Update man pages
This commit is contained in:
Tatsuhiro Tsujikawa
parent
3097547491
commit
3db0badc35
|
|
@ -1,6 +1,6 @@
|
|||
.\" 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
|
||||
h2load \- HTTP/2 benchmarking tool
|
||||
.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.\" 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
|
||||
nghttp \- HTTP/2 experimental client
|
||||
.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.\" 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
|
||||
nghttpd \- HTTP/2 experimental server
|
||||
.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.\" 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
|
||||
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).
|
||||
.sp
|
||||
Optionally, if <PATTERN>s are given, the backend address
|
||||
is only used if request matches the pattern. If \fI\%\-s\fP, \fI\%\-p\fP,
|
||||
\fI\%\-\-client\fP or \fI\%\-\-http2\-bridge\fP is used, <PATTERN>s are
|
||||
ignored. The pattern matching is closely designed to
|
||||
ServeMux in net/http package of Go programming language.
|
||||
<PATTERN> consists of path, host + path or just host.
|
||||
The path must starts with "\fI/\fP". If it ends with "\fI/\fP", it
|
||||
matches to the request path whose prefix is the path.
|
||||
To deal with the request to the directory without
|
||||
trailing slash, pattern which ends with "\fI/\fP" also matches
|
||||
the path if pattern == path + "\fI/\fP" (e.g., pattern "\fI/foo/\fP"
|
||||
matches path "\fI/foo\fP"). If it does not end with "\fI/\fP", it
|
||||
performs exact match against the request path. If host
|
||||
is given, it performs exact match against the request
|
||||
host. If host alone is given, "\fI/\fP" is appended to it, so
|
||||
that it matches all paths under the host (e.g.,
|
||||
specifying "nghttp2.org" equals to "nghttp2.org/").
|
||||
is only used if request matches the pattern. If \fI\%\-s\fP or
|
||||
\fI\%\-p\fP is used, <PATTERN>s are ignored. The pattern
|
||||
matching is closely designed to ServeMux in net/http
|
||||
package of Go programming language. <PATTERN> consists
|
||||
of path, host + path or just host. The path must starts
|
||||
with "\fI/\fP". If it ends with "\fI/\fP", it matches to the
|
||||
request path whose prefix is the path. To deal with the
|
||||
request to the directory without trailing slash, pattern
|
||||
which ends with "\fI/\fP" also matches the path if pattern ==
|
||||
path + "\fI/\fP" (e.g., pattern "\fI/foo/\fP" matches path "\fI/foo\fP").
|
||||
If it does not end with "\fI/\fP", it performs exact match
|
||||
against the request path. If host is given, it performs
|
||||
exact match against the request host. If host alone is
|
||||
given, "\fI/\fP" is appended to it, so that it matches all
|
||||
paths under the host (e.g., specifying "nghttp2.org"
|
||||
equals to "nghttp2.org/").
|
||||
.sp
|
||||
Longer patterns take precedence over shorter ones,
|
||||
breaking a tie by the order of the appearance in the
|
||||
configuration.
|
||||
Patterns with host take precedence over path only
|
||||
patterns. Then, longer patterns take precedence over
|
||||
shorter ones, breaking a tie by the order of the
|
||||
appearance in the configuration.
|
||||
.sp
|
||||
If <PATTERN> is omitted, "\fI/\fP" is used as pattern, which
|
||||
matches all paths (catch\-all pattern). The catch\-all
|
||||
|
|
@ -244,9 +245,14 @@ Default: \fB0\fP
|
|||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-backend\-http2\-connections\-per\-worker=<N>
|
||||
Set maximum number of HTTP/2 connections per worker.
|
||||
The default value is 0, which means the number of
|
||||
backend addresses specified by \fI\%\-b\fP option.
|
||||
Set maximum number of backend HTTP/2 physical
|
||||
connections per worker. If pattern is used in \fI\%\-b\fP
|
||||
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
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
|
|
@ -844,6 +850,14 @@ Default: \fB/etc/nghttpx/nghttpx.conf\fP
|
|||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.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
|
||||
Print version and exit.
|
||||
.UNINDENT
|
||||
|
|
|
|||
|
|
@ -45,26 +45,27 @@ Connections
|
|||
with "unix:" (e.g., unix:/var/run/backend.sock).
|
||||
|
||||
Optionally, if <PATTERN>s are given, the backend address
|
||||
is only used if request matches the pattern. If :option:`-s`\, :option:`-p`\,
|
||||
:option:`--client` or :option:`\--http2-bridge` is used, <PATTERN>s are
|
||||
ignored. The pattern matching is closely designed to
|
||||
ServeMux in net/http package of Go programming language.
|
||||
<PATTERN> consists of path, host + path or just host.
|
||||
The path must starts with "*/*". If it ends with "*/*", it
|
||||
matches to the request path whose prefix is the path.
|
||||
To deal with the request to the directory without
|
||||
trailing slash, pattern which ends with "*/*" also matches
|
||||
the path if pattern == path + "*/*" (e.g., pattern "*/foo/*"
|
||||
matches path "*/foo*"). If it does not end with "*/*", it
|
||||
performs exact match against the request path. If host
|
||||
is given, it performs exact match against the request
|
||||
host. If host alone is given, "*/*" is appended to it, so
|
||||
that it matches all paths under the host (e.g.,
|
||||
specifying "nghttp2.org" equals to "nghttp2.org/").
|
||||
is only used if request matches the pattern. If :option:`-s` or
|
||||
:option:`-p` is used, <PATTERN>s are ignored. The pattern
|
||||
matching is closely designed to ServeMux in net/http
|
||||
package of Go programming language. <PATTERN> consists
|
||||
of path, host + path or just host. The path must starts
|
||||
with "*/*". If it ends with "*/*", it matches to the
|
||||
request path whose prefix is the path. To deal with the
|
||||
request to the directory without trailing slash, pattern
|
||||
which ends with "*/*" also matches the path if pattern ==
|
||||
path + "*/*" (e.g., pattern "*/foo/*" matches path "*/foo*").
|
||||
If it does not end with "*/*", it performs exact match
|
||||
against the request path. If host is given, it performs
|
||||
exact match against the request host. If host alone is
|
||||
given, "*/*" is appended to it, so that it matches all
|
||||
paths under the host (e.g., specifying "nghttp2.org"
|
||||
equals to "nghttp2.org/").
|
||||
|
||||
Longer patterns take precedence over shorter ones,
|
||||
breaking a tie by the order of the appearance in the
|
||||
configuration.
|
||||
Patterns with host take precedence over path only
|
||||
patterns. Then, longer patterns take precedence over
|
||||
shorter ones, breaking a tie by the order of the
|
||||
appearance in the configuration.
|
||||
|
||||
If <PATTERN> is omitted, "*/*" is used as pattern, which
|
||||
matches all paths (catch-all pattern). The catch-all
|
||||
|
|
@ -214,9 +215,14 @@ Performance
|
|||
|
||||
.. option:: --backend-http2-connections-per-worker=<N>
|
||||
|
||||
Set maximum number of HTTP/2 connections per worker.
|
||||
The default value is 0, which means the number of
|
||||
backend addresses specified by :option:`-b` option.
|
||||
Set maximum number of backend HTTP/2 physical
|
||||
connections per worker. If pattern is used in :option:`-b`
|
||||
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>
|
||||
|
||||
|
|
@ -754,6 +760,13 @@ Misc
|
|||
|
||||
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
|
||||
|
||||
Print version and exit.
|
||||
|
|
|
|||
Loading…
Reference in New Issue