source: chapter06/attr.xml@ 0a56911

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../general.ent">
  %general-entities;
]>

<sect1 id="ch-system-attr" role="wrap">
  <?dbhtml filename="attr.html"?>

  <sect1info condition="script">
    <productname>attr</productname>
    <productnumber>&attr-version;</productnumber>
    <address>&attr-url;</address>
  </sect1info>

  <title>Attr-&attr-version;</title>

  <indexterm zone="ch-system-attr">
    <primary sortas="a-Attr">Attr</primary>
  </indexterm>

  <sect2 role="package">
    <title/>

    <para>The attr package contains utilities to administer the extended
    attributes on filesystem objects.</para>

    <segmentedlist>
      <segtitle>&buildtime;</segtitle>
      <segtitle>&diskspace;</segtitle>

      <seglistitem>
        <seg>&attr-ch6-sbu;</seg>
        <seg>&attr-ch6-du;</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Attr</title>

    <para>Modify the documentation directory so that it is a versioned
    directory:</para>

<screen><userinput remap="pre">sed -i -e 's|/@pkg_name@|&amp;-@pkg_version@|' include/builddefs.in</userinput></screen>

    <para>Prepare Attr for compilation:</para>

<screen><userinput remap="configure">./configure --prefix=/usr --libdir=/lib --libexecdir=/usr/lib</userinput></screen>

    <para>Compile the package:</para>

<screen><userinput remap="make">make</userinput></screen>

    <para>The attr tests need to be run on a filesystem that supports extended
    attributes.  To test the results, issue:</para>

<screen><userinput remap="test">make tests root-tests ext-tests</userinput></screen>

    <para>Install the package:</para>

<screen><userinput remap="install">make install install-dev install-lib</userinput></screen>

  </sect2>

  <sect2 id="contents-attr" role="content">
    <title>Contents of Attr</title>

    <segmentedlist>
      <segtitle>Installed programs</segtitle>
      <segtitle>Installed library</segtitle>
      <segtitle>Installed directories</segtitle>

      <seglistitem>
        <seg>attr, getfattr, and setattr</seg>
        <seg>libattr.{so,a}</seg>
        <seg>/usr/{include/attr,share/doc/attr-&attr-version;}</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="attr">
        <term><command>attr</command></term>
        <listitem>
          <para>Extends attributes on filesystem objects</para>
          <indexterm zone="ch-system-attr attr">
            <primary sortas="b-attr">attr</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="getfattr">
        <term><command>getfattr</command></term>
        <listitem>
          <para>Gets the extended attributes of filesystem objects.</para>
          <indexterm zone="ch-system-attr getfattr">
            <primary sortas="b-getfattr">getfattr</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="setattr">
        <term><command>setattr</command></term>
        <listitem>
          <para>Sets the extended attributes of filesystem objects</para>
          <indexterm zone="ch-system-attr setattr">
            <primary sortas="b-setattr">setattr</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libattr">
        <term><filename class="libraryfile">libattr.{so,a}</filename></term>
        <listitem>
          <para>Contains the <application>attr</application> API functions.</para>
          <indexterm zone="ch-system-attr libattr">
            <primary sortas="c-libattr">libattr.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>