shadow/man/groupmod.8.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
		"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
<refentry id='groupmod.8'>
  <!-- $Id: groupmod.8.xml,v 1.5 2005/04/27 16:44:12 kloczek Exp $ -->
  <refmeta>
    <refentrytitle>groupmod</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>
  <refnamediv id='name'>
    <refname>groupmod</refname>
    <refpurpose>modify a group</refpurpose>
  </refnamediv>
  <!-- body begins here -->
  <refsynopsisdiv id='synopsis'>
    <cmdsynopsis>
      <command>groupmod</command>    
      <arg choice='opt'>
        <arg choice='plain'>-g <replaceable>gid</replaceable></arg>
        <arg choice='opt'>-o </arg>
      </arg>
      <arg choice='opt'>-n <replaceable>new_group_name</replaceable></arg>
      <arg choice='plain'><replaceable>group</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  
  <refsect1 id='description'>
    <title>DESCRIPTION</title>
    <para>
      The <command>groupmod</command> command modifies the system account
      files to reflect the changes that are specified on the command line.
    </para>
  </refsect1>
  
  <refsect1 id='options'>
    <title>OPTIONS</title>
    <para>
      The options which apply to the <command>groupmod</command> command
      are:
    </para>
    <variablelist remap='IP'>
      <varlistentry>
        <term>
          <option>-g</option> <replaceable>gid</replaceable>
        </term>
        <listitem>
          <para>The numerical value of the group's ID. This value must be
            unique, unless the <option>-o</option> option is used. The value
            must be non-negative. Values between 0 and 999 are typically
            reserved for system groups. Any files which the old group ID is
            the file group ID must have the file group ID changed manually.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-n</option> <replaceable>new_group_name</replaceable></term>
        <listitem>
          <para> The name of the group will be changed from <emphasis
            remap='I'>group</emphasis> to <emphasis
            remap='I'>new_group_name</emphasis>.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  
  <refsect1 id='files'>
    <title>FILES</title>
    <variablelist>
      <varlistentry>
        <term><filename>/etc/group</filename></term>
        <listitem>group account information</listitem>
      </varlistentry>
      <varlistentry>
        <term><filename>/etc/gshadow</filename></term>
        <listitem>secure group account information</listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  
  <refsect1 id='exit_values'>
    <title>EXIT VALUES</title>
    <variablelist remap='TP'>
      <varlistentry>
        <term>
          The <command>groupmod</command> command exits with the
          following values:
        </term>
        <listitem>
          <!-- .br -->
          <para>
            <literal>0</literal>	- success
            <!-- .br -->
            <literal>2</literal>	- bad command syntax
            <!-- .br -->
            <literal>3</literal>	- invalid argument to option
            <!-- .br -->
            <literal>4</literal>	- gid already in use (and no -o)
            <!-- .br -->
            <literal>6</literal>	- specified group doesn't exist
            <!-- .br -->
            <literal>9</literal>	- group name already in use
            <!-- .br -->
            <literal>10</literal>	- can't update group file
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  
  <refsect1 id='see_also'>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>chfn</refentrytitle><manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>chsh</refentrytitle><manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>passwd</refentrytitle><manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>groupadd</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>groupdel</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>useradd</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>userdel</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>usermod</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>
    </para>
  </refsect1>
  
  <refsect1 id='author'>
    <title>AUTHOR</title>
    <para>Julianne Frances Haugh (jockgrrl@ix.netcom.com)</para>
  </refsect1>
</refentry>