e2fsprogs.xml 17 KB

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