usr/src/man/man1m/groupadd.1m

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 1998 Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH GROUPADD 1M "Aug 27, 2008"
   7 .SH NAME
   8 groupadd \- add (create) a new group definition on the system
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/sbin/groupadd\fR [\fB-g\fR \fIgid\fR [\fB-o\fR]] \fIgroup\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBgroupadd\fR command creates a new group definition on the system by
  19 adding the appropriate entry to the \fB/etc/group\fR file.
  20 .SH OPTIONS
  21 .sp
  22 .LP
  23 The following options are supported:
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fB-g\fR \fIgid\fR\fR
  28 .ad
  29 .RS 10n
  30 Assigns the group id \fIgid\fR for the new group. This group id must be a
  31 non-negative decimal integer below \fBMAXUID\fR as defined in
  32 \fB/usr/include/sys/param.h\fR. The group \fBID\fR defaults to the next
  33 available (unique) number above the highest number currently assigned. For
  34 example, if groups  \fB100\fR, \fB105\fR, and  \fB200\fR are assigned as
  35 groups, the next default group number will be  \fB201\fR. (Group \fBIDs\fR from
  36 \fB0\fR\(mi\fB99\fR are reserved by SunOS for future applications.)
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fB-o\fR\fR
  43 .ad
  44 .RS 10n
  45 Allows the \fIgid\fR to be duplicated (non-unique).
  46 .RE
  47
  48 .SH OPERANDS
  49 .sp
  50 .LP
  51 The following operands are supported:
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fIgroup\fR\fR
  56 .ad
  57 .RS 9n
  58 A string consisting of characters from the set of lower case alphabetic
  59 characters and numeric characters. A warning message will be written if the
  60 string exceeds \fBMAXGLEN,\fR which is usually set at eight characters. The
  61 \fIgroup\fR field must contain at least one character; it accepts lower case or
  62 numeric characters or a combination of both, and must not contain a colon
  63 (\fB:\fR) or  \fBNEWLINE.\fR
  64 .RE
  65
  66 .SH EXIT STATUS
  67 .sp
  68 .LP
  69 The following exit values are returned:
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fB0\fR\fR
  74 .ad
  75 .RS 6n
  76 Successful completion.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fB2\fR\fR
  83 .ad
  84 .RS 6n
  85 Invalid command syntax. A usage message for the \fBgroupadd\fR command is
  86 displayed.
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fB3\fR\fR
  93 .ad
  94 .RS 6n
  95 An invalid argument was provided to an option.
  96 .RE
  97
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fB4\fR\fR
 102 .ad
 103 .RS 6n
 104 The \fIgid\fR is not unique (when  \fB-o\fR option is not used).
 105 .RE
 106
 107 .sp
 108 .ne 2
 109 .na
 110 \fB\fB9\fR\fR
 111 .ad
 112 .RS 6n
 113 The \fIgroup\fR is not unique.
 114 .RE
 115
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fB10\fR\fR
 120 .ad
 121 .RS 6n
 122 The  \fB/etc/group\fR file cannot be updated.
 123 .RE
 124
 125 .SH FILES
 126 .RS +4
 127 .TP
 128 .ie t \(bu
 129 .el o
 130 \fB/etc/group\fR
 131 .RE
 132 .RS +4
 133 .TP
 134 .ie t \(bu
 135 .el o
 136 \fB/usr/include/userdefs.h\fR
 137 .RE
 138 .SH SEE ALSO
 139 .sp
 140 .LP
 141 \fBusers\fR(1B), \fBgroupdel\fR(1M), \fBgroupmod\fR(1M), \fBgrpck\fR(1M),
 142 \fBlogins\fR(1M), \fBpwck\fR(1M), \fBuseradd\fR(1M), \fBuserdel\fR(1M),
 143 \fBusermod\fR(1M), \fBgroup\fR(4), \fBattributes\fR(5)
 144 .SH NOTES
 145 .sp
 146 .LP
 147 \fBgroupadd\fR only adds a group definition to the local system. If a network
 148 name service such as \fBNIS\fR or \fBNIS+\fR is being used to supplement the
 149 local \fB/etc/group\fR file with additional entries, \fBgroupadd\fR cannot
 150 change information supplied by the network name service. However,
 151 \fBgroupadd\fR will verify the uniqueness of group name and group \fBID\fR
 152 against the external name service.
 153 .sp
 154 .LP
 155 If the number of characters in a \fBgroup\fR entry exceeds 2047, group
 156 maintenance commands, such as \fBgroupdel\fR(1M) and \fBgroupmod\fR(1M), fail.