source: chapter06/e2fsprogs.xml@ d35b7f3

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.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 d35b7f3 was d35b7f3, checked in by Bruce Dubbs <bdubbs@…>, 15 years ago

Update to sed 4,2,1
Update to Linux 2.6.30.1
Correct GCC to use -fomit-frame-pointer
Add pkg-config
Remove --with-col from Man-DB
Move Util-Linux-NG to before E2fsprogs in Chapter 6
Update to e2fsprogs-1.41.7
Remove E2fsprogs in Chapter 5

git-svn-id: http://svn.linuxfromscratch.org/LFS/trunk/BOOK@8955 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689

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