r3308 - in trunk/BOOK: introduction/welcome multimedia/libdriv multimedia/videoutils

randy at linuxfromscratch.org randy at linuxfromscratch.org
Wed Jan 19 08:12:47 PST 2005


Author: randy
Date: 2005-01-19 09:12:46 -0700 (Wed, 19 Jan 2005)
New Revision: 3308

Modified:
   trunk/BOOK/introduction/welcome/changelog.xml
   trunk/BOOK/multimedia/libdriv/xine-lib.xml
   trunk/BOOK/multimedia/videoutils/ffmpeg.xml
   trunk/BOOK/multimedia/videoutils/transcode.xml
Log:
Added indexing tags and instructions to install HTML documentation to FFmpeg

Modified: trunk/BOOK/introduction/welcome/changelog.xml
===================================================================
--- trunk/BOOK/introduction/welcome/changelog.xml	2005-01-19 15:08:28 UTC (rev 3307)
+++ trunk/BOOK/introduction/welcome/changelog.xml	2005-01-19 16:12:46 UTC (rev 3308)
@@ -22,6 +22,9 @@
 
 <itemizedlist>
 
+<listitem><para>January 19th, 2005 [randy]: Added installation of 
+HTML documentation to the FFmpeg instructions.</para></listitem>
+
 <listitem><para>January 17th, 2005 [randy]: Updated to
 AbiWord-2.2.3.</para></listitem>
 

Modified: trunk/BOOK/multimedia/libdriv/xine-lib.xml
===================================================================
--- trunk/BOOK/multimedia/libdriv/xine-lib.xml	2005-01-19 15:08:28 UTC (rev 3307)
+++ trunk/BOOK/multimedia/libdriv/xine-lib.xml	2005-01-19 16:12:46 UTC (rev 3308)
@@ -27,11 +27,15 @@
 
 <sect3><title>Package information</title>
 <itemizedlist spacing='compact'>
-<listitem><para>Download (HTTP): <ulink url="&xine-lib-download-http;"/></para></listitem>
-<listitem><para>Download (FTP): <ulink url="&xine-lib-download-ftp;"/></para></listitem>
+<listitem><para>Download (HTTP): 
+<ulink url="&xine-lib-download-http;"/></para></listitem>
+<listitem><para>Download (FTP): 
+<ulink url="&xine-lib-download-ftp;"/></para></listitem>
 <listitem><para>Download size: &xine-lib-size;</para></listitem>
-<listitem><para>Estimated disk space required: &xine-lib-buildsize;</para></listitem>
-<listitem><para>Estimated build time: &xine-lib-time;</para></listitem></itemizedlist>
+<listitem><para>Estimated disk space required: 
+&xine-lib-buildsize;</para></listitem>
+<listitem><para>Estimated build time: 
+&xine-lib-time;</para></listitem></itemizedlist>
 </sect3>
 
 <sect3><title>Additional downloads</title>
@@ -50,7 +54,7 @@
 
 <sect4><title>Optional</title>
 <para><xref linkend="pkgconfig"/>, 
-<xref linkend="ffmpeg"/>, 
+<xref linkend="ffmpeg-package"/>, 
 <xref linkend="aalib"/>, 
 <xref linkend="libmng"/>, 
 <xref linkend="sdl"/>, 

Modified: trunk/BOOK/multimedia/videoutils/ffmpeg.xml
===================================================================
--- trunk/BOOK/multimedia/videoutils/ffmpeg.xml	2005-01-19 15:08:28 UTC (rev 3307)
+++ trunk/BOOK/multimedia/videoutils/ffmpeg.xml	2005-01-19 16:12:46 UTC (rev 3308)
@@ -10,13 +10,15 @@
   <!ENTITY ffmpeg-time          "0.87 SBU">
 ]>
 
-<sect1 id="ffmpeg" xreflabel="FFmpeg-&ffmpeg-version;">
+<sect1 id="ffmpeg-package" xreflabel="FFmpeg-&ffmpeg-version;">
 <sect1info>
 <othername>$LastChangedBy$</othername>
 <date>$Date$</date>
 </sect1info>
 <?dbhtml filename="ffmpeg.html"?>
 <title>FFmpeg-&ffmpeg-version;</title>
