Section 0: Wharf



This page was been converted automatically, from Debian GNU/Linux man pages.




Wharf(1.6)                                             Wharf(1.6)


NAME

Wharf - the AfterStep "application dock" module

SYNOPSIS

Wharf is spawned by afterstep, so no command line invoca- tion will work. From within the autoexec file or as a menu option, Wharf is spawned as follows: Module "I" Wharf Wait "I" Wharf Wait is used to allow Wharf to swallow the apps specified in the wharf file prior to afterstep starting other apps which use the same name. or from within an afterstep menu file by 'Wharf': cat "~/GNUstep/Library/AfterStep/start/Modules/Wharf" Module "Wharf" Wharf MiniPixmap "mini-as.xpm" To stop the Wharf module, a menu item can be used: cat "~/GNUstep/Library/AfterStep/start/Modules/Wharf_Stop" KillModuleByName "Stop Wharf" Wharf MiniPixmap "mini-as.xpm"

DESCRIPTION

The Wharf module is a free-floating application loader that can execute programs, "Swallow" running programs, and contain "Folders" of more applications, among other things. Pressing mouse button 1 on a button triggers either a "Folder" to open, or an application to run, while pressing mouse button 3 will cause the entire /fBWharf/fP to with- draw to the nearest corner in an iconized state. Some swallowed apps have mouse button 2 bound for its use.

INITIALIZATION

During initialization, Wharf will search for a configura- tion file which describes the button panel geometry, color, icons, and applications to use/swallow. The config- uration file is /usr/local/share/afterstep/wharf; but can be overriden by ~/GNUstep/Library/AfterStep/wharf . If the Wharf executable is linked to another name, ie ln -s Wharf OtherWharf, then another module called OtherWharf can be started, with a completely different set of Wharf Dec 10 1998 1 Wharf(1.6) Wharf(1.6) configurations than Wharf, simply by adding configuration options with the keywords *OtherWharf. This way multiple Wharf programs can be used. Note that the symlinked mod- ule can not be called Wharf, as aftrestep will pressume the standard Wharf binary.

INVOCATION

Wharf can be invoked from the autoexec file or from a menu item as shown in the Synopsis section above. AfterStep will search through the directories specified in the ModulePath configuration in the base.#bpp (where # is your colordepth) to attempt to locate Wharf; as well as searching through the PixmapPath for the pixmaps & Icon- Path for the bitmaps supplied in the configuration options. CONFIGURATION OPTIONS Wharf reads the wharf file when it starts up and looks for it's configuration options: *WharfTextureType type Specifies the type of gradient fill or pixmap to be used on Wharf's buttons. Valid values for type are: 0 - No texture - use WharfBgColor to set the desired color 1 - Gradient from upper-left to lower right 2 - Horizontal one way gradient from top to bottom 3 - Horizontal cylindrical gradient from top/bottom to center 4 - Vertical one way gradient from left to right 5 - Vertical cylindrical gradient from left/right to center 128 - User defined pixmap The default is the builtin Wharf texture pixmap. *WharfTextureColor from to When used with a *WharfTextureType of 1 through 5, designates the ends of the color gradient's range to be used on Wharf's buttons. *WharfPixmap pixmap Sets the pixmap file to be used as Wharf's button. To be used with *WharfTextureType 128. If the pixmap is transparent, Wharf will be transparent (shaped). The path need not be specified if the pixmap is in the PixmapPath specified in the base.#bpp file. Valid pixmaps are XPM, JPEG, or PNG. Wharf Dec 10 1998 2 Wharf(1.6) Wharf(1.6) *WharfBgColor color If *WharfTextureType 0 is specified, Wharf's but- tons will be filled with color. *WharfMaxColors number Specifies the maximum number of colors to use on a gradient fill. *WharfAnimate If specified, the opening and closing of Folders will be animated, rather than simply drawn in one frame. *WharfAnimateMain Designates that full-length Wharf withdraws will be animated. *WharfAnimateDelay delay Specifies the delay in milliseconds that the anima- tion will pause between each move when opening or closing a folder. *WharfAnimateSteps steps Specifies the steps a Folder takes in animating while opening or closing. This translates into the Folder button moving /steps pixels each step. *WharfAnimateStepsMain steps Specifies the steps the main Wharf takes in iconi- fication or de-iconification upon mouse button 3 being pressed. This translates into the main Wharf moving /steps pixels each step. *WharfBalloons Turns on the balloon feature. A "balloon" is dis- played showing the name of the button the pointer is resting on in the Wharf. *WharfBalloonFore color Specifies the color for text in the balloon window. If omitted it defaults to the foreground color for the window being described. Wharf Dec 10 1998 3 Wharf(1.6) Wharf(1.6) *WharfBalloonBack color Specifies the background color for the balloon win- dow. If omitted it defaults to the background color for the window being described. *WharfBalloonFont font-name Specifies a font to use for the balloon text. Defaults to fixed. *WharfBalloonBorderWidth number Sets the width of the balloon window's border. Defaults to 1. *WharfBalloonBorderColor color Sets the color of the balloon window's border. Defaults to black. *WharfBalloonDelay number Specifies the period in milliseconds to delay the appearance of the balloon. *WharfBalloonYOffset number The balloon window is positioned to be horizontally centered against the Wharf window it is describing. The vertical position may be set as an offset. Neg- ative offsets of -N are placed N pixels above the Wharf window, positive offsets of +N are placed N pixels below. Defaults to +2. *WharfFullPush If specified, the entire Wharf button background will be offset down and to the right 2 pixels when pushed. Especially useful with *WharfNoBorder tex- tures. *WharfNoPush If specified, the entire Wharf button will not appear as if it is being pushed in. *WharfNoBorder Denotes that beveled borders should not be drawn around the Wharf button. Useful with textures or pixmaps that include their own bevels. Wharf Dec 10 1998 4 Wharf(1.6) Wharf(1.6) *WharfForceSize If specified, will force pixmaps larger than 64x64 to the default size of 64x64. Pixmaps smaller than 64x64 are not supported. This has no effect on the icons used for applications. *WharfRows rows Specifies the number of rows of buttons to be cre- ated. If unspecified, the number of rows will be set to 1. If the rows are set to a number greater than 1 then there will be that number of rows with enough columns to satisfy the requested number of buttons. *WharfColumns columns Specifies the number of columns of buttons to be created. If unspecified, the number of columns will be set to 1. If the columns are set to a number greater than 1 then there will be that number of columns with enough rows to satisfy the requested number of buttons. *WharfGeometry geometry Specifies the Wharf window location and/or size. If the size is not specified, Wharf will auto-size itself in a reasonable manner. The geometry is a standard X11 window geometry specification. *Wharf label-for-balloon icon [size W H] command The label-for-balloon is what appears in the Bal- loons if balloons are used, otherwise this entry is still required. Multiple entries can refer to the same wharf button by using the same label-for-bal- loon. The icon field specifies an X11 bitmap file, XPM, JPEG, or PNG color icon file or a comma-delimited set of pixmaps containing the icon(s) to display on the button. These icon(s) will be displayed in front of the WharfTextureColor, WharfPixmap, or WharfBgColor, and behind any Swallowed windows. Transparent icons are allowed. The optional parameter size W H specifies the W width and H height, both in pixels, of the Wharf buttons. The order of precedence is 1) Size defi- nition; 2) MaxSwallow window size; 3) WharfPixmap size; otherwise 4) Use 64x64. The command specifies an AfterStep built-in command Wharf Dec 10 1998 5 Wharf(1.6) Wharf(1.6) (as described in the afterstep man page), or a Wharf command; which should be executed when a but- ton is pressed. The following Wharf commands are available: Swallow "window-name" command Causes Wharf to run command, capture the first win- dow whose name or resource is window-name, and dis- play it in the associated button. The application window will be shrunk to fit the size of the but- ton. MaxSwallow "window-name" command Like Swallow, except the button will be resized to fit the application. SwallowModule "window-name" command Like Swallow, except the command is an AfterStep module. MaxSwallowModule "window-name" command Like MaxSwallow, except the command is an AfterStep module. DropExec "label" command Specifies a command to run when the associated but- ton receives a Offix Drag & Drop event. (if present) will be replaced with the dropped data, and (if present) will be replaced with the data type. See EXAMPLES below for an example. Size width height Sets the size of the associated button, overriding any other size consideration. Folder "folder-name" Defines a slide-out folder inside the current folder. The following button definitions will be placed inside of the subfolder, until a *Wharf ~Folder line is encountered. See the EXAMPLES sec- tion below for an example. Folders may be nested.

