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

Last change on this file since 008ad92 was 021d0cc, checked in by Joe Ciccone <jciccone@…>, 16 years ago

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