doc/nghttpd.1.rst

   1
   2 .. GENERATED by help2rst.py.  DO NOT EDIT DIRECTLY.
   3
   4 .. program:: nghttpd
   5
   6 nghttpd(1)
   7 ==========
   8
   9 SYNOPSIS
  10 --------
  11
  12 **nghttpd** [OPTION]... <PORT> [<PRIVATE_KEY> <CERT>]
  13
  14 DESCRIPTION
  15 -----------
  16
  17 HTTP/2 server
  18
  19 .. describe:: <PORT>
  20
  21     Specify listening port number.
  22
  23 .. describe:: <PRIVATE_KEY>
  24
  25
  26     Set  path  to  server's private  key.   Required  unless
  27     :option:`--no-tls` is specified.
  28
  29 .. describe:: <CERT>
  30
  31     Set  path  to  server's  certificate.   Required  unless
  32     :option:`--no-tls` is specified.
  33
  34 OPTIONS
  35 -------
  36
  37 .. option:: -a, --address=<ADDR>
  38
  39     The address to bind to.  If not specified the default IP
  40     address determined by getaddrinfo is used.
  41
  42 .. option:: -D, --daemon
  43
  44     Run in a background.  If :option:`-D` is used, the current working
  45     directory is  changed to '*/*'.  Therefore  if this option
  46     is used, :option:`-d` option must be specified.
  47
  48 .. option:: -V, --verify-client
  49
  50     The server  sends a client certificate  request.  If the
  51     client did  not return  a certificate, the  handshake is
  52     terminated.   Currently,  this  option just  requests  a
  53     client certificate and does not verify it.
  54
  55 .. option:: -d, --htdocs=<PATH>
  56
  57     Specify document root.  If this option is not specified,
  58     the document root is the current working directory.
  59
  60 .. option:: -v, --verbose
  61
  62     Print debug information  such as reception/ transmission
  63     of frames and name/value pairs.
  64
  65 .. option:: --no-tls
  66
  67     Disable SSL/TLS.
  68
  69 .. option:: -c, --header-table-size=<SIZE>
  70
  71     Specify decoder header table size.
  72
  73 .. option:: --encoder-header-table-size=<SIZE>
  74
  75     Specify encoder header table size.  The decoder (client)
  76     specifies  the maximum  dynamic table  size it  accepts.
  77     Then the negotiated dynamic table size is the minimum of
  78     this option value and the value which client specified.
  79
  80 .. option:: --color
  81
  82     Force colored log output.
  83
  84 .. option:: -p, --push=<PATH>=<PUSH_PATH,...>
  85
  86     Push  resources <PUSH_PATH>s  when <PATH>  is requested.
  87     This option  can be used repeatedly  to specify multiple
  88     push  configurations.    <PATH>  and   <PUSH_PATH>s  are
  89     relative  to   document  root.   See   :option:`--htdocs`  option.
  90     Example: :option:`-p`\/=/foo.png :option:`-p`\/doc=/bar.css
  91
  92 .. option:: -b, --padding=<N>
  93
  94     Add at  most <N>  bytes to a  frame payload  as padding.
  95     Specify 0 to disable padding.
  96
  97 .. option:: -m, --max-concurrent-streams=<N>
  98
  99     Set the maximum number of  the concurrent streams in one
 100     HTTP/2 session.
 101
 102     Default: ``100``
 103
 104 .. option:: -n, --workers=<N>
 105
 106     Set the number of worker threads.
 107
 108     Default: ``1``
 109
 110 .. option:: -e, --error-gzip
 111
 112     Make error response gzipped.
 113
 114 .. option:: -w, --window-bits=<N>
 115
 116     Sets the stream level initial window size to 2\*\*<N>-1.
 117
 118 .. option:: -W, --connection-window-bits=<N>
 119
 120     Sets  the  connection  level   initial  window  size  to
 121     2\*\*<N>-1.
 122
 123 .. option:: --dh-param-file=<PATH>
 124
 125     Path to file that contains  DH parameters in PEM format.
 126     Without  this   option,  DHE   cipher  suites   are  not
 127     available.
 128
 129 .. option:: --early-response
 130
 131     Start sending response when request HEADERS is received,
 132     rather than complete request is received.
 133
 134 .. option:: --trailer=<HEADER>
 135
 136     Add a trailer  header to a response.   <HEADER> must not
 137     include pseudo header field  (header field name starting
 138     with ':').  The  trailer is sent only if  a response has
 139     body part.  Example: :option:`--trailer` 'foo: bar'.
 140
 141 .. option:: --hexdump
 142
 143     Display the  incoming traffic in  hexadecimal (Canonical
 144     hex+ASCII display).  If SSL/TLS  is used, decrypted data
 145     are used.
 146
 147 .. option:: --echo-upload
 148
 149     Send back uploaded content if method is POST or PUT.
 150
 151 .. option:: --mime-types-file=<PATH>
 152
 153     Path  to file  that contains  MIME media  types and  the
 154     extensions that represent them.
 155
 156     Default: ``/etc/mime.types``
 157
 158 .. option:: --no-content-length
 159
 160     Don't send content-length header field.
 161
 162 .. option:: --version
 163
 164     Display version information and exit.
 165
 166 .. option:: -h, --help
 167
 168     Display this help and exit.
 169
 170
 171
 172 The <SIZE> argument is an integer and an optional unit (e.g., 10K is
 173 10 * 1024).  Units are K, M and G (powers of 1024).
 174
 175 SEE ALSO
 176 --------
 177
 178 :manpage:`nghttp(1)`, :manpage:`nghttpx(1)`, :manpage:`h2load(1)`