source: postlfs/filesystems/xfs.xml@ fd7e0ed6

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 6.3 6.3-rc1 6.3-rc2 6.3-rc3 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 fd7e0ed6 was fd7e0ed6, checked in by Randy McMurchy <randy@…>, 16 years ago

Changed all lines with nothing but whitespace to blank lines

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