lib/libc/sys/chflags.2

   1 .\" Copyright (c) 1989, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)chflags.2   8.3 (Berkeley) 5/2/95
  33 .\" $FreeBSD: src/lib/libc/sys/chflags.2,v 1.11.2.7 2001/12/14 18:34:00 ru Exp $
  34 .\" $DragonFly: src/lib/libc/sys/chflags.2,v 1.4 2008/06/24 07:58:00 swildner Exp $
  35 .\"
  36 .Dd June 24, 2008
  37 .Dt CHFLAGS 2
  38 .Os
  39 .Sh NAME
  40 .Nm chflags ,
  41 .Nm fchflags
  42 .Nd set file flags
  43 .Sh LIBRARY
  44 .Lb libc
  45 .Sh SYNOPSIS
  46 .In sys/stat.h
  47 .In unistd.h
  48 .Ft int
  49 .Fn chflags "const char *path"  "u_long flags"
  50 .Ft int
  51 .Fn fchflags "int fd" "u_long flags"
  52 .Sh DESCRIPTION
  53 The file whose name
  54 is given by
  55 .Fa path
  56 or referenced by the descriptor
  57 .Fa fd
  58 has its flags changed to
  59 .Fa flags .
  60 .Pp
  61 The flags specified are formed by
  62 .Em or Ns 'ing
  63 the following values
  64 .Pp
  65 .Bl -tag -width "SF_IMMUTABLE" -compact -offset indent
  66 .It UF_NODUMP
  67 Do not dump the file.
  68 .It UF_IMMUTABLE
  69 The file may not be changed.
  70 .It UF_APPEND
  71 The file may only be appended to.
  72 .It UF_NOUNLINK
  73 The file may not be renamed or deleted.
  74 .It UF_NOHISTORY
  75 Do not retain history for file.
  76 .It UF_OPAQUE
  77 The directory is opaque when viewed through a union stack.
  78 .It SF_ARCHIVED
  79 The file may be archived.
  80 .It SF_IMMUTABLE
  81 The file may not be changed.
  82 .It SF_APPEND
  83 The file may only be appended to.
  84 .It SF_NOUNLINK
  85 The file may not be renamed or deleted.
  86 .It SF_NOHISTORY
  87 Do not retain history for file.
  88 .El
  89 .Pp
  90 The
  91 .Dq UF_IMMUTABLE ,
  92 .Dq UF_APPEND ,
  93 .Dq UF_NOUNLINK ,
  94 .Dq UF_NOHISTORY ,
  95 .Dq UF_NODUMP ,
  96 and
  97 .Dq UF_OPAQUE
  98 flags may be set or unset by either the owner of a file or the super-user.
  99 .Pp
 100 The
 101 .Dq SF_IMMUTABLE ,
 102 .Dq SF_APPEND ,
 103 .Dq SF_NOUNLINK ,
 104 .Dq SF_NOHISTORY ,
 105 and
 106 .Dq SF_ARCHIVED
 107 flags may only be set or unset by the super-user.
 108 Attempts by the non-super-user to set the super-user only flags
 109 are silently ignored.
 110 These flags may be set at any time, but normally may only be unset when
 111 the system is in single-user mode.
 112 (See
 113 .Xr init 8
 114 for details.)
 115 .Sh RETURN VALUES
 116 .Rv -std
 117 .Sh ERRORS
 118 .Fn Chflags
 119 will fail if:
 120 .Bl -tag -width Er
 121 .It Bq Er ENOTDIR
 122 A component of the path prefix is not a directory.
 123 .It Bq Er ENAMETOOLONG
 124 A component of a pathname exceeded 255 characters,
 125 or an entire path name exceeded 1023 characters.
 126 .It Bq Er ENOENT
 127 The named file does not exist.
 128 .It Bq Er EACCES
 129 Search permission is denied for a component of the path prefix.
 130 .It Bq Er ELOOP
 131 Too many symbolic links were encountered in translating the pathname.
 132 .It Bq Er EPERM
 133 The effective user ID does not match the owner of the file and
 134 the effective user ID is not the super-user.
 135 .It Bq Er EROFS
 136 The named file resides on a read-only file system.
 137 .It Bq Er EFAULT
 138 .Fa Path
 139 points outside the process's allocated address space.
 140 .It Bq Er EIO
 141 An
 142 .Tn I/O
 143 error occurred while reading from or writing to the file system.
 144 .It Bq Er EOPNOTSUPP
 145 The underlying file system does not support file flags.
 146 .El
 147 .Pp
 148 .Fn Fchflags
 149 will fail if:
 150 .Bl -tag -width Er
 151 .It Bq Er EBADF
 152 The descriptor is not valid.
 153 .It Bq Er EINVAL
 154 .Fa fd
 155 refers to a socket, not to a file.
 156 .It Bq Er EPERM
 157 The effective user ID does not match the owner of the file and
 158 the effective user ID is not the super-user.
 159 .It Bq Er EROFS
 160 The file resides on a read-only file system.
 161 .It Bq Er EIO
 162 An
 163 .Tn I/O
 164 error occurred while reading from or writing to the file system.
 165 .It Bq Er EOPNOTSUPP
 166 The underlying file system does not support file flags.
 167 .El
 168 .Sh SEE ALSO
 169 .Xr chflags 1 ,
 170 .Xr fflagstostr 3 ,
 171 .Xr strtofflags 3 ,
 172 .Xr init 8 ,
 173 .Xr mount_union 8
 174 .Sh HISTORY
 175 The
 176 .Nm chflags
 177 and
 178 .Nm fchflags
 179 functions first appeared in
 180 .Bx 4.4 .