Apache HTTP Server 2.1 Documentation Status File.
-Last modified: $Date: 2003/04/29 23:07:52 $
+Last modified: $Date: 2003/04/30 23:25:08 $
For more information on how to contribute to the Apache Documentation
Project, please see http://httpd.apache.org/docs-project/
developer/API.html
# converting from nroff to xml
-programs/dbmmanage.html
programs/htdigest.html
programs/htpasswd.html
programs/other.html
-.TH dbmmanage 1 "March 1998"
-.\" The Apache Software License, Version 1.1
-.\"
-.\" Copyright (c) 2000-2003 The Apache Software Foundation. All rights
-.\" reserved.
-.\"
-.\" Redistribution and use in source and binary forms, with or without
-.\" modification, are permitted provided that the following conditions
-.\" are met:
-.\"
-.\" 1. Redistributions of source code must retain the above copyright
-.\" notice, this list of conditions and the following disclaimer.
-.\"
-.\" 2. Redistributions in binary form must reproduce the above copyright
-.\" notice, this list of conditions and the following disclaimer in
-.\" the documentation and/or other materials provided with the
-.\" distribution.
-.\"
-.\" 3. The end-user documentation included with the redistribution,
-.\" if any, must include the following acknowledgment:
-.\" "This product includes software developed by the
-.\" Apache Software Foundation (http://www.apache.org/)."
-.\" Alternately, this acknowledgment may appear in the software itself,
-.\" if and wherever such third-party acknowledgments normally appear.
-.\"
-.\" 4. The names "Apache" and "Apache Software Foundation" must
-.\" not be used to endorse or promote products derived from this
-.\" software without prior written permission. For written
-.\" permission, please contact apache@apache.org.
-.\"
-.\" 5. Products derived from this software may not be called "Apache",
-.\" nor may "Apache" appear in their name, without prior written
-.\" permission of the Apache Software Foundation.
-.\"
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
-.\" WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
-.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-.\" DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
-.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
-.\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-.\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
-.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
-.\" SUCH DAMAGE.
-.\"
-.\" This software consists of voluntary contributions made by many
-.\" individuals on behalf of the Apache Software Foundation. For more
-.\" information on the Apache Software Foundation, please see
-.\" <http://www.apache.org/>.
-.\"
+.\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+.\" DO NOT EDIT! Generated from XML source.
+.\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+.de Sh \" Subsection
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Ip \" List item
+.br
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
+.TH "DBMMANAGE" 1 "2003-04-30" "Apache HTTP Server" "dbmmanage"
+
.SH NAME
-dbmmanage \- Create and update user authentication files in DBM format
-.SH SYNOPSIS
-.B dbmmanage
-.I filename
-[
-.I command
-] [
-.I username
-[
-.I encpasswd
-] ]
+dbmmanage \- Manage user authentication files in DBM format
+
+.SH "SYNOPSIS"
+
+.PP
+\fBdbmmanage\fR [ \fIencoding\fR ] \fIfilename\fR add|adduser|check|delete|update \fIusername\fR [ \fIencpasswd\fR [ \fIgroup\fR[,\fIgroup\fR\&.\&.\&.] [ \fIcomment\fR ] ] ]
+
+.PP
+\fBdbmmanage\fR \fIfilename\fR view [ \fIusername\fR ]
+
+.PP
+\fBdbmmanage\fR \fIfilename\fR import
+
+
+.SH "SUMMARY"
+
.PP
-.SH DESCRIPTION
-.B dbmmanage
-is used to create and update the DBM format files used to store
-usernames and password for basic authentication of HTTP users.
-Resources available from the
-.B httpd
-Apache web server can be restricted to just the users listed
-in the files created by
-.B dbmmanage.
-This program can only be used
-when the usernames are stored in a DBM file. To use a
-flat-file database see
-\fBhtpasswd\fP.
+dbmmanage is used to create and update the DBM format files used to store usernames and password for basic authentication of HTTP users\&. Resources available from the Apache HTTP server can be restricted to just the users listed in the files created by dbmmanage\&. This program can only be used when the usernames are stored in a DBM file\&. To use a flat-file database see htpasswd\&.
+
.PP
-This manual page only lists the command line arguments. For details of
-the directives necessary to configure user authentication in
-.B httpd
-see
-the Apache manual, which is part of the Apache distribution or can be
-found at http://www.apache.org/.
-.SH OPTIONS
-.IP \fB\fIfilename\fP
-The filename of the DBM format file. Usually without the
-extension .db, .pag, or .dir.
-.IP \fB\fIcommand\fP
-This selects the operation to perform:
-.TP 12
-.B add
-Adds an entry for \fIusername\fP to \fIfilename\fP using the encrypted
-password \fIencpassword\fP.
-.TP 12
-.B adduser
-Asks for a password and then adds an entry for \fIusername\fP to
-\fIfilename\fP .
-.TP 12
-.B check
-Asks for a password and then checks if
-\fIusername\fP is in \fIfilename\fP and if it's password matches
-the specified one.
-.TP 12
-.B delete
-Deletes the \fIusername\fP entry from \fIfilename\fP.
-.TP 12
-.B import
-Reads username:password entries (one per line) from STDIN and adds them to
-\fIfilename\fP. The passwords already has to be crypted.
-.TP 12
-.B update
-Same as the "adduser" command, except that it makes sure \fIusername\fP
-already exists in \fIfilename\fP.
-.TP 12
-.B view
-Just displays the complete contents of the DBM file.
-.IP \fB\fIusername\fP
-The user for which the update operation is performed.
-.PD
-.SH BUGS
+This manual page only lists the command line arguments\&. For details of the directives necessary to configure user authentication in httpd see the httpd manual, which is part of the Apache distribution or can be found at http://httpd\&.apache\&.org/\&.
+
+
+.SH "OPTIONS"
+
+.RS
+
+.TP
+\fIfilename\fR
+The filename of the DBM format file\&. Usually without the extension \&.db, \&.pag, or \&.dir\&.
+.TP
+\fIusername\fR
+The user for which the operations are performed\&. The \fIusername\fR may not contain a colon (:)\&.
+.TP
+\fIencpasswd\fR
+This is the already encrypted password to use for the update and add commands\&. You may use a hyphen (-) if you want to get prompted for the password, but fill in the fields afterwards\&. Additionally when using the update command, a period (\&.) keeps the original password untouched\&.
+.TP
+\fIgroup\fR
+A group, which the user is member of\&. A groupname may not contain a colon (:)\&. You may use a hyphen (-) if you don't want to assign the user to a group, but fill in the comment field\&. Additionally when using the update command, a period (\&.) keeps the original groups untouched\&.
+.TP
+\fIcomment\fR
+This is the place for your opaque comments about the user, like realname, mailaddress or such things\&. The server will ignore this field\&.
+.RE
+
+.Sh "ENCODINGS"
+
+.RS
+
+.TP
+-d
+crypt encryption (default, except on Win32, Netware)
+.TP
+-m
+MD5 encryption (default on Win32, Netware)
+.TP
+-s
+SHA1 encryption
+.TP
+-p
+plaintext (\fInot recommended\fR)
+.RE
+
+.Sh "COMMANDS"
+
+.RS
+
+.TP
+add
+Adds an entry for \fIusername\fR to \fIfilename\fR using the encrypted password \fIencpasswd\fR\&.
+.TP
+adduser
+Asks for a password and then adds an entry for \fIusername\fR to \fIfilename\fR\&.
+.TP
+check
+Asks for a password and then checks if \fIusername\fR is in \fIfilename\fR and if it's password matches the specified one\&.
+.TP
+delete
+Deletes the \fIusername\fR entry from \fIfilename\fR\&.
+.TP
+import
+Reads \fIusername\fR:\fIpassword\fR entries (one per line) from STDIN and adds them to \fIfilename\fR\&. The passwords already have to be crypted\&.
+.TP
+update
+Same as the adduser command, except that it makes sure \fIusername\fR already exists in \fIfilename\fR\&.
+.TP
+view
+Just displays the contents of the DBM file\&. If you specify a \fIusername\fR, it displays the particular record only\&.
+.RE
+
+.SH "BUGS"
+
.PP
-One should be aware that there are a number of different DBM file
-formats in existence, and with all likelihood, libraries for more than
-one format may exist on your system. The three primary examples are
-NDBM, the GNU project's GDBM, and Berkeley DB 2. Unfortunately, all
-these libraries use different file formats, and you must make sure
-that the file format used by
-.I filename
-is the same format that
-.B dbmmanage
-expects to see.
-.B dbmmanage
-currently has no way of determining what type of DBM file it is
-looking at. If used against the wrong format,
-.dbmmanage
-will simply return nothing, or may create a different DBM file with a
-different name, or at worst, it may corrupt the DBM file if you were
-attempting to write to it.
+One should be aware that there are a number of different DBM file formats in existence, and with all likelihood, libraries for more than one format may exist on your system\&. The three primary examples are SDBM, NDBM, the GNU project's GDBM, and Berkeley DB 2\&. Unfortunately, all these libraries use different file formats, and you must make sure that the file format used by \fIfilename\fR is the same format that dbmmanage expects to see\&. dbmmanage currently has no way of determining what type of DBM file it is looking at\&. If used against the wrong format, will simply return nothing, or may create a different DBM file with a different name, or at worst, it may corrupt the DBM file if you were attempting to write to it\&.
+
.PP
-.B dbmmanage
-has a list of DBM format preferences, defined by the
-.B @AnyDBM::ISA
-array near the beginning of the program. Since we prefer the Berkeley
-DB 2 file format, the order in which
-.B dbmmanage
-will look for system libraries is Berkeley DB 2, then NDBM, and then
-GDBM. The first library found will be the library
-.B dbmmanage
-will attempt to use for all DBM file transactions. This ordering is
-slightly different than the standard
-.B @AnyDBM::ISA
-ordering in perl, as well as the ordering used by the simple dbmopen()
-call in Perl, so if you use any other utilities to manage your DBM
-files, they must also follow this preference ordering. Similar care
-must be taken if using programs in other languages, like C, to
-access these files.
+dbmmanage has a list of DBM format preferences, defined by the @AnyDBM::ISA array near the beginning of the program\&. Since we prefer the Berkeley DB 2 file format, the order in which dbmmanage will look for system libraries is Berkeley DB 2, then NDBM, then GDBM and then SDBM\&. The first library found will be the library dbmmanage will attempt to use for all DBM file transactions\&. This ordering is slightly different than the standard @AnyDBM::ISA ordering in perl, as well as the ordering used by the simple dbmopen() call in Perl, so if you use any other utilities to manage your DBM files, they must also follow this preference ordering\&. Similar care must be taken if using programs in other languages, like C, to access these files\&.
+
.PP
-Apache's
-.B mod_auth_dbm.c
-corresponds to the NDBM library. Also, one can usually use the
-.B file
-program supplied with most Unix systems to see what format a DBM file is in.
-.PD
-.SH SEE ALSO
-.BR httpd(8)
-.
+One can usually use the file program supplied with most Unix systems to see what format a DBM file is in\&.
+
+++ /dev/null
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta name="generator" content="HTML Tidy, see www.w3.org" />
-
- <title>Manual Page: dbmmanage - Apache HTTP Server</title>
- </head>
-
- <body bgcolor="#ffffff" text="#000000" link="#0000ff"
- vlink="#000080" alink="#ff0000">
- <div align="center">
- <img src="../images/sub.gif" alt="[APACHE DOCUMENTATION]" />
-
- <h3>Apache HTTP Server Version 2.1</h3>
- </div>
-
-
-
- <h1 align="center">Manual Page: dbmmanage</h1>
- <!-- This document was autogenerated from the man page -->
-<pre>
-<strong>NAME</strong>
- dbmmanage - Create and update user authentication files in
- DBM format
-
-<strong>SYNOPSIS</strong>
- <strong>dbmmanage</strong> <em>filename</em> [ <em>command</em> ] [ <em>username</em> [ <em>encpasswd</em> ] ]
-
-<strong>DESCRIPTION</strong>
- <strong>dbmmanage</strong> is used to create and update the DBM format files
- used to store usernames and password for basic authentica-
- tion of HTTP users. Resources available from the <strong>httpd</strong>
- Apache web server can be restricted to just the users listed
- in the files created by <strong>dbmmanage.</strong> This program can only be
- used when the usernames are stored in a DBM file. To use a
- flat-file database see <strong>htpasswd</strong>.
-
- This manual page only lists the command line arguments. For
- details of the directives necessary to configure user
- authentication in <strong>httpd</strong> see the Apache manual, which is part
- of the Apache distribution or can be found at
- http://www.apache.org/.
-
-<strong>OPTIONS</strong>
- <em>filename</em>
- The filename of the DBM format file. Usually without
- the extension .db, .pag, or .dir.
-
- <em>command</em>
- This selects the operation to perform:
-
- <strong>add </strong> Adds an entry for <em>username</em> to <em>filename</em> using the
- encrypted password <em>encpassword</em>.
-
- <strong>adduser </strong> Asks for a password and then adds an entry for
- <em>username</em> to <em>filename</em> .
-
- <strong>check </strong> Asks for a password and then checks if <em>username</em>
- is in <em>filename</em> and if it's password matches the
- specified one.
-
- <strong>delete </strong> Deletes the <em>username</em> entry from <em>filename</em>.
-
- <strong>import </strong> Reads username:password entries (one per line)
- from STDIN and adds them to <em>filename</em>. The pass-
- words already has to be crypted.
-
- <strong>update </strong> Same as the "adduser" command, except that it
- makes sure <em>username</em> already exists in <em>filename</em>.
-
- <strong>view </strong> Just displays the complete contents of the DBM
- file.
-
- <em>username</em> The user for which the update operation is per-
- formed.
-
-<strong>BUGS</strong>
- One should be aware that there are a number of different DBM
- file formats in existence, and with all likelihood,
- libraries for more than one format may exist on your system.
- The three primary examples are NDBM, the GNU project's GDBM,
- and Berkeley DB 2. Unfortunately, all these libraries use
- different file formats, and you must make sure that the file
- format used by <em>filename</em> is the same format that <strong>dbmmanage</strong>
- expects to see. <strong>dbmmanage</strong> currently has no way of determin-
- ing what type of DBM file it is looking at. If used against
- the wrong format, will simply return nothing, or may create
- a different DBM file with a different name, or at worst, it
- may corrupt the DBM file if you were attempting to write to
- it.
-
- <strong>dbmmanage</strong> has a list of DBM format preferences, defined by
- the <strong>@AnyDBM::ISA</strong> array near the beginning of the program.
- Since we prefer the Berkeley DB 2 file format, the order in
- which <strong>dbmmanage</strong> will look for system libraries is Berkeley
- DB 2, then NDBM, and then GDBM. The first library found
- will be the library <strong>dbmmanage</strong> will attempt to use for all
- DBM file transactions. This ordering is slightly different
- than the standard <strong>@AnyDBM::ISA</strong> ordering in perl, as well as
- the ordering used by the simple dbmopen() call in Perl, so
- if you use any other utilities to manage your DBM files,
- they must also follow this preference ordering. Similar
- care must be taken if using programs in other languages,
- like C, to access these files.
-
- Apache's <strong>mod_auth_dbm.c</strong> corresponds to the NDBM
- library. Also, one can usually use the <strong>file</strong> program sup-
- plied with most Unix systems to see what format a DBM file
- is in.
-
-<strong>SEE ALSO</strong>
- <strong>httpd(8)</strong>
-
-</pre>
- <hr />
-
- <h3 align="center">Apache HTTP Server Version 2.1</h3>
- <a href="./"><img src="../images/index.gif" alt="Index" /></a>
- <a href="../"><img src="../images/home.gif" alt="Home" /></a>
-
-
- </body>
-</html>
-
--- /dev/null
+<?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>dbmmanage - Manage user authentication files in DBM format - 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="<-" alt="<-" src="../images/left.gif" /></a></div>
+<div id="path">
+<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.1</a> > <a href="./">Programs</a></div><div id="page-content"><div id="preamble"><h1>dbmmanage - Manage user authentication files in DBM format</h1>
+ <p><code>dbmmanage</code> is used to create and update the DBM format files
+ used to store usernames and password for basic authentication of HTTP users.
+ Resources available from the Apache HTTP server can be restricted to just
+ the users listed in the files created by <code>dbmmanage</code>. This
+ program can only be used when the usernames are stored in a DBM file. To
+ use a flat-file database see <a href="htpasswd.html">htpasswd</a>.</p>
+
+ <p>This manual page only lists the command line arguments. For details of
+ the directives necessary to configure user authentication in
+ <a href="httpd.html">httpd</a> see the httpd manual, which is part of
+ the Apache distribution or can be found at <a href="http://httpd.apache.org/">http://httpd.apache.org/</a>.</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="#bugs">Bugs</a></li>
+</ul><h3>See also</h3><ul class="seealso"><li><a href="httpd.html">httpd</a></li><li><code class="module"><a href="../mod/mod_authn_dbm.html">mod_authn_dbm</a></code></li><li><code class="module"><a href="../mod/mod_authz_dbm.html">mod_authz_dbm</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>dbmmanage</strong> [ <var>encoding</var> ]
+ <var>filename</var> add|adduser|check|delete|update
+ <var>username</var>
+ [ <var>encpasswd</var>
+ [ <var>group</var>[,<var>group</var>...]
+ [ <var>comment</var> ] ] ]</code></p>
+
+ <p><code><strong>dbmmanage</strong> <var>filename</var>
+ view [ <var>username</var> ]</code></p>
+
+ <p><code><strong>dbmmanage</strong> <var>filename</var> import</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><var>filename</var></code></dt>
+ <dd>The filename of the DBM format file. Usually without the extension
+ <code>.db</code>, <code>.pag</code>, or <code>.dir</code>.</dd>
+
+ <dt><code><var>username</var></code></dt>
+ <dd>The user for which the operations are performed. The <var>username</var>
+ may not contain a colon (<code>:</code>).</dd>
+
+ <dt><code><var>encpasswd</var></code></dt>
+ <dd>This is the already encrypted password to use for the
+ <code>update</code> and <code>add</code> commands. You may use a hyphen
+ (<code>-</code>) if you want to get prompted for the password, but fill
+ in the fields afterwards. Additionally when using the <code>update</code>
+ command, a period (<code>.</code>) keeps the original password
+ untouched.</dd>
+
+ <dt><code><var>group</var></code></dt>
+ <dd>A group, which the user is member of. A groupname may not contain a
+ colon (<code>:</code>). You may use a hyphen (<code>-</code>) if you don't
+ want to assign the user to a group, but fill in the comment field.
+ Additionally when using the <code>update</code> command, a period
+ (<code>.</code>) keeps the original groups untouched.</dd>
+
+ <dt><code><var>comment</var></code></dt>
+ <dd>This is the place for your opaque comments about the user, like
+ realname, mailaddress or such things. The server will ignore this
+ field.</dd>
+ </dl>
+
+ <h3><a name="options.encodings" id="options.encodings">Encodings</a></h3>
+ <dl>
+ <dt><code>-d</code></dt>
+ <dd>crypt encryption (default, except on Win32, Netware)</dd>
+
+ <dt><code>-m</code></dt>
+ <dd>MD5 encryption (default on Win32, Netware)</dd>
+
+ <dt><code>-s</code></dt>
+ <dd>SHA1 encryption</dd>
+
+ <dt><code>-p</code></dt>
+ <dd>plaintext (<em>not recommended</em>)</dd>
+ </dl>
+
+
+ <h3><a name="options.commands" id="options.commands">Commands</a></h3>
+ <dl>
+ <dt><code>add</code></dt>
+ <dd>Adds an entry for <var>username</var> to <var>filename</var> using the
+ encrypted password <var>encpasswd</var>.</dd>
+
+ <dt><code>adduser</code></dt>
+ <dd>Asks for a password and then adds an entry for <var>username</var> to
+ <var>filename</var>.</dd>
+
+ <dt><code>check</code></dt>
+ <dd>Asks for a password and then checks if <var>username</var> is in
+ <var>filename</var> and if it's password matches the specified one.</dd>
+
+ <dt><code>delete</code></dt>
+ <dd>Deletes the <var>username</var> entry from <var>filename</var>.</dd>
+
+ <dt><code>import</code></dt>
+ <dd>Reads <code><var>username</var>:<var>password</var></code> entries
+ (one per line) from <code>STDIN</code> and adds them to
+ <var>filename</var>. The passwords already have to be crypted.</dd>
+
+ <dt><code>update</code></dt>
+ <dd>Same as the <code>adduser</code> command, except that it makes
+ sure <var>username</var> already exists in <var>filename</var>.</dd>
+
+ <dt><code>view</code></dt>
+ <dd>Just displays the contents of the DBM file. If you specify a
+ <var>username</var>, it displays the particular record only.</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="bugs" id="bugs">Bugs</a></h2>
+ <p>One should be aware that there are a number of different DBM file formats
+ in existence, and with all likelihood, libraries for more than one format
+ may exist on your system. The three primary examples are SDBM, NDBM, the GNU
+ project's GDBM, and Berkeley DB 2. Unfortunately, all these libraries use
+ different file formats, and you must make sure that the file format used
+ by <var>filename</var> is the same format that <code>dbmmanage</code>
+ expects to see. <code>dbmmanage</code> currently has no way of determining
+ what type of DBM file it is looking at. If used against the wrong format,
+ will simply return nothing, or may create a different DBM file with a
+ different name, or at worst, it may corrupt the DBM file if you were
+ attempting to write to it.</p>
+
+ <p><code>dbmmanage</code> has a list of DBM format preferences, defined by
+ the <code>@AnyDBM::ISA</code> array near the beginning of the program. Since
+ we prefer the Berkeley DB 2 file format, the order in which
+ <code>dbmmanage</code> will look for system libraries is Berkeley DB 2,
+ then NDBM, then GDBM and then SDBM. The first library found will be the
+ library <code>dbmmanage</code> will attempt to use for all DBM file
+ transactions. This ordering is slightly different than the standard
+ <code>@AnyDBM::ISA</code> ordering in perl, as well as the ordering used by
+ the simple <code>dbmopen()</code> call in Perl, so if you use any other
+ utilities to manage your DBM files, they must also follow this preference
+ ordering. Similar care must be taken if using programs in other languages,
+ like C, to access these files.</p>
+
+ <p>One can usually use the <code>file</code> program supplied with most
+ Unix systems to see what format a DBM file is in.</p>
+</div></div>
+<div id="footer">
+<p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</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
--- /dev/null
+<?xml version='1.0' encoding='UTF-8' ?>
+<!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
+<manualpage metafile="dbmmanage.xml.meta">
+<parentdocument href="./">Programs</parentdocument>
+
+<title>dbmmanage - Manage user authentication files in DBM format</title>
+
+<summary>
+ <p><code>dbmmanage</code> is used to create and update the DBM format files
+ used to store usernames and password for basic authentication of HTTP users.
+ Resources available from the Apache HTTP server can be restricted to just
+ the users listed in the files created by <code>dbmmanage</code>. This
+ program can only be used when the usernames are stored in a DBM file. To
+ use a flat-file database see <a href="htpasswd.html">htpasswd</a>.</p>
+
+ <p>This manual page only lists the command line arguments. For details of
+ the directives necessary to configure user authentication in
+ <a href="httpd.html">httpd</a> see the httpd manual, which is part of
+ the Apache distribution or can be found at <a
+ href="http://httpd.apache.org/">http://httpd.apache.org/</a>.</p>
+</summary>
+<seealso><a href="httpd.html">httpd</a></seealso>
+<seealso><module>mod_authn_dbm</module></seealso>
+<seealso><module>mod_authz_dbm</module></seealso>
+
+<section id="synopsis"><title>Synopsis</title>
+ <p><code><strong>dbmmanage</strong> [ <var>encoding</var> ]
+ <var>filename</var> add|adduser|check|delete|update
+ <var>username</var>
+ [ <var>encpasswd</var>
+ [ <var>group</var>[,<var>group</var>...]
+ [ <var>comment</var> ] ] ]</code></p>
+
+ <p><code><strong>dbmmanage</strong> <var>filename</var>
+ view [ <var>username</var> ]</code></p>
+
+ <p><code><strong>dbmmanage</strong> <var>filename</var> import</code></p>
+</section>
+
+<section id="options"><title>Options</title>
+ <dl>
+ <dt><code><var>filename</var></code></dt>
+ <dd>The filename of the DBM format file. Usually without the extension
+ <code>.db</code>, <code>.pag</code>, or <code>.dir</code>.</dd>
+
+ <dt><code><var>username</var></code></dt>
+ <dd>The user for which the operations are performed. The <var>username</var>
+ may not contain a colon (<code>:</code>).</dd>
+
+ <dt><code><var>encpasswd</var></code></dt>
+ <dd>This is the already encrypted password to use for the
+ <code>update</code> and <code>add</code> commands. You may use a hyphen
+ (<code>-</code>) if you want to get prompted for the password, but fill
+ in the fields afterwards. Additionally when using the <code>update</code>
+ command, a period (<code>.</code>) keeps the original password
+ untouched.</dd>
+
+ <dt><code><var>group</var></code></dt>
+ <dd>A group, which the user is member of. A groupname may not contain a
+ colon (<code>:</code>). You may use a hyphen (<code>-</code>) if you don't
+ want to assign the user to a group, but fill in the comment field.
+ Additionally when using the <code>update</code> command, a period
+ (<code>.</code>) keeps the original groups untouched.</dd>
+
+ <dt><code><var>comment</var></code></dt>
+ <dd>This is the place for your opaque comments about the user, like
+ realname, mailaddress or such things. The server will ignore this
+ field.</dd>
+ </dl>
+
+ <section id="options.encodings"><title>Encodings</title>
+ <dl>
+ <dt><code>-d</code></dt>
+ <dd>crypt encryption (default, except on Win32, Netware)</dd>
+
+ <dt><code>-m</code></dt>
+ <dd>MD5 encryption (default on Win32, Netware)</dd>
+
+ <dt><code>-s</code></dt>
+ <dd>SHA1 encryption</dd>
+
+ <dt><code>-p</code></dt>
+ <dd>plaintext (<em>not recommended</em>)</dd>
+ </dl>
+ </section>
+
+ <section id="options.commands"><title>Commands</title>
+ <dl>
+ <dt><code>add</code></dt>
+ <dd>Adds an entry for <var>username</var> to <var>filename</var> using the
+ encrypted password <var>encpasswd</var>.</dd>
+
+ <dt><code>adduser</code></dt>
+ <dd>Asks for a password and then adds an entry for <var>username</var> to
+ <var>filename</var>.</dd>
+
+ <dt><code>check</code></dt>
+ <dd>Asks for a password and then checks if <var>username</var> is in
+ <var>filename</var> and if it's password matches the specified one.</dd>
+
+ <dt><code>delete</code></dt>
+ <dd>Deletes the <var>username</var> entry from <var>filename</var>.</dd>
+
+ <dt><code>import</code></dt>
+ <dd>Reads <code><var>username</var>:<var>password</var></code> entries
+ (one per line) from <code>STDIN</code> and adds them to
+ <var>filename</var>. The passwords already have to be crypted.</dd>
+
+ <dt><code>update</code></dt>
+ <dd>Same as the <code>adduser</code> command, except that it makes
+ sure <var>username</var> already exists in <var>filename</var>.</dd>
+
+ <dt><code>view</code></dt>
+ <dd>Just displays the contents of the DBM file. If you specify a
+ <var>username</var>, it displays the particular record only.</dd>
+ </dl>
+ </section>
+</section>
+
+<section id="bugs"><title>Bugs</title>
+ <p>One should be aware that there are a number of different DBM file formats
+ in existence, and with all likelihood, libraries for more than one format
+ may exist on your system. The three primary examples are SDBM, NDBM, the GNU
+ project's GDBM, and Berkeley DB 2. Unfortunately, all these libraries use
+ different file formats, and you must make sure that the file format used
+ by <var>filename</var> is the same format that <code>dbmmanage</code>
+ expects to see. <code>dbmmanage</code> currently has no way of determining
+ what type of DBM file it is looking at. If used against the wrong format,
+ will simply return nothing, or may create a different DBM file with a
+ different name, or at worst, it may corrupt the DBM file if you were
+ attempting to write to it.</p>
+
+ <p><code>dbmmanage</code> has a list of DBM format preferences, defined by
+ the <code>@AnyDBM::ISA</code> array near the beginning of the program. Since
+ we prefer the Berkeley DB 2 file format, the order in which
+ <code>dbmmanage</code> will look for system libraries is Berkeley DB 2,
+ then NDBM, then GDBM and then SDBM. The first library found will be the
+ library <code>dbmmanage</code> will attempt to use for all DBM file
+ transactions. This ordering is slightly different than the standard
+ <code>@AnyDBM::ISA</code> ordering in perl, as well as the ordering used by
+ the simple <code>dbmopen()</code> call in Perl, so if you use any other
+ utilities to manage your DBM files, they must also follow this preference
+ ordering. Similar care must be taken if using programs in other languages,
+ like C, to access these files.</p>
+
+ <p>One can usually use the <code>file</code> program supplied with most
+ Unix systems to see what format a DBM file is in.</p>
+</section>
+
+</manualpage>
--- /dev/null
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<metafile>
+ <basename>dbmmanage</basename>
+ <path>/programs/</path>
+ <relpath>..</relpath>
+
+ <variants>
+ <variant>en</variant>
+ </variants>
+</metafile>
<!-- documents not converted (yet?). -->
<not-exists>
<file>developer/API.xml</file>
- <file>programs/dbmmanage.xml</file>
<file>programs/htdigest.xml</file>
<file>programs/htpasswd.xml</file>
<file>programs/other.xml</file>
projects / apache / commitdiff