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
46 .Fn chflags "const char *path" "unsigned long flags"
48 .Fn lchflags "const char *path" "unsigned long flags"
50 .Fn fchflags "int fd" "unsigned long flags"
52 .Fn chflagsat "int fd" "const char *path" "unsigned 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.
98 Only allow to change flags for a file which is beneath of
99 the topping directory.
100 See the description of the
109 is passed the special value
113 parameter, the current working directory is used.
116 is zero, the behavior is identical to a call to
119 The flags specified are formed by
123 .Bl -tag -width ".Dv SF_IMMUTABLE" -compact -offset indent
125 The file may only be appended to.
127 The file has been archived.
128 This flag means the opposite of the DOS, Windows and CIFS
129 FILE_ATTRIBUTE_ARCHIVE attribute.
130 This flag has been deprecated, and may be removed in a future release.
132 The file may not be changed.
134 The file may not be renamed or deleted.
136 The file is a snapshot file.
138 The file may only be appended to.
140 The file needs to be archived.
141 This flag has the same meaning as the DOS, Windows and CIFS
142 FILE_ATTRIBUTE_ARCHIVE attribute.
143 Filesystems in FreeBSD may or may not have special handling for this flag.
144 For instance, ZFS tracks changes to files and will set this bit when a
146 UFS only stores the flag, and relies on the application to change it when
149 The file may be hidden from directory listings at the application's
151 The file has the DOS, Windows and CIFS FILE_ATTRIBUTE_HIDDEN attribute.
153 The file may not be changed.
155 Do not dump the file.
157 The file may not be renamed or deleted.
159 The file is offline, or has the Windows and CIFS FILE_ATTRIBUTE_OFFLINE
161 Filesystems in FreeBSD store and display this flag, but do not provide any
162 special handling when it is set.
164 The directory is opaque when viewed through a union stack.
166 The file is read only, and may not be written or appended.
167 Filesystems may use this flag to maintain compatibility with the DOS, Windows
168 and CIFS FILE_ATTRIBUTE_READONLY attribute.
170 The file contains a Windows reparse point and has the Windows and CIFS
171 FILE_ATTRIBUTE_REPARSE_POINT attribute.
173 The file has the Windows FILE_ATTRIBUTE_SPARSE_FILE attribute.
174 This may also be used by a filesystem to indicate a sparse file.
176 The file has the DOS, Windows and CIFS FILE_ATTRIBUTE_SYSTEM attribute.
177 Filesystems in FreeBSD may store and display this flag, but do not provide
178 any special handling when it is set.
182 .Dv SF_IMMUTABLE , SF_APPEND ,
185 is set a non-super-user cannot change any flags and even the super-user
186 can change flags only if securelevel is 0.
192 .Dv UF_IMMUTABLE , UF_APPEND , UF_NOUNLINK , UF_NODUMP ,
195 flags may be set or unset by either the owner of a file or the super-user.
198 .Dv SF_IMMUTABLE , SF_APPEND , SF_NOUNLINK ,
201 flags may only be set or unset by the super-user.
202 Attempts to toggle these flags by non-super-users are rejected.
203 These flags may be set at any time, but normally may only be unset when
204 the system is in single-user mode.
209 The implementation of all flags is filesystem-dependent.
210 See the description of the
212 flag above for one example of the differences in behavior.
213 Care should be exercised when writing applications to account for
214 support or lack of support of these flags in various filesystems.
218 flag is maintained by the system and cannot be toggled.
224 system call will fail if:
227 A component of the path prefix is not a directory.
228 .It Bq Er ENAMETOOLONG
229 A component of a pathname exceeded 255 characters,
230 or an entire path name exceeded 1023 characters.
232 The named file does not exist.
234 Search permission is denied for a component of the path prefix.
236 Too many symbolic links were encountered in translating the pathname.
238 The effective user ID does not match the owner of the file and
239 the effective user ID is not the super-user.
242 .Dv SF_IMMUTABLE , SF_APPEND ,
245 is set and the user is either not the super-user or
246 securelevel is greater than 0.
248 A non-super-user attempted to toggle one of
249 .Dv SF_ARCHIVED , SF_IMMUTABLE , SF_APPEND ,
253 An attempt was made to toggle the
257 The named file resides on a read-only file system.
262 points outside the process's allocated address space.
266 error occurred while reading from or writing to the file system.
268 Corrupted data was detected while reading from the file system.
270 The underlying file system does not support file flags, or
271 does not support all of the flags set in
277 system call will fail if:
280 The descriptor is not valid.
285 refers to a socket, not to a file.
287 The effective user ID does not match the owner of the file and
288 the effective user ID is not the super-user.
291 .Dv SF_IMMUTABLE , SF_APPEND ,
294 is set and the user is either not the super-user or
295 securelevel is greater than 0.
297 A non-super-user attempted to toggle one of
298 .Dv SF_ARCHIVED , SF_IMMUTABLE , SF_APPEND ,
302 An attempt was made to toggle the
306 The file resides on a read-only file system.
310 error occurred while reading from or writing to the file system.
312 Corrupted data was detected while reading from the file system.
314 The underlying file system does not support file flags, or
315 does not support all of the flags set in
317 .It Bq Er ENOTCAPABLE
320 or contained a ".." component leading to a
321 directory outside of the directory hierarchy specified by
323 and the process is in capability mode.
324 .It Bq Er ENOTCAPABLE
331 does not have its tail fully contained under the topping directory,
347 system calls first appeared in
351 system call first appeared in
355 system call first appeared in