source: gnome/add/gnome-utils.xml@ 8cf3617

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY gnome-utils-download-http "&gnome-download-http;/gnome-utils/&gnome-version;/gnome-utils-&gnome-utils-version;.tar.bz2">
  <!ENTITY gnome-utils-download-ftp  "&gnome-download-ftp;/gnome-utils/&gnome-version;/gnome-utils-&gnome-utils-version;.tar.bz2">
  <!ENTITY gnome-utils-md5sum        "71d615932e4ddf7182abeb734b8e370c">
  <!ENTITY gnome-utils-size          "1.7 MB">
  <!ENTITY gnome-utils-buildsize     "30.7 MB">
  <!ENTITY gnome-utils-time          "0.3 SBU">
]>

<sect1 id="gnome-utils" xreflabel="GNOME Utilities-&gnome-utils-version;">
  <?dbhtml filename="gnome-utils.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">gnome-utils-&gnome-utils-version;.tar</keyword>
      <keyword role="ftpdir">gnome-utils</keyword>
    </keywordset>
  </sect1info>

  <title>GNOME Utilities-&gnome-utils-version;</title>

  <indexterm zone="gnome-utils">
    <primary sortas="a-GNOME Utilities">GNOME Utilities</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to GNOME Utilities</title>

    <para>The <application>GNOME Utilities</application> package contains a
    collection of small applications designed to make your life a little
    easier.</para>

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

    <bridgehead renderas="sect3">GNOME Utilities Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="gnome-panel"/> and
    <xref linkend="libgnomeprintui"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="linux-pam"/> (only if consolehelper
    is also installed) and <xref linkend="hal"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of GNOME Utilities</title>

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

<screen><userinput>./configure --prefix=`pkg-config --variable=prefix ORBit-2.0` \
            --libexecdir=`pkg-config \
            --variable=prefix ORBit-2.0`/lib/gnome-utils \
            --localstatedir=/var/lib \
            --sysconfdir=&gnome-etc-dir; &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>

    <para><parameter>--libexecdir=`pkg-config
    --variable=prefix ORBit-2.0`/lib/gnome-utils</parameter>: This switch puts
    libexec files in
    <filename class="directory">$GNOME_PREFIX/lib/gnome-utils</filename>
    instead of
     <filename class="directory">$GNOME_PREFIX/libexec</filename>.</para>

    <para><parameter>--localstatedir=/var/lib</parameter>: This switch
    puts <application>ScrollKeeper</application> files in
    <filename class="directory">/var/lib/scrollkeeper</filename> instead of
    <filename class="directory">$GNOME_PREFIX/var/scrollkeeper</filename>.</para>

    <para><parameter>--sysconfdir=&gnome-etc-dir;</parameter>: This switch puts
    configuration files in <filename class="directory">&gnome-etc-dir;</filename>
    instead of <filename class="directory">$GNOME_PREFIX/etc</filename>.</para>

    <para><option>--with-pam-prefix=/etc/pam.d</option>: This switch
    puts <application>PAM</application> files in
    <filename class="directory">/etc/pam.d</filename> instead of
    <filename class="directory">&gnome-etc-dir;</filename>.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>gfloppy, gnome-dictionary, gnome-panel-screenshot,
        gnome-screenshot, gnome-search-tool, and gnome-system-log</seg>
        <seg>None</seg>
        <seg>&gnome-etc-dir;/gconf/gconf.xml.defaults/[,schemas/]apps/[gfloppy,
        gnome-[dictionary, screenshot, search-tool, system-log]] and
        the following subdirectories of $GNOME_PREFIX/:
        lib/gnome-utils,
        share/[gnome-[screenshot, system-log, utils],
        gnome/help/[gfloppy, gnome-dictionary, gnome-search-tool, gnome-system-log]
        omf/gnome-utils,
        pixmaps/gsearchtool]</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gfloppy">
        <term><command>gfloppy</command></term>
        <listitem>
          <para>formats floppy disks under Linux.</para>
          <indexterm zone="gnome-utils gfloppy">
            <primary sortas="b-gfloppy">gfloppy</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gnome-dictionary">
        <term><command>gnome-dictionary</command></term>
        <listitem>
          <para>allows you to look up definitions and spelling of words.</para>
          <indexterm zone="gnome-utils gnome-dictionary">
            <primary sortas="b-gnome-dictionary">gnome-dictionary</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gnome-screenshot">
        <term><command>gnome-screenshot</command></term>
        <listitem>
          <para>is used to capture the contents of the current desktop as
          a graphics formatted file.</para>
          <indexterm zone="gnome-utils gnome-screenshot">
            <primary sortas="b-gnome-screenshot">gnome-screenshot</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gnome-search-tool">
        <term><command>gnome-search-tool</command></term>
        <listitem>
          <para>allows you to search for files on your system using simple
          and advanced search options.</para>
          <indexterm zone="gnome-utils gnome-search-tool">
            <primary sortas="b-gnome-search-tool">gnome-search-tool</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gnome-system-log">
        <term><command>gnome-system-log</command></term>
        <listitem>
          <para>allows you to monitor and view system log files.</para>
          <indexterm zone="gnome-utils gnome-system-log">
            <primary sortas="b-gnome-system-log">gnome-system-log</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>