Rename --title to --proc_title as that makes more sense. Remove -t option as it's...
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Script / FastCGI.pm
index 3c11974..bad4af6 100644 (file)
@@ -8,66 +8,60 @@ use namespace::autoclean;
 with 'Catalyst::ScriptRole';
 
 has listen => (
-    traits => [qw(Getopt)],
-    cmd_aliases => 'l',
-    isa => Int,
-    is => 'ro',
+    traits        => [qw(Getopt)],
+    cmd_aliases   => 'l',
+    isa           => Str,
+    is            => 'ro',
     documentation => 'Specify a listening port/socket',
 );
 
 has pidfile => (
-    traits => [qw(Getopt)],
-    cmd_aliases => 'pid',
-    isa => Str,
-    is => 'ro',
+    traits        => [qw(Getopt)],
+    cmd_aliases   => [qw/pid p/],
+    isa           => Str,
+    is            => 'ro',
     documentation => 'Specify a pidfile',
 );
 
 has daemon => (
-    traits => [qw(Getopt)],
-    isa => Bool,   
-    is => 'ro', 
-    cmd_aliases => 'd', 
-    documentation => 'Daemonize',
+    traits        => [qw(Getopt)],
+    isa           => Bool,
+    is            => 'ro',
+    cmd_aliases   => [qw/d detach/], # Eww, detach is here as we fucked it up.. Deliberately not documented
+    documentation => 'Daemonize (go into the background)',
 );
 
 has manager => (
-    traits => [qw(Getopt)],
-    isa => Str,    
-    is => 'ro',
-    cmd_aliases => 'm',
-    documentation => 'Use a different FastCGI manager', # FIXME
+    traits        => [qw(Getopt)],
+    isa           => Str,
+    is            => 'ro',
+    cmd_aliases   => 'M',
+    documentation => 'Use a different FastCGI process manager class',
 );
 
-has keep_stderr => (
-    traits => [qw(Getopt)],
-    cmd_aliases => 'std', 
-    isa => Bool,   
-    is => 'ro',  
+has keeperr => (
+    traits        => [qw(Getopt)],
+    cmd_aliases   => 'e',
+    isa           => Bool,
+    is            => 'ro',
     documentation => 'Log STDERR',
 );
 
 has nproc => (
-    traits => [qw(Getopt)],
-    cmd_aliases => 'np',  
-    isa => Int,
-    is => 'ro',  
-    documentation => 'Specify an nproc', # FIXME
+    traits        => [qw(Getopt)],
+    cmd_aliases   => 'n',
+    isa           => Int,
+    is            => 'ro',
+    documentation => 'Specify a number of child processes',
 );
 
-has detach => (
-    traits => [qw(Getopt)],
-    cmd_aliases => 'det', 
-    isa => Bool,   
-    is => 'ro',  
-    documentation => 'Detach this FastCGI process',
+has proc_title => (
+    traits        => [qw(Getopt)],
+    isa           => Str,
+    is            => 'ro',
+    documentation => 'Set the process title',
 );
 
-sub run {
-    my ($self) = @_;
-    $self->_run_application;
-}
-
 sub _application_args {
     my ($self) = shift;
     return (
@@ -76,8 +70,9 @@ sub _application_args {
             nproc   => $self->nproc,
             pidfile => $self->pidfile,
             manager => $self->manager,
-            detach  => $self->detach,
-            keep_stderr => $self->keep_stderr,
+            detach  => $self->daemon,
+            keep_stderr => $self->keeperr,
+            proc_title => $self->proc_title,
         }
     );
 }
@@ -90,11 +85,30 @@ Catalyst::Script::FastCGI - The FastCGI Catalyst Script
 
 =head1 SYNOPSIS
 
-See L<Catalyst>.
+  myapp_fastcgi.pl [options]
+
+ Options:
+   -? --help       display this help and exits
+   -l --listen     Socket path to listen on
+                   (defaults to standard input)
+                   can be HOST:PORT, :PORT or a
+                   filesystem path
+   -n --nproc      specify number of processes to keep
+                   to serve requests (defaults to 1,
+                   requires -listen)
+   -p --pidfile    specify filename for pid file
+                   (requires -listen)
+   -d --daemon     daemonize (requires -listen)
+   -M --manager    specify alternate process manager
+                   (FCGI::ProcManager sub-class)
+                   or empty string to disable
+   -e --keeperr    send error messages to STDOUT, not
+                   to the webserver
+      --proc_title set the process title
 
 =head1 DESCRIPTION
 
-FIXME
+Run a Catalyst application as fastcgi.
 
 =head1 AUTHORS