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