source: chapter06/e2fsprogs.xml@ adcd988

10.0 10.0-rc1 10.1 10.1-rc1 11.0 11.0-rc1 11.0-rc2 11.0-rc3 8.3 8.3-rc1 8.3-rc2 8.4 8.4-rc1 9.0 9.0-rc1 9.1 9.1-rc1 cross-chap5 ml-11.0 multilib old-trunk trunk xry111/git-transition xry111/glibc-2.34 xry111/tester-nohack xry111/usr-move
Last change on this file since adcd988 was adcd988, checked in by Bruce Dubbs <bdubbs@…>, 3 years ago

Fix currency for attr and acl

git-svn-id: http://svn.linuxfromscratch.org/LFS/trunk/BOOK@11429 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689

  • Property mode set to 100644
File size: 20.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 <sect1info condition="script">
12 <productname>e2fsprogs</productname>
13 <productnumber>&e2fsprogs-version;</productnumber>
14 <address>&e2fsprogs-url;</address>
15 </sect1info>
16
17 <title>E2fsprogs-&e2fsprogs-version;</title>
18
19 <indexterm zone="ch-system-e2fsprogs">
20 <primary sortas="a-E2fsprogs">E2fsprogs</primary>
21 </indexterm>
22
23 <sect2 role="package">
24 <title/>
25
26 <para>The E2fsprogs package contains the utilities for handling the
27 <systemitem class="filesystem">ext2</systemitem> file system. It also
28 supports the <systemitem class="filesystem">ext3</systemitem> and
29 <systemitem class="filesystem">ext4</systemitem> journaling
30 file systems.</para>
31
32 <segmentedlist>
33 <segtitle>&buildtime;</segtitle>
34 <segtitle>&diskspace;</segtitle>
35
36 <seglistitem>
37 <seg>&e2fsprogs-ch6-sbu;</seg>
38 <seg>&e2fsprogs-ch6-du;</seg>
39 </seglistitem>
40 </segmentedlist>
41
42 </sect2>
43
44 <sect2 role="installation">
45 <title>Installation of E2fsprogs</title>
46
47 <para>The E2fsprogs documentation recommends that the package be built in
48 a subdirectory of the source tree: </para>
49
50<screen><userinput remap="pre">mkdir -v build
51cd build</userinput></screen>
52
53 <para>Prepare E2fsprogs for compilation:</para>
54
55<screen><userinput remap="configure">../configure --prefix=/usr \
56 --bindir=/bin \
57 --with-root-prefix="" \
58 --enable-elf-shlibs \
59 --disable-libblkid \
60 --disable-libuuid \
61 --disable-uuidd \
62 --disable-fsck</userinput></screen>
63
64 <variablelist>
65 <title>The meaning of the environment variable and configure options:</title>
66<!--
67 <varlistentry>
68 <term><parameter>PKG_CONFIG_PATH, LIBS, CFLAGS</parameter></term>
69 <listitem>
70 <para>These variables enable e2fsprogs to be built using the
71 <xref linkend="ch-tools-util-linux"/> package built earlier.</para>
72 </listitem>
73 </varlistentry>
74-->
75 <varlistentry>
76 <term><parameter>--with-root-prefix=""</parameter> and
77 <parameter>--bindir=/bin</parameter></term>
78 <listitem>
79 <para>Certain programs (such as the <command>e2fsck</command>
80 program) are considered essential programs. When, for example,
81 <filename class="directory">/usr</filename> is not mounted, these
82 programs still need to be available. They belong in directories
83 like <filename class="directory">/lib</filename> and <filename
84 class="directory">/sbin</filename>. If this option is not passed
85 to E2fsprogs' configure, the programs are installed into the
86 <filename class="directory">/usr</filename> directory.</para>
87 </listitem>
88 </varlistentry>
89
90 <varlistentry>
91 <term><parameter>--enable-elf-shlibs</parameter></term>
92 <listitem>
93 <para>This creates the shared libraries which some programs
94 in this package use.</para>
95 </listitem>
96 </varlistentry>
97
98 <varlistentry>
99 <term><parameter>--disable-*</parameter></term>
100 <listitem>
101 <para>This prevents E2fsprogs from building and installing the
102 <systemitem class="library">libuuid</systemitem> and
103 <systemitem class="library">libblkid</systemitem> libraries, the
104 <systemitem class="daemon">uuidd</systemitem> daemon, and the
105 <command>fsck</command> wrapper, as Util-Linux installs more
106 recent versions.</para>
107 </listitem>
108 </varlistentry>
109
110 </variablelist>
111
112 <para>Compile the package:</para>
113
114<screen><userinput remap="make">make</userinput></screen>
115
116 <para>To set up and run the test suite we need to first link some
117 libraries from /tools/lib to a location where the test programs look.
118 To run the tests, issue:</para>
119
120<screen><userinput remap="test">ln -sfv /tools/lib/lib{blk,uu}id.so.1 lib
121make LD_LIBRARY_PATH=/tools/lib check</userinput></screen>
122
123 <para>One of the E2fsprogs tests will attempt to allocate 256 MB of memory.
124 If you do not have significantly more RAM than this, be sure to enable
125 sufficient swap space for the test. See <xref
126 linkend="space-creatingfilesystem"/> and <xref linkend="space-mounting"/>
127 for details on creating and enabling swap space. Two tests, f_bigalloc_badinode
128 and f_bigalloc_orphan_list, are known ot fail.</para>
129
130 <para>Install the binaries, documentation, and shared libraries:</para>
131
132<screen><userinput remap="install">make install</userinput></screen>
133
134 <para>Install the static libraries and headers:</para>
135
136<screen><userinput remap="install">make install-libs</userinput></screen>
137
138 <para>Make the installed static libraries writable so debugging symbols can
139 be removed later:</para>
140
141<screen><userinput remap="install">chmod -v u+w /usr/lib/{libcom_err,libe2p,libext2fs,libss}.a</userinput></screen>
142
143 <para>This package installs a gzipped
144 <filename class="extension">.info</filename> file but doesn't update the
145 system-wide <filename>dir</filename> file. Unzip this file and then update
146 the system <filename>dir</filename> file using the following
147 commands:</para>
148
149<screen><userinput remap="install">gunzip -v /usr/share/info/libext2fs.info.gz
150install-info --dir-file=/usr/share/info/dir /usr/share/info/libext2fs.info</userinput></screen>
151
152 <para>If desired, create and install some additional documentation by
153 issuing the following commands:</para>
154
155<screen><userinput remap="install">makeinfo -o doc/com_err.info ../lib/et/com_err.texinfo
156install -v -m644 doc/com_err.info /usr/share/info
157install-info --dir-file=/usr/share/info/dir /usr/share/info/com_err.info</userinput></screen>
158 </sect2>
159
160 <sect2 id="contents-e2fsprogs" role="content">
161 <title>Contents of E2fsprogs</title>
162
163 <segmentedlist>
164 <segtitle>Installed programs</segtitle>
165 <segtitle>Installed libraries</segtitle>
166 <segtitle>Installed directories</segtitle>
167
168 <seglistitem>
169 <seg>badblocks, chattr, compile_et, debugfs, dumpe2fs,e2freefrag,
170 e2fsck, e2image, e2label, e2undo, e4defrag, filefrag, fsck.ext2,
171 fsck.ext3, fsck.ext4, fsck.ext4dev, logsave, lsattr, mk_cmds, mke2fs,
172 mkfs.ext2, mkfs.ext3, mkfs.ext4, mkfs.ext4dev, mklost+found,
173 resize2fs, and tune2fs</seg>
174 <seg>libcom_err.so, libe2p.so, libext2fs.so, and libss.so</seg>
175 <seg>/usr/include/e2p, /usr/include/et, /usr/include/ext2fs,
176 /usr/include/ss, /usr/share/et, and /usr/share/ss</seg>
177 </seglistitem>
178 </segmentedlist>
179
180 <variablelist>
181 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
182 <?dbfo list-presentation="list"?>
183 <?dbhtml list-presentation="table"?>
184
185 <varlistentry id="badblocks">
186 <term><command>badblocks</command></term>
187 <listitem>
188 <para>Searches a device (usually a disk partition) for bad
189 blocks</para>
190 <indexterm zone="ch-system-e2fsprogs badblocks">
191 <primary sortas="b-badblocks">badblocks</primary>
192 </indexterm>
193 </listitem>
194 </varlistentry>
195
196 <varlistentry id="chattr">
197 <term><command>chattr</command></term>
198 <listitem>
199 <para>Changes the attributes of files on an <systemitem
200 class="filesystem">ext2</systemitem> file system; it also
201 changes <systemitem class="filesystem">ext3</systemitem>
202 file systems, the journaling version of <systemitem
203 class="filesystem">ext2</systemitem> file systems</para>
204 <indexterm zone="ch-system-e2fsprogs chattr">
205 <primary sortas="b-chattr">chattr</primary>
206 </indexterm>
207 </listitem>
208 </varlistentry>
209
210 <varlistentry id="compile_et">
211 <term><command>compile_et</command></term>
212 <listitem>
213 <para>An error table compiler; it converts a table of error-code
214 names and messages into a C source file suitable for use with the
215 <filename class="libraryfile">com_err</filename> library</para>
216 <indexterm zone="ch-system-e2fsprogs compile_et">
217 <primary sortas="b-compile_et">compile_et</primary>
218 </indexterm>
219 </listitem>
220 </varlistentry>
221
222 <varlistentry id="debugfs">
223 <term><command>debugfs</command></term>
224 <listitem>
225 <para>A file system debugger; it can be used to examine and change
226 the state of an <systemitem class="filesystem">ext2</systemitem>
227 file system</para>
228 <indexterm zone="ch-system-e2fsprogs debugfs">
229 <primary sortas="b-debugfs">debugfs</primary>
230 </indexterm>
231 </listitem>
232 </varlistentry>
233
234 <varlistentry id="dumpe2fs">
235 <term><command>dumpe2fs</command></term>
236 <listitem>
237 <para>Prints the super block and blocks group information for the
238 file system present on a given device</para>
239 <indexterm zone="ch-system-e2fsprogs dumpe2fs">
240 <primary sortas="b-dumpe2fs">dumpe2fs</primary>
241 </indexterm>
242 </listitem>
243 </varlistentry>
244
245 <varlistentry id="e2freefrag">
246 <term><command>e2freefrag</command></term>
247 <listitem>
248 <para>Reports free space fragmentation information</para>
249 <indexterm zone="ch-system-e2fsprogs e2freefrag">
250 <primary sortas="b-e2freefrag">e2freefrag</primary>
251 </indexterm>
252 </listitem>
253 </varlistentry>
254
255 <varlistentry id="e2fsck">
256 <term><command>e2fsck</command></term>
257 <listitem>
258 <para>Is used to check, and optionally repair <systemitem
259 class="filesystem">ext2</systemitem> file systems and <systemitem
260 class="filesystem">ext3</systemitem> file systems</para>
261 <indexterm zone="ch-system-e2fsprogs e2fsck">
262 <primary sortas="b-e2fsck">e2fsck</primary>
263 </indexterm>
264 </listitem>
265 </varlistentry>
266
267 <varlistentry id="e2image">
268 <term><command>e2image</command></term>
269 <listitem>
270 <para>Is used to save critical <systemitem
271 class="filesystem">ext2</systemitem> file system data to a file</para>
272 <indexterm zone="ch-system-e2fsprogs e2image">
273 <primary sortas="b-e2image">e2image</primary>
274 </indexterm>
275 </listitem>
276 </varlistentry>
277
278 <varlistentry id="e2label">
279 <term><command>e2label</command></term>
280 <listitem>
281 <para>Displays or changes the file system label on the <systemitem
282 class="filesystem">ext2</systemitem> file system present on a given
283 device</para>
284 <indexterm zone="ch-system-e2fsprogs e2label">
285 <primary sortas="b-e2label">e2label</primary>
286 </indexterm>
287 </listitem>
288 </varlistentry>
289
290 <varlistentry id="e2undo">
291 <term><command>e2undo</command></term>
292 <listitem>
293 <para>Replays the undo log undo_log for an ext2/ext3/ext4 filesystem
294 found on a device [This can be used to undo a failed operation by an
295 e2fsprogs program.]</para>
296 <indexterm zone="ch-system-e2fsprogs e2undo">
297 <primary sortas="b-e2undo">e2undo</primary>
298 </indexterm>
299 </listitem>
300 </varlistentry>
301
302 <varlistentry id="e4defrag">
303 <term><command>e4defrag</command></term>
304 <listitem>
305 <para>Online defragmenter for ext4 filesystems</para>
306 <indexterm zone="ch-system-e2fsprogs e4defrag">
307 <primary sortas="b-e4defrag">e4defrag</primary>
308 </indexterm>
309 </listitem>
310 </varlistentry>
311
312 <varlistentry id="filefrag">
313 <term><command>filefrag</command></term>
314 <listitem>
315 <para>Reports on how badly fragmented a particular file might be</para>
316 <indexterm zone="ch-system-e2fsprogs filefrag">
317 <primary sortas="b-filefrag">filefrag</primary>
318 </indexterm>
319 </listitem>
320 </varlistentry>
321
322 <varlistentry id="fsck.ext2">
323 <term><command>fsck.ext2</command></term>
324 <listitem>
325 <para>By default checks <systemitem class="filesystem">ext2</systemitem>
326 file systems and is a hard link to <command>e2fsck</command></para>
327 <indexterm zone="ch-system-e2fsprogs fsck.ext2">
328 <primary sortas="b-fsck.ext2">fsck.ext2</primary>
329 </indexterm>
330 </listitem>
331 </varlistentry>
332
333 <varlistentry id="fsck.ext3">
334 <term><command>fsck.ext3</command></term>
335 <listitem>
336 <para>By default checks <systemitem class="filesystem">ext3</systemitem>
337 file systems and is a hard link to <command>e2fsck</command></para>
338 <indexterm zone="ch-system-e2fsprogs fsck.ext3">
339 <primary sortas="b-fsck.ext3">fsck.ext3</primary>
340 </indexterm>
341 </listitem>
342 </varlistentry>
343
344 <varlistentry id="fsck.ext4">
345 <term><command>fsck.ext4</command></term>
346 <listitem>
347 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
348 file systems and is a hard link to <command>e2fsck</command></para>
349 <indexterm zone="ch-system-e2fsprogs fsck.ext4">
350 <primary sortas="b-fsck.ext4">fsck.ext4</primary>
351 </indexterm>
352 </listitem>
353 </varlistentry>
354
355 <varlistentry id="fsck.ext4dev">
356 <term><command>fsck.ext4dev</command></term>
357 <listitem>
358 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
359 development file systems and is a hard link to
360 <command>e2fsck</command></para>
361 <indexterm zone="ch-system-e2fsprogs fsck.ext4dev">
362 <primary sortas="b-fsck.ext4dev">fsck.ext4dev</primary>
363 </indexterm>
364 </listitem>
365 </varlistentry>
366
367 <varlistentry id="logsave">
368 <term><command>logsave</command></term>
369 <listitem>
370 <para>Saves the output of a command in a log file</para>
371 <indexterm zone="ch-system-e2fsprogs logsave">
372 <primary sortas="b-logsave">logsave</primary>
373 </indexterm>
374 </listitem>
375 </varlistentry>
376
377 <varlistentry id="lsattr">
378 <term><command>lsattr</command></term>
379 <listitem>
380 <para>Lists the attributes of files on a second extended file
381 system</para>
382 <indexterm zone="ch-system-e2fsprogs lsattr">
383 <primary sortas="b-lsattr">lsattr</primary>
384 </indexterm>
385 </listitem>
386 </varlistentry>
387
388 <varlistentry id="mk_cmds">
389 <term><command>mk_cmds</command></term>
390 <listitem>
391 <para>Converts a table of command names and help messages into a C
392 source file suitable for use with the <filename
393 class="libraryfile">libss</filename> subsystem library</para>
394 <indexterm zone="ch-system-e2fsprogs mk_cmds">
395 <primary sortas="b-mk_cmds">mk_cmds</primary>
396 </indexterm>
397 </listitem>
398 </varlistentry>
399
400 <varlistentry id="mke2fs">
401 <term><command>mke2fs</command></term>
402 <listitem>
403 <para>Creates an <systemitem class="filesystem">ext2</systemitem>
404 or <systemitem class="filesystem">ext3</systemitem> file system on
405 the given device</para>
406 <indexterm zone="ch-system-e2fsprogs mke2fs">
407 <primary sortas="b-mke2fs">mke2fs</primary>
408 </indexterm>
409 </listitem>
410 </varlistentry>
411
412 <varlistentry id="mkfs.ext2">
413 <term><command>mkfs.ext2</command></term>
414 <listitem>
415 <para>By default creates <systemitem class="filesystem">ext2</systemitem>
416 file systems and is a hard link to <command>mke2fs</command></para>
417 <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
418 <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
419 </indexterm>
420 </listitem>
421 </varlistentry>
422
423 <varlistentry id="mkfs.ext3">
424 <term><command>mkfs.ext3</command></term>
425 <listitem>
426 <para>By default creates <systemitem class="filesystem">ext3</systemitem>
427 file systems and is a hard link to <command>mke2fs</command></para>
428 <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
429 <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
430 </indexterm>
431 </listitem>
432 </varlistentry>
433
434 <varlistentry id="mkfs.ext4">
435 <term><command>mkfs.ext4</command></term>
436 <listitem>
437 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
438 file systems and is a hard link to <command>mke2fs</command></para>
439 <indexterm zone="ch-system-e2fsprogs mkfs.ext4">
440 <primary sortas="b-mkfs.ext4">mkfs.ext4</primary>
441 </indexterm>
442 </listitem>
443 </varlistentry>
444
445 <varlistentry id="mkfs.ext4dev">
446 <term><command>mkfs.ext4dev</command></term>
447 <listitem>
448 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
449 development file systems and is a hard link to <command>mke2fs</command></para>
450 <indexterm zone="ch-system-e2fsprogs mkfs.ext4dev">
451 <primary sortas="b-mkfs.ext4dev">mkfs.ext4dev</primary>
452 </indexterm>
453 </listitem>
454 </varlistentry>
455
456 <varlistentry id="mklost-found">
457 <term><command>mklost+found</command></term>
458 <listitem>
459 <para>Used to create a <filename class="directory">lost+found</filename>
460 directory on an <systemitem class="filesystem">ext2</systemitem> file
461 system; it pre-allocates disk blocks to this directory to lighten the
462 task of <command>e2fsck</command></para>
463 <indexterm zone="ch-system-e2fsprogs mklost-found">
464 <primary sortas="b-mklost+found">mklost+found</primary>
465 </indexterm>
466 </listitem>
467 </varlistentry>
468
469 <varlistentry id="resize2fs">
470 <term><command>resize2fs</command></term>
471 <listitem>
472 <para>Can be used to enlarge or shrink an <systemitem
473 class="filesystem">ext2</systemitem> file system</para>
474 <indexterm zone="ch-system-e2fsprogs resize2fs">
475 <primary sortas="b-resize2fs">resize2fs</primary>
476 </indexterm>
477 </listitem>
478 </varlistentry>
479
480 <varlistentry id="tune2fs">
481 <term><command>tune2fs</command></term>
482 <listitem>
483 <para>Adjusts tunable file system parameters on an <systemitem
484 class="filesystem">ext2</systemitem> file system</para>
485 <indexterm zone="ch-system-e2fsprogs tune2fs">
486 <primary sortas="b-tune2fs">tune2fs</primary>
487 </indexterm>
488 </listitem>
489 </varlistentry>
490
491 <varlistentry id="libcom_err">
492 <term><filename class="libraryfile">libcom_err</filename></term>
493 <listitem>
494 <para>The common error display routine</para>
495 <indexterm zone="ch-system-e2fsprogs libcom_err">
496 <primary sortas="c-libcom_err">libcom_err</primary>
497 </indexterm>
498 </listitem>
499 </varlistentry>
500
501 <varlistentry id="libe2p">
502 <term><filename class="libraryfile">libe2p</filename></term>
503 <listitem>
504 <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
505 and <command>lsattr</command></para>
506 <indexterm zone="ch-system-e2fsprogs libe2p">
507 <primary sortas="c-libe2p">libe2p</primary>
508 </indexterm>
509 </listitem>
510 </varlistentry>
511
512 <varlistentry id="libext2fs">
513 <term><filename class="libraryfile">libext2fs</filename></term>
514 <listitem>
515 <para>Contains routines to enable user-level programs to manipulate an
516 <systemitem class="filesystem">ext2</systemitem> file system</para>
517 <indexterm zone="ch-system-e2fsprogs libext2fs">
518 <primary sortas="c-libext2fs">libext2fs</primary>
519 </indexterm>
520 </listitem>
521 </varlistentry>
522
523 <varlistentry id="libss">
524 <term><filename class="libraryfile">libss</filename></term>
525 <listitem>
526 <para>Used by <command>debugfs</command></para>
527 <indexterm zone="ch-system-e2fsprogs libss">
528 <primary sortas="c-libss">libss</primary>
529 </indexterm>
530 </listitem>
531 </varlistentry>
532
533 </variablelist>
534
535 </sect2>
536
537</sect1>
Note: See TracBrowser for help on using the repository browser.