[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 |
|
---|
[91be7ab] | 7 | <!ENTITY xfsprogs-download-http "&sources-anduin-http;/x/xfsprogs-&xfsprogs-version;.tar.gz">
|
---|
[a3c54ef2] | 8 | <!ENTITY xfsprogs-download-ftp "ftp://oss.sgi.com/projects/xfs/cmd_tars/xfsprogs-&xfsprogs-version;.tar.gz">
|
---|
[eac6532f] | 9 | <!ENTITY xfsprogs-md5sum "de9f1f45026c2f4e0776058d429ff4b6">
|
---|
| 10 | <!ENTITY xfsprogs-size "1.3 MB">
|
---|
| 11 | <!ENTITY xfsprogs-buildsize "45 MB">
|
---|
[8bc3edae] | 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 |
|
---|
[cf67717] | 35 | &lfs75_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 |
|
---|
| 70 | <screen><literal>File Systems:
|
---|
| 71 | XFS filesystem support: M or Y</literal></screen>
|
---|
| 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 |
|
---|
[b5972ac] | 85 | <screen><userinput>make DEBUG=-DNDEBUG INSTALL_USER=root INSTALL_GROUP=root \
|
---|
[a3c54ef2] | 86 | LOCAL_CONFIGURE_OPTIONS="--enable-readline"</userinput></screen>
|
---|
[1ba83240] | 87 |
|
---|
| 88 | <para>This package does not come with a test suite.</para>
|
---|
[152fb77] | 89 |
|
---|
| 90 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 91 |
|
---|
[a3c54ef2] | 92 | <screen role="root"><userinput>make install install-dev &&
|
---|
| 93 | rm -rfv /lib/libhandle.{a,la,so} &&
|
---|
| 94 | ln -sfv ../../lib/libhandle.so.1 /usr/lib/libhandle.so &&
|
---|
| 95 | sed -i "s@libdir='/lib@libdir='/usr/lib@g" /usr/lib/libhandle.la</userinput></screen>
|
---|
[2da2e6a] | 96 |
|
---|
[152fb77] | 97 | </sect2>
|
---|
| 98 |
|
---|
[55329727] | 99 | <sect2 role="commands">
|
---|
| 100 | <title>Command Explanations</title>
|
---|
| 101 |
|
---|
[410e228b] | 102 | <para><command>make DEBUG=-DNDEBUG</command>: Turns off debugging
|
---|
[b160786] | 103 | symbols.</para>
|
---|
[2da2e6a] | 104 |
|
---|
[1ba83240] | 105 | <para><parameter>INSTALL_USER=root INSTALL_GROUP=root</parameter>: This
|
---|
| 106 | sets the owner and group of the installed files.</para>
|
---|
[864b24de] | 107 |
|
---|
[1ba83240] | 108 | <para><parameter>LOCAL_CONFIGURE_OPTIONS="..."</parameter>: This passes
|
---|
| 109 | extra configuration options to the <filename>configure</filename> script.
|
---|
[a3c54ef2] | 110 | The example <parameter>--enable-readline</parameter> parameter
|
---|
[1ba83240] | 111 | enables linking the XFS programs with the
|
---|
| 112 | <filename class="libraryfile">libreadline.so</filename> library, in order
|
---|
| 113 | to allow editing interactive commands.</para>
|
---|
[864b24de] | 114 |
|
---|
[2da2e6a] | 115 | <para><parameter>OPTIMIZER="..."</parameter>: Adding this parameter to
|
---|
[1ba83240] | 116 | the end of the <command>make</command> command overrides the
|
---|
| 117 | default optimization settings.</para>
|
---|
| 118 |
|
---|
[55329727] | 119 | </sect2>
|
---|
| 120 |
|
---|
[152fb77] | 121 | <sect2 role="content">
|
---|
| 122 | <title>Contents</title>
|
---|
| 123 |
|
---|
| 124 | <segmentedlist>
|
---|
| 125 | <segtitle>Installed Programs</segtitle>
|
---|
[1ba83240] | 126 | <segtitle>Installed Libraries</segtitle>
|
---|
[a3c54ef2] | 127 | <segtitle>Installed Directories</segtitle>
|
---|
[152fb77] | 128 |
|
---|
| 129 | <seglistitem>
|
---|
[99b1c520] | 130 | <seg>fsck.xfs, mkfs.xfs, xfs_admin, xfs_bmap, xfs_check, xfs_copy,
|
---|
| 131 | xfs_db, xfs_freeze, xfs_growfs, xfs_info, xfs_io, xfs_logprint,
|
---|
[5e72fc7] | 132 | xfs_mdrestore, xfs_metadump, xfs_mkfile, xfs_ncheck, xfs_quota,
|
---|
| 133 | xfs_repair, and xfs_rtcp</seg>
|
---|
[a3c54ef2] | 134 | <seg>libhandle.{so,a}</seg>
|
---|
| 135 | <seg>/usr/include/xfs and /usr/share/doc/xfsprogs</seg>
|
---|
[152fb77] | 136 | </seglistitem>
|
---|
| 137 | </segmentedlist>
|
---|
| 138 |
|
---|
| 139 | <variablelist>
|
---|
| 140 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 141 | <?dbfo list-presentation="list"?>
|
---|
| 142 | <?dbhtml list-presentation="table"?>
|
---|
| 143 |
|
---|
| 144 | <varlistentry id="fsck.xfs">
|
---|
| 145 | <term><command>fsck.xfs</command></term>
|
---|
| 146 | <listitem>
|
---|
[99b1c520] | 147 | <para>simply exits with a zero status, since XFS
|
---|
[152fb77] | 148 | partitions are checked at mount time.</para>
|
---|
[a3c54ef2] | 149 | <indexterm zone="xfsprogs fsck.xfs">
|
---|
[152fb77] | 150 | <primary sortas="b-fsck.xfs">fsck.xfs</primary>
|
---|
| 151 | </indexterm>
|
---|
| 152 | </listitem>
|
---|
| 153 | </varlistentry>
|
---|
| 154 |
|
---|
| 155 | <varlistentry id="mkfs.xfs">
|
---|
| 156 | <term><command>mkfs.xfs</command></term>
|
---|
| 157 | <listitem>
|
---|
| 158 | <para>constructs an XFS file system.</para>
|
---|
[a3c54ef2] | 159 | <indexterm zone="xfsprogs mkfs.xfs">
|
---|
[152fb77] | 160 | <primary sortas="b-mkfs.xfs">mkfs.xfs</primary>
|
---|
| 161 | </indexterm>
|
---|
| 162 | </listitem>
|
---|
| 163 | </varlistentry>
|
---|
| 164 |
|
---|
| 165 | <varlistentry id="xfs_admin">
|
---|
| 166 | <term><command>xfs_admin</command></term>
|
---|
| 167 | <listitem>
|
---|
| 168 | <para>changes the parameters of an XFS file system.</para>
|
---|
[a3c54ef2] | 169 | <indexterm zone="xfsprogs xfs_admin">
|
---|
[152fb77] | 170 | <primary sortas="b-xfs_admin">xfs_admin</primary>
|
---|
| 171 | </indexterm>
|
---|
| 172 | </listitem>
|
---|
| 173 | </varlistentry>
|
---|
| 174 |
|
---|
| 175 | <varlistentry id="xfs_bmap">
|
---|
| 176 | <term><command>xfs_bmap</command></term>
|
---|
| 177 | <listitem>
|
---|
| 178 | <para>prints block mapping for an XFS file.</para>
|
---|
[a3c54ef2] | 179 | <indexterm zone="xfsprogs xfs_bmap">
|
---|
[152fb77] | 180 | <primary sortas="b-xfs_bmap">xfs_bmap</primary>
|
---|
| 181 | </indexterm>
|
---|
| 182 | </listitem>
|
---|
| 183 | </varlistentry>
|
---|
| 184 |
|
---|
| 185 | <varlistentry id="xfs_check">
|
---|
| 186 | <term><command>xfs_check</command></term>
|
---|
| 187 | <listitem>
|
---|
| 188 | <para>checks XFS file system consistency.</para>
|
---|
[a3c54ef2] | 189 | <indexterm zone="xfsprogs xfs_check">
|
---|
[152fb77] | 190 | <primary sortas="b-xfs_check">xfs_check</primary>
|
---|
| 191 | </indexterm>
|
---|
| 192 | </listitem>
|
---|
| 193 | </varlistentry>
|
---|
| 194 |
|
---|
| 195 | <varlistentry id="xfs_copy">
|
---|
| 196 | <term><command>xfs_copy</command></term>
|
---|
| 197 | <listitem>
|
---|
[99b1c520] | 198 | <para>copies the contents of an XFS file system
|
---|
[152fb77] | 199 | to one or more targets in parallel.</para>
|
---|
[a3c54ef2] | 200 | <indexterm zone="xfsprogs xfs_copy">
|
---|
[152fb77] | 201 | <primary sortas="b-xfs_copy">xfs_copy</primary>
|
---|
| 202 | </indexterm>
|
---|
| 203 | </listitem>
|
---|
| 204 | </varlistentry>
|
---|
| 205 |
|
---|
| 206 | <varlistentry id="xfs_db">
|
---|
| 207 | <term><command>xfs_db</command></term>
|
---|
| 208 | <listitem>
|
---|
| 209 | <para>is used to debug an XFS file system.</para>
|
---|
[a3c54ef2] | 210 | <indexterm zone="xfsprogs xfs_db">
|
---|
[152fb77] | 211 | <primary sortas="b-xfs_db">xfs_db</primary>
|
---|
| 212 | </indexterm>
|
---|
| 213 | </listitem>
|
---|
| 214 | </varlistentry>
|
---|
| 215 |
|
---|
| 216 | <varlistentry id="xfs_freeze">
|
---|
| 217 | <term><command>xfs_freeze</command></term>
|
---|
| 218 | <listitem>
|
---|
| 219 | <para>suspends access to an XFS file system.</para>
|
---|
[a3c54ef2] | 220 | <indexterm zone="xfsprogs xfs_freeze">
|
---|
[152fb77] | 221 | <primary sortas="b-xfs_freeze">xfs_freeze</primary>
|
---|
| 222 | </indexterm>
|
---|
| 223 | </listitem>
|
---|
| 224 | </varlistentry>
|
---|
| 225 |
|
---|
| 226 | <varlistentry id="xfs_growfs">
|
---|
| 227 | <term><command>xfs_growfs</command></term>
|
---|
| 228 | <listitem>
|
---|
| 229 | <para>expands an XFS file system.</para>
|
---|
[a3c54ef2] | 230 | <indexterm zone="xfsprogs xfs_growfs">
|
---|
[152fb77] | 231 | <primary sortas="b-xfs_growfs">xfs_growfs</primary>
|
---|
| 232 | </indexterm>
|
---|
| 233 | </listitem>
|
---|
| 234 | </varlistentry>
|
---|
| 235 |
|
---|
| 236 | <varlistentry id="xfs_info">
|
---|
| 237 | <term><command>xfs_info</command></term>
|
---|
| 238 | <listitem>
|
---|
[99b1c520] | 239 | <para>is equivalent to invoking <command>xfs_growfs</command>, but
|
---|
[152fb77] | 240 | specifying that no change to the file system is to be made.</para>
|
---|
[a3c54ef2] | 241 | <indexterm zone="xfsprogs xfs_info">
|
---|
[152fb77] | 242 | <primary sortas="b-xfs_info">xfs_info</primary>
|
---|
| 243 | </indexterm>
|
---|
| 244 | </listitem>
|
---|
| 245 | </varlistentry>
|
---|
| 246 |
|
---|
| 247 | <varlistentry id="xfs_io">
|
---|
| 248 | <term><command>xfs_io</command></term>
|
---|
| 249 | <listitem>
|
---|
[99b1c520] | 250 | <para>is a debugging tool like <command>xfs_db</command>, but is
|
---|
| 251 | aimed at examining the regular file I/O path rather than the raw
|
---|
[152fb77] | 252 | XFS volume itself.</para>
|
---|
[a3c54ef2] | 253 | <indexterm zone="xfsprogs xfs_io">
|
---|
[152fb77] | 254 | <primary sortas="b-xfs_io">xfs_io</primary>
|
---|
| 255 | </indexterm>
|
---|
| 256 | </listitem>
|
---|
| 257 | </varlistentry>
|
---|
| 258 |
|
---|
| 259 | <varlistentry id="xfs_logprint">
|
---|
| 260 | <term><command>xfs_logprint</command></term>
|
---|
| 261 | <listitem>
|
---|
| 262 | <para>prints the log of an XFS file system.</para>
|
---|
[a3c54ef2] | 263 | <indexterm zone="xfsprogs xfs_logprint">
|
---|
[152fb77] | 264 | <primary sortas="b-xfs_logprint">xfs_logprint</primary>
|
---|
| 265 | </indexterm>
|
---|
| 266 | </listitem>
|
---|
| 267 | </varlistentry>
|
---|
| 268 |
|
---|
[5e72fc7] | 269 | <varlistentry id="xfs_mdrestore">
|
---|
| 270 | <term><command>xfs_mdrestore</command></term>
|
---|
| 271 | <listitem>
|
---|
| 272 | <para>restores an XFS metadump image to a filesystem image.</para>
|
---|
[a3c54ef2] | 273 | <indexterm zone="xfsprogs xfs_mdrestore">
|
---|
[5e72fc7] | 274 | <primary sortas="b-xfs_mdrestore">xfs_mdrestore</primary>
|
---|
| 275 | </indexterm>
|
---|
| 276 | </listitem>
|
---|
| 277 | </varlistentry>
|
---|
| 278 |
|
---|
| 279 | <varlistentry id="xfs_metadump">
|
---|
| 280 | <term><command>xfs_metadump</command></term>
|
---|
| 281 | <listitem>
|
---|
| 282 | <para>copies XFS filesystem metadata to a file.</para>
|
---|
[a3c54ef2] | 283 | <indexterm zone="xfsprogs xfs_metadump">
|
---|
[5e72fc7] | 284 | <primary sortas="b-xfs_metadump">xfs_metadump</primary>
|
---|
| 285 | </indexterm>
|
---|
| 286 | </listitem>
|
---|
| 287 | </varlistentry>
|
---|
| 288 |
|
---|
| 289 | <varlistentry id="xfs_mkfile">
|
---|
[152fb77] | 290 | <term><command>xfs_mkfile</command></term>
|
---|
| 291 | <listitem>
|
---|
| 292 | <para>creates an XFS file, padded with zeroes by default.</para>
|
---|
[a3c54ef2] | 293 | <indexterm zone="xfsprogs xfs_mkfile">
|
---|
[152fb77] | 294 | <primary sortas="b-xfs_mkfile">xfs_mkfile</primary>
|
---|
| 295 | </indexterm>
|
---|
| 296 | </listitem>
|
---|
| 297 | </varlistentry>
|
---|
| 298 |
|
---|
| 299 | <varlistentry id="xfs_ncheck">
|
---|
| 300 | <term><command>xfs_ncheck</command></term>
|
---|
| 301 | <listitem>
|
---|
[99b1c520] | 302 | <para>generates pathnames from inode numbers for an
|
---|
[152fb77] | 303 | XFS file system.</para>
|
---|
[a3c54ef2] | 304 | <indexterm zone="xfsprogs xfs_ncheck">
|
---|
[152fb77] | 305 | <primary sortas="b-xfs_ncheck">xfs_ncheck</primary>
|
---|
| 306 | </indexterm>
|
---|
| 307 | </listitem>
|
---|
| 308 | </varlistentry>
|
---|
| 309 |
|
---|
[2da2e6a] | 310 | <varlistentry id="xfs_quota">
|
---|
| 311 | <term><command>xfs_quota</command></term>
|
---|
| 312 | <listitem>
|
---|
| 313 | <para>is a utility for reporting and editing various
|
---|
| 314 | aspects of filesystem quota.</para>
|
---|
[a3c54ef2] | 315 | <indexterm zone="xfsprogs xfs_quota">
|
---|
[2da2e6a] | 316 | <primary sortas="b-xfs_quota">xfs_quota</primary>
|
---|
| 317 | </indexterm>
|
---|
| 318 | </listitem>
|
---|
| 319 | </varlistentry>
|
---|
| 320 |
|
---|
[152fb77] | 321 | <varlistentry id="xfs_repair">
|
---|
| 322 | <term><command>xfs_repair</command></term>
|
---|
| 323 | <listitem>
|
---|
| 324 | <para>repairs corrupt or damaged XFS file systems.</para>
|
---|
[a3c54ef2] | 325 | <indexterm zone="xfsprogs xfs_repair">
|
---|
[152fb77] | 326 | <primary sortas="b-xfs_repair">xfs_repair</primary>
|
---|
| 327 | </indexterm>
|
---|
| 328 | </listitem>
|
---|
| 329 | </varlistentry>
|
---|
| 330 |
|
---|
| 331 | <varlistentry id="xfs_rtcp">
|
---|
| 332 | <term><command>xfs_rtcp</command></term>
|
---|
| 333 | <listitem>
|
---|
[99b1c520] | 334 | <para>copies a file to the real-time partition on an
|
---|
[152fb77] | 335 | XFS file system.</para>
|
---|
[a3c54ef2] | 336 | <indexterm zone="xfsprogs xfs_rtcp">
|
---|
[152fb77] | 337 | <primary sortas="b-xfs_rtcp">xfs_rtcp</primary>
|
---|
| 338 | </indexterm>
|
---|
| 339 | </listitem>
|
---|
| 340 | </varlistentry>
|
---|
| 341 |
|
---|
| 342 | <varlistentry id="libhandle">
|
---|
[a3c54ef2] | 343 | <term><filename class="libraryfile">libhandle.so</filename></term>
|
---|
[152fb77] | 344 | <listitem>
|
---|
[1ba83240] | 345 | <para>contains XFS-specific functions that provide a way to perform
|
---|
[a4b9cd7] | 346 | certain filesystem operations without using a file descriptor to
|
---|
| 347 | access filesystem objects.</para>
|
---|
[a3c54ef2] | 348 | <indexterm zone="xfsprogs libhandle">
|
---|
[152fb77] | 349 | <primary sortas="c-libhandle">libhandle.so</primary>
|
---|
| 350 | </indexterm>
|
---|
| 351 | </listitem>
|
---|
| 352 | </varlistentry>
|
---|
[864b24de] | 353 |
|
---|
[152fb77] | 354 | </variablelist>
|
---|
| 355 |
|
---|
| 356 | </sect2>
|
---|
[f45b1953] | 357 |
|
---|
| 358 | </sect1>
|
---|