uzix/picocom
1
0
Fork 0
mirror of https://github.com/UzixLS/picocom.git synced 2025-07-18 23:11:18 +03:00
Code Issues Projects Releases Wiki Activity

Doc updates, rebuilt docs

Browse Source 
Mostly typos and some rewording.
This commit is contained in:
Nick Patavalis
2018-04-03 15:07:07 +03:00
parent b86e131c57
commit eb0f53a0c0
5 changed files with 51 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -15,17 +15,11 @@ 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.
many other similar tasks. It can be used in embedded systems, since
its memory footprint is rather small (approximately 40K, when stripped
and minimally configured).
It is ideal for embedded systems since its memory footprint is small
(approximately 40K, when stripped and minimally configured). Apart
from being a handy little tool, *picocom's* source distribution
includes a simple, easy to use, and thoroughly documented
terminal-management library, which could serve other projects as
well. This library hides the termios(3) calls, and provides a less
complex and safer (though certainly less feature-rich) interface.
*picocom* runs and is, primarily, tested on Linux. With no, or with
*Picocom* runs and is primarily tested on Linux. With no, or with
minor, modifications it will run (and most of its features will work)
on any Unix-like system with a reasonably POSIX-compatible termios(3)
interface. Patches to support idiosyncrasies of specific Unix-like
@ -413,18 +407,17 @@ Custom baudrate support gives you the ability to set arbitrary
baudrate values (like 1234, or 42000, etc) to a serial port, provided
that the underlying driver can handle this. Since release 2.0, picocom
can be compiled with custom baudrate support for some systems. Since
release 3.1 picocom is compiled with custom baudrate support enabled
*by default* on some systems (like Linux, kernels > 2.6, on x86 and
x86_64, modern Intel Macs, and some BSDs). In any case, you can
explicitly ask for custom baudrate support to be *enabled* by
compiling picocom like this:
release 3.1 picocom is compiled with support enabled *by default* on
some systems (like Linux, kernels > 2.6, on x86 and x86_64, modern
Intel Macs, and some BSDs). In any case, you can explicitly ask for
support to be *enabled* by compiling picocom like this:
CPPFLAGS=-DUSE_CUSTOM_BAUD make clean
CPPFLAGS=-DUSE_CUSTOM_BAUD make
If custom baudrate support is not available for your system, the
compilation will fail. Similarly, you can ask for custom baudrate
support to be *disabled* by compiling like:
compilation will fail. Similarly, you can ask for support to be
*disabled* by compiling like:
CPPFLAGS=-DNO_CUSTOM_BAUD make clean
CPPFLAGS=-DNO_CUSTOM_BAUD make

22
picocom.1
View File

