<?xml version="1.0"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
  <!ENTITY legal SYSTEM "legal.xml">
  <!ENTITY toolversion "2.15.2">
  <!ENTITY manrevision "2.15.2">
  <!ENTITY date "August 2006">
  <!ENTITY tool "Users Administration Tool">
]>
<!-- 
      (Do not remove this comment block.)
  Maintained by the MATE Documentation Project
  http://developer.mate.org/projects/gdp
  Template version: 2.0 beta
  Template last modified Feb 06, 2003
-->
<!-- =============Document Header ============================= -->
<article id="index" lang="en">
<!-- please do not change the id; for translations, change lang to -->
<!-- appropriate code -->
  <articleinfo> 
    <title>&tool; Manual</title> 
    <copyright>
      <year>2004</year>
      <holder>Carlos Garnacho Parro</holder>
    </copyright>

<!-- translators: uncomment this:
  <copyright>
   <year>2003</year>
   <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
  </copyright>
   -->

    <publisher role="maintainer"> 
	 <publishername>Carlos Garnacho Parro</publishername> 
    </publisher> 

&legal;
<!-- This file  contains link to license for the documentation (GNU FDL), and 
     other legal stuff such as "NO WARRANTY" statement. Please do not change 
     any of this. -->

    <authorgroup> 
      <author>
        <firstname>Carlos</firstname>
        <surname>Garnacho Parro</surname>
      </author>
      <!-- This is appropriate place for other contributors: translators,
           maintainers,  etc. Commented out by default.
        <othercredit role="translator">
	      <firstname>Latin</firstname> 
	      <surname>Translator 1</surname> 
	      <affiliation> 
	      	<orgname>Latin Translation Team</orgname> 
	       	<address> <email>translator@gnome.org</email> </address> 
	      </affiliation>
	      <contrib>Latin translation</contrib>
        </othercredit>
