AWeb ARexx Commands

Configuration commands

Configuration items:
ALLOWCMD ANONYMOUS AREXX AUTOSEARCH AUTOSEARCHURL BACKGROUND BGSOUND BLINK BUTTON CACHEDISK CACHEMEMORY CACHEPATH COLOUR CONSOLE CONTANIM COOKIES CYCLETOLIST DRAGGING EDITOR ENDTCP	FASTRESPONSE FONT FORMWARNING FRAMES FTPEMAILADDR FTPPROXY GOPHERPROXY HISTORYCLOSE HISTORYOPEN HOMEURL HOTLISTCLOSE HOTLISTOPEN HOTLISTREQUESTER HTMLMODE HTMLVIEWER HTTPPROXY ICONS IGNOREMIME IMAGES IMAGEVIEWER	INCREMENTALTABLE INDEXSUFFIX JAVASCRIPT KEEPFREECHIP KEEPFREEFAST KEY LIMITEDPROXY MAILNEWS MAILTO MAXLOCAL MAXNETWORK MIME NETSTATUSOPEN NEWS NOCACHE NOCOOKIE NOMINALFRAME NOPROXY OVERLAP PALETTE	POPUP POPUPMENU RFCCOOKIES SAVEPATH SCREEN SCREENPENS SHOWBUTTONS SPAMBLOCK SPOOFAS STARTHOME STARTTCP STYLE TELNET TELNETPROXY TEMPPATH ULLINKS VERIFICATION

GETCFG

Template:


   GETCFG ITEM,VAR/K,STEM/K

Obtain one or more configuration settings.

Argument Description
ITEM Specifies the name of the single item, group or list to obtain.
If not specified, an array is built of all configuration items.
VAR The name of the variable to return the value of a single item in. If no name is specified, the value of a single item will be returned in the reserved ARexx variable RESULT.
STEM The name of a stem variable to return an array of items in, for a group or list, or when obtaining all items. Do not include the trailing period in this name.

Argument	Description
ITEM	Specifies the name of the single item, group or list to obtain. If not specified, an array is built of all configuration items.
VAR	The name of the variable to return the value of a single item in. If no name is specified, the value of a single item will be returned in the reserved ARexx variable `RESULT`.
STEM	The name of a stem variable to return an array of items in, for a group or list, or when obtaining all items. Do not include the trailing period in this name.

SETCFG

Template:


   SETCFG ITEM,VALUE,STEM/K,ADD/S

Set one or more configuration settings. After completion of this command, the new configuration will be in effect, and possibly a re-lay out of the current document will take place (or even a screen close and re-open). If you need to set several items at once, it is best to combine all items into one array, so any extra processing will be done only once.

Argument Description
ITEM Specifies the name of the item to set.
VALUE The value to set the item of the specified name to.
STEM The name of a stem variable that holds an array of items to set. The items in this array don't necessarily belong to the same group or list.
ADD If this switch is set, any list items are added to the existing settings.
If this switch is not set, and list items are supplied, they replace the existing list for that item.

Argument	Description
ITEM	Specifies the name of the item to set.
VALUE	The value to set the item of the specified name to.
STEM	The name of a stem variable that holds an array of items to set. The items in this array don't necessarily belong to the same group or list.
ADD	If this switch is set, any list items are added to the existing settings. If this switch is not set, and list items are supplied, they replace the existing list for that item.

Stem variable

The stem variable used as output of the GETCFG command, or as input for the SETCFG command, holds an array of structured information. Each array element contains the name and value of one configuration item.

Structured information components
Name	Description
ITEM	Name of the item.
VALUE	Value of the item.

Types of items

There are three basic types of configuration items: single items, item groups, and item lists.

Single item

A single item is an atomic configuration item, identified by its name.

Example: HTMLMODE is the item controlling the browser's HTML mode.

Item group

An item group is a set of closely related items. The individual items are identified by the group name and the item name, separated by a period. In the GETCFG command, the group name can be specified to obtain the entire group at once (in a stem variable).

Example: STYLE is a group containing all browser style settings. STYLE.H3 and STYLE.BLOCKQUOTE are two individual items in this group.

Item list

An item list contains one or more values for the same item. These values can not be obtained individually, only as an array. The array elements for the item list all have the same name.

