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

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

Update to Class-Accessor-9.51 (Perl module).
Update to apr-1.6.3 and apr-util-1.6.1.
Update to gnutls-3.6.1.
Update to btrfs-progs-4.13.3.

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

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