doc/nghttpd.1.rst

   1
   2 nghttpd(1)
   3 ==========
   4
   5 SYNOPSIS
   6 --------
   7
   8 **nghttpd** [OPTION]... <PORT> [<PRIVATE_KEY> <CERT>]
   9
  10 DESCRIPTION
  11 -----------
  12
  13 HTTP/2 experimental server
  14
  15 .. describe:: <PORT>
  16
  17     Specify listening port number.
  18
  19 .. describe:: <PRIVATE_KEY>
  20
  21
  22     Set  path  to  server's private  key.   Required  unless
  23     :option:`--no-tls` is specified.
  24
  25 .. describe:: <CERT>
  26
  27     Set  path  to  server's  certificate.   Required  unless
  28     :option:`--no-tls` is specified.
  29
  30 OPTIONS
  31 -------
  32
  33 .. option:: -D, --daemon
  34
  35     Run in a background.  If :option:`-D` is used, the current working
  36     directory is  changed to '*/*'.  Therefore  if this option
  37     is used, :option:`-d` option must be specified.
  38
  39 .. option:: -V, --verify-client
  40
  41     The server  sends a client certificate  request.  If the
  42     client did  not return  a certificate, the  handshake is
  43     terminated.   Currently,  this  option just  requests  a
  44     client certificate and does not verify it.
  45
  46 .. option:: -d, --htdocs=<PATH>
  47
  48     Specify document root.  If this option is not specified,
  49     the document root is the current working directory.
  50
  51 .. option:: -v, --verbose
  52
  53     Print debug information  such as reception/ transmission
  54     of frames and name/value pairs.
  55
  56 .. option:: --no-tls
  57
  58     Disable SSL/TLS.
  59
  60 .. option:: -c, --header-table-size=<SIZE>
  61
  62     Specify decoder header table size.
  63
  64 .. option:: --color
  65
  66     Force colored log output.
  67
  68 .. option:: -p, --push=<PATH>=<PUSH_PATH,...>
  69
  70     Push  resources <PUSH_PATH>s  when <PATH>  is requested.
  71     This option  can be used repeatedly  to specify multiple
  72     push  configurations.    <PATH>  and   <PUSH_PATH>s  are
  73     relative  to   document  root.   See   :option:`--htdocs`  option.
  74     Example: :option:`-p`\/=/foo.png :option:`-p`\/doc=/bar.css
  75
  76 .. option:: -b, --padding=<N>
  77
  78     Add at  most <N>  bytes to a  frame payload  as padding.
  79     Specify 0 to disable padding.
  80
  81 .. option:: -n, --workers=<N>
  82
  83     Set the number of worker threads.
  84
  85     Default: ``1``
  86
  87 .. option:: -e, --error-gzip
  88
  89     Make error response gzipped.
  90
  91 .. option:: --dh-param-file=<PATH>
  92
  93     Path to file that contains  DH parameters in PEM format.
  94     Without  this   option,  DHE   cipher  suites   are  not
  95     available.
  96
  97 .. option:: --early-response
  98
  99     Start sending response when request HEADERS is received,
 100     rather than complete request is received.
 101
 102 .. option:: --version
 103
 104     Display version information and exit.
 105
 106 .. option:: -h, --help
 107
 108     Display this help and exit.
 109
 110
 111 The <SIZE> argument is an integer and an optional unit (e.g., 10K is
 112 10 * 1024).  Units are K, M and G (powers of 1024).
 113
 114 SEE ALSO
 115 --------
 116
 117 :manpage:`nghttp(1)`, :manpage:`nghttpx(1)`, :manpage:`h2load(1)`