source: chapter08/e2fsprogs.xml@ 9ac6ff5

12.1 12.1-rc1 multilib trunk xry111/arm64 xry111/clfs-ng xry111/loongarch xry111/loongarch-12.1 xry111/mips64el xry111/update-glibc
Last change on this file since 9ac6ff5 was 7152faa, checked in by Pierre Labastie <pierre.labastie@…>, 3 months ago

Change all xml files to utf-8 encoding
  • Property mode set to 100644
File size: 20.9 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
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>These prevent 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; 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 <!-- https://github.com/tytso/e2fsprogs/issues/134 -->
97 <para>One test named <filename>m_assume_storage_prezeroed</filename>
98 is known to fail.</para>
99
100<!-- This is a ridiculous amount now! And is it still true?
101 Does not appear to be true for version 1.46.3. Time with tests
102 26 seconds with tests (With lots of cores and ram and an ssd disk).
103
104 <para>One of the e2fsprogs tests will attempt to allocate 256 MB of memory.
105 If you do not have significantly more RAM than this, be sure to enable
106 sufficient swap space for the test. See <xref
107 linkend="ch-partitioning-creatingfilesystem"/> and <xref
108 linkend="ch-partitioning-mounting"/>
109 for details on creating and enabling swap space.</para>
110
111 <para>On a spinning disk, the tests take a little more than 4 SBUs. They
112 can be much shorter on an SSD (down to about 1.5 SBUs).</para>
113-->
114 <para>Install the package:</para>
115
116<screen><userinput remap="install">make install</userinput></screen>
117
118 <para>Remove useless static libraries:</para>
119
120<screen><userinput remap="install">rm -fv /usr/lib/{libcom_err,libe2p,libext2fs,libss}.a</userinput></screen>
121
122 <para>This package installs a gzipped
123 <filename class="extension">.info</filename> file but doesn't update the
124 system-wide <filename>dir</filename> file. Unzip this file and then update
125 the system <filename>dir</filename> file using the following
126 commands:</para>
127
128<screen><userinput remap="install">gunzip -v /usr/share/info/libext2fs.info.gz
129install-info --dir-file=/usr/share/info/dir /usr/share/info/libext2fs.info</userinput></screen>
130
131 <para>If desired, create and install some additional documentation by
132 issuing the following commands:</para>
133
134<screen><userinput remap="install">makeinfo -o doc/com_err.info ../lib/et/com_err.texinfo
135install -v -m644 doc/com_err.info /usr/share/info
136install-info --dir-file=/usr/share/info/dir /usr/share/info/com_err.info</userinput></screen>
137 </sect2>
138
139 <sect2 id="conf-e2fsprogs" role="configuration">
140 <title>Configuring E2fsprogs</title>
141
142 <indexterm zone="conf-e2fsprogs">
143 <primary sortas="e-/etc/mke2fs.conf">/etc/mke2fs.conf</primary>
144 </indexterm>
145
146 <para>
147 <filename>/etc/mke2fs.conf</filename> contains the default value of
148 various command line options of <command>mke2fs</command>. You may
149 edit the file to make the default values suitable for your need.
150 For example, some utilities (not in LFS or BLFS) cannot recognize a
151 <systemitem class='filesystem'>ext4</systemitem> file system with
152 <literal>metadata_csum_seed</literal> feature enabled.
153 <emphasis role='bold'>If</emphasis> you need such an utility, you may
154 remove the feature from the default
155 <systemitem class='filesystem'>ext4</systemitem> feature list with the
156 command:
157 </para>
158
159 <screen role='nodump'><userinput>sed 's/metadata_csum_seed,//' -i /etc/mke2fs.conf</userinput></screen>
160
161 <para>
162 Read the man page <filename>mke2fs.conf(5)</filename> for details.
163 </para>
164 </sect2>
165
166 <sect2 id="contents-e2fsprogs" role="content">
167 <title>Contents of E2fsprogs</title>
168
169 <segmentedlist>
170 <segtitle>Installed programs</segtitle>
171 <segtitle>Installed libraries</segtitle>
172 <segtitle>Installed directories</segtitle>
173
174 <seglistitem>
175 <seg>badblocks, chattr, compile_et, debugfs, dumpe2fs, e2freefrag,
176 e2fsck, e2image, e2label, e2mmpstatus, e2scrub, e2scrub_all, e2undo,
177 e4crypt, e4defrag, filefrag, fsck.ext2,
178 fsck.ext3, fsck.ext4, logsave, lsattr, mk_cmds, mke2fs,
179 mkfs.ext2, mkfs.ext3, mkfs.ext4, mklost+found,
180 resize2fs, and tune2fs</seg>
181 <seg>libcom_err.so, libe2p.so, libext2fs.so, and libss.so</seg>
182 <seg>/usr/include/e2p, /usr/include/et, /usr/include/ext2fs,
183 /usr/include/ss, /usr/lib/e2fsprogs, /usr/share/et, and
184 /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 <systemitem
208 class="filesystem">ext{234}</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 <systemitem class="filesystem">ext{234}</systemitem>
232 file systems</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">ext{234}</systemitem> file systems</para>
265 <indexterm zone="ch-system-e2fsprogs e2fsck">
266 <primary sortas="b-e2fsck">e2fsck</primary>
267 </indexterm>
268 </listitem>
269 </varlistentry>
270
271 <varlistentry id="e2image">
272 <term><command>e2image</command></term>
273 <listitem>
274 <para>Is used to save critical <systemitem
275 class="filesystem">ext{234}</systemitem> file system data to a file</para>
276 <indexterm zone="ch-system-e2fsprogs e2image">
277 <primary sortas="b-e2image">e2image</primary>
278 </indexterm>
279 </listitem>
280 </varlistentry>
281
282 <varlistentry id="e2label">
283 <term><command>e2label</command></term>
284 <listitem>
285 <para>Displays or changes the file system label on the <systemitem
286 class="filesystem">ext{234}</systemitem> file system on a given
287 device</para>
288 <indexterm zone="ch-system-e2fsprogs e2label">
289 <primary sortas="b-e2label">e2label</primary>
290 </indexterm>
291 </listitem>
292 </varlistentry>
293
294 <varlistentry id="e2mmpstatus">
295 <term><command>e2mmpstatus</command></term>
296 <listitem>
297 <para>Checks MMP (Multiple Mount Protection) status of an <systemitem
298 class="filesystem">ext4</systemitem> file system</para>
299 <indexterm zone="ch-system-e2fsprogs e2mmpstatus">
300 <primary sortas="b-e2mmpstatus">e2mmpstatus</primary>
301 </indexterm>
302 </listitem>
303 </varlistentry>
304
305 <varlistentry id="e2scrub">
306 <term><command>e2scrub</command></term>
307 <listitem>
308 <para>Checks the contents of a mounted <systemitem
309 class="filesystem">ext{234}</systemitem> file system</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 <systemitem class="filesystem">ext{234}</systemitem>
320 file systems for errors</para>
321 <indexterm zone="ch-system-e2fsprogs e2scrub_all">
322 <primary sortas="b-e2scrub_all">e2scrub_all</primary>
323 </indexterm>
324 </listitem>
325 </varlistentry>
326
327 <varlistentry id="e2undo">
328 <term><command>e2undo</command></term>
329 <listitem>
330 <para>Replays the undo log for an <systemitem
331 class="filesystem">ext{234}</systemitem> file system
332 found on a device. [This can be used to undo a failed operation by an
333 E2fsprogs program.]</para>
334 <indexterm zone="ch-system-e2fsprogs e2undo">
335 <primary sortas="b-e2undo">e2undo</primary>
336 </indexterm>
337 </listitem>
338 </varlistentry>
339
340 <varlistentry id="e4crypt">
341 <term><command>e4crypt</command></term>
342 <listitem>
343 <para><systemitem class="filesystem">Ext4</systemitem>
344 file system encryption utility</para>
345 <indexterm zone="ch-system-e2fsprogs e4crypt">
346 <primary sortas="b-e4crypt">e4crypt</primary>
347 </indexterm>
348 </listitem>
349 </varlistentry>
350
351 <varlistentry id="e4defrag">
352 <term><command>e4defrag</command></term>
353 <listitem>
354 <para>Online defragmenter for <systemitem
355 class="filesystem">ext4</systemitem> file systems</para>
356 <indexterm zone="ch-system-e2fsprogs e4defrag">
357 <primary sortas="b-e4defrag">e4defrag</primary>
358 </indexterm>
359 </listitem>
360 </varlistentry>
361
362 <varlistentry id="filefrag">
363 <term><command>filefrag</command></term>
364 <listitem>
365 <para>Reports on how badly fragmented a particular file might be</para>
366 <indexterm zone="ch-system-e2fsprogs filefrag">
367 <primary sortas="b-filefrag">filefrag</primary>
368 </indexterm>
369 </listitem>
370 </varlistentry>
371
372 <varlistentry id="fsck.ext2">
373 <term><command>fsck.ext2</command></term>
374 <listitem>
375 <para>By default checks <systemitem class="filesystem">ext2</systemitem>
376 file systems and is a hard link to <command>e2fsck</command></para>
377 <indexterm zone="ch-system-e2fsprogs fsck.ext2">
378 <primary sortas="b-fsck.ext2">fsck.ext2</primary>
379 </indexterm>
380 </listitem>
381 </varlistentry>
382
383 <varlistentry id="fsck.ext3">
384 <term><command>fsck.ext3</command></term>
385 <listitem>
386 <para>By default checks <systemitem class="filesystem">ext3</systemitem>
387 file systems and is a hard link to <command>e2fsck</command></para>
388 <indexterm zone="ch-system-e2fsprogs fsck.ext3">
389 <primary sortas="b-fsck.ext3">fsck.ext3</primary>
390 </indexterm>
391 </listitem>
392 </varlistentry>
393
394 <varlistentry id="fsck.ext4">
395 <term><command>fsck.ext4</command></term>
396 <listitem>
397 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
398 file systems and is a hard link to <command>e2fsck</command></para>
399 <indexterm zone="ch-system-e2fsprogs fsck.ext4">
400 <primary sortas="b-fsck.ext4">fsck.ext4</primary>
401 </indexterm>
402 </listitem>
403 </varlistentry>
404
405 <varlistentry id="logsave">
406 <term><command>logsave</command></term>
407 <listitem>
408 <para>Saves the output of a command in a log file</para>
409 <indexterm zone="ch-system-e2fsprogs logsave">
410 <primary sortas="b-logsave">logsave</primary>
411 </indexterm>
412 </listitem>
413 </varlistentry>
414
415 <varlistentry id="lsattr">
416 <term><command>lsattr</command></term>
417 <listitem>
418 <para>Lists the attributes of files on a second extended file
419 system</para>
420 <indexterm zone="ch-system-e2fsprogs lsattr">
421 <primary sortas="b-lsattr">lsattr</primary>
422 </indexterm>
423 </listitem>
424 </varlistentry>
425
426 <varlistentry id="mk_cmds">
427 <term><command>mk_cmds</command></term>
428 <listitem>
429 <para>Converts a table of command names and help messages into a C
430 source file suitable for use with the <filename
431 class="libraryfile">libss</filename> subsystem library</para>
432 <indexterm zone="ch-system-e2fsprogs mk_cmds">
433 <primary sortas="b-mk_cmds">mk_cmds</primary>
434 </indexterm>
435 </listitem>
436 </varlistentry>
437
438 <varlistentry id="mke2fs">
439 <term><command>mke2fs</command></term>
440 <listitem>
441 <para>Creates an <systemitem class="filesystem">ext{234}</systemitem>
442 file system on the given device</para>
443 <indexterm zone="ch-system-e2fsprogs mke2fs">
444 <primary sortas="b-mke2fs">mke2fs</primary>
445 </indexterm>
446 </listitem>
447 </varlistentry>
448
449 <varlistentry id="mkfs.ext2">
450 <term><command>mkfs.ext2</command></term>
451 <listitem>
452 <para>By default creates <systemitem class="filesystem">ext2</systemitem>
453 file systems and is a hard link to <command>mke2fs</command></para>
454 <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
455 <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
456 </indexterm>
457 </listitem>
458 </varlistentry>
459
460 <varlistentry id="mkfs.ext3">
461 <term><command>mkfs.ext3</command></term>
462 <listitem>
463 <para>By default creates <systemitem class="filesystem">ext3</systemitem>
464 file systems and is a hard link to <command>mke2fs</command></para>
465 <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
466 <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
467 </indexterm>
468 </listitem>
469 </varlistentry>
470
471 <varlistentry id="mkfs.ext4">
472 <term><command>mkfs.ext4</command></term>
473 <listitem>
474 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
475 file systems and is a hard link to <command>mke2fs</command></para>
476 <indexterm zone="ch-system-e2fsprogs mkfs.ext4">
477 <primary sortas="b-mkfs.ext4">mkfs.ext4</primary>
478 </indexterm>
479 </listitem>
480 </varlistentry>
481
482 <varlistentry id="mklost-found">
483 <term><command>mklost+found</command></term>
484 <listitem>
485 <para>Creates a <filename class="directory">lost+found</filename>
486 directory on an <systemitem class="filesystem">ext{234}</systemitem> file
487 system; it pre-allocates disk blocks to this directory to lighten the
488 task of <command>e2fsck</command></para>
489 <indexterm zone="ch-system-e2fsprogs mklost-found">
490 <primary sortas="b-mklost+found">mklost+found</primary>
491 </indexterm>
492 </listitem>
493 </varlistentry>
494
495 <varlistentry id="resize2fs">
496 <term><command>resize2fs</command></term>
497 <listitem>
498 <para>Can be used to enlarge or shrink <systemitem
499 class="filesystem">ext{234}</systemitem> file systems</para>
500 <indexterm zone="ch-system-e2fsprogs resize2fs">
501 <primary sortas="b-resize2fs">resize2fs</primary>
502 </indexterm>
503 </listitem>
504 </varlistentry>
505
506 <varlistentry id="tune2fs">
507 <term><command>tune2fs</command></term>
508 <listitem>
509 <para>Adjusts tunable file system parameters on <systemitem
510 class="filesystem">ext{234}</systemitem> file systems</para>
511 <indexterm zone="ch-system-e2fsprogs tune2fs">
512 <primary sortas="b-tune2fs">tune2fs</primary>
513 </indexterm>
514 </listitem>
515 </varlistentry>
516
517 <varlistentry id="libcom_err">
518 <term><filename class="libraryfile">libcom_err</filename></term>
519 <listitem>
520 <para>The common error display routine</para>
521 <indexterm zone="ch-system-e2fsprogs libcom_err">
522 <primary sortas="c-libcom_err">libcom_err</primary>
523 </indexterm>
524 </listitem>
525 </varlistentry>
526
527 <varlistentry id="libe2p">
528 <term><filename class="libraryfile">libe2p</filename></term>
529 <listitem>
530 <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
531 and <command>lsattr</command></para>
532 <indexterm zone="ch-system-e2fsprogs libe2p">
533 <primary sortas="c-libe2p">libe2p</primary>
534 </indexterm>
535 </listitem>
536 </varlistentry>
537
538 <varlistentry id="libext2fs">
539 <term><filename class="libraryfile">libext2fs</filename></term>
540 <listitem>
541 <para>Contains routines to enable user-level programs to manipulate
542 <systemitem class="filesystem">ext{234}</systemitem> file systems</para>
543 <indexterm zone="ch-system-e2fsprogs libext2fs">
544 <primary sortas="c-libext2fs">libext2fs</primary>
545 </indexterm>
546 </listitem>
547 </varlistentry>
548
549 <varlistentry id="libss">
550 <term><filename class="libraryfile">libss</filename></term>
551 <listitem>
552 <para>Used by <command>debugfs</command></para>
553 <indexterm zone="ch-system-e2fsprogs libss">
554 <primary sortas="c-libss">libss</primary>
555 </indexterm>
556 </listitem>
557 </varlistentry>
558
559 </variablelist>
560
561 </sect2>
562
563</sect1>
Note: See TracBrowser for help on using the repository browser.