source: postlfs/filesystems/xfsprogs.xml

trunk
Last change on this file was 868811b, checked in by Bruce Dubbs <bdubbs@…>, 2 months ago

Many tags.
genutils
sysutils
netlibs
netprogs
netutils
editors
filesystems
shells

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