From 4b0b036d3b14a06dd37abf335ca6fdbd8eee486f Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Thu, 29 Jan 2015 23:29:52 +0900 Subject: [PATCH] Update man pages --- doc/h2load.1 | 2 +- doc/nghttp.1 | 2 +- doc/nghttpd.1 | 2 +- doc/nghttpx.1 | 38 +++++++++++++++++++++----------------- doc/nghttpx.1.rst | 36 ++++++++++++++++++++---------------- 5 files changed, 44 insertions(+), 36 deletions(-) diff --git a/doc/h2load.1 b/doc/h2load.1 index 88e08ab7..0618a081 100644 --- a/doc/h2load.1 +++ b/doc/h2load.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "H2LOAD" "1" "January 25, 2015" "0.7.3" "nghttp2" +.TH "H2LOAD" "1" "January 29, 2015" "0.7.4-DEV" "nghttp2" .SH NAME h2load \- HTTP/2 benchmarking tool . diff --git a/doc/nghttp.1 b/doc/nghttp.1 index aea61699..c332bace 100644 --- a/doc/nghttp.1 +++ b/doc/nghttp.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTP" "1" "January 25, 2015" "0.7.3" "nghttp2" +.TH "NGHTTP" "1" "January 29, 2015" "0.7.4-DEV" "nghttp2" .SH NAME nghttp \- HTTP/2 experimental client . diff --git a/doc/nghttpd.1 b/doc/nghttpd.1 index aba7acaf..3fb6b259 100644 --- a/doc/nghttpd.1 +++ b/doc/nghttpd.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTPD" "1" "January 25, 2015" "0.7.3" "nghttp2" +.TH "NGHTTPD" "1" "January 29, 2015" "0.7.4-DEV" "nghttp2" .SH NAME nghttpd \- HTTP/2 experimental server . diff --git a/doc/nghttpx.1 b/doc/nghttpx.1 index 307972df..fc75063c 100644 --- a/doc/nghttpx.1 +++ b/doc/nghttpx.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTPX" "1" "January 25, 2015" "0.7.3" "nghttp2" +.TH "NGHTTPX" "1" "January 29, 2015" "0.7.4-DEV" "nghttp2" .SH NAME nghttpx \- HTTP/2 experimental proxy . @@ -237,29 +237,29 @@ Default: \fB16K\fP .SS Timeout: .INDENT 0.0 .TP -.B \-\-frontend\-http2\-read\-timeout= +.B \-\-frontend\-http2\-read\-timeout= Specify read timeout for HTTP/2 and SPDY frontend connection. .sp -Default: \fB180\fP +Default: \fB180s\fP .UNINDENT .INDENT 0.0 .TP -.B \-\-frontend\-read\-timeout= +.B \-\-frontend\-read\-timeout= Specify read timeout for HTTP/1.1 frontend connection. .sp -Default: \fB180\fP +Default: \fB180s\fP .UNINDENT .INDENT 0.0 .TP -.B \-\-frontend\-write\-timeout= +.B \-\-frontend\-write\-timeout= Specify write timeout for all frontend connections. .sp -Default: \fB30\fP +Default: \fB30s\fP .UNINDENT .INDENT 0.0 .TP -.B \-\-stream\-read\-timeout= +.B \-\-stream\-read\-timeout= Specify read timeout for HTTP/2 and SPDY streams. 0 means no timeout. .sp @@ -267,7 +267,7 @@ Default: \fB0\fP .UNINDENT .INDENT 0.0 .TP -.B \-\-stream\-write\-timeout= +.B \-\-stream\-write\-timeout= Specify write timeout for HTTP/2 and SPDY streams. 0 means no timeout. .sp @@ -275,30 +275,30 @@ Default: \fB0\fP .UNINDENT .INDENT 0.0 .TP -.B \-\-backend\-read\-timeout= +.B \-\-backend\-read\-timeout= Specify read timeout for backend connection. .sp -Default: \fB180\fP +Default: \fB180s\fP .UNINDENT .INDENT 0.0 .TP -.B \-\-backend\-write\-timeout= +.B \-\-backend\-write\-timeout= Specify write timeout for backend connection. .sp -Default: \fB30\fP +Default: \fB30s\fP .UNINDENT .INDENT 0.0 .TP -.B \-\-backend\-keep\-alive\-timeout= +.B \-\-backend\-keep\-alive\-timeout= Specify keep\-alive timeout for backend connection. .sp -Default: \fB600\fP +Default: \fB2s\fP .UNINDENT .INDENT 0.0 .TP -.B \-\-listener\-disable\-timeout= +.B \-\-listener\-disable\-timeout= After accepting connection failed, connection listener -is disabled for a given time in seconds. Specifying 0 +is disabled for a given amount of time. Specifying 0 disables this feature. .sp Default: \fB0\fP @@ -734,6 +734,10 @@ Print this help and exit. .sp The argument is an integer and an optional unit (e.g., 10K is 10 * 1024). Units are K, M and G (powers of 1024). +.sp +The argument is an integer and an optional unit (e.g., 1s +is 1 second and 500ms is 500 milliseconds). Units are s or ms. If +a unit is omitted, a second is used as unit. .SH FILES .INDENT 0.0 .TP diff --git a/doc/nghttpx.1.rst b/doc/nghttpx.1.rst index 3d11ece8..b0ea78c4 100644 --- a/doc/nghttpx.1.rst +++ b/doc/nghttpx.1.rst @@ -200,61 +200,61 @@ Performance: Timeout: ~~~~~~~~ -.. option:: --frontend-http2-read-timeout= +.. option:: --frontend-http2-read-timeout= Specify read timeout for HTTP/2 and SPDY frontend connection. - Default: ``180`` + Default: ``180s`` -.. option:: --frontend-read-timeout= +.. option:: --frontend-read-timeout= Specify read timeout for HTTP/1.1 frontend connection. - Default: ``180`` + Default: ``180s`` -.. option:: --frontend-write-timeout= +.. option:: --frontend-write-timeout= Specify write timeout for all frontend connections. - Default: ``30`` + Default: ``30s`` -.. option:: --stream-read-timeout= +.. option:: --stream-read-timeout= Specify read timeout for HTTP/2 and SPDY streams. 0 means no timeout. Default: ``0`` -.. option:: --stream-write-timeout= +.. option:: --stream-write-timeout= Specify write timeout for HTTP/2 and SPDY streams. 0 means no timeout. Default: ``0`` -.. option:: --backend-read-timeout= +.. option:: --backend-read-timeout= Specify read timeout for backend connection. - Default: ``180`` + Default: ``180s`` -.. option:: --backend-write-timeout= +.. option:: --backend-write-timeout= Specify write timeout for backend connection. - Default: ``30`` + Default: ``30s`` -.. option:: --backend-keep-alive-timeout= +.. option:: --backend-keep-alive-timeout= Specify keep-alive timeout for backend connection. - Default: ``600`` + Default: ``2s`` -.. option:: --listener-disable-timeout= +.. option:: --listener-disable-timeout= After accepting connection failed, connection listener - is disabled for a given time in seconds. Specifying 0 + is disabled for a given amount of time. Specifying 0 disables this feature. Default: ``0`` @@ -653,6 +653,10 @@ Misc: The argument is an integer and an optional unit (e.g., 10K is 10 * 1024). Units are K, M and G (powers of 1024). +The argument is an integer and an optional unit (e.g., 1s +is 1 second and 500ms is 500 milliseconds). Units are s or ms. If +a unit is omitted, a second is used as unit. + FILES -----