diff --git a/doc/h2load.1 b/doc/h2load.1 index d6787925..55765d53 100644 --- a/doc/h2load.1 +++ b/doc/h2load.1 @@ -1,6 +1,6 @@ .\" 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 h2load \- HTTP/2 benchmarking tool . diff --git a/doc/nghttp.1 b/doc/nghttp.1 index b0c0a8c5..44c1b5a3 100644 --- a/doc/nghttp.1 +++ b/doc/nghttp.1 @@ -1,6 +1,6 @@ .\" 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 nghttp \- HTTP/2 client . diff --git a/doc/nghttpd.1 b/doc/nghttpd.1 index 8bf9d157..23d6837b 100644 --- a/doc/nghttpd.1 +++ b/doc/nghttpd.1 @@ -1,6 +1,6 @@ .\" 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 nghttpd \- HTTP/2 server . diff --git a/doc/nghttpx.1 b/doc/nghttpx.1 index cf07235e..16821562 100644 --- a/doc/nghttpx.1 +++ b/doc/nghttpx.1 @@ -1,6 +1,6 @@ .\" 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 nghttpx \- HTTP/2 proxy . @@ -55,7 +55,7 @@ The options are categorized into several groups. .SS Connections .INDENT 0.0 .TP -.B \-b, \-\-backend=(,|unix:)[;[[:...]][;proto=][;tls][;fall=][;rise=]] +.B \-b, \-\-backend=(,|unix:)[;[[:...]][[;PARAM]...] Set backend host and port. The multiple backend addresses are accepted by repeating this option. UNIX 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 are grouped together forming load balancing group. .sp -Optionally, backend application protocol can be -specified in . All that share the same -must have the same value if it is given. - should be one of the following list without -quotes: "h2", "http/1.1". The default value of -is "http/1.1". Note that usually "h2" refers to HTTP/2 +Several parameters are accepted after . +The parameters are delimited by ";". The available +parameters are: "proto=", "tls", "fall=", and +"rise=". 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" keyword, and in the form of +"proto=". All that share the same must +have the same value if it is given. +should be one of the following list without quotes: +"h2", "http/1.1". The default value of is +"http/1.1". Note that usually "h2" refers to HTTP/2 over TLS. But in this option, it may mean HTTP/2 over cleartext TCP unless "tls" keyword is used (see below). .sp -Optionally, TLS can be enabled by specifying "tls" -keyword. TLS is not enabled by default. +TLS can be enabled by specifying optional "tls" keyword. +TLS is not enabled by default. .sp -Optionally, the feature to detect whether backend is -online/offline can be enabled using "fall" and "rise" +The feature to detect whether backend is online or +offline can be enabled using optional "fall" and "rise" parameters. Using "fall=" parameter, if nghttpx cannot connect to a this backend times in a row, this backend is assumed to be offline, and it is diff --git a/doc/nghttpx.1.rst b/doc/nghttpx.1.rst index 6e87f5f4..50e7e635 100644 --- a/doc/nghttpx.1.rst +++ b/doc/nghttpx.1.rst @@ -37,7 +37,8 @@ The options are categorized into several groups. Connections ~~~~~~~~~~~ -.. option:: -b, --backend=(,|unix:)[;[[:...]][;proto=][;tls][;fall=][;rise=]] +.. option:: -b, --backend=(,|unix:)[;[[:...]][[;PARAM]...] + Set backend host and port. The multiple backend addresses are accepted by repeating this option. UNIX @@ -100,20 +101,31 @@ Connections The backend addresses sharing same are grouped together forming load balancing group. - Optionally, backend application protocol can be - specified in . All that share the same - must have the same value if it is given. - should be one of the following list without - quotes: "h2", "http/1.1". The default value of - is "http/1.1". Note that usually "h2" refers to HTTP/2 + Several parameters are accepted after . + The parameters are delimited by ";". The available + parameters are: "proto=", "tls", "fall=", and + "rise=". 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" keyword, and in the form of + "proto=". All that share the same must + have the same value if it is given. + should be one of the following list without quotes: + "h2", "http/1.1". The default value of is + "http/1.1". Note that usually "h2" refers to HTTP/2 over TLS. But in this option, it may mean HTTP/2 over cleartext TCP unless "tls" keyword is used (see below). - Optionally, TLS can be enabled by specifying "tls" - keyword. TLS is not enabled by default. + TLS can be enabled by specifying optional "tls" keyword. + TLS is not enabled by default. - Optionally, the feature to detect whether backend is - online/offline can be enabled using "fall" and "rise" + The feature to detect whether backend is online or + offline can be enabled using optional "fall" and "rise" parameters. Using "fall=" parameter, if nghttpx cannot connect to a this backend times in a row, this backend is assumed to be offline, and it is diff --git a/src/shrpx.cc b/src/shrpx.cc index 007c034e..4c98e6e0 100644 --- a/src/shrpx.cc +++ b/src/shrpx.cc @@ -1268,11 +1268,11 @@ Connections: 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. The each parameters are described - as follows. + "tls" without value. Each parameter is described as + follows. - Optionally, backend application protocol can be - specified using "proto" keyword, and in the form of + The backend application protocol can be specified using + optional "proto" keyword, and in the form of "proto=". All that share the same must have the same value if it is given. 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 cleartext TCP unless "tls" keyword is used (see below). - Optionally, TLS can be enabled by specifying "tls" - keyword. TLS is not enabled by default. + TLS can be enabled by specifying optional "tls" keyword. + TLS is not enabled by default. - Optionally, the feature to detect whether backend is - online/offline can be enabled using "fall" and "rise" + The feature to detect whether backend is online or + offline can be enabled using optional "fall" and "rise" parameters. Using "fall=" parameter, if nghttpx cannot connect to a this backend times in a row, this backend is assumed to be offline, and it is