Bug 2389: (followup) Add documentation and fix use case

Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>

Signed-off-by: Barton Chittenden <barton@bywatersolutions.com>

Signed-off-by: Katrin Fischer  <katrin.fischer@bsz-bw.de>

Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
This commit is contained in:
Tomás Cohen Arazi 2016-09-13 14:42:32 -03:00 committed by Kyle M Hall
parent 71454b4263
commit 9e22a9ced3

View file

@ -69,6 +69,7 @@ overdue_notices.pl
-borcat <categorycode> category code that must be included -borcat <categorycode> category code that must be included
-borcatout <categorycode> category code that must be excluded -borcatout <categorycode> category code that must be excluded
-t only include triggered overdues -t only include triggered overdues
--test Run in test mode. No changes will be made on the DB.
-list-all list all overdues -list-all list all overdues
-date <yyyy-mm-dd> emulate overdues run for this date -date <yyyy-mm-dd> emulate overdues run for this date
-email <email_type> type of email that will be used. Can be 'email', 'emailpro' or 'B_email'. Repeatable. -email <email_type> type of email that will be used. Can be 'email', 'emailpro' or 'B_email'. Repeatable.
@ -159,6 +160,13 @@ the cron schedule to ensure proper behavior.
Add the --triggered option for daily cron, at the risk of no notice Add the --triggered option for daily cron, at the risk of no notice
being generated if the cron fails to run on time. being generated if the cron fails to run on time.
=item B<-test>
This option makes the script run in test mode.
In test mode, the script won't make any changes on the DB. This is useful
for debugging configuration.
=item B<-list-all> =item B<-list-all>
Default items.content lists only those items that fall in the Default items.content lists only those items that fall in the
@ -813,7 +821,7 @@ END_SQL
attachments => [$attachment], attachments => [$attachment],
to_address => $admin_email_address, to_address => $admin_email_address,
} }
); ) unless $test_mode;
} }
} }