source: postlfs/filesystems/xfs.xml@ b5972ac

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 b5972ac was b5972ac, checked in by David Jensen <djensen@…>, 15 years ago

removed a sed from XFS-2.9.3

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

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