~ubuntu-branches/ubuntu/hardy/minicom/hardy

« back to all changes in this revision

Viewing changes to man/minicom.1

  • Committer: Bazaar Package Importer
  • Author(s): Martin A. Godisch
  • Date: 2006-10-27 05:41:23 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20061027054123-9cyfsdx649zetdrv
Tags: 2.2-3
* Added upstream NEWS file, closes: #394827.
* Fixed spelling errors, closes: #395449.

Show diffs side-by-side

added added

removed removed

Lines of Context:
4
4
.\" It may be distributed under the GNU Public License, version 2, or
5
5
.\" any higher version.  See section COPYING of the GNU Public license
6
6
.\" for conditions under which this file may be redistributed.
7
 
.TH MINICOM 1 "$Date: 2003/04/26 07:31:06 $" "User's Manual"
 
7
.TH MINICOM 1 "$Date: 2005/11/06 19:22:07 $" "User's Manual" "Version 2.1"
8
8
.SH NAME
9
9
minicom \- friendly serial communication program
10
10
.SH SYNOPSIS
11
11
.B minicom
12
 
.RI "[-somMlwz8] [-c on|off] [-S script] [-d entry]"
 
12
.RI "[\-somMlwz8] [\-c on|off] [\-S script] [\-d entry]"
13
13
.br
14
14
.in 15
15
 
.RI "[-a on|off] [-t term] [-p pty] [-C capturefile] [" configuration ]
 
15
.RI "[\-a on|off] [\-t term] [\-p pty] [\-C capturefile] [" configuration ]
16
16
.SH DESCRIPTION
17
17
.B minicom
18
18
is a communication program which somewhat resembles the shareware
19
19
program TELIX but is free with source code and runs under most unices.
20
20
Features include dialing directory with auto-redial, support for
21
 
UUCP-style lock files on serial devices, a seperate script language
 
21
UUCP-style lock files on serial devices, a separate script language
22
22
interpreter, capture to file, multiple users with individual
23
23
configurations, and more.
24
24
.SH COMMAND-LINE
25
25
.TP 0.5i
26
 
.B -s
 
26
.B \-s
27
27
.BR S etup.
28
28
Root edits the system-wide defaults in /etc/minirc.dfl with this option. 
29
29
When it is used, minicom does 
33
33
because your system has changed, or for the first time you run
34
34
minicom. For most systems, reasonable defaults are already compiled in.
35
35
.TP 0.5i
36
 
.B -o
 
36
.B \-o
37
37
Do not initialize. Minicom will skip the initialization code.  This
38
38
option is handy if you quitted from minicom without resetting, and
39
39
then want to restart a session. It is potentially dangerous though: no
42
42
it is assumed, that users who are given access to a modem are
43
43
responsible enough for their actions.
44
44
.TP 0.5i
45
 
.B -m
 
45
.B \-m
46
46
Override command-key with the Meta or ALT key. This is the default in 1.80
47
47
and it can also be configured in one of minicom's menus, but if you use 
48
48
different terminals all the time, of which some don't have a Meta or ALT key,
51
51
assumes that your Meta key sends the ESC prefix, not the other variant
52
52
that sets the highest bit of the character.
53
53
.TP 0.5i
54
 
.B -M
55
 
Same as -m, but assumes that your Meta key sets the 8th bit of the
 
54
.B \-M
 
55
Same as \-m, but assumes that your Meta key sets the 8th bit of the
56
56
character high (sends 128 + character code).
57
57
.TP 0.5i
58
 
.B -z
 
58
.B \-z
59
59
Use terminal status line. This only works on terminals that support it
60
60
and that have the relevant information in their \fItermcap\fP or
61
61
\fIterminfo\fP database entry.
62
62
.TP 0.5i
63
 
.B -l
 
63
.B \-l
64
64
.BR L iteral
65
65
translation of characters with the high bit set. With this flag on,
66
 
minicom will not try to translate the IBM line characters to ASCII,
67
 
but passes them straight trough. Many PC-unix clones will display
68
 
them correctly without translation (Linux in a special mode, Coherent
69
 
and Sco).
 
66
minicom will try to translate the IBM line characters to ASCII. Many PC-unix
 
67
clones will display charachter correctly without translation (Linux in a
 
68
special mode, Coherent and Sco).
70
69
.TP 0.5i
71
 
.B -L
 
