shadow/man/vipw.8.xml

<?xml version="1.0" encoding="UTF-8"?>
<refentry id='vipw.8'>
  <!--  $Id: vipw.8.xml,v 1.20 2006/10/28 12:29:04 kloczek Exp $  -->
  <refmeta>
    <refentrytitle>vipw</refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo class="sectdesc">System Management Commands</refmiscinfo>
  </refmeta>
  <refnamediv id='name'>
    <refname>vipw</refname>
    <refname>vigr</refname>
    <refpurpose>
      edit the password, group, shadow-password or shadow-group file
    </refpurpose>
  </refnamediv>

  <refsynopsisdiv id='synopsis'>
    <cmdsynopsis>
      <command>vipw</command>
      <arg choice='opt'>
	<replaceable>options</replaceable>                                                                                           
      </arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>vigr</command>
      <arg choice='opt'>
	<replaceable>options</replaceable>                                                                                           
      </arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id='description'>
    <title>DESCRIPTION</title>
    <para>
      The <command>vipw</command> and <command>vigr</command> commands edits
      the files <filename>/etc/passwd</filename> and
      <filename>/etc/group</filename>, respectively. With the
      <option>-s</option> flag, they will edit the shadow versions of those
      files, <filename>/etc/shadow</filename> and
      <filename>/etc/gshadow</filename>, respectively. The programs will set
      the appropriate locks to prevent file corruption. When looking for an
      editor, the programs will first try the environment variable
      <envar>$VISUAL</envar>, then the environment variable
      <envar>$EDITOR</envar>, and finally the default editor,
      <citerefentry><refentrytitle>vi</refentrytitle>
      <manvolnum>1</manvolnum></citerefentry>.
    </para>
  </refsect1>

  <refsect1 id='options'>
    <title>OPTIONS</title>
    <para>
      The options which apply to the <command>vipw</command> and
      <command>vigr</command> commands are:
    </para>
    <variablelist remap='IP'>
      <varlistentry>
	<term><option>-g</option>, <option>--group</option></term>
	<listitem>
	  <para>Edit group database.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>-h</option>, <option>--help</option></term>
	<listitem>
	  <para>Display help message and exit.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>-p</option>, <option>--passwd</option></term>
	<listitem>
	  <para>Edit passwd database.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>-q</option>, <option>--quiet</option></term>
	<listitem>
	  <para>Quiet mode.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>-s</option>, <option>--shadow</option></term>
	<listitem>
	  <para>Edit shadow or gshadow database.</para>
	</listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1 id='files'>
    <title>FILES</title>
    <variablelist>
      <varlistentry>
	<term><filename>/etc/group</filename></term>
	<listitem>
	  <para>Group account information.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><filename>/etc/gshadow</filename></term>
	<listitem>
	  <para>Secure group account information.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><filename>/etc/passwd</filename></term>
	<listitem>
	  <para>User account information.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><filename>/etc/shadow</filename></term>
	<listitem>
	  <para>Secure user account information.</para>
	</listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1 id='see_also'>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
	<refentrytitle>vi</refentrytitle><manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
	<refentrytitle>group</refentrytitle><manvolnum>5</manvolnum>
      </citerefentry>,
      <citerefentry>
	<refentrytitle>gshadow</refentrytitle><manvolnum>5</manvolnum>
      </citerefentry>
      <citerefentry>
	<refentrytitle>passwd</refentrytitle><manvolnum>5</manvolnum>
      </citerefentry>,
      <citerefentry>
	<refentrytitle>shadow</refentrytitle><manvolnum>5</manvolnum>
      </citerefentry>.
    </para>
  </refsect1>
</refentry>