diff --git a/doc/h2load.1 b/doc/h2load.1 index 5a75bd31..7cd17f0f 100644 --- a/doc/h2load.1 +++ b/doc/h2load.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "H2LOAD" "1" "Jan 18, 2019" "1.36.0" "nghttp2" +.TH "H2LOAD" "1" "Jan 21, 2019" "1.37.0-DEV" "nghttp2" .SH NAME h2load \- HTTP/2 benchmarking tool . diff --git a/doc/nghttp.1 b/doc/nghttp.1 index 987ccaa5..bfec97e4 100644 --- a/doc/nghttp.1 +++ b/doc/nghttp.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTP" "1" "Jan 18, 2019" "1.36.0" "nghttp2" +.TH "NGHTTP" "1" "Jan 21, 2019" "1.37.0-DEV" "nghttp2" .SH NAME nghttp \- HTTP/2 client . diff --git a/doc/nghttpd.1 b/doc/nghttpd.1 index 4c30d23c..75d8abbc 100644 --- a/doc/nghttpd.1 +++ b/doc/nghttpd.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTPD" "1" "Jan 18, 2019" "1.36.0" "nghttp2" +.TH "NGHTTPD" "1" "Jan 21, 2019" "1.37.0-DEV" "nghttp2" .SH NAME nghttpd \- HTTP/2 server . diff --git a/doc/nghttpx.1 b/doc/nghttpx.1 index 3efdc930..d80de261 100644 --- a/doc/nghttpx.1 +++ b/doc/nghttpx.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTPX" "1" "Jan 18, 2019" "1.36.0" "nghttp2" +.TH "NGHTTPX" "1" "Jan 21, 2019" "1.37.0-DEV" "nghttp2" .SH NAME nghttpx \- HTTP/2 proxy . @@ -139,13 +139,13 @@ parameters are: "proto=", "tls", "sni=", "fall=", "rise=", "affinity=", "dns", "redirect\-if\-not\-tls", "upgrade\-scheme", "mruby=", -"read\-timeout=", and -"write\-timeout=". 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. +"read\-timeout=", "write\-timeout=", +"group=", "group\-weight=", and "weight=". +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 @@ -251,6 +251,29 @@ timeouts. If these timeouts are entirely omitted for a pattern, \fI\%\-\-backend\-read\-timeout\fP and \fI\%\-\-backend\-write\-timeout\fP are used. .sp +"group=" parameter specifies the name of group +this backend address belongs to. By default, it belongs +to the unnamed default group. The name of group is +unique per pattern. "group\-weight=" parameter +specifies the weight of the group. The higher weight +gets more frequently selected by the load balancing +algorithm. must be [1, 256] inclusive. The weight +8 has 4 times more weight than 2. must be the same +for all addresses which share the same . If +"group\-weight" is omitted in an address, but the other +address which belongs to the same group specifies +"group\-weight", its weight is used. If no +"group\-weight" is specified for all addresses, the +weight of a group becomes 1. +.sp +"weight=" parameter specifies the weight of the +backend address inside a group which this address +belongs to. The higher weight gets more frequently +selected by the load balancing algorithm. must be +[1, 256] inclusive. The weight 8 has 4 times more +weight than weight 2. If this parameter is omitted, +weight becomes 1. +.sp Since ";" and ":" are used as delimiter, must not contain these characters. Since ";" has special meaning in shell, the option value must be quoted. diff --git a/doc/nghttpx.1.rst b/doc/nghttpx.1.rst index 5018df05..1bda75f8 100644 --- a/doc/nghttpx.1.rst +++ b/doc/nghttpx.1.rst @@ -123,13 +123,13 @@ Connections "sni=", "fall=", "rise=", "affinity=", "dns", "redirect-if-not-tls", "upgrade-scheme", "mruby=", - "read-timeout=", and - "write-timeout=". 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. + "read-timeout=", "write-timeout=", + "group=", "group-weight=", and "weight=". + 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 @@ -235,6 +235,30 @@ Connections pattern, :option:`--backend-read-timeout` and :option:`--backend-write-timeout` are used. + + "group=" parameter specifies the name of group + this backend address belongs to. By default, it belongs + to the unnamed default group. The name of group is + unique per pattern. "group-weight=" parameter + specifies the weight of the group. The higher weight + gets more frequently selected by the load balancing + algorithm. must be [1, 256] inclusive. The weight + 8 has 4 times more weight than 2. must be the same + for all addresses which share the same . If + "group-weight" is omitted in an address, but the other + address which belongs to the same group specifies + "group-weight", its weight is used. If no + "group-weight" is specified for all addresses, the + weight of a group becomes 1. + + "weight=" parameter specifies the weight of the + backend address inside a group which this address + belongs to. The higher weight gets more frequently + selected by the load balancing algorithm. must be + [1, 256] inclusive. The weight 8 has 4 times more + weight than weight 2. If this parameter is omitted, + weight becomes 1. + Since ";" and ":" are used as delimiter, must not contain these characters. Since ";" has special meaning in shell, the option value must be quoted.