source: chapter06/e2fsprogs.xml@ f6b1d91

10.0 10.0-rc1 10.1 10.1-rc1 11.0 11.0-rc1 11.0-rc2 11.0-rc3 11.1 11.1-rc1 11.2 11.2-rc1 11.3 11.3-rc1 12.0 12.0-rc1 12.1 12.1-rc1 7.5 7.6 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 arm bdubbs/gcc13 ml-11.0 multilib renodr/libudev-from-systemd s6-init trunk xry111/arm64 xry111/arm64-12.0 xry111/clfs-ng xry111/lfs-next xry111/loongarch xry111/loongarch-12.0 xry111/loongarch-12.1 xry111/mips64el xry111/pip3 xry111/rust-wip-20221008 xry111/update-glibc
Last change on this file since f6b1d91 was f6b1d91, checked in by Bruce Dubbs <bdubbs@…>, 10 years ago

Updates to the installed programs lists for several packages

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