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

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

use the libblkid and libuuid provided by Util-Linux-NG instead of E2fsprogs now.
  • Property mode set to 100644
File size: 17.4 KB
RevLine 
[02095ae]1<?xml version="1.0" encoding="ISO-8859-1"?>
[c439b8a]2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
[02095ae]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
[79e00fc]22 supports the <systemitem class="filesystem">ext3</systemitem> and
23 <systemitem class="filesystem">ext4</systemitem> journaling
24 file systems.</para>
[02095ae]25
26 </sect2>
27
[12e6567]28 &env-target;
29
[02095ae]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
[2a5046a]41<screen os="d"><userinput>PKG_CONFIG=true ../configure --build=${CLFS_HOST} --host=${CLFS_TARGET} \
[cee2ca2]42 --prefix=/usr --with-root-prefix="" \
[2a5046a]43 --enable-elf-shlibs --disable-libblkid \
44 --disable-libuuid --disable-fsck --disable-uuidd</userinput></screen>
[02095ae]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
[755f44a]77 of a base CLFS system, so the plugin is not required. See the EVMS
[02095ae]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
[c413747]89 <para os="h">Install the binaries, documentation, and shared libraries:</para>
[02095ae]90
[586feb7]91<screen os="i"><userinput>make DESTDIR=${CLFS} install</userinput></screen>
[02095ae]92
[c413747]93 <para os="j">Install the static libraries and headers:</para>
[02095ae]94
[586feb7]95<screen os="k"><userinput>make DESTDIR=${CLFS} install-libs</userinput></screen>
[02095ae]96
[021d0cc]97 <para os="l">Remove absolute paths from the link destinations:</para>
98
[2a5046a]99<screen os="m"><userinput>rm -v ${CLFS}/usr/lib/lib{com_err,e2p,ext2fs,ss}.so
[021d0cc]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
[2a5046a]103ln -sv ../../lib/libss.so.2 ${CLFS}/usr/lib/libss.so</userinput></screen>
[021d0cc]104
[02095ae]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,
[82b662d]116 e2fsck, e2image, e2label, filefrag, findfs, fsck, fsck.ext2, fsck.ext3,
[02095ae]117 logsave, lsattr, mk_cmds, mke2fs, mkfs.ext2, mkfs.ext3,
118 mklost+found, resize2fs, tune2fs, and uuidgen.</seg>
[2a5046a]119 <seg>libcom_err.[a,so], libe2p.[a,so],
120 libext2fs.[a,so], and libss.[a,so]</seg>
[02095ae]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
[82b662d]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
[02095ae]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">
257 <term><command>fsck</command></term>
258 <listitem>
259 <para>Is used to check, and optionally repair, file systems</para>
260 <indexterm zone="ch-system-e2fsprogs fsck">
261 <primary sortas="b-fsck">fsck</primary>
262 </indexterm>
263 </listitem>
264 </varlistentry>
265
266 <varlistentry id="fsck.ext2">
267 <term><command>fsck.ext2</command></term>
268 <listitem>
269 <para>By default checks <systemitem class="filesystem">ext2</systemitem>
270 file systems</para>
271 <indexterm zone="ch-system-e2fsprogs fsck.ext2">
272 <primary sortas="b-fsck.ext2">fsck.ext2</primary>
273 </indexterm>
274 </listitem>
275 </varlistentry>
276
277 <varlistentry id="fsck.ext3">
278 <term><command>fsck.ext3</command></term>
279 <listitem>
280 <para>By default checks <systemitem class="filesystem">ext3</systemitem>
281 file systems</para>
282 <indexterm zone="ch-system-e2fsprogs fsck.ext3">
283 <primary sortas="b-fsck.ext3">fsck.ext3</primary>
284 </indexterm>
285 </listitem>
286 </varlistentry>
287
288 <varlistentry id="logsave">
289 <term><command>logsave</command></term>
290 <listitem>
291 <para>Saves the output of a command in a log file</para>
292 <indexterm zone="ch-system-e2fsprogs logsave">
293 <primary sortas="b-logsave">logsave</primary>
294 </indexterm>
295 </listitem>
296 </varlistentry>
297
298 <varlistentry id="lsattr">
299 <term><command>lsattr</command></term>
300 <listitem>
301 <para>Lists the attributes of files on a second extended file
302 system</para>
303 <indexterm zone="ch-system-e2fsprogs lsattr">
304 <primary sortas="b-lsattr">lsattr</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308
309 <varlistentry id="mk_cmds">
310 <term><command>mk_cmds</command></term>
311 <listitem>
312 <para>Converts a table of command names and help messages into a C
313 source file suitable for use with the <filename
314 class="libraryfile">libss</filename> subsystem library</para>
315 <indexterm zone="ch-system-e2fsprogs mk_cmds">
316 <primary sortas="b-mk_cmds">mk_cmds</primary>
317 </indexterm>
318 </listitem>
319 </varlistentry>
320
321 <varlistentry id="mke2fs">
322 <term><command>mke2fs</command></term>
323 <listitem>
324 <para>Creates an <systemitem class="filesystem">ext2</systemitem>
325 or <systemitem class="filesystem">ext3</systemitem> file system on
326 the given device</para>
327 <indexterm zone="ch-system-e2fsprogs mke2fs">
328 <primary sortas="b-mke2fs">mke2fs</primary>
329 </indexterm>
330 </listitem>
331 </varlistentry>
332
333 <varlistentry id="mkfs.ext2">
334 <term><command>mkfs.ext2</command></term>
335 <listitem>
336 <para>By default creates <systemitem class="filesystem">ext2</systemitem>
337 file systems</para>
338 <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
339 <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
340 </indexterm>
341 </listitem>
342 </varlistentry>
343
344 <varlistentry id="mkfs.ext3">
345 <term><command>mkfs.ext3</command></term>
346 <listitem>
347 <para>By default creates <systemitem class="filesystem">ext3</systemitem>
348 file systems</para>
349 <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
350 <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
351 </indexterm>
352 </listitem>
353 </varlistentry>
354
355 <varlistentry id="mklost-found">
356 <term><command>mklost+found</command></term>
357 <listitem>
358 <para>Used to create a <filename class="directory">lost+found</filename>
359 directory on an <systemitem class="filesystem">ext2</systemitem> file
360 system; it pre-allocates disk blocks to this directory to lighten the
361 task of <command>e2fsck</command></para>
362 <indexterm zone="ch-system-e2fsprogs mklost-found">
363 <primary sortas="b-mklost+found">mklost+found</primary>
364 </indexterm>
365 </listitem>
366 </varlistentry>
367
368 <varlistentry id="resize2fs">
369 <term><command>resize2fs</command></term>
370 <listitem>
371 <para>Can be used to enlarge or shrink an <systemitem
372 class="filesystem">ext2</systemitem> file system</para>
373 <indexterm zone="ch-system-e2fsprogs resize2fs">
374 <primary sortas="b-resize2fs">resize2fs</primary>
375 </indexterm>
376 </listitem>
377 </varlistentry>
378
379 <varlistentry id="tune2fs">
380 <term><command>tune2fs</command></term>
381 <listitem>
382 <para>Adjusts tunable file system parameters on an <systemitem
383 class="filesystem">ext2</systemitem> file system</para>
384 <indexterm zone="ch-system-e2fsprogs tune2fs">
385 <primary sortas="b-tune2fs">tune2fs</primary>
386 </indexterm>
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.