Alias W for WINDOW and T for TAB.

Add documentation on ARexx startup/shutdown scripts

svn path=/trunk/netsurf/; revision=10720

2 files changed, 28 insertions, 24 deletions

diff --git a/amiga/arexx.c b/amiga/arexx.c
index 296178317..ac577d7a7 100755
--- a/amiga/arexx.c
+++ b/amiga/arexx.c
@@ -77,21 +77,21 @@ STATIC VOID rx_close(struct ARexxCmd *, struct RexxMsg *);
 
 STATIC struct ARexxCmd Commands[] =
 {
-	{"OPEN",RX_OPEN,rx_open,"URL/A,NEW=NEWWINDOW/S,NEWTAB/S,SAVEAS/K,WINDOW/K/N,TAB/K/N", 		0, 	NULL, 	0, 	0, 	NULL },
+	{"OPEN",RX_OPEN,rx_open,"URL/A,NEW=NEWWINDOW/S,NEWTAB/S,SAVEAS/K,W=WINDOW/K/N,T=TAB/K/N", 		0, 	NULL, 	0, 	0, 	NULL },
 	{"QUIT",RX_QUIT,rx_quit,NULL, 		0, 	NULL, 	0, 	0, 	NULL },
 	{"TOFRONT",RX_TOFRONT,rx_tofront,NULL, 		0, 	NULL, 	0, 	0, 	NULL },
-	{"GETURL",RX_GETURL,rx_geturl,	"WINDOW/K/N,TAB/K/N", 		0, 	NULL, 	0, 	0, 	NULL },
-	{"GETTITLE",RX_GETTITLE,rx_gettitle,	"WINDOW/K/N,TAB/K/N", 		0, 	NULL, 	0, 	0, 	NULL },
+	{"GETURL",RX_GETURL,rx_geturl,	"W=WINDOW/K/N,T=TAB/K/N", 		0, 	NULL, 	0, 	0, 	NULL },
+	{"GETTITLE",RX_GETTITLE,rx_gettitle,	"W=WINDOW/K/N,T=TAB/K/N", 		0, 	NULL, 	0, 	0, 	NULL },
 	{"VERSION",RX_VERSION,rx_version,"VERSION/N,SVN=REVISION/N,RELEASE/S", 		0, 	NULL, 	0, 	0, 	NULL },
-	{"SAVE",RX_SAVE,rx_save,"FILENAME/A,WINDOW/K/N,TAB/K/N", 		0, 	NULL, 	0, 	0, 	NULL },
+	{"SAVE",RX_SAVE,rx_save,"FILENAME/A,W=WINDOW/K/N,T=TAB/K/N", 		0, 	NULL, 	0, 	0, 	NULL },
 	{"GETSCREENNAME",RX_PUBSCREEN,rx_pubscreen,NULL, 		0, 	NULL, 	0, 	0, 	NULL },
-	{"BACK",	RX_BACK,	rx_back,	"WINDOW/K/N,TAB/K/N", 		0, 	NULL, 	0, 	0, 	NULL },
-	{"FORWARD",	RX_FORWARD,	rx_forward,	"WINDOW/K/N,TAB/K/N", 		0, 	NULL, 	0, 	0, 	NULL },
-	{"HOME",	RX_HOME,	rx_home,	"WINDOW/K/N,TAB/K/N", 		0, 	NULL, 	0, 	0, 	NULL },
-	{"RELOAD",	RX_RELOAD,	rx_reload,	"FORCE/S,WINDOW/K/N,TAB/K/N", 		0, 	NULL, 	0, 	0, 	NULL },
-	{"WINDOWS",	RX_WINDOWS,	rx_windows,	"WINDOW/K/N", 		0, 	NULL, 	0, 	0, 	NULL },
-	{"ACTIVE",	RX_ACTIVE,	rx_active,	"TAB/S", 		0, 	NULL, 	0, 	0, 	NULL },
-	{"CLOSE",	RX_CLOSE,	rx_close,	"WINDOW/K/N,TAB/K/N", 		0, 	NULL, 	0, 	0, 	NULL },
+	{"BACK",	RX_BACK,	rx_back,	"W=WINDOW/K/N,T=TAB/K/N", 		0, 	NULL, 	0, 	0, 	NULL },
+	{"FORWARD",	RX_FORWARD,	rx_forward,	"W=WINDOW/K/N,T=TAB/K/N", 		0, 	NULL, 	0, 	0, 	NULL },
+	{"HOME",	RX_HOME,	rx_home,	"W=WINDOW/K/N,T=TAB/K/N", 		0, 	NULL, 	0, 	0, 	NULL },
+	{"RELOAD",	RX_RELOAD,	rx_reload,	"FORCE/S,W=WINDOW/K/N,T=TAB/K/N", 		0, 	NULL, 	0, 	0, 	NULL },
+	{"WINDOWS",	RX_WINDOWS,	rx_windows,	"W=WINDOW/K/N", 		0, 	NULL, 	0, 	0, 	NULL },
+	{"ACTIVE",	RX_ACTIVE,	rx_active,	"T=TAB/S", 		0, 	NULL, 	0, 	0, 	NULL },
+	{"CLOSE",	RX_CLOSE,	rx_close,	"W=WINDOW/K/N,T=TAB/K/N", 		0, 	NULL, 	0, 	0, 	NULL },
 	{ NULL, 		0, 				NULL, 		NULL, 		0, 	NULL, 	0, 	0, 	NULL }
 };
 
diff --git a/amiga/dist/NetSurf.guide b/amiga/dist/NetSurf.guide
index 5abf13946..9b6cf780d 100755
--- a/amiga/dist/NetSurf.guide
+++ b/amiga/dist/NetSurf.guide
@@ -46,6 +46,8 @@ There are a couple of Amiga-specific options which can only be changed directly
 @{b}url_file@{ub} Path to URL database file
 @{b}hotlist_file@{ub} Path to Hotlist file
 @{b}arexx_dir@{ub} Path to ARexx scripts dir
