source: chapter06/e2fsprogs.xml@ 0b9e193

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 6.4 6.5 6.6 6.7 6.8 7.0 7.1 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 0b9e193 was 0b9e193, checked in by Bruce Dubbs <bdubbs@…>, 16 years ago

Updated to e2fsprogs 1.41.3

git-svn-id: ​http://svn.linuxfromscratch.org/LFS/trunk/BOOK@8711 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689
  • Property mode set to 100644
File size: 21.4 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> journaling
29 file system.</para>
30
31 <segmentedlist>
32 <segtitle>&buildtime;</segtitle>
33 <segtitle>&diskspace;</segtitle>
34
35 <seglistitem>
36 <seg>&e2fsprogs-ch6-sbu;</seg>
37 <seg>&e2fsprogs-ch6-du;</seg>
38 </seglistitem>
39 </segmentedlist>
40
41 </sect2>
42
43 <sect2 role="installation">
44 <title>Installation of E2fsprogs</title>
45
46 <para>Fix a hardcoded path to <filename>/bin/rm</filename> in E2fsprogs'
47 testsuite:</para>
48
49 <screen><userinput remap="pre">sed -i 's@/bin/rm@/tools&amp;@' lib/blkid/test_probe.in</userinput></screen>
50
51 <para>The E2fsprogs documentation recommends that the package be built in
52 a subdirectory of the source tree: </para>
53
54<screen><userinput remap="pre">mkdir -v build
55cd build</userinput></screen>
56
57 <para>Prepare E2fsprogs for compilation:</para>
58
59<screen><userinput remap="configure">../configure --prefix=/usr --with-root-prefix="" \
60 --enable-elf-shlibs</userinput></screen>
61
62 <variablelist>
63 <title>The meaning of the configure options:</title>
64
65 <varlistentry>
66 <term><parameter>--with-root-prefix=""</parameter></term>
67 <listitem>
68 <para>Certain programs (such as the <command>e2fsck</command>
69 program) are considered essential programs. When, for example,
70 <filename class="directory">/usr</filename> is not mounted, these
71 programs still need to be available. They belong in directories
72 like <filename class="directory">/lib</filename> and <filename
73 class="directory">/sbin</filename>. If this option is not passed
74 to E2fsprogs' configure, the programs are installed into the
75 <filename class="directory">/usr</filename> directory.</para>
76 </listitem>
77 </varlistentry>
78
79 <varlistentry>
80 <term><parameter>--enable-elf-shlibs</parameter></term>
81 <listitem>
82 <para>This creates the shared libraries which some programs
83 in this package use.</para>
84 </listitem>
85 </varlistentry>
86
87 </variablelist>
88
89 <para>Compile the package:</para>
90
91<screen><userinput remap="make">make</userinput></screen>
92
93 <para>To test the results, issue:</para>
94
95<screen><userinput remap="test">make check</userinput></screen>
96
97 <para>One of the E2fsprogs tests will attempt to allocate 256 MB
98 of memory. If you do not have significantly more RAM than this, it
99 is recommended to enable sufficient swap space for the test. See
100 <xref linkend="space-creatingfilesystem"/> and
101 <xref linkend="space-mounting"/> for details on creating and enabling
102 swap space.</para>
103
104 <para>Install the binaries, documentation, and shared libraries:</para>
105
106<screen><userinput remap="install">make install</userinput></screen>
107
108 <para>Install the static libraries and headers:</para>
109
110<screen><userinput remap="install">make install-libs</userinput></screen>
111
112 <para>Make the installed static libraries writable so debugging symbols can
113 be removed later.</para>
114
115<screen><userinput remap="install">chmod -v u+w /usr/lib/{libblkid,libcom_err,libe2p,libext2fs,libss,libuuid}.a</userinput></screen>
116
117 <para>This package installs a gzipped
118 <filename class="extension">.info</filename> file but doesn't update the
119 system-wide <filename>dir</filename> file. Unzip this file and then update
120 the system <filename>dir</filename> file using the following
121 commands.</para>
122
123<screen><userinput remap="install">gunzip -v /usr/share/info/libext2fs.info.gz
124install-info --dir-file=/usr/share/info/dir \
125 /usr/share/info/libext2fs.info</userinput></screen>
126
127 <para>If desired, create and install some additional documentation by
128 issuing the following commands:</para>
129
130<screen><userinput remap="install">makeinfo -o doc/com_err.info ../lib/et/com_err.texinfo
131install -v -m644 doc/com_err.info /usr/share/info
132install-info --dir-file=/usr/share/info/dir \
133 /usr/share/info/com_err.info
134
135install -v -m644 -D ../doc/libblkid.txt \
136 /usr/share/doc/e2fsprogs-&e2fsprogs-version;/libblkid.txt</userinput></screen>
137
138 </sect2>
139
140 <sect2 id="contents-e2fsprogs" role="content">
141 <title>Contents of E2fsprogs</title>
142
143 <segmentedlist>
144 <segtitle>Installed programs</segtitle>
145 <segtitle>Installed libraries</segtitle>
146
147 <seglistitem>
148 <seg>badblocks, blkid, chattr, compile_et, debugfs, dumpe2fs, e2fsck,
149 e2image, e2label, e2undo, filefrag, findfs, fsck, fsck.ext2, fsck.ext3,
150 fsck.ext4, fsck.ext4dev, logsave, lsattr,
151 mk_cmds, mke2fs, mkfs.ext2, mkfs.ext3, fsck.ext4, fsck.ext4dev,
152 mklost+found, resize2fs, tune2fs, uuidd, and uuidgen.</seg>
153 <seg>libblkid.{a,so}, libcom_err.{a,so}, libe2p.{a,so},
154 libext2fs.{a,so}, libss.{a,so}, and libuuid.{a,so}</seg>
155 </seglistitem>
156 </segmentedlist>
157
158 <variablelist>
159 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
160 <?dbfo list-presentation="list"?>
161 <?dbhtml list-presentation="table"?>
162
163 <varlistentry id="badblocks">
164 <term><command>badblocks</command></term>
165 <listitem>
166 <para>Searches a device (usually a disk partition) for bad
167 blocks</para>
168 <indexterm zone="ch-system-e2fsprogs badblocks">
169 <primary sortas="b-badblocks">badblocks</primary>
170 </indexterm>
171 </listitem>
172 </varlistentry>
173
174 <varlistentry id="blkid">
175 <term><command>blkid</command></term>
176 <listitem>
177 <para>A command line utility to locate and print block device
178 attributes</para>
179 <indexterm zone="ch-system-e2fsprogs blkid">
180 <primary sortas="b-blkid">blkid</primary>
181 </indexterm>
182 </listitem>
183 </varlistentry>
184
185 <varlistentry id="chattr">
186 <term><command>chattr</command></term>
187 <listitem>
188 <para>Changes the attributes of files on an <systemitem
189 class="filesystem">ext2</systemitem> file system; it also
190 changes <systemitem class="filesystem">ext3</systemitem>
191 file systems, the journaling version of <systemitem
192 class="filesystem">ext2</systemitem> file systems</para>
193 <indexterm zone="ch-system-e2fsprogs chattr">
194 <primary sortas="b-chattr">chattr</primary>
195 </indexterm>
196 </listitem>
197 </varlistentry>
198
199 <varlistentry id="compile_et">
200 <term><command>compile_et</command></term>
201 <listitem>
202 <para>An error table compiler; it converts a table of error-code
203 names and messages into a C source file suitable for use with the
204 <filename class="libraryfile">com_err</filename> library</para>
205 <indexterm zone="ch-system-e2fsprogs compile_et">
206 <primary sortas="b-compile_et">compile_et</primary>
207 </indexterm>
208 </listitem>
209 </varlistentry>
210
211 <varlistentry id="debugfs">
212 <term><command>debugfs</command></term>
213 <listitem>
214 <para>A file system debugger; it can be used to examine and change
215 the state of an <systemitem class="filesystem">ext2</systemitem>
216 file system</para>
217 <indexterm zone="ch-system-e2fsprogs debugfs">
218 <primary sortas="b-debugfs">debugfs</primary>
219 </indexterm>
220 </listitem>
221 </varlistentry>
222
223 <varlistentry id="dumpe2fs">
224 <term><command>dumpe2fs</command></term>
225 <listitem>
226 <para>Prints the super block and blocks group information for the
227 file system present on a given device</para>
228 <indexterm zone="ch-system-e2fsprogs dumpe2fs">
229 <primary sortas="b-dumpe2fs">dumpe2fs</primary>
230 </indexterm>
231 </listitem>
232 </varlistentry>
233
234 <varlistentry id="e2fsck">
235 <term><command>e2fsck</command></term>
236 <listitem>
237 <para>Is used to check, and optionally repair <systemitem
238 class="filesystem">ext2</systemitem> file systems and <systemitem
239 class="filesystem">ext3</systemitem> file systems</para>
240 <indexterm zone="ch-system-e2fsprogs e2fsck">
241 <primary sortas="b-e2fsck">e2fsck</primary>
242 </indexterm>
243 </listitem>
244 </varlistentry>
245
246 <varlistentry id="e2image">
247 <term><command>e2image</command></term>
248 <listitem>
249 <para>Is used to save critical <systemitem
250 class="filesystem">ext2</systemitem> file system data to a file</para>
251 <indexterm zone="ch-system-e2fsprogs e2image">
252 <primary sortas="b-e2image">e2image</primary>
253 </indexterm>
254 </listitem>
255 </varlistentry>
256
257 <varlistentry id="e2label">
258 <term><command>e2label</command></term>
259 <listitem>
260 <para>Displays or changes the file system label on the <systemitem
261 class="filesystem">ext2</systemitem> file system present on a given
262 device</para>
263 <indexterm zone="ch-system-e2fsprogs e2label">
264 <primary sortas="b-e2label">e2label</primary>
265 </indexterm>
266 </listitem>
267 </varlistentry>
268
269 <varlistentry id="e2undo">
270 <term><command>e2undo</command></term>
271 <listitem>
272 <para>Replayd the undo log undo_log for an ext2/ext3/ext4 filesystem
273 found on a device. This can be used to undo a failed operation by an
274 e2fsprogs program.</para>
275 <indexterm zone="ch-system-e2fsprogs e2undo">
276 <primary sortas="b-e2undo">e2undo</primary>
277 </indexterm>
278 </listitem>
279 </varlistentry>
280
281 <varlistentry id="filefrag">
282 <term><command>filefrag</command></term>
283 <listitem>
284 <para>Reports on how badly fragmented a particular file might be</para>
285 <indexterm zone="ch-system-e2fsprogs filefrag">
286 <primary sortas="b-filefrag">filefrag</primary>
287 </indexterm>
288 </listitem>
289 </varlistentry>
290
291 <varlistentry id="findfs">
292 <term><command>findfs</command></term>
293 <listitem>
294 <para>Finds a file system by label or Universally Unique Identifier
295 (UUID)</para>
296 <indexterm zone="ch-system-e2fsprogs findfs">
297 <primary sortas="b-findfs">findfs</primary>
298 </indexterm>
299 </listitem>
300 </varlistentry>
301
302 <varlistentry id="fsck">
303 <term><command>fsck</command></term>
304 <listitem>
305 <para>Is used to check, and optionally repair, file systems</para>
306 <indexterm zone="ch-system-e2fsprogs fsck">
307 <primary sortas="b-fsck">fsck</primary>
308 </indexterm>
309 </listitem>
310 </varlistentry>
311
312 <varlistentry id="fsck.ext2">
313 <term><command>fsck.ext2</command></term>
314 <listitem>
315 <para>By default checks <systemitem class="filesystem">ext2</systemitem>
316 file systems. This is a hard link to <command>fsck</command>.</para>
317 <indexterm zone="ch-system-e2fsprogs fsck.ext2">
318 <primary sortas="b-fsck.ext2">fsck.ext2</primary>
319 </indexterm>
320 </listitem>
321 </varlistentry>
322
323 <varlistentry id="fsck.ext3">
324 <term><command>fsck.ext3</command></term>
325 <listitem>
326 <para>By default checks <systemitem class="filesystem">ext3</systemitem>
327 file systems. This is a hard link to <command>fsck</command>.</para>
328 <indexterm zone="ch-system-e2fsprogs fsck.ext3">
329 <primary sortas="b-fsck.ext3">fsck.ext3</primary>
330 </indexterm>
331 </listitem>
332 </varlistentry>
333
334 <varlistentry id="fsck.ext4">
335 <term><command>fsck.ext4</command></term>
336 <listitem>
337 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
338 file systems. This is a hard link to <command>fsck</command>.</para>
339 <indexterm zone="ch-system-e2fsprogs fsck.ext4">
340 <primary sortas="b-fsck.ext4">fsck.ext4</primary>
341 </indexterm>
342 </listitem>
343 </varlistentry>
344
345 <varlistentry id="fsck.ext4dev">
346 <term><command>fsck.ext4dev</command></term>
347 <listitem>
348 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
349 development file systems. This is a hard link to
350 <command>fsck</command>.</para>
351 <indexterm zone="ch-system-e2fsprogs fsck.ext4dev">
352 <primary sortas="b-fsck.ext4dev">fsck.ext4dev</primary>
353 </indexterm>
354 </listitem>
355 </varlistentry>
356
357 <varlistentry id="logsave">
358 <term><command>logsave</command></term>
359 <listitem>
360 <para>Saves the output of a command in a log file</para>
361 <indexterm zone="ch-system-e2fsprogs logsave">
362 <primary sortas="b-logsave">logsave</primary>
363 </indexterm>
364 </listitem>
365 </varlistentry>
366
367 <varlistentry id="lsattr">
368 <term><command>lsattr</command></term>
369 <listitem>
370 <para>Lists the attributes of files on a second extended file
371 system</para>
372 <indexterm zone="ch-system-e2fsprogs lsattr">
373 <primary sortas="b-lsattr">lsattr</primary>
374 </indexterm>
375 </listitem>
376 </varlistentry>
377
378 <varlistentry id="mk_cmds">
379 <term><command>mk_cmds</command></term>
380 <listitem>
381 <para>Converts a table of command names and help messages into a C
382 source file suitable for use with the <filename
383 class="libraryfile">libss</filename> subsystem library</para>
384 <indexterm zone="ch-system-e2fsprogs mk_cmds">
385 <primary sortas="b-mk_cmds">mk_cmds</primary>
386 </indexterm>
387 </listitem>
388 </varlistentry>
389
390 <varlistentry id="mke2fs">
391 <term><command>mke2fs</command></term>
392 <listitem>
393 <para>Creates an <systemitem class="filesystem">ext2</systemitem>
394 or <systemitem class="filesystem">ext3</systemitem> file system on
395 the given device</para>
396 <indexterm zone="ch-system-e2fsprogs mke2fs">
397 <primary sortas="b-mke2fs">mke2fs</primary>
398 </indexterm>
399 </listitem>
400 </varlistentry>
401
402 <varlistentry id="mkfs.ext2">
403 <term><command>mkfs.ext2</command></term>
404 <listitem>
405 <para>By default creates <systemitem class="filesystem">ext2</systemitem>
406 file systems. This is a hard link to <command>mke2fs</command>.</para>
407 <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
408 <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
409 </indexterm>
410 </listitem>
411 </varlistentry>
412
413 <varlistentry id="mkfs.ext3">
414 <term><command>mkfs.ext3</command></term>
415 <listitem>
416 <para>By default creates <systemitem class="filesystem">ext3</systemitem>
417 file systems. This is a hard link to <command>mke2fs</command>.</para>
418 <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
419 <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
420 </indexterm>
421 </listitem>
422 </varlistentry>
423
424 <varlistentry id="mkfs.ext4">
425 <term><command>mkfs.ext4</command></term>
426 <listitem>
427 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
428 file systems. This is a hard link to <command>mke2fs</command>.</para>
429 <indexterm zone="ch-system-e2fsprogs mkfs.ext4">
430 <primary sortas="b-mkfs.ext4">mkfs.ext4</primary>
431 </indexterm>
432 </listitem>
433 </varlistentry>
434
435 <varlistentry id="mkfs.ext4dev">
436 <term><command>mkfs.ext4dev</command></term>
437 <listitem>
438 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
439 development file systems. This is a hard link to <command>mke2fs</command>.</para>
440 <indexterm zone="ch-system-e2fsprogs mkfs.ext4dev">
441 <primary sortas="b-mkfs.ext4dev">mkfs.ext4dev</primary>
442 </indexterm>
443 </listitem>
444 </varlistentry>
445
446 <varlistentry id="mklost-found">
447 <term><command>mklost+found</command></term>
448 <listitem>
449 <para>Used to create a <filename class="directory">lost+found</filename>
450 directory on an <systemitem class="filesystem">ext2</systemitem> file
451 system; it pre-allocates disk blocks to this directory to lighten the
452 task of <command>e2fsck</command></para>
453 <indexterm zone="ch-system-e2fsprogs mklost-found">
454 <primary sortas="b-mklost+found">mklost+found</primary>
455 </indexterm>
456 </listitem>
457 </varlistentry>
458
459 <varlistentry id="resize2fs">
460 <term><command>resize2fs</command></term>
461 <listitem>
462 <para>Can be used to enlarge or shrink an <systemitem
463 class="filesystem">ext2</systemitem> file system</para>
464 <indexterm zone="ch-system-e2fsprogs resize2fs">
465 <primary sortas="b-resize2fs">resize2fs</primary>
466 </indexterm>
467 </listitem>
468 </varlistentry>
469
470 <varlistentry id="tune2fs">
471 <term><command>tune2fs</command></term>
472 <listitem>
473 <para>Adjusts tunable file system parameters on an <systemitem
474 class="filesystem">ext2</systemitem> file system</para>
475 <indexterm zone="ch-system-e2fsprogs tune2fs">
476 <primary sortas="b-tune2fs">tune2fs</primary>
477 </indexterm>
478 </listitem>
479 </varlistentry>
480
481 <varlistentry id="uuidd">
482 <term><command>uuidd</command></term>
483 <listitem>
484 <para>A daemon used by the UUID library to generate time-based
485 UUIDs in a secure and guranteed-unique fashion.</para>
486 <indexterm zone="ch-system-e2fsprogs uuidd">
487 <primary sortas="b-uuidd">uuidd</primary>
488 </indexterm>
489 </listitem>
490 </varlistentry>
491
492 <varlistentry id="uuidgen">
493 <term><command>uuidgen</command></term>
494 <listitem>
495 <para>Creates new UUIDs. Each new UUID can reasonably be considered
496 unique among all UUIDs created, on the local system and on other
497 systems, in the past and in the future</para>
498 <indexterm zone="ch-system-e2fsprogs uuidgen">
499 <primary sortas="b-uuidgen">uuidgen</primary>
500 </indexterm>
501 </listitem>
502 </varlistentry>
503
504 <varlistentry id="libblkid">
505 <term><filename class="libraryfile">libblkid</filename></term>
506 <listitem>
507 <para>Contains routines for device identification and token
508 extraction</para>
509 <indexterm zone="ch-system-e2fsprogs libblkid">
510 <primary sortas="c-libblkid">libblkid</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 an
540 <systemitem class="filesystem">ext2</systemitem> file system</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 <varlistentry id="libuuid">
558 <term><filename class="libraryfile">libuuid</filename></term>
559 <listitem>
560 <para>Contains routines for generating unique identifiers for objects
561 that may be accessible beyond the local system</para>
562 <indexterm zone="ch-system-e2fsprogs libuuid">
563 <primary sortas="c-libuuid">libuuid</primary>
564 </indexterm>
565 </listitem>
566 </varlistentry>
567
568 </variablelist>
569
570 </sect2>
571
572</sect1>
Note: See TracBrowser for help on using the repository browser.