From 66f20976271d55f3646c9507af1c460ed545eaff Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Sun, 9 Aug 2015 01:13:35 +0900 Subject: [PATCH] Update man pages --- doc/h2load.1 | 18 +++++++++--------- doc/h2load.1.rst | 16 ++++++++-------- doc/nghttp.1 | 2 +- doc/nghttpd.1 | 2 +- doc/nghttpx.1 | 9 +++++---- doc/nghttpx.1.rst | 7 ++++--- 6 files changed, 28 insertions(+), 26 deletions(-) diff --git a/doc/h2load.1 b/doc/h2load.1 index 30aaa6b8..6416eb1c 100644 --- a/doc/h2load.1 +++ b/doc/h2load.1 @@ -1,6 +1,6 @@ .\" 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 h2load \- HTTP/2 benchmarking tool . @@ -135,7 +135,7 @@ POST. .INDENT 0.0 .TP .B \-r, \-\-rate= -Specified the fixed rate at which connections are +Specifies the fixed rate at which connections are created. The rate must be a positive integer, representing the number of connections to be made per 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. The total number of connections must be a positive integer. On each connection, \fI\%\-m\fP requests are made. The -test stops once as soon as the N connections have either -completed or failed. When the number of connections is -0, the program will run as it normally does, creating as -many connections as it needs in order to make the \fI\%\-n\fP -requests specified. The default value for this option -is 0. The \fI\%\-n\fP option is not required if the \fI\%\-C\fP option is -being used. +test stops once as soon as the connections have +either completed or failed. When the number of +connections is 0, the program will run as it normally +does, creating as many connections as it needs in order +to make the \fI\%\-n\fP requests specified. The default value +for this option is 0. The \fI\%\-n\fP option is not required if +the \fI\%\-C\fP option is being used. .UNINDENT .INDENT 0.0 .TP diff --git a/doc/h2load.1.rst b/doc/h2load.1.rst index 5b0ecb1f..15903963 100644 --- a/doc/h2load.1.rst +++ b/doc/h2load.1.rst @@ -104,7 +104,7 @@ OPTIONS .. option:: -r, --rate= - Specified the fixed rate at which connections are + Specifies the fixed rate at which connections are created. The rate must be a positive integer, representing the number of connections to be made per 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. The total number of connections must be a positive integer. On each connection, :option:`-m` requests are made. The - test stops once as soon as the N connections have either - completed or failed. When the number of connections is - 0, the program will run as it normally does, creating as - many connections as it needs in order to make the :option:`-n` - requests specified. The default value for this option - is 0. The :option:`-n` option is not required if the :option:`\-C` option is - being used. + test stops once as soon as the connections have + either completed or failed. When the number of + connections is 0, the program will run as it normally + does, creating as many connections as it needs in order + to make the :option:`-n` requests specified. The default value + for this option is 0. The :option:`-n` option is not required if + the :option:`-C` option is being used. .. option:: -v, --verbose diff --git a/doc/nghttp.1 b/doc/nghttp.1 index 40e4c26c..f7d9b940 100644 --- a/doc/nghttp.1 +++ b/doc/nghttp.1 @@ -1,6 +1,6 @@ .\" 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 nghttp \- HTTP/2 experimental client . diff --git a/doc/nghttpd.1 b/doc/nghttpd.1 index 5a8d100a..7c4b1064 100644 --- a/doc/nghttpd.1 +++ b/doc/nghttpd.1 @@ -1,6 +1,6 @@ .\" 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 nghttpd \- HTTP/2 experimental server . diff --git a/doc/nghttpx.1 b/doc/nghttpx.1 index 4a7d1c6f..c7812a10 100644 --- a/doc/nghttpx.1 +++ b/doc/nghttpx.1 @@ -1,6 +1,6 @@ .\" 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 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 retrieved from memcached. nghttpx just reads keys from memcached; one 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\&. -The data format stored in memcached is the binary format described -below: +every 1 hour). The example key generator tlsticketupdate.go is +available under contrib directory in nghttp2 archive. The memcached +entry key is \fBnghttpx:tls\-ticket\-key\fP\&. The data format stored in +memcached is the binary format described below: .INDENT 0.0 .INDENT 3.5 .sp diff --git a/doc/nghttpx.1.rst b/doc/nghttpx.1.rst index 6df8b31c..96e8b414 100644 --- a/doc/nghttpx.1.rst +++ b/doc/nghttpx.1.rst @@ -972,9 +972,10 @@ keep at most 12 keys. If :option:`--tls-ticket-key-memcached` is given, encryption keys are retrieved from memcached. nghttpx just reads keys from memcached; one has to deploy key generator program to update keys frequently (e.g., -every 1 hour). The memcached entry key is ``nghttpx:tls-ticket-key``. -The data format stored in memcached is the binary format described -below:: +every 1 hour). The example key generator tlsticketupdate.go is +available under contrib directory in nghttp2 archive. The memcached +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) ...