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