Home | History | Annotate | Download | only in man3
      1 <!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
      2 <!--ArborText, Inc., 1988-1999, v.4002-->
      3 <!ENTITY cmd "libvorbis">
      4 <!ENTITY % commonents SYSTEM "smancommon.ent">
      5 %commonents;
      6 <!ENTITY % booktitles SYSTEM "booktitles.ent">
      7 %booktitles;
      8 <!ENTITY suncopy "Copyright (c) 2004, 2006, Sun Microsystems, Inc. All Rights Reserved.">
      9 ]>
     10 <?Pub UDT _bookmark _target>
     11 <?Pub Inc>
     12 <refentry id="libvorbis-3">
     13 <!-- %Z%%M% %I% %E% SMI; -->
     14 <refmeta><refentrytitle>&cmd;</refentrytitle><manvolnum>3</manvolnum>
     15 <refmiscinfo class="date">7 Sep 2004</refmiscinfo>
     16 <refmiscinfo class="sectdesc">&man1;</refmiscinfo>
     17 <refmiscinfo class="software">&release;</refmiscinfo>
     18 <refmiscinfo class="arch">generic</refmiscinfo>
     19 <refmiscinfo class="copyright">&suncopy;</refmiscinfo>
     20 </refmeta>
     21 <indexterm><primary>&cmd;</primary></indexterm><indexterm><primary>Xiph.org
     22 compression format library</primary></indexterm>
     23 <refnamediv id="libvorbis-3-name"><refname>&cmd;</refname><refpurpose>
     24 Xiph.org compression format library</refpurpose></refnamediv>
     25 <refsect1 id="libvorbis-3-desc"><title>&desc-tt;</title>
     26 <para><literal>&cmd;</literal> is an implementation of the Vorbis specification
     27 by the Xiph.org foundation. <literal>&cmd;</literal> provides an API to work
     28 with the Vorbis multimedia compression format.</para>
     29 <para>Vorbis is an audio compression scheme that is designed to be contained
     30 in the Ogg container. Note that other formats are capable of being embedded
     31 in an Ogg container, such as FLAC and Speex.</para>
     32 <para>To access the API documentation, you must install the developer version
     33 of the package.</para>
     34 </refsect1>
     35 <refsect1 id="libvorbis-3-file"><title>&file-tt;</title>
     36 <para>The following files are used by this application:</para>
     37 <variablelist termlength="wholeline">
     38 <varlistentry><term><filename>/usr/lib/&cmd;.so</filename> </term><listitem>
     39 <para>Vorbis shared library</para></varlistentry>
     40 <varlistentry><term><filename>/usr/share/gtk-doc/html/libvorbis-devel</filename> </term><listitem>
     41 <para>Location of developer documentation</para>
     42 </listitem></varlistentry>
     43 </variablelist></refsect1>
     44 <refsect1 id="libvorbis-3-attr"><title>&attr-tt;</title>
     45 <para>See <olink targetdocent="REFMAN5" localinfo="attributes-3"><citerefentry>
     46 <refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
     47 for descriptions of the following attributes:</para>
     48 <informaltable frame="all">
     49 <tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
     50 <colspec colname="COLSPEC1" colwidth="1*">
     51 <thead>
     52 <row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
     53 valign="middle">ATTRIBUTE VALUE</entry></row>
     54 </thead>
     55 <tbody>
     56 <row><entry><para>Availability</para></entry><entry><para>SUNWogg-vorbis</para></entry>
     57 </row>
     58 <row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
     59 colname="COLSPEC1"><para>Volatile</para></entry></row>
     60 </tbody>
     61 </tgroup>
     62 </informaltable>
     63 </refsect1>
     64 <refsect1 id="libvorbis-3-also"><title>&also-tt;</title>
     65 <!--Reference to another man page-->
     66 <!--Reference to a Help manual-->
     67 <!--Reference to a book.-->
     68 <para>
     69 <citerefentry><refentrytitle>libogg</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
     70 <citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
     71 <citerefentry><refentrytitle>gnome-interfaces</refentrytitle><manvolnum>5</manvolnum></citerefentry>
     72 </para></refsect1>
     73 <refsect1 id="libvorbis-3-note"><title>&note-tt;</title>
     74 <para>Written by Brian Cameron, Sun Microsystems Inc., 2004, 2006.</para>
     75 </refsect1>
     76 </refentry>
     77