source: multimedia/libdriv/libogg.xml@ 66adf1ed

<?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 libogg-download-http "https://downloads.xiph.org/releases/ogg/libogg-&libogg-version;.tar.xz">
  <!ENTITY libogg-download-ftp  " ">
  <!ENTITY libogg-md5sum        "3178c98341559657a15b185bf5d700a5">
  <!ENTITY libogg-size          "420 KB">
  <!ENTITY libogg-buildsize     "3.5 MB (with tests)">
  <!ENTITY libogg-time          "less than 0.1 SBU (with tests)">
]>

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


  <title>libogg-&libogg-version;</title>

  <indexterm zone="libogg">
    <primary sortas="a-Libogg">Libogg</primary>
  </indexterm>

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

    <para>
      The <application>libogg</application> package contains the Ogg file
      structure. This is useful for creating (encoding) or playing (decoding) a
      single physical bit stream.
    </para>

    &lfs120_checked;

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr    \
            --disable-static \
            --docdir=/usr/share/doc/libogg-&libogg-version; &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make check</command>.
    </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/static-libraries.xml"/>

  </sect2>

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

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

      <seglistitem>
        <seg>None</seg>
        <seg>libogg.so</seg>
        <seg>/usr/include/ogg and /usr/share/doc/libogg-&libogg-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libogg-lib">
        <term><filename class="libraryfile">libogg.so</filename></term>
        <listitem>
          <para>
            provides the functions required for programs to
            read or write Ogg formatted bit streams
          </para>
          <indexterm zone="libogg libogg-lib">
            <primary sortas="c-libogg">libogg.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>