« back to all changes in this revision
Viewing changes to bbmail.1
- browse files at revision 1
- compare with another revision
- download diff
- download tarball
- view history from revision 1
- Committer: Bazaar Package Importer
- Author(s): Matt Hope
- Date: 2002-02-02 18:49:55 UTC
- Revision ID: james.westby@ubuntu.com-20020202184955-a0zs49k8711frhqc
Tags: upstream-0.8.2
Import upstream version 0.8.2
- files added:
- data
- scripts
added
removed
bbmail.1
1
.TH "bbmail" "1" "May 14, 2001" "John Kennis" ""
2
.SH "NAME"
3
bbmail \- mailbox flag for X
4
.SH "SYNOPSIS"
5
.B bbmail
6
.RI [ options ]
7
.SH "DESCRIPTION"
8
.B bbmail
9
displays the status of a mailbox and warns when new mail has arrived.
10
It has internal support for mbox and maildir mailboxes.
11
Other mailboxes like MH or pop3 can be checked using an external
12
program.
13
14
The tool is designed to mimic the look and feel of the Blackbox
15
window manager when used in combination with blackbox bbmail copies
16
the style from Blackbox.
17
18
A little picture of an envelope shows if new mail is present.
19
Multiple mailboxes can be defined and different envelope colors
20
are used to indicate new mail.
21
22
If the envelope is pressed with left mouse button a
23
program for example a mail client can be started. When the right
24
button is pressed on the envelope a menu shows up.
25
The menu shows all mailboxes and the new mail/total mail
26
of that mail box.
27
28
Another option in the menu is reconfigure, which causes bbmail
29
to reconfigure (reread the config files).
30
31
32
.SH "Options"
33
.BR bbmail
34
supports the following command line options:
35
.TP
36
.BI \-d " displayname" "\fR,\fP \-\^\-display " displayname
37
Set display to displayname
38
.TP
39
.BI \-c " configname" "\fR,\fP \-\^\-config " configname
40
Read configuration from configname instead of the default.
41
.TP
42
.BR \-v ", " \-\^\-version
43
Display version number of bbmail
44
.TP
45
.BR \-h ", " \-\^\-help
46
Display help on command line options
47
.TP
48
.BI \-g " +x+y" "\fR,\fP \-\^\-geometry" +x+y
49
Set the position of bbmail to x,y. Use +x+y to specify the coordinates
50
relative to the upper left corner,
51
use \-x\-y specify the coordinates relative the lower right corner.
52
This option is ignored when \-withdrawn flag is used.
53
.TP
54
.BR \-d ", " \-\^\-decorated
55
Show bbmail in a normal window with title bar.
56
.TP
57
.BR \-w ", " \-\^\-withdrawn
58
Put bbmail in the blackbox slit or Windowmaker dock.
59
.TP
60
.BR \-s ", " \-\^\-shape
61
Don't display the background of bbmail. This only makes sense in combination
62
with the \-withdrawn flag
63
64
.SH "Configuration"
65
\fBGlobal configuration:\fR By default the configuration file
66
bbmail.bb
67
can be found in /usr/local/share/bbtools
68
\fBLocal configuration:\fR The default configuration file should
69
be placed in ~/.bbtools/
70
71
The following options can be set in the configuration file:
72
.TP
73
.BI bbmail.bevelWidth: " width"
74
Set the width between text label and edge of tool.
75
.TP
76
.BI bbmail.position: " +x+y"
77
Set position of bbmail.
78
.TP
79
.BI bbmail.withdrawn: " boolean"
80
Set to True to put bbmail in the blackbox slit or Windowmaker dock.
81
Default set to false.
82
.TP
83
.BI bbmail.shape: "boolean"
84
Set to True if bbmail shouldn't display its background. This
85
gives a nice effect when withdrawn.
86
Default set to false.
87
.TP
88
.BI bbmail.checkDelay: " seconds"
89
Delay between checks. After delay mailbox file is checked for change.
90
.TP
91
.BI bbmail.forceCheck.onDelay: " seconds"
92
Delay between checks. After delay external program to check mail is
93
executed.
94
.TP
95
.BI bbmail.show.newmail.counter: " boolean"
96
Set to true if bbmail should show the new mail counter.
97
Default set to true.
98
.TP
99
.BI bbmail.show.totalmail.counter: " boolean"
100
Set to true if bbmail should show the total mail counter.
101
Default set to true.
102
.TP
103
.BI bbmail.show.envelope: " boolean"
104
Set to true if bbmail should show envelope which flags new mail.
105
Default set to true
106
.TP
107
.BI bbmail.numberOf.digits: " value"
108
Set the number of digits of the new mail and total mail labels.
109
Default it is set to 2, this makes it fit nicely in the slit.
110
.TP
111
.BI bbmail.show.onlyAtnewmail: " boolean"
112
Set to true if bbmail should only show up when new mail has arrived.
113
Default set to false
114
.TP
115
.BI bbmail.raised: " boolean"
116
.TP
117
.BI bbmail.autoRaise: " boolean"
118
.TP
119
.BI bbmail.pressed.runCommand: " command"
120
The command to run when the envelope is pressed
121
(using the left mouse button).
122
This command is overridden by the newmail command.
123
.TP
124
.BI bbmail.numberOf.mailboxes: " value"
125
Set the number of mailboxes you want to define.
126
If set to 0, the environment variable MAIL is used to find default
127
mailbox.
128
.TP
129
.BI bbmail.mailbox.*.type: " value"
130
Set the type of mailbox to eother mbox, maildir or other.
131
.BI bbmail.mailbox.*.fi lename: " filename"
132
The filename of the mbox file or the directory of maildir
133
.TP
134
.BI bbmail.mailbox.*.name: " name"
135
Name of mailbox, this name is shown in menu.
136
.TP
137
.BI bbmail.mailbox.*.newmail.pressed.runCommand: " command"
138
The command to run when new mail is indicated. If this
139
command is not defined the command defined by
140
bbmail.pressed.runCommand is used.
141
.TP
142
.BI bbmail.mailbox.*.newmail.runCommand: " command"
143
The command to run when new mail is received.
144
Example: cat mail.wav > /dev/dsp
145
.TP
146
.BI bbmail.mailbox.*.newmail.bell: " boolean"
147
If set to true the bell is sound when new mail arrives.
148
.TP
149
.BI bbmail.mailbox.*.newmail: " gradient"
150
Set the gradient of the envelope when new mail is present.
151
Example: Raised Gradient Vertical Bevel1
152
.TP
153
.BI bbmail.mailbox.*.newmail.color: " color"
154
Set the "from" color of the envelope when new mail is present.
155
.TP
156
.BI bbmail.mailbox.*.newmail.colorTo: " color"
157
Set the "to" color of the envelope when new mail is present.
158
.TP
159
.BI bbmail.mailbox.*.newmail.pressed: "gradient"
160
Set the gradient of the envelope when new mail is present and the
161
envelope is pressed.
162
Example: Flat Gradient Vertical Bevel1
163
.TP
164
.BI bbmail.mailbox.*.newmail.textColor: " color"
165
Set the color for the lines in the envelope.
166
.TP
167
.BI bbmail.mailbox.*.newmail.error.textColor: " color"
168
Set color for the error indication in the envelope.
169
.TP
170
.BI bbmail.menu.justify: " justify"
171
Set menu text justify to either CentreJustify, LeftJustify or RightJustify.
172
.TP
173
.BI bbmail.menu.bulletStyle: " bullet style" diamond
174
Set menu bullet style to either diamond
175
.TP
176
.BI bbmail.menu.bulletPosition: " bullet position"
177
Set menu bullet position to either left or right.
178
.TP
179
.BI bbmail.menu: " gradient"
180
Set the gradient of the menu.
181
.TP
182
.BI bbmail.menu.color: " color"
183
Set the "from" color of the menu.
184
.TP
185
.BI bbmail.menu.colorTo: " color"
186
Set the "to" color of the menu.
187
188
189
.B type mbox options
190
191
bbmail.mailbox.1.newmail.statusFlag: " status"
192
Set the status flag which in used in the mbox file to indicate
193
mail is read.
194
Example for Netscape: X\-Mozilla\-Status: [89ABCDEF]
195
196
.B type other options
197
198
.BI bbmail.mailbox.1.mode: " mode"
199
mode: 1\- unread mail total mail
200
2\- unread mail read mail
201
3\- read mail total mail
202
4\- ignore second value (for both proc and reversed proc)
203
.TP
204
.BI bbmail.mailbox.1.proc: " program"
205
The program to run to check for mail, bbmail searches for 2 integers
206
in the output of the program. If none are found an error is reported.
207
Example program MH: flist
208
Example program fetchmail: fetchmail \-c | ~/.bbtools/bbmailparsefm.pl
209
210
211
.SH "BUGS"
212
The config file of bbmail doesn't handle spaces after commands very well.
Loggerhead is a web-based interface for Breezy
Version: 2.0.1