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.
.\" 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 14, 2005
.Dt CHFLAGS 1
.Os
.Sh NAME
.Nm chflags
.Nd change file flags
.Sh SYNOPSIS
.Nm
.Op Fl h
.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 h
If the
.Ar file
is a symbolic link,
change the mode of the link itself rather than the file to which it points.
.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 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:
.Pp
.Bl -tag -offset indent -width ".Ar opaque"
.It Ar arch , archived
set the archived flag (super-user only)
.It Ar opaque
set the opaque flag (owner or super-user only)
.It Ar nodump
set the nodump flag (owner or super-user only)
.It Ar sappnd , sappend
set the system append-only flag (super-user only)
.It Ar schg , schange , simmutable
set the system immutable flag (super-user only)
.It Ar sunlnk , sunlink
set the system undeletable flag (super-user only)
.It Ar uappnd , uappend
set the user append-only flag (owner or super-user only)
.It Ar uchg , uchange , uimmutable
set the user immutable flag (owner or super-user only)
.It Ar uunlnk , uunlink
set the user undeletable flag (owner or super-user only)
.El
.Pp
Putting the letters
.Dq Ar no
before or removing the letters
.Dq Ar no
from a keyword causes the flag to be cleared.
For example:
.Pp
.Bl -tag -offset indent -width "nouchg" -compact
.It Ar nouchg
clear the user immutable flag (owner or super-user only)
.It Ar dump
clear the nodump flag (owner or super-user only)
.El
.Pp
Unless the
.Fl H ,
.Fl L ,
or
.Fl h
options are given,
.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 EXIT STATUS
.Ex -std
.Sh SEE ALSO
.Xr ls 1 ,
.Xr chflags 2 ,
.Xr stat 2 ,
.Xr fts 3 ,
.Xr symlink 7
.Sh BUGS
Only a limited number of utilities are
.Nm
aware.
Some of these tools include
.Xr ls 1 ,
.Xr cp 1 ,
.Xr find 1 ,
.Xr install 1 ,
.Xr dump 8 ,
and
.Xr restore 8 .
In particular a tool which is not currently
.Nm
aware is the
.Xr pax 1
utility.
.Sh HISTORY
The
.Nm
command first appeared in
.Bx 4.4 .
/*- or .\"- or #- to begin license clauses. 2005-01-10 08:39:26 +00:00			`.\"-`
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.`
			`.\" 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			`.\"`
Add an interface to the lchflags(2) syscall. The new -h option is analogous to chmod(1)'s -h. It allows setting flags on symbolic links, which do exist in 5.x+ despite a claim to the contrary in the chflags(1) man page. Suggested by: Chris Dillon 2005-05-14 23:23:10 +00:00			`.Dd May 14, 2005`
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`
Add an interface to the lchflags(2) syscall. The new -h option is analogous to chmod(1)'s -h. It allows setting flags on symbolic links, which do exist in 5.x+ despite a claim to the contrary in the chflags(1) man page. Suggested by: Chris Dillon 2005-05-14 23:23:10 +00:00			`.Op Fl h`
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.)`
Add an interface to the lchflags(2) syscall. The new -h option is analogous to chmod(1)'s -h. It allows setting flags on symbolic links, which do exist in 5.x+ despite a claim to the contrary in the chflags(1) man page. Suggested by: Chris Dillon 2005-05-14 23:23:10 +00:00			`.It Fl h`
			`If the`
			`.Ar file`
			`is a symbolic link,`
			`change the mode of the link itself rather than the file to which it points.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +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.bin Sources 1994-05-27 12:33:43 +00:00			`.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:`
Prepare for mdoc(7)NG. 2000-12-19 16:00:12 +00:00			`.Pp`
Group equivalent flags together and delete the `aliases' section. PR: docs/70856 Submitted by: Rostislav Krasny <rosti_bsd@yahoo.com> 2004-09-21 10:13:34 +00:00			`.Bl -tag -offset indent -width ".Ar opaque"`
			`.It Ar arch , archived`
Prepare for mdoc(7)NG. 2000-12-19 16:00:12 +00:00			`set the archived flag (super-user only)`
			`.It Ar opaque`
			`set the opaque flag (owner or super-user only)`
			`.It Ar nodump`
			`set the nodump flag (owner or super-user only)`
Group equivalent flags together and delete the `aliases' section. PR: docs/70856 Submitted by: Rostislav Krasny <rosti_bsd@yahoo.com> 2004-09-21 10:13:34 +00:00			`.It Ar sappnd , sappend`
Prepare for mdoc(7)NG. 2000-12-19 16:00:12 +00:00			`set the system append-only flag (super-user only)`
Group equivalent flags together and delete the `aliases' section. PR: docs/70856 Submitted by: Rostislav Krasny <rosti_bsd@yahoo.com> 2004-09-21 10:13:34 +00:00			`.It Ar schg , schange , simmutable`
Prepare for mdoc(7)NG. 2000-12-19 16:00:12 +00:00			`set the system immutable flag (super-user only)`
Group equivalent flags together and delete the `aliases' section. PR: docs/70856 Submitted by: Rostislav Krasny <rosti_bsd@yahoo.com> 2004-09-21 10:13:34 +00:00			`.It Ar sunlnk , sunlink`
Prepare for mdoc(7)NG. 2000-12-19 16:00:12 +00:00			`set the system undeletable flag (super-user only)`
Group equivalent flags together and delete the `aliases' section. PR: docs/70856 Submitted by: Rostislav Krasny <rosti_bsd@yahoo.com> 2004-09-21 10:13:34 +00:00			`.It Ar uappnd , uappend`
Prepare for mdoc(7)NG. 2000-12-19 16:00:12 +00:00			`set the user append-only flag (owner or super-user only)`
Group equivalent flags together and delete the `aliases' section. PR: docs/70856 Submitted by: Rostislav Krasny <rosti_bsd@yahoo.com> 2004-09-21 10:13:34 +00:00			`.It Ar uchg , uchange , uimmutable`
Prepare for mdoc(7)NG. 2000-12-19 16:00:12 +00:00			`set the user immutable flag (owner or super-user only)`
Group equivalent flags together and delete the `aliases' section. PR: docs/70856 Submitted by: Rostislav Krasny <rosti_bsd@yahoo.com> 2004-09-21 10:13:34 +00:00			`.It Ar uunlnk , uunlink`
Prepare for mdoc(7)NG. 2000-12-19 16:00:12 +00:00			`set the user undeletable flag (owner or super-user only)`
			`.El`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Pp`
			`Putting the letters`
Prepare for mdoc(7)NG. 2000-12-19 16:00:12 +00:00			`.Dq Ar no`
Document how to clear flags with negative-logic, currently only the nodump flag. PR: 46912 Reported by: dave@syix.com <dave@syix.com> MFC after: 2 weeks 2003-03-24 20:15:58 +00:00			`before or removing the letters`
			`.Dq Ar no`
			`from a keyword causes the flag to be cleared.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`For example:`
Document how to clear flags with negative-logic, currently only the nodump flag. PR: 46912 Reported by: dave@syix.com <dave@syix.com> MFC after: 2 weeks 2003-03-24 20:15:58 +00:00			`.Pp`
			`.Bl -tag -offset indent -width "nouchg" -compact`
Prepare for mdoc(7)NG. 2000-12-19 16:00:12 +00:00			`.It Ar nouchg`
Document how to clear flags with negative-logic, currently only the nodump flag. PR: 46912 Reported by: dave@syix.com <dave@syix.com> MFC after: 2 weeks 2003-03-24 20:15:58 +00:00			`clear the user immutable flag (owner or super-user only)`
			`.It Ar dump`
			`clear the nodump flag (owner or super-user only)`
Prepare for mdoc(7)NG. 2000-12-19 16:00:12 +00:00			`.El`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Pp`
Add an interface to the lchflags(2) syscall. The new -h option is analogous to chmod(1)'s -h. It allows setting flags on symbolic links, which do exist in 5.x+ despite a claim to the contrary in the chflags(1) man page. Suggested by: Chris Dillon 2005-05-14 23:23:10 +00:00			`Unless the`
			`.Fl H ,`
			`.Fl L ,`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`or`
Add an interface to the lchflags(2) syscall. The new -h option is analogous to chmod(1)'s -h. It allows setting flags on symbolic links, which do exist in 5.x+ despite a claim to the contrary in the chflags(1) man page. Suggested by: Chris Dillon 2005-05-14 23:23:10 +00:00			`.Fl h`
			`options are given,`
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.`
Add the new standard EXIT STATUS section where appropriate. Sort standard sections in the (documented) preferred order. 2005-01-16 16:41:59 +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.bin Sources 1994-05-27 12:33:43 +00:00			`.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 information on utilities which may or may not be aware of file flags. PR: 55653 Submitted by: Tony Maher <tonymaher@optushome.com.au> (original version) 2005-02-23 23:07:45 +00:00			`.Sh BUGS`
			`Only a limited number of utilities are`
			`.Nm`
			`aware.`
Fix a few markup nits in previous commit. Noticed by: ru, who else? :) 2005-02-25 00:40:46 +00:00			`Some of these tools include`
Add information on utilities which may or may not be aware of file flags. PR: 55653 Submitted by: Tony Maher <tonymaher@optushome.com.au> (original version) 2005-02-23 23:07:45 +00:00			`.Xr ls 1 ,`
			`.Xr cp 1 ,`
			`.Xr find 1 ,`
Fix a few markup nits in previous commit. Noticed by: ru, who else? :) 2005-02-25 00:40:46 +00:00			`.Xr install 1 ,`
Add information on utilities which may or may not be aware of file flags. PR: 55653 Submitted by: Tony Maher <tonymaher@optushome.com.au> (original version) 2005-02-23 23:07:45 +00:00			`.Xr dump 8 ,`
			`and`
			`.Xr restore 8 .`
Fix a few markup nits in previous commit. Noticed by: ru, who else? :) 2005-02-25 00:40:46 +00:00			`In particular a tool which is not currently`
Add information on utilities which may or may not be aware of file flags. PR: 55653 Submitted by: Tony Maher <tonymaher@optushome.com.au> (original version) 2005-02-23 23:07:45 +00:00			`.Nm`
Fix a few markup nits in previous commit. Noticed by: ru, who else? :) 2005-02-25 00:40:46 +00:00			`aware is the`
			`.Xr pax 1`
			`utility.`
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 .`