Changeset 65a0209 for multimedia/videoutils

Timestamp:

01/19/2005 04:12:46 PM (19 years ago)

Author:

Randy McMurchy <randy@…>

Branches:

10.0, 10.1, 11.0, 11.1, 11.2, 11.3, 12.0, 12.1, 6.0, 6.1, 6.2, 6.2.0, 6.2.0-rc1, 6.2.0-rc2, 6.3, 6.3-rc1, 6.3-rc2, 6.3-rc3, 7.10, 7.4, 7.5, 7.6, 7.6-blfs, 7.6-systemd, 7.7, 7.8, 7.9, 8.0, 8.1, 8.2, 8.3, 8.4, 9.0, 9.1, basic, bdubbs/svn, elogind, gnome, kde5-13430, kde5-14269, kde5-14686, kea, ken/TL2024, ken/inkscape-core-mods, ken/tuningfonts, krejzi/svn, lazarus, lxqt, nosym, perl-modules, plabs/newcss, plabs/python-mods, python3.11, qt5new, rahul/power-profiles-daemon, renodr/vulkan-addition, systemd-11177, systemd-13485, trunk, upgradedb, xry111/intltool, xry111/llvm18, xry111/soup3, xry111/test-20220226, xry111/xf86-video-removal

Children:

13f51afc

Parents:

d557417

Message:

Added indexing tags and instructions to install HTML documentation to FFmpeg

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@3308 af4574ff-66df-0310-9fd7-8a98e5e911e0

Location:

multimedia/videoutils

Files:

• ffmpeg.xml (modified) (6 diffs)
• transcode.xml (modified) (1 diff)

multimedia/videoutils/ffmpeg.xml

@@ -11 +11 @@
 ]>
 
-<sect1 id="ffmpeg" xreflabel="FFmpeg-&ffmpeg-version;">
+<sect1 id="ffmpeg-package" xreflabel="FFmpeg-&ffmpeg-version;">
 <sect1info>
 <othername>$LastChangedBy$</othername>
@@ -18 +18 @@
 <?dbhtml filename="ffmpeg.html"?>
 <title>FFmpeg-&ffmpeg-version;</title>
+<indexterm zone="ffmpeg-package">
+<primary sortas="a-FFmpeg">FFmpeg</primary></indexterm>
 
 <sect2>
@@ -71 +73 @@
 
 <!-- <screen><userinput><command>patch -Np1 -i ../ffmpeg-&ffmpeg-version;-gcc34-1.patch &amp;&amp; -->
-<screen><userinput><command>./configure --prefix=/usr \
-    --enable-shared --enable-pthreads &amp;&amp;
+<screen><userinput><command>./configure --prefix=/usr --enable-shared \
+    --enable-pthreads --disable-ffplay &amp;&amp;
 make &amp;&amp;
-make -C doc {ffmpeg,ffserver,ffplay}.1 &amp;&amp;
-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 &amp;&amp;
+install -v -d -m755 /usr/share/doc/ffmpeg-&ffmpeg-version; &amp;&amp;
+install -v -m644 doc/*.html /usr/share/doc/ffmpeg-&ffmpeg-version;</command></userinput></screen>
 
 </sect2>
@@ -90 +97 @@
 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>
@@ -110 +118 @@
 <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>
 
@@ -126 +141 @@
 <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>
-
-</sect2>
-
-<sect2><title>Description</title>
-
-<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>
-
-<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>
-
-<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>
-
-<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>
+<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>
+
+<variablelist>
+<bridgehead renderas="sect3">Short Descriptions</bridgehead>
+<?dbfo list-presentation="list"?>
+
+<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>
+
+<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>
+
+<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>
+
+<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>
+
+<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>

multimedia/videoutils/transcode.xml

@@ -63 +63 @@
 <sect3><title><application>Transcode</application> dependencies</title>
 <sect4><title>Required</title>
-<para><xref linkend="ffmpeg"/></para>
+<para><xref linkend="ffmpeg-package"/></para>
 </sect4>