chflags/chflags.1

   1 .\"     $NetBSD: chflags.1,v 1.6 1997/10/18 12:39:50 lukem Exp $
   2 .\"
   3 .\" Copyright (c) 1989, 1990, 1993, 1994
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to Berkeley by
   7 .\" the Institute of Electrical and Electronics Engineers, Inc.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\" 3. All advertising materials mentioning features or use of this software
  18 .\"    must display the following acknowledgement:
  19 .\"     This product includes software developed by the University of
  20 .\"     California, Berkeley and its contributors.
  21 .\" 4. Neither the name of the University nor the names of its contributors
  22 .\"    may be used to endorse or promote products derived from this software
  23 .\"    without specific prior written permission.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  26 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  29 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35 .\" SUCH DAMAGE.
  36 .\"
  37 .\"     @(#)chflags.1   8.4 (Berkeley) 5/2/95
  38 .\"
  39 .Dd May 2, 1995
  40 .Dt CHFLAGS 1
  41 .Os
  42 .Sh NAME
  43 .Nm chflags
  44 .Nd change file flags
  45 .Sh SYNOPSIS
  46 .Nm
  47 .Oo
  48 .Fl R
  49 .Op Fl H | Fl L | Fl P
  50 .Oc
  51 .Ar flags
  52 .Ar file ...
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 utility modifies the file flags of the listed files
  57 as specified by the
  58 .Ar flags
  59 operand.
  60 .Pp
  61 The options are as follows:
  62 .Bl -tag -width Ds
  63 .It Fl H
  64 If the
  65 .Fl R
  66 option is specified, symbolic links on the command line are followed.
  67 (Symbolic links encountered in the tree traversal are not followed.)
  68 .It Fl L
  69 If the
  70 .Fl R
  71 option is specified, all symbolic links are followed.
  72 .It Fl P
  73 If the
  74 .Fl R
  75 option is specified, no symbolic links are followed.
  76 .It Fl R
  77 Change the file flags for the file hierarchies rooted
  78 in the files instead of just the files themselves.
  79 .El
  80 .Pp
  81 Flags are a comma separated list of keywords.
  82 The following keywords are currently defined:
  83 .Bd -literal -offset indent compact
  84 arch    set the archived flag (super-user only)
  85 opaque  set the opaque flag (owner or super-user only)
  86 nodump  set the nodump flag (owner or super-user only)
  87 sappnd  set the system append-only flag (super-user only)
  88 schg    set the system immutable flag (super-user only)
  89 uappnd  set the user append-only flag (owner or super-user only)
  90 uchg    set the user immutable flag (owner or super-user only)
  91 .Ed
  92 .Pp
  93 Putting the letters
  94 .Dq no
  95 before an option causes the flag to be turned off.
  96 For example:
  97 .Bd -literal -offset indent compact
  98 nouchg  the immutable bit should be cleared
  99 .Ed
 100 .Pp
 101 Symbolic links do not have flags, so unless the
 102 .Fl H
 103 or
 104 .Fl L
 105 option is set,
 106 .Nm
 107 on a symbolic link always succeeds and has no effect.
 108 The
 109 .Fl H ,
 110 .Fl L
 111 and
 112 .Fl P
 113 options are ignored unless the
 114 .Fl R
 115 option is specified.
 116 In addition, these options override each other and the
 117 command's actions are determined by the last one specified.
 118 .Pp
 119 The
 120 .Nm
 121 utility exits 0 on success, and >0 if an error occurs.
 122 .Sh SEE ALSO
 123 .Xr chflags 2 ,
 124 .Xr stat 2 ,
 125 .Xr fts 3 ,
 126 .Xr symlink 7