README
1File-ExtAttr version 1.09
2=========================
3
4File::ExtAttr is a Perl module providing access to the extended attributes
5of files.
6
7Extended attributes are metadata associated with a file.
8Examples are access control lists (ACLs) and other security parameters.
9But users can add their own key=value pairs.
10
11Extended attributes may not be supported by your operating system.
12This module is aimed at Linux, Unix or Unix-like operating systems
13(e.g.: Mac OS X, FreeBSD, NetBSD).
14
15Extended attributes may also not be supported by your filesystem
16or require special options to be enabled for a particular filesystem
17(e.g. "mount -o user_xattr /dev/hda1 /some/path").
18
19Please see the POD documentation for more detailed information
20("perldoc File::ExtAttr").
21
22INSTALLATION
23
24To install this module type the following:
25
26 perl Makefile.PL
27 make
28 make test
29 make install
30
31Installation requires a C compiler.
32
33"make test" will fail if the filesystem you are building and running
34the test suite does not support extended attributes. You can use
35the "ATTR_TEST_DIR" environment variable to make the test suite
36use a different file system, e.g.:
37
38 mkdir -p /path/to/somewhere/with/extattr/test-dir
39 export ATTR_TEST_DIR=/path/to/somewhere/with/extattr/test-dir
40 make test
41
42DEPENDENCIES
43
44On Linux, you will need to install the package that provides
45the header files <attr/attributes.h> and <attr/xattr.h>. On Fedora
46you can install these as follows:
47
48 yum -y install libattr-devel
49
50This module requires these other modules:
51
52 Carp
53 Scalar::Util
54
55This module's test suite is enhanced by the presence of the following
56modules:
57
58 Test::Distribution
59 Test::Pod
60 File::Find::Rule
61 Module::CoreList
62
63COPYRIGHT AND LICENCE
64
65Copyright (C) 2005 by Kevin M. Goess
66
67Copyright (C) 2005, 2006, 2007, 2008 by Richard Dawe
68
69This library is free software; you can redistribute it and/or modify
70it under the same terms as Perl itself, either Perl version 5.8.5 or,
71at your option, any later version of Perl 5 you may have available.
72