Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
N
nghttp2
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Libraries
nghttp2
Commits
d30f3816
Commit
d30f3816
authored
Dec 17, 2017
by
Tatsuhiro Tsujikawa
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update manual pages
parent
cff9ebe1
Changes
6
Show whitespace changes
Inline
Side-by-side
Showing
6 changed files
with
43 additions
and
59 deletions
+43
-59
doc/h2load.1
doc/h2load.1
+6
-11
doc/h2load.1.rst
doc/h2load.1.rst
+5
-10
doc/nghttp.1
doc/nghttp.1
+1
-1
doc/nghttpd.1
doc/nghttpd.1
+1
-1
doc/nghttpx.1
doc/nghttpx.1
+15
-18
doc/nghttpx.1.rst
doc/nghttpx.1.rst
+15
-18
No files found.
doc/h2load.1
View file @
d30f3816
.\" Man page generated from reStructuredText.
.\" Man page generated from reStructuredText.
.
.
.TH "H2LOAD" "1" "Dec 1
4
, 2017" "1.29.0-DEV" "nghttp2"
.TH "H2LOAD" "1" "Dec 1
7
, 2017" "1.29.0-DEV" "nghttp2"
.SH NAME
.SH NAME
h2load \- HTTP/2 benchmarking tool
h2load \- HTTP/2 benchmarking tool
.
.
...
@@ -35,7 +35,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
...
@@ -35,7 +35,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
\fBh2load\fP [OPTIONS]... [URI]...
\fBh2load\fP [OPTIONS]... [URI]...
.SH DESCRIPTION
.SH DESCRIPTION
.sp
.sp
benchmarking tool for HTTP/2
and SPDY
server
benchmarking tool for HTTP/2 server
.INDENT 0.0
.INDENT 0.0
.TP
.TP
.B <URI>
.B <URI>
...
@@ -101,7 +101,6 @@ Default: \fB1\fP
...
@@ -101,7 +101,6 @@ Default: \fB1\fP
.TP
.TP
.B \-w, \-\-window\-bits=<N>
.B \-w, \-\-window\-bits=<N>
Sets the stream level initial window size to (2**<N>)\-1.
Sets the stream level initial window size to (2**<N>)\-1.
For SPDY, 2**<N> is used instead.
.sp
.sp
Default: \fB30\fP
Default: \fB30\fP
.UNINDENT
.UNINDENT
...
@@ -109,9 +108,7 @@ Default: \fB30\fP
...
@@ -109,9 +108,7 @@ Default: \fB30\fP
.TP
.TP
.B \-W, \-\-connection\-window\-bits=<N>
.B \-W, \-\-connection\-window\-bits=<N>
Sets the connection level initial window size to
Sets the connection level initial window size to
(2**<N>)\-1. For SPDY, if <N> is strictly less than 16,
(2**<N>)\-1.
this option is ignored. Otherwise 2**<N> is used for
SPDY.
.sp
.sp
Default: \fB30\fP
Default: \fB30\fP
.UNINDENT
.UNINDENT
...
@@ -133,8 +130,7 @@ Default: \fBECDHE\-ECDSA\-AES256\-GCM\-SHA384:ECDHE\-RSA\-AES256\-GCM\-SHA384:EC
...
@@ -133,8 +130,7 @@ Default: \fBECDHE\-ECDSA\-AES256\-GCM\-SHA384:ECDHE\-RSA\-AES256\-GCM\-SHA384:EC
.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: h2c and
Available protocols: h2c and http/1.1
http/1.1
.sp
.sp
Default: \fBh2c\fP
Default: \fBh2c\fP
.UNINDENT
.UNINDENT
...
@@ -350,8 +346,7 @@ compression. Let \fBdecompressed(headers)\fP to the number of bytes
...
@@ -350,8 +346,7 @@ compression. Let \fBdecompressed(headers)\fP to the number of bytes
used for header fields after decompression. The \fBspace savings\fP
used for header fields after decompression. The \fBspace savings\fP
is calculated by (1 \- \fBheaders\fP / \fBdecompressed(headers)\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
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
header compression. For HTTP/2, it shows some insightful numbers.
numbers.
.TP
.TP
.B data
.B data
The number of response body bytes received from the server.
The number of response body bytes received from the server.
...
@@ -448,7 +443,7 @@ h2load sets large flow control window by default, and effectively
...
@@ -448,7 +443,7 @@ h2load sets large flow control window by default, and effectively
disables flow control to avoid under utilization of server
disables flow control to avoid under utilization of server
performance. To set smaller flow control window, use \fI\%\-w\fP and
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
\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
.SH SEE ALSO
.sp
.sp
\fBnghttp(1)\fP, \fBnghttpd(1)\fP, \fBnghttpx(1)\fP
\fBnghttp(1)\fP, \fBnghttpd(1)\fP, \fBnghttpx(1)\fP
...
...
doc/h2load.1.rst
View file @
d30f3816
...
@@ -14,7 +14,7 @@ SYNOPSIS
...
@@ -14,7 +14,7 @@ SYNOPSIS
DESCRIPTION
DESCRIPTION
-----------
-----------
benchmarking tool for HTTP/2
and SPDY
server
benchmarking tool for HTTP/2 server
.. describe:: <URI>
.. describe:: <URI>
...
@@ -76,16 +76,13 @@ OPTIONS
...
@@ -76,16 +76,13 @@ OPTIONS
.. option:: -w, --window-bits=<N>
.. option:: -w, --window-bits=<N>
Sets the stream level initial window size to (2\*\*<N>)-1.
Sets the stream level initial window size to (2\*\*<N>)-1.
For SPDY, 2\*\*<N> is used instead.
Default: ``30``
Default: ``30``
.. option:: -W, --connection-window-bits=<N>
.. option:: -W, --connection-window-bits=<N>
Sets the connection level initial window size to
Sets the connection level initial window size to
(2\*\*<N>)-1. For SPDY, if <N> is strictly less than 16,
(2\*\*<N>)-1.
this option is ignored. Otherwise 2\*\*<N> is used for
SPDY.
Default: ``30``
Default: ``30``
...
@@ -104,8 +101,7 @@ OPTIONS
...
@@ -104,8 +101,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: h2c and
Available protocols: h2c and http/1.1
http/1.1
Default: ``h2c``
Default: ``h2c``
...
@@ -297,8 +293,7 @@ traffic
...
@@ -297,8 +293,7 @@ traffic
used for header fields after decompression. The ``space savings``
used for header fields after decompression. The ``space savings``
is calculated by (1 - ``headers`` / ``decompressed(headers)``) *
is calculated by (1 - ``headers`` / ``decompressed(headers)``) *
100. For HTTP/1.1, this is usually 0.00%, since it does not have
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
header compression. For HTTP/2, it shows some insightful numbers.
numbers.
data
data
The number of response body bytes received from the server.
The number of response body bytes received from the server.
...
@@ -366,7 +361,7 @@ h2load sets large flow control window by default, and effectively
...
@@ -366,7 +361,7 @@ h2load sets large flow control window by default, and effectively
disables flow control to avoid under utilization of server
disables flow control to avoid under utilization of server
performance. To set smaller flow control window, use :option:`-w` and
performance. To set smaller flow control window, use :option:`-w` and
:option:`-W` options. For example, use ``-w16 -W16`` to set default
: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
SEE ALSO
--------
--------
...
...
doc/nghttp.1
View file @
d30f3816
.\" Man page generated from reStructuredText.
.\" Man page generated from reStructuredText.
.
.
.TH "NGHTTP" "1" "Dec 1
4
, 2017" "1.29.0-DEV" "nghttp2"
.TH "NGHTTP" "1" "Dec 1
7
, 2017" "1.29.0-DEV" "nghttp2"
.SH NAME
.SH NAME
nghttp \- HTTP/2 client
nghttp \- HTTP/2 client
.
.
...
...
doc/nghttpd.1
View file @
d30f3816
.\" Man page generated from reStructuredText.
.\" Man page generated from reStructuredText.
.
.
.TH "NGHTTPD" "1" "Dec 1
4
, 2017" "1.29.0-DEV" "nghttp2"
.TH "NGHTTPD" "1" "Dec 1
7
, 2017" "1.29.0-DEV" "nghttp2"
.SH NAME
.SH NAME
nghttpd \- HTTP/2 server
nghttpd \- HTTP/2 server
.
.
...
...
doc/nghttpx.1
View file @
d30f3816
.\" Man page generated from reStructuredText.
.\" Man page generated from reStructuredText.
.
.
.TH "NGHTTPX" "1" "Dec 1
4
, 2017" "1.29.0-DEV" "nghttp2"
.TH "NGHTTPX" "1" "Dec 1
7
, 2017" "1.29.0-DEV" "nghttp2"
.SH NAME
.SH NAME
nghttpx \- HTTP/2 proxy
nghttpx \- HTTP/2 proxy
.
.
...
@@ -35,7 +35,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
...
@@ -35,7 +35,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
\fBnghttpx\fP [OPTIONS]... [<PRIVATE_KEY> <CERT>]
\fBnghttpx\fP [OPTIONS]... [<PRIVATE_KEY> <CERT>]
.SH DESCRIPTION
.SH DESCRIPTION
.sp
.sp
A reverse proxy for HTTP/2,
HTTP/1 and SPDY
.
A reverse proxy for HTTP/2,
and HTTP/1
.
.INDENT 0.0
.INDENT 0.0
.TP
.TP
.B <PRIVATE_KEY>
.B <PRIVATE_KEY>
...
@@ -471,8 +471,7 @@ this option will be simply ignored.
...
@@ -471,8 +471,7 @@ this option will be simply ignored.
.INDENT 0.0
.INDENT 0.0
.TP
.TP
.B \-\-frontend\-http2\-read\-timeout=<DURATION>
.B \-\-frontend\-http2\-read\-timeout=<DURATION>
Specify read timeout for HTTP/2 and SPDY frontend
Specify read timeout for HTTP/2 frontend connection.
connection.
.sp
.sp
Default: \fB3m\fP
Default: \fB3m\fP
.UNINDENT
.UNINDENT
...
@@ -501,16 +500,16 @@ Default: \fB1m\fP
...
@@ -501,16 +500,16 @@ Default: \fB1m\fP
.INDENT 0.0
.INDENT 0.0
.TP
.TP
.B \-\-stream\-read\-timeout=<DURATION>
.B \-\-stream\-read\-timeout=<DURATION>
Specify read timeout for HTTP/2
and SPDY streams. 0
Specify read timeout for HTTP/2
streams. 0 means no
means no
timeout.
timeout.
.sp
.sp
Default: \fB0\fP
Default: \fB0\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 0.0
.TP
.TP
.B \-\-stream\-write\-timeout=<DURATION>
.B \-\-stream\-write\-timeout=<DURATION>
Specify write timeout for HTTP/2
and SPDY streams. 0
Specify write timeout for HTTP/2
streams. 0 means no
means no
timeout.
timeout.
.sp
.sp
Default: \fB1m\fP
Default: \fB1m\fP
.UNINDENT
.UNINDENT
...
@@ -983,12 +982,12 @@ HTTP/2. To use those cipher suites with HTTP/2,
...
@@ -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
consider to use \fI\%\-\-client\-no\-http2\-cipher\-black\-list\fP
option. But be aware its implications.
option. But be aware its implications.
.UNINDENT
.UNINDENT
.SS HTTP/2
and SPDY
.SS HTTP/2
.INDENT 0.0
.INDENT 0.0
.TP
.TP
.B \-c, \-\-frontend\-http2\-max\-concurrent\-streams=<N>
.B \-c, \-\-frontend\-http2\-max\-concurrent\-streams=<N>
Set the maximum number of the concurrent streams in one
Set the maximum number of the concurrent streams in one
frontend HTTP/2
and SPDY
session.
frontend HTTP/2 session.
.sp
.sp
Default: \(ga\(ga 100\(ga\(ga
Default: \(ga\(ga 100\(ga\(ga
.UNINDENT
.UNINDENT
...
@@ -1005,17 +1004,16 @@ Default: \fB100\fP
...
@@ -1005,17 +1004,16 @@ Default: \fB100\fP
.INDENT 0.0
.INDENT 0.0
.TP
.TP
.B \-\-frontend\-http2\-window\-size=<SIZE>
.B \-\-frontend\-http2\-window\-size=<SIZE>
Sets
the per\-stream initial window size of HTTP/2 and
Sets
the per\-stream initial window size of HTTP/2
SPDY
frontend connection.
frontend connection.
.sp
.sp
Default: \fB65535\fP
Default: \fB65535\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 0.0
.TP
.TP
.B \-\-frontend\-http2\-connection\-window\-size=<SIZE>
.B \-\-frontend\-http2\-connection\-window\-size=<SIZE>
Sets the per\-connection window size of HTTP/2 and SPDY
Sets the per\-connection window size of HTTP/2 frontend
frontend connection. For SPDY connection, the value
connection.
less than 64KiB is rounded up to 64KiB.
.sp
.sp
Default: \fB65535\fP
Default: \fB65535\fP
.UNINDENT
.UNINDENT
...
@@ -1056,8 +1054,7 @@ default mode and HTTP/2 frontend via Link header field.
...
@@ -1056,8 +1054,7 @@ default mode and HTTP/2 frontend via Link header field.
It is also supported if both frontend and backend are
It is also supported if both frontend and backend are
HTTP/2 in default mode. In this case, server push from
HTTP/2 in default mode. In this case, server push from
backend session is relayed to frontend, and server push
backend session is relayed to frontend, and server push
via Link header field is also supported. SPDY frontend
via Link header field is also supported.
does not support server push.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 0.0
.TP
.TP
...
@@ -1128,7 +1125,7 @@ Default: \fB4K\fP
...
@@ -1128,7 +1125,7 @@ Default: \fB4K\fP
.INDENT 0.0
.INDENT 0.0
.TP
.TP
.B (default mode)
.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
parameter is used in \fI\%\-\-frontend\fP option, accept HTTP/2
and HTTP/1.1 over cleartext TCP. The incoming HTTP/1.1
and HTTP/1.1 over cleartext TCP. The incoming HTTP/1.1
connection can be upgraded to HTTP/2 through HTTP
connection can be upgraded to HTTP/2 through HTTP
...
...
doc/nghttpx.1.rst
View file @
d30f3816
...
@@ -14,7 +14,7 @@ SYNOPSIS
...
@@ -14,7 +14,7 @@ SYNOPSIS
DESCRIPTION
DESCRIPTION
-----------
-----------
A reverse proxy for HTTP/2,
HTTP/1 and SPDY
.
A reverse proxy for HTTP/2,
and HTTP/1
.
.. describe:: <PRIVATE_KEY>
.. describe:: <PRIVATE_KEY>
...
@@ -440,8 +440,7 @@ Timeout
...
@@ -440,8 +440,7 @@ Timeout
.. option:: --frontend-http2-read-timeout=<DURATION>
.. option:: --frontend-http2-read-timeout=<DURATION>
Specify read timeout for HTTP/2 and SPDY frontend
Specify read timeout for HTTP/2 frontend connection.
connection.
Default: ``3m``
Default: ``3m``
...
@@ -466,15 +465,15 @@ Timeout
...
@@ -466,15 +465,15 @@ Timeout
.. option:: --stream-read-timeout=<DURATION>
.. option:: --stream-read-timeout=<DURATION>
Specify read timeout for HTTP/2
and SPDY streams. 0
Specify read timeout for HTTP/2
streams. 0 means no
means no
timeout.
timeout.
Default: ``0``
Default: ``0``
.. option:: --stream-write-timeout=<DURATION>
.. option:: --stream-write-timeout=<DURATION>
Specify write timeout for HTTP/2
and SPDY streams. 0
Specify write timeout for HTTP/2
streams. 0 means no
means no
timeout.
timeout.
Default: ``1m``
Default: ``1m``
...
@@ -903,13 +902,13 @@ SSL/TLS
...
@@ -903,13 +902,13 @@ SSL/TLS
option. But be aware its implications.
option. But be aware its implications.
HTTP/2
and SPDY
HTTP/2
~~~~~~
~~~~~~~~~
~~~~~~
.. option:: -c, --frontend-http2-max-concurrent-streams=<N>
.. option:: -c, --frontend-http2-max-concurrent-streams=<N>
Set the maximum number of the concurrent streams in one
Set the maximum number of the concurrent streams in one
frontend HTTP/2
and SPDY
session.
frontend HTTP/2 session.
Default: `` 100``
Default: `` 100``
...
@@ -924,16 +923,15 @@ HTTP/2 and SPDY
...
@@ -924,16 +923,15 @@ HTTP/2 and SPDY
.. option:: --frontend-http2-window-size=<SIZE>
.. option:: --frontend-http2-window-size=<SIZE>
Sets
the per-stream initial window size of HTTP/2 and
Sets
the per-stream initial window size of HTTP/2
SPDY
frontend connection.
frontend connection.
Default: ``65535``
Default: ``65535``
.. option:: --frontend-http2-connection-window-size=<SIZE>
.. option:: --frontend-http2-connection-window-size=<SIZE>
Sets the per-connection window size of HTTP/2 and SPDY
Sets the per-connection window size of HTTP/2 frontend
frontend connection. For SPDY connection, the value
connection.
less than 64KiB is rounded up to 64KiB.
Default: ``65535``
Default: ``65535``
...
@@ -969,8 +967,7 @@ HTTP/2 and SPDY
...
@@ -969,8 +967,7 @@ HTTP/2 and SPDY
It is also supported if both frontend and backend are
It is also supported if both frontend and backend are
HTTP/2 in default mode. In this case, server push from
HTTP/2 in default mode. In this case, server push from
backend session is relayed to frontend, and server push
backend session is relayed to frontend, and server push
via Link header field is also supported. SPDY frontend
via Link header field is also supported.
does not support server push.
.. option:: --frontend-http2-optimize-write-buffer-size
.. option:: --frontend-http2-optimize-write-buffer-size
...
@@ -1038,7 +1035,7 @@ Mode
...
@@ -1038,7 +1035,7 @@ Mode
.. describe:: (default 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
parameter is used in :option:`--frontend` option, accept HTTP/2
and HTTP/1.1 over cleartext TCP. The incoming HTTP/1.1
and HTTP/1.1 over cleartext TCP. The incoming HTTP/1.1
connection can be upgraded to HTTP/2 through HTTP
connection can be upgraded to HTTP/2 through HTTP
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment