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 man page

Browse source
This commit is contained in:
Martin Lund 2022-03-11 14:34:33 +01:00
parent e9d5a23129
commit 745244df06
1 changed files with 14 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

26
man/tio.1.in
View file

@ -1,7 +1,7 @@
.TH "tio" "1" "@version_date@" "tio @version@" "User Commands" .TH "tio" "1" "@version_date@" "tio @version@" "User Commands"
.SH "NAME" .SH "NAME"
tio \- a simple TTY terminal I/O tool tio \- a simple serial terminal I/O tool
.SH "SYNOPSIS" .SH "SYNOPSIS"
.PP .PP
@ -11,8 +11,8 @@ tio \- a simple TTY terminal I/O tool
.SH "DESCRIPTION" .SH "DESCRIPTION"
.PP .PP
.B tio .B tio
is a simple TTY terminal tool which features a straightforward command-line is a simple serial terminal tool which features a straightforward command-line
interface to easily connect to TTY devices for basic I/O operations. interface to easily connect to serial/TTY devices for basic I/O operations.
.SH "OPTIONS" .SH "OPTIONS"
@ -157,18 +157,20 @@ Show version
.SH "CONFIGURATION" .SH "CONFIGURATION"
.PP .PP
.TP 16n .TP 16n
Default tty options can be set in ~/.tiorc using the INI format. Section are used to group settings and their names are only used for readability. 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, ~/.config/tio/tiorc, ~/.tiorc
.TP
Sections can be used to group settings and their names are only used for readability.
.TP .TP
.TP .TP
tio will try to match the user input to a section pattern to get the tty and tio will try to match the user input to a section pattern to get the tty and other options.
other options.
.TP .TP
The following options are available: The following options are available:
.IP "\fBpattern" .IP "\fBpattern"
pattern matching user input. This pattern ca be an extended regular expression with a single group. pattern matching user input. This pattern can be an extended regular expression with a single group.
.IP "\fBtty" .IP "\fBtty"
tty device to open. If tty contains a "%s" it will be substituted with the first group match. tty device to open. If tty contains a "%s" it will be substituted with the first group match.
.IP "\fBbaudrate" .IP "\fBbaudrate"
@ -199,7 +201,7 @@ Map special characters on input or output
.SH "CONFIGURATION EXAMPLES" .SH "CONFIGURATION EXAMPLES"
.TP .TP
A Typical section used as a short-hand would be defined as such A Typical section used as a short-hand would be defined as such:
.RS .RS
.nf .nf
@ -213,19 +215,19 @@ tty=/dev/serial/by-id/usb-FTDI_TTL232R-3V3_FTGQVXBL-if00-port0
.RE .RE
.TP .TP
With this section defined in the configuration file the following commands would be equivalent With this section defined in the configuration file the following commands would be equivalent:
tio ftdi tio ftdi
tio -b 115200 /dev/serial/by-id/usb-FTDI_TTL232R-3V3_FTGQVXBL-if00-port0 tio -b 115200 /dev/serial/by-id/usb-FTDI_TTL232R-3V3_FTGQVXBL-if00-port0
.TP .TP
a pattern ca also be a regular expression. A pattern can also be a regular expression:
.RS .RS
.nf .nf
.eo .eo
[ftdi match] [usb device]
pattern=usb([0-9]*) pattern=usb([0-9]*)
baudrate=115200 baudrate=115200
tty=/dev/ttyUSB%s tty=/dev/ttyUSB%s
@ -234,7 +236,7 @@ tty=/dev/ttyUSB%s
.RE .RE
.TP .TP
Making the following commands equivalent Making the following commands equivalent:
tio usb12 tio usb12