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