walkero
/
nghttp2
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity
nghttp2/doc/h2load.1

147 lines
3.3 KiB
Groff
Raw Normal View History

Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.\" Man page generated from reStructuredText.
.
Update man pages
2015-01-11 11:03:45 +01:00
.TH "H2LOAD" "1" "January 11, 2015" "0.7.1" "nghttp2"
Add h2load.1 dev version for now to `make` happy
2014-05-09 17:34:56 +02:00
.SH NAME
h2load \- HTTP/2 benchmarking tool
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
Add h2load.1 dev version for now to `make` happy
2014-05-09 17:34:56 +02:00
.SH SYNOPSIS
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.sp
\fBh2load\fP [OPTIONS]... [URI]...
Add h2load.1 dev version for now to `make` happy
2014-05-09 17:34:56 +02:00
.SH DESCRIPTION
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.sp
Add h2load.1 dev version for now to `make` happy
2014-05-09 17:34:56 +02:00
benchmarking tool for HTTP/2 and SPDY server
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.INDENT 0.0
Add h2load.1 dev version for now to `make` happy
2014-05-09 17:34:56 +02:00
.TP
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.B <URI>
Add h2load.1 dev version for now to `make` happy
2014-05-09 17:34:56 +02:00
Specify URI to access. Multiple URIs can be
specified. URIs are used in this order for each
client. All URIs are used, then first URI is
used and then 2nd URI, and so on. The scheme,
host and port in the subsequent URIs, if present,
are ignored. Those in the first URI are used
solely.
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.UNINDENT
.SH OPTIONS:
.INDENT 0.0
Add h2load.1 dev version for now to `make` happy
2014-05-09 17:34:56 +02:00
.TP
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.B \-n, \-\-requests=<N>
Number of requests.
.sp
Default: \fB1\fP
.UNINDENT
.INDENT 0.0
Add h2load.1 dev version for now to `make` happy
2014-05-09 17:34:56 +02:00
.TP
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.B \-c, \-\-clients=<N>
Number of concurrent clients.
.sp
Default: \fB1\fP
.UNINDENT
.INDENT 0.0
Add h2load.1 dev version for now to `make` happy
2014-05-09 17:34:56 +02:00
.TP
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.B \-t, \-\-threads=<N>
Number of native threads.
.sp
Default: \fB1\fP
.UNINDENT
.INDENT 0.0
.TP
.B \-i, \-\-input\-file=<FILE>
Update man pages
2014-10-27 16:35:44 +01:00
Path of a file with multiple URIs are seperated
by EOLs. This option will disable URIs getting
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
from command\-line. If \(aq\-\(aq is given as <FILE>,
Update man pages
2014-10-27 16:35:44 +01:00
URIs will be read from stdin. URIs are used in
this order for each client. All URIs are used,
then first URI is used and then 2nd URI, and so
on. The scheme, host and port in the subsequent
URIs, if present, are ignored. Those in the
first URI are used solely.
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.UNINDENT
.INDENT 0.0
Update man pages
2014-10-27 16:35:44 +01:00
.TP
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.B \-m, \-\-max\-concurrent\-streams=(auto|<N>)
Add h2load.1 dev version for now to `make` happy
2014-05-09 17:34:56 +02:00
Max concurrent streams to issue per session. If
"auto" is given, the number of given URIs is
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
used.
.sp
Default: \fBauto\fP
.UNINDENT
.INDENT 0.0
Add h2load.1 dev version for now to `make` happy
2014-05-09 17:34:56 +02:00
.TP
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.B \-w, \-\-window\-bits=<N>
Add h2load.1 dev version for now to `make` happy
2014-05-09 17:34:56 +02:00
Sets the stream level initial window size to
(2**<N>)\-1. For SPDY, 2**<N> is used instead.
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.UNINDENT
.INDENT 0.0
Add h2load.1 dev version for now to `make` happy
2014-05-09 17:34:56 +02:00
.TP
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.B \-W, \-\-connection\-window\-bits=<N>
Add h2load.1 dev version for now to `make` happy
2014-05-09 17:34:56 +02:00
Sets the connection level initial window size to
(2**<N>)\-1. For SPDY, if <N> is strictly less
than 16, this option is ignored. Otherwise
2**<N> is used for SPDY.
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.UNINDENT
.INDENT 0.0
Add h2load.1 dev version for now to `make` happy
2014-05-09 17:34:56 +02:00
.TP
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.B \-H, \-\-header=<HEADER>
Update man pages
2014-10-27 16:35:44 +01:00
Add/Override a header to the requests.
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.UNINDENT
.INDENT 0.0
Update man pages
2014-10-27 16:35:44 +01:00
.TP
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.B \-p, \-\-no\-tls\-proto=<PROTOID>
Add h2load.1 dev version for now to `make` happy
2014-05-09 17:34:56 +02:00
Specify ALPN identifier of the protocol to be
used when accessing http URI without SSL/TLS.
Available protocols: spdy/2, spdy/3, spdy/3.1 and
doc: Update man pages
2014-08-16 15:54:15 +02:00
h2c\-14
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.sp
Default: \fBh2c\-14\fP
.UNINDENT
.INDENT 0.0
Add h2load.1 dev version for now to `make` happy
2014-05-09 17:34:56 +02:00
.TP
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.B \-v, \-\-verbose
Add h2load.1 dev version for now to `make` happy
2014-05-09 17:34:56 +02:00
Output debug information.
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.UNINDENT
.INDENT 0.0
Add h2load.1 dev version for now to `make` happy
2014-05-09 17:34:56 +02:00
.TP
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.B \-\-version
Add h2load.1 dev version for now to `make` happy
2014-05-09 17:34:56 +02:00
Display version information and exit.
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.UNINDENT
.INDENT 0.0
Add h2load.1 dev version for now to `make` happy
2014-05-09 17:34:56 +02:00
.TP
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.B \-h, \-\-help
Add h2load.1 dev version for now to `make` happy
2014-05-09 17:34:56 +02:00
Display this help and exit.
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.UNINDENT
.SH SEE ALSO
.sp
\fInghttp(1)\fP, \fInghttpd(1)\fP, \fInghttpx(1)\fP
.SH AUTHOR
Tatsuhiro Tsujikawa
.SH COPYRIGHT
Update doc about nghttpx feature
2015-01-10 09:12:24 +01:00
2012, 2015, Tatsuhiro Tsujikawa
Produce man pages using sphinx Previously to create manual page for bundled programs, we use help2man to create man page from program's help output. Then our man2rst.py script converts man page to rst document. Sphinx generates html from rst documents. Now help2rst.py produces rst document from programs output. We use Sphinx solely to produce both man pages and html files.
2015-01-09 16:37:42 +01:00
.\" Generated by docutils manpage writer.
.