Browsing Made Easy

Last Updated: 19th June 2003


<< Preferences Chapter Contents Chapter Printing Chapter >>

ARexx Notes
Before introducing the ARexx commands present in this release of IBrowse², here is a brief overview of the ARexx argument conventions, and the error codes generated by IBrowse² when an ARexx commands fails.
ARGUMENT/A Required. This keyword must be given a value during command-line (CLI) processing, or when used in an ARexx script, or an error will be returned.
OPTION/S Switch. This is considered a Boolean variable, and will be set if the option name appears on the command-line (CLI), or in an ARexx script. The entry is the Boolean, i.e. 0 for not set, non-zero for set.
VALUE/N Number. This parameter is considered a decimal number. If an invalid number is specified, an error will be returned.
IBrowse² will set the return code variable RC to one of the following error codes if an ARexx command fails:
-2 Out Of Memory error. This error will be returned when the system is out of memory during ARexx execution, but the cause was unknown.
-3 Unknown ARexx Command error. This error will be returned when an unknown ARexx command has been issued to IBrowse²
-4 Unknown Syntax error. This error will be returned when the syntax for an ARexx command is incorrect.
-5 Unknown Item error. This error will be returned when an ITEM has been supplied that is not known by IBrowse²
-6 No Browser Active error. This error will be returned when an action has been specified for a browser, when no active or current browser is available.
Info The examples provided are for executing the ARexx calls from a Shell/CLI prompt.

Standard MUI Commands
QUIT FORCE/S
This command will instruct IBrowse² to exit. If Preferences » General » Safe requester is enabled, you will be asked to confirm that you would like to quit.
e.g. rx "ADDRESS IBROWSE; 'QUIT'"
FORCE/S
This switch will instruct IBrowse² to exit without a confirmation requester even if Preferences » General » Safe requester is enabled.
e.g. rx "ADDRESS IBROWSE; 'QUIT FORCE'"
SHOW
This command will instruct IBrowse² to uniconify itself, and if it is running on its own screen, bring it to front.
e.g. rx "ADDRESS IBROWSE; 'SHOW'"
HIDE
This command will instruct IBrowse² to iconify itself, and if it is running on its own screen, close it.
e.g. rx "ADDRESS IBROWSE; 'HIDE'"
ACTIVATE
This command will instruct IBrowse² to uniconify itself, and if it is running on its own screen, bring it to front.
e.g. rx "ADDRESS IBROWSE; 'ACTIVATE'"
Info This command is the same as SHOW.
DEACTIVATE
This command will instruct IBrowse² to iconify itself, and if it is running on its own screen, close it.
e.g. rx "ADDRESS IBROWSE; 'DEACTIVATE'"
Info This command is the same as HIDE.
INFO ITEM/A
This command will return the information for an ITEM. Valid ITEMs are:
TITLE, AUTHOR, COPYRIGHT, DESCRIPTION, VERSION, BASE, SCREEN
e.g. rx "OPTIONS RESULTS; ADDRESS IBROWSE; 'INFO ITEM=TITLE'; SAY RESULT"
Info ITEM is case insensitive.
Error Sets RC to -5 if ITEM is not found.
ITEM
The following keywords are valid ITEMs:
TITLE
This keyword will return the TITLE string specified by the application
e.g. rx "OPTIONS RESULTS; ADDRESS IBROWSE; 'INFO ITEM=TITLE'; SAY RESULT"
AUTHOR
This keyword will return the AUTHOR string specified by the application
e.g. rx "OPTIONS RESULTS; ADDRESS IBROWSE; 'INFO ITEM=AUTHOR'; SAY RESULT"
COPYRIGHT
This keyword will return the COPYRIGHT string specified by the application
e.g. rx "OPTIONS RESULTS; ADDRESS IBROWSE; 'INFO ITEM=COPYRIGHT'; SAY RESULT"
DESCRIPTION
This keyword will return the DESCRIPTION string specified by the application
e.g. rx "OPTIONS RESULTS; ADDRESS IBROWSE; 'INFO ITEM=DESCRIPTION'; SAY RESULT"
VERSION
This keyword will return the VERSION string specified by the application
e.g. rx "OPTIONS RESULTS; ADDRESS IBROWSE; 'INFO ITEM=VERSION'; SAY RESULT"
BASE
This keyword will return the BASE ARexx port ID for the application
e.g. rx "OPTIONS RESULTS; ADDRESS IBROWSE; 'INFO ITEM=BASE'; SAY RESULT"
SCREEN
This keyword will return the SCREEN name that the application is running on.
e.g. rx "OPTIONS RESULTS; ADDRESS IBROWSE; 'INFO ITEM=SCREEN'; SAY RESULT"
HELP FILE/A
This command will return a list of available ARexx commands and templates, and output them to the file specified. FILE/A should be a valid filename to output the data to.
e.g. rx "ADDRESS IBROWSE; 'HELP FILE=RAM:arexx.txt'"

