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

Last change on this file since 5508d22 was 27931b9, checked in by Joe Ciccone <jciccone@…>, 14 years ago

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