source: clfs-sysroot/BOOK/final-system/common/e2fsprogs.xml @ 755f44a

Last change on this file since 755f44a was 755f44a, checked in by Joe Ciccone <jciccone@…>, 13 years ago

LFS to CLFS changes.

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