move detailed setup documentation to interface modules
authorMischa POSLAWSKY <perl@shiar.org>
Mon, 17 Mar 2008 19:02:45 +0000 (20:02 +0100)
committerMischa POSLAWSKY <perl@shiar.org>
Tue, 18 Mar 2008 05:33:20 +0000 (05:33 +0000)
Only keep basic instructions for Lighttpd+mod_fastcgi and
Apache+mod_perl in PLP's main synopsis. Other configurations is given in
the pods of interface modules. These are linked at PLP#DESCRIPTION,
which now also contains an overview of supported servers.

Mod_perl configuration variables have also been moved into PLP::Apache.
In all, makes the main documentation much cleaner (uncluttered with
interface-specific details).

PLP.pm
PLP/Apache.pm
PLP/CGI.pm
PLP/FastCGI.pm

diff --git a/PLP.pm b/PLP.pm
index 5899af3b6378c87770bfa946d33204f8b654cd41..e5988c6e1da767c52cb045ef0c1bcd77db8fdbf4 100644 (file)
--- a/PLP.pm
+++ b/PLP.pm
@@ -256,47 +256,30 @@ PLP - Perl in HTML pages
 
 =head1 SYNOPSIS
 
-=head2 mod_perl installation
+=head2 Lighttpd installation
 
-=over 10
+F<lighttpd.conf> configuration using L<mod_fastcgi|PLP::FastCGI>:
+
+    server.modules = (
+        "mod_fastcgi",
+    )
+    fastcgi.server = (
+        ".plp" => ((
+                    "bin-path" => "/usr/bin/perl -MPLP::FastCGI",
+                    "socket" => "/tmp/fcgi-plp.socket",
+                  )),
+    )
+
+=head2 Apache installation
 
-=item * httpd.conf (for mod_perl setup)
+F<httpd.conf> for a L<mod_perl|PLP::Apache> setup:
 
     <Files *.plp>
         SetHandler perl-script
         PerlHandler PLP::Apache
         PerlSendHeader On
-        PerlSetVar PLPcache On
     </Files>
 
-    # Who said CGI was easier to set up? :)
-
-=back
-
-=head2 CGI installation
-
-=over 10
-
-=item * /foo/bar/plp.cgi (local filesystem address)
-
-    #!/usr/bin/perl
-    use PLP::CGI;
-    PLP::CGI::everything();
-
-=item * httpd.conf (for CGI setup)
-
-    ScriptAlias /foo/bar/ /PLP_COMMON/
-    <Directory /foo/bar/>
-        AllowOverride None
-        Options +ExecCGI
-        Order allow,deny
-        Allow from all
-    </Directory>
-    AddHandler plp-document plp
-    Action plp-document /PLP_COMMON/plp.cgi
-
-=back
-
 =head2 Test script (test.plp)
 
     <html><body>
@@ -309,8 +292,28 @@ PLP - Perl in HTML pages
 
 PLP is yet another Perl embedder, primarily for HTML documents. Unlike with
 other Perl embedders, there is no need to learn a meta-syntax or object
-model: one can just use the normal Perl constructs. PLP runs under mod_perl
-for speeds comparable to those of PHP, but can also be run as a CGI script.
+model: one can just use the normal Perl constructs. PLP runs under
+L<mod_perl|PLP::Apache> and L<FastCGI|PLP::FastCGI> for speeds comparable
+to those of PHP, but can also be run as a standard L<CGI|PLP::CGI> script.
+
+=head2 Setup
+
+See either L<CGI|PLP::CGI>, L<FastCGI|PLP::FastCGI> or L<Apache|PLP::Apache>.
+At least the following servers are supported:
+
+=over 10
+
+=item Lighttpd
+
+With L<mod_fastcgi|PLP::FastCGI> or L<mod_cgi|PLP::CGI>.
+
+=item Apache
+
+Either version 1 or 2.
+Using L<mod_perl|PLP::Apache>, L<mod_fastcgi, mod_fcgid|PLP::FastCGI>,
+or L<mod_action|PLP::CGI>.
+
+=back
 
 =head2 PLP Syntax
 
@@ -390,20 +393,6 @@ These are described in L<PLP::Fields>.
 
 =back
 
-=head2 (mod_perl only) PerlSetVar configuration directives
-
-=over 22
-
-=item PLPcache
-
-Sets caching B<On>/B<Off>. When caching, PLP saves your script in memory and
-doesn't re-read and re-parse it if it hasn't changed. PLP will use more memory,
-but will also run 50% faster.
-
-B<On> is default, anything that isn't =~ /^off$/i is considered On.
-
-=back
-
 =head2 Things that you should know about
 
 Not only syntax is important, you should also be aware of some other important
