Added new xml files for pulse, added rationale.xml

This commit is contained in:
Zeckmathederg 2024-05-13 03:06:32 -06:00
parent 5d9096e5a8
commit 99de2333d7
7 changed files with 1050 additions and 0 deletions

View File

@ -0,0 +1,72 @@
<?xml version="1.0" encoding="UTF-8"?>
<!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;
]>
<sect1 id="rationale" xreflabel="Rationale for Packages">
<?dbhtml filename="rationale.html"?>
<title>Rationale for Packages</title>
<para>
Upon reading through some of the sections in this book, you may notice
that a lot of the packages linked in some of the sections aren't in
this book but rather in BLFS, and that some optional dependencies aren't
even listed. Furthermore, some packages may be outdated. These choices
are very much deliberate.
</para>
<sect2>
<title>Why Are Many Packages Not in the Book?</title>
<para>
Many packages linked on some of the packages' sections aren't in
the book but rather in the BLFS book. There are multiple reasons
for this, but the most notable one is the packages that aren't in
the book aren't important for the main packages in the book, those
being <application>Steam</application> and <application>Wine
</application>. They are still listed anyway if users want more
support out of the specific packages not specific to the main
packages, like media playback for example. Another reason for
packages not being in the book is that the packages take a lot
of work to install and require jumping around. They can also require
a lot of choice or take up space or RAM for no real benefit for a
lot of users when there are more simple solutions, for example: a
logind variant being completely unnecessary as the regular user can
just be added to the <systemitem class='groupname'>audio</systemitem>,
<systemitem class='groupname'>video</systemitem>, and
<systemitem class='groupname'>input</systemitem> groups.
</para>
</sect2>
<sect2>
<title>Why Are Some Optional Dependencies Not Listed?</title>
<para>
There are some optional dependencies that aren't listed, and the
main reason for this is that they just would take up unnecessary
space. If on the offchance you desire even more out of your system,
there are plenty more packages in BLFS and is more geared for
everyone, although this book focuses more on gaming.
</para>
</sect2>
<sect2>
<title>Packages That Are Outdated and Why</title>
<para>
GCC-&gcc-version; vs GCC-14.1.0: GCC-14.1.0 introduces a lot of
bugs, leading to the inability to even compile the newest version
with <application>MinGW-w64</application>. It also leads to
unexpected test failures. Until these bugs are worked out, the
<application>GCC</application> version will be &gcc-version;.
</para>
</sect2>
</sect1>

View File

@ -30,6 +30,7 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="which.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="conventions.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="packages.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="rationale.xml"/>
<!-- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="newsserver.xml"/> -->
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="askhelp.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="credits.xml"/>

214
shareddeps/audio/flac.xml Normal file
View File

