xref: /netbsd-src/usr.bin/chflags/chflags.1 (revision 52efc5a51db248c4e2bca587e723c9802783d370)

.\"	$NetBSD: chflags.1,v 1.32 2023/05/31 20:33:22 uwe Exp $
.\"
.\" Copyright (c) 1989, 1990, 1993, 1994
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the Institute of Electrical and Electronics Engineers, Inc.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)chflags.1	8.4 (Berkeley) 5/2/95
.\"
.Dd May 25, 2023
.Dt CHFLAGS 1
.Os
.Sh NAME
.Nm chflags
.Nd change file flags
.Sh SYNOPSIS
.Nm
.Oo
.Fl R
.Op Fl H | Fl L | Fl P
.Oc
.Op Fl d
.Op Fl h
.Ar flags
.Ar
.Sh DESCRIPTION
The
.Nm
utility modifies the file flags of the listed files
as specified by the
.Ar flags
operand.
.Pp
The options are as follows:
.Bl -tag -width Fl
.It Fl d
If the change requested would not alter the
flags currently set for
.Ar file
then attempt no change operation.
.It Fl H
If the
.Fl R
option is specified, symbolic links on the command line are followed.
Symbolic links encountered in the tree traversal are not followed.
.It Fl h
If the
.Ar file
or a file encountered during directory traversal is a symbolic link,
the file flags of the link itself are changed.
.It Fl L
If the
.Fl R
option is specified, all symbolic links are followed.
.It Fl P
If the
.Fl R
option is specified, no symbolic links are followed.
.It Fl R
Change the file flags for the file hierarchies rooted
in the
.Ar file\^ Ns s
instead of just the
.Ar file\^ Ns s
themselves.
.El
.Pp
Flags are a comma separated list of keywords.
The following keywords are currently defined:
.\" XXX: list the actual chflags(2) macro names
.Bl -column -offset indent ".Sy Keyword" "system append-only"
.It Sy Keyword Ta Sy Flag Ta Sy Permission
.It Li arch Ta archived Ta super-user only
.It Li opaque Ta opaque Ta owner or super-user
.It Li nodump Ta nodump Ta owner or super-user
.It Li sappnd Ta system append-only Ta super-user only
.It Li schg Ta system immutable Ta super-user only
.It Li uappnd Ta user append-only Ta owner or super-user
.It Li uchg Ta user immutable Ta owner or super-user
.El
.Pp
Putting the letters
.Sq Cm no
before a keyword causes the flag to be turned off.
For example,
.Li nouchg
requests the immutable bit should be cleared.
.Pp
The
.Fl H ,
.Fl L
and
.Fl P
options are ignored unless the
.Fl R
option is specified.
In addition, these options override each other and the
command's actions are determined by the last one specified.
The default is as if the
.Fl P
option had been specified.
.Pp
The
.Fl o
option
of
.Xr ls 1
is used to display the flags.
.Pp
The kernel does not allow the flags on block and character
devices to be changed except by the super-user.
.Pp
Note that the ability to clear certain flags is
dependent on the current kernel
.Va securelevel .
See
.Xr secmodel_securelevel 9
for details.
.Sh EXIT STATUS
.Ex -std
.Sh SEE ALSO
.Xr ls 1 ,
.Xr chflags 2 ,
.Xr lchflags 2 ,
.Xr stat 2 ,
.Xr fts 3 ,
.Xr stat_flags 3 ,
.Xr symlink 7 ,
.Xr dump 8 ,
.Xr init 8 ,
.Xr secmodel_securelevel 9