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

clfs-1.2clfs-2.1clfs-3.0.0-systemdclfs-3.0.0-sysvinitsystemdsysvinit
Last change on this file since 8535616 was 8535616, checked in by Chris Staub <chris@…>, 15 years ago

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