source: archive/DeviceKit.xml@ d0cf396

<?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 DeviceKit-download-http "http://hal.freedesktop.org/releases/DeviceKit-&DeviceKit-version;.tar.gz">
  <!ENTITY DeviceKit-download-ftp  " ">
  <!ENTITY DeviceKit-md5sum        "8b311547f4a2c8c6b6598e3318d66cd7">
  <!ENTITY DeviceKit-size          "375 KB">
  <!ENTITY DeviceKit-buildsize     "3 MB">
  <!ENTITY DeviceKit-time          "0.1 SBU">
]>

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

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

  <title>DeviceKit-&DeviceKit-version;</title>

  <indexterm zone="DeviceKit">
    <primary sortas="a-DeviceKit">DeviceKit</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to DeviceKit</title>

    <para>The <application>DeviceKit</application> is a modular HAL designed for
    use in Linux systems that is designed to simplify device management and
    replace the current monolithic Linux <application>HAL</application>.
    DeviceKit includes the ability to enumerate system devices and send
    notifications when hardware is added or removed from the computer
    system.</para>

    &lfs65_checked;

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

    <bridgehead renderas="sect3">DeviceKit Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="dbus-glib"/> and
    <xref linkend="docbook-xsl"/></para>

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of DeviceKit</title>

    <para>Install <application>DeviceKit</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=/usr \
    --sysconfdir=/etc \
    --localstatedir=/var \
    --libexecdir=/usr/lib/DeviceKit &amp;&amp;
make</userinput></screen>

    <para>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</userinput></screen>

  </sect2>

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

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

      <seglistitem>
        <seg>devkit and devkit-daemon</seg>
        <seg>libdevkit-gobject.{so,a}</seg>
        <seg>/usr/{include/DeviceKit/devkit-gobject,lib/DeviceKit},
        /var/run/devkit</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="devkit">
        <term><command>devkit</command></term>
        <listitem>
          <para>is a simple command line client for the
          <application>DeviceKit</application> daemon.</para>
          <indexterm zone="DeviceKit devkit">
            <primary sortas="b-devkit">devkit</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="devkit-daemon">
        <term><command>devkit-daemon</command></term>
        <listitem>
          <para>provides the org.freedesktop.DeviceKit service on the system
          message bus.</para>
          <indexterm zone="DeviceKit devkit-daemon">
            <primary sortas="b-devkit-daemon">devkit-daemon</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libdevkit-gobject">
        <term><filename class='libraryfile'>libdevkit-gobject.{so,a}</filename></term>
        <listitem>
          <para>contains the <application>DeviceKit</application> API
          functions.</para>
          <indexterm zone="DeviceKit libdevkit-gobject">
            <primary sortas="c-libdevkit-gobject">libdevkit-gobject.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>