Update manual pages

This commit is contained in:
Tatsuhiro Tsujikawa 2017-09-20 22:41:56 +09:00
parent 0389af5724
commit 6f0ae9d49a
5 changed files with 34 additions and 6 deletions

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "H2LOAD" "1" "Aug 18, 2017" "1.25.0" "nghttp2" .TH "H2LOAD" "1" "Sep 20, 2017" "1.26.0" "nghttp2"
.SH NAME .SH NAME
h2load \- HTTP/2 benchmarking tool h2load \- HTTP/2 benchmarking tool
. .
@ -54,7 +54,9 @@ scheme, host or port values.
Number of requests across all clients. If it is used Number of requests across all clients. If it is used
with \fI\%\-\-timing\-script\-file\fP option, this option specifies with \fI\%\-\-timing\-script\-file\fP option, this option specifies
the number of requests each client performs rather than the number of requests each client performs rather than
the number of requests across all clients. the number of requests across all clients. This option
is ignored if timing\-based benchmarking is enabled (see
\fI\%\-\-duration\fP option).
.sp .sp
Default: \fB1\fP Default: \fB1\fP
.UNINDENT .UNINDENT
@ -170,6 +172,19 @@ option is 1s.
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-D, \-\-duration=<N>
Specifies the main duration for the measurements in case
of timing\-based benchmarking.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-warm\-up\-time=<DURATION>
Specifies the time period before starting the actual
measurements, in case of timing\-based benchmarking.
Needs to provided along with \fI\%\-D\fP option.
.UNINDENT
.INDENT 0.0
.TP
.B \-T, \-\-connection\-active\-timeout=<DURATION> .B \-T, \-\-connection\-active\-timeout=<DURATION>
Specifies the maximum time that h2load is willing to Specifies the maximum time that h2load is willing to
keep a connection open, regardless of the activity on keep a connection open, regardless of the activity on

View File

@ -34,7 +34,9 @@ OPTIONS
Number of requests across all clients. If it is used Number of requests across all clients. If it is used
with :option:`--timing-script-file` option, this option specifies with :option:`--timing-script-file` option, this option specifies
the number of requests each client performs rather than the number of requests each client performs rather than
the number of requests across all clients. the number of requests across all clients. This option
is ignored if timing-based benchmarking is enabled (see
:option:`--duration` option).
Default: ``1`` Default: ``1``
@ -136,6 +138,17 @@ OPTIONS
the rate option is not used. The default value for this the rate option is not used. The default value for this
option is 1s. option is 1s.
.. option:: -D, --duration=<N>
Specifies the main duration for the measurements in case
of timing-based benchmarking.
.. option:: --warm-up-time=<DURATION>
Specifies the time period before starting the actual
measurements, in case of timing-based benchmarking.
Needs to provided along with :option:`-D` option.
.. option:: -T, --connection-active-timeout=<DURATION> .. option:: -T, --connection-active-timeout=<DURATION>
Specifies the maximum time that h2load is willing to Specifies the maximum time that h2load is willing to

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTP" "1" "Aug 18, 2017" "1.25.0" "nghttp2" .TH "NGHTTP" "1" "Sep 20, 2017" "1.26.0" "nghttp2"
.SH NAME .SH NAME
nghttp \- HTTP/2 client nghttp \- HTTP/2 client
. .

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPD" "1" "Aug 18, 2017" "1.25.0" "nghttp2" .TH "NGHTTPD" "1" "Sep 20, 2017" "1.26.0" "nghttp2"
.SH NAME .SH NAME
nghttpd \- HTTP/2 server nghttpd \- HTTP/2 server
. .

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPX" "1" "Aug 18, 2017" "1.25.0" "nghttp2" .TH "NGHTTPX" "1" "Sep 20, 2017" "1.26.0" "nghttp2"
.SH NAME .SH NAME
nghttpx \- HTTP/2 proxy nghttpx \- HTTP/2 proxy
. .