[DOC] trivial fix for man page
I'm working on helping Arnaud update haproxy in Debian, and one of the package build warnings I received was about "hyphen where a minus sign was intended" in the man page - details: http://lintian.debian.org/tags/hyphen-used-as-minus-sign.html Patch included in my 1.3.20 Debian package is attached.
This commit is contained in:
parent
a080eca533
commit
35928e84e2
@ -6,7 +6,7 @@ HAProxy \- fast and reliable http reverse proxy and load balancer
|
|||||||
|
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
|
|
||||||
haproxy -f <configuration\ file> [-n\ maxconn] [-N\ maxconn] [-d] [-D] [-q] [-V] [-c] [-p\ <pidfile>] [-s] [-l] [-dk] [-ds] [-de] [-dp] [-db] [-m\ <megs>] [{-sf|-st}\ pidlist...]
|
haproxy \-f <configuration\ file> [\-n\ maxconn] [\-N\ maxconn] [\-d] [\-D] [\-q] [\-V] [\-c] [\-p\ <pidfile>] [\-s] [\-l] [\-dk] [\-ds] [\-de] [\-dp] [\-db] [\-m\ <megs>] [{\-sf|\-st}\ pidlist...]
|
||||||
|
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
|
|
||||||
@ -33,19 +33,19 @@ instances without risking the system's stability.
|
|||||||
.SH OPTIONS
|
.SH OPTIONS
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fB-f <configuration file>\fP
|
\fB\-f <configuration file>\fP
|
||||||
Specify configuration file path.
|
Specify configuration file path.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fB-n <maxconn>\fP
|
\fB\-n <maxconn>\fP
|
||||||
Set the high limit for the total number of simultaneous connections.
|
Set the high limit for the total number of simultaneous connections.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fB-N <maxconn>\fP
|
\fB\-N <maxconn>\fP
|
||||||
Set the high limit for the per-listener number of simultaneous connections.
|
Set the high limit for the per-listener number of simultaneous connections.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fB-d\fP
|
\fB\-d\fP
|
||||||
Start in foregreound with debugging mode enabled.
|
Start in foregreound with debugging mode enabled.
|
||||||
When the proxy runs in this mode, it dumps every connections,
|
When the proxy runs in this mode, it dumps every connections,
|
||||||
disconnections, timestamps, and HTTP headers to stdout. This should
|
disconnections, timestamps, and HTTP headers to stdout. This should
|
||||||
@ -53,77 +53,77 @@ NEVER be used in an init script since it will prevent the system from
|
|||||||
starting up.
|
starting up.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fB-D\fP
|
\fB\-D\fP
|
||||||
Start in daemon mode.
|
Start in daemon mode.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fB-q\fP
|
\fB\-q\fP
|
||||||
Disable messages on output.
|
Disable messages on output.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fB-V\fP
|
\fB\-V\fP
|
||||||
Displays messages on output even when -q or 'quiet' are specified. Some
|
Displays messages on output even when \-q or 'quiet' are specified. Some
|
||||||
information about pollers and config file are displayed during startup.
|
information about pollers and config file are displayed during startup.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fB-c\fP
|
\fB\-c\fP
|
||||||
Only checks config file and exits with code 0 if no error was found, or
|
Only checks config file and exits with code 0 if no error was found, or
|
||||||
exits with code 1 if a syntax error was found.
|
exits with code 1 if a syntax error was found.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fB-p <pidfile>\fP
|
\fB\-p <pidfile>\fP
|
||||||
Ask the process to write down each of its children's pids to this file
|
Ask the process to write down each of its children's pids to this file
|
||||||
in daemon mode.
|
in daemon mode.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fB-s\fP
|
\fB\-s\fP
|
||||||
Show statistics (only if compiled in).
|
Show statistics (only if compiled in).
|
||||||
Statistics are only available if compiled in with the 'STATTIME' option.
|
Statistics are only available if compiled in with the 'STATTIME' option.
|
||||||
It's only used during code optimization phases, and will soon disappear.
|
It's only used during code optimization phases, and will soon disappear.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fB-l\fP
|
\fB\-l\fP
|
||||||
Show even more statistics (implies '-s').
|
Show even more statistics (implies '\-s').
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fB-dk\fP
|
\fB\-dk\fP
|
||||||
Disable use of kqueue(). kqueue() is available only on BSD systems.
|
Disable use of kqueue(). kqueue() is available only on BSD systems.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fB-ds\fP
|
\fB\-ds\fP
|
||||||
Disable use of speculative epoll(). epoll() is available only on Linux 2.6
|
Disable use of speculative epoll(). epoll() is available only on Linux 2.6
|
||||||
and some custom Linux 2.4 systems.
|
and some custom Linux 2.4 systems.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fB-de\fP
|
\fB\-de\fP
|
||||||
Disable use of epoll(). epoll() is available only on Linux 2.6
|
Disable use of epoll(). epoll() is available only on Linux 2.6
|
||||||
and some custom Linux 2.4 systems.
|
and some custom Linux 2.4 systems.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fB-dp\fP
|
\fB\-dp\fP
|
||||||
Disables use of poll(). select() might be used instead.
|
Disables use of poll(). select() might be used instead.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fB-db\fP
|
\fB\-db\fP
|
||||||
Disables background mode (stays in foreground, useful for debugging).
|
Disables background mode (stays in foreground, useful for debugging).
|
||||||
For debugging, the '-db' option is very useful as it temporarily
|
For debugging, the '\-db' option is very useful as it temporarily
|
||||||
disables daemon mode and multi-process mode. The service can then be
|
disables daemon mode and multi-process mode. The service can then be
|
||||||
stopped by simply pressing Ctrl-C, without having to edit the config nor
|
stopped by simply pressing Ctrl-C, without having to edit the config nor
|
||||||
run full debug.
|
run full debug.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fB-m <megs>\fP
|
\fB\-m <megs>\fP
|
||||||
Enforce a memory usage limit to a maximum of <megs> megabytes.
|
Enforce a memory usage limit to a maximum of <megs> megabytes.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fB-sf <pidlist>\fP
|
\fB\-sf <pidlist>\fP
|
||||||
Send FINISH signal to the pids in pidlist after startup. The processes
|
Send FINISH signal to the pids in pidlist after startup. The processes
|
||||||
which receive this signal will wait for all sessions to finish before
|
which receive this signal will wait for all sessions to finish before
|
||||||
exiting. This option must be specified last, followed by any number of
|
exiting. This option must be specified last, followed by any number of
|
||||||
PIDs. Technically speaking, \fBSIGTTOU\fP and \fBSIGUSR1\fP are sent.
|
PIDs. Technically speaking, \fBSIGTTOU\fP and \fBSIGUSR1\fP are sent.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fB-st <pidlist>\fP
|
\fB\-st <pidlist>\fP
|
||||||
Send TERMINATE signal to the pids in pidlist after startup. The processes
|
Send TERMINATE signal to the pids in pidlist after startup. The processes
|
||||||
which receive this signal will wait immediately terminate, closing all
|
which receive this signal will wait immediately terminate, closing all
|
||||||
active sessions. This option must be specified last, followed by any number
|
active sessions. This option must be specified last, followed by any number
|
||||||
@ -135,31 +135,31 @@ For this reason, it uses the UDP protocol to send its logs to the server,
|
|||||||
even if it is the local server. People who experience trouble receiving
|
even if it is the local server. People who experience trouble receiving
|
||||||
logs should ensure that their syslog daemon listens to the UDP socket.
|
logs should ensure that their syslog daemon listens to the UDP socket.
|
||||||
Several Linux distributions which ship with syslogd from the sysklogd
|
Several Linux distributions which ship with syslogd from the sysklogd
|
||||||
package have UDP disabled by default. The \fB-r\fP option must be passed
|
package have UDP disabled by default. The \fB\-r\fP option must be passed
|
||||||
to the daemon in order to enable UDP.
|
to the daemon in order to enable UDP.
|
||||||
|
|
||||||
.SH SIGNALS
|
.SH SIGNALS
|
||||||
Some signals have a special meaning for the haproxy daemon. Generally, they are used between daemons and need not be used by the administrator.
|
Some signals have a special meaning for the haproxy daemon. Generally, they are used between daemons and need not be used by the administrator.
|
||||||
.TP
|
.TP
|
||||||
- \fBSIGUSR1\fP
|
\- \fBSIGUSR1\fP
|
||||||
Tells the daemon to stop all proxies and exit once all sessions are closed. It is often referred to as the "soft-stop" signal.
|
Tells the daemon to stop all proxies and exit once all sessions are closed. It is often referred to as the "soft-stop" signal.
|
||||||
.TP
|
.TP
|
||||||
- \fBSIGTTOU\fP
|
\- \fBSIGTTOU\fP
|
||||||
Tells the daemon to stop listening to all sockets. Used internally by \fB-sf\fP and \fB-st\fP.
|
Tells the daemon to stop listening to all sockets. Used internally by \fB\-sf\fP and \fB\-st\fP.
|
||||||
.TP
|
.TP
|
||||||
- \fBSIGTTIN\fP
|
\- \fBSIGTTIN\fP
|
||||||
Tells the daemon to restart listening to all sockets after a \fBSIGTTOU\fP. Used internally when there was a problem during hot reconfiguration.
|
Tells the daemon to restart listening to all sockets after a \fBSIGTTOU\fP. Used internally when there was a problem during hot reconfiguration.
|
||||||
.TP
|
.TP
|
||||||
- \fBSIGINT\fP and \fBSIGTERM\fP
|
\- \fBSIGINT\fP and \fBSIGTERM\fP
|
||||||
Both signals can be used to quickly stop the daemon.
|
Both signals can be used to quickly stop the daemon.
|
||||||
.TP
|
.TP
|
||||||
- \fBSIGHUP\fP
|
\- \fBSIGHUP\fP
|
||||||
Dumps the status of all proxies and servers into the logs. Mostly used for trouble-shooting purposes.
|
Dumps the status of all proxies and servers into the logs. Mostly used for trouble-shooting purposes.
|
||||||
.TP
|
.TP
|
||||||
\-\ \fBSIGQUIT\fP
|
\- \fBSIGQUIT\fP
|
||||||
Dumps information about memory pools into the logs. Mostly used for debugging purposes.
|
Dumps information about memory pools into the logs. Mostly used for debugging purposes.
|
||||||
.TP
|
.TP
|
||||||
\-\ \fBSIGPIPE\fP
|
\- \fBSIGPIPE\fP
|
||||||
This signal is intercepted and ignored on systems without \fBMSG_NOSIGNAL\fP.
|
This signal is intercepted and ignored on systems without \fBMSG_NOSIGNAL\fP.
|
||||||
|
|
||||||
.SH SEE ALSO
|
.SH SEE ALSO
|
||||||
|
Loading…
x
Reference in New Issue
Block a user