man/groupdel.8.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3    Copyright (c) 1991 - 1993, Julianne Frances Haugh
   4    Copyright (c) 2007 - 2008, Nicolas François
   5    All rights reserved.
   6
   7    Redistribution and use in source and binary forms, with or without
   8    modification, are permitted provided that the following conditions
   9    are met:
  10    1. Redistributions of source code must retain the above copyright
  11       notice, this list of conditions and the following disclaimer.
  12    2. Redistributions in binary form must reproduce the above copyright
  13       notice, this list of conditions and the following disclaimer in the
  14       documentation and/or other materials provided with the distribution.
  15    3. The name of the copyright holders or contributors may not be used to
  16       endorse or promote products derived from this software without
  17       specific prior written permission.
  18
  19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  22    PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
  23    HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30 -->
  31 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.5//EN"
  32   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  33 <!ENTITY MAX_MEMBERS_PER_GROUP SYSTEM "login.defs.d/MAX_MEMBERS_PER_GROUP.xml">
  34 ]>
  35 <refentry id='groupdel.8'>
  36   <!-- $Id: groupdel.8.xml 2947 2009-05-19 20:31:45Z nekral-guest $ -->
  37   <refmeta>
  38     <refentrytitle>groupdel</refentrytitle>
  39     <manvolnum>8</manvolnum>
  40     <refmiscinfo class="sectdesc">System Management Commands</refmiscinfo>
  41   </refmeta>
  42   <refnamediv id='name'>
  43     <refname>groupdel</refname>
  44     <refpurpose>delete a group</refpurpose>
  45   </refnamediv>
  46   <!-- body begins here -->
  47   <refsynopsisdiv id='synopsis'>
  48     <cmdsynopsis>
  49       <command>groupdel</command>
  50       <arg choice='plain'>
  51         <replaceable>group</replaceable>
  52       </arg>
  53     </cmdsynopsis>
  54   </refsynopsisdiv>
  55
  56   <refsect1 id='description'>
  57     <title>DESCRIPTION</title>
  58     <para> The <command>groupdel</command> command modifies the system
  59       account files, deleting all entries that refer to <emphasis
  60       remap='I'>group</emphasis>. The named group must exist.
  61     </para>
  62   </refsect1>
  63
  64   <refsect1 id='caveats'>
  65     <title>CAVEATS</title>
  66     <para>
  67       You may not remove the primary group of any existing user. You
  68       must remove the user before you remove the group.
  69     </para>
  70     <para>
  71       You should manually check all file systems to ensure that no files
  72       remain owned by this group.
  73     </para>
  74   </refsect1>
  75
  76   <refsect1 id='configuration'>
  77     <title>CONFIGURATION</title>
  78     <para>
  79       The following configuration variables in
  80       <filename>/etc/login.defs</filename> change the behavior of this
  81       tool:
  82     </para>
  83     <variablelist>
  84       &MAX_MEMBERS_PER_GROUP;
  85     </variablelist>
  86   </refsect1>
  87
  88   <refsect1 id='files'>
  89     <title>FILES</title>
  90     <variablelist>
  91       <varlistentry>
  92         <term><filename>/etc/group</filename></term>
  93         <listitem>
  94           <para>Group account information.</para>
  95         </listitem>
  96       </varlistentry>
  97       <varlistentry condition="gshadow">
  98         <term><filename>/etc/gshadow</filename></term>
  99         <listitem>
 100           <para>Secure group account information.</para>
 101         </listitem>
 102       </varlistentry>
 103     </variablelist>
 104   </refsect1>
 105
 106   <refsect1 id='exit_values'>
 107     <title>EXIT VALUES</title>
 108     <para>
 109       The <command>groupdel</command> command exits with the following values:
 110       <variablelist>
 111         <varlistentry>
 112           <term><replaceable>0</replaceable></term>
 113           <listitem>
 114             <para>success</para>
 115           </listitem>
 116         </varlistentry>
 117         <varlistentry>
 118           <term><replaceable>2</replaceable></term>
 119           <listitem>
 120             <para>invalid command syntax</para>
 121           </listitem>
 122         </varlistentry>
 123         <varlistentry>
 124           <term><replaceable>6</replaceable></term>
 125           <listitem>
 126             <para>specified group doesn't exist</para>
 127           </listitem>
 128         </varlistentry>
 129         <varlistentry>
 130           <term><replaceable>8</replaceable></term>
 131           <listitem>
 132             <para>can't remove user's primary group</para>
 133           </listitem>
 134         </varlistentry>
 135         <varlistentry>
 136           <term><replaceable>10</replaceable></term>
 137           <listitem>
 138             <para>can't update group file</para>
 139           </listitem>
 140         </varlistentry>
 141       </variablelist>
 142     </para>
 143   </refsect1>
 144
 145   <refsect1 id='see_also'>
 146     <title>SEE ALSO</title>
 147     <para><citerefentry>
 148         <refentrytitle>chfn</refentrytitle><manvolnum>1</manvolnum>
 149       </citerefentry>,
 150       <citerefentry>
 151         <refentrytitle>chsh</refentrytitle><manvolnum>1</manvolnum>
 152       </citerefentry>,
 153       <citerefentry>
 154         <refentrytitle>passwd</refentrytitle><manvolnum>1</manvolnum>
 155       </citerefentry>,
 156       <citerefentry>
 157         <refentrytitle>gpasswd</refentrytitle><manvolnum>8</manvolnum>
 158       </citerefentry>,
 159       <citerefentry>
 160         <refentrytitle>groupadd</refentrytitle><manvolnum>8</manvolnum>
 161       </citerefentry>,
 162       <citerefentry>
 163         <refentrytitle>groupmod</refentrytitle><manvolnum>8</manvolnum>
 164       </citerefentry>,
 165       <citerefentry>
 166         <refentrytitle>useradd</refentrytitle><manvolnum>8</manvolnum>
 167       </citerefentry>,
 168       <citerefentry>
 169         <refentrytitle>userdel</refentrytitle><manvolnum>8</manvolnum>
 170       </citerefentry>,
 171       <citerefentry>
 172         <refentrytitle>usermod</refentrytitle><manvolnum>8</manvolnum>
 173       </citerefentry>
 174     </para>
 175   </refsect1>
 176 </refentry>