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 terminal
  11     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           -m, --map <flags>           Map special characters
  32           -v, --version               Display version
  33           -h, --help                  Display help
  34
  35         In session, press ctrl-t q to quit.
  36
  37
  38     The only option which requires a bit of elaboration is perhaps the
  39     --no-autoconnect option.
  40
  41     By default tio automatically connects to the provided device if present.
  42     If the device is not present, it will wait for it to appear and then
  43     connect. If the connection is lost (eg. device is unplugged), it will wait
  44     for the device to reappear and then reconnect. However, if the
  45     --no-autoconnect option is provided, tio will exit if the device is not
  46     present or an established connection is lost.
  47
  48     Tio features full bash autocompletion support.
  49
  50     Tio also supports various key commands. Press ctrl-t ? to list the
  51     available key commands.
  52
  53     See the tio man page for more details.
  54
  55
  56 3. Installation
  57
  58     The latest release version is available at https://tio.github.io
  59
  60 3.1 Installation using release tarball
  61
  62     Install steps:
  63
  64      $ ./configure
  65      $ make
  66      $ make install
  67
  68     See INSTALL file for more installation details.
  69
  70 3.2 Installation using package
  71
  72     Tio comes prepackaged for various GNU/Linux distributions. Visit
  73     https://tio.github.io for package installation details.
  74
  75
  76 4. Contributing
  77
  78     Tio is open source. All contributions (bug fixes, doc, ideas, etc.) are
  79     welcome. Visit the tio GitHub page to access latest source code, create
  80     pull requests, add issues etc..
  81
  82     GitHub: https://github.com/tio/tio
  83
  84     Also, if you find this free open source software useful please consider
  85     making a donation: https://www.paypal.me/lundmar
  86
  87
  88 5. Support
  89
  90     Submit bug reports via GitHub: https://github.com/tio/tio/issues
  91
  92
  93 6. Website
  94
  95     Visit https://tio.github.io
  96
  97
  98 7. License
  99
 100     Tio is GPLv2+. See COPYING file for license details.
 101
 102
 103 8. Authors
 104
 105     Created by Martin Lund <martin.lund@keep-it-simple.com>
 106
 107     See the AUTHORS file for full list of authors.