It is possible to set or add an individual value with the SETCFG command. If the ADD switch is given, the value is added to the list, otherwise the one value replaces all existing values from the list.

Example: MIME is a list containing all MIME type and external program settings.

Configuration items

ALLOWCMD

program settings, options: Allow shell commands in links.

Value: Boolean (0 or 1).

ANONYMOUS

network settings, options: Browse anonymously.

Value: Boolean (0 or 1).

AREXX

GUI settings, ARexx: ARexx macro menu.

This is a item list of individual menu entries.

Value of each entry: String with format:

   shortcut;macro;title

shortcut	A number in the range 1..10 representing the menu shortcut (1 = right-Amiga + 1; 9 = right-Amiga + 9; 10 = right-Amiga + 0), or 0 indicating no menu shortcut.
macro	The path and name of the ARexx macro associated with the menu item.
title	The title text as shown in the menu.

AUTOSEARCH

network settings, options: Enable auto search.

Value: Boolean (0 or 1).

AUTOSEARCHURL

Network settings, options: Auto search URL.

Value: String containing the URL of the autosearch search engine.

BACKGROUND

Browser settings, options: Use background and colours.

Value: Boolean (0 or 1).

BGSOUND

Browser settings, options: Use background sounds.

Value: Boolean (0 or 1).

BLINK

Browser settings, options: Blink.

Value: Number in the range 0..40, specifying the blink rate in tenths of a second. Zero means no blinking.

BUTTON

GUI settings, Buttons: User buttons.

This is a item list of individual menu entries.

Value of each entry: String with format:

   label NL command

label	The label to show in the button.
NL	A newline character (hexadecimal 0A).
command	The ARexx command to execute when the button is clicked.

CACHEDISK

Network settings, cache: Cache size on disk.

Value: Non-negative number, specifying the size of the disk cache in kB.

CACHEMEMORY

Network settings, cache: Cache size in memory.

Value: Non-negative number, specifying the size of the memory cache in kB.

CACHEPATH

Network settings, cache: Cache path.

Value: String specifying a DOS path.

COLOUR

Browser settings, colours: Default browser colours.

This item group contains the following items:

COLOUR.BACKGROUND Document background colour.
COLOUR.TEXT Document text colour.
COLOUR.LINK Colour of not yet visited hyperlinks.
COLOUR.VLINK Colour of visited hyperlinks.
COLOUR.ALINK Colour of active (selected) hyperlinks.
Value of all items: String of 6 hexadecimal digits specifying the RGB colour value (RRGGBB).

COLOUR.BACKGROUND	Document background colour.
COLOUR.TEXT	Document text colour.
COLOUR.LINK	Colour of not yet visited hyperlinks.
COLOUR.VLINK	Colour of visited hyperlinks.
COLOUR.ALINK	Colour of active (selected) hyperlinks.

CONSOLE

Program settings, external programs: Console window specification.

Value: String specifying a DOS console window.

CONTANIM

network settings, options: Continuous animation.

Value: Boolean (0 or 1).

COOKIES

Network settings, options: Use cookies.

Value: 0,1 or 2:

0 Never remember or send a cookie.
1 Ask user before remembering a cookie.
2 Remember and send cookies silently.

0	Never remember or send a cookie.
1	Ask user before remembering a cookie.
2	Remember and send cookies silently.

CYCLETOLIST

Browser settings, options: Show cycle fields as list.

Value: Boolean (0 or 1).

DRAGGING

Program settings, options: Allow dragging.

Value: Boolean (0 or 1).

EDITOR

Program settings, external programs: Editor.

Value: String with format:

   command;arguments

command	DOS path and file name of the editor.
arguments	Arguments for the editor.

ENDTCP

Network settings, external programs: End TCP stack.

Value: String with format:

   command;arguments

command	DOS path and file name of the TCP end script.
arguments	Arguments for the script.

FASTRESPONSE

Network settings, cache: Fast response.

Value: Boolean (0 or 1).

FONT

Browser settings, fonts: Browser fonts.

This item group contains the following items:

FONT.N# (# = 1..7) Normal font in this size.
FONT.F# (# = 1..7) Fixed width font in this size.

