aboutsummaryrefslogtreecommitdiffstats
path: root/doc/userguide/index.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/userguide/index.html')
-rw-r--r--doc/userguide/index.html69
1 files changed, 36 insertions, 33 deletions
diff --git a/doc/userguide/index.html b/doc/userguide/index.html
index a76b36b5c..b3d1e408d 100644
--- a/doc/userguide/index.html
+++ b/doc/userguide/index.html
@@ -90,39 +90,42 @@ the JSR has not yet been produced.
<P>
-The JOGL distribution for developers contains two parts: a
-platform-independent JAR file containing the Java classes of the
-library (jogl.jar) and a platform-dependent native library containing
-the associated JNI code which calls OpenGL.
+The JOGL distribution for developers comes in the form of a zip
+archive which contains the Java classes to call OpenGL from Java, as
+well as the associated JNI native libraries. JOGL depends on some
+run-time support classes and native code provided by the GlueGen
+project; these classes and native code are also provided in the zip
+bundles.
</P>
<P>
-If you are developing a new application which uses JOGL, download both
-jogl.jar and the appropriate native library jar file (for example,
-jogl-natives-win32.jar). It is recommended to place both of these jar
-files in the same directory. Modify your CLASSPATH environment
-variable to include the full path to jogl.jar; for example,
-".;C:\Some\Other\Package\foo.jar;C:\Users\myhome\jogl\jogl.jar". (If
-you did not previously set the CLASSPATH environment variable, you may
-want to make sure that ".", the current directory, is on your new
-CLASSPATH.) Use the jar command which ships with the JDK to extract
-the native library jar; e.g., "jar xvf jogl-natives-win32.jar". Modify
-your PATH environment variable (Windows), LD_LIBRARY_PATH environment
-variable (Solaris and Linux), or DYLD_LIBRARY_PATH environment
-variable (Mac OS X) to contain the directory holding the new .dll, .so
-or .jnilib files. At this point your Java installation should be able
-to see the JOGL class files. Users of IDEs such as NetBeans and
-Eclipse should consult the IDE's documentation to see how to add jar
-files and native libraries to their current project.
+If you are developing a new application which uses JOGL, download the
+zip archive for your platform (for example.,
+jogl-[version]-windows-i586.zip) and unzip it. Modify your CLASSPATH
+environment variable to include the full paths to jogl.jar and
+gluegen-rt.jar; for example,
+".;C:\Some\Other\Package\foo.jar;C:\Users\myhome\jogl-[version]-windows-i586\lib\jogl.jar;C:\Users\myhome\jogl-[version]-windows-i586\lib\gluegen-rt.jar".
+(If you did not previously set the CLASSPATH environment variable, you
+may want to make sure that ".", the current directory, is on your new
+CLASSPATH.) Modify your PATH environment variable (Windows),
+LD_LIBRARY_PATH environment variable (Solaris and Linux), or
+DYLD_LIBRARY_PATH environment variable (Mac OS X) to contain the full
+path to the "lib" directory; for example, on Windows, add
+"C:\Users\myhome\jogl-[version]-windows-i586\lib" to your PATH using
+the System control panel, Advanced tab, Environment Variables
+button. At this point your Java installation should be able to see the
+JOGL class files. Users of IDEs such as NetBeans and Eclipse should
+consult the IDE's documentation to see how to add jar files and native
+libraries to their current project.
</P>
<P>
Dropping the JOGL jar and native library into the extension directory
-of the JRE is strongly discouraged. Doing so can cause conflicts with
-third-party applications launched via Java Web Start, and causes
-confusion later when upgrading the distribution.
+of the JRE is <b>strongly discouraged</b>. Doing so can cause
+conflicts with third-party applications launched via Java Web Start,
+and causes confusion later when upgrading the distribution.
</P>
@@ -148,19 +151,19 @@ the following line in the <code>&lt;resources&gt;</code> section:
</PRE>
This JNLP file points to the current JSR-231 unofficial development
-build; the JNLP file's location will change once the reference
-implementation is complete. The APIs in this release differ
-significantly from the 1.1.1 release of JOGL, which was the last
-pre-JSR release of the JOGL project. It is strongly recommended that
-applications transition to the new APIs, as the implementation is
-generally more robust than the 1.1.1 release and provides new and
-useful functionality. For reference, the stable JOGL 1.1.1 extension
-JNLP file is
+build. For reference, the extension JNLP file for the most recent
+official JSR-231 build is available at
<PRE>
- &lt;extension name="jogl" href="https://jogl.dev.java.net/webstart/jogl-1-1.jnlp" /&gt;
+ &lt;extension name="jogl" href="http://download.java.net/media/jogl/builds/archive/jsr-231-1.0.0/jogl.jnlp" /&gt;
</PRE>
+Note that before JOGL transitioned to the JSR-231 APIs, there were
+releases of the library in the <code>net.java.games.jogl</code>
+namespace under version numbers "1.0", "1.1", and "1.1.1". All of
+these releases have been superseded by JSR-231. Please update your
+applications.
+
</P>
<H3> Applet support </H3>