From 2d9d6545079df0d3783fbf10a52cf991a62d5261 Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Sun, 11 Dec 2016 16:52:03 +0900 Subject: [PATCH] Update man pages --- doc/h2load.1 | 2 +- doc/nghttp.1 | 2 +- doc/nghttpd.1 | 2 +- doc/nghttpx.1 | 53 ++++++++++++++++++++++++++++++++++-------- doc/nghttpx.1.rst | 59 +++++++++++++++++++++++++++++++++++++---------- 5 files changed, 94 insertions(+), 24 deletions(-) diff --git a/doc/h2load.1 b/doc/h2load.1 index 3b560ff2..ee341126 100644 --- a/doc/h2load.1 +++ b/doc/h2load.1 @@ -1,6 +1,6 @@ .\" 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 h2load \- HTTP/2 benchmarking tool . diff --git a/doc/nghttp.1 b/doc/nghttp.1 index 75a50a59..bffd1183 100644 --- a/doc/nghttp.1 +++ b/doc/nghttp.1 @@ -1,6 +1,6 @@ .\" 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 nghttp \- HTTP/2 client . diff --git a/doc/nghttpd.1 b/doc/nghttpd.1 index 78dd7589..62414cc5 100644 --- a/doc/nghttpd.1 +++ b/doc/nghttpd.1 @@ -1,6 +1,6 @@ .\" 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 nghttpd \- HTTP/2 server . diff --git a/doc/nghttpx.1 b/doc/nghttpx.1 index 7b9bfb84..dbb89741 100644 --- a/doc/nghttpx.1 +++ b/doc/nghttpx.1 @@ -1,6 +1,6 @@ .\" 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 nghttpx \- HTTP/2 proxy . @@ -120,13 +120,13 @@ together forming load balancing group. Several parameters are accepted after . The parameters are delimited by ";". The available parameters are: "proto=", "tls", -"sni=", "fall=", "rise=", and -"affinity=". The parameter consists of keyword, -and optionally followed by "=" and value. For example, -the 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. +"sni=", "fall=", "rise=", +"affinity=", and "dns". The parameter consists +of keyword, and optionally followed by "=" and value. +For example, the 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" 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 settings are reloaded or replaced by API. .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, must not contain these characters. Since ";" has special 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= Change server response header field value to . .sp -Default: \fBnghttpx nghttp2/1.17.0\fP +Default: \fBnghttpx nghttp2/1.18.0\-DEV\fP .UNINDENT .INDENT 0.0 .TP @@ -1255,6 +1263,33 @@ Set the maximum size of request body for API request. .sp Default: \fB16K\fP .UNINDENT +.SS DNS +.INDENT 0.0 +.TP +.B \-\-dns\-cache\-timeout= +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= +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= +Set the number of DNS query before nghttpx gives up name +lookup. +.sp +Default: \fB2\fP +.UNINDENT .SS Debug .INDENT 0.0 .TP diff --git a/doc/nghttpx.1.rst b/doc/nghttpx.1.rst index eba52dfe..fd7b09c6 100644 --- a/doc/nghttpx.1.rst +++ b/doc/nghttpx.1.rst @@ -104,13 +104,13 @@ Connections Several parameters are accepted after . The parameters are delimited by ";". The available parameters are: "proto=", "tls", - "sni=", "fall=", "rise=", and - "affinity=". The parameter consists of keyword, - and optionally followed by "=" and value. For example, - the 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. + "sni=", "fall=", "rise=", + "affinity=", and "dns". The parameter consists + of keyword, and optionally followed by "=" and value. + For example, the 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" parameter, and in the form of @@ -159,6 +159,14 @@ Connections break if one of the backend gets unreachable, or backend 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, must not contain these characters. Since ";" has special meaning in shell, the option value must be quoted. @@ -1118,7 +1126,7 @@ HTTP Change server response header field value to . - Default: ``nghttpx nghttp2/1.17.0`` + Default: ``nghttpx nghttp2/1.18.0-DEV`` .. option:: --no-server-rewrite @@ -1137,6 +1145,33 @@ API Default: ``16K`` +DNS +~~~ + +.. option:: --dns-cache-timeout= + + Set duration that cached DNS results remain valid. Note + that nghttpx caches the unsuccessful results as well. + + Default: ``10s`` + +.. option:: --dns-lookup-timeout= + + 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= + + Set the number of DNS query before nghttpx gives up name + lookup. + + Default: ``2`` + + Debug ~~~~~ @@ -1767,10 +1802,10 @@ The replacement is done instantly without breaking existing connections or requests. It also avoids any process creation as is the case with hot swapping with signals. -The one limitation is that only numeric IP address is allowed in -:option:`backend <--backend>` in request body unless "dns" parameter -is missing while non numeric hostname is allowed in command-line or -configuration file is read using :option:`--conf`. +The one limitation is that only numeric IP address is allowd in +:option:`backend <--backend>` in request body while non numeric +hostname is allowed in command-line or configuration file is read +using :option:`--conf`. SEE ALSO --------