home *** CD-ROM | disk | FTP | other *** search
/ PC Online 1996 October / PCO_10.ISO / filesbbs / commo.arj / ADDENDUM.DOC < prev    next >
Encoding:
Text File  |  1996-08-24  |  11.2 KB  |  298 lines
  1.  
  2.  
  3.  
  4.  
  5.                               {COMMO} 7.0 Addendum
  6.                               _____________________
  7.  
  8.      This Addendum contains the major additions and/or changes to the
  9.      {COMMO} 6.6 documentation.  Print out this file and keep it with your
  10.      printed manual.  There is a complete list of changes (major and minor)
  11.      in the file HISTORY.
  12.  
  13.      ===============================
  14.      In the User Guide and Reference
  15.      ===============================
  16.  
  17.      Under "[Alt-G]  Edit Setup File"
  18.      --------------------------------
  19.  
  20.      _____________________________________
  21.  
  22.      {com=1,3f8,4}   Com1 port address/IRQ
  23.      {com=2,2f8,3}   Com2 port address/IRQ
  24.      {com=3,3e8,4}   Com3 port address/IRQ
  25.      {com=4,2e8,3}   Com4 port address/IRQ
  26.      _____________________________________
  27.  
  28.           These are the hardware serial port base address and IRQ
  29.           assignments (the settings shown are the defaults).  COM3 and COM4
  30.           usually require a different IRQ setting.
  31.  
  32.           NOTE:  If you need to define more than four ports, you can add
  33.           extra "com" items (up to "com=16,...").
  34.  
  35.           Port addresses are in hexadecimal and may range from 0 to ffff
  36.           (use addresses below 200 with caution).  If the documentation
  37.           shows a range of addresses, such as "3f8-3ff," use the first
  38.           value as the base address.
  39.  
  40.           IRQ numbers are decimal and may range from 2 to 15 (avoid use of
  41.           IRQ numbers that are used by system hardware, such as 6, 8, 13 or
  42.           14).  If your serial port hardware is configured for IRQ 2, you
  43.           may get better results on AT class machines if you specify IRQ 9
  44.           in {COMMO}.
  45.  
  46.           The serial port base address and IRQ number for the current port
  47.           are available to macros in the built-in variables "_pad" and
  48.           "_irq" respectively.
  49.  
  50.           You can also specify the maximum speed or "frequency" for each
  51.           serial port by adding a fourth parameter (default is 115200). 
  52.           For example, if you have a port that has a frequency of 256000
  53.           you might have:
  54.  
  55.                {com=4,2e8,5,256000}
  56.  
  57.  
  58.  
  59.           The frequency value is the speed that results when the Baud Rate
  60.           Divisor is equal to one (which is usually the crystal frequency
  61.           divided by 16).  It may be as high as 40,000,000 bps.
  62.  
  63.      _________________________________________________
  64.  
  65.      {min=auto}   Send Modem Init String (auto/yes/no)
  66.      _________________________________________________
  67.  
  68.           If this is set to "auto" {COMMO} will send the Modem
  69.           Initialization String at program startup only if carrier detect
  70.           is off.  This allows you to exit the program and restart while
  71.           still online.
  72.  
  73.           If "yes" {COMMO} will send the string regardless of the state of
  74.           carrier detect.  If "no" {COMMO} will not send the string.
  75.  
  76.           You can override this item with the "/iy" or "/in" command line
  77.           switch.
  78.  
  79.      _________________________________________________
  80.  
  81.      {vsp=3}   Variable Space size in kilobytes (1-64)
  82.      _________________________________________________
  83.  
  84.           This may need to be increased if you run macros that use a lot of
  85.           variables.  Usually the author of the macro will indicate how
  86.           much space is required.
  87.  
  88.  
  89.      Under "[Alt-U]  Utility Menu"
  90.      -----------------------------
  91.  
  92.      The Utility Menu contains a selection of features supported by macros
  93.      in COMMO.MAC.  Current features include:
  94.  
  95.           Add an entry to the Dialing Directory.
  96.           Set current terminal emulation.
  97.           Run the host mode macro, MOSTHOST.MAC.
  98.           Edit the host mode macro.
  99.           Edit any external text file less than 64k in size.
  100.           Run any macro by name (label).
  101.           Load any auxiliary Macro File.
  102.           Unload the current auxiliary Macro File.
  103.           Modify certain setup items for the current session.
  104.           Toggle the Speech Friendly Interface ON/OFF.
  105.  
  106.      NOTE:  The Utility Menu may not be available (or may have different
  107.      features on its menu) if an auxiliary Macro File has been loaded.
  108.  
  109.  
  110.  
  111.      ==============================
  112.      In the Macro Programming Guide
  113.      ==============================
  114.  
  115.      -------------------------------
  116.      Additions to existing functions
  117.      -------------------------------
  118.  
  119.      Under INPUt, switches
  120.      ---------------------
  121.  
  122.           Ln
  123.                Length of the input field, "n" may range from 1 to 120
  124.                (default is 60).
  125.  
  126.  
  127.      Under SETEsc, switches
  128.      ----------------------
  129.  
  130.           K0
  131.                Ignore all typed keys except Ctrl-Break (i.e., lock the
  132.                keyboard).  If a macro label is included, the macro will be
  133.                executed when Ctrl-Break is pressed (there will be no
  134.                prompt).  Otherwise Ctrl-Break causes the macro to STOP.  In
  135.                either case, the keyboard is active again as soon as Ctrl-
  136.                Break is pressed.
  137.  
  138.                NOTE:  System keys such as Ctrl-Alt-Del, Shift-PrtSc,
  139.                NumLock, etc., are not affected (they remain active).
  140.  
  141.           K1 or K
  142.                  Allow all keys (default).
  143.  
  144.  
  145.      Under SETLook
  146.      -------------
  147.  
  148.      Default key:   none
  149.      Description:   Set parameters for LOOKfor functions.
  150.  
  151.      General form:
  152.  
  153.           {SETLook seconds,label,seconds,response}
  154.  
  155.                seconds
  156.                     LOOKfor timeout.  Maximum time in seconds to look for
  157.                     strings.  If no string is found in the allotted time,
  158.                     the macro in the second argument will be started.  May
  159.                     be 0 to 999.  Note that this timer is restarted
  160.                     whenever a string is sent by SSLOok.  Default is 0
  161.                     (disabled).
  162.  
  163.  
  164.  
  165.                label
  166.                     Timeout macro.  Macro to GOTO if the time in the first
  167.                     argument expires.  If no macro is specified or if the
  168.                     macro label is invalid, control will pass to the
  169.                     function following the LOOKfor.
  170.  
  171.                     IMPORTANT!  If the LOOKfor is in a CALLed subroutine,
  172.                     be sure to execute a RETUrn or POPS at the label.
  173.  
  174.                seconds
  175.                     "No data" timeout.  If no characters are received from
  176.                     the remote system for the specified amount of time,
  177.                     {COMMO} will take action as indicated by the "N" switch
  178.                     (see below).  The timer is restarted whenever a
  179.                     character is received.  May be 0 to 999.  Default is 0
  180.                     (disabled).
  181.  
  182.                     IMPORTANT!  The timeout should be long enough (or
  183.                     disabled entirely) to prevent a premature response.
  184.  
  185.                response
  186.                     This argument is a string or a macro label depending on
  187.                     the setting of the "N" switch (see below).  Default is
  188.                     no string or label.
  189.  
  190.      Switches:
  191.  
  192.           N0
  193.                The response argument is a string (up to 32 characters). 
  194.                This is useful if unexpected prompts appear, such as "Press
  195.                any key" or "More [Y/n]".  Specify a generic response such
  196.                as "|" or "n|" and {COMMO} will send it each time the "no
  197.                data" timer expires (default).
  198.  
  199.                NOTE:  The timer will be restarted after the response is
  200.                sent or if any keys are typed while waiting (allowing a
  201.                manual response to a prompt which the macro does not
  202.                handle).
  203.  
  204.           N or N1
  205.                The response argument is a macro label.  If the "no data"
  206.                timer expires, {COMMO} will GOTO the label.
  207.  
  208.      Examples:
  209.  
  210.           {setl 60,abc,4,n|}
  211.                The LOOKfor timeout is set to 60 seconds; GOTO "abc" if the
  212.                timer expires.  If no characters are received for 4 seconds,
  213.                send the string "n|" (and keep looking).
  214.  
  215.  
  216.  
  217.           {setl-n 300,toolong,30,nodata}
  218.                The LOOKfor timeout is set to 300 seconds; GOTO "toolong" if
  219.                the timer expires.  If no characters are received for 30
  220.                seconds, GOTO the label "nodata".
  221.  
  222.      The SETLook function will set parameters for subsequent LOOKfor
  223.      functions and may be executed at any time to modify the parameters.
  224.  
  225.      When macro execution terminates, the parameters will be reset to the
  226.      default values.
  227.  
  228.      Default arguments are:
  229.  
  230.           LOOKfor timeout     0 (disabled)
  231.           Timeout macro       none 
  232.           "No data" timeout   0 (disabled)
  233.           Response            none
  234.  
  235.      IMPORTANT!  Null arguments in the SETLook function will revert to
  236.      these defaults.
  237.  
  238.      See also LOOKfor, SSLOok, CALOok, GOLOok.
  239.  
  240.  
  241.      =================
  242.      In the Appendices
  243.      =================
  244.  
  245.      Under "Appendix I   List of Reserved Variables"
  246.      -----------------------------------------------
  247.  
  248.        _cfs        Capture File status: 0=closed, 1=open
  249.        _elt        Elapsed timer in clock ticks (55 ms)
  250.  
  251.  
  252.      Under "Appendix L   External Communications Drivers (INT 14)"
  253.      -------------------------------------------------------------
  254.  
  255.      {COMMO} supports external communications drivers that use the standard
  256.      INT 14 (BIOS) interface.  These include various FOSSIL drivers,
  257.      network communications drivers, Internet protocol drivers and the BIOS
  258.      in your computer (the original INT 14 interface).
  259.  
  260.      You tell {COMMO} to use the driver by specifying the port speed as
  261.      "*s", where "s" is a number from 0 to 7.  For example:
  262.  
  263.           {bps=*7}                 Setup File
  264.           {parm *7,8n1,3,A,0}      Macro File
  265.           {*5,7e1,1,V,0}           Dialing Directory
  266.  
  267.      The driver will map the number 0 to 7 into a port speed.  The standard
  268.      (BIOS) mapping is 0=110 bps, 1=150 bps, 2=300 bps, 3=600 bps, 4=1200
  269.      bps, 5=2400 bps, 6=4800 bps, 7=9600 bps.  Some drivers map other
  270.  
  271.  
  272.  
  273.      speeds.  For example, the X00 FOSSIL driver maps 0=19200 bps and
  274.      1=38400 bps to allow speeds higher than 9600 bps.
  275.  
  276.      Consult your driver documentation for details on installation and
  277.      speed mapping.  Drivers may allow the speed to be "locked" (when
  278.      installing the driver) and ignore the speed code provided by {COMMO}.
  279.  
  280.      Note also that drivers may map port numbers as 0=COM1, 1=COM2, etc. 
  281.      In {COMMO} you still use 1=COM1, 2=COM2, etc.  The corresponding "com"
  282.      item in the Setup File is ignored in driver mode.
  283.  
  284.      TIPS on using the X00 FOSSIL driver:
  285.  
  286.       *   Use the XU utility to activate the FOSSIL (prior to starting
  287.           {COMMO}) or X00 will be operating in BIOS emulation mode only.
  288.  
  289.       *   In Win95 X00 may work better if you load it in the DOS window
  290.           where it will be used.
  291.  
  292.       *   In Win95 you may get better results if you increase the size of
  293.           the transmit and receive buffers to 2048 bytes.
  294.  
  295.  
  296.                               - end -
  297.  
  298.