FONT.N# (# = 1..7)	Normal font in this size.
FONT.F# (# = 1..7)	Fixed width font in this size.

Value of all items: String with format:

   fontname/fontsize

fontname	Name of the font, including the `.font` suffix.
fontsize	Number, specifying the size of the font.

FORMWARNING

Network settings, privacy: Warn before sending unsecure form data.

Value: Boolean (0 or 1).

FRAMES

Browser settings, options: Use frames.

Value: Boolean (0 or 1).

FTPEMAILADDR

Network settings, privacy: Use e-mail address as FTP anon password.

Value: Boolean (0 or 1).

FTPPROXY

Network settings, proxy: FTP proxy.

Value: String containing the URL of the proxy, including the leading http://.

GOPHERPROXY

Network settings, proxy: Gopher proxy.

Value: String containing the URL of the proxy, including the leading http://.

HISTORYCLOSE

Program settings, options: History window auto close.

Value: Boolean (0 or 1).

HISTORYOPEN

Program settings, options: Auto open window history.

Value: Boolean (0 or 1).

HOMEURL

Network settings, options: Home page.

Value: String containing the URL of the browser's home page.

HOTLISTCLOSE

Program settings, options: Hotlist requester auto close.

Value: Boolean (0 or 1).

HOTLISTOPEN

Program settings, options: Auto open hotlist.

Value: Boolean (0 or 1).

HOTLISTREQUESTER

Program settings, options: Hotlist button gives requester.

Value: Boolean (0 or 1).

HTMLMODE

Browser settings, options: HTML mode.

Value: 0, 1 or 2:

0 Strict
1 Tolerant
2 Compatible

0	Strict
1	Tolerant
2	Compatible

HTMLVIEWER

Program settings, external programs: HTML source viewer.

Value: String with format:

   command;arguments

command	DOS path and file name of the HTML viewer.
arguments	Arguments for the HTML viewer.

HTTPPROXY

Network settings, proxy: HTTP proxy.

Value: String containing the URL of the proxy, including the leading http://.

ICONS

Program settings, options: Create icons.

Value: Boolean (0 or 1).

IGNOREMIME

Network settings, options: Ignore server MIME type.

Value: Boolean (0 or 1).

IMAGES

Network settings, options: Image loading.

Value: 0, 1 or 2:

0 Off
1 Maps only
2 All images

0	Off
1	Maps only
2	All images

IMAGEVIEWER

Program settings, external programs: external image viewer.

Value: String with format:

   command;arguments

command	DOS path and file name of the image viewer.
arguments	Arguments for the image viewer.

INCREMENTALTABLE

Browser settings, options: Incremental table display.

Value: Boolean (0 or 1).

INDEXSUFFIX

Network settings, options: Local index name.

Value: String.

JAVASCRIPT

Browser settings, options: Use JavaScript.

Value: Boolean (0 or 1).

KEEPFREECHIP

Network settings, cache: Keep minimum free chip memory.

Value: Non-negative number, specifying the amount of memory in kB.

KEEPFREEFAST

Network settings, cache: Keep minimum free fast memory.

Value: Non-negative number, specifying the amount of memory in kB.

KEY

GUI settings, Keys: User defined keys.

This is a item list of individual key configuration entries.

Value of each entry: String with format:

   key NL command

key

String describing the key to attach the command to. It is in one of these formats:

$xx	Special key, xx is the hexadecimal raw key code.
S-$xx	Shifted special key, xx is the hexadecimal raw key code.
A-$xx	Alt-special key combination, xx is the hexadecimal raw key code.
A-x	Alt-letter key combination, x is a letter (A-Z).

Not all rawkey codes are accepted, only for those special keys listed in the GUI settings requester.

A newline character (hexadecimal 0A).

command

The ARexx command to execute when the key or key combination is hit.

LIMITEDPROXY

Network settings, proxy: Limited proxy usage.

Value: Boolean (0 or 1).

MAILNEWS

Network settings, mail/news: mail and news details.

This item group contains the following items:

