doc/nghttpd.1

   1 .\" Man page generated from reStructuredText.
   2 .
   3 .TH "NGHTTPD" "1" "Oct 19, 2021" "1.46.0" "nghttp2"
   4 .SH NAME
   5 nghttpd \- HTTP/2 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 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 \-\-encoder\-header\-table\-size=<SIZE>
 103 Specify encoder header table size.  The decoder (client)
 104 specifies  the maximum  dynamic table  size it  accepts.
 105 Then the negotiated dynamic table size is the minimum of
 106 this option value and the value which client specified.
 107 .UNINDENT
 108 .INDENT 0.0
 109 .TP
 110 .B \-\-color
 111 Force colored log output.
 112 .UNINDENT
 113 .INDENT 0.0
 114 .TP
 115 .B \-p, \-\-push=<PATH>=<PUSH_PATH,...>
 116 Push  resources <PUSH_PATH>s  when <PATH>  is requested.
 117 This option  can be used repeatedly  to specify multiple
 118 push  configurations.    <PATH>  and   <PUSH_PATH>s  are
 119 relative  to   document  root.   See   \fI\%\-\-htdocs\fP  option.
 120 Example: \fI\%\-p\fP/=/foo.png \fI\%\-p\fP/doc=/bar.css
 121 .UNINDENT
 122 .INDENT 0.0
 123 .TP
 124 .B \-b, \-\-padding=<N>
 125 Add at  most <N>  bytes to a  frame payload  as padding.
 126 Specify 0 to disable padding.
 127 .UNINDENT
 128 .INDENT 0.0
 129 .TP
 130 .B \-m, \-\-max\-concurrent\-streams=<N>
 131 Set the maximum number of  the concurrent streams in one
 132 HTTP/2 session.
 133 .sp
 134 Default: \fB100\fP
 135 .UNINDENT
 136 .INDENT 0.0
 137 .TP
 138 .B \-n, \-\-workers=<N>
 139 Set the number of worker threads.
 140 .sp
 141 Default: \fB1\fP
 142 .UNINDENT
 143 .INDENT 0.0
 144 .TP
 145 .B \-e, \-\-error\-gzip
 146 Make error response gzipped.
 147 .UNINDENT
 148 .INDENT 0.0
 149 .TP
 150 .B \-w, \-\-window\-bits=<N>
 151 Sets the stream level initial window size to 2**<N>\-1.
 152 .UNINDENT
 153 .INDENT 0.0
 154 .TP
 155 .B \-W, \-\-connection\-window\-bits=<N>
 156 Sets  the  connection  level   initial  window  size  to
 157 2**<N>\-1.
 158 .UNINDENT
 159 .INDENT 0.0
 160 .TP
 161 .B \-\-dh\-param\-file=<PATH>
 162 Path to file that contains  DH parameters in PEM format.
 163 Without  this   option,  DHE   cipher  suites   are  not
 164 available.
 165 .UNINDENT
 166 .INDENT 0.0
 167 .TP
 168 .B \-\-early\-response
 169 Start sending response when request HEADERS is received,
 170 rather than complete request is received.
 171 .UNINDENT
 172 .INDENT 0.0
 173 .TP
 174 .B \-\-trailer=<HEADER>
 175 Add a trailer  header to a response.   <HEADER> must not
 176 include pseudo header field  (header field name starting
 177 with \(aq:\(aq).  The  trailer is sent only if  a response has
 178 body part.  Example: \fI\%\-\-trailer\fP \(aqfoo: bar\(aq.
 179 .UNINDENT
 180 .INDENT 0.0
 181 .TP
 182 .B \-\-hexdump
 183 Display the  incoming traffic in  hexadecimal (Canonical
 184 hex+ASCII display).  If SSL/TLS  is used, decrypted data
 185 are used.
 186 .UNINDENT
 187 .INDENT 0.0
 188 .TP
 189 .B \-\-echo\-upload
 190 Send back uploaded content if method is POST or PUT.
 191 .UNINDENT
 192 .INDENT 0.0
 193 .TP
 194 .B \-\-mime\-types\-file=<PATH>
 195 Path  to file  that contains  MIME media  types and  the
 196 extensions that represent them.
 197 .sp
 198 Default: \fB/etc/mime.types\fP
 199 .UNINDENT
 200 .INDENT 0.0
 201 .TP
 202 .B \-\-no\-content\-length
 203 Don\(aqt send content\-length header field.
 204 .UNINDENT
 205 .INDENT 0.0
 206 .TP
 207 .B \-\-version
 208 Display version information and exit.
 209 .UNINDENT
 210 .INDENT 0.0
 211 .TP
 212 .B \-h, \-\-help
 213 Display this help and exit.
 214 .UNINDENT
 215 .sp
 216 The <SIZE> argument is an integer and an optional unit (e.g., 10K is
 217 10 * 1024).  Units are K, M and G (powers of 1024).
 218 .SH SEE ALSO
 219 .sp
 220 \fBnghttp(1)\fP, \fBnghttpx(1)\fP, \fBh2load(1)\fP
 221 .SH AUTHOR
 222 Tatsuhiro Tsujikawa
 223 .SH COPYRIGHT
 224 2012, 2015, 2016, Tatsuhiro Tsujikawa
 225 .\" Generated by docutils manpage writer.
 226 .