source: chapter08/e2fsprogs.xml@ 37e35d2

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

Update to new lfs structure

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