source: BOOK/final-system/common/e2fsprogs.xml@ 8274832

systemd
Last change on this file since 8274832 was 7cd7f99, checked in by Chris Staub <chris@…>, 9 years ago

Put one configure option per line
  • Property mode set to 100644
File size: 18.2 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 <title>E2fsprogs-&e2fsprogs-version;</title>
12
13 <indexterm zone="ch-system-e2fsprogs">
14 <primary sortas="a-E2fsprogs">E2fsprogs</primary>
15 </indexterm>
16
17 <sect2 role="package">
18 <title/>
19
20 <para>The E2fsprogs package contains the utilities for handling the
21 <systemitem class="filesystem">ext2</systemitem> file system. It also
22 supports the <systemitem class="filesystem">ext3</systemitem> and
23 <systemitem class="filesystem">ext4</systemitem> journaling
24 file systems.</para>
25
26 </sect2>
27
28 <sect2 role="installation">
29 <title>Installation of E2fsprogs</title>
30
31 <para os="a">The E2fsprogs documentation recommends that the package be
32 built in a subdirectory of the source tree:</para>
33
34<screen os="b"><userinput>mkdir -v build
35cd build</userinput></screen>
36
37 <para os="c">Prepare E2fsprogs for compilation:</para>
38
39<screen os="d"><userinput>../configure \
40 --prefix=/usr \
41 --bindir=/bin \
42 --with-root-prefix="" \
43 --enable-elf-shlibs \
44 --disable-libblkid \
45 --disable-libuuid \
46 --disable-fsck \
47 --disable-uuidd</userinput></screen>
48
49 <variablelist os="e">
50 <title>The meaning of the configure options:</title>
51
52 <varlistentry os="e1">
53 <term><parameter>--with-root-prefix=""</parameter></term>
54 <listitem>
55 <para>Certain programs (such as the <command>e2fsck</command>
56 program) are considered essential programs. When, for example,
57 <filename class="directory">/usr</filename> is not mounted,
58 these programs still need to be available. They belong in
59 directories like <filename class="directory">/lib</filename> and
60 <filename class="directory">/sbin</filename>. If this option is
61 not passed to E2fsprogs' configure, the programs are installed into
62 the <filename class="directory">/usr</filename> directory.</para>
63 </listitem>
64 </varlistentry>
65
66 <varlistentry os="e2">
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 os="e3">
75 <term><parameter>--disable-*</parameter></term>
76 <listitem>
77 <para>This prevents E2fsprogs from 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, as Util-Linux installed all of
82 them earlier.</para>
83 </listitem>
84 </varlistentry>
85
86 </variablelist>
87
88 <para os="f">Compile the package:</para>
89
90<screen os="g"><userinput>make</userinput></screen>
91
92 <para os="h">To test the results, issue:</para>
93
94<screen os="h2"><userinput remap="test">make check</userinput></screen>
95
96 <para os="i">Install the binaries, documentation and shared libraries:</para>
97
98<screen os="j"><userinput>make install</userinput></screen>
99
100 <para os="k">Install the static libraries and headers:</para>
101
102<screen os="l"><userinput>make install-libs</userinput></screen>
103
104 </sect2>
105
106 <sect2 id="contents-e2fsprogs" role="content">
107 <title>Contents of E2fsprogs</title>
108
109 <segmentedlist>
110 <segtitle>Installed programs</segtitle>
111 <segtitle>Installed libraries</segtitle>
112 <segtitle>Installed directories</segtitle>
113
114 <seglistitem>
115 <seg>badblocks, chattr, compile_et, debugfs, dumpe2fs, e2freefrag,
116 e2fsck, e2image, e2initrd_helper, e2label, e2undo, e4defrag, filefrag,
117 fsck.ext2, fsck.ext3, fsck.ext4, fsck.ext4dev, logsave, lsattr,
118 mk_cmds, mke2fs, mkfs.ext2, mkfs.ext3, mkfs.ext4, mkfs.ext4dev,
119 mklost+found, resize2fs, tune2fs</seg>
120 <seg>libcom_err.[a,so], libe2p.[a,so], libext2fs.[a,so],
121 libss.[a,so], libquota.a</seg>
122 <seg>/usr/include/e2p, /usr/include/et, /usr/include/ext2fs,
123 /usr/include/quota, /usr/include/ss, /usr/share/et, /usr/share/ss</seg>
124 </seglistitem>
125 </segmentedlist>
126
127 <variablelist>
128 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
129 <?dbfo list-presentation="list"?>
130 <?dbhtml list-presentation="table"?>
131
132 <varlistentry id="badblocks">
133 <term><command>badblocks</command></term>
134 <listitem>
135 <para>Searches a device (usually a disk partition) for bad
136 blocks</para>
137 <indexterm zone="ch-system-e2fsprogs badblocks">
138 <primary sortas="b-badblocks">badblocks</primary>
139 </indexterm>
140 </listitem>
141 </varlistentry>
142
143 <varlistentry id="chattr">
144 <term><command>chattr</command></term>
145 <listitem>
146 <para>Changes the attributes on a Linux file system</para>
147 <indexterm zone="ch-system-e2fsprogs chattr">
148 <primary sortas="b-chattr">chattr</primary>
149 </indexterm>
150 </listitem>
151 </varlistentry>
152
153 <varlistentry id="compile_et">
154 <term><command>compile_et</command></term>
155 <listitem>
156 <para>An error table compiler; it converts a table of error-code
157 names and messages into a C source file suitable for use with the
158 <filename class="libraryfile">com_err</filename> library</para>
159 <indexterm zone="ch-system-e2fsprogs compile_et">
160 <primary sortas="b-compile_et">compile_et</primary>
161 </indexterm>
162 </listitem>
163 </varlistentry>
164
165 <varlistentry id="debugfs">
166 <term><command>debugfs</command></term>
167 <listitem>
168 <para>A file system debugger; it can be used to examine and change
169 the state of an <systemitem class="filesystem">ext2</systemitem>
170 file system</para>
171 <indexterm zone="ch-system-e2fsprogs debugfs">
172 <primary sortas="b-debugfs">debugfs</primary>
173 </indexterm>
174 </listitem>
175 </varlistentry>
176
177 <varlistentry id="dumpe2fs">
178 <term><command>dumpe2fs</command></term>
179 <listitem>
180 <para>Prints the super block and blocks group information for the
181 file system present on a given device</para>
182 <indexterm zone="ch-system-e2fsprogs dumpe2fs">
183 <primary sortas="b-dumpe2fs">dumpe2fs</primary>
184 </indexterm>
185 </listitem>
186 </varlistentry>
187
188 <varlistentry id="e2freefrag">
189 <term><command>e2freefrag</command></term>
190 <listitem>
191 <para> Reports free space fragmentation information</para>
192 <indexterm zone="ch-system-e2fsprogs e2freefrag">
193 <primary sortas="b-e2freefrag">e2freefrag</primary>
194 </indexterm>
195 </listitem>
196 </varlistentry>
197
198 <varlistentry id="e2fsck">
199 <term><command>e2fsck</command></term>
200 <listitem>
201 <para>Is used to check, and optionally repair <systemitem
202 class="filesystem">ext2</systemitem>, <systemitem
203 class="filesystem">ext3</systemitem> and <systemitem
204 class="filesystem">ext4</systemitem>file systems</para>
205 <indexterm zone="ch-system-e2fsprogs e2fsck">
206 <primary sortas="b-e2fsck">e2fsck</primary>
207 </indexterm>
208 </listitem>
209 </varlistentry>
210
211 <varlistentry id="e2image">
212 <term><command>e2image</command></term>
213 <listitem>
214 <para>Is used to save critical <systemitem
215 class="filesystem">ext2</systemitem> file system data to a file</para>
216 <indexterm zone="ch-system-e2fsprogs e2image">
217 <primary sortas="b-e2image">e2image</primary>
218 </indexterm>
219 </listitem>
220 </varlistentry>
221
222 <varlistentry id="e2initrd_helper">
223 <term><command>e2initrd_helper</command></term>
224 <listitem>
225 <para>Prints the FS type of a given filesystem, given either a
226 device name or label</para>
227 <indexterm zone="ch-system-e2fsprogs e2initrd_helper">
228 <primary sortas="b-e2initrd_helper">e2initrd_helper</primary>
229 </indexterm>
230 </listitem>
231 </varlistentry>
232
233 <varlistentry id="e2label">
234 <term><command>e2label</command></term>
235 <listitem>
236 <para>Displays or changes the file system label on the <systemitem
237 class="filesystem">ext2</systemitem> file system present on a given
238 device</para>
239 <indexterm zone="ch-system-e2fsprogs e2label">
240 <primary sortas="b-e2label">e2label</primary>
241 </indexterm>
242 </listitem>
243 </varlistentry>
244
245 <varlistentry id="e2undo">
246 <term><command>e2undo</command></term>
247 <listitem>
248 <para>Replays an undo log for an ext2/ext3/ext4 filesystem</para>
249 <indexterm zone="ch-system-e2fsprogs e2undo">
250 <primary sortas="b-e2undo">e2undo</primary>
251 </indexterm>
252 </listitem>
253 </varlistentry>
254
255 <varlistentry id="e4defrag">
256 <term><command>e4defrag</command></term>
257 <listitem>
258 <para>Online defragmenter for ext4 filesystems</para>
259 <indexterm zone="ch-system-e2fsprogs e4defrag">
260 <primary sortas="b-e4defrag">e4defrag</primary>
261 </indexterm>
262 </listitem>
263 </varlistentry>
264
265 <varlistentry id="filefrag">
266 <term><command>filefrag</command></term>
267 <listitem>
268 <para>Reports on how badly fragmented a particular file might be</para>
269 <indexterm zone="ch-system-e2fsprogs filefrag">
270 <primary sortas="b-filefrag">filefrag</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>
274
275 <varlistentry id="fsck.ext2">
276 <term><command>fsck.ext2</command></term>
277 <listitem>
278 <para>By default checks <systemitem class="filesystem">ext2</systemitem>
279 file systems</para>
280 <indexterm zone="ch-system-e2fsprogs fsck.ext2">
281 <primary sortas="b-fsck.ext2">fsck.ext2</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 <varlistentry id="fsck.ext3">
287 <term><command>fsck.ext3</command></term>
288 <listitem>
289 <para>By default checks <systemitem class="filesystem">ext3</systemitem>
290 file systems</para>
291 <indexterm zone="ch-system-e2fsprogs fsck.ext3">
292 <primary sortas="b-fsck.ext3">fsck.ext3</primary>
293 </indexterm>
294 </listitem>
295 </varlistentry>
296
297 <varlistentry id="fsck.ext4">
298 <term><command>fsck.ext4</command></term>
299 <listitem>
300 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
301 file systems</para>
302 <indexterm zone="ch-system-e2fsprogs fsck.ext4">
303 <primary sortas="b-fsck.ext4">fsck.ext4</primary>
304 </indexterm>
305 </listitem>
306 </varlistentry>
307
308 <varlistentry id="fsck.ext4dev">
309 <term><command>fsck.ext4dev</command></term>
310 <listitem>
311 <para>By default checks <systemitem class="filesystem">ext4dev</systemitem>
312 file systems</para>
313 <indexterm zone="ch-system-e2fsprogs fsck.ext4dev">
314 <primary sortas="b-fsck.ext4dev">fsck.ext4dev</primary>
315 </indexterm>
316 </listitem>
317 </varlistentry>
318
319 <varlistentry id="logsave">
320 <term><command>logsave</command></term>
321 <listitem>
322 <para>Saves the output of a command in a log file</para>
323 <indexterm zone="ch-system-e2fsprogs logsave">
324 <primary sortas="b-logsave">logsave</primary>
325 </indexterm>
326 </listitem>
327 </varlistentry>
328
329 <varlistentry id="lsattr">
330 <term><command>lsattr</command></term>
331 <listitem>
332 <para>Lists the attributes of files on a second extended file
333 system</para>
334 <indexterm zone="ch-system-e2fsprogs lsattr">
335 <primary sortas="b-lsattr">lsattr</primary>
336 </indexterm>
337 </listitem>
338 </varlistentry>
339
340 <varlistentry id="mk_cmds">
341 <term><command>mk_cmds</command></term>
342 <listitem>
343 <para>Converts a table of command names and help messages into a C
344 source file suitable for use with the <filename
345 class="libraryfile">libss</filename> subsystem library</para>
346 <indexterm zone="ch-system-e2fsprogs mk_cmds">
347 <primary sortas="b-mk_cmds">mk_cmds</primary>
348 </indexterm>
349 </listitem>
350 </varlistentry>
351
352 <varlistentry id="mke2fs">
353 <term><command>mke2fs</command></term>
354 <listitem>
355 <para>Creates an <systemitem class="filesystem">ext2</systemitem>,
356 <systemitem class="filesystem">ext3</systemitem> or <systemitem
357 class="filesystem">ext4</systemitem> file system on the given device</para>
358 <indexterm zone="ch-system-e2fsprogs mke2fs">
359 <primary sortas="b-mke2fs">mke2fs</primary>
360 </indexterm>
361 </listitem>
362 </varlistentry>
363
364 <varlistentry id="mkfs.ext2">
365 <term><command>mkfs.ext2</command></term>
366 <listitem>
367 <para>By default creates <systemitem class="filesystem">ext2</systemitem>
368 file systems</para>
369 <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
370 <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
371 </indexterm>
372 </listitem>
373 </varlistentry>
374
375 <varlistentry id="mkfs.ext3">
376 <term><command>mkfs.ext3</command></term>
377 <listitem>
378 <para>By default creates <systemitem class="filesystem">ext3</systemitem>
379 file systems</para>
380 <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
381 <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
382 </indexterm>
383 </listitem>
384 </varlistentry>
385
386 <varlistentry id="mkfs.ext4">
387 <term><command>mkfs.ext4</command></term>
388 <listitem>
389 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
390 file systems</para>
391 <indexterm zone="ch-system-e2fsprogs mkfs.ext4">
392 <primary sortas="b-mkfs.ext4">mkfs.ext4</primary>
393 </indexterm>
394 </listitem>
395 </varlistentry>
396
397 <varlistentry id="mkfs.ext4dev">
398 <term><command>mkfs.ext4dev</command></term>
399 <listitem>
400 <para>By default creates <systemitem class="filesystem">ext4dev</systemitem>
401 file systems</para>
402 <indexterm zone="ch-system-e2fsprogs mkfs.ext4dev">
403 <primary sortas="b-mkfs.ext4dev">mkfs.ext4dev</primary>
404 </indexterm>
405 </listitem>
406 </varlistentry>
407
408 <varlistentry id="mklost-found">
409 <term><command>mklost+found</command></term>
410 <listitem>
411 <para>Used to create a <filename class="directory">lost+found</filename>
412 directory on an <systemitem class="filesystem">ext2</systemitem> file
413 system; it pre-allocates disk blocks to this directory to lighten the
414 task of <command>e2fsck</command></para>
415 <indexterm zone="ch-system-e2fsprogs mklost-found">
416 <primary sortas="b-mklost+found">mklost+found</primary>
417 </indexterm>
418 </listitem>
419 </varlistentry>
420
421 <varlistentry id="resize2fs">
422 <term><command>resize2fs</command></term>
423 <listitem>
424 <para>Can be used to enlarge or shrink an <systemitem
425 class="filesystem">ext2</systemitem> file system</para>
426 <indexterm zone="ch-system-e2fsprogs resize2fs">
427 <primary sortas="b-resize2fs">resize2fs</primary>
428 </indexterm>
429 </listitem>
430 </varlistentry>
431
432 <varlistentry id="tune2fs">
433 <term><command>tune2fs</command></term>
434 <listitem>
435 <para>Adjusts tunable file system parameters on an <systemitem
436 class="filesystem">ext2</systemitem> file system</para>
437 <indexterm zone="ch-system-e2fsprogs tune2fs">
438 <primary sortas="b-tune2fs">tune2fs</primary>
439 </indexterm>
440 </listitem>
441 </varlistentry>
442
443 <varlistentry id="libcom_err">
444 <term><filename class="libraryfile">libcom_err</filename></term>
445 <listitem>
446 <para>The common error display routine</para>
447 <indexterm zone="ch-system-e2fsprogs libcom_err">
448 <primary sortas="c-libcom_err">libcom_err</primary>
449 </indexterm>
450 </listitem>
451 </varlistentry>
452
453 <varlistentry id="libe2p">
454 <term><filename class="libraryfile">libe2p</filename></term>
455 <listitem>
456 <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
457 and <command>lsattr</command></para>
458 <indexterm zone="ch-system-e2fsprogs libe2p">
459 <primary sortas="c-libe2p">libe2p</primary>
460 </indexterm>
461 </listitem>
462 </varlistentry>
463
464 <varlistentry id="libext2fs">
465 <term><filename class="libraryfile">libext2fs</filename></term>
466 <listitem>
467 <para>Contains routines to enable user-level programs to manipulate an
468 <systemitem class="filesystem">ext2</systemitem> file system</para>
469 <indexterm zone="ch-system-e2fsprogs libext2fs">
470 <primary sortas="c-libext2fs">libext2fs</primary>
471 </indexterm>
472 </listitem>
473 </varlistentry>
474
475 <varlistentry id="libquota">
476 <term><filename class="libraryfile">libquota</filename></term>
477 <listitem>
478 <para>Provides an interface for creating and updating quota files
479 and ext4 superblock fields</para>
480 <indexterm zone="ch-system-e2fsprogs libquota">
481 <primary sortas="c-libquota">libquota</primary>
482 </indexterm>
483 </listitem>
484 </varlistentry>
485
486 <varlistentry id="libss">
487 <term><filename class="libraryfile">libss</filename></term>
488 <listitem>
489 <para>Used by <command>debugfs</command></para>
490 <indexterm zone="ch-system-e2fsprogs libss">
491 <primary sortas="c-libss">libss</primary>
492 </indexterm>
493 </listitem>
494 </varlistentry>
495
496 </variablelist>
497
498 </sect2>
499
500</sect1>
Note: See TracBrowser for help on using the repository browser.