@ -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-04-03" "Picocom 3.2a" "User Commands"
.nh \" Turn off hyphenation by default.
.SH NAME
.PP
@ -117,7 +117,7 @@ May not be supported on some systems.
.B \f[B]C\-backslash\f[]
Generate a break sequence on the serial line.
A break sequence is usually generated by marking (driving to logical
one) the serial Tx line for an amount of time coresponding to several
one) the serial Tx line for an amount of time corresponding to several
character durations.
.RS
.RE
@ -178,8 +178,8 @@ Toggle local\-echo mode.
.TP
.B \f[B]C\-w\f[]
Write hex.
Picococm prompts the user for a string of hexadecimal values.
Values can be entered with or without delimeters (separators).
Picocom prompts the user for a string of hexadecimal values.
Values can be entered with or without delimiters (separators).
The hexadecimal values are translated to binary and sent to the port,
exactly as if input at the terminal (i.e.
the \f[B]\-\-omap\f[], \f[B]\-\-echo\f[] and \f[B]\-\-emap\f[] options
@ -350,7 +350,7 @@ serial port to it\[aq]s original settings on exit, but it \f[I]will\f[]
clear the modem control lines (typically DTR and RTS) to signal a modem
hangup.
Without the \f[B]\-\-noreset\f[] option (explicitly given, or implied by
extiting with the "Quit" command) \f[B]\-\-hangup\f[] has no effect
exiting with the "Quit" command) \f[B]\-\-hangup\f[] has no effect
(without \f[B]\-\-noreset\f[] picocom always clears the modem control
lines on exit, anyway).
.RS
@ -397,7 +397,7 @@ See \f[B]SENDING AND RECEIVING FILES\f[].
Specifies the input character map (i.e.
special characters to be replaced when read from the serial port).
See \f[B]INPUT, OUTPUT, AND ECHO MAPPING\f[].
(Defaul: Empty)
(Default: Empty)
.RS
.RE
.TP
@ -405,7 +405,7 @@ See \f[B]INPUT, OUTPUT, AND ECHO MAPPING\f[].
Specifies the output character map (i.e.
special characters to be replaced before being written to serial port).
See \f[B]INPUT, OUTPUT, AND ECHO MAPPING\f[].
(Defaul: Empty)
(Default: Empty)
.RS
.RE
.TP
@ -510,9 +510,9 @@ serial port, AND there is nothing to write (send) to the serial port,
AND nothing is read from the standard input (terminal).
If \f[B]\-\-exit\-after\f[] is set to zero, then picocom exits after
opening and configuring the serial port, after sending the init string
(if any, see option \f[B]\-\-initstring\f[]) and imediatelly when it
(if any, see option \f[B]\-\-initstring\f[]) and immediately when it
becomes idle.
When exiting after being idle, picocom drains the O/S serial port ouput
When exiting after being idle, picocom drains the O/S serial port output
buffer (i.e.
waits for data already written to the port to be transmitted) and
observes the \f[B]\-\-noreset\f[] and \f[B]\-\-hangup\f[] options as
@ -532,7 +532,7 @@ its output queue have been transmitted.
.RE
.TP
.B \f[B]\-\-exit\f[] | \f[B]\-X\f[]
Exit picocom immediatelly after opening and configuring the serial port.
Exit picocom immediately after opening and configuring the serial port.
Do \f[I]not\f[] read \f[I]anything\f[] from the standard input or from
the serial port.
When exiting the \f[B]\-\-noreset\f[] and \f[B]\-\-hangup\f[] options
@ -784,7 +784,7 @@ That is, the escape character is seen (default \f[B]C\-a\f[]), followed
by the quit command character (default \f[B]C\-q\f[]).
The behavior in this case is similar to that of the exit command, with
one difference: Picocom behaves as if the \f[B]\-\-noreset\f[] option is
given (regardless if it actualy is, or not).
given (regardless if it actually is, or not).
.IP \[bu] 2
The \f[B]\-\-exit\f[] option is given.
See the documentation of this option for a description of what exactly

18
picocom.1.html
View File

