improve commands to show all options that can affect their behavior

mojolicious · Oct 9, 2015 · 11a3f5b · 11a3f5b
1 parent 357ec06
commit 11a3f5b
Show file tree

Hide file tree

Showing 16 changed files with 80 additions and 12 deletions.
diff --git a/Changes b/Changes
@@ -1,5 +1,6 @@
 
 6.24  2015-10-09
+  - Improved commands to show all options that can affect their behavior.
 
 6.23  2015-10-06
   - Improved documentation browser CSS.

diff --git a/lib/Mojolicious/Command/cgi.pm b/lib/Mojolicious/Command/cgi.pm
@@ -26,7 +26,12 @@ Mojolicious::Command::cgi - CGI command
   Usage: APPLICATION cgi [OPTIONS]
 
   Options:
-    --nph   Enable non-parsed-header mode
+    -h, --help          Show this summary of available options
+        --home <path>   Path to your applications home directory, defaults to
+                        the value of MOJO_HOME or auto detection
+    -m, --mode <name>   Operating mode for your application, defaults to the
+                        value of MOJO_MODE/PLACK_ENV or "development"
+        --nph           Enable non-parsed-header mode
 
 =head1 DESCRIPTION
 

diff --git a/lib/Mojolicious/Command/cpanify.pm b/lib/Mojolicious/Command/cpanify.pm
@@ -52,6 +52,7 @@ Mojolicious::Command::cpanify - Cpanify command
     mojo cpanify -u sri -p secr3t Mojolicious-Plugin-MyPlugin-0.01.tar.gz
 
   Options:
+    -h, --help                  Show this summary of available options
     -p, --password <password>   PAUSE password
     -u, --user <name>           PAUSE username
 

diff --git a/lib/Mojolicious/Command/daemon.pm b/lib/Mojolicious/Command/daemon.pm
@@ -45,11 +45,18 @@ Mojolicious::Command::daemon - Daemon command
                                          SOMAXCONN
     -c, --clients <number>               Maximum number of concurrent
                                          connections, defaults to 1000
+    -h, --help                           Show this summary of available options
+        --home <path>                    Path to your applications home
+                                         directory, defaults to the value of
+                                         MOJO_HOME or auto detection
     -i, --inactivity-timeout <seconds>   Inactivity timeout, defaults to the
                                          value of MOJO_INACTIVITY_TIMEOUT or 15
     -l, --listen <location>              One or more locations you want to
                                          listen on, defaults to the value of
                                          MOJO_LISTEN or "http://*:3000"
+    -m, --mode <name>                    Operating mode for your application,
+                                         defaults to the value of
+                                         MOJO_MODE/PLACK_ENV or "development"
     -p, --proxy                          Activate reverse proxy support,
                                          defaults to the value of
                                          MOJO_REVERSE_PROXY

diff --git a/lib/Mojolicious/Command/eval.pm b/lib/Mojolicious/Command/eval.pm
@@ -37,8 +37,13 @@ Mojolicious::Command::eval - Eval command
     ./myapp.pl eval -V 'app->renderer->paths'
 
   Options:
-    -v, --verbose   Print return value to STDOUT
-    -V              Print returned data structure to STDOUT
+    -h, --help          Show this summary of available options
+        --home <path>   Path to your applications home directory, defaults to
+                        the value of MOJO_HOME or auto detection
+    -m, --mode <name>   Operating mode for your application, defaults to the
+                        value of MOJO_MODE/PLACK_ENV or "development"
+    -v, --verbose       Print return value to STDOUT
+    -V                  Print returned data structure to STDOUT
 
 =head1 DESCRIPTION
 

diff --git a/lib/Mojolicious/Command/generate/app.pm b/lib/Mojolicious/Command/generate/app.pm
@@ -53,7 +53,10 @@ Mojolicious::Command::generate::app - App generator command
 
 =head1 SYNOPSIS
 
-  Usage: APPLICATION generate app [NAME]
+  Usage: APPLICATION generate app [OPTIONS] [NAME]
+
+  Options:
+    -h, --help   Show this summary of available options
 
 =head1 DESCRIPTION
 

diff --git a/lib/Mojolicious/Command/generate/lite_app.pm b/lib/Mojolicious/Command/generate/lite_app.pm
@@ -21,7 +21,10 @@ Mojolicious::Command::generate::lite_app - Lite app generator command
 
 =head1 SYNOPSIS
 
-  Usage: APPLICATION generate lite_app [NAME]
+  Usage: APPLICATION generate lite_app [OPTIONS] [NAME]
+
+  Options:
+    -h, --help   Show this summary of available options
 
 =head1 DESCRIPTION
 

diff --git a/lib/Mojolicious/Command/generate/makefile.pm b/lib/Mojolicious/Command/generate/makefile.pm
@@ -18,7 +18,10 @@ Mojolicious::Command::generate::makefile - Makefile generator command
 
 =head1 SYNOPSIS
 
-  Usage: APPLICATION generate makefile
+  Usage: APPLICATION generate makefile [OPTIONS]
+
+  Options:
+    -h, --help   Show this summary of available options
 
 =head1 DESCRIPTION
 

diff --git a/lib/Mojolicious/Command/generate/plugin.pm b/lib/Mojolicious/Command/generate/plugin.pm
@@ -35,7 +35,10 @@ Mojolicious::Command::generate::plugin - Plugin generator command
 
 =head1 SYNOPSIS
 
