source: postlfs/filesystems/xfsprogs.xml@ cfc1f98

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 cfc1f98 was cfc1f98, checked in by Pierre Labastie <pieere@…>, 14 months ago

cups-filters-1.28.1
mercurial-5.5.1
php-7.4.10
gspell-1.8.4
amtk-5.1.2
gtk+-3.24.23
at-spi2-core-2.36.1
gnutls-3.6.15
xfsprogs-5.8.0
js-68.12.0

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

  • Property mode set to 100644
File size: 14.6 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 "8227438c870493f95613b3d9c5e3fa2a">
10 <!ENTITY xfsprogs-size "1.2 MB">
11 <!ENTITY xfsprogs-buildsize "84 MB">
12 <!ENTITY xfsprogs-time "0.2 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 &lfs10_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</userinput></screen>
106
107 <para>
108 This package does not come with a test suite.
109 </para>
110
111 <para>
112 Now, as the <systemitem class="username">root</systemitem> user:
113 </para>
114
115<screen role="root"><userinput>make PKG_DOC_DIR=/usr/share/doc/xfsprogs-&xfsprogs-version; install &amp;&amp;
116make PKG_DOC_DIR=/usr/share/doc/xfsprogs-&xfsprogs-version; install-dev &amp;&amp;
117
118rm -rfv /usr/lib/libhandle.a &amp;&amp;
119rm -rfv /lib/libhandle.{a,la,so} &amp;&amp;
120ln -sfv ../../lib/libhandle.so.1 /usr/lib/libhandle.so</userinput></screen>
121
122 </sect2>
123
124 <sect2 role="commands">
125 <title>Command Explanations</title>
126
127 <para>
128 <command>make DEBUG=-DNDEBUG</command>: Turns off debugging
129 symbols.
130 </para>
131
132 <para>
133 <parameter>INSTALL_USER=root INSTALL_GROUP=root</parameter>: This
134 sets the owner and group of the installed files.
135 </para>
136
137 <para>
138 <option>OPTIMIZER="..."</option>: Adding this parameter to
139 the end of the <command>make</command> command overrides the
140 default optimization settings.
141 </para>
142
143 </sect2>
144
145 <sect2 role="content">
146 <title>Contents</title>
147
148 <segmentedlist>
149 <segtitle>Installed Programs</segtitle>
150 <segtitle>Installed Libraries</segtitle>
151 <segtitle>Installed Directories</segtitle>
152
153 <seglistitem>
154 <seg>fsck.xfs, mkfs.xfs, xfs_admin, xfs_bmap, xfs_copy, xfs_db,
155 xfs_estimate, xfs_freeze, xfs_fsr, xfs_growfs, xfs_info, xfs_io,
156 xfs_logprint, xfs_mdrestore, xfs_metadump, xfs_mkfile, xfs_ncheck,
157 xfs_quota, xfs_repair, xfs_rtcp, xfs_scrub, xfs_scrub_all,
158 and xfs_spaceman</seg>
159 <seg>libhandle.so</seg>
160 <seg>/usr/include/xfs,
161 /usr/lib/xfsprogs, and
162 /usr/share/doc/xfsprogs-&xfsprogs-version;</seg>
163 </seglistitem>
164 </segmentedlist>
165
166 <variablelist>
167 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
168 <?dbfo list-presentation="list"?>
169 <?dbhtml list-presentation="table"?>
170
171 <varlistentry id="fsck.xfs">
172 <term><command>fsck.xfs</command></term>
173 <listitem>
174 <para>
175 simply exits with a zero status, since XFS
176 partitions are checked at mount time.
177 </para>
178 <indexterm zone="xfsprogs fsck.xfs">
179 <primary sortas="b-fsck.xfs">fsck.xfs</primary>
180 </indexterm>
181 </listitem>
182 </varlistentry>
183
184 <varlistentry id="mkfs.xfs">
185 <term><command>mkfs.xfs</command></term>
186 <listitem>
187 <para>
188 constructs an XFS file system.
189 </para>
190 <indexterm zone="xfsprogs mkfs.xfs">
191 <primary sortas="b-mkfs.xfs">mkfs.xfs</primary>
192 </indexterm>
193 </listitem>
194 </varlistentry>
195
196 <varlistentry id="xfs_admin">
197 <term><command>xfs_admin</command></term>
198 <listitem>
199 <para>
200 changes the parameters of an XFS file system.
201 </para>
202 <indexterm zone="xfsprogs xfs_admin">
203 <primary sortas="b-xfs_admin">xfs_admin</primary>
204 </indexterm>
205 </listitem>
206 </varlistentry>
207
208 <varlistentry id="xfs_bmap">
209 <term><command>xfs_bmap</command></term>
210 <listitem>
211 <para>
212 prints block mapping for an XFS file.
213 </para>
214 <indexterm zone="xfsprogs xfs_bmap">
215 <primary sortas="b-xfs_bmap">xfs_bmap</primary>
216 </indexterm>
217 </listitem>
218 </varlistentry>
219
220 <varlistentry id="xfs_copy">
221 <term><command>xfs_copy</command></term>
222 <listitem>
223 <para>
224 copies the contents of an XFS file system
225 to one or more targets in parallel.
226 </para>
227 <indexterm zone="xfsprogs xfs_copy">
228 <primary sortas="b-xfs_copy">xfs_copy</primary>
229 </indexterm>
230 </listitem>
231 </varlistentry>
232
233 <varlistentry id="xfs_estimate">
234 <term><command>xfs_estimate</command></term>
235 <listitem>
236 <para>
237 for each directory argument, estimates the space that directory
238 would take if it were copied to an XFS filesystem
239 (does not cross mount points).
240 </para>
241 <indexterm zone="xfsprogs xfs_estimate">
242 <primary sortas="b-xfs_estimate">xfs_estimate</primary>
243 </indexterm>
244 </listitem>
245 </varlistentry>
246
247 <varlistentry id="xfs_db">
248 <term><command>xfs_db</command></term>
249 <listitem>
250 <para>
251 is used to debug an XFS file system.
252 </para>
253 <indexterm zone="xfsprogs xfs_db">
254 <primary sortas="b-xfs_db">xfs_db</primary>
255 </indexterm>
256 </listitem>
257 </varlistentry>
258
259 <varlistentry id="xfs_freeze">
260 <term><command>xfs_freeze</command></term>
261 <listitem>
262 <para>
263 suspends access to an XFS file system.
264 </para>
265 <indexterm zone="xfsprogs xfs_freeze">
266 <primary sortas="b-xfs_freeze">xfs_freeze</primary>
267 </indexterm>
268 </listitem>
269 </varlistentry>
270
271 <varlistentry id="xfs_fsr">
272 <term><command>xfs_fsr</command></term>
273 <listitem>
274 <para>
275 applicable only to XFS filesystems, improves the organization of
276 mounted filesystems, the reorganization algorithm operates on one
277 file at a time, compacting or othewise improving the layout of the
278 file extents (contiguous blocks of file data).
279 </para>
280 <indexterm zone="xfsprogs xfs_fsr">
281 <primary sortas="b-xfs_fsr">xfs_fsr</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 <varlistentry id="xfs_growfs">
287 <term><command>xfs_growfs</command></term>
288 <listitem>
289 <para>
290 expands an XFS file system.
291 </para>
292 <indexterm zone="xfsprogs xfs_growfs">
293 <primary sortas="b-xfs_growfs">xfs_growfs</primary>
294 </indexterm>
295 </listitem>
296 </varlistentry>
297
298 <varlistentry id="xfs_info">
299 <term><command>xfs_info</command></term>
300 <listitem>
301 <para>
302 is equivalent to invoking <command>xfs_growfs</command>, but
303 specifying that no change to the file system is to be made.
304 </para>
305 <indexterm zone="xfsprogs xfs_info">
306 <primary sortas="b-xfs_info">xfs_info</primary>
307 </indexterm>
308 </listitem>
309 </varlistentry>
310
311 <varlistentry id="xfs_io">
312 <term><command>xfs_io</command></term>
313 <listitem>
314 <para>
315 is a debugging tool like <command>xfs_db</command>, but is
316 aimed at examining the regular file I/O path rather than the raw
317 XFS volume itself.
318 </para>
319 <indexterm zone="xfsprogs xfs_io">
320 <primary sortas="b-xfs_io">xfs_io</primary>
321 </indexterm>
322 </listitem>
323 </varlistentry>
324
325 <varlistentry id="xfs_logprint">
326 <term><command>xfs_logprint</command></term>
327 <listitem>
328 <para>
329 prints the log of an XFS file system.
330 </para>
331 <indexterm zone="xfsprogs xfs_logprint">
332 <primary sortas="b-xfs_logprint">xfs_logprint</primary>
333 </indexterm>
334 </listitem>
335 </varlistentry>
336
337 <varlistentry id="xfs_mdrestore">
338 <term><command>xfs_mdrestore</command></term>
339 <listitem>
340 <para>
341 restores an XFS metadump image to a filesystem image.
342 </para>
343 <indexterm zone="xfsprogs xfs_mdrestore">
344 <primary sortas="b-xfs_mdrestore">xfs_mdrestore</primary>
345 </indexterm>
346 </listitem>
347 </varlistentry>
348
349 <varlistentry id="xfs_metadump">
350 <term><command>xfs_metadump</command></term>
351 <listitem>
352 <para>
353 copies XFS filesystem metadata to a file.
354 </para>
355 <indexterm zone="xfsprogs xfs_metadump">
356 <primary sortas="b-xfs_metadump">xfs_metadump</primary>
357 </indexterm>
358 </listitem>
359 </varlistentry>
360
361 <varlistentry id="xfs_mkfile">
362 <term><command>xfs_mkfile</command></term>
363 <listitem>
364 <para>
365 creates an XFS file, padded with zeroes by default.
366 </para>
367 <indexterm zone="xfsprogs xfs_mkfile">
368 <primary sortas="b-xfs_mkfile">xfs_mkfile</primary>
369 </indexterm>
370 </listitem>
371 </varlistentry>
372
373 <varlistentry id="xfs_ncheck">
374 <term><command>xfs_ncheck</command></term>
375 <listitem>
376 <para>
377 generates pathnames from inode numbers for an
378 XFS file system.
379 </para>
380 <indexterm zone="xfsprogs xfs_ncheck">
381 <primary sortas="b-xfs_ncheck">xfs_ncheck</primary>
382 </indexterm>
383 </listitem>
384 </varlistentry>
385
386 <varlistentry id="xfs_quota">
387 <term><command>xfs_quota</command></term>
388 <listitem>
389 <para>
390 is a utility for reporting and editing various
391 aspects of filesystem quota.
392 </para>
393 <indexterm zone="xfsprogs xfs_quota">
394 <primary sortas="b-xfs_quota">xfs_quota</primary>
395 </indexterm>
396 </listitem>
397 </varlistentry>
398
399 <varlistentry id="xfs_repair">
400 <term><command>xfs_repair</command></term>
401 <listitem>
402 <para>
403 repairs corrupt or damaged XFS file systems.
404 </para>
405 <indexterm zone="xfsprogs xfs_repair">
406 <primary sortas="b-xfs_repair">xfs_repair</primary>
407 </indexterm>
408 </listitem>
409 </varlistentry>
410
411 <varlistentry id="xfs_rtcp">
412 <term><command>xfs_rtcp</command></term>
413 <listitem>
414 <para>
415 copies a file to the real-time partition on an
416 XFS file system.
417 </para>
418 <indexterm zone="xfsprogs xfs_rtcp">
419 <primary sortas="b-xfs_rtcp">xfs_rtcp</primary>
420 </indexterm>
421 </listitem>
422 </varlistentry>
423
424 <varlistentry id="xfs_scrub">
425 <term><command>xfs_scrub</command></term>
426 <listitem>
427 <para>
428 checks and repairs the contents of a mounted
429 XFS file system.
430 </para>
431 <indexterm zone="xfsprogs xfs_scrub">
432 <primary sortas="b-xfs_scrub">xfs_scrub</primary>
433 </indexterm>
434 </listitem>
435 </varlistentry>
436
437 <varlistentry id="xfs_scrub_all">
438 <term><command>xfs_scrub_all</command></term>
439 <listitem>
440 <para>
441 scrubs all mounted XFS file systems.
442 </para>
443 <indexterm zone="xfsprogs xfs_scrub_all">
444 <primary sortas="b-xfs_scrub_all">xfs_scrub_all</primary>
445 </indexterm>
446 </listitem>
447 </varlistentry>
448
449 <varlistentry id="xfs_spaceman">
450 <term><command>xfs_spaceman</command></term>
451 <listitem>
452 <para>
453 reports and controls free space usage in an
454 XFS file system.
455 </para>
456 <indexterm zone="xfsprogs xfs_spaceman">
457 <primary sortas="b-xfs_spaceman">xfs_spaceman</primary>
458 </indexterm>
459 </listitem>
460 </varlistentry>
461
462 <varlistentry id="libhandle">
463 <term><filename class="libraryfile">libhandle.so</filename></term>
464 <listitem>
465 <para>
466 contains XFS-specific functions that provide a way to perform
467 certain filesystem operations without using a file descriptor to
468 access filesystem objects.
469 </para>
470 <indexterm zone="xfsprogs libhandle">
471 <primary sortas="c-libhandle">libhandle.so</primary>
472 </indexterm>
473 </listitem>
474 </varlistentry>
475
476 </variablelist>
477
478 </sect2>
479
480</sect1>
Note: See TracBrowser for help on using the repository browser.