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 .\"
  35 .Dd May 2, 1995
  36 .Dt CHFLAGS 2
  37 .Os
  38 .Sh NAME
  39 .Nm chflags ,
  40 .Nm fchflags
  41 .Nd set file flags
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In sys/stat.h
  46 .In unistd.h
  47 .Ft int
  48 .Fn chflags "const char *path"  "u_long flags"
  49 .Ft int
  50 .Fn fchflags "int fd" "u_long flags"
  51 .Sh DESCRIPTION
  52 The file whose name
  53 is given by
  54 .Fa path
  55 or referenced by the descriptor
  56 .Fa fd
  57 has its flags changed to
  58 .Fa flags .
  59 .Pp
  60 The flags specified are formed by
  61 .Em or Ns 'ing
  62 the following values
  63 .Pp
  64 .Bl -tag -width "SF_IMMUTABLE" -compact -offset indent
  65 .It UF_NODUMP
  66 Do not dump the file.
  67 .It UF_IMMUTABLE
  68 The file may not be changed.
  69 .It UF_APPEND
  70 The file may only be appended to.
  71 .It UF_NOUNLINK
  72 The file may not be renamed or deleted.
  73 .It UF_OPAQUE
  74 The directory is opaque when viewed through a union stack.
  75 .It SF_ARCHIVED
  76 The file may be archived.
  77 .It SF_IMMUTABLE
  78 The file may not be changed.
  79 .It SF_APPEND
  80 The file may only be appended to.
  81 .It SF_NOUNLINK
  82 The file may not be renamed or deleted.
  83 .El
  84 .Pp
  85 The
  86 .Dq UF_IMMUTABLE ,
  87 .Dq UF_APPEND ,
  88 .Dq UF_NOUNLINK ,
  89 .Dq UF_NODUMP ,
  90 and
  91 .Dq UF_OPAQUE
  92 flags may be set or unset by either the owner of a file or the super-user.
  93 .Pp
  94 The
  95 .Dq SF_IMMUTABLE ,
  96 .Dq SF_APPEND ,
  97 .Dq SF_NOUNLINK ,
  98 and
  99 .Dq SF_ARCHIVED
 100 flags may only be set or unset by the super-user.
 101 Attempts by the non-super-user to set the super-user only flags
 102 are silently ignored.
 103 These flags may be set at any time, but normally may only be unset when
 104 the system is in single-user mode.
 105 (See
 106 .Xr init 8
 107 for details.)
 108 .Sh RETURN VALUES
 109 .Rv -std
 110 .Sh ERRORS
 111 .Fn Chflags
 112 will fail if:
 113 .Bl -tag -width Er
 114 .It Bq Er ENOTDIR
 115 A component of the path prefix is not a directory.
 116 .It Bq Er ENAMETOOLONG
 117 A component of a pathname exceeded 255 characters,
 118 or an entire path name exceeded 1023 characters.
 119 .It Bq Er ENOENT
 120 The named file does not exist.
 121 .It Bq Er EACCES
 122 Search permission is denied for a component of the path prefix.
 123 .It Bq Er ELOOP
 124 Too many symbolic links were encountered in translating the pathname.
 125 .It Bq Er EPERM
 126 The effective user ID does not match the owner of the file and
 127 the effective user ID is not the super-user.
 128 .It Bq Er EROFS
 129 The named file resides on a read-only file system.
 130 .It Bq Er EFAULT
 131 .Fa Path
 132 points outside the process's allocated address space.
 133 .It Bq Er EIO
 134 An
 135 .Tn I/O
 136 error occurred while reading from or writing to the file system.
 137 .It Bq Er EOPNOTSUPP
 138 The underlying file system does not support file flags.
 139 .El
 140 .Pp
 141 .Fn Fchflags
 142 will fail if:
 143 .Bl -tag -width Er
 144 .It Bq Er EBADF
 145 The descriptor is not valid.
 146 .It Bq Er EINVAL
 147 .Fa fd
 148 refers to a socket, not to a file.
 149 .It Bq Er EPERM
 150 The effective user ID does not match the owner of the file and
 151 the effective user ID is not the super-user.
 152 .It Bq Er EROFS
 153 The file resides on a read-only file system.
 154 .It Bq Er EIO
 155 An
 156 .Tn I/O
 157 error occurred while reading from or writing to the file system.
 158 .It Bq Er EOPNOTSUPP
 159 The underlying file system does not support file flags.
 160 .El
 161 .Sh SEE ALSO
 162 .Xr chflags 1 ,
 163 .Xr fflagstostr 3 ,
 164 .Xr strtofflags 3 ,
 165 .Xr init 8 ,
 166 .Xr mount_union 8
 167 .Sh HISTORY
 168 The
 169 .Nm chflags
 170 and
 171 .Nm fchflags
 172 functions first appeared in
 173 .Bx 4.4 .