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

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

Updates to installed programs lists
  • Property mode set to 100644
File size: 17.6 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 --disable-libblkid \
41    --disable-libuuid --disable-fsck \
42    --disable-uuidd</userinput></screen>
43
44    <variablelist os="e">
45      <title>The meaning of the configure options:</title>
46
47      <varlistentry os="e1">
48        <term><parameter>--with-root-prefix=""</parameter></term>
49        <listitem>
50          <para>Certain programs (such as the <command>e2fsck</command>
51          program) are considered essential programs. When, for example,
52          <filename class="directory">/usr</filename> is not mounted,
53          these programs still need to be available. They belong in
54          directories like <filename class="directory">/lib</filename> and
55          <filename class="directory">/sbin</filename>. If this option is
56          not passed to E2fsprogs' configure, the programs are installed into
57          the <filename class="directory">/usr</filename> directory.</para>
58        </listitem>
59      </varlistentry>
60
61      <varlistentry os="e2">
62        <term><parameter>--enable-elf-shlibs</parameter></term>
63        <listitem>
64          <para>This creates the shared libraries which some programs
65          in this package use.</para>
66        </listitem>
67      </varlistentry>
68
69    </variablelist>
70
71    <para os="f">Compile the package:</para>
72
73<screen os="g"><userinput>make</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      <segtitle>Installed directories</segtitle>
95
96      <seglistitem>
97        <seg>badblocks, chattr, compile_et, debugfs, dumpe2fs, e2freefrag,
98        e2fsck, e2image, e2initrd_helper, e2label, e2undo, e4defrag, filefrag,
99        fsck.ext2, fsck.ext3, fsck.ext4, fsck.ext4dev, logsave, lsattr,
100        mk_cmds, mke2fs, mkfs.ext2, mkfs.ext3, mkfs.ext4, mkfs.ext4dev,
101        mklost+found, resize2fs, and tune2fs</seg>
102        <seg>libcom_err.[a,so], libe2p.[a,so], libext2fs.[a,so],
103        libss.[a,so], and libquota.a</seg>
104        <seg>/usr/include/e2p, /usr/include/et, /usr/include/ext2fs,
105        /usr/include/quota, /usr/include/ss, /usr/share/et, /usr/share/ss</seg>
106      </seglistitem>
107    </segmentedlist>
108
109    <variablelist>
110      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
111      <?dbfo list-presentation="list"?>
112      <?dbhtml list-presentation="table"?>
113
114      <varlistentry id="badblocks">
115        <term><command>badblocks</command></term>
116        <listitem>
117          <para>Searches a device (usually a disk partition) for bad
118          blocks</para>
119          <indexterm zone="ch-system-e2fsprogs badblocks">
120            <primary sortas="b-badblocks">badblocks</primary>
121          </indexterm>
122        </listitem>
123      </varlistentry>
124
125      <varlistentry id="chattr">
126        <term><command>chattr</command></term>
127        <listitem>
128          <para>Changes the attributes on a Linux file system</para>
129          <indexterm zone="ch-system-e2fsprogs chattr">
130            <primary sortas="b-chattr">chattr</primary>
131          </indexterm>
132        </listitem>
133      </varlistentry>
134
135      <varlistentry id="compile_et">
136        <term><command>compile_et</command></term>
137        <listitem>
138          <para>An error table compiler; it converts a table of error-code
139          names and messages into a C source file suitable for use with the
140          <filename class="libraryfile">com_err</filename> library</para>
141          <indexterm zone="ch-system-e2fsprogs compile_et">
142            <primary sortas="b-compile_et">compile_et</primary>
143          </indexterm>
144        </listitem>
145      </varlistentry>
146
147      <varlistentry id="debugfs">
148        <term><command>debugfs</command></term>
149        <listitem>
150          <para>A file system debugger; it can be used to examine and change
151          the state of an <systemitem class="filesystem">ext2</systemitem>
152          file system</para>
153          <indexterm zone="ch-system-e2fsprogs debugfs">
154            <primary sortas="b-debugfs">debugfs</primary>
155          </indexterm>
156        </listitem>
157      </varlistentry>
158
159      <varlistentry id="dumpe2fs">
160        <term><command>dumpe2fs</command></term>
161        <listitem>
162          <para>Prints the super block and blocks group information for the
163          file system present on a given device</para>
164          <indexterm zone="ch-system-e2fsprogs dumpe2fs">
165            <primary sortas="b-dumpe2fs">dumpe2fs</primary>
166          </indexterm>
167        </listitem>
168      </varlistentry>
169
170      <varlistentry id="e2freefrag">
171        <term><command>e2freefrag</command></term>
172        <listitem>
173          <para> Reports free space fragmentation information</para>
174          <indexterm zone="ch-system-e2fsprogs e2freefrag">
175            <primary sortas="b-e2freefrag">e2freefrag</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>, <systemitem
185          class="filesystem">ext3</systemitem> and <systemitem 
186          class="filesystem">ext4</systemitem>file systems</para>
187          <indexterm zone="ch-system-e2fsprogs e2fsck">
188            <primary sortas="b-e2fsck">e2fsck</primary>
189          </indexterm>
190        </listitem>
191      </varlistentry>
192
193      <varlistentry id="e2image">
194        <term><command>e2image</command></term>
195        <listitem>
196          <para>Is used to save critical <systemitem
197          class="filesystem">ext2</systemitem> file system data to a file</para>
198          <indexterm zone="ch-system-e2fsprogs e2image">
199            <primary sortas="b-e2image">e2image</primary>
200          </indexterm>
201        </listitem>
202      </varlistentry>
203
204      <varlistentry id="e2initrd_helper">
205        <term><command>e2initrd_helper</command></term>
206        <listitem>
207          <para>Prints the FS type of a given filesystem, given either a
208          device name or label</para>
209          <indexterm zone="ch-system-e2fsprogs e2initrd_helper">
210            <primary sortas="b-e2initrd_helper">e2initrd_helper</primary>
211          </indexterm>
212        </listitem>
213      </varlistentry>
214
215      <varlistentry id="e2label">
216        <term><command>e2label</command></term>
217        <listitem>
218          <para>Displays or changes the file system label on the <systemitem
219          class="filesystem">ext2</systemitem> file system present on a given
220          device</para>
221          <indexterm zone="ch-system-e2fsprogs e2label">
222            <primary sortas="b-e2label">e2label</primary>
223          </indexterm>
224        </listitem>
225      </varlistentry>
226
227      <varlistentry id="e2undo">
228        <term><command>e2undo</command></term>
229        <listitem>
230          <para>Replays an undo log for an ext2/ext3/ext4 filesystem</para>
231          <indexterm zone="ch-system-e2fsprogs e2undo">
232            <primary sortas="b-e2undo">e2undo</primary>
233          </indexterm>
234        </listitem>
235      </varlistentry>
236
237      <varlistentry id="e4defrag">
238        <term><command>e4defrag</command></term>
239        <listitem>
240          <para>Online defragmenter for ext4 filesystems</para>
241          <indexterm zone="ch-system-e2fsprogs e4defrag">
242            <primary sortas="b-e4defrag">e4defrag</primary>
243          </indexterm>
244        </listitem>
245      </varlistentry>
246
247      <varlistentry id="filefrag">
248        <term><command>filefrag</command></term>
249        <listitem>
250          <para>Reports on how badly fragmented a particular file might be</para>
251          <indexterm zone="ch-system-e2fsprogs filefrag">
252            <primary sortas="b-filefrag">filefrag</primary>
253          </indexterm>
254        </listitem>
255      </varlistentry>
256
257      <varlistentry id="fsck.ext2">
258        <term><command>fsck.ext2</command></term>
259        <listitem>
260          <para>By default checks <systemitem class="filesystem">ext2</systemitem>
261          file systems</para>
262          <indexterm zone="ch-system-e2fsprogs fsck.ext2">
263            <primary sortas="b-fsck.ext2">fsck.ext2</primary>
264          </indexterm>
265        </listitem>
266      </varlistentry>
267
268      <varlistentry id="fsck.ext3">
269        <term><command>fsck.ext3</command></term>
270        <listitem>
271          <para>By default checks <systemitem class="filesystem">ext3</systemitem>
272          file systems</para>
273          <indexterm zone="ch-system-e2fsprogs fsck.ext3">
274            <primary sortas="b-fsck.ext3">fsck.ext3</primary>
275          </indexterm>
276        </listitem>
277      </varlistentry>
278
279      <varlistentry id="fsck.ext4">
280        <term><command>fsck.ext4</command></term>
281        <listitem>
282          <para>By default checks <systemitem class="filesystem">ext4</systemitem>
283          file systems</para>
284          <indexterm zone="ch-system-e2fsprogs fsck.ext4">
285            <primary sortas="b-fsck.ext4">fsck.ext4</primary>
286          </indexterm>
287        </listitem>
288      </varlistentry>
289
290      <varlistentry id="fsck.ext4dev">
291        <term><command>fsck.ext4dev</command></term>
292        <listitem>
293          <para>By default checks <systemitem class="filesystem">ext4dev</systemitem>
294          file systems</para>
295          <indexterm zone="ch-system-e2fsprogs fsck.ext4dev">
296            <primary sortas="b-fsck.ext4dev">fsck.ext4dev</primary>
297          </indexterm>
298        </listitem>
299      </varlistentry>
300
301      <varlistentry id="logsave">
302        <term><command>logsave</command></term>
303        <listitem>
304          <para>Saves the output of a command in a log file</para>
305          <indexterm zone="ch-system-e2fsprogs logsave">
306            <primary sortas="b-logsave">logsave</primary>
307          </indexterm>
308        </listitem>
309      </varlistentry>
310
311      <varlistentry id="lsattr">
312        <term><command>lsattr</command></term>
313        <listitem>
314          <para>Lists the attributes of files on a second extended file
315          system</para>
316          <indexterm zone="ch-system-e2fsprogs lsattr">
317            <primary sortas="b-lsattr">lsattr</primary>
318          </indexterm>
319        </listitem>
320      </varlistentry>
321
322      <varlistentry id="mk_cmds">
323        <term><command>mk_cmds</command></term>
324        <listitem>
325          <para>Converts a table of command names and help messages into a C
326          source file suitable for use with the <filename
327          class="libraryfile">libss</filename> subsystem library</para>
328          <indexterm zone="ch-system-e2fsprogs mk_cmds">
329            <primary sortas="b-mk_cmds">mk_cmds</primary>
330          </indexterm>
331        </listitem>
332      </varlistentry>
333
334      <varlistentry id="mke2fs">
335        <term><command>mke2fs</command></term>
336        <listitem>
337          <para>Creates an <systemitem class="filesystem">ext2</systemitem>,
338          <systemitem class="filesystem">ext3</systemitem> or <systemitem 
339          class="filesystem">ext4</systemitem> file system on the given device</para>
340          <indexterm zone="ch-system-e2fsprogs mke2fs">
341            <primary sortas="b-mke2fs">mke2fs</primary>
342          </indexterm>
343        </listitem>
344      </varlistentry>
345
346      <varlistentry id="mkfs.ext2">
347        <term><command>mkfs.ext2</command></term>
348        <listitem>
349          <para>By default creates <systemitem class="filesystem">ext2</systemitem>
350          file systems</para>
351          <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
352            <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
353          </indexterm>
354        </listitem>
355      </varlistentry>
356
357      <varlistentry id="mkfs.ext3">
358        <term><command>mkfs.ext3</command></term>
359        <listitem>
360          <para>By default creates <systemitem class="filesystem">ext3</systemitem>
361          file systems</para>
362          <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
363            <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
364          </indexterm>
365        </listitem>
366      </varlistentry>
367
368      <varlistentry id="mkfs.ext4">
369        <term><command>mkfs.ext4</command></term>
370        <listitem>
371          <para>By default creates <systemitem class="filesystem">ext4</systemitem>
372          file systems</para>
373          <indexterm zone="ch-system-e2fsprogs mkfs.ext4">
374            <primary sortas="b-mkfs.ext4">mkfs.ext4</primary>
375          </indexterm>
376        </listitem>
377      </varlistentry>
378
379      <varlistentry id="mkfs.ext4dev">
380        <term><command>mkfs.ext4dev</command></term>
381        <listitem>
382          <para>By default creates <systemitem class="filesystem">ext4dev</systemitem>
383          file systems</para>
384          <indexterm zone="ch-system-e2fsprogs mkfs.ext4dev">
385            <primary sortas="b-mkfs.ext4dev">mkfs.ext4dev</primary>
386          </indexterm>
387        </listitem>
388      </varlistentry>
389
390      <varlistentry id="mklost-found">
391        <term><command>mklost+found</command></term>
392        <listitem>
393          <para>Used to create a <filename class="directory">lost+found</filename>
394          directory on an <systemitem class="filesystem">ext2</systemitem> file
395          system; it pre-allocates disk blocks to this directory to lighten the
396          task of <command>e2fsck</command></para>
397          <indexterm zone="ch-system-e2fsprogs mklost-found">
398            <primary sortas="b-mklost+found">mklost+found</primary>
399          </indexterm>
400        </listitem>
401      </varlistentry>
402
403      <varlistentry id="resize2fs">
404        <term><command>resize2fs</command></term>
405        <listitem>
406          <para>Can be used to enlarge or shrink an <systemitem
407          class="filesystem">ext2</systemitem> file system</para>
408          <indexterm zone="ch-system-e2fsprogs resize2fs">
409            <primary sortas="b-resize2fs">resize2fs</primary>
410          </indexterm>
411        </listitem>
412      </varlistentry>
413
414      <varlistentry id="tune2fs">
415        <term><command>tune2fs</command></term>
416        <listitem>
417          <para>Adjusts tunable file system parameters on an <systemitem
418          class="filesystem">ext2</systemitem> file system</para>
419          <indexterm zone="ch-system-e2fsprogs tune2fs">
420            <primary sortas="b-tune2fs">tune2fs</primary>
421          </indexterm>
422        </listitem>
423      </varlistentry>
424
425      <varlistentry id="libcom_err">
426        <term><filename class="libraryfile">libcom_err</filename></term>
427        <listitem>
428          <para>The common error display routine</para>
429          <indexterm zone="ch-system-e2fsprogs libcom_err">
430            <primary sortas="c-libcom_err">libcom_err</primary>
431          </indexterm>
432        </listitem>
433      </varlistentry>
434
435      <varlistentry id="libe2p">
436        <term><filename class="libraryfile">libe2p</filename></term>
437        <listitem>
438          <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
439          and <command>lsattr</command></para>
440          <indexterm zone="ch-system-e2fsprogs libe2p">
441            <primary sortas="c-libe2p">libe2p</primary>
442          </indexterm>
443        </listitem>
444      </varlistentry>
445
446      <varlistentry id="libext2fs">
447        <term><filename class="libraryfile">libext2fs</filename></term>
448        <listitem>
449          <para>Contains routines to enable user-level programs to manipulate an
450          <systemitem class="filesystem">ext2</systemitem> file system</para>
451          <indexterm zone="ch-system-e2fsprogs libext2fs">
452            <primary sortas="c-libext2fs">libext2fs</primary>
453          </indexterm>
454        </listitem>
455      </varlistentry>
456
457      <varlistentry id="libquota">
458        <term><filename class="libraryfile">libquota</filename></term>
459        <listitem>
460          <para>Provides an interface for creating and updating quota files
461          and ext4 superblock fields</para>
462          <indexterm zone="ch-system-e2fsprogs libquota">
463            <primary sortas="c-libquota">libquota</primary>
464          </indexterm>
465        </listitem>
466      </varlistentry>
467
468      <varlistentry id="libss">
469        <term><filename class="libraryfile">libss</filename></term>
470        <listitem>
471          <para>Used by <command>debugfs</command></para>
472          <indexterm zone="ch-system-e2fsprogs libss">
473            <primary sortas="c-libss">libss</primary>
474          </indexterm>
475        </listitem>
476      </varlistentry>
477
478    </variablelist>
479
480  </sect2>
481
482</sect1>
Note: See TracBrowser for help on using the repository browser.