IBrowse² Internal Commands
ADDHOTLIST GROUP/S, TITLE/A, URL, SHORTCUT, SHOWINMENU/N, INSERTGROUP, ACTIVATE/S
This command is used to add an entry to the Hotlist Manager.
GROUP/S
This switch is used to specify that TITLE will be used as the title of a new group entry, rather than as the title of a new URL entry.
e.g. rx "ADDRESS IBROWSE; 'ADDHOTLIST GROUP TITLE=Group'"
TITLE/A
This command is used to specify the text used for the title of the entry, and has a maximum length of 127 characters.
e.g. rx "ADDRESS IBROWSE; 'ADDHOTLIST GROUP TITLE=Group'"
e.g. rx "ADDRESS IBROWSE; 'ADDHOTLIST TITLE=Link URL=www.newlink.com'"
URL
This keyword is used to specify the URL for the entry you are adding, and is ignored if the GROUP switch is specified.
e.g. rx "ADDRESS IBROWSE; 'ADDHOTLIST TITLE=Link URL=www.newlink.com'"
SHORTCUT
This keyword is used to specify the alias for the entry you are adding. It must not contain ":./<>?& characters.
e.g. rx "ADDRESS IBROWSE; 'ADDHOTLIST TITLE=Link URL=www.newlink.com SHORTCUT=nl'"
SHOWINMENU/N
This keyboard is used to specify if the entry should be shown in Menus » Bookmarks. Specifying any number other than 0 will add it to the menu, 0 will never add it to the menu, and if the keyword is not specified, then the decision will be based on your setting for Preferences » General » Show new Hotlist Manager entries in menu.
e.g. rx "ADDRESS IBROWSE; 'ADDHOTLIST TITLE=Link URL=www.newlink.com SHOWINMENU=1'"
e.g. rx "ADDRESS IBROWSE; 'ADDHOTLIST TITLE=Link URL=www.newlink.com SHOWINMENU=0'"
INSERTGROUP
This keyword is used to specify the group you would like to add the entry to. If you have a group in your Hotlist Manager called News, and wanted to add a new entry to that group, you would use this keyword.
e.g. rx "ADDRESS IBROWSE; 'ADDHOTLIST TITLE=Link URL=www.newlink.com INSERTGROUP=News'"
Info The INSERTGROUP value is case insensitive.
Info If the group specified does not exist, then the entry will be added to the main list.
ACTIVATE/S
This switch is used to specify if the new entry should be activated in the Hotlist Manager once it has been added.
e.g. rx "ADDRESS IBROWSE; 'ADDHOTLIST TITLE=Link URL=www.newlink.com ACTIVATE'"
Info This will not automatically load the URL in the current browser, only select it from the list in Hotlist Manager.
ADDFASTLINK TITLE/A, URL, PROMPTTITLE/S
This command is used to add a new button to the Fastlinks GUI element. If the newly added button doesn't appear in the Fastlinks, it could be that the total number of Fastlink buttons has become greater than can be displayed in the number of rows specified in Preferences » GUI » Fastlinks » Rows, as Fastlinks that do not fit will be truncated from the GUI element.
TITLE/A
This command is used to specify the text used for the title of the button.
e.g. rx "ADDRESS IBROWSE; 'ADDFASTLINK TITLE=Button URL=www.newbutton.com'"
URL
This keyword is used to specify the URL for the entry you are adding.
e.g. rx "ADDRESS IBROWSE; 'ADDFASTLINK TITLE=Button URL=www.newbutton.com'"
PROMPTTILE/S
This switch is used to instruct IBrowse² to present the Specify title window for you to enter a title for the Fastlink button. If you specify both TITLE and PROMPTTITLE, then the title you specified will appear in the requester.
e.g. rx "ADDRESS IBROWSE; 'ADDFASTLINK TITLE=Button URL=www.newbutton.com PROMPTTITLE'"
BACK BROWSERNR/N
This command is used to move backwards through your navigation history for the current session. If BROWSERNR is not specified, it will affect the currently active browser.
e.g. rx "ADDRESS IBROWSE; 'BACK'"
Error Sets RC to -6 if no browser is active
BROWSERNR/N
This keyword is used to specify the browser to perform the operation on. The BROWSERNR will be the number shown in the window title between the [ ] brackets, i.e. the BrowserID.
e.g. rx "ADDRESS IBROWSE; 'BACK BROWSERNR=2'"
Error Sets RC to -6 if BROWSERNR is not found.
CLOSEBROWSER BROWSERNR/N
This command is used to close the browser. If BROWSERNR is not specified, it will affect the currently active browser.
e.g. rx "ADDRESS IBROWSE; 'CLOSEBROWSER'"
Error Sets RC to -6 if no browser is active.
BROWSERNR/N
This keyword is used to specify the browser to perform the operation on. The BROWSERNR will be the number shown in the window title between the [ ] brackets, i.e. the BrowserID.
e.g. rx "ADDRESS IBROWSE; 'CLOSEBROWSER BROWSERNR=2'"
Error Sets RC to -6 if BROWSERNR is not found.
CLOSEWINDOW BROWSERNR/N
This command is used to close the browser. If BROWSERNR is not specified, it will affect the currently active browser.
e.g. rx "ADDRESS IBROWSE; 'CLOSEWINDOW'"
Info This command is OBSOLETE and remains for backwards compatibility only. It is replaced by the new CLOSEBROWSER command.
Error Sets RC to -6 if no browser is active.
BROWSERNR/N
This keyword is used to specify the browser to perform the operation on. The BROWSERNR will be the number shown in the window title between the [ ] brackets, i.e. the BrowserID.
e.g. rx "ADDRESS IBROWSE; 'CLOSEWINDOW BROWSERNR=2'"
Error Sets RC to -6 if BROWSERNR is not found.
FLUSH BROWSERNR/N, HISTORY/S, ALLIMAGES/S, CACHEDIMAGES/S, IMAGES/S
This command is used to flush various items from memory, as specified by the switches. If BROWSERNR is not specified, it will affect the currently active browser.
e.g. rx "ADDRESS IBROWSE; 'FLUSH HISTORY'"
BROWSERNR/N
This keyword is used to specify the browser to perform the operation on. The BROWSERNR will be the number shown in the window title between the [ ] brackets, i.e. the BrowserID.
e.g. rx "ADDRESS IBROWSE; 'FLUSH HISTORY BROWSERNR=2'"
HISTORY/S
This switch is used to specify the history for the browser should be flushed from memory.
e.g. rx "ADDRESS IBROWSE; 'FLUSH HISTORY BROWSERNR=2'"
ALLIMAGES/S
This switch is used to specify that all images for all browsers should be flushed from memory. BROWSERNR is ignored when using this switch.
e.g. rx "ADDRESS IBROWSE; 'FLUSH ALLIMAGES'"
CACHEDIMAGES/S
This switch is used to specify that all cached images for all browser should be flushed from memory. BROWSERNR is ignored when using this switch.
e.g. rx "ADDRESS IBROWSE; 'FLUSH CACHEDIMAGES'"
IMAGES/S
This switch is used to specify that all the displayed images for the browser should be flushed.
e.g. rx "ADDRESS IBROWSE; 'FLUSH IMAGES'"
e.g. rx "ADDRESS IBROWSE; 'FLUSH IMAGES BROWSERNR=2'"
FORWARD BROWSERNR/N
This command is used to move forwards through your navigation history for the current session. If BROWSERNR/N is not specified, it will affect the currently active browser.
e.g. rx "ADDRESS IBROWSE; 'FORWARD'"
Error Sets RC to -6 if no browser is active.
BROWSERNR/N
This keyword is used to specify the browser to perform the operation on. The BROWSERNR will be the number shown in the window title between the [ ] brackets, i.e. the BrowserID.
e.g. rx "ADDRESS IBROWSE; 'FORWARD BROWSERNR=2'"
Error Sets RC to -6 if BROWSERNR is not found.
GOTOURL URL/A, BROWSERNR/N, SAVE/S, RELOAD/S, MIME
This command is used to instruct IBrowse² to load the specified URL into a browser. If BROWSERNR is not specified, it will affect the currently active browser.
e.g. rx "ADDRESS IBROWSE; 'GOTOURL URL=www.somesite.com'"
Error Sets RC to -6 if no browser is active.
URL/A
This command is used to specify the URL that should be loaded into the browser.
e.g. rx "ADDRESS IBROWSE; 'GOTOURL URL=www.somesite.com'"
Error Sets RC to -6 if no browser is active.
BROWSERNR/N
This keyword is used to specify the browser to perform the operation on. The BROWSERNR will be the number shown in the window title between the [ ] brackets, i.e. the BrowserID.
e.g. rx "ADDRESS IBROWSE; 'GOTOURL URL=www.somesite.com BROWSERNR=2'"
Error Sets RC to -6 if BROWSERNR is not found.
SAVE/S
This switch is used to specify that the URL should be saved to disk. The MIME Type can be overridden using the MIME switch.
e.g. rx "ADDRESS IBROWSE; 'GOTOURL URL=www.somesite.com/file.lha SAVE'"
Error Sets RC to -6 if no browser is active.
RELOAD/S
This switch is used to instruct IBrowse² to reload the URL from the web server, and not fetch it from the cache.
e.g. rx "ADDRESS IBROWSE; 'GOTOURL URL=www.somesite.com RELOAD'"
Error Sets RC to -6 if no browser is active.
MIME
This keyword is used to specify a MIME Type that IBrowse² should use for the URL. This is useful for downloading files.
e.g. rx "ADDRESS IBROWSE; GOTOURL URL=www.somesite.com/file.lzx MIME=application/octet-stream'"
Error Sets RC to -6 if no browser is active.
HOME BROWSERNR/N
This command is used load the homepage specified in Preferences » Network » Location into the browser. If BROWSERNR is not specified, it will affect the currently active browser.
e.g. rx "ADDRESS IBROWSE; 'HOME'"
Error Sets RC to -6 if no browser is active.
BROWSERNR/N
This keyword is used to specify the browser to perform the operation on. The BROWSERNR will be the number shown in the window title between the [ ] brackets, i.e. the BrowserID.
e.g. rx "ADDRESS IBROWSE; 'HOME BROWSERNR=2'"
Error Sets RC to -6 if BROWSERNR is not found.
LOADIMAGES BROWSERNR/N
This command is used to load any unloaded images into the browser. If BROWSERNR is not specified, it will affect the currently active browser.
e.g. rx "ADDRESS IBROWSE; 'LOADIMAGES'"
Error Sets RC to -6 if no browser is active.
BROWSERNR/N
This keyword is used to specify the browser to perform the operation on. The BROWSERNR will be the number shown in the window title between the [ ] brackets, i.e. the BrowserID.
e.g. rx "ADDRESS IBROWSE; 'LOADIMAGE BROWSERNR=2'"
Error Sets RC to -6 if BROWSERNR is not found.
NEW URL
This command is used to open a new window, or browser depending on your default new method Preferences » General » Default new method.
e.g. rx "OPTIONS RESULTS; ADDRESS IBROWSE; 'NEW'; SAY RESULT"
Info Sets RESULT to the number of the new browser or window.
URL
This command is used to specify the URL that should be loaded into the browser.
e.g. rx "OPTIONS RESULTS; ADDRESS IBROWSE; 'NEW URL=www.somesite.com'; SAY RESULT"
NEWBROWSER URL, BROWSEWINDOWNR/N
This command is used to explicitly open a new browser. If BROWSEWINDOWNR is not specified, the currently active window is used.
e.g. rx "OPTIONS RESULTS; ADDRESS IBROWSE; 'NEWBROWSER'; SAY RESULT"
Info Sets RESULT to the number of the new browser.
BROWSEWINDOWNR/N
This keyword is used to specify which window the new browser should be opened in. The BROWSEWINDOWNR will be the number shown in the window title between the [ ] brackets, i.e. the BrowserID.
e.g. rx "OPTIONS RESULTS; ADDRESS IBROWSE; 'NEWBROWSER BROWSEWINDOWNR=2'; SAY RESULT"
Info If you use a BROWSEWINDOWNR that is not open, the command will be ignored.
URL
This command is used to specify the URL that should be loaded into the browser that opens in the existing window.
e.g. rx "OPTIONS RESULTS; ADDRESS IBROWSE; 'NEWBROWSER URL=www.somesite.com'; SAY RESULT"
NEWWINDOW URL
This command is used to explicitly open a new window.
e.g. rx "OPTIONS RESULTS; ADDRESS IBROWSE; 'NEWWINDOW'; SAY RESULT"
Info Sets RESULT to the number of the new window.
URL
This command is used to specify the URL that should be loaded into the browser that opens in the new window.
e.g. rx "OPTIONS RESULTS; ADDRESS IBROWSE; 'NEWWINDOW URL=www.somesite.com'; SAY RESULT"
OPENCACHEBROWSER CLOSE/S
This command is used to open IBrowse² Cache Explorer.
e.g. rx "ADDRESS IBROWSE; 'OPENCACHEBROWSER'"
CLOSE/S
This switch is used to instruct IBrowse² to close the IBrowse² Cache Explorer.
e.g. rx "ADDRESS IBROWSE; 'OPENCACHEBROWSER CLOSE'"
OPENHISTORY BROWSERNR/N, CLOSE/S
This command is used to open the Browser History window. If BROWSERNR is not specified, the currently active browser is used.
e.g. rx "ADDRESS IBROWSE; 'OPENHISTORY'"
Error Sets RC to -6 if no browser is active.
BROWSERNR/N
This keyword is used to specify the browser to perform the operation on. The BROWSERNR will be the number shown in the window title between the [ ] brackets.
e.g. rx "ADDRESS IBROWSE; 'OPENHISTORY BROWSERNR=2'"
Error Sets RC to -6 if BROWSERNR is not found.
CLOSE/S
This switch is used to instruct IBrowse² to close the Browser History window.
e.g. rx "ADDRESS IBROWSE; 'OPENHISTORY BROWSERNR=2 CLOSE'"
OPENHOTLIST CLOSE/S
This command is used to open the Hotlist Manager.
e.g. rx "ADDRESS IBROWSE; 'OPENHOTLIST'"
! This option currently ignores the Preferences » General » Use Contact Manager for bookmarks option, so will always open Hotlist Manager even when you are using Contact Manager.
CLOSE/S
This switch is used to instruct IBrowse² to close the Hotlist Manager.
e.g. rx "ADDRESS IBROWSE; 'OPENHOTLIST CLOSE'"
OPENINFOWINDOW CLOSE/S
This command is used to open the Info Window.
e.g. rx "ADDRESS IBROWSE; 'OPENINFOWINDOW'"
CLOSE/S
This switch is used to instruct IBrowse² to close the Info Window.
e.g. rx "ADDRESS IBROWSE; 'OPENINFOWINDOW CLOSE'"
QUERY ITEM/A, BROWSERNR/N
This command is used to obtain information on an ITEM. If BROWSERNR is not specified, the currently active browser is used. Valid ITEMs are:
URL, TITLE, ACTIVEBROWSERNR ACTIVEWINDOWNR
e.g. rx "OPTIONS RESULTS; ADDRESS IBROWSE; 'QUERY ITEM=URL'; SAY RESULT"
Info ITEM is case insensitive.
Error Sets RC to -5 if ITEM is not found.
Sets RC to -6 if no browser is active during a query on one of the ACTIVE* items.
ITEM
The following keywords are valid ITEMs:
URL
This keyword will return the URL for the browser specified.
e.g. rx "OPTIONS RESULTS; ADDRESS IBROWSE; 'QUERY ITEM=URL BROWSERNR=2'; SAY RESULT"
TITLE
This keyword will return the <title> of the web page for the browser specified.
e.g. rx "OPTIONS RESULTS; ADDRESS IBROWSE; 'QUERY ITEM=TITLE BROWSERNR=2'; SAY RESULT"
ACTIVEBROWSERNR
This keyword will return the ID of the active browser. BROWSERNR is ignored when using this switch.
e.g. rx "OPTIONS RESULTS; ADDRESS IBROWSE; 'QUERY ITEM=ACTIVEBROWSERNR'; SAY RESULT"
Error Sets RC to -6 if no browser is active.
ACTIVEWINDOWNR
This keyword will return the ID of the active window. BROWSERNR is ignored when using this switch.
e.g. rx "OPTIONS RESULTS; ADDRESS IBROWSE; 'QUERY ITEM=ACTIVEWINDOWNR'; SAY RESULT"
Error Sets RC to -6 if no browser is active.
BROWSERNR/N
This keyword is used to specify the browser to perform the operation on. The BROWSERNR will be the number shown in the window title between the [ ] brackets, i.e. the BrowserID.
e.g. rx "OPTIONS RESULTS; ADDRESS IBROWSE; 'QUERY ITEM=TITLE BROWSERNR=2'; SAY RESULT"
Error Sets RC to -6 if BROWSERNR is not found.
RELOAD BROWSERNR/N, ALL/S, FRAMES/S, IMAGES/S
This command will instruct IBrowse² to reload various web page data in the browser. If BROWSERNR is not specified, the currently active browser will be used.
e.g. rx "ADDRESS IBROWSE; 'RELOAD'"
Error Sets RC to -6 if no browser is active.
BROWSERNR/N
This keyword is used to specify the browser to perform the operation on. The BROWSERNR will be the number shown in the window title between the [ ] brackets, i.e. the BrowserID.
e.g. rx "ADDRESS IBROWSE; 'RELOAD BROWSERNR=2'"
Error Sets RC to -6 if BROWSERNR is not found.
ALL/S
This switch is used to specify that all data for the web page in the browser, should be reloaded.
e.g. rx "ADDRESS IBROWSE; 'RELOAD ALL'"
Error Sets RC to -6 if no browser is active.
FRAMES/S
This switch is used to specify that all frame content for the web page in the browser, should be reloaded.
e.g. rx "ADDRESS IBROWSE; 'RELOAD FRAMES'"
Error Sets RC to -6 if no browser is active.
IMAGES/S
This switch is used to specify that all image data for the web page in the browser, should be reloaded.
e.g. rx "ADDRESS IBROWSE; 'RELOAD IMAGES'"
Error Sets RC to -6 if no browser is active.
STOP BROWSERNR/N
This command will instruct IBrowse² to stop transferring any data in the browser. If BROWSERNR is not specified, the currently active browser will be used.
e.g. rx "ADDRESS IBROWSE; 'STOP'"
Error Sets RC to -6 if no browser is active.
BROWSERNR/N
This keyword is used to specify the browser to perform the operation on. The BROWSERNR will be the number shown in the window title between the [ ] brackets, i.e. the BrowserID.
e.g. rx "ADDRESS IBROWSE; 'STOP BROWSERNR=2'"
Error Sets RC to -6 if BROWSERNR is not found.
SCREENTOBACK
This command will send the screen that IBrowse² is running on, to the back.
e.g. rx "ADDRESS IBROWSE; 'SCREENTOBACK'"
SCREENTOFRONT
This command will bring the screen that IBrowse² is running on, to the front.
e.g. rx "ADDRESS IBROWSE; 'SCREENTOFRONT'"

<< Preferences Chapter Contents Chapter Printing Chapter >>

Valid XHTML 1.0! ~ Upload This Local File To http://validator.w3.org To Validate Yourself

IBrowse² Documentation v2.3 © 2002, 2003 Dave Fisher ~ IBrowse² Development Team Revision 1.0