source: chapter06/e2fsprogs.xml@ 1b3d6df7

10.0 10.0-rc1 10.1 10.1-rc1 11.0 11.0-rc1 11.0-rc2 11.0-rc3 9.0 9.0-rc1 9.1 9.1-rc1 cross-chap5 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 1b3d6df7 was 1b3d6df7, checked in by Bruce Dubbs <bdubbs@…>, 3 years ago

Update to man-pages-5.01.
Update to linux-5.1.3.
Update to iproute2-5.1.0.
Update to gettext-0.20.1.
Update to file-5.37.
Update to e2fsprogs-1.45.1.

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

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