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

clfs-3.0.0-systemdsystemd
Last change on this file since f698055a was f698055a, checked in by Chris Staub <chris@…>, 6 years ago

Improve consistency in package installation lists, mainly removing 'and'

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