source: chapter06/e2fsprogs.xml@ 2ec64b3

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 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;
]>
<sect1 id="ch-system-e2fsprogs" xreflabel="E2fsprogs">
<title>E2fsprogs-&e2fsprogs-version;</title>
<?dbhtml filename="e2fsprogs.html"?>

<indexterm zone="ch-system-e2fsprogs"><primary sortas="a-E2fsprogs">E2fsprogs</primary></indexterm>

<para>The E2fsprogs package contains the utilities for handling the ext2
file system. It also supports the ext3 journaling file system.</para>

<screen>&buildtime; 0.6 SBU
&diskspace; 48.4 MB</screen>

<para>E2fsprogs installation depends on: Bash, Binutils, Coreutils,
Diffutils, Gawk, GCC, Gettext, Glibc, Grep, Make, Sed, Texinfo.</para>



<sect2>
<title>Installation of E2fsprogs</title>

<para>It is recommended to build E2fsprogs outside of the
source tree:</para>

<screen><userinput>mkdir ../e2fsprogs-build
cd ../e2fsprogs-build</userinput></screen>

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

<screen><userinput>../e2fsprogs-&e2fsprogs-version;/configure --prefix=/usr --with-root-prefix="" \
    --enable-elf-shlibs</userinput></screen>

<para>The meaning of the configure options:</para>

<itemizedlist>
<listitem><para><userinput>--with-root-prefix=""</userinput>: Certain
programs (such as the e2fsck program) are considered essential programs.
When, for example, <filename class="directory">/usr</filename> isn't
mounted, these essential programs have to be available. They belong in
directories like <filename class="directory">/lib</filename> and
<filename class="directory">/sbin</filename>. If this option isn't passed
to E2fsprogs's configure, the programs are placed in the
<filename class="directory">/usr</filename> directory, which is not what we
want.</para></listitem>

<listitem><para><userinput>--enable-elf-shlibs</userinput>: This creates
the shared libraries which some programs in this package use.</para></listitem>
</itemizedlist>

<para>Compile the package:</para>

<screen><userinput>make</userinput></screen>

