<?xml version="1.0" encoding="utf-8"?>
<!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 GNOME Documentation Project
  http://developer.gnome.org/projects/gdp
  Template version: 2.0 beta
  Template last modified Feb 06, 2003
-->
<!-- =============Document Header ============================= -->
<article id="index" lang="en_GB">
<!-- please do not change the id; for translations, change lang to -->
<!-- appropriate code -->
  <articleinfo> 
    <title>Users Administration Tool Manual</title> 
    <copyright>
      <year>2004</year>
      <holder>Carlos Garnacho Parro</holder>
    </copyright><copyright><year>2009</year><holder>Jen Ockwell (jenfraggleubuntu@gmail.com)</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> 

  <legalnotice id="legalnotice">
	<para>Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation Licence (GFDL), Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. You can find a copy of the GFDL at this <ulink type="help" url="ghelp:fdl">link</ulink> or in the file COPYING-DOCS distributed with this manual.</para>
         <para>This manual is part of a collection of GNOME manuals distributed under the GFDL. If you want to distribute this manual separately from the collection, you can do so by adding a copy of the licence to the manual, as described in section 6 of the licence.</para>

	<para>Many of the names used by companies to distinguish their products and services are claimed as trademarks. Where those names appear in any GNOME documentation, and the members of the GNOME Documentation Project are made aware of those trademarks, then the names are in capital letters or initial capital letters.</para>

	<para>DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENCE WITH THE FURTHER UNDERSTANDING THAT: <orderedlist>
		<listitem>
		  <para>DOCUMENT IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE OF THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT, YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENCE. NO USE OF ANY DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS AUTHORISED HEREUNDER EXCEPT UNDER THIS DISCLAIMER; AND</para>
		</listitem>
		<listitem>
		  <para>UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL THE AUTHOR, INITIAL WRITER, ANY CONTRIBUTOR, OR ANY DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE TO ANY PERSON FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR LOSSES ARISING OUT OF OR RELATING TO USE OF THE DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT, EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF THE POSSIBILITY OF SUCH DAMAGES.</para>
		</listitem>
	  </orderedlist></para>
  </legalnotice>


<!-- 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>Users Administration Tool Manual V2.15.2</revnumber>
	   <date>August 2006</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>Users Administration 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 2.15.2 of Users Administration Tool.</releaseinfo> 

    <legalnotice> 
	 <title>Feedback</title> 
	 <para>To report a bug or make a suggestion regarding the Users Administration Tool or this manual, follow the directions in the <ulink url="ghelp:gnome-feedback" type="help">GNOME Feedback Page</ulink>.</para>
    </legalnotice>
    <abstract role="description">
      <para>The Users Administration 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>Users Administration 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>Users Administration 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>Users Administration 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>Users Administration Tool main window</title>
	 <screenshot>
	   <mediaobject>
		<imageobject>
		  <imagedata fileref="figures/users-tool.png" format="PNG"/>
		</imageobject>
		<textobject>
		  <phrase>Shows Users Administration Tool main window.</phrase>
		</textobject>
	   </mediaobject>
	 </screenshot>
    </figure>

    <para>The <application>Users Administration Tool</application> main window contains the following elements:</para>

    <variablelist>
	 <varlistentry>
	   <term><guilabel>User list</guilabel></term>
	   <listitem>
		<para>Shows the available users. Depending on the GConf key <literal>/apps/gnome-system-tools/users/showall</literal> 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 dialogue to modify group settings.</para>
	   </listitem>
	 </varlistentry>
    </variablelist>

    <figure id="users-groups-editor">
	 <title>Users Administration Tool groups editor</title>
	 <screenshot>
	   <mediaobject>
		<imageobject>
		  <imagedata fileref="figures/groups.png" format="PNG"/>
		</imageobject>
		<textobject>
		  <phrase>Group 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 <guibutton>Add</guibutton> button in the main dialogue; 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, shell used, home directory, user ID and a list of the secondary groups for the user.</para>

	 <para>Main group, shell used, 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 <guibutton>Properties</guibutton> 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 <guibutton>Delete</guibutton> 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 <guibutton>Add</guibutton> button in the groups dialogue. 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 dialogue and press the <guibutton>Properties</guibutton> button, A window will appear with the group's data allowing you to modify it.</para>
    </sect2>

    <sect2>
	 <title>To delete an existing group</title>
	 <para>Select the group or groups that you want to delete in the groups dialogue and press the <guibutton>Delete</guibutton> 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>
