From 44672e437a2f0afb0e9e5695e9f894dbac7b1efc Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Sun, 31 Jul 2016 21:16:34 +0900 Subject: [PATCH] Update man pages --- doc/h2load.1 | 2 +- doc/nghttp.1 | 11 +++++++---- doc/nghttp.1.rst | 9 ++++++--- doc/nghttpd.1 | 2 +- doc/nghttpx.1 | 11 +++++++++-- doc/nghttpx.1.rst | 9 ++++++++- 6 files changed, 32 insertions(+), 12 deletions(-) diff --git a/doc/h2load.1 b/doc/h2load.1 index 4b1b81ea..dd63c682 100644 --- a/doc/h2load.1 +++ b/doc/h2load.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "H2LOAD" "1" "Jul 21, 2016" "1.13.0" "nghttp2" +.TH "H2LOAD" "1" "Jul 31, 2016" "1.14.0-DEV" "nghttp2" .SH NAME h2load \- HTTP/2 benchmarking tool . diff --git a/doc/nghttp.1 b/doc/nghttp.1 index e1273080..5d3f3eaa 100644 --- a/doc/nghttp.1 +++ b/doc/nghttp.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTP" "1" "Jul 21, 2016" "1.13.0" "nghttp2" +.TH "NGHTTP" "1" "Jul 31, 2016" "1.14.0-DEV" "nghttp2" .SH NAME nghttp \- HTTP/2 client . @@ -142,10 +142,13 @@ HTTP upgrade request is performed with OPTIONS method. .INDENT 0.0 .TP .B \-p, \-\-weight= -Sets priority group weight. The valid value range is +Sets weight of given URI. This option can be used +multiple times, and N\-th \fI\%\-p\fP option sets weight of N\-th +URI in the command line. If the number of \fI\%\-p\fP option is +less than the number of URI, the last \fI\%\-p\fP option value is +repeated. If there is no \fI\%\-p\fP option, default weight, 16, +is assumed. The valid value range is [1, 256], inclusive. -.sp -Default: \fB16\fP .UNINDENT .INDENT 0.0 .TP diff --git a/doc/nghttp.1.rst b/doc/nghttp.1.rst index 05c0b074..cc5c4536 100644 --- a/doc/nghttp.1.rst +++ b/doc/nghttp.1.rst @@ -107,11 +107,14 @@ OPTIONS .. option:: -p, --weight= - Sets priority group weight. The valid value range is + Sets weight of given URI. This option can be used + multiple times, and N-th :option:`-p` option sets weight of N-th + URI in the command line. If the number of :option:`-p` option is + less than the number of URI, the last :option:`-p` option value is + repeated. If there is no :option:`-p` option, default weight, 16, + is assumed. The valid value range is [1, 256], inclusive. - Default: ``16`` - .. option:: -M, --peer-max-concurrent-streams= Use as SETTINGS_MAX_CONCURRENT_STREAMS value of diff --git a/doc/nghttpd.1 b/doc/nghttpd.1 index 57d30b2a..43540382 100644 --- a/doc/nghttpd.1 +++ b/doc/nghttpd.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTPD" "1" "Jul 21, 2016" "1.13.0" "nghttp2" +.TH "NGHTTPD" "1" "Jul 31, 2016" "1.14.0-DEV" "nghttp2" .SH NAME nghttpd \- HTTP/2 server . diff --git a/doc/nghttpx.1 b/doc/nghttpx.1 index 394a71ad..c4548174 100644 --- a/doc/nghttpx.1 +++ b/doc/nghttpx.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTPX" "1" "Jul 21, 2016" "1.13.0" "nghttp2" +.TH "NGHTTPX" "1" "Jul 31, 2016" "1.14.0-DEV" "nghttp2" .SH NAME nghttpx \- HTTP/2 proxy . @@ -1278,6 +1278,9 @@ Shutdown gracefully. First accept pending connections and stop accepting connection. After all connections are handled, nghttpx exits. .TP +.B SIGHUP +Reload configuration file given in \fI\%\-\-conf\fP\&. +.TP .B SIGUSR1 Reopen log files. .TP @@ -1285,7 +1288,11 @@ Reopen log files. Fork and execute nghttpx. It will execute the binary in the same path with same command\-line arguments and environment variables. After new process comes up, sending SIGQUIT to the original process -to perform hot swapping. +to perform hot swapping. The difference between SIGUSR2 + SIGQUIT +and SIGHUP is that former is usually used to execute new binary, and +the master process is newly spawned. On the other hand, the latter +just reloads configuration file, and the same master process +continues to exist. .UNINDENT .sp \fBNOTE:\fP diff --git a/doc/nghttpx.1.rst b/doc/nghttpx.1.rst index b11dda64..20236781 100644 --- a/doc/nghttpx.1.rst +++ b/doc/nghttpx.1.rst @@ -1163,6 +1163,9 @@ SIGQUIT accepting connection. After all connections are handled, nghttpx exits. +SIGHUP + Reload configuration file given in :option:`--conf`. + SIGUSR1 Reopen log files. @@ -1170,7 +1173,11 @@ SIGUSR2 Fork and execute nghttpx. It will execute the binary in the same path with same command-line arguments and environment variables. After new process comes up, sending SIGQUIT to the original process - to perform hot swapping. + to perform hot swapping. The difference between SIGUSR2 + SIGQUIT + and SIGHUP is that former is usually used to execute new binary, and + the master process is newly spawned. On the other hand, the latter + just reloads configuration file, and the same master process + continues to exist. .. note::