source: BOOK/final-system/common/e2fsprogs.xml@ 5f4a45c9

clfs-1.2 clfs-2.1 clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since 5f4a45c9 was 427015f, checked in by Chris Staub <chris@…>, 16 years ago

Update lists of installed programs
  • Property mode set to 100644
File size: 18.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>../configure --prefix=/usr --with-root-prefix="" \
39 --enable-elf-shlibs --with-cc=gcc</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 </variablelist>
67
68 <para os="f">Compile the package:</para>
69
70<screen os="g"><userinput>make</userinput></screen>
71
72 <para os="h">To test the results, issue:
73 <userinput>make check</userinput>.</para>
74
75 <para os="i">Install the binaries, documentation and shared libraries:</para>
76
77<screen os="j"><userinput>make install</userinput></screen>
78
79 <para os="k">Install the static libraries and headers:</para>
80
81<screen os="l"><userinput>make install-libs</userinput></screen>
82
83 </sect2>
84
85 <sect2 id="contents-e2fsprogs" role="content">
86 <title>Contents of E2fsprogs</title>
87
88 <segmentedlist>
89 <segtitle>Installed programs</segtitle>
90 <segtitle>Installed libraries</segtitle>
91
92 <seglistitem>
93 <seg>badblocks, blkid, chattr, compile_et, debugfs, dumpe2fs,
94 e2fsck, e2image, e2label, e2undo, filefrag, findfs, fsck, fsck.ext2,
95 fsck.ext3, fsck.ext4, fsck.ext4dev logsave, lsattr, mk_cmds, mke2fs,
96 mkfs.ext2, mkfs.ext3, mkfs.ext4, mkfs.ext4dev mklost+found, resize2fs,
97 tune2fs, uuidd, and uuidgen.</seg>
98 <seg>libblkid.[a,so], libcom_err.[a,so], libe2p.[a,so],
99 libext2fs.[a,so], libss.[a,so], and libuuid.[a,so]</seg>
100 </seglistitem>
101 </segmentedlist>
102
103 <variablelist>
104 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
105 <?dbfo list-presentation="list"?>
106 <?dbhtml list-presentation="table"?>
107
108 <varlistentry id="badblocks">
109 <term><command>badblocks</command></term>
110 <listitem>
111 <para>Searches a device (usually a disk partition) for bad
112 blocks</para>
113 <indexterm zone="ch-system-e2fsprogs badblocks">
114 <primary sortas="b-badblocks">badblocks</primary>
115 </indexterm>
116 </listitem>
117 </varlistentry>
118
119 <varlistentry id="blkid">
120 <term><command>blkid</command></term>
121 <listitem>
122 <para>A command line utility to locate and print block device
123 attributes</para>
124 <indexterm zone="ch-system-e2fsprogs blkid">
125 <primary sortas="b-blkid">blkid</primary>
126 </indexterm>
127 </listitem>
128 </varlistentry>
129
130 <varlistentry id="chattr">
131 <term><command>chattr</command></term>
132 <listitem>
133 <para>Changes the attributes of files on an <systemitem
134 class="filesystem">ext2</systemitem> file system; it also
135 changes <systemitem class="filesystem">ext3</systemitem>
136 file systems, the journaling version of <systemitem
137 class="filesystem">ext2</systemitem> file systems</para>
138 <indexterm zone="ch-system-e2fsprogs chattr">
139 <primary sortas="b-chattr">chattr</primary>
140 </indexterm>
141 </listitem>
142 </varlistentry>
143
144 <varlistentry id="compile_et">
145 <term><command>compile_et</command></term>
146 <listitem>
147 <para>An error table compiler; it converts a table of error-code
148 names and messages into a C source file suitable for use with the
149 <filename class="libraryfile">com_err</filename> library</para>
150 <indexterm zone="ch-system-e2fsprogs compile_et">
151 <primary sortas="b-compile_et">compile_et</primary>
152 </indexterm>
153 </listitem>
154 </varlistentry>
155
156 <varlistentry id="debugfs">
157 <term><command>debugfs</command></term>
158 <listitem>
159 <para>A file system debugger; it can be used to examine and change
160 the state of an <systemitem class="filesystem">ext2</systemitem>
161 file system</para>
162 <indexterm zone="ch-system-e2fsprogs debugfs">
163 <primary sortas="b-debugfs">debugfs</primary>
164 </indexterm>
165 </listitem>
166 </varlistentry>
167
168 <varlistentry id="dumpe2fs">
169 <term><command>dumpe2fs</command></term>
170 <listitem>
171 <para>Prints the super block and blocks group information for the
172 file system present on a given device</para>
173 <indexterm zone="ch-system-e2fsprogs dumpe2fs">
174 <primary sortas="b-dumpe2fs">dumpe2fs</primary>
175 </indexterm>
176 </listitem>
177 </varlistentry>
178
179 <varlistentry id="e2fsck">
180 <term><command>e2fsck</command></term>
181 <listitem>
182 <para>Is used to check, and optionally repair <systemitem
183 class="filesystem">ext2</systemitem> file systems and <systemitem
184 class="filesystem">ext3</systemitem> file systems</para>
185 <indexterm zone="ch-system-e2fsprogs e2fsck">
186 <primary sortas="b-e2fsck">e2fsck</primary>
187 </indexterm>
188 </listitem>
189 </varlistentry>
190
191 <varlistentry id="e2image">
192 <term><command>e2image</command></term>
193 <listitem>
194 <para>Is used to save critical <systemitem
195 class="filesystem">ext2</systemitem> file system data to a file</para>
196 <indexterm zone="ch-system-e2fsprogs e2image">
197 <primary sortas="b-e2image">e2image</primary>
198 </indexterm>
199 </listitem>
200 </varlistentry>
201
202 <varlistentry id="e2label">
203 <term><command>e2label</command></term>
204 <listitem>
205 <para>Displays or changes the file system label on the <systemitem
206 class="filesystem">ext2</systemitem> file system present on a given
207 device</para>
208 <indexterm zone="ch-system-e2fsprogs e2label">
209 <primary sortas="b-e2label">e2label</primary>
210 </indexterm>
211 </listitem>
212 </varlistentry>
213
214 <varlistentry id="e2undo">
215 <term><command>e2undo</command></term>
216 <listitem>
217 <para>Replays an undo log for an ext2/ext3/ext4 filesystem</para>
218 <indexterm zone="ch-system-e2fsprogs e2undo">
219 <primary sortas="b-e2undo">e2undo</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="fsck.ext4dev">
289 <term><command>fsck.ext4dev</command></term>
290 <listitem>
291 <para>By default checks <systemitem class="filesystem">ext4dev</systemitem>
292 file systems</para>
293 <indexterm zone="ch-system-e2fsprogs fsck.ext4dev">
294 <primary sortas="b-fsck.ext4dev">fsck.ext4dev</primary>
295 </indexterm>
296 </listitem>
297 </varlistentry>
298
299 <varlistentry id="logsave">
300 <term><command>logsave</command></term>
301 <listitem>
302 <para>Saves the output of a command in a log file</para>
303 <indexterm zone="ch-system-e2fsprogs logsave">
304 <primary sortas="b-logsave">logsave</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308
309 <varlistentry id="lsattr">
310 <term><command>lsattr</command></term>
311 <listitem>
312 <para>Lists the attributes of files on a second extended file
313 system</para>
314 <indexterm zone="ch-system-e2fsprogs lsattr">
315 <primary sortas="b-lsattr">lsattr</primary>
316 </indexterm>
317 </listitem>
318 </varlistentry>
319
320 <varlistentry id="mk_cmds">
321 <term><command>mk_cmds</command></term>
322 <listitem>
323 <para>Converts a table of command names and help messages into a C
324 source file suitable for use with the <filename
325 class="libraryfile">libss</filename> subsystem library</para>
326 <indexterm zone="ch-system-e2fsprogs mk_cmds">
327 <primary sortas="b-mk_cmds">mk_cmds</primary>
328 </indexterm>
329 </listitem>
330 </varlistentry>
331
332 <varlistentry id="mke2fs">
333 <term><command>mke2fs</command></term>
334 <listitem>
335 <para>Creates an <systemitem class="filesystem">ext2</systemitem>
336 or <systemitem class="filesystem">ext3</systemitem> file system on
337 the given device</para>
338 <indexterm zone="ch-system-e2fsprogs mke2fs">
339 <primary sortas="b-mke2fs">mke2fs</primary>
340 </indexterm>
341 </listitem>
342 </varlistentry>
343
344 <varlistentry id="mkfs.ext2">
345 <term><command>mkfs.ext2</command></term>
346 <listitem>
347 <para>By default creates <systemitem class="filesystem">ext2</systemitem>
348 file systems</para>
349 <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
350 <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
351 </indexterm>
352 </listitem>
353 </varlistentry>
354
355 <varlistentry id="mkfs.ext3">
356 <term><command>mkfs.ext3</command></term>
357 <listitem>
358 <para>By default creates <systemitem class="filesystem">ext3</systemitem>
359 file systems</para>
360 <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
361 <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
362 </indexterm>
363 </listitem>
364 </varlistentry>
365
366 <varlistentry id="mkfs.ext4">
367 <term><command>mkfs.ext4</command></term>
368 <listitem>
369 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
370 file systems</para>
371 <indexterm zone="ch-system-e2fsprogs mkfs.ext4">
372 <primary sortas="b-mkfs.ext4">mkfs.ext4</primary>
373 </indexterm>
374 </listitem>
375 </varlistentry>
376
377 <varlistentry id="mkfs.ext4dev">
378 <term><command>mkfs.ext4dev</command></term>
379 <listitem>
380 <para>By default creates <systemitem class="filesystem">ext4dev</systemitem>
381 file systems</para>
382 <indexterm zone="ch-system-e2fsprogs mkfs.ext4dev">
383 <primary sortas="b-mkfs.ext4dev">mkfs.ext4dev</primary>
384 </indexterm>
385 </listitem>
386 </varlistentry>
387
388 <varlistentry id="mklost-found">
389 <term><command>mklost+found</command></term>
390 <listitem>
391 <para>Used to create a <filename class="directory">lost+found</filename>
392 directory on an <systemitem class="filesystem">ext2</systemitem> file
393 system; it pre-allocates disk blocks to this directory to lighten the
394 task of <command>e2fsck</command></para>
395 <indexterm zone="ch-system-e2fsprogs mklost-found">
396 <primary sortas="b-mklost+found">mklost+found</primary>
397 </indexterm>
398 </listitem>
399 </varlistentry>
400
401 <varlistentry id="resize2fs">
402 <term><command>resize2fs</command></term>
403 <listitem>
404 <para>Can be used to enlarge or shrink an <systemitem
405 class="filesystem">ext2</systemitem> file system</para>
406 <indexterm zone="ch-system-e2fsprogs resize2fs">
407 <primary sortas="b-resize2fs">resize2fs</primary>
408 </indexterm>
409 </listitem>
410 </varlistentry>
411
412 <varlistentry id="tune2fs">
413 <term><command>tune2fs</command></term>
414 <listitem>
415 <para>Adjusts tunable file system parameters on an <systemitem
416 class="filesystem">ext2</systemitem> file system</para>
417 <indexterm zone="ch-system-e2fsprogs tune2fs">
418 <primary sortas="b-tune2fs">tune2fs</primary>
419 </indexterm>
420 </listitem>
421 </varlistentry>
422
423 <varlistentry id="uuidd">
424 <term><command>uuidd</command></term>
425 <listitem>
426 <para>The uuidd daemon is used by the UUID library to generate
427 universally unique identifiers (UUIDs), especially time-based UUID's
428 in a secure and guaranteed-unique fashion, even in the face of large
429 numbers of threads trying to grab UUID's running on different CPU's.
430 </para>
431 <indexterm zone="ch-system-e2fsprogs uuidd">
432 <primary sortas="b-uuidd">uuidd</primary>
433 </indexterm>
434 </listitem>
435 </varlistentry>
436
437 <varlistentry id="uuidgen">
438 <term><command>uuidgen</command></term>
439 <listitem>
440 <para>Creates new UUIDs. Each new UUID can reasonably be considered
441 unique among all UUIDs created, on the local system and on other
442 systems, in the past and in the future</para>
443 <indexterm zone="ch-system-e2fsprogs uuidgen">
444 <primary sortas="b-uuidgen">uuidgen</primary>
445 </indexterm>
446 </listitem>
447 </varlistentry>
448
449 <varlistentry id="libblkid">
450 <term><filename class="libraryfile">libblkid</filename></term>
451 <listitem>
452 <para>Contains routines for device identification and token
453 extraction</para>
454 <indexterm zone="ch-system-e2fsprogs libblkid">
455 <primary sortas="c-libblkid">libblkid</primary>
456 </indexterm>
457 </listitem>
458 </varlistentry>
459
460 <varlistentry id="libcom_err">
461 <term><filename class="libraryfile">libcom_err</filename></term>
462 <listitem>
463 <para>The common error display routine</para>
464 <indexterm zone="ch-system-e2fsprogs libcom_err">
465 <primary sortas="c-libcom_err">libcom_err</primary>
466 </indexterm>
467 </listitem>
468 </varlistentry>
469
470 <varlistentry id="libe2p">
471 <term><filename class="libraryfile">libe2p</filename></term>
472 <listitem>
473 <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
474 and <command>lsattr</command></para>
475 <indexterm zone="ch-system-e2fsprogs libe2p">
476 <primary sortas="c-libe2p">libe2p</primary>
477 </indexterm>
478 </listitem>
479 </varlistentry>
480
481 <varlistentry id="libext2fs">
482 <term><filename class="libraryfile">libext2fs</filename></term>
483 <listitem>
484 <para>Contains routines to enable user-level programs to manipulate an
485 <systemitem class="filesystem">ext2</systemitem> file system</para>
486 <indexterm zone="ch-system-e2fsprogs libext2fs">
487 <primary sortas="c-libext2fs">libext2fs</primary>
488 </indexterm>
489 </listitem>
490 </varlistentry>
491
492 <varlistentry id="libss">
493 <term><filename class="libraryfile">libss</filename></term>
494 <listitem>
495 <para>Used by <command>debugfs</command></para>
496 <indexterm zone="ch-system-e2fsprogs libss">
497 <primary sortas="c-libss">libss</primary>
498 </indexterm>
499 </listitem>
500 </varlistentry>
501
502 <varlistentry id="libuuid">
503 <term><filename class="libraryfile">libuuid</filename></term>
504 <listitem>
505 <para>Contains routines for generating unique identifiers for objects
506 that may be accessible beyond the local system</para>
507 <indexterm zone="ch-system-e2fsprogs libuuid">
508 <primary sortas="c-libuuid">libuuid</primary>
509 </indexterm>
510 </listitem>
511 </varlistentry>
512
513 </variablelist>
514
515 </sect2>
516
517</sect1>
Note: See TracBrowser for help on using the repository browser.