Update man pages
This commit is contained in:
parent
fc17c0a618
commit
eec65826cf
47
doc/h2load.1
47
doc/h2load.1
|
@ -1,6 +1,6 @@
|
||||||
.\" Man page generated from reStructuredText.
|
.\" Man page generated from reStructuredText.
|
||||||
.
|
.
|
||||||
.TH "H2LOAD" "1" "April 27, 2015" "0.7.13" "nghttp2"
|
.TH "H2LOAD" "1" "May 07, 2015" "0.7.14-DEV" "nghttp2"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
h2load \- HTTP/2 benchmarking tool
|
h2load \- HTTP/2 benchmarking tool
|
||||||
.
|
.
|
||||||
|
@ -205,12 +205,55 @@ The maximum time taken for request and response.
|
||||||
The mean time taken for request and response.
|
The mean time taken for request and response.
|
||||||
.TP
|
.TP
|
||||||
.B sd
|
.B sd
|
||||||
The standard deviation of the time for request and response.
|
The standard deviation of the time taken for request and response.
|
||||||
.TP
|
.TP
|
||||||
.B +/\- sd
|
.B +/\- sd
|
||||||
The fraction of the number of requests within standard deviation
|
The fraction of the number of requests within standard deviation
|
||||||
range (mean +/\- sd) against total number of successful requests.
|
range (mean +/\- sd) against total number of successful requests.
|
||||||
.UNINDENT
|
.UNINDENT
|
||||||
|
.TP
|
||||||
|
.B time for connect
|
||||||
|
.INDENT 7.0
|
||||||
|
.TP
|
||||||
|
.B min
|
||||||
|
The minimum time taken to connect to a server.
|
||||||
|
.TP
|
||||||
|
.B max
|
||||||
|
The maximum time taken to connect to a server.
|
||||||
|
.TP
|
||||||
|
.B mean
|
||||||
|
The mean time taken to connect to a server.
|
||||||
|
.TP
|
||||||
|
.B sd
|
||||||
|
The standard deviation of the time taken to connect to a server.
|
||||||
|
.TP
|
||||||
|
.B +/\- sd
|
||||||
|
The fraction of the number of connections within standard
|
||||||
|
deviation range (mean +/\- sd) against total number of successful
|
||||||
|
connections.
|
||||||
|
.UNINDENT
|
||||||
|
.TP
|
||||||
|
.B time for 1st byte (of (decrypted in case of TLS) application data)
|
||||||
|
.INDENT 7.0
|
||||||
|
.TP
|
||||||
|
.B min
|
||||||
|
The minimum time taken to get 1st byte from a server.
|
||||||
|
.TP
|
||||||
|
.B max
|
||||||
|
The maximum time taken to get 1st byte from a server.
|
||||||
|
.TP
|
||||||
|
.B mean
|
||||||
|
The mean time taken to get 1st byte from a server.
|
||||||
|
.TP
|
||||||
|
.B sd
|
||||||
|
The standard deviation of the time taken to get 1st byte from a
|
||||||
|
server.
|
||||||
|
.TP
|
||||||
|
.B +/\- sd
|
||||||
|
The fraction of the number of connections within standard
|
||||||
|
deviation range (mean +/\- sd) against total number of successful
|
||||||
|
connections.
|
||||||
|
.UNINDENT
|
||||||
.UNINDENT
|
.UNINDENT
|
||||||
.SH FLOW CONTROL
|
.SH FLOW CONTROL
|
||||||
.sp
|
.sp
|
||||||
|
|
|
@ -153,11 +153,40 @@ time for request
|
||||||
mean
|
mean
|
||||||
The mean time taken for request and response.
|
The mean time taken for request and response.
|
||||||
sd
|
sd
|
||||||
The standard deviation of the time for request and response.
|
The standard deviation of the time taken for request and response.
|
||||||
+/- sd
|
+/- sd
|
||||||
The fraction of the number of requests within standard deviation
|
The fraction of the number of requests within standard deviation
|
||||||
range (mean +/- sd) against total number of successful requests.
|
range (mean +/- sd) against total number of successful requests.
|
||||||
|
|
||||||
|
time for connect
|
||||||
|
min
|
||||||
|
The minimum time taken to connect to a server.
|
||||||
|
max
|
||||||
|
The maximum time taken to connect to a server.
|
||||||
|
mean
|
||||||
|
The mean time taken to connect to a server.
|
||||||
|
sd
|
||||||
|
The standard deviation of the time taken to connect to a server.
|
||||||
|
+/- sd
|
||||||
|
The fraction of the number of connections within standard
|
||||||
|
deviation range (mean +/- sd) against total number of successful
|
||||||
|
connections.
|
||||||
|
|
||||||
|
time for 1st byte (of (decrypted in case of TLS) application data)
|
||||||
|
min
|
||||||
|
The minimum time taken to get 1st byte from a server.
|
||||||
|
max
|
||||||
|
The maximum time taken to get 1st byte from a server.
|
||||||
|
mean
|
||||||
|
The mean time taken to get 1st byte from a server.
|
||||||
|
sd
|
||||||
|
The standard deviation of the time taken to get 1st byte from a
|
||||||
|
server.
|
||||||
|
+/- sd
|
||||||
|
The fraction of the number of connections within standard
|
||||||
|
deviation range (mean +/- sd) against total number of successful
|
||||||
|
connections.
|
||||||
|
|
||||||
FLOW CONTROL
|
FLOW CONTROL
|
||||||
------------
|
------------
|
||||||
|
|
||||||
|
|
14
doc/nghttp.1
14
doc/nghttp.1
|
@ -1,6 +1,6 @@
|
||||||
.\" Man page generated from reStructuredText.
|
.\" Man page generated from reStructuredText.
|
||||||
.
|
.
|
||||||
.TH "NGHTTP" "1" "April 27, 2015" "0.7.13" "nghttp2"
|
.TH "NGHTTP" "1" "May 07, 2015" "0.7.14-DEV" "nghttp2"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
nghttp \- HTTP/2 experimental client
|
nghttp \- HTTP/2 experimental client
|
||||||
.
|
.
|
||||||
|
@ -64,8 +64,9 @@ yet.
|
||||||
.UNINDENT
|
.UNINDENT
|
||||||
.INDENT 0.0
|
.INDENT 0.0
|
||||||
.TP
|
.TP
|
||||||
.B \-t, \-\-timeout=<SEC>
|
.B \-t, \-\-timeout=<DURATION>
|
||||||
Timeout each request after <SEC> seconds.
|
Timeout each request after <DURATION>. Set 0 to disable
|
||||||
|
timeout.
|
||||||
.UNINDENT
|
.UNINDENT
|
||||||
.INDENT 0.0
|
.INDENT 0.0
|
||||||
.TP
|
.TP
|
||||||
|
@ -215,6 +216,11 @@ Display 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 h, m, s or ms
|
||||||
|
(hours, minutes, seconds and milliseconds, respectively). If a unit
|
||||||
|
is omitted, a second is used as unit.
|
||||||
.SH DEPENDENCY BASED PRIORITY
|
.SH DEPENDENCY BASED PRIORITY
|
||||||
.sp
|
.sp
|
||||||
nghttp sends priority hints to server by default unless
|
nghttp sends priority hints to server by default unless
|
||||||
|
@ -269,7 +275,7 @@ to its resource type.
|
||||||
.sp
|
.sp
|
||||||
For CSS, and Javascript files inside "head" element, they depend on
|
For CSS, and Javascript files inside "head" element, they depend on
|
||||||
stream 3 with the weight 2. The Javascript files outside "head"
|
stream 3 with the weight 2. The Javascript files outside "head"
|
||||||
element depend on stream 5 with the weight 2. The images depend on
|
element depend on stream 5 with the weight 2. The mages depend on
|
||||||
stream 11 with the weight 12. The other resources (e.g., icon) depend
|
stream 11 with the weight 12. The other resources (e.g., icon) depend
|
||||||
on stream 11 with the weight 2.
|
on stream 11 with the weight 2.
|
||||||
.SH SEE ALSO
|
.SH SEE ALSO
|
||||||
|
|
|
@ -38,9 +38,10 @@ OPTIONS
|
||||||
'index.html' is used as a filename. Not implemented
|
'index.html' is used as a filename. Not implemented
|
||||||
yet.
|
yet.
|
||||||
|
|
||||||
.. option:: -t, --timeout=<SEC>
|
.. option:: -t, --timeout=<DURATION>
|
||||||
|
|
||||||
Timeout each request after <SEC> seconds.
|
Timeout each request after <DURATION>. Set 0 to disable
|
||||||
|
timeout.
|
||||||
|
|
||||||
.. option:: -w, --window-bits=<N>
|
.. option:: -w, --window-bits=<N>
|
||||||
|
|
||||||
|
@ -168,6 +169,11 @@ OPTIONS
|
||||||
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 h, m, s or ms
|
||||||
|
(hours, minutes, seconds and milliseconds, respectively). If a unit
|
||||||
|
is omitted, a second is used as unit.
|
||||||
|
|
||||||
DEPENDENCY BASED PRIORITY
|
DEPENDENCY BASED PRIORITY
|
||||||
-------------------------
|
-------------------------
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
.\" Man page generated from reStructuredText.
|
.\" Man page generated from reStructuredText.
|
||||||
.
|
.
|
||||||
.TH "NGHTTPD" "1" "April 27, 2015" "0.7.13" "nghttp2"
|
.TH "NGHTTPD" "1" "May 07, 2015" "0.7.14-DEV" "nghttp2"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
nghttpd \- HTTP/2 experimental server
|
nghttpd \- HTTP/2 experimental server
|
||||||
.
|
.
|
||||||
|
@ -119,6 +119,14 @@ Specify 0 to disable padding.
|
||||||
.UNINDENT
|
.UNINDENT
|
||||||
.INDENT 0.0
|
.INDENT 0.0
|
||||||
.TP
|
.TP
|
||||||
|
.B \-m, \-\-max\-concurrent\-streams=<N>
|
||||||
|
Set the maximum number of the concurrent streams in one
|
||||||
|
HTTP/2 session.
|
||||||
|
.sp
|
||||||
|
Default: \fB100\fP
|
||||||
|
.UNINDENT
|
||||||
|
.INDENT 0.0
|
||||||
|
.TP
|
||||||
.B \-n, \-\-workers=<N>
|
.B \-n, \-\-workers=<N>
|
||||||
Set the number of worker threads.
|
Set the number of worker threads.
|
||||||
.sp
|
.sp
|
||||||
|
|
|
@ -85,6 +85,13 @@ OPTIONS
|
||||||
Add at most <N> bytes to a frame payload as padding.
|
Add at most <N> bytes to a frame payload as padding.
|
||||||
Specify 0 to disable padding.
|
Specify 0 to disable padding.
|
||||||
|
|
||||||
|
.. option:: -m, --max-concurrent-streams=<N>
|
||||||
|
|
||||||
|
Set the maximum number of the concurrent streams in one
|
||||||
|
HTTP/2 session.
|
||||||
|
|
||||||
|
Default: ``100``
|
||||||
|
|
||||||
.. option:: -n, --workers=<N>
|
.. option:: -n, --workers=<N>
|
||||||
|
|
||||||
Set the number of worker threads.
|
Set the number of worker threads.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
.\" Man page generated from reStructuredText.
|
.\" Man page generated from reStructuredText.
|
||||||
.
|
.
|
||||||
.TH "NGHTTPX" "1" "April 27, 2015" "0.7.13" "nghttp2"
|
.TH "NGHTTPX" "1" "May 07, 2015" "0.7.14-DEV" "nghttp2"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
nghttpx \- HTTP/2 experimental proxy
|
nghttpx \- HTTP/2 experimental proxy
|
||||||
.
|
.
|
||||||
|
@ -704,6 +704,23 @@ won\(aqt replace anything already set. This option can be
|
||||||
used several times to specify multiple header fields.
|
used several times to specify multiple header fields.
|
||||||
Example: \fI\%\-\-add\-response\-header\fP="foo: bar"
|
Example: \fI\%\-\-add\-response\-header\fP="foo: bar"
|
||||||
.UNINDENT
|
.UNINDENT
|
||||||
|
.INDENT 0.0
|
||||||
|
.TP
|
||||||
|
.B \-\-header\-field\-buffer=<SIZE>
|
||||||
|
Set maximum buffer size for incoming HTTP header field
|
||||||
|
list. This is the sum of header name and value in
|
||||||
|
bytes.
|
||||||
|
.sp
|
||||||
|
Default: \fB64K\fP
|
||||||
|
.UNINDENT
|
||||||
|
.INDENT 0.0
|
||||||
|
.TP
|
||||||
|
.B \-\-max\-header\-fields=<N>
|
||||||
|
Set maximum number of incoming HTTP header fields, which
|
||||||
|
appear in one request or response header field list.
|
||||||
|
.sp
|
||||||
|
Default: \fB100\fP
|
||||||
|
.UNINDENT
|
||||||
.SS Debug
|
.SS Debug
|
||||||
.INDENT 0.0
|
.INDENT 0.0
|
||||||
.TP
|
.TP
|
||||||
|
|
|
@ -619,6 +619,21 @@ HTTP
|
||||||
used several times to specify multiple header fields.
|
used several times to specify multiple header fields.
|
||||||
Example: :option:`--add-response-header`\="foo: bar"
|
Example: :option:`--add-response-header`\="foo: bar"
|
||||||
|
|
||||||
|
.. option:: --header-field-buffer=<SIZE>
|
||||||
|
|
||||||
|
Set maximum buffer size for incoming HTTP header field
|
||||||
|
list. This is the sum of header name and value in
|
||||||
|
bytes.
|
||||||
|
|
||||||
|
Default: ``64K``
|
||||||
|
|
||||||
|
.. option:: --max-header-fields=<N>
|
||||||
|
|
||||||
|
Set maximum number of incoming HTTP header fields, which
|
||||||
|
appear in one request or response header field list.
|
||||||
|
|
||||||
|
Default: ``100``
|
||||||
|
|
||||||
|
|
||||||
Debug
|
Debug
|
||||||
~~~~~
|
~~~~~
|
||||||
|
|
Loading…
Reference in New Issue