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