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

Update plain text man page

Browse source
This commit is contained in:
Martin Lund 2022-07-15 19:55:52 +02:00
parent 862a3ecadd
commit c931d7690d
1 changed files with 15 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

40
man/tio.1.txt
View file

@ -1,4 +1,4 @@
tio(1) User Commands tio(1) tio(1) User Commands tio(1)
NAME NAME
tio - a simple serial device I/O tool tio - a simple serial device I/O tool
@ -7,8 +7,7 @@ SYNOPSIS
tio [<options>] <tty-device|sub-config> tio [<options>] <tty-device|sub-config>
DESCRIPTION DESCRIPTION
tio is a simple serial device tool which features a straightforward command-line and configuration file interface to easily con‐ tio is a simple serial device tool which features a straightforward command-line and configuration file interface to easily connect to serial TTY devices for basic I/O operations.
nect to serial TTY devices for basic I/O operations.
OPTIONS OPTIONS
-b, --baudrate <bps> -b, --baudrate <bps>
@ -31,8 +30,7 @@ OPTIONS
Set parity (default: none). Set parity (default: none).
Note: With mark parity the parity bit is always 0. With space parity the parity bit is always 1. Not all platforms support Note: With mark parity the parity bit is always 0. With space parity the parity bit is always 1. Not all platforms support mark and space parity.
mark and space parity.
-o, --output-delay <ms> -o, --output-delay <ms>
@ -50,12 +48,9 @@ OPTIONS
Disable automatic connect. Disable automatic connect.
By default tio automatically connects to the provided device if present. If the device is not present, it will wait for it By default tio automatically connects to the provided device if present. If the device is not present, it will wait for it to appear and then connect. If the connection is lost (eg. device disconnects), it will wait for the device to reappear and then reconnect.
to appear and then connect. If the connection is lost (eg. device disconnects), it will wait for the device to reappear and
then reconnect.
However, if the --no-autoconnect option is provided, tio will exit if the device is not present or an established connec‐ However, if the --no-autoconnect option is provided, tio will exit if the device is not present or an established connection is lost.
tion is lost.
-e, --local-echo -e, --local-echo
@ -123,19 +118,18 @@ OPTIONS
Enable hexadecimal mode. Enable hexadecimal mode.
-c, --color 0..255|none|list -c, --color 0..255|bold|none|list
Colorize tio text using ANSI color code value ranging from 0 to 255 or use "none" for no color. Colorize tio text using ANSI color code value ranging from 0 to 255 or use "none" for no color or use "bold" to apply bold formatting to existing system color.
Use "list" to print a list of available ANSI color codes. Use "list" to print a list of available ANSI color codes.
Default value is 15. Default value is "bold".
-S, --socket <socket> -S, --socket <socket>
Redirect I/O to socket. Any input from clients connected to the socket is sent on the serial port as if entered at the ter‐ Redirect I/O to socket. Any input from clients connected to the socket is sent on the serial port as if entered at the terminal where tio is running (except that ctrl-t sequences are not recognized), and any input from the serial port is multiplexed to the ter‐
minal where tio is running (except that ctrl-t sequences are not recognized), and any input from the serial port is multi‐ minal and all connected clients.
plexed to the terminal and all connected clients.
Sockets remain open while the serial port is disconnected, and writes will block. Sockets remain open while the serial port is disconnected, and writes will block.
@ -160,8 +154,7 @@ OPTIONS
Display help. Display help.
KEYS KEYS
In session, the following key sequences, a prefix key (default: ctrl-t) followed by a command key, are intercepted as tio com‐ In session, the following key sequences, a prefix key (default: ctrl-t) followed by a command key, are intercepted as tio commands:
mands:
ctrl-t ? List available key commands ctrl-t ? List available key commands
@ -196,12 +189,10 @@ KEYS
HEXADECIMAL MODE HEXADECIMAL MODE
In hexadecimal mode each incoming byte is printed out as a hexadecimal value. In hexadecimal mode each incoming byte is printed out as a hexadecimal value.
Bytes can be sent in this mode by typing the two-character hexadecimal representation of the value, e.g.: to send 0xA you must Bytes can be sent in this mode by typing the two-character hexadecimal representation of the value, e.g.: to send 0xA you must type 0a or 0A.
type 0a or 0A.
CONFIGURATION FILE CONFIGURATION FILE
Options can be set via configuration file using the INI format. tio uses the configuration file first found in the following loca‐ Options can be set via configuration file using the INI format. tio uses the configuration file first found in the following locations in the order listed:
tions in the order listed:
$XDG_CONFIG_HOME/tio/tiorc $XDG_CONFIG_HOME/tio/tiorc
@ -321,8 +312,7 @@ EXAMPLES
$ tio /dev/serial/by-id/usb-FTDI_TTL232R-3V3_FTGQVXBL-if00-port0 $ tio /dev/serial/by-id/usb-FTDI_TTL232R-3V3_FTGQVXBL-if00-port0
Using serial devices by ID ensures that tio automatically reconnects to the correct serial device if it is disconnected and then Using serial devices by ID ensures that tio automatically reconnects to the correct serial device if it is disconnected and then reconnected.
reconnected.
Redirect serial device I/O to Unix file socket for scripting: Redirect serial device I/O to Unix file socket for scripting:
@ -365,4 +355,4 @@ WEBSITE
AUTHOR AUTHOR
Created by Martin Lund <martin.lund@keep-it-simple.com>. Created by Martin Lund <martin.lund@keep-it-simple.com>.
tio 1.45 2022-07-13 tio(1) tio 1.45 2022-07-15 tio(1)