~ubuntu-branches/ubuntu/trusty/haproxy/trusty-backports

« back to all changes in this revision

Viewing changes to debian/haproxy.8

  • Committer: Bazaar Package Importer
  • Author(s): Arnaud Cornet
  • Date: 2008-03-09 21:30:29 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20080309213029-8oupnrc607mg5uqw
Tags: 1.3.14.3-1
* New Upstream Version
* Add status argument support to init-script to conform to LSB.
* Cleanup pidfile after stop in init script. Init script return code fixups.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH HAPROXY 8 "17 August 2007" 
2
 
 
3
 
.SH NAME
4
 
 
5
 
HAProxy \- fast and reliable http reverse proxy
6
 
 
7
 
.SH SYNOPSIS
8
 
 
9
 
haproxy -f <configuration file> [-n maxconn] [-N maxconn] [-d] [-D] [-q] [-V] [-c] [-p <pidfile>] [-sf] [-st] [-s] [-l] [-dk] [-ds] [-de] [-dp] [-db] [-m <megs>]
10
 
 
11
 
.SH DESCRIPTION
12
 
 
13
 
HAProxy is a TCP/HTTP reverse proxy which is particularly suited for
14
 
high availability environments. Indeed, it can :
15
 
 \- route HTTP requests depending on statically assigned cookies ;
16
 
 \- spread the load among several servers while assuring server
17
 
   persistence through the use of HTTP cookies ;
18
 
 \- switch to backup servers in the event a main one fails ;
19
 
 \- accept connections to special ports dedicated to service
20
 
   monitoring ;
21
 
 \- stop accepting connections without breaking existing ones ;
22
 
 \- add/modify/delete HTTP headers both ways ;
23
 
 \- block requests matching a particular pattern ;
24
 
 \- hold clients to the right application server depending on
25
 
   application cookies
26
 
 \- report detailed status as HTML pages to authenticated users from an
27
 
   URI intercepted from the application.
28
 
 
29
 
It needs very little resource. Its event-driven architecture allows it
30
 
to easily handle thousands of simultaneous connections on hundreds of
31
 
instances without risking the system's stability.
32
 
 
33
 
.SH OPTIONS
34
 
 
35
 
.TP
36
 
\fB-f <configuration file>\fP
37
 
Specify configuration file path.
38
 
 
39
 
.TP
40
 
\fB-n <maxconn>\fP
41
 
Set the high limit for the total number of simultaneous connections.
42
 
 
43
 
.TP
44
 
\fB-N <maxconn>\fP
45
 
Set the high limit for the per-listener number of simultaneous connections.
46
 
 
47
 
.TP
48
 
\fB-d\fP
49
 
Start in foregreound with debugging mode enabled.
50
 
When the proxy runs in this mode, it dumps every connections,
51
 
disconnections, timestamps, and HTTP headers to stdout. This should
52
 
NEVER be used in an init script since it will prevent the system from
53
 
starting up.
54
 
 
55
 
.TP
56
 
\fB-D\fP
57
 
Start in daemon mode.
58
 
 
59
 
.TP
60
 
\fB-q\fP
61
 
Disable messages on output.
62
 
 
63
 
.TP
64
 
\fB-V\fP
65
 
Displays messages on output even when -q or 'quiet' are specified.
66
 
 
67
 
.TP
68
 
\fB-c\fP
69
 
Only checks config file and exits with code 0 if no error was found, or
70
 
exits with code 1 if a syntax error was found.
71
 
 
72
 
.TP
73
 
\fB-p <pidfile>\fP
74
 
Ask the process to write down each of its children's pids to this file
75
 
in daemon mode.
76
 
 
77
 
.TP
78
 
\fB-sf <pidlist>\fP
79
 
Send FINISH signal to the pids in pidlist after startup.
80
 
 
81
 
.TP
82
 
\fB-st <pidlist>\fP
83
 
Send TERMINATE signal to the pids in pidlist after startup.
84
 
 
85
 
.TP
86
 
\fB-s\fP
87
 
Show statistics (only if compiled in).
88
 
Statistics are only available if compiled in with the 'STATTIME' option.
89
 
It's only used during code optimization phases, and will soon disappear.
90
 
 
91
 
.TP
92
 
\fB-l\fP
93
 
Show even more statistics (implies '-s').
94
 
 
95
 
.TP
96
 
\fB-dk\fP
97
 
Disable use of kqueue().
98
 
 
99
 
.TP
100
 
\fB-ds\fP
101
 
Disable use of speculative epoll().
102
 
 
103
 
.TP
104
 
\fB-de\fP
105
 
Disable use of epoll().
106
 
 
107
 
.TP
108
 
\fB-dp\fP
109
 
Disables use of poll().
110
 
 
111
 
.TP
112
 
\fB-db\fP
113
 
Disables background mode (stays in foreground, useful for debugging).
114
 
For debugging, the '-db' option is very useful as it temporarily
115
 
disables daemon mode and multi-process mode. The service can then be
116
 
stopped by simply pressing Ctrl-C, without having to edit the config nor
117
 
run full debug.
118
 
 
119
 
.TP
120
 
\fB-m <megs>\fP
121
 
Enforce a memory usage limit to a maximum of <megs> megabytes.
122
 
 
123
 
.SH SEE ALSO
124
 
 
125
 
A much better documentation can be found in haproxy-en.txt. On debian
126
 
systems, you can find this file in
127
 
/usr/share/doc/haproxy/haproxy-en.txt.gz.
128
 
 
129
 
.SH AUTHOR
130
 
 
131
 
HAProxy was written by Willy Tarreau.
132