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 doc

Browse source
This commit is contained in:
Martin Lund 2022-07-03 13:18:52 +02:00
parent db88a9d664
commit 4ca7375cac
3 changed files with 16 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -40,7 +40,7 @@ when used in combination with [tmux](https://tmux.github.io).
* Log to file * Log to file
* Autogeneration of log filename * Autogeneration of log filename
* Configuration file support * Configuration file support
* Select subconfigurations by name or pattern * Select sub-configurations by name or pattern
* Redirect I/O to socket for scripting or TTY sharing * Redirect I/O to socket for scripting or TTY sharing
* Pipe input and/or output * Pipe input and/or output
* Bash completion * Bash completion
@ -54,7 +54,7 @@ when used in combination with [tmux](https://tmux.github.io).
The command-line interface is straightforward as reflected in the output from The command-line interface is straightforward as reflected in the output from
'tio --help': 'tio --help':
``` ```
Usage: tio [<options>] <tty-device|config> Usage: tio [<options>] <tty-device|sub-config>
Options: Options:
-b, --baudrate <bps> Baud rate (default: 115200) -b, --baudrate <bps> Baud rate (default: 115200)

16
man/tio.1.in
View file

@ -207,10 +207,16 @@ In hexadecimal mode each incoming byte is printed out as a hexadecimal value.
.TP .TP
Bytes can be sent in this mode by typing the \fBtwo-character hexadecimal\fR representation of the value, e.g.: to send \fI0xA\fR you must type \fI0a\fR or \fI0A\fR. Bytes can be sent in this mode by typing the \fBtwo-character hexadecimal\fR representation of the value, e.g.: to send \fI0xA\fR you must type \fI0a\fR or \fI0A\fR.
.SH "CONFIGURATION" .SH "CONFIGURATION FILE"
.PP .PP
.TP 16n .TP 16n
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, $HOME/.config/tio/tiorc, $HOME/.tiorc 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:
.PP
.I $XDG_CONFIG_HOME/tio/tiorc
.PP
.I $HOME/.config/tio/tiorc
.PP
.I $HOME/.tiorc
.TP .TP
Labels can be used to group settings into named sub-configurations which can be activated from the command-line when starting tio. Labels can be used to group settings into named sub-configurations which can be activated from the command-line when starting tio.
@ -220,7 +226,7 @@ Labels can be used to group settings into named sub-configurations which can be
tio will try to match the user input to a sub-configuration by name or by pattern to get the tty and other options. tio will try to match the user input to a sub-configuration by name or by pattern to get the tty and other options.
.TP .TP
Options without any label changes the default options. Options without any label change the default options.
.TP .TP
The following configuration file options are available: The following configuration file options are available:
@ -265,7 +271,7 @@ Enable hexadecimal mode
.IP "\fBsocket" .IP "\fBsocket"
Set socket to redirect I/O to Set socket to redirect I/O to
.SH "CONFIGURATION EXAMPLES" .SH "CONFIGURATION FILE EXAMPLES"
.TP .TP
To change the default configuration simply set options like so: To change the default configuration simply set options like so:
@ -308,7 +314,7 @@ Which is equivalent to:
$ tio -b 115200 -c 11 /dev/serial/by-id/usb-FTDI_TTL232R-3V3_FTGQVXBL-if00-port0 $ tio -b 115200 -c 11 /dev/serial/by-id/usb-FTDI_TTL232R-3V3_FTGQVXBL-if00-port0
.TP .TP
A sub-configuration can also be matched by its pattern which supports regular expressions: A sub-configuration can also be activated by its pattern which supports regular expressions:
.RS .RS
.nf .nf

4
src/options.c
View file

@ -68,7 +68,9 @@ struct option_t option =
void print_help(char *argv[]) void print_help(char *argv[])
{ {
printf("Usage: %s [<options>] <tty-device|config>\n", argv[0]); printf("Usage: %s [<options>] <tty-device|sub-config>\n", argv[0]);
printf("\n");
printf("Connect to tty-device or activate sub-configuration.\n");
printf("\n"); printf("\n");
printf("Options:\n"); printf("Options:\n");
printf(" -b, --baudrate <bps> Baud rate (default: 115200)\n"); printf(" -b, --baudrate <bps> Baud rate (default: 115200)\n");