summaryrefslogtreecommitdiff
path: root/man/man1/getfattr.1
blob: 35a48c8686b0ae69c0d93a893765b3e58f4c3216 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
.\" Copyright (C) 2002, 2004, 2007  Silicon Graphics, Inc. All rights reserved.
.\" Copyright (C) 2002, 2004, 2007  Andreas Gruenbacher <agruen@suse.de>
.\"
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" The GNU General Public License's references to "object code"
.\" and "executables" are to be interpreted as the output of any
.\" document formatting or typesetting system, including
.\" intermediate and printed output.
.\"
.\" This manual is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public
.\" License along with this manual.  If not, see
.\" <http://www.gnu.org/licenses/>.
.\"
.TH GETFATTR 1 "Extended Attributes" "Dec 2001" "File Utilities"
.SH NAME
getfattr \- get extended attributes of filesystem objects
.SH SYNOPSIS
.nf
\f3getfattr\f1 [\f3\-hRLP\f1] \f3\-n name\f1 [\f3\-e en\f1] \c
\f3pathname\f1...
\f3getfattr\f1 [\f3\-hRLP\f1] \f3\-d\f1 [\f3\-e en\f1] \c
[\f3\-m pattern\f1] \f3pathname\f1...
.fi
.SH DESCRIPTION
For each file,
.B getfattr
displays the file name,
and the set of extended attribute names (and optionally values) which
are associated with that file.
.PP
The output format of
.B "getfattr \-d"
is as follows:
.fam C
.RS
.nf
 1:  # file: somedir/
 2:  user.name0="value0"
 3:  user.name1="value1"
 4:  user.name2="value2"
 5:  ...
.fi
.RE
.fam T
.PP
Line 1 identifies the file name for which the
following lines are being reported.
The remaining lines (lines 2 to 4 above) show the
.I name
and 
.I value
pairs associated with the specified file.
.SH OPTIONS
.TP 4
.BR \-n " \f2name\f1, " \-\-name "=\f2name\f1"
Dump the value of the named extended attribute extended attribute.
.TP
.BR \-d ", " \-\-dump
Dump the values of all extended attributes associated with
.IR pathname .
.TP
.BR \-e " \f2en\f1, " \-\-encoding "=\f2en\f1"
Encode values after retrieving them.
Valid values of
.I en
are "text", "hex", and "base64".
Values encoded as text strings are enclosed in double quotes ("),
while strings encoded as hexidecimal and base64 are prefixed with
0x and 0s, respectively.
.TP
.BR \-h ", " \-\-no-dereference
Do not dereference symlinks. Instead of the file a symlink refers to, the
symlink itself is examined.  Unless doing a logical (\-L) traversal, do not
traverse symlinks to directories.
.TP
.BR \-m " \f2pattern\f1, " \-\-match "=\f2pattern\f1"
Only include attributes with names matching the regular expression
.IR pattern .
The default value for
.I pattern
is "^user\\\\.", 
which includes all the attributes in the user namespace. Specify "\-" for
including all attributes.  Refer to
.BR attr (5)
for a more detailed discussion of namespaces.
.TP
.B \-\-absolute-names
Do not strip leading slash characters ('/').
The default behaviour is to strip leading slash characters.
.TP
.B \-\-only-values
Dump out the raw extended attribute value(s) without encoding them.
.TP
.BR \-R ", " \-\-recursive
List the attributes of all files and directories recursively.
.TP
.BR \-L ", " \-\-logical
Logical walk, follow symbolic links to directories.
The default behaviour is to follow symbolic link arguments unless
\-\-no\-dereference is given, and to skip symbolic links encountered in
subdirectories.
Only effective in combination with \-R.
.TP
.BR \-P ", " \-\-physical
Physical walk, do not follow symbolic links to directories.
This also skips symbolic link arguments.
Only effective in combination with \-R.
.TP
.B \-\-version
Print the version of
.B getfattr
and exit.
.TP
.B \-\-help
Print help explaining the command line options.
.TP
.B \-\-
End of command line options.
All remaining parameters are interpreted as file names, even if they
start with a dash character.
.SH AUTHOR
Andreas Gruenbacher,
.RI < a.gruenbacher@bestbits.at >
and the SGI XFS development team,
.RI < linux-xfs@oss.sgi.com >.
.P
Please send your bug reports or comments to these addresses.
.SH "SEE ALSO"
setfattr(1), and attr(5).