bin/chflags/chflags.1

   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 .\" 4. 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$
  34 .\"
  35 .Dd March 3, 2006
  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
  51 The
  52 .Nm
  53 utility modifies the file flags of the listed files
  54 as specified by the
  55 .Ar flags
  56 operand.
  57 .Pp
  58 The options are as follows:
  59 .Bl -tag -width indent
  60 .It Fl f
  61 Do not display a diagnostic message if
  62 .Nm
  63 could not modify the flags for
  64 .Va file ,
  65 nor modify the exit status to reflect such failures.
  66 .It Fl H
  67 If the
  68 .Fl R
  69 option is specified, symbolic links on the command line are followed.
  70 (Symbolic links encountered in the tree traversal are not followed.)
  71 .It Fl h
  72 If the
  73 .Ar file
  74 is a symbolic link,
  75 change the file flags of the link itself rather than the file to which it points.
  76 .It Fl L
  77 If the
  78 .Fl R
  79 option is specified, all symbolic links are followed.
  80 .It Fl P
  81 If the
  82 .Fl R
  83 option is specified, no symbolic links are followed.
  84 This is the default.
  85 .It Fl R
  86 Change the file flags for the file hierarchies rooted
  87 in the files instead of just the files themselves.
  88 .It Fl v
  89 Cause
  90 .Nm
  91 to be verbose, showing filenames as the flags are modified.
  92 If the
  93 .Fl v
  94 option is specified more than once, the old and new flags of the file
  95 will also be printed, in octal notation.
  96 .El
  97 .Pp
  98 The flags are specified as an octal number or a comma separated list
  99 of keywords.
 100 The following keywords are currently defined:
 101 .Bl -tag -offset indent -width ".Cm opaque"
 102 .It Cm arch , archived
 103 set the archived flag (super-user only)
 104 .It Cm opaque
 105 set the opaque flag (owner or super-user only)
 106 .It Cm nodump
 107 set the nodump flag (owner or super-user only)
 108 .It Cm sappnd , sappend
 109 set the system append-only flag (super-user only)
 110 .It Cm schg , schange , simmutable
 111 set the system immutable flag (super-user only)
 112 .It Cm sunlnk , sunlink
 113 set the system undeletable flag (super-user only)
 114 .It Cm uappnd , uappend
 115 set the user append-only flag (owner or super-user only)
 116 .It Cm uchg , uchange , uimmutable
 117 set the user immutable flag (owner or super-user only)
 118 .It Cm uunlnk , uunlink
 119 set the user undeletable flag (owner or super-user only)
 120 .El
 121 .Pp
 122 Putting the letters
 123 .Dq Ar no
 124 before or removing the letters
 125 .Dq Ar no
 126 from a keyword causes the flag to be cleared.
 127 For example:
 128 .Pp
 129 .Bl -tag -offset indent -width "nouchg" -compact
 130 .It Cm nouchg
 131 clear the user immutable flag (owner or super-user only)
 132 .It Cm dump
 133 clear the nodump flag (owner or super-user only)
 134 .El
 135 .Pp
 136 A few of the octal values include:
 137 .Bl -tag -offset indent -width ".Li 10"
 138 .It Li 0
 139 Clear all file flags.
 140 .It Li 1
 141 Translates to the
 142 .Cm nodump
 143 keyword.
 144 .It Li 2
 145 Translates to the
 146 .Cm uchg
 147 keyword.
 148 .It Li 3
 149 Translates to the
 150 .Cm uchg , nodump
 151 keywords.
 152 .It Li 4
 153 Translates to the
 154 .Cm uappnd
 155 keyword.
 156 .It Li 10
 157 Translates to the
 158 .Cm opaque
 159 keyword.
 160 .It Li 20
 161 translates to the
 162 .Cm uunlnk
 163 keyword.
 164 .El
 165 .Pp
 166 Other combinations of keywords may be placed by using
 167 the octets assigned; however, these are the most notable.
 168 .Pp
 169 Unless the
 170 .Fl H ,
 171 .Fl L ,
 172 or
 173 .Fl h
 174 options are given,
 175 .Nm
 176 on a symbolic link always succeeds and has no effect.
 177 The
 178 .Fl H ,
 179 .Fl L
 180 and
 181 .Fl P
 182 options are ignored unless the
 183 .Fl R
 184 option is specified.
 185 In addition, these options override each other and the
 186 command's actions are determined by the last one specified.
 187 .Pp
 188 You can use "ls -lo" to see the flags of existing files.
 189 .Pp
 190 Note that the ability to change certain flags is dependent
 191 on the current kernel
 192 .Va securelevel
 193 setting.
 194 See
 195 .Xr security 7
 196 for more information on this setting.
 197 .Sh EXIT STATUS
 198 .Ex -std
 199 .Sh SEE ALSO
 200 .Xr ls 1 ,
 201 .Xr chflags 2 ,
 202 .Xr stat 2 ,
 203 .Xr fts 3 ,
 204 .Xr security 7 ,
 205 .Xr symlink 7
 206 .Sh HISTORY
 207 The
 208 .Nm
 209 command first appeared in
 210 .Bx 4.4 .
 211 .Sh BUGS
 212 Only a limited number of utilities are
 213 .Nm
 214 aware.
 215 Some of these tools include
 216 .Xr ls 1 ,
 217 .Xr cp 1 ,
 218 .Xr find 1 ,
 219 .Xr install 1 ,
 220 .Xr dump 8 ,
 221 and
 222 .Xr restore 8 .
 223 In particular a tool which is not currently
 224 .Nm
 225 aware is the
 226 .Xr pax 1
 227 utility.