source: clfs-embedded/BOOK/beyond-filesys/common/e2fsprogs.xml@ c898266

Last change on this file since c898266 was c898266, checked in by Andrew Bradford <bradfa@…>, 14 years ago

Create beyond-filesys section

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