source: postlfs/filesystems/xfsprogs.xml@ 5431aad

11.1 lazarus qt5new trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since 5431aad was 5431aad, checked in by Bruce Dubbs <bdubbs@…>, 9 months ago

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