X-Git-Url: https://git.datadissipation.net/ust/blobdiff_plain/583162323b4770ec84061c2257d2b1c144f1f679..40fa18eb720897145f1d9524ec2dc74018aad2ef:/README.md diff --git a/README.md b/README.md index c429905..44d3f50 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,9 @@ -## Flags +## Installation -All flags can have their default values set by modifying `config.h`, additional info and configuration options are also available in the file +Before installing check `config.mk` - inside, the installation directories can be set. - * `--line|-l dev` - 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 - * `--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 - * `--echo|-h` - toggle local echo (half-duplex mode) - * `--canonical|-c` - toggle canonical mode (text can be edited locally before sending it to the line) +To install, simply run: -> If both even and odd parity flags are set, parity is disabled - - * `--odd|-o` - toggle odd parity - * `--even|-e` - toggle even parity - -> If both hardware flow control flags are set, DCD flow control is enabled - - * `--hardware-rts-cts|-R` - toggle RTS/CTS flow control - * `--hardware-dtr-dsr|-r` - toggle DTR/DSR flow control - ---- - - * `--translation|-t option` - CR and LF translation for data sent - * `--input-translation|-T option` - CR and LF translation for data read -### Options: - * `cr-to-lf` - * `cr-in-lf` - CR to CRLF - * `no-cr` - * `lf-to-cr` - * `lf-in-cr` - LF to CRLF - * `no-lf` - -## Interactive use - -Special character (`~` by default, may be set in `config.h`) will be escaped if it's the first one in the buffer. - -### Commands - - * `.` - drop connection and exit - * `b` - toggle backspace character - * `h` - toggle local echo - * `c` - toggle canonical mode - * `s` - set new baudrate - * `d` - set new character delay - * `t|T` - toggle a translation option for output|input - * `w` - write file contents to the line - * `p` - send a DCD pulse +``` +make && make install +```