________________________________________ \____ \____/ ___________ Ž____ \ Ž__ | | \ \ \ \ \/ | _ \ | \ Ž_____ Œ_ Œ____ Œ_ /\ _€___€_ Œ___ / +------\/--\/-----\/--\/--\/-------\/RtX!\/+ EDGE V1.70 ========== TYPED BY SHARD - DTL HELP ---- This section will tell you how to use the AmigaGuide Help for Edge. AmigaGuide is a "hypertext" program to let you jump back and forth at random in a text file. You may read things sequentially, or you may browse in any subject you care to, and return to where you left off immediately. Simply click on any words that looks like a gadget, and you will jump to the place that explains the subject related to that word. If you double-click on ANY word that happens to be represented by a "hypertext node", then AmigaGuide will jump you there. If there is no word listed, the screen will flash and a "can't find" message will appear. Try clicking on requesters or double clicking on the word; "requesters", and you will see the results are the same. There are headings in the help window to let you return to the table of contents or jump back (Retrace) step by step to where you have been already. At any time you may simply "Browse" forward or backward through the file. When Edge is open, you may press the Help key at any time, and the Amiga Guide Help file will open to the area that will explain the relevant subject. For instance, if a requester is open, and you need help in deciding how to answer it, press help and the explanation of that requester will appear in the window. You may of course use the hypertext capabilities to jump around once you are in the Edge Help file. The help system is asynchronous, which means that you can have it running and still use the editor. To return to the Edge program to take up where you left off, simply activate the window you were working with. General Conventions and Syntax ------------------------------ The Edge Window Status Line Once the Edge Window opens, it displays a status information line which may be on the top or bottom of the window depending on the GlobalEnvFlags flag in GlobalEnvVars, accessable in WindowSettings. The information line contains, from left to right: Line number L:2 means Line number 2. Column number C:4 means Column number 4. Letter I or O I=Insert typing mode; O=Overstrike typing mode. Immediately next to I or O is a letter or a blank to tell whether the numeric keypad cursor keys are active or not. K=ON; blank=OFF The decimal ASCII character code of the character under the cursor. For example: 77 = decimal character code for "M" Number of Lines #L:40 is a 40 line file File size (bytes) Size:714 means a file size of 714 bytes Number of changes Chng:9 means you have made 9 changes to the file since opening/last saving it Page number Pg:1 means you are on page 1 of the document Page Line number PLn:5 means you are on line 5 of the current page The format of the status line is defined in the MiscTexts: section in the Text configuration file. At the lower right hand corner is a size gadget. Click, hold, and drag to resize the window. General Syntax and Conventions of Edge -------------------------------------- Edge has a number of equivalent actions that you may perform to select a checkbox, or activate a string gadget, or perform a menu function. If You Previously Assigned Edge: If you happen to have made an assignment of Edge: to some path or other, it will change the name shown in the Edge window to Edge2. It will also change the name of the ARexx port(s) of Edge and its windows. Generally it will append a "2" to the end of all named objects to do with Edge. If Edge2 also exists a "3" will be appended; if Edge3 exists a "4" is appended, etc. Menus ----- Menus are activated by clicking the Right Mouse Button (RMB) and holding it down. The Menu Bar at the top of the window will activate and names will appear. To select one of the Items under a Menu name, continue to hold down the RMB and move the pointer until the item or subitem you wish to activate is highlighted. The Item function is performed if you let go of the RMB while that item is highlighted. Certain menu items will have a "Command Equivalent" to the right of the item name. To use this "Keyboard Equivalent" of the menu, press the Right Amiga Key along with the keyboard character shown in the menu item. For instance, in a "Project" Menu, if you wish to Open a file, you may use the menu or press the Right Amiga key and the "o" key together. Now - to include a file by keyboard command you press the Right Amiga key together with any Shift key and the "o" key. In Edge, unlike most Amiga programs, if a menu shortcut key is displayed in upper case you must also press shift since Edge normaly distinguishes shifted and unshifted command keys. NOTE: caps lock will not do. Keyboard Equivalents -------------------- The Right Amiga key is called a "Qualifier" to the "o" key, above. All menu equivalents are qualified by the Right Amiga key. In the Help file, a "Qualified" key press is indicated by [Right Amiga] [O] A simple key press looks like [O] or "O", but in either case only the O key is pressed. Underlined Characters in the Gadget or Checkbox Name In general, all requesters EXCEPT the file requester will have one character in each gadget or checkbox name UNDERLINED. If you wish to activate that gadget or to toggle that checkbox ON or OFF, you may simply press the keyboard character that you see underlined in the gadget name. In the Help file: "Keyboard select: 'm'" means that you may SELECT the gadget or the checkbox or the string gadget by simply pressing the key for M (shifted or unshifted) because the gadget name has an underlined character 'm' in it. "Keyboard equivalent: [Right Amiga] [O]" means that pressing the key or keys shown together will PERFORM A FUNCTION. In string gadgets, to cycle forwards, press the "Tab" key. "Shift-Tab" cycles backwards. Mouse clicks inside string gadgets activate them with a cursor visible inside, or press the underlined character on the keyboard. If the gadget is active, pressing the underlined character will ENTER that character into the gadget. ARexx Every action you can do from the Edge interface has an equivalent ARexx Command. Look at Commands for more information. Starting Edge. -------------- This section will tell you how to start Edge, either from Shell or from Workbench, and what arguments you can supply. Starting Edge from the Workbench To start Edge from Workbench just double click on the Edge tool icon or select and double click the Edge project-file(s) you want to load. The Edge tool icon tooltypes are: Dictionary Filename of the default dictionary file, defaults to EdgePrg:Edge.dictionary Dormant Flag to specify that Edge is to start up in iconified state. If any files are to be loaded this flag is ignored. Force Flag to specify that you wish to start a new copy of edge and not create new files in the one copy already loaded. obviously this flag only has a meaning if you have Edge already running in memory and wish to start another. Global Filename of the global settings preference file, defaults to EdgePrg:Edge.global Icon Filename of the icon to use as project icon (not including .info, which is added automatically), defaults to EdgePrg:Edge.icon.info Keyboard Filename of the keyboard config file, defaults to EdgePrg:Edge.keyboard Local Filename of the local settings preference file, defaults to EdgePrg:Edge.local Menus Filename of the menu config file, defaults to EdgePrg:Edge.menus MouseButtons Filename of the mouse button config file, defaults to EdgePrg:Edge.mousebuttons PubScreen The name of the public screen to open on. This keyword will override the _GE_Monitor variable in the global settings prefs file. For example - to run Edge on DirectoryOpus's screen enter a new tooltype: PublicScreen='DOPUS.1' Startup Filename of the startup-script to be executed after all files are loaded, defaults to EdgePrg:Edge.startup Templates Filename of the default template file, defaults to EdgePrg:Edge.templates Texts Filename of the requester and text config file, defaults to EdgePrg:Edge.texts Wakeup Filename of the wakeup-script to be executed after Edge is uniconified, defaults to EdgePrg:Edge.wakeup WorkDir The path to use as current directory once the editor has started. For example: WorkDir=Data:myfiles/text/pgms The tooltypes in the project icon have the same name as the Edge environment variable they affect, so look in the environment section for an explanation of what and how the environment variables work. Edge on the Workbench --------------------- AppWindows When Edge is running on the Workbench all text windows become what is known as 'Application Windows'. This means that you may drag and drop project icons into the text windows in order to load them. If multiple icons are dropped in one window, then the first file will be loaded in that window and new windows will be opened for the rest of the files. AppIcon If you set the AppIcon flag in GE_Flags, accessible in General Settings by clicking on the AppIcon check box, Edge will put an Application Icon on the Workbench. This icon is called Edge-Deposit. Project icons may be dragged and dropped into the AppIcon to load them into Edge automatically. A new Edge window will open with each project loaded. This is a great way to open up multiple files without going to the trouble of multiple-selecting them. Just click and hold down the Left Mouse Button on a project file, drag it until the mouse pointer is over the icon, and release the mouse button. If the editor is iconified while doing so it will be awakened. Double clicking on the icon works just as pressing the Edge hot key - Edge will pop to front, and wake up if iconified. The AppIcon is fetched from disk using the name "EdgePrg:edge.appicon.info". Edge's Disk Icon Once Edge is running, a disk icon called "Edge-Docs" opens on the Workbench. This "disk" performs sort of like a RAM_Disk except that you cannot properly write to it, see EDGE: advanced information. What you do use it for is mainly to access the files loaded into the editor without the need of saving them, which is great for compiling, etc. If you use DirectoryOpus, you may open a directory window of Edge: or Edge-Docs: and view the files, copy project files to this disk device, or treat it as any other drive! When you copy files to this device, it is as if you had loaded the project into Edge in the more conventional fashion: a new window opens with the project file loaded. NOTE: When dropping icons on Edge-Docs in Workbench, the icon tool-types (e.g. the files local environment variables) and the files' true path are NOT available, use the AppIcon, or AppWindows, instead, if you need that information. Starting from a Shell --------------------- To start Edge from a Shell just type 'edge'; if you want the editor to load any files at startup simply type the filenames after the command 'edge work:mystuff/source.a'; or to load all C and assembler files in work:mystuff edge work:mystuff/#?(.c|.a). The command line syntax for Edge is as follows: Edge Files/M,PS=PubScreen/K,WD=WorkDir/K, S=Startup/K,W=Wakeup/K, G=Global/K,L=Local/K, M=Menus/K,T=Texts/K, K=Keyboard/K,B=MouseButtons/K, I=Icon/K,D=Dictionary/K,P=Templates/K, Z=Dormant/S,F=Force/S This syntax is shown if you type 'edge ?'. All arguments except FILES work as the tooltype with the same name and are explained below. FILES are, as said above, the name(s) of the file(s) you wish the editor to load at startup. EDGE: advanced information -------------------------- EDGE: is a virtual "disk" perhaps best described as a DOS interface to Edge. Through it you can access all files loaded into the editor and also load new files. Most things you can do with a normal ram disk you can also do with EDGE: - with a few exceptions: 1) .info files cannot be loaded via EDGE: 2) It is not possible to Seek in a file which is presently written to, e.g. opened with MODE_NEWFILE. 3) Read/Write files are not supported; open with MODE_READWRITE. For the more technical users out there, the following DOS packets are supported by the EDGE: device; ACTION_FREE_LOCK ACTION_END ACTION_READ ACTION_LOCATE_OBJECT ACTION_FINDINPUT ACTION_SEEK ACTION_EXAMINE_OBJECT ACTION_EXAMINE_NEXT ACTION_COPY_DIR ACTION_PARENT ACTION_RENAME_OBJECT ACTION_SET_PROTECT ACTION_DISK_INFO ACTION_INFO ACTION_IS_FILESYSTEM ACTION_SET_DATE ACTION_SET_COMMENT ACTION_DELETE ACTION_WRITE ACTION_FINDOUTPUT NOTE: If a blocking requester is active when EDGE: is in use, sometimes it may seem as if DOS is frozen. This is because the requester will also block the Edge's process communication with the EDGE: device - just get rid of the requester and everything will be ok. Edge Help: Basics ----------------- Entering Text Text may be entered into the window by simply typing it in. The cursor indicates where the text will appear if you start typing. Pressing the [Return] key breaks the line and moves the cursor down to the start of the next line. If you start in the middle of some text, the default is to insert the new text and push aside the old text to make room. This is called Insert mode. Toggle whether to Insert or Overstrike in the Settings/Local menu item. You may select which mode to save as the default by using the Local Settings requester opened from the Settings menu. The default is that if you indent a line, then all subsequent lines will indent the same amount until you move the start of the line back out to the left. This is intended for programmers who do a lot of block indentations. This is called AutoIndent. Your text would look like this. All such behaviors of the editor are configurable by the user. If you didn't want to use AutoIndent, for instance, you would select the Settings menu item and within it, select Local Settings or use the keyboard equivalent of pressing [Right Amiga]-[e]. This notation means to press the Right Amiga key, hold it down, and press the [e] key at the same time. Keys that aren't obvious such as the [e] key are named within the square brackets. Other such keys are [CursorUp] for the up arrow key, [Esc] for the Escape key, and so on. When the Local Settings requester opens, you have a choice of setting the Insert or Overstrike mode; Word wrap (words automatically continue or "wrap" around to the next line once you type past the right margin); or setting AutoIndent on or off, simply by clicking on check boxes. Try different settings to see how they affect editing in your document. You may set everything, including tab stops and whether to show spaces, in the Local Settings window. Printing a Document ------------------- You may print a document by selecting the Project/Print, Project/Print To or Project/Print As menu items. If you choose Print As, you get a window to change the printer settings before you print. These do not affect the global printer settings, however. Moving Around with the Mouse, Menu, and Keyboard You may move the cursor up and down and side to side with the cursor arrow keys or with the numeric keypad keys when the numeric pad is toggled so a K appears in the window's bottom indicator bar. Toggle the keypad on and off in Settings/Global Settings menu. You may move around quickly up and down and side to side by simply holding down the Left Mouse Button (LMB) and moving its pointer toward the top, bottom, or side margins. The closer the pointer is to the margins, the faster the text will scroll. You may move up and down with the scroll bar to the right hand side of the window as well. Click and hold the LMB on the scroll bar to move the text up and down smoothly; click on an "empty" space off the scroll bar to jump the text a proportional amount up or down. Bookmarks There is a special way to jump around inside the document. The menu item is called Tools and has two items at the bottom. The first one for setting bookmarks (special user-settable markers you can jump back to after going off somewhere else). The second item is for jumping to the bookmarks you set before. Move to The Tools menu also has a Move to section for moves to line numbers, last change, errors, even specific bytes (useful for programmers). Folds Edge has the capacity to hide sections of a large document as "folds". It behaves as if your file was written on a long scroll and part of it "folded" out of sight. This is useful for hiding completed sections of program code so that they will not distract from work on other parts of the listing. Use the Local Settings requester to set the Fold Start and Fold End character string you prefer to delimit the start and end of your folds. The default for start is /*FS*/ and the default for the end is /*FE*/ but you may change them to any string you prefer. You may also nest folds so that you may hide sections within sections. To show a hidden section, just place the cursor on the start of fold mark and select the menu item to show it or show all to reveal all folds. The File Requesters You have a choice of the Commodore system ASL file requester or a custom requester with more features just for Edge. If you choose in the Global Settings to have the ASL, help is not available, but on-line help will come up for the Edge requester when it is open, or you can jump to any help section from anywhere in the Amigaguide file. Block Operations Edge supports selection and operations with both horizontal and vertical blocks. In order to move text around, we usually cut or copy a block and then paste it down in some other part of the document. We select blocks by double clicking over the start of the block; or by selecting a menu item Block/Mark Block when the cursor is over the start of the block; or by using the keyboard [Right Amiga] [b]. The cursor changes color (if we are using enough colors in our system) after we select the start of the block. The next place we click or move the cursor will highlight all the text from the start to the cursor. Once we have moved the cursor to where we want the end of the block to be, we may cut, copy, or perform other block operations on it. To select a Vertical or Columnar block, we must hold down the [Shift] key while clicking with the mouse - or using the middle button if we have a three button mouse, select the Columnar Block item from the Edit/Begin Column menu, or press [Right Amiga] [Shift] [B] to start the block. Then the highlighted text will be in a column format rather than in a horizontal format. Find and Replace Refer to the Find/Replace requester for information about this subject. Running ARexx Macros There is a rich ARexx command set for Edge, and there are plenty of example programs to use or learn from. Teaching you to program in ARexx is beyond the scope of this help manual. You may run any of the macros included by using the menu item Macros/ARexx/Run ARexx Script or by pressing [Shift] [Esc]. A file requester will open asking you for the name of the ARexx script you want to run. The Setting/Edit Sub-Menu If you need to reconfigure or delete any features, you simply edit a text file such as EdgePrg:edge.menus/main. You don't have to remember which file is which. The Settings menu Edit item at the right hand side has sub-items to edit each configuration such as menus or keyboard settings. Selecting one of these will bring up the configuration file for that item. Save a backup under a different name the first few times you try this. After you finish your edit, another menu item lets you reload the configuration so your changes will take effect. Configuring Edge Although a well thought out default configuration is present from the first time you use Edge, you may easily change any of the default settings to suit your style or habits of use. If you have been using another brand of editor, you may want to reconfigure certain keystrokes and menus to match what you are used to. After installation, if you look at the directory in which Edge resides, you will notice a number of files with names such as Edge.menus or Edge.global. These are ASCII text files which govern the configuration of Edge. Edge itself can open a number of Requesters which allow you to change things such as the global prefs by pointing and clicking on check boxes which edit the associated file indirectly. Advanced users may edit these files directly. We recommend that everyone make a back up file before trying to edit a configuration file directly. Novices should at first use only the Requesters for changing things because these graphics interfaces don't make "typos" when changing a file, and they are easy to change back again. If Edge is your first editor, we suggest that you simply use it as it comes. You may use Edge's default configuration for a while without having to reconfigure anything. Remember that experts developed the defaults. The standard configuration should require only minor customization on your part: for instance, if you don't like or don't use some feature, you may easily delete it from the menu or keyboard configuration file. Extensive rearranging may take some planning, because if you change one thing, you'll probably have to change something else, too. Advanced users who program in different languages may configure different versions of Edge for different projects and languages. To reconfigure anything in your Edge editing environment, you simply modify a text file either directly or via a requester. Dictionaries Edge supplies a workable C language dictionary. Once the dictionary is loaded, it will automatically correct the case of otherwise esoteric strings. You may add words or modify dictionaries, because they are in plain ASCII text format. Dictionaries may be "included" so as to build up a project dictionary from multiple smaller ones. The dictionary feature helps prevent needless case sensitive errors in your code. The default configuration attempts to load a dictionary with the name EdgePrg:Edge.dictionary which is supplied as an empty file. If you desire to use one of the supplied technical programming dictionaries as the default, you should change its name to the default file, or put in a tooltype Dictionary=path:mydictionary which supplies a path to your default dictionary. Edge's Requesters... -------------------- About the Notify requester. The Notify requester is used to notify the user about something, when the response from the user is not significant - the Notify requester only has a 'Continue' gadget. To make the requester go away the user can click the 'Continue' gadget, the window close gadget, press the ESC or RETURN key on the keyboard, select 'Continue' from the menu or press the menu shortcut key for 'Continue' or press the underlined character 'C' for continue. Underlined characters in names for gadgets will select that item. The user can also press the HELP key to activate the Edge Help-system, which will display the page you see here. The Notify requester MENU has two items: Continue Close the requester (may also be done as described above). Keyboard equivalent: [Right Amiga] [C] Snapshot window Save the current position of the Notify requester window in the global environment and use it the next time the requester is called for. Keyboard equivalent: [Right Amiga] [S] NOTE: If you wish to permanently save the window position you must save the Global Settings to disk. NOTE: If the Notify requester window is pointer relative the saved position will NOT be used. NOTE: The Edge ARexx Command for a Notify requester is RequestNotify. About the Choice requester. The Choice requester is used to prompt the user about an OK/Cancel type of decision when the response from the user is significant. The requester will contain a short text describing the matter the user is supposed to decide about. To give a positive response to the requester the user may click the 'OK' gadget (the left one), select 'OK' from the menu or press the menu shortcut key for 'OK', or press the underlined character 'O' in the name 'OK'. To give a negative response to the requester the user may click the 'Cancel' gadget, select 'Cancel' from the menu, press the menu shortcut key for 'Cancel' or press underlined character 'C' or the ESC key on the keyboard. The requester is closed by any of the responses described above. The user can also press the HELP key to activate the Edge Help-system, which will then display this page. The Choice requester MENU has three items: OK Give a positive response. Keyboard equivalent: [Right Amiga] [O] Cancel Give a negative response. Keyboard equivalent: [Right Amiga] [C] Snapshot window Save the current position of the Choice requester window in the global environment and use it the next time the requester is called for. Keyboard equivalent: [Right Amiga] [S] NOTE: If you wish to permanently save the window position you must save the Global Settings to disk. NOTE: If the Choice requester window is pointer relative the saved position will NOT be used. NOTE: The Edge ARexx Command for the Choice requester is RequestChoice. About the Enter a Number requester. The Enter a Number requester is used to prompt the user for a number. The window title will contain a short text telling the user what the number is for. The requester may be preloaded with a default number and if that is OK for the user then he can just 'OK' the requester. The string gadget is automatically activated when the requester is opened but if it should get inactive just click in it. You can only enter digits in this requester within the limits shown in a small window below the number entry gadget. If the number is off limits and you try to 'OK' the requester, the display will flash and a message will be printed in the requester telling you if the number is too small or too large. The requester will refuse to accept an out-of-limits number. To 'OK' the requester and accept the number, either press the RETURN key on the keyboard, click the 'OK' gadget, select 'OK' from the menu or press the menu shortcut key for 'OK', or press 'O', the underlined character. To 'Cancel' the requester either click the 'Cancel' gadget, select 'Cancel' from the menu, press the menu shortcut key for 'Cancel', press the ESC key on the keyboard or press the RETURN key on the keyboard with the string gadget empty (no digits), or press 'C' for 'Cancel'. The requester is closed by any of the responses described above. (as for the 'OK' responses - the number must be within limits or the requester will not go away). The user can also press the HELP key to activate the Edge Help-system, which will then display this page. The Enter a Number requester MENU has three items: OK Give a positive response. Keyboard equivalent: [Right Amiga] [O] Cancel Give a negative response. Keyboard equivalent: [Right Amiga] [C] Snapshot window Save the current position of the Enter a Number requester window in the global environment and use it the next time the requester is called for. Keyboard equivalent: [Right Amiga] [S] NOTE: If you wish to permanently save the window position you must save the Global Settings to disk. NOTE: If the Enter a Number requester window is pointer relative the saved position will NOT be used. NOTE: The Edge ARexx Command for number requester is RequestNumber. About the Enter a Key requester. The Enter a Key requester is used to prompt you for a key-sequence. The window title will contain a short text telling you what the key is for. To start sampling click the 'Sample' gadget - now keyboard input is monitored and displayed in the box below the 'Sample' gadget. Once a complete key-sequence is entered, sampling will stop. As long as sampling is engaged the window title will say 'Sampling'. You may also activate sample mode by pressing the underlined character, 'p', in the name 'Sample'. To the right of the requester there are four checkboxes controling the qualifier options. Click in the box to toggle select/deselect or press the keyboard equivalent - the underlined character in the name of the box. Alt Same Holds the state of the ALTSAME flag in _GE_Flags. If set, left Alt and right Alt are equivalent; i.e. it doesn't matter which Alt key is pressed. Keyboard select: 'A' Shift Same Holds the state of the ALTSHIFT flag in _GE_Flags. If set, left Shift and right Shift are equivalent; i.e. it doesn't matter which Shift key is pressed. Keyboard select: 'S' Mask Alt Holds the state of the QMALT flag in _GE_Flags. If set, the Qualifier mask will include Alt; i.e. the Alt keys as qualifiers are ignored. Keyboard select: 'M' Mask Shift Holds the state of the QMSHIFT flag in _GE_Flags. If set, the Qualifier mask will include Shift; i.e. the Shift keys as such are ignored. Keyboard select: 'Q' To 'OK' the requester; i.e. accept the key-sequence, either press the shortcut key for the 'OK' gadget, click the 'OK' gadget, select 'OK' from the menu or press the menu shortcut key for 'OK'. Keyboard select: 'O' To 'Cancel' the requester either click the 'Cancel' gadget, select 'Cancel' from the menu, press the menu shortcut key for 'Cancel', press the ESC key on the keyboard or press click on the window close gadget. Keyboard select: 'C' The requester is closed by any of the responses described above. You can also press the HELP key to activate the Edge Help-system, which will then display this page. The Enter a Key requester menu has three items: OK Give a positive response. Keyboard equivalent: [Right Amiga] [O] Cancel Give a negative response. Keyboard equivalent: [Right Amiga] [C] Snapshot window Save the current position of the Enter a Key requester window in the global environment and use it the next time the requester is called for. Keyboard equivalent: [Right Amiga] [S] NOTE: If you wish to permanently save the window position you must save the Global Settings to disk. NOTE: If the Enter a Key requester window is pointer relative the saved position will NOT be used. NOTE: The Edge ARexx Command for the EnterAKey requester is RequestKey. About the Enter a String requester. The Enter a String requester is used to prompt the user for a string. The window title will contain a short text telling the user what the string is for. The requester may be preloaded with a default string and if that is OK for the user then he can just 'OK' the requester. The string gadget is automatically activated when the requester is opened, but if it should become inactive just click in it. You can enter any character in this requester. In order to enter non- printing characters use backslash and a three digit decimal number, e.g. '\\010' for a Line Feed (LF), '\\013' for Carriage Return (CR), etc. To 'OK' the requester; i.e. accept the string, either press the RETURN key on the keyboard, click the 'OK' gadget, select 'OK' from the menu or press the menu shortcut key for 'OK', or press 'O', the underlined character. To 'Cancel' the requester either click the 'Cancel' gadget, select 'Cancel' from the menu, press the menu shortcut key for 'Cancel', press the ESC key on the keyboard or press the RETURN key on the keyboard with the string gadget empty (no characters), or press 'C' for 'Cancel'. The requester is closed by any of the responses described above. The user can also press the HELP key to activate the Edge Help-system, which will then display this page. The Enter a String requester MENU has three items: OK Give a positive response. Keyboard equivalent: [Right Amiga] [O] Cancel Give a negative response. Keyboard equivalent: [Right Amiga] [C] Snapshot window Save the current position of the Enter a String requester window in the global environment and use it the next time the requester is called for. Keyboard equivalent: [Right Amiga] [S] NOTE: If you wish to permanently save the window position you must save the Global Settings to disk. NOTE: If the Enter a String requester window is pointer relative the saved position will NOT be used. NOTE: The Edge ARexx Command for a string requester is RequestString. About the Find/Replace requester. The Find/Replace requester is used to prompt the user for find and replace strings and search attributes. The Find and Find/Replace requesters are identical except for one thing, the replace string gadget which will only appear in the Find/Replace requester. All gadgets in the Find/Replace requester display the last values used. If this is OK, then just 'OK' the requester. The find string gadget is activated when the requester is opened, but if it should become inactive just click in it or press a key if the requester window is active. To move the cursor between the find and replace string gadgets from the keyboard use the TAB key. The labels for the options have characters in their names underlined. To select that option, just press the left Amiga key and one of the underlined characters. Edge maintains a history of the find and replace string gadgets. To cycle through the list, simply use the Cursor Up/Down keys. Shift Cursor Down will move to the end 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). You can enter any character in the string gadgets; in order to enter a non-printable character use backslash and its three digit decimal number, e.g. '\\010' LF, '\\013' CR, '\\000' NULL, etc. To 'OK' the requester, i.e. accept the string(s), either press the RETURN key on the keyboard, click the 'OK' gadget, select 'OK' from the menu, press the menu shortcut key for 'OK', or use the keyboard: Press the 'O' key. In general, all requesters' items may be chosen by pressing the underlined character in their name. To 'Cancel' the requester either click the 'Cancel' gadget, select 'Cancel' from the menu, press the menu shortcut key for 'Cancel', press the ESC key on the keyboard or press the RETURN key on the keyboard with the find string gadget empty (no characters). You may also press 'C'. The requester is closed by any of the responses described above. The user can also press the HELP key to activate the Edge Help-system which will then display this page. The Find/Replace requester MENU has eight items, described below. OK Go ahead and Find/Replace. Keyboard equivalent: [Right Amiga] [O] Cancel Abort the operation. Keyboard equivalent: [Right Amiga] [C] Snapshot window Save current position of the Find/Replace requester window in the global environment and use it the next time the requester is called for. Keyboard equivalent: [Right Amiga] [S] NOTE: If you wish to permanently save the window position you must save the Global Settings to disk. NOTE: If the Find/Replace requester window is pointer relative, the saved position will NOT be used. The five items below are used to toggle the state of the five checkboxes in the right side, displaying the current state of the search flags. A check in the checkbox means the flag is active. Ignore case Toggles the UCEQLC flag; if this flag is active upper case is treated equal to lower case in searches, else case is significant. Keyboard equivalent: [Right Amiga] [A] Scan forward Toggles the FORWARD flag; if this flag is active the search is made forwards in the file, towards the end of the file, else the search is made backwards, towards start of the file. Keyboard equivalent: [Right Amiga] [F] Use wildcards Toggles the WILD flag; if this flag is active and the find string contains any wildcard characters then pattern matching is used during the search. Keyboard equivalent: [Right Amiga] [D] Searching with wildcards is line oriented, e.g. the entire line is matched against the find-string once and only once. If a match occurs then the cursor will be positioned at column 1 on the line that matched. The 'Only whole words' option is ignored when searching for wildcards. Only whole words Toggles the WORD flag; if this flag is active then the search is made to check for white spaces before and after the specified find string. Keyboard equivalent: [Right Amiga] [W] Circular scan Toggles the CIRCULAR flag; if this flag is active then the search is made circular; that is when end or start of file is reached, the search is restarted at the other end of the file and will continue until either the find string or the beginning of the search is found. Keyboard equivalent: [Right Amiga] [R] Swap... This item only appears in the Replace requester. When selected the Find and Replace strings are swapped. Keyboard equivalent: [Right Amiga] [T] NOTE: The Keyboard equivalents will toggle checkboxes even if a string gadget is active. About the Edge File/Directory requester. NOTE: If you have selected the ASL File Requester (the Amiga Standard File Requester) in the General Settings window, this description does not apply. The ASL requester is described in the AmigaDOS documentation. The Edge File/Directory requeste will expand to maintain a file for the command as you do when you bind a macro to a key. Use the Settings/Edit/Keyboard menu to open the keyboard configuration file. NOTE: Edge has an ARexx or host address which is case sensitive. The primary ARexx port is normally "EDGE" and is also the screen title text. Normally you won't talk to this port. Additionally, each window in turn opens its own ARexx port with the following syntax (case sensitive): --------------------------------------------------------------------------- EDGE1.1.2 means Edge, window 1, view 2 EDGE1.3.4 means Edge, window 3, view 4 --------------------------------------------------------------------------- If your ARexx macro needs to send commands between windows, then you need to do an address instruction to change the current address to the window you want to send the command to. There is a rich ARexx command set for Edge, and there are plenty of example programs to use or learn from. Teaching you to program in ARexx is beyond the scope of this on-line help. Click for more info See ARexx commands for more information Commands -------- See ARexx macros & hot-keys for more information Edge ARexx Command Set All commands return their result in the ARexx RESULT variable; the RC variable indicates failure or success (0=success, any other value is severity level on the error that occurred). About SHOW/S,VERSION/S,TECHSUPPORT/S ActivateWindow PORT,TOP/S,BOTTOM/S,NEXT/S,PREVIOUS/S,LASTACTIVE/S, CURRENT/S AddErr LINE/A/N,CHAR/A/N,MESSAGE/A AddressOf FILENAME,FULLNAME,TOP/S,BOTTOM/S,NEXT/S,PREVIOUS/S, TW=TOPWINDOW/S,BW=BOTTOMWINDOW/S,NW=NEXTWINDOW/S, PW=PREVIOUSWINDOW/S BeepScreen , BlockInfo , BlockOff , BlockToBuff ADDRESS/A/N,MAXSIZE/A/N BlockToFindBuff , BlockToReplaceBuff , ChangeWindow LEFTEDGE/N,TOPEDGE/N,WIDTH/N,HEIGHT/N,DELTAX/N,DELTAY /N,DELTAW/N,DELTAH/N CheckAbort , Clear FORCE/S,RESTORELS/S ClearClip GC=GLOBALCLIP/S ClearErr , Close FORCE/S,FORCEREXX/S,FORCEOK/S,SAVE/S,ICON/S,NOICON/S, BACKUP/S,NOBACKUP/S,NOQUIT/S CloseRexxIO , CompleteTemplate TEMPLATE Copy GC=GLOBALCLIP/S,SC=SMALLCLIP/S,CHAR/S,WORD/S,BACK/S, LINE/S,SOL/S,EOL/S,APPEND/S,RB=RESULTBUFF/S CorrectCase WORD CorrectWord WORD CurrentDir DIRNAME Cursor UP/N,DOWN/N,LEFT/N,RIGHT/N Cut GC=GLOBALCLIP/S,SC=SMALLCLIP/S,CHAR/S,WORD/S,BACK/S, LINE/S,SOL/S,EOL/S,APPEND/S,RB=RESULTBUFF/S Delete CHAR/S,WORD/S,BACK/S,LINE/S,SOL/S,EOL/S Dictionary WORD/A,ADD/S,FORCE/S,REMOVE/S DisableUser , EnableUser , EnterASCII ASCII/N Erase , Fault ERRNUM/N,RAW/S Find FIND,UCEQLC/N,FORWARD/N,WILDCARD/N,WORDS/N,CIRCULAR/N FindBracket , FindCFunction , FindIMark MARK/A/N FindLabel , FindNext BACK/S FindReplace ONCE/S,ALL/S,FIND,CHANGE,UCEQLC/N,FORWARD/N,WILDCARD/ N,WORDS/N,CIRCULAR/N FindReplaceNext ONCE/S,ALL/S,BACK/S Flag FIELD/A,FLAG/A,T=TOGGLE/S,S=SET/S,C=CLEAR/S Fold SHOW/S,HIDE/S,SHOWNESTED/S,HIDENESTED/S,SHOWALL/S, HIDEALL/S Font NAME,SIZE/N,SCREEN/S,TEXT/S,GADGET/S,BOLD/S,ITALIC/S, UNDERLINE/S,SCALE/S Format LEFT/S,RIGHT/S,CENTER/S,FILL/S GetENVVar NAME/A,RAW/S GlobalSettings PRINTER/S,SCREEN/S,WINDOWS/S GoToAuto , GoToBookMark MARK/A/N GoToByte BYTE/N GoToColumn COLUMN/N GoToError ERRNUMBER/N,PREVIOUS/S,SHOW/S GoToLine LINE/N GoToPage PAGE/N Help HELPFILE/K,SECTION,LOADINDEX/S,LOADALL/A,CACHENODE/S, KEEPCACHE/S,QUIT/S Iconify FORCE/S,FORCEREXX/S,FORCEOK/S,SAVE/S,ICONS/S,NOICONS/ S,BACKUPS/S,NOBACKUPS/S Include FILENAME KeyBoard KEY/A,Q=QUALIFIER/K,QM=QUALMASK/K,ASK/S,FORCE/S, COMMAND/F Learn FILENAME LoadDictionary FILENAME,FORCE/S,APPEND/S LoadENV FILENAME,GE/S,LE/S,DEFLE/S,PATTERN LoadKeyboard FILENAME,FORCE/S,APPEND/S LoadMenus FILENAME,APPEND/S LoadMouseButtons FILENAME,FORCE/S,APPEND/S LoadTexts FILENAME,APPEND/S LoadTemplates FILENAME,FORCE/S,APPEND/S LocalSettings , LowerCase CHAR/S,WORD/S,BACK/S,LINE/S,SOL/S,EOL/S,BLOCK/S MarkBlock COLUMNAR/S EdgeToBack , EdgeToFront , MouseButton BUTTON/A,Q=QUALIFIER/K,QM=QUALMASK/K,ASK/S,FORCE/S, COMMAND/F MovePage UP/N,DOWN/N,LEFT/N,RIGHT/N,CENTER/S MoveScreen LEFTEDGE/N,TOPEDGE/N,DELTAX/N,DELTAY/N New PORTNAME/K,LEFTEDGE/N,TOPEDGE/N,WIDTH/N,HEIGHT/N, ZOOMLEFTEDGE/N,ZOOMTOPEDGE/N,ZOOMWIDTH/N,ZOOMHEIGHT/ N,PATH,NAME,COPYLS/S NewLine NI=NOINDENT/S,I=INDENT/S,TI=TOGGLEINDENT/S Next WORD/S,PAGE/S Nop , Open FILES/M,FORCE/S,RESTORELS/S,PATH/K OpenClip FILENAME,GC=GLOBALCLIP/S,APPEND/S Paste GC=GLOBALCLIP/S,GCC=GLOBALCLIPCOLUMNAR/S,SC=SMALLCLIP /S Position LINE/N,COLUMN/N,CHAR/N,SOF/S,EOF/S,SOL/S,EOL/S,SOW/S, EOW/S,SOP/S,EOP/S Previous WORD/S,PAGE/S Print PROMPT/S PrintClip GC=GLOBALCLIP/S,PROMPT/S PutENVVar NAME/A,VALUE/A Quit FORCE/S,FORCEREXX/S,FORCEOK/S,SAVE/S,ICONS/S,NOICONS /S,BACKUPS/S,NOBACKUPS/S Redo , RequestFile TITLE/K,PATH,FILE,PATTERN,DIR/S,SAVE/S,GETDIR/S, MULTISELECT/S RequestKey TITLE/K,ALTSAME/N,SHIFTSAME/N,QMALT/N,QMSHIFT/N, SAMPLE/S RequestNotify TITLE/K,STRING/A/F RequestNumber TITLE/K,DEFAULT/N,MIN/N,MAX/N,SHOWLIMITS/S RequestChoice TITLE/K,STRING/A/F,PG=POSITIVEGADGET/K,NG=NEGATIVEGADGET /K RequestString TITLE/K,DEFAULT,TRANSLATE/S RX SYNC/S,FILEREQ/S,PATH/K,FILE/K,PATTERN/K, STOP=STOPLEARNING/S,COMMAND/F Save ICON/S,NOICON/S,BACKUP/S,NOBACKUP/S SaveAs FILENAME,FORCE/S,ICON/S,NOICON/S,BACKUP/S,NOBACKUP/S SaveChanges ICONS/S,NOICONS/S,BACKUPS/S,NOBACKUPS/S SaveClip FILENAME,FORCE/S,GC=GLOBALCLIP/S,ICON/S,NOICON/S SaveDictionary FILENAME,FORCE/S SaveENV FILENAME,GE/S,LE/S,DEFLE/S,FORCE/S,PATTERN SaveKeyboard FILENAME,FORCE/S SaveMenus FILENAME,FORCE/S SaveMouseButtons FILENAME,FORCE/S SaveTexts FILENAME,FORCE/S SaveTemplates FILENAME,FORCE/S 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 Select FILENAME,FULLNAME,TOP/S,BOTTOM/S,NEXT/S,PREVIOUS/S SetBookMark MARK/A/N SwapCase CHAR/S,WORD/S,BACK/S,LINE/S,SOL/S,EOL/S,BLOCK/S Template TEMPLATE/A,ASK/S,FORCE/S,FILL/F Text TEXT/A,RAW/S Undo , UpperCase CHAR/S,WORD/S,BACK/S,LINE/S,SOL/S,EOL/S,BLOCK/S Wakeup , 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 WindowTitle MESSAGE/A,DISPLAYTIME/N About ----- FORMAT About SHOW/S,VERSION/S,TECHSUPPORT/S DESCRIPTION If the SHOW switch is present the about string will be displayed using the Notify requester and in this case the function will not return until the user closes the Notify requester. Specify TECHSUPPORT to get information about how and where to contact technical support. Specify VERSION to get version information about Edge, Kickstart, Workbench and your computer. Without VERSION and TECHSUPPORT specified About will give copyright information, mailing addresses and phone numbers. INPUTS SHOW - Use this flag to display the about string with a Message requester. VERSION - Get version information TECHSUPPORT - Get technical support information RESULTS A string containing information on the selected topic. ActivateWindow -------------- FORMAT ActivateWindow PORT,TOP/S,BOTTOM/S,NEXT/S,PREVIOUS/S,LASTACTIVE/S,CURRENT/S DESCRIPTION Activate a window 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. INPUTS PORT - Activate the Edge window with the given ARexx address, if the port is not found no window will be activated. 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. LASTACTIVE - Activate the window previously active, useful for toggling between two windows. CURRENT - Activate the Edge window attached to the current ARexx address. 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. If no switches are specified the last text window receiving input from the user will be activated. You may only specify one of the switches at a time. RESULTS The ARexx-address of the activated window. AddErr ------ FORMAT AddErr CHAR/A/N,LINE/A/N,MESSAGE/A DESCRIPTION Add an error message to the error list. INPUTS CHAR - Character offset on the line. LINE - Line-number where the error occurred. MESSAGE - The error/warning message itself. AddressOf --------- FORMAT AddressOf FILENAME,FULLNAME,TOP/S,BOTTOM/S,NEXT/S,PREVIOUS/S, TW=TOPWINDOW/S,BW=BOTTOMWINDOW/S,NW=NEXTWINDOW/S, PW=PREVIOUSWINDOW/S DESCRIPTION Get the ARexx-address of an Edge window. If no parameters are specified the address of the current window will be returned. INPUTS FILENAME - Get the address of the first window in the file with the given filename; the search is made ignoring the Edge path components. FULLNAME - Get the address of the first window in the file with the given filename; the search is made taking into account the Edge path componets. TOP - Get the address of the first window in the first file. BOTTOM - Get the address of the first window in the last file. NEXT - Get the address of the first window in the next file. PREVIOUS - Get the address of the first window in the previous file. TW - Get the address of the first window in the window list. BW - Get the address of the last window in the window list. NW - Get the address of the next window in the window list. PW - Get the address of the previous window in the window list. NOTE NEXT and PREVIOUS are circular which means that if the current file is the last one and you specify NEXT you will get the address of the first file, and if the current file is the first one and you specify PREVIOUS you will get the address of the last file. The same goes for the window switches and the window list. You may only specify one of the parameters at a time. RESULT The ARexx-address of the specified file. BeepScreen ---------- FORMAT BeepScreen , DESCRIPTION Flash the screen Edge is running on. BlockInfo --------- FORMAT BlockInfo , DESCRIPTION Returns information on the currently selected block. If no block is currently selected an error is returned. RESULTS The info returned are five decimal numbers and a word; the start line and column of the block, the current (end of block) line and column, the byte-size of the block and a flag telling you whether the block is a "Normal" block or a "Columnar" one. BlockOff -------- FORMAT BlockOff , DESCRIPTION Turn off block mode. BlockToBuff ----------- FORMAT BlockToBuff ADDRESS/A/N,MAXSIZE/A/N DESCRIPTION Copies the currently selected block to the buffer starting at the given address, but copies no more than MAXSIZE bytes. Use with caution since it is easy to cause a memory overwrite. INPUTS ADDRESS - Decimal address, pointing to the start of the buffer. MAXSIZE - Maximun number of bytes that may be transferred (allocated size of the buffer). RESULTS The actual number of bytes copied. BlockToReplaceBuff ------------------ FORMAT BlockToReplaceBuff , DESCRIPTION Copies the currently selected block to the _FE_ReplaceString buffer. RESULTS The number of bytes copied. BlockToFindBuff --------------- FORMAT BlockToFindBuff , DESCRIPTION Copies the currently selected block to the _FE_FindString buffer. RESULTS The number of bytes copied. ChangeWindow ------------ FORMAT ChangeWindow LEFTEDGE/N,TOPEDGE/N,WIDTH/N,HEIGHT/N,DELTAX/N,DELTAY/N, DELTAW/N,DELTAH/N DESCRIPTION Changes the size and/or the position of an Edge text window. To find out what the size/position actually became, use the Window command. INPUTS LEFTEDGE - Move the window to this absolute X position. TOPEDGE - Move the window to this absolute Y position. WIDTH - Change the window's width to this absolute width. HEIGHT - Change the window's height to this absolute height. DELTAX - Move the window horizontally this amount relative to the current or specified absolute X position. DELTAY - Move the window vertically this amount relative to the current position or specified absolute Y position. DELTAW - Change the window's width with this amount relative to the current or specified absolute width. DELTAH - Change the window's height with this amount relative to the current or specified absolute height. CheckAbort ---------- FORMAT CheckAbort , DESCRIPTION This command used to check if CTRL-C has been pressed by the user, if so the user abort error is returned, e.g. RC=~0. If CTRL-C has not been pressed RC will equal 0. NOTE: The state of the CTRL-C flag is cleared by this command. The Menu_PlayNDefMac.edge script uses this command to see if the user wants to abort while playing back the default macro. RESULTS RC~=0 if CTRL-C has been pressed, RC=0 if not. Clear ----- FORMAT Clear FORCE/S,RESTORELS/S DESCRIPTION Clears the current file, flushes the undo-buffer and optionally resets the local settings to default. The FORCE switch suppresses the requester that will pop up if any changes have been made to the file, asking the user to confirm that losing the changes is OK. If the RESTORELS switch is present the local settings will be loaded with defaults; if not present the settings are kept as they are. INPUTS FORCE - Suppresses the requester prompting the user about losing any changes. RESTORELS - Loads the local settings with default values. RESULTS The new name for this file. ClearClip --------- FORMAT ClearClip GC=GLOBALCLIP/S DESCRIPTION Clears the selected clipboard, global if GLOBALCLIP is specified, else the local one, and free all memory used. INPUTS GLOBALCLIP - Flag to select the global clip for clearing. ClearErr -------- FORMAT ClearErr , DESCRIPTION Clears the error list, removes all errors linked and frees all memory used. You should use this command before you start a new assembly/compilation. Close ----- FORMAT Close FORCE/S,FORCEREXX/S,FORCEOK/S,SAVE/S,ICON/S,NOICON/S,BACKUP/S, NOBACKUP/S,NOQUIT/S DESCRIPTION Quits the current file. If the current file is the last one then Edge will either iconify or quit depending on the DORMANTQUIT flag in _GE_Flags. The FORCE switch suppresses the requester that will pop up if any changes have been made to the file, asking the user to confirm that losing the changes is OK. The FORCEREXX switch suppresses the requester that will pop up if any of the file windows have any outstanding ARexx messages (the requester is only visually suppressed - the outstanding messages must return before the editor can be unloaded). The FORCEOK switch suppresses the requester that pops up if no changes are made and no ARexx messages are outstanding, asking if quitting the file is OK. If the SAVE switch is present the file will be saved before it is closed. The ICON, NOICON, BACKUP and NOBACKUP switches are used to force or suppress icon and backup creation when saving. The NOQUIT switch is used to make sure that Edge will not unload/iconify if the last file is force closed. INPUTS BACKUPS - Forces create backups for all files saved. FORCE - Suppresses the requester asking the user about losing any changes. FORECEOK - Suppresses the 'OK to close file..' requester. FORCEREXX - Suppresses the 'ARexx outstanding messages' requester. SAVE - Saves the file before it is closed. ICON - Forces create an icon. NOICON - Suppresses icon creation. BACKUP - Forces a backup to be saved. NOBACKUP - Suppresses backup creation. NOQUIT - Switch to suppress quiting the editor if the last file is force Closed. CloseRexxIO ----------- FORMAT CloseRexxIO , DESCRIPTION When used, CloseRexxIO will tag the ARexx Input/Output (IO) stream so when all outstanding ARexx messages have returned, the ARexx IO stream will be closed regardless of setfont, close delay, etc. INPUTS None CompleteTemplate ---------------- FORMAT CompleteTemplate TEMPLATE DESCRIPTION Searches the template-list for a match to TEMPLATE or the word currently under the cursor. If a match, and only one, is found then if a TEMPLATE was specified the fill-text is returned as the result and if no TEMPLATE was given the fill-text is inserted into the file. NOTE: In order to match a template you need only give enough characters to uniquely separate it from the rest of the templates, i.e. if 'while' is the only template beginning on 'w' you need only give a 'w' in order to get a match. NOTE: You must have loaded a template configuration or created at least one template with the Template command in order for this function to do anything. The fill-text may contain two special characters: '@' Position the cursor on the character after this one when the fill-text has been inserted. '«' Insert a 'backspace'. To include a true '@' or '«' simply type two in a row '@@' or '««'. INPUTS TEMPLATE - Template to match or nothing to use the word under the cursor. RESULTS If a TEMPLATE is given the fill-text is not inserted into the file but returned as the result from this function. On the other hand, if no TEMPLATE is given the fill-text is inserted and the final cursor position is returned as the result. Copy ---- FORMAT Copy GC=GLOBALCLIP/S,SC=SMALLCLIP/S,CHAR/S,WORD/S,BACK/S,LINE/S,SOL/S, EOL/S,APPEND/S,RB=RESULTBUFF/S DESCRIPTION Copies the currenly selected block to one of the clipboards. If GLOBALCLIP is specified the text will be copied to the global clipboard; if SMALLCLIP is specified the text will be copied to the small clipboard; and if RESULTBUFF is specified the text will be copied to the ARexx result buffer, else the text will be copied to the local clipboard. The contents of the small clipboard are found in the Edge environment variable _FE_SmallClip. With normal block operations you must first select or mark the text you wish to copy to a clipboard, but that is not the case with the following switches: CHAR, WORD, LINE, SOL, and EOL. When you specify any of those switches the selected entity will be automatically marked and copied to the selected clipboard. If the APPEND flag is specified the newly copied text is not just put into the specified clip but joined to the end of what is already in the clip - with this switch you can merge text from different places into the clip and then insert it all in one go. INPUTS GLOBALCLIP - Flag to select the globalclip. SMALLCLIP - Flag to select the smallclip. CHAR - Auto mark and copy the character under the cursor. WORD - Auto mark and copy the word beginning under and extending to the right of the cursor plus trailing spaces. BACK - This flag only works together with CHAR and WORD. If given the text to the left of the cursor is copied instead of the text to the right. LINE - Auto mark and copy the whole current line. SOL - Auto mark and copy all characters from the start of the line to the cursor, not including the character under the cursor. EOL - Auto mark and copy all characters from the cursor, including the character under the cursor, to the end of the line. APPEND - Merge mode. RESULTBUFF - Copies to the ARexx result buffer, note that blocks larger than 1k will be truncated. CorrectCase ----------- FORMAT CorrectCase WORD DESCRIPTION Searches the dictionary for a case-insignificant match to WORD or the word currently under the cursor. If a match is found then if a WORD was specified the word found in the dictionary is returned as the result and if no WORD was given the word under the cursor will be replaced with the word found in the dictionary. NOTE: In order to get a match the word must be spelled correctly. NOTE: You must have loaded a dictionary or created at least one entry in the dictionary with the Dictionary command in order for this function to do anything. INPUTS WORD - Word to correct or nothing to use the word under the cursor. RESULTS The word found in the dictionary. CorrectWord ----------- FORMAT CorrectWord WORD DESCRIPTION Searches the dictionary for the best fitting word according to WORD or the word currently under the cursor. If a match is found then if a WORD was specified the word found in the dictionary is returned as the result and if no WORD was given, the word under the cursor will be replaced with the word found in the dictionary. NOTE: You must have loaded a dictionary or created at least one entry in the dictionary with the Dictionary command in order for this function to do anything. NOTE: Edge uses a best fit function to try to correct the given word. If it is spelled too badly Edge will not be able to correct it. However - Edge would rather guess than fail, so if you try to correct a word that is not in the dictionary you may end up with the closest thing Edge could find. This should not be a problem since it is easy to undo changes. NOTE: The first letter must be correct and enough letters typed for the correction to have a chance to be successful; i.e. you can not type 'sewiti' and hope that it will be corrected to 'SetWindowTitles'. INPUTS WORD - Word to correct or nothing to use the word under the cursor. RESULTS The word found in the dictionary. CurrentDir ---------- FORMAT CurrentDir DIRNAME DESCRIPTION Changes the current directory for Edge. If the DIRNAME is not present the user will be prompted with the FileRequester to select a directory. INPUTS DIRNAME - The new current directory, or nothing to prompt the user. RESULTS The old current directorypath. Cursor ------ FORMAT Cursor UP/N,DOWN/N,LEFT/N,RIGHT/N DESCRIPTION Moves the cursor. You may give more than one argument in order to move the cursor both horizontally and vertically with one call. The vertical movement is always executed first. The horizontal movement will not wrap at sol/eol. INPUTS UP - Number of lines to move up, towards sof. DOWN - Number of lines to move down, towards eof. LEFT - Number of characters to move left, towards sol. RIGHT - Number of characters to move right, towards eol. RESULTS The new position will be returned with the format: Line Offset Column ASCII All fields are decimal numbers. Cut --- FORMAT Cut GC=GLOBALCLIP/S,SC=SMALLCLIP/S,CHAR/S,WORD/S,BACK/S,LINE/S,SOL/S, EOL/S,APPEND/S,RB=RESULTBUFF/S DESCRIPTION Cuts the currently selected block from the file to one of the clipboards. If GLOBALCLIP is specified the text will be cut to the global clipboard; if SMALLCLIP is specified the text will be cut to the small clipboard; and if RESULTBUFF is specified the text will be cut to the ARexx result buffer, else the text will be cut to the local clipboard. The contents of the small clipboard is found in the Edge environment variable _FE_SmallClip. With normal block operations you must first select or mark the text you wish to cut to a clipboard, but that is not the case with the following switches: CHAR, WORD, LINE, SOL, and EOL. When you specify any of those switches the selected entity will be automatically marked and cut to the selected clipboard. If the APPEND flag is specified the newly cut text is not just put into the specified clip but joined to the end of that which is already in the clip - with this switch you can merge text from different places into the clip and then insert it all in one go. INPUTS GLOBALCLIP - Flag to select the globalclip. SMALLCLIP - Flag to select the smallclip. CHAR - Auto mark and cut the character under the cursor. WORD - Auto mark and cut the word beginning under and extending to the right of the cursor plus trailing spaces. BACK - This flag only works together with CHAR and WORD. If given the text to the left of the cursor is cut instead of the text to the right. LINE - Auto mark and cut the whole current line. SOL - Auto mark and cut all characters from the start of the line to the cursor, not including the character under the cursor. EOL - Auto mark and cut all characters from the cursor, including the character under the cursor, to the end of the line. APPEND - Merge mode. RESULTBUFF - Cuts to the ARexx result buffer, note that blocks larger than 1k will be truncated. Delete ------ FORMAT Delete CHAR/S,WORD/S,BACK/S,LINE/S,SOL/S,EOL/S DESCRIPTION Delete characters in some different and useful ways. INPUTS CHAR - Delete the character under the cursor; the text to the right of the deleted character is moved to the left. The cursor is not moved. WORD - Delete the word beginning under and extending to the right of the cursor plus trailing spaces; the text to the right of the deleted word is moved to the left. The cursor is not moved. BACK - This flag only works together with CHAR and WORD. If given the text to the left of the cursor is deleted instead of the text to the right. LINE - Delete the whole current line. SOL - Delete all characters from the start of the line to the cursor, not including the character under the cursor. EOL - Delete all characters from the cursor, including the character under the cursor, to the end of the line. RESULTS The new position will be returned with the format: Line Offset Column ASCII All fields are decimal numbers. Dictionary ---------- FORMAT Dictionary WORD/A,ADD/S,FORCE/S,REMOVE/S DESCRIPTION Inquires about, removes or adds a word to the dictionary. If no switches are given the current definition of WORD will be returned, if it exists. INPUTS WORD - The word you wish to affect. ADD - Switch used to add WORD to the dictionary. FORCE - Switch to suppress the 'OK to overwrite' requester that will pop up if WORD already exists. REMOVE - Switch to remove WORD from the dictionary. RESULTS The old definition of WORD. DisableUser ----------- FORMAT DisableUser , DESCRIPTION Inhibit user input in the current window and sets the busy pointer. This function is nested and must be matched by an equal number of EnableUser calls to reenable user input. EnableUser ---------- FORMAT EnableUser , DESCRIPTION Decreases the input lock counter for this window and if zero reenables user input and clears the busy pointer. EnterASCII ---------- FORMAT EnterASCII ASCII/N DESCRIPTION This function is provided so that the user may enter non-printable characters into the text. When the function is called without the argument a requester will pop up to get the ASCII number from the user. The Text function can be used to perform the same function as EnterASCII with an argument. INPUTS ASCII - ASCII value of the character to enter, or if nothing entered, prompts the user. RESULTS The new position will be returned with the format: Line Offset Column ASCII All fields are decimal numbers. Erase ----- FORMAT Erase , DESCRIPTION Delete the currently selected block of text. Fault ----- FORMAT Fault ERRNUM/N,RAW/S DESCRIPTION Get the error string assigned to the given number, if no number is given, the return code from the last function is used. If RAW is specified unprintable characters will be translated to '\\xxx', e.g. LF = '\\010'. INPUTS ERRNUM - The error number to inquire about, or input nothing to find out what went wrong with the command last called. RAW - Switch to inhibit '\\xxx' translation. RESULT An error message. Find ---- FORMAT Find CIRCULAR/N,FIND,FORWARD/N,UCEQLC/N,WILDCARD/N,WORDS/N, DESCRIPTION Finds a string in the text. If the FIND string is not given, prompts the user with the Find requester to enter the string to find. UCEQLC, FORWARD, WILDCARD, WORDS and CIRCULAR are optional flags to define how the search will be made. If not given, the current setting of the flag with the same name in _FE_Flags (displayed in the Find requester) will be used; if the option equals 0, meaning 'not in use', or 'reversed', setting the option equal to any other number will enable the option. Pattern matching will only be enabled if the WILDCARD option is enabled and the string to search for contains wildcard characters. For example if you want to search for a period followed by only one space then you would use the following in the search field @{"#?. ~( )#?" link DosWildCards}. In order to enter non printable characters use backslash and a three digit decimal number e.g. '\\010' for LF, '\\000' for NULL, etc. INPUTS CIRCULAR - Search circular (wrap at sof/eof). FIND - The string to search for, or nothing to prompt the user. FORWARD - Search forward in the file, else backwards. UCEQLC - Treat upper case as lower case. WILDCARD - Use pattern-matching when searching. WORDS - Search only for whole words. RESULTS The new position will be returned with the format: Line Offset Column ASCII All fields are decimal numbers. FindBracket ----------- FORMAT FindBracket , DESCRIPTION Search for a match to the bracket currently under the cursor. Valid brackets are '(', ')', '[', ']', '{' and '}'. RESULTS The new position will be returned with the format: Line Offset Column ASCII All fields are decimal numbers. FindCFunction ------------- FORMAT FindCFunction , DESCRIPTION Search the file for the definition of the C function currently under the cursor. RESULTS The new position will be returned with the format: Line Offset Column ASCII All fields are decimal numbers. FindReplace ----------- FORMAT FindReplace ONCE/S,ALL/S,FIND,REPLACE,UCEQLC/N,FORWARD/N,WILDCARD/N, WORDS/N,CIRCULAR/N Finds a string in the text and replaces it and stops if ONCE is specified; replaces it and all other occurrences without prompting the user if ALL is specified; or prompts the user if neither ONCE nor ALL is given. When prompted the user may select to do the following: (Y)es Replace this occurrence of the find string and search for the next occurrence. (N)o Don't replace, but search for the next. (L)ast Replace and quit searching. (A)ll Replace this and then find and change all occurrences not previously found without further prompting. Quit Don't replace and Stop searching. If the FIND or REPLACE string is not specified, the user will be prompted with the Find/Replace requester to enter the string to search for and the replacement string. UCEQLC, FORWARD, WILDCARD, WORDS and CIRCULAR are optional flags to define how the search will be made. If not given, the current setting of the flag with the same name in _FE_Flags (displayed in the Find/Replace requester) will be used, if the option is 0, it is not in use or reversed, so any other number will enable the option. Pattern matching will only be enabled if the WILDCARD option is enabled and the string to search for contains wildcard characters. Click for more information about wildcards. In order to enter non-printable characters use backslash and a three digit decimal number e.g. '\\010' for LF, '\\000' for NULL, etc. INPUTS ONCE - Replace once without prompting the user, then stop. ALL - Replace every occurrence without prompting the user. FIND - The string to search for, or nothing to prompt the user. REPLACE - The replace string. UCEQLC - Treat upper case as lower case. FORWARD - Search forward in the file, else backwards. WILDCARD - Use pattern-matching when searching. WORDS - Search only for whole words. CIRCULAR - Search circular (wrap at sof/eof). RESULTS The new position will be returned with the format: Line Offset Column ASCII All fields are decimal numbers. FindReplaceNext --------------- FORMAT FindReplaceNext ONCE/S,ALL/S,BACK/S DESCRIPTION Finds a string in the text and replaces it and stops if ONCE is specified; replaces it and all other occurrences without prompting the user if ALL is specified; or prompts the user if neither ONCE nor ALL is given. When prompted the user may select to do the following: (Y)es Replace this occurrence of the find string and search for the next occurrence. (N)o Don't replace, but search for the next. (L)ast Replace and quit searching. (A)ll Replace this and then find and change all occurrences not previously found without further prompting. Quit Don't replace and Stop searching. The search is made using the contents of the _FE_FindString buffer and the search flags in _FE_Flags, the replacement string used is _FE_ReplaceString. If BACK is specified the search is made backwards in the file, towards sof (start of file). INPUTS ONCE - Replace once without prompting the user, then stop. ALL - Replace every occurrence without prompting the user. BACK - The search will be made backwards, towards sof. RESULTS The new position will be returned with the format: Line Offset Column ASCII All fields are decimal numbers. FindIMark --------- FORMAT FindIMark MARK/A/N DESCRIPTION Searches the file for the specified IMark. First the IMark image is expanded using the supplied argument and then the search is made. In the IMark image a small x specifies the mark number, so '/*x*/'f. RESULTS The new position will be returned with the format: Line Offset Column ASCII All fields are decimal numbers. FindIMark --------- FORMAT FindIMark MARK/A/N DESCRIPTION Searches the file for the specified IMark. First the IMark image is expanded using the supplied argument and then the search is made. In the IMark image a small x specifies the mark number, so '/*x*/' will expand to '/*4*/' if the argument is 4 and '/*-999*/' if the argument is -999. The IMark must be placed at column 1. The search is case-sensitive. INPUTS MARK - The imark number to search for. RESULTS The new position will be returned with the format: Line Offset Column ASCII All fields are decimal numbers. FindLabel --------- FORMAT FindLabel , DESCRIPTION Searches the file for the definition of the label currently under the cursor. The label must be a standard assembler label using characters 'a' - 'z', 'A' - 'Z', '0' - '9', '.' and '_'. It must start on column 1 if not ended with a colon ':'. If ended with a colon ':' it may start on any column if all characters preceding it are spaces and/or tabs. The search is case-sensitive. RESULTS The new position will be returned with the format: Line Offset Column ASCII All fields are decimal numbers. FindNext -------- FORMAT FindNext BACK/S DESCRIPTION Searches for the current contents of _FE_FindString in the text. If BACK is specified the search is made backwards. INPUTS BACK - The search will be made backwards, towards sof. RESULTS The new position will be returned with the format: Line Offset Column ASCII All fields are decimal numbers. Flag ----- FORMAT Flag FIELD/A,FLAG/A,T=TOGGLE/S,S=SET/S,C=CLEAR/S DESCRIPTION Change and/or inquire about the state of a flag. If none of the action switches are specified the flag is left unchanged. INPUTS FIELD - What flag field to affect. FLAG - What flag to change or inquire about. TOGGLE - Toggle the state of the flag. SET - Set the flag. CLEAR - Clear the flag. RESULTS The old state of the flag. Font ---- FORMAT Font NAME,SIZE/N,SCREEN/S,TEXT/S,GADGET/S,BOLD/S,ITALIC/S,UNDERLINE/S, SCALE/S DESCRIPTION Change the font(s). INPUTS NAME - Name of the font to use, with or without .font. SIZE - Size of the font to use. SCREEN - The change will affect the screen font. TEXT - The change will affect the text font. GADGET - The change will affect the gadget font. BOLD - Use Bold style. ITALIC - Use Italic style. UNDERLINE - Use UnderLined style. SCALE - Allow font scaling. EXAMPLES Font GADGET TEXT SCREEN BOLD ; change all fonts to bold style Font SIZE 16 SCREEN ; change size of the screen font Fold ---- FORMAT Fold SHOW/S,HIDE/S,SHOWNESTED/S,HIDENESTED/S,SHOWALL/S,HIDEALL/S DESCRIPTION This command is used to show and hide folds in the text. In order to hide a piece of text by folding it, the text must be enclosed within special foldmarkers, defined by _FE_FoldStart and _FE_FoldEnd, and the cursor positioned within the text you wish to fold, unless HIDEALL is specified. The foldmarkers must appear on column one of the line they are in. The default definition is '/*fs*/' for _FE_FoldStart and '/*fe*/' for _FE_FoldEnd. To show a piece of text, unfold it, the cursor must be positioned on the line just above or below the text you wish to unfold. Normally this is easy since the foldmarkers aren't hidden when folded, so just put the cursor on one of the lines with the foldmarkers enclosing the folded text. If SHOWALL is specified the cursor may be positioned anywhere - all folds are shown anyway. INPUTS SHOW - Unfold the current fold. HIDE - Fold the current fold. SHOWNESTED - Unfold the entire tree of the current fold. HIDENESTED - Fold the entire tree of the current fold. SHOWALL - Unfold all folds. HIDEALL - Fold all folds. Format ------ FORMAT Format LEFT/S,RIGHT/S,CENTER/S,FILL/S DESCRIPTION Formats a paragraph of text, starting at the current line and continuing to the first empty or hard-space indented line. If the first line is hard-space indented, that indent will be used for the entire formatted paragraph. Only one formatting option may be specified at a time. The indent of the first line is kept if the format is LEFT or FILL. Punctuation marks, e.g. end of sentence characters, and the number of spaces to put after, e.g. the number of spaces between end of sentence - start of sentence, are defined by two variables: INPUTS LEFT - Straight left edge, ragged right edge. RIGHT - Straight right edge, ragged left edge. CENTER - Center the lines, ragged left- and right edges. FILL - Straight left- and right edges. GetENVVar --------- FORMAT GetENVVar NAME/A,RAW/S DESCRIPTION Get the value of an Edge environment variable. INPUTS NAME - The name of the variable to read. RAW - Switch to suppress the '\\xxx' translation of 'non-printing' chars. RESULTS The value of the given variable. GlobalSettings -------------- FORMAT GlobalSettings PRINTER/S,SCREEN/S,WINDOWS/S DESCRIPTION Bring up the Global Settings control panel so the user can alter the settings. If no startup switch is given general settings will be displayed. INPUTS PRINTER - Show printer settings when opened. SCREEN - Show screen settings when opened. WINDOWS - Show window settings when opened. Edge Help : GoToAuto FORMAT GoToAuto , DESCRIPTION Moves the cursor to AutoBookMark. The AutoBookMark is a special bookmark automatically set, before the cursor is moved, by the following commands: Find FindNext FindReplace FindReplaceNext FindCFunction FindLabel FindBracket FindIMark Position GoToBookMark GoToLine GoToPage GoToError GoToByte Paste RESULTS The new position will be returned with the format: Line Offset Column ASCII All fields are decimal numbers. GoToBookMark ------------ FORMAT GoToBookMark MARK/A/N DESCRIPTION Moves the cursor to the given bookmark. The number must be within the valid range 1 - 10 or an error will be reported. INPUTS MARK - Bookmark to move to. RESULTS The new position will be returned with the format: Line Offset Column ASCII All fields are decimal numbers. GoToByte -------- FORMAT GoToByte BYTE/N DESCRIPTION Moves the cursor to the given byte in the file; if no argument is given the user will be prompted for a number. INPUTS BYTE - Byte to move to, or nothing to prompt the user. RESULTS The new position will be returned with the format: Line Offset Column ASCII All fields are decimal numbers. GoToColumn ---------- FORMAT GoToColumn COLUMN/N DESCRIPTION Moves the cursor to the given column on the current line, or if no argument is given prompts the user for a number and uses that. INPUTS COLUMN - Column to move to, or nothing to prompt the user. RESULTS The new position will be returned with the format: Line Offset Column ASCII All fields are decimal numbers. GoToError --------- FORMAT GoToError ERRNUMBER/N,PREVIOUS/S,SHOW/S DESCRIPTION Moves the cursor to the line and column of the next entry in the error-list and displays the error-message in the window title bar. If an ERRNUMBER is given, then this function goes to and displays this error, and if PREVIOUS is specified, then it displays the previous error in the list. If SHOW is specified a window will open, displaying all errors linked, but if the error list is currently empty no window will open. INPUTS ERRNUMBER Go to the error number given, or the last error linked if the number specified is greater than the number of errors linked. PREVIOUS Switch used to move backwards in the error-list. SHOW Switch to open a window in which all linked errors can be viewed. RESULTS The new position will be returned with the format: Line Offset Column ASCII All fields are decimal numbers. GoToLine -------- FORMAT GoToLine LINE/N Moves the cursor to the given line, or if no argument is given prompts the user for a number and uses that. INPUTS LINE - Line to move to, or nothing to prompt the user. RESULTS The new position will be returned with the format: Line Offset Column ASCII All fields are decimal numbers. GoToPage -------- FORMAT GoToPage PAGE/N DESCRIPTION Moves the cursor to the first line of the given page, or if no argument is given prompts the user for a page number and uses that. INPUTS PAGE - Page to move to, or if nothing, prompts the user. RESULTS The new position will be returned with the format: Line Offset Column ASCII All fields are decimal numbers. Help ---- FORMAT Help HELPFILE/K,SECTION,LOADINDEX/S,LOADALL/S,CACHENODE/S,KEEPCACHE/S, QUIT/S DESCRIPTION Activates the Help-system and displays the named section if given, else displays the last visited section. If the help system is activated for the first time and no section is given, the MainMenu will be displayed. The switches are used to control the operation of the help system. INPUTS HELPFILE - The help-file to use, default 'EdgePrg:help/Edge.guide'. SECTION - The section to display at activation. LOADINDEX - Force load index at startup. LOADALL - Force load the entire database at startup. CACHENODE - Cache each section as visited. KEEPCACHE - Hold on to the buffers until purged. QUIT - Tell AmigaGuide to close down and free all buffers. Iconify ------- FORMAT Iconify FORCE/S,FORCEREXX/S,FORCEOK/S,SAVE/S,ICONS/S,NOICONS/S,BACKUPS/S, NOBACKUPS/S DESCRIPTION Makes Edge dormant. If ICONWINDOW, in _GE_Flags, is enabled a small icon-window will be opened in the Workbench screen. To wake up Edge either activate the icon-window and press the right mouse button or press the Edge hotkey, as defined in _GE_CX_PopKey, or send a 'Wakeup' or a 'New' command to the global Edge ARexx port. If you wish to quit Edge when in dormant mode either click the close gadget in the icon-window or use Commodities Exchange to kill it, or send a 'Quit' command to the global Edge ARexx port. The FORCE switch suppresses the requester that will pop up if any changes have been made to any file, asking the user to confirm that losing the changes is OK. The FORCEOK switch suppresses the requester that pops up if no changes are made and no ARexx messages are outstanding, asking if quitting the file is OK. The FORCEREXX switch suppresses the requester that will pop up if any of the windows have any outstanding ARexx messages (the requester is only visually suppressed - the outstanding messages must return before the editor can be unloaded). If the SAVE switch is present all changes will be saved before Edge is iconified. The ICON, NOICON, BACKUP and NOBACKUP switches are used to force or suppress icon and backup creation when saving. Edge will NOT iconify if there are outstanding ARexx messages. All ARexx messages must return before Edge will iconify. INPUTS FORCE - Suppress the requester asking the user about losing any changes. FORCEREXX - Suppress the 'ARexx outstanding messages' requester. FORCEOK - Suppress the 'OK to iconify Edge' requester. SAVE - Save the file(s) before iconifying. ICONS - Force create icons for all files saved. NOICONS - Suppress icon creation for all files saved. BACKUPS - Force create backups for all files saved. NOBACKUPS - Suppress backup creation for all files saved. Include ------- FORMAT Include FILENAME DESCRIPTION Includes the named file in the current file at the current cursor position. If no file is given, prompts the user with a FileRequester for a filename. INPUTS FILENAME - Name of the file to include, or nothing to prompt the user. RESULTS The name of the included file. KeyBoard -------- FORMAT KeyBoard KEY/A,Q=QUALIFIER/K,QM=QUALMASK/K,ASK/S,FORCE/S,COMMAND/F DESCRIPTION Inquire about, remove, change or add a keyboard command. INPUTS KEY - The key to use. QUALIFIER - The qualifiers to test for. QUALMASK - The qualifiers to mask out before the qualifier test is made. ASK - Use this switch to get the current command assigned to KEY. FORCE - Suppresses the requester that will pop up if KEY already exists. COMMAND - The command to be assigned to KEY. EXAMPLES KeyBoard "up" ask ; will normally return "cursor up 1". KeyBoard "up" ; remove the installed command. KeyBoard up cursor down 1 ; add it again. KeyBoard up force cursor up 1 ; make it right this time. RESULTS The old command assigned to KEY Learn ----- FORMAT Learn FILENAME DESCRIPTION Starts/Stops the recording of a macro. If this command is issued and no macro is currently defined, a new macro will be created with the given name, or 'ram:Edge.macro' if no name is given. If this command is issued and a macro is currently defined, then the macro recording is stopped. When macro recording is enabled, the commands executed by the user, menu or keyboard events, and normal typing will also be written to the macrofile as an ARexx script that can later be executed. INPUTS FILENAME - The name of the macro, or nothing for the default name 'ram:Edge.macro' LoadDictionary -------------- FORMAT LoadDictionary FILENAME,FORCE/S,APPEND/S DESCRIPTION Loads a new dictionary configuration from 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 a word already exists. If the APPEND switch is present the current dictionary will not be cleared before the new one is loaded, so you can merge different definitions together. INPUTS FILENAME - Name of the file to use, or nothing for the default one. FORCE - Suppress the 'OK to overwrite..' requester. APPEND - Merge mode. LoadENV ------- FORMAT LoadENV FILENAME,GE/S,LE/S,DEFLE/S,PATTERN DESCRIPTION Loads environment variables from a file. Normally the environment variables are stored in two files; Edge.global and Edge.local. However, you may choose to save all environment variables in one file and then use LoadENV to load it all. If no FILENAME is given the user will be prompted with the FileRequester to enter a filename. The Pattern is used to select which variables to load and supports wildcard expansion. If no pattern is given all variables present in the file will be loaded. INPUTS FILENAME - The name of the env-file to load, no name prompts the user. GE - Use this switch to load the Global Environment Variables. LE - Use this switch to load the Local Environment Variables. DEFLE - Use this switch to load the Default Environment Variables. PATTERN - Pattern to select which variables to load, or nothing for all. EXAMPLES LoadEnv 'my_edge.prefs' GE LE DEFLE RESULTS The name of the loaded prefs-file. LoadKeyboard ------------ FORMAT LoadKeyboard FILENAME,FORCE/S,APPEND/S DESCRIPTION Loads a new keyboard definition from the 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. The FORCE switch is used to suppress the requester that will pop up if a key already exists. If the APPEND switch is present the current keyboard definition will not be cleared before the new one is loaded, so you can merge different definitions together. INPUTS FILENAME - Name of the file to use, or nothing for the default one. FORCE - Suppress the 'OK to overwrite..' requester. APPEND - Merge mode. LoadMenus --------- FORMAT LoadMenus FILENAME,APPEND/S DESCRIPTION Loads a new menu definition from the 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. If the APPEND switch is present the current menu definition isn't cleared before the new one is loaded so you can merge different definitions together. INPUTS FILENAME - Name of the file to use, or nothing for the default one. APPEND - Merge mode. LoadMouseButtons ---------------- FORMAT LoadMouseButtons FILENAME,FORCE/S,APPEND/S DESCRIPTION Loads a new mouse button definition from the file with the given name. If no name is given, the default name, either EdgePrg:Edge.mousebuttons or the name defined by the user at startup with the MOUSEBUTTONS keyword/tooltype, is used. The FORCE switch is used to suppress the requester that will pop up if a button already exists. If the APPEND switch is present the current definition will not be cleared before the new one is loaded, so you can merge different definitions together. INPUTS FILENAME - Name of the file to use, or nothing for the default one. FORCE - Suppress the 'OK to overwrite..' requester. APPEND - Merge mode. LoadTexts --------- FORMAT LoadTexts FILENAME,APPEND/S DESCRIPTION Loads a new requester definition from 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. If the APPEND switch is present the current definition isn't cleared before the new one is loaded so you can merge different definitions together. INPUTS FILENAME - Name of the file to use, or nothing for the default one. APPEND - Merge mode. LoadTemplates ------------- FORMAT LoadTemplates FILENAME,FORCE/S,APPEND/S DESCRIPTION Loads a new template configuration from 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 a template already exists. If the APPEND switch is present the current configuration will not be cleared before the new one is loaded, so you can merge different definitions together. INPUTS FILENAME - Name of the file to use, or nothing for the default one. FORCE - Suppress the 'OK to overwrite..' requester. APPEND - Merge mode. LocalSettings ------------- FORMAT LocalSettings , DESCRIPTION Bring up the LocalSettings control panel so the user may adjust the settings, save or load them. LowerCase --------- FORMAT LowerCase CHAR/S,WORD/S,BACK/S,LINE/S,SOL/S,EOL/S,BLOCK/S DESCRIPTION Convert characters to lower case in some different and useful ways. INPUTS CHAR The character under the cursor; the cursor is moved to the right. WORD 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 given, 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 whole 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. MarkBlock --------- FORMAT MarkBlock COLUMNAR/S DESCRIPTION Turn on block mode in order to select a block; if block mode is already engaged it will discontinue. If the COLUMNAR switch is given the block selected will be of columnar type, else normal. INPUTS COLUMNAR - Switch to mark columnar blocks. EdgeToBack ---------- FORMAT EdgeToBack , DESCRIPTION Move the Edge screen behind all other screens. EdgeToFront ----------- FORMAT EdgeToFront , DESCRIPTION Bring the Edge screen in front of all other screens. MouseButton ----------- FORMAT MouseButton BUTTON/A,Q=QUALIFIER/K,QM=QUALMASK/K,ASK/S,FORCE/S,COMMAND/F DESCRIPTION Inquire about, remove, change or add a mouse button command. INPUTS BUTTON - The mouse button click sequence to use. QUALIFIER - The qualifiers to test for. QUALMASK - The qualifiers to mask out before the qualifier test is made. ASK - Use this switch to get the current command assigned to BUTTON. FORCE - Suppresses the requester that will pop up if BUTTON already exists. COMMAND - The command to be assigned to BUTTON. EXAMPLES MouseButton DOUBLELEFT Q="shift" ask ; normally returns "markblock columnar". MouseButton DOUBLELEFT Q="shift" ; remove the installed command. MouseButton DOUBLELEFT Q="shift" markblock ; add it again. MouseButton DOUBLELEFT Q="shift" force markblock columnar ; make it right RESULTS The old command assigned to BUTTON MovePage -------- FORMAT MovePage UP/N,DOWN/N,LEFT/N,RIGHT/N,CENTER/S DESCRIPTION Scrolls the text, but keeps the cursor on the same character. The text can only be scrolled as long as the cursor is within the defined scrollborders. INPUTS UP - Number of lines to scroll up. DOWN - Number of lines to scroll down. LEFT - Number of characters to scroll left. RIGHT - Number of characters to scroll right. CENTER - Try to put the cursor in the middle of the window, the other arguments are ignored if this switch is given. MoveScreen ---------- FORMAT MoveScreen LEFTEDGE/N,TOPEDGE/N,DELTAX/N,DELTAY/N DESCRIPTION Scrolls the Edge screen either to an absolute position or relative to the current one. This is only possible if the screen size is bigger than the actual display size, e.g. an autoscroll screen. INPUTS LEFTEDGE - Move the screen to this absolute x position. TOPEDGE - Move the screen to this absolute y position. DELTAX - Move the screen horizontally this amount relative to the current x position. DELTAY - Move the screen vertically this amount relative to the current y position. New --- FORMAT New PORTNAME/K,LEFTEDGE/N,TOPEDGE/N,WIDTH/N,HEIGHT/N, ZOOMLEFTEDGE/N,ZOOMTOPEDGE/N,ZOOMWIDTH/N,ZOOMHEIGHT/N,PATH,NAME, COPYLS/S DESCRIPTION Creates a new file in Edge. You may specify a custom ARexx-address, the initial window size/position, the initial zoomed size/position and the initial path and name. If you don't supply any arguments defaults will be used, unless the COPYLS switch is present - in which case the local settings will be copied from the file executing the New command. INPUTS PORTNAME - ARexx port's address for this window. LEFTEDGE - Window x position. TOPEDGE - Window y position. WIDTH - Window width. HEIGHT - Window height. ZOOMLEFTEDGE - Window zoomed x position. ZOOMTOPEDGE - Window zoomed y position. ZOOMWIDTH - Window zoomed width. ZOOMHEIGHT - Window zoomed height. PATH - The DOS path to use. NAME - The name for this file. COPYLS - Copies the local settings from the file executing the New command. NOTE The file specified is not loaded. The new file will simply use that name and path. When running from ARexx, the host address is not changed to that of the new window. In order to do so you must 'address value result' using the result from this command. RESULTS The ARexx-address (ARexx port name) for the new window. NewLine ------- FORMAT NewLine NI=NOINDENT/S,I=INDENT/S,TI=TOGGLEINDENT/S DESCRIPTION Inserts a new line in the text below the current one, but doesn't split the current line. If NOINDENT is specified, NewLine will not Autoindent the new line as it usually does if Autoindent is enabled. If INDENT is specified Newlinw will indent the Newline regardless of the state of Autoindent. If TOGGLEINDENT is specified Newline will do the opposite from that specified by the Autoindent flAg I.E If Autoindent is on Newline doesn't Indent and if Autoindent is off, then newline will indent the new line INDENT - Force an indent of the new line. TOGGLEINDENT - Do the opposite as specified by the AutoIndent flag. RESULTS The new position will be returned with the format: Line Offset Column ASCII All fields are decimal numbers. Next ---- FORMAT Next WORD/S,PAGE/S DESCRIPTION Move the cursor to the beginning of the next word or page. INPUTS WORD - Move to next word. PAGE - Move to next page. RESULTS The new position will be returned with the format: Line Offset Column ASCII All fields are decimal numbers. Nop --- FORMAT Nop , DESCRIPTION This command does nothing, which is sometimes useful. Open ---- FORMAT Open FILES/M,FORCE/S,RESTORELS/S,PATH/K DESCRIPTION Loads a new file into the current work area, and if multiple files are specified, opens new work areas and loads those files too. If no names are given, the user will be prompted with the FileRequester. The FORCE switch suppresses the requester that will pop up if any changes have been made to the current file, asking the user to confirm that losing the changes is OK. If the RESTORELS switch is present the local settings will be loaded with the default local settings before the new file is loaded. If not present, the settings used in the old file will be kept, if not overridden by variables saved in the new files icon. The PATH component is used to specify a path for all files not having an absolute path specified within them. INPUTS FILES Name(s) of the file(s) to load. No input here prompts the user to supply name(s). The name(s) may contain wildcard characters. FORCE Suppresses the requester prompting the user about losing any changes (this only applies for the current file). RESTORELS Loads the localsettings with default values before loading the new file (this only applies for the current file). PATH Path for non-absolute file specifications. EXAMPLES Let's assume that the current directory in Edge is 'work:', then open work:source.c source.c path myfiles will open the files 'work:source.c' and 'work:myfiles/source.c' and open work:source.c source.c path dh0: will open the files 'work:source.c' and 'dh0:source.c'. RESULTS The name of the loaded file. OpenClip -------- FORMAT OpenClip FILENAME,GC=GLOBALCLIP/S,APPEND/S DESCRIPTION Loads a new file into one of the clipboards, local or global. If no FILENAME is specified the user will be prompted with a FileRequester. If the APPEND flag is specified, the loaded text is not just put into the specified clip but joined to the end of what is already in the clip. With this switch you can merge different files into the clip and then insert it all in one go. INPUTS FILENAME Path and name of the file to load, or nothing to prompt the user. GLOBALCLIP Switch to select the global clipboard; if not given, the local clipboard is used. APPEND Merge mode. RESULTS The name of the loaded file. Paste ----- FORMAT Paste GC=GLOBALCLIP/S,GCC=GLOBALCLIPCOLUMNAR/S,SC=SMALLCLIP/S DESCRIPTION Inserts the contents of one of the clips at the current cursor position. If no switch is given, the contents of the local clip is inserted. When using the globalclip, i.e. the system clipboard, you yourself must decide how to insert it - Normal or Columnar. INPUTS GLOBALCLIP Switch to select the global clip as a normal block. GLOBALCLIPCOLUMNAR Insert the globalclip as a columnar block. SMALLCLIP Switch to select the small clip. Position -------- FORMAT Position LINE/N,COLUMN/N,CHAR/N,SOF/S,EOF/S,SOL/S,EOL/S,SOW/S,EOW/S,SOP/S, EOP/S DESCRIPTION Positions the cursor absolutely at some useful locations. You can only specify one switch at a time, except if you use LINE you may also use COLUMN or CHAR. INPUTS LINE Line to move to. COLUMN Column to move to. CHAR Character to move to (byte offset from sol). SOF Move to Start of File. EOF Move to End of File. SOL Move to Start of Line. EOL Move to End of Line. SOW Move to Start of Word. EOW Move to End of Word. SOP Move to Start of Page. EOP Move to End of Page. RESULTS The new position will be returned with the format: Line Offset Column ASCII All fields are decimal numbers. Previous -------- FORMAT Previous WORD/S,PAGE/S DESCRIPTION Moves cursor to the beginning of the previous word or page. INPUTS WORD Move to the previous word. PAGE Move to the previous page. RESULTS The new position will be returned with the format: Line Offset Column ASCII All fields are decimal numbers. PrintClip --------- FORMAT PrintClip GC=GLOBALCLIP/S,PROMPT/S DESCRIPTION Prints either the local or global clip, depending on the GLOBALCLIP switch, using the current printer settings. If the PROMPT switch is specified, the Global Settings - Printer requester will be opened to let the user alter the printer settings before printing the contents of the selected clipboard. The changes are only for that print session, however, if the PROMPT keyword is used. INPUTS GLOBALCLIP Switch to select the global clipboard. PROMPT To allow the user to change the printer settings. Print ----- FORMAT Print PROMPT/S DESCRIPTION Prints the current file using the current printer settings. If the PROMPT switch is specified the Global Settings - Printer requester will be opened to let the user alter the printer settings before printing. The changes are only for that print session, however, if PROMPT is used. INPUTS PROMPT To allow the user to change the printer settings. PutENVVar --------- FORMAT PutENVVar NAME/A,VALUE/A DESCRIPTION Puts a new value in an Edge environment variable. INPUTS NAME Name of the variable to affect. VALUE The new value. NOTE: if VALUE starts with an underscore '_', it is assumed to be an Edge environment variable. RESULTS The old value of the given variable. The FORCEREXX Switch suppresses the requester that will pop up if any of the windows have any outstanding ARexx messages (the requester is only visually suppressed - the outstanding messages must return before the editor can be unloaded). The FORCEOK switch suppresses the requester that pops up if no changes are made and no ARexx messages are outstanding, asking if quitting the file is OK. If the SAVE switch is present all changes will be saved before Edge is closed. The ICON, NOICON, BACKUP and NOBACKUP switches are used to force or suppress icon and backup creation when saving. NOTE If any window has outstanding ARexx messages, then Edge will wait for these messages to return before unloading the editor. If there are any Locks/Opens active to the Edge: disk then Edge will refuse to close down and this command will fail. INPUTS FORCE - Suppress the requester asking the user about losing any changes. FORCEREXX - Suppress the 'ARexx outstanding messages' requester. FORCEOK - Suppress the 'OK to quit Edge' requester. SAVE - Save the file(s) before closing down. 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. Redo ---- FORMAT Redo , DESCRIPTION Redo the undos. RequestFile ----------- FORMAT RequestFile TITLE/K,PATH,FILE,PATTERN,DIR/S,SAVE/S,GETDIR/S,MULTISELECT/S DESCRIPTION Brings up the FileRequester so the user may select a file or directory. INPUTS TITLE - The title, or nothing for default. PATH - The directory path, or nothing for the last used. FILE - The preloaded filename, or nothing for the last used. PATTERN - The wildcard pattern to use, or nothing for the last used. DIR - The user selects a directory (no files listed). SAVE - The filename selected will be used in a write operation (no check is made to see if the file exists, but a validity check is made on the filename). GETDIR - Read the given directory at activation. MULTISELECT - Enable multiselect, but only if SAVE and DIR isn't specified. RESULTS The path and/or file the user selected. If MULTISELECT is enabled the returned string will be a pattern, e.g. 'm:(a.c|b.c|c.c)' 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. Copyright Information --------------------- Edge v1.70 (c) Copyright 1992-93, Thomas liljetoft, All Rights Reserved ALL SOFTWARE PROGRAMS AND DOCUMENTATION PROVIDED HEREIN, WITH THE EXCEPTION OF AMIGA INSTALLER AND AMIGAGUIDE PROGRAMS, ARE ENTIRELY COPYRIGHT 1993 BY THOMAS LILJETOFT. ALL RIGHTS ARE RESERVED. YOU MAY NOT COPY, MODIFY, OR TRANSFER THE PROGRAMS OR DOCUMENTATION BY ANY MEANS WHATSOEVER. THE PROGRAMS AND DOCUMENTATION ARE SOLD "AS IS" AND SUBJECT TO CHANGE; NO WARRANTIES ARE MADE. ALL USE IS AT YOUR OWN RISK. NO LIABILITY OR RESPONSIBILITY IS ASSUMED. The following copyright and licensing information refers only to Amiga Installer and AmigaGUIDE files contained in this package. Installer Version 2.17 (c) Copyright 1991-93 Commodore-Amiga, Inc. All Rights Reserved Reproduced and distributed under license from Commodore. AmigaGuide and AmigaGuide.info Version 34.3 AmigaGuide.Library Version 34.11 (c) Copyright 1991-93 Commodore-Amiga, Inc. All Rights Reserved. Reproduced and distributed under license from Commodore. INSTALLER AND AMIGAGUIDE SOFTWARE IS PROVIDED "AS-IS" AND SUBJECT TO CHANGE; NO WARRANTIES ARE MADE. ALL USE IS AT YOUR OWN RISK. NO LIABILITY OR RESPONSIBILITY IS ASSUMED. Technical Support Information ----------------------------- Technical support is only available to registered users, so don't forget to send in your registration card. Feel free to write/fax to the USA address with suggestions and comments about Edge. Technical support is available on these telecom services: We have conference areas on... BIX inovatronics CompuServe AMIGAVEND, area 8 Portal inovatronics Electronic mail addresses... BIX inovatronics CompuServe 75300,361 Portal inovatronics Internet inovatronics@bix.com Our various addresses around the world: INOVAtronics, Inc. Tel: (214) 340-4991 8499 Greenville Ave. Suite 209B FAX: (214) 340-8514 Dallas, TX 75231 USA Orders: (800) 875-8499 (North America Only!) Hours: 9:00am-5:30pm CST/CDT Tech Support: (214) 340-4992 Hours: 11:00am-3:00pm CST/CDT BBS: (214) 342-1930 Inovatronics GmbH Tel: 49-2241-40 68 56 Lόtticher Straίe 12 FAX: 49-2241-40 67 73 D-53842 Troisdorf-Spich Germany Inovatronics, Ltd. Tel: 44-707-662861 Unit 11, Enterprise Centre FAX: 44-707-660992 Cranborne Road Potters Bar, Hertfordshire EN6 3DQ England -----------------------------------END------------------------------------- ________________________________________ \____ \____/ ___________ Ž____ \ Ž__ | | \ \ \ \ \/ | _ \ | \ Ž_____ Œ_ Œ____ Œ_ /\ _€___€_ Œ___ / +------\/--\/-----\/--\/--\/-------\/RtX!\/+