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