source: postlfs/filesystems/xfs.xml@ ec64d28

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts krejzi/svn lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since ec64d28 was 91be7ab, checked in by Krejzi <krejzi@…>, 12 years ago

Fix changelog typo, fix xfsprogs download link and mark reiserfsprogs and jfsutils as 72built.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@10799 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 12.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 "&sources-anduin-http;/x/xfsprogs-&xfsprogs-version;.tar.gz">
8 <!ENTITY xfsprogs-download-ftp " ">
9 <!ENTITY xfsprogs-md5sum "f70b2e7200d4c29f0af1cf70e7be1db6">
10 <!ENTITY xfsprogs-size "1.3 MB">
11 <!ENTITY xfsprogs-buildsize "40 MB">
12 <!ENTITY xfsprogs-time "0.5 SBU">
13]>
14
15<sect1 id="xfs" xreflabel="xfsprogs-&xfsprogs-version;">
16 <?dbhtml filename="xfsfs.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="xfs">
26 <primary sortas="a-XFS">XFS</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to xfsprogs</title>
31
32 <para>The <application>xfsprogs</application> package contains administration
33 and debugging tools for the XFS file system.</para>
34
35 &lfs72_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 <caution><para>The XFS developers regularly remove the current
60 package when a new package is available. Unfortunately, this has led to
61 severe incompatibilities, including
62 <ulink url="http://bugs.debian.org/465737">unmountable filesystems</ulink>,
63 due to kernel version requirements in new versions of the package. Using a
64 version not in the book is strongly discouraged. Additional information,
65 is available at the
66 <ulink url="http://oss.sgi.com/projects/xfs/">XFS</ulink> project
67 page.</para></caution>
68
69<!-- For more information on this problem, see this thread on BLFS-Dev
70 http://linuxfromscratch.org/pipermail/blfs-dev/2008-March/018311.html
71-->
72 <para condition="html" role="usernotes">User Notes:
73 <ulink url="&blfs-wiki;/xfs"/></para>
74
75 </sect2>
76
77 <sect2 role="kernel" id='xfs-kernel'>
78 <title>Kernel Configuration</title>
79
80 <para>Enable the following options in the kernel configuration
81 and recompile the kernel:</para>
82
83<screen><literal>File Systems:
84 XFS filesystem support: M or Y</literal></screen>
85
86 <indexterm zone="xfs xfs-kernel">
87 <primary sortas="d-xfs">XFS Programs</primary>
88 </indexterm>
89
90 </sect2>
91
92 <sect2 role="installation">
93 <title>Installation of xfsprogs</title>
94
95 <para>Install <application>xfsprogs</application> by running the following
96 commands:</para>
97
98<screen><userinput>make DEBUG=-DNDEBUG INSTALL_USER=root INSTALL_GROUP=root \
99 LOCAL_CONFIGURE_OPTIONS="--enable-readline=yes"</userinput></screen>
100
101 <para>This package does not come with a test suite.</para>
102
103 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
104
105<screen role="root"><userinput>make install &amp;&amp;
106make install-dev &amp;&amp;
107chmod -v 755 /lib/libhandle.so.1.*</userinput></screen>
108
109 </sect2>
110
111 <sect2 role="commands">
112 <title>Command Explanations</title>
113
114 <para><command>make DEBUG=-DNDEBUG</command>: Turns off debugging
115 symbols.</para>
116
117 <para><parameter>INSTALL_USER=root INSTALL_GROUP=root</parameter>: This
118 sets the owner and group of the installed files.</para>
119
120 <para><parameter>LOCAL_CONFIGURE_OPTIONS="..."</parameter>: This passes
121 extra configuration options to the <filename>configure</filename> script.
122 The example <parameter>--enable-readline=yes</parameter> parameter
123 enables linking the XFS programs with the
124 <filename class="libraryfile">libreadline.so</filename> library, in order
125 to allow editing interactive commands.</para>
126
127 <para><parameter>OPTIMIZER="..."</parameter>: Adding this parameter to
128 the end of the <command>make</command> command overrides the
129 default optimization settings.</para>
130
131 <para><command>make install-dev</command>: This command installs
132 static XFS libraries, their headers and the corresponding
133 documentation.</para>
134
135 </sect2>
136
137 <sect2 role="content">
138 <title>Contents</title>
139
140 <segmentedlist>
141 <segtitle>Installed Programs</segtitle>
142 <segtitle>Installed Libraries</segtitle>
143 <segtitle>Installed Directory</segtitle>
144
145 <seglistitem>
146 <seg>fsck.xfs, mkfs.xfs, xfs_admin, xfs_bmap, xfs_check, xfs_copy,
147 xfs_db, xfs_freeze, xfs_growfs, xfs_info, xfs_io, xfs_logprint,
148 xfs_mdrestore, xfs_metadump, xfs_mkfile, xfs_ncheck, xfs_quota,
149 xfs_repair, and xfs_rtcp</seg>
150 <seg>libdisk.a, libhandle.{so,a}, libxcmd.a, libxfs.a, and
151 libxlog.a </seg>
152 <seg>/usr/share/doc/xfsprogs</seg>
153 </seglistitem>
154 </segmentedlist>
155
156 <variablelist>
157 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
158 <?dbfo list-presentation="list"?>
159 <?dbhtml list-presentation="table"?>
160
161 <varlistentry id="fsck.xfs">
162 <term><command>fsck.xfs</command></term>
163 <listitem>
164 <para>simply exits with a zero status, since XFS
165 partitions are checked at mount time.</para>
166 <indexterm zone="xfs fsck.xfs">
167 <primary sortas="b-fsck.xfs">fsck.xfs</primary>
168 </indexterm>
169 </listitem>
170 </varlistentry>
171
172 <varlistentry id="mkfs.xfs">
173 <term><command>mkfs.xfs</command></term>
174 <listitem>
175 <para>constructs an XFS file system.</para>
176 <indexterm zone="xfs mkfs.xfs">
177 <primary sortas="b-mkfs.xfs">mkfs.xfs</primary>
178 </indexterm>
179 </listitem>
180 </varlistentry>
181
182 <varlistentry id="xfs_admin">
183 <term><command>xfs_admin</command></term>
184 <listitem>
185 <para>changes the parameters of an XFS file system.</para>
186 <indexterm zone="xfs xfs_admin">
187 <primary sortas="b-xfs_admin">xfs_admin</primary>
188 </indexterm>
189 </listitem>
190 </varlistentry>
191
192 <varlistentry id="xfs_bmap">
193 <term><command>xfs_bmap</command></term>
194 <listitem>
195 <para>prints block mapping for an XFS file.</para>
196 <indexterm zone="xfs xfs_bmap">
197 <primary sortas="b-xfs_bmap">xfs_bmap</primary>
198 </indexterm>
199 </listitem>
200 </varlistentry>
201
202 <varlistentry id="xfs_check">
203 <term><command>xfs_check</command></term>
204 <listitem>
205 <para>checks XFS file system consistency.</para>
206 <indexterm zone="xfs xfs_check">
207 <primary sortas="b-xfs_check">xfs_check</primary>
208 </indexterm>
209 </listitem>
210 </varlistentry>
211
212 <varlistentry id="xfs_copy">
213 <term><command>xfs_copy</command></term>
214 <listitem>
215 <para>copies the contents of an XFS file system
216 to one or more targets in parallel.</para>
217 <indexterm zone="xfs xfs_copy">
218 <primary sortas="b-xfs_copy">xfs_copy</primary>
219 </indexterm>
220 </listitem>
221 </varlistentry>
222
223 <varlistentry id="xfs_db">
224 <term><command>xfs_db</command></term>
225 <listitem>
226 <para>is used to debug an XFS file system.</para>
227 <indexterm zone="xfs xfs_db">
228 <primary sortas="b-xfs_db">xfs_db</primary>
229 </indexterm>
230 </listitem>
231 </varlistentry>
232
233 <varlistentry id="xfs_freeze">
234 <term><command>xfs_freeze</command></term>
235 <listitem>
236 <para>suspends access to an XFS file system.</para>
237 <indexterm zone="xfs xfs_freeze">
238 <primary sortas="b-xfs_freeze">xfs_freeze</primary>
239 </indexterm>
240 </listitem>
241 </varlistentry>
242
243 <varlistentry id="xfs_growfs">
244 <term><command>xfs_growfs</command></term>
245 <listitem>
246 <para>expands an XFS file system.</para>
247 <indexterm zone="xfs xfs_growfs">
248 <primary sortas="b-xfs_growfs">xfs_growfs</primary>
249 </indexterm>
250 </listitem>
251 </varlistentry>
252
253 <varlistentry id="xfs_info">
254 <term><command>xfs_info</command></term>
255 <listitem>
256 <para>is equivalent to invoking <command>xfs_growfs</command>, but
257 specifying that no change to the file system is to be made.</para>
258 <indexterm zone="xfs xfs_info">
259 <primary sortas="b-xfs_info">xfs_info</primary>
260 </indexterm>
261 </listitem>
262 </varlistentry>
263
264 <varlistentry id="xfs_io">
265 <term><command>xfs_io</command></term>
266 <listitem>
267 <para>is a debugging tool like <command>xfs_db</command>, but is
268 aimed at examining the regular file I/O path rather than the raw
269 XFS volume itself.</para>
270 <indexterm zone="xfs xfs_io">
271 <primary sortas="b-xfs_io">xfs_io</primary>
272 </indexterm>
273 </listitem>
274 </varlistentry>
275
276 <varlistentry id="xfs_logprint">
277 <term><command>xfs_logprint</command></term>
278 <listitem>
279 <para>prints the log of an XFS file system.</para>
280 <indexterm zone="xfs xfs_logprint">
281 <primary sortas="b-xfs_logprint">xfs_logprint</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 <varlistentry id="xfs_mdrestore">
287 <term><command>xfs_mdrestore</command></term>
288 <listitem>
289 <para>restores an XFS metadump image to a filesystem image.</para>
290 <indexterm zone="xfs xfs_mdrestore">
291 <primary sortas="b-xfs_mdrestore">xfs_mdrestore</primary>
292 </indexterm>
293 </listitem>
294 </varlistentry>
295
296 <varlistentry id="xfs_metadump">
297 <term><command>xfs_metadump</command></term>
298 <listitem>
299 <para>copies XFS filesystem metadata to a file.</para>
300 <indexterm zone="xfs xfs_metadump">
301 <primary sortas="b-xfs_metadump">xfs_metadump</primary>
302 </indexterm>
303 </listitem>
304 </varlistentry>
305
306 <varlistentry id="xfs_mkfile">
307 <term><command>xfs_mkfile</command></term>
308 <listitem>
309 <para>creates an XFS file, padded with zeroes by default.</para>
310 <indexterm zone="xfs xfs_mkfile">
311 <primary sortas="b-xfs_mkfile">xfs_mkfile</primary>
312 </indexterm>
313 </listitem>
314 </varlistentry>
315
316 <varlistentry id="xfs_ncheck">
317 <term><command>xfs_ncheck</command></term>
318 <listitem>
319 <para>generates pathnames from inode numbers for an
320 XFS file system.</para>
321 <indexterm zone="xfs xfs_ncheck">
322 <primary sortas="b-xfs_ncheck">xfs_ncheck</primary>
323 </indexterm>
324 </listitem>
325 </varlistentry>
326
327 <varlistentry id="xfs_quota">
328 <term><command>xfs_quota</command></term>
329 <listitem>
330 <para>is a utility for reporting and editing various
331 aspects of filesystem quota.</para>
332 <indexterm zone="xfs xfs_quota">
333 <primary sortas="b-xfs_quota">xfs_quota</primary>
334 </indexterm>
335 </listitem>
336 </varlistentry>
337
338 <varlistentry id="xfs_repair">
339 <term><command>xfs_repair</command></term>
340 <listitem>
341 <para>repairs corrupt or damaged XFS file systems.</para>
342 <indexterm zone="xfs xfs_repair">
343 <primary sortas="b-xfs_repair">xfs_repair</primary>
344 </indexterm>
345 </listitem>
346 </varlistentry>
347
348 <varlistentry id="xfs_rtcp">
349 <term><command>xfs_rtcp</command></term>
350 <listitem>
351 <para>copies a file to the real-time partition on an
352 XFS file system.</para>
353 <indexterm zone="xfs xfs_rtcp">
354 <primary sortas="b-xfs_rtcp">xfs_rtcp</primary>
355 </indexterm>
356 </listitem>
357 </varlistentry>
358
359 <varlistentry id="libhandle">
360 <term><filename class='libraryfile'>libhandle.so</filename></term>
361 <listitem>
362 <para>contains XFS-specific functions that provide a way to perform
363 certain filesystem operations without using a file descriptor to
364 access filesystem objects.</para>
365 <indexterm zone="xfs libhandle">
366 <primary sortas="c-libhandle">libhandle.so</primary>
367 </indexterm>
368 </listitem>
369 </varlistentry>
370
371
372 <!-- FIXME: other libraries are undocumented 20080221 -->
373
374 </variablelist>
375
376 </sect2>
377
378</sect1>
Note: See TracBrowser for help on using the repository browser.