source: postlfs/filesystems/btrfs-progs.xml@ 5b20844

10.0 10.1 11.0 9.0 9.1 ken/refactor-virt lazarus qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 5b20844 was 5b20844, checked in by Bruce Dubbs <bdubbs@…>, 2 years ago

Update to btrfs-progs-v5.2wq

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

  • Property mode set to 100644
File size: 9.9 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 btrfs-progs-download-http "&kernel-dl;/linux/kernel/people/kdave/btrfs-progs/btrfs-progs-v&btrfs-progs-version;.tar.xz">
8 <!ENTITY btrfs-progs-download-ftp " ">
9 <!ENTITY btrfs-progs-md5sum "61be9c48f088bd27480cd9ecf6121cf8">
10 <!ENTITY btrfs-progs-size "2.0 MB">
11 <!ENTITY btrfs-progs-buildsize "55 MB (add 111 MB for tests)">
12 <!ENTITY btrfs-progs-time "0.2 SBU (add 13 SBU for tests)">
13]>
14
15<sect1 id="btrfs-progs" xreflabel="btrfs-progs-&btrfs-progs-version;">
16 <?dbhtml filename="btrfs-progs.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>btrfs-progs-&btrfs-progs-version;</title>
24
25 <indexterm zone="btrfs-progs">
26 <primary sortas="a-btrfs-progs">btrfs-progs</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to btrfs-progs</title>
31
32 <para>The <application>btrfs-progs</application> package contains administration
33 and debugging tools for the B-tree file system (btrfs).</para>
34
35 &lfs84_checked;
36
37 <bridgehead renderas="sect3">Package Information</bridgehead>
38 <itemizedlist spacing="compact">
39 <listitem>
40 <para>Download (HTTP): <ulink url="&btrfs-progs-download-http;"/></para>
41 </listitem>
42 <listitem>
43 <para>Download (FTP): <ulink url="&btrfs-progs-download-ftp;"/></para>
44 </listitem>
45 <listitem>
46 <para>Download MD5 sum: &btrfs-progs-md5sum;</para>
47 </listitem>
48 <listitem>
49 <para>Download size: &btrfs-progs-size;</para>
50 </listitem>
51 <listitem>
52 <para>Estimated disk space required: &btrfs-progs-buildsize;</para>
53 </listitem>
54 <listitem>
55 <para>Estimated build time: &btrfs-progs-time;</para>
56 </listitem>
57 </itemizedlist>
58
59 <bridgehead renderas="sect3">Btrfs-progs Dependencies</bridgehead>
60
61 <bridgehead renderas="sect4">Required</bridgehead>
62 <para role="required">
63 <xref linkend="lzo"/>
64 </para>
65
66 <bridgehead renderas="sect4">Recommended</bridgehead>
67 <para role="recommended">
68 <xref linkend="asciidoc"/> and
69 <xref linkend="xmlto"/> (both required to generate man pages)
70 </para>
71
72 <bridgehead renderas="sect4">Optional</bridgehead>
73 <para role="optional">
74 <xref linkend="lvm2"/> (<command>dmsetup</command> is used in tests),
75 <xref linkend="python2"/> (python bindings),
76 <xref linkend="reiserfs"/> (for tests), and
77 <ulink url='https://github.com/facebook/zstd/releases/'>zstd</ulink> (for tests)
78 </para>
79
80 <para condition="html" role="usernotes">User Notes:
81 <ulink url="&blfs-wiki;/xfs"/></para>
82
83 </sect2>
84
85 <sect2 role="kernel" id="btrfs-progs-kernel">
86 <title>Kernel Configuration</title>
87
88 <para>Enable the following option in the kernel configuration
89 and recompile the kernel:</para>
90
91<screen><literal>File systems ---&gt;
92 &lt;*/M&gt; Btrfs filesystem support [CONFIG_BTRFS_FS]</literal></screen>
93
94 <note><para>CONFIG_BTRFS_FS_POSIX_ACL and
95 CONFIG_REISERFS_FS_XATTR are required for some tests.
96 Other Btrfs options in the kernel are optional.</para></note>
97
98 <indexterm zone="btrfs-progs btrfs-progs-kernel">
99 <primary sortas="d-btrfs-progs">BTRFS Programs</primary>
100 </indexterm>
101
102 </sect2>
103
104 <sect2 role="installation">
105 <title>Installation of btrfs-progs</title>
106
107 <para>Install <application>btrfs-progs</application> by running the following
108 commands:</para>
109
110<screen><userinput>./configure --prefix=/usr \
111 --bindir=/bin \
112 --libdir=/lib \
113 --disable-zstd &amp;&amp;
114make</userinput></screen>
115
116 <note><para>Some tests require grep built with perl regular expressions. To
117 obtain this, rebuild grep with the LFS Chapter 6 instructions after
118 installing <xref linkend="pcre"/>.</para></note>
119
120 <para>Before running tests, build a support program and
121 disable several that fail:</para>
122
123<screen><userinput>make fssum &amp;&amp;
124
125sed -i '/found/s/^/: #/' tests/convert-tests.sh &amp;&amp;
126
127mv tests/convert-tests/010-reiserfs-basic/test.sh{,.broken} &amp;&amp;
128mv tests/convert-tests/011-reiserfs-delete-all-rollback/test.sh{,.broken} &amp;&amp;
129mv tests/convert-tests/012-reiserfs-large-hole-extent/test.sh{,.broken} &amp;&amp;
130mv tests/convert-tests/013-reiserfs-common-inode-flags/test.sh{,.broken} &amp;&amp;
131mv tests/convert-tests/014-reiserfs-tail-handling/test.sh{,.broken} &amp;&amp;
132mv tests/misc-tests/025-zstd-compression/test.sh{,.broken}</userinput></screen>
133
134 <para>To test the results, issue (as the <systemitem
135 class="username">root</systemitem> user): </para>
136
137<screen><userinput>pushd tests
138 ./fsck-tests.sh
139 ./mkfs-tests.sh
140 ./cli-tests.sh
141 ./convert-tests.sh
142 ./misc-tests.sh
143 ./fuzz-tests.sh
144popd</userinput></screen>
145
146 <para>Install the package as the <systemitem
147 class="username">root</systemitem> user:</para>
148
149<screen role="root"><userinput>make install &amp;&amp;
150
151ln -sfv ../../lib/$(readlink /lib/libbtrfs.so) /usr/lib/libbtrfs.so &amp;&amp;
152ln -sfv ../../lib/$(readlink /lib/libbtrfsutil.so) /usr/lib/libbtrfsutil.so &amp;&amp;
153rm -fv /lib/libbtrfs.{a,so} /lib/libbtrfsutil.{a,so} &amp;&amp;
154mv -v /bin/{mkfs,fsck}.btrfs /sbin</userinput></screen>
155
156 </sect2>
157
158 <sect2 role="commands">
159 <title>Command Explanations</title>
160
161 <para><option>--disable-documentation</option>: This option
162 is needed if the recommended dependencies are not installed.</para>
163
164 <para><command>mv tests/{cli,convert,misc,fuzz}-tests/ ...</command>: Disables
165 tests that fail and prevent tests from completing.</para>
166
167 <para><command>ln -s ... /usr/lib/libbtrfs.so</command>: Creates a
168 symbolic link in the directory where it is expected.</para>
169
170 <para><command>rm /lib/libbtrfs.{a,so}</command>: Removes unneeded
171 library entries.</para>
172
173 </sect2>
174
175 <sect2 role="content">
176 <title>Contents</title>
177
178 <segmentedlist>
179 <segtitle>Installed Programs</segtitle>
180 <segtitle>Installed Libraries</segtitle>
181 <segtitle>Installed Directories</segtitle>
182
183 <seglistitem>
184 <seg>
185 btrfs,
186 btrfs-convert,
187 btrfs-find-root,
188 btrfs-image,
189 btrfs-map-logical,
190 btrfs-select-super,
191 btrfsck (link to btrfs),
192 btrfstune,
193 fsck.btrfs, and
194 mkfs.btrfs
195 </seg>
196
197 <seg>
198 libbtrfs.so and
199 libbtrfsutil.so
200 </seg>
201
202 <seg>/usr/include/btrfs</seg>
203 </seglistitem>
204 </segmentedlist>
205
206 <variablelist>
207 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
208 <?dbfo list-presentation="list"?>
209 <?dbhtml list-presentation="table"?>
210
211 <varlistentry id="btrfs-prog">
212 <term><command>btrfs</command></term>
213 <listitem>
214 <para>
215 is the main interface into btrfs filesystem operations.
216 </para>
217 <indexterm zone="btrfs-progs btrfs-prog">
218 <primary sortas="b-btrfs">btrfs</primary>
219 </indexterm>
220 </listitem>
221 </varlistentry>
222
223 <varlistentry id="btrfs-convert">
224 <term><command>btrfs-convert</command></term>
225 <listitem>
226 <para>
227 converts from an ext2/3/4 filesystem to btrfs.
228 </para>
229 <indexterm zone="btrfs-progs btrfs-convert">
230 <primary sortas="b-btrfs-convert">btrfs-convert</primary>
231 </indexterm>
232 </listitem>
233 </varlistentry>
234
235 <varlistentry id="btrfs-find-root">
236 <term><command>btrfs-find-root</command></term>
237 <listitem>
238 <para>
239 is a filter to find btrfs root.
240 </para>
241 <indexterm zone="btrfs-progs btrfs-find-root">
242 <primary sortas="b-btrfs-find-root">btrfs-find-root</primary>
243 </indexterm>
244 </listitem>
245 </varlistentry>
246
247 <varlistentry id="btrfs-map-logical">
248 <term><command>btrfs-map-logical</command></term>
249 <listitem>
250 <para>
251 maps btrfs logical extent to physical extent.
252 </para>
253 <indexterm zone="btrfs-progs btrfs-map-logical">
254 <primary sortas="b-btrfs-map-logical">btrfs-map-logical</primary>
255 </indexterm>
256 </listitem>
257 </varlistentry>
258
259 <varlistentry id="btrfs-select-super">
260 <term><command>btrfs-select-super</command></term>
261 <listitem>
262 <para>
263 overwrites the primary superblock with a backup copy.
264 </para>
265 <indexterm zone="btrfs-progs btrfs-select-super">
266 <primary sortas="b-btrfs-select-super">btrfs-select-super</primary>
267 </indexterm>
268 </listitem>
269 </varlistentry>
270
271 <varlistentry id="btrfstune">
272 <term><command>btrfstune</command></term>
273 <listitem>
274 <para>
275 tunes various filesystem parameters.
276 </para>
277 <indexterm zone="btrfs-progs btrfstune">
278 <primary sortas="b-btrfstune">btrfstune</primary>
279 </indexterm>
280 </listitem>
281 </varlistentry>
282
283 <varlistentry id="fsck.btrfs">
284 <term><command>fsck.btrfs</command></term>
285 <listitem>
286 <para>
287 does nothing, but is present for consistency with fstab.
288 </para>
289 <indexterm zone="btrfs-progs fsck.btrfs">
290 <primary sortas="b-fsck.btrfs">fsck.btrfs</primary>
291 </indexterm>
292 </listitem>
293 </varlistentry>
294
295 <varlistentry id="mkfs.btrfs">
296 <term><command>mkfs.btrfs</command></term>
297 <listitem>
298 <para>creates a btrfs file system.</para>
299 <indexterm zone="btrfs-progs mkfs.btrfs">
300 <primary sortas="b-mkfs.btrfs">mkfs.btrfs</primary>
301 </indexterm>
302 </listitem>
303 </varlistentry>
304
305 </variablelist>
306
307 </sect2>
308
309</sect1>
Note: See TracBrowser for help on using the repository browser.