source: multimedia/libdriv/opus.xml@ d8e1be0

<?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 opus-download-http
           "&mozilla-http;/opus/opus-&opus-version;.tar.gz">
  <!ENTITY opus-download-ftp  " ">
  <!ENTITY opus-md5sum        "d7c07db796d21c9cf1861e0c2b0c0617">
  <!ENTITY opus-size          "1.0 MB">
  <!ENTITY opus-buildsize     "26 MB (with tests)">
  <!ENTITY opus-time          "0.8 SBU  (with tests)">
]>

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


  <title>Opus-&opus-version;</title>

  <indexterm zone="opus">
    <primary sortas="a-Opus">Opus</primary>
  </indexterm>

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

    <para>
      <application>Opus</application> is a lossy audio compression format
      developed by the Internet Engineering Task Force (IETF) that is
      particularly suitable for interactive speech and audio transmission over
      the Internet. This package provides the Opus development library and
      headers.
    </para>

    &lfs113_checked;

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/> and
      <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>)
    </para>


  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr    \
            --disable-static \
            --docdir=/usr/share/doc/opus-&opus-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 Directory</segtitle>

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

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

      <varlistentry id="libopus">
        <term><filename class="libraryfile">libopus.so</filename></term>
        <listitem>
          <para>
            provides the functions used to read and write Opus format
          </para>
          <indexterm zone="opus libopus">
            <primary sortas="c-libopus">libopus.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>