add perldoc for update_totalissues.pl

diff --git a/en/manual.xml b/en/manual.xml
index 5564ffb..82c06e5 100644 (file)
--- a/en/manual.xml
+++ b/en/manual.xml
@@ -39754,6 +39754,62 @@ print theme('pages_catalog');</programlisting>
           database with the latest tally of checkouts.</para>
 
           <para>Frequency suggestion: nightly</para>
+          <section id="updateissuesperldoc">
+            <title>Perl Documentation</title>
+            <para><emphasis role="bold">NAME</emphasis>
+            </para>
+            <para>update_totalissues.pl </para>
+            <para><emphasis role="bold">SYNOPSIS</emphasis>
+            </para>
+            <para>update_totalissues.pl --use-stats </para>
+            <para>update_totalissues.pl --use-items </para>
+            <para>update_totalissues.pl --commit=1000 </para>
+            <para>update_totalissues.pl --since='2012-01-01' </para>
+            <para>update_totalissues.pl --interval=30d </para>
+            <para><emphasis role="bold">DESCRIPTION</emphasis>
+            </para>
+            <para>This batch job populates bibliographic records' total issues count based on
+              historical issue statistics. </para>
+            <para>--help Prints this help </para>
+            <para>-v|--verbose </para>
+            <para>Provide verbose log information (list every bib modified). </para>
+            <para>--use-stats </para>
+            <para>Use the data in the statistics table for populating total issues. </para>
+            <para>--use-items </para>
+            <para>Use items.issues data for populating total issues. Note that issues data from the
+              items table does not respect the --since or --interval options, by definition. Also
+              note that if both --use-stats and --use-items are specified, the count of biblios
+              processed will be misleading. </para>
+            <para>-s|--since=DATE </para>
+            <para>Only process issues recorded in the statistics table since DATE. </para>
+            <para>-i|--interval=S </para>
+            <para>Only process issues recorded in the statistics table in the last N units of time.
+              The interval should consist of a number with a one- letter unit suffix. The valid
+              suffixes are h (hours), d (days), w (weeks), m (months), and y (years). The default
+              unit is days. </para>
+            <para>--incremental </para>
+            <para>Add the number of issues found in the statistics table to the existing total
+              issues count. Intended so that this script can be used as a cron job to update
+              popularity information during low-usage periods. If neither --since or --interval are
+              specified, incremental mode will default to processing the last twenty-four hours. </para>
+            <para>--commit=N </para>
+            <para>Commit the results to the database after every N records are processed. </para>
+            <para>--test </para>
+            <para>Only test the popularity population script. </para>
+            <para><emphasis role="bold">WARNING</emphasis>
+            </para>
+            <para>If the time on your database server does not match the time on your Koha server
+              you will need to take that into account, and probably use the --since argument instead
+              of the --interval argument for incremental updating. </para>
+            <para><emphasis role="bold">CREDITS</emphasis>
+            </para>
+            <para>This patch to Koha was sponsored by the Arcadia Public Library and the Arcadia
+              Public Library Foundation in honor of Jackie Faust-Moreno, late director of the
+              Arcadia Public Library. </para>
+            <para><emphasis role="bold">AUTHOR</emphasis>
+            </para>
+            <para>Jared Camins-Esakov &lt;jcamins AT cpbibliography DOT com></para>
+          </section>
         </section>
       </section>