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

Updated manual and regenerated docs

Browse Source
This commit is contained in:
Nick Patavalis
2017-12-20 11:11:14 +02:00
parent 89be292023
commit 0ec7213956
4 changed files with 177 additions and 133 deletions
Download Patch File Download Diff File Expand all files Collapse all files

114
picocom.1
View File

@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 1.16.0.2
.\"
.TH "PICOCOM" "1" "2017-12-16" "Picocom 2.3a" "User Commands"
.TH "PICOCOM" "1" "2017-12-20" "Picocom 2.3a" "User Commands"
.hy
.SH NAME
.PP
@ -58,15 +58,19 @@ and remains in transparent mode.
.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.
Exit the program.
If the \f[B]\-\-noreset\f[] option is \f[I]not\f[] given, then the
serial port is reset to its original settings before exiting, and the
modem control lines (typically DTR and RTS) are cleared (lowered)
signaling a modem hangup; if \f[B]\-\-noreset\f[] is given, then the
serial port settings are not reset, and the modem control lines remain
unaffected.
.RS
.RE
.TP
.B \f[B]C\-q\f[]
Quit the program \f[I]without\f[] resetting the serial port, regardless
of the \f[B]\-\-noreset\f[] option.
Quit the program \f[I]without\f[] resetting the serial port, exactly as
if the \f[B]\-\-noreset\f[] option was given.
.RS
.RE
.TP
@ -235,6 +239,7 @@ 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.
See also the \f[B]\-\-no\-escape\f[] option.
(Default: \f[B]a\f[])
.RS
.RE
@ -242,8 +247,8 @@ command mode.
.B \f[B]\-\-no\-escape\f[] | \f[B]\-n\f[]
Disables the escape character.
Picocom will never enter command\-mode if this option is enabled.
To exit picocom, either close its standard input, or send it the TERM or
INT signal.
To exit picocom, you must either close its standard input, or send it
the TERM or INT signal.
(Default: Disabled).
.RS
.RE
@ -258,30 +263,44 @@ configuration (see \f[B]\-\-emap\f[] option).
.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.
If given, picocom will not initialize, configure, 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.
terminating the connection, or altering their settings.
If required, serial port parameters can then be adjusted at run\-time by
commands.
See also the \f[B]\-\-noreset\f[] option.
(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.
It will just close the respective file descriptor and do nothing more.
The serial port settings will \f[I]not\f[] be restored to their original
values and the modem\-control lines will \f[I]not\f[] be affected.
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.
never resets the serial port (i.e makes picocom behave exactly as if
\f[B]\-\-noreset\f[] was given).
If \f[B]\-\-noreset\f[] is given then "Quit" and "Exit" behave
essentially the same.
(Default: Disabled)
.RS
.PP
NOTICE: Picocom will always set the HUPCL control bit of the serial
port, according to the \f[B]\-\-noreset\f[] option.
If \f[B]\-\-noreset\f[] is given, then HUPCL for the port is cleared,
and will remain so after exiting picocom.
If \f[B]\-\-noreset\f[] is \f[I]not\f[] given, then HUPCL is set for the
port, and will remain so after exiting picocom.
This is true, regardless of the way picocom terminates (command, read
zero\-bytes from standard input, killed by signal, fatal error, etc),
and regardless of the \f[B]\-\-noinit\f[] option.
.RE
.TP
.B \f[B]\-\-nolock\f[] | \f[B]\-l\f[]
@ -364,7 +383,7 @@ Send the provided string after opening and configuring the serial port.
The init string is sent exactly as if it was input at the terminal.
Sending the init string, picocom observes the \f[B]\-\-omap\f[] output
mapping, the \f[B]\-\-echo\f[] local\-echo setting, and the
\f[B]\-emap\f[] local\-echo mapping.
\f[B]\-\-emap\f[] local\-echo mapping.
This feature is useful, for example, if the serial device needs some
special magic strings to start responding.
Use \f[B]echo(1)\f[] or \f[B]xxd(1)\f[] to generate special characters
@ -374,7 +393,7 @@ Example:
.IP
.nf
\f[C]
picocom\ \-t\ "$(echo\ \-e\ \[aq]\\r\\nATZ\\r\\n\[aq])"\ /dev/ttsyS0
picocom\ \-t\ "$(echo\ \-e\ \[aq]AAATZ\\r\\n\[aq])"\ /dev/ttyS0
\f[]
.fi
.PP
@ -403,22 +422,24 @@ Exit picocom if it remains idle for the specified time (in
milliseconds).
Picocom is considered idle if: Nothing is read (received) from the
serial port, AND there is nothing to write (send) to the serial port,
AND nothing is read from the terminal.
AND nothing is read from the standard input (terminal).
If \f[B]\-\-exit\-after\f[] is set to zero, then picocom exits after
opening and configuring the serial port, after sending the init string
(if any, see option \f[B]\-\-initstring\f[]), and imediatelly when it
becomes idle.
When exiting after being idle, picocom observes the \f[B]\-\-noreset\f[]
setting as usual.
When exiting after being idle, picocom drains the O/S serial port ouput
buffer (i.e.
waits for data already written to the port to be transmitted) and
observes the \f[B]\-\-noreset\f[] setting as usual.
(Default: not set).
.RS
.PP
NOTICE: If \f[B]\-\-exit\-after\f[] is set, reading zero bytes from the
standard input (which usually means that whatever was connected there
has been closed), will \f[I]not\f[] cause picocom to exit.
Instead, picocom will keep running, without reading from stdin, and will
exit only when it becomes idle for the specified time, or if it is
killed by a signal.
Instead, picocom will keep running, \f[I]without\f[] reading from stdin,
and will exit only when it becomes idle for the specified time, or if it
is killed by a signal.
If \f[B]\-\-exit\-after\f[] is \f[I]not\f[] set, then reading zero bytes
from the standard input causes picocom to exit, after the contents of
its output queue have been transmitted.
@ -430,14 +451,14 @@ Do \f[I]not\f[] read \f[I]anything\f[] from the standard input or from
the serial port.
When exiting the \f[B]\-\-noreset\f[] option is observed as usual.
With \f[B]\-\-exit\f[] and \f[B]\-\-noreset\f[] picocom can be used as a
crude replacement of \f[B]stty(1)\f[].
very crude replacement of \f[B]stty(1)\f[].
If an init string is also given (see \f[B]\-\-initstring\f[] option),
picocom exits imediatelly after sending (writing) the init string to the
serial port.
In this case, before exiting, picocom drains the O/S serial port output
buffer (i.e.
waits for data written to the port to be transmitted).
Again, nothing is read from the standard input, or from the serial port.
The ouput map (see \f[B]\-\-omap\f[]), the local echo option (see
\f[B]\-\-echo\f[]), and the local\-echo map (see \f[B]\-\-emap\f[]) are
observed when sending the init string.
The \f[B]\-\-exit\f[] option, overrides the \f[B]\-\-exit\-after\f[]
option.
(Default: Disabled)
@ -628,23 +649,25 @@ its operation and what happens on each such condition:
.IP \[bu] 2
The exit command is seen in the standard input.
That is, the escape character is seen (default \f[B]C\-a\f[]), followed
by the exit command character (default: \f[B]C\-x\f[]).
In this case: The contents of the output queue are discarded and the
contents of the O/S serial port output buffer (data already written to
the port) are drained (i.e.
picocom waits for them to be transmitted).
by the exit command character (default \f[B]C\-x\f[]).
In this case: The contents of the output queue (data read from the
standard input, but not yet written to the port) as well as the contents
of the O/S serial port output buffer (data already written to the port,
but not yet transmitted) are discarded (flushed).
Then, if the \f[B]\-\-noreset\f[] option is \f[I]not\f[] given, the
serial port is reset to the settings it had when picocom started, and
picocom exits.
the modem control lines (typically DTR and RTS) are cleared (lowered),
signaling a modem hangup.
Picocom then exits.
If \f[B]\-\-noreset\f[] is given, then picocom exits without reseting
the serial port.
the serial port and without affecting the modem control lines.
.IP \[bu] 2
The quit command is seen in the standard input.
That is, the escape character is seen (default \f[B]C\-a\f[]), followed
by the quit command character (default: \f[B]C\-q\f[]).
by the quit command character (default \f[B]C\-q\f[]).
The behavior in this case is similar to that of the exit command, with
one difference: The serial port is \f[I]not\f[] reset to its original
settings, regardless of the \f[B]\-\-noreset\f[] option.
one difference: Picocom behaves as if the \f[B]\-\-noreset\f[] option is
given (regardless if it actualy is, or not).
.IP \[bu] 2
The \f[B]\-\-exit\f[] option is given.
See the documentation of this option for a description of what exactly
@ -658,14 +681,15 @@ Zero bytes are read from the standard input.
This usually means that whatever was connected to picocom\[aq]s standard
input has been closed or, if a file was connected, that picocom has read
up to the end of the file.
In this case, if the \f[B]\-\-exit\-after\f[] option is not given,
picocom stops reading from the standard input, and keeps operating
normally (i.e.
In this case, if the \f[B]\-\-exit\-after\f[] option is \f[I]not\f[]
given, picocom stops reading from the standard input, and keeps
operating normally (i.e.
writing to, and reading from, the serial port) until its output queue is
emptied.
When this happens, picocom waits for the O/S serial port output buffer
to drain and then (subject to the \f[B]\-\-noreset\f[] option) resets
the serial port to it\[aq]s initial settings and exits.
the serial port to it\[aq]s initial settings, clears the modem\-control
lines, and exits.
If the \f[B]\-\-exit\-after\f[] option is given then, again, picocom
stops reading from the standard input and continues operating normally
but, in this case, it does so until it becomes idle for the specified
@ -675,15 +699,13 @@ observing the \f[B]\-\-noreset\f[] option as usual.
.IP \[bu] 2
Picocom is killed by the TERM or INT signal.
In this case picocom behaves as if it had received the exit command,
that is: The contents of the output queue are discarded and the contents
of the O/S serial port output buffer (data already written to the port)
are drained (i.e.
picocom waits for them to be transmitted).
that is: The contents of the output queue and the contents of the O/S
serial port output buffer are discarded (flushed).
Then, if the \f[B]\-\-noreset\f[] option is \f[I]not\f[] given, the
serial port is reset to the settings it had when picocom started, and
picocom exits.
serial port is reset to the settings it had when picocom started, the
modem control lines are cleared, and picocom exits.
If \f[B]\-\-noreset\f[] is given, then picocom exits without reseting
the serial port.
the serial port or affecting the modem control lines.
.SH AUTHOR
.PP
Written by Nick Patavalis <npat@efault.net>