source: chapter06/e2fsprogs.xml@ fd824cf

10.0 10.0-rc1 10.1 10.1-rc1 11.0 11.0-rc1 11.0-rc2 11.0-rc3 8.3 8.3-rc1 8.3-rc2 8.4 8.4-rc1 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 fd824cf was fd824cf, checked in by Bruce Dubbs <bdubbs@…>, 3 years ago

Revert inadvertant changes to e2fsprogs instructions

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

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