source: chapter06/e2fsprogs.xml@ 6c67242

10.0 10.0-rc1 10.1 10.1-rc1 11.0 11.0-rc1 11.0-rc2 11.0-rc3 8.4 8.4-rc1 9.0 9.0-rc1 9.1 9.1-rc1 cross-chap5 ml-11.0 multilib old-trunk trunk xry111/git-transition xry111/glibc-2.34 xry111/tester-nohack xry111/usr-move
Last change on this file since 6c67242 was 6c67242, checked in by Bruce Dubbs <bdubbs@…>, 3 years ago

Clean up of unneeded symbolic links.
Reordered packages so version specific packages are
built as late as possible in Chapter 6. Now building
util-linux in Chapter 5 is unneeded and has been removed.

Update to eudev-3.2.6.
Update to elfutils-0.174 (libelf).
Update to psmisc-23.2.
Update to openssl-1.1.1.
Update to linux-4.18.9.

git-svn-id: http://svn.linuxfromscratch.org/LFS/trunk/BOOK@11472 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
126 <para>To run the tests, issue:</para>
127
128<screen><userinput remap="test">make check</userinput></screen>
129<!--ln -sfv /tools/lib/lib{blk,uu}id.so.1 lib -->
130<!--make LD_LIBRARY_PATH=/tools/lib check</userinput></screen>-->
131
132 <para>One of the E2fsprogs tests will attempt to allocate 256 MB of memory.
133 If you do not have significantly more RAM than this, be sure to enable
134 sufficient swap space for the test. See <xref
135 linkend="space-creatingfilesystem"/> and <xref linkend="space-mounting"/>
136 for details on creating and enabling swap space.</para>
137
138 <para>Install the binaries, documentation, and shared libraries:</para>
139
140<screen><userinput remap="install">make install</userinput></screen>
141
142 <para>Install the static libraries and headers:</para>
143
144<screen><userinput remap="install">make install-libs</userinput></screen>
145
146 <para>Make the installed static libraries writable so debugging symbols can
147 be removed later:</para>
148
149<screen><userinput remap="install">chmod -v u+w /usr/lib/{libcom_err,libe2p,libext2fs,libss}.a</userinput></screen>
150
151 <para>This package installs a gzipped
152 <filename class="extension">.info</filename> file but doesn't update the
153 system-wide <filename>dir</filename> file. Unzip this file and then update
154 the system <filename>dir</filename> file using the following
155 commands:</para>
156
157<screen><userinput remap="install">gunzip -v /usr/share/info/libext2fs.info.gz
158install-info --dir-file=/usr/share/info/dir /usr/share/info/libext2fs.info</userinput></screen>
159
160 <para>If desired, create and install some additional documentation by
161 issuing the following commands:</para>
162
163<screen><userinput remap="install">makeinfo -o doc/com_err.info ../lib/et/com_err.texinfo
164install -v -m644 doc/com_err.info /usr/share/info
165install-info --dir-file=/usr/share/info/dir /usr/share/info/com_err.info</userinput></screen>
166 </sect2>
167
168 <sect2 id="contents-e2fsprogs" role="content">
169 <title>Contents of E2fsprogs</title>
170
171 <segmentedlist>
172 <segtitle>Installed programs</segtitle>
173 <segtitle>Installed libraries</segtitle>
174 <segtitle>Installed directories</segtitle>
175
176 <seglistitem>
177 <seg>badblocks, chattr, compile_et, debugfs, dumpe2fs,e2freefrag,
178 e2fsck, e2image, e2label, e2undo, e4defrag, filefrag, fsck.ext2,
179 fsck.ext3, fsck.ext4, fsck.ext4dev, logsave, lsattr, mk_cmds, mke2fs,
180 mkfs.ext2, mkfs.ext3, mkfs.ext4, mkfs.ext4dev, mklost+found,
181 resize2fs, and tune2fs</seg>
182 <seg>libcom_err.so, libe2p.so, libext2fs.so, and libss.so</seg>
183 <seg>/usr/include/e2p, /usr/include/et, /usr/include/ext2fs,
184 /usr/include/ss, /usr/share/et, and /usr/share/ss</seg>
185 </seglistitem>
186 </segmentedlist>
187
188 <variablelist>
189 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
190 <?dbfo list-presentation="list"?>
191 <?dbhtml list-presentation="table"?>
192
193 <varlistentry id="badblocks">
194 <term><command>badblocks</command></term>
195 <listitem>
196 <para>Searches a device (usually a disk partition) for bad
197 blocks</para>
198 <indexterm zone="ch-system-e2fsprogs badblocks">
199 <primary sortas="b-badblocks">badblocks</primary>
200 </indexterm>
201 </listitem>
202 </varlistentry>
203
204 <varlistentry id="chattr">
205 <term><command>chattr</command></term>
206 <listitem>
207 <para>Changes the attributes of files on an <systemitem
208 class="filesystem">ext2</systemitem> file system; it also
209 changes <systemitem class="filesystem">ext3</systemitem>
210 file systems, the journaling version of <systemitem
211 class="filesystem">ext2</systemitem> file systems</para>
212 <indexterm zone="ch-system-e2fsprogs chattr">
213 <primary sortas="b-chattr">chattr</primary>
214 </indexterm>
215 </listitem>
216 </varlistentry>
217
218 <varlistentry id="compile_et">
219 <term><command>compile_et</command></term>
220 <listitem>
221 <para>An error table compiler; it converts a table of error-code
222 names and messages into a C source file suitable for use with the
223 <filename class="libraryfile">com_err</filename> library</para>
224 <indexterm zone="ch-system-e2fsprogs compile_et">
225 <primary sortas="b-compile_et">compile_et</primary>
226 </indexterm>
227 </listitem>
228 </varlistentry>
229
230 <varlistentry id="debugfs">
231 <term><command>debugfs</command></term>
232 <listitem>
233 <para>A file system debugger; it can be used to examine and change
234 the state of an <systemitem class="filesystem">ext2</systemitem>
235 file system</para>
236 <indexterm zone="ch-system-e2fsprogs debugfs">
237 <primary sortas="b-debugfs">debugfs</primary>
238 </indexterm>
239 </listitem>
240 </varlistentry>
241
242 <varlistentry id="dumpe2fs">
243 <term><command>dumpe2fs</command></term>
244 <listitem>
245 <para>Prints the super block and blocks group information for the
246 file system present on a given device</para>
247 <indexterm zone="ch-system-e2fsprogs dumpe2fs">
248 <primary sortas="b-dumpe2fs">dumpe2fs</primary>
249 </indexterm>
250 </listitem>
251 </varlistentry>
252
253 <varlistentry id="e2freefrag">
254 <term><command>e2freefrag</command></term>
255 <listitem>
256 <para>Reports free space fragmentation information</para>
257 <indexterm zone="ch-system-e2fsprogs e2freefrag">
258 <primary sortas="b-e2freefrag">e2freefrag</primary>
259 </indexterm>
260 </listitem>
261 </varlistentry>
262
263 <varlistentry id="e2fsck">
264 <term><command>e2fsck</command></term>
265 <listitem>
266 <para>Is used to check, and optionally repair <systemitem
267 class="filesystem">ext2</systemitem> file systems and <systemitem
268 class="filesystem">ext3</systemitem> file systems</para>
269 <indexterm zone="ch-system-e2fsprogs e2fsck">
270 <primary sortas="b-e2fsck">e2fsck</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>
274
275 <varlistentry id="e2image">
276 <term><command>e2image</command></term>
277 <listitem>
278 <para>Is used to save critical <systemitem
279 class="filesystem">ext2</systemitem> file system data to a file</para>
280 <indexterm zone="ch-system-e2fsprogs e2image">
281 <primary sortas="b-e2image">e2image</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 <varlistentry id="e2label">
287 <term><command>e2label</command></term>
288 <listitem>
289 <para>Displays or changes the file system label on the <systemitem
290 class="filesystem">ext2</systemitem> file system present on a given
291 device</para>
292 <indexterm zone="ch-system-e2fsprogs e2label">
293 <primary sortas="b-e2label">e2label</primary>
294 </indexterm>
295 </listitem>
296 </varlistentry>
297
298 <varlistentry id="e2undo">
299 <term><command>e2undo</command></term>
300 <listitem>
301 <para>Replays the undo log undo_log for an ext2/ext3/ext4 filesystem
302 found on a device [This can be used to undo a failed operation by an
303 e2fsprogs program.]</para>
304 <indexterm zone="ch-system-e2fsprogs e2undo">
305 <primary sortas="b-e2undo">e2undo</primary>
306 </indexterm>
307 </listitem>
308 </varlistentry>
309
310 <varlistentry id="e4defrag">
311 <term><command>e4defrag</command></term>
312 <listitem>
313 <para>Online defragmenter for ext4 filesystems</para>
314 <indexterm zone="ch-system-e2fsprogs e4defrag">
315 <primary sortas="b-e4defrag">e4defrag</primary>
316 </indexterm>
317 </listitem>
318 </varlistentry>
319
320 <varlistentry id="filefrag">
321 <term><command>filefrag</command></term>
322 <listitem>
323 <para>Reports on how badly fragmented a particular file might be</para>
324 <indexterm zone="ch-system-e2fsprogs filefrag">
325 <primary sortas="b-filefrag">filefrag</primary>
326 </indexterm>
327 </listitem>
328 </varlistentry>
329
330 <varlistentry id="fsck.ext2">
331 <term><command>fsck.ext2</command></term>
332 <listitem>
333 <para>By default checks <systemitem class="filesystem">ext2</systemitem>
334 file systems and is a hard link to <command>e2fsck</command></para>
335 <indexterm zone="ch-system-e2fsprogs fsck.ext2">
336 <primary sortas="b-fsck.ext2">fsck.ext2</primary>
337 </indexterm>
338 </listitem>
339 </varlistentry>
340
341 <varlistentry id="fsck.ext3">
342 <term><command>fsck.ext3</command></term>
343 <listitem>
344 <para>By default checks <systemitem class="filesystem">ext3</systemitem>
345 file systems and is a hard link to <command>e2fsck</command></para>
346 <indexterm zone="ch-system-e2fsprogs fsck.ext3">
347 <primary sortas="b-fsck.ext3">fsck.ext3</primary>
348 </indexterm>
349 </listitem>
350 </varlistentry>
351
352 <varlistentry id="fsck.ext4">
353 <term><command>fsck.ext4</command></term>
354 <listitem>
355 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
356 file systems and is a hard link to <command>e2fsck</command></para>
357 <indexterm zone="ch-system-e2fsprogs fsck.ext4">
358 <primary sortas="b-fsck.ext4">fsck.ext4</primary>
359 </indexterm>
360 </listitem>
361 </varlistentry>
362
363 <varlistentry id="fsck.ext4dev">
364 <term><command>fsck.ext4dev</command></term>
365 <listitem>
366 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
367 development file systems and is a hard link to
368 <command>e2fsck</command></para>
369 <indexterm zone="ch-system-e2fsprogs fsck.ext4dev">
370 <primary sortas="b-fsck.ext4dev">fsck.ext4dev</primary>
371 </indexterm>
372 </listitem>
373 </varlistentry>
374
375 <varlistentry id="logsave">
376 <term><command>logsave</command></term>
377 <listitem>
378 <para>Saves the output of a command in a log file</para>
379 <indexterm zone="ch-system-e2fsprogs logsave">
380 <primary sortas="b-logsave">logsave</primary>
381 </indexterm>
382 </listitem>
383 </varlistentry>
384
385 <varlistentry id="lsattr">
386 <term><command>lsattr</command></term>
387 <listitem>
388 <para>Lists the attributes of files on a second extended file
389 system</para>
390 <indexterm zone="ch-system-e2fsprogs lsattr">
391 <primary sortas="b-lsattr">lsattr</primary>
392 </indexterm>
393 </listitem>
394 </varlistentry>
395
396 <varlistentry id="mk_cmds">
397 <term><command>mk_cmds</command></term>
398 <listitem>
399 <para>Converts a table of command names and help messages into a C
400 source file suitable for use with the <filename
401 class="libraryfile">libss</filename> subsystem library</para>
402 <indexterm zone="ch-system-e2fsprogs mk_cmds">
403 <primary sortas="b-mk_cmds">mk_cmds</primary>
404 </indexterm>
405 </listitem>
406 </varlistentry>
407
408 <varlistentry id="mke2fs">
409 <term><command>mke2fs</command></term>
410 <listitem>
411 <para>Creates an <systemitem class="filesystem">ext2</systemitem>
412 or <systemitem class="filesystem">ext3</systemitem> file system on
413 the given device</para>
414 <indexterm zone="ch-system-e2fsprogs mke2fs">
415 <primary sortas="b-mke2fs">mke2fs</primary>
416 </indexterm>
417 </listitem>
418 </varlistentry>
419
420 <varlistentry id="mkfs.ext2">
421 <term><command>mkfs.ext2</command></term>
422 <listitem>
423 <para>By default creates <systemitem class="filesystem">ext2</systemitem>
424 file systems and is a hard link to <command>mke2fs</command></para>
425 <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
426 <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
427 </indexterm>
428 </listitem>
429 </varlistentry>
430
431 <varlistentry id="mkfs.ext3">
432 <term><command>mkfs.ext3</command></term>
433 <listitem>
434 <para>By default creates <systemitem class="filesystem">ext3</systemitem>
435 file systems and is a hard link to <command>mke2fs</command></para>
436 <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
437 <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
438 </indexterm>
439 </listitem>
440 </varlistentry>
441
442 <varlistentry id="mkfs.ext4">
443 <term><command>mkfs.ext4</command></term>
444 <listitem>
445 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
446 file systems and is a hard link to <command>mke2fs</command></para>
447 <indexterm zone="ch-system-e2fsprogs mkfs.ext4">
448 <primary sortas="b-mkfs.ext4">mkfs.ext4</primary>
449 </indexterm>
450 </listitem>
451 </varlistentry>
452
453 <varlistentry id="mkfs.ext4dev">
454 <term><command>mkfs.ext4dev</command></term>
455 <listitem>
456 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
457 development file systems and is a hard link to <command>mke2fs</command></para>
458 <indexterm zone="ch-system-e2fsprogs mkfs.ext4dev">
459 <primary sortas="b-mkfs.ext4dev">mkfs.ext4dev</primary>
460 </indexterm>
461 </listitem>
462 </varlistentry>
463
464 <varlistentry id="mklost-found">
465 <term><command>mklost+found</command></term>
466 <listitem>
467 <para>Used to create a <filename class="directory">lost+found</filename>
468 directory on an <systemitem class="filesystem">ext2</systemitem> file
469 system; it pre-allocates disk blocks to this directory to lighten the
470 task of <command>e2fsck</command></para>
471 <indexterm zone="ch-system-e2fsprogs mklost-found">
472 <primary sortas="b-mklost+found">mklost+found</primary>
473 </indexterm>
474 </listitem>
475 </varlistentry>
476
477 <varlistentry id="resize2fs">
478 <term><command>resize2fs</command></term>
479 <listitem>
480 <para>Can be used to enlarge or shrink an <systemitem
481 class="filesystem">ext2</systemitem> file system</para>
482 <indexterm zone="ch-system-e2fsprogs resize2fs">
483 <primary sortas="b-resize2fs">resize2fs</primary>
484 </indexterm>
485 </listitem>
486 </varlistentry>
487
488 <varlistentry id="tune2fs">
489 <term><command>tune2fs</command></term>
490 <listitem>
491 <para>Adjusts tunable file system parameters on an <systemitem
492 class="filesystem">ext2</systemitem> file system</para>
493 <indexterm zone="ch-system-e2fsprogs tune2fs">
494 <primary sortas="b-tune2fs">tune2fs</primary>
495 </indexterm>
496 </listitem>
497 </varlistentry>
498
499 <varlistentry id="libcom_err">
500 <term><filename class="libraryfile">libcom_err</filename></term>
501 <listitem>
502 <para>The common error display routine</para>
503 <indexterm zone="ch-system-e2fsprogs libcom_err">
504 <primary sortas="c-libcom_err">libcom_err</primary>
505 </indexterm>
506 </listitem>
507 </varlistentry>
508
509 <varlistentry id="libe2p">
510 <term><filename class="libraryfile">libe2p</filename></term>
511 <listitem>
512 <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
513 and <command>lsattr</command></para>
514 <indexterm zone="ch-system-e2fsprogs libe2p">
515 <primary sortas="c-libe2p">libe2p</primary>
516 </indexterm>
517 </listitem>
518 </varlistentry>
519
520 <varlistentry id="libext2fs">
521 <term><filename class="libraryfile">libext2fs</filename></term>
522 <listitem>
523 <para>Contains routines to enable user-level programs to manipulate an
524 <systemitem class="filesystem">ext2</systemitem> file system</para>
525 <indexterm zone="ch-system-e2fsprogs libext2fs">
526 <primary sortas="c-libext2fs">libext2fs</primary>
527 </indexterm>
528 </listitem>
529 </varlistentry>
530
531 <varlistentry id="libss">
532 <term><filename class="libraryfile">libss</filename></term>
533 <listitem>
534 <para>Used by <command>debugfs</command></para>
535 <indexterm zone="ch-system-e2fsprogs libss">
536 <primary sortas="c-libss">libss</primary>
537 </indexterm>
538 </listitem>
539 </varlistentry>
540
541 </variablelist>
542
543 </sect2>
544
545</sect1>
Note: See TracBrowser for help on using the repository browser.