[PATCH] explicitly use escaped minus in man pages

Hleb Valoshka 375gnu at gmail.com
Fri Oct 12 17:55:16 UTC 2012


---
 man/man1/unicorn.1       |   32 ++++++++++++++++----------------
 man/man1/unicorn_rails.1 |   34 +++++++++++++++++-----------------
 2 files changed, 33 insertions(+), 33 deletions(-)

diff --git a/man/man1/unicorn.1 b/man/man1/unicorn.1
index 0b496af..749272a 100644
--- a/man/man1/unicorn.1
+++ b/man/man1/unicorn.1
@@ -4,7 +4,7 @@
 unicorn - a rackup-like command to launch the Unicorn HTTP server
 .SH SYNOPSIS
 .PP
-unicorn [-c CONFIG_FILE] [-E RACK_ENV] [-D] [RACKUP_FILE]
+unicorn [\-c CONFIG_FILE] [\-E RACK_ENV] [\-D] [RACKUP_FILE]
 .SH DESCRIPTION
 .PP
 A rackup(1)-like command to launch Rack applications using Unicorn.
@@ -26,7 +26,7 @@ Embedded command-line options are mostly parsed for compatibility
 with rackup(1) but strongly discouraged.
 .SH UNICORN OPTIONS
 .TP
-.B -c, --config-file CONFIG_FILE
+.B \-c, \-\-config\-file CONFIG_FILE
 Path to the Unicorn-specific config file.
 The config file is implemented as a Ruby DSL, so Ruby code may
 executed.
@@ -38,7 +38,7 @@ viewing ps(1) output.
 .RS
 .RE
 .TP
-.B -D, --daemonize
+.B \-D, \-\-daemonize
 Run daemonized in the background.
 The process is detached from the controlling terminal and stdin is
 redirected to \[lq]/dev/null\[rq].
@@ -50,13 +50,13 @@ redirected to \[lq]/dev/null\[rq].
 .RS
 .RE
 .TP
-.B -E, --env RACK_ENV
+.B \-E, \-\-env RACK_ENV
 Run under the given RACK_ENV.
 See the RACK ENVIRONMENT section for more details.
 .RS
 .RE
 .TP
-.B -l, --listen ADDRESS
+.B \-l, \-\-listen ADDRESS
 Listens on a given ADDRESS.
 ADDRESS may be in the form of HOST:PORT or PATH, HOST:PORT is taken
 to mean a TCP socket and PATH is meant to be a path to a UNIX
@@ -69,51 +69,51 @@ socket options.
 .RE
 .SH RACKUP COMPATIBILITY OPTIONS
 .TP
-.B -o, --host HOST
+.B \-o, \-\-host HOST
 Listen on a TCP socket belonging to HOST, default is
 \[lq]0.0.0.0\[rq] (all addresses).
 If specified multiple times on the command-line, only the
 last-specified value takes effect.
 This option only exists for compatibility with the rackup(1)
-command, use of \[lq]-l\[rq]/\[lq]--listen\[rq] switch is
+command, use of \[lq]\-l\[rq]/\[lq]\-\-listen\[rq] switch is
 recommended instead.
 .RS
 .RE
 .TP
-.B -p, --port PORT
+.B \-p, \-\-port PORT
 Listen on the specified TCP PORT, default is 8080.
 If specified multiple times on the command-line, only the
 last-specified value takes effect.
 This option only exists for compatibility with the rackup(1)
-command, use of \[lq]-l\[rq]/\[lq]--listen\[rq] switch is
+command, use of \[lq]\-l\[rq]/\[lq]\-\-listen\[rq] switch is
 recommended instead.
 .RS
 .RE
 .TP
-.B -s, --server SERVER
+.B \-s, \-\-server SERVER
 No-op, this exists only for compatibility with rackup(1).
 .RS
 .RE
 .SH RUBY OPTIONS
 .TP
-.B -e, --eval LINE
+.B \-e, \-\-eval LINE
 Evaluate a LINE of Ruby code.
 This evaluation happens immediately as the command-line is being
 parsed.
 .RS
 .RE
 .TP
-.B -d, --debug
+.B \-d, \-\-debug
 Turn on debug mode, the $DEBUG variable is set to true.
 .RS
 .RE
 .TP
-.B -w, --warn
+.B \-w, \-\-warn
 Turn on verbose warnings, the $VERBOSE variable is set to true.
 .RS
 .RE
 .TP
-.B -I, --include PATH
+.B \-I, \-\-include PATH
 specify $LOAD_PATH.
 PATH will be prepended to $LOAD_PATH.
 The \[aq]:\[aq] character may be used to delimit multiple
@@ -124,7 +124,7 @@ they were specified on the command-line.
 .RS
 .RE
 .TP
-.B -r, --require LIBRARY
+.B \-r, \-\-require LIBRARY
 require a specified LIBRARY before executing the application.
 The "require" statement will be executed immediately and in the
 order they were specified on the command-line.
@@ -185,7 +185,7 @@ If needed, they should be individually specified in the
 RACKUP_FILE, some frameworks do not require them.
 .SH ENVIRONMENT VARIABLES
 .PP
-The RACK_ENV variable is set by the aforementioned -E switch.
+The RACK_ENV variable is set by the aforementioned \-E switch.
 All application or library-specific environment variables (e.g.
 TMPDIR) may always be set in the Unicorn CONFIG_FILE in addition to
 the spawning shell.
diff --git a/man/man1/unicorn_rails.1 b/man/man1/unicorn_rails.1
index a593acb..c644d03 100644
--- a/man/man1/unicorn_rails.1
+++ b/man/man1/unicorn_rails.1
@@ -5,7 +5,7 @@ unicorn_rails - a script/server-like command to launch the Unicorn
 HTTP server
 .SH SYNOPSIS
 .PP
-unicorn_rails [-c CONFIG_FILE] [-E RAILS_ENV] [-D] [RACKUP_FILE]
+unicorn_rails [\-c CONFIG_FILE] [\-E RAILS_ENV] [\-D] [RACKUP_FILE]
 .SH DESCRIPTION
 .PP
 A rackup(1)-like command to launch Rails applications using
@@ -31,7 +31,7 @@ stick to the few command-line options specified in the SYNOPSIS and
 use the CONFIG_FILE as much as possible.
 .SH UNICORN OPTIONS
 .TP
-.B -c, --config-file CONFIG_FILE
+.B \-c, \-\-config-file CONFIG_FILE
 Path to the Unicorn-specific config file.
 The config file is implemented as a Ruby DSL, so Ruby code may
 executed.
@@ -43,7 +43,7 @@ viewing ps(1) output.
 .RS
 .RE
 .TP
-.B -D, --daemonize
+.B \-D, \-\-daemonize
 Run daemonized in the background.
 The process is detached from the controlling terminal and stdin is
 redirected to \[lq]/dev/null\[rq].
@@ -61,7 +61,7 @@ override this Unicorn config file.
 .RS
 .RE
 .TP
-.B -E, --env RAILS_ENV
+.B \-E, \-\-env RAILS_ENV
 Run under the given RAILS_ENV.
 This sets the RAILS_ENV environment variable.
 Acceptable values are exactly those you expect in your Rails
@@ -70,7 +70,7 @@ application, typically \[lq]development\[rq] or
 .RS
 .RE
 .TP
-.B -l, --listen ADDRESS
+.B \-l, \-\-listen ADDRESS
 Listens on a given ADDRESS.
 ADDRESS may be in the form of HOST:PORT or PATH, HOST:PORT is taken
 to mean a TCP socket and PATH is meant to be a path to a UNIX
@@ -84,28 +84,28 @@ socket options.
 .RE
 .SH RACKUP COMPATIBILITY OPTIONS
 .TP
-.B -o, --host HOST
+.B \-o, \-\-host HOST
 Listen on a TCP socket belonging to HOST, default is
 \[lq]0.0.0.0\[rq] (all addresses).
 If specified multiple times on the command-line, only the
 last-specified value takes effect.
 This option only exists for compatibility with the rackup(1)
-command, use of \[lq]-l\[rq]/\[lq]--listen\[rq] switch is
+command, use of \[lq]\-l\[rq]/\[lq]\-\-listen\[rq] switch is
 recommended instead.
 .RS
 .RE
 .TP
-.B -p, --port PORT
+.B \-p, \-\-port PORT
 Listen on the specified TCP PORT, default is 8080.
 If specified multiple times on the command-line, only the
 last-specified value takes effect.
 This option only exists for compatibility with the rackup(1)
-command, use of \[lq]-l\[rq]/\[lq]--listen\[rq] switch is
+command, use of \[lq]\-l\[rq]/\[lq]\-\-listen\[rq] switch is
 recommended instead.
 .RS
 .RE
 .TP
-.B --path PATH
+.B \-\-path PATH
 Mounts the Rails application at the given PATH (instead of
 \[lq]/\[rq]).
 This is equivalent to setting the RAILS_RELATIVE_URL_ROOT
@@ -115,26 +115,26 @@ This is only supported under Rails 2.3 or later at the moment.
 .RE
 .SH RUBY OPTIONS
 .TP
-.B -e, --eval LINE
+.B \-e, \-\-eval LINE
 Evaluate a LINE of Ruby code.
 This evaluation happens immediately as the command-line is being
 parsed.
 .RS
 .RE
 .TP
-.B -d, --debug
+.B \-d, \-\-debug
 Turn on debug mode, the $DEBUG variable is set to true.
 For Rails >= 2.3.x, this loads the \f[I]Rails::Rack::Debugger\f[]
 middleware.
 .RS
 .RE
 .TP
-.B -w, --warn
+.B \-w, \-\-warn
 Turn on verbose warnings, the $VERBOSE variable is set to true.
 .RS
 .RE
 .TP
-.B -I, --include PATH
+.B \-I, \-\-include PATH
 specify $LOAD_PATH.
 PATH will be prepended to $LOAD_PATH.
 The \[aq]:\[aq] character may be used to delimit multiple
@@ -145,7 +145,7 @@ they were specified on the command-line.
 .RS
 .RE
 .TP
-.B -r, --require LIBRARY
+.B \-r, \-\-require LIBRARY
 require a specified LIBRARY before executing the application.
 The "require" statement will be executed immediately and in the
 order they were specified on the command-line.
@@ -164,8 +164,8 @@ Embedded command-line options are mostly parsed for compatibility
 with rackup(1) but strongly discouraged.
 .SH ENVIRONMENT VARIABLES
 .PP
-The RAILS_ENV variable is set by the aforementioned -E switch.
-The RAILS_RELATIVE_URL_ROOT is set by the aforementioned --path
+The RAILS_ENV variable is set by the aforementioned \-E switch.
+The RAILS_RELATIVE_URL_ROOT is set by the aforementioned \-\-path
 switch.
 Either of these variables may also be set in the shell or the
 Unicorn CONFIG_FILE.
-- 
1.7.10.4



More information about the mongrel-unicorn mailing list