Home Page The Club Computers News Links Glossary EYAWTK
Before Amiga Background ICS OCS ECS AGA ??? PPC
U-Boot SLB Linux Amiga OS Dual Boot Motherboards Peripherals Other
Initialisation Installation OS4 Updates About OS4 File Systems Networking Printing Other
Introduction File System Workbench Preferences Commands Error Msgs Miscellaneous

AmigaOS 4.0 - About OS4 - Commands

WBPATTERN Preferences Editor
Purpose: To specify the background for various Workbench windows.
Format: WBPATTERN [<filename>] [EDIT | USE | SAVE] [PUBSCREEN <public screen  name>] [SCREEN] [SHOWHINTS YES | NO] [CREATEICONS YES | NO] [LEFT <coord> | LEFT | CENTER | MOUSE | AUTO] [TOP <coord> | TOP | CENTER | MOUSE | AUTO] [WIDTH <size> | MAXSIZE | MINSIZE | AUTO] [HEIGHT <size> | MAXSIZE | MINSIZE | AUTO] [FONTNAME <font name>] [FONTSIZE <font size>] [WBIMAGE <imagename>] [WINDOWIMAGE <imagename>] [SCREENIMAGE <imagename>] [CLIPUNIT <unit>] [NOREMAP]
Template: FROM, EDIT/S, USE/S, SAVE/S, PUBSCREEN/K, SCREEN/S, SHOWHINTS/K, CREATEICONS/K, LEFT/K, TOP/K, WIDTH/K, HEIGHT/K, FONTNAME/K, FONTSIZE/K/N, WBIMAGE/K, WINDOWIMAGE/K, SCREENIMAGE/K, CLIPUNIT/K/N, NOREMAP/S
Path: SYS:Prefs/WBPattern
WBPATTERN can be used to specify the background for various Workbench windows.

WBPATTERN without any arguments or with the EDIT argument opens the WBPattern Preferences editor.

The FROM argument <filename> enables you to specify a file to open. This must be a file that was previously saved with the 'Save As' menu item of the WBPattern Preferences editor. For example, if you have previously saved a special configuration of the WBPattern Preferences editor to a file in the Presets drawer, you can use the FROM argument to open that file.

If the USE switch is also given, the WBPattern Preferences editor will not be opened, but the settings in the FROM file will be used.

If the SAVE switch is given, the WBPattern Preferences editor will not open, but the settings in the FROM file will be saved.

The PUBSCREEN option can be used to specify a <public screen name> where the WBPattern Preferences editor should open.

The SCREEN option can be used to force the WBPattern Preferences editor to open in full-screen mode.

The SHOWHINTS YES option will display usage hints when the cursor is positioned over any field on the screen. SHOWHINTS NO suppresses this information.

If CREATEICONS YES is specified, an icon will be created for the saved file, otherwise no icon will be created.

The LEFT, TOP, WIDTH and HEIGHT options can be used to customise where the WBPattern Preferences editor window should appear on the screen and the size of the window.

The FONTNAME and FONTSIZE options can be used to specify the font and font size to be used in the WBPattern Preferences editor window.

The WBIMAGE <imagename> option sets the value for the 'Workbench' Picture Name field. If the USE or SAVE switches are also given, the WBPattern Preferences editor will not be opened, but the value passed will be used as the background for the Workbench window, and if SAVE was specified it will be changed permanently.

The WINDOWIMAGE <imagename> option sets the value for the 'Windows' Picture Name field. If the USE or SAVE switches are also given, the WBPattern Preferences editor will not be opened, but the value passed will be used as the background for all other windows, and if SAVE was specified it will be changed permanently.

The SCREENIMAGE <imagename> option sets the value for the 'Screen' Picture Name field. If the USE or SAVE switches are also given, the WBPattern Preferences editor will not be opened, but the value passed will be used as the background for the screen behind the Workbench window, and if SAVE was specified it will be changed permanently.

The CLIPUNIT <clipunit> option enables you to specify the clipboard.device unit number to use. Specify any unit from 0 to 255. The default number is 0. It is recommended that this option be used only by advanced users or programmers who wish to use different units for different data, such as one for text and another for graphics.

The NOREMAP option turns off color mapping so that the system displays picture files using the colors with which they were saved.

Instructions for using the WBPattern Preferences editor can be found here.

Example 1:

  3.OS4:> WBPATTERN

will open the WBPattern Preferences window.

Example 2:

  3.OS4:> WBPATTERN USE WBIMAGE=OS4:Prefs/Presets/Backgrounds/AA_WB.jpg

will not open the WBPattern Preferences window, but will use AA_WB.jpg as the background for the Workbench screen.


Return to Commands Selection

Disclaimer: Amiga Auckland have prepared the above information for the use of its members based on our experiences and as such is subject to revision at any time. Amiga Auckland cannot guarantee any of the information and cannot be held accountable for any issues that may result from using it.


Copyright 2006 Amiga Auckland Inc. All rights reserved.
Revised: February 9, 2006.