From ede801d09997f68a4823412af735f557e69821c0 Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Sat, 16 Aug 2014 22:54:15 +0900 Subject: [PATCH] doc: Update man pages --- doc/h2load.1 | 8 ++++---- doc/h2load.1.rst | 4 ++-- doc/nghttp.1 | 4 ++-- doc/nghttpd.1 | 4 ++-- doc/nghttpx.1 | 38 +++++++++++++++++++++++++++++++------- doc/nghttpx.1.rst | 42 +++++++++++++++++++++++++++++++++++++----- 6 files changed, 78 insertions(+), 22 deletions(-) diff --git a/doc/h2load.1 b/doc/h2load.1 index 714d60d2..59935975 100644 --- a/doc/h2load.1 +++ b/doc/h2load.1 @@ -1,5 +1,5 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.45.1. -.TH H2LOAD "1" "July 2014" "h2load nghttp2/0.5.1" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.1. +.TH H2LOAD "1" "August 2014" "h2load nghttp2/0.6.0-DEV" "User Commands" .SH NAME h2load \- HTTP/2 benchmarking tool .SH SYNOPSIS @@ -45,8 +45,8 @@ than 16, this option is ignored. Otherwise Specify ALPN identifier of the protocol to be used when accessing http URI without SSL/TLS. Available protocols: spdy/2, spdy/3, spdy/3.1 and -h2c\-13 -Default: h2c\-13 +h2c\-14 +Default: h2c\-14 .TP \fB\-v\fR, \fB\-\-verbose\fR Output debug information. diff --git a/doc/h2load.1.rst b/doc/h2load.1.rst index 44107a5a..dd20010f 100644 --- a/doc/h2load.1.rst +++ b/doc/h2load.1.rst @@ -69,8 +69,8 @@ OPTIONS Specify ALPN identifier of the protocol to be used when accessing http URI without SSL/TLS. Available protocols: spdy/2, spdy/3, spdy/3.1 and - h2c-13 - Default: h2c-13 + h2c-14 + Default: h2c-14 .. option:: -v, --verbose diff --git a/doc/nghttp.1 b/doc/nghttp.1 index 5697a100..0e13d45d 100644 --- a/doc/nghttp.1 +++ b/doc/nghttp.1 @@ -1,5 +1,5 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.45.1. -.TH NGHTTP "1" "July 2014" "nghttp nghttp2/0.5.1" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.1. +.TH NGHTTP "1" "August 2014" "nghttp nghttp2/0.6.0-DEV" "User Commands" .SH NAME nghttp \- HTTP/2 experimental client .SH SYNOPSIS diff --git a/doc/nghttpd.1 b/doc/nghttpd.1 index e982d402..1420644a 100644 --- a/doc/nghttpd.1 +++ b/doc/nghttpd.1 @@ -1,5 +1,5 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.45.1. -.TH NGHTTPD "1" "July 2014" "nghttpd nghttp2/0.5.1" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.1. +.TH NGHTTPD "1" "August 2014" "nghttpd nghttp2/0.6.0-DEV" "User Commands" .SH NAME nghttpd \- HTTP/2 experimental server .SH SYNOPSIS diff --git a/doc/nghttpx.1 b/doc/nghttpx.1 index 54cf72d1..fc05d6a4 100644 --- a/doc/nghttpx.1 +++ b/doc/nghttpx.1 @@ -1,5 +1,5 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.45.1. -.TH NGHTTPX "1" "July 2014" "nghttpx nghttp2/0.5.1" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.1. +.TH NGHTTPX "1" "August 2014" "nghttpx nghttp2/0.6.0-DEV" "User Commands" .SH NAME nghttpx \- HTTP/2 experimental proxy .SH SYNOPSIS @@ -76,6 +76,13 @@ Default: 0 Set maximum number of simultaneous connections frontend accepts. Setting 0 means unlimited. Default: 0 +.TP +\fB\-\-backend\-connections\-per\-frontend=\fR +Set maximum number of backend simultaneous +connections per frontend. This option is +meaningful when the combination of HTTP/2 or SPDY +frontend and HTTP/1 backend is used. +Default: 100 .SS "Timeout:" .TP \fB\-\-frontend\-http2\-read\-timeout=\fR @@ -86,20 +93,30 @@ Default: 180 \fB\-\-frontend\-read\-timeout=\fR Specify read timeout for HTTP/1.1 frontend connection. -Default: 180 +Default: 30 .TP \fB\-\-frontend\-write\-timeout=\fR Specify write timeout for all frontend connections. -Default: 60 +Default: 30 +.TP +\fB\-\-stream\-read\-timeout=\fR +Specify read timeout for HTTP/2 and SPDY streams. +0 means no timeout. +Default: 0 +.TP +\fB\-\-stream\-write\-timeout=\fR +Specify write timeout for HTTP/2 and SPDY +streams. 0 means no timeout. +Default: 0 .TP \fB\-\-backend\-read\-timeout=\fR Specify read timeout for backend connection. -Default: 900 +Default: 30 .TP \fB\-\-backend\-write\-timeout=\fR Specify write timeout for backend connection. -Default: 60 +Default: 30 .TP \fB\-\-backend\-keep\-alive\-timeout=\fR Specify keep\-alive timeout for backend @@ -171,7 +188,7 @@ most desirable protocol comes first. This is used in both ALPN and NPN. The parameter must be delimited by a single comma only and any white spaces are treated as a part of protocol string. -Default: h2\-13,spdy/3.1,spdy/3,spdy/2,http/1.1 +Default: h2\-14,spdy/3.1,spdy/3,spdy/2,http/1.1 .TP \fB\-\-verify\-client\fR Require and verify client certificate. @@ -312,6 +329,13 @@ downstream request. Don't append to Via header field. If Via header field is received, it is left unaltered. .TP +\fB\-\-no\-location\-rewrite\fR +Don't rewrite location header field on +\fB\-\-http2\-bridge\fR, \fB\-\-client\fR and default mode. For +\fB\-\-http2\-proxy\fR and \fB\-\-client\-proxy\fR mode, location +header field will not be altered regardless of +this option. +.TP \fB\-\-altsvc=\fR Specify protocol ID, port, host and origin of alternative service. and are diff --git a/doc/nghttpx.1.rst b/doc/nghttpx.1.rst index ce81909c..9a573d30 100644 --- a/doc/nghttpx.1.rst +++ b/doc/nghttpx.1.rst @@ -114,6 +114,15 @@ Performance frontend accepts. Setting 0 means unlimited. Default: 0 +.. option:: --backend-connections-per-frontend= + + + Set maximum number of backend simultaneous + connections per frontend. This option is + meaningful when the combination of HTTP/2 or SPDY + frontend and HTTP/1 backend is used. + Default: 100 + Timeout ^^^^^^^ @@ -129,26 +138,40 @@ Timeout Specify read timeout for HTTP/1.1 frontend connection. - Default: 180 + Default: 30 .. option:: --frontend-write-timeout= Specify write timeout for all frontend connections. - Default: 60 + Default: 30 + +.. option:: --stream-read-timeout= + + + Specify read timeout for HTTP/2 and SPDY streams. + 0 means no timeout. + Default: 0 + +.. option:: --stream-write-timeout= + + + Specify write timeout for HTTP/2 and SPDY + streams. 0 means no timeout. + Default: 0 .. option:: --backend-read-timeout= Specify read timeout for backend connection. - Default: 900 + Default: 30 .. option:: --backend-write-timeout= Specify write timeout for backend connection. - Default: 60 + Default: 30 .. option:: --backend-keep-alive-timeout= @@ -242,7 +265,7 @@ SSL/TLS used in both ALPN and NPN. The parameter must be delimited by a single comma only and any white spaces are treated as a part of protocol string. - Default: h2-13,spdy/3.1,spdy/3,spdy/2,http/1.1 + Default: h2-14,spdy/3.1,spdy/3,spdy/2,http/1.1 .. option:: --verify-client @@ -444,6 +467,15 @@ Misc Don't append to Via header field. If Via header field is received, it is left unaltered. +.. option:: --no-location-rewrite + + + Don't rewrite location header field on + :option:`--http2-bridge`, :option:`--client` and default mode. For + :option:`--http2-proxy` and :option:`--client-proxy` mode, location + header field will not be altered regardless of + this option. + .. option:: --altsvc=