xnu-6153.121.1.tar.gz

[apple/xnu.git] / bsd / man / man2 / chflags.2

diff --git a/bsd/man/man2/chflags.2 b/bsd/man/man2/chflags.2
index 48a949e8f8d7b3cdb22014722acbe4f2488a91b8..6bea184c416eedde8c13c855748626e8f08fcc54 100644 (file)
--- a/bsd/man/man2/chflags.2
+++ b/bsd/man/man2/chflags.2
@@ -44,9 +44,9 @@
 .Fd #include <sys/stat.h>
 .Fd #include <unistd.h>
 .Ft int
 .Fd #include <sys/stat.h>
 .Fd #include <unistd.h>
 .Ft int

-.Fn chflags "const char *path"  "u_long flags"
+.Fn chflags "const char *path"  "u_int flags"

 .Ft int
 .Ft int

-.Fn fchflags "int fd" "u_long flags"
+.Fn fchflags "int fd" "u_int flags"

 .Sh DESCRIPTION
 The file whose name
 is given by
 .Sh DESCRIPTION
 The file whose name
 is given by


@@ -60,45 +60,56 @@ The flags specified are formed by
 .Em or Ns 'ing
 the following values
 .Pp
 .Em or Ns 'ing
 the following values
 .Pp

-.Bl -tag -width "SF_IMMUTABLE" -compact -offset indent
+.Bl -tag -width "SF_IMMUTABLEX" -compact -offset indent

 .It UF_NODUMP
 Do not dump the file.
 .It UF_IMMUTABLE
 The file may not be changed.
 .It UF_APPEND
 The file may only be appended to.
 .It UF_NODUMP
 Do not dump the file.
 .It UF_IMMUTABLE
 The file may not be changed.
 .It UF_APPEND
 The file may only be appended to.

-.\".It ARCHIVED
-.\"File is archived.
+.It UF_OPAQUE
+The directory is opaque when viewed through a union stack.
+.It UF_HIDDEN
+The file or directory is not intended to be displayed to the user.
+.It SF_ARCHIVED
+The file has been archived.

 .It SF_IMMUTABLE
 The file may not be changed.
 .It SF_APPEND
 The file may only be appended to.
 .It SF_IMMUTABLE
 The file may not be changed.
 .It SF_APPEND
 The file may only be appended to.

+.It SF_DATALESSFAULT
+The file is a dataless placeholder.
+The system will attempt to materialize it when accessed according to the dataless file materialization policy of the accessing thread or process.
+See
+.Xr getiopolicy_np 3 .

 .El
 .Pp
 The
 .El
 .Pp
 The

-.Dq UF_IMMUTABLE
+.Dq UF_IMMUTABLE ,
+.Dq UF_APPEND ,
+.Dq UF_OPAQUE ,

 and
 and

-.Dq UF_APPEND
+.Dq UF_HIDDEN

 flags may be set or unset by either the owner of a file or the super-user.
 .Pp
 The
 flags may be set or unset by either the owner of a file or the super-user.
 .Pp
 The

+.Dq SF_ARCHIVED ,

 .Dq SF_IMMUTABLE
 and
 .Dq SF_APPEND
 flags may only be set or unset by the super-user.
 .Dq SF_IMMUTABLE
 and
 .Dq SF_APPEND
 flags may only be set or unset by the super-user.

-They may be set at any time, but normally may only be unset when
-the system is in single-user mode.
-(See
-.Xr init 8
-for details.)
+.Pp
+The
+.Dq SF_DATALESSFAULT
+flag is an internal flag and may not be set from user space.

 .Sh RETURN VALUES
 Upon successful completion, a value of 0 is returned.
 Otherwise, -1 is returned and the global variable
 .Va errno
 is set to indicate the error.
 .Sh ERRORS
 .Sh RETURN VALUES
 Upon successful completion, a value of 0 is returned.
 Otherwise, -1 is returned and the global variable
 .Va errno
 is set to indicate the error.
 .Sh ERRORS

-.Fn Chflags
-will fail it:
+.Fn chflags
+will fail if:

 .Bl -tag -width Er
 .It Bq Er ENOTDIR
 A component of the path prefix is not a directory.
 .Bl -tag -width Er
 .It Bq Er ENOTDIR
 A component of the path prefix is not a directory.


@@ -126,15 +137,17 @@ points outside the process's allocated address space.
 An
 .Tn I/O
 error occurred while reading from or writing to the file system.
 An
 .Tn I/O
 error occurred while reading from or writing to the file system.

+.It Bq Er ENOTSUP
+The operation isn't supported by the filesystem.

 .El
 .Pp
 .El
 .Pp

-.Fn Fchflags
+.Fn fchflags

 will fail if:
 .Bl -tag -width Er
 .It Bq Er EBADF
 The descriptor is not valid.
 .It Bq Er EINVAL
 will fail if:
 .Bl -tag -width Er
 .It Bq Er EBADF
 The descriptor is not valid.
 .It Bq Er EINVAL

-.Fa Fd
+.Fa fd

 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
 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


@@ -145,10 +158,15 @@ The file resides on a read-only file system.
 An
 .Tn I/O
 error occurred while reading from or writing to the file system.
 An
 .Tn I/O
 error occurred while reading from or writing to the file system.

+.It Bq Er ENOTSUP
+The operation isn't supported by the filesystem.

 .El
 .Sh SEE ALSO
 .Xr chflags 1 ,
 .El
 .Sh SEE ALSO
 .Xr chflags 1 ,

-.Xr init 8
+.Xr fflagstostr 3 ,
+.Xr lchflags 3 ,
+.Xr strtofflags 3 ,
+.Xr launchd 8

 .Sh HISTORY
 The
 .Fn chflags
 .Sh HISTORY
 The
 .Fn chflags