comparison src/solaris/doc/sun/man/man1/rmic.1 @ 1228:b056c42ea5b4

6837214: Update JDK7 man pages Reviewed-by: darcy, bpatel, tbell Contributed-by: jacob.royal@sun.com
author tbell
date Mon, 04 May 2009 18:28:26 -0700
parents 37a05a11f281
children 00cd9dc3c2b5
comparison
equal deleted inserted replaced
0:70196d168637 1:023c0668e704
1 .'" t 1 ." Copyright 2004-2006 Sun Microsystems, Inc. All Rights Reserved.
2 ." Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
3 ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 2 ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 ." 3 ."
5 ." This code is free software; you can redistribute it and/or modify it 4 ." This code is free software; you can redistribute it and/or modify it
6 ." under the terms of the GNU General Public License version 2 only, as 5 ." under the terms of the GNU General Public License version 2 only, as
7 ." published by the Free Software Foundation. 6 ." published by the Free Software Foundation.
17 ." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 16 ." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 ." 17 ."
19 ." Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, 18 ." Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
20 ." CA 95054 USA or visit www.sun.com if you need additional information or 19 ." CA 95054 USA or visit www.sun.com if you need additional information or
21 ." have any questions. 20 ." have any questions.
22 ." ` 21 ."
23 .TH rmic 1 "05 Aug 2006" 22 .TH rmic 1 "04 May 2009"
24 ." Generated by html2roff 23 ." Generated from HTML by html2man (author: Eric Armstrong)
25 24
26 .LP 25 .LP
27 .SH NAME 26 .SH "Name"
28 rmic \- The Java RMI Compiler 27 rmic \- The Java RMI Compiler
29 .LP 28 .LP
29 .RS 3
30 30
31 .LP 31 .LP
32 .LP 32 .LP
33 \f3rmic\fP generates stub, skeleton, and tie classes for remote objects using either the JRMP or IIOP protocols. Also generates OMG IDL. 33 \f3rmic\fP generates stub, skeleton, and tie classes for remote objects using either the JRMP or IIOP protocols. Also generates OMG IDL.
34 .LP 34 .LP
35 .RE
35 .SH "SYNOPSIS" 36 .SH "SYNOPSIS"
36 .LP 37 .LP
37 38
38 .LP 39 .LP
39 .nf 40 .nf
81 .LP 82 .LP
82 .SH "OPTIONS" 83 .SH "OPTIONS"
83 .LP 84 .LP
84 85
85 .LP 86 .LP
87 .RS 3
86 .TP 3 88 .TP 3
87 \-bootclasspath path 89 \-bootclasspath path
88 Overrides location of bootstrap class files 90 Overrides location of bootstrap class files
89 .TP 3 91 .TP 3
90 \-classpath path 92 \-classpath path
133 \-extdirs path 135 \-extdirs path
134 Overrides location of installed extensions 136 Overrides location of installed extensions
135 .TP 3 137 .TP 3
136 \-g 138 \-g
137 Enables generation of all debugging information, including local variables. By default, only line number information is generated. 139 Enables generation of all debugging information, including local variables. By default, only line number information is generated.
140 .LP
138 .TP 3 141 .TP 3
139 \-idl 142 \-idl
140 Causes \f2rmic\fP to generate OMG IDL for the classes specified and any classes referenced. IDL provides a purely declarative, programming language\-independent way of specifying an object's API. The IDL is used as a specification for methods and data that can be written in and invoked from any language that provides CORBA bindings. This includes Java and C++ among others. See the 143 Causes \f2rmic\fP to generate OMG IDL for the classes specified and any classes referenced. IDL provides a purely declarative, programming language\-independent way of specifying an object's API. The IDL is used as a specification for methods and data that can be written in and invoked from any language that provides CORBA bindings. This includes Java and C++ among others. See the
141 .na 144 .na
142 \f2Java Language to IDL Mapping\fP @ 145 \f2Java Language to IDL Mapping\fP @
143 .fi 146 .fi
144 http://www.omg.org/technology/documents/formal/java_language_mapping_to_omg_idl.htm (OMG) document for a complete description. 147 http://www.omg.org/technology/documents/formal/java_language_mapping_to_omg_idl.htm (OMG) document for a complete description.
145 .LP 148 .LP
146 When the \f2\-idl\fP option is used, other options also include: 149 When the \f2\-idl\fP option is used, other options also include:
150 .RS 3
147 .TP 3 151 .TP 3
148 \-always or \-alwaysgenerate 152 \-always or \-alwaysgenerate
149 Forces re\-generation even when existing stubs/ties/IDL are newer than the input class. 153 Forces re\-generation even when existing stubs/ties/IDL are newer than the input class.
150 .TP 3 154 .TP 3
151 \-factory 155 \-factory
152 Uses factory keyword in generated IDL. 156 Uses factory keyword in generated IDL.
153 .TP 3 157 .TP 3
154 \-idlModule\ fromJavaPackage[.class]\ 158 \-idlModule\ fromJavaPackage[.class]\ toIDLModule
155 toIDLModule
156 Specifies IDLEntity package mapping. For example:\ \f2\-idlModule foo.bar my::real::idlmod\fP. 159 Specifies IDLEntity package mapping. For example:\ \f2\-idlModule foo.bar my::real::idlmod\fP.
157 .TP 3 160 .TP 3
158 \-idlFile\ fromJavaPackage[.class]\ 161 \-idlFile\ fromJavaPackage[.class]\ toIDLFile
159 toIDLFile 162 Specifies IDLEntity file mapping. For example:\ \f2\-idlFile test.pkg.X TEST16.idl\fP.\
160 Specifies IDLEntity file mapping. For example:\ \f2\-idlFile test.pkg.X TEST16.idl\fP.\ 163 .RE
161 .LP 164 .LP
162 .TP 3 165 .TP 3
163 \-iiop 166 \-iiop
164 Causes \f2rmic\fP to generate IIOP stub and tie classes, rather than JRMP stub and skeleton classes. A stub class is a local proxy for a remote object and is used by clients to send calls to a server. Each remote interface requires a stub class, which implements that remote interface. A client's reference to a remote object is actually a reference to a stub. Tie classes are used on the server side to process incoming calls, and dispatch the calls to the proper implementation class. Each implementation class requires a tie class. 167 Causes \f2rmic\fP to generate IIOP stub and tie classes, rather than JRMP stub and skeleton classes. A stub class is a local proxy for a remote object and is used by clients to send calls to a server. Each remote interface requires a stub class, which implements that remote interface. A client's reference to a remote object is actually a reference to a stub. Tie classes are used on the server side to process incoming calls, and dispatch the calls to the proper implementation class. Each implementation class requires a tie class.
165 .LP 168 .LP
181 \fP 184 \fP
182 .fi 185 .fi
183 .RE 186 .RE
184 .LP 187 .LP
185 When the \f2\-iiop\fP option is used, other options also include: 188 When the \f2\-iiop\fP option is used, other options also include:
189 .RS 3
186 .TP 3 190 .TP 3
187 \-always or \-alwaysgenerate 191 \-always or \-alwaysgenerate
188 Forces re\-generation even when existing stubs/ties/IDL are newer than the input class. 192 Forces re\-generation even when existing stubs/ties/IDL are newer than the input class.
189 .TP 3 193 .TP 3
190 \-nolocalstubs 194 \-nolocalstubs
198 .LP 202 .LP
199 The \f2PortableServer\fP module for the 203 The \f2PortableServer\fP module for the
200 .na 204 .na
201 \f2Portable Object Adapter\fP @ 205 \f2Portable Object Adapter\fP @
202 .fi 206 .fi
203 http://java.sun.com/javase/6/docs/technotes/guides/idl/POA.html (POA) defines the native \f2Servant\fP type. In the Java programming language, the \f2Servant\fP type is mapped to the Java \f2org.omg.PortableServer.Servant\fP class. It serves as the base class for all POA servant implementations and provides a number of methods that may be invoked by the application programmer, as well as methods which are invoked by the POA itself and may be overridden by the user to control aspects of servant behavior. Based on the OMG IDL to Java Language Mapping Specification, CORBA V 2.3.1 ptc/00\-01\-08.pdf. 207 http://java.sun.com/javase/6/docs/technotes/guides/idl/POA.html (POA) defines the native \f2Servant\fP type. In the Java programming language, the \f2Servant\fP type is mapped to the Java \f2org.omg.PortableServer.Servant\fP class. It serves as the base class for all POA servant implementations and provides a number of methods that may be invoked by the application programmer, as well as methods which are invoked by the POA itself and may be overridden by the user to control aspects of servant behavior. Based on the OMG IDL to Java Language Mapping Specification, CORBA V 2.3.1 ptc/00\-01\-08.pdf.
208 .RE
204 .TP 3 209 .TP 3
205 \-J 210 \-J
206 Used in conjunction with any \f2java\fP option, it passes the option following the \f2\-J\fP (no spaces between the \-J and the option) on to the \f2java\fP interpreter. 211 Used in conjunction with any \f2java\fP option, it passes the option following the \f2\-J\fP (no spaces between the \-J and the option) on to the \f2java\fP interpreter.
207 .TP 3 212 .TP 3
208 \-keep or \-keepgenerated 213 \-keep or \-keepgenerated
209 Retains the generated \f2.java\fP source files for the stub, skeleton, and/or tie classes and writes them to the same directory as the \f2.class\fP files. 214 Retains the generated \f2.java\fP source files for the stub, skeleton, and/or tie classes and writes them to the same directory as the \f2.class\fP files.
210 .TP 3 215 .TP 3
211 \-nowarn 216 \-nowarn
212 Turns off warnings. If used the compiler does not print out any warnings. 217 Turns off warnings. If used the compiler does not print out any warnings.
218 .LP
213 .TP 3 219 .TP 3
214 \-vcompat 220 \-vcompat
215 Generates stub and skeleton classes compatible with both the 1.1 and 1.2 JRMP stub protocol versions. (This option was the default in releases prior to 5.0.) The generated stub classes will use the 1.1 stub protocol version when loaded in a JDK 1.1 virtual machine and will use the 1.2 stub protocol version when loaded into a 1.2 (or later) virtual machine. The generated skeleton classes will support both 1.1 and 1.2 stub protocol versions. The generated classes are relatively large in order to support both modes of operation. 221 Generates stub and skeleton classes compatible with both the 1.1 and 1.2 JRMP stub protocol versions. (This option was the default in releases prior to 5.0.) The generated stub classes will use the 1.1 stub protocol version when loaded in a JDK 1.1 virtual machine and will use the 1.2 stub protocol version when loaded into a 1.2 (or later) virtual machine. The generated skeleton classes will support both 1.1 and 1.2 stub protocol versions. The generated classes are relatively large in order to support both modes of operation.
216 .TP 3 222 .TP 3
217 \-verbose 223 \-verbose
218 Causes the compiler and linker to print out messages about what classes are being compiled and what class files are being loaded. 224 Causes the compiler and linker to print out messages about what classes are being compiled and what class files are being loaded.
225 .LP
219 .TP 3 226 .TP 3
220 \-v1.1 227 \-v1.1
221 Generates stub and skeleton classes for the 1.1 JRMP stub protocol version only. Note that this option is only useful for generating stub classes that are serialization\-compatible with pre\-existing, statically\-deployed stub classes that were generated by the \f3rmic\fP tool from JDK 1.1 and that cannot be upgraded (and dynamic class loading is not being used). 228 Generates stub and skeleton classes for the 1.1 JRMP stub protocol version only. Note that this option is only useful for generating stub classes that are serialization\-compatible with pre\-existing, statically\-deployed stub classes that were generated by the \f3rmic\fP tool from JDK 1.1 and that cannot be upgraded (and dynamic class loading is not being used).
229 .LP
222 .TP 3 230 .TP 3
223 \-v1.2 231 \-v1.2
224 (default) Generates stub classes for the 1.2 JRMP stub protocol version only. No skeleton classes are generated with this option because skeleton classes are not used with the 1.2 stub protocol version. The generated stub classes will not work if they are loaded into a JDK 1.1 virtual machine. 232 (default) Generates stub classes for the 1.2 JRMP stub protocol version only. No skeleton classes are generated with this option because skeleton classes are not used with the 1.2 stub protocol version. The generated stub classes will not work if they are loaded into a JDK 1.1 virtual machine.
233 .RE
234
225 .LP 235 .LP
226 .SH "ENVIRONMENT VARIABLES" 236 .SH "ENVIRONMENT VARIABLES"
227 .LP 237 .LP
228 238
229 .LP 239 .LP
240 .RS 3
230 .TP 3 241 .TP 3
231 CLASSPATH 242 CLASSPATH
232 Used to provide the system a path to user\-defined classes. Directories are separated by colons. For example, 243 Used to provide the system a path to user\-defined classes. Directories are separated by colons. For example,
233 .RS 3 244 .RS 3
234 245
239 .:/usr/local/java/classes 250 .:/usr/local/java/classes
240 .fl 251 .fl
241 \fP 252 \fP
242 .fi 253 .fi
243 .RE 254 .RE
255 .RE
244 256
245 .LP 257 .LP
246 .SH "SEE ALSO" 258 .SH "SEE ALSO"
247 .LP 259 .LP
248 260
249 .LP 261 .LP
250 .LP 262 .LP
251 java, javac, CLASSPATH 263 java(1), javac(1),
264 .na
265 \f2CLASSPATH\fP @
266 .fi
267 http://java.sun.com/javase/6/docs/technotes/tools/index.html#classpath
252 .LP 268 .LP
253 269
254 .LP 270 .LP
255 271