source: BOOK/final-system/common/e2fsprogs.xml@ 8518b40

clfs-2.1 clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since 8518b40 was 2538f4d, checked in by William Harrington <kb0iic@…>, 12 years ago

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