/[gentoo]/xml/htdocs/doc/en/java.xml
Gentoo

Diff of /xml/htdocs/doc/en/java.xml

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.6

  ViewVC Help
Powered by ViewVC 1.1.20