source: chapter08/e2fsprogs.xml@ 4049a4b

11.3 12.0 12.0-rc1 12.1 12.1-rc1 bdubbs/gcc13 multilib renodr/libudev-from-systemd trunk xry111/arm64 xry111/arm64-12.0 xry111/clfs-ng xry111/loongarch xry111/loongarch-12.0 xry111/loongarch-12.1 xry111/mips64el xry111/update-glibc
Last change on this file since 4049a4b was 4049a4b, checked in by Xi Ruoyao <xry111@…>, 15 months ago

e2fsprogs: Add configuration section about mke2fs.conf
  • Property mode set to 100644
File size: 20.9 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>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 <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="conf-e2fsprogs" role="configuration">
138 <title>Configuring E2fsprogs</title>
139
140 <indexterm zone="conf-e2fsprogs">
141 <primary sortas="e-/etc/mke2fs.conf">/etc/mke2fs.conf</primary>
142 </indexterm>
143
144 <para>
145 <filename>/etc/mke2fs.conf</filename> contains the default value of
146 various command line options of <command>mke2fs</command>. You may
147 edit the file to make the default values suitable for your need.
148 For example, some utilities (not in LFS or BLFS) cannot recognize a
149 <systemitem class='filesystem'>ext4</systemitem> file system with
150 <literal>metadata_csum_seed</literal> feature enabled.
151 <emphasis role='bold'>If</emphasis> you need such an utility, you may
152 remove the feature from the default
153 <systemitem class='filesystem'>ext4</systemitem> feature list with the
154 command:
155 </para>
156
157 <screen role='nodump'><userinput>sed 's/metadata_csum_seed,//' -i /etc/mke2fs.conf</userinput></screen>
158
159 <para>
160 Read the man page <filename>mke2fs.conf(5)</filename> for details.
161 </para>
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 <systemitem
206 class="filesystem">ext{234}</systemitem> file systems</para>
207 <indexterm zone="ch-system-e2fsprogs chattr">
208 <primary sortas="b-chattr">chattr</primary>
209 </indexterm>
210 </listitem>
211 </varlistentry>
212
213 <varlistentry id="compile_et">
214 <term><command>compile_et</command></term>
215 <listitem>
216 <para>An error table compiler; it converts a table of error-code
217 names and messages into a C source file suitable for use with the
218 <filename class="libraryfile">com_err</filename> library</para>
219 <indexterm zone="ch-system-e2fsprogs compile_et">
220 <primary sortas="b-compile_et">compile_et</primary>
221 </indexterm>
222 </listitem>
223 </varlistentry>
224
225 <varlistentry id="debugfs">
226 <term><command>debugfs</command></term>
227 <listitem>
228 <para>A file system debugger; it can be used to examine and change
229 the state of <systemitem class="filesystem">ext{234}</systemitem>
230 file systems</para>
231 <indexterm zone="ch-system-e2fsprogs debugfs">
232 <primary sortas="b-debugfs">debugfs</primary>
233 </indexterm>
234 </listitem>
235 </varlistentry>
236
237 <varlistentry id="dumpe2fs">
238 <term><command>dumpe2fs</command></term>
239 <listitem>
240 <para>Prints the super block and blocks group information for the
241 file system present on a given device</para>
242 <indexterm zone="ch-system-e2fsprogs dumpe2fs">
243 <primary sortas="b-dumpe2fs">dumpe2fs</primary>
244 </indexterm>
245 </listitem>
246 </varlistentry>
247
248 <varlistentry id="e2freefrag">
249 <term><command>e2freefrag</command></term>
250 <listitem>
251 <para>Reports free space fragmentation information</para>
252 <indexterm zone="ch-system-e2fsprogs e2freefrag">
253 <primary sortas="b-e2freefrag">e2freefrag</primary>
254 </indexterm>
255 </listitem>
256 </varlistentry>
257
258 <varlistentry id="e2fsck">
259 <term><command>e2fsck</command></term>
260 <listitem>
261 <para>Is used to check and optionally repair <systemitem
262 class="filesystem">ext{234}</systemitem> file systems</para>
263 <indexterm zone="ch-system-e2fsprogs e2fsck">
264 <primary sortas="b-e2fsck">e2fsck</primary>
265 </indexterm>
266 </listitem>
267 </varlistentry>
268
269 <varlistentry id="e2image">
270 <term><command>e2image</command></term>
271 <listitem>
272 <para>Is used to save critical <systemitem
273 class="filesystem">ext{234}</systemitem> file system data to a file</para>
274 <indexterm zone="ch-system-e2fsprogs e2image">
275 <primary sortas="b-e2image">e2image</primary>
276 </indexterm>
277 </listitem>
278 </varlistentry>
279
280 <varlistentry id="e2label">
281 <term><command>e2label</command></term>
282 <listitem>
283 <para>Displays or changes the file system label on the <systemitem
284 class="filesystem">ext{234}</systemitem> file system on a given
285 device</para>
286 <indexterm zone="ch-system-e2fsprogs e2label">
287 <primary sortas="b-e2label">e2label</primary>
288 </indexterm>
289 </listitem>
290 </varlistentry>
291
292 <varlistentry id="e2mmpstatus">
293 <term><command>e2mmpstatus</command></term>
294 <listitem>
295 <para>Checks MMP (Multiple Mount Protection) status of an <systemitem
296 class="filesystem">ext4</systemitem> file system</para>
297 <indexterm zone="ch-system-e2fsprogs e2mmpstatus">
298 <primary sortas="b-e2mmpstatus">e2mmpstatus</primary>
299 </indexterm>
300 </listitem>
301 </varlistentry>
302
303 <varlistentry id="e2scrub">
304 <term><command>e2scrub</command></term>
305 <listitem>
306 <para>Checks the contents of a mounted <systemitem
307 class="filesystem">ext{234}</systemitem> file system</para>
308 <indexterm zone="ch-system-e2fsprogs e2scrub">
309 <primary sortas="b-e2scrub">e2scrub</primary>
310 </indexterm>
311 </listitem>
312 </varlistentry>
313
314 <varlistentry id="e2scrub_all">
315 <term><command>e2scrub_all</command></term>
316 <listitem>
317 <para>Checks all mounted <systemitem class="filesystem">ext{234}</systemitem>
318 file systems for errors</para>
319 <indexterm zone="ch-system-e2fsprogs e2scrub_all">
320 <primary sortas="b-e2scrub_all">e2scrub_all</primary>
321 </indexterm>
322 </listitem>
323 </varlistentry>
324
325 <varlistentry id="e2undo">
326 <term><command>e2undo</command></term>
327 <listitem>
328 <para>Replays the undo log for an <systemitem
329 class="filesystem">ext{234}</systemitem> file system
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><systemitem class="filesystem">Ext4</systemitem>
342 file system encryption utility</para>
343 <indexterm zone="ch-system-e2fsprogs e4crypt">
344 <primary sortas="b-e4crypt">e4crypt</primary>
345 </indexterm>
346 </listitem>
347 </varlistentry>
348
349 <varlistentry id="e4defrag">
350 <term><command>e4defrag</command></term>
351 <listitem>
352 <para>Online defragmenter for <systemitem
353 class="filesystem">ext4</systemitem> file systems</para>
354 <indexterm zone="ch-system-e2fsprogs e4defrag">
355 <primary sortas="b-e4defrag">e4defrag</primary>
356 </indexterm>
357 </listitem>
358 </varlistentry>
359
360 <varlistentry id="filefrag">
361 <term><command>filefrag</command></term>
362 <listitem>
363 <para>Reports on how badly fragmented a particular file might be</para>
364 <indexterm zone="ch-system-e2fsprogs filefrag">
365 <primary sortas="b-filefrag">filefrag</primary>
366 </indexterm>
367 </listitem>
368 </varlistentry>
369
370 <varlistentry id="fsck.ext2">
371 <term><command>fsck.ext2</command></term>
372 <listitem>
373 <para>By default checks <systemitem class="filesystem">ext2</systemitem>
374 file systems and is a hard link to <command>e2fsck</command></para>
375 <indexterm zone="ch-system-e2fsprogs fsck.ext2">
376 <primary sortas="b-fsck.ext2">fsck.ext2</primary>
377 </indexterm>
378 </listitem>
379 </varlistentry>
380
381 <varlistentry id="fsck.ext3">
382 <term><command>fsck.ext3</command></term>
383 <listitem>
384 <para>By default checks <systemitem class="filesystem">ext3</systemitem>
385 file systems and is a hard link to <command>e2fsck</command></para>
386 <indexterm zone="ch-system-e2fsprogs fsck.ext3">
387 <primary sortas="b-fsck.ext3">fsck.ext3</primary>
388 </indexterm>
389 </listitem>
390 </varlistentry>
391
392 <varlistentry id="fsck.ext4">
393 <term><command>fsck.ext4</command></term>
394 <listitem>
395 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
396 file systems and is a hard link to <command>e2fsck</command></para>
397 <indexterm zone="ch-system-e2fsprogs fsck.ext4">
398 <primary sortas="b-fsck.ext4">fsck.ext4</primary>
399 </indexterm>
400 </listitem>
401 </varlistentry>
402
403 <varlistentry id="logsave">
404 <term><command>logsave</command></term>
405 <listitem>
406 <para>Saves the output of a command in a log file</para>
407 <indexterm zone="ch-system-e2fsprogs logsave">
408 <primary sortas="b-logsave">logsave</primary>
409 </indexterm>
410 </listitem>
411 </varlistentry>
412
413 <varlistentry id="lsattr">
414 <term><command>lsattr</command></term>
415 <listitem>
416 <para>Lists the attributes of files on a second extended file
417 system</para>
418 <indexterm zone="ch-system-e2fsprogs lsattr">
419 <primary sortas="b-lsattr">lsattr</primary>
420 </indexterm>
421 </listitem>
422 </varlistentry>
423
424 <varlistentry id="mk_cmds">
425 <term><command>mk_cmds</command></term>
426 <listitem>
427 <para>Converts a table of command names and help messages into a C
428 source file suitable for use with the <filename
429 class="libraryfile">libss</filename> subsystem library</para>
430 <indexterm zone="ch-system-e2fsprogs mk_cmds">
431 <primary sortas="b-mk_cmds">mk_cmds</primary>
432 </indexterm>
433 </listitem>
434 </varlistentry>
435
436 <varlistentry id="mke2fs">
437 <term><command>mke2fs</command></term>
438 <listitem>
439 <para>Creates an <systemitem class="filesystem">ext{234}</systemitem>
440 file system on the given device</para>
441 <indexterm zone="ch-system-e2fsprogs mke2fs">
442 <primary sortas="b-mke2fs">mke2fs</primary>
443 </indexterm>
444 </listitem>
445 </varlistentry>
446
447 <varlistentry id="mkfs.ext2">
448 <term><command>mkfs.ext2</command></term>
449 <listitem>
450 <para>By default creates <systemitem class="filesystem">ext2</systemitem>
451 file systems and is a hard link to <command>mke2fs</command></para>
452 <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
453 <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
454 </indexterm>
455 </listitem>
456 </varlistentry>
457
458 <varlistentry id="mkfs.ext3">
459 <term><command>mkfs.ext3</command></term>
460 <listitem>
461 <para>By default creates <systemitem class="filesystem">ext3</systemitem>
462 file systems and is a hard link to <command>mke2fs</command></para>
463 <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
464 <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
465 </indexterm>
466 </listitem>
467 </varlistentry>
468
469 <varlistentry id="mkfs.ext4">
470 <term><command>mkfs.ext4</command></term>
471 <listitem>
472 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
473 file systems and is a hard link to <command>mke2fs</command></para>
474 <indexterm zone="ch-system-e2fsprogs mkfs.ext4">
475 <primary sortas="b-mkfs.ext4">mkfs.ext4</primary>
476 </indexterm>
477 </listitem>
478 </varlistentry>
479
480 <varlistentry id="mklost-found">
481 <term><command>mklost+found</command></term>
482 <listitem>
483 <para>Creates a <filename class="directory">lost+found</filename>
484 directory on an <systemitem class="filesystem">ext{234}</systemitem> file
485 system; it pre-allocates disk blocks to this directory to lighten the
486 task of <command>e2fsck</command></para>
487 <indexterm zone="ch-system-e2fsprogs mklost-found">
488 <primary sortas="b-mklost+found">mklost+found</primary>
489 </indexterm>
490 </listitem>
491 </varlistentry>
492
493 <varlistentry id="resize2fs">
494 <term><command>resize2fs</command></term>
495 <listitem>
496 <para>Can be used to enlarge or shrink <systemitem
497 class="filesystem">ext{234}</systemitem> file systems</para>
498 <indexterm zone="ch-system-e2fsprogs resize2fs">
499 <primary sortas="b-resize2fs">resize2fs</primary>
500 </indexterm>
501 </listitem>
502 </varlistentry>
503
504 <varlistentry id="tune2fs">
505 <term><command>tune2fs</command></term>
506 <listitem>
507 <para>Adjusts tunable file system parameters on <systemitem
508 class="filesystem">ext{234}</systemitem> file systems</para>
509 <indexterm zone="ch-system-e2fsprogs tune2fs">
510 <primary sortas="b-tune2fs">tune2fs</primary>
511 </indexterm>
512 </listitem>
513 </varlistentry>
514
515 <varlistentry id="libcom_err">
516 <term><filename class="libraryfile">libcom_err</filename></term>
517 <listitem>
518 <para>The common error display routine</para>
519 <indexterm zone="ch-system-e2fsprogs libcom_err">
520 <primary sortas="c-libcom_err">libcom_err</primary>
521 </indexterm>
522 </listitem>
523 </varlistentry>
524
525 <varlistentry id="libe2p">
526 <term><filename class="libraryfile">libe2p</filename></term>
527 <listitem>
528 <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
529 and <command>lsattr</command></para>
530 <indexterm zone="ch-system-e2fsprogs libe2p">
531 <primary sortas="c-libe2p">libe2p</primary>
532 </indexterm>
533 </listitem>
534 </varlistentry>
535
536 <varlistentry id="libext2fs">
537 <term><filename class="libraryfile">libext2fs</filename></term>
538 <listitem>
539 <para>Contains routines to enable user-level programs to manipulate
540 <systemitem class="filesystem">ext{234}</systemitem> file systems</para>
541 <indexterm zone="ch-system-e2fsprogs libext2fs">
542 <primary sortas="c-libext2fs">libext2fs</primary>
543 </indexterm>
544 </listitem>
545 </varlistentry>
546
547 <varlistentry id="libss">
548 <term><filename class="libraryfile">libss</filename></term>
549 <listitem>
550 <para>Used by <command>debugfs</command></para>
551 <indexterm zone="ch-system-e2fsprogs libss">
552 <primary sortas="c-libss">libss</primary>
553 </indexterm>
554 </listitem>
555 </varlistentry>
556
557 </variablelist>
558
559 </sect2>
560
561</sect1>
Note: See TracBrowser for help on using the repository browser.