Update man pages

This commit is contained in:
Tatsuhiro Tsujikawa 2015-08-09 01:13:35 +09:00
parent a67d15be58
commit 66f2097627
6 changed files with 28 additions and 26 deletions

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "H2LOAD" "1" "July 28, 2015" "1.1.3-DEV" "nghttp2" .TH "H2LOAD" "1" "August 09, 2015" "1.2.0" "nghttp2"
.SH NAME .SH NAME
h2load \- HTTP/2 benchmarking tool h2load \- HTTP/2 benchmarking tool
. .
@ -135,7 +135,7 @@ POST.
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-r, \-\-rate=<N> .B \-r, \-\-rate=<N>
Specified the fixed rate at which connections are Specifies the fixed rate at which connections are
created. The rate must be a positive integer, created. The rate must be a positive integer,
representing the number of connections to be made per representing the number of connections to be made per
second. When the rate is 0, the program will run as it second. When the rate is 0, the program will run as it
@ -148,13 +148,13 @@ rate it wants. The default value for this option is 0.
Specifies the total number of connections to create. Specifies the total number of connections to create.
The total number of connections must be a positive The total number of connections must be a positive
integer. On each connection, \fI\%\-m\fP requests are made. The integer. On each connection, \fI\%\-m\fP requests are made. The
test stops once as soon as the N connections have either test stops once as soon as the <N> connections have
completed or failed. When the number of connections is either completed or failed. When the number of
0, the program will run as it normally does, creating as connections is 0, the program will run as it normally
many connections as it needs in order to make the \fI\%\-n\fP does, creating as many connections as it needs in order
requests specified. The default value for this option to make the \fI\%\-n\fP requests specified. The default value
is 0. The \fI\%\-n\fP option is not required if the \fI\%\-C\fP option is for this option is 0. The \fI\%\-n\fP option is not required if
being used. the \fI\%\-C\fP option is being used.
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP

View File

@ -104,7 +104,7 @@ OPTIONS
.. option:: -r, --rate=<N> .. option:: -r, --rate=<N>
Specified the fixed rate at which connections are Specifies the fixed rate at which connections are
created. The rate must be a positive integer, created. The rate must be a positive integer,
representing the number of connections to be made per representing the number of connections to be made per
second. When the rate is 0, the program will run as it second. When the rate is 0, the program will run as it
@ -116,13 +116,13 @@ OPTIONS
Specifies the total number of connections to create. Specifies the total number of connections to create.
The total number of connections must be a positive The total number of connections must be a positive
integer. On each connection, :option:`-m` requests are made. The integer. On each connection, :option:`-m` requests are made. The
test stops once as soon as the N connections have either test stops once as soon as the <N> connections have
completed or failed. When the number of connections is either completed or failed. When the number of
0, the program will run as it normally does, creating as connections is 0, the program will run as it normally
many connections as it needs in order to make the :option:`-n` does, creating as many connections as it needs in order
requests specified. The default value for this option to make the :option:`-n` requests specified. The default value
is 0. The :option:`-n` option is not required if the :option:`\-C` option is for this option is 0. The :option:`-n` option is not required if
being used. the :option:`-C` option is being used.
.. option:: -v, --verbose .. option:: -v, --verbose

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTP" "1" "July 28, 2015" "1.1.3-DEV" "nghttp2" .TH "NGHTTP" "1" "August 09, 2015" "1.2.0" "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" "July 28, 2015" "1.1.3-DEV" "nghttp2" .TH "NGHTTPD" "1" "August 09, 2015" "1.2.0" "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" "July 28, 2015" "1.1.3-DEV" "nghttp2" .TH "NGHTTPX" "1" "August 09, 2015" "1.2.0" "nghttp2"
.SH NAME .SH NAME
nghttpx \- HTTP/2 experimental proxy nghttpx \- HTTP/2 experimental proxy
. .
@ -1061,9 +1061,10 @@ keep at most 12 keys.
If \fI\%\-\-tls\-ticket\-key\-memcached\fP is given, encryption keys are If \fI\%\-\-tls\-ticket\-key\-memcached\fP is given, encryption keys are
retrieved from memcached. nghttpx just reads keys from memcached; one retrieved from memcached. nghttpx just reads keys from memcached; one
has to deploy key generator program to update keys frequently (e.g., has to deploy key generator program to update keys frequently (e.g.,
every 1 hour). The memcached entry key is \fBnghttpx:tls\-ticket\-key\fP\&. every 1 hour). The example key generator tlsticketupdate.go is
The data format stored in memcached is the binary format described available under contrib directory in nghttp2 archive. The memcached
below: entry key is \fBnghttpx:tls\-ticket\-key\fP\&. The data format stored in
memcached is the binary format described below:
.INDENT 0.0 .INDENT 0.0
.INDENT 3.5 .INDENT 3.5
.sp .sp

View File

@ -972,9 +972,10 @@ keep at most 12 keys.
If :option:`--tls-ticket-key-memcached` is given, encryption keys are If :option:`--tls-ticket-key-memcached` is given, encryption keys are
retrieved from memcached. nghttpx just reads keys from memcached; one retrieved from memcached. nghttpx just reads keys from memcached; one
has to deploy key generator program to update keys frequently (e.g., has to deploy key generator program to update keys frequently (e.g.,
every 1 hour). The memcached entry key is ``nghttpx:tls-ticket-key``. every 1 hour). The example key generator tlsticketupdate.go is
The data format stored in memcached is the binary format described available under contrib directory in nghttp2 archive. The memcached
below:: entry key is ``nghttpx:tls-ticket-key``. The data format stored in
memcached is the binary format described below::
+--------------+-------+----------------+ +--------------+-------+----------------+
| VERSION (4) |LEN (2)|KEY(48 or 80) ... | VERSION (4) |LEN (2)|KEY(48 or 80) ...