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

clfs-1.2 clfs-2.1 clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since 31276bb was 8187b7d, checked in by Chris Staub <chris@…>, 16 years ago

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