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
  61 3.1 Installation using release tarball
  62
  63     Install steps:
  64
  65      $ ./configure
  66      $ make
  67      $ make install
  68
  69     See INSTALL file for more installation details.
  70
  71
  72 3.2 Installation using package
  73
  74     Tio comes prepackaged for various GNU/Linux distributions. Visit
  75     https://tio.github.io for package installation details.
  76
  77
  78 4. Contributing
  79
  80     Tio is open source. All contributions (bug fixes, doc, ideas, etc.) are
  81     welcome. Visit the tio GitHub page to access latest source code, create
  82     pull requests, add issues etc..
  83
  84     GitHub: https://github.com/tio/tio
  85
  86     Also, if you find this free open source software useful please consider
  87     making a donation: https://www.paypal.me/lundmar
  88
  89
  90 5. Support
  91
  92     Submit bug reports via GitHub: https://github.com/tio/tio/issues
  93
  94
  95 6. Website
  96
  97     Visit https://tio.github.io
  98
  99
 100 7. License
 101
 102     Tio is GPLv2+. See COPYING file for license details.
 103
 104
 105 8. Authors
 106
 107     Created by Martin Lund <martin.lund@keep-it-simple.com>
 108
 109     See the AUTHORS file for full list of authors.