source: chapter08/e2fsprogs.xml@ dc5635a

xry111/usr-move
Last change on this file since dc5635a was dc5635a, checked in by Xi Ruoyao <xry111@…>, 21 months ago

usr-move: another batch of configure switches cleanup

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