Skip to content

N
nghttp2
Commit d30f3816 authored by Tatsuhiro Tsujikawa's avatar Tatsuhiro Tsujikawa
Browse files
Options

Update manual pages

parent cff9ebe1
Hide whitespace changes
Inline Side-by-side
Showing with 43 additions and 59 deletions
doc/h2load.1
View file @ d30f3816
.\" Man page generated from reStructuredText.
.
.TH "H2LOAD" "1" "Dec 14, 2017" "1.29.0-DEV" "nghttp2"
.TH "H2LOAD" "1" "Dec 17, 2017" "1.29.0-DEV" "nghttp2"
.SH NAME
h2load \- HTTP/2 benchmarking tool
.
......@@ -35,7 +35,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
\fBh2load\fP [OPTIONS]... [URI]...
.SH DESCRIPTION
.sp
benchmarking tool for HTTP/2 and SPDY server
benchmarking tool for HTTP/2 server
.INDENT 0.0
.TP
.B <URI>
......@@ -101,7 +101,6 @@ Default: \fB1\fP
.TP
.B \-w, \-\-window\-bits=<N>
Sets the stream level initial window size to (2**<N>)\-1.
For SPDY, 2**<N> is used instead.
.sp
Default: \fB30\fP
.UNINDENT
......@@ -109,9 +108,7 @@ Default: \fB30\fP
.TP
.B \-W, \-\-connection\-window\-bits=<N>
Sets the connection level initial window size to
(2**<N>)\-1. For SPDY, if <N> is strictly less than 16,
this option is ignored. Otherwise 2**<N> is used for
SPDY.
(2**<N>)\-1.
.sp
Default: \fB30\fP
.UNINDENT
......@@ -133,8 +130,7 @@ Default: \fBECDHE\-ECDSA\-AES256\-GCM\-SHA384:ECDHE\-RSA\-AES256\-GCM\-SHA384:EC
.B \-p, \-\-no\-tls\-proto=<PROTOID>
Specify ALPN identifier of the protocol to be used when
accessing http URI without SSL/TLS.
Available protocols: h2c and
http/1.1
Available protocols: h2c and http/1.1
.sp
Default: \fBh2c\fP
.UNINDENT
......@@ -350,8 +346,7 @@ compression. Let \fBdecompressed(headers)\fP to the number of bytes
used for header fields after decompression. The \fBspace savings\fP
is calculated by (1 \- \fBheaders\fP / \fBdecompressed(headers)\fP) *
100. For HTTP/1.1, this is usually 0.00%, since it does not have
header compression. For HTTP/2 and SPDY, it shows some insightful
numbers.
header compression. For HTTP/2, it shows some insightful numbers.
.TP
.B data
The number of response body bytes received from the server.
......@@ -448,7 +443,7 @@ h2load sets large flow control window by default, and effectively
disables flow control to avoid under utilization of server
performance. To set smaller flow control window, use \fI\%\-w\fP and
\fI\%\-W\fP options. For example, use \fB\-w16 \-W16\fP to set default
window size described in HTTP/2 and SPDY protocol specification.
window size described in HTTP/2 protocol specification.
.SH SEE ALSO
.sp
\fBnghttp(1)\fP, \fBnghttpd(1)\fP, \fBnghttpx(1)\fP
......
doc/h2load.1.rst
View file @ d30f3816
......@@ -14,7 +14,7 @@ SYNOPSIS
DESCRIPTION
-----------
benchmarking tool for HTTP/2 and SPDY server
benchmarking tool for HTTP/2 server
.. describe:: <URI>
......@@ -76,16 +76,13 @@ OPTIONS
.. option:: -w, --window-bits=<N>
Sets the stream level initial window size to (2\*\*<N>)-1.
For SPDY, 2\*\*<N> is used instead.
Default: ``30``
.. option:: -W, --connection-window-bits=<N>
Sets the connection level initial window size to
(2\*\*<N>)-1. For SPDY, if <N> is strictly less than 16,
this option is ignored. Otherwise 2\*\*<N> is used for
SPDY.
(2\*\*<N>)-1.
Default: ``30``
......@@ -104,8 +101,7 @@ OPTIONS
Specify ALPN identifier of the protocol to be used when
accessing http URI without SSL/TLS.
Available protocols: h2c and
http/1.1
Available protocols: h2c and http/1.1
Default: ``h2c``
......@@ -297,8 +293,7 @@ traffic
used for header fields after decompression. The ``space savings``
is calculated by (1 - ``headers`` / ``decompressed(headers)``) *
100. For HTTP/1.1, this is usually 0.00%, since it does not have
header compression. For HTTP/2 and SPDY, it shows some insightful
numbers.
header compression. For HTTP/2, it shows some insightful numbers.
data
The number of response body bytes received from the server.
......@@ -366,7 +361,7 @@ h2load sets large flow control window by default, and effectively
disables flow control to avoid under utilization of server
performance. To set smaller flow control window, use :option:`-w` and
:option:`-W` options. For example, use ``-w16 -W16`` to set default
window size described in HTTP/2 and SPDY protocol specification.
window size described in HTTP/2 protocol specification.
SEE ALSO
--------
......
doc/nghttp.1
View file @ d30f3816
.\" Man page generated from reStructuredText.
.
.TH "NGHTTP" "1" "Dec 14, 2017" "1.29.0-DEV" "nghttp2"
.TH "NGHTTP" "1" "Dec 17, 2017" "1.29.0-DEV" "nghttp2"
.SH NAME
nghttp \- HTTP/2 client
.
......
doc/nghttpd.1
View file @ d30f3816
.\" Man page generated from reStructuredText.
.
.TH "NGHTTPD" "1" "Dec 14, 2017" "1.29.0-DEV" "nghttp2"
.TH "NGHTTPD" "1" "Dec 17, 2017" "1.29.0-DEV" "nghttp2"
.SH NAME
nghttpd \- HTTP/2 server
.
......
doc/nghttpx.1
View file @ d30f3816
.\" Man page generated from reStructuredText.
.
.TH "NGHTTPX" "1" "Dec 14, 2017" "1.29.0-DEV" "nghttp2"
.TH "NGHTTPX" "1" "Dec 17, 2017" "1.29.0-DEV" "nghttp2"
.SH NAME
nghttpx \- HTTP/2 proxy
.
......@@ -35,7 +35,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
\fBnghttpx\fP [OPTIONS]... [<PRIVATE_KEY> <CERT>]
.SH DESCRIPTION
.sp
A reverse proxy for HTTP/2, HTTP/1 and SPDY.
A reverse proxy for HTTP/2, and HTTP/1.
.INDENT 0.0
.TP
.B <PRIVATE_KEY>
......@@ -471,8 +471,7 @@ this option will be simply ignored.
.INDENT 0.0
.TP
.B \-\-frontend\-http2\-read\-timeout=<DURATION>
Specify read timeout for HTTP/2 and SPDY frontend
connection.
Specify read timeout for HTTP/2 frontend connection.
.sp
Default: \fB3m\fP
.UNINDENT
......@@ -501,16 +500,16 @@ Default: \fB1m\fP
.INDENT 0.0
.TP
.B \-\-stream\-read\-timeout=<DURATION>
Specify read timeout for HTTP/2 and SPDY streams. 0
means no timeout.
Specify read timeout for HTTP/2 streams. 0 means no
timeout.
.sp
Default: \fB0\fP
.UNINDENT
.INDENT 0.0
.TP
.B \-\-stream\-write\-timeout=<DURATION>
Specify write timeout for HTTP/2 and SPDY streams. 0
means no timeout.
Specify write timeout for HTTP/2 streams. 0 means no
timeout.
.sp
Default: \fB1m\fP
.UNINDENT
......@@ -983,12 +982,12 @@ HTTP/2. To use those cipher suites with HTTP/2,
consider to use \fI\%\-\-client\-no\-http2\-cipher\-black\-list\fP
option. But be aware its implications.
.UNINDENT
.SS HTTP/2 and SPDY
.SS HTTP/2
.INDENT 0.0
.TP
.B \-c, \-\-frontend\-http2\-max\-concurrent\-streams=<N>
Set the maximum number of the concurrent streams in one
frontend HTTP/2 and SPDY session.
frontend HTTP/2 session.
.sp
Default: \(ga\(ga 100\(ga\(ga
.UNINDENT
......@@ -1005,17 +1004,16 @@ Default: \fB100\fP
.INDENT 0.0
.TP
.B \-\-frontend\-http2\-window\-size=<SIZE>
Sets the per\-stream initial window size of HTTP/2 and
SPDY frontend connection.
Sets the per\-stream initial window size of HTTP/2
frontend connection.
.sp
Default: \fB65535\fP
.UNINDENT
.INDENT 0.0
.TP
.B \-\-frontend\-http2\-connection\-window\-size=<SIZE>
Sets the per\-connection window size of HTTP/2 and SPDY
frontend connection. For SPDY connection, the value
less than 64KiB is rounded up to 64KiB.
Sets the per\-connection window size of HTTP/2 frontend
connection.
.sp
Default: \fB65535\fP
.UNINDENT
......@@ -1056,8 +1054,7 @@ default mode and HTTP/2 frontend via Link header field.
It is also supported if both frontend and backend are
HTTP/2 in default mode. In this case, server push from
backend session is relayed to frontend, and server push
via Link header field is also supported. SPDY frontend
does not support server push.
via Link header field is also supported.
.UNINDENT
.INDENT 0.0
.TP
......@@ -1128,7 +1125,7 @@ Default: \fB4K\fP
.INDENT 0.0
.TP
.B (default mode)
Accept HTTP/2, SPDY and HTTP/1.1 over SSL/TLS. "no\-tls"
Accept HTTP/2, and HTTP/1.1 over SSL/TLS. "no\-tls"
parameter is used in \fI\%\-\-frontend\fP option, accept HTTP/2
and HTTP/1.1 over cleartext TCP. The incoming HTTP/1.1
connection can be upgraded to HTTP/2 through HTTP
......
doc/nghttpx.1.rst
View file @ d30f3816
......@@ -14,7 +14,7 @@ SYNOPSIS
DESCRIPTION
-----------
A reverse proxy for HTTP/2, HTTP/1 and SPDY.
A reverse proxy for HTTP/2, and HTTP/1.
.. describe:: <PRIVATE_KEY>
......@@ -440,8 +440,7 @@ Timeout
.. option:: --frontend-http2-read-timeout=<DURATION>
Specify read timeout for HTTP/2 and SPDY frontend
connection.
Specify read timeout for HTTP/2 frontend connection.
Default: ``3m``
......@@ -466,15 +465,15 @@ Timeout
.. option:: --stream-read-timeout=<DURATION>
Specify read timeout for HTTP/2 and SPDY streams. 0
means no timeout.
Specify read timeout for HTTP/2 streams. 0 means no
timeout.
Default: ``0``
.. option:: --stream-write-timeout=<DURATION>
Specify write timeout for HTTP/2 and SPDY streams. 0
means no timeout.
Specify write timeout for HTTP/2 streams. 0 means no
timeout.
Default: ``1m``
......@@ -903,13 +902,13 @@ SSL/TLS
option. But be aware its implications.
HTTP/2 and SPDY
~~~~~~~~~~~~~~~
HTTP/2
~~~~~~
.. option:: -c, --frontend-http2-max-concurrent-streams=<N>
Set the maximum number of the concurrent streams in one
frontend HTTP/2 and SPDY session.
frontend HTTP/2 session.
Default: `` 100``
......@@ -924,16 +923,15 @@ HTTP/2 and SPDY
.. option:: --frontend-http2-window-size=<SIZE>
Sets the per-stream initial window size of HTTP/2 and
SPDY frontend connection.
Sets the per-stream initial window size of HTTP/2
frontend connection.
Default: ``65535``
.. option:: --frontend-http2-connection-window-size=<SIZE>
Sets the per-connection window size of HTTP/2 and SPDY
frontend connection. For SPDY connection, the value
less than 64KiB is rounded up to 64KiB.
Sets the per-connection window size of HTTP/2 frontend
connection.
Default: ``65535``
......@@ -969,8 +967,7 @@ HTTP/2 and SPDY
It is also supported if both frontend and backend are
HTTP/2 in default mode. In this case, server push from
backend session is relayed to frontend, and server push
via Link header field is also supported. SPDY frontend
does not support server push.
via Link header field is also supported.
.. option:: --frontend-http2-optimize-write-buffer-size
......@@ -1038,7 +1035,7 @@ Mode
.. describe:: (default mode)
Accept HTTP/2, SPDY and HTTP/1.1 over SSL/TLS. "no-tls"
Accept HTTP/2, and HTTP/1.1 over SSL/TLS. "no-tls"
parameter is used in :option:`--frontend` option, accept HTTP/2
and HTTP/1.1 over cleartext TCP. The incoming HTTP/1.1
connection can be upgraded to HTTP/2 through HTTP
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment