mirror of
https://github.com/tio/tio.git
synced 2026-05-01 14:57:59 +02:00
a81c43a01a
This allows for better config file ergonomics if the user has a diverse set of serial devices as the name does not need to be specified in the config file twice.
296 lines
6.7 KiB
Groff
296 lines
6.7 KiB
Groff
.TH "tio" "1" "@version_date@" "tio @version@" "User Commands"
|
|
|
|
.SH "NAME"
|
|
tio \- a simple serial terminal I/O tool
|
|
|
|
.SH "SYNOPSIS"
|
|
.PP
|
|
.B tio
|
|
.RI "[" <options> "] " "<tty-device>"
|
|
|
|
.SH "DESCRIPTION"
|
|
.PP
|
|
.B tio
|
|
is a simple serial terminal tool which features a straightforward command-line
|
|
interface to easily connect to serial/TTY devices for basic I/O operations.
|
|
|
|
.SH "OPTIONS"
|
|
|
|
.TP
|
|
.BR \-b ", " "\-\-baudrate " \fI<bps>
|
|
|
|
Set baud rate [bps] (default: 115200).
|
|
.TP
|
|
.BR \-d ", " "\-\-databits 5" | 6 | 7 | 8
|
|
|
|
Set data bits (default: 8).
|
|
.TP
|
|
.BR \-f ", " "\-\-flow hard" | soft | none
|
|
|
|
Set flow control (default: none).
|
|
.TP
|
|
.BR \-s ", " "\-\-stopbits 1" | 2
|
|
|
|
Set stop bits (default: 1).
|
|
.TP
|
|
.BR \-p ", " "\-\-parity odd" | even | none
|
|
|
|
Set parity (default: none).
|
|
.TP
|
|
.BR \-o ", " "\-\-output\-delay " \fI<ms>
|
|
|
|
Set output delay [ms] inserted between each sent character (default: 0).
|
|
.TP
|
|
.BR \-n ", " \-\-no\-autoconnect
|
|
|
|
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.
|
|
|
|
However, if the
|
|
.B \-\-no\-autoconnect
|
|
option is provided, tio will exit if the device is not present or an established connection is lost.
|
|
|
|
.TP
|
|
.BR \-e ", " "\-\-local\-echo
|
|
|
|
Enable local echo.
|
|
|
|
.TP
|
|
.BR \-t ", " \-\-timestamp[=\fI<format>\fR\fB]
|
|
|
|
Enable timestamp. Optionally you can specify any of the following timestamp formats:
|
|
.RS
|
|
.TP 16n
|
|
.IP "\fB24hour"
|
|
24-hour format ("hh:mm:ss.sss")
|
|
.IP "\fB24hour-start"
|
|
24-hour format relative to start time
|
|
.IP "\fBiso8601"
|
|
ISO8601 format ("YYYY-MM-DDThh:mm:ss.sss")
|
|
.P
|
|
Default format is
|
|
.B 24hour
|
|
.RE
|
|
|
|
.TP
|
|
.BR \-L ", " \-\-list\-devices
|
|
|
|
List available serial devices.
|
|
|
|
.TP
|
|
.BR \-l ", " \-\-log[=\fI<filename>\fR\fB]
|
|
|
|
Log to file. If no filename is provided the filename will be automatically generated.
|
|
|
|
.TP
|
|
.BR \-m ", " "\-\-map " \fI<flags>
|
|
|
|
Map (replace, translate) special characters on input or output. The following mapping flags are supported:
|
|
.RS
|
|
.TP 12n
|
|
.IP "\fBICRNL"
|
|
Map CR to NL on input (unless IGNCR is set).
|
|
.IP "\fBIGNCR"
|
|
Ignore CR on input.
|
|
.IP "\fBINLCR"
|
|
Map NL to CR on input.
|
|
.IP "\fBINLCRNL"
|
|
Map NL to CR-NL on input.
|
|
.IP "\fBOCRNL"
|
|
Map CR to NL on output.
|
|
.IP "\fBODELBS"
|
|
Map DEL to BS on output.
|
|
.IP "\fBONLCRNL"
|
|
Map NL to CR-NL on output.
|
|
.P
|
|
If defining more than one flag, the flags must be comma separated.
|
|
.RE
|
|
|
|
.TP
|
|
.BR \-c ", " "\-\-color " \fI<code>
|
|
|
|
Colorize tio text using ANSI color code ranging from 0 to 255.
|
|
|
|
If color code is negative a list of available ANSI colors will be printed.
|
|
|
|
.TP
|
|
.BR \-S ", " "\-\-socket \fI<socket>\fR\fB
|
|
|
|
Listen on 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
|
|
.B 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.
|
|
|
|
Two socket types are supported using different prefixes in the socket field:
|
|
|
|
unix:<filename> - Unix Domain Socket (file)
|
|
|
|
inet:<IP>:<port> - Internet Socket (network) (NOT YET SUPPORTED)
|
|
|
|
At present there is a hardcoded limit of 16 clients connected at one time.
|
|
|
|
.TP
|
|
.BR \-v ", " \-\-version
|
|
|
|
Display program version.
|
|
.TP
|
|
.BR \-h ", " \-\-help
|
|
|
|
Display help.
|
|
.SH "KEYS"
|
|
.PP
|
|
.TP 16n
|
|
In session, the following key sequences are intercepted as tio commands:
|
|
.IP "\fBctrl-t ?"
|
|
List available key commands
|
|
.IP "\fBctrl-t b"
|
|
Send serial break (triggers SysRq on Linux, etc.)
|
|
.IP "\fBctrl-t c"
|
|
Show configuration (baudrate, databits, etc.)
|
|
.IP "\fBctrl-t e"
|
|
Toggle local echo mode
|
|
.IP "\fBctrl-t h"
|
|
Toggle hexadecimal mode
|
|
.IP "\fBctrl-t l"
|
|
Clear screen
|
|
.IP "\fBctrl-t q"
|
|
Quit
|
|
.IP "\fBctrl-t s"
|
|
Show TX/RX statistics
|
|
.IP "\fBctrl-t t"
|
|
Send ctrl-t key code
|
|
.IP "\fBctrl-t L"
|
|
Show line states (DTR, RTS, CTS, DSR, DCD, RI)
|
|
.IP "\fBctrl-t d"
|
|
Toggle DTR
|
|
.IP "\fBctrl-t r"
|
|
Toggle RTS
|
|
.IP "\fBctrl-t v"
|
|
Show version
|
|
|
|
.SH "CONFIGURATION"
|
|
.PP
|
|
.TP 16n
|
|
Options can be set via a 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, $HOME/.config/tio/tiorc, $HOME/.tiorc
|
|
|
|
.TP
|
|
Sections can be used to group settings and their names are only used for readability.
|
|
|
|
.TP
|
|
.TP
|
|
tio will try to match the user input to a section pattern to get the tty and other options.
|
|
|
|
.TP
|
|
If pattern matching fails, tio will try to match the user input to a section name.
|
|
|
|
.TP
|
|
Options without any section name sets the default options.
|
|
|
|
.TP
|
|
The following configuration file options are available:
|
|
|
|
.IP "\fBpattern"
|
|
pattern matching user input. This pattern can be an extended regular expression with a single group.
|
|
.IP "\fBtty"
|
|
tty device to open. If tty contains a "%s" it will be substituted with the first group match.
|
|
.IP "\fBbaudrate"
|
|
Set baud rate
|
|
.IP "\fBdatabits"
|
|
Set data bits
|
|
.IP "\fBflow"
|
|
Set flow control
|
|
.IP "\fBstopbits"
|
|
Set stop bits
|
|
.IP "\fBparity"
|
|
Set parity
|
|
.IP "\fBoutput-delay"
|
|
Set output delay
|
|
.IP "\fBno-autoconnect"
|
|
Disable automatic connect
|
|
.IP "\fBlog"
|
|
Log to file
|
|
.IP "\fBlocal-echo"
|
|
Enable local echo
|
|
.IP "\fBtimestamp"
|
|
Prefix each new line with a timestamp
|
|
.IP "\fBlog-filename"
|
|
Set log filename
|
|
.IP "\fBmap"
|
|
Map special characters on input or output
|
|
.IP "\fBcolor"
|
|
Colorize tio text using ANSI color code ranging from 0 to 255.
|
|
.IP "\fBsocket"
|
|
Set socket path (must include
|
|
.BR unix: ).
|
|
|
|
.SH "CONFIGURATION EXAMPLES"
|
|
|
|
.TP
|
|
A Typical section used as a short-hand would be defined as such:
|
|
|
|
.RS
|
|
.nf
|
|
.eo
|
|
[ftdi device]
|
|
pattern=ftdi
|
|
baudrate=115200
|
|
tty=/dev/serial/by-id/usb-FTDI_TTL232R-3V3_FTGQVXBL-if00-port0
|
|
color=11
|
|
.ec
|
|
.fi
|
|
.RE
|
|
|
|
.TP
|
|
With this section defined in the configuration file the following commands would be equivalent:
|
|
|
|
tio ftdi
|
|
|
|
tio -b 115200 /dev/serial/by-id/usb-FTDI_TTL232R-3V3_FTGQVXBL-if00-port0
|
|
|
|
.TP
|
|
A pattern can also be a regular expression:
|
|
|
|
.RS
|
|
.nf
|
|
.eo
|
|
[usb device]
|
|
pattern=usb([0-9]*)
|
|
baudrate=115200
|
|
tty=/dev/ttyUSB%s
|
|
.ec
|
|
.fi
|
|
.RE
|
|
|
|
.TP
|
|
Making the following commands equivalent:
|
|
|
|
tio usb12
|
|
|
|
tio -b 115200 /dev/ttyUSB12
|
|
|
|
.SH "EXAMPLES"
|
|
.TP
|
|
Typical use is without options. For example:
|
|
|
|
tio /dev/ttyUSB0
|
|
.TP
|
|
Which corresponds to the commonly used options:
|
|
|
|
tio \-b 115200 \-d 8 \-f none \-s 1 \-p none /dev/ttyUSB0
|
|
.TP
|
|
It is recommended to connect serial tty devices by ID. For example:
|
|
|
|
tio /dev/serial/by\-id/usb\-FTDI_TTL232R-3V3_FTGQVXBL\-if00\-port0
|
|
.PP
|
|
Using serial devices by ID ensures that tio automatically reconnects to the
|
|
correct serial device if the device is disconnected and then reconnected.
|
|
|
|
.SH "WEBSITE"
|
|
.PP
|
|
Visit https://tio.github.io
|
|
|
|
.SH "AUTHOR"
|
|
.PP
|
|
Written by Martin Lund <martin.lund@keep\-it\-simple.com>.
|