source: chapter08/e2fsprogs.xml@ cd152f22

10.1 10.1-rc1 11.0 11.0-rc1 11.0-rc2 11.0-rc3 ml-11.0 multilib trunk xry111/git-transition xry111/glibc-2.34 xry111/tester-nohack xry111/usr-move
Last change on this file since cd152f22 was cd152f22, checked in by Xi Ruoyao <xry111@…>, 10 months ago

remove unneeded static libraries

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

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