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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)chflags.2   8.3 (Berkeley) 5/2/95
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd September 23, 2020
  32 .Dt CHFLAGS 2
  33 .Os
  34 .Sh NAME
  35 .Nm chflags ,
  36 .Nm lchflags ,
  37 .Nm fchflags ,
  38 .Nm chflagsat
  39 .Nd set file flags
  40 .Sh LIBRARY
  41 .Lb libc
  42 .Sh SYNOPSIS
  43 .In sys/stat.h
  44 .In unistd.h
  45 .Ft int
  46 .Fn chflags "const char *path" "unsigned long flags"
  47 .Ft int
  48 .Fn lchflags "const char *path" "unsigned long flags"
  49 .Ft int
  50 .Fn fchflags "int fd" "unsigned long flags"
  51 .Ft int
  52 .Fn chflagsat "int fd" "const char *path" "unsigned long flags" "int atflag"
  53 .Sh DESCRIPTION
  54 The file whose name
  55 is given by
  56 .Fa path
  57 or referenced by the descriptor
  58 .Fa fd
  59 has its flags changed to
  60 .Fa flags .
  61 .Pp
  62 The
  63 .Fn lchflags
  64 system call is like
  65 .Fn chflags
  66 except in the case where the named file is a symbolic link,
  67 in which case
  68 .Fn lchflags
  69 will change the flags of the link itself,
  70 rather than the file it points to.
  71 .Pp
  72 The
  73 .Fn chflagsat
  74 is equivalent to either
  75 .Fn chflags
  76 or
  77 .Fn lchflags
  78 depending on the
  79 .Fa atflag
  80 except in the case where
  81 .Fa path
  82 specifies a relative path.
  83 In this case the file to be changed is determined relative to the directory
  84 associated with the file descriptor
  85 .Fa fd
  86 instead of the current working directory.
  87 The values for the
  88 .Fa atflag
  89 are constructed by a bitwise-inclusive OR of flags from the following list,
  90 defined in
  91 .In fcntl.h :
  92 .Bl -tag -width indent
  93 .It Dv AT_SYMLINK_NOFOLLOW
  94 If
  95 .Fa path
  96 names a symbolic link, then the flags of the symbolic link are changed.
  97 .It Dv AT_BENEATH
  98 Only allow to change flags for a file which is beneath of
  99 the topping directory.
 100 See the description of the
 101 .Dv O_BENEATH
 102 flag in the
 103 .Xr open 2
 104 manual page.
 105 .It Dv AT_RESOLVE_BENEATH
 106 Only walks paths below the topping directory.
 107 See the description of the
 108 .Dv O_RESOLVE_BENEATH
 109 flag in the
 110 .Xr open 2
 111 manual page.
 112 .El
 113 .Pp
 114 If
 115 .Fn chflagsat
 116 is passed the special value
 117 .Dv AT_FDCWD
 118 in the
 119 .Fa fd
 120 parameter, the current working directory is used.
 121 If also
 122 .Fa atflag
 123 is zero, the behavior is identical to a call to
 124 .Fn chflags .
 125 .Pp
 126 The flags specified are formed by
 127 .Em or Ns 'ing
 128 the following values
 129 .Pp
 130 .Bl -tag -width ".Dv SF_IMMUTABLE" -compact -offset indent
 131 .It Dv SF_APPEND
 132 The file may only be appended to.
 133 .It Dv SF_ARCHIVED
 134 The file has been archived.
 135 This flag means the opposite of the DOS, Windows and CIFS
 136 FILE_ATTRIBUTE_ARCHIVE attribute.
 137 This flag has been deprecated, and may be removed in a future release.
 138 .It Dv SF_IMMUTABLE
 139 The file may not be changed.
 140 .It Dv SF_NOUNLINK
 141 The file may not be renamed or deleted.
 142 .It Dv SF_SNAPSHOT
 143 The file is a snapshot file.
 144 .It Dv UF_APPEND
 145 The file may only be appended to.
 146 .It Dv UF_ARCHIVE
 147 The file needs to be archived.
 148 This flag has the same meaning as the DOS, Windows and CIFS
 149 FILE_ATTRIBUTE_ARCHIVE attribute.
 150 Filesystems in FreeBSD may or may not have special handling for this flag.
 151 For instance, ZFS tracks changes to files and will set this bit when a
 152 file is updated.
 153 UFS only stores the flag, and relies on the application to change it when
 154 needed.
 155 .It Dv UF_HIDDEN
 156 The file may be hidden from directory listings at the application's
 157 discretion.
 158 The file has the DOS, Windows and CIFS FILE_ATTRIBUTE_HIDDEN attribute.
 159 .It Dv UF_IMMUTABLE
 160 The file may not be changed.
 161 .It Dv UF_NODUMP
 162 Do not dump the file.
 163 .It Dv UF_NOUNLINK
 164 The file may not be renamed or deleted.
 165 .It Dv UF_OFFLINE
 166 The file is offline, or has the Windows and CIFS FILE_ATTRIBUTE_OFFLINE
 167 attribute.
 168 Filesystems in FreeBSD store and display this flag, but do not provide any
 169 special handling when it is set.
 170 .It Dv UF_OPAQUE
 171 The directory is opaque when viewed through a union stack.
 172 .It Dv UF_READONLY
 173 The file is read only, and may not be written or appended.
 174 Filesystems may use this flag to maintain compatibility with the DOS, Windows
 175 and CIFS FILE_ATTRIBUTE_READONLY attribute.
 176 .It Dv UF_REPARSE
 177 The file contains a Windows reparse point and has the Windows and CIFS
 178 FILE_ATTRIBUTE_REPARSE_POINT attribute.
 179 .It Dv UF_SPARSE
 180 The file has the Windows FILE_ATTRIBUTE_SPARSE_FILE attribute.
 181 This may also be used by a filesystem to indicate a sparse file.
 182 .It Dv UF_SYSTEM
 183 The file has the DOS, Windows and CIFS FILE_ATTRIBUTE_SYSTEM attribute.
 184 Filesystems in FreeBSD may store and display this flag, but do not provide
 185 any special handling when it is set.
 186 .El
 187 .Pp
 188 If one of
 189 .Dv SF_IMMUTABLE , SF_APPEND ,
 190 or
 191 .Dv SF_NOUNLINK
 192 is set a non-super-user cannot change any flags and even the super-user
 193 can change flags only if securelevel is 0.
 194 (See
 195 .Xr init 8
 196 for details.)
 197 .Pp
 198 The
 199 .Dv UF_IMMUTABLE , UF_APPEND , UF_NOUNLINK , UF_NODUMP ,
 200 and
 201 .Dv UF_OPAQUE
 202 flags may be set or unset by either the owner of a file or the super-user.
 203 .Pp
 204 The
 205 .Dv SF_IMMUTABLE , SF_APPEND , SF_NOUNLINK ,
 206 and
 207 .Dv SF_ARCHIVED
 208 flags may only be set or unset by the super-user.
 209 Attempts to toggle these flags by non-super-users are rejected.
 210 These flags may be set at any time, but normally may only be unset when
 211 the system is in single-user mode.
 212 (See
 213 .Xr init 8
 214 for details.)
 215 .Pp
 216 The implementation of all flags is filesystem-dependent.
 217 See the description of the
 218 .Dv UF_ARCHIVE
 219 flag above for one example of the differences in behavior.
 220 Care should be exercised when writing applications to account for
 221 support or lack of support of these flags in various filesystems.
 222 .Pp
 223 The
 224 .Dv SF_SNAPSHOT
 225 flag is maintained by the system and cannot be toggled.
 226 .Sh RETURN VALUES
 227 .Rv -std
 228 .Sh ERRORS
 229 The
 230 .Fn chflags
 231 system call will fail if:
 232 .Bl -tag -width Er
 233 .It Bq Er ENOTDIR
 234 A component of the path prefix is not a directory.
 235 .It Bq Er ENAMETOOLONG
 236 A component of a pathname exceeded 255 characters,
 237 or an entire path name exceeded 1023 characters.
 238 .It Bq Er ENOENT
 239 The named file does not exist.
 240 .It Bq Er EACCES
 241 Search permission is denied for a component of the path prefix.
 242 .It Bq Er ELOOP
 243 Too many symbolic links were encountered in translating the pathname.
 244 .It Bq Er EPERM
 245 The effective user ID does not match the owner of the file and
 246 the effective user ID is not the super-user.
 247 .It Bq Er EPERM
 248 One of
 249 .Dv SF_IMMUTABLE , SF_APPEND ,
 250 or
 251 .Dv SF_NOUNLINK
 252 is set and the user is either not the super-user or
 253 securelevel is greater than 0.
 254 .It Bq Er EPERM
 255 A non-super-user attempted to toggle one of
 256 .Dv SF_ARCHIVED , SF_IMMUTABLE , SF_APPEND ,
 257 or
 258 .Dv SF_NOUNLINK .
 259 .It Bq Er EPERM
 260 An attempt was made to toggle the
 261 .Dv SF_SNAPSHOT
 262 flag.
 263 .It Bq Er EROFS
 264 The named file resides on a read-only file system.
 265 .It Bq Er EFAULT
 266 The
 267 .Fa path
 268 argument
 269 points outside the process's allocated address space.
 270 .It Bq Er EIO
 271 An
 272 .Tn I/O
 273 error occurred while reading from or writing to the file system.
 274 .It Bq Er EINTEGRITY
 275 Corrupted data was detected while reading from the file system.
 276 .It Bq Er EOPNOTSUPP
 277 The underlying file system does not support file flags, or
 278 does not support all of the flags set in
 279 .Fa flags .
 280 .El
 281 .Pp
 282 The
 283 .Fn fchflags
 284 system call will fail if:
 285 .Bl -tag -width Er
 286 .It Bq Er EBADF
 287 The descriptor is not valid.
 288 .It Bq Er EINVAL
 289 The
 290 .Fa fd
 291 argument
 292 refers to a socket, not to a file.
 293 .It Bq Er EPERM
 294 The effective user ID does not match the owner of the file and
 295 the effective user ID is not the super-user.
 296 .It Bq Er EPERM
 297 One of
 298 .Dv SF_IMMUTABLE , SF_APPEND ,
 299 or
 300 .Dv SF_NOUNLINK
 301 is set and the user is either not the super-user or
 302 securelevel is greater than 0.
 303 .It Bq Er EPERM
 304 A non-super-user attempted to toggle one of
 305 .Dv SF_ARCHIVED , SF_IMMUTABLE , SF_APPEND ,
 306 or
 307 .Dv SF_NOUNLINK .
 308 .It Bq Er EPERM
 309 An attempt was made to toggle the
 310 .Dv SF_SNAPSHOT
 311 flag.
 312 .It Bq Er EROFS
 313 The file resides on a read-only file system.
 314 .It Bq Er EIO
 315 An
 316 .Tn I/O
 317 error occurred while reading from or writing to the file system.
 318 .It Bq Er EINTEGRITY
 319 Corrupted data was detected while reading from the file system.
 320 .It Bq Er EOPNOTSUPP
 321 The underlying file system does not support file flags, or
 322 does not support all of the flags set in
 323 .Fa flags .
 324 .It Bq Er ENOTCAPABLE
 325 .Fa path
 326 is an absolute path,
 327 or contained a ".." component leading to a
 328 directory outside of the directory hierarchy specified by
 329 .Fa fd ,
 330 and the process is in capability mode.
 331 .It Bq Er ENOTCAPABLE
 332 The
 333 .Dv AT_BENEATH
 334 flag was provided to
 335 .Fn chflagsat ,
 336 and the absolute
 337 .Fa path
 338 does not have its tail fully contained under the topping directory,
 339 or the relative
 340 .Fa path
 341 escapes it.
 342 .El
 343 .Sh SEE ALSO
 344 .Xr chflags 1 ,
 345 .Xr fflagstostr 3 ,
 346 .Xr strtofflags 3 ,
 347 .Xr init 8 ,
 348 .Xr mount_unionfs 8
 349 .Sh HISTORY
 350 The
 351 .Fn chflags
 352 and
 353 .Fn fchflags
 354 system calls first appeared in
 355 .Bx 4.4 .
 356 The
 357 .Fn lchflags
 358 system call first appeared in
 359 .Fx 5.0 .
 360 The
 361 .Fn chflagsat
 362 system call first appeared in
 363 .Fx 10.0 .