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-09-15 22:55:21 +09:00
parent 789b7a5ff1
commit f0108ece6f
6 changed files with 112 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/h2load.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "H2LOAD" "1" "Aug 31, 2021" "1.45.0-DEV" "nghttp2" .TH "H2LOAD" "1" "Sep 15, 2021" "1.45.0-DEV" "nghttp2"
.SH NAME .SH NAME
h2load \- HTTP/2 benchmarking tool h2load \- HTTP/2 benchmarking tool
. .
@ -328,6 +328,11 @@ Disable UDP GSO.
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-max\-udp\-payload\-size=<SIZE>
Specify the maximum outgoing UDP datagram payload size.
.UNINDENT
.INDENT 0.0
.TP
.B \-v, \-\-verbose .B \-v, \-\-verbose
Output debug information. Output debug information.
.UNINDENT .UNINDENT

4
doc/h2load.1.rst
View File

@ -277,6 +277,10 @@ OPTIONS
Disable UDP GSO. Disable UDP GSO.
.. option:: --max-udp-payload-size=<SIZE>
Specify the maximum outgoing UDP datagram payload size.
.. 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" "Aug 31, 2021" "1.45.0-DEV" "nghttp2" .TH "NGHTTP" "1" "Sep 15, 2021" "1.45.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" "Aug 31, 2021" "1.45.0-DEV" "nghttp2" .TH "NGHTTPD" "1" "Sep 15, 2021" "1.45.0-DEV" "nghttp2"
.SH NAME .SH NAME
nghttpd \- HTTP/2 server nghttpd \- HTTP/2 server
. .

60
doc/nghttpx.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPX" "1" "Aug 31, 2021" "1.45.0-DEV" "nghttp2" .TH "NGHTTPX" "1" "Sep 15, 2021" "1.45.0-DEV" "nghttp2"
.SH NAME .SH NAME
nghttpx \- HTTP/2 proxy nghttpx \- HTTP/2 proxy
. .
@ -1089,12 +1089,13 @@ option. But be aware its implications.
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-tls\-no\-postpone\-early\-data .B \-\-tls\-no\-postpone\-early\-data
By default, nghttpx postpones forwarding HTTP requests By default, except for QUIC connections, nghttpx
sent in early data, including those sent in partially in postpones forwarding HTTP requests sent in early data,
it, until TLS handshake finishes. If all backend server including those sent in partially in it, until TLS
recognizes "Early\-Data" header field, using this option handshake finishes. If all backend server recognizes
makes nghttpx not postpone forwarding request and get "Early\-Data" header field, using this option makes
full potential of 0\-RTT data. nghttpx not postpone forwarding request and get full
potential of 0\-RTT data.
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
@ -1741,6 +1742,51 @@ Default: \fB/usr/local/lib/nghttp2/reuseport_kern.o\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-frontend\-quic\-early\-data
Enable early data on frontend QUIC connections. nghttpx
sends "Early\-Data" header field to a backend server if a
request is received in early data and handshake has not
finished. All backend servers should deal with possibly
replayed requests.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-frontend\-quic\-qlog\-dir=<DIR>
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".
.UNINDENT
.INDENT 0.0
.TP
.B \-\-frontend\-quic\-require\-token
Require an address validation token for a frontend QUIC
connection. Server sends a token in Retry packet or
NEW_TOKEN frame in the previous connection.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-frontend\-quic\-congestion\-controller=<CC>
Specify a congestion controller algorithm for a frontend
QUIC connection. <CC> should be either "cubic" or
"bbr".
.sp
Default: \fBcubic\fP
.UNINDENT
.INDENT 0.0
.TP
.B \-\-frontend\-quic\-connection\-id\-encryption\-key=<HEXSTRING>
Specify Connection ID encryption key. The encryption
key must be 16 bytes, and it must be encoded in hex
string (which is 32 bytes long). If this option is
omitted, new key is generated. In order to survive QUIC
connection in a configuration reload event, old and new
configuration must have this option and share the same
key.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-quic\-bpf .B \-\-no\-quic\-bpf
Disable eBPF. Disable eBPF.
.UNINDENT .UNINDENT

53
doc/nghttpx.1.rst
View File

@ -1003,12 +1003,13 @@ SSL/TLS
.. option:: --tls-no-postpone-early-data .. option:: --tls-no-postpone-early-data
By default, nghttpx postpones forwarding HTTP requests By default, except for QUIC connections, nghttpx
sent in early data, including those sent in partially in postpones forwarding HTTP requests sent in early data,
it, until TLS handshake finishes. If all backend server including those sent in partially in it, until TLS
recognizes "Early-Data" header field, using this option handshake finishes. If all backend server recognizes
makes nghttpx not postpone forwarding request and get "Early-Data" header field, using this option makes
full potential of 0-RTT data. nghttpx not postpone forwarding request and get full
potential of 0-RTT data.
.. option:: --tls-max-early-data=<SIZE> .. option:: --tls-max-early-data=<SIZE>
@ -1589,6 +1590,46 @@ HTTP/3 and QUIC
Default: ``/usr/local/lib/nghttp2/reuseport_kern.o`` Default: ``/usr/local/lib/nghttp2/reuseport_kern.o``
.. option:: --frontend-quic-early-data
Enable early data on frontend QUIC connections. nghttpx
sends "Early-Data" header field to a backend server if a
request is received in early data and handshake has not
finished. All backend servers should deal with possibly
replayed requests.
.. option:: --frontend-quic-qlog-dir=<DIR>
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".
.. option:: --frontend-quic-require-token
Require an address validation token for a frontend QUIC
connection. Server sends a token in Retry packet or
NEW_TOKEN frame in the previous connection.
.. option:: --frontend-quic-congestion-controller=<CC>
Specify a congestion controller algorithm for a frontend
QUIC connection. <CC> should be either "cubic" or
"bbr".
Default: ``cubic``
.. option:: --frontend-quic-connection-id-encryption-key=<HEXSTRING>
Specify Connection ID encryption key. The encryption
key must be 16 bytes, and it must be encoded in hex
string (which is 32 bytes long). If this option is
omitted, new key is generated. In order to survive QUIC
connection in a configuration reload event, old and new
configuration must have this option and share the same
key.
.. option:: --no-quic-bpf .. option:: --no-quic-bpf
Disable eBPF. Disable eBPF.