shadow/man/groupmems.8.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY MAX_MEMBERS_PER_GROUP SYSTEM "login.defs.d/MAX_MEMBERS_PER_GROUP.xml">
]>
<refentry id='groupmems.8'>
  <!-- $Id$ -->
  <refmeta>
    <refentrytitle>groupmems</refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo class="sectdesc">System Management Commands</refmiscinfo>
  </refmeta>
  <refnamediv id='name'>
    <refname>groupmems</refname>
    <refpurpose>administer members of a user's primary group</refpurpose>
  </refnamediv>

  <refsynopsisdiv id='synopsis'>
    <cmdsynopsis>
      <command>groupmems</command>
      <group choice='plain'>
	<arg choice='plain'>-a <replaceable>user_name</replaceable></arg>
	<arg choice='plain'>-d <replaceable>user_name</replaceable></arg>
	<arg choice='opt'>-g <replaceable>group_name</replaceable></arg>
	<arg choice='plain'>-l </arg><arg choice='plain'>-p </arg>
      </group>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id='description'>
    <title>DESCRIPTION</title>
    <para>
      The <command>groupmems</command> command allows a user to administer
      his/her own group membership list without the requirement of
      superuser privileges. The <command>groupmems</command> utility is for
      systems that configure its users to be in their own name sake primary
      group (i.e., guest / guest).
    </para>

    <para>Only the superuser, as administrator, can use
      <command>groupmems</command> to alter the memberships of other groups.
    </para>
  </refsect1>

  <refsect1 id='options'>
    <title>OPTIONS</title>
    <para>
      The options which apply to the <command>groupmems</command> command
      are:
    </para>
    <variablelist remap='IP'>
      <varlistentry>
	<term><option>-a</option> <replaceable>user_name</replaceable></term>
	<listitem>
	  <para>Add a new user to the group membership list.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>-d</option> <replaceable>user_name</replaceable></term>
	<listitem>
	  <para>Delete a user from the group membership list.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>-g</option> <replaceable>group_name</replaceable></term>
	<listitem>
	  <para>The superuser can specify which group membership
	    list to modify.
	  </para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>-l</option></term>
	<listitem>
	  <para>List the group membership list.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>-p</option></term>
	<listitem>
	  <para>Purge all users from the group membership list.</para>
	</listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1 id='setup'>
    <title>SETUP</title>
    <para>
      The <command>groupmems</command> executable should be in mode
      <literal>2770</literal> as user <emphasis>root</emphasis> and in group
      <emphasis>groups</emphasis>. The system administrator can add users to
      group <emphasis>groups</emphasis> to allow or disallow them using the
      <command>groupmems</command> utility to manage their own group
      membership list.
    </para>

    <programlisting>
	$ groupadd -r groups
	$ chmod 2770 groupmems
	$ chown root.groups groupmems
	$ groupmems -g groups -a gk4
    </programlisting>
  </refsect1>

  <refsect1 id='configuration'>
    <title>CONFIGURATION</title>
    <para>
      The following configuration variables in
      <filename>/etc/login.defs</filename> change the behavior of this
      tool:
    </para>
    <variablelist>
      &MAX_MEMBERS_PER_GROUP;
    </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 condition="gshadow">
	<term><filename>/etc/gshadow</filename></term>
	<listitem>
	  <para>secure group account information</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>
</refentry>