1.\" $NetBSD: chflags.2,v 1.9 1997/04/23 06:00:51 mikel 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 BSD 4.4 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_long flags" 48.Ft int 49.Fn fchflags "int fd" "u_long 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_IMMUTABLE" -compact -offset indent 64.It Dv UF_NODUMP 65Do not dump the file. 66.It Dv UF_IMMUTABLE 67The file may not be changed. 68.It Dv UF_APPEND 69The file may only be appended to. 70.It Dv UF_OPAQUE 71The file (if a directory) is opaque for union mounts. 72.It Dv SF_ARCHIVED 73The file is archived. 74.It Dv SF_IMMUTABLE 75The file may not be changed. 76.It Dv SF_APPEND 77The file may only be appended to. 78.El 79.Pp 80The 81.Dv UF_NODUMP , 82.Dv UF_IMMUTABLE , 83.Dv UF_APPEND , 84and 85.Dv UF_OPAQUE 86flags may be set or unset by either the owner of a file or the super-user. 87.Pp 88The 89.Dv SF_ARCHIVED , 90.Dv SF_IMMUTABLE , 91and 92.Dv SF_APPEND 93flags may only be set or unset by the super-user. 94The 95.Dv SF_IMMUTABLE 96and 97.Dv SF_APPEND 98flags 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 116.Dv {NAME_MAX} 117characters, or an entire path name exceeded 118.Dv {PATH_MAX} 119characters. 120.It Bq Er ENOENT 121The named file does not exist. 122.It Bq Er EACCES 123Search permission is denied for a component of the path prefix. 124.It Bq Er ELOOP 125Too many symbolic links were encountered in translating the pathname. 126.It Bq Er EPERM 127The effective user ID does not match the owner of the file and 128the effective user ID is not the super-user. 129.It Bq Er EPERM 130The effective user ID is not the super-user and one or more of the 131super-user-only flags for the named file would be changed. 132.It Bq Er EOPNOTSUPP 133The named file resides on a file system that does not support file 134flags. 135.It Bq Er EROFS 136The named file resides on a read-only file system. 137.It Bq Er EFAULT 138.Fa Path 139points outside the process's allocated address space. 140.It Bq Er EIO 141An 142.Tn I/O 143error occurred while reading from or writing to the file system. 144.El 145.Pp 146.Fn Fchflags 147will fail if: 148.Bl -tag -width Er 149.It Bq Er EBADF 150The descriptor is not valid. 151.It Bq Er EINVAL 152.Fa Fd 153refers to a socket, not to a file. 154.It Bq Er EPERM 155The effective user ID does not match the owner of the file and 156the effective user ID is not the super-user. 157.It Bq Er EPERM 158The effective user ID is not the super-user and one or more of the 159super-user-only flags for the file would be changed. 160.It Bq Er EOPNOTSUPP 161The file resides on a file system that does not support file flags. 162.It Bq Er EROFS 163The file resides on a read-only file system. 164.It Bq Er EIO 165An 166.Tn I/O 167error occurred while reading from or writing to the file system. 168.El 169.Sh SEE ALSO 170.Xr chflags 1 , 171.Xr init 8 172.Sh HISTORY 173The 174.Fn chflags 175and 176.Fn fchflags 177functions first appeared in 4.4BSD. 178