[1f1a9e9] | 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 |
|
---|
[8dfc5c3] | 7 | <!ENTITY btrfs-progs-download-http "&kernel-dl;/linux/kernel/people/kdave/btrfs-progs/btrfs-progs-v&btrfs-progs-version;.tar.xz">
|
---|
[1f1a9e9] | 8 | <!ENTITY btrfs-progs-download-ftp " ">
|
---|
[5d01724] | 9 | <!ENTITY btrfs-progs-md5sum "b8e43ed6aa34d4b48974f297c79d391b">
|
---|
| 10 | <!ENTITY btrfs-progs-size "1.9 MB">
|
---|
| 11 | <!ENTITY btrfs-progs-buildsize "82 MB (add 4 MB for tests)">
|
---|
| 12 | <!ENTITY btrfs-progs-time "0.2 SBU (add 6.8 SBU for tests)">
|
---|
[1f1a9e9] | 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 |
|
---|
[e6bce28] | 35 | &lfs83_checked;
|
---|
[1f1a9e9] | 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 |
|
---|
[61439d5] | 61 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 62 | <para role="required">
|
---|
| 63 | <xref linkend="lzo"/>
|
---|
| 64 | </para>
|
---|
| 65 |
|
---|
[1f1a9e9] | 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 |
|
---|
[292a840] | 72 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 73 | <para role="optional">
|
---|
[6eb166fa] | 74 | <xref linkend="lvm2"/> (<command>dmsetup</command> is used in tests),
|
---|
[0ecaac7] | 75 | <xref linkend="python2"/> (python bindings),
|
---|
[6eb166fa] | 76 | <xref linkend="reiserfs"/> (for tests), and
|
---|
| 77 | <ulink url='https://github.com/facebook/zstd/releases/'>zstd</ulink> (for tests)
|
---|
[292a840] | 78 | </para>
|
---|
| 79 |
|
---|
[1f1a9e9] | 80 | <para condition="html" role="usernotes">User Notes:
|
---|
| 81 | <ulink url="&blfs-wiki;/xfs"/></para>
|
---|
| 82 |
|
---|
| 83 | </sect2>
|
---|
| 84 |
|
---|
| 85 | <sect2 role="kernel" id="btrfs-progs-kernel">
|
---|
| 86 | <title>Kernel Configuration</title>
|
---|
| 87 |
|
---|
| 88 | <para>Enable the following option in the kernel configuration
|
---|
| 89 | and recompile the kernel:</para>
|
---|
| 90 |
|
---|
| 91 | <screen><literal>File systems --->
|
---|
| 92 | <*/M> Btrfs filesystem support [CONFIG_BTRFS_FS]</literal></screen>
|
---|
| 93 |
|
---|
[f1e50963] | 94 | <note><para>CONFIG_BTRFS_FS_POSIX_ACL and
|
---|
| 95 | CONFIG_REISERFS_FS_XATTR are required for some tests.
|
---|
[a4b8b2a7] | 96 | Other Btrfs options in the kernel are optional.</para></note>
|
---|
[1f1a9e9] | 97 |
|
---|
| 98 | <indexterm zone="btrfs-progs btrfs-progs-kernel">
|
---|
[2630345] | 99 | <primary sortas="d-btrfs-progs">BTRFS Programs</primary>
|
---|
[1f1a9e9] | 100 | </indexterm>
|
---|
| 101 |
|
---|
| 102 | </sect2>
|
---|
| 103 |
|
---|
| 104 | <sect2 role="installation">
|
---|
| 105 | <title>Installation of btrfs-progs</title>
|
---|
| 106 |
|
---|
| 107 | <para>Install <application>btrfs-progs</application> by running the following
|
---|
| 108 | commands:</para>
|
---|
[7b2b4b11] | 109 |
|
---|
[5d01724] | 110 | <screen><userinput>./configure --prefix=/usr \
|
---|
[6eb166fa] | 111 | --bindir=/bin \
|
---|
| 112 | --libdir=/lib \
|
---|
| 113 | --disable-zstd &&
|
---|
[1f1a9e9] | 114 | make</userinput></screen>
|
---|
| 115 |
|
---|
[bd9de06d] | 116 | <para>Before running tests, build a support program and
|
---|
| 117 | disable several that fail:</para>
|
---|
[1f1a9e9] | 118 |
|
---|
[bd9de06d] | 119 | <screen><userinput>make fssum &&
|
---|
| 120 |
|
---|
[f1e50963] | 121 | sed -i '/found/s/^/: #/' tests/convert-tests.sh &&
|
---|
| 122 |
|
---|
[4dc9669] | 123 | mv tests/mkfs-tests/013-reserved-1M-for-single/test.sh{,.broken} &&
|
---|
| 124 | mv tests/convert-tests/010-reiserfs-basic/test.sh{,.broken} &&
|
---|
[f1e50963] | 125 | mv tests/convert-tests/011-reiserfs-delete-all-rollback/test.sh{,.broken} &&
|
---|
[4dc9669] | 126 | mv tests/convert-tests/012-reiserfs-large-hole-extent/test.sh{,.broken} &&
|
---|
| 127 | mv tests/convert-tests/013-reiserfs-common-inode-flags/test.sh{,.broken} &&
|
---|
| 128 | mv tests/convert-tests/014-reiserfs-tail-handling/test.sh{,.broken} &&
|
---|
[e6bce28] | 129 | mv tests/misc-tests/004-shrink-fs/test.sh{,.broken} &&
|
---|
| 130 | mv tests/misc-tests/013-subvolume-sync-crash/test.sh{,.broken} &&
|
---|
[4dc9669] | 131 | mv tests/misc-tests/025-zstd-compression/test.sh{,.broken} &&
|
---|
| 132 | mv tests/fuzz-tests/003-multi-check-unmounted/test.sh{,.broken} &&
|
---|
[bd9de06d] | 133 | mv tests/fuzz-tests/009-simple-zero-log/test.sh{,.broken}</userinput></screen>
|
---|
[32bc8e4c] | 134 |
|
---|
| 135 | <para>To test the results, issue (as the <systemitem
|
---|
| 136 | class="username">root</systemitem> user): </para>
|
---|
| 137 |
|
---|
| 138 | <screen><userinput>pushd tests
|
---|
| 139 | ./fsck-tests.sh
|
---|
| 140 | ./mkfs-tests.sh
|
---|
[bd9de06d] | 141 | ./cli-tests.sh
|
---|
[32bc8e4c] | 142 | ./convert-tests.sh
|
---|
| 143 | ./misc-tests.sh
|
---|
| 144 | ./fuzz-tests.sh
|
---|
| 145 | popd</userinput></screen>
|
---|
| 146 |
|
---|
| 147 | <para>Install the package as the <systemitem
|
---|
| 148 | class="username">root</systemitem> user:</para>
|
---|
[1f1a9e9] | 149 |
|
---|
[01e86d88] | 150 | <screen role="root"><userinput>make install &&
|
---|
[1f1a9e9] | 151 |
|
---|
[555dcb4a] | 152 | ln -sfv ../../lib/$(readlink /lib/libbtrfs.so) /usr/lib/libbtrfs.so &&
|
---|
[2565779] | 153 | ln -sfv ../../lib/$(readlink /lib/libbtrfsutil.so) /usr/lib/libbtrfsutil.so &&
|
---|
| 154 | rm -fv /lib/libbtrfs.{a,so} /lib/libbtrfsutil.{a,so} &&
|
---|
[f50481de] | 155 | mv -v /bin/{mkfs,fsck}.btrfs /sbin</userinput></screen>
|
---|
[1f1a9e9] | 156 |
|
---|
| 157 | </sect2>
|
---|
| 158 |
|
---|
| 159 | <sect2 role="commands">
|
---|
| 160 | <title>Command Explanations</title>
|
---|
| 161 |
|
---|
[61439d5] | 162 | <para><option>--disable-documentation</option>: This option
|
---|
| 163 | is needed if the recommended dependencies are not installed.</para>
|
---|
| 164 |
|
---|
[f1e50963] | 165 | <para><command>mv tests/{cli,convert,misc,fuzz}-tests/ ...</command>: Disables
|
---|
[32bc8e4c] | 166 | tests that fail and prevent tests from completing.</para>
|
---|
| 167 |
|
---|
[1f1a9e9] | 168 | <para><command>ln -s ... /usr/lib/libbtrfs.so</command>: Creates a
|
---|
| 169 | symbolic link in the directory where it is expected.</para>
|
---|
| 170 |
|
---|
| 171 | <para><command>rm /lib/libbtrfs.{a,so}</command>: Removes unneeded
|
---|
| 172 | library entries.</para>
|
---|
| 173 |
|
---|
| 174 | </sect2>
|
---|
| 175 |
|
---|
| 176 | <sect2 role="content">
|
---|
| 177 | <title>Contents</title>
|
---|
| 178 |
|
---|
| 179 | <segmentedlist>
|
---|
| 180 | <segtitle>Installed Programs</segtitle>
|
---|
| 181 | <segtitle>Installed Libraries</segtitle>
|
---|
| 182 | <segtitle>Installed Directories</segtitle>
|
---|
| 183 |
|
---|
| 184 | <seglistitem>
|
---|
| 185 | <seg>
|
---|
| 186 | btrfs,
|
---|
| 187 | btrfs-convert,
|
---|
| 188 | btrfs-find-root,
|
---|
| 189 | btrfs-image,
|
---|
| 190 | btrfs-map-logical,
|
---|
| 191 | btrfs-select-super,
|
---|
| 192 | btrfsck (link to btrfs),
|
---|
| 193 | btrfstune,
|
---|
| 194 | fsck.btrfs, and
|
---|
| 195 | mkfs.btrfs
|
---|
| 196 | </seg>
|
---|
| 197 |
|
---|
[5d01724] | 198 | <seg>
|
---|
| 199 | libbtrfs.so and
|
---|
| 200 | libbtrfsutil.so
|
---|
| 201 | </seg>
|
---|
[1f1a9e9] | 202 |
|
---|
| 203 | <seg>/usr/include/btrfs</seg>
|
---|
| 204 | </seglistitem>
|
---|
| 205 | </segmentedlist>
|
---|
| 206 |
|
---|
| 207 | <variablelist>
|
---|
| 208 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 209 | <?dbfo list-presentation="list"?>
|
---|
| 210 | <?dbhtml list-presentation="table"?>
|
---|
| 211 |
|
---|
| 212 | <varlistentry id="btrfs-prog">
|
---|
| 213 | <term><command>btrfs</command></term>
|
---|
| 214 | <listitem>
|
---|
| 215 | <para>
|
---|
| 216 | is the main interface into btrfs filesystem operations.
|
---|
| 217 | </para>
|
---|
| 218 | <indexterm zone="btrfs-progs btrfs-prog">
|
---|
| 219 | <primary sortas="b-btrfs">btrfs</primary>
|
---|
| 220 | </indexterm>
|
---|
| 221 | </listitem>
|
---|
| 222 | </varlistentry>
|
---|
| 223 |
|
---|
[292a840] | 224 | <varlistentry id="btrfs-convert">
|
---|
| 225 | <term><command>btrfs-convert</command></term>
|
---|
| 226 | <listitem>
|
---|
| 227 | <para>
|
---|
| 228 | converts from ext2/3/4 filesystem to btrfs.
|
---|
| 229 | </para>
|
---|
| 230 | <indexterm zone="btrfs-progs btrfs-convert">
|
---|
| 231 | <primary sortas="b-btrfs-convert">btrfs-convert</primary>
|
---|
| 232 | </indexterm>
|
---|
| 233 | </listitem>
|
---|
| 234 | </varlistentry>
|
---|
| 235 |
|
---|
| 236 | <varlistentry id="btrfs-find-root">
|
---|
| 237 | <term><command>btrfs-find-root</command></term>
|
---|
| 238 | <listitem>
|
---|
| 239 | <para>
|
---|
| 240 | is a filter to find btrfs root.
|
---|
| 241 | </para>
|
---|
| 242 | <indexterm zone="btrfs-progs btrfs-find-root">
|
---|
| 243 | <primary sortas="b-btrfs-find-root">btrfs-find-root</primary>
|
---|
| 244 | </indexterm>
|
---|
| 245 | </listitem>
|
---|
| 246 | </varlistentry>
|
---|
| 247 |
|
---|
| 248 | <varlistentry id="btrfs-map-logical">
|
---|
| 249 | <term><command>btrfs-map-logical</command></term>
|
---|
| 250 | <listitem>
|
---|
| 251 | <para>
|
---|
| 252 | maps btrfs logical extent to physical extent.
|
---|
| 253 | </para>
|
---|
| 254 | <indexterm zone="btrfs-progs btrfs-map-logical">
|
---|
| 255 | <primary sortas="b-btrfs-map-logical">btrfs-map-logical</primary>
|
---|
| 256 | </indexterm>
|
---|
| 257 | </listitem>
|
---|
| 258 | </varlistentry>
|
---|
| 259 |
|
---|
| 260 | <varlistentry id="btrfs-select-super">
|
---|
| 261 | <term><command>btrfs-select-super</command></term>
|
---|
| 262 | <listitem>
|
---|
| 263 | <para>
|
---|
| 264 | overwrites primary superblock with a backup copy.
|
---|
| 265 | </para>
|
---|
| 266 | <indexterm zone="btrfs-progs btrfs-select-super">
|
---|
| 267 | <primary sortas="b-btrfs-select-super">btrfs-select-super</primary>
|
---|
| 268 | </indexterm>
|
---|
| 269 | </listitem>
|
---|
| 270 | </varlistentry>
|
---|
| 271 |
|
---|
| 272 | <varlistentry id="btrfstune">
|
---|
| 273 | <term><command>btrfstune</command></term>
|
---|
| 274 | <listitem>
|
---|
| 275 | <para>
|
---|
| 276 | tunes various filesystem parameters.
|
---|
| 277 | </para>
|
---|
| 278 | <indexterm zone="btrfs-progs btrfstune">
|
---|
| 279 | <primary sortas="b-btrfstune">btrfstune</primary>
|
---|
| 280 | </indexterm>
|
---|
| 281 | </listitem>
|
---|
| 282 | </varlistentry>
|
---|
| 283 |
|
---|
[1f1a9e9] | 284 | <varlistentry id="fsck.btrfs">
|
---|
| 285 | <term><command>fsck.btrfs</command></term>
|
---|
| 286 | <listitem>
|
---|
| 287 | <para>
|
---|
| 288 | does nothing, but is present for consistency with fstab.
|
---|
| 289 | </para>
|
---|
| 290 | <indexterm zone="btrfs-progs fsck.btrfs">
|
---|
| 291 | <primary sortas="b-fsck.btrfs">fsck.btrfs</primary>
|
---|
| 292 | </indexterm>
|
---|
| 293 | </listitem>
|
---|
| 294 | </varlistentry>
|
---|
| 295 |
|
---|
| 296 | <varlistentry id="mkfs.btrfs">
|
---|
| 297 | <term><command>mkfs.btrfs</command></term>
|
---|
| 298 | <listitem>
|
---|
| 299 | <para>creates a btrfs file system.</para>
|
---|
| 300 | <indexterm zone="btrfs-progs mkfs.btrfs">
|
---|
| 301 | <primary sortas="b-mkfs.btrfs">mkfs.btrfs</primary>
|
---|
| 302 | </indexterm>
|
---|
| 303 | </listitem>
|
---|
| 304 | </varlistentry>
|
---|
| 305 |
|
---|
| 306 | </variablelist>
|
---|
| 307 |
|
---|
| 308 | </sect2>
|
---|
| 309 |
|
---|
| 310 | </sect1>
|
---|