e2fsprogs.xml 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  3. <!ENTITY % general-entities SYSTEM "../general.ent">
  4. %general-entities;
  5. ]>
  6. <sect1 id="ch-system-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
  12. <systemitem class="filesystem">ext2</systemitem> file system. It also supports
  13. the <systemitem class="filesystem">ext3</systemitem> journaling file system.</para>
  14. <segmentedlist>
  15. <segtitle>&buildtime;</segtitle>
  16. <segtitle>&diskspace;</segtitle>
  17. <seglistitem><seg>0.6 SBU</seg><seg>40.0 MB</seg></seglistitem>
  18. </segmentedlist>
  19. <segmentedlist>
  20. <segtitle>&dependencies;</segtitle>
  21. <seglistitem><seg>Bash, Binutils, Coreutils,
  22. Diffutils, Gawk, GCC, Gettext, Glibc, Grep, Make, Sed, and Texinfo</seg></seglistitem>
  23. </segmentedlist>
  24. </sect2>
  25. <sect2 role="installation">
  26. <title>Installation of E2fsprogs</title>
  27. <para>It is recommended that E2fsprogs be built in a subdirectory of the source tree:
  28. </para>
  29. <screen><userinput>mkdir -v build
  30. cd build</userinput></screen>
  31. <para>Prepare E2fsprogs for compilation:</para>
  32. <screen><userinput>../configure --prefix=/usr --with-root-prefix="" \
  33. --enable-elf-shlibs --disable-evms</userinput></screen>
  34. <para>The meaning of the configure options:</para>
  35. <variablelist>
  36. <varlistentry>
  37. <term><parameter>--with-root-prefix=""</parameter></term>
  38. <listitem><para>Certain programs (such as the <command>e2fsck</command> program)
  39. are considered essential programs. When, for example, <filename
  40. class="directory">/usr</filename> is not mounted, these programs still need
  41. to be available. They belong in directories like <filename
  42. class="directory">/lib</filename> and <filename
  43. class="directory">/sbin</filename>. If this option is not passed to E2fsprogs'
  44. configure, the programs are installed into the <filename
  45. class="directory">/usr</filename> directory.</para></listitem>
  46. </varlistentry>
  47. <varlistentry>
  48. <term><parameter>--enable-elf-shlibs</parameter></term>
  49. <listitem><para>This creates the shared libraries which some programs
  50. in this package use.</para></listitem>
  51. </varlistentry>
  52. <varlistentry>
  53. <term><parameter>--disable-evms</parameter></term>
  54. <listitem><para>This disables the building of the Enterprise Volume
  55. Management System (EVMS) plugin. This plugin is not up-to-date with
  56. the latest EVMS internal interfaces and EVMS is not installed as part
  57. of a base LFS system, so the plugin is not required. See the EVMS
  58. website at <ulink url="http://evms.sourceforge.net/"/> for more
  59. information regarding EVMS.</para></listitem>
  60. </varlistentry>
  61. </variablelist>
  62. <para>Compile the package:</para>
  63. <screen><userinput>make</userinput></screen>
  64. <para>To test the results, issue:
  65. <userinput>make check</userinput>.</para>
  66. <para>Install the binaries and documentation:</para>
  67. <screen><userinput>make install</userinput></screen>
  68. <para>Install the shared libraries:</para>
  69. <screen><userinput>make install-libs</userinput></screen>
  70. </sect2>
  71. <sect2 id="contents-e2fsprogs" role="content"><title>Contents of E2fsprogs</title>
  72. <segmentedlist>
  73. <segtitle>Installed programs</segtitle>
  74. <segtitle>Installed libraries</segtitle>
  75. <seglistitem><seg>badblocks, blkid, chattr,
  76. compile_et, debugfs, dumpe2fs, e2fsck, e2image, e2label, findfs, fsck,
  77. fsck.ext2, fsck.ext3, logsave, lsattr, mk_cmds, mke2fs, mkfs.ext2, mkfs.ext3,
  78. mklost+found, resize2fs, tune2fs, and uuidgen.</seg>
  79. <seg>libblkid.[a,so], libcom_err.[a,so], libe2p.[a,so],
  80. libext2fs.[a,so], libss.[a,so], and libuuid.[a,so]</seg></seglistitem>
  81. </segmentedlist>
  82. <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
  83. <?dbfo list-presentation="list"?>
  84. <?dbhtml list-presentation="table"?>
  85. <varlistentry id="badblocks">
  86. <term><command>badblocks</command></term>
  87. <listitem>
  88. <para>Searches a device (usually a disk partition) for bad blocks</para>
  89. <indexterm zone="ch-system-e2fsprogs badblocks"><primary sortas="b-badblocks">badblocks</primary></indexterm>
  90. </listitem>
  91. </varlistentry>
  92. <varlistentry id="blkid">
  93. <term><command>blkid</command></term>
  94. <listitem>
  95. <para>A command line utility to locate and print block device attributes</para>
  96. <indexterm zone="ch-system-e2fsprogs blkid"><primary sortas="b-blkid">blkid</primary></indexterm>
  97. </listitem>
  98. </varlistentry>
  99. <varlistentry id="chattr">
  100. <term><command>chattr</command></term>
  101. <listitem>
  102. <para>Changes the attributes of files on an <systemitem
  103. class="filesystem">ext2</systemitem> file system; it also changes <systemitem
  104. class="filesystem">ext3</systemitem> file systems, the journaling version of
  105. <systemitem class="filesystem">ext2</systemitem> file systems</para>
  106. <indexterm zone="ch-system-e2fsprogs chattr"><primary sortas="b-chattr">chattr</primary></indexterm>
  107. </listitem>
  108. </varlistentry>
  109. <varlistentry id="compile_et">
  110. <term><command>compile_et</command></term>
  111. <listitem>
  112. <para>An error table compiler; it converts a table of error-code names and
  113. messages into a C source file suitable for use with the <filename
  114. class="libraryfile">com_err</filename> library</para>
  115. <indexterm zone="ch-system-e2fsprogs compile_et"><primary sortas="b-compile_et">compile_et</primary></indexterm>
  116. </listitem>
  117. </varlistentry>
  118. <varlistentry id="debugfs">
  119. <term><command>debugfs</command></term>
  120. <listitem>
  121. <para>A file system debugger; it can be used to examine and change the
  122. state of an <systemitem class="filesystem">ext2</systemitem> file system</para>
  123. <indexterm zone="ch-system-e2fsprogs debugfs"><primary sortas="b-debugfs">debugfs</primary></indexterm>
  124. </listitem>
  125. </varlistentry>
  126. <varlistentry id="dumpe2fs">
  127. <term><command>dumpe2fs</command></term>
  128. <listitem>
  129. <para>Prints the super block and blocks group information for the file
  130. system present on a given device</para>
  131. <indexterm zone="ch-system-e2fsprogs dumpe2fs"><primary sortas="b-dumpe2fs">dumpe2fs</primary></indexterm>
  132. </listitem>
  133. </varlistentry>
  134. <varlistentry id="e2fsck">
  135. <term><command>e2fsck</command></term>
  136. <listitem>
  137. <para>Is used to check, and optionally repair <systemitem
  138. class="filesystem">ext2</systemitem> file systems and <systemitem
  139. class="filesystem">ext3</systemitem> file systems</para>
  140. <indexterm zone="ch-system-e2fsprogs e2fsck"><primary sortas="b-e2fsck">e2fsck</primary></indexterm>
  141. </listitem>
  142. </varlistentry>
  143. <varlistentry id="e2image">
  144. <term><command>e2image</command></term>
  145. <listitem>
  146. <para>Is used to save critical <systemitem class="filesystem">ext2</systemitem>
  147. file system data to a file</para>
  148. <indexterm zone="ch-system-e2fsprogs e2image"><primary sortas="b-e2image">e2image</primary></indexterm>
  149. </listitem>
  150. </varlistentry>
  151. <varlistentry id="e2label">
  152. <term><command>e2label</command></term>
  153. <listitem>
  154. <para>Displays or changes the file system label on the <systemitem
  155. class="filesystem">ext2</systemitem> file system present on a given device</para>
  156. <indexterm zone="ch-system-e2fsprogs e2label"><primary sortas="b-e2label">e2label</primary></indexterm>
  157. </listitem>
  158. </varlistentry>
  159. <varlistentry id="findfs">
  160. <term><command>findfs</command></term>
  161. <listitem>
  162. <para>Finds a file system by label or Universally Unique Identifier (UUID)</para>
  163. <indexterm zone="ch-system-e2fsprogs findfs"><primary sortas="b-findfs">findfs</primary></indexterm>
  164. </listitem>
  165. </varlistentry>
  166. <varlistentry id="fsck">
  167. <term><command>fsck</command></term>
  168. <listitem>
  169. <para>Is used to check, and optionally repair, file systems</para>
  170. <indexterm zone="ch-system-e2fsprogs fsck"><primary sortas="b-fsck">fsck</primary></indexterm>
  171. </listitem>
  172. </varlistentry>
  173. <varlistentry id="fsck.ext2">
  174. <term><command>fsck.ext2</command></term>
  175. <listitem>
  176. <para>By default checks <systemitem class="filesystem">ext2</systemitem>
  177. file systems</para>
  178. <indexterm zone="ch-system-e2fsprogs fsck.ext2"><primary
  179. sortas="b-fsck.ext2">fsck.ext2</primary></indexterm>
  180. </listitem>
  181. </varlistentry>
  182. <varlistentry id="fsck.ext3">
  183. <term><command>fsck.ext3</command></term>
  184. <listitem>
  185. <para>By default checks <systemitem class="filesystem">ext3</systemitem>
  186. file systems</para>
  187. <indexterm zone="ch-system-e2fsprogs fsck.ext3"><primary
  188. sortas="b-fsck.ext3">fsck.ext3</primary></indexterm>
  189. </listitem>
  190. </varlistentry>
  191. <varlistentry id="logsave">
  192. <term><command>logsave</command></term>
  193. <listitem>
  194. <para>Saves the output of a command in a log file</para>
  195. <indexterm zone="ch-system-e2fsprogs logsave"><primary sortas="b-logsave">logsave</primary></indexterm>
  196. </listitem>
  197. </varlistentry>
  198. <varlistentry id="lsattr">
  199. <term><command>lsattr</command></term>
  200. <listitem>
  201. <para>Lists the attributes of files on a second extended file system</para>
  202. <indexterm zone="ch-system-e2fsprogs lsattr"><primary sortas="b-lsattr">lsattr</primary></indexterm>
  203. </listitem>
  204. </varlistentry>
  205. <varlistentry id="mk_cmds">
  206. <term><command>mk_cmds</command></term>
  207. <listitem>
  208. <para>Converts a table of command names and help messages into a C
  209. source file suitable for use with the <filename
  210. class="libraryfile">libss</filename> subsystem library</para>
  211. <indexterm zone="ch-system-e2fsprogs mk_cmds"><primary sortas="b-mk_cmds">mk_cmds</primary></indexterm>
  212. </listitem>
  213. </varlistentry>
  214. <varlistentry id="mke2fs">
  215. <term><command>mke2fs</command></term>
  216. <listitem>
  217. <para>Creates an ext2 or ext3 file system on the given device</para>
  218. <indexterm zone="ch-system-e2fsprogs mke2fs"><primary sortas="b-mke2fs">mke2fs</primary></indexterm>
  219. </listitem>
  220. </varlistentry>
  221. <varlistentry id="mkfs.ext2">
  222. <term><command>mkfs.ext2</command></term>
  223. <listitem>
  224. <para>By default creates <systemitem class="filesystem">ext2</systemitem>
  225. file systems</para>
  226. <indexterm zone="ch-system-e2fsprogs mkfs.ext2"><primary
  227. sortas="b-mkfs.ext2">mkfs.ext2</primary></indexterm>
  228. </listitem>
  229. </varlistentry>
  230. <varlistentry id="mkfs.ext3">
  231. <term><command>mkfs.ext3</command></term>
  232. <listitem>
  233. <para>By default creates <systemitem class="filesystem">ext3</systemitem>
  234. file systems</para>
  235. <indexterm zone="ch-system-e2fsprogs mkfs.ext3"><primary
  236. sortas="b-mkfs.ext3">mkfs.ext3</primary></indexterm>
  237. </listitem>
  238. </varlistentry>
  239. <varlistentry id="mklost-found">
  240. <term><command>mklost+found</command></term>
  241. <listitem>
  242. <para>Used to create a <filename class="directory">lost+found</filename>
  243. directory on an <systemitem class="filesystem">ext2</systemitem> file system;
  244. it pre-allocates disk blocks to this directory to lighten the task of
  245. <command>e2fsck</command></para>
  246. <indexterm zone="ch-system-e2fsprogs mklost-found"><primary sortas="b-mklost+found">mklost+found</primary></indexterm>
  247. </listitem>
  248. </varlistentry>
  249. <varlistentry id="resize2fs">
  250. <term><command>resize2fs</command></term>
  251. <listitem>
  252. <para>Can be used to enlarge or shrink an <systemitem
  253. class="filesystem">ext2</systemitem> file system</para>
  254. <indexterm zone="ch-system-e2fsprogs resize2fs"><primary sortas="b-resize2fs">resize2fs</primary></indexterm>
  255. </listitem>
  256. </varlistentry>
  257. <varlistentry id="tune2fs">
  258. <term><command>tune2fs</command></term>
  259. <listitem>
  260. <para>Adjusts tunable file system parameters on an <systemitem
  261. class="filesystem">ext2</systemitem> file system</para>
  262. <indexterm zone="ch-system-e2fsprogs tune2fs"><primary sortas="b-tune2fs">tune2fs</primary></indexterm>
  263. </listitem>
  264. </varlistentry>
  265. <varlistentry id="uuidgen">
  266. <term><command>uuidgen</command></term>
  267. <listitem>
  268. <para>Creates new UUIDs. Each new UUID can reasonably be considered unique
  269. among all UUIDs created, on the local system and on other systems, in the
  270. past and in the future</para>
  271. <indexterm zone="ch-system-e2fsprogs uuidgen"><primary sortas="b-uuidgen">uuidgen</primary></indexterm>
  272. </listitem>
  273. </varlistentry>
  274. <varlistentry id="libblkid">
  275. <term><filename class="libraryfile">libblkid</filename></term>
  276. <listitem>
  277. <para>Contains routines for device identification and token extraction</para>
  278. <indexterm zone="ch-system-e2fsprogs libblkid"><primary sortas="c-libblkid">libblkid</primary></indexterm>
  279. </listitem>
  280. </varlistentry>
  281. <varlistentry id="libcom_err">
  282. <term><filename class="libraryfile">libcom_err</filename></term>
  283. <listitem>
  284. <para>The common error display routine</para>
  285. <indexterm zone="ch-system-e2fsprogs libcom_err"><primary sortas="c-libcom_err">libcom_err</primary></indexterm>
  286. </listitem>
  287. </varlistentry>
  288. <varlistentry id="libe2p">
  289. <term><filename class="libraryfile">libe2p</filename></term>
  290. <listitem>
  291. <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
  292. and <command>lsattr</command></para>
  293. <indexterm zone="ch-system-e2fsprogs libe2p"><primary sortas="c-libe2p">libe2p</primary></indexterm>
  294. </listitem>
  295. </varlistentry>
  296. <varlistentry id="libext2fs">
  297. <term><filename class="libraryfile">libext2fs</filename></term>
  298. <listitem>
  299. <para>Contains routines to enable user-level programs to manipulate an
  300. <systemitem class="filesystem">ext2</systemitem> file system</para>
  301. <indexterm zone="ch-system-e2fsprogs libext2fs"><primary sortas="c-libext2fs">libext2fs</primary></indexterm>
  302. </listitem>
  303. </varlistentry>
  304. <varlistentry id="libss">
  305. <term><filename class="libraryfile">libss</filename></term>
  306. <listitem>
  307. <para>Used by <command>debugfs</command></para>
  308. <indexterm zone="ch-system-e2fsprogs libss"><primary sortas="c-libss">libss</primary></indexterm>
  309. </listitem>
  310. </varlistentry>
  311. <varlistentry id="libuuid">
  312. <term><filename class="libraryfile">libuuid</filename></term>
  313. <listitem>
  314. <para>Contains routines for generating unique identifiers for objects
  315. that may be accessible beyond the local system</para>
  316. <indexterm zone="ch-system-e2fsprogs libuuid"><primary sortas="c-libuuid">libuuid</primary></indexterm>
  317. </listitem>
  318. </varlistentry>
  319. </variablelist>
  320. </sect2>
  321. </sect1>