source: postlfs/filesystems/xfs.xml@ b4b71892

<?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 " ">
  <!ENTITY xfsprogs-download-ftp "ftp://oss.sgi.com/projects/xfs/download/cmd_tars/xfsprogs-&xfsprogs-version;.src.tar.gz">
  <!ENTITY xfsprogs-size       "827 KB">
  <!ENTITY xfsprogs-buildsize   "42 MB">
  <!ENTITY xfsprogs-time     "0.69 SBU">
]>

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

<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 &amp;&amp;
make install</command></userinput></screen>

</sect2>

<sect2>
<title>Contents</title>

<para><application>XFS</application> contains
<command>fsck.xfs</command>,
<command>mkfs.xfs</command>,
<command>xfs_admin</command>,
<command>xfs_bmap</command>,
<command>xfs_check</command>,
<command>xfs_copy</command>,
<command>xfs_db</command>,
<command>xfs_freeze</command>,
<command>xfs_growfs</command>,
<command>xfs_info</command>,
<command>xfs_io</command>,
<command>xfs_logprint</command>,
<command>xfs_mkfile</command>,
<command>xfs_ncheck</command>,
<command>xfs_repair</command> and
<command>xfs_rtcp</command>.
</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>fsck.xfs</title>
<para><command>fsck.xfs</command> simply exits with a zero status, since
<acronym>XFS</acronym> partitions are checked at mount time.</para></sect3>

<sect3><title>mkfs.xfs</title>
<para><command>mkfs.xfs</command> constructs an <acronym>XFS</acronym> 
file system.</para></sect3>

<sect3><title>xfs_admin</title>
<para><command>xfs_admin</command> changes the parameters of an <acronym>XFS
</acronym> file system.</para></sect3>

<sect3><title>xfs_bmap</title>
<para><command>xfs_bmap</command> prints block mapping for an <acronym>XFS
</acronym> file.</para></sect3>

<sect3><title>xfs_check</title>
<para><command>xfs_check</command> checks <acronym>XFS</acronym> file system 
consistency.</para>
</sect3>

<sect3><title>xfs_copy</title>
<para><command>xfs_copy</command> copies the contents of an
<acronym>XFS</acronym> file system to one or more targets in
parallel.</para></sect3>

<sect3><title>xfs_db</title>
<para><command>xfs_db</command> is used to debug an <acronym>XFS</acronym> 
file system.</para></sect3>

<sect3><title>xfs_freeze</title>
<para><command>xfs_freeze</command> suspends access to an <acronym>XFS</acronym> file system.</para></sect3>

<sect3><title>xfs_growfs</title>
<para><command>xfs_growfs</command> expands an <acronym>XFS</acronym> file system.
</para></sect3>

<sect3><title>xfs_info</title>
<para><command>xfs_info</command> is equivalent to invoking
<command>xfs_growfs</command>, but specifying that no change to the file
system is to be made.</para></sect3>
        
<sect3><title>xfs_io</title>
<para><command>xfs_io</command> 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></sect3>

<sect3><title>xfs_logprint</title>
<para><command>xfs_logprint</command> prints the log of an <acronym>XFS
</acronym> file system.</para></sect3>

<sect3><title>xfs_mkfile</title>
<para><command>xfs_mkfile</command> creates an <acronym>XFS</acronym> file, 
padded with zeroes by default.</para></sect3>

<sect3><title>xfs_ncheck</title>
<para><command>xfs_ncheck</command> generates pathnames from inode numbers for 
an <acronym>XFS</acronym> file system.</para></sect3>

<sect3><title>xfs_repair</title>
<para><command>xfs_repair</command> repairs corrupt or damaged <acronym>XFS
</acronym>file systems.</para></sect3>

<sect3><title>xfs_rtcp</title>
<para><command>xfs_rtcp</command> copies a file to the real-time
partition on an <acronym>XFS</acronym> file system.</para></sect3>

</sect2>

</sect1>