walkero
/
nghttp2
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Update man pages

This commit is contained in:
Tatsuhiro Tsujikawa 2015-07-15 00:01:04 +09:00
parent 860da8bf87
commit 9c8bc1218d
5 changed files with 59 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/h2load.1
View File

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

2
doc/nghttp.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTP" "1" "July 12, 2015" "1.0.6-DEV" "nghttp2" .TH "NGHTTP" "1" "July 14, 2015" "1.0.6" "nghttp2"
.SH NAME .SH NAME
nghttp \- HTTP/2 experimental client nghttp \- HTTP/2 experimental client
. .

2
doc/nghttpd.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPD" "1" "July 12, 2015" "1.0.6-DEV" "nghttp2" .TH "NGHTTPD" "1" "July 14, 2015" "1.0.6" "nghttp2"
.SH NAME .SH NAME
nghttpd \- HTTP/2 experimental server nghttpd \- HTTP/2 experimental server
. .

51
doc/nghttpx.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPX" "1" "July 12, 2015" "1.0.6-DEV" "nghttp2" .TH "NGHTTPX" "1" "July 14, 2015" "1.0.6" "nghttp2"
.SH NAME .SH NAME
nghttpx \- HTTP/2 experimental proxy nghttpx \- HTTP/2 experimental proxy
. .
@ -55,7 +55,7 @@ The options are categorized into several groups.
.SS Connections .SS Connections
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-b, \-\-backend=<HOST>,<PORT>[;<PATTERN>[:...]] .B \-b, \-\-backend=(<HOST>,<PORT>|unix:<PATH>)[;<PATTERN>[:...]]
Set backend host and port. The multiple backend Set backend host and port. The multiple backend
addresses are accepted by repeating this option. UNIX addresses are accepted by repeating this option. UNIX
domain socket can be specified by prefixing path name domain socket can be specified by prefixing path name
@ -66,27 +66,27 @@ is only used if request matches the pattern. If \fI\%\-s\fP or
\fI\%\-p\fP is used, <PATTERN>s are ignored. The pattern \fI\%\-p\fP is used, <PATTERN>s are ignored. The pattern
matching is closely designed to ServeMux in net/http matching is closely designed to ServeMux in net/http
package of Go programming language. <PATTERN> consists package of Go programming language. <PATTERN> consists
of path, host + path or just host. The path must starts of path, host + path or just host. The path must start
with "\fI/\fP". If it ends with "\fI/\fP", it matches to the with "\fI/\fP". If it ends with "\fI/\fP", it matches all request
request path whose prefix is the path. To deal with the path in its subtree. To deal with the request to the
request to the directory without trailing slash, pattern directory without trailing slash, the path which ends
which ends with "\fI/\fP" also matches the path if pattern == with "\fI/\fP" also matches the request path which only lacks
path + "\fI/\fP" (e.g., pattern "\fI/foo/\fP" matches path "\fI/foo\fP"). trailing \(aq\fI/\fP\(aq (e.g., path "\fI/foo/\fP" matches request path
If it does not end with "\fI/\fP", it performs exact match "\fI/foo\fP"). If it does not end with "\fI/\fP", it performs exact
against the request path. If host is given, it performs match against the request path. If host is given, it
exact match against the request host. If host alone is performs exact match against the request host. If host
given, "\fI/\fP" is appended to it, so that it matches all alone is given, "\fI/\fP" is appended to it, so that it
paths under the host (e.g., specifying "nghttp2.org" matches all request paths under the host (e.g.,
equals to "nghttp2.org/"). specifying "nghttp2.org" equals to "nghttp2.org/").
.sp .sp
Patterns with host take precedence over path only Patterns with host take precedence over patterns with
patterns. Then, longer patterns take precedence over just path. Then, longer patterns take precedence over
shorter ones, breaking a tie by the order of the shorter ones, breaking a tie by the order of the
appearance in the configuration. 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 request paths (catch\-all pattern). The
backend must be given. catch\-all backend must be given.
.sp .sp
When doing a match, nghttpx made some normalization to When doing a match, nghttpx made some normalization to
pattern, request host and path. For host part, they are pattern, request host and path. For host part, they are
@ -104,18 +104,20 @@ The multiple <PATTERN>s can be specified, delimiting
them by ":". Specifying them by ":". Specifying
\fI\%\-b\fP\(aq127.0.0.1,8080;nghttp2.org:www.nghttp2.org\(aq has the \fI\%\-b\fP\(aq127.0.0.1,8080;nghttp2.org:www.nghttp2.org\(aq has the
same effect to specify \fI\%\-b\fP\(aq127.0.0.1,8080;nghttp2.org\(aq same effect to specify \fI\%\-b\fP\(aq127.0.0.1,8080;nghttp2.org\(aq
and \fI\%\-b\fP\(aq127.0.0.1,8080:www.nghttp2.org\(aq. and \fI\%\-b\fP\(aq127.0.0.1,8080;www.nghttp2.org\(aq.
.sp .sp
The backend addresses sharing same <PATTERN> are grouped The backend addresses sharing same <PATTERN> are grouped
together forming load balancing group. Since ";" and together forming load balancing group.
":" are used as delimiter, <PATTERN> must not contain .sp
these characters. Since ";" and ":" are used as delimiter, <PATTERN> must
not contain these characters. Since ";" has special
meaning in shell, the option value must be quoted.
.sp .sp
Default: \fB127.0.0.1,80\fP Default: \fB127.0.0.1,80\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-f, \-\-frontend=<HOST>,<PORT> .B \-f, \-\-frontend=(<HOST>,<PORT>|unix:<PATH>)
Set frontend host and port. If <HOST> is \(aq*\(aq, it Set frontend host and port. If <HOST> is \(aq*\(aq, it
assumes all addresses including both IPv4 and IPv6. assumes all addresses including both IPv4 and IPv6.
UNIX domain socket can be specified by prefixing path UNIX domain socket can be specified by prefixing path
@ -692,6 +694,9 @@ $ssl_session_reused: "r" if SSL/TLS session was
reused. Otherwise, "." reused. Otherwise, "."
.UNINDENT .UNINDENT
.sp .sp
The variable can be enclosed by "{" and "}" for
disambiguation (e.g., ${remote_addr}).
.sp
Default: \fB$remote_addr \- \- [$time_local] "$request" $status $body_bytes_sent "$http_referer" "$http_user_agent"\fP Default: \fB$remote_addr \- \- [$time_local] "$request" $status $body_bytes_sent "$http_referer" "$http_user_agent"\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0

50
doc/nghttpx.1.rst
View File

@ -37,7 +37,7 @@ The options are categorized into several groups.
Connections Connections
~~~~~~~~~~~ ~~~~~~~~~~~
.. option:: -b, --backend=<HOST>,<PORT>[;<PATTERN>[:...]] .. option:: -b, --backend=(<HOST>,<PORT>|unix:<PATH>)[;<PATTERN>[:...]]
Set backend host and port. The multiple backend Set backend host and port. The multiple backend
addresses are accepted by repeating this option. UNIX addresses are accepted by repeating this option. UNIX
@ -49,27 +49,27 @@ Connections
:option:`-p` is used, <PATTERN>s are ignored. The pattern :option:`-p` is used, <PATTERN>s are ignored. The pattern
matching is closely designed to ServeMux in net/http matching is closely designed to ServeMux in net/http
package of Go programming language. <PATTERN> consists package of Go programming language. <PATTERN> consists
of path, host + path or just host. The path must starts of path, host + path or just host. The path must start
with "*/*". If it ends with "*/*", it matches to the with "*/*". If it ends with "*/*", it matches all request
request path whose prefix is the path. To deal with the path in its subtree. To deal with the request to the
request to the directory without trailing slash, pattern directory without trailing slash, the path which ends
which ends with "*/*" also matches the path if pattern == with "*/*" also matches the request path which only lacks
path + "*/*" (e.g., pattern "*/foo/*" matches path "*/foo*"). trailing '*/*' (e.g., path "*/foo/*" matches request path
If it does not end with "*/*", it performs exact match "*/foo*"). If it does not end with "*/*", it performs exact
against the request path. If host is given, it performs match against the request path. If host is given, it
exact match against the request host. If host alone is performs exact match against the request host. If host
given, "*/*" is appended to it, so that it matches all alone is given, "*/*" is appended to it, so that it
paths under the host (e.g., specifying "nghttp2.org" matches all request paths under the host (e.g.,
equals to "nghttp2.org/"). specifying "nghttp2.org" equals to "nghttp2.org/").
Patterns with host take precedence over path only Patterns with host take precedence over patterns with
patterns. Then, longer patterns take precedence over just path. Then, longer patterns take precedence over
shorter ones, breaking a tie by the order of the shorter ones, breaking a tie by the order of the
appearance in the configuration. 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 request paths (catch-all pattern). The
backend must be given. catch-all backend must be given.
When doing a match, nghttpx made some normalization to When doing a match, nghttpx made some normalization to
pattern, request host and path. For host part, they are pattern, request host and path. For host part, they are
@ -87,16 +87,19 @@ Connections
them by ":". Specifying them by ":". Specifying
:option:`-b`\'127.0.0.1,8080;nghttp2.org:www.nghttp2.org' has the :option:`-b`\'127.0.0.1,8080;nghttp2.org:www.nghttp2.org' has the
same effect to specify :option:`-b`\'127.0.0.1,8080;nghttp2.org' same effect to specify :option:`-b`\'127.0.0.1,8080;nghttp2.org'
and :option:`-b`\'127.0.0.1,8080:www.nghttp2.org'. and :option:`-b`\'127.0.0.1,8080;www.nghttp2.org'.
The backend addresses sharing same <PATTERN> are grouped The backend addresses sharing same <PATTERN> are grouped
together forming load balancing group. Since ";" and together forming load balancing group.
":" are used as delimiter, <PATTERN> must not contain
these characters. Since ";" and ":" are used as delimiter, <PATTERN> must
not contain these characters. Since ";" has special
meaning in shell, the option value must be quoted.
Default: ``127.0.0.1,80`` Default: ``127.0.0.1,80``
.. option:: -f, --frontend=<HOST>,<PORT> .. option:: -f, --frontend=(<HOST>,<PORT>|unix:<PATH>)
Set frontend host and port. If <HOST> is '\*', it Set frontend host and port. If <HOST> is '\*', it
assumes all addresses including both IPv4 and IPv6. assumes all addresses including both IPv4 and IPv6.
@ -611,6 +614,9 @@ Logging
* $ssl_session_reused: "r" if SSL/TLS session was * $ssl_session_reused: "r" if SSL/TLS session was
reused. Otherwise, "." reused. Otherwise, "."
The variable can be enclosed by "{" and "}" for
disambiguation (e.g., ${remote_addr}).
Default: ``$remote_addr - - [$time_local] "$request" $status $body_bytes_sent "$http_referer" "$http_user_agent"`` Default: ``$remote_addr - - [$time_local] "$request" $status $body_bytes_sent "$http_referer" "$http_user_agent"``