source: BOOK/final-system/common/e2fsprogs.xml@ 37389ed

clfs-1.2 clfs-2.1 clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since 37389ed was f213337, checked in by Chris Staub <chris@…>, 15 years ago

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