doc/nghttpd.1

   1 .\" Man page generated from reStructuredText.
   2 .
   3 .TH "NGHTTPD" "1" "May 16, 2015" "1.0.0" "nghttp2"
   4 .SH NAME
   5 nghttpd \- HTTP/2 experimental server
   6 .
   7 .nr rst2man-indent-level 0
   8 .
   9 .de1 rstReportMargin
  10 \\$1 \\n[an-margin]
  11 level \\n[rst2man-indent-level]
  12 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  13 -
  14 \\n[rst2man-indent0]
  15 \\n[rst2man-indent1]
  16 \\n[rst2man-indent2]
  17 ..
  18 .de1 INDENT
  19 .\" .rstReportMargin pre:
  20 . RS \\$1
  21 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  22 . nr rst2man-indent-level +1
  23 .\" .rstReportMargin post:
  24 ..
  25 .de UNINDENT
  26 . RE
  27 .\" indent \\n[an-margin]
  28 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29 .nr rst2man-indent-level -1
  30 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  31 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  32 ..
  33 .SH SYNOPSIS
  34 .sp
  35 \fBnghttpd\fP [OPTION]... <PORT> [<PRIVATE_KEY> <CERT>]
  36 .SH DESCRIPTION
  37 .sp
  38 HTTP/2 experimental server
  39 .INDENT 0.0
  40 .TP
  41 .B <PORT>
  42 Specify listening port number.
  43 .UNINDENT
  44 .INDENT 0.0
  45 .TP
  46 .B <PRIVATE_KEY>
  47 Set  path  to  server\(aqs private  key.   Required  unless
  48 \fI\%\-\-no\-tls\fP is specified.
  49 .UNINDENT
  50 .INDENT 0.0
  51 .TP
  52 .B <CERT>
  53 Set  path  to  server\(aqs  certificate.   Required  unless
  54 \fI\%\-\-no\-tls\fP is specified.
  55 .UNINDENT
  56 .SH OPTIONS
  57 .INDENT 0.0
  58 .TP
  59 .B \-a, \-\-address=<ADDR>
  60 The address to bind to.  If not specified the default IP
  61 address determined by getaddrinfo is used.
  62 .UNINDENT
  63 .INDENT 0.0
  64 .TP
  65 .B \-D, \-\-daemon
  66 Run in a background.  If \fI\%\-D\fP is used, the current working
  67 directory is  changed to \(aq\fI/\fP\(aq.  Therefore  if this option
  68 is used, \fI\%\-d\fP option must be specified.
  69 .UNINDENT
  70 .INDENT 0.0
  71 .TP
  72 .B \-V, \-\-verify\-client
  73 The server  sends a client certificate  request.  If the
  74 client did  not return  a certificate, the  handshake is
  75 terminated.   Currently,  this  option just  requests  a
  76 client certificate and does not verify it.
  77 .UNINDENT
  78 .INDENT 0.0
  79 .TP
  80 .B \-d, \-\-htdocs=<PATH>
  81 Specify document root.  If this option is not specified,
  82 the document root is the current working directory.
  83 .UNINDENT
  84 .INDENT 0.0
  85 .TP
  86 .B \-v, \-\-verbose
  87 Print debug information  such as reception/ transmission
  88 of frames and name/value pairs.
  89 .UNINDENT
  90 .INDENT 0.0
  91 .TP
  92 .B \-\-no\-tls
  93 Disable SSL/TLS.
  94 .UNINDENT
  95 .INDENT 0.0
  96 .TP
  97 .B \-c, \-\-header\-table\-size=<SIZE>
  98 Specify decoder header table size.
  99 .UNINDENT
 100 .INDENT 0.0
 101 .TP
 102 .B \-\-color
 103 Force colored log output.
 104 .UNINDENT
 105 .INDENT 0.0
 106 .TP
 107 .B \-p, \-\-push=<PATH>=<PUSH_PATH,...>
 108 Push  resources <PUSH_PATH>s  when <PATH>  is requested.
 109 This option  can be used repeatedly  to specify multiple
 110 push  configurations.    <PATH>  and   <PUSH_PATH>s  are
 111 relative  to   document  root.   See   \fI\%\-\-htdocs\fP  option.
 112 Example: \fI\%\-p\fP/=/foo.png \fI\%\-p\fP/doc=/bar.css
 113 .UNINDENT
 114 .INDENT 0.0
 115 .TP
 116 .B \-b, \-\-padding=<N>
 117 Add at  most <N>  bytes to a  frame payload  as padding.
 118 Specify 0 to disable padding.
 119 .UNINDENT
 120 .INDENT 0.0
 121 .TP
 122 .B \-m, \-\-max\-concurrent\-streams=<N>
 123 Set the maximum number of  the concurrent streams in one
 124 HTTP/2 session.
 125 .sp
 126 Default: \fB100\fP
 127 .UNINDENT
 128 .INDENT 0.0
 129 .TP
 130 .B \-n, \-\-workers=<N>
 131 Set the number of worker threads.
 132 .sp
 133 Default: \fB1\fP
 134 .UNINDENT
 135 .INDENT 0.0
 136 .TP
 137 .B \-e, \-\-error\-gzip
 138 Make error response gzipped.
 139 .UNINDENT
 140 .INDENT 0.0
 141 .TP
 142 .B \-\-dh\-param\-file=<PATH>
 143 Path to file that contains  DH parameters in PEM format.
 144 Without  this   option,  DHE   cipher  suites   are  not
 145 available.
 146 .UNINDENT
 147 .INDENT 0.0
 148 .TP
 149 .B \-\-early\-response
 150 Start sending response when request HEADERS is received,
 151 rather than complete request is received.
 152 .UNINDENT
 153 .INDENT 0.0
 154 .TP
 155 .B \-\-trailer=<HEADER>
 156 Add a trailer  header to a response.   <HEADER> must not
 157 include pseudo header field  (header field name starting
 158 with \(aq:\(aq).  The  trailer is sent only if  a response has
 159 body part.  Example: \fI\%\-\-trailer\fP \(aqfoo: bar\(aq.
 160 .UNINDENT
 161 .INDENT 0.0
 162 .TP
 163 .B \-\-hexdump
 164 Display the  incoming traffic in  hexadecimal (Canonical
 165 hex+ASCII display).  If SSL/TLS  is used, decrypted data
 166 are used.
 167 .UNINDENT
 168 .INDENT 0.0
 169 .TP
 170 .B \-\-echo\-upload
 171 Send back uploaded content if method is POST or PUT.
 172 .UNINDENT
 173 .INDENT 0.0
 174 .TP
 175 .B \-\-version
 176 Display version information and exit.
 177 .UNINDENT
 178 .INDENT 0.0
 179 .TP
 180 .B \-h, \-\-help
 181 Display this help and exit.
 182 .UNINDENT
 183 .sp
 184 The <SIZE> argument is an integer and an optional unit (e.g., 10K is
 185 10 * 1024).  Units are K, M and G (powers of 1024).
 186 .SH SEE ALSO
 187 .sp
 188 \fInghttp(1)\fP, \fInghttpx(1)\fP, \fIh2load(1)\fP
 189 .SH AUTHOR
 190 Tatsuhiro Tsujikawa
 191 .SH COPYRIGHT
 192 2012, 2015, Tatsuhiro Tsujikawa
 193 .\" Generated by docutils manpage writer.
 194 .