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