]> git.sur5r.net Git - tio/blobdiff - man/tio.1.in
Update upstream source from tag 'upstream/2.0'
[tio] / man / tio.1.in
index 48623b23264dbee49b30044c883faee0b1d0d682..de87ea33478a64fe210c8e49cb122f7817b8ad43 100644 (file)
@@ -55,18 +55,24 @@ Set output delay [ms] inserted between each sent line (default: 0).
 .BR "    \-\-line\-pulse\-duration " \fI<duration>
 
 Set the pulse duration [ms] of each serial port line using the following key
-valur pair format in the duration field: <key>=<value>
+value pair format in the duration field: <key>=<value>
 
 Each key represents a serial line. The following keys are available:
 
 .RS
-.TP 12n
-.IP "\fBDTR - Data Terminal Ready"
-.IP "\fBRTS - Request To Send"
-.IP "\fBCTS - Clear To Send"
-.IP "\fBDSR - Data Set Ready"
-.IP "\fBDCD - Data Carrier Detect"
-.IP "\fBRI  - Ring Indicator"
+.TP 8n
+.IP \fBDTR
+Data Terminal Ready
+.IP \fBRTS
+Request To Send
+.IP \fBCTS
+Clear To Send
+.IP \fBDSR
+Data Set Ready
+.IP \fBDCD
+Data Carrier Detect
+.IP \fBRI
+Ring Indicator
 .P
 If defining more than one key value pair, the pairs must be comma separated.
 
@@ -118,15 +124,14 @@ Default format is \fB24hour\fR
 .TP
 .BR \-L ", " \-\-list\-devices
 
-List available serial devices.
+List available serial devices by ID.
 
 .TP
 .BR \-l ", " \-\-log
 
 Enable log to file.
 
-If no filename is provided the filename will be
-automatically generated.
+If no filename is provided the filename will be automatically generated.
 
 .TP
 .BR "    \-\-log-file \fI<filename>
@@ -185,10 +190,12 @@ Default value is "bold".
 .TP
 .BR \-S ", " "\-\-socket \fI<socket>\fR\fB
 
-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 \fBctrl-t\fR sequences are not recognized), and any input from the serial
-port is multiplexed to the terminal and all connected clients.
+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 \fBctrl-t\fR sequences
+are not recognized), and any input from the serial port is multiplexed to the
+terminal and all connected clients.
 
 Sockets remain open while the serial port is disconnected, and writes will block.
 
@@ -208,6 +215,58 @@ If port is 0 or no port is provided default port 3333 is used.
 At present there is a hardcoded limit of 16 clients connected at one time.
 .RE
 
+.TP
+.BR \-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.
+
+Any tio text is automatically muted when piping a string to tio while in
+response mode to make it easy to parse the response.
+
+.TP
+.BR "    \-\-response\-timeout " \fI<ms>
+
+Set timeout [ms] of line response (default: 100).
+
+.TP
+.BR "    \-\-rs\-485"
+
+Enable RS-485 mode.
+
+.TP
+.BR "    \-\-rs\-485\-config " \fI<config>
+
+Set the RS-485 configuration using the following key or key value pair format in
+the configuration field:
+
+.RS
+.TP 30n
+.IP \fBRTS_ON_SEND=value
+Set logical level (0 or 1) for RTS pin when sending
+.IP \fBRTS_AFTER_SEND=value
+Set logical level (0 or 1) for RTS pin after sending
+.IP \fBRTS_DELAY_BEFORE_SEND=value
+Set RTS delay (ms) before sending
+.IP \fBRTS_DELAY_AFTER_SEND=value
+Set RTS delay (ms) after sending
+.IP \fBRX_DURING_TX
+Receive data even while sending data
+.P
+If defining more than one key or key value pair, they must be comma separated.
+.RE
+
+.TP
+.BR "\-\-alert none|bell|blink"
+
+Set alert action on connect/disconnect.
+
+It will sound the bell once or blink once on successful connect. Likewise it
+will sound the bell twice or blink twice on disconnect.
+
+Default value is "none".
+
 .TP
 .BR \-v ", " \-\-version
 
@@ -288,7 +347,7 @@ Any options set via command-line will override options set in the configuration
 .PP
 The following configuration file options are available:
 
-.TP 21n
+.TP 25n
 .IP "\fBpattern"
 Pattern matching user input. This pattern can be an extended regular expression with a single group.
 .IP "\fBtty"
@@ -333,6 +392,16 @@ Enable hexadecimal mode
 Set socket to redirect I/O to
 .IP "\fBprefix-ctrl-key"
 Set prefix ctrl key (a..z, default: t)
+.IP "\fBresponse-wait"
+Enable wait for line response
+.IP "\fBresponse-timeout"
+Set line response timeout
+.IP "\fBrs-485"
+Enable RS-485 mode
+.IP "\fBrs-485-config"
+Set RS-485 configuration
+.IP "\fBalert"
+Set alert action on connect/disconnect
 
 .SH "CONFIGURATION FILE EXAMPLES"
 
@@ -469,12 +538,24 @@ $ nc -N 10.0.0.42 4444
 Pipe command to the serial device:
 
 $ echo "ls -la" | tio /dev/serial/by\-id/usb\-FTDI_TTL232R-3V3_FTGQVXBL\-if00\-port0
+
+.TP
+Pipe command to the serial device and wait for line response (string ending with CR or NL):
+
+$ echo "*IDN?" | tio /dev/ttyACM0 --response-wait
+.TP
+In this mode, only the response will be printed.
+
 .TP
 Likewise, to pipe data from file to the serial device:
 
 $ cat data.bin | tio /dev/serial/by\-id/usb\-FTDI_TTL232R-3V3_FTGQVXBL\-if00\-port0
 
+.TP
+Enable RS-485 mode:
+
+$ tio --rs-485 --rs-485-config=RTS_ON_SEND=1,RX_DURING_TX /dev/ttyUSB0
+
 .SH "WEBSITE"
 .PP
 Visit https://tio.github.io