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 2016-06-14 00:26:36 +09:00
parent fd09d8b861
commit 47fa56fd0a
6 changed files with 25 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/h2load.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "H2LOAD" "1" "June 09, 2016" "1.12.0-DEV" "nghttp2" .TH "H2LOAD" "1" "June 14, 2016" "1.12.0-DEV" "nghttp2"
.SH NAME .SH NAME
h2load \- HTTP/2 benchmarking tool h2load \- HTTP/2 benchmarking tool
. .
@ -138,7 +138,9 @@ Default: \fBh2c\fP
.TP .TP
.B \-d, \-\-data=<PATH> .B \-d, \-\-data=<PATH>
Post FILE to server. The request method is changed to Post FILE to server. The request method is changed to
POST. POST. For http/1.1 connection, if \fI\%\-d\fP is used, the
maximum number of in\-flight pipelined requests is set to
1.
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP

4
doc/h2load.1.rst
View File

@ -108,7 +108,9 @@ OPTIONS
.. option:: -d, --data=<PATH> .. option:: -d, --data=<PATH>
Post FILE to server. The request method is changed to Post FILE to server. The request method is changed to
POST. POST. For http/1.1 connection, if :option:`-d` is used, the
maximum number of in-flight pipelined requests is set to
1.
.. option:: -r, --rate=<N> .. option:: -r, --rate=<N>

2
doc/nghttp.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTP" "1" "June 09, 2016" "1.12.0-DEV" "nghttp2" .TH "NGHTTP" "1" "June 14, 2016" "1.12.0-DEV" "nghttp2"
.SH NAME .SH NAME
nghttp \- HTTP/2 client nghttp \- HTTP/2 client
. .

2
doc/nghttpd.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPD" "1" "June 09, 2016" "1.12.0-DEV" "nghttp2" .TH "NGHTTPD" "1" "June 14, 2016" "1.12.0-DEV" "nghttp2"
.SH NAME .SH NAME
nghttpd \- HTTP/2 server nghttpd \- HTTP/2 server
. .

16
doc/nghttpx.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPX" "1" "June 09, 2016" "1.12.0-DEV" "nghttp2" .TH "NGHTTPX" "1" "June 14, 2016" "1.12.0-DEV" "nghttp2"
.SH NAME .SH NAME
nghttpx \- HTTP/2 proxy nghttpx \- HTTP/2 proxy
. .
@ -1733,7 +1733,7 @@ defined:
The request was successful. The request was successful.
.TP .TP
.B Failure .B Failure
The request was faield. No change has been made. The request was failed. No change has been made.
.UNINDENT .UNINDENT
.TP .TP
.B code .B code
@ -1745,13 +1745,13 @@ some cases where the error has occurred before reaching API endpoint
(e.g., header field is too large). (e.g., header field is too large).
.sp .sp
The following section describes available API endpoints. The following section describes available API endpoints.
.SS PUT /api/v1beta1/backend/replace .SS PUT /api/v1beta1/backendconfig
.sp .sp
This API replaces the current set of backend servers with the This API replaces the current backend server settings with the
requested ones. The request must carry request body with method PUT requested ones. The request method should be PUT, but POST is also
or POST. The request body must be nghttpx configuration file format. acceptable. The request body must be nghttpx configuration file
For configuration file format, see \fI\%FILES\fP section. The line format. For configuration file format, see \fI\%FILES\fP section. The
separator inside the request body must be single LF (0x0A). line separator inside the request body must be single LF (0x0A).
Currently, only \fI\%backend\fP option is parsed, the Currently, only \fI\%backend\fP option is parsed, the
others are simply ignored. The semantics of this API is replace the others are simply ignored. The semantics of this API is replace the
current backend with the backend options in request body. Describe current backend with the backend options in request body. Describe

16
doc/nghttpx.1.rst
View File

@ -1574,7 +1574,7 @@ status
The request was successful. The request was successful.
Failure Failure
The request was faield. No change has been made. The request was failed. No change has been made.
code code
HTTP status code HTTP status code
@ -1585,14 +1585,14 @@ some cases where the error has occurred before reaching API endpoint
The following section describes available API endpoints. The following section describes available API endpoints.
PUT /api/v1beta1/backend/replace PUT /api/v1beta1/backendconfig
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This API replaces the current set of backend servers with the This API replaces the current backend server settings with the
requested ones. The request must carry request body with method PUT requested ones. The request method should be PUT, but POST is also
or POST. The request body must be nghttpx configuration file format. acceptable. The request body must be nghttpx configuration file
For configuration file format, see `FILES`_ section. The line format. For configuration file format, see `FILES`_ section. The
separator inside the request body must be single LF (0x0A). line separator inside the request body must be single LF (0x0A).
Currently, only :option:`backend <--backend>` option is parsed, the Currently, only :option:`backend <--backend>` option is parsed, the
others are simply ignored. The semantics of this API is replace the others are simply ignored. The semantics of this API is replace the
current backend with the backend options in request body. Describe current backend with the backend options in request body. Describe