Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

chgrp(1)

Name

chgrp - change file group ownership

Synopsis

chgrp [-c | -changes] [--dereference] [ -h | --no-dereference]
     [-f | --silent | --quiet] [--help] [-R | --recursive]
     [--no-preserve-root] [--preserve-root] [-v | --verbose]
     group file...
chgrp -R | --recursive [-c | -changes] [--dereference]
     [-h | --no-dereference] [-f | --silent | --quiet]
     [--help] [-H | -L | -P] [--no-preserve-root] [--preserve-root]
     [-v | --verbose] group file...
chgrp [-c | -changes] [--dereference] [-h | --no-dereference]
     [-f | --silent | --quiet] [--help] [-R | --recursive]
     [--no-preserve-root] [--preserve-root] [-v | --verbose]
     --reference=RFILE | -s groupsid file...
chgrp -R | --recursive [-c | -changes] [--dereference]
     [-h | --no-dereference] [-f | --silent | --quiet]
     [--help] [-H | -L | -P] [--no-preserve-root] [--preserve-root]
     [-v | --verbose] --reference=RFILE | -s groupsid file...

Description

The chgrp utility will set the group ID of the file named by each file operand to the group ID specified by the group operand.

For each file operand, it will perform actions equivalent to the chown(2) function, called with the following arguments:

  • The file operand will be used as the path argument.

  • The user ID of the file will be used as the owner argument.

  • The specified group ID will be used as the group argument.

Unless chgrp is invoked with the {PRIV_FILE_SETID} privilege, the set-user-ID and set-group-ID bits of a regular file will be cleared upon successful completion; the set-user-ID and set-group-ID bits of other file types may be cleared.

The file system has a mountpoint option, rstchown, to restrict ownership changes. When this option is in effect, the owner of the file may change the group of the file only to a group to which the owner belongs. The _POSIX_CHOWN_RESTRICTED option will be reported as true for paths on filesystems mounted with the rstchown option, when checked with fpathconf(2) or getconf(1).

The privilege {PRIV_FILE_CHOWN_SELF} allows a process to behave as if rstchown is disabled, whether or not the mount option is in effect. The privilege {PRIV_FILE_CHOWN} allows a process to change the group ID of any file to any group, whether or not the file is owned by the effective user id of the process, even if the effective user is not a member of that group.

Options

The following options are supported for /usr/bin/chgrp:

–c, –-changes

Like verbose (–v | –-verbose). Reports only when a change is made.

–f, –-silent, –-quiet

Force. Does not report errors.

–h, –-no-dereference

If the file is a symbolic link, this option changes the group of the symbolic link. Without this option, the group of the file referenced by the symbolic link is changed.

–-help

Display usage message and exit.

–H

If the file specified on the command line is a symbolic link referencing a file of type directory, this option changes the group of the directory referenced by the symbolic link and all the files in the file hierarchy below it. If a symbolic link is encountered when traversing a file hierarchy, the group of the target file is changed, but no recursion takes place.

–L

If the file is a symbolic link, this option changes the group of the file referenced by the symbolic link. If the file specified on the command line, or encountered during the traversal of the file hierarchy, is a symbolic link referencing a file of type directory, then this option changes the group of the directory referenced by the symbolic link and all files in the file hierarchy below it.

–-no-preserve-root

Do not treat '/' specially. This is the default.

–-preserve-root

Do not operate recursively on '/'.

–P

If the file specified on the command line or encountered during the traversal of a file hierarchy is a symbolic link, this option changes the group of the symbolic link. This option does not follow the symbolic link to any other part of the file hierarchy.

–-reference=RFILE

Use group name of RFILE. If RFILE is non-existent, an error message is displayed and returns a non-zero exit code. This option and –s option are mutually exclusive.

–R, –-recursive

Recursive. chgrp descends through the directory, and any subdirectories, setting the specified group ID as it proceeds. When a symbolic link is encountered, the group of the target file is changed, unless the –h or –P option is specified. However, no recursion takes place, unless the –H or –L option is specified.

–s

The specified group is Windows SID. This option requires a file system that supports storing SIDs, such as ZFS. This option and –-reference option are mutually exclusive.

–v, –-verbose

Give a diagnostic for every file processed.

Specifying more than one of the mutually-exclusive options –H, –L, or –P is not considered an error. The last option specified determines the behavior of chgrp.

The following options are supported for /usr/xpg4/bin/chgrp:

–f

Force. Does not report errors.

–R

Recursive. chgrp descends through the directory, and any subdirectories, setting the specified group ID as it proceeds. When a symbolic link is encountered, the group of the target file is changed, unless the –h or –P option is specified. Unless the –H, –L, or –P option is specified, the –L option is used as the default mode.

–H

If the file specified on the command line is a symbolic link referencing a file of type directory, this option changes the group of the directory referenced by the symbolic link and all the files in the file hierarchy below it. If a symbolic link is encountered when traversing a file hierarchy, the group of the target file is changed, but no recursion takes place.

–L

If the file is a symbolic link, this option changes group of the file referenced by the symbolic link. If the file specified on the command line, or encountered during the traversal of the file hierarchy, is a symbolic link referencing a file of type directory, then this option changes the group of the directory referenced by the symbolic link and all files in the file hierarchy below it.

–P

If the file specified on the command line or encountered during the traversal of a file hierarchy is a symbolic link, this option changes the group of the symbolic link. This option does not follow the symbolic link to any other part of the file hierarchy.

–s

The specified group is Windows SID. This option requires a file system that supports storing SIDs, such as ZFS.

Specifying more than one of the mutually-exclusive options –H, –L, or –P is not considered an error. The last option specified determines the behavior of chgrp.

Operands

The following operands are supported:

group

A group name from the group database or a numeric group ID. Either specifies a group ID to be given to each file named by one of the file operands. If a numeric group operand exists in the group database as a group name, the group ID number associated with that group name is used as the group ID.

file

A path name of a file whose group ID is to be modified.

Environment Variables

See environ(7) for descriptions of the following environment variables that affect the execution of chgrp: LANG, LC_ALL, LC_CTYPE, LC_MESSAGES, and NLSPATH.

Exit Status

The following exit values are returned:

0

The utility executed successfully and all requested changes were made.

>0

An error occurred.

Attributes

See attributes(7) for descriptions of the following attributes:

/usr/bin/chgrp

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
system/core-os
CSI
Enabled. See NOTES.
Interface Stability
Committed
Standard

/usr/xpg4/bin/chgrp

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
system/xopen/xcu4
CSI
Enabled. See NOTES.
Interface Stability
Committed
Standard

See Also

chmod(1), chown(1), getconf(1), chown(2), fpathconf(2), group(5), passwd(5), attributes(7), environ(7), privileges(7), standards(7), id(8), mount(8)

Notes

chgrp is CSI-enabled except for the group name.