+<indexterm zone="ffmpeg-package">
+<primary sortas="a-FFmpeg">FFmpeg</primary></indexterm>
 
 <sect2>
 <title>Introduction to <application>FFmpeg</application></title>
@@ -70,12 +72,17 @@
 source tree for information about optimizing the build.</para></note>
 
 <!-- <screen><userinput><command>patch -Np1 -i ../ffmpeg-&ffmpeg-version;-gcc34-1.patch && -->
-<screen><userinput><command>./configure --prefix=/usr \
-    --enable-shared --enable-pthreads &&
+<screen><userinput><command>./configure --prefix=/usr --enable-shared \
+    --enable-pthreads --disable-ffplay &&
 make &&
-make -C doc {ffmpeg,ffserver,ffplay}.1 &&
-make install</command></userinput></screen>
+make -C doc {ffmpeg,ffserver,ffplay}.1</command></userinput></screen>
 
+<para>Now, as the root user:</para>
+
+<screen><userinput role='root'><command>make install &&
+install -v -d -m755 /usr/share/doc/ffmpeg-&ffmpeg-version; &&
+install -v -m644 doc/*.html /usr/share/doc/ffmpeg-&ffmpeg-version;</command></userinput></screen>
+
 </sect2>
 
 <sect2>
@@ -89,14 +96,15 @@
 <para><parameter>--enable-pthreads</parameter>: This switch enables the 
 build to link against the Posix threads library.</para>
 
+<para><option>--disable-ffplay</option>: Only installs the server part.
+<command>ffplay</command> requires <application>X</application> for 
+building. Remove this option if <application>X</application> is 
+installed.</para>
+
 <para><option>--enable-<replaceable>[codec]</replaceable></option>: Review
 the available options and codecs using the 
 <command>./configure --help</command> command.</para>
 
-<para><option>--disable-ffplay</option>: Only installs the server part.
-<command>ffplay</command> requires <application>X</application> for 
-building.</para>
-
 <para><command>make -C doc {ffmpeg,ffserver,ffplay}.1</command>: This builds 
 the man pages which are installed by <command>make install</command>.</para>
 
@@ -109,15 +117,22 @@
 <sect2>
 <title>Configuring <application>FFmpeg</application></title>
 
-<sect3><title>Config files</title>
+<sect3 id="ffmpeg-config"><title>Config files</title>
 
 <para><filename>/etc/ffserver.conf</filename> and 
 <filename>~/.ffmpeg/ffserver-config</filename></para>
 
+<indexterm zone="ffmpeg-package ffmpeg-config">
+<primary 
+sortas="e-AA.ffmpeg-ffserver-config">~/.ffmpeg/ffserver-config</primary>
+</indexterm>
+<indexterm zone="ffmpeg-package ffmpeg-config">
+<primary sortas="e-etc-ffserver.conf">/etc/ffserver.conf</primary>
+</indexterm>
+
 <para>You'll find a sample ffserver configuration file at
 <ulink url="http://ffmpeg.sourceforge.net/sample.html"/> (also 
 <filename>doc/ffserver.conf</filename> in the source tree).</para>
-
 </sect3>
 
 </sect2>
@@ -125,38 +140,70 @@
 <sect2>
 <title>Contents</title>
 
-<para>The <application>FFmpeg</application> package contains 
-<command>ffmpeg</command>, 
-<command>ffserver</command>, 
-<command>ffplay</command>, 
-<filename class="libraryfile">libavcodec</filename>, 
-<filename class="libraryfile">libavformat</filename> and 
-video hook modules.</para>
+<segmentedlist>
+<segtitle>Installed Programs</segtitle>
+<segtitle>Installed Libraries</segtitle>
+<segtitle>Installed Directories</segtitle>
+<seglistitem>
+<seg>ffmpeg, ffserver and optionally, ffplay</seg>
+<seg>libavcodec.so, libavformat.so and video hook modules</seg>
+<seg>/usr/include/ffmpeg, /usr/lib/vhook and 
+/usr/share/doc/ffmpeg-&ffmpeg-version;</seg>
+</seglistitem>
+</segmentedlist>
 
-</sect2>
+<variablelist>
+<bridgehead renderas="sect3">Short Descriptions</bridgehead>
+<?dbfo list-presentation="list"?>
 
-<sect2><title>Description</title>
+<varlistentry id="ffmpeg">
+<term><command>ffmpeg</command></term>
+<listitem><para>is a command-line tool to convert video files, network streams 
+and input from a <acronym>TV</acronym> card to several video formats.</para>
+<indexterm zone="ffmpeg-package ffmpeg">
+<primary sortas="b-ffmpeg">ffmpeg</primary></indexterm>
+</listitem>
+</varlistentry>
 
-<sect3><title>ffmpeg</title>
-<para><command>ffmpeg</command> is a command-line tool to convert video files, 
-network streams and input from a TV card to several video formats.</para>
-</sect3>
+<varlistentry id="ffplay">
+<term><command>ffplay</command></term>
+<listitem><para>is a very simple and portable media player using the 
+<filename>ffmpeg</filename> libraries and the <acronym>SDL</acronym> 
+library.</para>
+<indexterm zone="ffmpeg-package ffplay">
+<primary sortas="b-ffplay">ffplay</primary></indexterm>
+</listitem>
+</varlistentry>
 
-<sect3><title>ffserver</title>
-<para><command>ffserver</command> is a streaming server for everything
-that <command>ffmpeg</command> could use as input (files, streams, TV card 
-input, webcam, etc.).</para></sect3>
+<varlistentry id="ffserver">
+<term><command>ffserver</command></term>
+<listitem><para>is a streaming server for everything that 
+<command>ffmpeg</command> could use as input (files, streams, TV card input, 
+webcam, etc.).</para>
+<indexterm zone="ffmpeg-package ffserver">
+<primary sortas="b-ffserver">ffserver</primary></indexterm>
+</listitem>
+</varlistentry>
 
-<sect3><title>ffplay</title>
-<para><command>ffplay</command> is a very simple and portable media 
-player using the <filename>ffmpeg</filename> libraries and the 
-<acronym>SDL</acronym> library.</para></sect3>
+<varlistentry id="libavcodec">
+<term><filename class='libraryfile'>libavcodec.so</filename></term>
+<listitem><para>is a library containing the <application>FFmpeg</application> 
+codecs (both encoding and decoding).</para>
+<indexterm zone="ffmpeg-package libavcodec">
+<primary sortas="c-libavcodec">libavcodec.so</primary></indexterm>
+</listitem>
+</varlistentry>
 
-<sect3><title>libavcodec/libavformat</title>
-<para><filename class="libraryfile">libavcodec</filename> and 
-<filename class="libraryfile">libavformats</filename> are libraries for 
-encoding/decoding video streams and putting them into files or network 
-packets.</para></sect3>
+<varlistentry id="libavformat">
+<term><filename class='libraryfile'>libavformat.so</filename></term>
+<listitem><para>is a library containing the file formats handling (mux and 
+demux code for several formats) used by <command>ffplay</command> as well as 
+allowing the generation of  audio or video streams.</para>
+<indexterm zone="ffmpeg-package libavformat">
+<primary sortas="c-libavformat">libavformat.so</primary></indexterm>
+</listitem>
+</varlistentry>
+</variablelist>
 
 </sect2>
 

Modified: trunk/BOOK/multimedia/videoutils/transcode.xml
===================================================================
--- trunk/BOOK/multimedia/videoutils/transcode.xml	2005-01-19 15:08:28 UTC (rev 3307)
+++ trunk/BOOK/multimedia/videoutils/transcode.xml	2005-01-19 16:12:46 UTC (rev 3308)
@@ -62,7 +62,7 @@
 
 <sect3><title><application>Transcode</application> dependencies</title>
 <sect4><title>Required</title>
-<para><xref linkend="ffmpeg"/></para>
+<para><xref linkend="ffmpeg-package"/></para>
 </sect4>
 
 <sect4><title>Recommended</title>




More information about the blfs-book mailing list