From ab0b98db61867963f60fa1ccd7ddfa86dd82dd20 Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Tue, 27 Dec 2016 20:42:46 +0900 Subject: [PATCH] Update man pages --- doc/h2load.1 | 2 +- doc/nghttp.1 | 2 +- doc/nghttpd.1 | 2 +- doc/nghttpx.1 | 44 +++++++++++++++++++++++++++++++++++++++++--- doc/nghttpx.1.rst | 39 +++++++++++++++++++++++++++++++++++++-- 5 files changed, 81 insertions(+), 8 deletions(-) diff --git a/doc/h2load.1 b/doc/h2load.1 index ee341126..277e8b83 100644 --- a/doc/h2load.1 +++ b/doc/h2load.1 @@ -1,6 +1,6 @@ .\" 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 . diff --git a/doc/nghttp.1 b/doc/nghttp.1 index bffd1183..5707e347 100644 --- a/doc/nghttp.1 +++ b/doc/nghttp.1 @@ -1,6 +1,6 @@ .\" 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 . diff --git a/doc/nghttpd.1 b/doc/nghttpd.1 index 62414cc5..999afec8 100644 --- a/doc/nghttpd.1 +++ b/doc/nghttpd.1 @@ -1,6 +1,6 @@ .\" 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 . diff --git a/doc/nghttpx.1 b/doc/nghttpx.1 index 16e77c44..2d52815b 100644 --- a/doc/nghttpx.1 +++ b/doc/nghttpx.1 @@ -1,6 +1,6 @@ .\" 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= +Specify keep\-alive timeout for frontend HTTP/1 +connection. +.sp +Default: \fB1m\fP +.UNINDENT +.INDENT 0.0 +.TP .B \-\-stream\-read\-timeout= 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= -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= Change server response header field value to . .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 + (:) +.INDENT 7.0 +.TP +.B +It is a conbination of date and time when the log is written. It +is in ISO 8601 format. +.TP +.B +It is a master process ID. +.TP +.B +It is a process ID which writes this log. +.TP +.B +It is a thread ID which writes this log. It would be unique +within . +.TP +.B and +They are source file name, and line number which produce this log. +.TP +.B +It is a log message body. +.UNINDENT .UNINDENT .SH SIGNALS .INDENT 0.0 diff --git a/doc/nghttpx.1.rst b/doc/nghttpx.1.rst index 4b12e540..fa8ccf02 100644 --- a/doc/nghttpx.1.rst +++ b/doc/nghttpx.1.rst @@ -399,6 +399,13 @@ Timeout Default: ``30s`` +.. option:: --frontend-keep-alive-timeout= + + Specify keep-alive timeout for frontend HTTP/1 + connection. + + Default: ``1m`` + .. option:: --stream-read-timeout= Specify read timeout for HTTP/2 and SPDY streams. 0 @@ -434,7 +441,8 @@ Timeout .. option:: --backend-keep-alive-timeout= - 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 . - 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: + + (:) + + + It is a conbination of date and time when the log is written. It + is in ISO 8601 format. + + + It is a master process ID. + + + It is a process ID which writes this log. + + + It is a thread ID which writes this log. It would be unique + within . + + and + They are source file name, and line number which produce this log. + + + It is a log message body. + SIGNALS -------