source: gnome/applications/cheese.xml@ f1a4776e

<?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-41;/cheese-&cheese-version;.tar.xz">
  <!ENTITY cheese-download-ftp  "&gnome-download-ftp;/cheese/&gnome-41;/cheese-&cheese-version;.tar.xz">
  <!ENTITY cheese-md5sum        "f847793aaf08fb349f5d182e76d4c83d">
  <!ENTITY cheese-size          "1.0 MB">
  <!ENTITY cheese-buildsize     "22 MB">
  <!ENTITY cheese-time          "0.2 SBU">
]>

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


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

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

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

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

    &lfs112_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">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required patch:
          <ulink url="&patch-root;/cheese-&cheese-version;-upstream_fixes-1.patch"/>
        </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="gst10-plugins-bad"/>,
      <xref linkend="gst10-plugins-good"/> (built with <xref linkend="v4l-utils"/>),
      <xref linkend="libcanberra"/>, and
      <xref linkend="libgudev"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref role="runtime" linkend="gnome-video-effects"/> (at runtime, for video effects),
      <xref linkend="gobject-introspection"/> and
      <xref linkend="vala"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/>,
      <xref linkend="libxslt"/>,
      <ulink url="&appstream-glib-url;">appstream-glib</ulink>,
      <ulink url="http://ltp.sourceforge.net/coverage/lcov.php"> LCOV </ulink>, and
      <ulink url="&gnome-download-http;/nautilus-sendto/">Nautilus SendTo</ulink>
    </para>

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

  <sect2 role="kernel" id="cheese-kernel">
      <title>Kernel Configuration</title>

    <para>
      Depending on your camera, enable the appropriate options and recompile the
      kernel if necessary:
    </para>

<screen><literal>Device Drivers  ---&gt;
  Multimedia support ---&gt;
    &lt;*&gt; Autoselect ancillary drivers (tuners, sensors, i2c, spi, frontends) [CONFIG_MEDIA_SUBDRV_AUTOSELECT]
    Media device types ---&gt;
      &lt;*&gt; Cameras/video grabbers support  [CONFIG_MEDIA_CAMERA_SUPPORT]
    Media drivers ---&gt;
      &lt;*&gt; Media USB Adapters  ---&gt;         [CONFIG_MEDIA_USB_SUPPORT]
                  Select device(s) as needed</literal></screen>

      <indexterm zone="cheese cheese-kernel">
        <primary sortas="d-cheese">cheese</primary>
      </indexterm>
  </sect2>

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

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

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson --prefix=/usr --buildtype=release -Dgtk_doc=false .. &amp;&amp;
ninja</userinput></screen>

     <para>
      This package does not have a working test suite.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>ninja install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

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

    <para>
      <parameter>-Dgtk_doc=false</parameter>: This switch prevents the build
      system from generating and installing the API documentation. Omit this
      switch if you have <xref linkend="gtk-doc" role="nodep"/> installed
      and wish to generate and install the API documentation. Building the
      documentation is broken due to an incompatibility with gtk-doc.
    </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 and libcheese-gtk.so
        </seg>
        <seg>
          /usr/{include,share/gtk-doc/html,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 a 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>
            <application>GTK+</application> widgets
          </para>
          <indexterm zone="cheese libcheese-gtk">
            <primary sortas="c-libcheese-gtk">libcheese-gtk.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>