source: postlfs/filesystems/xfsprogs.xml@ 50ab38f

trunk
Last change on this file since 50ab38f was 50ab38f, checked in by Bruce Dubbs <bdubbs@…>, 2 months ago

Update packages
Update to xfsprogs-5.12.0.
Update to libgusb-0.3.7.
Update to inkscape-1.1.

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