70
.B \-L
72
71
Ditto but assume screen uses an ISO8859 character set.
73
72
.TP 0.5i
74
 
.B -w
 
73
.B \-w
75
74
Turns linewrap on at startup by default.
76
75
.TP 0.5i
77
 
.B -a
 
76
.B \-a
78
77
.BR A ttribute
79
 
usage. Some terminals, notably televideo's, have a rotten attribute
80
 
handling (serial instead of parallel). By default, minicom uses '-a
 
78
usage. Some terminals, notably Televideo's, have rotten attribute
 
79
handling (serial instead of parallel). By default, minicom uses '\-a
81
80
on', but if you are using such a terminal you can (must!)  supply the
82
 
option '-a off'. The trailing 'on' or 'off' is needed.
 
81
option '\-a off'. The trailing 'on' or 'off' is needed.
83
82
.TP 0.5i
84
 
.B -t
 
83
.B \-t
85
84
.BR T erminal
86
85
type. With this flag, you can override the environment TERM variable.
87
86
This is handy for use in the MINICOM environment variable; one can create
88
87
a special termcap entry for use with minicom on the console, that
89
 
initializes the screen to raw mode so that in conjunction with the -l
 
88
initializes the screen to raw mode so that in conjunction with the \-l
90
89
flag, the IBM line characters are displayed untranslated.
91
90
.TP 0.5i
92
 
.B -c
 
91
.B \-c
93
92
.BR C olor
94
93
usage. Some terminals (such as the Linux console) support color with
95
94
the standard ANSI escape sequences. Because there is apparently no
96
95
termcap support for color, these escape sequences are hard-coded into
97
96
minicom. Therefore this option is off by default.  You can turn it on
98
 
with '-c on'. This, and the '-m' option, are good candidates to put
 
97
with '\-c on'. This, and the '\-m' option, are good candidates to put
99
98
into the MINICOM environment variable.
100
99
.TP 0.5i
101
 
.B -S 
 
100
.B \-S 
102
101
.BR script .
103
102
Run the named script at startup. So far, passing username and password
104
 
to a startup script is not supported. If you also use the -d option to
105
 
start dialing at startup, the -S script will be run BEFORE dialing the
106
 
entries specified with -d.
 
103
to a startup script is not supported. If you also use the \-d option to
 
104
start dialing at startup, the \-S script will be run BEFORE dialing the
 
105
entries specified with \-d.
107
106
.TP 0.5i
108
 
.B -d
 
107
.B \-d
109
108
.BR D ial
110
109
an entry from the dialing directory on startup. You can specify an
111
110
index number, but also a substring of the name of the entry. If you 
115
114
entry specified after all other program initialization procedures are 
116
115
completed.
117
116
.TP 0.5i
118
 
.B -p
 
117
.B \-p
119
118
.BR P seudo
120
119
terminal
121
 
to use. This overrrides the terminal port defined in the configuration
 
120
to use. This overrides the terminal port defined in the configuration
122
121
files, but only if it is a pseudo tty. The filename supplied must be of
123
122
the form (/dev/)tty[p-z/][0-f], (/dev/)pts[p-z/][0-f] or 
124
123
(/dev/)pty[p-z/][0-f]. For example, /dev/ttyp1, pts/0 or /dev/ptyp2.
125
124
.TP 0.5i
126
 
.B -C
 
125
.B \-C
127
126
.BR filename .
128
127
Open capture file at startup.
129
128
.TP 0.5i
130
 
.B -T
 
129
.B \-T
131
130
Disable the display of the online time in the status bar.
132
131
.TP 0.5i
133
 
.B -8
134
 
'8bit clean' and 'continuous' mode. '8bit clean' means Minicom let
 
132
.B \-7
 
133
7bit mode for terminals which aren't 8bit capable. 8bit is default if the
 
134
environment is configured for this via LANG or LC_ALL, 7bit otherwise.
 
135
.TP 0.5i
 
136
.B \-8
135
137
8bit characters pass through without any modification.  'Continuous'
136
138
means no locate/attribute control sequences are inserted without
137
139
real change of locate/attribute. This mode is to display 8bit
147
149
.PP
148
150
.RS 0.5i
149
151
.PD 0
150
 
MINICOM='-m -c on'
 
152
MINICOM='\-m \-c on'
151
153
.PP
152
154
export MINICOM
153
155
.PP
160
162
a Meta or <ALT> key and that color is supported.  If you then log in
161
163
from a terminal without color support, and you have set MINICOM in your
162
164
startup (.profile or equivalent) file, and don't want to re-set your
163
 
