shadow/man/groupadd.8.xml

151 lines
4.8 KiB
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='groupadd.8'>
<!-- $Id: groupadd.8.xml,v 1.5 2005/04/27 16:44:12 kloczek Exp $ -->
<refmeta>
<refentrytitle>groupadd</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv id='name'>
<refname>groupadd</refname>
<refpurpose>Create a new group</refpurpose>
</refnamediv>
<!-- body begins here -->
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
<command>groupadd</command>
<arg choice='opt'>
<arg choice='plain'>-g <replaceable>gid</replaceable></arg>
<arg choice='opt'>-o </arg>
</arg>
<arg choice='opt'>-f </arg>
<arg choice='plain'>
<replaceable>group</replaceable>
</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id='description'>
<title>DESCRIPTION</title>
<para>The <command>groupadd</command> command creates a new group
account using the values specified on the command line and the default
values from the system. The new group will be entered into the system
files as needed.
</para>
</refsect1>
<refsect1 id='options'>
<title>OPTIONS</title>
<para>
The options which apply to the <command>groupadd</command> command
are:
</para>
<variablelist remap='IP'>
<varlistentry>
<term>
<option>-f</option>
</term>
<listitem>
<para>This option causes to just exit with success status if the
specified group already exists. With <option>-g</option>, if
specified gid already exists, other (unique) gid is chosen (i.e.
<option>-g</option> is turned off).
</para>
</listitem>
</varlistentry>
<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. The default is to use the smallest ID
value greater than 999 and greater than every other group.
Values between 0 and 999 are typically reserved for system
accounts.
</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>groupadd</command> command exits with the
following values:
</term>
<listitem>
<!-- .br -->
<para>
<literal>0</literal> - success
<!-- .br -->
<literal>2</literal> - invalid command syntax
<!-- .br -->
<literal>3</literal> - invalid argument to option
<!-- .br -->
<literal>4</literal> - gid not unique (when -o not
used) <!-- .br -->
<literal>9</literal> - group name not unique
<!-- .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>groupdel</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>groupmod</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>