diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/manual/programs/dbmmanage.xml | 33 |
1 files changed, 26 insertions, 7 deletions
diff --git a/docs/manual/programs/dbmmanage.xml b/docs/manual/programs/dbmmanage.xml index 32310f7ce1..c23d6101c4 100644 --- a/docs/manual/programs/dbmmanage.xml +++ b/docs/manual/programs/dbmmanage.xml @@ -25,7 +25,8 @@ <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. + used to store usernames and password for basic authentication of HTTP users + via <module>mod_auth_dbm</module>. 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 @@ -105,18 +106,30 @@ <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> + encrypted password <var>encpasswd</var>. + + <example>dbmmanage passwords.dat add rbowen foKntnEF3KSXA</example> + </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> + <var>filename</var>. + + <example>dbmmanage passwords.dat adduser krietz</example> + </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> + <var>filename</var> and if it's password matches the specified one. + + <example>dbmmanage passwords.dat check rbowen</example> + </dd> <dt><code>delete</code></dt> - <dd>Deletes the <var>username</var> entry from <var>filename</var>.</dd> + <dd>Deletes the <var>username</var> entry from <var>filename</var>. + + <example>dbmmanage passwords.dat delete rbowen</example> + </dd> <dt><code>import</code></dt> <dd>Reads <code><var>username</var>:<var>password</var></code> entries @@ -125,11 +138,17 @@ <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> + sure <var>username</var> already exists in <var>filename</var>. + + <example>dbmmanage passwords.dat update rbowen</example> + </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> + <var>username</var>, it displays the particular record only. + + <example>dbmmanage passwords.dat view</example> + </dd> </dl> </section> </section> |