source: chapter08/e2fsprogs.xml@ a2434bd4

multilib
Last change on this file since a2434bd4 was 8cde104, checked in by David Bryant <davidbryant@…>, 17 months ago

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