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

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