source: general/sysutils/Device-mapper.xml@ 600ef130

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY Device-mapper-download-http " ">
  <!ENTITY Device-mapper-download-ftp  "ftp://sources.redhat.com/pub/lvm2/LVM2.&LVM2-version;.tgz">
  <!ENTITY Device-mapper-md5sum        "321429cd1b1526a29cf6d75018b1e4bb">
  <!ENTITY Device-mapper-size          "1 MB">
  <!ENTITY Device-mapper-buildsize     "7.7 MB">
  <!ENTITY Device-mapper-time          "0.1 SBU">
]>

<sect1 id="device-mapper" xreflabel="device-mapper-&Device-mapper-version;">
  <?dbhtml filename="device-mapper.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>device-mapper-&Device-mapper-version;</title>

  <indexterm zone="device-mapper">
    <primary sortas="a-device-mapper">device-mapper</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to device-mapper</title>

    <para>The <application>device-mapper</application> package is an
    implementation of a minimalistic kernel-space driver that handles volume
    management, while keeping knowledge of the underlying device layout in
    user-space.</para>

    &lfs70_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <!--<listitem>
        <para>Download (HTTP): <ulink url="&Device-mapper-download-http;"/></para>
      </listitem>-->
      <listitem>
        <para>Download (FTP): <ulink url="&Device-mapper-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &Device-mapper-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &Device-mapper-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &Device-mapper-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &Device-mapper-time;</para>
      </listitem>
    </itemizedlist>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/device-mapper"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of device-mapper</title>

    <para>Install <application>device-mapper</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=/usr --enable-pkgconfig &amp;&amp;
make device-mapper</userinput></screen>

    <!-- Note, there is a test suite (make check), but it is for LVM2 -->

    <para>The device-mapper portion of this package does not come with a test
    suite.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install_device-mapper</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><parameter>--enable-pkgconfig</parameter>: This parameter installs
    pkgconfig support.</para>

    <para><option>--enable-dmeventd</option>: This option builds the
    device-mapper event daemon.</para>

    <para><option>--enable-cmdlib</option>: This option builds the shared
    command library. It is required when building the daemon.</para>

  </sect2>

  <!-- TODO  FIXME Need to create a boot script for dmeventd (devmapper-event)
  According to CBLFS, only needed in very specific situations.

  <sect2 role="configuration">
    <title>Configuring device-mapper</title>

    <sect3  id="device-mapper-init">
      <title>Boot Script</title>

      <para>To automatically start the <command>device-mapper</command> daemon
      when the system is rebooted, install the
      <filename>/etc/rc.d/init.d/device-mapper</filename>
      bootscript from the
      <xref linkend="bootscripts"/> package.</para>

      <indexterm zone="device-mapper device-mapper-init">
        <primary sortas="f-device-mapper">device-mapper</primary>
      </indexterm>

<screen role="root"><userinput>make install-device-mapper</userinput></screen>

    </sect3>

  </sect2>

  -->

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>dmeventd and dmsetup</seg>
        <seg>libdevmapper-event.so and libdevmapper.so</seg>
        <seg>None</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="dmsetup">
        <term><command>dmsetup</command></term>
        <listitem>
          <para>is a low level logical volume management tool.</para>
          <indexterm zone="device-mapper dmsetup">
            <primary sortas="b-dmsetup">dmsetup</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libdevmapper">
        <term><filename class='libraryfile'>libdevmapper.so</filename></term>
        <listitem>
          <para>contains the <application>device-mapper</application> API
          functions.</para>
          <indexterm zone="device-mapper libdevmapper">
            <primary sortas="c-libdevmapper">libdevmapper.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>