source: BOOK/final-system/common/e2fsprogs.xml @ 98c59fa

clfs-1.2clfs-2.1clfs-3.0.0-systemdclfs-3.0.0-sysvinitsystemdsysvinit
Last change on this file since 98c59fa was 98c59fa, checked in by Joe Ciccone <jciccone@…>, 15 years ago

use the libblkid and libuuid provided by Util-Linux-NG instead of E2fsprogs now.
  • Property mode set to 100644
File size: 18.2 KB
Line 
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  <title>E2fsprogs-&e2fsprogs-version;</title>
12
13  <indexterm zone="ch-system-e2fsprogs">
14    <primary sortas="a-E2fsprogs">E2fsprogs</primary>
15  </indexterm>
16
17  <sect2 role="package">
18    <title/>
19
20    <para>The E2fsprogs package contains the utilities for handling the
21    <systemitem class="filesystem">ext2</systemitem> file system. It also
22    supports the <systemitem class="filesystem">ext3</systemitem> and
23    <systemitem class="filesystem">ext4</systemitem> journaling
24    file systems.</para>
25
26  </sect2>
27
28  <sect2 role="installation">
29    <title>Installation of E2fsprogs</title>
30
31    <para os="a">The E2fsprogs documentation recommends that the package be
32    built in a subdirectory of the source tree:</para>
33
34<screen os="b"><userinput>mkdir -v build
35cd build</userinput></screen>
36
37    <para os="c">Prepare E2fsprogs for compilation:</para>
38
39<screen os="d"><userinput>PKG_CONFIG=true ../configure --prefix=/usr --with-root-prefix="" \
40    --enable-elf-shlibs --with-cc=gcc \
41    --disable-libuuid --disable-libblkid</userinput></screen>
42
43    <variablelist os="e">
44      <title>The meaning of the configure options:</title>
45
46      <varlistentry os="e1">
47        <term><parameter>--with-root-prefix=""</parameter></term>
48        <listitem>
49          <para>Certain programs (such as the <command>e2fsck</command>
50          program) are considered essential programs. When, for example,
51          <filename class="directory">/usr</filename> is not mounted,
52          these programs still need to be available. They belong in
53          directories like <filename class="directory">/lib</filename> and
54          <filename class="directory">/sbin</filename>. If this option is
55          not passed to E2fsprogs' configure, the programs are installed into
56          the <filename class="directory">/usr</filename> directory.</para>
57        </listitem>
58      </varlistentry>
59
60      <varlistentry os="e2">
61        <term><parameter>--enable-elf-shlibs</parameter></term>
62        <listitem>
63          <para>This creates the shared libraries which some programs
64          in this package use.</para>
65        </listitem>
66      </varlistentry>
67
68    </variablelist>
69
70    <para os="f">Compile the package:</para>
71
72<screen os="g"><userinput>make LIBUUID="-luuid" STATIC_LIBUUID="-luuid" \
73    LIBBLKID="-lblkid" STATIC_LIBBLKID="-lblkid"</userinput></screen>
74
75    <para os="h">To test the results, issue:
76    <userinput>make check</userinput>.</para>
77
78    <para os="i">Install the binaries, documentation and shared libraries:</para>
79
80<screen os="j"><userinput>make install</userinput></screen>
81
82    <para os="k">Install the static libraries and headers:</para>
83
84<screen os="l"><userinput>make install-libs</userinput></screen>
85
86  </sect2>
87
88  <sect2 id="contents-e2fsprogs" role="content">
89    <title>Contents of E2fsprogs</title>
90
91    <segmentedlist>
92      <segtitle>Installed programs</segtitle>
93      <segtitle>Installed libraries</segtitle>
94
95      <seglistitem>
96        <seg>badblocks, blkid, chattr, compile_et, debugfs, dumpe2fs,
97        e2fsck, e2image, e2label, e2undo, filefrag, findfs, fsck, fsck.ext2,
98        fsck.ext3, fsck.ext4, fsck.ext4dev logsave, lsattr, mk_cmds, mke2fs,
99        mkfs.ext2, mkfs.ext3, mkfs.ext4, mkfs.ext4dev mklost+found, resize2fs,
100        tune2fs, uuidd, and uuidgen.</seg>
101        <seg>libcom_err.[a,so], libe2p.[a,so], libext2fs.[a,so], and
102        libss.[a,so]</seg>
103      </seglistitem>
104    </segmentedlist>
105
106    <variablelist>
107      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
108      <?dbfo list-presentation="list"?>
109      <?dbhtml list-presentation="table"?>
110
111      <varlistentry id="badblocks">
112        <term><command>badblocks</command></term>
113        <listitem>
114          <para>Searches a device (usually a disk partition) for bad
115          blocks</para>
116          <indexterm zone="ch-system-e2fsprogs badblocks">
117            <primary sortas="b-badblocks">badblocks</primary>
118          </indexterm>
119        </listitem>
120      </varlistentry>
121
122      <varlistentry id="blkid">
123        <term><command>blkid</command></term>
124        <listitem>
125          <para>A command line utility to locate and print block device
126          attributes</para>
127          <indexterm zone="ch-system-e2fsprogs blkid">
128            <primary sortas="b-blkid">blkid</primary>
129          </indexterm>
130        </listitem>
131      </varlistentry>
132
133      <varlistentry id="chattr">
134        <term><command>chattr</command></term>
135        <listitem>
136          <para>Changes the attributes of files on an <systemitem
137          class="filesystem">ext2</systemitem> file system; it also
138          changes <systemitem class="filesystem">ext3</systemitem>
139          file systems, the journaling version of <systemitem
140          class="filesystem">ext2</systemitem> file systems</para>
141          <indexterm zone="ch-system-e2fsprogs chattr">
142            <primary sortas="b-chattr">chattr</primary>
143          </indexterm>
144        </listitem>
145      </varlistentry>
146
147      <varlistentry id="compile_et">
148        <term><command>compile_et</command></term>
149        <listitem>
150          <para>An error table compiler; it converts a table of error-code
151          names and messages into a C source file suitable for use with the
152          <filename class="libraryfile">com_err</filename> library</para>
153          <indexterm zone="ch-system-e2fsprogs compile_et">
154            <primary sortas="b-compile_et">compile_et</primary>
155          </indexterm>
156        </listitem>
157      </varlistentry>
158
159      <varlistentry id="debugfs">
160        <term><command>debugfs</command></term>
161        <listitem>
162          <para>A file system debugger; it can be used to examine and change
163          the state of an <systemitem class="filesystem">ext2</systemitem>
164          file system</para>
165          <indexterm zone="ch-system-e2fsprogs debugfs">
166            <primary sortas="b-debugfs">debugfs</primary>
167          </indexterm>
168        </listitem>
169      </varlistentry>
170
171      <varlistentry id="dumpe2fs">
172        <term><command>dumpe2fs</command></term>
173        <listitem>
174          <para>Prints the super block and blocks group information for the
175          file system present on a given device</para>
176          <indexterm zone="ch-system-e2fsprogs dumpe2fs">
177            <primary sortas="b-dumpe2fs">dumpe2fs</primary>
178          </indexterm>
179        </listitem>
180      </varlistentry>
181
182      <varlistentry id="e2fsck">
183        <term><command>e2fsck</command></term>
184        <listitem>
185          <para>Is used to check, and optionally repair <systemitem
186          class="filesystem">ext2</systemitem> file systems and <systemitem
187          class="filesystem">ext3</systemitem> file systems</para>
188          <indexterm zone="ch-system-e2fsprogs e2fsck">
189            <primary sortas="b-e2fsck">e2fsck</primary>
190          </indexterm>
191        </listitem>
192      </varlistentry>
193
194      <varlistentry id="e2image">
195        <term><command>e2image</command></term>
196        <listitem>
197          <para>Is used to save critical <systemitem
198          class="filesystem">ext2</systemitem> file system data to a file</para>
199          <indexterm zone="ch-system-e2fsprogs e2image">
200            <primary sortas="b-e2image">e2image</primary>
201          </indexterm>
202        </listitem>
203      </varlistentry>
204
205      <varlistentry id="e2label">
206        <term><command>e2label</command></term>
207        <listitem>
208          <para>Displays or changes the file system label on the <systemitem
209          class="filesystem">ext2</systemitem> file system present on a given
210          device</para>
211          <indexterm zone="ch-system-e2fsprogs e2label">
212            <primary sortas="b-e2label">e2label</primary>
213          </indexterm>
214        </listitem>
215      </varlistentry>
216
217      <varlistentry id="e2undo">
218        <term><command>e2undo</command></term>
219        <listitem>
220          <para>Replays an undo log for an ext2/ext3/ext4 filesystem</para>
221          <indexterm zone="ch-system-e2fsprogs e2undo">
222            <primary sortas="b-e2undo">e2undo</primary>
223          </indexterm>
224        </listitem>
225      </varlistentry>
226
227      <varlistentry id="filefrag">
228        <term><command>filefrag</command></term>
229        <listitem>
230          <para>Reports on how badly fragmented a particular file might be</para>
231          <indexterm zone="ch-system-e2fsprogs filefrag">
232            <primary sortas="b-filefrag">filefrag</primary>
233          </indexterm>
234        </listitem>
235      </varlistentry>
236
237      <varlistentry id="findfs">
238        <term><command>findfs</command></term>
239        <listitem>
240          <para>Finds a file system by label or Universally Unique Identifier
241          (UUID)</para>
242          <indexterm zone="ch-system-e2fsprogs findfs">
243            <primary sortas="b-findfs">findfs</primary>
244          </indexterm>
245        </listitem>
246      </varlistentry>
247
248      <varlistentry id="fsck">
249        <term><command>fsck</command></term>
250        <listitem>
251          <para>Is used to check, and optionally repair, file systems</para>
252          <indexterm zone="ch-system-e2fsprogs fsck">
253            <primary sortas="b-fsck">fsck</primary>
254          </indexterm>
255        </listitem>
256      </varlistentry>
257
258      <varlistentry id="fsck.ext2">
259        <term><command>fsck.ext2</command></term>
260        <listitem>
261          <para>By default checks <systemitem class="filesystem">ext2</systemitem>
262          file systems</para>
263          <indexterm zone="ch-system-e2fsprogs fsck.ext2">
264            <primary sortas="b-fsck.ext2">fsck.ext2</primary>
265          </indexterm>
266        </listitem>
267      </varlistentry>
268
269      <varlistentry id="fsck.ext3">
270        <term><command>fsck.ext3</command></term>
271        <listitem>
272          <para>By default checks <systemitem class="filesystem">ext3</systemitem>
273          file systems</para>
274          <indexterm zone="ch-system-e2fsprogs fsck.ext3">
275            <primary sortas="b-fsck.ext3">fsck.ext3</primary>
276          </indexterm>
277        </listitem>
278      </varlistentry>
279
280      <varlistentry id="fsck.ext4">
281        <term><command>fsck.ext4</command></term>
282        <listitem>
283          <para>By default checks <systemitem class="filesystem">ext4</systemitem>
284          file systems</para>
285          <indexterm zone="ch-system-e2fsprogs fsck.ext4">
286            <primary sortas="b-fsck.ext4">fsck.ext4</primary>
287          </indexterm>
288        </listitem>
289      </varlistentry>
290
291      <varlistentry id="fsck.ext4dev">
292        <term><command>fsck.ext4dev</command></term>
293        <listitem>
294          <para>By default checks <systemitem class="filesystem">ext4dev</systemitem>
295          file systems</para>
296          <indexterm zone="ch-system-e2fsprogs fsck.ext4dev">
297            <primary sortas="b-fsck.ext4dev">fsck.ext4dev</primary>
298          </indexterm>
299        </listitem>
300      </varlistentry>
301
302      <varlistentry id="logsave">
303        <term><command>logsave</command></term>
304        <listitem>
305          <para>Saves the output of a command in a log file</para>
306          <indexterm zone="ch-system-e2fsprogs logsave">
307            <primary sortas="b-logsave">logsave</primary>
308          </indexterm>
309        </listitem>
310      </varlistentry>
311
312      <varlistentry id="lsattr">
313        <term><command>lsattr</command></term>
314        <listitem>
315          <para>Lists the attributes of files on a second extended file
316          system</para>
317          <indexterm zone="ch-system-e2fsprogs lsattr">
318            <primary sortas="b-lsattr">lsattr</primary>
319          </indexterm>
320        </listitem>
321      </varlistentry>
322
323      <varlistentry id="mk_cmds">
324        <term><command>mk_cmds</command></term>
325        <listitem>
326          <para>Converts a table of command names and help messages into a C
327          source file suitable for use with the <filename
328          class="libraryfile">libss</filename> subsystem library</para>
329          <indexterm zone="ch-system-e2fsprogs mk_cmds">
330            <primary sortas="b-mk_cmds">mk_cmds</primary>
331          </indexterm>
332        </listitem>
333      </varlistentry>
334
335      <varlistentry id="mke2fs">
336        <term><command>mke2fs</command></term>
337        <listitem>
338          <para>Creates an <systemitem class="filesystem">ext2</systemitem>
339          or <systemitem class="filesystem">ext3</systemitem> file system on
340          the given device</para>
341          <indexterm zone="ch-system-e2fsprogs mke2fs">
342            <primary sortas="b-mke2fs">mke2fs</primary>
343          </indexterm>
344        </listitem>
345      </varlistentry>
346
347      <varlistentry id="mkfs.ext2">
348        <term><command>mkfs.ext2</command></term>
349        <listitem>
350          <para>By default creates <systemitem class="filesystem">ext2</systemitem>
351          file systems</para>
352          <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
353            <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
354          </indexterm>
355        </listitem>
356      </varlistentry>
357
358      <varlistentry id="mkfs.ext3">
359        <term><command>mkfs.ext3</command></term>
360        <listitem>
361          <para>By default creates <systemitem class="filesystem">ext3</systemitem>
362          file systems</para>
363          <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
364            <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
365          </indexterm>
366        </listitem>
367      </varlistentry>
368
369      <varlistentry id="mkfs.ext4">
370        <term><command>mkfs.ext4</command></term>
371        <listitem>
372          <para>By default creates <systemitem class="filesystem">ext4</systemitem>
373          file systems</para>
374          <indexterm zone="ch-system-e2fsprogs mkfs.ext4">
375            <primary sortas="b-mkfs.ext4">mkfs.ext4</primary>
376          </indexterm>
377        </listitem>
378      </varlistentry>
379
380      <varlistentry id="mkfs.ext4dev">
381        <term><command>mkfs.ext4dev</command></term>
382        <listitem>
383          <para>By default creates <systemitem class="filesystem">ext4dev</systemitem>
384          file systems</para>
385          <indexterm zone="ch-system-e2fsprogs mkfs.ext4dev">
386            <primary sortas="b-mkfs.ext4dev">mkfs.ext4dev</primary>
387          </indexterm>
388        </listitem>
389      </varlistentry>
390
391      <varlistentry id="mklost-found">
392        <term><command>mklost+found</command></term>
393        <listitem>
394          <para>Used to create a <filename class="directory">lost+found</filename>
395          directory on an <systemitem class="filesystem">ext2</systemitem> file
396          system; it pre-allocates disk blocks to this directory to lighten the
397          task of <command>e2fsck</command></para>
398          <indexterm zone="ch-system-e2fsprogs mklost-found">
399            <primary sortas="b-mklost+found">mklost+found</primary>
400          </indexterm>
401        </listitem>
402      </varlistentry>
403
404      <varlistentry id="resize2fs">
405        <term><command>resize2fs</command></term>
406        <listitem>
407          <para>Can be used to enlarge or shrink an <systemitem
408          class="filesystem">ext2</systemitem> file system</para>
409          <indexterm zone="ch-system-e2fsprogs resize2fs">
410            <primary sortas="b-resize2fs">resize2fs</primary>
411          </indexterm>
412        </listitem>
413      </varlistentry>
414
415      <varlistentry id="tune2fs">
416        <term><command>tune2fs</command></term>
417        <listitem>
418          <para>Adjusts tunable file system parameters on an <systemitem
419          class="filesystem">ext2</systemitem> file system</para>
420          <indexterm zone="ch-system-e2fsprogs tune2fs">
421            <primary sortas="b-tune2fs">tune2fs</primary>
422          </indexterm>
423        </listitem>
424      </varlistentry>
425
426      <varlistentry id="uuidd">
427        <term><command>uuidd</command></term>
428        <listitem>
429          <para>The uuidd daemon is used by the UUID library to generate
430          universally unique identifiers (UUIDs), especially time-based UUID's
431          in a secure and guaranteed-unique fashion, even in the face of large
432          numbers of threads trying to grab UUID's running on different CPU's.
433          </para>
434          <indexterm zone="ch-system-e2fsprogs uuidd">
435            <primary sortas="b-uuidd">uuidd</primary>
436          </indexterm>
437        </listitem>
438      </varlistentry>
439
440      <varlistentry id="uuidgen">
441        <term><command>uuidgen</command></term>
442        <listitem>
443          <para>Creates new UUIDs. Each new UUID can reasonably be considered
444          unique among all UUIDs created, on the local system and on other
445          systems, in the past and in the future</para>
446          <indexterm zone="ch-system-e2fsprogs uuidgen">
447            <primary sortas="b-uuidgen">uuidgen</primary>
448          </indexterm>
449        </listitem>
450      </varlistentry>
451
452      <varlistentry id="libcom_err">
453        <term><filename class="libraryfile">libcom_err</filename></term>
454        <listitem>
455          <para>The common error display routine</para>
456          <indexterm zone="ch-system-e2fsprogs libcom_err">
457            <primary sortas="c-libcom_err">libcom_err</primary>
458          </indexterm>
459        </listitem>
460      </varlistentry>
461
462      <varlistentry id="libe2p">
463        <term><filename class="libraryfile">libe2p</filename></term>
464        <listitem>
465          <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
466          and <command>lsattr</command></para>
467          <indexterm zone="ch-system-e2fsprogs libe2p">
468            <primary sortas="c-libe2p">libe2p</primary>
469          </indexterm>
470        </listitem>
471      </varlistentry>
472
473      <varlistentry id="libext2fs">
474        <term><filename class="libraryfile">libext2fs</filename></term>
475        <listitem>
476          <para>Contains routines to enable user-level programs to manipulate an
477          <systemitem class="filesystem">ext2</systemitem> file system</para>
478          <indexterm zone="ch-system-e2fsprogs libext2fs">
479            <primary sortas="c-libext2fs">libext2fs</primary>
480          </indexterm>
481        </listitem>
482      </varlistentry>
483
484      <varlistentry id="libss">
485        <term><filename class="libraryfile">libss</filename></term>
486        <listitem>
487          <para>Used by <command>debugfs</command></para>
488          <indexterm zone="ch-system-e2fsprogs libss">
489            <primary sortas="c-libss">libss</primary>
490          </indexterm>
491        </listitem>
492      </varlistentry>
493
494    </variablelist>
495
496  </sect2>
497
498</sect1>
Note: See TracBrowser for help on using the repository browser.