source: postlfs/filesystems/xfs.xml@ dcee0f2f

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/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-size          "833 KB">
  <!ENTITY xfsprogs-buildsize     "25.2 MB">
  <!ENTITY xfsprogs-time          "0.59 SBU">
]>

<sect1 id="xfs" xreflabel="XFS-&xfsprogs-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="xfsfs.html"?>
<title>XFS-&xfsprogs-version;</title>
<indexterm zone="xfs">
<primary sortas="a-XFS">XFS</primary>
</indexterm>

<sect2>
<title>Introduction to 
<application><acronym>XFS</acronym></application></title>

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

<sect3><title>Package information</title>
<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 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>
</sect3>

</sect2>

<sect2>
<title>Installation of <application>XFS</application></title>

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

<screen><userinput><command>sed -i 's/autoconf//' Makefile &amp;&amp;
make</command></userinput></screen>

<para>Now, as the root user:</para>

<screen><userinput role='root'><command>make install</command></userinput></screen>

</sect2>

<sect2>
<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</seg>
<seg>/usr/share/doc/xfsprogs</seg>
</seglistitem>
</segmentedlist>

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

<varlistentry id="fsck.xfs">
<term><command>fsck.xfs</command></term>
<listitem><para>simply exits with a zero status, since <acronym>XFS</acronym> 
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 <acronym>XFS</acronym> 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 <acronym>XFS</acronym> 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 <acronym>XFS</acronym> 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 <acronym>XFS</acronym> 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 <acronym>XFS</acronym> 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 <acronym>XFS</acronym> 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 <acronym>XFS</acronym> 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 <acronym>XFS</acronym> 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 
<acronym>XFS</acronym> 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 <acronym>XFS</acronym> 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 <acronym>XFS</acronym> 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 
<acronym>XFS</acronym> file system.</para>
<indexterm zone="xfs xfs_ncheck">
<primary sortas="b-xfs_ncheck">xfs_ncheck</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="xfs_repair">
<term><command>xfs_repair</command></term>
<listitem><para>repairs corrupt or damaged <acronym>XFS</acronym>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 
<acronym>XFS</acronym> 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>