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

11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since b0d1dc0 was b0d1dc0, checked in by Bruce Dubbs <bdubbs@…>, 17 months ago

Package updates.
Update to php-8.1.13.
Update to umockdev-0.17.15.
Update to btrfs-progs-v6.0.2.
  • Property mode set to 100644
File size: 11.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 "b7a644064b6badaaa8d834e2bd589b7c">
10 <!ENTITY btrfs-progs-size "2.2 MB">
11 <!ENTITY btrfs-progs-buildsize "52 MB (add 8.2 GB for tests)">
12 <!ENTITY btrfs-progs-time "0.2 SBU (add 5.0 SBU for tests, but will be longer on slow disks)">
13]>
14
15<sect1 id="btrfs-progs" xreflabel="btrfs-progs-&btrfs-progs-version;">
16 <?dbhtml filename="btrfs-progs.html"?>
17
18 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>btrfs-progs-&btrfs-progs-version;</title>
23
24 <indexterm zone="btrfs-progs">
25 <primary sortas="a-btrfs-progs">btrfs-progs</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to btrfs-progs</title>
30
31 <para>
32 The <application>btrfs-progs</application> package contains
33 administration and debugging tools for the B-tree file system (btrfs).
34 </para>
35
36 &lfs112_checked;
37
38 <bridgehead renderas="sect3">Package Information</bridgehead>
39 <itemizedlist spacing="compact">
40 <listitem>
41 <para>
42 Download (HTTP): <ulink url="&btrfs-progs-download-http;"/>
43 </para>
44 </listitem>
45 <listitem>
46 <para>
47 Download (FTP): <ulink url="&btrfs-progs-download-ftp;"/>
48 </para>
49 </listitem>
50 <listitem>
51 <para>
52 Download MD5 sum: &btrfs-progs-md5sum;
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 Download size: &btrfs-progs-size;
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Estimated disk space required: &btrfs-progs-buildsize;
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Estimated build time: &btrfs-progs-time;
68 </para>
69 </listitem>
70 </itemizedlist>
71<!--
72<bridgehead renderas="sect3">Additional Downloads</bridgehead>
73 <itemizedlist spacing="compact">
74 <listitem>
75 <para>
76 Required patch if building with linux kernel headers version
77 before 5.12:
78 <ulink url="&patch-root;/btrfs-progs-&btrfs-progs-version;-headers_fix-1.patch"/>
79 </para>
80 </listitem>
81 </itemizedlist>
82-->
83 <bridgehead renderas="sect3">Btrfs-progs Dependencies</bridgehead>
84
85 <bridgehead renderas="sect4">Required</bridgehead>
86 <para role="required">
87 <xref linkend="lzo"/>
88 </para>
89
90 <bridgehead renderas="sect4">Recommended</bridgehead>
91 <para role="recommended">
92 <xref linkend="asciidoc"/> (or <xref role="nodep" linkend="asciidoctor"/>)
93 and <xref linkend="xmlto"/> (both required to generate man pages)
94 </para>
95
96 <bridgehead renderas="sect4">Optional</bridgehead>
97 <para role="optional">
98 <xref linkend="lvm2"/> (<command>dmsetup</command> is used in tests),
99 <xref linkend="reiserfs"/> (for tests), and
100 <ulink url="https://www.sphinx-doc.org/">Sphinx</ulink> (required to build documentation),
101
102 </para>
103
104 <para condition="html" role="usernotes">User Notes:
105 <ulink url="&blfs-wiki;/btrfs-progs"/></para>
106
107 </sect2>
108
109 <sect2 role="kernel" id="btrfs-progs-kernel">
110 <title>Kernel Configuration</title>
111
112 <para>
113 Enable the following option in the kernel configuration
114 and recompile the kernel:
115 </para>
116
117<screen><literal>File systems ---&gt;
118 &lt;*/M&gt; Btrfs filesystem support [CONFIG_BTRFS_FS]</literal></screen>
119
120 <para>
121 In addition to the above and to the options required for
122 <xref linkend="lvm2"/> and <xref linkend="reiserfs"/>, the following
123 options must be enabled for running tests:
124 </para>
125
126<screen><literal>File systems ---&gt;
127 [*] Btrfs POSIX Access Control Lists [CONFIG_BTRFS_FS_POSIX_ACL]
128 [*] ReiserFS extended attributes [CONFIG_REISERFS_FS_XATTR]
129 [*] ReiserFS POSIX Access Control Lists [CONFIG_REISERFS_FS_POSIX_ACL]</literal></screen>
130
131 <indexterm zone="btrfs-progs btrfs-progs-kernel">
132 <primary sortas="d-btrfs-progs">BTRFS Programs</primary>
133 </indexterm>
134
135 </sect2>
136
137 <sect2 role="installation">
138 <title>Installation of btrfs-progs</title>
139
140 <para>
141 Install <application>btrfs-progs</application> by running the following
142 commands:
143 </para>
144
145<screen><userinput>./configure --prefix=/usr --disable-documentation &amp;&amp;
146make</userinput></screen>
147
148 <note>
149 <para>
150 Some tests require grep built with perl regular expressions. To
151 obtain this, rebuild grep with the LFS Chapter 8 instructions after
152 installing <xref linkend="pcre2"/>.
153 </para>
154 </note>
155<!-- Keeping this for now, but it seems that calling "make test" is
156 simpler and does the same thing -->
157 <para>
158 Before running tests, build a support program:
159 </para>
160
161<screen remap="test"><userinput>make fssum</userinput></screen>
162
163 <para>
164 To test the results, issue (as the &root; user):
165 </para>
166
167<screen role="root" remap="test"><userinput>pushd tests
168 ./fsck-tests.sh
169 ./mkfs-tests.sh
170 ./cli-tests.sh
171 ./convert-tests.sh
172 ./misc-tests.sh
173 ./fuzz-tests.sh
174popd</userinput></screen>
175
176<!-- Template for failed test removal:
177 <para>
178 To test the results, first disable one test that fails and prevents
179 the other ones to run:
180 </para>
181
182<screen remap="test"><userinput>mv tests/fsck-tests/012-leaf-corruption/test.sh{,.broken}</userinput></screen>
183Substitute your test failure with the one above.
184 <para>
185 To test the results, run (as the
186 <systemitem class="username">root</systemitem> user):
187 </para>
188
189<screen role="root" remap="test"><userinput>make -j1 -k test</userinput></screen>
190-->
191 <note>
192 <para>
193 If the above mentioned kernel options are not enabled, some tests
194 fail, and prevent all the remaining tests to run because the test
195 disk image is not cleanly unmounted.
196 </para>
197 </note>
198
199 <para>
200 The mkfs test 025-zoned-parallel is known to fail.
201 </para>
202
203 <para>
204 Install the package as the &root; user:
205 </para>
206
207<screen role="root"><userinput>make install</userinput></screen>
208
209 </sect2>
210
211 <sect2 role="commands">
212 <title>Command Explanations</title>
213
214 <para>
215 <option>--disable-documentation</option>: This option
216 is needed if the recommended dependencies are not installed.
217 </para>
218<!-- not anymore in the commands
219 <para>
220 <command>mv tests/{cli,convert,misc,fuzz}-tests/ ...</command>: Disables
221 tests that fail and prevent tests from completing.
222 </para>
223
224 <para>
225 <command>ln -s ... /usr/lib/libbtrfs.so</command>: Creates a
226 symbolic link in the directory where it is expected.
227 </para>
228
229 <para>
230 <command>rm /lib/libbtrfs.{a,so}</command>: Removes unneeded
231 library entries.
232 </para>
233-->
234 </sect2>
235
236 <sect2 role="content">
237 <title>Contents</title>
238
239 <segmentedlist>
240 <segtitle>Installed Programs</segtitle>
241 <segtitle>Installed Libraries</segtitle>
242 <segtitle>Installed Directories</segtitle>
243
244 <seglistitem>
245 <seg>
246 btrfs,
247 btrfs-convert,
248 btrfs-find-root,
249 btrfs-image,
250 btrfs-map-logical,
251 btrfs-select-super,
252 btrfsck (link to btrfs),
253 btrfstune,
254 fsck.btrfs, and
255 mkfs.btrfs
256 </seg>
257
258 <seg>
259 libbtrfs.so and
260 libbtrfsutil.so
261 </seg>
262
263 <seg>/usr/include/btrfs</seg>
264 </seglistitem>
265 </segmentedlist>
266
267 <variablelist>
268 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
269 <?dbfo list-presentation="list"?>
270 <?dbhtml list-presentation="table"?>
271
272 <varlistentry id="btrfs-prog">
273 <term><command>btrfs</command></term>
274 <listitem>
275 <para>
276 is the main interface into btrfs filesystem operations
277 </para>
278 <indexterm zone="btrfs-progs btrfs-prog">
279 <primary sortas="b-btrfs">btrfs</primary>
280 </indexterm>
281 </listitem>
282 </varlistentry>
283
284 <varlistentry id="btrfs-convert">
285 <term><command>btrfs-convert</command></term>
286 <listitem>
287 <para>
288 converts from an ext2/3/4 or reiserfs filesystem to btrfs
289 </para>
290 <indexterm zone="btrfs-progs btrfs-convert">
291 <primary sortas="b-btrfs-convert">btrfs-convert</primary>
292 </indexterm>
293 </listitem>
294 </varlistentry>
295
296 <varlistentry id="btrfs-find-root">
297 <term><command>btrfs-find-root</command></term>
298 <listitem>
299 <para>
300 is a filter to find btrfs root
301 </para>
302 <indexterm zone="btrfs-progs btrfs-find-root">
303 <primary sortas="b-btrfs-find-root">btrfs-find-root</primary>
304 </indexterm>
305 </listitem>
306 </varlistentry>
307
308 <varlistentry id="btrfs-map-logical">
309 <term><command>btrfs-map-logical</command></term>
310 <listitem>
311 <para>
312 maps btrfs logical extent to physical extent
313 </para>
314 <indexterm zone="btrfs-progs btrfs-map-logical">
315 <primary sortas="b-btrfs-map-logical">btrfs-map-logical</primary>
316 </indexterm>
317 </listitem>
318 </varlistentry>
319
320 <varlistentry id="btrfs-select-super">
321 <term><command>btrfs-select-super</command></term>
322 <listitem>
323 <para>
324 overwrites the primary superblock with a backup copy
325 </para>
326 <indexterm zone="btrfs-progs btrfs-select-super">
327 <primary sortas="b-btrfs-select-super">btrfs-select-super</primary>
328 </indexterm>
329 </listitem>
330 </varlistentry>
331
332 <varlistentry id="btrfstune">
333 <term><command>btrfstune</command></term>
334 <listitem>
335 <para>
336 tunes various filesystem parameters
337 </para>
338 <indexterm zone="btrfs-progs btrfstune">
339 <primary sortas="b-btrfstune">btrfstune</primary>
340 </indexterm>
341 </listitem>
342 </varlistentry>
343
344 <varlistentry id="fsck.btrfs">
345 <term><command>fsck.btrfs</command></term>
346 <listitem>
347 <para>
348 does nothing, but is present for consistency with fstab
349 </para>
350 <indexterm zone="btrfs-progs fsck.btrfs">
351 <primary sortas="b-fsck.btrfs">fsck.btrfs</primary>
352 </indexterm>
353 </listitem>
354 </varlistentry>
355
356 <varlistentry id="mkfs.btrfs">
357 <term><command>mkfs.btrfs</command></term>
358 <listitem>
359 <para>
360 creates a btrfs file system
361 </para>
362 <indexterm zone="btrfs-progs mkfs.btrfs">
363 <primary sortas="b-mkfs.btrfs">mkfs.btrfs</primary>
364 </indexterm>
365 </listitem>
366 </varlistentry>
367
368 </variablelist>
369
370 </sect2>
371
372</sect1>
Note: See TracBrowser for help on using the repository browser.