source: general/sysutils/udisks.xml@ 69b2349

<?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 udisks-download-http "http://hal.freedesktop.org/releases/udisks-&udisks-version;.tar.gz">
  <!ENTITY udisks-download-ftp  " ">
  <!ENTITY udisks-md5sum        "70d48dcfe523a74cd7c7fbbc2847fcdd">
  <!ENTITY udisks-size          "720 KB">
  <!ENTITY udisks-buildsize     "12 MB">
  <!ENTITY udisks-time          "0.1 SBU">
]>

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

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

  <title>UDisks-&udisks-version;</title>

  <indexterm zone="udisks">
    <primary sortas="a-UDisks">UDisks</primary>
  </indexterm>

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

    <para>
      The <application>UDisks</application> package provides a
      storage daemon that implements well-defined D-Bus interfaces
      that can be used to query and manipulate storage devices.
    </para>

    &lfs79_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="dbus-glib"/>,
      <xref linkend="libatasmart"/>,
      <xref linkend="libgudev"/>,
      <xref linkend="lvm2"/>,
      <xref linkend="parted"/>,
      <xref linkend="polkit"/>, and
      <xref linkend="sg3_utils"/>
    </para>

    <bridgehead renderas="sect4" revision="systemd">Recommended</bridgehead>
    <para role="recommended" revision="systemd">
      <xref linkend="systemd"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/>,
      <xref linkend="libxslt"/> and
      <xref linkend="sudo"/> (to run the test)
    </para>

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

  </sect2>

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

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

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

    <para>
      To test the results, issue: <command>make check</command>.
    </para>

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

<screen role="root"><userinput>make profiledir=/etc/bash_completion.d install</userinput></screen>

  </sect2>

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

   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/gtk-doc-rebuild.xml"/>

  </sect2>

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

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

      <seglistitem>
        <seg>
          udisks,
          udisks-daemon,
          udisks-tcp-bridge, and
          umount.udisks
        </seg>
        <seg>
          None
        </seg>
        <seg>
          /usr/share/gtk-doc/html/udisks and
          /var/lib/udisks
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="udisks-prog">
        <term><command>udisks</command></term>
        <listitem>
          <para>
            is a simple command line interface for the
            <application>UDisks</application> Daemon.
          </para>
          <indexterm zone="udisks udisks-prog">
            <primary sortas="b-udisks">udisks</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="udisks-tcp-bridge">
        <term><command>udisks-tcp-bridge</command></term>
        <listitem>
          <para>
            is the <application>UDisks</application> TCP/IP bridge.
          </para>
          <indexterm zone="udisks udisks-tcp-bridge">
            <primary sortas="b-udisks-tcp-bridge">udisks-tcp-bridge</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="udisks-daemon">
        <term><command>udisks-daemon</command></term>
        <listitem>
          <para>
            is the <application>UDisks</application> Daemon.
          </para>
          <indexterm zone="udisks udisks-daemon">
            <primary sortas="b-udisks-daemon">udisks-daemon</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>