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

Update man pages

This commit is contained in:
Tatsuhiro Tsujikawa 2017-02-26 18:35:58 +09:00
parent e59fc725ab
commit bb7718a64a
6 changed files with 56 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/h2load.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "H2LOAD" "1" "Feb 20, 2017" "1.20.0-DEV" "nghttp2" .TH "H2LOAD" "1" "Feb 26, 2017" "1.20.0" "nghttp2"
.SH NAME .SH NAME
h2load \- HTTP/2 benchmarking tool h2load \- HTTP/2 benchmarking tool
. .
@ -131,7 +131,7 @@ Default: \fBECDHE\-ECDSA\-CHACHA20\-POLY1305:ECDHE\-RSA\-CHACHA20\-POLY1305:ECDH
.B \-p, \-\-no\-tls\-proto=<PROTOID> .B \-p, \-\-no\-tls\-proto=<PROTOID>
Specify ALPN identifier of the protocol to be used when Specify ALPN identifier of the protocol to be used when
accessing http URI without SSL/TLS. accessing http URI without SSL/TLS.
Available protocols: spdy/2, spdy/3, spdy/3.1, h2c and Available protocols: h2c and
http/1.1 http/1.1
.sp .sp
Default: \fBh2c\fP Default: \fBh2c\fP
@ -233,7 +233,7 @@ NPN. The parameter must be delimited by a single comma
only and any white spaces are treated as a part of only and any white spaces are treated as a part of
protocol string. protocol string.
.sp .sp
Default: \fBh2,h2\-16,h2\-14,spdy/3.1,spdy/3,spdy/2,http/1.1\fP Default: \fBh2,h2\-16,h2\-14,http/1.1\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP

4
doc/h2load.1.rst
View File

@ -102,7 +102,7 @@ OPTIONS
Specify ALPN identifier of the protocol to be used when Specify ALPN identifier of the protocol to be used when
accessing http URI without SSL/TLS. accessing http URI without SSL/TLS.
Available protocols: spdy/2, spdy/3, spdy/3.1, h2c and Available protocols: h2c and
http/1.1 http/1.1
Default: ``h2c`` Default: ``h2c``
@ -196,7 +196,7 @@ OPTIONS
only and any white spaces are treated as a part of only and any white spaces are treated as a part of
protocol string. protocol string.
Default: ``h2,h2-16,h2-14,spdy/3.1,spdy/3,spdy/2,http/1.1`` Default: ``h2,h2-16,h2-14,http/1.1``
.. option:: --h1 .. option:: --h1

2
doc/nghttp.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTP" "1" "Feb 20, 2017" "1.20.0-DEV" "nghttp2" .TH "NGHTTP" "1" "Feb 26, 2017" "1.20.0" "nghttp2"
.SH NAME .SH NAME
nghttp \- HTTP/2 client nghttp \- HTTP/2 client
. .

2
doc/nghttpd.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPD" "1" "Feb 20, 2017" "1.20.0-DEV" "nghttp2" .TH "NGHTTPD" "1" "Feb 26, 2017" "1.20.0" "nghttp2"
.SH NAME .SH NAME
nghttpd \- HTTP/2 server nghttpd \- HTTP/2 server
. .

