source: postlfs/filesystems/xfsprogs.xml@ 3867d8ee

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 3867d8ee was 3867d8ee, checked in by Bruce Dubbs <bdubbs@…>, 4 years ago

Update to expect-5.45.5.

Remove elfutils. The library is all that is
needed and that is now in LFS.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@19787 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 &lfs82_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>sed -i '/copy_file_range(/s/copy/xfs_&amp;/' io/copy_file_range.c &amp;&amp;
86make DEBUG=-DNDEBUG INSTALL_USER=root INSTALL_GROUP=root \
87 LOCAL_CONFIGURE_OPTIONS="--enable-readline"</userinput></screen>
88
89 <para>This package does not come with a test suite.</para>
90
91 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
92
93<screen role="root"><userinput>make PKG_DOC_DIR=/usr/share/doc/xfsprogs-&xfsprogs-version; install &amp;&amp;
94make PKG_DOC_DIR=/usr/share/doc/xfsprogs-&xfsprogs-version; install-dev &amp;&amp;
95
96rm -rfv /usr/lib/libhandle.a &amp;&amp;
97rm -rfv /lib/libhandle.{a,la,so} &amp;&amp;
98ln -sfv ../../lib/libhandle.so.1 /usr/lib/libhandle.so &amp;&amp;
99sed -i "s@libdir='/lib@libdir='/usr/lib@" /usr/lib/libhandle.la</userinput></screen>
100
101 </sect2>
102
103 <sect2 role="commands">
104 <title>Command Explanations</title>
105
106 <para><command>sed -i '/copy_file_range(/s/copy/xfs_&amp;/'</command>:
107 glibc-2.27 now defines copy_file, so rename the package function.</para>
108
109 <para><command>make DEBUG=-DNDEBUG</command>: Turns off debugging
110 symbols.</para>
111
112 <para><parameter>INSTALL_USER=root INSTALL_GROUP=root</parameter>: This
113 sets the owner and group of the installed files.</para>
114
115 <para><parameter>LOCAL_CONFIGURE_OPTIONS="..."</parameter>: This passes
116 extra configuration options to the <filename>configure</filename> script.
117 The example <parameter>--enable-readline</parameter> parameter
118 enables linking the XFS programs with the
119 <filename class="libraryfile">libreadline.so</filename> library, in order
120 to allow editing interactive commands.</para>
121
122 <para><option>OPTIMIZER="..."</option>: Adding this parameter to
123 the end of the <command>make</command> command overrides the
124 default optimization settings.</para>
125
126 </sect2>
127
128 <sect2 role="content">
129 <title>Contents</title>
130
131 <segmentedlist>
132 <segtitle>Installed Programs</segtitle>
133 <segtitle>Installed Libraries</segtitle>
134 <segtitle>Installed Directories</segtitle>
135
136 <seglistitem>
137 <seg>fsck.xfs, mkfs.xfs, xfs_admin, xfs_bmap, xfs_copy, xfs_db,
138 xfs_estimate, xfs_freeze, xfs_fsr, xfs_growfs, xfs_info, xfs_io,
139 xfs_logprint, xfs_mdrestore, xfs_metadump, xfs_mkfile, xfs_ncheck,
140 xfs_quota, xfs_repair, xfs_rtcp, and xfs_spaceman</seg>
141 <seg>libhandle.so</seg>
142 <seg>/usr/include/xfs and /usr/share/doc/xfsprogs-&xfsprogs-version;</seg>
143 </seglistitem>
144 </segmentedlist>
145
146 <variablelist>
147 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
148 <?dbfo list-presentation="list"?>
149 <?dbhtml list-presentation="table"?>
150
151 <varlistentry id="fsck.xfs">
152 <term><command>fsck.xfs</command></term>
153 <listitem>
154 <para>simply exits with a zero status, since XFS
155 partitions are checked at mount time.</para>
156 <indexterm zone="xfsprogs fsck.xfs">
157 <primary sortas="b-fsck.xfs">fsck.xfs</primary>
158 </indexterm>
159 </listitem>
160 </varlistentry>
161
162 <varlistentry id="mkfs.xfs">
163 <term><command>mkfs.xfs</command></term>
164 <listitem>
165 <para>constructs an XFS file system.</para>
166 <indexterm zone="xfsprogs mkfs.xfs">
167 <primary sortas="b-mkfs.xfs">mkfs.xfs</primary>
168 </indexterm>
169 </listitem>
170 </varlistentry>
171
172 <varlistentry id="xfs_admin">
173 <term><command>xfs_admin</command></term>
174 <listitem>
175 <para>changes the parameters of an XFS file system.</para>
176 <indexterm zone="xfsprogs xfs_admin">
177 <primary sortas="b-xfs_admin">xfs_admin</primary>
178 </indexterm>
179 </listitem>
180 </varlistentry>
181
182 <varlistentry id="xfs_bmap">
183 <term><command>xfs_bmap</command></term>
184 <listitem>
185 <para>prints block mapping for an XFS file.</para>
186 <indexterm zone="xfsprogs xfs_bmap">
187 <primary sortas="b-xfs_bmap">xfs_bmap</primary>
188 </indexterm>
189 </listitem>
190 </varlistentry>
191
192 <varlistentry id="xfs_copy">
193 <term><command>xfs_copy</command></term>
194 <listitem>
195 <para>copies the contents of an XFS file system
196 to one or more targets in parallel.</para>
197 <indexterm zone="xfsprogs xfs_copy">
198 <primary sortas="b-xfs_copy">xfs_copy</primary>
199 </indexterm>
200 </listitem>
201 </varlistentry>
202
203 <varlistentry id="xfs_estimate">
204 <term><command>xfs_estimate</command></term>
205 <listitem>
206 <para>for each directory argument, estimates the space that directory
207 would take if it were copied to an XFS filesystem
208 (does not cross mount points).</para>
209 <indexterm zone="xfsprogs xfs_estimate">
210 <primary sortas="b-xfs_estimate">xfs_estimate</primary>
211 </indexterm>
212 </listitem>
213 </varlistentry>
214
215 <varlistentry id="xfs_db">
216 <term><command>xfs_db</command></term>
217 <listitem>
218 <para>is used to debug an XFS file system.</para>
219 <indexterm zone="xfsprogs xfs_db">
220 <primary sortas="b-xfs_db">xfs_db</primary>
221 </indexterm>
222 </listitem>
223 </varlistentry>
224
225 <varlistentry id="xfs_freeze">
226 <term><command>xfs_freeze</command></term>
227 <listitem>
228 <para>suspends access to an XFS file system.</para>
229 <indexterm zone="xfsprogs xfs_freeze">
230 <primary sortas="b-xfs_freeze">xfs_freeze</primary>
231 </indexterm>
232 </listitem>
233 </varlistentry>
234
235 <varlistentry id="xfs_fsr">
236 <term><command>xfs_fsr</command></term>
237 <listitem>
238 <para>applicable only to XFS filesystems, improves the organization
239 of mounted filesystems, the reorganization algorithm operates on one
240 file at a time, compacting or othewise improving the layout of the
241 file extents (contiguous blocks of file data).</para>
242 <indexterm zone="xfsprogs xfs_fsr">
243 <primary sortas="b-xfs_fsr">xfs_fsr</primary>
244 </indexterm>
245 </listitem>
246 </varlistentry>
247
248 <varlistentry id="xfs_growfs">
249 <term><command>xfs_growfs</command></term>
250 <listitem>
251 <para>expands an XFS file system.</para>
252 <indexterm zone="xfsprogs xfs_growfs">
253 <primary sortas="b-xfs_growfs">xfs_growfs</primary>
254 </indexterm>
255 </listitem>
256 </varlistentry>
257
258 <varlistentry id="xfs_info">
259 <term><command>xfs_info</command></term>
260 <listitem>
261 <para>is equivalent to invoking <command>xfs_growfs</command>, but
262 specifying that no change to the file system is to be made.</para>
263 <indexterm zone="xfsprogs xfs_info">
264 <primary sortas="b-xfs_info">xfs_info</primary>
265 </indexterm>
266 </listitem>
267 </varlistentry>
268
269 <varlistentry id="xfs_io">
270 <term><command>xfs_io</command></term>
271 <listitem>
272 <para>is a debugging tool like <command>xfs_db</command>, but is
273 aimed at examining the regular file I/O path rather than the raw
274 XFS volume itself.</para>
275 <indexterm zone="xfsprogs xfs_io">
276 <primary sortas="b-xfs_io">xfs_io</primary>
277 </indexterm>
278 </listitem>
279 </varlistentry>
280
281 <varlistentry id="xfs_logprint">
282 <term><command>xfs_logprint</command></term>
283 <listitem>
284 <para>prints the log of an XFS file system.</para>
285 <indexterm zone="xfsprogs xfs_logprint">
286 <primary sortas="b-xfs_logprint">xfs_logprint</primary>
287 </indexterm>
288 </listitem>
289 </varlistentry>
290
291 <varlistentry id="xfs_mdrestore">
292 <term><command>xfs_mdrestore</command></term>
293 <listitem>
294 <para>restores an XFS metadump image to a filesystem image.</para>
295 <indexterm zone="xfsprogs xfs_mdrestore">
296 <primary sortas="b-xfs_mdrestore">xfs_mdrestore</primary>
297 </indexterm>
298 </listitem>
299 </varlistentry>
300
301 <varlistentry id="xfs_metadump">
302 <term><command>xfs_metadump</command></term>
303 <listitem>
304 <para>copies XFS filesystem metadata to a file.</para>
305 <indexterm zone="xfsprogs xfs_metadump">
306 <primary sortas="b-xfs_metadump">xfs_metadump</primary>
307 </indexterm>
308 </listitem>
309 </varlistentry>
310
311 <varlistentry id="xfs_mkfile">
312 <term><command>xfs_mkfile</command></term>
313 <listitem>
314 <para>creates an XFS file, padded with zeroes by default.</para>
315 <indexterm zone="xfsprogs xfs_mkfile">
316 <primary sortas="b-xfs_mkfile">xfs_mkfile</primary>
317 </indexterm>
318 </listitem>
319 </varlistentry>
320
321 <varlistentry id="xfs_ncheck">
322 <term><command>xfs_ncheck</command></term>
323 <listitem>
324 <para>generates pathnames from inode numbers for an
325 XFS file system.</para>
326 <indexterm zone="xfsprogs xfs_ncheck">
327 <primary sortas="b-xfs_ncheck">xfs_ncheck</primary>
328 </indexterm>
329 </listitem>
330 </varlistentry>
331
332 <varlistentry id="xfs_quota">
333 <term><command>xfs_quota</command></term>
334 <listitem>
335 <para>is a utility for reporting and editing various
336 aspects of filesystem quota.</para>
337 <indexterm zone="xfsprogs xfs_quota">
338 <primary sortas="b-xfs_quota">xfs_quota</primary>
339 </indexterm>
340 </listitem>
341 </varlistentry>
342
343 <varlistentry id="xfs_repair">
344 <term><command>xfs_repair</command></term>
345 <listitem>
346 <para>repairs corrupt or damaged XFS file systems.</para>
347 <indexterm zone="xfsprogs xfs_repair">
348 <primary sortas="b-xfs_repair">xfs_repair</primary>
349 </indexterm>
350 </listitem>
351 </varlistentry>
352
353 <varlistentry id="xfs_rtcp">
354 <term><command>xfs_rtcp</command></term>
355 <listitem>
356 <para>copies a file to the real-time partition on an
357 XFS file system.</para>
358 <indexterm zone="xfsprogs xfs_rtcp">
359 <primary sortas="b-xfs_rtcp">xfs_rtcp</primary>
360 </indexterm>
361 </listitem>
362 </varlistentry>
363
364 <varlistentry id="xfs_spaceman">
365 <term><command>xfs_spaceman</command></term>
366 <listitem>
367 <para>reports and controls free space usage in an
368 XFS file system.</para>
369 <indexterm zone="xfsprogs xfs_spaceman">
370 <primary sortas="b-xfs_spaceman">xfs_spaceman</primary>
371 </indexterm>
372 </listitem>
373 </varlistentry>
374
375 <varlistentry id="libhandle">
376 <term><filename class="libraryfile">libhandle.so</filename></term>
377 <listitem>
378 <para>contains XFS-specific functions that provide a way to perform
379 certain filesystem operations without using a file descriptor to
380 access filesystem objects.</para>
381 <indexterm zone="xfsprogs libhandle">
382 <primary sortas="c-libhandle">libhandle.so</primary>
383 </indexterm>
384 </listitem>
385 </varlistentry>
386
387 </variablelist>
388
389 </sect2>
390
391</sect1>
Note: See TracBrowser for help on using the repository browser.