Update man pages

This commit is contained in:
Tatsuhiro Tsujikawa 2016-12-27 20:42:46 +09:00
parent 4245d98653
commit ab0b98db61
5 changed files with 81 additions and 8 deletions

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "H2LOAD" "1" "Dec 11, 2016" "1.18.0-DEV" "nghttp2" .TH "H2LOAD" "1" "Dec 27, 2016" "1.18.0" "nghttp2"
.SH NAME .SH NAME
h2load \- HTTP/2 benchmarking tool h2load \- HTTP/2 benchmarking tool
. .

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTP" "1" "Dec 11, 2016" "1.18.0-DEV" "nghttp2" .TH "NGHTTP" "1" "Dec 27, 2016" "1.18.0" "nghttp2"
.SH NAME .SH NAME
nghttp \- HTTP/2 client nghttp \- HTTP/2 client
. .

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPD" "1" "Dec 11, 2016" "1.18.0-DEV" "nghttp2" .TH "NGHTTPD" "1" "Dec 27, 2016" "1.18.0" "nghttp2"
.SH NAME .SH NAME
nghttpd \- HTTP/2 server nghttpd \- HTTP/2 server
. .

View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPX" "1" "Dec 11, 2016" "1.18.0-DEV" "nghttp2" .TH "NGHTTPX" "1" "Dec 27, 2016" "1.18.0" "nghttp2"
.SH NAME .SH NAME
nghttpx \- HTTP/2 proxy nghttpx \- HTTP/2 proxy
. .
@ -434,6 +434,14 @@ Default: \fB30s\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-frontend\-keep\-alive\-timeout=<DURATION>
Specify keep\-alive timeout for frontend HTTP/1
connection.
.sp
Default: \fB1m\fP
.UNINDENT
.INDENT 0.0
.TP
.B \-\-stream\-read\-timeout=<DURATION> .B \-\-stream\-read\-timeout=<DURATION>
Specify read timeout for HTTP/2 and SPDY streams. 0 Specify read timeout for HTTP/2 and SPDY streams. 0
means no timeout. means no timeout.
@ -473,7 +481,8 @@ Default: \fB30s\fP
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-backend\-keep\-alive\-timeout=<DURATION> .B \-\-backend\-keep\-alive\-timeout=<DURATION>
Specify keep\-alive timeout for backend connection. Specify keep\-alive timeout for backend HTTP/1
connection.
.sp .sp
Default: \fB2s\fP Default: \fB2s\fP
.UNINDENT .UNINDENT
@ -1246,7 +1255,7 @@ backend server, the custom error pages are not used.
.B \-\-server\-name=<NAME> .B \-\-server\-name=<NAME>
Change server response header field value to <NAME>. Change server response header field value to <NAME>.
.sp .sp
Default: \fBnghttpx nghttp2/1.18.0\-DEV\fP Default: \fBnghttpx nghttp2/1.18.0\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
@ -1428,6 +1437,35 @@ positional arguments in command\-line, use \fBprivate\-key\-file\fP and
.sp .sp
\fI\%\-\-conf\fP option cannot be used in the configuration file and \fI\%\-\-conf\fP option cannot be used in the configuration file and
will be ignored if specified. will be ignored if specified.
.TP
.B Error log
Error log is written to stderr by default. It can be configured
using \fI\%\-\-errorlog\-file\fP\&. The format of log message is as
follows:
.sp
<datetime> <master\-pid> <current\-pid> <thread\-id> <level> (<filename>:<line>) <msg>
.INDENT 7.0
.TP
.B <datetime>
It is a conbination of date and time when the log is written. It
is in ISO 8601 format.
.TP
.B <master\-pid>
It is a master process ID.
.TP
.B <current\-pid>
It is a process ID which writes this log.
.TP
.B <thread\-id>
It is a thread ID which writes this log. It would be unique
within <current\-pid>.
.TP
.B <filename> and <line>
They are source file name, and line number which produce this log.
.TP
.B <msg>
It is a log message body.
.UNINDENT
.UNINDENT .UNINDENT
.SH SIGNALS .SH SIGNALS
.INDENT 0.0 .INDENT 0.0

View File

@ -399,6 +399,13 @@ Timeout
Default: ``30s`` Default: ``30s``
.. option:: --frontend-keep-alive-timeout=<DURATION>
Specify keep-alive timeout for frontend HTTP/1
connection.
Default: ``1m``
.. option:: --stream-read-timeout=<DURATION> .. option:: --stream-read-timeout=<DURATION>
Specify read timeout for HTTP/2 and SPDY streams. 0 Specify read timeout for HTTP/2 and SPDY streams. 0
@ -434,7 +441,8 @@ Timeout
.. option:: --backend-keep-alive-timeout=<DURATION> .. option:: --backend-keep-alive-timeout=<DURATION>
Specify keep-alive timeout for backend connection. Specify keep-alive timeout for backend HTTP/1
connection.
Default: ``2s`` Default: ``2s``
@ -1126,7 +1134,7 @@ HTTP
Change server response header field value to <NAME>. Change server response header field value to <NAME>.
Default: ``nghttpx nghttp2/1.18.0-DEV`` Default: ``nghttpx nghttp2/1.18.0``
.. option:: --no-server-rewrite .. option:: --no-server-rewrite
@ -1301,6 +1309,33 @@ FILES
:option:`--conf` option cannot be used in the configuration file and :option:`--conf` option cannot be used in the configuration file and
will be ignored if specified. will be ignored if specified.
Error log
Error log is written to stderr by default. It can be configured
using :option:`--errorlog-file`. The format of log message is as
follows:
<datetime> <master-pid> <current-pid> <thread-id> <level> (<filename>:<line>) <msg>
<datetime>
It is a conbination of date and time when the log is written. It
is in ISO 8601 format.
<master-pid>
It is a master process ID.
<current-pid>
It is a process ID which writes this log.
<thread-id>
It is a thread ID which writes this log. It would be unique
within <current-pid>.
<filename> and <line>
They are source file name, and line number which produce this log.
<msg>
It is a log message body.
SIGNALS SIGNALS
------- -------