fookb/fookb.1x

   1 .\" Copyright (c) 1998-2004 Alexey Vyskubov <alexey@mawhrin.net>
   2 .\"
   3 .\" This is free documentation; you can redistribute it and/or
   4 .\" modify it under the terms of the Artistic License
   5 .\" This manual is distributed in the hope that it will be useful,
   6 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
   7 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   8 .TH fookb 1 "10 Jan 2002" "fookb" "FOOcrosoft"
   9 .SH NAME
  10 fookb \- Xkb state indicator with optional Window Maker support
  11 .SH SYNOPSIS
  12 .B fookb [options]
  13
  14 .SH DESCRIPTION
  15 \fBfookb\fP is a Xkb state indicator. It displays
  16 the icon corresponding to the number of Xkb locked group. You may use
  17 mouse-clicks to change Xkb locked group with mouse. Additionally,
  18 \fBfookb\fP can be configured to execute a program on changing group.
  19 .P
  20 \fBfookb\fP man page is based on \fBWMMail.app\fP man page. Program
  21 was written from scratch.
  22 .P
  23 To use \fBfookb\fP with the Window Maker Dock, simply drag the
  24 \fBfookb\fP icon to the Window Maker Dock (if \fBfookb\fP was compiled
  25 with Window Maker support).
  26
  27 .SH OPTIONS
  28 .TP
  29 NB! Command line parameters take precedence over config file or X resources!
  30 .TP
  31 All the icons should be of the same size or fookb will refuse to run. If you
  32 use Windowmaker-enabled version of fookb (windowmaker dockable applet) then
  33 fookb will warn you if you use icons of size more than 64x64, but it will try
  34 to run anyway.
  35 .TP
  36 .B -icon1
  37 .TP
  38 .B -icon2
  39 .TP
  40 .B -icon3
  41 .TP
  42 .B -icon4
  43 .TP
  44 .B -iconboom
  45 .TP
  46 .B -display
  47
  48 .SH CONFIGURATION FILE (for libWUtil-enabled version)
  49 The configuration file consist of a single PropList dictionary, which
  50 in turn is composed of several PropList key\-value pairs. The
  51 recognized keys is:
  52 .TP
  53 .B Icon1 Filename (mandatory)
  54 XPM file contains an icon for 1st XKB group.
  55 .TP
  56 .B Icon2 Filename (mandatory)
  57 XPM file contains an icon for 2nd XKB group.
  58 .TP
  59 .B Icon3 Filename (mandatory)
  60 XPM file contains an icon for 3rd XKB group.
  61 .TP
  62 .B Icon4 Filename (mandatory)
  63 XPM file contains an icon for 4th XKB group.
  64 .TP
  65 .B IconBoom Filename (mandatory)
  66 XPM file contains an icon for "broken Xkb". Please look in
  67 BUGS section.
  68 .TP
  69 .B Sound (Yes|No)
  70 \fBfookb\fP will run command from "Command" value (see below), if this
  71 parameter is set to "Yes". You'll receive (non-fatal) error message if
  72 this parameter is not defined. In any other case command will not be
  73 run.
  74 .TP
  75 .B Command command_to_run
  76 This command will be run if XKB locked group is changed and "Sound" is
  77 set to "Yes".
  78
  79 .SH X resources
  80 .TP
  81 NB! Parameters in PropList config file take precedence over X resources!
  82 .TP
  83 .B fookb.icon1 Filename
  84 .TP
  85 .B fookb.icon2 Filename
  86 .TP
  87 .B fookb.icon3 Filename
  88 .TP
  89 .B fookb.icon4 Filename
  90 .TP
  91 .B fookb.iconBoom Filename
  92 .TP
  93 .B fookb.sound Yes/No
  94 .TP
  95 .B fookb.command Command
  96
  97 .SH EXAMPLES
  98 Here is an example of configuration file.
  99 .P
 100 .nf
 101 {
 102   Icon1 = "/usr/local/share/fookb/icon1.xpm";
 103   Icon2 = "/usr/local/share/fookb/icon2.xpm";
 104   Icon3 = "/usr/local/share/fookb/icon3.xpm";
 105   Icon4 = "/usr/local/share/fookb/icon4.xpm";
 106   IconBoom = "/usr/local/share/fookb/crash.xpm";
 107   Sound = "Yes";
 108   Command = "/usr/bin/play /usr/local/share/fookb/click.au";
 109 }
 110 .fi
 111
 112 Here is an example of app-defaults file.
 113 .P
 114 .nf
 115 fookb.icon1: /usr/local/share/fookb/icon1.xpm
 116 fookb.icon2: /usr/local/share/fookb/icon2.xpm
 117 fookb.icon3: /usr/local/share/fookb/icon3.xpm
 118 fookb.icon4: /usr/local/share/fookb/icon4.xpm
 119 fookb.iconBoom: /usr/local/share/fookb/crash.xpm
 120 fookb.sound: Yes
 121 fookb.command: /home/bgates/bin/playmssound
 122 .fi
 123
 124 .SH FILES
 125 .TP
 126 .B ~/GNUstep/Defaults/FOOkb
 127 \fBfookb\fP defaults (for Window Maker enabled version).
 128 .TP
 129 .B ~/.fookb
 130 \fBfookb\fP defaults (for Window Maker disabled version).
 131
 132 .SH BUGS
 133 Sometimes \fBfookb\fP receives message about changing XKB group, but
 134 message.state.group does not point to any existing XKB group. In this
 135 case \fBfookb\fP will show IconBoom (from config file) picture.
 136 .P
 137 As far as I know the only way to look at this bug is to run vmware.
 138
 139 .SH VERSION
 140 This man page is [hopefully] up-to-date for version 3.1 of \fBfookb\fP.
 141
 142 .SH AUTHORS
 143 .P
 144 \fBfookb\fP is (c) 1998-2004 Alexey Vyskubov <alexey@mawhrin.net>.
 145 .P
 146 This manpage was written by Alexey Vyskubov <alexey@mawhrin.net>.