freebsd-skq/usr.sbin/chown/chgrp.1

.\" Copyright (c) 1983, 1990, 1993, 1994
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the Institute of Electrical and Electronics Engineers, Inc.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)chgrp.1	8.3 (Berkeley) 3/31/94
.\" $FreeBSD$
.\"
.Dd January 7, 2017
.Dt CHGRP 1
.Os
.Sh NAME
.Nm chgrp
.Nd change group
.Sh SYNOPSIS
.Nm
.Op Fl fhvx
.Oo
.Fl R
.Op Fl H | Fl L | Fl P
.Oc
.Ar group
.Ar
.Sh DESCRIPTION
The
.Nm
utility sets the group ID of the file named by each
.Ar file
operand to the
.Ar group
ID specified by the group operand.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl H
If the
.Fl R
option is specified, symbolic links on the command line are followed
and hence unaffected by the command.
(Symbolic links encountered during traversal are not followed.)
.It Fl L
If the
.Fl R
option is specified, all symbolic links are followed.
.It Fl P
If the
.Fl R
option is specified, no symbolic links are followed.
This is the default.
.It Fl R
Change the group ID of the file hierarchies rooted in the files,
instead of just the files themselves.
Beware of unintentionally matching the
.Dq Pa ".."
hard link to the parent directory when using wildcards like
.Dq Li ".*" .
.It Fl f
The force option ignores errors, except for usage errors and does not
query about strange modes (unless the user does not have proper permissions).
.It Fl h
If the file is a symbolic link, the group ID of the link itself is changed
rather than the file that is pointed to.
.It Fl v
Cause
.Nm
to be verbose, showing files as the group is modified.
If the
.Fl v
flag is specified more than once,
.Nm
will print the filename, followed by the old and new numeric group ID.
.It Fl x
File system mount points are not traversed.
.El
.Pp
The
.Fl H ,
.Fl L
and
.Fl P
options are ignored unless the
.Fl R
option is specified.
In addition, these options override each other and the
command's actions are determined by the last one specified.
.Pp
The
.Ar group
operand can be either a group name from the group database,
or a numeric group ID.
If a group name is also a numeric group ID, the operand is used as a
group name.
.Pp
The user invoking
.Nm
must belong to the specified group and be the owner of the file,
or be the super-user.
.Pp
If
.Nm
receives a
.Dv SIGINFO
signal (see the
.Cm status
argument for
.Xr stty 1 ) ,
then the current filename as well as the old and new group names are
displayed.
.Sh FILES
.Bl -tag -width /etc/group -compact
.It Pa /etc/group
group ID file
.El
.Sh EXIT STATUS
.Ex -std
.Sh COMPATIBILITY
In previous versions of this system, symbolic links did not have groups.
.Pp
The
.Fl v
and
.Fl x
options are non-standard and their use in scripts is not recommended.
.Sh SEE ALSO
.Xr chown 2 ,
.Xr fts 3 ,
.Xr group 5 ,
.Xr passwd 5 ,
.Xr symlink 7 ,
.Xr chown 8
.Sh STANDARDS
The
.Nm
utility is expected to be
.St -p1003.2
compatible.
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.\" Copyright (c) 1983, 1990, 1993, 1994`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" This code is derived from software contributed to Berkeley by`
			`.\" the Institute of Electrical and Electronics Engineers, Inc.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96 2017-02-28 23:42:47 +00:00			`.\" 3. Neither the name of the University nor the names of its contributors`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)chgrp.1 8.3 (Berkeley) 3/31/94`
