1.\" $NetBSD: chflags.2,v 1.6 1995/02/27 12:32:03 cgd Exp $ 2.\" 3.\" Copyright (c) 1989, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" @(#)chflags.2 8.1 (Berkeley) 6/9/93 35.\" 36.Dd June 9, 1993 37.Dt CHFLAGS 2 38.Os 39.Sh NAME 40.Nm chflags , 41.Nm fchflags 42.Nd set file flags 43.Sh SYNOPSIS 44.Fd #include <sys/stat.h> 45.Fd #include <unistd.h> 46.Ft int 47.Fn chflags "const char *path" "u_int flags" 48.Ft int 49.Fn fchflags "int fd" "u_int flags" 50.Sh DESCRIPTION 51The file whose name 52is given by 53.Fa path 54or referenced by the descriptor 55.Fa fd 56has its flags changed to 57.Fa flags . 58.Pp 59The flags specified are formed by 60.Em or Ns 'ing 61the following values 62.Pp 63.Bl -tag -width "SF_IMMUTABLEX" -compact -offset indent 64.It UF_NODUMP 65Do not dump the file. 66.It UF_IMMUTABLE 67The file may not be changed. 68.It UF_APPEND 69The file may only be appended to. 70.It UF_OPAQUE 71The directory is opaque when viewed through a union stack. 72.It UF_HIDDEN 73The file or directory is not intended to be displayed to the user. 74.It UF_COMPRESSED 75File is compressed at the file system level. 76.It SF_ARCHIVED 77The file has been archived. 78.It SF_IMMUTABLE 79The file may not be changed. 80.It SF_APPEND 81The file may only be appended to. 82.It SF_DATALESS 83The file is a dataless placeholder. 84The system will attempt to materialize it when accessed according to the dataless file materialization policy of the accessing thread or process. 85See 86.Xr getiopolicy_np 3 . 87.El 88.Pp 89The 90.Dq UF_IMMUTABLE , 91.Dq UF_APPEND , 92.Dq UF_OPAQUE , 93and 94.Dq UF_HIDDEN 95flags may be set or unset by either the owner of a file or the super-user. 96.Pp 97The 98.Dq SF_ARCHIVED , 99.Dq SF_IMMUTABLE 100and 101.Dq SF_APPEND 102flags may only be set or unset by the super-user. 103.Pp 104The 105.Dq SF_DATALESS 106and 107.Dq UF_COMPRESSED 108flags are internal flags and may not be set or unset from user space. Attempting to modify them using 109.Fn chflags 110will result in undefined behaviour. 111.Sh RETURN VALUES 112Upon successful completion, a value of 0 is returned. 113Otherwise, -1 is returned and the global variable 114.Va errno 115is set to indicate the error. 116.Sh ERRORS 117.Fn chflags 118will fail if: 119.Bl -tag -width Er 120.It Bq Er ENOTDIR 121A component of the path prefix is not a directory. 122.It Bq Er ENAMETOOLONG 123A component of a pathname exceeded 124.Dv {NAME_MAX} 125characters, or an entire path name exceeded 126.Dv {PATH_MAX} 127characters. 128.It Bq Er ENOENT 129The named file does not exist. 130.It Bq Er EACCES 131Search permission is denied for a component of the path prefix. 132.It Bq Er ELOOP 133Too many symbolic links were encountered in translating the pathname. 134.It Bq Er EPERM 135The effective user ID does not match the owner of the file and 136the effective user ID is not the super-user. 137.It Bq Er EROFS 138The named file resides on a read-only file system. 139.It Bq Er EFAULT 140.Fa Path 141points outside the process's allocated address space. 142.It Bq Er EIO 143An 144.Tn I/O 145error occurred while reading from or writing to the file system. 146.It Bq Er ENOTSUP 147The operation isn't supported by the filesystem. 148.El 149.Pp 150.Fn fchflags 151will fail if: 152.Bl -tag -width Er 153.It Bq Er EBADF 154The descriptor is not valid. 155.It Bq Er EINVAL 156.Fa fd 157refers to a socket, not to a file. 158.It Bq Er EPERM 159The effective user ID does not match the owner of the file and 160the effective user ID is not the super-user. 161.It Bq Er EROFS 162The file resides on a read-only file system. 163.It Bq Er EIO 164An 165.Tn I/O 166error occurred while reading from or writing to the file system. 167.It Bq Er ENOTSUP 168The operation isn't supported by the filesystem. 169.El 170.Sh SEE ALSO 171.Xr chflags 1 , 172.Xr fflagstostr 3 , 173.Xr lchflags 3 , 174.Xr strtofflags 3 , 175.Xr launchd 8 176.Sh HISTORY 177The 178.Fn chflags 179and 180.Nm fchflags 181functions first appeared in 4.4BSD. 182