chapter06/e2fsprogs.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
   4   <!ENTITY % general-entities SYSTEM "../general.ent">
   5   %general-entities;
   6 ]>
   7
   8 <sect1 id="ch-system-e2fsprogs" role="wrap">
   9   <?dbhtml filename="e2fsprogs.html"?>
  10
  11   <sect1info condition="script">
  12     <productname>e2fsprogs</productname>
  13     <productnumber>&e2fsprogs-version;</productnumber>
  14     <address>&e2fsprogs-url;</address>
  15   </sect1info>
  16
  17   <title>E2fsprogs-&e2fsprogs-version;</title>
  18
  19   <indexterm zone="ch-system-e2fsprogs">
  20     <primary sortas="a-E2fsprogs">E2fsprogs</primary>
  21   </indexterm>
  22
  23   <sect2 role="package">
  24     <title/>
  25
  26     <para>The E2fsprogs package contains the utilities for handling the
  27     <systemitem class="filesystem">ext2</systemitem> file system. It also
  28     supports the <systemitem class="filesystem">ext3</systemitem> and
  29     <systemitem class="filesystem">ext4</systemitem> journaling
  30     file systems.</para>
  31
  32     <segmentedlist>
  33       <segtitle>&buildtime;</segtitle>
  34       <segtitle>&diskspace;</segtitle>
  35
  36       <seglistitem>
  37         <seg>&e2fsprogs-ch6-sbu;</seg>
  38         <seg>&e2fsprogs-ch6-du;</seg>
  39       </seglistitem>
  40     </segmentedlist>
  41
  42   </sect2>
  43
  44   <sect2 role="installation">
  45     <title>Installation of E2fsprogs</title>
  46
  47     <para>The E2fsprogs documentation recommends that the package be built in
  48     a subdirectory of the source tree: </para>
  49
  50 <screen><userinput remap="pre">mkdir -v build
  51 cd build</userinput></screen>
  52
  53     <para>Prepare E2fsprogs for compilation:</para>
  54
  55 <screen><userinput remap="configure">LIBS=-L/tools/lib                    \
  56 CFLAGS=-I/tools/include              \
  57 PKG_CONFIG_PATH=/tools/lib/pkgconfig \
  58 ../configure --prefix=/usr           \
  59              --bindir=/bin           \
  60              --with-root-prefix=""   \
  61              --enable-elf-shlibs     \
  62              --disable-libblkid      \
  63              --disable-libuuid       \
  64              --disable-uuidd         \
  65              --disable-fsck</userinput></screen>
  66
  67     <variablelist>
  68       <title>The meaning of the environment variable and configure options:</title>
  69
  70       <varlistentry>
  71         <term><parameter>PKG_CONFIG_PATH, LIBS, CFLAGS</parameter></term>
  72         <listitem>
  73           <para>These variables enable e2fsprogs to be built using the
  74           <xref linkend="ch-tools-util-linux"/> package built earlier.</para>
  75         </listitem>
  76       </varlistentry>
  77
  78       <varlistentry>
  79         <term><parameter>--with-root-prefix=""</parameter> and
  80               <parameter>--bindir=/bin</parameter></term>
  81         <listitem>
  82           <para>Certain programs (such as the <command>e2fsck</command>
  83           program) are considered essential programs.  When, for example,
  84           <filename class="directory">/usr</filename> is not mounted, these
  85           programs still need to be available. They belong in directories
  86           like <filename class="directory">/lib</filename> and <filename
  87           class="directory">/sbin</filename>. If this option is not passed
  88           to E2fsprogs' configure, the programs are installed into the
  89           <filename class="directory">/usr</filename> directory.</para>
  90         </listitem>
  91       </varlistentry>
  92
  93       <varlistentry>
  94         <term><parameter>--enable-elf-shlibs</parameter></term>
  95         <listitem>
  96           <para>This creates the shared libraries which some programs
  97           in this package use.</para>
  98         </listitem>
  99       </varlistentry>
 100
 101       <varlistentry>
 102         <term><parameter>--disable-*</parameter></term>
 103         <listitem>
 104           <para>This prevents E2fsprogs from building and installing the
 105           <systemitem class="library">libuuid</systemitem> and
 106           <systemitem class="library">libblkid</systemitem> libraries, the
 107           <systemitem class="daemon">uuidd</systemitem> daemon, and the
 108           <command>fsck</command> wrapper, as Util-Linux installs more
 109           recent versions.</para>
 110         </listitem>
 111       </varlistentry>
 112
 113     </variablelist>
 114
 115     <para>Compile the package:</para>
 116
 117 <screen><userinput remap="make">make</userinput></screen>
 118
 119     <para>To set up and run the test suite we need to first link some
 120     libraries from /tools/lib to a location where the test programs look.
 121     To run the tests, issue:</para>
 122
 123 <screen><userinput remap="test">ln -sfv /tools/lib/lib{blk,uu}id.so.1 lib
 124 make LD_LIBRARY_PATH=/tools/lib check</userinput></screen>
 125
 126     <para>One of the E2fsprogs tests will attempt to allocate 256 MB of memory.
 127     If you do not have significantly more RAM than this, be sure to enable
 128     sufficient swap space for the test. See <xref
 129     linkend="space-creatingfilesystem"/> and <xref linkend="space-mounting"/>
 130     for details on creating and enabling swap space.</para>
 131
 132     <para>Install the binaries, documentation, and shared libraries:</para>
 133
 134 <screen><userinput remap="install">make install</userinput></screen>
 135
 136     <para>Install the static libraries and headers:</para>
 137
 138 <screen><userinput remap="install">make install-libs</userinput></screen>
 139
 140     <para>Make the installed static libraries writable so debugging symbols can
 141     be removed later:</para>
 142
 143 <screen><userinput remap="install">chmod -v u+w /usr/lib/{libcom_err,libe2p,libext2fs,libss}.a</userinput></screen>
 144
 145     <para>This package installs a gzipped
 146     <filename class="extension">.info</filename> file but doesn't update the
 147     system-wide <filename>dir</filename> file. Unzip this file and then update
 148     the system <filename>dir</filename> file using the following
 149     commands.</para>
 150
 151 <screen><userinput remap="install">gunzip -v /usr/share/info/libext2fs.info.gz
 152 install-info --dir-file=/usr/share/info/dir /usr/share/info/libext2fs.info</userinput></screen>
 153
 154     <para>If desired, create and install some additional documentation by
 155     issuing the following commands:</para>
 156
 157 <screen><userinput remap="install">makeinfo -o      doc/com_err.info ../lib/et/com_err.texinfo
 158 install -v -m644 doc/com_err.info /usr/share/info
 159 install-info --dir-file=/usr/share/info/dir /usr/share/info/com_err.info</userinput></screen>
 160   </sect2>
 161
 162   <sect2 id="contents-e2fsprogs" role="content">
 163     <title>Contents of E2fsprogs</title>
 164
 165     <segmentedlist>
 166       <segtitle>Installed programs</segtitle>
 167       <segtitle>Installed libraries</segtitle>
 168       <segtitle>Installed directories</segtitle>
 169
 170       <seglistitem>
 171         <seg>badblocks, chattr, compile_et, debugfs, dumpe2fs,e2freefrag,
 172         e2fsck, e2image, e2label, e2undo, e4defrag, filefrag, fsck.ext2,
 173         fsck.ext3, fsck.ext4, fsck.ext4dev, logsave, lsattr, mk_cmds, mke2fs,
 174         mkfs.ext2, mkfs.ext3, mkfs.ext4, mkfs.ext4dev, mklost+found,
 175         resize2fs, and tune2fs</seg>
 176         <seg>libcom_err.so, libe2p.so, libext2fs.so, and libss.so</seg>
 177         <seg>/usr/include/e2p, /usr/include/et, /usr/include/ext2fs,
 178         /usr/include/ss, /usr/share/et, and /usr/share/ss</seg>
 179       </seglistitem>
 180     </segmentedlist>
 181
 182     <variablelist>
 183       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
 184       <?dbfo list-presentation="list"?>
 185       <?dbhtml list-presentation="table"?>
 186
 187       <varlistentry id="badblocks">
 188         <term><command>badblocks</command></term>
 189         <listitem>
 190           <para>Searches a device (usually a disk partition) for bad
 191           blocks</para>
 192           <indexterm zone="ch-system-e2fsprogs badblocks">
 193             <primary sortas="b-badblocks">badblocks</primary>
 194           </indexterm>
 195         </listitem>
 196       </varlistentry>
 197
 198       <varlistentry id="chattr">
 199         <term><command>chattr</command></term>
 200         <listitem>
 201           <para>Changes the attributes of files on an <systemitem
 202           class="filesystem">ext2</systemitem> file system; it also
 203           changes <systemitem class="filesystem">ext3</systemitem>
 204           file systems, the journaling version of <systemitem
 205           class="filesystem">ext2</systemitem> file systems</para>
 206           <indexterm zone="ch-system-e2fsprogs chattr">
 207             <primary sortas="b-chattr">chattr</primary>
 208           </indexterm>
 209         </listitem>
 210       </varlistentry>
 211
 212       <varlistentry id="compile_et">
 213         <term><command>compile_et</command></term>
 214         <listitem>
 215           <para>An error table compiler; it converts a table of error-code
 216           names and messages into a C source file suitable for use with the
 217           <filename class="libraryfile">com_err</filename> library</para>
 218           <indexterm zone="ch-system-e2fsprogs compile_et">
 219             <primary sortas="b-compile_et">compile_et</primary>
 220           </indexterm>
 221         </listitem>
 222       </varlistentry>
 223
 224       <varlistentry id="debugfs">
 225         <term><command>debugfs</command></term>
 226         <listitem>
 227           <para>A file system debugger; it can be used to examine and change
 228           the state of an <systemitem class="filesystem">ext2</systemitem>
 229           file system</para>
 230           <indexterm zone="ch-system-e2fsprogs debugfs">
 231             <primary sortas="b-debugfs">debugfs</primary>
 232           </indexterm>
 233         </listitem>
 234       </varlistentry>
 235
 236       <varlistentry id="dumpe2fs">
 237         <term><command>dumpe2fs</command></term>
 238         <listitem>
 239           <para>Prints the super block and blocks group information for the
 240           file system present on a given device</para>
 241           <indexterm zone="ch-system-e2fsprogs dumpe2fs">
 242             <primary sortas="b-dumpe2fs">dumpe2fs</primary>
 243           </indexterm>
 244         </listitem>
 245       </varlistentry>
 246
 247       <varlistentry id="e2freefrag">
 248         <term><command>e2freefrag</command></term>
 249         <listitem>
 250           <para>Reports free space fragmentation information</para>
 251           <indexterm zone="ch-system-e2fsprogs e2freefrag">
 252             <primary sortas="b-e2freefrag">e2freefrag</primary>
 253           </indexterm>
 254         </listitem>
 255       </varlistentry>
 256
 257       <varlistentry id="e2fsck">
 258         <term><command>e2fsck</command></term>
 259         <listitem>
 260           <para>Is used to check, and optionally repair <systemitem
 261           class="filesystem">ext2</systemitem> file systems and <systemitem
 262           class="filesystem">ext3</systemitem> file systems</para>
 263           <indexterm zone="ch-system-e2fsprogs e2fsck">
 264             <primary sortas="b-e2fsck">e2fsck</primary>
 265           </indexterm>
 266         </listitem>
 267       </varlistentry>
 268
 269       <varlistentry id="e2image">
 270         <term><command>e2image</command></term>
 271         <listitem>
 272           <para>Is used to save critical <systemitem
 273           class="filesystem">ext2</systemitem> file system data to a file</para>
 274           <indexterm zone="ch-system-e2fsprogs e2image">
 275             <primary sortas="b-e2image">e2image</primary>
 276           </indexterm>
 277         </listitem>
 278       </varlistentry>
 279
 280       <varlistentry id="e2label">
 281         <term><command>e2label</command></term>
 282         <listitem>
 283           <para>Displays or changes the file system label on the <systemitem
 284           class="filesystem">ext2</systemitem> file system present on a given
 285           device</para>
 286           <indexterm zone="ch-system-e2fsprogs e2label">
 287             <primary sortas="b-e2label">e2label</primary>
 288           </indexterm>
 289         </listitem>
 290       </varlistentry>
 291
 292       <varlistentry id="e2undo">
 293         <term><command>e2undo</command></term>
 294         <listitem>
 295           <para>Replays the undo log undo_log for an ext2/ext3/ext4 filesystem
 296           found on a device [This can be used to undo a failed operation by an
 297           e2fsprogs program.]</para>
 298           <indexterm zone="ch-system-e2fsprogs e2undo">
 299             <primary sortas="b-e2undo">e2undo</primary>
 300           </indexterm>
 301         </listitem>
 302       </varlistentry>
 303
 304       <varlistentry id="e4defrag">
 305         <term><command>e4defrag</command></term>
 306         <listitem>
 307           <para>Online defragmenter for ext4 filesystems</para>
 308           <indexterm zone="ch-system-e2fsprogs e4defrag">
 309             <primary sortas="b-e4defrag">e4defrag</primary>
 310           </indexterm>
 311         </listitem>
 312       </varlistentry>
 313
 314       <varlistentry id="filefrag">
 315         <term><command>filefrag</command></term>
 316         <listitem>
 317           <para>Reports on how badly fragmented a particular file might be</para>
 318           <indexterm zone="ch-system-e2fsprogs filefrag">
 319             <primary sortas="b-filefrag">filefrag</primary>
 320           </indexterm>
 321         </listitem>
 322       </varlistentry>
 323
 324       <varlistentry id="fsck.ext2">
 325         <term><command>fsck.ext2</command></term>
 326         <listitem>
 327           <para>By default checks <systemitem class="filesystem">ext2</systemitem>
 328           file systems and is a hard link to <command>e2fsck</command></para>
 329           <indexterm zone="ch-system-e2fsprogs fsck.ext2">
 330             <primary sortas="b-fsck.ext2">fsck.ext2</primary>
 331           </indexterm>
 332         </listitem>
 333       </varlistentry>
 334
 335       <varlistentry id="fsck.ext3">
 336         <term><command>fsck.ext3</command></term>
 337         <listitem>
 338           <para>By default checks <systemitem class="filesystem">ext3</systemitem>
 339           file systems and is a hard link to <command>e2fsck</command></para>
 340           <indexterm zone="ch-system-e2fsprogs fsck.ext3">
 341             <primary sortas="b-fsck.ext3">fsck.ext3</primary>
 342           </indexterm>
 343         </listitem>
 344       </varlistentry>
 345
 346       <varlistentry id="fsck.ext4">
 347         <term><command>fsck.ext4</command></term>
 348         <listitem>
 349           <para>By default checks <systemitem class="filesystem">ext4</systemitem>
 350           file systems and is a hard link to <command>e2fsck</command></para>
 351           <indexterm zone="ch-system-e2fsprogs fsck.ext4">
 352             <primary sortas="b-fsck.ext4">fsck.ext4</primary>
 353           </indexterm>
 354         </listitem>
 355       </varlistentry>
 356
 357       <varlistentry id="fsck.ext4dev">
 358         <term><command>fsck.ext4dev</command></term>
 359         <listitem>
 360           <para>By default checks <systemitem class="filesystem">ext4</systemitem>
 361           development file systems and  is a hard link to
 362           <command>e2fsck</command></para>
 363           <indexterm zone="ch-system-e2fsprogs fsck.ext4dev">
 364             <primary sortas="b-fsck.ext4dev">fsck.ext4dev</primary>
 365           </indexterm>
 366         </listitem>
 367       </varlistentry>
 368
 369       <varlistentry id="logsave">
 370         <term><command>logsave</command></term>
 371         <listitem>
 372           <para>Saves the output of a command in a log file</para>
 373           <indexterm zone="ch-system-e2fsprogs logsave">
 374             <primary sortas="b-logsave">logsave</primary>
 375           </indexterm>
 376         </listitem>
 377       </varlistentry>
 378
 379       <varlistentry id="lsattr">
 380         <term><command>lsattr</command></term>
 381         <listitem>
 382           <para>Lists the attributes of files on a second extended file
 383           system</para>
 384           <indexterm zone="ch-system-e2fsprogs lsattr">
 385             <primary sortas="b-lsattr">lsattr</primary>
 386           </indexterm>
 387         </listitem>
 388       </varlistentry>
 389
 390       <varlistentry id="mk_cmds">
 391         <term><command>mk_cmds</command></term>
 392         <listitem>
 393           <para>Converts a table of command names and help messages into a C
 394           source file suitable for use with the <filename
 395           class="libraryfile">libss</filename> subsystem library</para>
 396           <indexterm zone="ch-system-e2fsprogs mk_cmds">
 397             <primary sortas="b-mk_cmds">mk_cmds</primary>
 398           </indexterm>
 399         </listitem>
 400       </varlistentry>
 401
 402       <varlistentry id="mke2fs">
 403         <term><command>mke2fs</command></term>
 404         <listitem>
 405           <para>Creates an <systemitem class="filesystem">ext2</systemitem>
 406           or <systemitem class="filesystem">ext3</systemitem> file system on
 407           the given device</para>
 408           <indexterm zone="ch-system-e2fsprogs mke2fs">
 409             <primary sortas="b-mke2fs">mke2fs</primary>
 410           </indexterm>
 411         </listitem>
 412       </varlistentry>
 413
 414       <varlistentry id="mkfs.ext2">
 415         <term><command>mkfs.ext2</command></term>
 416         <listitem>
 417           <para>By default creates <systemitem class="filesystem">ext2</systemitem>
 418           file systems and is a hard link to <command>mke2fs</command></para>
 419           <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
 420             <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
 421           </indexterm>
 422         </listitem>
 423       </varlistentry>
 424
 425       <varlistentry id="mkfs.ext3">
 426         <term><command>mkfs.ext3</command></term>
 427         <listitem>
 428           <para>By default creates <systemitem class="filesystem">ext3</systemitem>
 429           file systems and is a hard link to <command>mke2fs</command></para>
 430           <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
 431             <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
 432           </indexterm>
 433         </listitem>
 434       </varlistentry>
 435
 436       <varlistentry id="mkfs.ext4">
 437         <term><command>mkfs.ext4</command></term>
 438         <listitem>
 439           <para>By default creates <systemitem class="filesystem">ext4</systemitem>
 440           file systems and is a hard link to <command>mke2fs</command></para>
 441           <indexterm zone="ch-system-e2fsprogs mkfs.ext4">
 442             <primary sortas="b-mkfs.ext4">mkfs.ext4</primary>
 443           </indexterm>
 444         </listitem>
 445       </varlistentry>
 446
 447       <varlistentry id="mkfs.ext4dev">
 448         <term><command>mkfs.ext4dev</command></term>
 449         <listitem>
 450           <para>By default creates <systemitem class="filesystem">ext4</systemitem>
 451           development file systems and is a hard link to <command>mke2fs</command></para>
 452           <indexterm zone="ch-system-e2fsprogs mkfs.ext4dev">
 453             <primary sortas="b-mkfs.ext4dev">mkfs.ext4dev</primary>
 454           </indexterm>
 455         </listitem>
 456       </varlistentry>
 457
 458       <varlistentry id="mklost-found">
 459         <term><command>mklost+found</command></term>
 460         <listitem>
 461           <para>Used to create a <filename class="directory">lost+found</filename>
 462           directory on an <systemitem class="filesystem">ext2</systemitem> file
 463           system; it pre-allocates disk blocks to this directory to lighten the
 464           task of <command>e2fsck</command></para>
 465           <indexterm zone="ch-system-e2fsprogs mklost-found">
 466             <primary sortas="b-mklost+found">mklost+found</primary>
 467           </indexterm>
 468         </listitem>
 469       </varlistentry>
 470
 471       <varlistentry id="resize2fs">
 472         <term><command>resize2fs</command></term>
 473         <listitem>
 474           <para>Can be used to enlarge or shrink an <systemitem
 475           class="filesystem">ext2</systemitem> file system</para>
 476           <indexterm zone="ch-system-e2fsprogs resize2fs">
 477             <primary sortas="b-resize2fs">resize2fs</primary>
 478           </indexterm>
 479         </listitem>
 480       </varlistentry>
 481
 482       <varlistentry id="tune2fs">
 483         <term><command>tune2fs</command></term>
 484         <listitem>
 485           <para>Adjusts tunable file system parameters on an <systemitem
 486           class="filesystem">ext2</systemitem> file system</para>
 487           <indexterm zone="ch-system-e2fsprogs tune2fs">
 488             <primary sortas="b-tune2fs">tune2fs</primary>
 489           </indexterm>
 490         </listitem>
 491       </varlistentry>
 492
 493       <varlistentry id="libcom_err">
 494         <term><filename class="libraryfile">libcom_err</filename></term>
 495         <listitem>
 496           <para>The common error display routine</para>
 497           <indexterm zone="ch-system-e2fsprogs libcom_err">
 498             <primary sortas="c-libcom_err">libcom_err</primary>
 499           </indexterm>
 500         </listitem>
 501       </varlistentry>
 502
 503       <varlistentry id="libe2p">
 504         <term><filename class="libraryfile">libe2p</filename></term>
 505         <listitem>
 506           <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
 507           and <command>lsattr</command></para>
 508           <indexterm zone="ch-system-e2fsprogs libe2p">
 509             <primary sortas="c-libe2p">libe2p</primary>
 510           </indexterm>
 511         </listitem>
 512       </varlistentry>
 513
 514       <varlistentry id="libext2fs">
 515         <term><filename class="libraryfile">libext2fs</filename></term>
 516         <listitem>
 517           <para>Contains routines to enable user-level programs to manipulate an
 518           <systemitem class="filesystem">ext2</systemitem> file system</para>
 519           <indexterm zone="ch-system-e2fsprogs libext2fs">
 520             <primary sortas="c-libext2fs">libext2fs</primary>
 521           </indexterm>
 522         </listitem>
 523       </varlistentry>
 524
 525 <!--      <varlistentry id="libquota">
 526         <term><filename class="libraryfile">libquota</filename></term>
 527         <listitem>
 528           <para>Provides an interface for creating and updating quota files
 529           and ext4 superblock fields</para>
 530           <indexterm zone="ch-system-e2fsprogs libquota">
 531             <primary sortas="c-libquota">libquota</primary>
 532           </indexterm>
 533         </listitem>
 534       </varlistentry>
 535 -->
 536       <varlistentry id="libss">
 537         <term><filename class="libraryfile">libss</filename></term>
 538         <listitem>
 539           <para>Used by <command>debugfs</command></para>
 540           <indexterm zone="ch-system-e2fsprogs libss">
 541             <primary sortas="c-libss">libss</primary>
 542           </indexterm>
 543         </listitem>
 544       </varlistentry>
 545
 546     </variablelist>
 547
 548   </sect2>
 549
 550 </sect1>