source: postlfs/filesystems/xfs.xml@ 5e72fc7

10.0 10.1 11.0 11.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 krejzi/svn lazarus nosym perl-modules qt5new systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since 5e72fc7 was 5e72fc7, checked in by David Jensen <djensen@…>, 15 years ago

Updated to XFS-2.9.3

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

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