From 039ff29a2fb3318eace4155b3398f222000bf790 Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Wed, 23 Feb 2022 16:49:04 +0900 Subject: [PATCH] Update manual pages --- doc/h2load.1 | 21 ++++++++++++++------- doc/h2load.1.rst | 18 ++++++++++++------ doc/nghttp.1 | 2 +- doc/nghttpd.1 | 2 +- doc/nghttpx.1 | 18 ++++++++++++++---- doc/nghttpx.1.rst | 15 ++++++++++++--- 6 files changed, 54 insertions(+), 22 deletions(-) diff --git a/doc/h2load.1 b/doc/h2load.1 index 2b6c2e59..33185bdf 100644 --- a/doc/h2load.1 +++ b/doc/h2load.1 @@ -1,6 +1,6 @@ .\" 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 h2load \- HTTP/2 benchmarking tool . @@ -99,6 +99,14 @@ Default: \fB1\fP .UNINDENT .INDENT 0.0 .TP +.B \-f, \-\-max\-frame\-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= Sets the stream level initial window size to (2**)\-1. For QUIC, is capped to 26 (roughly 64MiB). @@ -121,7 +129,7 @@ Add/Override a header to the requests. .INDENT 0.0 .TP .B \-\-ciphers= -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). .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 @@ -296,11 +304,10 @@ to buffering. Status code is \-1 for failed streams. .TP .B \-\-qlog\-file\-base= Enable qlog output and specify base file name for qlogs. -Qlog is emitted for each connection. -For a given base name "base", each output file name -becomes "base.M.N.qlog" where M is worker ID and N is -client ID (e.g. "base.0.3.qlog"). -Only effective in QUIC runs. +Qlog is emitted for each connection. For a given base +name "base", each output file name becomes +"base.M.N.sqlog" where M is worker ID and N is client ID +(e.g. "base.0.3.sqlog"). Only effective in QUIC runs. .UNINDENT .INDENT 0.0 .TP diff --git a/doc/h2load.1.rst b/doc/h2load.1.rst index 66173807..ff847383 100644 --- a/doc/h2load.1.rst +++ b/doc/h2load.1.rst @@ -73,6 +73,13 @@ OPTIONS Default: ``1`` +.. option:: -f, --max-frame-size= + + Maximum frame size that the local endpoint is willing to + receive. + + Default: ``16K`` + .. option:: -w, --window-bits= Sets the stream level initial window size to (2\*\*)-1. @@ -93,7 +100,7 @@ OPTIONS .. option:: --ciphers= - 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). 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= Enable qlog output and specify base file name for qlogs. - Qlog is emitted for each connection. - For a given base name "base", each output file name - becomes "base.M.N.qlog" where M is worker ID and N is - client ID (e.g. "base.0.3.qlog"). - Only effective in QUIC runs. + Qlog is emitted for each connection. For a given base + name "base", each output file name becomes + "base.M.N.sqlog" where M is worker ID and N is client ID + (e.g. "base.0.3.sqlog"). Only effective in QUIC runs. .. option:: --connect-to=[:] diff --git a/doc/nghttp.1 b/doc/nghttp.1 index 4148abfb..b96b3a1b 100644 --- a/doc/nghttp.1 +++ b/doc/nghttp.1 @@ -1,6 +1,6 @@ .\" 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 nghttp \- HTTP/2 client . diff --git a/doc/nghttpd.1 b/doc/nghttpd.1 index 25d4f494..1fdddaa4 100644 --- a/doc/nghttpd.1 +++ b/doc/nghttpd.1 @@ -1,6 +1,6 @@ .\" 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 nghttpd \- HTTP/2 server . diff --git a/doc/nghttpx.1 b/doc/nghttpx.1 index b9e0eb3b..077708f0 100644 --- a/doc/nghttpx.1 +++ b/doc/nghttpx.1 @@ -1,6 +1,6 @@ .\" 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 nghttpx \- HTTP/2 proxy . @@ -1614,6 +1614,16 @@ field when redirect to HTTPS URI is made due to .sp Default: \fB443\fP .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 .INDENT 0.0 .TP @@ -1792,7 +1802,7 @@ Specify a directory where a qlog file is written for frontend QUIC connections. A qlog file is created per each QUIC connection. The file name is ISO8601 basic format, followed by "\-", server Source Connection ID and -".qlog". +".sqlog". .UNINDENT .INDENT 0.0 .TP @@ -1805,8 +1815,8 @@ NEW_TOKEN frame in the previous connection. .TP .B \-\-frontend\-quic\-congestion\-controller= Specify a congestion controller algorithm for a frontend -QUIC connection. should be either "cubic" or -"bbr". +QUIC connection. should be one of "cubic", "bbr", +and "bbr2". .sp Default: \fBcubic\fP .UNINDENT diff --git a/doc/nghttpx.1.rst b/doc/nghttpx.1.rst index ad7edbb9..fe77fc6a 100644 --- a/doc/nghttpx.1.rst +++ b/doc/nghttpx.1.rst @@ -1462,6 +1462,15 @@ HTTP 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 ~~~ @@ -1637,7 +1646,7 @@ HTTP/3 and QUIC frontend QUIC connections. A qlog file is created per each QUIC connection. The file name is ISO8601 basic format, followed by "-", server Source Connection ID and - ".qlog". + ".sqlog". .. option:: --frontend-quic-require-token @@ -1648,8 +1657,8 @@ HTTP/3 and QUIC .. option:: --frontend-quic-congestion-controller= Specify a congestion controller algorithm for a frontend - QUIC connection. should be either "cubic" or - "bbr". + QUIC connection. should be one of "cubic", "bbr", + and "bbr2". Default: ``cubic``