source: chapter06/e2fsprogs.xml@ 55fa5a3

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

Various minor text changes.

git-svn-id: ​http://svn.linuxfromscratch.org/LFS/trunk/BOOK@8903 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689
  • Property mode set to 100644
File size: 21.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</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/{libblkid,libcom_err,libe2p,libext2fs,libss,libuuid}.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
135
136install -v -m644 -D ../doc/libblkid.txt \
137 /usr/share/doc/e2fsprogs-&e2fsprogs-version;/libblkid.txt</userinput></screen>
138
139 </sect2>
140
141 <sect2 id="contents-e2fsprogs" role="content">
142 <title>Contents of E2fsprogs</title>
143
144 <segmentedlist>
145 <segtitle>Installed programs</segtitle>
146 <segtitle>Installed libraries</segtitle>
147
148 <seglistitem>
149 <seg>badblocks, blkid, chattr, compile_et, debugfs, dumpe2fs, e2fsck,
150 e2image, e2initrd_helper, e2label, e2undo, filefrag, findfs, fsck,
151 fsck.ext2, fsck.ext3, fsck.ext4, fsck.ext4dev, logsave, lsattr,
152 mk_cmds, mke2fs, mkfs.ext2, mkfs.ext3, mkfs.ext4, mkfs.ext4dev,
153 mklost+found, resize2fs, tune2fs, uuidd, and uuidgen.</seg>
154 <seg>libblkid.{a,so}, libcom_err.{a,so}, libe2p.{a,so},
155 libext2fs.{a,so}, libss.{a,so}, and libuuid.{a,so}</seg>
156 </seglistitem>
157 </segmentedlist>
158
159 <variablelist>
160 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
161 <?dbfo list-presentation="list"?>
162 <?dbhtml list-presentation="table"?>
163
164 <varlistentry id="badblocks">
165 <term><command>badblocks</command></term>
166 <listitem>
167 <para>Searches a device (usually a disk partition) for bad
168 blocks</para>
169 <indexterm zone="ch-system-e2fsprogs badblocks">
170 <primary sortas="b-badblocks">badblocks</primary>
171 </indexterm>
172 </listitem>
173 </varlistentry>
174
175 <varlistentry id="blkid">
176 <term><command>blkid</command></term>
177 <listitem>
178 <para>A command line utility to locate and print block device
179 attributes</para>
180 <indexterm zone="ch-system-e2fsprogs blkid">
181 <primary sortas="b-blkid">blkid</primary>
182 </indexterm>
183 </listitem>
184 </varlistentry>
185
186 <varlistentry id="chattr">
187 <term><command>chattr</command></term>
188 <listitem>
189 <para>Changes the attributes of files on an <systemitem
190 class="filesystem">ext2</systemitem> file system; it also
191 changes <systemitem class="filesystem">ext3</systemitem>
192 file systems, the journaling version of <systemitem
193 class="filesystem">ext2</systemitem> file systems</para>
194 <indexterm zone="ch-system-e2fsprogs chattr">
195 <primary sortas="b-chattr">chattr</primary>
196 </indexterm>
197 </listitem>
198 </varlistentry>
199
200 <varlistentry id="compile_et">
201 <term><command>compile_et</command></term>
202 <listitem>
203 <para>An error table compiler; it converts a table of error-code
204 names and messages into a C source file suitable for use with the
205 <filename class="libraryfile">com_err</filename> library</para>
206 <indexterm zone="ch-system-e2fsprogs compile_et">
207 <primary sortas="b-compile_et">compile_et</primary>
208 </indexterm>
209 </listitem>
210 </varlistentry>
211
212 <varlistentry id="debugfs">
213 <term><command>debugfs</command></term>
214 <listitem>
215 <para>A file system debugger; it can be used to examine and change
216 the state of an <systemitem class="filesystem">ext2</systemitem>
217 file system</para>
218 <indexterm zone="ch-system-e2fsprogs debugfs">
219 <primary sortas="b-debugfs">debugfs</primary>
220 </indexterm>
221 </listitem>
222 </varlistentry>
223
224 <varlistentry id="dumpe2fs">
225 <term><command>dumpe2fs</command></term>
226 <listitem>
227 <para>Prints the super block and blocks group information for the
228 file system present on a given device</para>
229 <indexterm zone="ch-system-e2fsprogs dumpe2fs">
230 <primary sortas="b-dumpe2fs">dumpe2fs</primary>
231 </indexterm>
232 </listitem>
233 </varlistentry>
234
235 <varlistentry id="e2fsck">
236 <term><command>e2fsck</command></term>
237 <listitem>
238 <para>Is used to check, and optionally repair <systemitem
239 class="filesystem">ext2</systemitem> file systems and <systemitem
240 class="filesystem">ext3</systemitem> file systems</para>
241 <indexterm zone="ch-system-e2fsprogs e2fsck">
242 <primary sortas="b-e2fsck">e2fsck</primary>
243 </indexterm>
244 </listitem>
245 </varlistentry>
246
247 <varlistentry id="e2image">
248 <term><command>e2image</command></term>
249 <listitem>
250 <para>Is used to save critical <systemitem
251 class="filesystem">ext2</systemitem> file system data to a file</para>
252 <indexterm zone="ch-system-e2fsprogs e2image">
253 <primary sortas="b-e2image">e2image</primary>
254 </indexterm>
255 </listitem>
256 </varlistentry>
257
258 <varlistentry id="e2initrd_helper">
259 <term><command>e2initrd_helper</command></term>
260 <listitem>
261 <para>Prints the FS type of a given filesystem, given either a
262 device name or label</para>
263 <indexterm zone="ch-system-e2fsprogs e2initrd_helper">
264 <primary sortas="b-e2initrd_helper">e2initrd_helper</primary>
265 </indexterm>
266 </listitem>
267 </varlistentry>
268
269 <varlistentry id="e2label">
270 <term><command>e2label</command></term>
271 <listitem>
272 <para>Displays or changes the file system label on the <systemitem
273 class="filesystem">ext2</systemitem> file system present on a given
274 device</para>
275 <indexterm zone="ch-system-e2fsprogs e2label">
276 <primary sortas="b-e2label">e2label</primary>
277 </indexterm>
278 </listitem>
279 </varlistentry>
280
281 <varlistentry id="e2undo">
282 <term><command>e2undo</command></term>
283 <listitem>
284 <para>Replays the undo log undo_log for an ext2/ext3/ext4 filesystem
285 found on a device. This can be used to undo a failed operation by an
286 e2fsprogs program.</para>
287 <indexterm zone="ch-system-e2fsprogs e2undo">
288 <primary sortas="b-e2undo">e2undo</primary>
289 </indexterm>
290 </listitem>
291 </varlistentry>
292
293 <varlistentry id="filefrag">
294 <term><command>filefrag</command></term>
295 <listitem>
296 <para>Reports on how badly fragmented a particular file might be</para>
297 <indexterm zone="ch-system-e2fsprogs filefrag">
298 <primary sortas="b-filefrag">filefrag</primary>
299 </indexterm>
300 </listitem>
301 </varlistentry>
302
303 <varlistentry id="findfs">
304 <term><command>findfs</command></term>
305 <listitem>
306 <para>Finds a file system by label or Universally Unique Identifier
307 (UUID)</para>
308 <indexterm zone="ch-system-e2fsprogs findfs">
309 <primary sortas="b-findfs">findfs</primary>
310 </indexterm>
311 </listitem>
312 </varlistentry>
313
314 <varlistentry id="fsck">
315 <term><command>fsck</command></term>
316 <listitem>
317 <para>Is used to check, and optionally repair, file systems</para>
318 <indexterm zone="ch-system-e2fsprogs fsck">
319 <primary sortas="b-fsck">fsck</primary>
320 </indexterm>
321 </listitem>
322 </varlistentry>
323
324 <varlistentry id="fsck.ext2">
325 <term><command>fsck.ext2</command></term>
326 <listitem>
327 <para>By default checks <systemitem class="filesystem">ext2</systemitem>
328 file systems. This is a hard link to <command>fsck</command>.</para>
329 <indexterm zone="ch-system-e2fsprogs fsck.ext2">
330 <primary sortas="b-fsck.ext2">fsck.ext2</primary>
331 </indexterm>
332 </listitem>
333 </varlistentry>
334
335 <varlistentry id="fsck.ext3">
336 <term><command>fsck.ext3</command></term>
337 <listitem>
338 <para>By default checks <systemitem class="filesystem">ext3</systemitem>
339 file systems. This is a hard link to <command>fsck</command>.</para>
340 <indexterm zone="ch-system-e2fsprogs fsck.ext3">
341 <primary sortas="b-fsck.ext3">fsck.ext3</primary>
342 </indexterm>
343 </listitem>
344 </varlistentry>
345
346 <varlistentry id="fsck.ext4">
347 <term><command>fsck.ext4</command></term>
348 <listitem>
349 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
350 file systems. This is a hard link to <command>fsck</command>.</para>
351 <indexterm zone="ch-system-e2fsprogs fsck.ext4">
352 <primary sortas="b-fsck.ext4">fsck.ext4</primary>
353 </indexterm>
354 </listitem>
355 </varlistentry>
356
357 <varlistentry id="fsck.ext4dev">
358 <term><command>fsck.ext4dev</command></term>
359 <listitem>
360 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
361 development file systems. This is a hard link to
362 <command>fsck</command>.</para>
363 <indexterm zone="ch-system-e2fsprogs fsck.ext4dev">
364 <primary sortas="b-fsck.ext4dev">fsck.ext4dev</primary>
365 </indexterm>
366 </listitem>
367 </varlistentry>
368
369 <varlistentry id="logsave">
370 <term><command>logsave</command></term>
371 <listitem>
372 <para>Saves the output of a command in a log file</para>
373 <indexterm zone="ch-system-e2fsprogs logsave">
374 <primary sortas="b-logsave">logsave</primary>
375 </indexterm>
376 </listitem>
377 </varlistentry>
378
379 <varlistentry id="lsattr">
380 <term><command>lsattr</command></term>
381 <listitem>
382 <para>Lists the attributes of files on a second extended file
383 system</para>
384 <indexterm zone="ch-system-e2fsprogs lsattr">
385 <primary sortas="b-lsattr">lsattr</primary>
386 </indexterm>
387 </listitem>
388 </varlistentry>
389
390 <varlistentry id="mk_cmds">
391 <term><command>mk_cmds</command></term>
392 <listitem>
393 <para>Converts a table of command names and help messages into a C
394 source file suitable for use with the <filename
395 class="libraryfile">libss</filename> subsystem library</para>
396 <indexterm zone="ch-system-e2fsprogs mk_cmds">
397 <primary sortas="b-mk_cmds">mk_cmds</primary>
398 </indexterm>
399 </listitem>
400 </varlistentry>
401
402 <varlistentry id="mke2fs">
403 <term><command>mke2fs</command></term>
404 <listitem>
405 <para>Creates an <systemitem class="filesystem">ext2</systemitem>
406 or <systemitem class="filesystem">ext3</systemitem> file system on
407 the given device</para>
408 <indexterm zone="ch-system-e2fsprogs mke2fs">
409 <primary sortas="b-mke2fs">mke2fs</primary>
410 </indexterm>
411 </listitem>
412 </varlistentry>
413
414 <varlistentry id="mkfs.ext2">
415 <term><command>mkfs.ext2</command></term>
416 <listitem>
417 <para>By default creates <systemitem class="filesystem">ext2</systemitem>
418 file systems. This is a hard link to <command>mke2fs</command>.</para>
419 <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
420 <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
421 </indexterm>
422 </listitem>
423 </varlistentry>
424
425 <varlistentry id="mkfs.ext3">
426 <term><command>mkfs.ext3</command></term>
427 <listitem>
428 <para>By default creates <systemitem class="filesystem">ext3</systemitem>
429 file systems. This is a hard link to <command>mke2fs</command>.</para>
430 <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
431 <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
432 </indexterm>
433 </listitem>
434 </varlistentry>
435
436 <varlistentry id="mkfs.ext4">
437 <term><command>mkfs.ext4</command></term>
438 <listitem>
439 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
440 file systems. This is a hard link to <command>mke2fs</command>.</para>
441 <indexterm zone="ch-system-e2fsprogs mkfs.ext4">
442 <primary sortas="b-mkfs.ext4">mkfs.ext4</primary>
443 </indexterm>
444 </listitem>
445 </varlistentry>
446
447 <varlistentry id="mkfs.ext4dev">
448 <term><command>mkfs.ext4dev</command></term>
449 <listitem>
450 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
451 development file systems. This is a hard link to <command>mke2fs</command>.</para>
452 <indexterm zone="ch-system-e2fsprogs mkfs.ext4dev">
453 <primary sortas="b-mkfs.ext4dev">mkfs.ext4dev</primary>
454 </indexterm>
455 </listitem>
456 </varlistentry>
457
458 <varlistentry id="mklost-found">
459 <term><command>mklost+found</command></term>
460 <listitem>
461 <para>Used to create a <filename class="directory">lost+found</filename>
462 directory on an <systemitem class="filesystem">ext2</systemitem> file
463 system; it pre-allocates disk blocks to this directory to lighten the
464 task of <command>e2fsck</command></para>
465 <indexterm zone="ch-system-e2fsprogs mklost-found">
466 <primary sortas="b-mklost+found">mklost+found</primary>
467 </indexterm>
468 </listitem>
469 </varlistentry>
470
471 <varlistentry id="resize2fs">
472 <term><command>resize2fs</command></term>
473 <listitem>
474 <para>Can be used to enlarge or shrink an <systemitem
475 class="filesystem">ext2</systemitem> file system</para>
476 <indexterm zone="ch-system-e2fsprogs resize2fs">
477 <primary sortas="b-resize2fs">resize2fs</primary>
478 </indexterm>
479 </listitem>
480 </varlistentry>
481
482 <varlistentry id="tune2fs">
483 <term><command>tune2fs</command></term>
484 <listitem>
485 <para>Adjusts tunable file system parameters on an <systemitem
486 class="filesystem">ext2</systemitem> file system</para>
487 <indexterm zone="ch-system-e2fsprogs tune2fs">
488 <primary sortas="b-tune2fs">tune2fs</primary>
489 </indexterm>
490 </listitem>
491 </varlistentry>
492
493 <varlistentry id="uuidd">
494 <term><command>uuidd</command></term>
495 <listitem>
496 <para>A daemon used by the UUID library to generate time-based
497 UUIDs in a secure and guranteed-unique fashion.</para>
498 <indexterm zone="ch-system-e2fsprogs uuidd">
499 <primary sortas="b-uuidd">uuidd</primary>
500 </indexterm>
501 </listitem>
502 </varlistentry>
503
504 <varlistentry id="uuidgen">
505 <term><command>uuidgen</command></term>
506 <listitem>
507 <para>Creates new UUIDs. Each new UUID can reasonably be considered
508 unique among all UUIDs created, on the local system and on other
509 systems, in the past and in the future</para>
510 <indexterm zone="ch-system-e2fsprogs uuidgen">
511 <primary sortas="b-uuidgen">uuidgen</primary>
512 </indexterm>
513 </listitem>
514 </varlistentry>
515
516 <varlistentry id="libblkid">
517 <term><filename class="libraryfile">libblkid</filename></term>
518 <listitem>
519 <para>Contains routines for device identification and token
520 extraction</para>
521 <indexterm zone="ch-system-e2fsprogs libblkid">
522 <primary sortas="c-libblkid">libblkid</primary>
523 </indexterm>
524 </listitem>
525 </varlistentry>
526
527 <varlistentry id="libcom_err">
528 <term><filename class="libraryfile">libcom_err</filename></term>
529 <listitem>
530 <para>The common error display routine</para>
531 <indexterm zone="ch-system-e2fsprogs libcom_err">
532 <primary sortas="c-libcom_err">libcom_err</primary>
533 </indexterm>
534 </listitem>
535 </varlistentry>
536
537 <varlistentry id="libe2p">
538 <term><filename class="libraryfile">libe2p</filename></term>
539 <listitem>
540 <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
541 and <command>lsattr</command></para>
542 <indexterm zone="ch-system-e2fsprogs libe2p">
543 <primary sortas="c-libe2p">libe2p</primary>
544 </indexterm>
545 </listitem>
546 </varlistentry>
547
548 <varlistentry id="libext2fs">
549 <term><filename class="libraryfile">libext2fs</filename></term>
550 <listitem>
551 <para>Contains routines to enable user-level programs to manipulate an
552 <systemitem class="filesystem">ext2</systemitem> file system</para>
553 <indexterm zone="ch-system-e2fsprogs libext2fs">
554 <primary sortas="c-libext2fs">libext2fs</primary>
555 </indexterm>
556 </listitem>
557 </varlistentry>
558
559 <varlistentry id="libss">
560 <term><filename class="libraryfile">libss</filename></term>
561 <listitem>
562 <para>Used by <command>debugfs</command></para>
563 <indexterm zone="ch-system-e2fsprogs libss">
564 <primary sortas="c-libss">libss</primary>
565 </indexterm>
566 </listitem>
567 </varlistentry>
568
569 <varlistentry id="libuuid">
570 <term><filename class="libraryfile">libuuid</filename></term>
571 <listitem>
572 <para>Contains routines for generating unique identifiers for objects
573 that may be accessible beyond the local system</para>
574 <indexterm zone="ch-system-e2fsprogs libuuid">
575 <primary sortas="c-libuuid">libuuid</primary>
576 </indexterm>
577 </listitem>
578 </varlistentry>
579
580 </variablelist>
581
582 </sect2>
583
584</sect1>
Note: See TracBrowser for help on using the repository browser.