source: chapter08/e2fsprogs.xml@ 47c9152

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 47c9152 was 9901d50d, checked in by Bruce Dubbs <bdubbs@…>, 3 years ago

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