source: postlfs/filesystems/btrfs-progs.xml@ 25af923

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

Update to sudo-1.8.18p1.
Clarified the location of the discussion about removing unneeded noto fonts.
Update to btrfs-progs-v4.8.1.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@17884 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 "127e109ed05274597d67c24c89861d49">
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<!-- Theere is a broblem with the data for the 4.7.3 regression tests
117
118<para>To test the results, issue (as the <systemitem
119 class="username">root</systemitem> user): <command>make -k
120 test</command>.</para>-->
121
122 <para>This package does not come with a working test suite.</para>
123
124 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
125
126<screen role="root"><userinput>make install &amp;&amp;
127
128ln -sfv ../../lib/$(readlink /lib/libbtrfs.so) /usr/lib/libbtrfs.so &amp;&amp;
129rm -v /lib/libbtrfs.{a,so}</userinput></screen>
130
131 </sect2>
132
133 <sect2 role="commands">
134 <title>Command Explanations</title>
135
136 <para><command>sed ... Documentation/Makefile.in</command>: Disables
137 compressing man pages to be consistent with the rest of BLFS.</para>
138
139 <para><option>--disable-documentation</option>: This option
140 is needed if the recommended dependencies are not installed.</para>
141
142 <para><command>ln -s ... /usr/lib/libbtrfs.so</command>: Creates a
143 symbolic link in the directory where it is expected.</para>
144
145 <para><command>rm /lib/libbtrfs.{a,so}</command>: Removes unneeded
146 library entries.</para>
147
148 </sect2>
149
150 <sect2 role="content">
151 <title>Contents</title>
152
153 <segmentedlist>
154 <segtitle>Installed Programs</segtitle>
155 <segtitle>Installed Libraries</segtitle>
156 <segtitle>Installed Directories</segtitle>
157
158 <seglistitem>
159 <seg>
160 btrfs,
161 btrfs-convert,
162 btrfs-debug-tree,
163 btrfs-find-root,
164 btrfs-image,
165 btrfs-map-logical,
166 btrfs-select-super,
167 btrfs-show-super,
168 btrfs-zero-log,
169 btrfsck (link to btrfs),
170 btrfstune,
171 fsck.btrfs, and
172 mkfs.btrfs
173 </seg>
174
175 <seg>libbtrfs.so</seg>
176
177 <seg>/usr/include/btrfs</seg>
178 </seglistitem>
179 </segmentedlist>
180
181 <variablelist>
182 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
183 <?dbfo list-presentation="list"?>
184 <?dbhtml list-presentation="table"?>
185
186 <varlistentry id="btrfs-prog">
187 <term><command>btrfs</command></term>
188 <listitem>
189 <para>
190 is the main interface into btrfs filesystem operations.
191 </para>
192 <indexterm zone="btrfs-progs btrfs-prog">
193 <primary sortas="b-btrfs">btrfs</primary>
194 </indexterm>
195 </listitem>
196 </varlistentry>
197
198 <varlistentry id="btrfs-convert">
199 <term><command>btrfs-convert</command></term>
200 <listitem>
201 <para>
202 converts from ext2/3/4 filesystem to btrfs.
203 </para>
204 <indexterm zone="btrfs-progs btrfs-convert">
205 <primary sortas="b-btrfs-convert">btrfs-convert</primary>
206 </indexterm>
207 </listitem>
208 </varlistentry>
209
210 <varlistentry id="btrfs-debug-tree">
211 <term><command>btrfs-debug-tree</command></term>
212 <listitem>
213 <para>
214 queries various internal information.
215 </para>
216 <indexterm zone="btrfs-progs btrfs-debug-tree">
217 <primary sortas="b-btrfs-debug-tree">btrfs-debug-tree</primary>
218 </indexterm>
219 </listitem>
220 </varlistentry>
221
222 <varlistentry id="btrfs-find-root">
223 <term><command>btrfs-find-root</command></term>
224 <listitem>
225 <para>
226 is a filter to find btrfs root.
227 </para>
228 <indexterm zone="btrfs-progs btrfs-find-root">
229 <primary sortas="b-btrfs-find-root">btrfs-find-root</primary>
230 </indexterm>
231 </listitem>
232 </varlistentry>
233
234 <varlistentry id="btrfs-map-logical">
235 <term><command>btrfs-map-logical</command></term>
236 <listitem>
237 <para>
238 maps btrfs logical extent to physical extent.
239 </para>
240 <indexterm zone="btrfs-progs btrfs-map-logical">
241 <primary sortas="b-btrfs-map-logical">btrfs-map-logical</primary>
242 </indexterm>
243 </listitem>
244 </varlistentry>
245
246 <varlistentry id="btrfs-select-super">
247 <term><command>btrfs-select-super</command></term>
248 <listitem>
249 <para>
250 overwrites primary superblock with a backup copy.
251 </para>
252 <indexterm zone="btrfs-progs btrfs-select-super">
253 <primary sortas="b-btrfs-select-super">btrfs-select-super</primary>
254 </indexterm>
255 </listitem>
256 </varlistentry>
257
258 <varlistentry id="btrfs-show-super">
259 <term><command>btrfs-show-super</command></term>
260 <listitem>
261 <para>
262 queries various internal information.
263 </para>
264 <indexterm zone="btrfs-progs btrfs-show-super">
265 <primary sortas="b-btrfs-show-super">btrfs-show-super</primary>
266 </indexterm>
267 </listitem>
268 </varlistentry>
269
270 <varlistentry id="btrfs-zero-log">
271 <term><command>btrfs-zero-log</command></term>
272 <listitem>
273 <para>
274 recovers a damaged btrfs filesystem.
275 </para>
276 <indexterm zone="btrfs-progs btrfs-zero-log">
277 <primary sortas="b-btrfs-zero-log">btrfs-zero-log</primary>
278 </indexterm>
279 </listitem>
280 </varlistentry>
281
282 <varlistentry id="btrfstune">
283 <term><command>btrfstune</command></term>
284 <listitem>
285 <para>
286 tunes various filesystem parameters.
287 </para>
288 <indexterm zone="btrfs-progs btrfstune">
289 <primary sortas="b-btrfstune">btrfstune</primary>
290 </indexterm>
291 </listitem>
292 </varlistentry>
293
294 <varlistentry id="fsck.btrfs">
295 <term><command>fsck.btrfs</command></term>
296 <listitem>
297 <para>
298 does nothing, but is present for consistency with fstab.
299 </para>
300 <indexterm zone="btrfs-progs fsck.btrfs">
301 <primary sortas="b-fsck.btrfs">fsck.btrfs</primary>
302 </indexterm>
303 </listitem>
304 </varlistentry>
305
306 <varlistentry id="mkfs.btrfs">
307 <term><command>mkfs.btrfs</command></term>
308 <listitem>
309 <para>creates a btrfs file system.</para>
310 <indexterm zone="btrfs-progs mkfs.btrfs">
311 <primary sortas="b-mkfs.btrfs">mkfs.btrfs</primary>
312 </indexterm>
313 </listitem>
314 </varlistentry>
315
316 </variablelist>
317
318 </sect2>
319
320</sect1>
Note: See TracBrowser for help on using the repository browser.