Update man pages

This commit is contained in:
Tatsuhiro Tsujikawa 2016-12-11 16:52:03 +09:00
parent 7398e57174
commit 2d9d654507
5 changed files with 94 additions and 24 deletions

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "H2LOAD" "1" "Nov 27, 2016" "1.17.0" "nghttp2" .TH "H2LOAD" "1" "Dec 11, 2016" "1.18.0-DEV" "nghttp2"
.SH NAME .SH NAME
h2load \- HTTP/2 benchmarking tool h2load \- HTTP/2 benchmarking tool
. .

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTP" "1" "Nov 27, 2016" "1.17.0" "nghttp2" .TH "NGHTTP" "1" "Dec 11, 2016" "1.18.0-DEV" "nghttp2"
.SH NAME .SH NAME
nghttp \- HTTP/2 client nghttp \- HTTP/2 client
. .

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPD" "1" "Nov 27, 2016" "1.17.0" "nghttp2" .TH "NGHTTPD" "1" "Dec 11, 2016" "1.18.0-DEV" "nghttp2"
.SH NAME .SH NAME
nghttpd \- HTTP/2 server nghttpd \- HTTP/2 server
. .

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPX" "1" "Nov 27, 2016" "1.17.0" "nghttp2" .TH "NGHTTPX" "1" "Dec 11, 2016" "1.18.0-DEV" "nghttp2"
.SH NAME .SH NAME
nghttpx \- HTTP/2 proxy nghttpx \- HTTP/2 proxy
. .
@ -120,13 +120,13 @@ together forming load balancing group.
Several parameters <PARAM> are accepted after <PATTERN>. Several parameters <PARAM> are accepted after <PATTERN>.
The parameters are delimited by ";". The available The parameters are delimited by ";". The available
parameters are: "proto=<PROTO>", "tls", parameters are: "proto=<PROTO>", "tls",
"sni=<SNI_HOST>", "fall=<N>", "rise=<N>", and "sni=<SNI_HOST>", "fall=<N>", "rise=<N>",
"affinity=<METHOD>". The parameter consists of keyword, "affinity=<METHOD>", and "dns". The parameter consists
and optionally followed by "=" and value. For example, of keyword, and optionally followed by "=" and value.
the parameter "proto=h2" consists of the keyword "proto" For example, the parameter "proto=h2" consists of the
and value "h2". The parameter "tls" consists of the keyword "proto" and value "h2". The parameter "tls"
keyword "tls" without value. Each parameter is consists of the keyword "tls" without value. Each
described as follows. parameter is described as follows.
.sp .sp
The backend application protocol can be specified using The backend application protocol can be specified using
optional "proto" parameter, and in the form of optional "proto" parameter, and in the form of
@ -175,6 +175,14 @@ session affinity is desired. The session affinity may
break if one of the backend gets unreachable, or backend break if one of the backend gets unreachable, or backend
settings are reloaded or replaced by API. settings are reloaded or replaced by API.
.sp .sp
By default, name resolution of backend host name is done
at start up, or reloading configuration. If "dns"
parameter is given, name resolution takes place
dynamically. This is useful if backend address changes
frequently. If "dns" is given, name resolution of
backend host name at start up, or reloading
configuration is skipped.
.sp
Since ";" and ":" are used as delimiter, <PATTERN> must Since ";" and ":" are used as delimiter, <PATTERN> must
not contain these characters. Since ";" has special not contain these characters. Since ";" has special
meaning in shell, the option value must be quoted. meaning in shell, the option value must be quoted.
@ -1238,7 +1246,7 @@ backend server, the custom error pages are not used.
.B \-\-server\-name=<NAME> .B \-\-server\-name=<NAME>
Change server response header field value to <NAME>. Change server response header field value to <NAME>.
.sp .sp
Default: \fBnghttpx nghttp2/1.17.0\fP Default: \fBnghttpx nghttp2/1.18.0\-DEV\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
@ -1255,6 +1263,33 @@ Set the maximum size of request body for API request.
.sp .sp
Default: \fB16K\fP Default: \fB16K\fP
.UNINDENT .UNINDENT
.SS DNS
.INDENT 0.0
.TP
.B \-\-dns\-cache\-timeout=<DURATION>
Set duration that cached DNS results remain valid. Note
that nghttpx caches the unsuccessful results as well.
.sp
Default: \fB10s\fP
.UNINDENT
.INDENT 0.0
.TP
.B \-\-dns\-lookup\-timeout=<DURATION>
Set timeout that DNS server is given to respond to the
initial DNS query. For the 2nd and later queries,
server is given time based on this timeout, and it is
scaled linearly.
.sp
Default: \fB5s\fP
.UNINDENT
.INDENT 0.0
.TP
.B \-\-dns\-max\-try=<N>
Set the number of DNS query before nghttpx gives up name
lookup.
.sp
Default: \fB2\fP
.UNINDENT
.SS Debug .SS Debug
.INDENT 0.0 .INDENT 0.0
.TP .TP

