source: final-system/common/e2fsprogs.xml@ b462061

Last change on this file since b462061 was b71fa50, checked in by Chris Staub <chris@…>, 18 years ago

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