sendmailanalyzer/doc/sa_cache.pod
2020-08-12 09:07:31 +02:00

62 lines
2.3 KiB
Text

=head1 NAME
sa_cache - a SendmailAnalyzer cache report builder
=head1 DESCRIPTION
This program is used to build cache files for all reports generated by
SendmailAnalyzer. It must be run to enable report of week, months and years
views.
=head1 USAGE
Usage: sa_cache [-s hostname] [-c conf_file] [-d yyyy/mm]
This script generate cache statistics for past months and year until now.
Using the --actual-day-only will compute statstics for the current day only
-c | --config file : Path to sendmailanalyzer configuration file. Default
to /usr/local/sendmailanalyzer/sendmailanalyzer.conf.
-d | --date "yyyy/mm" : year/month cache to proceed. Default is all.
-h | --help : Show this message.
-s | --syslog host : syslog name of the host to proceed. Default all.
-a | --actual-day-only: Proceed only the current day, this option replace the
old and obsolete day_cache script. You still have to
run it often like each five minutes.
Setup a cronjob to run sa_cache and restart SendmailAnalyzer daemon after the
log file rotation as follow:
# SendmailAnalyzer log reporting daily cache
0 1 * * * /usr/local/sendmailanalyzer/sa_cache > /dev/null 2>&1
# On huge MTA you may want to have five minutes caching
#*/5 * * * * /usr/local/sendmailanalyzer/sa_cache -a > /dev/null 2>&1
=head1 AUTHOR
Gilles Darold <gilles @nospam@ darold.net>
=head1 COPYRIGHT
Copyright (c) 2002-2020 Gilles Darold - All rights reserved.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see < http://www.gnu.org/licenses/ >.
=head1 BUGS
Your volontee to help construct a better software by submitting bug report or
feature request as well as code contribution are welcome.