source: chapter06/e2fsprogs.xml@ e1428f3

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.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 e1428f3 was e1428f3, checked in by Bruce Dubbs <bdubbs@…>, 13 years ago

Upgrade to Util-linux-2.19. Changed name from util-linux-ng.

git-svn-id: ​http://svn.linuxfromscratch.org/LFS/trunk/BOOK@9459 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689
  • Property mode set to 100644
File size: 19.8 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 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 <segtitle>Installed directory</segtitle>
152
153 <seglistitem>
154 <seg>badblocks, chattr, compile_et, debugfs, dumpe2fs, e2freefrag,
155 e2fsck, e2image, e2initrd_helper, e2label, e2undo, filefrag, fsck.ext2,
156 fsck.ext3, fsck.ext4, fsck.ext4dev, logsave, lsattr, mk_cmds, mke2fs,
157 mkfs.ext2, mkfs.ext3, mkfs.ext4, mkfs.ext4dev, mklost+found,
158 resize2fs, and tune2fs</seg>
159 <seg>libcom_err.{a,so}, libe2p.{a,so}, libext2fs.{a,so} and
160 libss.{a,so}</seg>
161 <seg>/usr/include/e2p, /usr/include/et, /usr/include/ext2fs,
162 /usr/include/ss, /usr/share/et, /usr/share/ss</seg>
163 </seglistitem>
164 </segmentedlist>
165
166 <variablelist>
167 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
168 <?dbfo list-presentation="list"?>
169 <?dbhtml list-presentation="table"?>
170
171 <varlistentry id="badblocks">
172 <term><command>badblocks</command></term>
173 <listitem>
174 <para>Searches a device (usually a disk partition) for bad
175 blocks</para>
176 <indexterm zone="ch-system-e2fsprogs badblocks">
177 <primary sortas="b-badblocks">badblocks</primary>
178 </indexterm>
179 </listitem>
180 </varlistentry>
181
182 <varlistentry id="chattr">
183 <term><command>chattr</command></term>
184 <listitem>
185 <para>Changes the attributes of files on an <systemitem
186 class="filesystem">ext2</systemitem> file system; it also
187 changes <systemitem class="filesystem">ext3</systemitem>
188 file systems, the journaling version of <systemitem
189 class="filesystem">ext2</systemitem> file systems</para>
190 <indexterm zone="ch-system-e2fsprogs chattr">
191 <primary sortas="b-chattr">chattr</primary>
192 </indexterm>
193 </listitem>
194 </varlistentry>
195
196 <varlistentry id="compile_et">
197 <term><command>compile_et</command></term>
198 <listitem>
199 <para>An error table compiler; it converts a table of error-code
200 names and messages into a C source file suitable for use with the
201 <filename class="libraryfile">com_err</filename> library</para>
202 <indexterm zone="ch-system-e2fsprogs compile_et">
203 <primary sortas="b-compile_et">compile_et</primary>
204 </indexterm>
205 </listitem>
206 </varlistentry>
207
208 <varlistentry id="debugfs">
209 <term><command>debugfs</command></term>
210 <listitem>
211 <para>A file system debugger; it can be used to examine and change
212 the state of an <systemitem class="filesystem">ext2</systemitem>
213 file system</para>
214 <indexterm zone="ch-system-e2fsprogs debugfs">
215 <primary sortas="b-debugfs">debugfs</primary>
216 </indexterm>
217 </listitem>
218 </varlistentry>
219
220 <varlistentry id="dumpe2fs">
221 <term><command>dumpe2fs</command></term>
222 <listitem>
223 <para>Prints the super block and blocks group information for the
224 file system present on a given device</para>
225 <indexterm zone="ch-system-e2fsprogs dumpe2fs">
226 <primary sortas="b-dumpe2fs">dumpe2fs</primary>
227 </indexterm>
228 </listitem>
229 </varlistentry>
230
231 <varlistentry id="e2freefrag">
232 <term><command>e2freefrag</command></term>
233 <listitem>
234 <para> Reports free space fragmentation information</para>
235 <indexterm zone="ch-system-e2fsprogs e2freefrag">
236 <primary sortas="b-e2freefrag">e2freefrag</primary>
237 </indexterm>
238 </listitem>
239 </varlistentry>
240
241 <varlistentry id="e2fsck">
242 <term><command>e2fsck</command></term>
243 <listitem>
244 <para>Is used to check, and optionally repair <systemitem
245 class="filesystem">ext2</systemitem> file systems and <systemitem
246 class="filesystem">ext3</systemitem> file systems</para>
247 <indexterm zone="ch-system-e2fsprogs e2fsck">
248 <primary sortas="b-e2fsck">e2fsck</primary>
249 </indexterm>
250 </listitem>
251 </varlistentry>
252
253 <varlistentry id="e2image">
254 <term><command>e2image</command></term>
255 <listitem>
256 <para>Is used to save critical <systemitem
257 class="filesystem">ext2</systemitem> file system data to a file</para>
258 <indexterm zone="ch-system-e2fsprogs e2image">
259 <primary sortas="b-e2image">e2image</primary>
260 </indexterm>
261 </listitem>
262 </varlistentry>
263
264 <varlistentry id="e2initrd_helper">
265 <term><command>e2initrd_helper</command></term>
266 <listitem>
267 <para>Prints the FS type of a given filesystem, given either a
268 device name or label</para>
269 <indexterm zone="ch-system-e2fsprogs e2initrd_helper">
270 <primary sortas="b-e2initrd_helper">e2initrd_helper</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>
274
275 <varlistentry id="e2label">
276 <term><command>e2label</command></term>
277 <listitem>
278 <para>Displays or changes the file system label on the <systemitem
279 class="filesystem">ext2</systemitem> file system present on a given
280 device</para>
281 <indexterm zone="ch-system-e2fsprogs e2label">
282 <primary sortas="b-e2label">e2label</primary>
283 </indexterm>
284 </listitem>
285 </varlistentry>
286
287 <varlistentry id="e2undo">
288 <term><command>e2undo</command></term>
289 <listitem>
290 <para>Replays the undo log undo_log for an ext2/ext3/ext4 filesystem
291 found on a device. This can be used to undo a failed operation by an
292 e2fsprogs program.</para>
293 <indexterm zone="ch-system-e2fsprogs e2undo">
294 <primary sortas="b-e2undo">e2undo</primary>
295 </indexterm>
296 </listitem>
297 </varlistentry>
298
299 <varlistentry id="filefrag">
300 <term><command>filefrag</command></term>
301 <listitem>
302 <para>Reports on how badly fragmented a particular file might be</para>
303 <indexterm zone="ch-system-e2fsprogs filefrag">
304 <primary sortas="b-filefrag">filefrag</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308
309 <varlistentry id="fsck.ext2">
310 <term><command>fsck.ext2</command></term>
311 <listitem>
312 <para>By default checks <systemitem class="filesystem">ext2</systemitem>
313 file systems. This is a hard link to <command>e2fsck</command>.</para>
314 <indexterm zone="ch-system-e2fsprogs fsck.ext2">
315 <primary sortas="b-fsck.ext2">fsck.ext2</primary>
316 </indexterm>
317 </listitem>
318 </varlistentry>
319
320 <varlistentry id="fsck.ext3">
321 <term><command>fsck.ext3</command></term>
322 <listitem>
323 <para>By default checks <systemitem class="filesystem">ext3</systemitem>
324 file systems. This is a hard link to <command>e2fsck</command>.</para>
325 <indexterm zone="ch-system-e2fsprogs fsck.ext3">
326 <primary sortas="b-fsck.ext3">fsck.ext3</primary>
327 </indexterm>
328 </listitem>
329 </varlistentry>
330
331 <varlistentry id="fsck.ext4">
332 <term><command>fsck.ext4</command></term>
333 <listitem>
334 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
335 file systems. This is a hard link to <command>e2fsck</command>.</para>
336 <indexterm zone="ch-system-e2fsprogs fsck.ext4">
337 <primary sortas="b-fsck.ext4">fsck.ext4</primary>
338 </indexterm>
339 </listitem>
340 </varlistentry>
341
342 <varlistentry id="fsck.ext4dev">
343 <term><command>fsck.ext4dev</command></term>
344 <listitem>
345 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
346 development file systems. This is a hard link to
347 <command>e2fsck</command>.</para>
348 <indexterm zone="ch-system-e2fsprogs fsck.ext4dev">
349 <primary sortas="b-fsck.ext4dev">fsck.ext4dev</primary>
350 </indexterm>
351 </listitem>
352 </varlistentry>
353
354 <varlistentry id="logsave">
355 <term><command>logsave</command></term>
356 <listitem>
357 <para>Saves the output of a command in a log file</para>
358 <indexterm zone="ch-system-e2fsprogs logsave">
359 <primary sortas="b-logsave">logsave</primary>
360 </indexterm>
361 </listitem>
362 </varlistentry>
363
364 <varlistentry id="lsattr">
365 <term><command>lsattr</command></term>
366 <listitem>
367 <para>Lists the attributes of files on a second extended file
368 system</para>
369 <indexterm zone="ch-system-e2fsprogs lsattr">
370 <primary sortas="b-lsattr">lsattr</primary>
371 </indexterm>
372 </listitem>
373 </varlistentry>
374
375 <varlistentry id="mk_cmds">
376 <term><command>mk_cmds</command></term>
377 <listitem>
378 <para>Converts a table of command names and help messages into a C
379 source file suitable for use with the <filename
380 class="libraryfile">libss</filename> subsystem library</para>
381 <indexterm zone="ch-system-e2fsprogs mk_cmds">
382 <primary sortas="b-mk_cmds">mk_cmds</primary>
383 </indexterm>
384 </listitem>
385 </varlistentry>
386
387 <varlistentry id="mke2fs">
388 <term><command>mke2fs</command></term>
389 <listitem>
390 <para>Creates an <systemitem class="filesystem">ext2</systemitem>
391 or <systemitem class="filesystem">ext3</systemitem> file system on
392 the given device</para>
393 <indexterm zone="ch-system-e2fsprogs mke2fs">
394 <primary sortas="b-mke2fs">mke2fs</primary>
395 </indexterm>
396 </listitem>
397 </varlistentry>
398
399 <varlistentry id="mkfs.ext2">
400 <term><command>mkfs.ext2</command></term>
401 <listitem>
402 <para>By default creates <systemitem class="filesystem">ext2</systemitem>
403 file systems. This is a hard link to <command>mke2fs</command>.</para>
404 <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
405 <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
406 </indexterm>
407 </listitem>
408 </varlistentry>
409
410 <varlistentry id="mkfs.ext3">
411 <term><command>mkfs.ext3</command></term>
412 <listitem>
413 <para>By default creates <systemitem class="filesystem">ext3</systemitem>
414 file systems. This is a hard link to <command>mke2fs</command>.</para>
415 <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
416 <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
417 </indexterm>
418 </listitem>
419 </varlistentry>
420
421 <varlistentry id="mkfs.ext4">
422 <term><command>mkfs.ext4</command></term>
423 <listitem>
424 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
425 file systems. This is a hard link to <command>mke2fs</command>.</para>
426 <indexterm zone="ch-system-e2fsprogs mkfs.ext4">
427 <primary sortas="b-mkfs.ext4">mkfs.ext4</primary>
428 </indexterm>
429 </listitem>
430 </varlistentry>
431
432 <varlistentry id="mkfs.ext4dev">
433 <term><command>mkfs.ext4dev</command></term>
434 <listitem>
435 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
436 development file systems. This is a hard link to <command>mke2fs</command>.</para>
437 <indexterm zone="ch-system-e2fsprogs mkfs.ext4dev">
438 <primary sortas="b-mkfs.ext4dev">mkfs.ext4dev</primary>
439 </indexterm>
440 </listitem>
441 </varlistentry>
442
443 <varlistentry id="mklost-found">
444 <term><command>mklost+found</command></term>
445 <listitem>
446 <para>Used to create a <filename class="directory">lost+found</filename>
447 directory on an <systemitem class="filesystem">ext2</systemitem> file
448 system; it pre-allocates disk blocks to this directory to lighten the
449 task of <command>e2fsck</command></para>
450 <indexterm zone="ch-system-e2fsprogs mklost-found">
451 <primary sortas="b-mklost+found">mklost+found</primary>
452 </indexterm>
453 </listitem>
454 </varlistentry>
455
456 <varlistentry id="resize2fs">
457 <term><command>resize2fs</command></term>
458 <listitem>
459 <para>Can be used to enlarge or shrink an <systemitem
460 class="filesystem">ext2</systemitem> file system</para>
461 <indexterm zone="ch-system-e2fsprogs resize2fs">
462 <primary sortas="b-resize2fs">resize2fs</primary>
463 </indexterm>
464 </listitem>
465 </varlistentry>
466
467 <varlistentry id="tune2fs">
468 <term><command>tune2fs</command></term>
469 <listitem>
470 <para>Adjusts tunable file system parameters on an <systemitem
471 class="filesystem">ext2</systemitem> file system</para>
472 <indexterm zone="ch-system-e2fsprogs tune2fs">
473 <primary sortas="b-tune2fs">tune2fs</primary>
474 </indexterm>
475 </listitem>
476 </varlistentry>
477
478 <varlistentry id="libcom_err">
479 <term><filename class="libraryfile">libcom_err</filename></term>
480 <listitem>
481 <para>The common error display routine</para>
482 <indexterm zone="ch-system-e2fsprogs libcom_err">
483 <primary sortas="c-libcom_err">libcom_err</primary>
484 </indexterm>
485 </listitem>
486 </varlistentry>
487
488 <varlistentry id="libe2p">
489 <term><filename class="libraryfile">libe2p</filename></term>
490 <listitem>
491 <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
492 and <command>lsattr</command></para>
493 <indexterm zone="ch-system-e2fsprogs libe2p">
494 <primary sortas="c-libe2p">libe2p</primary>
495 </indexterm>
496 </listitem>
497 </varlistentry>
498
499 <varlistentry id="libext2fs">
500 <term><filename class="libraryfile">libext2fs</filename></term>
501 <listitem>
502 <para>Contains routines to enable user-level programs to manipulate an
503 <systemitem class="filesystem">ext2</systemitem> file system</para>
504 <indexterm zone="ch-system-e2fsprogs libext2fs">
505 <primary sortas="c-libext2fs">libext2fs</primary>
506 </indexterm>
507 </listitem>
508 </varlistentry>
509
510 <varlistentry id="libss">
511 <term><filename class="libraryfile">libss</filename></term>
512 <listitem>
513 <para>Used by <command>debugfs</command></para>
514 <indexterm zone="ch-system-e2fsprogs libss">
515 <primary sortas="c-libss">libss</primary>
516 </indexterm>
517 </listitem>
518 </varlistentry>
519
520 </variablelist>
521
522 </sect2>
523
524</sect1>
Note: See TracBrowser for help on using the repository browser.