Update manual pages
This commit is contained in:
parent
0cc7c598ff
commit
1745a30644
|
@ -1,6 +1,6 @@
|
||||||
.\" Man page generated from reStructuredText.
|
.\" Man page generated from reStructuredText.
|
||||||
.
|
.
|
||||||
.TH "H2LOAD" "1" "Sep 23, 2021" "1.46.0-DEV" "nghttp2"
|
.TH "H2LOAD" "1" "Oct 17, 2021" "1.46.0" "nghttp2"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
h2load \- HTTP/2 benchmarking tool
|
h2load \- HTTP/2 benchmarking tool
|
||||||
.
|
.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
.\" Man page generated from reStructuredText.
|
.\" Man page generated from reStructuredText.
|
||||||
.
|
.
|
||||||
.TH "NGHTTP" "1" "Sep 23, 2021" "1.46.0-DEV" "nghttp2"
|
.TH "NGHTTP" "1" "Oct 17, 2021" "1.46.0" "nghttp2"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
nghttp \- HTTP/2 client
|
nghttp \- HTTP/2 client
|
||||||
.
|
.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
.\" Man page generated from reStructuredText.
|
.\" Man page generated from reStructuredText.
|
||||||
.
|
.
|
||||||
.TH "NGHTTPD" "1" "Sep 23, 2021" "1.46.0-DEV" "nghttp2"
|
.TH "NGHTTPD" "1" "Oct 17, 2021" "1.46.0" "nghttp2"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
nghttpd \- HTTP/2 server
|
nghttpd \- HTTP/2 server
|
||||||
.
|
.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
.\" Man page generated from reStructuredText.
|
.\" Man page generated from reStructuredText.
|
||||||
.
|
.
|
||||||
.TH "NGHTTPX" "1" "Sep 23, 2021" "1.46.0-DEV" "nghttp2"
|
.TH "NGHTTPX" "1" "Oct 17, 2021" "1.46.0" "nghttp2"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
nghttpx \- HTTP/2 proxy
|
nghttpx \- HTTP/2 proxy
|
||||||
.
|
.
|
||||||
|
@ -503,6 +503,15 @@ Default: \fB0\fP
|
||||||
.UNINDENT
|
.UNINDENT
|
||||||
.INDENT 0.0
|
.INDENT 0.0
|
||||||
.TP
|
.TP
|
||||||
|
.B \-\-rlimit\-memlock=<N>
|
||||||
|
Set maximum number of bytes of memory that may be locked
|
||||||
|
into RAM. If 0 is given, nghttpx does not set the
|
||||||
|
limit.
|
||||||
|
.sp
|
||||||
|
Default: \fB0\fP
|
||||||
|
.UNINDENT
|
||||||
|
.INDENT 0.0
|
||||||
|
.TP
|
||||||
.B \-\-backend\-request\-buffer=<SIZE>
|
.B \-\-backend\-request\-buffer=<SIZE>
|
||||||
Set buffer size used to store backend request.
|
Set buffer size used to store backend request.
|
||||||
.sp
|
.sp
|
||||||
|
@ -1705,6 +1714,33 @@ process. nghttpx still spawns additional process 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
|
||||||
|
.INDENT 0.0
|
||||||
|
.TP
|
||||||
|
.B \-\-max\-worker\-processes=<N>
|
||||||
|
The maximum number of worker processes. nghttpx spawns
|
||||||
|
new worker process when it reloads its configuration.
|
||||||
|
The previous worker process enters graceful termination
|
||||||
|
period and will terminate when it finishes handling the
|
||||||
|
existing connections. However, if reloading
|
||||||
|
configurations happen very frequently, the worker
|
||||||
|
processes might be piled up if they take a bit long time
|
||||||
|
to finish the existing connections. With this option,
|
||||||
|
if the number of worker processes exceeds the given
|
||||||
|
value, the oldest worker process is terminated
|
||||||
|
immediately. Specifying 0 means no limit and it is the
|
||||||
|
default behaviour.
|
||||||
|
.UNINDENT
|
||||||
|
.INDENT 0.0
|
||||||
|
.TP
|
||||||
|
.B \-\-worker\-process\-grace\-shutdown\-period=<DURATION>
|
||||||
|
Maximum period for a worker process to terminate
|
||||||
|
gracefully. When a worker process enters in graceful
|
||||||
|
shutdown period (e.g., when nghttpx reloads its
|
||||||
|
configuration) and it does not finish handling the
|
||||||
|
existing connections in the given period of time, it is
|
||||||
|
immediately terminated. Specifying 0 means no limit and
|
||||||
|
it is the default behaviour.
|
||||||
|
.UNINDENT
|
||||||
.SS Scripting
|
.SS Scripting
|
||||||
.INDENT 0.0
|
.INDENT 0.0
|
||||||
.TP
|
.TP
|
||||||
|
@ -1808,13 +1844,20 @@ internally on startup and reload.
|
||||||
Specify server ID encoded in Connection ID to identify
|
Specify server ID encoded in Connection ID to identify
|
||||||
this particular server instance. Connection ID is
|
this particular server instance. Connection ID is
|
||||||
encrypted and this part is not visible in public. It
|
encrypted and this part is not visible in public. It
|
||||||
must be 2 bytes long and must be encoded in hex string
|
must be 4 bytes long and must be encoded in hex string
|
||||||
(which is 4 bytes long). If this option is omitted, a
|
(which is 8 bytes long). If this option is omitted, a
|
||||||
random server ID is generated on startup and
|
random server ID is generated on startup and
|
||||||
configuration reload.
|
configuration reload.
|
||||||
.UNINDENT
|
.UNINDENT
|
||||||
.INDENT 0.0
|
.INDENT 0.0
|
||||||
.TP
|
.TP
|
||||||
|
.B \-\-frontend\-quic\-initial\-rtt=<DURATION>
|
||||||
|
Specify the initial RTT of the frontend QUIC connection.
|
||||||
|
.sp
|
||||||
|
Default: \fB333ms\fP
|
||||||
|
.UNINDENT
|
||||||
|
.INDENT 0.0
|
||||||
|
.TP
|
||||||
.B \-\-no\-quic\-bpf
|
.B \-\-no\-quic\-bpf
|
||||||
Disable eBPF.
|
Disable eBPF.
|
||||||
.UNINDENT
|
.UNINDENT
|
||||||
|
|
|
@ -472,6 +472,14 @@ Performance
|
||||||
|
|
||||||
Default: ``0``
|
Default: ``0``
|
||||||
|
|
||||||
|
.. option:: --rlimit-memlock=<N>
|
||||||
|
|
||||||
|
Set maximum number of bytes of memory that may be locked
|
||||||
|
into RAM. If 0 is given, nghttpx does not set the
|
||||||
|
limit.
|
||||||
|
|
||||||
|
Default: ``0``
|
||||||
|
|
||||||
.. option:: --backend-request-buffer=<SIZE>
|
.. option:: --backend-request-buffer=<SIZE>
|
||||||
|
|
||||||
Set buffer size used to store backend request.
|
Set buffer size used to store backend request.
|
||||||
|
@ -1554,6 +1562,31 @@ Process
|
||||||
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.
|
||||||
|
|
||||||
|
.. option:: --max-worker-processes=<N>
|
||||||
|
|
||||||
|
The maximum number of worker processes. nghttpx spawns
|
||||||
|
new worker process when it reloads its configuration.
|
||||||
|
The previous worker process enters graceful termination
|
||||||
|
period and will terminate when it finishes handling the
|
||||||
|
existing connections. However, if reloading
|
||||||
|
configurations happen very frequently, the worker
|
||||||
|
processes might be piled up if they take a bit long time
|
||||||
|
to finish the existing connections. With this option,
|
||||||
|
if the number of worker processes exceeds the given
|
||||||
|
value, the oldest worker process is terminated
|
||||||
|
immediately. Specifying 0 means no limit and it is the
|
||||||
|
default behaviour.
|
||||||
|
|
||||||
|
.. option:: --worker-process-grace-shutdown-period=<DURATION>
|
||||||
|
|
||||||
|
Maximum period for a worker process to terminate
|
||||||
|
gracefully. When a worker process enters in graceful
|
||||||
|
shutdown period (e.g., when nghttpx reloads its
|
||||||
|
configuration) and it does not finish handling the
|
||||||
|
existing connections in the given period of time, it is
|
||||||
|
immediately terminated. Specifying 0 means no limit and
|
||||||
|
it is the default behaviour.
|
||||||
|
|
||||||
|
|
||||||
Scripting
|
Scripting
|
||||||
~~~~~~~~~
|
~~~~~~~~~
|
||||||
|
@ -1652,11 +1685,17 @@ HTTP/3 and QUIC
|
||||||
Specify server ID encoded in Connection ID to identify
|
Specify server ID encoded in Connection ID to identify
|
||||||
this particular server instance. Connection ID is
|
this particular server instance. Connection ID is
|
||||||
encrypted and this part is not visible in public. It
|
encrypted and this part is not visible in public. It
|
||||||
must be 2 bytes long and must be encoded in hex string
|
must be 4 bytes long and must be encoded in hex string
|
||||||
(which is 4 bytes long). If this option is omitted, a
|
(which is 8 bytes long). If this option is omitted, a
|
||||||
random server ID is generated on startup and
|
random server ID is generated on startup and
|
||||||
configuration reload.
|
configuration reload.
|
||||||
|
|
||||||
|
.. option:: --frontend-quic-initial-rtt=<DURATION>
|
||||||
|
|
||||||
|
Specify the initial RTT of the frontend QUIC connection.
|
||||||
|
|
||||||
|
Default: ``333ms``
|
||||||
|
|
||||||
.. option:: --no-quic-bpf
|
.. option:: --no-quic-bpf
|
||||||
|
|
||||||
Disable eBPF.
|
Disable eBPF.
|
||||||
|
|
Loading…
Reference in New Issue