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

11.1 lazarus qt5new trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since 8558044 was 8558044, checked in by Pierre Labastie <pierre.labastie@…>, 9 months ago

Remove spaces at the end of lines

I know it is somewhat useless, but I don't like them for
two reasons: first they cannot be seen, and I do not like things I
cannot see. Second, git highlights them, and this is disturbing...

  • Property mode set to 100644
File size: 10.8 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 "8ca78d6e62179ef177597422e27a58fc">
10 <!ENTITY btrfs-progs-size "2.1 MB">
11 <!ENTITY btrfs-progs-buildsize "54 MB (up to 2.7 GB are used during tests)">
12 <!ENTITY btrfs-progs-time "0.2 SBU (add 5.9 SBU for tests, but will be longer on slow disks)">
13]>
14
15<sect1 id="btrfs-progs" xreflabel="btrfs-progs-&btrfs-progs-version;">
16 <?dbhtml filename="btrfs-progs.html"?>
17
18 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>btrfs-progs-&btrfs-progs-version;</title>
23
24 <indexterm zone="btrfs-progs">
25 <primary sortas="a-btrfs-progs">btrfs-progs</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to btrfs-progs</title>
30
31 <para>
32 The <application>btrfs-progs</application> package contains
33 administration and debugging tools for the B-tree file system (btrfs).
34 </para>
35
36 &lfs110a_checked;
37
38 <bridgehead renderas="sect3">Package Information</bridgehead>
39 <itemizedlist spacing="compact">
40 <listitem>
41 <para>
42 Download (HTTP): <ulink url="&btrfs-progs-download-http;"/>
43 </para>
44 </listitem>
45 <listitem>
46 <para>
47 Download (FTP): <ulink url="&btrfs-progs-download-ftp;"/>
48 </para>
49 </listitem>
50 <listitem>
51 <para>
52 Download MD5 sum: &btrfs-progs-md5sum;
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 Download size: &btrfs-progs-size;
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Estimated disk space required: &btrfs-progs-buildsize;
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Estimated build time: &btrfs-progs-time;
68 </para>
69 </listitem>
70 </itemizedlist>
71
72 <bridgehead renderas="sect3">Btrfs-progs Dependencies</bridgehead>
73
74 <bridgehead renderas="sect4">Required</bridgehead>
75 <para role="required">
76 <xref linkend="lzo"/>
77 </para>
78
79 <bridgehead renderas="sect4">Recommended</bridgehead>
80 <para role="recommended">
81 <xref linkend="asciidoc"/> and
82 <xref linkend="xmlto"/> (both required to generate man pages)
83 </para>
84
85 <bridgehead renderas="sect4">Optional</bridgehead>
86 <para role="optional">
87 <xref linkend="lvm2"/> (<command>dmsetup</command> is used in tests) and
88 <xref linkend="reiserfs"/> (for tests)
89 </para>
90
91 <para condition="html" role="usernotes">User Notes:
92 <ulink url="&blfs-wiki;/btrfs-progs"/></para>
93
94 </sect2>
95
96 <sect2 role="kernel" id="btrfs-progs-kernel">
97 <title>Kernel Configuration</title>
98
99 <para>
100 Enable the following option in the kernel configuration
101 and recompile the kernel:
102 </para>
103
104<screen><literal>File systems ---&gt;
105 &lt;*/M&gt; Btrfs filesystem support [CONFIG_BTRFS_FS]</literal></screen>
106
107 <para>
108 In addition to the above and to the options required for
109 <xref linkend="lvm2"/> and <xref linkend="reiserfs"/>, the following
110 options must be enabled for running tests:
111 </para>
112
113<screen><literal>File systems ---&gt;
114 [*] Btrfs POSIX Access Control Lists [CONFIG_BTRFS_FS_POSIX_ACL]
115 [*] ReiserFS extended attributes [CONFIG_REISERFS_FS_XATTR]
116 [*] ReiserFS POSIX Access Control Lists [CONFIG_REISERFS_FS_POSIX_ACL]</literal></screen>
117
118 <indexterm zone="btrfs-progs btrfs-progs-kernel">
119 <primary sortas="d-btrfs-progs">BTRFS Programs</primary>
120 </indexterm>
121
122 </sect2>
123
124 <sect2 role="installation">
125 <title>Installation of btrfs-progs</title>
126
127 <para>
128 Install <application>btrfs-progs</application> by running the following
129 commands:
130 </para>
131
132<screen><userinput>./configure --prefix=/usr &amp;&amp;
133make</userinput></screen>
134
135 <note>
136 <para>
137 Some tests require grep built with perl regular expressions. To
138 obtain this, rebuild grep with the LFS Chapter 8 instructions after
139 installing <xref linkend="pcre"/>.
140 </para>
141 </note>
142<!-- Keeping this for now, but it seems that calling "make test" is
143 simpler and does the same thing -->
144 <para>
145 Before running tests, build a support program:
146 </para>
147
148<screen remap="test"><userinput>make fssum</userinput></screen>
149
150 <para>
151 To test the results, issue (as the <systemitem
152 class="username">root</systemitem> user):
153 </para>
154
155<screen role="root" remap="test"><userinput>pushd tests
156 ./fsck-tests.sh
157 ./mkfs-tests.sh
158 ./cli-tests.sh
159 ./convert-tests.sh
160 ./misc-tests.sh
161 ./fuzz-tests.sh
162popd</userinput></screen>
163
164<!-- Template for failed test removal:
165 <para>
166 To test the results, first disable one test that fails and prevents
167 the other ones to run:
168 </para>
169
170<screen remap="test"><userinput>mv tests/fsck-tests/012-leaf-corruption/test.sh{,.broken}</userinput></screen>
171Substitute your test failure with the one above.
172 <para>
173 To test the results, run (as the
174 <systemitem class="username">root</systemitem> user):
175 </para>
176
177<screen role="root" remap="test"><userinput>make -j1 -k test</userinput></screen>
178-->
179 <note>
180 <para>
181 If the above mentioned kernel options are not enabled, some tests
182 fail, and prevent all the remaining tests to run, because the test
183 disk image is not cleanly unmounted.
184 </para>
185 </note>
186<!--
187 <para>
188 Two tests fail for unknown reasons in the
189 <command>test-libbtrfsutil</command> section. Tests take a very long
190 time, and it may be interesting to run only part of them. Running tests
191 only in one directory can be done with
192 <command>make TEST=&lt;DIR&gt; test</command>.
193 </para>
194-->
195 <para>
196 Install the package as the <systemitem
197 class="username">root</systemitem> user:
198 </para>
199
200<screen role="root"><userinput>make install</userinput></screen>
201
202 </sect2>
203
204 <sect2 role="commands">
205 <title>Command Explanations</title>
206
207 <para>
208 <option>--disable-documentation</option>: This option
209 is needed if the recommended dependencies are not installed.
210 </para>
211<!-- not anymore in the commands
212 <para>
213 <command>mv tests/{cli,convert,misc,fuzz}-tests/ ...</command>: Disables
214 tests that fail and prevent tests from completing.
215 </para>
216
217 <para>
218 <command>ln -s ... /usr/lib/libbtrfs.so</command>: Creates a
219 symbolic link in the directory where it is expected.
220 </para>
221
222 <para>
223 <command>rm /lib/libbtrfs.{a,so}</command>: Removes unneeded
224 library entries.
225 </para>
226-->
227 </sect2>
228
229 <sect2 role="content">
230 <title>Contents</title>
231
232 <segmentedlist>
233 <segtitle>Installed Programs</segtitle>
234 <segtitle>Installed Libraries</segtitle>
235 <segtitle>Installed Directories</segtitle>
236
237 <seglistitem>
238 <seg>
239 btrfs,
240 btrfs-convert,
241 btrfs-find-root,
242 btrfs-image,
243 btrfs-map-logical,
244 btrfs-select-super,
245 btrfsck (link to btrfs),
246 btrfstune,
247 fsck.btrfs, and
248 mkfs.btrfs
249 </seg>
250
251 <seg>
252 libbtrfs.so and
253 libbtrfsutil.so
254 </seg>
255
256 <seg>/usr/include/btrfs</seg>
257 </seglistitem>
258 </segmentedlist>
259
260 <variablelist>
261 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
262 <?dbfo list-presentation="list"?>
263 <?dbhtml list-presentation="table"?>
264
265 <varlistentry id="btrfs-prog">
266 <term><command>btrfs</command></term>
267 <listitem>
268 <para>
269 is the main interface into btrfs filesystem operations
270 </para>
271 <indexterm zone="btrfs-progs btrfs-prog">
272 <primary sortas="b-btrfs">btrfs</primary>
273 </indexterm>
274 </listitem>
275 </varlistentry>
276
277 <varlistentry id="btrfs-convert">
278 <term><command>btrfs-convert</command></term>
279 <listitem>
280 <para>
281 converts from an ext2/3/4 or reiserfs filesystem to btrfs
282 </para>
283 <indexterm zone="btrfs-progs btrfs-convert">
284 <primary sortas="b-btrfs-convert">btrfs-convert</primary>
285 </indexterm>
286 </listitem>
287 </varlistentry>
288
289 <varlistentry id="btrfs-find-root">
290 <term><command>btrfs-find-root</command></term>
291 <listitem>
292 <para>
293 is a filter to find btrfs root
294 </para>
295 <indexterm zone="btrfs-progs btrfs-find-root">
296 <primary sortas="b-btrfs-find-root">btrfs-find-root</primary>
297 </indexterm>
298 </listitem>
299 </varlistentry>
300
301 <varlistentry id="btrfs-map-logical">
302 <term><command>btrfs-map-logical</command></term>
303 <listitem>
304 <para>
305 maps btrfs logical extent to physical extent
306 </para>
307 <indexterm zone="btrfs-progs btrfs-map-logical">
308 <primary sortas="b-btrfs-map-logical">btrfs-map-logical</primary>
309 </indexterm>
310 </listitem>
311 </varlistentry>
312
313 <varlistentry id="btrfs-select-super">
314 <term><command>btrfs-select-super</command></term>
315 <listitem>
316 <para>
317 overwrites the primary superblock with a backup copy
318 </para>
319 <indexterm zone="btrfs-progs btrfs-select-super">
320 <primary sortas="b-btrfs-select-super">btrfs-select-super</primary>
321 </indexterm>
322 </listitem>
323 </varlistentry>
324
325 <varlistentry id="btrfstune">
326 <term><command>btrfstune</command></term>
327 <listitem>
328 <para>
329 tunes various filesystem parameters
330 </para>
331 <indexterm zone="btrfs-progs btrfstune">
332 <primary sortas="b-btrfstune">btrfstune</primary>
333 </indexterm>
334 </listitem>
335 </varlistentry>
336
337 <varlistentry id="fsck.btrfs">
338 <term><command>fsck.btrfs</command></term>
339 <listitem>
340 <para>
341 does nothing, but is present for consistency with fstab
342 </para>
343 <indexterm zone="btrfs-progs fsck.btrfs">
344 <primary sortas="b-fsck.btrfs">fsck.btrfs</primary>
345 </indexterm>
346 </listitem>
347 </varlistentry>
348
349 <varlistentry id="mkfs.btrfs">
350 <term><command>mkfs.btrfs</command></term>
351 <listitem>
352 <para>
353 creates a btrfs file system
354 </para>
355 <indexterm zone="btrfs-progs mkfs.btrfs">
356 <primary sortas="b-mkfs.btrfs">mkfs.btrfs</primary>
357 </indexterm>
358 </listitem>
359 </varlistentry>
360
361 </variablelist>
362
363 </sect2>
364
365</sect1>
Note: See TracBrowser for help on using the repository browser.