man/groupmod.8

   1 '\" t
   2 .\"     Title: groupmod
   3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
   5 .\"      Date: 02/16/2011
   6 .\"    Manual: System Management Commands
   7 .\"    Source: System Management Commands
   8 .\"  Language: English
   9 .\"
  10 .TH "GROUPMOD" "8" "02/16/2011" "System Management Commands" "System Management Commands"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 groupmod \- modify a group definition on the system
  32 .SH "SYNOPSIS"
  33 .HP \w'\fBgroupmod\fR\ 'u
  34 \fBgroupmod\fR [\fIoptions\fR] \fIGROUP\fR
  35 .SH "DESCRIPTION"
  36 .PP
  37 The
  38 \fBgroupmod\fR
  39 command modifies the definition of the specified
  40 \fIGROUP\fR
  41 by modifying the appropriate entry in the group database\&.
  42 .SH "OPTIONS"
  43 .PP
  44 The options which apply to the
  45 \fBgroupmod\fR
  46 command are:
  47 .PP
  48 \fB\-g\fR, \fB\-\-gid\fR \fIGID\fR
  49 .RS 4
  50 The group ID of the given
  51 \fIGROUP\fR
  52 will be changed to
  53 \fIGID\fR\&.
  54 .sp
  55 The value of
  56 \fIGID\fR
  57 must be a non\-negative decimal integer\&. This value must be unique, unless the
  58 \fB\-o\fR
  59 option is used\&. Values between 0 and 999 are typically reserved for system groups\&.
  60 .sp
  61 Any files that have the old group ID and must continue to belong to
  62 \fIGROUP\fR, must have their group ID changed manually\&.
  63 .RE
  64 .PP
  65 \fB\-h\fR, \fB\-\-help\fR
  66 .RS 4
  67 Display help message and exit\&.
  68 .RE
  69 .PP
  70 \fB\-n\fR, \fB\-\-new\-name\fR \fINEW_GROUP\fR
  71 .RS 4
  72 The name of the group will be changed from
  73 \fIGROUP\fR
  74 to
  75 \fINEW_GROUP\fR
  76 name\&.
  77 .RE
  78 .PP
  79 \fB\-o\fR, \fB\-\-non\-unique\fR
  80 .RS 4
  81 When used with the
  82 \fB\-g\fR
  83 option, allow to change the group
  84 \fIGID\fR
  85 to a non\-unique value\&.
  86 .RE
  87 .PP
  88 \fB\-p\fR, \fB\-\-password\fR \fIPASSWORD\fR
  89 .RS 4
  90 The encrypted password, as returned by
  91 \fBcrypt\fR(3)\&.
  92 .sp
  93
  94 \fBNote:\fR
  95 This option is not recommended because the password (or encrypted password) will be visible by users listing the processes\&.
  96 .sp
  97 You should make sure the password respects the system\*(Aqs password policy\&.
  98 .RE
  99 .SH "CONFIGURATION"
 100 .PP
 101 The following configuration variables in
 102 /etc/login\&.defs
 103 change the behavior of this tool:
 104 .PP
 105 \fBMAX_MEMBERS_PER_GROUP\fR (number)
 106 .RS 4
 107 Maximum members per group entry\&. When the maximum is reached, a new group entry (line) is started in
 108 /etc/group
 109 (with the same name, same password, and same GID)\&.
 110 .sp
 111 The default value is 0, meaning that there are no limits in the number of members in a group\&.
 112 .sp
 113 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\&.
 114 .sp
 115 If you need to enforce such limit, you can use 25\&.
 116 .sp
 117 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\&.
 118 .RE
 119 .SH "FILES"
 120 .PP
 121 /etc/group
 122 .RS 4
 123 Group account information\&.
 124 .RE
 125 .PP
 126 /etc/gshadow
 127 .RS 4
 128 Secure group account information\&.
 129 .RE
 130 .SH "EXIT VALUES"
 131 .PP
 132 The
 133 \fBgroupmod\fR
 134 command exits with the following values:
 135 .PP
 136 \fI0\fR
 137 .RS 4
 138 success
 139 .RE
 140 .PP
 141 \fI2\fR
 142 .RS 4
 143 invalid command syntax
 144 .RE
 145 .PP
 146 \fI3\fR
 147 .RS 4
 148 invalid argument to option
 149 .RE
 150 .PP
 151 \fI4\fR
 152 .RS 4
 153 specified group doesn\*(Aqt exist
 154 .RE
 155 .PP
 156 \fI6\fR
 157 .RS 4
 158 specified group doesn\*(Aqt exist
 159 .RE
 160 .PP
 161 \fI9\fR
 162 .RS 4
 163 group name already in use
 164 .RE
 165 .PP
 166 \fI10\fR
 167 .RS 4
 168 can\*(Aqt update group file
 169 .RE
 170 .SH "SEE ALSO"
 171 .PP
 172
 173 \fBchfn\fR(1),
 174 \fBchsh\fR(1),
 175 \fBpasswd\fR(1),
 176 \fBgpasswd\fR(8),
 177 \fBgroupadd\fR(8),
 178 \fBgroupdel\fR(8),
 179 \fBuseradd\fR(8),
 180 \fBuserdel\fR(8),
 181 \fBusermod\fR(8)\&.