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-03-31 00:23:12 +09:00
parent cc94632b29
commit 763293a050
7 changed files with 64 additions and 18 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" "March 27, 2015" "0.7.9" "nghttp2" .TH "H2LOAD" "1" "March 31, 2015" "0.7.10-DEV" "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" "March 27, 2015" "0.7.9" "nghttp2" .TH "NGHTTP" "1" "March 31, 2015" "0.7.10-DEV" "nghttp2"
.SH NAME .SH NAME
nghttp \- HTTP/2 experimental client nghttp \- HTTP/2 experimental client
. .

1
doc/nghttp.1.rst
View File

@ -162,6 +162,7 @@ OPTIONS
Display this help and exit. Display this help and exit.
The <SIZE> argument is an integer and an optional unit (e.g., 10K is The <SIZE> argument is an integer and an optional unit (e.g., 10K is
10 * 1024). Units are K, M and G (powers of 1024). 10 * 1024). Units are K, M and G (powers of 1024).

2
doc/nghttpd.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPD" "1" "March 27, 2015" "0.7.9" "nghttp2" .TH "NGHTTPD" "1" "March 31, 2015" "0.7.10-DEV" "nghttp2"
.SH NAME .SH NAME
nghttpd \- HTTP/2 experimental server nghttpd \- HTTP/2 experimental server
. .

1
doc/nghttpd.1.rst
View File

@ -126,6 +126,7 @@ OPTIONS
Display this help and exit. Display this help and exit.
The <SIZE> argument is an integer and an optional unit (e.g., 10K is The <SIZE> argument is an integer and an optional unit (e.g., 10K is
10 * 1024). Units are K, M and G (powers of 1024). 10 * 1024). Units are K, M and G (powers of 1024).

