1 .\" Copyright (c) 1994, 2019, Oracle and/or its affiliates. All rights reserved.
   2 .\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   3 .\"
   4 .\" This code is free software; you can redistribute it and/or modify it
   5 .\" under the terms of the GNU General Public License version 2 only, as
   6 .\" published by the Free Software Foundation.
   7 .\"
   8 .\" This code is distributed in the hope that it will be useful, but WITHOUT
   9 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10 .\" FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  11 .\" version 2 for more details (a copy is included in the LICENSE file that
  12 .\" accompanied this code).
  13 .\"
  14 .\" You should have received a copy of the GNU General Public License version
  15 .\" 2 along with this work; if not, write to the Free Software Foundation,
  16 .\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  17 .\"
  18 .\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  19 .\" or visit www.oracle.com if you need additional information or have any
  20 .\" questions.
  21 .\"
  22 .\" Automatically generated by Pandoc 2.3.1
  23 .\"
  24 .TH "RMIC" "1" "2018" "JDK 13" "JDK Commands"
  25 .hy
  26 .SH NAME
  27 .PP
  28 rmic \- generate stub and skeleton class files using the Java Remote
  29 Method Protocol (JRMP)
  30 .SH SYNOPSIS
  31 .PP
  32 \f[CB]rmic\f[R] [\f[I]options\f[R]]
  33 \f[I]package\-qualified\-class\-names\f[R]
  34 .TP
  35 .B \f[I]options\f[R]
  36 This represent the command\-line \f[CB]options\f[R] for the\f[CB]rmic\f[R]
  37 compiler.
  38 See \f[B]Options for the rmic Compiler\f[R].
  39 .RS
  40 .RE
  41 .TP
  42 .B \f[I]package\-qualified\-class\-names\f[R]
  43 Class names that include their packages, for example,
  44 \f[CB]java.awt.Color\f[R].
  45 .RS
  46 .RE
  47 .SH DESCRIPTION
  48 .PP
  49 \f[B]Deprecation Note:\f[R] Support for static generation of Java Remote
  50 Method Protocol (JRMP) stubs and skeletons has been deprecated.
  51 Oracle recommends that you use dynamically generated JRMP stubs instead,
  52 eliminating the need to use this tool for JRMP\-based applications.
  53 .PP
  54 The \f[CB]rmic\f[R] compiler generates stub and skeleton class files using
  55 the JRMP.
  56 .PP
  57 \f[B]Note:\f[R]
  58 .PP
  59 The rmic compiler has been updated to remove the \f[CB]\-idl\f[R] and
  60 \f[CB]\-iiop\f[R] options and can no longer generate IDL or IIOP stubs and
  61 tie classes.
  62 .PP
  63 JRMP class files are generated from compiled Java programming language
  64 classes that are remote object implementation classes.
  65 A remote implementation class is a class that implements the interface
  66 \f[CB]java.rmi.Remote\f[R].
  67 The class names in the \f[CB]rmic\f[R] command must be for classes that
  68 were compiled successfully with the \f[CB]javac\f[R] command and must be
  69 fully package qualified.
  70 For example, running the \f[CB]rmic\f[R] command on the class file name
  71 \f[CB]HelloImpl\f[R] as shown here creates the
  72 \f[CB]HelloImpl_Stub.class\f[R] file in the \f[CB]hello\f[R] subdirectory
  73 (named for the class\[aq]s package):
  74 .RS
  75 .PP
  76 \f[CB]rmic\ hello.HelloImpl\f[R]
  77 .RE
  78 .PP
  79 A skeleton for a remote object is a JRMP protocol server\-side entity
  80 that has a method that dispatches calls to the remote object
  81 implementation.
  82 .PP
  83 A stub is a client\-side proxy for a remote object that\[aq]s
  84 responsible for communicating method invocations on remote objects to
  85 the server where the actual remote object implementation resides.
  86 A client\[aq]s reference to a remote object, therefore, is actually a
  87 reference to a local stub.
  88 .PP
  89 By default, the \f[CB]rmic\f[R] command generates stub classes that use
  90 the 1.2 JRMP stub protocol version only, as though the \f[CB]\-v1.2\f[R]
  91 option were specified.
  92 See \f[B]Options for the rmic Compiler\f[R].
  93 .PP
  94 A stub implements only the remote interfaces, and not local interfaces
  95 that the remote object also implements.
  96 Because a JRMP stub implements the same set of remote interfaces as the
  97 remote object, a client can use the Java programming language built\-in
  98 operators for casting and type checking.
  99 .PP
 100 \f[B]Note:\f[R]
 101 .PP
 102 The rmic compiler does not support reading of class files that have been
 103 compiled with the \f[CB]\-\-enable\-preview\f[R] option, nor does it
 104 support generation of stub or skeleton classes that have preview
 105 features enabled.
 106 .SH OPTIONS FOR THE RMIC COMPILER
 107 .TP
 108 .B \f[CB]\-bootclasspath\f[R] \f[I]path\f[R]
 109 Overrides the location of bootstrap class files.
 110 .RS
 111 .RE
 112 .TP
 113 .B \f[CB]\-classpath\f[R] \f[I]path\f[R]
 114 Specifies the path the \f[CB]rmic\f[R] command uses to look up classes.
 115 This option overrides the default or the \f[CB]CLASSPATH\f[R] environment
 116 variable when it is set.
 117 Directories are separated by colons or semicolons, depending on your
 118 operating system.
 119 The following is the general format for \f[I]path\f[R]:
 120 .RS
 121 .IP \[bu] 2
 122 \f[B]Oracle Solaris, Linux, and OS X:\f[R]
 123 \f[CB]\&.:\f[R]\f[I]your_path\f[R], for example:
 124 \f[CB]\&.:/usr/local/java/classes\f[R]
 125 .IP \[bu] 2
 126 \f[B]Windows:\f[R] \f[CB]\&.;\f[R]\f[I]your_path\f[R], for example:
 127 \f[CB]\&.;/usr/local/java/classes\f[R]
 128 .RE
 129 .TP
 130 .B \f[CB]\-d\f[R] \f[I]directory\f[R]
 131 Specifies the root destination directory for the generated class
 132 hierarchy.
 133 You can use this option to specify a destination directory for the stub,
 134 skeleton, and tie files.
 135 .RS
 136 .IP \[bu] 2
 137 \f[B]Oracle Solaris, Linux, and OS X:\f[R] For example, the following
 138 command places the stub and skeleton classes derived from
 139 \f[CB]MyClass\f[R] into the directory \f[CB]/java/classes/exampleclass\f[R]:
 140 .RS 2
 141 .RS
 142 .PP
 143 \f[CB]rmic\ \-d\ /java/classes\ exampleclass.MyClass\f[R]
 144 .RE
 145 .RE
 146 .IP \[bu] 2
 147 \f[B]Windows:\f[R] For example, the following command places the stub and
 148 skeleton classes derived from \f[CB]MyClass\f[R] into the directory
 149 \f[CB]C:\\java\\classes\\exampleclass\f[R]:
 150 .RS 2
 151 .RS
 152 .PP
 153 \f[CB]rmic\ \-d\ C:\\java\\classes\ exampleclass.MyClass\f[R]
 154 .RE
 155 .RE
 156 .PP
 157 If the \f[CB]\-d\f[R] option isn\[aq]t specified, then the default
 158 behavior is as though \f[CB]\-d\f[R] was specified.
 159 The package hierarchy of the target class is created in the current
 160 directory, and stub/tie/skeleton files are placed within it.
 161 .RE
 162 .TP
 163 .B \f[CB]\-g\f[R]
 164 Enables the generation of all debugging information, including local
 165 variables.
 166 By default, only line number information is generated.
 167 .RS
 168 .RE
 169 .TP
 170 .B \f[CB]\-J\f[R]\f[I]argument\f[R]
 171 Used with any Java command, the \f[CB]\-J\f[R] option passes the
 172 \f[I]argument\f[R] that follows it (no spaces between the \f[CB]\-J\f[R]
 173 and the argument) to the Java interpreter.
 174 .RS
 175 .RE
 176 .TP
 177 .B \f[CB]\-keep\f[R] or \f[CB]\-keepgenerated\f[R]
 178 Retains the generated \f[CB]\&.java\f[R] source files for the stub,
 179 skeleton, and tie classes and writes them to the same directory as
 180 the\f[CB]\&.class\f[R] files.
 181 .RS
 182 .RE
 183 .TP
 184 .B \f[CB]\-nowarn\f[R]
 185 Turns off warnings.
 186 When the \f[CB]\-nowarn\f[R] options is used, the compiler doesn\[aq]t
 187 print warnings.
 188 .RS
 189 .RE
 190 .TP
 191 .B \f[CB]\-nowrite\f[R]
 192 Doesn\[aq]t write compiled classes to the file system.
 193 .RS
 194 .RE
 195 .TP
 196 .B \f[CB]\-vcompat\f[R] (deprecated)
 197 Generates stub and skeleton classes that are compatible with both the
 198 1.1 and 1.2 JRMP stub protocol versions.
 199 This option was the default in releases before 5.0.
 200 The generated stub classes use the 1.1 stub protocol version when loaded
 201 in a JDK 1.1 virtual machine and use the 1.2 stub protocol version when
 202 loaded into a 1.2 (or later) virtual machine.
 203 The generated skeleton classes support both 1.1 and 1.2 stub protocol
 204 versions.
 205 The generated classes are relatively large to support both modes of
 206 operation.
 207 .RS
 208 .PP
 209 \f[B]Note:\f[R]
 210 .PP
 211 This option has been deprecated.
 212 See \f[B]Description\f[R].
 213 .RE
 214 .TP
 215 .B \f[CB]\-verbose\f[R]
 216 Causes the compiler and linker to print messages about what classes are
 217 being compiled and what class files are being loaded.
 218 .RS
 219 .RE
 220 .TP
 221 .B \f[CB]\-v1.1\f[R] (deprecated)
 222 Generates stub and skeleton classes for the 1.1 JRMP stub protocol
 223 version only.
 224 The \f[CB]\-v1.1\f[R] option is useful only for generating stub classes
 225 that are serialization\-compatible with existing, statically deployed
 226 stub classes generated by the \f[CB]rmic\f[R] command from JDK 1.1 that
 227 can\[aq]t be upgraded (and dynamic class loading isn\[aq]t being used).
 228 .RS
 229 .PP
 230 \f[B]Note:\f[R]
 231 .PP
 232 This option has been deprecated.
 233 See \f[B]Description\f[R].
 234 .RE
 235 .TP
 236 .B \f[CB]\-v1.2\f[R] (deprecated)
 237 (Default) Generates stub classes for the 1.2 JRMP stub protocol version
 238 only.
 239 No skeleton classes are generated because skeleton classes aren\[aq]t
 240 used with the 1.2 stub protocol version.
 241 The generated stub classes don\[aq]t work when they\[aq]re loaded into a
 242 JDK 1.1 virtual machine.
 243 .RS
 244 .PP
 245 \f[B]Note:\f[R]
 246 .PP
 247 This option has been deprecated.
 248 See \f[B]Description\f[R].
 249 .RE
 250 .SH ENVIRONMENT VARIABLES
 251 .TP
 252 .B \f[CB]CLASSPATH\f[R]
 253 Used to provide the system a path to user\-defined classes.
 254 .RS
 255 .IP \[bu] 2
 256 \f[B]Oracle Solaris, Linux, and OS X:\f[R] Directories are separated by
 257 colons, for example: \f[CB]\&.:/usr/local/java/classes\f[R].
 258 .IP \[bu] 2
 259 \f[B]Windows:\f[R] Directories are separated by colons, for example:
 260 \f[CB]\&.;C:\\usr\\local\\java\\classes\f[R].
 261 .RE