EDGE V1.70 Part 5 ========== -=-=-=- RequestKey ---------- FORMAT RequestKey TITLE/K,ALTSAME/N,SHIFTSAME/N,QMALT/N,QMSHIFT/N,SAMPLE/S DESCRIPTION Puts up the EnterAKey requester to prompt the user to input a key-sequence. INPUTS TITLE - The requester window title, or nothing for default. ALTSAME - Set the state of the ALTSAME flag, 0 will clear it, any other value will set it, if not specified the setting of ALTSAME in _GE_Flags will be used. If ALTSAME is set left Alt and right Alt are equal; i.e. it doesn't matter which Alt key is pressed. SHIFTSAME - Set the state of the ALTSHIFT flag, 0 will clear it, any other value will set it, if not specified the setting of ALTSHIFT in _GE_Flags will be used. If SHIFTSAME is set left Shift and right Shift are equal; i.e. it doesn't matter which Shift key is pressed. QMALT - Set the state of the QMALT flag, 0 will clear it, any other value will set it, if not specified the setting of QMALT in _GE_Flags will be used. If QMALT is set the Qualifier mask will include Alt; i.e. the Alt keys as such are ignored. QMSHIFT - Set the state of the QMSHIFT flag, 0 will clear it, any other value will set it, if not specified the setting of QMSHIFT in _GE_Flags will be used. If QMSHIFT is set the Qualifier mask will include Shift; i.e. the Shift keys as such are ignored. SAMPLE - Start sampling immediately; i.e. you don't have to click on the 'Sample' gadget. RESULTS The key-sequence the user entered, as 'KEY="" Q="" QM=""' RequestNotify ------------- FORMAT RequestNotify TITLE/K,STRING/A/F DESCRIPTION This requester is used to notify the user of something and it can only be satisfied with an 'OK' type of response. INPUTS TITLE - The requester window title. STRING - The actual message. RequestNumber ------------- FORMAT RequestNumber TITLE/K,DEFAULT/N,MIN/N,MAX/N,SHOWLIMITS/S DESCRIPTION This requester is used to prompt the user for a decimal number. INPUTS TITLE - The requester window title, or nothing for default. DEFAULT - The preloaded number. MIN - The minimum value the user may enter. MAX - The maximum value the user may enter. SHOWLIMITS - Show the limits in a box under the string gadget. RESULTS The number the user entered. RequestChoice ------------- FORMAT RequestChoice TITLE/K,STRING/A/F,PG=POSITIVEGADGET/K,NG=NEGATIVEGADGET/K DESCRIPTION This requester is used to prompt the user about an OK/cancel type of decision. INPUTS TITLE - The requester window title, or nothing for default. STRING - Text describing the matter the user is supposed to decide about. PG - Specify text to replace 'OK' in the OK gadget. NG - Specify text to replace 'Cancel' in the Cancel gadget. RequestString ------------- FORMAT RequestString TITLE/K,DEFAULT,TRANSLATE/S DESCRIPTION This requester is used to prompt the user for a string. A special error will be reported if the user enters a null-string and OK's the requester with the RETURN key. If the TRANSLATE switch is given, 'non-printing' characters will be translated to '\\xxx' in the result string. Edge maintains a history of the RequestString (global) gadget. To cycle through the list, simply use the Cursor Up/Down keys. Shift Cursor Down will move to the start of the list and clear the gadget. Shift Cursor Up will search the list for the string currently in the gadget (just like the shell). None of the history files can be saved. INPUTS TITLE - The requester window title, or nothing for default. DEFAULT - The preloaded string. TRANSLATE - Translate 'non-printing' characters to '\\xxx'. RESULTS The string the user typed. RX -- FORMAT RX PORT/K,SYNC/S,FILEREQ/S,PATH/K,FILE/K,PATTERN/K,STOP=STOPLEARNING/S, COMMAND/F DESCRIPTION Sends an ARexx command to the specified port following the PORT keyword, or to ARexx if no port is specified. Sends an ARexx command asynchronously, or synchronously if SYNC is specified. If no command is given, the user will be prompted with an 'Enter a String' requester. The user may then enter a string to send (internal command, ARexx string-program, or the name of a script). If FILEREQ, PATH, FILE or PATTERN is specified and no command is given, then the user will be prompted with a FileRequester in order to select an ARexx-script to run. When a command is sent synchronously, user input is blocked in the sending window until the command returns. Asynchronous commands do not block the sending window. This command cannot be nested; i.e. you can't use RX to run RX again. If the STOP switch is present and if a macro is currently being recorded, recording will stop; all other arguments are ignored. Edge maintains a history of the RX (local) string gadget. To cycle through the list, simply use the Cursor Up/Down keys. Shift Cursor Up will move to the top of the list; Shift Cursor Down will move to the bottom of the list. Shift Cursor Down will move to the start of the list and clear the gadget. Shift Cursor Up will search the list for the string currently in the gadget (just like the shell). None of the history files can be saved. INPUTS SYNC - Send the command synchronously. No entry signifies asynchronously sending the command. COMMAND - The command string to send, or nothing to prompt the user. FILEREQ - Bring up a FileRequester instead of an Enter a String requester. PATH - Path specification for the FileRequester. If not specified the last path used is used, initial default is 'Rexx:'. FILE - File specification for the FileReqeuester. If not specified the last file used is used, initial default is nothing. PATTERN - Pattern matching string for the FileRequester. If not specified the last pattern used is used, initial default is .edge. STOP - Stop macro recording. Useful for ARexx scripts that should not be callable from a recorded macro. Save ---- FORMAT Save ICON/S,NOICON/S,BACKUP/S,NOBACKUP/S DESCRIPTION Saves the current file with the current name. INPUTS ICON - Force creation of an icon for the file. NOICON - Suppress icon creation for the file. BACKUP - Force creation of a backup for the file. NOBACKUP - Suppress backup creation for the file. RESULTS The filename used to save the file. SaveAs ------ FORMAT SaveAs FILENAME,FORCE/S,ICON/S,NOICON/S,BACKUP/S,NOBACKUP/S DESCRIPTION Saves the current file with a new name. If the name is not given, the user will be prompted with the FileRequester to enter a filename. The FORCE switch suppresses the requester that will pop up if the file already exists, asking the user if it is OK to overwrite it. INPUTS FILENAME - The new filename, or nothing to prompt the user. FORCE - Suppress the requester asking the user if overwriting is OK. ICON - Force creation of an icon for the file. NOICON - Suppress icon creation for the file. BACKUP - Force creation of a backup for the file. NOBACKUP - Suppress backup creation for the file. RESULTS The filename used to save the file. SaveChanges ----------- FORMAT SaveChanges ICONS/S,NOICONS/S,BACKUPS/S,NOBACKUPS/S DESCRIPTION Saves all files in Edge that have been changed, using their current name. INPUTS ICONS - Force creation of icons for all files saved. NOICONS - Suppress icon creation for all files saved. BACKUPS - Force creation of backups for all files saved. NOBACKUPS - Suppress backup creation for all files saved. SaveClip -------- FORMAT SaveClip FILENAME,FORCE/S,GC=GLOBALCLIP/S,ICON/S,NOICON/S DESCRIPTION Saves either the global or the local clip, depending on the GLOBALCLIP switch, with the given name. If the filename is not present, the user will be prompted with the FileRequester to specify a filename. The FORCE switch is used to suppress the requester that will pop up if the selected file already exists. If no icon switch is given icon creation will take place as defined by the files ICON flag in _FE_Flags. INPUTS FILENAME - The name to use, or nothing to prompt the user. FORCE - Suppress the requester asking the user if overwriting is OK. GLOBALCLIP - Select the global clipboard. ICON - Force creation of an icon for the file. NOICON - Suppress the creation of an icon for the file. RESULTS The filename used to save the clip. SaveDictionary -------------- FORMAT SaveDictionary FILENAME,FORCE/S DESCRIPTION Saves the dictionary to the file with the given name. If no name is given, the default name, either EdgePrg:Edge.dictionary or the name defined by you at startup with the DICTIONARY keyword/tooltype, is used. The FORCE switch is used to suppress the requester that will pop up if the file already exists, asking you if overwriting is OK. INPUTS FILENAME - Name of the file to use, or nothing for the default Dictionary File. FORCE - Suppress the requester asking you if overwriting is OK. SaveENV ------- FORMAT SaveENV FILENAME,GE/S,LE/S,DEFLE/S,FORCE/S,PATTERN DESCRIPTION Saves the Edge environment variables to a file with the given name. If no name is given, the user will be prompted with the FileRequester to enter a filename. The FORCE switch is used to suppress the requester that will pop up if the selected file already exists. You may choose to save Global, Local, Default Local or any mix of variables in the save file. PATTERN is used to select which variables to save and supports @{"wildcard" link DosWildCards} expansion. If no PATTERN is given all variables are enabled. INPUTS FILENAME - The filename to use, or nothing to prompt the user. GE - Save Global environment variables. LE - Save Local environment variables. DEFLE - Save the Default Local environment variables. FORCE - Suppress the requester asking the user if overwriting is OK. PATTERN - Pattern to select which variables to save, or nothing for all. RESULTS The filename used to save the preferences. SaveKeyboard ------------ FORMAT SaveKeyboard FILENAME,FORCE/S DESCRIPTION Saves the keyboard definition to a file with the given name. If no name is given, the default name, either EdgePrg:Edge.keyboard or the name defined by the user at startup with the KEYBOARD keyword/tooltype, is used. INPUTS FILENAME - Name of the file to use, or nothing for the default one. FORCE - Suppress the requester asking the user if overwriting is OK. SaveMenus --------- FORMAT SaveMenus FILEANME,FORCE/S DESCRIPTION Saves the menu definition to a file with the given name. If no name is given, the default name, either EdgePrg:Edge.menus or the name defined by the user at startup with the MENUS keyword/tooltype, is used. INPUTS FILENAME - Name of the file to use, or nothing for the default one. FORCE - Suppress the requester asking the user if overwriting is OK. SaveMouseButtons ---------------- FORMAT SaveMouseButtons FILENAME,FORCE/S DESCRIPTION Saves the mouse button configuration to the file with the given name. If no name is given, the default name, either EdgePrg:Edge.mousebuttons or the name defined by you at startup with the MOUSEBUTTONS keyword/tooltype, is used. INPUTS FILENAME - Name of the file to use, or nothing for the default one. FORCE - Suppress the requester asking the user if overwriting is OK. SaveTexts --------- FORMAT SaveTexts FILENAME,FORCE/S DESCRIPTION Saves the text table configuration and Edge texts to the file with the given name. If no name is given, the default name, either EdgePrg:Edge.texts or the name defined by the user at startup with the TEXTS keyword/tooltype, is used. INPUTS FILENAME - Name of the file to use, or nothing for the default one. FORCE - Suppress the requester asking the user if overwriting is OK. SaveTemplates ------------- FORMAT SaveTemplates FILENAME,FORCE/S DESCRIPTION Saves the template configuration to the file with the given name. If no name is given, the default name, either EdgePrg:Edge.templates or the name defined by you at startup with the TEMPLATES keyword/tooltype, is used. The FORCE switch is used to suppress the requester that will pop up if the file already exists, asking if overwriting is OK. INPUTS FILENAME - Name of the file to use, or nothing for the default one. FORCE - Suppress the requester asking you if overwriting is OK. ScreenMode ---------- FORMAT ScreenMode MONITOR,WIDTH/N,HEIGHT/N,DEPTH/N,DETAILPEN/N,BLOCKPEN/N, TEXTPEN/N,SHINEPEN/N,SHADOWPEN/N,FILLPEN/N,FILLTEXTPEN/N, BACKGROUNDPEN/N,HIGHLIGHTTEXTPEN/N,BARDETAILPEN/N, BARBLOCKPEN/N,BARTRIMPEN/N DESCRIPTION Changes the Edge screen mode. You may alter the width, height, depth, display mode and the 'pens' of the screen. Pen numbers should be color register numbers consistent with the palette depth (number of colors): A depth of 2 results in 4 colors in registers 0 - 3; A depth of 3 results in 8 colors in registers 0 - 7; A depth of 4 results in 16 colors in registers 0 - 15; NOTE: The Background pen is always color 0. INPUTS MONITOR - Display to use e.g. 'PAL:Hires' or 'NTSC:Hires-Interlace', or the name of a public screen, e.g. 'Workbench:Use'. WIDTH - The width of the screen, -1 for default. HEIGHT - The height of the screen, -1 for default. DEPTH - The number of bitplanes to use (1 - 3). DETAILPEN - Compatible Intuition rendering pens BLOCKPEN - Compatible Intuition rendering pens TEXTPEN - Text on background SHINEPEN - Bright edge on 3D objects SHADOWPEN - Dark edge on 3D objects FILLPEN - Active-window/selected-gadget fill FILLTEXTPEN - Text over FILLPEN BACKGROUNDPEN - Always color 0 HIGHLIGHTTEXTPEN - Special color text, on background NOTE: These pens are only available under Kickstart v39 or better BARDETAILPEN - Text/detail in screen-bar/menus BARBLOCKPEN - Screen-bar/menus fill BARTRIMPEN - Trim under screen-bar Select ------ FORMAT Select FILENAME,FULLNAME,TOP/S,BOTTOM/S,NEXT/S,PREVIOUS/S DESCRIPTION Selects a new current file to work with. Activates the first window in the specified file for USER input. Take care when using this function from ARexx, since the host address doesn't change. If you wish to change the host address to that of the activated window you must 'address value result' using the result from this function. If no filename and no switches are given the user is prompted with a requester to enter a filename. Edge maintains a history of the Select (global) string gadget. To cycle through the list, simply use the Cursor Up/Down keys. Shift Cursor Up will move to the top of the list; Shift Cursor Down will move to the bottom of the list. Shift Cursor Down will move to the start of the list and clear the gadget. Shift Cursor Up will search the list for the string currently in the gadget (just like the shell). None of the history files can be saved. INPUTS FILENAME - Activate the first window in the given file; the search is made ignoring the Edge path components. FULLNAME - Activate the first window in the given file; the search is made taking into account the Edge path componets. TOP - Activate the first window in the first file. BOTTOM - Activate the last window in the last file. NEXT - Activate the next window in the window list. PREVIOUS - Activate the previous window in the window list. NOTE NEXT and PREVIOUS are circular, which means that if the current window is the last one and you specify NEXT you will activate the first window in the first file, and if the current window is the first one and you specify PREVIOUS you will activate the last window in the last file. You may only specify one of the switches at a time. RESULTS The ARexx-address of the activated window. SetBookMark ----------- FORMAT SetBookMark MARK/A/N DESCRIPTION Sets a bookmark in the text. The mark number must be within the valid range 1 - 10. INPUTS MARK - Bookmark number to use. SwapCase -------- FORMAT SwapCase CHAR/S,WORD/S,BACK/S,LINE/S,SOL/S,EOL/S,BLOCK/S DESCRIPTION Swaps case on characters, to upper if lower; and to lower if upper, in some different and useful ways. INPUTS CHAR - Change the character under the cursor. The cursor is moved to the right. WORD - Change the word beginning under and extending to the right of the cursor. The cursor is moved to the right. BACK - This flag only works together with CHAR and WORD. If BACK is used, the text to the LEFT of the cursor is changed instead of the text to the right. The cursor is moved to the left. LINE - Change the entire current line. The cursor is moved to the line below. SOL - Change all characters from the start of the line to the cursor, not including the character under the cursor. The cursor is moved to SOL. EOL - Change all characters from the cursor, including the character under the cursor, to the end of the line. The cursor is moved to EOL. BLOCK - Change the currently selected block. Template -------- FORMAT Template TEMPLATE/A,ASK/S,FORCE/S,FILL/F DESCRIPTION Inquires about, removes or adds a template to the template configuration. INPUTS TEMPLATE - The template you wish to affect. ASK - Switch used to inquire about the fill-text currently assigned to the given TEMPLATE. FILL - The fill-text you wish to assign to the given TEMPLATE. To include non-printing characters use decimal codes: '\\xxx' e.g. '\\169' = '-' '\\065' = 'A', '\\010' = LF, etc. FORCE - Switch to suppress the 'OK to overwrite' requester that will pop up if TEMPLATE already exists. EXAMPLES Template ff ask ; inquire about template 'ff' Template ff force ; remove template 'ff'; i.e. assign it a fill-text ''. RESULTS The old fill-text assigned to TEMPLATE. Text ---- FORMAT Text TEXT/A,RAW/S DESCRIPTION Inserts or overwrites characters in the file at the current cursor position. The characters to be written must be quoted, and in order to use non-printable characters use backslash and a three digit decimal number, e.g. "\\010" for LF, "\\009" for TAB, "\\065" for A, etc. Normally the characters are inserted one by one and are affected by AUTOINDENT, CORRECTCASE and WORDWRAP. However - if the RAW switch is specified, then the text is inserted as a block in one go which is much faster, but AUTOINDENT, CORRECTCASE and WORDWRAP are bypassed. INPUTS RAW - Switch to bypass AUTOINDENT, CORRECTCASE and WORDWRAP. TEXT - The characters to be inserted. RESULTS The new position will be returned with the format: Line Offset Column ASCII All fields are decimal numbers. Undo ---- FORMAT Undo , DESCRIPTION To undo changes made to the file. UpperCase --------- FORMAT UpperCase CHAR/S,WORD/S,BACK/S,LINE/S,SOL/S,EOL/S,BLOCK/S DESCRIPTION Converts characters to upper case in some different and useful ways. INPUTS CHAR - Change the character under the cursor. The cursor is moved to the right. WORD - Change the word beginning under and extending to the right of the cursor. The cursor is moved to the right. BACK - This flag only works together with CHAR and WORD. If BACK is used, the text to the LEFT of the cursor is changed instead of the text to the right. The cursor is moved to the left. LINE - Change the entire current line. The cursor is moved to the line below. SOL - Change all characters from the start of the line to the cursor, not including the character under the cursor. The cursor is moved to SOL. EOL - Change all characters from the cursor, including the character under the cursor, to the end of the line. The cursor is moved to EOL. BLOCK - Change the currently selected block. Wakeup ------ FORMAT Wakeup , DESCRIPTION Uniconifies Edge, if iconified; else does nothing. Window ------ FORMAT Window SV=SPLITVERTICAL/S,SH=SPLITHORIZONTAL/S,CLOSE/S,FORCE/S, FORCEREXX/S,FORCEOK/S,SNAPSHOT/S,MIN/S,MAX/S,FRONT/S,BACK/S, ZOOM/S,UNZOOM/S,ZIP/S DESCRIPTION This is a powerful window manipulating command. It will allow you to split a window into two windows, vertically or horizontally, close a window, snapshot a window so that the next time you load the file the window will have the same size and position (providing you have elected to save the local settings with the file), resize, zip, zoom, unzoom and move a window in front of all windows or behind all windows. INPUTS SPLITVERTICAL - Split the current window in two, vertically. SPLITHORIZONTAL - Split the current window in two, horizontally. CLOSE - Close the current window. FORCE - Suppress the requester that will pop up if this window is the last one in the file and the file contains changes, asking if losing the changes is OK. FORCEREXX - Suppress the 'ARexx outstanding msg' requester that will appear if running this command from ARexx, or if any other scripts are still out there. FORCEOK - Suppress the 'OK to quit file 'xx'' requester that will pop up if this window is the last in the file and no changes are made. SNAPSHOT - Snapshot the current window. MAX - Resize the current window to its maximum size. MIN - Resize the current window to its minimum size. FRONT - Bring the current window in front of all other windows. BACK - Move the current window behind all other windows. ZOOM - Zoom the current window. UNZOOM - UnZoom the current window. ZIP - Either Zoom or UnZoom the current window depending on its current state (zoomed or unzoomed). NOTE If a window is Zoomed when you make a snapshot, the size/position will be stored in the zoom size/position variables. The result returned from this command is the state the window was in BEFORE it was changed, zoomed, min, max, etc. RESULTS The window position, size and ARexx-address is returned with the format: X x, Y y, W w, H h, ARexx-address, ZoomFlag ('Zoomed' or 'UnZoomed') x, y, w and h are decimal numbers. X, Y, W, and H are the actual letter. EXAMPLE Here is a typical result string returned: X 0, Y 0, W 640, H 200, EDGE1.1.1, UnZoomed WindowTitle ----------- FORMAT WindowTitle MESSAGE/A,DISPLAYTIME/N DESCRIPTION Displays a message in the title bar of the current ARexx command host's text window, and shows it for DISPLAYTIME seconds. If no DISPLAYTIME is given the message will be displayed for 4 seconds. INPUTS MESSAGE - Message text to show. DISPLAYTIME - How long to show it, no entry uses default which is 4. Environment ----------- The Edge environment variables and flags. Edge has one global environment that contains settings used by all files, and then each file has its own local environment as well. The local environment is actually divided into 2 parts, one large section, the File environment, and then for each window in the file a small section known as the Window environment. NOTE: There is no file for window environment variables since they are dynamic and depend on the opened window conditions. The window variables are accessible through GetEnvVar and PutEnvVar. Actual Environment Files These environment, or prefs, files may also contain an INCLUDE directive to include another prefs file into the current one. INCLUDEs may be nested up to 8 levels deep before an error is reported. GlobalEnvVars ------------- Global Environment Variables _GE_ASLHeight Read Write The ASL Requester height stored here. _GE_ASLWidth Read Write The ASL Requester width stored here. _GE_AutoSaveTimer Read Write Time between autosaves. (minutes) _GE_BarHeight Read Only Window title bar height, calculated as: WBorTop + RastPort.TxHeight + 1 _GE_ClipUnit Read Write 'clipboard.device' unit number use by the global clip, normally this is 0, system default clipboard, so that you may exchange data with other programs. Should you wish to create a 'private' global clip just change this variable. _GE_ClockLeftEdge Read Write The pixel X position for the Edge clock. _GE_CloseDelay Read Write Close delay for the ARexx console, in seconds. _GE_CurrentDir Read Only Current directory path. _GE_CX_PopKey Read Write Hotkey description, 31 chars. _GE_CX_Priority Read Write Hotkey priority. _GE_Date Read Only String containing current time and date. _GE_DevName Read Only The editor device name, e.g. "EDGE" _GE_DictionaryFile Read Only Filename of the dictionary file. _GE_DirInk Read Write Text pen for FileRequester directories. This option is only available with Kickstart v39 or higher. _GE_ErrLevel Read Write Threshold for errors reported to the user. _GE_ErrListX Read Write X coordinate for the Error list window in GotoError. _GE_ErrListY Read Write Y coordinate for the Error list window in GotoError. _GE_FileInit Read Write Init string for printing file, 127 chars. _GE_FileInk Read Write Text pen for FileRequester files. This option is only available with Kickstart v39 or higher. _GE_Files Read Only Number of files in Edge. _GE_FindX Read Write X coordinate for Find/FindReplace. _GE_FindY Read Write Y coordinate for Find/FindReplace. _GE_Flags Read Write General flags, see Global Environment Flags - General _GE_FontFlags Read Only Soft Style flags, see Global Environment Flags - Font _GE_FootInit Read Write Footer init string, 127 chars. _GE_FootTitle Read Write Footer title, 127 chars. _GE_GadgetFontName Read Only Name of the gadget font, use empty string "" for system default font, max 31 chars. _GE_GadgetFontSize Read Only Size of the gadget font, 6 to 64, values out of range will be set to the nearest limit. _GE_GlobalFile Read Only Filename of the global settings prefs file. _GE_GlobalPattern Read Write GlobalSettings FileReq pattern, 31 chars. _GE_GlobalX Read Write X coordinate for GlobalSettings. _GE_GlobalY Read Write Y coordinate for GlobalSettings. _GE_HeadInit Read Write Header init string, 127 chars. _GE_HeadTitle Read Write Header title, 127 chars. _GE_IconWindowX Read Write Left edge for iconified Edge window. _GE_IconWindowY Read Write Top edge for iconified Edge window. _GE_InfoInk Read Write Text pen for status line. _GE_InfoPaper Read Write Background pen for status line. _GE_ItemInk Read Write Text pen for menu items. _GE_KeyboardFile Read Only Filename of the keyboard config file. _GE_LeftMargin Read Write Printer left margin. _GE_ListInk Read Write Text pen for lists-view gadgets. This option is only available with Kickstart v39 or better. _GE_LocalFile Read Only Filename of the local settings prefs file. _GE_LocalLoadMask Read Write Pattern for variables to be loaded from the files icon, 1023 chars. _GE_LocalSaveMask Read Write Pattern for variables to be saved in the files icon, 1023 chars. _GE_LockCount Read Only Locks made to 'EDGE:'. _GE_LocalX Read Write X coordinate for LocalSettings. _GE_LocalY Read Write Y coordinate for LocalSettings. _GE_MaxLast Read Write Max entries in the Last-Used list. _GE_MemPoolPudSize Read Write The size of the memory pool puddle value: minimum size 4096 bytes, no maximum value. _GE_MenusFile Read Only Filename of the menus config file. _GE_MessageInk Read Write Text pen for messages. _GE_Monitor Read Only Name of the monitor to use, 255 chars. _GE_MouseButtonsFile Read Only Filename of the mousebuttons config file. _GE_Palette Read Write The Edge custom screen palette. The palette is made up of hexadecimal RGB values, starting at pen 0. e.g. pen 0 R,G,B, pen 1 R,G,B, ... pen 15 R,G,B _GE_PaperLen Read Write Printer paper length. _GE_Printer Read Write Printer device, e.g. 'PRT:', 31 chars. _GE_Priority Read Write Edge process priority. _GE_PrtFlags Read Write Printer flags, see @{"Global Environment Flags - Printer" link globalenvflags} _GE_PunctuationMarks Read Write String of characters that marks the end of a sentence, used by Format. Defaults to "!.?", max 31 characters. _GE_RealGadgetFontName Read Only Actual name of the gadget font. _GE_RealGadgetFontSize Read Only Actual size of the gadget font. _GE_RealScreenFontName Read Only Actual name of the screen font. _GE_RealScreenFontSize Read Only Actual size of the screen font. _GE_RealScreenHeight Read Only The actual screen height in pixels. _GE_RealScreenWidth Read Only The actual screen width in pixels. _GE_RealTextFontName Read Only actual name of the text font. _GE_RealTextFontSize Read Only actual size of the text font. _GE_ReqChoiceX Read Write X coordinate for RequestChoice. _GE_ReqChoiceY Read Write Y coordinate for RequestChoice. _GE_ReqFile Read Only Filename of the req config file. _GE_ReqKeyX Read Write X position of RequestKey window when not pointer relative. _GE_ReqKeyY Read Write Y position of RequestKey window when not pointer relative. _GE_ReqFileX Read Write X coordinate for RequestFile (and ASL). _GE_ReqFileY Read Write Y coordinate for RequestFile (and ASL). _GE_ReqNotifyX Read Write X coordinate for RequestNotify. _GE_ReqNotifyY Read Write Y coordinate for RequestNotify. _GE_ReqNumberX Read Write X coordinate for RequestNumber. _GE_ReqNumberY Read Write Y coordinate for RequestNumber. _GE_ReqStringX Read Write X coordinate for RequestString. _GE_ReqStringY Read Write Y coordinate for RequestString. _GE_RexxConsole Read Write ARexx IO name, e.g. "con:...", 127 chars. _GE_RexxMsgOut Read Only Total number of ARexx messages sent. _GE_RightMargin Read Write Printer right margin. _GE_ScreenDepth Read Only Edge screen depth, 2 to 4, values out of range will be set to the nearest limit. _GE_ScreenFontName Read Only Name of the gadget font, use empty string "" for system default font, max 31 chars. _GE_ScreenFontSize Read Only Size of the screen font, 6 to 64, values out of range will be set to the nearest limit. _GE_ScreenHeight Read Only Edge screen height. _GE_ScreenName Read Only Name of the screen Edge is using. _GE_ScreenPens Read Only The Edge custom screen dri pens, defaults to 2,1,1,2,1,3,1,0,3,1,2,0. The pens are in the same order as the arguments to ScreenMode. _GE_ScreenWidth Read Only Edge screen width. _GE_ScreenX Read Only Screen relative x offset. _GE_ScreenY Read Only Screen relative y offset. _GE_ScrollJumpH1 Read Write Scroll smoothness for 1 char left/right. A value of -1 indicates the width of the current font. _GE_ScrollJumpHn Read Write Scroll smoothness for n chars left/right. A value of -1 indicates the width of the current font. _GE_ScrollJumpV1 Read Write Scroll smoothness for 1 line up/down. A value of -1 indicates the height of the current font. _GE_ScrollJumpVn Read Write Scroll smoothness for n lines up/down. A value of -1 indicates the height of the current font. _GE_SpacesAfterPunctuation Read Write Holds the designated number of spaces between the punctuation at the end of a sentence and the start of the next sentence to the given number during paragraph formatting. Default = 2. Min 1, Max 10 _GE_StartupFile Read Only Filename of the startup script. _GE_TabDistance Read Write Printer tab distance. _GE_TemplatesFile Read Only Filename of the templates file. _GE_TextFontName Read Only Name of the text font, use empty string "" for system default font, max 31 chars. _GE_TextFontSize Read Only Size of the text font, 6 to 64, values out of range will be set to the nearest limit. _GE_TextInk Read Write Text pen for text. NOTE: The number of bitplanes used when scrolling, etc, the text depends only on the color used, so for best speed and look you should select a pen that is a 2^n number; i.e. 1, 2, or 4. NOTE: The colors used to mark blocks are located in one of the planes not used by the text, so if you specify a text color that uses all bitplanes, you will not be able to see the block marking. _GE_ToolName Read Write The project-icon toolname, 127 chars. _GE_User0 Read Write User variable - 127 chars. _GE_User1 Read Write User variable - 127 chars. _GE_User2 Read Write User variable - 127 chars. _GE_User3 Read Write User variable - 127 chars. _GE_User4 Read Write User variable - 127 chars. _GE_User5 Read Write User variable - 127 chars. _GE_User6 Read Write User variable - 127 chars. _GE_User7 Read Write User variable - 127 chars. _GE_User8 Read Write User variable - 127 chars. _GE_User9 Read Write User variable - 127 chars. _GE_UserFlags Read Write User Flags, ignored by Edge. This field contains 32 flags 'F1 - 'F32', all available to the user. _GE_VisualScreenHeight Read Only Pixel height of visual screen area. _GE_VisualScreenWidth Read Only Pixel width of the visual screen area. _GE_WakeupFile Read Only Filename of the wakeup script. _GE_Windows Read Only This holds the number of windows opened. _GE_WndActComm Read Write Command to execute when a text window goes active, 127 chars, default "". _GE_WndCloseComm Read Write Command to execute when the user clicks on a textwindow closegadget, 127 chars, default "window close". _GE_WndDeActComm Read Write Command to execute when a text window goes inactive, 127 chars, default "". _GE_WndFlags Read Write Window flags, see Global Environment Flags - Window _GE_WordDelimiters Read Write The word-delimiter list. The string is 256 digits long, one digit for each character, consisting of '0', '1' and '2'. If the digit is a '1' the character is a 'word' character ('a', 'b', etc), if the digit is a '2' the character is a 'space' character (' ','\\t' and '\\n') and if the digit is a '0' then the character is neither a 'word' nor a 'space' ('.',':', etc). GlobalEnvFlags -------------- Global Environment Flags - General ( _GE_Flags ) AltSame In RequestKey both Alt keys the same; no left or right. AppIcon Puts an application icon on Workbench. ASLReq Use the ASL filerequester. AutoClock Enable clock if an Edge window is active, disable clock when no Edge window is active and not blocked by a requester. AutoDir Auto 'GetDir' when the FileRequesters directory attributes (path name and date) don't match with those of the specified directory. AutoSaveAll Save all files in the editor. AutoSaveChng Save only if any changes have been made. AutoSaveOn Auto save is active. AutoSaveReq Prompt the user before auto-saving. CacheDir The FileRequester caches directories. Clock Enable clock always. DornamtQuit Iconify instead of quit when the last window is closed. Edge will NOT iconify if there are any outstanding ARexx messages. All ARexx messages must return before Edge will iconify. GlobalIcon Create icon for GlobalSettings file. IconWindow Open a window on workbench when iconified. LoadLocal Load LocalSettings from icons. LocalIcon Create icon for LocalSettings file. MouseBlanker Enable the Edge mouse pointer blanker. QMAlt In RequestKey both Alts keys ignored as qualifiers. QMShift In RequestKey both Shift keys ignored as qualifiers. SaveLocal Save LocalSettings in icons. ShiftSame In RequestKey both Shift keys the same; no left or right. ShowDir Show dir/files during directory reads. CutRepeat Cut off overflowing 'REPEAT' keys. Global Environment Flags - Window ( _GE_WndFlags ) ---------------------------------------------------- AutoFront Auto move the window in front at activation. AutoUnZoom Auto unzoom window at activation. AutoZoom Auto zoom window at deactivation. ChoicePRel RequestChoice is pointer relative. ErrListPRel Error list, GoToError, is pointer relative. FilereqPRel RequestFile or ASL is pointer relative. FindPRel Find/FindReplace is pointer relative. GlobalPRel GlobalSettings is pointer relative. InfoTop Put status line at top of window. KeyPad Use 'KEYPAD' qualifier. KeyPRel RequestKey is pointer relative. LocalPRel LocalSettings is pointer relative. NotifyPRel RequestNotify is pointer relative. NumerPRel RequestNumber is pointer relative. ScrScroll Autoscroll the screen when the cursor moves beyond the visible part of the screen. This feature works only on Kickstart v39 or better. SnapSize Auto snap window size to even chars. StringPRel RequestString is pointer relative. Global Environment Flags - Printer ( _GE_PrtFlags ) ---------------------------------------------------- FootDate Put date in footer. FootName Put filename in footer. FootPage Put page # in footer. HeadDate Put date in header. HeadName Put filename in header. HeadPage Put page # in header. SpacesToTabs Convert spaces to tabs using internal tabs. TabsToSpaces Convert tabs to spaces using internal tabs. Global Environment Flags - Font ( _GE_FontFlags ) ------------------------------------------------- GadgetBold Bold style on gadget font. GadgetItalic Italic style on gadget font. GadgetScale Allow font scaling for gadget font. GadgetUnderline Underline gadget font. ScreenBold Bold style on screen font. ScreenItalic Italic style on screen font. ScreenScale Allow font scaling for screen font. ScreenUnderline Underline screen font. TextBold Bold style on text font. TextItalic Italic style on text font. TextScale Allow font scaling for text font. TextUnderline Underline text font. FileEnvVars ------------ File environment variables _FE_BackDir Read Write Backup directory path, max 95 chars. _FE_BackFile Read Write Backup file. If this field is blank the default backup file, *{#}, will be used, max 31 chars. * = the name of the file. # = current backup counter for this file. _FE_Changes Read Only Number of changes made to this file. _FE_ClipPath Read Write Path for the FileRequester used by the clip commands, 95 chars. _FE_ClipPattern Read Write Pattern for the FileRequester used by the clip commands, 31 chars. _FE_DosName Read Write Full name, e.g. "dh0:work/mysource.c", 126 chars. _FE_FindString Read Write The current find-string, 1023 chars _FE_Flags Read Write Flag field, see File Environment Flags. _FE_FoldEnd Read Write Fold end marker, max 31 chars, default '/*fe*/'. _FE_FoldStart Read Write Fold start marker, max 31 chars, default '/*fs*/'. _FE_Height Read Write Window height, -1 for default. _FE_IMark Read Write IMark image, used by FindIMark, max 31 chars. _FE_IncludePath Read Write Path for Include FileRequester, max 95 chars. _FE_IncludePattern Read Write Pattern for Include FileRequester, max 31 chars. _FE_LeftEdge Read Write Window left edge, -1 for default. _FE_LeftSB Read Write Left scroll border. _FE_Lines Read Only Number of lines in the file. _FE_LockCount Read Only Locks made to this file. _FE_LoweSB Read Write Lower scroll border. _FE_LocalPath Read Write Path for the FileRequester used by the LocalSettings command, 95 chars. _FE_LocalPattern Read Write Pattern for the FileRequester used by the LocalSettings command, 31 chars. _FE_MarkChar1 Read Write Bookmark 1, character offset. _FE_MarkChar10 Read Write Bookmark 10, character offset. _FE_MarkChar2 Read Write Bookmark 2, character offset. _FE_MarkChar3 Read Write Bookmark 3, character offset. _FE_MarkChar4 Read Write Bookmark 4, character offset. _FE_MarkChar5 Read Write Bookmark 5, character offset. _FE_MarkChar6 Read Write Bookmark 6, character offset. _FE_MarkChar7 Read Write Bookmark 7, character offset. _FE_MarkChar8 Read Write Bookmark 8, character offset. _FE_MarkChar9 Read Write Bookmark 9, character offset. _FE_MarkLine1 Read Write Bookmark 1, line number. _FE_MarkLine10 Read Write Bookmark 10, line number. _FE_MarkLine2 Read Write Bookmark 2, line number. _FE_MarkLine3 Read Write Bookmark 3, line number. _FE_MarkLine4 Read Write Bookmark 4, line number. _FE_MarkLine5 Read Write Bookmark 5, line number. _FE_MarkLine6 Read Write Bookmark 6, line number. _FE_MarkLine7 Read Write Bookmark 7, line number. _FE_MarkLine8 Read Write Bookmark 8, line number. _FE_MarkLine9 Read Write Bookmark 9, line number. _FE_MaxBackups Read Write Maximum number of backup copies to be cycled. _FE_Name Read Write Name of the file, e.g. "mysource.c", max 31 chars. _FE_OpenCount Read Only Opens made to this file. _FE_PageLen Read Write Page length for this file, minimum 1. _FE_Path Read Write Path for this file, e.g. "dh0:work/", max 95 chars. _FE_Pattern Read Write Pattern for Open/Save FileRequester, max 31 chars. _FE_ReplaceString Read Write The current replace-string, max 1023 chars _FE_RequestFilePath Read Write Path for the FileRequester used by the RequestFile command, 95 chars. _FE_RequestFilePattern Read Write Pattern for the FileRequester used by the RequestFile command, 31 chars. _FE_RightSB Read Write Right scroll border. _FE_RXName Read Write File for the FileRequester used by the RX command, 31 chars, default "". _FE_RXPath Read Write Path for the FileRequester used by the RX command, 95 chars, default "Rexx:". _FE_RXPattern Read Write Pattern for the FileRequester used by the RX command, max 31 chars, default #?.edge DosWildCards. _FE_RXString Read Write Current string in the RX buffer, max 1023 chars _FE_SavedChar Read Write Cursor offset when file was saved. _FE_SavedLine Read Write Cursor line when file was saved. _FE_Size Read Only Byte-size of the file. _FE_SmallClip Read Write The small clipboard buffer string, max 1023 chars. _FE_SmallClipType Read Write Type of clip, 0==normal, 1==columnar. _FE_TabList Read Write Tab stop list, 254 chars. _FE_TopEdge Read Write Window top edge, -1 for default. _FE_TopPtr Read Only Pointer to the first line. _FE_UndoBuff Read Write Byte-size of the undo buffer. _FE_UpperSB Read Write Upper scroll border. _FE_User0 Read Write Ten user variables, these are ignored _FE_User1 Read Write by Edge, max 127 chars. _FE_User2 Read Write _FE_User3 Read Write _FE_User4 Read Write _FE_User5 Read Write _FE_User6 Read Write _FE_User7 Read Write _FE_User8 Read Write _FE_User9 Read Write _FE_UserFlags Read Write User flags, these are ignored by Edge, contains 32 flags 'F1' - 'F32'. _FE_Width Read Write Window width, -1 for default. _FE_Windows Read Only Number of open windows in this file. _FE_WrapBorder Read Write Right border for Word Wrap and Format. _FE_ZoomHeight Read Write Window initial zoomed height, -1 for default. _FE_ZoomLeftEdge Read Write Window initial zoomed left edge, -1 for default. _FE_ZoomTopEdge Read Write Window initial zoomed top edge, -1 for default. _FE_ZoomWidth Read Write Window initial zoomed width, -1 for default. FileEnvFlags ------------ File Environment Flags ( _FE_Flags ) AutoIndent Auto indent enabled. Backup Make a backup when saving. Circular Search circular. CorrectCase Case correction enabled. Editable The file is editable. Forward Search forward in the file. Icon Create icon for this file. Insert Insert mode. (else overwrite mode) Layout Layout enabled. LineWrap Cursor wrap at line end/start. SafeSaves Do safe saves. ShowSpaces Show white spaces as '·' = space, '°' = tab and '¶' = LF. TabsToSpaces Convert tabs to spaces. UCEqlc Upper case is equal to lower case. Wild Use wildcards in search. Words Search only for whole words. WordWrap Word Wrap enabled. WindowEnvVars ------------- Window environment variables These variables are dependent upon the open window in Edge and are not kept in a file like the Global Enviroment variables '_GE_xxx', and the local environment variables named '_FE_xxx'. Instead they are dynamic and accessible whenever a window is open. Use the GetEnvVar and PutEnvVar commands to change these. _WE_ASCII Read Only Ascii value of the character under the cursor. _WE_ByteColumn Read Only Byte offset from start of line to the current cursor position. _WE_ByteOffset Read Only Byte offset from start of file to the current cursor position. _WE_CLine Read Only The raw contents of the current line. _WE_Column Read Only Current column number, first column is 0. _WE_Columns Read Only Number of chars that will fit in the window. _WE_CursorX Read Only Current cursor X position, 1st column is 0. _WE_CursorY Read Only Current cursor Y position, first line is 0. _WE_Line Read Only Current line number, first line is 0. _WE_Lines Read Only Number of lines that will fit in the window. _WE_Page Read Only Page number, first page is 1. _WE_RexxMsgOut Read Only The number of ARexx messages sent from this window. _WE_RexxPort Read/Write Name of this window's ARexx port, max 15 chars. Dos Wildcards ------------- The Amiga's Pattern Matching Wildcards... ? Matches any single character. For example, FI?E would match FILE, FINE and FIRE but not FIE. # Matches the following expression 0 or more times. For example, FRE#D would match FRE, FRED, FREDD, FREDDD, etc. #? will match anything. (a|b|c) Matches any one of the items seperated by '|'. For example, (D#?G|C#?T) would match DOG, CAT, DIG, COT, etc. ~ The tilde, the upper left key on most keyboards, negates the following expression. It matches all strings that do not match the expression. For example, F~(ROG)#? will match FROM but not FROG. ~J#? will match anything not starting with the letter J. [abc] A character class: matches only the characters in the class. For example, a[bcd] will match ab, ac and ad but not ae. [~abc] The tilde here indicates a negated character class: matches only the characters not in the class. For example, a[~bc] will match ad and ae but not ab and ac. [a-z] Character range (only within character classes). For example, [a-z] represents all the lowercase letters from a to z. [a-cx-z]#? would match any name starting with the letters a, b, c, x, y or z. % Matches the null string. For example, CA(M|%)P will match CAMP and CAP. ' The apostrophe, found on most keyboards just to the left of the return key. This character is used to declare the following character to be a literal character, instead of a possible wildcard symbol. This permits you to use the characters #, ?, |, %, (, ), [, ], *, ~ and even an apostrophe as themselves. For example, YEAR#?'% will match YEAR1989%, YEAR1990% but not YEAR1989 or YEAR1990 as would normally be the case NOTE: The term "expression", above, means either a single character (ex: "#?"), or an alternation (ex: "#(ab|cd|ef)"), or a character class (ex: "#[a-zA-Z]"). More Pattern Matching Examples: A?B Matches any three letter names beginning with A and ending with B, such as AcB, AzB and alb. A#BC Matches any name beginning with A, ending with C and having any number of Bs in between, such as AC, ABC, ABBC, ABBBC and so on. A#(BC) Matches any name beginning with A and followed by any number of BC combinations, such as ABC, ABCBC, ABCBCBC and so on. A(B|C)D Matches ABD or ACD. ABC#? Matches any name beginning with ABC, reqardless of what follows, such as ABCD, ABCDEF.info or ABCXYZ. #?XYZ Matches any names ending in XYZ, requardless of what precedes it, such as ABCXYZ and ABCDEFXYZ. [A-D]#? Matches any name beginning with A, B, C or D. ~(XYZ) Matches anything but XYZ. ~(#?XYZ) Matches anything not ending in XYZ. A(B|D|%)#C Matches ABC, ADC, AC (% is the null string), ABCC, ADCC, ACCC and so on. ARexx Help ---------- ARexx specific information... The ARexx Cookbook, by Merrill Callaway WHITESTONE, 511-A Girard SE, Albuquerque, NM 87106 (505) 268-0678 ($54.90 book & two example disks postage paid). Amiga Programmer's Guide to ARexx, by Eric Giguere Commodore-Amiga, Inc., 1991 Using ARexx on the Amiga, by Chris Zamara and Nick Sullivan Abacus, 1991 ISBN 1-55755-114-6 There are ARexx forums on BIX, CompuServe, GENIE and PORTAL. Rexx scripting information... Practical Usage of REXX, by Anthony S. Rudd Ellis Horwood/Simon & Schuster, 1990 ISBN 0-13-682790-X Programming in REXX, by Charles Danny McGraw Hill, 1992 ISBN 0-07-15305-1 The REXX Handbook, edited by Gabe Goldberg and Phil Sullivan McGraw Hill, 1991 ISBN 0-07-023682-8 The Rexx standard... The REXX Language, 2nd edition, by M.F. Cowlishaw Prentice-Hall, 1985 ISBN 0-13-780651 This book is considered the current standard for the REXX language. It is often just referred to as either "TRL" or "The Red Book". Until ANSI, committee X3J18, releases its standard, this book is IT. -----------------------------------END-------------------------------------