1994-05-27 05:00:24 +00:00
|
|
|
.\" Copyright (c) 1989, 1993
|
|
|
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
|
|
|
.\"
|
|
|
|
|
.\" 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.
|
|
|
|
|
.\"
|
1997-03-11 11:35:56 +00:00
|
|
|
.\" @(#)chflags.2 8.3 (Berkeley) 5/2/95
|
1999-08-28 00:22:10 +00:00
|
|
|
.\" $FreeBSD$
|
1994-05-27 05:00:24 +00:00
|
|
|
.\"
|
2013-03-21 23:05:44 +00:00
|
|
|
.Dd March 22, 2013
|
1994-05-27 05:00:24 +00:00
|
|
|
.Dt CHFLAGS 2
|
|
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm chflags ,
|
2002-05-05 23:51:32 +00:00
|
|
|
.Nm lchflags ,
|
1994-05-27 05:00:24 +00:00
|
|
|
.Nm fchflags
|
|
|
|
|
.Nd set file flags
|
2000-04-21 09:42:15 +00:00
|
|
|
.Sh LIBRARY
|
|
|
|
|
.Lb libc
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh SYNOPSIS
|
2001-10-01 16:09:29 +00:00
|
|
|
.In sys/stat.h
|
|
|
|
|
.In unistd.h
|
1994-05-27 05:00:24 +00:00
|
|
|
.Ft int
|
2013-03-21 22:44:33 +00:00
|
|
|
.Fn chflags "const char *path" "unsigned long flags"
|
1994-05-27 05:00:24 +00:00
|
|
|
.Ft int
|
2013-03-21 22:44:33 +00:00
|
|
|
.Fn lchflags "const char *path" "unsigned long flags"
|
2002-05-05 23:51:32 +00:00
|
|
|
.Ft int
|
2013-03-21 22:44:33 +00:00
|
|
|
.Fn fchflags "int fd" "unsigned long flags"
|
2013-03-21 23:05:44 +00:00
|
|
|
.Ft int
|
|
|
|
|
.Fn chflagsat "int fd" "const char *path" "unsigned long flags" "int atflag"
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The file whose name
|
|
|
|
|
is given by
|
|
|
|
|
.Fa path
|
|
|
|
|
or referenced by the descriptor
|
|
|
|
|
.Fa fd
|
|
|
|
|
has its flags changed to
|
|
|
|
|
.Fa flags .
|
|
|
|
|
.Pp
|
2002-05-05 23:51:32 +00:00
|
|
|
The
|
|
|
|
|
.Fn lchflags
|
|
|
|
|
system call is like
|
|
|
|
|
.Fn chflags
|
|
|
|
|
except in the case where the named file is a symbolic link,
|
|
|
|
|
in which case
|
|
|
|
|
.Fn lchflags
|
|
|
|
|
will change the flags of the link itself,
|
|
|
|
|
rather than the file it points to.
|
|
|
|
|
.Pp
|
2013-03-21 23:05:44 +00:00
|
|
|
The
|
|
|
|
|
.Fn chflagsat
|
|
|
|
|
is equivalent to either
|
|
|
|
|
.Fn chflags
|
|
|
|
|
or
|
|
|
|
|
.Fn lchflags
|
|
|
|
|
depending on the
|
|
|
|
|
.Fa atflag
|
|
|
|
|
except in the case where
|
|
|
|
|
.Fa path
|
|
|
|
|
specifies a relative path.
|
|
|
|
|
In this case the file to be changed is determined relative to the directory
|
|
|
|
|
associated with the file descriptor
|
|
|
|
|
.Fa fd
|
|
|
|
|
instead of the current working directory.
|
|
|
|
|
The values for the
|
|
|
|
|
.Fa atflag
|
|
|
|
|
are constructed by a bitwise-inclusive OR of flags from the following list,
|
|
|
|
|
defined in
|
|
|
|
|
.In fcntl.h :
|
|
|
|
|
.Bl -tag -width indent
|
|
|
|
|
.It Dv AT_SYMLINK_NOFOLLOW
|
|
|
|
|
If
|
|
|
|
|
.Fa path
|
|
|
|
|
names a symbolic link, then the flags of the symbolic link are changed.
|
|
|
|
|
.El
|
|
|
|
|
.Pp
|
|
|
|
|
If
|
|
|
|
|
.Fn chflagsat
|
|
|
|
|
is passed the special value
|
|
|
|
|
.Dv AT_FDCWD
|
|
|
|
|
in the
|
|
|
|
|
.Fa fd
|
|
|
|
|
parameter, the current working directory is used.
|
|
|
|
|
If also
|
|
|
|
|
.Fa atflag
|
|
|
|
|
is zero, the behavior is identical to a call to
|
|
|
|
|
.Fn chflags .
|
|
|
|
|
.Pp
|
1994-05-27 05:00:24 +00:00
|
|
|
The flags specified are formed by
|
|
|
|
|
.Em or Ns 'ing
|
|
|
|
|
the following values
|
|
|
|
|
.Pp
|
2006-09-17 21:27:35 +00:00
|
|
|
.Bl -tag -width ".Dv SF_IMMUTABLE" -compact -offset indent
|
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 Dv SF_APPEND
|
1994-05-27 05:00:24 +00:00
|
|
|
The file may only be appended to.
|
2006-09-17 21:27:35 +00:00
|
|
|
.It Dv SF_ARCHIVED
|
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
|
|
|
The file has been archived.
|
|
|
|
|
This flag means the opposite of the DOS, Windows and CIFS
|
|
|
|
|
FILE_ATTRIBUTE_ARCHIVE attribute.
|
|
|
|
|
This flag has been deprecated, and may be removed in a future release.
|
2006-09-17 21:27:35 +00:00
|
|
|
.It Dv SF_IMMUTABLE
|
1994-05-27 05:00:24 +00:00
|
|
|
The file may not be changed.
|
2006-09-17 21:27:35 +00:00
|
|
|
.It Dv SF_NOUNLINK
|
1997-06-02 06:24:52 +00:00
|
|
|
The file may not be renamed or deleted.
|
2006-09-17 21:27:35 +00:00
|
|
|
.It Dv SF_SNAPSHOT
|
2006-05-16 20:24:41 +00:00
|
|
|
The file is a snapshot file.
|
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 Dv UF_APPEND
|
|
|
|
|
The file may only be appended to.
|
|
|
|
|
.It Dv UF_ARCHIVE
|
|
|
|
|
The file needs to be archived.
|
|
|
|
|
This flag has the same meaning as the DOS, Windows and CIFS
|
|
|
|
|
FILE_ATTRIBUTE_ARCHIVE attribute.
|
|
|
|
|
Filesystems in FreeBSD may or may not have special handling for this flag.
|
|
|
|
|
For instance, ZFS tracks changes to files and will set this bit when a
|
|
|
|
|
file is updated.
|
|
|
|
|
UFS only stores the flag, and relies on the application to change it when
|
|
|
|
|
needed.
|
|
|
|
|
.It Dv UF_HIDDEN
|
|
|
|
|
The file may be hidden from directory listings at the application's
|
|
|
|
|
discretion.
|
|
|
|
|
The file has the DOS, Windows and CIFS FILE_ATTRIBUTE_HIDDEN attribute.
|
|
|
|
|
.It Dv UF_IMMUTABLE
|
|
|
|
|
The file may not be changed.
|
|
|
|
|
.It Dv UF_NODUMP
|
|
|
|
|
Do not dump the file.
|
|
|
|
|
.It Dv UF_NOUNLINK
|
|
|
|
|
The file may not be renamed or deleted.
|
|
|
|
|
.It Dv UF_OFFLINE
|
|
|
|
|
The file is offline, or has the Windows and CIFS FILE_ATTRIBUTE_OFFLINE
|
|
|
|
|
attribute.
|
|
|
|
|
Filesystems in FreeBSD store and display this flag, but do not provide any
|
|
|
|
|
special handling when it is set.
|
|
|
|
|
.It Dv UF_OPAQUE
|
|
|
|
|
The directory is opaque when viewed through a union stack.
|
|
|
|
|
.It Dv UF_READONLY
|
|
|
|
|
The file is read only, and may not be written or appended.
|
|
|
|
|
Filesystems may use this flag to maintain compatibility with the DOS, Windows
|
|
|
|
|
and CIFS FILE_ATTRIBUTE_READONLY attribute.
|
|
|
|
|
.It Dv UF_REPARSE
|
|
|
|
|
The file contains a Windows reparse point and has the Windows and CIFS
|
|
|
|
|
FILE_ATTRIBUTE_REPARSE_POINT attribute.
|
|
|
|
|
.It Dv UF_SPARSE
|
|
|
|
|
The file has the Windows FILE_ATTRIBUTE_SPARSE_FILE attribute.
|
|
|
|
|
This may also be used by a filesystem to indicate a sparse file.
|
|
|
|
|
.It Dv UF_SYSTEM
|
|
|
|
|
The file has the DOS, Windows and CIFS FILE_ATTRIBUTE_SYSTEM attribute.
|
|
|
|
|
Filesystems in FreeBSD may store and display this flag, but do not provide
|
|
|
|
|
any special handling when it is set.
|
1994-05-27 05:00:24 +00:00
|
|
|
.El
|
|
|
|
|
.Pp
|
2006-09-17 21:27:35 +00:00
|
|
|
If one of
|
|
|
|
|
.Dv SF_IMMUTABLE , SF_APPEND ,
|
2006-05-16 20:24:41 +00:00
|
|
|
or
|
2006-09-17 21:27:35 +00:00
|
|
|
.Dv SF_NOUNLINK
|
2006-05-16 20:24:41 +00:00
|
|
|
is set a non-super-user cannot change any flags and even the super-user
|
2013-02-09 17:13:51 +00:00
|
|
|
can change flags only if securelevel is 0.
|
2006-05-16 20:24:41 +00:00
|
|
|
(See
|
|
|
|
|
.Xr init 8
|
|
|
|
|
for details.)
|
|
|
|
|
.Pp
|
1994-05-27 05:00:24 +00:00
|
|
|
The
|
2006-09-17 21:27:35 +00:00
|
|
|
.Dv UF_IMMUTABLE , UF_APPEND , UF_NOUNLINK , UF_NODUMP ,
|
1997-06-02 06:24:52 +00:00
|
|
|
and
|
2006-09-17 21:27:35 +00:00
|
|
|
.Dv UF_OPAQUE
|
1994-05-27 05:00:24 +00:00
|
|
|
flags may be set or unset by either the owner of a file or the super-user.
|
|
|
|
|
.Pp
|
|
|
|
|
The
|
2006-09-17 21:27:35 +00:00
|
|
|
.Dv SF_IMMUTABLE , SF_APPEND , SF_NOUNLINK ,
|
1997-06-02 06:24:52 +00:00
|
|
|
and
|
2006-09-17 21:27:35 +00:00
|
|
|
.Dv SF_ARCHIVED
|
1994-05-27 05:00:24 +00:00
|
|
|
flags may only be set or unset by the super-user.
|
2012-04-10 15:59:37 +00:00
|
|
|
Attempts to toggle these flags by non-super-users are rejected.
|
1997-03-11 11:35:56 +00:00
|
|
|
These flags may be set at any time, but normally may only be unset when
|
1994-05-27 05:00:24 +00:00
|
|
|
the system is in single-user mode.
|
|
|
|
|
(See
|
|
|
|
|
.Xr init 8
|
|
|
|
|
for details.)
|
2006-05-16 20:24:41 +00:00
|
|
|
.Pp
|
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
|
|
|
The implementation of all flags is filesystem-dependent.
|
|
|
|
|
See the description of the
|
|
|
|
|
.Dv UF_ARCHIVE
|
|
|
|
|
flag above for one example of the differences in behavior.
|
|
|
|
|
Care should be exercised when writing applications to account for
|
|
|
|
|
support or lack of support of these flags in various filesystems.
|
|
|
|
|
.Pp
|
2006-05-16 20:24:41 +00:00
|
|
|
The
|
2006-09-17 21:27:35 +00:00
|
|
|
.Dv SF_SNAPSHOT
|
2012-04-13 05:40:26 +00:00
|
|
|
flag is maintained by the system and cannot be toggled.
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh RETURN VALUES
|
2001-08-31 09:57:38 +00:00
|
|
|
.Rv -std
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh ERRORS
|
2002-07-15 20:59:12 +00:00
|
|
|
The
|
|
|
|
|
.Fn chflags
|
2002-12-18 09:22:32 +00:00
|
|
|
system call will fail if:
|
1994-05-27 05:00:24 +00:00
|
|
|
.Bl -tag -width Er
|
|
|
|
|
.It Bq Er ENOTDIR
|
|
|
|
|
A component of the path prefix is not a directory.
|
|
|
|
|
.It Bq Er ENAMETOOLONG
|
|
|
|
|
A component of a pathname exceeded 255 characters,
|
|
|
|
|
or an entire path name exceeded 1023 characters.
|
|
|
|
|
.It Bq Er ENOENT
|
|
|
|
|
The named file does not exist.
|
|
|
|
|
.It Bq Er EACCES
|
|
|
|
|
Search permission is denied for a component of the path prefix.
|
|
|
|
|
.It Bq Er ELOOP
|
|
|
|
|
Too many symbolic links were encountered in translating the pathname.
|
|
|
|
|
.It Bq Er EPERM
|
|
|
|
|
The effective user ID does not match the owner of the file and
|
|
|
|
|
the effective user ID is not the super-user.
|
2006-05-16 20:24:41 +00:00
|
|
|
.It Bq Er EPERM
|
|
|
|
|
One of
|
2006-09-17 21:27:35 +00:00
|
|
|
.Dv SF_IMMUTABLE , SF_APPEND ,
|
2006-05-16 20:24:41 +00:00
|
|
|
or
|
2006-09-17 21:27:35 +00:00
|
|
|
.Dv SF_NOUNLINK
|
2006-05-16 20:24:41 +00:00
|
|
|
is set and the user is either not the super-user or
|
|
|
|
|
securelevel is greater than 0.
|
|
|
|
|
.It Bq Er EPERM
|
2012-04-13 05:40:26 +00:00
|
|
|
A non-super-user attempted to toggle one of
|
2010-10-29 15:03:29 +00:00
|
|
|
.Dv SF_ARCHIVED , SF_IMMUTABLE , SF_APPEND ,
|
2006-05-16 20:24:41 +00:00
|
|
|
or
|
2006-09-17 21:27:35 +00:00
|
|
|
.Dv SF_NOUNLINK .
|
2006-12-15 19:23:27 +00:00
|
|
|
.It Bq Er EPERM
|
2012-04-13 05:40:26 +00:00
|
|
|
An attempt was made to toggle the
|
2006-12-15 19:23:27 +00:00
|
|
|
.Dv SF_SNAPSHOT
|
|
|
|
|
flag.
|
1994-05-27 05:00:24 +00:00
|
|
|
.It Bq Er EROFS
|
|
|
|
|
The named file resides on a read-only file system.
|
|
|
|
|
.It Bq Er EFAULT
|
2002-12-19 09:40:28 +00:00
|
|
|
The
|
|
|
|
|
.Fa path
|
|
|
|
|
argument
|
1994-05-27 05:00:24 +00:00
|
|
|
points outside the process's allocated address space.
|
|
|
|
|
.It Bq Er EIO
|
|
|
|
|
An
|
|
|
|
|
.Tn I/O
|
|
|
|
|
error occurred while reading from or writing to the file system.
|
1999-02-14 13:58:18 +00:00
|
|
|
.It Bq Er EOPNOTSUPP
|
2012-04-13 05:40:26 +00:00
|
|
|
The underlying file system does not support file flags, or
|
|
|
|
|
does not support all of the flags set in
|
|
|
|
|
.Fa flags .
|
1994-05-27 05:00:24 +00:00
|
|
|
.El
|
|
|
|
|
.Pp
|
2002-07-15 20:59:12 +00:00
|
|
|
The
|
|
|
|
|
.Fn fchflags
|
2002-12-18 09:22:32 +00:00
|
|
|
system call will fail if:
|
1994-05-27 05:00:24 +00:00
|
|
|
.Bl -tag -width Er
|
|
|
|
|
.It Bq Er EBADF
|
|
|
|
|
The descriptor is not valid.
|
|
|
|
|
.It Bq Er EINVAL
|
2002-12-19 09:40:28 +00:00
|
|
|
The
|
2000-12-29 14:08:20 +00:00
|
|
|
.Fa fd
|
2002-12-19 09:40:28 +00:00
|
|
|
argument
|
1994-05-27 05:00:24 +00:00
|
|
|
refers to a socket, not to a file.
|
|
|
|
|
.It Bq Er EPERM
|
|
|
|
|
The effective user ID does not match the owner of the file and
|
|
|
|
|
the effective user ID is not the super-user.
|
2006-05-16 20:24:41 +00:00
|
|
|
.It Bq Er EPERM
|
|
|
|
|
One of
|
2006-09-17 21:27:35 +00:00
|
|
|
.Dv SF_IMMUTABLE , SF_APPEND ,
|
2006-05-16 20:24:41 +00:00
|
|
|
or
|
2006-09-17 21:27:35 +00:00
|
|
|
.Dv SF_NOUNLINK
|
2006-05-16 20:24:41 +00:00
|
|
|
is set and the user is either not the super-user or
|
|
|
|
|
securelevel is greater than 0.
|
|
|
|
|
.It Bq Er EPERM
|
2012-04-13 05:40:26 +00:00
|
|
|
A non-super-user attempted to toggle one of
|
2010-10-29 15:03:29 +00:00
|
|
|
.Dv SF_ARCHIVED , SF_IMMUTABLE , SF_APPEND ,
|
2006-05-16 20:24:41 +00:00
|
|
|
or
|
2006-09-17 21:27:35 +00:00
|
|
|
.Dv SF_NOUNLINK .
|
2010-10-29 15:03:29 +00:00
|
|
|
.It Bq Er EPERM
|
2012-04-13 05:40:26 +00:00
|
|
|
An attempt was made to toggle the
|
2010-10-29 15:03:29 +00:00
|
|
|
.Dv SF_SNAPSHOT
|
|
|
|
|
flag.
|
1994-05-27 05:00:24 +00:00
|
|
|
.It Bq Er EROFS
|
|
|
|
|
The file resides on a read-only file system.
|
|
|
|
|
.It Bq Er EIO
|
|
|
|
|
An
|
|
|
|
|
.Tn I/O
|
|
|
|
|
error occurred while reading from or writing to the file system.
|
1999-02-15 13:16:02 +00:00
|
|
|
.It Bq Er EOPNOTSUPP
|
2012-04-13 05:40:26 +00:00
|
|
|
The underlying file system does not support file flags, or
|
|
|
|
|
does not support all of the flags set in
|
|
|
|
|
.Fa flags .
|
1994-05-27 05:00:24 +00:00
|
|
|
.El
|
|
|
|
|
.Sh SEE ALSO
|
1996-09-21 06:28:55 +00:00
|
|
|
.Xr chflags 1 ,
|
2000-06-17 14:03:34 +00:00
|
|
|
.Xr fflagstostr 3 ,
|
|
|
|
|
.Xr strtofflags 3 ,
|
1997-03-11 11:35:56 +00:00
|
|
|
.Xr init 8 ,
|
2001-05-23 14:58:19 +00:00
|
|
|
.Xr mount_unionfs 8
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh HISTORY
|
|
|
|
|
The
|
2002-12-18 09:22:32 +00:00
|
|
|
.Fn chflags
|
1994-05-27 05:00:24 +00:00
|
|
|
and
|
2002-12-18 09:22:32 +00:00
|
|
|
.Fn fchflags
|
|
|
|
|
system calls first appeared in
|
1996-08-22 23:31:07 +00:00
|
|
|
.Bx 4.4 .
|
2013-03-16 22:44:14 +00:00
|
|
|
The
|
|
|
|
|
.Fn lchflags
|
|
|
|
|
system call first appeared in
|
|
|
|
|
.Fx 5.0 .
|
2013-03-21 23:05:44 +00:00
|
|
|
The
|
|
|
|
|
.Fn chflagsat
|
|
|
|
|
system call first appeared in
|
|
|
|
|
.Fx 10.0 .
|
