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