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

clfs-1.2clfs-2.1clfs-3.0.0-systemdclfs-3.0.0-sysvinitsystemdsysvinit
Last change on this file since fcbd1c6 was fcbd1c6, checked in by Jonathan Norman <jon@…>, 12 years ago

Fixed e2fsprogs in PPC64 boot section
  • Property mode set to 100644
File size: 17.1 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, filefrag, fsck.ext2,
99        fsck.ext3, fsck.ext4, fsck.ext4dev, logsave, lsattr, mk_cmds, mke2fs,
100        mkfs.ext2, mkfs.ext3, mkfs.ext4, mkfs.ext4dev, mklost+found, resize2fs,
101        and tune2fs</seg>
102        <seg>libcom_err.[a,so], libe2p.[a,so], libext2fs.[a,so], and
103        libss.[a,so]</seg>
104        <seg>/usr/include/e2p, /usr/include/et, /usr/include/ext2fs,
105        /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 of files on an <systemitem
129          class="filesystem">ext2</systemitem> file system; it also
130          changes <systemitem class="filesystem">ext3</systemitem>
131          file systems, the journaling version of <systemitem
132          class="filesystem">ext2</systemitem> file systems</para>
133          <indexterm zone="ch-system-e2fsprogs chattr">
134            <primary sortas="b-chattr">chattr</primary>
135          </indexterm>
136        </listitem>
137      </varlistentry>
138
139      <varlistentry id="compile_et">
140        <term><command>compile_et</command></term>
141        <listitem>
142          <para>An error table compiler; it converts a table of error-code
143          names and messages into a C source file suitable for use with the
144          <filename class="libraryfile">com_err</filename> library</para>
145          <indexterm zone="ch-system-e2fsprogs compile_et">
146            <primary sortas="b-compile_et">compile_et</primary>
147          </indexterm>
148        </listitem>
149      </varlistentry>
150
151      <varlistentry id="debugfs">
152        <term><command>debugfs</command></term>
153        <listitem>
154          <para>A file system debugger; it can be used to examine and change
155          the state of an <systemitem class="filesystem">ext2</systemitem>
156          file system</para>
157          <indexterm zone="ch-system-e2fsprogs debugfs">
158            <primary sortas="b-debugfs">debugfs</primary>
159          </indexterm>
160        </listitem>
161      </varlistentry>
162
163      <varlistentry id="dumpe2fs">
164        <term><command>dumpe2fs</command></term>
165        <listitem>
166          <para>Prints the super block and blocks group information for the
167          file system present on a given device</para>
168          <indexterm zone="ch-system-e2fsprogs dumpe2fs">
169            <primary sortas="b-dumpe2fs">dumpe2fs</primary>
170          </indexterm>
171        </listitem>
172      </varlistentry>
173
174      <varlistentry id="e2freefrag">
175        <term><command>e2freefrag</command></term>
176        <listitem>
177          <para> Reports free space fragmentation information</para>
178          <indexterm zone="ch-system-e2fsprogs e2freefrag">
179            <primary sortas="b-e2freefrag">e2freefrag</primary>
180          </indexterm>
181        </listitem>
182      </varlistentry>
183
184      <varlistentry id="e2fsck">
185        <term><command>e2fsck</command></term>
186        <listitem>
187          <para>Is used to check, and optionally repair <systemitem
188          class="filesystem">ext2</systemitem>, <systemitem
189          class="filesystem">ext3</systemitem> and <systemitem 
190          class="filesystem">ext4</systemitem>file systems</para>
191          <indexterm zone="ch-system-e2fsprogs e2fsck">
192            <primary sortas="b-e2fsck">e2fsck</primary>
193          </indexterm>
194        </listitem>
195      </varlistentry>
196
197      <varlistentry id="e2image">
198        <term><command>e2image</command></term>
199        <listitem>
200          <para>Is used to save critical <systemitem
201          class="filesystem">ext2</systemitem> file system data to a file</para>
202          <indexterm zone="ch-system-e2fsprogs e2image">
203            <primary sortas="b-e2image">e2image</primary>
204          </indexterm>
205        </listitem>
206      </varlistentry>
207
208      <varlistentry id="e2initrd_helper">
209        <term><command>e2initrd_helper</command></term>
210        <listitem>
211          <para>Prints the FS type of a given filesystem, given either a
212          device name or label</para>
213          <indexterm zone="ch-system-e2fsprogs e2initrd_helper">
214            <primary sortas="b-e2initrd_helper">e2initrd_helper</primary>
215          </indexterm>
216        </listitem>
217      </varlistentry>
218
219      <varlistentry id="e2label">
220        <term><command>e2label</command></term>
221        <listitem>
222          <para>Displays or changes the file system label on the <systemitem
223          class="filesystem">ext2</systemitem> file system present on a given
224          device</para>
225          <indexterm zone="ch-system-e2fsprogs e2label">
226            <primary sortas="b-e2label">e2label</primary>
227          </indexterm>
228        </listitem>
229      </varlistentry>
230
231      <varlistentry id="e2undo">
232        <term><command>e2undo</command></term>
233        <listitem>
234          <para>Replays an undo log for an ext2/ext3/ext4 filesystem</para>
235          <indexterm zone="ch-system-e2fsprogs e2undo">
236            <primary sortas="b-e2undo">e2undo</primary>
237          </indexterm>
238        </listitem>
239      </varlistentry>
240
241      <varlistentry id="filefrag">
242        <term><command>filefrag</command></term>
243        <listitem>
244          <para>Reports on how badly fragmented a particular file might be</para>
245          <indexterm zone="ch-system-e2fsprogs filefrag">
246            <primary sortas="b-filefrag">filefrag</primary>
247          </indexterm>
248        </listitem>
249      </varlistentry>
250
251      <varlistentry id="fsck.ext2">
252        <term><command>fsck.ext2</command></term>
253        <listitem>
254          <para>By default checks <systemitem class="filesystem">ext2</systemitem>
255          file systems</para>
256          <indexterm zone="ch-system-e2fsprogs fsck.ext2">
257            <primary sortas="b-fsck.ext2">fsck.ext2</primary>
258          </indexterm>
259        </listitem>
260      </varlistentry>
261
262      <varlistentry id="fsck.ext3">
263        <term><command>fsck.ext3</command></term>
264        <listitem>
265          <para>By default checks <systemitem class="filesystem">ext3</systemitem>
266          file systems</para>
267          <indexterm zone="ch-system-e2fsprogs fsck.ext3">
268            <primary sortas="b-fsck.ext3">fsck.ext3</primary>
269          </indexterm>
270        </listitem>
271      </varlistentry>
272
273      <varlistentry id="fsck.ext4">
274        <term><command>fsck.ext4</command></term>
275        <listitem>
276          <para>By default checks <systemitem class="filesystem">ext4</systemitem>
277          file systems</para>
278          <indexterm zone="ch-system-e2fsprogs fsck.ext4">
279            <primary sortas="b-fsck.ext4">fsck.ext4</primary>
280          </indexterm>
281        </listitem>
282      </varlistentry>
283
284      <varlistentry id="fsck.ext4dev">
285        <term><command>fsck.ext4dev</command></term>
286        <listitem>
287          <para>By default checks <systemitem class="filesystem">ext4dev</systemitem>
288          file systems</para>
289          <indexterm zone="ch-system-e2fsprogs fsck.ext4dev">
290            <primary sortas="b-fsck.ext4dev">fsck.ext4dev</primary>
291          </indexterm>
292        </listitem>
293      </varlistentry>
294
295      <varlistentry id="logsave">
296        <term><command>logsave</command></term>
297        <listitem>
298          <para>Saves the output of a command in a log file</para>
299          <indexterm zone="ch-system-e2fsprogs logsave">
300            <primary sortas="b-logsave">logsave</primary>
301          </indexterm>
302        </listitem>
303      </varlistentry>
304
305      <varlistentry id="lsattr">
306        <term><command>lsattr</command></term>
307        <listitem>
308          <para>Lists the attributes of files on a second extended file
309          system</para>
310          <indexterm zone="ch-system-e2fsprogs lsattr">
311            <primary sortas="b-lsattr">lsattr</primary>
312          </indexterm>
313        </listitem>
314      </varlistentry>
315
316      <varlistentry id="mk_cmds">
317        <term><command>mk_cmds</command></term>
318        <listitem>
319          <para>Converts a table of command names and help messages into a C
320          source file suitable for use with the <filename
321          class="libraryfile">libss</filename> subsystem library</para>
322          <indexterm zone="ch-system-e2fsprogs mk_cmds">
323            <primary sortas="b-mk_cmds">mk_cmds</primary>
324          </indexterm>
325        </listitem>
326      </varlistentry>
327
328      <varlistentry id="mke2fs">
329        <term><command>mke2fs</command></term>
330        <listitem>
331          <para>Creates an <systemitem class="filesystem">ext2</systemitem>,
332          <systemitem class="filesystem">ext3</systemitem> or <systemitem 
333          class="filesystem">ext4</systemitem> file system on the given device</para>
334          <indexterm zone="ch-system-e2fsprogs mke2fs">
335            <primary sortas="b-mke2fs">mke2fs</primary>
336          </indexterm>
337        </listitem>
338      </varlistentry>
339
340      <varlistentry id="mkfs.ext2">
341        <term><command>mkfs.ext2</command></term>
342        <listitem>
343          <para>By default creates <systemitem class="filesystem">ext2</systemitem>
344          file systems</para>
345          <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
346            <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
347          </indexterm>
348        </listitem>
349      </varlistentry>
350
351      <varlistentry id="mkfs.ext3">
352        <term><command>mkfs.ext3</command></term>
353        <listitem>
354          <para>By default creates <systemitem class="filesystem">ext3</systemitem>
355          file systems</para>
356          <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
357            <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
358          </indexterm>
359        </listitem>
360      </varlistentry>
361
362      <varlistentry id="mkfs.ext4">
363        <term><command>mkfs.ext4</command></term>
364        <listitem>
365          <para>By default creates <systemitem class="filesystem">ext4</systemitem>
366          file systems</para>
367          <indexterm zone="ch-system-e2fsprogs mkfs.ext4">
368            <primary sortas="b-mkfs.ext4">mkfs.ext4</primary>
369          </indexterm>
370        </listitem>
371      </varlistentry>
372
373      <varlistentry id="mkfs.ext4dev">
374        <term><command>mkfs.ext4dev</command></term>
375        <listitem>
376          <para>By default creates <systemitem class="filesystem">ext4dev</systemitem>
377          file systems</para>
378          <indexterm zone="ch-system-e2fsprogs mkfs.ext4dev">
379            <primary sortas="b-mkfs.ext4dev">mkfs.ext4dev</primary>
380          </indexterm>
381        </listitem>
382      </varlistentry>
383
384      <varlistentry id="mklost-found">
385        <term><command>mklost+found</command></term>
386        <listitem>
387          <para>Used to create a <filename class="directory">lost+found</filename>
388          directory on an <systemitem class="filesystem">ext2</systemitem> file
389          system; it pre-allocates disk blocks to this directory to lighten the
390          task of <command>e2fsck</command></para>
391          <indexterm zone="ch-system-e2fsprogs mklost-found">
392            <primary sortas="b-mklost+found">mklost+found</primary>
393          </indexterm>
394        </listitem>
395      </varlistentry>
396
397      <varlistentry id="resize2fs">
398        <term><command>resize2fs</command></term>
399        <listitem>
400          <para>Can be used to enlarge or shrink an <systemitem
401          class="filesystem">ext2</systemitem> file system</para>
402          <indexterm zone="ch-system-e2fsprogs resize2fs">
403            <primary sortas="b-resize2fs">resize2fs</primary>
404          </indexterm>
405        </listitem>
406      </varlistentry>
407
408      <varlistentry id="tune2fs">
409        <term><command>tune2fs</command></term>
410        <listitem>
411          <para>Adjusts tunable file system parameters on an <systemitem
412          class="filesystem">ext2</systemitem> file system</para>
413          <indexterm zone="ch-system-e2fsprogs tune2fs">
414            <primary sortas="b-tune2fs">tune2fs</primary>
415          </indexterm>
416        </listitem>
417      </varlistentry>
418
419      <varlistentry id="libcom_err">
420        <term><filename class="libraryfile">libcom_err</filename></term>
421        <listitem>
422          <para>The common error display routine</para>
423          <indexterm zone="ch-system-e2fsprogs libcom_err">
424            <primary sortas="c-libcom_err">libcom_err</primary>
425          </indexterm>
426        </listitem>
427      </varlistentry>
428
429      <varlistentry id="libe2p">
430        <term><filename class="libraryfile">libe2p</filename></term>
431        <listitem>
432          <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
433          and <command>lsattr</command></para>
434          <indexterm zone="ch-system-e2fsprogs libe2p">
435            <primary sortas="c-libe2p">libe2p</primary>
436          </indexterm>
437        </listitem>
438      </varlistentry>
439
440      <varlistentry id="libext2fs">
441        <term><filename class="libraryfile">libext2fs</filename></term>
442        <listitem>
443          <para>Contains routines to enable user-level programs to manipulate an
444          <systemitem class="filesystem">ext2</systemitem> file system</para>
445          <indexterm zone="ch-system-e2fsprogs libext2fs">
446            <primary sortas="c-libext2fs">libext2fs</primary>
447          </indexterm>
448        </listitem>
449      </varlistentry>
450
451      <varlistentry id="libss">
452        <term><filename class="libraryfile">libss</filename></term>
453        <listitem>
454          <para>Used by <command>debugfs</command></para>
455          <indexterm zone="ch-system-e2fsprogs libss">
456            <primary sortas="c-libss">libss</primary>
457          </indexterm>
458        </listitem>
459      </varlistentry>
460
461    </variablelist>
462
463  </sect2>
464
465</sect1>
Note: See TracBrowser for help on using the repository browser.