File: bulletin-expire.1

package info (click to toggle)
maildir-bulletin 0.66
  • links: PTS
  • area: main
  • in suites: woody
  • size: 160 kB
  • ctags: 50
  • sloc: cpp: 734; sh: 157; makefile: 73
file content (59 lines) | stat: -rw-r--r-- 1,877 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
.TH bulletin-expire 1 
.SH NAME
bulletin-expire \- remove bulletins created by maildir-bulletin

.SH SYNOPSIS
.B bulletin-expire
.I [files]

.SH DESCRIPTION
This program is used to expire bulletins created by the
.B maildir-bulletin
program. It is designed to be run as root, but if root isn't the adminsitrative
account for email then it could be run as another user. For example if you
have all mail storage as user
.B mail
then you should probable run this program as user
.B mail
too.
.P

.SH PARAMETERS
The default mode of operation is to check the expiry time set in the bulletins
and after removing all links to a bulletin file it will move the bulletin to
the
.B removed
subdirectory of the bulletins directory.
.P
If you specify one or more file names on the command line then it will process
them instead, however if you specify the files it will not move the files it
will just remove links to them.

.SH FILES
.TP
.I /var/log/bulletin.log /var/log/bulletin.err
logs.

.SH DIRECTORIES
.TP
.I /var/lib/maildir-bulletin
The main directory for config files.
.TP
.I /var/lib/maildir-bulletin/tmp
Temporary directory for sed input - do not make this a link to /tmp, it must
be a directory that is only writable by root.
.TP
.I /var/lib/maildir-bulletin/bulletins
Where the bulletin files are stored.

.SH BUGS
If the expiry date contains a month greater than 12 or a day greater than the number of
days in the month this won't be taken as an error. Month 13 means that it won't
expire until the next year, day 32 means it won't expire until the next month.
Maybe someone will consider this a feature.

.SH AUTHOR
This program, it's manual page, and the Debian package were written by
Russell Coker <russell@coker.com.au> while under contract to Cap Gemini.
I had to re-write their bulletin program anyway so it made sense to do it
properly and release it as open source.