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

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 c392eee was c392eee, checked in by Bruce Dubbs <bdubbs@…>, 5 years ago

Update to btrfs-progs-v4.8.2

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

  • Property mode set to 100644
File size: 10.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 "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 "45 MB">
12 <!ENTITY btrfs-progs-time "0.3 SBU">
13 <!--
14 <!ENTITY btrfs-progs-buildsize "46 MB (additional 1.4 GB fror tests)">
15 <!ENTITY btrfs-progs-time "0.3 SBU (additional 6.1 SBU for tests)">
16 -->
17]>
18
19<sect1 id="btrfs-progs" xreflabel="btrfs-progs-&btrfs-progs-version;">
20 <?dbhtml filename="btrfs-progs.html"?>
21
22 <sect1info>
23 <othername>$LastChangedBy$</othername>
24 <date>$Date$</date>
25 </sect1info>
26
27 <title>btrfs-progs-&btrfs-progs-version;</title>
28
29 <indexterm zone="btrfs-progs">
30 <primary sortas="a-btrfs-progs">btrfs-progs</primary>
31 </indexterm>
32
33 <sect2 role="package">
34 <title>Introduction to btrfs-progs</title>
35
36 <para>The <application>btrfs-progs</application> package contains administration
37 and debugging tools for the B-tree file system (btrfs).</para>
38
39 &lfs7a_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>Download (HTTP): <ulink url="&btrfs-progs-download-http;"/></para>
45 </listitem>
46 <listitem>
47 <para>Download (FTP): <ulink url="&btrfs-progs-download-ftp;"/></para>
48 </listitem>
49 <listitem>
50 <para>Download MD5 sum: &btrfs-progs-md5sum;</para>
51 </listitem>
52 <listitem>
53 <para>Download size: &btrfs-progs-size;</para>
54 </listitem>
55 <listitem>
56 <para>Estimated disk space required: &btrfs-progs-buildsize;</para>
57 </listitem>
58 <listitem>
59 <para>Estimated build time: &btrfs-progs-time;</para>
60 </listitem>
61 </itemizedlist>
62
63 <bridgehead renderas="sect3">Btrfs-progs Dependencies</bridgehead>
64
65 <bridgehead renderas="sect4">Required</bridgehead>
66 <para role="required">
67 <xref linkend="lzo"/>
68 </para>
69
70 <bridgehead renderas="sect4">Recommended</bridgehead>
71 <para role="recommended">
72 <xref linkend="asciidoc"/> and
73 <xref linkend="xmlto"/> (both required to generate man pages)
74 </para>
75
76 <bridgehead renderas="sect4">Optional</bridgehead>
77 <para role="optional">
78 <xref linkend="lvm2"/> (<command>dmsetup</command> is used in tests)
79 </para>
80
81 <para condition="html" role="usernotes">User Notes:
82 <ulink url="&blfs-wiki;/xfs"/></para>
83
84 </sect2>
85
86 <sect2 role="kernel" id="btrfs-progs-kernel">
87 <title>Kernel Configuration</title>
88
89 <para>Enable the following option in the kernel configuration
90 and recompile the kernel:</para>
91
92<screen><literal>File systems ---&gt;
93 &lt;*/M&gt; Btrfs filesystem support [CONFIG_BTRFS_FS]</literal></screen>
94
95 <note><para>Other Btrfs options in the kernel are optional.</para></note>
96
97 <indexterm zone="btrfs-progs btrfs-progs-kernel">
98 <primary sortas="d-xfs">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 '1,106 s/\.gz//g' Documentation/Makefile.in &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><option>--disable-documentation</option>: This option
142 is needed if the recommended dependencies are not installed.</para>
143
144 <para><command>ln -s ... /usr/lib/libbtrfs.so</command>: Creates a
145 symbolic link in the directory where it is expected.</para>
146
147 <para><command>rm /lib/libbtrfs.{a,so}</command>: Removes unneeded
148 library entries.</para>
149
150 </sect2>
151
152 <sect2 role="content">
153 <title>Contents</title>
154
155 <segmentedlist>
156 <segtitle>Installed Programs</segtitle>
157 <segtitle>Installed Libraries</segtitle>
158 <segtitle>Installed Directories</segtitle>
159
160 <seglistitem>
161 <seg>
162 btrfs,
163 btrfs-convert,
164 btrfs-debug-tree,
165 btrfs-find-root,
166 btrfs-image,
167 btrfs-map-logical,
168 btrfs-select-super,
169 btrfs-show-super,
170 btrfs-zero-log,
171 btrfsck (link to btrfs),
172 btrfstune,
173 fsck.btrfs, and
174 mkfs.btrfs
175 </seg>
176
177 <seg>libbtrfs.so</seg>
178
179 <seg>/usr/include/btrfs</seg>
180 </seglistitem>
181 </segmentedlist>
182
183 <variablelist>
184 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
185 <?dbfo list-presentation="list"?>
186 <?dbhtml list-presentation="table"?>
187
188 <varlistentry id="btrfs-prog">
189 <term><command>btrfs</command></term>
190 <listitem>
191 <para>
192 is the main interface into btrfs filesystem operations.
193 </para>
194 <indexterm zone="btrfs-progs btrfs-prog">
195 <primary sortas="b-btrfs">btrfs</primary>
196 </indexterm>
197 </listitem>
198 </varlistentry>
199
200 <varlistentry id="btrfs-convert">
201 <term><command>btrfs-convert</command></term>
202 <listitem>
203 <para>
204 converts from ext2/3/4 filesystem to btrfs.
205 </para>
206 <indexterm zone="btrfs-progs btrfs-convert">
207 <primary sortas="b-btrfs-convert">btrfs-convert</primary>
208 </indexterm>
209 </listitem>
210 </varlistentry>
211
212 <varlistentry id="btrfs-debug-tree">
213 <term><command>btrfs-debug-tree</command></term>
214 <listitem>
215 <para>
216 queries various internal information.
217 </para>
218 <indexterm zone="btrfs-progs btrfs-debug-tree">
219 <primary sortas="b-btrfs-debug-tree">btrfs-debug-tree</primary>
220 </indexterm>
221 </listitem>
222 </varlistentry>
223
224 <varlistentry id="btrfs-find-root">
225 <term><command>btrfs-find-root</command></term>
226 <listitem>
227 <para>
228 is a filter to find btrfs root.
229 </para>
230 <indexterm zone="btrfs-progs btrfs-find-root">
231 <primary sortas="b-btrfs-find-root">btrfs-find-root</primary>
232 </indexterm>
233 </listitem>
234 </varlistentry>
235
236 <varlistentry id="btrfs-map-logical">
237 <term><command>btrfs-map-logical</command></term>
238 <listitem>
239 <para>
240 maps btrfs logical extent to physical extent.
241 </para>
242 <indexterm zone="btrfs-progs btrfs-map-logical">
243 <primary sortas="b-btrfs-map-logical">btrfs-map-logical</primary>
244 </indexterm>
245 </listitem>
246 </varlistentry>
247
248 <varlistentry id="btrfs-select-super">
249 <term><command>btrfs-select-super</command></term>
250 <listitem>
251 <para>
252 overwrites primary superblock with a backup copy.
253 </para>
254 <indexterm zone="btrfs-progs btrfs-select-super">
255 <primary sortas="b-btrfs-select-super">btrfs-select-super</primary>
256 </indexterm>
257 </listitem>
258 </varlistentry>
259
260 <varlistentry id="btrfs-show-super">
261 <term><command>btrfs-show-super</command></term>
262 <listitem>
263 <para>
264 queries various internal information.
265 </para>
266 <indexterm zone="btrfs-progs btrfs-show-super">
267 <primary sortas="b-btrfs-show-super">btrfs-show-super</primary>
268 </indexterm>
269 </listitem>
270 </varlistentry>
271
272 <varlistentry id="btrfs-zero-log">
273 <term><command>btrfs-zero-log</command></term>
274 <listitem>
275 <para>
276 recovers a damaged btrfs filesystem.
277 </para>
278 <indexterm zone="btrfs-progs btrfs-zero-log">
279 <primary sortas="b-btrfs-zero-log">btrfs-zero-log</primary>
280 </indexterm>
281 </listitem>
282 </varlistentry>
283
284 <varlistentry id="btrfstune">
285 <term><command>btrfstune</command></term>
286 <listitem>
287 <para>
288 tunes various filesystem parameters.
289 </para>
290 <indexterm zone="btrfs-progs btrfstune">
291 <primary sortas="b-btrfstune">btrfstune</primary>
292 </indexterm>
293 </listitem>
294 </varlistentry>
295
296 <varlistentry id="fsck.btrfs">
297 <term><command>fsck.btrfs</command></term>
298 <listitem>
299 <para>
300 does nothing, but is present for consistency with fstab.
301 </para>
302 <indexterm zone="btrfs-progs fsck.btrfs">
303 <primary sortas="b-fsck.btrfs">fsck.btrfs</primary>
304 </indexterm>
305 </listitem>
306 </varlistentry>
307
308 <varlistentry id="mkfs.btrfs">
309 <term><command>mkfs.btrfs</command></term>
310 <listitem>
311 <para>creates a btrfs file system.</para>
312 <indexterm zone="btrfs-progs mkfs.btrfs">
313 <primary sortas="b-mkfs.btrfs">mkfs.btrfs</primary>
314 </indexterm>
315 </listitem>
316 </varlistentry>
317
318 </variablelist>
319
320 </sect2>
321
322</sect1>
Note: See TracBrowser for help on using the repository browser.