-->
    </authorgroup>

    <revhistory>
	 <revision>
	   <revnumber>&tool; Manual V&manrevision;</revnumber>
	   <date>&date;</date>
	   <revdescription>
          <para role="author">carlosg@gnome.org (Carlos Garnacho Parro)</para>
          <para role="publisher">carlosg@gnome.org (Carlos Garnacho Parro)</para>
	   </revdescription>
	 </revision>
	 <revision>
	   <revnumber>&tool; Manual V0.35</revnumber>
	   <date>June 2004</date>
	   <revdescription>
          <para role="author">carlosg@gnome.org (Carlos Garnacho Parro)</para>
          <para role="publisher">carlosg@gnome.org (Carlos Garnacho Parro)</para>
	   </revdescription>
	 </revision>
    </revhistory>

    <releaseinfo>This manual describes version &toolversion; of &tool;.</releaseinfo> 

    <legalnotice> 
	 <title>Feedback</title> 
	 <para> To report a bug or make a suggestion regarding the &tool; or this manual, follow the directions in the <ulink url="help:mate-feedback" type="help">MATE Feedback Page</ulink>. </para>
    </legalnotice>
    <abstract role="description">
      <para>The &tool; allows you add, delete and modify the existing users and groups in your system.</para>
    </abstract>
  </articleinfo> 

  <indexterm zone="index"> 
    <primary>Users Administration Tool</primary> 
  </indexterm> 

  <!-- ============= Document Body ============================= -->
  <sect1 id="tool-introduction"> 
    <title>Introduction</title> 
    <para>The <application>&tool;</application> allows you add, delete and modify the existing users and groups in your system.</para> 
  </sect1>

  <sect1 id="tool-getting-started">
    <title>Getting started</title>

    <para>You can start <application>&tool;</application> in the following ways:</para>

    <variablelist>
	 <varlistentry>
	   <term><guimenu>System</guimenu> menu</term>
	   <listitem>
		<para>Choose <menuchoice><guisubmenu>Administration</guisubmenu><guimenuitem>Users and groups</guimenuitem></menuchoice>.</para>
	   </listitem>
	 </varlistentry>

	 <varlistentry>
	   <term>Command line</term>
	   <listitem>
		<para>Execute the following command: <command>users-admin</command></para>
	   </listitem>
	 </varlistentry>
    </variablelist>

    <para>When you start <application>&tool;</application>, you will be prompted for the administrator password, this is necessary because the changes done with this tool will affect the whole system.</para>

    <para>After entering the administrator password, the following window is displayed.</para>

    <figure id="users-main-window">
	 <title>&tool; main window</title>
	 <screenshot>
	   <mediaobject>
		<imageobject>
		  <imagedata fileref="figures/users-tool.png" format="PNG"/>
		</imageobject>
		<textobject>
		  <phrase>Shows &tool; main window.</phrase>
		</textobject>
	   </mediaobject>
	 </screenshot>
    </figure>

    <para>The <application>&tool;</application> main window contains the following elements:</para>

    <variablelist>
	 <varlistentry>
	   <term><guilabel>Users list</guilabel></term>
	   <listitem>
		<para>Shows the available users. depending on the mateconf key "/apps/mate-system-tools/users/showall" it will show the system users too.</para>
	   </listitem>
	 </varlistentry>

	 <varlistentry>
	   <term><guilabel>User manipulation buttons</guilabel></term>
	   <listitem>
		<para>Allows to add or delete users or modify user settings.</para>
	   </listitem>
	 </varlistentry>
	 <varlistentry>
	   <term><guilabel>Manage groups button</guilabel></term>
	   <listitem>
		<para>Shows a similar dialog to modify group settings.</para>
	   </listitem>
	 </varlistentry>
    </variablelist>

    <figure id="users-groups-editor">
	 <title>&tool; groups editor</title>
	 <screenshot>
	   <mediaobject>
		<imageobject>
		  <imagedata fileref="figures/groups.png" format="PNG"/>
		</imageobject>
		<textobject>
		  <phrase>Groups editor.</phrase>
		</textobject>
	   </mediaobject>
	 </screenshot>
    </figure>
  </sect1>

  <sect1 id="tool-usage">
    <title>Usage</title>

    <sect2 id="tool-add-new-user">
	 <title>To add a new user</title>
	 <para>Press the <guilabel>Add</guilabel> button in the main dialog, a new window will appear asking for the new user data. For adding a new user, you must provide at least the username and password (automatically generated or by hand). Optionally you can specify or modify real name, office location, work phone, home phone, main group, used shell, home directory, user ID and a list of the secondary groups for the user.</para>

	 <para>Main group, used shell, home directory and user ID are automatically guessed depending on the selected profile.</para>
    </sect2>

    <sect2>
	 <title>To modify an existing user</title>
	 <para>Select the user you want to modify and press the <guilabel>Properties</guilabel> button, a window similar to the one used for adding new users will appear with all the user data, allowing you to modify them.</para>
    </sect2>

    <sect2>
	 <title>To delete an existing user</title>
	 <para>Select the user or users that you want to delete and press the <guilabel>Delete</guilabel> button in the <guilabel>Users</guilabel> tab, due to the importance of this data, you will be asked for confirmation for every user you want to delete.</para>

	 <para>For security reasons, the home directory of the deleted users will not be deleted.</para>
    </sect2>

    <sect2 id="tool-add-new-group">
	 <title>To add a new group</title>
	 <para>Press the <guilabel>Add</guilabel> button in the groups dialog, a new window will appear asking for the new group data. For adding a new group, you must provide at least the group name and the group ID. Optionally you can specify the users that will belong to this group.</para>
    </sect2>

    <sect2>
	 <title>To modify an existing group</title>
	 <para>Select the group you want to modify in the groups dialog and press the <guilabel>Properties</guilabel> button, A window will appear with the group's data allowing you to modify them.</para>
    </sect2>

    <sect2>
	 <title>To delete an existing group</title>
	 <para>Select the group or groups that you want to delete in the groups dialog and press the <guilabel>Delete</guilabel> button in the <guilabel>Groups</guilabel> tab, due to the importance of this data, you will be asked for confirmation for every group you want to delete.</para>
    </sect2>
  </sect1>
</article> 