$Id$ -> $FreeBSD$ 1999-08-28 01:35:59 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.\"`
chown/chgrp: Add SIGINFO handler PR: 191884 Submitted by: Dan McGregor <dan.mcgregor at usask.ca> Reviewed by: mjg@ (earlier version) 2017-01-08 06:58:42 +00:00			`.Dd January 7, 2017`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Dt CHGRP 1`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 15:12:08 +00:00			`.Os`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Sh NAME`
			`.Nm chgrp`
			`.Nd change group`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm`
Add a "-x" option to chown(8)/chgrp(1) similar to the same option in du(1), cp(1) etc, to prevent the crossing of mountpoints whilst using the commands recursively. PR: bin/130855 Submitted by: keramida MFC after: 1 month 2010-02-21 10:14:06 +00:00			`.Op Fl fhvx`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Oo`
			`.Fl R`
			`.Op Fl H \| Fl L \| Fl P`
			`.Oc`
			`.Ar group`
add .Sh DIAGNOSTICS 1999-10-17 15:50:19 +00:00			`.Ar`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Sh DESCRIPTION`
Cosmetic in man page. Sync usage() with man page. 1997-09-04 11:55:45 +00:00			`The`
			`.Nm`
			`utility sets the group ID of the file named by each`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Ar file`
			`operand to the`
			`.Ar group`
			`ID specified by the group operand.`
			`.Pp`
add .Sh DIAGNOSTICS 1999-10-17 15:50:19 +00:00			`The following options are available:`
			`.Bl -tag -width indent`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.It Fl H`
			`If the`
			`.Fl R`
Standardise chmod, chflags, chown and chgrp recursive symlink processing chmod, chflags, chgrp, chmod and chown now affect symlinks in -R mode as defined in symlink(7); previously symlinks were silently ignored. Differential Revision: https://reviews.freebsd.org/D2316 Reviewed by: jilles MFC after: 1 month Relnotes: yes Sponsored by: Multiplay 2015-04-29 00:49:00 +00:00			`option is specified, symbolic links on the command line are followed`
			`and hence unaffected by the command.`
			`(Symbolic links encountered during traversal are not followed.)`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.It Fl L`
			`If the`
			`.Fl R`
			`option is specified, all symbolic links are followed.`
			`.It Fl P`
			`If the`
			`.Fl R`
			`option is specified, no symbolic links are followed.`
Make it clear that -P is the default. PR: docs/27629 2001-05-25 07:32:58 +00:00			`This is the default.`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.It Fl R`
Standardise chmod, chflags, chown and chgrp recursive symlink processing chmod, chflags, chgrp, chmod and chown now affect symlinks in -R mode as defined in symlink(7); previously symlinks were silently ignored. Differential Revision: https://reviews.freebsd.org/D2316 Reviewed by: jilles MFC after: 1 month Relnotes: yes Sponsored by: Multiplay 2015-04-29 00:49:00 +00:00			`Change the group ID of the file hierarchies rooted in the files,`
			`instead of just the files themselves.`
			`Beware of unintentionally matching the`
			`.Dq Pa ".."`
			`hard link to the parent directory when using wildcards like`
			`.Dq Li ".*" .`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.It Fl f`
Expand *n't contractions. 2005-02-13 22:25:33 +00:00			`The force option ignores errors, except for usage errors and does not`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`query about strange modes (unless the user does not have proper permissions).`
Activate the -h flag which tells chown/chgrp to work on the symlink itself using lchown(). Most of the code was already here, the option was recognised but ignored for SYSV/POSIX.2(?) compatability. 1997-03-31 13:03:49 +00:00			`.It Fl h`
			`If the file is a symbolic link, the group ID of the link itself is changed`
			`rather than the file that is pointed to.`
Add "-v". 1999-11-27 19:25:08 +00:00			`.It Fl v`
			`Cause`
			`.Nm`
			`to be verbose, showing files as the group is modified.`
Similar to chmod(1); make -v -v mean very verbose and show the old and new uid/gid. PR: 41341 Submitted by: Edward Brocklesby <nighthawk@unrealircd.com> Reviewed by: bde@ (an older version) 2003-04-25 08:57:55 +00:00			`If the`
			`.Fl v`
