home *** CD-ROM | disk | FTP | other *** search
/ Current Shareware 1994 January / SHAR194.ISO / modem / commo552.zip / MACRO.DOC < prev    next >
Text File  |  1993-10-14  |  139KB  |  4,914 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.     {COMMO} (tm)
  7.  
  8.                    "A New Standard in Telecommunications" 
  9.  
  10.  
  11.         by Fred P. Brucker
  12.  
  13.  
  14.  
  15.  
  16.  
  17.             Part II
  18.               Macro Programming Guide
  19.  
  20.  
  21.             Release 5.52
  22.               October 14, 1993
  23.  
  24.  
  25.  
  26.  
  27.        (C)Copyright 1989-1993  Fred P. Brucker  All Rights Reserved 
  28.  
  29.  
  30. The {COMMO} program and associated on-disk documentation are the property
  31. of the author and may not be sold without permission.  The Shareware
  32. version may be distributed, unaltered and as a unit, via Electronic
  33. Bulletin Board Systems.
  34.  
  35. SHAREWARE DISTRIBUTORS and clubs, please see the file VENDOR.DOC for
  36. distribution guidelines.
  37.  
  38.  
  39. THE AUTHOR DOES NOT GUARANTEE THIS PROGRAM TO BE FREE FROM DEFECTS AND MAY
  40. NOT BE HELD RESPONSIBLE FOR LOSS CAUSED BY SUCH.  YOUR USE OF THIS PROGRAM
  41. CONSTITUTES YOUR ACCEPTANCE OF THESE TERMS.
  42.  
  43.  
  44.  
  45.  
  46. {COMMO} is a trademark of Fred P. Brucker
  47.  
  48. DESQview is a trademark of Quarterdeck Office Systems
  49. OmniView is a trademark of Sunny Hill Software
  50. DoubleDOS is a trademark of SoftLogic Solutions, Inc.
  51. HS/Link is a product of Samuel H. Smith
  52. DSZ and GSZ are products of Omen Technology Inc.
  53. MPt is a product of Matthew Thomas
  54. LIST is a product of Vernon D. Buerg
  55. The IBM PC is a product of IBM Corp.
  56. MS-DOS is a trademark of MicroSoft Corp.
  57.  
  58.  
  59.  
  60.                      ================================
  61.                      {COMMO} Registration Information
  62.                      ================================
  63.  
  64.   {COMMO} is a "SHAREWARE" product.  You are entitled to evaluate it for
  65.   30 days.  If it suits your needs and you would like to continue using
  66.   it, then you must pay the licensing fee.  Please use the REGISTRATION
  67.   FORM on the next page.
  68.  
  69.   When you REGISTER you will be licensed to use all future SHAREWARE
  70.   releases of {COMMO}.  You will never have to pay an "update" charge.
  71.   You will also receive instructions for removing the Shareware Notice
  72.   at program startup.  Registered users will receive priority support
  73.   on Bulletin Boards and CompuServe (see READ.ME).
  74.  
  75.   Call or write for pricing information on MULTI-USER (SITE) and
  76.   DISTRIBUTION licenses.  Discounts are given on quantities of 10 or more.
  77.  
  78.   All prices shown are US DOLLARS.  Please remit US FUNDS on US BANK only.
  79.   NET 30 TERMS will be accepted on purchase orders totalling $100.00 or
  80.   more.
  81.  
  82.   The PRINTED MANUAL has an attractive new size and format for release
  83.   5.5 and includes an index.  The DISKETTE has the latest {COMMO} release
  84.   plus the utilities listed in READ.ME (COMMOPNS, MOSTHOST, CMC, etc.).
  85.  
  86.   For orders, inquiries and support for registered users, call MON-SAT,
  87.   9am-5pm, EASTERN time.  If you get my answering machine, please try
  88.   again later (I cannot return long distance calls).
  89.  
  90.   To register by E-mail on CompuServe, upload the completed Registration
  91.   Form as a message (text or binary).
  92.  
  93.      MAILING ADDRESS:    Fred P. Brucker
  94.                          P.O. Box 141537
  95.                          Columbus, OH 43214
  96.  
  97.      VOICE TELEPHONE:    (614) 326-1309
  98.      COMPUSERVE:         71021,356
  99.      INTERNET:           71021.356@compuserve.com
  100.  
  101.   PAYMENT OPTIONS:
  102.  
  103.   1) CHECK or MONEY ORDER:  make payable to FRED P. BRUCKER.
  104.  
  105.   2) CREDIT CARD:  fill in the credit card information at the bottom of
  106.      the Registration Form (next page).  Credit card orders may be mailed,
  107.      phoned or E-mailed (CompuServe only).
  108.  
  109. --------------------------------------------------------------------------
  110.  
  111.  
  112.  
  113.                {COMMO} 5.52 SINGLE USER REGISTRATION FORM
  114.  
  115.   Name     _______________________________________________________________
  116.  
  117.   Company name (if company address)   ____________________________________
  118.  
  119.   Address  _______________________________________________________________
  120.  
  121.            _______________________________________________________________
  122.  
  123.            _______________________________________________________________
  124.  
  125.              * All prices include shipping and handling *            Number
  126.                                                                     of Copies
  127.   {COMMO} single user license with PRINTED MANUAL and DISKETTE:
  128.          Price in USA/Canada/Mexico ....................... $ 53.00   ____
  129.          OHIO residents (includes sales tax ) .............   56.05   ____
  130.          All other countries ..............................   60.00   ____
  131.  
  132.   {COMMO} single user license, with DISKETTE:
  133.          All countries ....................................   40.00   ____
  134.          OHIO residents (includes sales tax) ..............   42.30   ____
  135.  
  136.   {COMMO} single user LICENSE alone:
  137.          All countries ....................................   35.00   ____
  138.          OHIO residents (includes sales tax ) .............   37.02   ____
  139.  
  140.   BBS sysops, students, seniors, low-income:
  141.          All countries ....................................   25.00   ____
  142.          OHIO residents (includes sales tax ) .............   26.44   ____
  143.          License only; please state category ______________
  144.  
  145.   >>>>>>>  Specify diskette format (if applicable): 5.25" ____ 3.5" ____
  146.  
  147.   Payment method:  Check__  Money order__  Visa__  MasterCard__
  148.                    Carte Blanche__  Diners Club__  JCB__   PO__
  149.  
  150.  
  151.                                       Enter total amount:   $ ____________
  152.  
  153.  
  154.      INFORMATION FOR CREDIT CARD PURCHASES ONLY:
  155.  
  156.      Card No. ________  ________  ________  ________  Expires ____/____
  157.  
  158.      Cardholder signature _____________________________________________
  159.  
  160.      Cardholder name __________________________________________________
  161.  
  162.      Daytime telephone  (_____) _____ _______
  163.  
  164. --------------------------------------------------------------------------
  165.  
  166.  
  167.  
  168.  
  169.   Answers to the following questions will help me serve you better in the
  170.   future:
  171.  
  172.   How did you obtain {COMMO}?  (If BBS, please give name and phone number)
  173.  
  174.   ________________________________________________________________________
  175.  
  176.   In general terms, what do you use {COMMO} for?
  177.  
  178.   ________________________________________________________________________
  179.  
  180.   ________________________________________________________________________
  181.  
  182.   What type of computer and modem do you use?
  183.  
  184.   ________________________________________________________________________
  185.  
  186.   ________________________________________________________________________
  187.  
  188.  
  189.   Comments / Questions ___________________________________________________
  190.  
  191.   ________________________________________________________________________
  192.  
  193.   ________________________________________________________________________
  194.  
  195.   ________________________________________________________________________
  196.  
  197.   ________________________________________________________________________
  198.  
  199.  
  200.   Thank you, and I hope you enjoy {COMMO}.
  201.  
  202.  
  203.  
  204.                                     -6-
  205.  
  206. ========
  207. Contents
  208. ========
  209.  
  210.  
  211. Programming {COMMO} Macros  . . . . . . . . . . . . . . . . . . . . . .   9
  212.      Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . .   9
  213.      Macro Structure  . . . . . . . . . . . . . . . . . . . . . . . . .   9
  214.      Macro Functions  . . . . . . . . . . . . . . . . . . . . . . . . .  10
  215.      Macro Labels . . . . . . . . . . . . . . . . . . . . . . . . . . .  12
  216.      Macro Variables  . . . . . . . . . . . . . . . . . . . . . . . . .  13
  217.      How to Use Variables . . . . . . . . . . . . . . . . . . . . . . .  14
  218.      Reserved Variables . . . . . . . . . . . . . . . . . . . . . . . .  15
  219.      Executing Macros . . . . . . . . . . . . . . . . . . . . . . . . .  16
  220.      Additional Macro Execution Rules . . . . . . . . . . . . . . . . .  16
  221.      Cancelling a Macro . . . . . . . . . . . . . . . . . . . . . . . .  17
  222.      A Macro Example in Detail  . . . . . . . . . . . . . . . . . . . .  17
  223.  
  224. Description of Functions (Alphabetical) . . . . . . . . . . . . . . . .  20
  225.      ABAUd  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  20
  226.      ALARm  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  20
  227.      ASCIiup  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  21
  228.      AUTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  22
  229.      BEEP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  23
  230.      BREAk  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  23
  231.      CALL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  23
  232.      CALOok . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  24
  233.      CAPMode  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  24
  234.      CAPTure  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  25
  235.      CHATmode . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  26
  236.      CLEAr  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  26
  237.      COMPare  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  26
  238.      CURSor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  27
  239.      DECRement  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  28
  240.      DIAL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  28
  241.           Marking Numbers for Dialing . . . . . . . . . . . . . . . . .  29
  242.           Automatic Resumption of Dialing . . . . . . . . . . . . . . .  30
  243.           Testing Success and Failure Results . . . . . . . . . . . . .  30
  244.           Handling Incoming Calls . . . . . . . . . . . . . . . . . . .  31
  245.      DISPlay  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  31
  246.      DIVIde . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  32
  247.      DOORway  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  33
  248.      DPARms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  33
  249.      EDIT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  34
  250.      ELAPse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  35
  251.      EXECute  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  35
  252.           Using the Direct Switch: EXEC-D . . . . . . . . . . . . . . .  37
  253.           Using the Swap to Disk Switch: EXEC-S . . . . . . . . . . . .  37
  254.           EXECute Preview Mode  . . . . . . . . . . . . . . . . . . . .  38
  255.      EXIT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  38
  256.      FILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  39
  257.      GETString  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  40
  258.      GOLOok . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  42
  259.  
  260.  
  261.  
  262.                                     -7-
  263.  
  264.      GOTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  43
  265.      HANGup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  43
  266.      HELP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  43
  267.      HOLD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  43
  268.      IFCArrier  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  44
  269.      IFCOndition  . . . . . . . . . . . . . . . . . . . . . . . . . . .  45
  270.      IFERrorlevel . . . . . . . . . . . . . . . . . . . . . . . . . . .  46
  271.      IFEXist  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  47
  272.      INCRement  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  48
  273.      INFOrm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  49
  274.      INITmodem  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  50
  275.      INPUt  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  50
  276.      INSTring . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  51
  277.      KEYStuff . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  51
  278.      LENGth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  52
  279.      LIGHts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  52
  280.      LOCAlecho  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  53
  281.      LOOKfor  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  53
  282.      MACLoad  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  55
  283.      MACRo  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  56
  284.      MARK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  57
  285.      MENU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  58
  286.      MULTiply . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  60
  287.      NOCArrier  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  61
  288.      NOOP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  61
  289.      OFFLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  61
  290.      PARMs  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  62
  291.      PASSword . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  62
  292.      PAUSe  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  63
  293.      POPStack . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  63
  294.      PRINtlog . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  64
  295.      PUSHstack  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  64
  296.      RCLOse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  65
  297.      READ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  65
  298.      RETUrn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  66
  299.      ROPEn  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  66
  300.      RTRAn  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  67
  301.      RXMOdem  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  68
  302.      RYMOdem  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  69
  303.      SCREen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  71
  304.      SCROllback . . . . . . . . . . . . . . . . . . . . . . . . . . . .  71
  305.      SEND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  71
  306.      SETDial  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  72
  307.      SETEsc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  72
  308.      SETGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  73
  309.      SETLook  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  75
  310.      SETVariable  . . . . . . . . . . . . . . . . . . . . . . . . . . .  76
  311.      SHELl  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  78
  312.      SIGNal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  78
  313.      SOUNd  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  79
  314.      SPDCtrl  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  79
  315.      SPOCtrl  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  80
  316.      SSLOok . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  80
  317.  
  318.  
  319.  
  320.                                     -8-
  321.  
  322.      STATusline . . . . . . . . . . . . . . . . . . . . . . . . . . . .  81
  323.      STOP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  82
  324.      STRAn  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  82
  325.      SUBString  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  83
  326.      SXMOdem  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  84
  327.      SYMOdem  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  84
  328.      TOGGles  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  86
  329.      UNMArk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  86
  330.      VIDEo  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  87
  331.      VTCUr  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  87
  332.      VTPAd  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  88
  333.      WCLOse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  88
  334.      WINDow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  89
  335.      WOPEn  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  89
  336.      WRITe  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  90
  337.  
  338. For APPENDICES see Part I, COMMO.DOC. . . . . . . . . . . . . . . . . .  91
  339.  
  340.  
  341.  
  342.                                     -9-
  343.  
  344. ==========  Programming {COMMO} Macros
  345.  
  346.  
  347. IMPORTANT!  Please read the next few pages before you attempt to write any
  348. macros!  The rules for writing {COMMO} macros are few in number, but must
  349. be followed carefully.
  350.  
  351. Examples of more complex macro programming are given in the sample Macro
  352. File COMMO.MAC, in the supplied file SAMPLES.MAC and in the Host Mode and
  353. Guide macros.  A macro from SAMPLES.MAC is discussed in detail at the end
  354. of this section.
  355.  
  356. The following pages assume familiarity with {COMMO}'s key commands and with
  357. other features of the program.  Since many macro functions have
  358. corresponding key commands, duplicate explanations will not be given here. 
  359. Refer to the description of the key command in Part I.
  360.  
  361.  
  362. -----=====  Overview
  363.  
  364.  
  365. {COMMO}'s Macro File may contain any number of macros.  The only size
  366. limitation on the file is that the Dialing Directory and Macro File
  367. combined must total 64k bytes or less.
  368.  
  369. Macros are "interpreted," which implies the following:
  370.  
  371.      (1)  Macros are not processed until they are executed.
  372.  
  373.      (2)  Only macros within the currently loaded Macro File are available
  374.           for use.
  375.  
  376.      (3)  Macros added or modified with the Internal Editor are available
  377.           immediately.
  378.  
  379. Alternate Macro Files may be loaded using the MACLoad function (the
  380. original file is replaced and may be reloaded at a later time).
  381.  
  382.  
  383. -----=====  Macro Structure
  384.  
  385.  
  386. Macros consist of a series of items enclosed in curly braces.  Items may be
  387. placed on the same line or on as many lines as desired.  The file is
  388. entirely free-form.  Lines may be up to 255 characters in length and all
  389. text outside the curly braces is commentary and is ignored by the Macro
  390. Processor.
  391.  
  392. There are two types of items: "functions" and "labels."
  393.  
  394.      Functions are action items.  Some are equivalent to {COMMO} key
  395.      commands, such as DIAL, while others are unique to the macro language,
  396.      such as SETVariable.
  397.  
  398.  
  399.  
  400.                                     -10-
  401.  
  402.  
  403.      Labels are macro entry points and may be placed anywhere within the
  404.      Macro File.
  405.  
  406.  
  407. -----=====  Macro Functions
  408.  
  409.  
  410. Each macro function is described in detail later in this document.  See
  411. also Appendix J "Macro Functions Listed by Class."
  412.  
  413.  
  414. The general form of any macro function is:
  415.  
  416.      {name-switches arg1,arg2,...,argn}
  417.  
  418.           name
  419.                The function name describes the action to be performed and
  420.                consists of four or more characters. Only the first four are
  421.                significant and case is ignored.
  422.  
  423.           switches
  424.                These are used to alter the operation of a function.  Each
  425.                switch is a single letter and may be followed by a numeric
  426.                value, usually "1" or "0" to indicate "yes" or "no"
  427.                respectively.
  428.  
  429.                Switches have default interpretations when the numeric value
  430.                is omitted, or when the switch is not present.
  431.  
  432.                Switches must be separated from the name with a hyphen (no
  433.                intervening spaces).  They may be upper or lower case.
  434.  
  435.                See individual function descriptions for details (note that
  436.                only certain functions have switches).
  437.  
  438.           args
  439.                A SINGLE SPACE separates the arguments from the function
  440.                name and switches.
  441.  
  442.                Individual arguments are separated with commas and may
  443.                contain no extraneous spaces (all spaces are significant).
  444.  
  445. NOTE:  Curly braces may be represented within macro functions by using ^(
  446. for { and ^) for }.
  447.  
  448.  
  449.  
  450.                                     -11-
  451.  
  452. Examples:
  453.  
  454.      {send Hi, how are you?}
  455.  
  456.           This function sends the string "Hi, how are you?" to the modem. 
  457.           SEND has only one argument -- the string to send out.  Since the
  458.           string is the last argument, it may contain commas and spaces. 
  459.           Quotes are not used to define strings.
  460.  
  461.      {ifcon-LE label1,label2}
  462.  
  463.           The IFCOndition function tests for conditions set by other
  464.           functions, such as COMPare.  Here two switches are present,
  465.           telling {COMMO} to test for less than or equal:
  466.  
  467.                L    Test for "less than."
  468.                E    Test for "equal."
  469.  
  470.           The two arguments are labels to GOTO depending on the conditions.
  471.  
  472.           Notice that "name-switches" may be written in a number of
  473.           different ways:
  474.  
  475.                ifco-LE  ifcondition-EL  ifcond-LE
  476.  
  477.      {asci-S0E1 pathname}
  478.  
  479.           The ASCII Upload function will send the file indicated by
  480.           "pathname."  The switches override current settings and tell
  481.           {COMMO}:
  482.  
  483.                S0   Do NOT strip linefeeds.
  484.                E1   DO expand blank lines (may also be written "E").
  485.  
  486.      {sound}   {sound yes}
  487.  
  488.           The first function will TOGGLE Master Sound ON/OFF (since there
  489.           is no argument).  The second will turn the sound ON.
  490.  
  491.  
  492. One very important function is the STOP function.  It is used to terminate
  493. macro processing and may appear in either its long form or short form:
  494.  
  495.      ... {stop}     long form
  496.      ... {}         short form
  497.  
  498. Macro processing continues until a STOP function is executed.  Be sure to
  499. use one or processing will continue into the next macro in the Macro File!
  500.  
  501.  
  502.  
  503.                                     -12-
  504.  
  505. -----=====  Macro Labels
  506.  
  507.  
  508. Labels are identifiers consisting of one or more characters.  When a label
  509. is defined, it must be preceded by a colon.  References to labels, such as
  510. {goto label}, do not require the colon.
  511.  
  512. IMPORTANT!  {COMMO} always searches for labels from the beginning of the
  513. Macro File.  This means that if a label is duplicated within the file, the
  514. first occurrence will be used.
  515.  
  516. Only the first eight characters in a label are significant.  Case is
  517. ignored.  All characters are allowed in labels except the following:
  518.  
  519.      colon           ":"
  520.      space           " "
  521.      comma           ","
  522.      slash           "/"
  523.      curly braces    "{" or "}"
  524.  
  525. Examples:
  526.  
  527.      {:mailrun} {call login} ...
  528.  
  529.      {:start-here} {:another.entry} {send Begin now!} ...
  530.  
  531.  
  532. A number of three character labels are reserved and are called "key-
  533. labels."  When the corresponding key is pressed from the Terminal Screen,
  534. {COMMO} will look for the key-label in the current Macro File.  If the key-
  535. label is found, macro processing will begin at that location.
  536.  
  537. Any default key assignment may be overridden using a key-label.  For
  538. example, pressing Alt-D normally enters the Dialing Directory.  But suppose
  539. this line is in the Macro File:
  540.  
  541.      {:ald} {clear} {}
  542.  
  543. Now pressing Alt-D will clear the screen.
  544.  
  545. See Appendix H "Table of {COMMO} Key-labels" for a complete list of keys
  546. that may be assigned.
  547.  
  548.  
  549.  
  550.                                     -13-
  551.  
  552. -----=====  Macro Variables
  553.  
  554.  
  555. {COMMO} maintains a String Variable Space in which variables appear in the
  556. form:
  557.  
  558.      name,string
  559.  
  560.           name
  561.                An identifier consisting of one or more characters of which
  562.                only the first eight are significant.  Case is ignored.  The
  563.                following are the ONLY valid characters that may be used in
  564.                a variable name:
  565.  
  566.                     "A" through "Z"
  567.                     "a" through "z"
  568.                     "0" through "9"
  569.                     "_" underline.
  570.  
  571.                All other characters will terminate the name.
  572.  
  573.           string
  574.                A text string.  The string must not contain any control
  575.                characters below ASCII 28.  If a string is set to null (0
  576.                characters), it is deleted from variable space.
  577.  
  578.                NOTE:  Any variable not defined is considered to be null.
  579.  
  580.                Strings consisting of only the digits 0-9 and representing a
  581.                decimal number from 0 to 4,294,967,295 (2^32-1) are also
  582.                numeric variables.  There is no other difference between
  583.                string and numeric variables.
  584.  
  585.                The maximum length of strings is 240 characters.
  586.  
  587. The String Variable Space may be viewed from within the Macro Processor
  588. window by pressing "V".  The amount of unused string space is shown at the
  589. bottom of the screen.
  590.  
  591. Once a variable is defined, it remains in String Variable Space until it is
  592. redefined or deleted (set to null).  Therefore variables should be deleted
  593. or re-used to prevent String Variable Space from becoming full.
  594.  
  595. The default size of String Variable Space is 3072 bytes, but it may be
  596. adjusted with the "/v" command line switch at program startup.  The valid
  597. range is from 512 bytes to 65535 bytes.  See also "Command Line Options" in
  598. Part I.
  599.  
  600.  
  601.  
  602.                                     -14-
  603.  
  604. ----------  How to Use Variables
  605.  
  606.  
  607. {COMMO} variables are set (or "defined") by various macro functions and by
  608. variable strings in a Dialing Directory entry.
  609.  
  610. Variables are used (or "referenced") in macro function arguments and in the
  611. telephone number field of the Dialing Directory.  
  612.  
  613. See also "Alt-D  Dialing Directory" in Part I.
  614.  
  615. When a variable name appears, the string assigned to the name is
  616. substituted for the name.  If the variable is null, then the name is
  617. replaced with 0 characters.  {COMMO} will expand the variables in a macro
  618. function before processing it.
  619.  
  620. In order to distinguish variable names, they must be preceded with a
  621. percent sign "%" (use two percent signs if a percent sign is needed in the
  622. data).
  623.  
  624. The end of the variable name is indicated with another "%" or with the
  625. first character that is not allowed in a name (see list of characters
  626. above).
  627.  
  628.  
  629. A variable definition example:
  630.  
  631.      {setvar animal,Elephant} or {setvar %animal,Elephant}
  632.  
  633.           Notice that the "%" is not required (but is permitted) when the
  634.           variable name is the first argument of a function that defines,
  635.           modifies or tests the value of a variable.  Other such functions
  636.           include INPUt, GETString, INCRement, DECRement, COMPare,
  637.           SUBString, INSTring, READ.
  638.  
  639.           If the variable name in this situation needs to be a variable,
  640.           then use two percent signs:
  641.  
  642.                {setv %%animal,Elephant}
  643.  
  644.  
  645. Variable usage examples:
  646.  
  647.      {setvar animal,Elephant}
  648.      {send %animal}
  649.           Sends "Elephant" to the modem.
  650.      {send animal}
  651.           Sends "animal".
  652.      {send %animal%s are large animals}
  653.           Sends "Elephants are large animals".  Note that the trailing "%"
  654.           is required here.
  655.  
  656.      {setvar animal,Elephant}
  657.  
  658.  
  659.  
  660.                                     -15-
  661.  
  662.      {setv creature,animal}
  663.      {send creature}
  664.           Sends "creature".
  665.      {send %creature}
  666.           Sends "animal".
  667.      {setv %%creature,Giraffe}
  668.      {send %animal}
  669.           Sends "Giraffe".
  670.  
  671.  
  672. IMPORTANT!  Variables may NOT be substituted within the function name or
  673. switches.  They may be substituted anywhere else, even for the commas
  674. separating arguments.
  675.  
  676.  
  677. ----------  Reserved Variables
  678.  
  679.  
  680. Certain variables have fixed names so that {COMMO} can find them whenever
  681. they are needed.  The names of these variables begin with an underline
  682. character "_".  There are two types of reserved variables: "user-defined"
  683. and "built-in" (see Appendix I "List of Reserved Variables" for a complete
  684. list).
  685.  
  686. USER-DEFINED reserved variables are defined in the same way that you define
  687. ordinary variables -- in the Setup File using SET, or in a macro using
  688. functions such as SETVariable, INPUt, etc.  These variables define strings
  689. used by certain program features.  For example, the pathname of the Usage
  690. Log is defined in the Setup File as follows:
  691.  
  692.      {set _uselog,c:\commo\commo.log}
  693.  
  694. BUILT-IN variables are defined by {COMMO} based on current system 
  695. parameters.  Examples are:
  696.  
  697.      _cap
  698.           Current Capture File pathname
  699.  
  700.      _tim
  701.           Current time of day
  702.  
  703. Any variable that starts with the same four characters as a built-in
  704. variable ("_" plus the next three) will be considered the same variable. 
  705. For example "_pas" may be written "_password" and "_yea" may be written
  706. "_year".
  707.  
  708. {COMMO} will always search String Variable Space first when looking up the
  709. value of any variable.  This allows built-in variables to be overridden,
  710. but only when using their four character minimum names.  For example, to
  711. override the serial port number, you must use "_por", not "_port".
  712.  
  713. See Appendix I for a complete list of reserved variables.
  714.  
  715.  
  716.  
  717.                                     -16-
  718.  
  719.  
  720. -----=====  Executing Macros
  721.  
  722.  
  723. Macro execution may be started in any of the following ways:
  724.  
  725. 1)   Open the Macro Processor window by pressing Alt-M.  Position the
  726.      Selector Bar at the desired starting point and press [Enter].  The
  727.      Macro Processor will begin processing at the first macro label or
  728.      function on the line.
  729.  
  730.      NOTE:  Macros started with the Selector Bar do not need macro labels
  731.      and may be started at any point within the macro.
  732.  
  733. 2)   If a macro label is also a key-label, then you may press that key from
  734.      the Terminal Screen.  Note that if the same key-label appears more
  735.      than once, the first occurrence will be used.
  736.  
  737. 3)   A macro may be linked to a Dialing Directory entry (Linked Macro).  In
  738.      this case {COMMO} will GOTO the macro when a connection is established
  739.      with that system (or optionally CALL it, see the DIAL function).
  740.  
  741. 4)   A startup macro may be specified in the Setup File using the
  742.      "{mac=label}" item.
  743.  
  744. 5)   A startup macro may be specified on the command line with the switch
  745.      "/:label".  This will override the Setup File macro.
  746.  
  747. 6)   A macro may be an argument of another function such as CALL, GOTO,
  748.      DIAL or SETLook.
  749.  
  750. Some macro functions show their current action on the Status Line at the
  751. bottom of the screen.  In addition, a "face" character in the middle of the
  752. Status Line indicates that a macro is executing.
  753.  
  754.  
  755. -----=====  Additional Macro Execution Rules
  756.  
  757.  
  758. Characters may be typed to the serial port during functions that wait
  759. (LOOKfor, GETString, PAUSe, HOLD, etc.).  Command keys will be ignored
  760. during macro processing.
  761.  
  762. The Macro Processor will execute functions IN SEQUENCE until one of the
  763. following conditions occurs:
  764.  
  765. 1)   A CALL, GOTO, RETURn, STOP, EXIT, etc. is encountered.
  766.  
  767. 2)   Control is transferred to an alternate macro from certain functions
  768.      when a special condition occurs.  An example of this is the SETLook
  769.      function.  The alternate will execute when a subsequent LOOKfor times
  770.      out.
  771.  
  772.  
  773.  
  774.                                     -17-
  775.  
  776. 3)   A macro error occurs.  This will bring up the Macro Processor window
  777.      with the Selector Bar on the problem line.  The macro will be
  778.      terminated.
  779.  
  780. 4)   The end of the Macro File is reached.
  781.  
  782.  
  783. -----=====  Cancelling a Macro
  784.  
  785.  
  786. The [Esc] key is used to terminate macro processing.  To type an <esc> code
  787. (ASCII 27) to the remote during macro execution (without terminating the
  788. macro), press Ctrl-[ (Ctrl + left bracket).
  789.  
  790. Current function execution may be terminated by pressing [Ctrl-Break].  For
  791. example, this can be used to terminate a LOOKfor, PAUSe or HOLD
  792. prematurely.  Macro processing will advance to the next function.
  793.  
  794. If a macro contains a function that brings up a {COMMO} window (Dialing
  795. Directory, Capture File Options, etc.), then [Esc] will exit the window and
  796. processing continues with the next function.  To terminate macro processing
  797. from a window, press [Ctrl-Break].
  798.  
  799. NOTE:  The SETEsc function may be used to help prevent accidental
  800. termination of macros.
  801.  
  802.  
  803. -----=====  A Macro Example in Detail
  804.  
  805.  
  806. The following macro example from SAMPLES.MAC can be used to log in to many
  807. types of Bulletin Board Systems.  This is a Linked Macro, so the label
  808. "login" would appear in the Dialing Directory macro field for each system
  809. that uses it.  When you dial and connect to one of the systems, {COMMO}
  810. will automatically GOTO the macro.
  811.  
  812. The subroutine "gls" (generic login subroutine) can also be called from
  813. macros that perform mailruns and other BBS operations.
  814.  
  815. Note that labels and functions may be placed side by side on the same line
  816. (up to 255 characters).  For purposes of this example each item is placed
  817. on its own line.
  818.  
  819. The main routine at "login" performs some initial functions and then calls
  820. the subroutine at "gls".  The subroutine looks for various prompts,
  821. responds to them and terminates after responding to the "password" prompt.
  822.  
  823.  
  824. {:login}
  825.      The entry point.  All labels begin with a ":".
  826.  
  827. {capture y,c:\commo\commo.cap}
  828.  
  829.  
  830.  
  831.                                     -18-
  832.  
  833.      "y" means open the Capture File.  The pathname of the file is
  834.      specified here, otherwise the current file would be opened.
  835.  
  836. {asci ,}
  837.      Set ASCII Upload to "no pacing."
  838.  
  839. {call gls}
  840.      CALL the macro at "gls".  When the subroutine executes a RETUrn,
  841.      control will come back here.
  842.  
  843. {}
  844.      STOP and resume manual operation in the Terminal Screen.  Without this
  845.      STOP processing would continue into subsequent macros.  Remember that
  846.      labels are "passed over" during sequential macro processing.
  847.  
  848. {:gls}
  849.      The entry point of the "gls" subroutine.
  850.  
  851. {setlook 60,hng,10,|}
  852.      This function specifies parameters that go into effect whenever a
  853.      LOOKfor executes.  It tells the Macro Processor to wait up to 60
  854.      seconds for the string (or strings) and to GOTO the label "hng" if
  855.      none of the strings appear within that time.  The timer is restarted
  856.      each time a LOOKfor begins to execute.
  857.  
  858.      The SETLook also specifies that a "|" (carriage return) should be sent
  859.      to the modem whenever 10 seconds have elapsed and no characters are
  860.      received.  This is used to respond to prompts that are not explicitly
  861.      specified in SSLOoks/CALOoks/GOLOoks/LOOKfors (e.g., "Press any key to
  862.      continue").
  863.  
  864.      Use this latter facility with care since a BBS may spend time
  865.      processing and not actually be expecting input from the caller.  The
  866.      carriage returns sent will accumulate and be used to satisfy later
  867.      prompts, causing things to get out of "sync."  Adjust the 10 second
  868.      timeout as needed.
  869.  
  870. {setv ss_r,~|}
  871. {setv ss_yr,~y|}
  872.      Variables are set for some common responses.  They will be used later
  873.      by SSLOok functions.  For convenience, these variables may be defined
  874.      in the Setup File (using the "set" keyword).
  875.  
  876.      SSLOoks, CALOoks and GOLOoks store strings to look for, but do not
  877.      wait for the strings (only a LOOKfor can do the actual waiting).
  878.  
  879. {:li1}
  880. {sslo ss_r,(enter)}
  881. {sslo ss_yr,graphics (enter)}
  882. {sslo ss_yr,is this correct} 
  883.      The SSLOoks will send the strings in the variables when the respective
  884.      targets are received.  The looking for all of the stored strings then
  885.      resumes.
  886.  
  887.  
  888.  
  889.                                     -19-
  890.  
  891.  
  892. {calo li1,li2,first name}
  893. {calo li1,li3,last name}
  894.      CALOoks will CALL the second label if the target string appears (the
  895.      LOOKfor is cancelled).  When the macro executes a RETUrn, control goes
  896.      to the first label where all of the strings can be set up again.  Note
  897.      that CALOoks are used here for demonstration.  SSLOoks could be used
  898.      as well (and probably should be).
  899.  
  900. {golo li1,;passwor}
  901.      A GOLOok will set up a string and GOTO the label if the string appears
  902.      (only one label is used).  In this example the specified string is to
  903.      be ignored.  This was needed for a BBS that used the string
  904.      "first;last;password" prior to the actual password prompt.
  905.  
  906. {lookfor password}
  907.      This is where the actual "looking" takes place.  Remember that
  908.      SSLOoks, CALOoks and GOLOoks only cause strings to be stored but do
  909.      not actually wait for the strings.
  910.  
  911.      The LOOKfor will wait for the string specified and also any other
  912.      stored strings (up to 16 total).  If the string in the LOOKfor
  913.      appears, control passes to the next macro function.
  914.  
  915.      "password" is assumed to be the last prompt in the login sequence.
  916.  
  917. {send ~%_pas|}
  918.      Control then passes here and the string is sent to the modem.  The
  919.      tilde (~) causes a half-second delay before sending the password.  The
  920.      password in the Dialing Directory entry was stored into the built-in
  921.      variable "_pas" when dialing began.
  922.  
  923.      Finally, a carriage return (|) is sent.
  924.  
  925. {return}
  926.      This will RETUrn to the "login" macro.
  927.  
  928. {:li2}
  929. {send ~Fred|}
  930.      Response to "first name".
  931.  
  932. {return}
  933.  
  934. {:li3}
  935. {send ~Brucker|}
  936.      Response to "last name".
  937.  
  938. {return}
  939.  
  940.  
  941.  
  942.                                     -20-
  943.  
  944. ==========  Description of Functions (Alphabetical)
  945.  
  946.  
  947. The purpose of this section is to show the syntax of each function and the
  948. meaning of its arguments through examples.  All functions are listed here,
  949. but details for functions which are also default key commands are found in
  950. Part I under "{COMMO} Key Commands."
  951.  
  952. Function names are shown with their four-letter abbreviations in uppercase.
  953.  
  954. For consistency, the following conventions are used in many functions:
  955.  
  956.      "y" or "yes" is used to indicate "yes", "on",  "open",  etc.
  957.      "n" or "no"  is used to indicate "no",  "off", "close", etc.
  958.  
  959.  
  960. ===  ABAUd  ===
  961.  
  962.  
  963. Default key:   none
  964. Description:   Set AutoBaud toggle.
  965.  
  966. Examples:
  967.  
  968.      {abaud}
  969.           Toggle AutoBaud on/off
  970.  
  971.      {abaud y}
  972.           Turn on AutoBaud
  973.  
  974.      {abaud n}
  975.           Turn off AutoBaud
  976.  
  977.  
  978. ===  ALARm  ===
  979.  
  980.  
  981. Default key:   none
  982. Description:   Ring the alarm.
  983.  
  984. Examples:
  985.  
  986.      {alarm}
  987.           Ring alarm, use ring count in Setup File.
  988.  
  989.      {alarm 2}
  990.           Ring alarm 2 times.
  991.  
  992. {COMMO} will wait until the alarm has stopped ringing before proceeding to
  993. the next macro function (the alarm may be terminated early by pressing a
  994. key).
  995.  
  996.  
  997.  
  998.                                     -21-
  999.  
  1000. ===  ASCIiup  ===
  1001.  
  1002.  
  1003. Default key:   Alt-A
  1004. Description:   Upload an ASCII (text) file.
  1005.  
  1006. General form:
  1007.  
  1008.      {ASCIiup pathname[\],pace}
  1009.  
  1010.           pathname
  1011.                The complete path and filename (if the path is absent, the
  1012.                current directory will be used).
  1013.  
  1014.                If a path only is used (signified by a "\" at the end) the
  1015.                ASCII Upload window will open, prompting you to enter the
  1016.                filename.
  1017.  
  1018.           pace
  1019.                The pacing character to be used.
  1020.  
  1021. Switches:
  1022.  
  1023.      E1 or E
  1024.           Expand blank lines.  A space will be sent when a zero-character
  1025.           line is encountered.
  1026.  
  1027.      E0
  1028.           Do not expand blank lines.
  1029.  
  1030.      S1 or S
  1031.           Strip linefeeds from outgoing text.
  1032.  
  1033.      S0
  1034.           Do not strip linefeeds.
  1035.  
  1036.           If a switch is absent, the current setting of the toggle will be
  1037.           used.  The toggles can be set in the Setup File or by using the
  1038.           Alt-T key command.
  1039.  
  1040.           Switches apply to the current function only and do not affect the
  1041.           settings of the toggles.
  1042.  
  1043. Examples:    
  1044.  
  1045.      {asci}
  1046.           Open ASCII Upload window.
  1047.  
  1048.  
  1049.  
  1050.                                     -22-
  1051.  
  1052.      {asci-S}
  1053.           Open ASCII Upload window, strip linefeeds when file is sent.
  1054.  
  1055.      {asci %uldir%\}
  1056.           Open ASCII Upload window, prompt with the current value of the
  1057.           variable "uldir".
  1058.  
  1059.      {asci c:\msgs\file.xyz,:}
  1060.           Upload "file.xyz."  Use ":" for pacing.
  1061.  
  1062.      {asci-E0 c:\msgs\file.xyz}
  1063.           Upload "file.xyz."  Use current pacing character, do not expand
  1064.           blank lines.
  1065.  
  1066.      {asci c:\msgs\file.xyz,}
  1067.           Upload "file.xyz."  Do not use pacing.
  1068.  
  1069.      {asci ,?}
  1070.           Set current pacing character to "?"
  1071.  
  1072.      {asci ,}
  1073.           Set current pacing to "no" pacing.
  1074.  
  1075. The pacing character may be entered according to the rules shown in
  1076. Appendix D.  For example, "^m" or "|" may be used to represent the carriage
  1077. return.
  1078.  
  1079.  
  1080. ===  AUTO  ===
  1081.  
  1082.  
  1083. Default key:   none
  1084. Description:   Maintain Auto Receive strings.
  1085.  
  1086. General form:
  1087.  
  1088.      {AUTO label,string}
  1089.  
  1090.           label
  1091.                Label to GOTO when the string is received.
  1092.  
  1093.           string
  1094.                String to look for, may be up to 32 characters.
  1095.  
  1096. Examples:
  1097.  
  1098.      {auto}
  1099.           Clear all Auto Receive strings.
  1100.  
  1101.      {auto zmodem,^XB00}
  1102.           Zmodem Auto Receive string.
  1103.  
  1104.  
  1105.  
  1106.                                     -23-
  1107.  
  1108. Note that up to 16 Auto Receive strings may be in effect at the same time
  1109. (including any strings defined in the Setup File).
  1110.  
  1111. Use this function with no arguments to clear all strings when necessary.
  1112.  
  1113. See also "TIPS on creating LOOKfor strings" under LOOKfor.
  1114.  
  1115.  
  1116. ===  BEEP  ===
  1117.  
  1118.  
  1119. Default key:   none
  1120. Description:   Sound a beep.
  1121.  
  1122. Example:
  1123.  
  1124.      {beep}
  1125.           No arguments.
  1126.  
  1127.  
  1128. ===  BREAk  ===
  1129.  
  1130.  
  1131. Default key:   Alt-B
  1132. Description:   Send a break.
  1133.  
  1134. Switches:
  1135.  
  1136.           Tn
  1137.                Set break duration in system clock ticks.  "n" may range
  1138.                from 1 to 999.  There are 18.2 clock ticks per second.
  1139.  
  1140.           T0 or T
  1141.                Set break duration to 18 clock ticks (default).
  1142.  
  1143. Examples:
  1144.  
  1145.      {break}
  1146.           One second break.
  1147.  
  1148.      {break-t9}
  1149.           One-half second break.
  1150.  
  1151.      {break-t55}
  1152.           Three second break.
  1153.  
  1154.  
  1155. ===  CALL  ===
  1156.  
  1157.  
  1158. Default key:   none
  1159. Description:   Execute a macro subroutine.
  1160.  
  1161.  
  1162.  
  1163.                                     -24-
  1164.  
  1165. Example:
  1166.  
  1167.      {call abc}
  1168.           Execute subroutine abc.
  1169.  
  1170. CALL will push the location following the CALL function onto the macro
  1171. stack, then it will GOTO the label given in the argument.  When a RETUrn is
  1172. executed, the location will be popped and control will return to the
  1173. function following the CALL.
  1174.  
  1175. Note that macros may be nested up to 32 deep.
  1176.  
  1177. See also RETUrn, PUSHstack, POPStack.
  1178.  
  1179.  
  1180. ===  CALOok  ===
  1181.  
  1182.  
  1183. Default key:   none
  1184. Description:   CALL a label when a string appears.
  1185.  
  1186. General form:
  1187.  
  1188.      {CALOok label1,label2,target}
  1189.  
  1190.           label1
  1191.                The location to return to after label2 is CALLed.
  1192.  
  1193.           label2
  1194.                The label to CALL when the target is received from the
  1195.                serial port.
  1196.  
  1197.           target
  1198.                The ASCII string to look for.  The string begins following
  1199.                the "," and is terminated by the "}".
  1200.  
  1201. CALOok is used in conjunction with the LOOKfor function.  It sets up an
  1202. additional string to look for.  When the target string appears, a CALL is
  1203. made to "label2."  When the routine executes a RETUrn, control will pass to
  1204. "label1".  This is equivalent to:
  1205.  
  1206.      {call label2} {:label1} ...
  1207.  
  1208. See LOOKfor for details, examples and tips on using CALOok.
  1209.  
  1210. See also: SSLOok, GOLOok, SETLook.
  1211.  
  1212.  
  1213. ===  CAPMode  ===
  1214.  
  1215.  
  1216. Default key:   none
  1217. Description:   Set Capture Mode.
  1218.  
  1219.  
  1220.  
  1221.                                     -25-
  1222.  
  1223.  
  1224. Examples:
  1225.  
  1226.      {capmode screen}
  1227.           Set Capture Mode to SCREEN.
  1228.  
  1229.      {capmode filter}
  1230.           Set Capture Mode to FILTER.
  1231.  
  1232.      {capmode raw}
  1233.           Set Capture Mode to RAW.
  1234.  
  1235. See also CAPTure.
  1236.  
  1237.  
  1238. ===  CAPTure  ===
  1239.  
  1240.  
  1241. Default key:   Alt-1
  1242. Description:   Capture File Options.
  1243.  
  1244. Switches:
  1245.  
  1246.      N1 or N
  1247.           Do not wait for a keypress if the disk fills up while capturing
  1248.           (a message is displayed for several seconds).  The setting
  1249.           remains in effect until the Capture File is closed.
  1250.  
  1251.           NOTE:  This switch is effective only on a CAPTure function that
  1252.           successfully opens a Capture File.
  1253.  
  1254.      N0
  1255.           Wait for Esc to be pressed if the disk fills up (default).
  1256.  
  1257. Examples:
  1258.  
  1259.      {capture}
  1260.           Open Capture File Options window.
  1261.  
  1262.      {capture y}
  1263.           Open current Capture File.
  1264.  
  1265.      {capture n}
  1266.           Close current Capture File.
  1267.  
  1268.      {capt y,c:\commo\file.xyz}
  1269.           Open indicated Capture File.
  1270.  
  1271.      {capt n,c:\dl\newfile.cap}
  1272.           Close current Capture File, set new file as indicated.
  1273.  
  1274. The current Capture File will always be closed when a new file is opened.
  1275.  
  1276.  
  1277.  
  1278.                                     -26-
  1279.  
  1280. IMPORTANT!  If the disk fills while capture is open, a "disk full" message
  1281. will appear (see the "N" switch above) and the file will be closed.  The
  1282. built-in variable "_dfc" will be set to 1.
  1283.  
  1284. See also CAPMode.
  1285.  
  1286.  
  1287. ===  CHATmode  ===
  1288.  
  1289.  
  1290. Default key:   Alt-- (Alt minus)
  1291. Description:   Set Chat Mode toggle.
  1292.  
  1293. Examples:
  1294.  
  1295.      {chat}
  1296.           Toggle Chat Mode on/off.
  1297.  
  1298.      {chat y}
  1299.           Turn on Chat Mode.
  1300.  
  1301.      {chat n}
  1302.           Turn off Chat Mode
  1303.  
  1304.  
  1305. ===  CLEAr  ===
  1306.  
  1307.  
  1308. Default key:   Alt-C
  1309. Description:   Clear Terminal Screen to default colors.
  1310.  
  1311. Example:
  1312.  
  1313.      {clear}
  1314.           No arguments.
  1315.  
  1316.  
  1317. ===  COMPare  ===
  1318.  
  1319.  
  1320. Default key:   none
  1321. Description:   Compare a string or numeric variable.
  1322.  
  1323. General form:
  1324.  
  1325.      {COMPare name,string}
  1326.  
  1327.           name
  1328.                The name of a variable.
  1329.  
  1330.           string
  1331.                A string of ASCII characters.
  1332.  
  1333.  
  1334.  
  1335.                                     -27-
  1336.  
  1337. Examples:
  1338.  
  1339.      {comp pword,aardvark}
  1340.           Test if the variable "pword" is set to "aardvark."
  1341.  
  1342.      {comp pword}
  1343.           Test if "pword" is null.
  1344.  
  1345.      {comp pword,}
  1346.           Test if "pword" is null.
  1347.  
  1348.      {comp nmbr,5}
  1349.           Compare a numeric variable.
  1350.  
  1351.      {comp abc,%xyz}
  1352.           Test if the variable "abc" is equal to the variable "xyz."
  1353.  
  1354. A numeric variable is a string of ASCII digits, 0-9, forming a positive
  1355. integer.  If the number is outside the allowed range or contains non-
  1356. numeric characters, the results of the compare will be unpredictable.
  1357.  
  1358. COMPare will set flags which can be tested with the IFCOndition function.
  1359.  
  1360.      The Condition Flag will be set to "true" if the two arguments are
  1361.      identical strings (case is ignored).  Otherwise it will be set to
  1362.      "false."
  1363.  
  1364.      The Numeric Flag will be set to "equal", "less than" or "greater
  1365.      than."  This flag is unpredictable unless both arguments are valid
  1366.      numeric variables.
  1367.  
  1368. A variable may be tested for being null (no entry in variable space) by
  1369. omitting the second argument (or by comparing to a null variable).
  1370.  
  1371. See also IFCOndition.
  1372.  
  1373.  
  1374. ===  CURSor  ===
  1375.  
  1376.  
  1377. Default key:   none
  1378. Description:   Terminal Screen cursor on/off.
  1379.  
  1380. Examples:
  1381.  
  1382.      {cursor}
  1383.           Toggle Terminal cursor on/off.
  1384.  
  1385.      {curs y}
  1386.           Turn on Terminal Screen cursor.
  1387.  
  1388.      {curs n}
  1389.           Turn off Terminal Screen cursor.
  1390.  
  1391.  
  1392.  
  1393.                                     -28-
  1394.  
  1395.  
  1396.  
  1397. ===  DECRement  ===
  1398.  
  1399.  
  1400. Default key:   none
  1401. Description:   Subtract a number from a numeric variable.
  1402.  
  1403. Examples:
  1404.  
  1405.      {decr count}
  1406.           Subtract 1 from the variable "count".
  1407.  
  1408.      {decr apples,200}
  1409.           Subtract 200 from "apples".
  1410.  
  1411. The default for the second argument is 1.
  1412.  
  1413. If the result is less than 0 or if either argument is out of range, then
  1414. the variable will be set to the string "ERROR".
  1415.  
  1416. If the variable is not numeric, the results will be unpredictable.
  1417.  
  1418. See also INCRement.
  1419.  
  1420.  
  1421. ===  DIAL  ===
  1422.  
  1423.  
  1424. Default keys:  Alt-D, Alt-N
  1425. Description:   Open Dialing Directory, dial marked systems.
  1426.  
  1427. General form:
  1428.  
  1429.      {DIAL tries,label1,label2}
  1430.  
  1431.           tries
  1432.                The maximum number of dialing tries.  If no connection is
  1433.                established when the try count is exhausted, the macro in
  1434.                the second argument will be started.  May be 0 to 999.  "0"
  1435.                means unlimited.  Default is 0.
  1436.  
  1437.           label1
  1438.                A macro to GOTO if the try count in the first argument is
  1439.                exhausted.  If no macro is specified or if the macro label
  1440.                is invalid, control will pass to the next function.  Default
  1441.                is none.
  1442.  
  1443.                If the "C" switch is used, the macro will be CALLed.  When a
  1444.                RETUrn is executed, control will return to the DIAL
  1445.                function.
  1446.  
  1447.  
  1448.  
  1449.                                     -29-
  1450.  
  1451.           label2
  1452.                A macro to GOTO when a response is matched during the Inter-
  1453.                dial Delay.  Response strings are listed in the reserved
  1454.                variable "_dialir" and are usually defined in the Setup
  1455.                File.
  1456.  
  1457.                If the "C" switch is used, the macro will be CALLed.  When a
  1458.                RETUrn is executed, control will return to the DIAL
  1459.                function.
  1460.  
  1461. Switches:
  1462.  
  1463.      C1 or C
  1464.           Specifies that macros will be started via CALL (instead of GOTO). 
  1465.           When the macros execute a RETUrn, control returns to the DIAL
  1466.           function and Multi Number Dialing will resume.
  1467.  
  1468.           The "C" switch applies to the Linked Macro (from the Dialing
  1469.           Directory), the "tries exhausted" macro and to the Inter-dial
  1470.           Delay macro.
  1471.  
  1472.      C0
  1473.           Start dialing macros via GOTO (default).
  1474.  
  1475. Examples:
  1476.  
  1477.      {dial}
  1478.           Open Dialing Directory window (similar to Alt-D).
  1479.  
  1480.      {dial ,}
  1481.           Multi Number Dial (similar to Alt-N).
  1482.  
  1483.      {dial 25,abc}
  1484.           Multi Number Dial with try count.
  1485.  
  1486.      {dial-C ,}
  1487.           Multi Number Dial, CALL Linked Macros.
  1488.  
  1489.      {dial-c ,,inter}
  1490.           Multi Number Dial with Inter-dial Delay macro.
  1491.  
  1492.  
  1493. ----------  Marking Numbers for Dialing
  1494.  
  1495.  
  1496. Numbers may be marked in one of several ways:
  1497.  
  1498.      1)   Manually in the Dialing Directory window.
  1499.      2)   By placing Dialing Strings on the {COMMO} command line.
  1500.      3)   Using the MARK macro function.
  1501.  
  1502. Marked numbers will be redialed in sequence.  If a connection occurs and a
  1503. valid Linked Macro is specified in the Dialing Directory, the macro will be
  1504.  
  1505.  
  1506.  
  1507.                                     -30-
  1508.  
  1509. started via GOTO (unless the "C" switch is present).  If no macro is
  1510. specified in the Dialing Directory, control is passed to the next function.
  1511.  
  1512. If no numbers are marked when executing the DIAL, control will pass to the
  1513. next function.
  1514.  
  1515.  
  1516. ----------  Automatic Resumption of Dialing
  1517.  
  1518.  
  1519. Here are two methods for resuming at the end of a Linked Macro.  Both allow
  1520. multiple systems to be called without operator intervention.
  1521.  
  1522.      1)   Use the "C" switch on the DIAL function.  Each Linked Macro
  1523.           should end with a RETUrn which will transfer control back to the
  1524.           DIAL.  When all numbers have been called, control will pass to
  1525.           the function following the DIAL.
  1526.  
  1527.      2)   At the end of each Linked Macro (after logging off), GOTO a macro
  1528.           such as this:
  1529.  
  1530.             {:nocar} {pause 1} {ifcarrier nocar} {dial ,} {}
  1531.  
  1532.           This ensures that carrier has dropped before DIALing the next
  1533.           number.  The PAUSe allows data to display on the screen while
  1534.           waiting for carrier to drop.
  1535.  
  1536.  
  1537. ----------  Testing Success and Failure Results
  1538.  
  1539.  
  1540. Details about a successful or failed dialing attempt are available in
  1541. several reserved variables (see Appendix I "List of Reserved Variables" for
  1542. complete descriptions):
  1543.  
  1544.      _dtc
  1545.           Dialing termination code
  1546.  
  1547.      _dialrt
  1548.           Dialing response text
  1549.  
  1550.      _mod
  1551.           Speed reported by modem (normally in the CONNECT or CARRIER
  1552.           response)
  1553.  
  1554. After a successful attempt the variables "_dialrt" and "_mod" may be tested
  1555. in your Linked Macro.  For example, if you expected a high-speed connect
  1556. and the speed reported was 2400 or 1200, then you may want to hang up and
  1557. try again later.
  1558.  
  1559. You can get control after each failed attempt by using "DIAL 1", with or
  1560. without a macro.  For example:
  1561.  
  1562.  
  1563.  
  1564.                                     -31-
  1565.  
  1566.      1)   {dial-c 1,nocon} ...
  1567.  
  1568.           The Linked Macro and the "no connect" macro will be CALLed (the
  1569.           "C" switch).  The variables "_dtc" and "_dialrt" may be tested in
  1570.           the macro at "nocon".
  1571.  
  1572.      2)   {dial 1} ...
  1573.  
  1574.           Control will pass to the next function if a dialing attempt fails
  1575.           or when no more systems are marked (test "_dtc" to determine
  1576.           which).
  1577.  
  1578. If the testing indicates that the system should not be dialed again (e.g.,
  1579. it did not answer, _dtc = 3), the UNMArk function can be used with the "L"
  1580. switch to unmark the last number dialed: {unmark-l}.
  1581.  
  1582.  
  1583. ----------  Handling Incoming Calls
  1584.  
  1585.  
  1586. Most modems return the string "RING" when a call comes in.  If this happens
  1587. during the Inter-dial Delay, you may choose to stop dialing (to answer a
  1588. voice call) or to send a brief message to a modem caller (during a BBS
  1589. event, for example).
  1590.  
  1591. Use "label2" on the DIAL function to process responses during the Inter-
  1592. dial Delay.  For example:
  1593.  
  1594.      {dial ,,incoming}
  1595.  
  1596. The macro at "incoming" will execute if the modem sends an Inter-dial Delay
  1597. response string (these are normally defined in the Setup File with the
  1598. "_dialir" variable).
  1599.  
  1600. See also: SETDial, MARK, UNMArk.
  1601.  
  1602.  
  1603. ===  DISPlay  ===
  1604.  
  1605.  
  1606. Default key:   none
  1607. Description:   Display a string to the screen.
  1608.  
  1609. General form:
  1610.  
  1611.      {DISPlay row,col,attr,string}
  1612.  
  1613.           row
  1614.                The row where the string will display.
  1615.  
  1616.           col
  1617.                The column where the string will display.
  1618.  
  1619.  
  1620.  
  1621.                                     -32-
  1622.  
  1623.           attr
  1624.                The attribute (colors) of the string.
  1625.  
  1626.           string
  1627.                The text of the string (no quotes).
  1628.  
  1629. Examples:
  1630.  
  1631.      {display 12,20,17,Hello!}
  1632.           Display "Hello!" at row 12, column 20.  Colors are white on blue.
  1633.  
  1634.      {disp ,,,Hello, again.^m^j}
  1635.           Display "Hello, again." at the current cursor using the current
  1636.           attribute, followed by a cr/lf.
  1637.  
  1638.      {disp 3,40}
  1639.           Position the cursor at row 3, column 40.
  1640.  
  1641. TIPS on using DISPlay:
  1642.  
  1643. >    The attribute is specified in the same manner as the colors in the
  1644.      Setup File (press F7 in the Internal Editor to display the Color
  1645.      Chart).
  1646.  
  1647. >    Setting background colors to high intensity values will cause blinking
  1648.      (for example, using "9" instead of "1" will still give a blue
  1649.      background but the foreground character will blink).  
  1650.  
  1651. >    After the string is displayed, the previous Terminal Screen attribute
  1652.      will be restored.
  1653.  
  1654. >    Conversion is performed on the string according to the rules in
  1655.      Appendix D.
  1656.  
  1657.  
  1658. ===  DIVIde  ===
  1659.  
  1660.  
  1661. Default key:   none
  1662. Description:   Divide a numeric variable by a number.
  1663.  
  1664. Example:
  1665.  
  1666.      {divi space,1024}
  1667.           Divide "space" by 1024.
  1668.  
  1669. The divisor (second argument) is limited to 65535 (default is 1).
  1670.  
  1671. The named variable will be set to the quotient, the built-in variable
  1672. "_rem" will be set to the remainder.
  1673.  
  1674. If the divisor is zero or if either argument is out of range, then the
  1675. variable will be set to the string "ERROR".
  1676.  
  1677.  
  1678.  
  1679.                                     -33-
  1680.  
  1681.  
  1682. If the variable is not numeric, the results will be unpredictable.
  1683.  
  1684.  
  1685. ===  DOORway  ===
  1686.  
  1687.  
  1688. Default key:   Alt-=
  1689. Description:   Toggle Doorway Mode.
  1690.  
  1691. Switches:
  1692.  
  1693.      S1 or S
  1694.           Status Line on when entering Doorway Mode.
  1695.  
  1696.      S0
  1697.           Status Line off (default).
  1698.  
  1699.      M0
  1700.           Do not display Doorway enter/exit messages.
  1701.  
  1702.      M1
  1703.           Display enter/exit messages (default).
  1704.  
  1705. Examples:
  1706.  
  1707.      {doorway}
  1708.           Toggle Doorway Mode on/off.
  1709.  
  1710.      {door-S}
  1711.           Status Line on when entering Doorway Mode.
  1712.  
  1713.      {doorway-M0}
  1714.           Do not display enter/exit messages.
  1715.  
  1716. The "S" switch is ignored when exiting Doorway Mode (the Status Line will
  1717. be restored to its prior state).
  1718.  
  1719.  
  1720. ===  DPARms  ===
  1721.  
  1722.  
  1723. Default key:   Alt-P
  1724. Description:   Set Default Dialing Terminal Parameters
  1725.  
  1726. General form:
  1727.  
  1728.      {DPARms speed,format,comport,terminal-type,delay}
  1729.  
  1730.  
  1731.  
  1732.                                     -34-
  1733.  
  1734.           speed
  1735.                The bps rate: 2400, 9600, etc.
  1736.  
  1737.           format
  1738.                The data format: 8n1, 7e1, etc.
  1739.  
  1740.           comport
  1741.                The serial port number: 1, 2, 3 or 4.
  1742.  
  1743.           terminal
  1744.                The terminal-type: A, V or T.
  1745.  
  1746.           delay
  1747.                The inter-character delay factor: 0-999.
  1748.  
  1749. Examples:
  1750.  
  1751.      {dparms 2400,8,1,,20}
  1752.           Set 2400 bps, 8n1, Com1, delay=20.
  1753.  
  1754.      {dparms ,,4,V}
  1755.           Set Com4 VT102.
  1756.  
  1757.      {dparms 19200,7o1}
  1758.           Set 19200 bps, 7o1.
  1759.  
  1760. IMPORTANT!  Omitted parameters are not changed.
  1761.  
  1762. These are the parameters that are set whenever a number is DIALed.  Any of
  1763. them may be overridden in the Dialing Directory entry.
  1764.  
  1765. See also PARMs.
  1766.  
  1767.  
  1768. ===  EDIT  ===
  1769.  
  1770.  
  1771. Default key:   none
  1772. Description:   Edit an external file.
  1773.  
  1774. Example:
  1775.  
  1776.      {edit c:\autoexec.bat}
  1777.           Edit AUTOEXEC.BAT file.
  1778.  
  1779. EDIT may be used to edit any text file up to 64k in length.  The rules are
  1780. the same as for editing a support file with the Internal Editor.
  1781.  
  1782. TIPS on using EDIT:
  1783.  
  1784. >    Control characters (below ASCII 28) may not be typed.
  1785.  
  1786.  
  1787.  
  1788.                                     -35-
  1789.  
  1790. >    Any data beyond the last cr/lf pair will be removed prior to editing. 
  1791.      A cr/lf pair will be added, if necessary, to ensure at least one line
  1792.      in the file.
  1793.  
  1794. >    The file will be saved unconditionally when Alt-F is pressed or
  1795.      conditionally (if changes were made) when Esc is pressed.  The file is
  1796.      "saved in place" (no backup).
  1797.  
  1798.  
  1799. ===  ELAPse  ===
  1800.  
  1801.  
  1802. Default key:   none
  1803. Description:   Reset the elapsed timer to 0 minutes.
  1804.  
  1805. Example:
  1806.  
  1807.      {elap}
  1808.           No arguments.
  1809.  
  1810. The elapsed timer is automatically reset whenever dialing begins and when a
  1811. connection is made with a remote system.
  1812.  
  1813.  
  1814. ===  EXECute  ===
  1815.  
  1816.  
  1817. Default key:   none
  1818. Description:   Execute a DOS command.
  1819.  
  1820. Switches:
  1821.  
  1822.      A1 or A
  1823.           Sound the alarm at the end of command execution.
  1824.  
  1825.      A0
  1826.           Do not sound the alarm (default).
  1827.  
  1828.      D1 or D
  1829.           Execute an external program directly, without use of the command
  1830.           processor (see details below).
  1831.  
  1832.      D0
  1833.           Use the command processor (default).
  1834.  
  1835.      N1 or N
  1836.           Do not clear the screen before execution.  This is useful when
  1837.           running programs that clear or rewrite the screen.  Also for
  1838.           simple DOS functions like changing directories, renaming files,
  1839.           etc.  
  1840.  
  1841.      N0
  1842.           Clear the screen (default).
  1843.  
  1844.  
  1845.  
  1846.                                     -36-
  1847.  
  1848.  
  1849.      S1 or S
  1850.           Swap to Disk before executing the program (see details below).
  1851.  
  1852.      S0
  1853.           Do not swap to disk (default).
  1854.  
  1855.      W
  1856.           Wait for a key press before restoring the Terminal Screen.  This
  1857.           is useful if you need to see the results of the command
  1858.           execution.
  1859.  
  1860.      Wn
  1861.           Wait for "n" seconds, "n" may range from 0 to 999.  Press a key
  1862.           to cancel the wait.
  1863.  
  1864.           Note:  Default (no "W" switch) is no wait.
  1865.  
  1866. Examples:
  1867.  
  1868.      {exec-AW3 dsz port %_por speed %_spe sz %uldir%\%file}
  1869.           {COMMO} will prepare the DSZ command by expanding the "%"
  1870.           variables, then call DOS to execute the program.
  1871.  
  1872.           See the section "Macro Variables" for complete details on
  1873.           variable substitution.
  1874.  
  1875.           The alarm will sound at completion (the "A" switch) and {COMMO}
  1876.           will wait for three seconds (the "W3" switch) before restoring
  1877.           the Terminal Screen.
  1878.  
  1879.      {execute-DN c:\utils\list.com %_cap}
  1880.           The LIST program will be directly executed with the current
  1881.           Capture File pathname as a command line argument.  The screen
  1882.           will not be cleared (LIST will rewrite the screen).  {COMMO} will
  1883.           return immediately to the Terminal Screen when LIST exits.
  1884.  
  1885. The EXECute function enables you to "build" a command to be executed by
  1886. DOS.  The DOS command processor (COMMAND.COM) is normally used (see below),
  1887. which implies that you may specify any command as you would type it from
  1888. the DOS prompt.
  1889.  
  1890. Thus you can execute batch files and internal DOS commands (REN, DEL,
  1891. etc.).  Also you can omit command paths and extensions (if the command is
  1892. in your PATH or in the current directory).
  1893.  
  1894. Character conversion is performed in the EXECute function.  This enables
  1895. you to specify control characters.  For example:
  1896.  
  1897.      {exec echo ^L> prn}   Send a formfeed to the printer
  1898.  
  1899. See Appendix D for details on conversion.  Note that the vertical bar "|"
  1900. is NOT translated to a carriage return in the EXECute function.  
  1901.  
  1902.  
  1903.  
  1904.                                     -37-
  1905.  
  1906.  
  1907. Key codes may be placed in the keyboard buffer prior to EXECute using the
  1908. KEYStuff function.
  1909.  
  1910.  
  1911. ----------  Using the Direct Switch: EXEC-D
  1912.  
  1913.  
  1914. Use this switch to execute .EXE and .COM programs without the use of the
  1915. command processor (usually COMMAND.COM).
  1916.  
  1917. The program's Exit Code (called ERRORLEVEL in batch files) is saved and may
  1918. be tested with the IFERrorlevel function.  The Exit Code is also available
  1919. in the variable "_err".
  1920.  
  1921. There are several advantages to using the "D" switch:
  1922.  
  1923. 1)   Only the memory needed to run the program is required (the command
  1924.      processor requires that about 32k be available, even if the program
  1925.      being run is much smaller).
  1926.  
  1927. 2)   About 4k of memory is saved by not having a copy of the command
  1928.      processor resident when the program is running.
  1929.  
  1930. 3)   The program executes faster, since COMMAND.COM is not loaded from
  1931.      disk.
  1932.  
  1933. 4)   The program's Exit Code is preserved and may be tested with the
  1934.      {COMMO} IFERrorlevel function.
  1935.  
  1936. Two important rules must be followed when using the "D" switch:
  1937.  
  1938. 1)   The full pathname of the program file must be specified, including the
  1939.      path where the file resides on disk and the file extension.  For
  1940.      example:
  1941.  
  1942.           {exec-D c:\util\list.com file.txt}
  1943.  
  1944. 2)   Only .EXE and .COM files may be run (batch files and internal DOS
  1945.      commands cannot be executed without COMMAND.COM).
  1946.  
  1947.  
  1948. ----------  Using the Swap to Disk Switch: EXEC-S
  1949.  
  1950.  
  1951. The "S" switch will direct {COMMO} to write the program and associated data
  1952. to a disk file.  This will free up approximately 50k to 180k of memory,
  1953. depending on the sizes of your Variable Space, Scrollback Buffer, Dialing
  1954. Directory and Macro File.  The pathname of this file is specified with
  1955. "swp=" in the Setup File (under "Paths and Files").  
  1956.  
  1957. When the program or shell exits back to {COMMO}, the program and data will
  1958. be restored from the disk file.  Any errors in this process will cause
  1959.  
  1960.  
  1961.  
  1962.                                     -38-
  1963.  
  1964. {COMMO} to exit to DOS.  If the Swap File cannot be opened or there is not
  1965. enough disk space for the swap, the EXECute (or SHELl) will be attempted
  1966. without swapping.
  1967.  
  1968. TIPS on using Swap to Disk:
  1969.  
  1970. >    The serial port will be closed during the swap (normally it is left
  1971.      open to receive characters during EXECute and SHELl).  To avoid losing
  1972.      any data, swapping should be initiated when the remote system is quiet
  1973.      (or when you are offline).
  1974.  
  1975. >    Use Swap to Disk when running major applications such as external
  1976.      protocol drivers, offline mail readers, etc.  Using it with internal
  1977.      DOS functions (DEL, COPY, REN, etc.) or very small programs is
  1978.      inefficient and unnecessary.
  1979.  
  1980. >    If possible, specify the Swap File on a RAMDISK.  This will speed up
  1981.      the swap considerably.  A ramdisk program is supplied with DOS
  1982.      (RAMDRIVE.SYS or VDISK.SYS) or you can obtain one from a BBS.
  1983.  
  1984. >    Be sure to specify a complete pathname for the Swap File.
  1985.  
  1986. >    Do not run any TSR (resident) programs when swapping is in effect. 
  1987.      Doing so may result in a swap error.
  1988.  
  1989.  
  1990. ----------  EXECute Preview Mode
  1991.  
  1992.  
  1993. Use the Set Toggles key command, Alt-T, to turn on "EXECute Preview Mode." 
  1994. This mode is used to test your DOS commands and performs the following
  1995. steps for each EXECute function:
  1996.  
  1997. 1)   The command will be displayed after expanding variables and converting
  1998.      control characters.
  1999.  
  2000. 2)   You will be given an opportunity to edit and/or cancel the command
  2001.      before it is executed.
  2002.  
  2003. 3)   Following execution {COMMO} will wait before restoring the Terminal
  2004.      Screen.  This lets you see any error messages that the command may
  2005.      have displayed.
  2006.  
  2007.  
  2008. ===  EXIT  ===
  2009.  
  2010.  
  2011. Default key:   Alt-X
  2012. Description:   Exit {COMMO}.
  2013.  
  2014. General form:
  2015.  
  2016.      {EXIT number}
  2017.  
  2018.  
  2019.  
  2020.                                     -39-
  2021.  
  2022.  
  2023.           number
  2024.                The return code to be passed to DOS.  It may be tested with
  2025.                the IF ERRORLEVEL batch command.  Range is 0 to 255.
  2026.  
  2027. Switches:
  2028.  
  2029.      D1 or D
  2030.           Drop DTR and RTS.  Dropping DTR will cause the modem to
  2031.           disconnect if it has been properly initialized.  See Appendix A.
  2032.  
  2033.      D0
  2034.           Do not drop DTR and RTS.
  2035.  
  2036.           If the switch is absent, the current setting of the toggle will
  2037.           be used.  The toggle can be set in the Setup File or by using the
  2038.           Alt-T key command.
  2039.  
  2040. Examples:
  2041.  
  2042.      {exit}
  2043.           No arguments (return code = 0).
  2044.  
  2045.      {exit 3}
  2046.           With return code.
  2047.  
  2048.      {exit-D}
  2049.           Drop DTR and RTS.
  2050.  
  2051.  
  2052. ===  FILE  ===
  2053.  
  2054.  
  2055. Default key:   none
  2056. Description:   Find directory entry information.
  2057.  
  2058. General form:
  2059.  
  2060.      {FILE filespec}
  2061.  
  2062.           filespec
  2063.                The path and file mask to be used for finding directory
  2064.                entries (filenames and subdirectories).  May consist of
  2065.                drive, path and filename with wildcards.
  2066.  
  2067. Switches:
  2068.  
  2069.      X1 or X
  2070.           Find next matching entry.
  2071.  
  2072.      X0
  2073.           Find first matching entry (default).
  2074.  
  2075.  
  2076.  
  2077.                                     -40-
  2078.  
  2079. Examples:
  2080.  
  2081.      {file c:\upload\*.*}
  2082.           Find first filename or subdirectory in the directory "c:\upload."
  2083.  
  2084.      {file-x}
  2085.           Find next filename in same directory.
  2086.  
  2087. The FILE function will find directory information about the files and
  2088. subdirectories specified in "filespec."  The data will be made available in
  2089. the following built-in variables:
  2090.  
  2091.      _ffn
  2092.           Filename or subdirectory name.  Subdirectory names will be
  2093.           preceded with a "\".  The parent directory (if any) will be
  2094.           indicated as "\..".
  2095.  
  2096.      _ffs
  2097.           File size in bytes.
  2098.  
  2099.      _ffd
  2100.           File date.  The format will be as specified in Setup File item
  2101.           "dat=".
  2102.  
  2103.      _fft
  2104.           File time.  The format will be as specified in Setup File item
  2105.           "tim=".
  2106.  
  2107. The FILE function must be executed without the "X" switch (or with X0) to
  2108. initialize the directory.  This will also make available the first filename
  2109. or subdirectory.  Subsequent executions (with the "X" switch) will make
  2110. subsequent names available.
  2111.  
  2112. Use the IFCOndition function to determine if a filename was made available. 
  2113. The first label ("true") will be taken if a filename was found;  the second
  2114. label ("false") will be taken if no additional filenames are available.
  2115.  
  2116. NOTE:  The built-in variables will always contain the data for the last
  2117. filename found.  If no filename has ever been found, the contents are
  2118. unpredictable.
  2119.  
  2120.  
  2121. ===  GETString  ===
  2122.  
  2123.  
  2124. Default key:   none
  2125. Description:   Input a string from the modem to a variable.
  2126.  
  2127. General form:
  2128.  
  2129.      {GETString name,count,label}
  2130.  
  2131.  
  2132.  
  2133.                                     -41-
  2134.  
  2135.           name
  2136.                The name of the variable to which the string will be
  2137.                assigned.
  2138.  
  2139.           count
  2140.                The maximum number of data characters allowed.  A carriage
  2141.                return will always terminate input.  May be 1 to 240. 
  2142.                Default is 240.
  2143.  
  2144.           label
  2145.                A macro to GOTO if a carriage return is received and no
  2146.                characters have been entered (the string will be assigned as
  2147.                null).  If this argument is omitted, control will pass to
  2148.                the next function.
  2149.  
  2150. Switches:
  2151.  
  2152.      A1 or A
  2153.           "Append" mode.  Characters will be appended to the variable.  If
  2154.           the current length of the variable is greater than the count in
  2155.           the second argument, a count of 240 will be assumed.
  2156.  
  2157.      A0
  2158.           The variable will be replaced (default).
  2159.  
  2160.      H1 or H
  2161.           "Hotkey" mode.  When the maximum number of characters has been
  2162.           entered, control will pass to the next function.
  2163.  
  2164.      H0
  2165.           Ignore all input after the maximum has been entered, except
  2166.           backspace and carriage return (default).
  2167.  
  2168.      P1 or P
  2169.           "Password" mode.  Asterisks will be echoed to the remote and
  2170.           local terminals in place of the received characters (Echo Status
  2171.           will be honored, see SETGet).
  2172.  
  2173.      P0
  2174.           Characters are echoed as received (default).
  2175.  
  2176. Examples:
  2177.  
  2178.      {setget 60,timeout,y,^m^j}
  2179.           Set GETString parameters.
  2180.  
  2181.      {gets fonum,12,badinput}
  2182.           Get input to "fonum."
  2183.  
  2184.      {gets-p pword,20}
  2185.           Get a password.
  2186.  
  2187.  
  2188.  
  2189.                                     -42-
  2190.  
  2191. TIPS on using GETString:
  2192.  
  2193. >    The only control characters allowed (below ASCII 28) are carriage
  2194.      return (ASCII 13) and backspace (ASCII 8).  Other control characters
  2195.      should be entered as ^J for linefeed, etc.  See Appendix D.
  2196.  
  2197. >    Destructive backspace processing is supported for editing purposes.
  2198.  
  2199. >    GETString supports "tandem" input.  Characters entered at either end
  2200.      will be input to the string (and displayed at both ends if echo is on
  2201.      (see SETGet).  Turn on Local Echo to see text locally that is sent to
  2202.      the remote with SEND, ASCIiup, etc.
  2203.  
  2204. >    Use the "H" switch and a character count of 1 for "hotkeys."
  2205.  
  2206. >    Turn off echo in the SETGet while waiting for the modem to answer (in
  2207.      host mode).  Some modems react poorly to characters being echoed when
  2208.      they are generating a response (such as "RING").
  2209.  
  2210. >    Incoming characters displayed during a GETString function are not seen
  2211.      by subsequent SSLOok/CALOok/GOLOok/LOOKfor functions.
  2212.  
  2213. See also SETGet.
  2214.  
  2215.  
  2216. ===  GOLOok  ===
  2217.  
  2218.  
  2219. Default key:   none
  2220. Description:   GOTO a label when a string appears.
  2221.  
  2222. General form:
  2223.  
  2224.      {GOLOok label,target}
  2225.  
  2226.           label
  2227.                A label to GOTO when the target is received from the serial
  2228.                port.
  2229.  
  2230.           target
  2231.                The ASCII string to look for.  The string begins following
  2232.                the "," and is terminated by the "}".
  2233.  
  2234. GOLOok is used in conjunction with the LOOKfor function.  It sets up an
  2235. additional string to look for.  When the target string appears, control
  2236. will pass to the label.
  2237.  
  2238. See LOOKfor for details, examples and tips on using GOLOok.
  2239.  
  2240. See also: SSLOok, CALOok, SETLook.
  2241.  
  2242.  
  2243.  
  2244.                                     -43-
  2245.  
  2246. ===  GOTO  ===
  2247.  
  2248.  
  2249. Default key:   none
  2250. Description:   Transfer control to a macro label.
  2251.  
  2252. Example:
  2253.  
  2254.      {goto mail_run}
  2255.           Control transferred to label "mail_run".
  2256.  
  2257.  
  2258. ===  HANGup  ===
  2259.  
  2260.  
  2261. Default key:   Alt-H
  2262. Description:   Disconnect by dropping DTR.
  2263.  
  2264. Examples:
  2265.  
  2266.      {hangup}
  2267.           Prompt user for disconnect.
  2268.  
  2269.      {hangup y}
  2270.           Disconnect without prompting.
  2271.  
  2272.  
  2273. ===  HELP  ===
  2274.  
  2275.  
  2276. Default key:   F1
  2277. Description:   Open Online Help window.
  2278.  
  2279. Examples:
  2280.  
  2281.      {help}
  2282.           Display key command help
  2283.  
  2284.      {help x}
  2285.           Display topic "TX"
  2286.  
  2287. Any single character may be specified.  {COMMO} will prefix it with a "T"
  2288. and search for the topic code.  You may create your own Online Help file. 
  2289. See "Modifying the Help File" in Part I.
  2290.  
  2291.  
  2292. ===  HOLD  ===
  2293.  
  2294.  
  2295. Default key:   none
  2296. Description:   Hold until specified time of day (24 hour format).
  2297.  
  2298.  
  2299.  
  2300.                                     -44-
  2301.  
  2302. Examples:
  2303.  
  2304.      {hold 3:30}
  2305.           Hold until 3:30 am.
  2306.  
  2307.      {hold 16:10}
  2308.           Hold until 4:10 pm.
  2309.  
  2310.      {hold 0:00}
  2311.           Hold until midnight.
  2312.  
  2313. NOTE:  Incoming characters displayed during a HOLD function are not seen by
  2314. subsequent SSLOok/CALOok/GOLOok/LOOKfor functions.
  2315.  
  2316.  
  2317. ===  IFCArrier  ===
  2318.  
  2319.  
  2320. Default key:   none
  2321. Description:   Test for presence of carrier detect signal.
  2322.  
  2323. General form:
  2324.  
  2325.      {IFCArrier true,false}
  2326.  
  2327.           true
  2328.                A label to GOTO or CALL if carrier is detected.
  2329.  
  2330.           false
  2331.                A label to GOTO or CALL if carrier is not detected.
  2332.  
  2333. NOTE:  If the target label is omitted (null), control will pass to the next
  2334. function.
  2335.  
  2336. Switches:
  2337.  
  2338.      C1 or C
  2339.           A CALL is performed on the label.  When the CALLed routine
  2340.           RETUrns, execution will continue following the IFCArrier.
  2341.  
  2342.      C0
  2343.           A GOTO is performed (default).
  2344.  
  2345. Examples:
  2346.  
  2347.      {ifcarrier c10,c20}
  2348.           Using GOTO
  2349.  
  2350.      {ifcarrier-c c10,c20}
  2351.           Using CALL
  2352.  
  2353.  
  2354.  
  2355.                                     -45-
  2356.  
  2357. TIP on using IFCArrier:
  2358.  
  2359. >    When using a loop to wait for a change in carrier detect, you should
  2360.      include a short pause in the loop if you want characters to display. 
  2361.      The following sequence will display incoming characters while waiting
  2362.      for carrier detect to drop:
  2363.  
  2364.           ... {:cd1} {pause 1} {ifcarrier cd1} ...
  2365.  
  2366.  
  2367. ===  IFCOndition  ===
  2368.  
  2369.  
  2370. Default key:   none
  2371. Description:   Test for conditions set by other functions.
  2372.  
  2373. General form:
  2374.  
  2375.      {IFCOndition true,false}
  2376.  
  2377.           true
  2378.                A label to GOTO or CALL if the Condition Flag is true.
  2379.  
  2380.           false
  2381.                A label to GOTO or CALL if the Condition Flag is false.
  2382.  
  2383. NOTE:  If the target label is omitted (null), control will pass to the next
  2384. function.
  2385.  
  2386. Numeric switches:
  2387.  
  2388.      no switches present
  2389.           Test the current state of the Condition Flag.
  2390.  
  2391.      E1 or E
  2392.           Test for numeric equality.  A numeric string contains only the
  2393.           digits 0-9 and is in the range 0 to 65535.
  2394.  
  2395.      L1 or L
  2396.           Numeric test -- if first COMPare argument is less than the
  2397.           second.
  2398.  
  2399.      G1 or G
  2400.           Numeric test -- if first COMPare argument is greater than the
  2401.           second.
  2402.  
  2403.  
  2404.  
  2405.                                     -46-
  2406.  
  2407. Other switches:
  2408.  
  2409.      C1 or C
  2410.           A CALL is performed on the label.  When the CALLed routine
  2411.           RETUrns, execution will continue following the IFCOndition.
  2412.  
  2413.      C0
  2414.           A GOTO is performed (default).
  2415.  
  2416. Examples:
  2417.  
  2418.      {compare var1,message}
  2419.      {ifcondit match,nomatch}
  2420.           Compare and set Condition Flag.  GOTO "match" if the variable
  2421.           "var1" is set to "message," to "nomatch" if it is not.
  2422.  
  2423.      {compare value,200}
  2424.      {ifcon-GEC toobig,aok}
  2425.           Compare and set conditions.  CALL "toobig" if "value" is greater
  2426.           than or equal to 200, else CALL "aok."
  2427.  
  2428.      {instring zipcode,90}
  2429.      {ifcon yes,no}
  2430.           Test if "zipcode" contains the digits "90".  If "true" GOTO
  2431.           "yes", if "false" GOTO "no".
  2432.  
  2433. Switches may be used in any combination.  If any numeric switches are
  2434. present, the Condition Flag is not tested.
  2435.  
  2436. The difference between testing for string equality and numeric equality is
  2437. shown in this example:
  2438.  
  2439.      The strings "05" and "5" are different text strings, but are
  2440.      numerically equal.
  2441.  
  2442.  
  2443. ===  IFERrorlevel  ===
  2444.  
  2445.  
  2446. Default key:   none
  2447. Description:   Test the Exit Code set by certain functions.
  2448.  
  2449. General form:
  2450.  
  2451.      {IFERrorlevel number,true,false}
  2452.  
  2453.           number
  2454.                A number from 0 to 255.  It will be compared to the last
  2455.                Exit Code that was set.
  2456.  
  2457.  
  2458.  
  2459.                                     -47-
  2460.  
  2461.           true
  2462.                A label to GOTO or CALL if the Exit Code is greater than or
  2463.                equal to "number."
  2464.  
  2465.           false
  2466.                A label to GOTO or CALL if the Exit Code is less than
  2467.                "number."
  2468.  
  2469. NOTE:  If the target label is omitted (null), control will pass to the next
  2470. function.
  2471.  
  2472. Switches:
  2473.  
  2474.      C1 or C
  2475.           A CALL is performed on the label.  When the CALLed routine
  2476.           RETUrns, execution will continue following the IFERrorlevel.
  2477.  
  2478.      C0
  2479.           A GOTO is performed (default).
  2480.  
  2481. Examples:
  2482.  
  2483.      {iferror 1,abc,def}
  2484.           GOTO "abc" if Exit Code is greater than or equal to 1.  Else GOTO
  2485.           def.
  2486.  
  2487.      {ifer-c 2,gtr2}
  2488.           CALL "gtr2" if Exit Code is greater than or equal to 2  Else
  2489.           continue.
  2490.  
  2491. TIPS on using IFERrorlevel:
  2492.  
  2493. >    The Exit Code is set by certain functions (e.g., EXECute-D, SHELl,
  2494.      RXMOdem, SXMOdem) and should normally be tested immediately following
  2495.      execution of those functions.
  2496.  
  2497. >    EXECute without the "D" switch or Shell to DOS will normally set the
  2498.      Exit Code to 0.
  2499.  
  2500. >    Many programs return an Exit Code greater than 0 when the result is
  2501.      unsuccessful.  DSZ, for example, will return an Exit Code of 1 if the
  2502.      file transfer has failed.
  2503.  
  2504. >    The value of the Exit Code is also stored in the string variable
  2505.      "_err" and may be tested with COMPare.
  2506.  
  2507.  
  2508. ===  IFEXist  ===
  2509.  
  2510.  
  2511. Default key:   none
  2512. Description:   Test for existence of a disk file or files.
  2513.  
  2514.  
  2515.  
  2516.                                     -48-
  2517.  
  2518. General form:
  2519.  
  2520.      {IFEXist pathname,true,false}
  2521.  
  2522.           pathname
  2523.                A DOS pathname.  If the path is omitted, the current
  2524.                directory will be used.  If wildcards are used the "true"
  2525.                condition will hold if any files match the specification.
  2526.  
  2527.           true
  2528.                A label to GOTO or CALL if the file exists.
  2529.  
  2530.           false
  2531.                A label to GOTO or CALL if no files match.
  2532.  
  2533. NOTE:  If the target label is omitted (null), control will pass to the next
  2534. function.
  2535.  
  2536. Switches:
  2537.  
  2538.      C1 or C
  2539.           A CALL is performed on the label.  When the CALLed routine
  2540.           RETUrns, execution will continue following the IFEXist.
  2541.  
  2542.      C0
  2543.           A GOTO is performed (default).
  2544.  
  2545. Examples:
  2546.  
  2547.      {ifex-c a:file.xyz,,m20}
  2548.           CALL "m20" if not found.
  2549.  
  2550.      {ifex c:\data\words.txt,345}
  2551.           GOTO "345" if found.
  2552.  
  2553.      {ifex c:\ul\*.rep,a01,a02}
  2554.           Using a wildcard.
  2555.  
  2556.  
  2557. ===  INCRement  ===
  2558.  
  2559.  
  2560. Default key:   none
  2561. Description:   Add a number to a numeric variable.
  2562.  
  2563. Examples:
  2564.  
  2565.      {incr count}
  2566.           Add 1 to the variable "count".
  2567.  
  2568.      {incr oranges,1234}
  2569.           Add 1234 to "oranges".
  2570.  
  2571.  
  2572.  
  2573.                                     -49-
  2574.  
  2575. The default for the second argument is 1.
  2576.  
  2577. If either argument or the result is out of range, then the variable will be
  2578. set to the string "ERROR".
  2579.  
  2580. If the variable is not numeric, the results will be unpredictable.
  2581.  
  2582. See also DECRement.
  2583.  
  2584.  
  2585. ===  INFOrm  ===
  2586.  
  2587.  
  2588. Default key:   none
  2589. Description:   Display an advisory message.
  2590.  
  2591. General form:
  2592.  
  2593.      {INFOrm string}
  2594.  
  2595.           string
  2596.                Message to be displayed.
  2597.  
  2598. Switches:
  2599.  
  2600.      Q1 or Q
  2601.           Query the user for a "Yes/No" response.  "Yes" will be the
  2602.           default if Enter is pressed.
  2603.  
  2604.           The Condition Flag will be set to "true" if the response is
  2605.           "yes".  It will be set to "false" if the response is "no".  Test
  2606.           with IFCOndition.
  2607.  
  2608.      Q0
  2609.           Query the user for a "Yes/No" response.  "No" will be the default
  2610.           if Enter is pressed.  The Condition Flag is set as above.
  2611.  
  2612.      Dn
  2613.           Display the message for "n" seconds, then continue.  "n" may
  2614.           range from 1 to 999.
  2615.  
  2616.      S1 or S
  2617.           An error sound will accompany the message (default).
  2618.  
  2619.      S0
  2620.           No error sound will be made.
  2621.  
  2622. Examples:
  2623.  
  2624.      {inform Press a key to continue}
  2625.           Wait for Esc.
  2626.  
  2627.  
  2628.  
  2629.                                     -50-
  2630.  
  2631.      {info-qs0 Overwrite the file?}
  2632.           Yes/No response, no error sound.
  2633.  
  2634.      {info-d3 Login now in progress}
  2635.           Display message for 3 seconds, then continue.
  2636.  
  2637. INFOrm will display a string in a pop-up box over the Terminal Screen. 
  2638. {COMMO} will normally wait for "Esc" to be pressed (switches can alter this
  2639. behavior).  The string length is limited by the width of the screen.
  2640.  
  2641. NOTE:  When the "Q" switch is used, Esc and Ctrl-Break will be ignored.
  2642.  
  2643.  
  2644. ===  INITmodem  ===
  2645.  
  2646.  
  2647. Default key:   Alt-O
  2648. Description:   Send Modem Initialization String.
  2649.  
  2650. Example:
  2651.  
  2652.      {init}
  2653.           No arguments
  2654.  
  2655.  
  2656. ===  INPUt  ===
  2657.  
  2658.  
  2659. Default key:   none
  2660. Description:   Input a string from the keyboard.
  2661.  
  2662. General form:
  2663.  
  2664.      {INPUt name,prompt}
  2665.  
  2666.           name
  2667.                The name of a string variable.  The current value of this
  2668.                variable will appear in the input line.
  2669.  
  2670.           prompt
  2671.                A prompt string that will appear in the input window border.
  2672.  
  2673. Example:
  2674.  
  2675.      {input upfile,Enter a filename:}
  2676.           Input a string to the variable "upfile."
  2677.  
  2678. If 0 data characters are entered, the variable will be set to null.
  2679.  
  2680. NOTE:  If Esc is pressed, macro processing will be terminated unless an
  2681. exit label has been defined with SETEsc.
  2682.  
  2683.  
  2684.  
  2685.                                     -51-
  2686.  
  2687. ===  INSTring  ===
  2688.  
  2689.  
  2690. Default key:   none
  2691. Description:   Find a string within a string, return its position.
  2692.  
  2693. General form:
  2694.  
  2695.      {INSTring name,string}
  2696.  
  2697.           name
  2698.                The name of a variable (string to search in).
  2699.  
  2700.           string
  2701.                The string to search for.
  2702.  
  2703. Example:
  2704.  
  2705.      {inst line,abc}
  2706.           The variable "line" is searched for the string "abc".
  2707.  
  2708. INSTring will set the following:
  2709.  
  2710.      1)   The Condition Flag will be set to "true" if the string is found,
  2711.           to "false" if the string is not found.  Test with IFCOndition, no
  2712.           switches.
  2713.  
  2714.      2)   The starting position of the string will be returned in the
  2715.           built-in variable "_pos" (first character is "1").  "_pos" will
  2716.           be set to zero if the string is not found.
  2717.  
  2718.  
  2719. ===  KEYStuff  ===
  2720.  
  2721.  
  2722. Default key:   none
  2723. Description:   Put key codes into the keyboard buffer.
  2724.  
  2725. Examples:
  2726.  
  2727.      {keys 1c0d}
  2728.           Put a carriage return into the keyboard buffer.
  2729.  
  2730.      {keys 1e41,6c00}
  2731.           Put an "A" in the keyboard buffer followed by Alt-F5.
  2732.  
  2733. This function is usually used prior to EXECuting programs, batch files or
  2734. DOS commands that require keys to be pressed.  It allows complete
  2735. automation without operator intervention.
  2736.  
  2737.  
  2738.  
  2739.                                     -52-
  2740.  
  2741. TIPS on using KEYStuff:
  2742.  
  2743. >    The key codes are given in hexadecimal (scan code/character code as
  2744.      received from the BIOS).  Press Alt-K in the Internal Editor to view
  2745.      any key code.
  2746.  
  2747. >    One or more codes may be listed.  Do not insert extra spaces.
  2748.  
  2749. >    Usually, when specifying an ASCII character, only the character code
  2750.      need be listed.  Thus the second example above could be written: 
  2751.      {keys 41,6c00}.
  2752.  
  2753.  
  2754. ===  LENGth  ===
  2755.  
  2756.  
  2757. Default key:   none
  2758. Description:   Determine the length of a string.
  2759.  
  2760. Examples:
  2761.  
  2762.      {leng %line}
  2763.           Find the length of the string in the variable "line".
  2764.  
  2765.      {leng %line1%%line2}
  2766.           Find the combined length of "line1" and "line2".
  2767.  
  2768. The length will be returned in the built-in variable "_len".  If the string
  2769. is null, the length will be set to zero.
  2770.  
  2771.  
  2772. ===  LIGHts  ===
  2773.  
  2774.  
  2775. Default key:   none
  2776. Description:   Set Signal Lights toggle.
  2777.  
  2778. Examples:
  2779.  
  2780.      {lights}
  2781.           Toggle Signal Lights on/off.
  2782.  
  2783.      {lights y}
  2784.           Turn on Signal Lights.
  2785.  
  2786.      {lights n}
  2787.           Turn off Signal Lights.
  2788.  
  2789.  
  2790.  
  2791.                                     -53-
  2792.  
  2793. ===  LOCAlecho  ===
  2794.  
  2795.  
  2796. Default key:   none
  2797. Description:   Set Local Echo toggle.
  2798.  
  2799. Examples:
  2800.  
  2801.      {local}
  2802.           Toggle Local Echo on/off.
  2803.  
  2804.      {local y}
  2805.           Turn on Local Echo.
  2806.  
  2807.      {local n}
  2808.           Turn off Local Echo.
  2809.  
  2810.  
  2811. ===  LOOKfor  ===
  2812.  
  2813.  
  2814. Default key:   none
  2815. Description:   Look for strings in the modem input stream.
  2816.  
  2817. LOOKfor is used in conjunction with SSLOok, CALOok and GOLOok to scan for
  2818. as many as 16 strings at the same time.  When SSLOok, CALOok and GOLOok set
  2819. up additional strings to look for, the actual "looking" does not take place
  2820. until the LOOKfor executes.
  2821.  
  2822. Parameters controlling LOOKfor are set with the SETLook function and may be
  2823. changed at any time with another SETLook.  See the description of the
  2824. SETLook function for details.
  2825.  
  2826. Examples using LOOKfor only:
  2827.  
  2828.      {lookfor first name?}
  2829.           Look for the string "first name?"
  2830.  
  2831.      {look ^(COMMO^)}
  2832.           Look for the string "{COMMO}".
  2833.  
  2834.      When the string comes in, control will pass to the next function.
  2835.  
  2836. Example construct using SSLOok/CALOok/GOLOok/LOOKfor:
  2837.  
  2838.                {setlook 60,hng,3,n|}
  2839.                {setv ss_r,|}
  2840.                  ...
  2841.      {:start}
  2842.                {golook label-a,target1}
  2843.                {calook start,label-b,target2}
  2844.                {sslook ss_r,target3}
  2845.                {golook ,target4}
  2846.  
  2847.  
  2848.  
  2849.                                     -54-
  2850.  
  2851.                {lookfor target5} {send answer5}
  2852.                {goto label-c}
  2853.  
  2854.      {:label-a}     {hangup y} {goto cancel}
  2855.      {:label-b}     {send answer2} {call subr} {return}
  2856.      {:label-c}          ...
  2857.  
  2858.      In this example {COMMO} will look for five target strings.
  2859.  
  2860.      When a target specified in any of the CALOok, GOLOok or LOOKfor
  2861.      functions is received, the LOOKfor is cancelled.  It may be set up
  2862.      again by going to "start".
  2863.  
  2864.      When the target specified in the SSLOok is received, the string in the
  2865.      variable will be transmitted to the serial port.  The LOOKfor will
  2866.      continue to look for the same targets.
  2867.  
  2868.      The GOLOok function for target1 will GOTO "label-a" when the string
  2869.      comes in.  In the example control will pass to "cancel" (macro not
  2870.      shown).
  2871.  
  2872.      If target2 comes in, the CALOok function will set "start" as the
  2873.      return point and then CALL "label-b".  When this routine RETUrns,
  2874.      control returns to "start" and the five string LOOKfor will be set up
  2875.      again.
  2876.  
  2877.      If target3 is received, the string in the variable "ss_r" will be sent
  2878.      (in this case, a carriage return) and looking will continue.
  2879.  
  2880.      The GOLOok for target4 has a null label and control will pass to the
  2881.      function following the LOOKfor if that string comes in.  The "," must
  2882.      be present.
  2883.  
  2884.      If target5 comes in, control will pass to the function following the
  2885.      LOOKfor.
  2886.  
  2887. TIPS on creating LOOKfor strings:
  2888.  
  2889. >    There should be just one space following the LOOKfor function name. 
  2890.      Any spaces beyond this point are part of the string.  The string ends
  2891.      at the right curly brace.
  2892.  
  2893. >    SSLOok/CALOok/GOLOok/Auto Receive strings begin immediately after the
  2894.      comma.  There should be no spaces unless they are part of the string.
  2895.  
  2896. >    Strings may be up to 32 characters in length (control characters like
  2897.      "^M" count as one).  Upper/lower case is ignored.
  2898.  
  2899. >    ANSI control sequences are filtered if ANSI or VT102 emulation is
  2900.      enabled.
  2901.  
  2902. >    Remember that short strings may not be unique enough, long strings may
  2903.      not match due to line noise.
  2904.  
  2905.  
  2906.  
  2907.                                     -55-
  2908.  
  2909.  
  2910. >    Rules for representing special characters in
  2911.      SSLOok/CALOok/GOLOok/LOOKfor/Auto Receive strings are given in
  2912.      Appendix D.
  2913.  
  2914. Additional TIPS:
  2915.  
  2916. >    SSLOok, CALOok and GOLOok functions should immediately precede a
  2917.      LOOKfor (no string compares actually occur until the LOOKfor
  2918.      executes).  Up to 15 SSLOok/CALOok/GOLOok strings may be used in
  2919.      addition to the LOOKfor (up to 16 strings total).
  2920.  
  2921. >    FILTER Capture Mode should be used to determine the exact prompt to
  2922.      look for.  The LOOKfor sees the incoming data exactly as it is
  2923.      captured when FILTER mode is set.
  2924.  
  2925. >    If two or more strings cause a match at the same time, the LAST such
  2926.      string listed is the one acted upon (for example, if "abcdef" and
  2927.      "def" are listed and the string "abcdef" comes in).
  2928.  
  2929. See also: SSLOok, CALOok, GOLOok, SETLook.
  2930.  
  2931.  
  2932. ===  MACLoad  ===
  2933.  
  2934.  
  2935. Default key:   none
  2936. Description:   Load a new Macro File.
  2937.  
  2938. General form:
  2939.  
  2940.      {MACLoad filename,label}
  2941.  
  2942.           filename
  2943.                The new Macro File.  Do NOT specify a path; the {COMMO} home
  2944.                directory will be used.
  2945.  
  2946.           label
  2947.                A label to GOTO when the new file is loaded.  Optional.
  2948.  
  2949. Switches:
  2950.  
  2951.      R1 or R
  2952.           Specifies that COMMO.MAC will be reloaded when carrier detect is
  2953.           lost.  Normally this would occur at the end of the call.
  2954.  
  2955.      R0
  2956.           Do not reload COMMO.MAC when carrier is lost (default).
  2957.  
  2958. Examples:
  2959.  
  2960.      {macload-R vt102-1.mac}
  2961.           Load vt102-1.mac, reload COMMO.MAC at the end of the call.
  2962.  
  2963.  
  2964.  
  2965.                                     -56-
  2966.  
  2967.  
  2968.      {macl newmac.fil,abc}
  2969.           Load newmac.fil, start macro "abc" in the new file.
  2970.  
  2971.      {macload commo.mac,%mcall}
  2972.           Load COMMO.MAC, GOTO the label specified in the variable "mcall".
  2973.  
  2974. IMPORTANT!  The new Macro File must reside in the {COMMO} home directory
  2975. (do not specify a path).
  2976.  
  2977. TIPS on using MACLoad:
  2978.  
  2979. >    The new Macro File can be "called" (by setting a variable to the
  2980.      return label).  Use this variable as the optional label when
  2981.      "returning" to the calling Macro File.
  2982.  
  2983. >    The macro stack is preserved during MACLoad.  Be sure that your CALLs
  2984.      and RETUrns are in "sync" or the results may be unpredictable.
  2985.  
  2986. >    The current file will be saved to disk if changes are outstanding. 
  2987.      The new file is then loaded in place of the current one (all macros
  2988.      are replaced).  
  2989.  
  2990. >    MACLoad should be the last function in a macro, since control is not
  2991.      returned.
  2992.  
  2993.  
  2994. ===  MACRo  ===
  2995.  
  2996.  
  2997. Default key:   Alt-M
  2998. Description:   Open Macro Processor window.
  2999.  
  3000. Examples:
  3001.  
  3002.      {macro}
  3003.           Open window at current position.
  3004.  
  3005.      {macro menu1}
  3006.           Open window at "menu1."
  3007.  
  3008. NOTE:  The MACRo function always terminates the macro that is currently
  3009. executing.
  3010.  
  3011. A string argument may be included to facilitate the creation of menus
  3012. within the Macro File.  The first occurrence of the argument string will
  3013. become the top line of the display when the window is opened.
  3014.  
  3015. The Selector Bar will be positioned on the first screen line that has a
  3016. left curly brace, if any.
  3017.  
  3018.  
  3019.  
  3020.                                     -57-
  3021.  
  3022. Here is an example of how to structure a menu using MACRo:
  3023.  
  3024.                                    | (this is past col. 80)
  3025.                                    | menu111
  3026.           Name of Menu             |
  3027.                                    |
  3028.                                    |
  3029.           Selection 1              | {goto sel1}
  3030.           Selection 2              | {goto sel2}
  3031.           Selection 3              | {goto sel3}
  3032.  
  3033.      {:af1} {macro menu111}
  3034.      {:sel1} ...
  3035.      {:sel2} ...
  3036.      {:sel3} ...
  3037.  
  3038. The upper line with "menu111" will be the top line of the screen.  Pressing
  3039. Alt-F1 will bring up the menu with the Selector Bar on Selection 1.  Macros
  3040. at "sel1", "sel2" and "sel3" will process the respective selections.
  3041.  
  3042. Note that the macro at "af1" to invoke the menu must be below the menu
  3043. since it contains the string and would be found in the search.
  3044.  
  3045. See also MENU.
  3046.  
  3047.  
  3048. ===  MARK  ===
  3049.  
  3050.  
  3051. Default key:   none
  3052. Description:   Mark Dialing Directory entries for dialing.
  3053.  
  3054. Example:
  3055.  
  3056.      {mark joes-bbs,file-city}
  3057.           Mark entries for dialing.
  3058.  
  3059. Dialing Strings may be separated by spaces or commas.
  3060.  
  3061. {COMMO} will search the Dialing Directory for each string and mark the
  3062. first entry where a match is found.  Case is ignored.
  3063.  
  3064. The strings may consist of any part of a Dialing Directory entry line
  3065. (including strings contained within curly braces), but must NOT contain any
  3066. spaces, commas or curly braces.
  3067.  
  3068. See also: DIAL, UNMArk.
  3069.  
  3070.  
  3071.  
  3072.                                     -58-
  3073.  
  3074. ===  MENU  ===
  3075.  
  3076.  
  3077. Default key:   none
  3078. Description:   Create a pop-up macro menu.
  3079.  
  3080. General form:
  3081.  
  3082.      {SETV _menu1,text1}
  3083.      {SETV _menu2,text2}
  3084.           ...
  3085.      {SETV _menuN,textN}
  3086.  
  3087.           text1
  3088.                Text to be placed on first information line in the pop-up
  3089.                window (third line down, counting from the top border).
  3090.  
  3091.                NOTE:  These text strings are simply information and have no
  3092.                effect on which macros will be executed.
  3093.  
  3094.           text2
  3095.                Text to be placed on second information line.
  3096.           ...
  3097.  
  3098.           textN
  3099.                Text to be placed on Nth information line.
  3100.  
  3101.      {SETV _mlabel,label1,label2,...}
  3102.  
  3103.           NOTE:  Labels are positional and may be omitted using null
  3104.           arguments for keys that aren't used.  See example 2 below.
  3105.  
  3106.           label1
  3107.                Label to GOTO if F1, A or 1 is pressed.  Any of the three
  3108.                keys will activate the macro at the first label.
  3109.  
  3110.           label2
  3111.                Label to GOTO if F2, B or 2 is pressed.
  3112.  
  3113.           ... etc.
  3114.  
  3115.      {SETV _menter,label}
  3116.  
  3117.           label
  3118.                Label to GOTO if Enter is pressed.
  3119.  
  3120.      {SETV _mcolor,text,border}
  3121.  
  3122.           text
  3123.                Colors for the text area of the pop-up window.
  3124.  
  3125.           border
  3126.                Colors for the window border.
  3127.  
  3128.  
  3129.  
  3130.                                     -59-
  3131.  
  3132.  
  3133.           NOTE:  The attributes are specified in the same manner as the
  3134.           colors in the Setup File (press F7 in the Internal Editor to
  3135.           display the Color Chart).  
  3136.  
  3137.      {MENU height,width,string}
  3138.  
  3139.           height
  3140.                Total number of rows from top to bottom of pop-up window,
  3141.                including borders.  Minimum is 5.
  3142.  
  3143.           width
  3144.                Total number of columns from left side to right side,
  3145.                including borders.  Minimum is 23.
  3146.  
  3147.           string
  3148.                Title string that will appear in the top border.
  3149.  
  3150. Example 1:
  3151.  
  3152.           {setv _menu1, F1  Call computer at work}
  3153.           {setv _menu3, F2  Call E-mail service}
  3154.           {setv _menu5, F3  Run offline mail reader}
  3155.           {setv _mlabel,work,mail,reader}
  3156.           {setv _mcolor,17,30}
  3157.           {menu 9,32,Daily Activity Menu} {}
  3158.  
  3159.      {:work}    ... macro to call work computer.
  3160.      {:mail}    ... macro to call E-mail service.
  3161.      {:reader}  ... macro to run offline reader.
  3162.  
  3163.      This menu specifies that function keys be pressed to activate the
  3164.      macros.  You could also press A or 1 instead of F1, B or 2 instead of
  3165.      F2, etc.  The macros may be as simple or as complex as desired to
  3166.      complete the task.
  3167.  
  3168. Example 2:
  3169.  
  3170.           {setv _menu1, [D]  Dialing Directory}
  3171.           {setv _menu4, [E]  Edit a file}
  3172.           {setv _menu2, [M]  Macro File}
  3173.           {setv _menu3, [Enter]  Shell to DOS (with swap)}
  3174.           {setv _mlabel,,,,ddir,edit,,,,,,,,mfile}
  3175.           {setv _menter,dos}
  3176.           {setv _mcolor,03,47}
  3177.           {menu 8,39,Common Commands} {}
  3178.  
  3179.      {:ddir}  {dial} {}
  3180.      {:edit}  {input efile,Filename to Edit}
  3181.               {edit %efile} {}
  3182.      {:mfile} {macro}
  3183.      {:dos}   {shell-s} {}
  3184.  
  3185.  
  3186.  
  3187.                                     -60-
  3188.  
  3189.      This menu uses "mnemonic" key labeling -- D for (D)ialing Directory,
  3190.      etc.  Notice that there are three empty positions in the "_mlabel"
  3191.      list prior to "ddir" and "edit".  These correspond to A, B and C,
  3192.      which are not used in this menu.  Then there are empty positions up to
  3193.      "mfile" (M).
  3194.  
  3195. TIPS on using MENU:
  3196.  
  3197. >    The dimensions of the window are limited by the current size of the
  3198.      Terminal Screen.
  3199.  
  3200. >    The total number of displayable lines is "height" less 4.  Lines in
  3201.      the window for which no "_menux" variable has been defined will be
  3202.      left blank.
  3203.  
  3204. >    Up to 26 labels can be specified in each menu.  These correspond to
  3205.      pressing the letters A through Z.  The first 12 labels also correspond
  3206.      to pressing F1 through F12, while the first 9 labels correspond to
  3207.      pressing 1 through 9.
  3208.  
  3209. >    The built-in variable "_msn" is set to the number of the menu
  3210.      selection when a menu key is pressed: 0 for Enter, 1 to 26 for A to Z,
  3211.      etc.
  3212.  
  3213. >    All variables used to create the menu are automatically deleted from
  3214.      Variable Space after the menu is displayed. 
  3215.  
  3216. >    The last colors used to display a menu will persist until they are
  3217.      changed (by setting the "_mcolor" variable).
  3218.  
  3219. >    If Esc is pressed to exit the menu, macro processing continues in
  3220.      sequence following the MENU function.
  3221.  
  3222. See also MACRo.
  3223.  
  3224.  
  3225. ===  MULTiply  ===
  3226.  
  3227.  
  3228. Default key:   none
  3229. Description:   Multiply a numeric variable by a number.
  3230.  
  3231. Example:
  3232.  
  3233.      {mult money,10}
  3234.           Multiply "money" by 10.
  3235.  
  3236. The multiplier (second argument) is limited to 65535 (default is 1).
  3237.  
  3238. If either argument or the result is out of range, then the variable will be
  3239. set to the string "ERROR".
  3240.  
  3241. If the variable is not numeric, the results will be unpredictable.
  3242.  
  3243.  
  3244.  
  3245.                                     -61-
  3246.  
  3247.  
  3248.  
  3249. ===  NOCArrier  ===
  3250.  
  3251.  
  3252. Default key:   none
  3253. Description:   Sets/resets a macro to execute when carrier detect is lost.
  3254.  
  3255. Examples:
  3256.  
  3257.      {nocar carrlost}
  3258.           GOTO the label "carrlost" when the carrier detect signal drops.
  3259.  
  3260.      {nocar}
  3261.           Turn off the carrier lost label.
  3262.  
  3263. IMPORTANT!  This feature is enabled only when a connection is made using
  3264. {COMMO}'s Auto Dialer.  Also, if carrier drops while a macro is running or
  3265. a command window is open (such as the Dialing Directory or Capture File
  3266. Options), the carrier lost macro will not activate.
  3267.  
  3268. Be sure that you have your modem configured to provide the carrier detect
  3269. signal.  See Appendix A for modem information.
  3270.  
  3271.  
  3272. ===  NOOP  ===
  3273.  
  3274.  
  3275. Default key:   none
  3276. Description:   No-op function, does nothing
  3277.  
  3278. Example:
  3279.  
  3280.      {noop}
  3281.           No arguments.
  3282.  
  3283.  
  3284. ===  OFFLog  ===
  3285.  
  3286.  
  3287. Default key:   none
  3288. Description:   Make an {Off} entry in the Usage Log.
  3289.  
  3290. Example:
  3291.  
  3292.      {offlog}
  3293.           No arguments.
  3294.  
  3295. This function is useful on systems that do not support the carrier detect
  3296. signal.
  3297.  
  3298. NOTE:  An {Off} entry will be made only if an {On} entry was made at
  3299. connection time.
  3300.  
  3301.  
  3302.  
  3303.                                     -62-
  3304.  
  3305.  
  3306.  
  3307. ===  PARMs  ===
  3308.  
  3309.  
  3310. Default key:   Alt-P
  3311. Description:   Set Current Terminal Parameters
  3312.  
  3313. General form:
  3314.  
  3315.      {PARMs speed,format,comport,terminal-type,delay}
  3316.  
  3317.           speed
  3318.                The bps rate: 2400, 9600, etc.
  3319.  
  3320.           format
  3321.                The data format: 8n1, 7e1, etc.
  3322.  
  3323.           comport
  3324.                The serial port number: 1, 2, 3 or 4.
  3325.  
  3326.           terminal
  3327.                The terminal-type: A, V or T.
  3328.  
  3329.           delay
  3330.                The inter-character delay factor: 0-999.
  3331.  
  3332. Examples:
  3333.  
  3334.      {parms 2400,8,1,,20}
  3335.           Set 2400 bps, 8n1, Com1, delay=20.
  3336.  
  3337.      {parms ,,4,V}
  3338.           Set Com4 VT102.
  3339.  
  3340.      {parms 19200,7o1}
  3341.           Set 19200 bps, 7o1.
  3342.  
  3343. IMPORTANT!  Omitted parameters are not changed.
  3344.  
  3345. This function will change the current parameters, but has no effect on the
  3346. parameters set when dialing.
  3347.  
  3348. See also DPARms.
  3349.  
  3350.  
  3351. ===  PASSword  ===
  3352.  
  3353.  
  3354. Default key:   Alt-W
  3355. Description:   Send current password.
  3356.  
  3357.  
  3358.  
  3359.                                     -63-
  3360.  
  3361. Example:
  3362.  
  3363.      {password}
  3364.           No arguments.
  3365.  
  3366. The current password is obtained from the Dialing Directory entry whenever
  3367. a number is dialed.  If no password is specified no characters will be
  3368. sent.
  3369.  
  3370.  
  3371. ===  PAUSe  ===
  3372.  
  3373.  
  3374. Default key:   none
  3375. Description:   Pause for a time interval.
  3376.  
  3377. Switches:
  3378.  
  3379.      T or T1
  3380.           Time is specified in DOS clock ticks (there are 18 clock ticks
  3381.           per second).
  3382.  
  3383.      T0
  3384.           Time is specified in seconds (default).
  3385.  
  3386. Examples:
  3387.  
  3388.      {pause 25}
  3389.           Pause for 25 seconds.
  3390.  
  3391.      {pause-t 9}
  3392.           Pause for 9 clock ticks (one half second).
  3393.  
  3394. NOTE:  Incoming characters displayed during a PAUSe function are not seen
  3395. by subsequent SSLOok/CALOok/GOLOok/LOOKfor functions.
  3396.  
  3397.  
  3398. ===  POPStack  ===
  3399.  
  3400.  
  3401. Default key:   none
  3402. Description:   Pop an element from the macro stack.
  3403.  
  3404. Switches:
  3405.  
  3406.      C1 or C
  3407.           Clear all elements from the stack.
  3408.  
  3409.      C0
  3410.           Pop the top element (default).
  3411.  
  3412.  
  3413.  
  3414.                                     -64-
  3415.  
  3416. Examples:
  3417.  
  3418.      {pops}
  3419.           Pop the top element.
  3420.  
  3421.      {pops-c}
  3422.           Clear the stack.
  3423.  
  3424. POPStack throws away the top element on the macro stack.  This element
  3425. would have been used by the next RETUrn function.
  3426.  
  3427. See PUSHstack for a more complete description of the use of this function.
  3428.  
  3429. See also CALL, RETUrn.
  3430.  
  3431.  
  3432. ===  PRINtlog  ===
  3433.  
  3434.  
  3435. Default key:   Alt-2
  3436. Description:   Set Print Log toggle.
  3437.  
  3438. Examples:
  3439.  
  3440.      {print}
  3441.           Toggle Print Log on/off.
  3442.  
  3443.      {print y}
  3444.           Turn on Print Log.
  3445.  
  3446.      {print n}
  3447.           Turn off Print Log.
  3448.  
  3449.  
  3450. ===  PUSHstack  ===
  3451.  
  3452.  
  3453. Default key:   none
  3454. Description:   Push a return point onto the macro stack.
  3455.  
  3456. Examples:
  3457.  
  3458.      {push}
  3459.           Push the current location.
  3460.  
  3461.      {push abc}
  3462.           Push the location "abc".
  3463.  
  3464. When there are no arguments, the location pushed is the location of the
  3465. PUSHstack function itself (i.e., it will be executed again when a RETUrn is
  3466. encountered).
  3467.  
  3468.  
  3469.  
  3470.                                     -65-
  3471.  
  3472. Explanation:  Whenever a CALL is executed, the location of the function
  3473. following the CALL (the "return point") is "pushed" onto the macro stack. 
  3474. When a subsequent RETUrn is executed, the location at the top of the stack
  3475. is "popped" and control is transferred to that location.  This allows
  3476. "nesting" of CALLs and RETUrns.
  3477.  
  3478. PUSHstack will push a return point onto the macro stack without
  3479. transferring control to the location (control continues in sequence).  A
  3480. subsequent RETUrn will transfer control to the location that was pushed.
  3481.  
  3482. POPStack will remove the top stack element without transferring control to
  3483. it (control continues in sequence).
  3484.  
  3485. See also CALL, RETUrn.
  3486.  
  3487.  
  3488. ===  RCLOse  ===
  3489.  
  3490.  
  3491. Default key:   none
  3492. Description:   Close the read file.
  3493.  
  3494. Example:
  3495.  
  3496.      {rclose}
  3497.           No arguments.
  3498.  
  3499. NOTE:  The read file will be closed automatically in the following
  3500. situations:
  3501.  
  3502.      1)   When an attempt is made to read past the end of the file.
  3503.      2)   When the macro terminates (STOP, EXIT, etc.).
  3504.  
  3505. See also ROPEn, READ.
  3506.  
  3507.  
  3508. ===  READ  ===
  3509.  
  3510.  
  3511. Default key:   none
  3512. Description:   Read a line from the read file to a variable.
  3513.  
  3514. Example:
  3515.  
  3516.      {read nextline}
  3517.           Read the next line in the file into the variable "nextline."
  3518.  
  3519. TIPS on reading files:
  3520.  
  3521. >    A file must be open for reading or a macro error will result.
  3522.  
  3523. >    Each READ will get the next line in the file (lines are terminated by
  3524.      carriage return and linefeed).
  3525.  
  3526.  
  3527.  
  3528.                                     -66-
  3529.  
  3530.  
  3531. >    When an attempt is made to read past the end of file, control will
  3532.      GOTO the label specified in the ROPEn.  If no label was specified or
  3533.      if the label was invalid, control will continue in sequence.  In
  3534.      either case the file is automatically closed and the variable is set
  3535.      to null.
  3536.  
  3537. >    READ will set the Exit Code to 0 unless the end of file was
  3538.      encountered, in which case it will be set to 1.  The Exit Code is
  3539.      stored in the built-in variable "_err" and can be tested with the
  3540.      IFERrorlevel function.
  3541.  
  3542. >    ALL control characters (below ASCII 28) will be discarded, including
  3543.      the carriage return/linefeed that terminates the line.
  3544.  
  3545. >    Lines longer than 240 characters will be truncated to a length of 240.
  3546.  
  3547. See also ROPEn, RCLOse
  3548.  
  3549.  
  3550. ===  RETUrn  ===
  3551.  
  3552.  
  3553. Default key:   none
  3554. Description:   Return from a CALLed macro.
  3555.  
  3556. Example:
  3557.  
  3558.      {return}
  3559.           No arguments.
  3560.  
  3561. This function will return control to a location determined by the last CALL
  3562. or PUSHstack function.  See PUSHstack for a more complete description of
  3563. CALL and RETUrn.
  3564.  
  3565. NOTE:  If a RETUrn is encountered and no CALL or PUSHstack has been
  3566. executed, a STOP will occur.  This is useful in macros that are CALLed and
  3567. are also used standalone (such as protocol file transfer macros).
  3568.  
  3569. See also CALL, PUSHstack, POPStack.
  3570.  
  3571.  
  3572. ===  ROPEn  ===
  3573.  
  3574.  
  3575. Default key:   none
  3576. Description:   Open a file for reading.
  3577.  
  3578. General Form:
  3579.  
  3580.      {ROPEn pathname,label}
  3581.  
  3582.  
  3583.  
  3584.                                     -67-
  3585.  
  3586.           pathname
  3587.                The pathname of the file to open.
  3588.  
  3589.           label
  3590.                A label to GOTO when a READ is attempted at the end of the
  3591.                file.
  3592.  
  3593. Example:
  3594.  
  3595.      {ropen c:\bbs\file.txt,nomore}
  3596.           Open the file and set the label "nomore" to GOTO when the end of
  3597.           the file is reached.
  3598.  
  3599. TIPS on using ROPEn:
  3600.  
  3601. >    Only one file may be opened for reading (and one for writing).
  3602.  
  3603. >    The file will be automatically closed when the end of the file is
  3604.      encountered during a READ (whether or not a label is specified).  An
  3605.      RCLOse is not needed in this situation.
  3606.  
  3607. See also READ, RCLOse.
  3608.  
  3609.  
  3610. ===  RTRAn  ===
  3611.  
  3612.  
  3613. Default key:   none
  3614. Description:   Maintain Receive Translate Table.
  3615.  
  3616. Switches:
  3617.  
  3618.      I1 or I
  3619.           Initialize Receive Translate Table to default values (consecutive
  3620.           0 to 255).
  3621.  
  3622.      I0
  3623.           Do not initialize (default).
  3624.  
  3625. Examples:
  3626.  
  3627.      {rtran y}
  3628.           Turn receive translation ON.
  3629.  
  3630.      {rtran-i n}
  3631.           Initialize the table and turn it OFF.
  3632.  
  3633.      {rtran 26,0}
  3634.           Change ASCII 26 to null (ASCII 0, which will not display).
  3635.  
  3636.      {rtran-i y,#8,224,240}
  3637.           Initialize the table, turn receive translation ON, change ASCII
  3638.           224 to 240, 225 to 241, ..., 231 to 247.  
  3639.  
  3640.  
  3641.  
  3642.                                     -68-
  3643.  
  3644.  
  3645.      {rtran}
  3646.           Toggle receive translation ON/OFF.
  3647.  
  3648.      {rtran #13,65,78,#13,78,65,#13,97,110,#13,110,97}
  3649.           ROT13 translation.  This exchanges each letter in the first half
  3650.           of the alphabet with the corresponding letter from the second
  3651.           half (and vice-versa).
  3652.  
  3653. Rules for RTRAn arguments are the same as for the {rtr=} item in the Setup
  3654. File.  In addition, "n" may be used as the first argument to turn receive
  3655. translation OFF at any time.
  3656.  
  3657. See "Edit Setup File" in Part I for details and more examples.
  3658.  
  3659. TIPS on using RTRAn:
  3660.  
  3661. >    Some control characters are unaffected by translation when certain
  3662.      features are enabled.  Examples:  XON (17) and XOFF (19) are not
  3663.      translated when Software Flow Control is on.  ENQ (5) is not
  3664.      translated when ENQ/ACK emulation is on.
  3665.  
  3666. >    When the Capture Mode is set to RAW, data will be captured prior to
  3667.      translation.  FILTER and SCREEN captures will contain translated data.
  3668.  
  3669. >    LOOKfor will always see translated data.  Use FILTER Capture Mode to
  3670.      see what LOOKfor sees.
  3671.  
  3672. >    In GETString, incoming data (as well as locally typed characters) will
  3673.      be translated with the Receive Translate Table (it may be necessary to
  3674.      turn receive translation off during certain GETString functions).
  3675.  
  3676. See also STRAn.
  3677.  
  3678.  
  3679. ===  RXMOdem  ===
  3680.  
  3681.  
  3682. Default key:   none
  3683. Description:   Receive a file using the Xmodem protocol.
  3684.  
  3685. Switches:
  3686.  
  3687.      See RYMOdem (switches are the same).
  3688.  
  3689. Example:
  3690.  
  3691.      {rxmo-ya c:\dl\file.zip}
  3692.           Receive "file.zip", overwrite the file if it exists, sound the
  3693.           alarm.
  3694.  
  3695.  
  3696.  
  3697.                                     -69-
  3698.  
  3699. Only one file may be received with each RXMOdem function (the file must be
  3700. explicitly named, but need not be given the same name as on the remote
  3701. system).
  3702.  
  3703. See RYMOdem for tips that apply to both RXMOdem and RYMOdem.
  3704.  
  3705. See also SXMOdem, RYMOdem.
  3706.  
  3707.  
  3708. ===  RYMOdem  ===
  3709.  
  3710.  
  3711. Default key:   none
  3712. Description:   Receive files using the Ymodem Batch protocol.
  3713.  
  3714. Switches:
  3715.  
  3716.      C1 or C
  3717.           Use CRC error correction (default).
  3718.  
  3719.      C0
  3720.           Use Checksum error correction.
  3721.  
  3722.      G1 or G
  3723.           Use streaming (fast) transfer method.
  3724.  
  3725.           IMPORTANT!  Use only with error-correcting modems or direct
  3726.           connections between computers.
  3727.  
  3728.      G0
  3729.           Use normal (error-correcting) transfer method (default).
  3730.  
  3731.      Y1 or Y
  3732.           Overwrite an existing file when a received file has the same name
  3733.           (the existing file will be erased).
  3734.  
  3735.      Y0
  3736.           Cancel the transfer if a received file has the same name as an
  3737.           existing file (default).
  3738.  
  3739.      D1 or D
  3740.           Cancel transfer if carrier detect is lost (default).
  3741.  
  3742.           NOTE:  If carrier detect is off when the transfer is started,
  3743.           this switch will behave as if "D0" had been set.
  3744.  
  3745.      D0
  3746.           Ignore state of carrier detect.
  3747.  
  3748.  
  3749.  
  3750.                                     -70-
  3751.  
  3752.      A1 or A
  3753.           Sound the alarm at the end of the transfer.
  3754.  
  3755.      A0
  3756.           Do not sound the alarm (default).
  3757.  
  3758.      W
  3759.           Wait for a keypress at end of transfer.
  3760.  
  3761.      Wn
  3762.           Wait for "n" seconds, "n" may range from 0 to 999.  Press a key
  3763.           to cancel the wait.
  3764.  
  3765.           Note:  Default (no "W" switch) is no wait.
  3766.  
  3767. Examples:
  3768.  
  3769.      {rymo-ya %dldir}
  3770.           Receive files into the download directory, overwrite a file if it
  3771.           exists, sound the alarm.
  3772.  
  3773.      {rymo-gw3}
  3774.           Receive files using the "G" method into the current directory. 
  3775.           Wait 3 seconds before returning to the Terminal Screen.
  3776.  
  3777. Ymodem is a "batch" protocol that will receive multiple files.  Filenames
  3778. are transmitted by the sender and are used to name files at the receiving
  3779. end.  A filename "collision" will cause the transfer to cancel unless the
  3780. "Y" switch is used.  File sizes are also transmitted by the sender and are
  3781. used to truncate the file to the proper size.
  3782.  
  3783. TIPS on using RYMOdem and RXMOdem:
  3784.  
  3785. >    The "G" method is specified by the receiver.  Be sure that the sender
  3786.      allows it before starting.
  3787.  
  3788. >    Block size is established by the sender and may be changed on a block-
  3789.      by-block basis (always 1024 when the "G" method is used).
  3790.  
  3791. >    Some conditions that will cancel a transfer:
  3792.        1) 10 consecutive errors.
  3793.        2) Any error when "G" method is used.
  3794.        3) The file to be received already exists and the "Y" switch is not
  3795.           present.
  3796.        4) The sender has transmitted CAN (^X) characters.
  3797.  
  3798. >    The Exit Code (test with IFER) will be set at the end of the transfer. 
  3799.      The Exit Code will also be stored in the variable "_err".  0 means
  3800.      success, 1 means failure.
  3801.  
  3802. >    If the Usage Log is enabled, an entry will be made after each file is
  3803.      transferred (or if a transfer is cancelled).
  3804.  
  3805.  
  3806.  
  3807.                                     -71-
  3808.  
  3809. See also SYMOdem, RXMOdem.
  3810.  
  3811.  
  3812. ===  SCREen  ===
  3813.  
  3814.  
  3815. Default key:   Alt-I
  3816. Description:   Screen Image Save.
  3817.  
  3818. Examples:
  3819.  
  3820.      {screen}
  3821.           Open Screen Image Save window.
  3822.  
  3823.      {screen y}
  3824.           Append screen image to current file.
  3825.  
  3826.      {screen y,commo.scr}
  3827.           Append screen image to indicated file. (and change current
  3828.           pathname).
  3829.  
  3830.      {screen n,c:\file.xyz}
  3831.           Change current screen image pathname (don't save screen to file).
  3832.  
  3833.  
  3834. ===  SCROllback  ===
  3835.  
  3836.  
  3837. Default key:   Alt-K
  3838. Description:   Display Scrollback Buffer
  3839.  
  3840. Example:
  3841.  
  3842.      {scroll}
  3843.           No arguments.
  3844.  
  3845.  
  3846. ===  SEND  ===
  3847.  
  3848.  
  3849. Default key:   none
  3850. Description:   Send a string to the modem (serial port).
  3851.  
  3852. Examples:
  3853.  
  3854.      {send Fred|~~Brucker|~~%_pass%|}
  3855.           Send my first and last name with carriage returns and 1 second
  3856.           delays, then send the current password and a <cr>.
  3857.  
  3858.  
  3859.  
  3860.                                     -72-
  3861.  
  3862.      {send ^[^[}
  3863.           Send two <esc> characters.
  3864.  
  3865.      {send  }
  3866.           Send a space (there must be two spaces, the first is the
  3867.           separator).
  3868.  
  3869.      {send %line}
  3870.           Send the string in the variable "line".
  3871.  
  3872.  
  3873. NOTE:  See Appendix D for information on how to represent any character in
  3874. a SEND function.
  3875.  
  3876.  
  3877. ===  SETDial  ===
  3878.  
  3879.  
  3880. Default key:   none
  3881. Description:   Set parameters for dialing.
  3882.  
  3883. Examples:
  3884.  
  3885.      {setdial 60,15}
  3886.           Set the dialing cycle timer to 60 seconds and the Inter-dial
  3887.           Delay to 15 seconds.
  3888.  
  3889.      {setd ,3}
  3890.           Change only the Inter-dial Delay timer.
  3891.  
  3892. The first argument is the dialing cycle time limit.  This is the number of
  3893. seconds {COMMO} will allow after sending the dial command to the modem. 
  3894. Range is from 1 to 999.
  3895.  
  3896. The second argument is the inter-dial delay timer.  This is the number of
  3897. seconds before {COMMO} dials the next number.  Range is from 1 to 999.
  3898.  
  3899. NOTE:  Changes to dialing parameters override the Setup File values and
  3900. remain in effect until {COMMO} is exited.
  3901.  
  3902. See also DIAL.
  3903.  
  3904.  
  3905. ===  SETEsc  ===
  3906.  
  3907.  
  3908. Default key:   none
  3909. Description:   Define a label to GOTO when Esc is pressed.
  3910.  
  3911. General form:
  3912.  
  3913.      {setesc label}
  3914.  
  3915.  
  3916.  
  3917.                                     -73-
  3918.  
  3919.           label
  3920.                A label to GOTO when the user presses Esc during macro
  3921.                execution.
  3922.  
  3923. Switches:
  3924.  
  3925.      P1 or P
  3926.           The user will be prompted with, "A macro is running.  Terminate
  3927.           it?."  If the user answers "no," macro processing will continue
  3928.           as if nothing had happened.  If "yes," processing will GOTO the
  3929.           label.  If the label does not exist, a STOP will be executed.  P1
  3930.           is the default.
  3931.  
  3932.      P0
  3933.           The user will not be prompted.  Processing will GOTO the label if
  3934.           it exists, else a STOP will be executed.
  3935.  
  3936. Examples:
  3937.  
  3938.      {setesc finish}
  3939.           GOTO label, with prompt.
  3940.  
  3941.      {sete-p0 done}
  3942.           GOTO label, without prompt.
  3943.  
  3944.      {setesc}
  3945.           Reset to no label (STOP on Esc).
  3946.  
  3947.  
  3948. This function is used to "capture" the Esc key during macro execution,
  3949. especially when a MACLoad is used to load a new Macro File.  It will help
  3950. prevent accidental macro terminations.
  3951.  
  3952. The macro at the label would typically reload COMMO.MAC, thus restoring the
  3953. user's familiar environment.
  3954.  
  3955. NOTE:  In the various command windows, Esc is normally used to exit the
  3956. window.  Use Ctrl-Break to bring up the prompt.
  3957.  
  3958.  
  3959. ===  SETGet  ===
  3960.  
  3961.  
  3962. Default key:   none
  3963. Description:   Set parameters for GETString functions.
  3964.  
  3965. General form:
  3966.  
  3967.      {SETGet seconds,label,y/n/l,string}
  3968.  
  3969.  
  3970.  
  3971.                                     -74-
  3972.  
  3973.           seconds
  3974.                GETString timeout.  If a character is not entered in the
  3975.                specified amount of time, the macro in the second argument
  3976.                will be started.  May be 0 to 999.  Default is 0 (disabled).
  3977.  
  3978.           label
  3979.                Timeout macro.  Macro to GOTO if the time in the first
  3980.                argument expires.  If no macro is specified or if the macro
  3981.                label is invalid, control will pass to the function
  3982.                following the GETString.  Default is no macro.
  3983.  
  3984.                Note that if the timer expires no variable assignment will
  3985.                be made.  Any previous assignment will be unaltered.
  3986.  
  3987.           y/n/l
  3988.                Echo Status.  If this is "yes", characters entered at the
  3989.                local or remote terminals will be echoed back to the remote
  3990.                and displayed locally.  This is the default.
  3991.  
  3992.                If "no", characters will not be echoed to either location.
  3993.  
  3994.                If "local", characters will be displayed locally, but not
  3995.                echoed to the remote.  This should be used when the remote
  3996.                is a host system.
  3997.  
  3998.                IMPORTANT!  This setting is independent of Local Echo.  Turn
  3999.                on Local Echo if necessary for local display of data
  4000.                transmitted with SEND, ASCIiup, etc.
  4001.  
  4002.           string
  4003.                Terminator response.  This string will be sent and/or
  4004.                displayed locally (in accord with the Echo Status) when a
  4005.                carriage return is received (input terminated).  This is
  4006.                typically a carriage return/linefeed.  May be up to 32
  4007.                characters.  Default is no string.
  4008.  
  4009. Example:
  4010.  
  4011.      {setg 120,noget,y,^m^j}
  4012.           Set GETString parameters.
  4013.  
  4014.  
  4015. The SETGet function will set parameters for all subsequent GETString
  4016. functions.  It may be executed at any time to modify the parameters.
  4017.  
  4018. When macro processing terminates, the parameters will be reset to the
  4019. default values.
  4020.  
  4021.  
  4022.  
  4023.                                     -75-
  4024.  
  4025. Default arguments are:
  4026.  
  4027.      GETString timeout        0 (disabled)
  4028.      Timeout macro            none 
  4029.      Echo status              y (echo on)
  4030.      Terminator response      none
  4031.  
  4032. IMPORTANT!  Null arguments in the SETGet function will be set to these
  4033. defaults.
  4034.  
  4035. See also: GETString.
  4036.  
  4037.  
  4038. ===  SETLook  ===
  4039.  
  4040.  
  4041. Default key:   none
  4042. Description:   Set parameters for LOOKfor functions.
  4043.  
  4044. General form:
  4045.  
  4046.      {SETLook seconds,label,seconds,string}
  4047.  
  4048.           seconds
  4049.                LOOKfor timeout.  Maximum time in seconds to look for a
  4050.                string.  If the string is not found in the allotted time,
  4051.                the macro in the second argument will be started.  May be 0
  4052.                to 999.  Default is 0 (disabled).  
  4053.  
  4054.           label
  4055.                Timeout macro.  Macro to GOTO if the time in the first
  4056.                argument expires.  If no macro is specified or if the macro
  4057.                label is invalid, control will pass to the function
  4058.                following the LOOKfor.
  4059.  
  4060.           seconds
  4061.                Prompt timeout.  During a LOOKfor function unwanted prompts
  4062.                may appear like "Press any key" or "More [Y/n]", etc.  This
  4063.                argument is the time in seconds to wait at a prompt (no
  4064.                input from the modem) before sending the string in the
  4065.                fourth argument.  Usually you would send "|" or "n|".
  4066.  
  4067.                When the response string is sent the timer is restarted,
  4068.                allowing any number of prompts to be satisfied (until the
  4069.                LOOKfor itself is satisfied or times out).
  4070.  
  4071.                The timer will also be restarted if any keys are typed while
  4072.                waiting.  This allows a manual response to a prompt which
  4073.                the macro does not handle.
  4074.  
  4075.                IMPORTANT!  The prompt timeout should be long enough (or
  4076.                disabled entirely) to prevent the response from being sent
  4077.                when there is a long delay without a prompt.  This might
  4078.  
  4079.  
  4080.  
  4081.                                     -76-
  4082.  
  4083.                occur right after connection while the BBS software is
  4084.                loading or when a "door" program is loading.
  4085.  
  4086.                Failure to heed this warning will result in "n" responses to
  4087.                "First name?" and other undesirable effects.
  4088.  
  4089.                May be 0 to 999.  Default is 0 (disabled).
  4090.  
  4091.           string
  4092.                Prompt response.  String to send when the time in the third
  4093.                argument runs out.  May be up to 32 characters.  Default is
  4094.                no string.
  4095.  
  4096. Example:
  4097.  
  4098.      {setl 60,abc,4,n|}
  4099.           Set LOOKfor parameters
  4100.  
  4101.  
  4102. The SETLook function will set parameters for subsequent LOOKfor functions
  4103. and may be executed at any time to modify the parameters.
  4104.  
  4105. When macro processing terminates, the parameters will be reset to the
  4106. default values.
  4107.  
  4108. Default arguments are:
  4109.  
  4110.      LOOKfor timeout     0 (disabled)
  4111.      Timeout macro       none 
  4112.      Prompt timeout      0 (disabled)
  4113.      Prompt response     none
  4114.  
  4115. IMPORTANT!  Null arguments in the SETLook function will revert to these
  4116. defaults.
  4117.  
  4118. See also: LOOKfor, SSLOok, CALOok, GOLOok.
  4119.  
  4120.  
  4121. ===  SETVariable  ===
  4122.  
  4123.  
  4124. Default key:   none
  4125. Description:   Assign a string to a variable name.
  4126.  
  4127. General form:
  4128.  
  4129.      {SETVariable name,string}
  4130.  
  4131.  
  4132.  
  4133.                                     -77-
  4134.  
  4135.           name
  4136.                The name of the variable to which the string will be
  4137.                assigned.
  4138.  
  4139.           string
  4140.                The string may be the name of another {COMMO} variable or an
  4141.                environment variable.  In these cases further expansion is
  4142.                controlled by switches (see below).
  4143.  
  4144. Switches:
  4145.  
  4146.      E1 or E
  4147.           This switch indicates that the second argument is a DOS
  4148.           environment variable.  If it is not found in the environment, the
  4149.           {COMMO} variable will be set to NULL.
  4150.  
  4151.           Note that environment variable names are CASE SENSITIVE (they are
  4152.           usually upper case).
  4153.  
  4154.      E0
  4155.           Normal variable (default).
  4156.  
  4157.      S1 or S
  4158.           This switch will cause "double expansion" of the second argument
  4159.           (indirect variable).  First {COMMO} will substitute any variables
  4160.           indicated by "%" signs.  The resulting string (which must NOT
  4161.           begin with a "%") will then be treated as a variable name and
  4162.           expanded again.
  4163.  
  4164.           This facility may be used to create a "subscript."
  4165.  
  4166.      S0
  4167.           Single expansion (default).
  4168.  
  4169. Examples:
  4170.  
  4171.      {setv net,nodeid}
  4172.           Assign the string "nodeid" to the variable name "net".
  4173.  
  4174.      {setv nodeid,ggcs_bbs}
  4175.           Assign the string "ggcs_bbs" to the variable name "nodeid".
  4176.  
  4177.      {setv-s bbs,nodeid}
  4178.           Assuming the above examples have been executed, this will set the
  4179.           variable "bbs" to "ggcs_bbs".
  4180.  
  4181.      {setv-s board,%net}
  4182.           Assuming the above examples have been executed, this will set the
  4183.           variable "board" to "ggcs_bbs".
  4184.  
  4185.  
  4186.  
  4187.                                     -78-
  4188.  
  4189.      {setv-s xxx,yyy%index}
  4190.           Suppose the variable "index" has the value "3".  It will be
  4191.           expanded first, then "yyy3" will be expanded and its value
  4192.           assigned to "xxx".
  4193.  
  4194.      {setv-e abc,TABLE}
  4195.           Assuming a "SET TABLE=" DOS command has been executed prior to
  4196.           running {COMMO}, the variable "abc" will be set to the
  4197.           environment string.
  4198.  
  4199.      {setv abc} or {setv abc,}
  4200.           Set the variable "abc" to null (it will be deleted from variable
  4201.           space).
  4202.  
  4203.  
  4204. ===  SHELl  ===
  4205.  
  4206.  
  4207. Default key:   Alt-S
  4208. Description:   Shell to DOS.
  4209.  
  4210. Switches:
  4211.  
  4212.      S1 or S
  4213.           Swap to disk before shelling to DOS (see details under EXECute,
  4214.           "Using the Swap to Disk Switch").
  4215.  
  4216.      S0
  4217.           Do not swap to disk (default).
  4218.  
  4219. Examples:
  4220.  
  4221.      {shell}
  4222.           No arguments.
  4223.  
  4224.      {shell-s}
  4225.           Swap to disk before shelling to DOS.
  4226.  
  4227.  
  4228. ===  SIGNal  ===
  4229.  
  4230.  
  4231. Default key:   none
  4232. Description:   Set state of hardware signals.
  4233.  
  4234. Switches:
  4235.  
  4236.      D1 or D
  4237.           Set DTR high.
  4238.  
  4239.      D0
  4240.           Set DTR low.
  4241.  
  4242.  
  4243.  
  4244.                                     -79-
  4245.  
  4246.      R1 or R
  4247.           Set RTS high.
  4248.  
  4249.      R0
  4250.           Set RTS low.
  4251.  
  4252. Example:
  4253.  
  4254.      {signal-d0r1}
  4255.           Turn off DTR, turn on RTS.
  4256.  
  4257. The "D" and "R" switches are used to control the RS-232C signals DTR (Data
  4258. Terminal Ready) and RTS (Request To Send).  The default for each switch is
  4259. to leave the signal unchanged.  Use these with care due to interaction with
  4260. Hardware Flow Control, etc.
  4261.  
  4262.  
  4263. ===  SOUNd  ===
  4264.  
  4265.  
  4266. Default key:   none
  4267. Description:   Set Master Sound toggle.
  4268.  
  4269. Examples:
  4270.  
  4271.      {sound}
  4272.           Toggle Master Sound on/off.
  4273.  
  4274.      {sound y}
  4275.           Turn on Master Sound.
  4276.  
  4277.      {sound n}
  4278.           Turn off Master Sound.
  4279.  
  4280.  
  4281. ===  SPDCtrl  ===
  4282.  
  4283.  
  4284. Default key:   none
  4285. Description:   Serial port display control.
  4286.  
  4287. Examples:
  4288.  
  4289.      {spdc y}
  4290.           Serial port display is ON.
  4291.  
  4292.      {spdc n}
  4293.           Serial port display is OFF.
  4294.  
  4295. This function will suppress display of any data received from the serial
  4296. port.  It can be used when a "clean" display is desired during automated
  4297. procedures.
  4298.  
  4299.  
  4300.  
  4301.                                     -80-
  4302.  
  4303. TIPS on using SPDCtrl:
  4304.  
  4305. >    Serial port display can be suppressed only while a macro is running
  4306.      (it will be restored to ON at macro termination).
  4307.  
  4308. >    ANSI control sequences are not processed while the display is OFF
  4309.      (Terminal Emulation effectively reverts to TTY).
  4310.  
  4311. >    LOOKfor will function normally, but remember that ANSI sequences are
  4312.      not stripped.  Make a manual run using TTY emulation to see what the
  4313.      LOOKfor will see.
  4314.  
  4315. >    SCREEN Capture Mode will not capture any of the incoming data.  Use
  4316.      RAW mode or FILTER mode instead (FILTER capture will be affected by
  4317.      the Translate Table, but will still contain ANSI sequences).
  4318.  
  4319.  
  4320. ===  SPOCtrl  ===
  4321.  
  4322.  
  4323. Default key:   none
  4324. Description:   Serial port output control.
  4325.  
  4326. Examples:
  4327.  
  4328.      {spoc y}
  4329.           Serial port output is ON.
  4330.  
  4331.      {spoc n}
  4332.           Serial port output is OFF.
  4333.  
  4334. This function will inhibit any data from being sent to the serial port. 
  4335. All other program operations will be normal.  It is used for "local mode"
  4336. in host macros (no data is sent to the modem).
  4337.  
  4338. TIPS on using SPOCtrl:
  4339.  
  4340. >    Serial port output can be inhibited only while a macro is running (it
  4341.      will be restored to ON at macro termination).
  4342.  
  4343. >    Internal protocols will not operate properly if serial port output is
  4344.      turned OFF.
  4345.  
  4346.  
  4347. ===  SSLOok  ===
  4348.  
  4349.  
  4350. Default key:   none
  4351. Description:   Send a string when a string appears.
  4352.  
  4353. General form:
  4354.  
  4355.      {SSLOok name,target}
  4356.  
  4357.  
  4358.  
  4359.                                     -81-
  4360.  
  4361.  
  4362.           name
  4363.                The name of a string variable (MUST be a variable).
  4364.  
  4365.           target
  4366.                The ASCII string to look for.  The string begins following
  4367.                the "," and is terminated by the "}".
  4368.  
  4369. Switches:
  4370.  
  4371.      R or R1
  4372.           Send a carriage return after sending the variable string to the
  4373.           serial port.
  4374.  
  4375.      R0
  4376.           Do not send a carriage return (default).
  4377.  
  4378. Example:
  4379.  
  4380.      {setv ss_r,|} {setv ss_nr,n|}
  4381.      ...
  4382.      {sslo-r _pas,password:}
  4383.      {sslo ss_r,Press enter to continue}
  4384.      {sslo ss_nr,Do you want to log off?}
  4385.      {look command?} ...
  4386.  
  4387. SSLOok is used in conjunction with the LOOKfor function.  It sets up an
  4388. additional string to look for.  When the target string appears, the string
  4389. in the variable is sent to the serial port.  The LOOKfor continues to look
  4390. for all specified strings.
  4391.  
  4392. See LOOKfor for details, examples and tips on using SSLOok.
  4393.  
  4394. See also: CALOok, GOLOok, SETLook.
  4395.  
  4396.  
  4397. ===  STATusline  ===
  4398.  
  4399.  
  4400. Default key:   none
  4401. Description:   Set Status Line toggle.
  4402.  
  4403. IMPORTANT!  The Status Line is {COMMO}'s instrument panel.  You should not
  4404. turn it off until you are familiar with operating the program.
  4405.  
  4406. Examples:
  4407.  
  4408.      {statusline}
  4409.           Toggle Status Line on/off.
  4410.  
  4411.  
  4412.  
  4413.                                     -82-
  4414.  
  4415.      {status y}
  4416.           Turn on Status Line.
  4417.  
  4418.      {status n}
  4419.           Turn off Status Line.
  4420.  
  4421. When the Status Line is off (not visible), the bottom line of the display
  4422. becomes part of the Terminal Screen.
  4423.  
  4424. The STATusline function is ignored while in Chat Mode.
  4425.  
  4426.  
  4427. ===  STOP  ===
  4428.  
  4429.  
  4430. Default key:   none
  4431. Description:   Halt macro execution.
  4432.  
  4433. Examples:
  4434.  
  4435.      {stop}
  4436.           No arguments.
  4437.  
  4438.      {}
  4439.           Short form.
  4440.  
  4441. STOP always returns {COMMO} to manual operation in the Terminal Screen.  It
  4442. should be used to end login macros.
  4443.  
  4444.  
  4445. ===  STRAn  ===
  4446.  
  4447.  
  4448. Default key:   none
  4449. Description:   Maintain Send Translate Table.
  4450.  
  4451. Switches:
  4452.  
  4453.      I1 or I
  4454.           Initialize Send Translate Table to default values (consecutive 0
  4455.           to 255).
  4456.  
  4457.      I0
  4458.           Do not initialize (default).
  4459.  
  4460. Examples:
  4461.  
  4462.      {stran y}
  4463.           Turn send translation ON.
  4464.  
  4465.  
  4466.  
  4467.                                     -83-
  4468.  
  4469.      {stran-i n}
  4470.           Initialize the table and turn it OFF.
  4471.  
  4472.      {stran-i y,92,47}
  4473.           Initialize the table, turn send translation ON, change "\" to
  4474.           "/".
  4475.  
  4476.      {stran}
  4477.           Toggle send translation ON/OFF.
  4478.  
  4479.      {stran #13,65,78,#13,78,65,#13,97,110,#13,110,97}
  4480.           ROT13 translation.  This swaps the first 13 letters of the
  4481.           alphabet for the second 13.
  4482.  
  4483. Rules for STRAn arguments are the same as for the {str=} item in the Setup
  4484. File.  In addition, "n" may be used as the first argument to turn send
  4485. translation OFF at any time.
  4486.  
  4487. See "Edit Setup File" in Part I for details and more examples.
  4488.  
  4489. TIPS on using STRAn:
  4490.  
  4491. >    Some control characters are unaffected by translation when certain
  4492.      features are enabled.  Examples:  XON (17) and XOFF (19) are not
  4493.      translated when Software Flow Control is on.  When ENQ/ACK emulation
  4494.      is on, an ACK sent in response to an ENQ will not be translated.
  4495.  
  4496. >    In GETString, data echoed to the modem (and displayed locally) will be
  4497.      translated with the Send Translate Table (it may be necessary to turn
  4498.      send translation off during certain GETString functions).
  4499.  
  4500. See also RTRAn.
  4501.  
  4502.  
  4503. ===  SUBString  ===
  4504.  
  4505.  
  4506. Default key:   none
  4507. Description:   Move a substring to a variable.
  4508.  
  4509. General form:
  4510.  
  4511.      {SUBString name,start,count,string}
  4512.  
  4513.           name
  4514.                The name of the variable to which the substring will be
  4515.                assigned.
  4516.  
  4517.           start
  4518.                The starting character number (first character is "1").  If
  4519.                it is negative, {COMMO} will count in from the end of the
  4520.                string.
  4521.  
  4522.  
  4523.  
  4524.                                     -84-
  4525.  
  4526.                If it is too large and positive, the substring will be null.
  4527.  
  4528.                If it is too large and negative, the substring will start at
  4529.                the beginning of the string.
  4530.  
  4531.           count
  4532.                The number of characters to use.  If the number is too
  4533.                large, {COMMO} will use as many as possible.  If the count
  4534.                is 0, the substring will be null.
  4535.  
  4536.           string
  4537.                The string to use.
  4538.  
  4539. Examples:
  4540.  
  4541.      {subs var-sub,2,4,abcdefgh}
  4542.           Set "var-sub" to "bcde".
  4543.  
  4544.      {subs newvar,-5,20,abcdefgh}
  4545.           Set "newvar" to "defgh".
  4546.  
  4547.  
  4548. ===  SXMOdem  ===
  4549.  
  4550.  
  4551. Default key:   none
  4552. Description:   Send a file using the Xmodem protocol.
  4553.  
  4554. Switches:
  4555.  
  4556.      See SYMOdem (switches are the same).
  4557.  
  4558. Example:
  4559.  
  4560.      {sxmo-ka c:\ul\file.zip}
  4561.           Send "file.zip" using 1024 byte block size (Xmodem-1k), sound the
  4562.           alarm.
  4563.  
  4564. Only one file may be sent with each SXMOdem function.
  4565.  
  4566. See SYMOdem for tips that apply to both SXMOdem and SYMOdem.
  4567.  
  4568. See also RXMOdem, SYMOdem.
  4569.  
  4570.  
  4571. ===  SYMOdem  ===
  4572.  
  4573.  
  4574. Default key:   none
  4575. Description:   Send a file using the Ymodem Batch protocol.
  4576.  
  4577.  
  4578.  
  4579.                                     -85-
  4580.  
  4581. Switches:
  4582.  
  4583.      K1 or K
  4584.           Use 1024 byte block size.
  4585.  
  4586.      K0
  4587.           Use 128 byte block size (default).
  4588.  
  4589.      D1 or D
  4590.           Cancel transfer if carrier detect is lost (default).
  4591.  
  4592.           NOTE:  If carrier detect is off when the transfer is started,
  4593.           this switch will behave as if "D0" had been set.
  4594.  
  4595.      D0
  4596.           Ignore state of carrier detect.
  4597.  
  4598.      A1 or A
  4599.           Sound the alarm at end of transfer.
  4600.  
  4601.      A0
  4602.           Do not sound the alarm (default).
  4603.  
  4604.      W
  4605.           Wait for a keypress at end of transfer.
  4606.  
  4607.      Wn
  4608.           Wait for "n" seconds, "n" may range from 0 to 999.  Press a key
  4609.           to cancel the wait.
  4610.  
  4611.           Note:  Default (no "W" switch) is no wait.
  4612.  
  4613. Examples:
  4614.  
  4615.      {symo-ka %uldir\*.zip}
  4616.           Send all .ZIP files in the upload directory using 1024 byte block
  4617.           size, sound the alarm.
  4618.  
  4619.      {symo-k c:\subdir\*.*,@c:\ul\file.lst,info.txt,a:*.qw?}
  4620.           Send all files listed using 1024 byte block size.
  4621.  
  4622. Any combination of file specifications may be listed in the SYMOdem
  4623. function (separated with commas).  These may include wildcard specifiers
  4624. (*,?), the indirect file specifier (@) and any single files.
  4625.  
  4626. If a filespec is preceded with the "@" sign, it will be assumed to be an
  4627. "indirect file."  This means that it is a text file containing a list of
  4628. filespecs.  Filespecs should be listed one per line and each line should
  4629. end with a cr/lf.  Each filespec may contain wildcards.  For example:
  4630.  
  4631.      c:\subdir\*.*
  4632.      info.txt
  4633.      a:*.qw?
  4634.  
  4635.  
  4636.  
  4637.                                     -86-
  4638.  
  4639.  
  4640. TIPS on using SYMOdem and SXMOdem:
  4641.  
  4642. >    CRC vs. Csum mode is established by the receiver.
  4643.  
  4644. >    Use of "G" method is established by the receiver.
  4645.  
  4646. >    Some conditions that will cancel a transfer:
  4647.        1) 10 consecutive errors.
  4648.        2) Any error when "G" method is used.
  4649.        3) The receiver has transmitted CAN (^X) characters.
  4650.  
  4651. >    The Exit Code (test with IFER) will be set at the end of the transfer. 
  4652.      The Exit Code will also be stored in the variable "_err".  0 means
  4653.      success, 1 means failure.
  4654.  
  4655. >    If the Usage Log is enabled, an entry will be made after each file is
  4656.      transferred (or if a transfer is cancelled).
  4657.  
  4658. See also RYMOdem, SXMOdem.
  4659.  
  4660.  
  4661. ===  TOGGles  ===
  4662.  
  4663.  
  4664. Default key:   Alt-T
  4665. Description:   Set various toggle parameters.
  4666.  
  4667. Example:
  4668.  
  4669.      {toggles}
  4670.           Open Set Toggles window.
  4671.  
  4672.  
  4673. ===  UNMArk  ===
  4674.  
  4675.  
  4676. Default key:   none
  4677. Description:   Unmark Dialing Directory entries.
  4678.  
  4679. Switches:
  4680.  
  4681.      L1 or L
  4682.           Unmark last-dialed entry only.
  4683.  
  4684.      L0
  4685.           Unmark all or listed entries (default).
  4686.  
  4687. Examples:
  4688.  
  4689.      {unmark joes-bbs,file-city}
  4690.           Unmark listed entries.
  4691.  
  4692.  
  4693.  
  4694.                                     -87-
  4695.  
  4696.      {unmark}
  4697.           Unmark all entries.
  4698.  
  4699.      {unmark-L}
  4700.           Unmark last-dialed entry.
  4701.  
  4702. NOTE:  When the "L" switch is present, any Dialing Strings listed will be
  4703. ignored.
  4704.  
  4705. Dialing Strings may be separated by spaces or commas.
  4706.  
  4707. {COMMO} will search the Dialing Directory for each string and unmark the
  4708. first entry where a match is found.  Case is ignored.
  4709.  
  4710. The strings may consist of any part of a Dialing Directory entry line
  4711. (including strings contained within curly braces), but must NOT contain any
  4712. spaces, commas or curly braces.
  4713.  
  4714. See also: DIAL, MARK.
  4715.  
  4716.  
  4717. ===  VIDEo  ===
  4718.  
  4719.  
  4720. Default key:   none
  4721. Description:   Change to an alternate hardware video mode.
  4722.  
  4723. Switches:
  4724.  
  4725.      M1 or M
  4726.           Change to the alternate display mode.
  4727.  
  4728.      M0
  4729.           Change back to the normal display mode.
  4730.  
  4731. Examples:
  4732.  
  4733.      {video-m1}
  4734.           Change to the alternate mode.
  4735.  
  4736.      {video-m0}
  4737.           Change back to the normal mode.
  4738.  
  4739. The "alternate" mode is defined by Setup File item {avm=}.  The "normal"
  4740. mode is the mode in effect when you start {COMMO}.
  4741.  
  4742.  
  4743. ===  VTCUr  ===
  4744.  
  4745.  
  4746. Default key:   none
  4747. Description:   Define a VT102 cursor (arrow) key.
  4748.  
  4749.  
  4750.  
  4751.                                     -88-
  4752.  
  4753. Example:
  4754.  
  4755.      {vtcur ^[[A|^[OA}
  4756.           Define up-arrow key strings.
  4757.  
  4758. The first string is sent when cursor mode is active; the second string is
  4759. sent when application mode is active (these modes are controlled by the
  4760. host).
  4761.  
  4762. The two strings must be separated by a "|".  Use "^m" for carriage return
  4763. if necessary.
  4764.  
  4765. See also VTPAd.
  4766.  
  4767.  
  4768. ===  VTPAd  ===
  4769.  
  4770.  
  4771. Default key:   none
  4772. Description:   Define a VT102 keypad key.
  4773.  
  4774. Example:
  4775.  
  4776.      {vtpad 5|^[Ou}
  4777.           Define keypad "5" key strings.
  4778.  
  4779. The first string is sent when numeric mode is active; the second string is
  4780. sent when application mode is active (these modes are controlled by the
  4781. host).
  4782.  
  4783. The two strings must be separated by a "|".  Use "^m" for carriage return
  4784. if necessary.
  4785.  
  4786. See also VTCUr.
  4787.  
  4788.  
  4789. ===  WCLOse  ===
  4790.  
  4791.  
  4792. Default key:   none
  4793. Description:   Close the write file.
  4794.  
  4795. Example:
  4796.  
  4797.      {wclose}
  4798.           No arguments.
  4799.  
  4800. NOTE:  The write file will be closed automatically when the macro
  4801. terminates (STOP, EXIT, etc.).
  4802.  
  4803. See also WOPEn, WRITE.
  4804.  
  4805.  
  4806.  
  4807.                                     -89-
  4808.  
  4809. ===  WINDow  ===
  4810.  
  4811.  
  4812. Default key:   none
  4813. Description:   Preserve window display.
  4814.  
  4815. Switches:
  4816.  
  4817.      K1 or K
  4818.           Do not allow the Terminal Screen to be restored when exiting from
  4819.           a window.
  4820.  
  4821.      K0
  4822.           Allow the Terminal Screen to be restored when exiting from a
  4823.           window (default).
  4824.  
  4825. Examples:
  4826.  
  4827.      {window-k}
  4828.           Don't restore the Terminal Screen.
  4829.  
  4830.      {wind-k0}
  4831.           Restore the Terminal Screen.
  4832.  
  4833. This function will prevent the Terminal Screen from being restored after a
  4834. window function exits.  It is useful for making smooth, flicker-free
  4835. transitions between windows or for placing one pop-up window on top of
  4836. another.
  4837.  
  4838. The condition will remain active until either the "k0" switch is used or
  4839. the macro terminates.
  4840.  
  4841.  
  4842. ===  WOPEn  ===
  4843.  
  4844.  
  4845. Default key:   none
  4846. Description:   Open a file for writing.
  4847.  
  4848. Switches:
  4849.  
  4850.      A1 or A
  4851.           Open the file in "append" mode.  New lines written to the file
  4852.           will be added at the end.  If the file doesn't exist, it will be
  4853.           created.
  4854.  
  4855.      A0
  4856.           Open the file in "create" mode.  If the file exists, it will be
  4857.           erased (default).
  4858.  
  4859.  
  4860.  
  4861.                                     -90-
  4862.  
  4863. Examples:
  4864.  
  4865.      {wopen c:\bbs\file.txt}
  4866.           Open the file in create mode.
  4867.  
  4868.      {wopen-a c:\data\word.fil}
  4869.           Open the file in append mode.
  4870.  
  4871. TIP on using WOPEn:
  4872.  
  4873. >    Only one file may be opened for writing (and one for reading).
  4874.  
  4875. See also WRITe, WCLOse.
  4876.  
  4877.  
  4878. ===  WRITe  ===
  4879.  
  4880.  
  4881. Default key:   none
  4882. Description:   Write a string to the write file.
  4883.  
  4884. Examples:
  4885.  
  4886.      {write %nextline}
  4887.           Write the contents of the variable "nextline" to the write file.
  4888.  
  4889.      {write}
  4890.           Write a carriage return/linefeed only (blank line) to the file.
  4891.  
  4892.      {write %num%> }
  4893.           Write the contents of "num" followed by a ">" and a space.
  4894.  
  4895. TIPS on using WRITe:
  4896.  
  4897. >    A file must be open for writing or a macro error will result.
  4898.  
  4899. >    The string will be written as one line, terminated by a carriage
  4900.      return/linefeed.
  4901.  
  4902. >    Control character conversion is NOT performed on the write string.
  4903.  
  4904. >    A macro error will result if the disk is full.
  4905.  
  4906. See also WOPEn, WCLOse
  4907.  
  4908.  
  4909.  
  4910.                                     -91-
  4911.  
  4912. For APPENDICES see Part I, COMMO.DOC.
  4913.  
  4914.