README.md

   1 ## Flags
   2
   3 All flags can have their default values set by modifying `config.h`, additional info and configuration options are also available in the file
   4
   5  * `--line|-l dev` - device to open, can be specified with `/dev/` or as just the device name
   6  * `--verbose|-v` - toggle verbose output
   7  * `--speed|-s # | -#` - baudrate, can also be set with just the number
   8  * `--rx-speed|-i` - separate baudrate for RX line, same as TX if not set explicitly
   9  * `--data|-D bits` - set data bits
  10  * `--stop-bits|-S bits` - set stop bits
  11  * `--software|-X` - toggle XON/XOFF flow control
  12  * `--delay|-d delay` - delay between sending characters in nanoseconds
  13  * `--min-chars|-m` - the minimum number of characters to start sending them
  14  * `--backspace|-b` - toggle between ASCII `DELETE` and `BACKSPACE` characters
  15  * `--echo|-h` - toggle local echo (half-duplex mode)
  16  * `--canonical|-c` - toggle canonical mode (text can be edited locally before sending it to the line)
  17
  18 > If both even and odd parity flags are set, parity is disabled
  19
  20  * `--odd|-o` - toggle odd parity
  21  * `--even|-e` - toggle even parity
  22
  23 > If both hardware flow control flags are set, DCD flow control is enabled
  24
  25  * `--hardware-rts-cts|-R` - toggle RTS/CTS flow control
  26  * `--hardware-dtr-dsr|-r` - toggle DTR/DSR flow control
  27
  28 ---
  29
  30  * `--translation|-t option` - CR and LF translation for data sent
  31  * `--input-translation|-T option` - CR and LF translation for data read
  32
  33 ### Options:
  34
  35  * `cr-to-lf`
  36  * `cr-in-lf` - CR to CRLF
  37  * `no-cr`
  38  * `lf-to-cr`
  39  * `lf-in-cr` - LF to CRLF
  40  * `no-lf`
  41
  42 ## Interactive use
  43
  44 Special character (`~` by default, may be set in `config.h`) will be escaped if it's the first one in the buffer.
  45
  46 ### Commands
  47
  48  * `.` - drop connection and exit
  49  * `b` - toggle backspace character
  50  * `h` - toggle local echo
  51  * `c` - toggle canonical mode
  52  * `s` - set new baudrate
  53  * `d` - set new character delay
  54  * `t|T` - toggle a translation option for output|input
  55  * `w` - write file contents to the line
  56  * `p` - send a DCD pulse