home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 592b.lha / TermII / English / Documentation / COMMANDS.doc.pp / COMMANDS.doc
Text File  |  1992-01-01  |  16KB  |  446 lines
  1. July 2nd 1991
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                                     Term II
  13.  
  14.                                   version 1.1
  15.  
  16.                           (c) 1990,1991 - Eric GONTIER
  17.  
  18.                                   COMMANDS.doc
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.         INTRODUCTION :
  29.  
  30.             Every functions in Term II is a command. You can send commands
  31.             to Term II in different ways : with an ARexx script, with an
  32.             external command, by hand through the "Command..." option of
  33.             the "Project" menu, or through a file.
  34.  
  35.             The the configuration file (term.config), the ARexx examples or
  36.             the XCMD examples to see how commands work. Or try this :
  37.  
  38.                 In the project menu, select "Command...". A requester opens
  39.                 and type in the string requester :
  40.  
  41.                         console_font "courier.font" 24
  42.  
  43.                 This will replace the font used in the window by a
  44.                 courier.font font in 24 points size.
  45.  
  46.             Here are the description of the 91 commands recognized by Term
  47.             II :
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.             about
  55.                 Gives the "about" of the program in a requester.
  56.  
  57.  
  58.             capture
  59.                 Open the command panel for the capture facilities. Capture
  60.                 is always made by adding at the end of a file. This avoid
  61.                 to delete file.
  62.  
  63.             capture_buffer size
  64.                 Set the size of the capture buffer. When the buffer is
  65.                 full, Term will write it to the end of the capture file. A
  66.                 "big" buffer will take some time to be written to file.
  67.  
  68.             capture_dir "directory"
  69.                 Set the directory for capture. Useful to have the file
  70.                 requester for capture directly open to the proper directory
  71.                 of you choice.
  72.  
  73.             capture_off
  74.                 Stop the capture. The cuurent buffer is written to the
  75.                 capture file.
  76.  
  77.             capture_on "nom_de_fichier"
  78.                 Start capture to file. Note that the directory given with
  79.                 capture_dir is not used.
  80.  
  81.             capture_on_
  82.                 Start capture to file. A file requester will open for the
  83.                 user to type in the name of the file to use. In this case,
  84.                 the directory given with the capture_dir "dirname" will be
  85.                 used.
  86.  
  87.             console_autowrap_off
  88.                 Turn the autowrap mode off. The autowrap mode is the
  89.                 ability to automatically go to the next line in there is no
  90.                 room left in the current line.
  91.  
  92.             console_autowrap_on
  93.                 Turn the autowrap mode on
  94.  
  95.             console_clear
  96.                 Clear the console window
  97.  
  98.             console_close
  99.                 Close the console window. All characters received from the
  100.                 serial device will not be written to the window. This
  101.                 "blind way" to work can be useful in combination with
  102.                 scripts or XCMD with automatic connections. This mode is
  103.                 much more quicker than when all characters are written ro
  104.                 the window. Note that "memory" (see XCMD.doc and
  105.                 SCRIPTS.doc) and capture are still working when they are
  106.                 on.
  107.  
  108.             console_echo_off
  109.                 Turn console window echo of each typed characters off.
  110.  
  111.             console_echo_on
  112.                 Turn console window echo of each type character on.
  113.  
  114.             console_font "nom.font" size
  115.                 Change current font used in console window. Note that the
  116.                 console.device is better in handling only non-proportional
  117.                 fonts.
  118.  
  119.             console_map_key numero "command"
  120.                 Map a string command to a function key. Numbers 1 to 10 are
  121.                 functions keys F1 to F10 and numbers 11 to 20 are functions
  122.                 keys <shift><F1> to <shift><F10>. For example :
  123.  
  124.                     console_map_key 1 "serial_send \"ATDT3600\n\""
  125.  
  126.                 map the command serial_send "ATDT3600\n" to the function
  127.                 key F1. The character \ allows the insertion of special
  128.                 character : \n is RETURN (x0D) and \l is LINE FEDD (x0A).
  129.                 \\ and \" allow the insertion of \ and " respectively.
  130.  
  131.                 Here are some examples that can be found in term.config :
  132.  
  133.                     #
  134.                     #   Examples of function keys mapping
  135.                     #
  136.                     # shift-F10 to quit Term without confirm
  137.                     console_map_key 20 "rexx \"quit.rexx\""
  138.                     # F10 to start XCMD Laser
  139.                     console_map_key 10 "rexx \"laser.rexx\""
  140.                     # F9 to disconnect Hayes modem
  141.                     console_map_key 9 "serial_send \"+++\""
  142.                     # F1 to dial my favorite BBS :
  143.                     console_map_key 1 "serial_send \"ATDT999999\n\""
  144.  
  145.  
  146.             console_open
  147.                 Open a console window. Use options the user asked for :
  148.                 number of colors, gadgets, screen, etc...
  149.  
  150.             console_setfont
  151.                 Give acces to a standard font requester to change the font
  152.                 used in the console window.
  153.  
  154.             menu_long_on
  155.                 Put long menu on
  156.  
  157.             menu_off
  158.                 Remove the menu from the window
  159.  
  160.             menu_short_on
  161.                 Put short menu off
  162.  
  163.             option_load "file"
  164.                 Read and execute all commands include in "file".
  165.                 term.config is a good example of such a file. When
  166.                 starting, Term II attempts a option_load "term.config" to
  167.                 initialize itself.
  168.  
  169.             option_save "file"
  170.                 Save all parameters to "file". Parameters are written as
  171.                 commands that can be excuted with option_load. The "Save
  172.                 config..." option of the "Project" menu perform a
  173.                 option_save "term.config".
  174.  
  175.             panel
  176.                 This option starts the panel XCMD. See the PANEL.doc for
  177.                 more informations on how to use and program the panel.
  178.  
  179.             phone_book
  180.                 Start the phone book XCMD. See the file PHONE.doc for more
  181.                 informations on how to use the phone book.
  182.  
  183.             quit
  184.                 Quit Term II, and free all ressources allocated while
  185.                 running. If the XCMD Panel or Phone Book have been loaded
  186.                 during execution time, they will be stopped and removed
  187.                 from memory.
  188.  
  189.             rexx "file"
  190.                 Start "file" as an ARexx script. RexxMaster must be running
  191.                 in the background for this function to work.
  192.  
  193.             rexx_delay delai
  194.                 Perform a delay. Can be called only from an ARexx script.
  195.                 See the SCRIPTS.doc file.
  196.  
  197.             rexx_memory_off
  198.                 Turn "rexx memory" off. Can be called only from an ARexx
  199.                 script. See the SCRIPTS.doc file.
  200.  
  201.             rexx_memory_on
  202.                 Turn "rexx memory" on. Can be called only from an ARexx
  203.                 script. See the SCRIPTS.doc file.
  204.  
  205.             rexx_wait delai1 delai2
  206.                 Wait for characters incoming from the serial device. Will
  207.                 wait for delai1 (in seconds) without receiving anything.
  208.                 Then, will returned when no characters are received for
  209.                 delai2 (in seconds). Can be called only from an ARexx
  210.                 script. See the SCRIPTS.doc file.
  211.  
  212.             serial
  213.                 Open the control panel for the serial device. This panel
  214.                 allows the user to set easily all RS232 parameters.
  215.  
  216.             serial_baud baud
  217.                 Set serial baud of serial.device
  218.  
  219.             serial_buffer taille
  220.                 Set buffer size of internal read buffers of the serial
  221.                 device.
  222.  
  223.             serial_close
  224.                 Close the serial device
  225.  
  226.             serial_length length
  227.                 Set length of word echanged through the serial.device.
  228.                 Length can be either 7 or 8.
  229.  
  230.             serial_off
  231.                 This is an important command for XCMD or ARexx scripts.
  232.                 When this command is performed, Term II will stop reading
  233.                 the serial device. Reads will be performed only when an
  234.                 ARexx script or an XCMD asks for it (for example with
  235.                 xcmd_sread). After a serial_off, Term can't update the
  236.                 "memory" used in ARexx or XCMD (see the file SCRIPTS.doc
  237.                 and XCMD.doc).
  238.  
  239.             serial_on
  240.                 Turn serial_on, reverse of serial_off : this allow Term to
  241.                 read the serial device as soon as a character is received.
  242.  
  243.             serial_open "serial.device" unit
  244.                 Open the serial device. "serial.device" is the name of the
  245.                 device to used (usually "serial.device" in DEVS:, but could
  246.                 be "IGGY:pop/other.device". Unit is the number of the unit
  247.                 of the selected device to use. Usually 0 (0 is the default,
  248.                 that is the one as defined in the Workbench preferences).
  249.                 Other units or devices can be used with multi-serial cards.
  250.  
  251.  
  252.             serial_parity parity
  253.                 Set parity used by the serial.device. 5 kinds of parity can
  254.                 be used, so "parity" is one of the following number : 0
  255.                 (odd), 1 (even), 2 (no parity), 3 (space), 4 (mark).
  256.  
  257.             serial_send "string"
  258.                 Send "string" to the serial.device
  259.  
  260.             serial_stop stop
  261.                 Set the number of stop bits. Can be either 1 or 2
  262.  
  263.             serial_xdisabled
  264.                 Turn XON/XOFF off.
  265.  
  266.             serial_xenabled
  267.                 Turn XON/XOF on.
  268.  
  269.             window_backdrop_off
  270.                 Use a non-backdrop window. Take effect with the next
  271.                 console_open.
  272.  
  273.             window_backdrop_on
  274.                 Use a backdrop window. Take effect with the next console
  275.                 open.
  276.  
  277.             window_borderless_off
  278.                 Use a non-borderless window. Take effect with the next
  279.                 console_open.
  280.  
  281.             window_borderless_on
  282.                 Use a borderless window. Take effect with the next
  283.                 console_open.
  284.  
  285.             window_closegadget_off
  286.                 Use a window with no close gadget. Take effect with the
  287.                 next console_open.
  288.  
  289.             window_closegadget_on
  290.                 Use a window with a close gadget. Take effect with the next
  291.                 console_open.
  292.  
  293.             window_color number
  294.                 Set the number of colors for the screen. Can be one of 2, 4
  295.                 or 8 (NOTE: there is no color requester yet). Take effect
  296.                 with the next console_open.
  297.  
  298.             window_dragbar_off
  299.                 Use a window without dragbar. Take effect with the next
  300.                 console_open.
  301.  
  302.             window_dragbar_on
  303.                 Use a window with a dragbar. Take effect with the next
  304.                 console_open.
  305.  
  306.             window_options
  307.                 Open control panel for window options.
  308.  
  309.             window_publicscreen_default
  310.                 Use the default public screen for Term II window. Take
  311.                 effect with the next console_open.
  312.  
  313.             window_publicscreen_name "name"
  314.                 If asked for use a public screen, Term II will used the
  315.                 "name" public screen (if it is already opened). Take effect
  316.                 with the next console_open.
  317.  
  318.             window_screen_public
  319.                 Ask Term II to use a public screen. The name of the public
  320.                 screen to use must be given with window_publicscreen_name.
  321.  
  322.             window_screen_term
  323.                 Tell Term II to use its own screen. This screen will be the
  324.                 new default public screen.
  325.  
  326.             window_screen_workbench
  327.                 Tell Term II to use the Workbench screen to open its
  328.                 window. Take effect with the next console_open.
  329.  
  330.             window_sizegadget_off
  331.                 Tell Term II no to put a size gadget on its window. Take
  332.                 effect with the next console_open.
  333.  
  334.             window_sizegadget_on
  335.                 Tell Term II to add a size gadget to its window. Take
  336.                 effect with the next console_open.
  337.  
  338.             window_termscreen_interlace_off
  339.                 Tell Term II not to use an interlace screen. Take effect
  340.                 with the next console_open. (valid only if
  341.                 window_screen_term used).
  342.  
  343.             window_termscreen_interlace_on
  344.                 Tell Term II to use an interlace screen. Take effect with
  345.                 the next console_open. Valid only if used with
  346.                 window_screen_term.
  347.  
  348.             window_termscreen_shanghai_off
  349.                 Tell Term II not to use a shanghai screen
  350.  
  351.             window_termscreen_shanghai_on
  352.                 Terll Term II to use a a shanghai screen
  353.  
  354.             xcmd_delay
  355.                 XCMD-only command to perform a delay. See XCMD.doc.
  356.  
  357.             xcmd_lock_request
  358.                 XCMD-only command to get locks on Term screen and Term
  359.                 directory. See XCMD.doc.
  360.  
  361.             xcmd_memory_request
  362.                 XCMD-only command to get the XCMD "memory". See XCMD.doc.
  363.  
  364.             xcmd_memory_off
  365.                 XCMD-only command to turn "memory" off. See XCMD.doc.
  366.  
  367.             xcmd_memory_on
  368.                 XCMD-only command to turn "memory" on. See XCMD.doc.
  369.  
  370.             xcmd_setserial
  371.                 XCMD-only command to set serial device parameters. See
  372.                 XCMD.doc.
  373.  
  374.             xcmd_sflush
  375.                 XCMD-only command to flush the serial device. See XCMD.doc.
  376.  
  377.             xcmd_squery
  378.                 XCMD-only command to query the serial device about the
  379.                 number of characters waiting to be read. See XCMD.doc.
  380.  
  381.             xcmd_sread
  382.                 XCMD-only command to read characters from the serial
  383.                 device. See XCMD.doc.
  384.  
  385.             xcmd_start "port"
  386.                 Use this command to send a START message to an external
  387.                 process. For example, to start the panel XCMD, type
  388.  
  389.                     xcmd_start "PANEL_PORT"
  390.  
  391.             xcmd_stop "port"
  392.                 Use this command to send a STOP message to an external
  393.                 process.
  394.  
  395.             xcmd_swrite
  396.                 XCMD-only command to write characters to the serial.device.
  397.                 See XCMD.doc.
  398.  
  399.             xcmd_wait
  400.                 XCMD-only command to read characters from the serial
  401.                 device. See XCMD.doc.
  402.  
  403.             xpr
  404.                 Open control panel for the XPR facilities.
  405.  
  406.             xpr_close
  407.                 Close an opened xpr library.
  408.  
  409.             xpr_down_dir "directory"
  410.                 Set the directory for the download requester.
  411.  
  412.             xpr_init "init"
  413.                 Send an init string to the current XPR library. See the
  414.                 documentation of your XPR library for a description of this
  415.                 init string.
  416.  
  417.             xpr_open "LibName"
  418.                 Open an XPR library.
  419.  
  420.             xpr_open_
  421.                 Open an XPR library. A standard file requester will open to
  422.                 get the name of the library to use.
  423.  
  424.             xpr_receive "name"
  425.                 Download a file using the current XPR library.
  426.  
  427.             xpr_receive_
  428.                 Download a file using the current XPR library. A standard
  429.                 file requester will open to get the name of the file to
  430.                 download (depends on the XPR used. ZModem will not allow
  431.                 the opening of a file requester).
  432.  
  433.             xpr_send "name"
  434.                 Upload a file using the current XPR library
  435.  
  436.             xpr_send_
  437.                 Upload a file using the current XPR library. A standard
  438.                 file requester will open to get the name of the file(s) to
  439.                 upload.
  440.  
  441.             xpr_setup
  442.                 Set parameters of the current XPR library
  443.  
  444.             xpr_up_dir "directory"
  445.                 Set upload directory.
  446.