mirror of
https://github.com/tio/tio.git
synced 2026-05-01 14:57:59 +02:00
Update README
This commit is contained in:
Martin Lund
parent
b46ea8b758
commit
101e32749b
4 changed files with 25 additions and 129 deletions
109
README
109
README
|
|
@ -1,109 +0,0 @@
|
|||
=== tio - a simple TTY terminal I/O application ===
|
||||
|
||||
|
||||
1. Introduction
|
||||
|
||||
tio is a simple TTY terminal application which features a straightforward
|
||||
commandline interface to easily connect to TTY devices for basic
|
||||
input/output.
|
||||
|
||||
It was created because the author needed a simple no-nonsense TTY terminal
|
||||
application to easily connect to various terminal TTY devices.
|
||||
|
||||
|
||||
2. Usage
|
||||
|
||||
The commandline interface is straightforward as reflected in the output
|
||||
from 'tio --help':
|
||||
|
||||
|
||||
Usage: tio [<options>] <tty device>
|
||||
|
||||
Options:
|
||||
-b, --baudrate <bps> Baud rate (default: 115200)
|
||||
-d, --databits 5|6|7|8 Data bits (default: 8)
|
||||
-f, --flow hard|soft|none Flow control (default: none)
|
||||
-s, --stopbits 1|2 Stop bits (default: 1)
|
||||
-p, --parity even|odd|none Parity (default: none)
|
||||
-o, --output-delay <ms> Output delay (default: 0)
|
||||
-n, --no-autoconnect Disable automatic connect
|
||||
-l, --log <filename> Log to file
|
||||
-m, --map <flags> Map special characters
|
||||
-v, --version Display version
|
||||
-h, --help Display help
|
||||
|
||||
In session, press ctrl-t q to quit.
|
||||
|
||||
|
||||
The only option which requires a bit of elaboration is perhaps the
|
||||
--no-autoconnect option.
|
||||
|
||||
By default tio automatically connects to the provided device if present.
|
||||
If the device is not present, it will wait for it to appear and then
|
||||
connect. If the connection is lost (eg. device is unplugged), it will wait
|
||||
for the device to reappear and then reconnect. However, if the
|
||||
--no-autoconnect option is provided, tio will exit if the device is not
|
||||
present or an established connection is lost.
|
||||
|
||||
Tio features full bash autocompletion support.
|
||||
|
||||
Tio also supports various key commands. Press ctrl-t ? to list the
|
||||
available key commands.
|
||||
|
||||
See the tio man page for more details.
|
||||
|
||||
|
||||
3. Installation
|
||||
|
||||
The latest release version is available at https://tio.github.io
|
||||
|
||||
|
||||
3.1 Installation using release tarball
|
||||
|
||||
Install steps:
|
||||
|
||||
$ ./configure
|
||||
$ make
|
||||
$ make install
|
||||
|
||||
See INSTALL file for more installation details.
|
||||
|
||||
|
||||
3.2 Installation using package
|
||||
|
||||
Tio comes prepackaged for various GNU/Linux distributions. Visit
|
||||
https://tio.github.io for package installation details.
|
||||
|
||||
|
||||
4. Contributing
|
||||
|
||||
Tio is open source. All contributions (bug fixes, doc, ideas, etc.) are
|
||||
welcome. Visit the tio GitHub page to access latest source code, create
|
||||
pull requests, add issues etc..
|
||||
|
||||
GitHub: https://github.com/tio/tio
|
||||
|
||||
Also, if you find this free open source software useful please consider
|
||||
making a donation: https://www.paypal.me/lundmar
|
||||
|
||||
|
||||
5. Support
|
||||
|
||||
Submit bug reports via GitHub: https://github.com/tio/tio/issues
|
||||
|
||||
|
||||
6. Website
|
||||
|
||||
Visit https://tio.github.io
|
||||
|
||||
|
||||
7. License
|
||||
|
||||
Tio is GPLv2+. See COPYING file for license details.
|
||||
|
||||
|
||||
8. Authors
|
||||
|
||||
Created by Martin Lund <martin.lund@keep-it-simple.com>
|
||||
|
||||
See the AUTHORS file for full list of authors.
|
||||
45
README.md
45
README.md
|
|
@ -1,24 +1,20 @@
|
|||
# tio - a simple TTY terminal I/O application
|
||||
# tio - a simple TTY terminal I/O tool
|
||||
|
||||
[](https://travis-ci.org/tio/tio)
|
||||
[](https://build.snapcraft.io/user/tio/tio.snapcraft)
|
||||
|
||||
## 1. Introduction
|
||||
|
||||
tio is a simple TTY terminal application which features a straightforward
|
||||
commandline interface to easily connect to TTY devices for basic input/output.
|
||||
|
||||
It was created because the author needed a simple no-nonsense TTY terminal
|
||||
application to easily connect to various terminal TTY devices.
|
||||
tio is a simple TTY terminal tool which features a straightforward command-line
|
||||
interface to easily connect to TTY devices for basic I/O operations.
|
||||
|
||||
<p align="center">
|
||||
<img src="https://tio.github.io/images/tio-demo.gif">
|
||||
<img src="images/tio-demo.gif">
|
||||
</p>
|
||||
|
||||
|
||||
## 2. Usage
|
||||
|
||||
The commandline interface is straightforward as reflected in the output from
|
||||
The command-line interface is straightforward as reflected in the output from
|
||||
'tio --help':
|
||||
```
|
||||
Usage: tio [<options>] <tty-device>
|
||||
|
|
@ -62,9 +58,23 @@ See the tio man page for more details.
|
|||
|
||||
## 3. Installation
|
||||
|
||||
The latest release version is available at https://tio.github.io
|
||||
### 3.1 Installation using package manager
|
||||
tio comes prepackaged for various GNU/Linux distributions. Please consult your package manager tool to find and install tio.
|
||||
|
||||
### 3.1 Installation using release tarball
|
||||
### 3.2 Installation using snap
|
||||
|
||||
Install latest stable version:
|
||||
```
|
||||
$ snap install tio
|
||||
```
|
||||
Install bleeding edge:
|
||||
```
|
||||
$ snap install tio --edge
|
||||
```
|
||||
|
||||
### 3.3 Installation from source
|
||||
|
||||
The latest source releases can be found [here](https://github.com/tio/tio/releases).
|
||||
|
||||
Install steps:
|
||||
```
|
||||
|
|
@ -74,11 +84,6 @@ Install steps:
|
|||
```
|
||||
See INSTALL file for more installation details.
|
||||
|
||||
### 3.2 Installation using package
|
||||
|
||||
Tio comes prepackaged for various GNU/Linux distributions. Visit
|
||||
https://tio.github.io for package installation details.
|
||||
|
||||
|
||||
## 4. Contributing
|
||||
|
||||
|
|
@ -89,9 +94,9 @@ requests, add issues etc..
|
|||
GitHub: https://github.com/tio/tio
|
||||
|
||||
Also, if you find this free open source software useful please consider making
|
||||
a donation:
|
||||
a donation of your choice:
|
||||
|
||||
[](https://www.paypal.me/lundmar)
|
||||
[](https://www.paypal.me/lundmar)
|
||||
|
||||
|
||||
## 5. Support
|
||||
|
|
@ -101,7 +106,7 @@ Submit bug reports via GitHub: https://github.com/tio/tio/issues
|
|||
|
||||
## 6. Website
|
||||
|
||||
Visit https://tio.github.io
|
||||
Visit [tio.github.io](https://tio.github.io)
|
||||
|
||||
|
||||
## 7. License
|
||||
|
|
@ -113,4 +118,4 @@ Tio is GPLv2+. See COPYING file for license details.
|
|||
|
||||
Created by Martin Lund \<martin.lund@keep-it-simple.com>
|
||||
|
||||
See the AUTHORS file for full list of authors.
|
||||
See the AUTHORS file for full list of contributors.
|
||||
|
|
|
|||
BIN
images/paypal.png
Normal file
BIN
images/paypal.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
BIN
images/tio-demo.gif
Normal file
BIN
images/tio-demo.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 571 KiB |
Loading…
Add table
Add a link
Reference in a new issue