source: chapter08/e2fsprogs.xml@ ea0f48e

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

Update test results for several packages.

Most of the changes were removing documentation of failed tests
that no longer fail.
  • Property mode set to 100644
File size: 19.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-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<!-- This is a ridiculous amount now! And is it still true?
97 Does not appear to be true for version 1.46.3. Time with tests
98 26 seconds with tests (With lots of cores and ram and an ssd disk).
99
100 <para>One of the e2fsprogs tests will attempt to allocate 256 MB of memory.
101 If you do not have significantly more RAM than this, be sure to enable
102 sufficient swap space for the test. See <xref
103 linkend="ch-partitioning-creatingfilesystem"/> and <xref
104 linkend="ch-partitioning-mounting"/>
105 for details on creating and enabling swap space.</para>
106
107 <para>On a spinning disk, the tests take a little more than 4 SBUs. They
108 can be much shorter on an SSD (down to about 1.5 SBUs).</para>
109-->
110 <para>Install the package:</para>
111
112<screen><userinput remap="install">make install</userinput></screen>
113
114 <para>Remove useless static libraries:</para>
115
116<screen><userinput remap="install">rm -fv /usr/lib/{libcom_err,libe2p,libext2fs,libss}.a</userinput></screen>
117
118 <para>This package installs a gzipped
119 <filename class="extension">.info</filename> file but doesn't update the
120 system-wide <filename>dir</filename> file. Unzip this file and then update
121 the system <filename>dir</filename> file using the following
122 commands:</para>
123
124<screen><userinput remap="install">gunzip -v /usr/share/info/libext2fs.info.gz
125install-info --dir-file=/usr/share/info/dir /usr/share/info/libext2fs.info</userinput></screen>
126
127 <para>If desired, create and install some additional documentation by
128 issuing the following commands:</para>
129
130<screen><userinput remap="install">makeinfo -o doc/com_err.info ../lib/et/com_err.texinfo
131install -v -m644 doc/com_err.info /usr/share/info
132install-info --dir-file=/usr/share/info/dir /usr/share/info/com_err.info</userinput></screen>
133 </sect2>
134
135 <sect2 id="contents-e2fsprogs" role="content">
136 <title>Contents of E2fsprogs</title>
137
138 <segmentedlist>
139 <segtitle>Installed programs</segtitle>
140 <segtitle>Installed libraries</segtitle>
141 <segtitle>Installed directories</segtitle>
142
143 <seglistitem>
144 <seg>badblocks, chattr, compile_et, debugfs, dumpe2fs, e2freefrag,
145 e2fsck, e2image, e2label, e2mmpstatus, e2scrub, e2scrub_all, e2undo,
146 e4crypt, e4defrag, filefrag, fsck.ext2,
147 fsck.ext3, fsck.ext4, logsave, lsattr, mk_cmds, mke2fs,
148 mkfs.ext2, mkfs.ext3, mkfs.ext4, mklost+found,
149 resize2fs, and tune2fs</seg>
150 <seg>libcom_err.so, libe2p.so, libext2fs.so, and libss.so</seg>
151 <seg>/usr/include/e2p, /usr/include/et, /usr/include/ext2fs,
152 /usr/include/ss, /usr/lib/e2fsprogs, /usr/share/et, and
153 /usr/share/ss</seg>
154 </seglistitem>
155 </segmentedlist>
156
157 <variablelist>
158 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
159 <?dbfo list-presentation="list"?>
160 <?dbhtml list-presentation="table"?>
161
162 <varlistentry id="badblocks">
163 <term><command>badblocks</command></term>
164 <listitem>
165 <para>Searches a device (usually a disk partition) for bad
166 blocks</para>
167 <indexterm zone="ch-system-e2fsprogs badblocks">
168 <primary sortas="b-badblocks">badblocks</primary>
169 </indexterm>
170 </listitem>
171 </varlistentry>
172
173 <varlistentry id="chattr">
174 <term><command>chattr</command></term>
175 <listitem>
176 <para>Changes the attributes of files on an <systemitem
177 class="filesystem">ext2</systemitem> file system; it also
178 changes <systemitem class="filesystem">ext3</systemitem>
179 file systems, the journaling version of <systemitem
180 class="filesystem">ext2</systemitem> file systems</para>
181 <indexterm zone="ch-system-e2fsprogs chattr">
182 <primary sortas="b-chattr">chattr</primary>
183 </indexterm>
184 </listitem>
185 </varlistentry>
186
187 <varlistentry id="compile_et">
188 <term><command>compile_et</command></term>
189 <listitem>
190 <para>An error table compiler; it converts a table of error-code
191 names and messages into a C source file suitable for use with the
192 <filename class="libraryfile">com_err</filename> library</para>
193 <indexterm zone="ch-system-e2fsprogs compile_et">
194 <primary sortas="b-compile_et">compile_et</primary>
195 </indexterm>
196 </listitem>
197 </varlistentry>
198
199 <varlistentry id="debugfs">
200 <term><command>debugfs</command></term>
201 <listitem>
202 <para>A file system debugger; it can be used to examine and change
203 the state of an <systemitem class="filesystem">ext2</systemitem>
204 file system</para>
205 <indexterm zone="ch-system-e2fsprogs debugfs">
206 <primary sortas="b-debugfs">debugfs</primary>
207 </indexterm>
208 </listitem>
209 </varlistentry>
210
211 <varlistentry id="dumpe2fs">
212 <term><command>dumpe2fs</command></term>
213 <listitem>
214 <para>Prints the super block and blocks group information for the
215 file system present on a given device</para>
216 <indexterm zone="ch-system-e2fsprogs dumpe2fs">
217 <primary sortas="b-dumpe2fs">dumpe2fs</primary>
218 </indexterm>
219 </listitem>
220 </varlistentry>
221
222 <varlistentry id="e2freefrag">
223 <term><command>e2freefrag</command></term>
224 <listitem>
225 <para>Reports free space fragmentation information</para>
226 <indexterm zone="ch-system-e2fsprogs e2freefrag">
227 <primary sortas="b-e2freefrag">e2freefrag</primary>
228 </indexterm>
229 </listitem>
230 </varlistentry>
231
232 <varlistentry id="e2fsck">
233 <term><command>e2fsck</command></term>
234 <listitem>
235 <para>Is used to check, and optionally repair <systemitem
236 class="filesystem">ext2</systemitem> file systems and <systemitem
237 class="filesystem">ext3</systemitem> file systems</para>
238 <indexterm zone="ch-system-e2fsprogs e2fsck">
239 <primary sortas="b-e2fsck">e2fsck</primary>
240 </indexterm>
241 </listitem>
242 </varlistentry>
243
244 <varlistentry id="e2image">
245 <term><command>e2image</command></term>
246 <listitem>
247 <para>Is used to save critical <systemitem
248 class="filesystem">ext2</systemitem> file system data to a file</para>
249 <indexterm zone="ch-system-e2fsprogs e2image">
250 <primary sortas="b-e2image">e2image</primary>
251 </indexterm>
252 </listitem>
253 </varlistentry>
254
255 <varlistentry id="e2label">
256 <term><command>e2label</command></term>
257 <listitem>
258 <para>Displays or changes the file system label on the <systemitem
259 class="filesystem">ext2</systemitem> file system present on a given
260 device</para>
261 <indexterm zone="ch-system-e2fsprogs e2label">
262 <primary sortas="b-e2label">e2label</primary>
263 </indexterm>
264 </listitem>
265 </varlistentry>
266
267 <varlistentry id="e2mmpstatus">
268 <term><command>e2mmpstatus</command></term>
269 <listitem>
270 <para>Checks MMP status of an ext4 filesystem</para>
271 <indexterm zone="ch-system-e2fsprogs e2mmpstatus">
272 <primary sortas="b-e2mmpstatus">e2mmpstatus</primary>
273 </indexterm>
274 </listitem>
275 </varlistentry>
276
277 <varlistentry id="e2scrub">
278 <term><command>e2scrub</command></term>
279 <listitem>
280 <para>Checks the contents of a mounted ext[234] filesystem</para>
281 <indexterm zone="ch-system-e2fsprogs e2scrub">
282 <primary sortas="b-e2scrub">e2scrub</primary>
283 </indexterm>
284 </listitem>
285 </varlistentry>
286
287 <varlistentry id="e2scrub_all">
288 <term><command>e2scrub_all</command></term>
289 <listitem>
290 <para>Checks all mounted ext[234] filesystems for errors</para>
291 <indexterm zone="ch-system-e2fsprogs e2scrub_all">
292 <primary sortas="b-e2scrub_all">e2scrub_all</primary>
293 </indexterm>
294 </listitem>
295 </varlistentry>
296
297 <varlistentry id="e2undo">
298 <term><command>e2undo</command></term>
299 <listitem>
300 <para>Replays the undo log undo_log for an ext2/ext3/ext4 filesystem
301 found on a device [This can be used to undo a failed operation by an
302 e2fsprogs program.]</para>
303 <indexterm zone="ch-system-e2fsprogs e2undo">
304 <primary sortas="b-e2undo">e2undo</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308
309 <varlistentry id="e4crypt">
310 <term><command>e4crypt</command></term>
311 <listitem>
312 <para>Ext4 filesystem encryption utility</para>
313 <indexterm zone="ch-system-e2fsprogs e4crypt">
314 <primary sortas="b-e4crypt">e4crypt</primary>
315 </indexterm>
316 </listitem>
317 </varlistentry>
318
319 <varlistentry id="e4defrag">
320 <term><command>e4defrag</command></term>
321 <listitem>
322 <para>Online defragmenter for ext4 filesystems</para>
323 <indexterm zone="ch-system-e2fsprogs e4defrag">
324 <primary sortas="b-e4defrag">e4defrag</primary>
325 </indexterm>
326 </listitem>
327 </varlistentry>
328
329 <varlistentry id="filefrag">
330 <term><command>filefrag</command></term>
331 <listitem>
332 <para>Reports on how badly fragmented a particular file might be</para>
333 <indexterm zone="ch-system-e2fsprogs filefrag">
334 <primary sortas="b-filefrag">filefrag</primary>
335 </indexterm>
336 </listitem>
337 </varlistentry>
338
339 <varlistentry id="fsck.ext2">
340 <term><command>fsck.ext2</command></term>
341 <listitem>
342 <para>By default checks <systemitem class="filesystem">ext2</systemitem>
343 file systems and is a hard link to <command>e2fsck</command></para>
344 <indexterm zone="ch-system-e2fsprogs fsck.ext2">
345 <primary sortas="b-fsck.ext2">fsck.ext2</primary>
346 </indexterm>
347 </listitem>
348 </varlistentry>
349
350 <varlistentry id="fsck.ext3">
351 <term><command>fsck.ext3</command></term>
352 <listitem>
353 <para>By default checks <systemitem class="filesystem">ext3</systemitem>
354 file systems and is a hard link to <command>e2fsck</command></para>
355 <indexterm zone="ch-system-e2fsprogs fsck.ext3">
356 <primary sortas="b-fsck.ext3">fsck.ext3</primary>
357 </indexterm>
358 </listitem>
359 </varlistentry>
360
361 <varlistentry id="fsck.ext4">
362 <term><command>fsck.ext4</command></term>
363 <listitem>
364 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
365 file systems and is a hard link to <command>e2fsck</command></para>
366 <indexterm zone="ch-system-e2fsprogs fsck.ext4">
367 <primary sortas="b-fsck.ext4">fsck.ext4</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="mklost-found">
451 <term><command>mklost+found</command></term>
452 <listitem>
453 <para>Used to create a <filename class="directory">lost+found</filename>
454 directory on an <systemitem class="filesystem">ext2</systemitem> file
455 system; it pre-allocates disk blocks to this directory to lighten the
456 task of <command>e2fsck</command></para>
457 <indexterm zone="ch-system-e2fsprogs mklost-found">
458 <primary sortas="b-mklost+found">mklost+found</primary>
459 </indexterm>
460 </listitem>
461 </varlistentry>
462
463 <varlistentry id="resize2fs">
464 <term><command>resize2fs</command></term>
465 <listitem>
466 <para>Can be used to enlarge or shrink an <systemitem
467 class="filesystem">ext2</systemitem> file system</para>
468 <indexterm zone="ch-system-e2fsprogs resize2fs">
469 <primary sortas="b-resize2fs">resize2fs</primary>
470 </indexterm>
471 </listitem>
472 </varlistentry>
473
474 <varlistentry id="tune2fs">
475 <term><command>tune2fs</command></term>
476 <listitem>
477 <para>Adjusts tunable file system parameters on an <systemitem
478 class="filesystem">ext2</systemitem> file system</para>
479 <indexterm zone="ch-system-e2fsprogs tune2fs">
480 <primary sortas="b-tune2fs">tune2fs</primary>
481 </indexterm>
482 </listitem>
483 </varlistentry>
484
485 <varlistentry id="libcom_err">
486 <term><filename class="libraryfile">libcom_err</filename></term>
487 <listitem>
488 <para>The common error display routine</para>
489 <indexterm zone="ch-system-e2fsprogs libcom_err">
490 <primary sortas="c-libcom_err">libcom_err</primary>
491 </indexterm>
492 </listitem>
493 </varlistentry>
494
495 <varlistentry id="libe2p">
496 <term><filename class="libraryfile">libe2p</filename></term>
497 <listitem>
498 <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
499 and <command>lsattr</command></para>
500 <indexterm zone="ch-system-e2fsprogs libe2p">
501 <primary sortas="c-libe2p">libe2p</primary>
502 </indexterm>
503 </listitem>
504 </varlistentry>
505
506 <varlistentry id="libext2fs">
507 <term><filename class="libraryfile">libext2fs</filename></term>
508 <listitem>
509 <para>Contains routines to enable user-level programs to manipulate an
510 <systemitem class="filesystem">ext2</systemitem> file system</para>
511 <indexterm zone="ch-system-e2fsprogs libext2fs">
512 <primary sortas="c-libext2fs">libext2fs</primary>
513 </indexterm>
514 </listitem>
515 </varlistentry>
516
517 <varlistentry id="libss">
518 <term><filename class="libraryfile">libss</filename></term>
519 <listitem>
520 <para>Used by <command>debugfs</command></para>
521 <indexterm zone="ch-system-e2fsprogs libss">
522 <primary sortas="c-libss">libss</primary>
523 </indexterm>
524 </listitem>
525 </varlistentry>
526
527 </variablelist>
528
529 </sect2>
530
531</sect1>
Note: See TracBrowser for help on using the repository browser.