xref: /freebsd/usr.sbin/extattr/rmextattr.8 (revision 2008043f386721d58158e37e0d7e50df8095942d)
1.\"-
2.\" Copyright (c) 2000, 2001 Robert N. M. Watson
3.\" Copyright (c) 2002 Networks Associates Technology, Inc.
4.\" All rights reserved.
5.\"
6.\" This software was developed for the FreeBSD Project by Poul-Henning
7.\" Kamp and Network Associates Laboratories, the Security Research Division
8.\" of Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
9.\" ("CBOSS"), as part of the DARPA CHATS research program
10.\"
11.\" Redistribution and use in source and binary forms, with or without
12.\" modification, are permitted provided that the following conditions
13.\" are met:
14.\" 1. Redistributions of source code must retain the above copyright
15.\"    notice, this list of conditions and the following disclaimer.
16.\" 2. Redistributions in binary form must reproduce the above copyright
17.\"    notice, this list of conditions and the following disclaimer in the
18.\"    documentation and/or other materials provided with the distribution.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.Dd April 27, 2016
33.Dt RMEXTATTR 8
34.Os
35.Sh NAME
36.Nm getextattr ,
37.Nm lsextattr ,
38.Nm rmextattr ,
39.Nm setextattr
40.Nd manipulate extended attributes
41.Sh SYNOPSIS
42.Nm getextattr
43.Op Fl fhqsx
44.Ar attrnamespace
45.Ar attrname
46.Ar filename ...
47.Nm lsextattr
48.Op Fl fhq
49.Ar attrnamespace
50.Ar filename ...
51.Nm rmextattr
52.Op Fl fhq
53.Ar attrnamespace
54.Ar attrname
55.Ar filename ...
56.Nm setextattr
57.Op Fl fhnq
58.Ar attrnamespace
59.Ar attrname
60.Ar attrvalue
61.Ar filename ...
62.Nm setextattr
63.Fl i
64.Op Fl fhnq
65.Ar attrnamespace
66.Ar attrname
67.Ar filename ...
68.Sh DESCRIPTION
69These
70utilities
71are user tools to manipulate the named extended attributes on files and
72directories.
73The
74.Ar attrnamespace
75argument should be the namespace of the attribute to retrieve: legal
76values are
77.Cm user
78and
79.Cm system .
80The
81.Ar attrname
82argument should be the name of the attribute,
83.Ar filename
84the name of the target file or directory,
85.Ar attrvalue
86a string to store in the attribute.
87.Pp
88The following options are available:
89.Bl -tag -width indent
90.It Fl f
91(Force.)
92Ignore errors on individual filenames and continue with
93the remaining arguments.
94.It Fl h
95(No follow.)
96If the file is a symbolic link, perform the operation on the
97link itself rather than the file that the link points to.
98.It Fl i
99(From stdin.)
100Read attribute data from stdin instead of as an argument.
101.It Fl n
102.Dv ( NUL Ns
103-terminate.)
104.Dv NUL Ns
105-terminate the extent content written out.
106.It Fl q
107(Quiet.)
108Do not print out the pathname and suppress error messages.
109When given twice, print only the attribute value, with no trailing newline.
110.It Fl s
111(Stringify.)
112Escape nonprinting characters and put quotes around the output.
113.It Fl x
114(Hex.)
115Print the output in hexadecimal.
116.El
117.Sh EXAMPLES
118.Bd -literal
119setextattr system md5 `md5 -q /boot/kernel/kernel` /boot/kernel/kernel
120md5 -q /boot/kernel/kernel | setextattr -i system md5 /boot/kernel/kernel
121getextattr system md5 /boot/kernel/kernel
122getextattr -qq system md5 /boot/kernel/kernel | od -x
123lsextattr system /boot/kernel/kernel
124rmextattr system md5 /boot/kernel/kernel
125.Ed
126.Sh SEE ALSO
127.Xr extattr 2 ,
128.Xr extattr 3 ,
129.Xr extattrctl 8 ,
130.Xr extattr 9
131.Sh HISTORY
132Extended attribute support was developed as part of the
133.Tn TrustedBSD
134Project,
135and introduced in
136.Fx 5.0 .
137It was developed to support security extensions requiring additional labels
138to be associated with each file or directory.
139.Sh AUTHORS
140.An Robert N M Watson
141.An Poul-Henning Kamp
142