Fix typos
[sven/pflogsumm.git] / README
1
2 Pflogsumm README
3
4 There's not much to installing pflogsumm, so it's all manual.
5
6     1. Unpack the distribution (if you're reading this, you've already
7        gotten that far)
8
9     2. Copy or move pflogsumm.pl to some directory from which you'll
10        want to execute it.  Maybe rename it to just "pflogsumm."
11        Watch the ownerships and permissions.  Make sure it's executable.
12
13        E.g.:
14
15             cp pflogsumm.pl /usr/local/bin/pflogsumm
16             chown bin:bin /usr/local/bin/pflogsumm
17             chmod 755 /usr/local/bin/pflogsumm
18
19     3. If there's a manual page available (pflogsumm.1), copy that to
20        /usr/local/man/man1 or wherever you stash local manpages.  Make
21        sure it's world-readable.
22
23        E.g.:
24
25             cp pflogsumm.1 /usr/local/man/man1/pflogsumm.1
26             chown bin:bin /usr/local/man/man1/pflogsumm.1
27             chmod 644 /usr/local/man/man1/pflogsumm.1
28
29     4. Read the man page (or the top of pflogsumm itself) for usage.
30
31     5. Check the FAQ (pflogsumm-faq.txt)
32
33     6. Configure your cron jobs if you're going to run pflogsumm on an
34        automatic, scheduled basis.  There are tips in the manpage and
35        the FAQ.
36
37 That's about it.
38
39 As the manpage and FAQ both note: pflogsumm requires the Date::Calc
40 Perl module if you want to use --smtpd_stats.
41