[6dcb9e77] | 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 libblockdev-download-http
|
---|
[5bffcec7] | 8 | "https://github.com/storaged-project/libblockdev/releases/download/&libblockdev-version;-1/libblockdev-&libblockdev-version;.tar.gz">
|
---|
[6dcb9e77] | 9 | <!ENTITY libblockdev-download-ftp " ">
|
---|
[a4013fa] | 10 | <!ENTITY libblockdev-md5sum "ef5dd9a42ac7d31d88842222773ded70">
|
---|
| 11 | <!ENTITY libblockdev-size "1.0 MB">
|
---|
| 12 | <!ENTITY libblockdev-buildsize "16 MB">
|
---|
| 13 | <!ENTITY libblockdev-time "0.1 SBU">
|
---|
[6dcb9e77] | 14 | ]>
|
---|
| 15 |
|
---|
| 16 | <sect1 id="libblockdev" xreflabel="libblockdev-&libblockdev-version;">
|
---|
| 17 | <?dbhtml filename="libblockdev.html"?>
|
---|
| 18 |
|
---|
| 19 |
|
---|
| 20 | <title>libblockdev-&libblockdev-version;</title>
|
---|
| 21 |
|
---|
| 22 | <indexterm zone="libblockdev">
|
---|
| 23 | <primary sortas="a-libblockdev">libblockdev</primary>
|
---|
| 24 | </indexterm>
|
---|
| 25 |
|
---|
| 26 | <sect2 role="package">
|
---|
| 27 | <title>Introduction to libblockdev</title>
|
---|
| 28 |
|
---|
| 29 | <para>
|
---|
[0ecaac7] | 30 | libblockdev is a C library supporting GObject Introspection for
|
---|
[6dcb9e77] | 31 | manipulation of block devices. It has a plugin-based architecture where
|
---|
| 32 | each technology (like LVM, Btrfs, MD RAID, Swap,...) is implemented in a
|
---|
| 33 | separate plugin, possibly with multiple implementations (e.g. using LVM
|
---|
| 34 | CLI or the new LVM DBus API).
|
---|
| 35 | </para>
|
---|
| 36 |
|
---|
[acd88fc] | 37 | &lfs113_checked;
|
---|
[6dcb9e77] | 38 |
|
---|
| 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>
|
---|
| 43 | Download (HTTP): <ulink url="&libblockdev-download-http;"/>
|
---|
| 44 | </para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download (FTP): <ulink url="&libblockdev-download-ftp;"/>
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Download MD5 sum: &libblockdev-md5sum;
|
---|
| 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Download size: &libblockdev-size;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
| 63 | Estimated disk space required: &libblockdev-buildsize;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>
|
---|
| 68 | Estimated build time: &libblockdev-time;
|
---|
| 69 | </para>
|
---|
| 70 | </listitem>
|
---|
| 71 | </itemizedlist>
|
---|
| 72 |
|
---|
| 73 | <bridgehead renderas="sect3">libblockdev Dependencies</bridgehead>
|
---|
| 74 |
|
---|
| 75 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 76 | <para role="required">
|
---|
[d5e4de79] | 77 | <xref linkend="glib2"/>
|
---|
[6dcb9e77] | 78 | </para>
|
---|
| 79 |
|
---|
[a4013fa] | 80 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 81 | <para role="recommended">
|
---|
[d5e4de79] | 82 | <xref linkend="cryptsetup"/>,
|
---|
| 83 | <xref linkend="gobject-introspection"/> (required for GNOME),
|
---|
| 84 | <xref linkend="keyutils"/>,
|
---|
| 85 | <xref linkend="libbytesize"/>,
|
---|
| 86 | <xref linkend="libnvme"/>, and
|
---|
| 87 | <xref linkend="lvm2"/>
|
---|
[a4013fa] | 88 | </para>
|
---|
| 89 |
|
---|
[6dcb9e77] | 90 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 91 | <para role="optional">
|
---|
| 92 | <xref linkend="btrfs-progs"/>,
|
---|
| 93 | <xref linkend="gtk-doc"/>,
|
---|
| 94 | <xref linkend="mdadm"/>,
|
---|
[d5e4de79] | 95 | <xref linkend="parted"/>,
|
---|
| 96 | <xref linkend="volume_key"/>,
|
---|
[c6b192c] | 97 | <ulink url="https://people.redhat.com/~heinzm/sw/dmraid/">dmraid</ulink>,
|
---|
[36aab55] | 98 | <ulink url="https://bcachefs.org/">bcachefs</ulink>, and
|
---|
[16dc2c74] | 99 | <ulink url="https://github.com/pmem/ndctl">ndctl</ulink>
|
---|
[6dcb9e77] | 100 | </para>
|
---|
| 101 |
|
---|
| 102 | </sect2>
|
---|
| 103 |
|
---|
| 104 | <sect2 role="installation">
|
---|
| 105 | <title>Installation of libblockdev</title>
|
---|
[ca31bd3] | 106 | <!--
|
---|
[ce8e472] | 107 | <para>
|
---|
| 108 | Fix the usage of a glib function deprecated for security:
|
---|
| 109 | </para>
|
---|
| 110 |
|
---|
| 111 | <screen><userinput>sed 's/g_memdup/&2/' -i \
|
---|
| 112 | src/lib/plugin_apis/vdo.{c,api} \
|
---|
| 113 | src/plugins/vdo.c</userinput></screen>
|
---|
[ca31bd3] | 114 | -->
|
---|
[6dcb9e77] | 115 | <para>
|
---|
| 116 | Install <application>libblockdev</application> by running
|
---|
| 117 | the following commands:
|
---|
| 118 | </para>
|
---|
| 119 |
|
---|
[d5e4de79] | 120 | <screen><userinput>./configure --prefix=/usr \
|
---|
| 121 | --sysconfdir=/etc \
|
---|
| 122 | --with-python3 \
|
---|
| 123 | --without-escrow \
|
---|
| 124 | --without-gtk-doc \
|
---|
| 125 | --without-lvm \
|
---|
| 126 | --without-lvm_dbus \
|
---|
| 127 | --without-nvdimm \
|
---|
| 128 | --without-tools &&
|
---|
[6dcb9e77] | 129 | make</userinput></screen>
|
---|
| 130 |
|
---|
| 131 | <para>
|
---|
[453073a8] | 132 | This package does not come with a working test suite.
|
---|
[6dcb9e77] | 133 | </para>
|
---|
| 134 |
|
---|
| 135 | <para>
|
---|
| 136 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 137 | </para>
|
---|
| 138 |
|
---|
| 139 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 140 |
|
---|
| 141 | </sect2>
|
---|
[d5e4de79] | 142 |
|
---|
[6dcb9e77] | 143 | <sect2 role="commands">
|
---|
| 144 | <title>Command Explanations</title>
|
---|
| 145 |
|
---|
[d5e4de79] | 146 | <para>
|
---|
| 147 | <parameter>--without-escrow</parameter>: This switch allows building
|
---|
| 148 | <application>libblockdev</application> without
|
---|
| 149 | <xref linkend="volume_key"/> installed. Remove it if you've installed
|
---|
| 150 | <xref linkend="volume_key"/>.
|
---|
| 151 | </para>
|
---|
| 152 |
|
---|
| 153 | <para>
|
---|
| 154 | <parameter>--without-lvm --without-lvm_dbus
|
---|
| 155 | --without-tools</parameter>: The combination of these switches allows
|
---|
| 156 | building <application>libblockdev</application> without
|
---|
| 157 | <xref linkend="parted"/> installed. Remove it if you've installed
|
---|
| 158 | <xref linkend="parted"/> and wish to build the
|
---|
| 159 | <command>lvm-cache-stats</command> or <command>vfat-resize</command>
|
---|
| 160 | utilities, or wish <application>libblockdev</application> to support
|
---|
| 161 | logical volumes.
|
---|
| 162 | </para>
|
---|
| 163 |
|
---|
| 164 | <para>
|
---|
| 165 | <option>--without-btrfs --without-mdraid --without-tools</option>:
|
---|
| 166 | The combination of these switches allows building
|
---|
| 167 | <application>libblockdev</application> without
|
---|
| 168 | <xref linkend="libbytesize"/> installed. The
|
---|
| 169 | <option>--without-mdraid</option> option will break
|
---|
| 170 | <xref linkend="udisks2"/>, so don't use it unless you really know what
|
---|
| 171 | you are doing.
|
---|
| 172 | </para>
|
---|
| 173 |
|
---|
| 174 | <para>
|
---|
| 175 | <option>--without-crypto</option>: This switch allows building
|
---|
| 176 | <application>libblockdev</application> without
|
---|
| 177 | <xref linkend="cryptsetup"/> or <xref linkend="keyutils"/> installed.
|
---|
| 178 | This switch will break <xref linkend="udisks2"/>, so don't use it
|
---|
| 179 | unless you really know what you are doing.
|
---|
| 180 | </para>
|
---|
| 181 |
|
---|
| 182 | <para>
|
---|
| 183 | <option>--without-dm --without-lvm --without-lvm_dbus
|
---|
| 184 | --without-mpath</option>: The combination of these switches allows
|
---|
| 185 | building <application>libblockdev</application> without
|
---|
| 186 | <xref linkend="lvm2"/> installed. The <option>--without-dm</option>
|
---|
| 187 | and <option>--without-mpath</option> options are not in the
|
---|
| 188 | instruction in the instruction provided by the book because
|
---|
| 189 | <xref linkend="lvm2"/> is required for <xref linkend="cryptsetup"/>
|
---|
| 190 | and <xref linkend="cryptsetup"/> is a recommended dependency of
|
---|
| 191 | <application>libblockdev</application> anyway.
|
---|
| 192 | </para>
|
---|
| 193 |
|
---|
| 194 | <para>
|
---|
| 195 | <option>--without-nvme</option>: This switch allows building
|
---|
| 196 | <application>libblockdev</application> without
|
---|
| 197 | <xref linkend="libnvme"/> installed. This switch will break
|
---|
| 198 | <xref linkend="udisks2"/>, so don't use it unless you really know what
|
---|
| 199 | you are doing.
|
---|
| 200 | </para>
|
---|
[6dcb9e77] | 201 |
|
---|
| 202 | </sect2>
|
---|
[d5e4de79] | 203 |
|
---|
[6dcb9e77] | 204 | <sect2 role="content">
|
---|
| 205 | <title>Contents</title>
|
---|
| 206 |
|
---|
| 207 | <segmentedlist>
|
---|
| 208 | <segtitle>Installed Programs</segtitle>
|
---|
| 209 | <segtitle>Installed Libraries</segtitle>
|
---|
| 210 | <segtitle>Installed Directories</segtitle>
|
---|
| 211 |
|
---|
| 212 | <seglistitem>
|
---|
| 213 | <seg>
|
---|
[d5e4de79] | 214 | lvm-cache-stats and vfat-resize (both optional)
|
---|
[6dcb9e77] | 215 | </seg>
|
---|
| 216 | <seg>
|
---|
[8558044] | 217 | libbd_btrfs.so,
|
---|
[6dcb9e77] | 218 | libbd_crypto.so,
|
---|
[d5e4de79] | 219 | libbd_dm.so,
|
---|
[8558044] | 220 | libbd_fs.so,
|
---|
[6dcb9e77] | 221 | libbd_loop.so,
|
---|
[d5e4de79] | 222 | libbd_lvm.so (optional),
|
---|
| 223 | libbd_lvm-dbus.so (optional),
|
---|
[6dcb9e77] | 224 | libbd_mdraid.so,
|
---|
| 225 | libbd_mpath.so,
|
---|
[d5e4de79] | 226 | libbd_nvme.so,
|
---|
[6dcb9e77] | 227 | libbd_part.so,
|
---|
| 228 | libbd_swap.so,
|
---|
[d5e4de79] | 229 | libbd_utils.so, and
|
---|
[6dcb9e77] | 230 | libblockdev.so
|
---|
| 231 | </seg>
|
---|
| 232 | <seg>
|
---|
[fa30d84] | 233 | /etc/libblockdev,
|
---|
| 234 | /usr/include/blockdev, and
|
---|
[d5e4de79] | 235 | /usr/share/gtk-doc/html/libblockdev (optional)
|
---|
[6dcb9e77] | 236 | </seg>
|
---|
| 237 | </seglistitem>
|
---|
| 238 | </segmentedlist>
|
---|
[4163b584] | 239 |
|
---|
[6dcb9e77] | 240 | <variablelist>
|
---|
| 241 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 242 | <?dbfo list-presentation="list"?>
|
---|
| 243 | <?dbhtml list-presentation="table"?>
|
---|
| 244 |
|
---|
[4163b584] | 245 | <varlistentry id="lvm-cache-stats">
|
---|
| 246 | <term><command>lvm-cache-stats</command></term>
|
---|
[6dcb9e77] | 247 | <listitem>
|
---|
| 248 | <para>
|
---|
[4c24eb0a] | 249 | prints statistics on caches on LVM Logical Volumes
|
---|
[6dcb9e77] | 250 | </para>
|
---|
[4163b584] | 251 | <indexterm zone="libblockdev lvm-cache-stats">
|
---|
| 252 | <primary sortas="b-lvm-cache-stats">lvm-cache-stats</primary>
|
---|
[6dcb9e77] | 253 | </indexterm>
|
---|
| 254 | </listitem>
|
---|
| 255 | </varlistentry>
|
---|
| 256 |
|
---|
[d5e4de79] | 257 | <varlistentry id="vfat-resize">
|
---|
| 258 | <term><command>vfat-resize</command></term>
|
---|
| 259 | <listitem>
|
---|
| 260 | <para>
|
---|
| 261 | resizes <systemitem class="filesystem">vfat</systemitem>
|
---|
| 262 | file systems
|
---|
| 263 | </para>
|
---|
| 264 | <indexterm zone="libblockdev vfat-resize">
|
---|
| 265 | <primary sortas="b-vfat-resize">vfat-resize</primary>
|
---|
| 266 | </indexterm>
|
---|
| 267 | </listitem>
|
---|
| 268 | </varlistentry>
|
---|
[6dcb9e77] | 269 | </variablelist>
|
---|
[4163b584] | 270 |
|
---|
[6dcb9e77] | 271 | </sect2>
|
---|
| 272 |
|
---|
| 273 | </sect1>
|
---|