@ -0,0 +1,214 @@
<?xml version="1.0" encoding="UTF-8"?>
<!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 flac-download-http "https://downloads.xiph.org/releases/flac/flac-&flac-version;.tar.xz">
<!ENTITY flac-download-ftp " ">
<!ENTITY flac-md5sum "7cab20b46e0bc859234bf5ba7da81625">
<!ENTITY flac-size "1.0 MB">
<!ENTITY flac-buildsize "22 MB (additional 163 MB to run the test suite)">
<!ENTITY flac-time "0.2 SBU (additional 0.6 SBU to run the test suite)">
]>
<sect1 id="flac" xreflabel="FLAC-&flac-version;">
<?dbhtml filename="flac.html"?>
<title>FLAC-&flac-version;</title>
<indexterm zone="flac">
<primary sortas="a-FLAC">FLAC</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to FLAC</title>
<para>
<application>FLAC</application> is an audio CODEC similar to
MP3, but lossless, meaning that audio is compressed without losing any
information.
</para>
&lfs121_checked;
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&flac-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&flac-download-ftp;"/>
</para>
</listitem>
<listitem>
<para>
Download MD5 sum: &flac-md5sum;
</para>
</listitem>
<listitem>
<para>
Download size: &flac-size;
</para>
</listitem>
<listitem>
<para>
Estimated disk space required: &flac-buildsize;
</para>
</listitem>
<listitem>
<para>
Estimated build time: &flac-time;
</para>
</listitem>
</itemizedlist>
<!--
<bridgehead renderas="sect3">Additional Downloads</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Required patch:
<ulink url="&patch-root;/flac-&flac-version;-security_fixes-1.patch"/>
</para>
</listitem>
</itemizedlist>
-->
<bridgehead renderas="sect3">FLAC Dependencies</bridgehead>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="libogg"/>,
<xref linkend="docbook-utils"/>,
<xref linkend="doxygen"/>, and
<xref linkend="valgrind"/>
</para>
</sect2>
<sect2 role="installation">
<title>Installation of FLAC</title>
<para>
Install <application>FLAC</application> by running the
following commands:
</para>
<screen><userinput>./configure --prefix=/usr \
--disable-thorough-tests \
--docdir=/usr/share/doc/flac-&flac-version; &amp;&amp;
make</userinput></screen>
<para>
To test the results, issue: <command>make check</command>. Note that
if you passed the <option>--enable-exhaustive-tests</option> and
<option>--enable-valgrind-testing</option> parameters to
<command>configure</command> and then run the test suite, it will take a
<emphasis>very</emphasis> long time (up to 300 SBUs) and use about 375 MB
of disk space.
</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>
<para>
<parameter>--disable-thorough-tests</parameter>: This parameter is
used so that the test suite will complete in a reasonable amount of time.
Remove it if you desire more extensive tests.
</para>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>flac and metaflac</seg>
<seg>libFLAC.so and libFLAC++.so</seg>
<seg>/usr/include/FLAC, /usr/include/FLAC++ and
/usr/share/doc/flac-&flac-version;</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="flac-prog">
<term><command>flac</command></term>
<listitem>
<para>
is a command-line utility for encoding, decoding and
converting FLAC files
</para>
<indexterm zone="flac flac-prog">
<primary sortas="b-flac">flac</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="metaflac">
<term><command>metaflac</command></term>
<listitem>
<para>
is a program for listing, adding, removing, or editing
metadata in one or more FLAC files
</para>
<indexterm zone="flac metaflac">
<primary sortas="b-metaflac">metaflac</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libflac">
<term><filename class="libraryfile">libFLAC{,++}.so</filename></term>
<listitem>
<para>
these libraries provide native FLAC and Ogg FLAC C/C++ APIs
for programs utilizing FLAC
</para>
<indexterm zone="flac libflac">
<primary sortas="c-libFLAC">libFLAC{,++}.so</primary>
</indexterm>
</listitem>
</varlistentry>
<!--
<varlistentry id="libxmms-flac">
<term><filename class="libraryfile">libxmms-flac.{so,a}</filename></term>
<listitem>
<para>
is a plugin for <application>XMMS</application>.
</para>
<indexterm zone="flac libxmms-flac">
<primary sortas="c-libxmms-flac">libxmms-flac.{so,a}</primary>
</indexterm>
</listitem>
</varlistentry>
-->
</variablelist>
</sect2>
</sect1>

142
shareddeps/audio/libogg.xml Normal file
View File

@ -0,0 +1,142 @@
<?xml version="1.0" encoding="UTF-8"?>
<!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>
&lfs121_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>

View File

