Document all gpasswd.1 options separately. This clarify the gpasswd.1

manpages (reported in debian bug #445480).
This commit is contained in:
nekral-guest 2007-10-27 14:00:31 +00:00
parent 3ada732dc0
commit 93acdeb8ff
2 changed files with 101 additions and 42 deletions

View File

@ -1,3 +1,8 @@
2007-10-27 Nicolas François <nicolas.francois@centraliens.net>
* man/gpasswd.1.xml: Describe the options separately in the
OPTIONS section. Simplify the synopsis.
2007-10-27 Nicolas François <nicolas.francois@centraliens.net> 2007-10-27 Nicolas François <nicolas.francois@centraliens.net>
* README, po/Makevars: Update contact information. * README, po/Makevars: Update contact information.

View File

@ -14,34 +14,13 @@
<refsynopsisdiv id='synopsis'> <refsynopsisdiv id='synopsis'>
<cmdsynopsis> <cmdsynopsis>
<command>gpasswd</command> <command>gpasswd</command>
<arg choice='opt'>
<replaceable>option</replaceable>
</arg>
<arg choice='plain'> <arg choice='plain'>
<replaceable>group</replaceable> <replaceable>group</replaceable>
</arg> </arg>
</cmdsynopsis> </cmdsynopsis>
<cmdsynopsis>
<command>gpasswd</command>
<arg choice='plain'>-a <replaceable>user</replaceable></arg>
<arg choice='plain'><replaceable>group</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>gpasswd</command>
<arg choice='plain'>-d <replaceable>user</replaceable></arg>
<arg choice='plain'><replaceable>group</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>gpasswd</command>
<arg choice='plain'>-R <replaceable>group</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>gpasswd</command>
<arg choice='plain'>-r <replaceable>group</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>gpasswd</command>
<arg choice='opt' rep='repeat'>-A <replaceable>user,</replaceable></arg>
<arg choice='opt' rep='repeat'>-M <replaceable>user,</replaceable></arg>
<arg choice='plain'><replaceable>group</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
<refsect1 id='description'> <refsect1 id='description'>
@ -51,10 +30,18 @@
<filename>/etc/group</filename> file (and <filename>/etc/group</filename> file (and
<filename>/etc/gshadow</filename> file if compiled with SHADOWGRP <filename>/etc/gshadow</filename> file if compiled with SHADOWGRP
defined). Every group can have administrators, members and a password. defined). Every group can have administrators, members and a password.
System administrator can use <option>-A</option> option to define System administrator can use the <option>-A</option> option to define
group administrator(s) and <option>-M</option> option to define group administrator(s) and the <option>-M</option> option to define
members and has all rights of group administrators and members. members and has all rights of group administrators and members.
</para> </para>
<para>
<command>gpasswd</command> called by a group administrator with a group
name only prompts for the group password. If a password is set the
members can still <citerefentry>
<refentrytitle>newgrp</refentrytitle><manvolnum>1</manvolnum>
</citerefentry> without a password, and non-members must supply the
password.
</para>
<refsect2 id='notes_about_group_passwords'> <refsect2 id='notes_about_group_passwords'>
<title>Notes about group passwords</title> <title>Notes about group passwords</title>
@ -70,23 +57,90 @@
<refsect1 id='options'> <refsect1 id='options'>
<title>OPTIONS</title> <title>OPTIONS</title>
<para> <para>
Group administrator can add and delete users using <option>-a</option> Except for the <option>-A</option> and <option>-M</option> options,
and <option>-d</option> options respectively. Administrators can use the options cannot be combined.
<option>-r</option> option to remove group password. When no password The options which apply to the <command>gpasswd</command> command are:
is set only group members can use <command>newgrp</command> to join
the group. Option <option>-R</option> disables access via a password
to the group through <command>newgrp</command> command (however
members will still be able to switch to this group).
</para>
<para>
<command>gpasswd</command> called by a group administrator with group
name only prompts for the group password. If password is set the
members can still <citerefentry>
<refentrytitle>newgrp</refentrytitle><manvolnum>1</manvolnum>
</citerefentry> without a password, non-members must supply the
password.
</para> </para>
<variablelist remap='IP'>
<varlistentry>
<term>
<option>-a</option> <replaceable>user</replaceable>
</term>
<listitem>
<para>
Add the <replaceable>user</replaceable> to the named
<replaceable>group</replaceable>.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist remap='IP'>
<varlistentry>
<term>
<option>-d</option> <replaceable>user</replaceable>
</term>
<listitem>
<para>
Remove the <replaceable>user</replaceable> from the named
<replaceable>group</replaceable>.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist remap='IP'>
<varlistentry>
<term>
<option>-r</option>
</term>
<listitem>
<para>
Remove the password from the named <replaceable>group</replaceable>.
Only group members will be allowed to use
<command>newgrp</command> to join the named
<replaceable>group</replaceable>.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist remap='IP'>
<varlistentry>
<term>
<option>-R</option>
</term>
<listitem>
<para>
Restrict the access to the named <replaceable>group</replaceable>.
Only group members will be allowed to use
<command>newgrp</command> to join the named
<replaceable>group</replaceable>.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist remap='IP'>
<varlistentry>
<term>
<option>-A</option> <replaceable>user</replaceable>,...
</term>
<listitem>
<para>
Set the list of administrative users.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist remap='IP'>
<varlistentry>
<term>
<option>-M</option> <replaceable>user</replaceable>,...
</term>
<listitem>
<para>
Set the list of group members.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1> </refsect1>
<refsect1 id='files'> <refsect1 id='files'>