source: postlfs/filesystems/xfsprogs.xml@ 3b98867

10.0 10.1 11.0 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus perl-modules qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 3b98867 was 3b98867, checked in by Ken Moffat <ken@…>, 4 years ago

Fix xfs-progs for glibc-2.27.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@19764 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 13.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 "2d50e3751cc98e6c9364bc3d2297b9fd">
10 <!ENTITY xfsprogs-size "1.1 MB">
11 <!ENTITY xfsprogs-buildsize "51 MB">
12 <!ENTITY xfsprogs-time "0.6 SBU">
13]>
14
15<sect1 id="xfsprogs" xreflabel="xfsprogs-&xfsprogs-version;">
16 <?dbhtml filename="xfsprogs.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>xfsprogs-&xfsprogs-version;</title>
24
25 <indexterm zone="xfsprogs">
26 <primary sortas="a-xfsprogs">xfsprogs</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to xfsprogs</title>
31
32 <para>The <application>xfsprogs</application> package contains
33 administration and debugging tools for the XFS file system.</para>
34
35 &lfs81_checked;
36
37 <bridgehead renderas="sect3">Package Information</bridgehead>
38 <itemizedlist spacing="compact">
39 <listitem>
40 <para>Download (HTTP): <ulink url="&xfsprogs-download-http;"/></para>
41 </listitem>
42 <listitem>
43 <para>Download (FTP): <ulink url="&xfsprogs-download-ftp;"/></para>
44 </listitem>
45 <listitem>
46 <para>Download MD5 sum: &xfsprogs-md5sum;</para>
47 </listitem>
48 <listitem>
49 <para>Download size: &xfsprogs-size;</para>
50 </listitem>
51 <listitem>
52 <para>Estimated disk space required: &xfsprogs-buildsize;</para>
53 </listitem>
54 <listitem>
55 <para>Estimated build time: &xfsprogs-time;</para>
56 </listitem>
57 </itemizedlist>
58
59 <para condition="html" role="usernotes">User Notes:
60 <ulink url="&blfs-wiki;/xfs"/></para>
61
62 </sect2>
63
64 <sect2 role="kernel" id="xfsprogs-kernel">
65 <title>Kernel Configuration</title>
66
67 <para>Enable the following options in the kernel configuration
68 and recompile the kernel:</para>
69
70<screen><literal>File systems ---&gt;
71 &lt;*/M&gt; XFS filesystem support [CONFIG_XFS_FS]</literal></screen>
72
73 <indexterm zone="xfsprogs xfsprogs-kernel">
74 <primary sortas="d-xfs">XFS Programs</primary>
75 </indexterm>
76
77 </sect2>
78
79 <sect2 role="installation">
80 <title>Installation of xfsprogs</title>
81
82 <para>Install <application>xfsprogs</application> by running the following
83 commands:</para>
84
85<screen><userinput>
86sed -i '/copy_file_range(/s/copy/xfs_&amp;/' io/copy_file_range.c &amp;&amp;
87make DEBUG=-DNDEBUG INSTALL_USER=root INSTALL_GROUP=root \
88 LOCAL_CONFIGURE_OPTIONS="--enable-readline"</userinput></screen>
89
90 <para>This package does not come with a test suite.</para>
91
92 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
93
94<screen role="root"><userinput>make PKG_DOC_DIR=/usr/share/doc/xfsprogs-&xfsprogs-version; install &amp;&amp;
95make PKG_DOC_DIR=/usr/share/doc/xfsprogs-&xfsprogs-version; install-dev &amp;&amp;
96
97rm -rfv /usr/lib/libhandle.a &amp;&amp;
98rm -rfv /lib/libhandle.{a,la,so} &amp;&amp;
99ln -sfv ../../lib/libhandle.so.1 /usr/lib/libhandle.so &amp;&amp;
100sed -i "s@libdir='/lib@libdir='/usr/lib@" /usr/lib/libhandle.la</userinput></screen>
101
102 </sect2>
103
104 <sect2 role="commands">
105 <title>Command Explanations</title>
106
107 <para><command>sed -i '/copy_file_range(/s/copy/xfs_&amp;/'</command>:
108 glibc-2.27 now defines copy_file, so rename the package function.</para>
109
110 <para><command>make DEBUG=-DNDEBUG</command>: Turns off debugging
111 symbols.</para>
112
113 <para><parameter>INSTALL_USER=root INSTALL_GROUP=root</parameter>: This
114 sets the owner and group of the installed files.</para>
115
116 <para><parameter>LOCAL_CONFIGURE_OPTIONS="..."</parameter>: This passes
117 extra configuration options to the <filename>configure</filename> script.
118 The example <parameter>--enable-readline</parameter> parameter
119 enables linking the XFS programs with the
120 <filename class="libraryfile">libreadline.so</filename> library, in order
121 to allow editing interactive commands.</para>
122
123 <para><option>OPTIMIZER="..."</option>: Adding this parameter to
124 the end of the <command>make</command> command overrides the
125 default optimization settings.</para>
126
127 </sect2>
128
129 <sect2 role="content">
130 <title>Contents</title>
131
132 <segmentedlist>
133 <segtitle>Installed Programs</segtitle>
134 <segtitle>Installed Libraries</segtitle>
135 <segtitle>Installed Directories</segtitle>
136
137 <seglistitem>
138 <seg>fsck.xfs, mkfs.xfs, xfs_admin, xfs_bmap, xfs_copy, xfs_db,
139 xfs_estimate, xfs_freeze, xfs_fsr, xfs_growfs, xfs_info, xfs_io,
140 xfs_logprint, xfs_mdrestore, xfs_metadump, xfs_mkfile, xfs_ncheck,
141 xfs_quota, xfs_repair, xfs_rtcp, and xfs_spaceman</seg>
142 <seg>libhandle.so</seg>
143 <seg>/usr/include/xfs and /usr/share/doc/xfsprogs-&xfsprogs-version;</seg>
144 </seglistitem>
145 </segmentedlist>
146
147 <variablelist>
148 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
149 <?dbfo list-presentation="list"?>
150 <?dbhtml list-presentation="table"?>
151
152 <varlistentry id="fsck.xfs">
153 <term><command>fsck.xfs</command></term>
154 <listitem>
155 <para>simply exits with a zero status, since XFS
156 partitions are checked at mount time.</para>
157 <indexterm zone="xfsprogs fsck.xfs">
158 <primary sortas="b-fsck.xfs">fsck.xfs</primary>
159 </indexterm>
160 </listitem>
161 </varlistentry>
162
163 <varlistentry id="mkfs.xfs">
164 <term><command>mkfs.xfs</command></term>
165 <listitem>
166 <para>constructs an XFS file system.</para>
167 <indexterm zone="xfsprogs mkfs.xfs">
168 <primary sortas="b-mkfs.xfs">mkfs.xfs</primary>
169 </indexterm>
170 </listitem>
171 </varlistentry>
172
173 <varlistentry id="xfs_admin">
174 <term><command>xfs_admin</command></term>
175 <listitem>
176 <para>changes the parameters of an XFS file system.</para>
177 <indexterm zone="xfsprogs xfs_admin">
178 <primary sortas="b-xfs_admin">xfs_admin</primary>
179 </indexterm>
180 </listitem>
181 </varlistentry>
182
183 <varlistentry id="xfs_bmap">
184 <term><command>xfs_bmap</command></term>
185 <listitem>
186 <para>prints block mapping for an XFS file.</para>
187 <indexterm zone="xfsprogs xfs_bmap">
188 <primary sortas="b-xfs_bmap">xfs_bmap</primary>
189 </indexterm>
190 </listitem>
191 </varlistentry>
192
193 <varlistentry id="xfs_copy">
194 <term><command>xfs_copy</command></term>
195 <listitem>
196 <para>copies the contents of an XFS file system
197 to one or more targets in parallel.</para>
198 <indexterm zone="xfsprogs xfs_copy">
199 <primary sortas="b-xfs_copy">xfs_copy</primary>
200 </indexterm>
201 </listitem>
202 </varlistentry>
203
204 <varlistentry id="xfs_estimate">
205 <term><command>xfs_estimate</command></term>
206 <listitem>
207 <para>for each directory argument, estimates the space that directory
208 would take if it were copied to an XFS filesystem
209 (does not cross mount points).</para>
210 <indexterm zone="xfsprogs xfs_estimate">
211 <primary sortas="b-xfs_estimate">xfs_estimate</primary>
212 </indexterm>
213 </listitem>
214 </varlistentry>
215
216 <varlistentry id="xfs_db">
217 <term><command>xfs_db</command></term>
218 <listitem>
219 <para>is used to debug an XFS file system.</para>
220 <indexterm zone="xfsprogs xfs_db">
221 <primary sortas="b-xfs_db">xfs_db</primary>
222 </indexterm>
223 </listitem>
224 </varlistentry>
225
226 <varlistentry id="xfs_freeze">
227 <term><command>xfs_freeze</command></term>
228 <listitem>
229 <para>suspends access to an XFS file system.</para>
230 <indexterm zone="xfsprogs xfs_freeze">
231 <primary sortas="b-xfs_freeze">xfs_freeze</primary>
232 </indexterm>
233 </listitem>
234 </varlistentry>
235
236 <varlistentry id="xfs_fsr">
237 <term><command>xfs_fsr</command></term>
238 <listitem>
239 <para>applicable only to XFS filesystems, improves the organization
240 of mounted filesystems, the reorganization algorithm operates on one
241 file at a time, compacting or othewise improving the layout of the
242 file extents (contiguous blocks of file data).</para>
243 <indexterm zone="xfsprogs xfs_fsr">
244 <primary sortas="b-xfs_fsr">xfs_fsr</primary>
245 </indexterm>
246 </listitem>
247 </varlistentry>
248
249 <varlistentry id="xfs_growfs">
250 <term><command>xfs_growfs</command></term>
251 <listitem>
252 <para>expands an XFS file system.</para>
253 <indexterm zone="xfsprogs xfs_growfs">
254 <primary sortas="b-xfs_growfs">xfs_growfs</primary>
255 </indexterm>
256 </listitem>
257 </varlistentry>
258
259 <varlistentry id="xfs_info">
260 <term><command>xfs_info</command></term>
261 <listitem>
262 <para>is equivalent to invoking <command>xfs_growfs</command>, but
263 specifying that no change to the file system is to be made.</para>
264 <indexterm zone="xfsprogs xfs_info">
265 <primary sortas="b-xfs_info">xfs_info</primary>
266 </indexterm>
267 </listitem>
268 </varlistentry>
269
270 <varlistentry id="xfs_io">
271 <term><command>xfs_io</command></term>
272 <listitem>
273 <para>is a debugging tool like <command>xfs_db</command>, but is
274 aimed at examining the regular file I/O path rather than the raw
275 XFS volume itself.</para>
276 <indexterm zone="xfsprogs xfs_io">
277 <primary sortas="b-xfs_io">xfs_io</primary>
278 </indexterm>
279 </listitem>
280 </varlistentry>
281
282 <varlistentry id="xfs_logprint">
283 <term><command>xfs_logprint</command></term>
284 <listitem>
285 <para>prints the log of an XFS file system.</para>
286 <indexterm zone="xfsprogs xfs_logprint">
287 <primary sortas="b-xfs_logprint">xfs_logprint</primary>
288 </indexterm>
289 </listitem>
290 </varlistentry>
291
292 <varlistentry id="xfs_mdrestore">
293 <term><command>xfs_mdrestore</command></term>
294 <listitem>
295 <para>restores an XFS metadump image to a filesystem image.</para>
296 <indexterm zone="xfsprogs xfs_mdrestore">
297 <primary sortas="b-xfs_mdrestore">xfs_mdrestore</primary>
298 </indexterm>
299 </listitem>
300 </varlistentry>
301
302 <varlistentry id="xfs_metadump">
303 <term><command>xfs_metadump</command></term>
304 <listitem>
305 <para>copies XFS filesystem metadata to a file.</para>
306 <indexterm zone="xfsprogs xfs_metadump">
307 <primary sortas="b-xfs_metadump">xfs_metadump</primary>
308 </indexterm>
309 </listitem>
310 </varlistentry>
311
312 <varlistentry id="xfs_mkfile">
313 <term><command>xfs_mkfile</command></term>
314 <listitem>
315 <para>creates an XFS file, padded with zeroes by default.</para>
316 <indexterm zone="xfsprogs xfs_mkfile">
317 <primary sortas="b-xfs_mkfile">xfs_mkfile</primary>
318 </indexterm>
319 </listitem>
320 </varlistentry>
321
322 <varlistentry id="xfs_ncheck">
323 <term><command>xfs_ncheck</command></term>
324 <listitem>
325 <para>generates pathnames from inode numbers for an
326 XFS file system.</para>
327 <indexterm zone="xfsprogs xfs_ncheck">
328 <primary sortas="b-xfs_ncheck">xfs_ncheck</primary>
329 </indexterm>
330 </listitem>
331 </varlistentry>
332
333 <varlistentry id="xfs_quota">
334 <term><command>xfs_quota</command></term>
335 <listitem>
336 <para>is a utility for reporting and editing various
337 aspects of filesystem quota.</para>
338 <indexterm zone="xfsprogs xfs_quota">
339 <primary sortas="b-xfs_quota">xfs_quota</primary>
340 </indexterm>
341 </listitem>
342 </varlistentry>
343
344 <varlistentry id="xfs_repair">
345 <term><command>xfs_repair</command></term>
346 <listitem>
347 <para>repairs corrupt or damaged XFS file systems.</para>
348 <indexterm zone="xfsprogs xfs_repair">
349 <primary sortas="b-xfs_repair">xfs_repair</primary>
350 </indexterm>
351 </listitem>
352 </varlistentry>
353
354 <varlistentry id="xfs_rtcp">
355 <term><command>xfs_rtcp</command></term>
356 <listitem>
357 <para>copies a file to the real-time partition on an
358 XFS file system.</para>
359 <indexterm zone="xfsprogs xfs_rtcp">
360 <primary sortas="b-xfs_rtcp">xfs_rtcp</primary>
361 </indexterm>
362 </listitem>
363 </varlistentry>
364
365 <varlistentry id="xfs_spaceman">
366 <term><command>xfs_spaceman</command></term>
367 <listitem>
368 <para>reports and controls free space usage in an
369 XFS file system.</para>
370 <indexterm zone="xfsprogs xfs_spaceman">
371 <primary sortas="b-xfs_spaceman">xfs_spaceman</primary>
372 </indexterm>
373 </listitem>
374 </varlistentry>
375
376 <varlistentry id="libhandle">
377 <term><filename class="libraryfile">libhandle.so</filename></term>
378 <listitem>
379 <para>contains XFS-specific functions that provide a way to perform
380 certain filesystem operations without using a file descriptor to
381 access filesystem objects.</para>
382 <indexterm zone="xfsprogs libhandle">
383 <primary sortas="c-libhandle">libhandle.so</primary>
384 </indexterm>
385 </listitem>
386 </varlistentry>
387
388 </variablelist>
389
390 </sect2>
391
392</sect1>
Note: See TracBrowser for help on using the repository browser.