source: chapter06/e2fsprogs.xml@ d8a8713

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

Merge changes from trunk

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