From 789eb8a5902f07e47bc1a3e9af47a5da0aac64d1 Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Sun, 30 Aug 2015 00:24:11 +0900 Subject: [PATCH] Update man pages --- doc/h2load.1 | 62 +++++++++++++++++++++++++++++++++++++++++++++--- doc/h2load.1.rst | 55 ++++++++++++++++++++++++++++++++++++++++-- doc/nghttp.1 | 2 +- doc/nghttpd.1 | 2 +- doc/nghttpx.1 | 2 +- 5 files changed, 115 insertions(+), 8 deletions(-) diff --git a/doc/h2load.1 b/doc/h2load.1 index 9ab126c4..0c827c29 100644 --- a/doc/h2load.1 +++ b/doc/h2load.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "H2LOAD" "1" "August 14, 2015" "1.2.1" "nghttp2" +.TH "H2LOAD" "1" "August 30, 2015" "1.2.2-DEV" "nghttp2" .SH NAME h2load \- HTTP/2 benchmarking tool . @@ -44,7 +44,8 @@ URIs are used in this order for each client. All URIs are used, then first URI is used and then 2nd URI, and so on. The scheme, host and port in the subsequent URIs, if present, are ignored. Those in the first URI -are used solely. +are used solely. Definition of a base URI overrides all +scheme, host or port values. .UNINDENT .SH OPTIONS .INDENT 0.0 @@ -78,7 +79,8 @@ URIs are used in this order for each client. All URIs are used, then first URI is used and then 2nd URI, and so on. The scheme, host and port in the subsequent URIs, if present, are ignored. Those in the first URI -are used solely. +are used solely. Definition of a base URI overrides all +scheme, host or port values. .UNINDENT .INDENT 0.0 .TP @@ -158,6 +160,55 @@ the \fI\%\-C\fP option is being used. .UNINDENT .INDENT 0.0 .TP +.B \-T, \-\-connection\-active\-timeout= +Specifies the maximum time that h2load is willing to +keep a connection open, regardless of the activity on +said connection. must be a positive integer, +specifying the number of seconds to wait. When no +timeout value is set (either active or inactive), h2load +will keep a connection open indefinitely, waiting for a +response. +.UNINDENT +.INDENT 0.0 +.TP +.B \-N, \-\-connection\-inactivity\-timeout= +Specifies the amount of time that h2load is willing to +wait to see activity on a given connection. must be +a positive integer, specifying the number of seconds to +wait. When no timeout value is set (either active or +inactive), h2load will keep a connection open +indefinitely, waiting for a response. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-timing\-script\-file= +Path of a file containing one or more lines separated by +EOLs. Each script line is composed of two tab\-separated +fields. The first field represents the time offset from +the start of execution, expressed as milliseconds with +microsecond resolution. The second field represents the +URI. This option will disable URIs getting from +command\-line. If \(aq\-\(aq is given as , script lines +will be read from stdin. Script lines are used in order +for each client. If \fI\%\-n\fP is given, it must be less than +or equal to the number of script lines, larger values are +clamped to the number of script lines. If \fI\%\-n\fP is +not given, the number of requests will default to the +number of script lines. The scheme, host and port defined +in the first URI are used solely. Values contained in +other URIs, if present, are ignored. Definition of a +base URI overrides all scheme, host or port values. +.UNINDENT +.INDENT 0.0 +.TP +.B \-B, \-\-base\-uri= +Specify URI from which the scheme, host and port will be +used for all requests. The base URI overrides all +values defined either at the command line or inside +input files. +.UNINDENT +.INDENT 0.0 +.TP .B \-v, \-\-verbose Output debug information. .UNINDENT @@ -199,6 +250,11 @@ The number of requests failed, except for HTTP level failures. This is the subset of the number reported in \fBfailed\fP and most likely the network level failures or stream was reset by RST_STREAM. +.TP +.B timeout +The number of requests whose connection timed out before they were +completed. This is the subset of the number reported in +\fBerrored\fP\&. .UNINDENT .TP .B status codes diff --git a/doc/h2load.1.rst b/doc/h2load.1.rst index 0f9aaa3f..08804352 100644 --- a/doc/h2load.1.rst +++ b/doc/h2load.1.rst @@ -23,7 +23,8 @@ benchmarking tool for HTTP/2 and SPDY server are used, then first URI is used and then 2nd URI, and so on. The scheme, host and port in the subsequent URIs, if present, are ignored. Those in the first URI - are used solely. + are used solely. Definition of a base URI overrides all + scheme, host or port values. OPTIONS ------- @@ -55,7 +56,8 @@ OPTIONS are used, then first URI is used and then 2nd URI, and so on. The scheme, host and port in the subsequent URIs, if present, are ignored. Those in the first URI - are used solely. + are used solely. Definition of a base URI overrides all + scheme, host or port values. .. option:: -m, --max-concurrent-streams=(auto|) @@ -124,6 +126,51 @@ OPTIONS for this option is 0. The :option:`-n` option is not required if the :option:`-C` option is being used. +.. option:: -T, --connection-active-timeout= + + Specifies the maximum time that h2load is willing to + keep a connection open, regardless of the activity on + said connection. must be a positive integer, + specifying the number of seconds to wait. When no + timeout value is set (either active or inactive), h2load + will keep a connection open indefinitely, waiting for a + response. + +.. option:: -N, --connection-inactivity-timeout= + + Specifies the amount of time that h2load is willing to + wait to see activity on a given connection. must be + a positive integer, specifying the number of seconds to + wait. When no timeout value is set (either active or + inactive), h2load will keep a connection open + indefinitely, waiting for a response. + +.. option:: --timing-script-file= + + Path of a file containing one or more lines separated by + EOLs. Each script line is composed of two tab-separated + fields. The first field represents the time offset from + the start of execution, expressed as milliseconds with + microsecond resolution. The second field represents the + URI. This option will disable URIs getting from + command-line. If '-' is given as , script lines + will be read from stdin. Script lines are used in order + for each client. If :option:`-n` is given, it must be less than + or equal to the number of script lines, larger values are + clamped to the number of script lines. If :option:`-n` is + not given, the number of requests will default to the + number of script lines. The scheme, host and port defined + in the first URI are used solely. Values contained in + other URIs, if present, are ignored. Definition of a + base URI overrides all scheme, host or port values. + +.. option:: -B, --base-uri= + + Specify URI from which the scheme, host and port will be + used for all requests. The base URI overrides all + values defined either at the command line or inside + input files. + .. option:: -v, --verbose Output debug information. @@ -157,6 +204,10 @@ requests This is the subset of the number reported in ``failed`` and most likely the network level failures or stream was reset by RST_STREAM. + timeout + The number of requests whose connection timed out before they were + completed. This is the subset of the number reported in + ``errored``. status codes The number of status code h2load received. diff --git a/doc/nghttp.1 b/doc/nghttp.1 index 784a29f0..b2bda81d 100644 --- a/doc/nghttp.1 +++ b/doc/nghttp.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTP" "1" "August 14, 2015" "1.2.1" "nghttp2" +.TH "NGHTTP" "1" "August 30, 2015" "1.2.2-DEV" "nghttp2" .SH NAME nghttp \- HTTP/2 experimental client . diff --git a/doc/nghttpd.1 b/doc/nghttpd.1 index 6c70b2ef..f268d2f3 100644 --- a/doc/nghttpd.1 +++ b/doc/nghttpd.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTPD" "1" "August 14, 2015" "1.2.1" "nghttp2" +.TH "NGHTTPD" "1" "August 30, 2015" "1.2.2-DEV" "nghttp2" .SH NAME nghttpd \- HTTP/2 experimental server . diff --git a/doc/nghttpx.1 b/doc/nghttpx.1 index 46be65f5..400d92d2 100644 --- a/doc/nghttpx.1 +++ b/doc/nghttpx.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTPX" "1" "August 14, 2015" "1.2.1" "nghttp2" +.TH "NGHTTPX" "1" "August 30, 2015" "1.2.2-DEV" "nghttp2" .SH NAME nghttpx \- HTTP/2 experimental proxy .