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 V<novaboot-shell>.
205 Currently, this in an initial experimental implementation. We plan to
206 change/extend this feature soon!
210 =head2 Script preprocessing phase
212 This phase allows modifying the parsed novaboot script before it is
213 used in the later phases.
217 =item -a, --append=I<parameters>
219 Append a string to the first C<load> line in the novaboot script. This option
220 can be used to append parameters to the kernel's or root task's
221 command line. This option can appear multiple times.
225 Use L<Bender|https://github.com/TUD-OS/morbo/blob/master/standalone/bender.c>
226 chainloader. Bender scans the PCI bus for PCI serial ports and stores
227 the information about them in the BIOS data area for use by the
230 =item --chainloader=I<chainloader>
232 Specifies a chainloader that is loaded before the kernel and other
233 files specified in the novaboot script. E.g. 'bin/boot/bender
238 Print the modules to boot and their parameters, after this phase
239 finishes. Then exit. This is useful for seeing the effect of other
240 options in this section.
242 =item -k, --kernel=F<file>
244 Replace the first word on the first C<load> line in the novaboot
247 =item --scriptmod=I<Perl expression>
249 When novaboot reads the script, I<Perl expression> is executed for every
250 line (in $_ variable). For example, C<novaboot
251 --scriptmod=s/sigma0/omega6/g> replaces every occurrence of I<sigma0>
252 in the script with I<omega6>.
254 When this option is present, it overrides I<$script_modifier> variable
255 from the configuration file, which has the same effect. If this option
256 is given multiple times all expressions are evaluated in the command
261 =head2 File generation phase
263 In this phase, files needed for booting are generated in a so-called
264 I<build directory> (see L</--build-dir>). In most cases configuration
265 for a bootloader is generated automatically by novaboot. It is also
266 possible to generate other files using I<heredoc> or I<"<"> syntax in
267 novaboot scripts. Finally, novaboot can generate binaries in this phases by
268 running C<scons> or C<make>.
272 =item --build-dir=I<directory>
274 Overrides the default build directory location.
276 The default build directory location is determined as follows: If the
277 configuration file defines the C<$builddir> variable, its value is
278 used. Otherwise, it is the directory that contains the first processed
281 See also L</BUILDDIR> variable.
283 =item -g, --grub[=I<filename>]
285 Generates grub bootloader menu file. If the I<filename> is not
286 specified, F<menu.lst> is used. The I<filename> is relative to the
287 build directory (see B<--build-dir>).
289 =item --grub-preamble=I<prefix>
291 Specifies the I<preamble> that is at the beginning of the generated
292 GRUB or GRUB2 config files. This is useful for specifying GRUB's
295 =item --prefix=I<prefix>
297 Specifies I<prefix> (e.g. F</srv/tftp>) that is put in front of every
298 filename in generated bootloader configuration files (or in U-Boot
301 If the I<prefix> contains string $NAME, it will be replaced with the
302 name of the novaboot script (see also B<--name>).
304 If the I<prefix> contains string $BUILDDIR, it will be replaced with
305 the build directory (see also B<--build-dir>).
309 Alias for B<--prefix>.
311 =item --grub2[=I<filename>]
313 Generate GRUB2 menu entry in I<filename>. If I<filename> is not
314 specified F<grub.cfg> is used. The content of the menu entry can be
315 customized with B<--grub-preamble>, B<--grub2-prolog> or
316 B<--grub_prefix> options.
318 To use the generated menu entry on your development
319 machine that uses GRUB2, append the following snippet to
320 F</etc/grub.d/40_custom> file and regenerate your grub configuration,
321 i.e. run update-grub on Debian/Ubuntu.
323 if [ -f /path/to/nul/build/grub.cfg ]; then
324 source /path/to/nul/build/grub.cfg
327 =item --grub2-prolog=I<prolog>
329 Specifies the text that novaboot puts at the beginning of the GRUB2 menu entry.
331 =item -m, --make[=make command]
333 Runs C<make> to build files that are not generated by novaboot itself.
335 =item --name=I<string>
337 Use the name I<string> instead of the name of the novaboot script.
338 This name is used for things like a title of grub menu or for the
339 server directory where the boot files are copied to.
343 Do not run external commands to generate files (i.e. "<" syntax and
344 C<run> keyword). This switch does not influence the generation of files
345 specified with "<<WORD" syntax.
347 =item -p, --pulsar[=mac]
349 Generates pulsar bootloader configuration file named F<config-I<mac>>
350 The I<mac> string is typically a MAC address and defaults to
353 =item --scons[=scons command]
355 Runs C<scons> to build files that are not generated by novaboot
360 Strip I<rom://> prefix from command lines and generated config files.
361 The I<rom://> prefix is used by NUL. For NRE, it has to be stripped.
365 Exit novaboot after file generation phase.
369 =head2 Target connection check
371 In this phase novaboot connects to target's serial port (if it has
372 one). If another novaboot user/instance occupies the target, novaboot
373 exits here with an error message.
377 =item --amt=I<"[user[:password]@]host[:port]>
379 Use Intel AMT technology to control the target machine. WS management
380 is used to powercycle it and Serial-Over-Lan (SOL) for input/output.
381 The hostname or (IP address) is given by the I<host> parameter. If the
382 I<password> is not specified, environment variable AMT_PASSWORD is
383 used. The I<port> specifies a TCP port for SOL. If not specified, the
384 default is 16992. The default I<user> is admin.
386 =item --iprelay=I<addr[:port]>
388 Use TCP/IP relay and serial port to access the target's serial port
389 and powercycle it. The I<addr> parameter specifies the IP address of
390 the relay. If I<port> is not specified, it defaults to 23.
392 Note: This option is supposed to work with HWG-ER02a IP relays.
394 =item --iprelay-cmd=I<command>
396 Similar to B<--iprelay> but uses I<command> to talk to the iprelay
397 rather than direct network connection.
399 =item -s, --serial[=device]
401 Target's serial line is connected to host's serial line (device). The
402 default value for device is F</dev/ttyUSB0>.
404 The value of this option is exported in NB_NOVABOOT environment
405 variable to all subprocesses run by C<novaboot>.
407 =item --stty=I<settings>
409 Specifies settings passed to C<stty> invoked on the serial line
410 specified with B<--serial> option. If this option is not given,
411 C<stty> is called with C<raw -crtscts -onlcr 115200> settings.
413 =item --remote-cmd=I<cmd>
415 Command that mediates connection to the target's serial line. For
416 example C<ssh server 'cu -l /dev/ttyS0'>.
418 =item --remote-expect=I<string>
420 Wait for reception of I<string> after establishing the remote
421 connection. This option is needed when novaboot should wait for
422 confirmation before deploying files to the target, e.g. to not
423 overwrite other user's files when they are using the target.
425 =item --remote-expect-silent=I<string>
427 The same as B<--remote-expect> except that the remote output is not
428 echoed to stdout while waiting for the I<string>. Everything after the
429 matched string is printed to stdout, so you may want to include line
430 end characters in the I<string> as well.
432 =item --remote-expect-timeout=I<seconds>
434 Timeout in seconds for B<--remote-expect> or
435 B<--remote-expect-seconds>. When negative, waits forever. The default
440 =head2 File deployment phase
442 In some setups, it is necessary to copy the files needed for booting
443 to a particular location, e.g. to a TFTP boot server or to the
448 =item -d, --dhcp-tftp
450 Turns your workstation into a DHCP and TFTP server so that the OS can
451 be booted via PXE BIOS (or similar mechanism) on the test machine
452 directly connected by a plain Ethernet cable to your workstation.
454 The DHCP and TFTP servers require root privileges and C<novaboot>
455 uses C<sudo> command to obtain those. You can put the following to
456 I</etc/sudoers> to allow running the necessary commands without asking
459 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
460 your_login ALL=NOPASSWD: NOVABOOT
464 Starts a TFTP server on your workstation. This is similar to
465 B<--dhcp-tftp> except that DHCP server is not started.
467 The TFTP server requires root privileges and C<novaboot> uses C<sudo>
468 command to obtain those. You can put the following to I</etc/sudoers>
469 to allow running the necessary commands without asking for a password.
471 Cmnd_Alias NOVABOOT = /usr/sbin/in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid *, /usr/bin/pkill --pidfile=tftpd.pid
472 your_login ALL=NOPASSWD: NOVABOOT
474 =item --tftp-port=I<port>
476 Port to run the TFTP server on. Implies B<--tftp>.
478 =item --netif=I<network interface>
480 Network interface used to deploy files to the target. The default value is
481 I<eth0>. This option influences the configuration of the DHCP server started
482 by B<--dhcp-tftp> and the value that B<$NB_MYIP> get replaced with during
485 =item --iso[=filename]
487 Generates the ISO image that boots NOVA system via GRUB. If no filename
488 is given, the image is stored under I<NAME>.iso, where I<NAME> is the name
489 of the novaboot script (see also B<--name>).
491 =item --server[=[[user@]server:]path]
493 Copy all files needed for booting to another location. The files will
494 be copied (by B<rsync> tool) to the directory I<path>. If the I<path>
495 contains string $NAME, it will be replaced with the name of the
496 novaboot script (see also B<--name>).
498 =item --rsync-flags=I<flags>
500 Specifies I<flags> to append to F<rsync> command line when
501 copying files as a result of I<--server> option.
505 If B<--server> is used and its value ends with $NAME, then after
506 copying the files, a new bootloader configuration file (e.g. menu.lst)
507 is created at I<path-wo-name>, i.e. the path specified by B<--server>
508 with $NAME part removed. The content of the file is created by
509 concatenating all files of the same name from all subdirectories of
510 I<path-wo-name> found on the "server".
514 Use Intel AMT technology for IDE redirection. This allows the target
515 machine to boot from novaboot created ISO image. Implies B<--iso>.
517 The experimental C<amtider> utility needed by this option can be
518 obtained from https://github.com/wentasah/amtterm.
522 =head2 Target power-on and reset phase
524 At this point, the target is reset (or switched on/off). There are
525 several ways how this can be accomplished. Resetting a physical target
526 can currently be accomplished by the following options: B<--amt>,
527 B<--iprelay>, B<--reset-cmd> and B<--reset-send>.
533 Switch on/off the target machine and exit. The script (if any) is
534 completely ignored. Currently, it works only with the following
535 options: B<--iprelay>, B<--amt>, B<--ssh>.
537 =item -Q, --qemu[=I<qemu-binary>]
539 Boot the configuration in qemu. Optionally, the name of qemu binary
540 can be specified as a parameter.
542 =item --qemu-append=I<flags>
544 Append I<flags> to the default qemu flags (QEMU_FLAGS variable or
545 C<-cpu coreduo -smp 2>).
547 =item -q, --qemu-flags=I<flags>
549 Replace the default qemu flags (QEMU_FLAGS variable or C<-cpu coreduo
550 -smp 2>) with I<flags> specified here.
552 =item --reset-cmd=I<cmd>
554 Runs command I<cmd> to reset the target.
556 =item --reset-send=I<string>
558 Reset the target by sending the given I<string> to the remote serial
559 line. "\n" sequences are replaced with the newline character.
561 =item --no-reset, --reset
563 Disable/enable resetting of the target.
567 =head2 Interaction with the bootloader on the target
571 =item --uboot[=I<prompt>]
573 Interact with U-Boot bootloader to boot the thing described in the
574 novaboot script. I<prompt> specifies the U-Boot's prompt (default is
575 "=> ", other common prompts are "U-Boot> " or "U-Boot# ").
579 Disable U-Boot interaction previously enabled with B<--uboot>.
583 Command(s) to send the U-Boot bootloader before loading the images and
584 booting them. This option can be given multiple times. After sending
585 commands from each option novaboot waits for U-Boot I<prompt>.
587 If the command contains string I<$NB_MYIP> then this string is
588 replaced by IPv4 address of eth0 interface (see also B<--netif>).
589 Similarly, I<$NB_PREFIX> is replaced with prefix given by B<--prefix>.
591 See also C<uboot> keyword in L</"NOVABOOT SCRIPT SYNTAX">).
593 =item --uboot-addr I<name>=I<address>
595 Load address of U-Boot's C<tftpboot> command for loading I<name>,
596 where name is one of I<kernel>, I<ramdisk> or I<fdt> (flattened device
599 The default addresses are ${I<name>_addr_r}, i.e. U-Boot environment
600 variables used by convention for this purpose.
602 =item --uboot-cmd=I<command>
604 Specifies U-Boot command used to execute the OS. If the command
605 contains strings C<$kernel_addr>, C<$ramdisk_addr>, C<$fdt_addr>,
606 these are replaced with the addresses configured with B<--uboot-addr>.
610 bootm $kernel_addr $ramdisk_addr $fdt_addr
612 or the C<UBOOT_CMD> variable if defined in the novaboot script.
616 =head2 Target interaction phase
618 In this phase, target's serial output is redirected to stdout and if
619 stdin is a TTY, it is redirected to the target's serial input allowing
620 interactive work with the target.
624 =item --exiton=I<string>
626 When the I<string> is sent by the target, novaboot exits. This option can
627 be specified multiple times, in which case novaboot exits whenever
628 either of the specified strings is sent.
630 If the I<string> is C<-re>, then the next B<--exiton>'s I<string> is
631 treated as a regular expression. For example:
633 --exiton -re --exiton 'error:.*failed'
635 =item --exiton-re=I<regex>
637 The same as --exiton -re --exiton I<regex>.
639 =item --exiton-timeout=I<seconds>
641 By default B<--exiton> waits for the string match forever. When this
642 option is specified, "exiton" timeouts after the specifies the number of
643 seconds and novaboot returns non-zero exit code.
645 =item -i, --interactive
647 Setup things for the interactive use of the target. Your terminal will
648 be switched to raw mode. In raw mode, your local terminal does not
649 process input in any way (no echoing of entered characters, no
650 interpretation of special characters). This, among others, means that
651 Ctrl-C is passed to the target and does not interrupt novaboot. To
652 exit from novaboot interactive mode type "~~.".
654 =item --no-interaction, --interaction
656 Skip resp. force target interaction phase. When skipped, novaboot exits
657 immediately after the boot is initiated.
659 =item --expect=I<string>
661 When the I<string> is received from the target, send the string specified
662 with the subsequent B<--send*> option to the target.
664 =item --expect-re=I<regex>
666 When target's output matches regular expression I<regex>, send the
667 string specified with the subsequent B<--send*> option to the target.
669 =item --expect-raw=I<perl-code>
671 Provides direct control over Perl's Expect module.
673 =item --send=I<string>
675 Send I<string> to the target after the previously specified
676 B<--expect*> was matched in the target's output. The I<string> may
677 contain escape sequences such as "\n".
679 Note that I<string> is actually interpreted by Perl, so it can contain
680 much more that escape sequences. This behavior may change in the
683 Example: C<--expect='login: ' --send='root\n'>
685 =item --sendcont=I<string>
687 Similar to B<--send> but continue expecting more input.
689 Example: C<--expect='Continue?' --sendcont='yes\n'>
691 =item --final-eol, --no-final-eol
693 By default, B<novaboot> always prints an end-of-line character at the
694 end of its execution in order to ensure that the output of programs
695 started after novaboot appears at the beginning of the line. When this
696 is not desired B<--no-final-eol> option can be used to override this
701 =head1 NOVABOOT SCRIPT SYNTAX
703 The syntax tries to mimic POSIX shell syntax. The syntax is defined
704 by the following rules.
706 Lines starting with "#" and empty lines are ignored.
708 Lines that end with "\" are concatenated with the following line after
709 removal of the final "\" and leading whitespace of the following line.
711 Lines of the form I<VARIABLE=...> (i.e. matching '^[A-Z_]+=' regular
712 expression) assign values to internal variables. See L</VARIABLES>
715 Otherwise, the first word on the line defines the meaning of the line.
716 The following keywords are supported:
722 These lines represent modules to boot. The
723 word after C<load> is a file name (relative to the build directory
724 (see B<--build-dir>) of the module to load and the remaining words are
725 passed to it as the command line parameters.
727 When the C<load> line ends with "<<WORD" then the subsequent lines
728 until the line containing solely WORD are copied literally to the file
729 named on that line. This is similar to shell's heredoc feature.
731 When the C<load> line ends with "< CMD" then command CMD is executed
732 with F</bin/sh> and its standard output is stored in the file named on
733 that line. The SRCDIR variable in CMD's environment is set to the
734 absolute path of the directory containing the interpreted novaboot
739 These lines are similar to C<load> lines. The
740 file mentioned there is copied to the same place as in the case of C<load>
741 (e.g. tftp server), but the file is not used in the bootloader
742 configuration. Such a file can be used by the target for other
743 purposes than booting, e.g. at OS runtime or for firmware update.
747 Chainload another bootloader. Instead of loading multiboot modules
748 identified with C<load> keyword, run another bootloader. This is
749 currently supported only by pulsar and can be used to load e.g. Grub
750 as in the example below:
752 chld boot/grub/i386-pc/core.0
757 Lines starting with C<run> keyword contain shell commands that are run
758 during file generation phase. This is the same as the "< CMD" syntax
759 for C<load> keyboard except that the command's output is not
760 redirected to a file. The ordering of commands is the same as they
761 appear in the novaboot script.
765 These lines represent U-Boot commands that are sent to the target if
766 B<--uboot> option is given. Having a U-Boot line in the novaboot
767 script is the same as giving B<--uboot-init> option to novaboot. The
768 following syntax variants are supported:
771 uboot[:<timeout>] <string> [> <file>]
772 uboot[:<timeout>] < <shell> [> <file>]
774 C<string> is the literal U-Boot command.
776 The C<uboot> keyword can be suffixed with timeout specification. The
777 syntax is C<uboot:Ns>, where C<N> is the whole number of seconds. If
778 the U-Boot command prompt does not appear before the timeout, novaboot
779 fails. The default timeout is 10 seconds.
781 In the second variant with the C<<> character the shell code is
782 executed and its standard output is sent to U-Boot. Example:
784 uboot < printf "mmc write \$loadaddr 1 %x" $(($(/usr/bin/stat -c%s rootfs.ext4) / 512))
786 When C<E<gt> file> part is present, the output of the U-Boot command
787 is written into the given file.
793 #!/usr/bin/env novaboot
794 load bzImage console=ttyS0,115200
795 run make -C buildroot
796 load rootfs.cpio < gen_cpio buildroot/images/rootfs.cpio "myapp->/etc/init.d/S99myapp"
798 Example (NOVA User Land - NUL):
800 #!/usr/bin/env novaboot
801 WVDESC=Example program
802 load bin/apps/sigma0.nul S0_DEFAULT script_start:1,1 \
803 verbose hostkeyb:0,0x60,1,12,2
804 load bin/apps/hello.nul
805 load hello.nulconfig <<EOF
806 sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
807 rom://bin/apps/hello.nul
810 This example will load three modules: F<sigma0.nul>, F<hello.nul> and
811 F<hello.nulconfig>. sigma0 receives some command line parameters and
812 F<hello.nulconfig> file is generated on the fly from the lines between
815 Example (Zynq system update via U-Boot):
817 #!/usr/bin/env novaboot
821 # Write kernel to FAT filesystem on the 1st SD card partition
822 run mkimage -f uboot-image.its image.ub
824 uboot:60s tftpboot ${loadaddr} $NB_PREFIX/image.ub
825 uboot fatwrite mmc 0:1 ${loadaddr} image.ub $filesize
826 uboot set bootargs console=ttyPS0,115200 root=/dev/mmcblk0p2
828 # Write root FS image to the 2nd SD card partition
829 copy rootfs/images/rootfs.ext4
830 uboot:60s tftpboot ${loadaddr} $NB_PREFIX/rootfs/images/rootfs.ext4
831 uboot mmc part > mmc-part.txt
832 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))
839 The following variables are interpreted in the novaboot script:
845 Novaboot chdir()s to this directory before file generation phase. The
846 directory name specified here is relative to the build directory
847 specified by other means (see L</--build-dir>).
851 Assigning this variable has the same effect as specifying L</--exiton>
854 =item HYPERVISOR_PARAMS
856 Parameters passed to the hypervisor. The default value is "serial", unless
857 overridden in the configuration file.
861 The kernel to use instead of the hypervisor specified in the
862 configuration file with the C<$hypervisor> variable. The value should
863 contain the name of the kernel image as well as its command line
864 parameters. If this variable is defined and non-empty, the variable
865 HYPERVISOR_PARAMS is not used.
869 If this variable is 1, the system is not booted. This is currently
870 only implemented for U-Boot bootloader where it is useful for
871 interacting with the bootloader without booting the system - e.g. for
876 Use a specific qemu binary (can be overridden with B<-Q>) and flags
877 when booting this script under qemu. If QEMU_FLAGS variable is also
878 specified flags specified in QEMU variable are replaced by those in
883 Use specific qemu flags (can be overridden with B<-q>).
891 Description of the WvTest-compliant program.
895 The timeout in seconds for WvTest harness. If no complete line appears
896 in the test output within the time specified here, the test fails. It
897 is necessary to specify this for long running tests that produce no
902 =head1 CONFIGURATION FILES
904 Novaboot can read its configuration from one or more files. By
905 default, novaboot looks for files in F</etc/novaboot.d>, file
906 F<~/.config/novaboot> and files named F<.novaboot> as described in
907 L</Configuration reading phase>. Alternatively, configuration file
908 location can be specified with the B<-c> switch or with the
909 NOVABOOT_CONFIG environment variable. The configuration file has Perl
910 syntax (i.e. it is better to put C<1;> as the last line) and should set
911 values of certain Perl variables. The current configuration can be
912 dumped with the B<--dump-config> switch. Some configuration variables
913 can be overridden by environment variables (see below) or by command
916 Supported configuration variables include:
922 Build directory location relative to the location of the configuration
925 =item $default_target
927 Default target (see below) to use when no target is explicitly
928 specified with the B<--target> command line option or
929 B<NOVABOOT_TARGET> environment variable.
933 Hash of target definitions to be used with the B<--target> option. The
934 key is the identifier of the target, the value is the string with
935 command line options. For instance, if the configuration file contains:
937 $targets{'mybox'} = '--server=boot:/tftproot --serial=/dev/ttyUSB0 --grub',
939 then the following two commands are equivalent:
941 ./myos --server=boot:/tftproot --serial=/dev/ttyUSB0 --grub
946 =head1 ENVIRONMENT VARIABLES
948 Some options can be specified not only via config file or command line
949 but also through environment variables. Environment variables override
950 the values from the configuration file and command line parameters
951 override the environment variables.
955 =item NOVABOOT_CONFIG
957 Name of the novaboot configuration file to use instead of the default
960 =item NOVABOOT_CONFIG_DIR
962 Name of the novaboot configuration directory. When not specified
963 F</etc/novaboot.d> is used.
965 =item NOVABOOT_TARGET
967 Name of the novaboot target to use. This overrides the value of
968 B<$default_target> from the configuration file and can be overridden
969 with the B<--target> command line option.
971 =item NOVABOOT_BENDER
973 Defining this variable has the same effect as using B<--bender>
980 Michal Sojka <sojka@os.inf.tu-dresden.de>
982 Latest novaboot version can be found at
983 L<https://github.com/wentasah/novaboot>.