From 1745a306442a8811e3c0baa48c9953fdeab8abf4 Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Sun, 17 Oct 2021 14:28:20 +0900 Subject: [PATCH] Update manual pages --- doc/h2load.1 | 2 +- doc/nghttp.1 | 2 +- doc/nghttpd.1 | 2 +- doc/nghttpx.1 | 49 ++++++++++++++++++++++++++++++++++++++++++++--- doc/nghttpx.1.rst | 43 +++++++++++++++++++++++++++++++++++++++-- 5 files changed, 90 insertions(+), 8 deletions(-) diff --git a/doc/h2load.1 b/doc/h2load.1 index 8ebff2bb..26fbb49b 100644 --- a/doc/h2load.1 +++ b/doc/h2load.1 @@ -1,6 +1,6 @@ .\" 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 h2load \- HTTP/2 benchmarking tool . diff --git a/doc/nghttp.1 b/doc/nghttp.1 index 8915a1fd..58423929 100644 --- a/doc/nghttp.1 +++ b/doc/nghttp.1 @@ -1,6 +1,6 @@ .\" 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 nghttp \- HTTP/2 client . diff --git a/doc/nghttpd.1 b/doc/nghttpd.1 index 505cf7bf..42b764f9 100644 --- a/doc/nghttpd.1 +++ b/doc/nghttpd.1 @@ -1,6 +1,6 @@ .\" 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 nghttpd \- HTTP/2 server . diff --git a/doc/nghttpx.1 b/doc/nghttpx.1 index 09d31cb0..a05490ea 100644 --- a/doc/nghttpx.1 +++ b/doc/nghttpx.1 @@ -1,6 +1,6 @@ .\" 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 nghttpx \- HTTP/2 proxy . @@ -503,6 +503,15 @@ Default: \fB0\fP .UNINDENT .INDENT 0.0 .TP +.B \-\-rlimit\-memlock= +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= Set buffer size used to store backend request. .sp @@ -1705,6 +1714,33 @@ process. nghttpx still spawns additional process if neverbleed is used. In the single process mode, the signal handling feature is disabled. .UNINDENT +.INDENT 0.0 +.TP +.B \-\-max\-worker\-processes= +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= +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 .INDENT 0.0 .TP @@ -1808,13 +1844,20 @@ internally on startup and reload. Specify server ID encoded in Connection ID to identify this particular server instance. Connection ID is encrypted and this part is not visible in public. It -must be 2 bytes long and must be encoded in hex string -(which is 4 bytes long). If this option is omitted, a +must be 4 bytes long and must be encoded in hex string +(which is 8 bytes long). If this option is omitted, a random server ID is generated on startup and configuration reload. .UNINDENT .INDENT 0.0 .TP +.B \-\-frontend\-quic\-initial\-rtt= +Specify the initial RTT of the frontend QUIC connection. +.sp +Default: \fB333ms\fP +.UNINDENT +.INDENT 0.0 +.TP .B \-\-no\-quic\-bpf Disable eBPF. .UNINDENT diff --git a/doc/nghttpx.1.rst b/doc/nghttpx.1.rst index b5e25ee2..dd22f261 100644 --- a/doc/nghttpx.1.rst +++ b/doc/nghttpx.1.rst @@ -472,6 +472,14 @@ Performance Default: ``0`` +.. option:: --rlimit-memlock= + + 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= Set buffer size used to store backend request. @@ -1554,6 +1562,31 @@ Process neverbleed is used. In the single process mode, the signal handling feature is disabled. +.. option:: --max-worker-processes= + + 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= + + 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 ~~~~~~~~~ @@ -1652,11 +1685,17 @@ HTTP/3 and QUIC Specify server ID encoded in Connection ID to identify this particular server instance. Connection ID is encrypted and this part is not visible in public. It - must be 2 bytes long and must be encoded in hex string - (which is 4 bytes long). If this option is omitted, a + must be 4 bytes long and must be encoded in hex string + (which is 8 bytes long). If this option is omitted, a random server ID is generated on startup and configuration reload. +.. option:: --frontend-quic-initial-rtt= + + Specify the initial RTT of the frontend QUIC connection. + + Default: ``333ms`` + .. option:: --no-quic-bpf Disable eBPF.