view release on metacpan or  search on metacpan

user_manage.html  view on Meta::CPAN

<p>

<div align=CENTER>
<img src="figs/administrator.1.gif" alt="figure 4"><br>
<cite>Administrator's user management screen</cite>
</div>


<h4>Adding a New User</h4>

To add a new user, type his or her user name into the text field
labeled <em>New User</em> and press <em>Edit/Add</em>.  A screen like
this one will appear:

<p>

<div align=CENTER>
<img src="figs/administrator.2.gif" alt="figure 5"><br>
<cite>Adding a new user</cite>
</div>

<p>

The checkboxes labeled <em>Set Groups</em> contains all the groups
currently defined.  Toggle all the groups that you wish the user to
belong to.  If a group isn't already defined, you can type in its name
in the text field labeled <em>Other:</em>.  Enter and reenter the
password for this user in the text fields labeled <em>Password
Enter</em> and <em>Confirm</em>.  When you are satisifed, press the
<cite>Set Values</cite> button.  A confirmation will appear at the top
of the page, and the script will display the "User Edit" page
described in the next section.  You can re-edit the user (to define
new groups, for example), edit a different user, or add another new
user.

<p>

If any additional user fields are defined in the configuration file,
they will appear as a series of text fields in a section labeled
"Other Information".  In the example shown here there are three
labeled "name", "age" and "paid."

<p>

If there are more than five groups defined, the list of checkboxes
will turn into a scrolling list in order to save space.

<h4>Editing an Existing User</h4>

To edit an existing user, just select the user from the user list and
press <em>Edit/Add</em>.  This will bring up the page shown below.
The top portion of the screen contains a duplicate of the user
selection page, while the bottom portion contains the entry for the
selected user.  Edit the user's assigned groups and/or passwords and
press <cite>Set Values</cite>.  If you inadvertently make a change
that you do not want to keep, press <cite>Reset Values</cite> to
revert to the original values.

<p>

The screenshot below also shows how the popup menu of existing users
turns into a scrolling list when the number becomes large.

<p>

<div align=CENTER>
<img src="figs/administrator.3.gif" alt="figure 6"><br>
<cite>Editing an existing user</cite>
</div>

<h4>Deleting a User</h4>

Select the user you wish to delete from the user list and press the
<cite>Delete</cite> button.

<hr>

<h3>Managing Users from the Command Line</h3>

<cite>user_manage</cite> can be used from the command line to
add, edit, and delete users.  It's also a handy way to view the
contents of a DB or DBM file.

<p>

The syntax for invoking the script from the command line is:

<blockquote>
user_manage [<em>realm</em>] <em>command</em> <em>argument1 argument2 argument3</em>
</blockquote>

The first argument to the command is the security realm.  You can, if
you wish, omit the realm name entirely.  If you do so, the script
will default to the first realm defined in its configuration file.
This is followed by a command indicating the action you want the
script to take.  Following this are zero or more additional arguments,
the meaning of which depend on the command that's being issued.

<p>

Here's a summary of the commands and their arguments:

<p>

<table border>
<caption>Commands recognized by <cite>user_manage</cite></caption>
<tr><th>Command   <th>Arguments         <th>Description
<tr><th>setup     <td>(none)                    <td>First-time setup
    for a database
<tr><th>add       <td><em>user password [group1,group2...] [field1=value1,field2=value2...]</em> <td>Add or edit a user's password & groups
<tr><th>delete    <td><em>user1 user2...</em>     <td>Delete named users
<tr><th>edit      <td><em>user password [group1,group2...]  [field1=value1,field2=value2...]</em> <td>A synonym for "add"
<tr><th>realms   <td>(none)            <td>Concise list of all defined realms
<tr><th>group     <td><em>user [group1,group2...]</em> <td>Set the user's groups
<tr><th>group     <td><em>user [field1=value1,field2=value2...]</em> <td>Set the user's values
<tr><th>view      <td><em>user1 user2...</em>   <td>View users' entries
<tr><th>view      <td>(none)                    <td>View all users
<tr><th>format    <td>(none)                    <td>Create a formatted
    entry for access.conf
</table>