From ab9cc37ca05df92480a7589443ce1b9b71314998 Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Sun, 26 Jun 2016 00:04:17 +0900 Subject: [PATCH] Update man pages --- doc/h2load.1 | 2 +- doc/nghttp.1 | 2 +- doc/nghttpd.1 | 2 +- doc/nghttpx.1 | 19 +++++++++++++++++-- doc/nghttpx.1.rst | 16 +++++++++++++++- 5 files changed, 35 insertions(+), 6 deletions(-) diff --git a/doc/h2load.1 b/doc/h2load.1 index 458766d7..1c6d400c 100644 --- a/doc/h2load.1 +++ b/doc/h2load.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "H2LOAD" "1" "June 17, 2016" "1.12.0-DEV" "nghttp2" +.TH "H2LOAD" "1" "June 26, 2016" "1.12.0-DEV" "nghttp2" .SH NAME h2load \- HTTP/2 benchmarking tool . diff --git a/doc/nghttp.1 b/doc/nghttp.1 index 4b87c7e4..bb8a9b99 100644 --- a/doc/nghttp.1 +++ b/doc/nghttp.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTP" "1" "June 17, 2016" "1.12.0-DEV" "nghttp2" +.TH "NGHTTP" "1" "June 26, 2016" "1.12.0-DEV" "nghttp2" .SH NAME nghttp \- HTTP/2 client . diff --git a/doc/nghttpd.1 b/doc/nghttpd.1 index ff1f867c..08512af1 100644 --- a/doc/nghttpd.1 +++ b/doc/nghttpd.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTPD" "1" "June 17, 2016" "1.12.0-DEV" "nghttp2" +.TH "NGHTTPD" "1" "June 26, 2016" "1.12.0-DEV" "nghttp2" .SH NAME nghttpd \- HTTP/2 server . diff --git a/doc/nghttpx.1 b/doc/nghttpx.1 index 26eac946..48ecdcb9 100644 --- a/doc/nghttpx.1 +++ b/doc/nghttpx.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTPX" "1" "June 17, 2016" "1.12.0-DEV" "nghttp2" +.TH "NGHTTPX" "1" "June 26, 2016" "1.12.0-DEV" "nghttp2" .SH NAME nghttpx \- HTTP/2 proxy . @@ -192,7 +192,8 @@ This option can be used multiple times to listen to multiple addresses. .sp This option can take 0 or more parameters, which are -described below. +described below. Note that "api" and "healthmon" +parameters are mutually exclusive. .sp Optionally, TLS can be disabled by specifying "no\-tls" parameter. TLS is enabled by default. @@ -485,6 +486,20 @@ backend server. .sp Default: \fB10s\fP .UNINDENT +.INDENT 0.0 +.TP +.B \-\-backend\-max\-backoff= +Specify maximum backoff interval. This is used when +doing health check against offline backend (see "fail" +parameter in \fI\%\-\-backend\fP option). It is also used to +limit the maximum interval to temporarily disable +backend when nghttpx failed to connect to it. These +intervals are calculated using exponential backoff, and +consecutive failed attempts increase the interval. This +option caps its maximum value. +.sp +Default: \fB2m\fP +.UNINDENT .SS SSL/TLS .INDENT 0.0 .TP diff --git a/doc/nghttpx.1.rst b/doc/nghttpx.1.rst index 364a9cbc..46954b47 100644 --- a/doc/nghttpx.1.rst +++ b/doc/nghttpx.1.rst @@ -176,7 +176,8 @@ Connections multiple addresses. This option can take 0 or more parameters, which are - described below. + described below. Note that "api" and "healthmon" + parameters are mutually exclusive. Optionally, TLS can be disabled by specifying "no-tls" parameter. TLS is enabled by default. @@ -444,6 +445,19 @@ Timeout Default: ``10s`` +.. option:: --backend-max-backoff= + + Specify maximum backoff interval. This is used when + doing health check against offline backend (see "fail" + parameter in :option:`--backend` option). It is also used to + limit the maximum interval to temporarily disable + backend when nghttpx failed to connect to it. These + intervals are calculated using exponential backoff, and + consecutive failed attempts increase the interval. This + option caps its maximum value. + + Default: ``2m`` + SSL/TLS ~~~~~~~