<para>If you to test the results, first make sure an mtab file
exists with <userinput>touch /etc/mtab</userinput> to prevent some sixty tests
from failing, and (if it doesn't already exist) fake the presence of an old
pager with <userinput>ln -s /tools/bin/cat /bin/more</userinput> to prevent one
test from failing, then issue: <userinput>make check</userinput>.</para>

<para>Install most of the package:</para>

<screen><userinput>make install</userinput></screen>

<para>Also install the shared libraries:</para>

<screen><userinput>make install-libs</userinput></screen>

</sect2>



<sect2 id="contents-e2fsprogs"><title>Contents of E2fsprogs</title>

<para><emphasis>Installed programs</emphasis>: badblocks, blkid, chattr,
compile_et, debugfs, dumpe2fs, e2fsck, e2image, e2label, findfs, fsck,
fsck.ext2, fsck.ext3, logsave, lsattr, mk_cmds, mke2fs, mkfs.ext2, mkfs.ext3,
mklost+found, resize2fs, tune2fs and uuidgen.</para>

<para><emphasis>Installed libraries</emphasis>: libblkid.[a,so],
libcom_err.[a,so], libe2p.[a,so], libext2fs.[a,so], libss.[a,so] and
libuuid.[a,so]</para>

</sect2>


<sect2><title>Short descriptions</title>

<indexterm zone="ch-system-e2fsprogs badblocks"><primary sortas="b-badblocks">badblocks</primary></indexterm>
<para id="badblocks"><command>badblocks</command> searches a device (usually a disk
partition) for bad blocks.</para>

<indexterm zone="ch-system-e2fsprogs blkid"><primary sortas="b-blkid">blkid</primary></indexterm>
<para id="blkid"><command>blkid</command> is a command line utility to locate and
print block device attributes.</para>

<indexterm zone="ch-system-e2fsprogs chattr"><primary sortas="b-chattr">chattr</primary></indexterm>
<para id="chattr"><command>chattr</command> changes the attributes of files on a
second extended (ext2) file system, and also ext3 file systems, the journaling version of ext2 file systems.</para>

<indexterm zone="ch-system-e2fsprogs compile_et"><primary sortas="b-compile_et">compile_et</primary></indexterm>
<para id="compile_et"><command>compile_et</command> is an error table compiler. It
converts a table of error-code names and messages into a C source file
suitable for use with the com_err library.</para>

<indexterm zone="ch-system-e2fsprogs debugfs"><primary sortas="b-debugfs">debugfs</primary></indexterm>
<para id="debugfs"><command>debugfs</command> is a file system debugger. It can be
used to examine and change the state of an ext2 file system.</para>

<indexterm zone="ch-system-e2fsprogs dumpe2fs"><primary sortas="b-dumpe2fs">dumpe2fs</primary></indexterm>
<para id="dumpe2fs"><command>dumpe2fs</command> prints the super block and blocks group
information for the file system present on a given device.</para>

<indexterm zone="ch-system-e2fsprogs e2fsck"><primary sortas="b-e2fsck">e2fsck</primary></indexterm>
<para id="e2fsck"><command>e2fsck</command> is used to check, and optionally repair,
second extended (ext2) file systems, and also ext3 file systems.</para>

<indexterm zone="ch-system-e2fsprogs e2image"><primary sortas="b-e2image">e2image</primary></indexterm>
<para id="e2image"><command>e2image</command> is used to save critical ext2 file system
data to a file.</para>

<indexterm zone="ch-system-e2fsprogs e2label"><primary sortas="b-e2label">e2label</primary></indexterm>
<para id="e2label"><command>e2label</command> will display or change the file system
label on the ext2 file system present on a given device.</para>

<indexterm zone="ch-system-e2fsprogs findfs"><primary sortas="b-findfs">findfs</primary></indexterm>
<para id="findfs"><command>findfs</command> finds a file system by label or UUID (Universally Unique Identifier).</para>

<indexterm zone="ch-system-e2fsprogs fsck"><primary sortas="b-fsck">fsck</primary></indexterm>
<para id="fsck"><command>fsck</command> is used to check, and optionally repair,
file systems. By default it checks the file systems listed in
<filename>/etc/fstab</filename></para>

<indexterm zone="ch-system-e2fsprogs logsave"><primary sortas="b-logsave">logsave</primary></indexterm>
<para id="logsave"><command>logsave</command> saves the output of a command in a log file.</para>

<indexterm zone="ch-system-e2fsprogs lsattr"><primary sortas="b-lsattr">lsattr</primary></indexterm>
<para id="lsattr"><command>lsattr</command> lists the attributes of files on a second
extended file system.</para>

<indexterm zone="ch-system-e2fsprogs mk_cmds"><primary sortas="b-mk_cmds">mk_cmds</primary></indexterm>
<para id="mk_cmds"><command>mk_cmds</command> converts a table of command names
and help messages into a C source file suitable for use with the
<filename>libss</filename> subsystem library.</para>

<indexterm zone="ch-system-e2fsprogs mke2fs"><primary sortas="b-mke2fs">mke2fs</primary></indexterm>
<para id="mke2fs"><command>mke2fs</command> is used to create a second extended
file system on the given device.</para>

<indexterm zone="ch-system-e2fsprogs mklost-found"><primary sortas="b-mklost+found">mklost+found</primary></indexterm>
<para id="mklost-found"><command>mklost+found</command> is used to create a
<filename>lost+found</filename> directory on a second extended file system.
It pre-allocates disk blocks to this directory to lighten the task of e2fsck.</para>

<indexterm zone="ch-system-e2fsprogs resize2fs"><primary sortas="b-resize2fs">resize2fs</primary></indexterm>
<para id="resize2fs"><command>resize2fs</command> can be used to enlarge or shrink an
ext2 file system.</para>

<indexterm zone="ch-system-e2fsprogs tune2fs"><primary sortas="b-tune2fs">tune2fs</primary></indexterm>
<para id="tune2fs"><command>tune2fs</command> is used adjust tunable file system
parameters on a second extended file system.</para>

<indexterm zone="ch-system-e2fsprogs uuidgen"><primary sortas="b-uuidgen">uuidgen</primary></indexterm>
<para id="uuidgen"><command>uuidgen</command> creates new
UUID. Each new UUID can reasonably be considered unique
among all UUIDs created, on the local system and on other systems, in the
past and in the future.</para>

<indexterm zone="ch-system-e2fsprogs libblkid"><primary sortas="c-libblkid">libblkid</primary></indexterm>
<para id="libblkid"><command>libblkid</command> contains routines for device
identification and token extraction.</para>

<indexterm zone="ch-system-e2fsprogs libcom_err"><primary sortas="c-libcom_err">libcom_err</primary></indexterm>
<para id="libcom_err"><command>libcom_err</command> is the common error display routine.</para>

<indexterm zone="ch-system-e2fsprogs libe2p"><primary sortas="c-libe2p">libe2p</primary></indexterm>
<para id="libe2p"><command>libe2p</command> is used by dumpe2fs, chattr, and lsattr.</para>

<indexterm zone="ch-system-e2fsprogs libext2fs"><primary sortas="c-libext2fs">libext2fs</primary></indexterm>
<para id="libext2fs"><command>libext2fs</command> contains routines to enable user-level
programs to manipulate an ext2 file system.</para>

<indexterm zone="ch-system-e2fsprogs libss"><primary sortas="c-libss">libss</primary></indexterm>
<para id="libss"><command>libss</command> is used by debugfs.</para>

<indexterm zone="ch-system-e2fsprogs libuuid"><primary sortas="c-libuuid">libuuid</primary></indexterm>
<para id="libuuid"><command>libuuid</command> contains routines for generating unique
identifiers for objects that may be accessible beyond the local system.</para>

</sect2>



</sect1>