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 2023-04-27 10:13:57 +02:00
parent ab905d8e0c
commit 3bedd85e7c
2 changed files with 13 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

5
man/tio.1.in
View file

@ -131,7 +131,10 @@ List available serial devices by ID.
Enable log to file. Enable log to file.
If no filename is provided the filename will be automatically generated. The filename will be automatically generated using the following format
tio_DEVICE_YYYY-MM-DDTHH:MM:SS.log.
The filename can be manually set using the \-\-log-file option.
.TP .TP
.BR " \-\-log-file \fI<filename> .BR " \-\-log-file \fI<filename>

18
man/tio.1.txt
View file

@ -1,4 +1,4 @@
tio(1) User Commands tio(1) tio(1) User Commands tio(1)
NAME NAME
tio - a simple serial device I/O tool tio - a simple serial device I/O tool
@ -66,8 +66,7 @@ OPTIONS
Disable automatic connect. Disable automatic connect.
By default tio automatically connects to the provided device if present. If the device is not present, it will wait for it to appear and then connect. If the connection is lost (eg. device disconnects), it will wait for the device to By default tio automatically connects to the provided device if present. If the device is not present, it will wait for it to appear and then connect. If the connection is lost (eg. device disconnects), it will wait for the device to reappear and then reconnect.
reappear and then reconnect.
However, if the --no-autoconnect option is provided, tio will exit if the device is not present or an established connection is lost. However, if the --no-autoconnect option is provided, tio will exit if the device is not present or an established connection is lost.
@ -101,7 +100,9 @@ OPTIONS
Enable log to file. Enable log to file.
If no filename is provided the filename will be automatically generated. The filename will be automatically generated using the following format tio_DEVICE_YYYY-MM-DDTHH:MM:SS.log.
The filename can be manually set using the --log-file option.
--log-file <filename> --log-file <filename>
@ -151,8 +152,7 @@ OPTIONS
Redirect I/O to socket. Redirect I/O to socket.
Any input from clients connected to the socket is sent on the serial port as if entered at the terminal where tio is running (except that ctrl-t sequences are not recognized), and any input from the serial port is multiplexed to the Any input from clients connected to the socket is sent on the serial port as if entered at the terminal where tio is running (except that ctrl-t sequences are not recognized), and any input from the serial port is multiplexed to the terminal and all connected clients.
terminal and all connected clients.
Sockets remain open while the serial port is disconnected, and writes will block. Sockets remain open while the serial port is disconnected, and writes will block.
@ -170,7 +170,7 @@ OPTIONS
-r, --response-wait -r, --response-wait
Wait for line response then quit. A line is considered any string ending with either CR or NL character. If no line is received tio will quit after response timeout. Wait for line response then quit. A line is considered any string terminated with a NL character. If no line is received tio will quit after response timeout.
Any tio text is automatically muted when piping a string to tio while in response mode to make it easy to parse the response. Any tio text is automatically muted when piping a string to tio while in response mode to make it easy to parse the response.
@ -215,7 +215,7 @@ 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, all key strokes are forwarded to the serial device except the following key sequence: a prefix key (default: ctrl-t) followed by a command key. These sequences are intercepted as tio commands:
ctrl-t ? List available key commands ctrl-t ? List available key commands
@ -444,4 +444,4 @@ WEBSITE
AUTHOR AUTHOR
Created by Martin Lund <martin.lund@keep-it-simple.com>. Created by Martin Lund <martin.lund@keep-it-simple.com>.
tio 2.6 2022-12-17 tio(1) tio 2.6 2022-12-17 tio(1)