[Koha-bugs] [Bug 11344] New: Perldoc issues in misc/cronjobs/advance_notices.pl

[bugzilla-daemon at bugs.koha-community.org]

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=11344

            Bug ID: 11344
           Summary: Perldoc issues in misc/cronjobs/advance_notices.pl
 Change sponsored?: ---
           Product: Koha
           Version: master
          Hardware: All
                OS: All
            Status: NEW
          Severity: enhancement
          Priority: P5 - low
         Component: Command-line Utilities
          Assignee: gmcharlt at gmail.com
          Reporter: bartonski at gmail.com
        QA Contact: testopia at bugs.koha-community.org

perldoc misc/cronjobs/advance_notices.pl shows the following:

NAME
       advance_notices.pl - cron script to put item due reminders into message
queue

SYNOPSIS
       ./advance_notices.pl -c

       or, in crontab: 0 1 * * * advance_notices.pl -c

DESCRIPTION
       This script prepares pre-due and item due reminders to be sent to
patrons. It queues them in the message queue, which is processed by the
process_message_queue.pl cronjob. The type and timing
       of the messages can be configured by the patrons in their "My Alerts"
tab in the OPAC.

NAME
       advance_notices.pl - prepare messages to be sent to patrons for nearly
due, or due, items

SYNOPSIS
       advance_notices.pl
         [ -n ][ -m <number of days> ][ --itemscontent <comma separated field
list> ][ -c ]

OPTIONS
       --help  Print a brief help message and exits.

       --man   Prints the manual page and exits.

       -v      Verbose. Without this flag set, only fatal errors are reported.

       -n      Do not send any email. Advanced or due notices that would have
been sent to the patrons are printed to standard out.

       -m      Defines the maximum number of days in advance to send advance
notices.

       --itemscontent
               comma separated list of fields that get substituted into
templates in places of the <<items.content>> placeholder. This defaults to due
date,title,author,barcode

               Other possible values come from fields in the biblios, items and
issues tables.

DESCRIPTION
       This script is designed to alert patrons when items are due, or coming
due

...


===============================================

Issues:

NAME
SYNOPSIS
DESCRIPTION

Occur twice. The sections are not duplicates. One version should be chosen for
each section.

-c (Confirm that the user has read and configured this script.) is not
documented in OPTIONS.

Here are the comments where $confirm is defined, as well as the call to
GetOptions:

   161  # These are defaults for command line options.
   162  my $confirm;                                                        #
-c: Confirm that the user has read and configured this script.
   163  # my $confirm     = 1;                                                #
-c: Confirm that the user has read and configured this script.
   164  my $nomail;                                                         #
-n: No mail. Will not send any emails.
   165  my $mindays     = 0;                                                #
-m: Maximum number of days in advance to send notices
   166  my $maxdays     = 30;                                               #
-e: the End of the time period
   167  my $verbose     = 0;                                                #
-v: verbose
   168  my $itemscontent = join(',',qw( date_due title author barcode ));
   169  
   170  my $help    = 0;
   171  my $man     = 0;
   172  
   173  GetOptions(
   174              'help|?'         => \$help,
   175              'man'            => \$man,
   176              'c'              => \$confirm,
   177              'n'              => \$nomail,
   178              'm:i'            => \$maxdays,
   179              'v'              => \$verbose,
   180              'itemscontent=s' => \$itemscontent,
   181         )or pod2usage(2);
   182  pod2usage(1) if $help;
   183  pod2usage( -verbose => 2 ) if $man;;

-- 
You are receiving this mail because:
You are watching all bug changes.