walkero
/
nghttp2
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

doc: Update man pages

This commit is contained in:
Tatsuhiro Tsujikawa 2014-08-16 22:54:15 +09:00
parent 9649b2d346
commit ede801d099
6 changed files with 78 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/h2load.1
View File

@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.45.1. .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.1.
.TH H2LOAD "1" "July 2014" "h2load nghttp2/0.5.1" "User Commands" .TH H2LOAD "1" "August 2014" "h2load nghttp2/0.6.0-DEV" "User Commands"
.SH NAME .SH NAME
h2load \- HTTP/2 benchmarking tool h2load \- HTTP/2 benchmarking tool
.SH SYNOPSIS .SH SYNOPSIS
@ -45,8 +45,8 @@ than 16, this option is ignored. Otherwise
Specify ALPN identifier of the protocol to be Specify ALPN identifier of the protocol to be
used when accessing http URI without SSL/TLS. used when accessing http URI without SSL/TLS.
Available protocols: spdy/2, spdy/3, spdy/3.1 and Available protocols: spdy/2, spdy/3, spdy/3.1 and
h2c\-13 h2c\-14
Default: h2c\-13 Default: h2c\-14
.TP .TP
\fB\-v\fR, \fB\-\-verbose\fR \fB\-v\fR, \fB\-\-verbose\fR
Output debug information. Output debug information.

4
doc/h2load.1.rst
View File

@ -69,8 +69,8 @@ OPTIONS
Specify ALPN identifier of the protocol to be Specify ALPN identifier of the protocol to be
used when accessing http URI without SSL/TLS. used when accessing http URI without SSL/TLS.
Available protocols: spdy/2, spdy/3, spdy/3.1 and Available protocols: spdy/2, spdy/3, spdy/3.1 and
h2c-13 h2c-14
Default: h2c-13 Default: h2c-14
.. option:: -v, --verbose .. option:: -v, --verbose

4
doc/nghttp.1
View File

@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.45.1. .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.1.
.TH NGHTTP "1" "July 2014" "nghttp nghttp2/0.5.1" "User Commands" .TH NGHTTP "1" "August 2014" "nghttp nghttp2/0.6.0-DEV" "User Commands"
.SH NAME .SH NAME
nghttp \- HTTP/2 experimental client nghttp \- HTTP/2 experimental client
.SH SYNOPSIS .SH SYNOPSIS

4
doc/nghttpd.1
View File

@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.45.1. .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.1.
.TH NGHTTPD "1" "July 2014" "nghttpd nghttp2/0.5.1" "User Commands" .TH NGHTTPD "1" "August 2014" "nghttpd nghttp2/0.6.0-DEV" "User Commands"
.SH NAME .SH NAME
nghttpd \- HTTP/2 experimental server nghttpd \- HTTP/2 experimental server
.SH SYNOPSIS .SH SYNOPSIS

38
doc/nghttpx.1
View File