Erase whitespace at EOL. Approved by: re (blanket) 2003-05-22 11:56:41 +00:00			`flag is specified more than once,`
Similar to chmod(1); make -v -v mean very verbose and show the old and new uid/gid. PR: 41341 Submitted by: Edward Brocklesby <nighthawk@unrealircd.com> Reviewed by: bde@ (an older version) 2003-04-25 08:57:55 +00:00			`.Nm`
			`will print the filename, followed by the old and new numeric group ID.`
Add a "-x" option to chown(8)/chgrp(1) similar to the same option in du(1), cp(1) etc, to prevent the crossing of mountpoints whilst using the commands recursively. PR: bin/130855 Submitted by: keramida MFC after: 1 month 2010-02-21 10:14:06 +00:00			`.It Fl x`
			`File system mount points are not traversed.`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.El`
			`.Pp`
			`The`
			`.Fl H ,`
			`.Fl L`
			`and`
			`.Fl P`
			`options are ignored unless the`
			`.Fl R`
			`option is specified.`
			`In addition, these options override each other and the`
			`command's actions are determined by the last one specified.`
			`.Pp`
			`The`
			`.Ar group`
			`operand can be either a group name from the group database,`
			`or a numeric group ID.`
			`If a group name is also a numeric group ID, the operand is used as a`
			`group name.`
			`.Pp`
			`The user invoking`
Cosmetic in man page. Sync usage() with man page. 1997-09-04 11:55:45 +00:00			`.Nm`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`must belong to the specified group and be the owner of the file,`
			`or be the super-user.`
chown/chgrp: Add SIGINFO handler PR: 191884 Submitted by: Dan McGregor <dan.mcgregor at usask.ca> Reviewed by: mjg@ (earlier version) 2017-01-08 06:58:42 +00:00			`.Pp`
			`If`
			`.Nm`
			`receives a`
			`.Dv SIGINFO`
			`signal (see the`
			`.Cm status`
			`argument for`
			`.Xr stty 1 ) ,`
			`then the current filename as well as the old and new group names are`
			`displayed.`
Sort sections. 2005-01-18 20:02:45 +00:00			`.Sh FILES`
			`.Bl -tag -width /etc/group -compact`
			`.It Pa /etc/group`
			`group ID file`
			`.El`
Added the EXIT STATUS section where appropriate. 2005-01-17 07:44:44 +00:00			`.Sh EXIT STATUS`
mdoc(7) police: utilize the new .Ex macro. 2001-08-15 09:09:47 +00:00			`.Ex -std`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Sh COMPATIBILITY`
Activate the -h flag which tells chown/chgrp to work on the symlink itself using lchown(). Most of the code was already here, the option was recognised but ignored for SYSV/POSIX.2(?) compatability. 1997-03-31 13:03:49 +00:00			`In previous versions of this system, symbolic links did not have groups.`
Add "-v". 1999-11-27 19:25:08 +00:00			`.Pp`
			`The`
			`.Fl v`
Add a "-x" option to chown(8)/chgrp(1) similar to the same option in du(1), cp(1) etc, to prevent the crossing of mountpoints whilst using the commands recursively. PR: bin/130855 Submitted by: keramida MFC after: 1 month 2010-02-21 10:14:06 +00:00			`and`
			`.Fl x`
			`options are non-standard and their use in scripts is not recommended.`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Sh SEE ALSO`
			`.Xr chown 2 ,`
Sort cross references. 1997-01-20 00:03:00 +00:00			`.Xr fts 3 ,`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Xr group 5 ,`
			`.Xr passwd 5 ,`
			`.Xr symlink 7 ,`
			`.Xr chown 8`
			`.Sh STANDARDS`
			`The`
Cosmetic in man page. Sync usage() with man page. 1997-09-04 11:55:45 +00:00			`.Nm`
			`utility is expected to be`
			`.St -p1003.2`
			`compatible.`