git.sur5r.net Git - tio/blob - README

   1 === tio - a simple TTY terminal I/O application ===
   2
   3
   4 1. Introduction
   5
   6     "tio" is a simple TTY terminal application which features a straightforward
   7     commandline interface to easily connect to TTY devices for basic
   8     input/output.
   9
  10     It was created because the author needed a simple no-nonsense TTY
  11     terminal application to easily connect to various terminal TTY devices.
  12
  13
  14 2. Usage
  15
  16     The commandline interface is straightforward as reflected in the output
  17     from 'tio --help':
  18
  19
  20         Usage: tio [<options>] <tty device>
  21
  22         Options:
  23           -b, --baudrate <bps>        Baud rate (default: 115200)
  24           -d, --databits 5|6|7|8      Data bits (default: 8)
  25           -f, --flow hard|soft|none   Flow control (default: none)
  26           -s, --stopbits 1|2          Stop bits (default: 1)
  27           -p, --parity even|odd|none  Parity (default: none)
  28           -o, --output-delay <ms>     Output delay (default: 0)
  29           -n, --no-autoconnect        Disable automatic connect
  30           -l, --log <filename>        Log to file
  31           -v, --version               Display version
  32           -h, --help                  Display help
  33
  34         In session, press ctrl-t q to quit.
  35
  36
  37     The only option which requires a bit of elaboration is perhaps the
  38     --no-autoconnect option.
  39
  40     By default tio automatically connects to the provided device if present.
  41     If the device is not present it will wait for it to appear and then
  42     connect. If the connection is lost (eg. device disconnects) it will wait
  43     for the device to reappear and then reconnect.
  44
  45     However, if the --no-autoconnect option is provided tio will exit if the
  46     device is not present or exit if an established connection is lost.
  47
  48     Tio features full bash autocompletion support.
  49
  50
  51 3. Download
  52
  53     Find the latest release tarball at https://tio.github.io
  54
  55     The latest source is available on GitHub: https://github.com/tio/tio
  56
  57
  58 4. Installation
  59
  60     Install steps:
  61
  62     $ ./configure
  63     $ make
  64     $ make install
  65
  66     See INSTALL file for installation details.
  67
  68
  69 5. Contributing
  70
  71     Tio is open source. Any contributions (bug fixes, doc, ideas, etc.) are
  72     welcome.
  73
  74
  75 6. Support
  76
  77     Submit bug reports on GitHub: https://github.com/tio/tio/issues
  78
  79
  80 7. License
  81
  82     Tio is GPLv2+. See COPYING file for license details.
  83
  84
  85 8. Authors
  86
  87     Created by Martin Lund <martin.lund@keep-it-simple.com>
  88
  89     See the AUTHORS file for full list of authors.