1 | <?xml version='1.0' encoding="UTF-8"?> |
1 | <?xml version='1.0' encoding="UTF-8"?> |
2 | <?xml-stylesheet href="/xsl/guide.xsl" type="text/xsl"?> |
2 | <?xml-stylesheet href="/xsl/guide.xsl" type="text/xsl"?> |
|
|
3 | |
3 | <guide link = "/doc/en/java.xml"> |
4 | <guide link = "/doc/en/java.xml"> |
4 | <title>Gentoo Java Guide</title> |
5 | <title>Gentoo Java Guide</title> |
5 | <author title="Author and Editor"> |
6 | <author title="Author and Editor"> |
6 | <mail link="karltk@gentoo.org">Karl Trygve Kalleberg</mail> |
7 | <mail link="karltk@gentoo.org">Karl Trygve Kalleberg</mail> |
7 | </author> |
8 | </author> |
8 | |
9 | |
9 | <abstract> |
10 | <abstract> |
10 | Users' and Developers' Guide to Java in Gentoo |
11 | Users' and Developers' Guide to Java in Gentoo |
11 | </abstract> |
12 | </abstract> |
12 | |
13 | |
13 | <version>0.1.1</version> |
14 | <version>0.1.1</version> |
14 | <date>June 25, 2002</date> |
15 | <date>June 25, 2002</date> |
15 | |
16 | |
16 | <chapter> |
17 | <chapter> |
17 | |
|
|
18 | <title>Installing a JDK/JRE</title> |
18 | <title>Installing a JDK/JRE</title> |
19 | <section> |
19 | <section> |
20 | <title>Overview</title> |
20 | <title>Overview</title> |
21 | <body> |
21 | <body> |
|
|
22 | |
22 | <p>Gentoo provides numerous JDKs and JREs. The default is the |
23 | <p>Gentoo provides numerous JDKs and JREs. The default is the |
23 | Blackdown JDK/JRE pair, as it is freely (beer) available without any |
24 | Blackdown JDK/JRE pair, as it is freely (beer) available without any |
24 | registration fuss.</p> |
25 | registration fuss. |
|
|
26 | </p> |
25 | |
27 | |
26 | <note>As kaffe becomes a JRE/JDK drop-in replacement, that will most |
28 | <note>As kaffe becomes a JRE/JDK drop-in replacement, that will most |
27 | likely become our default.</note> |
29 | likely become our default. |
|
|
30 | </note> |
28 | |
31 | |
29 | <p>Both the Sun JDK/JRE and the IBM JDK/JRE are generally faster, but |
32 | <p>Both the Sun JDK/JRE and the IBM JDK/JRE are generally faster, but |
30 | getting them is a bit more work, as you are required to read and |
33 | getting them is a bit more work, as you are required to read and |
31 | accept their license before downloading (IBM additionally requires you |
34 | accept their license before downloading (IBM additionally requires you |
32 | to register).</p> |
35 | to register). |
|
|
36 | </p> |
33 | |
37 | |
34 | <p>Our ebuilds for the Sun and IBM JDK/JREs will notify you of where |
38 | <p>Our ebuilds for the Sun and IBM JDK/JREs will notify you of where |
35 | to go to download them.</p> |
39 | to go to download them. |
|
|
40 | </p> |
|
|
41 | |
36 | </body> |
42 | </body> |
37 | </section> |
43 | </section> |
38 | |
44 | |
39 | <section> |
45 | <section> |
40 | <title>Installing the Sun/IBM JDK/JREs</title> |
46 | <title>Installing the Sun/IBM JDK/JREs</title> |
41 | <body> |
47 | <body> |
|
|
48 | |
42 | <p>If you run <c>emerge dev-java/sun-jdk-1.3.1</c> or <c>emerge |
49 | <p>If you run <c>emerge sun-jdk-1.3.1</c> or <c>emerge |
43 | dev-java/ibm-jdk-1.3.1</c>, you will be notified that you are required |
50 | ibm-jdk-1.3.1</c>, you will be notified that you are required |
44 | to download the actual tarballs yourself. This has to do with license |
51 | to download the actual tarballs yourself. This has to do with license |
45 | restrictions for the Sun JDK/JRE (online click-wrap license) and |
52 | restrictions for the Sun JDK/JRE (online click-wrap license) and |
46 | registration issues with the IBM JDK/JRE.</p> |
53 | registration issues with the IBM JDK/JRE. |
|
|
54 | </p> |
47 | |
55 | |
48 | <note>There is also a dev-java/sun-jdk-1.4.0, but not all packages |
56 | <note>There is also a sun-jdk-1.4.0, but not all packages |
49 | work nicely with Java 1.4, so you're on your own if you use the 1.4.0 |
57 | work nicely with Java 1.4, so you're on your own if you use the 1.4.0 |
50 | JDK.</note> |
58 | JDK. |
|
|
59 | </note> |
51 | |
60 | |
52 | <p>You should download the indicated file(s) into |
61 | <p>You should download the indicated file(s) into |
53 | <path>/usr/portage/distfiles</path>. Once that is done, you can rerun |
62 | <path>/usr/portage/distfiles</path>. Once that is done, you can rerun |
54 | the emerge command, then the JDK/JRE will be installed properly into |
63 | the emerge command, then the JDK/JRE will be installed properly into |
55 | <path>/opt</path>.</p> |
64 | <path>/opt</path>. |
|
|
65 | </p> |
|
|
66 | |
56 | </body> |
67 | </body> |
57 | </section> |
68 | </section> |
58 | </chapter> |
69 | </chapter> |
59 | |
70 | |
60 | <chapter> |
71 | <chapter> |
61 | <title>Configuring your JDK/JRE</title> |
72 | <title>Configuring your JDK/JRE</title> |
|
|
73 | |
62 | <section> |
74 | <section> |
63 | <title>Overview</title> |
75 | <title>Overview</title> |
|
|
76 | |
64 | <body> |
77 | <body> |
|
|
78 | |
65 | <p>Gentoo has the ability to have multiple JDKs and JREs installed |
79 | <p>Gentoo has the ability to have multiple JDKs and JREs installed |
66 | without them conflicting. There are a few caveats to this, as noted |
80 | without them conflicting. There are a few caveats to this, as noted |
67 | below.</p> |
81 | below. |
|
|
82 | </p> |
68 | |
83 | |
69 | <p>Using the <c>java-config</c> tool, you can set the system-wide |
84 | <p>Using the <c>java-config</c> tool, you can set the system-wide |
70 | default if you have root access. Users can also use <c>java-config</c> |
85 | default if you have root access. Users can also use <c>java-config</c> |
71 | to set up their own personal default, that is different from the |
86 | to set up their own personal default, that is different from the |
72 | system-wide default.</p> |
87 | system-wide default. |
|
|
88 | </p> |
|
|
89 | |
73 | </body> |
90 | </body> |
74 | </section> |
91 | </section> |
75 | |
92 | |
76 | <section> |
93 | <section> |
77 | <title>Setting a default JDK/JRE</title> |
94 | <title>Setting a default JDK/JRE</title> |
78 | <body> |
95 | <body> |
|
|
96 | |
79 | <p>Running the command <c>java-config --list-available-vms</c> will |
97 | <p>Running the command <c>java-config --list-available-vms</c> will |
80 | give you a list of all availble JREs and JDKs on your system, thus:</p> |
98 | give you a list of all availble JREs and JDKs on your system, thus:</p> |
81 | <pre> |
99 | |
|
|
100 | <pre caption = "Listing available VMs"> |
82 | [%1 ~] java-config --list-available-vms |
101 | [%1 ~] java-config --list-available-vms |
83 | [blackdown-jdk-1.3.1] Blackdown JDK 1.3.1 (/etc/env.d/java/20blackdown-jdk-1.3.1) |
102 | [blackdown-jdk-1.3.1] Blackdown JDK 1.3.1 (/etc/env.d/java/20blackdown-jdk-1.3.1) |
84 | [blackdown-jre-1.3.1] Blackdown JRE 1.3.1 (/etc/env.d/java/20blackdown-jre-1.3.1) |
103 | [blackdown-jre-1.3.1] Blackdown JRE 1.3.1 (/etc/env.d/java/20blackdown-jre-1.3.1) |
85 | [ibm-jdk-1.3.0] IBM JDK 1.3.0 (/etc/env.d/java/20ibm-jdk-1.3.0) |
104 | [ibm-jdk-1.3.0] IBM JDK 1.3.0 (/etc/env.d/java/20ibm-jdk-1.3.0) |
86 | [ibm-jdk-1.3.1] IBM JDK 1.3.1 (/etc/env.d/java/20ibm-jdk-1.3.1) |
105 | [ibm-jdk-1.3.1] IBM JDK 1.3.1 (/etc/env.d/java/20ibm-jdk-1.3.1) |
87 | [ibm-jre-1.3.1] IBM JRE 1.3.1 (/etc/env.d/java/20ibm-jre-1.3.1) |
106 | [ibm-jre-1.3.1] IBM JRE 1.3.1 (/etc/env.d/java/20ibm-jre-1.3.1) |
88 | [sun-jdk-1.4.0] Sun JDK 1.4.0 (/etc/env.d/java/20sun-jdk-1.4.0) |
107 | [sun-jdk-1.4.0] Sun JDK 1.4.0 (/etc/env.d/java/20sun-jdk-1.4.0) |
89 | </pre> |
108 | </pre> |
|
|
109 | |
90 | <p>The name in the brackets <path>"[]"</path> is the handle or ID for |
110 | <p>The name in the brackets <path>"[]"</path> is the handle or ID for |
91 | that particular VM. You use pass that ID to <c>java-config |
111 | that particular VM. You use pass that ID to <c>java-config |
92 | --set-system-vm</c>, thus:</p> |
112 | --set-system-vm</c>, thus: |
93 | <pre> |
113 | </p> |
|
|
114 | |
|
|
115 | <pre caption = "Setting the System VM"> |
94 | [#1 ~] java-config --set-system-vm=ibm-jdk-1.3.1 |
116 | [#1 ~] java-config --set-system-vm=ibm-jdk-1.3.1 |
95 | Now using IBM JDK 1.3.1 (/etc/env.d/java/20ibm-jdk-1.3.1) |
117 | Now using IBM JDK 1.3.1 (/etc/env.d/java/20ibm-jdk-1.3.1) |
96 | </pre> |
118 | </pre> |
97 | |
119 | |
98 | <note>You will have to be root to run --set-system-vm</note> |
120 | <note>You will have to be root to run --set-system-vm |
|
|
121 | </note> |
99 | |
122 | |
100 | <p>Once you have issued <c>java-config --set-system-vm</c> with a |
123 | <p>Once you have issued <c>java-config --set-system-vm</c> with a |
101 | particular VM ID, you will need to regenerate your /etc/profile.env, |
124 | particular VM ID, you will need to regenerate your /etc/profile.env, |
102 | thus:</p> |
125 | thus: |
103 | <pre> |
126 | </p> |
|
|
127 | |
|
|
128 | <pre caption = "Regenerating /etc/profile.env" > |
104 | [#1 ~] env-update |
129 | [#1 ~] env-update |
105 | </pre> |
130 | </pre> |
106 | |
131 | |
107 | <p>After this, you will either want to relogin, or resource |
132 | <p>After this, you will either want to relogin, or resource |
108 | <path>/etc/profile</path> into your environment.</p> |
133 | <path>/etc/profile</path> into your environment. |
|
|
134 | </p> |
109 | |
135 | |
110 | <p>As a regular user, you can use <c>java-config --set-user-vm</c>, |
136 | <p>As a regular user, you can use <c>java-config --set-user-vm</c>, |
111 | which will create <path>$HOME/.gentoo/java-env</path> with all |
137 | which will create <path>$HOME/.gentoo/java-env</path> with all |
112 | required env vars. You would normally source this from your shell's |
138 | required env vars. You would normally source this from your shell's |
113 | startup script (<path>$HOME/.zshenv</path> in my case).</p> |
139 | startup script (<path>$HOME/.zshenv</path> in my case).</p> |
|
|
140 | |
114 | </body> |
141 | </body> |
115 | </section> |
142 | </section> |
116 | |
143 | |
117 | <section> |
144 | <section> |
118 | <title>Setting a default CLASSPATH</title> |
145 | <title>Setting a default CLASSPATH</title> |
119 | <body> |
146 | <body> |
|
|
147 | |
120 | <p><c>java-config</c> can also be used to set a system-wide default |
148 | <p><c>java-config</c> can also be used to set a system-wide default |
121 | CLASSPATH, and of course a user-specific default CLASSPATH.</p> |
149 | CLASSPATH, and of course a user-specific default CLASSPATH. |
|
|
150 | </p> |
122 | |
151 | |
123 | <p>First you want to list available java libraries that might be |
152 | <p>First you want to list available java libraries that might be |
124 | interesting to put in your CLASSPATH, thus:</p> |
153 | interesting to put in your CLASSPATH, thus: |
125 | <pre> |
154 | </p> |
|
|
155 | |
|
|
156 | <pre caption = "Listing classes"> |
126 | [%1 ~] java-config --list-available-packages |
157 | [%1 ~] java-config --list-available-packages |
127 | [ant] No description (/usr/share/ant/classpath.env) |
158 | [ant] No description (/usr/share/ant/classpath.env) |
128 | [java-gnome] No description (/usr/share/java-gnome/classpath.env) |
159 | [java-gnome] No description (/usr/share/java-gnome/classpath.env) |
129 | [java-gtk] No description (/usr/share/java-gtk/classpath.env) |
160 | [java-gtk] No description (/usr/share/java-gtk/classpath.env) |
130 | [log4j] "" (/usr/share/log4j/package.env) |
161 | [log4j] "" (/usr/share/log4j/package.env) |
131 | </pre> |
162 | </pre> |
132 | |
163 | |
133 | <note>None of these packages have a proper description. That is |
164 | <note>None of these packages have a proper description. That is |
134 | something that will be implemented in the not-so-distant |
165 | something that will be implemented in the not-so-distant |
135 | future.</note> |
166 | future. |
|
|
167 | </note> |
136 | |
168 | |
137 | <p>Again, the name in brackets <path>"[]"</path> are the IDs that you |
169 | <p>Again, the name in brackets <path>"[]"</path> are the IDs that you |
138 | have to pass to <c>java-config --set-system-classpath</c>, thus:</p> |
170 | have to pass to <c>java-config --set-system-classpath</c>, thus: |
139 | <pre> |
171 | </p> |
|
|
172 | |
|
|
173 | <pre caption = "Setting classpaths"> |
140 | java-config --set-system-classpath=log4j,java-gtk,java-gnome |
174 | java-config --set-system-classpath=log4j,java-gtk,java-gnome |
141 | </pre> |
175 | </pre> |
|
|
176 | |
142 | <note>The current directory (.) will not be part of the system classpath, |
177 | <note>The current directory (.) will not be part of the system classpath, |
143 | as that should be added in root's login profile.</note> |
178 | as that should be added in root's login profile. |
|
|
179 | </note> |
|
|
180 | |
144 | <p>Again, you will want to run <c>env-update</c> to update your |
181 | <p>Again, you will want to run <c>env-update</c> to update your |
145 | system's environment, and you might also want to relogin or resource |
182 | system's environment, and you might also want to relogin or resource |
146 | the <path>/etc/profile</path>.</p> |
183 | the <path>/etc/profile</path>. |
|
|
184 | </p> |
|
|
185 | |
147 | <p>For users, <c>java-config --set-user-classpath</c> will create |
186 | <p>For users, <c>java-config --set-user-classpath</c> will create |
148 | <path>$HOME/.gentoo/java-env-classpath</path>, which is automatically |
187 | <path>$HOME/.gentoo/java-env-classpath</path>, which is automatically |
149 | included by <path>$HOME/.gentoo/java-env</path>.</p> |
188 | included by <path>$HOME/.gentoo/java-env</path>. |
|
|
189 | </p> |
|
|
190 | |
150 | </body> |
191 | </body> |
151 | </section> |
192 | </section> |
152 | </chapter> |
193 | </chapter> |
153 | |
194 | |
154 | <chapter> |
195 | <chapter> |
155 | <title>Additional resources</title> |
196 | <title>Additional resources</title> |
156 | <section> |
197 | <section> |
157 | <title>Off-line resources</title> |
198 | <title>Off-line resources</title> |
|
|
199 | |
158 | <body> |
200 | <body> |
159 | <ul> |
201 | |
|
|
202 | <ul> |
160 | <li>java-config man page</li> |
203 | <li>java-config man page</li> |
161 | <li><c>java-config --help</c></li> |
204 | <li><c>java-config --help</c></li> |
162 | <li>The <path>/usr/bin/java-config</path> script itself</li> |
205 | <li>The <path>/usr/bin/java-config</path> script itself</li> |
163 | </ul> |
206 | </ul> |
|
|
207 | |
164 | </body> |
208 | </body> |
165 | </section> |
209 | </section> |
|
|
210 | |
166 | <section> |
211 | <section> |
167 | <title>Online resources</title> |
212 | <title>Online resources</title> |
|
|
213 | |
168 | <body> |
214 | <body> |
169 | <ul> |
215 | |
|
|
216 | <ul> |
170 | <li>The <uri link="http://lists.gentoo.org/pipermail/gentoo-dev/"> |
217 | <li>The <uri link="http://lists.gentoo.org/pipermail/gentoo-dev/"> |
171 | gentoo-dev </uri>, |
218 | gentoo-dev </uri>, |
172 | <uri link="http://lists.gentoo.org/pipermail/gentoo-user/"> gentoo-user |
219 | <uri link="http://lists.gentoo.org/pipermail/gentoo-user/"> gentoo-user |
173 | </uri> mailing list archives</li> |
220 | </uri> mailing list archives</li> |
174 | <li>#gentoo on irc.openprojects.net</li> |
221 | <li>#gentoo on irc.openprojects.net</li> |
175 | </ul> |
222 | </ul> |
|
|
223 | |
176 | </body> |
224 | </body> |
177 | </section> |
225 | </section> |
178 | </chapter> |
226 | </chapter> |
|
|
227 | |
179 | <chapter> |
228 | <chapter> |
180 | <title>Caveats</title> |
229 | <title>Caveats</title> |
181 | <section> |
230 | <section> |
182 | <title>General</title> |
231 | <title>General</title> |
|
|
232 | |
183 | <body> |
233 | <body> |
|
|
234 | |
184 | <p>If you select a JRE as your default VM, you may not have a |
235 | <p>If you select a JRE as your default VM, you may not have a |
185 | <c>javac</c> command handy at all times, unless you have manually |
236 | <c>javac</c> command handy at all times, unless you have manually |
186 | installed a symlink to take care of that.</p> |
237 | installed a symlink to take care of that. |
|
|
238 | </p> |
187 | |
239 | |
188 | <p>Jikes will be used to compile some of the largest packages, if it |
240 | <p>Jikes will be used to compile some of the largest packages, if it |
189 | is available. With time, we hope to be able to compile all |
241 | is available. With time, we hope to be able to compile all |
190 | java-dependent packages with Jikes, so some dependencies on the JDK |
242 | java-dependent packages with Jikes, so some dependencies on the JDK |
191 | can be replaced with a dependency on the JRE.</p> |
243 | can be replaced with a dependency on the JRE.</p> |
192 | |
244 | |
193 | <p>With some versions of Portage, doing an <c>emerge --world |
245 | <p>With some versions of Portage, doing an <c>emerge --world |
194 | update</c> will install the JDK regardless if whether you have it |
246 | update</c> will install the JDK regardless if whether you have it |
195 | installed before or not. This is a known bug addressed in later |
247 | installed before or not. This is a known bug addressed in later |
196 | versions of Portage.</p> |
248 | versions of Portage. |
|
|
249 | </p> |
|
|
250 | |
197 | </body> |
251 | </body> |
198 | </section> |
252 | </section> |
199 | </chapter> |
253 | </chapter> |
200 | </guide> |
254 | </guide> |