OSDN Git Service

Add linux.x86 linux.x86_64 target
[pizza-ipa-oss/jre.git] / features / jp.pizzafactory.com.sun.jre / rootfiles.linux.x86 / jre / man / man1 / java.1
1 ." Copyright (c) 1994, 2010, Oracle and/or its affiliates. All rights reserved. 
2 ."
3 .TH java 1 "06 Apr 2010"
4 ." Generated from HTML by html2man (author: Eric Armstrong)
5
6 .LP
7 .SH "Name"
8 java \- the Java application launcher
9 .LP
10 .SH "SYNOPSIS"
11 .LP
12 .nf
13 \f3
14 .fl
15     \fP\f3java\fP [ options ] class [ argument ... ]
16 .fl
17     \f3java\fP [ options ] \f3\-jar\fP file.jar [ argument ... ]
18 .fl
19 .fi
20
21 .LP
22 .RS 3
23
24 .LP
25 .RS 3
26 .TP 3
27 options 
28 Command\-line options. 
29 .TP 3
30 class 
31 Name of the class to be invoked. 
32 .TP 3
33 file.jar 
34 Name of the jar file to be invoked. Used only with \f2\-jar\fP. 
35 .TP 3
36 argument 
37 Argument passed to the \f3main\fP function. 
38 .RE
39
40 .LP
41 .RE
42 .SH "DESCRIPTION"
43 .LP
44
45 .LP
46 .LP
47 The \f3java\fP tool launches a Java application. It does this by starting a Java runtime environment, loading a specified class, and invoking that class's \f3main\fP method.
48 .LP
49 .LP
50 The method must be declared public and static, it must not return any value, and it must accept a \f2String\fP array as a parameter. The method declaration must look like the following:
51 .LP
52 .nf
53 \f3
54 .fl
55     public static void main(String args[])
56 .fl
57 \fP
58 .fi
59
60 .LP
61 .LP
62 By default, the first non\-option argument is the name of the class to be invoked. A fully\-qualified class name should be used. If the \f3\-jar\fP option is specified, the first non\-option argument is the name of a \f3JAR\fP archive containing class and resource files for the application, with the startup class indicated by the \f3Main\-Class\fP manifest header.
63 .LP
64 .LP
65 The Java runtime searches for the startup class, and other classes used, in three sets of locations: the bootstrap class path, the installed extensions, and the user class path.
66 .LP
67 .LP
68 Non\-option arguments after the class name or JAR file name are passed to the \f3main\fP function.
69 .LP
70 .SH "OPTIONS"
71 .LP
72
73 .LP
74 .LP
75 The launcher has a set of standard options that are supported on the current runtime environment and will be supported in future releases. In addition, the current implementations of the virtual machines support a set of non\-standard options that are subject to change in future releases.
76 .LP
77 .SH "Standard Options"
78 .LP
79
80 .LP
81 .RS 3
82 .TP 3
83 \-client 
84 .LP
85 Select the Java HotSpot Client VM. A 64\-bit capable jdk currently ignores this option and instead uses the Java Hotspot Server VM. 
86 .LP
87 For default VM selection, see 
88 .na
89 \f2Server\-Class Machine Detection\fP @
90 .fi
91 http://java.sun.com/javase/6/docs/technotes/guides/vm/server\-class.html  
92 .TP 3
93 \-server 
94 .LP
95 Select the Java HotSpot Server VM. On a 64\-bit capable jdk only the Java Hotspot Server VM is supported so the \-server option is implicit. 
96 .LP
97 For default VM selection, see 
98 .na
99 \f2Server\-Class Machine Detection\fP @
100 .fi
101 http://java.sun.com/javase/6/docs/technotes/guides/vm/server\-class.html  
102 .TP 3
103 \-agentlib:libname[=options] 
104 Load native agent library \f2libname\fP, e.g. 
105 .LP
106 \-agentlib:hprof 
107 .LP
108 \-agentlib:jdwp=help 
109 .LP
110 \-agentlib:hprof=help 
111 .LP
112 For more information, see 
113 .na
114 \f2JVMTI Agent Command Line Options\fP @
115 .fi
116 http://java.sun.com/javase/6/docs/platform/jvmti/jvmti.html#starting.  
117 .TP 3
118 \-agentpath:pathname[=options] 
119 Load a native agent library by full pathname. For more information, see 
120 .na
121 \f2JVMTI Agent Command Line Options\fP @
122 .fi
123 http://java.sun.com/javase/6/docs/platform/jvmti/jvmti.html#starting. 
124 .TP 3
125 \-classpath classpath 
126 .TP 3
127 \-cp classpath 
128 Specify a list of directories, JAR archives, and ZIP archives to search for class files. Class path entries are separated by colons (\f3:\fP). Specifying \f3\-classpath\fP or \f3\-cp\fP overrides any setting of the \f3CLASSPATH\fP environment variable. 
129 .LP
130 If \f3\-classpath\fP and \f3\-cp\fP are not used and \f3CLASSPATH\fP is not set, the user class path consists of the current directory (\f4.\fP).  
131 .LP
132 As a special convenience, a class path element containing a basename of \f2*\fP is considered equivalent to specifying a list of all the files in the directory with the extension \f2.jar\fP or \f2.JAR\fP (a java program cannot tell the difference between the two invocations).
133 .br
134 .br
135 For example, if directory \f2foo\fP contains \f2a.jar\fP and \f2b.JAR\fP, then the class path element \f2foo/*\fP is expanded to a \f2A.jar:b.JAR\fP, except that the order of jar files is unspecified. All jar files in the specified directory, even hidden ones, are included in the list. A classpath entry consisting simply of \f2*\fP expands to a list of all the jar files in the current directory. The \f2CLASSPATH\fP environment variable, where defined, will be similarly expanded. Any classpath wildcard expansion occurs before the Java virtual machine is started \-\- no Java program will ever see unexpanded wildcards except by querying the environment. For example; by invoking \f2System.getenv("CLASSPATH")\fP.  
136 .LP
137 For more information on class paths, see 
138 .na
139 \f2Setting the Class Path\fP @
140 .fi
141 http://java.sun.com/javase/6/docs/technotes/tools/index.html#classpath.  
142 .TP 3
143 \-Dproperty=value 
144 Set a system property value. 
145 .TP 3
146 \-d32 
147 .TP 3
148 \-d64 
149 Request that the program to be run in a 32\-bit or 64\-bit environment, respectively. If the requested environment is not installed or is not supported, an error is reported. 
150 .LP
151 Currently only the Java HotSpot Server VM supports 64\-bit operation, and the "\-server" option is implicit with the use of \-d64. And the "\-client" option is ignored with the use of \-d64. This is subject to change in a future release. 
152 .LP
153 If neither \f3\-d32\fP nor \f3\-d64\fP is specified, the default is to run in a 32\-bit environment, except for 64\-bit only systems. This is subject to change in a future release.  
154 .TP 3
155 \-enableassertions[:<package name>"..." | :<class name> ] 
156 .TP 3
157 \-ea[:<package name>"..." | :<class name> ] 
158 Enable assertions. Assertions are disabled by default. 
159 .LP
160 With no arguments, \f3enableassertions\fP or \f3\-ea\fP enables assertions. With one argument ending in \f2"..."\fP, the switch enables assertions in the specified package and any subpackages. If the argument is simply \f2"..."\fP, the switch enables assertions in the unnamed package in the current working directory. With one argument not ending in \f2"..."\fP, the switch enables assertions in the specified class. 
161 .LP
162 If a single command line contains multiple instances of these switches, they are processed in order before loading any classes. So, for example, to run a program with assertions enabled only in package \f2com.wombat.fruitbat\fP (and any subpackages), the following command could be used: 
163 .nf
164 \f3
165 .fl
166 java \-ea:com.wombat.fruitbat... <Main Class>
167 .fl
168 \fP
169 .fi
170 .LP
171 The \f3\-enableassertions\fP and \f3\-ea\fP switches apply to \f2all\fP class loaders and to system classes (which do not have a class loader). There is one exception to this rule: in their no\-argument form, the switches do \f2not\fP apply to system. This makes it easy to turn on asserts in all classes except for system classes. A separate switch is provided to enable asserts in all system classes; see \f3\-enablesystemassertions\fP below.  
172 .TP 3
173 \-disableassertions[:<package name>"..." | :<class name> ] 
174 .TP 3
175 \-da[:<package name>"..." | :<class name> ] 
176 Disable assertions. This is the default. 
177 .LP
178 With no arguments, \f3disableassertions\fP or \f3\-da\fP disables assertions. With one argument ending in \f2"..."\fP, the switch disables assertions in the specified package and any subpackages. If the argument is simply \f2"..."\fP, the switch disables assertions in the unnamed package in the current working directory. With one argument not ending in \f2"..."\fP, the switch disables assertions in the specified class. 
179 .LP
180 To run a program with assertions enabled in package \f2com.wombat.fruitbat\fP but disabled in class \f2com.wombat.fruitbat.Brickbat\fP, the following command could be used: 
181 .nf
182 \f3
183 .fl
184 java \-ea:com.wombat.fruitbat... \-da:com.wombat.fruitbat.Brickbat <Main Class>
185 .fl
186 \fP
187 .fi
188 .LP
189 The \f3\-disableassertions\fP and \f3\-da\fP switches apply to \f2all\fP class loaders and to system classes (which do not have a class loader). There is one exception to this rule: in their no\-argument form, the switches do \f2not\fP apply to system. This makes it easy to turn on asserts in all classes except for system classes. A separate switch is provided to enable asserts in all system classes; see \f3\-disablesystemassertions\fP below.  
190 .TP 3
191 \-enablesystemassertions 
192 .TP 3
193 \-esa 
194 Enable asserts in all system classes (sets the \f2default assertion status\fP for system classes to \f2true\fP). 
195 .TP 3
196 \-disablesystemassertions 
197 .TP 3
198 \-dsa 
199 Disables asserts in all system classes. 
200 .LP
201 .TP 3
202 \-jar 
203 Execute a program encapsulated in a JAR file. The first argument is the name of a JAR file instead of a startup class name. In order for this option to work, the manifest of the JAR file must contain a line of the form \f3Main\-Class: \fP\f4classname\fP. Here, \f2classname\fP identifies the class having the \f2public\ static\ void\ main(String[]\ args)\fP method that serves as your application's starting point. See the jar(1) and the Jar trail of the 
204 .na
205 \f2Java Tutorial\fP @
206 .fi
207 http://java.sun.com/docs/books/tutorial/jar for information about working with Jar files and Jar\-file manifests. 
208 .LP
209 When you use this option, the JAR file is the source of all user classes, and other user class path settings are ignored. 
210 .LP
211 Note that JAR files that can be run with the "java \-jar" option can have their execute permissions set so they can be run without using "java \-jar". Refer to 
212 .na
213 \f2Java Archive (JAR) Files\fP @
214 .fi
215 http://java.sun.com/javase/6/docs/technotes/guides/jar/index.html.  
216 .TP 3
217 \-javaagent:jarpath[=options] 
218 Load a Java programming language agent, see 
219 .na
220 \f2java.lang.instrument\fP @
221 .fi
222 http://java.sun.com/javase/6/docs/api/java/lang/instrument/package\-summary.html. 
223 .TP 3
224 \-verbose 
225 .TP 3
226 \-verbose:class 
227 Display information about each class loaded. 
228 .TP 3
229 \-verbose:gc 
230 Report on each garbage collection event. 
231 .TP 3
232 \-verbose:jni 
233 Report information about use of native methods and other Java Native Interface activity. 
234 .TP 3
235 \-version 
236 Display version information and exit. 
237 .TP 3
238 \-version:release 
239 Specifies that the version specified by \f2release\fP is required by the class or jar file specified on the command line. If the version of the java command invoked does not meet this specification and an appropriate implementation is found on the system, the appropriate implementation will be used. 
240 .LP
241 \f2release\fP not only can specify an exact version, but can also specify a list of versions called a version string. A version string is an ordered list of version ranges separated by spaces. A version range is either a version\-id, a version\-id followed by a star (*), a version\-id followed by a plus sign (+) , or two version\-ranges combined using an ampersand (&). The star means prefix match, the plus sign means this version or greater, and the ampersand means the logical anding of the two version\-ranges. For example: 
242 .nf
243 \f3
244 .fl
245 \-version:"1.5.0_04 1.5*&1.5.1_02+"
246 .fl
247 \fP
248 .fi
249 The meaning of the above is that the class or jar file requires either version 1.5.0_02, or a version with 1.5 as a version\-id prefix and that is not less than 1.5.1_02. The exact syntax and definition of version strings may be found in Appendix A of the Java Network Launching Protocol & API Specification (JSR\-56). 
250 .LP
251 For jar files, the usual preference is to specify version requirements in the jar file manifest rather than on the command line. 
252 .LP
253 See the following NOTES section for important policy information on the use of this option.  
254 .TP 3
255 \-showversion 
256 Display version information and continue. 
257 .TP 3
258 \-? 
259 .TP 3
260 \-help 
261 Display usage information and exit. 
262 .TP 3
263 \-X 
264 Display information about non\-standard options and exit. 
265 .RE
266
267 .LP
268 .SS 
269 Non\-Standard Options
270 .LP
271 .RS 3
272
273 .LP
274 .RS 3
275 .TP 3
276 \-Xint 
277 Operate in interpreted\-only mode. Compilation to native code is disabled, and all bytecodes are executed by the interpreter. The performance benefits offered by the Java HotSpot VMs' adaptive compiler will not be present in this mode. 
278 .TP 3
279 \-Xbatch 
280 Disable background compilation. Normally the VM will compile the method as a background task, running the method in interpreter mode until the background compilation is finished. The \f2\-Xbatch\fP flag disables background compilation so that compilation of all methods proceeds as a foreground task until completed. 
281 .TP 3
282 \-Xbootclasspath:bootclasspath 
283 Specify a colon\-separated list of directories, JAR archives, and ZIP archives to search for boot class files. These are used in place of the boot class files included in the Java 2 SDK. \f2Note: Applications that use this option for the purpose of overriding a class in rt.jar should not be deployed as doing so would contravene the Java 2 Runtime Environment binary code license.\fP 
284 .TP 3
285 \-Xbootclasspath/a:path 
286 Specify a colon\-separated path of directires, JAR archives, and ZIP archives to append to the default bootstrap class path. 
287 .TP 3
288 \-Xbootclasspath/p:path 
289 Specify a colon\-separated path of directires, JAR archives, and ZIP archives to prepend in front of the default bootstrap class path. \f2Note: Applications that use this option for the purpose of overriding a class in rt.jar should not be deployed as doing so would contravene the Java 2 Runtime Environment binary code license.\fP 
290 .TP 3
291 \-Xcheck:jni 
292 Perform additional checks for Java Native Interface (JNI) functions. Specifically, the Java Virtual Machine validates the parameters passed to the JNI function as well as the runtime environment data before processing the JNI request. Any invalid data encountered indicates a problem in the native code, and the Java Virtual Machine will terminate with a fatal error in such cases. Expect a performance degradation when this option is used. 
293 .TP 3
294 \-Xfuture 
295 Perform strict class\-file format checks. For purposes of backwards compatibility, the default format checks performed by the Java 2 SDK's virtual machine are no stricter than the checks performed by 1.1.x versions of the JDK software. The \f3\-Xfuture\fP flag turns on stricter class\-file format checks that enforce closer conformance to the class\-file format specification. Developers are encouraged to use this flag when developing new code because the stricter checks will become the default in future releases of the Java application launcher. 
296 .TP 3
297 \-Xnoclassgc 
298 Disable class garbage collection. Use of this option will prevent memory recovery from loaded classes thus increasing overall memory usage. This could cause OutOfMemoryError to be thrown in some applications. 
299 .TP 3
300 \-Xincgc 
301 Enable the incremental garbage collector. The incremental garbage collector, which is off by default, will reduce the occasional long garbage\-collection pauses during program execution. The incremental garbage collector will at times execute concurrently with the program and during such times will reduce the processor capacity available to the program. 
302 .TP 3
303 \-Xloggc:file 
304 Report on each garbage collection event, as with \-verbose:gc, but log this data to \f2file\fP. In addition to the information \f2\-verbose:gc\fP gives, each reported event will be preceeded by the time (in seconds) since the first garbage\-collection event. 
305 .LP
306 Always use a local file system for storage of this file to avoid stalling the JVM due to network latency. The file may be truncated in the case of a full file system and logging will continue on the truncated file. This option overrides \f2\-verbose:gc\fP if both are given on the command line.  
307 .LP
308 .TP 3
309 \-Xmsn 
310 Specify the initial size, in bytes, of the memory allocation pool. This value must be a multiple of 1024 greater than 1MB. Append the letter \f2k\fP or \f2K\fP to indicate kilobytes, or \f2m\fP or \f2M\fP to indicate megabytes. The default value is chosen at runtime based on system configuration. For more information, see HotSpot Ergonomics
311 .br
312 Examples: 
313 .RS 3
314
315 .LP
316 .nf
317 \f3
318 .fl
319        \-Xms6291456
320 .fl
321        \-Xms6144k
322 .fl
323        \-Xms6m
324 .fl
325        
326 .fl
327 \fP
328 .fi
329 .RE
330 .TP 3
331 \-Xmxn 
332 Specify the maximum size, in bytes, of the memory allocation pool. This value must a multiple of 1024 greater than 2MB. Append the letter \f2k\fP or \f2K\fP to indicate kilobytes, or \f2m\fP or \f2M\fP to indicate megabytes. The default value is chosen at runtime based on system configuration. For more information, see HotSpot Ergonomics
333 .br
334 Examples: 
335 .RS 3
336
337 .LP
338 .nf
339 \f3
340 .fl
341        \-Xmx83886080
342 .fl
343        \-Xmx81920k
344 .fl
345        \-Xmx80m
346 .fl
347        
348 .fl
349 \fP
350 .fi
351 .RE
352 On Solaris 7 and Solaris 8 SPARC platforms, the upper limit for this value is approximately 4000m minus overhead amounts. On Solaris 2.6 and x86 platforms, the upper limit is approximately 2000m minus overhead amounts. On Linux platforms, the upper limit is approximately 2000m minus overhead amounts. 
353 .TP 3
354 \-Xprof 
355 Profiles the running program, and sends profiling data to standard output. This option is provided as a utility that is useful in program development and is not intended to be used in production systems.  
356 .LP
357 .TP 3
358 \-Xrs 
359 Reduces use of operating\-system signals by the Java virtual machine (JVM). 
360 .LP
361 In a previous release, the Shutdown Hooks facility was added to allow orderly shutdown of a Java application. The intent was to allow user cleanup code (such as closing database connections) to run at shutdown, even if the JVM terminates abruptly. 
362 .LP
363 Sun's JVM catches signals to implement shutdown hooks for abnormal JVM termination. The JVM uses SIGHUP, SIGINT, and SIGTERM to initiate the running of shutdown hooks. 
364 .LP
365 The JVM uses a similar mechanism to implement the pre\-1.2 feature of dumping thread stacks for debugging purposes. Sun's JVM uses SIGQUIT to perform thread dumps. 
366 .LP
367 Applications embedding the JVM frequently need to trap signals like SIGINT or SIGTERM, which can lead to interference with the JVM's own signal handlers. The \f3\-Xrs\fP command\-line option is available to address this issue. When \f3\-Xrs\fP is used on Sun's JVM, the signal masks for SIGINT, SIGTERM, SIGHUP, and SIGQUIT are not changed by the JVM, and signal handlers for these signals are not installed. 
368 .LP
369 There are two consequences of specifying \f3\-Xrs\fP: 
370 .RS 3
371 .TP 2
372 o
373 SIGQUIT thread dumps are not available. 
374 .TP 2
375 o
376 User code is responsible for causing shutdown hooks to run, for example by calling System.exit() when the JVM is to be terminated. 
377 .RE
378 .TP 3
379 \-Xssn 
380 Set thread stack size. 
381 .TP 3
382 \-XX:+UseAltSigs 
383 The VM uses \f2SIGUSR1\fP and \f2SIGUSR2\fP by default, which can sometimes conflict with applications that signal\-chain \f2SIGUSR1\fP and \f2SIGUSR2\fP. The \f2\-XX:+UseAltSigs\fP option will cause the VM to use signals other than \f2SIGUSR1\fP and \f2SIGUSR2\fP as the default. 
384 .RE
385
386 .LP
387 .RE
388 .SH "NOTES"
389 .LP
390
391 .LP
392 The \f3\-version:\fP\f2release\fP command line option places no restrictions on the complexity of the release specification. However, only a restricted subset of the possible release specifications represent sound policy and only these are fully supported. These policies are: 
393 .RS 3
394 .TP 3
395 1.
396 Any version, represented by not using this option. 
397 .TP 3
398 2.
399 Any version greater than an arbitrarily precise version\-id. For example: 
400 .nf
401 \f3
402 .fl
403 "1.5.0_03+"
404 .fl
405 \fP
406 .fi
407 .LP
408 Would utilize any version greater than 1.5.0_03. This is useful for a case where an interface was introduced (or a bug fixed) in the release specified.  
409 .TP 3
410 3.
411 A version greater than an arbitrarily precise version\-id, bounded by the upper bound of that release family. For example: 
412 .nf
413 \f3
414 .fl
415 "1.5.0_03+&1.5*"
416 .fl
417 \fP
418 .fi
419 .TP 3
420 4.
421 "Or" expressions of items 2. or 3. above. For example: 
422 .nf
423 \f3
424 .fl
425 "1.4.2_05+&1.4* 1.5+"
426 .fl
427 \fP
428 .fi
429 Similar to item 2. this is useful when a change was introduced in a release (1.5) but also made available in updates to previous releases. 
430 .RE
431
432 .LP
433 .SH "SEE ALSO"
434 .LP
435
436 .LP
437 .RS 3
438 .TP 2
439 o
440 javac(1) 
441 .TP 2
442 o
443 jdb(1) 
444 .TP 2
445 o
446 javah(1) 
447 .TP 2
448 o
449 jar(1) 
450 .TP 2
451 o
452 .na
453 \f2The Java Extensions Framework\fP @
454 .fi
455 http://java.sun.com/javase/6/docs/technotes/guides/extensions/index.html 
456 .TP 2
457 o
458 .na
459 \f2Security Features\fP @
460 .fi
461 http://java.sun.com/javase/6/docs/technotes/guides/security/index.html. 
462 .TP 2
463 o
464 .na
465 \f2HotSpot VM Specific Options\fP @
466 .fi
467 http://java.sun.com/docs/hotspot/VMOptions.html. 
468 .RE
469
470 .LP
471