e2fsprogs.xml 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  3. <!ENTITY % general-entities SYSTEM "../general.ent">
  4. %general-entities;
  5. ]>
  6. <sect1 id="ch-system-e2fsprogs" xreflabel="E2fsprogs" role="wrap">
  7. <title>E2fsprogs-&e2fsprogs-version;</title>
  8. <?dbhtml filename="e2fsprogs.html"?>
  9. <indexterm zone="ch-system-e2fsprogs"><primary sortas="a-E2fsprogs">E2fsprogs</primary></indexterm>
  10. <sect2 role="package"><title/>
  11. <para>The E2fsprogs package contains the utilities for handling the ext2
  12. file system. It also supports the ext3 journaling file system.</para>
  13. <segmentedlist>
  14. <segtitle>&buildtime;</segtitle>
  15. <segtitle>&diskspace;</segtitle>
  16. <seglistitem><seg>0.6 SBU</seg><seg>48.4 MB</seg></seglistitem>
  17. </segmentedlist>
  18. <segmentedlist>
  19. <segtitle>E2fsprogs installation depends on</segtitle>
  20. <seglistitem><seg>Bash, Binutils, Coreutils,
  21. Diffutils, Gawk, GCC, Gettext, Glibc, Grep, Make, Sed, Texinfo</seg></seglistitem>
  22. </segmentedlist>
  23. </sect2>
  24. <sect2 role="installation">
  25. <title>Installation of E2fsprogs</title>
  26. <para>Prepare E2fsprogs for compilation:</para>
  27. <screen><userinput>./configure --prefix=/usr --with-root-prefix="" \
  28. --enable-elf-shlibs --disable-evms</userinput></screen>
  29. <para>The meaning of the configure options:</para>
  30. <itemizedlist>
  31. <listitem><para><userinput>--with-root-prefix=""</userinput>: Certain
  32. programs (such as the e2fsck program) are considered essential programs.
  33. When, for example, <filename class="directory">/usr</filename> isn't
  34. mounted, these essential programs have to be available. They belong in
  35. directories like <filename class="directory">/lib</filename> and
  36. <filename class="directory">/sbin</filename>. If this option isn't passed
  37. to E2fsprogs's configure, the programs are placed in the
  38. <filename class="directory">/usr</filename> directory, which is not what we
  39. want.</para></listitem>
  40. <listitem><para><userinput>--enable-elf-shlibs</userinput>: This creates
  41. the shared libraries which some programs in this package use.</para></listitem>
  42. </itemizedlist>
  43. <para>Compile the package:</para>
  44. <screen><userinput>make</userinput></screen>
  45. <para>To test the results, issue:
  46. <userinput>make check</userinput>.</para>
  47. <para>Install most of the package:</para>
  48. <screen><userinput>make install</userinput></screen>
  49. <para>Also install also the shared libraries:</para>
  50. <screen><userinput>make install-libs</userinput></screen>
  51. </sect2>
  52. <sect2 id="contents-e2fsprogs"><title>Contents of E2fsprogs</title>
  53. <para><emphasis>Installed programs</emphasis>: badblocks, blkid, chattr,
  54. compile_et, debugfs, dumpe2fs, e2fsck, e2image, e2label, findfs, fsck,
  55. fsck.ext2, fsck.ext3, logsave, lsattr, mk_cmds, mke2fs, mkfs.ext2, mkfs.ext3,
  56. mklost+found, resize2fs, tune2fs and uuidgen.</para>
  57. <para><emphasis>Installed libraries</emphasis>: libblkid.[a,so],
  58. libcom_err.[a,so], libe2p.[a,so], libext2fs.[a,so], libss.[a,so] and
  59. libuuid.[a,so]</para>
  60. </sect2>
  61. <sect2><title>Short descriptions</title>
  62. <indexterm zone="ch-system-e2fsprogs badblocks"><primary sortas="b-badblocks">badblocks</primary></indexterm>
  63. <para id="badblocks"><command>badblocks</command> searches a device (usually a disk
  64. partition) for bad blocks.</para>
  65. <indexterm zone="ch-system-e2fsprogs blkid"><primary sortas="b-blkid">blkid</primary></indexterm>
  66. <para id="blkid"><command>blkid</command> is a command line utility to locate and
  67. print block device attributes.</para>
  68. <indexterm zone="ch-system-e2fsprogs chattr"><primary sortas="b-chattr">chattr</primary></indexterm>
  69. <para id="chattr"><command>chattr</command> changes the attributes of files on a
  70. second extended (ext2) file system, and also ext3 file systems, the journaling version of ext2 file systems.</para>
  71. <indexterm zone="ch-system-e2fsprogs compile_et"><primary sortas="b-compile_et">compile_et</primary></indexterm>
  72. <para id="compile_et"><command>compile_et</command> is an error table compiler. It
  73. converts a table of error-code names and messages into a C source file
  74. suitable for use with the com_err library.</para>
  75. <indexterm zone="ch-system-e2fsprogs debugfs"><primary sortas="b-debugfs">debugfs</primary></indexterm>
  76. <para id="debugfs"><command>debugfs</command> is a file system debugger. It can be
  77. used to examine and change the state of an ext2 file system.</para>
  78. <indexterm zone="ch-system-e2fsprogs dumpe2fs"><primary sortas="b-dumpe2fs">dumpe2fs</primary></indexterm>
  79. <para id="dumpe2fs"><command>dumpe2fs</command> prints the super block and blocks group
  80. information for the file system present on a given device.</para>
  81. <indexterm zone="ch-system-e2fsprogs e2fsck"><primary sortas="b-e2fsck">e2fsck</primary></indexterm>
  82. <para id="e2fsck"><command>e2fsck</command> is used to check, and optionally repair,
  83. second extended (ext2) file systems, and also ext3 file systems.</para>
  84. <indexterm zone="ch-system-e2fsprogs e2image"><primary sortas="b-e2image">e2image</primary></indexterm>
  85. <para id="e2image"><command>e2image</command> is used to save critical ext2 file system
  86. data to a file.</para>
  87. <indexterm zone="ch-system-e2fsprogs e2label"><primary sortas="b-e2label">e2label</primary></indexterm>
  88. <para id="e2label"><command>e2label</command> will display or change the file system
  89. label on the ext2 file system present on a given device.</para>
  90. <indexterm zone="ch-system-e2fsprogs findfs"><primary sortas="b-findfs">findfs</primary></indexterm>
  91. <para id="findfs"><command>findfs</command> finds a file system by label or UUID (Universally Unique Identifier).</para>
  92. <indexterm zone="ch-system-e2fsprogs fsck"><primary sortas="b-fsck">fsck</primary></indexterm>
  93. <para id="fsck"><command>fsck</command> is used to check, and optionally repair,
  94. file systems. By default it checks the file systems listed in
  95. <filename>/etc/fstab</filename></para>
  96. <indexterm zone="ch-system-e2fsprogs logsave"><primary sortas="b-logsave">logsave</primary></indexterm>
  97. <para id="logsave"><command>logsave</command> saves the output of a command in a log file.</para>
  98. <indexterm zone="ch-system-e2fsprogs lsattr"><primary sortas="b-lsattr">lsattr</primary></indexterm>
  99. <para id="lsattr"><command>lsattr</command> lists the attributes of files on a second
  100. extended file system.</para>
  101. <indexterm zone="ch-system-e2fsprogs mk_cmds"><primary sortas="b-mk_cmds">mk_cmds</primary></indexterm>
  102. <para id="mk_cmds"><command>mk_cmds</command> converts a table of command names
  103. and help messages into a C source file suitable for use with the
  104. <filename>libss</filename> subsystem library.</para>
  105. <indexterm zone="ch-system-e2fsprogs mke2fs"><primary sortas="b-mke2fs">mke2fs</primary></indexterm>
  106. <para id="mke2fs"><command>mke2fs</command> is used to create a second extended
  107. file system on the given device.</para>
  108. <indexterm zone="ch-system-e2fsprogs mklost-found"><primary sortas="b-mklost+found">mklost+found</primary></indexterm>
  109. <para id="mklost-found"><command>mklost+found</command> is used to create a
  110. <filename>lost+found</filename> directory on a second extended file system.
  111. It pre-allocates disk blocks to this directory to lighten the task of e2fsck.</para>
  112. <indexterm zone="ch-system-e2fsprogs resize2fs"><primary sortas="b-resize2fs">resize2fs</primary></indexterm>
  113. <para id="resize2fs"><command>resize2fs</command> can be used to enlarge or shrink an
  114. ext2 file system.</para>
  115. <indexterm zone="ch-system-e2fsprogs tune2fs"><primary sortas="b-tune2fs">tune2fs</primary></indexterm>
  116. <para id="tune2fs"><command>tune2fs</command> is used adjust tunable file system
  117. parameters on a second extended file system.</para>
  118. <indexterm zone="ch-system-e2fsprogs uuidgen"><primary sortas="b-uuidgen">uuidgen</primary></indexterm>
  119. <para id="uuidgen"><command>uuidgen</command> creates new
  120. UUID. Each new UUID can reasonably be considered unique
  121. among all UUIDs created, on the local system and on other systems, in the
  122. past and in the future.</para>
  123. <indexterm zone="ch-system-e2fsprogs libblkid"><primary sortas="c-libblkid">libblkid</primary></indexterm>
  124. <para id="libblkid"><command>libblkid</command> contains routines for device
  125. identification and token extraction.</para>
  126. <indexterm zone="ch-system-e2fsprogs libcom_err"><primary sortas="c-libcom_err">libcom_err</primary></indexterm>
  127. <para id="libcom_err"><command>libcom_err</command> is the common error display routine.</para>
  128. <indexterm zone="ch-system-e2fsprogs libe2p"><primary sortas="c-libe2p">libe2p</primary></indexterm>
  129. <para id="libe2p"><command>libe2p</command> is used by dumpe2fs, chattr, and lsattr.</para>
  130. <indexterm zone="ch-system-e2fsprogs libext2fs"><primary sortas="c-libext2fs">libext2fs</primary></indexterm>
  131. <para id="libext2fs"><command>libext2fs</command> contains routines to enable user-level
  132. programs to manipulate an ext2 file system.</para>
  133. <indexterm zone="ch-system-e2fsprogs libss"><primary sortas="c-libss">libss</primary></indexterm>
  134. <para id="libss"><command>libss</command> is used by debugfs.</para>
  135. <indexterm zone="ch-system-e2fsprogs libuuid"><primary sortas="c-libuuid">libuuid</primary></indexterm>
  136. <para id="libuuid"><command>libuuid</command> contains routines for generating unique
  137. identifiers for objects that may be accessible beyond the local system.</para>
  138. </sect2>
  139. </sect1>