Disable quilt.
[mspang/vmailman.git] / contrib / README.mmdsr
1 Daily Status Report script...
2
3 The mmdsr script was created by Brad Knowles to produce a daily status report
4 for mailman.  It was initially posted at
5 <http://sourceforge.net/tracker/index.php?func=detail&aid=1123383&group_id=103&atid=300103>
6 which see for possible patches and other enhancements.
7
8 Here goes the original mmdsr.readme by Brad ...
9
10 ========================================================================
11 This is a basic Bourne shell script that I quickly hacked together for
12 my own purposes, designed to be fired off at 23:59 every night, going
13 through a variety of Mailman log files looking for entries specific
14 to that date, summarizing the activities, and indicating problems or
15 certain types of activity that might be of interest to someone trying
16 to administer the server.
17
18 It also does an "ls -la" of /usr/local/mailman/qfiles/*, so that you
19 can see what is in the queue at the time of the execution of the script.
20
21 This daily report will get e-mailed to the admin, or posted to a "reports"
22 mailing list, where they can be archived and kept for future reference.
23 If you don't define an address where the output e-mail should be sent,
24 it will instead be printed to the standard output (thus allowing you to
25 do something else with it).
26
27
28 Once I'd gone through a few revisions of my own on this tool, I
29 thought that I would release the code to the public and get comments
30 and suggestions from others in the Mailman community.  This program is
31 currently being used actively on the mail servers for python.org (where
32 the mailman-users and other Mailman-related mailing lists are hosted),
33 as well as many others.
34
35 Note that this script needs to be configured once to know where standard
36 commands are located, where log files are kept, etc... (see the top
37 500 lines or so of the script), but after that you don't need to feed
38 it any input, or capture the output to be sent anywhere.  This script
39 takes care of all of that.  All you should need to do is to call this
40 script from a cron job at 23:59 (local time) every night.
41
42
43 When looking at this script, perhaps during configuration, please keep
44 in mind that it is heavily commented at the top, and everything should
45 hopefully be self-evident.