Update man pages

This commit is contained in:
Tatsuhiro Tsujikawa 2015-07-12 23:26:45 +09:00
parent 3097547491
commit 3db0badc35
5 changed files with 75 additions and 48 deletions

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "H2LOAD" "1" "July 11, 2015" "1.0.6-DEV" "nghttp2" .TH "H2LOAD" "1" "July 12, 2015" "1.0.6-DEV" "nghttp2"
.SH NAME .SH NAME
h2load \- HTTP/2 benchmarking tool h2load \- HTTP/2 benchmarking tool
. .

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTP" "1" "July 11, 2015" "1.0.6-DEV" "nghttp2" .TH "NGHTTP" "1" "July 12, 2015" "1.0.6-DEV" "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 11, 2015" "1.0.6-DEV" "nghttp2" .TH "NGHTTPD" "1" "July 12, 2015" "1.0.6-DEV" "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 11, 2015" "1.0.6-DEV" "nghttp2" .TH "NGHTTPX" "1" "July 12, 2015" "1.0.6-DEV" "nghttp2"
.SH NAME .SH NAME
nghttpx \- HTTP/2 experimental proxy nghttpx \- HTTP/2 experimental proxy
. .
@ -62,26 +62,27 @@ domain socket can be specified by prefixing path name
with "unix:" (e.g., unix:/var/run/backend.sock). with "unix:" (e.g., unix:/var/run/backend.sock).
.sp .sp
Optionally, if <PATTERN>s are given, the backend address Optionally, if <PATTERN>s are given, the backend address
is only used if request matches the pattern. If \fI\%\-s\fP, \fI\%\-p\fP, is only used if request matches the pattern. If \fI\%\-s\fP or
\fI\%\-\-client\fP or \fI\%\-\-http2\-bridge\fP is used, <PATTERN>s are \fI\%\-p\fP is used, <PATTERN>s are ignored. The pattern
ignored. The pattern matching is closely designed to matching is closely designed to ServeMux in net/http
ServeMux in net/http package of Go programming language. package of Go programming language. <PATTERN> consists
<PATTERN> consists of path, host + path or just host. of path, host + path or just host. The path must starts
The path must starts with "\fI/\fP". If it ends with "\fI/\fP", it with "\fI/\fP". If it ends with "\fI/\fP", it matches to the
matches to the request path whose prefix is the path. request path whose prefix is the path. To deal with the
To deal with the request to the directory without request to the directory without trailing slash, pattern
trailing slash, pattern which ends with "\fI/\fP" also matches which ends with "\fI/\fP" also matches the path if pattern ==
the path if pattern == path + "\fI/\fP" (e.g., pattern "\fI/foo/\fP" path + "\fI/\fP" (e.g., pattern "\fI/foo/\fP" matches path "\fI/foo\fP").
matches path "\fI/foo\fP"). If it does not end with "\fI/\fP", it If it does not end with "\fI/\fP", it performs exact match
performs exact match against the request path. If host against the request path. If host is given, it performs
is given, it performs exact match against the request exact match against the request host. If host alone is
host. If host alone is given, "\fI/\fP" is appended to it, so given, "\fI/\fP" is appended to it, so that it matches all
that it matches all paths under the host (e.g., paths under the host (e.g., specifying "nghttp2.org"
specifying "nghttp2.org" equals to "nghttp2.org/"). equals to "nghttp2.org/").
.sp .sp
Longer patterns take precedence over shorter ones, Patterns with host take precedence over path only
breaking a tie by the order of the appearance in the patterns. Then, longer patterns take precedence over
configuration. shorter ones, breaking a tie by the order of the
appearance in the configuration.
.sp .sp
If <PATTERN> is omitted, "\fI/\fP" is used as pattern, which If <PATTERN> is omitted, "\fI/\fP" is used as pattern, which
matches all paths (catch\-all pattern). The catch\-all matches all paths (catch\-all pattern). The catch\-all
@ -244,9 +245,14 @@ Default: \fB0\fP
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-backend\-http2\-connections\-per\-worker=<N> .B \-\-backend\-http2\-connections\-per\-worker=<N>
Set maximum number of HTTP/2 connections per worker. Set maximum number of backend HTTP/2 physical
The default value is 0, which means the number of connections per worker. If pattern is used in \fI\%\-b\fP
backend addresses specified by \fI\%\-b\fP option. option, this limit is applied to each pattern group (in
other words, each pattern group can have maximum <N>
HTTP/2 connections). The default value is 0, which
means that the value is adjusted to the number of
backend addresses. If pattern is used, this adjustment
is done for each pattern group.
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
@ -844,6 +850,14 @@ Default: \fB/etc/nghttpx/nghttpx.conf\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-include=<PATH>
Load additional configurations from <PATH>. File <PATH>
is read when configuration parser encountered this
option. This option can be used multiple times, or even
recursively.
.UNINDENT
.INDENT 0.0
.TP
.B \-v, \-\-version .B \-v, \-\-version
Print version and exit. Print version and exit.
.UNINDENT .UNINDENT

