e2fsprogs.xml 21 KB

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