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 "libogg">
      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="libogg-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 container format library</primary></indexterm>
     23 <refnamediv id="libogg-3-name"><refname>&cmd;</refname>
     24 <refpurpose>Xiph.org container format library</refpurpose></refnamediv>
     25 <refsect1 id="libogg-3-desc"><title>&desc-tt;</title>
     26 <para><literal>&cmd;</literal> is an implementation of the Ogg specification
     27 by the Xiph.org Foundation. <literal>&cmd;</literal> provides an API to work
     28 with the Ogg container format for audio, video, and multimedia.</para>
     29 <para>Ogg project codecs use the Ogg bitstream format to arrange the raw,
     30 compressed bitstream into a more robust, useful form. For example, the Ogg
     31 bitstream makes seeking, time stamping, and error recovery possible, as well
     32 as mixing several separate, concurrent media streams into a single physical
     33 bitstream.</para>
     34 <para>To access the API documentation, you must install the developer version
     35 of the package.</para>
     36 </refsect1>
     37 <refsect1 id="libogg-3-file"><title>&file-tt;</title>
     38 <para>The following files are used by this application:</para>
     39 <variablelist termlength="wholeline">
     40 <varlistentry><term><filename>/usr/lib/&cmd;.so</filename> </term><listitem>
     41 <para>Ogg shared library</para></varlistentry>
     42 <varlistentry><term><filename>/usr/share/gtk-doc/html/libogg-devel</filename> </term><listitem>
     43 <para>Location of developer documentation</para>
     44 </listitem></varlistentry>
     45 </variablelist></refsect1>
     46 <refsect1 id="libogg-3-attr"><title>&attr-tt;</title>
     47 <para>See <olink targetdocent="REFMAN5" localinfo="attributes-3"><citerefentry>
     48 <refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
     49 for descriptions of the following attributes:</para>
     50 <informaltable frame="all">
     51 <tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
     52 <colspec colname="COLSPEC1" colwidth="1*">
     53 <thead>
     54 <row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
     55 valign="middle">ATTRIBUTE VALUE</entry></row>
     56 </thead>
     57 <tbody>
     58 <row><entry><para>Availability</para></entry><entry><para>SUNWogg-vorbis</para></entry>
     59 </row>
     60 <row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
     61 colname="COLSPEC1"><para>Volatile</para></entry></row>
     62 </tbody>
     63 </tgroup>
     64 </informaltable>
     65 </refsect1>
     66 <refsect1 id="libogg-3-also"><title>&also-tt;</title>
     67 <!--Reference to another man page-->
     68 <!--Reference to a Help manual-->
     69 <!--Reference to a book.-->
     70 <para>
     71 <citerefentry><refentrytitle>libvorbis</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
     72 <citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
     73 <citerefentry><refentrytitle>gnome-interfaces</refentrytitle><manvolnum>5</manvolnum></citerefentry>
     74 </para>
     75 </refsect1>
     76 <refsect1 id="libogg-3-note"><title>&note-tt;</title>
     77 <para>Written by Brian Cameron, Sun Microsystems Inc., 2004, 2006.</para>
     78 </refsect1>
     79 </refentry>
     80