source: postlfs/filesystems/xfs.xml@ c65d4375

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 c65d4375 was c65d4375, checked in by DJ Lucas <dj@…>, 16 years ago

Put xfs-progs back into the book and update 2.9.7.

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