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 2014-08-30 00:15:31 +09:00
parent 3de678e164
commit 340b52da84
5 changed files with 108 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/h2load.1
View File

@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.1. .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.1.
.TH H2LOAD "1" "August 2014" "h2load nghttp2/0.6.0-DEV" "User Commands" .TH H2LOAD "1" "August 2014" "h2load nghttp2/0.6.0" "User Commands"
.SH NAME .SH NAME
h2load \- HTTP/2 benchmarking tool h2load \- HTTP/2 benchmarking tool
.SH SYNOPSIS .SH SYNOPSIS

2
doc/nghttp.1
View File

@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.1. .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.1.
.TH NGHTTP "1" "August 2014" "nghttp nghttp2/0.6.0-DEV" "User Commands" .TH NGHTTP "1" "August 2014" "nghttp nghttp2/0.6.0" "User Commands"
.SH NAME .SH NAME
nghttp \- HTTP/2 experimental client nghttp \- HTTP/2 experimental client
.SH SYNOPSIS .SH SYNOPSIS

2
doc/nghttpd.1
View File

@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.1. .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.1.
.TH NGHTTPD "1" "August 2014" "nghttpd nghttp2/0.6.0-DEV" "User Commands" .TH NGHTTPD "1" "August 2014" "nghttpd nghttp2/0.6.0" "User Commands"
.SH NAME .SH NAME
nghttpd \- HTTP/2 experimental server nghttpd \- HTTP/2 experimental server
.SH SYNOPSIS .SH SYNOPSIS

64
doc/nghttpx.1
View File

@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.1. .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.1.
.TH NGHTTPX "1" "August 2014" "nghttpx nghttp2/0.6.0-DEV" "User Commands" .TH NGHTTPX "1" "August 2014" "nghttpx nghttp2/0.6.0" "User Commands"
.SH NAME .SH NAME
nghttpx \- HTTP/2 experimental proxy nghttpx \- HTTP/2 experimental proxy
.SH SYNOPSIS .SH SYNOPSIS
@ -42,12 +42,54 @@ Resolve backend hostname to IPv4 address only.
.TP .TP
\fB\-\-backend\-ipv6\fR \fB\-\-backend\-ipv6\fR
Resolve backend hostname to IPv6 address only. Resolve backend hostname to IPv6 address only.
.TP
\fB\-\-backend\-http\-proxy\-uri=\fR<URI>
Specify proxy URI in the form
http://[<USER>:<PASS>@]<PROXY>:<PORT>. If a
proxy requires authentication, specify <USER> and
<PASS>. Note that they must be properly
percent\-encoded. This proxy is used when the
backend connection is HTTP/2. First, make a
CONNECT request to the proxy and it connects to
the backend on behalf of nghttpx. This forms
tunnel. After that, nghttpx performs SSL/TLS
handshake with the downstream through the tunnel.
The timeouts when connecting and making CONNECT
request can be specified by
\fB\-\-backend\-read\-timeout\fR and
\fB\-\-backend\-write\-timeout\fR options.
.SS "Performance:" .SS "Performance:"
.TP .TP
\fB\-n\fR, \fB\-\-workers=\fR<CORES> \fB\-n\fR, \fB\-\-workers=\fR<CORES>
Set the number of worker threads. Set the number of worker threads.
Default: 1 Default: 1
.TP .TP
\fB\-\-read\-rate=\fR<RATE>
Set maximum average read rate on frontend
connection. Setting 0 to this option means read
rate is unlimited.
Default: 0
.TP
\fB\-\-read\-burst=\fR<SIZE>
Set maximum read burst size on frontend
connection. Setting 0 does not work, but it is
not a problem because \fB\-\-read\-rate\fR=\fI\,0\/\fR will give
unlimited read rate regardless of this option
value.
Default: 1073741824
.TP
\fB\-\-write\-rate=\fR<RATE>
Set maximum average write rate on frontend
connection. Setting 0 to this option means write
rate is unlimited.
Default: 0
.TP
\fB\-\-write\-burst=\fR<SIZE>
Set maximum write burst size on frontend
connection. Setting 0 to this option means write
burst size is unlimited.
Default: 0
.TP
\fB\-\-worker\-read\-rate=\fR<RATE> \fB\-\-worker\-read\-rate=\fR<RATE>
Set maximum average read rate on frontend Set maximum average read rate on frontend
connection per worker. Setting 0 to this option connection per worker. Setting 0 to this option
@ -123,21 +165,11 @@ Specify keep\-alive timeout for backend
connection. connection.
Default: 60 Default: 60
.TP .TP
\fB\-\-backend\-http\-proxy\-uri=\fR<URI> \fB\-\-listener\-disable\-timeout=\fR<SEC>
Specify proxy URI in the form After accepting connection failed, connection
http://[<USER>:<PASS>@]<PROXY>:<PORT>. If a listener is disabled for a given time in seconds.
proxy requires authentication, specify <USER> and Specifying 0 disables this feature.
<PASS>. Note that they must be properly Default: 0
percent\-encoded. This proxy is used when the
backend connection is HTTP/2. First, make a
CONNECT request to the proxy and it connects to
the backend on behalf of nghttpx. This forms
tunnel. After that, nghttpx performs SSL/TLS
handshake with the downstream through the tunnel.
The timeouts when connecting and making CONNECT
request can be specified by
\fB\-\-backend\-read\-timeout\fR and
\fB\-\-backend\-write\-timeout\fR options.
.SS "SSL/TLS:" .SS "SSL/TLS:"
.TP .TP
\fB\-\-ciphers=\fR<SUITE> \fB\-\-ciphers=\fR<SUITE>

