Commit be48e2ff authored by Richard Bowen's avatar Richard Bowen
Browse files

Documentation for the new httxt2dbm utility. 


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@219429 13f79535-47bb-0310-9956-ffa450edef68
parent 38ec247c

docs/manual/programs/httxt2dbm.html

0 → 100644
+3 −0
Changes for docs/manual/programs/httxt2dbm.html: 3 added lines, 0 removed lines.
Original line number Diff line number Diff line 
URI: httxt2dbm.html.en

Content-Language: en

Content-type: text/html; charset=ISO-8859-1

docs/manual/programs/httxt2dbm.html.en

0 → 100644
+82 −0
Changes for docs/manual/programs/httxt2dbm.html.en: 82 added lines, 0 removed lines.
Original line number Diff line number Diff line 
<?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>httxt2dbm - Generate dbm files for use with RewriteMap - 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.1</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-project/">Documentation</a> &gt; <a href="../">Version 2.1</a> &gt; <a href="./">Programs</a></div><div id="page-content"><div id="preamble"><h1>httxt2dbm - Generate dbm files for use with RewriteMap</h1>

<div class="toplang">

<p><span>Available Languages: </span><a href="../en/programs/httxt2dbm.html" title="English">&nbsp;en&nbsp;</a></p>

</div>



    <p><code>httxt2dbm</code> is used to generate dbm files from text input, for

    use in RewriteMap with the <code>dbm</code> map type.

    </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>

<li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>

</ul><h3>See also</h3><ul class="seealso"><li><code class="program"><a href="../programs/httpd.html">httpd</a></code></li><li><code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</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>httxt2dbm</strong>

    [ -<strong>v</strong> ]

    [ -<strong>f</strong> <var>DBM_TYPE</var> ]

    -<strong>i</strong> <var>SOURCE_TXT</var>

    -<strong>o</strong> <var>OUTPUT_DBM</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>-v</code></dt>

    <dd>More verbose output</dd>



    <dt><code>-f</code></dt>

    <dd>Specify the DBM type to be used for the output. If not specified, will

    use the APR Default. Available types are:<br />

    <code>GDBM</code> for GDBM files<br />

    <code>SDBM</code> for SDBM files<br />

    <code>DB</code> for berkeley DB files<br />

    <code>NDBM</code> for NDBM files<br />

    default for the default DBM type

    </dd>



    <dt><code>-i</code></dt>

    <dd>Input file from which the dbm is to be created. The file should be formated

    with one record per line, of the form:<br />

    <code>key value</code><br />

    See the documentation for <code class="directive"><a href="../mod/mod_rewrite.html#rewritemap">RewriteMap</a></code> for

    further details of this file's format and meaning.

    </dd>



    <dt><code>-o</code></dt>

    <dd>Name of the output dbm files.</dd>

    </dl>

</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>

<div class="section">

<h2><a name="examples" id="examples">Examples</a></h2>

    <div class="example"><p><code>

      httxt2dbm -i rewritemap.txt -i rewritemap.dbm<br />

      httxt2dbm -f SDBM -i rewritemap.txt -i rewritemap.dbm<br />

    </code></p></div>

</div></div>

<div class="bottomlang">

<p><span>Available Languages: </span><a href="../en/programs/httxt2dbm.html" title="English">&nbsp;en&nbsp;</a></p>

</div><div id="footer">

<p class="apache">Copyright 1995-2005 The Apache Software Foundation or its licensors, as applicable.<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

docs/manual/programs/httxt2dbm.xml

0 → 100644
+80 −0
Changes for docs/manual/programs/httxt2dbm.xml: 80 added lines, 0 removed lines.
Original line number Diff line number Diff line 
<?xml version='1.0' encoding='UTF-8' ?>

<!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">

<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>

<!-- $LastChangedRevision: 159139 $ -->



<!--

 Copyright 2003-2005 The Apache Software Foundation or its licensors, as

 applicable.



 Licensed 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="httxt2dbm.xml.meta">

<parentdocument href="./">Programs</parentdocument>



<title>httxt2dbm - Generate dbm files for use with RewriteMap</title>



<summary>

    <p><code>httxt2dbm</code> is used to generate dbm files from text input, for

    use in RewriteMap with the <code>dbm</code> map type.

    </p>

</summary>

<seealso><program>httpd</program></seealso>

<seealso><module>mod_rewrite</module></seealso>



<section id="synopsis"><title>Synopsis</title>

    <p><code><strong>httxt2dbm</strong>

    [ -<strong>v</strong> ]

    [ -<strong>f</strong> <var>DBM_TYPE</var> ]

    -<strong>i</strong> <var>SOURCE_TXT</var>

    -<strong>o</strong> <var>OUTPUT_DBM</var>

    </code></p>

</section>



<section id="options"><title>Options</title>

    <dl>

    <dt><code>-v</code></dt>

    <dd>More verbose output</dd>



    <dt><code>-f</code></dt>

    <dd>Specify the DBM type to be used for the output. If not specified, will

    use the APR Default. Available types are:<br />

    <code>GDBM</code> for GDBM files<br />

    <code>SDBM</code> for SDBM files<br />

    <code>DB</code> for berkeley DB files<br />

    <code>NDBM</code> for NDBM files<br />

    default for the default DBM type

    </dd>



    <dt><code>-i</code></dt>

    <dd>Input file from which the dbm is to be created. The file should be formated

    with one record per line, of the form:<br />

    <code>key value</code><br />

    See the documentation for <directive module="mod_rewrite">RewriteMap</directive> for

    further details of this file's format and meaning.

    </dd>



    <dt><code>-o</code></dt>

    <dd>Name of the output dbm files.</dd>

    </dl>

</section>



<section id="examples"><title>Examples</title>

    <example>

      httxt2dbm -i rewritemap.txt -i rewritemap.dbm<br />

      httxt2dbm -f SDBM -i rewritemap.txt -i rewritemap.dbm<br />

    </example>

</section>



</manualpage>

docs/manual/programs/httxt2dbm.xml.meta

0 → 100644
+11 −0
Changes for docs/manual/programs/httxt2dbm.xml.meta: 11 added lines, 0 removed lines.
Original line number Diff line number Diff line 
<?xml version="1.0" encoding="UTF-8" ?>



<metafile>

  <basename>httxt2dbm</basename>

  <path>/programs/</path>

  <relpath>..</relpath>



  <variants>

    <variant>en</variant>

  </variants>

</metafile>

docs/manual/programs/index.html.en

+4 −0
Changes for docs/manual/programs/index.html.en: 4 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -73,6 +73,10 @@ 
      <dd>Create and update user authentication files for basic

      authentication</dd>



      <dt><code class="program"><a href="../programs/httxt2dbm.html">httxt2dbm</a></code></dt>



      <dd>Create dbm files for use with RewriteMap</dd>



      <dt><code class="program"><a href="../programs/logresolve.html">logresolve</a></code></dt>



      <dd>Resolve hostnames for IP-addresses in Apache