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 experimental 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:: --color
  74
  75     Force colored log output.
  76
  77 .. option:: -p, --push=<PATH>=<PUSH_PATH,...>
  78
  79     Push  resources <PUSH_PATH>s  when <PATH>  is requested.
  80     This option  can be used repeatedly  to specify multiple
  81     push  configurations.    <PATH>  and   <PUSH_PATH>s  are
  82     relative  to   document  root.   See   :option:`--htdocs`  option.
  83     Example: :option:`-p`\/=/foo.png :option:`-p`\/doc=/bar.css
  84
  85 .. option:: -b, --padding=<N>
  86
  87     Add at  most <N>  bytes to a  frame payload  as padding.
  88     Specify 0 to disable padding.
  89
  90 .. option:: -m, --max-concurrent-streams=<N>
  91
  92     Set the maximum number of  the concurrent streams in one
  93     HTTP/2 session.
  94
  95     Default: ``100``
  96
  97 .. option:: -n, --workers=<N>
  98
  99     Set the number of worker threads.
 100
 101     Default: ``1``
 102
 103 .. option:: -e, --error-gzip
 104
 105     Make error response gzipped.
 106
 107 .. option:: --dh-param-file=<PATH>
 108
 109     Path to file that contains  DH parameters in PEM format.
 110     Without  this   option,  DHE   cipher  suites   are  not
 111     available.
 112
 113 .. option:: --early-response
 114
 115     Start sending response when request HEADERS is received,
 116     rather than complete request is received.
 117
 118 .. option:: --trailer=<HEADER>
 119
 120     Add a trailer  header to a response.   <HEADER> must not
 121     include pseudo header field  (header field name starting
 122     with ':').  The  trailer is sent only if  a response has
 123     body part.  Example: :option:`--trailer` 'foo: bar'.
 124
 125 .. option:: --hexdump
 126
 127     Display the  incoming traffic in  hexadecimal (Canonical
 128     hex+ASCII display).  If SSL/TLS  is used, decrypted data
 129     are used.
 130
 131 .. option:: --echo-upload
 132
 133     Send back uploaded content if method is POST or PUT.
 134
 135 .. option:: --version
 136
 137     Display version information and exit.
 138
 139 .. option:: -h, --help
 140
 141     Display this help and exit.
 142
 143
 144
 145 The <SIZE> argument is an integer and an optional unit (e.g., 10K is
 146 10 * 1024).  Units are K, M and G (powers of 1024).
 147
 148 SEE ALSO
 149 --------
 150
 151 :manpage:`nghttp(1)`, :manpage:`nghttpx(1)`, :manpage:`h2load(1)`