source: chapter06/e2fsprogs.xml@ 8054162

10.0 10.0-rc1 10.1 10.1-rc1 11.0 11.0-rc1 11.0-rc2 11.0-rc3 11.1 11.1-rc1 8.3 8.3-rc1 8.3-rc2 8.4 8.4-rc1 9.0 9.0-rc1 9.1 9.1-rc1 arm cross-chap5 ml-11.0 multilib old-trunk trunk xry111/clfs-ng xry111/git-transition xry111/glibc-2.34 xry111/lfs-next xry111/tester-nohack xry111/usr-move
Last change on this file since 8054162 was 8054162, checked in by Bruce Dubbs <bdubbs@…>, 4 years ago

Make symbolic links in inital part of Chapter 6 consistent
for all versions of the book. Allows removing environment
variables no longer needed with e2fsprogs.

git-svn-id: http://svn.linuxfromscratch.org/LFS/trunk/BOOK@11432 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689

  • Property mode set to 100644
File size: 20.7 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 <sect1info condition="script">
12 <productname>e2fsprogs</productname>
13 <productnumber>&e2fsprogs-version;</productnumber>
14 <address>&e2fsprogs-url;</address>
15 </sect1info>
16
17 <title>E2fsprogs-&e2fsprogs-version;</title>
18
19 <indexterm zone="ch-system-e2fsprogs">
20 <primary sortas="a-E2fsprogs">E2fsprogs</primary>
21 </indexterm>
22
23 <sect2 role="package">
24 <title/>
25
26 <para>The E2fsprogs package contains the utilities for handling the
27 <systemitem class="filesystem">ext2</systemitem> file system. It also
28 supports the <systemitem class="filesystem">ext3</systemitem> and
29 <systemitem class="filesystem">ext4</systemitem> journaling
30 file systems.</para>
31
32 <segmentedlist>
33 <segtitle>&buildtime;</segtitle>
34 <segtitle>&diskspace;</segtitle>
35
36 <seglistitem>
37 <seg>&e2fsprogs-ch6-sbu;</seg>
38 <seg>&e2fsprogs-ch6-du;</seg>
39 </seglistitem>
40 </segmentedlist>
41
42 </sect2>
43
44 <sect2 role="installation">
45 <title>Installation of E2fsprogs</title>
46
47 <para>The E2fsprogs documentation recommends that the package be built in
48 a subdirectory of the source tree: </para>
49
50<screen><userinput remap="pre">mkdir -v build
51cd build</userinput></screen>
52
53 <para>Prepare E2fsprogs for compilation:</para>
54
55<!--<screen><userinput remap="configure">LIBS=-L/tools/lib \
56CFLAGS=-I/tools/include \
57CFLAGS=-I/tools/include \
58PKG_CONFIG_PATH=/tools/lib/pkgconfig \
59../configure - -prefix=/usr \-->
60<screen><userinput remap="configure">../configure --prefix=/usr \
61 --bindir=/bin \
62 --with-root-prefix="" \
63 --enable-elf-shlibs \
64 --disable-libblkid \
65 --disable-libuuid \
66 --disable-uuidd \
67 --disable-fsck</userinput></screen>
68
69 <variablelist>
70 <title>The meaning of the environment variable and configure options:</title>
71<!--
72 <varlistentry>
73 <term><parameter>PKG_CONFIG_PATH, LIBS, CFLAGS</parameter></term>
74 <listitem>
75 <para>These variables enable e2fsprogs to be built using the
76 <xref linkend="ch-tools-util-linux"/> package built earlier.</para>
77 </listitem>
78 </varlistentry>
79-->
80 <varlistentry>
81 <term><parameter>--with-root-prefix=""</parameter> and
82 <parameter>--bindir=/bin</parameter></term>
83 <listitem>
84 <para>Certain programs (such as the <command>e2fsck</command>
85 program) are considered essential programs. When, for example,
86 <filename class="directory">/usr</filename> is not mounted, these
87 programs still need to be available. They belong in directories
88 like <filename class="directory">/lib</filename> and <filename
89 class="directory">/sbin</filename>. If this option is not passed
90 to E2fsprogs' configure, the programs are installed into the
91 <filename class="directory">/usr</filename> directory.</para>
92 </listitem>
93 </varlistentry>
94
95 <varlistentry>
96 <term><parameter>--enable-elf-shlibs</parameter></term>
97 <listitem>
98 <para>This creates the shared libraries which some programs
99 in this package use.</para>
100 </listitem>
101 </varlistentry>
102
103 <varlistentry>
104 <term><parameter>--disable-*</parameter></term>
105 <listitem>
106 <para>This prevents E2fsprogs from building and installing the
107 <systemitem class="library">libuuid</systemitem> and
108 <systemitem class="library">libblkid</systemitem> libraries, the
109 <systemitem class="daemon">uuidd</systemitem> daemon, and the
110 <command>fsck</command> wrapper, as Util-Linux installs more
111 recent versions.</para>
112 </listitem>
113 </varlistentry>
114
115 </variablelist>
116
117 <para>Compile the package:</para>
118
119<screen><userinput remap="make">make</userinput></screen>
120
121 <para>To set up and run the test suite we need to first link some
122 libraries from /tools/lib to a location where the test programs look.
123 To run the tests, issue:</para>
124
125<screen><userinput remap="test">ln -sfv /tools/lib/lib{blk,uu}id.so.1 lib
126make LD_LIBRARY_PATH=/tools/lib check</userinput></screen>
127
128 <para>One of the E2fsprogs tests will attempt to allocate 256 MB of memory.
129 If you do not have significantly more RAM than this, be sure to enable
130 sufficient swap space for the test. See <xref
131 linkend="space-creatingfilesystem"/> and <xref linkend="space-mounting"/>
132 for details on creating and enabling swap space. Two tests, f_bigalloc_badinode
133 and f_bigalloc_orphan_list, are known ot fail.</para>
134
135 <para>Install the binaries, documentation, and shared libraries:</para>
136
137<screen><userinput remap="install">make install</userinput></screen>
138
139 <para>Install the static libraries and headers:</para>
140
141<screen><userinput remap="install">make install-libs</userinput></screen>
142
143 <para>Make the installed static libraries writable so debugging symbols can
144 be removed later:</para>
145
146<screen><userinput remap="install">chmod -v u+w /usr/lib/{libcom_err,libe2p,libext2fs,libss}.a</userinput></screen>
147
148 <para>This package installs a gzipped
149 <filename class="extension">.info</filename> file but doesn't update the
150 system-wide <filename>dir</filename> file. Unzip this file and then update
151 the system <filename>dir</filename> file using the following
152 commands:</para>
153
154<screen><userinput remap="install">gunzip -v /usr/share/info/libext2fs.info.gz
155install-info --dir-file=/usr/share/info/dir /usr/share/info/libext2fs.info</userinput></screen>
156
157 <para>If desired, create and install some additional documentation by
158 issuing the following commands:</para>
159
160<screen><userinput remap="install">makeinfo -o doc/com_err.info ../lib/et/com_err.texinfo
161install -v -m644 doc/com_err.info /usr/share/info
162install-info --dir-file=/usr/share/info/dir /usr/share/info/com_err.info</userinput></screen>
163 </sect2>
164
165 <sect2 id="contents-e2fsprogs" role="content">
166 <title>Contents of E2fsprogs</title>
167
168 <segmentedlist>
169 <segtitle>Installed programs</segtitle>
170 <segtitle>Installed libraries</segtitle>
171 <segtitle>Installed directories</segtitle>
172
173 <seglistitem>
174 <seg>badblocks, chattr, compile_et, debugfs, dumpe2fs,e2freefrag,
175 e2fsck, e2image, e2label, e2undo, e4defrag, filefrag, fsck.ext2,
176 fsck.ext3, fsck.ext4, fsck.ext4dev, logsave, lsattr, mk_cmds, mke2fs,
177 mkfs.ext2, mkfs.ext3, mkfs.ext4, mkfs.ext4dev, mklost+found,
178 resize2fs, and tune2fs</seg>
179 <seg>libcom_err.so, libe2p.so, libext2fs.so, and libss.so</seg>
180 <seg>/usr/include/e2p, /usr/include/et, /usr/include/ext2fs,
181 /usr/include/ss, /usr/share/et, and /usr/share/ss</seg>
182 </seglistitem>
183 </segmentedlist>
184
185 <variablelist>
186 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
187 <?dbfo list-presentation="list"?>
188 <?dbhtml list-presentation="table"?>
189
190 <varlistentry id="badblocks">
191 <term><command>badblocks</command></term>
192 <listitem>
193 <para>Searches a device (usually a disk partition) for bad
194 blocks</para>
195 <indexterm zone="ch-system-e2fsprogs badblocks">
196 <primary sortas="b-badblocks">badblocks</primary>
197 </indexterm>
198 </listitem>
199 </varlistentry>
200
201 <varlistentry id="chattr">
202 <term><command>chattr</command></term>
203 <listitem>
204 <para>Changes the attributes of files on an <systemitem
205 class="filesystem">ext2</systemitem> file system; it also
206 changes <systemitem class="filesystem">ext3</systemitem>
207 file systems, the journaling version of <systemitem
208 class="filesystem">ext2</systemitem> file systems</para>
209 <indexterm zone="ch-system-e2fsprogs chattr">
210 <primary sortas="b-chattr">chattr</primary>
211 </indexterm>
212 </listitem>
213 </varlistentry>
214
215 <varlistentry id="compile_et">
216 <term><command>compile_et</command></term>
217 <listitem>
218 <para>An error table compiler; it converts a table of error-code
219 names and messages into a C source file suitable for use with the
220 <filename class="libraryfile">com_err</filename> library</para>
221 <indexterm zone="ch-system-e2fsprogs compile_et">
222 <primary sortas="b-compile_et">compile_et</primary>
223 </indexterm>
224 </listitem>
225 </varlistentry>
226
227 <varlistentry id="debugfs">
228 <term><command>debugfs</command></term>
229 <listitem>
230 <para>A file system debugger; it can be used to examine and change
231 the state of an <systemitem class="filesystem">ext2</systemitem>
232 file system</para>
233 <indexterm zone="ch-system-e2fsprogs debugfs">
234 <primary sortas="b-debugfs">debugfs</primary>
235 </indexterm>
236 </listitem>
237 </varlistentry>
238
239 <varlistentry id="dumpe2fs">
240 <term><command>dumpe2fs</command></term>
241 <listitem>
242 <para>Prints the super block and blocks group information for the
243 file system present on a given device</para>
244 <indexterm zone="ch-system-e2fsprogs dumpe2fs">
245 <primary sortas="b-dumpe2fs">dumpe2fs</primary>
246 </indexterm>
247 </listitem>
248 </varlistentry>
249
250 <varlistentry id="e2freefrag">
251 <term><command>e2freefrag</command></term>
252 <listitem>
253 <para>Reports free space fragmentation information</para>
254 <indexterm zone="ch-system-e2fsprogs e2freefrag">
255 <primary sortas="b-e2freefrag">e2freefrag</primary>
256 </indexterm>
257 </listitem>
258 </varlistentry>
259
260 <varlistentry id="e2fsck">
261 <term><command>e2fsck</command></term>
262 <listitem>
263 <para>Is used to check, and optionally repair <systemitem
264 class="filesystem">ext2</systemitem> file systems and <systemitem
265 class="filesystem">ext3</systemitem> file systems</para>
266 <indexterm zone="ch-system-e2fsprogs e2fsck">
267 <primary sortas="b-e2fsck">e2fsck</primary>
268 </indexterm>
269 </listitem>
270 </varlistentry>
271
272 <varlistentry id="e2image">
273 <term><command>e2image</command></term>
274 <listitem>
275 <para>Is used to save critical <systemitem
276 class="filesystem">ext2</systemitem> file system data to a file</para>
277 <indexterm zone="ch-system-e2fsprogs e2image">
278 <primary sortas="b-e2image">e2image</primary>
279 </indexterm>
280 </listitem>
281 </varlistentry>
282
283 <varlistentry id="e2label">
284 <term><command>e2label</command></term>
285 <listitem>
286 <para>Displays or changes the file system label on the <systemitem
287 class="filesystem">ext2</systemitem> file system present on a given
288 device</para>
289 <indexterm zone="ch-system-e2fsprogs e2label">
290 <primary sortas="b-e2label">e2label</primary>
291 </indexterm>
292 </listitem>
293 </varlistentry>
294
295 <varlistentry id="e2undo">
296 <term><command>e2undo</command></term>
297 <listitem>
298 <para>Replays the undo log undo_log for an ext2/ext3/ext4 filesystem
299 found on a device [This can be used to undo a failed operation by an
300 e2fsprogs program.]</para>
301 <indexterm zone="ch-system-e2fsprogs e2undo">
302 <primary sortas="b-e2undo">e2undo</primary>
303 </indexterm>
304 </listitem>
305 </varlistentry>
306
307 <varlistentry id="e4defrag">
308 <term><command>e4defrag</command></term>
309 <listitem>
310 <para>Online defragmenter for ext4 filesystems</para>
311 <indexterm zone="ch-system-e2fsprogs e4defrag">
312 <primary sortas="b-e4defrag">e4defrag</primary>
313 </indexterm>
314 </listitem>
315 </varlistentry>
316
317 <varlistentry id="filefrag">
318 <term><command>filefrag</command></term>
319 <listitem>
320 <para>Reports on how badly fragmented a particular file might be</para>
321 <indexterm zone="ch-system-e2fsprogs filefrag">
322 <primary sortas="b-filefrag">filefrag</primary>
323 </indexterm>
324 </listitem>
325 </varlistentry>
326
327 <varlistentry id="fsck.ext2">
328 <term><command>fsck.ext2</command></term>
329 <listitem>
330 <para>By default checks <systemitem class="filesystem">ext2</systemitem>
331 file systems and is a hard link to <command>e2fsck</command></para>
332 <indexterm zone="ch-system-e2fsprogs fsck.ext2">
333 <primary sortas="b-fsck.ext2">fsck.ext2</primary>
334 </indexterm>
335 </listitem>
336 </varlistentry>
337
338 <varlistentry id="fsck.ext3">
339 <term><command>fsck.ext3</command></term>
340 <listitem>
341 <para>By default checks <systemitem class="filesystem">ext3</systemitem>
342 file systems and is a hard link to <command>e2fsck</command></para>
343 <indexterm zone="ch-system-e2fsprogs fsck.ext3">
344 <primary sortas="b-fsck.ext3">fsck.ext3</primary>
345 </indexterm>
346 </listitem>
347 </varlistentry>
348
349 <varlistentry id="fsck.ext4">
350 <term><command>fsck.ext4</command></term>
351 <listitem>
352 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
353 file systems and is a hard link to <command>e2fsck</command></para>
354 <indexterm zone="ch-system-e2fsprogs fsck.ext4">
355 <primary sortas="b-fsck.ext4">fsck.ext4</primary>
356 </indexterm>
357 </listitem>
358 </varlistentry>
359
360 <varlistentry id="fsck.ext4dev">
361 <term><command>fsck.ext4dev</command></term>
362 <listitem>
363 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
364 development file systems and is a hard link to
365 <command>e2fsck</command></para>
366 <indexterm zone="ch-system-e2fsprogs fsck.ext4dev">
367 <primary sortas="b-fsck.ext4dev">fsck.ext4dev</primary>
368 </indexterm>
369 </listitem>
370 </varlistentry>
371
372 <varlistentry id="logsave">
373 <term><command>logsave</command></term>
374 <listitem>
375 <para>Saves the output of a command in a log file</para>
376 <indexterm zone="ch-system-e2fsprogs logsave">
377 <primary sortas="b-logsave">logsave</primary>
378 </indexterm>
379 </listitem>
380 </varlistentry>
381
382 <varlistentry id="lsattr">
383 <term><command>lsattr</command></term>
384 <listitem>
385 <para>Lists the attributes of files on a second extended file
386 system</para>
387 <indexterm zone="ch-system-e2fsprogs lsattr">
388 <primary sortas="b-lsattr">lsattr</primary>
389 </indexterm>
390 </listitem>
391 </varlistentry>
392
393 <varlistentry id="mk_cmds">
394 <term><command>mk_cmds</command></term>
395 <listitem>
396 <para>Converts a table of command names and help messages into a C
397 source file suitable for use with the <filename
398 class="libraryfile">libss</filename> subsystem library</para>
399 <indexterm zone="ch-system-e2fsprogs mk_cmds">
400 <primary sortas="b-mk_cmds">mk_cmds</primary>
401 </indexterm>
402 </listitem>
403 </varlistentry>
404
405 <varlistentry id="mke2fs">
406 <term><command>mke2fs</command></term>
407 <listitem>
408 <para>Creates an <systemitem class="filesystem">ext2</systemitem>
409 or <systemitem class="filesystem">ext3</systemitem> file system on
410 the given device</para>
411 <indexterm zone="ch-system-e2fsprogs mke2fs">
412 <primary sortas="b-mke2fs">mke2fs</primary>
413 </indexterm>
414 </listitem>
415 </varlistentry>
416
417 <varlistentry id="mkfs.ext2">
418 <term><command>mkfs.ext2</command></term>
419 <listitem>
420 <para>By default creates <systemitem class="filesystem">ext2</systemitem>
421 file systems and is a hard link to <command>mke2fs</command></para>
422 <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
423 <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
424 </indexterm>
425 </listitem>
426 </varlistentry>
427
428 <varlistentry id="mkfs.ext3">
429 <term><command>mkfs.ext3</command></term>
430 <listitem>
431 <para>By default creates <systemitem class="filesystem">ext3</systemitem>
432 file systems and is a hard link to <command>mke2fs</command></para>
433 <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
434 <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
435 </indexterm>
436 </listitem>
437 </varlistentry>
438
439 <varlistentry id="mkfs.ext4">
440 <term><command>mkfs.ext4</command></term>
441 <listitem>
442 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
443 file systems and is a hard link to <command>mke2fs</command></para>
444 <indexterm zone="ch-system-e2fsprogs mkfs.ext4">
445 <primary sortas="b-mkfs.ext4">mkfs.ext4</primary>
446 </indexterm>
447 </listitem>
448 </varlistentry>
449
450 <varlistentry id="mkfs.ext4dev">
451 <term><command>mkfs.ext4dev</command></term>
452 <listitem>
453 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
454 development file systems and is a hard link to <command>mke2fs</command></para>
455 <indexterm zone="ch-system-e2fsprogs mkfs.ext4dev">
456 <primary sortas="b-mkfs.ext4dev">mkfs.ext4dev</primary>
457 </indexterm>
458 </listitem>
459 </varlistentry>
460
461 <varlistentry id="mklost-found">
462 <term><command>mklost+found</command></term>
463 <listitem>
464 <para>Used to create a <filename class="directory">lost+found</filename>
465 directory on an <systemitem class="filesystem">ext2</systemitem> file
466 system; it pre-allocates disk blocks to this directory to lighten the
467 task of <command>e2fsck</command></para>
468 <indexterm zone="ch-system-e2fsprogs mklost-found">
469 <primary sortas="b-mklost+found">mklost+found</primary>
470 </indexterm>
471 </listitem>
472 </varlistentry>
473
474 <varlistentry id="resize2fs">
475 <term><command>resize2fs</command></term>
476 <listitem>
477 <para>Can be used to enlarge or shrink an <systemitem
478 class="filesystem">ext2</systemitem> file system</para>
479 <indexterm zone="ch-system-e2fsprogs resize2fs">
480 <primary sortas="b-resize2fs">resize2fs</primary>
481 </indexterm>
482 </listitem>
483 </varlistentry>
484
485 <varlistentry id="tune2fs">
486 <term><command>tune2fs</command></term>
487 <listitem>
488 <para>Adjusts tunable file system parameters on an <systemitem
489 class="filesystem">ext2</systemitem> file system</para>
490 <indexterm zone="ch-system-e2fsprogs tune2fs">
491 <primary sortas="b-tune2fs">tune2fs</primary>
492 </indexterm>
493 </listitem>
494 </varlistentry>
495
496 <varlistentry id="libcom_err">
497 <term><filename class="libraryfile">libcom_err</filename></term>
498 <listitem>
499 <para>The common error display routine</para>
500 <indexterm zone="ch-system-e2fsprogs libcom_err">
501 <primary sortas="c-libcom_err">libcom_err</primary>
502 </indexterm>
503 </listitem>
504 </varlistentry>
505
506 <varlistentry id="libe2p">
507 <term><filename class="libraryfile">libe2p</filename></term>
508 <listitem>
509 <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
510 and <command>lsattr</command></para>
511 <indexterm zone="ch-system-e2fsprogs libe2p">
512 <primary sortas="c-libe2p">libe2p</primary>
513 </indexterm>
514 </listitem>
515 </varlistentry>
516
517 <varlistentry id="libext2fs">
518 <term><filename class="libraryfile">libext2fs</filename></term>
519 <listitem>
520 <para>Contains routines to enable user-level programs to manipulate an
521 <systemitem class="filesystem">ext2</systemitem> file system</para>
522 <indexterm zone="ch-system-e2fsprogs libext2fs">
523 <primary sortas="c-libext2fs">libext2fs</primary>
524 </indexterm>
525 </listitem>
526 </varlistentry>
527
528 <varlistentry id="libss">
529 <term><filename class="libraryfile">libss</filename></term>
530 <listitem>
531 <para>Used by <command>debugfs</command></para>
532 <indexterm zone="ch-system-e2fsprogs libss">
533 <primary sortas="c-libss">libss</primary>
534 </indexterm>
535 </listitem>
536 </varlistentry>
537
538 </variablelist>
539
540 </sect2>
541
542</sect1>
Note: See TracBrowser for help on using the repository browser.