source: chapter08/e2fsprogs.xml@ 49170b0a

11.0 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 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 49170b0a was 49170b0a, checked in by Bruce Dubbs <bdubbs@…>, 3 years ago

Package updates for lfs-11.0-rc3
LFS-11.0-rc3 released.
Update to e2fsprogs-1.46.4.
Update to meson-0.59.1.
Update to util-linux 2.37.2.
Update to linux-5.13.12.
Update to libcap-2.53.
  • Property mode set to 100644
File size: 19.8 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-fin-sbu;</seg>
38 <seg>&e2fsprogs-fin-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">../configure --prefix=/usr \
56 --sysconfdir=/etc \
57 --enable-elf-shlibs \
58 --disable-libblkid \
59 --disable-libuuid \
60 --disable-uuidd \
61 --disable-fsck</userinput></screen>
62
63 <variablelist>
64 <title>The meaning of the configure options:</title>
65
66 <varlistentry>
67 <term><parameter>--enable-elf-shlibs</parameter></term>
68 <listitem>
69 <para>This creates the shared libraries which some programs
70 in this package use.</para>
71 </listitem>
72 </varlistentry>
73
74 <varlistentry>
75 <term><parameter>--disable-*</parameter></term>
76 <listitem>
77 <para>This prevents e2fsprogs from building and installing the
78 <systemitem class="library">libuuid</systemitem> and
79 <systemitem class="library">libblkid</systemitem> libraries, the
80 <systemitem class="daemon">uuidd</systemitem> daemon, and the
81 <command>fsck</command> wrapper, as util-linux installs more
82 recent versions.</para>
83 </listitem>
84 </varlistentry>
85
86 </variablelist>
87
88 <para>Compile the package:</para>
89
90<screen><userinput remap="make">make</userinput></screen>
91
92 <para>To run the tests, issue:</para>
93
94<screen><userinput remap="test">make check</userinput></screen>
95
96 <para>One test, u_direct_io, is known to fail on some systems.</para>
97
98<!-- This is a ridiculous amount now! And is it still true?
99 Does not appear to be true for version 1.46.3. Time with tests
100 26 seconds with tests (With lots of cores and ram and an ssd disk).
101
102 <para>One of the e2fsprogs tests will attempt to allocate 256 MB of memory.
103 If you do not have significantly more RAM than this, be sure to enable
104 sufficient swap space for the test. See <xref
105 linkend="ch-partitioning-creatingfilesystem"/> and <xref
106 linkend="ch-partitioning-mounting"/>
107 for details on creating and enabling swap space.</para>
108
109 <para>On a spinning disk, the tests take a little more than 4 SBUs. They
110 can be much shorter on an SSD (down to about 1.5 SBUs).</para>
111-->
112 <para>Install the package:</para>
113
114<screen><userinput remap="install">make install</userinput></screen>
115
116 <para>Remove useless static libraries:</para>
117
118<screen><userinput remap="install">rm -fv /usr/lib/{libcom_err,libe2p,libext2fs,libss}.a</userinput></screen>
119
120 <para>This package installs a gzipped
121 <filename class="extension">.info</filename> file but doesn't update the
122 system-wide <filename>dir</filename> file. Unzip this file and then update
123 the system <filename>dir</filename> file using the following
124 commands:</para>
125
126<screen><userinput remap="install">gunzip -v /usr/share/info/libext2fs.info.gz
127install-info --dir-file=/usr/share/info/dir /usr/share/info/libext2fs.info</userinput></screen>
128
129 <para>If desired, create and install some additional documentation by
130 issuing the following commands:</para>
131
132<screen><userinput remap="install">makeinfo -o doc/com_err.info ../lib/et/com_err.texinfo
133install -v -m644 doc/com_err.info /usr/share/info
134install-info --dir-file=/usr/share/info/dir /usr/share/info/com_err.info</userinput></screen>
135 </sect2>
136
137 <sect2 id="contents-e2fsprogs" role="content">
138 <title>Contents of E2fsprogs</title>
139
140 <segmentedlist>
141 <segtitle>Installed programs</segtitle>
142 <segtitle>Installed libraries</segtitle>
143 <segtitle>Installed directories</segtitle>
144
145 <seglistitem>
146 <seg>badblocks, chattr, compile_et, debugfs, dumpe2fs, e2freefrag,
147 e2fsck, e2image, e2label, e2mmpstatus, e2scrub, e2scrub_all, e2undo,
148 e4crypt, e4defrag, filefrag, fsck.ext2,
149 fsck.ext3, fsck.ext4, logsave, lsattr, mk_cmds, mke2fs,
150 mkfs.ext2, mkfs.ext3, mkfs.ext4, mklost+found,
151 resize2fs, and tune2fs</seg>
152 <seg>libcom_err.so, libe2p.so, libext2fs.so, and libss.so</seg>
153 <seg>/usr/include/e2p, /usr/include/et, /usr/include/ext2fs,
154 /usr/include/ss, /usr/lib/e2fsprogs, /usr/share/et, and
155 /usr/share/ss</seg>
156 </seglistitem>
157 </segmentedlist>
158
159 <variablelist>
160 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
161 <?dbfo list-presentation="list"?>
162 <?dbhtml list-presentation="table"?>
163
164 <varlistentry id="badblocks">
165 <term><command>badblocks</command></term>
166 <listitem>
167 <para>Searches a device (usually a disk partition) for bad
168 blocks</para>
169 <indexterm zone="ch-system-e2fsprogs badblocks">
170 <primary sortas="b-badblocks">badblocks</primary>
171 </indexterm>
172 </listitem>
173 </varlistentry>
174
175 <varlistentry id="chattr">
176 <term><command>chattr</command></term>
177 <listitem>
178 <para>Changes the attributes of files on an <systemitem
179 class="filesystem">ext2</systemitem> file system; it also
180 changes <systemitem class="filesystem">ext3</systemitem>
181 file systems, the journaling version of <systemitem
182 class="filesystem">ext2</systemitem> file systems</para>
183 <indexterm zone="ch-system-e2fsprogs chattr">
184 <primary sortas="b-chattr">chattr</primary>
185 </indexterm>
186 </listitem>
187 </varlistentry>
188
189 <varlistentry id="compile_et">
190 <term><command>compile_et</command></term>
191 <listitem>
192 <para>An error table compiler; it converts a table of error-code
193 names and messages into a C source file suitable for use with the
194 <filename class="libraryfile">com_err</filename> library</para>
195 <indexterm zone="ch-system-e2fsprogs compile_et">
196 <primary sortas="b-compile_et">compile_et</primary>
197 </indexterm>
198 </listitem>
199 </varlistentry>
200
201 <varlistentry id="debugfs">
202 <term><command>debugfs</command></term>
203 <listitem>
204 <para>A file system debugger; it can be used to examine and change
205 the state of an <systemitem class="filesystem">ext2</systemitem>
206 file system</para>
207 <indexterm zone="ch-system-e2fsprogs debugfs">
208 <primary sortas="b-debugfs">debugfs</primary>
209 </indexterm>
210 </listitem>
211 </varlistentry>
212
213 <varlistentry id="dumpe2fs">
214 <term><command>dumpe2fs</command></term>
215 <listitem>
216 <para>Prints the super block and blocks group information for the
217 file system present on a given device</para>
218 <indexterm zone="ch-system-e2fsprogs dumpe2fs">
219 <primary sortas="b-dumpe2fs">dumpe2fs</primary>
220 </indexterm>
221 </listitem>
222 </varlistentry>
223
224 <varlistentry id="e2freefrag">
225 <term><command>e2freefrag</command></term>
226 <listitem>
227 <para>Reports free space fragmentation information</para>
228 <indexterm zone="ch-system-e2fsprogs e2freefrag">
229 <primary sortas="b-e2freefrag">e2freefrag</primary>
230 </indexterm>
231 </listitem>
232 </varlistentry>
233
234 <varlistentry id="e2fsck">
235 <term><command>e2fsck</command></term>
236 <listitem>
237 <para>Is used to check, and optionally repair <systemitem
238 class="filesystem">ext2</systemitem> file systems and <systemitem
239 class="filesystem">ext3</systemitem> file systems</para>
240 <indexterm zone="ch-system-e2fsprogs e2fsck">
241 <primary sortas="b-e2fsck">e2fsck</primary>
242 </indexterm>
243 </listitem>
244 </varlistentry>
245
246 <varlistentry id="e2image">
247 <term><command>e2image</command></term>
248 <listitem>
249 <para>Is used to save critical <systemitem
250 class="filesystem">ext2</systemitem> file system data to a file</para>
251 <indexterm zone="ch-system-e2fsprogs e2image">
252 <primary sortas="b-e2image">e2image</primary>
253 </indexterm>
254 </listitem>
255 </varlistentry>
256
257 <varlistentry id="e2label">
258 <term><command>e2label</command></term>
259 <listitem>
260 <para>Displays or changes the file system label on the <systemitem
261 class="filesystem">ext2</systemitem> file system present on a given
262 device</para>
263 <indexterm zone="ch-system-e2fsprogs e2label">
264 <primary sortas="b-e2label">e2label</primary>
265 </indexterm>
266 </listitem>
267 </varlistentry>
268
269 <varlistentry id="e2mmpstatus">
270 <term><command>e2mmpstatus</command></term>
271 <listitem>
272 <para>Checks MMP status of an ext4 filesystem</para>
273 <indexterm zone="ch-system-e2fsprogs e2mmpstatus">
274 <primary sortas="b-e2mmpstatus">e2mmpstatus</primary>
275 </indexterm>
276 </listitem>
277 </varlistentry>
278
279 <varlistentry id="e2scrub">
280 <term><command>e2scrub</command></term>
281 <listitem>
282 <para>Checks the contents of a mounted ext[234] filesystem</para>
283 <indexterm zone="ch-system-e2fsprogs e2scrub">
284 <primary sortas="b-e2scrub">e2scrub</primary>
285 </indexterm>
286 </listitem>
287 </varlistentry>
288
289 <varlistentry id="e2scrub_all">
290 <term><command>e2scrub_all</command></term>
291 <listitem>
292 <para>Checks all mounted ext[234] filesystems for errors</para>
293 <indexterm zone="ch-system-e2fsprogs e2scrub_all">
294 <primary sortas="b-e2scrub_all">e2scrub_all</primary>
295 </indexterm>
296 </listitem>
297 </varlistentry>
298
299 <varlistentry id="e2undo">
300 <term><command>e2undo</command></term>
301 <listitem>
302 <para>Replays the undo log undo_log for an ext2/ext3/ext4 filesystem
303 found on a device [This can be used to undo a failed operation by an
304 e2fsprogs program.]</para>
305 <indexterm zone="ch-system-e2fsprogs e2undo">
306 <primary sortas="b-e2undo">e2undo</primary>
307 </indexterm>
308 </listitem>
309 </varlistentry>
310
311 <varlistentry id="e4crypt">
312 <term><command>e4crypt</command></term>
313 <listitem>
314 <para>Ext4 filesystem encryption utility</para>
315 <indexterm zone="ch-system-e2fsprogs e4crypt">
316 <primary sortas="b-e4crypt">e4crypt</primary>
317 </indexterm>
318 </listitem>
319 </varlistentry>
320
321 <varlistentry id="e4defrag">
322 <term><command>e4defrag</command></term>
323 <listitem>
324 <para>Online defragmenter for ext4 filesystems</para>
325 <indexterm zone="ch-system-e2fsprogs e4defrag">
326 <primary sortas="b-e4defrag">e4defrag</primary>
327 </indexterm>
328 </listitem>
329 </varlistentry>
330
331 <varlistentry id="filefrag">
332 <term><command>filefrag</command></term>
333 <listitem>
334 <para>Reports on how badly fragmented a particular file might be</para>
335 <indexterm zone="ch-system-e2fsprogs filefrag">
336 <primary sortas="b-filefrag">filefrag</primary>
337 </indexterm>
338 </listitem>
339 </varlistentry>
340
341 <varlistentry id="fsck.ext2">
342 <term><command>fsck.ext2</command></term>
343 <listitem>
344 <para>By default checks <systemitem class="filesystem">ext2</systemitem>
345 file systems and is a hard link to <command>e2fsck</command></para>
346 <indexterm zone="ch-system-e2fsprogs fsck.ext2">
347 <primary sortas="b-fsck.ext2">fsck.ext2</primary>
348 </indexterm>
349 </listitem>
350 </varlistentry>
351
352 <varlistentry id="fsck.ext3">
353 <term><command>fsck.ext3</command></term>
354 <listitem>
355 <para>By default checks <systemitem class="filesystem">ext3</systemitem>
356 file systems and is a hard link to <command>e2fsck</command></para>
357 <indexterm zone="ch-system-e2fsprogs fsck.ext3">
358 <primary sortas="b-fsck.ext3">fsck.ext3</primary>
359 </indexterm>
360 </listitem>
361 </varlistentry>
362
363 <varlistentry id="fsck.ext4">
364 <term><command>fsck.ext4</command></term>
365 <listitem>
366 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
367 file systems and is a hard link to <command>e2fsck</command></para>
368 <indexterm zone="ch-system-e2fsprogs fsck.ext4">
369 <primary sortas="b-fsck.ext4">fsck.ext4</primary>
370 </indexterm>
371 </listitem>
372 </varlistentry>
373
374 <varlistentry id="logsave">
375 <term><command>logsave</command></term>
376 <listitem>
377 <para>Saves the output of a command in a log file</para>
378 <indexterm zone="ch-system-e2fsprogs logsave">
379 <primary sortas="b-logsave">logsave</primary>
380 </indexterm>
381 </listitem>
382 </varlistentry>
383
384 <varlistentry id="lsattr">
385 <term><command>lsattr</command></term>
386 <listitem>
387 <para>Lists the attributes of files on a second extended file
388 system</para>
389 <indexterm zone="ch-system-e2fsprogs lsattr">
390 <primary sortas="b-lsattr">lsattr</primary>
391 </indexterm>
392 </listitem>
393 </varlistentry>
394
395 <varlistentry id="mk_cmds">
396 <term><command>mk_cmds</command></term>
397 <listitem>
398 <para>Converts a table of command names and help messages into a C
399 source file suitable for use with the <filename
400 class="libraryfile">libss</filename> subsystem library</para>
401 <indexterm zone="ch-system-e2fsprogs mk_cmds">
402 <primary sortas="b-mk_cmds">mk_cmds</primary>
403 </indexterm>
404 </listitem>
405 </varlistentry>
406
407 <varlistentry id="mke2fs">
408 <term><command>mke2fs</command></term>
409 <listitem>
410 <para>Creates an <systemitem class="filesystem">ext2</systemitem>
411 or <systemitem class="filesystem">ext3</systemitem> file system on
412 the given device</para>
413 <indexterm zone="ch-system-e2fsprogs mke2fs">
414 <primary sortas="b-mke2fs">mke2fs</primary>
415 </indexterm>
416 </listitem>
417 </varlistentry>
418
419 <varlistentry id="mkfs.ext2">
420 <term><command>mkfs.ext2</command></term>
421 <listitem>
422 <para>By default creates <systemitem class="filesystem">ext2</systemitem>
423 file systems and is a hard link to <command>mke2fs</command></para>
424 <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
425 <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
426 </indexterm>
427 </listitem>
428 </varlistentry>
429
430 <varlistentry id="mkfs.ext3">
431 <term><command>mkfs.ext3</command></term>
432 <listitem>
433 <para>By default creates <systemitem class="filesystem">ext3</systemitem>
434 file systems and is a hard link to <command>mke2fs</command></para>
435 <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
436 <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
437 </indexterm>
438 </listitem>
439 </varlistentry>
440
441 <varlistentry id="mkfs.ext4">
442 <term><command>mkfs.ext4</command></term>
443 <listitem>
444 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
445 file systems and is a hard link to <command>mke2fs</command></para>
446 <indexterm zone="ch-system-e2fsprogs mkfs.ext4">
447 <primary sortas="b-mkfs.ext4">mkfs.ext4</primary>
448 </indexterm>
449 </listitem>
450 </varlistentry>
451
452 <varlistentry id="mklost-found">
453 <term><command>mklost+found</command></term>
454 <listitem>
455 <para>Used to create a <filename class="directory">lost+found</filename>
456 directory on an <systemitem class="filesystem">ext2</systemitem> file
457 system; it pre-allocates disk blocks to this directory to lighten the
458 task of <command>e2fsck</command></para>
459 <indexterm zone="ch-system-e2fsprogs mklost-found">
460 <primary sortas="b-mklost+found">mklost+found</primary>
461 </indexterm>
462 </listitem>
463 </varlistentry>
464
465 <varlistentry id="resize2fs">
466 <term><command>resize2fs</command></term>
467 <listitem>
468 <para>Can be used to enlarge or shrink an <systemitem
469 class="filesystem">ext2</systemitem> file system</para>
470 <indexterm zone="ch-system-e2fsprogs resize2fs">
471 <primary sortas="b-resize2fs">resize2fs</primary>
472 </indexterm>
473 </listitem>
474 </varlistentry>
475
476 <varlistentry id="tune2fs">
477 <term><command>tune2fs</command></term>
478 <listitem>
479 <para>Adjusts tunable file system parameters on an <systemitem
480 class="filesystem">ext2</systemitem> file system</para>
481 <indexterm zone="ch-system-e2fsprogs tune2fs">
482 <primary sortas="b-tune2fs">tune2fs</primary>
483 </indexterm>
484 </listitem>
485 </varlistentry>
486
487 <varlistentry id="libcom_err">
488 <term><filename class="libraryfile">libcom_err</filename></term>
489 <listitem>
490 <para>The common error display routine</para>
491 <indexterm zone="ch-system-e2fsprogs libcom_err">
492 <primary sortas="c-libcom_err">libcom_err</primary>
493 </indexterm>
494 </listitem>
495 </varlistentry>
496
497 <varlistentry id="libe2p">
498 <term><filename class="libraryfile">libe2p</filename></term>
499 <listitem>
500 <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
501 and <command>lsattr</command></para>
502 <indexterm zone="ch-system-e2fsprogs libe2p">
503 <primary sortas="c-libe2p">libe2p</primary>
504 </indexterm>
505 </listitem>
506 </varlistentry>
507
508 <varlistentry id="libext2fs">
509 <term><filename class="libraryfile">libext2fs</filename></term>
510 <listitem>
511 <para>Contains routines to enable user-level programs to manipulate an
512 <systemitem class="filesystem">ext2</systemitem> file system</para>
513 <indexterm zone="ch-system-e2fsprogs libext2fs">
514 <primary sortas="c-libext2fs">libext2fs</primary>
515 </indexterm>
516 </listitem>
517 </varlistentry>
518
519 <varlistentry id="libss">
520 <term><filename class="libraryfile">libss</filename></term>
521 <listitem>
522 <para>Used by <command>debugfs</command></para>
523 <indexterm zone="ch-system-e2fsprogs libss">
524 <primary sortas="c-libss">libss</primary>
525 </indexterm>
526 </listitem>
527 </varlistentry>
528
529 </variablelist>
530
531 </sect2>
532
533</sect1>
Note: See TracBrowser for help on using the repository browser.