home *** CD-ROM | disk | FTP | other *** search
/ PC World 2004 May / PCWorld_2004-05_cd.bin / komunikace / apache / apache_2.0.48-win32-x86-no_ssl.msi / Data.Cab / F252882_dbmmanage.xml < prev    next >
Extensible Markup Language  |  2003-05-09  |  7KB  |  151 lines
  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. <manualpage metafile="dbmmanage.xml.meta">
  5. <parentdocument href="./">Programs</parentdocument>
  6.  
  7. <title>dbmmanage - Manage user authentication files in DBM format</title>
  8.  
  9. <summary>
  10.     <p><code>dbmmanage</code> is used to create and update the DBM format files
  11.     used to store usernames and password for basic authentication of HTTP users.
  12.     Resources available from the Apache HTTP server can be restricted to just
  13.     the users listed in the files created by <code>dbmmanage</code>. This
  14.     program can only be used when the usernames are stored in a DBM file. To
  15.     use a flat-file database see <a href="htpasswd.html">htpasswd</a>.</p>
  16.  
  17.     <p>This manual page only lists the command line arguments. For details of
  18.     the directives necessary to configure user authentication in
  19.     <a href="httpd.html">httpd</a> see the httpd manual, which is part of
  20.     the Apache distribution or can be found at <a
  21.     href="http://httpd.apache.org/">http://httpd.apache.org/</a>.</p>
  22. </summary>
  23. <seealso><a href="httpd.html">httpd</a></seealso>
  24. <seealso><module>mod_auth_dbm</module></seealso>
  25.  
  26. <section id="synopsis"><title>Synopsis</title>
  27.     <p><code><strong>dbmmanage</strong> [ <var>encoding</var> ]
  28.     <var>filename</var> add|adduser|check|delete|update
  29.     <var>username</var>
  30.     [ <var>encpasswd</var>
  31.       [ <var>group</var>[,<var>group</var>...]
  32.         [ <var>comment</var> ] ] ]</code></p>
  33.  
  34.     <p><code><strong>dbmmanage</strong> <var>filename</var>
  35.     view [ <var>username</var> ]</code></p>
  36.  
  37.     <p><code><strong>dbmmanage</strong> <var>filename</var> import</code></p>
  38. </section>
  39.  
  40. <section id="options"><title>Options</title>
  41.     <dl>
  42.     <dt><code><var>filename</var></code></dt>
  43.     <dd>The filename of the DBM format file. Usually without the extension
  44.     <code>.db</code>, <code>.pag</code>, or <code>.dir</code>.</dd>
  45.  
  46.     <dt><code><var>username</var></code></dt>
  47.     <dd>The user for which the operations are performed. The <var>username</var>
  48.     may not contain a colon (<code>:</code>).</dd>
  49.  
  50.     <dt><code><var>encpasswd</var></code></dt>
  51.     <dd>This is the already encrypted password to use for the
  52.     <code>update</code> and <code>add</code> commands. You may use a hyphen
  53.     (<code>-</code>) if you want to get prompted for the password, but fill
  54.     in the fields afterwards. Additionally when using the <code>update</code>
  55.     command, a period (<code>.</code>) keeps the original password
  56.     untouched.</dd>
  57.  
  58.     <dt><code><var>group</var></code></dt>
  59.     <dd>A group, which the user is member of. A groupname may not contain a
  60.     colon (<code>:</code>). You may use a hyphen (<code>-</code>) if you don't
  61.     want to assign the user to a group, but fill in the comment field.
  62.     Additionally when using the <code>update</code> command, a period
  63.     (<code>.</code>) keeps the original groups untouched.</dd>
  64.  
  65.     <dt><code><var>comment</var></code></dt>
  66.     <dd>This is the place for your opaque comments about the user, like
  67.     realname, mailaddress or such things. The server will ignore this
  68.     field.</dd>
  69.     </dl>
  70.  
  71.     <section id="options.encodings"><title>Encodings</title>
  72.       <dl>
  73.       <dt><code>-d</code></dt>
  74.       <dd>crypt encryption (default, except on Win32, Netware)</dd>
  75.  
  76.       <dt><code>-m</code></dt>
  77.       <dd>MD5 encryption (default on Win32, Netware)</dd>
  78.  
  79.       <dt><code>-s</code></dt>
  80.       <dd>SHA1 encryption</dd>
  81.  
  82.       <dt><code>-p</code></dt>
  83.       <dd>plaintext (<em>not recommended</em>)</dd>
  84.       </dl>
  85.     </section>
  86.  
  87.     <section id="options.commands"><title>Commands</title>
  88.       <dl>
  89.       <dt><code>add</code></dt>
  90.       <dd>Adds an entry for <var>username</var> to <var>filename</var> using the
  91.       encrypted password <var>encpasswd</var>.</dd>
  92.  
  93.       <dt><code>adduser</code></dt>
  94.       <dd>Asks for a password and then adds an entry for <var>username</var> to
  95.       <var>filename</var>.</dd>
  96.  
  97.       <dt><code>check</code></dt>
  98.       <dd>Asks for a password and then checks if <var>username</var> is in
  99.       <var>filename</var> and if it's password matches the specified one.</dd>
  100.  
  101.       <dt><code>delete</code></dt>
  102.       <dd>Deletes the <var>username</var> entry from <var>filename</var>.</dd>
  103.  
  104.       <dt><code>import</code></dt>
  105.       <dd>Reads <code><var>username</var>:<var>password</var></code> entries
  106.       (one per line) from <code>STDIN</code> and adds them to
  107.       <var>filename</var>. The passwords already have to be crypted.</dd>
  108.  
  109.       <dt><code>update</code></dt>
  110.       <dd>Same as the <code>adduser</code> command, except that it makes
  111.       sure <var>username</var> already exists in <var>filename</var>.</dd>
  112.  
  113.       <dt><code>view</code></dt>
  114.       <dd>Just displays the contents of the DBM file. If you specify a
  115.       <var>username</var>, it displays the particular record only.</dd>
  116.       </dl>
  117.     </section>
  118. </section>
  119.  
  120. <section id="bugs"><title>Bugs</title>
  121.     <p>One should be aware that there are a number of different DBM file formats
  122.     in existence, and with all likelihood, libraries for more than one format
  123.     may exist on your system. The three primary examples are SDBM, NDBM, the GNU
  124.     project's GDBM, and Berkeley DB 2. Unfortunately, all these libraries use
  125.     different file formats, and you must make sure that the file format used
  126.     by <var>filename</var> is the same format that <code>dbmmanage</code>
  127.     expects to see. <code>dbmmanage</code> currently has no way of determining
  128.     what type of DBM file it is looking at. If used against the wrong format,
  129.     will simply return nothing, or may create a different DBM file with a
  130.     different name, or at worst, it may corrupt the DBM file if you were
  131.     attempting to write to it.</p>
  132.  
  133.     <p><code>dbmmanage</code> has a list of DBM format preferences, defined by
  134.     the <code>@AnyDBM::ISA</code> array near the beginning of the program. Since
  135.     we prefer the Berkeley DB 2 file format, the order in which
  136.     <code>dbmmanage</code> will look for system libraries is Berkeley DB 2,
  137.     then NDBM, then GDBM and then SDBM. The first library found will be the
  138.     library <code>dbmmanage</code> will attempt to use for all DBM file
  139.     transactions. This ordering is slightly  different than the standard
  140.     <code>@AnyDBM::ISA</code> ordering in perl, as well as the ordering used by
  141.     the simple <code>dbmopen()</code> call in Perl, so if you use any other
  142.     utilities to manage your DBM files, they must also follow this preference
  143.     ordering. Similar care must be taken if using programs in other languages,
  144.     like C, to access these files.</p>
  145.  
  146.     <p>One can usually use the <code>file</code> program supplied with most
  147.     Unix systems to see what format a DBM file is in.</p>
  148. </section>
  149.  
  150. </manualpage>
  151.