granicus.if.org Git - apache/blob - docs/manual/programs/httxt2dbm.xml

   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$ -->
   5
   6 <!--
   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
  13
  14      http://www.apache.org/licenses/LICENSE-2.0
  15
  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.
  21 -->
  22
  23 <manualpage metafile="httxt2dbm.xml.meta">
  24 <parentdocument href="./">Programs</parentdocument>
  25
  26 <title>httxt2dbm - Generate dbm files for use with RewriteMap</title>
  27
  28 <summary>
  29     <p><code>httxt2dbm</code> is used to generate dbm files from text input, for
  30     use in <directive module="mod_rewrite">RewriteMap</directive> with the
  31     <code>dbm</code> map type.</p>
  32
  33     <p>If the output file already exists, it will not be truncated. New keys will be
  34     added and existing keys will be updated.</p>
  35 </summary>
  36 <seealso><program>httpd</program></seealso>
  37 <seealso><module>mod_rewrite</module></seealso>
  38
  39 <section id="synopsis"><title>Synopsis</title>
  40     <p><code><strong>httxt2dbm</strong>
  41     [ -<strong>v</strong> ]
  42     [ -<strong>f</strong> <var>DBM_TYPE</var> ]
  43     -<strong>i</strong> <var>SOURCE_TXT</var>
  44     -<strong>o</strong> <var>OUTPUT_DBM</var>
  45     </code></p>
  46 </section>
  47
  48 <section id="options"><title>Options</title>
  49     <dl>
  50     <dt><code>-v</code></dt>
  51     <dd>More verbose output</dd>
  52
  53     <dt><code>-f <var>DBM_TYPE</var></code></dt>
  54     <dd>Specify the DBM type to be used for the output. If not specified, will
  55     use the <glossary>APR</glossary> Default. Available types are:
  56     <code>GDBM</code> for GDBM files,
  57     <code>SDBM</code> for SDBM files,
  58     <code>DB</code> for berkeley DB files,
  59     <code>NDBM</code> for NDBM files,
  60     <code>default</code> for the default DBM type.
  61     </dd>
  62
  63     <dt><code>-i <var>SOURCE_TXT</var></code></dt>
  64     <dd>Input file from which the dbm is to be created. The file should be formated
  65     with one record per line, of the form: <code>key value</code>.
  66     See the documentation for <directive module="mod_rewrite">RewriteMap</directive> for
  67     further details of this file's format and meaning.
  68     </dd>
  69
  70     <dt><code>-o <var>OUTPUT_DBM</var></code></dt>
  71     <dd>Name of the output dbm files.</dd>
  72     </dl>
  73 </section>
  74
  75 <section id="examples"><title>Examples</title>
  76     <example>
  77       httxt2dbm -i rewritemap.txt -o rewritemap.dbm<br />
  78       httxt2dbm -f SDBM -i rewritemap.txt -o rewritemap.dbm<br />
  79     </example>
  80 </section>
  81
  82 </manualpage>