source: postlfs/filesystems/xfsprogs.xml@ c292bc08

10.0 10.1 11.0 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since c292bc08 was c292bc08, checked in by Bruce Dubbs <bdubbs@…>, 19 months ago

Update to xfsprogs-5.6.0

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@22998 af4574ff-66df-0310-9fd7-8a98e5e911e0

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