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 | <!-- <!ENTITY xfsprogs-download-http "http://mirrors.sunsite.dk/xfs/download/cmd_tars/xfsprogs_&xfsprogs-version;-1.tar.gz"> -->
|
---|
8 | <!ENTITY xfsprogs-download-http "&files-anduin;/sources/xfsprogs-&xfsprogs-version;.tar.gz">
|
---|
9 | <!-- <!ENTITY xfsprogs-download-ftp "ftp://oss.sgi.com/projects/xfs/download/cmd_tars/xfsprogs_&xfsprogs-version;-1.tar.gz"> -->
|
---|
10 | <!ENTITY xfsprogs-download-ftp " ">
|
---|
11 | <!ENTITY xfsprogs-md5sum "049cf9873794ea49d0bb3f12d45748a4">
|
---|
12 | <!ENTITY xfsprogs-size "1.3 MB">
|
---|
13 | <!ENTITY xfsprogs-buildsize "36 MB">
|
---|
14 | <!ENTITY xfsprogs-time "0.5 SBU">
|
---|
15 | ]>
|
---|
16 |
|
---|
17 | <sect1 id="xfs" xreflabel="xfs-&xfsprogs-version;">
|
---|
18 | <?dbhtml filename="xfsfs.html"?>
|
---|
19 |
|
---|
20 | <sect1info>
|
---|
21 | <othername>$LastChangedBy$</othername>
|
---|
22 | <date>$Date$</date>
|
---|
23 | </sect1info>
|
---|
24 |
|
---|
25 | <title>xfsprogs-&xfsprogs-version;</title>
|
---|
26 |
|
---|
27 | <indexterm zone="xfs">
|
---|
28 | <primary sortas="a-XFS">XFS</primary>
|
---|
29 | </indexterm>
|
---|
30 |
|
---|
31 | <sect2 role="package">
|
---|
32 | <title>Introduction to xfsprogs</title>
|
---|
33 |
|
---|
34 | <para>The <application>xfsprogs</application> package contains administration
|
---|
35 | and debugging tools for the XFS file system.</para>
|
---|
36 |
|
---|
37 | &lfs70_checked;
|
---|
38 |
|
---|
39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
40 | <itemizedlist spacing="compact">
|
---|
41 | <listitem>
|
---|
42 | <para>Download (HTTP): <ulink url="&xfsprogs-download-http;"/></para>
|
---|
43 | </listitem>
|
---|
44 | <listitem>
|
---|
45 | <para>Download (FTP): <ulink url="&xfsprogs-download-ftp;"/></para>
|
---|
46 | </listitem>
|
---|
47 | <listitem>
|
---|
48 | <para>Download MD5 sum: &xfsprogs-md5sum;</para>
|
---|
49 | </listitem>
|
---|
50 | <listitem>
|
---|
51 | <para>Download size: &xfsprogs-size;</para>
|
---|
52 | </listitem>
|
---|
53 | <listitem>
|
---|
54 | <para>Estimated disk space required: &xfsprogs-buildsize;</para>
|
---|
55 | </listitem>
|
---|
56 | <listitem>
|
---|
57 | <para>Estimated build time: &xfsprogs-time;</para>
|
---|
58 | </listitem>
|
---|
59 | </itemizedlist>
|
---|
60 |
|
---|
61 | <caution><para>The XFS developers regularly remove the current
|
---|
62 | package when a new package is available. Unfortunately, this has led to
|
---|
63 | severe incompatibilities, including
|
---|
64 | <ulink url="http://bugs.debian.org/465737">unmountable filesystems</ulink>,
|
---|
65 | due to kernel version requirements in new versions of the package. Using a
|
---|
66 | version not in the book is strongly discouraged. Additional information,
|
---|
67 | is available at the
|
---|
68 | <ulink url="http://oss.sgi.com/projects/xfs/">XFS</ulink> project
|
---|
69 | page.</para></caution>
|
---|
70 |
|
---|
71 | <!-- For more information on this problem, see this thread on BLFS-Dev
|
---|
72 | http://linuxfromscratch.org/pipermail/blfs-dev/2008-March/018311.html
|
---|
73 | -->
|
---|
74 | <para condition="html" role="usernotes">User Notes:
|
---|
75 | <ulink url="&blfs-wiki;/xfs"/></para>
|
---|
76 |
|
---|
77 | </sect2>
|
---|
78 |
|
---|
79 | <sect2 role="kernel" id='xfs-kernel'>
|
---|
80 | <title>Kernel Configuration</title>
|
---|
81 |
|
---|
82 | <para>Enable the following options in the kernel configuration
|
---|
83 | and recompile the kernel:</para>
|
---|
84 |
|
---|
85 | <screen><literal>File Systems:
|
---|
86 | XFS filesystem support: M or Y</literal></screen>
|
---|
87 |
|
---|
88 | <indexterm zone="xfs xfs-kernel">
|
---|
89 | <primary sortas="d-xfs">XFS Programs</primary>
|
---|
90 | </indexterm>
|
---|
91 |
|
---|
92 | </sect2>
|
---|
93 |
|
---|
94 | <sect2 role="installation">
|
---|
95 | <title>Installation of xfsprogs</title>
|
---|
96 |
|
---|
97 | <para>Install <application>xfsprogs</application> by running the following
|
---|
98 | commands:</para>
|
---|
99 |
|
---|
100 | <screen><userinput>make DEBUG=-DNDEBUG INSTALL_USER=root INSTALL_GROUP=root \
|
---|
101 | LOCAL_CONFIGURE_OPTIONS="--enable-readline=yes"</userinput></screen>
|
---|
102 |
|
---|
103 | <para>This package does not come with a test suite.</para>
|
---|
104 |
|
---|
105 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
106 |
|
---|
107 | <screen role="root"><userinput>make install &&
|
---|
108 | make install-dev &&
|
---|
109 | chmod -v 755 /lib/libhandle.so.1.*</userinput></screen>
|
---|
110 |
|
---|
111 | </sect2>
|
---|
112 |
|
---|
113 | <sect2 role="commands">
|
---|
114 | <title>Command Explanations</title>
|
---|
115 |
|
---|
116 | <para><command>make DEBUG=-DNDEBUG</command>: Turns off debugging
|
---|
117 | symbols.</para>
|
---|
118 |
|
---|
119 | <para><parameter>INSTALL_USER=root INSTALL_GROUP=root</parameter>: This
|
---|
120 | sets the owner and group of the installed files.</para>
|
---|
121 |
|
---|
122 | <para><parameter>LOCAL_CONFIGURE_OPTIONS="..."</parameter>: This passes
|
---|
123 | extra configuration options to the <filename>configure</filename> script.
|
---|
124 | The example <parameter>--enable-readline=yes</parameter> parameter
|
---|
125 | enables linking the XFS programs with the
|
---|
126 | <filename class="libraryfile">libreadline.so</filename> library, in order
|
---|
127 | to allow editing interactive commands.</para>
|
---|
128 |
|
---|
129 | <para><parameter>OPTIMIZER="..."</parameter>: Adding this parameter to
|
---|
130 | the end of the <command>make</command> command overrides the
|
---|
131 | default optimization settings.</para>
|
---|
132 |
|
---|
133 | <para><command>make install-dev</command>: This command installs
|
---|
134 | static XFS libraries, their headers and the corresponding
|
---|
135 | documentation.</para>
|
---|
136 |
|
---|
137 | </sect2>
|
---|
138 |
|
---|
139 | <sect2 role="content">
|
---|
140 | <title>Contents</title>
|
---|
141 |
|
---|
142 | <segmentedlist>
|
---|
143 | <segtitle>Installed Programs</segtitle>
|
---|
144 | <segtitle>Installed Libraries</segtitle>
|
---|
145 | <segtitle>Installed Directory</segtitle>
|
---|
146 |
|
---|
147 | <seglistitem>
|
---|
148 | <seg>fsck.xfs, mkfs.xfs, xfs_admin, xfs_bmap, xfs_check, xfs_copy,
|
---|
149 | xfs_db, xfs_freeze, xfs_growfs, xfs_info, xfs_io, xfs_logprint,
|
---|
150 | xfs_mdrestore, xfs_metadump, xfs_mkfile, xfs_ncheck, xfs_quota,
|
---|
151 | xfs_repair, and xfs_rtcp</seg>
|
---|
152 | <seg>libdisk.a, libhandle.{so,a}, libxcmd.a, libxfs.a, and
|
---|
153 | libxlog.a </seg>
|
---|
154 | <seg>/usr/share/doc/xfsprogs</seg>
|
---|
155 | </seglistitem>
|
---|
156 | </segmentedlist>
|
---|
157 |
|
---|
158 | <variablelist>
|
---|
159 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
160 | <?dbfo list-presentation="list"?>
|
---|
161 | <?dbhtml list-presentation="table"?>
|
---|
162 |
|
---|
163 | <varlistentry id="fsck.xfs">
|
---|
164 | <term><command>fsck.xfs</command></term>
|
---|
165 | <listitem>
|
---|
166 | <para>simply exits with a zero status, since XFS
|
---|
167 | partitions are checked at mount time.</para>
|
---|
168 | <indexterm zone="xfs fsck.xfs">
|
---|
169 | <primary sortas="b-fsck.xfs">fsck.xfs</primary>
|
---|
170 | </indexterm>
|
---|
171 | </listitem>
|
---|
172 | </varlistentry>
|
---|
173 |
|
---|
174 | <varlistentry id="mkfs.xfs">
|
---|
175 | <term><command>mkfs.xfs</command></term>
|
---|
176 | <listitem>
|
---|
177 | <para>constructs an XFS file system.</para>
|
---|
178 | <indexterm zone="xfs mkfs.xfs">
|
---|
179 | <primary sortas="b-mkfs.xfs">mkfs.xfs</primary>
|
---|
180 | </indexterm>
|
---|
181 | </listitem>
|
---|
182 | </varlistentry>
|
---|
183 |
|
---|
184 | <varlistentry id="xfs_admin">
|
---|
185 | <term><command>xfs_admin</command></term>
|
---|
186 | <listitem>
|
---|
187 | <para>changes the parameters of an XFS file system.</para>
|
---|
188 | <indexterm zone="xfs xfs_admin">
|
---|
189 | <primary sortas="b-xfs_admin">xfs_admin</primary>
|
---|
190 | </indexterm>
|
---|
191 | </listitem>
|
---|
192 | </varlistentry>
|
---|
193 |
|
---|
194 | <varlistentry id="xfs_bmap">
|
---|
195 | <term><command>xfs_bmap</command></term>
|
---|
196 | <listitem>
|
---|
197 | <para>prints block mapping for an XFS file.</para>
|
---|
198 | <indexterm zone="xfs xfs_bmap">
|
---|
199 | <primary sortas="b-xfs_bmap">xfs_bmap</primary>
|
---|
200 | </indexterm>
|
---|
201 | </listitem>
|
---|
202 | </varlistentry>
|
---|
203 |
|
---|
204 | <varlistentry id="xfs_check">
|
---|
205 | <term><command>xfs_check</command></term>
|
---|
206 | <listitem>
|
---|
207 | <para>checks XFS file system consistency.</para>
|
---|
208 | <indexterm zone="xfs xfs_check">
|
---|
209 | <primary sortas="b-xfs_check">xfs_check</primary>
|
---|
210 | </indexterm>
|
---|
211 | </listitem>
|
---|
212 | </varlistentry>
|
---|
213 |
|
---|
214 | <varlistentry id="xfs_copy">
|
---|
215 | <term><command>xfs_copy</command></term>
|
---|
216 | <listitem>
|
---|
217 | <para>copies the contents of an XFS file system
|
---|
218 | to one or more targets in parallel.</para>
|
---|
219 | <indexterm zone="xfs xfs_copy">
|
---|
220 | <primary sortas="b-xfs_copy">xfs_copy</primary>
|
---|
221 | </indexterm>
|
---|
222 | </listitem>
|
---|
223 | </varlistentry>
|
---|
224 |
|
---|
225 | <varlistentry id="xfs_db">
|
---|
226 | <term><command>xfs_db</command></term>
|
---|
227 | <listitem>
|
---|
228 | <para>is used to debug an XFS file system.</para>
|
---|
229 | <indexterm zone="xfs xfs_db">
|
---|
230 | <primary sortas="b-xfs_db">xfs_db</primary>
|
---|
231 | </indexterm>
|
---|
232 | </listitem>
|
---|
233 | </varlistentry>
|
---|
234 |
|
---|
235 | <varlistentry id="xfs_freeze">
|
---|
236 | <term><command>xfs_freeze</command></term>
|
---|
237 | <listitem>
|
---|
238 | <para>suspends access to an XFS file system.</para>
|
---|
239 | <indexterm zone="xfs xfs_freeze">
|
---|
240 | <primary sortas="b-xfs_freeze">xfs_freeze</primary>
|
---|
241 | </indexterm>
|
---|
242 | </listitem>
|
---|
243 | </varlistentry>
|
---|
244 |
|
---|
245 | <varlistentry id="xfs_growfs">
|
---|
246 | <term><command>xfs_growfs</command></term>
|
---|
247 | <listitem>
|
---|
248 | <para>expands an XFS file system.</para>
|
---|
249 | <indexterm zone="xfs xfs_growfs">
|
---|
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>
|
---|
258 | <para>is equivalent to invoking <command>xfs_growfs</command>, but
|
---|
259 | specifying that no change to the file system is to be made.</para>
|
---|
260 | <indexterm zone="xfs xfs_info">
|
---|
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>
|
---|
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
|
---|
271 | XFS volume itself.</para>
|
---|
272 | <indexterm zone="xfs xfs_io">
|
---|
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>
|
---|
282 | <indexterm zone="xfs xfs_logprint">
|
---|
283 | <primary sortas="b-xfs_logprint">xfs_logprint</primary>
|
---|
284 | </indexterm>
|
---|
285 | </listitem>
|
---|
286 | </varlistentry>
|
---|
287 |
|
---|
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>
|
---|
292 | <indexterm zone="xfs xfs_mdrestore">
|
---|
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>
|
---|
302 | <indexterm zone="xfs xfs_metadump">
|
---|
303 | <primary sortas="b-xfs_metadump">xfs_metadump</primary>
|
---|
304 | </indexterm>
|
---|
305 | </listitem>
|
---|
306 | </varlistentry>
|
---|
307 |
|
---|
308 | <varlistentry id="xfs_mkfile">
|
---|
309 | <term><command>xfs_mkfile</command></term>
|
---|
310 | <listitem>
|
---|
311 | <para>creates an XFS file, padded with zeroes by default.</para>
|
---|
312 | <indexterm zone="xfs xfs_mkfile">
|
---|
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>
|
---|
321 | <para>generates pathnames from inode numbers for an
|
---|
322 | XFS file system.</para>
|
---|
323 | <indexterm zone="xfs xfs_ncheck">
|
---|
324 | <primary sortas="b-xfs_ncheck">xfs_ncheck</primary>
|
---|
325 | </indexterm>
|
---|
326 | </listitem>
|
---|
327 | </varlistentry>
|
---|
328 |
|
---|
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>
|
---|
334 | <indexterm zone="xfs xfs_quota">
|
---|
335 | <primary sortas="b-xfs_quota">xfs_quota</primary>
|
---|
336 | </indexterm>
|
---|
337 | </listitem>
|
---|
338 | </varlistentry>
|
---|
339 |
|
---|
340 | <varlistentry id="xfs_repair">
|
---|
341 | <term><command>xfs_repair</command></term>
|
---|
342 | <listitem>
|
---|
343 | <para>repairs corrupt or damaged XFS file systems.</para>
|
---|
344 | <indexterm zone="xfs xfs_repair">
|
---|
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>
|
---|
353 | <para>copies a file to the real-time partition on an
|
---|
354 | XFS file system.</para>
|
---|
355 | <indexterm zone="xfs xfs_rtcp">
|
---|
356 | <primary sortas="b-xfs_rtcp">xfs_rtcp</primary>
|
---|
357 | </indexterm>
|
---|
358 | </listitem>
|
---|
359 | </varlistentry>
|
---|
360 |
|
---|
361 | <varlistentry id="libhandle">
|
---|
362 | <term><filename class='libraryfile'>libhandle.so</filename></term>
|
---|
363 | <listitem>
|
---|
364 | <para>contains XFS-specific functions that provide a way to perform
|
---|
365 | certain filesystem operations without using a file descriptor to
|
---|
366 | access filesystem objects.</para>
|
---|
367 | <indexterm zone="xfs libhandle">
|
---|
368 | <primary sortas="c-libhandle">libhandle.so</primary>
|
---|
369 | </indexterm>
|
---|
370 | </listitem>
|
---|
371 | </varlistentry>
|
---|
372 |
|
---|
373 |
|
---|
374 | <!-- FIXME: other libraries are undocumented 20080221 -->
|
---|
375 |
|
---|
376 | </variablelist>
|
---|
377 |
|
---|
378 | </sect2>
|
---|
379 |
|
---|
380 | </sect1>
|
---|