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

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