source: chapter06/e2fsprogs.xml@ e747759

10.0 10.0-rc1 10.1 10.1-rc1 11.0 11.0-rc1 11.0-rc2 11.0-rc3 11.1 11.1-rc1 11.2 11.2-rc1 11.3 11.3-rc1 12.0 12.0-rc1 12.1 12.1-rc1 6.4 6.5 6.6 6.7 6.8 7.0 7.1 7.2 7.3 7.4 7.5 7.5-systemd 7.6 7.6-systemd 7.7 7.7-systemd 7.8 7.8-systemd 7.9 7.9-systemd 8.0 8.1 8.2 8.3 8.4 9.0 9.1 arm bdubbs/gcc13 ml-11.0 multilib renodr/libudev-from-systemd s6-init trunk xry111/arm64 xry111/arm64-12.0 xry111/clfs-ng xry111/lfs-next xry111/loongarch xry111/loongarch-12.0 xry111/loongarch-12.1 xry111/mips64el xry111/pip3 xry111/rust-wip-20221008 xry111/update-glibc
Last change on this file since e747759 was e747759, checked in by Manuel Canales Esparcia <manuel@…>, 17 years ago

Added sect1info blocks to packages pages.

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