wmpager/man/wmpager.1x

   1 .\" $Id: wmpager.1x,v 1.2 2002/08/16 17:20:37 essmann Exp $
   2 .\"
   3 .\" Copyright (c) 2001-2002 Bruno Essmann <essmann@users.sourceforge.net>
   4 .\" All rights reserved.
   5 .\"
   6 .TH wmpager 1x "2002 Aug 16" "wmpager-1.2"
   7 .SH NAME
   8 wmpager - Window Maker workspace pager docklet
   9 .SH SYNOPSIS
  10 .B wmpager
  11 [options]
  12 .SH DESCRIPTION
  13 .B wmpager
  14 is a Window Maker pager docklet that offers:
  15 .PD 0
  16 .IP \(bu 2
  17 workspace switching for up to nine workspaces
  18 .IP \(bu 2
  19 automatic configuration according to the number of available workspaces
  20 .IP \(bu 2
  21 automagic adjustment to the currently active workspace
  22 .IP \(bu 2
  23 configurable look and feel
  24 .PD
  25 .SH OPTIONS
  26 .PD 0
  27 .TP
  28 .B \-h \-\-help
  29 Display usage and version information.
  30 .TP
  31 .B \-v \-\-verbose
  32 Enable verbose message output.
  33 .TP
  34 .B \-d \-\-display \fI<name>\fP
  35 The display to use (defaults to the 'DISPLAY' environment variable).
  36 .TP
  37 .B \-s \-\-size \fI<w>x<h>\fP
  38 The number of buttons to display. The default depends on the number of
  39 workspaces you have, i.e. 2x2 for 4 workspaces, 2x3 for 6, maximum is 3x3.
  40 .TP
  41 .B \-w \-\-workspaces \fI<count>\fP
  42 The number of workspace buttons to display. The default is the number of
  43 workspaces you have up to a maximum is 9.
  44 .TP
  45 .B \-t \-\-theme \fI<theme.xpm>\fP
  46 The button theme to use. \fI<theme.xpm>\fP is either an absolute pathname
  47 pointing to an 'xpm' theme file or a filename relative to the installation
  48 directory (see option \-\-installdir). The extension '.xpm' in the file or
  49 pathname is optional.
  50 .RS
  51 .PP
  52 For more information on theme files see the entry \fIBUTTON THEMES\fP below.
  53 .RE
  54 .TP
  55 .B \-i \-\-installdir \fI<dir>\fP
  56 Specifies the location of the installation directory. wmpager looks for 'xpm'
  57 theme files at this location. The default are '/usr/local/share/wmpager/' and
  58 the user specific '~/.wmpager' directory.
  59 .PD
  60 .SH BUTTON THEMES
  61 .PD
  62 Depending on your WindowMaker theme you might want to use another
  63 theme for wmpager as well. Use option '\-t' or '\-\-theme' to specify
  64 the location of an XPM file (the extension '.xpm' is optional, it has
  65 to be an XPM file though). If you use option '\-i', '\-\-installdir' or
  66 have set the environment variable WMPAGER to the installation location
  67 of the wmpager themes, then you may also skip the path to the theme.
  68
  69 Predefined themes: Well, I'm not much of an artist therefore I've only
  70 included some themes to give you an idea of how a real nice theme
  71 might be done. Naturally, I use the built\-in theme and theme support
  72 is only there because I have been asked to include it...
  73
  74 If you create a theme yourself please send it to me and I'll include it
  75 in the next build.
  76
  77 The list of predefined themes in this release includes:
  78 .PD 0
  79 .IP \(bu 2
  80 blue (the built\-in theme)
  81 .IP \(bu 2
  82 fire
  83 .IP \(bu 2
  84 gray
  85 .IP \(bu 2
  86 steel
  87 .RE 2
  88
  89 Creating your own themes: If you want to create your own theme simply
  90 take one of the included XPM theme files and modify it to your needs.
  91 If you really want to know, the format of the file is described below.
  92
  93 XPM file format: The XPM file has to be at least 102 by 71 pixels in
  94 size. The area 0,0 to 50,50 describes the background for the selected
  95 workspace, the area 51,0 to 101,50 for unselected work spaces. The
  96 area has to include a one\-pixel border that is used for all workspace
  97 buttons. From 0,51 to 89,60 are the digits used for the selected
  98 workspace (each 10x10 pixels, 1\-9 from left to right) and from 0,61 to
  99 89,70 are the digits for unselected workspaces. The digits may have
 100 a transparent background.
 101 .PD
 102 .SH REQUIREMENTS
 103 In order for wmpager to work properly you need to have your Window
 104 Maker compiled with Gnome support. (I don't know if this is the case
 105 for the precompiled Window Makers usually found in Linux distributions
 106 since I usually build my Window Maker myself.)
 107
 108 wmpager uses the Gnome support messages sent out by Window Maker to
 109 display the currently active workspace. Without Gnome support the
 110 pager will not automatically adjust the currently active desktop.
 111 .PD
 112 .SH BUGS
 113 .PD 0
 114 To file a bugreport please use the bug tracking system at:
 115 .TP
 116 \fIhttp://sourceforge.net/projects/wmpager/\fP
 117 .PD
 118 .SH AUTHOR
 119 .PD 0
 120 Bruno Essmann <essmann@users.sourceforge.net>
 121 .LP
 122 \fIhttp://wmpager.sourceforge.net/\fP
 123 .PD
 124 .SH ACKNOWLEDGEMENTS
 125 .PD 0
 126 Thanks to all at Ergon Informatik AG who are using wmpager and helped
 127 improve it!
 128 .LP
 129 \fIhttp://www.ergon.ch/\fP
 130 .PD
 131 .SH "SEE ALSO"
 132 \fBwmaker\fP(1x)