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

10.0 10.1 11.0 11.1 11.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind lazarus perl-modules plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 2565779 was 2565779, checked in by Bruce Dubbs <bdubbs@…>, 5 years ago

Misc fixes

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

  • Property mode set to 100644
File size: 10.6 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 "830e173b9fcef4135b0e5a2e0399344e">
10 <!ENTITY btrfs-progs-size "1.9 MB">
11 <!ENTITY btrfs-progs-buildsize "47 MB (add 71 MB for tests)">
12 <!ENTITY btrfs-progs-time "0.4 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 &lfs82_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="reiserfs"/> (for tests), and
76 <ulink url='https://github.com/facebook/zstd/releases/'>zstd</ulink> (for tests)
77 </para>
78
79 <para condition="html" role="usernotes">User Notes:
80 <ulink url="&blfs-wiki;/xfs"/></para>
81
82 </sect2>
83
84 <sect2 role="kernel" id="btrfs-progs-kernel">
85 <title>Kernel Configuration</title>
86
87 <para>Enable the following option in the kernel configuration
88 and recompile the kernel:</para>
89
90<screen><literal>File systems ---&gt;
91 &lt;*/M&gt; Btrfs filesystem support [CONFIG_BTRFS_FS]</literal></screen>
92
93 <note><para>CONFIG_BTRFS_FS_POSIX_ACL and
94 CONFIG_REISERFS_FS_XATTR are required for some tests.
95 Other Btrfs options in the kernel are optional.</para></note>
96
97 <indexterm zone="btrfs-progs btrfs-progs-kernel">
98 <primary sortas="d-btrfs-progs">BTRFS Programs</primary>
99 </indexterm>
100
101 </sect2>
102
103 <sect2 role="installation">
104 <title>Installation of btrfs-progs</title>
105
106 <para>Install <application>btrfs-progs</application> by running the following
107 commands:</para>
108
109<screen><userinput>sed -i '40,107 s/\.gz//g' Documentation/Makefile.in &amp;&amp;
110
111./configure --prefix=/usr \
112 --bindir=/bin \
113 --libdir=/lib \
114 --disable-zstd &amp;&amp;
115make</userinput></screen>
116
117 <para>Before running tests, build a support program and
118 disable several that fail:</para>
119
120<screen><userinput>make fssum &amp;&amp;
121
122sed -i '/found/s/^/: #/' tests/convert-tests.sh &amp;&amp;
123
124mv tests/mkfs-tests/013-reserved-1M-for-single/test.sh{,.broken} &amp;&amp;
125mv tests/convert-tests/010-reiserfs-basic/test.sh{,.broken} &amp;&amp;
126mv tests/convert-tests/011-reiserfs-delete-all-rollback/test.sh{,.broken} &amp;&amp;
127mv tests/misc-tests/025-zstd-compression/test.sh{,.broken} &amp;&amp;
128mv tests/fuzz-tests/003-multi-check-unmounted/test.sh{,.broken} &amp;&amp;
129mv tests/fuzz-tests/009-simple-zero-log/test.sh{,.broken}</userinput></screen>
130
131 <para>To test the results, issue (as the <systemitem
132 class="username">root</systemitem> user): </para>
133
134<screen><userinput>pushd tests
135 ./fsck-tests.sh
136 ./mkfs-tests.sh
137 ./cli-tests.sh
138 ./convert-tests.sh
139 ./misc-tests.sh
140 ./fuzz-tests.sh
141popd</userinput></screen>
142
143 <para>Install the package as the <systemitem
144 class="username">root</systemitem> user:</para>
145
146<screen role="root"><userinput>make install &amp;&amp;
147
148ln -sfv ../../lib/$(readlink /lib/libbtrfs.so) /usr/lib/libbtrfs.so &amp;&amp;
149ln -sfv ../../lib/$(readlink /lib/libbtrfsutil.so) /usr/lib/libbtrfsutil.so &amp;&amp;
150rm -fv /lib/libbtrfs.{a,so} /lib/libbtrfsutil.{a,so} &amp;&amp;
151mv -v /bin/{mkfs,fsck}.btrfs /sbin</userinput></screen>
152
153 </sect2>
154
155 <sect2 role="commands">
156 <title>Command Explanations</title>
157
158 <para><command>sed ... Documentation/Makefile.in</command>: Disables
159 compressing man pages to be consistent with the rest of BLFS.</para>
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-debug-tree,
188 btrfs-find-root,
189 btrfs-image,
190 btrfs-map-logical,
191 btrfs-select-super,
192 btrfs-zero-log,
193 btrfsck (link to btrfs),
194 btrfstune,
195 fsck.btrfs, and
196 mkfs.btrfs
197 </seg>
198
199 <seg>libbtrfs.so</seg>
200
201 <seg>/usr/include/btrfs</seg>
202 </seglistitem>
203 </segmentedlist>
204
205 <variablelist>
206 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
207 <?dbfo list-presentation="list"?>
208 <?dbhtml list-presentation="table"?>
209
210 <varlistentry id="btrfs-prog">
211 <term><command>btrfs</command></term>
212 <listitem>
213 <para>
214 is the main interface into btrfs filesystem operations.
215 </para>
216 <indexterm zone="btrfs-progs btrfs-prog">
217 <primary sortas="b-btrfs">btrfs</primary>
218 </indexterm>
219 </listitem>
220 </varlistentry>
221
222 <varlistentry id="btrfs-convert">
223 <term><command>btrfs-convert</command></term>
224 <listitem>
225 <para>
226 converts from ext2/3/4 filesystem to btrfs.
227 </para>
228 <indexterm zone="btrfs-progs btrfs-convert">
229 <primary sortas="b-btrfs-convert">btrfs-convert</primary>
230 </indexterm>
231 </listitem>
232 </varlistentry>
233
234 <varlistentry id="btrfs-debug-tree">
235 <term><command>btrfs-debug-tree</command></term>
236 <listitem>
237 <para>
238 queries various internal information.
239 </para>
240 <indexterm zone="btrfs-progs btrfs-debug-tree">
241 <primary sortas="b-btrfs-debug-tree">btrfs-debug-tree</primary>
242 </indexterm>
243 </listitem>
244 </varlistentry>
245
246 <varlistentry id="btrfs-find-root">
247 <term><command>btrfs-find-root</command></term>
248 <listitem>
249 <para>
250 is a filter to find btrfs root.
251 </para>
252 <indexterm zone="btrfs-progs btrfs-find-root">
253 <primary sortas="b-btrfs-find-root">btrfs-find-root</primary>
254 </indexterm>
255 </listitem>
256 </varlistentry>
257
258 <varlistentry id="btrfs-map-logical">
259 <term><command>btrfs-map-logical</command></term>
260 <listitem>
261 <para>
262 maps btrfs logical extent to physical extent.
263 </para>
264 <indexterm zone="btrfs-progs btrfs-map-logical">
265 <primary sortas="b-btrfs-map-logical">btrfs-map-logical</primary>
266 </indexterm>
267 </listitem>
268 </varlistentry>
269
270 <varlistentry id="btrfs-select-super">
271 <term><command>btrfs-select-super</command></term>
272 <listitem>
273 <para>
274 overwrites primary superblock with a backup copy.
275 </para>
276 <indexterm zone="btrfs-progs btrfs-select-super">
277 <primary sortas="b-btrfs-select-super">btrfs-select-super</primary>
278 </indexterm>
279 </listitem>
280 </varlistentry>
281
282 <varlistentry id="btrfs-zero-log">
283 <term><command>btrfs-zero-log</command></term>
284 <listitem>
285 <para>
286 recovers a damaged btrfs filesystem.
287 </para>
288 <indexterm zone="btrfs-progs btrfs-zero-log">
289 <primary sortas="b-btrfs-zero-log">btrfs-zero-log</primary>
290 </indexterm>
291 </listitem>
292 </varlistentry>
293
294 <varlistentry id="btrfstune">
295 <term><command>btrfstune</command></term>
296 <listitem>
297 <para>
298 tunes various filesystem parameters.
299 </para>
300 <indexterm zone="btrfs-progs btrfstune">
301 <primary sortas="b-btrfstune">btrfstune</primary>
302 </indexterm>
303 </listitem>
304 </varlistentry>
305
306 <varlistentry id="fsck.btrfs">
307 <term><command>fsck.btrfs</command></term>
308 <listitem>
309 <para>
310 does nothing, but is present for consistency with fstab.
311 </para>
312 <indexterm zone="btrfs-progs fsck.btrfs">
313 <primary sortas="b-fsck.btrfs">fsck.btrfs</primary>
314 </indexterm>
315 </listitem>
316 </varlistentry>
317
318 <varlistentry id="mkfs.btrfs">
319 <term><command>mkfs.btrfs</command></term>
320 <listitem>
321 <para>creates a btrfs file system.</para>
322 <indexterm zone="btrfs-progs mkfs.btrfs">
323 <primary sortas="b-mkfs.btrfs">mkfs.btrfs</primary>
324 </indexterm>
325 </listitem>
326 </varlistentry>
327
328 </variablelist>
329
330 </sect2>
331
332</sect1>
Note: See TracBrowser for help on using the repository browser.