tabs => spaces

[catagits/Catalyst-Runtime.git] / lib / Catalyst / Engine / FastCGI.pm

diff --git a/lib/Catalyst/Engine/FastCGI.pm b/lib/Catalyst/Engine/FastCGI.pm
index b308123..1ac5a35 100644 (file)
--- a/lib/Catalyst/Engine/FastCGI.pm
+++ b/lib/Catalyst/Engine/FastCGI.pm
@@ -3,7 +3,7 @@ package Catalyst::Engine::FastCGI;
 use strict;
 use base 'Catalyst::Engine::CGI';
 eval "use FCGI";
-die "Please install FCGI\n" if $@;
+die "Unable to load the FCGI module, you may need to install it:\n$@\n" if $@;
 
 =head1 NAME
 
@@ -22,24 +22,53 @@ This class overloads some methods from C<Catalyst::Engine::CGI>.
 Starts the FastCGI server.  If C<$listen> is set, then it specifies a
 location to listen for FastCGI requests;
 
-  Form            Meaning
-  /path           listen via Unix sockets on /path
-  :port           listen via TCP on port on all interfaces
-  hostname:port   listen via TCP on port bound to hostname
+=over 4
+
+=item /path
+
+listen via Unix sockets on /path
+
+=item :port
+
+listen via TCP on port on all interfaces
+
+=item hostname:port
+
+listen via TCP on port bound to hostname
+
+=back
 
 Options may also be specified;
 
-  Option          Meaning
-  leave_umask     Set to 1 to disable setting umask to 0
-                  for socket open
-  nointr          Do not allow the listener to be
-                  interrupted by Ctrl+C
-  nproc           Specify a number of processes for
-                  FCGI::ProcManager
-  pidfile         Specify a filename for the pid file
-  manager         Specify a FCGI::ProcManager sub-class
-  detach          Detach from console
-  keep_stderr     Send STDERR to STDOUT instead of the webserver
+=over 4
+
+=item leave_umask
+
+Set to 1 to disable setting umask to 0 for socket open =item nointr
+
+Do not allow the listener to be interrupted by Ctrl+C
+
+=item nproc
+
+Specify a number of processes for FCGI::ProcManager
+
+=item pidfile
+
+Specify a filename for the pid file
+
+=item manager
+
+Specify a FCGI::ProcManager sub-class
+
+=item detach          
+
+Detach from console
+
+=item keep_stderr
+
+Send STDERR to STDOUT instead of the webserver
+
+=back
 
 =cut
 
@@ -68,7 +97,7 @@ sub run {
     my %env;
     my $error = \*STDERR; # send STDERR to the web server
        $error = \*STDOUT  # send STDERR to stdout (a logfile)
-        if $options->{keep_stderr}; # (if asked to)
+         if $options->{keep_stderr}; # (if asked to)
     
     my $request =
       FCGI::Request( \*STDIN, \*STDOUT, $error, \%env, $sock,
@@ -208,18 +237,22 @@ static, and dynamic.
 
 =head3 Standalone server mode
 
-    FastCgiExternalServer /tmp/myapp -socket /tmp/myapp.socket
-    Alias /myapp/ /tmp/myapp/
+    FastCgiExternalServer /tmp/myapp.fcgi -socket /tmp/myapp.socket
+    Alias /myapp/ /tmp/myapp/myapp.fcgi/
     
     # Or, run at the root
-    Alias / /tmp/myapp/
+    Alias / /tmp/myapp.fcgi/
     
     # Optionally, rewrite the path when accessed without a trailing slash
     RewriteRule ^/myapp$ myapp/ [R]
     
-The FastCgiExternalServer directive tells Apache that when serving /tmp/myapp
-to use the FastCGI application listenting on the socket /tmp/mapp.socket. 
-Note that /tmp/myapp does not need to exist -- it's a virtual file name.
+
+The FastCgiExternalServer directive tells Apache that when serving
+/tmp/myapp to use the FastCGI application listenting on the socket
+/tmp/mapp.socket.  Note that /tmp/myapp.fcgi does not need to exist --
+it's a virtual file name.  With some versions of C<mod_fastcgi> or
+C<mod_fcgid>, you can use any name you like, but most require that the
+virtual filename end in C<.fcgi>.
 
 It's likely that Apache is not configured to serve files in /tmp, so the 
 Alias directive maps the url path /myapp/ to the (virtual) file that runs the