source: chapter06/e2fsprogs.xml@ 4f57994

10.0 10.0-rc1 10.1 10.1-rc1 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 7.5 7.6 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 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 4f57994 was 4f57994, checked in by Bruce Dubbs <bdubbs@…>, 10 years ago

Update to e2fsprogs-1.42.9

git-svn-id: ​http://svn.linuxfromscratch.org/LFS/trunk/BOOK@10432 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689
  • Property mode set to 100644
File size: 20.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-ch6-sbu;</seg>
38 <seg>&e2fsprogs-ch6-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 --with-root-prefix="" \
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>PKG_CONFIG...</parameter></term>
68 <listitem>
69 <para>This enables E2fsprogs to be built without requiring Pkg-config
70 to be built and installed first.</para>
71 </listitem>
72 </varlistentry>
73-->
74 <varlistentry>
75 <term><parameter>--with-root-prefix=""</parameter></term>
76 <listitem>
77 <para>Certain programs (such as the <command>e2fsck</command>
78 program) are considered essential programs. When, for example,
79 <filename class="directory">/usr</filename> is not mounted, these
80 programs still need to be available. They belong in directories
81 like <filename class="directory">/lib</filename> and <filename
82 class="directory">/sbin</filename>. If this option is not passed
83 to E2fsprogs' configure, the programs are installed into the
84 <filename class="directory">/usr</filename> directory.</para>
85 </listitem>
86 </varlistentry>
87
88 <varlistentry>
89 <term><parameter>--enable-elf-shlibs</parameter></term>
90 <listitem>
91 <para>This creates the shared libraries which some programs
92 in this package use.</para>
93 </listitem>
94 </varlistentry>
95
96 <varlistentry>
97 <term><parameter>--disable-*</parameter></term>
98 <listitem>
99 <para>This prevents E2fsprogs from building and installing the
100 <systemitem class="library">libuuid</systemitem> and
101 <systemitem class="library">libblkid</systemitem> libraries, the
102 <systemitem class="daemon">uuidd</systemitem> daemon, and the
103 <command>fsck</command> wrapper, as Util-Linux installed all of
104 them earlier.</para>
105 </listitem>
106 </varlistentry>
107
108 </variablelist>
109
110 <para>Compile the package:</para>
111
112<screen><userinput remap="make">make</userinput></screen>
113
114 <para>To test the results, issue:</para>
115
116<screen><userinput remap="test">make check</userinput></screen>
117
118 <para>One of the E2fsprogs tests will attempt to allocate 256 MB of memory.
119 If you do not have significantly more RAM than this, be sure to enable
120 sufficient swap space for the test. See <xref
121 linkend="space-creatingfilesystem"/> and <xref linkend="space-mounting"/>
122 for details on creating and enabling swap space. Additionally,
123 three tests try to allocate a two terabyte partition and will fail
124 unless you have at least that much unused disk space available.</para>
125
126 <para>Install the binaries, documentation, and shared libraries:</para>
127
128<screen><userinput remap="install">make install</userinput></screen>
129
130 <para>Install the static libraries and headers:</para>
131
132<screen><userinput remap="install">make install-libs</userinput></screen>
133
134 <para>Make the installed static libraries writable so debugging symbols can
135 be removed later:</para>
136
137<screen><userinput remap="install">chmod -v u+w /usr/lib/{libcom_err,libe2p,libext2fs,libss}.a</userinput></screen>
138
139 <para>This package installs a gzipped
140 <filename class="extension">.info</filename> file but doesn't update the
141 system-wide <filename>dir</filename> file. Unzip this file and then update
142 the system <filename>dir</filename> file using the following
143 commands.</para>
144
145<screen><userinput remap="install">gunzip -v /usr/share/info/libext2fs.info.gz
146install-info --dir-file=/usr/share/info/dir /usr/share/info/libext2fs.info</userinput></screen>
147
148 <para>If desired, create and install some additional documentation by
149 issuing the following commands:</para>
150
151<screen><userinput remap="install">makeinfo -o doc/com_err.info ../lib/et/com_err.texinfo
152install -v -m644 doc/com_err.info /usr/share/info
153install-info --dir-file=/usr/share/info/dir /usr/share/info/com_err.info</userinput></screen>
154 </sect2>
155
156 <sect2 id="contents-e2fsprogs" role="content">
157 <title>Contents of E2fsprogs</title>
158
159 <segmentedlist>
160 <segtitle>Installed programs</segtitle>
161 <segtitle>Installed libraries</segtitle>
162 <segtitle>Installed directory</segtitle>
163
164 <seglistitem>
165 <seg>badblocks, chattr, compile_et, debugfs, dumpe2fs,e2freefrag,
166 e2fsck, e2image, e2label, e2undo, e4defrag, filefrag, fsck.ext2,
167 fsck.ext3, fsck.ext4, fsck.ext4dev, logsave, lsattr, mk_cmds, mke2fs,
168 mkfs.ext2, mkfs.ext3, mkfs.ext4, mkfs.ext4dev,
169 resize2fs, and tune2fs</seg>
170 <seg>libcom_err.{a,so}, libe2p.{a,so}, libext2fs.{a,so},
171 libquota.a, and libss.{a,so}</seg>
172 <seg>/usr/include/e2p, /usr/include/et, /usr/include/ext2fs,
173 /usr/include/quota, /usr/include/ss, /usr/share/et, /usr/share/ss</seg>
174 </seglistitem>
175 </segmentedlist>
176
177 <variablelist>
178 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
179 <?dbfo list-presentation="list"?>
180 <?dbhtml list-presentation="table"?>
181
182 <varlistentry id="badblocks">
183 <term><command>badblocks</command></term>
184 <listitem>
185 <para>Searches a device (usually a disk partition) for bad
186 blocks</para>
187 <indexterm zone="ch-system-e2fsprogs badblocks">
188 <primary sortas="b-badblocks">badblocks</primary>
189 </indexterm>
190 </listitem>
191 </varlistentry>
192
193 <varlistentry id="chattr">
194 <term><command>chattr</command></term>
195 <listitem>
196 <para>Changes the attributes of files on an <systemitem
197 class="filesystem">ext2</systemitem> file system; it also
198 changes <systemitem class="filesystem">ext3</systemitem>
199 file systems, the journaling version of <systemitem
200 class="filesystem">ext2</systemitem> file systems</para>
201 <indexterm zone="ch-system-e2fsprogs chattr">
202 <primary sortas="b-chattr">chattr</primary>
203 </indexterm>
204 </listitem>
205 </varlistentry>
206
207 <varlistentry id="compile_et">
208 <term><command>compile_et</command></term>
209 <listitem>
210 <para>An error table compiler; it converts a table of error-code
211 names and messages into a C source file suitable for use with the
212 <filename class="libraryfile">com_err</filename> library</para>
213 <indexterm zone="ch-system-e2fsprogs compile_et">
214 <primary sortas="b-compile_et">compile_et</primary>
215 </indexterm>
216 </listitem>
217 </varlistentry>
218
219 <varlistentry id="debugfs">
220 <term><command>debugfs</command></term>
221 <listitem>
222 <para>A file system debugger; it can be used to examine and change
223 the state of an <systemitem class="filesystem">ext2</systemitem>
224 file system</para>
225 <indexterm zone="ch-system-e2fsprogs debugfs">
226 <primary sortas="b-debugfs">debugfs</primary>
227 </indexterm>
228 </listitem>
229 </varlistentry>
230
231 <varlistentry id="dumpe2fs">
232 <term><command>dumpe2fs</command></term>
233 <listitem>
234 <para>Prints the super block and blocks group information for the
235 file system present on a given device</para>
236 <indexterm zone="ch-system-e2fsprogs dumpe2fs">
237 <primary sortas="b-dumpe2fs">dumpe2fs</primary>
238 </indexterm>
239 </listitem>
240 </varlistentry>
241
242 <varlistentry id="e2freefrag">
243 <term><command>e2freefrag</command></term>
244 <listitem>
245 <para> Reports free space fragmentation information</para>
246 <indexterm zone="ch-system-e2fsprogs e2freefrag">
247 <primary sortas="b-e2freefrag">e2freefrag</primary>
248 </indexterm>
249 </listitem>
250 </varlistentry>
251
252 <varlistentry id="e2fsck">
253 <term><command>e2fsck</command></term>
254 <listitem>
255 <para>Is used to check, and optionally repair <systemitem
256 class="filesystem">ext2</systemitem> file systems and <systemitem
257 class="filesystem">ext3</systemitem> file systems</para>
258 <indexterm zone="ch-system-e2fsprogs e2fsck">
259 <primary sortas="b-e2fsck">e2fsck</primary>
260 </indexterm>
261 </listitem>
262 </varlistentry>
263
264 <varlistentry id="e2image">
265 <term><command>e2image</command></term>
266 <listitem>
267 <para>Is used to save critical <systemitem
268 class="filesystem">ext2</systemitem> file system data to a file</para>
269 <indexterm zone="ch-system-e2fsprogs e2image">
270 <primary sortas="b-e2image">e2image</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>
274
275 <varlistentry id="e2label">
276 <term><command>e2label</command></term>
277 <listitem>
278 <para>Displays or changes the file system label on the <systemitem
279 class="filesystem">ext2</systemitem> file system present on a given
280 device</para>
281 <indexterm zone="ch-system-e2fsprogs e2label">
282 <primary sortas="b-e2label">e2label</primary>
283 </indexterm>
284 </listitem>
285 </varlistentry>
286
287 <varlistentry id="e2undo">
288 <term><command>e2undo</command></term>
289 <listitem>
290 <para>Replays the undo log undo_log for an ext2/ext3/ext4 filesystem
291 found on a device. This can be used to undo a failed operation by an
292 e2fsprogs program.</para>
293 <indexterm zone="ch-system-e2fsprogs e2undo">
294 <primary sortas="b-e2undo">e2undo</primary>
295 </indexterm>
296 </listitem>
297 </varlistentry>
298
299 <varlistentry id="e4defrag">
300 <term><command>e4defrag</command></term>
301 <listitem>
302 <para>Online defragmenter for ext4 filesystems</para>
303 <indexterm zone="ch-system-e2fsprogs e4defrag">
304 <primary sortas="b-e4defrag">e4defrag</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308
309 <varlistentry id="filefrag">
310 <term><command>filefrag</command></term>
311 <listitem>
312 <para>Reports on how badly fragmented a particular file might be</para>
313 <indexterm zone="ch-system-e2fsprogs filefrag">
314 <primary sortas="b-filefrag">filefrag</primary>
315 </indexterm>
316 </listitem>
317 </varlistentry>
318
319 <varlistentry id="fsck.ext2">
320 <term><command>fsck.ext2</command></term>
321 <listitem>
322 <para>By default checks <systemitem class="filesystem">ext2</systemitem>
323 file systems. This is a hard link to <command>e2fsck</command>.</para>
324 <indexterm zone="ch-system-e2fsprogs fsck.ext2">
325 <primary sortas="b-fsck.ext2">fsck.ext2</primary>
326 </indexterm>
327 </listitem>
328 </varlistentry>
329
330 <varlistentry id="fsck.ext3">
331 <term><command>fsck.ext3</command></term>
332 <listitem>
333 <para>By default checks <systemitem class="filesystem">ext3</systemitem>
334 file systems. This is a hard link to <command>e2fsck</command>.</para>
335 <indexterm zone="ch-system-e2fsprogs fsck.ext3">
336 <primary sortas="b-fsck.ext3">fsck.ext3</primary>
337 </indexterm>
338 </listitem>
339 </varlistentry>
340
341 <varlistentry id="fsck.ext4">
342 <term><command>fsck.ext4</command></term>
343 <listitem>
344 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
345 file systems. This is a hard link to <command>e2fsck</command>.</para>
346 <indexterm zone="ch-system-e2fsprogs fsck.ext4">
347 <primary sortas="b-fsck.ext4">fsck.ext4</primary>
348 </indexterm>
349 </listitem>
350 </varlistentry>
351
352 <varlistentry id="fsck.ext4dev">
353 <term><command>fsck.ext4dev</command></term>
354 <listitem>
355 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
356 development file systems. This is a hard link to
357 <command>e2fsck</command>.</para>
358 <indexterm zone="ch-system-e2fsprogs fsck.ext4dev">
359 <primary sortas="b-fsck.ext4dev">fsck.ext4dev</primary>
360 </indexterm>
361 </listitem>
362 </varlistentry>
363
364 <varlistentry id="logsave">
365 <term><command>logsave</command></term>
366 <listitem>
367 <para>Saves the output of a command in a log file</para>
368 <indexterm zone="ch-system-e2fsprogs logsave">
369 <primary sortas="b-logsave">logsave</primary>
370 </indexterm>
371 </listitem>
372 </varlistentry>
373
374 <varlistentry id="lsattr">
375 <term><command>lsattr</command></term>
376 <listitem>
377 <para>Lists the attributes of files on a second extended file
378 system</para>
379 <indexterm zone="ch-system-e2fsprogs lsattr">
380 <primary sortas="b-lsattr">lsattr</primary>
381 </indexterm>
382 </listitem>
383 </varlistentry>
384
385 <varlistentry id="mk_cmds">
386 <term><command>mk_cmds</command></term>
387 <listitem>
388 <para>Converts a table of command names and help messages into a C
389 source file suitable for use with the <filename
390 class="libraryfile">libss</filename> subsystem library</para>
391 <indexterm zone="ch-system-e2fsprogs mk_cmds">
392 <primary sortas="b-mk_cmds">mk_cmds</primary>
393 </indexterm>
394 </listitem>
395 </varlistentry>
396
397 <varlistentry id="mke2fs">
398 <term><command>mke2fs</command></term>
399 <listitem>
400 <para>Creates an <systemitem class="filesystem">ext2</systemitem>
401 or <systemitem class="filesystem">ext3</systemitem> file system on
402 the given device</para>
403 <indexterm zone="ch-system-e2fsprogs mke2fs">
404 <primary sortas="b-mke2fs">mke2fs</primary>
405 </indexterm>
406 </listitem>
407 </varlistentry>
408
409 <varlistentry id="mkfs.ext2">
410 <term><command>mkfs.ext2</command></term>
411 <listitem>
412 <para>By default creates <systemitem class="filesystem">ext2</systemitem>
413 file systems. This is a hard link to <command>mke2fs</command>.</para>
414 <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
415 <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
416 </indexterm>
417 </listitem>
418 </varlistentry>
419
420 <varlistentry id="mkfs.ext3">
421 <term><command>mkfs.ext3</command></term>
422 <listitem>
423 <para>By default creates <systemitem class="filesystem">ext3</systemitem>
424 file systems. This is a hard link to <command>mke2fs</command>.</para>
425 <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
426 <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
427 </indexterm>
428 </listitem>
429 </varlistentry>
430
431 <varlistentry id="mkfs.ext4">
432 <term><command>mkfs.ext4</command></term>
433 <listitem>
434 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
435 file systems. This is a hard link to <command>mke2fs</command>.</para>
436 <indexterm zone="ch-system-e2fsprogs mkfs.ext4">
437 <primary sortas="b-mkfs.ext4">mkfs.ext4</primary>
438 </indexterm>
439 </listitem>
440 </varlistentry>
441
442 <varlistentry id="mkfs.ext4dev">
443 <term><command>mkfs.ext4dev</command></term>
444 <listitem>
445 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
446 development file systems. This is a hard link to <command>mke2fs</command>.</para>
447 <indexterm zone="ch-system-e2fsprogs mkfs.ext4dev">
448 <primary sortas="b-mkfs.ext4dev">mkfs.ext4dev</primary>
449 </indexterm>
450 </listitem>
451 </varlistentry>
452
453 <varlistentry id="mklost-found">
454 <term><command>mklost+found</command></term>
455 <listitem>
456 <para>Used to create a <filename class="directory">lost+found</filename>
457 directory on an <systemitem class="filesystem">ext2</systemitem> file
458 system; it pre-allocates disk blocks to this directory to lighten the
459 task of <command>e2fsck</command></para>
460 <indexterm zone="ch-system-e2fsprogs mklost-found">
461 <primary sortas="b-mklost+found">mklost+found</primary>
462 </indexterm>
463 </listitem>
464 </varlistentry>
465
466 <varlistentry id="resize2fs">
467 <term><command>resize2fs</command></term>
468 <listitem>
469 <para>Can be used to enlarge or shrink an <systemitem
470 class="filesystem">ext2</systemitem> file system</para>
471 <indexterm zone="ch-system-e2fsprogs resize2fs">
472 <primary sortas="b-resize2fs">resize2fs</primary>
473 </indexterm>
474 </listitem>
475 </varlistentry>
476
477 <varlistentry id="tune2fs">
478 <term><command>tune2fs</command></term>
479 <listitem>
480 <para>Adjusts tunable file system parameters on an <systemitem
481 class="filesystem">ext2</systemitem> file system</para>
482 <indexterm zone="ch-system-e2fsprogs tune2fs">
483 <primary sortas="b-tune2fs">tune2fs</primary>
484 </indexterm>
485 </listitem>
486 </varlistentry>
487
488 <varlistentry id="libcom_err">
489 <term><filename class="libraryfile">libcom_err</filename></term>
490 <listitem>
491 <para>The common error display routine</para>
492 <indexterm zone="ch-system-e2fsprogs libcom_err">
493 <primary sortas="c-libcom_err">libcom_err</primary>
494 </indexterm>
495 </listitem>
496 </varlistentry>
497
498 <varlistentry id="libe2p">
499 <term><filename class="libraryfile">libe2p</filename></term>
500 <listitem>
501 <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
502 and <command>lsattr</command></para>
503 <indexterm zone="ch-system-e2fsprogs libe2p">
504 <primary sortas="c-libe2p">libe2p</primary>
505 </indexterm>
506 </listitem>
507 </varlistentry>
508
509 <varlistentry id="libext2fs">
510 <term><filename class="libraryfile">libext2fs</filename></term>
511 <listitem>
512 <para>Contains routines to enable user-level programs to manipulate an
513 <systemitem class="filesystem">ext2</systemitem> file system</para>
514 <indexterm zone="ch-system-e2fsprogs libext2fs">
515 <primary sortas="c-libext2fs">libext2fs</primary>
516 </indexterm>
517 </listitem>
518 </varlistentry>
519
520 <varlistentry id="libquota">
521 <term><filename class="libraryfile">libquota</filename></term>
522 <listitem>
523 <para>Provides an interface for creating and updating quota files
524 and ext4 superblock fields</para>
525 <indexterm zone="ch-system-e2fsprogs libquota">
526 <primary sortas="c-libquota">libquota</primary>
527 </indexterm>
528 </listitem>
529 </varlistentry>
530
531 <varlistentry id="libss">
532 <term><filename class="libraryfile">libss</filename></term>
533 <listitem>
534 <para>Used by <command>debugfs</command></para>
535 <indexterm zone="ch-system-e2fsprogs libss">
536 <primary sortas="c-libss">libss</primary>
537 </indexterm>
538 </listitem>
539 </varlistentry>
540
541 </variablelist>
542
543 </sect2>
544
545</sect1>
Note: See TracBrowser for help on using the repository browser.