[apple/file_cmds.git] / chflags / chflags.1

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