source: postlfs/filesystems/xfsprogs.xml@ cfde9651

12.0 12.1 kea ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since cfde9651 was 14891a90, checked in by Xi Ruoyao <xry111@…>, 11 months ago

treewide: More "User Notes" clean up

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