Do not use nproc to determine the number of processors

[novaboot.git] / README.md

diff --git a/README.md b/README.md
index bf9e39d0557c71a16d066e4bea76d2b2c9884469..8551f502c2b7a3c0fd712fdaea490addadc556a9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -39,10 +39,10 @@ file syntax is described in section ["CONFIGURATION FILE"](#configuration-file).
 
 Simple examples of using `novaboot`:
 
-1. Run an OS in Qemu. This is the default action when no other action is
-specified by command line switches. Thus running `novaboot myos` (or
-`./myos` as described above) will run Qemu and make it boot the
-configuration specified in the `myos` script.
+1. Run an OS in Qemu. This is can be specified with the **--qemu** option.
+Thus running `novaboot --qemu myos` (or `./myos --qemu` as described
+above) will run Qemu and make it boot the configuration specified in
+the `myos` script.
 2. Create a bootloader configuration file (currently supported
 bootloaders are GRUB, GRUB2, ISOLINUX, Pulsar and U-Boot) and copy it
 with all other files needed for booting to a remote boot server. Then
@@ -132,9 +132,13 @@ instead of the novaboot script directory.
 - -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).
+    options. The effect of this option is the same as specifying the
+    options stored in the `%targets` configuration variable under key
+    _target_. See also ["CONFIGURATION FILE"](#configuration-file).
+
+    When this option is not given, novaboot tries to determine the target
+    to use from either **NOVABOOT\_TARGET** environment variable or from
+    **$default\_target** configuration file variable.
 
 ## Script preprocessing phase
 
@@ -330,8 +334,15 @@ user/instance.
 
 - --remote-expect=_string_
 
-    Wait for reception of _string_ after establishing the the remote
-    connection before continuing.
+    Wait for reception of _string_ after establishing the remote
+    connection.
+
+- --remote-expect-silent=_string_
+
+    The same as **--remote-expect** except that the remote output is not
+    echoed to stdout while waiting for the _string_. Everything after the
+    matched string is printed to stdout, so you may want to include line
+    end characters in the _string_ as well.
 
 ## File deployment phase
 
@@ -450,6 +461,10 @@ can currently be accomplished by the following options: **--amt**,
     Implementation of this option is currently tied to a particular board
     that we use. It may be subject to changes in the future!
 
+- --no-uboot
+
+    Disable U-Boot interaction previously enabled with **--uboot**.
+
 - --uboot-init
 
     Command(s) to send the U-Boot bootloader before loading the images and
@@ -519,6 +534,11 @@ interactive work with the target.
     to the target and does no longer interrupt novaboot. Use "~~."
     sequence to exit novaboot.
 
+- --no-interaction, --interaction
+
+    Skip resp. force target interaction phase. When skipped, novaboot exits
+    immediately when boot is initiated.
+
 - --expect=_string_
 
     When _string_ is received from the target, send the string specified
@@ -704,7 +724,8 @@ Supported configuration variables include:
 - $default\_target
 
     Default target (see below) to use when no target is explicitly
-    specified on command line with the **--target** option.
+    specified with the **--target** command line option or
+    **NOVABOOT\_TARGET** environment variable.
 
 - %targets
 
@@ -736,6 +757,12 @@ override the environment variables.
     Name of the novaboot configuration directory. When not specified
     `/etc/novaboot.d` is used.
 
+- NOVABOOT\_TARGET
+
+    Name of the novaboot target to use. This overrides the value of
+    **$default\_target** from the configuration file and can be overriden
+    with the **--target** command line option.
+
 - NOVABOOT\_BENDER
 
     Defining this variable has the same meaning as **--bender** option.