39
doc/nghttpx.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPX" "1" "March 27, 2015" "0.7.9" "nghttp2" .TH "NGHTTPX" "1" "March 31, 2015" "0.7.10-DEV" "nghttp2"
.SH NAME .SH NAME
nghttpx \- HTTP/2 experimental proxy nghttpx \- HTTP/2 experimental proxy
. .
@ -46,7 +46,8 @@ Set path to server\(aqs private key. Required unless \fI\%\-p\fP,
.TP .TP
.B <CERT> .B <CERT>
Set path to server\(aqs certificate. Required unless \fI\%\-p\fP, Set path to server\(aqs certificate. Required unless \fI\%\-p\fP,
\fI\%\-\-client\fP or \fI\%\-\-frontend\-no\-tls\fP are given. \fI\%\-\-client\fP or \fI\%\-\-frontend\-no\-tls\fP are given. To make OCSP
stapling work, this must be absolute path.
.UNINDENT .UNINDENT
.SH OPTIONS .SH OPTIONS
.sp .sp
@ -249,14 +250,14 @@ Default: \fB16K\fP
Specify read timeout for HTTP/2 and SPDY frontend Specify read timeout for HTTP/2 and SPDY frontend
connection. connection.
.sp .sp
Default: \fB180s\fP Default: \fB3m\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-frontend\-read\-timeout=<DURATION> .B \-\-frontend\-read\-timeout=<DURATION>
Specify read timeout for HTTP/1.1 frontend connection. Specify read timeout for HTTP/1.1 frontend connection.
.sp .sp
Default: \fB180s\fP Default: \fB3m\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
@ -286,7 +287,7 @@ Default: \fB0\fP
.B \-\-backend\-read\-timeout=<DURATION> .B \-\-backend\-read\-timeout=<DURATION>
Specify read timeout for backend connection. Specify read timeout for backend connection.
.sp .sp
Default: \fB180s\fP Default: \fB3m\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
@ -348,7 +349,8 @@ password protected it\(aqll be requested interactively.
Specify additional certificate and private key file. Specify additional certificate and private key file.
nghttpx will choose certificates based on the hostname nghttpx will choose certificates based on the hostname
indicated by client using TLS SNI extension. This indicated by client using TLS SNI extension. This
option can be used multiple times. option can be used multiple times. To make OCSP
stapling work, <CERTPATH> must be absolute path.
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
@ -442,6 +444,26 @@ objects, which means session ID generated by one worker
is not acceptable by another worker. On the other hand, is not acceptable by another worker. On the other hand,
session ticket key is shared across all worker threads. session ticket key is shared across all worker threads.
.UNINDENT .UNINDENT
.INDENT 0.0
.TP
.B \-\-fetch\-ocsp\-response\-file=<PATH>
Path to fetch\-ocsp\-response script file. It should be
absolute path.
.sp
Default: \fB/usr/local/share/nghttp2/fetch\-ocsp\-response\fP
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ocsp\-update\-interval=<DURATION>
Set interval to update OCSP response cache.
.sp
Default: \fB4h\fP
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-ocsp
Disable OCSP stapling.
.UNINDENT
.SS HTTP/2 and SPDY .SS HTTP/2 and SPDY
.INDENT 0.0 .INDENT 0.0
.TP .TP
@ -759,8 +781,9 @@ The <SIZE> argument is an integer and an optional unit (e.g., 10K is
10 * 1024). Units are K, M and G (powers of 1024). 10 * 1024). Units are K, M and G (powers of 1024).
.sp .sp
The <DURATION> argument is an integer and an optional unit (e.g., 1s The <DURATION> argument is an integer and an optional unit (e.g., 1s
is 1 second and 500ms is 500 milliseconds). Units are s or ms. If is 1 second and 500ms is 500 milliseconds). Units are h, m, s or ms
a unit is omitted, a second is used as unit. (hours, minutes, seconds and milliseconds, respectively). If a unit
is omitted, a second is used as unit.
.SH FILES .SH FILES
.INDENT 0.0 .INDENT 0.0
.TP .TP

35
doc/nghttpx.1.rst
View File

@ -21,7 +21,8 @@ A reverse proxy for HTTP/2, HTTP/1 and SPDY.
.. describe:: <CERT> .. describe:: <CERT>
Set path to server's certificate. Required unless :option:`-p`\, Set path to server's certificate. Required unless :option:`-p`\,
:option:`--client` or :option:`\--frontend-no-tls` are given. :option:`--client` or :option:`\--frontend-no-tls` are given. To make OCSP
stapling work, this must be absolute path.
OPTIONS OPTIONS
@ -212,13 +213,13 @@ Timeout
Specify read timeout for HTTP/2 and SPDY frontend Specify read timeout for HTTP/2 and SPDY frontend
connection. connection.
Default: ``180s`` Default: ``3m``
.. option:: --frontend-read-timeout=<DURATION> .. option:: --frontend-read-timeout=<DURATION>
Specify read timeout for HTTP/1.1 frontend connection. Specify read timeout for HTTP/1.1 frontend connection.
Default: ``180s`` Default: ``3m``
.. option:: --frontend-write-timeout=<DURATION> .. option:: --frontend-write-timeout=<DURATION>
@ -244,7 +245,7 @@ Timeout
Specify read timeout for backend connection. Specify read timeout for backend connection.
Default: ``180s`` Default: ``3m``
.. option:: --backend-write-timeout=<DURATION> .. option:: --backend-write-timeout=<DURATION>
@ -301,7 +302,8 @@ SSL/TLS
Specify additional certificate and private key file. Specify additional certificate and private key file.
nghttpx will choose certificates based on the hostname nghttpx will choose certificates based on the hostname
indicated by client using TLS SNI extension. This indicated by client using TLS SNI extension. This
option can be used multiple times. option can be used multiple times. To make OCSP
stapling work, <CERTPATH> must be absolute path.
.. option:: --backend-tls-sni-field=<HOST> .. option:: --backend-tls-sni-field=<HOST>
@ -385,6 +387,23 @@ SSL/TLS
is not acceptable by another worker. On the other hand, is not acceptable by another worker. On the other hand,
session ticket key is shared across all worker threads. session ticket key is shared across all worker threads.
.. option:: --fetch-ocsp-response-file=<PATH>
Path to fetch-ocsp-response script file. It should be
absolute path.
Default: ``/usr/local/share/nghttp2/fetch-ocsp-response``
.. option:: --ocsp-update-interval=<DURATION>
Set interval to update OCSP response cache.
Default: ``4h``
.. option:: --no-ocsp
Disable OCSP stapling.
HTTP/2 and SPDY HTTP/2 and SPDY
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
@ -670,12 +689,14 @@ Misc
Print this help and exit. Print this help and exit.
The <SIZE> argument is an integer and an optional unit (e.g., 10K is The <SIZE> argument is an integer and an optional unit (e.g., 10K is
10 * 1024). Units are K, M and G (powers of 1024). 10 * 1024). Units are K, M and G (powers of 1024).
The <DURATION> argument is an integer and an optional unit (e.g., 1s The <DURATION> argument is an integer and an optional unit (e.g., 1s
is 1 second and 500ms is 500 milliseconds). Units are s or ms. If is 1 second and 500ms is 500 milliseconds). Units are h, m, s or ms
a unit is omitted, a second is used as unit. (hours, minutes, seconds and milliseconds, respectively). If a unit
is omitted, a second is used as unit.
FILES FILES
----- -----