source: BOOK/final-system/common/e2fsprogs.xml@ 8eacec6

clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since 8eacec6 was 686839b, checked in by William Harrington <kb0iic@…>, 11 years ago

Add screen tags around userinput test commands and remap userinput for test commands as remap="test".
  • Property mode set to 100644
File size: 17.7 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:</para>
76
77<screen os="h2"><userinput remap="test">make check</userinput></screen>
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 <segtitle>Installed directories</segtitle>
96
97 <seglistitem>
98 <seg>badblocks, chattr, compile_et, debugfs, dumpe2fs, e2freefrag,
99 e2fsck, e2image, e2initrd_helper, e2label, e2undo, e4defrag, filefrag,
100 fsck.ext2, fsck.ext3, fsck.ext4, fsck.ext4dev, logsave, lsattr,
101 mk_cmds, mke2fs, mkfs.ext2, mkfs.ext3, mkfs.ext4, mkfs.ext4dev,
102 mklost+found, resize2fs, and tune2fs</seg>
103 <seg>libcom_err.[a,so], libe2p.[a,so], libext2fs.[a,so],
104 libss.[a,so], and libquota.a</seg>
105 <seg>/usr/include/e2p, /usr/include/et, /usr/include/ext2fs,
106 /usr/include/quota, /usr/include/ss, /usr/share/et, /usr/share/ss</seg>
107 </seglistitem>
108 </segmentedlist>
109
110 <variablelist>
111 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
112 <?dbfo list-presentation="list"?>
113 <?dbhtml list-presentation="table"?>
114
115 <varlistentry id="badblocks">
116 <term><command>badblocks</command></term>
117 <listitem>
118 <para>Searches a device (usually a disk partition) for bad
119 blocks</para>
120 <indexterm zone="ch-system-e2fsprogs badblocks">
121 <primary sortas="b-badblocks">badblocks</primary>
122 </indexterm>
123 </listitem>
124 </varlistentry>
125
126 <varlistentry id="chattr">
127 <term><command>chattr</command></term>
128 <listitem>
129 <para>Changes the attributes on a Linux file system</para>
130 <indexterm zone="ch-system-e2fsprogs chattr">
131 <primary sortas="b-chattr">chattr</primary>
132 </indexterm>
133 </listitem>
134 </varlistentry>
135
136 <varlistentry id="compile_et">
137 <term><command>compile_et</command></term>
138 <listitem>
139 <para>An error table compiler; it converts a table of error-code
140 names and messages into a C source file suitable for use with the
141 <filename class="libraryfile">com_err</filename> library</para>
142 <indexterm zone="ch-system-e2fsprogs compile_et">
143 <primary sortas="b-compile_et">compile_et</primary>
144 </indexterm>
145 </listitem>
146 </varlistentry>
147
148 <varlistentry id="debugfs">
149 <term><command>debugfs</command></term>
150 <listitem>
151 <para>A file system debugger; it can be used to examine and change
152 the state of an <systemitem class="filesystem">ext2</systemitem>
153 file system</para>
154 <indexterm zone="ch-system-e2fsprogs debugfs">
155 <primary sortas="b-debugfs">debugfs</primary>
156 </indexterm>
157 </listitem>
158 </varlistentry>
159
160 <varlistentry id="dumpe2fs">
161 <term><command>dumpe2fs</command></term>
162 <listitem>
163 <para>Prints the super block and blocks group information for the
164 file system present on a given device</para>
165 <indexterm zone="ch-system-e2fsprogs dumpe2fs">
166 <primary sortas="b-dumpe2fs">dumpe2fs</primary>
167 </indexterm>
168 </listitem>
169 </varlistentry>
170
171 <varlistentry id="e2freefrag">
172 <term><command>e2freefrag</command></term>
173 <listitem>
174 <para> Reports free space fragmentation information</para>
175 <indexterm zone="ch-system-e2fsprogs e2freefrag">
176 <primary sortas="b-e2freefrag">e2freefrag</primary>
177 </indexterm>
178 </listitem>
179 </varlistentry>
180
181 <varlistentry id="e2fsck">
182 <term><command>e2fsck</command></term>
183 <listitem>
184 <para>Is used to check, and optionally repair <systemitem
185 class="filesystem">ext2</systemitem>, <systemitem
186 class="filesystem">ext3</systemitem> and <systemitem
187 class="filesystem">ext4</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="e4defrag">
239 <term><command>e4defrag</command></term>
240 <listitem>
241 <para>Online defragmenter for ext4 filesystems</para>
242 <indexterm zone="ch-system-e2fsprogs e4defrag">
243 <primary sortas="b-e4defrag">e4defrag</primary>
244 </indexterm>
245 </listitem>
246 </varlistentry>
247
248 <varlistentry id="filefrag">
249 <term><command>filefrag</command></term>
250 <listitem>
251 <para>Reports on how badly fragmented a particular file might be</para>
252 <indexterm zone="ch-system-e2fsprogs filefrag">
253 <primary sortas="b-filefrag">filefrag</primary>
254 </indexterm>
255 </listitem>
256 </varlistentry>
257
258 <varlistentry id="fsck.ext2">
259 <term><command>fsck.ext2</command></term>
260 <listitem>
261 <para>By default checks <systemitem class="filesystem">ext2</systemitem>
262 file systems</para>
263 <indexterm zone="ch-system-e2fsprogs fsck.ext2">
264 <primary sortas="b-fsck.ext2">fsck.ext2</primary>
265 </indexterm>
266 </listitem>
267 </varlistentry>
268
269 <varlistentry id="fsck.ext3">
270 <term><command>fsck.ext3</command></term>
271 <listitem>
272 <para>By default checks <systemitem class="filesystem">ext3</systemitem>
273 file systems</para>
274 <indexterm zone="ch-system-e2fsprogs fsck.ext3">
275 <primary sortas="b-fsck.ext3">fsck.ext3</primary>
276 </indexterm>
277 </listitem>
278 </varlistentry>
279
280 <varlistentry id="fsck.ext4">
281 <term><command>fsck.ext4</command></term>
282 <listitem>
283 <para>By default checks <systemitem class="filesystem">ext4</systemitem>
284 file systems</para>
285 <indexterm zone="ch-system-e2fsprogs fsck.ext4">
286 <primary sortas="b-fsck.ext4">fsck.ext4</primary>
287 </indexterm>
288 </listitem>
289 </varlistentry>
290
291 <varlistentry id="fsck.ext4dev">
292 <term><command>fsck.ext4dev</command></term>
293 <listitem>
294 <para>By default checks <systemitem class="filesystem">ext4dev</systemitem>
295 file systems</para>
296 <indexterm zone="ch-system-e2fsprogs fsck.ext4dev">
297 <primary sortas="b-fsck.ext4dev">fsck.ext4dev</primary>
298 </indexterm>
299 </listitem>
300 </varlistentry>
301
302 <varlistentry id="logsave">
303 <term><command>logsave</command></term>
304 <listitem>
305 <para>Saves the output of a command in a log file</para>
306 <indexterm zone="ch-system-e2fsprogs logsave">
307 <primary sortas="b-logsave">logsave</primary>
308 </indexterm>
309 </listitem>
310 </varlistentry>
311
312 <varlistentry id="lsattr">
313 <term><command>lsattr</command></term>
314 <listitem>
315 <para>Lists the attributes of files on a second extended file
316 system</para>
317 <indexterm zone="ch-system-e2fsprogs lsattr">
318 <primary sortas="b-lsattr">lsattr</primary>
319 </indexterm>
320 </listitem>
321 </varlistentry>
322
323 <varlistentry id="mk_cmds">
324 <term><command>mk_cmds</command></term>
325 <listitem>
326 <para>Converts a table of command names and help messages into a C
327 source file suitable for use with the <filename
328 class="libraryfile">libss</filename> subsystem library</para>
329 <indexterm zone="ch-system-e2fsprogs mk_cmds">
330 <primary sortas="b-mk_cmds">mk_cmds</primary>
331 </indexterm>
332 </listitem>
333 </varlistentry>
334
335 <varlistentry id="mke2fs">
336 <term><command>mke2fs</command></term>
337 <listitem>
338 <para>Creates an <systemitem class="filesystem">ext2</systemitem>,
339 <systemitem class="filesystem">ext3</systemitem> or <systemitem
340 class="filesystem">ext4</systemitem> file system on the given device</para>
341 <indexterm zone="ch-system-e2fsprogs mke2fs">
342 <primary sortas="b-mke2fs">mke2fs</primary>
343 </indexterm>
344 </listitem>
345 </varlistentry>
346
347 <varlistentry id="mkfs.ext2">
348 <term><command>mkfs.ext2</command></term>
349 <listitem>
350 <para>By default creates <systemitem class="filesystem">ext2</systemitem>
351 file systems</para>
352 <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
353 <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
354 </indexterm>
355 </listitem>
356 </varlistentry>
357
358 <varlistentry id="mkfs.ext3">
359 <term><command>mkfs.ext3</command></term>
360 <listitem>
361 <para>By default creates <systemitem class="filesystem">ext3</systemitem>
362 file systems</para>
363 <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
364 <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
365 </indexterm>
366 </listitem>
367 </varlistentry>
368
369 <varlistentry id="mkfs.ext4">
370 <term><command>mkfs.ext4</command></term>
371 <listitem>
372 <para>By default creates <systemitem class="filesystem">ext4</systemitem>
373 file systems</para>
374 <indexterm zone="ch-system-e2fsprogs mkfs.ext4">
375 <primary sortas="b-mkfs.ext4">mkfs.ext4</primary>
376 </indexterm>
377 </listitem>
378 </varlistentry>
379
380 <varlistentry id="mkfs.ext4dev">
381 <term><command>mkfs.ext4dev</command></term>
382 <listitem>
383 <para>By default creates <systemitem class="filesystem">ext4dev</systemitem>
384 file systems</para>
385 <indexterm zone="ch-system-e2fsprogs mkfs.ext4dev">
386 <primary sortas="b-mkfs.ext4dev">mkfs.ext4dev</primary>
387 </indexterm>
388 </listitem>
389 </varlistentry>
390
391 <varlistentry id="mklost-found">
392 <term><command>mklost+found</command></term>
393 <listitem>
394 <para>Used to create a <filename class="directory">lost+found</filename>
395 directory on an <systemitem class="filesystem">ext2</systemitem> file
396 system; it pre-allocates disk blocks to this directory to lighten the
397 task of <command>e2fsck</command></para>
398 <indexterm zone="ch-system-e2fsprogs mklost-found">
399 <primary sortas="b-mklost+found">mklost+found</primary>
400 </indexterm>
401 </listitem>
402 </varlistentry>
403
404 <varlistentry id="resize2fs">
405 <term><command>resize2fs</command></term>
406 <listitem>
407 <para>Can be used to enlarge or shrink an <systemitem
408 class="filesystem">ext2</systemitem> file system</para>
409 <indexterm zone="ch-system-e2fsprogs resize2fs">
410 <primary sortas="b-resize2fs">resize2fs</primary>
411 </indexterm>
412 </listitem>
413 </varlistentry>
414
415 <varlistentry id="tune2fs">
416 <term><command>tune2fs</command></term>
417 <listitem>
418 <para>Adjusts tunable file system parameters on an <systemitem
419 class="filesystem">ext2</systemitem> file system</para>
420 <indexterm zone="ch-system-e2fsprogs tune2fs">
421 <primary sortas="b-tune2fs">tune2fs</primary>
422 </indexterm>
423 </listitem>
424 </varlistentry>
425
426 <varlistentry id="libcom_err">
427 <term><filename class="libraryfile">libcom_err</filename></term>
428 <listitem>
429 <para>The common error display routine</para>
430 <indexterm zone="ch-system-e2fsprogs libcom_err">
431 <primary sortas="c-libcom_err">libcom_err</primary>
432 </indexterm>
433 </listitem>
434 </varlistentry>
435
436 <varlistentry id="libe2p">
437 <term><filename class="libraryfile">libe2p</filename></term>
438 <listitem>
439 <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
440 and <command>lsattr</command></para>
441 <indexterm zone="ch-system-e2fsprogs libe2p">
442 <primary sortas="c-libe2p">libe2p</primary>
443 </indexterm>
444 </listitem>
445 </varlistentry>
446
447 <varlistentry id="libext2fs">
448 <term><filename class="libraryfile">libext2fs</filename></term>
449 <listitem>
450 <para>Contains routines to enable user-level programs to manipulate an
451 <systemitem class="filesystem">ext2</systemitem> file system</para>
452 <indexterm zone="ch-system-e2fsprogs libext2fs">
453 <primary sortas="c-libext2fs">libext2fs</primary>
454 </indexterm>
455 </listitem>
456 </varlistentry>
457
458 <varlistentry id="libquota">
459 <term><filename class="libraryfile">libquota</filename></term>
460 <listitem>
461 <para>Provides an interface for creating and updating quota files
462 and ext4 superblock fields</para>
463 <indexterm zone="ch-system-e2fsprogs libquota">
464 <primary sortas="c-libquota">libquota</primary>
465 </indexterm>
466 </listitem>
467 </varlistentry>
468
469 <varlistentry id="libss">
470 <term><filename class="libraryfile">libss</filename></term>
471 <listitem>
472 <para>Used by <command>debugfs</command></para>
473 <indexterm zone="ch-system-e2fsprogs libss">
474 <primary sortas="c-libss">libss</primary>
475 </indexterm>
476 </listitem>
477 </varlistentry>
478
479 </variablelist>
480
481 </sect2>
482
483</sect1>
Note: See TracBrowser for help on using the repository browser.