mirror of
https://github.com/tio/tio.git
synced 2026-05-01 14:57:59 +02:00
Update plain text man page
This commit is contained in:
parent
62c00ce05e
commit
a01d8b38b1
1 changed files with 68 additions and 50 deletions
|
|
@ -7,8 +7,8 @@ SYNOPSIS
|
||||||
tio [<options>] <tty-device|sub-config>
|
tio [<options>] <tty-device|sub-config>
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
tio is a simple serial device tool which features a straightforward command-line and configuration file interface to easily connect
|
tio is a simple serial device tool which features a straightforward command-line and configuration file interface to easily con‐
|
||||||
to serial TTY devices for basic I/O operations.
|
nect to serial TTY devices for basic I/O operations.
|
||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
-b, --baudrate <bps>
|
-b, --baudrate <bps>
|
||||||
|
|
@ -42,9 +42,28 @@ OPTIONS
|
||||||
|
|
||||||
Set output delay [ms] inserted between each sent line (default: 0).
|
Set output delay [ms] inserted between each sent line (default: 0).
|
||||||
|
|
||||||
--dtr-pulse-duration <ms>
|
--line-pulse-duration <duration>
|
||||||
|
|
||||||
Set the duration [ms] of the DTR pulse (default: 100).
|
Set the pulse duration [ms] of each serial port line using the following key valur pair format in the duration field:
|
||||||
|
<key>=<value>
|
||||||
|
|
||||||
|
Each key represents a serial line. The following keys are available:
|
||||||
|
|
||||||
|
DTR - Data Terminal Ready
|
||||||
|
|
||||||
|
RTS - Request To Send
|
||||||
|
|
||||||
|
CTS - Clear To Send
|
||||||
|
|
||||||
|
DSR - Data Set Ready
|
||||||
|
|
||||||
|
DCD - Data Carrier Detect
|
||||||
|
|
||||||
|
RI - Ring Indicator
|
||||||
|
|
||||||
|
If defining more than one key value pair, the pairs must be comma separated.
|
||||||
|
|
||||||
|
The default pulse duration for each line is 100 ms.
|
||||||
|
|
||||||
-n, --no-autoconnect
|
-n, --no-autoconnect
|
||||||
|
|
||||||
|
|
@ -54,8 +73,8 @@ OPTIONS
|
||||||
to appear and then connect. If the connection is lost (eg. device disconnects), it will wait for the device to reappear and
|
to appear and then connect. If the connection is lost (eg. device disconnects), it will wait for the device to reappear and
|
||||||
then reconnect.
|
then reconnect.
|
||||||
|
|
||||||
However, if the --no-autoconnect option is provided, tio will exit if the device is not present or an established connection
|
However, if the --no-autoconnect option is provided, tio will exit if the device is not present or an established connec‐
|
||||||
is lost.
|
tion is lost.
|
||||||
|
|
||||||
-e, --local-echo
|
-e, --local-echo
|
||||||
|
|
||||||
|
|
@ -161,7 +180,8 @@ OPTIONS
|
||||||
Display help.
|
Display help.
|
||||||
|
|
||||||
KEYS
|
KEYS
|
||||||
In session, the following key sequences, a prefix key (default: ctrl-t) followed by a command key, are intercepted as tio commands:
|
In session, the following key sequences, a prefix key (default: ctrl-t) followed by a command key, are intercepted as tio com‐
|
||||||
|
mands:
|
||||||
|
|
||||||
ctrl-t ? List available key commands
|
ctrl-t ? List available key commands
|
||||||
|
|
||||||
|
|
@ -171,22 +191,20 @@ KEYS
|
||||||
|
|
||||||
ctrl-t e Toggle local echo mode
|
ctrl-t e Toggle local echo mode
|
||||||
|
|
||||||
|
ctrl-t g Toggle serial port line
|
||||||
|
|
||||||
ctrl-t h Toggle hexadecimal mode
|
ctrl-t h Toggle hexadecimal mode
|
||||||
|
|
||||||
ctrl-t l Clear screen
|
ctrl-t l Clear screen
|
||||||
|
|
||||||
|
ctrl-t L Show line states (DTR, RTS, CTS, DSR, DCD, RI)
|
||||||
|
|
||||||
|
ctrl-t p Pulse serial port line
|
||||||
|
|
||||||
ctrl-t q Quit
|
ctrl-t q Quit
|
||||||
|
|
||||||
ctrl-t s Show TX/RX statistics
|
ctrl-t s Show TX/RX statistics
|
||||||
|
|
||||||
ctrl-t L Show line states (DTR, RTS, CTS, DSR, DCD, RI)
|
|
||||||
|
|
||||||
ctrl-t d Toggle DTR
|
|
||||||
|
|
||||||
ctrl-t D Pulse DTR
|
|
||||||
|
|
||||||
ctrl-t r Toggle RTS
|
|
||||||
|
|
||||||
ctrl-t t Toggle line timestamp mode
|
ctrl-t t Toggle line timestamp mode
|
||||||
|
|
||||||
ctrl-t U Toggle conversion to uppercase on output
|
ctrl-t U Toggle conversion to uppercase on output
|
||||||
|
|
@ -196,8 +214,8 @@ KEYS
|
||||||
HEXADECIMAL MODE
|
HEXADECIMAL MODE
|
||||||
In hexadecimal mode each incoming byte is printed out as a hexadecimal value.
|
In hexadecimal mode each incoming byte is printed out as a hexadecimal value.
|
||||||
|
|
||||||
Bytes can be sent in this mode by typing the two-character hexadecimal representation of the value, e.g.: to send 0xA you must type
|
Bytes can be sent in this mode by typing the two-character hexadecimal representation of the value, e.g.: to send 0xA you must
|
||||||
0a or 0A.
|
type 0a or 0A.
|
||||||
|
|
||||||
CONFIGURATION FILE
|
CONFIGURATION FILE
|
||||||
Options can be set via configuration file using the INI format. tio uses the configuration file first found in the following loca‐
|
Options can be set via configuration file using the INI format. tio uses the configuration file first found in the following loca‐
|
||||||
|
|
@ -237,7 +255,7 @@ CONFIGURATION FILE
|
||||||
|
|
||||||
output-line-delay Set output line delay
|
output-line-delay Set output line delay
|
||||||
|
|
||||||
dtr-pulse-duration Set DTR pulse duration
|
line-pulse-duration Set line pulse duration
|
||||||
|
|
||||||
no-autoconnect Disable automatic connect
|
no-autoconnect Disable automatic connect
|
||||||
|
|
||||||
|
|
@ -272,7 +290,7 @@ CONFIGURATION FILE EXAMPLES
|
||||||
parity = none
|
parity = none
|
||||||
stopbits = 1
|
stopbits = 1
|
||||||
color = 10
|
color = 10
|
||||||
dtr-pulse-duration = 50
|
line-pulse-duration = DTR=200,RTS=400
|
||||||
|
|
||||||
Named sub-configurations can be added via labels:
|
Named sub-configurations can be added via labels:
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue