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

Updated manual and regenerated docs

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

56
picocom.1
View File

@ -1,7 +1,7 @@
.\" Automatically generated by Pandoc 1.16.0.2
.\"
.ad l
.TH "PICOCOM" "1" "2017-12-21" "Picocom 3.0a" "User Commands"
.TH "PICOCOM" "1" "2017-12-23" "Picocom 3.0a" "User Commands"
.nh \" Turn off hyphenation by default.
.SH NAME
.PP
@ -21,6 +21,12 @@ program to allow access to all types of devices that provide serial
consoles.
It could also prove useful in many other similar tasks.
.PP
In effect, picocom is not an "emulator" per\-se.
It is a simple program that opens, configures, manages a serial port
(tty device) and its settings, and connects to it the terminal emulator
you are, most likely, already using (the terminal window application,
xterm, rxvt, system console, etc).
.PP
When picocom starts it opens the tty (serial port) given as its
non\-option argument.
Unless the \f[B]\-\-noinit\f[] option is given, it configures the port
@ -168,20 +174,24 @@ Toggle local\-echo mode.
.RS
.RE
.TP
.B \f[B]C\-v\f[]
Show program options (like baud rate, data bits, etc) as well as the
actual serial port settings.
Only the options and port settings that can be modified online (through
commands) are shown, not those that can only be set at the
command\-line.
See \f[B]DISPLAY OF OPTIONS AND PORT SETTINGS\f[] for details.
.RS
.RE
.TP
.B \f[B]C\-h\f[] or \f[B]C\-k\f[]
Show help or show keys.
Prints a short description of all available function (command) keys.
.B \f[B]C\-w\f[]
Write hex.
Picococm prompts the user for a string of hexadecimal values.
Values can be entered with or without delimeters (separators).
The hexadecimal values are translated to binary and sent to the port,
exactly as if input at the terminal (i.e.
the \f[B]\-\-omap\f[], \f[B]\-\-echo\f[] and \f[B]\-\-emap\f[] options
are observed).
Example: The following sends the characters "ABCD" to the port.
.RS
.IP
.nf
\f[C]
C\-a\ C\-w
***\ hex:\ 41\ 4243:44
***\ wrote\ 4\ byes\ ***
\f[]
.fi
.RE
.TP
.B \f[B]C\-s\f[]
@ -195,6 +205,22 @@ Receive (download) a file.
See \f[B]SENDING AND RECEIVING FILES\f[] below.
.RS
.RE
.TP
.B \f[B]C\-v\f[]
Show program options (like baud rate, data bits, etc) as well as the
actual serial port settings.
Only the options and port settings that can be modified online (through
commands) are shown, not those that can only be set at the
command\-line.
See \f[B]DISPLAY OF OPTIONS AND PORT SETTINGS\f[] for details.
.RS
.RE
.TP
.B \f[B]C\-h\f[] or \f[B]C\-k\f[]
Show help, or show keys.
Prints a short description of all available function (command) keys.
.RS
.RE
.PP
After performing one of the above operations, the program leaves the
command mode and enters transparent mode.
@ -309,7 +335,7 @@ If \f[B]\-\-noreset\f[] is given and \f[B]\-\-hangup\f[] is not, then
HUPCL for the port is cleared and will remain so after exiting picocom.
If \f[B]\-\-noreset\f[] is \f[I]not\f[] given, or if both
\f[B]\-\-noreset\f[] and \f[B]\-\-hangup\f[] are given, then HUPCL is
set for the port, and will remain so after exiting picocom.
set for the port and will remain so after exiting picocom.
This is true, regardless of the way picocom terminates (command, read
zero\-bytes from standard input, killed by signal, fatal error, etc),
and regardless of the \f[B]\-\-noinit\f[] option.