source: multimedia/videoutils/xine-ui.xml@ 1de15ced

<?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 xine-ui-download-http
    "&sourceforge-repo;/xine/xine-ui-&xine-ui-version;.tar.xz">
  <!ENTITY xine-ui-download-ftp
    "&gentoo-ftp-repo;/xine-ui-&xine-ui-version;.tar.xz">
  <!ENTITY xine-ui-md5sum        "8dc079baeab56c99e33268a973bc288e">
  <!ENTITY xine-ui-size          "1.7 MB">
  <!ENTITY xine-ui-buildsize     "33 MB">
  <!ENTITY xine-ui-time          "0.3 SBU">
]>

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

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

  <title>xine-ui-&xine-ui-version;</title>

  <indexterm zone="xine-ui">
    <primary sortas="a-Xine-User-Interface">Xine User Interface</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Xine User Interface</title>

    <para>
      The <application>xine User Interface</application> package contains a
      multimedia player. It plays back CDs, DVDs and VCDs. It also decodes
      multimedia files like AVI, MOV, WMV, MPEG and MP3 from local disk drives,
      and displays multimedia streamed over the Internet.
    </para>

    &lfs75_checked;

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

    <bridgehead renderas="sect3">Xine User Interface Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="xine-lib"/> and
      <xref linkend="shared-mime-info"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="curl"/>,
      <xref linkend="aalib"/>,
      <ulink url="http://www.lirc.org">LIRC</ulink>, and
      <ulink url="http://sam.zoy.org/projects/libcaca/">libcaca</ulink>
    </para>

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

  <sect2 role="installation">
    <title>Installation of Xine User Interface</title>

    <para>
      Install <application>xine User Interface</application> by running the
      following commands:
    </para>

<screen><userinput>sed -i 's/(CPPFunction[^)]*)//' src/xitk/network.c &amp;&amp;
./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 docsdir=/usr/share/doc/xine-ui-&xine-ui-version; install</userinput></screen>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/update-icons-and-desktop.xml"/>

  </sect2>

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

    <para>
       <parameter>sed -i 's/(CPPFunction[^)]*)//' src/xitk/network.c</parameter>:
       This command removes an unnecessary reference to deprecated code which fails
       to compile with <application>readline-6.3</application>.
    </para>

    <para>
      <parameter>docsdir=/usr/share/doc/xine-ui-&xine-ui-version;</parameter>:
      This parameter causes the <application>Xine UI</application> documentation
      to be installed in the versioned directory
      <filename class="directory">/usr/share/doc/xine-ui-&xine-ui-version;</filename>,
      rather that the default
      <filename class="directory">/usr/share/doc/xine-ui</filename>.
    </para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring Xine User Interface</title>

    <sect3 id="xine-ui-config">
      <title>Config Files</title>

      <para>
        <filename>~/.xine/config</filename>
      </para>

      <indexterm zone="xine-ui xine-ui-config">
        <primary sortas="e-AA.xine-config">~/.xine/config</primary>
      </indexterm>

    </sect3>

    <sect3>
      <title>Configuration Information</title>

      <para>
        The above file is created and maintainable through the
        <command>xine</command> setup dialog box. The documentation for the
        configuration settings is located at
        <filename>/usr/share/doc/xine-ui-&xine-ui-version;/README.config_en</filename>.
      </para>

      <para>
        If you have a DVB TV card, you can watch TV with the command
        <command>xine dvb://</command> and change channels with the scroll wheel
        on your mouse.
      </para>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>
          aaxine, cacaxine, fbxine, xine,
          xine-bugreport, xine-check, and
          xine-remote
        </seg>
        <seg>
          None
        </seg>
        <seg>
          /usr/share/xine and
          /usr/share/doc/xine-ui-&xine-ui-version;
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="aaxine">
        <term><command>aaxine</command></term>
        <listitem>
          <para>
            is an ASCII art video player which utilizes
            <application>AAlib</application> as the frontend for the
            <application>xine Libraries</application>.
          </para>
          <indexterm zone="xine-ui aaxine">
            <primary sortas="b-aaxine">aaxine</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="cacaxine">
        <term><command>cacaxine</command></term>
        <listitem>
          <para>
            is a color ASCII art video player which utilizes
            <application>CACA</application> as the frontend for the
            <application>xine Libraries</application>.
          </para>
          <indexterm zone="xine-ui cacaxine">
            <primary sortas="b-cacaxine">cacaxine</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="fbxine">
        <term><command>fbxine</command></term>
        <listitem>
          <para>
            is a frame buffer interface to the
            <application>xine Libraries</application>.
          </para>
          <indexterm zone="xine-ui fbxine">
            <primary sortas="b-fbxine">fbxine</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xine">
        <term><command>xine</command></term>
        <listitem>
          <para>
            is a multimedia player designed to play MPEG streams (audio and
            video), MPEG elementary streams (MP3), MPEG transport streams, Ogg
            files, AVI files, ASF files, some Quicktime files, VCDs and DVDs.
          </para>
          <indexterm zone="xine-ui xine">
            <primary sortas="b-xine">xine</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xine-bugreport">
        <term><command>xine-bugreport</command></term>
        <listitem>
          <para>
            produces a terse system description and guides you through the
            process of reporting a bug.
          </para>
          <indexterm zone="xine-ui xine-bugreport">
            <primary sortas="b-xine-bugreport">xine-bugreport</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xine-check">
        <term><command>xine-check</command></term>
        <listitem>
          <para>
            tests the <command>xine</command> video player installation for
            common problems. It tests the operating system settings,
            installation of plugins, CD/DVD drive settings and video support
            parameters.
          </para>
          <indexterm zone="xine-ui xine-check">
            <primary sortas="b-xine-check">xine-check</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xine-remote">
        <term><command>xine-remote</command></term>
        <listitem>
          <para>
            is a tool to connect to a <command>xine</command> remote control
            server.
          </para>
          <indexterm zone="xine-ui xine-remote">
            <primary sortas="b-xine-remote">xine-remote</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>