View File

@ -45,26 +45,27 @@ Connections
with "unix:" (e.g., unix:/var/run/backend.sock). with "unix:" (e.g., unix:/var/run/backend.sock).
Optionally, if <PATTERN>s are given, the backend address Optionally, if <PATTERN>s are given, the backend address
is only used if request matches the pattern. If :option:`-s`\, :option:`-p`\, is only used if request matches the pattern. If :option:`-s` or
:option:`--client` or :option:`\--http2-bridge` is used, <PATTERN>s are :option:`-p` is used, <PATTERN>s are ignored. The pattern
ignored. The pattern matching is closely designed to matching is closely designed to ServeMux in net/http
ServeMux in net/http package of Go programming language. package of Go programming language. <PATTERN> consists
<PATTERN> consists of path, host + path or just host. of path, host + path or just host. The path must starts
The path must starts with "*/*". If it ends with "*/*", it with "*/*". If it ends with "*/*", it matches to the
matches to the request path whose prefix is the path. request path whose prefix is the path. To deal with the
To deal with the request to the directory without request to the directory without trailing slash, pattern
trailing slash, pattern which ends with "*/*" also matches which ends with "*/*" also matches the path if pattern ==
the path if pattern == path + "*/*" (e.g., pattern "*/foo/*" path + "*/*" (e.g., pattern "*/foo/*" matches path "*/foo*").
matches path "*/foo*"). If it does not end with "*/*", it If it does not end with "*/*", it performs exact match
performs exact match against the request path. If host against the request path. If host is given, it performs
is given, it performs exact match against the request exact match against the request host. If host alone is
host. If host alone is given, "*/*" is appended to it, so given, "*/*" is appended to it, so that it matches all
that it matches all paths under the host (e.g., paths under the host (e.g., specifying "nghttp2.org"
specifying "nghttp2.org" equals to "nghttp2.org/"). equals to "nghttp2.org/").
Longer patterns take precedence over shorter ones, Patterns with host take precedence over path only
breaking a tie by the order of the appearance in the patterns. Then, longer patterns take precedence over
configuration. shorter ones, breaking a tie by the order of the
appearance in the configuration.
If <PATTERN> is omitted, "*/*" is used as pattern, which If <PATTERN> is omitted, "*/*" is used as pattern, which
matches all paths (catch-all pattern). The catch-all matches all paths (catch-all pattern). The catch-all
@ -214,9 +215,14 @@ Performance
.. option:: --backend-http2-connections-per-worker=<N> .. option:: --backend-http2-connections-per-worker=<N>
Set maximum number of HTTP/2 connections per worker. Set maximum number of backend HTTP/2 physical
The default value is 0, which means the number of connections per worker. If pattern is used in :option:`-b`
backend addresses specified by :option:`-b` option. option, this limit is applied to each pattern group (in
other words, each pattern group can have maximum <N>
HTTP/2 connections). The default value is 0, which
means that the value is adjusted to the number of
backend addresses. If pattern is used, this adjustment
is done for each pattern group.
.. option:: --backend-http1-connections-per-host=<N> .. option:: --backend-http1-connections-per-host=<N>
@ -754,6 +760,13 @@ Misc
Default: ``/etc/nghttpx/nghttpx.conf`` Default: ``/etc/nghttpx/nghttpx.conf``
.. option:: --include=<PATH>
Load additional configurations from <PATH>. File <PATH>
is read when configuration parser encountered this
option. This option can be used multiple times, or even
recursively.
.. option:: -v, --version .. option:: -v, --version
Print version and exit. Print version and exit.