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

   1 .TH "tio" "1" "@version_date@" "tio @version@" "User Commands"
   2
   3 .SH "NAME"
   4 tio \- a simple TTY terminal I/O tool
   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 tool which features a straightforward command-line
  15 interface to easily connect to TTY devices for basic I/O operations.
  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 \-t ", " \-\-timestamp
  61
  62 Enable line timestamp.
  63
  64 .TP
  65 .BR \-L ", " \-\-list\-devices
  66
  67 List available serial devices.
  68
  69 .TP
  70 .BR \-l ", " "\-\-log " \fI<filename>
  71
  72 Log to file.
  73
  74 .TP
  75 .BR \-m ", " "\-\-map " \fI<flags>
  76
  77 Map (replace, translate) special characters on input or output. The following mapping flags are supported:
  78
  79 .RS
  80 .TP 12n
  81 .IP "\fBICRNL"
  82 Map CR to NL on input (unless IGNCR is set).
  83 .IP "\fBIGNCR"
  84 Ignore CR on input.
  85 .IP "\fBINLCR"
  86 Map NL to CR on input.
  87 .IP "\fBINLCRNL"
  88 Map NL to CR-NL on input.
  89 .IP "\fBOCRNL"
  90 Map CR to NL on output.
  91 .IP "\fBODELBS"
  92 Map DEL to BS on output.
  93 .IP "\fBONLCRNL"
  94 Map NL to CR-NL on output.
  95 .P
  96 If defining more than one flag, the flags must be comma separated.
  97 .RE
  98
  99 .TP
 100 .BR \-c ", " "\-\-color " \fI<0..255>
 101
 102 Colorize tio text using ANSI color code.
 103
 104 If color code is negative a list of available ANSI colors will be printed.
 105
 106 .TP
 107 .BR \-v ", " \-\-version
 108
 109 Display program version.
 110 .TP
 111 .BR \-h ", " \-\-help
 112
 113 Display help.
 114
 115 .SH "KEYS"
 116 .PP
 117 .TP 16n
 118 In session, the following key sequences are intercepted as tio commands:
 119 .IP "\fBctrl-t ?"
 120 List available key commands
 121 .IP "\fBctrl-t b"
 122 Send serial break (triggers SysRq on Linux, etc.)
 123 .IP "\fBctrl-t c"
 124 Show configuration (baudrate, databits, etc.)
 125 .IP "\fBctrl-t e"
 126 Toggle local echo mode
 127 .IP "\fBctrl-t h"
 128 Toggle hexadecimal mode
 129 .IP "\fBctrl-t l"
 130 Clear screen
 131 .IP "\fBctrl-t q"
 132 Quit
 133 .IP "\fBctrl-t s"
 134 Show TX/RX statistics
 135 .IP "\fBctrl-t t"
 136 Send ctrl-t key code
 137 .IP "\fBctrl-t L"
 138 Show lines state (DTR, RTS, CTS, DSR, DCD, RI)
 139 .IP "\fBctrl-t d"
 140 Toggle DTR
 141 .IP "\fBctrl-t r"
 142 Toggle RTS
 143 .IP "\fBctrl-t v"
 144 Show version
 145
 146 .SH "EXAMPLES"
 147 .TP
 148 Typical use is without options. For example:
 149
 150 tio /dev/ttyUSB0
 151 .TP
 152 Which corresponds to the commonly used options:
 153
 154 tio \-b 115200 \-d 8 \-f none \-s 1 \-p none /dev/ttyUSB0
 155 .TP
 156 It is recommended to connect serial tty devices by ID. For example:
 157
 158 tio /dev/serial/by\-id/usb\-FTDI_TTL232R-3V3_FTGQVXBL\-if00\-port0
 159 .PP
 160 Using serial devices by ID ensures that tio automatically reconnects to the
 161 correct serial device if the device is disconnected and then reconnected.
 162
 163 .SH "WEBSITE"
 164 .PP
 165 Visit https://tio.github.io
 166
 167 .SH "AUTHOR"
 168 .PP
 169 Written by Martin Lund <martin.lund@keep\-it\-simple.com>.