source: chapter06/e2fsprogs.xml@ ac62f17

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.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 ac62f17 was ac62f17, checked in by Matthew Burgess <matthew@…>, 12 years ago

Upgrade to Binutils-2.22. Fixes #2967.

git-svn-id: ​http://svn.linuxfromscratch.org/LFS/trunk/BOOK@9671 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689
  • Property mode set to 100644
File size: 20.2 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 LDFLAGS="-lblkid -luuid" \
56 ../configure --prefix=/usr --with-root-prefix="" \
57 --enable-elf-shlibs --disable-libblkid --disable-libuuid \
58 --disable-uuidd --disable-fsck</userinput></screen>
59
60 <variablelist>
61 <title>The meaning of the configure options:</title>
62
63 <varlistentry>
64 <term><parameter>PKG_CONFIG...</parameter></term>
65 <listitem>
66 <para>This enables E2fsprogs to be built without requiring Pkg-config
67 to be built and installed first.</para>
68 </listitem>
69 </varlistentry>
70
71 <varlistentry>
72 <term><parameter>--with-root-prefix=""</parameter></term>
73 <listitem>
74 <para>Certain programs (such as the <command>e2fsck</command>
75 program) are considered essential programs. When, for example,
76 <filename class="directory">/usr</filename> is not mounted, these
77 programs still need to be available. They belong in directories
78 like <filename class="directory">/lib</filename> and <filename
79 class="directory">/sbin</filename>. If this option is not passed
80 to E2fsprogs' configure, the programs are installed into the
81 <filename class="directory">/usr</filename> directory.</para>
82 </listitem>
83 </varlistentry>
84
85 <varlistentry>
86 <term><parameter>--enable-elf-shlibs</parameter></term>
87 <listitem>
88 <para>This creates the shared libraries which some programs
89 in this package use.</para>
90 </listitem>
91 </varlistentry>
92
93 <varlistentry>
94 <term><parameter>--disable-*</parameter></term>
95 <listitem>
96 <para>This prevents E2fsprogs from building and installing the
97 <systemitem class="library">libuuid</systemitem> and
98 <systemitem class="library">libblkid</systemitem> libraries, the
99 <systemitem class="daemon">uuidd</systemitem> daemon, and the
100 <command>fsck</command> wrapper, as Util-Linux installed all of
101 them earlier.</para>
102 </listitem>
103 </varlistentry>
104
105 </variablelist>
106
107 <para>Compile the package:</para>
108
109<screen><userinput remap="make">make</userinput></screen>
110
111 <para>To test the results, issue:</para>
112
113<screen><userinput remap="test">make check</userinput></screen>
114
115 <para>One of the E2fsprogs tests will attempt to allocate 256 MB
116 of memory. If you do not have significantly more RAM than this, it
117 is recommended to enable sufficient swap space for the test. See
118 <xref linkend="space-creatingfilesystem"/> and
119 <xref linkend="space-mounting"/> for details on creating and enabling
120 swap space.</para>
121
122 <para>Install the binaries, documentation, and shared libraries:</para>
123
124<screen><userinput remap="install">make install</userinput></screen>
125
126 <para>Install the static libraries and headers:</para>
127
128<screen><userinput remap="install">make install-libs</userinput></screen>
129
130 <para>Make the installed static libraries writable so debugging symbols can
131 be removed later:</para>
132
133<screen><userinput remap="install">chmod -v u+w /usr/lib/{libcom_err,libe2p,libext2fs,libss}.a</userinput></screen>
134
135 <para>This package installs a gzipped
136 <filename class="extension">.info</filename> file but doesn't update the
137 system-wide <filename>dir</filename> file. Unzip this file and then update
138 the system <filename>dir</filename> file using the following
139 commands.</para>
140
141<screen><userinput remap="install">gunzip -v /usr/share/info/libext2fs.info.gz
142install-info --dir-file=/usr/share/info/dir \
143 /usr/share/info/libext2fs.info</userinput></screen>
144
145 <para>If desired, create and install some additional documentation by
146 issuing the following commands:</para>
147
148<screen><userinput remap="install">makeinfo -o doc/com_err.info ../lib/et/com_err.texinfo
149install -v -m644 doc/com_err.info /usr/share/info
150install-info --dir-file=/usr/share/info/dir \
151 /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, 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} and
169 libss.{a,so}</seg>
170 <seg>/usr/include/e2p, /usr/include/et, /usr/include/ext2fs,
171 /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="filefrag">
309 <term><command>filefrag</command></term>
310 <listitem>
311 <para>Reports on how badly fragmented a particular file might be</para>
312 <indexterm zone="ch-system-e2fsprogs filefrag">
313 <primary sortas="b-filefrag">filefrag</primary>
314 </indexterm>
315 </listitem>
316 </varlistentry>
317
318 <varlistentry id="fsck.ext2">
319 <term><command>fsck.ext2</command></term>
320 <listitem>
321 <para>By default checks <systemitem class="filesystem">ext2</systemitem>
322 file systems. This is a hard link to <command>e2fsck</command>.</para>
323 <indexterm zone="ch-system-e2fsprogs fsck.ext2">
324 <primary sortas="b-fsck.ext2">fsck.ext2</primary>
325 </indexterm>
326 </listitem>
327 </varlistentry>
328
329 <varlistentry id="fsck.ext3">
330 <term><command>fsck.ext3</command></term>
331 <listitem>
332 <para>By default checks <systemitem class="filesystem">ext3</systemitem>
333 file systems. This is a hard link to <command>e2fsck</command>.</para>
334 <indexterm zone="ch-system-e2fsprogs fsck.ext3">
335 <primary sortas="b-fsck.ext3">fsck.ext3</primary>
336 </indexterm>
337 </listitem>
338 </varlistentry>
339
340 <varlistentry id="fsck.ext4">
341 <term><command>fsck.ext4</command></term>
342 <listitem>
343 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
344 file systems. This is a hard link to <command>e2fsck</command>.</para>
345 <indexterm zone="ch-system-e2fsprogs fsck.ext4">
346 <primary sortas="b-fsck.ext4">fsck.ext4</primary>
347 </indexterm>
348 </listitem>
349 </varlistentry>
350
351 <varlistentry id="fsck.ext4dev">
352 <term><command>fsck.ext4dev</command></term>
353 <listitem>
354 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
355 development file systems. This is a hard link to
356 <command>e2fsck</command>.</para>
357 <indexterm zone="ch-system-e2fsprogs fsck.ext4dev">
358 <primary sortas="b-fsck.ext4dev">fsck.ext4dev</primary>
359 </indexterm>
360 </listitem>
361 </varlistentry>
362
363 <varlistentry id="logsave">
364 <term><command>logsave</command></term>
365 <listitem>
366 <para>Saves the output of a command in a log file</para>
367 <indexterm zone="ch-system-e2fsprogs logsave">
368 <primary sortas="b-logsave">logsave</primary>
369 </indexterm>
370 </listitem>
371 </varlistentry>
372
373 <varlistentry id="lsattr">
374 <term><command>lsattr</command></term>
375 <listitem>
376 <para>Lists the attributes of files on a second extended file
377 system</para>
378 <indexterm zone="ch-system-e2fsprogs lsattr">
379 <primary sortas="b-lsattr">lsattr</primary>
380 </indexterm>
381 </listitem>
382 </varlistentry>
383
384 <varlistentry id="mk_cmds">
385 <term><command>mk_cmds</command></term>
386 <listitem>
387 <para>Converts a table of command names and help messages into a C
388 source file suitable for use with the <filename
389 class="libraryfile">libss</filename> subsystem library</para>
390 <indexterm zone="ch-system-e2fsprogs mk_cmds">
391 <primary sortas="b-mk_cmds">mk_cmds</primary>
392 </indexterm>
393 </listitem>
394 </varlistentry>
395
396 <varlistentry id="mke2fs">
397 <term><command>mke2fs</command></term>
398 <listitem>
399 <para>Creates an <systemitem class="filesystem">ext2</systemitem>
400 or <systemitem class="filesystem">ext3</systemitem> file system on
401 the given device</para>
402 <indexterm zone="ch-system-e2fsprogs mke2fs">
403 <primary sortas="b-mke2fs">mke2fs</primary>
404 </indexterm>
405 </listitem>
406 </varlistentry>
407
408 <varlistentry id="mkfs.ext2">
409 <term><command>mkfs.ext2</command></term>
410 <listitem>
411 <para>By default creates <systemitem class="filesystem">ext2</systemitem>
412 file systems. This is a hard link to <command>mke2fs</command>.</para>
413 <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
414 <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
415 </indexterm>
416 </listitem>
417 </varlistentry>
418
419 <varlistentry id="mkfs.ext3">
420 <term><command>mkfs.ext3</command></term>
421 <listitem>
422 <para>By default creates <systemitem class="filesystem">ext3</systemitem>
423 file systems. This is a hard link to <command>mke2fs</command>.</para>
424 <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
425 <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
426 </indexterm>
427 </listitem>
428 </varlistentry>
429
430 <varlistentry id="mkfs.ext4">
431 <term><command>mkfs.ext4</command></term>
432 <listitem>
433 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
434 file systems. This is a hard link to <command>mke2fs</command>.</para>
435 <indexterm zone="ch-system-e2fsprogs mkfs.ext4">
436 <primary sortas="b-mkfs.ext4">mkfs.ext4</primary>
437 </indexterm>
438 </listitem>
439 </varlistentry>
440
441 <varlistentry id="mkfs.ext4dev">
442 <term><command>mkfs.ext4dev</command></term>
443 <listitem>
444 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
445 development file systems. This is a hard link to <command>mke2fs</command>.</para>
446 <indexterm zone="ch-system-e2fsprogs mkfs.ext4dev">
447 <primary sortas="b-mkfs.ext4dev">mkfs.ext4dev</primary>
448 </indexterm>
449 </listitem>
450 </varlistentry>
451
452 <varlistentry id="mklost-found">
453 <term><command>mklost+found</command></term>
454 <listitem>
455 <para>Used to create a <filename class="directory">lost+found</filename>
456 directory on an <systemitem class="filesystem">ext2</systemitem> file
457 system; it pre-allocates disk blocks to this directory to lighten the
458 task of <command>e2fsck</command></para>
459 <indexterm zone="ch-system-e2fsprogs mklost-found">
460 <primary sortas="b-mklost+found">mklost+found</primary>
461 </indexterm>
462 </listitem>
463 </varlistentry>
464
465 <varlistentry id="resize2fs">
466 <term><command>resize2fs</command></term>
467 <listitem>
468 <para>Can be used to enlarge or shrink an <systemitem
469 class="filesystem">ext2</systemitem> file system</para>
470 <indexterm zone="ch-system-e2fsprogs resize2fs">
471 <primary sortas="b-resize2fs">resize2fs</primary>
472 </indexterm>
473 </listitem>
474 </varlistentry>
475
476 <varlistentry id="tune2fs">
477 <term><command>tune2fs</command></term>
478 <listitem>
479 <para>Adjusts tunable file system parameters on an <systemitem
480 class="filesystem">ext2</systemitem> file system</para>
481 <indexterm zone="ch-system-e2fsprogs tune2fs">
482 <primary sortas="b-tune2fs">tune2fs</primary>
483 </indexterm>
484 </listitem>
485 </varlistentry>
486
487 <varlistentry id="libcom_err">
488 <term><filename class="libraryfile">libcom_err</filename></term>
489 <listitem>
490 <para>The common error display routine</para>
491 <indexterm zone="ch-system-e2fsprogs libcom_err">
492 <primary sortas="c-libcom_err">libcom_err</primary>
493 </indexterm>
494 </listitem>
495 </varlistentry>
496
497 <varlistentry id="libe2p">
498 <term><filename class="libraryfile">libe2p</filename></term>
499 <listitem>
500 <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
501 and <command>lsattr</command></para>
502 <indexterm zone="ch-system-e2fsprogs libe2p">
503 <primary sortas="c-libe2p">libe2p</primary>
504 </indexterm>
505 </listitem>
506 </varlistentry>
507
508 <varlistentry id="libext2fs">
509 <term><filename class="libraryfile">libext2fs</filename></term>
510 <listitem>
511 <para>Contains routines to enable user-level programs to manipulate an
512 <systemitem class="filesystem">ext2</systemitem> file system</para>
513 <indexterm zone="ch-system-e2fsprogs libext2fs">
514 <primary sortas="c-libext2fs">libext2fs</primary>
515 </indexterm>
516 </listitem>
517 </varlistentry>
518
519 <varlistentry id="libss">
520 <term><filename class="libraryfile">libss</filename></term>
521 <listitem>
522 <para>Used by <command>debugfs</command></para>
523 <indexterm zone="ch-system-e2fsprogs libss">
524 <primary sortas="c-libss">libss</primary>
525 </indexterm>
526 </listitem>
527 </varlistentry>
528
529 </variablelist>
530
531 </sect2>
532
533</sect1>
Note: See TracBrowser for help on using the repository browser.