source: chapter06/e2fsprogs.xml@ f6dd9ab

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 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 f6dd9ab was daef459, checked in by Bruce Dubbs <bdubbs@…>, 8 years ago

Update to e2fsprogs-1.43.3

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