fookb/fookb.1.in

   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 "September 2017"
   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!
  30 .TP
  31 All the icons should be of the same size or fookb will refuse to run.
  32 fookb will warn you if you use icons of size more than 64x64, but it will try
  33 to run anyway.
  34 .TP
  35 .B --icon1
  36 Icon to show for the 1st Xkb group
  37 .TP
  38 .B --icon2
  39 Icon to show for the 2nd Xkb group
  40 .TP
  41 .B --icon3
  42 Icon to show for the 3rd Xkb group
  43 .TP
  44 .B --icon4
  45 Icon to show for the 4th Xkb group
  46 .TP
  47 .B --iconboom
  48 Icon to show when Xkb system goes crazy
  49 .TP
  50 .B -d,--display
  51 X display to use (normally not needed)
  52
  53 .SH CONFIGURATION FILE
  54 The configuration file consist of a single PropList dictionary, which
  55 in turn is composed of several PropList key\-value pairs. The
  56 recognized keys is:
  57 .TP
  58 .B Icon1 Filename (mandatory)
  59 XPM file contains an icon for 1st XKB group.
  60 .TP
  61 .B Icon2 Filename (mandatory)
  62 XPM file contains an icon for 2nd XKB group.
  63 .TP
  64 .B Icon3 Filename (mandatory)
  65 XPM file contains an icon for 3rd XKB group.
  66 .TP
  67 .B Icon4 Filename (mandatory)
  68 XPM file contains an icon for 4th XKB group.
  69 .TP
  70 .B IconBoom Filename (mandatory)
  71 XPM file contains an icon for "broken Xkb". Please look in
  72 BUGS section.
  73 .TP
  74 .B Sound (Yes|No)
  75 \fBfookb\fP will run command from "Command" value (see below), if this
  76 parameter is set to "Yes". You'll receive (non-fatal) error message if
  77 this parameter is not defined. In any other case command will not be
  78 run.
  79 .TP
  80 .B Command command_to_run
  81 This command will be run if XKB locked group is changed and "Sound" is
  82 set to "Yes".
  83
  84 .SH EXAMPLES
  85 Here is an example of configuration file.
  86 .P
  87 .nf
  88 {
  89   Icon1 = "/usr/local/share/fookb/icon1.xpm";
  90   Icon2 = "/usr/local/share/fookb/icon2.xpm";
  91   Icon3 = "/usr/local/share/fookb/icon3.xpm";
  92   Icon4 = "/usr/local/share/fookb/icon4.xpm";
  93   IconBoom = "/usr/local/share/fookb/crash.xpm";
  94   Sound = "Yes";
  95   Command = "/usr/bin/play /usr/local/share/fookb/click.au";
  96 }
  97 .fi
  98
  99 .SH FILES
 100 .TP
 101 .B ~/.fookb
 102 \fBfookb\fP defaults
 103
 104 .SH BUGS
 105 Sometimes \fBfookb\fP receives message about changing XKB group, but
 106 message.state.group does not point to any existing XKB group. In this
 107 case \fBfookb\fP will show IconBoom (from config file) picture.
 108 .P
 109 As far as I know the only way to look at this bug is to run vmware.
 110
 111 .SH VERSION
 112 This man page is [hopefully] up-to-date for version @PACKAGE_VERSION@ of \fBfookb\fP.
 113
 114 .SH AUTHORS
 115 .P
 116 \fBfookb\fP is (c) 1998-2004 Alexey Vyskubov <alexey@mawhrin.net>.
 117 .P
 118 This manpage was written by Alexey Vyskubov <alexey@mawhrin.net>.