Improve --exiton doc

[novaboot.git] / README.md

diff --git a/README.md b/README.md
index c8c5eab01cdea64662873871a14496b0bbad10cd..904c8d6d17a940e315166baf5b55b1a5daa65239 100644 (file)
--- a/README.md
+++ b/README.md
@@ -425,6 +425,10 @@ can currently be accomplished by the following options: **--amt**,
 
     Command that resets the target.
 
+- --no-reset, --reset
+
+    Disable/enable reseting of the target.
+
 ## Interaction with the bootloader on the target
 
 - --uboot\[=_prompt_\]
@@ -442,7 +446,10 @@ can currently be accomplished by the following options: **--amt**,
     commands from each option novaboot waits for U-Boot _prompt_.
 
     If the command contains string _$NB\_MYIP_ then this string is
-    replaced by IPv4 address of eth0 interface.
+    replaced by IPv4 address of eth0 interface. Similarly _$NB\_PREFIX_ is
+    replaced with prefix given by **--prefix**.
+
+    See also `uboot` keyword in ["NOVABOOT SCRIPT SYNTAX"](#novaboot-script-syntax)).
 
 - --uboot-addr _name_=_address_
 
@@ -459,13 +466,18 @@ interactive work with the target.
 - --exiton=_string_
 
     When _string_ is sent by the target, novaboot exits. This option can
-    be specified multiple times.
+    be specified multiple times, in which case novaboot exits whenever
+    either of the specified strings is sent.
 
     If _string_ is `-re`, then the next **--exiton**'s _string_ is
     treated as regular expression. For example:
 
         --exiton -re --exiton 'error:.*failed'
 
+- --exiton-re=_regex_
+
+    The same as --exiton -re --exiton _regex_.
+
 - -i, --interactive
 
     Setup things for interactive use of target. Your terminal will be
@@ -542,6 +554,15 @@ 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.
 
+Lines starting with `uboot` represent U-Boot commands that are sent
+to the target if **--uboot** option is given. Having a U-Boot line in
+the novaboot script is the same as passing an equivalent
+**--uboot-init** option to novaboot. The `uboot` keyword can be
+suffixed with timeout specification. The syntax is `uboot:Ns`, where
+`N` is the whole number of seconds. If the U-Boot command prompt does
+not appear before the timeout, novaboot fails. The default timeout is
+10 seconds.
+
 Example (Linux):
 
     #!/usr/bin/env novaboot
@@ -594,6 +615,13 @@ The following variables are interpreted in the novaboot script:
     parameters. If this variable is defined and non-empty, the variable
     HYPERVISOR\_PARAMS is not used.
 
+- NO\_BOOT
+
+    If this variable is 1, the system is not booted. This is currently
+    only implemented for U-Boot bootloader where it is useful for
+    interacting with the bootloader without booting the system - e.g. for
+    flashing.
+
 - QEMU
 
     Use a specific qemu binary (can be overridden with **-Q**) and flags