source: gnome/add/gnome-disk-utility.xml@ 35fd944b

<?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 gnome-disk-utility-download-http "&gnome-download-http;/gnome-disk-utility/&gnome-old-version;/gnome-disk-utility-&gnome-disk-utility-version;.tar.bz2">
  <!ENTITY gnome-disk-utility-download-ftp  "&gnome-download-ftp;/gnome-disk-utility/&gnome-old-version;/gnome-disk-utility-&gnome-disk-utility-version;.tar.bz2">
  <!ENTITY gnome-disk-utility-md5sum        "d0e6191b7446717d80ccd7b3da611941">
  <!ENTITY gnome-disk-utility-size          "1.5 MB">
  <!ENTITY gnome-disk-utility-buildsize     "39 MB">
  <!ENTITY gnome-disk-utility-time          "0.6 SBU">
]>

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

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

  <title>gnome-disk-utility-&gnome-disk-utility-version;</title>

  <indexterm zone="gnome-disk-utility">
    <primary sortas="a-gnome-disk-utility">gnome-disk-utility</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to gnome-disk-utility</title>

    <para>The <application>gnome-disk-utility</application> package provides
    libraries and applications for dealing with storage devices.</para>

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

    <bridgehead renderas="sect3">gnome-disk-utility Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="DeviceKit-disks"/>,
    <xref linkend="gnome-doc-utils"/>,
    <xref linkend="gnome-keyring"/>,
    <xref linkend="libnotify"/>,
    <xref linkend="libunique"/>,
    <xref linkend="rarian"/>, and
    <xref linkend="which"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="gtk-doc"/> and
    <xref linkend="nautilus"/></para>

    <bridgehead renderas="sect4">Optional (Runtime)</bridgehead>
    <para role="optional"><xref linkend="eject"/></para>

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of gnome-disk-utility</title>

    <para>Install <application>gnome-disk-utility</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=$(pkg-config --variable=prefix ORBit-2.0) \
            --sysconfdir=&gnome-etc-dir; \
            --libexecdir=$(pkg-config \
                --variable=prefix ORBit-2.0)/lib/gnome-disk-utility \
            --disable-gtk-doc &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="commands">
    <title>Command Explanations</title>

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

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

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

    <!-- The disable-scrollkeeper paramter does not work!
    <para><parameter>-disable-scrollkeeper</parameter>: This parameter disables
    updates to the scrollkeeper database. Remove it if you have
    <application>Rarian</application> installed.</para>-->

    <para><parameter>--libexecdir=$(pkg-config --variable=prefix
    ORBit-2.0)/lib/gnome-disk-utility</parameter>: This parameter is used so
    that the <application>gnome-disk-utility</application> internal support
    programs are installed in the preferred location of <filename
    class='directory'>$GNOME_PREFIX/lib/gnome-disk-utility</filename> instead of
    <filename class='directory'>$GNOME_PREFIX/libexec</filename>.</para>

    <para><parameter>--disable-gtk-doc</parameter>: This parameter disables
    <application>gtk-doc</application> building the documentation. Remove it if
    you have <application>gtk-doc</application> installed.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>palimpsest, gdu-format-tool, and gdu-notification-daemon</seg>
        <seg>libgdu.{so,a}, libgdu-gtk.{so,a}, and libnautilus-gdu.{so,a}</seg>
        <seg><envar>$GNOME_PREFIX</envar>/{include/gnome-disk-utility/{gdu,
        gdu-gtk},lib/gnome-disk-utility,share/{gnome/help/palimpsest/*,
        gtk-doc/html/gnome-disk-utility,omf/palimpsest}}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="palimpsest">
        <term><command>palimpsest</command></term>
        <listitem>
          <para>is a tool to manage disk drives and media.</para>
          <indexterm zone="gnome-disk-utility palimpsest">
            <primary sortas="b-palimpsest">palimpsest</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

      <varlistentry id="libgdu-gtk">
        <term><filename class='libraryfile'>libgdu-gtk.{so,a}</filename></term>
        <listitem>
          <para>library provides standard <application>GTK+</application>
          dialogs for handling media operations.</para>
          <indexterm zone="gnome-disk-utility libgdu-gtk">
            <primary sortas="c-libgdu-gtk">libgdu-gtk.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libnautilus-gdu">
        <term><filename class='libraryfile'>libnautilus-gdu.{so,a}</filename></term>
        <listitem>
          <para>is a <application>nautilus</application> extension.</para>
          <indexterm zone="gnome-disk-utility libnautilus-gdu">
            <primary sortas="c-libnautilus-gdu">libnautilus-gdu.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>