home *** CD-ROM | disk | FTP | other *** search
/ Current Shareware 1994 January / SHAR194.ISO / modem / commo552.zip / ADDENDUM.DOC next >
Text File  |  1993-10-14  |  20KB  |  610 lines
  1.  
  2.  
  3.  
  4.  
  5.                            {COMMO} 5.52 Addendum
  6.                            _____________________
  7.  
  8.      This Addendum contains the major additions and/or changes to the
  9.      {COMMO} 5.41 documentation.  Print out this file and keep it with
  10.      your printed manual.  There is a complete list of changes (major
  11.      and minor) in the file HISTORY.
  12.  
  13.  
  14.      ===============================
  15.      In the User Guide and Reference
  16.      ===============================
  17.  
  18.  
  19.      Under "Command Line Options - Switches"
  20.      ---------------------------------------
  21.  
  22.      /{parms}       Default Dialing Parameters
  23.  
  24.           Any or all parameters may be specified.  Included parameters
  25.           will override those in the "ddp=" item in the Setup File.
  26.  
  27.  
  28.      Under "Alt-G  Edit Setup File"
  29.      ------------------------------
  30.  
  31.      _________________________________________________
  32.  
  33.      {sfc=yes}
  34.          Software (XON/XOFF) Flow Control (yes/no)
  35.      {hfc=auto}
  36.          Hardware (RTS/CTS) Flow Control (auto/yes/no)
  37.      _________________________________________________
  38.  
  39.           These are used to control the flow of data between your
  40.           computer and the remote system.  They prevent loss of data
  41.           when one end can send faster than the other end can process
  42.           the information.
  43.  
  44.           The "auto" setting for Hardware Flow Control should be used
  45.           in most cases.  {COMMO} will enable/disable Hardware Flow
  46.           Control based on the state of the CTS (Clear To Send)
  47.           signal.  The other settings should not be used unless you
  48.           have an unusual hardware configuration.
  49.  
  50.           See Appendix C for more information on flow control.
  51.  
  52.  
  53.  
  54.      __________________________________________
  55.  
  56.      {clm=auto}    Color Mode (auto/color/mono)
  57.      __________________________________________
  58.  
  59.           If this item is set to "auto," {COMMO} will auto detect the
  60.           display type and use the proper mode.  The default modes are
  61.           "color" for color displays and "mono" for monochrome
  62.           displays.
  63.  
  64.           If you have a laptop with a black and white LCD display
  65.           (VGA, EGA or CGA compatible), you can use the "mono" mode to
  66.           improve the contrast (color items below are ignored).
  67.  
  68.           Setting the mode to "color" will force the use of the
  69.           colors/attributes in the items below.  This is useful if you
  70.           have a monochrome display and you prefer to set your own
  71.           attributes.
  72.  
  73.           Press F7 while editing the Setup File (or other files) to
  74.           pop up the color chart.  You may use it with color or
  75.           monochrome displays.  Color settings have no effect when the
  76.           Color Mode is "mono" (or "auto" with a monochrome display).
  77.  
  78.           NOTE:  Terminal Screen colors/attributes may still be
  79.           changed if ANSI display data is received from the host.  It
  80.           may be necessary to adjust your settings at the host.
  81.  
  82.  
  83.      Under "Uploading and Downloading"
  84.      ---------------------------------
  85.  
  86.      Files for uploading (sending) are chosen from the file selection
  87.      menu (supported by SELECT.MAC).  Only one file should be selected
  88.      when using the Xmodem protocol.
  89.  
  90.  
  91.  
  92.      ==============================
  93.      In the Macro Programming Guide
  94.      ==============================
  95.  
  96.      ------------------------------------
  97.      New or Changed Function Descriptions
  98.      ------------------------------------
  99.  
  100.      _______
  101.  
  102.      CAPTure
  103.      _______
  104.  
  105.      Default key:   Alt-1
  106.      Description:   Capture File Options.
  107.  
  108.      Switches:
  109.  
  110.                N1 or N   Do not wait for a keypress if the disk fills
  111.                          up while capturing (a message is displayed
  112.                          for several seconds).  The setting remains in
  113.                          effect until the Capture File is closed.
  114.  
  115.                          NOTE:  This switch is effective only on a
  116.                          CAPTure function that successfully opens a
  117.                          Capture File.
  118.  
  119.                N0        Wait for Esc to be pressed if the disk fills
  120.                          up (default).
  121.  
  122.      Examples:
  123.  
  124.           {capture}                     Open Capture File Options
  125.                                         window.
  126.  
  127.           {capture y}                   Open current Capture File.
  128.  
  129.           {capture n}                   Close current Capture File.
  130.  
  131.           {capt y,c:\commo\file.xyz}    Open indicated Capture File.
  132.  
  133.           {capt n,c:\dl\newfile.cap}    Close current Capture File,
  134.                                         set new file as indicated.
  135.  
  136.      The current Capture File will always be closed when a new file is
  137.      opened.
  138.  
  139.      IMPORTANT!  If the disk fills while capture is open, a "disk
  140.      full" message will appear (see the "N" switch above) and the file
  141.      will be closed.  The built-in variable "_dfc" will be set to 1.
  142.  
  143.      See also CAPMode.
  144.  
  145.  
  146.  
  147.      ____
  148.  
  149.      FILE
  150.      ____
  151.  
  152.      Default key:   none
  153.      Description:   Find directory entry information.
  154.  
  155.      General form:
  156.  
  157.           {FILE filespec}
  158.  
  159.                filespec       The path and file mask to be used for
  160.                               finding directory entries (filenames and
  161.                               subdirectories).  May consist of drive,
  162.                               path and filename with wildcards.
  163.  
  164.      Switches:
  165.  
  166.                X1 or X        Find next matching entry.
  167.  
  168.                X0             Find first matching entry (default).
  169.  
  170.      Examples:
  171.  
  172.           {file c:\upload\*.*}     Find first filename or subdirectory
  173.                                    in the directory "c:\upload."
  174.  
  175.           {file-x}                 Find next filename in same
  176.                                    directory.
  177.  
  178.      The FILE function will find directory information about files and
  179.      subdirectories specified in "filespec."  The data will be made
  180.      available in the following built-in variables:
  181.  
  182.           _ffn      Filename or subdirectory name.  Subdirectory names
  183.                     will be preceded with a "\".  The parent directory
  184.                     (if any) will be indicated as "\..".
  185.  
  186.           _ffs      File size in bytes.
  187.  
  188.           _ffd      File date.  The format will be as specified in
  189.                     Setup File item "dat=".
  190.  
  191.           _fft      File time.  The format will be as specified in
  192.                     Setup File item "tim=".
  193.  
  194.      The FILE function must be executed without the "X" switch (or
  195.      with X0) to initialize the directory.  This will also make
  196.      available the first filename or subdirectory.  Subsequent
  197.      executions (with the "X" switch) will make subsequent names
  198.      available.
  199.  
  200.      Use the IFCOndition function to determine if a filename was made
  201.      available.  The first label ("true") will be taken if a filename
  202.  
  203.  
  204.  
  205.      was found;  the second label ("false") will be taken if no
  206.      additional filenames are available.
  207.  
  208.      NOTE:  The built-in variables will always contain the data for
  209.      the last filename found.  If no filename has ever been found, the
  210.      contents are unpredictable.
  211.  
  212.      _____
  213.  
  214.      IFxxx     NOTE:  The following applies to all "IF" functions.
  215.      _____
  216.  
  217.      Switches:
  218.  
  219.                C1 or C   A CALL is performed on the label.  When the
  220.                          CALLed routine RETUrns, execution will
  221.                          continue following the IFxxx.
  222.  
  223.                C0        A GOTO is performed (default).
  224.  
  225.      Examples:
  226.  
  227.                {ifxxx label10,label20}            Using GOTO
  228.                {ifxxx-c label10,label20}          Using CALL
  229.  
  230.      ______
  231.  
  232.      INFOrm
  233.      ______
  234.  
  235.      Default key:   none
  236.      Description:   Display an advisory message.
  237.  
  238.      General form:
  239.  
  240.           {INFOrm string}
  241.  
  242.                string    Message to be displayed.
  243.  
  244.      Switches:
  245.  
  246.                Q1 or Q   Query the user for a "Yes/No" response. 
  247.                          "Yes" will be the default if Enter is
  248.                          pressed.
  249.  
  250.                          The Condition Flag will be set to "true" if
  251.                          the response is "yes".  It will be set to
  252.                          "false" if the response is "no".  Test with
  253.                          IFCOndition.
  254.  
  255.                Q0        Query the user for a "Yes/No" response.  "No"
  256.                          will be the default if Enter is pressed.  The
  257.                          Condition Flag is set as above.
  258.  
  259.  
  260.  
  261.                Dn        Display the message for "n" seconds, then
  262.                          continue.  "n" may range from 1 to 999.
  263.  
  264.                S1 or S   An error sound will accompany the message
  265.                          (default).
  266.  
  267.                S0        No error sound will be made.
  268.  
  269.      Examples:
  270.  
  271.           {inform Press a key to continue}        Wait for Esc.
  272.           {info-qs0 Overwrite the file?}          Yes/No response, no
  273.                                                   error sound.
  274.           {info-d3 Login now in progress}         Display message for
  275.                                                   3 seconds, then
  276.                                                   continue.
  277.  
  278.      INFOrm will display a string in a pop-up box over the Terminal
  279.      Screen.  {COMMO} will normally wait for "Esc" to be pressed
  280.      (switches can alter this behavior).  The string length is limited
  281.      by the width of the screen.
  282.  
  283.      NOTE:  When the "Q" switch is used, Esc and Ctrl-Break will be
  284.      ignored.
  285.  
  286.      _______
  287.  
  288.      MACLoad
  289.      _______
  290.  
  291.           NOTE:  Only the description of MACLoad has been changed (to
  292.           provide more information).  The operation of the function is
  293.           the same.
  294.  
  295.      Default key:   none
  296.      Description:   Load a new Macro File.
  297.  
  298.      General form:
  299.  
  300.           {MACLoad filename,label}
  301.  
  302.                filename       The new Macro File.  Do NOT specify a
  303.                               path; the {COMMO} home directory will be
  304.                               used.
  305.  
  306.                label          A label to GOTO when the new file is
  307.                               loaded.  Optional.
  308.  
  309.      Switches:
  310.  
  311.                R1 or R   Specifies that COMMO.MAC will be reloaded
  312.                          when carrier detect is lost.  Normally this
  313.                          would occur at the end of the call.
  314.  
  315.  
  316.  
  317.                R0        Do not reload COMMO.MAC when carrier is lost
  318.                          (default).
  319.  
  320.      Examples:
  321.  
  322.           {macload-R vt102-1.mac}       Load vt102-1.mac, reload
  323.                                         COMMO.MAC at the end of the
  324.                                         call.
  325.  
  326.           {macl newmac.fil,abc}         Load newmac.fil, start macro
  327.                                         "abc" in the new file.
  328.  
  329.           {macload commo.mac,%mcall}    Load COMMO.MAC, GOTO the label
  330.                                         specified in the variable
  331.                                         "mcall".
  332.  
  333.      IMPORTANT!  The new Macro File must reside in the {COMMO} home
  334.      directory (do not specify a path).
  335.  
  336.      TIPS on using MACLoad:
  337.  
  338.      >    The new Macro File can be "called" (by setting a variable to
  339.           the return label).  Use this variable as the optional label
  340.           when "returning" to the calling Macro File.
  341.  
  342.      >    The macro stack is preserved during MACLoad.  Be sure that
  343.           your CALLs and RETUrns are in "sync" or the results may be
  344.           unpredictable.
  345.  
  346.      >    The current file will be saved to disk if changes are
  347.           outstanding.  The new file is then loaded in place of the
  348.           current one (all macros are replaced).  
  349.  
  350.      >    MACLoad should be the last function in a macro, since
  351.           control is not returned.
  352.  
  353.      ____
  354.  
  355.      MENU
  356.      ____
  357.  
  358.           NOTE:  The only change to MENU is the addition of the
  359.           "_menter" variable.
  360.  
  361.      Default key:   none
  362.      Description:   Create a pop-up macro menu.
  363.  
  364.      General form:
  365.  
  366.           {SETV _menu1,text1}
  367.           {SETV _menu2,text2}
  368.                ...
  369.           {SETV _menuN,textN}
  370.  
  371.  
  372.  
  373.                text1
  374.                     Text to be placed on first information line in the
  375.                     pop-up window (third line down, counting from the
  376.                     top border).
  377.  
  378.                     NOTE:  These text strings are simply information
  379.                     and have no effect on which macros will be
  380.                     executed.
  381.  
  382.                text2
  383.                     Text to be placed on second information line.
  384.                ...
  385.  
  386.                textN
  387.                     Text to be placed on Nth information line.
  388.  
  389.           {SETV _mlabel,label1,label2,...}
  390.  
  391.                NOTE:  Labels are positional and may be omitted using
  392.                null arguments for keys that aren't used.  See example
  393.                2 below.
  394.  
  395.                label1
  396.                     Label to GOTO if F1, A or 1 is pressed.  Any of
  397.                     the three keys will activate the macro at the
  398.                     first label.
  399.  
  400.                label2
  401.                     Label to GOTO if F2, B or 2 is pressed.
  402.  
  403.                ... etc.
  404.  
  405.           {SETV _menter,label}
  406.  
  407.                label
  408.                     Label to GOTO if Enter is pressed.
  409.  
  410.           {SETV _mcolor,text,border}
  411.  
  412.                text
  413.                     Colors for the text area of the pop-up window.
  414.  
  415.                border
  416.                     Colors for the window border.
  417.  
  418.                NOTE:  The attributes are specified in the same manner
  419.                as the colors in the Setup File (press F7 in the
  420.                Internal Editor to display the Color Chart).  
  421.  
  422.           {MENU height,width,string}
  423.  
  424.                height
  425.                     Total number of rows from top to bottom of pop-up
  426.                     window, including borders.  Minimum is 5.
  427.  
  428.  
  429.  
  430.                width
  431.                     Total number of columns from left side to right
  432.                     side, including borders.  Minimum is 23.
  433.  
  434.                string
  435.                     Title string that will appear in the top border.
  436.  
  437.      Example 1:
  438.  
  439.                {setv _menu1, F1  Call computer at work}
  440.                {setv _menu3, F2  Call E-mail service}
  441.                {setv _menu5, F3  Run offline mail reader}
  442.                {setv _mlabel,work,mail,reader}
  443.                {setv _mcolor,17,30}
  444.                {menu 9,32,Daily Activity Menu} {}
  445.  
  446.           {:work}    ... macro to call work computer.
  447.           {:mail}    ... macro to call E-mail service.
  448.           {:reader}  ... macro to run offline reader.
  449.  
  450.           This menu specifies that function keys be pressed to
  451.           activate the macros.  You could also press A or 1 instead of
  452.           F1, B or 2 instead of F2, etc.  The macros may be as simple
  453.           or as complex as desired to complete the task.
  454.  
  455.      Example 2:
  456.  
  457.                {setv _menu1, [D]  Dialing Directory}
  458.                {setv _menu4, [E]  Edit a file}
  459.                {setv _menu2, [M]  Macro File}
  460.                {setv _menu3, [Enter]  Shell to DOS (with swap)}
  461.                {setv _mlabel,,,,ddir,edit,,,,,,,,mfile}
  462.                {setv _menter,dos}
  463.                {setv _mcolor,03,47}
  464.                {menu 8,39,Common Commands} {}
  465.  
  466.           {:ddir}  {dial} {}
  467.           {:edit}  {input efile,Filename to Edit}
  468.                    {edit %efile} {}
  469.           {:mfile} {macro}
  470.           {:dos}   {shell-s} {}
  471.  
  472.           This menu uses "mnemonic" key labeling -- D for (D)ialing
  473.           Directory, etc.  Notice that there are three empty positions
  474.           in the "_mlabel" list prior to "ddir" and "edit".  These
  475.           correspond to A, B and C, which are not used in this menu. 
  476.           Then there are empty positions up to "mfile" (M).
  477.  
  478.      TIPS on using MENU:
  479.  
  480.      >    The dimensions of the window are limited by the current size
  481.           of the Terminal Screen.
  482.  
  483.  
  484.  
  485.      >    The total number of displayable lines is "height" less 4. 
  486.           Lines in the window for which no "_menux" variable has been
  487.           defined will be left blank.
  488.  
  489.      >    Up to 26 labels can be specified in each menu.  These
  490.           correspond to pressing the letters A through Z.  The first
  491.           12 labels also correspond to pressing F1 through F12, while
  492.           the first 9 labels correspond to pressing 1 through 9.
  493.  
  494.      >    The built-in variable "_msn" is set to the number of the
  495.           menu selection when a menu key is pressed: 0 for Enter, 1 to
  496.           26 for A to Z, etc.
  497.  
  498.      >    All variables used to create the menu are automatically
  499.           deleted from Variable Space after the menu is displayed. 
  500.  
  501.      >    The last colors used to display a menu will persist until
  502.           they are changed (by setting the "_mcolor" variable).
  503.  
  504.      >    If Esc is pressed to exit the menu, macro processing
  505.           continues in sequence following the MENU function.
  506.  
  507.      See also MACRo.
  508.  
  509.      _____
  510.  
  511.      PAUSe
  512.      _____
  513.  
  514.      Default key:   none
  515.      Description:   Pause for a time interval.
  516.  
  517.      Switches:
  518.  
  519.           T or T1
  520.                Time is specified in DOS clock ticks (there are 18
  521.                clock ticks per second).
  522.  
  523.           T0
  524.                Time is specified in seconds (default).
  525.  
  526.      Examples:
  527.  
  528.           {pause 25}
  529.                Pause for 25 seconds.
  530.  
  531.           {pause-t 9}
  532.                Pause for 9 clock ticks (one half second).
  533.  
  534.      NOTE:  Incoming characters displayed during a PAUSe function are
  535.      not seen by subsequent SSLOok/CALOok/GOLOok/LOOKfor functions.
  536.  
  537.  
  538.  
  539.      ______
  540.  
  541.      WINDow
  542.      ______
  543.  
  544.      Default key:   none
  545.      Description:   Preserve window display.
  546.  
  547.      Switches:
  548.  
  549.                K1 or K   Do not allow the Terminal Screen to be
  550.                          restored when exiting from a window.
  551.  
  552.                K0        Allow the Terminal Screen to be restored when
  553.                          exiting from a window (default).
  554.  
  555.      Examples:
  556.  
  557.           {window-k}          Don't restore the Terminal Screen.
  558.  
  559.           {wind-k0}           Restore the Terminal Screen.
  560.  
  561.      This function will prevent the Terminal Screen from being
  562.      restored after a window function exits.  It is useful for making
  563.      smooth, flicker-free transitions between windows or for placing
  564.      one pop-up window on top of another.
  565.  
  566.      The condition will remain active until either the "k0" switch is
  567.      used or the macro terminates.
  568.  
  569.  
  570.      Under RYMOdem and SYMOdem
  571.      -------------------------
  572.  
  573.           D1 or D
  574.                Cancel transfer if carrier detect is lost (default).
  575.  
  576.                NOTE:  If carrier detect is off when the transfer is
  577.                started, this switch will behave as if "D0" had been
  578.                set.
  579.  
  580.           D0
  581.                Ignore state of carrier detect.
  582.  
  583.  
  584.      ---------------------------------
  585.      New or Changed Built-in Variables
  586.      ---------------------------------
  587.  
  588.           _dsk      Current disk (e.g., C:)
  589.           _dir      Current directory (e.g., \upload, \)
  590.  
  591.           _ffn      Find file name (use with FILE function)
  592.           _ffs      Find file size
  593.           _ffd      Find file date
  594.  
  595.  
  596.  
  597.           _fft      Find file time
  598.  
  599.           _msn      Menu label selection number, from last MENU
  600.                     function (0 for Enter, 1 to 26 for A to Z, etc.)
  601.  
  602.           _nam      Current System Name (up to 40 chars)
  603.           _num      Current Phone Number (up to 40 chars)
  604.  
  605.           _ela      Elapsed time in minutes:seconds
  606.  
  607.  
  608.                                   - end -
  609.  
  610.