@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.45.1. .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.1.
.TH NGHTTPX "1" "July 2014" "nghttpx nghttp2/0.5.1" "User Commands" .TH NGHTTPX "1" "August 2014" "nghttpx nghttp2/0.6.0-DEV" "User Commands"
.SH NAME .SH NAME
nghttpx \- HTTP/2 experimental proxy nghttpx \- HTTP/2 experimental proxy
.SH SYNOPSIS .SH SYNOPSIS
@ -76,6 +76,13 @@ Default: 0
Set maximum number of simultaneous connections Set maximum number of simultaneous connections
frontend accepts. Setting 0 means unlimited. frontend accepts. Setting 0 means unlimited.
Default: 0 Default: 0
.TP
\fB\-\-backend\-connections\-per\-frontend=\fR<NUM>
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:" .SS "Timeout:"
.TP .TP
\fB\-\-frontend\-http2\-read\-timeout=\fR<SEC> \fB\-\-frontend\-http2\-read\-timeout=\fR<SEC>
@ -86,20 +93,30 @@ Default: 180
\fB\-\-frontend\-read\-timeout=\fR<SEC> \fB\-\-frontend\-read\-timeout=\fR<SEC>
Specify read timeout for HTTP/1.1 frontend Specify read timeout for HTTP/1.1 frontend
connection. connection.
Default: 180 Default: 30
.TP .TP
\fB\-\-frontend\-write\-timeout=\fR<SEC> \fB\-\-frontend\-write\-timeout=\fR<SEC>
Specify write timeout for all frontend Specify write timeout for all frontend
connections. connections.
Default: 60 Default: 30
.TP
\fB\-\-stream\-read\-timeout=\fR<SEC>
Specify read timeout for HTTP/2 and SPDY streams.
0 means no timeout.
Default: 0
.TP
\fB\-\-stream\-write\-timeout=\fR<SEC>
Specify write timeout for HTTP/2 and SPDY
streams. 0 means no timeout.
Default: 0
.TP .TP
\fB\-\-backend\-read\-timeout=\fR<SEC> \fB\-\-backend\-read\-timeout=\fR<SEC>
Specify read timeout for backend connection. Specify read timeout for backend connection.
Default: 900 Default: 30
.TP .TP
\fB\-\-backend\-write\-timeout=\fR<SEC> \fB\-\-backend\-write\-timeout=\fR<SEC>
Specify write timeout for backend connection. Specify write timeout for backend connection.
Default: 60 Default: 30
.TP .TP
\fB\-\-backend\-keep\-alive\-timeout=\fR<SEC> \fB\-\-backend\-keep\-alive\-timeout=\fR<SEC>
Specify keep\-alive timeout for backend 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 used in both ALPN and NPN. The parameter must be
delimited by a single comma only and any white delimited by a single comma only and any white
spaces are treated as a part of protocol string. 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 .TP
\fB\-\-verify\-client\fR \fB\-\-verify\-client\fR
Require and verify client certificate. Require and verify client certificate.
@ -312,6 +329,13 @@ downstream request.
Don't append to Via header field. If Via header Don't append to Via header field. If Via header
field is received, it is left unaltered. field is received, it is left unaltered.
.TP .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<PROTOID,PORT[,HOST,[ORIGIN]]> \fB\-\-altsvc=\fR<PROTOID,PORT[,HOST,[ORIGIN]]>
Specify protocol ID, port, host and origin of Specify protocol ID, port, host and origin of
alternative service. <HOST> and <ORIGIN> are alternative service. <HOST> and <ORIGIN> are

42
doc/nghttpx.1.rst
View File

@ -114,6 +114,15 @@ Performance
frontend accepts. Setting 0 means unlimited. frontend accepts. Setting 0 means unlimited.
Default: 0 Default: 0
.. option:: --backend-connections-per-frontend=<NUM>
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 Timeout
^^^^^^^ ^^^^^^^
@ -129,26 +138,40 @@ Timeout
Specify read timeout for HTTP/1.1 frontend Specify read timeout for HTTP/1.1 frontend
connection. connection.
Default: 180 Default: 30
.. option:: --frontend-write-timeout=<SEC> .. option:: --frontend-write-timeout=<SEC>
Specify write timeout for all frontend Specify write timeout for all frontend
connections. connections.
Default: 60 Default: 30
.. option:: --stream-read-timeout=<SEC>
Specify read timeout for HTTP/2 and SPDY streams.
0 means no timeout.
Default: 0
.. option:: --stream-write-timeout=<SEC>
Specify write timeout for HTTP/2 and SPDY
streams. 0 means no timeout.
Default: 0
.. option:: --backend-read-timeout=<SEC> .. option:: --backend-read-timeout=<SEC>
Specify read timeout for backend connection. Specify read timeout for backend connection.
Default: 900 Default: 30
.. option:: --backend-write-timeout=<SEC> .. option:: --backend-write-timeout=<SEC>
Specify write timeout for backend connection. Specify write timeout for backend connection.
Default: 60 Default: 30
.. option:: --backend-keep-alive-timeout=<SEC> .. option:: --backend-keep-alive-timeout=<SEC>
@ -242,7 +265,7 @@ SSL/TLS
used in both ALPN and NPN. The parameter must be used in both ALPN and NPN. The parameter must be
delimited by a single comma only and any white delimited by a single comma only and any white
spaces are treated as a part of protocol string. 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 .. option:: --verify-client
@ -444,6 +467,15 @@ Misc
Don't append to Via header field. If Via header Don't append to Via header field. If Via header
field is received, it is left unaltered. 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=<PROTOID,PORT[,HOST,[ORIGIN]]> .. option:: --altsvc=<PROTOID,PORT[,HOST,[ORIGIN]]>