Update man pages

This commit is contained in:
Tatsuhiro Tsujikawa 2015-01-29 23:29:52 +09:00
parent 0a0618baac
commit 4b0b036d3b
5 changed files with 44 additions and 36 deletions

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" 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 .SH NAME
h2load \- HTTP/2 benchmarking tool h2load \- HTTP/2 benchmarking tool
. .

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" 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 .SH NAME
nghttp \- HTTP/2 experimental client nghttp \- HTTP/2 experimental client
. .

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" 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 .SH NAME
nghttpd \- HTTP/2 experimental server nghttpd \- HTTP/2 experimental server
. .

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" 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 .SH NAME
nghttpx \- HTTP/2 experimental proxy nghttpx \- HTTP/2 experimental proxy
. .
@ -237,29 +237,29 @@ Default: \fB16K\fP
.SS Timeout: .SS Timeout:
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-frontend\-http2\-read\-timeout=<SEC> .B \-\-frontend\-http2\-read\-timeout=<DURATION>
Specify read timeout for HTTP/2 and SPDY frontend Specify read timeout for HTTP/2 and SPDY frontend
connection. connection.
.sp .sp
Default: \fB180\fP Default: \fB180s\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-frontend\-read\-timeout=<SEC> .B \-\-frontend\-read\-timeout=<DURATION>
Specify read timeout for HTTP/1.1 frontend connection. Specify read timeout for HTTP/1.1 frontend connection.
.sp .sp
Default: \fB180\fP Default: \fB180s\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-frontend\-write\-timeout=<SEC> .B \-\-frontend\-write\-timeout=<DURATION>
Specify write timeout for all frontend connections. Specify write timeout for all frontend connections.
.sp .sp
Default: \fB30\fP Default: \fB30s\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-stream\-read\-timeout=<SEC> .B \-\-stream\-read\-timeout=<DURATION>
Specify read timeout for HTTP/2 and SPDY streams. 0 Specify read timeout for HTTP/2 and SPDY streams. 0
means no timeout. means no timeout.
.sp .sp
@ -267,7 +267,7 @@ Default: \fB0\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-stream\-write\-timeout=<SEC> .B \-\-stream\-write\-timeout=<DURATION>
Specify write timeout for HTTP/2 and SPDY streams. 0 Specify write timeout for HTTP/2 and SPDY streams. 0
means no timeout. means no timeout.
.sp .sp
@ -275,30 +275,30 @@ Default: \fB0\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-backend\-read\-timeout=<SEC> .B \-\-backend\-read\-timeout=<DURATION>
Specify read timeout for backend connection. Specify read timeout for backend connection.
.sp .sp
Default: \fB180\fP Default: \fB180s\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-backend\-write\-timeout=<SEC> .B \-\-backend\-write\-timeout=<DURATION>
Specify write timeout for backend connection. Specify write timeout for backend connection.
.sp .sp
Default: \fB30\fP Default: \fB30s\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-backend\-keep\-alive\-timeout=<SEC> .B \-\-backend\-keep\-alive\-timeout=<DURATION>
Specify keep\-alive timeout for backend connection. Specify keep\-alive timeout for backend connection.
.sp .sp
Default: \fB600\fP Default: \fB2s\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-listener\-disable\-timeout=<SEC> .B \-\-listener\-disable\-timeout=<DURATION>
After accepting connection failed, connection listener 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. disables this feature.
.sp .sp
Default: \fB0\fP Default: \fB0\fP
@ -734,6 +734,10 @@ Print this help and exit.
.sp .sp
The <SIZE> argument is an integer and an optional unit (e.g., 10K is The <SIZE> argument is an integer and an optional unit (e.g., 10K is
10 * 1024). Units are K, M and G (powers of 1024). 10 * 1024). Units are K, M and G (powers of 1024).
.sp
The <DURATION> 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 .SH FILES
.INDENT 0.0 .INDENT 0.0
.TP .TP

View File

@ -200,61 +200,61 @@ Performance:
Timeout: Timeout:
~~~~~~~~ ~~~~~~~~
.. option:: --frontend-http2-read-timeout=<SEC> .. option:: --frontend-http2-read-timeout=<DURATION>
Specify read timeout for HTTP/2 and SPDY frontend Specify read timeout for HTTP/2 and SPDY frontend
connection. connection.
Default: ``180`` Default: ``180s``
.. option:: --frontend-read-timeout=<SEC> .. option:: --frontend-read-timeout=<DURATION>
Specify read timeout for HTTP/1.1 frontend connection. Specify read timeout for HTTP/1.1 frontend connection.
Default: ``180`` Default: ``180s``
.. option:: --frontend-write-timeout=<SEC> .. option:: --frontend-write-timeout=<DURATION>
Specify write timeout for all frontend connections. Specify write timeout for all frontend connections.
Default: ``30`` Default: ``30s``
.. option:: --stream-read-timeout=<SEC> .. option:: --stream-read-timeout=<DURATION>
Specify read timeout for HTTP/2 and SPDY streams. 0 Specify read timeout for HTTP/2 and SPDY streams. 0
means no timeout. means no timeout.
Default: ``0`` Default: ``0``
.. option:: --stream-write-timeout=<SEC> .. option:: --stream-write-timeout=<DURATION>
Specify write timeout for HTTP/2 and SPDY streams. 0 Specify write timeout for HTTP/2 and SPDY streams. 0
means no timeout. means no timeout.
Default: ``0`` Default: ``0``
.. option:: --backend-read-timeout=<SEC> .. option:: --backend-read-timeout=<DURATION>
Specify read timeout for backend connection. Specify read timeout for backend connection.
Default: ``180`` Default: ``180s``
.. option:: --backend-write-timeout=<SEC> .. option:: --backend-write-timeout=<DURATION>
Specify write timeout for backend connection. Specify write timeout for backend connection.
Default: ``30`` Default: ``30s``
.. option:: --backend-keep-alive-timeout=<SEC> .. option:: --backend-keep-alive-timeout=<DURATION>
Specify keep-alive timeout for backend connection. Specify keep-alive timeout for backend connection.
Default: ``600`` Default: ``2s``
.. option:: --listener-disable-timeout=<SEC> .. option:: --listener-disable-timeout=<DURATION>
After accepting connection failed, connection listener 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. disables this feature.
Default: ``0`` Default: ``0``
@ -653,6 +653,10 @@ Misc:
The <SIZE> argument is an integer and an optional unit (e.g., 10K is The <SIZE> argument is an integer and an optional unit (e.g., 10K is
10 * 1024). Units are K, M and G (powers of 1024). 10 * 1024). Units are K, M and G (powers of 1024).
The <DURATION> 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 FILES
----- -----