source: multimedia/libdriv/libvorbis.xml@ 8186151

<?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 libvorbis-download-http "https://downloads.xiph.org/releases/vorbis/libvorbis-&libvorbis-version;.tar.xz">
  <!ENTITY libvorbis-download-ftp  " ">
  <!ENTITY libvorbis-md5sum        "b7d1692f275c73e7833ed1cc2697cd65">
  <!ENTITY libvorbis-size          "1.1 MB">
  <!ENTITY libvorbis-buildsize     "12 MB">
  <!ENTITY libvorbis-time          "0.1 SBU">
]>

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

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

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

  <indexterm zone="libvorbis">
    <primary sortas="a-Libvorbis">Libvorbis</primary>
  </indexterm>

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

    <para>
      The <application>libvorbis</application> package contains a general
      purpose audio and music encoding format. This is useful for creating
      (encoding) and playing (decoding) sound in an open (patent free)
      format.
    </para>

    &lfs90_checked;

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

    <bridgehead renderas="sect3">libvorbis Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libogg"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/> and
      <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>)
      (specifically, pdflatex and htlatex) to build the PDF documentation
    </para>

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

  <sect2 role="installation">
    <title>Installation of libvorbis</title>
<!--
    <para>
      Optionally fix installation of the package when
      <command>- -enable-docs</command> is added to the configure switches:
    </para>

<screen><userinput>sed -i '/components.png \\/{n;d}' doc/Makefile.in</userinput></screen>
-->
    <para>
      Install <application>libvorbis</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr --disable-static &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 &amp;&amp;
install -v -m644 doc/Vorbis* /usr/share/doc/libvorbis-&libvorbis-version;</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"/>

    <para>
      <option>--enable-docs</option>: This switch enables building the
      documentation in formats other than the supplied html.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libvorbis.so, libvorbisenc.so and libvorbisfile.so
        </seg>
        <seg>
          /usr/include/vorbis and /usr/share/doc/libvorbis-&libvorbis-version;
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libvorbis-lib">
        <term><filename class="libraryfile">libvorbis.so</filename></term>
        <listitem>
          <para>
            provides the functions used to read and write sound files.
          </para>
          <indexterm zone="libvorbis libvorbis-lib">
            <primary sortas="c-libvorbis">libvorbis.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>