source: postlfs/filesystems/btrfs-progs.xml@ c3447c8

10.1 11.0 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since c3447c8 was c3447c8, checked in by Douglas R. Reno <renodr@…>, 9 months ago

Update to btrfs-progs-5.10
Update to vlc-3.0.12 (security update)
Update to libgcrypt-1.9.1
Update to gtk-doc-1.33.2

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

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