View File

@ -104,13 +104,13 @@ Connections
Several parameters <PARAM> are accepted after <PATTERN>. Several parameters <PARAM> are accepted after <PATTERN>.
The parameters are delimited by ";". The available The parameters are delimited by ";". The available
parameters are: "proto=<PROTO>", "tls", parameters are: "proto=<PROTO>", "tls",
"sni=<SNI_HOST>", "fall=<N>", "rise=<N>", and "sni=<SNI_HOST>", "fall=<N>", "rise=<N>",
"affinity=<METHOD>". The parameter consists of keyword, "affinity=<METHOD>", and "dns". The parameter consists
and optionally followed by "=" and value. For example, of keyword, and optionally followed by "=" and value.
the parameter "proto=h2" consists of the keyword "proto" For example, the parameter "proto=h2" consists of the
and value "h2". The parameter "tls" consists of the keyword "proto" and value "h2". The parameter "tls"
keyword "tls" without value. Each parameter is consists of the keyword "tls" without value. Each
described as follows. parameter is described as follows.
The backend application protocol can be specified using The backend application protocol can be specified using
optional "proto" parameter, and in the form of optional "proto" parameter, and in the form of
@ -159,6 +159,14 @@ Connections
break if one of the backend gets unreachable, or backend break if one of the backend gets unreachable, or backend
settings are reloaded or replaced by API. settings are reloaded or replaced by API.
By default, name resolution of backend host name is done
at start up, or reloading configuration. If "dns"
parameter is given, name resolution takes place
dynamically. This is useful if backend address changes
frequently. If "dns" is given, name resolution of
backend host name at start up, or reloading
configuration is skipped.
Since ";" and ":" are used as delimiter, <PATTERN> must Since ";" and ":" are used as delimiter, <PATTERN> must
not contain these characters. Since ";" has special not contain these characters. Since ";" has special
meaning in shell, the option value must be quoted. meaning in shell, the option value must be quoted.
@ -1118,7 +1126,7 @@ HTTP
Change server response header field value to <NAME>. Change server response header field value to <NAME>.
Default: ``nghttpx nghttp2/1.17.0`` Default: ``nghttpx nghttp2/1.18.0-DEV``
.. option:: --no-server-rewrite .. option:: --no-server-rewrite
@ -1137,6 +1145,33 @@ API
Default: ``16K`` Default: ``16K``
DNS
~~~
.. option:: --dns-cache-timeout=<DURATION>
Set duration that cached DNS results remain valid. Note
that nghttpx caches the unsuccessful results as well.
Default: ``10s``
.. option:: --dns-lookup-timeout=<DURATION>
Set timeout that DNS server is given to respond to the
initial DNS query. For the 2nd and later queries,
server is given time based on this timeout, and it is
scaled linearly.
Default: ``5s``
.. option:: --dns-max-try=<N>
Set the number of DNS query before nghttpx gives up name
lookup.
Default: ``2``
Debug Debug
~~~~~ ~~~~~
@ -1767,10 +1802,10 @@ The replacement is done instantly without breaking existing
connections or requests. It also avoids any process creation as is connections or requests. It also avoids any process creation as is
the case with hot swapping with signals. the case with hot swapping with signals.
The one limitation is that only numeric IP address is allowed in The one limitation is that only numeric IP address is allowd in
:option:`backend <--backend>` in request body unless "dns" parameter :option:`backend <--backend>` in request body while non numeric
is missing while non numeric hostname is allowed in command-line or hostname is allowed in command-line or configuration file is read
configuration file is read using :option:`--conf`. using :option:`--conf`.
SEE ALSO SEE ALSO
-------- --------