summaryrefslogtreecommitdiffstats
path: root/doc/HowToBuild.html
blob: 1cb3bad8c5d0254bceb133d2067d2f50cfbd4282 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
        <link href="../../style.css" rel="stylesheet" type="text/css"/>
        <title>How to build JOGL</title>
    </head>
    <body>
        <div id="container">
            <div id="header">
                <div id="slogan">How to build JOGL</div>
                <div id="logo"><a href="http://jogamp.org/">How to build JOGL</a></div>
            </div>
            <div id="menu">
                <ul>
                    <li><a href="http://jogamp.org/">Home</a></li>
                    <li><a href="../../gluegen/www/">Gluegen</a></li>
                    <li><a href="../../joal/www/">JOAL</a></li>
                    <li><a href="../../jocl/www/">JOCL</a></li>
                    <li><a href="../../jogl/www/">JOGL</a></li>
                    <li><a href="../../demos/www/">Demos</a></li>
                    <li><a href="../../wiki/">Wiki</a></li>
                    <li><a href="../../deployment/jogl-next/javadoc_public/">JavaDoc</a></li>
                    <li><a href="../../blog/">Blogs</a></li>
                    <li><a href="../../forum.html">Forums</a></li>
                </ul>
            </div>
            <div id="main">
                <div id="text" class="fill">

                    <h2>Platform and Component Requirements</h2>
                    <hr/>
                    Here is a list of platforms and components, we were able to build JOGL on,<br/>
                    if not stated otherwise.<br/>

                    <ul>
                        <li> <b>Java</b><br/>
                            One of the following desktop Java SDK's:
                            <ul>
                                <li> <a href="http://openjdk.java.net/">OpenJDK</a> </li>
                                <li> <a href="http://icedtea.classpath.org/">IcedTea</a> </li>
                                <li> <a href="http://java.sun.com/j2se/">Sun JDK 1.6.0 or later</a> </li>
                            </ul>
                            or you may try one of the following embedded Java SDK's (not yet tested):
                            <ul>
                                <li> <a href="http://mail.openjdk.java.net/pipermail/jdk6-dev/2009-April/000455.html">OpenJDK6 for embedded ARM</a> may use <a href="http://icedtea.classpath.org/wiki/ZeroSharkFaq">Zero/Shark</a></li>
                                <li> <a href="http://java.sun.com/javase/embedded/">Sun JDK for Embedded Use</a></li>
                            </ul>
                            or even the JavaME SDK's (see notes):
                            <ul>
                                <li> <a href="https://phoneme.dev.java.net/">phoneME (tested with a proprietary VM build)</a><br/>
                                    (tested with a proprietary VM build)</li>
                                <li> <a href="http://jamvm.sourceforge.net/">JamVM (not yet tested)</a><br/>
                                    (not yet tested)</li>
                                <li> <a href="http://www.cacaovm.org/">CacaoVM (not yet tested)</a><br/>
                                    (not yet tested)</li>
                            </ul>
                        </li>
                        <li> <b><a href="http://ant.apache.org/">Ant</a></b> 1.8.0 or later</li>
                        <li> <b><a href="http://www.kernel.org/pub/software/scm/git/docs/">Git</a></b> 1.6.0 or later<br/>
                            <ul>
                                <li> Use your Unix distribution's version, if available, or</li>
                                <li> <a href="http://www.kernel.org/pub/software/scm/git/">Source Code for GNU/Linux, MacOSX, ..</a>, or</li>
                                <li> <a href="http://code.google.com/p/msysgit/">Git on Windows</a>,
                                    <a href="http://code.google.com/p/msysgit/downloads/list">download</a> version
                                    <a href="http://code.google.com/p/msysgit/downloads/detail?name=Git-1.7.0.2-preview20100309.exe&amp;can=2&amp;q=">1.7.0</a> or later.</li>
                                <li> <a href="http://code.google.com/p/git-osx-installer/">git-osx-installer</a> </li>
                            </ul>
                        </li>
                        <li> Optional <b>NVidia Cg 2.2</b> <br/>
                            <ul>
                                <li> <a href="http://developer.nvidia.com/object/cg_download.html">Cg 2.2 Toolkit Download Page</a></li>
                            </ul>
                        </li>

                        <li> <b>GNU Linux</b> x86, 32- and 64-bit<br/>
                            You may have to install a few developer packages ...
                            <ul>
                                <li> <b>Debian</b> 5.00 or later
                                    <ul>
                                        <li>git</li>
                                        <li>gcc</li>
                                        <li>libgl1-mesa-dev</li>
                                        <li>libglu1-mesa-dev</li>
                                        <li>xorg-dev</li>
                                        <li>libice-dev</li>
                                        <li>libsm-dev</li>
                                        <li>libx11-dev</li>
                                        <li>libxext-dev</li>
                                        <li>libxxf86vm-dev</li>
                                        <li>libxinerama-dev</li>
                                        <li>libxrandr-dev</li>
                                        <li>libxrender-dev</li>
                                        <li>libxcursor-dev</li>
                                        <li>Optional: Your card vendor's proprietary driver</li>
                                    </ul>
                                    <pre>
