[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

r10289 - /man-cgi/extractor/README

Author: jfs
Date: Wed Oct 30 01:22:47 2013
New Revision: 10289

URL: http://svn.debian.org/wsvn/?sc=1&rev=10289
Update the README using the 'config' script and document how does the cronjob need to be setup


Modified: man-cgi/extractor/README
URL: http://svn.debian.org/wsvn/man-cgi/extractor/README?rev=10289&op=diff
--- man-cgi/extractor/README	(original)
+++ man-cgi/extractor/README	Wed Oct 30 01:22:47 2013
@@ -5,10 +5,10 @@
 This extractor should be used to build a manpages' pool for the man.cgi script.
 These are the steps to extract the manpages, you can execute them directly by
-first editing the generate-manpages-archive.sh script (adapt the variables
-to the local installation)and then run it.
+first editing the variables in the 'config' file (adapt the variables to 
+your local installation) and then running the generate-manpages-archive.sh script.
-This is how it works:
+This is how the script works:
 - First run manpage-extractor.pl by pointing it to a local mirror (on disk). It
   will generate a 'manpages-files' directory with all the available manpages.
@@ -28,19 +28,33 @@
 - The 'generate-indexes.sh' script will generate 'apropos' indexes that
   the man CGI script will use to do searchs. It just calls man -k for
-  all the different releases.  
+  all the different releases availble.
   NOTE: It does not do this for the different languages that might be
 These scripts should be run manually at least once and the periodically
-through cron to update the manpages contents.
+through cron to update the manpages contents. 
-There's no script that will clean up old manpages, so be careful as you might
-end up consuming large amounts of space if you don't cleanup and regenerate the
-'manpages-files' subdirectory.
+A sample cron entry would be the following:
+(the location of the script needs to be adjusted)
+0 3 1 * * /srv/manpages.debian.org/extractor/generate-manpages-archive.sh
+In addition, you can run the 'count-manpages-archive.sh' script to count the
+number of manpages available (to make sure that the name increases and not
+Please notice that there's no script that will clean up old manpages, so be
+careful as you might end up consuming large amounts of space if you don't
+cleanup and regenerate the 'manpages-files' subdirectory from time to time.
+This is specially the case if you extract manpages from 'unreleased' releases
+(sid, testing). 
 Javier Fernandez-Sanguino <jfs@debian.org>
-Thu, 30 Aug 2007 01:29:41 +0200
+Wed, 30 Oct 2013 02:15:28 +0100

Reply to: