source: chapter06/e2fsprogs.xml@ 2c5ca04

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 11.2 11.2-rc1 11.3 11.3-rc1 12.0 12.0-rc1 12.1 12.1-rc1 7.5 7.6 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 arm bdubbs/gcc13 ml-11.0 multilib renodr/libudev-from-systemd s6-init trunk xry111/arm64 xry111/arm64-12.0 xry111/clfs-ng xry111/lfs-next xry111/loongarch xry111/loongarch-12.0 xry111/loongarch-12.1 xry111/mips64el xry111/pip3 xry111/rust-wip-20221008 xry111/update-glibc
Last change on this file since 2c5ca04 was 2c5ca04, checked in by Bruce Dubbs <bdubbs@…>, 10 years ago

Fix e2fsprogs tests to run properly in the LFS chroot envirnment.
Remove unnecessary mkdir in groff.

git-svn-id: ​http://svn.linuxfromscratch.org/LFS/trunk/BOOK@10455 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689
  • Property mode set to 100644
File size: 21.1 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>First fix a problem with running regression tests in the LFS chroot
48 environment:</para>
49
50<screen><userinput remap="pre">sed -i -e 's|^LD_LIBRARY_PATH.*|&amp;:/tools/lib|' tests/test_config</userinput></screen>
51
52 <para>The E2fsprogs documentation recommends that the package be built in
53 a subdirectory of the source tree: </para>
54
55<screen><userinput remap="pre">mkdir -v build
56cd build</userinput></screen>
57
58 <para>Prepare E2fsprogs for compilation:</para>
59
60<screen><userinput remap="configure">LIBS=-L/tools/lib \
61CFLAGS=-I/tools/include \
62PKG_CONFIG_PATH=/tools/lib/pkgconfig \
63../configure --prefix=/usr \
64 --with-root-prefix="" \
65 --enable-elf-shlibs \
66 --disable-libblkid \
67 --disable-libuuid \
68 --disable-uuidd \
69 --disable-fsck</userinput></screen>
70
71 <variablelist>
72 <title>The meaning of the environment variable and configure options:</title>
73
74 <varlistentry>
75 <term><parameter>PKG_CONFIG_PATH, LIBS, CFLAGS</parameter></term>
76 <listitem>
77 <para>These variables enable e2fsprogs to be built using the
78 <xref linkend="ch-tools-util-linux"/> package built earlier.</para>
79 </listitem>
80 </varlistentry>
81
82 <varlistentry>
83 <term><parameter>--with-root-prefix=""</parameter></term>
84 <listitem>
85 <para>Certain programs (such as the <command>e2fsck</command>
86 program) are considered essential programs. When, for example,
87 <filename class="directory">/usr</filename> is not mounted, these
88 programs still need to be available. They belong in directories
89 like <filename class="directory">/lib</filename> and <filename
90 class="directory">/sbin</filename>. If this option is not passed
91 to E2fsprogs' configure, the programs are installed into the
92 <filename class="directory">/usr</filename> directory.</para>
93 </listitem>
94 </varlistentry>
95
96 <varlistentry>
97 <term><parameter>--enable-elf-shlibs</parameter></term>
98 <listitem>
99 <para>This creates the shared libraries which some programs
100 in this package use.</para>
101 </listitem>
102 </varlistentry>
103
104 <varlistentry>
105 <term><parameter>--disable-*</parameter></term>
106 <listitem>
107 <para>This prevents E2fsprogs from building and installing the
108 <systemitem class="library">libuuid</systemitem> and
109 <systemitem class="library">libblkid</systemitem> libraries, the
110 <systemitem class="daemon">uuidd</systemitem> daemon, and the
111 <command>fsck</command> wrapper, as Util-Linux installed all of
112 them earlier.</para>
113 </listitem>
114 </varlistentry>
115
116 </variablelist>
117
118 <para>Compile the package:</para>
119
120<screen><userinput remap="make">make</userinput></screen>
121
122 <para>To test the results, issue:</para>
123
124<screen><userinput remap="test">make check</userinput></screen>
125
126 <para>One of the E2fsprogs tests will attempt to allocate 256 MB of memory.
127 If you do not have significantly more RAM than this, be sure to enable
128 sufficient swap space for the test. See <xref
129 linkend="space-creatingfilesystem"/> and <xref linkend="space-mounting"/>
130 for details on creating and enabling swap space. Additionally,
131 three tests try to allocate a two terabyte partition and will fail
132 unless you have at least that much unused disk space available.</para>
133
134 <para>Install the binaries, documentation, and shared libraries:</para>
135
136<screen><userinput remap="install">make install</userinput></screen>
137
138 <para>Install the static libraries:</para>
139
140<screen><userinput remap="install">make install-libs</userinput></screen>
141
142 <para>Make the installed static libraries writable so debugging symbols can
143 be removed later:</para>
144
145<screen><userinput remap="install">chmod -v u+w /usr/lib/{libcom_err,libe2p,libext2fs,libss}.a</userinput></screen>
146
147 <para>This package installs a gzipped
148 <filename class="extension">.info</filename> file but doesn't update the
149 system-wide <filename>dir</filename> file. Unzip this file and then update
150 the system <filename>dir</filename> file using the following
151 commands.</para>
152
153<screen><userinput remap="install">gunzip -v /usr/share/info/libext2fs.info.gz
154install-info --dir-file=/usr/share/info/dir /usr/share/info/libext2fs.info</userinput></screen>
155
156 <para>If desired, create and install some additional documentation by
157 issuing the following commands:</para>
158
159<screen><userinput remap="install">makeinfo -o doc/com_err.info ../lib/et/com_err.texinfo
160install -v -m644 doc/com_err.info /usr/share/info
161install-info --dir-file=/usr/share/info/dir /usr/share/info/com_err.info</userinput></screen>
162 </sect2>
163
164 <sect2 id="contents-e2fsprogs" role="content">
165 <title>Contents of E2fsprogs</title>
166
167 <segmentedlist>
168 <segtitle>Installed programs</segtitle>
169 <segtitle>Installed libraries</segtitle>
170 <segtitle>Installed directory</segtitle>
171
172 <seglistitem>
173 <seg>badblocks, chattr, compile_et, debugfs, dumpe2fs,e2freefrag,
174 e2fsck, e2image, e2label, e2undo, e4defrag, filefrag, fsck.ext2,
175 fsck.ext3, fsck.ext4, fsck.ext4dev, logsave, lsattr, mk_cmds, mke2fs,
176 mkfs.ext2, mkfs.ext3, mkfs.ext4, mkfs.ext4dev,
177 resize2fs, and tune2fs</seg>
178 <seg>libcom_err.{a,so}, libe2p.{a,so}, libext2fs.{a,so},
179 libquota.a, and libss.{a,so}</seg>
180 <seg>/usr/include/e2p, /usr/include/et, /usr/include/ext2fs,
181 /usr/include/quota, /usr/include/ss, /usr/share/et, /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. This 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. This 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. This 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. This 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. This 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. This 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. This 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. This 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="libquota">
529 <term><filename class="libraryfile">libquota</filename></term>
530 <listitem>
531 <para>Provides an interface for creating and updating quota files
532 and ext4 superblock fields</para>
533 <indexterm zone="ch-system-e2fsprogs libquota">
534 <primary sortas="c-libquota">libquota</primary>
535 </indexterm>
536 </listitem>
537 </varlistentry>
538
539 <varlistentry id="libss">
540 <term><filename class="libraryfile">libss</filename></term>
541 <listitem>
542 <para>Used by <command>debugfs</command></para>
543 <indexterm zone="ch-system-e2fsprogs libss">
544 <primary sortas="c-libss">libss</primary>
545 </indexterm>
546 </listitem>
547 </varlistentry>
548
549 </variablelist>
550
551 </sect2>
552
553</sect1>
Note: See TracBrowser for help on using the repository browser.