+@{b}arexx_startup@{ub} ARexx script to run at startup (in above dir)
+@{b}arexx_shutdown@{ub} ARexx script to run on quit (in above dir)
 @endnode
 
 @node Fonts
@@ -81,10 +83,10 @@ NetSurf's ARexx port is called NETSURF.
 
 Commands are:
 
-@{b}OPEN URL/A,NEW=NEWWINDOW/S,NEWTAB/S,SAVEAS/K,WINDOW/K/N,TAB/K/N@{ub}
+@{b}OPEN URL/A,NEW=NEWWINDOW/S,NEWTAB/S,SAVEAS/K,W=WINDOW/K/N,T=TAB/K/N@{ub}
 Opens URL in current window or a new window/tab if NEWWINDOW/NEWTAB is specified.  Saves the location without displaying if SAVEAS and a filename is specified (SAVEAS available in 2.6325)
 
-@{b}SAVE FILENAME/A,WINDOW/K/N,TAB/K/N@{ub} (2.6027)
+@{b}SAVE FILENAME/A,W=WINDOW/K/N,T=TAB/K/N@{ub} (2.6027)
 Saves current page source to FILENAME
 
 @{b}QUIT@{ub}
@@ -93,42 +95,44 @@ Quits NetSurf
 @{b}TOFRONT@{ub}
 Brings NetSurf's screen to the front
 
-@{b}GETURL WINDOW/K/N,TAB/K/N@{ub}
+@{b}GETURL W=WINDOW/K/N,T=TAB/K/N@{ub}
 Puts the URL displayed in the current window/tab into RESULT
 
-@{b}GETTITLE WINDOW/K/N,TAB/K/N@{ub}
+@{b}GETTITLE W=WINDOW/K/N,T=TAB/K/N@{ub}
 Puts the title of the page displayed in the current window/tab into RESULT
 
 @{b}GETSCREENNAME@{ub} (2.8303)
 Puts the name of the screen NetSurf is running on into RESULT.
 
-@{b}BACK WINDOW/K/N,TAB/K/N@{ub} (2.10626)
+@{b}BACK W=WINDOW/K/N,T=TAB/K/N@{ub} (2.10626)
 Move back one page in history.
 
-@{b}FORWARD WINDOW/K/N,TAB/K/N@{ub} (2.10626)
+@{b}FORWARD W=WINDOW/K/N,T=TAB/K/N@{ub} (2.10626)
 Move forward one page in history.
 
-@{b}HOME WINDOW/K/N,TAB/K/N@{ub} (2.10626)
+@{b}HOME W=WINDOW/K/N,T=TAB/K/N@{ub} (2.10626)
 Move back to the home page.
 
-@{b}RELOAD FORCE/S,WINDOW/K/N,TAB/K/N@{ub} (2.10626)
+@{b}RELOAD FORCE/S,W=WINDOW/K/N,T=TAB/K/N@{ub} (2.10626)
 Reload the current page, FORCE will do a full reload.
 
-@{b}CLOSE WINDOW/K/N,TAB/K/N@{ub} (2.10718)
+@{b}CLOSE W=WINDOW/K/N,T=TAB/K/N@{ub} (2.10718)
 Close the current page.  A window or window and tab can be specified.  Note that when a tab is closed, the tab number of tabs to the right of it will change, and the currently active tab may also change.  If the last tab or window is closed, NetSurf will usually exit.  Make sure you account for these situations in your code.
 
 @{b}VERSION VERSION/N REVISION/N RELEASE/S@{ub}
 Returns the current version of NetSurf in RESULT.  You can also do version checking by supplying a VERSION and optional REVISION to check against.  If the version of NetSurf is the same or higher 1 will be returned, if it is older 0.  If RELEASE is specified, the command operates on the release version rather than the internal version number.
 
-@{b}ACTIVE TAB/S@{ub} (2.10718)
+@{b}ACTIVE T=TAB/S@{ub} (2.10718)
 Returns the active window (or tab if TAB is specified).  Commands automatically operate on the active window/tab so you do not normally need to use this.
 
-@{b}WINDOWS WINDOW/K/N@{ub} (2.10656)
+@{b}WINDOWS W=WINDOW/K/N@{ub} (2.10656)
 Puts the number of windows into RESULT.  If the WINDOW keyword is specified, will put the number of tabs in that window into RESULT.
 
-The WINDOW/K/N,TAB/K/N parameters were added in 2.10656 and allow targetting a window other than the current one.  Both WINDOW and TAB must be specified (TAB=1 for tabless window) except in the special case of the CLOSE command.
+The W=WINDOW/K/N,T=TAB/K/N parameters were added in 2.10656 and allow targetting a window other than the current one.  Both WINDOW and TAB must be specified (TAB=1 for tabless window) except in the special case of the CLOSE command.
 
-The ARexx menu will be populated with scripts named #?.nsrx in @{"arexx_dir" link options 9}, up to a maximum of 20 entries.  The titles of these entries will be the comments field of the file (or the filename if comments field is empty).
+The ARexx menu will be populated with scripts named #?.nsrx in @{"arexx_dir" link options 12}, up to a maximum of 20 entries.  The titles of these entries will be the comments field of the file (or the filename if comments field is empty).
+
+Special scripts @{"arexx_startup" link options 13} and @{"arexx_shutdown" link options 14} will be run at startup and shutdown of NetSurf.  These will execute after NetSurf has fully initialised with the initial window and before NetSurf frees resources (ie. at the last stage of startup, and the first stage of shutdown)
 @endnode
 
 @node OpenURL