source: chapter08/e2fsprogs.xml@ efa633e

multilib-10.1
Last change on this file since efa633e was efa633e, checked in by Thomas Trepl <thomas@…>, 3 years ago

Merge changes from trunk to multilib

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