doc/nghttp.1.rst

   1
   2 nghttp(1)
   3 =========
   4
   5 SYNOPSIS
   6 --------
   7
   8 **nghttp** [OPTIONS]... <URI>...
   9
  10 DESCRIPTION
  11 -----------
  12
  13 HTTP/2 experimental client
  14
  15 .. describe:: <URI>
  16
  17     Specify URI to access.
  18
  19 OPTIONS
  20 -------
  21
  22 .. option:: -v, --verbose
  23
  24     Print   debug   information   such  as   reception   and
  25     transmission of frames and name/value pairs.  Specifying
  26     this option multiple times increases verbosity.
  27
  28 .. option:: -n, --null-out
  29
  30     Discard downloaded data.
  31
  32 .. option:: -O, --remote-name
  33
  34     Save  download  data  in  the  current  directory.   The
  35     filename is  dereived from URI.   If URI ends  with '*/*',
  36     'index.html'  is used  as a  filename.  Not  implemented
  37     yet.
  38
  39 .. option:: -t, --timeout=<SEC>
  40
  41     Timeout each request after <SEC> seconds.
  42
  43 .. option:: -w, --window-bits=<N>
  44
  45     Sets the stream level initial window size to 2\*\*<N>-1.
  46
  47 .. option:: -W, --connection-window-bits=<N>
  48
  49     Sets  the  connection  level   initial  window  size  to
  50     2\*\*<N>-1.
  51
  52 .. option:: -a, --get-assets
  53
  54     Download assets  such as stylesheets, images  and script
  55     files linked  from the downloaded resource.   Only links
  56     whose  origins are  the same  with the  linking resource
  57     will be downloaded.   nghttp prioritizes resources using
  58     HTTP/2 dependency  based priority.  The  priority order,
  59     from highest to lowest,  is html itself, css, javascript
  60     and images.
  61
  62 .. option:: -s, --stat
  63
  64     Print statistics.
  65
  66 .. option:: -H, --header=<HEADER>
  67
  68     Add a header to the requests.  Example: :option:`-H`\':method: PUT'
  69
  70 .. option:: --cert=<CERT>
  71
  72     Use  the specified  client certificate  file.  The  file
  73     must be in PEM format.
  74
  75 .. option:: --key=<KEY>
  76
  77     Use the  client private key  file.  The file must  be in
  78     PEM format.
  79
  80 .. option:: -d, --data=<FILE>
  81
  82     Post FILE to server. If '-'  is given, data will be read
  83     from stdin.
  84
  85 .. option:: -m, --multiply=<N>
  86
  87     Request each URI <N> times.  By default, same URI is not
  88     requested twice.  This option disables it too.
  89
  90 .. option:: -u, --upgrade
  91
  92     Perform HTTP Upgrade for HTTP/2.  This option is ignored
  93     if the request URI has https scheme.  If :option:`-d` is used, the
  94     HTTP upgrade request is performed with OPTIONS method.
  95
  96 .. option:: -p, --weight=<WEIGHT>
  97
  98     Sets priority group weight.  The valid value range is
  99     [1, 256], inclusive.
 100
 101     Default: ``16``
 102
 103 .. option:: -M, --peer-max-concurrent-streams=<N>
 104
 105     Use  <N>  as  SETTINGS_MAX_CONCURRENT_STREAMS  value  of
 106     remote endpoint as if it  is received in SETTINGS frame.
 107     The default is large enough as it is seen as unlimited.
 108
 109 .. option:: -c, --header-table-size=<SIZE>
 110
 111     Specify decoder header table size.
 112
 113 .. option:: -b, --padding=<N>
 114
 115     Add at  most <N>  bytes to a  frame payload  as padding.
 116     Specify 0 to disable padding.
 117
 118 .. option:: -r, --har=<FILE>
 119
 120     Output HTTP  transactions <FILE> in HAR  format.  If '-'
 121     is given, data is written to stdout.
 122
 123 .. option:: --color
 124
 125     Force colored log output.
 126
 127 .. option:: --continuation
 128
 129     Send large header to test CONTINUATION.
 130
 131 .. option:: --no-content-length
 132
 133     Don't send content-length header field.
 134
 135 .. option:: --no-dep
 136
 137     Don't send dependency based priority hint to server.
 138
 139 .. option:: --dep-idle
 140
 141     Use idle streams as anchor nodes to express priority.
 142
 143 .. option:: --version
 144
 145     Display version information and exit.
 146
 147 .. option:: -h, --help
 148
 149     Display this help and exit.
 150
 151
 152 The <SIZE> argument is an integer and an optional unit (e.g., 10K is
 153 10 * 1024).  Units are K, M and G (powers of 1024).
 154
 155 SEE ALSO
 156 --------
 157
 158 :manpage:`nghttpd(1)`, :manpage:`nghttpx(1)`, :manpage:`h2load(1)`