xref: /netbsd-src/usr.bin/extattr/getextattr.1 (revision 274254cdae52594c1aa480a736aef78313d15c9c)
1.\"	$NetBSD: getextattr.1,v 1.2 2005/01/02 18:41:23 wiz Exp $
2.\"
3.\"-
4.\" Copyright (c) 2000, 2001 Robert N. M. Watson
5.\" Copyright (c) 2002 Networks Associates Technology, Inc.
6.\" All rights reserved.
7.\"
8.\" This software was developed for the FreeBSD Project by Poul-Henning
9.\" Kamp and Network Associates Laboratories, the Security Research Division
10.\" of Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
11.\" ("CBOSS"), as part of the DARPA CHATS research program
12.\"
13.\" Redistribution and use in source and binary forms, with or without
14.\" modification, are permitted provided that the following conditions
15.\" are met:
16.\" 1. Redistributions of source code must retain the above copyright
17.\"    notice, this list of conditions and the following disclaimer.
18.\" 2. Redistributions in binary form must reproduce the above copyright
19.\"    notice, this list of conditions and the following disclaimer in the
20.\"    documentation and/or other materials provided with the distribution.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\" $FreeBSD: src/usr.sbin/extattr/rmextattr.8,v 1.4 2003/02/24 22:53:25 ru Exp $
35.\"
36.Dd January 2, 2005
37.Dt RMEXTATTR 8
38.Os
39.Sh NAME
40.Nm getextattr ,
41.Nm lsextattr ,
42.Nm rmextattr ,
43.Nm setextattr
44.Nd manipulate extended attributes
45.Sh SYNOPSIS
46.Nm getextattr
47.Op Fl fhqsx
48.Ar attrnamespace
49.Ar attrname
50.Ar filename ...
51.Nm lsextattr
52.Op Fl fhq
53.Ar attrnamespace
54.Ar filename ...
55.Nm rmextattr
56.Op Fl fhq
57.Ar attrnamespace
58.Ar attrname
59.Ar filename ...
60.Nm setextattr
61.Op Fl fhnq
62.Ar attrnamespace
63.Ar attrname
64.Ar attrvalue
65.Ar filename ...
66.Sh DESCRIPTION
67These utilities are user tools to manipulate the named extended
68attributes on files and directories.
69The
70.Ar attrnamespace
71argument should be the namespace of the attribute to retrieve: legal
72values are
73.Cm user
74and
75.Cm system .
76The
77.Ar attrname
78argument should be the name of the attribute,
79.Ar filename
80the name of the target file or directory,
81.Ar attrvalue
82a string to store in the attribute.
83.Pp
84The following options are available:
85.Bl -tag -width indent
86.It Fl f
87(Force.)
88Ignore errors on individual filenames and continue with
89the remaining arguments.
90.It Fl h
91(No follow.)
92If the file is a symbolic link, perform the operation on the
93link itself rather than the file that the link points to.
94.It Fl n
95.Dv ( NUL Ns
96-terminate.)
97.Dv NUL Ns
98-terminate the extent content written out.
99.It Fl q
100(Quiet.)
101Do not print out the pathname and suppress error messages.
102.It Fl s
103(Stringify.)
104Escape nonprinting characters and put quotes around the output.
105.It Fl x
106(Hex.)
107Print the output in hexadecimal.
108.El
109.Sh EXAMPLES
110.Bd -literal
111setextattr system md5 `md5 -q /boot/kernel/kernel` /boot/kernel/kernel
112getextattr system md5 /boot/kernel/kernel
113lsextattr system /boot/kernel/kernel
114rmextattr system md5 /boot/kernel/kernel
115.Ed
116.Sh SEE ALSO
117.Xr extattr 2 ,
118.Xr extattr 3 ,
119.Xr extattrctl 8 ,
120.Xr extattr 9
121.Sh HISTORY
122Extended attribute support was developed as part of the
123.Tn TrustedBSD
124Project,
125and introduced in
126.Fx 5.0
127and
128.Nx 3.0 .
129It was developed to support security extensions requiring additional labels
130to be associated with each file or directory.
131.Sh AUTHORS
132.An Robert N M Watson
133.An Poul-Henning Kamp
134.Sh BUGS
135The
136.Nm setextattr
137utility can only be used to set attributes to strings.
138