-  Usage: APPLICATION generate plugin [NAME]
+  Usage: APPLICATION generate plugin [OPTIONS] [NAME]
+
+  Options:
+    -h, --help   Show this summary of available options
 
 =head1 DESCRIPTION
 

diff --git a/lib/Mojolicious/Command/get.pm b/lib/Mojolicious/Command/get.pm
@@ -146,7 +146,14 @@ Mojolicious::Command::get - Get command
                                 detection
     -c, --content <content>     Content to send with request
     -H, --header <name:value>   Additional HTTP header
+    -h, --help                  Show this summary of available options
+        --home <path>           Path to your applications home directory,
+                                defaults to the value of MOJO_HOME or auto
+                                detection
     -M, --method <method>       HTTP method to use, defaults to "GET"
+    -m, --mode <name>           Operating mode for your application, defaults to
+                                the value of MOJO_MODE/PLACK_ENV or
+                                "development"
     -r, --redirect              Follow up to 10 redirects
     -v, --verbose               Print request and response headers to STDERR
 

diff --git a/lib/Mojolicious/Command/inflate.pm b/lib/Mojolicious/Command/inflate.pm
@@ -38,7 +38,14 @@ Mojolicious::Command::inflate - Inflate command
 
 =head1 SYNOPSIS
 
-  Usage: APPLICATION inflate
+  Usage: APPLICATION inflate [OPTIONS]
+
+  Options:
+    -h, --help          Show this summary of available options
+        --home <path>   Path to your applications home directory, defaults to
+                        the value of MOJO_HOME or auto detection
+    -m, --mode <name>   Operating mode for your application, defaults to the
+                        value of MOJO_MODE/PLACK_ENV or "development"
 
 =head1 DESCRIPTION
 

diff --git a/lib/Mojolicious/Command/prefork.pm b/lib/Mojolicious/Command/prefork.pm
@@ -58,13 +58,20 @@ Mojolicious::Command::prefork - Prefork command
     -G, --graceful-timeout <seconds>     Graceful timeout, defaults to 20.
     -I, --heartbeat-interval <seconds>   Heartbeat interval, defaults to 5
     -H, --heartbeat-timeout <seconds>    Heartbeat timeout, defaults to 20
+    -h, --help                           Show this summary of available options
+        --home <path>                    Path to your applications home
+                                         directory, defaults to the value of
+                                         MOJO_HOME or auto detection
     -i, --inactivity-timeout <seconds>   Inactivity timeout, defaults to the
                                          value of MOJO_INACTIVITY_TIMEOUT or 15
     -l, --listen <location>              One or more locations you want to
                                          listen on, defaults to the value of
                                          MOJO_LISTEN or "http://*:3000"
     -M, --multi-accept <number>          Number of connections to accept at
                                          once, defaults to 50
+    -m, --mode <name>                    Operating mode for your application,
+                                         defaults to the value of
+                                         MOJO_MODE/PLACK_ENV or "development"
     -P, --pid-file <path>                Path to process id file, defaults to
                                          "prefork.pid" in a temporary diretory
     -p, --proxy                          Activate reverse proxy support,

diff --git a/lib/Mojolicious/Command/psgi.pm b/lib/Mojolicious/Command/psgi.pm
@@ -18,7 +18,14 @@ Mojolicious::Command::psgi - PSGI command
 
 =head1 SYNOPSIS
 
-  Usage: APPLICATION psgi
+  Usage: APPLICATION psgi [OPTIONS]
+
+  Options:
+    -h, --help          Show this summary of available options
+        --home <path>   Path to your applications home directory, defaults to
+                        the value of MOJO_HOME or auto detection
+    -m, --mode <name>   Operating mode for your application, defaults to the
+                        value of MOJO_MODE/PLACK_ENV or "development"
 
 =head1 DESCRIPTION
 

diff --git a/lib/Mojolicious/Command/routes.pm b/lib/Mojolicious/Command/routes.pm
@@ -67,8 +67,13 @@ Mojolicious::Command::routes - Routes command
   Usage: APPLICATION routes [OPTIONS]
 
   Options:
-    -v, --verbose   Print additional details about routes, flags indicate
-                    C=Conditions, D=Detour, U=Under and W=WebSocket
+    -h, --help          Show this summary of available options
+        --home <path>   Path to your applications home directory, defaults to
+                        the value of MOJO_HOME or auto detection
+    -m, --mode <name>   Operating mode for your application, defaults to the
+                        value of MOJO_MODE/PLACK_ENV or "development"
+    -v, --verbose       Print additional details about routes, flags indicate
+                        C=Conditions, D=Detour, U=Under and W=WebSocket
 
 =head1 DESCRIPTION
 

diff --git a/lib/Mojolicious/Command/test.pm b/lib/Mojolicious/Command/test.pm
@@ -41,6 +41,7 @@ Mojolicious::Command::test - Test command
     ./myapp.pl test -v t/foo/*.t
 
   Options:
+    -h, --help      Show this summary of available options
     -v, --verbose   Print verbose debug information to STDERR
 
 =head1 DESCRIPTION

diff --git a/lib/Mojolicious/Command/version.pm b/lib/Mojolicious/Command/version.pm
@@ -53,7 +53,10 @@ Mojolicious::Command::version - Version command
 
 =head1 SYNOPSIS
 
-  Usage: APPLICATION version
+  Usage: APPLICATION version [OPTIONS]
+
+  Options:
+    -h, --help   Show this summary of available options
 
 =head1 DESCRIPTION