source: postlfs/filesystems/xfsprogs.xml@ 45ab6c7

trunk
Last change on this file since 45ab6c7 was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 4 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

  • Property mode set to 100644
File size: 14.9 KB
Line 
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 "&kernel-dl;/linux/utils/fs/xfs/xfsprogs/xfsprogs-&xfsprogs-version;.tar.xz">
8 <!ENTITY xfsprogs-download-ftp " ">
9 <!ENTITY xfsprogs-md5sum "803bcddd983803b339acfb76064dfd84">
10 <!ENTITY xfsprogs-size "1.2 MB">
11 <!ENTITY xfsprogs-buildsize "86 MB">
12 <!ENTITY xfsprogs-time "0.3 SBU (Using parallelism=4)">
13]>
14
15<sect1 id="xfsprogs" xreflabel="xfsprogs-&xfsprogs-version;">
16 <?dbhtml filename="xfsprogs.html"?>
17
18 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>xfsprogs-&xfsprogs-version;</title>
23
24 <indexterm zone="xfsprogs">
25 <primary sortas="a-xfsprogs">xfsprogs</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to xfsprogs</title>
30
31 <para>
32 The <application>xfsprogs</application> package contains
33 administration and debugging tools for the XFS file system.
34 </para>
35
36 &lfs101_checked;
37
38 <bridgehead renderas="sect3">Package Information</bridgehead>
39 <itemizedlist spacing="compact">
40 <listitem>
41 <para>
42 Download (HTTP): <ulink url="&xfsprogs-download-http;"/>
43 </para>
44 </listitem>
45 <listitem>
46 <para>
47 Download (FTP): <ulink url="&xfsprogs-download-ftp;"/>
48 </para>
49 </listitem>
50 <listitem>
51 <para>
52 Download MD5 sum: &xfsprogs-md5sum;
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 Download size: &xfsprogs-size;
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Estimated disk space required: &xfsprogs-buildsize;
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Estimated build time: &xfsprogs-time;
68 </para>
69 </listitem>
70 </itemizedlist>
71
72 <bridgehead renderas="sect3">xfsprogs Dependencies</bridgehead>
73
74 <bridgehead renderas="sect4">Required</bridgehead>
75 <para role="required">
76 <xref linkend="inih"/>
77 </para>
78
79 <bridgehead renderas="sect4">Optional</bridgehead>
80 <para role="optional">
81 <xref linkend="icu"/> (for unicode name scanning in xfs_scrub)
82 </para>
83
84 <para condition="html" role="usernotes">User Notes:
85 <ulink url="&blfs-wiki;/xfs"/></para>
86
87 </sect2>
88
89 <sect2 role="kernel" id="xfsprogs-kernel">
90 <title>Kernel Configuration</title>
91
92 <para>
93 Enable the following options in the kernel configuration
94 and recompile the kernel:
95 </para>
96
97<screen><literal>File systems ---&gt;
98 &lt;*/M&gt; XFS filesystem support [CONFIG_XFS_FS]</literal></screen>
99
100 <indexterm zone="xfsprogs xfsprogs-kernel">
101 <primary sortas="d-xfs">XFS Programs</primary>
102 </indexterm>
103
104 </sect2>
105
106 <sect2 role="installation">
107 <title>Installation of xfsprogs</title>
108
109 <para>
110 Install <application>xfsprogs</application> by running the following
111 commands:
112 </para>
113
114 <screen><userinput>make DEBUG=-DNDEBUG \
115 INSTALL_USER=root \
116 INSTALL_GROUP=root</userinput></screen>
117
118 <para>
119 This package does not come with a test suite.
120 </para>
121
122 <para>
123 Now, as the <systemitem class="username">root</systemitem> user:
124 </para>
125
126<screen role="root"><userinput>make PKG_DOC_DIR=/usr/share/doc/xfsprogs-&xfsprogs-version; install &amp;&amp;
127make PKG_DOC_DIR=/usr/share/doc/xfsprogs-&xfsprogs-version; install-dev &amp;&amp;
128
129rm -rfv /usr/lib/libhandle.a &amp;&amp;
130rm -rfv /lib/libhandle.{a,la,so} &amp;&amp;
131ln -sfv ../../lib/libhandle.so.1 /usr/lib/libhandle.so</userinput></screen>
132
133 </sect2>
134
135 <sect2 role="commands">
136 <title>Command Explanations</title>
137
138 <para>
139 <command>make DEBUG=-DNDEBUG</command>: Turns off debugging
140 symbols.
141 </para>
142
143 <para>
144 <parameter>INSTALL_USER=root INSTALL_GROUP=root</parameter>: This
145 sets the owner and group of the installed files.
146 </para>
147
148 <para>
149 <option>OPTIMIZER="..."</option>: Adding this parameter to
150 the end of the <command>make</command> command overrides the
151 default optimization settings.
152 </para>
153
154 </sect2>
155
156 <sect2 role="content">
157 <title>Contents</title>
158
159 <segmentedlist>
160 <segtitle>Installed Programs</segtitle>
161 <segtitle>Installed Libraries</segtitle>
162 <segtitle>Installed Directories</segtitle>
163
164 <seglistitem>
165 <seg>fsck.xfs, mkfs.xfs, xfs_admin, xfs_bmap, xfs_copy, xfs_db,
166 xfs_estimate, xfs_freeze, xfs_fsr, xfs_growfs, xfs_info, xfs_io,
167 xfs_logprint, xfs_mdrestore, xfs_metadump, xfs_mkfile, xfs_ncheck,
168 xfs_quota, xfs_repair, xfs_rtcp, xfs_scrub, xfs_scrub_all,
169 and xfs_spaceman</seg>
170 <seg>libhandle.so</seg>
171 <seg>/usr/include/xfs,
172 /usr/lib/xfsprogs, and
173 /usr/share/doc/xfsprogs-&xfsprogs-version;</seg>
174 </seglistitem>
175 </segmentedlist>
176
177 <variablelist>
178 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
179 <?dbfo list-presentation="list"?>
180 <?dbhtml list-presentation="table"?>
181
182 <varlistentry id="fsck.xfs">
183 <term><command>fsck.xfs</command></term>
184 <listitem>
185 <para>
186 simply exits with a zero status, since XFS
187 partitions are checked at mount time
188 </para>
189 <indexterm zone="xfsprogs fsck.xfs">
190 <primary sortas="b-fsck.xfs">fsck.xfs</primary>
191 </indexterm>
192 </listitem>
193 </varlistentry>
194
195 <varlistentry id="mkfs.xfs">
196 <term><command>mkfs.xfs</command></term>
197 <listitem>
198 <para>
199 constructs an XFS file system
200 </para>
201 <indexterm zone="xfsprogs mkfs.xfs">
202 <primary sortas="b-mkfs.xfs">mkfs.xfs</primary>
203 </indexterm>
204 </listitem>
205 </varlistentry>
206
207 <varlistentry id="xfs_admin">
208 <term><command>xfs_admin</command></term>
209 <listitem>
210 <para>
211 changes the parameters of an XFS file system
212 </para>
213 <indexterm zone="xfsprogs xfs_admin">
214 <primary sortas="b-xfs_admin">xfs_admin</primary>
215 </indexterm>
216 </listitem>
217 </varlistentry>
218
219 <varlistentry id="xfs_bmap">
220 <term><command>xfs_bmap</command></term>
221 <listitem>
222 <para>
223 prints block mapping for an XFS file
224 </para>
225 <indexterm zone="xfsprogs xfs_bmap">
226 <primary sortas="b-xfs_bmap">xfs_bmap</primary>
227 </indexterm>
228 </listitem>
229 </varlistentry>
230
231 <varlistentry id="xfs_copy">
232 <term><command>xfs_copy</command></term>
233 <listitem>
234 <para>
235 copies the contents of an XFS file system
236 to one or more targets in parallel
237 </para>
238 <indexterm zone="xfsprogs xfs_copy">
239 <primary sortas="b-xfs_copy">xfs_copy</primary>
240 </indexterm>
241 </listitem>
242 </varlistentry>
243
244 <varlistentry id="xfs_estimate">
245 <term><command>xfs_estimate</command></term>
246 <listitem>
247 <para>
248 for each directory argument, estimates the space that directory
249 would take if it were copied to an XFS filesystem
250 (does not cross mount points)
251 </para>
252 <indexterm zone="xfsprogs xfs_estimate">
253 <primary sortas="b-xfs_estimate">xfs_estimate</primary>
254 </indexterm>
255 </listitem>
256 </varlistentry>
257
258 <varlistentry id="xfs_db">
259 <term><command>xfs_db</command></term>
260 <listitem>
261 <para>
262 is used to debug an XFS file system
263 </para>
264 <indexterm zone="xfsprogs xfs_db">
265 <primary sortas="b-xfs_db">xfs_db</primary>
266 </indexterm>
267 </listitem>
268 </varlistentry>
269
270 <varlistentry id="xfs_freeze">
271 <term><command>xfs_freeze</command></term>
272 <listitem>
273 <para>
274 suspends access to an XFS file system
275 </para>
276 <indexterm zone="xfsprogs xfs_freeze">
277 <primary sortas="b-xfs_freeze">xfs_freeze</primary>
278 </indexterm>
279 </listitem>
280 </varlistentry>
281
282 <varlistentry id="xfs_fsr">
283 <term><command>xfs_fsr</command></term>
284 <listitem>
285 <para>
286 applicable only to XFS filesystems, improves the organization of
287 mounted filesystems, the reorganization algorithm operates on one
288 file at a time, compacting or othewise improving the layout of the
289 file extents (contiguous blocks of file data)
290 </para>
291 <indexterm zone="xfsprogs xfs_fsr">
292 <primary sortas="b-xfs_fsr">xfs_fsr</primary>
293 </indexterm>
294 </listitem>
295 </varlistentry>
296
297 <varlistentry id="xfs_growfs">
298 <term><command>xfs_growfs</command></term>
299 <listitem>
300 <para>
301 expands an XFS file system
302 </para>
303 <indexterm zone="xfsprogs xfs_growfs">
304 <primary sortas="b-xfs_growfs">xfs_growfs</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308
309 <varlistentry id="xfs_info">
310 <term><command>xfs_info</command></term>
311 <listitem>
312 <para>
313 is equivalent to invoking <command>xfs_growfs</command>, but
314 specifying that no change to the file system is to be made
315 </para>
316 <indexterm zone="xfsprogs xfs_info">
317 <primary sortas="b-xfs_info">xfs_info</primary>
318 </indexterm>
319 </listitem>
320 </varlistentry>
321
322 <varlistentry id="xfs_io">
323 <term><command>xfs_io</command></term>
324 <listitem>
325 <para>
326 is a debugging tool like <command>xfs_db</command>, but is
327 aimed at examining the regular file I/O path rather than the raw
328 XFS volume itself
329 </para>
330 <indexterm zone="xfsprogs xfs_io">
331 <primary sortas="b-xfs_io">xfs_io</primary>
332 </indexterm>
333 </listitem>
334 </varlistentry>
335
336 <varlistentry id="xfs_logprint">
337 <term><command>xfs_logprint</command></term>
338 <listitem>
339 <para>
340 prints the log of an XFS file system
341 </para>
342 <indexterm zone="xfsprogs xfs_logprint">
343 <primary sortas="b-xfs_logprint">xfs_logprint</primary>
344 </indexterm>
345 </listitem>
346 </varlistentry>
347
348 <varlistentry id="xfs_mdrestore">
349 <term><command>xfs_mdrestore</command></term>
350 <listitem>
351 <para>
352 restores an XFS metadump image to a filesystem image
353 </para>
354 <indexterm zone="xfsprogs xfs_mdrestore">
355 <primary sortas="b-xfs_mdrestore">xfs_mdrestore</primary>
356 </indexterm>
357 </listitem>
358 </varlistentry>
359
360 <varlistentry id="xfs_metadump">
361 <term><command>xfs_metadump</command></term>
362 <listitem>
363 <para>
364 copies XFS filesystem metadata to a file
365 </para>
366 <indexterm zone="xfsprogs xfs_metadump">
367 <primary sortas="b-xfs_metadump">xfs_metadump</primary>
368 </indexterm>
369 </listitem>
370 </varlistentry>
371
372 <varlistentry id="xfs_mkfile">
373 <term><command>xfs_mkfile</command></term>
374 <listitem>
375 <para>
376 creates an XFS file, padded with zeroes by default
377 </para>
378 <indexterm zone="xfsprogs xfs_mkfile">
379 <primary sortas="b-xfs_mkfile">xfs_mkfile</primary>
380 </indexterm>
381 </listitem>
382 </varlistentry>
383
384 <varlistentry id="xfs_ncheck">
385 <term><command>xfs_ncheck</command></term>
386 <listitem>
387 <para>
388 generates pathnames from inode numbers for an
389 XFS file system
390 </para>
391 <indexterm zone="xfsprogs xfs_ncheck">
392 <primary sortas="b-xfs_ncheck">xfs_ncheck</primary>
393 </indexterm>
394 </listitem>
395 </varlistentry>
396
397 <varlistentry id="xfs_quota">
398 <term><command>xfs_quota</command></term>
399 <listitem>
400 <para>
401 is a utility for reporting and editing various
402 aspects of filesystem quotas
403 </para>
404 <indexterm zone="xfsprogs xfs_quota">
405 <primary sortas="b-xfs_quota">xfs_quota</primary>
406 </indexterm>
407 </listitem>
408 </varlistentry>
409
410 <varlistentry id="xfs_repair">
411 <term><command>xfs_repair</command></term>
412 <listitem>
413 <para>
414 repairs corrupt or damaged XFS file systems
415 </para>
416 <indexterm zone="xfsprogs xfs_repair">
417 <primary sortas="b-xfs_repair">xfs_repair</primary>
418 </indexterm>
419 </listitem>
420 </varlistentry>
421
422 <varlistentry id="xfs_rtcp">
423 <term><command>xfs_rtcp</command></term>
424 <listitem>
425 <para>
426 copies a file to the real-time partition on an
427 XFS file system
428 </para>
429 <indexterm zone="xfsprogs xfs_rtcp">
430 <primary sortas="b-xfs_rtcp">xfs_rtcp</primary>
431 </indexterm>
432 </listitem>
433 </varlistentry>
434
435 <varlistentry id="xfs_scrub">
436 <term><command>xfs_scrub</command></term>
437 <listitem>
438 <para>
439 checks and repairs the contents of a mounted
440 XFS file system
441 </para>
442 <indexterm zone="xfsprogs xfs_scrub">
443 <primary sortas="b-xfs_scrub">xfs_scrub</primary>
444 </indexterm>
445 </listitem>
446 </varlistentry>
447
448 <varlistentry id="xfs_scrub_all">
449 <term><command>xfs_scrub_all</command></term>
450 <listitem>
451 <para>
452 scrubs all mounted XFS file systems
453 </para>
454 <indexterm zone="xfsprogs xfs_scrub_all">
455 <primary sortas="b-xfs_scrub_all">xfs_scrub_all</primary>
456 </indexterm>
457 </listitem>
458 </varlistentry>
459
460 <varlistentry id="xfs_spaceman">
461 <term><command>xfs_spaceman</command></term>
462 <listitem>
463 <para>
464 reports and controls free space usage in an
465 XFS file system
466 </para>
467 <indexterm zone="xfsprogs xfs_spaceman">
468 <primary sortas="b-xfs_spaceman">xfs_spaceman</primary>
469 </indexterm>
470 </listitem>
471 </varlistentry>
472
473 <varlistentry id="libhandle">
474 <term><filename class="libraryfile">libhandle.so</filename></term>
475 <listitem>
476 <para>
477 contains XFS-specific functions that provide a way to perform
478 certain filesystem operations without using a file descriptor to
479 access filesystem objects
480 </para>
481 <indexterm zone="xfsprogs libhandle">
482 <primary sortas="c-libhandle">libhandle.so</primary>
483 </indexterm>
484 </listitem>
485 </varlistentry>
486
487 </variablelist>
488
489 </sect2>
490
491</sect1>
Note: See TracBrowser for help on using the repository browser.