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 <!-- $LastChangedRevision$ -->
7 Licensed to the Apache Software Foundation (ASF) under one or more
8 contributor license agreements. See the NOTICE file distributed with
9 this work for additional information regarding copyright ownership.
10 The ASF licenses this file to You under the Apache License, Version 2.0
11 (the "License"); you may not use this file except in compliance with
12 the License. You may obtain a copy of the License at
14 http://www.apache.org/licenses/LICENSE-2.0
16 Unless required by applicable law or agreed to in writing, software
17 distributed under the License is distributed on an "AS IS" BASIS,
18 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 See the License for the specific language governing permissions and
20 limitations under the License.
23 <manualpage metafile="firehose.xml.meta">
24 <parentdocument href="./">Programs</parentdocument>
26 <title>firehose - Demultiplex a firehose stream</title>
29 <p><code>firehose</code> demultiplexes the given stream of multiplexed
30 connections, and writes each connection to an individual file.</p>
32 <p>When writing to files, each connection is placed into a dedicated file
33 named after the UUID of the connection within the stream. Separate files
34 will be created if requests and responses are found in the stream.</p>
36 <p>If an optional prefix is specified as a parameter, connections that
37 start with the given prefix will be included. The prefix needs to fit
38 completely within the first fragment for a successful match to occur.</p>
41 <seealso><module>mod_firehose</module></seealso>
43 <section id="synopsis"><title>Synopsis</title>
44 <p><code><strong>firehose</strong>
45 [ -<strong>f</strong> <var>input</var> ]
46 [ -<strong>o</strong> <var>output-directory</var> ]
47 [ -<strong>u</strong> <var>uuid</var> ]
48 [ -<strong>h</strong> ]
49 [ --<strong>version</strong> ]
50 [<var>prefix1</var> [...]]</code></p>
54 <section id="options"><title>Options</title>
56 <dt><code>--file, -f <var>filename</var></code></dt>
57 <dd>File to read the firehose from. Defaults to stdin.</dd>
59 <dt><code>--output-directory, -o </code> <var>output-directory</var></dt>
60 <dd>Directory to write demultiplexed connections to.</dd>
62 <dt><code>--uuid, -u</code> <var>uuid</var></dt>
63 <dd>The UUID of the connection to demultiplex. Can be specified more
64 than once. If not specified, all UUIDs will be demultiplexed.</dd>
66 <dt><code>--help, -h</code></dt>
67 <dd>This help text.</dd>
69 <dt><code>--version</code></dt>
70 <dd>Display the version of the program.</dd>