-.\" $NetBSD: chflags.1,v 1.6 1997/10/18 12:39:50 lukem Exp $
-.\"
+.\"-
.\" Copyright (c) 1989, 1990, 1993, 1994
.\" The Regents of the University of California. All rights reserved.
.\"
.\" 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.
.\" SUCH DAMAGE.
.\"
.\" @(#)chflags.1 8.4 (Berkeley) 5/2/95
+.\" $FreeBSD: src/bin/chflags/chflags.1,v 1.30.2.1.2.1 2009/10/25 01:10:29 kensmith Exp $
.\"
-.Dd May 2, 1995
+.Dd March 3, 2006
.Dt CHFLAGS 1
.Os
.Sh NAME
.Nd change file flags
.Sh SYNOPSIS
.Nm
+.Op Fl fhv
.Oo
.Fl R
.Op Fl H | Fl L | Fl P
.Oc
.Ar flags
-.Ar file ...
+.Ar
.Sh DESCRIPTION
The
.Nm
operand.
.Pp
The options are as follows:
-.Bl -tag -width Ds
+.Bl -tag -width indent
+.It Fl f
+Do not display a diagnostic message if
+.Nm
+could not modify the flags for
+.Va file ,
+nor modify the exit status to reflect such failures.
.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 file flags of the link itself rather than the file to which it points.
.It Fl L
If the
.Fl R
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.
+.It Fl v
+Cause
+.Nm
+to be verbose, showing filenames as the flags are modified.
+If the
+.Fl v
+option is specified more than once, the old and new flags of the file
+will also be printed, in octal notation.
.El
.Pp
-Flags are a comma separated list of keywords.
+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)
-uappnd set the user append-only flag (owner or super-user only)
-uchg set the user immutable flag (owner or super-user only)
-.Ed
+.Pp
+.Bl -tag -offset indent -width ".Cm opaque"
+.It Cm arch , archived
+set the archived flag (super-user only)
+.It Cm opaque
+set the opaque flag (owner or super-user only).
+[Directory is opaque when viewed through a union mount]
+.It Cm nodump
+set the nodump flag (owner or super-user only)
+.It Cm sappnd , sappend
+set the system append-only flag (super-user only)
+.It Cm schg , schange , simmutable
+set the system immutable flag (super-user only)
+.It Cm uappnd , uappend
+set the user append-only flag (owner or super-user only)
+.It Cm uchg , uchange , uimmutable
+set the user immutable flag (owner or super-user only)
+.It Cm hidden
+set the hidden flag
+[Hide item from GUI]
+.El
+.Pp
+As discussed in
+.Xr chflags 2 ,
+the
+.Ar sappnd
+and
+.Ar schg
+flags may only be unset when the system is in single-user mode.
.Pp
Putting the letters
-.Dq no
-before an option causes the flag to be turned off.
+.Dq Ar no
+before or removing the letters
+.Dq Ar no
+from a keyword causes the flag to be cleared.
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
+.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
or
.Fl L
-option is set,
+options are given,
.Nm
on a symbolic link always succeeds and has no effect.
The
In addition, these options override each other and the
command's actions are determined by the last one specified.
.Pp
-The
-.Nm
-utility exits 0 on success, and >0 if an error occurs.
+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 HISTORY
+The
+.Nm
+command first appeared in
+.Bx 4.4 .
+.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.
projects / apple / file_cmds.git / blobdiff