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

   1 # tio - a simple TTY terminal I/O tool
   2
   3 [![CircleCI](https://circleci.com/gh/tio/tio/tree/master.svg?style=shield)](https://circleci.com/gh/tio/tio/tree/master)
   4 [![tio](https://snapcraft.io/tio/badge.svg)](https://snapcraft.io/tio)
   5
   6 ## 1. Introduction
   7
   8 tio is a simple TTY terminal tool which features a straightforward command-line
   9 interface to easily connect to TTY devices for basic I/O operations.
  10
  11 <p align="center">
  12 <img src="images/tio-demo.gif">
  13 </p>
  14
  15 ### 1.1 Motivation
  16
  17 To make a simpler TTY terminal tool for talking with TTY devices with less
  18 focus on classic terminal/modem features and more focus on the needs of
  19 embedded developers and hackers.
  20
  21 ## 2. Usage
  22
  23 The command-line interface is straightforward as reflected in the output from
  24 'tio --help':
  25 ```
  26     Usage: tio [<options>] <tty-device>
  27
  28     Options:
  29       -b, --baudrate <bps>        Baud rate (default: 115200)
  30       -d, --databits 5|6|7|8      Data bits (default: 8)
  31       -f, --flow hard|soft|none   Flow control (default: none)
  32       -s, --stopbits 1|2          Stop bits (default: 1)
  33       -p, --parity odd|even|none  Parity (default: none)
  34       -o, --output-delay <ms>     Output delay (default: 0)
  35       -n, --no-autoconnect        Disable automatic connect
  36       -e, --local-echo            Do local echo
  37       -t, --timestamp             Timestamp lines
  38       -L, --list-devices          List available serial devices
  39       -l, --log <filename>        Log to file
  40       -m, --map <flags>           Map special characters
  41       -c, --color <0..255>        Colorize tio text
  42       -v, --version               Display version
  43       -h, --help                  Display help
  44
  45     See the man page for list of supported mapping flags.
  46
  47     In session, press ctrl-t q to quit.
  48 ```
  49
  50 The only option which requires a bit of elaboration is perhaps the
  51 `--no-autoconnect` option.
  52
  53 By default tio automatically connects to the provided device if present.  If
  54 the device is not present, it will wait for it to appear and then connect. If
  55 the connection is lost (eg. device is unplugged), it will wait for the device
  56 to reappear and then reconnect. However, if the `--no-autoconnect` option is
  57 provided, tio will exit if the device is not present or an established
  58 connection is lost.
  59
  60 Tio features full bash autocompletion support.
  61
  62 Tio also supports various key commands. Press ctrl-t ? to list the available
  63 key commands.
  64
  65 See the tio man page for more details.
  66
  67
  68 ## 3. Installation
  69
  70 ### 3.1 Installation using package manager
  71 tio comes prepackaged for various GNU/Linux distributions. Please consult your package manager tool to find and install tio.
  72
  73 ### 3.2 Installation using snap
  74
  75 Install latest stable version:
  76 ```
  77     $ snap install tio
  78 ```
  79 Install bleeding edge:
  80 ```
  81     $ snap install tio --edge
  82 ```
  83
  84 ### 3.3 Installation from source
  85
  86 The latest source releases can be found [here](https://github.com/tio/tio/releases).
  87
  88 Install steps:
  89 ```
  90     $ meson build
  91     $ meson compile -C build
  92     $ meson install -C build
  93 ```
  94
  95 See meson\_options.txt for tio specific build options.
  96
  97 Note: Please do no try to install from source if you are not familiar with
  98 how to build stuff using meson.
  99
 100
 101 ## 4. Contributing
 102
 103 tio is open source. If you want to help out with the project please feel free
 104 to join in.
 105
 106 All contributions (bug reports, code, doc, ideas, etc.) are welcome.
 107
 108 Please use the github issue tracker and pull request features.
 109
 110 Also, if you find this free open source software useful please feel free to
 111 consider making a donation of your choice:
 112
 113 [![Donate](images/paypal.png)](https://www.paypal.me/lundmar)
 114
 115
 116 ## 5. Support
 117
 118 Submit bug reports via GitHub: https://github.com/tio/tio/issues
 119
 120
 121 ## 6. Website
 122
 123 Visit [tio.github.io](https://tio.github.io)
 124
 125
 126 ## 7. License
 127
 128 Tio is GPLv2+. See COPYING file for license details.
 129
 130
 131 ## 8. Authors
 132
 133 Created by Martin Lund \<martin.lund@keep-it-simple.com>
 134
 135 See the AUTHORS file for full list of contributors.