source: chapter06/e2fsprogs.xml@ 6b041a0

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 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 6b041a0 was 6b041a0, checked in by Xi Ruoyao <xry111@…>, 4 years ago

e2fsprogs: install-libs is automatically run by install

git-svn-id: ​http://svn.linuxfromscratch.org/LFS/trunk/BOOK@11745 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>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 package:</para>
139
140<screen><userinput remap="install">make install</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 directories</segtitle>
171
172 <seglistitem>
173 <seg>badblocks, chattr, compile_et, debugfs, dumpe2fs,e2freefrag,
174 e2fsck, e2image, e2label, e2mmpstatus, e2scrub, e2scrub_all, e2undo,
175 e4crypt, e4defrag, filefrag, fsck.ext2,
176 fsck.ext3, fsck.ext4, logsave, lsattr, mk_cmds, mke2fs,
177 mkfs.ext2, mkfs.ext3, mkfs.ext4, 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/lib/e2fsprogs, /usr/share/et, and
182 /usr/share/ss</seg>
183 </seglistitem>
184 </segmentedlist>
185
186 <variablelist>
187 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
188 <?dbfo list-presentation="list"?>
189 <?dbhtml list-presentation="table"?>
190
191 <varlistentry id="badblocks">
192 <term><command>badblocks</command></term>
193 <listitem>
194 <para>Searches a device (usually a disk partition) for bad
195 blocks</para>
196 <indexterm zone="ch-system-e2fsprogs badblocks">
197 <primary sortas="b-badblocks">badblocks</primary>
198 </indexterm>
199 </listitem>
200 </varlistentry>
201
202 <varlistentry id="chattr">
203 <term><command>chattr</command></term>
204 <listitem>
205 <para>Changes the attributes of files on an <systemitem
206 class="filesystem">ext2</systemitem> file system; it also
207 changes <systemitem class="filesystem">ext3</systemitem>
208 file systems, the journaling version of <systemitem
209 class="filesystem">ext2</systemitem> file systems</para>
210 <indexterm zone="ch-system-e2fsprogs chattr">
211 <primary sortas="b-chattr">chattr</primary>
212 </indexterm>
213 </listitem>
214 </varlistentry>
215
216 <varlistentry id="compile_et">
217 <term><command>compile_et</command></term>
218 <listitem>
219 <para>An error table compiler; it converts a table of error-code
220 names and messages into a C source file suitable for use with the
221 <filename class="libraryfile">com_err</filename> library</para>
222 <indexterm zone="ch-system-e2fsprogs compile_et">
223 <primary sortas="b-compile_et">compile_et</primary>
224 </indexterm>
225 </listitem>
226 </varlistentry>
227
228 <varlistentry id="debugfs">
229 <term><command>debugfs</command></term>
230 <listitem>
231 <para>A file system debugger; it can be used to examine and change
232 the state of an <systemitem class="filesystem">ext2</systemitem>
233 file system</para>
234 <indexterm zone="ch-system-e2fsprogs debugfs">
235 <primary sortas="b-debugfs">debugfs</primary>
236 </indexterm>
237 </listitem>
238 </varlistentry>
239
240 <varlistentry id="dumpe2fs">
241 <term><command>dumpe2fs</command></term>
242 <listitem>
243 <para>Prints the super block and blocks group information for the
244 file system present on a given device</para>
245 <indexterm zone="ch-system-e2fsprogs dumpe2fs">
246 <primary sortas="b-dumpe2fs">dumpe2fs</primary>
247 </indexterm>
248 </listitem>
249 </varlistentry>
250
251 <varlistentry id="e2freefrag">
252 <term><command>e2freefrag</command></term>
253 <listitem>
254 <para>Reports free space fragmentation information</para>
255 <indexterm zone="ch-system-e2fsprogs e2freefrag">
256 <primary sortas="b-e2freefrag">e2freefrag</primary>
257 </indexterm>
258 </listitem>
259 </varlistentry>
260
261 <varlistentry id="e2fsck">
262 <term><command>e2fsck</command></term>
263 <listitem>
264 <para>Is used to check, and optionally repair <systemitem
265 class="filesystem">ext2</systemitem> file systems and <systemitem
266 class="filesystem">ext3</systemitem> file systems</para>
267 <indexterm zone="ch-system-e2fsprogs e2fsck">
268 <primary sortas="b-e2fsck">e2fsck</primary>
269 </indexterm>
270 </listitem>
271 </varlistentry>
272
273 <varlistentry id="e2image">
274 <term><command>e2image</command></term>
275 <listitem>
276 <para>Is used to save critical <systemitem
277 class="filesystem">ext2</systemitem> file system data to a file</para>
278 <indexterm zone="ch-system-e2fsprogs e2image">
279 <primary sortas="b-e2image">e2image</primary>
280 </indexterm>
281 </listitem>
282 </varlistentry>
283
284 <varlistentry id="e2label">
285 <term><command>e2label</command></term>
286 <listitem>
287 <para>Displays or changes the file system label on the <systemitem
288 class="filesystem">ext2</systemitem> file system present on a given
289 device</para>
290 <indexterm zone="ch-system-e2fsprogs e2label">
291 <primary sortas="b-e2label">e2label</primary>
292 </indexterm>
293 </listitem>
294 </varlistentry>
295
296 <varlistentry id="e2mmpstatus">
297 <term><command>e2mmpstatus</command></term>
298 <listitem>
299 <para>Checks MMP status of an ext4 filesystem</para>
300 <indexterm zone="ch-system-e2fsprogs e2mmpstatus">
301 <primary sortas="b-e2mmpstatus">e2mmpstatus</primary>
302 </indexterm>
303 </listitem>
304 </varlistentry>
305
306 <varlistentry id="e2scrub">
307 <term><command>e2scrub</command></term>
308 <listitem>
309 <para>Checks the contents of a mounted ext[234] filesystem</para>
310 <indexterm zone="ch-system-e2fsprogs e2scrub">
311 <primary sortas="b-e2scrub">e2scrub</primary>
312 </indexterm>
313 </listitem>
314 </varlistentry>
315
316 <varlistentry id="e2scrub_all">
317 <term><command>e2scrub_all</command></term>
318 <listitem>
319 <para>Checks all mounted ext[234] filesystems for errors</para>
320 <indexterm zone="ch-system-e2fsprogs e2scrub_all">
321 <primary sortas="b-e2scrub_all">e2scrub_all</primary>
322 </indexterm>
323 </listitem>
324 </varlistentry>
325
326 <varlistentry id="e2undo">
327 <term><command>e2undo</command></term>
328 <listitem>
329 <para>Replays the undo log undo_log for an ext2/ext3/ext4 filesystem
330 found on a device [This can be used to undo a failed operation by an
331 e2fsprogs program.]</para>
332 <indexterm zone="ch-system-e2fsprogs e2undo">
333 <primary sortas="b-e2undo">e2undo</primary>
334 </indexterm>
335 </listitem>
336 </varlistentry>
337
338 <varlistentry id="e4crypt">
339 <term><command>e4crypt</command></term>
340 <listitem>
341 <para>Ext4 filesystem encryption utility</para>
342 <indexterm zone="ch-system-e2fsprogs e4crypt">
343 <primary sortas="b-e4crypt">e4crypt</primary>
344 </indexterm>
345 </listitem>
346 </varlistentry>
347
348 <varlistentry id="e4defrag">
349 <term><command>e4defrag</command></term>
350 <listitem>
351 <para>Online defragmenter for ext4 filesystems</para>
352 <indexterm zone="ch-system-e2fsprogs e4defrag">
353 <primary sortas="b-e4defrag">e4defrag</primary>
354 </indexterm>
355 </listitem>
356 </varlistentry>
357
358 <varlistentry id="filefrag">
359 <term><command>filefrag</command></term>
360 <listitem>
361 <para>Reports on how badly fragmented a particular file might be</para>
362 <indexterm zone="ch-system-e2fsprogs filefrag">
363 <primary sortas="b-filefrag">filefrag</primary>
364 </indexterm>
365 </listitem>
366 </varlistentry>
367
368 <varlistentry id="fsck.ext2">
369 <term><command>fsck.ext2</command></term>
370 <listitem>
371 <para>By default checks <systemitem class="filesystem">ext2</systemitem>
372 file systems and is a hard link to <command>e2fsck</command></para>
373 <indexterm zone="ch-system-e2fsprogs fsck.ext2">
374 <primary sortas="b-fsck.ext2">fsck.ext2</primary>
375 </indexterm>
376 </listitem>
377 </varlistentry>
378
379 <varlistentry id="fsck.ext3">
380 <term><command>fsck.ext3</command></term>
381 <listitem>
382 <para>By default checks <systemitem class="filesystem">ext3</systemitem>
383 file systems and is a hard link to <command>e2fsck</command></para>
384 <indexterm zone="ch-system-e2fsprogs fsck.ext3">
385 <primary sortas="b-fsck.ext3">fsck.ext3</primary>
386 </indexterm>
387 </listitem>
388 </varlistentry>
389
390 <varlistentry id="fsck.ext4">
391 <term><command>fsck.ext4</command></term>
392 <listitem>
393 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
394 file systems and is a hard link to <command>e2fsck</command></para>
395 <indexterm zone="ch-system-e2fsprogs fsck.ext4">
396 <primary sortas="b-fsck.ext4">fsck.ext4</primary>
397 </indexterm>
398 </listitem>
399 </varlistentry>
400
401 <varlistentry id="logsave">
402 <term><command>logsave</command></term>
403 <listitem>
404 <para>Saves the output of a command in a log file</para>
405 <indexterm zone="ch-system-e2fsprogs logsave">
406 <primary sortas="b-logsave">logsave</primary>
407 </indexterm>
408 </listitem>
409 </varlistentry>
410
411 <varlistentry id="lsattr">
412 <term><command>lsattr</command></term>
413 <listitem>
414 <para>Lists the attributes of files on a second extended file
415 system</para>
416 <indexterm zone="ch-system-e2fsprogs lsattr">
417 <primary sortas="b-lsattr">lsattr</primary>
418 </indexterm>
419 </listitem>
420 </varlistentry>
421
422 <varlistentry id="mk_cmds">
423 <term><command>mk_cmds</command></term>
424 <listitem>
425 <para>Converts a table of command names and help messages into a C
426 source file suitable for use with the <filename
427 class="libraryfile">libss</filename> subsystem library</para>
428 <indexterm zone="ch-system-e2fsprogs mk_cmds">
429 <primary sortas="b-mk_cmds">mk_cmds</primary>
430 </indexterm>
431 </listitem>
432 </varlistentry>
433
434 <varlistentry id="mke2fs">
435 <term><command>mke2fs</command></term>
436 <listitem>
437 <para>Creates an <systemitem class="filesystem">ext2</systemitem>
438 or <systemitem class="filesystem">ext3</systemitem> file system on
439 the given device</para>
440 <indexterm zone="ch-system-e2fsprogs mke2fs">
441 <primary sortas="b-mke2fs">mke2fs</primary>
442 </indexterm>
443 </listitem>
444 </varlistentry>
445
446 <varlistentry id="mkfs.ext2">
447 <term><command>mkfs.ext2</command></term>
448 <listitem>
449 <para>By default creates <systemitem class="filesystem">ext2</systemitem>
450 file systems and is a hard link to <command>mke2fs</command></para>
451 <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
452 <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
453 </indexterm>
454 </listitem>
455 </varlistentry>
456
457 <varlistentry id="mkfs.ext3">
458 <term><command>mkfs.ext3</command></term>
459 <listitem>
460 <para>By default creates <systemitem class="filesystem">ext3</systemitem>
461 file systems and is a hard link to <command>mke2fs</command></para>
462 <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
463 <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
464 </indexterm>
465 </listitem>
466 </varlistentry>
467
468 <varlistentry id="mkfs.ext4">
469 <term><command>mkfs.ext4</command></term>
470 <listitem>
471 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
472 file systems and is a hard link to <command>mke2fs</command></para>
473 <indexterm zone="ch-system-e2fsprogs mkfs.ext4">
474 <primary sortas="b-mkfs.ext4">mkfs.ext4</primary>
475 </indexterm>
476 </listitem>
477 </varlistentry>
478
479 <varlistentry id="mklost-found">
480 <term><command>mklost+found</command></term>
481 <listitem>
482 <para>Used to create a <filename class="directory">lost+found</filename>
483 directory on an <systemitem class="filesystem">ext2</systemitem> file
484 system; it pre-allocates disk blocks to this directory to lighten the
485 task of <command>e2fsck</command></para>
486 <indexterm zone="ch-system-e2fsprogs mklost-found">
487 <primary sortas="b-mklost+found">mklost+found</primary>
488 </indexterm>
489 </listitem>
490 </varlistentry>
491
492 <varlistentry id="resize2fs">
493 <term><command>resize2fs</command></term>
494 <listitem>
495 <para>Can be used to enlarge or shrink an <systemitem
496 class="filesystem">ext2</systemitem> file system</para>
497 <indexterm zone="ch-system-e2fsprogs resize2fs">
498 <primary sortas="b-resize2fs">resize2fs</primary>
499 </indexterm>
500 </listitem>
501 </varlistentry>
502
503 <varlistentry id="tune2fs">
504 <term><command>tune2fs</command></term>
505 <listitem>
506 <para>Adjusts tunable file system parameters on an <systemitem
507 class="filesystem">ext2</systemitem> file system</para>
508 <indexterm zone="ch-system-e2fsprogs tune2fs">
509 <primary sortas="b-tune2fs">tune2fs</primary>
510 </indexterm>
511 </listitem>
512 </varlistentry>
513
514 <varlistentry id="libcom_err">
515 <term><filename class="libraryfile">libcom_err</filename></term>
516 <listitem>
517 <para>The common error display routine</para>
518 <indexterm zone="ch-system-e2fsprogs libcom_err">
519 <primary sortas="c-libcom_err">libcom_err</primary>
520 </indexterm>
521 </listitem>
522 </varlistentry>
523
524 <varlistentry id="libe2p">
525 <term><filename class="libraryfile">libe2p</filename></term>
526 <listitem>
527 <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
528 and <command>lsattr</command></para>
529 <indexterm zone="ch-system-e2fsprogs libe2p">
530 <primary sortas="c-libe2p">libe2p</primary>
531 </indexterm>
532 </listitem>
533 </varlistentry>
534
535 <varlistentry id="libext2fs">
536 <term><filename class="libraryfile">libext2fs</filename></term>
537 <listitem>
538 <para>Contains routines to enable user-level programs to manipulate an
539 <systemitem class="filesystem">ext2</systemitem> file system</para>
540 <indexterm zone="ch-system-e2fsprogs libext2fs">
541 <primary sortas="c-libext2fs">libext2fs</primary>
542 </indexterm>
543 </listitem>
544 </varlistentry>
545
546 <varlistentry id="libss">
547 <term><filename class="libraryfile">libss</filename></term>
548 <listitem>
549 <para>Used by <command>debugfs</command></para>
550 <indexterm zone="ch-system-e2fsprogs libss">
551 <primary sortas="c-libss">libss</primary>
552 </indexterm>
553 </listitem>
554 </varlistentry>
555
556 </variablelist>
557
558 </sect2>
559
560</sect1>
Note: See TracBrowser for help on using the repository browser.