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

Last change on this file since 124823a was c115ef0, checked in by Joe Ciccone <jciccone@…>, 16 years ago

Update a few of the lists of files that packages install.
  • Property mode set to 100644
File size: 17.5 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> journaling
23 file system.</para>
24
25 </sect2>
26
27 <sect2 role="installation">
28 <title>Installation of E2fsprogs</title>
29
30 <para os="a">The E2fsprogs documentation recommends that the package be
31 built in a subdirectory of the source tree:</para>
32
33<screen os="b"><userinput>mkdir -v build
34cd build</userinput></screen>
35
36 <para os="c">Prepare E2fsprogs for compilation:</para>
37
38<screen os="d"><userinput>../configure --prefix=/usr --with-root-prefix="" \
39 --enable-elf-shlibs --disable-evms \
40 --with-cc=gcc</userinput></screen>
41
42 <variablelist os="e">
43 <title>The meaning of the configure options:</title>
44
45 <varlistentry os="e1">
46 <term><parameter>--with-root-prefix=""</parameter></term>
47 <listitem>
48 <para>Certain programs (such as the <command>e2fsck</command>
49 program) are considered essential programs. When, for example,
50 <filename class="directory">/usr</filename> is not mounted,
51 these programs still need to be available. They belong in
52 directories like <filename class="directory">/lib</filename> and
53 <filename class="directory">/sbin</filename>. If this option is
54 not passed to E2fsprogs' configure, the programs are installed into
55 the <filename class="directory">/usr</filename> directory.</para>
56 </listitem>
57 </varlistentry>
58
59 <varlistentry os="e2">
60 <term><parameter>--enable-elf-shlibs</parameter></term>
61 <listitem>
62 <para>This creates the shared libraries which some programs
63 in this package use.</para>
64 </listitem>
65 </varlistentry>
66
67 <varlistentry os="e3">
68 <term><parameter>--disable-evms</parameter></term>
69 <listitem>
70 <para>This disables the building of the Enterprise Volume
71 Management System (EVMS) plugin. This plugin is not up-to-date with
72 the latest EVMS internal interfaces and EVMS is not installed as part
73 of a base CLFS system, so the plugin is not required. See the EVMS
74 website at <ulink url="http://evms.sourceforge.net/"/> for more
75 information regarding EVMS.</para>
76 </listitem>
77 </varlistentry>
78
79 </variablelist>
80
81 <para os="f">Compile the package:</para>
82
83<screen os="g"><userinput>make</userinput></screen>
84
85 <para os="h">To test the results, issue:
86 <userinput>make check</userinput>.</para>
87
88 <para os="i">Install the binaries, documentation and shared libraries:</para>
89
90<screen os="j"><userinput>make install</userinput></screen>
91
92 <para os="k">Install the static libraries and headers:</para>
93
94<screen os="l"><userinput>make install-libs</userinput></screen>
95
96 </sect2>
97
98 <sect2 id="contents-e2fsprogs" role="content">
99 <title>Contents of E2fsprogs</title>
100
101 <segmentedlist>
102 <segtitle>Installed programs</segtitle>
103 <segtitle>Installed libraries</segtitle>
104
105 <seglistitem>
106 <seg>badblocks, blkid, chattr, compile_et, debugfs, dumpe2fs,
107 e2fsck, e2image, e2label, filefrag, findfs, fsck, fsck.ext2, fsck.ext3,
108 logsave, lsattr, mk_cmds, mke2fs, mkfs.ext2, mkfs.ext3,
109 mklost+found, resize2fs, tune2fs, uuidd, and uuidgen.</seg>
110 <seg>libblkid.[a,so], libcom_err.[a,so], libe2p.[a,so],
111 libext2fs.[a,so], libss.[a,so], and libuuid.[a,so]</seg>
112 </seglistitem>
113 </segmentedlist>
114
115 <variablelist>
116 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
117 <?dbfo list-presentation="list"?>
118 <?dbhtml list-presentation="table"?>
119
120 <varlistentry id="badblocks">
121 <term><command>badblocks</command></term>
122 <listitem>
123 <para>Searches a device (usually a disk partition) for bad
124 blocks</para>
125 <indexterm zone="ch-system-e2fsprogs badblocks">
126 <primary sortas="b-badblocks">badblocks</primary>
127 </indexterm>
128 </listitem>
129 </varlistentry>
130
131 <varlistentry id="blkid">
132 <term><command>blkid</command></term>
133 <listitem>
134 <para>A command line utility to locate and print block device
135 attributes</para>
136 <indexterm zone="ch-system-e2fsprogs blkid">
137 <primary sortas="b-blkid">blkid</primary>
138 </indexterm>
139 </listitem>
140 </varlistentry>
141
142 <varlistentry id="chattr">
143 <term><command>chattr</command></term>
144 <listitem>
145 <para>Changes the attributes of files on an <systemitem
146 class="filesystem">ext2</systemitem> file system; it also
147 changes <systemitem class="filesystem">ext3</systemitem>
148 file systems, the journaling version of <systemitem
149 class="filesystem">ext2</systemitem> file systems</para>
150 <indexterm zone="ch-system-e2fsprogs chattr">
151 <primary sortas="b-chattr">chattr</primary>
152 </indexterm>
153 </listitem>
154 </varlistentry>
155
156 <varlistentry id="compile_et">
157 <term><command>compile_et</command></term>
158 <listitem>
159 <para>An error table compiler; it converts a table of error-code
160 names and messages into a C source file suitable for use with the
161 <filename class="libraryfile">com_err</filename> library</para>
162 <indexterm zone="ch-system-e2fsprogs compile_et">
163 <primary sortas="b-compile_et">compile_et</primary>
164 </indexterm>
165 </listitem>
166 </varlistentry>
167
168 <varlistentry id="debugfs">
169 <term><command>debugfs</command></term>
170 <listitem>
171 <para>A file system debugger; it can be used to examine and change
172 the state of an <systemitem class="filesystem">ext2</systemitem>
173 file system</para>
174 <indexterm zone="ch-system-e2fsprogs debugfs">
175 <primary sortas="b-debugfs">debugfs</primary>
176 </indexterm>
177 </listitem>
178 </varlistentry>
179
180 <varlistentry id="dumpe2fs">
181 <term><command>dumpe2fs</command></term>
182 <listitem>
183 <para>Prints the super block and blocks group information for the
184 file system present on a given device</para>
185 <indexterm zone="ch-system-e2fsprogs dumpe2fs">
186 <primary sortas="b-dumpe2fs">dumpe2fs</primary>
187 </indexterm>
188 </listitem>
189 </varlistentry>
190
191 <varlistentry id="e2fsck">
192 <term><command>e2fsck</command></term>
193 <listitem>
194 <para>Is used to check, and optionally repair <systemitem
195 class="filesystem">ext2</systemitem> file systems and <systemitem
196 class="filesystem">ext3</systemitem> file systems</para>
197 <indexterm zone="ch-system-e2fsprogs e2fsck">
198 <primary sortas="b-e2fsck">e2fsck</primary>
199 </indexterm>
200 </listitem>
201 </varlistentry>
202
203 <varlistentry id="e2image">
204 <term><command>e2image</command></term>
205 <listitem>
206 <para>Is used to save critical <systemitem
207 class="filesystem">ext2</systemitem> file system data to a file</para>
208 <indexterm zone="ch-system-e2fsprogs e2image">
209 <primary sortas="b-e2image">e2image</primary>
210 </indexterm>
211 </listitem>
212 </varlistentry>
213
214 <varlistentry id="e2label">
215 <term><command>e2label</command></term>
216 <listitem>
217 <para>Displays or changes the file system label on the <systemitem
218 class="filesystem">ext2</systemitem> file system present on a given
219 device</para>
220 <indexterm zone="ch-system-e2fsprogs e2label">
221 <primary sortas="b-e2label">e2label</primary>
222 </indexterm>
223 </listitem>
224 </varlistentry>
225
226 <varlistentry id="filefrag">
227 <term><command>filefrag</command></term>
228 <listitem>
229 <para>Reports on how badly fragmented a particular file might be</para>
230 <indexterm zone="ch-system-e2fsprogs filefrag">
231 <primary sortas="b-filefrag">filefrag</primary>
232 </indexterm>
233 </listitem>
234 </varlistentry>
235
236 <varlistentry id="findfs">
237 <term><command>findfs</command></term>
238 <listitem>
239 <para>Finds a file system by label or Universally Unique Identifier
240 (UUID)</para>
241 <indexterm zone="ch-system-e2fsprogs findfs">
242 <primary sortas="b-findfs">findfs</primary>
243 </indexterm>
244 </listitem>
245 </varlistentry>
246
247 <varlistentry id="fsck">
248 <term><command>fsck</command></term>
249 <listitem>
250 <para>Is used to check, and optionally repair, file systems</para>
251 <indexterm zone="ch-system-e2fsprogs fsck">
252 <primary sortas="b-fsck">fsck</primary>
253 </indexterm>
254 </listitem>
255 </varlistentry>
256
257 <varlistentry id="fsck.ext2">
258 <term><command>fsck.ext2</command></term>
259 <listitem>
260 <para>By default checks <systemitem class="filesystem">ext2</systemitem>
261 file systems</para>
262 <indexterm zone="ch-system-e2fsprogs fsck.ext2">
263 <primary sortas="b-fsck.ext2">fsck.ext2</primary>
264 </indexterm>
265 </listitem>
266 </varlistentry>
267
268 <varlistentry id="fsck.ext3">
269 <term><command>fsck.ext3</command></term>
270 <listitem>
271 <para>By default checks <systemitem class="filesystem">ext3</systemitem>
272 file systems</para>
273 <indexterm zone="ch-system-e2fsprogs fsck.ext3">
274 <primary sortas="b-fsck.ext3">fsck.ext3</primary>
275 </indexterm>
276 </listitem>
277 </varlistentry>
278
279 <varlistentry id="logsave">
280 <term><command>logsave</command></term>
281 <listitem>
282 <para>Saves the output of a command in a log file</para>
283 <indexterm zone="ch-system-e2fsprogs logsave">
284 <primary sortas="b-logsave">logsave</primary>
285 </indexterm>
286 </listitem>
287 </varlistentry>
288
289 <varlistentry id="lsattr">
290 <term><command>lsattr</command></term>
291 <listitem>
292 <para>Lists the attributes of files on a second extended file
293 system</para>
294 <indexterm zone="ch-system-e2fsprogs lsattr">
295 <primary sortas="b-lsattr">lsattr</primary>
296 </indexterm>
297 </listitem>
298 </varlistentry>
299
300 <varlistentry id="mk_cmds">
301 <term><command>mk_cmds</command></term>
302 <listitem>
303 <para>Converts a table of command names and help messages into a C
304 source file suitable for use with the <filename
305 class="libraryfile">libss</filename> subsystem library</para>
306 <indexterm zone="ch-system-e2fsprogs mk_cmds">
307 <primary sortas="b-mk_cmds">mk_cmds</primary>
308 </indexterm>
309 </listitem>
310 </varlistentry>
311
312 <varlistentry id="mke2fs">
313 <term><command>mke2fs</command></term>
314 <listitem>
315 <para>Creates an <systemitem class="filesystem">ext2</systemitem>
316 or <systemitem class="filesystem">ext3</systemitem> file system on
317 the given device</para>
318 <indexterm zone="ch-system-e2fsprogs mke2fs">
319 <primary sortas="b-mke2fs">mke2fs</primary>
320 </indexterm>
321 </listitem>
322 </varlistentry>
323
324 <varlistentry id="mkfs.ext2">
325 <term><command>mkfs.ext2</command></term>
326 <listitem>
327 <para>By default creates <systemitem class="filesystem">ext2</systemitem>
328 file systems</para>
329 <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
330 <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
331 </indexterm>
332 </listitem>
333 </varlistentry>
334
335 <varlistentry id="mkfs.ext3">
336 <term><command>mkfs.ext3</command></term>
337 <listitem>
338 <para>By default creates <systemitem class="filesystem">ext3</systemitem>
339 file systems</para>
340 <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
341 <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
342 </indexterm>
343 </listitem>
344 </varlistentry>
345
346 <varlistentry id="mklost-found">
347 <term><command>mklost+found</command></term>
348 <listitem>
349 <para>Used to create a <filename class="directory">lost+found</filename>
350 directory on an <systemitem class="filesystem">ext2</systemitem> file
351 system; it pre-allocates disk blocks to this directory to lighten the
352 task of <command>e2fsck</command></para>
353 <indexterm zone="ch-system-e2fsprogs mklost-found">
354 <primary sortas="b-mklost+found">mklost+found</primary>
355 </indexterm>
356 </listitem>
357 </varlistentry>
358
359 <varlistentry id="resize2fs">
360 <term><command>resize2fs</command></term>
361 <listitem>
362 <para>Can be used to enlarge or shrink an <systemitem
363 class="filesystem">ext2</systemitem> file system</para>
364 <indexterm zone="ch-system-e2fsprogs resize2fs">
365 <primary sortas="b-resize2fs">resize2fs</primary>
366 </indexterm>
367 </listitem>
368 </varlistentry>
369
370 <varlistentry id="tune2fs">
371 <term><command>tune2fs</command></term>
372 <listitem>
373 <para>Adjusts tunable file system parameters on an <systemitem
374 class="filesystem">ext2</systemitem> file system</para>
375 <indexterm zone="ch-system-e2fsprogs tune2fs">
376 <primary sortas="b-tune2fs">tune2fs</primary>
377 </indexterm>
378 </listitem>
379 </varlistentry>
380
381 <varlistentry id="uuidd">
382 <term><command>uuidd</command></term>
383 <listitem>
384 <para>The uuidd daemon is used by the UUID library to generate
385 universally unique identifiers (UUIDs), especially time-based UUID's
386 in a secure and guaranteed-unique fashion, even in the face of large
387 numbers of threads trying to grab UUID's running on different CPU's.
388 </para>
389 <indexterm zone="ch-system-e2fsprogs uuidd">
390 <primary sortas="b-uuidd">uuidd</primary>
391 </indexterm>
392 </listitem>
393 </varlistentry>
394
395 <varlistentry id="uuidgen">
396 <term><command>uuidgen</command></term>
397 <listitem>
398 <para>Creates new UUIDs. Each new UUID can reasonably be considered
399 unique among all UUIDs created, on the local system and on other
400 systems, in the past and in the future</para>
401 <indexterm zone="ch-system-e2fsprogs uuidgen">
402 <primary sortas="b-uuidgen">uuidgen</primary>
403 </indexterm>
404 </listitem>
405 </varlistentry>
406
407 <varlistentry id="libblkid">
408 <term><filename class="libraryfile">libblkid</filename></term>
409 <listitem>
410 <para>Contains routines for device identification and token
411 extraction</para>
412 <indexterm zone="ch-system-e2fsprogs libblkid">
413 <primary sortas="c-libblkid">libblkid</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 <varlistentry id="libuuid">
461 <term><filename class="libraryfile">libuuid</filename></term>
462 <listitem>
463 <para>Contains routines for generating unique identifiers for objects
464 that may be accessible beyond the local system</para>
465 <indexterm zone="ch-system-e2fsprogs libuuid">
466 <primary sortas="c-libuuid">libuuid</primary>
467 </indexterm>
468 </listitem>
469 </varlistentry>
470
471 </variablelist>
472
473 </sect2>
474
475</sect1>
Note: See TracBrowser for help on using the repository browser.