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

Updated manual and regenerated docs

Browse Source
This commit is contained in:
Nick Patavalis
2017-12-23 13:20:42 +02:00
parent 77e684f5ce
commit 9bbb25c5cc
4 changed files with 86 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
picocom.1
View File

@ -1,7 +1,7 @@
.\" Automatically generated by Pandoc 1.16.0.2
.\"
.ad l
.TH "PICOCOM" "1" "2017-12-21" "Picocom 3.0a" "User Commands"
.TH "PICOCOM" "1" "2017-12-23" "Picocom 3.0a" "User Commands"
.nh \" Turn off hyphenation by default.
.SH NAME
.PP
@ -21,6 +21,12 @@ program to allow access to all types of devices that provide serial
consoles.
It could also prove useful in many other similar tasks.
.PP
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).
.PP
When picocom starts it opens the tty (serial port) given as its
non\-option argument.
Unless the \f[B]\-\-noinit\f[] option is given, it configures the port
@ -168,20 +174,24 @@ Toggle local\-echo mode.
.RS
.RE
.TP
.B \f[B]C\-v\f[]
Show program options (like baud rate, data bits, etc) as well as the
actual serial port settings.
Only the options and port settings that can be modified online (through
commands) are shown, not those that can only be set at the
command\-line.
See \f[B]DISPLAY OF OPTIONS AND PORT SETTINGS\f[] for details.
.RS
.RE
.TP
.B \f[B]C\-h\f[] or \f[B]C\-k\f[]
Show help or show keys.
Prints a short description of all available function (command) keys.
.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).
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
are observed).
Example: The following sends the characters "ABCD" to the port.
.RS
.IP
.nf
\f[C]
C\-a\ C\-w
***\ hex:\ 41\ 4243:44
***\ wrote\ 4\ byes\ ***
\f[]
.fi
.RE
.TP
.B \f[B]C\-s\f[]
@ -195,6 +205,22 @@ Receive (download) a file.
See \f[B]SENDING AND RECEIVING FILES\f[] below.
.RS
.RE
.TP
.B \f[B]C\-v\f[]
Show program options (like baud rate, data bits, etc) as well as the
actual serial port settings.
Only the options and port settings that can be modified online (through
commands) are shown, not those that can only be set at the
command\-line.
See \f[B]DISPLAY OF OPTIONS AND PORT SETTINGS\f[] for details.
.RS
.RE
.TP
.B \f[B]C\-h\f[] or \f[B]C\-k\f[]
Show help, or show keys.
Prints a short description of all available function (command) keys.
.RS
.RE
.PP
After performing one of the above operations, the program leaves the
command mode and enters transparent mode.
@ -309,7 +335,7 @@ If \f[B]\-\-noreset\f[] is given and \f[B]\-\-hangup\f[] is not, then
HUPCL for the port is cleared and will remain so after exiting picocom.
If \f[B]\-\-noreset\f[] is \f[I]not\f[] given, or if both
\f[B]\-\-noreset\f[] and \f[B]\-\-hangup\f[] are given, then HUPCL is
set for the port, and will remain so after exiting picocom.
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 \f[B]\-\-noinit\f[] option.

