source: chapter06/e2fsprogs.xml@ 6033f00

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 6033f00 was 6033f00, checked in by Bruce Dubbs <bdubbs@…>, 15 years ago

Remove the sed in e2fsprogs that soes nothing for the new release.

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