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

   1 .TH "tio" "1" "April 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 \-l ", " "\-\-log " \fI<filename>
  56
  57 Log to file.
  58
  59 .TP
  60 .BR \-m ", " "\-\-map " \fI<flags>
  61
  62 Map (replace, translate) special characters on input or output. The following mapping flags are supported:
  63
  64 .RS
  65 .TP 12n
  66 .IP "\fBICRNL"
  67 Map CR to NL on input (unless IGNCR is set).
  68 .IP "\fBIGNCR"
  69 Ignore CR on input.
  70 .IP "\fBINLCR"
  71 Map NL to CR on input.
  72 .IP "\fBINLCRNL"
  73 Map NL to CR-NL on input.
  74 .IP "\fBOCRNL"
  75 Map CR to NL on output.
  76 .IP "\fBODELBS"
  77 Map DEL to BS on output.
  78 .IP "\fBONLCRNL"
  79 Map NL to CR-NL on output.
  80 .P
  81 If defining more than one flag, the flags must be comma separated.
  82 .RE
  83
  84 .TP
  85 .BR \-v ", " \-\-version
  86
  87 Display program version.
  88 .TP
  89 .BR \-h ", " \-\-help
  90
  91 Display help.
  92
  93 .SH "KEYS"
  94 .PP
  95 .TP 16n
  96 In session, the following key sequences are intercepted as tio commands:
  97 .IP "\fBctrl-t ?"
  98 List available key commands
  99 .IP "\fBctrl-t b"
 100 Send serial break (triggers SysRq on Linux, etc.)
 101 .IP "\fBctrl-t c"
 102 Show configuration (baudrate, databits, etc.)
 103 .IP "\fBctrl-t h"
 104 Toggle hexadecimal mode
 105 .IP "\fBctrl-t l"
 106 Clear screen
 107 .IP "\fBctrl-t q"
 108 Quit
 109 .IP "\fBctrl-t s"
 110 Show TX/RX statistics
 111 .IP "\fBctrl-t t"
 112 Send ctrl-t key code
 113
 114 .SH "EXAMPLES"
 115 .TP
 116 Typical use is without options. For example:
 117
 118 tio /dev/ttyUSB0
 119 .TP
 120 Which corresponds to the commonly used options:
 121
 122 tio \-b 115200 \-d 8 \-f none \-s 1 \-p none /dev/ttyUSB0
 123 .TP
 124 It is recommended to connect serial tty devices by ID. For example:
 125
 126 tio /dev/serial/by\-id/usb\-FTDI_TTL232R-3V3_FTGQVXBL\-if00\-port0
 127 .PP
 128 Using serial devices by ID ensures that tio automatically reconnects to the
 129 correct serial device if the device is disconnected and then reconnected.
 130
 131 .SH "WEBSITE"
 132 .PP
 133 Visit https://tio.github.io
 134
 135 .SH "AUTHOR"
 136 .PP
 137 Written by Martin Lund <martin.lund@keep\-it\-simple.com>.