source: chapter08/e2fsprogs.xml

trunk
Last change on this file was ea93c11, checked in by Xi Ruoyao <xry111@…>, 3 months ago

treewide: Use <ulink> instead of <filename> for man pages

"gcc(1)" is really not a file name.

Use <ulink> and link to the online man page on
​https://man.archlinux.org/ so the user can refer to the man pages more
easily.

The change is done via a sed command and long lines are wrapped
manually.
  • Property mode set to 100644
File size: 21.0 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 <ulink role='man'
163 url='&man;mke2fs.conf.5'>mke2fs.conf(5)</ulink> for details.
164 </para>
165 </sect2>
166
167 <sect2 id="contents-e2fsprogs" role="content">
168 <title>Contents of E2fsprogs</title>
169
170 <segmentedlist>
171 <segtitle>Installed programs</segtitle>
172 <segtitle>Installed libraries</segtitle>
173 <segtitle>Installed directories</segtitle>
174
175 <seglistitem>
176 <seg>badblocks, chattr, compile_et, debugfs, dumpe2fs, e2freefrag,
177 e2fsck, e2image, e2label, e2mmpstatus, e2scrub, e2scrub_all, e2undo,
178 e4crypt, e4defrag, filefrag, fsck.ext2,
179 fsck.ext3, fsck.ext4, logsave, lsattr, mk_cmds, mke2fs,
180 mkfs.ext2, mkfs.ext3, mkfs.ext4, mklost+found,
181 resize2fs, and tune2fs</seg>
182 <seg>libcom_err.so, libe2p.so, libext2fs.so, and libss.so</seg>
183 <seg>/usr/include/e2p, /usr/include/et, /usr/include/ext2fs,
184 /usr/include/ss, /usr/lib/e2fsprogs, /usr/share/et, and
185 /usr/share/ss</seg>
186 </seglistitem>
187 </segmentedlist>
188
189 <variablelist>
190 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
191 <?dbfo list-presentation="list"?>
192 <?dbhtml list-presentation="table"?>
193
194 <varlistentry id="badblocks">
195 <term><command>badblocks</command></term>
196 <listitem>
197 <para>Searches a device (usually a disk partition) for bad
198 blocks</para>
199 <indexterm zone="ch-system-e2fsprogs badblocks">
200 <primary sortas="b-badblocks">badblocks</primary>
201 </indexterm>
202 </listitem>
203 </varlistentry>
204
205 <varlistentry id="chattr">
206 <term><command>chattr</command></term>
207 <listitem>
208 <para>Changes the attributes of files on <systemitem
209 class="filesystem">ext{234}</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 <systemitem class="filesystem">ext{234}</systemitem>
233 file systems</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">ext{234}</systemitem> file systems</para>
266 <indexterm zone="ch-system-e2fsprogs e2fsck">
267 <primary sortas="b-e2fsck">e2fsck</primary>
268 </indexterm>
269 </listitem>
270 </varlistentry>
271
272 <varlistentry id="e2image">
273 <term><command>e2image</command></term>
274 <listitem>
275 <para>Is used to save critical <systemitem
276 class="filesystem">ext{234}</systemitem> file system data to a file</para>
277 <indexterm zone="ch-system-e2fsprogs e2image">
278 <primary sortas="b-e2image">e2image</primary>
279 </indexterm>
280 </listitem>
281 </varlistentry>
282
283 <varlistentry id="e2label">
284 <term><command>e2label</command></term>
285 <listitem>
286 <para>Displays or changes the file system label on the <systemitem
287 class="filesystem">ext{234}</systemitem> file system on a given
288 device</para>
289 <indexterm zone="ch-system-e2fsprogs e2label">
290 <primary sortas="b-e2label">e2label</primary>
291 </indexterm>
292 </listitem>
293 </varlistentry>
294
295 <varlistentry id="e2mmpstatus">
296 <term><command>e2mmpstatus</command></term>
297 <listitem>
298 <para>Checks MMP (Multiple Mount Protection) status of an <systemitem
299 class="filesystem">ext4</systemitem> file system</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 <systemitem
310 class="filesystem">ext{234}</systemitem> file system</para>
311 <indexterm zone="ch-system-e2fsprogs e2scrub">
312 <primary sortas="b-e2scrub">e2scrub</primary>
313 </indexterm>
314 </listitem>
315 </varlistentry>
316
317 <varlistentry id="e2scrub_all">
318 <term><command>e2scrub_all</command></term>
319 <listitem>
320 <para>Checks all mounted <systemitem class="filesystem">ext{234}</systemitem>
321 file systems for errors</para>
322 <indexterm zone="ch-system-e2fsprogs e2scrub_all">
323 <primary sortas="b-e2scrub_all">e2scrub_all</primary>
324 </indexterm>
325 </listitem>
326 </varlistentry>
327
328 <varlistentry id="e2undo">
329 <term><command>e2undo</command></term>
330 <listitem>
331 <para>Replays the undo log for an <systemitem
332 class="filesystem">ext{234}</systemitem> file system
333 found on a device. [This can be used to undo a failed operation by an
334 E2fsprogs program.]</para>
335 <indexterm zone="ch-system-e2fsprogs e2undo">
336 <primary sortas="b-e2undo">e2undo</primary>
337 </indexterm>
338 </listitem>
339 </varlistentry>
340
341 <varlistentry id="e4crypt">
342 <term><command>e4crypt</command></term>
343 <listitem>
344 <para><systemitem class="filesystem">Ext4</systemitem>
345 file system encryption utility</para>
346 <indexterm zone="ch-system-e2fsprogs e4crypt">
347 <primary sortas="b-e4crypt">e4crypt</primary>
348 </indexterm>
349 </listitem>
350 </varlistentry>
351
352 <varlistentry id="e4defrag">
353 <term><command>e4defrag</command></term>
354 <listitem>
355 <para>Online defragmenter for <systemitem
356 class="filesystem">ext4</systemitem> file systems</para>
357 <indexterm zone="ch-system-e2fsprogs e4defrag">
358 <primary sortas="b-e4defrag">e4defrag</primary>
359 </indexterm>
360 </listitem>
361 </varlistentry>
362
363 <varlistentry id="filefrag">
364 <term><command>filefrag</command></term>
365 <listitem>
366 <para>Reports on how badly fragmented a particular file might be</para>
367 <indexterm zone="ch-system-e2fsprogs filefrag">
368 <primary sortas="b-filefrag">filefrag</primary>
369 </indexterm>
370 </listitem>
371 </varlistentry>
372
373 <varlistentry id="fsck.ext2">
374 <term><command>fsck.ext2</command></term>
375 <listitem>
376 <para>By default checks <systemitem class="filesystem">ext2</systemitem>
377 file systems and is a hard link to <command>e2fsck</command></para>
378 <indexterm zone="ch-system-e2fsprogs fsck.ext2">
379 <primary sortas="b-fsck.ext2">fsck.ext2</primary>
380 </indexterm>
381 </listitem>
382 </varlistentry>
383
384 <varlistentry id="fsck.ext3">
385 <term><command>fsck.ext3</command></term>
386 <listitem>
387 <para>By default checks <systemitem class="filesystem">ext3</systemitem>
388 file systems and is a hard link to <command>e2fsck</command></para>
389 <indexterm zone="ch-system-e2fsprogs fsck.ext3">
390 <primary sortas="b-fsck.ext3">fsck.ext3</primary>
391 </indexterm>
392 </listitem>
393 </varlistentry>
394
395 <varlistentry id="fsck.ext4">
396 <term><command>fsck.ext4</command></term>
397 <listitem>
398 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
399 file systems and is a hard link to <command>e2fsck</command></para>
400 <indexterm zone="ch-system-e2fsprogs fsck.ext4">
401 <primary sortas="b-fsck.ext4">fsck.ext4</primary>
402 </indexterm>
403 </listitem>
404 </varlistentry>
405
406 <varlistentry id="logsave">
407 <term><command>logsave</command></term>
408 <listitem>
409 <para>Saves the output of a command in a log file</para>
410 <indexterm zone="ch-system-e2fsprogs logsave">
411 <primary sortas="b-logsave">logsave</primary>
412 </indexterm>
413 </listitem>
414 </varlistentry>
415
416 <varlistentry id="lsattr">
417 <term><command>lsattr</command></term>
418 <listitem>
419 <para>Lists the attributes of files on a second extended file
420 system</para>
421 <indexterm zone="ch-system-e2fsprogs lsattr">
422 <primary sortas="b-lsattr">lsattr</primary>
423 </indexterm>
424 </listitem>
425 </varlistentry>
426
427 <varlistentry id="mk_cmds">
428 <term><command>mk_cmds</command></term>
429 <listitem>
430 <para>Converts a table of command names and help messages into a C
431 source file suitable for use with the <filename
432 class="libraryfile">libss</filename> subsystem library</para>
433 <indexterm zone="ch-system-e2fsprogs mk_cmds">
434 <primary sortas="b-mk_cmds">mk_cmds</primary>
435 </indexterm>
436 </listitem>
437 </varlistentry>
438
439 <varlistentry id="mke2fs">
440 <term><command>mke2fs</command></term>
441 <listitem>
442 <para>Creates an <systemitem class="filesystem">ext{234}</systemitem>
443 file system on the given device</para>
444 <indexterm zone="ch-system-e2fsprogs mke2fs">
445 <primary sortas="b-mke2fs">mke2fs</primary>
446 </indexterm>
447 </listitem>
448 </varlistentry>
449
450 <varlistentry id="mkfs.ext2">
451 <term><command>mkfs.ext2</command></term>
452 <listitem>
453 <para>By default creates <systemitem class="filesystem">ext2</systemitem>
454 file systems and is a hard link to <command>mke2fs</command></para>
455 <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
456 <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
457 </indexterm>
458 </listitem>
459 </varlistentry>
460
461 <varlistentry id="mkfs.ext3">
462 <term><command>mkfs.ext3</command></term>
463 <listitem>
464 <para>By default creates <systemitem class="filesystem">ext3</systemitem>
465 file systems and is a hard link to <command>mke2fs</command></para>
466 <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
467 <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
468 </indexterm>
469 </listitem>
470 </varlistentry>
471
472 <varlistentry id="mkfs.ext4">
473 <term><command>mkfs.ext4</command></term>
474 <listitem>
475 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
476 file systems and is a hard link to <command>mke2fs</command></para>
477 <indexterm zone="ch-system-e2fsprogs mkfs.ext4">
478 <primary sortas="b-mkfs.ext4">mkfs.ext4</primary>
479 </indexterm>
480 </listitem>
481 </varlistentry>
482
483 <varlistentry id="mklost-found">
484 <term><command>mklost+found</command></term>
485 <listitem>
486 <para>Creates a <filename class="directory">lost+found</filename>
487 directory on an <systemitem class="filesystem">ext{234}</systemitem> file
488 system; it pre-allocates disk blocks to this directory to lighten the
489 task of <command>e2fsck</command></para>
490 <indexterm zone="ch-system-e2fsprogs mklost-found">
491 <primary sortas="b-mklost+found">mklost+found</primary>
492 </indexterm>
493 </listitem>
494 </varlistentry>
495
496 <varlistentry id="resize2fs">
497 <term><command>resize2fs</command></term>
498 <listitem>
499 <para>Can be used to enlarge or shrink <systemitem
500 class="filesystem">ext{234}</systemitem> file systems</para>
501 <indexterm zone="ch-system-e2fsprogs resize2fs">
502 <primary sortas="b-resize2fs">resize2fs</primary>
503 </indexterm>
504 </listitem>
505 </varlistentry>
506
507 <varlistentry id="tune2fs">
508 <term><command>tune2fs</command></term>
509 <listitem>
510 <para>Adjusts tunable file system parameters on <systemitem
511 class="filesystem">ext{234}</systemitem> file systems</para>
512 <indexterm zone="ch-system-e2fsprogs tune2fs">
513 <primary sortas="b-tune2fs">tune2fs</primary>
514 </indexterm>
515 </listitem>
516 </varlistentry>
517
518 <varlistentry id="libcom_err">
519 <term><filename class="libraryfile">libcom_err</filename></term>
520 <listitem>
521 <para>The common error display routine</para>
522 <indexterm zone="ch-system-e2fsprogs libcom_err">
523 <primary sortas="c-libcom_err">libcom_err</primary>
524 </indexterm>
525 </listitem>
526 </varlistentry>
527
528 <varlistentry id="libe2p">
529 <term><filename class="libraryfile">libe2p</filename></term>
530 <listitem>
531 <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
532 and <command>lsattr</command></para>
533 <indexterm zone="ch-system-e2fsprogs libe2p">
534 <primary sortas="c-libe2p">libe2p</primary>
535 </indexterm>
536 </listitem>
537 </varlistentry>
538
539 <varlistentry id="libext2fs">
540 <term><filename class="libraryfile">libext2fs</filename></term>
541 <listitem>
542 <para>Contains routines to enable user-level programs to manipulate
543 <systemitem class="filesystem">ext{234}</systemitem> file systems</para>
544 <indexterm zone="ch-system-e2fsprogs libext2fs">
545 <primary sortas="c-libext2fs">libext2fs</primary>
546 </indexterm>
547 </listitem>
548 </varlistentry>
549
550 <varlistentry id="libss">
551 <term><filename class="libraryfile">libss</filename></term>
552 <listitem>
553 <para>Used by <command>debugfs</command></para>
554 <indexterm zone="ch-system-e2fsprogs libss">
555 <primary sortas="c-libss">libss</primary>
556 </indexterm>
557 </listitem>
558 </varlistentry>
559
560 </variablelist>
561
562 </sect2>
563
564</sect1>
Note: See TracBrowser for help on using the repository browser.