From df707df21ba7f096f1636116134d420d82d61c23 Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Mon, 27 Apr 2015 22:36:34 +0900 Subject: [PATCH] Update man pages --- doc/h2load.1 | 13 ++++++++++++- doc/h2load.1.rst | 13 +++++++++++++ doc/nghttp.1 | 2 +- doc/nghttpd.1 | 2 +- doc/nghttpx.1 | 2 +- 5 files changed, 28 insertions(+), 4 deletions(-) diff --git a/doc/h2load.1 b/doc/h2load.1 index 740c3ff1..4f821e33 100644 --- a/doc/h2load.1 +++ b/doc/h2load.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "H2LOAD" "1" "April 19, 2015" "0.7.12" "nghttp2" +.TH "H2LOAD" "1" "April 27, 2015" "0.7.13-DEV" "nghttp2" .SH NAME h2load \- HTTP/2 benchmarking tool . @@ -93,6 +93,8 @@ Default: \fBauto\fP .B \-w, \-\-window\-bits= Sets the stream level initial window size to (2**)\-1. For SPDY, 2** is used instead. +.sp +Default: \fB30\fP .UNINDENT .INDENT 0.0 .TP @@ -101,6 +103,8 @@ Sets the connection level initial window size to (2**)\-1. For SPDY, if is strictly less than 16, this option is ignored. Otherwise 2** is used for SPDY. +.sp +Default: \fB30\fP .UNINDENT .INDENT 0.0 .TP @@ -208,6 +212,13 @@ The fraction of the number of requests within standard deviation range (mean +/\- sd) against total number of successful requests. .UNINDENT .UNINDENT +.SH FLOW CONTROL +.sp +h2load sets large flow control window by default, and effectively +disables flow control to avoid under utilization of server +performance. To set smaller flow control window, use \fI\%\-w\fP and +\fI\%\-W\fP options. For example, use \fB\-w16 \-W16\fP to set default +window size described in HTTP/2 and SPDY protocol specification. .SH SEE ALSO .sp \fInghttp(1)\fP, \fInghttpd(1)\fP, \fInghttpx(1)\fP diff --git a/doc/h2load.1.rst b/doc/h2load.1.rst index ff1115c8..fc70f438 100644 --- a/doc/h2load.1.rst +++ b/doc/h2load.1.rst @@ -67,6 +67,8 @@ OPTIONS Sets the stream level initial window size to (2\*\*)-1. For SPDY, 2** is used instead. + Default: ``30`` + .. option:: -W, --connection-window-bits= Sets the connection level initial window size to @@ -74,6 +76,8 @@ OPTIONS this option is ignored. Otherwise 2\*\* is used for SPDY. + Default: ``30`` + .. option:: -H, --header=
Add/Override a header to the requests. @@ -154,6 +158,15 @@ time for request The fraction of the number of requests within standard deviation range (mean +/- sd) against total number of successful requests. +FLOW CONTROL +------------ + +h2load sets large flow control window by default, and effectively +disables flow control to avoid under utilization of server +performance. To set smaller flow control window, use :option:`-w` and +:option:`-W` options. For example, use ``-w16 -W16`` to set default +window size described in HTTP/2 and SPDY protocol specification. + SEE ALSO -------- diff --git a/doc/nghttp.1 b/doc/nghttp.1 index ad6d288a..b9ea4d74 100644 --- a/doc/nghttp.1 +++ b/doc/nghttp.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTP" "1" "April 19, 2015" "0.7.12" "nghttp2" +.TH "NGHTTP" "1" "April 27, 2015" "0.7.13-DEV" "nghttp2" .SH NAME nghttp \- HTTP/2 experimental client . diff --git a/doc/nghttpd.1 b/doc/nghttpd.1 index ba26ef6c..2eb1fe3f 100644 --- a/doc/nghttpd.1 +++ b/doc/nghttpd.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTPD" "1" "April 19, 2015" "0.7.12" "nghttp2" +.TH "NGHTTPD" "1" "April 27, 2015" "0.7.13-DEV" "nghttp2" .SH NAME nghttpd \- HTTP/2 experimental server . diff --git a/doc/nghttpx.1 b/doc/nghttpx.1 index c28d83a3..0cba2e19 100644 --- a/doc/nghttpx.1 +++ b/doc/nghttpx.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTPX" "1" "April 19, 2015" "0.7.12" "nghttp2" +.TH "NGHTTPX" "1" "April 27, 2015" "0.7.13-DEV" "nghttp2" .SH NAME nghttpx \- HTTP/2 experimental proxy .