nghttp2/doc/nghttpd.1

195 lines
4.5 KiB
Groff
Raw Normal View History

.\" Man page generated from reStructuredText.
.
2015-10-19 17:22:03 +02:00
.TH "NGHTTPD" "1" "October 20, 2015" "1.3.5-DEV" "nghttp2"
.SH NAME
2014-05-16 16:54:09 +02:00
nghttpd \- HTTP/2 experimental server
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fBnghttpd\fP [OPTION]... <PORT> [<PRIVATE_KEY> <CERT>]
.SH DESCRIPTION
.sp
2015-10-19 17:22:03 +02:00
HTTP/2 server
.INDENT 0.0
.TP
.B <PORT>
2014-05-16 16:54:09 +02:00
Specify listening port number.
.UNINDENT
.INDENT 0.0
.TP
.B <PRIVATE_KEY>
2015-01-15 16:10:16 +01:00
Set path to server\(aqs private key. Required unless
\fI\%\-\-no\-tls\fP is specified.
.UNINDENT
.INDENT 0.0
.TP
.B <CERT>
2015-01-15 16:10:16 +01:00
Set path to server\(aqs certificate. Required unless
\fI\%\-\-no\-tls\fP is specified.
.UNINDENT
2015-02-01 10:33:24 +01:00
.SH OPTIONS
.INDENT 0.0
.TP
2015-02-26 16:57:13 +01:00
.B \-a, \-\-address=<ADDR>
The address to bind to. If not specified the default IP
address determined by getaddrinfo is used.
.UNINDENT
.INDENT 0.0
.TP
.B \-D, \-\-daemon
2015-04-17 16:14:23 +02:00
Run in a background. If \fI\%\-D\fP is used, the current working
2015-01-15 16:10:16 +01:00
directory is changed to \(aq\fI/\fP\(aq. Therefore if this option
is used, \fI\%\-d\fP option must be specified.
.UNINDENT
.INDENT 0.0
.TP
.B \-V, \-\-verify\-client
2015-01-15 16:10:16 +01:00
The server sends a client certificate request. If the
client did not return a certificate, the handshake is
terminated. Currently, this option just requests a
client certificate and does not verify it.
.UNINDENT
.INDENT 0.0
.TP
.B \-d, \-\-htdocs=<PATH>
2015-01-15 16:10:16 +01:00
Specify document root. If this option is not specified,
the document root is the current working directory.
.UNINDENT
.INDENT 0.0
.TP
.B \-v, \-\-verbose
2015-01-15 16:10:16 +01:00
Print debug information such as reception/ transmission
of frames and name/value pairs.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-tls
Disable SSL/TLS.
.UNINDENT
.INDENT 0.0
.TP
2015-01-15 16:10:16 +01:00
.B \-c, \-\-header\-table\-size=<SIZE>
2014-05-16 16:54:09 +02:00
Specify decoder header table size.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-color
Force colored log output.
.UNINDENT
.INDENT 0.0
.TP
.B \-p, \-\-push=<PATH>=<PUSH_PATH,...>
2015-01-15 16:10:16 +01:00
Push resources <PUSH_PATH>s when <PATH> is requested.
This option can be used repeatedly to specify multiple
push configurations. <PATH> and <PUSH_PATH>s are
relative to document root. See \fI\%\-\-htdocs\fP option.
2015-04-17 16:14:23 +02:00
Example: \fI\%\-p\fP/=/foo.png \fI\%\-p\fP/doc=/bar.css
.UNINDENT
.INDENT 0.0
2014-05-16 16:54:09 +02:00
.TP
.B \-b, \-\-padding=<N>
2015-01-15 16:10:16 +01:00
Add at most <N> bytes to a frame payload as padding.
Specify 0 to disable padding.
.UNINDENT
.INDENT 0.0
2014-05-16 16:54:09 +02:00
.TP
2015-05-07 13:55:10 +02:00
.B \-m, \-\-max\-concurrent\-streams=<N>
Set the maximum number of the concurrent streams in one
HTTP/2 session.
.sp
Default: \fB100\fP
.UNINDENT
.INDENT 0.0
.TP
2015-01-15 16:10:16 +01:00
.B \-n, \-\-workers=<N>
2014-05-16 16:54:09 +02:00
Set the number of worker threads.
.sp
Default: \fB1\fP
.UNINDENT
.INDENT 0.0
2014-05-16 16:54:09 +02:00
.TP
.B \-e, \-\-error\-gzip
2014-05-16 16:54:09 +02:00
Make error response gzipped.
.UNINDENT
.INDENT 0.0
2014-05-16 16:54:09 +02:00
.TP
.B \-\-dh\-param\-file=<PATH>
2015-01-15 16:10:16 +01:00
Path to file that contains DH parameters in PEM format.
Without this option, DHE cipher suites are not
available.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-early\-response
2015-01-15 16:10:16 +01:00
Start sending response when request HEADERS is received,
rather than complete request is received.
.UNINDENT
.INDENT 0.0
.TP
2015-03-14 10:52:50 +01:00
.B \-\-trailer=<HEADER>
Add a trailer header to a response. <HEADER> must not
include pseudo header field (header field name starting
with \(aq:\(aq). The trailer is sent only if a response has
body part. Example: \fI\%\-\-trailer\fP \(aqfoo: bar\(aq.
.UNINDENT
.INDENT 0.0
.TP
2015-03-26 16:37:12 +01:00
.B \-\-hexdump
Display the incoming traffic in hexadecimal (Canonical
hex+ASCII display). If SSL/TLS is used, decrypted data
are used.
.UNINDENT
.INDENT 0.0
.TP
2015-05-12 17:44:37 +02:00
.B \-\-echo\-upload
Send back uploaded content if method is POST or PUT.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-version
2014-05-16 16:54:09 +02:00
Display version information and exit.
.UNINDENT
.INDENT 0.0
2014-05-16 16:54:09 +02:00
.TP
.B \-h, \-\-help
2014-05-16 16:54:09 +02:00
Display this help and exit.
.UNINDENT
2015-01-15 16:10:16 +01:00
.sp
The <SIZE> argument is an integer and an optional unit (e.g., 10K is
10 * 1024). Units are K, M and G (powers of 1024).
.SH SEE ALSO
.sp
\fInghttp(1)\fP, \fInghttpx(1)\fP, \fIh2load(1)\fP
.SH AUTHOR
Tatsuhiro Tsujikawa
.SH COPYRIGHT
2015-01-10 09:12:24 +01:00
2012, 2015, Tatsuhiro Tsujikawa
.\" Generated by docutils manpage writer.
.