environment variable, you can type 'minicom -c off' and run without
 
165
environment variable, you can type 'minicom \-c off' and run without
164
166
color support for that session.
165
167
.RE
166
168
.TP 0.5i
181
183
Control-A), and then the function key (a-z or A-Z). By pressing C-A
182
184
first and then 'z', a help screen comes up with a short summary of all
183
185
commands. This escape key can be altered when minicom is configured
184
 
(-s option or C-A O), but we'll stick to Control-A for now.
 
186
(\-s option or C-A O), but we'll stick to Control-A for now.
185
187
.PP
186
188
.PD 0
187
189
For every menu the next keys can be used:
211
213
bottom, a status line is placed there.  If this is not possible the
212
214
status line will be showed every time you press C-A. On terminals
213
215
that have a special status line that will be used if the termcap
214
 
information is complete \fIand\fP the \fB-k\fP flag has been given.
 
216
information is complete \fIand\fP the \fB\-k\fP flag has been given.
215
217
.PP
216
218
.PD 0
217
219
Possible commands are listed next, in alphabetical order.
315
317
Exit minicom, reset modem. If macros changed and were not saved, you will 
316
318
have a chance to do so.
317
319
.TP 0.5i
 
320
.B Y
 
321
Paste a file. Reads a file and sends its contests just as if it would be
 
322
typed in.
 
323
.TP 0.5i
318
324
.B Z
319
325
Pop up the help screen.
320
326
.PD 1
353
359
can be on or off for this system (if your version of minicom supports it).
354
360
.TP 1.0i
355
361
.B E - Script 
356
 
The script that must be executed after a succesfull connection is made
 
362
The script that must be executed after a successful connection is made
357
363
(see the manual for runscript)
358
364
.TP 1.0i
359
365
.B F - Username
393
399
Enter or ESC to end moving the entry. 
394
400
.PP
395
401
.SH CONFIGURATION
396
 
By pressing C-A O you will be thrown into the setup menu. Most
397
 
settings there can be changed by everyone, but some are restricted
398
 
to root only. Those priviliged settings are marked with a star (*) here.
 
402
By pressing C-A O you will be thrown into the setup menu.
399
403
.PP
400
404
.PD 0
401
405
.B "Filenames and paths"
483
487
.RS 0.25i
484
488
.PD 0
485
489
.TP 0.5i
486
 
.B *A - Serial device
 
490
.B A - Serial device
487
491
/dev/tty1 or /dev/ttyS1 for most people.
488
492
/dev/cua<n> is still possible under linux, but not recommended any more 
489
493
because these devices are obsolete and many newly installed systems 
504
508
establishes, minicom goes 'online'. If the server closes the socket, minicom
505
509
switches to 'offline' again.
506
510
.TP 0.5i
507
 
.B *B - Lock file location
 
511
.B B - Lock file location
508
512
On most systems This should be /usr/spool/uucp. Linux systems use
509
513
/var/lock. If this directory does not exist,
510
514
minicom will not attempt to use lockfiles.
511
515
.TP 0.5i
512
 
.B *C - Callin program
 
516
.B C - Callin program
513
517
If you have a uugetty or something on your serial port, it could be
514
518
that you want a program to be run to switch the modem cq. port into
515
519
dialin/dialout mode. This is the program to get into dialin mode.
516
520
.TP 0.5i
517
 
.B *D - Callout program
 
521
.B D - Callout program
518
522
And this to get into dialout mode.
519
523
.TP 0.5i
520
524
.B E - Bps/Par/Bits
523
527
.PP  
524
528
If one of the entries is left blank, it will not be used. So if you
525
529
don't care about locking, and don't have a getty running on your
526
 
modemline, entries B - D should be left blank.  Be warned! The callin
527
 
and callout programs are run with the effective user id of "root", eg
528
 
0!
 
530
modemline, entries B - D should be left blank.
529
531
.RE
530
532
.PP
531
533
.B "Modem and Dialing"
622
624
.B F - Background Color (menu)
623
625
indicates the background color to use for 
624
626
all the configuration windows in minicom. Note that minicom will not allow 
625
 
you to set forground and background colors to the same value.
 
