File: fookb.1x

package info (click to toggle)
fookb 2.21-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 360 kB
  • ctags: 49
  • sloc: ansic: 567; makefile: 85; sh: 44
file content (145 lines) | stat: -rw-r--r-- 4,011 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
.\" Copyright (c) 1999, 2000, 2001 Alexey Vyskubov <alexey@pepper.spb.ru>
.\"
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the Artistic License
.\" This manual is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.TH fookb 1 "17 Mar 2001" "fookb" "FOOcrosoft"
.SH NAME
fookb \- Xkb state indicator with optional Window Maker support
.SH SYNOPSIS
.B fookb [options]

.SH DESCRIPTION
\fBfookb\fP is a Xkb state indicator. It displays
the icon corresponding to the number of Xkb locked group. You may use
mouse-clicks to change Xkb locked group with mouse. Additionally,
\fBfookb\fP can be configured to execute a program on changing group.
.P
\fBfookb\fP man page is based on \fBWMMail.app\fP man page. Program
was written from scratch.
.P
To use \fBfookb\fP with the Window Maker Dock, simply drag the
\fBfookb\fP icon to the Window Maker Dock (if \fBfookb\fP was compiled 
with Window Maker support).

.SH OPTIONS
.TP
NB! Command line parameters take precedence over config file or X resources!
.TP
.B -icon1
.TP
.B -icon2
.TP
.B -icon3
.TP
.B -icon4
.TP
.B -iconboom
.TP
.B -display

.SH CONFIGURATION FILE (for libPropList-enabled version)
The configuration file consist of a single PropList dictionary, which
in turn is composed of several PropList key\-value pairs. The
recognized keys is:
.TP
.B Icon1 Filename (mandatory)
XPM file contains an icon (48x48) for 1st XKB group.
.TP
.B Icon2 Filename (mandatory)
XPM file contains an icon (48x48) for 2nd XKB group.
.TP
.B Icon3 Filename (mandatory)
XPM file contains an icon (48x48) for 3rd XKB group.
.TP
.B Icon4 Filename (mandatory)
XPM file contains an icon (48x48) for 4th XKB group.
.TP
.B IconBoom Filename (mandatory)
XPM file contains an icon (48x48) for "broken Xkb". Please look in
BUGS section.
.TP
.B Sound (Yes|No)
\fBfookb\fP will run command from "Command" value (see below), if this 
parameter is set to "Yes". You'll receive (non-fatal) error message if 
this parameter is not defined. In any other case command will not be
run.
.TP
.B Command command_to_run
This command will be run if XKB locked group is changed and "Sound" is 
set to "Yes".

.SH X resources
.TP
NB! Parameters in PropList config file take precednece over X resources!
.TP
.B fookb.icon1 Filename
.TP
.B fookb.icon2 Filename
.TP
.B fookb.icon3 Filename
.TP
.B fookb.icon4 Filename
.TP
.B fookb.iconBoom Filename
.TP
.B fookb.sound Yes/No
.TP
.B fookb.command Command

.SH EXAMPLES
Here is an example of configuration file.
.P
.nf
{
  Icon1 = "/usr/local/share/fookb/icon1.xpm";
  Icon2 = "/usr/local/share/fookb/icon2.xpm";
  Icon3 = "/usr/local/share/fookb/icon3.xpm";
  Icon4 = "/usr/local/share/fookb/icon4.xpm";
  IconBoom = "/usr/local/share/fookb/crash.xpm";
  Sound = "Yes";
  Command = "/usr/bin/play /usr/local/share/fookb/click.au";
}
.fi

Here is an example of app-defaults file.
.P
.nf
fookb.icon1: /usr/local/share/fookb/icon1.xpm
fookb.icon2: /usr/local/share/fookb/icon2.xpm
fookb.icon3: /usr/local/share/fookb/icon3.xpm
fookb.icon4: /usr/local/share/fookb/icon4.xpm
fookb.iconBoom: /usr/local/share/fookb/crash.xpm
fookb.sound: Yes
fookb.command: /home/bgates/bin/playmssound
.fi

.SH FILES
.TP
.B ~/GNUstep/Defaults/FOOkb
\fBfookb\fP defaults (for Window Maker enabled version).
.TP
.B ~/.fookb
\fBfookb\fP defaults (for Window Maker disabled version).

.SH BUGS
Sometimes \fBfookb\fP receives message about changing XKB group, but
message.state.group does not point to any existing XKB group. In this
case \fBfookb\fP will show IconBoom (from config file) picture.
.P
As far as I know the only way to look at this bug is run vmware.

.SH VERSION
This man page is up-to-date for version 2.13 of \fBfookb\fP.

.SH AUTHORS
.P
\fBfookb\fP is (c) 1998, 99, 2000, 20001 Alexey Vyskubov <alexey@pepper.spb.ru>.
.P
This manpage was written by Alexey Vyskubov <alexey@pepper.spb.ru>.