Skip to content

Commit

Permalink
Update man pages
Browse files Browse the repository at this point in the history
  • Loading branch information
tatsuhiro-t committed Sep 18, 2016
1 parent e464b10 commit 2c17ec3
Show file tree
Hide file tree
Showing 7 changed files with 106 additions and 4 deletions.
2 changes: 1 addition & 1 deletion doc/h2load.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "H2LOAD" "1" "Sep 10, 2016" "1.15.0-DEV" "nghttp2"
.TH "H2LOAD" "1" "Sep 18, 2016" "1.15.0-DEV" "nghttp2"
.SH NAME
h2load \- HTTP/2 benchmarking tool
.
Expand Down
10 changes: 9 additions & 1 deletion doc/nghttp.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "NGHTTP" "1" "Sep 10, 2016" "1.15.0-DEV" "nghttp2"
.TH "NGHTTP" "1" "Sep 18, 2016" "1.15.0-DEV" "nghttp2"
.SH NAME
nghttp \- HTTP/2 client
.
Expand Down Expand Up @@ -170,6 +170,14 @@ multiple header table size change.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-encoder\-header\-table\-size=<SIZE>
Specify encoder header table size. The decoder (server)
specifies the maximum dynamic table size it accepts.
Then the negotiated dynamic table size is the minimum of
this option value and the value which server specified.
.UNINDENT
.INDENT 0.0
.TP
.B \-b, \-\-padding=<N>
Add at most <N> bytes to a frame payload as padding.
Specify 0 to disable padding.
Expand Down
7 changes: 7 additions & 0 deletions doc/nghttp.1.rst
Expand Up @@ -131,6 +131,13 @@ OPTIONS
frame payload before the last value, to simulate
multiple header table size change.

.. option:: --encoder-header-table-size=<SIZE>

Specify encoder header table size. The decoder (server)
specifies the maximum dynamic table size it accepts.
Then the negotiated dynamic table size is the minimum of
this option value and the value which server specified.

.. option:: -b, --padding=<N>

Add at most <N> bytes to a frame payload as padding.
Expand Down
10 changes: 9 additions & 1 deletion doc/nghttpd.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "NGHTTPD" "1" "Sep 10, 2016" "1.15.0-DEV" "nghttp2"
.TH "NGHTTPD" "1" "Sep 18, 2016" "1.15.0-DEV" "nghttp2"
.SH NAME
nghttpd \- HTTP/2 server
.
Expand Down Expand Up @@ -99,6 +99,14 @@ Specify decoder header table size.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-encoder\-header\-table\-size=<SIZE>
Specify encoder header table size. The decoder (client)
specifies the maximum dynamic table size it accepts.
Then the negotiated dynamic table size is the minimum of
this option value and the value which client specified.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-color
Force colored log output.
.UNINDENT
Expand Down
7 changes: 7 additions & 0 deletions doc/nghttpd.1.rst
Expand Up @@ -70,6 +70,13 @@ OPTIONS

Specify decoder header table size.

.. option:: --encoder-header-table-size=<SIZE>

Specify encoder header table size. The decoder (client)
specifies the maximum dynamic table size it accepts.
Then the negotiated dynamic table size is the minimum of
this option value and the value which client specified.

.. option:: --color

Force colored log output.
Expand Down
40 changes: 39 additions & 1 deletion doc/nghttpx.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "NGHTTPX" "1" "Sep 10, 2016" "1.15.0-DEV" "nghttp2"
.TH "NGHTTPX" "1" "Sep 18, 2016" "1.15.0-DEV" "nghttp2"
.SH NAME
nghttpx \- HTTP/2 proxy
.
Expand Down Expand Up @@ -882,6 +882,44 @@ be adjusted using \fI\%\-\-frontend\-http2\-window\-size\fP option as
well. This option is only effective on recent Linux
platform.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-frontend\-http2\-encoder\-dynamic\-table\-size=<SIZE>
Specify the maximum dynamic table size of HPACK encoder
in the frontend HTTP/2 connection. The decoder (client)
specifies the maximum dynamic table size it accepts.
Then the negotiated dynamic table size is the minimum of
this option value and the value which client specified.
.sp
Default: \fB4K\fP
.UNINDENT
.INDENT 0.0
.TP
.B \-\-frontend\-http2\-decoder\-dynamic\-table\-size=<SIZE>
Specify the maximum dynamic table size of HPACK decoder
in the frontend HTTP/2 connection.
.sp
Default: \fB4K\fP
.UNINDENT
.INDENT 0.0
.TP
.B \-\-backend\-http2\-encoder\-dynamic\-table\-size=<SIZE>
Specify the maximum dynamic table size of HPACK encoder
in the backend HTTP/2 connection. The decoder (backend)
specifies the maximum dynamic table size it accepts.
Then the negotiated dynamic table size is the minimum of
this option value and the value which backend specified.
.sp
Default: \fB4K\fP
.UNINDENT
.INDENT 0.0
.TP
.B \-\-backend\-http2\-decoder\-dynamic\-table\-size=<SIZE>
Specify the maximum dynamic table size of HPACK decoder
in the backend HTTP/2 connection.
.sp
Default: \fB4K\fP
.UNINDENT
.SS Mode
.INDENT 0.0
.TP
Expand Down
34 changes: 34 additions & 0 deletions doc/nghttpx.1.rst
Expand Up @@ -804,6 +804,40 @@ HTTP/2 and SPDY
well. This option is only effective on recent Linux
platform.

.. option:: --frontend-http2-encoder-dynamic-table-size=<SIZE>

Specify the maximum dynamic table size of HPACK encoder
in the frontend HTTP/2 connection. The decoder (client)
specifies the maximum dynamic table size it accepts.
Then the negotiated dynamic table size is the minimum of
this option value and the value which client specified.

Default: ``4K``

.. option:: --frontend-http2-decoder-dynamic-table-size=<SIZE>

Specify the maximum dynamic table size of HPACK decoder
in the frontend HTTP/2 connection.

Default: ``4K``

.. option:: --backend-http2-encoder-dynamic-table-size=<SIZE>

Specify the maximum dynamic table size of HPACK encoder
in the backend HTTP/2 connection. The decoder (backend)
specifies the maximum dynamic table size it accepts.
Then the negotiated dynamic table size is the minimum of
this option value and the value which backend specified.

Default: ``4K``

.. option:: --backend-http2-decoder-dynamic-table-size=<SIZE>

Specify the maximum dynamic table size of HPACK decoder
in the backend HTTP/2 connection.

Default: ``4K``


Mode
~~~~
Expand Down

0 comments on commit 2c17ec3

Please sign in to comment.