]> git.sur5r.net Git - tio/blobdiff - man/tio.1.txt
New upstream version 2.6
[tio] / man / tio.1.txt
index c66269fd929108535b12bcda071498dafef97db3..252ca60a9ab12226700999d870e71962bd6f3a57 100644 (file)
@@ -1,4 +1,4 @@
-tio(1)                                                                                                                User Commands                                                                                                               tio(1)
+tio(1)                                                                                                                                         User Commands                                                                                                                                         tio(1)
 
 NAME
        tio - a simple serial device I/O tool
@@ -66,8 +66,7 @@ OPTIONS
 
               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
-              reappear and then reconnect.
+              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.
 
               However, if the --no-autoconnect option is provided, tio will exit if the device is not present or an established connection is lost.
 
@@ -101,12 +100,18 @@ OPTIONS
 
               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>
 
               Set log filename.
 
+           --log-append
+
+              Append to log file.
+
            --log-strip
 
               Strip control characters and escape sequences from log.
@@ -151,8 +156,7 @@ OPTIONS
 
               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
-              terminal and all connected clients.
+              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.
 
               Sockets remain open while the serial port is disconnected, and writes will block.
 
@@ -170,7 +174,7 @@ OPTIONS
 
        -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.
 
@@ -215,7 +219,7 @@ OPTIONS
               Display help.
 
 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
 
@@ -391,11 +395,11 @@ EXAMPLES
 
        Redirect serial device I/O to Unix file socket for scripting:
 
-              $ tio -S unix:/tmp/tmux-socket0 /dev/ttyUSB0
+              $ tio -S unix:/tmp/tio-socket0 /dev/ttyUSB0
 
        Then, to issue a command via the file socket simply do:
 
-              $ echo "ls -la" | nc -UN /tmp/tmux-socket0 > /dev/null
+              $ echo "ls -la" | nc -UN /tmp/tio-socket0 > /dev/null
 
        Or use the expect command to script an interaction:
 
@@ -444,4 +448,4 @@ WEBSITE
 AUTHOR
        Created by Martin Lund <martin.lund@keep-it-simple.com>.
 
-tio 2.5                                                                                                                2022-11-02                                                                                                                 tio(1)
+tio 2.6                                                                                                                                          2022-12-17                                                                                                                                          tio(1)