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