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 2021-04-02 22:34:59 +09:00
parent cef458c31c
commit 2aeec7703e
6 changed files with 49 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/h2load.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "H2LOAD" "1" "Feb 02, 2021" "1.43.0" "nghttp2" .TH "H2LOAD" "1" "Apr 02, 2021" "1.44.0-DEV" "nghttp2"
.SH NAME .SH NAME
h2load \- HTTP/2 benchmarking tool h2load \- HTTP/2 benchmarking tool
. .
@ -168,7 +168,7 @@ option is 1s.
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-D, \-\-duration=<N> .B \-D, \-\-duration=<DURATION>
Specifies the main duration for the measurements in case Specifies the main duration for the measurements in case
of timing\-based benchmarking. \fI\%\-D\fP and \fI\%\-r\fP are mutually of timing\-based benchmarking. \fI\%\-D\fP and \fI\%\-r\fP are mutually
exclusive. exclusive.
@ -220,7 +220,8 @@ to the number of script lines. The scheme, host and
port defined in the first URI are used solely. Values port defined in the first URI are used solely. Values
contained in other URIs, if present, are ignored. contained in other URIs, if present, are ignored.
Definition of a base URI overrides all scheme, host or Definition of a base URI overrides all scheme, host or
port values. port values. \fI\%\-\-timing\-script\-file\fP and \fI\%\-\-rps\fP are
mutually exclusive.
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
@ -290,6 +291,12 @@ in <URI>.
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-rps=<N>
Specify request per second for each client. \fI\%\-\-rps\fP and
\fI\%\-\-timing\-script\-file\fP are mutually exclusive.
.UNINDENT
.INDENT 0.0
.TP
.B \-v, \-\-verbose .B \-v, \-\-verbose
Output debug information. Output debug information.
.UNINDENT .UNINDENT

10
doc/h2load.1.rst
View File

@ -134,7 +134,7 @@ OPTIONS
the rate option is not used. The default value for this the rate option is not used. The default value for this
option is 1s. option is 1s.
.. option:: -D, --duration=<N> .. option:: -D, --duration=<DURATION>
Specifies the main duration for the measurements in case Specifies the main duration for the measurements in case
of timing-based benchmarking. :option:`-D` and :option:`\-r` are mutually of timing-based benchmarking. :option:`-D` and :option:`\-r` are mutually
@ -183,7 +183,8 @@ OPTIONS
port defined in the first URI are used solely. Values port defined in the first URI are used solely. Values
contained in other URIs, if present, are ignored. contained in other URIs, if present, are ignored.
Definition of a base URI overrides all scheme, host or Definition of a base URI overrides all scheme, host or
port values. port values. :option:`--timing-script-file` and :option:`\--rps` are
mutually exclusive.
.. option:: -B, --base-uri=(<URI>|unix:<PATH>) .. option:: -B, --base-uri=(<URI>|unix:<PATH>)
@ -244,6 +245,11 @@ OPTIONS
Host and port to connect instead of using the authority Host and port to connect instead of using the authority
in <URI>. in <URI>.
.. option:: --rps=<N>
Specify request per second for each client. :option:`--rps` and
:option:`--timing-script-file` are mutually exclusive.
.. option:: -v, --verbose .. option:: -v, --verbose
Output debug information. Output debug information.

2
doc/nghttp.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTP" "1" "Feb 02, 2021" "1.43.0" "nghttp2" .TH "NGHTTP" "1" "Apr 02, 2021" "1.44.0-DEV" "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 02, 2021" "1.43.0" "nghttp2" .TH "NGHTTPD" "1" "Apr 02, 2021" "1.44.0-DEV" "nghttp2"
.SH NAME .SH NAME
nghttpd \- HTTP/2 server nghttpd \- HTTP/2 server
. .

