source: postlfs/filesystems/xfsprogs.xml@ 09601d11

12.1 ken/TL2024 lazarus plabs/newcss python3.11 rahul/power-profiles-daemon trunk xry111/llvm18
Last change on this file since 09601d11 was 11eb541b, checked in by Bruce Dubbs <bdubbs@…>, 7 months ago

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