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, rebuilt docs.

Browse Source
This commit is contained in:
Nick Patavalis
2018-02-08 17:15:39 +02:00
parent 8707801496
commit acc4e7ea1a
4 changed files with 22 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
picocom.1
View File

@ -1,7 +1,7 @@
.\" Automatically generated by Pandoc 1.16.0.2 .\" Automatically generated by Pandoc 1.16.0.2
.\" .\"
.ad l .ad l
.TH "PICOCOM" "1" "2018-02-01" "Picocom 3.2a" "User Commands" .TH "PICOCOM" "1" "2018-02-08" "Picocom 3.2a" "User Commands"
.nh \" Turn off hyphenation by default. .nh \" Turn off hyphenation by default.
.SH NAME .SH NAME
.PP .PP
@ -28,7 +28,8 @@ you are, most likely, already using (the terminal window application,
xterm, rxvt, system console, etc). xterm, rxvt, system console, etc).
.PP .PP
When picocom starts it opens the tty (serial port) given as its When picocom starts it opens the tty (serial port) given as its
non\-option argument. non\-option argument (or the \f[I]last\f[] non\-option argument, if
multiple are given).
Unless the \f[B]\-\-noinit\f[] option is given, it configures the port Unless the \f[B]\-\-noinit\f[] option is given, it configures the port
to the settings specified by the option\-arguments (or to some default to the settings specified by the option\-arguments (or to some default
settings), and sets it to "raw" mode. settings), and sets it to "raw" mode.

4
picocom.1.html
View File

@ -11,7 +11,7 @@
</head> </head>
<body> <body>
<div id="header"> <div id="header">
<h1 class="title"><div id="pgname">PICOCOM(1)</div><div id="version">v3.2a / 2018-02-01</div></h1> <h1 class="title"><div id="pgname">PICOCOM(1)</div><div id="version">v3.2a / 2018-02-08</div></h1>
</div> </div>
<h1 id="name">NAME</h1> <h1 id="name">NAME</h1>
<p>picocom - minimal dumb-terminal emulation program</p> <p>picocom - minimal dumb-terminal emulation program</p>
@ -20,7 +20,7 @@
<h1 id="description">DESCRIPTION</h1> <h1 id="description">DESCRIPTION</h1>
<p>As its name suggests, <strong>picocom(1)</strong> is a minimal dumb-terminal emulation program. It is, in principle, very much like <strong>minicom(1)</strong>, only it's &quot;pico&quot; instead of &quot;mini&quot;! It was designed to serve as a simple, manual, modem configuration, testing, and debugging tool. It has also served (quite well) as a low-tech serial communications program to allow access to all types of devices that provide serial consoles. It could also prove useful in many other similar tasks.</p> <p>As its name suggests, <strong>picocom(1)</strong> is a minimal dumb-terminal emulation program. It is, in principle, very much like <strong>minicom(1)</strong>, only it's &quot;pico&quot; instead of &quot;mini&quot;! It was designed to serve as a simple, manual, modem configuration, testing, and debugging tool. It has also served (quite well) as a low-tech serial communications program to allow access to all types of devices that provide serial consoles. It could also prove useful in many other similar tasks.</p>
<p>In effect, picocom is not an &quot;emulator&quot; per-se. It is a simple program that opens, configures, manages a serial port (tty device) and its settings, and connects to it the terminal emulator you are, most likely, already using (the terminal window application, xterm, rxvt, system console, etc).</p> <p>In effect, picocom is not an &quot;emulator&quot; per-se. It is a simple program that opens, configures, manages a serial port (tty device) and its settings, and connects to it the terminal emulator you are, most likely, already using (the terminal window application, xterm, rxvt, system console, etc).</p>
<p>When picocom starts it opens the tty (serial port) given as its non-option argument. Unless the <strong>--noinit</strong> option is given, it configures the port to the settings specified by the option-arguments (or to some default settings), and sets it to &quot;raw&quot; mode. If <strong>--noinit</strong> is given, the initialization and configuration is skipped; the port is just opened. Following this, if standard input is a tty, picocom sets the tty to raw mode. Then it goes in a loop where it listens for input from stdin, or from the serial port. Input from the serial port is copied to the standard output while input from the standard input is copied to the serial port. Picocom also scans its input stream for a user-specified control character, called the <em>escape character</em> (being by default <strong>C-a</strong>). If the escape character is seen, then instead of sending it to the serial-device, the program enters &quot;command mode&quot; and waits for the next character (which is called the &quot;function character&quot;). Depending on the value of the function character, picocom performs one of the operations described in the <strong><a href="#commands">COMMANDS</a></strong> section below.</p> <p>When picocom starts it opens the tty (serial port) given as its non-option argument (or the <em>last</em> non-option argument, if multiple are given). Unless the <strong>--noinit</strong> option is given, it configures the port to the settings specified by the option-arguments (or to some default settings), and sets it to &quot;raw&quot; mode. If <strong>--noinit</strong> is given, the initialization and configuration is skipped; the port is just opened. Following this, if standard input is a tty, picocom sets the tty to raw mode. Then it goes in a loop where it listens for input from stdin, or from the serial port. Input from the serial port is copied to the standard output while input from the standard input is copied to the serial port. Picocom also scans its input stream for a user-specified control character, called the <em>escape character</em> (being by default <strong>C-a</strong>). If the escape character is seen, then instead of sending it to the serial-device, the program enters &quot;command mode&quot; and waits for the next character (which is called the &quot;function character&quot;). Depending on the value of the function character, picocom performs one of the operations described in the <strong><a href="#commands">COMMANDS</a></strong> section below.</p>
<h1 id="commands">COMMANDS</h1> <h1 id="commands">COMMANDS</h1>
<p>Commands are given to picocom by first keying the <em>espace character</em> which by default is <strong>C-a</strong> (see <strong><a href="#options">OPTIONS</a></strong> below for how to change it), and then keying one of the function (command) characters shown here.</p> <p>Commands are given to picocom by first keying the <em>espace character</em> which by default is <strong>C-a</strong> (see <strong><a href="#options">OPTIONS</a></strong> below for how to change it), and then keying one of the function (command) characters shown here.</p>
<dl> <dl>

33
picocom.1.md
View File

@ -31,22 +31,23 @@ likely, already using (the terminal window application, xterm, rxvt,
system console, etc). system console, etc).
When picocom starts it opens the tty (serial port) given as its When picocom starts it opens the tty (serial port) given as its
non-option argument. Unless the **--noinit** option is given, it non-option argument (or the *last* non-option argument, if multiple
configures the port to the settings specified by the option-arguments are given). Unless the **--noinit** option is given, it configures the
(or to some default settings), and sets it to "raw" mode. If port to the settings specified by the option-arguments (or to some
**--noinit** is given, the initialization and configuration is default settings), and sets it to "raw" mode. If **--noinit** is
skipped; the port is just opened. Following this, if standard input is given, the initialization and configuration is skipped; the port is
a tty, picocom sets the tty to raw mode. Then it goes in a loop where just opened. Following this, if standard input is a tty, picocom sets
it listens for input from stdin, or from the serial port. Input from the tty to raw mode. Then it goes in a loop where it listens for input
the serial port is copied to the standard output while input from the from stdin, or from the serial port. Input from the serial port is
standard input is copied to the serial port. Picocom also scans its copied to the standard output while input from the standard input is
input stream for a user-specified control character, called the copied to the serial port. Picocom also scans its input stream for a
_escape character_ (being by default **C-a**). If the escape character user-specified control character, called the _escape character_ (being
is seen, then instead of sending it to the serial-device, the program by default **C-a**). If the escape character is seen, then instead of
enters "command mode" and waits for the next character (which is sending it to the serial-device, the program enters "command mode" and
called the "function character"). Depending on the value of the waits for the next character (which is called the "function
function character, picocom performs one of the operations described character"). Depending on the value of the function character, picocom
in the **[COMMANDS]** section below. performs one of the operations described in the **[COMMANDS]** section
below.
# COMMANDS # COMMANDS

BIN
picocom.1.pdf
View File

Binary file not shown.