72
doc/nghttpx.1.rst
View File

@ -66,6 +66,24 @@ Connections
Resolve backend hostname to IPv6 address only. Resolve backend hostname to IPv6 address only.
.. option:: --backend-http-proxy-uri=<URI>
Specify proxy URI in the form
http://[<USER>:<PASS>@]<PROXY>:<PORT>. If a
proxy requires authentication, specify <USER> and
<PASS>. Note that they must be properly
percent-encoded. This proxy is used when the
backend connection is HTTP/2. First, make a
CONNECT request to the proxy and it connects to
the backend on behalf of nghttpx. This forms
tunnel. After that, nghttpx performs SSL/TLS
handshake with the downstream through the tunnel.
The timeouts when connecting and making CONNECT
request can be specified by
:option:`--backend-read-timeout` and
:option:`--backend-write-timeout` options.
Performance Performance
^^^^^^^^^^^ ^^^^^^^^^^^
@ -75,6 +93,40 @@ Performance
Set the number of worker threads. Set the number of worker threads.
Default: 1 Default: 1
.. option:: --read-rate=<RATE>
Set maximum average read rate on frontend
connection. Setting 0 to this option means read
rate is unlimited.
Default: 0
.. option:: --read-burst=<SIZE>
Set maximum read burst size on frontend
connection. Setting 0 does not work, but it is
not a problem because --read-rate=0 will give
unlimited read rate regardless of this option
value.
Default: 1073741824
.. option:: --write-rate=<RATE>
Set maximum average write rate on frontend
connection. Setting 0 to this option means write
rate is unlimited.
Default: 0
.. option:: --write-burst=<SIZE>
Set maximum write burst size on frontend
connection. Setting 0 to this option means write
burst size is unlimited.
Default: 0
.. option:: --worker-read-rate=<RATE> .. option:: --worker-read-rate=<RATE>
@ -180,23 +232,13 @@ Timeout
connection. connection.
Default: 60 Default: 60
.. option:: --backend-http-proxy-uri=<URI> .. option:: --listener-disable-timeout=<SEC>
Specify proxy URI in the form After accepting connection failed, connection
http://[<USER>:<PASS>@]<PROXY>:<PORT>. If a listener is disabled for a given time in seconds.
proxy requires authentication, specify <USER> and Specifying 0 disables this feature.
<PASS>. Note that they must be properly Default: 0
percent-encoded. This proxy is used when the
backend connection is HTTP/2. First, make a
CONNECT request to the proxy and it connects to
the backend on behalf of nghttpx. This forms
tunnel. After that, nghttpx performs SSL/TLS
handshake with the downstream through the tunnel.
The timeouts when connecting and making CONNECT
request can be specified by
:option:`--backend-read-timeout` and
:option:`--backend-write-timeout` options.
SSL/TLS SSL/TLS
^^^^^^^ ^^^^^^^