source: chapter06/e2fsprogs.xml@ 6f34f43

7.6-systemd 7.7-systemd 7.8-systemd 7.9-systemd
Last change on this file since 6f34f43 was 6f34f43, checked in by Krejzi <krejzi@…>, 10 years ago

Merge latest lfs svn work into systemd branch. Better to be safe than sorry.

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