home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d8xx / d831 / term.lha / Term / term-3.1-Int.lha / Documentation / termRexx.doc < prev    next >
Text File  |  1993-02-15  |  74KB  |  3,254 lines
  1. Changes
  2. *********
  3.  
  4.    Previous `term' releases would use a different ARexx host interface
  5. implementation. In order to conform to Commodore-endorsed user
  6. interface style guidelines it was redesigned from scratch for version
  7. 3.0. The design and implementation of the ARexx host interface was
  8. suggested by the `Amiga User Interface Style Guide' and strongly
  9. influenced by Martin Taillefer's `TurboText' ARexx host interface.
  10.  
  11.    Not a simple command has `survived' the revision, the new
  12. implementation is no longer compatible with its predecessors, so
  13. existing ARexx programs will have to be adapted or even entirely
  14. rewritten.
  15.  
  16.    `term' no longer distinguishes explicitely between asynchronous and
  17. synchronous commands (i.e. commands which force the main program to
  18. wait and commands which need not bother the main program as the ARexx
  19. handler process is able to execute them). As of this writing it is safe
  20. to assume that almost any command will be processed by the main
  21. program, exceptions are noted.
  22.  
  23.  
  24. term and ARexx
  25. ***************
  26.  
  27.    This document describes the ARexx(tm) (1) commands supported by
  28. `term'. This is not intended to be an introduction to the language
  29. itself. Rexx was developed by Mike F.  Cowlishaw on an IBM/SP system and
  30. ported to the Amiga by William S.  Hawes.
  31.  
  32.    ARexx (or Amiga Rexx) is a commercial product which is included with
  33. the AmigaDOS 2.0 Enhancer Package.  If you need a good introduction and
  34. description of the language, try to get a hold of the book `The REXX
  35. Language A Practical Approach to Programming' by M.F. Cowlishaw,
  36. available from Prentice-Hall International, Inc.
  37.  
  38.    The section entitled Command execution gives a brief introduction
  39. how to write and run ARexx commands. For more information refer to the
  40. Release 2 Users Manual `Using the System Software'.
  41.  
  42.    By default `term' opens an ARexx host by the name of `TERM'
  43. (accessable via `address term').  If more than a single `term' process
  44. is running on your machine, the name of the host will be adapted to the
  45. number of the program (i.e.  the first programm will use `TERM', the
  46. second one will use `TERM.1', the third one `TERM.2', etc.). The
  47. default name can be overridden by invoking the program with certain
  48. parameters (see main program documentation). The name of the host is
  49. displayed in the status window (see main program documentation).
  50.  
  51.    ---------- Footnotes ----------
  52.  
  53.    (1)  ARexx is a registered trademark of Wishful Thinking Development
  54. Corp.
  55.  
  56.  
  57. Command execution
  58. ==================
  59.  
  60.    In order to invoke any command supported by `term' one usually has
  61. to address the host explicitely:
  62.  
  63.      /* Address the `term' host. */
  64.      
  65.      ADDRESS term
  66.      
  67.      /* Invoke the `beepscreen' commmand. */
  68.      
  69.      BEEPSCREEN
  70.  
  71.    However, if an ARexx program is invoked directly by the `term' main
  72. program, the program will by default address the main program it was
  73. invoked by.
  74.  
  75.    Most commands will return results or error codes on failure. To
  76. enable result codes, one has to use the `options results' command. The
  77. results returned by commands will be placed in the `result' variable:
  78.  
  79.      /* We assume that the program will address the host it was invoked from.
  80.       *
  81.       * Enable command results.
  82.       */
  83.      
  84.      OPTIONS RESULTS
  85.      
  86.      /* Request a string from the user. */
  87.      
  88.      REQUESTSTRING DEFAULT 'anything' PROMPT 'Enter anything'
  89.      
  90.      /* Did the user cancel the requester? */
  91.      
  92.      IF rc ~= 0 THEN
  93.         SAY 'user cancelled requester'
  94.      ELSE
  95.         SAY result /* Output the result . */
  96.  
  97.    Failure codes will always be returned in the `rc' variable (see
  98. previous example).
  99.  
  100.    In case of failure (variable `rc' >= 10), `term' will leave an error
  101. code in the `term.lasterror' variable:
  102.  
  103.      /* Enable command results. */
  104.      
  105.      OPTIONS RESULTS
  106.      
  107.      /* Produce an error by not supplying any arguments. */
  108.      
  109.      STOPBITS
  110.      
  111.      /* Display the error code. */
  112.      
  113.      SAY term.lasterror
  114.  
  115.    Rexx tries to tokenize any command parameters, this process involves
  116. promoting them to all upper case letters and checking for illegal
  117. characters. This feature inhibits the use of the `:' (colon) and blank
  118. space characters in parameter names unless the corresponding arguments
  119. are enclosed in quotes:
  120.  
  121.      /* The following command will fail to send the file `ram:foobar' as the colon
  122.       * in the path name will cause an error:
  123.       */
  124.      
  125.      SENDFILE ram:foobar
  126.      
  127.      /* Here is how to do it correctly: */
  128.      
  129.      SENDFILE 'ram:foobar'
  130.      
  131.      /* The following command will fail to send the file `foo bar' as the
  132.       * file name is treated as two single files:
  133.       */
  134.      
  135.      SENDFILE foo bar
  136.      
  137.      /* Here is how to do it correctly: */
  138.      
  139.      SENDFILE 'foo bar'
  140.      
  141.      /* The following command will not transmit the string `Hello sailor'
  142.       * across the serial line as the single words will be capitalized,
  143.       * they will be transmitted as `HELLO SAILOR':
  144.       */
  145.      
  146.      SEND Hello sailor
  147.      
  148.      /* Here is how to do it correctly: */
  149.      
  150.      SEND 'Hello sailor'
  151.  
  152.  
  153. Stopping a command
  154. *******************
  155.  
  156.    Programs and commands sometimes fail to do what the user is expecting
  157. them to do which makes it necessary to bring program/command execution
  158. to a stop. A common ARexx program to call no external functions or host
  159. commands one can be halted in the following ways:
  160.  
  161.   1. Executing the `HI' command (located in the `SYS:rexxc' drawer)
  162.      from Shell. This command will attempt stop *all* currently running
  163.      ARexx programs.
  164.  
  165.   2. If the ARexx program to be executed runs in an environment to sport
  166.      an output window, activate the window and press the `Control + C'
  167.      keys. A break signal will be sent to the ARexx program, causing it
  168.      to stop as soon as possible.
  169.  
  170.  
  171.    With host environments such as `term' it may not always be possible
  172. to abort a command using the simple measures described above. As for
  173. `term' any command to wait (such as the READ, DELAY or WAIT commands)
  174. can be aborted by sending `term' itself a break signal in the following
  175. fashion:
  176.  
  177.   1. If the `term' program is still attached to a Shell output window,
  178.      activate the window and press the `Control + D' keys.
  179.  
  180.   2. If the `term' program was invoked from a Shell but is no longer
  181.      attached to it, enter `status command term' from Shell, remember
  182.      the number printed, then enter `break <number>' with `<number>'
  183.      being the number returned by the `status' command.
  184.  
  185.   3. Press the hotkey combination configured in the program hotkey
  186.      settings (see main program documentation). The default is `Right
  187.      Shift + Left Shift + Escape'. This will cause a break signal to be
  188.      sent to the `term' program.
  189.  
  190.  
  191.  
  192. Commands
  193. *********
  194.  
  195.    The commands supported by `term' are listed in a table of the
  196. following form:
  197.  
  198. `Format:'
  199.      The command name with its possible calling parameters. In this
  200.      table parameters are enclosed in brackets and braces, separated by
  201.      commas and vertical bars; *do not type these special characters
  202.      along with the parameters!*:
  203.  
  204.     `< > (Angle brackets)'
  205.           Angle brackets enclose parameters whose contents *must not*
  206.           be omitted in order to make the command work properly.
  207.  
  208.     `[ ] (Square brackets)'
  209.           Square brackets enclose optional parameters.
  210.  
  211.     `{ } (Curly braces)'
  212.           Curly braces enclose items which can be repeated a number of
  213.           times, such as file name lists.
  214.  
  215.     `| (Vertical bar)'
  216.           Vertical bars separate alternative, mutually exclusive
  217.           options.
  218.  
  219.     `, (Comma)'
  220.           Commas separate multiple applicable options.
  221.  
  222. `Template:'
  223.      The command template, similar to the command templates employed by
  224.      AmigaDOS Shell commands. Possible templates are:
  225.  
  226.     `<Parameter>/A'
  227.           The parameter must always be included in order to get
  228.           accepted.
  229.  
  230.     `<Option>/K'
  231.           The option's keyword must be given.
  232.  
  233.     `<Option>/S'
  234.           This option works as a switch. If this option keyword is
  235.           included the switch is on, else it is off.
  236.  
  237.     `<Option>/N'
  238.           A numeric parameter is expected.
  239.  
  240.     `<Option>/M'
  241.           Multiple parameters are accepted.
  242.  
  243.     `<Text>/F'
  244.           The text must be the final parameter on the command line.
  245.  
  246.     `, (Comma)'
  247.           Indicates that the command takes no parameters.
  248.  
  249. `Purpose:'
  250.      Briefly describes what the command will do.
  251.  
  252. `Specifications:'
  253.      Describes the command and its possible uses in more detail.
  254.  
  255. `Result:'
  256.      The type of the command result code if any.
  257.  
  258. `Warning:'
  259.      If the command can return with a warning and when.
  260.  
  261. `Example:'
  262.      An example code fragment to illustrate how to use the command.
  263.      Commands and keywords are given in upper case, the names of
  264.      variables and command arguments are given in lower case. Where a
  265.      single command line would not fit into a single line on the
  266.      screen, an ellipsis ('...') is meant to join the broken line.
  267.  
  268.    Table of commands in alphabetical order:
  269.  
  270.    Table of commands in functional groups:
  271.  
  272.    Commands dealing with text buffer and capturing
  273.  
  274.    Commands dealing with serial I/O
  275.  
  276.    Commands dealing with lists
  277.  
  278.    Commands dealing with the clipboard
  279.  
  280.    Commands dealing with file transfers
  281.  
  282.    Commands dealing with terminal I/O
  283.  
  284.    Commands dealing with windows and requesters
  285.  
  286.    Commands dealing with program attributes
  287.  
  288.    Commands dealing with program execution
  289.  
  290.    Commands dealing with file I/O
  291.  
  292.    Miscellaneous commands
  293.  
  294.  
  295. The ACTIVATE command
  296. =====================
  297.  
  298. `Format:'
  299.      ACTIVATE
  300.  
  301. `Template:'
  302.      ,
  303.  
  304. `Purpose:'
  305.      De-iconifies the program, brings the main window to the front and
  306.      makes it active.
  307.  
  308. `Specifications:'
  309.      The program can be put to sleep using the DEACTIVATE command, to
  310.      bring it back to proper operation, use the `ACTIVATE' command. If
  311.      this command is invoked while the program is not asleep, it will
  312.      cause the main window to be brought to the front and activated.
  313.  
  314. `Result:'
  315.      -
  316.  
  317. `Warning:'
  318.      -
  319.  
  320. `Example:'
  321.           /* This is how the main programm can be (re-)activated: */
  322.           
  323.           ACTIVATE
  324.  
  325.  
  326. The ADDITEM command
  327. ====================
  328.  
  329. `Format:'
  330.      ADDITEM [To] <Upload|Download|Dial|Wait> [Before|After] [Phone
  331.      <Entry number, name or wildcard pattern>] [Name <Name>]
  332.  
  333. `Template:'
  334.      TO/A,BEFORE/S,AFTER/S,PHONE/K/F,NAME/K/F
  335.  
  336. `Purpose:'
  337.      Inserts an item (a name, a phone number, text, etc.) before or
  338.      after the currently selected list item.
  339.  
  340. `Specifications:'
  341.      `term' maintains a number of lists, these are:
  342.  
  343.     `Upload list'
  344.           The list of files to be uploaded.
  345.  
  346.     `Download list'
  347.           The list of files the program has downloaded.
  348.  
  349.     `Dial list'
  350.           The list of phone numbers or phone book entries to be dialed.
  351.  
  352.     `Wait list'
  353.           The list of texts the WAIT command is to wait for.
  354.  
  355.      New items can be added to the list with the `ADDITEM' command. The
  356.      upload list expects the names of files the SENDFILE command is to
  357.      transfer. It makes little sense to add files names to the download
  358.      list as the `term' main program maintains it and adds the names of
  359.      files received to it, but it is still possible. The wait list
  360.      expects text lines the WAIT command will look for in the terminal
  361.      input stream.
  362.  
  363.      The dial list accepts a number of different parameters:
  364.  
  365.     `Phonebook entry numbers'
  366.           These are passed using the `Phone' parameter which should be
  367.           a numeric value as it is used as an index to pick the
  368.           corresponding entry from the phone book.
  369.  
  370.     `Phonebook entry names'
  371.           These are also passed using the `Phone' parameter which can
  372.           be a proper name or a wildcard pattern.
  373.  
  374.     `Phone numbers'
  375.           These are passed using the `Name' parameter.
  376.  
  377.      List item can be inserted before or after the currently selected
  378.      list item (see SELECTITEM command). The default is to insert them
  379.      after the currently selected list item.
  380.  
  381. `Result:'
  382.      -
  383.  
  384. `Warning:'
  385.      -
  386.  
  387. `Example:'
  388.           /* Enable result codes. */
  389.           
  390.           OPTIONS RESULTS
  391.           
  392.           /* Get a file name from the user. */
  393.           
  394.           REQUESTFILE TITLE 'Select a file to upload'
  395.           
  396.           /* Add the file name to the upload list. */
  397.           
  398.           IF rc = 0 THEN ADDITEM TO upload NAME result
  399.           
  400.           /* Add phonebook entry #2 to the dial list. */
  401.           
  402.           ADDITEM TO dial PHONE 2
  403.           
  404.           /* Add all phonebook entries whose names start
  405.            * with an `a' to the dial list.
  406.            */
  407.           
  408.           ADDITEM TO dial PHONE a#?
  409.           
  410.           /* Add a plain phone number to the dial list. */
  411.           
  412.           ADDITEM TO dial NAME 424242
  413.  
  414.  
  415. The BAUD command
  416. =================
  417.  
  418. `Format:'
  419.      BAUD [Rate] <Baud rate in bits per second>
  420.  
  421. `Template:'
  422.      RATE/A/N
  423.  
  424. `Purpose:'
  425.      Sets the serial line transfer speed
  426.  
  427. `Specifications:'
  428.      Sets the serial line transfers speed to some defined value. The
  429.      rate parameter passed in will be matched against all valid baud
  430.      rates supported by `term', the closest value will be used.
  431.  
  432. `Result:'
  433.      -
  434.  
  435. `Warning:'
  436.      -
  437.  
  438. `Example:'
  439.           /* Change the serial transfer speed to 2400 bps. */
  440.           
  441.           BAUD 2400
  442.  
  443.  
  444. The BEEPSCREEN command
  445. =======================
  446.  
  447. `Format:'
  448.      BEEPSCREEN
  449.  
  450. `Template:'
  451.      ,
  452.  
  453. `Purpose:'
  454.      `Beeps' the terminal screen.
  455.  
  456. `Specifications:'
  457.      Invokes a bell signal, as configured in the program settings.
  458.  
  459. `Result:'
  460.      -
  461.  
  462. `Warning:'
  463.      -
  464.  
  465. `Example:'
  466.           /* Invoke a bell signal. */
  467.           
  468.           BEEPSCREEN
  469.  
  470.  
  471. The CALLMENU command
  472. =====================
  473.  
  474. `Format:'
  475.      CALLMENU [Title] <Title text or wildcard pattern>
  476.  
  477. `Template:'
  478.      TITLE/A/F
  479.  
  480. `Purpose:'
  481.      Invokes the function associated with a menu item.
  482.  
  483. `Specifications:'
  484.      Calls a pull-down menu function just as if the user had selected it
  485.      using the mouse. The `Title' parameter can be any valid menu item
  486.      name or a wildcard pattern. In the latter case, only the first
  487.      menu item to match the pattern will be called.
  488.  
  489. `Result:'
  490.      -
  491.  
  492. `Warning:'
  493.      If no matching menu item was to be found.
  494.  
  495. `Example:'
  496.           /* Invoke the `About...' menu item. */
  497.           
  498.           CALLMENU abou#?
  499.  
  500.  
  501. The CAPTURE command
  502. ====================
  503.  
  504. `Format:'
  505.      CAPTURE [To] <Printer|File> [Name <File name>]
  506.  
  507. `Template:'
  508.      TO/A,NAME/K
  509.  
  510. `Purpose:'
  511.      Starts a file or printer capture.
  512.  
  513. `Specifications:'
  514.      If a capture is not already in progress will open a capture file
  515.      or start capturing incoming terminal text to the printer. If the
  516.      `File' argument is given and the `Name' parameter is omitted, will
  517.      prompt for the name of a file to capture to.
  518.  
  519.      If to capture to a given file, will append the captured text. If
  520.      user is to select a file to capture to, will ask whether to append
  521.      the text to the file or to overwrite it.
  522.  
  523. `Result:'
  524.      -
  525.  
  526. `Warning:'
  527.      In case user was to select a file and aborted the selection.
  528.  
  529. `Example:'
  530.           /* Open a named capture file. */
  531.           
  532.           CAPTURE TO file NAME 'ram:capture file'
  533.           
  534.           /* Close the capture file, ask the user for a file name. */
  535.           
  536.           CLOSE FILE
  537.           CAPTURE TO file
  538.           
  539.           /* Capture to the printer. */
  540.           
  541.           CAPTURE TO printer
  542.  
  543.  
  544. The CLEAR command
  545. ==================
  546.  
  547. `Format:'
  548.      CLEAR [From] <Upload|Download|Dial|Wait|Buffer> [Force]
  549.  
  550. `Template:'
  551.      FROM/A,FORCE/S
  552.  
  553. `Purpose:'
  554.      Clears the contents of a global list or the text buffer.
  555.  
  556. `Specifications:'
  557.      This command serves to clear the contents of the lists to be
  558.      maintained using the ADDITEM, REMITEM, SELECTITEM, etc. commands
  559.      and to purge the contents of the text buffer. In the latter case
  560.      the program will prompt for confirmation in case the buffer still
  561.      holds any lines. This confirmation can be suppressed by using the
  562.      `Force' parameter.
  563.  
  564. `Result:'
  565.      -
  566.  
  567. `Warning:'
  568.      In case the user did not confirm to clear the buffer.
  569.  
  570. `Example:'
  571.           /* Clear the wait list. */
  572.           
  573.           CLEAR FROM wait
  574.           
  575.           /* Clear the buffer, ask for a confirmation. */
  576.           
  577.           CLEAR FROM buffer
  578.           
  579.           /* If no confirmation was given, clear it by force. */
  580.           
  581.           IF rc ~= 0 THEN CLEAR FROM buffer FORCE
  582.  
  583.  
  584. The CLEARSCREEN command
  585. ========================
  586.  
  587. `Format:'
  588.      CLEARSCREEN
  589.  
  590. `Template:'
  591.      ,
  592.  
  593. `Purpose:'
  594.      Clears the terminal screen
  595.  
  596. `Specifications:'
  597.      Clears the terminal screen and positions the cursor in the top
  598.      left corner.
  599.  
  600. `Result:'
  601.      -
  602.  
  603. `Warning:'
  604.      -
  605.  
  606. `Example:'
  607.           /* Clear the terminal screen. */
  608.           
  609.           CLEARSCREEN
  610.  
  611.  
  612. The CLOSE command
  613. ==================
  614.  
  615. `Format:'
  616.      CLOSE [From] <Printer|File|All>
  617.  
  618. `Template:'
  619.      FROM/A
  620.  
  621. `Purpose:'
  622.      Terminates file and/or printer capture.
  623.  
  624. `Specifications:'
  625.      Terminates a capture process as started with the CAPTURE command.
  626.      Will terminate printer capture, file capture or both.
  627.  
  628. `Result:'
  629.      -
  630.  
  631. `Warning:'
  632.      -
  633.  
  634. `Example:'
  635.           /* Terminate both file and printer capture. */
  636.           
  637.           CLOSE ALL
  638.  
  639.  
  640. The CLOSEDEVICE command
  641. ========================
  642.  
  643. `Format:'
  644.      CLOSEDEVICE
  645.  
  646. `Template:'
  647.      ,
  648.  
  649. `Purpose:'
  650.      Release the current serial device driver
  651.  
  652. `Specifications:'
  653.      Frees the serial device driver for use with other applications.
  654.      The driver can be reopened (or a different device driver can be
  655.      selected) using the OPENDEVICE command.
  656.  
  657. `Result:'
  658.      -
  659.  
  660. `Warning:'
  661.      -
  662.  
  663. `Example:'
  664.           /* Release the serial device driver, all serial I/O
  665.            * will be halted.
  666.            */
  667.           
  668.           CLOSEDEVICE
  669.  
  670.  
  671. The CLOSEREQUESTER command
  672. ===========================
  673.  
  674. `Format:'
  675.      CLOSEREQUESTER
  676.  
  677. `Template:'
  678.      ,
  679.  
  680. `Purpose:'
  681.      Closes the currently open requester window
  682.  
  683. `Specifications:'
  684.      Will close any currently open requester window, such as the
  685.      dialing window, the phone book, the serial settings window, etc.
  686.      Will not close windows such as the file transfer window or the
  687.      text/numeric input windows.
  688.  
  689. `Result:'
  690.      -
  691.  
  692. `Warning:'
  693.      -
  694.  
  695. `Example:'
  696.           /* Close the currently open requester window,
  697.            * whatever it may be.
  698.            */
  699.           
  700.           CLOSEREQUESTER
  701.  
  702.  
  703. The DEACTIVATE command
  704. =======================
  705.  
  706. `Format:'
  707.      DEACTIVATE
  708.  
  709. `Template:'
  710.      ,
  711.  
  712. `Purpose:'
  713.      Iconifies the program.
  714.  
  715. `Specifications:'
  716.      Puts the application to sleep. Requires Workbench to be running,
  717.      so an AppIcon can be put on the Workbench backdrop. This command
  718.      will be ignored if the application has already been put to sleep.
  719.      To wake the application up, use the ACTIVATE command.
  720.  
  721. `Result:'
  722.      -
  723.  
  724. `Warning:'
  725.      -
  726.  
  727. `Example:'
  728.           /* Iconify the program. */
  729.           
  730.           DEACTIVATE
  731.  
  732.  
  733. The DELAY command
  734. ==================
  735.  
  736. `Format:'
  737.      DELAY [MIC|MICROSECONDS <Number>] [[SEC|SECONDS] <Number>]
  738.      [MIN|MINUTES <Number>]
  739.  
  740. `Template:'
  741.      MIC=MICROSECONDS/K/N,SEC=SECONDS/N,MIN=MINUTES/K/N
  742.  
  743. `Purpose:'
  744.      Delays program execution for a couple of microseconds, seconds and
  745.      minutes.
  746.  
  747. `Specifications:'
  748.      Will cause both the program to make the call and the application
  749.      to wait for a certain period of time.
  750.  
  751. `Result:'
  752.      -
  753.  
  754. `Warning:'
  755.      If command was aborted before the timeout had elapsed.
  756.  
  757. `Example:'
  758.           /* Wait for five seconds. */
  759.           
  760.           DELAY 5
  761.           
  762.           /* Wait for one second and seven microseconds. */
  763.           
  764.           DELAY MIC 7 SEC 5
  765.  
  766.  
  767. The DIAL command
  768. =================
  769.  
  770. `Format:'
  771.      DIAL [[Num] <Phone number>]
  772.  
  773. `Template:'
  774.      NUM/F
  775.  
  776. `Purpose:'
  777.      Dials the provided phone number. If no phone number was given,
  778.      will dial the numbers and phone book entries stored in the dial
  779.      list.
  780.  
  781. `Specifications:'
  782.      This command will build a dialing list from the available sources
  783.      and pass it to the dialing function which is to schedule the
  784.      dialing process and perform any login-actions. Available sources
  785.      are the `Num' parameter which will cause the command to dial only
  786.      this single number or the dial list whose contents will be used if
  787.      the `Num' parameter is omitted.
  788.  
  789.      This command will return as soon as the dialing process has been
  790.      initiated.
  791.  
  792. `Result:'
  793.      -
  794.  
  795. `Warning:'
  796.      -
  797.  
  798. `Example:'
  799.           /* Dial a single phone number. */
  800.           
  801.           DIAL 424242
  802.           
  803.           /* Wait a bit and abort the dialing process. */
  804.           
  805.           DELAY 5
  806.           CLOSEREQUESTER
  807.           
  808.           /* Clear the dialing list, then add all the phonebook entries
  809.            * to the list.
  810.            */
  811.           
  812.           CLEAR FROM dial
  813.           ADDITEM TO dial PHONE #?
  814.           
  815.           /* Dial the dial list. */
  816.           
  817.           DIAL
  818.  
  819.  
  820. The DUPLEX command
  821. ===================
  822.  
  823. `Format:'
  824.      DUPLEX [Full|Half|Echo]
  825.  
  826. `Template:'
  827.      FULL/S,HALF=ECHO/S
  828.  
  829. `Purpose:'
  830.      Sets the serial line duplex mode.
  831.  
  832. `Specifications:'
  833.      Sets the serial line duplex mode, this can be either full duplex
  834.      or half duplex (local echo).
  835.  
  836. `Result:'
  837.      -
  838.  
  839. `Warning:'
  840.      -
  841.  
  842. `Example:'
  843.           /* Enable local terminal echo. */
  844.           
  845.           DUPLEX ECHO
  846.  
  847.  
  848. The EXECTOOL command
  849. =====================
  850.  
  851. `Format:'
  852.      EXECTOOL [Console] [Async] [Port] [Command] <File name>
  853.  
  854. `Template:'
  855.      CONSOLE/S,ASYNC/S,PORT/S,COMMAND/A/F
  856.  
  857. `Purpose:'
  858.      Executes a program.
  859.  
  860. `Specifications:'
  861.      Will load and execute an AmigaDOS program. The `Console' parameter
  862.      will cause an output file or window to be opened, the `Async'
  863.      parameter will cause the command to return as soon as the
  864.      execution process has been launched. The `Port' parameter will
  865.      cause the current ARexx host port name to be passed to the tool on
  866.      the command line.
  867.  
  868. `Result:'
  869.      -
  870.  
  871. `Warning:'
  872.      -
  873.  
  874. `Example:'
  875.           /* Launch the `Dir' command. */
  876.           
  877.           EXECTOOL CONSOLE COMMAND 'dir c:'
  878.  
  879.  
  880. The FAULT command
  881. ==================
  882.  
  883. `Format:'
  884.      FAULT [Code] <Error code>
  885.  
  886. `Template:'
  887.      CODE/A/N
  888.  
  889. `Purpose:'
  890.      Returns the descriptive text associated with an error code as
  891.      returned by `term'.
  892.  
  893. `Specifications:'
  894.      `term' will return error codes in the `term.lasterror' variable.
  895.      In order to get the descriptive text associated with an error
  896.      code, use this command. All internal Rexx and AmigaDOS errors
  897.      codes are supported as well as the error codes special to `term'.
  898.  
  899. `Result:'
  900.      The error description associated with the error code.
  901.  
  902. `Warning:'
  903.      -
  904.  
  905. `Example:'
  906.           /* Enable command results. */
  907.           
  908.           OPTIONS RESULTS
  909.           
  910.           /* Get the text associated with error #1001. */
  911.           
  912.           FAULT 1001
  913.           
  914.           /* Output the result. */
  915.           
  916.           SAY result
  917.  
  918.  
  919. The GETATTR command
  920. ====================
  921.  
  922. `Format:'
  923.      GETATTR [Object] <Name> [Field] <Name> [Stem <Name>] [Var <Name>]
  924.  
  925. `Template:'
  926.      OBJECT/A,FIELD,STEM/K,VAR/K
  927.  
  928. `Purpose:'
  929.      Obtains information on an application attribute.
  930.  
  931. `Specifications:'
  932.      Obtains information on an object, if possible will store it in the
  933.      `result' variable. If a stem or simple variable name is given
  934.      using the `Stem' or `Var' parameters will store the information in
  935.      this variable. If no `Field' parameter is given, will store the
  936.      entire object contents which requires that the `Stem' parameter is
  937.      given. For a list of valid attributes see the section entitled
  938.      Attributes.
  939.  
  940. `Result:'
  941.      Returns information either in `result' variable or in the supplied
  942.      `Stem' or `Var' variable.
  943.  
  944. `Warning:'
  945.      -
  946.  
  947. `Example:'
  948.           /* Enable command results. */
  949.           
  950.           OPTIONS RESULTS
  951.           
  952.           /* Query the name of the ARexx host we are communicating with. */
  953.           
  954.           GETATTR OBJECT term FIELD arexx
  955.           
  956.           /* Output the result. */
  957.           
  958.           SAY result
  959.           
  960.           /* Same as above, but using a different syntax. */
  961.           
  962.           GETATTR term.arexx
  963.           SAY result
  964.           
  965.           /* Store the entire contents of the phone book in a
  966.            * stem variable.
  967.            */
  968.           
  969.           GETATTR term.phonebook STEM book
  970.           
  971.           /* Output the phonebook contents. */
  972.           
  973.           SAY 'phone book contains' book.count 'entries'
  974.           
  975.           DO i = 0 TO book.count - 1
  976.              SAY 'entry #' i
  977.           
  978.              SAY 'name    :' book.i.name
  979.              SAY 'number  :' book.i.number
  980.              SAY 'comment :' book.i.comment
  981.              SAY 'username:' book.i.username
  982.           END i
  983.  
  984.  
  985. The GETCLIP command
  986. ====================
  987.  
  988. `Format:'
  989.      GETCLIP [Unit <Number>]
  990.  
  991. `Template:'
  992.      UNIT/K/N
  993.  
  994. `Purpose:'
  995.      Retrieves the contents of the clipboard.
  996.  
  997. `Specifications:'
  998.      Obtains the contents of the clipboard and returns it in the
  999.      `result' variable. Will optionally read from the given clipboard
  1000.      unit, but uses the unit number selected in the application
  1001.      settings by default. *Note that a string returned can be up to
  1002.      65,536 characters long!*
  1003.  
  1004. `Result:'
  1005.      Contents of the clipboard if it contains any text.
  1006.  
  1007. `Warning:'
  1008.      If clipboard does not contain any text.
  1009.  
  1010. `Example:'
  1011.           /* Enable command results. */
  1012.           
  1013.           OPTIONS RESULTS
  1014.           
  1015.           /* Get the primary clipboard contents. */
  1016.           
  1017.           GETCLIP
  1018.           
  1019.           /* Output the contents. */
  1020.           
  1021.           IF rc ~= 0 THEN
  1022.              SAY 'clipboard does not contain any text'
  1023.           ELSE
  1024.              SAY result
  1025.  
  1026.  
  1027. The HANGUP command
  1028. ===================
  1029.  
  1030. `Format:'
  1031.      HANGUP
  1032.  
  1033. `Template:'
  1034.      ,
  1035.  
  1036. `Purpose:'
  1037.      Hang up the serial line.
  1038.  
  1039. `Specifications:'
  1040.      Hangs up the serial line, executes logoff and cleanup operations.
  1041.  
  1042. `Result:'
  1043.      -
  1044.  
  1045. `Warning:'
  1046.      -
  1047.  
  1048. `Example:'
  1049.           /* Hang up the line, whether the program is online or not. */
  1050.           
  1051.           HANGUP
  1052.  
  1053.  
  1054. The HELP command
  1055. =================
  1056.  
  1057. `Format:'
  1058.      HELP [[Command] <Name>] [Prompt]
  1059.  
  1060. `Template:'
  1061.      COMMAND,PROMPT/S
  1062.  
  1063. `Purpose:'
  1064.      Returns the template of a command or invokes the online help
  1065.      system.
  1066.  
  1067. `Specifications:'
  1068.      This command will either return the template associated with a
  1069.      `term' ARexx command specified using the `Command' parameter or
  1070.      invoke the AmigaGuide(tm) help system.
  1071.  
  1072. `Result:'
  1073.      Command template if requested.
  1074.  
  1075. `Warning:'
  1076.      -
  1077.  
  1078. `Example:'
  1079.           /* Enable command results. */
  1080.           
  1081.           OPTIONS RESULTS
  1082.           
  1083.           /* Query the template associated with the `selectitem' command. */
  1084.           
  1085.           HELP selectitem
  1086.           
  1087.           /* Output the result. */
  1088.           
  1089.           SAY result
  1090.           
  1091.           /* Invoke the online help. */
  1092.           
  1093.           HELP PROMPT
  1094.  
  1095.  
  1096. The OPEN command
  1097. =================
  1098.  
  1099. `Format:'
  1100.      OPEN [Name <File name>] [TO] <Translations|Functionkeys|Cursorkeys|
  1101.      Fastmacros|Hotkeys|Speech|Buffer|Configuration|Phone>
  1102.  
  1103. `Template:'
  1104.      NAME/K,TO/A
  1105.  
  1106. `Purpose:'
  1107.      Reads data from a disk file.
  1108.  
  1109. `Specifications:'
  1110.      This command reads the contents of a disk file and stores the
  1111.      information either in the configuration, the phone book or the
  1112.      text buffer. If text is read into the text buffer it will be
  1113.      appended to the existing text. If no file name is given will
  1114.      prompt the user to select a file.
  1115.  
  1116. `Result:'
  1117.      -
  1118.  
  1119. `Warning:'
  1120.      If user was requested to select a file and cancelled the selection.
  1121.  
  1122. `Example:'
  1123.           /* Load the configuration from a file. */
  1124.           
  1125.           OPEN NAME 'ram:term.prefs' TO configuration
  1126.           
  1127.           /* Add text to the text buffer. */
  1128.           
  1129.           OPEN TO buffer
  1130.  
  1131.  
  1132. The OPENDEVICE command
  1133. =======================
  1134.  
  1135. `Format:'
  1136.      OPENDEVICE [Name <Device name>] [Unit <Number>]
  1137.  
  1138. `Template:'
  1139.      NAME/K,UNIT/K/N
  1140.  
  1141. `Purpose:'
  1142.      (Re-)Opens the serial device driver.
  1143.  
  1144. `Specifications:'
  1145.      (Re-)Opens the previously released (see CLOSEDEVICE command) device
  1146.      driver or a different device driver/unit if the corresponding
  1147.      `Device' and `Unit' parameters are given.
  1148.  
  1149. `Result:'
  1150.      -
  1151.  
  1152. `Warning:'
  1153.      -
  1154.  
  1155. `Example:'
  1156.           /* Release the serial device driver. */
  1157.           
  1158.           CLOSEDEVICE
  1159.           
  1160.           /* Open a different device driver. */
  1161.           
  1162.           OPENDEVICE DEVICE 'duart.device' UNIT 5
  1163.  
  1164.  
  1165. The OPENREQUESTER command
  1166. ==========================
  1167.  
  1168. `Format:'
  1169.      OPENREQUESTER [REQUESTER]
  1170.      <Serial|Modem|Screen|Terminal|Emulation|Clipboard|
  1171.     
  1172.     
  1173.     
  1174.     
  1175.     
  1176.     
  1177.      Capture|Commands|Misc|Path|Transfer|Translations|Functionkeys|Cursorkeys|
  1178.      Fastmacros|Hotkeys|Speech|Phone>
  1179.  
  1180. `Template:'
  1181.      REQUESTER/A
  1182.  
  1183. `Purpose:'
  1184.      Opens a requester window.
  1185.  
  1186. `Specifications:'
  1187.      Opens a requester window. Only a single window can be open at a
  1188.      time. The window opened can be closed using the CLOSEREQUESTER
  1189.      command.
  1190.  
  1191. `Result:'
  1192.      -
  1193.  
  1194. `Warning:'
  1195.      -
  1196.  
  1197. `Example:'
  1198.           /* Open the phonebook window. */
  1199.           
  1200.           OPENREQUESTER phone
  1201.  
  1202.  
  1203. The PARITY command
  1204. ===================
  1205.  
  1206. `Format:'
  1207.      PARITY [Even|Odd|None|Mark|Space]
  1208.  
  1209. `Template:'
  1210.      EVEN/S,ODD/S,NONE/S,MARK/S,SPACE/S
  1211.  
  1212. `Purpose:'
  1213.      Sets the serial line parity mode.
  1214.  
  1215. `Specifications:'
  1216.      Sets the serial line parity mode.
  1217.  
  1218. `Result:'
  1219.      -
  1220.  
  1221. `Warning:'
  1222.      -
  1223.  
  1224. `Example:'
  1225.           /* Set the parity mode. */
  1226.           
  1227.           PARITY NONE
  1228.  
  1229.  
  1230. The PASTECLIP command
  1231. ======================
  1232.  
  1233. `Format:'
  1234.      PASTECLIP [Unit <Number>]
  1235.  
  1236. `Template:'
  1237.      UNIT/K/N
  1238.  
  1239. `Purpose:'
  1240.      Feed the contents of the clipboard into the input stream.
  1241.  
  1242. `Specifications:'
  1243.      Feeds the contents of the clipboard into the input stream. Obtains
  1244.      the data either from the given clipboard unit or from the default
  1245.      unit configured in the program settings.
  1246.  
  1247. `Result:'
  1248.      -
  1249.  
  1250. `Warning:'
  1251.      If clipboard does not contain any text.
  1252.  
  1253. `Example:'
  1254.           /* Paste the contents of clipboard #2. */
  1255.           
  1256.           PASTECLIP UNIT 2
  1257.  
  1258.  
  1259. The PRINT command
  1260. ==================
  1261.  
  1262. `Format:'
  1263.      PRINT [From]
  1264.      <Screentext|Clipboard|Buffer|Dial|Wait|Upload|Download> [TO <File
  1265.      name>] [Serial|Modem|Screen|Terminal|User|Comment| Size|Date|Attr]
  1266.  
  1267. `Template:'
  1268.      FROM/A,TO/K,SERIAL/S,MODEM/S,SCREEN/S,TERMINAL/S,USER/S,
  1269.      COMMENT/S,SIZE/S,DATE/S,ATTR/S
  1270.  
  1271. `Purpose:'
  1272.      Prints the contents of the screen, the clipboard, the textbuffer
  1273.      or one of the lists.
  1274.  
  1275. `Specifications:'
  1276.      Outputs the contents of the screen, the clipboard, the textbuffer
  1277.      or one of the lists (see ADDITEM command) to a file or the
  1278.      printer. If the `To' parameter is omitted, will output the data to
  1279.      the printer. The parameters `Serial' through `Attr' control what
  1280.      will be printed:
  1281.  
  1282.     `Screentext, Clipboard, Buffer, Wait list'
  1283.           Options have no effect on the output.
  1284.  
  1285.     `Dial list'
  1286.           Responds to the `Serial', `Modem', `Screen', `Terminal',
  1287.           `User' and `Comment' parameters. The printout will contain
  1288.           information on the corresponding settings.
  1289.  
  1290.     `Upload list, Download list'
  1291.           Responds to the `Comment', `Size', `Date' and `Attr'
  1292.           parameters. The printout will contain information on the
  1293.           corresponding file attributes. *Note: if any of these
  1294.           parameters are given, only the base file names will be
  1295.           printed along with the corresponding information.*
  1296.  
  1297. `Result:'
  1298.      -
  1299.  
  1300. `Warning:'
  1301.      If user cancelled print operation.
  1302.  
  1303. `Example:'
  1304.           /* Clear the dialing list, then add the entire phone book to it. */
  1305.           
  1306.           CLEAR dial
  1307.           additem to dial phone #?
  1308.           
  1309.           /* Send the contents of the dial list to a disk file. */
  1310.           
  1311.           PRINT FROM dial TO 'ram:phonebook' SERIAL MODEM SCREEN...
  1312.           ...TERMINAL USER COMMENT
  1313.  
  1314.  
  1315. The PROTOCOL command
  1316. =====================
  1317.  
  1318. `Format:'
  1319.      PROTOCOL [None|RTSCTS|RTSCTSDTR]
  1320.  
  1321. `Template:'
  1322.      NONE/S,RTSCTS/S,RTSCTSDTR/S
  1323.  
  1324. `Purpose:'
  1325.      Sets the serial line handshaking protocol.
  1326.  
  1327. `Specifications:'
  1328.      Sets the serial line handshaking protocol. See the main program
  1329.      documentation for details.
  1330.  
  1331. `Result:'
  1332.      -
  1333.  
  1334. `Warning:'
  1335.      -
  1336.  
  1337. `Example:'
  1338.           /* Set the handshaking protocol. */
  1339.           
  1340.           PROTOCOL NONE
  1341.  
  1342.  
  1343. The PUTCLIP command
  1344. ====================
  1345.  
  1346. `Format:'
  1347.      PUTCLIP [Unit <Unit>] [TEXT] <Text to store>
  1348.  
  1349. `Template:'
  1350.      UNIT/K/N,TEXT/A/F
  1351.  
  1352. `Purpose:'
  1353.      Stores text in the clipboard.
  1354.  
  1355. `Specifications:'
  1356.      Stores the provided text in the clipboard. Will store it in the
  1357.      given clipboard unit if the `Unit' parameter is given. Will use
  1358.      the unit number configured in the program settings otherwise.
  1359.  
  1360. `Result:'
  1361.      -
  1362.  
  1363. `Warning:'
  1364.      -
  1365.  
  1366. `Example:'
  1367.           /* Store a short string in the clipboard. Note: can
  1368.            * only be up to 65,536 characters long.
  1369.            */
  1370.           
  1371.           PUTCLIP 'hello sailor!'
  1372.  
  1373.  
  1374. The QUIT command
  1375. =================
  1376.  
  1377. `Format:'
  1378.      QUIT [Force]
  1379.  
  1380. `Template:'
  1381.      FORCE/S
  1382.  
  1383. `Purpose:'
  1384.      Terminates the application.
  1385.  
  1386. `Specifications:'
  1387.      Terminates program execution, will ask for a confirmation to leave
  1388.      unless the `Force' parameter is used.
  1389.  
  1390. `Result:'
  1391.      -
  1392.  
  1393. `Warning:'
  1394.      If user did not confirm termination.
  1395.  
  1396. `Example:'
  1397.           /* Try to terminate the program, ask for confirmation. */
  1398.           
  1399.           QUIT
  1400.           
  1401.           /* If no confirmation was given terminate by force. */
  1402.           
  1403.           IF rc ~= 0 THEN QUIT FORCE
  1404.  
  1405.  
  1406. The READ command
  1407. =================
  1408.  
  1409. `Format:'
  1410.      READ [Num <Number of bytes>] [CR] [Noecho] [[Prompt] <Prompt text>]
  1411.  
  1412. `Template:'
  1413.      NUM/K/N,CR/S,NOECHO/S,PROMPT/K/F
  1414.  
  1415. `Purpose:'
  1416.      Reads a number of bytes or a string from the serial line.
  1417.  
  1418. `Specifications:'
  1419.      If `Num' parameter is given will read a number of bytes from the
  1420.      serial line (*note: only a maximum of 65,536 bytes can be read*).
  1421.      The command will return when the read request has been satisfied,
  1422.      the timeout (settable using the TIMEOUT command) has elapsed or
  1423.      the command was aborted.
  1424.  
  1425.      If the `CR' parameter is given will handle simple line editing
  1426.      functions (`Backspace', `Control-X') and return a string as soon
  1427.      as the `Carriage return' key is pressed, the timeout (settable
  1428.      using the TIMEOUT command) has elapsed or the command is aborted.
  1429.  
  1430.      The `Noecho' parameter will cause `term' not to echo typed
  1431.      characters back to the remote. *Note that in order to see any
  1432.      input on the local side the remote is to echo the characters typed
  1433.      back.*
  1434.  
  1435.      If present, the `Prompt' text will be sent across the serial line,
  1436.      much the same as if it had been sent using the SEND command.
  1437.  
  1438. `Result:'
  1439.      The string read.
  1440.  
  1441. `Warning:'
  1442.      If command was cancelled, no input was made or, if the `CR'
  1443.      parameter is used, the timeout elapsed.
  1444.  
  1445. `Example:'
  1446.           /* Enable command results. */
  1447.           
  1448.           OPTIONS RESULTS
  1449.           
  1450.           /* Set the read timeout to five seconds. */
  1451.           
  1452.           TIMEOUT 5
  1453.           
  1454.           /* Read seven bytes. */
  1455.           
  1456.           READ NUM 7
  1457.           
  1458.           /* Output the result. */
  1459.           
  1460.           IF rc ~= 0 THEN
  1461.              SAY 'no data was read'
  1462.           ELSE
  1463.              SAY result
  1464.           
  1465.           /* Turn the timeout off. */
  1466.           
  1467.           TIMEOUT OFF
  1468.           
  1469.           /* Prompt for input. */
  1470.           
  1471.           READ CR PROMPT 'Enter a line of text:'
  1472.           
  1473.           /* Output the result. */
  1474.           
  1475.           IF rc ~= 0 THEN
  1476.              SAY 'no input was made'
  1477.           ELSE
  1478.              SAY result
  1479.  
  1480.  
  1481. The RECEIVEFILE command
  1482. ========================
  1483.  
  1484. `Format:'
  1485.      RECEIVEFILE [Mode <ASCII|Text|Binary>] [Name <File name>]
  1486.  
  1487. `Template:'
  1488.      MODE/K,NAME/K
  1489.  
  1490. `Purpose:'
  1491.      Receive one or more files using the XPR protocol.
  1492.  
  1493. `Specifications:'
  1494.      Receives one or more files using the currently configured XPR
  1495.      protocol. The `Mode' parameter determines the file transfer mode
  1496.      (either plain ASCII, Text mode or binary file mode), if omitted
  1497.      the file(s) will be received in binary mode. Some file transfer
  1498.      protocols do not require any file names to be given as they have
  1499.      their own means to determine the names of the files to be
  1500.      received. However, a file name parameter can be given. If omitted
  1501.      the file transfer protocol will prompt the user for a file name if
  1502.      necessary.
  1503.  
  1504.      The names of all files received are placed on the download list
  1505.      for processing. The list will be cleared before the transfer is
  1506.      started.
  1507.  
  1508. `Result:'
  1509.      -
  1510.  
  1511. `Warning:'
  1512.      If user cancelled file selection.
  1513.  
  1514. `Example:'
  1515.           /* Start to receive a file in text mode. */
  1516.           
  1517.           RECEIVEFILE MODE text
  1518.  
  1519.  
  1520. The REDIAL command
  1521. ===================
  1522.  
  1523. `Format:'
  1524.      REDIAL
  1525.  
  1526. `Template:'
  1527.      ,
  1528.  
  1529. `Purpose:'
  1530.      Redials the numbers remaining in the currently configured dialing
  1531.      list.
  1532.  
  1533. `Specifications:'
  1534.      Redials the numbers which still remain in the dialing list built
  1535.      either by the phone book or by the DIAL command. *Note that this
  1536.      command will return as soon as the dialing process is initiated.*
  1537.  
  1538. `Result:'
  1539.      -
  1540.  
  1541. `Warning:'
  1542.      If dialing list is empty.
  1543.  
  1544. `Example:'
  1545.           /* Redial the list. */
  1546.           
  1547.           REDIAL
  1548.           
  1549.           /* Successful? */
  1550.           
  1551.           IF rc ~= 0 THEN SAY 'dialing list is empty'
  1552.  
  1553.  
  1554. The REMITEM command
  1555. ====================
  1556.  
  1557. `Format:'
  1558.      REMITEM [From] <Upload|Download|Dial|Wait> [Name <Name or
  1559.      wildcard>]
  1560.  
  1561. `Template:'
  1562.      FROM/A,NAME/K/F
  1563.  
  1564. `Purpose:'
  1565.      Removes one or more items from a list.
  1566.  
  1567. `Specifications:'
  1568.      Removes one or more items from a list. If no `Name' parameter is
  1569.      given will remove the currently selected list item (selectable
  1570.      using the SELECTITEM command). The `Name' parameter can be a
  1571.      proper name or a wildcard pattern.
  1572.  
  1573.      *Note: Cannot remove named items from the dial list.*
  1574.  
  1575. `Result:'
  1576.      -
  1577.  
  1578. `Warning:'
  1579.      If no list item would match the name pattern.
  1580.  
  1581. `Example:'
  1582.           /* Remove the currently selected item from the wait list. */
  1583.           
  1584.           REMITEM FROM wait
  1585.           
  1586.           /* Remove all items from the wait list which end with `z'. */
  1587.           
  1588.           REMITEM FROM wait NAME '#?z'
  1589.  
  1590.  
  1591. The REQUESTFILE command
  1592. ========================
  1593.  
  1594. `Format:'
  1595.      REQUESTFILE [Title <Title text>] [Path <Path name>] [File <File
  1596.      name>] [Pattern <Wildcard pattern>] [Multi] [Stem|Name <Variable
  1597.      name>]
  1598.  
  1599. `Template:'
  1600.      TITLE/K,PATH/K,FILE/K,PATTERN/K,MULTI/S,STEM=NAME/K
  1601.  
  1602. `Purpose:'
  1603.      Requests one or more file names from the user.
  1604.  
  1605. `Specifications:'
  1606.      Requests one or more file names from the user. Will present a file
  1607.      requester with given title text and preset path, file name and
  1608.      pattern values. If only a single file name is to be requested will
  1609.      place the result in the `result' variable. The `Multi' parameter
  1610.      allows multiple files to be selected, the number of files selected
  1611.      and the file names will be placed in the variable specified using
  1612.      the `Stem' parameter.
  1613.  
  1614. `Result:'
  1615.      The name of the file selected will be placed in the `result'
  1616.      variable. If multiple file were selected, will place the following
  1617.      information in the supplied stem variable:
  1618.  
  1619.     `<Variable name>.COUNT'
  1620.           The number of files selected.
  1621.  
  1622.     `<Variable name>.0 through <Variable name>.n-1'
  1623.           The file names selected.
  1624.  
  1625. `Warning:'
  1626.      If user cancelled selection.
  1627.  
  1628. `Example:'
  1629.           /* Enable command results. */
  1630.           
  1631.           OPTIONS RESULTS
  1632.           
  1633.           /* Request a single file name from the user. */
  1634.           
  1635.           REQUESTFILE TITLE 'select a file'
  1636.           
  1637.           /* Output the result. */
  1638.           
  1639.           IF rc ~= 0 THEN
  1640.              SAY 'no file was selected'
  1641.           ELSE
  1642.              SAY result
  1643.           
  1644.           /* Request several files. */
  1645.           
  1646.           REQUESTFILE TITLE 'select several files' MULTI STEM names
  1647.           
  1648.           /* Output the result. */
  1649.           
  1650.           IF rc ~= 0 THEN
  1651.              SAY 'no files were selected'
  1652.           ELSE DO
  1653.              SAY 'files selected:' names.count
  1654.           
  1655.              DO i = 0 TO names.count - 1
  1656.                 SAY names.i
  1657.              END
  1658.           END
  1659.  
  1660.  
  1661. The REQUESTNOTIFY command
  1662. ==========================
  1663.  
  1664. `Format:'
  1665.      REQUESTNOTIFY [Title <Title text>] [Prompt] <Prompt text>
  1666.  
  1667. `Template:'
  1668.      TITLE/K,PROMPT/A/F
  1669.  
  1670. `Purpose:'
  1671.      Notify the user with a message.
  1672.  
  1673. `Specifications:'
  1674.      Opens a requester to notify the user, the prompt text can include
  1675.      line feed characters (`'0A'X'), the user will be able to answer
  1676.      the requester by clicking on a `Continue' button.
  1677.  
  1678. `Result:'
  1679.      -
  1680.  
  1681. `Warning:'
  1682.      -
  1683.  
  1684. `Example:'
  1685.           /* Notify the user. */
  1686.           
  1687.           REQUESTNOTIFY TITLE 'Important information' ...
  1688.           ...PROMPT 'This message is important'
  1689.  
  1690.  
  1691. The REQUESTNUMBER command
  1692. ==========================
  1693.  
  1694. `Format:'
  1695.      REQUESTNUMBER [Default <Default number>] [Prompt <Prompt text>]
  1696.  
  1697. `Template:'
  1698.      DEFAULT/K/N,PROMPT/K/F
  1699.  
  1700. `Purpose:'
  1701.      Requests a numeric value from the user
  1702.  
  1703. `Specifications:'
  1704.      Requests a numeric value from the user, will display the provided
  1705.      prompt text or a default text and present the provided default
  1706.      number, so user can simply hit return to accept the defaults.
  1707.  
  1708. `Result:'
  1709.      The number the has entered.
  1710.  
  1711. `Warning:'
  1712.      If user cancelled requester.
  1713.  
  1714. `Example:'
  1715.           /* Enable command results. */
  1716.           
  1717.           OPTIONS RESULTS
  1718.           
  1719.           /* Requester a single number. */
  1720.           
  1721.           REQUESTNUMBER DEFAULT 42 PROMPT 'Enter the answer'
  1722.           
  1723.           /* Output the result. */
  1724.           
  1725.           IF rc ~= 0 THEN
  1726.              SAY 'no number was entered'
  1727.           ELSE
  1728.              SAY result
  1729.  
  1730.  
  1731. The REQUESTRESPONSE command
  1732. ============================
  1733.  
  1734. `Format:'
  1735.      REQUESTRESPONSE [Title <Title text>] [Options <Options string>]
  1736.      [Prompt] <Prompt text>
  1737.  
  1738. `Template:'
  1739.      TITLE/K,OPTIONS/K,PROMPT/A/F
  1740.  
  1741. `Purpose:'
  1742.      Request a response from user.
  1743.  
  1744. `Specifications:'
  1745.      Requests a response from the user, uses provided title and prompt
  1746.      text and a number of options. If no options are specified will use
  1747.      `Yes|No' as the defaults.
  1748.  
  1749. `Result:'
  1750.      For `Options' passed as `Yes|Perhaps|No' will return 1 for `Yes',
  1751.      2 for `Perhaps' and return a warning for `No'.
  1752.  
  1753. `Warning:'
  1754.      If user selected negative choice.
  1755.  
  1756. `Example:'
  1757.           /* Enable command results. */
  1758.           
  1759.           OPTIONS RESULTS
  1760.           
  1761.           /* Request a response. */
  1762.           
  1763.           REQUESTRESPONSE PROMPT 'Are you indecisive?' ...
  1764.           ...OPTIONS 'Yes|Don't know|No'
  1765.           
  1766.           /* Look at the response. */
  1767.           
  1768.           IF rc ~= 0 THEN
  1769.              SAY 'Not indecisive'
  1770.           ELSE DO
  1771.              IF result = 0 THEN
  1772.                 SAY 'Indecisive'
  1773.              ELSE
  1774.                 SAY 'Probably indecisive'
  1775.           END
  1776.  
  1777.  
  1778. The REQUESTSTRING command
  1779. ==========================
  1780.  
  1781. `Format:'
  1782.      REQUESTSTRING [Secret] [Default <String>] [Prompt <Text>]
  1783.  
  1784. `Template:'
  1785.      SECRET/S,DEFAULT/K,PROMPT/K/F
  1786.  
  1787. `Purpose:'
  1788.      Requests a string from the user.
  1789.  
  1790. `Specifications:'
  1791.      Requests a string from the user, will display the provided prompt
  1792.      text or a default text and present the provided default string, so
  1793.      user can simply hit return to accept the defaults.
  1794.  
  1795.      If the `Secret' parameter is provided, will not display the
  1796.      characters typed.
  1797.  
  1798. `Result:'
  1799.      The text the user entered.
  1800.  
  1801. `Warning:'
  1802.      If user cancelled the requester.
  1803.  
  1804. `Example:'
  1805.           /* Enable command results. */
  1806.           
  1807.           OPTIONS RESULTS
  1808.           
  1809.           /* Request a secret string. */
  1810.           
  1811.           REQUESTSTRING SECRET DEFAULT 'hello sailor!' ...
  1812.           ...PROMPT 'Enter secret message'
  1813.           
  1814.           /* Output the result. */
  1815.           
  1816.           IF rc ~= 0 THEN
  1817.              SAY 'no text was entered'
  1818.           ELSE
  1819.              SAY result
  1820.  
  1821.  
  1822. The RESETSCREEN command
  1823. ========================
  1824.  
  1825. `Format:'
  1826.      RESETSCREEN
  1827.  
  1828. `Template:'
  1829.      ,
  1830.  
  1831. `Purpose:'
  1832.      Resets the terminal screen to defaults.
  1833.  
  1834. `Specifications:'
  1835.      Resets the terminal screen to defaults, this includes clearing the
  1836.      screen, moving the cursor to the home position and resetting text,
  1837.      text rendering styles and colours.
  1838.  
  1839. `Result:'
  1840.      -
  1841.  
  1842. `Warning:'
  1843.      -
  1844.  
  1845. `Example:'
  1846.           /* Reset the terminal screen. */
  1847.           
  1848.           RESETSCREEN
  1849.  
  1850.  
  1851. The RESETSTYLES command
  1852. ========================
  1853.  
  1854. `Format:'
  1855.      RESETSTYLES
  1856.  
  1857. `Template:'
  1858.      ,
  1859.  
  1860. `Purpose:'
  1861.      Resets the text rendering styles to defaults.
  1862.  
  1863. `Specifications:'
  1864.      Resets the text rendering styles to defaults, turning off inverse
  1865.      video, boldface, italics, etc. modes.
  1866.  
  1867. `Result:'
  1868.      -
  1869.  
  1870. `Warning:'
  1871.      -
  1872.  
  1873. `Example:'
  1874.           /* Reset the text rendering styles. */
  1875.           
  1876.           RESETSTYLES
  1877.  
  1878.  
  1879. The RESETTEXT command
  1880. ======================
  1881.  
  1882. `Format:'
  1883.      RESETTEXT
  1884.  
  1885. `Template:'
  1886.      ,
  1887.  
  1888. `Purpose:'
  1889.      Reset the terminal text to defaults.
  1890.  
  1891. `Specifications:'
  1892.      Reset the terminal text to defaults, this includes switching back
  1893.      from graphics text or G1 mode.
  1894.  
  1895. `Result:'
  1896.      -
  1897.  
  1898. `Warning:'
  1899.      -
  1900.  
  1901. `Example:'
  1902.           /* Reset the terminal text. */
  1903.           
  1904.           RESETTEXT
  1905.  
  1906.  
  1907. The RX command
  1908. ===============
  1909.  
  1910. `Format:'
  1911.      RX [Console] [Async] [Command] <Command name>
  1912.  
  1913. `Template:'
  1914.      CONSOLE/S,ASYNC/S,COMMAND/A/F
  1915.  
  1916. `Purpose:'
  1917.      Invokes an ARexx macro file.
  1918.  
  1919. `Specifications:'
  1920.      Invokes an ARexx macro file, if `Console' argument specified opens
  1921.      a console output window, else uses `NIL:', if `Async' argument
  1922.      specified executes the macro asynchronously.
  1923.  
  1924. `Result:'
  1925.      -
  1926.  
  1927. `Warning:'
  1928.      -
  1929.  
  1930. `Example:'
  1931.           /* Launch the `term' command shell. */
  1932.           
  1933.           RX CONSOLE ASYNC 'term:cmdshell.term'
  1934.  
  1935.  
  1936. The SAVE command
  1937. =================
  1938.  
  1939. `Format:'
  1940.      SAVE [From] <Translations|Functionkeys|
  1941.      Cursorkeys|Fastmacros|Hotkeys|Speech| Buffer|Configuration|Phone|
  1942.      Screentext|Screenimage>
  1943.  
  1944. `Template:'
  1945.      FROM/A
  1946.  
  1947. `Purpose:'
  1948.      Saves data to a disk file.
  1949.  
  1950. `Specifications:'
  1951.      Saves data to a disk file, will prompt for a file name to save to.
  1952.      See SAVEAS command for more information.
  1953.  
  1954. `Result:'
  1955.      -
  1956.  
  1957. `Warning:'
  1958.      If user cancels save operation.
  1959.  
  1960. `Example:'
  1961.           /* Save the terminal screen contents to an
  1962.            * IFF-ILBM file.
  1963.            */
  1964.           
  1965.           SAVE FROM screenimage
  1966.  
  1967.  
  1968. The SAVEAS command
  1969. ===================
  1970.  
  1971. `Format:'
  1972.      SAVEAS [Name <File name>] [From]
  1973.      <Translations|Functionkeys|Cursorkeys|
  1974.      Fastmacros|Hotkeys|Speech|Buffer| Configuration|Phone|Screentext|
  1975.      Screenimage>
  1976.  
  1977. `Template:'
  1978.      NAME/K,FROM/A
  1979.  
  1980. `Purpose:'
  1981.      Saves data to a disk file.
  1982.  
  1983. `Specifications:'
  1984.      Saves data to a disk file, will prompt for a filename to save to
  1985.      if none is provided. Will save either parts of the program
  1986.      configuration or the phone book contents (`Phonebook' parameter),
  1987.      the contents of the terminal screen as plain ASCII text
  1988.      (`Screentext' parameter) or the contents of the terminal screen as
  1989.      an IFF-ILBM-file (`Screenimage' parameter).
  1990.  
  1991. `Result:'
  1992.      -
  1993.  
  1994. `Warning:'
  1995.      If user cancels save operation.
  1996.  
  1997. `Example:'
  1998.           /* Save the program configuration to a file. */
  1999.           
  2000.           SAVEAS NAME 'ram:term.prefs' FROM configuration
  2001.  
  2002.  
  2003. The SELECTITEM command
  2004. =======================
  2005.  
  2006. `Format:'
  2007.      SELECTITEM [Name <Name>] [From] <Upload|Download|Dial|Wait>
  2008.      [Next|Prev|Previous|Top|Bottom]
  2009.  
  2010. `Template:'
  2011.      NAME/K,FROM/A,NEXT/S,PREV=PREVIOUS/S,TOP/S,BOTTOM/S
  2012.  
  2013. `Purpose:'
  2014.      Select an item from a list.
  2015.  
  2016. `Specifications:'
  2017.      Selects an item from a list, returns the item name in the `result'
  2018.      variable. The `Top' parameter will select the first list item,
  2019.      `Bottom' the last item. The `Previous' parameter will select the
  2020.      previous list item, `Next' the next successive item. Instead of
  2021.      using a positioning parameter, it is also possible to use a
  2022.      wildcard pattern or name with the `Name' parameter. The first list
  2023.      item to match the name will be selected.
  2024.  
  2025.      *Note: cannot be used with the dial list.*
  2026.  
  2027. `Result:'
  2028.      Returns the list item in the `result' variable.
  2029.  
  2030. `Warning:'
  2031.      If end of list reached.
  2032.  
  2033. `Example:'
  2034.           /* Enable command results. */
  2035.           
  2036.           OPTIONS RESULTS
  2037.           
  2038.           /* Output the contents of the download list. */
  2039.           
  2040.           SELECTITEM FROM download TOP
  2041.           
  2042.           DO WHILE rc = 0
  2043.              SAY result
  2044.              SELECTITEM FROM download NEXT
  2045.           END
  2046.  
  2047.  
  2048. The SEND command
  2049. =================
  2050.  
  2051. `Format:'
  2052.      SEND [Noecho] [Byte <ASCII code>] [Text] <Text>
  2053.  
  2054. `Template:'
  2055.      NOECHO/S,BYTE/K/N,TEXT/A/F
  2056.  
  2057. `Purpose:'
  2058.      Sends the provided text to the serial line, executes embedded
  2059.      command sequences.
  2060.  
  2061. `Specifications:'
  2062.      Sends the provided text to the serial line, executes embedded
  2063.      command sequences (see main program documentation). To send a
  2064.      single byte, use the `Byte' parameter. The `Noecho' parameter will
  2065.      suppress terminal output.
  2066.  
  2067. `Result:'
  2068.      -
  2069.  
  2070. `Warning:'
  2071.      -
  2072.  
  2073. `Example:'
  2074.           /* Send some text to the serial line. */
  2075.           
  2076.           SEND 'This is some text.\r\n'
  2077.           
  2078.           /* Send a single byte (a null) to the serial line. */
  2079.           
  2080.           SEND BYTE 0
  2081.           
  2082.           /* Execute an embedded command (send a break signal). */
  2083.           
  2084.           SEND '\x'
  2085.  
  2086.  
  2087. The SENDBREAK command
  2088. ======================
  2089.  
  2090. `Format:'
  2091.      SENDBREAK
  2092.  
  2093. `Template:'
  2094.      ,
  2095.  
  2096. `Purpose:'
  2097.      Send a break signal across the serial line.
  2098.  
  2099. `Specifications:'
  2100.      Send a break signal across the serial line.
  2101.  
  2102. `Result:'
  2103.      -
  2104.  
  2105. `Warning:'
  2106.      -
  2107.  
  2108. `Example:'
  2109.           /* Send a break signal. */
  2110.           
  2111.           SENDBREAK
  2112.  
  2113.  
  2114. The SENDFILE command
  2115. =====================
  2116.  
  2117. `Format:'
  2118.      SENDFILE [Mode <ASCII|Text|Binary>] [Names] {File names}
  2119.  
  2120. `Template:'
  2121.      MODE/K,NAMES/M
  2122.  
  2123. `Purpose:'
  2124.      Transfers files using the currently selected file transfer
  2125.      protocol.
  2126.  
  2127. `Specifications:'
  2128.      Transfers one or more files using the currently configured XPR
  2129.      protocol. The `Mode' parameter determines the file transfer mode
  2130.      (either plain ASCII, Text mode or binary file mode), if omitted
  2131.      the file(s) will be sent in binary mode. Some file transfer
  2132.      protocols do not require any file names to be given as they have
  2133.      their own means to determine the names of the files to be sent.
  2134.      However, a file name parameter can be given. If omitted the file
  2135.      transfer protocol will prompt the user for a file name if
  2136.      necessary. Several file names can be given if necessary, they will
  2137.      be transferred along with the file names stored in the upload
  2138.      list. The file transfer process will remove any files successfully
  2139.      transferred from the upload list, leaving only those behing which
  2140.      were not to be transferred correctly.
  2141.  
  2142. `Result:'
  2143.      -
  2144.  
  2145. `Warning:'
  2146.      If user cancels file selection.
  2147.  
  2148. `Example:'
  2149.           /* Prompt for files to be uploaded. */
  2150.           
  2151.           SENDFILE
  2152.           
  2153.           /* Send a single file. */
  2154.           
  2155.           SENDFILE 'c:list'
  2156.           
  2157.           /* Clear the upload list, add a single file name. */
  2158.           
  2159.           CLEAR upload
  2160.           ADDITEM TO upload NAME 'c:dir'
  2161.           
  2162.           /* Transfer the file. */
  2163.           
  2164.           SENDFILE
  2165.  
  2166.  
  2167. The SETATTR command
  2168. ====================
  2169.  
  2170. `Format:'
  2171.      SETATTR [Object] <Name> [Field] <Name> [Stem <Name>] [Var <Name>]
  2172.  
  2173. `Template:'
  2174.      OBJECT/A,FIELD,STEM/K,VAR
  2175.  
  2176. `Purpose:'
  2177.      Sets a certain application attribute.
  2178.  
  2179. `Specifications:'
  2180.      Sets a certain application attribute, retrieves the information
  2181.      from the supplied stem or simple variable. For a list of valid
  2182.      attributes, see the section entitled Attributes.
  2183.  
  2184. `Result:'
  2185.      -
  2186.  
  2187. `Warning:'
  2188.      -
  2189.  
  2190. `Example:'
  2191.           /* Set the transfer speed. */
  2192.           
  2193.           SETATTR serialprefs baudrate 2400
  2194.  
  2195.  
  2196. The SPEAK command
  2197. ==================
  2198.  
  2199. `Format:'
  2200.      SPEAK [Text] <Text>
  2201.  
  2202. `Template:'
  2203.      TEXT/A/F
  2204.  
  2205. `Purpose:'
  2206.      Speaks the provided text using the Amiga speech synthesizer.
  2207.  
  2208. `Specifications:'
  2209.      Speaks the provided text using the Amiga speech synthesizer,
  2210.      requires that speech support is enabled.
  2211.  
  2212. `Result:'
  2213.      -
  2214.  
  2215. `Warning:'
  2216.      -
  2217.  
  2218. `Example:'
  2219.           /* Say something sensible. */
  2220.           
  2221.           SPEAK 'something sensible'
  2222.  
  2223.  
  2224. The STOPBITS command
  2225. =====================
  2226.  
  2227. `Format:'
  2228.      STOPBITS [0|1]
  2229.  
  2230. `Template:'
  2231.      0/S,1/S
  2232.  
  2233. `Purpose:'
  2234.      Sets the serial line stop bits.
  2235.  
  2236. `Specifications:'
  2237.      Sets the serial line stop bits.
  2238.  
  2239. `Result:'
  2240.      -
  2241.  
  2242. `Warning:'
  2243.      -
  2244.  
  2245. `Example:'
  2246.           /* Set the serial line stop bits. */
  2247.           
  2248.           STOPBITS 1
  2249.  
  2250.  
  2251. The TEXTBUFFER command
  2252. =======================
  2253.  
  2254. `Format:'
  2255.      TEXTBUFFER [Lock|Unlock]
  2256.  
  2257. `Template:'
  2258.      LOCK/S,UNLOCK/S
  2259.  
  2260. `Purpose:'
  2261.      Locks or unlocks the text buffer contents.
  2262.  
  2263. `Specifications:'
  2264.      Locks or unlocks the text buffer contents, similar to the effect
  2265.      of the corresponding main menu entry.
  2266.  
  2267. `Result:'
  2268.      -
  2269.  
  2270. `Warning:'
  2271.      -
  2272.  
  2273. `Example:'
  2274.           /* Lock the text buffer. */
  2275.           
  2276.           TEXTBUFFER LOCK
  2277.  
  2278.  
  2279. The TIMEOUT command
  2280. ====================
  2281.  
  2282. `Format:'
  2283.      TIMEOUT [[Sec|Seconds] <Number>] [Off]
  2284.  
  2285. `Template:'
  2286.      SEC=SECONDS/N,OFF/S
  2287.  
  2288. `Purpose:'
  2289.      Sets the serial read timeout.
  2290.  
  2291. `Specifications:'
  2292.      Sets the timeout the WAIT and READ commands will wait until they
  2293.      exit.
  2294.  
  2295. `Result:'
  2296.      -
  2297.  
  2298. `Warning:'
  2299.      -
  2300.  
  2301. `Example:'
  2302.           /* Set the read timeout. */
  2303.           
  2304.           TIMEOUT SEC 5
  2305.  
  2306.  
  2307. The WAIT command
  2308. =================
  2309.  
  2310. `Format:'
  2311.      WAIT [Noecho] [[Text] <Text>]
  2312.  
  2313. `Template:'
  2314.      NOECHO/S,TEXT/F
  2315.  
  2316. `Purpose:'
  2317.      Waits for a certain sequence of characters to be received from the
  2318.      serial line.
  2319.  
  2320. `Specifications:'
  2321.      Wait for text to be received from the serial line. If no text to
  2322.      wait for is provided wait for either item of the wait list to
  2323.      appear. The `Noecho' parameter suppresses terminal output. *Note
  2324.      that text comparison does not consider the case of characters (in
  2325.      respect to the ECMA Latin 1 character set).*
  2326.  
  2327. `Result:'
  2328.      Returns the string found.
  2329.  
  2330. `Warning:'
  2331.      If timeout has elapsed before any matching text was received.
  2332.  
  2333. `Example:'
  2334.           /* Enable command results. */
  2335.           
  2336.           OPTIONS RESULTS
  2337.           
  2338.           /* Set the read timeout. */
  2339.           
  2340.           TIMEOUT SEC 30
  2341.           
  2342.           /* Wait for a single line of text. */
  2343.           
  2344.           WAIT 'some text'
  2345.           
  2346.           /* Clear the wait list, add a few items. */
  2347.           
  2348.           CLEAR wait
  2349.           ADDITEM TO wait NAME 'foo'
  2350.           ADDITEM TO wait NAME 'bar'
  2351.           
  2352.           /* Wait for the text to appear. */
  2353.           
  2354.           WAIT
  2355.           
  2356.           /* Output the result. */
  2357.           
  2358.           IF rc ~= 0 THEN
  2359.              SAY 'no text was received'
  2360.           ELSE
  2361.              SAY result
  2362.  
  2363.  
  2364. The WINDOW command
  2365. ===================
  2366.  
  2367. `Format:'
  2368.      WINDOW [Names] {<Buffer|Review|Packet|Fastmacros| Status|Main>}
  2369.      [Open|Close] [Activate] [Min|Max] [Front|Back] [Top|Bottom|Up|Down]
  2370.  
  2371. `Template:'
  2372.      NAMES/A/M,OPEN/S,CLOSE/S,ACTIVATE/S,MIN/S,MAX/S,FRONT/S,BACK/S,
  2373.      TOP/S,BOTTOM/S,UP/S,DOWN/S
  2374.  
  2375. `Purpose:'
  2376.      Manipulates the aspects of a window.
  2377.  
  2378. `Specifications:'
  2379.      Manipulates the aspects of a window. Not all windows will support
  2380.      all available commands. The windows supported are:
  2381.  
  2382.     `Buffer'
  2383.           The text buffer window and screen. Supports the `Open',
  2384.           `Close', `Activate' and `Front' commands.
  2385.  
  2386.     `Review'
  2387.           The review window. Supports the `Open', `Close', `Activate',
  2388.           `Min', `Max', `Front', `Back', `Top', `Bottom', `Up', and
  2389.           `Down' commands.
  2390.  
  2391.     `Packet'
  2392.           The packet window. Supports the `Open', `Close', `Activate',
  2393.           `Min', `Max', `Front' and `Back' commands.
  2394.  
  2395.     `Fastmacros'
  2396.           The fast! macro window. Supports the `Open', `Close',
  2397.           `Activate', `Min', `Max', `Front' and `Back' commands.
  2398.  
  2399.     `Status'
  2400.           The status window. Supports the `Open', `Close', `Activate',
  2401.           `Front' and `Back' commands.
  2402.  
  2403.     `Main'
  2404.           The main program window. Supports the `Open', `Close',
  2405.           `Activate', `Front' and `Back' commands.
  2406.  
  2407. `Result:'
  2408.      -
  2409.  
  2410. `Warning:'
  2411.      -
  2412.  
  2413. `Example:'
  2414.           /* Open all available windows. */
  2415.           
  2416.           WINDOW buffer review packet fastmacros status main OPEN
  2417.  
  2418.  
  2419. Attributes
  2420. ***********
  2421.  
  2422.    Several of the application's internal variables are can be accessed
  2423. and modified using the GETATTR and SETATTR commands. Information is
  2424. available on the objects and their associated fields explained below.
  2425. Each line consists of the object and field name and the type of the
  2426. available data:
  2427.  
  2428. `Numeric data'
  2429.     `<Object>.<Field>'
  2430.           Numeric
  2431.  
  2432.      The information is a numeric value.
  2433.  
  2434. `Text data'
  2435.     `<Object>.<Field>'
  2436.           Text
  2437.  
  2438.      The information is a text string.
  2439.  
  2440. `Boolean data'
  2441.     `<Object>.<Field>'
  2442.           Boolean
  2443.  
  2444.      The information is a boolean value and can be `ON' or `OFF'.
  2445.  
  2446. `Mapped codes'
  2447.     `<Object>.<Field>'
  2448.           <Value 1> ... <Value n>
  2449.  
  2450.      The information can be one of the given values.
  2451.  
  2452. The TERM object (read-only)
  2453. ===========================
  2454.  
  2455. `TERM.VERSION'
  2456.      Text
  2457.  
  2458.      The `term' program revision.
  2459.  
  2460. `TERM.SCREEN'
  2461.      Text
  2462.  
  2463.      The name of the public screen the `term' main window has been
  2464.      opened on.
  2465.  
  2466. `TERM.SESSION.ONLINE'
  2467.      Boolean
  2468.  
  2469.      Whether the program is currently online or not.
  2470.  
  2471. `TERM.SESSION.SESSIONSTART'
  2472.      Text
  2473.  
  2474.      Time and date when the `term' program was started.
  2475.  
  2476. `TERM.SESSION.BYTESSENT'
  2477.      Numeric
  2478.  
  2479. `TERM.SESSION.BYTESRECEIVED'
  2480.      Numeric
  2481.  
  2482. `TERM.SESSION.CONNECTMESSAGE'
  2483.      Text
  2484.  
  2485.      The message issued by the modem when the connection was
  2486.      established.
  2487.  
  2488. `TERM.SESSION.BBSNAME'
  2489.      Text
  2490.  
  2491. `TERM.SESSION.BBSNUMBER'
  2492.      Text
  2493.  
  2494. `TERM.SESSION.BBSCOMMENT'
  2495.      Text
  2496.  
  2497. `TERM.SESSION.USERNAME'
  2498.      Text
  2499.  
  2500. `TERM.SESSION.ONLINEMINUTES'
  2501.      Numeric
  2502.  
  2503.      The number of minutes the program is currently connected to a BBS.
  2504.  
  2505. `TERM.SESSION.ONLINECOST'
  2506.      Numeric
  2507.  
  2508.      The cost of the connection to the BBS.
  2509.  
  2510. `TERM.AREXX'
  2511.      Text
  2512.  
  2513.      The name of the ARexx host port the program is communicating with.
  2514.  
  2515. `TERM.LASTERROR'
  2516.      Numeric
  2517.  
  2518.      The code corresponding to the error the last command has caused.
  2519.  
  2520. `TERM.TERMINAL.ROWS'
  2521.      Numeric
  2522.  
  2523.      The number of available terminal screen rows.
  2524.  
  2525. `TERM.TERMINAL.COLUMNS'
  2526.      Numeric
  2527.  
  2528.      The number of available terminal screen columns.
  2529.  
  2530. `TERM.BUFFER.SIZE'
  2531.      Numeric
  2532.  
  2533.      The size of the text buffer.
  2534.  
  2535. The PHONEBOOK object (read-only)
  2536. ================================
  2537.  
  2538.    Available fields are:
  2539.  
  2540. `PHONEBOOK.COUNT'
  2541.      Numeric
  2542.  
  2543.      The number of entries in the phonebook. The single phonebook
  2544.      entries can be accessed as `PHONEBOOK.0...' through
  2545.      `PHONEBOOK.n-1...'.
  2546.  
  2547. `PHONEBOOK.n.NAME'
  2548.      Text
  2549.  
  2550. `PHONEBOOK.n.NUMBER'
  2551.      Text
  2552.  
  2553. `PHONEBOOK.n.COMMENTEXT'
  2554.      Text
  2555.  
  2556. `PHONEBOOK.n.USERNAME'
  2557.      Text
  2558.  
  2559. `PHONEBOOK.n.PASSWORDTEXT'
  2560.      Text
  2561.  
  2562. The SERIALPREFS object
  2563. ======================
  2564.  
  2565.    Available fields are:
  2566.  
  2567. `SERIALPREFS.BAUDRATE'
  2568.      Numeric
  2569.  
  2570. `SERIALPREFS.BREAKLENGTH'
  2571.      Numeric
  2572.  
  2573.      The break signal length in microseconds.
  2574.  
  2575. `SERIALPREFS.BUFFERSIZE'
  2576.      Numeric
  2577.  
  2578. `SERIALPREFS.DEVICENAME'
  2579.      Text
  2580.  
  2581. `SERIALPREFS.UNIT'
  2582.      Numeric
  2583.  
  2584. `SERIALPREFS.BITSPERCHAR'
  2585.      Numeric
  2586.  
  2587.      The number of bits per transferred char. This can be either seven
  2588.      or eight.
  2589.  
  2590. `SERIALPREFS.PARITYMODE'
  2591.      `NONE' `EVEN' `ODD' `MARK' `SPACE'.
  2592.  
  2593. `SERIALPREFS.STOPBITS'
  2594.      Numeric
  2595.  
  2596.      The number of stop bits to be used. This can be either 0 or 1.
  2597.  
  2598. `SERIALPREFS.HANDSHAKINGMODE'
  2599.      `NONE' `RTSCTS' `RTSCTSDSR'
  2600.  
  2601. `SERIALPREFS.DUPLEXMODE'
  2602.      `HALF' `FULL'
  2603.  
  2604. `SERIALPREFS.XONXOFF'
  2605.      Boolean
  2606.  
  2607. `SERIALPREFS.HIGHSPEED'
  2608.      Boolean
  2609.  
  2610. `SERIALPREFS.SHARED'
  2611.      Boolean
  2612.  
  2613. `SERIALPREFS.STRIPBIT8'
  2614.      Boolean
  2615.  
  2616. `SERIALPREFS.CARRIERCHECK'
  2617.      Boolean
  2618.  
  2619. `SERIALPREFS.PASSXONXOFFTHROUGH'
  2620.      Boolean
  2621.  
  2622. The MODEMPREFS object
  2623. =====================
  2624.  
  2625.    Available fields are:
  2626.  
  2627. `MODEMPREFS.MODEMINITTEXT'
  2628.      Text
  2629.  
  2630. `MODEMPREFS.MODEMEXITTEXT'
  2631.      Text
  2632.  
  2633. `MODEMPREFS.MODEMHANGUPTEXT'
  2634.      Text
  2635.  
  2636. `MODEMPREFS.DIALPREFIXTEXT'
  2637.      Text
  2638.  
  2639. `MODEMPREFS.DIALSUFFIXTEXT'
  2640.      Text
  2641.  
  2642. `MODEMPREFS.NOCARRIERTEXT'
  2643.      Text
  2644.  
  2645. `MODEMPREFS.NODIALTONETEXT'
  2646.      Text
  2647.  
  2648. `MODEMPREFS.CONNECTTEXT'
  2649.      Text
  2650.  
  2651. `MODEMPREFS.VOICETEXT'
  2652.      Text
  2653.  
  2654. `MODEMPREFS.RINGTEXT'
  2655.      Text
  2656.  
  2657. `MODEMPREFS.BUSYTEXT'
  2658.      Text
  2659.  
  2660. `MODEMPREFS.REDIALDELAY'
  2661.      Numeric
  2662.  
  2663.      The redial delay in seconds
  2664.  
  2665. `MODEMPREFS.DIALRETRIES'
  2666.      Numeric
  2667.  
  2668. `MODEMPREFS.DIALTIMEOUT'
  2669.      Numeric
  2670.  
  2671.      The dial timeout in seconds
  2672.  
  2673. `MODEMPREFS.CONNECTAUTOBAUD'
  2674.      Boolean
  2675.  
  2676. `MODEMPREFS.HANGUPDROPSDTR'
  2677.      Boolean
  2678.  
  2679. `MODEMPREFS.REDIALAFTERHANGUP'
  2680.      Boolean
  2681.  
  2682. The SCREENPREFS object
  2683. ======================
  2684.  
  2685.    Available fields are:
  2686.  
  2687. `SCREENPREFS.COLOURMODE'
  2688.      `TWO' `FOUR' `EIGHT' `SIXTEEN'
  2689.  
  2690. `SCREENPREFS.FONTNAME'
  2691.      Text
  2692.  
  2693. `SCREENPREFS.FONTSIZE'
  2694.      Numeric
  2695.  
  2696. `SCREENPREFS.MAKESCREENPUBLIC'
  2697.      Boolean
  2698.  
  2699. `SCREENPREFS.SHANGHAIWINDOWS'
  2700.      Boolean
  2701.  
  2702. `SCREENPREFS.BLINKING'
  2703.      Boolean
  2704.  
  2705. `SCREENPREFS.FASTERLAYOUT'
  2706.      Boolean
  2707.  
  2708. `SCREENPREFS.TITLEBAR'
  2709.      Boolean
  2710.  
  2711. `SCREENPREFS.STATUSLINEMODE'
  2712.      `DISABLED' `STANDARD' `COMPRESSED'
  2713.  
  2714. `SCREENPREFS.USEPUBSCREEN'
  2715.      Boolean
  2716.  
  2717. `SCREENPREFS.PUBSCREENNAME'
  2718.      Text
  2719.  
  2720. The TERMINALPREFS object
  2721. ========================
  2722.  
  2723.    Available fields are:
  2724.  
  2725. `TERMINALPREFS.BELLMODE'
  2726.      `NONE' `VISIBLE' `AUDIBLE' `BOTH' `SYSTEM'
  2727.  
  2728. `TERMINALPREFS.ALERTMODE'
  2729.      `NONE' `BELL' `SCREEN' `BOTH'
  2730.  
  2731. `TERMINALPREFS.EMULATIONMODE'
  2732.      `INTERNAL' `ATOMIC' `TTY' `EXTERNAL'
  2733.  
  2734. `TERMINALPREFS.FONTMODE'
  2735.      `STANDARD' `IBM' `IBMRAW'
  2736.  
  2737. `TERMINALPREFS.SENDCRMODE'
  2738.      `IGNORE' `CR' `CRLF'
  2739.  
  2740. `TERMINALPREFS.SENDLFMODE'
  2741.      `IGNORE' `LF' `LFCR'
  2742.  
  2743. `TERMINALPREFS.RECEIVECRMODE'
  2744.      `IGNORE' `CR' `CRLF'
  2745.  
  2746. `TERMINALPREFS.RECEIVELFMODE'
  2747.      `IGNORE' `LF' `LFCR'
  2748.  
  2749. `TERMINALPREFS.NUMCOLUMNS'
  2750.      Numeric
  2751.  
  2752. `TERMINALPREFS.NUMLINES'
  2753.      Numeric
  2754.  
  2755. `TERMINALPREFS.KEYMAPNAME'
  2756.      Text
  2757.  
  2758. `TERMINALPREFS.EMULATIONNAME'
  2759.      Text
  2760.  
  2761. `TERMINALPREFS.BEEPNAME'
  2762.      Text
  2763.  
  2764. `TERMINALPREFS.FONTNAME'
  2765.      Text
  2766.  
  2767. `TERMINALPREFS.FONTSIZE'
  2768.      Numeric
  2769.  
  2770. The EMULATIONPREFS object
  2771. =========================
  2772.  
  2773.    Available fields are:
  2774.  
  2775. `EMULATIONPREFS.CURSORMODE'
  2776.      `STANDARD' `APPLICATION'
  2777.  
  2778. `EMULATIONPREFS.NUMERICMODE'
  2779.      `STANDARD' `APPLICATION'
  2780.  
  2781. `EMULATIONPREFS.CURSORWRAP'
  2782.      Boolean
  2783.  
  2784. `EMULATIONPREFS.LINEWRAP'
  2785.      Boolean
  2786.  
  2787. `EMULATIONPREFS.INSERTMODE'
  2788.      Boolean
  2789.  
  2790. `EMULATIONPREFS.NEWLINEMODE'
  2791.      Boolean
  2792.  
  2793. `EMULATIONPREFS.FONTSCALEMODE'
  2794.      `NORMAL' `HALF'
  2795.  
  2796. `EMULATIONPREFS.SCROLLMODE'
  2797.      `JUMP' `SMOOTH'
  2798.  
  2799. `EMULATIONPREFS.DESTRUCTIVEBACKSPACE'
  2800.      Boolean
  2801.  
  2802. `EMULATIONPREFS.SWAPBSDELETE'
  2803.      Boolean
  2804.  
  2805. `EMULATIONPREFS.PRINTERENABLED'
  2806.      Boolean
  2807.  
  2808. `EMULATIONPREFS.ANSWERBACKTEXT'
  2809.      Text
  2810.  
  2811. The CLIPBOARDPREFS object
  2812. =========================
  2813.  
  2814.    Available fields are:
  2815.  
  2816. `CLIPBOARDPREFS.UNIT'
  2817.      Numeric
  2818.  
  2819. `CLIPBOARDPREFS.LINEDELAY'
  2820.      Numeric
  2821.  
  2822.      Paste line delay in 1/100 seconds.
  2823.  
  2824. `CLIPBOARDPREFS.CHARDELAY'
  2825.      Numeric
  2826.  
  2827.      Paste character delay in 1/100 seconds.
  2828.  
  2829. `CLIPBOARDPREFS.INSERTPREFIXTEXT'
  2830.      Text
  2831.  
  2832. `CLIPBOARDPREFS.INSERTSUFFIXTEXT'
  2833.      Text
  2834.  
  2835. The CAPTUREPREFS object
  2836. =======================
  2837.  
  2838.    Available fields are:
  2839.  
  2840. `CAPTUREPREFS.LOGACTIONS'
  2841.      Boolean
  2842.  
  2843. `CAPTUREPREFS.LOGFILENAME'
  2844.      Text
  2845.  
  2846. `CAPTUREPREFS.LOGCALLS'
  2847.      Boolean
  2848.  
  2849. `CAPTUREPREFS.CALLLOGFILENAME'
  2850.      Text
  2851.  
  2852. `CAPTUREPREFS.MAXBUFFERSIZE'
  2853.      Numeric
  2854.  
  2855. `CAPTUREPREFS.BUFFER'
  2856.      Boolean
  2857.  
  2858. `CAPTUREPREFS.BUFFERSAVEPATH'
  2859.      Text
  2860.  
  2861. `CAPTUREPREFS.CONNECTAUTOCAPTURE'
  2862.      Boolean
  2863.  
  2864. `CAPTUREPREFS.CAPTUREFILTER'
  2865.      Boolean
  2866.  
  2867. `CAPTUREPREFS.CAPTUREPATH'
  2868.      Text
  2869.  
  2870. The COMMANDPREFS object
  2871. =======================
  2872.  
  2873.    Available fields are:
  2874.  
  2875. `COMMANDPREFS.STARTUPMACROTEXT'
  2876.      Text
  2877.  
  2878. `COMMANDPREFS.LOGOFFMACROTEXT'
  2879.      Text
  2880.  
  2881. `COMMANDPREFS.UPLOADMACROTEXT'
  2882.      Text
  2883.  
  2884. `COMMANDPREFS.DOWNLOADMACROTEXT'
  2885.      Text
  2886.  
  2887. The MISCPREFS object
  2888. ====================
  2889.  
  2890.    Available fields are:
  2891.  
  2892. `MISCPREFS.PRIORITY'
  2893.      Numeric
  2894.  
  2895. `MISCPREFS.BACKUPCONFIG'
  2896.      Boolean
  2897.  
  2898. `MISCPREFS.OPENFASTMACROPANEL'
  2899.      Boolean
  2900.  
  2901. `MISCPREFS.RELEASEDEVICE'
  2902.      Boolean
  2903.  
  2904. `MISCPREFS.OVERRIDEPATH'
  2905.      Boolean
  2906.  
  2907. `MISCPREFS.AUTOUPLOAD'
  2908.      Boolean
  2909.  
  2910. `MISCPREFS.SETARCHIVEDBIT'
  2911.      Boolean
  2912.  
  2913. `MISCPREFS.COMMENTMODE'
  2914.      `IGNORE' `FILETYPE' `SOURCE'
  2915.  
  2916. `MISCPREFS.TRANSFERICONS'
  2917.      Boolean
  2918.  
  2919. The PATHPREFS object
  2920. ====================
  2921.  
  2922.    Available fields are:
  2923.  
  2924. `PATHPREFS.ASCIIUPLOADPATH'
  2925.      Text
  2926.  
  2927. `PATHPREFS.ASCIIDOWNLOADPATH'
  2928.      Text
  2929.  
  2930. `PATHPREFS.TEXTUPLOADPATH'
  2931.      Text
  2932.  
  2933. `PATHPREFS.TEXTDOWNLOADPATH'
  2934.      Text
  2935.  
  2936. `PATHPREFS.BINARYUPLOADPATH'
  2937.      Text
  2938.  
  2939. `PATHPREFS.BINARYDOWNLOADPATH'
  2940.      Text
  2941.  
  2942. `PATHPREFS.CONFIGPATH'
  2943.      Text
  2944.  
  2945. `PATHPREFS.EDITORNAME'
  2946.      Text
  2947.  
  2948. `PATHPREFS.HELPFILENAME'
  2949.      Text
  2950.  
  2951. The PROTOCOLPREFS object
  2952. ========================
  2953.  
  2954.    This object features no fields, it contains a single line of text:
  2955. the XPR protocol options.
  2956.  
  2957. The TRANSLATIONPREFS object
  2958. ===========================
  2959.  
  2960.    Indices referring to the ascii codes range from 0 to 255, available
  2961. fields are:
  2962.  
  2963. `TRANSLATIONPREFS.n.SEND'
  2964.      Text
  2965.  
  2966. `TRANSLATIONPREFS.n.RECEIVE'
  2967.      Text
  2968.  
  2969. The FUNCTIONKEYPREFS object
  2970. ===========================
  2971.  
  2972.    Key indices range from 1 to 10 (representing F1 through F10),
  2973. available fields are:
  2974.  
  2975. `FUNCTIONKEYPREFS.n'
  2976.      Text
  2977.  
  2978. `FUNCTIONKEYPREFS.SHIFT.n'
  2979.      Text
  2980.  
  2981. `FUNCTIONKEYPREFS.ALT.n'
  2982.      Text
  2983.  
  2984. `FUNCTIONKEYPREFS.CONTROL.n'
  2985.      Text
  2986.  
  2987. The CURSORKEYPREFS object
  2988. =========================
  2989.  
  2990.    Available fields are:
  2991.  
  2992. `CURSORKEYPREFS.UPTEXT'
  2993.      Text
  2994.  
  2995. `CURSORKEYPREFS.RIGHTTEXT'
  2996.      Text
  2997.  
  2998. `CURSORKEYPREFS.DOWNTEXT'
  2999.      Text
  3000.  
  3001. `CURSORKEYPREFS.LEFTTEXT'
  3002.      Text
  3003.  
  3004. `CURSORKEYPREFS.SHIFT.UPTEXT'
  3005.      Text
  3006.  
  3007. `CURSORKEYPREFS.SHIFT.RIGHTTEXT'
  3008.      Text
  3009.  
  3010. `CURSORKEYPREFS.SHIFT.DOWNTEXT'
  3011.      Text
  3012.  
  3013. `CURSORKEYPREFS.SHIFT.LEFTTEXT'
  3014.      Text
  3015.  
  3016. `CURSORKEYPREFS.ALT.UPTEXT'
  3017.      Text
  3018.  
  3019. `CURSORKEYPREFS.ALT.RIGHTTEXT'
  3020.      Text
  3021.  
  3022. `CURSORKEYPREFS.ALT.DOWNTEXT'
  3023.      Text
  3024.  
  3025. `CURSORKEYPREFS.ALT.LEFTTEXT'
  3026.      Text
  3027.  
  3028. `CURSORKEYPREFS.CONTROL.UPTEXT'
  3029.      Text
  3030.  
  3031. `CURSORKEYPREFS.CONTROL.RIGHTTEXT'
  3032.      Text
  3033.  
  3034. `CURSORKEYPREFS.CONTROL.DOWNTEXT'
  3035.      Text
  3036.  
  3037. `CURSORKEYPREFS.CONTROL.LEFTTEXT'
  3038.      Text
  3039.  
  3040. The FASTMACROPREFS object
  3041. =========================
  3042.  
  3043. `FASTMACROPREFS.COUNT'
  3044.      Numeric
  3045.  
  3046.      The number of fast macros available, entries range from
  3047.      `FASTMACROPREFS.0...' to `FASTMACROPREFS.n-1...'
  3048.  
  3049. `FASTMACROPREFS.n.NAME'
  3050.      Text
  3051.  
  3052. `FASTMACROPREFS.n.CODE'
  3053.      Text
  3054.  
  3055. The HOTKEYPREFS object
  3056. ======================
  3057.  
  3058.    Available fields are:
  3059.  
  3060. `HOTKEYPREFS.TERMSCREENTOFRONTTEXT'
  3061.      Text
  3062.  
  3063. `HOTKEYPREFS.BUFFERSCREENTOFRONTTEXT'
  3064.      Text
  3065.  
  3066. `HOTKEYPREFS.SKIPDIALENTRYTEXT'
  3067.      Text
  3068.  
  3069. `HOTKEYPREFS.ABORTAREXX'
  3070.      Text
  3071.  
  3072. `HOTKEYPREFS.COMMODITYPRIORITY'
  3073.      Numeric
  3074.  
  3075. `HOTKEYPREFS.HOTKEYSENABLED'
  3076.      Boolean
  3077.  
  3078. The SPEECHPREFS object
  3079. ======================
  3080.  
  3081.    Available fields are:
  3082.  
  3083. `SPEECHPREFS.RATE'
  3084.      Numeric
  3085.  
  3086. `SPEECHPREFS.PITCH'
  3087.      Numeric
  3088.  
  3089. `SPEECHPREFS.FREQUENCY'
  3090.      Numeric
  3091.  
  3092. `SPEECHPREFS.SEXMODE'
  3093.      `MALE' `FEMALE'
  3094.  
  3095. `SPEECHPREFS.VOLUME'
  3096.      Numeric
  3097.  
  3098. `SPEECHPREFS.SPEECH'
  3099.      Boolean
  3100.  
  3101. The CONSOLEPREFS object
  3102. =======================
  3103.  
  3104.    This object features no fields, it contains a single line of text:
  3105. the console output window specification.
  3106.  
  3107. The FILEPREFS object
  3108. ====================
  3109.  
  3110.    Available fields are:
  3111.  
  3112. `FILEPREFS.TRANSFERPROTOCOLNAME'
  3113.      Text
  3114.  
  3115. `FILEPREFS.TRANSLATIONFILENAME'
  3116.      Text
  3117.  
  3118. `FILEPREFS.MACROFILENAME'
  3119.      Text
  3120.  
  3121. `FILEPREFS.CURSORFILENAME'
  3122.      Text
  3123.  
  3124. `FILEPREFS.FASTMACROFILENAME'
  3125.      Text
  3126.  
  3127.  
  3128. Wanted!
  3129. ********
  3130.  
  3131.    As of this writing only a single example ARexx program is included
  3132. in the `term' distribution (see the `Rexx' drawer). However, it is
  3133. desirable to include more sample programs so more users will be able to
  3134. take advantage of the ARexx interface.
  3135.  
  3136.    If you wish to share your programs with the `term' user community,
  3137. send them (including documentation) to:
  3138.  
  3139.                              Olaf Barthel
  3140.                            Brabeckstrasse 35
  3141.                           D-3000 Hannover 71
  3142.  
  3143.                       Federal Republic of Germany
  3144.  
  3145.                  Internet: olsen@sourcery.mxm.sub.org
  3146.  
  3147.  
  3148. Index
  3149. ******
  3150.  
  3151.  
  3152.  
  3153.  `, (Comma)'                            Commands
  3154.  `, (Comma)'                            Commands
  3155.  `< > (Angle brackets)'                 Commands
  3156.  `<Option>/K'                           Commands
  3157.  `<Option>/M'                           Commands
  3158.  `<Option>/N'                           Commands
  3159.  `<Option>/S'                           Commands
  3160.  `<Parameter>/A'                        Commands
  3161.  `<Text>/F'                             Commands
  3162.  `{ } (Curly braces)'                   Commands
  3163.  `ACTIVATE'                             ACTIVATE
  3164.  `ADDITEM'                              ADDITEM
  3165.  `BAUD'                                 BAUD
  3166.  `BEEPSCREEN'                           BEEPSCREEN
  3167.  `CALLMENU'                             CALLMENU
  3168.  `CAPTURE'                              CAPTURE
  3169.  `CAPTUREPREFS'                         Attributes
  3170.  `CLEAR'                                CLEAR
  3171.  `CLEARSCREEN'                          CLEARSCREEN
  3172.  `CLIPBOARDPREFS'                       Attributes
  3173.  `CLOSE'                                CLOSE
  3174.  `CLOSEDEVICE'                          CLOSEDEVICE
  3175.  `CLOSEREQUESTER'                       CLOSEREQUESTER
  3176.  `COMMANDPREFS'                         Attributes
  3177.  `CONSOLEPREFS'                         Attributes
  3178.  `CURSORKEYPREFS'                       Attributes
  3179.  `DEACTIVATE'                           DEACTIVATE
  3180.  `DELAY'                                DELAY
  3181.  `DIAL'                                 DIAL
  3182.  `Dial list'                            ADDITEM
  3183.  `Download list'                        ADDITEM
  3184.  `DUPLEX'                               DUPLEX
  3185.  `EMULATIONPREFS'                       Attributes
  3186.  `Example:'                             Commands
  3187.  `EXECTOOL'                             EXECTOOL
  3188.  `FASTMACROPREFS'                       Attributes
  3189.  `FAULT'                                FAULT
  3190.  `FILEPREFS'                            Attributes
  3191.  `Format:'                              Commands
  3192.  `FUNCTIONKEYPREFS'                     Attributes
  3193.  `GETATTR'                              GETATTR
  3194.  `GETCLIP'                              GETCLIP
  3195.  `HANGUP'                               HANGUP
  3196.  `HELP'                                 HELP
  3197.  `HOTKEYPREFS'                          Attributes
  3198.  `MISCPREFS'                            Attributes
  3199.  `MODEMPREFS'                           Attributes
  3200.  `OPEN'                                 OPEN
  3201.  `OPENDEVICE'                           OPENDEVICE
  3202.  `OPENREQUESTER'                        OPENREQUESTER
  3203.  `PARITY'                               PARITY
  3204.  `PASTECLIP'                            PASTECLIP
  3205.  `PATHPREFS'                            Attributes
  3206.  `PHONEBOOK'                            Attributes
  3207.  `PRINT'                                PRINT
  3208.  `PROTOCOL'                             PROTOCOL
  3209.  `PROTOCOLPREFS'                        Attributes
  3210.  `Purpose:'                             Commands
  3211.  `PUTCLIP'                              PUTCLIP
  3212.  `QUIT'                                 QUIT
  3213.  `READ'                                 READ
  3214.  `RECEIVEFILE'                          RECEIVEFILE
  3215.  `REDIAL'                               REDIAL
  3216.  `REMITEM'                              REMITEM
  3217.  `REQUESTFILE'                          REQUESTFILE
  3218.  `REQUESTNOTIFY'                        REQUESTNOTIFY
  3219.  `REQUESTNUMBER'                        REQUESTNUMBER
  3220.  `REQUESTRESPONSE'                      REQUESTRESPONSE
  3221.  `REQUESTSTRING'                        REQUESTSTRING
  3222.  `RESETSCREEN'                          RESETSCREEN
  3223.  `RESETSTYLES'                          RESETSTYLES
  3224.  `RESETTEXT'                            RESETTEXT
  3225.  `Result:'                              Commands
  3226.  `RX'                                   RX
  3227.  `SAVE'                                 SAVE
  3228.  `SAVEAS'                               SAVEAS
  3229.  `SCREENPREFS'                          Attributes
  3230.  `SELECTITEM'                           SELECTITEM
  3231.  `SEND'                                 SEND
  3232.  `SENDBREAK'                            SENDBREAK
  3233.  `SENDFILE'                             SENDFILE
  3234.  `SERIALPREFS'                          Attributes
  3235.  `SETATTR'                              SETATTR
  3236.  `SPEAK'                                SPEAK
  3237.  `Specifications:'                      Commands
  3238.  `SPEECHPREFS'                          Attributes
  3239.  `STOPBITS'                             STOPBITS
  3240.  `Template:'                            Commands
  3241.  `TERM'                                 Attributes
  3242.  `TERMINALPREFS'                        Attributes
  3243.  `TEXTBUFFER'                           TEXTBUFFER
  3244.  `TIMEOUT'                              TIMEOUT
  3245.  `TRANSLATIONPREFS'                     Attributes
  3246.  `Upload list'                          ADDITEM
  3247.  `WAIT'                                 WAIT
  3248.  `Wait list'                            ADDITEM
  3249.  `Warning:'                             Commands
  3250.  `WINDOW'                               WINDOW
  3251.  `[ ] (Square brackets)'                Commands
  3252.  `| (Vertical bar)'                     Commands
  3253.  
  3254.