[4122007] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[4122007] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
[b8fa16e] | 6 |
|
---|
[518cff0] | 7 | <!ENTITY xfsprogs-download-http " ">
|
---|
[a3c54ef2] | 8 | <!ENTITY xfsprogs-download-ftp "ftp://oss.sgi.com/projects/xfs/cmd_tars/xfsprogs-&xfsprogs-version;.tar.gz">
|
---|
[b8dff090] | 9 | <!ENTITY xfsprogs-md5sum "e1b9438d3e6775b9df52cc9a13e9f9a6">
|
---|
[518cff0] | 10 | <!ENTITY xfsprogs-size "1.5 MB">
|
---|
[b8dff090] | 11 | <!ENTITY xfsprogs-buildsize "62 MB">
|
---|
[d24742c] | 12 | <!ENTITY xfsprogs-time "0.5 SBU">
|
---|
[4122007] | 13 | ]>
|
---|
| 14 |
|
---|
[a3c54ef2] | 15 | <sect1 id="xfsprogs" xreflabel="xfsprogs-&xfsprogs-version;">
|
---|
| 16 | <?dbhtml filename="xfsprogs.html"?>
|
---|
[152fb77] | 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
[8bc3edae] | 23 | <title>xfsprogs-&xfsprogs-version;</title>
|
---|
[152fb77] | 24 |
|
---|
[a3c54ef2] | 25 | <indexterm zone="xfsprogs">
|
---|
| 26 | <primary sortas="a-xfsprogs">xfsprogs</primary>
|
---|
[152fb77] | 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
[8bc3edae] | 30 | <title>Introduction to xfsprogs</title>
|
---|
[152fb77] | 31 |
|
---|
[8bc3edae] | 32 | <para>The <application>xfsprogs</application> package contains administration
|
---|
[152fb77] | 33 | and debugging tools for the XFS file system.</para>
|
---|
| 34 |
|
---|
[f3429309] | 35 | &lfs78_checked;
|
---|
[8bc3edae] | 36 |
|
---|
[152fb77] | 37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 38 | <itemizedlist spacing="compact">
|
---|
| 39 | <listitem>
|
---|
| 40 | <para>Download (HTTP): <ulink url="&xfsprogs-download-http;"/></para>
|
---|
| 41 | </listitem>
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>Download (FTP): <ulink url="&xfsprogs-download-ftp;"/></para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>Download MD5 sum: &xfsprogs-md5sum;</para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>Download size: &xfsprogs-size;</para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>Estimated disk space required: &xfsprogs-buildsize;</para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>Estimated build time: &xfsprogs-time;</para>
|
---|
| 56 | </listitem>
|
---|
| 57 | </itemizedlist>
|
---|
| 58 |
|
---|
[3597eb6] | 59 | <para condition="html" role="usernotes">User Notes:
|
---|
| 60 | <ulink url="&blfs-wiki;/xfs"/></para>
|
---|
| 61 |
|
---|
[152fb77] | 62 | </sect2>
|
---|
| 63 |
|
---|
[a3c54ef2] | 64 | <sect2 role="kernel" id="xfsprogs-kernel">
|
---|
[d28198d3] | 65 | <title>Kernel Configuration</title>
|
---|
| 66 |
|
---|
| 67 | <para>Enable the following options in the kernel configuration
|
---|
| 68 | and recompile the kernel:</para>
|
---|
| 69 |
|
---|
[421128a1] | 70 | <screen><literal>File systems --->
|
---|
| 71 | <*/M> XFS filesystem support [CONFIG_XFS_FS]</literal></screen>
|
---|
[d28198d3] | 72 |
|
---|
[a3c54ef2] | 73 | <indexterm zone="xfsprogs xfsprogs-kernel">
|
---|
[d28198d3] | 74 | <primary sortas="d-xfs">XFS Programs</primary>
|
---|
| 75 | </indexterm>
|
---|
| 76 |
|
---|
| 77 | </sect2>
|
---|
| 78 |
|
---|
[152fb77] | 79 | <sect2 role="installation">
|
---|
[8bc3edae] | 80 | <title>Installation of xfsprogs</title>
|
---|
[152fb77] | 81 |
|
---|
[8bc3edae] | 82 | <para>Install <application>xfsprogs</application> by running the following
|
---|
[152fb77] | 83 | commands:</para>
|
---|
| 84 |
|
---|
[8c64b06] | 85 | <screen><userinput>make DEBUG=-DNDEBUG \
|
---|
| 86 | INSTALL_USER=root \
|
---|
| 87 | INSTALL_GROUP=root \
|
---|
[a3c54ef2] | 88 | LOCAL_CONFIGURE_OPTIONS="--enable-readline"</userinput></screen>
|
---|
[1ba83240] | 89 |
|
---|
| 90 | <para>This package does not come with a test suite.</para>
|
---|
[152fb77] | 91 |
|
---|
| 92 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 93 |
|
---|
[38fb1e3] | 94 | <screen role="root"><userinput>make PKG_DOC_DIR=/usr/share/doc/xfsprogs-&xfsprogs-version; install &&
|
---|
| 95 | make PKG_DOC_DIR=/usr/share/doc/xfsprogs-&xfsprogs-version; install-dev &&
|
---|
[a5416837] | 96 | rm -rfv /usr/lib/libhandle.a &&
|
---|
| 97 | rm -rfv /lib/libhandle.{a,la,so} &&
|
---|
| 98 | ln -sfv ../../lib/libhandle.so.1 /usr/lib/libhandle.so &&
|
---|
[d24742c] | 99 | sed -i "s@libdir='/lib@libdir='/usr/lib@" /usr/lib/libhandle.la</userinput></screen>
|
---|
[2da2e6a] | 100 |
|
---|
[152fb77] | 101 | </sect2>
|
---|
| 102 |
|
---|
[55329727] | 103 | <sect2 role="commands">
|
---|
| 104 | <title>Command Explanations</title>
|
---|
| 105 |
|
---|
[410e228b] | 106 | <para><command>make DEBUG=-DNDEBUG</command>: Turns off debugging
|
---|
[b160786] | 107 | symbols.</para>
|
---|
[2da2e6a] | 108 |
|
---|
[1ba83240] | 109 | <para><parameter>INSTALL_USER=root INSTALL_GROUP=root</parameter>: This
|
---|
| 110 | sets the owner and group of the installed files.</para>
|
---|
[864b24de] | 111 |
|
---|
[1ba83240] | 112 | <para><parameter>LOCAL_CONFIGURE_OPTIONS="..."</parameter>: This passes
|
---|
| 113 | extra configuration options to the <filename>configure</filename> script.
|
---|
[a3c54ef2] | 114 | The example <parameter>--enable-readline</parameter> parameter
|
---|
[1ba83240] | 115 | enables linking the XFS programs with the
|
---|
| 116 | <filename class="libraryfile">libreadline.so</filename> library, in order
|
---|
| 117 | to allow editing interactive commands.</para>
|
---|
[864b24de] | 118 |
|
---|
[2da2e6a] | 119 | <para><parameter>OPTIMIZER="..."</parameter>: Adding this parameter to
|
---|
[1ba83240] | 120 | the end of the <command>make</command> command overrides the
|
---|
| 121 | default optimization settings.</para>
|
---|
| 122 |
|
---|
[55329727] | 123 | </sect2>
|
---|
| 124 |
|
---|
[152fb77] | 125 | <sect2 role="content">
|
---|
| 126 | <title>Contents</title>
|
---|
| 127 |
|
---|
| 128 | <segmentedlist>
|
---|
| 129 | <segtitle>Installed Programs</segtitle>
|
---|
[1ba83240] | 130 | <segtitle>Installed Libraries</segtitle>
|
---|
[a3c54ef2] | 131 | <segtitle>Installed Directories</segtitle>
|
---|
[152fb77] | 132 |
|
---|
| 133 | <seglistitem>
|
---|
[518cff0] | 134 | <seg>fsck.xfs, mkfs.xfs, xfs_admin, xfs_bmap, xfs_copy, xfs_db,
|
---|
| 135 | xfs_estimate, xfs_freeze, xfs_fsr, xfs_growfs, xfs_info, xfs_io,
|
---|
| 136 | xfs_logprint, xfs_mdrestore, xfs_metadump, xfs_mkfile, xfs_ncheck,
|
---|
| 137 | xfs_quota, xfs_repair, and xfs_rtcp</seg>
|
---|
[a5416837] | 138 | <seg>libhandle.so</seg>
|
---|
[38fb1e3] | 139 | <seg>/usr/include/xfs and /usr/share/doc/xfsprogs-&xfsprogs-version;</seg>
|
---|
[152fb77] | 140 | </seglistitem>
|
---|
| 141 | </segmentedlist>
|
---|
| 142 |
|
---|
| 143 | <variablelist>
|
---|
| 144 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 145 | <?dbfo list-presentation="list"?>
|
---|
| 146 | <?dbhtml list-presentation="table"?>
|
---|
| 147 |
|
---|
| 148 | <varlistentry id="fsck.xfs">
|
---|
| 149 | <term><command>fsck.xfs</command></term>
|
---|
| 150 | <listitem>
|
---|
[99b1c520] | 151 | <para>simply exits with a zero status, since XFS
|
---|
[152fb77] | 152 | partitions are checked at mount time.</para>
|
---|
[a3c54ef2] | 153 | <indexterm zone="xfsprogs fsck.xfs">
|
---|
[152fb77] | 154 | <primary sortas="b-fsck.xfs">fsck.xfs</primary>
|
---|
| 155 | </indexterm>
|
---|
| 156 | </listitem>
|
---|
| 157 | </varlistentry>
|
---|
| 158 |
|
---|
| 159 | <varlistentry id="mkfs.xfs">
|
---|
| 160 | <term><command>mkfs.xfs</command></term>
|
---|
| 161 | <listitem>
|
---|
| 162 | <para>constructs an XFS file system.</para>
|
---|
[a3c54ef2] | 163 | <indexterm zone="xfsprogs mkfs.xfs">
|
---|
[152fb77] | 164 | <primary sortas="b-mkfs.xfs">mkfs.xfs</primary>
|
---|
| 165 | </indexterm>
|
---|
| 166 | </listitem>
|
---|
| 167 | </varlistentry>
|
---|
| 168 |
|
---|
| 169 | <varlistentry id="xfs_admin">
|
---|
| 170 | <term><command>xfs_admin</command></term>
|
---|
| 171 | <listitem>
|
---|
| 172 | <para>changes the parameters of an XFS file system.</para>
|
---|
[a3c54ef2] | 173 | <indexterm zone="xfsprogs xfs_admin">
|
---|
[152fb77] | 174 | <primary sortas="b-xfs_admin">xfs_admin</primary>
|
---|
| 175 | </indexterm>
|
---|
| 176 | </listitem>
|
---|
| 177 | </varlistentry>
|
---|
| 178 |
|
---|
| 179 | <varlistentry id="xfs_bmap">
|
---|
| 180 | <term><command>xfs_bmap</command></term>
|
---|
| 181 | <listitem>
|
---|
| 182 | <para>prints block mapping for an XFS file.</para>
|
---|
[a3c54ef2] | 183 | <indexterm zone="xfsprogs xfs_bmap">
|
---|
[152fb77] | 184 | <primary sortas="b-xfs_bmap">xfs_bmap</primary>
|
---|
| 185 | </indexterm>
|
---|
| 186 | </listitem>
|
---|
| 187 | </varlistentry>
|
---|
| 188 |
|
---|
| 189 | <varlistentry id="xfs_copy">
|
---|
| 190 | <term><command>xfs_copy</command></term>
|
---|
| 191 | <listitem>
|
---|
[99b1c520] | 192 | <para>copies the contents of an XFS file system
|
---|
[152fb77] | 193 | to one or more targets in parallel.</para>
|
---|
[a3c54ef2] | 194 | <indexterm zone="xfsprogs xfs_copy">
|
---|
[152fb77] | 195 | <primary sortas="b-xfs_copy">xfs_copy</primary>
|
---|
| 196 | </indexterm>
|
---|
| 197 | </listitem>
|
---|
| 198 | </varlistentry>
|
---|
| 199 |
|
---|
[518cff0] | 200 | <varlistentry id="xfs_estimate">
|
---|
| 201 | <term><command>xfs_estimate</command></term>
|
---|
| 202 | <listitem>
|
---|
| 203 | <para>for each directory argument, estimates the space that directory
|
---|
| 204 | would take if it were copied to an XFS filesystem
|
---|
| 205 | (does not cross mount points).</para>
|
---|
| 206 | <indexterm zone="xfsprogs xfs_estimate">
|
---|
| 207 | <primary sortas="b-xfs_estimate">xfs_estimate</primary>
|
---|
| 208 | </indexterm>
|
---|
| 209 | </listitem>
|
---|
| 210 | </varlistentry>
|
---|
| 211 |
|
---|
[152fb77] | 212 | <varlistentry id="xfs_db">
|
---|
| 213 | <term><command>xfs_db</command></term>
|
---|
| 214 | <listitem>
|
---|
| 215 | <para>is used to debug an XFS file system.</para>
|
---|
[a3c54ef2] | 216 | <indexterm zone="xfsprogs xfs_db">
|
---|
[152fb77] | 217 | <primary sortas="b-xfs_db">xfs_db</primary>
|
---|
| 218 | </indexterm>
|
---|
| 219 | </listitem>
|
---|
| 220 | </varlistentry>
|
---|
| 221 |
|
---|
| 222 | <varlistentry id="xfs_freeze">
|
---|
| 223 | <term><command>xfs_freeze</command></term>
|
---|
| 224 | <listitem>
|
---|
| 225 | <para>suspends access to an XFS file system.</para>
|
---|
[a3c54ef2] | 226 | <indexterm zone="xfsprogs xfs_freeze">
|
---|
[152fb77] | 227 | <primary sortas="b-xfs_freeze">xfs_freeze</primary>
|
---|
| 228 | </indexterm>
|
---|
| 229 | </listitem>
|
---|
| 230 | </varlistentry>
|
---|
| 231 |
|
---|
[518cff0] | 232 | <varlistentry id="xfs_fsr">
|
---|
| 233 | <term><command>xfs_fsr</command></term>
|
---|
| 234 | <listitem>
|
---|
| 235 | <para>applicable only to XFS filesystems, improves the organization
|
---|
| 236 | of mounted filesystems, the reorganization algorithm operates on one
|
---|
| 237 | file at a time, compacting or othewise improving the layout of the
|
---|
| 238 | file extents (contiguous blocks of file data).</para>
|
---|
| 239 | <indexterm zone="xfsprogs xfs_fsr">
|
---|
| 240 | <primary sortas="b-xfs_fsr">xfs_fsr</primary>
|
---|
| 241 | </indexterm>
|
---|
| 242 | </listitem>
|
---|
| 243 | </varlistentry>
|
---|
| 244 |
|
---|
[152fb77] | 245 | <varlistentry id="xfs_growfs">
|
---|
| 246 | <term><command>xfs_growfs</command></term>
|
---|
| 247 | <listitem>
|
---|
| 248 | <para>expands an XFS file system.</para>
|
---|
[a3c54ef2] | 249 | <indexterm zone="xfsprogs xfs_growfs">
|
---|
[152fb77] | 250 | <primary sortas="b-xfs_growfs">xfs_growfs</primary>
|
---|
| 251 | </indexterm>
|
---|
| 252 | </listitem>
|
---|
| 253 | </varlistentry>
|
---|
| 254 |
|
---|
| 255 | <varlistentry id="xfs_info">
|
---|
| 256 | <term><command>xfs_info</command></term>
|
---|
| 257 | <listitem>
|
---|
[99b1c520] | 258 | <para>is equivalent to invoking <command>xfs_growfs</command>, but
|
---|
[152fb77] | 259 | specifying that no change to the file system is to be made.</para>
|
---|
[a3c54ef2] | 260 | <indexterm zone="xfsprogs xfs_info">
|
---|
[152fb77] | 261 | <primary sortas="b-xfs_info">xfs_info</primary>
|
---|
| 262 | </indexterm>
|
---|
| 263 | </listitem>
|
---|
| 264 | </varlistentry>
|
---|
| 265 |
|
---|
| 266 | <varlistentry id="xfs_io">
|
---|
| 267 | <term><command>xfs_io</command></term>
|
---|
| 268 | <listitem>
|
---|
[99b1c520] | 269 | <para>is a debugging tool like <command>xfs_db</command>, but is
|
---|
| 270 | aimed at examining the regular file I/O path rather than the raw
|
---|
[152fb77] | 271 | XFS volume itself.</para>
|
---|
[a3c54ef2] | 272 | <indexterm zone="xfsprogs xfs_io">
|
---|
[152fb77] | 273 | <primary sortas="b-xfs_io">xfs_io</primary>
|
---|
| 274 | </indexterm>
|
---|
| 275 | </listitem>
|
---|
| 276 | </varlistentry>
|
---|
| 277 |
|
---|
| 278 | <varlistentry id="xfs_logprint">
|
---|
| 279 | <term><command>xfs_logprint</command></term>
|
---|
| 280 | <listitem>
|
---|
| 281 | <para>prints the log of an XFS file system.</para>
|
---|
[a3c54ef2] | 282 | <indexterm zone="xfsprogs xfs_logprint">
|
---|
[152fb77] | 283 | <primary sortas="b-xfs_logprint">xfs_logprint</primary>
|
---|
| 284 | </indexterm>
|
---|
| 285 | </listitem>
|
---|
| 286 | </varlistentry>
|
---|
| 287 |
|
---|
[5e72fc7] | 288 | <varlistentry id="xfs_mdrestore">
|
---|
| 289 | <term><command>xfs_mdrestore</command></term>
|
---|
| 290 | <listitem>
|
---|
| 291 | <para>restores an XFS metadump image to a filesystem image.</para>
|
---|
[a3c54ef2] | 292 | <indexterm zone="xfsprogs xfs_mdrestore">
|
---|
[5e72fc7] | 293 | <primary sortas="b-xfs_mdrestore">xfs_mdrestore</primary>
|
---|
| 294 | </indexterm>
|
---|
| 295 | </listitem>
|
---|
| 296 | </varlistentry>
|
---|
| 297 |
|
---|
| 298 | <varlistentry id="xfs_metadump">
|
---|
| 299 | <term><command>xfs_metadump</command></term>
|
---|
| 300 | <listitem>
|
---|
| 301 | <para>copies XFS filesystem metadata to a file.</para>
|
---|
[a3c54ef2] | 302 | <indexterm zone="xfsprogs xfs_metadump">
|
---|
[5e72fc7] | 303 | <primary sortas="b-xfs_metadump">xfs_metadump</primary>
|
---|
| 304 | </indexterm>
|
---|
| 305 | </listitem>
|
---|
| 306 | </varlistentry>
|
---|
| 307 |
|
---|
| 308 | <varlistentry id="xfs_mkfile">
|
---|
[152fb77] | 309 | <term><command>xfs_mkfile</command></term>
|
---|
| 310 | <listitem>
|
---|
| 311 | <para>creates an XFS file, padded with zeroes by default.</para>
|
---|
[a3c54ef2] | 312 | <indexterm zone="xfsprogs xfs_mkfile">
|
---|
[152fb77] | 313 | <primary sortas="b-xfs_mkfile">xfs_mkfile</primary>
|
---|
| 314 | </indexterm>
|
---|
| 315 | </listitem>
|
---|
| 316 | </varlistentry>
|
---|
| 317 |
|
---|
| 318 | <varlistentry id="xfs_ncheck">
|
---|
| 319 | <term><command>xfs_ncheck</command></term>
|
---|
| 320 | <listitem>
|
---|
[99b1c520] | 321 | <para>generates pathnames from inode numbers for an
|
---|
[152fb77] | 322 | XFS file system.</para>
|
---|
[a3c54ef2] | 323 | <indexterm zone="xfsprogs xfs_ncheck">
|
---|
[152fb77] | 324 | <primary sortas="b-xfs_ncheck">xfs_ncheck</primary>
|
---|
| 325 | </indexterm>
|
---|
| 326 | </listitem>
|
---|
| 327 | </varlistentry>
|
---|
| 328 |
|
---|
[2da2e6a] | 329 | <varlistentry id="xfs_quota">
|
---|
| 330 | <term><command>xfs_quota</command></term>
|
---|
| 331 | <listitem>
|
---|
| 332 | <para>is a utility for reporting and editing various
|
---|
| 333 | aspects of filesystem quota.</para>
|
---|
[a3c54ef2] | 334 | <indexterm zone="xfsprogs xfs_quota">
|
---|
[2da2e6a] | 335 | <primary sortas="b-xfs_quota">xfs_quota</primary>
|
---|
| 336 | </indexterm>
|
---|
| 337 | </listitem>
|
---|
| 338 | </varlistentry>
|
---|
| 339 |
|
---|
[152fb77] | 340 | <varlistentry id="xfs_repair">
|
---|
| 341 | <term><command>xfs_repair</command></term>
|
---|
| 342 | <listitem>
|
---|
| 343 | <para>repairs corrupt or damaged XFS file systems.</para>
|
---|
[a3c54ef2] | 344 | <indexterm zone="xfsprogs xfs_repair">
|
---|
[152fb77] | 345 | <primary sortas="b-xfs_repair">xfs_repair</primary>
|
---|
| 346 | </indexterm>
|
---|
| 347 | </listitem>
|
---|
| 348 | </varlistentry>
|
---|
| 349 |
|
---|
| 350 | <varlistentry id="xfs_rtcp">
|
---|
| 351 | <term><command>xfs_rtcp</command></term>
|
---|
| 352 | <listitem>
|
---|
[99b1c520] | 353 | <para>copies a file to the real-time partition on an
|
---|
[152fb77] | 354 | XFS file system.</para>
|
---|
[a3c54ef2] | 355 | <indexterm zone="xfsprogs xfs_rtcp">
|
---|
[152fb77] | 356 | <primary sortas="b-xfs_rtcp">xfs_rtcp</primary>
|
---|
| 357 | </indexterm>
|
---|
| 358 | </listitem>
|
---|
| 359 | </varlistentry>
|
---|
| 360 |
|
---|
| 361 | <varlistentry id="libhandle">
|
---|
[a3c54ef2] | 362 | <term><filename class="libraryfile">libhandle.so</filename></term>
|
---|
[152fb77] | 363 | <listitem>
|
---|
[1ba83240] | 364 | <para>contains XFS-specific functions that provide a way to perform
|
---|
[a4b9cd7] | 365 | certain filesystem operations without using a file descriptor to
|
---|
| 366 | access filesystem objects.</para>
|
---|
[a3c54ef2] | 367 | <indexterm zone="xfsprogs libhandle">
|
---|
[152fb77] | 368 | <primary sortas="c-libhandle">libhandle.so</primary>
|
---|
| 369 | </indexterm>
|
---|
| 370 | </listitem>
|
---|
| 371 | </varlistentry>
|
---|
[864b24de] | 372 |
|
---|
[152fb77] | 373 | </variablelist>
|
---|
| 374 |
|
---|
| 375 | </sect2>
|
---|
[f45b1953] | 376 |
|
---|
| 377 | </sect1>
|
---|