source: chapter08/e2fsprogs.xml@ ea7ec72

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 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 ea7ec72 was fb386e0, checked in by Thomas Trepl <thomas@…>, 4 years ago

Rename package entities to be independent of chapter numbering

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