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

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