r11112 - /man-cgi/INSTALL
Author: jfs
Date: Sun Apr 17 15:56:30 2016
New Revision: 11112
URL: http://svn.debian.org/wsvn/?sc=1&rev=11112
Log:
Update the INSTALL instruccions
Modified:
man-cgi/INSTALL
Modified: man-cgi/INSTALL
URL: http://svn.debian.org/wsvn/man-cgi/INSTALL?rev=11112&op=diff
==============================================================================
--- man-cgi/INSTALL (original)
+++ man-cgi/INSTALL Sun Apr 17 15:56:30 2016
@@ -1,6 +1,6 @@
This is a simple INSTALL description of how to setup a
-manpages.debian.org server.
+manpages.debian.org server with the CGI script in this directory
The man.cgi script serves manpages that have been previously extracted from a
local Debian mirror, in order to set it up you need to take the following
@@ -49,13 +49,17 @@
------------------------------------------------------------------------
Notice that there are rewriting rules in place so that users can directly go
- to http://manpages.debian.org/man/1/bash or
- http://manpages.debian.org/man/bash. In both cases users are redirect to the
- latest Debian manpages (i.e. Sid's)
+ to
+ http://manpages.debian.org/man/1/bash
+ http://manpages.debian.org/man/bash
+ http://manpages.debian.org/1/bash
+
+ In all of these cases users are redirected to the latest Debian manpages
+ (i.e. Sid's)
-- Install the man.cgi script in your server's CGI directory. This will
- typically be /usr/lib/cgi-bin/
+- Install the man.cgi script in your server's CGI directory. This can
+ be the cgi-bin of your ApacheRoot configuration
(unless you setup a different location for the manpages.debian.org
vhost cgis)
@@ -63,6 +67,35 @@
the manpages where extracted.
Make sure the man.cgi script is executable
+
+- Install the man.cgi script dependencies. Currently the script requires:
+
+ * (mandatory) CGI
+ Available at http://search.cpan.org/~lds/CGI.pm-3.43/CGI.pm
+
+ * (optional) CGI::Cache and its dependencies (such as Tie::Restore)
+ Available at http://search.cpan.org/~dcoppit/CGI-Cache-1.4207/lib/CGI/Cache.pm
+
+ These dependencies can be installed either in the server's location for
+ Perl libraries (/usr/local/share/perl/) or in a library directory that the
+ man.CGI will source
+
+- Test the CGI by running it from the command line like this:
+
+----------------------------------------
+$ perl -T man.cgi
+(offline mode: enter name=value pairs on standard input; press ^D or ^Z when done)
+query=test
+[ press ^D, after this the script should provide the HTTP headers and HTML content]
+Date: Sun, 17 Apr 2016 15:53:57 GMT
+Content-Type: text/html; charset=ISO-8859-1
+
+<HTML>
+<HEAD>
+
+(...)
+----------------------------------------
+
- Install a simple index.html script that redirects to the manpage interface
in the server's document root. This is useful for people that go to
Reply to: