From 88588100e4964650f599339029151c5af048c7cb Mon Sep 17 00:00:00 2001 From: Martin Lund Date: Sat, 10 Sep 2022 22:46:58 +0200 Subject: [PATCH] Update plain text man page --- man/tio.1.txt | 157 ++++++++++++++++++++++++++++++++------------------ 1 file changed, 102 insertions(+), 55 deletions(-) diff --git a/man/tio.1.txt b/man/tio.1.txt index dc1072a..35a30b4 100644 --- a/man/tio.1.txt +++ b/man/tio.1.txt @@ -1,4 +1,4 @@ -tio(1) User Commands tio(1) +tio(1) User Commands tio(1) NAME tio - a simple serial device I/O tool @@ -7,8 +7,7 @@ SYNOPSIS tio [] DESCRIPTION - tio is a simple serial device tool which features a straightforward command-line and configuration file interface to easily con‐ - nect to serial TTY devices for basic I/O operations. + 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. OPTIONS -b, --baudrate @@ -31,8 +30,7 @@ OPTIONS 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 - mark and space parity. + 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. -o, --output-delay @@ -44,22 +42,21 @@ OPTIONS --line-pulse-duration - Set the pulse duration [ms] of each serial port line using the following key valur pair format in the duration field: - = + Set the pulse duration [ms] of each serial port line using the following key value pair format in the duration field: = Each key represents a serial line. The following keys are available: - DTR - Data Terminal Ready + DTR Data Terminal Ready - RTS - Request To Send + RTS Request To Send - CTS - Clear To Send + CTS Clear To Send - DSR - Data Set Ready + DSR Data Set Ready - DCD - Data Carrier Detect + DCD Data Carrier Detect - RI - Ring Indicator + RI Ring Indicator If defining more than one key value pair, the pairs must be comma separated. @@ -69,12 +66,10 @@ OPTIONS 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 - to appear and then connect. If the connection is lost (eg. device disconnects), it will wait for the device to reappear and - then reconnect. + 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. - However, if the --no-autoconnect option is provided, tio will exit if the device is not present or an established connec‐ - tion is lost. + However, if the --no-autoconnect option is provided, tio will exit if the device is not present or an established connection is lost. -e, --local-echo @@ -100,7 +95,7 @@ OPTIONS -L, --list-devices - List available serial devices. + List available serial devices by ID. -l, --log @@ -144,8 +139,7 @@ OPTIONS -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 or use "bold" to apply bold - formatting to existing system 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. @@ -153,9 +147,8 @@ OPTIONS -S, --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‐ - minal where tio is running (except that ctrl-t sequences are not recognized), and any input from the serial port is multi‐ - plexed to the terminal and all connected clients. + 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 terminal and all connected clients. Sockets remain open while the serial port is disconnected, and writes will block. @@ -171,6 +164,44 @@ OPTIONS At present there is a hardcoded limit of 16 clients connected at one time. + -r, --response-wait + + Wait for line response then quit. A line is considered any string ending with either CR or NL character. If no line is received tio will quit after response timeout. + + Any tio text is automatically muted when piping a string to tio while in response mode to make it easy to parse the response. + + --response-timeout + + Set timeout [ms] of line response (default: 100). + + --rs-485 + + Enable RS-485 mode. + + --rs-485-config + + Set the RS-485 configuration using the following key or key value pair format in the configuration field: + + RTS_ON_SEND=value Set logical level (0 or 1) for RTS pin when sending + + RTS_AFTER_SEND=value Set logical level (0 or 1) for RTS pin after sending + + RTS_DELAY_BEFORE_SEND=value Set RTS delay (ms) before sending + + RTS_DELAY_AFTER_SEND=value Set RTS delay (ms) after sending + + RX_DURING_TX Receive data even while sending data + + If defining more than one key or key value pair, they must be comma separated. + + --alert none|bell|blink + + Set alert action on connect/disconnect. + + It will sound the bell once or blink once on successful connect. Likewise it will sound the bell twice or blink twice on disconnect. + + Default value is "none". + -v, --version Display program version. @@ -180,8 +211,7 @@ OPTIONS Display help. KEYS - In session, the following key sequences, a prefix key (default: ctrl-t) followed by a command key, are intercepted as tio com‐ - mands: + In session, the following key sequences, a prefix key (default: ctrl-t) followed by a command key, are intercepted as tio commands: ctrl-t ? List available key commands @@ -214,12 +244,10 @@ KEYS HEXADECIMAL MODE 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 - type 0a or 0A. + 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. CONFIGURATION FILE - Options can be set via configuration file using the INI format. tio uses the configuration file first found in the following loca‐ - tions in the order listed: + 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: $XDG_CONFIG_HOME/tio/tiorc @@ -237,49 +265,59 @@ CONFIGURATION FILE The following configuration file options are available: - pattern Pattern matching user input. This pattern can be an extended regular expression with a single group. + pattern Pattern matching user input. This pattern can be an extended regular expression with a single group. - tty tty device to open. If it contains a "%s" it is substituted with the first group match. + tty tty device to open. If it contains a "%s" it is substituted with the first group match. - baudrate Set baud rate + baudrate Set baud rate - databits Set data bits + databits Set data bits - flow Set flow control + flow Set flow control - stopbits Set stop bits + stopbits Set stop bits - parity Set parity + parity Set parity - output-delay Set output character delay + output-delay Set output character delay - output-line-delay Set output line delay + output-line-delay Set output line delay - line-pulse-duration Set line pulse duration + line-pulse-duration Set line pulse duration - no-autoconnect Disable automatic connect + no-autoconnect Disable automatic connect - log Enable log to file + log Enable log to file - log-file Set log filename + log-file Set log filename - log-strip Enable strip of control and escape sequences from log + log-strip Enable strip of control and escape sequences from log - local-echo Enable local echo + local-echo Enable local echo - timestamp Enable line timestamp + timestamp Enable line timestamp - timestamp-format Set timestamp format + timestamp-format Set timestamp format - map Map characters on input or output + map Map characters on input or output - color Colorize tio text using ANSI color code ranging from 0 to 255 + color Colorize tio text using ANSI color code ranging from 0 to 255 - hexadecimal Enable hexadecimal mode + hexadecimal Enable hexadecimal mode - socket Set socket to redirect I/O to + socket Set socket to redirect I/O to - prefix-ctrl-key Set prefix ctrl key (a..z, default: t) + prefix-ctrl-key Set prefix ctrl key (a..z, default: t) + + response-wait Enable wait for line response + + response-timeout Set line response timeout + + rs-485 Enable RS-485 mode + + rs-485-config Set RS-485 configuration + + alert Set alert action on connect/disconnect CONFIGURATION FILE EXAMPLES To change the default configuration simply set options like so: @@ -339,8 +377,7 @@ EXAMPLES $ 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 - reconnected. + Using serial devices by ID ensures that tio automatically reconnects to the correct serial device if it is disconnected and then reconnected. Redirect serial device I/O to Unix file socket for scripting: @@ -377,14 +414,24 @@ EXAMPLES $ echo "ls -la" | tio /dev/serial/by-id/usb-FTDI_TTL232R-3V3_FTGQVXBL-if00-port0 + Pipe command to the serial device and wait for line response (string ending with CR or NL): + + $ echo "*IDN?" | tio /dev/ttyACM0 --response-wait + + In this mode, only the response will be printed. + Likewise, to pipe data from file to the serial device: $ cat data.bin | tio /dev/serial/by-id/usb-FTDI_TTL232R-3V3_FTGQVXBL-if00-port0 + Enable RS-485 mode: + + $ tio --rs-485 --rs-485-config=RTS_ON_SEND=1,RX_DURING_TX /dev/ttyUSB0 + WEBSITE Visit https://tio.github.io AUTHOR Created by Martin Lund . -tio 1.46 2022-07-15 tio(1) +tio 2.0 2022-07-23 tio(1)