Club Amiga de Montreal

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

Wrap

Text File | 1992-01-02 | 15.9 KB | 446 lines

July 2nd 1991 Term II version 1.1 (c) 1990,1991 - Eric GONTIER COMMANDS.doc INTRODUCTION : Every functions in Term II is a command. You can send commands to Term II in different ways : with an ARexx script, with an external command, by hand through the "Command..." option of the "Project" menu, or through a file. The the configuration file (term.config), the ARexx examples or the XCMD examples to see how commands work. Or try this : In the project menu, select "Command...". A requester opens and type in the string requester : console_font "courier.font" 24 This will replace the font used in the window by a courier.font font in 24 points size. Here are the description of the 91 commands recognized by Term II : about Gives the "about" of the program in a requester. capture Open the command panel for the capture facilities. Capture is always made by adding at the end of a file. This avoid to delete file. capture_buffer size Set the size of the capture buffer. When the buffer is full, Term will write it to the end of the capture file. A "big" buffer will take some time to be written to file. capture_dir "directory" Set the directory for capture. Useful to have the file requester for capture directly open to the proper directory of you choice. capture_off Stop the capture. The cuurent buffer is written to the capture file. capture_on "nom_de_fichier" Start capture to file. Note that the directory given with capture_dir is not used. capture_on_ Start capture to file. A file requester will open for the user to type in the name of the file to use. In this case, the directory given with the capture_dir "dirname" will be used. console_autowrap_off Turn the autowrap mode off. The autowrap mode is the ability to automatically go to the next line in there is no room left in the current line. console_autowrap_on Turn the autowrap mode on console_clear Clear the console window console_close Close the console window. All characters received from the serial device will not be written to the window. This "blind way" to work can be useful in combination with scripts or XCMD with automatic connections. This mode is much more quicker than when all characters are written ro the window. Note that "memory" (see XCMD.doc and SCRIPTS.doc) and capture are still working when they are on. console_echo_off Turn console window echo of each typed characters off. console_echo_on Turn console window echo of each type character on. console_font "nom.font" size Change current font used in console window. Note that the console.device is better in handling only non-proportional fonts. console_map_key numero "command" Map a string command to a function key. Numbers 1 to 10 are functions keys F1 to F10 and numbers 11 to 20 are functions keys <shift><F1> to <shift><F10>. For example : console_map_key 1 "serial_send \"ATDT3600\n\"" map the command serial_send "ATDT3600\n" to the function key F1. The character \ allows the insertion of special character : \n is RETURN (x0D) and \l is LINE FEDD (x0A). \\ and \" allow the insertion of \ and " respectively. Here are some examples that can be found in term.config : # # Examples of function keys mapping # # shift-F10 to quit Term without confirm console_map_key 20 "rexx \"quit.rexx\"" # F10 to start XCMD Laser console_map_key 10 "rexx \"laser.rexx\"" # F9 to disconnect Hayes modem console_map_key 9 "serial_send \"+++\"" # F1 to dial my favorite BBS : console_map_key 1 "serial_send \"ATDT999999\n\"" console_open Open a console window. Use options the user asked for : number of colors, gadgets, screen, etc... console_setfont Give acces to a standard font requester to change the font used in the console window. menu_long_on Put long menu on menu_off Remove the menu from the window menu_short_on Put short menu off option_load "file" Read and execute all commands include in "file". term.config is a good example of such a file. When starting, Term II attempts a option_load "term.config" to initialize itself. option_save "file" Save all parameters to "file". Parameters are written as commands that can be excuted with option_load. The "Save config..." option of the "Project" menu perform a option_save "term.config". panel This option starts the panel XCMD. See the PANEL.doc for more informations on how to use and program the panel. phone_book Start the phone book XCMD. See the file PHONE.doc for more informations on how to use the phone book. quit Quit Term II, and free all ressources allocated while running. If the XCMD Panel or Phone Book have been loaded during execution time, they will be stopped and removed from memory. rexx "file" Start "file" as an ARexx script. RexxMaster must be running in the background for this function to work. rexx_delay delai Perform a delay. Can be called only from an ARexx script. See the SCRIPTS.doc file. rexx_memory_off Turn "rexx memory" off. Can be called only from an ARexx script. See the SCRIPTS.doc file. rexx_memory_on Turn "rexx memory" on. Can be called only from an ARexx script. See the SCRIPTS.doc file. rexx_wait delai1 delai2 Wait for characters incoming from the serial device. Will wait for delai1 (in seconds) without receiving anything. Then, will returned when no characters are received for delai2 (in seconds). Can be called only from an ARexx script. See the SCRIPTS.doc file. serial Open the control panel for the serial device. This panel allows the user to set easily all RS232 parameters. serial_baud baud Set serial baud of serial.device serial_buffer taille Set buffer size of internal read buffers of the serial device. serial_close Close the serial device serial_length length Set length of word echanged through the serial.device. Length can be either 7 or 8. serial_off This is an important command for XCMD or ARexx scripts. When this command is performed, Term II will stop reading the serial device. Reads will be performed only when an ARexx script or an XCMD asks for it (for example with xcmd_sread). After a serial_off, Term can't update the "memory" used in ARexx or XCMD (see the file SCRIPTS.doc and XCMD.doc). serial_on Turn serial_on, reverse of serial_off : this allow Term to read the serial device as soon as a character is received. serial_open "serial.device" unit Open the serial device. "serial.device" is the name of the device to used (usually "serial.device" in DEVS:, but could be "IGGY:pop/other.device". Unit is the number of the unit of the selected device to use. Usually 0 (0 is the default, that is the one as defined in the Workbench preferences). Other units or devices can be used with multi-serial cards. serial_parity parity Set parity used by the serial.device. 5 kinds of parity can be used, so "parity" is one of the following number : 0 (odd), 1 (even), 2 (no parity), 3 (space), 4 (mark). serial_send "string" Send "string" to the serial.device serial_stop stop Set the number of stop bits. Can be either 1 or 2 serial_xdisabled Turn XON/XOFF off. serial_xenabled Turn XON/XOF on. window_backdrop_off Use a non-backdrop window. Take effect with the next console_open. window_backdrop_on Use a backdrop window. Take effect with the next console open. window_borderless_off Use a non-borderless window. Take effect with the next console_open. window_borderless_on Use a borderless window. Take effect with the next console_open. window_closegadget_off Use a window with no close gadget. Take effect with the next console_open. window_closegadget_on Use a window with a close gadget. Take effect with the next console_open. window_color number Set the number of colors for the screen. Can be one of 2, 4 or 8 (NOTE: there is no color requester yet). Take effect with the next console_open. window_dragbar_off Use a window without dragbar. Take effect with the next console_open. window_dragbar_on Use a window with a dragbar. Take effect with the next console_open. window_options Open control panel for window options. window_publicscreen_default Use the default public screen for Term II window. Take effect with the next console_open. window_publicscreen_name "name" If asked for use a public screen, Term II will used the "name" public screen (if it is already opened). Take effect with the next console_open. window_screen_public Ask Term II to use a public screen. The name of the public screen to use must be given with window_publicscreen_name. window_screen_term Tell Term II to use its own screen. This screen will be the new default public screen. window_screen_workbench Tell Term II to use the Workbench screen to open its window. Take effect with the next console_open. window_sizegadget_off Tell Term II no to put a size gadget on its window. Take effect with the next console_open. window_sizegadget_on Tell Term II to add a size gadget to its window. Take effect with the next console_open. window_termscreen_interlace_off Tell Term II not to use an interlace screen. Take effect with the next console_open. (valid only if window_screen_term used). window_termscreen_interlace_on Tell Term II to use an interlace screen. Take effect with the next console_open. Valid only if used with window_screen_term. window_termscreen_shanghai_off Tell Term II not to use a shanghai screen window_termscreen_shanghai_on Terll Term II to use a a shanghai screen xcmd_delay XCMD-only command to perform a delay. See XCMD.doc. xcmd_lock_request XCMD-only command to get locks on Term screen and Term directory. See XCMD.doc. xcmd_memory_request XCMD-only command to get the XCMD "memory". See XCMD.doc. xcmd_memory_off XCMD-only command to turn "memory" off. See XCMD.doc. xcmd_memory_on XCMD-only command to turn "memory" on. See XCMD.doc. xcmd_setserial XCMD-only command to set serial device parameters. See XCMD.doc. xcmd_sflush XCMD-only command to flush the serial device. See XCMD.doc. xcmd_squery XCMD-only command to query the serial device about the number of characters waiting to be read. See XCMD.doc. xcmd_sread XCMD-only command to read characters from the serial device. See XCMD.doc. xcmd_start "port" Use this command to send a START message to an external process. For example, to start the panel XCMD, type xcmd_start "PANEL_PORT" xcmd_stop "port" Use this command to send a STOP message to an external process. xcmd_swrite XCMD-only command to write characters to the serial.device. See XCMD.doc. xcmd_wait XCMD-only command to read characters from the serial device. See XCMD.doc. xpr Open control panel for the XPR facilities. xpr_close Close an opened xpr library. xpr_down_dir "directory" Set the directory for the download requester. xpr_init "init" Send an init string to the current XPR library. See the documentation of your XPR library for a description of this init string. xpr_open "LibName" Open an XPR library. xpr_open_ Open an XPR library. A standard file requester will open to get the name of the library to use. xpr_receive "name" Download a file using the current XPR library. xpr_receive_ Download a file using the current XPR library. A standard file requester will open to get the name of the file to download (depends on the XPR used. ZModem will not allow the opening of a file requester). xpr_send "name" Upload a file using the current XPR library xpr_send_ Upload a file using the current XPR library. A standard file requester will open to get the name of the file(s) to upload. xpr_setup Set parameters of the current XPR library xpr_up_dir "directory" Set upload directory.