@ -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">v3.2a / 2018-04-03</div></h1>
</div>
<h1 id="name">NAME</h1>
<p>picocom - minimal dumb-terminal emulation program</p>
@ -43,7 +43,7 @@
<dd><p>Toggle the RTS line. If RTS is up, then lower it. If it is down, then raise it. Not supported if the flow control mode is RTS/CTS. May not be supported on some systems.</p>
</dd>
<dt><strong>C-backslash</strong></dt>
<dd><p>Generate a break sequence on the serial line. A break sequence is usually generated by marking (driving to logical one) the serial Tx line for an amount of time coresponding to several character durations.</p>
<dd><p>Generate a break sequence on the serial line. A break sequence is usually generated by marking (driving to logical one) the serial Tx line for an amount of time corresponding to several character durations.</p>
</dd>
<dt><strong>C-b</strong></dt>
<dd><p>Set baudrate. Prompts you to enter a baudrate numerically (in bps) and configures the serial port accordingly.</p>
@ -70,7 +70,7 @@
<dd><p>Toggle local-echo mode.</p>
</dd>
<dt><strong>C-w</strong></dt>
<dd><p>Write hex. Picococm prompts the user for a string of hexadecimal values. Values can be entered with or without delimeters (separators). The hexadecimal values are translated to binary and sent to the port, exactly as if input at the terminal (i.e. the <strong>--omap</strong>, <strong>--echo</strong> and <strong>--emap</strong> options are observed). Example: The following sends the characters &quot;ABCD&quot; to the port.</p>
<dd><p>Write hex. Picocom prompts the user for a string of hexadecimal values. Values can be entered with or without delimiters (separators). The hexadecimal values are translated to binary and sent to the port, exactly as if input at the terminal (i.e. the <strong>--omap</strong>, <strong>--echo</strong> and <strong>--emap</strong> options are observed). Example: The following sends the characters &quot;ABCD&quot; to the port.</p>
<pre><code>C-a C-w
*** hex: 41 4243:44
*** wrote 4 bytes ***</code></pre>
@ -128,7 +128,7 @@
<p>NOTICE: Picocom clears the modem control lines on exit by setting the <em>HUPCL</em> control bit of the respective port. Picocom always sets HUPCL according to the <strong>--noreset</strong> and <strong>--hangup</strong> options. If <strong>--noreset</strong> is given and <strong>--hangup</strong> is not, then HUPCL for the port is cleared and will remain so after exiting picocom. If <strong>--noreset</strong> is <em>not</em> given, or if both <strong>--noreset</strong> and <strong>--hangup</strong> are given, then HUPCL is set for the port and will remain so after exiting picocom. This is true, regardless of the way picocom terminates (command, read zero-bytes from standard input, killed by signal, fatal error, etc), and regardless of the <strong>--noinit</strong> option.</p>
</dd>
<dt><strong>--hangup</strong> | <strong>-u</strong></dt>
<dd><p>If given together with <strong>--noreset</strong>, picocom will not reset the serial port to it's original settings on exit, but it <em>will</em> clear the modem control lines (typically DTR and RTS) to signal a modem hangup. Without the <strong>--noreset</strong> option (explicitly given, or implied by extiting with the &quot;Quit&quot; command) <strong>--hangup</strong> has no effect (without <strong>--noreset</strong> picocom always clears the modem control lines on exit, anyway).</p>
<dd><p>If given together with <strong>--noreset</strong>, picocom will not reset the serial port to it's original settings on exit, but it <em>will</em> clear the modem control lines (typically DTR and RTS) to signal a modem hangup. Without the <strong>--noreset</strong> option (explicitly given, or implied by exiting with the &quot;Quit&quot; command) <strong>--hangup</strong> has no effect (without <strong>--noreset</strong> picocom always clears the modem control lines on exit, anyway).</p>
</dd>
<dt><strong>--nolock</strong> | <strong>-l</strong></dt>
<dd><p>If given, picocom will <em>not</em> attempt to lock the serial port before opening it. Normally, depending on how it's compiled, picocom attempts to get a UUCP-style lock-file (e.g. '/var/lock/LCK..ttyS0') before opening the port, or attempts to lock the port device-node using <strong>flock(2)</strong>. Failing to do so, results in the program exiting after emitting an error-message. It is possible that your picocom binary is compiled without support for locking. In this case the <strong>--nolock</strong> option is accepted, but has no effect. (Default: Disabled)</p>
@ -140,10 +140,10 @@
<dd><p>Specifies the external program (and any arguments to it) that will be used for receiving files. If the argument to <strong>--receive-cmd</strong> is the empty string (''), the receive-file command is disabled. See <strong><a href="#sending-and-receiving-files">SENDING AND RECEIVING FILES</a></strong>. (Default: <strong>rz -vv</strong>)</p>
</dd>
<dt><strong>--imap</strong></dt>
<dd><p>Specifies the input character map (i.e. special characters to be replaced when read from the serial port). See <strong><a href="#input-output-and-echo-mapping">INPUT, OUTPUT, AND ECHO MAPPING</a></strong>. (Defaul: Empty)</p>
<dd><p>Specifies the input character map (i.e. special characters to be replaced when read from the serial port). See <strong><a href="#input-output-and-echo-mapping">INPUT, OUTPUT, AND ECHO MAPPING</a></strong>. (Default: Empty)</p>
</dd>
<dt><strong>--omap</strong></dt>
<dd><p>Specifies the output character map (i.e. special characters to be replaced before being written to serial port). See <strong><a href="#input-output-and-echo-mapping">INPUT, OUTPUT, AND ECHO MAPPING</a></strong>. (Defaul: Empty)</p>
<dd><p>Specifies the output character map (i.e. special characters to be replaced before being written to serial port). See <strong><a href="#input-output-and-echo-mapping">INPUT, OUTPUT, AND ECHO MAPPING</a></strong>. (Default: Empty)</p>
</dd>
<dt><strong>--emap</strong></dt>
<dd><p>Specifies the local-echo character map (i.e. special characters to be replaced before being echoed-back to the terminal, if local-echo is enabled). See <strong><a href="#input-output-and-echo-mapping">INPUT, OUTPUT, AND ECHO MAPPING</a></strong>. (Defaul: <strong>delbs,crcrlf</strong>)</p>
@ -173,11 +173,11 @@
<p>If neither <strong>--raise-dtr</strong> nor <strong>--lower-dtr</strong> are given, the state of the DTR signal, after opening and configuring the port, is system dependent. On most systems the signal is raised.</p>
</dd>
<dt><strong>--exit-aftrer</strong> | <strong>-x</strong></dt>
<dd><p>Exit picocom if it remains idle for the specified time (in milliseconds). Picocom is considered idle if: Nothing is read (received) from the serial port, AND there is nothing to write (send) to the serial port, AND nothing is read from the standard input (terminal). If <strong>--exit-after</strong> is set to zero, then picocom exits after opening and configuring the serial port, after sending the init string (if any, see option <strong>--initstring</strong>) and imediatelly when it becomes idle. When exiting after being idle, picocom drains the O/S serial port ouput buffer (i.e. waits for data already written to the port to be transmitted) and observes the <strong>--noreset</strong> and <strong>--hangup</strong> options as usual. (Default: not set).</p>
<dd><p>Exit picocom if it remains idle for the specified time (in milliseconds). Picocom is considered idle if: Nothing is read (received) from the serial port, AND there is nothing to write (send) to the serial port, AND nothing is read from the standard input (terminal). If <strong>--exit-after</strong> is set to zero, then picocom exits after opening and configuring the serial port, after sending the init string (if any, see option <strong>--initstring</strong>) and immediately when it becomes idle. When exiting after being idle, picocom drains the O/S serial port output buffer (i.e. waits for data already written to the port to be transmitted) and observes the <strong>--noreset</strong> and <strong>--hangup</strong> options as usual. (Default: not set).</p>
<p>NOTICE: If <strong>--exit-after</strong> is set, reading zero bytes from the standard input (which usually means that whatever was connected there has been closed), will <em>not</em> cause picocom to exit. Instead, picocom will keep running, <em>without</em> reading from stdin, and will exit only when it becomes idle for the specified time, or if it is killed by a signal. If <strong>--exit-after</strong> is <em>not</em> set, then reading zero bytes from the standard input causes picocom to exit, after the contents of its output queue have been transmitted.</p>
</dd>
<dt><strong>--exit</strong> | <strong>-X</strong></dt>
<dd><p>Exit picocom immediatelly after opening and configuring the serial port. Do <em>not</em> read <em>anything</em> from the standard input or from the serial port. When exiting the <strong>--noreset</strong> and <strong>--hangup</strong> options are observed as usual. With <strong>--exit</strong> and <strong>--noreset</strong> (and possibly <strong>--hangup</strong>) picocom can be used as a very crude replacement of <strong>stty(1)</strong>. If an init string is also given (see <strong>--initstring</strong> option), picocom exits imediatelly after sending (writing) the init string to the serial port and draining the O/S serial port output buffer (i.e. waiting for data written to the port to be transmitted). Again, nothing is read from the standard input, or from the serial port. The <strong>--exit</strong> option, overrides the <strong>--exit-after</strong> option. (Default: Disabled)</p>
<dd><p>Exit picocom immediately after opening and configuring the serial port. Do <em>not</em> read <em>anything</em> from the standard input or from the serial port. When exiting the <strong>--noreset</strong> and <strong>--hangup</strong> options are observed as usual. With <strong>--exit</strong> and <strong>--noreset</strong> (and possibly <strong>--hangup</strong>) picocom can be used as a very crude replacement of <strong>stty(1)</strong>. If an init string is also given (see <strong>--initstring</strong> option), picocom exits imediatelly after sending (writing) the init string to the serial port and draining the O/S serial port output buffer (i.e. waiting for data written to the port to be transmitted). Again, nothing is read from the standard input, or from the serial port. The <strong>--exit</strong> option, overrides the <strong>--exit-after</strong> option. (Default: Disabled)</p>
</dd>
<dt><strong>--quiet</strong> | <strong>-q</strong></dt>
<dd><p>Forces picocom to be quiet. Suppresses the output of the initial status and options information, as well as any other information or messages not explicitly requested by the user. Responses to user commands and any error or warning messages are still printed.</p>
@ -243,7 +243,7 @@
<p>This section summarizes the conditions in which picocom terminates its operation and what happens in each such condition:</p>
<ul>
<li><p>The exit command is seen in the standard input. That is, the escape character is seen (default <strong>C-a</strong>), followed by the exit command character (default <strong>C-x</strong>). In this case: The contents of the output queue (data read from the standard input, but not yet written to the port) as well as the contents of the O/S serial port output buffer (data already written to the port, but not yet transmitted) are discarded (flushed). Then the serial port is reset to it's original settings, and the modem-control lines are cleared signaling a modem reset, subject to the <strong>--noreset</strong> and the <strong>--hangup</strong> options. After that picocom exits with a success status.</p></li>
<li><p>The quit command is seen in the standard input. That is, the escape character is seen (default <strong>C-a</strong>), followed by the quit command character (default <strong>C-q</strong>). The behavior in this case is similar to that of the exit command, with one difference: Picocom behaves as if the <strong>--noreset</strong> option is given (regardless if it actualy is, or not).</p></li>
<li><p>The quit command is seen in the standard input. That is, the escape character is seen (default <strong>C-a</strong>), followed by the quit command character (default <strong>C-q</strong>). The behavior in this case is similar to that of the exit command, with one difference: Picocom behaves as if the <strong>--noreset</strong> option is given (regardless if it actually is, or not).</p></li>
<li><p>The <strong>--exit</strong> option is given. See the documentation of this option for a description of what exactly happens in this case. Picocom exits with a success exit status.</p></li>
<li><p>The <strong>--exit-after</strong> option is given. See the documentation of this option for a description of what exactly happens in this case. Picocom exits with a success exit status.</p></li>
<li><p>Zero bytes are read from the standard input. This usually means that whatever was connected to picocom's standard input has been closed or, if a file was connected, then picocom has read up to the end of the file. In this case, if the <strong>--exit-after</strong> option is <em>not</em> given, picocom stops reading from the standard input, and keeps operating normally (i.e. writing to, and reading from, the serial port) until its output queue empties. When this happens, picocom waits for the O/S serial port output buffer to drain and then (subject to the <strong>--noreset</strong> and <strong>--hangup</strong> options) resets the serial port to it's initial settings, clears the modem-control lines, and exits. If the <strong>--exit-after</strong> option is given then, again, picocom stops reading from the standard input and continues operating normally but, in this case, it does so until it becomes idle for the specified amount of time, before exiting. Picocom exits with a success exit status.</p></li>

