Commit ab0b98db authored by Tatsuhiro Tsujikawa's avatar Tatsuhiro Tsujikawa

Update man pages

parent 4245d986
.\" 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
h2load \- HTTP/2 benchmarking tool
.
......
.\" 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
nghttp \- HTTP/2 client
.
......
.\" 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
nghttpd \- HTTP/2 server
.
......
.\" 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
nghttpx \- HTTP/2 proxy
.
......@@ -434,6 +434,14 @@ Default: \fB30s\fP
.UNINDENT
.INDENT 0.0
.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>
Specify read timeout for HTTP/2 and SPDY streams. 0
means no timeout.
......@@ -473,7 +481,8 @@ Default: \fB30s\fP
.INDENT 0.0
.TP
.B \-\-backend\-keep\-alive\-timeout=<DURATION>
Specify keep\-alive timeout for backend connection.
Specify keep\-alive timeout for backend HTTP/1
connection.
.sp
Default: \fB2s\fP
.UNINDENT
......@@ -1246,7 +1255,7 @@ backend server, the custom error pages are not used.
.B \-\-server\-name=<NAME>
Change server response header field value to <NAME>.
.sp
Default: \fBnghttpx nghttp2/1.18.0\-DEV\fP
Default: \fBnghttpx nghttp2/1.18.0\fP
.UNINDENT
.INDENT 0.0
.TP
......@@ -1428,6 +1437,35 @@ positional arguments in command\-line, use \fBprivate\-key\-file\fP and
.sp
\fI\%\-\-conf\fP option cannot be used in the configuration file and
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
.SH SIGNALS
.INDENT 0.0
......
......@@ -399,6 +399,13 @@ Timeout
Default: ``30s``
.. option:: --frontend-keep-alive-timeout=<DURATION>
Specify keep-alive timeout for frontend HTTP/1
connection.
Default: ``1m``
.. option:: --stream-read-timeout=<DURATION>
Specify read timeout for HTTP/2 and SPDY streams. 0
......@@ -434,7 +441,8 @@ Timeout
.. option:: --backend-keep-alive-timeout=<DURATION>
Specify keep-alive timeout for backend connection.
Specify keep-alive timeout for backend HTTP/1
connection.
Default: ``2s``
......@@ -1126,7 +1134,7 @@ HTTP
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
......@@ -1301,6 +1309,33 @@ FILES
:option:`--conf` option cannot be used in the configuration file and
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
-------
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment