1 .\" $Id: wmpager.1x,v 1.2 2002/08/16 17:20:37 essmann Exp $
3 .\" Copyright (c) 2001-2002 Bruno Essmann <essmann@users.sourceforge.net>
4 .\" All rights reserved.
6 .TH wmpager 1x "2002 Aug 16" "wmpager-1.2"
8 wmpager - Window Maker workspace pager docklet
14 is a Window Maker pager docklet that offers:
17 workspace switching for up to nine workspaces
19 automatic configuration according to the number of available workspaces
21 automagic adjustment to the currently active workspace
23 configurable look and feel
31 Display usage and version information.
34 Enable verbose message output.
36 .B \-d \-\-display \fI<name>\fP
37 The display to use (defaults to the 'DISPLAY' environment variable).
39 .B \-s \-\-size \fI<w>x<h>\fP
40 The number of buttons to display. The default depends on the number of
41 workspaces you have, i.e. 2x2 for 4 workspaces, 2x3 for 6, maximum is 3x3.
43 .B \-w \-\-workspaces \fI<count>\fP
44 The number of workspace buttons to display. The default is the number of
45 workspaces you have up to a maximum is 9.
47 .B \-t \-\-theme \fI<theme.xpm>\fP
48 The button theme to use. \fI<theme.xpm>\fP is either an absolute pathname
49 pointing to an 'xpm' theme file or a filename relative to the installation
50 directory (see option \-\-installdir). The extension '.xpm' in the file or
54 For more information on theme files see the entry \fIBUTTON THEMES\fP below.
57 .B \-i \-\-installdir \fI<dir>\fP
58 Specifies the location of the installation directory. wmpager looks for 'xpm'
59 theme files at this location. The default are '/usr/local/share/wmpager/' and
60 the user specific '~/.wmpager' directory.
62 .B \-\-disable\-tooltips
63 Disables display of any tooltip windows. By default tooltips are enabled.
65 .B \-\-tooltip\-font \fI<font>\fP
66 Specifies the font to as tooltip font. The default is helvetica, bold, roman,
70 \-*\-helvetica\-bold\-r\-normal\-*\-12\-*\-*\-*\-*\-*\-*\-*
73 .B \-\-tooltip\-delay \fI<millis>\fP
74 Sets the delay before the tooltip window is popped up (default is 750 milliseconds).
76 .B \-\-tooltip\-reshow \fI<millis>\fP
77 Set the tooltip reshow delay (triggered when moving from button to button).
78 The default is 1500 milliseconds.
80 .B \-\-tooltip\-outside
81 Specifies that tooltips should be displayed outside of the docklet window.
82 By default they are displayed next to the workspace button.
86 Depending on your WindowMaker theme you might want to use another
87 theme for wmpager as well. Use option '\-t' or '\-\-theme' to specify
88 the location of an XPM file (the extension '.xpm' is optional, it has
89 to be an XPM file though). If you use option '\-i', '\-\-installdir' or
90 have set the environment variable WMPAGER to the installation location
91 of the wmpager themes, then you may also skip the path to the theme.
93 Predefined themes: Well, I'm not much of an artist therefore I've only
94 included some themes to give you an idea of how a real nice theme
95 might be done. Naturally, I use the built\-in theme and theme support
96 is only there because I have been asked to include it...
98 If you create a theme yourself please send it to me and I'll include it
101 The list of predefined themes in this release includes:
104 blue (the built\-in theme)
113 Creating your own themes: If you want to create your own theme simply
114 take one of the included XPM theme files and modify it to your needs.
115 If you really want to know, the format of the file is described below.
117 XPM file format: The XPM file has to be at least 102 by 71 pixels in
118 size. The area 0,0 to 50,50 describes the background for the selected
119 workspace, the area 51,0 to 101,50 for unselected work spaces. The
120 area has to include a one\-pixel border that is used for all workspace
121 buttons. From 0,51 to 89,60 are the digits used for the selected
122 workspace (each 10x10 pixels, 1\-9 from left to right) and from 0,61 to
123 89,70 are the digits for unselected workspaces. The digits may have
124 a transparent background.
127 In order for wmpager to work properly you need to have your Window
128 Maker compiled with Gnome support. (I don't know if this is the case
129 for the precompiled Window Makers usually found in Linux distributions
130 since I usually build my Window Maker myself.)
132 wmpager uses the Gnome support messages sent out by Window Maker to
133 display the currently active workspace. Without Gnome support the
134 pager will not automatically adjust the currently active desktop.
138 To file a bugreport please use the bug tracking system at:
140 \fIhttp://sourceforge.net/projects/wmpager/\fP
144 Bruno Essmann <essmann@users.sourceforge.net>
146 \fIhttp://wmpager.sourceforge.net/\fP
150 Thanks to all at Ergon Informatik AG who are using wmpager and helped
153 \fIhttp://www.ergon.ch/\fP