SF.net SVN: openvrml:[3940] trunk

[<br...@us...>]

Revision: 3940
          http://openvrml.svn.sourceforge.net/openvrml/?rev=3940&view=rev
Author:   braden
Date:     2009-07-02 23:14:31 +0000 (Thu, 02 Jul 2009)

Log Message:
-----------
Document the OPENVRML_FT_CONST and OPENVRML_JNI_CONST preprocessor symbols; document the environment variables used by libopenvrml and openvrml-player.

Modified Paths:
--------------
    trunk/ChangeLog
    trunk/README

Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog	2009-07-02 21:27:25 UTC (rev 3939)
+++ trunk/ChangeLog	2009-07-02 23:14:31 UTC (rev 3940)
@@ -1,5 +1,11 @@
 2009-07-02 Braden McDaniel  <br...@en...>
 
+	* README: Document the OPENVRML_FT_CONST and OPENVRML_JNI_CONST
+	preprocessor symbols; document the environment variables used by
+	libopenvrml and openvrml-player.
+
+2009-07-02 Braden McDaniel  <br...@en...>
+
 	* README: Note libxml as a required dependency on non-Windows
 	platforms.
 

Modified: trunk/README
===================================================================
--- trunk/README	2009-07-02 21:27:25 UTC (rev 3939)
+++ trunk/README	2009-07-02 23:14:31 UTC (rev 3940)
@@ -306,7 +306,15 @@
      Include support for rendering text using the Text node.  Requires
      fontconfig and FreeType.
 
+ OPENVRML_FT_CONST
+     Define to "const" if "const" should be used in FreeType callback
+     function signatures; define to empty otherwise.
 
+ OPENVRML_JNI_CONST
+     Define to "const" if "const" should be used in JNI function
+     signatures; define to empty otherwise.
+
+
 Installation
 ============
 
@@ -320,6 +328,32 @@
 documentation in the "doc/manual" subdirectory of the distribution and
 the example programs in the "examples" subdirectory.
 
+   libopenvrml loads data files and plug-ins from known locations once
+it is installed.  If they are defined, libopenvrml will prefer the
+locations specified by these environment variables:
+
+ OPENVRML_DATADIR
+     Directory where libopenvrml looks for architecture-independent
+     data.
+
+ OPENVRML_NODE_PATH
+     A search path where libopenvrml looks for node implementations.
+
+ OPENVRML_SCRIPT_PATH
+     A search path where libopenvrml looks for scripting engine
+     implementations.
+
+   The most common use case for setting these environment variables is
+running sdl-viewer or openvrml-xembed from the build directories.  For
+example, if running a Bash shell and building in a subdirectory
+"build" where the current directory is the root of the OpenVRML
+distribution:
+
+   $ OPENVRML_DATADIR=$(pwd)/data \
+   OPENVRML_NODE_PATH=$(pwd)/build/src/node \
+   OPENVRML_SCRIPT_PATH=$(pwd)/build/src/script \
+   ./build/examples/sdl-viewer models/rotation_toy.wrl
+
    If OpenVRML is configured to be installed to the same prefix as a
 Mozilla-based browser is installed on the system, "make install" will
 install the Mozilla plug-in to the browser's plug-in directory.  This
@@ -335,7 +369,14 @@
 directories, a symbolic link to the plug-in module "openvrml.so" must
 be made in the Mozilla plug-in directory.
 
+   When running openvrml-player from the build directories, you must
+specify the location of the GTK+ UI XML files using environment
+variable OPENVRML_PLAYER_UIDIR; e.g.:
 
+   $ OPENVRML_PLAYER_UIDIR=$(pwd)/src/openvrml-player \
+   ./build/src/openvrml-player/openvrml-player
+
+
 Conformance
 ===========
 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.