2005-01-10 08:39:26 +00:00
|
|
|
.\"-
|
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.
|
|
|
|
|
.\"
|
1999-08-30 03:40:26 +00:00
|
|
|
.\" @(#)chflags.1 8.4 (Berkeley) 5/2/95
|
1999-08-28 01:08:13 +00:00
|
|
|
.\" $FreeBSD$
|
1994-05-27 12:33:43 +00:00
|
|
|
.\"
|
2015-04-29 00:49:00 +00:00
|
|
|
.Dd April 20, 2015
|
1994-05-27 12:33:43 +00:00
|
|
|
.Dt CHFLAGS 1
|
|
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm chflags
|
|
|
|
|
.Nd change file flags
|
|
|
|
|
.Sh SYNOPSIS
|
2000-11-20 19:21:22 +00:00
|
|
|
.Nm
|
2008-03-09 12:10:24 +00:00
|
|
|
.Op Fl fhv
|
1994-05-27 12:33:43 +00:00
|
|
|
.Oo
|
|
|
|
|
.Fl R
|
|
|
|
|
.Op Fl H | Fl L | Fl P
|
|
|
|
|
.Oc
|
|
|
|
|
.Ar flags
|
1999-11-21 16:11:56 +00:00
|
|
|
.Ar
|
1994-05-27 12:33:43 +00:00
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The
|
1999-11-21 16:11:56 +00:00
|
|
|
.Nm
|
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:
|
1999-11-21 16:11:56 +00:00
|
|
|
.Bl -tag -width indent
|
2008-03-09 12:10:24 +00:00
|
|
|
.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.
|
1994-05-27 12:33:43 +00:00
|
|
|
.It Fl H
|
|
|
|
|
If the
|
|
|
|
|
.Fl R
|
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.)
|
2005-05-14 23:23:10 +00:00
|
|
|
.It Fl h
|
|
|
|
|
If the
|
|
|
|
|
.Ar file
|
|
|
|
|
is a symbolic link,
|
2007-05-28 04:23:09 +00:00
|
|
|
change the file flags of the link itself rather than the file to which it points.
|
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.
|
2001-05-25 07:32:58 +00:00
|
|
|
This is the default.
|
1994-05-27 12:33:43 +00:00
|
|
|
.It Fl R
|
2015-04-29 00:49:00 +00:00
|
|
|
Change the file flags 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 ".*" .
|
2008-03-09 12:10:24 +00:00
|
|
|
.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.
|
1994-05-27 12:33:43 +00:00
|
|
|
.El
|
|
|
|
|
.Pp
|
2000-04-03 22:10:58 +00:00
|
|
|
The flags are specified as an octal number or a comma separated list
|
|
|
|
|
of keywords.
|
1994-05-27 12:33:43 +00:00
|
|
|
The following keywords are currently defined:
|
2006-03-10 12:37:19 +00:00
|
|
|
.Bl -tag -offset indent -width ".Cm opaque"
|
|
|
|
|
.It Cm arch , archived
|
2000-12-19 16:00:12 +00:00
|
|
|
set the archived flag (super-user only)
|
2006-03-10 12:37:19 +00:00
|
|
|
.It Cm nodump
|
2000-12-19 16:00:12 +00:00
|
|
|
set the nodump flag (owner or super-user only)
|
Expand the use of stat(2) flags to allow storing some Windows/DOS
and CIFS file attributes as BSD stat(2) flags.
This work is intended to be compatible with ZFS, the Solaris CIFS
server's interaction with ZFS, somewhat compatible with MacOS X,
and of course compatible with Windows.
The Windows attributes that are implemented were chosen based on
the attributes that ZFS already supports.
The summary of the flags is as follows:
UF_SYSTEM: Command line name: "system" or "usystem"
ZFS name: XAT_SYSTEM, ZFS_SYSTEM
Windows: FILE_ATTRIBUTE_SYSTEM
This flag means that the file is used by the
operating system. FreeBSD does not enforce any
special handling when this flag is set.
UF_SPARSE: Command line name: "sparse" or "usparse"
ZFS name: XAT_SPARSE, ZFS_SPARSE
Windows: FILE_ATTRIBUTE_SPARSE_FILE
This flag means that the file is sparse. Although
ZFS may modify this in some situations, there is
not generally any special handling for this flag.
UF_OFFLINE: Command line name: "offline" or "uoffline"
ZFS name: XAT_OFFLINE, ZFS_OFFLINE
Windows: FILE_ATTRIBUTE_OFFLINE
This flag means that the file has been moved to
offline storage. FreeBSD does not have any special
handling for this flag.
UF_REPARSE: Command line name: "reparse" or "ureparse"
ZFS name: XAT_REPARSE, ZFS_REPARSE
Windows: FILE_ATTRIBUTE_REPARSE_POINT
This flag means that the file is a Windows reparse
point. ZFS has special handling code for reparse
points, but we don't currently have the other
supporting infrastructure for them.
UF_HIDDEN: Command line name: "hidden" or "uhidden"
ZFS name: XAT_HIDDEN, ZFS_HIDDEN
Windows: FILE_ATTRIBUTE_HIDDEN
This flag means that the file may be excluded from
a directory listing if the application honors it.
FreeBSD has no special handling for this flag.
The name and bit definition for UF_HIDDEN are
identical to the definition in MacOS X.
UF_READONLY: Command line name: "urdonly", "rdonly", "readonly"
ZFS name: XAT_READONLY, ZFS_READONLY
Windows: FILE_ATTRIBUTE_READONLY
This flag means that the file may not written or
appended, but its attributes may be changed.
ZFS currently enforces this flag, but Illumos
developers have discussed disabling enforcement.
The behavior of this flag is different than MacOS X.
MacOS X uses UF_IMMUTABLE to represent the DOS
readonly permission, but that flag has a stronger
meaning than the semantics of DOS readonly permissions.
UF_ARCHIVE: Command line name: "uarch", "uarchive"
ZFS_NAME: XAT_ARCHIVE, ZFS_ARCHIVE
Windows name: FILE_ATTRIBUTE_ARCHIVE
The UF_ARCHIVED flag means that the file has changed and
needs to be archived. The meaning is same as
the Windows FILE_ATTRIBUTE_ARCHIVE attribute, and
the ZFS XAT_ARCHIVE and ZFS_ARCHIVE attribute.
msdosfs and ZFS have special handling for this flag.
i.e. they will set it when the file changes.
sys/param.h: Bump __FreeBSD_version to 1000047 for the
addition of new stat(2) flags.
chflags.1: Document the new command line flag names
(e.g. "system", "hidden") available to the
user.
ls.1: Reference chflags(1) for a list of file flags
and their meanings.
strtofflags.c: Implement the mapping between the new
command line flag names and new stat(2)
flags.
chflags.2: Document all of the new stat(2) flags, and
explain the intended behavior in a little
more detail. Explain how they map to
Windows file attributes.
Different filesystems behave differently
with respect to flags, so warn the
application developer to take care when
using them.
zfs_vnops.c: Add support for getting and setting the
UF_ARCHIVE, UF_READONLY, UF_SYSTEM, UF_HIDDEN,
UF_REPARSE, UF_OFFLINE, and UF_SPARSE flags.
All of these flags are implemented using
attributes that ZFS already supports, so
the on-disk format has not changed.
ZFS currently doesn't allow setting the
UF_REPARSE flag, and we don't really have
the other infrastructure to support reparse
points.
msdosfs_denode.c,
msdosfs_vnops.c: Add support for getting and setting
UF_HIDDEN, UF_SYSTEM and UF_READONLY
in MSDOSFS.
It supported SF_ARCHIVED, but this has been
changed to be UF_ARCHIVE, which has the same
semantics as the DOS archive attribute instead
of inverse semantics like SF_ARCHIVED.
After discussion with Bruce Evans, change
several things in the msdosfs behavior:
Use UF_READONLY to indicate whether a file
is writeable instead of file permissions, but
don't actually enforce it.
Refuse to change attributes on the root
directory, because it is special in FAT
filesystems, but allow most other attribute
changes on directories.
Don't set the archive attribute on a directory
when its modification time is updated.
Windows and DOS don't set the archive attribute
in that scenario, so we are now bug-for-bug
compatible.
smbfs_node.c,
smbfs_vnops.c: Add support for UF_HIDDEN, UF_SYSTEM,
UF_READONLY and UF_ARCHIVE in SMBFS.
This is similar to changes that Apple has
made in their version of SMBFS (as of
smb-583.8, posted on opensource.apple.com),
but not quite the same.
We map SMB_FA_READONLY to UF_READONLY,
because UF_READONLY is intended to match
the semantics of the DOS readonly flag.
The MacOS X code maps both UF_IMMUTABLE
and SF_IMMUTABLE to SMB_FA_READONLY, but
the immutable flags have stronger meaning
than the DOS readonly bit.
stat.h: Add definitions for UF_SYSTEM, UF_SPARSE,
UF_OFFLINE, UF_REPARSE, UF_ARCHIVE, UF_READONLY
and UF_HIDDEN.
The definition of UF_HIDDEN is the same as
the MacOS X definition.
Add commented-out definitions of
UF_COMPRESSED and UF_TRACKED. They are
defined in MacOS X (as of 10.8.2), but we
do not implement them (yet).
ufs_vnops.c: Add support for getting and setting
UF_ARCHIVE, UF_HIDDEN, UF_OFFLINE, UF_READONLY,
UF_REPARSE, UF_SPARSE, and UF_SYSTEM in UFS.
Alphabetize the flags that are supported.
These new flags are only stored, UFS does
not take any action if the flag is set.
Sponsored by: Spectra Logic
Reviewed by: bde (earlier version)
2013-08-21 23:04:48 +00:00
|
|
|
.It Cm opaque
|
|
|
|
|
set the opaque flag (owner or super-user only)
|
2006-03-10 12:37:19 +00:00
|
|
|
.It Cm sappnd , sappend
|
2000-12-19 16:00:12 +00:00
|
|
|
set the system append-only flag (super-user only)
|
2006-03-10 12:37:19 +00:00
|
|
|
.It Cm schg , schange , simmutable
|
2000-12-19 16:00:12 +00:00
|
|
|
set the system immutable flag (super-user only)
|
Expand the use of stat(2) flags to allow storing some Windows/DOS
and CIFS file attributes as BSD stat(2) flags.
This work is intended to be compatible with ZFS, the Solaris CIFS
server's interaction with ZFS, somewhat compatible with MacOS X,
and of course compatible with Windows.
The Windows attributes that are implemented were chosen based on
the attributes that ZFS already supports.
The summary of the flags is as follows:
UF_SYSTEM: Command line name: "system" or "usystem"
ZFS name: XAT_SYSTEM, ZFS_SYSTEM
Windows: FILE_ATTRIBUTE_SYSTEM
This flag means that the file is used by the
operating system. FreeBSD does not enforce any
special handling when this flag is set.
UF_SPARSE: Command line name: "sparse" or "usparse"
ZFS name: XAT_SPARSE, ZFS_SPARSE
Windows: FILE_ATTRIBUTE_SPARSE_FILE
This flag means that the file is sparse. Although
ZFS may modify this in some situations, there is
not generally any special handling for this flag.
UF_OFFLINE: Command line name: "offline" or "uoffline"
ZFS name: XAT_OFFLINE, ZFS_OFFLINE
Windows: FILE_ATTRIBUTE_OFFLINE
This flag means that the file has been moved to
offline storage. FreeBSD does not have any special
handling for this flag.
UF_REPARSE: Command line name: "reparse" or "ureparse"
ZFS name: XAT_REPARSE, ZFS_REPARSE
Windows: FILE_ATTRIBUTE_REPARSE_POINT
This flag means that the file is a Windows reparse
point. ZFS has special handling code for reparse
points, but we don't currently have the other
supporting infrastructure for them.
UF_HIDDEN: Command line name: "hidden" or "uhidden"
ZFS name: XAT_HIDDEN, ZFS_HIDDEN
Windows: FILE_ATTRIBUTE_HIDDEN
This flag means that the file may be excluded from
a directory listing if the application honors it.
FreeBSD has no special handling for this flag.
The name and bit definition for UF_HIDDEN are
identical to the definition in MacOS X.
UF_READONLY: Command line name: "urdonly", "rdonly", "readonly"
ZFS name: XAT_READONLY, ZFS_READONLY
Windows: FILE_ATTRIBUTE_READONLY
This flag means that the file may not written or
appended, but its attributes may be changed.
ZFS currently enforces this flag, but Illumos
developers have discussed disabling enforcement.
The behavior of this flag is different than MacOS X.
MacOS X uses UF_IMMUTABLE to represent the DOS
readonly permission, but that flag has a stronger
meaning than the semantics of DOS readonly permissions.
UF_ARCHIVE: Command line name: "uarch", "uarchive"
ZFS_NAME: XAT_ARCHIVE, ZFS_ARCHIVE
Windows name: FILE_ATTRIBUTE_ARCHIVE
The UF_ARCHIVED flag means that the file has changed and
needs to be archived. The meaning is same as
the Windows FILE_ATTRIBUTE_ARCHIVE attribute, and
the ZFS XAT_ARCHIVE and ZFS_ARCHIVE attribute.
msdosfs and ZFS have special handling for this flag.
i.e. they will set it when the file changes.
sys/param.h: Bump __FreeBSD_version to 1000047 for the
addition of new stat(2) flags.
chflags.1: Document the new command line flag names
(e.g. "system", "hidden") available to the
user.
ls.1: Reference chflags(1) for a list of file flags
and their meanings.
strtofflags.c: Implement the mapping between the new
command line flag names and new stat(2)
flags.
chflags.2: Document all of the new stat(2) flags, and
explain the intended behavior in a little
more detail. Explain how they map to
Windows file attributes.
Different filesystems behave differently
with respect to flags, so warn the
application developer to take care when
using them.
zfs_vnops.c: Add support for getting and setting the
UF_ARCHIVE, UF_READONLY, UF_SYSTEM, UF_HIDDEN,
UF_REPARSE, UF_OFFLINE, and UF_SPARSE flags.
All of these flags are implemented using
attributes that ZFS already supports, so
the on-disk format has not changed.
ZFS currently doesn't allow setting the
UF_REPARSE flag, and we don't really have
the other infrastructure to support reparse
points.
msdosfs_denode.c,
msdosfs_vnops.c: Add support for getting and setting
UF_HIDDEN, UF_SYSTEM and UF_READONLY
in MSDOSFS.
It supported SF_ARCHIVED, but this has been
changed to be UF_ARCHIVE, which has the same
semantics as the DOS archive attribute instead
of inverse semantics like SF_ARCHIVED.
After discussion with Bruce Evans, change
several things in the msdosfs behavior:
Use UF_READONLY to indicate whether a file
is writeable instead of file permissions, but
don't actually enforce it.
Refuse to change attributes on the root
directory, because it is special in FAT
filesystems, but allow most other attribute
changes on directories.
Don't set the archive attribute on a directory
when its modification time is updated.
Windows and DOS don't set the archive attribute
in that scenario, so we are now bug-for-bug
compatible.
smbfs_node.c,
smbfs_vnops.c: Add support for UF_HIDDEN, UF_SYSTEM,
UF_READONLY and UF_ARCHIVE in SMBFS.
This is similar to changes that Apple has
made in their version of SMBFS (as of
smb-583.8, posted on opensource.apple.com),
but not quite the same.
We map SMB_FA_READONLY to UF_READONLY,
because UF_READONLY is intended to match
the semantics of the DOS readonly flag.
The MacOS X code maps both UF_IMMUTABLE
and SF_IMMUTABLE to SMB_FA_READONLY, but
the immutable flags have stronger meaning
than the DOS readonly bit.
stat.h: Add definitions for UF_SYSTEM, UF_SPARSE,
UF_OFFLINE, UF_REPARSE, UF_ARCHIVE, UF_READONLY
and UF_HIDDEN.
The definition of UF_HIDDEN is the same as
the MacOS X definition.
Add commented-out definitions of
UF_COMPRESSED and UF_TRACKED. They are
defined in MacOS X (as of 10.8.2), but we
do not implement them (yet).
ufs_vnops.c: Add support for getting and setting
UF_ARCHIVE, UF_HIDDEN, UF_OFFLINE, UF_READONLY,
UF_REPARSE, UF_SPARSE, and UF_SYSTEM in UFS.
Alphabetize the flags that are supported.
These new flags are only stored, UFS does
not take any action if the flag is set.
Sponsored by: Spectra Logic
Reviewed by: bde (earlier version)
2013-08-21 23:04:48 +00:00
|
|
|
.It Cm snapshot
|
|
|
|
|
set the snapshot flag (filesystems do not allow changing this flag)
|
2006-03-10 12:37:19 +00:00
|
|
|
.It Cm sunlnk , sunlink
|
2000-12-19 16:00:12 +00:00
|
|
|
set the system undeletable flag (super-user only)
|
2006-03-10 12:37:19 +00:00
|
|
|
.It Cm uappnd , uappend
|
2000-12-19 16:00:12 +00:00
|
|
|
set the user append-only flag (owner or super-user only)
|
Expand the use of stat(2) flags to allow storing some Windows/DOS
and CIFS file attributes as BSD stat(2) flags.
This work is intended to be compatible with ZFS, the Solaris CIFS
server's interaction with ZFS, somewhat compatible with MacOS X,
and of course compatible with Windows.
The Windows attributes that are implemented were chosen based on
the attributes that ZFS already supports.
The summary of the flags is as follows:
UF_SYSTEM: Command line name: "system" or "usystem"
ZFS name: XAT_SYSTEM, ZFS_SYSTEM
Windows: FILE_ATTRIBUTE_SYSTEM
This flag means that the file is used by the
operating system. FreeBSD does not enforce any
special handling when this flag is set.
UF_SPARSE: Command line name: "sparse" or "usparse"
ZFS name: XAT_SPARSE, ZFS_SPARSE
Windows: FILE_ATTRIBUTE_SPARSE_FILE
This flag means that the file is sparse. Although
ZFS may modify this in some situations, there is
not generally any special handling for this flag.
UF_OFFLINE: Command line name: "offline" or "uoffline"
ZFS name: XAT_OFFLINE, ZFS_OFFLINE
Windows: FILE_ATTRIBUTE_OFFLINE
This flag means that the file has been moved to
offline storage. FreeBSD does not have any special
handling for this flag.
UF_REPARSE: Command line name: "reparse" or "ureparse"
ZFS name: XAT_REPARSE, ZFS_REPARSE
Windows: FILE_ATTRIBUTE_REPARSE_POINT
This flag means that the file is a Windows reparse
point. ZFS has special handling code for reparse
points, but we don't currently have the other
supporting infrastructure for them.
UF_HIDDEN: Command line name: "hidden" or "uhidden"
ZFS name: XAT_HIDDEN, ZFS_HIDDEN
Windows: FILE_ATTRIBUTE_HIDDEN
This flag means that the file may be excluded from
a directory listing if the application honors it.
FreeBSD has no special handling for this flag.
The name and bit definition for UF_HIDDEN are
identical to the definition in MacOS X.
UF_READONLY: Command line name: "urdonly", "rdonly", "readonly"
ZFS name: XAT_READONLY, ZFS_READONLY
Windows: FILE_ATTRIBUTE_READONLY
This flag means that the file may not written or
appended, but its attributes may be changed.
ZFS currently enforces this flag, but Illumos
developers have discussed disabling enforcement.
The behavior of this flag is different than MacOS X.
MacOS X uses UF_IMMUTABLE to represent the DOS
readonly permission, but that flag has a stronger
meaning than the semantics of DOS readonly permissions.
UF_ARCHIVE: Command line name: "uarch", "uarchive"
ZFS_NAME: XAT_ARCHIVE, ZFS_ARCHIVE
Windows name: FILE_ATTRIBUTE_ARCHIVE
The UF_ARCHIVED flag means that the file has changed and
needs to be archived. The meaning is same as
the Windows FILE_ATTRIBUTE_ARCHIVE attribute, and
the ZFS XAT_ARCHIVE and ZFS_ARCHIVE attribute.
msdosfs and ZFS have special handling for this flag.
i.e. they will set it when the file changes.
sys/param.h: Bump __FreeBSD_version to 1000047 for the
addition of new stat(2) flags.
chflags.1: Document the new command line flag names
(e.g. "system", "hidden") available to the
user.
ls.1: Reference chflags(1) for a list of file flags
and their meanings.
strtofflags.c: Implement the mapping between the new
command line flag names and new stat(2)
flags.
chflags.2: Document all of the new stat(2) flags, and
explain the intended behavior in a little
more detail. Explain how they map to
Windows file attributes.
Different filesystems behave differently
with respect to flags, so warn the
application developer to take care when
using them.
zfs_vnops.c: Add support for getting and setting the
UF_ARCHIVE, UF_READONLY, UF_SYSTEM, UF_HIDDEN,
UF_REPARSE, UF_OFFLINE, and UF_SPARSE flags.
All of these flags are implemented using
attributes that ZFS already supports, so
the on-disk format has not changed.
ZFS currently doesn't allow setting the
UF_REPARSE flag, and we don't really have
the other infrastructure to support reparse
points.
msdosfs_denode.c,
msdosfs_vnops.c: Add support for getting and setting
UF_HIDDEN, UF_SYSTEM and UF_READONLY
in MSDOSFS.
It supported SF_ARCHIVED, but this has been
changed to be UF_ARCHIVE, which has the same
semantics as the DOS archive attribute instead
of inverse semantics like SF_ARCHIVED.
After discussion with Bruce Evans, change
several things in the msdosfs behavior:
Use UF_READONLY to indicate whether a file
is writeable instead of file permissions, but
don't actually enforce it.
Refuse to change attributes on the root
directory, because it is special in FAT
filesystems, but allow most other attribute
changes on directories.
Don't set the archive attribute on a directory
when its modification time is updated.
Windows and DOS don't set the archive attribute
in that scenario, so we are now bug-for-bug
compatible.
smbfs_node.c,
smbfs_vnops.c: Add support for UF_HIDDEN, UF_SYSTEM,
UF_READONLY and UF_ARCHIVE in SMBFS.
This is similar to changes that Apple has
made in their version of SMBFS (as of
smb-583.8, posted on opensource.apple.com),
but not quite the same.
We map SMB_FA_READONLY to UF_READONLY,
because UF_READONLY is intended to match
the semantics of the DOS readonly flag.
The MacOS X code maps both UF_IMMUTABLE
and SF_IMMUTABLE to SMB_FA_READONLY, but
the immutable flags have stronger meaning
than the DOS readonly bit.
stat.h: Add definitions for UF_SYSTEM, UF_SPARSE,
UF_OFFLINE, UF_REPARSE, UF_ARCHIVE, UF_READONLY
and UF_HIDDEN.
The definition of UF_HIDDEN is the same as
the MacOS X definition.
Add commented-out definitions of
UF_COMPRESSED and UF_TRACKED. They are
defined in MacOS X (as of 10.8.2), but we
do not implement them (yet).
ufs_vnops.c: Add support for getting and setting
UF_ARCHIVE, UF_HIDDEN, UF_OFFLINE, UF_READONLY,
UF_REPARSE, UF_SPARSE, and UF_SYSTEM in UFS.
Alphabetize the flags that are supported.
These new flags are only stored, UFS does
not take any action if the flag is set.
Sponsored by: Spectra Logic
Reviewed by: bde (earlier version)
2013-08-21 23:04:48 +00:00
|
|
|
.It Cm uarch , uarchive
|
|
|
|
|
set the archive flag (owner or super-user only)
|
2006-03-10 12:37:19 +00:00
|
|
|
.It Cm uchg , uchange , uimmutable
|
2000-12-19 16:00:12 +00:00
|
|
|
set the user immutable flag (owner or super-user only)
|
Expand the use of stat(2) flags to allow storing some Windows/DOS
and CIFS file attributes as BSD stat(2) flags.
This work is intended to be compatible with ZFS, the Solaris CIFS
server's interaction with ZFS, somewhat compatible with MacOS X,
and of course compatible with Windows.
The Windows attributes that are implemented were chosen based on
the attributes that ZFS already supports.
The summary of the flags is as follows:
UF_SYSTEM: Command line name: "system" or "usystem"
ZFS name: XAT_SYSTEM, ZFS_SYSTEM
Windows: FILE_ATTRIBUTE_SYSTEM
This flag means that the file is used by the
operating system. FreeBSD does not enforce any
special handling when this flag is set.
UF_SPARSE: Command line name: "sparse" or "usparse"
ZFS name: XAT_SPARSE, ZFS_SPARSE
Windows: FILE_ATTRIBUTE_SPARSE_FILE
This flag means that the file is sparse. Although
ZFS may modify this in some situations, there is
not generally any special handling for this flag.
UF_OFFLINE: Command line name: "offline" or "uoffline"
ZFS name: XAT_OFFLINE, ZFS_OFFLINE
Windows: FILE_ATTRIBUTE_OFFLINE
This flag means that the file has been moved to
offline storage. FreeBSD does not have any special
handling for this flag.
UF_REPARSE: Command line name: "reparse" or "ureparse"
ZFS name: XAT_REPARSE, ZFS_REPARSE
Windows: FILE_ATTRIBUTE_REPARSE_POINT
This flag means that the file is a Windows reparse
point. ZFS has special handling code for reparse
points, but we don't currently have the other
supporting infrastructure for them.
UF_HIDDEN: Command line name: "hidden" or "uhidden"
ZFS name: XAT_HIDDEN, ZFS_HIDDEN
Windows: FILE_ATTRIBUTE_HIDDEN
This flag means that the file may be excluded from
a directory listing if the application honors it.
FreeBSD has no special handling for this flag.
The name and bit definition for UF_HIDDEN are
identical to the definition in MacOS X.
UF_READONLY: Command line name: "urdonly", "rdonly", "readonly"
ZFS name: XAT_READONLY, ZFS_READONLY
Windows: FILE_ATTRIBUTE_READONLY
This flag means that the file may not written or
appended, but its attributes may be changed.
ZFS currently enforces this flag, but Illumos
developers have discussed disabling enforcement.
The behavior of this flag is different than MacOS X.
MacOS X uses UF_IMMUTABLE to represent the DOS
readonly permission, but that flag has a stronger
meaning than the semantics of DOS readonly permissions.
UF_ARCHIVE: Command line name: "uarch", "uarchive"
ZFS_NAME: XAT_ARCHIVE, ZFS_ARCHIVE
Windows name: FILE_ATTRIBUTE_ARCHIVE
The UF_ARCHIVED flag means that the file has changed and
needs to be archived. The meaning is same as
the Windows FILE_ATTRIBUTE_ARCHIVE attribute, and
the ZFS XAT_ARCHIVE and ZFS_ARCHIVE attribute.
msdosfs and ZFS have special handling for this flag.
i.e. they will set it when the file changes.
sys/param.h: Bump __FreeBSD_version to 1000047 for the
addition of new stat(2) flags.
chflags.1: Document the new command line flag names
(e.g. "system", "hidden") available to the
user.
ls.1: Reference chflags(1) for a list of file flags
and their meanings.
strtofflags.c: Implement the mapping between the new
command line flag names and new stat(2)
flags.
chflags.2: Document all of the new stat(2) flags, and
explain the intended behavior in a little
more detail. Explain how they map to
Windows file attributes.
Different filesystems behave differently
with respect to flags, so warn the
application developer to take care when
using them.
zfs_vnops.c: Add support for getting and setting the
UF_ARCHIVE, UF_READONLY, UF_SYSTEM, UF_HIDDEN,
UF_REPARSE, UF_OFFLINE, and UF_SPARSE flags.
All of these flags are implemented using
attributes that ZFS already supports, so
the on-disk format has not changed.
ZFS currently doesn't allow setting the
UF_REPARSE flag, and we don't really have
the other infrastructure to support reparse
points.
msdosfs_denode.c,
msdosfs_vnops.c: Add support for getting and setting
UF_HIDDEN, UF_SYSTEM and UF_READONLY
in MSDOSFS.
It supported SF_ARCHIVED, but this has been
changed to be UF_ARCHIVE, which has the same
semantics as the DOS archive attribute instead
of inverse semantics like SF_ARCHIVED.
After discussion with Bruce Evans, change
several things in the msdosfs behavior:
Use UF_READONLY to indicate whether a file
is writeable instead of file permissions, but
don't actually enforce it.
Refuse to change attributes on the root
directory, because it is special in FAT
filesystems, but allow most other attribute
changes on directories.
Don't set the archive attribute on a directory
when its modification time is updated.
Windows and DOS don't set the archive attribute
in that scenario, so we are now bug-for-bug
compatible.
smbfs_node.c,
smbfs_vnops.c: Add support for UF_HIDDEN, UF_SYSTEM,
UF_READONLY and UF_ARCHIVE in SMBFS.
This is similar to changes that Apple has
made in their version of SMBFS (as of
smb-583.8, posted on opensource.apple.com),
but not quite the same.
We map SMB_FA_READONLY to UF_READONLY,
because UF_READONLY is intended to match
the semantics of the DOS readonly flag.
The MacOS X code maps both UF_IMMUTABLE
and SF_IMMUTABLE to SMB_FA_READONLY, but
the immutable flags have stronger meaning
than the DOS readonly bit.
stat.h: Add definitions for UF_SYSTEM, UF_SPARSE,
UF_OFFLINE, UF_REPARSE, UF_ARCHIVE, UF_READONLY
and UF_HIDDEN.
The definition of UF_HIDDEN is the same as
the MacOS X definition.
Add commented-out definitions of
UF_COMPRESSED and UF_TRACKED. They are
defined in MacOS X (as of 10.8.2), but we
do not implement them (yet).
ufs_vnops.c: Add support for getting and setting
UF_ARCHIVE, UF_HIDDEN, UF_OFFLINE, UF_READONLY,
UF_REPARSE, UF_SPARSE, and UF_SYSTEM in UFS.
Alphabetize the flags that are supported.
These new flags are only stored, UFS does
not take any action if the flag is set.
Sponsored by: Spectra Logic
Reviewed by: bde (earlier version)
2013-08-21 23:04:48 +00:00
|
|
|
.It Cm uhidden , hidden
|
|
|
|
|
set the hidden file attribute (owner or super-user only)
|
|
|
|
|
.It Cm uoffline , offline
|
|
|
|
|
set the offline file attribute (owner or super-user only)
|
|
|
|
|
.It Cm urdonly , rdonly , readonly
|
|
|
|
|
set the DOS, Windows and CIFS readonly flag (owner or super-user only)
|
|
|
|
|
.It Cm usparse , sparse
|
|
|
|
|
set the sparse file attribute (owner or super-user only)
|
|
|
|
|
.It Cm usystem , system
|
|
|
|
|
set the DOS, Windows and CIFS system flag (owner or super-user only)
|
|
|
|
|
.It Cm ureparse , reparse
|
|
|
|
|
set the Windows reparse point file attribute (owner or super-user only)
|
2006-03-10 12:37:19 +00:00
|
|
|
.It Cm uunlnk , uunlink
|
2000-12-19 16:00:12 +00:00
|
|
|
set the user undeletable flag (owner or super-user only)
|
|
|
|
|
.El
|
1994-05-27 12:33:43 +00:00
|
|
|
.Pp
|
|
|
|
|
Putting the letters
|
2000-12-19 16:00:12 +00:00
|
|
|
.Dq Ar no
|
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.
|
1994-05-27 12:33:43 +00:00
|
|
|
For example:
|
2003-03-24 20:15:58 +00:00
|
|
|
.Pp
|
|
|
|
|
.Bl -tag -offset indent -width "nouchg" -compact
|
2006-03-10 12:37:19 +00:00
|
|
|
.It Cm nouchg
|
2003-03-24 20:15:58 +00:00
|
|
|
clear the user immutable flag (owner or super-user only)
|
2006-03-10 12:37:19 +00:00
|
|
|
.It Cm dump
|
2003-03-24 20:15:58 +00:00
|
|
|
clear the nodump flag (owner or super-user only)
|
2000-12-19 16:00:12 +00:00
|
|
|
.El
|
1994-05-27 12:33:43 +00:00
|
|
|
.Pp
|
2006-03-04 02:38:40 +00:00
|
|
|
A few of the octal values include:
|
2006-03-06 10:12:14 +00:00
|
|
|
.Bl -tag -offset indent -width ".Li 10"
|
2006-03-04 02:38:40 +00:00
|
|
|
.It Li 0
|
|
|
|
|
Clear all file flags.
|
|
|
|
|
.It Li 1
|
|
|
|
|
Translates to the
|
2006-03-06 10:12:14 +00:00
|
|
|
.Cm nodump
|
2006-03-04 02:38:40 +00:00
|
|
|
keyword.
|
|
|
|
|
.It Li 2
|
|
|
|
|
Translates to the
|
2006-03-06 10:12:14 +00:00
|
|
|
.Cm uchg
|
2006-03-04 02:38:40 +00:00
|
|
|
keyword.
|
|
|
|
|
.It Li 3
|
|
|
|
|
Translates to the
|
2006-03-06 10:12:14 +00:00
|
|
|
.Cm uchg , nodump
|
2006-03-04 02:38:40 +00:00
|
|
|
keywords.
|
|
|
|
|
.It Li 4
|
|
|
|
|
Translates to the
|
2006-03-06 10:12:14 +00:00
|
|
|
.Cm uappnd
|
2006-03-04 02:38:40 +00:00
|
|
|
keyword.
|
|
|
|
|
.It Li 10
|
|
|
|
|
Translates to the
|
2006-03-06 10:12:14 +00:00
|
|
|
.Cm opaque
|
2006-03-04 02:38:40 +00:00
|
|
|
keyword.
|
|
|
|
|
.It Li 20
|
|
|
|
|
translates to the
|
2006-03-06 10:12:14 +00:00
|
|
|
.Cm uunlnk
|
2006-03-04 02:38:40 +00:00
|
|
|
keyword.
|
|
|
|
|
.El
|
|
|
|
|
.Pp
|
|
|
|
|
Other combinations of keywords may be placed by using
|
|
|
|
|
the octets assigned; however, these are the most notable.
|
|
|
|
|
.Pp
|
2005-05-14 23:23:10 +00:00
|
|
|
Unless the
|
|
|
|
|
.Fl H ,
|
|
|
|
|
.Fl L ,
|
1994-05-27 12:33:43 +00:00
|
|
|
or
|
2005-05-14 23:23:10 +00:00
|
|
|
.Fl h
|
|
|
|
|
options are given,
|
1999-11-21 16:11:56 +00:00
|
|
|
.Nm
|
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
|
1997-06-24 06:57:11 +00:00
|
|
|
You can use "ls -lo" to see the flags of existing files.
|
2006-03-04 02:38:40 +00:00
|
|
|
.Pp
|
|
|
|
|
Note that the ability to change certain flags is dependent
|
|
|
|
|
on the current kernel
|
2006-03-06 10:12:14 +00:00
|
|
|
.Va securelevel
|
2006-03-04 02:38:40 +00:00
|
|
|
setting.
|
|
|
|
|
See
|
|
|
|
|
.Xr security 7
|
|
|
|
|
for more information on this setting.
|
2005-01-16 16:41:59 +00:00
|
|
|
.Sh EXIT STATUS
|
2001-08-15 09:09:47 +00:00
|
|
|
.Ex -std
|
1994-05-27 12:33:43 +00:00
|
|
|
.Sh SEE ALSO
|
1997-06-24 06:57:11 +00:00
|
|
|
.Xr ls 1 ,
|
1994-05-27 12:33:43 +00:00
|
|
|
.Xr chflags 2 ,
|
|
|
|
|
.Xr stat 2 ,
|
|
|
|
|
.Xr fts 3 ,
|
2006-03-04 02:38:40 +00:00
|
|
|
.Xr security 7 ,
|
1994-05-27 12:33:43 +00:00
|
|
|
.Xr symlink 7
|
2005-06-14 08:25:54 +00:00
|
|
|
.Sh HISTORY
|
|
|
|
|
The
|
|
|
|
|
.Nm
|
|
|
|
|
command first appeared in
|
|
|
|
|
.Bx 4.4 .
|
2005-02-23 23:07:45 +00:00
|
|
|
.Sh BUGS
|
|
|
|
|
Only a limited number of utilities are
|
|
|
|
|
.Nm
|
|
|
|
|
aware.
|
2005-02-25 00:40:46 +00:00
|
|
|
Some of these tools include
|
2005-02-23 23:07:45 +00:00
|
|
|
.Xr ls 1 ,
|
|
|
|
|
.Xr cp 1 ,
|
|
|
|
|
.Xr find 1 ,
|
2005-02-25 00:40:46 +00:00
|
|
|
.Xr install 1 ,
|
2005-02-23 23:07:45 +00:00
|
|
|
.Xr dump 8 ,
|
|
|
|
|
and
|
|
|
|
|
.Xr restore 8 .
|
2005-02-25 00:40:46 +00:00
|
|
|
In particular a tool which is not currently
|
2005-02-23 23:07:45 +00:00
|
|
|
.Nm
|
2005-02-25 00:40:46 +00:00
|
|
|
aware is the
|
|
|
|
|
.Xr pax 1
|
|
|
|
|
utility.
|
