From 2aeec7703ed4551a5a5c37c1b916ad4650f09d9b Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Fri, 2 Apr 2021 22:34:59 +0900 Subject: [PATCH] Update manual pages --- doc/h2load.1 | 13 ++++++++++--- doc/h2load.1.rst | 10 ++++++++-- doc/nghttp.1 | 2 +- doc/nghttpd.1 | 2 +- doc/nghttpx.1 | 30 +++++++++++++++--------------- doc/nghttpx.1.rst | 28 ++++++++++++++-------------- 6 files changed, 49 insertions(+), 36 deletions(-) diff --git a/doc/h2load.1 b/doc/h2load.1 index 6a24ba3f..1b878d71 100644 --- a/doc/h2load.1 +++ b/doc/h2load.1 @@ -1,6 +1,6 @@ .\" 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 h2load \- HTTP/2 benchmarking tool . @@ -168,7 +168,7 @@ option is 1s. .UNINDENT .INDENT 0.0 .TP -.B \-D, \-\-duration= +.B \-D, \-\-duration= Specifies the main duration for the measurements in case of timing\-based benchmarking. \fI\%\-D\fP and \fI\%\-r\fP are mutually 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 contained in other URIs, if present, are ignored. 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 .INDENT 0.0 .TP @@ -290,6 +291,12 @@ in . .UNINDENT .INDENT 0.0 .TP +.B \-\-rps= +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 Output debug information. .UNINDENT diff --git a/doc/h2load.1.rst b/doc/h2load.1.rst index 265ae838..24036c6a 100644 --- a/doc/h2load.1.rst +++ b/doc/h2load.1.rst @@ -134,7 +134,7 @@ OPTIONS the rate option is not used. The default value for this option is 1s. -.. option:: -D, --duration= +.. option:: -D, --duration= Specifies the main duration for the measurements in case 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 contained in other URIs, if present, are ignored. 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=(|unix:) @@ -244,6 +245,11 @@ OPTIONS Host and port to connect instead of using the authority in . +.. option:: --rps= + + Specify request per second for each client. :option:`--rps` and + :option:`--timing-script-file` are mutually exclusive. + .. option:: -v, --verbose Output debug information. diff --git a/doc/nghttp.1 b/doc/nghttp.1 index 0487dbe7..7efac6b5 100644 --- a/doc/nghttp.1 +++ b/doc/nghttp.1 @@ -1,6 +1,6 @@ .\" 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 nghttp \- HTTP/2 client . diff --git a/doc/nghttpd.1 b/doc/nghttpd.1 index ff1a2222..e2a31b58 100644 --- a/doc/nghttpd.1 +++ b/doc/nghttpd.1 @@ -1,6 +1,6 @@ .\" 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 nghttpd \- HTTP/2 server . diff --git a/doc/nghttpx.1 b/doc/nghttpx.1 index ce9f624b..285a783a 100644 --- a/doc/nghttpx.1 +++ b/doc/nghttpx.1 @@ -1,6 +1,6 @@ .\" 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 nghttpx \- HTTP/2 proxy . @@ -1006,19 +1006,19 @@ Default: \fB1s\fP .UNINDENT .INDENT 0.0 .TP -.B \-\-no\-http2\-cipher\-black\-list -Allow black listed cipher suite on frontend HTTP/2 +.B \-\-no\-http2\-cipher\-block\-list +Allow block listed cipher suite on frontend HTTP/2 connection. See \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 .INDENT 0.0 .TP -.B \-\-client\-no\-http2\-cipher\-black\-list -Allow black listed cipher suite on backend HTTP/2 +.B \-\-client\-no\-http2\-cipher\-block\-list +Allow block listed cipher suite on backend HTTP/2 connection. See \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 .INDENT 0.0 .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 contain any PSK cipher suite. In that case, desired PSK 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, -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. .UNINDENT .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 PSK cipher suite. In that case, desired PSK cipher 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, -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. .UNINDENT .INDENT 0.0 @@ -1669,10 +1669,10 @@ be used to drop root privileges. .B \-\-single\-process Run this program in a single process mode for debugging purpose. Without this option, nghttpx creates at least -2 processes: master and worker processes. If this -option is used, master and worker are unified into a -single process. nghttpx still spawns additional process -if neverbleed is used. In the single process mode, the +2 processes: main and worker processes. If this option +is used, main and worker are unified into a single +process. nghttpx still spawns additional process if +neverbleed is used. In the single process mode, the signal handling feature is disabled. .UNINDENT .SS Scripting diff --git a/doc/nghttpx.1.rst b/doc/nghttpx.1.rst index 9697f7e4..42be7e83 100644 --- a/doc/nghttpx.1.rst +++ b/doc/nghttpx.1.rst @@ -925,19 +925,19 @@ SSL/TLS 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 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 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= @@ -960,9 +960,9 @@ SSL/TLS are skipped. The default enabled cipher list might not contain any PSK cipher suite. In that case, desired PSK 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, - 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. .. option:: --client-psk-secrets= @@ -976,9 +976,9 @@ SSL/TLS The default enabled cipher list might not contain any PSK cipher suite. In that case, desired PSK cipher 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, - 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:: --tls-no-postpone-early-data @@ -1520,10 +1520,10 @@ Process Run this program in a single process mode for debugging purpose. Without this option, nghttpx creates at least - 2 processes: master and worker processes. If this - option is used, master and worker are unified into a - single process. nghttpx still spawns additional process - if neverbleed is used. In the single process mode, the + 2 processes: main and worker processes. If this option + is used, main and worker are unified into a single + process. nghttpx still spawns additional process if + neverbleed is used. In the single process mode, the signal handling feature is disabled.