source: postlfs/filesystems/btrfs-progs.xml@ 53375fc

10.0 10.1 11.0 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus nosym perl-modules qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 53375fc was 53375fc, checked in by Bruce Dubbs <bdubbs@…>, 5 years ago

Update to btrfs-progs-v4.8.4.
Update to libdrm-2.4.73.
Update to LVM2.2.02.167.
Text/format changes in dbus and tcsh

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

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