# HG changeset patch
# User Mychaela Falconia <falcon@freecalypso.org>
# Date 1583885784 0
# Node ID d2e4a22744976fcb3df425697c515faefab61629
# Parent  752aef91cc959b2db5ddf9bbaab97b658a12220d
doc/Loadtools-usage: extended batch mode documented

diff -r 752aef91cc95 -r d2e4a2274497 doc/Loadtools-usage
--- a/doc/Loadtools-usage	Wed Mar 11 00:01:58 2020 +0000
+++ b/doc/Loadtools-usage	Wed Mar 11 00:16:24 2020 +0000
@@ -119,13 +119,19 @@
 In addition to the interactive mode described above, fc-loadtool can be used in
 a scripted or batch mode where it makes contact with the target device as it
 boots, interrupts and diverts the boot process to loadagent, executes a given
-command script, cleans up the target state as appropriate (usually powers off)
-and exits.  This mode is used by the FreeCalypso factory for initial flash
+command or script, cleans up the target state as appropriate (usually powers
+off) and exits.  This mode is used by the FreeCalypso factory for initial flash
 programming on the device production line, but it can also be used by end users
 to install firmware updates in a more automated manner.
 
-The batch mode is entered when there is a command script given on the
-fc-loadtool invokation command line.
+To use the batch mode, specify an exec (command script), flash or flash2 command
+on the fc-loadtool invokation command line after the target tty port name.  For
+backward compatibility, if only one extra argument (in the UNIX process argument
+list sense) is given after the target tty port name, it is interpreted as the
+name of the command script to execute, as if it was preceded by 'exec'.  Only
+flash and flash2 commands can be given directly without going through a script;
+if you need to run other commands in batch mode, you will need to put them into
+a script file.
 
 Command line options
 ====================
@@ -135,7 +141,7 @@
 
 fc-iram [options] ttyport iramimage.srec [2ndprog]
 fc-xram [options] ttyport xramimage.srec [2ndprog]
-fc-loadtool [options] ttyport [batch-script]
+fc-loadtool [options] ttyport [batch command]
 
 The available options are common for all 3 utilities, with a few noted
 exceptions: