walkero
/
nghttp2
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Update man pages

This commit is contained in:
Tatsuhiro Tsujikawa 2016-04-25 21:53:41 +09:00
parent 4b34bc583d
commit f939000ad9
6 changed files with 57 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/h2load.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "H2LOAD" "1" "April 16, 2016" "1.10.0-DEV" "nghttp2" .TH "H2LOAD" "1" "April 25, 2016" "1.10.0-DEV" "nghttp2"
.SH NAME .SH NAME
h2load \- HTTP/2 benchmarking tool h2load \- HTTP/2 benchmarking tool
. .

2
doc/nghttp.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTP" "1" "April 16, 2016" "1.10.0-DEV" "nghttp2" .TH "NGHTTP" "1" "April 25, 2016" "1.10.0-DEV" "nghttp2"
.SH NAME .SH NAME
nghttp \- HTTP/2 client nghttp \- HTTP/2 client
. .

2
doc/nghttpd.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPD" "1" "April 16, 2016" "1.10.0-DEV" "nghttp2" .TH "NGHTTPD" "1" "April 25, 2016" "1.10.0-DEV" "nghttp2"
.SH NAME .SH NAME
nghttpd \- HTTP/2 server nghttpd \- HTTP/2 server
. .

35
doc/nghttpx.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPX" "1" "April 16, 2016" "1.10.0-DEV" "nghttp2" .TH "NGHTTPX" "1" "April 25, 2016" "1.10.0-DEV" "nghttp2"
.SH NAME .SH NAME
nghttpx \- HTTP/2 proxy nghttpx \- HTTP/2 proxy
. .
@ -55,7 +55,7 @@ The options are categorized into several groups.
.SS Connections .SS Connections
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-b, \-\-backend=(<HOST>,<PORT>|unix:<PATH>)[;[<PATTERN>[:...]][;proto=<PROTO>][;tls][;fall=<N>][;rise=<N>]] .B \-b, \-\-backend=(<HOST>,<PORT>|unix:<PATH>)[;[<PATTERN>[:...]][[;PARAM]...]
Set backend host and port. The multiple backend Set backend host and port. The multiple backend
addresses are accepted by repeating this option. UNIX addresses are accepted by repeating this option. UNIX
domain socket can be specified by prefixing path name domain socket can be specified by prefixing path name
@ -117,20 +117,31 @@ and \fI\%\-b\fP\(aq127.0.0.1,8080;www.nghttp2.org\(aq.
The backend addresses sharing same <PATTERN> are grouped The backend addresses sharing same <PATTERN> are grouped
together forming load balancing group. together forming load balancing group.
.sp .sp
Optionally, backend application protocol can be Several parameters <PARAM> are accepted after <PATTERN>.
specified in <PROTO>. All that share the same <PATTERN> The parameters are delimited by ";". The available
must have the same <PROTO> value if it is given. parameters are: "proto=<PROTO>", "tls", "fall=<N>", and
<PROTO> should be one of the following list without "rise=<N>". The parameter consists of keyword, and
quotes: "h2", "http/1.1". The default value of <PROTO> optionally followed by "=" and value. For example, the
is "http/1.1". Note that usually "h2" refers to HTTP/2 parameter "proto=h2" consists of the keyword "proto" and
value "h2". The parameter "tls" consists of the keyword
"tls" without value. Each parameter is described as
follows.
.sp
The backend application protocol can be specified using
optional "proto" keyword, and in the form of
"proto=<PROTO>". All that share the same <PATTERN> must
have the same <PROTO> value if it is given. <PROTO>
should be one of the following list without quotes:
"h2", "http/1.1". The default value of <PROTO> is
"http/1.1". Note that usually "h2" refers to HTTP/2
over TLS. But in this option, it may mean HTTP/2 over over TLS. But in this option, it may mean HTTP/2 over
cleartext TCP unless "tls" keyword is used (see below). cleartext TCP unless "tls" keyword is used (see below).
.sp .sp
Optionally, TLS can be enabled by specifying "tls" TLS can be enabled by specifying optional "tls" keyword.
keyword. TLS is not enabled by default. TLS is not enabled by default.
.sp .sp
Optionally, the feature to detect whether backend is The feature to detect whether backend is online or
online/offline can be enabled using "fall" and "rise" offline can be enabled using optional "fall" and "rise"
parameters. Using "fall=<N>" parameter, if nghttpx parameters. Using "fall=<N>" parameter, if nghttpx
cannot connect to a this backend <N> times in a row, cannot connect to a this backend <N> times in a row,
this backend is assumed to be offline, and it is this backend is assumed to be offline, and it is

34
doc/nghttpx.1.rst
View File

@ -37,7 +37,8 @@ The options are categorized into several groups.
Connections Connections
~~~~~~~~~~~ ~~~~~~~~~~~
.. option:: -b, --backend=(<HOST>,<PORT>|unix:<PATH>)[;[<PATTERN>[:...]][;proto=<PROTO>][;tls][;fall=<N>][;rise=<N>]] .. option:: -b, --backend=(<HOST>,<PORT>|unix:<PATH>)[;[<PATTERN>[:...]][[;PARAM]...]
Set backend host and port. The multiple backend Set backend host and port. The multiple backend
addresses are accepted by repeating this option. UNIX addresses are accepted by repeating this option. UNIX
@ -100,20 +101,31 @@ Connections
The backend addresses sharing same <PATTERN> are grouped The backend addresses sharing same <PATTERN> are grouped
together forming load balancing group. together forming load balancing group.
Optionally, backend application protocol can be Several parameters <PARAM> are accepted after <PATTERN>.
specified in <PROTO>. All that share the same <PATTERN> The parameters are delimited by ";". The available
must have the same <PROTO> value if it is given. parameters are: "proto=<PROTO>", "tls", "fall=<N>", and
<PROTO> should be one of the following list without "rise=<N>". The parameter consists of keyword, and
quotes: "h2", "http/1.1". The default value of <PROTO> optionally followed by "=" and value. For example, the
is "http/1.1". Note that usually "h2" refers to HTTP/2 parameter "proto=h2" consists of the keyword "proto" and
value "h2". The parameter "tls" consists of the keyword
"tls" without value. Each parameter is described as
follows.
The backend application protocol can be specified using
optional "proto" keyword, and in the form of
"proto=<PROTO>". All that share the same <PATTERN> must
have the same <PROTO> value if it is given. <PROTO>
should be one of the following list without quotes:
"h2", "http/1.1". The default value of <PROTO> is
"http/1.1". Note that usually "h2" refers to HTTP/2
over TLS. But in this option, it may mean HTTP/2 over over TLS. But in this option, it may mean HTTP/2 over
cleartext TCP unless "tls" keyword is used (see below). cleartext TCP unless "tls" keyword is used (see below).
Optionally, TLS can be enabled by specifying "tls" TLS can be enabled by specifying optional "tls" keyword.
keyword. TLS is not enabled by default. TLS is not enabled by default.
Optionally, the feature to detect whether backend is The feature to detect whether backend is online or
online/offline can be enabled using "fall" and "rise" offline can be enabled using optional "fall" and "rise"
parameters. Using "fall=<N>" parameter, if nghttpx parameters. Using "fall=<N>" parameter, if nghttpx
cannot connect to a this backend <N> times in a row, cannot connect to a this backend <N> times in a row,
this backend is assumed to be offline, and it is this backend is assumed to be offline, and it is

16
src/shrpx.cc
View File

@ -1268,11 +1268,11 @@ Connections:
optionally followed by "=" and value. For example, the optionally followed by "=" and value. For example, the
parameter "proto=h2" consists of the keyword "proto" and parameter "proto=h2" consists of the keyword "proto" and
value "h2". The parameter "tls" consists of the keyword value "h2". The parameter "tls" consists of the keyword
"tls" without value. The each parameters are described "tls" without value. Each parameter is described as
as follows. follows.
Optionally, backend application protocol can be The backend application protocol can be specified using
specified using "proto" keyword, and in the form of optional "proto" keyword, and in the form of
"proto=<PROTO>". All that share the same <PATTERN> must "proto=<PROTO>". All that share the same <PATTERN> must
have the same <PROTO> value if it is given. <PROTO> have the same <PROTO> value if it is given. <PROTO>
should be one of the following list without quotes: should be one of the following list without quotes:
@ -1281,11 +1281,11 @@ Connections:
over TLS. But in this option, it may mean HTTP/2 over over TLS. But in this option, it may mean HTTP/2 over
cleartext TCP unless "tls" keyword is used (see below). cleartext TCP unless "tls" keyword is used (see below).
Optionally, TLS can be enabled by specifying "tls" TLS can be enabled by specifying optional "tls" keyword.
keyword. TLS is not enabled by default. TLS is not enabled by default.
Optionally, the feature to detect whether backend is The feature to detect whether backend is online or
online/offline can be enabled using "fall" and "rise" offline can be enabled using optional "fall" and "rise"
parameters. Using "fall=<N>" parameter, if nghttpx parameters. Using "fall=<N>" parameter, if nghttpx
cannot connect to a this backend <N> times in a row, cannot connect to a this backend <N> times in a row,
this backend is assumed to be offline, and it is this backend is assumed to be offline, and it is