source: gnome/add/cheese.xml@ ee8252a6

<?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/&gnome-version;/cheese-&cheese-version;.tar.xz">
  <!ENTITY cheese-download-ftp  "&gnome-download-ftp;/cheese/&gnome-version;/cheese-&cheese-version;.tar.xz">
  <!ENTITY cheese-md5sum        "a674bbe235cc960e578bb71b6aa55783">
  <!ENTITY cheese-size          "3.4 MB">
  <!ENTITY cheese-buildsize     "27 MB">
  <!ENTITY cheese-time          "0.9 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 takes photos and videos
    with your webcam, with fun graphical effects.</para>

    &lfs70_built;

    <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"/> ( with
    <xref linkend="gst-plugins-base"/> using <xref linkend="libtheora"/>),
    <xref linkend="clutter-gtk"/>,
    <xref linkend="gnome-desktop"/>,
    <xref linkend="gnome-video-effects"/>,
    <xref linkend="libcanberra"/>,
    <xref linkend="librsvg"/>,
    <xref linkend="mx"/>, and
    <xref linkend="udev"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="rarian"/></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=$GNOME_PREFIX &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"/>

    <!-- a nice description, but no libexec is created
    <para><parameter>\-\-libexecdir=$GNOME_PREFIX/lib/cheese</parameter>: This
    parameter is used so that the <application>cheese</application> internal
    support programs are installed in the preferred location of <filename
    class='directory'>$GNOME_PREFIX/lib/cheese</filename> instead of <filename
    class='directory'>$GNOME_PREFIX/libexec/cheese</filename>.</para>-->

    <!-- despite suggestionsi otherwise, this is still offered by configure and
    rarian, whick provides the scrollkeeper commands, is only used if present -->
    <para><option>--disable-scrollkeeper</option>: Use this parameter if you
    have installed <application>rarian</application> but wish to disable the
    updates to the scrollkeeper database.</para>

    <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 Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>cheese</seg>
        <seg>libcheese.{so,a}, libcheese-gtk.{so,a}</seg>
        <seg><envar>$GNOME_PREFIX</envar>/{include/cheese,lib/cheese,
        share/{cheese/{effects,icons/hicolor/*,pixmaps},gnome/help/cheese/*,
        gtk-doc/html/cheese,omf/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 with graphical effects tool.</para>
          <indexterm zone="cheese cheese-prog">
            <primary sortas="b-cheese">cheese</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

      <varlistentry id="libcheese-gtk">
        <term><filename class='libraryfile'>libcheese-gtk.{so,a}</filename></term>
        <listitem>
          <para>contains the <application>cheese</application> API
          functions for Gtk+-2.</para>
          <indexterm zone="cheese libcheese-gtk">
            <primary sortas="c-libcheese-gtk">libcheese-gtk.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>