freebsd-dev/bin/chflags/chflags.1

.\" Copyright (c) 1989, 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. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. 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.
.\"
.\"	@(#)chflags.1	8.4 (Berkeley) 5/2/95
.\" $FreeBSD$
.\"
.Dd May 2, 1995
.Dt CHFLAGS 1
.Os
.Sh NAME
.Nm chflags
.Nd change file flags
.Sh SYNOPSIS
.Nm
.Oo
.Fl R
.Op Fl H | Fl L | Fl P
.Oc
.Ar flags
.Ar
.Sh DESCRIPTION
The
.Nm
utility modifies the file flags of the listed files
as specified by the
.Ar flags
operand.
.Pp
The options are as follows:
.Bl -tag -width indent
.It Fl H
If the
.Fl R
option is specified, symbolic links on the command line are followed.
(Symbolic links encountered in the tree 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.
.It Fl R
Change the file flags for the file hierarchies rooted
in the files instead of just the files themselves.
.El
.Pp
The flags are specified as an octal number or a comma separated list
of keywords.
The following keywords are currently defined:
.Bd -literal -offset indent compact
arch	set the archived flag (super-user only)
opaque	set the opaque flag (owner or super-user only)
nodump	set the nodump flag (owner or super-user only)
sappnd	set the system append-only flag (super-user only)
schg	set the system immutable flag (super-user only)
sunlnk	set the system undeletable flag (super-user only)
uappnd	set the user append-only flag (owner or super-user only)
uchg	set the user immutable flag (owner or super-user only)
uunlnk	set the user undeletable flag (owner or super-user only)
archived, sappend, schange, simmutable, uappend, uchange, uimmutable,
sunlink, uunlink
	aliases for the above
.Ed
.Pp
Putting the letters
.Dq no
before an option causes the flag to be turned off.
For example:
.Bd -literal -offset indent compact
nouchg	the immutable bit should be cleared
.Ed
.Pp
Symbolic links do not have flags, so unless the
.Fl H
or
.Fl L
option is set,
.Nm
on a symbolic link always succeeds and has no effect.
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
You can use "ls -lo" to see the flags of existing files.
.Sh DIAGNOSTICS
The
.Nm
utility exits 0 on success, and >0 if an error occurs.
.Sh SEE ALSO
.Xr ls 1 ,
.Xr chflags 2 ,
.Xr stat 2 ,
.Xr fts 3 ,
.Xr symlink 7
.Sh HISTORY
The
.Nm
command first appeared in
.Bx 4.4 .
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" Copyright (c) 1989, 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. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed by the University of`
			`.\" California, Berkeley and its contributors.`
			`.\" 4. 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.`
			`.\"`
Yet another previously forgotten merge from Lite2. (Describe `opaque', fix reversed description of `nodump', and don't use `nodump' as an example of adding a `no' prefix since the double negative would be confusing (it's still confusing -- the implicitly documented `nonodump' flag doesn't exist).) 1999-08-30 03:40:26 +00:00			`.\" @(#)chflags.1 8.4 (Berkeley) 5/2/95`
$Id$ -> $FreeBSD$ 1999-08-28 01:08:13 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\"`
Yet another previously forgotten merge from Lite2. (Describe `opaque', fix reversed description of `nodump', and don't use `nodump' as an example of adding a `no' prefix since the double negative would be confusing (it's still confusing -- the implicitly documented `nonodump' flag doesn't exist).) 1999-08-30 03:40:26 +00:00			`.Dd May 2, 1995`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Dt CHFLAGS 1`
			`.Os`
			`.Sh NAME`
			`.Nm chflags`
			`.Nd change file flags`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Oo`
			`.Fl R`
			`.Op Fl H \| Fl L \| Fl P`
			`.Oc`
			`.Ar flags`
Correct use of .Nm. Add DIAGNOSTICS section. Add rcsid 1999-11-21 16:11:56 +00:00			`.Ar`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh DESCRIPTION`
			`The`
Correct use of .Nm. Add DIAGNOSTICS section. Add rcsid 1999-11-21 16:11:56 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`utility modifies the file flags of the listed files`
			`as specified by the`
			`.Ar flags`
			`operand.`
			`.Pp`
			`The options are as follows:`
Correct use of .Nm. Add DIAGNOSTICS section. Add rcsid 1999-11-21 16:11:56 +00:00			`.Bl -tag -width indent`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Fl H`
			`If the`
			`.Fl R`
			`option is specified, symbolic links on the command line are followed.`
			`(Symbolic links encountered in the tree 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.`
			`.It Fl R`
			`Change the file flags for the file hierarchies rooted`
			`in the files instead of just the files themselves.`
			`.El`
			`.Pp`
Document that the flags can be specified as an octal number. 2000-04-03 22:10:58 +00:00			`The flags are specified as an octal number or a comma separated list`
			`of keywords.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`The following keywords are currently defined:`
			`.Bd -literal -offset indent compact`
Document the arch flag. It has always worked in 2.0. Document aliases for the flags. The formatting of the section describing the flags is poor. 1994-12-27 16:49:08 +00:00			`arch set the archived flag (super-user only)`
Yet another previously forgotten merge from Lite2. (Describe `opaque', fix reversed description of `nodump', and don't use `nodump' as an example of adding a `no' prefix since the double negative would be confusing (it's still confusing -- the implicitly documented `nonodump' flag doesn't exist).) 1999-08-30 03:40:26 +00:00			`opaque set the opaque flag (owner or super-user only)`
			`nodump set the nodump flag (owner or super-user only)`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`sappnd set the system append-only flag (super-user only)`
			`schg set the system immutable flag (super-user only)`
Submitted by: Whistle Communications (archie Cobbs) These changes add the ability to specify that a UFS file/directory cannot be unlinked. This is basically a scaled back version of the IMMUTABLE flag. The reason is to allow an administrator to create a directory hierarchy that a group of users can arbitrarily add/delete files from, but that the hierarchy itself is safe from removal by them. If the NOUNLINK definition is set to 0 then this results in no change to what happens normally. (and results in identical binary (in the kernel)). It can be proven that if this bit is never set by the admin, no new behaviour is introduced.. Several "good idea" comments from reviewers plus one grumble about creeping featurism. This code is in production in 2.2 based systems 1997-06-02 06:24:52 +00:00			`sunlnk set the system undeletable flag (super-user only)`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`uappnd set the user append-only flag (owner or super-user only)`
			`uchg set the user immutable flag (owner or super-user only)`
Submitted by: Whistle Communications (archie Cobbs) These changes add the ability to specify that a UFS file/directory cannot be unlinked. This is basically a scaled back version of the IMMUTABLE flag. The reason is to allow an administrator to create a directory hierarchy that a group of users can arbitrarily add/delete files from, but that the hierarchy itself is safe from removal by them. If the NOUNLINK definition is set to 0 then this results in no change to what happens normally. (and results in identical binary (in the kernel)). It can be proven that if this bit is never set by the admin, no new behaviour is introduced.. Several "good idea" comments from reviewers plus one grumble about creeping featurism. This code is in production in 2.2 based systems 1997-06-02 06:24:52 +00:00			`uunlnk set the user undeletable flag (owner or super-user only)`
			`archived, sappend, schange, simmutable, uappend, uchange, uimmutable,`
			`sunlink, uunlink`
Document the arch flag. It has always worked in 2.0. Document aliases for the flags. The formatting of the section describing the flags is poor. 1994-12-27 16:49:08 +00:00			`aliases for the above`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Ed`
			`.Pp`
			`Putting the letters`
			`.Dq no`
			`before an option causes the flag to be turned off.`
			`For example:`
			`.Bd -literal -offset indent compact`
Yet another previously forgotten merge from Lite2. (Describe `opaque', fix reversed description of `nodump', and don't use `nodump' as an example of adding a `no' prefix since the double negative would be confusing (it's still confusing -- the implicitly documented `nonodump' flag doesn't exist).) 1999-08-30 03:40:26 +00:00			`nouchg the immutable bit should be cleared`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Ed`
			`.Pp`
			`Symbolic links do not have flags, so unless the`
			`.Fl H`
			`or`
			`.Fl L`
			`option is set,`
Correct use of .Nm. Add DIAGNOSTICS section. Add rcsid 1999-11-21 16:11:56 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`on a symbolic link always succeeds and has no effect.`
			`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`
Document the use of `ls -lo' to see flags. Obtained from: OpenBSD. 1997-06-24 06:57:11 +00:00			`You can use "ls -lo" to see the flags of existing files.`
Correct use of .Nm. Add DIAGNOSTICS section. Add rcsid 1999-11-21 16:11:56 +00:00			`.Sh DIAGNOSTICS`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`The`
Correct use of .Nm. Add DIAGNOSTICS section. Add rcsid 1999-11-21 16:11:56 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`utility exits 0 on success, and >0 if an error occurs.`
			`.Sh SEE ALSO`
Document the use of `ls -lo' to see flags. Obtained from: OpenBSD. 1997-06-24 06:57:11 +00:00			`.Xr ls 1 ,`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Xr chflags 2 ,`
			`.Xr stat 2 ,`
			`.Xr fts 3 ,`
			`.Xr symlink 7`
Add history section. Follows chflags(2). 1997-02-19 00:32:35 +00:00			`.Sh HISTORY`
			`The`
Correct use of .Nm. Add DIAGNOSTICS section. Add rcsid 1999-11-21 16:11:56 +00:00			`.Nm`
Use the .Bx macro in the HISTORY section. 1997-02-19 07:14:30 +00:00			`command first appeared in`
			`.Bx 4.4 .`