]> datadissipation.net git - ust.git/commitdiff
README fixes
authorgit <redacted>
Mon, 16 Feb 2026 17:35:54 +0000 (12:35 -0500)
committergit <redacted>
Mon, 16 Feb 2026 17:35:54 +0000 (12:35 -0500)
README.md

index d301e44d8b25241e7a7a468992b229f895adf6be..ed51c114753192da7c336fa13303348f8c33cde0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,16 +2,16 @@
 
 All flags can have their default values set by modifying `config.h`, additional info and configuration options are also available in the file
 
- * `--line|-l dev` - device to open, can be specified with `/dev/` or as just the device name
+ * `--line|-l line` - line (device) to open, can be specified with `/dev/` or as just the device name
  * `--verbose|-v` - toggle verbose output
- * `--speed|-s # | -#` - baudrate, can also be set with just the number
- * `--rx-speed|-i` - separate baudrate for RX line, same as TX if not set explicitly
+ * `--speed|-s # | -#` - set baudrate
+ * `--rx-speed|-i` - set separate baudrate for RX line, same as TX if not set explicitly
  * `--data|-D bits` - set data bits
  * `--stop-bits|-S bits` - set stop bits 
  * `--software|-X` - toggle XON/XOFF flow control
- * `--delay|-d delay` - delay between sending characters in nanoseconds
- * `--min-chars|-m` - the minimum number of characters to start sending them
- * `--backspace|-b` - toggle between ASCII `DELETE` and `BACKSPACE` characters
+ * `--delay|-d delay` - delay between sending characters (in nanoseconds)
+ * `--min-chars|-m` - the minimal number of characters to start sending to the line
+ * `--backspace|-b` - toggle between ASCII `DELETE` and `BACKSPACE` characters for backspace key
  * `--echo|-h` - toggle local echo (half-duplex mode)
  * `--canonical|-c` - toggle canonical mode (text can be edited locally before sending it to the line)
 
@@ -25,7 +25,7 @@ All flags can have their default values set by modifying `config.h`, additional
  * `--hardware-rts-cts|-R` - toggle RTS/CTS flow control
  * `--hardware-dtr-dsr|-r` - toggle DTR/DSR flow control
 
----
+> Multiple translation options should be specified with multiple flags, e.g., `-t no-cr -t no-lf`  
 
  * `--translation|-t option` - CR and LF translation for data sent
  * `--input-translation|-T option` - CR and LF translation for data read
@@ -46,7 +46,7 @@ Special character (`~` by default, may be set in `config.h`) will be escaped if
 ### Commands
 
  * `.` - drop connection and exit
- * `b` - toggle backspace character
+ * `b` - toggle backspace character between the two
  * `h` - toggle local echo
  * `c` - toggle canonical mode
  * `s` - set new baudrate