1.\"- 2.\" Copyright (c) 1989, 1990, 1993, 1994 3.\" The Regents of the University of California. All rights reserved. 4.\" 5.\" This code is derived from software contributed to Berkeley by 6.\" the Institute of Electrical and Electronics Engineers, Inc. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation and/or other materials provided with the distribution. 16.\" 3. 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.1 8.4 (Berkeley) 5/2/95 33.\" $FreeBSD: head/bin/chflags/chflags.1 282208 2015-04-29 00:49:00Z smh $ 34.\" 35.Dd May 11, 2016 36.Dt CHFLAGS 1 37.Os 38.Sh NAME 39.Nm chflags 40.Nd change file flags 41.Sh SYNOPSIS 42.Nm 43.Op Fl fhv 44.Oo 45.Fl R 46.Op Fl H | Fl L | Fl P 47.Oc 48.Ar flags 49.Ar 50.Sh DESCRIPTION 51The 52.Nm 53utility modifies the file flags of the listed files 54as specified by the 55.Ar flags 56operand. 57.Pp 58The options are as follows: 59.Bl -tag -width indent 60.It Fl f 61Do not display a diagnostic message if 62.Nm 63could not modify the flags for 64.Va file , 65nor modify the exit status to reflect such failures. 66.It Fl H 67If the 68.Fl R 69option is specified, symbolic links on the command line are followed 70and hence unaffected by the command. 71(Symbolic links encountered during traversal are not followed.) 72.It Fl h 73If the 74.Ar file 75is a symbolic link, 76change the file flags of the link itself rather than the file to which 77it points. 78.It Fl L 79If the 80.Fl R 81option is specified, all symbolic links are followed. 82.It Fl P 83If the 84.Fl R 85option is specified, no symbolic links are followed. 86This is the default. 87.It Fl R 88Change the file flags of the file hierarchies rooted in the files, 89instead of just the files themselves. 90Beware of unintentionally matching the 91.Dq Pa ".." 92hard link to the parent directory when using wildcards like 93.Dq Li ".*" . 94.It Fl v 95Cause 96.Nm 97to be verbose, showing filenames as the flags are modified. 98If the 99.Fl v 100option is specified more than once, the old and new flags of the file 101will also be printed, in octal notation. 102.El 103.Pp 104The flags are specified as an octal number or a comma separated list 105of keywords. 106The following keywords are currently defined: 107.Bl -tag -offset indent -width ".Cm nouhistory" 108.It Cm arch , archived 109set the archived flag (super-user only) 110.It Cm opaque 111set the opaque flag (owner or super-user only) 112.It Cm nodump 113set the nodump flag (owner or super-user only) 114.It Cm noshistory 115set the system nohistory flag (super-user only) 116.It Cm nouhistory , nohistory 117set the user nohistory flag (owner or super-user only) 118.It Cm sappnd , sappend 119set the system append-only flag (super-user only) 120.It Cm schg , schange , simmutable 121set the system immutable flag (super-user only) 122.It Cm sunlnk , sunlink 123set the system undeletable flag (super-user only) 124.It Cm uappnd , uappend 125set the user append-only flag (owner or super-user only) 126.It Cm uchg , uchange , uimmutable 127set the user immutable flag (owner or super-user only) 128.It Cm uunlnk , uunlink 129set the user undeletable flag (owner or super-user only) 130.It Cm cache , ucache 131control the data 132.Xr swapcache 8 133(recursive, does not cross mounts) (owner or super-user only) 134.It Cm noscache 135control the data 136.Xr swapcache 8 137(recursive, does not cross mounts) (super-user only) 138.El 139.Pp 140If a 141.Dq Cm no 142prefix is added or removed from a keyword, the meaning is negated. 143For example: 144.Pp 145.Bl -tag -offset indent -width "nouchg" -compact 146.It Cm nouchg 147clear the user immutable flag (owner or super-user only) 148.It Cm dump 149clear the nodump flag (owner or super-user only) 150.El 151.Pp 152A few of the octal values include: 153.Bl -tag -offset indent -width ".Li 10" 154.It Li 0 155Clear all file flags. 156.It Li 1 157Translates to the 158.Cm nodump 159keyword. 160.It Li 2 161Translates to the 162.Cm uchg 163keyword. 164.It Li 3 165Translates to the 166.Cm uchg , nodump 167keywords. 168.It Li 4 169Translates to the 170.Cm uappnd 171keyword. 172.It Li 10 173Translates to the 174.Cm opaque 175keyword. 176.It Li 20 177translates to the 178.Cm uunlnk 179keyword. 180.El 181.Pp 182Other combinations of keywords may be placed by using 183the octets assigned; however, these are the most notable. 184.Pp 185Unless the 186.Fl H , 187.Fl L , 188or 189.Fl h 190options are given, 191.Nm 192on a symbolic link always succeeds and has no effect. 193The 194.Fl H , 195.Fl L 196and 197.Fl P 198options are ignored unless the 199.Fl R 200option is specified. 201In addition, these options override each other and the 202command's actions are determined by the last one specified. 203.Pp 204You can use 205.Dq Li "ls -lo" 206to see the flags of existing files. 207.Pp 208Note that the ability to change certain flags is dependent 209on the current kernel 210.Va securelevel 211setting. 212See 213.Xr security 7 214for more information on this setting. 215.Sh SWAPCACHE FLAGS 216The 217.Cm cache 218bit may be set to enable 219.Xr swapcache 8 220data caching. 221The superuser flag, 222.Cm noscache 223may be used to disable 224.Xr swapcache 8 225data caching and overrides the user flag. 226.Pp 227The flag is recursive but does not cross mount points. 228Setting it on a top-level directories or mount point will 229automatically apply the flag to the entire subtree or until 230a mount point is hit. 231You may have to refresh the namecache with a dummy 232.Xr find 1 233command after changing the flag in a top level directory. 234You do not have to recursive set the flag with 235.Nm 236.Fl R 237and, in fact, we do not recommend it under any circumstances. 238Filesystems which do not support flags generally have a 239.Cm cache 240mount option to enable swapcache operation on the mount. 241.Pp 242If you intend to use swapcache data the 243.Cm vm.swapcache.use_chflags 244sysctl determines whether the 245.Nm 246flags are used or not. 247If turned off and 248.Cm vm.swapcache.data_enable 249is turned on, data caching is turned on globally and the 250file flags are ignored. 251If 252.Cm use_chflags 253is turned on along with 254.Cm data_enable 255then only subtrees marked cacheable will be swapcached. 256.Pp 257You would typically want to enable the cache on 258.Pa /usr , /home , 259and 260.Pa /bin 261and disable it for 262.Pa /usr/obj . 263Alternatively if you want to cache 264NFS mounts (where 265.Nm 266doesn't work), you can set the flag on 267some parent directory, possibly even the root 268.Pq Pa / 269itself, 270and then selectively disable it in places where you don't want it. 271.Pp 272This only applies to data caching. 273Meta-data caching is universal when enabled. 274.Sh EXIT STATUS 275.Ex -std 276.Sh SEE ALSO 277.Xr ls 1 , 278.Xr chflags 2 , 279.Xr stat 2 , 280.Xr fts 3 , 281.Xr security 7 , 282.Xr symlink 7 , 283.Xr swapcache 8 284.Sh HISTORY 285The 286.Nm 287command first appeared in 288.Bx 4.4 . 289.Sh BUGS 290Only a limited number of utilities are 291.Nm 292aware. 293Some of these tools include 294.Xr ls 1 , 295.Xr cp 1 , 296.Xr find 1 , 297.Xr install 1 , 298.Xr dump 8 , 299and 300.Xr restore 8 . 301In particular a tool which is not currently 302.Nm 303aware is the 304.Xr pax 1 305utility. 306