tizen 2.4 release
[external/nghttp2.git] / doc / nghttp.1
1 .\" Man page generated from reStructuredText.
2 .
3 .TH "NGHTTP" "1" "February 08, 2015" "0.7.4-DEV" "nghttp2"
4 .SH NAME
5 nghttp \- HTTP/2 experimental client
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 \fBnghttp\fP [OPTIONS]... <URI>...
36 .SH DESCRIPTION
37 .sp
38 HTTP/2 experimental client
39 .INDENT 0.0
40 .TP
41 .B <URI>
42 Specify URI to access.
43 .UNINDENT
44 .SH OPTIONS
45 .INDENT 0.0
46 .TP
47 .B \-v, \-\-verbose
48 Print   debug   information   such  as   reception   and
49 transmission of frames and name/value pairs.  Specifying
50 this option multiple times increases verbosity.
51 .UNINDENT
52 .INDENT 0.0
53 .TP
54 .B \-n, \-\-null\-out
55 Discard downloaded data.
56 .UNINDENT
57 .INDENT 0.0
58 .TP
59 .B \-O, \-\-remote\-name
60 Save  download  data  in  the  current  directory.   The
61 filename is  dereived from URI.   If URI ends  with \(aq\fI/\fP\(aq,
62 \(aqindex.html\(aq  is used  as a  filename.  Not  implemented
63 yet.
64 .UNINDENT
65 .INDENT 0.0
66 .TP
67 .B \-t, \-\-timeout=<SEC>
68 Timeout each request after <SEC> seconds.
69 .UNINDENT
70 .INDENT 0.0
71 .TP
72 .B \-w, \-\-window\-bits=<N>
73 Sets the stream level initial window size to 2**<N>\-1.
74 .UNINDENT
75 .INDENT 0.0
76 .TP
77 .B \-W, \-\-connection\-window\-bits=<N>
78 Sets  the  connection  level   initial  window  size  to
79 2**<N>\-1.
80 .UNINDENT
81 .INDENT 0.0
82 .TP
83 .B \-a, \-\-get\-assets
84 Download assets  such as stylesheets, images  and script
85 files linked  from the downloaded resource.   Only links
86 whose  origins are  the same  with the  linking resource
87 will be downloaded.   nghttp prioritizes resources using
88 HTTP/2 dependency  based priority.  The  priority order,
89 from highest to lowest,  is html itself, css, javascript
90 and images.
91 .UNINDENT
92 .INDENT 0.0
93 .TP
94 .B \-s, \-\-stat
95 Print statistics.
96 .UNINDENT
97 .INDENT 0.0
98 .TP
99 .B \-H, \-\-header=<HEADER>
100 Add a header to the requests.  Example: \fI\%\-H\fP\(aq:method: PUT\(aq
101 .UNINDENT
102 .INDENT 0.0
103 .TP
104 .B \-\-cert=<CERT>
105 Use  the specified  client certificate  file.  The  file
106 must be in PEM format.
107 .UNINDENT
108 .INDENT 0.0
109 .TP
110 .B \-\-key=<KEY>
111 Use the  client private key  file.  The file must  be in
112 PEM format.
113 .UNINDENT
114 .INDENT 0.0
115 .TP
116 .B \-d, \-\-data=<FILE>
117 Post FILE to server. If \(aq\-\(aq  is given, data will be read
118 from stdin.
119 .UNINDENT
120 .INDENT 0.0
121 .TP
122 .B \-m, \-\-multiply=<N>
123 Request each URI <N> times.  By default, same URI is not
124 requested twice.  This option disables it too.
125 .UNINDENT
126 .INDENT 0.0
127 .TP
128 .B \-u, \-\-upgrade
129 Perform HTTP Upgrade for HTTP/2.  This option is ignored
130 if the request URI has https scheme.  If \fI\-d\fP is used, the
131 HTTP upgrade request is performed with OPTIONS method.
132 .UNINDENT
133 .INDENT 0.0
134 .TP
135 .B \-p, \-\-weight=<WEIGHT>
136 Sets priority group weight.  The valid value range is
137 [1, 256], inclusive.
138 .sp
139 Default: \fB16\fP
140 .UNINDENT
141 .INDENT 0.0
142 .TP
143 .B \-M, \-\-peer\-max\-concurrent\-streams=<N>
144 Use  <N>  as  SETTINGS_MAX_CONCURRENT_STREAMS  value  of
145 remote endpoint as if it  is received in SETTINGS frame.
146 The default is large enough as it is seen as unlimited.
147 .UNINDENT
148 .INDENT 0.0
149 .TP
150 .B \-c, \-\-header\-table\-size=<SIZE>
151 Specify decoder header table size.
152 .UNINDENT
153 .INDENT 0.0
154 .TP
155 .B \-b, \-\-padding=<N>
156 Add at  most <N>  bytes to a  frame payload  as padding.
157 Specify 0 to disable padding.
158 .UNINDENT
159 .INDENT 0.0
160 .TP
161 .B \-r, \-\-har=<FILE>
162 Output HTTP  transactions <FILE> in HAR  format.  If \(aq\-\(aq
163 is given, data is written to stdout.
164 .UNINDENT
165 .INDENT 0.0
166 .TP
167 .B \-\-color
168 Force colored log output.
169 .UNINDENT
170 .INDENT 0.0
171 .TP
172 .B \-\-continuation
173 Send large header to test CONTINUATION.
174 .UNINDENT
175 .INDENT 0.0
176 .TP
177 .B \-\-no\-content\-length
178 Don\(aqt send content\-length header field.
179 .UNINDENT
180 .INDENT 0.0
181 .TP
182 .B \-\-no\-dep
183 Don\(aqt send dependency based priority hint to server.
184 .UNINDENT
185 .INDENT 0.0
186 .TP
187 .B \-\-dep\-idle
188 Use idle streams as anchor nodes to express priority.
189 .UNINDENT
190 .INDENT 0.0
191 .TP
192 .B \-\-version
193 Display version information and exit.
194 .UNINDENT
195 .INDENT 0.0
196 .TP
197 .B \-h, \-\-help
198 Display this help and exit.
199 .UNINDENT
200 .sp
201 The <SIZE> argument is an integer and an optional unit (e.g., 10K is
202 10 * 1024).  Units are K, M and G (powers of 1024).
203 .SH SEE ALSO
204 .sp
205 \fInghttpd(1)\fP, \fInghttpx(1)\fP, \fIh2load(1)\fP
206 .SH AUTHOR
207 Tatsuhiro Tsujikawa
208 .SH COPYRIGHT
209 2012, 2015, Tatsuhiro Tsujikawa
210 .\" Generated by docutils manpage writer.
211 .