index 5a9745c138c4f831c48d2ff5334d2920226de169..b1744860021a55efe13215389cd7b0bb4be56e87 100644 (file)
@@ -79,3 +79,48 @@ sub handler {
 
 1;
 
+=head1 NAME
+
+PLP::Apache - Apache mod_perl interface for PLP
+
+=head1 SYNOPSIS
+
+Naturally, you'll need to enable I<mod_perl>:
+
+    apache-modconf apache enable mod_perl
+
+Setup F<httpd.conf> (often just create a F</etc/apache2/conf.d/plp>) with:
+
+    <IfModule mod_perl.c>
+        <Files *.plp>
+            SetHandler perl-script
+            PerlHandler PLP::Apache
+            PerlSendHeader On
+            PerlSetVar PLPcache On
+        </Files>
+    </IfModule>
+
+=head1 DESCRIPTION
+
+=head2 PerlSetVar configuration directives
+
+=over 16
+
+=item PLPcache
+
+Sets caching B<On>/B<Off>. When caching, PLP saves your script in memory and
+doesn't re-read and re-parse it if it hasn't changed. PLP will use more memory,
+but will also run 50% faster.
+
+B<On> is default, anything that isn't =~ /^off$/i is considered On.
+
+=back
+
+=head1 AUTHOR
+
+Mischa POSLAWSKY <perl@shiar.org>
+
+=head1 SEE ALSO
+
+L<PLP|PLP>, L<PLP::FastCGI|PLP::FastCGI>, L<mod_perl|Apache>
+
index 1f46a3c9852954a25d1fc279da38aa56dbb42b37..698c34b1120d531e7dd1cbeb9e9c45e87a2f7933 100644 (file)
@@ -77,3 +77,50 @@ sub import {
 
 1;
 
+=head1 NAME
+
+PLP::CGI - CGI interface for PLP
+
+=head1 SYNOPSIS
+
+For most servers you'll need a script executable.
+Example F</foo/bar/plp.cgi>:
+
+    #!/usr/bin/perl
+    use PLP::CGI;
+
+Or install the C<plp.cgi> included with PLP.
+
+=head2 Lighttpd
+
+Usually in F</etc/lighttpd/lighttpd.conf>:
+enable I<mod_cgi> (add/outcomment in server.modules), and add:
+
+    cgi.assign = (
+        ".plp" => "/foo/bar/plp.cgi",
+    )
+
+=head2 Apache
+
+Enable I<mod_actions> and setup F<httpd.conf>
+(often just create a F</etc/apache2/conf.d/plp>) with:
+
+    <IfModule mod_actions.c>
+        ScriptAlias /PLP_COMMON/ /foo/bar/
+        <Directory /foo/bar/>
+            Options +ExecCGI
+            Order allow,deny
+            Allow from all
+        </Directory>
+        AddHandler plp-document plp
+        Action plp-document /PLP_COMMON/plp.cgi
+    </IfModule>
+
+=head1 AUTHOR
+
+Mischa POSLAWSKY <perl@shiar.org>
+
+=head1 SEE ALSO
+
+L<PLP|PLP>, L<PLP::FastCGI|PLP::FastCGI>
+
index e16fbcbb940cca4cefea975dcd2fa0f0260e3e77..7db729697ad23c0c12de6acf5fb8864b21ddfc32 100644 (file)
@@ -20,3 +20,50 @@ sub import {
 
 1;
 
+=head1 NAME
+
+PLP::FastCGI - FastCGI interface for PLP
+
+=head1 SYNOPSIS
+
+=head2 Lighttpd
+
+Edit the configuration file (usually F</etc/lighttpd/lighttpd.conf>)
+to enable I<mod_fastcgi> (add/outcomment in server.modules), and add:
+
+    fastcgi.server = (
+        ".plp" => ((
+            "bin-path" => "/usr/bin/perl -MPLP::FastCGI",
+            "socket" => "/tmp/fcgi-plp.socket",
+        )),
+    )
+
+=head2 Apache
+
+You'll need a dispatch script (F<plp.fcgi> is included with PLP).
+Example F</foo/bar/plp.fcgi>:
+
+    #!/usr/bin/perl
+    use PLP::FastCGI;
+
+Then enable either I<mod_fastcgi> or I<mod_fcgid>, and setup F<httpd.conf>
+(often just create a F</etc/apache2/conf.d/plp>) with:
+
+    <IfModule mod_fastcgi.c>
+        AddHandler fastcgi-script plp
+        FastCgiWrapper /foo/bar/plp.fcgi
+    </IfModule>
+
+    <IfModule mod_fcgid.c>
+        AddHandler fcgid-script plp
+        FCGIWrapper /foo/bar/plp.fcgi .plp
+    </IfModule>
+
+=head1 AUTHOR
+
+Mischa POSLAWSKY <perl@shiar.org>
+
+=head1 SEE ALSO
+
+L<PLP|PLP>, L<PLP::CGI|PLP::CGI>, L<FCGI|FCGI>
+