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

Converted mapage source to pandoc's MarkDown and moved it to section 1.

Browse Source 
- Much metter groff and html formating. Much easier to write and edit.
- Page had no reason to be in section 8.
This commit is contained in:
Nick Patavalis
2015-08-22 14:46:24 +03:00
parent 0f09071f69
commit b443e39e43
10 changed files with 1145 additions and 1792 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
Makefile
View File

@ -52,19 +52,26 @@ split.o : split.c split.h
fdio.o : fdio.c fdio.h
doc : picocom.8 picocom.8.html picocom.8.ps
doc : picocom.1.html picocom.1 picocom.1.pdf
changes :
svn log -v . > CHANGES
picocom.8 : picocom.8.xml
xmltoman $< > $@
picocom.1 : picocom.1.md
sed 's/\*\*\[/\*\*/g;s/\]\*\*/\*\*/g' $< \
| pandoc -s -t man \
-Vfooter="Picocom $(VERSION)" -Vdate="`date -I`" \
-o $@
picocom.8.html : picocom.8.xml
xmlmantohtml $< > $@
picocom.1.html : picocom.1.md
pandoc -s -t html \
-c css/normalize-noforms.css -c css/manpage.css \
--self-contained \
-o $@ $<
picocom.1.pdf : picocom.1
groff -man -Tpdf $< > $@
picocom.8.ps : picocom.8
groff -mandoc -Tps $< > $@
clean:
rm -f picocom.o term.o fdio.o split.o linenoise-1.0/linenoise.o
@ -76,7 +83,7 @@ distclean: clean
rm -f picocom
realclean: distclean
rm -f picocom.8
rm -f picocom.8.html
rm -f picocom.8.ps
rm -f picocom.1
rm -f picocom.1.html
rm -f picocom.1.pdf
rm -f CHANGES

6
README.md
View File

@ -29,7 +29,7 @@ library.
For a description of picocom's operation, its command line options,
and usage examples, see the manual page included in the source
distribution as "picocom.8", and also html-ized as "picocom.8.html".
distribution as "picocom.1", and also html-ized as "picocom.1.html".
People who have contibuted to picocom, by offering feature
implementations, bug-fixes, corrections, and suggestions are listed in
@ -62,7 +62,7 @@ example:
```
cp picocom ~/bin
cp picocom.8 ~/man/man8
cp picocom.1 ~/man/man1
```
Again, this is not strictly necessary. You can run picocom and read
@ -188,7 +188,7 @@ page. It can be accessed like this (assuming you are inside the
picocom distribution source directory):
```
man ./picocom.8
man ./picocom.1
```
or (assuming you have installed the manual page to a suitable place):

512
picocom.1 Normal file
View File

@ -0,0 +1,512 @@
.TH "PICOCOM" "1" "2015-08-22" "Picocom 2.0a" "User Commands"
.SH NAME
.PP
picocom \- minimal dumb\-terminal emulation program
.SH SYNOPSIS
.PP
\f[B]picocom\f[] [ \f[I]options\f[] ] \f[I]device\f[]
.SH DESCRIPTION
.PP
As its name suggests, \f[B]picocom(1)\f[] is a minimal dumb\-terminal
emulation program.
It is, in principle, very much like \f[B]minicom(1)\f[], only it\[aq]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.
.PP
When picocom starts it opens the terminal (serial device) given as its
non\-option argument.
Unless the \f[B]\-\-noinit\f[] option is given, it configures the device
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 device is just opened.
Following this, picocom sets the standard\-input and standard\-output to
raw mode.
Having done so, 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 \f[I]escape character\f[] (being by default
\f[B]C\-a\f[]).
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 \f[B]COMMANDS\f[] section below.
.SH COMMANDS
.PP
Commands are given to picocom by first keying the \f[I]espace
character\f[] which by default is \f[B]C\-a\f[] (see \f[B]OPTIONS\f[]
below for how to change it), and then keying one of the function
(command) characters shown here.
.TP
.B \f[I]escape character\f[]
Send the escape character to the serial port and return to "transparent"
mode.
This means that if the escape character (\f[B]C\-a\f[], by default) is
typed twice, the program sends the escape character to the serial port,
and remains in transparent mode.
.RS
.RE
.TP
.B \f[B]C\-x\f[]
Exit the program: if the \f[B]\-\-noreset\f[] 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.
.RS
.RE
.TP
.B \f[B]C\-q\f[]
Quit the program \f[I]without\f[] reseting the serial port, regardless
of the \f[B]\-\-noreset\f[] option.
.RS
.RE
.TP
.B \f[B]C\-p\f[]
Pulse the DTR line.
Lower it for 1 sec, and then raise it again.
.RS
.RE
.TP
.B \f[B]C\-t\f[]
Toggle the DTR line.
If DTR is up, then lower it.
If it is down, then raise it.
.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
one) the serial Tx line for an amount of time coresponding to several
character durations.
.RS
.RE
.TP
.B \f[B]C\-u\f[]
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 \f[C]HIGH_BAUD\f[] 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.
.RS
.RE
.TP
.B \f[B]C\-d\f[]
Baud down.
Decrease the baud\-rate.
The list of baud\-rates stepped\-through by this command is the same as
for the "baud\-up" command.
.RS
.RE
.TP
.B \f[B]C\-f\f[]
Cycle through flow\-control settings (RTS/CTS, XON/XOFF, none).
.RS
.RE
.TP
.B \f[B]C\-y\f[]
Cycle through parity settings (even, odd, none).
.RS
.RE
.TP
.B \f[B]C\-b\f[]
Cycle through databits\-number settings (5, 6, 7, 8).
.RS
.RE
.TP
.B \f[B]C\-j\f[]
Cycle through stopbits\-number settings (1, 2).
.RS
.RE
.TP
.B \f[B]C\-c\f[]
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.
.RS
.RE
.TP
.B \f[B]C\-s\f[]
Send (upload) a file.
See \f[B]SENDING AND RECEIVING FILES\f[] below.
.RS
.RE
.TP
.B \f[B]C\-r\f[]
Receive (download) a file.
See \f[B]SENDING AND RECEIVING FILES\f[] below.
.RS
.RE
.PP
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:
.RS
.PP
\f[B]C\-a\f[], \f[B]C\-u\f[], \f[B]C\-a\f[], \f[B]C\-u\f[]
.RE
.PP
assuming of\-course that \f[B]C\-a\f[] is the escape character.
.SH OPTIONS
.PP
Picocom accepts the following command\-line options.
.TP
.B \f[B]\-\-baud\f[] | \f[B]\-b\f[]
Defines the baud\-rate to set the serial\-port (terminal) to.
.RS
.RE
.TP
.B \f[B]\-\-flow\f[] | \f[B]\-f\f[]
Defines the flow\-control mode to set the serial\-port to.
Must be one of: \f[B]x\f[] for xon/xoff (software) mode, \f[B]h\f[] for
hardware flow control (RTS/CTS), \f[B]n\f[] for no flow control.
(Default: \f[B]n\f[])
.RS
.RE
.TP
.B \f[B]\-\-parity\f[] | \f[B]\-y\f[]
Defines the parity mode to set the serial\-port to.
Must be one of: \f[B]o\f[] for odd parity mode, \f[B]e\f[] for even
parity mode, \f[B]n\f[] for no parity mode.
(Default: \f[B]n\f[])
.RS
.RE
.TP
.B \f[B]\-\-databits\f[] | \f[B]\-d\f[]
Defines the number of data bits in every character.
Must be one of: \f[B]5\f[], \f[B]6\f[], \f[B]7\f[], \f[B]8\f[].
(Default: \f[B]8\f[])
.RS
.RE
.TP
.B \f[B]\-\-stopbits\f[] | \f[B]\-p\f[]
Defines the number of stop bits in every character.
Must be one of: \f[B]1\f[], or \f[B]2\f[].
(Default: \f[B]1\f[])
.RS
.RE
.TP
.B \f[B]\-\-esacpe\f[] | \f[B]\-e\f[]
Defines the character that will make picocom enter command\-mode (see
description above).
If \f[B]x\f[] is given, then \f[B]C\-x\f[] will make picocom enter
command mode.
(Default: \f[B]a\f[])
.RS
.RE
.TP
.B \f[B]\-\-echo\f[] | \f[B]\-c\f[]
Enable local echo.
Every character being read from the terminal (standard input) is echoed
to the terminal (standard output) subject to the echo\-mapping
configuration (see \f[B]\-\-emap\f[] option).
(Default: Disabled)
.RS
.RE
.TP
.B \f[B]\-\-noinit\f[] | \f[B]\-i\f[]
If given, picocom will not initialize, reset, or otherwise meddle with
the serial port at start\-up.
It will just open it.
This is useful, for example, for connecting picocom to
already\-connected modems, or already configured ports without
terminating the connection, or altering the settings.
If required, serial port parameters can then be adjusted at run\-time by
commands.
(Default: Disabled)
.RS
.RE
.TP
.B \f[B]\-\-noreset\f[] | \f[B]\-r\f[]
If given, picocom will not reset the serial port when exiting.
It will just close the filedes and do nothing more.
This is useful, for example, for leaving modems connected when exiting
picocom.
Regardless whether the \f[B]\-\-noreset\f[] option is given, the user
can exit picocom using the "Quit" command (instead of "Exit"), which
never resets the serial port.
If \f[B]\-\-noreset\f[] is given then "Quit" and "Exit" behave
essentially the same.
(Default: Disabled)
.RS
.RE
.TP
.B \f[B]\-\-nolock\f[] | \f[B]\-l\f[]
If given, picocom will \f[I]not\f[] attempt to lock the serial port
before opening it.
Normally, depending on how it\[aq]s compiled, picocom attempts to get a
UUCP\-style lock\-file (e.g.
\[aq]/var/lock/LCK..ttyS0\[aq]) before opening the port, or attempts to
lock the port device\-node using \f[B]flock(2)\f[].
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 \f[B]\-\-nolock\f[] option is accepted, but has no
effect.
(Default: Disabled)
.RS
.RE
.TP
.B \f[B]\-\-send\-cmd\f[] | \f[B]\-s\f[]
Specifies the external program (and any arguments to it) that will be
used for transmitting files.
If the argument to \f[B]\-\-send\-cmd\f[] is the empty string
(\[aq]\[aq]), the send\-file command is disabled.
See \f[B]SENDING AND RECEIVING FILES\f[].
(Default: \f[B]sz \-vv\f[])
.RS
.RE
.TP
.B \f[B]\-\-receive\-cmd\f[] | \f[B]\-v\f[]
Specifies the external program (and any arguments to it) that will be
used for receiving files.
If the argument to \f[B]\-\-receive\-cmd\f[] is the empty string
(\[aq]\[aq]), the receive\-file command is disabled.
See \f[B]SENDING AND RECEIVING FILES\f[].
(Default: \f[B]rz \-vv\f[])
.RS
.RE
.TP
.B \f[B]\-\-imap\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)
.RS
.RE
.TP
.B \f[B]\-\-omap\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)
.RS
.RE
.TP
.B \f[B]\-\-emap\f[]
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 \f[B]INPUT, OUTPUT, AND ECHO MAPPING\f[].
(Defaul: \f[B]delbs,crcrlf\f[])
.RS
.RE
.TP
.B \f[B]\-\-help\f[] | \f[B]\-h\f[]
Print a short help message describing the command\-line options.
Picocom\[aq]s version, ompile\-time options, and enabled features are
also shown.
.RS
.RE
.SH DISPLAY OF OPTIONS AND PORT SETTINGS
.PP
The "show program options" command (\f[B]C\-v\f[]), as well as the
commands that change program options (\f[B]C\-u\f[], \f[B]C\-d\f[],
\f[B]C\-f\f[], 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:
.IP
.nf
\f[C]
***\ baud:\ 115200\ (9600)\
\f[]
.fi
.PP
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:
.IP
.nf
\f[C]
***\ baud:\ 9600
\f[]
.fi
.PP
This behavioir was intriduced 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
.PP
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:
.IP \[bu] 2
\f[B]rx(1)\f[] \- receive using the X\-MODEM protocol
.IP \[bu] 2
\f[B]rb(1)\f[] \- receive using the Y\-MODEM protocol
.IP \[bu] 2
\f[B]rz(1)\f[] \- receive using the Z\-MODEM protocol
.IP \[bu] 2
\f[B]sx(1)\f[] \- send using the X\-MODEM protocol
.IP \[bu] 2
\f[B]sb(1)\f[] \- send using the Y\-MODEM protocol
.IP \[bu] 2
\f[B]sz(1)\f[] \- send using the Z\-MODEM protocol
.IP \[bu] 2
\f[B]ascii\-xfr(1)\f[] \- receive or transmit ASCII files
.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
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,
you have to say something like this:
.IP
.nf
\f[C]
picocom\ \-\-send\-cmd\ "sz\ \-vv"\ \-\-receive\-cmd\ "rz\ \-vv"\ ...
\f[]
.fi
.PP
If the argument to the \f[B]\-send\-cmd\f[] option, or the argument to
the \f[B]\-\-receive\-cmd\f[] option is the empty string, then the
respective command is disabled.
For example, in order to disable both the "send" and the "receive"
commands you can invoke picocom like this:
.IP
.nf
\f[C]
picocom\ \-\-send\-cmd\ \[aq]\[aq]\ \-\-receive\-cmd\ \[aq]\[aq]\ ...
\f[]
.fi
.PP
A picocom session with both, the send\- and the receive\-file commands
disabled does not \f[B]fork(2)\f[] and does not run any external
programs.
.PP
During the picocom session, if you key the "send" or "receive" commands
(e.g.
by pressing \f[B]C\-a\f[], \f[B]C\-s\f[], or \f[B]C\-a\f[],
\f[B]C\-r\f[]) 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 \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
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.
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 \f[B]C\-c\f[] 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 \f[B]C\-c\f[] at any other time, has no special effect; the
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
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
(standard output) if local echo is enabled (with \f[B]\-\-emap\f[]).
These mapping options take, each, a single argument which is a
comma\-separated list of one or more of the following identifiers:
.IP \[bu] 2
\f[B]crlf\f[] (map CR to LF),
.IP \[bu] 2
\f[B]crcrlf\f[] (map CR to CR + LF),
.IP \[bu] 2
\f[B]igncr\f[] (ignore CR),
.IP \[bu] 2
\f[B]lfcr\f[] (map LF to CR),
.IP \[bu] 2
\f[B]lfcrlf\f[] (map LF to CR + LF),
.IP \[bu] 2
\f[B]ignlf\f[] (ignore LF),
.IP \[bu] 2
\f[B]bsdel\f[] (map BS to DEL),
.IP \[bu] 2
\f[B]delbs\f[] (map DEL to BS)
.PP
For example the command:
.IP
.nf
\f[C]
picocom\ \-\-omap\ crlf,delbs\ \-\-imap\ inglf,bsdel\ \-\-emap\ crcrlf\ ...
\f[]
.fi
.PP
will:
.IP \[bu] 2
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.
.IP \[bu] 2
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.
.IP \[bu] 2
Replace every CR character with CR and LF when echoing to the terminal
(if local\-echo is enabled).
.SH AUTHOR
.PP
Written by Nick Patavalis <npat@efault.net>
.SH AVAILABILITY
.PP
Download the latest release from:
<https://github.com/npat-efault/picocom/releases>
.SH COPYRIGHT
.PP
Copyright (c) 2004\-2015 Nick Patavalis
.PP
This file is part of Picocom.
.PP
Picocom is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2 of the License, or (at your
option) any later version.
.PP
Picocom is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
59 Temple Place, Suite 330, Boston, MA 02111\-1307 USA

194
picocom.1.html Normal file
View File

File diff suppressed because one or more lines are too long

419
picocom.1.md Normal file
View File

@ -0,0 +1,419 @@
% PICOCOM(1)
---
header: User Commands
---
# NAME
picocom - minimal dumb-terminal emulation program
# SYNOPSIS
**picocom** [ _options_ ] _device_
# DESCRIPTION
As its name suggests, **picocom(1)** is a minimal dumb-terminal
emulation program. It is, in principle, very much like **minicom(1)**,
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.
When picocom starts it opens the terminal (serial device) given as its
non-option argument. Unless the **--noinit** option is given, it
configures the device 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 device is just opened. Following this, picocom sets the
standard-input and standard-output to raw mode. Having done so, 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 called the "function character"). Depending
on the value of the function character, picocom performs one of the
operations described in the **[COMMANDS]** section below.
# COMMANDS
Commands are given to picocom by first keying the *espace character*
which by default is **C-a** (see **[OPTIONS]** below for how to change
it), and then keying one of the function (command) characters shown
here.
*escape character*
: Send the escape character to the serial port and return to
"transparent" mode. This means that if the escape character
(**C-a**, by default) is typed twice, the program sends the escape
character to the serial port, and remains in transparent mode.
**C-x**
: Exit the program: if the **--noreset** 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.
**C-q**
: Quit the program _without_ reseting the serial port, regardless of
the **--noreset** option.
**C-p**
: Pulse the DTR line. Lower it for 1 sec, and then raise it again.
**C-t**
: Toggle the DTR line. If DTR is up, then lower it. If it is down,
then raise it.
**C-backslash**
: 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.
**C-u**
: 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
`HIGH_BAUD` 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.
**C-d**
: Baud down. Decrease the baud-rate. The list of baud-rates
stepped-through by this command is the same as for the "baud-up"
command.
**C-f**
: Cycle through flow-control settings (RTS/CTS, XON/XOFF, none).
**C-y**
: Cycle through parity settings (even, odd, none).
**C-b**
: Cycle through databits-number settings (5, 6, 7, 8).
**C-j**
: Cycle through stopbits-number settings (1, 2).
**C-c**
: Toggle local-echo mode.
**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.
**C-s**
: Send (upload) a file. See **[SENDING AND RECEIVING FILES]**
below.
**C-r**
: Receive (download) a file. See **[SENDING AND RECEIVING FILES]**
below.
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:
> **C-a**, **C-u**, **C-a**, **C-u**
assuming of-course that **C-a** is the escape character.
# OPTIONS
Picocom accepts the following command-line options.
**--baud** | **-b**
: Defines the baud-rate to set the serial-port (terminal) to.
**--flow** | **-f**
: Defines the flow-control mode to set the serial-port to. Must be
one of: **x** for xon/xoff (software) mode, **h** for hardware
flow control (RTS/CTS), **n** for no flow control. (Default:
**n**)
**--parity** | **-y**
: Defines the parity mode to set the serial-port to. Must be one
of: **o** for odd parity mode, **e** for even parity mode, **n**
for no parity mode. (Default: **n**)
**--databits** | **-d**
: Defines the number of data bits in every character. Must be one
of: **5**, **6**, **7**, **8**. (Default: **8**)
**--stopbits** | **-p**
: Defines the number of stop bits in every character. Must be one
of: **1**, or **2**. (Default: **1**)
**--esacpe** | **-e**
: Defines the character that will make picocom enter command-mode
(see description above). If **x** is given, then **C-x** will make
picocom enter command mode. (Default: **a**)
**--echo** | **-c**
: Enable local echo. Every character being read from the terminal
(standard input) is echoed to the terminal (standard output)
subject to the echo-mapping configuration (see **--emap**
option). (Default: Disabled)
**--noinit** | **-i**
: If given, picocom will not initialize, reset, or otherwise meddle
with the serial port at start-up. It will just open it. This is
useful, for example, for connecting picocom to already-connected
modems, or already configured ports without terminating the
connection, or altering the settings. If required, serial port
parameters can then be adjusted at run-time by commands.
(Default: Disabled)
**--noreset** | **-r**
: If given, picocom will not reset the serial port when exiting. It
will just close the filedes and do nothing more. This is useful,
for example, for leaving modems connected when exiting
picocom. Regardless whether the **--noreset** option is given, the
user can exit picocom using the "Quit" command (instead of
"Exit"), which never resets the serial port. If **--noreset** is
given then "Quit" and "Exit" behave essentially the
same. (Default: Disabled)
**--nolock** | **-l**
: If given, picocom will _not_ 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 **flock(2)**. 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 **--nolock** option is accepted, but
has no effect. (Default: Disabled)
**--send-cmd** | **-s**
: Specifies the external program (and any arguments to it) that will
be used for transmitting files. If the argument to **--send-cmd**
is the empty string (''), the send-file command is disabled. See
**[SENDING AND RECEIVING FILES]**. (Default: **sz -vv**)
**--receive-cmd** | **-v**
: Specifies the external program (and any arguments to it) that will
be used for receiving files. If the argument to **--receive-cmd**
is the empty string (''), the receive-file command is
disabled. See **[SENDING AND RECEIVING FILES]**. (Default: **rz
-vv**)
**--imap**
: 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)
**--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)
**--emap**
: 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
**[INPUT, OUTPUT, AND ECHO MAPPING]**. (Defaul: **delbs,crcrlf**)
**--help** | **-h**
: Print a short help message describing the command-line
options. Picocom's version, ompile-time options, and enabled
features are also shown.
# DISPLAY OF OPTIONS AND PORT SETTINGS
The "show program options" command (**C-v**), as well as the commands
that change program options (**C-u**, **C-d**, **C-f**, 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:
*** baud: 115200 (9600)
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:
*** baud: 9600
This behavioir was intriduced in picocom 2.0. Older releases displayed
only the option values, not the actual serial-port settings
corresponding to them.
# SENDING AND RECEIVING FILES
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:
- **rx(1)** - receive using the X-MODEM protocol
- **rb(1)** - receive using the Y-MODEM protocol
- **rz(1)** - receive using the Z-MODEM protocol
- **sx(1)** - send using the X-MODEM protocol
- **sb(1)** - send using the Y-MODEM protocol
- **sz(1)** - send using the Z-MODEM protocol
- **ascii-xfr(1)** - receive or transmit ASCII files
The name of, and the command-line options to, the program to be used
for transmitting files are given by the **--send-cmd**
option. Similarly the program to receive files, and its argumets, are
given by the **--receive-cmd** option. For example, in order to start
a picocom session that uses **sz(1)** to transmit files, and **rz(1)**
to receive files, you have to say something like this:
picocom --send-cmd "sz -vv" --receive-cmd "rz -vv" ...
If the argument to the **-send-cmd** option, or the argument to the
**--receive-cmd** option is the empty string, then the respective
command is disabled. For example, in order to disable both the "send"
and the "receive" commands you can invoke picocom like this:
picocom --send-cmd '' --receive-cmd '' ...
A picocom session with both, the send- and the receive-file commands
disabled does not **fork(2)** and does not run any external programs.
During the picocom session, if you key the "send" or "receive"
commands (e.g. by pressing **C-a**, **C-s**, or **C-a**, **C-r**) 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 **C-c** 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 **C-c**, picocom will start the the
external program as specified by the **--send-cmd**, or
**--receive-cmd** 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 **C-c** 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 **C-c** at any
other time, has no special effect; the character is normally passed to
the serial port.
# INPUT, OUTPUT, AND ECHO MAPPING
Using the **--imap**, **--omap**, and **--emap** options you can make
picocom map (tranlate, replace) certain special characters after being
read from the serial port (with **--imap**), before being written to
the serial port (with **--omap**), and before being locally echoed to
the terminal (standard output) if local echo is enabled (with
**--emap**). These mapping options take, each, a single argument which
is a comma-separated list of one or more of the following identifiers:
- **crlf** (map CR to LF),
- **crcrlf** (map CR to CR + LF),
- **igncr** (ignore CR),
- **lfcr** (map LF to CR),
- **lfcrlf** (map LF to CR + LF),
- **ignlf** (ignore LF),
- **bsdel** (map BS to DEL),
- **delbs** (map DEL to BS)
For example the command:
picocom --omap crlf,delbs --imap inglf,bsdel --emap crcrlf ...
will:
- 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.
- 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.
- Replace every CR character with CR and LF when echoing to the
terminal (if local-echo is enabled).
# AUTHOR
Written by Nick Patavalis <npat@efault.net>
# AVAILABILITY
Download the latest release from:
<https://github.com/npat-efault/picocom/releases>
# COPYRIGHT
Copyright (c) 2004-2015 Nick Patavalis
This file is part of Picocom.
Picocom is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
Picocom is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA

BIN
picocom.1.pdf Normal file
View File

Binary file not shown.

142
picocom.8
View File

@ -1,142 +0,0 @@
.TH picocom 8 User Manuals
.SH NAME
picocom \- minimal dumb-terminal emulation program
.SH SYNOPSIS
\fBpicocom [ \fIoptions\fB ] \fIdevice\fB
\f1
.SH DESCRIPTION
As its name suggests, picocom is a minimal dumb-terminal emulation program. It is, in principle, very much like \fBminicom(1)\f1, 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.
When picocom starts it opens the terminal (serial device) given as its non-option argument. Unless the \fB--noinit\f1 option is given, it configures the device to the settings specified by the option-arguments (or to some default settings), and sets it to "raw" mode. If \fB--noinit\f1 is given, the initialization and configuration is skipped; the device is just opened. Following this, picocom sets the standard-input and standard-output to raw mode. Having done so, 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 called the "function character"). Depending on the value of the function character, picocom performs one of the operations described in the "Commands" section below.
.SH COMMANDS
Commands are given to picocom by first keying the "espace character" which by default is "C-a" (see "Options" below on how to change it), and then keying one for the function (command) characters shown here.
[escape character]: Send the escape character to the serial port and return to "transparent" mode. This means that if the escape character ("C-a", by default) is typed twice, the program sends the escape character to the serial port, and remains in transparent mode.
[C-x]: Exit the program: if the \fB--noreset\f1 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.
[C-q]: Quit the program *without* reseting the serial port, regardless of the \fB--noreset\f1 option.
[C-p]: Pulse the DTR line. Lower it for 1 sec, and then raise it again.
[C-t]: Toggle the DTR line. If DTR is up, then lower it. If it is down, then raise it.
[C-backslash]: 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.
[C-u]: 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 HIGH_BAUD 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.
[C-d]: Baud down. Decrease the baud-rate. The list of baud-rates stepped-through by this command is the same as for the "baud-up" command.
[C-f]: Cycle through flow-control settings (RTS/CTS, XON/XOFF, none).
[C-y]: Cycle through parity settings (even, odd, none).
[C-b]: Cycle through databits-number settings (5, 6, 7, 8).
[C-j]: Cycle through stopbits-number settings (1, 2).
[C-c]: Toggle local-echo mode.
[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. If an actual port setting is different than 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 port setting in parenthesis. Example: "*** baud: 115200 (9600)". This means that a baud rate of 115200bps has been selected (from the command line, or using commands) 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 port setting are the same, only a single value is shown. Example: "*** baud: 9600".
[C-h] or [C-k]: Show help or show keys. Prints a short description of all available function (command) keys.
[C-s]: Send (upload) a file (see "Sending and Receiving Files" below)
[C-r]: Receive (download) a file (see "Sending and Receiving Files" below)
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:
C-a, C-u, C-a, C-u
assuming of-course that "C-a" is the escape character.
Commands that change program options ([C-u], [C-d], [C-f], etc) also display a message showing the new option value. If the new option value cannot be applied succesfully to the serial port (for whatever reason), then the respective actual current port setting is also shown. See the description of the [C-v] command, above, for more on this.
.SH SENDING AND RECEIVING FILES
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:
\fBrx(1)\f1 - receive using the X-MODEM protocol
\fBrb(1)\f1 - receive using the Y-MODEM protocol
\fBrz(1)\f1 - receive using the Z-MODEM protocol
\fBsx(1)\f1 - send using the X-MODEM protocol
\fBsb(1)\f1 - send using the Y-MODEM protocol
\fBsz(1)\f1 - send using the Z-MODEM protocol
\fBascii-xfr(1)\f1 - receive or transmit ASCII files
The name of, and the command-line options to, the program to be used for transmitting files are given by the \fB--send-cmd\f1 option. Similarly the program to receive files, and its argumets, are given by the \fB--receive-cmd\f1 option. For example, in order to start a picocom session that uses "sz" to transmit files, and "rz" to receive files, you have to say something like this:
picocom --send-cmd "sz -vv" --receive-cmd "rz -vv"
If the argument to the \fB--send-cmd\f1 option, or the argument to the \fB--receive-cmd\f1 option is the empty string, then the respective command is disabled. For example, in order to disable both the "send" and the "receive" commands you can invoke picocom like this:
picocom --send-cmd '' --receive-cmd ''
During the picocom session, if you key the "send" or "receive" commands (e.g. by pressing C-a, C-s, or C-a, C-r) 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 pathname completion are available at this prompt, if you have compiled picocom with support for the linenoise library. Pressing 'C-c' 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 C-c, picocom will start the the external program as specified by the \fB--send-cmd\f1, or \fB--receive-cmd\f1 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 'C-c' while the external program is running will prematurely terminate it, and return control to picocom. Pressing 'C-c' at any other time, has no special effect; the character is normally passed to the serial port.
.SH INPUT, OUTPUT, AND ECHO MAPPING
Using the \fB--imap\f1, \fB--omap\f1, and \fB--emap\f1 options you can make picocom map (tranlate, replace) certain special characters after being read from the serial port (with \fB--imap\f1), before being written to the serial port (with \fB--omap\f1), and before being locally echoed to the terminal (standard output) if local echo is enabled (with \fB--emap\f1). These mapping options take, each, a single argument which is a comma-separated list of one or more of the following identifiers: "crlf" (map CR to LF), "crcrlf" (map CR to CR + LF), "igncr" (ignore CR), "lfcr" (map LF to CR), "lfcrlf" (map LF to CR + LF), "ignlf" (ignore LF), "bsdel" (map BS --> DEL), "delbs" (map DEL --> BS)
For example the command:
picocom --omap crlf,delbs --imap inglf,bsdel --emap crcrlf ...
will: 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. 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. Replace every CR character with CR and LF when echoing to the terminal (if local-echo is enabled).
.SH OPTIONS
picocom accepts the following command-line options
.TP
\fB--baud | -b
\f1Defines the baud-rate to set the serial-port (terminal) to.
.TP
\fB--flow | -f
\f1Defines the flow-control mode to set the serial-port to. Must be one of: 'x' for xon/xoff (software) mode, 'h' for hardware flow control (RTS/CTS), 'n' for no flow control. (Default: 'n')
.TP
\fB--parity | -p
\f1Defines the parity mode to set the serial-port to. Must be one of: 'o' for odd parity mode, 'e' for even parity mode, 'n' for no parity mode. (Default: 'n')
.TP
\fB--databits | -d
\f1Defines the number of data bits in every character. Must be one of: 5, 6, 7, 8. (Default: 8)
.TP
\fB--stopbits | -p
\f1Defines the number of stop bits in every character. Must be one of: 1, or 2. (Default: 1)
.TP
\fB--esacpe | -e
\f1Defines the character that will make picocom enter command-mode (see description above). If 'x' is given, then C-x will make picocom enter command mode. (Default: 'a')
.TP
\fB--echo | -c
\f1Enable local echo. Every character being read from the terminal (standard input) is echoed to the terminal (standard output) subject to the echo-mapping configuration (see \fB--emap\f1 option. (Default: Disabled)
.TP
\fB--noinit | -i
\f1If given, picocom will not initialize, reset, or otherwise meddle with the serial port at start-up. It will just open it. This is useful, for example, for connecting picocom to already-connected modems, or already configured ports without terminating the connection, or altering the settings. If required serial port parameters can then be adjusted at run-time by commands.
.TP
\fB--noreset | -r
\f1If given, picocom will not *reset* the serial port when exiting. It will just close the filedes and do nothing more. This is useful, for example, for leaving modems connected when exiting picocom. Regardless whether the \fB--noreset\f1 option is given the user can exit picocom using the "Quit" command (instead of "Exit"), which never resets the serial port. If \fB--noreset\f1 is given then "Quit" and "Exit" behave essentially the same.
.TP
\fB--nolock | -l
\f1If given, picocom will *not* 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 \fBflock(2)\f1. 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 \fB--nolock\f1 option is accepted, but has no effect.
.TP
\fB--send-cmd | -s
\f1Specifies the external program (and any arguments to it) that will be used for transmitting files. If the argument to \fB--send-cmd\f1 is the empty string (''), the send-file command is disabled. (Default: "sz -vv")
.TP
\fB--receive-cmd | -v
\f1Specifies the external program (and any arguments to it) that will be used for receiving files. If the argument to \fB--receive-cmd\f1 is the empty string (''), the receive-file command is disabled. (Default: "rz -vv")
.TP
\fB--imap
\f1Specifies the input character map (i.e. special characters to be replaced when read from the serial port). Example: "--imap crlf,delbs". (Defaul: Empty)
.TP
\fB--omap
\f1Specifies the output character map (i.e. special characters to be replaced before being written to serial port). Example: "--omap crcrlf,bsdel". (Defaul: Empty)
.TP
\fB--emap
\f1Specifies the local-echo character map (i.e. special characters to be replaced before being echoed-back to the terminal, if local-echo is enabled). Example: "--emap crcrlf,bsdel". (Defaul: delbs,crcrlf)
.TP
\fB--help | -h
\f1Print a short help message describing the command-line options. picocom's version, compile-time options, and enabled features are also shown.
.SH AUTHOR
picocom was written by Nick Patavalis (npat@efault.net)
.SH AVAILABILITY
The latest release of "picocom" can be downloaded from: \fBhttps://github.com/npat-efault/picocom/releases\f1

520
picocom.8.html
View File

@ -1,520 +0,0 @@
<body text="#000000" link="#0000ff" bgcolor="#ffffff"><center><table width="80%">
<tr><td><h1>picocom</h1>
<h2>minimal dumb-terminal emulation program</h2>
<h2>Synopsis</h2>
<b>
picocom [ <em>options</em> ] <em>device</em><br>
</b>
<h2>Description</h2>
<p>
As its name suggests, picocom is a minimal dumb-terminal
emulation program. It is, in principle, very much like <b>minicom (1)</b>, 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>
When picocom starts it opens the terminal (serial
device) given as its non-option argument. Unless the
<b>--noinit</b> option is given, it configures the device to
the settings specified by the option-arguments (or to some
default settings), and sets it to &quot;raw&quot; mode. If
<b>--noinit</b> is given, the initialization and
configuration is skipped; the device is just opened. Following
this, picocom sets the standard-input and
standard-output to raw mode. Having done so, 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 &quot;escape
character&quot; (being by default &quot;C-a&quot;). 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 &quot;Commands&quot; section below.
</p>
<h2>COMMANDS</h2>
<p>
Commands are given to picocom by first keying the &quot;espace
character&quot; which by default is &quot;C-a&quot; (see &quot;Options&quot; below on how
to change it), and then keying one for the function (command)
characters shown here.
</p>
<p>
[escape character]: Send the escape character to the serial port
and return to &quot;transparent&quot; mode. This means that if the escape
character (&quot;C-a&quot;, by default) is typed twice, the program sends
the escape character to the serial port, and remains in
transparent mode.
</p>
<p>
[C-x]: Exit the program: if the <b>--noreset</b> 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>
<p>
[C-q]: Quit the program *without* reseting the serial port,
regardless of the <b>--noreset</b> option.
</p>
<p>
[C-p]: Pulse the DTR line. Lower it for 1 sec, and then raise it
again.
</p>
<p>
[C-t]: Toggle the DTR line. If DTR is up, then lower it. If it
is down, then raise it.
</p>
<p>
[C-backslash]: 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>
<p>
[C-u]: 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 HIGH_BAUD 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>
<p>
[C-d]: Baud down. Decrease the baud-rate. The list of baud-rates
stepped-through by this command is the same as for the &quot;baud-up&quot;
command.
</p>
<p>
[C-f]: Cycle through flow-control settings (RTS/CTS, XON/XOFF,
none).
</p>
<p>
[C-y]: Cycle through parity settings (even, odd, none).
</p>
<p>
[C-b]: Cycle through databits-number settings (5, 6, 7, 8).
</p>
<p>
[C-j]: Cycle through stopbits-number settings (1, 2).
</p>
<p>
[C-c]: Toggle local-echo mode.
</p>
<p>
[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. If an
actual port setting is different than 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 port
setting in parenthesis. Example: &quot;*** baud: 115200 (9600)&quot;. This
means that a baud rate of 115200bps has been selected (from the
command line, or using commands) 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 port setting are the same, only a
single value is shown. Example: &quot;*** baud: 9600&quot;.
</p>
<p>
[C-h] or [C-k]: Show help or show keys. Prints a short
description of all available function (command) keys.
</p>
<p>
[C-s]: Send (upload) a file (see &quot;Sending and Receiving Files&quot;
below)
</p>
<p>
[C-r]: Receive (download) a file (see &quot;Sending and Receiving
Files&quot; below)
</p>
<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>
<p>
C-a, C-u, C-a, C-u
</p>
<p>
assuming of-course that &quot;C-a&quot; is the escape character.
</p>
<p>
Commands that change program options ([C-u], [C-d], [C-f], etc)
also display a message showing the new option value. If the new
option value cannot be applied succesfully to the serial port
(for whatever reason), then the respective actual current port
setting is also shown. See the description of the [C-v] command,
above, for more on this.
</p>
<h2>SENDING AND RECEIVING FILES</h2>
<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>
<p><b>rx (1)</b>
- receive using the X-MODEM protocol</p>
<p><b>rb (1)</b>
- receive using the Y-MODEM protocol</p>
<p><b>rz (1)</b>
- receive using the Z-MODEM protocol</p>
<p><b>sx (1)</b>
- send using the X-MODEM protocol</p>
<p><b>sb (1)</b>
- send using the Y-MODEM protocol</p>
<p><b>sz (1)</b>
- send using the Z-MODEM protocol</p>
<p><b>ascii-xfr (1)</b>
- receive or transmit ASCII files</p>
<p>
The name of, and the command-line options to, the program to be
used for transmitting files are given by the
<b>--send-cmd</b> option. Similarly the program to receive
files, and its argumets, are given by the
<b>--receive-cmd</b> option. For example, in order to start
a picocom session that uses &quot;sz&quot; to transmit files, and
&quot;rz&quot; to receive files, you have to say something like this:
</p>
<p>
picocom --send-cmd &quot;sz -vv&quot; --receive-cmd &quot;rz -vv&quot;
</p>
<p>
If the argument to the <b>--send-cmd</b> option, or the
argument to the <b>--receive-cmd</b> 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>
<p>
picocom --send-cmd '' --receive-cmd ''
</p>
<p>
During the picocom session, if you key the &quot;send&quot; or &quot;receive&quot;
commands (e.g. by pressing C-a, C-s, or C-a, C-r) 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
pathname completion are available at this prompt, if you have
compiled picocom with support for the linenoise
library. Pressing 'C-c' 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 C-c, picocom will
start the the external program as specified by the
<b>--send-cmd</b>, or <b>--receive-cmd</b> 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
'C-c' while the external program is running will prematurely
terminate it, and return control to picocom. Pressing
'C-c' at any other time, has no special effect; the character is
normally passed to the serial port.
</p>
<h2>INPUT, OUTPUT, AND ECHO MAPPING</h2>
<p>
Using the <b>--imap</b>, <b>--omap</b>, and
<b>--emap</b> options you can make picocom map
(tranlate, replace) certain special characters after being read
from the serial port (with <b>--imap</b>), before being
written to the serial port (with <b>--omap</b>), and before
being locally echoed to the terminal (standard output) if local
echo is enabled (with <b>--emap</b>). These mapping options
take, each, a single argument which is a comma-separated list of
one or more of the following identifiers: &quot;crlf&quot; (map CR to LF),
&quot;crcrlf&quot; (map CR to CR + LF), &quot;igncr&quot; (ignore CR), &quot;lfcr&quot; (map
LF to CR), &quot;lfcrlf&quot; (map LF to CR + LF), &quot;ignlf&quot; (ignore LF),
&quot;bsdel&quot; (map BS --&gt; DEL), &quot;delbs&quot; (map DEL --&gt; BS)
</p>
<p>
For example the command:
</p>
<p>
picocom --omap crlf,delbs --imap inglf,bsdel --emap crcrlf ...
</p>
<p>
will: 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. 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. Replace every CR character with CR and LF when
echoing to the terminal (if local-echo is enabled).
</p>
<h2>Options</h2>
<p>
picocom accepts the following command-line options
</p>
<b><p>--baud | -b</p></b>
<p>
Defines the baud-rate to set the serial-port (terminal) to.
</p>
<b><p>--flow | -f</p></b>
<p>
Defines the flow-control mode to set the serial-port
to. Must be one of: 'x' for xon/xoff (software) mode, 'h'
for hardware flow control (RTS/CTS), 'n' for no flow
control. (Default: 'n')
</p>
<b><p>--parity | -p</p></b>
<p>
Defines the parity mode to set the serial-port to. Must be
one of: 'o' for odd parity mode, 'e' for even parity mode,
'n' for no parity mode. (Default: 'n')
</p>
<b><p>--databits | -d</p></b>
<p>
Defines the number of data bits in every character. Must be
one of: 5, 6, 7, 8. (Default: 8)
</p>
<b><p>--stopbits | -p</p></b>
<p>
Defines the number of stop bits in every character. Must be
one of: 1, or 2. (Default: 1)
</p>
<b><p>--esacpe | -e</p></b>
<p>
Defines the character that will make picocom enter
command-mode (see description above). If 'x' is given, then
C-x will make picocom enter command mode. (Default: 'a')
</p>
<b><p>--echo | -c</p></b>
<p>
Enable local echo. Every character being read from the
terminal (standard input) is echoed to the terminal
(standard output) subject to the echo-mapping configuration
(see <b>--emap</b> option. (Default: Disabled)
</p>
<b><p>--noinit | -i</p></b>
<p>
If given, picocom will not initialize, reset, or
otherwise meddle with the serial port at start-up. It will
just open it. This is useful, for example, for connecting
picocom to already-connected modems, or already
configured ports without terminating the connection, or
altering the settings. If required serial port parameters
can then be adjusted at run-time by commands.
</p>
<b><p>--noreset | -r</p></b>
<p>
If given, picocom will not *reset* the serial port
when exiting. It will just close the filedes and do nothing
more. This is useful, for example, for leaving modems
connected when exiting picocom. Regardless whether
the <b>--noreset</b> option is given the user can exit
picocom using the &quot;Quit&quot; command (instead of &quot;Exit&quot;),
which never resets the serial port. If <b>--noreset</b>
is given then &quot;Quit&quot; and &quot;Exit&quot; behave essentially the same.
</p>
<b><p>--nolock | -l</p></b>
<p>
If given, picocom will *not* 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. &quot;/var/lock/LCK..ttyS0&quot;) before opening the
port, or attempts to lock the port device-node using <b>flock (2)</b>. 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 <b>--nolock</b>
option is accepted, but has no effect.
</p>
<b><p>--send-cmd | -s</p></b>
<p>
Specifies the external program (and any arguments to it)
that will be used for transmitting files. If the argument to
<b>--send-cmd</b> is the empty string (''), the
send-file command is disabled. (Default: &quot;sz -vv&quot;)
</p>
<b><p>--receive-cmd | -v</p></b>
<p>
Specifies the external program (and any arguments to it)
that will be used for receiving files. If the argument to
<b>--receive-cmd</b> is the empty string (''), the
receive-file command is disabled. (Default: &quot;rz -vv&quot;)
</p>
<b><p>--imap</p></b>
<p>
Specifies the input character map (i.e. special characters
to be replaced when read from the serial port). Example:
&quot;--imap crlf,delbs&quot;. (Defaul: Empty)
</p>
<b><p>--omap</p></b>
<p>
Specifies the output character map (i.e. special characters
to be replaced before being written to serial
port). Example: &quot;--omap crcrlf,bsdel&quot;. (Defaul: Empty)
</p>
<b><p>--emap</p></b>
<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). Example: &quot;--emap
crcrlf,bsdel&quot;. (Defaul: delbs,crcrlf)
</p>
<b><p>--help | -h</p></b>
<p>
Print a short help message describing the command-line
options. picocom's version, compile-time options, and enabled
features are also shown.
</p>
<h2>AUTHOR</h2>
<p>picocom was written by Nick Patavalis (npat@efault.net)</p>
<h2>AVAILABILITY</h2>
<p>The latest release of &quot;picocom&quot; can be downloaded from: <a href = "https://github.com/npat-efault/picocom/releases">https://github.com/npat-efault/picocom/releases</a>
</p>
</td></tr></table></center>
</body>

608
picocom.8.ps
View File

@ -1,608 +0,0 @@
%!PS-Adobe-3.0
%%Creator: groff version 1.22.2
%%CreationDate: Wed Aug 19 00:17:32 2015
%%DocumentNeededResources: font Times-Roman
%%+ font Times-Bold
%%+ font Times-Italic
%%DocumentSuppliedResources: procset grops 1.22 2
%%Pages: 5
%%PageOrder: Ascend
%%DocumentMedia: Default 612 792 0 () ()
%%Orientation: Portrait
%%EndComments
%%BeginDefaults
%%PageMedia: Default
%%EndDefaults
%%BeginProlog
%%BeginResource: procset grops 1.22 2
%!PS-Adobe-3.0 Resource-ProcSet
/setpacking where{
pop
currentpacking
true setpacking
}if
/grops 120 dict dup begin
/SC 32 def
/A/show load def
/B{0 SC 3 -1 roll widthshow}bind def
/C{0 exch ashow}bind def
/D{0 exch 0 SC 5 2 roll awidthshow}bind def
/E{0 rmoveto show}bind def
/F{0 rmoveto 0 SC 3 -1 roll widthshow}bind def
/G{0 rmoveto 0 exch ashow}bind def
/H{0 rmoveto 0 exch 0 SC 5 2 roll awidthshow}bind def
/I{0 exch rmoveto show}bind def
/J{0 exch rmoveto 0 SC 3 -1 roll widthshow}bind def
/K{0 exch rmoveto 0 exch ashow}bind def
/L{0 exch rmoveto 0 exch 0 SC 5 2 roll awidthshow}bind def
/M{rmoveto show}bind def
/N{rmoveto 0 SC 3 -1 roll widthshow}bind def
/O{rmoveto 0 exch ashow}bind def
/P{rmoveto 0 exch 0 SC 5 2 roll awidthshow}bind def
/Q{moveto show}bind def
/R{moveto 0 SC 3 -1 roll widthshow}bind def
/S{moveto 0 exch ashow}bind def
/T{moveto 0 exch 0 SC 5 2 roll awidthshow}bind def
/SF{
findfont exch
[exch dup 0 exch 0 exch neg 0 0]makefont
dup setfont
[exch/setfont cvx]cvx bind def
}bind def
/MF{
findfont
[5 2 roll
0 3 1 roll
neg 0 0]makefont
dup setfont
[exch/setfont cvx]cvx bind def
}bind def
/level0 0 def
/RES 0 def
/PL 0 def
/LS 0 def
/MANUAL{
statusdict begin/manualfeed true store end
}bind def
/PLG{
gsave newpath clippath pathbbox grestore
exch pop add exch pop
}bind def
/BP{
/level0 save def
1 setlinecap
1 setlinejoin
DEFS/BPhook known{DEFS begin BPhook end}if
72 RES div dup scale
LS{
90 rotate
}{
0 PL translate
}ifelse
1 -1 scale
}bind def
/EP{
level0 restore
showpage
}def
/DA{
newpath arcn stroke
}bind def
/SN{
transform
.25 sub exch .25 sub exch
round .25 add exch round .25 add exch
itransform
}bind def
/DL{
SN
moveto
SN
lineto stroke
}bind def
/DC{
newpath 0 360 arc closepath
}bind def
/TM matrix def
/DE{
TM currentmatrix pop
translate scale newpath 0 0 .5 0 360 arc closepath
TM setmatrix
}bind def
/RC/rcurveto load def
/RL/rlineto load def
/ST/stroke load def
/MT/moveto load def
/CL/closepath load def
/Fr{
setrgbcolor fill
}bind def
/setcmykcolor where{
pop
/Fk{
setcmykcolor fill
}bind def
}if
/Fg{
setgray fill
}bind def
/FL/fill load def
/LW/setlinewidth load def
/Cr/setrgbcolor load def
/setcmykcolor where{
pop
/Ck/setcmykcolor load def
}if
/Cg/setgray load def
/RE{
findfont
dup maxlength 1 index/FontName known not{1 add}if dict begin
{
1 index/FID ne
2 index/UniqueID ne
and
{def}{pop pop}ifelse
}forall
/Encoding exch def
dup/FontName exch def
currentdict end definefont pop
}bind def
/DEFS 0 def
/EBEGIN{
moveto
DEFS begin
}bind def
/EEND/end load def
/CNT 0 def
/level1 0 def
/PBEGIN{
/level1 save def
translate
div 3 1 roll div exch scale
neg exch neg exch translate
0 setgray
0 setlinecap
1 setlinewidth
0 setlinejoin
10 setmiterlimit
[]0 setdash
/setstrokeadjust where{
pop
false setstrokeadjust
}if
/setoverprint where{
pop
false setoverprint
}if
newpath
/CNT countdictstack def
userdict begin
/showpage{}def
/setpagedevice{}def
mark
}bind def
/PEND{
cleartomark
countdictstack CNT sub{end}repeat
level1 restore
}bind def
end def
/setpacking where{
pop
setpacking
}if
%%EndResource
%%EndProlog
%%BeginSetup
%%BeginFeature: *PageSize Default
<< /PageSize [ 612 792 ] /ImagingBBox null >> setpagedevice
%%EndFeature
%%IncludeResource: font Times-Roman
%%IncludeResource: font Times-Bold
%%IncludeResource: font Times-Italic
grops begin/DEFS 1 dict def DEFS begin/u{.001 mul}bind def end/RES 72
def/PL 792 def/LS false def/ENC0[/asciicircum/asciitilde/Scaron/Zcaron
/scaron/zcaron/Ydieresis/trademark/quotesingle/Euro/.notdef/.notdef
/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef
/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef
/.notdef/.notdef/space/exclam/quotedbl/numbersign/dollar/percent
/ampersand/quoteright/parenleft/parenright/asterisk/plus/comma/hyphen
/period/slash/zero/one/two/three/four/five/six/seven/eight/nine/colon
/semicolon/less/equal/greater/question/at/A/B/C/D/E/F/G/H/I/J/K/L/M/N/O
/P/Q/R/S/T/U/V/W/X/Y/Z/bracketleft/backslash/bracketright/circumflex
/underscore/quoteleft/a/b/c/d/e/f/g/h/i/j/k/l/m/n/o/p/q/r/s/t/u/v/w/x/y
/z/braceleft/bar/braceright/tilde/.notdef/quotesinglbase/guillemotleft
/guillemotright/bullet/florin/fraction/perthousand/dagger/daggerdbl
/endash/emdash/ff/fi/fl/ffi/ffl/dotlessi/dotlessj/grave/hungarumlaut
/dotaccent/breve/caron/ring/ogonek/quotedblleft/quotedblright/oe/lslash
/quotedblbase/OE/Lslash/.notdef/exclamdown/cent/sterling/currency/yen
/brokenbar/section/dieresis/copyright/ordfeminine/guilsinglleft
/logicalnot/minus/registered/macron/degree/plusminus/twosuperior
/threesuperior/acute/mu/paragraph/periodcentered/cedilla/onesuperior
/ordmasculine/guilsinglright/onequarter/onehalf/threequarters
/questiondown/Agrave/Aacute/Acircumflex/Atilde/Adieresis/Aring/AE
/Ccedilla/Egrave/Eacute/Ecircumflex/Edieresis/Igrave/Iacute/Icircumflex
/Idieresis/Eth/Ntilde/Ograve/Oacute/Ocircumflex/Otilde/Odieresis
/multiply/Oslash/Ugrave/Uacute/Ucircumflex/Udieresis/Yacute/Thorn
/germandbls/agrave/aacute/acircumflex/atilde/adieresis/aring/ae/ccedilla
/egrave/eacute/ecircumflex/edieresis/igrave/iacute/icircumflex/idieresis
/eth/ntilde/ograve/oacute/ocircumflex/otilde/odieresis/divide/oslash
/ugrave/uacute/ucircumflex/udieresis/yacute/thorn/ydieresis]def
/Times-Italic@0 ENC0/Times-Italic RE/Times-Bold@0 ENC0/Times-Bold RE
/Times-Roman@0 ENC0/Times-Roman RE
%%EndSetup
%%Page: 1 1
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@0 SF 131.795(picocom\(8\) System)72 48 R(Manager')2.5
E 2.5(sM)-.55 G 131.795(anual picocom\(8\))-2.5 F/F1 10.95/Times-Bold@0
SF -.219(NA)72 84 S(ME).219 E F0
(picocom \255 minimal dumb-terminal emulation program)108 96 Q F1
(SYNOPSIS)72 112.8 Q/F2 10/Times-Bold@0 SF(picocom [)108 124.8 Q/F3 10
/Times-Italic@0 SF(options)2.5 E F2(])2.5 E F3(de)2.5 E(vice)-.15 E F1
(DESCRIPTION)72 141.6 Q F0 1.497(As its name suggests, picocom is a min\
imal dumb-terminal emulation program. It is, in principle, v)108 153.6 R
(ery)-.15 E 1.141(much lik)108 165.6 R(e)-.1 E F2(minicom\(1\))3.641 E
F0 3.641(,o)C 1.141(nly it')-3.641 F 3.641(s")-.55 G 1.141
(pico" instead of "mini"! It w)-3.641 F 1.141(as designed to serv)-.1 F
3.641(ea)-.15 G 3.642(sas)-3.641 G 1.142(imple, manual,)-3.642 F .462
(modem con\214guration, testing, and deb)108 177.6 R .461
(ugging tool. It has also serv)-.2 F .461(ed \(quite well\) as a lo)-.15
F .461(w-tech serial com-)-.25 F .21(munications program to allo)108
189.6 R 2.71(wa)-.25 G .21(ccess to all types of de)-2.71 F .21
(vices that pro)-.25 F .21(vide serial consoles. It could also pro)-.15
F -.15(ve)-.15 G(useful in man)108 201.6 Q 2.5(yo)-.15 G
(ther similar tasks.)-2.5 E 1.563
(When picocom starts it opens the terminal \(serial de)108 225.6 R 1.563
(vice\) gi)-.25 F -.15(ve)-.25 G 4.063(na).15 G 4.062(si)-4.063 G 1.562
(ts non-option ar)-4.062 F 1.562(gument. Unless the)-.18 F F2(--noinit)
108 237.6 Q F0 1.271(option is gi)3.771 F -.15(ve)-.25 G 1.272
(n, it con\214gures the de).15 F 1.272
(vice to the settings speci\214ed by the option-ar)-.25 F 1.272
(guments \(or to)-.18 F .429(some def)108 249.6 R .429
(ault settings\), and sets it to "ra)-.1 F .429(w" mode. If)-.15 F F2
(--noinit)2.929 E F0 .429(is gi)2.929 F -.15(ve)-.25 G .428
(n, the initialization and con\214guration is).15 F .746
(skipped; the de)108 261.6 R .746(vice is just opened. F)-.25 F(ollo)
-.15 E .747
(wing this, picocom sets the standard-input and standard-output to)-.25
F(ra)108 273.6 Q 3.289(wm)-.15 G .789(ode. Ha)-3.289 F .789(ving done s\
o, it goes in a loop where it listens for input from stdin, or from the\
serial port.)-.2 F .589(Input from the serial port is copied to the st\
andard output while input from the standard input is copied to)108 285.6
R .331(the serial port. picocom also scans its input stream for a user)
108 297.6 R .33(-speci\214ed control character)-.2 F 2.83(,c)-.4 G .33
(alled the "escape)-2.83 F .554(character" \(being by def)108 309.6 R
.555(ault "C-a"\). If the escape character is seen, then instead of sen\
ding it to the serial-)-.1 F(de)108 321.6 Q .179
(vice, the program enters "command mode" and w)-.25 F .179
(aits for the ne)-.1 F .178
(xt character \(which is called the "function)-.15 F 1.652
(character"\). Depending on the v)108 333.6 R 1.652
(alue of the function character)-.25 F 4.152(,p)-.4 G 1.652
(icocom performs one of the operations)-4.152 F
(described in the "Commands" section belo)108 345.6 Q -.65(w.)-.25 G F1
(COMMANDS)72 362.4 Q F0 1.657(Commands are gi)108 374.4 R -.15(ve)-.25 G
4.157(nt).15 G 4.157(op)-4.157 G 1.657(icocom by \214rst k)-4.157 F -.15
(ey)-.1 G 1.657(ing the "espace character" which by def).15 F 1.656
(ault is "C-a" \(see)-.1 F .671("Options" belo)108 386.4 R 3.171(wo)-.25
G 3.172(nh)-3.171 G 1.172 -.25(ow t)-3.172 H 3.172(oc).25 G .672
(hange it\), and then k)-3.172 F -.15(ey)-.1 G .672
(ing one for the function \(command\) characters sho).15 F(wn)-.25 E
(here.)108 398.4 Q 1.82([escape character]: Send the escape character t\
o the serial port and return to "transparent" mode. This)108 422.4 R .06
(means that if the escape character \("C-a", by def)108 434.4 R .06
(ault\) is typed twice, the program sends the escape character)-.1 F
(to the serial port, and remains in transparent mode.)108 446.4 Q .248
([C-x]: Exit the program: if the)108 470.4 R F2(--nor)2.748 E(eset)-.18
E F0 .248(option w)2.748 F .248(as not gi)-.1 F -.15(ve)-.25 G 2.747(nt)
.15 G .247(hen the serial port is reset to its original set-)-2.747 F
(tings before e)108 482.4 Q(xiting; if it w)-.15 E(as gi)-.1 E -.15(ve)
-.25 G 2.5(nt).15 G(he serial port is not reset.)-2.5 E
([C-q]: Quit the program *without* reseting the serial port, re)108
506.4 Q -.05(ga)-.15 G(rdless of the).05 E F2(--nor)2.5 E(eset)-.18 E F0
(option.)2.5 E([C-p]: Pulse the DTR line. Lo)108 530.4 Q
(wer it for 1 sec, and then raise it ag)-.25 E(ain.)-.05 E([C-t]: T)108
554.4 Q(oggle the DTR line. If DTR is up, then lo)-.8 E
(wer it. If it is do)-.25 E(wn, then raise it.)-.25 E 1.66([C-backslash\
]: Generate a break sequence on the serial line. A break sequence is us\
ually generated by)108 578.4 R .472(marking \(dri)108 590.4 R .471(ving\
to logical one\) the serial Tx line for an amount of time coresponding\
to se)-.25 F -.15(ve)-.25 G .471(ral character).15 F(durations.)108
602.4 Q .442([C-u]: Baud up. Increase the baud-rate. The list of baud-r\
ates stepped-through by this command is: 50, 75,)108 626.4 R .044(110, \
134, 150, 200, 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 1\
15200. If HIGH_B)108 638.4 R -.55(AU)-.35 G 2.543(Ds).55 G(up-)-2.543 E
1.705(port is compiled in, then the follo)108 650.4 R 1.705
(wing baud-rates are also added to the list: 230400, 460800, 500000,)
-.25 F .757(576000, 921600, 1000000, 1152000, 1500000, 2000000, 2500000\
, 3000000, 3500000, 4000000. Depend-)108 662.4 R(ing on you system, an)
108 674.4 Q 2.5(yo)-.15 G 2.5(ft)-2.5 G
(he higher baud rates may be missing.)-2.5 E .655([C-d]: Baud do)108
698.4 R .655(wn. Decrease the baud-rate. The list of baud-rates stepped\
-through by this command is the)-.25 F
(same as for the "baud-up" command.)108 710.4 Q 187.62(Manuals User)72
768 R(1)219.56 E 0 Cg EP
%%Page: 2 2
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@0 SF 131.795(picocom\(8\) System)72 48 R(Manager')2.5
E 2.5(sM)-.55 G 131.795(anual picocom\(8\))-2.5 F
([C-f]: Cycle through \215o)108 84 Q(w-control settings \(R)-.25 E
(TS/CTS, XON/XOFF)-.6 E 2.5(,n)-.8 G(one\).)-2.5 E
([C-y]: Cycle through parity settings \(e)108 108 Q -.15(ve)-.25 G
(n, odd, none\).).15 E
([C-b]: Cycle through databits-number settings \(5, 6, 7, 8\).)108 132 Q
([C-j]: Cycle through stopbits-number settings \(1, 2\).)108 156 Q
([C-c]: T)108 180 Q(oggle local-echo mode.)-.8 E .674([C-v]: Sho)108 204
R 3.174(wp)-.25 G .674(rogram options \(lik)-3.174 F 3.174(eb)-.1 G .674
(aud rate, data bits, etc\) as well as the actual serial port settings.\
Only)-3.174 F .2(the options and port settings that can be modi\214ed \
online \(through commands\) are sho)108 216 R .2(wn, not those that can)
-.25 F .158
(only be set at the command-line. If an actual port setting is dif)108
228 R .157(ferent than the current v)-.25 F .157(alue of the respecti)
-.25 F -.15(ve)-.25 G .358(option \(for whate)108 240 R -.15(ve)-.25 G
2.858(rr).15 G .358(eason\) then the v)-2.858 F .358
(alue of the option is sho)-.25 F .359(wn, follo)-.25 F .359
(wed by the v)-.25 F .359(alue of the actual port)-.25 F .278(setting i\
n parenthesis. Example: "*** baud: 115200 \(9600\)". This means that a \
baud rate of 115200bps has)108 252 R 1.652
(been selected \(from the command line, or using commands\) b)108 264 R
1.652(ut the serial port is actually operating at)-.2 F .76
(9600bps \(the dri)108 276 R -.15(ve)-.25 G 3.26(rm).15 G .759(ay not s\
upport the higher setting, and has silently replaced it with a safe def)
-3.26 F .759(ault, or)-.1 F .341(the setting may ha)108 288 R .642 -.15
(ve b)-.2 H .342(een changed from outside picocom\). If the option and \
the corresponding port setting).15 F(are the same, only a single v)108
300 Q(alue is sho)-.25 E(wn. Example: "*** baud: 9600".)-.25 E 1.402
([C-h] or [C-k]: Sho)108 324 R 3.902(wh)-.25 G 1.401(elp or sho)-3.902 F
3.901(wk)-.25 G -.15(ey)-4.001 G 1.401
(s. Prints a short description of all a).15 F -.25(va)-.2 G 1.401
(ilable function \(command\)).25 F -.1(ke)108 336 S(ys.)-.05 E
([C-s]: Send \(upload\) a \214le \(see "Sending and Recei)108 360 Q
(ving Files" belo)-.25 E(w\))-.25 E([C-r]: Recei)108 384 Q .3 -.15
(ve \()-.25 H(do).15 E(wnload\) a \214le \(see "Sending and Recei)-.25 E
(ving Files" belo)-.25 E(w\))-.25 E .054
(After performing one of the abo)108 408 R .354 -.15(ve o)-.15 H .054
(perations the program lea).15 F -.15(ve)-.2 G 2.554(st).15 G .054
(he command mode and enters transparent)-2.554 F(mode. Example: T)108
420 Q 2.5(oi)-.8 G(ncrease the baud-rate by tw)-2.5 E 2.5(os)-.1 G
(teps, you ha)-2.5 E .3 -.15(ve t)-.2 H 2.5(ot).15 G(ype:)-2.5 E
(C-a, C-u, C-a, C-u)108 444 Q
(assuming of-course that "C-a" is the escape character)108 468 Q(.)-.55
E .505(Commands that change program options \([C-u], [C-d], [C-f], etc\
\) also display a message sho)108 492 R .504(wing the ne)-.25 F(w)-.25 E
.37(option v)108 504 R .37(alue. If the ne)-.25 F 2.87(wo)-.25 G .37
(ption v)-2.87 F .371
(alue cannot be applied succesfully to the serial port \(for whate)-.25
F -.15(ve)-.25 G 2.871(rr).15 G(eason\),)-2.871 E 1.316
(then the respecti)108 516 R 1.616 -.15(ve a)-.25 H 1.316
(ctual current port setting is also sho).15 F 1.315
(wn. See the description of the [C-v] command,)-.25 F(abo)108 528 Q -.15
(ve)-.15 G 2.5(,f).15 G(or more on this.)-2.5 E/F1 10.95/Times-Bold@0 SF
(SENDING AND RECEIVING FILES)72 544.8 Q F0 .496
(picocom can send and recei)108 556.8 R .796 -.15(ve \214)-.25 H .496
(les o).15 F -.15(ve)-.15 G 2.996(rt).15 G .496(he serial port using e)
-2.996 F .497(xternal programs that implement the respec-)-.15 F(ti)108
568.8 Q .3 -.15(ve p)-.25 H
(rotocols. In Linux typical programs for this purpose are:).15 E/F2 10
/Times-Bold@0 SF(rx\(1\))108 592.8 Q F0 2.5(-r)2.5 G(ecei)-2.5 E .3 -.15
(ve u)-.25 H(sing the X-MODEM protocol).15 E F2(rb\(1\))108 616.8 Q F0
2.5(-r)2.5 G(ecei)-2.5 E .3 -.15(ve u)-.25 H(sing the Y).15 E
(-MODEM protocol)-1.11 E F2(rz\(1\))108 640.8 Q F0 2.5(-r)2.5 G(ecei)
-2.5 E .3 -.15(ve u)-.25 H(sing the Z-MODEM protocol).15 E F2(sx\(1\))
108 664.8 Q F0 2.5(-s)2.5 G(end using the X-MODEM protocol)-2.5 E F2
(sb\(1\))108 688.8 Q F0 2.5(-s)2.5 G(end using the Y)-2.5 E
(-MODEM protocol)-1.11 E F2(sz\(1\))108 712.8 Q F0 2.5(-s)2.5 G
(end using the Z-MODEM protocol)-2.5 E 187.62(Manuals User)72 768 R(2)
219.56 E 0 Cg EP
%%Page: 3 3
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@0 SF 131.795(picocom\(8\) System)72 48 R(Manager')2.5
E 2.5(sM)-.55 G 131.795(anual picocom\(8\))-2.5 F/F1 10/Times-Bold@0 SF
(ascii-xfr\(1\))108 84 Q F0 2.5(-r)2.5 G(ecei)-2.5 E .3 -.15(ve o)-.25 H
2.5(rt).15 G(ransmit ASCII \214les)-2.5 E .692(The name of, and the com\
mand-line options to, the program to be used for transmitting \214les a\
re gi)108 108 R -.15(ve)-.25 G 3.191(nb).15 G(y)-3.191 E(the)108 120 Q
F1(--send-cmd)2.905 E F0 .405(option. Similarly the program to recei)
2.905 F .706 -.15(ve \214)-.25 H .406(les, and its ar).15 F .406
(gumets, are gi)-.18 F -.15(ve)-.25 G 2.906(nb).15 G 2.906(yt)-2.906 G
(he)-2.906 E F1(--r)2.906 E(ecei)-.18 E -.1(ve)-.1 G(-).1 E(cmd)108 132
Q F0 1.048(option. F)3.548 F 1.048(or e)-.15 F 1.047(xample, in order t\
o start a picocom session that uses "sz" to transmit \214les, and "rz" \
to)-.15 F(recei)108 144 Q .3 -.15(ve \214)-.25 H(les, you ha).15 E .3
-.15(ve t)-.2 H 2.5(os).15 G(ay something lik)-2.5 E 2.5(et)-.1 G(his:)
-2.5 E(picocom --send-cmd "sz -vv" --recei)108 168 Q -.15(ve)-.25 G
(-cmd "rz -vv").15 E .377(If the ar)108 192 R .377(gument to the)-.18 F
F1(--send-cmd)2.877 E F0 .377(option, or the ar)2.877 F .377
(gument to the)-.18 F F1(--r)2.877 E(ecei)-.18 E -.1(ve)-.1 G(-cmd).1 E
F0 .377(option is the empty string,)2.877 F .191(then the respecti)108
204 R .491 -.15(ve c)-.25 H .191(ommand is disabled. F).15 F .191(or e)
-.15 F .19(xample, in order to disable both the "send" and the "recei)
-.15 F -.15(ve)-.25 G(").15 E(commands you can in)108 216 Q -.2(vo)-.4 G
.2 -.1(ke p).2 H(icocom lik).1 E 2.5(et)-.1 G(his:)-2.5 E
(picocom --send-cmd ')108 240 Q 2.5('-)-.74 G(-recei)-2.5 E -.15(ve)-.25
G(-cmd ').15 E(')-.74 E .309(During the picocom session, if you k)108
264 R .609 -.15(ey t)-.1 H .309(he "send" or "recei).15 F -.15(ve)-.25 G
2.809("c).15 G .309(ommands \(e.g. by pressing C-a, C-s, or C-)-2.809 F
.431(a, C-r\) you will be prompted for a \214lename. At this prompt you\
can enter one or more \214le-names, and an)108 276 R(y)-.15 E .532
(additional ar)108 288 R .533(guments to the transmission or reception \
program. Command-line editing and pathname com-)-.18 F .983
(pletion are a)108 300 R -.25(va)-.2 G .983
(ilable at this prompt, if you ha).25 F 1.282 -.15(ve c)-.2 H .982
(ompiled picocom with support for the linenoise library).15 F(.)-.65 E
.077(Pressing 'C-c' at this prompt will cancel the \214le transfer comm\
and and return to normal picocom operation.)108 312 R .597(After enteri\
ng a \214lename \(and / or additional transmission or reception program\
ar)108 324 R .597(guments\) and assuming)-.18 F .478(you ha)108 336 R
.778 -.15(ve n)-.2 H .479(ot canceled the operation by pressing C-c, pi\
cocom will start the the e).15 F .479(xternal program as speci-)-.15 F
1.389(\214ed by the)108 348 R F1(--send-cmd)3.889 E F0 3.889(,o)C(r)
-3.889 E F1(--r)3.889 E(ecei)-.18 E -.1(ve)-.1 G(-cmd).1 E F0 1.389
(option, and with an)3.889 F 3.888<798c>-.15 G 1.388
(lenames and additional ar)-3.888 F 1.388(guments you)-.18 F .804
(may ha)108 360 R 1.104 -.15(ve s)-.2 H .805
(upplied. The standard input and output of the e).15 F .805
(xternal program will be connected to the serial)-.15 F .853
(port. The standard error of the e)108 372 R .852(xternal program will \
be connected to the terminal which---while the pro-)-.15 F .544
(gram is running---will re)108 384 R -.15(ve)-.25 G .545
(rt to canonical mode. Pressing 'C-c' while the e).15 F .545
(xternal program is running will)-.15 F 1.128(prematurely terminate it,\
and return control to picocom. Pressing 'C-c' at an)108 396 R 3.628(yo)
-.15 G 1.128(ther time, has no special)-3.628 F(ef)108 408 Q
(fect; the character is normally passed to the serial port.)-.25 E/F2
10.95/Times-Bold@0 SF(INPUT)72 424.8 Q 2.738(,O)-.81 G(UTPUT)-2.738 E
2.738(,A)-.81 G(ND ECHO MAPPING)-2.738 E F0 .442(Using the)108 436.8 R
F1(--imap)2.942 E F0(,)A F1(--omap)2.942 E F0 2.942(,a)C(nd)-2.942 E F1
(--emap)2.942 E F0 .443(options you can mak)2.943 F 2.943(ep)-.1 G .443
(icocom map \(tranlate, replace\) certain spe-)-2.943 F 1.072
(cial characters after being read from the serial port \(with)108 448.8
R F1(--imap)3.572 E F0 1.071
(\), before being written to the serial port)B(\(with)108 460.8 Q F1
(--omap)3.446 E F0 .946(\), and before being locally echoed to the term\
inal \(standard output\) if local echo is enabled)B(\(with)108 472.8 Q
F1(--emap)3.62 E F0 1.12(\). These mapping options tak)B 1.12
(e, each, a single ar)-.1 F 1.12
(gument which is a comma-separated list of)-.18 F 1.122
(one or more of the follo)108 484.8 R 1.123(wing identi\214ers: "crlf" \
\(map CR to LF\), "crcrlf" \(map CR to CR + LF\), "igncr")-.25 F .017(\
\(ignore CR\), "lfcr" \(map LF to CR\), "lfcrlf" \(map LF to CR + LF\),\
"ignlf" \(ignore LF\), "bsdel" \(map BS -->)108 496.8 R
(DEL\), "delbs" \(map DEL --> BS\))108 508.8 Q -.15(Fo)108 532.8 S 2.5
(re).15 G(xample the command:)-2.65 E
(picocom --omap crlf,delbs --imap inglf,bsdel --emap crcrlf ...)108
556.8 Q .86(will: Replace e)108 580.8 R -.15(ve)-.25 G .86(ry CR \(carr\
iage return, 0x0d\) caracter with LF \(line feed, 0x0a\) and e).15 F
-.15(ve)-.25 G .86(ry DEL \(delete,).15 F .054(0x7f\) character with BS\
\(backspace, 0x08\) before writing it to the serial port. Ignore \(not\
write to the termi-)108 592.8 R .781(nal\) e)108 604.8 R -.15(ve)-.25 G
.781(ry LF character read from the serial port and replace e).15 F -.15
(ve)-.25 G .781(ry BS character read from the serial port).15 F 1.42
(with DEL. Replace e)108 616.8 R -.15(ve)-.25 G 1.42(ry CR character wi\
th CR and LF when echoing to the terminal \(if local-echo is).15 F
(enabled\).)108 628.8 Q F2(OPTIONS)72 645.6 Q F0
(picocom accepts the follo)108 657.6 Q(wing command-line options)-.25 E
F1(--baud | -b)108 674.4 Q F0
(De\214nes the baud-rate to set the serial-port \(terminal\) to.)144
686.4 Q F1(--\215o)108 703.2 Q 2.5(w|-)-.1 G(f)-2.5 E F0 .33
(De\214nes the \215o)144 715.2 R .33(w-control mode to set the serial-p\
ort to. Must be one of: 'x' for xon/xof)-.25 F 2.83(f\()-.25 G(softw)
-2.83 E(are\))-.1 E(mode, 'h' for hardw)144 727.2 Q(are \215o)-.1 E 2.5
(wc)-.25 G(ontrol \(R)-2.5 E(TS/CTS\), 'n' for no \215o)-.6 E 2.5(wc)
-.25 G(ontrol. \(Def)-2.5 E(ault: 'n'\))-.1 E 187.62(Manuals User)72 768
R(3)219.56 E 0 Cg EP
%%Page: 4 4
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@0 SF 131.795(picocom\(8\) System)72 48 R(Manager')2.5
E 2.5(sM)-.55 G 131.795(anual picocom\(8\))-2.5 F/F1 10/Times-Bold@0 SF
(--parity | -p)108 84 Q F0 .685(De\214nes the parity mode to set the se\
rial-port to. Must be one of: 'o' for odd parity mode, 'e' for)144 96 R
-2.15 -.25(ev e)144 108 T 2.5(np).25 G
(arity mode, 'n' for no parity mode. \(Def)-2.5 E(ault: 'n'\))-.1 E F1
(--databits | -d)108 124.8 Q F0(De\214nes the number of data bits in e)
144 136.8 Q -.15(ve)-.25 G(ry character).15 E 2.5(.M)-.55 G
(ust be one of: 5, 6, 7, 8. \(Def)-2.5 E(ault: 8\))-.1 E F1
(--stopbits | -p)108 153.6 Q F0(De\214nes the number of stop bits in e)
144 165.6 Q -.15(ve)-.25 G(ry character).15 E 2.5(.M)-.55 G
(ust be one of: 1, or 2. \(Def)-2.5 E(ault: 1\))-.1 E F1(--esacpe | -e)
108 182.4 Q F0 .329(De\214nes the character that will mak)144 194.4 R
2.829(ep)-.1 G .329(icocom enter command-mode \(see description abo)
-2.829 F -.15(ve)-.15 G .33(\). If 'x').15 F(is gi)144 206.4 Q -.15(ve)
-.25 G(n, then C-x will mak).15 E 2.5(ep)-.1 G
(icocom enter command mode. \(Def)-2.5 E(ault: 'a'\))-.1 E F1
(--echo | -c)108 223.2 Q F0 .602(Enable local echo. Ev)144 235.2 R .602
(ery character being read from the terminal \(standard input\) is echoe\
d to the)-.15 F .004(terminal \(standard output\) subject to the echo-m\
apping con\214guration \(see)144 247.2 R F1(--emap)2.505 E F0 .005
(option. \(Def)2.505 F(ault:)-.1 E(Disabled\))144 259.2 Q F1
(--noinit | -i)108 276 Q F0 .785(If gi)144 288 R -.15(ve)-.25 G .785(n,\
picocom will not initialize, reset, or otherwise meddle with the seria\
l port at start-up. It).15 F 2.742
(will just open it. This is useful, for e)144 300 R 2.743
(xample, for connecting picocom to already-connected)-.15 F .038(modems\
, or already con\214gured ports without terminating the connection, or \
altering the settings. If)144 312 R(required serial port parameters can\
then be adjusted at run-time by commands.)144 324 Q F1(--nor)108 340.8
Q(eset | -r)-.18 E F0 .396(If gi)144 352.8 R -.15(ve)-.25 G .396
(n, picocom will not *reset* the serial port when e).15 F .397
(xiting. It will just close the \214ledes and do)-.15 F .696
(nothing more. This is useful, for e)144 364.8 R .696(xample, for lea)
-.15 F .696(ving modems connected when e)-.2 F .696(xiting picocom.)-.15
F(Re)144 376.8 Q -.05(ga)-.15 G .422(rdless whether the).05 F F1(--nor)
2.922 E(eset)-.18 E F0 .422(option is gi)2.922 F -.15(ve)-.25 G 2.922
(nt).15 G .422(he user can e)-2.922 F .422
(xit picocom using the "Quit" com-)-.15 F .706
(mand \(instead of "Exit"\), which ne)144 388.8 R -.15(ve)-.25 G 3.206
(rr).15 G .706(esets the serial port. If)-3.206 F F1(--nor)3.205 E(eset)
-.18 E F0 .705(is gi)3.205 F -.15(ve)-.25 G 3.205(nt).15 G .705
(hen "Quit" and)-3.205 F("Exit" beha)144 400.8 Q .3 -.15(ve e)-.2 H
(ssentially the same.).15 E F1(--nolock | -l)108 417.6 Q F0 .139(If gi)
144 429.6 R -.15(ve)-.25 G .139(n, picocom will *not* attempt to lock t\
he serial port before opening it. Normally).15 F 2.64(,d)-.65 G
(epending)-2.64 E 8.802(on ho)144 441.6 R 11.302(wi)-.25 G(t')-11.302 E
11.302(sc)-.55 G 8.802
(ompiled, picocom attempts to get a UUCP-style lock-\214le \(e.g.)
-11.302 F("/v)144 453.6 Q 1.323(ar/lock/LCK..ttyS0"\) before opening th\
e port, or attempts to lock the port de)-.25 F 1.324(vice-node using)
-.25 F F1(\215ock\(2\))144 465.6 Q F0 2.892(.F)C .391
(ailing to do so, results in the program e)-3.042 F .391
(xiting after emitting an error)-.15 F .391(-message. It is pos-)-.2 F
.698(sible that your picocom binary is compiled without support for loc\
king. In this case the)144 477.6 R F1(--nolock)3.198 E F0
(option is accepted, b)144 489.6 Q(ut has no ef)-.2 E(fect.)-.25 E F1
(--send-cmd | -s)108 506.4 Q F0 .46(Speci\214es the e)144 518.4 R .46
(xternal program \(and an)-.15 F 2.96(ya)-.15 G -.18(rg)-2.96 G .46
(uments to it\) that will be used for transmitting \214les. If).18 F
.663(the ar)144 530.4 R .663(gument to)-.18 F F1(--send-cmd)3.163 E F0
.663(is the empty string \(')3.163 F .664
('\), the send-\214le command is disabled. \(Def)-.74 F(ault:)-.1 E
("sz -vv"\))144 542.4 Q F1(--r)108 559.2 Q(ecei)-.18 E -.1(ve)-.1 G
(-cmd | -v).1 E F0 .237(Speci\214es the e)144 571.2 R .237
(xternal program \(and an)-.15 F 2.737(ya)-.15 G -.18(rg)-2.737 G .236
(uments to it\) that will be used for recei).18 F .236
(ving \214les. If the)-.25 F(ar)144 583.2 Q .286(gument to)-.18 F F1
(--r)2.786 E(ecei)-.18 E -.1(ve)-.1 G(-cmd).1 E F0 .286
(is the empty string \(')2.786 F .286('\), the recei)-.74 F -.15(ve)-.25
G .286(-\214le command is disabled. \(Def).15 F(ault:)-.1 E("rz -vv"\))
144 595.2 Q F1(--imap)108 612 Q F0 .575(Speci\214es the input character\
map \(i.e. special characters to be replaced when read from the serial)
144 612 R(port\). Example: "--imap crlf,delbs". \(Def)144 624 Q
(aul: Empty\))-.1 E F1(--omap)108 640.8 Q F0 1.031(Speci\214es the outp\
ut character map \(i.e. special characters to be replaced before being \
written to)144 640.8 R
(serial port\). Example: "--omap crcrlf,bsdel". \(Def)144 652.8 Q
(aul: Empty\))-.1 E F1(--emap)108 669.6 Q F0 .408(Speci\214es the local\
-echo character map \(i.e. special characters to be replaced before bei\
ng echoed-)144 669.6 R 4.24(back to the terminal, if local-echo is enab\
led\). Example: "--emap crcrlf,bsdel". \(Def)144 681.6 R(aul:)-.1 E
(delbs,crcrlf\))144 693.6 Q 187.62(Manuals User)72 768 R(4)219.56 E 0 Cg
EP
%%Page: 5 5
%%BeginPageSetup
BP
%%EndPageSetup
/F0 10/Times-Roman@0 SF 131.795(picocom\(8\) System)72 48 R(Manager')2.5
E 2.5(sM)-.55 G 131.795(anual picocom\(8\))-2.5 F/F1 10/Times-Bold@0 SF
(--help | -h)108 84 Q F0 .335(Print a short help message describing the\
command-line options. picocom')144 96 R 2.834(sv)-.55 G .334
(ersion, compile-time)-2.984 F
(options, and enabled features are also sho)144 108 Q(wn.)-.25 E/F2
10.95/Times-Bold@0 SF -.548(AU)72 124.8 S(THOR).548 E F0(picocom w)108
136.8 Q(as written by Nick P)-.1 E(ata)-.15 E -.25(va)-.2 G
(lis \(npat@ef).25 E(ault.net\))-.1 E F2 -1.04 -1.588(AV A)72 153.6 T
(ILABILITY)1.588 E F0 5.319(The latest release of "picocom" can be do)
108 165.6 R 5.319(wnloaded from:)-.25 F F1(https://github)7.819 E
(.com/npat-efault/pico-)-.4 E(com/r)108 177.6 Q(eleases)-.18 E F0 187.62
(Manuals User)72 768 R(5)219.56 E 0 Cg EP
%%Trailer
end
%%EOF

509
picocom.8.xml
View File

@ -1,509 +0,0 @@
<?xml version="1.0" standalone='no'?>
<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
<manpage
name="picocom"
section="8"
desc="minimal dumb-terminal emulation program">
<synopsis>
<cmd>picocom [ <arg>options</arg> ] <arg>device</arg></cmd>
</synopsis>
<description>
<p>
As its name suggests, <b>picocom</b> is a minimal dumb-terminal
emulation program. It is, in principle, very much like <manref
name="minicom" section="1"/>, 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>
When <b>picocom</b> starts it opens the terminal (serial
device) given as its non-option argument. Unless the
<opt>--noinit</opt> option is given, it configures the device to
the settings specified by the option-arguments (or to some
default settings), and sets it to "raw" mode. If
<opt>--noinit</opt> is given, the initialization and
configuration is skipped; the device is just opened. Following
this, <b>picocom</b> sets the standard-input and
standard-output to raw mode. Having done so, 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. <b>picocom</b> 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 called the "function character"). Depending on the
value of the function character, <b>picocom</b> performs one
of the operations described in the "Commands" section below.
</p>
</description>
<section name="COMMANDS">
<p>
Commands are given to <b>picocom</b> by first keying the "espace
character" which by default is "C-a" (see "Options" below on how
to change it), and then keying one for the function (command)
characters shown here.
</p>
<p>
[escape character]: Send the escape character to the serial port
and return to "transparent" mode. This means that if the escape
character ("C-a", by default) is typed twice, the program sends
the escape character to the serial port, and remains in
transparent mode.
</p>
<p>
[C-x]: Exit the program: if the <opt>--noreset</opt> 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>
<p>
[C-q]: Quit the program *without* reseting the serial port,
regardless of the <opt>--noreset</opt> option.
</p>
<p>
[C-p]: Pulse the DTR line. Lower it for 1 sec, and then raise it
again.
</p>
<p>
[C-t]: Toggle the DTR line. If DTR is up, then lower it. If it
is down, then raise it.
</p>
<p>
[C-backslash]: 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>
<p>
[C-u]: 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 HIGH_BAUD 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>
<p>
[C-d]: Baud down. Decrease the baud-rate. The list of baud-rates
stepped-through by this command is the same as for the "baud-up"
command.
</p>
<p>
[C-f]: Cycle through flow-control settings (RTS/CTS, XON/XOFF,
none).
</p>
<p>
[C-y]: Cycle through parity settings (even, odd, none).
</p>
<p>
[C-b]: Cycle through databits-number settings (5, 6, 7, 8).
</p>
<p>
[C-j]: Cycle through stopbits-number settings (1, 2).
</p>
<p>
[C-c]: Toggle local-echo mode.
</p>
<p>
[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. If an
actual port setting is different than 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 port
setting in parenthesis. Example: "*** baud: 115200 (9600)". This
means that a baud rate of 115200bps has been selected (from the
command line, or using commands) 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 port setting are the same, only a
single value is shown. Example: "*** baud: 9600".
</p>
<p>
[C-h] or [C-k]: Show help or show keys. Prints a short
description of all available function (command) keys.
</p>
<p>
[C-s]: Send (upload) a file (see "Sending and Receiving Files"
below)
</p>
<p>
[C-r]: Receive (download) a file (see "Sending and Receiving
Files" below)
</p>
<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>
<p>
C-a, C-u, C-a, C-u
</p>
<p>
assuming of-course that "C-a" is the escape character.
</p>
<p>
Commands that change program options ([C-u], [C-d], [C-f], etc)
also display a message showing the new option value. If the new
option value cannot be applied succesfully to the serial port
(for whatever reason), then the respective actual current port
setting is also shown. See the description of the [C-v] command,
above, for more on this.
</p>
</section>
<section name = "SENDING AND RECEIVING FILES">
<p>
<b>picocom</b> 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>
<p><manref name="rx" section="1"/>
- receive using the X-MODEM protocol</p>
<p><manref name="rb" section="1"/>
- receive using the Y-MODEM protocol</p>
<p><manref name="rz" section="1"/>
- receive using the Z-MODEM protocol</p>
<p><manref name="sx" section="1"/>
- send using the X-MODEM protocol</p>
<p><manref name="sb" section="1"/>
- send using the Y-MODEM protocol</p>
<p><manref name="sz" section="1"/>
- send using the Z-MODEM protocol</p>
<p><manref name="ascii-xfr" section="1"/>
- receive or transmit ASCII files</p>
<p>
The name of, and the command-line options to, the program to be
used for transmitting files are given by the
<opt>--send-cmd</opt> option. Similarly the program to receive
files, and its argumets, are given by the
<opt>--receive-cmd</opt> option. For example, in order to start
a <b>picocom</b> session that uses "sz" to transmit files, and
"rz" to receive files, you have to say something like this:
</p>
<p>
picocom --send-cmd "sz -vv" --receive-cmd "rz -vv"
</p>
<p>
If the argument to the <opt>--send-cmd</opt> option, or the
argument to the <opt>--receive-cmd</opt> option is the empty
string, then the respective command is disabled. For example, in
order to disable both the "send" and the "receive" commands you
can invoke picocom like this:
</p>
<p>
picocom --send-cmd '' --receive-cmd ''
</p>
<p>
During the picocom session, if you key the "send" or "receive"
commands (e.g. by pressing C-a, C-s, or C-a, C-r) 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
pathname completion are available at this prompt, if you have
compiled picocom with support for the linenoise
library. Pressing 'C-c' at this prompt will cancel the file
transfer command and return to normal <b>picocom</b>
operation. After entering a filename (and / or additional
transmission or reception program arguments) and assuming you
have not canceled the operation by pressing C-c, picocom will
start the the external program as specified by the
<opt>--send-cmd</opt>, or <opt>--receive-cmd</opt> 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
'C-c' while the external program is running will prematurely
terminate it, and return control to <b>picocom</b>. Pressing
'C-c' at any other time, has no special effect; the character is
normally passed to the serial port.
</p>
</section>
<section name = "INPUT, OUTPUT, AND ECHO MAPPING">
<p>
Using the <opt>--imap</opt>, <opt>--omap</opt>, and
<opt>--emap</opt> options you can make <b>picocom</b> map
(tranlate, replace) certain special characters after being read
from the serial port (with <opt>--imap</opt>), before being
written to the serial port (with <opt>--omap</opt>), and before
being locally echoed to the terminal (standard output) if local
echo is enabled (with <opt>--emap</opt>). These mapping options
take, each, a single argument which is a comma-separated list of
one or more of the following identifiers: "crlf" (map CR to LF),
"crcrlf" (map CR to CR + LF), "igncr" (ignore CR), "lfcr" (map
LF to CR), "lfcrlf" (map LF to CR + LF), "ignlf" (ignore LF),
"bsdel" (map BS --> DEL), "delbs" (map DEL --> BS)
</p>
<p>
For example the command:
</p>
<p>
picocom --omap crlf,delbs --imap inglf,bsdel --emap crcrlf ...
</p>
<p>
will: 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. 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. Replace every CR character with CR and LF when
echoing to the terminal (if local-echo is enabled).
</p>
</section>
<options>
<p>
<b>picocom</b> accepts the following command-line options
</p>
<option>
<opt><p>--baud | -b</p></opt>
<optdesc>
<p>
Defines the baud-rate to set the serial-port (terminal) to.
</p>
</optdesc>
</option>
<option>
<opt><p>--flow | -f</p></opt>
<optdesc>
<p>
Defines the flow-control mode to set the serial-port
to. Must be one of: 'x' for xon/xoff (software) mode, 'h'
for hardware flow control (RTS/CTS), 'n' for no flow
control. (Default: 'n')
</p>
</optdesc>
</option>
<option>
<opt><p>--parity | -p</p></opt>
<optdesc>
<p>
Defines the parity mode to set the serial-port to. Must be
one of: 'o' for odd parity mode, 'e' for even parity mode,
'n' for no parity mode. (Default: 'n')
</p>
</optdesc>
</option>
<option>
<opt><p>--databits | -d</p></opt>
<optdesc>
<p>
Defines the number of data bits in every character. Must be
one of: 5, 6, 7, 8. (Default: 8)
</p>
</optdesc>
</option>
<option>
<opt><p>--stopbits | -p</p></opt>
<optdesc>
<p>
Defines the number of stop bits in every character. Must be
one of: 1, or 2. (Default: 1)
</p>
</optdesc>
</option>
<option>
<opt><p>--esacpe | -e</p></opt>
<optdesc>
<p>
Defines the character that will make picocom enter
command-mode (see description above). If 'x' is given, then
C-x will make picocom enter command mode. (Default: 'a')
</p>
</optdesc>
</option>
<option>
<opt><p>--echo | -c</p></opt>
<optdesc>
<p>
Enable local echo. Every character being read from the
terminal (standard input) is echoed to the terminal
(standard output) subject to the echo-mapping configuration
(see <opt>--emap</opt> option. (Default: Disabled)
</p>
</optdesc>
</option>
<option>
<opt><p>--noinit | -i</p></opt>
<optdesc>
<p>
If given, <b>picocom</b> will not initialize, reset, or
otherwise meddle with the serial port at start-up. It will
just open it. This is useful, for example, for connecting
<b>picocom</b> to already-connected modems, or already
configured ports without terminating the connection, or
altering the settings. If required serial port parameters
can then be adjusted at run-time by commands.
</p>
</optdesc>
</option>
<option>
<opt><p>--noreset | -r</p></opt>
<optdesc>
<p>
If given, <b>picocom</b> will not *reset* the serial port
when exiting. It will just close the filedes and do nothing
more. This is useful, for example, for leaving modems
connected when exiting <b>picocom</b>. Regardless whether
the <opt>--noreset</opt> option is given the user can exit
<b>picocom</b> using the "Quit" command (instead of "Exit"),
which never resets the serial port. If <opt>--noreset</opt>
is given then "Quit" and "Exit" behave essentially the same.
</p>
</optdesc>
</option>
<option>
<opt><p>--nolock | -l</p></opt>
<optdesc>
<p>
If given, <b>picocom</b> will *not* 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 <manref
name="flock" section="2"/>. 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 <opt>--nolock</opt>
option is accepted, but has no effect.
</p>
</optdesc>
</option>
<option>
<opt><p>--send-cmd | -s</p></opt>
<optdesc>
<p>
Specifies the external program (and any arguments to it)
that will be used for transmitting files. If the argument to
<opt>--send-cmd</opt> is the empty string (''), the
send-file command is disabled. (Default: "sz -vv")
</p>
</optdesc>
</option>
<option>
<opt><p>--receive-cmd | -v</p></opt>
<optdesc>
<p>
Specifies the external program (and any arguments to it)
that will be used for receiving files. If the argument to
<opt>--receive-cmd</opt> is the empty string (''), the
receive-file command is disabled. (Default: "rz -vv")
</p>
</optdesc>
</option>
<option>
<opt><p>--imap</p></opt>
<optdesc>
<p>
Specifies the input character map (i.e. special characters
to be replaced when read from the serial port). Example:
"--imap crlf,delbs". (Defaul: Empty)
</p>
</optdesc>
</option>
<option>
<opt><p>--omap</p></opt>
<optdesc>
<p>
Specifies the output character map (i.e. special characters
to be replaced before being written to serial
port). Example: "--omap crcrlf,bsdel". (Defaul: Empty)
</p>
</optdesc>
</option>
<option>
<opt><p>--emap</p></opt>
<optdesc>
<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). Example: "--emap
crcrlf,bsdel". (Defaul: delbs,crcrlf)
</p>
</optdesc>
</option>
<option>
<opt><p>--help | -h</p></opt>
<optdesc>
<p>
Print a short help message describing the command-line
options. picocom's version, compile-time options, and enabled
features are also shown.
</p>
</optdesc>
</option>
</options>
<section name="AUTHOR">
<p>picocom was written by Nick Patavalis (npat@efault.net)</p>
</section>
<section name="AVAILABILITY">
<p>The latest release of "picocom" can be downloaded from: <url
href="https://github.com/npat-efault/picocom/releases" />
</p>
</section>
</manpage>