source: chapter06/e2fsprogs.xml@ 182ec8e

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 6.6 6.7 6.8 7.0 7.1 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 182ec8e was 182ec8e, checked in by Bruce Dubbs <bdubbs@…>, 14 years ago

Fix an error in e2fsprogs

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