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

systemd
Last change on this file since e936abe was e2745ee, checked in by William Harrington <kb0iic@…>, 9 years ago

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