Document the options with a list of options, as in the pwck(8) manpage.

This commit is contained in:
nekral-guest 2008-01-22 20:56:13 +00:00
parent ae8cbbc34d
commit 03e5a3a181
2 changed files with 37 additions and 8 deletions

View File

@ -1,3 +1,8 @@
2008-01-22 Nicolas François <nicolas.francois@centraliens.net>
* man/grpck.8.xml: Document the options with a list of options,
as in the pwck(8) manpage.
2008-01-22 Nicolas François <nicolas.francois@centraliens.net>
* NEWS, src/newgrp.c: Fix segfault when an user returns to an

View File

@ -23,6 +23,13 @@
<arg choice='plain'><replaceable>shadow</replaceable></arg>
</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>grpck</command> <arg choice='opt'>-s </arg>
<arg choice='opt'>
<arg choice='plain'><replaceable>group</replaceable></arg>
<arg choice='plain'><replaceable>shadow</replaceable></arg>
</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id='description'>
@ -71,19 +78,36 @@
<refsect1 id='options'>
<title>OPTIONS</title>
<para>
The options which apply to the <command>grpck</command> command are:
</para>
<variablelist remap='IP'>
<varlistentry>
<term><option>-r</option></term>
<listitem>
<para>
Execute the <command>grpck</command> command in read-only mode.
This causes all questions regarding changes to be answered
<emphasis>no</emphasis> without user intervention.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-s</option></term>
<listitem>
<para>
Sort entries in <filename>/etc/group</filename> and
<filename>/etc/gshadow</filename> by GID.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
By default, <command>grpck</command> operates on the files
<filename>/etc/group</filename> and <filename>/etc/gshadow</filename>.
The user may select alternate files with the <emphasis
remap='I'>group</emphasis> and <emphasis remap='I'>shadow</emphasis>
parameters. Additionally, the user may execute the command in
read-only mode by specifying the <option>-r</option> flag. This causes
all questions regarding changes to be answered <emphasis>no</emphasis>
without user intervention. <command>grpck</command> can also sort
entries in <filename>/etc/group</filename> and
<filename>/etc/gshadow</filename> by GID. To run it in sort mode pass
it <option>-s</option> flag. No checks are performed then, it just
sorts.
parameters.
</para>
</refsect1>