git.sur5r.net Git - tio/blob - man/tio.1

   1 .TH "tio" "1" "June 2018"
   2
   3 .SH "NAME"
   4 tio \- a simple TTY terminal I/O application
   5
   6 .SH "SYNOPSIS"
   7 .PP
   8 .B tio
   9 .RI "[" <options> "] " "<tty-device>"
  10
  11 .SH "DESCRIPTION"
  12 .PP
  13 .B tio
  14 is a simple TTY terminal application which features a straightforward
  15 commandline interface to easily connect to TTY devices for basic input/output.
  16
  17 .SH "OPTIONS"
  18
  19 .TP
  20 .BR \-b ", " "\-\-baudrate " \fI<bps>
  21
  22 Set baud rate [bps] (default: 115200).
  23 .TP
  24 .BR \-d ", " "\-\-databits 5" | 6 | 7 | 8
  25
  26 Set data bits (default: 8).
  27 .TP
  28 .BR \-f ", " "\-\-flow hard" | soft | none
  29
  30 Set flow control (default: none).
  31 .TP
  32 .BR \-s ", " "\-\-stopbits 1" | 2
  33
  34 Set stop bits (default: 1).
  35 .TP
  36 .BR \-p ", " "\-\-parity odd" | even | none
  37
  38 Set parity (default: none).
  39 .TP
  40 .BR \-o ", " "\-\-output\-delay " \fI<ms>
  41
  42 Set output delay [ms] inserted between each sent character (default: 0).
  43 .TP
  44 .BR \-n ", " \-\-no\-autoconnect
  45
  46 Disable automatic connect.
  47
  48 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.
  49
  50 However, if the
  51 .B \-\-no\-autoconnect
  52 option is provided, tio will exit if the device is not present or an established connection is lost.
  53
  54 .TP
  55 .BR \-e ", " "\-\-local\-echo
  56
  57 Enable local echo.
  58
  59 .TP
  60 .BR \-l ", " "\-\-log " \fI<filename>
  61
  62 Log to file.
  63
  64 .TP
  65 .BR \-m ", " "\-\-map " \fI<flags>
  66
  67 Map (replace, translate) special characters on input or output. The following mapping flags are supported:
  68
  69 .RS
  70 .TP 12n
  71 .IP "\fBICRNL"
  72 Map CR to NL on input (unless IGNCR is set).
  73 .IP "\fBIGNCR"
  74 Ignore CR on input.
  75 .IP "\fBINLCR"
  76 Map NL to CR on input.
  77 .IP "\fBINLCRNL"
  78 Map NL to CR-NL on input.
  79 .IP "\fBOCRNL"
  80 Map CR to NL on output.
  81 .IP "\fBODELBS"
  82 Map DEL to BS on output.
  83 .IP "\fBONLCRNL"
  84 Map NL to CR-NL on output.
  85 .P
  86 If defining more than one flag, the flags must be comma separated.
  87 .RE
  88
  89 .TP
  90 .BR \-v ", " \-\-version
  91
  92 Display program version.
  93 .TP
  94 .BR \-h ", " \-\-help
  95
  96 Display help.
  97
  98 .SH "KEYS"
  99 .PP
 100 .TP 16n
 101 In session, the following key sequences are intercepted as tio commands:
 102 .IP "\fBctrl-t ?"
 103 List available key commands
 104 .IP "\fBctrl-t b"
 105 Send serial break (triggers SysRq on Linux, etc.)
 106 .IP "\fBctrl-t c"
 107 Show configuration (baudrate, databits, etc.)
 108 .IP "\fBctrl-t e"
 109 Toggle local echo mode
 110 .IP "\fBctrl-t h"
 111 Toggle hexadecimal mode
 112 .IP "\fBctrl-t l"
 113 Clear screen
 114 .IP "\fBctrl-t q"
 115 Quit
 116 .IP "\fBctrl-t s"
 117 Show TX/RX statistics
 118 .IP "\fBctrl-t t"
 119 Send ctrl-t key code
 120
 121 .SH "EXAMPLES"
 122 .TP
 123 Typical use is without options. For example:
 124
 125 tio /dev/ttyUSB0
 126 .TP
 127 Which corresponds to the commonly used options:
 128
 129 tio \-b 115200 \-d 8 \-f none \-s 1 \-p none /dev/ttyUSB0
 130 .TP
 131 It is recommended to connect serial tty devices by ID. For example:
 132
 133 tio /dev/serial/by\-id/usb\-FTDI_TTL232R-3V3_FTGQVXBL\-if00\-port0
 134 .PP
 135 Using serial devices by ID ensures that tio automatically reconnects to the
 136 correct serial device if the device is disconnected and then reconnected.
 137
 138 .SH "WEBSITE"
 139 .PP
 140 Visit https://tio.github.io
 141
 142 .SH "AUTHOR"
 143 .PP
 144 Written by Martin Lund <martin.lund@keep\-it\-simple.com>.