home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F278498_ab.xml < prev    next >
Extensible Markup Language  |  2004-02-09  |  9KB  |  192 lines
  1. <?xml version='1.0' encoding='UTF-8' ?>
  2. <!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
  3. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  4.  
  5. <!--
  6.  Copyright 2003-2004 The Apache Software Foundation
  7.  
  8.  Licensed under the Apache License, Version 2.0 (the "License");
  9.  you may not use this file except in compliance with the License.
  10.  You may obtain a copy of the License at
  11.  
  12.      http://www.apache.org/licenses/LICENSE-2.0
  13.  
  14.  Unless required by applicable law or agreed to in writing, software
  15.  distributed under the License is distributed on an "AS IS" BASIS,
  16.  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17.  See the License for the specific language governing permissions and
  18.  limitations under the License.
  19. -->
  20.  
  21. <manualpage metafile="ab.xml.meta">
  22. <parentdocument href="./">Programs</parentdocument>
  23.  
  24. <title>ab - Apache HTTP server benchmarking tool</title>
  25.  
  26. <summary>
  27.     <p><code>ab</code> is a tool for benchmarking your Apache Hypertext
  28.     Transfer Protocol (HTTP) server. It is designed to give you an impression
  29.     of how your current Apache installation performs. This especially shows
  30.     you how many requests per second your Apache installation is capable of
  31.     serving.</p>
  32. </summary>
  33. <seealso><a href="httpd.html">httpd</a></seealso>
  34.  
  35. <section id="synopsis"><title>Synopsis</title>
  36.     <p><code><strong>ab</strong>
  37.     [ -<strong>A</strong> <var>auth-username</var>:<var>password</var> ]
  38.     [ -<strong>c</strong> <var>concurrency</var> ]
  39.     [ -<strong>C</strong> <var>cookie-name</var>=<var>value</var> ]
  40.     [ -<strong>d</strong> ]
  41.     [ -<strong>e</strong> <var>csv-file</var> ]
  42.     [ -<strong>g</strong> <var>gnuplot-file</var> ]
  43.     [ -<strong>h</strong> ]
  44.     [ -<strong>H</strong> <var>custom-header</var> ]
  45.     [ -<strong>i</strong> ]
  46.     [ -<strong>k</strong> ]
  47.     [ -<strong>n</strong> <var>requests</var> ]
  48.     [ -<strong>p</strong> <var>POST-file</var> ]
  49.     [ -<strong>P</strong> <var>proxy-auth-username</var>:<var>password</var> ]
  50.     [ -<strong>q</strong> ]
  51.     [ -<strong>s</strong> ]
  52.     [ -<strong>S</strong> ]
  53.     [ -<strong>t</strong> <var>timelimit</var> ]
  54.     [ -<strong>T</strong> <var>content-type</var> ]
  55.     [ -<strong>v</strong> <var>verbosity</var>]
  56.     [ -<strong>V</strong> ]
  57.     [ -<strong>w</strong> ]
  58.     [ -<strong>x</strong> <var><table>-attributes</var> ]
  59.     [ -<strong>X</strong> <var>proxy</var>[:<var>port</var>] ]
  60.     [ -<strong>y</strong> <var><tr>-attributes</var> ]
  61.     [ -<strong>z</strong> <var><td>-attributes</var> ]
  62.     [http://]<var>hostname</var>[:<var>port</var>]/<var>path</var></code></p>
  63. </section>
  64.  
  65. <section id="options"><title>Options</title>
  66.     <dl>
  67.     <dt><code>-A <var>auth-username</var>:<var>password</var></code></dt>
  68.     <dd>Supply BASIC Authentication credentials to the server. The username and
  69.     password are separated by a single <code>:</code> and sent on the wire
  70.     base64 encoded. The string is sent regardless of whether the server needs
  71.     it (<em>i.e.</em>, has sent an 401  authentication needed).</dd>
  72.  
  73.     <dt><code>-c <var>concurrency</var></code></dt>
  74.     <dd>Number of multiple requests to perform at a time. Default is one
  75.     request at a time.</dd>
  76.  
  77.     <dt><code>-C <var>cookie-name</var>=<var>value</var></code></dt>
  78.     <dd>Add a <code>Cookie:</code> line to the request. The  argument  is
  79.     typically in the form of a <code><var>name</var>=<var>value</var></code>
  80.     pair. This field is repeatable.</dd>
  81.  
  82.     <dt><code>-d</code></dt>
  83.     <dd>Do not display the "percentage served within XX [ms] table". (legacy
  84.     support).</dd>
  85.  
  86.     <dt><code>-e <var>csv-file</var></code></dt>
  87.     <dd>Write a Comma separated value (CSV) file which contains for each
  88.     percentage (from 1% to 100%) the time (in milliseconds) it took to serve
  89.     that percentage of the requests. This is usually more useful than the
  90.     'gnuplot' file; as the results are already 'binned'.</dd>
  91.  
  92.     <dt><code>-g <var>gnuplot-file</var></code></dt>
  93.     <dd>Write all measured values out as a 'gnuplot' or TSV (Tab separate
  94.     values) file. This file can easily be imported into packages like Gnuplot,
  95.     IDL, Mathematica, Igor or even Excell. The labels are on the first line of
  96.     the file. </dd>
  97.  
  98.     <dt><code>-h</code></dt>
  99.     <dd>Display usage information.</dd>
  100.  
  101.     <dt><code>-H <var>custom-header</var></code></dt>
  102.     <dd>Append extra headers to the request.  The  argument  is typically in
  103.     the form of a valid header line, containing a colon-separated field-value
  104.     pair (<em>i.e.</em>, <code>"Accept-Encoding: zip/zop;8bit"</code>).</dd>
  105.  
  106.     <dt><code>-i</code></dt>
  107.     <dd>Do <code>HEAD</code> requests instead of <code>GET</code>.</dd>
  108.  
  109.     <dt><code>-k</code></dt>
  110.     <dd>Enable the HTTP KeepAlive feature, <em>i.e.</em>, perform multiple
  111.     requests within one HTTP session. Default is no KeepAlive.</dd>
  112.  
  113.     <dt><code>-n <var>requests</var></code></dt>
  114.     <dd>Number of requests to perform for the benchmarking session. The default
  115.     is to just perform a single request which usually leads to
  116.     non-representative benchmarking results.</dd>
  117.  
  118.     <dt><code>-p <var>POST-file</var></code></dt>
  119.     <dd>File containing data to POST.</dd>
  120.  
  121.     <dt><code>-P <var>proxy-auth-username</var>:<var>password</var></code></dt>
  122.     <dd>Supply BASIC Authentication credentials to a proxy en-route. The
  123.     username and password are separated by a single <code>:</code> and sent on 
  124.     the  wire base64 encoded. The string is sent regardless of whether the
  125.     proxy needs it (<em>i.e.</em>, has  sent an 407 proxy authentication
  126.     needed).</dd>
  127.  
  128.     <dt><code>-q</code></dt>
  129.     <dd>When processing more than 150 requests, <code>ab</code> outputs a
  130.     progress count on <code>stderr</code> every 10% or 100 requests or so. The 
  131.     <code>-q</code> flag will suppress these messages.</dd>
  132.  
  133.     <dt><code>-s</code></dt>
  134.     <dd>When compiled in (<code>ab -h</code> will show you) use the SSL
  135.     protected <code>https</code> rather than the <code>http</code> protocol.
  136.     This feature is experimental and <em>very</em> rudimentary. You probably
  137.     do not want to use it.</dd>
  138.  
  139.     <dt><code>-S</code></dt>
  140.     <dd>Do not display the median and standard deviation values, nor display
  141.     the warning/error messages when the average and median are more than
  142.     one or two times the standard deviation apart. And default to the 
  143.     min/avg/max values. (legacy support).</dd>
  144.  
  145.     <dt><code>-t <var>timelimit</var></code></dt>
  146.     <dd>Maximum number of seconds to  spend  for  benchmarking. This implies a
  147.     <code>-n 50000</code> internally. Use this to benchmark the server within a
  148.     fixed total amount of time. Per default there is no timelimit.</dd>
  149.  
  150.     <dt><code>-T <var>content-type</var></code></dt>
  151.     <dd>Content-type header to use for POST data.</dd>
  152.  
  153.     <dt><code>-v <var>verbosity</var></code></dt>
  154.     <dd>Set verbosity level - <code>4</code> and above prints information on
  155.     headers, <code>3</code> and above prints response codes (404, 200, etc.),
  156.     <code>2</code> and above prints warnings and info.</dd>
  157.  
  158.     <dt><code>-V</code></dt>
  159.     <dd>Display version number and exit.</dd>
  160.  
  161.     <dt><code>-w</code></dt>
  162.     <dd>Print out results in HTML tables. Default table is two columns wide,
  163.     with a white background.</dd>
  164.  
  165.     <dt><code>-x <var><table>-attributes</var></code></dt>
  166.     <dd>String to use as attributes for <code><table></code>. Attributes
  167.     are inserted <code><table <var>here</var> ></code>.</dd>
  168.  
  169.     <dt><code>-X <var>proxy</var>[:<var>port</var>]</code></dt>
  170.     <dd>Use a proxy server for the requests.</dd>
  171.  
  172.     <dt><code>-y <var><tr>-attributes</var></code></dt>
  173.     <dd>String to use as attributes for <code><tr></code>.</dd>
  174.  
  175.     <dt><code>-z <var><td>-attributes</var></code></dt>
  176.     <dd>String to use as attributes for <code><td></code>.</dd>
  177.     </dl>
  178. </section>
  179.  
  180. <section id="bugs"><title>Bugs</title>
  181.     <p>There are various statically declared buffers of fixed length. Combined
  182.     with the lazy parsing of the command line arguments, the response headers
  183.     from the server and other external inputs, this might bite you.</p>
  184.  
  185.     <p>It does not implement HTTP/1.x fully; only accepts some 'expected' forms
  186.     of responses. The rather heavy use of <code>strstr(3)</code> shows up top
  187.     in profile, which might indicate a performance problem; <em>i.e.</em>, you
  188.     would measure the <code>ab</code> performance rather than the server's.</p>
  189. </section>
  190.  
  191. </manualpage>
  192.