1 .\" Copyright (c) 1989, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" @(#)chflags.2 8.3 (Berkeley) 5/2/95
29 .\" $FreeBSD: src/lib/libc/sys/chflags.2,v 1.11.2.7 2001/12/14 18:34:00 ru Exp $
46 .Fn chflags "const char *path" "u_long flags"
48 .Fn lchflags "const char *path" "u_long flags"
50 .Fn fchflags "int fd" "u_long flags"
52 .Fn chflagsat "int fd" "const char *path" "u_long flags" "int atflag"
57 or referenced by the descriptor
59 has its flags changed to
66 except in the case where the named file is a symbolic link,
69 will change the flags of the link itself,
70 rather than the file it points to.
74 is equivalent to either
80 except in the case where
82 specifies a relative path.
83 In this case the file to be changed is determined relative to the directory
84 associated with the file descriptor
86 instead of the current working directory.
89 are constructed by a bitwise-inclusive OR of flags from the following list,
92 .Bl -tag -width indent
93 .It Dv AT_SYMLINK_NOFOLLOW
96 names a symbolic link, then the flags of the symbolic link are changed.
101 is passed the special value
105 parameter, the current working directory is used.
108 is zero, the behavior is identical to a call to
111 The flags specified are formed by
115 .Bl -tag -width ".Dv SF_IMMUTABLE" -compact -offset indent
117 Do not dump the file.
119 The file may not be changed.
121 The file may only be appended to.
123 The directory is opaque when viewed through a union stack.
125 The file may not be renamed or deleted.
127 Do not retain history for file.
132 The flag is recursive and need only be set on a top-level directory.
134 The file may be archived.
136 The file may not be changed.
138 The file may only be appended to.
140 The file may not be renamed or deleted.
142 Do not retain history for file.
147 The flag is recursive and need only be set on a top-level directory.
153 flags may be set or unset by either the owner of a file or the super-user.
158 flags may only be set or unset by the super-user.
159 Attempts by the non-super-user to set the super-user only flags
160 are silently ignored.
161 These flags may be set at any time, but normally may only be unset when
162 the system is in single-user mode.
173 A component of the path prefix is not a directory.
174 .It Bq Er ENAMETOOLONG
175 A component of a pathname exceeded 255 characters,
176 or an entire path name exceeded 1023 characters.
178 The named file does not exist.
180 Search permission is denied for a component of the path prefix.
182 Too many symbolic links were encountered in translating the pathname.
184 The effective user ID does not match the owner of the file and
185 the effective user ID is not the super-user.
187 The named file resides on a read-only file system.
190 points outside the process's allocated address space.
194 error occurred while reading from or writing to the file system.
196 The underlying file system does not support file flags.
203 The descriptor is not valid.
206 refers to a socket, not to a file.
208 The effective user ID does not match the owner of the file and
209 the effective user ID is not the super-user.
211 The file resides on a read-only file system.
215 error occurred while reading from or writing to the file system.
217 The underlying file system does not support file flags.
230 functions first appeared in