source: postlfs/filesystems/xfs.xml@ 2da2e6a

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

  <!ENTITY xfsprogs-download-http "http://mirrors.sunsite.dk/xfs/download/cmd_tars/xfsprogs-&xfsprogs-version;.src.tar.gz">
  <!ENTITY xfsprogs-download-ftp  "ftp://oss.sgi.com/projects/xfs/download/cmd_tars/xfsprogs-&xfsprogs-version;.src.tar.gz">
  <!ENTITY xfsprogs-md5sum        "d4a78fced98c0f3f32627a473e8e0a59">
  <!ENTITY xfsprogs-size          "878 KB">
  <!ENTITY xfsprogs-buildsize     "17.3 MB">
  <!ENTITY xfsprogs-time          "0.78 SBU">
]>

<sect1 id="xfs" xreflabel="XFS-&xfsprogs-version;">
  <?dbhtml filename="xfsfs.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">xfsprogs-&xfsprogs-version;.src.tar</keyword>
      <keyword role="ftpdir">xfsprogs</keyword>
    </keywordset>
  </sect1info>

  <title>XFS-&xfsprogs-version;</title>

  <indexterm zone="xfs">
    <primary sortas="a-XFS">XFS</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to XFS</title>

    <para>The <application>XFS</application> package contains administration
    and debugging tools for the XFS file system.</para>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&xfsprogs-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&xfsprogs-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &xfsprogs-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &xfsprogs-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &xfsprogs-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &xfsprogs-time;</para>
      </listitem>
    </itemizedlist>

  </sect2>

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

    <note>
      <para>If you did not install the
      <ulink url="&lfs-root;/chapter06/e2fsprogs.html">E2fsprogs</ulink>
      package in LFS, you must install it, or
      <ulink url="http://pecl.php.net/package/uuid">UUID</ulink> before
      proceeding with the installation of <application>XFS</application>.</para>
    </note>

    <para>Install <application>XFS</application> by running the following
    commands:</para>

<screen><userinput>sed -i '/autoconf/d' Makefile &amp;&amp;
make DEBUG=-DNDEBUG</userinput></screen>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install</userinput></screen>

    <para>The <application>XFS</application> library installation is
    incomplete.  To finish the installation, issue the following commands
    as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>chmod -v 755 /lib/libhandle.so* &amp;&amp;
