File: bbmail.1

package info (click to toggle)
bbmail 0.8.3-7
  • links: PTS
  • area: main
  • in suites: stretch
  • size: 784 kB
  • sloc: cpp: 7,307; sh: 3,506; makefile: 83; perl: 26
file content (212 lines) | stat: -rw-r--r-- 6,911 bytes parent folder | download | duplicates (6)
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
.TH "bbmail" "1" "May 14, 2001" "John Kennis" ""
.SH "NAME"
bbmail \- mailbox flag for X
.SH "SYNOPSIS"
.B bbmail 
.RI [ options ]
.SH "DESCRIPTION"
.B bbmail 
displays the status of a mailbox and warns when new mail has arrived.
It has internal support for mbox and maildir mailboxes. 
Other mailboxes like MH or pop3 can be checked using an external
program.

The tool is designed to mimic the look and feel of the Blackbox
window manager when used in combination with blackbox bbmail copies 
the style from Blackbox.

A little picture of an envelope shows if new mail is present.
Multiple mailboxes can be defined and different envelope colors 
are used to indicate new mail.

If the envelope is pressed with left mouse button a
program for example a mail client can be started. When the right
button is pressed on the envelope a menu shows up.
The menu shows all mailboxes and the new mail/total mail 
of that mail box.

Another option in the menu is reconfigure, which causes bbmail 
to reconfigure (reread the config files).


.SH "Options"
.BR bbmail 
supports the following command line options:
.TP 
.BI \-d " displayname" "\fR,\fP \-\^\-display " displayname
Set display to displayname
.TP 
.BI \-c " configname" "\fR,\fP \-\^\-config " configname
Read configuration from configname instead of the default.
.TP 
.BR \-v ", " \-\^\-version
Display version number of bbmail
.TP 
.BR \-h ", " \-\^\-help
Display help on command line options
.TP 
.BI \-g " +x+y" "\fR,\fP \-\^\-geometry" +x+y
Set the position of bbmail to x,y. Use +x+y to specify the coordinates 
relative to the upper left corner,
use \-x\-y specify the coordinates relative the lower right corner.
This option is ignored when \-withdrawn flag is used.
.TP 
.BR \-d ", " \-\^\-decorated
Show bbmail in a normal window with title bar.
.TP 
.BR \-w ", " \-\^\-withdrawn
Put bbmail in the blackbox slit or Windowmaker dock.
.TP 
.BR \-s ", " \-\^\-shape
Don't display the background of bbmail. This only makes sense in combination 
with the \-withdrawn flag

.SH "Configuration"
\fBGlobal configuration:\fR By default the configuration file
bbmail.bb 
can be found in /usr/local/share/bbtools
\fBLocal configuration:\fR The default configuration file should 
be placed in ~/.bbtools/

The following options can be set in the configuration file:
.TP 
.BI bbmail.bevelWidth: "  width"
Set the width between text label and edge of tool.
.TP 
.BI bbmail.position: "  +x+y"
Set position of bbmail.
.TP 
.BI bbmail.withdrawn: " boolean"
Set to True to put bbmail in the blackbox slit or Windowmaker dock.
Default set to false.
.TP 
.BI bbmail.shape: "boolean"
Set to True if bbmail shouldn't display its background. This
gives a nice effect when withdrawn.
Default set to false.
.TP 
.BI bbmail.checkDelay: " seconds"
Delay between checks. After delay mailbox file is checked for change.
.TP 
.BI bbmail.forceCheck.onDelay: " seconds"
Delay between checks. After delay external program to check mail is
executed.
.TP 
.BI bbmail.show.newmail.counter: " boolean"
Set to true if bbmail should show the new mail counter.
Default set to true.
.TP 
.BI bbmail.show.totalmail.counter: " boolean"
Set to true if bbmail should show the total mail counter.
Default set to true.
.TP 
.BI bbmail.show.envelope: " boolean"
Set to true if bbmail should show envelope which flags new mail.
Default set to true
.TP 
.BI bbmail.numberOf.digits:	" value"
Set the number of digits of the new mail and total mail labels.
Default it is set to 2, this makes it fit nicely in the slit.
.TP 
.BI bbmail.show.onlyAtnewmail: " boolean"
Set to true if bbmail should only show up when new mail has arrived.
Default set to false
.TP 
.BI bbmail.raised: " boolean"
.TP 
.BI bbmail.autoRaise: " boolean"
.TP 
.BI bbmail.pressed.runCommand:	" command"
The command to run when the envelope is pressed 
(using the left mouse button).
This command is overridden by the newmail command.
.TP 
.BI bbmail.numberOf.mailboxes:	" value"
Set the number of mailboxes you want to define.
If set to 0, the environment variable MAIL is used to find default
mailbox.
.TP 
.BI bbmail.mailbox.*.type: " value"
Set the type of mailbox to eother mbox, maildir or other.
.BI bbmail.mailbox.*.fi lename: " filename"
The filename of the mbox file or the directory of maildir
.TP 
.BI bbmail.mailbox.*.name: " name"
Name of mailbox, this name is shown in menu.
.TP 
.BI bbmail.mailbox.*.newmail.pressed.runCommand: " command"
The command to run when new mail is indicated. If this
command is not defined the command defined by 
bbmail.pressed.runCommand is used.
.TP 
.BI bbmail.mailbox.*.newmail.runCommand: " command"
The command to run when new mail is received.
Example: cat mail.wav > /dev/dsp
.TP 
.BI bbmail.mailbox.*.newmail.bell: " boolean"
If set to true the bell is sound when new mail arrives.
.TP 
.BI bbmail.mailbox.*.newmail: " gradient"
Set the gradient of the envelope when new mail is present.
Example: Raised Gradient Vertical Bevel1
.TP 
.BI bbmail.mailbox.*.newmail.color: " color"
Set the "from" color of the envelope when new mail is present.
.TP 
.BI bbmail.mailbox.*.newmail.colorTo: " color"
Set the "to" color of the envelope when new mail is present.
.TP 
.BI bbmail.mailbox.*.newmail.pressed: "gradient"
Set the gradient of the envelope when new mail is present and the 
envelope is pressed.
Example: Flat Gradient Vertical Bevel1
.TP 
.BI bbmail.mailbox.*.newmail.textColor:	" color"
Set the color for the lines in the envelope.
.TP 
.BI bbmail.mailbox.*.newmail.error.textColor:  " color"
Set color for the error indication in the envelope.
.TP 
.BI bbmail.menu.justify:  " justify"
Set menu text justify to either CentreJustify, LeftJustify or RightJustify.
.TP 
.BI bbmail.menu.bulletStyle:  " bullet style"	diamond
Set menu bullet style to either diamond 
.TP 
.BI bbmail.menu.bulletPosition:	" bullet position"
Set menu bullet position to either left or right.
.TP 
.BI bbmail.menu: " gradient"
Set the gradient of the menu.
.TP 
.BI bbmail.menu.color:	" color"
Set the "from" color of the menu.
.TP 
.BI bbmail.menu.colorTo: " color"
Set the "to" color of the menu.


.B type mbox options

bbmail.mailbox.1.newmail.statusFlag:  " status"
Set the status flag which in used in the mbox file to indicate
mail is read.
Example for Netscape: X\-Mozilla\-Status: [89ABCDEF]

.B type other options

.BI bbmail.mailbox.1.mode: " mode"
mode:  1\- unread mail  total mail
       2\- unread mail  read mail
       3\- read mail    total mail
       4\- ignore second value (for both proc and reversed proc)
.TP 
.BI bbmail.mailbox.1.proc: " program"
The program to run to check for mail, bbmail searches for 2 integers
in the output of the program. If none are found an error is reported.
Example program MH: flist
Example program fetchmail:  fetchmail \-c | ~/.bbtools/bbmailparsefm.pl


.SH "BUGS"
The config file of bbmail doesn't handle spaces after commands very well.