summaryrefslogtreecommitdiffstats
path: root/docs/manual/programs
diff options
context:
space:
mode:
authorGraham Leggett <minfrin@apache.org>2011-12-17 18:06:08 +0100
committerGraham Leggett <minfrin@apache.org>2011-12-17 18:06:08 +0100
commit9ad07e75189301740ac788cbebe4ec8845a92aa7 (patch)
treeba5806f1476939b9bb0482a78cb3e25f4c0e9931 /docs/manual/programs
parentmod_firehose: Add a new debugging module able to record traffic (diff)
downloadapache2-9ad07e75189301740ac788cbebe4ec8845a92aa7.tar.xz
apache2-9ad07e75189301740ac788cbebe4ec8845a92aa7.zip
Update transformations.
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1215526 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'docs/manual/programs')
-rw-r--r--docs/manual/programs/firehose.html5
-rw-r--r--docs/manual/programs/firehose.html.en77
-rw-r--r--docs/manual/programs/firehose.xml75
-rw-r--r--docs/manual/programs/firehose.xml.meta12
-rw-r--r--docs/manual/programs/index.html.en4
5 files changed, 173 insertions, 0 deletions
diff --git a/docs/manual/programs/firehose.html b/docs/manual/programs/firehose.html
new file mode 100644
index 0000000000..be4e77d886
--- /dev/null
+++ b/docs/manual/programs/firehose.html
@@ -0,0 +1,5 @@
+# GENERATED FROM XML -- DO NOT EDIT
+
+URI: firehose.html.en
+Content-Language: en
+Content-type: text/html; charset=ISO-8859-1
diff --git a/docs/manual/programs/firehose.html.en b/docs/manual/programs/firehose.html.en
new file mode 100644
index 0000000000..475b7685ac
--- /dev/null
+++ b/docs/manual/programs/firehose.html.en
@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
+ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ -->
+<title>firehose - Demultiplex a firehose stream - Apache HTTP Server</title>
+<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
+<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
+<link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
+<link href="../images/favicon.ico" rel="shortcut icon" /></head>
+<body id="manual-page"><div id="page-header">
+<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
+<p class="apache">Apache HTTP Server Version 2.5</p>
+<img alt="" src="../images/feather.gif" /></div>
+<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
+<div id="path">
+<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Programs</a></div><div id="page-content"><div id="preamble"><h1>firehose - Demultiplex a firehose stream</h1>
+<div class="toplang">
+<p><span>Available Languages: </span><a href="../en/programs/firehose.html" title="English">&nbsp;en&nbsp;</a></p>
+</div>
+
+ <p><code>firehose</code> demultiplexes the given stream of multiplexed
+ connections, and writes each connection to an individual file.</p>
+
+ <p>When writing to files, each connection is placed into a dedicated file
+ named after the UUID of the connection within the stream. Separate files
+ will be created if requests and responses are found in the stream.</p>
+
+ <p>If an optional prefix is specified as a parameter, connections that
+ start with the given prefix will be included. The prefix needs to fit
+ completely within the first fragment for a successful match to occur.</p>
+
+</div>
+<div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#synopsis">Synopsis</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#options">Options</a></li>
+</ul><h3>See also</h3><ul class="seealso"><li><code class="module"><a href="../mod/mod_firehose.html">mod_firehose</a></code></li></ul></div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="section">
+<h2><a name="synopsis" id="synopsis">Synopsis</a></h2>
+ <p><code><strong>firehose</strong>
+ [ -<strong>f</strong> <var>input</var> ]
+ [ -<strong>o</strong> <var>output-directory</var> ]
+ [ -<strong>u</strong> <var>uuid</var> ]
+ [ -<strong>h</strong> ]
+ [ --<strong>version</strong> ]
+ [<var>prefix1</var> [...]]</code></p>
+
+</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="section">
+<h2><a name="options" id="options">Options</a></h2>
+ <dl>
+ <dt><code>--file, -f <var>filename</var></code></dt>
+ <dd>File to read the firehose from. Defaults to stdin.</dd>
+
+ <dt><code>--output-directory, -o </code> <var>output-directory</var></dt>
+ <dd>Directory to write demultiplexed connections to.</dd>
+
+ <dt><code>--uuid, -u</code> <var>uuid</var></dt>
+ <dd>The UUID of the connection to demultiplex. Can be specified more
+ than once. If not specified, all UUIDs will be demultiplexed.</dd>
+
+ <dt><code>--help, -h</code></dt>
+ <dd>This help text.</dd>
+
+ <dt><code>--version</code></dt>
+ <dd>Display the version of the program.</dd>
+ </dl>
+
+</div></div>
+<div class="bottomlang">
+<p><span>Available Languages: </span><a href="../en/programs/firehose.html" title="English">&nbsp;en&nbsp;</a></p>
+</div><div id="footer">
+<p class="apache">Copyright 2011 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
+<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
+</body></html> \ No newline at end of file
diff --git a/docs/manual/programs/firehose.xml b/docs/manual/programs/firehose.xml
new file mode 100644
index 0000000000..27cbf22a1e
--- /dev/null
+++ b/docs/manual/programs/firehose.xml
@@ -0,0 +1,75 @@
+<?xml version='1.0' encoding='UTF-8' ?>
+<!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
+<!-- $LastChangedRevision: 1174747 $ -->
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<manualpage metafile="firehose.xml.meta">
+<parentdocument href="./">Programs</parentdocument>
+
+<title>firehose - Demultiplex a firehose stream</title>
+
+<summary>
+ <p><code>firehose</code> demultiplexes the given stream of multiplexed
+ connections, and writes each connection to an individual file.</p>
+
+ <p>When writing to files, each connection is placed into a dedicated file
+ named after the UUID of the connection within the stream. Separate files
+ will be created if requests and responses are found in the stream.</p>
+
+ <p>If an optional prefix is specified as a parameter, connections that
+ start with the given prefix will be included. The prefix needs to fit
+ completely within the first fragment for a successful match to occur.</p>
+
+</summary>
+<seealso><module>mod_firehose</module></seealso>
+
+<section id="synopsis"><title>Synopsis</title>
+ <p><code><strong>firehose</strong>
+ [ -<strong>f</strong> <var>input</var> ]
+ [ -<strong>o</strong> <var>output-directory</var> ]
+ [ -<strong>u</strong> <var>uuid</var> ]
+ [ -<strong>h</strong> ]
+ [ --<strong>version</strong> ]
+ [<var>prefix1</var> [...]]</code></p>
+
+</section>
+
+<section id="options"><title>Options</title>
+ <dl>
+ <dt><code>--file, -f <var>filename</var></code></dt>
+ <dd>File to read the firehose from. Defaults to stdin.</dd>
+
+ <dt><code>--output-directory, -o </code> <var>output-directory</var></dt>
+ <dd>Directory to write demultiplexed connections to.</dd>
+
+ <dt><code>--uuid, -u</code> <var>uuid</var></dt>
+ <dd>The UUID of the connection to demultiplex. Can be specified more
+ than once. If not specified, all UUIDs will be demultiplexed.</dd>
+
+ <dt><code>--help, -h</code></dt>
+ <dd>This help text.</dd>
+
+ <dt><code>--version</code></dt>
+ <dd>Display the version of the program.</dd>
+ </dl>
+
+</section>
+
+</manualpage>
diff --git a/docs/manual/programs/firehose.xml.meta b/docs/manual/programs/firehose.xml.meta
new file mode 100644
index 0000000000..7567aca9f4
--- /dev/null
+++ b/docs/manual/programs/firehose.xml.meta
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!-- GENERATED FROM XML: DO NOT EDIT -->
+
+<metafile reference="firehose.xml">
+ <basename>firehose</basename>
+ <path>/programs/</path>
+ <relpath>..</relpath>
+
+ <variants>
+ <variant>en</variant>
+ </variants>
+</metafile>
diff --git a/docs/manual/programs/index.html.en b/docs/manual/programs/index.html.en
index 21cbce353b..041e4e5658 100644
--- a/docs/manual/programs/index.html.en
+++ b/docs/manual/programs/index.html.en
@@ -62,6 +62,10 @@
<dd>Start a FastCGI program</dd>
+ <dt><code class="program"><a href="../programs/firehose.html">firehose</a></code></dt>
+
+ <dd>Demultiplex a firehose from <code class="module"><a href="../mod/mod_firehose.html">mod_firehose</a></code></dd>
+
<dt><code class="program"><a href="../programs/htcacheclean.html">htcacheclean</a></code></dt>
<dd>Clean up the disk cache</dd>