From 13e006104bf83a3bdb3be16f44908fb1c2670213 Mon Sep 17 00:00:00 2001 From: Thomas Hochstein Date: Wed, 4 Sep 2013 11:53:28 +0200 Subject: [PATCH] Add documentation to parsedb.pl. Signed-off-by: Thomas Hochstein --- bin/parsedb.pl | 33 ++++++++++++++++++++++++++++++--- 1 file changed, 30 insertions(+), 3 deletions(-) diff --git a/bin/parsedb.pl b/bin/parsedb.pl index 1a0fa39..27a9229 100755 --- a/bin/parsedb.pl +++ b/bin/parsedb.pl @@ -258,11 +258,32 @@ See L. =head1 DESCRIPTION -... +This script will parse raw, unstructured headers from a database table which is +fed from F for a given time period and write its results to +nother database table with separate fields (columns) for most (or even all) +relevant headers. + +I, I, I and I will be parsed from MIME +encoded words to UTF-8 as needed while the unparsed copy is kept. From that +parsed copy, I, I and I will also be split into +separate name(s) and address(es) fields while the un-splitted copy is kept, +too. + +B should be run nightly from cron for yesterdays data so all +other scripts get current information. The time period to act on defaults to +yesterday, accordingly; you can assign another time period or a single day via +the B<--day> option (see below). =head2 Configuration -... +B will read its configuration from F +should be present in etc/ via Config::Auto or from a configuration file +submitted by the B<--conffile> option. + +See L for an overview of possible configuration options. + +You can override configuration options via the B<--rawdb> and +B<--parsedb> options, respectively. =head1 OPTIONS @@ -313,7 +334,13 @@ See L. =head1 EXAMPLES -... +An example crontab entry: + + 0 1 * * * /path/to/bin/parsedb.pl + +Do a dry run for yesterday's data, showing results of processing: + + parsedb --debug --test | less =head1 FILES