source: chapter06/e2fsprogs.xml@ 9122ffe

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

Update to util-linux-2.16, udev-145, e2fsprogs-1.41.8.

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