Update man pages
This commit is contained in:
parent
4d47c31ebe
commit
75d7e5abe0
|
@ -1,6 +1,6 @@
|
||||||
.\" Man page generated from reStructuredText.
|
.\" Man page generated from reStructuredText.
|
||||||
.
|
.
|
||||||
.TH "H2LOAD" "1" "February 01, 2015" "0.7.4-DEV" "nghttp2"
|
.TH "H2LOAD" "1" "February 08, 2015" "0.7.4-DEV" "nghttp2"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
h2load \- HTTP/2 benchmarking tool
|
h2load \- HTTP/2 benchmarking tool
|
||||||
.
|
.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
.\" Man page generated from reStructuredText.
|
.\" Man page generated from reStructuredText.
|
||||||
.
|
.
|
||||||
.TH "NGHTTP" "1" "February 01, 2015" "0.7.4-DEV" "nghttp2"
|
.TH "NGHTTP" "1" "February 08, 2015" "0.7.4-DEV" "nghttp2"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
nghttp \- HTTP/2 experimental client
|
nghttp \- HTTP/2 experimental client
|
||||||
.
|
.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
.\" Man page generated from reStructuredText.
|
.\" Man page generated from reStructuredText.
|
||||||
.
|
.
|
||||||
.TH "NGHTTPD" "1" "February 01, 2015" "0.7.4-DEV" "nghttp2"
|
.TH "NGHTTPD" "1" "February 08, 2015" "0.7.4-DEV" "nghttp2"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
nghttpd \- HTTP/2 experimental server
|
nghttpd \- HTTP/2 experimental server
|
||||||
.
|
.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
.\" Man page generated from reStructuredText.
|
.\" Man page generated from reStructuredText.
|
||||||
.
|
.
|
||||||
.TH "NGHTTPX" "1" "February 01, 2015" "0.7.4-DEV" "nghttp2"
|
.TH "NGHTTPX" "1" "February 08, 2015" "0.7.4-DEV" "nghttp2"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
nghttpx \- HTTP/2 experimental proxy
|
nghttpx \- HTTP/2 experimental proxy
|
||||||
.
|
.
|
||||||
|
@ -500,6 +500,13 @@ padding. Specify 0 to disable padding. This option is
|
||||||
meant for debugging purpose and not intended to enhance
|
meant for debugging purpose and not intended to enhance
|
||||||
protocol security.
|
protocol security.
|
||||||
.UNINDENT
|
.UNINDENT
|
||||||
|
.INDENT 0.0
|
||||||
|
.TP
|
||||||
|
.B \-\-no\-server\-push
|
||||||
|
Disable HTTP/2 server push. Server push is only
|
||||||
|
supported by default mode and HTTP/2 frontend. SPDY
|
||||||
|
frontend does not support server push.
|
||||||
|
.UNINDENT
|
||||||
.SS Mode
|
.SS Mode
|
||||||
.INDENT 0.0
|
.INDENT 0.0
|
||||||
.TP
|
.TP
|
||||||
|
@ -652,6 +659,14 @@ altered regardless of this option.
|
||||||
.UNINDENT
|
.UNINDENT
|
||||||
.INDENT 0.0
|
.INDENT 0.0
|
||||||
.TP
|
.TP
|
||||||
|
.B \-\-no\-host\-rewrite
|
||||||
|
Don\(aqt rewrite host and :authority header fields on
|
||||||
|
\fI\%\-\-http2\-bridge\fP, \fI\%\-\-client\fP and default mode. For
|
||||||
|
\fI\%\-\-http2\-proxy\fP and \fI\%\-\-client\-proxy\fP mode, these headers
|
||||||
|
will not be altered regardless of this option.
|
||||||
|
.UNINDENT
|
||||||
|
.INDENT 0.0
|
||||||
|
.TP
|
||||||
.B \-\-altsvc=<PROTOID,PORT[,HOST,[ORIGIN]]>
|
.B \-\-altsvc=<PROTOID,PORT[,HOST,[ORIGIN]]>
|
||||||
Specify protocol ID, port, host and origin of
|
Specify protocol ID, port, host and origin of
|
||||||
alternative service. <HOST> and <ORIGIN> are optional.
|
alternative service. <HOST> and <ORIGIN> are optional.
|
||||||
|
@ -782,6 +797,39 @@ path with same command\-line arguments and environment variables.
|
||||||
After new process comes up, sending SIGQUIT to the original process
|
After new process comes up, sending SIGQUIT to the original process
|
||||||
to perform hot swapping.
|
to perform hot swapping.
|
||||||
.UNINDENT
|
.UNINDENT
|
||||||
|
.SH SERVER PUSH
|
||||||
|
.sp
|
||||||
|
nghttpx supports HTTP/2 server push in default mode. nghttpx looks
|
||||||
|
for Link header field (\fI\%RFC 5988\fP) in response headers for
|
||||||
|
backend server and extracts URI\-reference with parameter
|
||||||
|
\fBrel=preload\fP (see \fI\%preload\fP)
|
||||||
|
and pushes those URIs to the frontend client. Here is a sample Link
|
||||||
|
header field to initiate server push:
|
||||||
|
.INDENT 0.0
|
||||||
|
.INDENT 3.5
|
||||||
|
.sp
|
||||||
|
.nf
|
||||||
|
.ft C
|
||||||
|
Link: </fonts/font.woff>; rel=preload
|
||||||
|
Link: </css/theme.css>; rel=preload
|
||||||
|
.ft P
|
||||||
|
.fi
|
||||||
|
.UNINDENT
|
||||||
|
.UNINDENT
|
||||||
|
.sp
|
||||||
|
Currently, the following restrictions are applied for server push:
|
||||||
|
.INDENT 0.0
|
||||||
|
.IP 1. 3
|
||||||
|
URI\-reference must not contain authority. If it exists, it is not
|
||||||
|
pushed. \fB/fonts/font.woff\fP and \fBcss/theme.css\fP are eligible to
|
||||||
|
be pushed. \fBhttps://example.org/fonts/font.woff\fP and
|
||||||
|
\fB//example.org/css/theme.css\fP are not.
|
||||||
|
.IP 2. 3
|
||||||
|
The associated stream must have method "GET" or "POST". The
|
||||||
|
associated stream\(aqs status code must be 200.
|
||||||
|
.UNINDENT
|
||||||
|
.sp
|
||||||
|
These limitations may be loosened in the future release.
|
||||||
.SH SEE ALSO
|
.SH SEE ALSO
|
||||||
.sp
|
.sp
|
||||||
\fInghttp(1)\fP, \fInghttpd(1)\fP, \fIh2load(1)\fP
|
\fInghttp(1)\fP, \fInghttpd(1)\fP, \fIh2load(1)\fP
|
||||||
|
|
|
@ -438,6 +438,12 @@ HTTP/2 and SPDY
|
||||||
meant for debugging purpose and not intended to enhance
|
meant for debugging purpose and not intended to enhance
|
||||||
protocol security.
|
protocol security.
|
||||||
|
|
||||||
|
.. option:: --no-server-push
|
||||||
|
|
||||||
|
Disable HTTP/2 server push. Server push is only
|
||||||
|
supported by default mode and HTTP/2 frontend. SPDY
|
||||||
|
frontend does not support server push.
|
||||||
|
|
||||||
|
|
||||||
Mode
|
Mode
|
||||||
~~~~
|
~~~~
|
||||||
|
@ -570,6 +576,13 @@ HTTP
|
||||||
:option:`--client-proxy` mode, location header field will not be
|
:option:`--client-proxy` mode, location header field will not be
|
||||||
altered regardless of this option.
|
altered regardless of this option.
|
||||||
|
|
||||||
|
.. option:: --no-host-rewrite
|
||||||
|
|
||||||
|
Don't rewrite host and :authority header fields on
|
||||||
|
:option:`--http2-bridge`\, :option:`--client` and default mode. For
|
||||||
|
:option:`--http2-proxy` and :option:`\--client-proxy` mode, these headers
|
||||||
|
will not be altered regardless of this option.
|
||||||
|
|
||||||
.. option:: --altsvc=<PROTOID,PORT[,HOST,[ORIGIN]]>
|
.. option:: --altsvc=<PROTOID,PORT[,HOST,[ORIGIN]]>
|
||||||
|
|
||||||
Specify protocol ID, port, host and origin of
|
Specify protocol ID, port, host and origin of
|
||||||
|
@ -701,6 +714,35 @@ SIGUSR2
|
||||||
After new process comes up, sending SIGQUIT to the original process
|
After new process comes up, sending SIGQUIT to the original process
|
||||||
to perform hot swapping.
|
to perform hot swapping.
|
||||||
|
|
||||||
|
SERVER PUSH
|
||||||
|
-----------
|
||||||
|
|
||||||
|
nghttpx supports HTTP/2 server push in default mode. nghttpx looks
|
||||||
|
for Link header field (`RFC 5988
|
||||||
|
<http://tools.ietf.org/html/rfc5988>`_) in response headers for
|
||||||
|
backend server and extracts URI-reference with parameter
|
||||||
|
``rel=preload`` (see `preload
|
||||||
|
<http://w3c.github.io/preload/#interoperability-with-http-link-header>`_)
|
||||||
|
and pushes those URIs to the frontend client. Here is a sample Link
|
||||||
|
header field to initiate server push:
|
||||||
|
|
||||||
|
.. code-block:: http
|
||||||
|
|
||||||
|
Link: </fonts/font.woff>; rel=preload
|
||||||
|
Link: </css/theme.css>; rel=preload
|
||||||
|
|
||||||
|
Currently, the following restrictions are applied for server push:
|
||||||
|
|
||||||
|
1. URI-reference must not contain authority. If it exists, it is not
|
||||||
|
pushed. ``/fonts/font.woff`` and ``css/theme.css`` are eligible to
|
||||||
|
be pushed. ``https://example.org/fonts/font.woff`` and
|
||||||
|
``//example.org/css/theme.css`` are not.
|
||||||
|
|
||||||
|
2. The associated stream must have method "GET" or "POST". The
|
||||||
|
associated stream's status code must be 200.
|
||||||
|
|
||||||
|
These limitations may be loosened in the future release.
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue