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

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

Additional consistency in program lists
  • Property mode set to 100644
File size: 16.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>PKG_CONFIG=true ../configure --prefix=/usr --with-root-prefix="" \
40    --enable-elf-shlibs --with-cc=gcc \
41    --disable-libblkid --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 LIBUUID="-luuid" STATIC_LIBUUID="-luuid" \
74    LIBBLKID="-lblkid" STATIC_LIBBLKID="-lblkid"</userinput></screen>
75
76    <para os="h">To test the results, issue:
77    <userinput>make check</userinput>.</para>
78
79    <para os="i">Install the binaries, documentation and shared libraries:</para>
80
81<screen os="j"><userinput>make install</userinput></screen>
82
83    <para os="k">Install the static libraries and headers:</para>
84
85<screen os="l"><userinput>make install-libs</userinput></screen>
86
87  </sect2>
88
89  <sect2 id="contents-e2fsprogs" role="content">
90    <title>Contents of E2fsprogs</title>
91
92    <segmentedlist>
93      <segtitle>Installed programs</segtitle>
94      <segtitle>Installed libraries</segtitle>
95
96      <seglistitem>
97        <seg>badblocks, chattr, compile_et, debugfs, dumpe2fs, e2fsck, e2image,
98        e2initrd_helper, e2label, e2undo, filefrag, fsck.ext2, fsck.ext3,
99        fsck.ext4, fsck.ext4dev, logsave, lsattr, mk_cmds, mke2fs, mkfs.ext2,
100        mkfs.ext3, mkfs.ext4, mkfs.ext4dev, mklost+found, resize2fs, and
101        tune2fs</seg>
102        <seg>libcom_err.[a,so], libe2p.[a,so], libext2fs.[a,so], and
103        libss.[a,so]</seg>
104      </seglistitem>
105    </segmentedlist>
106
107    <variablelist>
108      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
109      <?dbfo list-presentation="list"?>
110      <?dbhtml list-presentation="table"?>
111
112      <varlistentry id="badblocks">
113        <term><command>badblocks</command></term>
114        <listitem>
115          <para>Searches a device (usually a disk partition) for bad
116          blocks</para>
117          <indexterm zone="ch-system-e2fsprogs badblocks">
118            <primary sortas="b-badblocks">badblocks</primary>
119          </indexterm>
120        </listitem>
121      </varlistentry>
122
123      <varlistentry id="chattr">
124        <term><command>chattr</command></term>
125        <listitem>
126          <para>Changes the attributes of files on an <systemitem
127          class="filesystem">ext2</systemitem> file system; it also
128          changes <systemitem class="filesystem">ext3</systemitem>
129          file systems, the journaling version of <systemitem
130          class="filesystem">ext2</systemitem> file systems</para>
131          <indexterm zone="ch-system-e2fsprogs chattr">
132            <primary sortas="b-chattr">chattr</primary>
133          </indexterm>
134        </listitem>
135      </varlistentry>
136
137      <varlistentry id="compile_et">
138        <term><command>compile_et</command></term>
139        <listitem>
140          <para>An error table compiler; it converts a table of error-code
141          names and messages into a C source file suitable for use with the
142          <filename class="libraryfile">com_err</filename> library</para>
143          <indexterm zone="ch-system-e2fsprogs compile_et">
144            <primary sortas="b-compile_et">compile_et</primary>
145          </indexterm>
146        </listitem>
147      </varlistentry>
148
149      <varlistentry id="debugfs">
150        <term><command>debugfs</command></term>
151        <listitem>
152          <para>A file system debugger; it can be used to examine and change
153          the state of an <systemitem class="filesystem">ext2</systemitem>
154          file system</para>
155          <indexterm zone="ch-system-e2fsprogs debugfs">
156            <primary sortas="b-debugfs">debugfs</primary>
157          </indexterm>
158        </listitem>
159      </varlistentry>
160
161      <varlistentry id="dumpe2fs">
162        <term><command>dumpe2fs</command></term>
163        <listitem>
164          <para>Prints the super block and blocks group information for the
165          file system present on a given device</para>
166          <indexterm zone="ch-system-e2fsprogs dumpe2fs">
167            <primary sortas="b-dumpe2fs">dumpe2fs</primary>
168          </indexterm>
169        </listitem>
170      </varlistentry>
171
172      <varlistentry id="e2fsck">
173        <term><command>e2fsck</command></term>
174        <listitem>
175          <para>Is used to check, and optionally repair <systemitem
176          class="filesystem">ext2</systemitem> file systems and <systemitem
177          class="filesystem">ext3</systemitem> file systems</para>
178          <indexterm zone="ch-system-e2fsprogs e2fsck">
179            <primary sortas="b-e2fsck">e2fsck</primary>
180          </indexterm>
181        </listitem>
182      </varlistentry>
183
184      <varlistentry id="e2image">
185        <term><command>e2image</command></term>
186        <listitem>
187          <para>Is used to save critical <systemitem
188          class="filesystem">ext2</systemitem> file system data to a file</para>
189          <indexterm zone="ch-system-e2fsprogs e2image">
190            <primary sortas="b-e2image">e2image</primary>
191          </indexterm>
192        </listitem>
193      </varlistentry>
194
195      <varlistentry id="e2initrd_helper">
196        <term><command>e2initrd_helper</command></term>
197        <listitem>
198          <para>Prints the FS type of a given filesystem, given either a
199          device name or label</para>
200          <indexterm zone="ch-system-e2fsprogs e2initrd_helper">
201            <primary sortas="b-e2initrd_helper">e2initrd_helper</primary>
202          </indexterm>
203        </listitem>
204      </varlistentry>
205
206      <varlistentry id="e2label">
207        <term><command>e2label</command></term>
208        <listitem>
209          <para>Displays or changes the file system label on the <systemitem
210          class="filesystem">ext2</systemitem> file system present on a given
211          device</para>
212          <indexterm zone="ch-system-e2fsprogs e2label">
213            <primary sortas="b-e2label">e2label</primary>
214          </indexterm>
215        </listitem>
216      </varlistentry>
217
218      <varlistentry id="e2undo">
219        <term><command>e2undo</command></term>
220        <listitem>
221          <para>Replays an undo log for an ext2/ext3/ext4 filesystem</para>
222          <indexterm zone="ch-system-e2fsprogs e2undo">
223            <primary sortas="b-e2undo">e2undo</primary>
224          </indexterm>
225        </listitem>
226      </varlistentry>
227
228      <varlistentry id="filefrag">
229        <term><command>filefrag</command></term>
230        <listitem>
231          <para>Reports on how badly fragmented a particular file might be</para>
232          <indexterm zone="ch-system-e2fsprogs filefrag">
233            <primary sortas="b-filefrag">filefrag</primary>
234          </indexterm>
235        </listitem>
236      </varlistentry>
237
238      <varlistentry id="fsck.ext2">
239        <term><command>fsck.ext2</command></term>
240        <listitem>
241          <para>By default checks <systemitem class="filesystem">ext2</systemitem>
242          file systems</para>
243          <indexterm zone="ch-system-e2fsprogs fsck.ext2">
244            <primary sortas="b-fsck.ext2">fsck.ext2</primary>
245          </indexterm>
246        </listitem>
247      </varlistentry>
248
249      <varlistentry id="fsck.ext3">
250        <term><command>fsck.ext3</command></term>
251        <listitem>
252          <para>By default checks <systemitem class="filesystem">ext3</systemitem>
253          file systems</para>
254          <indexterm zone="ch-system-e2fsprogs fsck.ext3">
255            <primary sortas="b-fsck.ext3">fsck.ext3</primary>
256          </indexterm>
257        </listitem>
258      </varlistentry>
259
260      <varlistentry id="fsck.ext4">
261        <term><command>fsck.ext4</command></term>
262        <listitem>
263          <para>By default checks <systemitem class="filesystem">ext4</systemitem>
264          file systems</para>
265          <indexterm zone="ch-system-e2fsprogs fsck.ext4">
266            <primary sortas="b-fsck.ext4">fsck.ext4</primary>
267          </indexterm>
268        </listitem>
269      </varlistentry>
270
271      <varlistentry id="fsck.ext4dev">
272        <term><command>fsck.ext4dev</command></term>
273        <listitem>
274          <para>By default checks <systemitem class="filesystem">ext4dev</systemitem>
275          file systems</para>
276          <indexterm zone="ch-system-e2fsprogs fsck.ext4dev">
277            <primary sortas="b-fsck.ext4dev">fsck.ext4dev</primary>
278          </indexterm>
279        </listitem>
280      </varlistentry>
281
282      <varlistentry id="logsave">
283        <term><command>logsave</command></term>
284        <listitem>
285          <para>Saves the output of a command in a log file</para>
286          <indexterm zone="ch-system-e2fsprogs logsave">
287            <primary sortas="b-logsave">logsave</primary>
288          </indexterm>
289        </listitem>
290      </varlistentry>
291
292      <varlistentry id="lsattr">
293        <term><command>lsattr</command></term>
294        <listitem>
295          <para>Lists the attributes of files on a second extended file
296          system</para>
297          <indexterm zone="ch-system-e2fsprogs lsattr">
298            <primary sortas="b-lsattr">lsattr</primary>
299          </indexterm>
300        </listitem>
301      </varlistentry>
302
303      <varlistentry id="mk_cmds">
304        <term><command>mk_cmds</command></term>
305        <listitem>
306          <para>Converts a table of command names and help messages into a C
307          source file suitable for use with the <filename
308          class="libraryfile">libss</filename> subsystem library</para>
309          <indexterm zone="ch-system-e2fsprogs mk_cmds">
310            <primary sortas="b-mk_cmds">mk_cmds</primary>
311          </indexterm>
312        </listitem>
313      </varlistentry>
314
315      <varlistentry id="mke2fs">
316        <term><command>mke2fs</command></term>
317        <listitem>
318          <para>Creates an <systemitem class="filesystem">ext2</systemitem>
319          or <systemitem class="filesystem">ext3</systemitem> file system on
320          the given device</para>
321          <indexterm zone="ch-system-e2fsprogs mke2fs">
322            <primary sortas="b-mke2fs">mke2fs</primary>
323          </indexterm>
324        </listitem>
325      </varlistentry>
326
327      <varlistentry id="mkfs.ext2">
328        <term><command>mkfs.ext2</command></term>
329        <listitem>
330          <para>By default creates <systemitem class="filesystem">ext2</systemitem>
331          file systems</para>
332          <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
333            <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
334          </indexterm>
335        </listitem>
336      </varlistentry>
337
338      <varlistentry id="mkfs.ext3">
339        <term><command>mkfs.ext3</command></term>
340        <listitem>
341          <para>By default creates <systemitem class="filesystem">ext3</systemitem>
342          file systems</para>
343          <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
344            <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
345          </indexterm>
346        </listitem>
347      </varlistentry>
348
349      <varlistentry id="mkfs.ext4">
350        <term><command>mkfs.ext4</command></term>
351        <listitem>
352          <para>By default creates <systemitem class="filesystem">ext4</systemitem>
353          file systems</para>
354          <indexterm zone="ch-system-e2fsprogs mkfs.ext4">
355            <primary sortas="b-mkfs.ext4">mkfs.ext4</primary>
356          </indexterm>
357        </listitem>
358      </varlistentry>
359
360      <varlistentry id="mkfs.ext4dev">
361        <term><command>mkfs.ext4dev</command></term>
362        <listitem>
363          <para>By default creates <systemitem class="filesystem">ext4dev</systemitem>
364          file systems</para>
365          <indexterm zone="ch-system-e2fsprogs mkfs.ext4dev">
366            <primary sortas="b-mkfs.ext4dev">mkfs.ext4dev</primary>
367          </indexterm>
368        </listitem>
369      </varlistentry>
370
371      <varlistentry id="mklost-found">
372        <term><command>mklost+found</command></term>
373        <listitem>
374          <para>Used to create a <filename class="directory">lost+found</filename>
375          directory on an <systemitem class="filesystem">ext2</systemitem> file
376          system; it pre-allocates disk blocks to this directory to lighten the
377          task of <command>e2fsck</command></para>
378          <indexterm zone="ch-system-e2fsprogs mklost-found">
379            <primary sortas="b-mklost+found">mklost+found</primary>
380          </indexterm>
381        </listitem>
382      </varlistentry>
383
384      <varlistentry id="resize2fs">
385        <term><command>resize2fs</command></term>
386        <listitem>
387          <para>Can be used to enlarge or shrink an <systemitem
388          class="filesystem">ext2</systemitem> file system</para>
389          <indexterm zone="ch-system-e2fsprogs resize2fs">
390            <primary sortas="b-resize2fs">resize2fs</primary>
391          </indexterm>
392        </listitem>
393      </varlistentry>
394
395      <varlistentry id="tune2fs">
396        <term><command>tune2fs</command></term>
397        <listitem>
398          <para>Adjusts tunable file system parameters on an <systemitem
399          class="filesystem">ext2</systemitem> file system</para>
400          <indexterm zone="ch-system-e2fsprogs tune2fs">
401            <primary sortas="b-tune2fs">tune2fs</primary>
402          </indexterm>
403        </listitem>
404      </varlistentry>
405
406      <varlistentry id="libcom_err">
407        <term><filename class="libraryfile">libcom_err</filename></term>
408        <listitem>
409          <para>The common error display routine</para>
410          <indexterm zone="ch-system-e2fsprogs libcom_err">
411            <primary sortas="c-libcom_err">libcom_err</primary>
412          </indexterm>
413        </listitem>
414      </varlistentry>
415
416      <varlistentry id="libe2p">
417        <term><filename class="libraryfile">libe2p</filename></term>
418        <listitem>
419          <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
420          and <command>lsattr</command></para>
421          <indexterm zone="ch-system-e2fsprogs libe2p">
422            <primary sortas="c-libe2p">libe2p</primary>
423          </indexterm>
424        </listitem>
425      </varlistentry>
426
427      <varlistentry id="libext2fs">
428        <term><filename class="libraryfile">libext2fs</filename></term>
429        <listitem>
430          <para>Contains routines to enable user-level programs to manipulate an
431          <systemitem class="filesystem">ext2</systemitem> file system</para>
432          <indexterm zone="ch-system-e2fsprogs libext2fs">
433            <primary sortas="c-libext2fs">libext2fs</primary>
434          </indexterm>
435        </listitem>
436      </varlistentry>
437
438      <varlistentry id="libss">
439        <term><filename class="libraryfile">libss</filename></term>
440        <listitem>
441          <para>Used by <command>debugfs</command></para>
442          <indexterm zone="ch-system-e2fsprogs libss">
443            <primary sortas="c-libss">libss</primary>
444          </indexterm>
445        </listitem>
446      </varlistentry>
447
448    </variablelist>
449
450  </sect2>
451
452</sect1>
Note: See TracBrowser for help on using the repository browser.