@ -0,0 +1,289 @@
<?xml version="1.0" encoding="UTF-8"?>
<!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 libsndfile-download-http
"https://github.com/libsndfile/libsndfile/releases/download/&libsndfile-version;/libsndfile-&libsndfile-version;.tar.xz">
<!ENTITY libsndfile-download-ftp " ">
<!ENTITY libsndfile-md5sum "04e2e6f726da7c5dc87f8cf72f250d04">
<!ENTITY libsndfile-size "716 KB">
<!ENTITY libsndfile-buildsize "12 MB (add 10 MB for tests)">
<!ENTITY libsndfile-time "0.3 SBU (add 0.3 SBU for tests)">
]>
<sect1 id="libsndfile" xreflabel="libsndfile-&libsndfile-version;">
<?dbhtml filename="libsndfile.html"?>
<title>libsndfile-&libsndfile-version;</title>
<indexterm zone="libsndfile">
<primary sortas="a-libsndfile">libsndfile</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to libsndfile</title>
<para>
<application>Libsndfile</application> is a library of C routines for
reading and writing files containing sampled audio data.
</para>
&lfs121_checked;
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&libsndfile-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&libsndfile-download-ftp;"/>
</para>
</listitem>
<listitem>
<para>
Download MD5 sum: &libsndfile-md5sum;
</para>
</listitem>
<listitem>
<para>
Download size: &libsndfile-size;
</para>
</listitem>
<listitem>
<para>
Estimated disk space required: &libsndfile-buildsize;
</para>
</listitem>
<listitem>
<para>
Estimated build time: &libsndfile-time;
</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">libsndfile Dependencies</bridgehead>
<bridgehead renderas="sect4">Recommended</bridgehead>
<para role="recommended">
<xref linkend="flac"/>,
<xref linkend="opus"/>, and
<xref linkend="libvorbis"/><!-- brings in libogg -->
</para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="alsa-lib"/>,
<xref linkend="lame"/>,
<xref linkend="mpg123"/>,
<xref linkend="speex"/>, and
<xref linkend="sqlite"/>
</para>
</sect2>
<sect2 role="installation">
<title>Installation of libsndfile</title>
<para>
Install <application>libsndfile</application> by running the following
commands:
</para>
<screen><userinput>./configure --prefix=/usr \
--docdir=/usr/share/doc/libsndfile-&libsndfile-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>
sndfile-cmp,
sndfile-concat,
sndfile-convert,
sndfile-deinterleave,
sndfile-info,
sndfile-interleave,
sndfile-metadata-get,
sndfile-metadata-set,
sndfile-play, and
sndfile-salvage
</seg>
<seg>libsndfile.so</seg>
<seg>/usr/share/doc/libsndfile-&libsndfile-version;</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="sndfile-cmp">
<term><command>sndfile-cmp</command></term>
<listitem>
<para>
compares two audio files
</para>
<indexterm zone="libsndfile sndfile-cmp">
<primary sortas="b-sndfile-cmp">sndfile-cmp</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sndfile-concat">
<term><command>sndfile-concat</command></term>
<listitem>
<para>
concatenates two or more audio files
</para>
<indexterm zone="libsndfile sndfile-concat">
<primary sortas="b-sndfile-concat">sndfile-concat</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sndfile-convert">
<term><command>sndfile-convert</command></term>
<listitem>
<para>
converts a sound file from one format to another
</para>
<indexterm zone="libsndfile sndfile-convert">
<primary sortas="b-sndfile-convert">sndfile-convert</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sndfile-deinterleave">
<term><command>sndfile-deinterleave</command></term>
<listitem>
<para>
splits a multi-channel into multiple single channel files
</para>
<indexterm zone="libsndfile sndfile-deinterleave">
<primary sortas="b-sndfile-deinterleave">sndfile-deinterleave</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sndfile-info">
<term><command>sndfile-info</command></term>
<listitem>
<para>
displays information about a sound file
</para>
<indexterm zone="libsndfile sndfile-info">
<primary sortas="b-sndfile-info">sndfile-info</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sndfile-interleave">
<term><command>sndfile-interleave</command></term>
<listitem>
<para>
converts multiple single channel files into a multi-channel file
</para>
<indexterm zone="libsndfile sndfile-interleave">
<primary sortas="b-sndfile-interleave">sndfile-interleave</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sndfile-metadata-get">
<term><command>sndfile-metadata-get</command></term>
<listitem>
<para>
retrieves metadata from a sound file
</para>
<indexterm zone="libsndfile sndfile-metadata-get">
<primary sortas="b-sndfile-metadata-get">sndfile-metadata-get</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sndfile-metadata-set">
<term><command>sndfile-metadata-set</command></term>
<listitem>
<para>
sets metadata in a sound file
</para>
<indexterm zone="libsndfile sndfile-metadata-set">
<primary sortas="b-sndfile-metadata-set">sndfile-metadata-set</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sndfile-play">
<term><command>sndfile-play</command></term>
<listitem>
<para>
plays a sound file
</para>
<indexterm zone="libsndfile sndfile-play">
<primary sortas="b-sndfile-play">sndfile-play</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sndfile-salvage">
<term><command>sndfile-salvage</command></term>
<listitem>
<para>
salvages the audio data from WAV files which are more than
4GB in size
</para>
<indexterm zone="libsndfile sndfile-salvage">
<primary sortas="b-sndfile-salvage">sndfile-salvage</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libsndfile-lib">
<term><filename class="libraryfile">libsndfile.so</filename></term>
<listitem>
<para>
contains the <application>libsndfile</application> API functions
</para>
<indexterm zone="libsndfile libsndfile-lib">
<primary sortas="c-libsndfile">libsndfile.so</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>

View File

@ -0,0 +1,173 @@
<?xml version="1.0" encoding="UTF-8"?>
<!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 "50902641d358135f06a8392e61c9ac77">
<!ENTITY libvorbis-size "1.1 MB">
<!ENTITY libvorbis-buildsize "15 MB">
<!ENTITY libvorbis-time "0.1 SBU">
]>
<sect1 id="libvorbis" xreflabel="libvorbis-&libvorbis-version;">
<?dbhtml filename="libvorbis.html"?>
<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>
&lfs121_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>
</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 -j1 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>

159
shareddeps/audio/opus.xml Normal file
View File

@ -0,0 +1,159 @@
<?xml version="1.0" encoding="UTF-8"?>
<!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 "https://downloads.xiph.org/releases/opus/opus-&opus-version;.tar.gz">
<!ENTITY opus-download-ftp " ">
<!ENTITY opus-md5sum "c40b3a1fbdbb9a7aa178600b88200c76">
<!ENTITY opus-size "7.4 MB">
<!ENTITY opus-buildsize "33 MB (with tests)">
<!ENTITY opus-time "0.5 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>
&lfs121_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>mkdir build &amp;&amp;
cd build &amp;&amp;
meson setup --prefix=/usr \
--buildtype=release \
-Ddocdir=/usr/share/doc/opus-&opus-version; &amp;&amp;
ninja</userinput></screen>
<para>
To test the results, issue: <command>ninja test</command>.
</para>
<para>
Now, as the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>ninja install</userinput></screen>
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="../../xincludes/meson-buildtype-release.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>