STERM(1)

NAME
sterm - a minimal serial terminal that focus on being easy to use. A client simply works.

SYNOPSIS
sterm [-h | --help] [-u | --unbuffered] [--escape character] [--binary] [-b baudrate | --baudrate baudrate] [-f format | --format format] device

DESCRIPTION
sterm is a minimal serial terminal that focus on being easy to use and not sucking. - This client simply works.
It has inline input and supports Unicode (utf-8). It writes whatever it receives to stdout so that also ANSI escape sequences work as expected.
With the --binary option, the received data will be output byte wise as hexadecimal numbers. Ideal for debugging.
sterm has some internal commands, listed below. To enter a command you first have to enter an escape character. Entering the escape character (see --escape) starts a command input. If this command is known it gets executed. If the command is unknown the input gets rejected in unbuffered mode, and send to the remote terminal in buffered mode. When entering the escape character a second time in unbuffered mode, the escape character gets send to the remove client.

OPTIONS

-h, --help
    Display a help, version number and exit

--binary
    Print hexadecimal values instead of Unicode characters. (Only applied on output, input will still be UTF-8)

-u, --unbuffered
    Use this flag to avoid input buffering. By default, sterm reads a whole line, and then sends all data at once. When this flag is set, each character gets send directly, except when entering the escape key. Then you can enter a command that sterm handles internal. In unbuffered mode, the input gets not echoed by sterm.

--escape character
    With this parameter, the escape character can be changed. By default, it is the escape key ("\e").

-b baudrate, --baudrate baudrate
    Define the baudrate used for receiving and transmitting.
    Default: 115200 baud.

-f format, --format format
    Configuration-triple: xyz with x = byte length in bits {5,6,7,8}; y = parity {N,E,O}; z = stop bits {1,2}.
    Default: "8N1" - 8 data bits, no parity bits and 1 stop bit.

-w logfile, --write logfile
    Write received data into a log file. ANSI Escape sequences will also be written into the file. In binary mode (--binary) binary data gets written into the file. Otherwise the data is UTF-8 encoded.

device
    Serial I/O device to access

EXIT STATUS

0   Everything OK

1   On error

INTERNAL COMMANDS

exit
    Close sterm

version
    Show the version of sterm

EXAMPLES
sterm /dev/ttyUART0
Connect to UART device with 115200 baud, 8 data bits, 1 stop bit and no parity bit (8N1)

sterm --binary -b 9600 -f 7E2 /dev/ttyS0
Connect with 9600 baud, 7 data bits, 2 stop bits and even parity:

AUTHOR
Written by Ralf Stemmer <ralf.stemmer@gmx.net>

REPORTING BUGS
GitHub: <https://github.com/rstemmer/sterm/issues>

COPYRIGHT
sterm Copyright (C) 2013-2019 Ralf Stemmer <ralf.stemmer@gmx.net>
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
This program comes with ABSOLUTELY NO WARRANTY
This is free software, and you are welcome to redistribute it under certain conditions.

SEE ALSO
Full documentation at: <https://github.com/rstemmer/sterm>