627
you to set foreground and background colors to the same value.
626
628
.TP 0.5i
627
629
.B G - Foreground Color (term)
628
630
indicates the foreground color to use in the terminal window.
629
631
.TP 0.5i
630
632
.B H - Background Color (term)
631
633
indicates the background color to use in 
632
 
the terminal window. Note that minicom will not allow you to set forground 
 
634
the terminal window. Note that minicom will not allow you to set foreground 
633
635
and background colors to the same value.
634
636
.TP 0.5i
635
637
.B I - Foreground Color (stat)
638
640
.B J - Background Color (stat)
639
641
indicates the color to use in for the
640
642
status bar. Note that minicom will allow you to set the status bar's
641
 
forground and background colors to the same value. This will effectively
642
 
make the status bar invisible but if these are your intensions, please
 
643
foreground and background colors to the same value. This will effectively
 
644
make the status bar invisible but if these are your intentions, please
643
645
see the option
644
646
.TP 0.5i
645
647
.B K - History buffer size
742
744
.B "Save setup as.."
743
745
Save the parameters under a special name. Whenever Minicom is started
744
746
with this name as an argument, it will use these parameters. This
745
 
option is of course priviliged to root.
 
747
option is of course privileged to root.
746
748
.TP 0.25i
747
749
.B "Exit"
748
750
Escape from this menu without saving.  This can also be done with ESC.
749
751
.TP 0.25i
750
752
.B "Exit from minicom"
751
 
Only root will see this menu entry, if he/she started minicom with the '-s'
 
753
Only root will see this menu entry, if he/she started minicom with the '\-s'
752
754
option. This way, it is possible to change the configuration without
753
755
actually running minicom.
754
756
.PD 1
764
766
the remote system's termcap initialization strings (is).
765
767
.PD 1
766
768
.SH "LOCALES"
767
 
Minicom has now support for local languages. This means you can change most
 
769
Minicom has support for local languages. This means you can change most
768
770
of the English messages and other strings to another language by setting
769
 
the environment variable LANG. On September 2001 the supported languages
770
 
are Brazilian Portuguese, Finnish, Japanese, French, Polish, Czech, Russian 
771
 
and Spanish.
772
 
Turkish is under construction.
773
 
.PD 1
774
 
.SH "SECURITY ISSUES"
775
 
Since Minicom is run setuid root on some computers, you probably want to 
776
 
restrict access to it. This is possible by using a configuration file 
777
 
in the same directory as the default files, called "minicom.users". 
778
 
The syntax of this file is as following:
779
 
.PP
780
 
.RS 0.5i
781
 
<username> <configuration> [configuration...]
782
 
.RE
783
 
.PP
784
 
To allow user 'miquels' to use the default configuration, enter the 
785
 
following line into "minicom.users":
786
 
.PP
787
 
.RS 0.5i
788
 
miquels dfl
789
 
.RE
790
 
.PP
791
 
If you want users to be able to use more than the default
792
 
configurations, just add the names of those configurations behind the
793
 
user name. If no configuration is given behind the username, minicom
794
 
assumes that the user has access to all configurations.
 
771
the environment variable LANG.
795
772
.PD 1
796
773
.SH MISC
797
 
If minicom is hung, kill it with SIGTERM . (This means kill -15, or
 
774
If minicom is hung, kill it with SIGTERM . (This means kill \-15, or
798
775
since sigterm is default, just plain "kill <minicompid>". This will
799
776
cause a graceful exit of minicom, doing resets and everything.
800
 
You may kill minicom from a script with the command "! killall -9 minicom"
801
 
without hanging up the line. Without the -9 parameter, minicom first 
 
777
You may kill minicom from a script with the command "! killall \-9 minicom"
 
778
without hanging up the line. Without the \-9 parameter, minicom first 
802
779
hangs up before exiting.
803
780
.PP
804
781
Since a lot of escape sequences begin with ESC (Arrow up is ESC [ A),
834
811
$HOME/minicom.log
835
812
/usr/share/locale/*/LC_MESSAGES/minicom.mo
836
813
.fi
837
 
.SH VERSION
838
 
Minicom is now up to version 2.1.
 
814
.SH SEE ALSO
 
815
.BR runscript (1)
 
816
.SH BUGS
 
817
Please report any bugs to
 
818
.IR minicom-devel@lists.alioth.debian.org .
 
819
Thank you!
839
820
.SH AUTHORS
840
821
The original author of minicom is Miquel van Smoorenburg (miquels@cistron.nl).
841
822
He wrote versions up to 1.75.