source: chapter06/e2fsprogs.xml@ f1c177f

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.2 7.3 7.4 7.5 7.5-systemd 7.6 7.6-systemd 7.7 7.7-systemd 7.8 7.8-systemd 7.9 7.9-systemd 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 f1c177f was f1c177f, checked in by Matthew Burgess <matthew@…>, 12 years ago

Upgrade to Glibc-2.16.0. Fixes #3131.

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