source: postlfs/filesystems/xfsprogs.xml@ b1a8c0e8

12.0 12.1 gimp3 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/for-12.3 xry111/llvm18 xry111/spidermonkey128 xry111/xf86-video-removal
Last change on this file since b1a8c0e8 was e2ebccab, checked in by Douglas R. Reno <renodr@…>, 14 months ago

Fix building xfsprogs-6.3.0 with gettext-0.22.

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