source: postlfs/filesystems/xfsprogs.xml@ 60e8d690

12.0 12.1 kea ken/TL2024 ken/tuningfonts lazarus lxqt plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since 60e8d690 was 6252ce9, checked in by Pierre Labastie <pierre.labastie@…>, 12 months ago

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