source: general/sysutils/udisks2.xml@ 0b64dc8

<?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 udisks2-download-http "https://github.com/storaged-project/udisks/releases/download/udisks-&udisks2-version;/udisks-&udisks2-version;.tar.bz2">
  <!ENTITY udisks2-download-ftp  " ">
  <!ENTITY udisks2-md5sum        "5b5da772a4537951bf487ee11a510ccc">
  <!ENTITY udisks2-size          "1.7 MB">
  <!ENTITY udisks2-buildsize     "41 MB (with tests)">
  <!ENTITY udisks2-time          "0.2 SBU (with tests)">
]>

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


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

  <indexterm zone="udisks2">
    <primary sortas="a-UDisks2">UDisks2</primary>
  </indexterm>

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

    <para>
      The <application>UDisks</application> package provides a daemon,
      tools and libraries to access and manipulate disks and storage
      devices.
    </para>

    &lfs113_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libatasmart"/>,
      <xref linkend="libblockdev"/>,
      <xref linkend="libgudev"/>,
      <xref linkend="libxslt"/>, and
      <xref linkend="polkit"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <phrase revision="systemd"><xref role='runtime' linkend="systemd"/>
      (runtime)</phrase>
      <phrase revision="sysv"><xref linkend="elogind"/></phrase>
    </para>

    <bridgehead renderas="sect4">Optional (Required if building GNOME)</bridgehead>
    <para role="optional">
      <xref linkend="gobject-introspection"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="dbus-python"/> (for the integration tests),
      <xref linkend="gtk-doc"/>,
      <xref linkend="lvm2"/>,
      <!-- <xref linkend="ntfs-3g"/>, -->
      <xref linkend="pygobject3"/> (for the integration tests),
      <ulink url="https://github.com/relan/exfat">exFAT</ulink>, and
      <ulink url="https://github.com/sahlberg/libiscsi">libiscsi</ulink>
    </para>

    <bridgehead renderas="sect4">Optional Runtime Dependencies</bridgehead>
    <para role="runtime">
      <xref linkend="btrfs-progs"/>,
      <phrase revision="sysv"><xref linkend="dbus"/>,</phrase>
      <xref linkend="dosfstools"/>,
      <xref linkend="gptfdisk"/>,
      <xref linkend="mdadm"/>, and
      <xref linkend="xfsprogs"/>
    </para>

  </sect2>

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

<!-- Applied upstream in version 2.9.0.
    <para>
      First, fix a regression caused by glib-2.64:
    </para>

<screen><userinput remap="pre">sed -i '/stdout_channel = g/a g_io_channel_set_encoding (job->child_stdout_channel, NULL, NULL);' src/udisksspawnedjob.c &amp;&amp;
sed -i '/stderr_channel = g/a g_io_channel_set_encoding (job->child_stderr_channel, NULL, NULL);' src/udisksspawnedjob.c</userinput></screen>
-->

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

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

    <para>
      To test the results, issue: <command>make check</command>. A more
      thorough test can be run with <command>make ci</command>. You must first
      create the directories
      <filename class="directory">/var/run/udisks2</filename> and
      <filename class="directory">/var/lib/udisks2</filename>, and the optional
      python modules should be present.
    </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/static-libraries.xml"/>

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

    <para>
      <parameter>--enable-available-modules</parameter>: This switch enables
      additional <application>UDisks2</application> functionalities if
      <xref linkend='libblockdev'/> has been built with optional
      dependencies.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          udisksctl and umount.udisks2
        </seg>
        <seg>
          libudisks2.so
        </seg>
        <seg>
          /etc/udisks2,
          /usr/include/udisks2,
          /usr/libexec/udisks2,
          /usr/share/gtk-doc/html/udisks2, and
          /var/lib/udisks2
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="udisksctl">
        <term><command>udisksctl</command></term>
        <listitem>
          <para>
            is a command-line program used to interact with the
            <command>udisksd</command> daemon
          </para>
          <indexterm zone="udisks2 udisksctl">
            <primary sortas="b-udisksctl">udisksctl</primary>
          </indexterm>
        </listitem>
      </varlistentry>

<!-- Removed since the user shouldn't use this, and it is in /usr/libexec
      <varlistentry id="udisksd">
        <term><command>udisksd</command></term>
        <listitem>
          <para>
            is the <application>UDisks</application> daemon itself.
          </para>
          <indexterm zone="udisks2 udisksd">
            <primary sortas="b-udisksd">udisksd</primary>
          </indexterm>
        </listitem>
      </varlistentry>
-->
      <varlistentry id="umountudisks2">
        <term><command>umount.udisks2</command></term>
        <listitem>
          <para>
            is a command-line program used to unmount file systems
            that have been mounted by the
            <application>UDisks</application> daemon
          </para>
          <indexterm zone="udisks2 umountudisks2">
            <primary sortas="b-umountudisks2">umount.udisks2</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libudisks2">
        <term><filename class="libraryfile">libudisks2.so</filename></term>
        <listitem>
          <para>
            contains the <application>UDisks</application> API functions
          </para>
          <indexterm zone="udisks2 libudisks2">
            <primary sortas="c-libudisks2">libudisks2.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>