[BACK]Return to xfs_attr.html CVS log [TXT][DIR] Up to [Development] / xfs-website.orig / manpages
File: [Development] / xfs-website.orig / manpages / xfs_attr.html (download) (as text)

Revision 1.1, Wed Sep 27 05:01:47 2000 UTC (17 years, 1 month ago) by xfs
Branch: MAIN
CVS Tags: HEAD 

Update manpages.
These changes from Martin Peterson.

<html>
<head>
<meta name="Content-Style" content="text/css">
</head>
<body>
<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#OVERVIEW">OVERVIEW</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#NOTES">NOTES</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>
<!-- Creator     : groff version 1.15  -->
<!-- CreationDate: Tue Sep 26 23:59:38 2000
 -->
<!-- Total number of pages: 2 -->
<!-- Page: 1 -->
<!-- left  margin: 100 -->
<!-- right margin: 750 -->
<a name="NAME"></a><h2>NAME</h2><p><font size=3>xfs_attr - manipulate Extended Attributes on filesystem objects</p>
<a name="SYNOPSIS"></a><h2>SYNOPSIS</h2>
<table width="100%"  rules="none"  frame="none"  cols="2">
<tr valign="top" align="left">
<td valign="top" align="left"  width="52.0000%">
<p><font size=3><B>xfs_attr</B> <font size=3>[ <font size=3><B>-LRq</B> <font size=3>] <font size=3><B>-s attrname</B> <font size=3>[ <font size=3><B>-V attrvalue</B> <font size=3>] <font size=3><B>pathname</p>
</B><p><font size=3><B>xfs_attr</B> <font size=3>[ <font size=3><B>-LRq</B> <font size=3>] <font size=3><B>-g attrname pathname</p>
</B><p><font size=3><B>xfs_attr</B> <font size=3>[ <font size=3><B>-LRq</B> <font size=3>] <font size=3><B>-r attrname pathname</p>
</B><p><font size=3><B>xfs_attr</B> <font size=3>[ <font size=3><B>-LRq</B> <font size=3>] <font size=3><B>-l pathname</p>
</B></td>
<td valign="top" align="left"  width="48.0000%">
</td>
</tr>
</table>
<a name="OVERVIEW"></a><h2>OVERVIEW</h2><p><font size=3>Extended Attributes implement the ability for a user to attach name/value pairs to objects within the filesystem. They are currently only supported in XFS filesystems.</p>
<p><font size=3>They could be used to store meta-information about the file. For example "character-set=kanji" could tell a docu- ment 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.</p>
<p><font size=3>The <font size=3><I>names</I> <font size=3>can be up to 256 bytes in length, terminated by the first 0 byte. The intent is that they be printable ASCII (or other character set) names for the attribute.</p>
<p><font size=3>The <font size=3><I>values</I> <font size=3>can be up to 256KB of arbitrary binary data.</p>
<p><font size=3>Attributes can be attached to all types of inodes: regular files, directories, symbolic links, device nodes, etc.</p>
<p><font size=3>There are 2 disjoint attribute name spaces associated with every filesystem object. They are the <font size=3><B>root</B> <font size=3>and <font size=3><B>user</B> <font size=3>address spaces. The <font size=3><B>root</B> <font size=3>address space is accessable only to the superuser, and then only by specifying a flag argument to the function call. Other users will not see or be able to modify attributes in the <font size=3><B>root</B> <font size=3>address space. The <font size=3><B>user</B> <font size=3>address space is protected by the normal file permissions mechanism, so the owner of the file can decide who is able to see and/or modify the value of attributes on any particular file.</p>
<p><font size=3>Attributes are currently supported only in the XFS filesystem type.</p>
<a name="DESCRIPTION"></a><h2>DESCRIPTION</h2><p><font size=3>The <font size=3><I>xfs_attr</I> <font size=3>utility allows the manipulation of Extended Attributes associated with filesystem objects from within shell scripts.</p>
<p><font size=3>There are four main operations that <font size=3><I>xfs_attr</I> <font size=3>can perform:</p>

