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

Update manual pages

This commit is contained in:
Tatsuhiro Tsujikawa 2022-02-23 16:49:04 +09:00
parent 385a28c7f1
commit 039ff29a2f
6 changed files with 54 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/h2load.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "H2LOAD" "1" "Oct 19, 2021" "1.46.0" "nghttp2" .TH "H2LOAD" "1" "Feb 23, 2022" "1.47.0" "nghttp2"
.SH NAME .SH NAME
h2load \- HTTP/2 benchmarking tool h2load \- HTTP/2 benchmarking tool
. .
@ -99,6 +99,14 @@ Default: \fB1\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-f, \-\-max\-frame\-size=<SIZE>
Maximum frame size that the local endpoint is willing to
receive.
.sp
Default: \fB16K\fP
.UNINDENT
.INDENT 0.0
.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 QUIC, <N> is capped to 26 (roughly 64MiB). For QUIC, <N> is capped to 26 (roughly 64MiB).
@ -121,7 +129,7 @@ Add/Override a header to the requests.
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-ciphers=<SUITE> .B \-\-ciphers=<SUITE>
Set allowed cipher list for TLSv1.2 or ealier. The Set allowed cipher list for TLSv1.2 or earlier. The
format of the string is described in OpenSSL ciphers(1). format of the string is described in OpenSSL ciphers(1).
.sp .sp
Default: \fBECDHE\-ECDSA\-AES256\-GCM\-SHA384:ECDHE\-RSA\-AES256\-GCM\-SHA384:ECDHE\-ECDSA\-CHACHA20\-POLY1305:ECDHE\-RSA\-CHACHA20\-POLY1305:ECDHE\-ECDSA\-AES128\-GCM\-SHA256:ECDHE\-RSA\-AES128\-GCM\-SHA256:ECDHE\-ECDSA\-AES256\-SHA384:ECDHE\-RSA\-AES256\-SHA384:ECDHE\-ECDSA\-AES128\-SHA256:ECDHE\-RSA\-AES128\-SHA256\fP Default: \fBECDHE\-ECDSA\-AES256\-GCM\-SHA384:ECDHE\-RSA\-AES256\-GCM\-SHA384:ECDHE\-ECDSA\-CHACHA20\-POLY1305:ECDHE\-RSA\-CHACHA20\-POLY1305:ECDHE\-ECDSA\-AES128\-GCM\-SHA256:ECDHE\-RSA\-AES128\-GCM\-SHA256:ECDHE\-ECDSA\-AES256\-SHA384:ECDHE\-RSA\-AES256\-SHA384:ECDHE\-ECDSA\-AES128\-SHA256:ECDHE\-RSA\-AES128\-SHA256\fP
@ -296,11 +304,10 @@ to buffering. Status code is \-1 for failed streams.
.TP .TP
.B \-\-qlog\-file\-base=<PATH> .B \-\-qlog\-file\-base=<PATH>
Enable qlog output and specify base file name for qlogs. Enable qlog output and specify base file name for qlogs.
Qlog is emitted for each connection. Qlog is emitted for each connection. For a given base
For a given base name "base", each output file name name "base", each output file name becomes
becomes "base.M.N.qlog" where M is worker ID and N is "base.M.N.sqlog" where M is worker ID and N is client ID
client ID (e.g. "base.0.3.qlog"). (e.g. "base.0.3.sqlog"). Only effective in QUIC runs.
Only effective in QUIC runs.
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP

18
doc/h2load.1.rst
View File

@ -73,6 +73,13 @@ OPTIONS
Default: ``1`` Default: ``1``
.. option:: -f, --max-frame-size=<SIZE>
Maximum frame size that the local endpoint is willing to
receive.
Default: ``16K``
.. 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.
@ -93,7 +100,7 @@ OPTIONS
.. option:: --ciphers=<SUITE> .. option:: --ciphers=<SUITE>
Set allowed cipher list for TLSv1.2 or ealier. The Set allowed cipher list for TLSv1.2 or earlier. The
format of the string is described in OpenSSL ciphers(1). format of the string is described in OpenSSL ciphers(1).
Default: ``ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256`` Default: ``ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256``
@ -251,11 +258,10 @@ OPTIONS
.. option:: --qlog-file-base=<PATH> .. option:: --qlog-file-base=<PATH>
Enable qlog output and specify base file name for qlogs. Enable qlog output and specify base file name for qlogs.
Qlog is emitted for each connection. Qlog is emitted for each connection. For a given base
For a given base name "base", each output file name name "base", each output file name becomes
becomes "base.M.N.qlog" where M is worker ID and N is "base.M.N.sqlog" where M is worker ID and N is client ID
client ID (e.g. "base.0.3.qlog"). (e.g. "base.0.3.sqlog"). Only effective in QUIC runs.
Only effective in QUIC runs.
.. option:: --connect-to=<HOST>[:<PORT>] .. option:: --connect-to=<HOST>[:<PORT>]