FILES

Wharf Dec 10 1998 6 Wharf(1.6) Wharf(1.6) /usr/local/share/afterstep/wharf The global configuration file for system wide defaults of all users. $HOME/GNUstep/Library/AfterStep/wharf This file should be copied from the /usr/local/share/afterstep/wharf and edited to suit the user's specific requirements. This file, if exists, will override the system wide default file. /usr/local/share/afterstep/base.[8|15|16|24|32]bpp Contains the IconPath & PixmapPath global settings for the Wharf. $HOME/GNUstep/Library/AfterStep/base.[8|15|16|24|32]bpp This file should be copied from the/usr/local/share/after- step/base.[8|15|16|24|32]bpp and edited to suit the user's specific requirements for the IconPath & PixmapPath settings of the Wharf.

EXAMPLES

The wharf file shipped contains many examples, refer to the CONFIGURATION OPTIONS section above for its configura- tion options. To create slide-out folders in Wharf the following format must be used: *Wharf files Folders.xpm,3_dots.xpm Folder *Wharf xftp 3DRings.xpm Exec "" xftp & *Wharf xdir FolderDeposit.xpm Exec "" xdir & *Wharf moxfm FilingCabinet.xpm Exec "" moxfm & *Wharf ~Folder The first line of this set tells Wharf that this button definition will be a folder. All of the button defini- tions between the Folder and the line with the definition of *Wharf ~Folder will appear on the "files" folder when it is exposed. To expose the "files" folder simply click on the Wharf button with the Folders.xpm icon showing. A button bar will appear perpendicular to your Wharf bar and toward the center of the screen. On this smaller bar will be the three icons that were configured between the Folder and ~Folder parts of the Wharf configuration. Folders may be nested. Wharf supports the OffiX Drag and Drop standard. The fol- lowing is an example of a DropExec line: Wharf Dec 10 1998 7 Wharf(1.6) Wharf(1.6) *Wharf trash Recyler.xpm DropExec "" rm *Wharf trash - Restart "" afterstep The button will restart AfterStep when pushed. If a file is dragged onto into it, rm will be called with being replaced by the dropped filename.

AUTHORS

Beat Christen Frank Fejes Alfredo Kengi Kojima Dan Weeks Bo Yang Robert Nation David Mihm [Man page] Ethan Fischer SEE ALSO afterstep(1), Pager(1), X(1) Wharf Dec 10 1998 8