From 745244df06b6a987c5a0651053fe49d8f46732b2 Mon Sep 17 00:00:00 2001 From: Martin Lund Date: Fri, 11 Mar 2022 14:34:33 +0100 Subject: [PATCH] Update man page --- man/tio.1.in | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/man/tio.1.in b/man/tio.1.in index f97855d..b061750 100644 --- a/man/tio.1.in +++ b/man/tio.1.in @@ -1,7 +1,7 @@ .TH "tio" "1" "@version_date@" "tio @version@" "User Commands" .SH "NAME" -tio \- a simple TTY terminal I/O tool +tio \- a simple serial terminal I/O tool .SH "SYNOPSIS" .PP @@ -11,8 +11,8 @@ tio \- a simple TTY terminal I/O tool .SH "DESCRIPTION" .PP .B tio -is a simple TTY terminal tool which features a straightforward command-line -interface to easily connect to TTY devices for basic I/O operations. +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" @@ -157,18 +157,20 @@ Show version .SH "CONFIGURATION" .PP .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 -tio will try to match the user input to a section pattern to get the tty and -other options. +tio will try to match the user input to a section pattern to get the tty and other options. .TP The following options are available: .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" tty device to open. If tty contains a "%s" it will be substituted with the first group match. .IP "\fBbaudrate" @@ -199,7 +201,7 @@ Map special characters on input or output .SH "CONFIGURATION EXAMPLES" .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 .nf @@ -213,19 +215,19 @@ tty=/dev/serial/by-id/usb-FTDI_TTL232R-3V3_FTGQVXBL-if00-port0 .RE .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 -b 115200 /dev/serial/by-id/usb-FTDI_TTL232R-3V3_FTGQVXBL-if00-port0 .TP -a pattern ca also be a regular expression. +A pattern can also be a regular expression: .RS .nf .eo -[ftdi match] +[usb device] pattern=usb([0-9]*) baudrate=115200 tty=/dev/ttyUSB%s @@ -234,7 +236,7 @@ tty=/dev/ttyUSB%s .RE .TP -Making the following commands equivalent +Making the following commands equivalent: tio usb12