source: clfs-sysroot/BOOK/final-system/common/e2fsprogs.xml @ 9c8c5a8

Last change on this file since 9c8c5a8 was ddaaf19, checked in by Joe Ciccone <jciccone@…>, 15 years ago

Fix validation error and cleanup e2fsprogs installed programs.
  • Property mode set to 100644
File size: 15.7 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  &env-target;
29
30  <sect2 role="installation">
31    <title>Installation of E2fsprogs</title>
32
33    <para os="a">The E2fsprogs documentation recommends that the package be
34    built in a subdirectory of the source tree:</para>
35
36<screen os="b"><userinput>mkdir -v build
37cd build</userinput></screen>
38
39    <para os="c">Prepare E2fsprogs for compilation:</para>
40
41<screen os="d"><userinput>PKG_CONFIG=true ../configure --build=${CLFS_HOST} --host=${CLFS_TARGET} \
42    --prefix=/usr --with-root-prefix="" \
43    --enable-elf-shlibs --disable-libblkid \
44    --disable-libuuid --disable-fsck --disable-uuidd</userinput></screen>
45
46    <variablelist os="e">
47      <title>The meaning of the configure options:</title>
48
49      <varlistentry os="e1">
50        <term><parameter>--with-root-prefix=""</parameter></term>
51        <listitem>
52          <para>Certain programs (such as the <command>e2fsck</command>
53          program) are considered essential programs. When, for example,
54          <filename class="directory">/usr</filename> is not mounted,
55          these programs still need to be available. They belong in
56          directories like <filename class="directory">/lib</filename> and
57          <filename class="directory">/sbin</filename>. If this option is
58          not passed to E2fsprogs' configure, the programs are installed into
59          the <filename class="directory">/usr</filename> directory.</para>
60        </listitem>
61      </varlistentry>
62
63      <varlistentry os="e2">
64        <term><parameter>--enable-elf-shlibs</parameter></term>
65        <listitem>
66          <para>This creates the shared libraries which some programs
67          in this package use.</para>
68        </listitem>
69      </varlistentry>
70
71      <varlistentry os="e3">
72        <term><parameter>--disable-evms</parameter></term>
73        <listitem>
74          <para>This disables the building of the Enterprise Volume
75          Management System (EVMS) plugin. This plugin is not up-to-date with
76          the latest EVMS internal interfaces and EVMS is not installed as part
77          of a base CLFS system, so the plugin is not required. See the EVMS
78          website at <ulink url="http://evms.sourceforge.net/"/> for more
79          information regarding EVMS.</para>
80        </listitem>
81      </varlistentry>
82
83    </variablelist>
84
85    <para os="f">Compile the package:</para>
86
87<screen os="g"><userinput>make</userinput></screen>
88
89    <para os="h">Install the binaries, documentation, and shared libraries:</para>
90
91<screen os="i"><userinput>make DESTDIR=${CLFS} install</userinput></screen>
92
93    <para os="j">Install the static libraries and headers:</para>
94
95<screen os="k"><userinput>make DESTDIR=${CLFS} install-libs</userinput></screen>
96
97    <para os="l">Remove absolute paths from the link destinations:</para>
98
99<screen os="m"><userinput>rm -v ${CLFS}/usr/lib/lib{com_err,e2p,ext2fs,ss}.so
100ln -sv ../../lib/libcom_err.so.2 ${CLFS}/usr/lib/libcom_err.so
101ln -sv ../../lib/libe2p.so.2 ${CLFS}/usr/lib/libe2p.so
102ln -sv ../../lib/libext2fs.so.2 ${CLFS}/usr/lib/libext2fs.so
103ln -sv ../../lib/libss.so.2 ${CLFS}/usr/lib/libss.so</userinput></screen>
104
105  </sect2>
106
107  <sect2 id="contents-e2fsprogs" role="content">
108    <title>Contents of E2fsprogs</title>
109
110    <segmentedlist>
111      <segtitle>Installed programs</segtitle>
112      <segtitle>Installed libraries</segtitle>
113
114      <seglistitem>
115        <seg>badblocks, blkid, chattr, compile_et, debugfs, dumpe2fs,
116        e2fsck, e2image, e2label, filefrag, findfs, fsck, fsck.ext2, fsck.ext3,
117        logsave, lsattr, mk_cmds, mke2fs, mkfs.ext2, mkfs.ext3,
118        mklost+found, resize2fs, and tune2fs.</seg>
119        <seg>libcom_err.[a,so], libe2p.[a,so],
120        libext2fs.[a,so], and libss.[a,so]</seg>
121      </seglistitem>
122    </segmentedlist>
123
124    <variablelist>
125      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
126      <?dbfo list-presentation="list"?>
127      <?dbhtml list-presentation="table"?>
128
129      <varlistentry id="badblocks">
130        <term><command>badblocks</command></term>
131        <listitem>
132          <para>Searches a device (usually a disk partition) for bad
133          blocks</para>
134          <indexterm zone="ch-system-e2fsprogs badblocks">
135            <primary sortas="b-badblocks">badblocks</primary>
136          </indexterm>
137        </listitem>
138      </varlistentry>
139
140      <varlistentry id="blkid">
141        <term><command>blkid</command></term>
142        <listitem>
143          <para>A command line utility to locate and print block device
144          attributes</para>
145          <indexterm zone="ch-system-e2fsprogs blkid">
146            <primary sortas="b-blkid">blkid</primary>
147          </indexterm>
148        </listitem>
149      </varlistentry>
150
151      <varlistentry id="chattr">
152        <term><command>chattr</command></term>
153        <listitem>
154          <para>Changes the attributes of files on an <systemitem
155          class="filesystem">ext2</systemitem> file system; it also
156          changes <systemitem class="filesystem">ext3</systemitem>
157          file systems, the journaling version of <systemitem
158          class="filesystem">ext2</systemitem> file systems</para>
159          <indexterm zone="ch-system-e2fsprogs chattr">
160            <primary sortas="b-chattr">chattr</primary>
161          </indexterm>
162        </listitem>
163      </varlistentry>
164
165      <varlistentry id="compile_et">
166        <term><command>compile_et</command></term>
167        <listitem>
168          <para>An error table compiler; it converts a table of error-code
169          names and messages into a C source file suitable for use with the
170          <filename class="libraryfile">com_err</filename> library</para>
171          <indexterm zone="ch-system-e2fsprogs compile_et">
172            <primary sortas="b-compile_et">compile_et</primary>
173          </indexterm>
174        </listitem>
175      </varlistentry>
176
177      <varlistentry id="debugfs">
178        <term><command>debugfs</command></term>
179        <listitem>
180          <para>A file system debugger; it can be used to examine and change
181          the state of an <systemitem class="filesystem">ext2</systemitem>
182          file system</para>
183          <indexterm zone="ch-system-e2fsprogs debugfs">
184            <primary sortas="b-debugfs">debugfs</primary>
185          </indexterm>
186        </listitem>
187      </varlistentry>
188
189      <varlistentry id="dumpe2fs">
190        <term><command>dumpe2fs</command></term>
191        <listitem>
192          <para>Prints the super block and blocks group information for the
193          file system present on a given device</para>
194          <indexterm zone="ch-system-e2fsprogs dumpe2fs">
195            <primary sortas="b-dumpe2fs">dumpe2fs</primary>
196          </indexterm>
197        </listitem>
198      </varlistentry>
199
200      <varlistentry id="e2fsck">
201        <term><command>e2fsck</command></term>
202        <listitem>
203          <para>Is used to check, and optionally repair <systemitem
204          class="filesystem">ext2</systemitem> file systems and <systemitem
205          class="filesystem">ext3</systemitem> file systems</para>
206          <indexterm zone="ch-system-e2fsprogs e2fsck">
207            <primary sortas="b-e2fsck">e2fsck</primary>
208          </indexterm>
209        </listitem>
210      </varlistentry>
211
212      <varlistentry id="e2image">
213        <term><command>e2image</command></term>
214        <listitem>
215          <para>Is used to save critical <systemitem
216          class="filesystem">ext2</systemitem> file system data to a file</para>
217          <indexterm zone="ch-system-e2fsprogs e2image">
218            <primary sortas="b-e2image">e2image</primary>
219          </indexterm>
220        </listitem>
221      </varlistentry>
222
223      <varlistentry id="e2label">
224        <term><command>e2label</command></term>
225        <listitem>
226          <para>Displays or changes the file system label on the <systemitem
227          class="filesystem">ext2</systemitem> file system present on a given
228          device</para>
229          <indexterm zone="ch-system-e2fsprogs e2label">
230            <primary sortas="b-e2label">e2label</primary>
231          </indexterm>
232        </listitem>
233      </varlistentry>
234
235      <varlistentry id="filefrag">
236        <term><command>filefrag</command></term>
237        <listitem>
238          <para>Reports on how badly fragmented a particular file might be</para>
239          <indexterm zone="ch-system-e2fsprogs filefrag">
240            <primary sortas="b-filefrag">filefrag</primary>
241          </indexterm>
242        </listitem>
243      </varlistentry>
244
245      <varlistentry id="findfs">
246        <term><command>findfs</command></term>
247        <listitem>
248          <para>Finds a file system by label or Universally Unique Identifier
249          (UUID)</para>
250          <indexterm zone="ch-system-e2fsprogs findfs">
251            <primary sortas="b-findfs">findfs</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="logsave">
279        <term><command>logsave</command></term>
280        <listitem>
281          <para>Saves the output of a command in a log file</para>
282          <indexterm zone="ch-system-e2fsprogs logsave">
283            <primary sortas="b-logsave">logsave</primary>
284          </indexterm>
285        </listitem>
286      </varlistentry>
287
288      <varlistentry id="lsattr">
289        <term><command>lsattr</command></term>
290        <listitem>
291          <para>Lists the attributes of files on a second extended file
292          system</para>
293          <indexterm zone="ch-system-e2fsprogs lsattr">
294            <primary sortas="b-lsattr">lsattr</primary>
295          </indexterm>
296        </listitem>
297      </varlistentry>
298
299      <varlistentry id="mk_cmds">
300        <term><command>mk_cmds</command></term>
301        <listitem>
302          <para>Converts a table of command names and help messages into a C
303          source file suitable for use with the <filename
304          class="libraryfile">libss</filename> subsystem library</para>
305          <indexterm zone="ch-system-e2fsprogs mk_cmds">
306            <primary sortas="b-mk_cmds">mk_cmds</primary>
307          </indexterm>
308        </listitem>
309      </varlistentry>
310
311      <varlistentry id="mke2fs">
312        <term><command>mke2fs</command></term>
313        <listitem>
314          <para>Creates an <systemitem class="filesystem">ext2</systemitem>
315          or <systemitem class="filesystem">ext3</systemitem> file system on
316          the given device</para>
317          <indexterm zone="ch-system-e2fsprogs mke2fs">
318            <primary sortas="b-mke2fs">mke2fs</primary>
319          </indexterm>
320        </listitem>
321      </varlistentry>
322
323      <varlistentry id="mkfs.ext2">
324        <term><command>mkfs.ext2</command></term>
325        <listitem>
326          <para>By default creates <systemitem class="filesystem">ext2</systemitem>
327          file systems</para>
328          <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
329            <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
330          </indexterm>
331        </listitem>
332      </varlistentry>
333
334      <varlistentry id="mkfs.ext3">
335        <term><command>mkfs.ext3</command></term>
336        <listitem>
337          <para>By default creates <systemitem class="filesystem">ext3</systemitem>
338          file systems</para>
339          <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
340            <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
341          </indexterm>
342        </listitem>
343      </varlistentry>
344
345      <varlistentry id="mklost-found">
346        <term><command>mklost+found</command></term>
347        <listitem>
348          <para>Used to create a <filename class="directory">lost+found</filename>
349          directory on an <systemitem class="filesystem">ext2</systemitem> file
350          system; it pre-allocates disk blocks to this directory to lighten the
351          task of <command>e2fsck</command></para>
352          <indexterm zone="ch-system-e2fsprogs mklost-found">
353            <primary sortas="b-mklost+found">mklost+found</primary>
354          </indexterm>
355        </listitem>
356      </varlistentry>
357
358      <varlistentry id="resize2fs">
359        <term><command>resize2fs</command></term>
360        <listitem>
361          <para>Can be used to enlarge or shrink an <systemitem
362          class="filesystem">ext2</systemitem> file system</para>
363          <indexterm zone="ch-system-e2fsprogs resize2fs">
364            <primary sortas="b-resize2fs">resize2fs</primary>
365          </indexterm>
366        </listitem>
367      </varlistentry>
368
369      <varlistentry id="tune2fs">
370        <term><command>tune2fs</command></term>
371        <listitem>
372          <para>Adjusts tunable file system parameters on an <systemitem
373          class="filesystem">ext2</systemitem> file system</para>
374          <indexterm zone="ch-system-e2fsprogs tune2fs">
375            <primary sortas="b-tune2fs">tune2fs</primary>
376          </indexterm>
377        </listitem>
378      </varlistentry>
379
380      <varlistentry id="libcom_err">
381        <term><filename class="libraryfile">libcom_err</filename></term>
382        <listitem>
383          <para>The common error display routine</para>
384          <indexterm zone="ch-system-e2fsprogs libcom_err">
385            <primary sortas="c-libcom_err">libcom_err</primary>
386          </indexterm>
387        </listitem>
388      </varlistentry>
389
390      <varlistentry id="libe2p">
391        <term><filename class="libraryfile">libe2p</filename></term>
392        <listitem>
393          <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
394          and <command>lsattr</command></para>
395          <indexterm zone="ch-system-e2fsprogs libe2p">
396            <primary sortas="c-libe2p">libe2p</primary>
397          </indexterm>
398        </listitem>
399      </varlistentry>
400
401      <varlistentry id="libext2fs">
402        <term><filename class="libraryfile">libext2fs</filename></term>
403        <listitem>
404          <para>Contains routines to enable user-level programs to manipulate an
405          <systemitem class="filesystem">ext2</systemitem> file system</para>
406          <indexterm zone="ch-system-e2fsprogs libext2fs">
407            <primary sortas="c-libext2fs">libext2fs</primary>
408          </indexterm>
409        </listitem>
410      </varlistentry>
411
412      <varlistentry id="libss">
413        <term><filename class="libraryfile">libss</filename></term>
414        <listitem>
415          <para>Used by <command>debugfs</command></para>
416          <indexterm zone="ch-system-e2fsprogs libss">
417            <primary sortas="c-libss">libss</primary>
418          </indexterm>
419        </listitem>
420      </varlistentry>
421
422    </variablelist>
423
424  </sect2>
425
426</sect1>
Note: See TracBrowser for help on using the repository browser.