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 "3feb593cb52df7570769559366d5e320">
|
---|
10 | <!ENTITY btrfs-progs-size "1.2 MB">
|
---|
11 | <!ENTITY btrfs-progs-buildsize "46 MB (add 1.4 GB for tests)">
|
---|
12 | <!ENTITY btrfs-progs-time "0.4 SBU (add 2.1 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 | &lfs79_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 | <para condition="html" role="usernotes">User Notes:
|
---|
73 | <ulink url="&blfs-wiki;/xfs"/></para>
|
---|
74 |
|
---|
75 | </sect2>
|
---|
76 |
|
---|
77 | <sect2 role="kernel" id="btrfs-progs-kernel">
|
---|
78 | <title>Kernel Configuration</title>
|
---|
79 |
|
---|
80 | <para>Enable the following option in the kernel configuration
|
---|
81 | and recompile the kernel:</para>
|
---|
82 |
|
---|
83 | <screen><literal>File systems --->
|
---|
84 | <*/M> Btrfs filesystem support [CONFIG_BTRFS_FS]</literal></screen>
|
---|
85 |
|
---|
86 | <note><para>Other Btrfs options are optional.</para></note>
|
---|
87 |
|
---|
88 | <indexterm zone="btrfs-progs btrfs-progs-kernel">
|
---|
89 | <primary sortas="d-xfs">BTRFS Programs</primary>
|
---|
90 | </indexterm>
|
---|
91 |
|
---|
92 | </sect2>
|
---|
93 |
|
---|
94 | <sect2 role="installation">
|
---|
95 | <title>Installation of btrfs-progs</title>
|
---|
96 |
|
---|
97 | <para>Install <application>btrfs-progs</application> by running the following
|
---|
98 | commands:</para>
|
---|
99 |
|
---|
100 | <screen><userinput>sed -i '1,106 s/\.gz//g' Documentation/Makefile.in &&
|
---|
101 |
|
---|
102 | ./configure --prefix=/usr \
|
---|
103 | --bindir=/bin \
|
---|
104 | --libdir=/lib &&
|
---|
105 | make</userinput></screen>
|
---|
106 |
|
---|
107 | <para>To test the results, as the <systemitem
|
---|
108 | class="username">root</systemitem> user, issue: <command>make -k
|
---|
109 | test</command>. One test, long-device-name-for-ssd, is known to fail.</para>
|
---|
110 |
|
---|
111 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
112 |
|
---|
113 | <screen role="root"><userinput>make install &&
|
---|
114 |
|
---|
115 | ln -sf ../../lib/$(readlink /lib/libbtrfs.so) /usr/lib/libbtrfs.so &&
|
---|
116 | rm /lib/libbtrfs.{a,so}</userinput></screen>
|
---|
117 |
|
---|
118 | </sect2>
|
---|
119 |
|
---|
120 | <sect2 role="commands">
|
---|
121 | <title>Command Explanations</title>
|
---|
122 |
|
---|
123 | <para><command>sed ... Documentation/Makefile.in</command>: Disables
|
---|
124 | compressing man pages to be consistent with the rest of BLFS.</para>
|
---|
125 |
|
---|
126 | <para><option>--disable-documentation</option>: This option
|
---|
127 | is needed if the recommended dependencies are not installed.</para>
|
---|
128 |
|
---|
129 | <para><command>ln -s ... /usr/lib/libbtrfs.so</command>: Creates a
|
---|
130 | symbolic link in the directory where it is expected.</para>
|
---|
131 |
|
---|
132 | <para><command>rm /lib/libbtrfs.{a,so}</command>: Removes unneeded
|
---|
133 | library entries.</para>
|
---|
134 |
|
---|
135 | </sect2>
|
---|
136 |
|
---|
137 | <sect2 role="content">
|
---|
138 | <title>Contents</title>
|
---|
139 |
|
---|
140 | <segmentedlist>
|
---|
141 | <segtitle>Installed Programs</segtitle>
|
---|
142 | <segtitle>Installed Libraries</segtitle>
|
---|
143 | <segtitle>Installed Directories</segtitle>
|
---|
144 |
|
---|
145 | <seglistitem>
|
---|
146 | <seg>
|
---|
147 | btrfs,
|
---|
148 | btrfs-convert,
|
---|
149 | btrfs-debug-tree,
|
---|
150 | btrfs-find-root,
|
---|
151 | btrfs-image,
|
---|
152 | btrfs-map-logical,
|
---|
153 | btrfs-select-super,
|
---|
154 | btrfs-show-super,
|
---|
155 | btrfs-zero-log,
|
---|
156 | btrfsck (link to btrfs),
|
---|
157 | btrfstune,
|
---|
158 | fsck.btrfs, and
|
---|
159 | mkfs.btrfs
|
---|
160 | </seg>
|
---|
161 |
|
---|
162 | <seg>libbtrfs.so</seg>
|
---|
163 |
|
---|
164 | <seg>/usr/include/btrfs</seg>
|
---|
165 | </seglistitem>
|
---|
166 | </segmentedlist>
|
---|
167 |
|
---|
168 | <variablelist>
|
---|
169 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
170 | <?dbfo list-presentation="list"?>
|
---|
171 | <?dbhtml list-presentation="table"?>
|
---|
172 |
|
---|
173 | <varlistentry id="btrfs-prog">
|
---|
174 | <term><command>btrfs</command></term>
|
---|
175 | <listitem>
|
---|
176 | <para>
|
---|
177 | is the main interface into btrfs filesystem operations.
|
---|
178 | </para>
|
---|
179 | <indexterm zone="btrfs-progs btrfs-prog">
|
---|
180 | <primary sortas="b-btrfs">btrfs</primary>
|
---|
181 | </indexterm>
|
---|
182 | </listitem>
|
---|
183 | </varlistentry>
|
---|
184 |
|
---|
185 | <varlistentry id="fsck.btrfs">
|
---|
186 | <term><command>fsck.btrfs</command></term>
|
---|
187 | <listitem>
|
---|
188 | <para>
|
---|
189 | does nothing, but is present for consistency with fstab.
|
---|
190 | </para>
|
---|
191 | <indexterm zone="btrfs-progs fsck.btrfs">
|
---|
192 | <primary sortas="b-fsck.btrfs">fsck.btrfs</primary>
|
---|
193 | </indexterm>
|
---|
194 | </listitem>
|
---|
195 | </varlistentry>
|
---|
196 |
|
---|
197 | <varlistentry id="mkfs.btrfs">
|
---|
198 | <term><command>mkfs.btrfs</command></term>
|
---|
199 | <listitem>
|
---|
200 | <para>creates a btrfs file system.</para>
|
---|
201 | <indexterm zone="btrfs-progs mkfs.btrfs">
|
---|
202 | <primary sortas="b-mkfs.btrfs">mkfs.btrfs</primary>
|
---|
203 | </indexterm>
|
---|
204 | </listitem>
|
---|
205 | </varlistentry>
|
---|
206 |
|
---|
207 | </variablelist>
|
---|
208 |
|
---|
209 | </sect2>
|
---|
210 |
|
---|
211 | </sect1>
|
---|