| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 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 "729b0927484ebb34e375849b632e287d">
|
|---|
| 10 | <!ENTITY btrfs-progs-size "2.5 MB">
|
|---|
| 11 | <!ENTITY btrfs-progs-buildsize "62 MB (transient files created during tests need up to 10 GB)">
|
|---|
| 12 | <!ENTITY btrfs-progs-time "0.3 SBU (with parallelism=4; add 2.5 SBU for tests, up to 14 SBU on slow disks)">
|
|---|
| 13 | ]>
|
|---|
| 14 |
|
|---|
| 15 | <sect1 id="btrfs-progs" xreflabel="btrfs-progs-&btrfs-progs-version;">
|
|---|
| 16 | <?dbhtml filename="btrfs-progs.html"?>
|
|---|
| 17 |
|
|---|
| 18 |
|
|---|
| 19 | <title>btrfs-progs-&btrfs-progs-version;</title>
|
|---|
| 20 |
|
|---|
| 21 | <indexterm zone="btrfs-progs">
|
|---|
| 22 | <primary sortas="a-btrfs-progs">btrfs-progs</primary>
|
|---|
| 23 | </indexterm>
|
|---|
| 24 |
|
|---|
| 25 | <sect2 role="package">
|
|---|
| 26 | <title>Introduction to btrfs-progs</title>
|
|---|
| 27 |
|
|---|
| 28 | <para>
|
|---|
| 29 | The <application>btrfs-progs</application> package contains
|
|---|
| 30 | administration and debugging tools for the B-tree file system (btrfs).
|
|---|
| 31 | </para>
|
|---|
| 32 |
|
|---|
| 33 | &lfs121_checked;
|
|---|
| 34 |
|
|---|
| 35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
|---|
| 36 | <itemizedlist spacing="compact">
|
|---|
| 37 | <listitem>
|
|---|
| 38 | <para>
|
|---|
| 39 | Download (HTTP): <ulink url="&btrfs-progs-download-http;"/>
|
|---|
| 40 | </para>
|
|---|
| 41 | </listitem>
|
|---|
| 42 | <listitem>
|
|---|
| 43 | <para>
|
|---|
| 44 | Download (FTP): <ulink url="&btrfs-progs-download-ftp;"/>
|
|---|
| 45 | </para>
|
|---|
| 46 | </listitem>
|
|---|
| 47 | <listitem>
|
|---|
| 48 | <para>
|
|---|
| 49 | Download MD5 sum: &btrfs-progs-md5sum;
|
|---|
| 50 | </para>
|
|---|
| 51 | </listitem>
|
|---|
| 52 | <listitem>
|
|---|
| 53 | <para>
|
|---|
| 54 | Download size: &btrfs-progs-size;
|
|---|
| 55 | </para>
|
|---|
| 56 | </listitem>
|
|---|
| 57 | <listitem>
|
|---|
| 58 | <para>
|
|---|
| 59 | Estimated disk space required: &btrfs-progs-buildsize;
|
|---|
| 60 | </para>
|
|---|
| 61 | </listitem>
|
|---|
| 62 | <listitem>
|
|---|
| 63 | <para>
|
|---|
| 64 | Estimated build time: &btrfs-progs-time;
|
|---|
| 65 | </para>
|
|---|
| 66 | </listitem>
|
|---|
| 67 | </itemizedlist>
|
|---|
| 68 | <!--
|
|---|
| 69 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
|---|
| 70 | <itemizedlist spacing="compact">
|
|---|
| 71 | <listitem>
|
|---|
| 72 | <para>
|
|---|
| 73 | Required patch if building with linux kernel headers version
|
|---|
| 74 | before 5.12:
|
|---|
| 75 | <ulink url="&patch-root;/btrfs-progs-&btrfs-progs-version;-headers_fix-1.patch"/>
|
|---|
| 76 | </para>
|
|---|
| 77 | </listitem>
|
|---|
| 78 | </itemizedlist>
|
|---|
| 79 | -->
|
|---|
| 80 | <bridgehead renderas="sect3">Btrfs-progs Dependencies</bridgehead>
|
|---|
| 81 |
|
|---|
| 82 | <bridgehead renderas="sect4">Required</bridgehead>
|
|---|
| 83 | <para role="required">
|
|---|
| 84 | <xref linkend="lzo"/>
|
|---|
| 85 | </para>
|
|---|
| 86 | <!-- In v6.2.1 (and maybe previous), sphinx is required for the doc
|
|---|
| 87 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
|---|
| 88 | <para role="recommended">
|
|---|
| 89 | <xref linkend="asciidoc"/> (or <xref role="nodep" linkend="asciidoctor"/>)
|
|---|
| 90 | and <xref linkend="xmlto"/> (both required to generate man pages)
|
|---|
| 91 | </para>
|
|---|
| 92 | -->
|
|---|
| 93 | <bridgehead renderas="sect4">Optional</bridgehead>
|
|---|
| 94 | <para role="optional">
|
|---|
| 95 | <xref linkend="lvm2"/> (<command>dmsetup</command> is used in tests),
|
|---|
| 96 | <xref linkend="sphinx"/> and <xref linkend="sphinx_rtd_theme"/>
|
|---|
| 97 | (required to build documentation), and
|
|---|
| 98 | <ulink
|
|---|
| 99 | url='https://mirrors.edge.kernel.org/pub/linux/kernel/people/jeffm/reiserfsprogs/'>
|
|---|
| 100 | reiserfsprogs</ulink> (for tests).
|
|---|
| 101 |
|
|---|
| 102 | </para>
|
|---|
| 103 |
|
|---|
| 104 |
|
|---|
| 105 | </sect2>
|
|---|
| 106 |
|
|---|
| 107 | <sect2 role="kernel" id="btrfs-progs-kernel">
|
|---|
| 108 | <title>Kernel Configuration</title>
|
|---|
| 109 |
|
|---|
| 110 | <para>
|
|---|
| 111 | Enable the following option in the kernel configuration
|
|---|
| 112 | and recompile the kernel:
|
|---|
| 113 | </para>
|
|---|
| 114 |
|
|---|
| 115 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
|---|
| 116 | href="btrfs-progs-kernel.xml"/>
|
|---|
| 117 |
|
|---|
| 118 | <para>
|
|---|
| 119 | In addition to the above and to the options required for
|
|---|
| 120 | <xref linkend="lvm2"/>, the following
|
|---|
| 121 | options must be enabled for running tests:
|
|---|
| 122 | </para>
|
|---|
| 123 |
|
|---|
| 124 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
|---|
| 125 | href="btrfs-progs-test-kernel.xml"/>
|
|---|
| 126 |
|
|---|
| 127 | <indexterm zone="btrfs-progs btrfs-progs-kernel">
|
|---|
| 128 | <primary sortas="d-btrfs-progs">BTRFS Programs</primary>
|
|---|
| 129 | </indexterm>
|
|---|
| 130 |
|
|---|
| 131 | </sect2>
|
|---|
| 132 |
|
|---|
| 133 | <sect2 role="installation">
|
|---|
| 134 | <title>Installation of btrfs-progs</title>
|
|---|
| 135 |
|
|---|
| 136 | <para>
|
|---|
| 137 | Install <application>btrfs-progs</application> by running the following
|
|---|
| 138 | commands:
|
|---|
| 139 | </para>
|
|---|
| 140 |
|
|---|
| 141 | <screen><userinput>./configure --prefix=/usr \
|
|---|
| 142 | --disable-static \
|
|---|
| 143 | --disable-documentation &&
|
|---|
| 144 | make</userinput></screen>
|
|---|
| 145 |
|
|---|
| 146 | <note>
|
|---|
| 147 | <para>
|
|---|
| 148 | Some tests require grep built with perl regular expressions. To
|
|---|
| 149 | obtain this, rebuild grep with the LFS Chapter 8 instructions after
|
|---|
| 150 | installing <xref linkend="pcre2"/>.
|
|---|
| 151 | </para>
|
|---|
| 152 | </note>
|
|---|
| 153 | <!-- Keeping this for now, but it seems that calling "make test" is
|
|---|
| 154 | simpler and does the same thing -->
|
|---|
| 155 | <para>
|
|---|
| 156 | Before running tests, build a support program:
|
|---|
| 157 | </para>
|
|---|
| 158 |
|
|---|
| 159 | <screen remap="test"><userinput>make fssum</userinput></screen>
|
|---|
| 160 |
|
|---|
| 161 | <para>
|
|---|
| 162 | To test the results, issue (as the &root; user):
|
|---|
| 163 | </para>
|
|---|
| 164 |
|
|---|
| 165 | <screen role="root" remap="test"><userinput>pushd tests
|
|---|
| 166 | ./fsck-tests.sh
|
|---|
| 167 | ./mkfs-tests.sh
|
|---|
| 168 | ./cli-tests.sh
|
|---|
| 169 | #./convert-tests.sh
|
|---|
| 170 | ./misc-tests.sh
|
|---|
| 171 | ./fuzz-tests.sh
|
|---|
| 172 | popd</userinput></screen>
|
|---|
| 173 |
|
|---|
| 174 | <!-- Template for failed test removal:
|
|---|
| 175 | the other ones to run:
|
|---|
| 176 | </para>
|
|---|
| 177 |
|
|---|
| 178 | <screen remap="test"><userinput>mv tests/fsck-tests/012-leaf-corruption/test.sh{,.broken}</userinput></screen>
|
|---|
| 179 | Substitute your test failure with the one above.
|
|---|
| 180 | <para>
|
|---|
| 181 | To test the results, run (as the
|
|---|
| 182 | <systemitem class="username">root</systemitem> user):
|
|---|
| 183 | </para>
|
|---|
| 184 |
|
|---|
| 185 | <screen role="root" remap="test"><userinput>make -j1 -k test</userinput></screen>
|
|---|
| 186 | -->
|
|---|
| 187 | <note>
|
|---|
| 188 | <para>
|
|---|
| 189 | If the above mentioned kernel options are not enabled, some tests
|
|---|
| 190 | fail, and prevent all the remaining tests from running because the test
|
|---|
| 191 | disk image is not cleanly unmounted.
|
|---|
| 192 | </para>
|
|---|
| 193 | </note>
|
|---|
| 194 |
|
|---|
| 195 | <para>
|
|---|
| 196 | The convert-tests scripts are known to fail.
|
|---|
| 197 | Tests 004-shrink-fs and 062-fi-show-raw-dm-all-devices in the misc-tests
|
|---|
| 198 | are known to fail.
|
|---|
| 199 | </para>
|
|---|
| 200 |
|
|---|
| 201 | <para>
|
|---|
| 202 | Install the package as the &root; user:
|
|---|
| 203 | </para>
|
|---|
| 204 |
|
|---|
| 205 | <screen role="root"><userinput>make install</userinput></screen>
|
|---|
| 206 |
|
|---|
| 207 | <para>
|
|---|
| 208 | If you have passed <parameter>--disable-documentation</parameter> to
|
|---|
| 209 | <command>configure</command> and you need the manual pages, install them
|
|---|
| 210 | by running, as the &root; user:
|
|---|
| 211 | </para>
|
|---|
| 212 |
|
|---|
| 213 | <screen role="root"><userinput>for i in 5 8; do
|
|---|
| 214 | install Documentation/*.$i /usr/share/man/man$i
|
|---|
| 215 | done</userinput></screen>
|
|---|
| 216 |
|
|---|
| 217 | </sect2>
|
|---|
| 218 |
|
|---|
| 219 | <sect2 role="commands">
|
|---|
| 220 | <title>Command Explanations</title>
|
|---|
| 221 |
|
|---|
| 222 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
|---|
| 223 | href="../../xincludes/static-libraries.xml"/>
|
|---|
| 224 |
|
|---|
| 225 | <para>
|
|---|
| 226 | <parameter>--disable-documentation</parameter>: This switch
|
|---|
| 227 | disables rebuilding the manual pages, because it requires
|
|---|
| 228 | <xref linkend="sphinx"/>.
|
|---|
| 229 | </para>
|
|---|
| 230 | <!--
|
|---|
| 231 | <para>
|
|---|
| 232 | <command>sed 's/,orphan_file//" ...</command>: In this version of
|
|---|
| 233 | <application>btrfs-progs</application>, the
|
|---|
| 234 | <command>btrfs-convert</command> program produces a btrfs filesystem
|
|---|
| 235 | containing errors if converting from an ext4 filesystem created
|
|---|
| 236 | with the <quote>orphan_file</quote> feature. This command creates
|
|---|
| 237 | a custom configuration file that prevents creating a filesystem
|
|---|
| 238 | with this feature.
|
|---|
| 239 | </para>
|
|---|
| 240 | -->
|
|---|
| 241 | <!--
|
|---|
| 242 | <para>
|
|---|
| 243 | <command>ln -s ... /usr/lib/libbtrfs.so</command>: Creates a
|
|---|
| 244 | symbolic link in the directory where it is expected.
|
|---|
| 245 | </para>
|
|---|
| 246 |
|
|---|
| 247 | <para>
|
|---|
| 248 | <command>rm /lib/libbtrfs.{a,so}</command>: Removes unneeded
|
|---|
| 249 | library entries.
|
|---|
| 250 | </para>
|
|---|
| 251 | -->
|
|---|
| 252 | </sect2>
|
|---|
| 253 | <!--
|
|---|
| 254 | <sect2 role="using" id="using-btrfs-convert">
|
|---|
| 255 | <title>Using the btrfs-convert Program</title>
|
|---|
| 256 |
|
|---|
| 257 | <para>
|
|---|
| 258 | This version of <application>btrfs-progs</application> does not convert
|
|---|
| 259 | correctly ext4 filesystems to btrfs if the ext4
|
|---|
| 260 | <option>orphan_file</option> feature is turned on. If you happen to
|
|---|
| 261 | convert such a filesystem, you need to first run:
|
|---|
| 262 | </para>
|
|---|
| 263 |
|
|---|
| 264 | <screen role="nodump"><userinput>tune2fs -O ^orphan_file <replaceable>/dev/sdxx</replaceable></userinput></screen>
|
|---|
| 265 |
|
|---|
| 266 | <para>
|
|---|
| 267 | where <filename>/dev/sdxx</filename> is the partition of the filesystem
|
|---|
| 268 | you want to convert.
|
|---|
| 269 | </para>
|
|---|
| 270 | </sect2>
|
|---|
| 271 | -->
|
|---|
| 272 |
|
|---|
| 273 | <sect2 role="content">
|
|---|
| 274 | <title>Contents</title>
|
|---|
| 275 |
|
|---|
| 276 | <segmentedlist>
|
|---|
| 277 | <segtitle>Installed Programs</segtitle>
|
|---|
| 278 | <segtitle>Installed Libraries</segtitle>
|
|---|
| 279 | <segtitle>Installed Directories</segtitle>
|
|---|
| 280 |
|
|---|
| 281 | <seglistitem>
|
|---|
| 282 | <seg>
|
|---|
| 283 | btrfs,
|
|---|
| 284 | btrfs-convert,
|
|---|
| 285 | btrfs-find-root,
|
|---|
| 286 | btrfs-image,
|
|---|
| 287 | btrfs-map-logical,
|
|---|
| 288 | btrfs-select-super,
|
|---|
| 289 | btrfsck (link to btrfs),
|
|---|
| 290 | btrfstune,
|
|---|
| 291 | fsck.btrfs, and
|
|---|
| 292 | mkfs.btrfs
|
|---|
| 293 | </seg>
|
|---|
| 294 |
|
|---|
| 295 | <seg>
|
|---|
| 296 | libbtrfs.so and
|
|---|
| 297 | libbtrfsutil.so
|
|---|
| 298 | </seg>
|
|---|
| 299 |
|
|---|
| 300 | <seg>/usr/include/btrfs</seg>
|
|---|
| 301 | </seglistitem>
|
|---|
| 302 | </segmentedlist>
|
|---|
| 303 |
|
|---|
| 304 | <variablelist>
|
|---|
| 305 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|---|
| 306 | <?dbfo list-presentation="list"?>
|
|---|
| 307 | <?dbhtml list-presentation="table"?>
|
|---|
| 308 |
|
|---|
| 309 | <varlistentry id="btrfs-prog">
|
|---|
| 310 | <term><command>btrfs</command></term>
|
|---|
| 311 | <listitem>
|
|---|
| 312 | <para>
|
|---|
| 313 | is the main interface into btrfs filesystem operations
|
|---|
| 314 | </para>
|
|---|
| 315 | <indexterm zone="btrfs-progs btrfs-prog">
|
|---|
| 316 | <primary sortas="b-btrfs">btrfs</primary>
|
|---|
| 317 | </indexterm>
|
|---|
| 318 | </listitem>
|
|---|
| 319 | </varlistentry>
|
|---|
| 320 |
|
|---|
| 321 | <varlistentry id="btrfs-convert">
|
|---|
| 322 | <term><command>btrfs-convert</command></term>
|
|---|
| 323 | <listitem>
|
|---|
| 324 | <para>
|
|---|
| 325 | converts from an ext2/3/4 or reiserfs filesystem to btrfs <!--(see
|
|---|
| 326 | <xref linkend="using-btrfs-convert"/> above)-->
|
|---|
| 327 | </para>
|
|---|
| 328 | <indexterm zone="btrfs-progs btrfs-convert">
|
|---|
| 329 | <primary sortas="b-btrfs-convert">btrfs-convert</primary>
|
|---|
| 330 | </indexterm>
|
|---|
| 331 | </listitem>
|
|---|
| 332 | </varlistentry>
|
|---|
| 333 |
|
|---|
| 334 | <varlistentry id="btrfs-find-root">
|
|---|
| 335 | <term><command>btrfs-find-root</command></term>
|
|---|
| 336 | <listitem>
|
|---|
| 337 | <para>
|
|---|
| 338 | is a filter to find btrfs root
|
|---|
| 339 | </para>
|
|---|
| 340 | <indexterm zone="btrfs-progs btrfs-find-root">
|
|---|
| 341 | <primary sortas="b-btrfs-find-root">btrfs-find-root</primary>
|
|---|
| 342 | </indexterm>
|
|---|
| 343 | </listitem>
|
|---|
| 344 | </varlistentry>
|
|---|
| 345 |
|
|---|
| 346 | <varlistentry id="btrfs-map-logical">
|
|---|
| 347 | <term><command>btrfs-map-logical</command></term>
|
|---|
| 348 | <listitem>
|
|---|
| 349 | <para>
|
|---|
| 350 | maps btrfs logical extent to physical extent
|
|---|
| 351 | </para>
|
|---|
| 352 | <indexterm zone="btrfs-progs btrfs-map-logical">
|
|---|
| 353 | <primary sortas="b-btrfs-map-logical">btrfs-map-logical</primary>
|
|---|
| 354 | </indexterm>
|
|---|
| 355 | </listitem>
|
|---|
| 356 | </varlistentry>
|
|---|
| 357 |
|
|---|
| 358 | <varlistentry id="btrfs-select-super">
|
|---|
| 359 | <term><command>btrfs-select-super</command></term>
|
|---|
| 360 | <listitem>
|
|---|
| 361 | <para>
|
|---|
| 362 | overwrites the primary superblock with a backup copy
|
|---|
| 363 | </para>
|
|---|
| 364 | <indexterm zone="btrfs-progs btrfs-select-super">
|
|---|
| 365 | <primary sortas="b-btrfs-select-super">btrfs-select-super</primary>
|
|---|
| 366 | </indexterm>
|
|---|
| 367 | </listitem>
|
|---|
| 368 | </varlistentry>
|
|---|
| 369 |
|
|---|
| 370 | <varlistentry id="btrfstune">
|
|---|
| 371 | <term><command>btrfstune</command></term>
|
|---|
| 372 | <listitem>
|
|---|
| 373 | <para>
|
|---|
| 374 | tunes various filesystem parameters
|
|---|
| 375 | </para>
|
|---|
| 376 | <indexterm zone="btrfs-progs btrfstune">
|
|---|
| 377 | <primary sortas="b-btrfstune">btrfstune</primary>
|
|---|
| 378 | </indexterm>
|
|---|
| 379 | </listitem>
|
|---|
| 380 | </varlistentry>
|
|---|
| 381 |
|
|---|
| 382 | <varlistentry id="fsck.btrfs">
|
|---|
| 383 | <term><command>fsck.btrfs</command></term>
|
|---|
| 384 | <listitem>
|
|---|
| 385 | <para>
|
|---|
| 386 | does nothing, but is present for consistency with fstab
|
|---|
| 387 | </para>
|
|---|
| 388 | <indexterm zone="btrfs-progs fsck.btrfs">
|
|---|
| 389 | <primary sortas="b-fsck.btrfs">fsck.btrfs</primary>
|
|---|
| 390 | </indexterm>
|
|---|
| 391 | </listitem>
|
|---|
| 392 | </varlistentry>
|
|---|
| 393 |
|
|---|
| 394 | <varlistentry id="mkfs.btrfs">
|
|---|
| 395 | <term><command>mkfs.btrfs</command></term>
|
|---|
| 396 | <listitem>
|
|---|
| 397 | <para>
|
|---|
| 398 | creates a btrfs file system
|
|---|
| 399 | </para>
|
|---|
| 400 | <indexterm zone="btrfs-progs mkfs.btrfs">
|
|---|
| 401 | <primary sortas="b-mkfs.btrfs">mkfs.btrfs</primary>
|
|---|
| 402 | </indexterm>
|
|---|
| 403 | </listitem>
|
|---|
| 404 | </varlistentry>
|
|---|
| 405 |
|
|---|
| 406 | </variablelist>
|
|---|
| 407 |
|
|---|
| 408 | </sect2>
|
|---|
| 409 |
|
|---|
| 410 | </sect1>
|
|---|
