summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBarry Naujok <bnaujok@sgi.com>2007-10-22 15:51:20 +0000
committerBarry Naujok <bnaujok@sgi.com>2007-10-22 15:51:20 +0000
commit338d2e92e858f76f54b05ef83ce5e4df8e71d5b8 (patch)
tree7eb1b6af8b4ce33e3c8e287d2dbb221ccdfb9c73
parent1892120ed3888fdd57170589032f39dcda8e6f46 (diff)
downloadattr-338d2e92e858f76f54b05ef83ce5e4df8e71d5b8.tar.gz
Fix attr man pages
Merge of master-melb:xfs-cmds:29936a by kenmcd. Fix attr man pages
-rw-r--r--man/man1/attr.118
-rw-r--r--man/man5/attr.531
2 files changed, 26 insertions, 23 deletions
diff --git a/man/man1/attr.1 b/man/man1/attr.1
index ab555f1..a1b30b3 100644
--- a/man/man1/attr.1
+++ b/man/man1/attr.1
@@ -16,12 +16,6 @@ attr \- extended attributes on XFS filesystem objects
.SH OVERVIEW
Extended attributes implement the ability for a user to attach
name:value pairs to objects within the XFS filesystem.
-.P
-They could be used to store meta-information about the file.
-For example "character-set=kanji" could tell a document browser to
-use the Kanji character set when displaying that document
-and "thumbnail=..." could provide a reduced resolution overview of a
-high resolution graphic image.
.PP
This document describes the
.I attr
@@ -32,7 +26,13 @@ filesystem independent extended attribute manipulation, consult the
and
.IR setfattr (1)
documentation.
-.P
+.PP
+Extended attributes can be used to store meta-information about the file.
+For example "character-set=kanji" could tell a document browser to
+use the Kanji character set when displaying that document
+and "thumbnail=..." could provide a reduced resolution overview of a
+high resolution graphic image.
+.PP
In the XFS filesystem, the
.I names
can be up to 256 bytes in length, terminated by the first 0 byte.
@@ -41,10 +41,10 @@ names for the attribute.
The
.I values
can be up to 64KB of arbitrary binary data.
-.P
+.PP
Attributes can be attached to all types of XFS inodes:
regular files, directories, symbolic links, device nodes, etc.
-.P
+.PP
XFS uses 2 disjoint attribute name spaces associated with every
filesystem object.
They are the
diff --git a/man/man5/attr.5 b/man/man5/attr.5
index 27ae67b..43cb8cd 100644
--- a/man/man5/attr.5
+++ b/man/man5/attr.5
@@ -32,12 +32,8 @@ Writing replaces any previous value with the new value.
Space consumed for extended attributes is counted towards the disk quotas
of the file owner and file group.
.PP
-Currently, support for extended attributes is implemented on Linux by
-the ext2, ext3 and XFS filesystem patches, which can be downloaded from
-.B http://acl.bestbits.at/
-and
-.B http://oss.sgi.com/projects/xfs/
-respectively.
+Currently, support for extended attributes is implemented on Linux by the
+ext2, ext3, ext4, XFS, JFS and reiserfs filesystems.
.SH EXTENDED ATTRIBUTE NAMESPACES
Attribute names are zero-terminated strings.
The attribute name is always specified in the fully qualified
@@ -106,16 +102,23 @@ manual page for an explanation of Sticky Directories).
.SH FILESYSTEM DIFFERENCES
The kernel and the filesystem may place limits on the maximum number
and size of extended attributes that can be associated with a file.
+Some file systems, such as ext2/3 and reiserfs, require the filesystem
+to be mounted with the
+.B user_xattr
+mount option in order for extended user attributes to be used.
+.PP
+In the current ext2, ext3 and ext4 filesystem implementations, each
+extended attribute must fit on a single filesystem block (1024, 2048
+or 4096 bytes, depending on the block size specified when the
+filesystem was created).
.PP
-In the current ext2 and ext3 filesystem implementations, all extended
-attributes must fit on a single filesystem block (1024, 2048 or 4096 bytes,
-depending on the block size specified when the filesystem
-was created). This limit may be removed in a future version.
+In the XFS and reiserfs filesystem implementations, there is no
+practical limit on the number or size of extended attributes
+associated with a file, and the algorithms used to store extended
+attribute information on disk are scalable.
.PP
-In the XFS filesystem implementation, there is no practical limit on the
-number of extended attributes associated with a file, and the algorithms
-used to store extended attribute information on disk are scalable (stored
-either inline in the inode, as an extent, or in a B+ tree).
+In the JFS filesystem implementation, names can be up to 255 bytes and
+values up to 65,535 bytes.
.SH ADDITIONAL NOTES
Since the filesystems on which extended attributes are stored might also
be used on architectures with a different byte order and machine word