30
doc/nghttpx.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPX" "1" "Feb 02, 2021" "1.43.0" "nghttp2" .TH "NGHTTPX" "1" "Apr 02, 2021" "1.44.0-DEV" "nghttp2"
.SH NAME .SH NAME
nghttpx \- HTTP/2 proxy nghttpx \- HTTP/2 proxy
. .
@ -1006,19 +1006,19 @@ Default: \fB1s\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-no\-http2\-cipher\-black\-list .B \-\-no\-http2\-cipher\-block\-list
Allow black listed cipher suite on frontend HTTP/2 Allow block listed cipher suite on frontend HTTP/2
connection. See connection. See
\fI\%https://tools.ietf.org/html/rfc7540#appendix\-A\fP for the \fI\%https://tools.ietf.org/html/rfc7540#appendix\-A\fP for the
complete HTTP/2 cipher suites black list. complete HTTP/2 cipher suites block list.
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-client\-no\-http2\-cipher\-black\-list .B \-\-client\-no\-http2\-cipher\-block\-list
Allow black listed cipher suite on backend HTTP/2 Allow block listed cipher suite on backend HTTP/2
connection. See connection. See
\fI\%https://tools.ietf.org/html/rfc7540#appendix\-A\fP for the \fI\%https://tools.ietf.org/html/rfc7540#appendix\-A\fP for the
complete HTTP/2 cipher suites black list. complete HTTP/2 cipher suites block list.
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
@ -1043,9 +1043,9 @@ in hex. An empty line, and line which starts with \(aq#\(aq
are skipped. The default enabled cipher list might not are skipped. The default enabled cipher list might not
contain any PSK cipher suite. In that case, desired PSK contain any PSK cipher suite. In that case, desired PSK
cipher suites must be enabled using \fI\%\-\-ciphers\fP option. cipher suites must be enabled using \fI\%\-\-ciphers\fP option.
The desired PSK cipher suite may be black listed by The desired PSK cipher suite may be block listed by
HTTP/2. To use those cipher suites with HTTP/2, HTTP/2. To use those cipher suites with HTTP/2,
consider to use \fI\%\-\-no\-http2\-cipher\-black\-list\fP option. consider to use \fI\%\-\-no\-http2\-cipher\-block\-list\fP option.
But be aware its implications. But be aware its implications.
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
@ -1060,9 +1060,9 @@ The first identity and secret pair encountered is used.
The default enabled cipher list might not contain any The default enabled cipher list might not contain any
PSK cipher suite. In that case, desired PSK cipher PSK cipher suite. In that case, desired PSK cipher
suites must be enabled using \fI\%\-\-client\-ciphers\fP option. suites must be enabled using \fI\%\-\-client\-ciphers\fP option.
The desired PSK cipher suite may be black listed by The desired PSK cipher suite may be block listed by
HTTP/2. To use those cipher suites with HTTP/2, 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\-block\-list\fP
option. But be aware its implications. option. But be aware its implications.
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
@ -1669,10 +1669,10 @@ be used to drop root privileges.
.B \-\-single\-process .B \-\-single\-process
Run this program in a single process mode for debugging Run this program in a single process mode for debugging
purpose. Without this option, nghttpx creates at least purpose. Without this option, nghttpx creates at least
2 processes: master and worker processes. If this 2 processes: main and worker processes. If this option
option is used, master and worker are unified into a is used, main and worker are unified into a single
single process. nghttpx still spawns additional process process. nghttpx still spawns additional process if
if neverbleed is used. In the single process mode, the neverbleed is used. In the single process mode, the
signal handling feature is disabled. signal handling feature is disabled.
.UNINDENT .UNINDENT
.SS Scripting .SS Scripting

28
doc/nghttpx.1.rst
View File

@ -925,19 +925,19 @@ SSL/TLS
Default: ``1s`` Default: ``1s``
.. option:: --no-http2-cipher-black-list .. option:: --no-http2-cipher-block-list
Allow black listed cipher suite on frontend HTTP/2 Allow block listed cipher suite on frontend HTTP/2
connection. See connection. See
https://tools.ietf.org/html/rfc7540#appendix-A for the https://tools.ietf.org/html/rfc7540#appendix-A for the
complete HTTP/2 cipher suites black list. complete HTTP/2 cipher suites block list.
.. option:: --client-no-http2-cipher-black-list .. option:: --client-no-http2-cipher-block-list
Allow black listed cipher suite on backend HTTP/2 Allow block listed cipher suite on backend HTTP/2
connection. See connection. See
https://tools.ietf.org/html/rfc7540#appendix-A for the https://tools.ietf.org/html/rfc7540#appendix-A for the
complete HTTP/2 cipher suites black list. complete HTTP/2 cipher suites block list.
.. option:: --tls-sct-dir=<DIR> .. option:: --tls-sct-dir=<DIR>
@ -960,9 +960,9 @@ SSL/TLS
are skipped. The default enabled cipher list might not are skipped. The default enabled cipher list might not
contain any PSK cipher suite. In that case, desired PSK contain any PSK cipher suite. In that case, desired PSK
cipher suites must be enabled using :option:`--ciphers` option. cipher suites must be enabled using :option:`--ciphers` option.
The desired PSK cipher suite may be black listed by The desired PSK cipher suite may be block listed by
HTTP/2. To use those cipher suites with HTTP/2, HTTP/2. To use those cipher suites with HTTP/2,
consider to use :option:`--no-http2-cipher-black-list` option. consider to use :option:`--no-http2-cipher-block-list` option.
But be aware its implications. But be aware its implications.
.. option:: --client-psk-secrets=<PATH> .. option:: --client-psk-secrets=<PATH>
@ -976,9 +976,9 @@ SSL/TLS
The default enabled cipher list might not contain any The default enabled cipher list might not contain any
PSK cipher suite. In that case, desired PSK cipher PSK cipher suite. In that case, desired PSK cipher
suites must be enabled using :option:`--client-ciphers` option. suites must be enabled using :option:`--client-ciphers` option.
The desired PSK cipher suite may be black listed by The desired PSK cipher suite may be block listed by
HTTP/2. To use those cipher suites with HTTP/2, HTTP/2. To use those cipher suites with HTTP/2,
consider to use :option:`--client-no-http2-cipher-black-list` consider to use :option:`--client-no-http2-cipher-block-list`
option. But be aware its implications. option. But be aware its implications.
.. option:: --tls-no-postpone-early-data .. option:: --tls-no-postpone-early-data
@ -1520,10 +1520,10 @@ Process
Run this program in a single process mode for debugging Run this program in a single process mode for debugging
purpose. Without this option, nghttpx creates at least purpose. Without this option, nghttpx creates at least
2 processes: master and worker processes. If this 2 processes: main and worker processes. If this option
option is used, master and worker are unified into a is used, main and worker are unified into a single
single process. nghttpx still spawns additional process process. nghttpx still spawns additional process if
if neverbleed is used. In the single process mode, the neverbleed is used. In the single process mode, the
signal handling feature is disabled. signal handling feature is disabled.