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

Regenerated docs

Browse Source
This commit is contained in:
Nick Patavalis
2016-10-15 19:28:15 +03:00
parent f53667c840
commit 910531e93d
3 changed files with 29 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
picocom.1
View File

@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 1.16.0.2
.\"
.TH "PICOCOM" "1" "2016-10-04" "Picocom 2.3a" "User Commands"
.TH "PICOCOM" "1" "2016-10-15" "Picocom 2.3a" "User Commands"
.hy
.SH NAME
.PP
@ -65,7 +65,7 @@ was given the serial port is not reset.
.RE
.TP
.B \f[B]C\-q\f[]
Quit the program \f[I]without\f[] reseting the serial port, regardless
Quit the program \f[I]without\f[] resetting the serial port, regardless
of the \f[B]\-\-noreset\f[] option.
.RS
.RE
@ -83,6 +83,15 @@ If it is down, then raise it.
.RS
.RE
.TP
.B \f[B]C\-g\f[]
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.
Only supported in Linux.
.RS
.RE
.TP
.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
@ -92,7 +101,7 @@ character durations.
.RE
.TP
.B \f[B]C\-b\f[]
Set baurdate.
Set baudrate.
Prompts you to enter a baudrate numerically (in bps) and configures the
serial port accordingly.
.RS
@ -368,7 +377,7 @@ Example:
\f[]
.fi
.PP
This behavioir was intriduced in picocom 2.0.
This behavior was introduced in picocom 2.0.
Older releases displayed only the option values, not the actual
serial\-port settings corresponding to them.
.SH SENDING AND RECEIVING FILES
@ -393,7 +402,7 @@ In Linux typical programs for this purpose are:
.PP
The name of, and the command\-line options to, the program to be used
for transmitting files are given by the \f[B]\-\-send\-cmd\f[] option.
Similarly the program to receive files, and its argumets, are given by
Similarly the program to receive files, and its arguments, are given by
the \f[B]\-\-receive\-cmd\f[] option.
For example, in order to start a picocom session that uses
\f[B]sz(1)\f[] to transmit files, and \f[B]rz(1)\f[] to receive files,
@ -434,7 +443,7 @@ Pressing \f[B]C\-c\f[] at this prompt will cancel the file transfer
command and return to normal picocom operation.
After entering a filename (and / or additional transmission or reception
program arguments) and assuming you have not canceled the operation by
pressing \f[B]C\-c\f[], picocom will start the the external program as
pressing \f[B]C\-c\f[], picocom will start the external program as
specified by the \f[B]\-\-send\-cmd\f[], or \f[B]\-\-receive\-cmd\f[]
option, and with any filenames and additional arguments you may have
supplied.
@ -451,7 +460,7 @@ character is normally passed to the serial port.
.SH INPUT, OUTPUT, AND ECHO MAPPING
.PP
Using the \f[B]\-\-imap\f[], \f[B]\-\-omap\f[], and \f[B]\-\-emap\f[]
options you can make picocom map (tranlate, replace) certain special
options you can make picocom map (translate, replace) certain special
characters after being read from the serial port (with
\f[B]\-\-imap\f[]), before being written to the serial port (with
\f[B]\-\-omap\f[]), and before being locally echoed to the terminal
@ -479,13 +488,13 @@ For example the command:
.IP
.nf
\f[C]
picocom\ \-\-omap\ crlf,delbs\ \-\-imap\ inglf,bsdel\ \-\-emap\ crcrlf\ ...
picocom\ \-\-omap\ crlf,delbs\ \-\-imap\ ignlf,bsdel\ \-\-emap\ crcrlf\ ...
\f[]
.fi
.PP
will:
.IP \[bu] 2
Replace every CR (carriage return, 0x0d) caracter with LF (line feed,
Replace every CR (carriage return, 0x0d) character with LF (line feed,
0x0a) and every DEL (delete, 0x7f) character with BS (backspace, 0x08)
before writing it to the serial port.
.IP \[bu] 2

19
picocom.1.html
View File

@ -30,7 +30,7 @@
<dd><p>Exit the program: if the <strong>--noreset</strong> option was not given then the serial port is reset to its original settings before exiting; if it was given the serial port is not reset.</p>
</dd>
<dt><strong>C-q</strong></dt>
<dd><p>Quit the program <em>without</em> reseting the serial port, regardless of the <strong>--noreset</strong> option.</p>
<dd><p>Quit the program <em>without</em> resetting the serial port, regardless of the <strong>--noreset</strong> option.</p>
</dd>
<dt><strong>C-p</strong></dt>
<dd><p>Pulse the DTR line. Lower it for 1 sec, and then raise it again.</p>
@ -38,11 +38,14 @@
<dt><strong>C-t</strong></dt>
<dd><p>Toggle the DTR line. If DTR is up, then lower it. If it is down, then raise it.</p>
</dd>
<dt><strong>C-g</strong></dt>
<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. Only supported in Linux.</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>
<dt><strong>C-b</strong></dt>
<dd><p>Set baurdate. Prompts you to enter a baudrate numerically (in bps) and configures the serial port accordingly.</p>
<dd><p>Set baudrate. Prompts you to enter a baudrate numerically (in bps) and configures the serial port accordingly.</p>
</dd>
<dt><strong>C-u</strong></dt>
<dd><p>Baud up. Increase the baud-rate. The list of baud-rates stepped-through by this command is: 50, 75, 110, 134, 150, 200, 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200. If <code>HIGH_BAUD</code> support is compiled-in, then the following baud-rates are also added to the list: 230400, 460800, 500000, 576000, 921600, 1000000, 1152000, 1500000, 2000000, 2500000, 3000000, 3500000, 4000000. Depending on you system, any of the higher baud rates may be missing.</p>
@ -140,7 +143,7 @@
<pre><code>*** baud: 115200 (9600) </code></pre>
<p>This means that a baud rate of 115200bps has been selected (from the command line, or using commands that change the baudrate) but the serial-port is actually operating at 9600bps (the driver may not support the higher setting, and has silently replaced it with a safe default, or the setting may have been changed from outside picocom). If the option and the corresponding serial-port setting are the same, only a single value is shown. Example:</p>
<pre><code>*** baud: 9600</code></pre>
<p>This behavioir was intriduced in picocom 2.0. Older releases displayed only the option values, not the actual serial-port settings corresponding to them.</p>
<p>This behavior was introduced in picocom 2.0. Older releases displayed only the option values, not the actual serial-port settings corresponding to them.</p>
<h1 id="sending-and-receiving-files">SENDING AND RECEIVING FILES</h1>
<p>Picocom can send and receive files over the serial port using external programs that implement the respective protocols. In Linux typical programs for this purpose are:</p>
<ul>
@ -152,14 +155,14 @@
<li><strong>sz(1)</strong> - send using the Z-MODEM protocol</li>
<li><strong>ascii-xfr(1)</strong> - receive or transmit ASCII files</li>
</ul>
<p>The name of, and the command-line options to, the program to be used for transmitting files are given by the <strong>--send-cmd</strong> option. Similarly the program to receive files, and its argumets, are given by the <strong>--receive-cmd</strong> option. For example, in order to start a picocom session that uses <strong>sz(1)</strong> to transmit files, and <strong>rz(1)</strong> to receive files, you have to say something like this:</p>
<p>The name of, and the command-line options to, the program to be used for transmitting files are given by the <strong>--send-cmd</strong> option. Similarly the program to receive files, and its arguments, are given by the <strong>--receive-cmd</strong> option. For example, in order to start a picocom session that uses <strong>sz(1)</strong> to transmit files, and <strong>rz(1)</strong> to receive files, you have to say something like this:</p>
<pre><code>picocom --send-cmd &quot;sz -vv&quot; --receive-cmd &quot;rz -vv&quot; ...</code></pre>
<p>If the argument to the <strong>-send-cmd</strong> option, or the argument to the <strong>--receive-cmd</strong> option is the empty string, then the respective command is disabled. For example, in order to disable both the &quot;send&quot; and the &quot;receive&quot; commands you can invoke picocom like this:</p>
<pre><code>picocom --send-cmd '' --receive-cmd '' ...</code></pre>
<p>A picocom session with both, the send- and the receive-file commands disabled does not <strong>fork(2)</strong> and does not run any external programs.</p>
<p>During the picocom session, if you key the &quot;send&quot; or &quot;receive&quot; commands (e.g. by pressing <strong>C-a</strong>, <strong>C-s</strong>, or <strong>C-a</strong>, <strong>C-r</strong>) you will be prompted for a filename. At this prompt you can enter one or more file-names, and any additional arguments to the transmission or reception program. Command-line editing and rudimentary pathname completion are available at this prompt, if you have compiled picocom with support for the linenoise library. Pressing <strong>C-c</strong> at this prompt will cancel the file transfer command and return to normal picocom operation. After entering a filename (and / or additional transmission or reception program arguments) and assuming you have not canceled the operation by pressing <strong>C-c</strong>, picocom will start the the external program as specified by the <strong>--send-cmd</strong>, or <strong>--receive-cmd</strong> option, and with any filenames and additional arguments you may have supplied. The standard input and output of the external program will be connected to the serial port. The standard error of the external program will be connected to the terminal which---while the program is running---will revert to canonical mode. Pressing <strong>C-c</strong> while the external program is running will prematurely terminate it (assuming that the program itself does not ignore SIGINT), and return control to picocom. Pressing <strong>C-c</strong> at any other time, has no special effect; the character is normally passed to the serial port.</p>
<p>During the picocom session, if you key the &quot;send&quot; or &quot;receive&quot; commands (e.g. by pressing <strong>C-a</strong>, <strong>C-s</strong>, or <strong>C-a</strong>, <strong>C-r</strong>) you will be prompted for a filename. At this prompt you can enter one or more file-names, and any additional arguments to the transmission or reception program. Command-line editing and rudimentary pathname completion are available at this prompt, if you have compiled picocom with support for the linenoise library. Pressing <strong>C-c</strong> at this prompt will cancel the file transfer command and return to normal picocom operation. After entering a filename (and / or additional transmission or reception program arguments) and assuming you have not canceled the operation by pressing <strong>C-c</strong>, picocom will start the external program as specified by the <strong>--send-cmd</strong>, or <strong>--receive-cmd</strong> option, and with any filenames and additional arguments you may have supplied. The standard input and output of the external program will be connected to the serial port. The standard error of the external program will be connected to the terminal which---while the program is running---will revert to canonical mode. Pressing <strong>C-c</strong> while the external program is running will prematurely terminate it (assuming that the program itself does not ignore SIGINT), and return control to picocom. Pressing <strong>C-c</strong> at any other time, has no special effect; the character is normally passed to the serial port.</p>
<h1 id="input-output-and-echo-mapping">INPUT, OUTPUT, AND ECHO MAPPING</h1>
<p>Using the <strong>--imap</strong>, <strong>--omap</strong>, and <strong>--emap</strong> options you can make picocom map (tranlate, replace) certain special characters after being read from the serial port (with <strong>--imap</strong>), before being written to the serial port (with <strong>--omap</strong>), and before being locally echoed to the terminal (standard output) if local echo is enabled (with <strong>--emap</strong>). These mapping options take, each, a single argument which is a comma-separated list of one or more of the following identifiers:</p>
<p>Using the <strong>--imap</strong>, <strong>--omap</strong>, and <strong>--emap</strong> options you can make picocom map (translate, replace) certain special characters after being read from the serial port (with <strong>--imap</strong>), before being written to the serial port (with <strong>--omap</strong>), and before being locally echoed to the terminal (standard output) if local echo is enabled (with <strong>--emap</strong>). These mapping options take, each, a single argument which is a comma-separated list of one or more of the following identifiers:</p>
<ul>
<li><strong>crlf</strong> (map CR to LF),</li>
<li><strong>crcrlf</strong> (map CR to CR + LF),</li>
@ -171,10 +174,10 @@
<li><strong>delbs</strong> (map DEL to BS)</li>
</ul>
<p>For example the command:</p>
<pre><code>picocom --omap crlf,delbs --imap inglf,bsdel --emap crcrlf ...</code></pre>
<pre><code>picocom --omap crlf,delbs --imap ignlf,bsdel --emap crcrlf ...</code></pre>
<p>will:</p>
<ul>
<li><p>Replace every CR (carriage return, 0x0d) caracter with LF (line feed, 0x0a) and every DEL (delete, 0x7f) character with BS (backspace, 0x08) before writing it to the serial port.</p></li>
<li><p>Replace every CR (carriage return, 0x0d) character with LF (line feed, 0x0a) and every DEL (delete, 0x7f) character with BS (backspace, 0x08) before writing it to the serial port.</p></li>
<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>

BIN
picocom.1.pdf
View File

Binary file not shown.