Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
N
nghttp2
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Libraries
nghttp2
Commits
e428bff9
Commit
e428bff9
authored
Jan 19, 2016
by
Tatsuhiro Tsujikawa
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update man pages
parent
d162f7c1
Changes
6
Show whitespace changes
Inline
Side-by-side
Showing
6 changed files
with
156 additions
and
10 deletions
+156
-10
doc/h2load.1
doc/h2load.1
+8
-3
doc/h2load.1.rst
doc/h2load.1.rst
+7
-2
doc/nghttp.1
doc/nghttp.1
+1
-1
doc/nghttpd.1
doc/nghttpd.1
+1
-1
doc/nghttpx.1
doc/nghttpx.1
+78
-2
doc/nghttpx.1.rst
doc/nghttpx.1.rst
+61
-1
No files found.
doc/h2load.1
View file @
e428bff9
.\" Man page generated from reStructuredText.
.\" Man page generated from reStructuredText.
.
.
.TH "H2LOAD" "1" "January 1
1
, 2016" "1.6.1-DEV" "nghttp2"
.TH "H2LOAD" "1" "January 1
9
, 2016" "1.6.1-DEV" "nghttp2"
.SH NAME
.SH NAME
h2load \- HTTP/2 benchmarking tool
h2load \- HTTP/2 benchmarking tool
.
.
...
@@ -208,11 +208,16 @@ port values.
...
@@ -208,11 +208,16 @@ port values.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 0.0
.TP
.TP
.B \-B, \-\-base\-uri=
<URI>
.B \-B, \-\-base\-uri=
(<URI>|unix:<PATH>)
Specify URI from which the scheme, host and port will be
Specify URI from which the scheme, host and port will be
used for all requests. The base URI overrides all
used for all requests. The base URI overrides all
values defined either at the command line or inside
values defined either at the command line or inside
input files.
input files. If argument starts with "unix:", then the
rest of the argument will be treated as UNIX domain
socket path. The connection is made through that path
instead of TCP. In this case, scheme is inferred from
the first URI appeared in the command line or inside
input files as usual.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 0.0
.TP
.TP
...
...
doc/h2load.1.rst
View file @
e428bff9
...
@@ -171,12 +171,17 @@ OPTIONS
...
@@ -171,12 +171,17 @@ OPTIONS
Definition of a base URI overrides all scheme, host or
Definition of a base URI overrides all scheme, host or
port values.
port values.
.. option:: -B, --base-uri=
<URI>
.. option:: -B, --base-uri=
(<URI>|unix:<PATH>)
Specify URI from which the scheme, host and port will be
Specify URI from which the scheme, host and port will be
used for all requests. The base URI overrides all
used for all requests. The base URI overrides all
values defined either at the command line or inside
values defined either at the command line or inside
input files.
input files. If argument starts with "unix:", then the
rest of the argument will be treated as UNIX domain
socket path. The connection is made through that path
instead of TCP. In this case, scheme is inferred from
the first URI appeared in the command line or inside
input files as usual.
.. option:: --npn-list=<LIST>
.. option:: --npn-list=<LIST>
...
...
doc/nghttp.1
View file @
e428bff9
.\" Man page generated from reStructuredText.
.\" Man page generated from reStructuredText.
.
.
.TH "NGHTTP" "1" "January 1
1
, 2016" "1.6.1-DEV" "nghttp2"
.TH "NGHTTP" "1" "January 1
9
, 2016" "1.6.1-DEV" "nghttp2"
.SH NAME
.SH NAME
nghttp \- HTTP/2 client
nghttp \- HTTP/2 client
.
.
...
...
doc/nghttpd.1
View file @
e428bff9
.\" Man page generated from reStructuredText.
.\" Man page generated from reStructuredText.
.
.
.TH "NGHTTPD" "1" "January 1
1
, 2016" "1.6.1-DEV" "nghttp2"
.TH "NGHTTPD" "1" "January 1
9
, 2016" "1.6.1-DEV" "nghttp2"
.SH NAME
.SH NAME
nghttpd \- HTTP/2 server
nghttpd \- HTTP/2 server
.
.
...
...
doc/nghttpx.1
View file @
e428bff9
.\
" Man page generated from reStructuredText.
.\
" Man page generated from reStructuredText.
.
.
.TH "
NGHTTPX
" "
1
" "
January
1
1
,
2016
" "
1.6.1
-
DEV
" "
nghttp2
"
.TH "
NGHTTPX
" "
1
" "
January
1
9
,
2016
" "
1.6.1
-
DEV
" "
nghttp2
"
.SH NAME
.SH NAME
nghttpx \- HTTP/2 proxy
nghttpx \- HTTP/2 proxy
.
.
...
@@ -384,7 +384,7 @@ After accepting connection failed, connection listener
...
@@ -384,7 +384,7 @@ After accepting connection failed, connection listener
is disabled for a given amount of time. Specifying 0
is disabled for a given amount of time. Specifying 0
disables this feature.
disables this feature.
.sp
.sp
Default:
\f
B
0
\f
P
Default:
\f
B
30s
\f
P
.UNINDENT
.UNINDENT
.SS SSL/TLS
.SS SSL/TLS
.INDENT 0.0
.INDENT 0.0
...
@@ -845,6 +845,54 @@ requests.
...
@@ -845,6 +845,54 @@ requests.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 0.0
.TP
.TP
.B \-\-add\-forwarded=<LIST>
Append RFC 7239 Forwarded header field with parameters
specified in comma delimited list <LIST>. The supported
parameters are "
by
", "
for
", "
host
", and "
proto
". By
default, the value of "
by
" and "
for
" parameters are
obfuscated string. See
\f
I\%\-\-forwarded\-by
\f
P and
\f
I\%\-\-forwarded\-for
\f
P options respectively. Note that nghttpx
does not translate non\-standard X\-Forwarded\-* header
fields into Forwarded header field, and vice versa.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-strip\-incoming\-forwarded
Strip Forwarded header field from inbound client
requests.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-forwarded\-by=(obfuscated|ip|<VALUE>)
Specify the parameter value sent out with "
by
" parameter
of Forwarded header field. If "
obfuscated
" is given,
the string is randomly generated at startup. If "
ip
" is
given, the interface address of the connection,
including port number, is sent with "
by
" parameter.
User can also specify the static obfuscated string. The
limitation is that it must starts with "
_
", and only
consists of character set [A\-Za\-z0\-9._\-], as described
in RFC 7239.
.sp
Default:
\f
Bobfuscated
\f
P
.UNINDENT
.INDENT 0.0
.TP
.B \-\-forwarded\-for=(obfuscated|ip|<VALUE>)
Specify the parameter value sent out with "
for
"
parameter of Forwarded header field. If "
obfuscated
" is
given, the string is randomly generated for each client
connection. If "
ip
" is given, the remote client address
of the connection, without port number, is sent with
"
for
" parameter. User can also specify the static
obfuscated string. The limitation is that it must
starts with "
_
", and only consists of character set
[A\-Za\-z0\-9._\-], as described in RFC 7239.
.sp
Default:
\f
Bobfuscated
\f
P
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-via
.B \-\-no\-via
Don\(aqt append to Via header field. If Via header field
Don\(aqt append to Via header field. If Via header field
is received, it is left unaltered.
is received, it is left unaltered.
...
@@ -1010,6 +1058,34 @@ option name with leading \fB\-\-\fP stripped (e.g., \fBfrontend\fP). Put
...
@@ -1010,6 +1058,34 @@ option name with leading \fB\-\-\fP stripped (e.g., \fBfrontend\fP). Put
\f
B=
\f
P between option name and value. Don\(aqt put extra leading or
\f
B=
\f
P between option name and value. Don\(aqt put extra leading or
trailing spaces.
trailing spaces.
.sp
.sp
When specifying arguments including characters which have special
meaning to a shell, we usually use quotes so that shell does not
interpret them. When writing this configuration file, quotes for
this purpose must not be used. For example, specify additional
request header field, do this:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
add\-request\-header=foo: bar
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
instead of:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
add\-request\-header="
foo
:
bar
"
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The options which do not take argument in the command\-line
\f
Itake
\f
P
The options which do not take argument in the command\-line
\f
Itake
\f
P
argument in the configuration file. Specify
\f
Byes
\f
P as an argument
argument in the configuration file. Specify
\f
Byes
\f
P as an argument
(e.g.,
\f
Bhttp2\-proxy=yes
\f
P). If other string is given, it is
(e.g.,
\f
Bhttp2\-proxy=yes
\f
P). If other string is given, it is
...
...
doc/nghttpx.1.rst
View file @
e428bff9
...
@@ -341,7 +341,7 @@ Timeout
...
@@ -341,7 +341,7 @@ Timeout
is
disabled
for
a
given
amount
of
time
.
Specifying
0
is
disabled
for
a
given
amount
of
time
.
Specifying
0
disables
this
feature
.
disables
this
feature
.
Default
:
``
0
``
Default
:
``
30
s
``
SSL
/
TLS
SSL
/
TLS
...
@@ -751,6 +751,50 @@ HTTP
...
@@ -751,6 +751,50 @@ HTTP
Strip X-Forwarded-For header field from inbound client
Strip X-Forwarded-For header field from inbound client
requests.
requests.
.. option:: --add-forwarded=<LIST>
Append RFC 7239 Forwarded header field with parameters
specified in comma delimited list <LIST>. The supported
parameters are "by", "for", "host", and "proto". By
default, the value of "by" and "for" parameters are
obfuscated string. See :option:`--forwarded-by` and
:option:`--forwarded-for` options respectively. Note that nghttpx
does not translate non-standard X-Forwarded-\* header
fields into Forwarded header field, and vice versa.
.. option:: --strip-incoming-forwarded
Strip Forwarded header field from inbound client
requests.
.. option:: --forwarded-by=(obfuscated|ip|<VALUE>)
Specify the parameter value sent out with "by" parameter
of Forwarded header field. If "obfuscated" is given,
the string is randomly generated at startup. If "ip" is
given, the interface address of the connection,
including port number, is sent with "by" parameter.
User can also specify the static obfuscated string. The
limitation is that it must starts with "_", and only
consists of character set [A-Za-z0-9._-], as described
in RFC 7239.
Default: ``obfuscated``
.. option:: --forwarded-for=(obfuscated|ip|<VALUE>)
Specify the parameter value sent out with "for"
parameter of Forwarded header field. If "obfuscated" is
given, the string is randomly generated for each client
connection. If "ip" is given, the remote client address
of the connection, without port number, is sent with
"for" parameter. User can also specify the static
obfuscated string. The limitation is that it must
starts with "_", and only consists of character set
[A-Za-z0-9._-], as described in RFC 7239.
Default: ``obfuscated``
.. option:: --no-via
.. option:: --no-via
Don'
t
append
to
Via
header
field
.
If
Via
header
field
Don'
t
append
to
Via
header
field
.
If
Via
header
field
...
@@ -913,6 +957,22 @@ FILES
...
@@ -913,6 +957,22 @@ FILES
``=`` between option name and value. Don'
t
put
extra
leading
or
``=`` between option name and value. Don'
t
put
extra
leading
or
trailing
spaces
.
trailing
spaces
.
When
specifying
arguments
including
characters
which
have
special
meaning
to
a
shell
,
we
usually
use
quotes
so
that
shell
does
not
interpret
them
.
When
writing
this
configuration
file
,
quotes
for
this
purpose
must
not
be
used
.
For
example
,
specify
additional
request
header
field
,
do
this
:
..
code
-
block
::
text
add
-
request
-
header
=
foo
:
bar
instead
of
:
..
code
-
block
::
text
add
-
request
-
header
=
"foo: bar"
The
options
which
do
not
take
argument
in
the
command
-
line
*
take
*
The
options
which
do
not
take
argument
in
the
command
-
line
*
take
*
argument
in
the
configuration
file
.
Specify
``
yes
``
as
an
argument
argument
in
the
configuration
file
.
Specify
``
yes
``
as
an
argument
(
e
.
g
.,
``
http2
-
proxy
=
yes
``).
If
other
string
is
given
,
it
is
(
e
.
g
.,
``
http2
-
proxy
=
yes
``).
If
other
string
is
given
,
it
is
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment