nghttp2/doc/nghttpd.1.rst

139 lines
3.2 KiB
ReStructuredText
Raw Normal View History

2015-04-17 16:14:23 +02:00
.. program:: nghttpd
nghttpd(1)
==========
SYNOPSIS
--------
**nghttpd** [OPTION]... <PORT> [<PRIVATE_KEY> <CERT>]
DESCRIPTION
-----------
HTTP/2 experimental server
.. describe:: <PORT>
Specify listening port number.
.. describe:: <PRIVATE_KEY>
2015-01-15 16:10:16 +01:00
Set path to server's private key. Required unless
:option:`--no-tls` is specified.
.. describe:: <CERT>
2015-01-15 16:10:16 +01:00
Set path to server's certificate. Required unless
:option:`--no-tls` is specified.
2015-02-01 10:33:24 +01:00
OPTIONS
-------
2015-02-26 16:57:13 +01:00
.. option:: -a, --address=<ADDR>
The address to bind to. If not specified the default IP
address determined by getaddrinfo is used.
.. option:: -D, --daemon
2015-01-15 16:10:16 +01:00
Run in a background. If :option:`-D` is used, the current working
directory is changed to '*/*'. Therefore if this option
is used, :option:`-d` option must be specified.
.. option:: -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.
.. option:: -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.
.. option:: -v, --verbose
2015-01-15 16:10:16 +01:00
Print debug information such as reception/ transmission
of frames and name/value pairs.
.. option:: --no-tls
Disable SSL/TLS.
2015-01-15 16:10:16 +01:00
.. option:: -c, --header-table-size=<SIZE>
Specify decoder header table size.
.. option:: --color
Force colored log output.
.. option:: -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 :option:`--htdocs` option.
Example: :option:`-p`\/=/foo.png :option:`-p`\/doc=/bar.css
.. option:: -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.
2015-01-15 16:10:16 +01:00
.. option:: -n, --workers=<N>
Set the number of worker threads.
Default: ``1``
.. option:: -e, --error-gzip
Make error response gzipped.
.. option:: --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.
.. option:: --early-response
2015-01-15 16:10:16 +01:00
Start sending response when request HEADERS is received,
rather than complete request is received.
2015-03-14 10:52:50 +01:00
.. option:: --trailer=<HEADER>
Add a trailer header to a response. <HEADER> must not
include pseudo header field (header field name starting
with ':'). The trailer is sent only if a response has
body part. Example: :option:`--trailer` 'foo: bar'.
2015-03-26 16:37:12 +01:00
.. option:: --hexdump
Display the incoming traffic in hexadecimal (Canonical
hex+ASCII display). If SSL/TLS is used, decrypted data
are used.
.. option:: --version
Display version information and exit.
.. option:: -h, --help
Display this help and exit.
2015-01-15 16:10:16 +01:00
2015-03-30 17:23:12 +02:00
2015-01-15 16:10:16 +01:00
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).
SEE ALSO
--------
:manpage:`nghttp(1)`, :manpage:`nghttpx(1)`, :manpage:`h2load(1)`