mirror of
https://github.com/UzixLS/picocom.git
synced 2025-07-19 07:21:18 +03:00
Updated manual and rebuild docs
This commit is contained in:
Nick Patavalis
83
picocom.1
83
picocom.1
@ -1,7 +1,7 @@
|
||||
.\" Automatically generated by Pandoc 1.16.0.2
|
||||
.\"
|
||||
.ad l
|
||||
.TH "PICOCOM" "1" "2018-02-08" "Picocom 3.2a" "User Commands"
|
||||
.TH "PICOCOM" "1" "2018-02-28" "Picocom 4.0a" "User Commands"
|
||||
.nh \" Turn off hyphenation by default.
|
||||
.SH NAME
|
||||
.PP
|
||||
@ -30,9 +30,14 @@ xterm, rxvt, system console, etc).
|
||||
When picocom starts it opens the tty (serial port) given as its
|
||||
non\-option argument (or the \f[I]last\f[] non\-option argument, if
|
||||
multiple are given).
|
||||
Unless the \f[B]\-\-noinit\f[] option is given, it configures the port
|
||||
to the settings specified by the option\-arguments (or to some default
|
||||
settings), and sets it to "raw" mode.
|
||||
The serial port is usually given as a device\-node path (e.g.
|
||||
\f[I]/dev/ttyXX\f[]).
|
||||
If RFC2217 support is compiled in, the port may instead be specified as
|
||||
an RFC2217 service name, if the \f[B]\-\-telnet\f[] option is also given
|
||||
(for more see \f[B]TELNET AND RFC2217 SUPPORT\f[]).
|
||||
Unless the \f[B]\-\-noinit\f[] option is given, picocom configures the
|
||||
port to the settings specified by the option\-arguments (or to some
|
||||
default settings), and sets it to "raw" mode.
|
||||
If \f[B]\-\-noinit\f[] is given, the initialization and configuration is
|
||||
skipped; the port is just opened.
|
||||
Following this, if standard input is a tty, picocom sets the tty to raw
|
||||
@ -567,6 +572,14 @@ Picocom\[aq]s version, compile\-time options, and enabled features are
|
||||
also shown.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[B]\-\-telnet\f[] | \f[B]\-T\f[]
|
||||
Interpret the \f[I]device\f[] non\-option argument as the name of an RFC
|
||||
2217 service, with an optional port: \f[I]hostname\f[][,\f[I]port\f[]].
|
||||
This option may not be supported on all picocom builds.
|
||||
For more see \f[B]TELNET AND RFC2217 SUPPORT\f[].
|
||||
.RS
|
||||
.RE
|
||||
.SH DISPLAY OF OPTIONS AND PORT SETTINGS
|
||||
.PP
|
||||
The "show program options" command (\f[B]C\-v\f[]), as well as the
|
||||
@ -762,6 +775,68 @@ with DEL.
|
||||
.IP \[bu] 2
|
||||
Replace every CR character with CR and LF when echoing to the terminal
|
||||
(if local\-echo is enabled).
|
||||
.SH TELNET AND RFC2217 SUPPORT
|
||||
.PP
|
||||
Picocom can be compiled with Telnet and RFC2217 support.
|
||||
This facilitates accessing remote ports through TCP connections using
|
||||
the Telnet protocol, and configuring and controling them (e.g.
|
||||
changing their settings or the status of the modem\-control lines) using
|
||||
the COMPORT protocol option described in RFC2217.
|
||||
To test if support for Telnet and RFC2217 has been compiled\-in your
|
||||
picocom binary, run with \f[B]\-\-help\f[] and observe the first few
|
||||
lines of output.
|
||||
The use of a remote port is specified like this:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
picocom\ \-\-telnet\ \-\-baud\ 9600\ host,8888
|
||||
\f[]
|
||||
.fi
|
||||
.PP
|
||||
for more see the \f[B]\-\-telnet\f[] option.
|
||||
When picocom is used with a remote port its behavior is, for the most
|
||||
part, the same as if the port was local, with the following limitations
|
||||
and differences:
|
||||
.IP \[bu] 2
|
||||
You cannot use the \f[B]C\-s\f[] (send file) and \f[B]C\-r\f[] (received
|
||||
file) commands.
|
||||
This is a known limitation that may be fixed in the future.
|
||||
.IP \[bu] 2
|
||||
The \f[B]\-\-noreset\f[] and \f[B]\-\-hangup\f[] options, are
|
||||
meaningless and, therefore, not allowed.
|
||||
Whether the remote port will be reset to its original settings when
|
||||
picocom terminates (and disconnects from it), and whether the modem
|
||||
control lines will be reset, is something controlled by the remote
|
||||
access server.
|
||||
Some servers reset their ports when the client disconnects, other
|
||||
don\[aq]t, other are per\-port configurable.
|
||||
RFC2217, indicates that a server \f[I]should\f[] reset and hangup its
|
||||
port when the client disconnects.
|
||||
Similarly the \f[B]C\-x\f[] (Exit) and \f[B]C\-q\f[] (Quit) commands, do
|
||||
the same thing.
|
||||
.IP \[bu] 2
|
||||
The \f[B]\-\-noinit\f[] option works as expected.
|
||||
Actually, by running picocom with \f[B]\-\-noinit\f[] you can connect to
|
||||
port servers that do not support the COMPORT (RFC2217) remote port
|
||||
configuration option, but only support plain Telnet.
|
||||
Without the \f[B]\-\-noinit\f[] option this is not possible, for obvious
|
||||
reasons.
|
||||
When picocom is run without \f[B]\-\-noinit\f[] it first configures the
|
||||
remote port to the requested settings (given in the command\-line or the
|
||||
picocom defaults) and then starts reading and writing to or from it.
|
||||
Any data received from the port, before it has been configured are
|
||||
discarded.
|
||||
If picocom is run with \f[B]\-\-noinit\f[] then it immediately starts
|
||||
reading and writing data to and from the remote port (as the port is
|
||||
assumed already configured).
|
||||
.IP \[bu] 2
|
||||
Interactive commands that change the port\[aq]s settings or change the
|
||||
status of the modem\-control lines, are executed in an asynchronous
|
||||
manner, which may be a bit confusing.
|
||||
That is, you may not get an immediate indication of a command\[aq]s
|
||||
failure to affect the port, but the \f[I]true\f[] status of the port
|
||||
\f[I]will\f[] be updated (it a short while) and you \f[I]can\f[] verify
|
||||
it using the \f[B]C\-v\f[] (show port settings) command.
|
||||
.SH EXITING PICOCOM
|
||||
.PP
|
||||
This section summarizes the conditions in which picocom terminates its
|
||||
|
||||
@ -11,7 +11,7 @@
|
||||
</head>
|
||||
<body>
|
||||
<div id="header">
|
||||
<h1 class="title"><div id="pgname">PICOCOM(1)</div><div id="version">v3.2a / 2018-02-08</div></h1>
|
||||
<h1 class="title"><div id="pgname">PICOCOM(1)</div><div id="version">v4.0a / 2018-02-28</div></h1>
|
||||
</div>
|
||||
<h1 id="name">NAME</h1>
|
||||
<p>picocom - minimal dumb-terminal emulation program</p>
|
||||
@ -20,7 +20,7 @@
|
||||
<h1 id="description">DESCRIPTION</h1>
|
||||
<p>As its name suggests, <strong>picocom(1)</strong> is a minimal dumb-terminal emulation program. It is, in principle, very much like <strong>minicom(1)</strong>, only it's "pico" instead of "mini"! It was designed to serve as a simple, manual, modem configuration, testing, and debugging tool. It has also served (quite well) as a low-tech serial communications program to allow access to all types of devices that provide serial consoles. It could also prove useful in many other similar tasks.</p>
|
||||
<p>In effect, picocom is not an "emulator" per-se. It is a simple program that opens, configures, manages a serial port (tty device) and its settings, and connects to it the terminal emulator you are, most likely, already using (the terminal window application, xterm, rxvt, system console, etc).</p>
|
||||
<p>When picocom starts it opens the tty (serial port) given as its non-option argument (or the <em>last</em> non-option argument, if multiple are given). Unless the <strong>--noinit</strong> option is given, it configures the port to the settings specified by the option-arguments (or to some default settings), and sets it to "raw" mode. If <strong>--noinit</strong> is given, the initialization and configuration is skipped; the port is just opened. Following this, if standard input is a tty, picocom sets the tty to raw mode. Then it goes in a loop where it listens for input from stdin, or from the serial port. Input from the serial port is copied to the standard output while input from the standard input is copied to the serial port. Picocom also scans its input stream for a user-specified control character, called the <em>escape character</em> (being by default <strong>C-a</strong>). If the escape character is seen, then instead of sending it to the serial-device, the program enters "command mode" and waits for the next character (which is called the "function character"). Depending on the value of the function character, picocom performs one of the operations described in the <strong><a href="#commands">COMMANDS</a></strong> section below.</p>
|
||||
<p>When picocom starts it opens the tty (serial port) given as its non-option argument (or the <em>last</em> non-option argument, if multiple are given). The serial port is usually given as a device-node path (e.g. <em>/dev/ttyXX</em>). If RFC2217 support is compiled in, the port may instead be specified as an RFC2217 service name, if the <strong>--telnet</strong> option is also given (for more see <strong><a href="#telnet-and-rfc2217-support">TELNET AND RFC2217 SUPPORT</a></strong>). Unless the <strong>--noinit</strong> option is given, picocom configures the port to the settings specified by the option-arguments (or to some default settings), and sets it to "raw" mode. If <strong>--noinit</strong> is given, the initialization and configuration is skipped; the port is just opened. Following this, if standard input is a tty, picocom sets the tty to raw mode. Then it goes in a loop where it listens for input from stdin, or from the serial port. Input from the serial port is copied to the standard output while input from the standard input is copied to the serial port. Picocom also scans its input stream for a user-specified control character, called the <em>escape character</em> (being by default <strong>C-a</strong>). If the escape character is seen, then instead of sending it to the serial-device, the program enters "command mode" and waits for the next character (which is called the "function character"). Depending on the value of the function character, picocom performs one of the operations described in the <strong><a href="#commands">COMMANDS</a></strong> section below.</p>
|
||||
<h1 id="commands">COMMANDS</h1>
|
||||
<p>Commands are given to picocom by first keying the <em>espace character</em> which by default is <strong>C-a</strong> (see <strong><a href="#options">OPTIONS</a></strong> below for how to change it), and then keying one of the function (command) characters shown here.</p>
|
||||
<dl>
|
||||
@ -185,6 +185,9 @@
|
||||
<dt><strong>--help</strong> | <strong>-h</strong></dt>
|
||||
<dd><p>Print a short help message describing the command-line options. Picocom's version, compile-time options, and enabled features are also shown.</p>
|
||||
</dd>
|
||||
<dt><strong>--telnet</strong> | <strong>-T</strong></dt>
|
||||
<dd><p>Interpret the <em>device</em> non-option argument as the name of an RFC 2217 service, with an optional port: <em>hostname</em>[,<em>port</em>]. This option may not be supported on all picocom builds. For more see <strong><a href="#telnet-and-rfc2217-support">TELNET AND RFC2217 SUPPORT</a></strong>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<h1 id="display-of-options-and-port-settings">DISPLAY OF OPTIONS AND PORT SETTINGS</h1>
|
||||
<p>The "show program options" command (<strong>C-v</strong>), as well as the commands that change program options (<strong>C-b</strong>, <strong>C-u</strong>, <strong>C-d</strong>, <strong>C-f</strong>, etc) print messages showing the current values (or the new values, if they were changed) for the respective options. If picocom determines that an actual serial-port setting differs from the current value of the respective option (for whatever reason), then the value of the option is shown followed by the value of the actual serial-port setting in parenthesis. Example:</p>
|
||||
@ -239,6 +242,16 @@
|
||||
<li><p>Ignore (not write to the terminal) every LF character read from the serial port, and replace every BS character read from the serial port with DEL.</p></li>
|
||||
<li><p>Replace every CR character with CR and LF when echoing to the terminal (if local-echo is enabled).</p></li>
|
||||
</ul>
|
||||
<h1 id="telnet-and-rfc2217-support">TELNET AND RFC2217 SUPPORT</h1>
|
||||
<p>Picocom can be compiled with Telnet and RFC2217 support. This facilitates accessing remote ports through TCP connections using the Telnet protocol, and configuring and controling them (e.g. changing their settings or the status of the modem-control lines) using the COMPORT protocol option described in RFC2217. To test if support for Telnet and RFC2217 has been compiled-in your picocom binary, run with <strong>--help</strong> and observe the first few lines of output. The use of a remote port is specified like this:</p>
|
||||
<pre><code>picocom --telnet --baud 9600 host,8888</code></pre>
|
||||
<p>for more see the <strong>--telnet</strong> option. When picocom is used with a remote port its behavior is, for the most part, the same as if the port was local, with the following limitations and differences:</p>
|
||||
<ul>
|
||||
<li><p>You cannot use the <strong>C-s</strong> (send file) and <strong>C-r</strong> (received file) commands. This is a known limitation that may be fixed in the future.</p></li>
|
||||
<li><p>The <strong>--noreset</strong> and <strong>--hangup</strong> options, are meaningless and, therefore, not allowed. Whether the remote port will be reset to its original settings when picocom terminates (and disconnects from it), and whether the modem control lines will be reset, is something controlled by the remote access server. Some servers reset their ports when the client disconnects, other don't, other are per-port configurable. RFC2217, indicates that a server <em>should</em> reset and hangup its port when the client disconnects. Similarly the <strong>C-x</strong> (Exit) and <strong>C-q</strong> (Quit) commands, do the same thing.</p></li>
|
||||
<li><p>The <strong>--noinit</strong> option works as expected. Actually, by running picocom with <strong>--noinit</strong> you can connect to port servers that do not support the COMPORT (RFC2217) remote port configuration option, but only support plain Telnet. Without the <strong>--noinit</strong> option this is not possible, for obvious reasons. When picocom is run without <strong>--noinit</strong> it first configures the remote port to the requested settings (given in the command-line or the picocom defaults) and then starts reading and writing to or from it. Any data received from the port, before it has been configured are discarded. If picocom is run with <strong>--noinit</strong> then it immediately starts reading and writing data to and from the remote port (as the port is assumed already configured).</p></li>
|
||||
<li><p>Interactive commands that change the port's settings or change the status of the modem-control lines, are executed in an asynchronous manner, which may be a bit confusing. That is, you may not get an immediate indication of a command's failure to affect the port, but the <em>true</em> status of the port <em>will</em> be updated (it a short while) and you <em>can</em> verify it using the <strong>C-v</strong> (show port settings) command.</p></li>
|
||||
</ul>
|
||||
<h1 id="exiting-picocom">EXITING PICOCOM</h1>
|
||||
<p>This section summarizes the conditions in which picocom terminates its operation and what happens in each such condition:</p>
|
||||
<ul>
|
||||
|
||||
75
picocom.1.md
75
picocom.1.md
@ -35,16 +35,17 @@ non-option argument (or the *last* non-option argument, if multiple
|
||||
are given). The serial port is usually given as a device-node path
|
||||
(e.g. */dev/ttyXX*). If RFC2217 support is compiled in, the port may
|
||||
instead be specified as an RFC2217 service name, if the **--telnet**
|
||||
option is also given. Unless the **--noinit** option is given, picocom
|
||||
configures the port to the settings specified by the option-arguments
|
||||
(or to some default settings), and sets it to "raw" mode. If
|
||||
**--noinit** is given, the initialization and configuration is
|
||||
skipped; the port is just opened. Following this, if standard input is
|
||||
a tty, picocom sets the tty to raw mode. Then it goes in a loop where
|
||||
it listens for input from stdin, or from the serial port. Input from
|
||||
the serial port is copied to the standard output while input from the
|
||||
standard input is copied to the serial port. Picocom also scans its
|
||||
input stream for a user-specified control character, called the
|
||||
option is also given (for more see
|
||||
**[TELNET AND RFC2217 SUPPORT]**). Unless the **--noinit** option is
|
||||
given, picocom configures the port to the settings specified by the
|
||||
option-arguments (or to some default settings), and sets it to "raw"
|
||||
mode. If **--noinit** is given, the initialization and configuration
|
||||
is skipped; the port is just opened. Following this, if standard input
|
||||
is a tty, picocom sets the tty to raw mode. Then it goes in a loop
|
||||
where it listens for input from stdin, or from the serial port. Input
|
||||
from the serial port is copied to the standard output while input from
|
||||
the standard input is copied to the serial port. Picocom also scans
|
||||
its input stream for a user-specified control character, called the
|
||||
_escape character_ (being by default **C-a**). If the escape character
|
||||
is seen, then instead of sending it to the serial-device, the program
|
||||
enters "command mode" and waits for the next character (which is
|
||||
@ -464,7 +465,8 @@ Picocom accepts the following command-line options.
|
||||
|
||||
: Interpret the _device_ non-option argument as the name of an RFC
|
||||
2217 service, with an optional port: _hostname_[,_port_]. This
|
||||
option may not be supported on all picocom builds.
|
||||
option may not be supported on all picocom builds. For more see
|
||||
**[TELNET AND RFC2217 SUPPORT]**.
|
||||
|
||||
|
||||
# DISPLAY OF OPTIONS AND PORT SETTINGS
|
||||
@ -610,6 +612,57 @@ will:
|
||||
- Replace every CR character with CR and LF when echoing to the
|
||||
terminal (if local-echo is enabled).
|
||||
|
||||
# TELNET AND RFC2217 SUPPORT
|
||||
|
||||
Picocom can be compiled with Telnet and RFC2217 support. This
|
||||
facilitates accessing remote ports through TCP connections using the
|
||||
Telnet protocol, and configuring and controling them (e.g. changing
|
||||
their settings or the status of the modem-control lines) using the
|
||||
COMPORT protocol option described in RFC2217. To test if support for
|
||||
Telnet and RFC2217 has been compiled-in your picocom binary, run with
|
||||
**--help** and observe the first few lines of output. The use of a
|
||||
remote port is specified like this:
|
||||
|
||||
picocom --telnet --baud 9600 host,8888
|
||||
|
||||
for more see the **--telnet** option. When picocom is used with a
|
||||
remote port its behavior is, for the most part, the same as if the
|
||||
port was local, with the following limitations and differences:
|
||||
|
||||
- You cannot use the **C-s** (send file) and **C-r** (received file)
|
||||
commands. This is a known limitation that may be fixed in the
|
||||
future.
|
||||
|
||||
- The **--noreset** and **--hangup** options, are meaningless and,
|
||||
therefore, not allowed. Whether the remote port will be reset to its
|
||||
original settings when picocom terminates (and disconnects from it),
|
||||
and whether the modem control lines will be reset, is something
|
||||
controlled by the remote access server. Some servers reset their
|
||||
ports when the client disconnects, other don't, other are per-port
|
||||
configurable. RFC2217, indicates that a server *should* reset and
|
||||
hangup its port when the client disconnects. Similarly the **C-x**
|
||||
(Exit) and **C-q** (Quit) commands, do the same thing.
|
||||
|
||||
- The **--noinit** option works as expected. Actually, by running
|
||||
picocom with **--noinit** you can connect to port servers that do
|
||||
not support the COMPORT (RFC2217) remote port configuration option,
|
||||
but only support plain Telnet. Without the **--noinit** option this
|
||||
is not possible, for obvious reasons. When picocom is run without
|
||||
**--noinit** it first configures the remote port to the requested
|
||||
settings (given in the command-line or the picocom defaults) and
|
||||
then starts reading and writing to or from it. Any data received
|
||||
from the port, before it has been configured are discarded. If
|
||||
picocom is run with **--noinit** then it immediately starts reading
|
||||
and writing data to and from the remote port (as the port is assumed
|
||||
already configured).
|
||||
|
||||
- Interactive commands that change the port's settings or change the
|
||||
status of the modem-control lines, are executed in an asynchronous
|
||||
manner, which may be a bit confusing. That is, you may not get an
|
||||
immediate indication of a command's failure to affect the port, but
|
||||
the *true* status of the port *will* be updated (it a short while)
|
||||
and you *can* verify it using the **C-v** (show port settings)
|
||||
command.
|
||||
|
||||
# EXITING PICOCOM
|
||||
|
||||
|
||||
BIN
picocom.1.pdf
BIN
picocom.1.pdf
Binary file not shown.
Reference in New Issue
Block a user