WinList(0.5)

NAME
WinList - the AfterStep window list module

SYNOPSIS
WinList is spawned by AfterStep, so no command line invocation will work.

DESCRIPTION
The WinList module provides a widow list made up of buttons, each corresponding to a window that AfterStep is managing. Clicking on the buttons with any of the three mouse buttons will either do a default action or can be user configured. Like the other modules, WinList only works when AfterStep is used as the window manager.

INITIALIZATION
During initialization, WinList will scan the ~/GNUstep/Library/AfterStep/winlist file to find the options that pertain to it. These options are discussed in a later section.

INVOCATION
WinList can be invoked by AfterStep during initialization by inserting the line 'Module WinList' in the ~/GNUstep/Library/AfterStep/winlist file. WinList can also be bound to a keystroke, mouse button, or menu option to be invoked later, in this case using 'Transient' as an argument will cause WinList to resemble the built in window list. WinList must reside in a directory that is listed in the ModulePath option of AfterStep for it to be executed by AfterStep.

CONFIGURATION OPTIONS
The following options can be placed in the ~/GNUstep/Library/AfterStep/winlist file :

*WinListGeometry {+-}<X>x{+-}<Y>
    Specifies the location and gravity of the WinList window. At the current time, size is not supported and WinList will resize itself as buttons are added. If the NoAnchor option is not specified then the windows gravity corner will be anchored, and the window will grow in the opposite direction. (i.e. If the geometry is specified -5-5, that is SoutEastGravity. This will cause the window to draw up and to the left as windows are added)

*WinListFont font
    Specifies the font to be used for labeling the buttons.

*WinListFore color
    Specifies the color to use for the button names.

*WinListBack color
    Specifies the color for the buttons.

*WinListUseSkipList
    Tells WinList to not show the windows that are listed on a WindowListSkip line if the configuration file.

*WinListNoAnchor
    By default, WinList will anchor the gravity corner so the window will grow in the opposite direction. This undoes that option.

*WinListUseIconNames
    Tells WinList to use the icon name of the window instead of the full window name. This is useful to keep the width of the window small.

*WinListAction action response[,reponse...]
    Tells WinList to do response when action is done. The currently supported actions are: Click1, Click2, Click3. The currently supported responses are any AfterStep built-in commands, including modules and functions.

*WinListOrientation down|across
    Will make a vertical or horizontal winlist.

*WinListMaxWidth width in pixel
    Sets either maxwidth for a vertical winlist or the actual width for an horizontal "taskbar".

*WinListLeftJustify
    If used, will justify to left window titles (centering is default)

SAMPLE CONFIGURATION
The following are excepts from a winlist file which describe WinList initialization commands:

########
# Pop up the window list in tranient mode on button 3 press & hold
Mouse 3   R   A   Module "WinList" WinList Transient
########################## Window-Lister ###############################
*WinListBack DarkOliveGreen
*WinListFore PaleGoldenRod
*WinListFont -*-new century schoolbook-bold-r-*-*-*-120-*-*-*-*-*-*
*WinListAction Click1 Iconify -1,Raise
*WinListAction Click2 Iconify
*WinListAction Click3 Module "Ident" Ident
*WinListUseSkipList
*WinListUseIconNames
*WinListGeometry -50-85
#*WinListNoAnchor
*WinListMaxWidth 798
# down (vertical winlist) or across (horizontal titlebar) ?
*WinListOrientation across

AUTHOR
Ren'e Fichter <refic_79@unix.edu.sollentuna.se> Mike Finger <mfinger@mermaid.micro.umn.edu>