Workbench ARexx Port - Revision history

Rob Cranley: /* ARexx Interface */

2023-07-08T16:39:33Z

ARexx Interface

Rob Cranley: /* ARexx Interface */ Fixed internal links in top table

2023-07-08T16:38:46Z

ARexx Interface: Fixed internal links in top table

Rob Cranley: Created new appendix as a more intuitive and suitable place for the Workbench ARexx documentation

2022-11-29T09:02:06Z

Created new appendix as a more intuitive and suitable place for the Workbench ARexx documentation

Show changes

← Older revision		Revision as of 16:39, 8 July 2023
Line 7:		Line 7:
	! style="text-align:left;"\| Description		! style="text-align:left;"\| Description
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[ACTIVATEWINDOW_command\|ACTIVATEWINDOW]] WINDOW \|\| This command will attempt to make a window the active one.		\| [[#ACTIVATEWINDOW_command\|ACTIVATEWINDOW]] WINDOW \|\| This command will attempt to make a window the active one.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[CHANGEWINDOW_command\|CHANGEWINDOW]] WINDOW,LEFTEDGE/N,TOPEDGE/N,WIDTH/N,HEIGHT/N \|\| This command will attempt to change the size and the position of a window.		\| [[#CHANGEWINDOW_command\|CHANGEWINDOW]] WINDOW,LEFTEDGE/N,TOPEDGE/N,WIDTH/N,HEIGHT/N \|\| This command will attempt to change the size and the position of a window.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[DELETE_command\|DELETE]] NAME/A,ALL/S \|\| This command is for deleting files and drawers (and their contents).		\| [[#DELETE_command\|DELETE]] NAME/A,ALL/S \|\| This command is for deleting files and drawers (and their contents).
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[FAULT_command\|FAULT]] CODE/A/N \|\| This command will return a human readable explanation corresponding to an error code.		\| [[#FAULT_command\|FAULT]] CODE/A/N \|\| This command will return a human readable explanation corresponding to an error code.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[GETATTR_command\|GETATTR]] OBJECT/A,NAME/K,STEM/K,VAR/K \|\| This command will retrieve information from the Workbench database, such the names of the drawers currently open and the icons currently selected.		\| [[#GETATTR_command\|GETATTR]] OBJECT/A,NAME/K,STEM/K,VAR/K \|\| This command will retrieve information from the Workbench database, such the names of the drawers currently open and the icons currently selected.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[HELP_command\|HELP]] COMMAND/K,MENUS/S,PROMPT/S \|\| This command can be used to open the online help and to obtain information on the supported menus, commands and command parameters.		\| [[#HELP_command\|HELP]] COMMAND/K,MENUS/S,PROMPT/S \|\| This command can be used to open the online help and to obtain information on the supported menus, commands and command parameters.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[ICON_command\|ICON]] WINDOW,NAMES/M,OPEN/S,MAKEVISIBLE/S,SELECT/S,UNSELECT/S, UP/N,DOWN/N,LEFT/N,RIGHT/N,X/N,Y/N,ACTIVATE/K,CYCLE/K, MOVE/K \|\| This command is for manipulating the icons displayed in a window.		\| [[#ICON_command\|ICON]] WINDOW,NAMES/M,OPEN/S,MAKEVISIBLE/S,SELECT/S,UNSELECT/S, UP/N,DOWN/N,LEFT/N,RIGHT/N,X/N,Y/N,ACTIVATE/K,CYCLE/K, MOVE/K \|\| This command is for manipulating the icons displayed in a window.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[INFO_command\|INFO]] NAME/A \|\| This command is for opening the Workbench icon information requester.		\| [[#INFO_command\|INFO]] NAME/A \|\| This command is for opening the Workbench icon information requester.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[KEYBOARD_command\|KEYBOARD]] NAME/A,ADD/S,REMOVE/S,KEY,CMD/F \|\| This command can be used to bind ARexx commands to key combinations.		\| [[#KEYBOARD_command\|KEYBOARD]] NAME/A,ADD/S,REMOVE/S,KEY,CMD/F \|\| This command can be used to bind ARexx commands to key combinations.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[LOCKGUI_command\|LOCKGUI]] \|\| This command will block access to all Workbench drawer windows.		\| [[#LOCKGUI_command\|LOCKGUI]] \|\| This command will block access to all Workbench drawer windows.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[MENU_command\|MENU]] WINDOW/K,INVOKE,NAME/K,TITLE/K,SHORTCUT/K,ADD/S,REMOVE/S,CMD/K/F \|\| This command is for invoking items of the Workbench menu, as if the user had selected them with the mouse and for adding/removing user menus.		\| [[#MENU_command\|MENU]] WINDOW/K,INVOKE,NAME/K,TITLE/K,SHORTCUT/K,ADD/S,REMOVE/S,CMD/K/F \|\| This command is for invoking items of the Workbench menu, as if the user had selected them with the mouse and for adding/removing user menus.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[MOVEWINDOW_command\|MOVEWINDOW]] WINDOW,LEFTEDGE/N,TOPEDGE/N \|\| This command will attempt to change the position of a window.		\| [[#MOVEWINDOW_command\|MOVEWINDOW]] WINDOW,LEFTEDGE/N,TOPEDGE/N \|\| This command will attempt to change the position of a window.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[NEWDRAWER_command\|NEWDRAWER]] NAME/A \|\| This command is for creating new drawers.		\| [[#NEWDRAWER_command\|NEWDRAWER]] NAME/A \|\| This command is for creating new drawers.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[RENAME_command\|RENAME]] OLDNAME/A,NEWNAME/A \|\| This command is for renaming files, drawers and volumes.		\| [[#RENAME_command\|RENAME]] OLDNAME/A,NEWNAME/A \|\| This command is for renaming files, drawers and volumes.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[RX_command\|RX]] CONSOLE/S,ASYNC/S,CMD/A/F \|\| This command is for executing ARexx scripts and commands.		\| [[#RX_command\|RX]] CONSOLE/S,ASYNC/S,CMD/A/F \|\| This command is for executing ARexx scripts and commands.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[SIZEWINDOW_command\|SIZEWINDOW]] WINDOW,WIDTH/N,HEIGHT/N \|\| This command will attempt to change the size of a window.		\| [[#SIZEWINDOW_command\|SIZEWINDOW]] WINDOW,WIDTH/N,HEIGHT/N \|\| This command will attempt to change the size of a window.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[UNLOCKGUI_command\|UNLOCKGUI]] \|\| This command will allow access to all Workbench drawer windows locked with the LOCKGUI command.		\| [[#UNLOCKGUI_command\|UNLOCKGUI]] \|\| This command will allow access to all Workbench drawer windows locked with the LOCKGUI command.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[UNZOOMWINDOW_command\|UNZOOMWINDOW]] WINDOW \|\| This command will attempt to return a window to its original position and dimensions.		\| [[#UNZOOMWINDOW_command\|UNZOOMWINDOW]] WINDOW \|\| This command will attempt to return a window to its original position and dimensions.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[VIEW_command\|VIEW]] WINDOW,PAGE/S,PIXEL/S,UP/S,DOWN/S,LEFT/S,RIGHT/S \|\| This command will change the position of the viewable display area of a window.		\| [[#VIEW_command\|VIEW]] WINDOW,PAGE/S,PIXEL/S,UP/S,DOWN/S,LEFT/S,RIGHT/S \|\| This command will change the position of the viewable display area of a window.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[WINDOW_command\|WINDOW]] WINDOWS/M/A,OPEN/S,CLOSE/S,SNAPSHOT/S,ACTIVATE/S,MIN/S,MAX/S, FRONT/S,BACK/S,CYCLE/K \|\| This command will change, open, close or snapshot windows.		\| [[#WINDOW_command\|WINDOW]] WINDOWS/M/A,OPEN/S,CLOSE/S,SNAPSHOT/S,ACTIVATE/S,MIN/S,MAX/S, FRONT/S,BACK/S,CYCLE/K \|\| This command will change, open, close or snapshot windows.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[WINDOWTOBACK_command\|WINDOWTOBACK]] WINDOW \|\| This command will push a window into the background.		\| [[#WINDOWTOBACK_command\|WINDOWTOBACK]] WINDOW \|\| This command will push a window into the background.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[WINDOWTOFRONT_command\|WINDOWTOFRONT]] WINDOW \|\| This command will bring a window to the foreground.		\| [[#WINDOWTOFRONT_command\|WINDOWTOFRONT]] WINDOW \|\| This command will bring a window to the foreground.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[ZOOMWINDOW_command\|ZOOMWINDOW]] WINDOW \|\| This command will change a window to alternate position and dimensions.		\| [[#ZOOMWINDOW_command\|ZOOMWINDOW]] WINDOW \|\| This command will change a window to alternate position and dimensions.
	\|}		\|}

← Older revision		Revision as of 16:38, 8 July 2023
Line 7:		Line 7:
	! style="text-align:left;"\| Description		! style="text-align:left;"\| Description
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[~~AmigaOS_Manual:_Workbench_Using#~~ACTIVATEWINDOW_command\|ACTIVATEWINDOW]] WINDOW \|\| This command will attempt to make a window the active one.		\| [[ACTIVATEWINDOW_command\|ACTIVATEWINDOW]] WINDOW \|\| This command will attempt to make a window the active one.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[~~AmigaOS_Manual:_Workbench_Using#~~CHANGEWINDOW_command\|CHANGEWINDOW]] WINDOW,LEFTEDGE/N,TOPEDGE/N,WIDTH/N,HEIGHT/N \|\| This command will attempt to change the size and the position of a window.		\| [[CHANGEWINDOW_command\|CHANGEWINDOW]] WINDOW,LEFTEDGE/N,TOPEDGE/N,WIDTH/N,HEIGHT/N \|\| This command will attempt to change the size and the position of a window.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[~~AmigaOS_Manual:_Workbench_Using#~~DELETE_command\|DELETE]] NAME/A,ALL/S \|\| This command is for deleting files and drawers (and their contents).		\| [[DELETE_command\|DELETE]] NAME/A,ALL/S \|\| This command is for deleting files and drawers (and their contents).
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[~~AmigaOS_Manual:_Workbench_Using#~~FAULT_command\|FAULT]] CODE/A/N \|\| This command will return a human readable explanation corresponding to an error code.		\| [[FAULT_command\|FAULT]] CODE/A/N \|\| This command will return a human readable explanation corresponding to an error code.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[~~AmigaOS_Manual:_Workbench_Using#~~GETATTR_command\|GETATTR]] OBJECT/A,NAME/K,STEM/K,VAR/K \|\| This command will retrieve information from the Workbench database, such the names of the drawers currently open and the icons currently selected.		\| [[GETATTR_command\|GETATTR]] OBJECT/A,NAME/K,STEM/K,VAR/K \|\| This command will retrieve information from the Workbench database, such the names of the drawers currently open and the icons currently selected.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[~~AmigaOS_Manual:_Workbench_Using#~~HELP_command\|HELP]] COMMAND/K,MENUS/S,PROMPT/S \|\| This command can be used to open the online help and to obtain information on the supported menus, commands and command parameters.		\| [[HELP_command\|HELP]] COMMAND/K,MENUS/S,PROMPT/S \|\| This command can be used to open the online help and to obtain information on the supported menus, commands and command parameters.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[~~AmigaOS_Manual:_Workbench_Using#~~ICON_command\|ICON]] WINDOW,NAMES/M,OPEN/S,MAKEVISIBLE/S,SELECT/S,UNSELECT/S, UP/N,DOWN/N,LEFT/N,RIGHT/N,X/N,Y/N,ACTIVATE/K,CYCLE/K, MOVE/K \|\| This command is for manipulating the icons displayed in a window.		\| [[ICON_command\|ICON]] WINDOW,NAMES/M,OPEN/S,MAKEVISIBLE/S,SELECT/S,UNSELECT/S, UP/N,DOWN/N,LEFT/N,RIGHT/N,X/N,Y/N,ACTIVATE/K,CYCLE/K, MOVE/K \|\| This command is for manipulating the icons displayed in a window.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[~~AmigaOS_Manual:_Workbench_Using#~~INFO_command\|INFO]] NAME/A \|\| This command is for opening the Workbench icon information requester.		\| [[INFO_command\|INFO]] NAME/A \|\| This command is for opening the Workbench icon information requester.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[~~AmigaOS_Manual:_Workbench_Using#~~KEYBOARD_command\|KEYBOARD]] NAME/A,ADD/S,REMOVE/S,KEY,CMD/F \|\| This command can be used to bind ARexx commands to key combinations.		\| [[KEYBOARD_command\|KEYBOARD]] NAME/A,ADD/S,REMOVE/S,KEY,CMD/F \|\| This command can be used to bind ARexx commands to key combinations.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[~~AmigaOS_Manual:_Workbench_Using#~~LOCKGUI_command\|LOCKGUI]] \|\| This command will block access to all Workbench drawer windows.		\| [[LOCKGUI_command\|LOCKGUI]] \|\| This command will block access to all Workbench drawer windows.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[~~AmigaOS_Manual:_Workbench_Using#~~MENU_command\|MENU]] WINDOW/K,INVOKE,NAME/K,TITLE/K,SHORTCUT/K,ADD/S,REMOVE/S,CMD/K/F \|\| This command is for invoking items of the Workbench menu, as if the user had selected them with the mouse and for adding/removing user menus.		\| [[MENU_command\|MENU]] WINDOW/K,INVOKE,NAME/K,TITLE/K,SHORTCUT/K,ADD/S,REMOVE/S,CMD/K/F \|\| This command is for invoking items of the Workbench menu, as if the user had selected them with the mouse and for adding/removing user menus.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[~~AmigaOS_Manual:_Workbench_Using#~~MOVEWINDOW_command\|MOVEWINDOW]] WINDOW,LEFTEDGE/N,TOPEDGE/N \|\| This command will attempt to change the position of a window.		\| [[MOVEWINDOW_command\|MOVEWINDOW]] WINDOW,LEFTEDGE/N,TOPEDGE/N \|\| This command will attempt to change the position of a window.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[~~AmigaOS_Manual:_Workbench_Using#~~NEWDRAWER_command\|NEWDRAWER]] NAME/A \|\| This command is for creating new drawers.		\| [[NEWDRAWER_command\|NEWDRAWER]] NAME/A \|\| This command is for creating new drawers.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[~~AmigaOS_Manual:_Workbench_Using#~~RENAME_command\|RENAME]] OLDNAME/A,NEWNAME/A \|\| This command is for renaming files, drawers and volumes.		\| [[RENAME_command\|RENAME]] OLDNAME/A,NEWNAME/A \|\| This command is for renaming files, drawers and volumes.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[~~AmigaOS_Manual:_Workbench_Using#~~RX_command\|RX]] CONSOLE/S,ASYNC/S,CMD/A/F \|\| This command is for executing ARexx scripts and commands.		\| [[RX_command\|RX]] CONSOLE/S,ASYNC/S,CMD/A/F \|\| This command is for executing ARexx scripts and commands.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[~~AmigaOS_Manual:_Workbench_Using#~~SIZEWINDOW_command\|SIZEWINDOW]] WINDOW,WIDTH/N,HEIGHT/N \|\| This command will attempt to change the size of a window.		\| [[SIZEWINDOW_command\|SIZEWINDOW]] WINDOW,WIDTH/N,HEIGHT/N \|\| This command will attempt to change the size of a window.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[~~AmigaOS_Manual:_Workbench_Using#~~UNLOCKGUI_command\|UNLOCKGUI]] \|\| This command will allow access to all Workbench drawer windows locked with the LOCKGUI command.		\| [[UNLOCKGUI_command\|UNLOCKGUI]] \|\| This command will allow access to all Workbench drawer windows locked with the LOCKGUI command.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[~~AmigaOS_Manual:_Workbench_Using#~~UNZOOMWINDOW_command\|UNZOOMWINDOW]] WINDOW \|\| This command will attempt to return a window to its original position and dimensions.		\| [[UNZOOMWINDOW_command\|UNZOOMWINDOW]] WINDOW \|\| This command will attempt to return a window to its original position and dimensions.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[~~AmigaOS_Manual:_Workbench_Using#~~VIEW_command\|VIEW]] WINDOW,PAGE/S,PIXEL/S,UP/S,DOWN/S,LEFT/S,RIGHT/S \|\| This command will change the position of the viewable display area of a window.		\| [[VIEW_command\|VIEW]] WINDOW,PAGE/S,PIXEL/S,UP/S,DOWN/S,LEFT/S,RIGHT/S \|\| This command will change the position of the viewable display area of a window.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[~~AmigaOS_Manual:_Workbench_Using#~~WINDOW_command\|WINDOW]] WINDOWS/M/A,OPEN/S,CLOSE/S,SNAPSHOT/S,ACTIVATE/S,MIN/S,MAX/S, FRONT/S,BACK/S,CYCLE/K \|\| This command will change, open, close or snapshot windows.		\| [[WINDOW_command\|WINDOW]] WINDOWS/M/A,OPEN/S,CLOSE/S,SNAPSHOT/S,ACTIVATE/S,MIN/S,MAX/S, FRONT/S,BACK/S,CYCLE/K \|\| This command will change, open, close or snapshot windows.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[~~AmigaOS_Manual:_Workbench_Using#~~WINDOWTOBACK_command\|WINDOWTOBACK]] WINDOW \|\| This command will push a window into the background.		\| [[WINDOWTOBACK_command\|WINDOWTOBACK]] WINDOW \|\| This command will push a window into the background.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[~~AmigaOS_Manual:_Workbench_Using#~~WINDOWTOFRONT_command\|WINDOWTOFRONT]] WINDOW \|\| This command will bring a window to the foreground.		\| [[WINDOWTOFRONT_command\|WINDOWTOFRONT]] WINDOW \|\| This command will bring a window to the foreground.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| [[~~AmigaOS_Manual:_Workbench_Using#~~ZOOMWINDOW_command\|ZOOMWINDOW]] WINDOW \|\| This command will change a window to alternate position and dimensions.		\| [[ZOOMWINDOW_command\|ZOOMWINDOW]] WINDOW \|\| This command will change a window to alternate position and dimensions.
	\|}		\|}