4 novaboot - Boots a locally compiled operating system on a remote
11 B<novaboot> [option]... [--] script...
13 B<./script> [option]...
17 Novaboot makes booting of a locally compiled operating system (OS)
18 (e.g. NOVA or Linux) on remote targets as simple as running a program
19 locally. It automates things like copying OS images to a TFTP server,
20 generation of bootloader configuration files, resetting of target
21 hardware or redirection of target's serial line to stdin/out. Novaboot
22 is highly configurable and makes it easy to boot a single image on
23 different targets or different images on a single target.
25 Novaboot operation is controlled by configuration files, command line
26 options and by a so-called novaboot script, which can be thought as a
27 generalization of bootloader configuration files (see L</"NOVABOOT
28 SCRIPT SYNTAX">). The typical way of using novaboot is to make the
29 novaboot script executable and set its first line to I<#!/usr/bin/env
30 novaboot>. Then, booting a particular OS configuration becomes the
31 same as executing a local program – the novaboot script.
33 Novaboot uses configuration files to, among other things, define
34 command line options needed for different targets. Users typically use
35 only the B<-t>/B<--target> command line option to select the target.
36 Internally, this option expands to the pre-configured options.
37 Novaboot searches configuration files at multiple places, which allows
38 having per-system, per-user or per-project configurations.
39 Configuration file syntax is described in section L</"CONFIGURATION
42 Simple examples of using C<novaboot>:
48 Running an OS in Qemu can be accomplished by giving the B<--qemu> option.
53 (or C<./myos --qemu> as described above) will run Qemu and make it
54 boot the configuration specified in the F<myos> script.
58 Create a bootloader configuration file (currently supported
59 bootloaders are GRUB, GRUB2, ISOLINUX, Pulsar, and U-Boot) and copy it
60 with all other files needed for booting to a remote boot server. Then
61 use a TCP/IP-controlled relay/serial-to-TCP converter to reset the
62 target and receive its serial output.
64 ./myos --grub2 --server=192.168.1.1:/tftp --iprelay=192.168.1.2
66 Alternatively, you can put these switches to the configuration file
69 ./myos --target mytarget
73 Run DHCP and TFTP server on developer's machine to boot the target
78 This usage is useful when no network infrastructure is in place, and
79 the target is connected directly to developer's box.
83 Create bootable ISO image.
85 novaboot --iso -- script1 script2
87 The created ISO image will have ISOLINUX bootloader installed on it,
88 and the boot menu will allow selecting between I<script1> and
89 I<script2> configurations.
93 =head1 PHASES AND OPTIONS
95 Novaboot performs its work in several phases. Command like options
96 described bellow influence the execution of each phase or allow their
97 skipping. The list of phases (in the execution order) is as follows.
101 =item 1. L<Configuration reading|/Configuration reading phase>
103 =item 2. L<Command line processing|/Command line processing phase>
105 =item 3. L<Script preprocessing|/Script preprocessing phase>
107 =item 4. L<File generation|/File generation phase>
109 =item 5. L<Target connection|/Target connection check>
111 =item 6. L<File deployment|/File deployment phase>
113 =item 7. L<Target power-on and reset|/Target power-on and reset phase>
115 =item 8. L<Interaction with the bootloader|/Interaction with the bootloader on the target>
117 =item 9. L<Target interaction|/Target interaction phase>
121 Each phase is described in the following sections together with the
122 command line options that control it.
124 =head2 Configuration reading phase
126 After starting, novaboot reads zero or more configuration files. We
127 describe their content in section L</"CONFIGURATION FILES">. By default, the
128 configuration is read from multiple locations. First from the system
129 configuration directory (F</etc/novaboot.d/>), second from the user
130 configuration file (F<~/.config/novaboot>) and third from F<.novaboot>
131 files along the path to the current directory. Alternatively, a single
132 configuration file specified with the B<-c> switch or with the
133 C<NOVABOOT_CONFIG> environment variable is read. The latter read files
134 override settings from the former ones.
136 The system configuration directory is determined by the content of
137 NOVABOOT_CONFIG_DIR environment variable and defaults to
138 F</etc/novaboot.d>. Files in this directory with names consisting
139 solely of English letters, numbers, dashes '-' and underscores '_'
140 (note that dot '.' is not included) are read in alphabetical order.
142 Then, the user configuration file is read from
143 F<$XDG_CONFIG_HOME/novaboot>. If C<$XDG_CONFIG_HOME> environment
144 variable is not set F<~/.config/novaboot> is read instead.
146 Finally, novaboot searches for files named F<.novaboot> starting from the
147 directory of the novaboot script (or working directory, see bellow)
148 and continuing upwards up to the root directory. The found
149 configuration files are then read in the opposite order (i.e. from the
150 root directory downwards). This ordering allows having, for example, a project
151 specific configuration in F<~/project/.novaboot>.
153 Note the difference between F<~/.config/novaboot> and F<~/.novaboot>.
154 The former one is always read, whereas the latter only when novaboot
155 script or working directory is under the C<$HOME> directory.
157 In certain cases, the location of the novaboot script cannot be
158 determined in this early phase. This situation happens either when the script is
159 read from the standard input or when novaboot is invoked explicitly as
160 in the example L</"4."> above. In this case, the current working
161 directory is used as a starting point for configuration file search
162 instead of the novaboot script directory.
166 =item -c, --config=I<filename>
168 Use the specified configuration file instead of the default one(s).
172 =head2 Command line processing phase
178 Dump the current configuration to stdout end exit. Useful as an
179 initial template for a configuration file.
183 Print short (B<-h>) or long (B<--help>) help.
185 =item -t, --target=I<target>
187 This option serves as a user configurable shortcut for other novaboot
188 options. The effect of this option is the same as specifying the
189 options stored in the C<%targets> configuration variable under key
190 I<target>. See also L</"CONFIGURATION FILES">.
192 When this option is not given, novaboot tries to determine the target
193 to use from either B<NOVABOOT_TARGET> environment variable or
194 B<$default_target> configuration file variable.
196 =item --ssh=I<user@hostname>
198 Configures novaboot to control the target via C<novaboot-shell>
199 running remotely via SSH.
201 Using this option is the same as specifying B<--remote-cmd>,
202 B<--remote-expect>, B<--server> B<--rsync-flags>, B<--prefix> and
203 B<--reset-cmd> manually in a way compatible with C<novaboot-shell>.
204 The server can be configured to provide other, safe bootloader-related
205 options, to the client. When this happens, novaboot prints them to
208 Currently, this in an initial experimental implementation. We plan to
209 change/extend this feature soon!
213 =head2 Script preprocessing phase
215 This phase allows modifying the parsed novaboot script before it is
216 used in the later phases.
220 =item -a, --append=I<parameters>
222 Append a string to the first C<load> line in the novaboot script. This option
223 can be used to append parameters to the kernel's or root task's
224 command line. This option can appear multiple times.
228 Use L<Bender|https://github.com/TUD-OS/morbo/blob/master/standalone/bender.c>
229 chainloader. Bender scans the PCI bus for PCI serial ports and stores
230 the information about them in the BIOS data area for use by the
233 =item --chainloader=I<chainloader>
235 Specifies a chainloader that is loaded before the kernel and other
236 files specified in the novaboot script. E.g. 'bin/boot/bender
241 Print the modules to boot and their parameters, after this phase
242 finishes. Then exit. This is useful for seeing the effect of other
243 options in this section.
245 =item -k, --kernel=F<file>
247 Replace the first word on the first C<load> line in the novaboot
250 =item --scriptmod=I<Perl expression>
252 When novaboot reads the script, I<Perl expression> is executed for every
253 line (in $_ variable). For example, C<novaboot
254 --scriptmod=s/sigma0/omega6/g> replaces every occurrence of I<sigma0>
255 in the script with I<omega6>.
257 When this option is present, it overrides I<$script_modifier> variable
258 from the configuration file, which has the same effect. If this option
259 is given multiple times all expressions are evaluated in the command
264 =head2 File generation phase
266 In this phase, files needed for booting are generated in a so-called
267 I<build directory> (see L</--build-dir>). In most cases configuration
268 for a bootloader is generated automatically by novaboot. It is also
269 possible to generate other files using I<heredoc> or I<"<"> syntax in
270 novaboot scripts. Finally, novaboot can generate binaries in this phases by
271 running C<scons> or C<make>.
275 =item --build-dir=I<directory>
277 Overrides the default build directory location.
279 The default build directory location is determined as follows: If the
280 configuration file defines the C<$builddir> variable, its value is
281 used. Otherwise, it is the directory that contains the first processed
284 See also L</BUILDDIR> variable.
286 =item -g, --grub[=I<filename>]
288 Generates grub bootloader menu file. If the I<filename> is not
289 specified, F<menu.lst> is used. The I<filename> is relative to the
290 build directory (see B<--build-dir>).
292 =item --grub-preamble=I<prefix>
294 Specifies the I<preamble> that is at the beginning of the generated
295 GRUB or GRUB2 config files. This is useful for specifying GRUB's
298 =item --prefix=I<prefix>
300 Specifies I<prefix> (e.g. F</srv/tftp>) that is put in front of every
301 filename in generated bootloader configuration files (or in U-Boot
304 If the I<prefix> contains string $NAME, it will be replaced with the
305 name of the novaboot script (see also B<--name>).
307 If the I<prefix> contains string $BUILDDIR, it will be replaced with
308 the build directory (see also B<--build-dir>).
312 Alias for B<--prefix>.
314 =item --grub2[=I<filename>]
316 Generate GRUB2 menu entry in I<filename>. If I<filename> is not
317 specified F<grub.cfg> is used. The content of the menu entry can be
318 customized with B<--grub-preamble>, B<--grub2-prolog> or
319 B<--grub_prefix> options.
321 To use the generated menu entry on your development
322 machine that uses GRUB2, append the following snippet to
323 F</etc/grub.d/40_custom> file and regenerate your grub configuration,
324 i.e. run update-grub on Debian/Ubuntu.
326 if [ -f /path/to/nul/build/grub.cfg ]; then
327 source /path/to/nul/build/grub.cfg
330 =item --grub2-prolog=I<prolog>
332 Specifies the text that novaboot puts at the beginning of the GRUB2 menu entry.
334 =item -m, --make[=make command]
336 Runs C<make> to build files that are not generated by novaboot itself.
338 =item --name=I<string>
340 Use the name I<string> instead of the name of the novaboot script.
341 This name is used for things like a title of grub menu or for the
342 server directory where the boot files are copied to.
346 Do not run external commands to generate files (i.e. "<" syntax and
347 C<run> keyword). This switch does not influence the generation of files
348 specified with "<<WORD" syntax.
350 =item -p, --pulsar[=mac]
352 Generates pulsar bootloader configuration file named F<config-I<mac>>
353 The I<mac> string is typically a MAC address and defaults to
356 =item --scons[=scons command]
358 Runs C<scons> to build files that are not generated by novaboot
363 Strip I<rom://> prefix from command lines and generated config files.
364 The I<rom://> prefix is used by NUL. For NRE, it has to be stripped.
368 Exit novaboot after file generation phase.
372 =head2 Target connection check
374 In this phase novaboot connects to target's serial port (if it has
375 one). If another novaboot user/instance occupies the target, novaboot
376 exits here with an error message.
380 =item --amt=I<"[user[:password]@]host[:port]>
382 Use Intel AMT technology to control the target machine. WS management
383 is used to powercycle it and Serial-Over-Lan (SOL) for input/output.
384 The hostname or (IP address) is given by the I<host> parameter. If the
385 I<password> is not specified, environment variable AMT_PASSWORD is
386 used. The I<port> specifies a TCP port for SOL. If not specified, the
387 default is 16992. The default I<user> is admin.
389 =item --iprelay=I<addr[:port]>
391 Use TCP/IP relay and serial port to access the target's serial port
392 and powercycle it. The I<addr> parameter specifies the IP address of
393 the relay. If I<port> is not specified, it defaults to 23.
395 Note: This option is supposed to work with HWG-ER02a IP relays.
397 =item --iprelay-cmd=I<command>
399 Similar to B<--iprelay> but uses I<command> to talk to the iprelay
400 rather than direct network connection.
402 =item -s, --serial[=device]
404 Target's serial line is connected to host's serial line (device). The
405 default value for device is F</dev/ttyUSB0>.
407 The value of this option is exported in NB_NOVABOOT environment
408 variable to all subprocesses run by C<novaboot>.
410 =item --stty=I<settings>
412 Specifies settings passed to C<stty> invoked on the serial line
413 specified with B<--serial> option. If this option is not given,
414 C<stty> is called with C<raw -crtscts -onlcr 115200> settings.
416 =item --remote-cmd=I<cmd>
418 Command that mediates connection to the target's serial line. For
419 example C<ssh server 'cu -l /dev/ttyS0'>.
421 =item --remote-expect=I<string>
423 Wait for reception of I<string> after establishing the remote
424 connection. This option is needed when novaboot should wait for
425 confirmation before deploying files to the target, e.g. to not
426 overwrite other user's files when they are using the target.
428 =item --remote-expect-silent=I<string>
430 The same as B<--remote-expect> except that the remote output is not
431 echoed to stdout while waiting for the I<string>. Everything after the
432 matched string is printed to stdout, so you may want to include line
433 end characters in the I<string> as well.
435 =item --remote-expect-timeout=I<seconds>
437 Timeout in seconds for B<--remote-expect> or
438 B<--remote-expect-seconds>. When negative, waits forever. The default
443 =head2 File deployment phase
445 In some setups, it is necessary to copy the files needed for booting
446 to a particular location, e.g. to a TFTP boot server or to the
451 =item -d, --dhcp-tftp
453 Turns your workstation into a DHCP and TFTP server so that the OS can
454 be booted via PXE BIOS (or similar mechanism) on the test machine
455 directly connected by a plain Ethernet cable to your workstation.
457 The DHCP and TFTP servers require root privileges and C<novaboot>
458 uses C<sudo> command to obtain those. You can put the following to
459 I</etc/sudoers> to allow running the necessary commands without asking
462 Cmnd_Alias NOVABOOT = /bin/ip a add 10.23.23.1/24 dev eth0, /bin/ip l set dev eth0 up, /usr/sbin/dhcpd -d -cf dhcpd.conf -lf dhcpd.leases -pf dhcpd.pid, /usr/sbin/in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid *, /usr/bin/touch dhcpd.leases, /usr/bin/pkill --pidfile=dhcpd.pid, /usr/bin/pkill --pidfile=tftpd.pid
463 your_login ALL=NOPASSWD: NOVABOOT
467 Starts a TFTP server on your workstation. This is similar to
468 B<--dhcp-tftp> except that DHCP server is not started.
470 The TFTP server requires root privileges and C<novaboot> uses C<sudo>
471 command to obtain those. You can put the following to I</etc/sudoers>
472 to allow running the necessary commands without asking for a password.
474 Cmnd_Alias NOVABOOT = /usr/sbin/in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid *, /usr/bin/pkill --pidfile=tftpd.pid
475 your_login ALL=NOPASSWD: NOVABOOT
477 =item --tftp-port=I<port>
479 Port to run the TFTP server on. Implies B<--tftp>.
481 =item --netif=I<network interface>
483 Network interface used to deploy files to the target. The default value is
484 I<eth0>. This option influences the configuration of the DHCP server started
485 by B<--dhcp-tftp> and the value that B<$NB_MYIP> get replaced with during
488 =item --iso[=filename]
490 Generates the ISO image that boots NOVA system via GRUB. If no filename
491 is given, the image is stored under I<NAME>.iso, where I<NAME> is the name
492 of the novaboot script (see also B<--name>).
494 =item --server[=[[user@]server:]path]
496 Copy all files needed for booting to another location. The files will
497 be copied (by B<rsync> tool) to the directory I<path>. If the I<path>
498 contains string $NAME, it will be replaced with the name of the
499 novaboot script (see also B<--name>).
501 =item --rsync-flags=I<flags>
503 Specifies I<flags> to append to F<rsync> command line when
504 copying files as a result of I<--server> option.
508 If B<--server> is used and its value ends with $NAME, then after
509 copying the files, a new bootloader configuration file (e.g. menu.lst)
510 is created at I<path-wo-name>, i.e. the path specified by B<--server>
511 with $NAME part removed. The content of the file is created by
512 concatenating all files of the same name from all subdirectories of
513 I<path-wo-name> found on the "server".
517 Use Intel AMT technology for IDE redirection. This allows the target
518 machine to boot from novaboot created ISO image. Implies B<--iso>.
520 The experimental C<amtider> utility needed by this option can be
521 obtained from https://github.com/wentasah/amtterm.
525 =head2 Target power-on and reset phase
527 At this point, the target is reset (or switched on/off). There are
528 several ways how this can be accomplished. Resetting a physical target
529 can currently be accomplished by the following options: B<--amt>,
530 B<--iprelay>, B<--reset-cmd> and B<--reset-send>.
536 Switch on/off the target machine and exit. The script (if any) is
537 completely ignored. Currently, it works only with the following
538 options: B<--iprelay>, B<--amt>, B<--ssh>.
540 =item -Q, --qemu[=I<qemu-binary>]
542 Boot the configuration in qemu. Optionally, the name of qemu binary
543 can be specified as a parameter.
545 =item --qemu-append=I<flags>
547 Append I<flags> to the default qemu flags (QEMU_FLAGS variable or
548 C<-cpu coreduo -smp 2>).
550 =item -q, --qemu-flags=I<flags>
552 Replace the default qemu flags (QEMU_FLAGS variable or C<-cpu coreduo
553 -smp 2>) with I<flags> specified here.
555 =item --reset-cmd=I<cmd>
557 Runs command I<cmd> to reset the target.
559 =item --reset-send=I<string>
561 Reset the target by sending the given I<string> to the remote serial
562 line. "\n" sequences are replaced with the newline character.
564 =item --no-reset, --reset
566 Disable/enable resetting of the target.
570 =head2 Interaction with the bootloader on the target
574 =item --uboot[=I<prompt>]
576 Interact with U-Boot bootloader to boot the thing described in the
577 novaboot script. I<prompt> specifies the U-Boot's prompt (default is
578 "=> ", other common prompts are "U-Boot> " or "U-Boot# ").
582 Disable U-Boot interaction previously enabled with B<--uboot>.
586 Command(s) to send the U-Boot bootloader before loading the images and
587 booting them. This option can be given multiple times. After sending
588 commands from each option novaboot waits for U-Boot I<prompt>.
590 If the command contains string I<$NB_MYIP> then this string is
591 replaced by IPv4 address of eth0 interface (see also B<--netif>).
592 Similarly, I<$NB_PREFIX> is replaced with prefix given by B<--prefix>.
594 See also C<uboot> keyword in L</"NOVABOOT SCRIPT SYNTAX">).
596 =item --uboot-addr I<name>=I<address>
598 Load address of U-Boot's C<tftpboot> command for loading I<name>,
599 where name is one of I<kernel>, I<ramdisk> or I<fdt> (flattened device
602 The default addresses are ${I<name>_addr_r}, i.e. U-Boot environment
603 variables used by convention for this purpose.
605 =item --uboot-cmd=I<command>
607 Specifies U-Boot command used to execute the OS. If the command
608 contains strings C<$kernel_addr>, C<$ramdisk_addr>, C<$fdt_addr>,
609 these are replaced with the addresses configured with B<--uboot-addr>.
613 bootm $kernel_addr $ramdisk_addr $fdt_addr
615 or the C<UBOOT_CMD> variable if defined in the novaboot script.
619 =head2 Target interaction phase
621 In this phase, target's serial output is redirected to stdout and if
622 stdin is a TTY, it is redirected to the target's serial input allowing
623 interactive work with the target.
627 =item --exiton=I<string>
629 When the I<string> is sent by the target, novaboot exits. This option can
630 be specified multiple times, in which case novaboot exits whenever
631 either of the specified strings is sent.
633 If the I<string> is C<-re>, then the next B<--exiton>'s I<string> is
634 treated as a regular expression. For example:
636 --exiton -re --exiton 'error:.*failed'
638 =item --exiton-re=I<regex>
640 The same as --exiton -re --exiton I<regex>.
642 =item --exiton-timeout=I<seconds>
644 By default B<--exiton> waits for the string match forever. When this
645 option is specified, "exiton" timeouts after the specifies the number of
646 seconds and novaboot returns non-zero exit code.
648 =item -i, --interactive
650 Setup things for the interactive use of the target. Your terminal will
651 be switched to raw mode. In raw mode, your local terminal does not
652 process input in any way (no echoing of entered characters, no
653 interpretation of special characters). This, among others, means that
654 Ctrl-C is passed to the target and does not interrupt novaboot. To
655 exit from novaboot interactive mode type "~~.".
657 =item --no-interaction, --interaction
659 Skip resp. force target interaction phase. When skipped, novaboot exits
660 immediately after the boot is initiated.
662 =item --expect=I<string>
664 When the I<string> is received from the target, send the string specified
665 with the subsequent B<--send*> option to the target.
667 =item --expect-re=I<regex>
669 When target's output matches regular expression I<regex>, send the
670 string specified with the subsequent B<--send*> option to the target.
672 =item --expect-raw=I<perl-code>
674 Provides direct control over Perl's Expect module.
676 =item --send=I<string>
678 Send I<string> to the target after the previously specified
679 B<--expect*> was matched in the target's output. The I<string> may
680 contain escape sequences such as "\n".
682 Note that I<string> is actually interpreted by Perl, so it can contain
683 much more that escape sequences. This behavior may change in the
686 Example: C<--expect='login: ' --send='root\n'>
688 =item --sendcont=I<string>
690 Similar to B<--send> but continue expecting more input.
692 Example: C<--expect='Continue?' --sendcont='yes\n'>
694 =item --final-eol, --no-final-eol
696 By default, B<novaboot> always prints an end-of-line character at the
697 end of its execution in order to ensure that the output of programs
698 started after novaboot appears at the beginning of the line. When this
699 is not desired B<--no-final-eol> option can be used to override this
704 =head1 NOVABOOT SCRIPT SYNTAX
706 The syntax tries to mimic POSIX shell syntax. The syntax is defined
707 by the following rules.
709 Lines starting with "#" and empty lines are ignored.
711 Lines that end with "\" are concatenated with the following line after
712 removal of the final "\" and leading whitespace of the following line.
714 Lines of the form I<VARIABLE=...> (i.e. matching '^[A-Z_]+=' regular
715 expression) assign values to internal variables. See L</VARIABLES>
718 Otherwise, the first word on the line defines the meaning of the line.
719 The following keywords are supported:
725 These lines represent modules to boot. The
726 word after C<load> is a file name (relative to the build directory
727 (see B<--build-dir>) of the module to load and the remaining words are
728 passed to it as the command line parameters.
730 When the C<load> line ends with "<<WORD" then the subsequent lines
731 until the line containing solely WORD are copied literally to the file
732 named on that line. This is similar to shell's heredoc feature.
734 When the C<load> line ends with "< CMD" then command CMD is executed
735 with F</bin/sh> and its standard output is stored in the file named on
736 that line. The SRCDIR variable in CMD's environment is set to the
737 absolute path of the directory containing the interpreted novaboot
742 These lines are similar to C<load> lines. The
743 file mentioned there is copied to the same place as in the case of C<load>
744 (e.g. tftp server), but the file is not used in the bootloader
745 configuration. Such a file can be used by the target for other
746 purposes than booting, e.g. at OS runtime or for firmware update.
750 Chainload another bootloader. Instead of loading multiboot modules
751 identified with C<load> keyword, run another bootloader. This is
752 currently supported only by pulsar and can be used to load e.g. Grub
753 as in the example below:
755 chld boot/grub/i386-pc/core.0
760 Lines starting with C<run> keyword contain shell commands that are run
761 during file generation phase. This is the same as the "< CMD" syntax
762 for C<load> keyboard except that the command's output is not
763 redirected to a file. The ordering of commands is the same as they
764 appear in the novaboot script.
768 These lines represent U-Boot commands that are sent to the target if
769 B<--uboot> option is given. Having a U-Boot line in the novaboot
770 script is the same as giving B<--uboot-init> option to novaboot. The
771 following syntax variants are supported:
774 uboot[:<timeout>] <string> [> <file>]
775 uboot[:<timeout>] < <shell> [> <file>]
777 C<string> is the literal U-Boot command.
779 The C<uboot> keyword can be suffixed with timeout specification. The
780 syntax is C<uboot:Ns>, where C<N> is the whole number of seconds. If
781 the U-Boot command prompt does not appear before the timeout, novaboot
782 fails. The default timeout is 10 seconds.
784 In the second variant with the C<<> character the shell code is
785 executed and its standard output is sent to U-Boot. Example:
787 uboot < printf "mmc write \$loadaddr 1 %x" $(($(/usr/bin/stat -c%s rootfs.ext4) / 512))
789 When C<E<gt> file> part is present, the output of the U-Boot command
790 is written into the given file.
796 #!/usr/bin/env novaboot
797 load bzImage console=ttyS0,115200
798 run make -C buildroot
799 load rootfs.cpio < gen_cpio buildroot/images/rootfs.cpio "myapp->/etc/init.d/S99myapp"
801 Example (NOVA User Land - NUL):
803 #!/usr/bin/env novaboot
804 WVDESC=Example program
805 load bin/apps/sigma0.nul S0_DEFAULT script_start:1,1 \
806 verbose hostkeyb:0,0x60,1,12,2
807 load bin/apps/hello.nul
808 load hello.nulconfig <<EOF
809 sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
810 rom://bin/apps/hello.nul
813 This example will load three modules: F<sigma0.nul>, F<hello.nul> and
814 F<hello.nulconfig>. sigma0 receives some command line parameters and
815 F<hello.nulconfig> file is generated on the fly from the lines between
818 Example (Zynq system update via U-Boot):
820 #!/usr/bin/env novaboot
824 # Write kernel to FAT filesystem on the 1st SD card partition
825 run mkimage -f uboot-image.its image.ub
827 uboot:60s tftpboot ${loadaddr} $NB_PREFIX/image.ub
828 uboot fatwrite mmc 0:1 ${loadaddr} image.ub $filesize
829 uboot set bootargs console=ttyPS0,115200 root=/dev/mmcblk0p2
831 # Write root FS image to the 2nd SD card partition
832 copy rootfs/images/rootfs.ext4
833 uboot:60s tftpboot ${loadaddr} $NB_PREFIX/rootfs/images/rootfs.ext4
834 uboot mmc part > mmc-part.txt
835 uboot < printf "mmc write \$loadaddr %x %x" $(awk '{ if ($1 == "2") { print $2 }}' mmc-part.txt) $(($(/usr/bin/stat -L --printf=%s rootfs/images/rootfs.ext4) / 512))
842 The following variables are interpreted in the novaboot script:
848 Novaboot chdir()s to this directory before file generation phase. The
849 directory name specified here is relative to the build directory
850 specified by other means (see L</--build-dir>).
854 Assigning this variable has the same effect as specifying L</--exiton>
857 =item HYPERVISOR_PARAMS
859 Parameters passed to the hypervisor. The default value is "serial", unless
860 overridden in the configuration file.
864 The kernel to use instead of the hypervisor specified in the
865 configuration file with the C<$hypervisor> variable. The value should
866 contain the name of the kernel image as well as its command line
867 parameters. If this variable is defined and non-empty, the variable
868 HYPERVISOR_PARAMS is not used.
872 If this variable is 1, the system is not booted. This is currently
873 only implemented for U-Boot bootloader where it is useful for
874 interacting with the bootloader without booting the system - e.g. for
879 Use a specific qemu binary (can be overridden with B<-Q>) and flags
880 when booting this script under qemu. If QEMU_FLAGS variable is also
881 specified flags specified in QEMU variable are replaced by those in
886 Use specific qemu flags (can be overridden with B<-q>).
894 Description of the WvTest-compliant program.
898 The timeout in seconds for WvTest harness. If no complete line appears
899 in the test output within the time specified here, the test fails. It
900 is necessary to specify this for long running tests that produce no
905 =head1 CONFIGURATION FILES
907 Novaboot can read its configuration from one or more files. By
908 default, novaboot looks for files in F</etc/novaboot.d>, file
909 F<~/.config/novaboot> and files named F<.novaboot> as described in
910 L</Configuration reading phase>. Alternatively, configuration file
911 location can be specified with the B<-c> switch or with the
912 NOVABOOT_CONFIG environment variable. The configuration file has Perl
913 syntax (i.e. it is better to put C<1;> as the last line) and should set
914 values of certain Perl variables. The current configuration can be
915 dumped with the B<--dump-config> switch. Some configuration variables
916 can be overridden by environment variables (see below) or by command
919 Supported configuration variables include:
925 Build directory location relative to the location of the configuration
928 =item $default_target
930 Default target (see below) to use when no target is explicitly
931 specified with the B<--target> command line option or
932 B<NOVABOOT_TARGET> environment variable.
936 Hash of target definitions to be used with the B<--target> option. The
937 key is the identifier of the target, the value is the string with
938 command line options. For instance, if the configuration file contains:
940 $targets{'mybox'} = '--server=boot:/tftproot --serial=/dev/ttyUSB0 --grub',
942 then the following two commands are equivalent:
944 ./myos --server=boot:/tftproot --serial=/dev/ttyUSB0 --grub
949 =head1 ENVIRONMENT VARIABLES
951 Some options can be specified not only via config file or command line
952 but also through environment variables. Environment variables override
953 the values from the configuration file and command line parameters
954 override the environment variables.
958 =item NOVABOOT_CONFIG
960 Name of the novaboot configuration file to use instead of the default
963 =item NOVABOOT_CONFIG_DIR
965 Name of the novaboot configuration directory. When not specified
966 F</etc/novaboot.d> is used.
968 =item NOVABOOT_TARGET
970 Name of the novaboot target to use. This overrides the value of
971 B<$default_target> from the configuration file and can be overridden
972 with the B<--target> command line option.
974 =item NOVABOOT_BENDER
976 Defining this variable has the same effect as using B<--bender>
983 Michal Sojka <sojka@os.inf.tu-dresden.de>
985 Latest novaboot version can be found at
986 L<https://github.com/wentasah/novaboot>.