source: chapter06/e2fsprogs.xml@ 2ca8941

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.3 7.4 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 2ca8941 was 2ca8941, checked in by Matthew Burgess <matthew@…>, 11 years ago

Remove trailing whitespace from all files.

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