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 May 5, 2002 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 55The file whose name 56is given by 57.Fa path 58or referenced by the descriptor 59.Fa fd 60has its flags changed to 61.Fa flags . 62.Pp 63The 64.Fn lchflags 65system call is like 66.Fn chflags 67except in the case where the named file is a symbolic link, 68in which case 69.Fn lchflags 70will change the flags of the link itself, 71rather than the file it points to. 72.Pp 73The flags specified are formed by 74.Em or Ns 'ing 75the following values 76.Pp 77.Bl -tag -width "SF_IMMUTABLE" -compact -offset indent 78.It UF_NODUMP 79Do not dump the file. 80.It UF_IMMUTABLE 81The file may not be changed. 82.It UF_APPEND 83The file may only be appended to. 84.It UF_NOUNLINK 85The file may not be renamed or deleted. 86.It UF_OPAQUE 87The directory is opaque when viewed through a union stack. 88.It SF_ARCHIVED 89The file may be archived. 90.It SF_IMMUTABLE 91The file may not be changed. 92.It SF_APPEND 93The file may only be appended to. 94.It SF_NOUNLINK 95The file may not be renamed or deleted. 96.El 97.Pp 98The 99.Dq UF_IMMUTABLE , 100.Dq UF_APPEND , 101.Dq UF_NOUNLINK , 102.Dq UF_NODUMP , 103and 104.Dq UF_OPAQUE 105flags may be set or unset by either the owner of a file or the super-user. 106.Pp 107The 108.Dq SF_IMMUTABLE , 109.Dq SF_APPEND , 110.Dq SF_NOUNLINK , 111and 112.Dq SF_ARCHIVED 113flags may only be set or unset by the super-user. 114Attempts by the non-super-user to set the super-user only flags 115are silently ignored. 116These flags may be set at any time, but normally may only be unset when 117the system is in single-user mode. 118(See 119.Xr init 8 120for details.) 121.Sh RETURN VALUES 122.Rv -std 123.Sh ERRORS 124The 125.Fn chflags 126system call will fail if: 127.Bl -tag -width Er 128.It Bq Er ENOTDIR 129A component of the path prefix is not a directory. 130.It Bq Er ENAMETOOLONG 131A component of a pathname exceeded 255 characters, 132or an entire path name exceeded 1023 characters. 133.It Bq Er ENOENT 134The named file does not exist. 135.It Bq Er EACCES 136Search permission is denied for a component of the path prefix. 137.It Bq Er ELOOP 138Too many symbolic links were encountered in translating the pathname. 139.It Bq Er EPERM 140The effective user ID does not match the owner of the file and 141the effective user ID is not the super-user. 142.It Bq Er EROFS 143The named file resides on a read-only file system. 144.It Bq Er EFAULT 145The 146.Fa path 147argument 148points outside the process's allocated address space. 149.It Bq Er EIO 150An 151.Tn I/O 152error occurred while reading from or writing to the file system. 153.It Bq Er EOPNOTSUPP 154The underlying file system does not support file flags. 155.El 156.Pp 157The 158.Fn fchflags 159system call will fail if: 160.Bl -tag -width Er 161.It Bq Er EBADF 162The descriptor is not valid. 163.It Bq Er EINVAL 164The 165.Fa fd 166argument 167refers to a socket, not to a file. 168.It Bq Er EPERM 169The effective user ID does not match the owner of the file and 170the effective user ID is not the super-user. 171.It Bq Er EROFS 172The file resides on a read-only file system. 173.It Bq Er EIO 174An 175.Tn I/O 176error occurred while reading from or writing to the file system. 177.It Bq Er EOPNOTSUPP 178The underlying file system does not support file flags. 179.El 180.Sh SEE ALSO 181.Xr chflags 1 , 182.Xr fflagstostr 3 , 183.Xr strtofflags 3 , 184.Xr init 8 , 185.Xr mount_unionfs 8 186.Sh HISTORY 187The 188.Fn chflags 189and 190.Fn fchflags 191system calls first appeared in 192.Bx 4.4 . 193