docs/manual/programs/httxt2dbm.xml

<?xml version='1.0' encoding='UTF-8' ?>
<!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
<!-- $LastChangedRevision$ -->

<!--
 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="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 <directive module="mod_rewrite">RewriteMap</directive> with the
    <code>dbm</code> map type.</p>

    <p>If the output file already exists, it will not be truncated. New keys will be
    added and existing keys will be updated.</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 <var>DBM_TYPE</var></code></dt>
    <dd>Specify the DBM type to be used for the output. If not specified, will
    use the <glossary>APR</glossary> Default. Available types are:
    <code>GDBM</code> for GDBM files,
    <code>SDBM</code> for SDBM files,
    <code>DB</code> for berkeley DB files,
    <code>NDBM</code> for NDBM files,
    <code>default</code> for the default DBM type.
    </dd>

    <dt><code>-i <var>SOURCE_TXT</var></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: <code>key value</code>.
    See the documentation for <directive module="mod_rewrite">RewriteMap</directive> for
    further details of this file's format and meaning.
    </dd>

    <dt><code>-o <var>OUTPUT_DBM</var></code></dt>
    <dd>Name of the output dbm files.</dd>
    </dl>
</section>

<section id="examples"><title>Examples</title>
    <example>
      httxt2dbm -i rewritemap.txt -o rewritemap.dbm<br />
      httxt2dbm -f SDBM -i rewritemap.txt -o rewritemap.dbm<br />
    </example>
</section>

</manualpage>