From 9c22adb8f979ce1386b600a13f5abc37ec92d696 Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Sat, 19 Sep 2020 20:05:47 +0200 Subject: [PATCH] doc/arch/sandbox.rst: reformat command line options Reformat the command line options chapter so that the command line options clearly stand out. Signed-off-by: Heinrich Schuchardt Reviewed-by: Simon Glass --- doc/arch/sandbox.rst | 57 +++++++++++++++++++++++++------------------- 1 file changed, 33 insertions(+), 24 deletions(-) diff --git a/doc/arch/sandbox.rst b/doc/arch/sandbox.rst index 360f22461a..4674c420ac 100644 --- a/doc/arch/sandbox.rst +++ b/doc/arch/sandbox.rst @@ -97,30 +97,39 @@ Command-line Options -------------------- Various options are available, mostly for test purposes. Use -h to see -available options. Some of these are described below. - -The terminal is normally in what is called 'raw-with-sigs' mode. This means -that you can use arrow keys for command editing and history, but if you -press Ctrl-C, U-Boot will exit instead of handling this as a keypress. - -Other options are 'raw' (so Ctrl-C is handled within U-Boot) and 'cooked' -(where the terminal is in cooked mode and cursor keys will not work, Ctrl-C -will exit). - -As mentioned above, -l causes the LCD emulation window to be shown. - -A device tree binary file can be provided with -d. If you edit the source -(it is stored at arch/sandbox/dts/sandbox.dts) you must rebuild U-Boot to -recreate the binary file. - -To use the default device tree, use -D. To use the test device tree, use -T. - -To execute commands directly, use the -c option. You can specify a single -command, or multiple commands separated by a semicolon, as is normal in -U-Boot. Be careful with quoting as the shell will normally process and -swallow quotes. When -c is used, U-Boot exits after the command is complete, -but you can force it to go to interactive mode instead with -i. - +available options. Some of these are described below: + +* -t, --terminal + - The terminal is normally in what is called 'raw-with-sigs' mode. This means + that you can use arrow keys for command editing and history, but if you + press Ctrl-C, U-Boot will exit instead of handling this as a keypress. + Other options are 'raw' (so Ctrl-C is handled within U-Boot) and 'cooked' + (where the terminal is in cooked mode and cursor keys will not work, Ctrl-C + will exit). + +* -l + - Show the LCD emulation window. + +* -d + - A device tree binary file can be provided with -d. If you edit the source + (it is stored at arch/sandbox/dts/sandbox.dts) you must rebuild U-Boot to + recreate the binary file. + +* -D + - To use the default device tree, use -D. + +* -T + - To use the test device tree, use -T. + +* -c [;] + - To execute commands directly, use the -c option. You can specify a single + command, or multiple commands separated by a semicolon, as is normal in + U-Boot. Be careful with quoting as the shell will normally process and + swallow quotes. When -c is used, U-Boot exits after the command is complete, + but you can force it to go to interactive mode instead with -i. + +* -i + - Go to interactive mode after executing the commands specified by -c. Memory Emulation ---------------- -- 2.39.5