6/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$
  34 .\"
  35 .Dd Jun 23, 2006
  36 .Dt CHFLAGS 2
  37 .Os
  38 .Sh NAME
  39 .Nm chflags ,
  40 .Nm lchflags ,
  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 lchflags "const char *path" "int flags"
  52 .Ft int
  53 .Fn fchflags "int fd" "u_long flags"
  54 .Sh DESCRIPTION
  55 The file whose name
  56 is given by
  57 .Fa path
  58 or referenced by the descriptor
  59 .Fa fd
  60 has its flags changed to
  61 .Fa flags .
  62 .Pp
  63 The
  64 .Fn lchflags
  65 system call is like
  66 .Fn chflags
  67 except in the case where the named file is a symbolic link,
  68 in which case
  69 .Fn lchflags
  70 will change the flags of the link itself,
  71 rather than the file it points to.
  72 .Pp
  73 The flags specified are formed by
  74 .Em or Ns 'ing
  75 the following values
  76 .Pp
  77 .Bl -tag -width "SF_IMMUTABLE" -compact -offset indent
  78 .It UF_NODUMP
  79 Do not dump the file.
  80 .It UF_IMMUTABLE
  81 The file may not be changed.
  82 .It UF_APPEND
  83 The file may only be appended to.
  84 .It UF_NOUNLINK
  85 The file may not be renamed or deleted.
  86 .It UF_OPAQUE
  87 The directory is opaque when viewed through a union stack.
  88 .It SF_ARCHIVED
  89 The file may be archived.
  90 .It SF_IMMUTABLE
  91 The file may not be changed.
  92 .It SF_APPEND
  93 The file may only be appended to.
  94 .It SF_NOUNLINK
  95 The file may not be renamed or deleted.
  96 .It SF_SNAPSHOT
  97 The file is a snapshot file.
  98 .El
  99 .Pp
 100 If one of
 101 .Dq SF_IMMUTABLE ,
 102 .Dq SF_APPEND ,
 103 or
 104 .Dq SF_NOUNLINK
 105 is set a non-super-user cannot change any flags and even the super-user
 106 can change flags only if securelevel is greater than 0.
 107 (See
 108 .Xr init 8
 109 for details.)
 110 .Pp
 111 The
 112 .Dq UF_IMMUTABLE ,
 113 .Dq UF_APPEND ,
 114 .Dq UF_NOUNLINK ,
 115 .Dq UF_NODUMP ,
 116 and
 117 .Dq UF_OPAQUE
 118 flags may be set or unset by either the owner of a file or the super-user.
 119 .Pp
 120 The
 121 .Dq SF_IMMUTABLE ,
 122 .Dq SF_APPEND ,
 123 .Dq SF_NOUNLINK ,
 124 and
 125 .Dq SF_ARCHIVED
 126 flags may only be set or unset by the super-user.
 127 Attempts to set these flags by non-super-users are rejected, attempts by
 128 non-superusers to clear flags that are already unset are silently ignored.
 129 These flags may be set at any time, but normally may only be unset when
 130 the system is in single-user mode.
 131 (See
 132 .Xr init 8
 133 for details.)
 134 .Pp
 135 The
 136 .Dq SF_SNAPSHOT
 137 flag is maintained by the system and cannot be changed by any user.
 138 .Sh RETURN VALUES
 139 .Rv -std
 140 .Sh ERRORS
 141 The
 142 .Fn chflags
 143 system call will fail if:
 144 .Bl -tag -width Er
 145 .It Bq Er ENOTDIR
 146 A component of the path prefix is not a directory.
 147 .It Bq Er ENAMETOOLONG
 148 A component of a pathname exceeded 255 characters,
 149 or an entire path name exceeded 1023 characters.
 150 .It Bq Er ENOENT
 151 The named file does not exist.
 152 .It Bq Er EACCES
 153 Search permission is denied for a component of the path prefix.
 154 .It Bq Er ELOOP
 155 Too many symbolic links were encountered in translating the pathname.
 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 EPERM
 160 One of
 161 .Dq SF_IMMUTABLE ,
 162 .Dq SF_APPEND ,
 163 or
 164 .Dq SF_NOUNLINK
 165 is set and the user is either not the super-user or
 166 securelevel is greater than 0.
 167 .It Bq Er EPERM
 168 A non-super-user tries to set one of
 169 .Dq SF_IMMUTABLE ,
 170 .Dq SF_APPEND ,
 171 or
 172 .Dq SF_NOUNLINK .
 173 .It Bq Er EROFS
 174 The named file resides on a read-only file system.
 175 .It Bq Er EFAULT
 176 The
 177 .Fa path
 178 argument
 179 points outside the process's allocated address space.
 180 .It Bq Er EIO
 181 An
 182 .Tn I/O
 183 error occurred while reading from or writing to the file system.
 184 .It Bq Er EOPNOTSUPP
 185 The underlying file system does not support file flags.
 186 .El
 187 .Pp
 188 The
 189 .Fn fchflags
 190 system call will fail if:
 191 .Bl -tag -width Er
 192 .It Bq Er EBADF
 193 The descriptor is not valid.
 194 .It Bq Er EINVAL
 195 The
 196 .Fa fd
 197 argument
 198 refers to a socket, not to a file.
 199 .It Bq Er EPERM
 200 The effective user ID does not match the owner of the file and
 201 the effective user ID is not the super-user.
 202 .It Bq Er EPERM
 203 One of
 204 .Dq SF_IMMUTABLE ,
 205 .Dq SF_APPEND ,
 206 or
 207 .Dq SF_NOUNLINK
 208 is set and the user is either not the super-user or
 209 securelevel is greater than 0.
 210 .It Bq Er EPERM
 211 A non-super-user tries to set one of
 212 .Dq SF_IMMUTABLE ,
 213 .Dq SF_APPEND ,
 214 or
 215 .Dq SF_NOUNLINK .
 216 .It Bq Er EROFS
 217 The file resides on a read-only file system.
 218 .It Bq Er EIO
 219 An
 220 .Tn I/O
 221 error occurred while reading from or writing to the file system.
 222 .It Bq Er EOPNOTSUPP
 223 The underlying file system does not support file flags.
 224 .El
 225 .Sh SEE ALSO
 226 .Xr chflags 1 ,
 227 .Xr fflagstostr 3 ,
 228 .Xr strtofflags 3 ,
 229 .Xr init 8 ,
 230 .Xr mount_unionfs 8
 231 .Sh HISTORY
 232 The
 233 .Fn chflags
 234 and
 235 .Fn fchflags
 236 system calls first appeared in
 237 .Bx 4.4 .