[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 " ">
|
---|
[498e62a] | 10 | <!ENTITY libblockdev-md5sum "6476e5967753ee03d8e65f4d7837a4b6">
|
---|
| 11 | <!ENTITY libblockdev-size "908 KB">
|
---|
| 12 | <!ENTITY libblockdev-buildsize "14 MB">
|
---|
| 13 | <!ENTITY libblockdev-time "0.2 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">
|
---|
| 77 | <xref linkend="gobject-introspection"/>,
|
---|
[8558044] | 78 | <xref linkend="libbytesize"/>,
|
---|
[b738ceb] | 79 | <xref linkend="libyaml"/>,
|
---|
[8558044] | 80 | <xref linkend="parted"/>, and
|
---|
[b738ceb] | 81 | <xref linkend="volume_key"/>
|
---|
[6dcb9e77] | 82 | </para>
|
---|
| 83 |
|
---|
| 84 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 85 | <para role="optional">
|
---|
| 86 | <xref linkend="btrfs-progs"/>,
|
---|
| 87 | <xref linkend="gtk-doc"/>,
|
---|
| 88 | <xref linkend="mdadm"/>,
|
---|
[c6b192c] | 89 | <ulink url="https://people.redhat.com/~heinzm/sw/dmraid/">dmraid</ulink>,
|
---|
[36aab55] | 90 | <ulink url="https://bcachefs.org/">bcachefs</ulink>, and
|
---|
[16dc2c74] | 91 | <ulink url="https://github.com/pmem/ndctl">ndctl</ulink>
|
---|
[6dcb9e77] | 92 | </para>
|
---|
| 93 |
|
---|
| 94 | </sect2>
|
---|
| 95 |
|
---|
| 96 | <sect2 role="installation">
|
---|
| 97 | <title>Installation of libblockdev</title>
|
---|
[ca31bd3] | 98 | <!--
|
---|
[ce8e472] | 99 | <para>
|
---|
| 100 | Fix the usage of a glib function deprecated for security:
|
---|
| 101 | </para>
|
---|
| 102 |
|
---|
| 103 | <screen><userinput>sed 's/g_memdup/&2/' -i \
|
---|
| 104 | src/lib/plugin_apis/vdo.{c,api} \
|
---|
| 105 | src/plugins/vdo.c</userinput></screen>
|
---|
[ca31bd3] | 106 | -->
|
---|
[6dcb9e77] | 107 | <para>
|
---|
| 108 | Install <application>libblockdev</application> by running
|
---|
| 109 | the following commands:
|
---|
| 110 | </para>
|
---|
| 111 |
|
---|
[60ddbaf] | 112 | <screen><userinput>./configure --prefix=/usr \
|
---|
[ce794256] | 113 | --sysconfdir=/etc \
|
---|
[66d9ef8] | 114 | --with-python3 \
|
---|
| 115 | --without-gtk-doc \
|
---|
[16dc2c74] | 116 | --without-nvdimm \
|
---|
[ce794256] | 117 | --without-dm &&
|
---|
[6dcb9e77] | 118 | make</userinput></screen>
|
---|
| 119 |
|
---|
| 120 | <para>
|
---|
[453073a8] | 121 | This package does not come with a working test suite.
|
---|
[6dcb9e77] | 122 | </para>
|
---|
| 123 |
|
---|
| 124 | <para>
|
---|
| 125 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 126 | </para>
|
---|
| 127 |
|
---|
| 128 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 129 |
|
---|
| 130 | </sect2>
|
---|
| 131 | <!--
|
---|
| 132 | <sect2 role="commands">
|
---|
| 133 | <title>Command Explanations</title>
|
---|
| 134 |
|
---|
| 135 |
|
---|
| 136 | </sect2>
|
---|
| 137 | -->
|
---|
| 138 | <sect2 role="content">
|
---|
| 139 | <title>Contents</title>
|
---|
| 140 |
|
---|
| 141 | <segmentedlist>
|
---|
| 142 | <segtitle>Installed Programs</segtitle>
|
---|
| 143 | <segtitle>Installed Libraries</segtitle>
|
---|
| 144 | <segtitle>Installed Directories</segtitle>
|
---|
| 145 |
|
---|
| 146 | <seglistitem>
|
---|
| 147 | <seg>
|
---|
[4163b584] | 148 | lvm-cache-stats
|
---|
[6dcb9e77] | 149 | </seg>
|
---|
| 150 | <seg>
|
---|
[8558044] | 151 | libbd_btrfs.so,
|
---|
[6dcb9e77] | 152 | libbd_crypto.so,
|
---|
[8558044] | 153 | libbd_fs.so,
|
---|
[6dcb9e77] | 154 | libbd_kbd.so,
|
---|
| 155 | libbd_loop.so,
|
---|
| 156 | libbd_lvm.so,
|
---|
| 157 | libbd_lvm-dbus.so,
|
---|
| 158 | libbd_mdraid.so,
|
---|
| 159 | libbd_mpath.so,
|
---|
| 160 | libbd_part.so,
|
---|
| 161 | libbd_part_err.so,
|
---|
| 162 | libbd_swap.so,
|
---|
[4163b584] | 163 | libbd_utils.so,
|
---|
| 164 | libbd_vdo.so, and
|
---|
[6dcb9e77] | 165 | libblockdev.so
|
---|
| 166 | </seg>
|
---|
| 167 | <seg>
|
---|
[fa30d84] | 168 | /etc/libblockdev,
|
---|
| 169 | /usr/include/blockdev, and
|
---|
| 170 | /usr/share/gtk-doc/html/libblockdev
|
---|
[6dcb9e77] | 171 | </seg>
|
---|
| 172 | </seglistitem>
|
---|
| 173 | </segmentedlist>
|
---|
[4163b584] | 174 |
|
---|
[6dcb9e77] | 175 | <variablelist>
|
---|
| 176 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 177 | <?dbfo list-presentation="list"?>
|
---|
| 178 | <?dbhtml list-presentation="table"?>
|
---|
| 179 |
|
---|
[4163b584] | 180 | <varlistentry id="lvm-cache-stats">
|
---|
| 181 | <term><command>lvm-cache-stats</command></term>
|
---|
[6dcb9e77] | 182 | <listitem>
|
---|
| 183 | <para>
|
---|
[4c24eb0a] | 184 | prints statistics on caches on LVM Logical Volumes
|
---|
[6dcb9e77] | 185 | </para>
|
---|
[4163b584] | 186 | <indexterm zone="libblockdev lvm-cache-stats">
|
---|
| 187 | <primary sortas="b-lvm-cache-stats">lvm-cache-stats</primary>
|
---|
[6dcb9e77] | 188 | </indexterm>
|
---|
| 189 | </listitem>
|
---|
| 190 | </varlistentry>
|
---|
| 191 |
|
---|
| 192 | </variablelist>
|
---|
[4163b584] | 193 |
|
---|
[6dcb9e77] | 194 | </sect2>
|
---|
| 195 |
|
---|
| 196 | </sect1>
|
---|