43
picocom.1.md
View File

@ -103,7 +103,7 @@ here.
: Generate a break sequence on the serial line. A break sequence is
usually generated by marking (driving to logical one) the serial
Tx line for an amount of time coresponding to several character
Tx line for an amount of time corresponding to several character
durations.
**C-b**
@ -150,8 +150,8 @@ here.
**C-w**
: Write hex. Picococm prompts the user for a string of hexadecimal
values. Values can be entered with or without delimeters
: Write hex. Picocom prompts the user for a string of hexadecimal
values. Values can be entered with or without delimiters
(separators). The hexadecimal values are translated to binary and
sent to the port, exactly as if input at the terminal (i.e. the
**--omap**, **--echo** and **--emap** options are
@ -288,7 +288,7 @@ Picocom accepts the following command-line options.
serial port to it's original settings on exit, but it *will* clear
the modem control lines (typically DTR and RTS) to signal a modem
hangup. Without the **--noreset** option (explicitly given, or
implied by extiting with the "Quit" command) **--hangup** has no
implied by exiting with the "Quit" command) **--hangup** has no
effect (without **--noreset** picocom always clears the modem
control lines on exit, anyway).
@ -323,13 +323,13 @@ Picocom accepts the following command-line options.
: Specifies the input character map (i.e. special characters to be
replaced when read from the serial port). See
**[INPUT, OUTPUT, AND ECHO MAPPING]**. (Defaul: Empty)
**[INPUT, OUTPUT, AND ECHO MAPPING]**. (Default: Empty)
**--omap**
: Specifies the output character map (i.e. special characters to be
replaced before being written to serial port). See
**[INPUT, OUTPUT, AND ECHO MAPPING]**. (Defaul: Empty)
**[INPUT, OUTPUT, AND ECHO MAPPING]**. (Default: Empty)
**--emap**
@ -413,8 +413,8 @@ Picocom accepts the following command-line options.
input (terminal). If **--exit-after** is set to zero, then picocom
exits after opening and configuring the serial port, after sending
the init string (if any, see option **--initstring**) and
imediatelly when it becomes idle. When exiting after being idle,
picocom drains the O/S serial port ouput buffer (i.e. waits for
immediately when it becomes idle. When exiting after being idle,
picocom drains the O/S serial port output buffer (i.e. waits for
data already written to the port to be transmitted) and observes
the **--noreset** and **--hangup** options as usual. (Default: not
set).
@ -430,19 +430,18 @@ Picocom accepts the following command-line options.
**--exit** | **-X**
: Exit picocom immediatelly after opening and configuring the
serial port. Do *not* read *anything* from the standard input or
from the serial port. When exiting the **--noreset** and
**--hangup** options are observed as usual. With **--exit** and
**--noreset** (and possibly **--hangup**) picocom can be used as
a very crude replacement of **stty(1)**. If an init string is
also given (see **--initstring** option), picocom exits
imediatelly after sending (writing) the init string to the serial
port and draining the O/S serial port output buffer (i.e. waiting
for data written to the port to be transmitted). Again, nothing
is read from the standard input, or from the serial port. The
**--exit** option, overrides the **--exit-after**
option. (Default: Disabled)
: Exit picocom immediately after opening and configuring the serial
port. Do *not* read *anything* from the standard input or from
the serial port. When exiting the **--noreset** and **--hangup**
options are observed as usual. With **--exit** and **--noreset**
(and possibly **--hangup**) picocom can be used as a very crude
replacement of **stty(1)**. If an init string is also given (see
**--initstring** option), picocom exits imediatelly after sending
(writing) the init string to the serial port and draining the O/S
serial port output buffer (i.e. waiting for data written to the
port to be transmitted). Again, nothing is read from the standard
input, or from the serial port. The **--exit** option, overrides
the **--exit-after** option. (Default: Disabled)
**--quiet** | **-q**
@ -622,7 +621,7 @@ operation and what happens in each such condition:
character is seen (default **C-a**), followed by the quit command
character (default **C-q**). The behavior in this case is similar to
that of the exit command, with one difference: Picocom behaves as if
the **--noreset** option is given (regardless if it actualy is, or
the **--noreset** option is given (regardless if it actually is, or
not).
- The **--exit** option is given. See the documentation of this option

BIN
picocom.1.pdf
View File

Binary file not shown.