31
doc/nghttpx.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPX" "1" "Feb 20, 2017" "1.20.0-DEV" "nghttp2" .TH "NGHTTPX" "1" "Feb 26, 2017" "1.20.0" "nghttp2"
.SH NAME .SH NAME
nghttpx \- HTTP/2 proxy nghttpx \- HTTP/2 proxy
. .
@ -280,6 +280,15 @@ Default: \fB1\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-single\-thread
Run everything in one thread inside the worker process.
This feature is provided for better debugging
experience, or for the platforms which lack thread
support. If threading is disabled, this option is
always enabled.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-read\-rate=<SIZE> .B \-\-read\-rate=<SIZE>
Set maximum average read rate on frontend connection. Set maximum average read rate on frontend connection.
Setting 0 to this option means read rate is unlimited. Setting 0 to this option means read rate is unlimited.
@ -466,7 +475,7 @@ Default: \fB0\fP
Specify write timeout for HTTP/2 and SPDY streams. 0 Specify write timeout for HTTP/2 and SPDY streams. 0
means no timeout. means no timeout.
.sp .sp
Default: \fB0\fP Default: \fB1m\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
@ -627,7 +636,7 @@ NPN. The parameter must be delimited by a single comma
only and any white spaces are treated as a part of only and any white spaces are treated as a part of
protocol string. protocol string.
.sp .sp
Default: \fBh2,h2\-16,h2\-14,spdy/3.1,http/1.1\fP Default: \fBh2,h2\-16,h2\-14,http/1.1\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
@ -1342,7 +1351,7 @@ backend server, the custom error pages are not used.
.B \-\-server\-name=<NAME> .B \-\-server\-name=<NAME>
Change server response header field value to <NAME>. Change server response header field value to <NAME>.
.sp .sp
Default: \fBnghttpx nghttp2/1.20.0\-DEV\fP Default: \fBnghttpx\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
@ -1395,6 +1404,16 @@ lookup.
.sp .sp
Default: \fB2\fP Default: \fB2\fP
.UNINDENT .UNINDENT
.INDENT 0.0
.TP
.B \-\-frontend\-max\-requests=<N>
The number of requests that single frontend connection
can process. For HTTP/2, this is the number of streams
in one HTTP/2 connection. For HTTP/1, this is the
number of keep alive requests. This is hint to nghttpx,
and it may allow additional few requests. The default
value is unlimited.
.UNINDENT
.SS Debug .SS Debug
.INDENT 0.0 .INDENT 0.0
.TP .TP
@ -2138,7 +2157,9 @@ configuration revision is opaque string, and it changes after each
reloading by SIGHUP. With this API, an external application knows reloading by SIGHUP. With this API, an external application knows
that whether nghttpx has finished reloading its configuration by that whether nghttpx has finished reloading its configuration by
comparing the configuration revisions between before and after comparing the configuration revisions between before and after
reloading. reloading. It is recommended to disable persistent (keep\-alive)
connection for this purpose in order to avoid to send a request using
the reused connection which may bound to an old process.
.sp .sp
This API returns response including \fBdata\fP key. Its value is JSON This API returns response including \fBdata\fP key. Its value is JSON
object, and it contains at least the following key: object, and it contains at least the following key:

27
doc/nghttpx.1.rst
View File

@ -262,6 +262,14 @@ Performance
Default: ``1`` Default: ``1``
.. option:: --single-thread
Run everything in one thread inside the worker process.
This feature is provided for better debugging
experience, or for the platforms which lack thread
support. If threading is disabled, this option is
always enabled.
.. option:: --read-rate=<SIZE> .. option:: --read-rate=<SIZE>
Set maximum average read rate on frontend connection. Set maximum average read rate on frontend connection.
@ -431,7 +439,7 @@ Timeout
Specify write timeout for HTTP/2 and SPDY streams. 0 Specify write timeout for HTTP/2 and SPDY streams. 0
means no timeout. means no timeout.
Default: ``0`` Default: ``1m``
.. option:: --backend-read-timeout=<DURATION> .. option:: --backend-read-timeout=<DURATION>
@ -578,7 +586,7 @@ SSL/TLS
only and any white spaces are treated as a part of only and any white spaces are treated as a part of
protocol string. protocol string.
Default: ``h2,h2-16,h2-14,spdy/3.1,http/1.1`` Default: ``h2,h2-16,h2-14,http/1.1``
.. option:: --verify-client .. option:: --verify-client
@ -1216,7 +1224,7 @@ HTTP
Change server response header field value to <NAME>. Change server response header field value to <NAME>.
Default: ``nghttpx nghttp2/1.20.0-DEV`` Default: ``nghttpx``
.. option:: --no-server-rewrite .. option:: --no-server-rewrite
@ -1269,6 +1277,15 @@ DNS
Default: ``2`` Default: ``2``
.. option:: --frontend-max-requests=<N>
The number of requests that single frontend connection
can process. For HTTP/2, this is the number of streams
in one HTTP/2 connection. For HTTP/1, this is the
number of keep alive requests. This is hint to nghttpx,
and it may allow additional few requests. The default
value is unlimited.
Debug Debug
~~~~~ ~~~~~
@ -1959,7 +1976,9 @@ configuration revision is opaque string, and it changes after each
reloading by SIGHUP. With this API, an external application knows reloading by SIGHUP. With this API, an external application knows
that whether nghttpx has finished reloading its configuration by that whether nghttpx has finished reloading its configuration by
comparing the configuration revisions between before and after comparing the configuration revisions between before and after
reloading. reloading. It is recommended to disable persistent (keep-alive)
connection for this purpose in order to avoid to send a request using
the reused connection which may bound to an old process.
This API returns response including ``data`` key. Its value is JSON This API returns response including ``data`` key. Its value is JSON
object, and it contains at least the following key: object, and it contains at least the following key: