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

clfs-1.2clfs-2.1clfs-3.0.0-systemdclfs-3.0.0-sysvinitsystemdsysvinit
Last change on this file since 4996ca05 was 4996ca05, checked in by Joe Ciccone <jciccone@…>, 15 years ago

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