diff options
| author | Heinrich Schuchardt | 2021-01-25 01:11:47 +0100 |
|---|---|---|
| committer | Heinrich Schuchardt | 2021-01-25 01:15:34 +0100 |
| commit | 5b6dac01e636aa8b799a68c115d9fd86e4bbbf09 (patch) | |
| tree | b15d6e3db84ca57b85cea83f957cd7bfc2299a1b /doc | |
| parent | bce86e075fbe8b54262b73380846f10a9e9a0c0d (diff) | |
doc: describe command conitrace
Provide a man-page for the conitrace command.
Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/usage/conitrace.rst | 54 | ||||
| -rw-r--r-- | doc/usage/index.rst | 1 |
2 files changed, 55 insertions, 0 deletions
diff --git a/doc/usage/conitrace.rst b/doc/usage/conitrace.rst new file mode 100644 index 00000000000..d9916c865ee --- /dev/null +++ b/doc/usage/conitrace.rst @@ -0,0 +1,54 @@ +conitrace command +================= + +Synopsis +-------- + +:: + + conitrace + +Description +----------- + +The conitrace command is used to test the correct function of the console input +driver. It is especially valuable for checking the support for special keys like +<F1> or <POS1>. + +To display escape sequences on a single line the output only advances to the +next line after detecting a pause of a few milliseconds. + +The output is hexadecimal. + +Examples +-------- + +Entering keys <B><SHIFT-B><CTRL-B><X> + +:: + + => conitrace + Waiting for your input + To terminate type 'x' + 62 + 42 + 02 + => + +Entering keys <F1><POS1><DEL><BACKSPACE><X> + +:: + + => conitrace + Waiting for your input + To terminate type 'x' + 1b 4f 50 + 1b 5b 48 + 1b 5b 33 7e + 7f + => + +Configuration +------------- + +The conitrace command is only available if CONFIG_CMD_CONITRACE=y. diff --git a/doc/usage/index.rst b/doc/usage/index.rst index 0309abf2ffd..f75bd082378 100644 --- a/doc/usage/index.rst +++ b/doc/usage/index.rst @@ -17,6 +17,7 @@ Shell commands bootefi bootmenu button + conitrace echo exit false |