apt-get install git gcc libgl1-mesa-dev libglu1-mesa-dev xorg-dev libice-dev libsm-dev libx11-dev libxext-dev libxxf86vm-dev libxinerama-dev libxrandr-dev libxrender-dev libxcursor-dev
                                    </pre>
                                </li>
                                <li> <b>OpenSuSE</b> 10.2 or later
                                    <ul>
                                        <li>git</li>
                                        <li>gcc</li>
                                        <li>x11-devel</li>
                                        <li>mesa-devel</li>
                                    </ul>
                                </li>
                                <li> <b>CentOS / Red Hat Enterprise Linux</b> 5.4 or later<br/>
                                    <ul>
                                        <li>git</li>
                                        <li>gcc</li>
                                        <li>mesa-libGL-devel</li>
                                        <li>xorg-x11-proto-devel</li>
                                        <li>libICE-devel</li>
                                        <li>libSM-devel</li>
                                        <li>libX11-devel</li>
                                        <li>libXext-devel</li>
                                        <li>libXau-devel</li>
                                        <li>libXdmcp-devel</li>
                                        <li>libXt-devel</li>
                                        <li>libXxf86vm-devel</li>
                                        <li>libXinerama-devel</li>
                                        <li>libXrandr-devel</li>
                                        <li>libXrender-devel</li>
                                        <li>libXcursor-devel</li>
                                        <li>Optional: Your card vendor's proprietary driver</li>
                                    </ul>
                                </li>
                            </ul>
                        </li>
                        <li> <b>OpenSolaris</b> SPARC and x86, 32- and 64-bit
                            <ul>
                                <li> <a href="http://opensolaris.org/">OpenSolaris 2009.06 or later</a></li>
                            </ul>
                        </li>
                        <li> <b>MacOSX</b> Intel
                            <ul>
                                <li> git, see above </li>
                                <li> <a href="http://www.apple.com/macosx/">Mac OS X</a> 10.3 (note: will not work with earlier releases) </li>
                                <li> <a href="http://developer.apple.com/technologies/xcode.html">Xcode</a> for gcc, etc (included in OSX)</li>
                            </ul>
                        </li>
                        <li> <b>Windows</b>/x86 (32 bit)
                            <ul>
                                <li>Windows XP or later </li>
                                <li>git, see above</li>
                                <li> <a href="http://mingw-w64.sourceforge.net/">MinGW64</a>
                                  <ul>
                                    <li> <a href="http://sourceforge.net/projects/mingwbuilds/files/mingw-builds-install/mingw-builds-install.exe/download">Installer</a>
                                      <ul>
                                        <li>mingw-build-install</li>
                                        <li>version: 4.8.1</li>
                                        <li>host: x32</li>
                                        <li>threading: win32</li>
                                        <li>exceptions: SJLJ</li>
                                        <li>revision: 5</li>
                                      </ul></li>
                                    <li> or <a href="http://sourceforge.net/projects/mingwbuilds/files/host-windows/releases/">manual</a> 
                                         via  <a href="http://sourceforge.net/projects/mingwbuilds/files/host-windows/releases/4.8.1/32-bit/threads-win32/sjlj/">7z archive file</a></li>
                                  </ul></li>
                            </ul>
                        </li>
                        <li> <b>Windows</b>/x86_64 (64-bit)
                            <ul>
                                <li>Windows XP or later </li>
                                <li>git, see above</li>
                                <li> <a href="http://mingw-w64.sourceforge.net/">MinGW64</a>
                                  <ul>
                                    <li> <a href="http://sourceforge.net/projects/mingwbuilds/files/mingw-builds-install/mingw-builds-install.exe/download">Installer</a>
                                      <ul>
                                        <li>mingw-build-install</li>
                                        <li>version: 4.8.1</li>
                                        <li>host: x64</li>
                                        <li>threading: win32</li>
                                        <li>exceptions: SJLJ</li>
                                        <li>revision: 5</li>
                                      </ul></li>
                                    <li> or <a href="http://sourceforge.net/projects/mingwbuilds/files/host-windows/releases/">manual</a> 
                                         via  <a href="http://sourceforge.net/projects/mingwbuilds/files/host-windows/releases/4.8.1/64-bit/threads-win32/sjlj/">7z archive file</a></li>
                                  </ul></li>
                            </ul>
                        </li>
                    </ul>

                    <p>
                        Additional platforms such as FreeBSD and HP/UX are handled by the
                        build system, but are not officially supported.
                    </p>

                    <h2>Build Steps</h2>
                    <hr/>
                    <p>
                        Here are the steps that are required in order to build JOGL.
                    </p>

                    <ol>
                        <li><b>Optain the source code</b> using git:
                            <ul>
                                <li><a href="http://jogamp.org/git/?p=gluegen.git">Gluegen Dev GIT Repo</a></li>
                                <li><a href="http://jogamp.org/git/?p=jogl.git">JOGL Dev GIT Repo</a></li>
                            </ul><br/>
                            It is crucial that you checkout the source code under a common root directory:
                            <pre>
    /home/dude/projects/jogamp> git clone git://jogamp.org/srv/scm/gluegen.git gluegen
    /home/dude/projects/jogamp> git clone git://jogamp.org/srv/scm/jogl.git jogl
                            </pre>
                            Now you should have following directory structure:
                            <pre>
    /home/dude/projects/jogamp
    /home/dude/projects/jogamp/gluegen
    /home/dude/projects/jogamp/jogl
                            </pre>
                        </li>

                        <li> <b>Unset your CLASSPATH environment variable:</b> <br/>
                            The Ant build requires that the JOGL jars not be visible on the classpath. On Unix, type
                            <code> unsetenv CLASSPATH </code> into a csh or tcsh shell, or <code> unset CLASSPATH </code>
                            into a Bourne shell. On Windows, type <code> set CLASSPATH= </code> into a command prompt.
                        </li>

                        <li> <b>Optional</b>  <i>Copy and edit <b>gluegen.properties</b>:</i> <br/>
                            To specify different basic options for components and compilers,<br/>
                            copy <b>gluegen/make/gluegen.properties</b> into your home directory (pointed to by the Java system property <b>user.home</b>). <br/></li>

                        <li> <b>Optional</b>  <i>Copy and edit <b>jogl.properties</b>:</i> <br/>
                            To specify different basic options for the build,<br/>
                            copy <b>jogl/make/jogl.properties</b> into your home directory (pointed to by the Java system property
                            <b>user.home</b>). <br/>
                            Edit the copy to change desired settings.
                        </li>

                        <li> <b>Build the source tree:</b> <br/>
                            Open a command shell in the "gluegen/make" directory of the source tree and type <code>"ant"</code>.<br/>
                            Then open a command shell in the "jogl/make" directory of the source tree and type <code>"ant"</code>.
                            <ul>
                                <li>
                                    An experimental binding to the high-level <a href="http://developer.nvidia.com/view.asp?PAGE=cg_main">Cg</a>
                                    language by NVidia corporation can be generated by specifying <code>-Djogl.cg=1</code> to ant; e.g.
                                    <code>ant -Djogl.cg=1</code>. The Cg binding has been tested on Windows, Linux, and Mac OS X.
                                </li>
                            </ul>
                        </li>

                        <li> <b>Test your build:</b> <br/> Stay in your command shell in the "jogl/make" directory of the source tree and type <code>"ant junit.run"</code>.</li>

                        <li> <b>Build Javadoc:</b> <br/> Stay in your command shell in the "jogl/make" directory of the source tree and type "<code>ant javadoc.all"</code>.
                            This will produce the end-user documentation for JOGL along with some auxiliary utility packages.
                        </li>
                    </ol>

                    Note that there are a lot of warnings produced by ANTLR about the
                    C grammar and our modifications to some of the signatures of the
                    productions; the C grammar warnings have been documented by the
                    author of the grammar as having been investigated completely and
                    harmless, and the warnings about our modifications are also
                    harmless.

                    <h2> Common build problems </h2>

                    <ol>

                        <li>
                            <b>Your CLASSPATH environment variable appears to be set (some JOGL classes are currently visible to the build.)</b>, and $CLASSPATH isn't set.
                            An older version of JOGL was installed into the extension directory of the JDK you're using to build the
                            current JOGL. On Windows and Linux, delete any ANTLR jars from jre/lib/ext, and on Mac OS X, delete them from
                            /Library/Java/Extensions. It is generally not a good idea to drop JOGL directly into the extensions directory,
                            as this can interfere with upgrades via Java Web Start.
                        </li>

                        <li>
                            <b>CharScanner; panic: ClassNotFoundException: com.sun.gluegen.cgram.CToken</b>

                            This occurs because ANTLR was dropped into the Extensions
                            directory of the JRE/JDK. On Windows and Linux, delete any ANTLR jars from jre/lib/ext,
                            and on Mac OS X, delete them from /Library/Java/Extensions. Use the antlr.jar property in the build.xml
                            to point to a JRE-external location of this jar file.
                        </li>

                    </ol>

                    <br/>
                    <p>
                        <i>- Christopher Kline and Kenneth Russell, June 2003 (revised November 2006)</i><br/>
                        <i>- Sven Gothel and Michael Bien, May 2010</i><br/>
                    </p>

                </div>
            </div>
            <div id="footer">
                <div id="footer_left">
                    <span>JogAmp.org</span>
                    by <a href="http://jogamp.org">http://jogamp.org</a>
                    is licensed under a <br/>
                    <a href="http://creativecommons.org/licenses/by/3.0/us/">Creative Commons Attribution 3.0 License</a>.
                </div>
            </div>
        </div>
    </body>
</html>