Skip to content

Commit 267f992

Browse files
committed
simulator: Add -h option for usag eand detect bad options
Add a `-h` option showing simulator usage Detect incorrect option and when this happens, show usage. Signed-off-by: Christophe de Dinechin <christophe@dinechin.org>
1 parent 7b0db18 commit 267f992

2 files changed

Lines changed: 289 additions & 126 deletions

File tree

SIMULATOR.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,25 +27,26 @@ The simulator can be started with the command-line options listed in the table b
2727

2828
| Option | Description |
2929
| --- | --- |
30+
| -D[[`<whitespace>`]`<argument>`] | Set the pattern of recorder traces to show when a test fails. |
31+
| -E[[`<whitespace>`]`<argument>`] | Like `-e`, but also prints every stack level after each command (bottom of stack first). With the normal GUI, output goes to stderr; with `-H`, to stdout. The option may be repeated. |
32+
| -H | Headless mode: do not show a window, and exit when startup commands finish. Use with `-E` for batch scripting. On Linux, uses the offscreen Qt platform; on macOS, the native platform with a hidden window. |
33+
| -I | Initialize the user's environment. WARNING: This may overwrite user configuration with defaults. |
34+
| -K | Simulate typing of individual keys during tests. |
35+
| -N | Disable beeps. Use this if you get error messages about audio drivers. |
36+
| -O[`<test>` \| all] | Only configure test-suite recorder traces (`est_<test>` or `est_.*` for `all`) without enabling automatic test execution. |
37+
| -T[`<test>` \| all] | Run tests. Without a suffix, run the full test suite. With a suffix, select individual test suites. For example `-Tmatrices` will run the `matrices` portion of the test suite. |
3038
| -d[[`<whitespace>`]`<integer>`] | Set key delay time in milliseconds to slow down tests. Default = 0 ms. |
39+
| -e[[`<whitespace>`]`<argument>`] | Evaluate an RPL command line at startup, as if typed on the command line and executed with Enter. The option may be repeated to run several commands in order. |
40+
| -h | Show command-line usage and exit. |
3141
| -i[[`<whitespace>`]`<integer>`] | Set the maximum time waiting for an image to match the expected image during testing. Default = 500 ms. |
3242
| -k[[`<whitespace>`]`<argument>`] | Load a saved keymap to change keyboard layout. |
33-
| -K | Simulate typing of individual keys during tests. |
43+
| -l | With `-E`, prefix each printed stack line with its level number (`1:` is the top of stack). Default is to print values only. |
3444
| -m[[`<whitespace>`]`<integer>`] | Set the memory size available to the calculator in kilobytes. |
3545
| -n | Enable beeps while running the test suite (noisy testing). |
3646
| -r[[`<whitespace>`]`<integer>`] | Set the time to wait for a screen update in milliseconds. Default = 20 ms. |
3747
| -s[[`<whitespace>`]`<real>`] | Scale the application window by the given floating-point scaling factor. |
3848
| -t`<trace>` | Enable the named recorder trace. Multiple traces can be enabled by using multiple `-t` options, or by using a regular expression as an argument to `-t`. |
3949
| -w[[`<whitespace>`]`<integer>`] | Set the default time the test suite waits for a command to complete, in milliseconds. You can increase this to run the test suite on a very slow machine. The default = 1000 ms. |
40-
| -D[[`<whitespace>`]`<argument>`] | Set the pattern of recorder traces to show when a test fails. |
41-
| -e[[`<whitespace>`]`<argument>`] | Evaluate an RPL command line at startup, as if typed on the command line and executed with Enter. The option may be repeated to run several commands in order. |
42-
| -E[[`<whitespace>`]`<argument>`] | Like `-e`, but also prints every stack level after each command (bottom of stack first). With the normal GUI, output goes to stderr; with `-H`, to stdout. The option may be repeated. |
43-
| -H | Headless mode: use the offscreen Qt platform, do not show a window, and exit when startup commands finish. Use with `-E` for batch scripting. Implies `QT_QPA_PLATFORM=offscreen`. |
44-
| -l | With `-E`, prefix each printed stack line with its level number (`1:` is the top of stack). Default is to print values only. |
45-
| -I | Initialize the user's environment. WARNING: This may overwrite user configuration with defaults. |
46-
| -N | Disable beeps. Use this if you get error messages about audio drivers. |
47-
| -T[`<test>` \| all] | Run tests. Without a suffix, run the full test suite. With a suffix, select individual test suites. For example `-Tmatrices` will run the `matrices` portion of the test suite. |
48-
| -O[`<test>` \| all] | Only configure test-suite recorder traces (`est_<test>` or `est_.*` for `all`) without enabling automatic test execution. |
4950

5051

5152
## Arguments

0 commit comments

Comments
 (0)