source: final-system/common/e2fsprogs.xml@ 288217a9

Last change on this file since 288217a9 was 155e089, checked in by Jim Gifford <clfs@…>, 19 years ago

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