source: chapter06/e2fsprogs.xml@ 9f5aaf7

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.2 7.3 7.4 7.5 7.5-systemd 7.6 7.6-systemd 7.7 7.7-systemd 7.8 7.8-systemd 7.9 7.9-systemd 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 9f5aaf7 was 9f5aaf7, checked in by Bruce Dubbs <bdubbs@…>, 12 years ago

Add whitespace for better readability of instructions

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