source: gnome/add/cheese.xml@ 9db3353e

<?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 cheese-download-http "&gnome-download-http;/cheese/3.4/cheese-&cheese-version;.tar.xz">
  <!ENTITY cheese-download-ftp  "&gnome-download-ftp;/cheese/3.4/cheese-&cheese-version;.tar.xz">
  <!ENTITY cheese-md5sum        "350afb16522ed26b1fe4192e12991d0f">
  <!ENTITY cheese-size          "3.6 MB">
  <!ENTITY cheese-buildsize     "28 MB">
  <!ENTITY cheese-time          "0.8 SBU">
]>

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

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

  <title>Cheese-&cheese-version;</title>

  <indexterm zone="cheese">
    <primary sortas="a-cheese">cheese</primary>
  </indexterm>

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

    <para>
      The <application>Cheese</application> package is used to 
      take photos and videos with fun graphical effects.
    </para>

    &lfs70_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="clutter-gst"/>,
      <xref linkend="clutter-gtk"/>,
      <xref linkend="gnome-desktop"/>,
      <xref linkend="gnome-video-effects"/>,
      <xref linkend="libgee"/>,
      <xref linkend="libcanberra"/>,
      <xref linkend="librsvg"/>,
      <xref linkend="mx"/>,
      <xref linkend="nautilus-sendto"/>,
      <xref linkend="udev"/>,
      <xref linkend="vala"/> and
      <xref linkend="yelp-xsl"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/>
    </para>

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

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr &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/gtk-doc-rebuild.xml"/>

  </sect2>

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

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

      <seglistitem>
        <seg>
          cheese
        </seg>
        <seg>
          libcheese.so and libcheese-gtk.so
        </seg>
        <seg>
          /usr/include/cheese, /usr/share/cheese,
          /usr/share/gtk-doc/html/cheese and 
          /usr/share/help/*/cheese
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="cheese-prog">
        <term><command>cheese</command></term>
        <listitem>
          <para>
            is the webcam tool with graphical effects.
          </para>
          <indexterm zone="cheese cheese-prog">
            <primary sortas="b-cheese">cheese</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

      <varlistentry id="libcheese-gtk">
        <term><filename class='libraryfile'>libcheese-gtk.so</filename></term>
        <listitem>
          <para>
            contains the <application>cheese</application> GTK+ Widgets.
          </para>
          <indexterm zone="cheese libcheese-gtk">
            <primary sortas="c-libcheese-gtk">libcheese-gtk.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>