MAILNEWS.EMAIL E-mail address
Value: String
MAILNEWS.REALNAME Real name
Value: String
MAILNEWS.REPLYTO Reply-to address
Value: String
MAILNEWS.ORGANIZATION Organization
Value: String
MAILNEWS.SIGNATURE Path of signature file
Value: String
MAILNEWS.SMTPHOST Mail host name (SMTP)
Value: String
MAILNEWS.MAILQUOTEHDR Mail quote header
Value: String
MAILNEWS.EXTMAILER Use external mailer instead
Value: Boolean (0 or 1)
MAILNEWS.NNTPHOST News host name (NNTP)
Value: String
MAILNEWS.NEWSQUOTEHDR News quote header
Value: String
MAILNEWS.USERNAME Authorized news user name
Value: String
MAILNEWS.PASSWORD Authorized news password
Value: String
MAILNEWS.EXTNEWSREADER Use external newsreader instead
Value: Boolean (0 or 1)
MAILNEWS.MAXARTICLES Maximum number of articles
Value: Positive number or zero
MAILNEWS.SORTARTICLES Sort article headers on subject
Value: Boolean (0 or 1)
MAILNEWS.SPLITSCREEN Use split screen when reading news
Value: Boolean (0 or 1)
MAILNEWS.LONGHEADERS Show long headers with news articles
Value: Boolean (0 or 1)
MAILNEWS.PROPFONT Use proportional font for news articles
Value: Boolean (0 or 1)

MAILNEWS.EMAIL	E-mail address
Value: String
MAILNEWS.REALNAME	Real name
Value: String
MAILNEWS.REPLYTO	Reply-to address
Value: String
MAILNEWS.ORGANIZATION	Organization
Value: String
MAILNEWS.SIGNATURE	Path of signature file
Value: String
MAILNEWS.SMTPHOST	Mail host name (SMTP)
Value: String
MAILNEWS.MAILQUOTEHDR	Mail quote header
Value: String
MAILNEWS.EXTMAILER	Use external mailer instead
Value: Boolean (0 or 1)
MAILNEWS.NNTPHOST	News host name (NNTP)
Value: String
MAILNEWS.NEWSQUOTEHDR	News quote header
Value: String
MAILNEWS.USERNAME	Authorized news user name
Value: String
MAILNEWS.PASSWORD	Authorized news password
Value: String
MAILNEWS.EXTNEWSREADER	Use external newsreader instead
Value: Boolean (0 or 1)
MAILNEWS.MAXARTICLES	Maximum number of articles
Value: Positive number or zero
MAILNEWS.SORTARTICLES	Sort article headers on subject
Value: Boolean (0 or 1)
MAILNEWS.SPLITSCREEN	Use split screen when reading news
Value: Boolean (0 or 1)
MAILNEWS.LONGHEADERS	Show long headers with news articles
Value: Boolean (0 or 1)
MAILNEWS.PROPFONT	Use proportional font for news articles
Value: Boolean (0 or 1)

MAILTO

Network settings, external programs: Mailto: program.

Value: String with format:

   command;arguments

command	DOS path and file name of the mailto program or script.
arguments	Arguments for the program or script.

MAXLOCAL

Network settings, options: Maximum local disk reads.

Value: Positive number.

MAXNETWORK

Network settings, options: Maximum network connections.

Value: Positive number.

MIME

Browser settings, viewers: MIME types and external viewers.

This is a item list of individual MIME and viewer definitions. Note that the individual entries in the list will be kept unique with regard to the MIME type. Even if you use the ADD switch on the SETCFG command, a definition for a MIME type will replace the existing definition for that MIME type.

Value of each entry: String with format:

   type/subtype;extensions;action;name;arguments

type/subtype

MIME type.

extensions

Filename extensions that default to this MIME type.

action

Action to perform for this MIME type. Valid actions are:

D	Default
I	Internal
A	AWeb plugin
E	External program
P	External program with PIPE:
S	Save to local disk

name

DOS path and file name of the AWeb plugin or external program.

arguments

Arguments for the AWeb plugin or external program.

NETSTATUSOPEN

Program settings, options: Auto open network status.

Value: Boolean (0 or 1).

NEWS

Network settings, external programs: News: program.

Value: String with format:

   command;arguments

command	DOS path and file name of the mailto program or script.
arguments	Arguments for the program or script.

NOCACHE

Network settings, cache: Do not cache these sites.

This is an item list of individual names or patterns.

Value of each entry: String.

NOCOOKIE

Network settings, options: No cookie for domains.

This is an item list of individual names or patterns.

Value of each entry: String.

NOMINALFRAME

Browser settings, options: Nominal frame height.

Value: Boolean (0 or 1).

NOPROXY

Network settings, proxy: No proxy for these sites.

This is an item list of individual names or patterns.

Value of each entry: String.

OVERLAP

Program settings, options: Scroll overlap.

Value: Non-negative number.

PALETTE

Program settings, palette: Change palette.

This item group contains the following items:

PALETTE.# (# = 0..7) Palette definition for this pen number.
Value of all items: String of 6 hexadecimal digits specifying the RGB colour value (RRGGBB).

PALETTE.# (# = 0..7)	Palette definition for this pen number.

POPUP

GUI settings, options: Popup menu activation.

Value: String containing zero of more from:

A ALT key
C Control key
M Middle mouse button
R Right mouse button
S Shift key

A	ALT key
C	Control key
M	Middle mouse button
R	Right mouse button
S	Shift key

POPUPMENU

GUI settings, Popup: Popup menu.

This is a item list of individual menu entries.

Value of each entry: String with format:

   menu NL memory NL title NL command

menu

Identification of the menu section to add this item to:

I	Image popup menu
L	Link popup menu
F	Frame popup menu

A newline character (hexadecimal 0A).

memory

Number indicating when the item is valid:

1	Item to be shown if object is in memory
2	Item to be shown if object is not in memory
3	Item to be shown always

For the frame popup menu, this indicator is not used and has the value zero.

title

The item title to show in the menu.

command

The ARexx command to execute when the button is clicked.

RFCCOOKIES

Network settings, privacy: RFC 2109.

Value: Boolean (0 or 1).

SAVEPATH

Program settings, options: Save path.

Value: String specifying a DOS path.

SCREEN

Program settings, screen: Screen details.

This item group contains the following items:

SCREEN.TYPE Type of screen to run AWeb on.
Value: 0, 1 or 2:

0 Default public screen
1 Named public screen
2 Own public screen

SCREEN.NAME Name of public screen to run AWeb on.
Value: String.
SCREEN.MODE Screen mode of own public screen.
Value: String containing 8 hexadecimal digits, specifying the screen's ModeID.
SCREEN.WIDTH Width of own public screen in pixels.
Value: Positive number.
SCREEN.HEIGHT Height of own public screen in pixels.
Value: Positive number.
SCREEN.DEPTH Depth of own public screen (number of bitplanes).
Value: Positive number.
SCREEN.PALETTE Load spread palette indicator.
Value: 0, 1 or 2:

0 Off
1 Colours
2 Grayscale

SCREENPENS

Program settings, palette: Pen settings.

Value: String containing 9 pen numbers, separated by spaces. The numbers define the pens to use for: Normal text, Bright edges, Dark edges, Active window title bars, Active window titles, Background (must be 0), Important text, Menu text, Menu background.

   command;arguments

command	DOS path and file name of the TCP start script.
arguments	Arguments for the script.

STYLE

Browser settings, style: Style settings. This item group contains the following items:

STYLE.H1 STYLE.H2 STYLE.H3 STYLE.H4 STYLE.H5 STYLE.H6 STYLE.BIG	STYLE.SMALL STYLE.SUB STYLE.SUP STYLE.ADDRESS STYLE.BLOCKQUOTE STYLE.CITE STYLE.CODE	STYLE.DFN STYLE.EM STYLE.KBD STYLE.PRE STYLE.SAMP STYLE.STRONG STYLE.VAR

Each the style to use for the HTML tag, and corresponding to the entry in the browser settings, style page.

Value: For STYLE.H1 through STYLE.H6, string with format:

   fonttype;absolute size;style

and for the other items, string with format:

   fonttype;relative size;style

fonttype

Type of font to use:

N	Normal font
F	Fixed-width font

absolute size

Number in range 1..7

relative size

Signed number in range -6..+6

style

String containing zero or more from:

B	Bold
I	Italic
U	Underlined

TELNET

Network settings, external programs: Telnet: program.

Value: String with format:

   command;arguments

command	DOS path and file name of the telnet program or script.
arguments	Arguments for the program or script.

0	Verify always
1	Verify once per session
2	Verify never