<table width="100%"  rules="none"  frame="none"  cols="3">
<tr valign="top" align="left">
<td valign="top" align="left"  width="13.3846%">
<p><font size=3><B>GET</p>
</B></td>
<td valign="top" align="left"  width="6.6154%">
</td>
<td valign="top" align="left"  width="80.0000%">
<p><font size=3>The <font size=3><B>-g attrname</B> <font size=3>option tells <font size=3><I>xfs_attr</I> <font size=3>to search the named object and print (to <font size=3><EM>stdout</EM><font size=3>) the value associated with that attribute name. With the <font size=3><B>-q</B> <font size=3>flag, <font size=3><EM>stdout</EM> <font size=3>will be exactly and only the value of the attribute, suitable for storage directly into a file or processing via a piped command.</p>
</td>
</tr>
<tr valign="top" align="left">
<td valign="top" align="left"  width="13.3846%">
<p><font size=3><B>LIST</p>
</B></td>
<td valign="top" align="left"  width="6.6154%">
</td>
<td valign="top" align="left"  width="80.0000%">
<p><font size=3>The <font size=3><B>-l</B> <font size=3>option tells <font size=3><I>xfs_attr</I> <font size=3>to list the names of all the attributes that are associated with the object, and the number of bytes in the value of each of those attributes. With the <font size=3><B>-q</B> <font size=3>flag, <font size=3><EM>stdout</EM> <font size=3>will be a simple list of only the attribute names, one per line, suitable for input into a script.</p>
</td>
</tr>
<tr valign="top" align="left">
<td valign="top" align="left"  width="13.3846%">
<p><font size=3><B>REMOVE</p>
</B></td>
<td valign="top" align="left"  width="6.6154%">
</td>
<td valign="top" align="left"  width="80.0000%">
<p><font size=3>The <font size=3><B>-r attrname</B> <font size=3>option tells <font size=3><I>xfs_attr</I> <font size=3>to remove an attribute with the given name from the object if the attribute exists. There is no output on sucessful completion.</p>
</td>
</tr>
<tr valign="top" align="left">
<td valign="top" align="left"  width="13.3846%">
<p><font size=3><B>SET/CREATE</p>
</B></td>
<td valign="top" align="left"  width="6.6154%">
</td>
<td valign="top" align="left"  width="80.0000%">
<p><font size=3>The <font size=3><B>-s attrname</B> <font size=3>option tells <font size=3><I>xfs_attr</I> <font size=3>to set the named attribute of the object to the value read from <font size=3><EM>stdin</EM><font size=3>. If an attribute with that name already exists, its value will be replaced with this one. If an attribute with that name does not already exist, one will be created with this value. With the <font size=3><B>-V attrvalue</B> <font size=3>flag, the attribute will be set to have a value of <font size=3><B>attrvalue</B> <font size=3>and <font size=3><EM>stdin</EM> <font size=3>will not be read. With the <font size=3><B>-q</B> <font size=3>flag, <font size=3><EM>stdout</EM> <font size=3>will not be used. Without the <font size=3><B>-q</B> <font size=3>flag, a mes- sage showing the attribute name and the entire value will be printed.</p>
</td>
</tr>
</table>
<p><font size=3>When the <font size=3><B>-L</B> <font size=3>option is given and the named object is a symbolic link, operate on the attributes of the object refer- enced by the symbolic link. Without this option, operate on the attributes of the symbolic link itself.</p>
<p><font size=3>When the <font size=3><B>-R</B> <font size=3>option is given and the process has appropriate privileges, operate in the <font size=3><I>root</I> <font size=3>attribute namespace rather that the <font size=3><I>USER</I> <font size=3>attribute namespace.</p>
<p><font size=3>When the <font size=3><B>-q</B> <font size=3>option is given <font size=3><I>xfs_attr</I> <font size=3>will try to keep quiet. It will output error messages (to <font size=3><EM>stderr</EM><font size=3>) but will not print status messages (to <font size=3><EM>stdout</EM><font size=3>).</p>
<a name="NOTES"></a><h2>NOTES</h2><p><font size=3>The standard file interchange/archive programs <font size=3><I>tar</I><font size=3>(1), <font size=3><I>cpio</I><font size=3>(1), and <font size=3><I>bru</I><font size=3>(1) will not archive or restore Extended Attributes, while the <font size=3><I>xfsdump</I><font size=3>(8) program will.</p>
<p><span style=" text-indent: 6.3600in;"></span><font size=3>0a<br>
</p>

<!-- Page: 2  -->
<!-- left  margin: 100 -->
<!-- right margin: 750 -->
<a name="SEE ALSO"></a><h2>SEE ALSO</h2><p><font size=3>attr_get(2), attr_getf(2), attr_list(2), attr_listf(2), attr_multi(2), attr_multif(2), attr_remove(2), attr_removef(2), attr_set(2), attr_setf(2), xfsdump(8).</p>
<p><span style=" text-indent: 6.3600in;"></span><font size=3>0b<br>
</p>
</body>
</html>