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

   1 .TH "tio" "1" "7 May 2016"
   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] \(em delay inserted between each transmitted character (default: 0).
  43 .TP
  44 .BR \-n ", " \-\-no\-autoconnect
  45
  46 Disable automatic connect.
  47 .TP
  48 .BR \-l ", " "\-\-log " \fI<filename>
  49
  50 Log to file.
  51 .TP
  52 .BR \-v ", " \-\-version
  53
  54 Display program version.
  55 .TP
  56 .BR \-h ", " \-\-help
  57
  58 Display help.
  59
  60 .SH "KEYS"
  61 .PP
  62 .TP 16n
  63 In session, the following key sequences are intercepted as tio commands:
  64 .IP "\fBctrl-t ?"
  65 List available key commands
  66 .IP "\fBctrl-t i"
  67 Show settings information (baudrate, databits, etc.)
  68 .IP "\fBctrl-t q"
  69 Quit
  70 .IP "\fBctrl-t s"
  71 Show statistics (total number of bytes transmitted/received)
  72 .IP "\fBctrl-t t"
  73 Send ctrl-t key code
  74
  75 .SH "EXAMPLES"
  76 .TP
  77 A typical use is without options. For example:
  78
  79 tio /dev/ttyUSB0
  80 .TP
  81 Which corresponds to the commonly used options:
  82
  83 tio \-b 115200 \-d 8 \-f none \-s 1 \-p none /dev/ttyUSB0
  84 .TP
  85 It is recommended to connect serial tty devices by id. For example:
  86
  87 tio /dev/serial/by\-id/usb\-FTDI_TTL232R-3V3_FTGQVXBL\-if00\-port0
  88 .PP
  89 Using serial devices by id ensures that tio automatically reconnects to the
  90 correct serial device if the device is disconnected and then reconnected.
  91
  92 .SH "AUTHOR"
  93 .PP
  94 Written by Martin Lund <martin.lund@keep\-it\-simple.com>.