21
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.0a / 2017-12-21</div></h1>
<h1 class="title"><div id="pgname">PICOCOM(1)</div><div id="version">v3.0a / 2017-12-23</div></h1>
</div>
<h1 id="name">NAME</h1>
<p>picocom - minimal dumb-terminal emulation program</p>
@ -19,6 +19,7 @@
<p><strong>picocom</strong> [ <em>options</em> ] <em>device</em></p>
<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 &quot;pico&quot; instead of &quot;mini&quot;! 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 &quot;emulator&quot; 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. 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 &quot;raw&quot; 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 &quot;command mode&quot; and waits for the next character (which is called the &quot;function character&quot;). 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>
@ -68,11 +69,11 @@
<dt><strong>C-c</strong></dt>
<dd><p>Toggle local-echo mode.</p>
</dd>
<dt><strong>C-v</strong></dt>
<dd><p>Show program options (like baud rate, data bits, etc) as well as the actual serial port settings. Only the options and port settings that can be modified online (through commands) are shown, not those that can only be set at the command-line. See <strong><a href="#display-of-options-and-port-settings">DISPLAY OF OPTIONS AND PORT SETTINGS</a></strong> for details.</p>
</dd>
<dt><strong>C-h</strong> or <strong>C-k</strong></dt>
<dd><p>Show help or show keys. Prints a short description of all available function (command) keys.</p>
<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>
<pre><code>C-a C-w
*** hex: 41 4243:44
*** wrote 4 byes ***</code></pre>
</dd>
<dt><strong>C-s</strong></dt>
<dd><p>Send (upload) a file. See <strong><a href="#sending-and-receiving-files">SENDING AND RECEIVING FILES</a></strong> below.</p>
@ -80,6 +81,12 @@
<dt><strong>C-r</strong></dt>
<dd><p>Receive (download) a file. See <strong><a href="#sending-and-receiving-files">SENDING AND RECEIVING FILES</a></strong> below.</p>
</dd>
<dt><strong>C-v</strong></dt>
<dd><p>Show program options (like baud rate, data bits, etc) as well as the actual serial port settings. Only the options and port settings that can be modified online (through commands) are shown, not those that can only be set at the command-line. See <strong><a href="#display-of-options-and-port-settings">DISPLAY OF OPTIONS AND PORT SETTINGS</a></strong> for details.</p>
</dd>
<dt><strong>C-h</strong> or <strong>C-k</strong></dt>
<dd><p>Show help, or show keys. Prints a short description of all available function (command) keys.</p>
</dd>
</dl>
<p>After performing one of the above operations, the program leaves the command mode and enters transparent mode. Example: To increase the baud-rate by two steps, you have to type:</p>
<blockquote>
@ -118,7 +125,7 @@
</dd>
<dt><strong>--noreset</strong> | <strong>-r</strong></dt>
<dd><p>If given, picocom will not reset the serial port when exiting. It will just close the respective file descriptor and do nothing more. The serial port settings will <em>not</em> be restored to their original values and, unless the <strong>--hangup</strong> option is also given, the modem-control lines will <em>not</em> be affected. This is useful, for example, for leaving modems connected when exiting picocom. Regardless whether the <strong>--noreset</strong> option is given, the user can exit picocom using the &quot;Quit&quot; command (instead of &quot;Exit&quot;), which makes picocom behave <em>exactly</em> as if <strong>--noreset</strong> was given. See also the <strong>--hangup</strong> option. (Default: Disabled)</p>
<p>NOTICE: Picocom will always set the HUPCL control bit of the serial port, 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>
<p>NOTICE: Picocom will always set the HUPCL control bit of the serial port, 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>

42
picocom.1.md
View File

@ -24,6 +24,12 @@ 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.
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).
When picocom starts it opens the tty (serial port) given as its
non-option argument. Unless the **--noinit** option is given, it
configures the port to the settings specified by the option-arguments
@ -141,18 +147,19 @@ here.
: Toggle local-echo mode.
**C-v**
**C-w**
: Show program options (like baud rate, data bits, etc) as well as
the actual serial port settings. Only the options and port
settings that can be modified online (through commands) are shown,
not those that can only be set at the command-line. See
**[DISPLAY OF OPTIONS AND PORT SETTINGS]** for details.
: 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
**--omap**, **--echo** and **--emap** options are
observed). Example: The following sends the characters "ABCD" to
the port.
**C-h** or **C-k**
: Show help or show keys. Prints a short description of all
available function (command) keys.
C-a C-w
*** hex: 41 4243:44
*** wrote 4 byes ***
**C-s**
@ -164,6 +171,19 @@ here.
: Receive (download) a file. See **[SENDING AND RECEIVING FILES]**
below.
**C-v**
: Show program options (like baud rate, data bits, etc) as well as
the actual serial port settings. Only the options and port
settings that can be modified online (through commands) are shown,
not those that can only be set at the command-line. See
**[DISPLAY OF OPTIONS AND PORT SETTINGS]** for details.
**C-h** or **C-k**
: Show help, or show keys. Prints a short description of all
available function (command) keys.
After performing one of the above operations, the program leaves the
command mode and enters transparent mode. Example: To increase the
baud-rate by two steps, you have to type:
@ -254,7 +274,7 @@ Picocom accepts the following command-line options.
options. If **--noreset** is given and **--hangup** is not, then
HUPCL for the port is cleared and will remain so after exiting
picocom. If **--noreset** is *not* given, or if both **--noreset**
and **--hangup** are given, then HUPCL is set for the port, and
and **--hangup** 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

BIN
picocom.1.pdf
View File

Binary file not shown.