home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 3 Comm / 03-Comm.zip / mincom15.zip / Manual.mnc < prev    next >
Text File  |  1993-10-26  |  20KB  |  595 lines
  1.  
  2.  
  3.  
  4. MINICOM(1)      Linux Programmer's Manual      MINICOM(1)
  5.  
  6.  
  7. NAME
  8.        minicom - friendly serial communication program
  9.  
  10. SYNOPSIS
  11.        minicom [-soml] [-c on|off] [-a on|off]
  12.            [-t term] [configuration]
  13.  
  14. DESCRIPTION
  15.        minicom    is  a communication program which somewhat resem-
  16.        bles the shareware program TELIX but is free  with  source
  17.        code and runs under most unices.    Features include dialing
  18.        directory with auto-redial, support  for    UUCP-style  lock
  19.        files on serial devices, a seperate script language inter-
  20.        preter, capture to file, multiple  users    with  individual
  21.        configurations, and more.
  22.  
  23. COMMAND-LINE
  24.        -s   Setup.   This  is  allowed    for  root only. When this
  25.         option is used, minicom does not initialize, but puts
  26.         you    directly  into    the  configuration menu. This is
  27.         very handy if minicom refuses  to  start  up  because
  28.         your  system  has  changed, or for the first time you
  29.         run minicom. For most  systems,  reasonable    defaults
  30.         are already compiled in.
  31.  
  32.        -o   Do    not initialize. Minicom will skip the initializa-
  33.         tion code.    This option is handy if you quitted  from
  34.         minicom without resetting, and then want to restart a
  35.         session. It is potentially dangerous though: no check
  36.         for    lock  files etc. is made, so a normal user could
  37.         interfere with things like uucp... Maybe this will be
  38.         taken  out    later.    For now it is assumed, that users
  39.         who are given  access  to  a  modem    are  responsible
  40.         enough for their actions.
  41.  
  42.        -m   Override  command-key  with the Meta or ALT key. This
  43.         can also be configured in one of minicom's menus, but
  44.         if you use different terminals all the time, of which
  45.         some don't have a Meta or ALT key, it's handy to  set
  46.         the default command key to Ctrl-A and use this option
  47.         when you have a keyboard supporting Meta or ALT keys.
  48.  
  49.        -l   Literal  translation  of characters with the high bit
  50.         set. With this flag    on,  minicom  will  not  try  to
  51.         translate  the  IBM    line  characters  to  ASCII, but
  52.         passes them straight trough. Many PC-unix clones will
  53.         display  them correctly without translation (Linux in
  54.         a special mode, Coherent and Minix).
  55.  
  56.        -a   Attribute usage. Some terminals, notably televideo's,
  57.         have  a  rotten attribute handling (serial instead of
  58.         parallel). By default, minicom uses '-a on',  but  if
  59.         you are using such a terminal you can (must!)  supply
  60.         the option '-a off'. The trailing 'on'  or    'off'  is
  61.  
  62.  
  63.  
  64. Cohesive Systems        9 Oct 1993                1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. MINICOM(1)      Linux Programmer's Manual      MINICOM(1)
  71.  
  72.  
  73.         needed.
  74.  
  75.        -t   Terminal  type.  With this flag, you can override the
  76.         environment TERM variable.    This is handy for use  in
  77.         the    MINICOM  environment  variable; one can create a
  78.         special termcap entry for use  with    minicom  on  the
  79.         console,  that  initializes the screen to raw mode so
  80.         that in conjunction with the -l flag,  the    IBM  line
  81.         characters are displayed untranslated.
  82.  
  83.        -c   Color  usage.  Some terminals (such as the Linux con-
  84.         sole) support color with  the  standard  ANSI  escape
  85.         sequences.    Because    there    is  apparently no termcap
  86.         support for color, these escape sequences  are  hard-
  87.         coded  into    minicom. Therefore this option is off by
  88.         default.  You can turn it on with '-c on'. This,  and
  89.         the    '-m' option, are good candidates to put into the
  90.         MINICOM environment variable.
  91.  
  92.         When minicom starts, it first  searches  the  MINICOM
  93.         environment    variable  for    command-line  arguments,
  94.         which can be over-ridden on the command line.   Thus,
  95.         if you have done
  96.  
  97.          MINICOM='-m -c on'
  98.          export MINICOM
  99.  
  100.         or    the  equivalent,  and start minicom, minicom will
  101.         assume that your terminal has a Meta or <ALT> key and
  102.         that  color    is supported.    If you then log in from a
  103.         terminal without color  support,  and  you    have  set
  104.         MINICOM  in    your  startup    (.profile  or equivalent)
  105.         file, and don't want to re-set your environment vari-
  106.         able,  you    can type 'minicom -c off' and run without
  107.         color support for that session.
  108.  
  109.        configuration
  110.         The configuration argument is more interesting.  Nor-
  111.         mally,  minicom  gets its defaults from a file called
  112.         "minirc.dfl". If you  however  give    an  argument  to
  113.         minicom,  it will try to get its defaults from a file
  114.         called "minirc.configuration".  So it is possible  to
  115.         create  multiple  configuration  files, for different
  116.         ports, different users etc. Most sensible is  to  use
  117.         device  names,  such  as  tty1, tty64, sio2 etc. If a
  118.         user creates his own configuration file, it will show
  119.         up in his home directory as '.minirc.dfl'.
  120.  
  121. USE
  122.        Minicom is windows-based. To popup a window with the func-
  123.        tion you want, press Control-A (from now on, we    will  use
  124.        C-A  to mean Control-A), and then the function key (a-z or
  125.        A-Z). By pressing C-A first and then 'z',  a  help  screen
  126.        comes up with a short summary of all commands. This escape
  127.  
  128.  
  129.  
  130. Cohesive Systems        9 Oct 1993                2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. MINICOM(1)      Linux Programmer's Manual      MINICOM(1)
  137.  
  138.  
  139.        key can be altered when minicom is configured  (-s  option
  140.        or C-A O), but we'll stick to Control-A for now.
  141.  
  142.        For every menu the next keys can be used:
  143.     UP     arrow-up or 'k'
  144.     DOWN   arrow-down or 'j'
  145.     LEFT   arrow-left or 'h'
  146.     RIGHT  arrow-right or 'l'
  147.     CHOOSE Enter
  148.     CANCEL ESCape.
  149.  
  150.        The  screen  is    divided    into  two portions: the upper 24
  151.        lines are the terminal-emulator screen.    In  this  window,
  152.        ANSI  or    VT100 escape sequences are interpreted. If MINIX
  153.        emulation is chosen, this window will be 25 lines long (if
  154.        possible).   If there is a line left at the bottom, a sta-
  155.        tus line is placed there.  If this  is  not  possible  the
  156.        status line will be showed every time you press C-A.
  157.  
  158.        Possible    commands are listed next, in alphabetical order.
  159.        C-A  Pressing C-A a second time will just send  a  C-A  to
  160.         the    remote system.    If you have changed your "escape
  161.         character" to something other than    C-A,  this  works
  162.         analogously for that character.
  163.        A    Toggle 'Add Linefeed' on/off. If it is on, a linefeed
  164.         is added before every carriage  return  displayed  on
  165.         the screen.
  166.        B    Gives  you    a  scroll  back buffer. You can scroll up
  167.         with u, down with d, a page up with b,  a  page  down
  168.         with  f,  and  if  you  have  them the arrow and page
  169.         up/page down keys can also be used.
  170.        C    Clears the screen.
  171.        D    Dial a number, or go to the dialing directory.
  172.        E    Toggle local echo on and  off  (if    your  version  of
  173.         minicom supports it).
  174.        F    A break signal is sent to the modem.
  175.        G    Run script (Go). Runs a login script.
  176.        H    Hangup.
  177.        I    Toggle  the    type  of escape sequence that the cursor
  178.         keys send between normal and applications mode.  (See
  179.         also the comment about the status line below).
  180.        J    Jump  to a shell. On return, the whole screen will be
  181.         redrawn.
  182.        K    Clears the screen, runs kermit and redraws the screen
  183.         upon return.
  184.        L    Turn  Capture  file    on off. If turned on, all output
  185.         sent to the screen will be captured in the file  too.
  186.        M    Sends the modem initialization string.
  187.        O    Configure  minicom.    Puts  you  in    the configuration
  188.         menu.
  189.        P    Communication Parameters. Allows you  to  change  the
  190.         baudrate, parity and number of bits.
  191.        Q    Exit minicom without resetting the modem.
  192.        R    Recieve   files.   Choose    from   various    protocols
  193.  
  194.  
  195.  
  196. Cohesive Systems        9 Oct 1993                3
  197.  
  198.  
  199.  
  200.  
  201.  
  202. MINICOM(1)      Linux Programmer's Manual      MINICOM(1)
  203.  
  204.  
  205.         (external).
  206.        S    Send files. Ditto.
  207.        T    Choose Terminal emulation: Minix-Ansi(color)-vt100.
  208.        W    Toggle linewrap on/off.
  209.        X    Exit minicom, reset modem.
  210.        Z    Pop up the help screen.
  211.  
  212. DIALING DIRECTORY
  213.        By pressing C-A D the program asks:
  214.  
  215.         "Number to dial: (enter for dialing directory) " _
  216.  
  217.        You can now directly enter a  number  to    dial,    or  press
  218.        <enter>.    If  you enter the phone (not dialing directory)
  219.        number to dial, it  will    be  dialed,  and  if  you  press
  220.        <enter> then the dialing directory will be drawn.  You can
  221.        add, delete or edit entries.  By choosing "dial" the phone
  222.        number  of the highlighted entry will be dialed. While the
  223.        modem is dialing, you can press any key to cancel dialing.
  224.        Your  dialing  directory    will  be  saved  into a the file
  225.        ".dialdir" in your home directory.  You can scroll up  and
  226.        down with the arrow keys, but you can also scroll complete
  227.        pages by pressing the PageUp  or    PageDown  key.    If  you
  228.        don't  have  those, use Control-B (Backward) and Control-F
  229.        (Forward).
  230.  
  231.        The "edit" menu speaks for itself, but I will  discuss  it
  232.        briefly here.
  233.        A - Name    The name for this entry
  234.        B - Number
  235.          and its telephone number.
  236.        C - Dial string #
  237.          Which    specific  dial    string you want to use to
  238.          connect. There are three different dial  strings
  239.          (prefixes  and    suffixes) that can be configured
  240.          in the Modem and dialing menu.
  241.        D - Local echo
  242.          can be on or off for this system (if  your  ver-
  243.          sion of minicom supports it).
  244.        E - Script
  245.          The script that must be executed after a succes-
  246.          full connection is made (see the manual for run-
  247.          script)
  248.        F - Username
  249.          The  username    that  is  passed to the runscript
  250.          program.  It is passed in the environment string
  251.          "$LOGIN".
  252.        G - Password
  253.          The password is passed as "$PASS".
  254.        H - Terminal Emulation
  255.          Use MINIX, ANSI or VT100 emulation.
  256.        I - Line settings
  257.          Baudrate,  bits  and parity to use for this con-
  258.          nection.
  259.  
  260.  
  261.  
  262. Cohesive Systems        9 Oct 1993                4
  263.  
  264.  
  265.  
  266.  
  267.  
  268. MINICOM(1)      Linux Programmer's Manual      MINICOM(1)
  269.  
  270.  
  271. CONFIGURATION
  272.        By pressing C-A O you will be thrown into the setup  menu.
  273.        Most  settings  there can be changed by everyone, but some
  274.        are restricted to root only. Those priviliged settings are
  275.        marked with a star (*) here.
  276.  
  277.        Filenames and paths
  278.       This menu defines your default directories.
  279.       A - upload
  280.            where the uploaded files go to.
  281.       B - download
  282.            Yup, you guessed it.
  283.       C - script
  284.            Where you keep your login scripts.
  285.       D - Script program
  286.            Which  program  to  use as the script interpreter.
  287.            Defaults to the program "runscript",  but  if  you
  288.            want   to  use  something  else    (eg,  /bin/sh  or
  289.            "expect") it is possible.  Stdin    and  stdout  are
  290.            connected to the modem, stderr to the screen.
  291.            If the path is relative (ie, does not start with a
  292.            slash) then it's relative to your home  directory,
  293.            except for the script interpreter.
  294.       E - Kermit program
  295.            Where  to find the executable for kermit, and it's
  296.            options. Some simple macro's can be  used  on  the
  297.            command    line:  '%l'  is    expanded to the complete
  298.            filename of  the    dial  out-device,  and    '%b'  is
  299.            expanded to the current baudrate.
  300.  
  301.        File Transfer Protocols
  302.       Protocols  defined  here  will  show up when C-A s/r is
  303.       pressed.  "Name" is the name that will show up  in  the
  304.       menu. "Program" is the path to the protocol. "NeedName"
  305.       defines if the program needs an argument, eg. a file to
  306.       be  transmitted.  Up/Down  defines if this entry should
  307.       show up in the upload or the    download  menu.    Fullscr
  308.       defines  if the program should run full screen, or that
  309.       minicom  will    only  show  it's  stderr  in  a  window.
  310.       Finally,  IO-Red  defines  if minicom should attach the
  311.       program's standard in and output to the modem    port  or
  312.       not.    The  old  sz and rz are not full screen, and have
  313.       IO-Red set. However, there are curses based versions of
  314.       at  least  rz    that  do not want their stdin and stdout
  315.       redirected, and run full  screen.   All  file    transfer
  316.       protocols  are  run  with  the UID of the user, and not
  317.       with UID=root. '%l' and '%b' can be used on the command
  318.       line as with kermit.
  319.  
  320.        Serial port setup
  321.       *A - Serial device
  322.            /dev/tty1  for most people, or maybe /dev/tty64 if
  323.            you use the VC package under  minix.   /dev/cua<n>
  324.            or /dev/modem under linux.
  325.  
  326.  
  327.  
  328. Cohesive Systems        9 Oct 1993                5
  329.  
  330.  
  331.  
  332.  
  333.  
  334. MINICOM(1)      Linux Programmer's Manual      MINICOM(1)
  335.  
  336.  
  337.       *B - Lock file location
  338.            This  should be /usr/spool/uucp. If this directory
  339.            does not exist, minicom will not    attempt  to  use
  340.            lockfiles.
  341.       *C - Callin program
  342.            If  you have a uugetty or something on your serial
  343.            port, it could be that you want a  program  to  be
  344.            run   to    switch   the    modem    cq.   port  into
  345.            dialin/dialout mode. This is the    program  to  get
  346.            into dialin mode.
  347.       *D - Callout program
  348.            And this to get into dialout mode.
  349.       E - Baud/Par/Bits
  350.            Default parameters at startup.
  351.  
  352.       If  one  of  the  entries is left blank, it will not be
  353.       used. So if you don't care  about  locking,  and  don't
  354.       have    a  getty running on your modemline, entries B - D
  355.       should be left blank.    Be warned! The callin and  call-
  356.       out  programs    are  run  with    the effective user id of
  357.       "root", eg 0!
  358.  
  359.        Modem and Dialing
  360.       Here, the parameters for your modem are defined. I will
  361.       not  explain    this further because the defaults are for
  362.       generic Hayes modems, and should work always. This file
  363.       is not a Hayes tutorial :-) The only thing worth notic-
  364.       ing is that control characters can be sent by prefixing
  365.       them    with a '^', in which '^^' means '^' itself.  Some
  366.       options however, don't have much to do with  the  modem
  367.       but more with the behaviour of minicom itself:
  368.       M - Dial time
  369.            The  number of seconds before minicom times out if
  370.            no connection is established.
  371.       N - Delay before redial
  372.            Minicom will redial if no connection was made, but
  373.            it first waits some time.
  374.       O - Number of tries
  375.            Maximum    number    of times that minicom attempts to
  376.            dial.
  377.       P - Autobaud detect
  378.            If this is on, minicom tries to match  the  dialed
  379.            party's speed.
  380.       Q - Drop DTR to hangup
  381.            Normally    minicom hangs up by sending a Hayes-type
  382.            hangup sequence but if your Minix supports it,  it
  383.            can also hangup by dropping the DTR line.
  384.       R - Modem has DCD line
  385.            If  your    modem, and your O/S both support the DCD
  386.            line (that goes 'high' when a connection is  made)
  387.            minicom will use it.
  388.  
  389.         Note  that a special exception is made for this menu:
  390.         every user can change all parameters here,    but  they
  391.  
  392.  
  393.  
  394. Cohesive Systems        9 Oct 1993                6
  395.  
  396.  
  397.  
  398.  
  399.  
  400. MINICOM(1)      Linux Programmer's Manual      MINICOM(1)
  401.  
  402.  
  403.         will not be saved.
  404.  
  405.        Screen and keyboard
  406.       A - Command key is
  407.            the  'Hot  Key' that brings you into command mode.
  408.            If this is set to 'ALT' or  'meta  key',    you  can
  409.            directly    call  commands    by  alt-key  instead  of
  410.            HotKey-key.
  411.       B - Backspace key sends
  412.            There still are some systems that want a VT100  to
  413.            send  DEL  instead of BS. With this option you can
  414.            enable that  stupidity.    (Eh,  it's  even  on  by
  415.            default...)
  416.       C - Status line is
  417.            Enabled    or  disabled.  Some  slow  terminals (for
  418.            example, X-terminals) cause  the    status    line  to
  419.            jump "up and down" when scrolling, so you can turn
  420.            it off if desired. It will still be shown in  com-
  421.            mand-mode.
  422.  
  423.     Save setup as dfl
  424.       Save    the  parameters    as the default for the next time
  425.       the program is  started.  Instead  of    dfl,  any  other
  426.       parameter  name  may appear, depending on which one was
  427.       used when the program was started.
  428.  
  429.     Save setup as..
  430.       Save the parameters  under  a    special  name.    Whenever
  431.       Minicom  is  started    with this name as an argument, it
  432.       will use these parameters. This  option  is  of  course
  433.       priviliged to root.
  434.  
  435.     Exit
  436.       Escape from this menu without saving.    This can also be
  437.       done with ESC.
  438.  
  439.     Exit from minicom
  440.       Only root will see this menu entry, if  he/she  started
  441.       minicom  with the '-s' option. This way, it is possible
  442.       to change the configuration  without    actually  running
  443.       minicom.
  444.  
  445. STATUS LINE
  446.        The  status  line  has  several indicators, that speak for
  447.        themselves.  The mysterious APP or CUR indicator    probably
  448.        needs  explanation.  The    VT100    cursor keys can be in two
  449.        modes: applications mode and cursor  mode.  This    is  con-
  450.        trolled by an escape sequence. If you find that the cursor
  451.        keys do not work in, say, vi when you're logged    in  using
  452.        minicom    then  you can see with this indicator whether the
  453.        cursor keys are in applications or cursor  mode.    You  can
  454.        toggle the two with the C-A I key. If the cursor keys then
  455.        work, it's probably an error in the remote system's  term-
  456.        cap initialization strings (is).
  457.  
  458.  
  459.  
  460. Cohesive Systems        9 Oct 1993                7
  461.  
  462.  
  463.  
  464.  
  465.  
  466. MINICOM(1)      Linux Programmer's Manual      MINICOM(1)
  467.  
  468.  
  469. SECURITY ISSUES
  470.        Since  Minicom  runs  setuid  root,  you    probably want to
  471.        restrict access to it. This is possible by using a config-
  472.        uration    file  in the same directory as the default files,
  473.        called "minicom.users". The syntax of this file is as fol-
  474.        lowing:
  475.  
  476.         <username> <configuration> [configuration...]
  477.  
  478.        To  allow user 'miquels' to use the default configuration,
  479.        enter the following line into "minicom.users":
  480.  
  481.         miquels dfl
  482.  
  483.        If you want users to be able to use more than the  default
  484.        configurations, just add the names of those configurations
  485.        behind the user name. If no configuration is given  behind
  486.        the  username, minicom assumes that the user has access to
  487.        all configurations.
  488.  
  489. MISC
  490.        If minicom is hung, kill it with    SIGTERM  .  (This  means
  491.        kill  -15,  or  since sigterm is default, just plain "kill
  492.        <minicompid>". This will cause a graceful exit of minicom,
  493.        doing resets and everything.
  494.  
  495.        Since  a    lot of escape sequences begin with ESC (Arrow up
  496.        is ESC [ A), Minicom does not know if the escape character
  497.        it  gets    is  you  pressing  the    escape key, or part of a
  498.        sequence.
  499.  
  500.        An old version of Minicom, V1.2, solved this in    a  rather
  501.        crude  way:  to    get  the  escape key, you had to press it
  502.        twice.  Support for timing (with select) was already built
  503.        in  to  minicom    (see  file wkeys.c) and works great under
  504.        BSD, but alas, not under Minix.    The  same  problem,  but
  505.        worse, was with Televideo type terminals. Since they use a
  506.        lot of escape sequences that start with 'C-A', you had  to
  507.        press  'C-A'  twice  when  you  want to pop up a window or
  508.        something...
  509.  
  510.        As of release 1.3 this has bettered a little: now a 1-sec-
  511.        ond  timeout  is    builtin,  like in vi. And... surprise: a
  512.        special Minix and Linux-dependant hack :-) was added. Now,
  513.        minicom    can separate the escape key and escape-sequences.
  514.        To see how dirty this was done, look into wkeys.c.  But it
  515.        works like a charm!
  516.  
  517. AUTHORS
  518.        The author of minicom and the minicom manual is Miquel van
  519.        Smoorenburg (miquels@drinkel.nl.mugnet.org)
  520.  
  521.        Most of this man page is copied,    with  corrections,  from
  522.        the  minicom  manual,  but some pieces and the corrections
  523.  
  524.  
  525.  
  526. Cohesive Systems        9 Oct 1993                8
  527.  
  528.  
  529.  
  530.  
  531.  
  532. MINICOM(1)      Linux Programmer's Manual      MINICOM(1)
  533.  
  534.  
  535.        are by Michael K. Johnson (johnsonm@stolaf.edu).
  536.  
  537.  
  538.  
  539.  
  540.  
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592. Cohesive Systems        9 Oct 1993                9
  593.  
  594.  
  595.