Maarrk/tio
1
0
Fork 0
mirror of https://github.com/tio/tio.git synced 2026-05-01 23:07:58 +02:00
Code Issues Projects Releases 1 Packages Wiki Activity Actions

Update README

Browse source
This commit is contained in:
Martin Lund 2022-07-11 21:16:45 +02:00
parent c009e19d89
commit 73a30a89ef
1 changed files with 33 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

63
README.md
View file

@ -56,45 +56,40 @@ when used in combination with [tmux](https://tmux.github.io).
The command-line interface is straightforward as reflected in the output from The command-line interface is straightforward as reflected in the output from
'tio --help': 'tio --help':
``` ```
Usage: tio [<options>] <tty-device|sub-config> Usage: tio [<options>] <tty-device|sub-config>
Connect to tty device directly or via sub-configuration. Connect to tty device directly or via sub-configuration.
Options: Options:
-b, --baudrate <bps> Baud rate (default: 115200) -b, --baudrate <bps> Baud rate (default: 115200)
-d, --databits 5|6|7|8 Data bits (default: 8) -d, --databits 5|6|7|8 Data bits (default: 8)
-f, --flow hard|soft|none Flow control (default: none) -f, --flow hard|soft|none Flow control (default: none)
-s, --stopbits 1|2 Stop bits (default: 1) -s, --stopbits 1|2 Stop bits (default: 1)
-p, --parity odd|even|none Parity (default: none) -p, --parity odd|even|none|mark|space Parity (default: none)
-o, --output-delay <ms> Output character delay (default: 0) -o, --output-delay <ms> Output character delay (default: 0)
-O, --output-line-delay <ms> Output line delay (default: 0) -O, --output-line-delay <ms> Output line delay (default: 0)
--dtr-pulse-duration <ms> DTR pulse duration (default: 100) --dtr-pulse-duration <ms> DTR pulse duration (default: 100)
-n, --no-autoconnect Disable automatic connect -n, --no-autoconnect Disable automatic connect
-e, --local-echo Enable local echo -e, --local-echo Enable local echo
-t, --timestamp Enable line timestamp -t, --timestamp Enable line timestamp
--timestamp-format <format> Set timestamp format (default: 24hour) --timestamp-format <format> Set timestamp format (default: 24hour)
-L, --list-devices List available serial devices -L, --list-devices List available serial devices
--dtr-pulse-duration <ms> DTR pulse duration (default: 100) -l, --log Enable log to file
-n, --no-autoconnect Disable automatic connect --log-file <filename> Set log filename
-e, --local-echo Enable local echo --log-strip Strip control characters and escape sequences
-t, --timestamp Enable line timestamp -m, --map <flags> Map characters
--timestamp-format <format> Set timestamp format (default: 24hour) -c, --color 0..255|none|list Colorize tio text (default: 15)
-L, --list-devices List available serial devices -S, --socket <socket> Redirect I/O to file or network socket
-l, --log Enable log to file -x, --hexadecimal Enable hexadecimal mode
--log-file <filename> Set log filename -v, --version Display version
--log-strip Strip control characters and escape sequences -h, --help Display help
-m, --map <flags> Map characters
-c, --color 0..255|none|list Colorize tio text (default: 15)
-S, --socket <socket> Redirect I/O to file or network socket
-x, --hexadecimal Enable hexadecimal mode
-v, --version Display version
-h, --help Display help
Options and sub-configurations may be set via configuration file. Options and sub-configurations may be set via configuration file.
In session, press ctrl-t q to quit. In session, press ctrl-t q to quit.
See the man page for more details.
See the man page for more details.
``` ```
By default tio automatically connects to the provided TTY device if present. By default tio automatically connects to the provided TTY device if present.