source: chapter06/e2fsprogs.xml@ 2a4c0cc

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 2a4c0cc was 2a4c0cc, checked in by Matthew Burgess <matthew@…>, 15 years ago

Fix a PDF rendering overflow issue

git-svn-id: ​http://svn.linuxfromscratch.org/LFS/trunk/BOOK@9031 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689
  • Property mode set to 100644
File size: 19.5 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>Make sure the version date is in a format compatible with
48 <command>configure</command>:</para>
49
50<screen><userinput remap="pre">sed -i -e "s/July/Jul/" version.h</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, e2fsck,
159 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="e2fsck">
234 <term><command>e2fsck</command></term>
235 <listitem>
236 <para>Is used to check, and optionally repair <systemitem
237 class="filesystem">ext2</systemitem> file systems and <systemitem
238 class="filesystem">ext3</systemitem> file systems</para>
239 <indexterm zone="ch-system-e2fsprogs e2fsck">
240 <primary sortas="b-e2fsck">e2fsck</primary>
241 </indexterm>
242 </listitem>
243 </varlistentry>
244
245 <varlistentry id="e2image">
246 <term><command>e2image</command></term>
247 <listitem>
248 <para>Is used to save critical <systemitem
249 class="filesystem">ext2</systemitem> file system data to a file</para>
250 <indexterm zone="ch-system-e2fsprogs e2image">
251 <primary sortas="b-e2image">e2image</primary>
252 </indexterm>
253 </listitem>
254 </varlistentry>
255
256 <varlistentry id="e2initrd_helper">
257 <term><command>e2initrd_helper</command></term>
258 <listitem>
259 <para>Prints the FS type of a given filesystem, given either a
260 device name or label</para>
261 <indexterm zone="ch-system-e2fsprogs e2initrd_helper">
262 <primary sortas="b-e2initrd_helper">e2initrd_helper</primary>
263 </indexterm>
264 </listitem>
265 </varlistentry>
266
267 <varlistentry id="e2label">
268 <term><command>e2label</command></term>
269 <listitem>
270 <para>Displays or changes the file system label on the <systemitem
271 class="filesystem">ext2</systemitem> file system present on a given
272 device</para>
273 <indexterm zone="ch-system-e2fsprogs e2label">
274 <primary sortas="b-e2label">e2label</primary>
275 </indexterm>
276 </listitem>
277 </varlistentry>
278
279 <varlistentry id="e2undo">
280 <term><command>e2undo</command></term>
281 <listitem>
282 <para>Replays the undo log undo_log for an ext2/ext3/ext4 filesystem
283 found on a device. This can be used to undo a failed operation by an
284 e2fsprogs program.</para>
285 <indexterm zone="ch-system-e2fsprogs e2undo">
286 <primary sortas="b-e2undo">e2undo</primary>
287 </indexterm>
288 </listitem>
289 </varlistentry>
290
291 <varlistentry id="filefrag">
292 <term><command>filefrag</command></term>
293 <listitem>
294 <para>Reports on how badly fragmented a particular file might be</para>
295 <indexterm zone="ch-system-e2fsprogs filefrag">
296 <primary sortas="b-filefrag">filefrag</primary>
297 </indexterm>
298 </listitem>
299 </varlistentry>
300
301 <varlistentry id="fsck.ext2">
302 <term><command>fsck.ext2</command></term>
303 <listitem>
304 <para>By default checks <systemitem class="filesystem">ext2</systemitem>
305 file systems. This is a hard link to <command>fsck</command>.</para>
306 <indexterm zone="ch-system-e2fsprogs fsck.ext2">
307 <primary sortas="b-fsck.ext2">fsck.ext2</primary>
308 </indexterm>
309 </listitem>
310 </varlistentry>
311
312 <varlistentry id="fsck.ext3">
313 <term><command>fsck.ext3</command></term>
314 <listitem>
315 <para>By default checks <systemitem class="filesystem">ext3</systemitem>
316 file systems. This is a hard link to <command>fsck</command>.</para>
317 <indexterm zone="ch-system-e2fsprogs fsck.ext3">
318 <primary sortas="b-fsck.ext3">fsck.ext3</primary>
319 </indexterm>
320 </listitem>
321 </varlistentry>
322
323 <varlistentry id="fsck.ext4">
324 <term><command>fsck.ext4</command></term>
325 <listitem>
326 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
327 file systems. This is a hard link to <command>fsck</command>.</para>
328 <indexterm zone="ch-system-e2fsprogs fsck.ext4">
329 <primary sortas="b-fsck.ext4">fsck.ext4</primary>
330 </indexterm>
331 </listitem>
332 </varlistentry>
333
334 <varlistentry id="fsck.ext4dev">
335 <term><command>fsck.ext4dev</command></term>
336 <listitem>
337 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
338 development file systems. This is a hard link to
339 <command>fsck</command>.</para>
340 <indexterm zone="ch-system-e2fsprogs fsck.ext4dev">
341 <primary sortas="b-fsck.ext4dev">fsck.ext4dev</primary>
342 </indexterm>
343 </listitem>
344 </varlistentry>
345
346 <varlistentry id="logsave">
347 <term><command>logsave</command></term>
348 <listitem>
349 <para>Saves the output of a command in a log file</para>
350 <indexterm zone="ch-system-e2fsprogs logsave">
351 <primary sortas="b-logsave">logsave</primary>
352 </indexterm>
353 </listitem>
354 </varlistentry>
355
356 <varlistentry id="lsattr">
357 <term><command>lsattr</command></term>
358 <listitem>
359 <para>Lists the attributes of files on a second extended file
360 system</para>
361 <indexterm zone="ch-system-e2fsprogs lsattr">
362 <primary sortas="b-lsattr">lsattr</primary>
363 </indexterm>
364 </listitem>
365 </varlistentry>
366
367 <varlistentry id="mk_cmds">
368 <term><command>mk_cmds</command></term>
369 <listitem>
370 <para>Converts a table of command names and help messages into a C
371 source file suitable for use with the <filename
372 class="libraryfile">libss</filename> subsystem library</para>
373 <indexterm zone="ch-system-e2fsprogs mk_cmds">
374 <primary sortas="b-mk_cmds">mk_cmds</primary>
375 </indexterm>
376 </listitem>
377 </varlistentry>
378
379 <varlistentry id="mke2fs">
380 <term><command>mke2fs</command></term>
381 <listitem>
382 <para>Creates an <systemitem class="filesystem">ext2</systemitem>
383 or <systemitem class="filesystem">ext3</systemitem> file system on
384 the given device</para>
385 <indexterm zone="ch-system-e2fsprogs mke2fs">
386 <primary sortas="b-mke2fs">mke2fs</primary>
387 </indexterm>
388 </listitem>
389 </varlistentry>
390
391 <varlistentry id="mkfs.ext2">
392 <term><command>mkfs.ext2</command></term>
393 <listitem>
394 <para>By default creates <systemitem class="filesystem">ext2</systemitem>
395 file systems. This is a hard link to <command>mke2fs</command>.</para>
396 <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
397 <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
398 </indexterm>
399 </listitem>
400 </varlistentry>
401
402 <varlistentry id="mkfs.ext3">
403 <term><command>mkfs.ext3</command></term>
404 <listitem>
405 <para>By default creates <systemitem class="filesystem">ext3</systemitem>
406 file systems. This is a hard link to <command>mke2fs</command>.</para>
407 <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
408 <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
409 </indexterm>
410 </listitem>
411 </varlistentry>
412
413 <varlistentry id="mkfs.ext4">
414 <term><command>mkfs.ext4</command></term>
415 <listitem>
416 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
417 file systems. This is a hard link to <command>mke2fs</command>.</para>
418 <indexterm zone="ch-system-e2fsprogs mkfs.ext4">
419 <primary sortas="b-mkfs.ext4">mkfs.ext4</primary>
420 </indexterm>
421 </listitem>
422 </varlistentry>
423
424 <varlistentry id="mkfs.ext4dev">
425 <term><command>mkfs.ext4dev</command></term>
426 <listitem>
427 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
428 development file systems. This is a hard link to <command>mke2fs</command>.</para>
429 <indexterm zone="ch-system-e2fsprogs mkfs.ext4dev">
430 <primary sortas="b-mkfs.ext4dev">mkfs.ext4dev</primary>
431 </indexterm>
432 </listitem>
433 </varlistentry>
434
435 <varlistentry id="mklost-found">
436 <term><command>mklost+found</command></term>
437 <listitem>
438 <para>Used to create a <filename class="directory">lost+found</filename>
439 directory on an <systemitem class="filesystem">ext2</systemitem> file
440 system; it pre-allocates disk blocks to this directory to lighten the
441 task of <command>e2fsck</command></para>
442 <indexterm zone="ch-system-e2fsprogs mklost-found">
443 <primary sortas="b-mklost+found">mklost+found</primary>
444 </indexterm>
445 </listitem>
446 </varlistentry>
447
448 <varlistentry id="resize2fs">
449 <term><command>resize2fs</command></term>
450 <listitem>
451 <para>Can be used to enlarge or shrink an <systemitem
452 class="filesystem">ext2</systemitem> file system</para>
453 <indexterm zone="ch-system-e2fsprogs resize2fs">
454 <primary sortas="b-resize2fs">resize2fs</primary>
455 </indexterm>
456 </listitem>
457 </varlistentry>
458
459 <varlistentry id="tune2fs">
460 <term><command>tune2fs</command></term>
461 <listitem>
462 <para>Adjusts tunable file system parameters on an <systemitem
463 class="filesystem">ext2</systemitem> file system</para>
464 <indexterm zone="ch-system-e2fsprogs tune2fs">
465 <primary sortas="b-tune2fs">tune2fs</primary>
466 </indexterm>
467 </listitem>
468 </varlistentry>
469
470 <varlistentry id="libcom_err">
471 <term><filename class="libraryfile">libcom_err</filename></term>
472 <listitem>
473 <para>The common error display routine</para>
474 <indexterm zone="ch-system-e2fsprogs libcom_err">
475 <primary sortas="c-libcom_err">libcom_err</primary>
476 </indexterm>
477 </listitem>
478 </varlistentry>
479
480 <varlistentry id="libe2p">
481 <term><filename class="libraryfile">libe2p</filename></term>
482 <listitem>
483 <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
484 and <command>lsattr</command></para>
485 <indexterm zone="ch-system-e2fsprogs libe2p">
486 <primary sortas="c-libe2p">libe2p</primary>
487 </indexterm>
488 </listitem>
489 </varlistentry>
490
491 <varlistentry id="libext2fs">
492 <term><filename class="libraryfile">libext2fs</filename></term>
493 <listitem>
494 <para>Contains routines to enable user-level programs to manipulate an
495 <systemitem class="filesystem">ext2</systemitem> file system</para>
496 <indexterm zone="ch-system-e2fsprogs libext2fs">
497 <primary sortas="c-libext2fs">libext2fs</primary>
498 </indexterm>
499 </listitem>
500 </varlistentry>
501
502 <varlistentry id="libss">
503 <term><filename class="libraryfile">libss</filename></term>
504 <listitem>
505 <para>Used by <command>debugfs</command></para>
506 <indexterm zone="ch-system-e2fsprogs libss">
507 <primary sortas="c-libss">libss</primary>
508 </indexterm>
509 </listitem>
510 </varlistentry>
511
512 </variablelist>
513
514 </sect2>
515
516</sect1>
Note: See TracBrowser for help on using the repository browser.