source: clfs-sysroot/BOOK/final-system/common/e2fsprogs.xml @ 79e00fc

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

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