README.md

   1 # NAME
   2
   3 novaboot - Boots a locally compiled operating system on a remote
   4 target or in qemu
   5
   6 # SYNOPSIS
   7
   8 **novaboot** --help
   9
  10 **novaboot** \[option\]... \[--\] script...
  11
  12 **./script** \[option\]...
  13
  14 # DESCRIPTION
  15
  16 This program makes booting of a locally compiled operating system (OS)
  17 (e.g. NOVA or Linux) on remote targets as simple as running a program
  18 locally. It automates things like copying OS images to a TFTP server,
  19 generation of bootloader configuration files, resetting of target
  20 hardware or redirection of target's serial line to stdin/out. Novaboot
  21 is highly configurable and it makes it easy to boot a single image on
  22 different targets or different images on a single target.
  23
  24 Novaboot operation is controlled by command line options and by a so
  25 called novaboot script, which can be thought as a generalization of
  26 bootloader configuration files (see ["NOVABOOT SCRIPT SYNTAX"](#novaboot-script-syntax)).
  27 Typical way of using novaboot is to make the novaboot script
  28 executable and set its first line to _#!/usr/bin/env novaboot_. Then,
  29 booting a particular OS configuration becomes the same as executing a
  30 local program - the novaboot script.
  31
  32 Novaboot uses configuration files to, among other things, define
  33 command line options needed for different targets. Users typically use
  34 only the **-t**/**--target** command line option to select the target.
  35 Internally, this option expands to the pre-configured options.
  36 Configuration files are searched at multiple places, which allows to
  37 have per-system, per-user or per-project configurations. Configuration
  38 file syntax is described in section ["CONFIGURATION FILE"](#configuration-file).
  39
  40 Simple examples of using `novaboot`:
  41
  42 1. Run an OS in Qemu. This is the default action when no other action is
  43 specified by command line switches. Thus running `novaboot myos` (or
  44 `./myos` as described above) will run Qemu and make it boot the
  45 configuration specified in the `myos` script.
  46 2. Create a bootloader configuration file (currently supported
  47 bootloaders are GRUB, GRUB2, ISOLINUX, Pulsar and U-Boot) and copy it
  48 with all other files needed for booting to a remote boot server. Then
  49 use a TCP/IP-controlled relay/serial-to-TCP converter to reset the
  50 target and receive its serial output.
  51
  52         ./myos --grub2 --server=192.168.1.1:/tftp --iprelay=192.168.1.2
  53
  54 3. Run DHCP and TFTP server on developer's machine to boot the target
  55 from it.
  56
  57         ./myos --dhcp-tftp
  58
  59     This is useful when no network infrastructure is in place and
  60     the target is connected directly to developer's box.
  61
  62 4. Create bootable ISO image.
  63
  64         novaboot --iso -- script1 script2
  65
  66     The created ISO image will have ISOLINUX bootloader installed on it
  67     and the boot menu will allow selecting between _script1_ and
  68     _script2_ configurations.
  69
  70 # PHASES AND OPTIONS
  71
  72 Novaboot performs its work in several phases. Each phase can be
  73 influenced by several command line options, certain phases can be
  74 skipped. The list of phases (in the execution order) and the
  75 corresponding options follows.
  76
  77 ## Configuration reading phase
  78
  79 After starting, novaboot reads configuration files. Their content is
  80 described in section ["CONFIGURATION FILE"](#configuration-file). By default,
  81 configuration is read from two locations. First from the configuration
  82 directory and second from `.novaboot` files along the path to the
  83 current directory. The latter read files override settings from the
  84 former ones.
  85
  86 Configuration directory is determined by the content of
  87 NOVABOOT\_CONFIG\_DIR environment variable and defaults to
  88 `/etc/novaboot.d`. Files in this directory with names consisting
  89 solely of English letters, numbers, dashes '-' and underscores '\_'
  90 (note that dot '.' is not included) are read in alphabetical order.
  91
  92 Then novaboot searches for files named `.novaboot` starting from the
  93 directory of the novaboot script (or working directory, see bellow)
  94 and continuing upwards up to the root directory. The found
  95 configuration files are then read in the opposite order (i.e. from the
  96 root directory downwards). This allows to have, for example, user
  97 specific configuration in `~/.novaboot` and project specific one in
  98 `~/project/.novaboot`.
  99
 100 In certain cases, the location of the novaboot script cannot be
 101 determined in this early phase. This happens either when the script is
 102 read from the standard input or when novaboot is invoked explicitly as
 103 in the example ["4."](#4) above. In this case the current working
 104 directory is used as a starting point for configuration file search
 105 instead of the novaboot script directory.
 106
 107 - -c, --config=_filename_
 108
 109     Use the specified configuration file instead of the default one(s).
 110
 111 ## Command line processing phase
 112
 113 - --dump-config
 114
 115     Dump the current configuration to stdout end exit. Useful as an
 116     initial template for a configuration file.
 117
 118 - -h, --help
 119
 120     Print short (**-h**) or long (**--help**) help.
 121
 122 - -t, --target=_target_
 123
 124     This option serves as a user configurable shortcut for other novaboot
 125     options. The effect of this option is the same as the options stored
 126     in the `%targets` configuration variable under key _target_. See
 127     also ["CONFIGURATION FILE"](#configuration-file).
 128
 129 ## Script preprocessing phase
 130
 131 This phases allows to modify the parsed novaboot script before it is
 132 used in the later phases.
 133
 134 - -a, --append=_parameters_
 135
 136     Append a string to the first `load` line in the novaboot script. This
 137     can be used to append parameters to the kernel's or root task's
 138     command line. This option can appear multiple times.
 139
 140 - -b, --bender
 141
 142     Use `bender` chainloader. Bender scans the PCI bus for PCI serial
 143     ports and stores the information about them in the BIOS data area for
 144     use by the kernel.
 145
 146 - --chainloader=_chainloader_
 147
 148     Specifies a chainloader that is loaded before the kernel and other
 149     files specified in the novaboot script. E.g. 'bin/boot/bender
 150     promisc'.
 151
 152 - --dump
 153
 154     Print the modules to boot and their parameters after this phase
 155     finishes. Then exit. This is useful for seeing the effect of other
 156     options in this section.
 157
 158 - -k, --kernel=`file`
 159
 160     Replace the first word on the first `load` line in the novaboot
 161     script with `file`.
 162
 163 - --scriptmod=_perl expression_
 164
 165     When novaboot script is read, _perl expression_ is executed for every
 166     line (in $\_ variable). For example, `novaboot
 167     \--scriptmod=s/sigma0/omega6/g` replaces every occurrence of _sigma0_
 168     in the script with _omega6_.
 169
 170     When this option is present, it overrides _$script\_modifier_ variable
 171     from the configuration file, which has the same effect. If this option
 172     is given multiple times all expressions are evaluated in the command
 173     line order.
 174
 175 ## File generation phase
 176
 177 In this phase, files needed for booting are generated in a so called
 178 _build directory_ (see ["--build-dir"](#build-dir)). In most cases configuration
 179 for a bootloader is generated automatically by novaboot. It is also
 180 possible to generate other files using _heredoc_ or _"<"_ syntax in
 181 novaboot scripts. Finally, binaries can be generated in this phases by
 182 running `scons` or `make`.
 183
 184 - --build-dir=_directory_
 185
 186     Overrides the default build directory location.
 187
 188     The default build directory location is determined as follows: If the
 189     configuration file defines the `$builddir` variable, its value is
 190     used. Otherwise, it is the directory that contains the first processed
 191     novaboot script.
 192
 193     See also ["BUILDDIR"](#builddir) variable.
 194
 195 - -g, --grub\[=_filename_\]
 196
 197     Generates grub bootloader menu file. If the _filename_ is not
 198     specified, `menu.lst` is used. The _filename_ is relative to the
 199     build directory (see **--build-dir**).
 200
 201 - --grub-preamble=_prefix_
 202
 203     Specifies the _preable_ that is at the beginning of the generated
 204     GRUB or GRUB2 config files. This is useful for specifying GRUB's
 205     timeout.
 206
 207 - --prefix=_prefix_
 208
 209     Specifies _prefix_ (e.g. `/srv/tftp`) that is put in front of every
 210     file name in generated bootloader configuration files (or in U-Boot
 211     commands).
 212
 213     If the _prefix_ contains string $NAME, it will be replaced with the
 214     name of the novaboot script (see also **--name**).
 215
 216     If the _prefix_ contains string $BUILDDIR, it will be replaced with
 217     the build directory (see also **--build-dir**).
 218
 219 - --grub-prefix
 220
 221     Alias for **--prefix**.
 222
 223 - --grub2\[=_filename_\]
 224
 225     Generate GRUB2 menu entry in _filename_. If _filename_ is not
 226     specified `grub.cfg` is used. The content of the menu entry can be
 227     customized with **--grub-preamble**, **--grub2-prolog** or
 228     **--grub\_prefix** options.
 229
 230     In order to use the the generated menu entry on your development
 231     machine that uses GRUB2, append the following snippet to
 232     `/etc/grub.d/40_custom` file and regenerate your grub configuration,
 233     i.e. run update-grub on Debian/Ubuntu.
 234
 235         if [ -f /path/to/nul/build/grub.cfg ]; then
 236           source /path/to/nul/build/grub.cfg
 237         fi
 238
 239 - --grub2-prolog=_prolog_
 240
 241     Specifies text that is put at the beginning of the GRUB2 menu entry.
 242
 243 - -m, --make\[=make command\]
 244
 245     Runs `make` to build files that are not generated by novaboot itself.
 246
 247 - --name=_string_
 248
 249     Use the name _string_ instead of the name of the novaboot script.
 250     This name is used for things like a title of grub menu or for the
 251     server directory where the boot files are copied to.
 252
 253 - --no-file-gen
 254
 255     Do not run external commands to generate files (i.e. "<" syntax and
 256     `run` keyword). This switch does not influence generation of files
 257     specified with "<<WORD" syntax.
 258
 259 - -p, --pulsar\[=mac\]
 260
 261     Generates pulsar bootloader configuration file named `config-_mac_`
 262     The _mac_ string is typically a MAC address and defaults to
 263     _novaboot_.
 264
 265 - --scons\[=scons command\]
 266
 267     Runs `scons` to build files that are not generated by novaboot
 268     itself.
 269
 270 - --strip-rom
 271
 272     Strip _rom://_ prefix from command lines and generated config files.
 273     The _rom://_ prefix is used by NUL. For NRE, it has to be stripped.
 274
 275 - --gen-only
 276
 277     Exit novaboot after file generation phase.
 278
 279 ## Target connection check
 280
 281 If supported by the target, the connection to it is made and it is
 282 checked whether the target is not occupied by another novaboot
 283 user/instance.
 284
 285 - --amt=_"\[user\[:password\]@\]host\[:port\]_
 286
 287     Use Intel AMT technology to control the target machine. WS management
 288     is used to powercycle it and Serial-Over-Lan (SOL) for input/output.
 289     The hostname or (IP address) is given by the _host_ parameter. If
 290     _password_ is not specified, environment variable AMT\_PASSWORD is
 291     used. The _port_ specifies a TCP port for SOL. If not specified, the
 292     default is 16992. Default _user_ is admin.
 293
 294 - --iprelay=_addr\[:port\]_
 295
 296     Use TCP/IP relay and serial port to access the target's serial port
 297     and powercycle it. The IP address of the relay is given by _addr_
 298     parameter. If _port_ is not specified, it default to 23.
 299
 300     Note: This option is supposed to work with HWG-ER02a IP relays.
 301
 302 - -s, --serial\[=device\]
 303
 304     Target's serial line is connected to host's serial line (device). The
 305     default value for device is `/dev/ttyUSB0`.
 306
 307     The value of this option is exported in NB\_NOVABOOT environment
 308     variable to all subprocesses run by `novaboot`.
 309
 310 - --stty=_settings_
 311
 312     Specifies settings passed to `stty` invoked on the serial line
 313     specified with **--serial** option. If this option is not given,
 314     `stty` is called with `raw -crtscts -onlcr 115200` settings.
 315
 316 - --remote-cmd=_cmd_
 317
 318     Command that mediates connection to the target's serial line. For
 319     example `ssh server 'cu -l /dev/ttyS0'`.
 320
 321 - --remote-expect=_string_
 322
 323     Wait for reception of _string_ after establishing the the remote
 324     connection before continuing.
 325
 326 ## File deployment phase
 327
 328 In some setups, it is necessary to copy the files needed for booting
 329 to a particular location, e.g. to a TFTP boot server or to the
 330 `/boot` partition.
 331
 332 - -d, --dhcp-tftp
 333
 334     Turns your workstation into a DHCP and TFTP server so that the OS can
 335     be booted via PXE BIOS (or similar mechanism) on the test machine
 336     directly connected by a plain Ethernet cable to your workstation.
 337
 338     The DHCP and TFTP servers requires root privileges and `novaboot`
 339     uses `sudo` command to obtain those. You can put the following to
 340     _/etc/sudoers_ to allow running the necessary commands without asking
 341     for password.
 342
 343         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
 344         your_login ALL=NOPASSWD: NOVABOOT
 345
 346 - --tftp
 347
 348     Starts a TFTP server on your workstation. This is similar to
 349     **--dhcp-tftp** except that DHCP server is not started.
 350
 351     The TFTP server require root privileges and `novaboot` uses `sudo`
 352     command to obtain those. You can put the following to _/etc/sudoers_
 353     to allow running the necessary commands without asking for password.
 354
 355         Cmnd_Alias NOVABOOT =  /usr/sbin/in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid *, /usr/bin/pkill --pidfile=tftpd.pid
 356         your_login ALL=NOPASSWD: NOVABOOT
 357
 358 - --tftp-port=_port_
 359
 360     Port to run the TFTP server on. Implies **--tftp**.
 361
 362 - --iso\[=filename\]
 363
 364     Generates the ISO image that boots NOVA system via GRUB. If no filename
 365     is given, the image is stored under _NAME_.iso, where _NAME_ is the name
 366     of the novaboot script (see also **--name**).
 367
 368 - --server\[=\[\[user@\]server:\]path\]
 369
 370     Copy all files needed for booting to another location. The files will
 371     be copied (by **rsync** tool) to the directory _path_. If the _path_
 372     contains string $NAME, it will be replaced with the name of the
 373     novaboot script (see also **--name**).
 374
 375 - --rsync-flags=_flags_
 376
 377     Specifies which _flags_ are appended to `rsync` command line when
 378     copying files as a result of _--server_ option.
 379
 380 - --concat
 381
 382     If **--server** is used and its value ends with $NAME, then after
 383     copying the files, a new bootloader configuration file (e.g. menu.lst)
 384     is created at _path-wo-name_, i.e. the path specified by **--server**
 385     with $NAME part removed. The content of the file is created by
 386     concatenating all files of the same name from all subdirectories of
 387     _path-wo-name_ found on the "server".
 388
 389 - --ider
 390
 391     Use Intel AMT technology for IDE redirection. This allows the target
 392     machine to boot from novaboot created ISO image. Implies **--iso**.
 393
 394     The experimental `amtider` utility needed by this option can be
 395     obtained from https://github.com/wentasah/amtterm.
 396
 397 ## Target power-on and reset phase
 398
 399 At this point, the target is reset (or switched on/off). There is
 400 several ways how this can be accomplished. Resetting a physical target
 401 can currently be accomplished by the following options: **--amt**,
 402 **--iprelay**, **--reset-cmd**.
 403
 404 - --on, --off
 405
 406     Switch on/off the target machine and exit. The script (if any) is
 407     completely ignored. Currently it works only with **--iprelay** or
 408     **--amt**.
 409
 410 - -Q, --qemu\[=_qemu-binary_\]
 411
 412     Boot the configuration in qemu. Optionally, the name of qemu binary
 413     can be specified as a parameter.
 414
 415 - --qemu-append=_flags_
 416
 417     Append _flags_ to the default qemu flags (QEMU\_FLAGS variable or
 418     `-cpu coreduo -smp 2`).
 419
 420 - -q, --qemu-flags=_flags_
 421
 422     Replace the default qemu flags (QEMU\_FLAGS variable or `-cpu coreduo
 423     \-smp 2`) with _flags_ specified here.
 424
 425 - --reset-cmd=_cmd_
 426
 427     Command that resets the target.
 428
 429 - --no-reset, --reset
 430
 431     Disable/enable reseting of the target.
 432
 433 ## Interaction with the bootloader on the target
 434
 435 - --uboot\[=_prompt_\]
 436
 437     Interact with U-Boot bootloader to boot the thing described in the
 438     novaboot script. _prompt_ specifies the U-Boot's prompt (default is
 439     "=> ", other common prompts are "U-Boot> " or "U-Boot# ").
 440     Implementation of this option is currently tied to a particular board
 441     that we use. It may be subject to changes in the future!
 442
 443 - --uboot-init
 444
 445     Command(s) to send the U-Boot bootloader before loading the images and
 446     booting them. This option can be given multiple times. After sending
 447     commands from each option novaboot waits for U-Boot _prompt_.
 448
 449     If the command contains string _$NB\_MYIP_ then this string is
 450     replaced by IPv4 address of eth0 interface. Similarly _$NB\_PREFIX_ is
 451     replaced with prefix given by **--prefix**.
 452
 453     See also `uboot` keyword in ["NOVABOOT SCRIPT SYNTAX"](#novaboot-script-syntax)).
 454
 455 - --uboot-addr _name_=_address_
 456
 457     Load address of U-Boot's `tftpboot` command for loading _name_,
 458     where name is one of _kernel_, _ramdisk_ or _fdt_ (flattened device
 459     tree).
 460
 461 ## Target interaction phase
 462
 463 In this phase, target's serial output is redirected to stdout and if
 464 stdin is a TTY, it is redirected to the target's serial input allowing
 465 interactive work with the target.
 466
 467 - --exiton=_string_
 468
 469     When _string_ is sent by the target, novaboot exits. This option can
 470     be specified multiple times, in which case novaboot exits whenever
 471     either of the specified strings is sent.
 472
 473     If _string_ is `-re`, then the next **--exiton**'s _string_ is
 474     treated as regular expression. For example:
 475
 476         --exiton -re --exiton 'error:.*failed'
 477
 478 - --exiton-re=_regex_
 479
 480     The same as --exiton -re --exiton _regex_.
 481
 482 - --exiton-timeout=_seconds_
 483
 484     By default **--exiton** waits for the string match forever. When this
 485     option is specified, "exiton" timeouts after the specifies number of
 486     seconds and novaboot returns non-zero exit code.
 487
 488 - -i, --interactive
 489
 490     Setup things for interactive use of target. Your terminal will be
 491     switched to raw mode. In raw mode, your system does not process input
 492     in any way (no echoing of entered characters, no interpretation
 493     special characters). This, among others, means that Ctrl-C is passed
 494     to the target and does no longer interrupt novaboot. Use "~~."
 495     sequence to exit novaboot.
 496
 497 - --expect=_string_
 498
 499     When _string_ is received from the target, send the string specified
 500     with the subsequent **--send\*** option to the target.
 501
 502 - --expect-re=_regex_
 503
 504     When target's output matches regular expression _regex_, send the
 505     string specified with the subsequent **--send\*** option to the target.
 506
 507 - --expect-raw=_perl-code_
 508
 509     Provides direct control over Perl's Expect module.
 510
 511 - --send=_string_
 512
 513     Send _string_ to the target after the previously specified
 514     **--expect\*** was matched in the target's output. The _string_ may
 515     contain escape sequences such as "\\n".
 516
 517     Note that _string_ is actually interpreted by Perl, so it can contain
 518     much more that escape sequences. This behavior may change in the
 519     future.
 520
 521     Example: `--expect='login: ' --send='root\n'`
 522
 523 - --sendcont=_string_
 524
 525     Similar to **--send** but continue expecting more input.
 526
 527     Example: `--expect='Continue?' --sendcont='yes\n'`
 528
 529 # NOVABOOT SCRIPT SYNTAX
 530
 531 The syntax tries to mimic POSIX shell syntax. The syntax is defined
 532 with the following rules.
 533
 534 Lines starting with "#" and empty lines are ignored.
 535
 536 Lines that end with "\\" are concatenated with the following line after
 537 removal of the final "\\" and leading whitespace of the following line.
 538
 539 Lines of the form _VARIABLE=..._ (i.e. matching '^\[A-Z\_\]+=' regular
 540 expression) assign values to internal variables. See ["VARIABLES"](#variables)
 541 section.
 542
 543 Lines starting with `load` keyword represent modules to boot. The
 544 word after `load` is a file name (relative to the build directory
 545 (see **--build-dir**) of the module to load and the remaining words are
 546 passed to it as the command line parameters.
 547
 548 When the `load` line ends with "<<WORD" then the subsequent lines
 549 until the line containing solely WORD are copied literally to the file
 550 named on that line. This is similar to shell's heredoc feature.
 551
 552 When the `load` line ends with "< CMD" then command CMD is executed
 553 with `/bin/sh` and its standard output is stored in the file named on
 554 that line. The SRCDIR variable in CMD's environment is set to the
 555 absolute path of the directory containing the interpreted novaboot
 556 script.
 557
 558 Lines starting with `run` keyword contain shell commands that are run
 559 during file generation phase. This is the same as the "< CMD" syntax
 560 for `load` keyboard except that the command's output is not
 561 redirected to a file. The ordering of commands is the same as they
 562 appear in the novaboot script.
 563
 564 Lines starting with `uboot` represent U-Boot commands that are sent
 565 to the target if **--uboot** option is given. Having a U-Boot line in
 566 the novaboot script is the same as passing an equivalent
 567 **--uboot-init** option to novaboot. The `uboot` keyword can be
 568 suffixed with timeout specification. The syntax is `uboot:Ns`, where
 569 `N` is the whole number of seconds. If the U-Boot command prompt does
 570 not appear before the timeout, novaboot fails. The default timeout is
 571 10 seconds.
 572
 573 Example (Linux):
 574
 575     #!/usr/bin/env novaboot
 576     load bzImage console=ttyS0,115200
 577     run  make -C buildroot
 578     load rootfs.cpio < gen_cpio buildroot/images/rootfs.cpio "myapp->/etc/init.d/S99myapp"
 579
 580 Example (NOVA User Land - NUL):
 581
 582     #!/usr/bin/env novaboot
 583     WVDESC=Example program
 584     load bin/apps/sigma0.nul S0_DEFAULT script_start:1,1 \
 585                              verbose hostkeyb:0,0x60,1,12,2
 586     load bin/apps/hello.nul
 587     load hello.nulconfig <<EOF
 588     sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
 589     rom://bin/apps/hello.nul
 590     EOF
 591
 592 This example will load three modules: `sigma0.nul`, `hello.nul` and
 593 `hello.nulconfig`. sigma0 receives some command line parameters and
 594 `hello.nulconfig` file is generated on the fly from the lines between
 595 `<<EOF` and `EOF`.
 596
 597 ## VARIABLES
 598
 599 The following variables are interpreted in the novaboot script:
 600
 601 - BUILDDIR
 602
 603     Novaboot chdir()s to this directory before file generation phase. The
 604     directory name specified here is relative to the build directory
 605     specified by other means (see ["--build-dir"](#build-dir)).
 606
 607 - EXITON
 608
 609     Assigning this variable has the same effect as specifying ["--exiton"](#exiton)
 610     option.
 611
 612 - HYPERVISOR\_PARAMS
 613
 614     Parameters passed to hypervisor. The default value is "serial", unless
 615     overridden in configuration file.
 616
 617 - KERNEL
 618
 619     The kernel to use instead of the hypervisor specified in the
 620     configuration file with the `$hypervisor` variable. The value should
 621     contain the name of the kernel image as well as its command line
 622     parameters. If this variable is defined and non-empty, the variable
 623     HYPERVISOR\_PARAMS is not used.
 624
 625 - NO\_BOOT
 626
 627     If this variable is 1, the system is not booted. This is currently
 628     only implemented for U-Boot bootloader where it is useful for
 629     interacting with the bootloader without booting the system - e.g. for
 630     flashing.
 631
 632 - QEMU
 633
 634     Use a specific qemu binary (can be overridden with **-Q**) and flags
 635     when booting this script under qemu. If QEMU\_FLAGS variable is also
 636     specified flags specified in QEMU variable are replaced by those in
 637     QEMU\_FLAGS.
 638
 639 - QEMU\_FLAGS
 640
 641     Use specific qemu flags (can be overridden with **-q**).
 642
 643 - WVDESC
 644
 645     Description of the WvTest-compliant program.
 646
 647 - WVTEST\_TIMEOUT
 648
 649     The timeout in seconds for WvTest harness. If no complete line appears
 650     in the test output within the time specified here, the test fails. It
 651     is necessary to specify this for long running tests that produce no
 652     intermediate output.
 653
 654 # CONFIGURATION FILE
 655
 656 Novaboot can read its configuration from one or more files. By
 657 default, novaboot looks for files in `/etc/novaboot.d` and files
 658 named `.novaboot` as described in ["Configuration reading phase"](#configuration-reading-phase).
 659 Alternatively, configuration file location can be specified with the
 660 **-c** switch or with the NOVABOOT\_CONFIG environment variable. The
 661 configuration file has Perl syntax (i.e. it is better to put `1;` as
 662 a last line) and should set values of certain Perl variables. The
 663 current configuration can be dumped with the **--dump-config** switch.
 664 Some configuration variables can be overridden by environment
 665 variables (see below) or by command line switches.
 666
 667 Supported configuration variables include:
 668
 669 - $builddir
 670
 671     Build directory location relative to the location of the configuration
 672     file.
 673
 674 - $default\_target
 675
 676     Default target (see below) to use when no target is explicitly
 677     specified on command line with the **--target** option.
 678
 679 - %targets
 680
 681     Hash of target definitions to be used with the **--target** option. The
 682     key is the identifier of the target, the value is the string with
 683     command line options. For instance, if the configuration file contains:
 684
 685         $targets{'mybox'} = '--server=boot:/tftproot --serial=/dev/ttyUSB0 --grub',
 686
 687     then the following two commands are equivalent:
 688
 689         ./myos --server=boot:/tftproot --serial=/dev/ttyUSB0 --grub
 690         ./myos -t mybox
 691
 692 # ENVIRONMENT VARIABLES
 693
 694 Some options can be specified not only via config file or command line
 695 but also through environment variables. Environment variables override
 696 the values from configuration file and command line parameters
 697 override the environment variables.
 698
 699 - NOVABOOT\_CONFIG
 700
 701     Name of the novaboot configuration file to use instead of the default
 702     one(s).
 703
 704 - NOVABOOT\_CONFIG\_DIR
 705
 706     Name of the novaboot configuration directory. When not specified
 707     `/etc/novaboot.d` is used.
 708
 709 - NOVABOOT\_BENDER
 710
 711     Defining this variable has the same meaning as **--bender** option.
 712
 713 # AUTHORS
 714
 715 Michal Sojka <sojka@os.inf.tu-dresden.de>