install -v -m755 -D libhandle/libhandle.la /usr/lib/libhandle.la &amp;&amp;
install -v -m644 libhandle/.libs/libhandle.a /usr/lib &amp;&amp;
ln -sv ../../lib/libhandle.so.1 /usr/lib/libhandle.so</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><command>sed -i '/autoconf/d' Makefile</command>: This command
    disables running <command>autoconf</command> because it is
    unnecessary.</para>

    <para><command>make DEBUG=-DNDEBUG</command>: The <application>XFS
    </application> build will fail using the default -DDEBUG flags.</para>

    <para><parameter>OPTIMIZER="..."</parameter>: Adding this parameter to
    the <command>make</command> command overrides the default optimization
    settings.</para>

    <para><command>install -v ...</command>: These commands install the
    static library and libtool archive for <filename>libhandle</filename>.</para>

    <para><command>ln -sv ...</command>: This command installs a symlink
    that is missed by the <command>make install</command> command.</para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>fsck.xfs, mkfs.xfs, xfs_admin, xfs_bmap, xfs_check, xfs_copy,
        xfs_db, xfs_freeze, xfs_growfs, xfs_info, xfs_io, xfs_logprint,
        xfs_mkfile, xfs_ncheck, xfs_repair, and xfs_rtcp</seg>
        <seg>libhandle.[so,a]</seg>
        <seg>/usr/share/doc/xfsprogs</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="fsck.xfs">
        <term><command>fsck.xfs</command></term>
        <listitem>
          <para>simply exits with a zero status, since XFS
          partitions are checked at mount time.</para>
          <indexterm zone="xfs fsck.xfs">
            <primary sortas="b-fsck.xfs">fsck.xfs</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mkfs.xfs">
        <term><command>mkfs.xfs</command></term>
        <listitem>
          <para>constructs an XFS file system.</para>
          <indexterm zone="xfs mkfs.xfs">
            <primary sortas="b-mkfs.xfs">mkfs.xfs</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xfs_admin">
        <term><command>xfs_admin</command></term>
        <listitem>
          <para>changes the parameters of an XFS file system.</para>
          <indexterm zone="xfs xfs_admin">
            <primary sortas="b-xfs_admin">xfs_admin</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xfs_bmap">
        <term><command>xfs_bmap</command></term>
        <listitem>
          <para>prints block mapping for an XFS file.</para>
          <indexterm zone="xfs xfs_bmap">
            <primary sortas="b-xfs_bmap">xfs_bmap</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xfs_check">
        <term><command>xfs_check</command></term>
        <listitem>
          <para>checks XFS file system consistency.</para>
          <indexterm zone="xfs xfs_check">
            <primary sortas="b-xfs_check">xfs_check</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xfs_copy">
        <term><command>xfs_copy</command></term>
        <listitem>
          <para>copies the contents of an XFS file system
          to one or more targets in parallel.</para>
          <indexterm zone="xfs xfs_copy">
            <primary sortas="b-xfs_copy">xfs_copy</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xfs_db">
        <term><command>xfs_db</command></term>
        <listitem>
          <para>is used to debug an XFS file system.</para>
          <indexterm zone="xfs xfs_db">
            <primary sortas="b-xfs_db">xfs_db</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xfs_freeze">
        <term><command>xfs_freeze</command></term>
        <listitem>
          <para>suspends access to an XFS file system.</para>
          <indexterm zone="xfs xfs_freeze">
            <primary sortas="b-xfs_freeze">xfs_freeze</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xfs_growfs">
        <term><command>xfs_growfs</command></term>
        <listitem>
          <para>expands an XFS file system.</para>
          <indexterm zone="xfs xfs_growfs">
            <primary sortas="b-xfs_growfs">xfs_growfs</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xfs_info">
        <term><command>xfs_info</command></term>
        <listitem>
          <para>is equivalent to invoking <command>xfs_growfs</command>, but
          specifying that no change to the file system is to be made.</para>
          <indexterm zone="xfs xfs_info">
            <primary sortas="b-xfs_info">xfs_info</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xfs_io">
        <term><command>xfs_io</command></term>
        <listitem>
          <para>is a debugging tool like <command>xfs_db</command>, but is
          aimed at examining the regular file I/O path rather than the raw
          XFS volume itself.</para>
          <indexterm zone="xfs xfs_io">
            <primary sortas="b-xfs_io">xfs_io</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xfs_logprint">
        <term><command>xfs_logprint</command></term>
        <listitem>
          <para>prints the log of an XFS file system.</para>
          <indexterm zone="xfs xfs_logprint">
            <primary sortas="b-xfs_logprint">xfs_logprint</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xfs_mkfile">
        <term><command>xfs_mkfile</command></term>
        <listitem>
          <para>creates an XFS file, padded with zeroes by default.</para>
          <indexterm zone="xfs xfs_mkfile">
            <primary sortas="b-xfs_mkfile">xfs_mkfile</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xfs_ncheck">
        <term><command>xfs_ncheck</command></term>
        <listitem>
          <para>generates pathnames from inode numbers for an
          XFS file system.</para>
          <indexterm zone="xfs xfs_ncheck">
            <primary sortas="b-xfs_ncheck">xfs_ncheck</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xfs_quota">
        <term><command>xfs_quota</command></term>
        <listitem>
          <para>is a utility for reporting and editing various
          aspects of filesystem quota.</para>
          <indexterm zone="xfs xfs_quota">
            <primary sortas="b-xfs_quota">xfs_quota</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xfs_repair">
        <term><command>xfs_repair</command></term>
        <listitem>
          <para>repairs corrupt or damaged XFS file systems.</para>
          <indexterm zone="xfs xfs_repair">
            <primary sortas="b-xfs_repair">xfs_repair</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xfs_rtcp">
        <term><command>xfs_rtcp</command></term>
        <listitem>
          <para>copies a file to the real-time partition on an
          XFS file system.</para>
          <indexterm zone="xfs xfs_rtcp">
            <primary sortas="b-xfs_rtcp">xfs_rtcp</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libhandle">
        <term><filename class='libraryfile'>libhandle.so</filename></term>
        <listitem>
          <para>contains functions to map filesystem handles to a
          corresponding open file descriptor for that filesystem.</para>
          <indexterm zone="xfs libhandle">
            <primary sortas="c-libhandle">libhandle.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>