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

Update man page

Browse source
This commit is contained in:
Martin Lund 2022-04-21 02:28:53 +02:00
parent 2e0b0386dc
commit fa91a3fcc4
1 changed files with 6 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

16
man/tio.1.in
View file

@ -176,14 +176,11 @@ Show version
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 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 .TP
Sections can be used to group settings and their names are only used for readability. Sections can be used to group settings.
.TP .TP
.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 by name or by 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 .TP
Options without any section name sets the default options. Options without any section name sets the default options.
@ -228,13 +225,12 @@ Set socket path (must include
.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
.eo .eo
[ftdi device] [ftdi]
pattern=ftdi
baudrate=115200 baudrate=115200
tty=/dev/serial/by-id/usb-FTDI_TTL232R-3V3_FTGQVXBL-if00-port0 tty=/dev/serial/by-id/usb-FTDI_TTL232R-3V3_FTGQVXBL-if00-port0
color=11 color=11
@ -250,7 +246,7 @@ 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 can also be a regular expression: A section can also be matched by its pattern which supports regular expressions:
.RS .RS
.nf .nf
@ -293,4 +289,4 @@ Visit https://tio.github.io
.SH "AUTHOR" .SH "AUTHOR"
.PP .PP
Written by Martin Lund <martin.lund@keep\-it\-simple.com>. Created by Martin Lund <martin.lund@keep\-it\-simple.com>.