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

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 upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since c1ff74eb was c1ff74eb, checked in by Bruce Dubbs <bdubbs@…>, 5 years ago

Update to btrfs-progs-v4.8.3.
Update to menu-cache-1.0.2.
Update to xfce4-terminal-0.8.1.
Update to bluez-5.43.
Update to fltk-1.3.4.

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