source: clfs-embedded/BOOK/final-system/common/e2fsprogs.xml@ 8c3de96

Last change on this file since 8c3de96 was bd48e48, checked in by Manuel Canales Esparcia <manuel@…>, 18 years ago

Updated CLFS-Embedded book sources to use DocBook-XML DTD 4.5.
  • Property mode set to 100644
File size: 16.9 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>CC="${CC} ${BUILD} -Os" ../configure --build=${CLFS_HOST} --host=${CLFS_TARGET} \
39 --prefix=/usr --with-root-prefix="" --with-cc="${CC} ${BUILD} -Os" --with-linker=${LD}</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">Install the binaries, documentation, and shared libraries:</para>
85
86<screen os="i"><userinput>make DESTDIR=${CLFS} install</userinput></screen>
87
88 <para os="j">Install the static libraries and headers:</para>
89
90<screen os="k"><userinput>make DESTDIR=${CLFS} install-libs</userinput></screen>
91
92 </sect2>
93
94 <sect2 id="contents-e2fsprogs" role="content">
95 <title>Contents of E2fsprogs</title>
96
97 <segmentedlist>
98 <segtitle>Installed programs</segtitle>
99 <segtitle>Installed libraries</segtitle>
100
101 <seglistitem>
102 <seg>badblocks, blkid, chattr, compile_et, debugfs, dumpe2fs,
103 e2fsck, e2image, e2label, filefrag, findfs, fsck, fsck.ext2, fsck.ext3,
104 logsave, lsattr, mk_cmds, mke2fs, mkfs.ext2, mkfs.ext3,
105 mklost+found, resize2fs, tune2fs, and uuidgen.</seg>
106 <seg>libblkid.[a,so], libcom_err.[a,so], libe2p.[a,so],
107 libext2fs.[a,so], libss.[a,so], and libuuid.[a,so]</seg>
108 </seglistitem>
109 </segmentedlist>
110
111 <variablelist>
112 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
113 <?dbfo list-presentation="list"?>
114 <?dbhtml list-presentation="table"?>
115
116 <varlistentry id="badblocks">
117 <term><command>badblocks</command></term>
118 <listitem>
119 <para>Searches a device (usually a disk partition) for bad
120 blocks</para>
121 <indexterm zone="ch-system-e2fsprogs badblocks">
122 <primary sortas="b-badblocks">badblocks</primary>
123 </indexterm>
124 </listitem>
125 </varlistentry>
126
127 <varlistentry id="blkid">
128 <term><command>blkid</command></term>
129 <listitem>
130 <para>A command line utility to locate and print block device
131 attributes</para>
132 <indexterm zone="ch-system-e2fsprogs blkid">
133 <primary sortas="b-blkid">blkid</primary>
134 </indexterm>
135 </listitem>
136 </varlistentry>
137
138 <varlistentry id="chattr">
139 <term><command>chattr</command></term>
140 <listitem>
141 <para>Changes the attributes of files on an <systemitem
142 class="filesystem">ext2</systemitem> file system; it also
143 changes <systemitem class="filesystem">ext3</systemitem>
144 file systems, the journaling version of <systemitem
145 class="filesystem">ext2</systemitem> file systems</para>
146 <indexterm zone="ch-system-e2fsprogs chattr">
147 <primary sortas="b-chattr">chattr</primary>
148 </indexterm>
149 </listitem>
150 </varlistentry>
151
152 <varlistentry id="compile_et">
153 <term><command>compile_et</command></term>
154 <listitem>
155 <para>An error table compiler; it converts a table of error-code
156 names and messages into a C source file suitable for use with the
157 <filename class="libraryfile">com_err</filename> library</para>
158 <indexterm zone="ch-system-e2fsprogs compile_et">
159 <primary sortas="b-compile_et">compile_et</primary>
160 </indexterm>
161 </listitem>
162 </varlistentry>
163
164 <varlistentry id="debugfs">
165 <term><command>debugfs</command></term>
166 <listitem>
167 <para>A file system debugger; it can be used to examine and change
168 the state of an <systemitem class="filesystem">ext2</systemitem>
169 file system</para>
170 <indexterm zone="ch-system-e2fsprogs debugfs">
171 <primary sortas="b-debugfs">debugfs</primary>
172 </indexterm>
173 </listitem>
174 </varlistentry>
175
176 <varlistentry id="dumpe2fs">
177 <term><command>dumpe2fs</command></term>
178 <listitem>
179 <para>Prints the super block and blocks group information for the
180 file system present on a given device</para>
181 <indexterm zone="ch-system-e2fsprogs dumpe2fs">
182 <primary sortas="b-dumpe2fs">dumpe2fs</primary>
183 </indexterm>
184 </listitem>
185 </varlistentry>
186
187 <varlistentry id="e2fsck">
188 <term><command>e2fsck</command></term>
189 <listitem>
190 <para>Is used to check, and optionally repair <systemitem
191 class="filesystem">ext2</systemitem> file systems and <systemitem
192 class="filesystem">ext3</systemitem> file systems</para>
193 <indexterm zone="ch-system-e2fsprogs e2fsck">
194 <primary sortas="b-e2fsck">e2fsck</primary>
195 </indexterm>
196 </listitem>
197 </varlistentry>
198
199 <varlistentry id="e2image">
200 <term><command>e2image</command></term>
201 <listitem>
202 <para>Is used to save critical <systemitem
203 class="filesystem">ext2</systemitem> file system data to a file</para>
204 <indexterm zone="ch-system-e2fsprogs e2image">
205 <primary sortas="b-e2image">e2image</primary>
206 </indexterm>
207 </listitem>
208 </varlistentry>
209
210 <varlistentry id="e2label">
211 <term><command>e2label</command></term>
212 <listitem>
213 <para>Displays or changes the file system label on the <systemitem
214 class="filesystem">ext2</systemitem> file system present on a given
215 device</para>
216 <indexterm zone="ch-system-e2fsprogs e2label">
217 <primary sortas="b-e2label">e2label</primary>
218 </indexterm>
219 </listitem>
220 </varlistentry>
221
222 <varlistentry id="filefrag">
223 <term><command>filefrag</command></term>
224 <listitem>
225 <para>Reports on how badly fragmented a particular file might be</para>
226 <indexterm zone="ch-system-e2fsprogs filefrag">
227 <primary sortas="b-filefrag">filefrag</primary>
228 </indexterm>
229 </listitem>
230 </varlistentry>
231
232 <varlistentry id="findfs">
233 <term><command>findfs</command></term>
234 <listitem>
235 <para>Finds a file system by label or Universally Unique Identifier
236 (UUID)</para>
237 <indexterm zone="ch-system-e2fsprogs findfs">
238 <primary sortas="b-findfs">findfs</primary>
239 </indexterm>
240 </listitem>
241 </varlistentry>
242
243 <varlistentry id="fsck">
244 <term><command>fsck</command></term>
245 <listitem>
246 <para>Is used to check, and optionally repair, file systems</para>
247 <indexterm zone="ch-system-e2fsprogs fsck">
248 <primary sortas="b-fsck">fsck</primary>
249 </indexterm>
250 </listitem>
251 </varlistentry>
252
253 <varlistentry id="fsck.ext2">
254 <term><command>fsck.ext2</command></term>
255 <listitem>
256 <para>By default checks <systemitem class="filesystem">ext2</systemitem>
257 file systems</para>
258 <indexterm zone="ch-system-e2fsprogs fsck.ext2">
259 <primary sortas="b-fsck.ext2">fsck.ext2</primary>
260 </indexterm>
261 </listitem>
262 </varlistentry>
263
264 <varlistentry id="fsck.ext3">
265 <term><command>fsck.ext3</command></term>
266 <listitem>
267 <para>By default checks <systemitem class="filesystem">ext3</systemitem>
268 file systems</para>
269 <indexterm zone="ch-system-e2fsprogs fsck.ext3">
270 <primary sortas="b-fsck.ext3">fsck.ext3</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>
274
275 <varlistentry id="logsave">
276 <term><command>logsave</command></term>
277 <listitem>
278 <para>Saves the output of a command in a log file</para>
279 <indexterm zone="ch-system-e2fsprogs logsave">
280 <primary sortas="b-logsave">logsave</primary>
281 </indexterm>
282 </listitem>
283 </varlistentry>
284
285 <varlistentry id="lsattr">
286 <term><command>lsattr</command></term>
287 <listitem>
288 <para>Lists the attributes of files on a second extended file
289 system</para>
290 <indexterm zone="ch-system-e2fsprogs lsattr">
291 <primary sortas="b-lsattr">lsattr</primary>
292 </indexterm>
293 </listitem>
294 </varlistentry>
295
296 <varlistentry id="mk_cmds">
297 <term><command>mk_cmds</command></term>
298 <listitem>
299 <para>Converts a table of command names and help messages into a C
300 source file suitable for use with the <filename
301 class="libraryfile">libss</filename> subsystem library</para>
302 <indexterm zone="ch-system-e2fsprogs mk_cmds">
303 <primary sortas="b-mk_cmds">mk_cmds</primary>
304 </indexterm>
305 </listitem>
306 </varlistentry>
307
308 <varlistentry id="mke2fs">
309 <term><command>mke2fs</command></term>
310 <listitem>
311 <para>Creates an <systemitem class="filesystem">ext2</systemitem>
312 or <systemitem class="filesystem">ext3</systemitem> file system on
313 the given device</para>
314 <indexterm zone="ch-system-e2fsprogs mke2fs">
315 <primary sortas="b-mke2fs">mke2fs</primary>
316 </indexterm>
317 </listitem>
318 </varlistentry>
319
320 <varlistentry id="mkfs.ext2">
321 <term><command>mkfs.ext2</command></term>
322 <listitem>
323 <para>By default creates <systemitem class="filesystem">ext2</systemitem>
324 file systems</para>
325 <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
326 <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
327 </indexterm>
328 </listitem>
329 </varlistentry>
330
331 <varlistentry id="mkfs.ext3">
332 <term><command>mkfs.ext3</command></term>
333 <listitem>
334 <para>By default creates <systemitem class="filesystem">ext3</systemitem>
335 file systems</para>
336 <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
337 <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
338 </indexterm>
339 </listitem>
340 </varlistentry>
341
342 <varlistentry id="mklost-found">
343 <term><command>mklost+found</command></term>
344 <listitem>
345 <para>Used to create a <filename class="directory">lost+found</filename>
346 directory on an <systemitem class="filesystem">ext2</systemitem> file
347 system; it pre-allocates disk blocks to this directory to lighten the
348 task of <command>e2fsck</command></para>
349 <indexterm zone="ch-system-e2fsprogs mklost-found">
350 <primary sortas="b-mklost+found">mklost+found</primary>
351 </indexterm>
352 </listitem>
353 </varlistentry>
354
355 <varlistentry id="resize2fs">
356 <term><command>resize2fs</command></term>
357 <listitem>
358 <para>Can be used to enlarge or shrink an <systemitem
359 class="filesystem">ext2</systemitem> file system</para>
360 <indexterm zone="ch-system-e2fsprogs resize2fs">
361 <primary sortas="b-resize2fs">resize2fs</primary>
362 </indexterm>
363 </listitem>
364 </varlistentry>
365
366 <varlistentry id="tune2fs">
367 <term><command>tune2fs</command></term>
368 <listitem>
369 <para>Adjusts tunable file system parameters on an <systemitem
370 class="filesystem">ext2</systemitem> file system</para>
371 <indexterm zone="ch-system-e2fsprogs tune2fs">
372 <primary sortas="b-tune2fs">tune2fs</primary>
373 </indexterm>
374 </listitem>
375 </varlistentry>
376
377 <varlistentry id="uuidgen">
378 <term><command>uuidgen</command></term>
379 <listitem>
380 <para>Creates new UUIDs. Each new UUID can reasonably be considered
381 unique among all UUIDs created, on the local system and on other
382 systems, in the past and in the future</para>
383 <indexterm zone="ch-system-e2fsprogs uuidgen">
384 <primary sortas="b-uuidgen">uuidgen</primary>
385 </indexterm>
386 </listitem>
387 </varlistentry>
388
389 <varlistentry id="libblkid">
390 <term><filename class="libraryfile">libblkid</filename></term>
391 <listitem>
392 <para>Contains routines for device identification and token
393 extraction</para>
394 <indexterm zone="ch-system-e2fsprogs libblkid">
395 <primary sortas="c-libblkid">libblkid</primary>
396 </indexterm>
397 </listitem>
398 </varlistentry>
399
400 <varlistentry id="libcom_err">
401 <term><filename class="libraryfile">libcom_err</filename></term>
402 <listitem>
403 <para>The common error display routine</para>
404 <indexterm zone="ch-system-e2fsprogs libcom_err">
405 <primary sortas="c-libcom_err">libcom_err</primary>
406 </indexterm>
407 </listitem>
408 </varlistentry>
409
410 <varlistentry id="libe2p">
411 <term><filename class="libraryfile">libe2p</filename></term>
412 <listitem>
413 <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
414 and <command>lsattr</command></para>
415 <indexterm zone="ch-system-e2fsprogs libe2p">
416 <primary sortas="c-libe2p">libe2p</primary>
417 </indexterm>
418 </listitem>
419 </varlistentry>
420
421 <varlistentry id="libext2fs">
422 <term><filename class="libraryfile">libext2fs</filename></term>
423 <listitem>
424 <para>Contains routines to enable user-level programs to manipulate an
425 <systemitem class="filesystem">ext2</systemitem> file system</para>
426 <indexterm zone="ch-system-e2fsprogs libext2fs">
427 <primary sortas="c-libext2fs">libext2fs</primary>
428 </indexterm>
429 </listitem>
430 </varlistentry>
431
432 <varlistentry id="libss">
433 <term><filename class="libraryfile">libss</filename></term>
434 <listitem>
435 <para>Used by <command>debugfs</command></para>
436 <indexterm zone="ch-system-e2fsprogs libss">
437 <primary sortas="c-libss">libss</primary>
438 </indexterm>
439 </listitem>
440 </varlistentry>
441
442 <varlistentry id="libuuid">
443 <term><filename class="libraryfile">libuuid</filename></term>
444 <listitem>
445 <para>Contains routines for generating unique identifiers for objects
446 that may be accessible beyond the local system</para>
447 <indexterm zone="ch-system-e2fsprogs libuuid">
448 <primary sortas="c-libuuid">libuuid</primary>
449 </indexterm>
450 </listitem>
451 </varlistentry>
452
453 </variablelist>
454
455 </sect2>
456
457</sect1>
Note: See TracBrowser for help on using the repository browser.