#11 Update help/readme with inter command timeout

This commit is contained in:
Aaron Cook 2023-05-13 14:16:57 -05:00
commit 6c5e576729
2 changed files with 7 additions and 1 deletions

View file

@ -64,6 +64,9 @@ Configs get loaded from ${HOME}/.bytenuts/config (if file exists)
--escape=<char> --escape=<char>
Change the default ctrl+b escape character. Change the default ctrl+b escape character.
--inter_cmd_to=<ms>
Set the intercommand timeout in milliseconds (default is 10ms).
``` ```
## Navigation ## Navigation
@ -85,12 +88,14 @@ colors=1
echo=0 echo=0
no_crlf=0 no_crlf=0
escape=a escape=a
inter_cmd_to=100
``` ```
- `colors` - enable parsing of 8-bit ANSI color codes - `colors` - enable parsing of 8-bit ANSI color codes
- `echo` - echo input to the terminal in app - `echo` - echo input to the terminal in app
- `no_crlf` - just send a line feed (`\n`) for user input rather than carriage return + line feed (`\r\n`) - `no_crlf` - just send a line feed (`\n`) for user input rather than carriage return + line feed (`\r\n`)
- `escape` - change what character is used as an escape sequence for commands (e.g. if set to `escape=a`, Bytenuts can be exited with `ctrl+a, q`) - `escape` - change what character is used as an escape sequence for commands (e.g. if set to `escape=a`, Bytenuts can be exited with `ctrl+a, q`)
- `inter_cmd_to` - Set a timeout in milliseconds that must be met. Useful for pasting in multiple lines and ensuring a short delay in between the commands.
Bytenuts looks for the configs at `~/.config/bytenuts/config`. Bytenuts looks for the configs at `~/.config/bytenuts/config`.

View file

@ -25,7 +25,8 @@
"--colors=<0|1>\n Turn 8-bit ANSI colors off/on.\n\n" \ "--colors=<0|1>\n Turn 8-bit ANSI colors off/on.\n\n" \
"--echo=<0|1>\n Turn input echoing off/on.\n\n" \ "--echo=<0|1>\n Turn input echoing off/on.\n\n" \
"--no_crlf=<0|1>\n Choose to send LF and not CRLF on input.\n\n" \ "--no_crlf=<0|1>\n Choose to send LF and not CRLF on input.\n\n" \
"--escape=<char>\n Change the default ctrl+b escape character.\n" \ "--escape=<char>\n Change the default ctrl+b escape character.\n\n" \
"--inter_cmd_to=<ms>\n Set the intercommand timeout in milliseconds (default is 10ms).\n" \
) )
static int parse_args(int argc, char **argv); static int parse_args(int argc, char **argv);