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

10.0 10.1 11.0 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus perl-modules qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 2630345 was 2630345, checked in by Pierre Labastie <pieere@…>, 4 years ago

Fix a few longindex entries again

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

  • Property mode set to 100644
File size: 10.5 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 "94229b39c246797525b7366eff547a4b">
10 <!ENTITY btrfs-progs-size "1.8 MB">
11 <!ENTITY btrfs-progs-buildsize "46 MB (add 34 MB for tests)">
12 <!ENTITY btrfs-progs-time "0.3 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;
149rm -v /lib/libbtrfs.{a,so} &amp;&amp;
150mv -v /bin/{mkfs,fsck}.btrfs /sbin</userinput></screen>
151
152 </sect2>
153
154 <sect2 role="commands">
155 <title>Command Explanations</title>
156
157 <para><command>sed ... Documentation/Makefile.in</command>: Disables
158 compressing man pages to be consistent with the rest of BLFS.</para>
159
160 <para><option>--disable-documentation</option>: This option
161 is needed if the recommended dependencies are not installed.</para>
162
163 <para><command>mv tests/{cli,convert,misc,fuzz}-tests/ ...</command>: Disables
164 tests that fail and prevent tests from completing.</para>
165
166 <para><command>ln -s ... /usr/lib/libbtrfs.so</command>: Creates a
167 symbolic link in the directory where it is expected.</para>
168
169 <para><command>rm /lib/libbtrfs.{a,so}</command>: Removes unneeded
170 library entries.</para>
171
172 </sect2>
173
174 <sect2 role="content">
175 <title>Contents</title>
176
177 <segmentedlist>
178 <segtitle>Installed Programs</segtitle>
179 <segtitle>Installed Libraries</segtitle>
180 <segtitle>Installed Directories</segtitle>
181
182 <seglistitem>
183 <seg>
184 btrfs,
185 btrfs-convert,
186 btrfs-debug-tree,
187 btrfs-find-root,
188 btrfs-image,
189 btrfs-map-logical,
190 btrfs-select-super,
191 btrfs-zero-log,
192 btrfsck (link to btrfs),
193 btrfstune,
194 fsck.btrfs, and
195 mkfs.btrfs
196 </seg>
197
198 <seg>libbtrfs.so</seg>
199
200 <seg>/usr/include/btrfs</seg>
201 </seglistitem>
202 </segmentedlist>
203
204 <variablelist>
205 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
206 <?dbfo list-presentation="list"?>
207 <?dbhtml list-presentation="table"?>
208
209 <varlistentry id="btrfs-prog">
210 <term><command>btrfs</command></term>
211 <listitem>
212 <para>
213 is the main interface into btrfs filesystem operations.
214 </para>
215 <indexterm zone="btrfs-progs btrfs-prog">
216 <primary sortas="b-btrfs">btrfs</primary>
217 </indexterm>
218 </listitem>
219 </varlistentry>
220
221 <varlistentry id="btrfs-convert">
222 <term><command>btrfs-convert</command></term>
223 <listitem>
224 <para>
225 converts from ext2/3/4 filesystem to btrfs.
226 </para>
227 <indexterm zone="btrfs-progs btrfs-convert">
228 <primary sortas="b-btrfs-convert">btrfs-convert</primary>
229 </indexterm>
230 </listitem>
231 </varlistentry>
232
233 <varlistentry id="btrfs-debug-tree">
234 <term><command>btrfs-debug-tree</command></term>
235 <listitem>
236 <para>
237 queries various internal information.
238 </para>
239 <indexterm zone="btrfs-progs btrfs-debug-tree">
240 <primary sortas="b-btrfs-debug-tree">btrfs-debug-tree</primary>
241 </indexterm>
242 </listitem>
243 </varlistentry>
244
245 <varlistentry id="btrfs-find-root">
246 <term><command>btrfs-find-root</command></term>
247 <listitem>
248 <para>
249 is a filter to find btrfs root.
250 </para>
251 <indexterm zone="btrfs-progs btrfs-find-root">
252 <primary sortas="b-btrfs-find-root">btrfs-find-root</primary>
253 </indexterm>
254 </listitem>
255 </varlistentry>
256
257 <varlistentry id="btrfs-map-logical">
258 <term><command>btrfs-map-logical</command></term>
259 <listitem>
260 <para>
261 maps btrfs logical extent to physical extent.
262 </para>
263 <indexterm zone="btrfs-progs btrfs-map-logical">
264 <primary sortas="b-btrfs-map-logical">btrfs-map-logical</primary>
265 </indexterm>
266 </listitem>
267 </varlistentry>
268
269 <varlistentry id="btrfs-select-super">
270 <term><command>btrfs-select-super</command></term>
271 <listitem>
272 <para>
273 overwrites primary superblock with a backup copy.
274 </para>
275 <indexterm zone="btrfs-progs btrfs-select-super">
276 <primary sortas="b-btrfs-select-super">btrfs-select-super</primary>
277 </indexterm>
278 </listitem>
279 </varlistentry>
280
281 <varlistentry id="btrfs-zero-log">
282 <term><command>btrfs-zero-log</command></term>
283 <listitem>
284 <para>
285 recovers a damaged btrfs filesystem.
286 </para>
287 <indexterm zone="btrfs-progs btrfs-zero-log">
288 <primary sortas="b-btrfs-zero-log">btrfs-zero-log</primary>
289 </indexterm>
290 </listitem>
291 </varlistentry>
292
293 <varlistentry id="btrfstune">
294 <term><command>btrfstune</command></term>
295 <listitem>
296 <para>
297 tunes various filesystem parameters.
298 </para>
299 <indexterm zone="btrfs-progs btrfstune">
300 <primary sortas="b-btrfstune">btrfstune</primary>
301 </indexterm>
302 </listitem>
303 </varlistentry>
304
305 <varlistentry id="fsck.btrfs">
306 <term><command>fsck.btrfs</command></term>
307 <listitem>
308 <para>
309 does nothing, but is present for consistency with fstab.
310 </para>
311 <indexterm zone="btrfs-progs fsck.btrfs">
312 <primary sortas="b-fsck.btrfs">fsck.btrfs</primary>
313 </indexterm>
314 </listitem>
315 </varlistentry>
316
317 <varlistentry id="mkfs.btrfs">
318 <term><command>mkfs.btrfs</command></term>
319 <listitem>
320 <para>creates a btrfs file system.</para>
321 <indexterm zone="btrfs-progs mkfs.btrfs">
322 <primary sortas="b-mkfs.btrfs">mkfs.btrfs</primary>
323 </indexterm>
324 </listitem>
325 </varlistentry>
326
327 </variablelist>
328
329 </sect2>
330
331</sect1>
Note: See TracBrowser for help on using the repository browser.