Commit 453e12cd authored by Tatsuhiro Tsujikawa's avatar Tatsuhiro Tsujikawa

Update man pages

parent de5c8215
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.45.1. .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.45.1.
.TH H2LOAD "1" "May 2014" "h2load nghttp2/0.4.0-DEV" "User Commands" .TH H2LOAD "1" "May 2014" "h2load nghttp2/0.4.0" "User Commands"
.SH NAME .SH NAME
h2load \- HTTP/2 benchmarking tool h2load \- HTTP/2 benchmarking tool
.SH SYNOPSIS .SH SYNOPSIS
......
.\" nghttp2 manual page .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.45.1.
.TH nghttp2 "1" "January 2014" "nghttp2" "User Commands" .TH NGHTTP "1" "May 2014" "nghttp nghttp2/0.4.0" "User Commands"
.SH NAME .SH NAME
nghttp2 \- HTTP2 experimental client nghttp \- HTTP/2 experimental client
.SH SYNOPSIS .SH SYNOPSIS
\fBnghttp\fP [\fIOPTIONS\fP] \fIURI\fP... .B nghttp
[\fI\,OPTIONS\/\fR]... \fI\,<URI>\/\fR...
.SH DESCRIPTION .SH DESCRIPTION
Experimental client for HTTP 2.0. HTTP/2 experimental client
.TP
<URI>
Specify URI to access.
.SH OPTIONS .SH OPTIONS
.TP .TP
\fB\-v\fR, \fB\-\-verbose\fR \fB\-v\fR, \fB\-\-verbose\fR
Print debug information such as reception/ Print debug information such as reception and
transmission of frames and name/value pairs. transmission of frames and name/value pairs.
.TP .TP
\fB\-n\fR, \fB\-\-null\-out\fR \fB\-n\fR, \fB\-\-null\-out\fR
Discard downloaded data. Discard downloaded data.
.TP .TP
\fB\-O\fR, \fB\-\-remote\-name\fR \fB\-O\fR, \fB\-\-remote\-name\fR
Save download data in the current directory. Save download data in the current directory. The
The filename is dereived from URI. If URI filename is dereived from URI. If URI ends with
ends with '/', 'index.html' is used as a \&'/', 'index.html' is used as a filename. Not
filename. Not implemented yet. implemented yet.
.TP .TP
\fB\-t\fR, \fB\-\-timeout=\fR<N> \fB\-t\fR, \fB\-\-timeout=\fR<N>
Timeout each request after <N> seconds. Timeout each request after <N> seconds.
.TP .TP
\fB\-w\fR, \fB\-\-window\-bits=\fR<N> \fB\-w\fR, \fB\-\-window\-bits=\fR<N>
Sets the stream level initial window size Sets the stream level initial window size to
to 2**<N>\-1. 2**<N>\-1.
.TP .TP
\fB\-W\fR, \fB\-\-connection\-window\-bits=\fR<N> \fB\-W\fR, \fB\-\-connection\-window\-bits=\fR<N>
Sets the connection level initial window Sets the connection level initial window size to
size to 2**<N>\-1. 2**<N>\-1.
.TP .TP
\fB\-a\fR, \fB\-\-get\-assets\fR \fB\-a\fR, \fB\-\-get\-assets\fR
Download assets such as stylesheets, images Download assets such as stylesheets, images and
and script files linked from the downloaded script files linked from the downloaded resource.
resource. Only links whose origins are the Only links whose origins are the same with the
same with the linking resource will be linking resource will be downloaded.
downloaded.
.TP .TP
\fB\-s\fR, \fB\-\-stat\fR \fB\-s\fR, \fB\-\-stat\fR
Print statistics. Print statistics.
...@@ -46,45 +49,61 @@ Print statistics. ...@@ -46,45 +49,61 @@ Print statistics.
Add a header to the requests. Add a header to the requests.
.TP .TP
\fB\-\-cert=\fR<CERT> \fB\-\-cert=\fR<CERT>
Use the specified client certificate file. Use the specified client certificate file. The
The file must be in PEM format. file must be in PEM format.
.TP .TP
\fB\-\-key=\fR<KEY> \fB\-\-key=\fR<KEY>
Use the client private key file. The file Use the client private key file. The file must
must be in PEM format. be in PEM format.
.TP .TP
\fB\-d\fR, \fB\-\-data=\fR<FILE> \fB\-d\fR, \fB\-\-data=\fR<FILE>
Post FILE to server. If \- is given, data Post FILE to server. If '\-' is given, data will
will be read from stdin. be read from stdin.
.TP .TP
\fB\-m\fR, \fB\-\-multiply=\fR<N> Request each URI <N> times. By default, same \fB\-g\fR, \fB\-\-compress\-data\fR
URI is not requested twice. This option When used with \fB\-d\fR option, compress request body
disables it too. on the fly using per\-frame compression.
.TP .TP
\fB\-f\fR, \fB\-\-no\-flow\-control\fR \fB\-m\fR, \fB\-\-multiply=\fR<N> Request each URI <N> times.
Disables connection and stream level flow By default, same URI
controls. is not requested twice. This option disables it
too.
.TP .TP
\fB\-u\fR, \fB\-\-upgrade\fR \fB\-u\fR, \fB\-\-upgrade\fR
Perform HTTP Upgrade for HTTP/2.0. This Perform HTTP Upgrade for HTTP/2. This option is
option is ignored if the request URI has ignored if the request URI has https scheme. If
https scheme. \fB\-d\fR is used, the HTTP upgrade request is performed
If \fB\-d\fR is used, the HTTP upgrade request is with OPTIONS method.
performed with OPTIONS method.
.TP .TP
\fB\-p\fR, \fB\-\-pri=\fR<PRIORITY> \fB\-p\fR, \fB\-\-weight=\fR<WEIGHT>
Sets stream priority. Default: 1073741824 Sets priority group weight. The valid value
range is [1, 256], inclusive.
Default: 16
.TP .TP
\fB\-M\fR, \fB\-\-peer\-max\-concurrent\-streams=\fR<N> \fB\-M\fR, \fB\-\-peer\-max\-concurrent\-streams=\fR<N>
Use <N> as SETTINGS_MAX_CONCURRENT_STREAMS Use <N> as SETTINGS_MAX_CONCURRENT_STREAMS value
value of remote endpoint as if it is of remote endpoint as if it is received in
received in SETTINGS frame. The default SETTINGS frame. The default is large enough as
is large enough as it is seen as unlimited. it is seen as unlimited.
.TP .TP
\fB\-c\fR, \fB\-\-header\-table\-size=\fR<N> \fB\-c\fR, \fB\-\-header\-table\-size=\fR<N>
Specify decoder header table size. Specify decoder header table size.
.TP .TP
\fB\-b\fR, \fB\-\-padding=\fR<N>
Add at most <N> bytes to a frame payload as
padding. Specify 0 to disable padding.
.TP
\fB\-\-color\fR \fB\-\-color\fR
Force colored log output. Force colored log output.
.TP
\fB\-\-continuation\fR
Send large header to test CONTINUATION.
.TP
\fB\-\-version\fR
Display version information and exit.
.TP
\fB\-h\fR, \fB\-\-help\fR
Display this help and exit.
.SH "SEE ALSO" .SH "SEE ALSO"
nghttpd(1), nghttpx(1)
nghttpd(1), nghttpx(1), h2load(1)
.\" nghttpd manual page .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.45.1.
.TH nghttpd "1" "January 2014" "nghttpd" "User Commands" .TH NGHTTPD "1" "May 2014" "nghttpd nghttp2/0.4.0" "User Commands"
.SH NAME .SH NAME
nghttpd \- HTTP 2.0 experimental server nghttpd \- HTTP/2 experimental server
.SH SYNOPSIS .SH SYNOPSIS
\fBnghttpd\fP [\fIOPTIONS\fP...] [\fIPRIVATE_KEY\fP \fICERT\fP] .B nghttpd
[\fI\,OPTION\/\fR]... \fI\,<PORT> <PRIVATE_KEY> <CERT>\/\fR
.br
.B nghttpd
\fI\,--no-tls \/\fR[\fI\,OPTION\/\fR]... \fI\,<PORT>\/\fR
.SH DESCRIPTION .SH DESCRIPTION
Experimental HTTP 2.0 server. HTTP/2 experimental server
.SH "Positional arguments"
.TP .TP
\fIPRIVATE_KEY\fP <PORT>
Specify listening port number.
.TP
<PRIVATE_KEY>
Set path to server's private key. Required Set path to server's private key. Required
unless either \fB\-p\fR or \fB\-\-client\fR is specified. unless \fB\-\-no\-tls\fR is specified.
.TP .TP
\fICERT\fP <CERT>
Set path to server's certificate. Required Set path to server's certificate. Required
unless either \fB\-p\fR or \fB\-\-client\fR is specified. unless \fB\-\-no\-tls\fR is specified.
.SH OPTIONS .SH OPTIONS
.TP .TP
\fB\-D\fR, \fB\-\-daemon\fR \fB\-D\fR, \fB\-\-daemon\fR
Run in a background. If \fB\-D\fR is used, the Run in a background. If \fB\-D\fR is used, the current
current working directory is changed to '/'. working directory is changed to '/'. Therefore
Therefore if this option is used, \fB\-d\fR option if this option is used, \fB\-d\fR option must be
must be specified. specified.
.TP .TP
\fB\-V\fR, \fB\-\-verify\-client\fR \fB\-V\fR, \fB\-\-verify\-client\fR
The server sends a client certificate The server sends a client certificate request.
request. If the client did not return a If the client did not return a certificate, the
certificate, the handshake is terminated. handshake is terminated. Currently, this option
Currently, this option just requests a just requests a client certificate and does not
client certificate and does not verify it. verify it.
.TP .TP
\fB\-d\fR, \fB\-\-htdocs=\fR<PATH> \fB\-d\fR, \fB\-\-htdocs=\fR<PATH>
Specify document root. If this option is Specify document root. If this option is not
not specified, the document root is the specified, the document root is the current
current working directory. working directory.
.TP .TP
\fB\-v\fR, \fB\-\-verbose\fR \fB\-v\fR, \fB\-\-verbose\fR
Print debug information such as reception/ Print debug information such as reception/
...@@ -42,14 +48,36 @@ transmission of frames and name/value pairs. ...@@ -42,14 +48,36 @@ transmission of frames and name/value pairs.
\fB\-\-no\-tls\fR \fB\-\-no\-tls\fR
Disable SSL/TLS. Disable SSL/TLS.
.TP .TP
\fB\-f\fR, \fB\-\-no\-flow\-control\fR \fB\-c\fR, \fB\-\-header\-table\-size=\fR<N>
Disables connection and stream level flow Specify decoder header table size.
controls.
.TP .TP
\fB\-\-color\fR \fB\-\-color\fR
Force colored log output. Force colored log output.
.TP .TP
\fB\-p\fR, \fB\-\-push=\fR<PATH>=<PUSH_PATH,...>
Push resources <PUSH_PATH>s when <PATH> is
requested. This option can be used repeatedly to
specify multiple push configurations. <PATH> and
<PUSH_PATH>s are relative to document root. See
\fB\-\-htdocs\fR option. Example: \fB\-p\fR/=/foo.png
\fB\-p\fR/doc=/bar.css
.TP
\fB\-b\fR, \fB\-\-padding=\fR<N>
Add at most <N> bytes to a frame payload as
padding. Specify 0 to disable padding.
.TP
\fB\-n\fR, \fB\-\-workers=\fR<CORE>
Set the number of worker threads.
Default: 1
.TP
\fB\-e\fR, \fB\-\-error\-gzip\fR
Make error response gzipped.
.TP
\fB\-\-version\fR
Display version information and exit.
.TP
\fB\-h\fR, \fB\-\-help\fR \fB\-h\fR, \fB\-\-help\fR
Print this help. Display this help and exit.
.SH "SEE ALSO" .SH "SEE ALSO"
nghttp(1), nghttpx(1)
nghttp(1), nghttpx(1), h2load(1)
This diff is collapsed.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment