# SYNOPSIS
-__novaboot__ \[ options \] \[--\] script...
+**novaboot** --help
-__./script__ \[ options \]
+**novaboot** \[option\]... \[--\] script...
-__novaboot__ --help
+**./script** \[option\]...
# DESCRIPTION
-This program makes it easier to boot NOVA or other operating system
-(OS) in different environments. It reads a so called novaboot script
-and uses it either to boot the OS in an emulator (e.g. in qemu) or to
-generate the configuration for a specific bootloader and optionally to
-copy the necessary binaries and other needed files to proper
-locations, perhaps on a remote server. In case the system is actually
-booted, its serial output is redirected to standard output if that is
-possible.
-
-A typical way of using novaboot is to make the novaboot script
-executable and set its first line to _\#!/usr/bin/env novaboot_. Then,
+This program makes booting of an operating system (e.g. NOVA or Linux)
+as simple as running a local program. It facilitates booting on local
+or remote hosts or in emulators such as qemu. Novaboot operation is
+controlled by command line options and by a so called novaboot script,
+which can be thought as a generalization of bootloader configuration
+files (see ["NOVABOOT SCRIPT SYNTAX"](#novaboot-script-syntax)). Based on this input,
+novaboot setups everything for the target host to boot the desired
+configuration, i.e. it generates the bootloader configuration file in
+the proper format, deploy the binaries and other needed files to
+required locations, perhaps on a remote boot server and reset the
+target host. Finally, target host's serial output is redirected to
+standard output if that is possible.
+
+Typical way of using novaboot is to make the novaboot script
+executable and set its first line to _#!/usr/bin/env novaboot_. Then,
booting a particular OS configuration becomes the same as executing a
local program - the novaboot script.
-With `novaboot` you can:
+For example, with `novaboot` you can:
1. Run an OS in Qemu. This is the default action when no other action is
specified by command line switches. Thus running `novaboot ./script`
(or `./script` as described above) will run Qemu and make it boot the
-configuration specified in the _script_.
+configuration specified in the `script`.
2. Create a bootloader configuration file (currently supported
-bootloaders are GRUB, GRUB2 and Pulsar) and copy it with all other
-files needed for booting to another, perhaps remote, location.
+bootloaders are GRUB, GRUB2, Pulsar and U-Boot) and copy it with all
+other files needed for booting to a remote boot server.
- ./script --server --iprelay=192.168.1.2
+ ./script --server=192.168.1.1:/tftp --iprelay=192.168.1.2
- This command copies files to a TFTP server specified in the
- configuration file and uses TCP/IP-controlled relay to reset the test
- box and receive its serial output.
+ This command copies files to the TFTP server and uses
+ TCP/IP-controlled relay to reset the target host and receive its
+ serial output.
-3. Run DHCP and TFTP server on developer's machine to PXE-boot NOVA from
-it. E.g.
+3. Run DHCP and TFTP server on developer's machine to PXE-boot the target
+host from it. E.g.
./script --dhcp-tftp
the boot menu will allow selecting between _script1_ and _script2_
configurations.
+Note that the options needed for a specific target can be stored in a
+["CONFIGURATION FILE"](#configuration-file). Then it is sufficient to use only the **-t**
+option to specify the name of the target.
+
# PHASES AND OPTIONS
-Novaboot perform its work in several phases. Each phase can be
+Novaboot performs its work in several phases. Each phase can be
influenced by several options, certain phases can be skipped. The list
-of phases with the corresponding options follows.
+of phases (in the execution order) and the corresponding options
+follow.
## Configuration reading phase
In certain cases, the location of the novaboot script cannot be
determined in this early phase. This happens either when the script is
read from the standard input or when novaboot is invoked explicitly
-and options precede the script name, as in the example ["4."](#4.) above.
+and options precede the script name, as in the example ["4."](#4) above.
In this case the current working directory is used as a starting point
for configuration file search.
-- \-c, --config=<filename>
+- -c, --config=_filename_
Use the specified configuration file instead of the default one(s).
## Command line processing phase
-- \--dump-config
+- --dump-config
Dump the current configuration to stdout end exits. Useful as an
initial template for a configuration file.
-- \-h, --help
+- -h, --help
- Print short (__\-h__) or long (__\--help__) help.
+ Print short (**-h**) or long (**--help**) help.
-- \-t, --target=<target>
+- -t, --target=_target_
This option serves as a user configurable shortcut for other novaboot
options. The effect of this option is the same as the options stored
in the `%targets` configuration variable under key _target_. See
- also ["CONFIGURATION FILE"](#CONFIGURATION FILE).
+ also ["CONFIGURATION FILE"](#configuration-file).
## Script preprocessing phase
This phases allows to modify the parsed novaboot script before it is
used in the later phases.
-- \-a, --append=<parameters>
+- -a, --append=_parameters_
- Appends a string to the first "filename" line in the novaboot script.
- This can be used to append parameters to the kernel's or root task's
- command line.
+ Append a string to the first `load` line in the novaboot script. This
+ can be used to append parameters to the kernel's or root task's
+ command line. Can appear multiple times.
-- \-b, --bender
+- -b, --bender
Use `bender` chainloader. Bender scans the PCI bus for PCI serial
ports and stores the information about them in the BIOS data area for
use by the kernel.
-- \--dump
+- --chainloader=_chainloader_
+
+ Chainloader that is loaded before the kernel and other files specified
+ in the novaboot script. E.g. 'bin/boot/bender promisc'.
+
+- --dump
- Prints the content of the novaboot script after removing comments and
- evaluating all _\--scriptmod_ expressions. Exit after reading (and
- dumping) the script.
+ Print the modules to boot and their parameters after this phase
+ finishes. Then exit. This is useful for seeing the effect of other
+ options in this section.
-- \--scriptmod=_perl expression_
+- -k, --kernel=`file`
+
+ Replace the first word on the first `load` line in the novaboot
+ script with `file`.
+
+- --scriptmod=_perl expression_
When novaboot script is read, _perl expression_ is executed for every
line (in $\_ variable). For example, `novaboot
- --scriptmod=s/sigma0/omega6/g` replaces every occurrence of _sigma0_
+ \--scriptmod=s/sigma0/omega6/g` replaces every occurrence of _sigma0_
in the script with _omega6_.
When this option is present, it overrides _$script\_modifier_ variable
is given multiple times all expressions are evaluated in the command
line order.
-- \--strip-rom
-
- Strip _rom://_ prefix from command lines and generated config files.
- The _rom://_ prefix is used by NUL. For NRE, it has to be stripped.
-
## File generation phase
In this phase, files needed for booting are generated in a so called
-_build directory_ (see TODO). In most cases configuration for a
-bootloader is generated automatically by novaboot. It is also possible
-to generate other files using _heredoc_ or _"<"_ syntax in novaboot
-scripts. Finally, binaries can be generated in this phases by running
-`scons` or `make`.
+_build directory_ (see ["--build-dir"](#build-dir)). In most cases configuration
+for a bootloader is generated automatically by novaboot. It is also
+possible to generate other files using _heredoc_ or _"<"_ syntax in
+novaboot scripts. Finally, binaries can be generated in this phases by
+running `scons` or `make`.
-- \--build-dir=<directory>
+- --build-dir=_directory_
Overrides the default build directory location.
- The default build directory location is determined as follows:
+ The default build directory location is determined as follows: If the
+ configuration file defines the `$builddir` variable, its value is
+ used. Otherwise, it is the directory that contains the first processed
+ novaboot script.
- If there is a configuration file, the value specified in the
- _$builddir_ variable is used. Otherwise, if the current working
- directory is inside git work tree and there is `build` directory at
- the top of that tree, it is used. Otherwise, if directory
- `~/nul/build` exists, it is used. Otherwise, it is the directory that
- contains the first processed novaboot script.
+ See also ["BUILDDIR"](#builddir) variable.
-- \-g, --grub\[=_filename_\]
+- -g, --grub\[=_filename_\]
Generates grub bootloader menu file. If the _filename_ is not
specified, `menu.lst` is used. The _filename_ is relative to the
- build directory (see __\--build-dir__).
+ build directory (see **--build-dir**).
-- \--grub-preamble=_prefix_
+- --grub-preamble=_prefix_
Specifies the _preable_ that is at the beginning of the generated
GRUB or GRUB2 config files. This is useful for specifying GRUB's
timeout.
-- \--grub-prefix=_prefix_
+- --grub-prefix=_prefix_
Specifies _prefix_ that is put in front of every file name in GRUB's
`menu.lst`. The default value is the absolute path to the build directory.
If the _prefix_ contains string $NAME, it will be replaced with the
- name of the novaboot script (see also __\--name__).
+ name of the novaboot script (see also **--name**).
-- \--grub2\[=_filename_\]
+- --grub2\[=_filename_\]
Generate GRUB2 menuentry in _filename_. If _filename_ is not
specified `grub.cfg` is used. The content of the menuentry can be
- customized with __\--grub-preable__, __\--grub2-prolog__ or
- __\--grub\_prefix__ options.
+ customized with **--grub-preable**, **--grub2-prolog** or
+ **--grub\_prefix** options.
In order to use the the generated menuentry on your development
machine that uses GRUB2, append the following snippet to
- `/etc/grub.d/40\_custom` file and regenerate your grub configuration,
+ `/etc/grub.d/40_custom` file and regenerate your grub configuration,
i.e. run update-grub on Debian/Ubuntu.
if [ -f /path/to/nul/build/grub.cfg ]; then
source /path/to/nul/build/grub.cfg
fi
-- \--grub2-prolog=_prolog_
+- --grub2-prolog=_prolog_
- Specifies text _preable_ that is put at the begiging of the entry
+ Specifies text _preable_ that is put at the beginning of the entry
GRUB2 entry.
-- \--name=_string_
+- -m, --make\[=make command\]
+
+ Runs `make` to build files that are not generated by novaboot itself.
+
+- --name=_string_
Use the name _string_ instead of the name of the novaboot script.
This name is used for things like a title of grub menu or for the
server directory where the boot files are copied to.
-- \--no-file-gen
+- --no-file-gen
- Do not generate files on the fly (i.e. "<" syntax) except for the
- files generated via "<<WORD" syntax.
+ Do not run external commands to generate files (i.e. "<" syntax and
+ `run` keyword). This switch does not influence generation of files
+ specified with "<<WORD" syntax.
-- \-p, --pulsar\[=mac\]
+- -p, --pulsar\[=mac\]
Generates pulsar bootloader configuration file named `config-_mac_`
The _mac_ string is typically a MAC address and defaults to
_novaboot_.
-- \--scons\[=scons command\]
+- --scons\[=scons command\]
- Runs _scons_ to build files that are not generated by novaboot
+ Runs `scons` to build files that are not generated by novaboot
itself.
+- --strip-rom
+
+ Strip _rom://_ prefix from command lines and generated config files.
+ The _rom://_ prefix is used by NUL. For NRE, it has to be stripped.
+
+- --gen-only
+
+ Exit novaboot after file generation phase.
+
## Target connection check
If supported by the target, the connection to it is made and it is
checked whether the target is not occupied by another novaboot
user/instance.
+- --amt=_"\[user\[:password\]@\]host\[:port\]_
+
+ Use Intel AMT technology to control the target machine. WS management
+ is used to powercycle it and Serial-Over-Lan (SOL) for input/output.
+ The hostname or (IP address) is given by the _host_ parameter. If
+ _password_ is not specified, environment variable AMT\_PASSWORD is
+ used. The _port_ specifies a TCP port for SOL. If not specified, the
+ default is 16992. Default _user_ is admin.
+
+- --iprelay=_addr\[:port\]_
+
+ Use TCP/IP relay and serial port to access the target's serial port
+ and powercycle it. The IP address of the relay is given by _addr_
+ parameter. If _port_ is not specified, it default to 23.
+
+ Note: This option is supposed to work with HWG-ER02a IP relays.
+
+- -s, --serial\[=device\]
+
+ Target's serial line is connected to host's serial line (device). The
+ default value for device is `/dev/ttyUSB0`.
+
+ The value of this option is exported in NB\_NOVABOOT environment
+ variable to all subprocesses run by `novaboot`.
+
+- --stty=_settings_
+
+ Specifies settings passed to `stty` invoked on the serial line
+ specified with **--serial** option. If this option is not given,
+ `stty` is called with `raw -crtscts -onlcr 115200` settings.
+
+- --remote-cmd=_cmd_
+
+ Command that mediates connection to the target's serial line. For
+ example `ssh server 'cu -l /dev/ttyS0'`.
+
+- --remote-expect=_string_
+
+ Wait for reception of _string_ after establishing the the remote
+ connection before continuing.
+
## File deployment phase
In some setups, it is necessary to copy the files needed for booting
to a particular location, e.g. to a TFTP boot server or to the
`/boot` partition.
-- \-d, --dhcp-tftp
+- -d, --dhcp-tftp
- Turns your workstation into a DHCP and TFTP server so that NOVA
- can be booted via PXE BIOS on a test machine directly connected by
- a plain Ethernet cable to your workstation.
+ Turns your workstation into a DHCP and TFTP server so that the OS can
+ be booted via PXE BIOS (or similar mechanism) on the test machine
+ directly connected by a plain Ethernet cable to your workstation.
The DHCP and TFTP servers require root privileges and `novaboot`
uses `sudo` command to obtain those. You can put the following to
_/etc/sudoers_ to allow running the necessary commands without
asking for password.
- 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 --foreground --secure -v -v -v *, /usr/bin/touch dhcpd.leases
+ 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
your_login ALL=NOPASSWD: NOVABOOT
-- \-i, --iso\[=filename\]
+- --tftp
+
+ Starts a TFTP server on your workstation. This is similar to
+ **--dhcp-tftp** except that DHCP server is not started.
+
+ The TFTP server require root privileges in order to listen on TFTP
+ port and `novaboot` uses `sudo` command to obtain those. You can put
+ the following to _/etc/sudoers_ to allow running the necessary
+ commands without asking for password.
+
+ Cmnd_Alias NOVABOOT = /usr/sbin/in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid *, /usr/bin/pkill --pidfile=tftpd.pid
+ your_login ALL=NOPASSWD: NOVABOOT
+
+- --iso\[=filename\]
Generates the ISO image that boots NOVA system via GRUB. If no filename
is given, the image is stored under _NAME_.iso, where _NAME_ is the name
- of the novaboot script (see also __\--name__).
+ of the novaboot script (see also **--name**).
-- \--server\[=\[\[user@\]server:\]path\]
+- --server\[=\[\[user@\]server:\]path\]
- Copy all files needed for booting to another location (implies __\-g__
- unless __\--grub2__ is given). The files will be copied (by __rsync__
+ Copy all files needed for booting to another location (implies **-g**
+ unless **--grub2** is given). The files will be copied (by **rsync**
tool) to the directory _path_. If the _path_ contains string $NAME,
it will be replaced with the name of the novaboot script (see also
- __\--name__).
+ **--name**).
-- \--concat
+- --concat
- If __\--server__ is used and its value ends with $NAME, then after
+ If **--server** is used and its value ends with $NAME, then after
copying the files, a new bootloader configuration file (e.g. menu.lst)
- is created at _path-wo-name_, i.e. the path specified by __\--server__
+ is created at _path-wo-name_, i.e. the path specified by **--server**
with $NAME part removed. The content of the file is created by
concatenating all files of the same name from all subdirectories of
_path-wo-name_ found on the "server".
-- \--rsync-flags=_flags_
+- --rsync-flags=_flags_
Specifies which _flags_ are appended to `rsync` command line when
- copying files as a result of _\--server_ option.
+ copying files as a result of _--server_ option.
## Target power-on and reset phase
-- \--iprelay=_addr\[:port\]_
-
- Use IP relay to reset the machine and to get the serial output. The IP
- address of the relay is given by _addr_ parameter.
+- --on, --off
- Note: This option is expected to work with HWG-ER02a IP relays.
+ Switch on/off the target machine and exit. The script (if any) is
+ completely ignored. Currently it works only with **--iprelay** or
+ **--amt**.
-- \--on, --off
+- -Q, --qemu\[=_qemu-binary_\]
- Switch on/off the target machine. Currently works only with
- __\--iprelay__.
+ Boot the configuration in qemu. Optionally, the name of qemu binary
+ can be specified as a parameter.
-- \-Q, --qemu=_qemu-binary_
-
- The name of qemu binary to use. The default is 'qemu'.
-
-- \--qemu-append=_flags_
+- --qemu-append=_flags_
Append _flags_ to the default qemu flags (QEMU\_FLAGS variable or
`-cpu coreduo -smp 2`).
-- \-q, --qemu-flags=_flags_
+- -q, --qemu-flags=_flags_
Replace the default qemu flags (QEMU\_FLAGS variable or `-cpu coreduo
- -smp 2`) with _flags_ specified here.
+ \-smp 2`) with _flags_ specified here.
+
+- --reset-cmd=_cmd_
+
+ Command that resets the target.
## Interaction with the bootloader on the target
-See __\--serial__. There will be new options soon.
+- --uboot\[=_prompt_\]
+
+ Interact with uBoot bootloader to boot the thing described in the
+ novaboot script. _prompt_ specifies the U-Boot's prompt (default is
+ "=> ", other common prompts are "U-Boot> " or "U-Boot# ").
+ Implementation of this option is currently tied to a particular board
+ that we use. It may be subject to changes in the future!
-## Target's output reception phase
+- --uboot-init
-- \-s, --serial\[=device\]
+ Command(s) to send the U-Boot bootloader before loading the images and
+ booting them. This option can be given multiple times. After sending
+ commands from each option novaboot waits for U-Boot _prompt_.
- Use serial line to control GRUB bootloader and to see the output
- serial output of the machine. The default value is `/dev/ttyUSB0`.
+## Target interaction phase
-See also __\--iprelay__.
+In this phase, target's serial output is redirected to stdout and if
+stdin is a TTY, it is redirected to the target's serial input allowing
+interactive work with the target.
-## Termination phase
+- --exiton=_string_
-Daemons that were spwned (`dhcpd` and `tftpd`) are killed here.
+ When _string_ is sent by the target, novaboot exits. This option can
+ be specified multiple times.
+
+ If _string_ is `-re`, then the next **--exiton**'s _string_ is
+ treated as regular expression. For example:
+
+ --exiton -re --exiton 'error:.*failed'
+
+- -i, --interactive
+
+ Setup things for interactive use of target. Your terminal will be
+ switched to raw mode. In raw mode, your system does not process input
+ in any way (no echoing of entered characters, no interpretation
+ special characters). This, among others, means that Ctrl-C is passed
+ to the target and does no longer interrupt novaboot. Use "~~."
+ sequence to exit novaboot.
+
+- --expect=_string_
+
+ When _string_ is received from the target, send the string specified
+ with the subsequent **--send\*** option to the target.
+
+- --expect-re=_regex_
+
+ When target's output matches regular expression _regex_, send the
+ string specified with the subsequent **--send\*** option to the target.
+
+- --expect-raw=_perl-code_
+
+ Provides direct control over Perl's Expect module.
+
+- --send=_string_
+
+ Send _string_ to the target after the previously specified
+ **--expect\*** was matched in the target's output. The _string_ may
+ contain escape sequences such as "\\n".
+
+ Note that _string_ is actually interpreted by Perl, so it can contain
+ much more that escape sequences. This behavior may change in the
+ future.
+
+ Example: `--expect='login: ' --send='root\n'`
+
+- --sendcont=_string_
+
+ Similar to **--send** but continue expecting more input.
+
+ Example: `--expect='Continue?' --sendcont='yes\n'`
# NOVABOOT SCRIPT SYNTAX
-The syntax tries to mimic POSIX shell syntax. The syntax is defined with the following rules.
+The syntax tries to mimic POSIX shell syntax. The syntax is defined
+with the following rules.
-Lines starting with "\#" are ignored.
+Lines starting with "#" and empty lines are ignored.
Lines that end with "\\" are concatenated with the following line after
removal of the final "\\" and leading whitespace of the following line.
-Lines in the form _VARIABLE=..._ (i.e. matching '^\[A-Z\_\]+=' regular
-expression) assign values to internal variables. See VARIABLES
+Lines of the form _VARIABLE=..._ (i.e. matching '^\[A-Z\_\]+=' regular
+expression) assign values to internal variables. See ["VARIABLES"](#variables)
section.
-Otherwise, the first word on the line represents the filename
-(relative to the build directory (see __\--build-dir__) of the module to
-load and the remaining words are passed as the command line
-parameters.
-
-When the line ends with "<<WORD" then the subsequent lines until the
-line containing only WORD are copied literally to the file named on
-that line.
-
-When the line ends with "< CMD" the command CMD is executed with
-`/bin/sh` and its standard output is stored in the file named on that
-line. The SRCDIR variable in CMD's environment is set to the absolute
-path of the directory containing the interpreted novaboot script.
-
-Example:
- \#!/usr/bin/env novaboot
- WVDESC=Example program
- bin/apps/sigma0.nul S0\_DEFAULT script\_start:1,1 \\
- verbose hostkeyb:0,0x60,1,12,2
- bin/apps/hello.nul
- hello.nulconfig <<EOF
- sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
- rom://bin/apps/hello.nul
- EOF
-
-This example will load three modules: sigma0.nul, hello.nul and
-hello.nulconfig. sigma0 gets some command line parameters and
-hello.nulconfig file is generated on the fly from the lines between
-<<EOF and EOF.
+Lines starting with `load` keyword represent modules to boot. The
+word after `load` is a file name (relative to the build directory
+(see **--build-dir**) of the module to load and the remaining words are
+passed to it as the command line parameters.
+
+When the `load` line ends with "<<WORD" then the subsequent lines
+until the line containing solely WORD are copied literally to the file
+named on that line. This is similar to shell's heredoc feature.
+
+When the `load` line ends with "< CMD" then command CMD is executed
+with `/bin/sh` and its standard output is stored in the file named on
+that line. The SRCDIR variable in CMD's environment is set to the
+absolute path of the directory containing the interpreted novaboot
+script.
+
+Lines starting with `run` keyword contain shell commands that are run
+during file generation phase. This is the same as the "< CMD" syntax
+for `load` keyboard except that the command's output is not
+redirected to a file. The ordering of commands is the same as they
+appear in the novaboot script.
+
+Example (Linux):
+
+ #!/usr/bin/env novaboot
+ load bzImage console=ttyS0,115200
+ run make -C buildroot
+ load rootfs.cpio < gen_cpio buildroot/images/rootfs.cpio "myapp->/etc/init.d/S99myapp"
+
+Example (NOVA User Land - NUL):
+
+ #!/usr/bin/env novaboot
+ WVDESC=Example program
+ load bin/apps/sigma0.nul S0_DEFAULT script_start:1,1 \
+ verbose hostkeyb:0,0x60,1,12,2
+ load bin/apps/hello.nul
+ load hello.nulconfig <<EOF
+ sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
+ rom://bin/apps/hello.nul
+ EOF
+
+This example will load three modules: `sigma0.nul`, `hello.nul` and
+`hello.nulconfig`. sigma0 receives some command line parameters and
+`hello.nulconfig` file is generated on the fly from the lines between
+`<<EOF` and `EOF`.
## VARIABLES
The following variables are interpreted in the novaboot script:
-- WVDESC
+- BUILDDIR
- Description of the wvtest-compliant program.
+ Novaboot chdir()s to this directory before file generation phase. The
+ directory name specified here is relative to the build directory
+ specified by other means (see ["--build-dir"](#build-dir)).
-- WVTEST\_TIMEOUT
+- EXITON
- The timeout in seconds for WvTest harness. If no complete line appears
- in the test output within the time specified here, the test fails. It
- is necessary to specify this for long running tests that produce no
- intermediate output.
+ Assigning this variable has the same effect as specifying ["--exiton"](#exiton)
+ option.
+
+- HYPERVISOR\_PARAMS
+
+ Parameters passed to hypervisor. The default value is "serial", unless
+ overridden in configuration file.
+
+- KERNEL
+
+ The kernel to use instead of the hypervisor specified in the
+ configuration file with the `$hypervisor` variable. The value should
+ contain the name of the kernel image as well as its command line
+ parameters. If this variable is defined and non-empty, the variable
+ HYPERVISOR\_PARAMS is not used.
- QEMU
- Use a specific qemu binary (can be overriden with __\-Q__) and flags
+ Use a specific qemu binary (can be overridden with **-Q**) and flags
when booting this script under qemu. If QEMU\_FLAGS variable is also
specified flags specified in QEMU variable are replaced by those in
QEMU\_FLAGS.
- QEMU\_FLAGS
- Use specific qemu flags (can be overriden with __\-q__).
+ Use specific qemu flags (can be overridden with **-q**).
-- HYPERVISOR\_PARAMS
+- WVDESC
- Parameters passed to hypervisor. The default value is "serial", unless
- overriden in configuration file.
+ Description of the wvtest-compliant program.
-- KERNEL
+- WVTEST\_TIMEOUT
- The kernel to use instead of NOVA hypervisor specified in the
- configuration file. The value should contain the name of the kernel
- image as well as its command line parameters. If this variable is
- defined and non-empty, the variable HYPERVISOR\_PARAMS is not used.
+ The timeout in seconds for WvTest harness. If no complete line appears
+ in the test output within the time specified here, the test fails. It
+ is necessary to specify this for long running tests that produce no
+ intermediate output.
# CONFIGURATION FILE
-Novaboot can read its configuration from a file. Configuration file
-was necessary in early days of novaboot. Nowadays, an attempt is made
-to not use the configuration file because it makes certain novaboot
-scripts unusable on systems without (or with different) configuration
-file. The only recommended use of the configuration file is to specify
-custom\_options (see bellow).
+Novaboot can read its configuration from one or more files. By
+default, novaboot looks for files named `.novaboot` as described in
+["Configuration reading phase"](#configuration-reading-phase). Alternatively, its location can be
+specified with the **-c** switch or with the NOVABOOT\_CONFIG
+environment variable. The configuration file has perl syntax and
+should set values of certain Perl variables. The current configuration
+can be dumped with the **--dump-config** switch. Some configuration
+variables can be overridden by environment variables (see below) or by
+command line switches.
+
+Supported configuration variables include:
-If you decide to use the configuration file, it is looked up, by
-default, in files named `.novaboot` as described in ["Configuration reading phase"](#Configuration reading phase). Alternatively, its location can be specified with the
-__\-c__ switch or with the NOVABOOT\_CONFIG environment variable. The
-configuration file has perl syntax and should set values of certain
-Perl variables. The current configuration can be dumped with the
-__\--dump-config__ switch. Some configuration variables can be overriden
-by environment variables (see below) or by command line switches.
+- $builddir
-Documentation of some configuration variables follows:
+ Build directory location relative to the location of the configuration
+ file.
-- @chainloaders
+- $default\_target
- Custom chainloaders to load before hypervisor and files specified in
- novaboot script. E.g. ('bin/boot/bender promisc', 'bin/boot/zapp').
+ Default target (see below) to use when no target is explicitly
+ specified on command line with the **--target** option.
- %targets
- Hash of shortcuts to be used with the __\--target__ option. If the hash
+ Hash of shortcuts to be used with the **--target** option. If the hash
contains, for instance, the following pair of values
'mybox' => '--server=boot:/tftproot --serial=/dev/ttyUSB0 --grub',
- NOVABOOT\_BENDER
- Defining this variable has the same meaning as __\--bender__ option.
+ Defining this variable has the same meaning as **--bender** option.
# AUTHORS
projects / novaboot.git / blobdiff