Update upstream source from tag 'upstream/2.0'

[tio] / README.md

diff --git a/README.md b/README.md
index a79bc159285e5809808b6b602ba1d6056372c453..8861b68819f92473d99395a201a673561b75e860 100644 (file)
--- a/README.md
+++ b/README.md
@@ -28,7 +28,9 @@ when used in combination with [tmux](https://tmux.github.io).
 
  * Easily connect to serial TTY devices
  * Automatic connect and reconnect
- * Support for arbitrary baud rates
+ * Sensible defaults
+ * Support for non-standard baud rates
+ * Support for RS-485 mode
  * List available serial devices by ID
  * Show RX/TX statistics
  * Toggle serial lines
@@ -43,17 +45,20 @@ when used in combination with [tmux](https://tmux.github.io).
  * Autogeneration of log filename
  * Configuration file support
  * Activate sub-configurations by name or pattern
- * Redirect I/O to file or network socket for scripting or TTY sharing
+ * Redirect I/O to UNIX socket or IPv4/v6 network socket for scripting or TTY sharing
  * Pipe input and/or output
+ * Support for simple line request/response handling
  * Bash completion
  * Color support
+ * Visual or audible alert on connect/disconnect
  * Remapping of prefix key
  * Man page documentation
+ * Plays nicely with [tmux](https://tmux.github.io)
 
 ## 3. Usage
 
 For more usage details please see the man page documentation
-[here](man/tio.1.txt).
+[here](https://raw.githubusercontent.com/tio/tio/master/man/tio.1.txt).
 
 ### 3.1 Command-line
 
@@ -83,8 +88,13 @@ The command-line interface is straightforward as reflected in the output from
         --log-strip                        Strip control characters and escape sequences
     -m, --map <flags>                      Map characters
     -c, --color 0..255|bold|none|list      Colorize tio text (default: bold)
-    -S, --socket <socket>                  Redirect I/O to file or network socket
+    -S, --socket <socket>                  Redirect I/O to socket
     -x, --hexadecimal                      Enable hexadecimal mode
+    -r, --response-wait                    Wait for line response then quit
+        --response-timeout <ms>            Response timeout (default: 100)
+        --rs-485                           Enable RS-485 mode
+        --rs-485-config <config>           Set RS-485 configuration
+        --alert bell|blink|none            Alert on connect/disconnect (default: none)
     -v, --version                          Display version
     -h, --help                             Display help
 
@@ -121,6 +131,18 @@ $ tio /dev/serial/by-id/usb-FTDI_TTL232R-3V3_FTGQVXBL-if00-port0
 Using serial devices by ID ensures that tio automatically reconnects to the
 correct serial device if it is disconnected and then reconnected.
 
+
+Inject data to the serial device:
+```
+$ cat data.bin | tio /dev/ttyUSB0
+```
+
+Send command to serial device and wait for line response:
+```
+$ echo "*IDN?" | tio /dev/ttyACM0 --response-wait
+KORAD KD3305P V4.2 SN:32475045
+```
+
 ### 3.2 Key commands
 
 Various in session key commands are supported. When tio is started, press
@@ -202,7 +224,7 @@ Packages for various GNU/Linux distributions are available. Please consult your
 package manager tool to find and install tio.
 
 If you would like to see tio included in your favorite distribution, please
-reach out to their package maintainers team.
+reach out to its package maintainers team.
 
 ### 4.2 Installation using snap (Linux)
 
@@ -218,11 +240,11 @@ If you have [brew](http://brew.sh) installed:
     $ brew install tio
 ```
 
-### 4.4 Installation using MacPorts (MacOS)
+### 4.4 Installation using MSYS2 (Windows)
 
-If you have [MacPorts](https://www.macports.org) installed:
+If you have [MSYS2](https://www.msys2.org) installed:
 ```
-    $ sudo port install tio
+    $ pacman -S tio
 ```
 
 ### 4.5 Installation from source
@@ -238,8 +260,7 @@ Install steps:
 
 See meson\_options.txt for tio specific build options.
 
-Note: It is recommended to only try to install from source if you are familiar
-with how to build stuff using meson.
+Note: The meson install steps may differ depending on your specific system.
 
 
 ## 5. Contributing