source: chapter06/e2fsprogs.xml@ 784b3bb

10.0 10.0-rc1 10.1 10.1-rc1 11.0 11.0-rc1 11.0-rc2 11.0-rc3 ml-11.0 multilib old-trunk trunk xry111/git-transition xry111/glibc-2.34 xry111/tester-nohack xry111/usr-move
Last change on this file since 784b3bb was 784b3bb, checked in by Bruce Dubbs <bdubbs@…>, 19 months ago

Update to bison-3.6.
Update to gcc-10.1.0.
Update to libcap-2.34.
Update to bc-2.7.2.
Update to linux-5.6.11.

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

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