man-pages/man8/groupmod.8.html
2021-03-31 01:06:50 +01:00

321 lines
6.4 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of GROUPMOD</TITLE>
</HEAD><BODY>
<H1>GROUPMOD</H1>
Section: System Management Commands (8)<BR>Updated: 05/28/2020<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
groupmod - modify a group definition on the system
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<DL COMPACT>
<DT id="1">
<B>groupmod</B> [<I>options</I>] <I>GROUP</I>
</DL>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
<DD>The
<B>groupmod</B>
command modifies the definition of the specified
<I>GROUP</I>
by modifying the appropriate entry in the group database.
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<P>
The options which apply to the
<B>groupmod</B>
command are:
<P>
<B>-g</B>, <B>--gid</B>&nbsp;<I>GID</I>
<DL COMPACT><DT id="2"><DD>
The group ID of the given
<I>GROUP</I>
will be changed to
<I>GID</I>.
<P>
The value of
<I>GID</I>
must be a non-negative decimal integer. This value must be unique, unless the
<B>-o</B>
option is used.
<P>
Users who use the group as primary group will be updated to keep the group as their primary group.
<P>
Any files that have the old group ID and must continue to belong to
<I>GROUP</I>, must have their group ID changed manually.
<P>
No checks will be performed with regard to the
<B>GID_MIN</B>,
<B>GID_MAX</B>,
<B>SYS_GID_MIN</B>, or
<B>SYS_GID_MAX</B>
from
/etc/login.defs.
</DL>
<P>
<B>-h</B>, <B>--help</B>
<DL COMPACT><DT id="3"><DD>
Display help message and exit.
</DL>
<P>
<B>-n</B>, <B>--new-name</B>&nbsp;<I>NEW_GROUP</I>
<DL COMPACT><DT id="4"><DD>
The name of the group will be changed from
<I>GROUP</I>
to
<I>NEW_GROUP</I>
name.
</DL>
<P>
<B>-o</B>, <B>--non-unique</B>
<DL COMPACT><DT id="5"><DD>
When used with the
<B>-g</B>
option, allow to change the group
<I>GID</I>
to a non-unique value.
</DL>
<P>
<B>-p</B>, <B>--password</B>&nbsp;<I>PASSWORD</I>
<DL COMPACT><DT id="6"><DD>
The encrypted password, as returned by
<B><A HREF="/cgi-bin/man/man2html?3+crypt">crypt</A></B>(3).
<P>
<B>Note:</B>
This option is not recommended because the password (or encrypted password) will be visible by users listing the processes.
<P>
You should make sure the password respects the system's password policy.
</DL>
<P>
<B>-R</B>, <B>--root</B>&nbsp;<I>CHROOT_DIR</I>
<DL COMPACT><DT id="7"><DD>
Apply changes in the
<I>CHROOT_DIR</I>
directory and use the configuration files from the
<I>CHROOT_DIR</I>
directory.
</DL>
<P>
<B>-P</B>, <B>--prefix</B>&nbsp;<I>PREFIX_DIR</I>
<DL COMPACT><DT id="8"><DD>
Apply changes in the
<I>PREFIX_DIR</I>
directory and use the configuration files from the
<I>PREFIX_DIR</I>
directory. This option does not chroot and is intended for preparing a cross-compilation target. Some limitations: NIS and LDAP users/groups are not verified. PAM authentication is using the host files. No SELINUX support.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>CONFIGURATION</H2>
<P>
The following configuration variables in
/etc/login.defs
change the behavior of this tool:
<P>
<B>MAX_MEMBERS_PER_GROUP</B> (number)
<DL COMPACT><DT id="9"><DD>
Maximum members per group entry. When the maximum is reached, a new group entry (line) is started in
/etc/group
(with the same name, same password, and same GID).
<P>
The default value is 0, meaning that there are no limits in the number of members in a group.
<P>
This feature (split group) permits to limit the length of lines in the group file. This is useful to make sure that lines for NIS groups are not larger than 1024 characters.
<P>
If you need to enforce such limit, you can use 25.
<P>
Note: split groups may not be supported by all tools (even in the Shadow toolsuite). You should not use this variable unless you really need it.
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>FILES</H2>
<P>
/etc/group
<DL COMPACT><DT id="10"><DD>
Group account information.
</DL>
<P>
/etc/gshadow
<DL COMPACT><DT id="11"><DD>
Secure group account information.
</DL>
<P>
/etc/login.defs
<DL COMPACT><DT id="12"><DD>
Shadow password suite configuration.
</DL>
<P>
/etc/passwd
<DL COMPACT><DT id="13"><DD>
User account information.
</DL>
<A NAME="lbAH">&nbsp;</A>
<H2>EXIT VALUES</H2>
<P>
The
<B>groupmod</B>
command exits with the following values:
<P>
<I>0</I>
<DL COMPACT><DT id="14"><DD>
E_SUCCESS: success
</DL>
<P>
<I>2</I>
<DL COMPACT><DT id="15"><DD>
E_USAGE: invalid command syntax
</DL>
<P>
<I>3</I>
<DL COMPACT><DT id="16"><DD>
E_BAD_ARG: invalid argument to option
</DL>
<P>
<I>4</I>
<DL COMPACT><DT id="17"><DD>
E_GID_IN_USE: specified group doesn't exist
</DL>
<P>
<I>6</I>
<DL COMPACT><DT id="18"><DD>
E_NOTFOUND: specified group doesn't exist
</DL>
<P>
<I>9</I>
<DL COMPACT><DT id="19"><DD>
E_NAME_IN_USE: group name already in use
</DL>
<P>
<I>10</I>
<DL COMPACT><DT id="20"><DD>
E_GRP_UPDATE: can't update group file
</DL>
<P>
<I>11</I>
<DL COMPACT><DT id="21"><DD>
E_CLEANUP_SERVICE: can't setup cleanup service
</DL>
<P>
<I>12</I>
<DL COMPACT><DT id="22"><DD>
E_PAM_USERNAME: can't determine your username for use with pam
</DL>
<P>
<I>13</I>
<DL COMPACT><DT id="23"><DD>
E_PAM_ERROR: pam returned an error, see syslog facility id groupmod for the PAM error message
</DL>
<A NAME="lbAI">&nbsp;</A>
<H2>SEE ALSO</H2>
<P>
<B><A HREF="/cgi-bin/man/man2html?1+chfn">chfn</A></B>(1),
<B><A HREF="/cgi-bin/man/man2html?1+chsh">chsh</A></B>(1),
<B><A HREF="/cgi-bin/man/man2html?1+passwd">passwd</A></B>(1),
<B><A HREF="/cgi-bin/man/man2html?8+gpasswd">gpasswd</A></B>(8),
<B><A HREF="/cgi-bin/man/man2html?8+groupadd">groupadd</A></B>(8),
<B><A HREF="/cgi-bin/man/man2html?8+groupdel">groupdel</A></B>(8),
<B><A HREF="/cgi-bin/man/man2html?5+login.defs">login.defs</A></B>(5),
<B><A HREF="/cgi-bin/man/man2html?8+useradd">useradd</A></B>(8),
<B><A HREF="/cgi-bin/man/man2html?8+userdel">userdel</A></B>(8),
<B><A HREF="/cgi-bin/man/man2html?8+usermod">usermod</A></B>(8).
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="24"><A HREF="#lbAB">NAME</A><DD>
<DT id="25"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="26"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="27"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="28"><A HREF="#lbAF">CONFIGURATION</A><DD>
<DT id="29"><A HREF="#lbAG">FILES</A><DD>
<DT id="30"><A HREF="#lbAH">EXIT VALUES</A><DD>
<DT id="31"><A HREF="#lbAI">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:06:12 GMT, March 31, 2021
</BODY>
</HTML>