From 35928e84e2766dc8310dea2b0062365bde0e65c9 Mon Sep 17 00:00:00 2001 From: Michael Shuler Date: Wed, 14 Oct 2009 10:23:03 -0500 Subject: [PATCH] [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. --- doc/haproxy.1 | 64 +++++++++++++++++++++++++-------------------------- 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/doc/haproxy.1 b/doc/haproxy.1 index 209fb8c6c..001de15a2 100644 --- a/doc/haproxy.1 +++ b/doc/haproxy.1 @@ -6,7 +6,7 @@ HAProxy \- fast and reliable http reverse proxy and load balancer .SH SYNOPSIS -haproxy -f [-n\ maxconn] [-N\ maxconn] [-d] [-D] [-q] [-V] [-c] [-p\ ] [-s] [-l] [-dk] [-ds] [-de] [-dp] [-db] [-m\ ] [{-sf|-st}\ pidlist...] +haproxy \-f [\-n\ maxconn] [\-N\ maxconn] [\-d] [\-D] [\-q] [\-V] [\-c] [\-p\ ] [\-s] [\-l] [\-dk] [\-ds] [\-de] [\-dp] [\-db] [\-m\ ] [{\-sf|\-st}\ pidlist...] .SH DESCRIPTION @@ -33,19 +33,19 @@ instances without risking the system's stability. .SH OPTIONS .TP -\fB-f \fP +\fB\-f \fP Specify configuration file path. .TP -\fB-n \fP +\fB\-n \fP Set the high limit for the total number of simultaneous connections. .TP -\fB-N \fP +\fB\-N \fP Set the high limit for the per-listener number of simultaneous connections. .TP -\fB-d\fP +\fB\-d\fP Start in foregreound with debugging mode enabled. When the proxy runs in this mode, it dumps every connections, 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. .TP -\fB-D\fP +\fB\-D\fP Start in daemon mode. .TP -\fB-q\fP +\fB\-q\fP Disable messages on output. .TP -\fB-V\fP -Displays messages on output even when -q or 'quiet' are specified. Some +\fB\-V\fP +Displays messages on output even when \-q or 'quiet' are specified. Some information about pollers and config file are displayed during startup. .TP -\fB-c\fP +\fB\-c\fP 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. .TP -\fB-p \fP +\fB\-p \fP Ask the process to write down each of its children's pids to this file in daemon mode. .TP -\fB-s\fP +\fB\-s\fP Show statistics (only if compiled in). Statistics are only available if compiled in with the 'STATTIME' option. It's only used during code optimization phases, and will soon disappear. .TP -\fB-l\fP -Show even more statistics (implies '-s'). +\fB\-l\fP +Show even more statistics (implies '\-s'). .TP -\fB-dk\fP +\fB\-dk\fP Disable use of kqueue(). kqueue() is available only on BSD systems. .TP -\fB-ds\fP +\fB\-ds\fP Disable use of speculative epoll(). epoll() is available only on Linux 2.6 and some custom Linux 2.4 systems. .TP -\fB-de\fP +\fB\-de\fP Disable use of epoll(). epoll() is available only on Linux 2.6 and some custom Linux 2.4 systems. .TP -\fB-dp\fP +\fB\-dp\fP Disables use of poll(). select() might be used instead. .TP -\fB-db\fP +\fB\-db\fP 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 stopped by simply pressing Ctrl-C, without having to edit the config nor run full debug. .TP -\fB-m \fP +\fB\-m \fP Enforce a memory usage limit to a maximum of megabytes. .TP -\fB-sf \fP +\fB\-sf \fP Send FINISH signal to the pids in pidlist after startup. The processes which receive this signal will wait for all sessions to finish before exiting. This option must be specified last, followed by any number of PIDs. Technically speaking, \fBSIGTTOU\fP and \fBSIGUSR1\fP are sent. .TP -\fB-st \fP +\fB\-st \fP Send TERMINATE signal to the pids in pidlist after startup. The processes which receive this signal will wait immediately terminate, closing all 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 logs should ensure that their syslog daemon listens to the UDP socket. 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. .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. .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. .TP -- \fBSIGTTOU\fP -Tells the daemon to stop listening to all sockets. Used internally by \fB-sf\fP and \fB-st\fP. +\- \fBSIGTTOU\fP +Tells the daemon to stop listening to all sockets. Used internally by \fB\-sf\fP and \fB\-st\fP. .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. .TP -- \fBSIGINT\fP and \fBSIGTERM\fP +\- \fBSIGINT\fP and \fBSIGTERM\fP Both signals can be used to quickly stop the daemon. .TP -- \fBSIGHUP\fP +\- \fBSIGHUP\fP Dumps the status of all proxies and servers into the logs. Mostly used for trouble-shooting purposes. .TP -\-\ \fBSIGQUIT\fP +\- \fBSIGQUIT\fP Dumps information about memory pools into the logs. Mostly used for debugging purposes. .TP -\-\ \fBSIGPIPE\fP +\- \fBSIGPIPE\fP This signal is intercepted and ignored on systems without \fBMSG_NOSIGNAL\fP. .SH SEE ALSO