From 15162addc4bd6c55798300c007647a43ab197683 Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Tue, 2 Oct 2018 01:34:32 +0900 Subject: [PATCH] Update manual pages --- doc/h2load.1 | 2 +- doc/nghttp.1 | 2 +- doc/nghttpd.1 | 2 +- doc/nghttpx.1 | 22 ++++++++++++++++------ doc/nghttpx.1.rst | 20 +++++++++++++++----- 5 files changed, 34 insertions(+), 14 deletions(-) diff --git a/doc/h2load.1 b/doc/h2load.1 index 38a66bb9..7e8511ad 100644 --- a/doc/h2load.1 +++ b/doc/h2load.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "H2LOAD" "1" "Sep 15, 2018" "1.34.0-DEV" "nghttp2" +.TH "H2LOAD" "1" "Oct 02, 2018" "1.34.0-DEV" "nghttp2" .SH NAME h2load \- HTTP/2 benchmarking tool . diff --git a/doc/nghttp.1 b/doc/nghttp.1 index 97d0b494..4170b2cd 100644 --- a/doc/nghttp.1 +++ b/doc/nghttp.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTP" "1" "Sep 15, 2018" "1.34.0-DEV" "nghttp2" +.TH "NGHTTP" "1" "Oct 02, 2018" "1.34.0-DEV" "nghttp2" .SH NAME nghttp \- HTTP/2 client . diff --git a/doc/nghttpd.1 b/doc/nghttpd.1 index 3875c2e3..f49c158f 100644 --- a/doc/nghttpd.1 +++ b/doc/nghttpd.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTPD" "1" "Sep 15, 2018" "1.34.0-DEV" "nghttp2" +.TH "NGHTTPD" "1" "Oct 02, 2018" "1.34.0-DEV" "nghttp2" .SH NAME nghttpd \- HTTP/2 server . diff --git a/doc/nghttpx.1 b/doc/nghttpx.1 index 5f049f42..150fe28a 100644 --- a/doc/nghttpx.1 +++ b/doc/nghttpx.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTPX" "1" "Sep 15, 2018" "1.34.0-DEV" "nghttp2" +.TH "NGHTTPX" "1" "Oct 02, 2018" "1.34.0-DEV" "nghttp2" .SH NAME nghttpx \- HTTP/2 proxy . @@ -138,11 +138,13 @@ The parameters are delimited by ";". The available parameters are: "proto=", "tls", "sni=", "fall=", "rise=", "affinity=", "dns", "redirect\-if\-not\-tls", -"upgrade\-scheme", and "mruby=". 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 +"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. .sp The backend application protocol can be specified using @@ -241,6 +243,14 @@ script file which is invoked when this pattern is matched. All backends which share the same pattern must have the same mruby path. .sp +"read\-timeout=" and "write\-timeout=" +parameters specify the read and write timeout of the +backend connection when this pattern is matched. All +backends which share the same pattern must have the same +timeouts. If these timeouts are entirely omitted for a +pattern, \fI\%\-\-backend\-read\-timeout\fP and +\fI\%\-\-backend\-write\-timeout\fP are used. +.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 ba0e7f14..5018df05 100644 --- a/doc/nghttpx.1.rst +++ b/doc/nghttpx.1.rst @@ -122,11 +122,13 @@ Connections parameters are: "proto=", "tls", "sni=", "fall=", "rise=", "affinity=", "dns", "redirect-if-not-tls", - "upgrade-scheme", and "mruby=". 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 + "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. The backend application protocol can be specified using @@ -225,6 +227,14 @@ Connections matched. All backends which share the same pattern must have the same mruby path. + "read-timeout=" and "write-timeout=" + parameters specify the read and write timeout of the + backend connection when this pattern is matched. All + backends which share the same pattern must have the same + timeouts. If these timeouts are entirely omitted for a + pattern, :option:`--backend-read-timeout` and + :option:`--backend-write-timeout` are used. + Since ";" and ":" are used as delimiter, must not contain these characters. Since ";" has special meaning in shell, the option value must be quoted.