From 6444f0c5cd902a360d9d41774577b54912dcff93 Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Thu, 26 Nov 2015 22:25:22 +0900 Subject: [PATCH] Update man pages --- doc/h2load.1 | 9 ++++++++- doc/h2load.1.rst | 6 ++++++ doc/nghttp.1 | 2 +- doc/nghttpd.1 | 2 +- doc/nghttpx.1 | 25 +++++++++++++++++++------ doc/nghttpx.1.rst | 23 ++++++++++++++++++----- 6 files changed, 53 insertions(+), 14 deletions(-) diff --git a/doc/h2load.1 b/doc/h2load.1 index 4e639968..797dace2 100644 --- a/doc/h2load.1 +++ b/doc/h2load.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "H2LOAD" "1" "November 12, 2015" "1.4.1-DEV" "nghttp2" +.TH "H2LOAD" "1" "November 26, 2015" "1.5.0" "nghttp2" .SH NAME h2load \- HTTP/2 benchmarking tool . @@ -227,6 +227,13 @@ Default: \fBh2,h2\-16,h2\-14,spdy/3.1,spdy/3,spdy/2,http/1.1\fP .UNINDENT .INDENT 0.0 .TP +.B \-\-h1 +Short hand for \fI\%\-\-npn\-list\fP=http/1.1 +\fI\%\-\-no\-tls\-proto\fP=http/1.1, which effectively force +http/1.1 for both http and https URI. +.UNINDENT +.INDENT 0.0 +.TP .B \-v, \-\-verbose Output debug information. .UNINDENT diff --git a/doc/h2load.1.rst b/doc/h2load.1.rst index 5a9f8321..448c4276 100644 --- a/doc/h2load.1.rst +++ b/doc/h2load.1.rst @@ -188,6 +188,12 @@ OPTIONS Default: ``h2,h2-16,h2-14,spdy/3.1,spdy/3,spdy/2,http/1.1`` +.. option:: --h1 + + Short hand for :option:`--npn-list`\=http/1.1 + :option:`--no-tls-proto`\=http/1.1, which effectively force + http/1.1 for both http and https URI. + .. option:: -v, --verbose Output debug information. diff --git a/doc/nghttp.1 b/doc/nghttp.1 index 1029cb57..a5781f59 100644 --- a/doc/nghttp.1 +++ b/doc/nghttp.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTP" "1" "November 12, 2015" "1.4.1-DEV" "nghttp2" +.TH "NGHTTP" "1" "November 26, 2015" "1.5.0" "nghttp2" .SH NAME nghttp \- HTTP/2 client . diff --git a/doc/nghttpd.1 b/doc/nghttpd.1 index 06ac32d6..99be2733 100644 --- a/doc/nghttpd.1 +++ b/doc/nghttpd.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTPD" "1" "November 12, 2015" "1.4.1-DEV" "nghttp2" +.TH "NGHTTPD" "1" "November 26, 2015" "1.5.0" "nghttp2" .SH NAME nghttpd \- HTTP/2 server . diff --git a/doc/nghttpx.1 b/doc/nghttpx.1 index 8c0a577f..9c22cd4b 100644 --- a/doc/nghttpx.1 +++ b/doc/nghttpx.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTPX" "1" "November 12, 2015" "1.4.1-DEV" "nghttp2" +.TH "NGHTTPX" "1" "November 26, 2015" "1.5.0" "nghttp2" .SH NAME nghttpx \- HTTP/2 proxy . @@ -685,9 +685,14 @@ protocol security. .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. +Disable HTTP/2 server push. Server push is supported by +default mode and HTTP/2 frontend via Link header field. +It is also supported if both frontend and backend are +HTTP/2 (which implies \fI\%\-\-http2\-bridge\fP or \fI\%\-\-client\fP mode). +In this case, server push from backend session is +relayed to frontend, and server push via Link header +field is also supported. HTTP SPDY frontend does not +support server push. .UNINDENT .SS Mode .INDENT 0.0 @@ -1053,8 +1058,8 @@ than master process. .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 from +nghttpx supports HTTP/2 server push in default mode with Link header +field. nghttpx looks for Link header field (\fI\%RFC 5988\fP) in response headers from 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 @@ -1079,6 +1084,14 @@ associated stream\(aqs status code must be 200. .UNINDENT .sp This limitation may be loosened in the future release. +.sp +nghttpx also supports server push if both frontend and backend are +HTTP/2 (which implies \fI\%\-\-http2\-bridge\fP or \fI\%\-\-client\fP). +In this case, in addition to server push via Link header field, server +push from backend is relayed to frontend HTTP/2 session. +.sp +HTTP/2 server push will be disabled if \fI\%\-\-http2\-proxy\fP or +\fI\%\-\-client\-proxy\fP is used. .SH UNIX DOMAIN SOCKET .sp nghttpx supports UNIX domain socket with a filename for both frontend diff --git a/doc/nghttpx.1.rst b/doc/nghttpx.1.rst index 33b7b4f2..a644406c 100644 --- a/doc/nghttpx.1.rst +++ b/doc/nghttpx.1.rst @@ -613,9 +613,14 @@ HTTP/2 and SPDY .. 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. + Disable HTTP/2 server push. Server push is supported by + default mode and HTTP/2 frontend via Link header field. + It is also supported if both frontend and backend are + HTTP/2 (which implies :option:`--http2-bridge` or :option:`\--client` mode). + In this case, server push from backend session is + relayed to frontend, and server push via Link header + field is also supported. HTTP SPDY frontend does not + support server push. Mode @@ -954,8 +959,8 @@ SIGUSR2 SERVER PUSH ----------- -nghttpx supports HTTP/2 server push in default mode. nghttpx looks -for Link header field (`RFC 5988 +nghttpx supports HTTP/2 server push in default mode with Link header +field. nghttpx looks for Link header field (`RFC 5988 `_) in response headers from backend server and extracts URI-reference with parameter ``rel=preload`` (see `preload @@ -975,6 +980,14 @@ Currently, the following restriction is applied for server push: This limitation may be loosened in the future release. +nghttpx also supports server push if both frontend and backend are +HTTP/2 (which implies :option:`--http2-bridge` or :option:`--client`). +In this case, in addition to server push via Link header field, server +push from backend is relayed to frontend HTTP/2 session. + +HTTP/2 server push will be disabled if :option:`--http2-proxy` or +:option:`--client-proxy` is used. + UNIX DOMAIN SOCKET ------------------