Initial commit for Tizen
[profile/extras/shadow-utils.git] / man / gshadow.5.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3    Copyright (c) 2005 - 2008, Nicolas François
4    All rights reserved.
5   
6    Redistribution and use in source and binary forms, with or without
7    modification, are permitted provided that the following conditions
8    are met:
9    1. Redistributions of source code must retain the above copyright
10       notice, this list of conditions and the following disclaimer.
11    2. Redistributions in binary form must reproduce the above copyright
12       notice, this list of conditions and the following disclaimer in the
13       documentation and/or other materials provided with the distribution.
14    3. The name of the copyright holders or contributors may not be used to
15       endorse or promote products derived from this software without
16       specific prior written permission.
17   
18    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
21    PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
22    HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 -->
30 <refentry id='gshadow.5'>
31   <!-- $Id: gshadow.5.xml 2965 2009-05-21 13:53:56Z nekral-guest $ -->
32   <refmeta>
33     <refentrytitle>gshadow</refentrytitle>
34     <manvolnum>5</manvolnum>
35     <refmiscinfo class="sectdesc">File Formats and Conversions</refmiscinfo>
36   </refmeta>
37   <refnamediv id='name'>
38     <refname>gshadow</refname>
39     <refpurpose>shadowed group file</refpurpose>
40   </refnamediv>
41
42   <refsect1 id='description'>
43     <title>DESCRIPTION</title>
44     <para>
45       <filename>/etc/gshadow</filename> contains the shadowed information
46       for group accounts.
47     </para>
48
49     <para>
50       This file must not be readable by regular users if password security
51       is to be maintained.
52     </para>
53
54     <para>
55       Each line of this file contains the following colon-separated
56       fields:
57     </para>
58     <variablelist>
59       <varlistentry>
60         <term><emphasis role="bold">group name</emphasis></term>
61         <listitem>
62           <para>
63             It must be a valid group name, which exist on the system.
64           </para>
65         </listitem>
66       </varlistentry>
67       <varlistentry>
68         <term><emphasis role="bold">encrypted password</emphasis></term>
69         <listitem>
70           <para>
71             Refer to <citerefentry><refentrytitle>crypt</refentrytitle>
72             <manvolnum>3</manvolnum></citerefentry> for details on how
73             this string is interpreted.
74           </para>
75           <para>
76             If the password field contains some string that is not a valid
77             result of <citerefentry><refentrytitle>crypt</refentrytitle>
78             <manvolnum>3</manvolnum></citerefentry>, for instance ! or *,
79             users will not be able to use a unix password to access the
80             group (but group members do not need the password).
81           </para>
82           <para>
83             The password is used when an user who is not a member of the
84             group wants to gain the permissions of this group (see
85             <citerefentry><refentrytitle>newgrp</refentrytitle>
86             <manvolnum>1</manvolnum></citerefentry>).
87           </para>
88           <para>
89             This field may be empty, in which case only the group members
90             can gain the group permissions.
91           </para>
92           <para>
93             A password field which starts with a exclamation mark means
94             that the password is locked.  The remaining characters on the
95             line represent the password field before the password was
96             locked.
97           </para>
98           <para>
99             This password supersedes any password specified in
100             <filename>/etc/group</filename>.
101           </para>
102
103         </listitem>
104       </varlistentry>
105       <varlistentry>
106         <term><emphasis role="bold">administrators</emphasis></term>
107         <listitem>
108           <para>
109             It must be a comma-separated list of user names.
110           </para>
111           <para>
112             Administrators can change the password or the members of the
113             group.
114           </para>
115           <para>
116             Administrators also have the same permissions as the members
117             (see below).
118           </para>
119         </listitem>
120       </varlistentry>
121       <varlistentry>
122         <term><emphasis role="bold">members</emphasis></term>
123         <listitem>
124           <para>
125             It must be a comma-separated list of user names.
126           </para>
127           <para>
128             Members can access the group without being prompted for a
129             password.
130           </para>
131           <para>
132             You should use the same list of users as in
133             <filename>/etc/group</filename>.
134           </para>
135         </listitem>
136       </varlistentry>
137     </variablelist>
138   </refsect1>
139
140   <refsect1 id='files'>
141     <title>FILES</title>
142     <variablelist>
143       <varlistentry>
144         <term><filename>/etc/group</filename></term>
145         <listitem>
146           <para>Group account information.</para>
147         </listitem>
148       </varlistentry>
149       <varlistentry>
150         <term><filename>/etc/gshadow</filename></term>
151         <listitem>
152           <para>Secure group account information.</para>
153         </listitem>
154       </varlistentry>
155     </variablelist>
156   </refsect1>
157
158   <refsect1 id='see_also'>
159     <title>SEE ALSO</title>
160     <para>
161       <citerefentry>
162         <refentrytitle>gpasswd</refentrytitle><manvolnum>5</manvolnum>
163       </citerefentry>,
164       <citerefentry>
165         <refentrytitle>group</refentrytitle><manvolnum>5</manvolnum>
166       </citerefentry>,
167       <citerefentry>
168         <refentrytitle>grpck</refentrytitle><manvolnum>8</manvolnum>
169       </citerefentry>,
170       <citerefentry>
171         <refentrytitle>grpconv</refentrytitle><manvolnum>8</manvolnum>
172       </citerefentry>,
173       <citerefentry>
174         <refentrytitle>newgrp</refentrytitle><manvolnum>1</manvolnum>
175       </citerefentry>.
176     </para>
177   </refsect1>
178 </refentry>