source: chapter06/e2fsprogs.xml@ 1891a2c

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 1891a2c was 1891a2c, checked in by Matthew Burgess <matthew@…>, 15 years ago

Prevent E2fsprogs from overwriting Util-Linux-NG's copy of uuidd. Fixes #2443.

git-svn-id: ​http://svn.linuxfromscratch.org/LFS/trunk/BOOK@8964 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> 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>Make sure the version date is in a format compatible with
48 <command>configure</command>:</para>
49
50<screen><userinput remap="pre">sed -i -e "s/July/Jul/" version.h</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 --disable-uuidd</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 <varlistentry>
89 <term><parameter>--disable-*</parameter></term>
90 <listitem>
91 <para>This prevents E2fsprogs from building and installing the
92 <systemitem class="library">libuuid</systemitem> and
93 <systemitem class="library">libblkid</systemitem> libraries, and the
94 <systemitem class="daemon">uuidd</systemitem> daemon, as Util-Linux-NG
95 installed them earlier.</para>
96 </listitem>
97 </varlistentry>
98
99 </variablelist>
100
101 <para>Compile the package:</para>
102
103<screen><userinput remap="make">make</userinput></screen>
104
105 <para>To test the results, issue:</para>
106
107<screen><userinput remap="test">make check</userinput></screen>
108
109 <para>One of the E2fsprogs tests will attempt to allocate 256 MB
110 of memory. If you do not have significantly more RAM than this, it
111 is recommended to enable sufficient swap space for the test. See
112 <xref linkend="space-creatingfilesystem"/> and
113 <xref linkend="space-mounting"/> for details on creating and enabling
114 swap space.</para>
115
116 <para>Install the binaries, documentation, and shared libraries:</para>
117
118<screen><userinput remap="install">make install</userinput></screen>
119
120 <para>Install the static libraries and headers:</para>
121
122<screen><userinput remap="install">make install-libs</userinput></screen>
123
124 <para>Make the installed static libraries writable so debugging symbols can
125 be removed later.</para>
126
127<screen><userinput remap="install">chmod -v u+w /usr/lib/{libcom_err,libe2p,libext2fs,libss}.a</userinput></screen>
128
129 <para>This package installs a gzipped
130 <filename class="extension">.info</filename> file but doesn't update the
131 system-wide <filename>dir</filename> file. Unzip this file and then update
132 the system <filename>dir</filename> file using the following
133 commands.</para>
134
135<screen><userinput remap="install">gunzip -v /usr/share/info/libext2fs.info.gz
136install-info --dir-file=/usr/share/info/dir \
137 /usr/share/info/libext2fs.info</userinput></screen>
138
139 <para>If desired, create and install some additional documentation by
140 issuing the following commands:</para>
141
142<screen><userinput remap="install">makeinfo -o doc/com_err.info ../lib/et/com_err.texinfo
143install -v -m644 doc/com_err.info /usr/share/info
144install-info --dir-file=/usr/share/info/dir \
145 /usr/share/info/com_err.info</userinput></screen>
146 </sect2>
147
148 <sect2 id="contents-e2fsprogs" role="content">
149 <title>Contents of E2fsprogs</title>
150
151 <segmentedlist>
152 <segtitle>Installed programs</segtitle>
153 <segtitle>Installed libraries</segtitle>
154
155 <seglistitem>
156 <seg>badblocks, blkid, chattr, compile_et, debugfs, dumpe2fs, e2fsck,
157 e2image, e2initrd_helper, e2label, e2undo, filefrag, findfs, fsck,
158 fsck.ext2, fsck.ext3, fsck.ext4, fsck.ext4dev, logsave, lsattr,
159 mk_cmds, mke2fs, mkfs.ext2, mkfs.ext3, mkfs.ext4, mkfs.ext4dev,
160 mklost+found, resize2fs, tune2fs, uuidd, and uuidgen.</seg>
161 <seg>libcom_err.{a,so}, libe2p.{a,so}, libext2fs.{a,so} and
162 libss.{a,so}</seg>
163 </seglistitem>
164 </segmentedlist>
165
166 <variablelist>
167 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
168 <?dbfo list-presentation="list"?>
169 <?dbhtml list-presentation="table"?>
170
171 <varlistentry id="badblocks">
172 <term><command>badblocks</command></term>
173 <listitem>
174 <para>Searches a device (usually a disk partition) for bad
175 blocks</para>
176 <indexterm zone="ch-system-e2fsprogs badblocks">
177 <primary sortas="b-badblocks">badblocks</primary>
178 </indexterm>
179 </listitem>
180 </varlistentry>
181
182 <varlistentry id="blkid">
183 <term><command>blkid</command></term>
184 <listitem>
185 <para>A command line utility to locate and print block device
186 attributes</para>
187 <indexterm zone="ch-system-e2fsprogs blkid">
188 <primary sortas="b-blkid">blkid</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="e2fsck">
243 <term><command>e2fsck</command></term>
244 <listitem>
245 <para>Is used to check, and optionally repair <systemitem
246 class="filesystem">ext2</systemitem> file systems and <systemitem
247 class="filesystem">ext3</systemitem> file systems</para>
248 <indexterm zone="ch-system-e2fsprogs e2fsck">
249 <primary sortas="b-e2fsck">e2fsck</primary>
250 </indexterm>
251 </listitem>
252 </varlistentry>
253
254 <varlistentry id="e2image">
255 <term><command>e2image</command></term>
256 <listitem>
257 <para>Is used to save critical <systemitem
258 class="filesystem">ext2</systemitem> file system data to a file</para>
259 <indexterm zone="ch-system-e2fsprogs e2image">
260 <primary sortas="b-e2image">e2image</primary>
261 </indexterm>
262 </listitem>
263 </varlistentry>
264
265 <varlistentry id="e2initrd_helper">
266 <term><command>e2initrd_helper</command></term>
267 <listitem>
268 <para>Prints the FS type of a given filesystem, given either a
269 device name or label</para>
270 <indexterm zone="ch-system-e2fsprogs e2initrd_helper">
271 <primary sortas="b-e2initrd_helper">e2initrd_helper</primary>
272 </indexterm>
273 </listitem>
274 </varlistentry>
275
276 <varlistentry id="e2label">
277 <term><command>e2label</command></term>
278 <listitem>
279 <para>Displays or changes the file system label on the <systemitem
280 class="filesystem">ext2</systemitem> file system present on a given
281 device</para>
282 <indexterm zone="ch-system-e2fsprogs e2label">
283 <primary sortas="b-e2label">e2label</primary>
284 </indexterm>
285 </listitem>
286 </varlistentry>
287
288 <varlistentry id="e2undo">
289 <term><command>e2undo</command></term>
290 <listitem>
291 <para>Replays the undo log undo_log for an ext2/ext3/ext4 filesystem
292 found on a device. This can be used to undo a failed operation by an
293 e2fsprogs program.</para>
294 <indexterm zone="ch-system-e2fsprogs e2undo">
295 <primary sortas="b-e2undo">e2undo</primary>
296 </indexterm>
297 </listitem>
298 </varlistentry>
299
300 <varlistentry id="filefrag">
301 <term><command>filefrag</command></term>
302 <listitem>
303 <para>Reports on how badly fragmented a particular file might be</para>
304 <indexterm zone="ch-system-e2fsprogs filefrag">
305 <primary sortas="b-filefrag">filefrag</primary>
306 </indexterm>
307 </listitem>
308 </varlistentry>
309
310 <varlistentry id="findfs">
311 <term><command>findfs</command></term>
312 <listitem>
313 <para>Finds a file system by label or Universally Unique Identifier
314 (UUID)</para>
315 <indexterm zone="ch-system-e2fsprogs findfs">
316 <primary sortas="b-findfs">findfs</primary>
317 </indexterm>
318 </listitem>
319 </varlistentry>
320
321 <varlistentry id="fsck">
322 <term><command>fsck</command></term>
323 <listitem>
324 <para>Is used to check, and optionally repair, file systems</para>
325 <indexterm zone="ch-system-e2fsprogs fsck">
326 <primary sortas="b-fsck">fsck</primary>
327 </indexterm>
328 </listitem>
329 </varlistentry>
330
331 <varlistentry id="fsck.ext2">
332 <term><command>fsck.ext2</command></term>
333 <listitem>
334 <para>By default checks <systemitem class="filesystem">ext2</systemitem>
335 file systems. This is a hard link to <command>fsck</command>.</para>
336 <indexterm zone="ch-system-e2fsprogs fsck.ext2">
337 <primary sortas="b-fsck.ext2">fsck.ext2</primary>
338 </indexterm>
339 </listitem>
340 </varlistentry>
341
342 <varlistentry id="fsck.ext3">
343 <term><command>fsck.ext3</command></term>
344 <listitem>
345 <para>By default checks <systemitem class="filesystem">ext3</systemitem>
346 file systems. This is a hard link to <command>fsck</command>.</para>
347 <indexterm zone="ch-system-e2fsprogs fsck.ext3">
348 <primary sortas="b-fsck.ext3">fsck.ext3</primary>
349 </indexterm>
350 </listitem>
351 </varlistentry>
352
353 <varlistentry id="fsck.ext4">
354 <term><command>fsck.ext4</command></term>
355 <listitem>
356 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
357 file systems. This is a hard link to <command>fsck</command>.</para>
358 <indexterm zone="ch-system-e2fsprogs fsck.ext4">
359 <primary sortas="b-fsck.ext4">fsck.ext4</primary>
360 </indexterm>
361 </listitem>
362 </varlistentry>
363
364 <varlistentry id="fsck.ext4dev">
365 <term><command>fsck.ext4dev</command></term>
366 <listitem>
367 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
368 development file systems. This is a hard link to
369 <command>fsck</command>.</para>
370 <indexterm zone="ch-system-e2fsprogs fsck.ext4dev">
371 <primary sortas="b-fsck.ext4dev">fsck.ext4dev</primary>
372 </indexterm>
373 </listitem>
374 </varlistentry>
375
376 <varlistentry id="logsave">
377 <term><command>logsave</command></term>
378 <listitem>
379 <para>Saves the output of a command in a log file</para>
380 <indexterm zone="ch-system-e2fsprogs logsave">
381 <primary sortas="b-logsave">logsave</primary>
382 </indexterm>
383 </listitem>
384 </varlistentry>
385
386 <varlistentry id="lsattr">
387 <term><command>lsattr</command></term>
388 <listitem>
389 <para>Lists the attributes of files on a second extended file
390 system</para>
391 <indexterm zone="ch-system-e2fsprogs lsattr">
392 <primary sortas="b-lsattr">lsattr</primary>
393 </indexterm>
394 </listitem>
395 </varlistentry>
396
397 <varlistentry id="mk_cmds">
398 <term><command>mk_cmds</command></term>
399 <listitem>
400 <para>Converts a table of command names and help messages into a C
401 source file suitable for use with the <filename
402 class="libraryfile">libss</filename> subsystem library</para>
403 <indexterm zone="ch-system-e2fsprogs mk_cmds">
404 <primary sortas="b-mk_cmds">mk_cmds</primary>
405 </indexterm>
406 </listitem>
407 </varlistentry>
408
409 <varlistentry id="mke2fs">
410 <term><command>mke2fs</command></term>
411 <listitem>
412 <para>Creates an <systemitem class="filesystem">ext2</systemitem>
413 or <systemitem class="filesystem">ext3</systemitem> file system on
414 the given device</para>
415 <indexterm zone="ch-system-e2fsprogs mke2fs">
416 <primary sortas="b-mke2fs">mke2fs</primary>
417 </indexterm>
418 </listitem>
419 </varlistentry>
420
421 <varlistentry id="mkfs.ext2">
422 <term><command>mkfs.ext2</command></term>
423 <listitem>
424 <para>By default creates <systemitem class="filesystem">ext2</systemitem>
425 file systems. This is a hard link to <command>mke2fs</command>.</para>
426 <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
427 <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
428 </indexterm>
429 </listitem>
430 </varlistentry>
431
432 <varlistentry id="mkfs.ext3">
433 <term><command>mkfs.ext3</command></term>
434 <listitem>
435 <para>By default creates <systemitem class="filesystem">ext3</systemitem>
436 file systems. This is a hard link to <command>mke2fs</command>.</para>
437 <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
438 <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
439 </indexterm>
440 </listitem>
441 </varlistentry>
442
443 <varlistentry id="mkfs.ext4">
444 <term><command>mkfs.ext4</command></term>
445 <listitem>
446 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
447 file systems. This is a hard link to <command>mke2fs</command>.</para>
448 <indexterm zone="ch-system-e2fsprogs mkfs.ext4">
449 <primary sortas="b-mkfs.ext4">mkfs.ext4</primary>
450 </indexterm>
451 </listitem>
452 </varlistentry>
453
454 <varlistentry id="mkfs.ext4dev">
455 <term><command>mkfs.ext4dev</command></term>
456 <listitem>
457 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
458 development file systems. This is a hard link to <command>mke2fs</command>.</para>
459 <indexterm zone="ch-system-e2fsprogs mkfs.ext4dev">
460 <primary sortas="b-mkfs.ext4dev">mkfs.ext4dev</primary>
461 </indexterm>
462 </listitem>
463 </varlistentry>
464
465 <varlistentry id="mklost-found">
466 <term><command>mklost+found</command></term>
467 <listitem>
468 <para>Used to create a <filename class="directory">lost+found</filename>
469 directory on an <systemitem class="filesystem">ext2</systemitem> file
470 system; it pre-allocates disk blocks to this directory to lighten the
471 task of <command>e2fsck</command></para>
472 <indexterm zone="ch-system-e2fsprogs mklost-found">
473 <primary sortas="b-mklost+found">mklost+found</primary>
474 </indexterm>
475 </listitem>
476 </varlistentry>
477
478 <varlistentry id="resize2fs">
479 <term><command>resize2fs</command></term>
480 <listitem>
481 <para>Can be used to enlarge or shrink an <systemitem
482 class="filesystem">ext2</systemitem> file system</para>
483 <indexterm zone="ch-system-e2fsprogs resize2fs">
484 <primary sortas="b-resize2fs">resize2fs</primary>
485 </indexterm>
486 </listitem>
487 </varlistentry>
488
489 <varlistentry id="tune2fs">
490 <term><command>tune2fs</command></term>
491 <listitem>
492 <para>Adjusts tunable file system parameters on an <systemitem
493 class="filesystem">ext2</systemitem> file system</para>
494 <indexterm zone="ch-system-e2fsprogs tune2fs">
495 <primary sortas="b-tune2fs">tune2fs</primary>
496 </indexterm>
497 </listitem>
498 </varlistentry>
499
500 <varlistentry id="uuidd">
501 <term><command>uuidd</command></term>
502 <listitem>
503 <para>A daemon used by the UUID library to generate time-based
504 UUIDs in a secure and guranteed-unique fashion.</para>
505 <indexterm zone="ch-system-e2fsprogs uuidd">
506 <primary sortas="b-uuidd">uuidd</primary>
507 </indexterm>
508 </listitem>
509 </varlistentry>
510
511 <varlistentry id="uuidgen">
512 <term><command>uuidgen</command></term>
513 <listitem>
514 <para>Creates new UUIDs. Each new UUID can reasonably be considered
515 unique among all UUIDs created, on the local system and on other
516 systems, in the past and in the future</para>
517 <indexterm zone="ch-system-e2fsprogs uuidgen">
518 <primary sortas="b-uuidgen">uuidgen</primary>
519 </indexterm>
520 </listitem>
521 </varlistentry>
522
523 <varlistentry id="libcom_err">
524 <term><filename class="libraryfile">libcom_err</filename></term>
525 <listitem>
526 <para>The common error display routine</para>
527 <indexterm zone="ch-system-e2fsprogs libcom_err">
528 <primary sortas="c-libcom_err">libcom_err</primary>
529 </indexterm>
530 </listitem>
531 </varlistentry>
532
533 <varlistentry id="libe2p">
534 <term><filename class="libraryfile">libe2p</filename></term>
535 <listitem>
536 <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
537 and <command>lsattr</command></para>
538 <indexterm zone="ch-system-e2fsprogs libe2p">
539 <primary sortas="c-libe2p">libe2p</primary>
540 </indexterm>
541 </listitem>
542 </varlistentry>
543
544 <varlistentry id="libext2fs">
545 <term><filename class="libraryfile">libext2fs</filename></term>
546 <listitem>
547 <para>Contains routines to enable user-level programs to manipulate an
548 <systemitem class="filesystem">ext2</systemitem> file system</para>
549 <indexterm zone="ch-system-e2fsprogs libext2fs">
550 <primary sortas="c-libext2fs">libext2fs</primary>
551 </indexterm>
552 </listitem>
553 </varlistentry>
554
555 <varlistentry id="libss">
556 <term><filename class="libraryfile">libss</filename></term>
557 <listitem>
558 <para>Used by <command>debugfs</command></para>
559 <indexterm zone="ch-system-e2fsprogs libss">
560 <primary sortas="c-libss">libss</primary>
561 </indexterm>
562 </listitem>
563 </varlistentry>
564
565 </variablelist>
566
567 </sect2>
568
569</sect1>
Note: See TracBrowser for help on using the repository browser.