Skip to content

Commit

Permalink
Update manual pages
Browse files Browse the repository at this point in the history
  • Loading branch information
tatsuhiro-t committed Jul 2, 2017
1 parent 6583780 commit 3bcc416
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 18 deletions.
2 changes: 1 addition & 1 deletion doc/h2load.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "H2LOAD" "1" "May 26, 2017" "1.23.0" "nghttp2"
.TH "H2LOAD" "1" "Jul 02, 2017" "1.24.0" "nghttp2"
.SH NAME
h2load \- HTTP/2 benchmarking tool
.
Expand Down
2 changes: 1 addition & 1 deletion doc/nghttp.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "NGHTTP" "1" "May 26, 2017" "1.23.0" "nghttp2"
.TH "NGHTTP" "1" "Jul 02, 2017" "1.24.0" "nghttp2"
.SH NAME
nghttp \- HTTP/2 client
.
Expand Down
2 changes: 1 addition & 1 deletion doc/nghttpd.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "NGHTTPD" "1" "May 26, 2017" "1.23.0" "nghttp2"
.TH "NGHTTPD" "1" "Jul 02, 2017" "1.24.0" "nghttp2"
.SH NAME
nghttpd \- HTTP/2 server
.
Expand Down
23 changes: 15 additions & 8 deletions doc/nghttpx.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "NGHTTPX" "1" "May 26, 2017" "1.23.0" "nghttp2"
.TH "NGHTTPX" "1" "Jul 02, 2017" "1.24.0" "nghttp2"
.SH NAME
nghttpx \- HTTP/2 proxy
.
Expand Down Expand Up @@ -604,11 +604,14 @@ enabled for backend connections.
.INDENT 0.0
.TP
.B \-\-cacert=<PATH>
Set path to trusted CA certificate file used in backend
TLS connections. The file must be in PEM format. It
can contain multiple certificates. If the linked
OpenSSL is configured to load system wide certificates,
they are loaded at startup regardless of this option.
Set path to trusted CA certificate file. It is used in
backend TLS connections to verify peer\(aqs certificate.
It is also used to verify OCSP response from the script
set by \fI\%\-\-fetch\-ocsp\-response\-file\fP\&. The file must be in
PEM format. It can contain multiple certificates. If
the linked OpenSSL is configured to load system wide
certificates, they are loaded at startup regardless of
this option.
.UNINDENT
.INDENT 0.0
.TP
Expand Down Expand Up @@ -691,10 +694,14 @@ done in case\-insensitive manner. The versions between
\fI\%\-\-tls\-min\-proto\-version\fP and \fI\%\-\-tls\-max\-proto\-version\fP are
enabled. If the protocol list advertised by client does
not overlap this range, you will receive the error
message "unknown protocol". The available versions are:
message "unknown protocol". If a protocol version lower
than TLSv1.2 is specified, make sure that the compatible
ciphers are included in \fI\%\-\-ciphers\fP option. The default
cipher list only includes ciphers compatible with
TLSv1.2 or above. The available versions are:
TLSv1.2, TLSv1.1, and TLSv1.0
.sp
Default: \fBTLSv1.1\fP
Default: \fBTLSv1.2\fP
.UNINDENT
.INDENT 0.0
.TP
Expand Down
21 changes: 14 additions & 7 deletions doc/nghttpx.1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -558,11 +558,14 @@ SSL/TLS

.. option:: --cacert=<PATH>

Set path to trusted CA certificate file used in backend
TLS connections. The file must be in PEM format. It
can contain multiple certificates. If the linked
OpenSSL is configured to load system wide certificates,
they are loaded at startup regardless of this option.
Set path to trusted CA certificate file. It is used in
backend TLS connections to verify peer's certificate.
It is also used to verify OCSP response from the script
set by :option:`--fetch-ocsp-response-file`\. The file must be in
PEM format. It can contain multiple certificates. If
the linked OpenSSL is configured to load system wide
certificates, they are loaded at startup regardless of
this option.

.. option:: --private-key-passwd-file=<PATH>

Expand Down Expand Up @@ -636,10 +639,14 @@ SSL/TLS
:option:`--tls-min-proto-version` and :option:`\--tls-max-proto-version` are
enabled. If the protocol list advertised by client does
not overlap this range, you will receive the error
message "unknown protocol". The available versions are:
message "unknown protocol". If a protocol version lower
than TLSv1.2 is specified, make sure that the compatible
ciphers are included in :option:`--ciphers` option. The default
cipher list only includes ciphers compatible with
TLSv1.2 or above. The available versions are:
TLSv1.2, TLSv1.1, and TLSv1.0

Default: ``TLSv1.1``
Default: ``TLSv1.2``

.. option:: --tls-max-proto-version=<VER>

Expand Down

0 comments on commit 3bcc416

Please sign in to comment.