File: barrendero.1

package info (click to toggle)
barrendero 1.0-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 96 kB
  • ctags: 2
  • sloc: sh: 329; makefile: 58
file content (125 lines) | stat: -rw-r--r-- 2,651 bytes parent folder | download
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
.TH BARRENDERO 1 "Version 0.1: 15 Feb 99"
.SH NAME
barrendero \- A mail spool directory cleaner
.SH SYNOPSIS
.br
.B "barrendero [-V]"
.br
.B "barrendero [-u] [-cconfig_file] [-f folder] [-n]"


.SH DESCRIPTION
.I Barrendero
is a program designed to clean the mail spool directory to free disk space. It does this by looking in every mail folder in the spool dir and deleting the messages older than a certain age. The users can get a mail with the report of the actions done in their folders, consisting on a extract of the headers of the messages deleted and the messages soon to be deleted. 
.br

.SH OPTIONS
.I -u
Force to process a folder even if it does not belong to a user.
.br
.br
.I -cconfig_file
Use this config file instead of /etc/barrendero.conf
.br
.br
.I -ffolder
Not yet implemented. Maybe on version 1.1 :-)
.br
.br
.I -n
Do not read any config file.
.br
.I -V
Print some info about the program (version, copyright) and quit.
.br
.br
.br
.SH CONFIG FILE
Most of the default options are hard-coded in the program. There is necesary to edit the code to customize the way it works.

The trigger age can be configured individually for each user, via a config file. This file has the following format:

.RS
.br 
#Lines begining with a hash are comments.
.br 
#Spool dir       
.br 
SPOOLDIR=/var/spool/mail;
.br 
#Warning age
.br 
WARNAGE=15;
.br 
#Delete age
.br 
DELAGE=20;
.br 
#Admin (who has to receive the general report)
.br 
ADMIN=admin@mymachine.com;
.br 
.br
#Set the debug level
.br
DEBUG=3
.br 
#Default languaje for reports
.br 
LANG=es;
.br 
#Send mail reports (1) or not to send them (0)
.br 
MAILREPORTS=1;
.br 
#Make backups of the mail folders?
.br 
# 0->No
.br 
# 1->Save the whole unmodified folder
.br 
# 2->Just save the deleted messages
.br 
MAKEBACKUP=2;
.br 

.br 
#Where to put the messages saved
.br 
SAVEDIR="/tmp";
.br 

#Folders smaller than this will not be inspected (size in bytes)
.br 
TRIGGERSIZE=300000;

.br 
.br 
#User            Warning   Delete  Lang  Trigger
.br
joe              30        35      es    120000
.br
#Other user than must be untouched!
.br
foo              99999      99999  en    9999999999
.RE

.SH WARNINGS
.br
The use of this program is a bit dangerous. Please inspect the code before
leting it delete your mail! The author accepts no responsability. I am personally using this program, but it may fail for you.

.SH BUGS
.br
Hey! This is version 1.0. ;-)) (you know, bug-free).
.br
If you find any bug, report it to the author.

.SH COPYRIGHT
.br
Copyright (c) Eduardo Diaz Comellas 
.br
This program is distributed under the GNU license. 
.br
Comments to: ediaz@tsc.uvigo.es