[Gnash-commit] gnash ChangeLog doc/C/usermanual/installation/i... [release-0-8-0]

[Ann Barcomb]

CVSROOT:        /sources/gnash
Module name:    gnash
Branch:         release-0-8-0
Changes by:     Ann Barcomb <ann>       07/06/05 14:57:08

Modified files:
        .              : ChangeLog 
        doc/C/usermanual/installation: install.xml 

Log message:
        This adds the section of the documentation which explains where Gnash
        installs.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/ChangeLog?cvsroot=gnash&only_with_tag=release-0-8-0&r1=1.3451.2.8&r2=1.3451.2.9
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/install.xml?cvsroot=gnash&only_with_tag=release-0-8-0&r1=1.1&r2=1.1.4.1

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/gnash/gnash/ChangeLog,v
retrieving revision 1.3451.2.8
retrieving revision 1.3451.2.9
diff -u -b -r1.3451.2.8 -r1.3451.2.9
--- ChangeLog   5 Jun 2007 14:45:42 -0000       1.3451.2.8
+++ ChangeLog   5 Jun 2007 14:57:07 -0000       1.3451.2.9
@@ -1,3 +1,7 @@
+2007-06-05 Ann Barcomb <address@hidden>
+       * doc/C/usermanual/installation/install.xml: Added information on
+         where Gnash installs.
+
 2007-06-05 Tomas Groth Christensen <address@hidden>
 
        * testsuite/media/square.flv: Changed the movements in the movie to

Index: doc/C/usermanual/installation/install.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/usermanual/installation/install.xml,v
retrieving revision 1.1
retrieving revision 1.1.4.1
diff -u -b -r1.1 -r1.1.4.1
--- doc/C/usermanual/installation/install.xml   27 May 2007 09:01:58 -0000      
1.1
+++ doc/C/usermanual/installation/install.xml   5 Jun 2007 14:57:08 -0000       
1.1.4.1
@@ -1 +1,110 @@
 <title>Installation</title>
+
+<para>
+  Installation is done with the command:
+  <programlisting>
+  make install
+  </programlisting>
+</para>
+
+<para>
+  &app; installs a number of <link linkend="libinstall">libraries</link>,
+  namely: <emphasis>libbase</emphasis>,
+  <emphasis>libgeometry</emphasis>, <emphasis>libbackend</emphasis>,
+  <emphasis>libserver</emphasis>, and <emphasis>libmozsdk</emphasis>.
+  <link linkend="appinstall">Executables</link>
+  consist of the (optional) plugin, <filename>gprocessor</filename>,
+  <filename>cygnal</filename>,  and <filename>gnash</filename>.
+  <link linkend="docinstall">Documentation</link> may also be installed.
+  The installation location is controlled with the
+  <emphasis>--prefix</emphasis> <link linkend="custompath">configure
+  option</link>.
+</para>
+
+<para>
+  Note that if you are using a single file-system <emphasis>NFS</emphasis>
+  mounted to multiple platforms, the 
+  <link linkend="custompath">configuration option</link> 
+  <emphasis>--exec-prefix</emphasis> may be used to specify where
+  platform-dependent executables and libraries are installed.
+</para>
+  
+<sect4 id="libinstall">
+  <title>Libraries</title>
+  
+  <para>
+    Installed libraries are located in 
+    <filename>/usr/local/lib</filename> by default.
+    If the <emphasis>--prefix</emphasis> option was used in
+    <link linkend="configure">configuration</link>, the libraries will
+    be installed in the directory <filename>lib</filename> inside the
+    path you specified.  If the libraries are stored in a non-standard
+    location, you need to identify the path in one of two ways.
+  </para>
+
+  <para>
+    The traditional way to do this on UNIX
+    platforms is to set the <emphasis>LD_LIBRARY_PATH</emphasis> variable
+    to the path plus <filename>/lib</filename>.  For example, if you
+    installed in <filename>/home/gnash</filename>, the 
+    <emphasis>LD_LIBRARY_PATH</emphasis> path would be
+    <filename>/home/gnash/lib</filename>.  Multiple paths are delimited
+    with a colon (':').
+  </para>
+  
+  <para>
+    GNU/Linux allows the custom path to be added to
+    <filename>/etc/ld.so.conf</filename>.  After adding the path,
+    run <emphasis>ldconfig</emphasis> as root to update the runtime
+    cache.
+  </para>
+</sect4>
+
+<sect4 id="appinstall">
+  <title>Executables</title>
+
+  <para>
+    The Mozilla plugin is installed into the <filename>plugins</filename>
+    directory of the system
+    installed <emphasis>Firefox</emphasis> or <emphasis>Mozilla</emphasis>, 
+    if development packages are installed for either of them.
+    Otherwise, the default is <filename>/usr/lib/mozilla/plugins</filename>. 
+    You may also specify the plugin installation directory by using the 
+    <emphasis>--with-plugindir</emphasis> <link linkend="custompath">option 
+    to configure</link>.
+  </para>
+
+  <para>
+    The remaining executables will be installed in the <filename>bin</filename>
+    subdirectory of the directory specified by during configuration.
+    If no path was specified, the default is 
+    <filename>/usr/local/bin</filename>.
+  </para>
+</sect4>
+
+<sect4 id="docinstall">
+  <title>Documentation</title>
+
+  <para>
+    Documentation is not built by default; please refer to the 
+    <link linkend="processdoc">section on documentation</link> for
+    more information on building documentation.
+  </para>
+
+  <para>
+    <emphasis>man</emphasis> and <emphasis>info</emphasis> 
+    will be installed in <filename>/usr/local/share/man</filename>
+    and <filename>/usr/local/share/info</filename> respectively, unless
+    the <emphasis>--mandif</emphasis> or <emphasis>--infodir</emphasis>
+    <link linkend="custompath">configuration options</link> are used.
+  </para>
+
+  <para>
+    <emphasis>GNOME help</emphasis> documentation uses the directory
+    <filename>/usr/local/share/gnash/doc/gnash/C/</filename> by default.
+    A configuration file in the &app; source tree,
+    <filename>doc/C/gnash.omf</filename> is used to specify under
+    which menu item &app; appears in the <emphasis>GNOME help</emphasis>
+    system.
+  </para>
+</sect4>