source: general/sysutils/udisks.xml@ f82e434

<?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-1.0.1.tar.gz">
  <!ENTITY udisks-download-ftp  " ">
  <!ENTITY udisks-md5sum        "3654d994eb43b80c8c2d04fe03da30c4">
  <!ENTITY udisks-size          "698 MB">
  <!ENTITY udisks-buildsize     "10 MB">
  <!ENTITY udisks-time          "0.2 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 is a daemon that provide
    interfaces to obtain information and perform operations on storage
    devices.</para>

    &lfs70_built;

    <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="parted"/> (with <xref linkend="lvm2"/>, device-mapper),
    <xref linkend="polkit"/>,
    <xref linkend="sg3_utils"/>, and
    <xref linkend="udev"/> (gudev)</para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="gtk-doc"/> 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 \
            --libexecdir=/usr/lib/udisks \
            --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 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"/>

    <para><option>--enable-static=no</option>: This switch prevents the static
    libraries being installed.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>udisks-dm-export, udisks-part-id, udisks-probe-ata-smart,
        udisks-probe-sas-expander, umount.udisks, udisks, udisks-tcp-bridge,
        udisks-daemon, udisks-helper-ata-smart-collect,
        udisks-helper-ata-smart-selftest, udisks-helper-change-filesystem-label,
        udisks-helper-change-luks-password, udisks-helper-create-partition,
        udisks-helper-create-partition-table, udisks-helper-delete-partition,
        udisks-helper-drive-benchmark, udisks-helper-drive-detach,
        udisks-helper-drive-poll, udisks-helper-fstab-mounter,
        udisks-helper-linux-md-check, udisks-helper-linux-md-remove-component,
        udisks-helper-mdadm-expand, udisks-helper-mkfs, and
        udisks-helper-modify-partition</seg>
        <seg>libudisks-action-lookup.{so,a}</seg>
        <seg>/usr/lib/udisks, /var/{lib/udisks,run/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 command line tool.</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 a <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>

      <varlistentry id="libudisks-action-lookup">
        <term><filename class='libraryfile'>libudisks-action-lookup.{so,a}</filename></term>
        <listitem>
          <para>is a <application>polkit</application> extension.</para>
          <indexterm zone="udisks libudisks-action-lookup">
            <primary sortas="c-libudisks-action-lookup">libudisks-action-lookup.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>