home *** CD-ROM | disk | FTP | other *** search
/ Power CD-ROM!! 7 / POWERCD7.ISO / dos / commo641 / addendum.doc next >
Text File  |  1994-11-20  |  13KB  |  380 lines
  1.  
  2.  
  3.  
  4.                              {COMMO} 6.41 Addendum
  5.                              _____________________
  6.  
  7.      This Addendum contains the major additions and/or changes to the
  8.      {COMMO} 6.0 documentation.  Print out this file and keep it with your
  9.      printed manual.  There is a complete list of changes (major and minor)
  10.      in the file HISTORY.
  11.  
  12.  
  13.      ===============================
  14.      In the User Guide and Reference
  15.      ===============================
  16.  
  17.      Under "[Alt-G]  Edit Setup File"
  18.      ------------------------------
  19.  
  20.      ___________________________________________________________
  21.  
  22.      {set zr_mode,r}   Zmodem like-named file mode (s/r/n/o)
  23.                          s=skip, r=resume, n=rename, o=overwrite
  24.      ___________________________________________________________
  25.  
  26.           This variable tells {COMMO} what to do when a file being received
  27.           with Zmodem already exists in your download directory.  See
  28.           "[PgUp]/[PgDn]  Uploading/Downloading" for details.
  29.  
  30.           NOTE:  This variable can be changed at any time by pressing "M"
  31.           in the Download Protocol Menu.
  32.  
  33.      _____________________________________________
  34.  
  35.      {set sel_pns,no}
  36.          Use COMMOPNS for upload picklist (yes/no)
  37.      _____________________________________________
  38.  
  39.           COMMOPNS is a shareware program that lets you tag files for
  40.           uploading.  It operates faster and displays more files at one
  41.           time than {COMMO}'s file selector macro.  Set this item to "yes"
  42.           after installing COMMOPNS.EXE in your "protodir" directory.
  43.  
  44.           IMPORTANT!  Do not use the macros supplied with COMMOPNS.
  45.  
  46.           The archive PNS52.ZIP is supplied on the {COMMO} registration
  47.           disk.  It may also be found on many fine BBS's.
  48.  
  49.  
  50.  
  51.      Under "[Alt-M]  Macro File"
  52.      -------------------------
  53.  
  54.      ----------  Compiling Macro Files
  55.  
  56.      NOTE:  Use of compiled macros is unavailable during shareware
  57.      evaluation.
  58.  
  59.      Macro Files may be compiled to increase speed, to reduce size and to
  60.      improve security of source code.  Compiling is done from within the
  61.      Macro File window (see Online Help for the keys used to load and
  62.      compile Macro Files).  The default extension for {COMMO} compiled
  63.      macros is .CCM, but you may edit the filename as desired.
  64.  
  65.      A compiled Macro File is used in exactly the same way as a source
  66.      Macro File.  The only difference is that in-window operations, such as
  67.      searching for text or starting a macro with the Selector Bar, are not
  68.      available.  This means that the {macro string} style of menus is also
  69.      not available.  Use the MENU function instead.
  70.  
  71.      TIPS on using compiled macros:
  72.  
  73.       *   The Macro Compiler version number is shown on the startup screen. 
  74.           This must match the version number in the compiled Macro File. 
  75.           To see the version number in the file, use the DOS "type" command
  76.           or your favorite file viewer or editor.
  77.  
  78.       *   Macro function names (LOOKfor, SEND, etc.) are checked for
  79.           validity at compile time, but all other errors are reported at
  80.           run time.  Be aware that the location of the error cannot be
  81.           shown without the source macros.
  82.  
  83.  
  84.      Under [PgUp]/[PgDn]  Uploading/Downloading
  85.      ------------------------------------------
  86.  
  87.      ----------  Internal Protocols
  88.  
  89.      {COMMO} provides an extremely fast and efficient version of the Zmodem
  90.      protocol, plus a number of variations on the Xmodem and Ymodem
  91.      protocols.  These afford you varying degrees of convenience, speed and
  92.      security.
  93.  
  94.      ZMODEM is the preferred protocol on most host systems.  It features
  95.      automatic startup of downloads, multi-file transfers and automatic
  96.      naming and dating of received files.  Zmodem also affords greater data
  97.      security through its 32 bit cyclic redundancy check and its ability to
  98.      resume transfers that were interrupted (e.g., by loss of carrier).
  99.  
  100.      The "zr_mode" variable item in COMMO.SET controls the disposition of
  101.      like-named files when downloading.  Four options are available when
  102.      the incoming filename matches a filename in the Download Directory
  103.      (choose only one):
  104.  
  105.  
  106.  
  107.           [S]kip -- The file will be skipped (not downloaded).
  108.  
  109.           [R]esume -- The file will be resumed (appended to) if the file in
  110.           the Download Directory is smaller than the incoming file. 
  111.           Otherwise, the transfer will be considered complete.
  112.  
  113.           re[N]ame -- The incoming file will be renamed by changing the
  114.           last character of "filename.ext" to a letter from A through Z.
  115.  
  116.           [O]verwrite -- The existing file will be deleted and the incoming
  117.           file will replace it.
  118.  
  119.  
  120.      ----------  External Zmodem
  121.  
  122.      Some users may prefer to use an external Zmodem driver.  This can be
  123.      done easily by entering replacement macros for "z_recv" and "z_send". 
  124.      If you add these at the top of COMMO.MAC, you won't have to change the
  125.      existing macro structure (the new macros will override the old).
  126.  
  127.      Example macros for Omen Technology programs and Texas Zmodem are shown
  128.      in SAMPLES.MAC.
  129.  
  130.  
  131.  
  132.      ==============================
  133.      In the Macro Programming Guide
  134.      ==============================
  135.  
  136.      New or Changed Function Descriptions
  137.      ------------------------------------
  138.  
  139.      ===  RZMOdem  ===
  140.  
  141.      Default key:   none
  142.      Description:   Receive a file using the Zmodem protocol.
  143.  
  144.      Switches:
  145.  
  146.           R1 or R
  147.                Resume like-named files.  If the incoming file is longer,
  148.                the transfer will resume at the end of the existing file.
  149.                No check is made to determine if the common portion of the
  150.                file is identical.
  151.  
  152.           N1 or N
  153.                Rename incoming files if like-named files exists.  A letter
  154.                "A" through "Z" will be used in place of the last character
  155.                of "filename.ext".
  156.  
  157.           Y1 or Y
  158.                Overwrite like-named files.  The existing file will be
  159.                deleted at the start of the transfer.
  160.  
  161.           D1 or D
  162.                Cancel transfer if carrier detect is lost (default).
  163.  
  164.                NOTE:  If carrier detect is off when the transfer is
  165.                started, this switch will behave as if "D0" had been set.
  166.  
  167.           D0
  168.                Ignore state of carrier detect.
  169.  
  170.           A1 or A
  171.                Sound the alarm at the end of the transfer.
  172.  
  173.           A0
  174.                Do not sound the alarm (default).
  175.  
  176.           W
  177.                Wait for a keypress at end of transfer.
  178.  
  179.           Wn
  180.                Wait for "n" seconds, "n" may range from 0 to 999.  Press a
  181.                key to cancel the wait.
  182.  
  183.                Note:  Default (no "W" switch) is no wait.
  184.  
  185.  
  186.  
  187.      The "R", "N" and "Y" switches are mutually exclusive (use only one). 
  188.      If none of the three is present, the file will be "skipped" if a like-
  189.      named file exists in the download directory.
  190.  
  191.      Example:
  192.  
  193.           {rzmo-ra %dldir}
  194.                Receive files into the download directory, resume partial
  195.                files, sound the alarm.
  196.  
  197.      TIPS on using RZMOdem:
  198.  
  199.       *   Some conditions that will cancel a transfer:
  200.             1)  20 consecutive errors.
  201.             2)  The sender has cancelled.
  202.             3)  Unable to open a file.
  203.             4)  Disk is full.
  204.             5)  Loss of carrier.
  205.  
  206.       *   The Exit Code (test with IFER) will be set at the end of the
  207.           transfer and will also be stored in the variable "_err".  0 means
  208.           all files were transferred successfully.  1 means one or more
  209.           files in the batch were not completed.
  210.  
  211.       *   If the Usage Log is enabled, an entry will be made after each
  212.           file is transferred (or if a transfer is cancelled).
  213.  
  214.  
  215.      ===  SETR  ===
  216.  
  217.      Default key:   none
  218.      Description:   Define a label to GOTO when a Macro Error occurs.
  219.  
  220.      Examples:
  221.  
  222.           {setr error}
  223.                GOTO "error" when any Macro Error occurs.
  224.  
  225.           {setr}
  226.                Reset to no label.
  227.  
  228.      SETR allows a macro to get control when a Macro Error occurs.  All
  229.      macro parameters (see STOP) will be reset after the error (including
  230.      the SETR label).
  231.  
  232.      TIPS on using SETR:
  233.  
  234.       *   The built-in variable "_met" will contain an error message
  235.           describing the most recent error.
  236.  
  237.       *   Variable Space will not be changed.
  238.  
  239.  
  240.  
  241.       *   If the specified label does not exist, or if no label is
  242.           currently specified, {COMMO} will STOP and indicate the location
  243.           of the error.
  244.  
  245.  
  246.      ===  SETUp  ===
  247.  
  248.      Default key:   Alt-G
  249.      Description:   Edit Setup File.
  250.  
  251.      Example:
  252.  
  253.           {setup}
  254.                No arguments.
  255.  
  256.  
  257.      ===  SZMOdem  ===
  258.  
  259.      Default key:   none
  260.      Description:   Send a file using the Zmodem Batch protocol.
  261.  
  262.      Switches:
  263.  
  264.           R1 or R
  265.                Tell the receiving program to resume the transfer at the end
  266.                of the existing file.
  267.  
  268.           U1 or U
  269.                Delete files after successful transmission.  Use with
  270.                CAUTION!
  271.  
  272.           D1 or D
  273.                Cancel transfer if carrier detect is lost (default).
  274.  
  275.                NOTE:  If carrier detect is off when the transfer is
  276.                started, this switch will behave as if "D0" had been set.
  277.  
  278.           D0
  279.                Ignore state of carrier detect.
  280.  
  281.           A1 or A
  282.                Sound the alarm at end of transfer.
  283.  
  284.           A0
  285.                Do not sound the alarm (default).
  286.  
  287.  
  288.  
  289.           W
  290.                Wait for a keypress at end of transfer.
  291.  
  292.           Wn
  293.                Wait for "n" seconds, "n" may range from 0 to 999.  Press a
  294.                key to cancel the wait.
  295.  
  296.                Note:  Default (no "W" switch) is no wait.
  297.  
  298.      Examples:
  299.  
  300.           {szmo-a %uldir\*.*}
  301.                Send all files in the upload directory, sound the alarm when
  302.                finished.
  303.  
  304.           {szmo-u ginger.rep}
  305.                Send "ginger.rep" and delete it after a successful transfer.
  306.  
  307.  
  308.      ----------  File Specifications
  309.  
  310.      Any combination of file specifications may be listed in the SZMOdem or
  311.      SYMOdem functions.  These must be separated with commas and may
  312.      include wildcard specifiers (*,?), the indirect file specifier (@) and
  313.      any single files.
  314.  
  315.      If a filespec is preceded with the "@" sign, it will be assumed to be
  316.      an "indirect file."  This means that it is a text file containing a
  317.      list of filespecs.  Filespecs should be listed one per line and each
  318.      line should end with a cr/lf (i.e., a normal text file).  Each
  319.      filespec may contain wildcards.  For example:
  320.  
  321.           c:\subdir\*.*
  322.           info.txt
  323.           a:*.qw?
  324.  
  325.      TIPS on using SZMOdem:
  326.  
  327.       *   Some conditions that will cancel a transfer:
  328.             1)  20 consecutive errors.
  329.             2)  The receiver has cancelled.
  330.             3)  Loss of carrier.
  331.  
  332.       *   The Exit Code (test with IFER) will be set at the end of the
  333.           transfer and will also be stored in the variable "_err".  0 means
  334.           all files were transferred successfully.  1 means one or more
  335.           files in the batch were not completed.
  336.  
  337.       *   If the Usage Log is enabled, an entry will be made after each
  338.           file is transferred (or if a transfer is cancelled).
  339.  
  340.  
  341.  
  342.      =================
  343.      In the Appendices
  344.      =================
  345.  
  346.      Under "Appendix F   Usage Log Format"
  347.      -------------------------------------
  348.  
  349.      Example of a file transfer entry:
  350.  
  351.        {RZ} 0  c:\ul\nlbbs.rep  188988  1608 cps  0 errors 
  352.  
  353.           {RZ}
  354.                File was received with Zmodem.
  355.           0
  356.                0 means the file was transferred (or resumed) successfully.
  357.                1 means the file was not completed.
  358.           c:\ul\nlbbs.rep
  359.                Path\filename of file.
  360.           188988
  361.                Bytes transferred (may not be equal to the size of the file
  362.                if the transfer was incomplete or if the Zmodem resume
  363.                feature was used).
  364.           1608 cps
  365.                Rate at which data was transferred in characters per second. 
  366.                The clock is not started until initial protocol handshaking
  367.                has been completed.  "** cps" indicates transfer time was
  368.                too short or there was an error in the computation.
  369.           0 errors
  370.                Total number of errors (corrected if transfer was
  371.                successful).
  372.  
  373.      NOTE:  You may configure an external protocol program to make log
  374.      entries to your {COMMO} Usage Log file.  The format of these entries
  375.      is explained in the documentation for the protocol program.
  376.  
  377.  
  378.                               - end -
  379.  
  380.