2
doc/nghttp.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTP" "1" "Oct 19, 2021" "1.46.0" "nghttp2" .TH "NGHTTP" "1" "Feb 23, 2022" "1.47.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" "Oct 19, 2021" "1.46.0" "nghttp2" .TH "NGHTTPD" "1" "Feb 23, 2022" "1.47.0" "nghttp2"
.SH NAME .SH NAME
nghttpd \- HTTP/2 server nghttpd \- HTTP/2 server
. .

18
doc/nghttpx.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPX" "1" "Oct 19, 2021" "1.46.0" "nghttp2" .TH "NGHTTPX" "1" "Feb 23, 2022" "1.47.0" "nghttp2"
.SH NAME .SH NAME
nghttpx \- HTTP/2 proxy nghttpx \- HTTP/2 proxy
. .
@ -1614,6 +1614,16 @@ field when redirect to HTTPS URI is made due to
.sp .sp
Default: \fB443\fP Default: \fB443\fP
.UNINDENT .UNINDENT
.INDENT 0.0
.TP
.B \-\-require\-http\-scheme
Always require http or https scheme in HTTP request. It
also requires that https scheme must be used for an
encrypted connection. Otherwise, http scheme must be
used. This option is recommended for a server
deployment which directly faces clients and the services
it provides only require http or https scheme.
.UNINDENT
.SS API .SS API
.INDENT 0.0 .INDENT 0.0
.TP .TP
@ -1792,7 +1802,7 @@ Specify a directory where a qlog file is written for
frontend QUIC connections. A qlog file is created per frontend QUIC connections. A qlog file is created per
each QUIC connection. The file name is ISO8601 basic each QUIC connection. The file name is ISO8601 basic
format, followed by "\-", server Source Connection ID and format, followed by "\-", server Source Connection ID and
".qlog". ".sqlog".
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
@ -1805,8 +1815,8 @@ NEW_TOKEN frame in the previous connection.
.TP .TP
.B \-\-frontend\-quic\-congestion\-controller=<CC> .B \-\-frontend\-quic\-congestion\-controller=<CC>
Specify a congestion controller algorithm for a frontend Specify a congestion controller algorithm for a frontend
QUIC connection. <CC> should be either "cubic" or QUIC connection. <CC> should be one of "cubic", "bbr",
"bbr". and "bbr2".
.sp .sp
Default: \fBcubic\fP Default: \fBcubic\fP
.UNINDENT .UNINDENT

15
doc/nghttpx.1.rst
View File

@ -1462,6 +1462,15 @@ HTTP
Default: ``443`` Default: ``443``
.. option:: --require-http-scheme
Always require http or https scheme in HTTP request. It
also requires that https scheme must be used for an
encrypted connection. Otherwise, http scheme must be
used. This option is recommended for a server
deployment which directly faces clients and the services
it provides only require http or https scheme.
API API
~~~ ~~~
@ -1637,7 +1646,7 @@ HTTP/3 and QUIC
frontend QUIC connections. A qlog file is created per frontend QUIC connections. A qlog file is created per
each QUIC connection. The file name is ISO8601 basic each QUIC connection. The file name is ISO8601 basic
format, followed by "-", server Source Connection ID and format, followed by "-", server Source Connection ID and
".qlog". ".sqlog".
.. option:: --frontend-quic-require-token .. option:: --frontend-quic-require-token
@ -1648,8 +1657,8 @@ HTTP/3 and QUIC
.. option:: --frontend-quic-congestion-controller=<CC> .. option:: --frontend-quic-congestion-controller=<CC>
Specify a congestion controller algorithm for a frontend Specify a congestion controller algorithm for a frontend
QUIC connection. <CC> should be either "cubic" or QUIC connection. <CC> should be one of "cubic", "bbr",
"bbr". and "bbr2".
Default: ``cubic`` Default: ``cubic``