e2fsprogs.xml 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555
  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. <sect1 id="ch-system-e2fsprogs" role="wrap">
  8. <?dbhtml filename="e2fsprogs.html"?>
  9. <sect1info condition="script">
  10. <productname>e2fsprogs</productname>
  11. <productnumber>&e2fsprogs-version;</productnumber>
  12. <address>&e2fsprogs-url;</address>
  13. </sect1info>
  14. <title>E2fsprogs-&e2fsprogs-version;</title>
  15. <indexterm zone="ch-system-e2fsprogs">
  16. <primary sortas="a-E2fsprogs">E2fsprogs</primary>
  17. </indexterm>
  18. <sect2 role="package">
  19. <title/>
  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. <segmentedlist>
  26. <segtitle>&buildtime;</segtitle>
  27. <segtitle>&diskspace;</segtitle>
  28. <seglistitem>
  29. <seg>&e2fsprogs-ch6-sbu;</seg>
  30. <seg>&e2fsprogs-ch6-du;</seg>
  31. </seglistitem>
  32. </segmentedlist>
  33. </sect2>
  34. <sect2 role="installation">
  35. <title>Installation of E2fsprogs</title>
  36. <para>The E2fsprogs documentation recommends that the package be built in
  37. a subdirectory of the source tree: </para>
  38. <screen><userinput remap="pre">mkdir -v build
  39. cd build</userinput></screen>
  40. <para>Prepare E2fsprogs for compilation:</para>
  41. <screen><userinput remap="configure">../configure --prefix=/usr \
  42. --with-root-prefix="" \
  43. --enable-elf-shlibs \
  44. --disable-libblkid \
  45. --disable-libuuid \
  46. --disable-uuidd \
  47. --disable-fsck</userinput></screen>
  48. <variablelist>
  49. <title>The meaning of the configure options:</title>
  50. <!--
  51. <varlistentry>
  52. <term><parameter>PKG_CONFIG...</parameter></term>
  53. <listitem>
  54. <para>This enables E2fsprogs to be built without requiring Pkg-config
  55. to be built and installed first.</para>
  56. </listitem>
  57. </varlistentry>
  58. -->
  59. <varlistentry>
  60. <term><parameter>--with-root-prefix=""</parameter></term>
  61. <listitem>
  62. <para>Certain programs (such as the <command>e2fsck</command>
  63. program) are considered essential programs. When, for example,
  64. <filename class="directory">/usr</filename> is not mounted, these
  65. programs still need to be available. They belong in directories
  66. like <filename class="directory">/lib</filename> and <filename
  67. class="directory">/sbin</filename>. If this option is not passed
  68. to E2fsprogs' configure, the programs are installed into the
  69. <filename class="directory">/usr</filename> directory.</para>
  70. </listitem>
  71. </varlistentry>
  72. <varlistentry>
  73. <term><parameter>--enable-elf-shlibs</parameter></term>
  74. <listitem>
  75. <para>This creates the shared libraries which some programs
  76. in this package use.</para>
  77. </listitem>
  78. </varlistentry>
  79. <varlistentry>
  80. <term><parameter>--disable-*</parameter></term>
  81. <listitem>
  82. <para>This prevents E2fsprogs from building and installing the
  83. <systemitem class="library">libuuid</systemitem> and
  84. <systemitem class="library">libblkid</systemitem> libraries, the
  85. <systemitem class="daemon">uuidd</systemitem> daemon, and the
  86. <command>fsck</command> wrapper, as Util-Linux installed all of
  87. them earlier.</para>
  88. </listitem>
  89. </varlistentry>
  90. </variablelist>
  91. <para>Compile the package:</para>
  92. <screen><userinput remap="make">make</userinput></screen>
  93. <para>To test the results, issue:</para>
  94. <screen><userinput remap="test">make -k check</userinput></screen>
  95. <para>One of the E2fsprogs tests will attempt to allocate 256 MB
  96. of memory. If you do not have significantly more RAM than this, it
  97. is recommended to enable sufficient swap space for the test. See
  98. <xref linkend="space-creatingfilesystem"/> and
  99. <xref linkend="space-mounting"/> for details on creating and enabling
  100. swap space.</para>
  101. <para>Install the binaries, documentation, and shared libraries:</para>
  102. <screen><userinput remap="install">make install</userinput></screen>
  103. <para>Install the static libraries and headers:</para>
  104. <screen><userinput remap="install">make install-libs</userinput></screen>
  105. <para>Make the installed static libraries writable so debugging symbols can
  106. be removed later:</para>
  107. <screen><userinput remap="install">chmod -v u+w /usr/lib/{libcom_err,libe2p,libext2fs,libss}.a</userinput></screen>
  108. <para>This package installs a gzipped
  109. <filename class="extension">.info</filename> file but doesn't update the
  110. system-wide <filename>dir</filename> file. Unzip this file and then update
  111. the system <filename>dir</filename> file using the following
  112. commands.</para>
  113. <screen><userinput remap="install">gunzip -v /usr/share/info/libext2fs.info.gz
  114. install-info --dir-file=/usr/share/info/dir /usr/share/info/libext2fs.info</userinput></screen>
  115. <para>If desired, create and install some additional documentation by
  116. issuing the following commands:</para>
  117. <screen><userinput remap="install">makeinfo -o doc/com_err.info ../lib/et/com_err.texinfo
  118. install -v -m644 doc/com_err.info /usr/share/info
  119. install-info --dir-file=/usr/share/info/dir /usr/share/info/com_err.info</userinput></screen>
  120. </sect2>
  121. <sect2 id="contents-e2fsprogs" role="content">
  122. <title>Contents of E2fsprogs</title>
  123. <segmentedlist>
  124. <segtitle>Installed programs</segtitle>
  125. <segtitle>Installed libraries</segtitle>
  126. <segtitle>Installed directory</segtitle>
  127. <seglistitem>
  128. <seg>badblocks, chattr, compile_et, debugfs, dumpe2fs, e2freefrag,
  129. e2fsck, e2image, e2initrd_helper, e2label, e2undo, e4defrag, filefrag, fsck.ext2,
  130. fsck.ext3, fsck.ext4, fsck.ext4dev, logsave, lsattr, mk_cmds, mke2fs,
  131. mkfs.ext2, mkfs.ext3, mkfs.ext4, mkfs.ext4dev, mklost+found,
  132. resize2fs, and tune2fs</seg>
  133. <seg>libcom_err.{a,so}, libe2p.{a,so}, libext2fs.{a,so},
  134. libquota.a and libss.{a,so}</seg>
  135. <seg>/usr/include/e2p, /usr/include/et, /usr/include/ext2fs,
  136. /usr/include/quota, /usr/include/ss, /usr/share/et, /usr/share/ss</seg>
  137. </seglistitem>
  138. </segmentedlist>
  139. <variablelist>
  140. <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  141. <?dbfo list-presentation="list"?>
  142. <?dbhtml list-presentation="table"?>
  143. <varlistentry id="badblocks">
  144. <term><command>badblocks</command></term>
  145. <listitem>
  146. <para>Searches a device (usually a disk partition) for bad
  147. blocks</para>
  148. <indexterm zone="ch-system-e2fsprogs badblocks">
  149. <primary sortas="b-badblocks">badblocks</primary>
  150. </indexterm>
  151. </listitem>
  152. </varlistentry>
  153. <varlistentry id="chattr">
  154. <term><command>chattr</command></term>
  155. <listitem>
  156. <para>Changes the attributes of files on an <systemitem
  157. class="filesystem">ext2</systemitem> file system; it also
  158. changes <systemitem class="filesystem">ext3</systemitem>
  159. file systems, the journaling version of <systemitem
  160. class="filesystem">ext2</systemitem> file systems</para>
  161. <indexterm zone="ch-system-e2fsprogs chattr">
  162. <primary sortas="b-chattr">chattr</primary>
  163. </indexterm>
  164. </listitem>
  165. </varlistentry>
  166. <varlistentry id="compile_et">
  167. <term><command>compile_et</command></term>
  168. <listitem>
  169. <para>An error table compiler; it converts a table of error-code
  170. names and messages into a C source file suitable for use with the
  171. <filename class="libraryfile">com_err</filename> library</para>
  172. <indexterm zone="ch-system-e2fsprogs compile_et">
  173. <primary sortas="b-compile_et">compile_et</primary>
  174. </indexterm>
  175. </listitem>
  176. </varlistentry>
  177. <varlistentry id="debugfs">
  178. <term><command>debugfs</command></term>
  179. <listitem>
  180. <para>A file system debugger; it can be used to examine and change
  181. the state of an <systemitem class="filesystem">ext2</systemitem>
  182. file system</para>
  183. <indexterm zone="ch-system-e2fsprogs debugfs">
  184. <primary sortas="b-debugfs">debugfs</primary>
  185. </indexterm>
  186. </listitem>
  187. </varlistentry>
  188. <varlistentry id="dumpe2fs">
  189. <term><command>dumpe2fs</command></term>
  190. <listitem>
  191. <para>Prints the super block and blocks group information for the
  192. file system present on a given device</para>
  193. <indexterm zone="ch-system-e2fsprogs dumpe2fs">
  194. <primary sortas="b-dumpe2fs">dumpe2fs</primary>
  195. </indexterm>
  196. </listitem>
  197. </varlistentry>
  198. <varlistentry id="e2freefrag">
  199. <term><command>e2freefrag</command></term>
  200. <listitem>
  201. <para> Reports free space fragmentation information</para>
  202. <indexterm zone="ch-system-e2fsprogs e2freefrag">
  203. <primary sortas="b-e2freefrag">e2freefrag</primary>
  204. </indexterm>
  205. </listitem>
  206. </varlistentry>
  207. <varlistentry id="e2fsck">
  208. <term><command>e2fsck</command></term>
  209. <listitem>
  210. <para>Is used to check, and optionally repair <systemitem
  211. class="filesystem">ext2</systemitem> file systems and <systemitem
  212. class="filesystem">ext3</systemitem> file systems</para>
  213. <indexterm zone="ch-system-e2fsprogs e2fsck">
  214. <primary sortas="b-e2fsck">e2fsck</primary>
  215. </indexterm>
  216. </listitem>
  217. </varlistentry>
  218. <varlistentry id="e2image">
  219. <term><command>e2image</command></term>
  220. <listitem>
  221. <para>Is used to save critical <systemitem
  222. class="filesystem">ext2</systemitem> file system data to a file</para>
  223. <indexterm zone="ch-system-e2fsprogs e2image">
  224. <primary sortas="b-e2image">e2image</primary>
  225. </indexterm>
  226. </listitem>
  227. </varlistentry>
  228. <varlistentry id="e2initrd_helper">
  229. <term><command>e2initrd_helper</command></term>
  230. <listitem>
  231. <para>Prints the FS type of a given filesystem, given either a
  232. device name or label</para>
  233. <indexterm zone="ch-system-e2fsprogs e2initrd_helper">
  234. <primary sortas="b-e2initrd_helper">e2initrd_helper</primary>
  235. </indexterm>
  236. </listitem>
  237. </varlistentry>
  238. <varlistentry id="e2label">
  239. <term><command>e2label</command></term>
  240. <listitem>
  241. <para>Displays or changes the file system label on the <systemitem
  242. class="filesystem">ext2</systemitem> file system present on a given
  243. device</para>
  244. <indexterm zone="ch-system-e2fsprogs e2label">
  245. <primary sortas="b-e2label">e2label</primary>
  246. </indexterm>
  247. </listitem>
  248. </varlistentry>
  249. <varlistentry id="e2undo">
  250. <term><command>e2undo</command></term>
  251. <listitem>
  252. <para>Replays the undo log undo_log for an ext2/ext3/ext4 filesystem
  253. found on a device. This can be used to undo a failed operation by an
  254. e2fsprogs program.</para>
  255. <indexterm zone="ch-system-e2fsprogs e2undo">
  256. <primary sortas="b-e2undo">e2undo</primary>
  257. </indexterm>
  258. </listitem>
  259. </varlistentry>
  260. <varlistentry id="e4defrag">
  261. <term><command>e4defrag</command></term>
  262. <listitem>
  263. <para>Online defragmenter for ext4 filesystems</para>
  264. <indexterm zone="ch-system-e2fsprogs e4defrag">
  265. <primary sortas="b-e4defrag">e4defrag</primary>
  266. </indexterm>
  267. </listitem>
  268. </varlistentry>
  269. <varlistentry id="filefrag">
  270. <term><command>filefrag</command></term>
  271. <listitem>
  272. <para>Reports on how badly fragmented a particular file might be</para>
  273. <indexterm zone="ch-system-e2fsprogs filefrag">
  274. <primary sortas="b-filefrag">filefrag</primary>
  275. </indexterm>
  276. </listitem>
  277. </varlistentry>
  278. <varlistentry id="fsck.ext2">
  279. <term><command>fsck.ext2</command></term>
  280. <listitem>
  281. <para>By default checks <systemitem class="filesystem">ext2</systemitem>
  282. file systems. This is a hard link to <command>e2fsck</command>.</para>
  283. <indexterm zone="ch-system-e2fsprogs fsck.ext2">
  284. <primary sortas="b-fsck.ext2">fsck.ext2</primary>
  285. </indexterm>
  286. </listitem>
  287. </varlistentry>
  288. <varlistentry id="fsck.ext3">
  289. <term><command>fsck.ext3</command></term>
  290. <listitem>
  291. <para>By default checks <systemitem class="filesystem">ext3</systemitem>
  292. file systems. This is a hard link to <command>e2fsck</command>.</para>
  293. <indexterm zone="ch-system-e2fsprogs fsck.ext3">
  294. <primary sortas="b-fsck.ext3">fsck.ext3</primary>
  295. </indexterm>
  296. </listitem>
  297. </varlistentry>
  298. <varlistentry id="fsck.ext4">
  299. <term><command>fsck.ext4</command></term>
  300. <listitem>
  301. <para>By default checks <systemitem class="filesystem">ext4</systemitem>
  302. file systems. This is a hard link to <command>e2fsck</command>.</para>
  303. <indexterm zone="ch-system-e2fsprogs fsck.ext4">
  304. <primary sortas="b-fsck.ext4">fsck.ext4</primary>
  305. </indexterm>
  306. </listitem>
  307. </varlistentry>
  308. <varlistentry id="fsck.ext4dev">
  309. <term><command>fsck.ext4dev</command></term>
  310. <listitem>
  311. <para>By default checks <systemitem class="filesystem">ext4</systemitem>
  312. development file systems. This is a hard link to
  313. <command>e2fsck</command>.</para>
  314. <indexterm zone="ch-system-e2fsprogs fsck.ext4dev">
  315. <primary sortas="b-fsck.ext4dev">fsck.ext4dev</primary>
  316. </indexterm>
  317. </listitem>
  318. </varlistentry>
  319. <varlistentry id="logsave">
  320. <term><command>logsave</command></term>
  321. <listitem>
  322. <para>Saves the output of a command in a log file</para>
  323. <indexterm zone="ch-system-e2fsprogs logsave">
  324. <primary sortas="b-logsave">logsave</primary>
  325. </indexterm>
  326. </listitem>
  327. </varlistentry>
  328. <varlistentry id="lsattr">
  329. <term><command>lsattr</command></term>
  330. <listitem>
  331. <para>Lists the attributes of files on a second extended file
  332. system</para>
  333. <indexterm zone="ch-system-e2fsprogs lsattr">
  334. <primary sortas="b-lsattr">lsattr</primary>
  335. </indexterm>
  336. </listitem>
  337. </varlistentry>
  338. <varlistentry id="mk_cmds">
  339. <term><command>mk_cmds</command></term>
  340. <listitem>
  341. <para>Converts a table of command names and help messages into a C
  342. source file suitable for use with the <filename
  343. class="libraryfile">libss</filename> subsystem library</para>
  344. <indexterm zone="ch-system-e2fsprogs mk_cmds">
  345. <primary sortas="b-mk_cmds">mk_cmds</primary>
  346. </indexterm>
  347. </listitem>
  348. </varlistentry>
  349. <varlistentry id="mke2fs">
  350. <term><command>mke2fs</command></term>
  351. <listitem>
  352. <para>Creates an <systemitem class="filesystem">ext2</systemitem>
  353. or <systemitem class="filesystem">ext3</systemitem> file system on
  354. the given device</para>
  355. <indexterm zone="ch-system-e2fsprogs mke2fs">
  356. <primary sortas="b-mke2fs">mke2fs</primary>
  357. </indexterm>
  358. </listitem>
  359. </varlistentry>
  360. <varlistentry id="mkfs.ext2">
  361. <term><command>mkfs.ext2</command></term>
  362. <listitem>
  363. <para>By default creates <systemitem class="filesystem">ext2</systemitem>
  364. file systems. This is a hard link to <command>mke2fs</command>.</para>
  365. <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
  366. <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
  367. </indexterm>
  368. </listitem>
  369. </varlistentry>
  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. This is a hard link to <command>mke2fs</command>.</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. <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. This is a hard link to <command>mke2fs</command>.</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. <varlistentry id="mkfs.ext4dev">
  391. <term><command>mkfs.ext4dev</command></term>
  392. <listitem>
  393. <para>By default creates <systemitem class="filesystem">ext4</systemitem>
  394. development file systems. This is a hard link to <command>mke2fs</command>.</para>
  395. <indexterm zone="ch-system-e2fsprogs mkfs.ext4dev">
  396. <primary sortas="b-mkfs.ext4dev">mkfs.ext4dev</primary>
  397. </indexterm>
  398. </listitem>
  399. </varlistentry>
  400. <varlistentry id="mklost-found">
  401. <term><command>mklost+found</command></term>
  402. <listitem>
  403. <para>Used to create a <filename class="directory">lost+found</filename>
  404. directory on an <systemitem class="filesystem">ext2</systemitem> file
  405. system; it pre-allocates disk blocks to this directory to lighten the
  406. task of <command>e2fsck</command></para>
  407. <indexterm zone="ch-system-e2fsprogs mklost-found">
  408. <primary sortas="b-mklost+found">mklost+found</primary>
  409. </indexterm>
  410. </listitem>
  411. </varlistentry>
  412. <varlistentry id="resize2fs">
  413. <term><command>resize2fs</command></term>
  414. <listitem>
  415. <para>Can be used to enlarge or shrink an <systemitem
  416. class="filesystem">ext2</systemitem> file system</para>
  417. <indexterm zone="ch-system-e2fsprogs resize2fs">
  418. <primary sortas="b-resize2fs">resize2fs</primary>
  419. </indexterm>
  420. </listitem>
  421. </varlistentry>
  422. <varlistentry id="tune2fs">
  423. <term><command>tune2fs</command></term>
  424. <listitem>
  425. <para>Adjusts tunable file system parameters on an <systemitem
  426. class="filesystem">ext2</systemitem> file system</para>
  427. <indexterm zone="ch-system-e2fsprogs tune2fs">
  428. <primary sortas="b-tune2fs">tune2fs</primary>
  429. </indexterm>
  430. </listitem>
  431. </varlistentry>
  432. <varlistentry id="libcom_err">
  433. <term><filename class="libraryfile">libcom_err</filename></term>
  434. <listitem>
  435. <para>The common error display routine</para>
  436. <indexterm zone="ch-system-e2fsprogs libcom_err">
  437. <primary sortas="c-libcom_err">libcom_err</primary>
  438. </indexterm>
  439. </listitem>
  440. </varlistentry>
  441. <varlistentry id="libe2p">
  442. <term><filename class="libraryfile">libe2p</filename></term>
  443. <listitem>
  444. <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
  445. and <command>lsattr</command></para>
  446. <indexterm zone="ch-system-e2fsprogs libe2p">
  447. <primary sortas="c-libe2p">libe2p</primary>
  448. </indexterm>
  449. </listitem>
  450. </varlistentry>
  451. <varlistentry id="libext2fs">
  452. <term><filename class="libraryfile">libext2fs</filename></term>
  453. <listitem>
  454. <para>Contains routines to enable user-level programs to manipulate an
  455. <systemitem class="filesystem">ext2</systemitem> file system</para>
  456. <indexterm zone="ch-system-e2fsprogs libext2fs">
  457. <primary sortas="c-libext2fs">libext2fs</primary>
  458. </indexterm>
  459. </listitem>
  460. </varlistentry>
  461. <varlistentry id="libquota">
  462. <term><filename class="libraryfile">libquota</filename></term>
  463. <listitem>
  464. <para>Provides an interface for creating and updating quota files
  465. and ext4 superblock fields</para>
  466. <indexterm zone="ch-system-e2fsprogs libquota">
  467. <primary sortas="c-libquota">libquota</primary>
  468. </indexterm>
  469. </listitem>
  470. </varlistentry>
  471. <varlistentry id="libss">
  472. <term><filename class="libraryfile">libss</filename></term>
  473. <listitem>
  474. <para>Used by <command>debugfs</command></para>
  475. <indexterm zone="ch-system-e2fsprogs libss">
  476. <primary sortas="c-libss">libss</primary>
  477. </indexterm>
  478. </listitem>
  479. </varlistentry>
  480. </variablelist>
  481. </sect2>
  482. </sect1>