WinList(1.8) WinList(1.8)
NAME
WinList - the AfterStep window list module
SYNOPSIS
WinList [-f config_file] [-v | --version] [-h | --help]
Although WinList can be run from the command line, it is
normally spawned by afterstep in the autoexec file, in the
following manner:
Module "I" WinList
From within an afterstep menu file by 'WinList':
% cat "~/GNUstep/Library/AfterStep/start/Modules/WinList"
Module "WinList" WinList
MiniPixmap "mini-as.xpm"
To stop the WinList module, a menu item can be used:
% cat "~/GNUstep/Library/AfterStep/start/Modules/WinList_Stop"
KillModuleByName "Stop WinList" WinList
MiniPixmap "mini-as.xpm"
DESCRIPTION
The WinList module provides a window list made up of but
tons, 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 by editing the winlist file.
OPTIONS
-f config_file
Use config_file instead of the default configura
tion file.
-h | --help
Print a usage message and exit successfully.
-v | --version
Print version information and exit successfully.
INITIALIZATION
During initialization, WinList will search a configuration
file which describes the colors, font, actions to take on
mouse clicks, and geometry settings to use. This file will
be the one specified by the -f option (if given). Else,
the ~/GNUstep/Library/AfterStep/winlist file will be used
Feb 7 2000 1
WinList(1.8) WinList(1.8)
if it exists. Else, /usr/local/share/afterstep/winlist
will be used.
If the WinList executable is linked to another name, ie
'ln -s WinList OtherWinList', then another module called
OtherWinList can be started, with a completely different
set of configurations than WinList, simply by adding *Oth
erWinList options following the same *WinList configura
tion options below to the winlist file. This way multiple
Identify programs can be used.
INVOCATION
WinList can be invoked from the autoexec file or from a
menu item as shown in the Synopsis section above.
WinList can also be invoked from binding "Module WinList
argument" to a keystroke or mouse button using Transient
as an argument which will cause WinList to resemble the
built-in window list.
AfterStep will search through the directories specified in
the ModulePath configuration in the base.#bpp (where # is
your colordepth) to attempt to locate WinList.
CONFIGURATION OPTIONS
WinList reads the winlist file when it starts up, and
looks for its configuration options. The MyStyle struc
ture should now be specified in the look files. This
allows for a greater control of the running module (dif
ferent WinList look with different desktop looks, dynamic
reconfiguration etc.).
MyStyle "*WinList"
style_option
~MyStyle
The possible style_options follow:
Font font
Specifies the font associated with this
style. font is a standard X11 font defini
tion.
ForeColor color
Specifies the text color associated with
this style. color is a standard X11 color
definition.
Feb 7 2000 2
WinList(1.8) WinList(1.8)
BackColor color
Specifies the background color associated
with this style. color is a standard X11
color definition.
TextStyle style
Specifies the text style associated with
this style. style can be 0, 1, or 2:
0: normal text
1: 3d effect #1
2: 3d effect #2
MaxColors maximum
Specifies the maximum number of colors that
the BackGradient can use. jpegs specified
with BackPixmap will also be limited to this
number of colors.
BackGradient type from to
Specifies that a gradient should be used as
a background instead of a solid color. The
gradient colors start at from and end at to.
from and to are standard X11 color defini
tions. type can be 1, 2, 3, 4, or 5:
1: Wharf-style diagonal gradient
2: Horizontal from top to bottom
3: Horizontal from top/bottom to center
4: Vertical from left to right
5: Vertical from left/right to center
BackPixmap type pixmap_name|color_name
Specifies that a pixmap should be used as a
background instead of a solid color. This
option has two forms, depending on the value
of type. If type is 128, the second parame
ter, pixmap_name must be the name of an xpm,
jpeg, or png image which can be found in
PixmapPath. If type is 129, the root pixmap
(desktop background) will be used, and the
optional second parameter must be a color
with which the root pixmap will be shaded.
128: tiled pixmap from the upper left
129: "transparent"
Feb 7 2000 3
WinList(1.8) WinList(1.8)
*WinListGeometry geometry
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 window's 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)
*WinListHideGeometry geometry
Specifies the location of the WinList window when
there are no windows. It will cause WinList to
display nice little window with AfterStep version
in there. If size is supplied WinList will center
the label within the window.
*WinListUseSkipList
Tells WinList to not show the windows that are have
WindowListSkip as a Style option in the atabase
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 mod
ules 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 a horizontal "taskbar".
Feb 7 2000 4
WinList(1.8) WinList(1.8)
*WinListJustify <Left|Center|Right>
If used, will justify the text as specifyed. If
unspecified, the default is to center text.
*WinListAutoHide number
Makes WinList auto-hide, when the mouse cursor
travels off WinList it reduces its size and becomes
a line, when the mouse cursor travels onto hidden
WinList it readjusts its size to normal dimensions.
0 turns this feature off, positive numbers turn it
on. This option makes sense only when WinList is
set to StaysOnTop in the database file. It is pos
sible to turn AutoHide on/off when the module is
running: pressing 'u' while the cursor is in the
WinList window permanently unhides, pressing 'h'
while the cursor is in the WinList window turns
AutoHide on.
*WinListBalloons
Turns on the balloon feature. A "balloon" is dis
played showing the name of the button the pointer
is resting on in the WinList. The balloon back
ground and text are configured with the MyStyle
"*WinListBalloon". See afterstep(1x) for more
information on MyStyles.
*WinListBalloonBorderWidth number
Sets the width of the balloon window's border.
Defaults to 1.
*WinListBalloonBorderColor color
Sets the color of the balloon window's border.
Defaults to black.
*WinListBalloonDelay number
Specifies the period in milliseconds to delay the
appearance of the balloon.
*WinListBalloonYOffset number
The balloon window is positioned to be horizontally
centered against the WinList window it is describ
ing. The vertical position may be set as an offset.
Negative offsets of -N are placed N pixels above
the WinList window, positive offsets of +N are
placed N pixels below. Defaults to +2.
Feb 7 2000 5
WinList(1.8) WinList(1.8)
FILES
/usr/local/share/afterstep/winlist
The global configuration file for system wide
defaults of all users.
$HOME/GNUstep/Library/AfterStep/winlist
This file should be copied from the
/usr/local/share/afterstep/winlist and edited to
suit the user's specific requirements. This file,
if exists, will override the system wide default
file.
EXAMPLES
The winlist file shipped contains a working example, refer
to the FILES section above for its configuration options.
To pop up the window list in tranient mode (appear only
when button 3 is pressed & held):
...the feel file would contain -
Mouse 3 R A Module "WinList" WinList Transient
AUTHORS
Rene Fichter <ceezaer@cyberspace.org>
Mike Finger <mfinger@mermaid.micro.umn.edu>
David Mihm <dmihm@swbell.net> [Man page]
Rafal Wierzbicki <rafal@mcss.mcmaster.ca>
SEE ALSO
afterstep(1),
Feb 7 2000 6
Man(1) output converted with
man2html