stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge

Browse Source
This commit is contained in:
Michael Fang 2011-05-11 12:55:34 -07:00
commit b1e12ab2ec
80 changed files with 5998 additions and 9128 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
jdk/src/linux/doc/man/appletviewer.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1995, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1995, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,43 +19,33 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH appletviewer 1 "02 Jun 2010"
.TH appletviewer 1 "10 May 2011"
.LP
.SH "Name"
appletviewer \- The Java Applet Viewer.
.LP
.RS 3
.LP
.LP
The \f3appletviewer\fP command allows you to run applets outside of a web browser.
.LP
.RE
.SH "SYNOPSIS"
.LP
.LP
.LP
\f4appletviewer\fP \f2[\fP \f2options\fP \f2] \fP\f2urls\fP ...
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f3appletviewer\fP command connects to the documents or resources designated by \f2urls\fP and displays each applet referenced by the documents in its own window. Note: if the documents referred to by \f2urls\fP do not reference any applets with the \f2OBJECT\fP, \f2EMBED\fP, or \f2APPLET\fP tag, then \f3appletviewer\fP does nothing. For details on the HTML tags that \f3appletviewer\fP supports, see
.na
\f2AppletViewer Tags\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/tools/appletviewertags.html.
http://download.oracle.com/javase/7/docs/technotes/tools/appletviewertags.html.
.LP
.LP
\f3Note:\fP The \f3appletviewer\fP requires encoded URLs according to the escaping mechanism defined in RFC2396. Only encoded URLs are supported. However, file names must be unencoded, as specified in RFC2396.
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3

51
jdk/src/linux/doc/man/apt.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,7 +19,7 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH apt 1 "02 Jun 2010"
.TH apt 1 "10 May 2011"
.LP
.SH "NAME"
@ -50,21 +50,17 @@ One or more files that list source files or other options
.SH "DESCRIPTION"
.LP
.LP
The tool \f2apt\fP, annotation processing tool, includes a set of new reflective APIs and supporting infrastructure to process program annotations. The \f2apt\fP reflective APIs provide a build\-time, source\-based, read\-only view of program structure. These reflective APIs are designed to cleanly model the Java(TM) programming language's type system after the addition of generics. First, \f2apt\fP runs annotation processors that can produce new source code and other files. Next, \f2apt\fP can cause compilation of both original and generated source files, easing development. The reflective APIs and other APIs used to interact with the tool are subpackages of \f2com.sun.mirror\fP.
\f3Note\fP: The \f2apt\fP tool and its associated API contained in the package \f2com.sun.mirror\fP have been deprecated since JDK 7 and are planned to be removed in the next major JDK release. Use the options available in the \f2javac(1)\fP tool and the APIs contained in the packages \f2javax.annotation.processing\fP and \f2javax.lang.model\fP to process annotations.
.LP
.LP
The tool \f2apt\fP, annotation processing tool, includes reflective APIs and supporting infrastructure to process program annotations. The \f2apt\fP reflective APIs provide a build\-time, source\-based, read\-only view of program structure. These reflective APIs are designed to cleanly model the Java(TM) programming language's type system after the addition of generics. First, \f2apt\fP runs annotation processors that can produce new source code and other files. Next, \f2apt\fP can cause compilation of both original and generated source files, easing development. The reflective APIs and other APIs used to interact with the tool are subpackages of \f2com.sun.mirror\fP.
.LP
.LP
A fuller discussion of how the tool operates as well as instructions for developing with \f2apt\fP are in
.na
\f4Getting Started with \fP\f4apt\fP. @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/apt/GettingStarted.html
.LP
.RS 3
.TP 3
Note:
\f2The functionality of \fP\f2apt\fP has been subsumed by the annotation\-processing infrastructure that is now part of the \f2javac(1)\fP tool and standardized for use by all Java compilers. This new infrastructure relies on the language model and annotation\-processing APIs that are now part of the Java Platform. It is recommended that new annotation processor development be based on the new APIs and the \f2javac\fP tool.
.RE
http://download.oracle.com/javase/7/docs/technotes/guides/apt/GettingStarted.html
.LP
.SH "OPTIONS"
.LP
@ -90,6 +86,12 @@ Specify where to find annotation processor factories; if this option is used, th
.TP 3
\-factory classname
Name of annotation processor factory to use; bypasses default discovery process
.TP 3
\-version
Print version information.
.TP 3
\-X
Display information about non\-standard options.
.RE
.LP
@ -109,10 +111,35 @@ Specify where to find user class files and annotation processor factories. If \f
.LP
Consult the javac(1) man page for information on \f2javac\fP options.
.LP
.SS
Non\-Standard Options
.LP
.RS 3
.TP 3
\-XListAnnotationTypes
List found annotation types.
.TP 3
\-XListDeclarations
List specified and included declarations.
.TP 3
\-XPrintAptRounds
Print information about initial and recursive \f2apt\fP rounds.
.TP 3
\-XPrintFactoryInfo
Print information about which annotations a factory is asked to process.
.TP 3
\-XclassesAsDecls
Treat both class and source files as declarations to process.
.RE
.LP
.LP
\f3Note\fP: Because these options are non\-standard, they are subject to change without notice.
.LP
.SH "NOTES"
.LP
.LP
The functionality of \f2apt\fP has been subsumed by the standard annotation\-processing infrastructure now offered by \f2javac\fP. Support for \f2apt\fP and its associated APIs may be discontinued in some future JDK release.
The \f2apt\fP tool and its associated API contained in the package \f2com.sun.mirror\fP have been deprecated since JDK 7 and are planned to be removed in the next major JDK release. Use the options available in the \f2javac(1)\fP tool and the APIs contained in the packages \f2javax.annotation.processing\fP and \f2javax.lang.model\fP to process annotations.
.LP
.SH "SEE ALSO"
.LP

16
jdk/src/linux/doc/man/extcheck.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1998, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,22 +19,16 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH extcheck 1 "02 Jun 2010"
.TH extcheck 1 "10 May 2011"
.LP
.SH "Name"
extcheck \- A utility to detect jar conflicts
.LP
.RS 3
.LP
.LP
\f3extcheck\fP detects version conflicts between a target jar file and currently installed extension jar files.
.LP
.RE
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -46,8 +40,6 @@ extcheck [ \-verbose ] targetfile.jar
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f3extcheck\fP utility checks a specified Jar file for title and version conflicts with any extensions installed in the Java(TM) SDK. Before installing an extension, you can use this utility to see if the same or a more recent version of the extension is already installed.
@ -62,8 +54,6 @@ If no conflict is detected, the return code is \f20\fP.
If the manifest of any jar file in the extensions directory has the same \f2Specification\-title\fP and the same or a newer \f2Specification\-version\fP number, a non\-zero error code is returned. A non\-zero error code is also returned if \f2targetfile.jar\fP does not have the \f2Specification\-title\fP or \f2Specification\-version\fP attributes in its manifest.
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
@ -76,8 +66,6 @@ Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the
.LP
.SH "SEE ALSO"
.LP
.LP
.LP
jar(1)

527
jdk/src/linux/doc/man/idlj.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2001, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,20 +19,14 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH idlj 1 "02 Jun 2010"
.TH idlj 1 "10 May 2011"
.LP
.SH "Name"
idlj \- The IDL\-to\-Java Compiler
.LP
.RS 3
.LP
\f3idlj\fP generates Java bindings from a given IDL file.
.RE
\f3idlj\fP generates Java bindings from a given IDL file.
.SH "Synopsis"
.LP
.LP
.nf
\f3
@ -48,28 +42,62 @@ where \f2idl\-file\fP is the name of a file containing Interface Definition Lang
.LP
.SH "Description"
.LP
.LP
The IDL\-to\-Java Compiler generates the Java bindings for a given IDL file.\ For binding details, see the
.na
\f2OMG IDL to Java Language Language Mapping Specification\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/idl/mapping/jidlMapping.html. Some previous releases of the IDL\-to\-Java compiler were named \f2idltojava\fP.
http://download.oracle.com/javase/7/docs/technotes/guides/idl/mapping/jidlMapping.html. Some previous releases of the IDL\-to\-Java compiler were named \f2idltojava\fP.
.LP
.SS
Emitting Client and Server Bindings
.LP
.RS 3
.LP
To generate Java bindings for an IDL file named My.idl:
.LP
.nf
\f3
.fl
idlj My.idl
.fl
\fP
.fi
.LP
To generate Java bindings for an IDL file named My.idl: \f2idlj My.idl\fP
.LP
This generates the client\-side bindings and is equivalent to: \f2idlj \fP\f4\-fclient\fP\f2 My.idl\fP
This generates the client\-side bindings and is equivalent to:
.LP
The client\-side bindings do not include the server\-side skeleton. If you want to generate the server\-side bindings for the interfaces: \f2idlj \fP\f4\-fserver\fP\f2 My.idl\fP
.nf
\f3
.fl
idlj \fP\f3\-fclient\fP My.idl
.fl
.fi
.LP
Server\-side bindings include the client\-side bindings plus the skeleton, all of which are \f2POA\fP (that is, Inheritance Model) classes. If you want to generate both client and server\-side bindings, use one of the following (equivalent) commands: \f2idlj \fP\f4\-fclient \-fserver\fP\f2 My.idl\fP
.br
\f2idlj \fP\f4\-fall\fP\f2 My.idl\fP
.LP
The client\-side bindings do not include the server\-side skeleton. If you want to generate the server\-side bindings for the interfaces:
.LP
.nf
\f3
.fl
idlj \fP\f3\-fserver\fP My.idl
.fl
.fi
.LP
.LP
Server\-side bindings include the client\-side bindings plus the skeleton, all of which are \f2POA\fP (that is, Inheritance Model) classes. If you want to generate both client and server\-side bindings, use one of the following (equivalent) commands:
.LP
.nf
\f3
.fl
idlj \fP\f3\-fclient \-fserver\fP My.idl
.fl
idlj \f3\-fall\fP My.idl
.fl
.fi
.LP
.LP
There are two possible server\-side models: the Inheritance Model and the Tie Delegation Model.
@ -82,31 +110,47 @@ The default server\-side model is the \f2Portable Servant Inheritance Model\fP.
.na
\f2org.omg.PortableServer.Servant\fP @
.fi
http://java.sun.com/javase/6/docs/api/org/omg/PortableServer/Servant.html and implements the \f2InvokeHandler\fP interface and the operations interface associated with the IDL interface the skeleton implements.
http://download.oracle.com/javase/7/docs/api/org/omg/PortableServer/Servant.html and implements the \f2InvokeHandler\fP interface and the operations interface associated with the IDL interface the skeleton implements.
.LP
.LP
The \f2PortableServer\fP module for the
.na
\f2Portable Object Adapter (POA)\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/idl/POA.html 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.
http://download.oracle.com/javase/7/docs/technotes/guides/idl/POA.html 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.
.LP
.LP
Another option for the Inheritance Model is to use the \f2\-oldImplBase\fP flag in order to generate server\-side bindings that are compatible with versions of the Java programming language prior to J2SE 1.4. Note that using the \f2\-oldImplBase\fP flag is non\-standard: these APIs are being deprecated. You would use this flag ONLY for compatibility with existing servers written in J2SE 1.3. In that case, you would need to modify an existing MAKEFILE to add the \f2\-oldImplBase\fP flag to the \f2idlj\fP compiler, otherwise POA\-based server\-side mappings will be generated. To generate server\-side bindings that are backwards compatible:
.LP
\f2idlj \fP\f4\-fclient \-fserver\fP\f2 \fP\f4\-oldImplBase\fP\f2 My.idl\fP
.br
\f2idlj \fP\f4\-fall\fP\f2 \fP\f4\-oldImplBase\fP\f2 My.idl\fP
.nf
\f3
.fl
idlj \fP\f3\-fclient \-fserver\fP \f3\-oldImplBase\fP My.idl
.fl
idlj \f3\-fall\fP \f3\-oldImplBase\fP My.idl
.fl
.fi
.LP
.LP
Given an interface \f2My\fP defined in \f2My.idl\fP, the file \f2_MyImplBase.java\fP is generated. You must provide the implementation for \f2My\fP and it must inherit from \f2_MyImplBase\fP.
.LP
Given an interface \f2My\fP defined in \f2My.idl\fP, the file \f2_MyImplBase.java\fP is generated. You must provide the implementation for \f2My\fP and it must inherit from \f2_MyImplBase\fP.
.LP
The other server\-side model is called the Tie Model. This is a delegation model. Because it is not possible to generate ties and skeletons at the same time, they must be generated separately. The following commands generate the bindings for the Tie Model:
.LP
\f2idlj \fP\f4\-fall\fP\f2 My.idl\fP
.br
\f2idlj \fP\f4\-fallTIE\fP\f2 My.idl\fP
.nf
\f3
.fl
idlj \fP\f3\-fall\fP My.idl
.fl
idlj \f3\-fallTIE\fP My.idl
.fl
.fi
.LP
.LP
For the interface \f2My\fP, the second command generates \f2MyPOATie.java\fP. The constructor to \f2MyPOATie\fP takes a \f2delegate\fP. In this example, using the default POA model, the constructor also needs a \f2poa\fP. You must provide the implementation for \f2delegate\fP, but it does not have to inherit from any other class, only the interface \f2MyOperations\fP. But to use it with the ORB, you must wrap your implementation within \f2MyPOATie\fP. For instance:
.LP
For the interface \f2My\fP, the second command generates \f2MyPOATie.java\fP. The constructor to \f2MyPOATie\fP takes a \f2delegate\fP. In this example, using the default POA model, the constructor also needs a \f2poa\fP. You must provide the implementation for \f2delegate\fP, but it does not have to inherit from any other class, only the interface \f2MyOperations\fP. But to use it with the ORB, you must wrap your implementation within \f2MyPOATie\fP. For instance:
.nf
\f3
.fl
@ -144,13 +188,21 @@ For the interface \f2My\fP, the second command generates \f2MyPOATie.java\fP. Th
.fi
.LP
You might want to use the Tie model instead of the typical Inheritance model if your implementation must inherit from some other implementation. Java allows any number of interface inheritance, but there is only one slot for class inheritance. If you use the inheritance model, that slot is used up . By using the Tie Model, that slot is freed up for your own use. The drawback is that it introduces a level of indirection: one extra method call occurs when invoking a method.
.LP
You might want to use the Tie model instead of the typical Inheritance model if your implementation must inherit from some other implementation. Java allows any number of interface inheritance, but there is only one slot for class inheritance. If you use the inheritance model, that slot is used up . By using the Tie Model, that slot is freed up for your own use. The drawback is that it introduces a level of indirection: one extra method call occurs when invoking a method.
.LP
.LP
To generate server\-side, Tie model bindings that are compatible with versions of the IDL to Java language mapping in versions prior to J2SE 1.4.
.LP
\f2idlj \fP\f4\-oldImplBase\fP\f2 \fP\f4\-fall\fP\f2 My.idl\fP
.br
\f2idlj \fP\f4\-oldImplBase\fP\f2 \fP\f4\-fallTIE\fP\f2 My.idl\fP
.nf
\f3
.fl
idlj \fP\f3\-oldImplBase\fP \f3\-fall\fP My.idl
.fl
idlj \f3\-oldImplBase\fP \f3\-fallTIE\fP My.idl
.fl
.fi
.LP
.LP
For the interface \f2My\fP, this will generate \f2My_Tie.java\fP. The constructor to \f2My_Tie\fP takes a \f2impl\fP. You must provide the implementation for \f2impl\fP, but it does not have to inherit from any other class, only the interface \f2HelloOperations\fP. But to use it with the ORB, you must wrap your implementation within \f2My_Tie\fP. For instance:
@ -184,201 +236,383 @@ For the interface \f2My\fP, this will generate \f2My_Tie.java\fP. The constructo
.fi
.LP
.RE
.SS
Specifying Alternate Locations for Emitted Files
.LP
.RS 3
.LP
If you want to direct the emitted files to a directory other than the current directory, invoke the compiler as:
.LP
.nf
\f3
.fl
idlj \fP\f3\-td /altdir\fP My.idl
.fl
.fi
.LP
If you want to direct the emitted files to a directory other than the current directory, invoke the compiler as:
.RS 3
.LP
\f2idlj \fP\f4\-td /altdir\fP\f2 My.idl\fP
.RE
For the interface \f2My\fP, the bindings will be emitted to \f2/altdir/My.java\fP, etc., instead of \f2./My.java\fP.
.RE
.LP
.SS
Specifying Alternate Locations for Include Files
.LP
.RS 3
.LP
If \f2My.idl\fP included another idl file, \f2MyOther.idl\fP, the compiler assumes that \f2MyOther.idl\fP resides in the local directory. If it resides in \f2/includes\fP, for example, then you would invoke the compiler with the following command:
.LP
.nf
\f3
.fl
idlj \fP\f3\-i /includes\fP My.idl
.fl
.fi
.LP
If \f2My.idl\fP included another idl file, \f2MyOther.idl\fP, the compiler assumes that \f2MyOther.idl\fP resides in the local directory. If it resides in \f2/includes\fP, for example, then you would invoke the compiler with the following command: \f2idlj \fP\f4\-i /includes\fP\f2 My.idl\fP
.LP
If \f2My.idl\fP also included \f2Another.idl\fP that resided in \f2/moreIncludes\fP, for example, then you would invoke the compiler with the following command: \f2idlj \fP\f4\-i /includes \-i /moreIncludes\fP\f2 My.idl\fP
If \f2My.idl\fP also included \f2Another.idl\fP that resided in \f2/moreIncludes\fP, for example, then you would invoke the compiler with the following command:
.LP
.nf
\f3
.fl
idlj \fP\f3\-i /includes \-i /moreIncludes\fP My.idl
.fl
.fi
.LP
.LP
Since this form of include can become irritatingly long, another means of indicating to the compiler where to search for included files is provided. This technique is similar to the idea of an environment variable. Create a file named \f2idl.config\fP in a directory that is listed in your CLASSPATH. Inside of \f2idl.config\fP, provide a line with the following form:
.LP
.nf
\f3
.fl
includes=/includes;/moreIncludes
.fl
\fP
.fi
.LP
Since this form of include can become irritatingly long, another means of indicating to the compiler where to search for included files is provided. This technique is similar to the idea of an environment variable. Create a file named \f2idl.config\fP in a directory that is listed in your CLASSPATH. Inside of \f2idl.config\fP, provide a line with the following form: \f2includes=/includes;/moreIncludes\fP
.LP
The compiler will find this file and read in the includes list. Note that in this example the separator character between the two directories is a semicolon (;). This separator character is platform dependent. On the Windows platform, use a semicolon, on the Unix platform, use a colon, etc. For more information on \f2includes\fP, see the
.na
\f2Setting the Classpath\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/tools/index.html#general.
.RE
http://download.oracle.com/javase/7/docs/technotes/tools/index.html#general.
.LP
.SS
Emitting Bindings for Include Files
.LP
.RS 3
.LP
By default, only those interfaces, structs, etc, that are defined in the idl file on the command line have Java bindings generated for them. The types defined in included files are not generated. For example, assume the following two idl files:
.LP
.LP
By default, only those interfaces, structs, etc, that are defined in the idl file on the command line have Java bindings generated for them. The types defined in included files are not generated. For example, assume the following two idl files: \f4My.idl\fP
.LP
\f2#include <MyOther.idl>\fP
.br
\f2interface My\fP
.br
\f2{\fP
.br
\f2};\fP
.br
\f4MyOther.idl\fP
\f4My.idl\fP
.LP
\f2interface MyOther\fP
.br
\f2{\fP
.br
\f2};\fP\
.nf
\f3
.fl
#include <MyOther.idl>
.fl
interface My
.fl
{
.fl
};
.fl
\fP
.fi
.LP
The following command will only generate the java bindings for \f2My\fP: \f2idlj My.idl\fP
.LP
To generate all of the types in \f2My.idl\fP and all of the types in the files that \f2My.idl\fP includes (in this example, \f2MyOther.idl\fP), use the following command: \f2idlj \fP\f4\-emitAll\fP\f2 My.idl\fP
.LP
There is a caveat to the default rule. \f2#include\fP statements which appear at global scope are treated as described. These \f2#include\fP statements can be thought of as import statements. \f2#include\fP statements which appear within some enclosing scope are treated as true \f2#include\fP statements, meaning that the code within the included file is treated as if it appeared in the original file and, therefore, Java bindings are emitted for it. Here is an example: \f4My.idl\fP
\f4MyOther.idl\fP
.LP
\f2#include <MyOther.idl>\fP
.br
\f2interface My\fP
.br
\f2{\fP
.br
\f2\ #include <Embedded.idl>\fP
.br
\f2};\ \fP \f4MyOther.idl\fP
.nf
\f3
.fl
interface MyOther
.fl
{
.fl
};
.fl
\fP
.fi
.LP
\f2interface MyOther\fP
.br
\f2{\fP
.br
\f2};\ \fP \f4Embedded.idl\fP
.LP
\f2enum E {one, two, three};\fP\
.LP
Running the following command: \f2idlj My.idl\fP
The following command will only generate the java bindings for \f2My\fP:
.LP
will generate the following list of Java files: \f2./MyHolder.java\fP
.br
\f2./MyHelper.java\fP
.br
\f2./_MyStub.java\fP
.br
\f2./MyPackage\fP
.br
\f2./MyPackage/EHolder.java\fP
.br
\f2./MyPackage/EHelper.java\fP
.br
\f2./MyPackage/E.java\fP
.br
\f2./My.java\fP
.nf
\f3
.fl
idlj My.idl
.fl
\fP
.fi
.LP
.LP
To generate all of the types in \f2My.idl\fP and all of the types in the files that \f2My.idl\fP includes (in this example, \f2MyOther.idl\fP), use the following command:
.LP
.nf
\f3
.fl
idlj \fP\f3\-emitAll\fP My.idl
.fl
.fi
.LP
.LP
There is a caveat to the default rule. \f2#include\fP statements which appear at global scope are treated as described. These \f2#include\fP statements can be thought of as import statements. \f2#include\fP statements which appear within some enclosing scope are treated as true \f2#include\fP statements, meaning that the code within the included file is treated as if it appeared in the original file and, therefore, Java bindings are emitted for it. Here is an example:
.LP
.LP
.LP
\f4My.idl\fP
.LP
.nf
\f3
.fl
#include <MyOther.idl>
.fl
interface My
.fl
{
.fl
#include <Embedded.idl>
.fl
};
.fl
\fP
.fi
.LP
.LP
.LP
\f4MyOther.idl\fP
.LP
.nf
\f3
.fl
interface MyOther
.fl
{
.fl
};
.fl
\fP
.fi
.LP
.LP
.LP
\f4Embedded.idl\fP
.LP
.nf
\f3
.fl
enum E {one, two, three};
.fl
\fP
.fi
.LP
.LP
.LP
Running the following command:
.LP
.nf
\f3
.fl
idlj My.idl
.fl
\fP
.fi
.LP
.LP
will generate the following list of Java files:
.LP
.nf
\f3
.fl
./MyHolder.java
.fl
./MyHelper.java
.fl
./_MyStub.java
.fl
./MyPackage
.fl
./MyPackage/EHolder.java
.fl
./MyPackage/EHelper.java
.fl
./MyPackage/E.java
.fl
./My.java
.fl
\fP
.fi
.LP
.LP
Notice that \f2MyOther.java\fP was not generated because it is defined in an import\-like \f2#include\fP. But \f2E.java\fP \f2was\fP generated because it was defined in a true \f2#include\fP. Also notice that since \f2Embedded.idl\fP was included within the scope of the interface \f2My\fP, it appears within the scope of \f2My\fP (that is,in \f2MyPackage\fP).
.LP
Notice that \f2MyOther.java\fP was not generated because it is defined in an import\-like \f2#include\fP. But \f2E.java\fP \f2was\fP generated because it was defined in a true \f2#include\fP. Also notice that since \f2Embedded.idl\fP was included within the scope of the interface \f2My\fP, it appears within the scope of \f2My\fP (that is,in \f2MyPackage\fP).
.LP
If the \f2\-emitAll\fP flag had been used in the previous example, then all types in all included files would be emitted.
.LP
.RE
.SS
Inserting Package Prefixes
.LP
.RS 3
.LP
Suppose that you work for a company named ABC that has constructed the following IDL file:
.LP
.LP
Suppose that you work for a company named ABC that has constructed the following IDL file:
.br
\f4Widgets.idl\fP
.LP
\f2module Widgets\fP
.br
\f2{\fP
.br
\f2\ interface W1 {...};\fP
.br
\f2\ interface W2 {...};\fP
.br
\f2};\fP\
\f4Widgets.idl\fP
.LP
Running this file through the IDL\-to\-Java compiler will place the Java bindings for \f2W1\fP and \f2W2\fP within the package \f2Widgets\fP. But there is an industry convention that states that a company's packages should reside within a package named \f2com.<company name>\fP. The \f2Widgets\fP package is not good enough. To follow convention, it should be \f2com.abc.Widgets\fP. To place this package prefix onto the \f2Widgets\fP module, execute the following: \f2idlj \fP\f4\-pkgPrefix Widgets com.abc\fP\f2 Widgets.idl\fP
.nf
\f3
.fl
module Widgets
.fl
{
.fl
interface W1 {...};
.fl
interface W2 {...};
.fl
};
.fl
\fP
.fi
.LP
.LP
.LP
Running this file through the IDL\-to\-Java compiler will place the Java bindings for \f2W1\fP and \f2W2\fP within the package \f2Widgets\fP. But there is an industry convention that states that a company's packages should reside within a package named \f2com.<company name>\fP. The \f2Widgets\fP package is not good enough. To follow convention, it should be \f2com.abc.Widgets\fP. To place this package prefix onto the \f2Widgets\fP module, execute the following:
.LP
.nf
\f3
.fl
idlj \fP\f3\-pkgPrefix Widgets com.abc\fP Widgets.idl
.fl
.fi
.LP
.LP
If you have an IDL file which includes \f2Widgets.idl\fP, the \f2\-pkgPrefix\fP flag must appear in that command also. If it does not, then your IDL file will be looking for a \f2Widgets\fP package rather than a \f2com.abc.Widgets\fP package.
.LP
If you have an IDL file which includes \f2Widgets.idl\fP, the \f2\-pkgPrefix\fP flag must appear in that command also. If it does not, then your IDL file will be looking for a \f2Widgets\fP package rather than a \f2com.abc.Widgets\fP package.
.LP
If you have a number of these packages that require prefixes, it might be easier to place them into the \f2idl.config\fP file described above. Each package prefix line should be of the form:
.LP
\f2PkgPrefix.<type>=<prefix>\fP
.nf
\f3
.fl
PkgPrefix.<type>=<prefix>
.fl
\fP
.fi
.LP
So the line for the above example would be: \f2PkgPrefix.Widgets=com.abc\fP
So the line for the above example would be:
.nf
\f3
.fl
PkgPrefix.Widgets=com.abc
.fl
\fP
.fi
.LP
.LP
The use of this option does not affect the Repository ID.
.LP
.RE
.SS
Defining Symbols Before Compilation
.LP
.RS 3
.LP
You may need to define a symbol for compilation that is not defined within the IDL file, perhaps to include debugging code in the bindings. The command
.LP
.nf
\f3
.fl
idlj \fP\f3\-d\fP MYDEF My.idl
.fl
.fi
.LP
You may need to define a symbol for compilation that is not defined within the IDL file, perhaps to include debugging code in the bindings. The command \f2idlj \fP\f4\-d\fP\f2 MYDEF My.idl\fP
.LP
is the equivalent of putting the line \f2#define MYDEF\fP inside \f2My.idl\fP.
.RE
.LP
.SS
Preserving Pre\-Existing Bindings
.LP
.RS 3
.LP
If the Java binding files already exist, the \f2\-keep\fP flag will keep the compiler from overwriting them. The default is to generate all files without considering if they already exist. If you've customized those files (which you should not do unless you are very comfortable with their contents), then the \f2\-keep\fP option is very useful. The command
.LP
.nf
\f3
.fl
idlj \fP\f3\-keep\fP My.idl
.fl
.fi
.LP
If the Java binding files already exist, the \f2\-keep\fP flag will keep the compiler from overwriting them. The default is to generate all files without considering if they already exist. If you've customized those files (which you should not do unless you are very comfortable with their contents), then the \f2\-keep\fP option is very useful. The command \f2idlj \fP\f4\-keep\fP\f2 My.idl\fP
.LP
emit all client\-side bindings that do not already exist.
.RE
emits all client\-side bindings that do not already exist.
.LP
.SS
Viewing Progress of Compilation
.LP
.RS 3
.LP
The IDL\-to\-Java compiler will generate status messages as it progresses through its phases of execution. Use the \f2\-v\fP option to activate this "verbose" mode:
.LP
.nf
\f3
.fl
idlj \fP\f3\-v\fP My.idl
.fl
.fi
.LP
The IDL\-to\-Java compiler will generate status messages as it progresses through its phases of execution. Use the \f2\-v\fP option to activate this "verbose" mode: \f2idlj \fP\f4\-v\fP\f2 My.idl\fP
.LP
By default the compiler does not operate in verbose mode.
.RE
.LP
.SS
Displaying Version Information
.LP
.RS 3
.LP
.LP
To display the build version of the IDL\-to\-Java compiler, specify the \f2\-version\fP option on the command\-line:
.LP
.LP
\f2idlj \-version\fP
.nf
\f3
.fl
idlj \-version
.fl
\fP
.fi
.LP
.LP
Version information also appears within the bindings generated by the compiler. Any additional options appearing on the command\-line are ignored.
.LP
.RE
.SH "Options"
.LP
.LP
.RS 3
.TP 3
\-d symbol
This is equivalent to the following line in an IDL file:
.RS 3
.LP
.nf
\f3
.fl
@ -386,7 +620,6 @@ This is equivalent to the following line in an IDL file:
.fl
\fP
.fi
.RE
.TP 3
\-emitAll
Emit all types, including those found in \f2#include\fP files.
@ -410,8 +643,9 @@ Generates skeletons compatible with pre\-1.4 JDK ORBs. By default, the POA Inher
Wherever \f2type\fP is encountered at file scope, prefix the generated Java package name with \f2prefix\fP for all files generated for that type. The \f2type\fP is the simple name of either a top\-level module, or an IDL type defined outside of any module.
.TP 3
\-pkgTranslate type package
Whenever the module name \f2type\fP is encountered in an identifier, replace it in the identifier with \f2package\fP for all files in the generated Java package. Note that \f2pkgPrefix\fP changes are made first. \f2type\fP is the simple name of either a top\-level module, or an IDL type defined outside of any module, and must match the full package name exactly.
.LP
Whenever the module name \f2type\fP is encountered in an identifier, replace it in the identifier with \f2package\fP for all files in the generated Java package. Note that \f2pkgPrefix\fP changes are made first. \f2type\fP is the simple name of either a top\-level module, or an IDL type defined outside of any module, and must match the full package name exactly.
.br
.br
If more than one translation matches an identifier, the longest match is chosen. For example, if the arguments include:
.nf
\f3
@ -420,7 +654,6 @@ If more than one translation matches an identifier, the longest match is chosen.
.fl
\fP
.fi
.LP
The following translations would occur:
.nf
\f3
@ -435,7 +668,6 @@ foo.baz.bar => buzz.fizz.bar
.fl
\fP
.fi
.LP
The following package names cannot be translated:
.RS 3
.TP 2
@ -445,8 +677,7 @@ o
o
\f2org.omg\fP or any subpackages of \f2org.omg\fP
.RE
.LP
Any attempt to translate these packages will result in uncompilable code, and the use of these packages as the first argument after \f2\-pkgTranslate\fP will be treated as an error.
Any attempt to translate these packages will result in uncompilable code, and the use of these packages as the first argument after \f2\-pkgTranslate\fP will be treated as an error.
.TP 3
\-skeletonName xxx%yyy
Use \f2xxx%yyy\fP as the pattern for naming the skeleton. The defaults are:
@ -481,10 +712,10 @@ Display version information and terminate.
.RE
.LP
See the Description section for more option information.
.SH "Restrictions:"
.LP
See the Description section for more option information.
.LP
.SH "Restrictions:"
.LP
.RS 3
.TP 2
@ -497,8 +728,6 @@ The \f2fixed\fP IDL type is not supported.
.LP
.SH "Known Problems:"
.LP
.LP
.RS 3
.TP 2

170
jdk/src/linux/doc/man/jar.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,16 +19,14 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jar 1 "02 Jun 2010"
.TH jar 1 "10 May 2011"
.LP
.SH "Name"
jar\-The Java Archive Tool
.LP
\f3jar\fP combines multiple files into a single JAR archive file.
\f3jar\fP combines multiple files into a single JAR archive file.
.SH "SYNOPSIS"
.LP
.LP
.RS 3
.TP 3
@ -51,9 +49,6 @@ Add index to jar file
.LP
.LP
where:
.LP
.RS 3
.LP
.RS 3
.TP 3
@ -80,10 +75,7 @@ Option to be passed into the Java runtime environment. (There must be no space b
.RE
.LP
.RE
.SH "DESCRIPTION"
.LP
.LP
The \f3jar\fP tool combines multiple files into a single JAR archive file. \f3jar\fP is a general\-purpose archiving and compression tool, based on ZIP and the
.na
@ -92,9 +84,6 @@ The \f3jar\fP tool combines multiple files into a single JAR archive file. \f3ja
http://www.gzip.org/zlib/ compression format. However, \f3jar\fP was designed mainly package java applets or applications into a single archive. When the components of an applet or application (files, images and sounds) are combined into a single archive, they can be downloaded by a java agent (like a browser) in a single HTTP transaction, rather than requiring a new connection for each piece. This dramatically improves download times. \f3jar\fP also compresses files and so further improves download time. In addition, it allows individual entries in a file to be signed by the applet author so that their origin can be authenticated. The syntax for the jar tool is almost identical to the syntax for the \f2tar\fP command. A \f3jar\fP archive can be used as a class path entry, whether or not it is compressed.
.LP
Typical usage to combine files into a jar file is:
.LP
.RS 3
.LP
.nf
\f3
@ -103,19 +92,15 @@ Typical usage to combine files into a jar file is:
.fl
\fP
.fi
.RE
.LP
In this example, all the class files in the current directory are placed into the file named \f2myFile.jar\fP. The jar tool automatically generates a manifest file entry named \f2META\-INF/MANIFEST.MF\fP. It is always the first entry in the jar file. The manifest file declares meta\-information about the archive, and stores that data as \f2name\ :\ value\fP pairs. Refer to the
.na
\f2JAR file specification\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/jar/jar.html#JAR%20Manifest for details explaining how the jar tool stores meta\-information in the manifest file.
http://download.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#JAR%20Manifest for details explaining how the jar tool stores meta\-information in the manifest file.
.LP
If a jar file should include \f2name\ :\ value\fP pairs contained in an existing manifest file, specify that file using the \f2\-m\fP option:
.LP
.RS 3
.LP
.nf
\f3
@ -124,7 +109,6 @@ If a jar file should include \f2name\ :\ value\fP pairs contained in an existing
.fl
\fP
.fi
.RE
.LP
An existing manifest file must end with a new line character.\ \f3jar\fP does not parse the last line of a manifest file if it does not end with a new line character.
@ -135,9 +119,6 @@ An existing manifest file must end with a new line character.\ \f3jar\fP does n
.LP
\f3Note:\ \fP A jar command that specifies \f2cfm\fP on the command line instead of \f2cmf\fP (the order of the m and \-f options are reversed), the \f3jar\fP command line must specify the name of the jar archive first, followed by the name of the manifest file:
.RS 3
.LP
.nf
\f3
.fl
@ -145,15 +126,11 @@ An existing manifest file must end with a new line character.\ \f3jar\fP does n
.fl
\fP
.fi
.RE
.LP
The manifest is in a text format inspired by RFC822 ASCII format, so it is easy to view and process manifest\-file contents.
.LP
To extract the files from a jar file, use \f2x\fP:
.LP
.RS 3
.LP
.nf
\f3
@ -162,14 +139,10 @@ To extract the files from a jar file, use \f2x\fP:
.fl
\fP
.fi
.RE
.LP
.LP
To extract individual files from a jar file, supply their filenames:
.LP
.RS 3
.LP
.nf
\f3
@ -178,7 +151,6 @@ To extract individual files from a jar file, supply their filenames:
.fl
\fP
.fi
.RE
.LP
.LP
@ -186,10 +158,7 @@ Beginning with version 1.3 of the JDK, the \f2jar\fP utility supports
.na
\f2JarIndex\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/jar/jar.html#JAR%20Index, which allows application class loaders to load classes more efficiently from jar files. If an application or applet is bundled into multiple jar files,\ only the necessary jar files will be downloaded and opened to load classes. This performance optimization is enabled by running \f2jar\fP with the \f2\-i\fPoption. It will generate package location information for the specified main jar file and all the jar files it depends on, which need to be specified in the \f2Class\-Path\fP attribute of the main jar file's manifest.
.LP
.RS 3
http://download.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#JAR_Index, which allows application class loaders to load classes more efficiently from jar files. If an application or applet is bundled into multiple jar files,\ only the necessary jar files will be downloaded and opened to load classes. This performance optimization is enabled by running \f2jar\fP with the \f2\-i\fPoption. It will generate package location information for the specified main jar file and all the jar files it depends on, which need to be specified in the \f2Class\-Path\fP attribute of the main jar file's manifest.
.LP
.nf
\f3
@ -198,7 +167,6 @@ http://java.sun.com/javase/6/docs/technotes/guides/jar/jar.html#JAR%20Index, whi
.fl
\fP
.fi
.RE
.LP
.LP
@ -209,9 +177,6 @@ The application class loader uses the information stored in this file for effici
.br
.br
To copy directories, first compress files in \f2dir1\fP to \f2stdout\fP, then extract from \f2stdin\fP to \f2dir2\fP (omitting the \f2\-f\fP option from both \f2jar\fP commands):
.LP
.RS 3
.LP
.nf
\f3
@ -220,7 +185,6 @@ To copy directories, first compress files in \f2dir1\fP to \f2stdout\fP, then ex
.fl
\fP
.fi
.RE
.LP
.LP
@ -228,11 +192,9 @@ To review command samples which use \f2jar\fP to opeate on jar files and jar fil
.na
\f2Java Tutorial\fP @
.fi
http://java.sun.com/docs/books/tutorial/jar.
http://download.oracle.com/javase/tutorial/deployment/jar.
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
@ -241,9 +203,6 @@ Creates a new archive file named \f2jarfile\fP (if \f2f\fP is specified) or to s
.TP 3
u
Updates an existing file \f2jarfile\fP (when \f2f\fP is specified) by adding to it files and directories specified by \f2inputfiles\fP. For example:
.RS 3
.LP
.nf
\f3
.fl
@ -251,11 +210,7 @@ jar uf foo.jar foo.class
.fl
\fP
.fi
.RE
would add the file \f2foo.class\fP to the existing jar file \f2foo.jar\fP. The \f2\-u\fP option can also update the manifest entry, as given by this example:
.RS 3
.LP
.nf
\f3
.fl
@ -263,7 +218,6 @@ jar umf manifest foo.jar
.fl
\fP
.fi
.RE
updates the \f2foo.jar\fP manifest with the \f2name : value\fP pairs in \f2manifest\fP.
.TP 3
x
@ -274,9 +228,6 @@ Lists the table of contents from \f2jarfile\fP (if \f2f\fP is specified) or stan
.TP 3
i
Generate index information for the specified \f2jarfile\fP and its dependent jar files. For example:
.RS 3
.LP
.nf
\f3
.fl
@ -284,9 +235,8 @@ jar i foo.jar
.fl
\fP
.fi
.RE
.LP
would generate an \f2INDEX.LIST\fP file in \f2foo.jar\fP which contains location information for each package in \f2foo.jar\fP and all the jar files specified in the \f2Class\-Path\fP attribute of \f2foo.jar\fP. See the index example.
would generate an \f2INDEX.LIST\fP file in \f2foo.jar\fP which contains location information for each package in \f2foo.jar\fP and all the jar files specified in the \f2Class\-Path\fP attribute of \f2foo.jar\fP. See the index example.
.TP 3
f
Specifies the file \f2jarfile\fP to be created (\f2c\fP), updated (\f2u\fP), extracted (\f2x\fP), indexed (\f2i\fP), or viewed (\f2t\fP). The \f2\-f\fP option and filename \f2jarfile\fP are a pair \-\- if present, they must both appear. Omitting \f2f\fP and \f2jarfile\fP accepts a jar file name from \f2stdin\fP(for x and t) or sends jar file to \f2stdout\fP (for c and u).
@ -301,12 +251,10 @@ M
Do not create a manifest file entry (for c and u), or delete a manifest file entry if one exists (for u).
.TP 3
m
Includes \f2name : value\fP attribute pairs from the specified manifest file \f2manifest\fP in the file at \f2META\-INF/MANIFEST.MF\fP. \f2jar\fP adds a \f2name\ :\ value\fP pair unless an entry already exists with the same name, in which case \f2jar\fP updates its value.
.LP
Includes \f2name : value\fP attribute pairs from the specified manifest file \f2manifest\fP in the file at \f2META\-INF/MANIFEST.MF\fP. \f2jar\fP adds a \f2name\ :\ value\fP pair unless an entry already exists with the same name, in which case \f2jar\fP updates its value.
.br
.br
On the command line, the letters \f3m\fP and \f3f\fP must appear in the same order that \f2manifest\fP and \f2jarfile\fP appear. Example use:
.RS 3
.LP
.nf
\f3
.fl
@ -314,22 +262,18 @@ jar cmf myManifestFile myFile.jar *.class
.fl
\fP
.fi
.RE
You can add special\-purpose \f2name\ :\ value\fP attribute pairs to the manifest that aren't contained in the default manifest. For example, you can add attributes specifying vendor information, version information, package sealing, or to make JAR\-bundled applications executable. See the
.na
\f2JAR Files\fP @
.fi
http://java.sun.com/docs/books/tutorial/jar/ trail in the Java Tutorial for examples of using the \f4\-m\fP option.
.LP
http://download.oracle.com/javase/tutorial/deployment/jar/ trail in the Java Tutorial for examples of using the \f4\-m\fP option.
.TP 3
e
Sets \f2entrypoint\fP as the application entry point for stand\-alone applications bundled into executable jar file. The use of this option creates or overrides the \f2Main\-Class\fP attribute value in the manifest file. This option can be used during creation of jar file or while updating the jar file. This option specifies the application entry point without editing or creating the manifest file.
.br
.br
.br
For example, this command creates \f2Main.jar\fP where the \f2Main\-Class\fP attribute value in the manifest is set to \f2Main\fP:
.RS 3
.LP
.nf
\f3
.fl
@ -337,12 +281,7 @@ jar cfe Main.jar Main Main.class
.fl
\fP
.fi
.RE
.LP
The java runtime can directly invoke this application by running the following command:
.RS 3
.LP
.nf
\f3
.fl
@ -350,11 +289,7 @@ java \-jar Main.jar
.fl
\fP
.fi
.RE
If the entrypoint class name is in a package it may use either a dot (".") or slash ("/") character as the delimiter. For example, if \f2Main.class\fP is in a package called \f2foo\fP the entry point can be specified in the following ways:
.RS 3
.LP
.nf
\f3
.fl
@ -362,11 +297,7 @@ jar \-cfe Main.jar foo/Main foo/Main.class
.fl
\fP
.fi
.RE
or
.RS 3
.LP
.nf
\f3
.fl
@ -374,18 +305,13 @@ jar \-cfe Main.jar foo.Main foo/Main.class
.fl
\fP
.fi
.RE
\f3Note:\ \fP specifying both \f2\-m\fP and \f2\-e\fP options together when the given manifest also contains the \f2Main\-Class\fP attribute results in an ambigous \f2Main.class\fP specification, leading to an error and the jar creation or update operation is aborted.
.LP
\f3Note:\ \fP specifying both \f2\-m\fP and \f2\-e\fP options together when the given manifest also contains the \f2Main\-Class\fP attribute results in an ambigous \f2Main.class\fP specification, leading to an error and the jar creation or update operation is aborted.
.TP 3
\-C \ dir
\-C\ dir
Temporarily changes directories (\f2cd\fP\ \f2dir\fP) during execution of the \f2jar\fP command while processing the following \f2inputfiles\fP argument. Its operation is intended to be similar to the \f2\-C\fP option of the UNIX \f2tar\fP utility.
.br
.br
For example, this command changes to the \f2classes\fP directory and adds the \f2bar.class\fP from that directory to \f2foo.jar\fP:
.RS 3
.LP
.nf
\f3
.fl
@ -393,11 +319,7 @@ jar uf foo.jar \-C classes bar.class
.fl
\fP
.fi
.RE
This command changes to the \f2classes\fP directory and adds to \f2foo.jar\fP all files within the \f2classes\fP directory (without creating a classes directory in the jar file), then changes back to the original directory before changing to the \f2bin\fP directory to add \f2xyz.class\fP to \f2foo.jar\fP.
.RS 3
.LP
.nf
\f3
.fl
@ -405,11 +327,7 @@ jar uf foo.jar \-C classes . \-C bin xyz.class
.fl
\fP
.fi
.RE
If \f2classes\fP holds files \f2bar1\fP and \f2bar2\fP, then here's what the jar file will contain using \f2jar tf foo.jar\fP:
.RS 3
.LP
.nf
\f3
.fl
@ -425,7 +343,6 @@ xyz.class
.fl
\fP
.fi
.RE
.LP
.TP 3
\-Joption
@ -434,8 +351,6 @@ Pass \f2option\fP to the Java runtime environment, where \f2option\fP is one of
.LP
.SH "COMMAND LINE ARGUMENT FILES"
.LP
.LP
To shorten or simplify the jar command line, you can specify one or more files that themselves contain arguments to the \f2jar\fP command (except \f2\-J\fP options). This enables you to create jar commands of any length, overcoming command line limits imposed by the operating system.
.LP
@ -446,9 +361,6 @@ When executing \f2jar\fP, pass in the path and name of each argument file with t
.br
.br
The example below, \f2classes.list\fP holds the names of files output by a \f2find\fP command:
.LP
.RS 3
.LP
.nf
\f3
@ -456,14 +368,10 @@ The example below, \f2classes.list\fP holds the names of files output by a \f2fi
% find \fP\f3.\fP \-name '*.class' \-print > classes.list
.fl
.fi
.RE
.LP
.LP
You can then execute the \f2jar\fP command on \f2Classes.list\fP by passing it to \f2jar\fP using argfile syntax:
.LP
.RS 3
.LP
.nf
\f3
@ -472,13 +380,9 @@ You can then execute the \f2jar\fP command on \f2Classes.list\fP by passing it t
.fl
\fP
.fi
.RE
.LP
An argument file can specify a path, but any filenames inside the argument file that have relative paths are relative to the current working directory, not to the path passed in. Here is an example:
.RS 3
.LP
.nf
\f3
.fl
@ -486,20 +390,14 @@ An argument file can specify a path, but any filenames inside the argument file
.fl
\fP
.fi
.RE
.LP
.LP
.LP
.SH "EXAMPLES"
.LP
.LP
To add all the files in a particular directory to an archive (overwriting contents if the archive already exists). Enumerating verbosely (with the \f2\-v\fP option) will tell you more information about the files in the archive, such as their size and last modified date.
.RS 3
.LP
.nf
\f3
.fl
@ -535,13 +433,9 @@ adding: spacemusic.au(in = 3079) (out= 73)(deflated 97%)
.fl
\fP
.fi
.RE
.LP
If you already have separate subdirectories for images, audio files and classes, you can combine them into a single jar file:
.RS 3
.LP
.nf
\f3
.fl
@ -585,13 +479,9 @@ audio/ bundle.jar classes/ images/
.fl
\fP
.fi
.RE
.LP
To see the entry names in the jarfile, use the \f2t\fP option:
.RS 3
.LP
.nf
\f3
.fl
@ -619,7 +509,6 @@ images/at_work.gif
.fl
\fP
.fi
.RE
.LP
.LP
@ -629,9 +518,6 @@ To add an index file to the jar file for speeding up class loading, use the \f2i
Example:
.br
.LP
.RS 3
.LP
If you split the inter\-dependent classes for a stock trade application into three jar files: \f2main.jar\fP, \f2buy.jar\fP, and \f2sell.jar\fP.
.br
@ -660,38 +546,34 @@ then you can use the \f2\-i\fP option to speed up the class loading time for you
.fi
.LP
An \f2INDEX.LIST\fP file is inserted to the \f2META\-INF\fP directory. This enables the application class loader to download the specified jar files when it is searching for classes or resources.
.RE
An \f2INDEX.LIST\fP file is inserted to the \f2META\-INF\fP directory. This enables the application class loader to download the specified jar files when it is searching for classes or resources.
.SH "SEE ALSO"
.LP
.LP
.na
\f2The Jar Overview\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/jar/jarGuide.html
.br
http://download.oracle.com/javase/7/docs/technotes/guides/jar/jarGuide.html
.LP
.LP
.na
\f2The Jar File Specification\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/jar/jar.html
.br
http://download.oracle.com/javase/7/docs/technotes/guides/jar/jar.html
.LP
.LP
.na
\f2The JarIndex Spec\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/jar/jar.html#JAR%20Index
.br
http://download.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#JAR_Index
.LP
.LP
.na
\f2Jar Tutorial\fP @
.fi
http://java.sun.com/docs/books/tutorial/jar on the Java Software web site.
.br
http://download.oracle.com/javase/tutorial/deployment/jar/index.html
.LP
pack200(1)
.LP
pack200(1)
.LP

415
jdk/src/linux/doc/man/jarsigner.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1998, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,22 +19,16 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jarsigner 1 "02 Jun 2010"
.TH jarsigner 1 "10 May 2011"
.LP
.SH "Name"
jarsigner \- JAR Signing and Verification Tool
.LP
.RS 3
.LP
.LP
Generates signatures for Java ARchive (JAR) files, and verifies the signatures of signed JAR files.
.LP
.RE
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -50,8 +44,6 @@ Generates signatures for Java ARchive (JAR) files, and verifies the signatures o
The jarsigner \-verify command can take zero or more keystore alias names after the jar filename. When specified, jarsigner will check that the certificate used to verify each signed entry in the jar file matches one of the keystore aliases. The aliases are defined in the keystore specified by \-keystore, or the default keystore.
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f3jarsigner\fP tool is used for two purposes:
@ -108,9 +100,6 @@ The default \f3jarsigner\fP behavior is to \f2sign\fP a JAR (or zip) file. Use t
.LP
.SS
Keystore Aliases
.LP
.RS 3
.LP
.LP
All keystore entities are accessed via unique \f2aliases\fP.
@ -121,23 +110,19 @@ When using \f3jarsigner\fP to sign a JAR file, you must specify the alias for th
.nf
\f3
.fl
jarsigner \-keystore /working/mystore \-storepass myspass
jarsigner \-keystore /working/mystore \-storepass \fP\f4<keystore password>\fP\f3
.fl
\-keypass dukekeypasswd MyJARFile.jar duke
\-keypass \fP\f4<private key password>\fP\f3 MyJARFile.jar duke
.fl
\fP
.fi
.LP
.LP
Keystores are protected with a password, so the store password (in this case "myspass") must be specified. You will be prompted for it if you don't specify it on the command line. Similarly, private keys are protected in a keystore with a password, so the private key's password (in this case "dukekeypasswd") must be specified, and you will be prompted for it if you don't specify it on the command line and it isn't the same as the store password.
Keystores are protected with a password, so the store password must be specified. You will be prompted for it if you don't specify it on the command line. Similarly, private keys are protected in a keystore with a password, so the private key's password must be specified, and you will be prompted for it if you don't specify it on the command line and it isn't the same as the store password.
.LP
.RE
.SS
Keystore Location
.LP
.RS 3
.LP
.LP
\f3jarsigner\fP has a \f2\-keystore\fP option for specifying the URL of the keystore to be used. The keystore is by default stored in a file named \f2.keystore\fP in the user's home directory, as determined by the \f2user.home\fP system property. On Solaris systems \f2user.home\fP defaults to the user's home directory.
@ -145,12 +130,8 @@ Keystore Location
.LP
Note that the input stream from the \f2\-keystore\fP option is passed to the \f2KeyStore.load\fP method. If \f2NONE\fP is specified as the URL, then a null stream is passed to the \f2KeyStore.load\fP method. \f2NONE\fP should be specified if the \f2KeyStore\fP is not file\-based, for example, if it resides on a hardware token device.
.LP
.RE
.SS
Keystore Implementation
.LP
.RS 3
.LP
.LP
The \f2KeyStore\fP class provided in the \f2java.security\fP package supplies well\-defined interfaces to access and modify the information in a keystore. It is possible for there to be multiple different concrete implementations, where each implementation is that for a particular \f2type\fP of keystore.
@ -166,13 +147,13 @@ Keystore implementations are provider\-based. More specifically, the application
.na
\f2How to Implement a Provider for the Java Cryptography Architecture\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/security/crypto/HowToImplAProvider.html.
http://download.oracle.com/javase/7/docs/technotes/guides/security/crypto/HowToImplAProvider.html.
.LP
.LP
Applications can choose different \f2types\fP of keystore implementations from different providers, using the "getInstance" factory method supplied in the \f2KeyStore\fP class. A keystore type defines the storage and data format of the keystore information, and the algorithms used to protect private keys in the keystore and the integrity of the keystore itself. Keystore implementations of different types are not compatible.
.LP
.LP
\f3keytool\fP works on any file\-based keystore implementation. (It treats the keytore location that is passed to it at the command line as a filename and converts it to a FileInputStream, from which it loads the keystore information.) The \f3jarsigner\fP and \f3policytool\fP tools, on the other hand, can read a keystore from any location that can be specified using a URL.
\f3keytool\fP works on any file\-based keystore implementation. (It treats the keystore location that is passed to it at the command line as a filename and converts it to a FileInputStream, from which it loads the keystore information.) The \f3jarsigner\fP and \f3policytool\fP tools, on the other hand, can read a keystore from any location that can be specified using a URL.
.LP
.LP
For \f3jarsigner\fP and \f3keytool\fP, you can specify a keystore type at the command line, via the \f2\-storetype\fP option. For \f3Policy Tool\fP, you can specify a keystore type via the "Change Keystore" command in the Edit menu.
@ -227,40 +208,35 @@ Note that if you us the PKCS#11 provider package, you should refer to the
.na
\f2KeyTool and JarSigner\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/security/p11guide.html#KeyToolJarSigner section of the Java PKCS#11 Reference Guide for details.
http://download.oracle.com/javase/7/docs/technotes/guides/security/p11guide.html#KeyToolJarSigner section of the Java PKCS#11 Reference Guide for details.
.LP
.RE
.SS
Supported Algorithms
.LP
.RS 3
.LP
.LP
By default, \f3jarsigner\fP signs a JAR file using either
By default, \f3jarsigner\fP signs a JAR file using one of the following:
.LP
.RS 3
.TP 2
o
DSA (Digital Signature Algorithm) with the SHA\-1 digest algorithm, or
DSA (Digital Signature Algorithm) with the SHA1 digest algorithm
.TP 2
o
the RSA algorithm with the SHA\-256 digest algorithm.
RSA algorithm with the SHA256 digest algorithm.
.TP 2
o
EC (Elliptic Curve) cryptography algorithm with the SHA256 with ECDSA (Elliptic Curve Digital Signature Algorithm).
.RE
.LP
.LP
That is, if the signer's public and private keys are DSA keys, \f3jarsigner\fP will sign the JAR file using the "SHA1withDSA" algorithm. If the signer's keys are RSA keys, \f3jarsigner\fP will attempt to sign the JAR file using the "SHA256withRSA" algorithm.
That is, if the signer's public and private keys are DSA keys, \f3jarsigner\fP will sign the JAR file using the "SHA1withDSA" algorithm. If the signer's keys are RSA keys, \f3jarsigner\fP will attempt to sign the JAR file using the "SHA256withRSA" algorithm. If the signer's keys are EC keys, \f3jarsigner\fP will sign the JAR file using the "SHA256withECDSA" algorithm.
.LP
.LP
These default signature algorithms can be overridden using the \f2\-sigalg\fP option.
.LP
.RE
.SS
The Signed JAR File
.LP
.RS 3
.LP
.LP
When \f3jarsigner\fP is used to sign a JAR file, the output signed JAR file is exactly the same as the input JAR file, except that it has two additional files placed in the META\-INF directory:
@ -271,7 +247,7 @@ o
a signature file, with a .SF extension, and
.TP 2
o
a signature block file, with a .DSA extension.
a signature block file, with a .DSA, .RSA, or .EC extension.
.RE
.LP
@ -281,22 +257,19 @@ The base file names for these two files come from the value of the \f2\-sigFile\
.nf
\f3
.fl
\-sigFile MKSIGN
\-sigFile MKSIGN
.fl
\fP
.fi
.LP
.LP
the files are named "MKSIGN.SF" and "MKSIGN.DSA".
The files are named "MKSIGN.SF" and "MKSIGN.DSA".
.LP
.LP
If no \f2\-sigfile\fP option appears on the command line, the base file name for the .SF and .DSA files will be the first 8 characters of the alias name specified on the command line, all converted to upper case. If the alias name has fewer than 8 characters, the full alias name is used. If the alias name contains any characters that are not allowed in a signature file name, each such character is converted to an underscore ("_") character in forming the file name. Legal characters include letters, digits, underscores, and hyphens.
.LP
\f3The Signature (.SF) File\fP
.LP
.RS 3
.LP
.LP
A signature file (the .SF file) looks similar to the manifest file that is always included in a JAR file when \f3jarsigner\fP is used to sign the file. That is, for each source file included in the JAR file, the .SF file has three lines, just as in the manifest file, listing the following:
@ -320,25 +293,14 @@ In the manifest file, the SHA digest value for each source file is the digest (h
.LP
The signature file also, by default, includes a header containing a hash of the whole manifest file. The presence of the header enables verification optimization, as described in JAR File Verification.
.LP
.RE
\f3The Signature Block (.DSA) File\fP
\f3The Signature Block File\fP
.LP
.RS 3
.LP
.LP
The .SF file is signed and the signature is placed in the .DSA file. The .DSA file also contains, encoded inside it, the certificate or certificate chain from the keystore which authenticates the public key corresponding to the private key used for signing.
.LP
.RE
.RE
The .SF file is signed and the signature is placed in the signature block file. This file also contains, encoded inside it, the certificate or certificate chain from the keystore which authenticates the public key corresponding to the private key used for signing. The file has the extension .DSA, .RSA, or .EC depending on the digest algorithm used.
.SS
Signature Timestamp
.LP
.RS 3
.LP
.LP
\f2jarsigner\fP tool can now generate and store a signature timestamp when signing a JAR file. In addition, \f2jarsigner\fP supports alternative signing mechanisms. This behavior is optional and is controlled by the user at the time of signing through these options:
\f2jarsigner\fP tool can generate and store a signature timestamp when signing a JAR file. In addition, \f2jarsigner\fP supports alternative signing mechanisms. This behavior is optional and is controlled by the user at the time of signing through these options:
.LP
.RS 3
.TP 2
@ -359,12 +321,8 @@ o
.LP
Each of these options is detailed in the Options section below.
.LP
.RE
.SS
JAR File Verification
.LP
.RS 3
.LP
.LP
A successful JAR file verification occurs if the signature(s) are valid, and none of the files that were in the JAR file when the signatures were generated have been changed since then. JAR file verification involves the following steps:
@ -372,18 +330,22 @@ A successful JAR file verification occurs if the signature(s) are valid, and non
.RS 3
.TP 3
1.
Verify the signature of the .SF file itself.
.LP
That is, the verification ensures that the signature stored in each signature block (.DSA) file was in fact generated using the private key corresponding to the public key whose certificate (or certificate chain) also appears in the .DSA file. It also ensures that the signature is a valid signature of the corresponding signature (.SF) file, and thus the .SF file has not been tampered with.
Verify the signature of the .SF file itself.
.br
.br
That is, the verification ensures that the signature stored in each signature block (.DSA) file was in fact generated using the private key corresponding to the public key whose certificate (or certificate chain) also appears in the .DSA file. It also ensures that the signature is a valid signature of the corresponding signature (.SF) file, and thus the .SF file has not been tampered with.
.TP 3
2.
Verify the digest listed in each entry in the .SF file with each corresponding section in the manifest.
.LP
The .SF file by default includes a header containing a hash of the entire manifest file. When the header is present, then the verification can check to see whether or not the hash in the header indeed matches the hash of the manifest file. If that is the case, verification proceeds to the next step.
.LP
If that is not the case, a less optimized verification is required to ensure that the hash in each source file information section in the .SF file equals the hash of its corresponding section in the manifest file (see The Signature (.SF) File).
.LP
One reason the hash of the manifest file that is stored in the .SF file header may not equal the hash of the current manifest file would be because one or more files were added to the JAR file (using the \f2jar\fP tool) after the signature (and thus the .SF file) was generated. When the \f2jar\fP tool is used to add files, the manifest file is changed (sections are added to it for the new files), but the .SF file is not. A verification is still considered successful if none of the files that were in the JAR file when the signature was generated have been changed since then, which is the case if the hashes in the non\-header sections of the .SF file equal the hashes of the corresponding sections in the manifest file.
Verify the digest listed in each entry in the .SF file with each corresponding section in the manifest.
.br
.br
The .SF file by default includes a header containing a hash of the entire manifest file. When the header is present, then the verification can check to see whether or not the hash in the header indeed matches the hash of the manifest file. If that is the case, verification proceeds to the next step.
.br
.br
If that is not the case, a less optimized verification is required to ensure that the hash in each source file information section in the .SF file equals the hash of its corresponding section in the manifest file (see The Signature (.SF) File).
.br
.br
One reason the hash of the manifest file that is stored in the .SF file header may not equal the hash of the current manifest file would be because one or more files were added to the JAR file (using the \f2jar\fP tool) after the signature (and thus the .SF file) was generated. When the \f2jar\fP tool is used to add files, the manifest file is changed (sections are added to it for the new files), but the .SF file is not. A verification is still considered successful if none of the files that were in the JAR file when the signature was generated have been changed since then, which is the case if the hashes in the non\-header sections of the .SF file equal the hashes of the corresponding sections in the manifest file.
.TP 3
3.
Read each file in the JAR file that has an entry in the .SF file. While reading, compute the file's digest, and then compare the result with the digest for this file in the manifest section. The digests should be the same, or verification fails.
@ -393,12 +355,8 @@ Read each file in the JAR file that has an entry in the .SF file. While reading,
.LP
If any serious verification failures occur during the verification process, the process is stopped and a security exception is thrown. It is caught and displayed by \f3jarsigner\fP.
.LP
.RE
.SS
Multiple Signatures for a JAR File
.LP
.RS 3
.LP
.LP
A JAR file can be signed by multiple people simply by running the \f3jarsigner\fP tool on the file multiple times, specifying the alias for a different person each time, as in:
@ -435,10 +393,7 @@ When a JAR file is signed multiple times, there are multiple .SF and .DSA files
.LP
Note: It is also possible for a JAR file to have mixed signatures, some generated by the JDK 1.1 \f3javakey\fP tool and others by \f3jarsigner\fP. That is, \f3jarsigner\fP can be used to sign JAR files already previously signed using \f3javakey\fP.
.LP
.RE
.SH "OPTIONS"
.LP
.LP
.LP
The various \f3jarsigner\fP options are listed and described below. Note:
@ -462,12 +417,15 @@ The \f2\-keystore\fP, \f2\-storepass\fP, \f2\-keypass\fP, \f2\-sigfile\fP, \f2\-
.RS 3
.TP 3
\-keystore url
Specifies the URL that tells the keystore location. This defaults to the file \f2.keystore\fP in the user's home directory, as determined by the "user.home" system property.
.LP
A keystore is required when signing, so you must explicitly specify one if the default keystore does not exist (or you want to use one other than the default).
.LP
A keystore is \f2not\fP required when verifying, but if one is specified, or the default exists, and the \f2\-verbose\fP option was also specified, additional information is output regarding whether or not any of the certificates used to verify the JAR file are contained in that keystore.
.LP
Specifies the URL that tells the keystore location. This defaults to the file \f2.keystore\fP in the user's home directory, as determined by the "user.home" system property.
.br
.br
A keystore is required when signing, so you must explicitly specify one if the default keystore does not exist (or you want to use one other than the default).
.br
.br
A keystore is \f2not\fP required when verifying, but if one is specified, or the default exists, and the \f2\-verbose\fP option was also specified, additional information is output regarding whether or not any of the certificates used to verify the JAR file are contained in that keystore.
.br
.br
Note: the \f2\-keystore\fP argument can actually be a file name (and path) specification rather than a URL, in which case it will be treated the same as a "file:" URL. That is,
.nf
\f3
@ -494,79 +452,93 @@ o
\f2\-storetype PKCS11\fP
.RE
For example, this command lists the contents of the configured PKCS#11 token:
.RS 3
.LP
.nf
\f3
.fl
jarsigner \-keystore NONE \-storetype PKCS11 \-list
.fl
.fl
\fP
.fi
.RE
.TP 3
\-storetype storetype
Specifies the type of keystore to be instantiated. The default keystore type is the one that is specified as the value of the "keystore.type" property in the security properties file, which is returned by the static \f2getDefaultType\fP method in \f2java.security.KeyStore\fP.
.LP
The PIN for a PCKS#11 token can also be specified using the \f2\-storepass\fP option. If none has been specified, keytool and jarsigner will prompt for the token PIN. If the token has a protected authentication path (such as a dedicated PIN\-pad or a biometric reader), then the \f2\-protected\fP option must be specified and no password options can be specified.
Specifies the type of keystore to be instantiated. The default keystore type is the one that is specified as the value of the "keystore.type" property in the security properties file, which is returned by the static \f2getDefaultType\fP method in \f2java.security.KeyStore\fP.
.br
.br
The PIN for a PCKS#11 token can also be specified using the \f2\-storepass\fP option. If none has been specified, keytool and jarsigner will prompt for the token PIN. If the token has a protected authentication path (such as a dedicated PIN\-pad or a biometric reader), then the \f2\-protected\fP option must be specified and no password options can be specified.
.TP 3
\-storepass password
Specifies the password which is required to access the keystore. This is only needed when signing (not verifying) a JAR file. In that case, if a \f2\-storepass\fP option is not provided at the command line, the user is prompted for the password.
.LP
Note: The password shouldn't be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system.
\-storepass[:env | :file] argument
Specifies the password which is required to access the keystore. This is only needed when signing (not verifying) a JAR file. In that case, if a \f2\-storepass\fP option is not provided at the command line, the user is prompted for the password.
.br
.br
If the modifier \f2env\fP or \f2file\fP is not specified, then the password has the value \f2argument\fP. Otherwise, the password is retrieved as follows:
.RS 3
.TP 2
o
\f2env\fP: Retrieve the password from the environment variable named \f2argument\fP
.TP 2
o
\f2file\fP: Retrieve the password from the file named \f2argument\fP
.RE
Note: The password shouldn't be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system.
.TP 3
\-keypass password
Specifies the password used to protect the private key of the keystore entry addressed by the alias specified on the command line. The password is required when using \f3jarsigner\fP to sign a JAR file. If no password is provided on the command line, and the required password is different from the store password, the user is prompted for it.
.LP
Note: The password shouldn't be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system. Also, when typing in a password at the password prompt, the password is echoed (displayed exactly as typed), so be careful not to type it in front of anyone.
\-keypass[:env | :file] argument
Specifies the password used to protect the private key of the keystore entry addressed by the alias specified on the command line. The password is required when using \f3jarsigner\fP to sign a JAR file. If no password is provided on the command line, and the required password is different from the store password, the user is prompted for it.
.br
.br
If the modifier \f2env\fP or \f2file\fP is not specified, then the password has the value \f2argument\fP. Otherwise, the password is retrieved as follows:
.RS 3
.TP 2
o
\f2env\fP: Retrieve the password from the environment variable named \f2argument\fP
.TP 2
o
\f2file\fP: Retrieve the password from the file named \f2argument\fP
.RE
Note: The password shouldn't be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system.
.TP 3
\-sigfile file
Specifies the base file name to be used for the generated .SF and .DSA files. For example, if \f2file\fP is "DUKESIGN", the generated .SF and .DSA files will be named "DUKESIGN.SF" and "DUKESIGN.DSA", and will be placed in the "META\-INF" directory of the signed JAR file.
.LP
The characters in \f2file\fP must come from the set "a\-zA\-Z0\-9_\-". That is, only letters, numbers, underscore, and hyphen characters are allowed. Note: All lowercase characters will be converted to uppercase for the .SF and .DSA file names.
.LP
If no \f2\-sigfile\fP option appears on the command line, the base file name for the .SF and .DSA files will be the first 8 characters of the alias name specified on the command line, all converted to upper case. If the alias name has fewer than 8 characters, the full alias name is used. If the alias name contains any characters that are not legal in a signature file name, each such character is converted to an underscore ("_") character in forming the file name.
Specifies the base file name to be used for the generated .SF and .DSA files. For example, if \f2file\fP is "DUKESIGN", the generated .SF and .DSA files will be named "DUKESIGN.SF" and "DUKESIGN.DSA", and will be placed in the "META\-INF" directory of the signed JAR file.
.br
.br
The characters in \f2file\fP must come from the set "a\-zA\-Z0\-9_\-". That is, only letters, numbers, underscore, and hyphen characters are allowed. Note: All lowercase characters will be converted to uppercase for the .SF and .DSA file names.
.br
.br
If no \f2\-sigfile\fP option appears on the command line, the base file name for the .SF and .DSA files will be the first 8 characters of the alias name specified on the command line, all converted to upper case. If the alias name has fewer than 8 characters, the full alias name is used. If the alias name contains any characters that are not legal in a signature file name, each such character is converted to an underscore ("_") character in forming the file name.
.TP 3
\-sigalg algorithm
.RS 3
.LP
Specifies the name of the signature algorithm to use to sign the JAR file.
.LP
Specifies the name of the signature algorithm to use to sign the JAR file.
.br
.br
See
.na
\f2Appendix A\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/security/crypto/CryptoSpec.html#AppA of the Java Cryptography Architecture for a list of standard signature algorithm names. This algorithm must be compatible with the private key used to sign the JAR file. If this option is not specified, SHA1withDSA or SHA256withRSA will be used depending on the type of private key. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f2\-providerClass\fP option, otherwise the command will not succeed.
.LP
.RE
http://download.oracle.com/javase/7/docs/technotes/guides/security/crypto/CryptoSpec.html#AppA of the Java Cryptography Architecture for a list of standard signature algorithm names. This algorithm must be compatible with the private key used to sign the JAR file. If this option is not specified, SHA1withDSA, SHA256withRSA, or SHA256withECDSA will be used depending on the type of private key. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f2\-providerClass\fP option, otherwise the command will not succeed.
.TP 3
\-digestalg algorithm
.RS 3
Specifies the name of the message digest algorithm to use when digesting the entries of a jar file.
.LP
Specifies the name of the message digest algorithm to use when digesting the entries of a jar file.
.br
.br
See
.na
\f2Appendix A\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/security/crypto/CryptoSpec.html#AppA of the Java Cryptography Architecture for a list of standard message digest algorithm names. If this option is not specified, SHA\-256 will be used. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f2\-providerClass\fP option, otherwise the command will not succeed.
.LP
.RE
http://download.oracle.com/javase/7/docs/technotes/guides/security/crypto/CryptoSpec.html#AppA of the Java Cryptography Architecture for a list of standard message digest algorithm names. If this option is not specified, SHA256 will be used. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f2\-providerClass\fP option, otherwise the command will not succeed.
.TP 3
\-signedjar file
Specifies the name to be used for the signed JAR file.
.LP
If no name is specified on the command line, the name used is the same as the input JAR file name (the name of the JAR file to be signed); in other words, that file is overwritten with the signed JAR file.
Specifies the name to be used for the signed JAR file.
.br
.br
If no name is specified on the command line, the name used is the same as the input JAR file name (the name of the JAR file to be signed); in other words, that file is overwritten with the signed JAR file.
.TP 3
\-verify
If this appears on the command line, the specified JAR file will be verified, not signed. If the verification is successful, "jar verified" will be displayed. If you try to verify an unsigned JAR file, or a JAR file signed with an unsupported algorithm (e.g., RSA when you don't have an RSA provider installed), the following is displayed: "jar is unsigned. (signatures missing or not parsable)"
.LP
It is possible to verify JAR files signed using either \f3jarsigner\fP or the JDK 1.1 \f3javakey\fP tool, or both.
.LP
For further information on verification, see JAR File Verification.
If this appears on the command line, the specified JAR file will be verified, not signed. If the verification is successful, "jar verified" will be displayed. If you try to verify an unsigned JAR file, or a JAR file signed with an unsupported algorithm (e.g., RSA when you don't have an RSA provider installed), the following is displayed: "jar is unsigned. (signatures missing or not parsable)"
.br
.br
It is possible to verify JAR files signed using either \f3jarsigner\fP or the JDK 1.1 \f3javakey\fP tool, or both.
.br
.br
For further information on verification, see JAR File Verification.
.TP 3
\-certs
If this appears on the command line, along with the \f2\-verify\fP and \f2\-verbose\fP options, the output includes certificate information for each signer of the JAR file. This information includes
@ -578,7 +550,6 @@ the name of the type of certificate (stored in the .DSA file) that certifies the
o
if the certificate is an X.509 certificate (more specifically, an instance of \f2java.security.cert.X509Certificate\fP): the distinguished name of the signer
.RE
.LP
The keystore is also examined. If no keystore value is specified on the command line, the default keystore file (if any) will be checked. If the public key certificate for a signer matches an entry in the keystore, then the following information will also be displayed:
.RS 3
.TP 2
@ -596,26 +567,25 @@ If this appears on the command line, it indicates "verbose" mode, which causes \
In the past, the .DSA (signature block) file generated when a JAR file was signed used to include a complete encoded copy of the .SF file (signature file) also generated. This behavior has been changed. To reduce the overall size of the output JAR file, the .DSA file by default doesn't contain a copy of the .SF file anymore. But if \f2\-internalsf\fP appears on the command line, the old behavior is utilized. \f3This option is mainly useful for testing; in practice, it should not be used, since doing so eliminates a useful optimization.\fP
.TP 3
\-sectionsonly
If this appears on the command line, the .SF file (signature file) generated when a JAR file is signed does \f2not\fP include a header containing a hash of the whole manifest file. It just contains information and hashes related to each individual source file included in the JAR file, as described in The Signature (.SF) File .
.LP
By default, this header is added, as an optimization. When the header is present, then whenever the JAR file is verified, the verification can first check to see whether or not the hash in the header indeed matches the hash of the whole manifest file. If so, verification proceeds to the next step. If not, it is necessary to do a less optimized verification that the hash in each source file information section in the .SF file equals the hash of its corresponding section in the manifest file.
.LP
For further information, see JAR File Verification.
.LP
\f3This option is mainly useful for testing; in practice, it should not be used, since doing so eliminates a useful optimization.\fP
If this appears on the command line, the .SF file (signature file) generated when a JAR file is signed does \f2not\fP include a header containing a hash of the whole manifest file. It just contains information and hashes related to each individual source file included in the JAR file, as described in The Signature (.SF) File .
.br
.br
By default, this header is added, as an optimization. When the header is present, then whenever the JAR file is verified, the verification can first check to see whether or not the hash in the header indeed matches the hash of the whole manifest file. If so, verification proceeds to the next step. If not, it is necessary to do a less optimized verification that the hash in each source file information section in the .SF file equals the hash of its corresponding section in the manifest file.
.br
.br
For further information, see JAR File Verification.
.br
.br
\f3This option is mainly useful for testing; in practice, it should not be used, since doing so eliminates a useful optimization.\fP
.TP 3
\-protected
Either \f2true\fP or \f2false\fP. This value should be specified as \f2true\fP if a password must be given via a protected authentication path such as a dedicated PIN reader.
.RE
.RS 3
.TP 3
\-provider provider\-class\-name
Used to specify the name of cryptographic service provider's master class file when the service provider is not listed in the security properties file, \f2java.security\fP.
.LP
\-providerClass provider\-class\-name
Used to specify the name of cryptographic service provider's master class file when the service provider is not listed in the security properties file, \f2java.security\fP.
.br
.br
Used in conjunction with the \f2\-providerArg\fP \f2ConfigFilePath\fP option, keytool and jarsigner will install the provider dynamically (where \f2ConfigFilePath\fP is the path to the token configuration file). Here's an example of a command to list a PKCS#11 keystore when the Sun PKCS#11 provider has not been configured in the security properties file.
.RS 3
.LP
.nf
\f3
.fl
@ -629,19 +599,16 @@ jarsigner \-keystore NONE \-storetype PKCS11 \\
.fl
\fP
.fi
.RE
.TP 3
\-providerName providerName
If more than one provider has been configured in the \f2java.security\fP security properties file, you can use the \f2\-providerName\fP option to target a specific provider instance. The argument to this option is the name of the provider.
.LP
If more than one provider has been configured in the \f2java.security\fP security properties file, you can use the \f2\-providerName\fP option to target a specific provider instance. The argument to this option is the name of the provider.
.br
.br
For the Sun PKCS#11 provider, \f2providerName\fP is of the form \f2SunPKCS11\-\fP\f2TokenName\fP, where \f2TokenName\fP is the name suffix that the provider instance has been configured with, as detailed in the
.na
\f2configuration attributes table\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/security/p11guide.html#ATTRS. For example, the following command lists the contents of the PKCS#11 keystore provider instance with name suffix \f2SmartCard\fP:
.RS 3
.LP
http://download.oracle.com/javase/7/docs/technotes/guides/security/p11guide.html#ATTRS. For example, the following command lists the contents of the PKCS#11 keystore provider instance with name suffix \f2SmartCard\fP:
.nf
\f3
.fl
@ -653,58 +620,59 @@ jarsigner \-keystore NONE \-storetype PKCS11 \\
.fl
\fP
.fi
.RE
.TP 3
\-Jjavaoption
Passes through the specified \f2javaoption\fP string directly to the Java interpreter. (\f3jarsigner\fP is actually a "wrapper" around the interpreter.) This option should not contain any spaces. It is useful for adjusting the execution environment or memory usage. For a list of possible interpreter options, type \f2java \-h\fP or \f2java \-X\fP at the command line.
.LP
Passes through the specified \f2javaoption\fP string directly to the Java interpreter. (\f3jarsigner\fP is actually a "wrapper" around the interpreter.) This option should not contain any spaces. It is useful for adjusting the execution environment or memory usage. For a list of possible interpreter options, type \f2java \-h\fP or \f2java \-X\fP at the command line.
.TP 3
\-tsa url
If \f2"\-tsa http://example.tsa.url"\fP appears on the command line when signing a JAR file then a timestamp is generated for the signature. The URL, \f2http://example.tsa.url\fP, identifies the location of the Time Stamping Authority (TSA). It overrides any URL found via the \f2\-tsacert\fP option. The \f2\-tsa\fP option does not require the TSA's public key certificate to be present in the keystore.
.LP
If \f2"\-tsa http://example.tsa.url"\fP appears on the command line when signing a JAR file then a timestamp is generated for the signature. The URL, \f2http://example.tsa.url\fP, identifies the location of the Time Stamping Authority (TSA). It overrides any URL found via the \f2\-tsacert\fP option. The \f2\-tsa\fP option does not require the TSA's public key certificate to be present in the keystore.
.br
.br
To generate the timestamp, \f2jarsigner\fP communicates with the TSA using the Time\-Stamp Protocol (TSP) defined in
.na
\f2RFC 3161\fP @
.fi
http://www.ietf.org/rfc/rfc3161.txt. If successful, the timestamp token returned by the TSA is stored along with the signature in the signature block file.
.LP
http://www.ietf.org/rfc/rfc3161.txt. If successful, the timestamp token returned by the TSA is stored along with the signature in the signature block file.
.TP 3
\-tsacert alias
If \f2"\-tsacert alias"\fP appears on the command line when signing a JAR file then a timestamp is generated for the signature. The \f2alias\fP identifies the TSA's public key certificate in the keystore that is currently in effect. The entry's certificate is examined for a Subject Information Access extension that contains a URL identifying the location of the TSA.
.LP
The TSA's public key certificate must be present in the keystore when using \f2\-tsacert\fP.
.LP
If \f2"\-tsacert alias"\fP appears on the command line when signing a JAR file then a timestamp is generated for the signature. The \f2alias\fP identifies the TSA's public key certificate in the keystore that is currently in effect. The entry's certificate is examined for a Subject Information Access extension that contains a URL identifying the location of the TSA.
.br
.br
The TSA's public key certificate must be present in the keystore when using \f2\-tsacert\fP.
.TP 3
\-altsigner class
Specifies that an alternative signing mechanism be used. The fully\-qualified class name identifies a class file that extends the \f2com.sun.jarsigner.ContentSigner abstract class\fP. The path to this class file is defined by the \f2\-altsignerpath\fP option. If the \f2\-altsigner\fP option is used, \f2jarsigner\fP uses the signing mechanism provided by the specified class. Otherwise, \f2jarsigner\fP uses its default signing mechanism.
.LP
For example, to use the signing mechanism provided by a class named \f2com.sun.sun.jarsigner.AuthSigner\fP, use the \f2jarsigner\fP option \f2"\-altsigner com.sun.jarsigner.AuthSigner"\fP
.LP
Specifies that an alternative signing mechanism be used. The fully\-qualified class name identifies a class file that extends the \f2com.sun.jarsigner.ContentSigner abstract class\fP. The path to this class file is defined by the \f2\-altsignerpath\fP option. If the \f2\-altsigner\fP option is used, \f2jarsigner\fP uses the signing mechanism provided by the specified class. Otherwise, \f2jarsigner\fP uses its default signing mechanism.
.br
.br
For example, to use the signing mechanism provided by a class named \f2com.sun.sun.jarsigner.AuthSigner\fP, use the \f2jarsigner\fP option \f2"\-altsigner com.sun.jarsigner.AuthSigner"\fP
.TP 3
\-altsignerpath classpathlist
Specifies the path to the class file (the class file name is specified with the \f2\-altsigner\fP option described above) and any JAR files it depends on. If the class file is in a JAR file, then this specifies the path to that JAR file, as shown in the example below.
.LP
An absolute path or a path relative to the current directory may be specified. If \f2classpathlist\fP contains multiple paths or JAR files, they should be separated with a colon (\f2:\fP) on Solaris and a semi\-colon (\f2;\fP) on Windows. This option is not necessary if the class is already in the search path.
.LP
Specifies the path to the class file (the class file name is specified with the \f2\-altsigner\fP option described above) and any JAR files it depends on. If the class file is in a JAR file, then this specifies the path to that JAR file, as shown in the example below.
.br
.br
An absolute path or a path relative to the current directory may be specified. If \f2classpathlist\fP contains multiple paths or JAR files, they should be separated with a colon (\f2:\fP) on Solaris and a semi\-colon (\f2;\fP) on Windows. This option is not necessary if the class is already in the search path.
.br
.br
Example of specifying the path to a jar file that contains the class file:
.RS 3
.LP
.LP
\f2\-altsignerpath /home/user/lib/authsigner.jar\fP
.LP
.RE
.LP
Note that the JAR file name is included.
.LP
.nf
\f3
.fl
\-altsignerpath /home/user/lib/authsigner.jar
.fl
\fP
.fi
Note that the JAR file name is included.
.br
.br
Example of specifying the path to the jar file that contains the class file:
.RS 3
.LP
\f2\-altsignerpath /home/user/classes/com/sun/tools/jarsigner/\fP
.LP
.RE
.LP
Note that the JAR file name is omitted.
.nf
\f3
.fl
\-altsignerpath /home/user/classes/com/sun/tools/jarsigner/
.fl
\fP
.fi
Note that the JAR file name is omitted.
.TP 3
\-strict
During the signing or verifying process, some warning messages may be shown. If this option appears on the command line, the exit code of the tool will reflect the warning messages that are found. Read the "WARNINGS" section for details.
@ -712,25 +680,22 @@ During the signing or verifying process, some warning messages may be shown. If
\-verbose:sub\-options
For the verifying process, the \f2\-verbose\fP option takes sub\-options to determine how much information will be shown. If \f2\-certs\fP is also specified, the default mode (or sub\-option all) displays each entry as it is being processed and following that, the certificate information for each signer of the JAR file. If \f2\-certs\fP and the \f2\-verbose:grouped\fP sub\-option are specified, entries with the same signer info are grouped and displayed together along with their certificate information. If \f2\-certs\fP and the \f2\-verbose:summary\fP sub\-option are specified, then entries with the same signer info are grouped and displayed together along with their certificate information but details about each entry are summarized and displayed as "one entry (and more)". See the examples section for more information.
.RE
.SH "EXAMPLES"
.LP
.LP
.SH "EXAMPLES"
.LP
.SS
Signing a JAR File
.LP
.RS 3
.LP
.LP
Suppose you have a JAR file named "bundle.jar" and you'd like to sign it using the private key of the user whose keystore alias is "jane" in the keystore named "mystore" in the "working" directory. Suppose the keystore password is "myspass" and the password for \f2jane\fP's private key is "j638klm". You can use the following to sign the JAR file and name the signed JAR file "sbundle.jar":
Suppose you have a JAR file named "bundle.jar" and you'd like to sign it using the private key of the user whose keystore alias is "jane" in the keystore named "mystore" in the "working" directory. You can use the following to sign the JAR file and name the signed JAR file "sbundle.jar":
.LP
.nf
\f3
.fl
jarsigner \-keystore /working/mystore \-storepass myspass
jarsigner \-keystore /working/mystore \-storepass \fP\f4<keystore password>\fP\f3
.fl
\-keypass j638klm \-signedjar sbundle.jar bundle.jar jane
\-keypass \fP\f4<private key password>\fP\f3 \-signedjar sbundle.jar bundle.jar jane
.fl
\fP
.fi
@ -747,7 +712,7 @@ If you want to be prompted for the store password and the private key password,
.fl
jarsigner \-keystore /working/mystore
.fl
\-signedjar sbundle.jar bundle.jar jane
\-signedjar sbundle.jar bundle.jar jane
.fl
\fP
.fi
@ -759,7 +724,7 @@ If the keystore to be used is the default keystore (the one named ".keystore" in
.nf
\f3
.fl
jarsigner \-signedjar sbundle.jar bundle.jar jane
jarsigner \-signedjar sbundle.jar bundle.jar jane
.fl
\fP
.fi
@ -771,18 +736,14 @@ Finally, if you want the signed JAR file to simply overwrite the input JAR file
.nf
\f3
.fl
jarsigner bundle.jar jane
jarsigner bundle.jar jane
.fl
\fP
.fi
.RE
.LP
.SS
Verifying a Signed JAR File
.LP
.RS 3
.LP
.LP
To verify a signed JAR file, that is, to verify that the signature is valid and the JAR file has not been tampered with, use a command such as the following:
@ -790,7 +751,7 @@ To verify a signed JAR file, that is, to verify that the signature is valid and
.nf
\f3
.fl
jarsigner \-verify sbundle.jar
jarsigner \-verify sbundle.jar
.fl
\fP
.fi
@ -851,7 +812,7 @@ You can get more information if you use the \f2\-verbose\fP option. A sample use
Verification with Certificate Information
.LP
.LP
If you specify the \f2\-certs\fP option when verifying, along with the \f2\-verify\fP and \f2\-verbose\fP options, the output includes certificate information for each signer of the JAR file, including the certificate type, the signer distinguished name information (iff it's an X.509 certificate), and, in parentheses, the keystore alias for the signer if the public key certificate in the JAR file matches that in a keystore entry. For example,
If you specify the \f2\-certs\fP option when verifying, along with the \f2\-verify\fP and \f2\-verbose\fP options, the output includes certificate information for each signer of the JAR file, including the certificate type, the signer distinguished name information (if and only if it's an X.509 certificate), and, in parentheses, the keystore alias for the signer if the public key certificate in the JAR file matches that in a keystore entry. For example,
.LP
.nf
\f3
@ -961,10 +922,7 @@ When the \f2\-certs\fP option is used, any identity database aliases are shown i
.LP
Note that the alias "duke" is in brackets to denote that it is an identity database alias, not a keystore alias.
.LP
.RE
.SH "WARNINGS"
.LP
.LP
During the signing/verifying process, jarsigner may display various warnings. These warning codes are defined as follows:
.nf
@ -980,25 +938,25 @@ During the signing/verifying process, jarsigner may display various warnings. Th
.fl
This jar contains entries whose signer certificate has expired.
.fl
.fl
notYetValidCert 4
.fl
This jar contains entries whose signer certificate is not yet valid.
.fl
.fl
chainNotValidated 4
.fl
This jar contains entries whose certificate chain cannot be correctly validated.
.fl
.fl
badKeyUsage 8
.fl
This jar contains entries whose signer certificate's KeyUsage extension doesn't allow code signing.
.fl
.fl
badExtendedKeyUsage 8
.fl
@ -1006,33 +964,33 @@ During the signing/verifying process, jarsigner may display various warnings. Th
.fl
doesn't allow code signing.
.fl
.fl
badNetscapeCertType 8
.fl
This jar contains entries whose signer certificate's NetscapeCertType extension
This jar contains entries whose signer certificate's NetscapeCertType extension
.fl
doesn't allow code signing.
.fl
.fl
hasUnsignedEntry 16
.fl
This jar contains unsigned entries which have not been integrity\-checked.
.fl
.fl
notSignedByAlias 32
.fl
This jar contains signed entries which are not signed by the specified alias(es)
.fl
.fl
aliasNotInStore 32
.fl
This jar contains signed entries that are not signed by alias in this keystore
.fl
.fl
\fP
.fi
@ -1042,23 +1000,19 @@ During the signing/verifying process, jarsigner may display various warnings. Th
When the \f2\-strict\fP option is provided, an OR\-value of warnings detected will be returned as the exit code of the tool. For example, if a certificate used to sign an entry is expired and has a keyUsage extension that does not allow it to sign a file, an exit code 12 (=4+8) will be returned.
.LP
.LP
\f3Note\fP: Exit codes are reused because only 0\-255 is legal for Unix. In any case, if the signing/verifying process fails, the exit code
\f3Note\fP: Exit codes are reused because only 0\-255 is legal for Unix. In any case, if the signing/verifying process fails, the following exit code will be returned:
.LP
.nf
\f3
.fl
failure 1
failure 1
.fl
\fP
.fi
.LP
will be returned.
.SS
Compatibility with JDK 1.1
.LP
.RS 3
.LP
.LP
The \f3keytool\fP and \f3jarsigner\fP tools completely replace the \f3javakey\fP tool provided in JDK 1.1. These new tools provide more features than \f3javakey\fP, including the ability to protect the keystore and private keys with passwords, and the ability to verify signatures in addition to generating them.
@ -1083,7 +1037,6 @@ o
The following table explains how JAR files that were signed in JDK 1.1.x are treated in the Java 2 platform.
.LP
.LP
.TS
.if \n+(b.=1 .nr d. \n(.c-\n(c.-1
.de 35
.ps \n(.s
@ -1390,7 +1343,7 @@ Default privileges granted to all code plus privileges granted in policy file. (
.nr 44 \n(83+(3*\n(38)
.nr 84 +\n(44
.nr TW \n(84
.if t .if \n(TW>\n(.li .tm Table at line 1128 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 1082 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -1566,7 +1519,6 @@ Default privileges granted to all code plus privileges granted in policy file. (
.rm g+
.rm h+
.rm i+
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-42
.LP
@ -1590,8 +1542,6 @@ Only trusted identities can be imported into Java 2 SDK keystores.
.LP
.SH "SEE ALSO"
.LP
.LP
.RS 3
.TP 2
@ -1606,13 +1556,12 @@ the
.na
\f4Security\fP @
.fi
http://java.sun.com/docs/books/tutorial/security/index.html trail of the
http://download.oracle.com/javase/tutorial/security/index.html trail of the
.na
\f4Java Tutorial\fP @
.fi
http://java.sun.com/docs/books/tutorial/index.html for examples of the use of the \f3jarsigner\fP tool
http://download.oracle.com/javase/tutorial/index.html for examples of the use of the \f3jarsigner\fP tool
.RE
.LP
.RE

240
jdk/src/linux/doc/man/java.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1994, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1994, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,7 +19,7 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH java 1 "02 Jun 2010"
.TH java 1 "10 May 2011"
.LP
.SH "Name"
@ -36,9 +36,6 @@ java \- the Java application launcher
.fl
.fi
.LP
.RS 3
.LP
.RS 3
.TP 3
@ -56,10 +53,7 @@ Argument passed to the \f3main\fP function.
.RE
.LP
.RE
.SH "DESCRIPTION"
.LP
.LP
.LP
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.
@ -70,7 +64,7 @@ The method must be declared public and static, it must not return any value, and
.nf
\f3
.fl
public static void main(String args[])
public static void main(String args[])
.fl
\fP
.fi
@ -86,77 +80,80 @@ The Java runtime searches for the startup class, and other classes used, in thre
Non\-option arguments after the class name or JAR file name are passed to the \f3main\fP function.
.LP
.SH "OPTIONS"
.LP
.LP
.LP
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.
.LP
.SH "Standard Options"
.LP
.LP
.RS 3
.TP 3
\-client
.LP
Select the Java HotSpot Client VM. A 64\-bit capable jdk currently ignores this option and instead uses the Java Hotspot Server VM.
.LP
Select the Java HotSpot Client VM. A 64\-bit capable jdk currently ignores this option and instead uses the Java Hotspot Server VM.
.br
.br
For default VM selection, see
.na
\f2Server\-Class Machine Detection\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/vm/server\-class.html
http://download.oracle.com/javase/7/docs/technotes/guides/vm/server\-class.html
.TP 3
\-server
.LP
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.
.LP
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.
.br
.br
For default VM selection, see
.na
\f2Server\-Class Machine Detection\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/vm/server\-class.html
http://download.oracle.com/javase/7/docs/technotes/guides/vm/server\-class.html
.TP 3
\-agentlib:libname[=options]
Load native agent library \f2libname\fP, e.g.
.LP
\-agentlib:hprof
.LP
\-agentlib:jdwp=help
.LP
\-agentlib:hprof=help
.LP
Load native agent library \f2libname\fP, e.g.
.br
.br
\-agentlib:hprof
.br
.br
\-agentlib:jdwp=help
.br
.br
\-agentlib:hprof=help
.br
.br
For more information, see
.na
\f2JVMTI Agent Command Line Options\fP @
.fi
http://java.sun.com/javase/6/docs/platform/jvmti/jvmti.html#starting.
http://download.oracle.com/javase/7/docs/platform/jvmti/jvmti.html#starting.
.TP 3
\-agentpath:pathname[=options]
Load a native agent library by full pathname. For more information, see
.na
\f2JVMTI Agent Command Line Options\fP @
.fi
http://java.sun.com/javase/6/docs/platform/jvmti/jvmti.html#starting.
http://download.oracle.com/javase/7/docs/platform/jvmti/jvmti.html#starting.
.TP 3
\-classpath classpath
.TP 3
\-cp classpath
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.
.LP
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.
.br
.br
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).
.LP
.br
.br
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).
.br
.br
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.
.LP
.br
.br
For more information on class paths, see
.na
\f2Setting the Class Path\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/tools/index.html#classpath.
http://download.oracle.com/javase/7/docs/technotes/tools/index.html#classpath.
.TP 3
\-Dproperty=value
Set a system property value.
@ -164,19 +161,23 @@ Set a system property value.
\-d32
.TP 3
\-d64
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.
.LP
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.
.LP
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.
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.
.br
.br
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.
.br
.br
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.
.TP 3
\-enableassertions[:<package name>"..." | :<class name> ]
.TP 3
\-ea[:<package name>"..." | :<class name> ]
Enable assertions. Assertions are disabled by default.
.LP
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.
.LP
Enable assertions. Assertions are disabled by default.
.br
.br
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.
.br
.br
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:
.nf
\f3
@ -185,26 +186,26 @@ java \-ea:com.wombat.fruitbat... <Main Class>
.fl
\fP
.fi
.LP
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.
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.
.TP 3
\-disableassertions[:<package name>"..." | :<class name> ]
.TP 3
\-da[:<package name>"..." | :<class name> ]
Disable assertions. This is the default.
.LP
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.
.LP
Disable assertions. This is the default.
.br
.br
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.
.br
.br
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:
.nf
\f3
.fl
java \-ea:com.wombat.fruitbat... \-da:com.wombat.fruitbat.Brickbat <Main Class>
java \-ea:com.wombat.fruitbat... \-da:com.wombat.fruitbat.Brickbat \fP\f4<Main Class>\fP\f3
.fl
\fP
.fi
.LP
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.
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.
.TP 3
\-enablesystemassertions
.TP 3
@ -215,29 +216,36 @@ Enable asserts in all system classes (sets the \f2default assertion status\fP fo
.TP 3
\-dsa
Disables asserts in all system classes.
.LP
.TP 3
\-jar
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
.na
\f2Java Tutorial\fP @
.fi
http://java.sun.com/docs/books/tutorial/jar for information about working with Jar files and Jar\-file manifests.
.LP
When you use this option, the JAR file is the source of all user classes, and other user class path settings are ignored.
.LP
http://download.oracle.com/javase/tutorial/deployment/jar for information about working with Jar files and Jar\-file manifests.
.br
.br
When you use this option, the JAR file is the source of all user classes, and other user class path settings are ignored.
.br
.br
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
.na
\f2Java Archive (JAR) Files\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/jar/index.html.
http://download.oracle.com/javase/7/docs/technotes/guides/jar/index.html.
.TP 3
\-javaagent:jarpath[=options]
Load a Java programming language agent, see
.na
\f2java.lang.instrument\fP @
.fi
http://java.sun.com/javase/6/docs/api/java/lang/instrument/package\-summary.html.
http://download.oracle.com/javase/7/docs/api/java/lang/instrument/package\-summary.html.
.TP 3
\-jre\-restrict\-search
Include user\-private JREs in the version search.
.TP 3
\-no\-jre\-restrict\-search
Exclude user\-private JREs in the version search.
.TP 3
\-verbose
.TP 3
@ -254,8 +262,9 @@ Report information about use of native methods and other Java Native Interface a
Display version information and exit.
.TP 3
\-version:release
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.
.LP
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.
.br
.br
\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:
.nf
\f3
@ -264,11 +273,13 @@ Specifies that the version specified by \f2release\fP is required by the class o
.fl
\fP
.fi
The meaning of the above is that the class or jar file requires either version 1.6.0_13, or a version with 1.6 as a version\-id prefix and that is not less than 1.6.0_10.. The exact syntax and definition of version strings may be found in Appendix A of the Java Network Launching Protocol & API Specification (JSR\-56).
.LP
For jar files, the usual preference is to specify version requirements in the jar file manifest rather than on the command line.
.LP
See the following NOTES section for important policy information on the use of this option.
The meaning of the above is that the class or jar file requires either version 1.6.0_13, or a version with 1.6 as a version\-id prefix and that is not less than 1.6.0_10.. The exact syntax and definition of version strings may be found in Appendix A of the Java Network Launching Protocol & API Specification (JSR\-56).
.br
.br
For jar files, the usual preference is to specify version requirements in the jar file manifest rather than on the command line.
.br
.br
See the following NOTES section for important policy information on the use of this option.
.TP 3
\-showversion
Display version information and continue.
@ -278,6 +289,9 @@ Display version information and continue.
\-help
Display usage information and exit.
.TP 3
\-splash:imagepath
Show splash screen with image specified by \f2imagepath\fP.
.TP 3
\-X
Display information about non\-standard options and exit.
.RE
@ -285,9 +299,6 @@ Display information about non\-standard options and exit.
.LP
.SS
Non\-Standard Options
.LP
.RS 3
.LP
.RS 3
.TP 3
@ -319,18 +330,20 @@ Disable class garbage collection. Use of this option will prevent memory recover
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.
.TP 3
\-Xloggc:file
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.
.LP
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.
.LP
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.
.br
.br
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.
.TP 3
\-Xmsn
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
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
.na
\f2HotSpot Ergonomics\fP @
.fi
http://download.oracle.com/javase/7/docs/technotes/guides/vm/gc\-ergonomics.html
.br
.br
Examples:
.RS 3
.LP
.nf
\f3
.fl
@ -340,19 +353,20 @@ Examples:
.fl
\-Xms6m
.fl
.fl
\fP
.fi
.RE
.TP 3
\-Xmxn
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
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
.na
\f2HotSpot Ergonomics\fP @
.fi
http://download.oracle.com/javase/7/docs/technotes/guides/vm/gc\-ergonomics.html
.br
.br
Examples:
.RS 3
.LP
.nf
\f3
.fl
@ -362,28 +376,31 @@ Examples:
.fl
\-Xmx80m
.fl
.fl
\fP
.fi
.RE
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.
.TP 3
\-Xprof
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.
.LP
.TP 3
\-Xrs
Reduces use of operating\-system signals by the Java virtual machine (JVM).
.LP
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.
.LP
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.
.LP
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.
.LP
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.
.LP
Reduces use of operating\-system signals by the Java virtual machine (JVM).
.br
.br
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.
.br
.br
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.
.br
.br
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.
.br
.br
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.
.br
.br
There are two consequences of specifying \f3\-Xrs\fP:
.RS 3
.TP 2
@ -402,12 +419,11 @@ The VM uses \f2SIGUSR1\fP and \f2SIGUSR2\fP by default, which can sometimes conf
.RE
.LP
.RE
.SH "NOTES"
.LP
.LP
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:
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:
.LP
.RS 3
.TP 3
1.
@ -422,8 +438,7 @@ Any version greater than an arbitrarily precise version\-id. For example:
.fl
\fP
.fi
.LP
Would utilize any version greater than 1.6.0_10. This is useful for a case where an interface was introduced (or a bug fixed) in the release specified.
This would utilize any version greater than \f21.6.0_10\fP. This is useful for a case where an interface was introduced (or a bug fixed) in the release specified.
.TP 3
3.
A version greater than an arbitrarily precise version\-id, bounded by the upper bound of that release family. For example:
@ -448,9 +463,22 @@ Similar to item 2. this is useful when a change was introduced in a release (1.7
.RE
.LP
.SH "SEE ALSO"
.SH "EXIT STATUS"
.LP
.LP
The following exit values are generally returned by the launcher, typically when the launcher is called with the wrong arguments, serious errors, or exceptions thrown from the Java Virtual Machine. However, a Java application may choose to return any value using the API call \f2System.exit(exitValue)\fP.
.LP
.RS 3
.TP 2
o
\f20\fP: Successful completion
.TP 2
o
\f2>0\fP: An error occurred
.RE
.LP
.SH "SEE ALSO"
.LP
.RS 3
.TP 2
@ -470,13 +498,13 @@ o
.na
\f2The Java Extensions Framework\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/extensions/index.html
http://download.oracle.com/javase/7/docs/technotes/guides/extensions/index.html
.TP 2
o
.na
\f2Security Features\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/security/index.html.
http://download.oracle.com/javase/7/docs/technotes/guides/security/index.html.
.TP 2
o
.na

719
jdk/src/linux/doc/man/javac.1
View File

File diff suppressed because it is too large Load Diff

2289
jdk/src/linux/doc/man/javadoc.1
View File

File diff suppressed because it is too large Load Diff

26
jdk/src/linux/doc/man/javah.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1994, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1994, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,37 +19,27 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH javah 1 "02 Jun 2010"
.TH javah 1 "10 May 2011"
.LP
.SH "Name"
javah \- C Header and Stub File Generator
.LP
.RS 3
.LP
.LP
\f3javah\fP produces C header files and C source files from a Java class. These files provide the connective glue that allow your Java and C code to interact.
.LP
.RE
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
.fl
javah [ \fP\f3options\fP\f3 ] fully\-qualified\-classname. . .
.fl
javah_g [ \fP\f3options\fP\f3 ] fully\-qualified\-classname. . .
.fl
\fP
.fi
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
\f3javah\fP generates C header and source files that are needed to implement native methods. The generated header and source files are used by C programs to reference an object's instance variables from native source code. The .h file contains a struct definition whose layout parallels the layout of the corresponding class. The fields in the struct correspond to instance variables in the class.
@ -63,12 +53,7 @@ By default \f3javah\fP creates a header file for each class listed on the comman
.LP
The new native method interface, Java Native Interface (JNI), does not require header information or stub files. \f3javah\fP can still be used to generate native method function proptotypes needed for JNI\-style native methods. \f3javah\fP produces JNI\-style output by default, and places the result in the .h file.
.LP
.LP
\f3javah_g\fP is a non\-optimized version of \f3javah\fP suitable for use with debuggers like jdb(1).
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
@ -110,11 +95,10 @@ For example:
.fl
\fP
.fi
.LP
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).
.br
.br
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.
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.
.TP 3
\-bootclasspath path
Specifies path from which to load bootstrap classes. By default, the bootstrap classes are the classes implementing the core Java 2 platform located in \f2jre/lib/rt.jar\fP and several other jar files.
@ -131,8 +115,6 @@ Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the
.LP
.SH "ENVIRONMENT VARIABLES"
.LP
.LP
.RS 3
.TP 3
@ -149,8 +131,6 @@ Used to provide the system a path to user\-defined classes. Directories are sepa
.LP
.SH "SEE ALSO"
.LP
.LP
.LP
javac(1), java(1), jdb(1), javap(1), javadoc(1)

301
jdk/src/linux/doc/man/javap.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1994, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1994, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,27 +19,21 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH javap 1 "02 Jun 2010"
.TH javap 1 "10 May 2011"
.LP
.SH "Name"
javap \- The Java Class File Disassembler
.LP
.RS 3
.LP
.LP
Disassembles class files.
.LP
.RE
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
.fl
javap [ \fP\f3options\fP\f3 ] class. . .
javap [ \fP\f3options\fP\f3 ] classes
.fl
\fP
.fi
@ -47,13 +41,21 @@ javap [ \fP\f3options\fP\f3 ] class. . .
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f3javap\fP command disassembles a class file. Its output depends on the options used. If no options are used, \f3javap\fP prints out the package, protected, and public fields and methods of the classes passed to it. \f3javap\fP prints its output to stdout. For example, compile the following class declaration:
The \f3javap\fP command disassembles one or more class files. Its output depends on the options used. If no options are used, \f3javap\fP prints out the package, protected, and public fields and methods of the classes passed to it. \f3javap\fP prints its output to stdout.
.LP
.RS 3
.TP 3
options
Command\-line options.
.TP 3
classes
List of one or more classes (separated by spaces) to be processed for annotations (such as \f2DocFooter.class\fP). You may specify a class that can be found in the class path, by its file name (for example, \f2/home/user/myproject/src/DocFooter.class\fP), or with a URL (for example, \f2file:///home/user/myproject/src/DocFooter.class\fP).
.RE
.LP
.LP
For example, compile the following class declaration:
.LP
.nf
\f3
@ -96,166 +98,160 @@ public class DocFooter extends Applet {
.fl
\fP
.fi
.RE
.LP
.LP
The output from \f3javap DocFooter\fP yields:
.LP
.RS 3
The output from \f3javap DocFooter.class\fP yields:
.LP
.nf
\f3
.fl
Compiled from DocFooter.java
Compiled from "DocFooter.java"
.fl
public class DocFooter extends java.applet.Applet {
.fl
java.lang.String date;
java.lang.String date;
.fl
java.lang.String email;
java.lang.String email;
.fl
public DocFooter();
public DocFooter();
.fl
public void init();
public void init();
.fl
public void paint(java.awt.Graphics);
public void paint(java.awt.Graphics);
.fl
}
.fl
\fP
.fi
.RE
.LP
.LP
The output from \f3javap \-c DocFooter\fP yields:
.LP
.RS 3
The output from \f3javap \-c DocFooter.class\fP yields:
.LP
.nf
\f3
.fl
Compiled from DocFooter.java
Compiled from "DocFooter.java"
.fl
public class DocFooter extends java.applet.Applet {
.fl
java.lang.String date;
java.lang.String date;
.fl
java.lang.String email;
.fl
public DocFooter();
java.lang.String email;
.fl
public void init();
.fl
public void paint(java.awt.Graphics);
public DocFooter();
.fl
Code:
.fl
0: aload_0
.fl
1: invokespecial #1 // Method java/applet/Applet."<init>":()V
.fl
4: return
.fl
.fl
public void init();
.fl
Code:
.fl
0: aload_0
.fl
1: sipush 500
.fl
4: bipush 100
.fl
6: invokevirtual #2 // Method resize:(II)V
.fl
9: aload_0
.fl
10: aload_0
.fl
11: ldc #3 // String LAST_UPDATED
.fl
13: invokevirtual #4 // Method getParameter:(Ljava/lang/String;)Ljava/lang/String;
.fl
16: putfield #5 // Field date:Ljava/lang/String;
.fl
19: aload_0
.fl
20: aload_0
.fl
21: ldc #6 // String EMAIL
.fl
23: invokevirtual #4 // Method getParameter:(Ljava/lang/String;)Ljava/lang/String;
.fl
26: putfield #7 // Field email:Ljava/lang/String;
.fl
29: return
.fl
.fl
public void paint(java.awt.Graphics);
.fl
Code:
.fl
0: aload_1
.fl
1: new #8 // class java/lang/StringBuilder
.fl
4: dup
.fl
5: invokespecial #9 // Method java/lang/StringBuilder."<init>":()V
.fl
8: aload_0
.fl
9: getfield #5 // Field date:Ljava/lang/String;
.fl
12: invokevirtual #10 // Method java/lang/StringBuilder.append:(Ljava/lang/String;)Ljava/lang/StringBuilder;
.fl
15: ldc #11 // String by
.fl
17: invokevirtual #10 // Method java/lang/StringBuilder.append:(Ljava/lang/String;)Ljava/lang/StringBuilder;
.fl
20: invokevirtual #12 // Method java/lang/StringBuilder.toString:()Ljava/lang/String;
.fl
23: bipush 100
.fl
25: bipush 15
.fl
27: invokevirtual #13 // Method java/awt/Graphics.drawString:(Ljava/lang/String;II)V
.fl
30: aload_1
.fl
31: aload_0
.fl
32: getfield #7 // Field email:Ljava/lang/String;
.fl
35: sipush 290
.fl
38: bipush 15
.fl
40: invokevirtual #13 // Method java/awt/Graphics.drawString:(Ljava/lang/String;II)V
.fl
43: return
.fl
}
.fl
.fl
Method DocFooter()
.fl
0 aload_0
.fl
1 invokespecial #1 <Method java.applet.Applet()>
.fl
4 return
.fl
.fl
Method void init()
.fl
0 aload_0
.fl
1 sipush 500
.fl
4 bipush 100
.fl
6 invokevirtual #2 <Method void resize(int, int)>
.fl
9 aload_0
.fl
10 aload_0
.fl
11 ldc #3 <String "LAST_UPDATED">
.fl
13 invokevirtual #4 <Method java.lang.String getParameter(java.lang.String)>
.fl
16 putfield #5 <Field java.lang.String date>
.fl
19 aload_0
.fl
20 aload_0
.fl
21 ldc #6 <String "EMAIL">
.fl
23 invokevirtual #4 <Method java.lang.String getParameter(java.lang.String)>
.fl
26 putfield #7 <Field java.lang.String email>
.fl
29 return
.fl
.fl
Method void paint(java.awt.Graphics)
.fl
0 aload_1
.fl
1 new #8 <Class java.lang.StringBuffer>
.fl
4 dup
.fl
5 invokespecial #9 <Method java.lang.StringBuffer()>
.fl
8 aload_0
.fl
9 getfield #5 <Field java.lang.String date>
.fl
12 invokevirtual #10 <Method java.lang.StringBuffer append(java.lang.String)>
.fl
15 ldc #11 <String " by ">
.fl
17 invokevirtual #10 <Method java.lang.StringBuffer append(java.lang.String)>
.fl
20 invokevirtual #12 <Method java.lang.String toString()>
.fl
23 bipush 100
.fl
25 bipush 15
.fl
27 invokevirtual #13 <Method void drawString(java.lang.String, int, int)>
.fl
30 aload_1
.fl
31 aload_0
.fl
32 getfield #7 <Field java.lang.String email>
.fl
35 sipush 290
.fl
38 bipush 15
.fl
40 invokevirtual #13 <Method void drawString(java.lang.String, int, int)>
.fl
43 return
.fl
\fP
.fi
.RE
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
\-help
\-help \-\-help \-?
Prints out help message for \f3javap\fP.
.TP 3
\-version
Prints out version information.
.TP 3
\-l
Prints out line and local variable tables.
.TP 3
@ -268,14 +264,11 @@ Shows only protected and public classes and members.
\-package
Shows only package, protected, and public classes and members. This is the default.
.TP 3
\-private
\-private \-p
Shows all classes and members.
.TP 3
\-Jflag
Pass \f2flag\fP directly to the runtime system. Some examples:
.RS 3
.LP
.nf
\f3
.fl
@ -285,11 +278,16 @@ javap \-J\-Djava.security.manager \-J\-Djava.security.policy=MyPolicy MyClassNam
.fl
\fP
.fi
.RE
.TP 3
\-s
Prints internal type signatures.
.TP 3
\-sysinfo
Shows system information (path, size, date, MD5 hash) of the class being processed.
.TP 3
\-constants
Shows static final constants.
.TP 3
\-c
Prints out disassembled code, i.e., the instructions that comprise the Java bytecodes, for each of the methods in the class. These are documented in the
.na
@ -301,22 +299,7 @@ http://java.sun.com/docs/books/vmspec/.
Prints stack size, number of \f2locals\fP and \f2args\fP for methods.
.TP 3
\-classpath path
Specifies the path \f3javap\fP uses to look up classes. Overrides the default or the CLASSPATH environment variable if it is set. Directories are separated by colons. Thus the general format for \f2path\fP is:
.nf
\f3
.fl
.:<your_path>
.fl
\fP
.fi
For example:
.nf
\f3
.fl
.:/home/avh/classes:/usr/local/java/classes
.fl
\fP
.fi
Specifies the path \f3javap\fP uses to look up classes. Overrides the default or the CLASSPATH environment variable if it is set.
.TP 3
\-bootclasspath path
Specifies path from which to load bootstrap classes. By default, the bootstrap classes are the classes implementing the core Java platform located in \f2jre/lib/rt.jar\fP and several other jar files.
@ -325,32 +308,8 @@ Specifies path from which to load bootstrap classes. By default, the bootstrap c
Overrides location at which installed extensions are searched for. The default location for extensions is the value of \f2java.ext.dirs\fP.
.RE
.LP
.SH "ENVIRONMENT VARIABLES"
.LP
.LP
.RS 3
.TP 3
CLASSPATH
Used to provide the system a path to user\-defined classes. Directories are separated by colons, for example, For example:
.RS 3
.LP
.nf
\f3
.fl
.:/home/avh/classes:/usr/local/java/classes
.fl
\fP
.fi
.RE
.RE
.LP
.SH "SEE ALSO"
.LP
.LP
.LP
javac(1), java(1), jdb(1), javah(1), javadoc(1)

208
jdk/src/linux/doc/man/javaws.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,30 +19,18 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH javaws 1 "02 Jun 2010"
.TH javaws 1 "10 May 2011"
.LP
.SH "Name"
\f2javaws\fP Command Line
.LP
.LP
\
.LP
.SS
NAME
.LP
.RS 3
.SH "NAME"
.LP
.LP
\f2javaws\fP \- Java Web Start launcher command
.LP
.RE
.SS
SYNOPSIS
.LP
.RS 3
.SH "SYNOPSIS"
.LP
.LP
\f2javaws [run\-options] <jnlp>\fP
@ -50,49 +38,27 @@ SYNOPSIS
.LP
\f2javaws [control\-options]\fP
.LP
.RE
.SS
PARAMETERS
.LP
.RS 3
.SH "PARAMETERS"
.LP
.LP
\f2[run\-options]\fP
.LP
.RS 3
.LP
.LP
Command\-line run\-options. run\-options may be in any order. For a discussion of the various run\-options, see RUN\-OPTIONS below.
.LP
.RE
.LP
\f2<jnlp>\fP
.LP
.RS 3
.LP
.LP
This can be either the path of, or the Uniform Resource Locater (URL) of the JNLP (Java Network Launching Protocol) file.
.LP
.RE
.LP
\f2[control\-options]\fP
.LP
.RS 3
.LP
.LP
Command\-line control\-options. control\-options may be in any order. For a discussion of the various control\-options, see CONTROL\-OPTIONS below.
.LP
.RE
.RE
.SS
DESCRIPTION
.LP
.RS 3
.SH "DESCRIPTION"
.LP
.LP
The \f2javaws\fP command launches Java Web Start, which is the reference implementation of the Java Network Launching Protocol (JNLP). Java Web Start launches Java applications/applets hosted on a network.
@ -103,256 +69,154 @@ If a JNLP file is specified, \f2javaws\fP will launch the Java application/apple
.LP
The \f2javaws\fP launcher has a set of options that are supported in the current release. However, the options may be removed in a future release.
.LP
.RE
.SS
RUN\-OPTIONS
.LP
.RS 3
.SH "RUN\-OPTIONS"
.LP
.LP
\f2\-offline\fP
.LP
.RS 3
.LP
Run Java Web Start in offline mode.
.LP
run Java Web Start in offline mode.
.LP
.RE
.LP
\f2\-Xnosplash\fP
.LP
.RS 3
.LP
Do not display the initial splash screen.
.LP
disable the display of the initial splash screen.
.LP
.RE
.LP
\f2\-open <arguments>\fP
.LP
.RS 3
.LP
.LP
If specified, replaces the arguments in the jnlp file with \f2\-open <arguments>\fP.
.LP
.RE
.LP
\f2\-print <arguments>\fP
.LP
.RS 3
.LP
.LP
If specified, replaces the arguments in the jnlp file with \f2\-print <arguments>\fP.
.LP
.RE
.LP
\f2\-online\fP
.LP
.RS 3
.LP
Use online mode (default behavior).
.LP
run in online mode (default behavior).
.LP
.RE
.LP
\f2\-wait\fP
.LP
.RS 3
.LP
If specified, the \f2javaws\fP process will not exit until the application exits. This option does not function as described on Windows platforms.
.LP
If specified, the \f2javaws\fP process will not exit until the application exits.
.LP
.RE
.LP
\f2\-verbose\fP
.LP
.RS 3
.LP
Display additional output.
.LP
display additional output.
.LP
.RE
.LP
\f2\-J<option>\fP
.LP
.RS 3
.LP
Supply options to the VM.
.LP
supply options to the vm.
.LP
.RE
.LP
\f2\-system\fP
.LP
.RS 3
.LP
Run the application from the system cache only.
.LP
run the application from the system cache only.
.LP
.RE
.RE
.SS
CONTROL\-OPTIONS
.LP
.RS 3
.SH "CONTROL\-OPTIONS"
.LP
.LP
\f2\-viewer\fP
.LP
.RS 3
.LP
Show the Cache Viewer in the Java Control Panel.
.LP
.LP
show the Cache Viewer in the java control panel
\f2\-clearcache\fP
.LP
.LP
Remove all non\-installed applications from the cache.
.LP
.RE
.LP
\f2\-userConfig <property name>\fP
.LP
.RS 3
.LP
Clear the specified deployment property.
.LP
clear the specified deployment property.
.LP
.RE
.LP
\f2\-userConfig <property name> <property value>\fP
.LP
.RS 3
.LP
Set the specified deployment property to the specified value.
.LP
set the specified deployment property to the specified value.
.LP
.RE
.LP
\f2\-uninstall\fP
.LP
.RS 3
.LP
Remove all applications from the cache.
.LP
remove all applications from the cache.
.LP
.RE
.LP
\f2\-uninstall <jnlp>\fP
.LP
.RS 3
.LP
Remove the application from the cache.
.LP
remove the application from the cache.
.LP
.RE
.LP
\f2\-import [import\-options] <jnlp>\fP
.LP
.RS 3
.LP
Import the application to the cache.
.LP
import the application to the cache.
.LP
.RE
\f3IMPORT\-OPTIONS\fP
.SH "IMPORT\-OPTIONS"
.LP
.LP
\f2\-silent\fP
.LP
.RS 3
.LP
Import silently (with no user interface).
.LP
import silently (with no user interface).
.LP
.RE
.LP
\f2\-system\fP
.LP
.RS 3
.LP
Import application to the system cache.
.LP
import application to the system cache.
.LP
.RE
.LP
\f2\-codebase <url>\fP
.LP
.RS 3
.LP
Retrieve resources from the given codebase.
.LP
retrieve resources from the given codebase.
.LP
.RE
.LP
\f2\-shortcut\fP
.LP
.RS 3
.LP
Install shortcuts as if user allowed prompt. This option has no effect unless \f2\-silent\fP option is also used.
.LP
install shortcuts as if user allowed prompt. This option has no effect unless \f2\-silent\fP option is also used.
.LP
.RE
.LP
\f2\-association\fP
.LP
.RS 3
.LP
Install associations as if user allowed prompt. This option has no effect unless \f2\-silent\fP option is also used.
.LP
install associations as if user allowed prompt. This option has no effect unless \f2\-silent\fP option is also used.
.LP
.RE
.RE
.SS
FILES
.LP
.RS 3
.SH "FILES"
.LP
.LP
For information about the user and system cache and deployment.properties files, see
.na
\f2System\- and User\-Level Properties\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/deployment/deployment\-guide/properties.html.
http://download.oracle.com/javase/7/docs/technotes/guides/deployment/deployment\-guide/properties.html.
.LP
.RE
.SS
MORE INFORMATION
.LP
.RS 3
.SH "MORE INFORMATION"
.LP
.LP
For more information about Java Web Start, see
.na
\f2Java Web Start\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/javaws/index.html.
http://download.oracle.com/javase/7/docs/technotes/guides/javaws/index.html.
.LP
.RS 3
.LP
.LP
\
.LP
.RE
.RE

50
jdk/src/linux/doc/man/jconsole.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,15 +19,13 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jconsole 1 "02 Jun 2010"
.TH jconsole 1 "10 May 2011"
.LP
.SH "Name"
jconsole \- Java Monitoring and Management Console
.LP
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -40,41 +38,40 @@ jconsole \- Java Monitoring and Management Console
.LP
.SH "PARAMETERS"
.LP
.LP
.RS 3
.TP 3
options
Options, if used, should follow immediately after the command name.
.br
.TP 3
connection = pid | host:port | jmxUrl
.RS 3
\f2pid\fP\ \ \ Process ID of a local Java VM. The Java VM must be running with the same user ID as the user ID running jconsole. See
.TP 2
o
\f2pid\fP Process ID of a local Java VM. The Java VM must be running with the same user ID as the user ID running jconsole. See
.na
\f2JMX Monitoring and Management\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/management/agent.html for details.
.br
\f2host\fP:\f2port\fP\ \ Name of the host system on which the Java VM is running and the port number specified by the system property \f2com.sun.management.jmxremote.port\fP when the Java VM was started. See
http://download.oracle.com/javase/7/docs/technotes/guides/management/agent.html for details.
.TP 2
o
\f2host\fP:\f2port\fP Name of the host system on which the Java VM is running and the port number specified by the system property \f2com.sun.management.jmxremote.port\fP when the Java VM was started. See
.na
\f2JMX Monitoring and Management\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/management/agent.html for details.
.br
\f2jmxUrl\fP\ \ Address of the JMX agent to be connected to as described in
http://download.oracle.com/javase/7/docs/technotes/guides/management/agent.html for details.
.TP 2
o
\f2jmxUrl\fP Address of the JMX agent to be connected to as described in
.na
\f2JMXServiceURL\fP @
.fi
http://java.sun.com/javase/6/docs/api/javax/management/remote/JMXServiceURL.html.
http://download.oracle.com/javase/7/docs/api/javax/management/remote/JMXServiceURL.html.
.RE
.RE
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f3jconsole\fP command launches a graphical console tool that enables you to monitor and manage Java applications and virtual machines on a local or remote machine.
@ -83,18 +80,16 @@ The \f3jconsole\fP command launches a graphical console tool that enables you to
On Windows, \f3jconsole\fP does not associate with a console window. It will, however, display a dialog box with error information if the \f3jconsole\fP command fails for some reason.
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
\-interval=n
Set the update interval to \f2n\fP seconds (default is 4 seconds).
.TP 3
\-notile\
\-notile
Do not tile windows initially (for two or more connections).
.TP 3
\-pluginpath\ plugins
\-pluginpath plugins
Specify a list of directories or JAR files which are searched for JConsole plugins. The \f2plugins\fP path should contain a provider\-configuration file named:
.br
.nf
@ -104,20 +99,19 @@ Specify a list of directories or JAR files which are searched for JConsole plugi
.fl
\fP
.fi
.LP
containing one line for each plugin specifying the fully qualified class name of the class implementing the
.na
\f2com.sun.tools.jconsole.JConsolePlugin\fP @
.fi
http://java.sun.com/javase/6/docs/jdk/api/jconsole/spec/com/sun/tools/jconsole/JConsolePlugin.html class.
http://download.oracle.com/javase/7/docs/jdk/api/jconsole/spec/com/sun/tools/jconsole/JConsolePlugin.html class.
.TP 3
\-version\
\-version
Output version information and exit.
.TP 3
\-help\
\-help
Output help message and exit.
.TP 3
\-J<flag>\
\-J<flag>
Pass <flag> to the Java virtual machine on which jconsole is run.
.RE
@ -130,13 +124,13 @@ o
.na
\f2Using JConsole\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/management/jconsole.html
http://download.oracle.com/javase/7/docs/technotes/guides/management/jconsole.html
.TP 2
o
.na
\f2Monitoring and Management for Java Platform\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/management/index.html
http://download.oracle.com/javase/7/docs/technotes/guides/management/index.html
.RE
.LP

74
jdk/src/linux/doc/man/jdb.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1995, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1995, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,22 +19,16 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jdb 1 "02 Jun 2010"
.TH jdb 1 "10 May 2011"
.LP
.SH "Name"
jdb \- The Java Debugger
.LP
.RS 3
.LP
.LP
\f3jdb\fP helps you find and fix bugs in Java language programs.
.LP
.RE
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -43,9 +37,6 @@ jdb \- The Java Debugger
.fl
.fi
.LP
.RS 3
.LP
.RS 3
.TP 3
@ -60,23 +51,17 @@ Arguments passed to the \f2main()\fP method of \f2class\fP.
.RE
.LP
.RE
.SH "DESCRIPTION"
.LP
.LP
.LP
The Java Debugger, \f3jdb\fP, is a simple command\-line debugger for Java classes. It is a demonstration of the
.na
\f2Java Platform Debugger Architecture\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/jpda/index.html that provides inspection and debugging of a local or remote Java Virtual Machine.
http://download.oracle.com/javase/7/docs/technotes/guides/jpda/index.html that provides inspection and debugging of a local or remote Java Virtual Machine.
.LP
.SS
Starting a jdb Session
.LP
.RS 3
.LP
.LP
There are many ways to start a jdb session. The most frequently used way is to have \f3jdb\fP launch a new Java Virtual Machine (VM) with the main class of the application to be debugged. This is done by substituting the command \f3jdb\fP for \f3java\fP in the command line. For example, if your application's main class is MyClass, you use the following command to debug it under JDB:
@ -137,7 +122,7 @@ There are many other ways to connect the debugger to a VM, and all of them are s
.na
\f2documentation\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/jpda/conninv.html on these connection options. For information on starting a J2SE 1.4.2 or early VM for use with \f3jdb\fP see the
http://download.oracle.com/javase/7/docs/technotes/guides/jpda/conninv.html on these connection options. For information on starting a J2SE 1.4.2 or early VM for use with \f3jdb\fP see the
.na
\f21.4.2 documentation\fP @
.fi
@ -148,9 +133,6 @@ Basic jdb Commands
.LP
.LP
The following is a list of the basic \f3jdb\fP commands. The Java debugger supports other commands which you can list using \f3jdb\fP's \f2help\fP command.
.LP
.RS 3
.LP
.RS 3
.TP 3
@ -164,10 +146,12 @@ cont
Continues execution of the debugged application after a breakpoint, exception, or step.
.TP 3
print
Displays Java objects and primitive values. For variables or fields of primitive types, the actual value is printed. For objects, a short description is printed. See the \f2dump\fP command below for getting more information about an object.
.LP
\f2NOTE: To display local variables, the containing class must have been compiled with the \fP\f2javac(1)\fP\f2 \fP\f2\-g\fP option.
.LP
Displays Java objects and primitive values. For variables or fields of primitive types, the actual value is printed. For objects, a short description is printed. See the \f2dump\fP command below for getting more information about an object.
.br
.br
\f2NOTE: To display local variables, the containing class must have been compiled with the \fP\f2javac(1)\fP\f2 \fP\f2\-g\fP option.
.br
.br
\f2print\fP supports many simple Java expressions including those with method invocations, for example:
.RS 3
.TP 2
@ -188,15 +172,13 @@ o
.RE
.TP 3
dump
For primitive values, this command is identical to \f2print\fP. For objects, it prints the current value of each field defined in the object. Static and instance fields are included.
.LP
The \f2dump\fP command supports the same set of expressions as the \f2print\fP command.
For primitive values, this command is identical to \f2print\fP. For objects, it prints the current value of each field defined in the object. Static and instance fields are included.
.br
.br
The \f2dump\fP command supports the same set of expressions as the \f2print\fP command.
.TP 3
threads
List the threads that are currently running. For each thread, its name and current status are printed, as well as an index that can be used for other commands, for example:
.RS 3
.LP
.nf
\f3
.fl
@ -204,25 +186,21 @@ List the threads that are currently running. For each thread, its name and curre
.fl
\fP
.fi
.RE
In this example, the thread index is 4, the thread is an instance of java.lang.Thread, the thread name is "main", and it is currently running,
.TP 3
thread
Select a thread to be the current thread. Many \f3jdb\fP commands are based on the setting of the current thread. The thread is specified with the thread index described in the \f2threads\fP command above.
.TP 3
where
\f2where\fP with no arguments dumps the stack of the current thread. \f2where all\fP dumps the stack of all threads in the current thread group. \f2where\fP \f2threadindex\fP dumps the stack of the specified thread.
.LP
If the current thread is suspended (either through an event such as a breakpoint or through the \f2suspend\fP command), local variables and fields can be displayed with the \f2print\fP and \f2dump\fP commands. The \f2up\fP and \f2down\fP commands select which stack frame is current.
\f2where\fP with no arguments dumps the stack of the current thread. \f2where all\fP dumps the stack of all threads in the current thread group. \f2where\fP \f2threadindex\fP dumps the stack of the specified thread.
.br
.br
If the current thread is suspended (either through an event such as a breakpoint or through the \f2suspend\fP command), local variables and fields can be displayed with the \f2print\fP and \f2dump\fP commands. The \f2up\fP and \f2down\fP commands select which stack frame is current.
.RE
.LP
.RE
.SS
Breakpoints
.LP
.RS 3
.LP
.LP
Breakpoints can be set in \f3jdb\fP at line numbers or at the first instruction of a method, for example:
@ -249,22 +227,14 @@ If a method is overloaded, you must also specify its argument types so that the
.LP
The \f2clear\fP command removes breakpoints using a syntax as in "\f2clear\ MyClass:45\fP". Using the \f2clear\fP or command with no argument displays a list of all breakpoints currently set. The \f2cont\fP command continues execution.
.LP
.RE
.SS
Stepping
.LP
.RS 3
.LP
.LP
The \f2step\fP commands advances execution to the next line whether it is in the current stack frame or a called method. The \f2next\fP command advances execution to the next line in the current stack frame.
.LP
.RE
.SS
Exceptions
.LP
.RS 3
.LP
.LP
When an exception occurs for which there isn't a catch statement anywhere in the throwing thread's call stack, the VM normally prints an exception trace and exits. When running under \f3jdb\fP, however, control returns to \f3jdb\fP at the offending throw. You can then use \f3jdb\fP to diagnose the cause of the exception.
@ -278,11 +248,7 @@ The \f2ignore\fP command negates the effect of a previous \f2catch\fP command.
.LP
\f2NOTE: The \fP\f2ignore\fP command does not cause the debugged VM to ignore specific exceptions, only the debugger.
.LP
.RE
.RE
.SH "Command Line Options"
.LP
.LP
.LP
When you use \f3jdb\fP in place of the Java application launcher on the command line, \f3jdb\fP accepts many of the same options as the java command, including \f2\-D\fP, \f2\-classpath\fP, and \f2\-X<option>\fP.
@ -335,7 +301,7 @@ Other options are supported for alternate mechanisms for connecting the debugger
.na
\f2documentation\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/jpda/conninv.html on these connection alternatives.
http://download.oracle.com/javase/7/docs/technotes/guides/jpda/conninv.html on these connection alternatives.
.LP
.SS
Options Forwarded to Debuggee Process
@ -357,8 +323,6 @@ Non\-standard target VM option
.LP
.SH "SEE ALSO"
.LP
.LP
.LP
javac(1), java(1), javah(1), javap(1), javadoc(1).

33
jdk/src/linux/doc/man/jhat.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2006, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2006, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,15 +19,13 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jhat 1 "02 Jun 2010"
.TH jhat 1 "10 May 2011"
.LP
.SH "Name"
jhat \- Java Heap Analysis Tool
.LP
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -40,18 +38,18 @@ jhat \- Java Heap Analysis Tool
.LP
.SH "PARAMETERS"
.LP
.LP
.RS 3
.TP 3
options
Options, if used, should follow immediately after the command name.
.br
.TP 3
heap\-dump\-file
Java binary heap dump file to be browsed. For a dump file that contains multiple heap dumps, you may specify which dump in the file by appending "#<number> to the file name, i.e. "foo.hprof#3".
.SH "DESCRIPTION"
.RE
.LP
.SH "DESCRIPTION"
.LP
.LP
The \f3jhat\fP command parses a java heap dump file and launches a webserver. jhat enables you to browse heap dumps using your favorite webbrowser. jhat supports pre\-designed queries (such as 'show all instances of a known class "Foo"') as well as \f3OQL\fP (\f3O\fPbject \f3Q\fPuery \f3L\fPanguage) \- a SQL\-like query language to query heap dumps. Help on OQL is available from the OQL help page shown by jhat. With the default port, OQL help is available at http://localhost:7000/oqlhelp/
@ -69,7 +67,7 @@ Use jconsole(1) option to obtain a heap dump via
.na
\f2HotSpotDiagnosticMXBean\fP @
.fi
http://java.sun.com/javase/6/docs/jre/api/management/extension/com/sun/management/HotSpotDiagnosticMXBean.html at runtime;
http://download.oracle.com/javase/7/docs/jre/api/management/extension/com/sun/management/HotSpotDiagnosticMXBean.html at runtime;
.TP 2
o
Heap dump will be generated when OutOfMemoryError is thrown by specifying \-XX:+HeapDumpOnOutOfMemoryError VM option;
@ -86,7 +84,8 @@ http://java.sun.com/developer/technicalArticles/Programming/HPROF.html.
.LP
\f3NOTE:\fP This tool is \f3experimental\fP and may \f3not\fP be available in future versions of the JDK.
.LP
.SH "OPTIONS"
.SH "OPTIONS"
.LP
.RS 3
.TP 3
\-stack false/true
@ -107,21 +106,22 @@ Specify a baseline heap dump. Objects in both heap dumps with the same object ID
\-debug int
Set debug level for this tool. 0 means no debug output. Set higher values for more verbose modes.
.TP 3
\-version\
\-version
Report version number and exit.
.TP 3
\-h\
\-h
Output help message and exit.
.TP 3
\-help\
\-help
Output help message and exit.
.TP 3
\-J<flag>\
\-J<flag>
Pass <flag> to the Java virtual machine on which jhat is run. For example, \-J\-Xmx512m to use a maximum heap size of 512MB.
.RE
.LP
.SH "SEE ALSO"
.SH "SEE ALSO"
.LP
.RS 3
.TP 2
o
@ -136,5 +136,6 @@ o
.fi
http://java.sun.com/developer/technicalArticles/Programming/HPROF.html
.RE
.RE
.LP

31
jdk/src/linux/doc/man/jinfo.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,15 +19,13 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jinfo 1 "02 Jun 2010"
.TH jinfo 1 "10 May 2011"
.LP
.SH "Name"
jinfo \- Configuration Info
.LP
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -42,55 +40,56 @@ jinfo \- Configuration Info
.LP
.SH "PARAMETERS"
.LP
.LP
.RS 3
.TP 3
option
Options are mutually exclusive. Option, if used, should follow immediately after the command name.
.RE
.LP
.RS 3
.TP 3
pid
process id for which the configuration info is to be printed. The process must be a Java process. To get a list of Java processes running on a machine, jps(1) may be used.
.RE
.LP
.RS 3
.TP 3
executable
Java executable from which the core dump was produced.
.RE
.LP
.RS 3
.TP 3
core
core file for which the configuration info is to be printed.
.RE
.LP
.RS 3
.TP 3
remote\-hostname\-or\-IP
remote debug server's (see jsadebugd(1)) hostname or IP address.
.RE
.LP
.RS 3
.TP 3
server\-id
optional unique id, if multiple debug servers are running on the same remote host.
.RE
.RE
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
\f3jinfo\fP prints Java configuration information for a given Java process or core file or a remote debug server. Configuration information includes Java System properties and Java virtual machine command line flags. If the given process is running on a 64\-bit VM, you may need to specify the \f2\-J\-d64\fP option, e.g.:
.br
.LP
.RS 3
.LP
jinfo \-J\-d64 \-sysprops pid
.RE
.LP
.LP
\f3NOTE \- This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' need to be installed to have these tools working. Also, \fP\f4PATH\fP\f3 environment variable should contain the location of \fP\f4jvm.dll\fP\f3 used by the target process or the location from which the Crash Dump file was produced.\fP
.LP
@ -98,8 +97,6 @@ jinfo \-J\-d64 \-sysprops pid
\f3For example, \fP\f4set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3

22
jdk/src/linux/doc/man/jmap.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,15 +19,13 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jmap 1 "02 Jun 2010"
.TH jmap 1 "10 May 2011"
.LP
.SH "Name"
jmap \- Memory Map
.LP
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -42,8 +40,6 @@ jmap \- Memory Map
.LP
.SH "PARAMETERS"
.LP
.LP
.RS 3
.TP 3
@ -73,14 +69,9 @@ optional unique id, if multiple debug servers are running on the same remote hos
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
\f3jmap\fP prints shared object memory maps or heap memory details of a given process or core file or a remote debug server. If the given process is running on a 64\-bit VM, you may need to specify the \f2\-J\-d64\fP option, e.g.:
.LP
.RS 3
.LP
.nf
\f3
@ -89,10 +80,11 @@ jmap \-J\-d64 \-heap pid
.fl
\fP
.fi
.RE
.LP
\f3NOTE \- This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' needs to be installed to have these tools working. Also, \fP\f4PATH\fP\f3 environment variable should contain the location of \fP\f4jvm.dll\fP\f3 used by the target process or the location from which the Crash Dump file was produced.\fP
.LP
\f3NOTE: This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' needs to be installed to have these tools working. Also, \fP\f4PATH\fP\f3 environment variable should contain the location of \fP\f4jvm.dll\fP\f3 used by the target process or the location from which the Crash Dump file was produced.\fP
.LP
.LP
\f3For example, \fP\f4set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP
.LP
@ -100,13 +92,11 @@ jmap \-J\-d64 \-heap pid
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
<no option>
When no option is used \f3jmap\fP prints shared object mappings. For each shared object loaded in the target VM, start address, the size of the mapping, and the full path of the shared object file are printed. This is similar to the Solaris \f3pmap\fP utility.
When no option is used jmap prints shared object mappings. For each shared object loaded in the target VM, start address, the size of the mapping, and the full path of the shared object file are printed. This is similar to the Solaris \f3pmap\fP utility.
.br
.TP 3
\-dump:[live,]format=b,file=<filename>

20
jdk/src/linux/doc/man/jps.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,15 +19,13 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jps 1 "02 Jun 2010"
.TH jps 1 "10 May 2011"
.LP
.SH "Name"
jps \- Java Virtual Machine Process Status Tool
.LP
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -40,8 +38,6 @@ jps \- Java Virtual Machine Process Status Tool
.LP
.SH "PARAMETERS"
.LP
.LP
.RS 3
.TP 3
@ -54,8 +50,6 @@ The host identifier of the host for which the process report should be generated
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f3jps\fP tool lists the instrumented HotSpot Java Virtual Machines (JVMs) on the target system. The tool is limited to reporting information on JVMs for which it has the access permissions.
@ -76,8 +70,6 @@ The list of JVMs produced by the \f3jps\fP command may be limited by the permiss
\f3NOTE:\fP This utility is unsupported and may not be available in future versions of the JDK. It is not currently available on Windows 98 and Windows ME platforms.
.LP
.SH "OPTIONS"
.LP
.LP
.LP
The \f3jps\fP command supports a number of options that modify the output of the command. These options are subject to change or removal in the future.
@ -106,9 +98,6 @@ Pass \f2option\fP to the \f3java\fP launcher called by \f3jps\fP. For example, \
.LP
.SS
HOST IDENTIFIER
.LP
.RS 3
.LP
.LP
The host identifier, or \f2hostid\fP is a string that indicates the target system. The syntax of the \f2hostid\fP string largely corresponds to the syntax of a URI:
@ -140,10 +129,7 @@ The treatment of this parameter depends on the implementation. For the optimized
.RE
.LP
.RE
.SH "OUTPUT FORMAT"
.LP
.LP
.LP
The output of the \f3jps\fP command follows the following pattern:
@ -168,8 +154,6 @@ Where all output tokens are separated by white space. An \f2arg\fP that includes
.LP
.SH "EXAMPLES"
.LP
.LP
.LP
This section provides examples of the \f3jps\fP command.

64
jdk/src/linux/doc/man/jrunscript.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2006, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2006, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,15 +19,13 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jrunscript 1 "02 Jun 2010"
.TH jrunscript 1 "10 May 2011"
.LP
.SH "Name"
jrunscript \- command line script shell
.LP
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -38,8 +36,6 @@ jrunscript \- command line script shell
.LP
.SH "PARAMETERS"
.LP
.LP
.RS 3
.TP 3
@ -52,8 +48,6 @@ Arguments, if used, should follow immediately after options or command name.
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
\f3jrunscript\fP is a command line script shell. jrunscript supports both an interactive (read\-eval\-print) mode and a batch (\-f option) mode of script execution. This is a scripting language independent shell. By default, JavaScript is the language used, but the \-l option can be used to specify a different language. Through Java to scripting language communication, jrunscript supports "exploratory programming" style.
@ -62,8 +56,6 @@ Arguments, if used, should follow immediately after options or command name.
\f3NOTE:\fP This tool is \f3experimental\fP and may \f3not\fP be available in future versions of the JDK.
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
@ -112,10 +104,8 @@ If [arguments...] are present and if no \f3\-e\fP or \f3\-f\fP option is used, t
.LP
.SH "EXAMPLES"
.LP
\f3Executing inline scripts\fP
.LP
.RS 3
.SS
Executing inline scripts
.LP
.nf
\f3
@ -126,13 +116,10 @@ jrunscript \-e "cat('http://java.sun.com')"
.fl
\fP
.fi
.RE
.LP
\f3Use specified language and evaluate given script file\fP
.LP
.RS 3
.SS
Use specified language and evaluate given script file
.LP
.nf
\f3
@ -141,42 +128,42 @@ jrunscript \-l js \-f test.js
.fl
\fP
.fi
.RE
.LP
\f3Interactive mode\fP
.LP
.RS 3
.SS
Interactive mode
.LP
.nf
\f3
.fl
jrunscript
.fl
js>print('hello world');
js> print('Hello World\\n');
.fl
hello world
Hello World
.fl
js>34 + 55
js> 34 + 55
.fl
89
89.0
.fl
js> thread(function() { print('hello world'); }
js> t = new java.lang.Thread(function() { print('Hello World\\n'); })
.fl
hello world
Thread[Thread\-0,5,main]
.fl
js> t.start()
.fl
js> Hello World
.fl
.fl
js>
.fl
\fP
.fi
.RE
.LP
\f3Run script file with script arguments\fP
.LP
.RS 3
.SS
Run script file with script arguments
.LP
.nf
\f3
@ -185,13 +172,16 @@ jrunscript test.js arg1 arg2 arg3
.fl
\fP
.fi
.RE
.LP
test.js is script file to execute and arg1, arg2 and arg3 are passed to script as script arguments. Script can access these using "arguments" array.
.SH "SEE ALSO"
.LP
.LP
If JavaScript is used, then before evaluating any user defined script, jrunscript initializes certain built\-in functions and objects. These JavaScript built\-ins are documented in jsdocs.
If JavaScript is used, then before evaluating any user defined script, jrunscript initializes certain built\-in functions and objects. These JavaScript built\-ins are documented in
.na
\f2jsdocs\fP @
.fi
http://download.oracle.com/javase/7/docs/technotes/tools/share/jsdocs/allclasses\-noframe.html.
.LP

39
jdk/src/linux/doc/man/jsadebugd.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,15 +19,13 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jsadebugd 1 "02 Jun 2010"
.TH jsadebugd 1 "10 May 2011"
.LP
.SH "Name"
jsadebugd \- Serviceability Agent Debug Daemon
.LP
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -40,36 +38,17 @@ jsadebugd \- Serviceability Agent Debug Daemon
.LP
.SH "PARAMETERS"
.LP
.LP
.RS 3
.TP 3
pid
process id of the process to which the debug server should attach. The process must be a Java process. To get a list of Java processes running on a machine, jps(1) may be used. At most one instance of the debug server may be attached to a single process.
.RE
.LP
.RS 3
.TP 3
executable
.RE
.LP
.RS 3
.TP 3
Java executable from which the core dump was produced
.RE
.LP
.RS 3
.TP 3
core
Core file to which the debug server should attach.
.RE
.LP
.RS 3
.TP 3
server\-id
Optional unique id, needed if multiple debug servers are started on the same machine. This ID must be used by remote clients to identify the particular debug server to attach. Within a single machine, this ID must be unique.
@ -77,18 +56,13 @@ Optional unique id, needed if multiple debug servers are started on the same mac
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
\f3jsadebugd\fP attaches to a Java process or core file and acts as a debug server. Remote clients such as jstack(1), jmap(1), and jinfo(1) can attach to the server using Java Remote Method Invocation (RMI). Before starting \f2jsadebugd\fP,
.na
\f2rmiregistry\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/tools/index.html#rmi must be started with:
.LP
.RS 3
http://download.oracle.com/javase/7/docs/technotes/tools/index.html#rmi must be started with:
.LP
.nf
\f3
@ -97,17 +71,16 @@ http://java.sun.com/javase/6/docs/technotes/tools/index.html#rmi must be started
.fl
\fP
.fi
.RE
.LP
.LP
where \f2$JAVA_HOME\fP is the JDK installation directory. If rmiregistry was not started, jsadebugd will start an rmiregistry in a standard (1099) port internally. Debug server may be stopped by sending SIGINT (pressing Ctrl\-C) to it.
.LP
.LP
\f3NOTE \- This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' needs to be installed to have these tools working. Also, \fP\f4PATH\fP\f3 environment variable should contain the location of \fP\f4jvm.dll\fP\f3 used by the target process or the location from which the Crash Dump file was produced.\fP
\f3NOTE\fP \- This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' needs to be installed to have these tools working. Also, \f2PATH\fP environment variable should contain the location of \f2jvm.dll\fP used by the target process or the location from which the Crash Dump file was produced.
.LP
.LP
\f3For example, \fP\f4set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP
For example, \f2set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP
.LP
.SH "SEE ALSO"
.LP
@ -129,7 +102,7 @@ o
.na
\f2rmiregistry\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/tools/index.html#rmi
http://download.oracle.com/javase/7/docs/technotes/tools/index.html#rmi
.RE
.LP

20
jdk/src/linux/doc/man/jstack.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,7 +19,7 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jstack 1 "02 Jun 2010"
.TH jstack 1 "10 May 2011"
.LP
.SH "Name"
@ -28,8 +28,6 @@ jstack \- Stack Trace
.LP
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -44,8 +42,6 @@ jstack \- Stack Trace
.LP
.SH "PARAMETERS"
.LP
.LP
.LP
Options are mutually exclusive. Option, if used, should follow immediately after the command name. See OPTIONS.
@ -77,16 +73,11 @@ optional unique id, if multiple debug servers are running on the same remote hos
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
\f3jstack\fP prints Java stack traces of Java threads for a given Java process or core file or a remote debug server. For each Java frame, the full class name, method name, 'bci' (byte code index) and line number, if available, are printed. With the \-m option, jstack prints both Java and native frames of all threads along with the 'pc' (program counter). For each native frame, the closest native symbol to 'pc', if available, is printed. C++ mangled names are not demangled. To demangle C++ names, the output of this command may be piped to \f3c++filt\fP. If the given process is running on a 64\-bit VM, you may need to specify the \f2\-J\-d64\fP option, e.g.:
.br
.LP
.RS 3
.LP
.nf
\f3
@ -95,7 +86,6 @@ jstack \-J\-d64 \-m pid
.fl
\fP
.fi
.RE
.LP
.LP
@ -105,8 +95,6 @@ jstack \-J\-d64 \-m pid
For example, \f2set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
@ -118,7 +106,7 @@ Long listing. Prints additional information about locks such as list of owned ja
.na
\f2ownable synchronizers\fP @
.fi
http://java.sun.com/javase/6/docs/api/java/util/concurrent/locks/AbstractOwnableSynchronizer.html.
http://download.oracle.com/javase/7/docs/api/java/util/concurrent/locks/AbstractOwnableSynchronizer.html.
.TP 3
\-m
prints mixed mode (both Java and native C/C++ frames) stack trace.
@ -153,8 +141,6 @@ jsadebugd(1)
.LP
.SH "KNOWN BUGS"
.LP
.LP
.LP
Mixed mode stack trace, the \-m option, does not work with the remote debug server.

118
jdk/src/linux/doc/man/jstat.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,15 +19,13 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jstat 1 "02 Jun 2010"
.TH jstat 1 "10 May 2011"
.LP
.SH "Name"
jstat \- Java Virtual Machine Statistics Monitoring Tool
.LP
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -38,8 +36,6 @@ jstat \- Java Virtual Machine Statistics Monitoring Tool
.LP
.SH "PARAMETERS"
.LP
.LP
.RS 3
.TP 3
@ -60,16 +56,14 @@ Virtual machine identifier, a string indicating the target Java virtual machine
The syntax of the vmid string largely corresponds to the syntax of a URI. The \f2vmid\fP can vary from a simple integer representing a local JVM to a more complex construction specifying a communications protocol, port number, and other implementation\-specific values. See Virtual Machine Identifier for details.
.TP 3
interval[s|ms]
Sampling interval in the specified units, seconds (s) or milliseconds (ms). Default units are milliseconds.\ Must be a positive integer.\ If specified, \f3jstat\fP will produce its output at each interval.
Sampling interval in the specified units, seconds (s) or milliseconds (ms). Default units are milliseconds. Must be a positive integer. If specified, \f3jstat\fP will produce its output at each interval.
.TP 3
count
Number of samples to display. Default value is infinity; that is, \f3jstat\fP displays statistics until the target JVM terminates or the \f3jstat\fP command is terminated.\ Must be a positive integer.
Number of samples to display. Default value is infinity; that is, \f3jstat\fP displays statistics until the target JVM terminates or the \f3jstat\fP command is terminated. Must be a positive integer.
.RE
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f3jstat\fP tool displays performance statistics for an instrumented HotSpot Java virtual machine (JVM). The target JVM is identified by its virtual machine identifier, or \f2vmid\fP option described below.
@ -81,9 +75,6 @@ The \f3jstat\fP tool displays performance statistics for an instrumented HotSpot
.LP
.SS
VIRTUAL MACHINE IDENTIFIER
.LP
.RS 3
.LP
.LP
The syntax of the \f2vmid\fP string largely corresponds to the syntax of a URI:
@ -115,10 +106,7 @@ The treatment of this parameter depends on implementation. For the optimized loc
.RE
.LP
.RE
.SH "OPTIONS"
.LP
.LP
.LP
The \f3jstat\fP command supports two types of options, general options and output options. General options cause \f3jstat\fP to display simple usage and version information. Output options determine the content and format of the statistical output.
@ -150,14 +138,11 @@ Display list of statistics options. See the Output Options section below.
.SS
OUTPUT OPTIONS
.LP
.RS 3
.LP
If you do not specify a general option, then you can specify output options. Output options determine the content and format of \f3jstat\fP's output, and consist of a single \f2statOption\fP, plus any of the other output options (\-h, \-t, and \-J). The \f2statOption\fP must come first.
.LP
.LP
If you do not specify a general option, then you can specify output options. Output options determine the content and format of \f3jstat\fP's output, and consist of a single \f2statOption\fP, plus any of the other output options (\-h, \-t, and \-J).\ The \f2statOption\fP must come first.
.LP
.LP
Output is formatted as a table, with columns are separated by spaces. A header row with titles describes the columns.\ Use the \f3\-h\fP option to set the frequency at which the header is displayed.\ Column header names are generally consistent between the different options. In general, if two options provide a column with the same name, then the data source for the two columns are the same.
Output is formatted as a table, with columns are separated by spaces. A header row with titles describes the columns. Use the \f3\-h\fP option to set the frequency at which the header is displayed. Column header names are generally consistent between the different options. In general, if two options provide a column with the same name, then the data source for the two columns are the same.
.LP
.LP
Use the \f3\-t\fP option to display a time stamp column, labeled \f2Timestamp\fP as the first column of output. The \f2Timestamp\fP column contains the elapsed time, in seconds, since startup of the target JVM. The resolution of the time stamp is dependent on various factors and is subject to variation due to delayed thread scheduling on heavily loaded systems.
@ -171,11 +156,10 @@ Use the \f2interval\fP and \f2count\fP parameters to determine how frequently an
.RS 3
.TP 3
\-statOption
Determines the statistics information that \f3jstat\fP displays. The following table lists the available options.\ Use the \f3\-options\fP general option to display the list of options for a particular platform installation.
Determines the statistics information that \f3jstat\fP displays. The following table lists the available options. Use the \f3\-options\fP general option to display the list of options for a particular platform installation.
.br
.br
.LP
.TS
.if \n+(b.=1 .nr d. \n(.c-\n(c.-1
.de 35
.ps \n(.s
@ -457,7 +441,7 @@ HotSpot compilation method statistics.
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 230 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 215 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -683,7 +667,6 @@ HotSpot compilation method statistics.
.rm j+
.rm k+
.rm l+
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-52
.TP 3
\-h n
@ -697,12 +680,8 @@ Pass \f2javaOption\fP to the \f3java\fP application launcher. For example, \f3\-
.RE
.LP
.RE
.SS
STATOPTIONS AND OUTPUT
.LP
.RS 3
.LP
.LP
The following tables summarize the columns that \f3jstat\fP outputs for each \f2statOption\fP.
@ -713,7 +692,6 @@ The following tables summarize the columns that \f3jstat\fP outputs for each \f2
\-class Option
.LP
.LP
.TS
.if \n+(b.=1 .nr d. \n(.c-\n(c.-1
.de 35
.ps \n(.s
@ -825,7 +803,7 @@ Time spent performing class load and unload operations.
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 280 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 261 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -910,7 +888,6 @@ Time spent performing class load and unload operations.
.rm a+
.rm b+
.rm c+
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-21
.LP
@ -918,7 +895,6 @@ Time spent performing class load and unload operations.
\-compiler Option
.LP
.LP
.TS
.if \n+(b.=1 .nr d. \n(.c-\n(c.-1
.de 35
.ps \n(.s
@ -1082,7 +1058,7 @@ Class name and method for the last failed compilation.
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 316 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 297 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -1210,7 +1186,6 @@ Class name and method for the last failed compilation.
.rm d+
.rm e+
.rm f+
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-29
.LP
@ -1218,7 +1193,6 @@ Class name and method for the last failed compilation.
\-gc Option
.LP
.LP
.TS
.if \n+(b.=1 .nr d. \n(.c-\n(c.-1
.de 35
.ps \n(.s
@ -1546,7 +1520,7 @@ Total garbage collection time.
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 386 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 367 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -1814,7 +1788,6 @@ Total garbage collection time.
.rm l+
.rm m+
.rm n+
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-63
.LP
@ -1822,7 +1795,6 @@ Total garbage collection time.
\-gccapacity Option
.LP
.LP
.TS
.if \n+(b.=1 .nr d. \n(.c-\n(c.-1
.de 35
.ps \n(.s
@ -2170,7 +2142,7 @@ Number of Young generation GC Events.
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 460 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 441 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -2455,7 +2427,6 @@ Number of Young generation GC Events.
.rm m+
.rm n+
.rm o+
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-67
.LP
@ -2466,7 +2437,6 @@ Number of Young generation GC Events.
This option displays the same summary of garbage collection statistics as the \f3\-gcutil\fP option, but includes the causes of the last garbage collection event and (if applicable) the current garbage collection event. In addition to the columns listed for \f3\-gcutil\fP, this option adds the following columns:
.LP
.LP
.TS
.if \n+(b.=1 .nr d. \n(.c-\n(c.-1
.de 35
.ps \n(.s
@ -2550,7 +2520,7 @@ Cause of current Garbage Collection.
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 483 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 464 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -2610,7 +2580,6 @@ Cause of current Garbage Collection.
.35
.rm a+
.rm b+
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-13
.LP
@ -2618,7 +2587,6 @@ Cause of current Garbage Collection.
\-gcnew Option
.LP
.LP
.TS
.if \n+(b.=1 .nr d. \n(.c-\n(c.-1
.de 35
.ps \n(.s
@ -2866,7 +2834,7 @@ Young generation garbage collection time.
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 537 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 518 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -3066,7 +3034,6 @@ Young generation garbage collection time.
.rm h+
.rm i+
.rm j+
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-47
.LP
@ -3074,7 +3041,6 @@ Young generation garbage collection time.
\-gcnewcapacity Option
.LP
.LP
.TS
.if \n+(b.=1 .nr d. \n(.c-\n(c.-1
.de 35
.ps \n(.s
@ -3094,15 +3060,14 @@ Young generation garbage collection time.
.rm 80 81
.nr 34 \n(.lu
.eo
.am 80
.am 81
.br
.di a+
.35
.ft \n(.f
.ll \n(34u*1u/3u
.if \n(.l<\n(80 .ll \n(80u
.if \n(.l<\n(81 .ll \n(81u
.in 0
NGCMN\ \ \ \ \ \ \ \ \ T}~T{
Minimum new generation capacity (KB).
.br
.di
@ -3262,9 +3227,11 @@ Number of young generation GC events.
.if \n(80<\n(38 .nr 80 \n(38
.nr 38 \w\f3Column\fP
.if \n(80<\n(38 .nr 80 \n(38
.nr 38 \wNGCMX \ \ \
.nr 38 \wNGCMN
.if \n(80<\n(38 .nr 80 \n(38
.nr 38 \wNGC \ \ \
.nr 38 \wNGCMX
.if \n(80<\n(38 .nr 80 \n(38
.nr 38 \wNGC
.if \n(80<\n(38 .nr 80 \n(38
.nr 38 \wS0CMX
.if \n(80<\n(38 .nr 80 \n(38
@ -3284,8 +3251,6 @@ Number of young generation GC events.
.if \n(80<\n(38 .nr 80 \n(38
.80
.rm 80
.nr 38 \n(a-
.if \n(80<\n(38 .nr 80 \n(38
.nr 81 0
.nr 38 \w\f3Description\fP
.if \n(81<\n(38 .nr 81 \n(38
@ -3293,6 +3258,8 @@ Number of young generation GC events.
.if \n(81<\n(38 .nr 81 \n(38
.81
.rm 81
.nr 38 \n(a-
.if \n(81<\n(38 .nr 81 \n(38
.nr 38 \n(b-
.if \n(81<\n(38 .nr 81 \n(38
.nr 38 \n(c-
@ -3321,7 +3288,7 @@ Number of young generation GC events.
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 593 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 572 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -3348,11 +3315,11 @@ Number of young generation GC events.
.ta \n(80u \n(81u
.nr 31 \n(.f
.nr 35 1m
\&\h'|\n(40u'\h'|\n(41u'
\&\h'|\n(40u'NGCMN\h'|\n(41u'
.mk ##
.nr 31 \n(##
.sp |\n(##u-1v
.nr 37 \n(40u
.nr 37 \n(41u
.in +\n(37u
.a+
.in -\n(37u
@ -3364,7 +3331,7 @@ Number of young generation GC events.
.ta \n(80u \n(81u
.nr 31 \n(.f
.nr 35 1m
\&\h'|\n(40u'NGCMX \ \ \\h'|\n(41u'
\&\h'|\n(40u'NGCMX\h'|\n(41u'
.mk ##
.nr 31 \n(##
.sp |\n(##u-1v
@ -3380,7 +3347,7 @@ Number of young generation GC events.
.ta \n(80u \n(81u
.nr 31 \n(.f
.nr 35 1m
\&\h'|\n(40u'NGC \ \ \\h'|\n(41u'
\&\h'|\n(40u'NGC\h'|\n(41u'
.mk ##
.nr 31 \n(##
.sp |\n(##u-1v
@ -3521,15 +3488,13 @@ Number of young generation GC events.
.rm h+
.rm i+
.rm j+
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-49
.if \n-(b.=0 .nr c. \n(.c-\n(d.-47
.LP
.SS
\-gcold Option
.LP
.LP
.TS
.if \n+(b.=1 .nr d. \n(.c-\n(c.-1
.de 35
.ps \n(.s
@ -3717,7 +3682,7 @@ Total garbage collection time.
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 635 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 614 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -3866,7 +3831,6 @@ Total garbage collection time.
.rm e+
.rm f+
.rm g+
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-35
.LP
@ -3874,7 +3838,6 @@ Total garbage collection time.
\-gcoldcapacity Option
.LP
.LP
.TS
.if \n+(b.=1 .nr d. \n(.c-\n(c.-1
.de 35
.ps \n(.s
@ -4062,7 +4025,7 @@ Total garbage collection time.
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 677 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 656 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -4211,7 +4174,6 @@ Total garbage collection time.
.rm e+
.rm f+
.rm g+
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-35
.LP
@ -4219,7 +4181,6 @@ Total garbage collection time.
\-gcpermcapacity Option
.LP
.LP
.TS
.if \n+(b.=1 .nr d. \n(.c-\n(c.-1
.de 35
.ps \n(.s
@ -4407,7 +4368,7 @@ Total garbage collection time.
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 719 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 698 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -4556,7 +4517,6 @@ Total garbage collection time.
.rm e+
.rm f+
.rm g+
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-35
.LP
@ -4564,7 +4524,6 @@ Total garbage collection time.
\-gcutil Option
.LP
.LP
.TS
.if \n+(b.=1 .nr d. \n(.c-\n(c.-1
.de 35
.ps \n(.s
@ -4792,7 +4751,7 @@ Total garbage collection time.
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 769 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 748 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -4975,7 +4934,6 @@ Total garbage collection time.
.rm g+
.rm h+
.rm i+
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-43
.LP
@ -4983,7 +4941,6 @@ Total garbage collection time.
\-printcompilation Option
.LP
.LP
.TS
.if \n+(b.=1 .nr d. \n(.c-\n(c.-1
.de 35
.ps \n(.s
@ -5091,7 +5048,7 @@ Class name and method name identifying the compiled method. Class name uses "/"
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 795 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 774 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -5172,14 +5129,10 @@ Class name and method name identifying the compiled method. Class name uses "/"
.rm a+
.rm b+
.rm c+
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-19
.LP
.SS
.LP
.SH ""
.SH "EXAMPLES"
.LP
.LP
This section presents some examples of monitoring a local JVM with a \f2lvmid\fP of 21891.
@ -5355,7 +5308,6 @@ This example attaches to \f2lvmid\fP 40496 on the system named \f2remote.domain\
.LP
The \f2lvmid\fP is combined with the name of the remote host to construct a \f2vmid\fP of \f240496@remote.domain\fP. This \f2vmid\fP results in the use of the \f3rmi\fP protocol to communicate to the default \f3jstatd\fP server on the remote host. The \f3jstatd\fP server is located using the \f3rmiregistry\fP on \f2remote.domain\fP that is bound to the default \f3rmiregistry\fP port (port 1099).
.LP
.RE
.SH "SEE ALSO"
.LP
.RS 3

22
jdk/src/linux/doc/man/jstatd.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,15 +19,13 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jstatd 1 "02 Jun 2010"
.TH jstatd 1 "10 May 2011"
.LP
.SH "Name"
jstatd \- Virtual Machine jstat Daemon
.LP
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -41,8 +39,6 @@ jstatd [ \fP\f4options\fP\f3 ]\fP
.LP
.SH "PARAMETERS"
.LP
.LP
.RS 3
.TP 3
@ -52,8 +48,6 @@ Command\-line options. The options may be in any order. If there are redundant o
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f3jstatd\fP tool is an RMI server application that monitors for the creation and termination of instrumented HotSpot Java virtual machines (JVMs) and provides a interface to allow remote monitoring tools to attach to JVMs running on the local host.
@ -65,8 +59,6 @@ The \f3jstatd\fP server requires the presence of an RMI registry on the local ho
\f3NOTE:\fP This utility is unsupported and may or may not be available in future versions of the JDK. It is not currently available on the Windows 98 and Windows ME platforms.
.LP
.SH "OPTIONS"
.LP
.LP
.LP
The \f3jstatd\fP command supports the following options:
@ -88,8 +80,6 @@ Pass \f2option\fP to the \f3java\fP launcher called by \f3javac\fP. For example,
.LP
.SH "SECURITY"
.LP
.LP
.LP
The \f3jstatd\fP server can only monitor JVMs for which it has the appropriate native access permissions. Therefor the \f3jstatd\fP process must be running with the same user credentials as the target JVMs. Some user credentials, such as the \f2root\fP user in UNIX(TM) based systems, have permission to access the instrumentation exported by any JVM on the system. A \f3jstatd\fP process running with such credentials can monitor any JVM on the system, but introduces additional security concerns.
@ -102,7 +92,7 @@ The \f3jstatd\fP server installs an instance of RMISecurityPolicy if no other se
.na
\f2Policy File Syntax\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/security/PolicyFiles.html.
http://download.oracle.com/javase/7/docs/technotes/guides/security/PolicyFiles.html.
.LP
.LP
The following policy file will allow the \f3jstatd\fP server to run without any security exceptions. This policy is less liberal then granting all permissions to all codebases, but is more liberal than a policy that grants the minimal permissions to run the \f3jstatd\fP server.
@ -144,15 +134,11 @@ jstatd \-J\-Djava.security.policy=jstatd.all.policy\fP
For sites with more restrictive security practices, it is possible to use a custom policy file to limit access to specific trusted hosts or networks, though such techniques are subject to IP addreess spoofing attacks. If your security concerns cannot be addressed with a customized policy file, then the safest action is to not run the \f3jstatd\fP server and use the \f3jstat\fP and \f3jps\fP tools locally.
.LP
.SH "REMOTE INTERFACE"
.LP
.LP
.LP
The interface exported by the \f3jstatd\fP process is proprietary and is guaranteed to change. Users and developers are discouraged from writing to this interface.
.LP
.SH "EXAMPLES"
.LP
.LP
.LP
Here are some examples of starting \f3jstatd\fP. Note that the \f3jstatd\fP scripts automatically start the server in the background.
@ -264,7 +250,7 @@ o
.na
\f2rmiregistry\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/tools/index.html#rmi \- the Java Remote Object Registry
http://download.oracle.com/javase/7/docs/technotes/tools/index.html#rmi \- the Java Remote Object Registry
.RE
.LP

104
jdk/src/linux/doc/man/jvisualvm.1 Normal file
View File

@ -0,0 +1,104 @@
." Copyright (c) 2008, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
." under the terms of the GNU General Public License version 2 only, as
." published by the Free Software Foundation.
."
." This code is distributed in the hope that it will be useful, but WITHOUT
." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
." version 2 for more details (a copy is included in the LICENSE file that
." accompanied this code).
."
." You should have received a copy of the GNU General Public License version
." 2 along with this work; if not, write to the Free Software Foundation,
." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
."
." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jvisualvm 1 "10 May 2011"
.LP
.SH "Name"
\f2jvisualvm\fP \- Java Virtual Machine Monitoring, Troubleshooting, and Profiling Tool
.LP
.SH "SYNOPSIS"
.LP
.nf
\f3
.fl
\fP\f3jvisualvm\fP [ \f2options\fP ]
.fl
.fi
.LP
.SH "PARAMETERS"
.LP
.LP
Options, if used, should follow immediately after the command name. Options may be in any order. For a discussion of parameters that apply to a specific option, see OPTIONS below.
.LP
.SH "DESCRIPTION"
.LP
.LP
Java VisualVM is an intuitive graphical user interface that provides detailed information about Java technology\-based applications (Java applications) while they are running on a given Java Virtual Machine (JVM(*)). The name Java VisualVM comes from the fact that Java VisualVM provides information about the JVM software \f2visually\fP.
.LP
.LP
Java VisualVM combines several monitoring, troubleshooting, and profiling utilities into a single tool. For example, most of the functionality offered by the standalone tools \f2jmap\fP, \f2jinfo\fP, \f2jstat\fP and \f2jstack\fP have been integrated into Java VisualVM. Other functionalities, such as some of those offered by the JConsole tool, can be added as optional plug\-ins.
.LP
.SH "OPTIONS"
.LP
.LP
The following option is possible when you launch Java VisualVM.
.LP
.RS 3
.TP 3
\-J<jvm_option>\
Pass this \f2<jvm_option>\fP to the JVM software.
.RE
.LP
.SH "USAGE"
.LP
.LP
Java VisualVM is useful to Java application developers to troubleshoot applications and to monitor and improve the applications' performance. Java VisualVM can allow developers to generate and analyse heap dumps, track down memory leaks, perform and monitor garbage collection, and perform lightweight memory and CPU profiling. Plug\-ins also exist that expand the functionality of Java VisualVM. For example, most of the functionality of the JConsole tool is available via the MBeans Tab and JConsole Plug\-in Wrapper plug\-ins. You can choose from a catalog of standard Java VisualVM plug\-ins by selecting 'Tools' | 'Plugins' in the Java VisualVM menus.
.LP
.LP
Start Java VisualVM with the following command:
.LP
.nf
\f3
.fl
% jvisualvm \fP\f4<options>\fP\f3
.fl
\fP
.fi
.LP
.SH "SEE ALSO"
.LP
.LP
For more details about Java VisualVM see the following pages.
.LP
.RS 3
.TP 2
o
.na
\f2Java VisualVM developers' site\fP @
.fi
http://visualvm.java.net
.TP 2
o
.na
\f2Java VisualVM in Java SE platform documentation\fP @
.fi
http://download.oracle.com/javase/7/docs/technotes/guides/visualvm/index.html
.RE
.LP
.LP
\f2(* The terms "Java Virtual Machine" and "JVM" mean a Virtual Machine for the Java platform.)\fP
.LP

1004
jdk/src/linux/doc/man/keytool.1
View File

File diff suppressed because it is too large Load Diff

26
jdk/src/linux/doc/man/native2ascii.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,22 +19,16 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH native2ascii 1 "02 Jun 2010"
.TH native2ascii 1 "10 May 2011"
.LP
.SH "Name"
native2ascii \- Native\-to\-ASCII Converter
.LP
.RS 3
.LP
Converts a file with characters in any supported character encoding to one with ASCII and/or Unicode escapes, or visa versa.
.LP
Converts a file with native\-encoded characters (characters which are non\-Latin 1 and non\-Unicode) to one with Unicode\-encoded characters.
.LP
.RE
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -46,31 +40,29 @@ Converts a file with native\-encoded characters (characters which are non\-Latin
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The Java compiler and other Java tools can only process files which contain Latin\-1 and/or Unicode\-encoded (\\udddd notation) characters. \f2native2ascii\fP converts files which contain other character encodings into files containing Latin\-1 and/or Unicode\-encoded charaters.
\f2native2ascii\fP converts files that are encoded to any character encoding that is supported by the Java runtime environment to files encoded in ASCII, using Unicode escapes ("\\uxxxx" notation) for all characters that are not part of the ASCII character set. This process is required for properties files containing characters not in ISO\-8859\-1 character sets. The tool can also perform the reverse conversion.
.LP
.LP
If \f2outputfile\fP is omitted, standard output is used for output. If, in addition, \f2inputfile\fP is omitted, standard input is used for input.
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
\-reverse
Perform the reverse operation: convert a file with Latin\-1 and/or Unicode encoded characters to one with native\-encoded characters.
Perform the reverse operation: Convert a file encoded in ISO\-8859\-1 with Unicode escapes to a file in any character encoding supported by the Java runtime environment.
.br
.br
.TP 3
\-encoding encoding_name
Specify the encoding name which is used by the conversion procedure. The default encoding is taken from System property \f2file.encoding\fP. The \f2encoding_name\fP string must be taken from the first column of the table of supported encodings in the
Specifies the name of the character encoding to be used by the conversion procedure. If this option is not present, the default character encoding (as determined by the \f2java.nio.charset.Charset.defaultCharset\fP method) is used. The \f2encoding_name\fP string must be the name of a character encoding that is supported by the Java runtime environment \- see the
.na
\f4Supported Encodings\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/intl/encoding.doc.html document.
http://download.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html document.
.br
.br
.TP 3
\-Joption
Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for the java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes.

26
jdk/src/linux/doc/man/orbd.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2001, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,14 +19,11 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH orbd 1 "02 Jun 2010"
.TH orbd 1 "10 May 2011"
.LP
.SH "Name"
orbd \- The Object Request Broker Daemon
.LP
.RS 3
.LP
.LP
\f3orbd\fP is used to enable clients to transparently locate and invoke persistent objects on servers in the CORBA environment.
@ -36,12 +33,9 @@ orbd \- The Object Request Broker Daemon
.na
\f2Naming Service\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/idl/jidlNaming.html
http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html
.LP
.RE
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -53,8 +47,6 @@ orbd <\fP\f3options\fP\f3>
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The Server Manager included with the \f3orbd\fP tool is used to enable clients to transparently locate and invoke persistent objects on servers in the CORBA environment. The persistent servers, while publishing the persistent object references in the Naming Service, include the port number of the ORBD in the object reference instead of the port number of the Server. The inclusion of an ORBD port number in the object reference for persistent object references has the following advantages:
@ -77,7 +69,7 @@ When \f2orbd\fP starts up, it also starts a naming service. For more information
.na
\f2Naming Service\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/idl/jidlNaming.html.
http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html.
.LP
.SH "OPTIONS"
.LP
@ -141,11 +133,11 @@ A Naming Service is a CORBA service that allows
.na
\f2CORBA objects\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/idl/jidlGlossary.html#CORBA%20object to be named by means of binding a name to an object reference. The
http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlGlossary.html#CORBA%20object to be named by means of binding a name to an object reference. The
.na
\f2name binding\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/idl/jidlGlossary.html#name%20binding may be stored in the naming service, and a client may supply the name to obtain the desired object reference.
http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlGlossary.html#name%20binding may be stored in the naming service, and a client may supply the name to obtain the desired object reference.
.LP
.LP
Prior to running a client or a server, you will start ORBD. ORBD includes a persistent Naming Service and a transient Naming Service, both of which are an implementation of the COS Naming Service.
@ -224,7 +216,7 @@ For more information on the Naming Service included with ORBD, see
.na
\f2Naming Service\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/idl/jidlNaming.html.
http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html.
.LP
.SH "Server Manager"
.LP
@ -239,7 +231,7 @@ Using the
.na
\f2sample tutorial\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/idl/jidlExample.html for our demonstration, you would run the \f2idlj\fP compiler and \f2javac\fP compiler as shown in the tutorial. To run the Server Manager, follow these steps for running the application:
http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlExample.html for our demonstration, you would run the \f2idlj\fP compiler and \f2javac\fP compiler as shown in the tutorial. To run the Server Manager, follow these steps for running the application:
.LP
.LP
Start \f2orbd\fP.
@ -362,7 +354,7 @@ o
.na
\f2Naming Service\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/idl/jidlNaming.html
http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html
.br
.TP 2
o

134
jdk/src/linux/doc/man/pack200.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,24 +19,19 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH pack200 1 "02 Jun 2010"
.TH pack200 1 "10 May 2011"
.LP
.SH "Name"
pack200 \- JAR Packing tool
.LP
.SH "SYNOPSIS"
.LP
.LP
.LP
\f4pack200\fP\f2 [ \fP\f2options\fP ] \f2output\-file\fP \f2JAR\-file\fP
.LP
.LP
Options may be in any order. The last option on the command line or in a properties file supersedes all previously specified options.
.LP
.RS 3
.LP
.RS 3
.TP 3
@ -51,10 +46,7 @@ Name of the input file.
.RE
.LP
.RE
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f2pack200\fP tool is a Java application that transforms a JAR file into a compressed \f2pack200\fP file using the Java \f2gzip\fP compressor. The \f2pack200\fP files are highly compressed files that can be directly deployed, saving bandwidth and reducing download time.
@ -64,32 +56,20 @@ The \f2pack200\fP tool uses several options to fine\-tune and set the compressio
.LP
.SS
Typical usage:
.LP
.RS 3
.LP
.LP
\f2% pack200 myarchive.pack.gz myarchive.jar\fP
.LP
.RE
.LP
In this example, \f2myarchive.pack.gz\fP is produced using the default \f2pack200\fP settings.
.LP
.SH "OPTIONS"
.LP
.LP
.LP
\f4\-r \-\-repack\fP
.LP
.RS 3
.LP
.LP
Produces a JAR file by packing the file \f2myarchive.jar\fP and unpacking it. The resulting file can be used as an input to the \f2jarsigner(1)\fP tool.
.LP
.RS 3
.LP
.LP
\f2% pack200 \-\-repack myarchive\-packer.jar myarchive.jar\fP
@ -97,50 +77,35 @@ Produces a JAR file by packing the file \f2myarchive.jar\fP and unpacking it. Th
.LP
\f2% pack200 \-\-repack myarchive.jar\fP
.LP
.RE
.RE
.LP
\f4\-g \-\-no\-gzip\fP
.LP
.RS 3
.LP
.LP
Produces a \f2pack200\fP file. With this option a suitable compressor must be used, and the target system must use a corresponding decompresser.
.LP
.RS 3
.LP
.LP
\f2% pack200 \-\-no\-gzip myarchive.pack myarchive.jar\fP
.LP
.RE
.RE
.LP
\f4\-G \-\-strip\-debug\fP
.LP
.RS 3
.LP
.LP
Strips attributes used for debugging from the output. These include \f2SourceFile\fP, \f2LineNumberTable\fP, \f2LocalVariableTable\fP and \f2LocalVariableTypeTable\fP. Removing these attributes reduces the size of both downloads and installations but reduces the usefulness of debuggers.
.LP
.RE
.LP
\f4\-\-keep\-file\-order\fP
.LP
.LP
Preserve the order of files in the input file; this is the default behavior.
.LP
.LP
\f4\-O \-\-no\-keep\-file\-order\fP
.LP
.RS 3
.LP
.LP
The packer will reorder and transmit all elements. Additionally, the packer may remove JAR directory names. This will reduce the download size; however, certain JAR file optimizations, such as indexing, may not work correctly.
.LP
.RE
.LP
\f4\-Svalue \-\-segment\-limit=\fP\f2value\fP
.LP
.RS 3
.LP
.LP
The value is the estimated target size N (in bytes) of each archive segment. If a single input file requires
@ -151,17 +116,13 @@ more than N bytes, it will be given its own archive segment. As a special case,
The size of each segment is estimated by counting the size of each input file to be transmitted in the segment, along with the size of its name and other transmitted properties.
.LP
.LP
The default is \f21000000\fP (a million bytes). This allows input JAR files of moderate size to be transmitted in one segment. It also puts a limit on memory requirements for packers and unpackers.
The default is \-1, which means the packer will always create a single segment output file. In cases where extremely large output files are generated, users are strongly encouraged to use segmenting or break up the input file into smaller JARs.
.LP
.LP
A 10MB JAR packed without this limit will typically pack about 10% smaller, but the packer may require a larger Java heap (about ten times the segment limit).
.LP
.RE
.LP
\f4\-Evalue \-\-effort=\fP\f2value\fP
.LP
.RS 3
.LP
.LP
If the value is set to a single decimal digit, the packer will use the indicated amount of effort in compressing the archive. Level \f21\fP may produce somewhat larger size and faster compression speed, while level \f29\fP will take much longer but may produce better compression. The special value \f20\fP instructs the packer to copy through the original JAR file directly with no compression. The JSR 200 standard requires any unpacker to understand this special case as a pass\-through of the entire archive.
@ -169,12 +130,8 @@ If the value is set to a single decimal digit, the packer will use the indicated
.LP
The default is \f25\fP, investing a modest amount of time to produce reasonable compression.
.LP
.RE
.LP
\f4\-Hvalue \-\-deflate\-hint=\fP\f2value\fP
.LP
.RS 3
.LP
.LP
Overrides the default, which preserves the input information, but may cause the transmitted archive to be larger. The possible values are:
@ -195,12 +152,8 @@ Preserve deflation hints observed in the input JAR. (This is the default.)
.RE
.LP
.RE
.LP
\f4\-mvalue \-\-modification\-time=\fP\f2value\fP
.LP
.RS 3
.LP
.LP
The possible values are:
@ -215,22 +168,14 @@ Preserves modification times observed in the input JAR. (This is the default.)
.RE
.LP
.RE
.LP
\f4\-Pfile \-\-pass\-file=\fP\f2file\fP
.LP
.RS 3
.LP
.LP
Indicates that a file should be passed through bytewise with no compression. By repeating the option, multiple files may be specified. There is no pathname transformation, except that the system file separator is replaced by the JAR file separator "\f2/\fP". The resulting file names must match exactly as strings with their occurrences in the JAR file. If file is a directory name, all files under that directory will be passed.
.LP
.RE
.LP
\f4\-Uaction \-\-unknown\-attribute=\fP\f2action\fP
.LP
.RS 3
.LP
.LP
Overrides the default behavior; i.e., the classfile containing the unknown attribute will be passed through with the specified action. The possible values for actions are:
@ -248,7 +193,6 @@ Upon encountering this attribute, the entire class will be transmitted as though
.RE
.LP
.RE
.LP
\f4\-Cattribute\-name=\fP\f2layout\fP \f3\-\-class\-attribute=\fP\f2attribute\-name=action\fP
.br
@ -257,9 +201,6 @@ Upon encountering this attribute, the entire class will be transmitted as though
\f4\-Mattribute\-name=\fP\f2layout\fP \f3\-\-method\-attribute=\fP\f2attribute\-name=action\fP
.br
\f4\-Dattribute\-name=\fP\f2layout\fP \f3\-\-code\-attribute=\fP\f2attribute\-name=action\fP
.LP
.RS 3
.LP
.LP
With the above four options, the attribute layout can be specified for a class entity, such as Class attribute, Field attribute, Method attribute, and Code attribute. The attribute\-name is the name of the attribute for which the layout or action is being defined. The possible values for action are:
@ -282,18 +223,11 @@ Upon encountering this attribute, the attribute will be removed from the output.
.LP
Example: \f2\-\-class\-attribute=CompilationID=pass\fP will cause the class file containing this attribute to be passed through without further action by the packer.
.LP
.RE
.LP
\f4\-f\fP\f2 \fP\f2pack.properties\fP \f3\-\-config\-file=\fP\f2pack.properties\fP
.LP
.RS 3
.LP
.LP
A configuration file, containing Java properties to initialize the packer, may be specified on the command line.
.LP
.RS 3
.LP
.LP
\f2% pack200 \-f pack.properties myarchive.pack.gz myarchive.jar\fP
@ -317,62 +251,47 @@ A configuration file, containing Java properties to initialize the packer, may b
\f2# Change the segment limit to be unlimited.\fP
.br
\f2segment.limit=\-1\fP
.LP
.RE
.RE
.RS 3
.LP
.LP
\f4\-v \-\-verbose\fP
.LP
.RS 3
.LP
.LP
Outputs minimal messages. Multiple specification of this option will output more verbose messages.
.LP
.RE
.LP
\f4\-q \-\-quiet\fP
.LP
.RS 3
.LP
.LP
Specifies quiet operation with no messages.
.LP
.RE
.LP
\f4\-lfilename \-\-log\-file=\fP\f2filename\fP
.LP
.RS 3
.LP
.LP
Specifies a log file to output messages.
.LP
.RE
.LP
\f4\-Joption\fP
.LP
.RS 3
\f4\-? \-h \-\-help\fP
.LP
.LP
Passes option to the Java launcher called by \f2pack200\fP. For example, \f2\-J\-Xms48m\fP sets the startup memory to 48 megabytes. Although it does not begin with \f2\-X\fP, it is not a standard option of \f2pack200\fP. It is a common convention for \f2\-J\fP to pass options to the underlying VM executing applications written in Java.
Prints help information about this command.
.LP
.LP
\f4\-V \-\-version\fP
.LP
.LP
Prints version information about this command.
.LP
.LP
\f4\-J\fP\f2option\fP
.LP
.LP
Passes \f2option\fP to the Java launcher called by \f2pack200\fP. For example, \f2\-J\-Xms48m\fP sets the startup memory to 48 megabytes. Although it does not begin with \f2\-X\fP, it is not a standard option of \f2pack200\fP. It is a common convention for \f2\-J\fP to pass options to the underlying VM executing applications written in Java.
.LP
.RE
.RE
.SH "EXIT STATUS"
.LP
.LP
.LP
The following exit values are returned:
.LP
.RS 3
.LP
.LP
\f2\ 0\fP for successful completion;
@ -380,7 +299,6 @@ The following exit values are returned:
.LP
\f2>0\fP if an error occurs.
.LP
.RE
.SH "SEE ALSO"
.LP
.RS 3
@ -392,13 +310,13 @@ o
.na
\f2Java SE Documentation\fP @
.fi
http://java.sun.com/javase/6/docs/index.html
http://download.oracle.com/javase/7/docs/index.html
.TP 2
o
.na
\f2Java Deployment Guide \- Pack200\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/deployment/deployment\-guide/pack200.html
http://download.oracle.com/javase/7/docs/technotes/guides/deployment/deployment\-guide/pack200.html
.TP 2
o
jar(1) \- Java Archive Tool
@ -412,8 +330,6 @@ o
.LP
.SH "NOTES"
.LP
.LP
.LP
This command should not be confused with \f2pack(1)\fP. They are distinctly separate products.

16
jdk/src/linux/doc/man/policytool.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2001, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,7 +19,7 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH policytool 1 "02 Jun 2010"
.TH policytool 1 "10 May 2011"
.LP
.SH "Name"
@ -27,8 +27,6 @@ policytool \- PolicyTool Administration GUI Utility
.LP
\f3policytool\fP reads and writes a plain text policy file based on user input via the utility GUI.
.SH "SYNOPSIS"
.LP
.LP
.RS 3
.TP 3
@ -57,7 +55,7 @@ The file name
.na
\f2the Policytool Users Guide\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/security/PolicyGuide.html.
http://download.oracle.com/javase/7/docs/technotes/guides/security/PolicyGuide.html.
.SH "OPTIONS"
.RS 3
.TP 3
@ -67,22 +65,22 @@ Loads \f2filename\fP.
.na
\f2Default Policy Implementation and Syntax\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/security/PolicyFiles.html
http://download.oracle.com/javase/7/docs/technotes/guides/security/PolicyFiles.html
.br
.na
\f2Policy Tool Users' Guide\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/security/PolicyGuide.html
http://download.oracle.com/javase/7/docs/technotes/guides/security/PolicyGuide.html
.br
.na
\f2Security Permissions\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/security/permissions.html
http://download.oracle.com/javase/7/docs/technotes/guides/security/permissions.html
.br
.na
\f2Security Overview\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/security/overview/jsoverview.html
http://download.oracle.com/javase/7/docs/technotes/guides/security/overview/jsoverview.html
.br
.RE
.RE

73
jdk/src/linux/doc/man/rmic.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,22 +19,16 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH rmic 1 "02 Jun 2010"
.TH rmic 1 "10 May 2011"
.LP
.SH "Name"
rmic \- The Java RMI Compiler
.LP
.RS 3
.LP
.LP
\f3rmic\fP generates stub, skeleton, and tie classes for remote objects using either the JRMP or IIOP protocols. Also generates OMG IDL.
.LP
.RE
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -46,8 +40,6 @@ rmic [ \fP\f3options\fP\f3 ] \fP\f4package\-qualified\-class\-name(s)\fP\f3
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f3rmic\fP compiler generates stub and skeleton class files (JRMP protocol) and stub and tie class files (IIOP protocol) for remote objects. These classes files are generated from compiled Java programming language classes that are remote object implementation classes. A remote implementation class is a class that implements the interface \f2java.rmi.Remote\fP. The class names in the \f3rmic\fP command must be for classes that have been compiled successfully with the \f3javac\fP command and must be fully package qualified. For example, running \f3rmic\fP on the class file name \f2HelloImpl\fP as shown here:
@ -80,8 +72,6 @@ By default, \f3rmic\fP generates stub classes that use the 1.2 JRMP stub protoco
A stub implements only the remote interfaces, not any local interfaces that the remote object also implements. Because a JRMP stub implements the same set of remote interfaces as the remote object itself, a client can use the Java programming language's built\-in operators for casting and type checking. For IIOP, the \f2PortableRemoteObject.narrow\fP method must be used.
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
@ -90,9 +80,6 @@ Overrides location of bootstrap class files
.TP 3
\-classpath path
Specifies the path \f3rmic\fP uses to look up classes. This option overrides the default or the CLASSPATH environment variable if it is set. Directories are separated by colons. Thus the general format for \f2path\fP is:
.RS 3
.LP
.nf
\f3
.fl
@ -100,11 +87,7 @@ Specifies the path \f3rmic\fP uses to look up classes. This option overrides the
.fl
\fP
.fi
.RE
For example:
.RS 3
.LP
.nf
\f3
.fl
@ -112,13 +95,9 @@ For example:
.fl
\fP
.fi
.RE
.TP 3
\-d directory
Specifies the root destination directory for the generated class hierarchy. You can use this option to specify a destination directory for the stub, skeleton, and tie files. For example, the command
.RS 3
.LP
.nf
\f3
.fl
@ -126,7 +105,6 @@ Specifies the root destination directory for the generated class hierarchy. You
.fl
\fP
.fi
.RE
would place the stub and skeleton classes derived from \f2MyClass\fP into the directory \f2/java/classes/foo\fP. If the \f2\-d\fP option is not specified, the default behavior is as if \f2"\-d\ ."\fP were specified: the package hierarchy of the target class is created in the current directory, and stub/tie/skeleton files are placed within it. (Note that in some previous versions of \f3rmic\fP, if \f2\-d\fP was not specified, then the package hierarchy was \f2not\fP created, and all of the output files were placed directly in the current directory.)
.br
\
@ -136,16 +114,16 @@ Overrides location of installed extensions
.TP 3
\-g
Enables generation of all debugging information, including local variables. By default, only line number information is generated.
.LP
.TP 3
\-idl
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
.na
\f2Java Language to IDL Mapping\fP @
.fi
http://www.omg.org/technology/documents/formal/java_language_mapping_to_omg_idl.htm (OMG) document for a complete description.
.LP
When the \f2\-idl\fP option is used, other options also include:
http://www.omg.org/technology/documents/formal/java_language_mapping_to_omg_idl.htm (OMG) document for a complete description.
.br
.br
When the \f2\-idl\fP option is used, other options also include:
.RS 3
.TP 3
\-always or \-alwaysgenerate
@ -160,31 +138,22 @@ Specifies IDLEntity package mapping. For example:\ \f2\-idlModule foo.bar my::r
\-idlFile\ fromJavaPackage[.class]\ toIDLFile
Specifies IDLEntity file mapping. For example:\ \f2\-idlFile test.pkg.X TEST16.idl\fP.\
.RE
.LP
.TP 3
\-iiop
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.
.LP
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.
.br
.br
Invoking \f2rmic\fP with the \f2\-iiop\fP generates stubs and ties that conform to this naming convention:
.RS 3
.LP
.nf
\f3
.fl
_<implementationName>_stub.class
.fl
\fP
.br
\f3
.fl
_<interfaceName>_tie.class
.fl
\fP
.fi
.RE
.LP
When the \f2\-iiop\fP option is used, other options also include:
When the \f2\-iiop\fP option is used, other options also include:
.RS 3
.TP 3
\-always or \-alwaysgenerate
@ -197,13 +166,11 @@ Do not create stubs optimized for same\-process clients and servers.
Must be used with the \f2\-idl\fP option. Prevents addition of \f2valuetype\fP methods and initializers to emitted IDL. These methods and initializers are optional for \f2valuetype\fPs, and are generated unless the \f2\-noValueMethods\fP option is specified when using the \f2\-idl\fP option.
.TP 3
\-poa
Changes the inheritance from \f2org.omg.CORBA_2_3.portable.ObjectImpl\fP to \f2org.omg.PortableServer.Servant\fP.
.LP
The \f2PortableServer\fP module for the
Changes the inheritance from \f2org.omg.CORBA_2_3.portable.ObjectImpl\fP to \f2org.omg.PortableServer.Servant\fP. The \f2PortableServer\fP module for the
.na
\f2Portable Object Adapter\fP @
.fi
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.
http://download.oracle.com/javase/7/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.
.RE
.TP 3
\-J
@ -214,18 +181,18 @@ Retains the generated \f2.java\fP source files for the stub, skeleton, and/or ti
.TP 3
\-nowarn
Turns off warnings. If used the compiler does not print out any warnings.
.LP
.TP 3
\-nowrite
Does not write compiled classes to the file system.
.TP 3
\-vcompat
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.
.TP 3
\-verbose
Causes the compiler and linker to print out messages about what classes are being compiled and what class files are being loaded.
.LP
.TP 3
\-v1.1
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).
.LP
.TP 3
\-v1.2
(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,16 +200,11 @@ Generates stub and skeleton classes for the 1.1 JRMP stub protocol version only.
.LP
.SH "ENVIRONMENT VARIABLES"
.LP
.LP
.RS 3
.TP 3
CLASSPATH
Used to provide the system a path to user\-defined classes. Directories are separated by colons. For example,
.RS 3
.LP
.nf
\f3
.fl
@ -251,18 +213,15 @@ Used to provide the system a path to user\-defined classes. Directories are sepa
\fP
.fi
.RE
.RE
.LP
.SH "SEE ALSO"
.LP
.LP
.LP
java(1), javac(1),
.na
\f2CLASSPATH\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/tools/index.html#classpath
http://download.oracle.com/javase/7/docs/technotes/tools/index.html#classpath
.LP

38
jdk/src/linux/doc/man/rmid.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1998, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,22 +19,16 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH rmid 1 "02 Jun 2010"
.TH rmid 1 "10 May 2011"
.LP
.SH "Name"
rmid \- The Java RMI Activation System Daemon
.LP
.RS 3
.LP
.LP
\f3rmid\fP starts the activation system daemon that allows objects to be registered and activated in a virtual machine (VM).
.LP
.RE
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -46,19 +40,17 @@ rmid [options]
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f3rmid\fP tool starts the activation system daemon. The activation system daemon must be started before activatable objects can be either registered with the activation system or activated in a VM. See the
.na
\f2Java RMI Specification\fP @
.fi
http://java.sun.com/javase/6/docs/platform/rmi/spec/rmiTOC.html and
http://download.oracle.com/javase/7/docs/platform/rmi/spec/rmiTOC.html and
.na
\f2Activation tutorials\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/rmi/activation/overview.html for details on how to write programs that use activatable remote objects.
http://download.oracle.com/javase/7/docs/technotes/guides/rmi/activation/overview.html for details on how to write programs that use activatable remote objects.
.LP
.LP
The daemon can be started by executing the \f2rmid\fP command, and specifying a security policy file, as follows:
@ -132,8 +124,6 @@ The \f2\-log\fP option is required. If this option is not specified, \f2rmid\fP
See the man pages for \f2inetd\fP (Solaris) or \f2xinetd\fP (Linux) for details on how to configure services to be started on demand.
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
@ -169,7 +159,6 @@ Specifies an option that is passed to the \f2java\fP interpreter running \f2rmid
.TP 3
\-J\-Dsun.rmi.activation.execPolicy=<policy>
Specifies the policy that \f2rmid\fP employs to check commands and command\-line options used to launch the VM in which an activation group runs. Please note that this option exists only in Sun's implementation of the Java RMI activation daemon. If this property is not specified on the command line, the result is the same as if \f2\-J\-Dsun.rmi.activation.execPolicy=default\fP were specified. The possible values of \f2<policy>\fP can be \f2default\fP, \f2<policyClassName>\fP, or \f2none\fP:
.LP
.RS 3
.TP 2
o
@ -255,17 +244,9 @@ The first permission granted allow \f2rmid\fP to execute the 1.7.0 version of th
The third permission granted, an \f2ExecOptionPermission\fP, allows \f2rmid\fP to launch an activation group that defines the security policy file to be \f2/files/policies/group.policy\fP. The next permission allows the \f2java.security.debug\fP property to be used by an activation group. The last permission allows any property in the \f2sun.rmi\fP property name hierarchy to be used by activation groups.
.LP
To start \f2rmid\fP with a policy file, the \f2java.security.policy\fP property needs to be specified on \f2rmid\fP's command line, for example:
.RS 3
.LP
.LP
\f2rmid \-J\-Djava.security.policy=rmid.policy\fP
.LP
\f2rmid \-J\-Djava.security.policy=rmid.policy\fP
.RE
.RE
.TP 2
o
.LP
.TP 2
o
\f4<policyClassName>\fP
@ -285,7 +266,6 @@ The \f2policyClassName\fP specifies a public class with a public, no\-argument c
\fP
.fi
Before launching an activation group, \f2rmid\fP calls the policy's \f2checkExecCommand\fP method, passing it the activation group descriptor and an array containing the complete command to launch the activation group. If the \f2checkExecCommand\fP throws a \f2SecurityException\fP, \f2rmid\fP will not launch the activation group and an \f2ActivationException\fP will be thrown to the caller attempting to activate the object.
.LP
.TP 2
o
\f3none\fP
@ -318,9 +298,9 @@ Specifies the port \f2rmid\fP's registry uses. The activation system daemon bind
\-stop
Stops the current invocation of \f2rmid\fP, for a port specified by the \f2\-port\fP option. If no port is specified, it will stop the \f2rmid\fP running on port 1098.
.RE
.SH "ENVIRONMENT VARIABLES"
.LP
.LP
.SH "ENVIRONMENT VARIABLES"
.LP
.RS 3
.TP 3
@ -337,14 +317,12 @@ Used to provide the system a path to user\-defined classes. Directories are sepa
.LP
.SH "SEE ALSO"
.LP
.LP
.LP
rmic(1),
.na
\f2CLASSPATH\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/tools/index.html#classpath, java(1)
http://download.oracle.com/javase/7/docs/technotes/tools/index.html#classpath, java(1)
.LP

27
jdk/src/linux/doc/man/rmiregistry.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,22 +19,18 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH rmiregistry 1 "02 Jun 2010"
.TH rmiregistry 1 "10 May 2011"
.LP
.SH "Name"
rmiregistry \- The Java Remote Object Registry
.LP
.RS 3
.LP
.LP
The \f3rmiregistry\fP command starts a remote object registry on the specified port on the current host.
.LP
The \f3rmiregistry\fP command starts a remote object registry on the specified port on the current host.
.RE
.SH "SYNOPSIS"
.LP
.LP
.SH "SYNOPSIS"
.LP
.nf
\f3
@ -46,8 +42,6 @@ rmiregistry [\fP\f4port\fP\f3]
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f3rmiregistry\fP command creates and starts a remote object registry on the specified \f2port\fP on the current host. If \f2port\fP is omitted, the registry is started on port 1099. The \f3rmiregistry\fP command produces no output and is typically run in the background. For example:
@ -68,8 +62,6 @@ The methods of the \f2java.rmi.registry.LocateRegistry\fP class are used to get
The URL\-based methods of the \f2java.rmi.Naming\fP class operate on a registry and can be used to look up a remote object on any host, and on the local host: bind a simple (string) name to a remote object, rebind a new name to a remote object (overriding the old binding), unbind a remote object, and list the URLs bound in the registry.
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
@ -80,17 +72,12 @@ Used in conjunction with any \f2java\fP option, it passes the option following t
.LP
.SH "SEE ALSO"
.LP
.LP
.LP
java(1),
.na
\f2java.rmi.registry.LocateRegistry\fP @
.fi
http://java.sun.com/javase/6/docs/api/java/rmi/registry/LocateRegistry.html and
http://download.oracle.com/javase/7/docs/api/java/rmi/registry/LocateRegistry.html and
.na
\f2java.rmi.Naming\fP @
.fi
http://java.sun.com/javase/6/docs/api/java/rmi/Naming.html
.LP
http://download.oracle.com/javase/7/docs/api/java/rmi/Naming.html

48
jdk/src/linux/doc/man/schemagen.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,7 +19,7 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH schemagen 1 "02 Jun 2010"
.TH schemagen 1 "10 May 2011"
.LP
.SH "Name"
@ -30,8 +30,7 @@ schemagen \- Java(TM) Architecture for XML Binding Schema Generator
.br
\f3Implementation Version:\fP 2.1.3
.LP
.SS
Launching schemagen
.SH "Launching schemagen"
.LP
.LP
The schema generator can be launched using the appropriate \f2schemagen\fP shell script in the \f2bin\fP directory for your platform.
@ -45,9 +44,6 @@ We also provide an Ant task to run the schema generator \- see the instructions
\f2using schemagen with Ant\fP @
.fi
https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html.
.LP
.RS 3
.LP
.nf
\f3
@ -58,19 +54,13 @@ Note: Writing schema1.xsd
.fl
\fP
.fi
.RE
.LP
.LP
If your java sources/classes reference other classes, they must be accessable on your system CLASSPATH environment variable, or they need to be given to the tool by using the \f2\-classpath\fP/\f2\-cp\fP options. Otherwise you will see errors when generating your schema.
.LP
.RS 3
.LP
\f3Command Line Options\fP
.LP
.RS 3
.SS
Command Line Options
.LP
.nf
\f3
@ -79,24 +69,29 @@ Usage: schemagen [\-options ...] <java files>
.fl
.fl
Options:
Options:
.fl
\-d <path> : Specify where to place processor and javac generated class files
\-d <path> : specify where to place processor and javac generated class files
.fl
\-cp <path> : Specify where to find user specified files
\-cp <path> : specify where to find user specified files
.fl
\-classpath <path> : Specify where to find user specified files
\-classpath <path> : specify where to find user specified files
.fl
\-help : Display this usage message
\-encoding <encoding> : specify encoding to be used for apt/javac invocation
.fl
.fl
\-episode <file> : generate episode file for separate compilation
.fl
\-version : display version information
.fl
\-help : display this usage message
.fl
\fP
.fi
.RE
.LP
.RE
.SS
Generated Resource Files
.SH "Generated Resource Files"
.LP
.LP
The current schema generator simply creates a schema file for each namespace referenced in your Java classes. There is no way to control the name of the generated schema files at this time. For that purpose, use
@ -105,7 +100,8 @@ The current schema generator simply creates a schema file for each namespace ref
.fi
https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html.
.LP
.SH "See Also"
.SH "Name"
See Also
.LP
.RS 3
.TP 2
@ -124,7 +120,7 @@ o
.na
\f2Java Architecture for XML Binding (JAXB)\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/xml/jaxb/index.html
http://download.oracle.com/javase/7/docs/technotes/guides/xml/jaxb/index.html
.RE
.LP

32
jdk/src/linux/doc/man/serialver.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,22 +19,16 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH serialver 1 "02 Jun 2010"
.TH serialver 1 "10 May 2011"
.LP
.SH "Name"
serialver \- The Serial Version Command
.LP
.RS 3
.LP
.LP
The \f3serialver\fP command returns the \f2serialVersionUID\fP.
.LP
.RE
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -43,9 +37,6 @@ The \f3serialver\fP command returns the \f2serialVersionUID\fP.
.fl
.fi
.LP
.RS 3
.LP
.RS 3
.TP 3
@ -57,17 +48,12 @@ One or more class names
.RE
.LP
.RE
.SH "DESCRIPTION"
.LP
.LP
.LP
\f3serialver\fP returns the \f2serialVersionUID\fP for one or more classes in a form suitable for copying into an evolving class. When invoked with no arguments it prints a usage line.
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
@ -87,37 +73,25 @@ Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the
.LP
.SH "NOTES"
.LP
.LP
.LP
The \f3serialver\fP command loads and initializes the specified classes in its virtual machine, and by default, it does not set a security manager. If \f3serialver\fP is to be run with untrusted classes, a security manager can be set with the following option:
.LP
.RS 3
.LP
.LP
\f2\-J\-Djava.security.manager\fP
.LP
.RE
.LP
and, if necessary, a security policy can be specified with the following option:
.LP
.RS 3
.LP
.LP
\f2\-J\-Djava.security.policy=<policy file>\fP
.LP
.RE
.SH "SEE ALSO"
.LP
.LP
.LP
.na
\f2java.io.ObjectStreamClass\fP @
.fi
http://java.sun.com/javase/6/docs/api/java/io/ObjectStreamClass.html
http://download.oracle.com/javase/7/docs/api/java/io/ObjectStreamClass.html
.LP

20
jdk/src/linux/doc/man/servertool.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2001, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,20 +19,14 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH servertool 1 "02 Jun 2010"
.TH servertool 1 "10 May 2011"
.LP
.SH "Name"
servertool \- The Java(TM) IDL Server Tool
.LP
.RS 3
.LP
\f3servertool\fP provides a command\-line interface for application programmers to register, unregister, startup, and shutdown a persistent server.
.RE
\f3servertool\fP provides a command\-line interface for application programmers to register, unregister, startup, and shutdown a persistent server.
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -53,15 +47,11 @@ If you enter a command when starting \f2servertool\fP, the Java IDL Server Tool
The \f2\-ORBInitialPort\fP \f2nameserverport\fP option is \f3required\fP. The value for \f2nameserverport\fP must specify the port on which \f2orbd\fP is running and listening for incoming requests. When using Solaris software, you must become root to start a process on a port under 1024. For this reason, we recommend that you use a port number greater than or equal to 1024 for the \f2nameserverport\fP.
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f2servertool\fP provides the command\-line interface for the application programmers to register, unregister, startup, and shutdown a persistent server. Other commands are provided to obtain various statistical information about the server.
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
@ -74,8 +64,6 @@ Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the
.LP
.SH "COMMANDS"
.LP
.LP
.RS 3
.TP 3
@ -121,7 +109,5 @@ Exit the server tool.
.LP
.SH "SEE ALSO"
.LP
.LP
orbd(1)

57
jdk/src/linux/doc/man/tnameserv.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1999, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1999, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,7 +19,7 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH tnameserv 1 "02 Jun 2010"
.TH tnameserv 1 "10 May 2011"
.LP
.SH "Name"
@ -30,7 +30,7 @@ This document discusses using the Java IDL Transient Naming Service, \f2tnameser
.na
\f2Java IDL Naming Service Included with ORBD\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/idl/jidlNaming.html topic.
http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html topic.
.LP
.LP
Topics in this section include:
@ -120,11 +120,11 @@ For the client and server to find the Naming Service, they must be made aware of
.na
\f2The Hello World Example Using RMI\-IIOP\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/rmi\-iiop/rmiiiopexample.html. You could also use the command line options \f2\-ORBInitialPort\fP \f2nameserverport#\fP and \f2\-ORBInitialHost\fP \f2nameserverhostname\fP to tell the client and server where to find the Naming Service.
http://download.oracle.com/javase/7/docs/technotes/guides/rmi\-iiop/rmiiiopexample.html. You could also use the command line options \f2\-ORBInitialPort\fP \f2nameserverport#\fP and \f2\-ORBInitialHost\fP \f2nameserverhostname\fP to tell the client and server where to find the Naming Service.
.na
\f2Java IDL: Running the Hello World Example on TWO Machines\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/idl/tutorial/jidl2machines.html shows one way of doing this using the command line option.
http://download.oracle.com/javase/7/docs/technotes/guides/idl/tutorial/jidl2machines.html shows one way of doing this using the command line option.
.LP
.LP
For example, suppose the Transient Naming Service, \f2tnameserv\fP is running on port 1050 on host \f2nameserverhost\fP. The client is running on host \f2clienthost\fP and the server is running on host \f2serverhost\fP.
@ -170,16 +170,12 @@ The \-J option
.LP
This command\-line option is available for use with \f2tnameserve\fP:
.RS 3
.LP
.RS 3
.TP 3
\-Joption
Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. It is a common convention for \f3\-J\fP to pass options to the underlying virtual machine.
.RE
.LP
.RE
.SH "Stopping the Java\ IDL Transient Naming Service"
.LP
.LP
@ -190,28 +186,27 @@ To stop the Java\ IDL naming service, use the relevant operating system command,
.LP
The following sample program illustrates how to add names to the namespace. It is a self\-contained Transient Naming Service client that creates the following simple tree.
.LP
.nf
\f3
.fl
\fP\f3
.fl
\fP\f4Initial\fP\f3
.fl
\fP\f4Naming Context\fP\f3
.fl
/ \\
.fl
/ \\
.fl
plans \fP\f4Personal\fP\f3
.fl
/ \\
.fl
/ \\
.fl
calendar schedule\fP
.fl
.fi
.RS 3
.TP 2
o
\f4Initial Naming Context\fP
.RS 3
.TP 2
*
\f3plans\fP
.TP 2
*
\f4Personal\fP
.RS 3
.TP 2
-
\f3calendar\fP
.TP 2
-
\f3schedule\fP
.RE
.RE
.RE
.LP
.LP

80
jdk/src/linux/doc/man/unpack200.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,24 +19,19 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH unpack200 1 "02 Jun 2010"
.TH unpack200 1 "10 May 2011"
.LP
.SH "Name"
unpack200 \- JAR Unpacking tool
.LP
.SH "SYNOPSIS"
.LP
.LP
.LP
\f4unpack200\fP\f2 [ \fP\f2options\fP ] \f2input\-file\fP \f2JAR\-file\fP
.LP
.LP
Options may be in any order. The last option on the command line supersedes all previously specified options.
.LP
.RS 3
.LP
.RS 3
.TP 3
@ -48,99 +43,71 @@ Name of the output JAR file.
.RE
.LP
.RE
.SH "DESCRIPTION"
.LP
.LP
.LP
\f2unpack200\fP is a native implementation that transforms a packed file produced by \f2pack200\fP(1) into a JAR file. Typical usage:
.LP
.RS 3
.LP
.LP
\f2% unpack200 myarchive.pack.gz myarchive.jar\fP
.LP
.RE
.LP
In this example, the \f2myarchive.jar\fP is produced from \f2myarchive.pack.gz\fP using the default \f2unpack200\fP settings.
.LP
.SH "OPTIONS"
.LP
.SS
Standard Options
.LP
.RS 3
.LP
.LP
\f4\-Hvalue \-\-deflate\-hint=\fP\f2value\fP
.LP
.RS 3
.LP
.LP
Sets the deflation to be \f2true\fP, \f2false\fP, or \f2keep\fP on all entries within a JAR file. The default mode is \f2keep\fP. If \f2true\fP or \f2false\fP, overrides the default behavior and sets the deflation mode on all entries within the output JAR file.
.LP
.RE
.RE
.SS
Non\-Standard Options
.LP
.RS 3
.LP
.LP
\f4\-r \-\-remove\-pack\-file\fP
.LP
.RS 3
.LP
.LP
Removes the input packed file.
.LP
.RE
.LP
\f4\-v \-\-verbose\fP
.LP
.RS 3
.LP
.LP
Outputs minimal messages. Multiple specification of this option will output more verbose messages.
.LP
.RE
.LP
\f4\-q \-\-quiet\fP
.LP
.RS 3
.LP
.LP
Specifies quiet operation with no messages.
.LP
.RE
.LP
\f4\-lfilename \-\-log\-file=\fP\f2filename\fP
.LP
.RS 3
.LP
.LP
Specifies a log file to output messages.
.LP
.RE
.RE
.SH "EXIT STATUS"
.LP
\f4\-? \-h \-\-help\fP
.LP
.LP
Prints help information about this command.
.LP
.LP
\f4\-V \-\-version\fP
.LP
.LP
Prints version information about this command.
.LP
.LP
\f4\-J\fP\f2option\fP
.LP
.LP
Passes \f2option\fP to the Java launcher called by \f2unpack200\fP.
.LP
.SH "EXIT STATUS"
.LP
.LP
The following exit values are returned:
.LP
.RS 3
.LP
.LP
\f2\ 0\fP if successful completion;
@ -148,7 +115,6 @@ The following exit values are returned:
.LP
\f2>0\fP if an error occurred.
.LP
.RE
.SH "SEE ALSO"
.LP
.RS 3
@ -160,13 +126,13 @@ o
.na
\f2Java SE Documentation\fP @
.fi
http://java.sun.com/javase/6/docs/index.html
http://download.oracle.com/javase/7/docs/index.html
.TP 2
o
.na
\f2Java Deployment Guide \- Pack200\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/deployment/deployment\-guide/pack200.html
http://download.oracle.com/javase/7/docs/technotes/guides/deployment/deployment\-guide/pack200.html
.TP 2
o
jar(1) \- Java Archive Tool
@ -180,8 +146,6 @@ o
.LP
.SH "NOTES"
.LP
.LP
.LP
This command should not be confused with \f2unpack(1)\fP. They are distinctly separate products.

14
jdk/src/linux/doc/man/wsgen.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,21 +19,15 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH wsgen 1 "02 Jun 2010"
.TH wsgen 1 "10 May 2011"
.SH "Name"
wsgen \- Java(TM) API for XML Web Services (JAX\-WS) 2.0
.RS 3
.LP
.LP
\f3Specification Version:\fP 2.1
.br
\f3Implementation Version:\fP 2.1.1
.LP
.LP
The \f2wsgen\fP tool generates JAX\-WS portable artifacts used in JAX\-WS web services. The tool reads a web service endpoint implementation class (SEI) and generates all the required artifacts for web service deployment, and invocation
.LP
.RE
.SH "Overview"
.LP
The \f2wsgen\fP tool generates JAX\-WS portable artifacts used in JAX\-WS web services. The tool reads a web service endpoint class and generates all the required artifacts for web service deployment, and invocation. JAXWS 2.1.1 RI also provides a wsgen ant task, see
@ -83,7 +77,6 @@ wsgen [options] <SEI>\fP
The following table lists the \f2wsgen\fP options.
.br
.LP
.TS
.if \n+(b.=1 .nr d. \n(.c-\n(c.-1
.de 35
.ps \n(.s
@ -354,7 +347,7 @@ Used only in conjunction with the \f2\-wsdl\fP option. Used to specify a particu
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 139 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 133 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -571,7 +564,6 @@ Used only in conjunction with the \f2\-wsdl\fP option. Used to specify a particu
.rm i+
.rm j+
.rm k+
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-53
.LP

289
jdk/src/linux/doc/man/wsimport.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,7 +19,7 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH wsimport 1 "02 Jun 2010"
.TH wsimport 1 "10 May 2011"
.SH "Name"
wsimport \- Java(TM) API for XML Web Services (JAX\-WS) 2.0
.LP
@ -88,7 +88,6 @@ wsimport [options] <wsdl>
.LP
The following table lists the \f2wsimport\fP options.
.LP
.TS
.if \n+(b.=1 .nr d. \n(.c-\n(c.-1
.de 35
.ps \n(.s
@ -676,7 +675,6 @@ Generate code as per the given JAX\-WS specification version. version 2.0 will g
.rm l+
.rm m+
.rm n+
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-66
.LP
Multiple JAX\-WS and JAXB binding files can be specified using \f2\-b\fP option and they can be used to customize various things like package names, bean names, etc. More information on JAX\-WS and JAXB binding files can be found in the
@ -684,15 +682,294 @@ Multiple JAX\-WS and JAXB binding files can be specified using \f2\-b\fP option
\f2customization documentation\fP @
.fi
https://jax\-ws.dev.java.net/nonav/2.1.1/docs/customizations.html.
.LP
The following table lists \f2wsimport\fP non\-standard options:
.LP
.if \n+(b.=1 .nr d. \n(.c-\n(c.-1
.de 35
.ps \n(.s
.vs \n(.vu
.in \n(.iu
.if \n(.u .fi
.if \n(.j .ad
.if \n(.j=0 .na
..
.nf
.nr #~ 0
.if n .nr #~ 0.6n
.ds #d .d
.if \(ts\n(.z\(ts\(ts .ds #d nl
.fc
.nr 33 \n(.s
.rm 80 81
.nr 34 \n(.lu
.eo
.am 81
.br
.di a+
.35
.ft \n(.f
.ll \n(34u*1u/3u
.if \n(.l<\n(81 .ll \n(81u
.in 0
Map headers not bound to request or response message to Java method parameters.
.br
.di
.nr a| \n(dn
.nr a- \n(dl
..
.ec \
.eo
.am 81
.br
.di b+
.35
.ft \n(.f
.ll \n(34u*1u/3u
.if \n(.l<\n(81 .ll \n(81u
.in 0
WSDL URI that specifies the file that contains authorization information; this URI is in the following format: http://\f2<user name>\fP:\f2<password>\fP@\f2<host name>\fP/\f2<Web service name>\fP?wsdl
.br
.di
.nr b| \n(dn
.nr b- \n(dl
..
.ec \
.eo
.am 81
.br
.di c+
.35
.ft \n(.f
.ll \n(34u*1u/3u
.if \n(.l<\n(81 .ll \n(81u
.in 0
Print debugging information.
.br
.di
.nr c| \n(dn
.nr c- \n(dl
..
.ec \
.eo
.am 80
.br
.di d+
.35
.ft \n(.f
.ll \n(34u*1u/3u
.if \n(.l<\n(80 .ll \n(80u
.in 0
\f3\-Xno\-addressing\-databinding\fP
.br
.di
.nr d| \n(dn
.nr d- \n(dl
..
.ec \
.eo
.am 81
.br
.di e+
.35
.ft \n(.f
.ll \n(34u*1u/3u
.if \n(.l<\n(81 .ll \n(81u
.in 0
Enable binding of W3C \f2EndpointReferenceType\fP to Java.
.br
.di
.nr e| \n(dn
.nr e- \n(dl
..
.ec \
.eo
.am 81
.br
.di f+
.35
.ft \n(.f
.ll \n(34u*1u/3u
.if \n(.l<\n(81 .ll \n(81u
.in 0
Do not compile generated Java files.
.br
.di
.nr f| \n(dn
.nr f- \n(dl
..
.ec \
.35
.nf
.ll \n(34u
.nr 80 0
.nr 38 \w\f3Option\fP
.if \n(80<\n(38 .nr 80 \n(38
.nr 38 \w\f3\-XadditionalHeaders\fP
.if \n(80<\n(38 .nr 80 \n(38
.nr 38 \w\f3\-Xauthfile <file>\fP
.if \n(80<\n(38 .nr 80 \n(38
.nr 38 \w\f3\-Xdebug\fP
.if \n(80<\n(38 .nr 80 \n(38
.nr 38 \w\f3\-Xnocompile\fP
.if \n(80<\n(38 .nr 80 \n(38
.80
.rm 80
.nr 38 \n(d-
.if \n(80<\n(38 .nr 80 \n(38
.nr 81 0
.nr 38 \w\f3Description\fP
.if \n(81<\n(38 .nr 81 \n(38
.81
.rm 81
.nr 38 \n(a-
.if \n(81<\n(38 .nr 81 \n(38
.nr 38 \n(b-
.if \n(81<\n(38 .nr 81 \n(38
.nr 38 \n(c-
.if \n(81<\n(38 .nr 81 \n(38
.nr 38 \n(e-
.if \n(81<\n(38 .nr 81 \n(38
.nr 38 \n(f-
.if \n(81<\n(38 .nr 81 \n(38
.35
.nf
.ll \n(34u
.nr 38 1n
.nr 79 0
.nr 40 \n(79+(0*\n(38)
.nr 80 +\n(40
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 193 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
.eo
.de T#
.ds #d .d
.if \(ts\n(.z\(ts\(ts .ds #d nl
.mk ##
.nr ## -1v
.ls 1
.ls
..
.ec
.ta \n(80u \n(81u
.nr 31 \n(.f
.nr 35 1m
\&\h'|\n(40u'\f3Option\fP\h'|\n(41u'\f3Description\fP
.ne \n(a|u+\n(.Vu
.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v)
.ta \n(80u \n(81u
.nr 31 \n(.f
.nr 35 1m
\&\h'|\n(40u'\f3\-XadditionalHeaders\fP\h'|\n(41u'
.mk ##
.nr 31 \n(##
.sp |\n(##u-1v
.nr 37 \n(41u
.in +\n(37u
.a+
.in -\n(37u
.mk 32
.if \n(32>\n(31 .nr 31 \n(32
.sp |\n(31u
.ne \n(b|u+\n(.Vu
.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v)
.ta \n(80u \n(81u
.nr 31 \n(.f
.nr 35 1m
\&\h'|\n(40u'\f3\-Xauthfile <file>\fP\h'|\n(41u'
.mk ##
.nr 31 \n(##
.sp |\n(##u-1v
.nr 37 \n(41u
.in +\n(37u
.b+
.in -\n(37u
.mk 32
.if \n(32>\n(31 .nr 31 \n(32
.sp |\n(31u
.ne \n(c|u+\n(.Vu
.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v)
.ta \n(80u \n(81u
.nr 31 \n(.f
.nr 35 1m
\&\h'|\n(40u'\f3\-Xdebug\fP\h'|\n(41u'
.mk ##
.nr 31 \n(##
.sp |\n(##u-1v
.nr 37 \n(41u
.in +\n(37u
.c+
.in -\n(37u
.mk 32
.if \n(32>\n(31 .nr 31 \n(32
.sp |\n(31u
.ne \n(d|u+\n(.Vu
.ne \n(e|u+\n(.Vu
.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v)
.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v)
.ta \n(80u \n(81u
.nr 31 \n(.f
.nr 35 1m
\&\h'|\n(40u'\h'|\n(41u'
.mk ##
.nr 31 \n(##
.sp |\n(##u-1v
.nr 37 \n(40u
.in +\n(37u
.d+
.in -\n(37u
.mk 32
.if \n(32>\n(31 .nr 31 \n(32
.sp |\n(##u-1v
.nr 37 \n(41u
.in +\n(37u
.e+
.in -\n(37u
.mk 32
.if \n(32>\n(31 .nr 31 \n(32
.sp |\n(31u
.ne \n(f|u+\n(.Vu
.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v)
.ta \n(80u \n(81u
.nr 31 \n(.f
.nr 35 1m
\&\h'|\n(40u'\f3\-Xnocompile\fP\h'|\n(41u'
.mk ##
.nr 31 \n(##
.sp |\n(##u-1v
.nr 37 \n(41u
.in +\n(37u
.f+
.in -\n(37u
.mk 32
.if \n(32>\n(31 .nr 31 \n(32
.sp |\n(31u
.fc
.nr T. 1
.T# 1
.35
.rm a+
.rm b+
.rm c+
.rm d+
.rm e+
.rm f+
.if \n-(b.=0 .nr c. \n(.c-\n(d.-26
.LP
.SH "Example"
.nf
\f3
.fl
\fP\f3wsimport \-p stockquote http://stockquote.xyz/quote?wsdl\fP
\fP\f3wsimport \-p stockquote http://stockquote.example.com/quote?wsdl\fP
.fl
.fi
.LP
This will generate the Java artifacts and compile them by importing the \f2http://stockquote.xyz/quote?wsdl\fP.
This will generate the Java artifacts and compile them by importing the \f2http://stockquote.example.com/quote?wsdl\fP.
.br

124
jdk/src/linux/doc/man/xjc.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,19 +19,18 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH xjc 1 "02 Jun 2010"
.TH xjc 1 "10 May 2011"
.LP
.ad c
.SH "Name"
xjc \- Java(TM) Architecture for XML Binding
.br
Binding Compiler
Binding Compiler
.LP
.LP
\f3Specification Version:\fP 2.1
.br
\f3Reference Implementation (RI) Version:\fP 2.1.3 .ad l
\f3Reference Implementation (RI) Version:\fP 2.1.3
.LP
.SH "Launching xjc"
.LP
@ -41,84 +40,87 @@ The binding compiler can be launched using the appropriate \f2xjc\fP shell scrip
\f2using the XJC Ant task\fP @
.fi
https://jaxb.dev.java.net/nonav/2.1.3/docs/xjcTask.html.
.LP
.RS 3
.LP
.LP
\f2% xjc \-help\fP
.LP
.RE
\f3Output\fP
.LP
.RS 3
.SS
Output
.LP
.nf
\f3
.fl
Usage: xjc [\-options ...] <schema_file/URL/dir> ... [\-b <bindinfo>] ...
Usage: xjc [\-options ...] <schema file/URL/dir/jar> ... [\-b <bindinfo>] ...
.fl
If dir is specified, all schema files in it will be compiled.
.fl
If jar is specified, /META\-INF/sun\-jaxb.episode binding file will be compiled.
.fl
Options:
.fl
\-nv : do not perform strict validation of the input schema(s)
\-nv : do not perform strict validation of the input schema(s)
.fl
\-extension : allow vendor extensions \- do not strictly follow the
\-extension : allow vendor extensions \- do not strictly follow the Compatibility Rules and App E.2 from the JAXB Spec
.fl
Compatibility Rules and App E.2 from the JAXB Spec
\-b <file/dir> : specify external bindings files (each <file> must have its own \-b); if a directory is given, **/*.xjb is searched
.fl
\-b <file/dir> : specify external bindings files (each <file> must have its own \-b)
\-d <dir> : generated files will go into this directory
.fl
If a directory is given, **/*.xjb is searched
\-p <pkg> : specifies the target package
.fl
\-d <dir> : generated files will go into this directory
\-httpproxy <proxy> : set HTTP/HTTPS proxy; format is [user[:password]@]proxyHost:proxyPort
.fl
\-p <pkg> : specifies the target package
\-httpproxyfile <f> : works like \-httpproxy but takes the argument in a file to protect password
.fl
\-httpproxy <proxy> : set HTTP/HTTPS proxy. Format is [user[:password]@]proxyHost:proxyPort
\-classpath <arg> : specify where to find user class files
.fl
\-httpproxyfile <file>: set the proxy string (same format as above).
\-catalog <file> : specify catalog files to resolve external entity references; support TR9401, XCatalog, and OASIS XML Catalog format
.fl
\-classpath <arg> : specify where to find user class files
\-readOnly : generated files will be in read\-only mode
.fl
\-catalog <file> : specify catalog files to resolve external entity references
\-npa : suppress generation of package level annotations (**/package\-info.java)
.fl
support TR9401, XCatalog, and OASIS XML Catalog format.
\-no\-header : suppress generation of a file header with timestamp
.fl
\-readOnly : generated files will be in read\-only mode
\-target 2.0 : behave like XJC 2.0 and generate code that doesnt use any 2.1 features
.fl
\-npa : suppress generation of package level annotations (**/package\-info.java)
\-xmlschema : treat input as W3C XML Schema (default)
.fl
\-no\-header : suppress generation of a file header with timestamp
\-relaxng : treat input as RELAX NG (experimental,unsupported)
.fl
\-target 2.0 : behave like XJC 2.0 and generate code that doesnt use any 2.1 features.
\-relaxng\-compact : treat input as RELAX NG compact syntax (experimental,unsupported)
.fl
\-xmlschema : treat input as W3C XML Schema (default)
\-dtd : treat input as XML DTD (experimental,unsupported)
.fl
\-relaxng : treat input as RELAX NG (experimental,unsupported)
\-wsdl : treat input as WSDL and compile schemas inside it (experimental,unsupported)
.fl
\-relaxng\-compact : treat input as RELAX NG compact syntax (experimental,unsupported)
\-verbose : be extra verbose
.fl
\-dtd : treat input as XML DTD (experimental,unsupported)
\-quiet : suppress compiler output
.fl
\-wsdl : treat input as WSDL and compile schemas inside it (experimental,unsupported)
\-help : display this help message
.fl
\-verbose : be extra verbose
\-version : display version information
.fl
\-quiet : suppress compiler output
.fl
\-help : display this help message
.fl
\-version : display version information
Extensions:
.fl
\-Xlocator : enable source location support for generated code
.fl
\-Xsync\-methods : generate accessor methods with the 'synchronized' keyword
.fl
\-mark\-generated : mark the generated code as @javax.annotation.Generated
.fl
\-episode <FILE> : generate the episode file for separate compilation
.fl
\fP
.fi
.RE
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
@ -129,15 +131,9 @@ By default, the XJC binding compiler performs strict validation of the source sc
By default, the XJC binding compiler strictly enforces the rules outlined in the Compatibility chapter of the JAXB Specification. Appendix E.2 defines a set of W3C XML Schema features that are not completely supported by JAXB v1.0. In some cases, you may be allowed to use them in the "\-extension" mode enabled by this switch. In the default (strict) mode, you are also limited to using only the binding customizations defined in the specification. By using the "\-extension" switch, you will be allowed to use the JAXB Vendor Extensions
.TP 3
\-b <file>
Specify one or more external binding files to process. (Each binding file must have its own \f2"\-b"\fP switch.) The syntax of the external binding files is extremely flexible. You may have a single binding file that contains customizations for multiple schemas or you can break the customizations into multiple bindings files:
.RS 3
.LP
\f2xjc schema1.xsd schema2.xsd schema3.xsd \-b bindings123.xjb\fP
Specify one or more external binding files to process. (Each binding file must have its own \f2"\-b"\fP switch.) The syntax of the external binding files is extremely flexible. You may have a single binding file that contains customizations for multiple schemas or you can break the customizations into multiple bindings files: \f2xjc schema1.xsd schema2.xsd schema3.xsd \-b bindings123.xjb\fP
.br
\f2xjc schema1.xsd schema2.xsd schema3.xsd \-b bindings1.xjb \-b bindings2.xjb \-b bindings3.xjb\fP
.RE
In addition, the ordering of the schema files and binding files on the command line does not matter.
\f2xjc schema1.xsd schema2.xsd schema3.xsd \-b bindings1.xjb \-b bindings2.xjb \-b bindings3.xjb\fP In addition, the ordering of the schema files and binding files on the command line does not matter.
.TP 3
\-d <dir>
By default, the XJC binding compiler will generate the Java content classes in the current directory. Use this option to specify an alternate output directory. The output directory must already exist, the XJC binding compiler will not create it for you.
@ -199,11 +195,29 @@ Display the compiler version information.
<schema file/URL/dir>
Specify one or more schema files to compile. If you specify a directory, then xjc will scan it for all schema files and compile them.
.RE
.LP
.SS
Summary of Deprecated and Removed Command Line Options
Non\-Standard Command Line Options
.LP
.RS 3
.TP 3
\-Xlocator
Causes the generated code to expose SAX Locator information about the source XML in the Java bean instances after unmarshalling.
.TP 3
\-Xsync\-methods
Causes all of the generated method signatures to include the \f2synchronized\fP keyword.
.TP 3
\-mark\-generated
Mark the generated code with the annotation \f2@javax.annotation.Generated\fP.
.TP 3
\-episode <file>
Generate the specified episode file for separate compilation.
.RE
.LP
.SS
Deprecated and Removed Command Line Options
.LP
.RS 3
.TP 3
@ -215,13 +229,9 @@ Since the JAXB 2.0 specification has defined a portable runtime, it is no longer
.TP 3
\-source
The \-source compatibility switch was introduced in the first JAXB 2.0 Early Access release. We have decided to remove this switch from future releases of JAXB 2.0. If you need to generate 1.0.x code, please use an installation of the 1.0.x codebase.
.TP 3
\-Xlocator & \-Xsync\-methods
These switches have been disabled for now. We plan on releasing this functionality as a separate download in the future.
.RE
.LP
.RE
.SS
Compiler Restrictions
.LP
@ -280,7 +290,7 @@ o
.na
\f2Java Architecture for XML Binding (JAXB)\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/xml/jaxb/index.html
http://download.oracle.com/javase/7/docs/technotes/guides/xml/jaxb/index.html
.RE
.LP

16
jdk/src/solaris/doc/sun/man/man1/appletviewer.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1995, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1995, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,43 +19,33 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH appletviewer 1 "02 Jun 2010"
.TH appletviewer 1 "10 May 2011"
.LP
.SH "Name"
appletviewer \- The Java Applet Viewer.
.LP
.RS 3
.LP
.LP
The \f3appletviewer\fP command allows you to run applets outside of a web browser.
.LP
.RE
.SH "SYNOPSIS"
.LP
.LP
.LP
\f4appletviewer\fP \f2[\fP \f2options\fP \f2] \fP\f2urls\fP ...
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f3appletviewer\fP command connects to the documents or resources designated by \f2urls\fP and displays each applet referenced by the documents in its own window. Note: if the documents referred to by \f2urls\fP do not reference any applets with the \f2OBJECT\fP, \f2EMBED\fP, or \f2APPLET\fP tag, then \f3appletviewer\fP does nothing. For details on the HTML tags that \f3appletviewer\fP supports, see
.na
\f2AppletViewer Tags\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/tools/appletviewertags.html.
http://download.oracle.com/javase/7/docs/technotes/tools/appletviewertags.html.
.LP
.LP
\f3Note:\fP The \f3appletviewer\fP requires encoded URLs according to the escaping mechanism defined in RFC2396. Only encoded URLs are supported. However, file names must be unencoded, as specified in RFC2396.
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3

51
jdk/src/solaris/doc/sun/man/man1/apt.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,7 +19,7 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH apt 1 "02 Jun 2010"
.TH apt 1 "10 May 2011"
.LP
.SH "NAME"
@ -50,21 +50,17 @@ One or more files that list source files or other options
.SH "DESCRIPTION"
.LP
.LP
The tool \f2apt\fP, annotation processing tool, includes a set of new reflective APIs and supporting infrastructure to process program annotations. The \f2apt\fP reflective APIs provide a build\-time, source\-based, read\-only view of program structure. These reflective APIs are designed to cleanly model the Java(TM) programming language's type system after the addition of generics. First, \f2apt\fP runs annotation processors that can produce new source code and other files. Next, \f2apt\fP can cause compilation of both original and generated source files, easing development. The reflective APIs and other APIs used to interact with the tool are subpackages of \f2com.sun.mirror\fP.
\f3Note\fP: The \f2apt\fP tool and its associated API contained in the package \f2com.sun.mirror\fP have been deprecated since JDK 7 and are planned to be removed in the next major JDK release. Use the options available in the \f2javac(1)\fP tool and the APIs contained in the packages \f2javax.annotation.processing\fP and \f2javax.lang.model\fP to process annotations.
.LP
.LP
The tool \f2apt\fP, annotation processing tool, includes reflective APIs and supporting infrastructure to process program annotations. The \f2apt\fP reflective APIs provide a build\-time, source\-based, read\-only view of program structure. These reflective APIs are designed to cleanly model the Java(TM) programming language's type system after the addition of generics. First, \f2apt\fP runs annotation processors that can produce new source code and other files. Next, \f2apt\fP can cause compilation of both original and generated source files, easing development. The reflective APIs and other APIs used to interact with the tool are subpackages of \f2com.sun.mirror\fP.
.LP
.LP
A fuller discussion of how the tool operates as well as instructions for developing with \f2apt\fP are in
.na
\f4Getting Started with \fP\f4apt\fP. @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/apt/GettingStarted.html
.LP
.RS 3
.TP 3
Note:
\f2The functionality of \fP\f2apt\fP has been subsumed by the annotation\-processing infrastructure that is now part of the \f2javac(1)\fP tool and standardized for use by all Java compilers. This new infrastructure relies on the language model and annotation\-processing APIs that are now part of the Java Platform. It is recommended that new annotation processor development be based on the new APIs and the \f2javac\fP tool.
.RE
http://download.oracle.com/javase/7/docs/technotes/guides/apt/GettingStarted.html
.LP
.SH "OPTIONS"
.LP
@ -90,6 +86,12 @@ Specify where to find annotation processor factories; if this option is used, th
.TP 3
\-factory classname
Name of annotation processor factory to use; bypasses default discovery process
.TP 3
\-version
Print version information.
.TP 3
\-X
Display information about non\-standard options.
.RE
.LP
@ -109,10 +111,35 @@ Specify where to find user class files and annotation processor factories. If \f
.LP
Consult the javac(1) man page for information on \f2javac\fP options.
.LP
.SS
Non\-Standard Options
.LP
.RS 3
.TP 3
\-XListAnnotationTypes
List found annotation types.
.TP 3
\-XListDeclarations
List specified and included declarations.
.TP 3
\-XPrintAptRounds
Print information about initial and recursive \f2apt\fP rounds.
.TP 3
\-XPrintFactoryInfo
Print information about which annotations a factory is asked to process.
.TP 3
\-XclassesAsDecls
Treat both class and source files as declarations to process.
.RE
.LP
.LP
\f3Note\fP: Because these options are non\-standard, they are subject to change without notice.
.LP
.SH "NOTES"
.LP
.LP
The functionality of \f2apt\fP has been subsumed by the standard annotation\-processing infrastructure now offered by \f2javac\fP. Support for \f2apt\fP and its associated APIs may be discontinued in some future JDK release.
The \f2apt\fP tool and its associated API contained in the package \f2com.sun.mirror\fP have been deprecated since JDK 7 and are planned to be removed in the next major JDK release. Use the options available in the \f2javac(1)\fP tool and the APIs contained in the packages \f2javax.annotation.processing\fP and \f2javax.lang.model\fP to process annotations.
.LP
.SH "SEE ALSO"
.LP

16
jdk/src/solaris/doc/sun/man/man1/extcheck.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1998, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,22 +19,16 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH extcheck 1 "02 Jun 2010"
.TH extcheck 1 "10 May 2011"
.LP
.SH "Name"
extcheck \- A utility to detect jar conflicts
.LP
.RS 3
.LP
.LP
\f3extcheck\fP detects version conflicts between a target jar file and currently installed extension jar files.
.LP
.RE
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -46,8 +40,6 @@ extcheck [ \-verbose ] targetfile.jar
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f3extcheck\fP utility checks a specified Jar file for title and version conflicts with any extensions installed in the Java(TM) SDK. Before installing an extension, you can use this utility to see if the same or a more recent version of the extension is already installed.
@ -62,8 +54,6 @@ If no conflict is detected, the return code is \f20\fP.
If the manifest of any jar file in the extensions directory has the same \f2Specification\-title\fP and the same or a newer \f2Specification\-version\fP number, a non\-zero error code is returned. A non\-zero error code is also returned if \f2targetfile.jar\fP does not have the \f2Specification\-title\fP or \f2Specification\-version\fP attributes in its manifest.
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
@ -76,8 +66,6 @@ Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the
.LP
.SH "SEE ALSO"
.LP
.LP
.LP
jar(1)

527
jdk/src/solaris/doc/sun/man/man1/idlj.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2001, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,20 +19,14 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH idlj 1 "02 Jun 2010"
.TH idlj 1 "10 May 2011"
.LP
.SH "Name"
idlj \- The IDL\-to\-Java Compiler
.LP
.RS 3
.LP
\f3idlj\fP generates Java bindings from a given IDL file.
.RE
\f3idlj\fP generates Java bindings from a given IDL file.
.SH "Synopsis"
.LP
.LP
.nf
\f3
@ -48,28 +42,62 @@ where \f2idl\-file\fP is the name of a file containing Interface Definition Lang
.LP
.SH "Description"
.LP
.LP
The IDL\-to\-Java Compiler generates the Java bindings for a given IDL file.\ For binding details, see the
.na
\f2OMG IDL to Java Language Language Mapping Specification\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/idl/mapping/jidlMapping.html. Some previous releases of the IDL\-to\-Java compiler were named \f2idltojava\fP.
http://download.oracle.com/javase/7/docs/technotes/guides/idl/mapping/jidlMapping.html. Some previous releases of the IDL\-to\-Java compiler were named \f2idltojava\fP.
.LP
.SS
Emitting Client and Server Bindings
.LP
.RS 3
.LP
To generate Java bindings for an IDL file named My.idl:
.LP
.nf
\f3
.fl
idlj My.idl
.fl
\fP
.fi
.LP
To generate Java bindings for an IDL file named My.idl: \f2idlj My.idl\fP
.LP
This generates the client\-side bindings and is equivalent to: \f2idlj \fP\f4\-fclient\fP\f2 My.idl\fP
This generates the client\-side bindings and is equivalent to:
.LP
The client\-side bindings do not include the server\-side skeleton. If you want to generate the server\-side bindings for the interfaces: \f2idlj \fP\f4\-fserver\fP\f2 My.idl\fP
.nf
\f3
.fl
idlj \fP\f3\-fclient\fP My.idl
.fl
.fi
.LP
Server\-side bindings include the client\-side bindings plus the skeleton, all of which are \f2POA\fP (that is, Inheritance Model) classes. If you want to generate both client and server\-side bindings, use one of the following (equivalent) commands: \f2idlj \fP\f4\-fclient \-fserver\fP\f2 My.idl\fP
.br
\f2idlj \fP\f4\-fall\fP\f2 My.idl\fP
.LP
The client\-side bindings do not include the server\-side skeleton. If you want to generate the server\-side bindings for the interfaces:
.LP
.nf
\f3
.fl
idlj \fP\f3\-fserver\fP My.idl
.fl
.fi
.LP
.LP
Server\-side bindings include the client\-side bindings plus the skeleton, all of which are \f2POA\fP (that is, Inheritance Model) classes. If you want to generate both client and server\-side bindings, use one of the following (equivalent) commands:
.LP
.nf
\f3
.fl
idlj \fP\f3\-fclient \-fserver\fP My.idl
.fl
idlj \f3\-fall\fP My.idl
.fl
.fi
.LP
.LP
There are two possible server\-side models: the Inheritance Model and the Tie Delegation Model.
@ -82,31 +110,47 @@ The default server\-side model is the \f2Portable Servant Inheritance Model\fP.
.na
\f2org.omg.PortableServer.Servant\fP @
.fi
http://java.sun.com/javase/6/docs/api/org/omg/PortableServer/Servant.html and implements the \f2InvokeHandler\fP interface and the operations interface associated with the IDL interface the skeleton implements.
http://download.oracle.com/javase/7/docs/api/org/omg/PortableServer/Servant.html and implements the \f2InvokeHandler\fP interface and the operations interface associated with the IDL interface the skeleton implements.
.LP
.LP
The \f2PortableServer\fP module for the
.na
\f2Portable Object Adapter (POA)\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/idl/POA.html 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.
http://download.oracle.com/javase/7/docs/technotes/guides/idl/POA.html 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.
.LP
.LP
Another option for the Inheritance Model is to use the \f2\-oldImplBase\fP flag in order to generate server\-side bindings that are compatible with versions of the Java programming language prior to J2SE 1.4. Note that using the \f2\-oldImplBase\fP flag is non\-standard: these APIs are being deprecated. You would use this flag ONLY for compatibility with existing servers written in J2SE 1.3. In that case, you would need to modify an existing MAKEFILE to add the \f2\-oldImplBase\fP flag to the \f2idlj\fP compiler, otherwise POA\-based server\-side mappings will be generated. To generate server\-side bindings that are backwards compatible:
.LP
\f2idlj \fP\f4\-fclient \-fserver\fP\f2 \fP\f4\-oldImplBase\fP\f2 My.idl\fP
.br
\f2idlj \fP\f4\-fall\fP\f2 \fP\f4\-oldImplBase\fP\f2 My.idl\fP
.nf
\f3
.fl
idlj \fP\f3\-fclient \-fserver\fP \f3\-oldImplBase\fP My.idl
.fl
idlj \f3\-fall\fP \f3\-oldImplBase\fP My.idl
.fl
.fi
.LP
.LP
Given an interface \f2My\fP defined in \f2My.idl\fP, the file \f2_MyImplBase.java\fP is generated. You must provide the implementation for \f2My\fP and it must inherit from \f2_MyImplBase\fP.
.LP
Given an interface \f2My\fP defined in \f2My.idl\fP, the file \f2_MyImplBase.java\fP is generated. You must provide the implementation for \f2My\fP and it must inherit from \f2_MyImplBase\fP.
.LP
The other server\-side model is called the Tie Model. This is a delegation model. Because it is not possible to generate ties and skeletons at the same time, they must be generated separately. The following commands generate the bindings for the Tie Model:
.LP
\f2idlj \fP\f4\-fall\fP\f2 My.idl\fP
.br
\f2idlj \fP\f4\-fallTIE\fP\f2 My.idl\fP
.nf
\f3
.fl
idlj \fP\f3\-fall\fP My.idl
.fl
idlj \f3\-fallTIE\fP My.idl
.fl
.fi
.LP
.LP
For the interface \f2My\fP, the second command generates \f2MyPOATie.java\fP. The constructor to \f2MyPOATie\fP takes a \f2delegate\fP. In this example, using the default POA model, the constructor also needs a \f2poa\fP. You must provide the implementation for \f2delegate\fP, but it does not have to inherit from any other class, only the interface \f2MyOperations\fP. But to use it with the ORB, you must wrap your implementation within \f2MyPOATie\fP. For instance:
.LP
For the interface \f2My\fP, the second command generates \f2MyPOATie.java\fP. The constructor to \f2MyPOATie\fP takes a \f2delegate\fP. In this example, using the default POA model, the constructor also needs a \f2poa\fP. You must provide the implementation for \f2delegate\fP, but it does not have to inherit from any other class, only the interface \f2MyOperations\fP. But to use it with the ORB, you must wrap your implementation within \f2MyPOATie\fP. For instance:
.nf
\f3
.fl
@ -144,13 +188,21 @@ For the interface \f2My\fP, the second command generates \f2MyPOATie.java\fP. Th
.fi
.LP
You might want to use the Tie model instead of the typical Inheritance model if your implementation must inherit from some other implementation. Java allows any number of interface inheritance, but there is only one slot for class inheritance. If you use the inheritance model, that slot is used up . By using the Tie Model, that slot is freed up for your own use. The drawback is that it introduces a level of indirection: one extra method call occurs when invoking a method.
.LP
You might want to use the Tie model instead of the typical Inheritance model if your implementation must inherit from some other implementation. Java allows any number of interface inheritance, but there is only one slot for class inheritance. If you use the inheritance model, that slot is used up . By using the Tie Model, that slot is freed up for your own use. The drawback is that it introduces a level of indirection: one extra method call occurs when invoking a method.
.LP
.LP
To generate server\-side, Tie model bindings that are compatible with versions of the IDL to Java language mapping in versions prior to J2SE 1.4.
.LP
\f2idlj \fP\f4\-oldImplBase\fP\f2 \fP\f4\-fall\fP\f2 My.idl\fP
.br
\f2idlj \fP\f4\-oldImplBase\fP\f2 \fP\f4\-fallTIE\fP\f2 My.idl\fP
.nf
\f3
.fl
idlj \fP\f3\-oldImplBase\fP \f3\-fall\fP My.idl
.fl
idlj \f3\-oldImplBase\fP \f3\-fallTIE\fP My.idl
.fl
.fi
.LP
.LP
For the interface \f2My\fP, this will generate \f2My_Tie.java\fP. The constructor to \f2My_Tie\fP takes a \f2impl\fP. You must provide the implementation for \f2impl\fP, but it does not have to inherit from any other class, only the interface \f2HelloOperations\fP. But to use it with the ORB, you must wrap your implementation within \f2My_Tie\fP. For instance:
@ -184,201 +236,383 @@ For the interface \f2My\fP, this will generate \f2My_Tie.java\fP. The constructo
.fi
.LP
.RE
.SS
Specifying Alternate Locations for Emitted Files
.LP
.RS 3
.LP
If you want to direct the emitted files to a directory other than the current directory, invoke the compiler as:
.LP
.nf
\f3
.fl
idlj \fP\f3\-td /altdir\fP My.idl
.fl
.fi
.LP
If you want to direct the emitted files to a directory other than the current directory, invoke the compiler as:
.RS 3
.LP
\f2idlj \fP\f4\-td /altdir\fP\f2 My.idl\fP
.RE
For the interface \f2My\fP, the bindings will be emitted to \f2/altdir/My.java\fP, etc., instead of \f2./My.java\fP.
.RE
.LP
.SS
Specifying Alternate Locations for Include Files
.LP
.RS 3
.LP
If \f2My.idl\fP included another idl file, \f2MyOther.idl\fP, the compiler assumes that \f2MyOther.idl\fP resides in the local directory. If it resides in \f2/includes\fP, for example, then you would invoke the compiler with the following command:
.LP
.nf
\f3
.fl
idlj \fP\f3\-i /includes\fP My.idl
.fl
.fi
.LP
If \f2My.idl\fP included another idl file, \f2MyOther.idl\fP, the compiler assumes that \f2MyOther.idl\fP resides in the local directory. If it resides in \f2/includes\fP, for example, then you would invoke the compiler with the following command: \f2idlj \fP\f4\-i /includes\fP\f2 My.idl\fP
.LP
If \f2My.idl\fP also included \f2Another.idl\fP that resided in \f2/moreIncludes\fP, for example, then you would invoke the compiler with the following command: \f2idlj \fP\f4\-i /includes \-i /moreIncludes\fP\f2 My.idl\fP
If \f2My.idl\fP also included \f2Another.idl\fP that resided in \f2/moreIncludes\fP, for example, then you would invoke the compiler with the following command:
.LP
.nf
\f3
.fl
idlj \fP\f3\-i /includes \-i /moreIncludes\fP My.idl
.fl
.fi
.LP
.LP
Since this form of include can become irritatingly long, another means of indicating to the compiler where to search for included files is provided. This technique is similar to the idea of an environment variable. Create a file named \f2idl.config\fP in a directory that is listed in your CLASSPATH. Inside of \f2idl.config\fP, provide a line with the following form:
.LP
.nf
\f3
.fl
includes=/includes;/moreIncludes
.fl
\fP
.fi
.LP
Since this form of include can become irritatingly long, another means of indicating to the compiler where to search for included files is provided. This technique is similar to the idea of an environment variable. Create a file named \f2idl.config\fP in a directory that is listed in your CLASSPATH. Inside of \f2idl.config\fP, provide a line with the following form: \f2includes=/includes;/moreIncludes\fP
.LP
The compiler will find this file and read in the includes list. Note that in this example the separator character between the two directories is a semicolon (;). This separator character is platform dependent. On the Windows platform, use a semicolon, on the Unix platform, use a colon, etc. For more information on \f2includes\fP, see the
.na
\f2Setting the Classpath\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/tools/index.html#general.
.RE
http://download.oracle.com/javase/7/docs/technotes/tools/index.html#general.
.LP
.SS
Emitting Bindings for Include Files
.LP
.RS 3
.LP
By default, only those interfaces, structs, etc, that are defined in the idl file on the command line have Java bindings generated for them. The types defined in included files are not generated. For example, assume the following two idl files:
.LP
.LP
By default, only those interfaces, structs, etc, that are defined in the idl file on the command line have Java bindings generated for them. The types defined in included files are not generated. For example, assume the following two idl files: \f4My.idl\fP
.LP
\f2#include <MyOther.idl>\fP
.br
\f2interface My\fP
.br
\f2{\fP
.br
\f2};\fP
.br
\f4MyOther.idl\fP
\f4My.idl\fP
.LP
\f2interface MyOther\fP
.br
\f2{\fP
.br
\f2};\fP\
.nf
\f3
.fl
#include <MyOther.idl>
.fl
interface My
.fl
{
.fl
};
.fl
\fP
.fi
.LP
The following command will only generate the java bindings for \f2My\fP: \f2idlj My.idl\fP
.LP
To generate all of the types in \f2My.idl\fP and all of the types in the files that \f2My.idl\fP includes (in this example, \f2MyOther.idl\fP), use the following command: \f2idlj \fP\f4\-emitAll\fP\f2 My.idl\fP
.LP
There is a caveat to the default rule. \f2#include\fP statements which appear at global scope are treated as described. These \f2#include\fP statements can be thought of as import statements. \f2#include\fP statements which appear within some enclosing scope are treated as true \f2#include\fP statements, meaning that the code within the included file is treated as if it appeared in the original file and, therefore, Java bindings are emitted for it. Here is an example: \f4My.idl\fP
\f4MyOther.idl\fP
.LP
\f2#include <MyOther.idl>\fP
.br
\f2interface My\fP
.br
\f2{\fP
.br
\f2\ #include <Embedded.idl>\fP
.br
\f2};\ \fP \f4MyOther.idl\fP
.nf
\f3
.fl
interface MyOther
.fl
{
.fl
};
.fl
\fP
.fi
.LP
\f2interface MyOther\fP
.br
\f2{\fP
.br
\f2};\ \fP \f4Embedded.idl\fP
.LP
\f2enum E {one, two, three};\fP\
.LP
Running the following command: \f2idlj My.idl\fP
The following command will only generate the java bindings for \f2My\fP:
.LP
will generate the following list of Java files: \f2./MyHolder.java\fP
.br
\f2./MyHelper.java\fP
.br
\f2./_MyStub.java\fP
.br
\f2./MyPackage\fP
.br
\f2./MyPackage/EHolder.java\fP
.br
\f2./MyPackage/EHelper.java\fP
.br
\f2./MyPackage/E.java\fP
.br
\f2./My.java\fP
.nf
\f3
.fl
idlj My.idl
.fl
\fP
.fi
.LP
.LP
To generate all of the types in \f2My.idl\fP and all of the types in the files that \f2My.idl\fP includes (in this example, \f2MyOther.idl\fP), use the following command:
.LP
.nf
\f3
.fl
idlj \fP\f3\-emitAll\fP My.idl
.fl
.fi
.LP
.LP
There is a caveat to the default rule. \f2#include\fP statements which appear at global scope are treated as described. These \f2#include\fP statements can be thought of as import statements. \f2#include\fP statements which appear within some enclosing scope are treated as true \f2#include\fP statements, meaning that the code within the included file is treated as if it appeared in the original file and, therefore, Java bindings are emitted for it. Here is an example:
.LP
.LP
.LP
\f4My.idl\fP
.LP
.nf
\f3
.fl
#include <MyOther.idl>
.fl
interface My
.fl
{
.fl
#include <Embedded.idl>
.fl
};
.fl
\fP
.fi
.LP
.LP
.LP
\f4MyOther.idl\fP
.LP
.nf
\f3
.fl
interface MyOther
.fl
{
.fl
};
.fl
\fP
.fi
.LP
.LP
.LP
\f4Embedded.idl\fP
.LP
.nf
\f3
.fl
enum E {one, two, three};
.fl
\fP
.fi
.LP
.LP
.LP
Running the following command:
.LP
.nf
\f3
.fl
idlj My.idl
.fl
\fP
.fi
.LP
.LP
will generate the following list of Java files:
.LP
.nf
\f3
.fl
./MyHolder.java
.fl
./MyHelper.java
.fl
./_MyStub.java
.fl
./MyPackage
.fl
./MyPackage/EHolder.java
.fl
./MyPackage/EHelper.java
.fl
./MyPackage/E.java
.fl
./My.java
.fl
\fP
.fi
.LP
.LP
Notice that \f2MyOther.java\fP was not generated because it is defined in an import\-like \f2#include\fP. But \f2E.java\fP \f2was\fP generated because it was defined in a true \f2#include\fP. Also notice that since \f2Embedded.idl\fP was included within the scope of the interface \f2My\fP, it appears within the scope of \f2My\fP (that is,in \f2MyPackage\fP).
.LP
Notice that \f2MyOther.java\fP was not generated because it is defined in an import\-like \f2#include\fP. But \f2E.java\fP \f2was\fP generated because it was defined in a true \f2#include\fP. Also notice that since \f2Embedded.idl\fP was included within the scope of the interface \f2My\fP, it appears within the scope of \f2My\fP (that is,in \f2MyPackage\fP).
.LP
If the \f2\-emitAll\fP flag had been used in the previous example, then all types in all included files would be emitted.
.LP
.RE
.SS
Inserting Package Prefixes
.LP
.RS 3
.LP
Suppose that you work for a company named ABC that has constructed the following IDL file:
.LP
.LP
Suppose that you work for a company named ABC that has constructed the following IDL file:
.br
\f4Widgets.idl\fP
.LP
\f2module Widgets\fP
.br
\f2{\fP
.br
\f2\ interface W1 {...};\fP
.br
\f2\ interface W2 {...};\fP
.br
\f2};\fP\
\f4Widgets.idl\fP
.LP
Running this file through the IDL\-to\-Java compiler will place the Java bindings for \f2W1\fP and \f2W2\fP within the package \f2Widgets\fP. But there is an industry convention that states that a company's packages should reside within a package named \f2com.<company name>\fP. The \f2Widgets\fP package is not good enough. To follow convention, it should be \f2com.abc.Widgets\fP. To place this package prefix onto the \f2Widgets\fP module, execute the following: \f2idlj \fP\f4\-pkgPrefix Widgets com.abc\fP\f2 Widgets.idl\fP
.nf
\f3
.fl
module Widgets
.fl
{
.fl
interface W1 {...};
.fl
interface W2 {...};
.fl
};
.fl
\fP
.fi
.LP
.LP
.LP
Running this file through the IDL\-to\-Java compiler will place the Java bindings for \f2W1\fP and \f2W2\fP within the package \f2Widgets\fP. But there is an industry convention that states that a company's packages should reside within a package named \f2com.<company name>\fP. The \f2Widgets\fP package is not good enough. To follow convention, it should be \f2com.abc.Widgets\fP. To place this package prefix onto the \f2Widgets\fP module, execute the following:
.LP
.nf
\f3
.fl
idlj \fP\f3\-pkgPrefix Widgets com.abc\fP Widgets.idl
.fl
.fi
.LP
.LP
If you have an IDL file which includes \f2Widgets.idl\fP, the \f2\-pkgPrefix\fP flag must appear in that command also. If it does not, then your IDL file will be looking for a \f2Widgets\fP package rather than a \f2com.abc.Widgets\fP package.
.LP
If you have an IDL file which includes \f2Widgets.idl\fP, the \f2\-pkgPrefix\fP flag must appear in that command also. If it does not, then your IDL file will be looking for a \f2Widgets\fP package rather than a \f2com.abc.Widgets\fP package.
.LP
If you have a number of these packages that require prefixes, it might be easier to place them into the \f2idl.config\fP file described above. Each package prefix line should be of the form:
.LP
\f2PkgPrefix.<type>=<prefix>\fP
.nf
\f3
.fl
PkgPrefix.<type>=<prefix>
.fl
\fP
.fi
.LP
So the line for the above example would be: \f2PkgPrefix.Widgets=com.abc\fP
So the line for the above example would be:
.nf
\f3
.fl
PkgPrefix.Widgets=com.abc
.fl
\fP
.fi
.LP
.LP
The use of this option does not affect the Repository ID.
.LP
.RE
.SS
Defining Symbols Before Compilation
.LP
.RS 3
.LP
You may need to define a symbol for compilation that is not defined within the IDL file, perhaps to include debugging code in the bindings. The command
.LP
.nf
\f3
.fl
idlj \fP\f3\-d\fP MYDEF My.idl
.fl
.fi
.LP
You may need to define a symbol for compilation that is not defined within the IDL file, perhaps to include debugging code in the bindings. The command \f2idlj \fP\f4\-d\fP\f2 MYDEF My.idl\fP
.LP
is the equivalent of putting the line \f2#define MYDEF\fP inside \f2My.idl\fP.
.RE
.LP
.SS
Preserving Pre\-Existing Bindings
.LP
.RS 3
.LP
If the Java binding files already exist, the \f2\-keep\fP flag will keep the compiler from overwriting them. The default is to generate all files without considering if they already exist. If you've customized those files (which you should not do unless you are very comfortable with their contents), then the \f2\-keep\fP option is very useful. The command
.LP
.nf
\f3
.fl
idlj \fP\f3\-keep\fP My.idl
.fl
.fi
.LP
If the Java binding files already exist, the \f2\-keep\fP flag will keep the compiler from overwriting them. The default is to generate all files without considering if they already exist. If you've customized those files (which you should not do unless you are very comfortable with their contents), then the \f2\-keep\fP option is very useful. The command \f2idlj \fP\f4\-keep\fP\f2 My.idl\fP
.LP
emit all client\-side bindings that do not already exist.
.RE
emits all client\-side bindings that do not already exist.
.LP
.SS
Viewing Progress of Compilation
.LP
.RS 3
.LP
The IDL\-to\-Java compiler will generate status messages as it progresses through its phases of execution. Use the \f2\-v\fP option to activate this "verbose" mode:
.LP
.nf
\f3
.fl
idlj \fP\f3\-v\fP My.idl
.fl
.fi
.LP
The IDL\-to\-Java compiler will generate status messages as it progresses through its phases of execution. Use the \f2\-v\fP option to activate this "verbose" mode: \f2idlj \fP\f4\-v\fP\f2 My.idl\fP
.LP
By default the compiler does not operate in verbose mode.
.RE
.LP
.SS
Displaying Version Information
.LP
.RS 3
.LP
.LP
To display the build version of the IDL\-to\-Java compiler, specify the \f2\-version\fP option on the command\-line:
.LP
.LP
\f2idlj \-version\fP
.nf
\f3
.fl
idlj \-version
.fl
\fP
.fi
.LP
.LP
Version information also appears within the bindings generated by the compiler. Any additional options appearing on the command\-line are ignored.
.LP
.RE
.SH "Options"
.LP
.LP
.RS 3
.TP 3
\-d symbol
This is equivalent to the following line in an IDL file:
.RS 3
.LP
.nf
\f3
.fl
@ -386,7 +620,6 @@ This is equivalent to the following line in an IDL file:
.fl
\fP
.fi
.RE
.TP 3
\-emitAll
Emit all types, including those found in \f2#include\fP files.
@ -410,8 +643,9 @@ Generates skeletons compatible with pre\-1.4 JDK ORBs. By default, the POA Inher
Wherever \f2type\fP is encountered at file scope, prefix the generated Java package name with \f2prefix\fP for all files generated for that type. The \f2type\fP is the simple name of either a top\-level module, or an IDL type defined outside of any module.
.TP 3
\-pkgTranslate type package
Whenever the module name \f2type\fP is encountered in an identifier, replace it in the identifier with \f2package\fP for all files in the generated Java package. Note that \f2pkgPrefix\fP changes are made first. \f2type\fP is the simple name of either a top\-level module, or an IDL type defined outside of any module, and must match the full package name exactly.
.LP
Whenever the module name \f2type\fP is encountered in an identifier, replace it in the identifier with \f2package\fP for all files in the generated Java package. Note that \f2pkgPrefix\fP changes are made first. \f2type\fP is the simple name of either a top\-level module, or an IDL type defined outside of any module, and must match the full package name exactly.
.br
.br
If more than one translation matches an identifier, the longest match is chosen. For example, if the arguments include:
.nf
\f3
@ -420,7 +654,6 @@ If more than one translation matches an identifier, the longest match is chosen.
.fl
\fP
.fi
.LP
The following translations would occur:
.nf
\f3
@ -435,7 +668,6 @@ foo.baz.bar => buzz.fizz.bar
.fl
\fP
.fi
.LP
The following package names cannot be translated:
.RS 3
.TP 2
@ -445,8 +677,7 @@ o
o
\f2org.omg\fP or any subpackages of \f2org.omg\fP
.RE
.LP
Any attempt to translate these packages will result in uncompilable code, and the use of these packages as the first argument after \f2\-pkgTranslate\fP will be treated as an error.
Any attempt to translate these packages will result in uncompilable code, and the use of these packages as the first argument after \f2\-pkgTranslate\fP will be treated as an error.
.TP 3
\-skeletonName xxx%yyy
Use \f2xxx%yyy\fP as the pattern for naming the skeleton. The defaults are:
@ -481,10 +712,10 @@ Display version information and terminate.
.RE
.LP
See the Description section for more option information.
.SH "Restrictions:"
.LP
See the Description section for more option information.
.LP
.SH "Restrictions:"
.LP
.RS 3
.TP 2
@ -497,8 +728,6 @@ The \f2fixed\fP IDL type is not supported.
.LP
.SH "Known Problems:"
.LP
.LP
.RS 3
.TP 2

170
jdk/src/solaris/doc/sun/man/man1/jar.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,16 +19,14 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jar 1 "02 Jun 2010"
.TH jar 1 "10 May 2011"
.LP
.SH "Name"
jar\-The Java Archive Tool
.LP
\f3jar\fP combines multiple files into a single JAR archive file.
\f3jar\fP combines multiple files into a single JAR archive file.
.SH "SYNOPSIS"
.LP
.LP
.RS 3
.TP 3
@ -51,9 +49,6 @@ Add index to jar file
.LP
.LP
where:
.LP
.RS 3
.LP
.RS 3
.TP 3
@ -80,10 +75,7 @@ Option to be passed into the Java runtime environment. (There must be no space b
.RE
.LP
.RE
.SH "DESCRIPTION"
.LP
.LP
The \f3jar\fP tool combines multiple files into a single JAR archive file. \f3jar\fP is a general\-purpose archiving and compression tool, based on ZIP and the
.na
@ -92,9 +84,6 @@ The \f3jar\fP tool combines multiple files into a single JAR archive file. \f3ja
http://www.gzip.org/zlib/ compression format. However, \f3jar\fP was designed mainly package java applets or applications into a single archive. When the components of an applet or application (files, images and sounds) are combined into a single archive, they can be downloaded by a java agent (like a browser) in a single HTTP transaction, rather than requiring a new connection for each piece. This dramatically improves download times. \f3jar\fP also compresses files and so further improves download time. In addition, it allows individual entries in a file to be signed by the applet author so that their origin can be authenticated. The syntax for the jar tool is almost identical to the syntax for the \f2tar\fP command. A \f3jar\fP archive can be used as a class path entry, whether or not it is compressed.
.LP
Typical usage to combine files into a jar file is:
.LP
.RS 3
.LP
.nf
\f3
@ -103,19 +92,15 @@ Typical usage to combine files into a jar file is:
.fl
\fP
.fi
.RE
.LP
In this example, all the class files in the current directory are placed into the file named \f2myFile.jar\fP. The jar tool automatically generates a manifest file entry named \f2META\-INF/MANIFEST.MF\fP. It is always the first entry in the jar file. The manifest file declares meta\-information about the archive, and stores that data as \f2name\ :\ value\fP pairs. Refer to the
.na
\f2JAR file specification\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/jar/jar.html#JAR%20Manifest for details explaining how the jar tool stores meta\-information in the manifest file.
http://download.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#JAR%20Manifest for details explaining how the jar tool stores meta\-information in the manifest file.
.LP
If a jar file should include \f2name\ :\ value\fP pairs contained in an existing manifest file, specify that file using the \f2\-m\fP option:
.LP
.RS 3
.LP
.nf
\f3
@ -124,7 +109,6 @@ If a jar file should include \f2name\ :\ value\fP pairs contained in an existing
.fl
\fP
.fi
.RE
.LP
An existing manifest file must end with a new line character.\ \f3jar\fP does not parse the last line of a manifest file if it does not end with a new line character.
@ -135,9 +119,6 @@ An existing manifest file must end with a new line character.\ \f3jar\fP does n
.LP
\f3Note:\ \fP A jar command that specifies \f2cfm\fP on the command line instead of \f2cmf\fP (the order of the m and \-f options are reversed), the \f3jar\fP command line must specify the name of the jar archive first, followed by the name of the manifest file:
.RS 3
.LP
.nf
\f3
.fl
@ -145,15 +126,11 @@ An existing manifest file must end with a new line character.\ \f3jar\fP does n
.fl
\fP
.fi
.RE
.LP
The manifest is in a text format inspired by RFC822 ASCII format, so it is easy to view and process manifest\-file contents.
.LP
To extract the files from a jar file, use \f2x\fP:
.LP
.RS 3
.LP
.nf
\f3
@ -162,14 +139,10 @@ To extract the files from a jar file, use \f2x\fP:
.fl
\fP
.fi
.RE
.LP
.LP
To extract individual files from a jar file, supply their filenames:
.LP
.RS 3
.LP
.nf
\f3
@ -178,7 +151,6 @@ To extract individual files from a jar file, supply their filenames:
.fl
\fP
.fi
.RE
.LP
.LP
@ -186,10 +158,7 @@ Beginning with version 1.3 of the JDK, the \f2jar\fP utility supports
.na
\f2JarIndex\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/jar/jar.html#JAR%20Index, which allows application class loaders to load classes more efficiently from jar files. If an application or applet is bundled into multiple jar files,\ only the necessary jar files will be downloaded and opened to load classes. This performance optimization is enabled by running \f2jar\fP with the \f2\-i\fPoption. It will generate package location information for the specified main jar file and all the jar files it depends on, which need to be specified in the \f2Class\-Path\fP attribute of the main jar file's manifest.
.LP
.RS 3
http://download.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#JAR_Index, which allows application class loaders to load classes more efficiently from jar files. If an application or applet is bundled into multiple jar files,\ only the necessary jar files will be downloaded and opened to load classes. This performance optimization is enabled by running \f2jar\fP with the \f2\-i\fPoption. It will generate package location information for the specified main jar file and all the jar files it depends on, which need to be specified in the \f2Class\-Path\fP attribute of the main jar file's manifest.
.LP
.nf
\f3
@ -198,7 +167,6 @@ http://java.sun.com/javase/6/docs/technotes/guides/jar/jar.html#JAR%20Index, whi
.fl
\fP
.fi
.RE
.LP
.LP
@ -209,9 +177,6 @@ The application class loader uses the information stored in this file for effici
.br
.br
To copy directories, first compress files in \f2dir1\fP to \f2stdout\fP, then extract from \f2stdin\fP to \f2dir2\fP (omitting the \f2\-f\fP option from both \f2jar\fP commands):
.LP
.RS 3
.LP
.nf
\f3
@ -220,7 +185,6 @@ To copy directories, first compress files in \f2dir1\fP to \f2stdout\fP, then ex
.fl
\fP
.fi
.RE
.LP
.LP
@ -228,11 +192,9 @@ To review command samples which use \f2jar\fP to opeate on jar files and jar fil
.na
\f2Java Tutorial\fP @
.fi
http://java.sun.com/docs/books/tutorial/jar.
http://download.oracle.com/javase/tutorial/deployment/jar.
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
@ -241,9 +203,6 @@ Creates a new archive file named \f2jarfile\fP (if \f2f\fP is specified) or to s
.TP 3
u
Updates an existing file \f2jarfile\fP (when \f2f\fP is specified) by adding to it files and directories specified by \f2inputfiles\fP. For example:
.RS 3
.LP
.nf
\f3
.fl
@ -251,11 +210,7 @@ jar uf foo.jar foo.class
.fl
\fP
.fi
.RE
would add the file \f2foo.class\fP to the existing jar file \f2foo.jar\fP. The \f2\-u\fP option can also update the manifest entry, as given by this example:
.RS 3
.LP
.nf
\f3
.fl
@ -263,7 +218,6 @@ jar umf manifest foo.jar
.fl
\fP
.fi
.RE
updates the \f2foo.jar\fP manifest with the \f2name : value\fP pairs in \f2manifest\fP.
.TP 3
x
@ -274,9 +228,6 @@ Lists the table of contents from \f2jarfile\fP (if \f2f\fP is specified) or stan
.TP 3
i
Generate index information for the specified \f2jarfile\fP and its dependent jar files. For example:
.RS 3
.LP
.nf
\f3
.fl
@ -284,9 +235,8 @@ jar i foo.jar
.fl
\fP
.fi
.RE
.LP
would generate an \f2INDEX.LIST\fP file in \f2foo.jar\fP which contains location information for each package in \f2foo.jar\fP and all the jar files specified in the \f2Class\-Path\fP attribute of \f2foo.jar\fP. See the index example.
would generate an \f2INDEX.LIST\fP file in \f2foo.jar\fP which contains location information for each package in \f2foo.jar\fP and all the jar files specified in the \f2Class\-Path\fP attribute of \f2foo.jar\fP. See the index example.
.TP 3
f
Specifies the file \f2jarfile\fP to be created (\f2c\fP), updated (\f2u\fP), extracted (\f2x\fP), indexed (\f2i\fP), or viewed (\f2t\fP). The \f2\-f\fP option and filename \f2jarfile\fP are a pair \-\- if present, they must both appear. Omitting \f2f\fP and \f2jarfile\fP accepts a jar file name from \f2stdin\fP(for x and t) or sends jar file to \f2stdout\fP (for c and u).
@ -301,12 +251,10 @@ M
Do not create a manifest file entry (for c and u), or delete a manifest file entry if one exists (for u).
.TP 3
m
Includes \f2name : value\fP attribute pairs from the specified manifest file \f2manifest\fP in the file at \f2META\-INF/MANIFEST.MF\fP. \f2jar\fP adds a \f2name\ :\ value\fP pair unless an entry already exists with the same name, in which case \f2jar\fP updates its value.
.LP
Includes \f2name : value\fP attribute pairs from the specified manifest file \f2manifest\fP in the file at \f2META\-INF/MANIFEST.MF\fP. \f2jar\fP adds a \f2name\ :\ value\fP pair unless an entry already exists with the same name, in which case \f2jar\fP updates its value.
.br
.br
On the command line, the letters \f3m\fP and \f3f\fP must appear in the same order that \f2manifest\fP and \f2jarfile\fP appear. Example use:
.RS 3
.LP
.nf
\f3
.fl
@ -314,22 +262,18 @@ jar cmf myManifestFile myFile.jar *.class
.fl
\fP
.fi
.RE
You can add special\-purpose \f2name\ :\ value\fP attribute pairs to the manifest that aren't contained in the default manifest. For example, you can add attributes specifying vendor information, version information, package sealing, or to make JAR\-bundled applications executable. See the
.na
\f2JAR Files\fP @
.fi
http://java.sun.com/docs/books/tutorial/jar/ trail in the Java Tutorial for examples of using the \f4\-m\fP option.
.LP
http://download.oracle.com/javase/tutorial/deployment/jar/ trail in the Java Tutorial for examples of using the \f4\-m\fP option.
.TP 3
e
Sets \f2entrypoint\fP as the application entry point for stand\-alone applications bundled into executable jar file. The use of this option creates or overrides the \f2Main\-Class\fP attribute value in the manifest file. This option can be used during creation of jar file or while updating the jar file. This option specifies the application entry point without editing or creating the manifest file.
.br
.br
.br
For example, this command creates \f2Main.jar\fP where the \f2Main\-Class\fP attribute value in the manifest is set to \f2Main\fP:
.RS 3
.LP
.nf
\f3
.fl
@ -337,12 +281,7 @@ jar cfe Main.jar Main Main.class
.fl
\fP
.fi
.RE
.LP
The java runtime can directly invoke this application by running the following command:
.RS 3
.LP
.nf
\f3
.fl
@ -350,11 +289,7 @@ java \-jar Main.jar
.fl
\fP
.fi
.RE
If the entrypoint class name is in a package it may use either a dot (".") or slash ("/") character as the delimiter. For example, if \f2Main.class\fP is in a package called \f2foo\fP the entry point can be specified in the following ways:
.RS 3
.LP
.nf
\f3
.fl
@ -362,11 +297,7 @@ jar \-cfe Main.jar foo/Main foo/Main.class
.fl
\fP
.fi
.RE
or
.RS 3
.LP
.nf
\f3
.fl
@ -374,18 +305,13 @@ jar \-cfe Main.jar foo.Main foo/Main.class
.fl
\fP
.fi
.RE
\f3Note:\ \fP specifying both \f2\-m\fP and \f2\-e\fP options together when the given manifest also contains the \f2Main\-Class\fP attribute results in an ambigous \f2Main.class\fP specification, leading to an error and the jar creation or update operation is aborted.
.LP
\f3Note:\ \fP specifying both \f2\-m\fP and \f2\-e\fP options together when the given manifest also contains the \f2Main\-Class\fP attribute results in an ambigous \f2Main.class\fP specification, leading to an error and the jar creation or update operation is aborted.
.TP 3
\-C \ dir
\-C\ dir
Temporarily changes directories (\f2cd\fP\ \f2dir\fP) during execution of the \f2jar\fP command while processing the following \f2inputfiles\fP argument. Its operation is intended to be similar to the \f2\-C\fP option of the UNIX \f2tar\fP utility.
.br
.br
For example, this command changes to the \f2classes\fP directory and adds the \f2bar.class\fP from that directory to \f2foo.jar\fP:
.RS 3
.LP
.nf
\f3
.fl
@ -393,11 +319,7 @@ jar uf foo.jar \-C classes bar.class
.fl
\fP
.fi
.RE
This command changes to the \f2classes\fP directory and adds to \f2foo.jar\fP all files within the \f2classes\fP directory (without creating a classes directory in the jar file), then changes back to the original directory before changing to the \f2bin\fP directory to add \f2xyz.class\fP to \f2foo.jar\fP.
.RS 3
.LP
.nf
\f3
.fl
@ -405,11 +327,7 @@ jar uf foo.jar \-C classes . \-C bin xyz.class
.fl
\fP
.fi
.RE
If \f2classes\fP holds files \f2bar1\fP and \f2bar2\fP, then here's what the jar file will contain using \f2jar tf foo.jar\fP:
.RS 3
.LP
.nf
\f3
.fl
@ -425,7 +343,6 @@ xyz.class
.fl
\fP
.fi
.RE
.LP
.TP 3
\-Joption
@ -434,8 +351,6 @@ Pass \f2option\fP to the Java runtime environment, where \f2option\fP is one of
.LP
.SH "COMMAND LINE ARGUMENT FILES"
.LP
.LP
To shorten or simplify the jar command line, you can specify one or more files that themselves contain arguments to the \f2jar\fP command (except \f2\-J\fP options). This enables you to create jar commands of any length, overcoming command line limits imposed by the operating system.
.LP
@ -446,9 +361,6 @@ When executing \f2jar\fP, pass in the path and name of each argument file with t
.br
.br
The example below, \f2classes.list\fP holds the names of files output by a \f2find\fP command:
.LP
.RS 3
.LP
.nf
\f3
@ -456,14 +368,10 @@ The example below, \f2classes.list\fP holds the names of files output by a \f2fi
% find \fP\f3.\fP \-name '*.class' \-print > classes.list
.fl
.fi
.RE
.LP
.LP
You can then execute the \f2jar\fP command on \f2Classes.list\fP by passing it to \f2jar\fP using argfile syntax:
.LP
.RS 3
.LP
.nf
\f3
@ -472,13 +380,9 @@ You can then execute the \f2jar\fP command on \f2Classes.list\fP by passing it t
.fl
\fP
.fi
.RE
.LP
An argument file can specify a path, but any filenames inside the argument file that have relative paths are relative to the current working directory, not to the path passed in. Here is an example:
.RS 3
.LP
.nf
\f3
.fl
@ -486,20 +390,14 @@ An argument file can specify a path, but any filenames inside the argument file
.fl
\fP
.fi
.RE
.LP
.LP
.LP
.SH "EXAMPLES"
.LP
.LP
To add all the files in a particular directory to an archive (overwriting contents if the archive already exists). Enumerating verbosely (with the \f2\-v\fP option) will tell you more information about the files in the archive, such as their size and last modified date.
.RS 3
.LP
.nf
\f3
.fl
@ -535,13 +433,9 @@ adding: spacemusic.au(in = 3079) (out= 73)(deflated 97%)
.fl
\fP
.fi
.RE
.LP
If you already have separate subdirectories for images, audio files and classes, you can combine them into a single jar file:
.RS 3
.LP
.nf
\f3
.fl
@ -585,13 +479,9 @@ audio/ bundle.jar classes/ images/
.fl
\fP
.fi
.RE
.LP
To see the entry names in the jarfile, use the \f2t\fP option:
.RS 3
.LP
.nf
\f3
.fl
@ -619,7 +509,6 @@ images/at_work.gif
.fl
\fP
.fi
.RE
.LP
.LP
@ -629,9 +518,6 @@ To add an index file to the jar file for speeding up class loading, use the \f2i
Example:
.br
.LP
.RS 3
.LP
If you split the inter\-dependent classes for a stock trade application into three jar files: \f2main.jar\fP, \f2buy.jar\fP, and \f2sell.jar\fP.
.br
@ -660,38 +546,34 @@ then you can use the \f2\-i\fP option to speed up the class loading time for you
.fi
.LP
An \f2INDEX.LIST\fP file is inserted to the \f2META\-INF\fP directory. This enables the application class loader to download the specified jar files when it is searching for classes or resources.
.RE
An \f2INDEX.LIST\fP file is inserted to the \f2META\-INF\fP directory. This enables the application class loader to download the specified jar files when it is searching for classes or resources.
.SH "SEE ALSO"
.LP
.LP
.na
\f2The Jar Overview\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/jar/jarGuide.html
.br
http://download.oracle.com/javase/7/docs/technotes/guides/jar/jarGuide.html
.LP
.LP
.na
\f2The Jar File Specification\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/jar/jar.html
.br
http://download.oracle.com/javase/7/docs/technotes/guides/jar/jar.html
.LP
.LP
.na
\f2The JarIndex Spec\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/jar/jar.html#JAR%20Index
.br
http://download.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#JAR_Index
.LP
.LP
.na
\f2Jar Tutorial\fP @
.fi
http://java.sun.com/docs/books/tutorial/jar on the Java Software web site.
.br
http://download.oracle.com/javase/tutorial/deployment/jar/index.html
.LP
pack200(1)
.LP
pack200(1)
.LP

413
jdk/src/solaris/doc/sun/man/man1/jarsigner.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1998, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,22 +19,16 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jarsigner 1 "02 Jun 2010"
.TH jarsigner 1 "10 May 2011"
.LP
.SH "Name"
jarsigner \- JAR Signing and Verification Tool
.LP
.RS 3
.LP
.LP
Generates signatures for Java ARchive (JAR) files, and verifies the signatures of signed JAR files.
.LP
.RE
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -50,8 +44,6 @@ Generates signatures for Java ARchive (JAR) files, and verifies the signatures o
The jarsigner \-verify command can take zero or more keystore alias names after the jar filename. When specified, jarsigner will check that the certificate used to verify each signed entry in the jar file matches one of the keystore aliases. The aliases are defined in the keystore specified by \-keystore, or the default keystore.
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f3jarsigner\fP tool is used for two purposes:
@ -108,9 +100,6 @@ The default \f3jarsigner\fP behavior is to \f2sign\fP a JAR (or zip) file. Use t
.LP
.SS
Keystore Aliases
.LP
.RS 3
.LP
.LP
All keystore entities are accessed via unique \f2aliases\fP.
@ -121,23 +110,19 @@ When using \f3jarsigner\fP to sign a JAR file, you must specify the alias for th
.nf
\f3
.fl
jarsigner \-keystore /working/mystore \-storepass myspass
jarsigner \-keystore /working/mystore \-storepass \fP\f4<keystore password>\fP\f3
.fl
\-keypass dukekeypasswd MyJARFile.jar duke
\-keypass \fP\f4<private key password>\fP\f3 MyJARFile.jar duke
.fl
\fP
.fi
.LP
.LP
Keystores are protected with a password, so the store password (in this case "myspass") must be specified. You will be prompted for it if you don't specify it on the command line. Similarly, private keys are protected in a keystore with a password, so the private key's password (in this case "dukekeypasswd") must be specified, and you will be prompted for it if you don't specify it on the command line and it isn't the same as the store password.
Keystores are protected with a password, so the store password must be specified. You will be prompted for it if you don't specify it on the command line. Similarly, private keys are protected in a keystore with a password, so the private key's password must be specified, and you will be prompted for it if you don't specify it on the command line and it isn't the same as the store password.
.LP
.RE
.SS
Keystore Location
.LP
.RS 3
.LP
.LP
\f3jarsigner\fP has a \f2\-keystore\fP option for specifying the URL of the keystore to be used. The keystore is by default stored in a file named \f2.keystore\fP in the user's home directory, as determined by the \f2user.home\fP system property. On Solaris systems \f2user.home\fP defaults to the user's home directory.
@ -145,12 +130,8 @@ Keystore Location
.LP
Note that the input stream from the \f2\-keystore\fP option is passed to the \f2KeyStore.load\fP method. If \f2NONE\fP is specified as the URL, then a null stream is passed to the \f2KeyStore.load\fP method. \f2NONE\fP should be specified if the \f2KeyStore\fP is not file\-based, for example, if it resides on a hardware token device.
.LP
.RE
.SS
Keystore Implementation
.LP
.RS 3
.LP
.LP
The \f2KeyStore\fP class provided in the \f2java.security\fP package supplies well\-defined interfaces to access and modify the information in a keystore. It is possible for there to be multiple different concrete implementations, where each implementation is that for a particular \f2type\fP of keystore.
@ -166,13 +147,13 @@ Keystore implementations are provider\-based. More specifically, the application
.na
\f2How to Implement a Provider for the Java Cryptography Architecture\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/security/crypto/HowToImplAProvider.html.
http://download.oracle.com/javase/7/docs/technotes/guides/security/crypto/HowToImplAProvider.html.
.LP
.LP
Applications can choose different \f2types\fP of keystore implementations from different providers, using the "getInstance" factory method supplied in the \f2KeyStore\fP class. A keystore type defines the storage and data format of the keystore information, and the algorithms used to protect private keys in the keystore and the integrity of the keystore itself. Keystore implementations of different types are not compatible.
.LP
.LP
\f3keytool\fP works on any file\-based keystore implementation. (It treats the keytore location that is passed to it at the command line as a filename and converts it to a FileInputStream, from which it loads the keystore information.) The \f3jarsigner\fP and \f3policytool\fP tools, on the other hand, can read a keystore from any location that can be specified using a URL.
\f3keytool\fP works on any file\-based keystore implementation. (It treats the keystore location that is passed to it at the command line as a filename and converts it to a FileInputStream, from which it loads the keystore information.) The \f3jarsigner\fP and \f3policytool\fP tools, on the other hand, can read a keystore from any location that can be specified using a URL.
.LP
.LP
For \f3jarsigner\fP and \f3keytool\fP, you can specify a keystore type at the command line, via the \f2\-storetype\fP option. For \f3Policy Tool\fP, you can specify a keystore type via the "Change Keystore" command in the Edit menu.
@ -227,40 +208,35 @@ Note that if you us the PKCS#11 provider package, you should refer to the
.na
\f2KeyTool and JarSigner\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/security/p11guide.html#KeyToolJarSigner section of the Java PKCS#11 Reference Guide for details.
http://download.oracle.com/javase/7/docs/technotes/guides/security/p11guide.html#KeyToolJarSigner section of the Java PKCS#11 Reference Guide for details.
.LP
.RE
.SS
Supported Algorithms
.LP
.RS 3
.LP
.LP
By default, \f3jarsigner\fP signs a JAR file using either
By default, \f3jarsigner\fP signs a JAR file using one of the following:
.LP
.RS 3
.TP 2
o
DSA (Digital Signature Algorithm) with the SHA\-1 digest algorithm, or
DSA (Digital Signature Algorithm) with the SHA1 digest algorithm
.TP 2
o
the RSA algorithm with the SHA\-256 digest algorithm.
RSA algorithm with the SHA256 digest algorithm.
.TP 2
o
EC (Elliptic Curve) cryptography algorithm with the SHA256 with ECDSA (Elliptic Curve Digital Signature Algorithm).
.RE
.LP
.LP
That is, if the signer's public and private keys are DSA keys, \f3jarsigner\fP will sign the JAR file using the "SHA1withDSA" algorithm. If the signer's keys are RSA keys, \f3jarsigner\fP will attempt to sign the JAR file using the "SHA256withRSA" algorithm.
That is, if the signer's public and private keys are DSA keys, \f3jarsigner\fP will sign the JAR file using the "SHA1withDSA" algorithm. If the signer's keys are RSA keys, \f3jarsigner\fP will attempt to sign the JAR file using the "SHA256withRSA" algorithm. If the signer's keys are EC keys, \f3jarsigner\fP will sign the JAR file using the "SHA256withECDSA" algorithm.
.LP
.LP
These default signature algorithms can be overridden using the \f2\-sigalg\fP option.
.LP
.RE
.SS
The Signed JAR File
.LP
.RS 3
.LP
.LP
When \f3jarsigner\fP is used to sign a JAR file, the output signed JAR file is exactly the same as the input JAR file, except that it has two additional files placed in the META\-INF directory:
@ -271,7 +247,7 @@ o
a signature file, with a .SF extension, and
.TP 2
o
a signature block file, with a .DSA extension.
a signature block file, with a .DSA, .RSA, or .EC extension.
.RE
.LP
@ -281,22 +257,19 @@ The base file names for these two files come from the value of the \f2\-sigFile\
.nf
\f3
.fl
\-sigFile MKSIGN
\-sigFile MKSIGN
.fl
\fP
.fi
.LP
.LP
the files are named "MKSIGN.SF" and "MKSIGN.DSA".
The files are named "MKSIGN.SF" and "MKSIGN.DSA".
.LP
.LP
If no \f2\-sigfile\fP option appears on the command line, the base file name for the .SF and .DSA files will be the first 8 characters of the alias name specified on the command line, all converted to upper case. If the alias name has fewer than 8 characters, the full alias name is used. If the alias name contains any characters that are not allowed in a signature file name, each such character is converted to an underscore ("_") character in forming the file name. Legal characters include letters, digits, underscores, and hyphens.
.LP
\f3The Signature (.SF) File\fP
.LP
.RS 3
.LP
.LP
A signature file (the .SF file) looks similar to the manifest file that is always included in a JAR file when \f3jarsigner\fP is used to sign the file. That is, for each source file included in the JAR file, the .SF file has three lines, just as in the manifest file, listing the following:
@ -320,25 +293,14 @@ In the manifest file, the SHA digest value for each source file is the digest (h
.LP
The signature file also, by default, includes a header containing a hash of the whole manifest file. The presence of the header enables verification optimization, as described in JAR File Verification.
.LP
.RE
\f3The Signature Block (.DSA) File\fP
\f3The Signature Block File\fP
.LP
.RS 3
.LP
.LP
The .SF file is signed and the signature is placed in the .DSA file. The .DSA file also contains, encoded inside it, the certificate or certificate chain from the keystore which authenticates the public key corresponding to the private key used for signing.
.LP
.RE
.RE
The .SF file is signed and the signature is placed in the signature block file. This file also contains, encoded inside it, the certificate or certificate chain from the keystore which authenticates the public key corresponding to the private key used for signing. The file has the extension .DSA, .RSA, or .EC depending on the digest algorithm used.
.SS
Signature Timestamp
.LP
.RS 3
.LP
.LP
\f2jarsigner\fP tool can now generate and store a signature timestamp when signing a JAR file. In addition, \f2jarsigner\fP supports alternative signing mechanisms. This behavior is optional and is controlled by the user at the time of signing through these options:
\f2jarsigner\fP tool can generate and store a signature timestamp when signing a JAR file. In addition, \f2jarsigner\fP supports alternative signing mechanisms. This behavior is optional and is controlled by the user at the time of signing through these options:
.LP
.RS 3
.TP 2
@ -359,12 +321,8 @@ o
.LP
Each of these options is detailed in the Options section below.
.LP
.RE
.SS
JAR File Verification
.LP
.RS 3
.LP
.LP
A successful JAR file verification occurs if the signature(s) are valid, and none of the files that were in the JAR file when the signatures were generated have been changed since then. JAR file verification involves the following steps:
@ -372,18 +330,22 @@ A successful JAR file verification occurs if the signature(s) are valid, and non
.RS 3
.TP 3
1.
Verify the signature of the .SF file itself.
.LP
That is, the verification ensures that the signature stored in each signature block (.DSA) file was in fact generated using the private key corresponding to the public key whose certificate (or certificate chain) also appears in the .DSA file. It also ensures that the signature is a valid signature of the corresponding signature (.SF) file, and thus the .SF file has not been tampered with.
Verify the signature of the .SF file itself.
.br
.br
That is, the verification ensures that the signature stored in each signature block (.DSA) file was in fact generated using the private key corresponding to the public key whose certificate (or certificate chain) also appears in the .DSA file. It also ensures that the signature is a valid signature of the corresponding signature (.SF) file, and thus the .SF file has not been tampered with.
.TP 3
2.
Verify the digest listed in each entry in the .SF file with each corresponding section in the manifest.
.LP
The .SF file by default includes a header containing a hash of the entire manifest file. When the header is present, then the verification can check to see whether or not the hash in the header indeed matches the hash of the manifest file. If that is the case, verification proceeds to the next step.
.LP
If that is not the case, a less optimized verification is required to ensure that the hash in each source file information section in the .SF file equals the hash of its corresponding section in the manifest file (see The Signature (.SF) File).
.LP
One reason the hash of the manifest file that is stored in the .SF file header may not equal the hash of the current manifest file would be because one or more files were added to the JAR file (using the \f2jar\fP tool) after the signature (and thus the .SF file) was generated. When the \f2jar\fP tool is used to add files, the manifest file is changed (sections are added to it for the new files), but the .SF file is not. A verification is still considered successful if none of the files that were in the JAR file when the signature was generated have been changed since then, which is the case if the hashes in the non\-header sections of the .SF file equal the hashes of the corresponding sections in the manifest file.
Verify the digest listed in each entry in the .SF file with each corresponding section in the manifest.
.br
.br
The .SF file by default includes a header containing a hash of the entire manifest file. When the header is present, then the verification can check to see whether or not the hash in the header indeed matches the hash of the manifest file. If that is the case, verification proceeds to the next step.
.br
.br
If that is not the case, a less optimized verification is required to ensure that the hash in each source file information section in the .SF file equals the hash of its corresponding section in the manifest file (see The Signature (.SF) File).
.br
.br
One reason the hash of the manifest file that is stored in the .SF file header may not equal the hash of the current manifest file would be because one or more files were added to the JAR file (using the \f2jar\fP tool) after the signature (and thus the .SF file) was generated. When the \f2jar\fP tool is used to add files, the manifest file is changed (sections are added to it for the new files), but the .SF file is not. A verification is still considered successful if none of the files that were in the JAR file when the signature was generated have been changed since then, which is the case if the hashes in the non\-header sections of the .SF file equal the hashes of the corresponding sections in the manifest file.
.TP 3
3.
Read each file in the JAR file that has an entry in the .SF file. While reading, compute the file's digest, and then compare the result with the digest for this file in the manifest section. The digests should be the same, or verification fails.
@ -393,12 +355,8 @@ Read each file in the JAR file that has an entry in the .SF file. While reading,
.LP
If any serious verification failures occur during the verification process, the process is stopped and a security exception is thrown. It is caught and displayed by \f3jarsigner\fP.
.LP
.RE
.SS
Multiple Signatures for a JAR File
.LP
.RS 3
.LP
.LP
A JAR file can be signed by multiple people simply by running the \f3jarsigner\fP tool on the file multiple times, specifying the alias for a different person each time, as in:
@ -435,10 +393,7 @@ When a JAR file is signed multiple times, there are multiple .SF and .DSA files
.LP
Note: It is also possible for a JAR file to have mixed signatures, some generated by the JDK 1.1 \f3javakey\fP tool and others by \f3jarsigner\fP. That is, \f3jarsigner\fP can be used to sign JAR files already previously signed using \f3javakey\fP.
.LP
.RE
.SH "OPTIONS"
.LP
.LP
.LP
The various \f3jarsigner\fP options are listed and described below. Note:
@ -462,12 +417,15 @@ The \f2\-keystore\fP, \f2\-storepass\fP, \f2\-keypass\fP, \f2\-sigfile\fP, \f2\-
.RS 3
.TP 3
\-keystore url
Specifies the URL that tells the keystore location. This defaults to the file \f2.keystore\fP in the user's home directory, as determined by the "user.home" system property.
.LP
A keystore is required when signing, so you must explicitly specify one if the default keystore does not exist (or you want to use one other than the default).
.LP
A keystore is \f2not\fP required when verifying, but if one is specified, or the default exists, and the \f2\-verbose\fP option was also specified, additional information is output regarding whether or not any of the certificates used to verify the JAR file are contained in that keystore.
.LP
Specifies the URL that tells the keystore location. This defaults to the file \f2.keystore\fP in the user's home directory, as determined by the "user.home" system property.
.br
.br
A keystore is required when signing, so you must explicitly specify one if the default keystore does not exist (or you want to use one other than the default).
.br
.br
A keystore is \f2not\fP required when verifying, but if one is specified, or the default exists, and the \f2\-verbose\fP option was also specified, additional information is output regarding whether or not any of the certificates used to verify the JAR file are contained in that keystore.
.br
.br
Note: the \f2\-keystore\fP argument can actually be a file name (and path) specification rather than a URL, in which case it will be treated the same as a "file:" URL. That is,
.nf
\f3
@ -494,79 +452,93 @@ o
\f2\-storetype PKCS11\fP
.RE
For example, this command lists the contents of the configured PKCS#11 token:
.RS 3
.LP
.nf
\f3
.fl
jarsigner \-keystore NONE \-storetype PKCS11 \-list
.fl
.fl
\fP
.fi
.RE
.TP 3
\-storetype storetype
Specifies the type of keystore to be instantiated. The default keystore type is the one that is specified as the value of the "keystore.type" property in the security properties file, which is returned by the static \f2getDefaultType\fP method in \f2java.security.KeyStore\fP.
.LP
The PIN for a PCKS#11 token can also be specified using the \f2\-storepass\fP option. If none has been specified, keytool and jarsigner will prompt for the token PIN. If the token has a protected authentication path (such as a dedicated PIN\-pad or a biometric reader), then the \f2\-protected\fP option must be specified and no password options can be specified.
Specifies the type of keystore to be instantiated. The default keystore type is the one that is specified as the value of the "keystore.type" property in the security properties file, which is returned by the static \f2getDefaultType\fP method in \f2java.security.KeyStore\fP.
.br
.br
The PIN for a PCKS#11 token can also be specified using the \f2\-storepass\fP option. If none has been specified, keytool and jarsigner will prompt for the token PIN. If the token has a protected authentication path (such as a dedicated PIN\-pad or a biometric reader), then the \f2\-protected\fP option must be specified and no password options can be specified.
.TP 3
\-storepass password
Specifies the password which is required to access the keystore. This is only needed when signing (not verifying) a JAR file. In that case, if a \f2\-storepass\fP option is not provided at the command line, the user is prompted for the password.
.LP
Note: The password shouldn't be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system.
\-storepass[:env | :file] argument
Specifies the password which is required to access the keystore. This is only needed when signing (not verifying) a JAR file. In that case, if a \f2\-storepass\fP option is not provided at the command line, the user is prompted for the password.
.br
.br
If the modifier \f2env\fP or \f2file\fP is not specified, then the password has the value \f2argument\fP. Otherwise, the password is retrieved as follows:
.RS 3
.TP 2
o
\f2env\fP: Retrieve the password from the environment variable named \f2argument\fP
.TP 2
o
\f2file\fP: Retrieve the password from the file named \f2argument\fP
.RE
Note: The password shouldn't be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system.
.TP 3
\-keypass password
Specifies the password used to protect the private key of the keystore entry addressed by the alias specified on the command line. The password is required when using \f3jarsigner\fP to sign a JAR file. If no password is provided on the command line, and the required password is different from the store password, the user is prompted for it.
.LP
Note: The password shouldn't be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system. Also, when typing in a password at the password prompt, the password is echoed (displayed exactly as typed), so be careful not to type it in front of anyone.
\-keypass[:env | :file] argument
Specifies the password used to protect the private key of the keystore entry addressed by the alias specified on the command line. The password is required when using \f3jarsigner\fP to sign a JAR file. If no password is provided on the command line, and the required password is different from the store password, the user is prompted for it.
.br
.br
If the modifier \f2env\fP or \f2file\fP is not specified, then the password has the value \f2argument\fP. Otherwise, the password is retrieved as follows:
.RS 3
.TP 2
o
\f2env\fP: Retrieve the password from the environment variable named \f2argument\fP
.TP 2
o
\f2file\fP: Retrieve the password from the file named \f2argument\fP
.RE
Note: The password shouldn't be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system.
.TP 3
\-sigfile file
Specifies the base file name to be used for the generated .SF and .DSA files. For example, if \f2file\fP is "DUKESIGN", the generated .SF and .DSA files will be named "DUKESIGN.SF" and "DUKESIGN.DSA", and will be placed in the "META\-INF" directory of the signed JAR file.
.LP
The characters in \f2file\fP must come from the set "a\-zA\-Z0\-9_\-". That is, only letters, numbers, underscore, and hyphen characters are allowed. Note: All lowercase characters will be converted to uppercase for the .SF and .DSA file names.
.LP
If no \f2\-sigfile\fP option appears on the command line, the base file name for the .SF and .DSA files will be the first 8 characters of the alias name specified on the command line, all converted to upper case. If the alias name has fewer than 8 characters, the full alias name is used. If the alias name contains any characters that are not legal in a signature file name, each such character is converted to an underscore ("_") character in forming the file name.
Specifies the base file name to be used for the generated .SF and .DSA files. For example, if \f2file\fP is "DUKESIGN", the generated .SF and .DSA files will be named "DUKESIGN.SF" and "DUKESIGN.DSA", and will be placed in the "META\-INF" directory of the signed JAR file.
.br
.br
The characters in \f2file\fP must come from the set "a\-zA\-Z0\-9_\-". That is, only letters, numbers, underscore, and hyphen characters are allowed. Note: All lowercase characters will be converted to uppercase for the .SF and .DSA file names.
.br
.br
If no \f2\-sigfile\fP option appears on the command line, the base file name for the .SF and .DSA files will be the first 8 characters of the alias name specified on the command line, all converted to upper case. If the alias name has fewer than 8 characters, the full alias name is used. If the alias name contains any characters that are not legal in a signature file name, each such character is converted to an underscore ("_") character in forming the file name.
.TP 3
\-sigalg algorithm
.RS 3
.LP
Specifies the name of the signature algorithm to use to sign the JAR file.
.LP
Specifies the name of the signature algorithm to use to sign the JAR file.
.br
.br
See
.na
\f2Appendix A\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/security/crypto/CryptoSpec.html#AppA of the Java Cryptography Architecture for a list of standard signature algorithm names. This algorithm must be compatible with the private key used to sign the JAR file. If this option is not specified, SHA1withDSA or SHA256withRSA will be used depending on the type of private key. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f2\-providerClass\fP option, otherwise the command will not succeed.
.LP
.RE
http://download.oracle.com/javase/7/docs/technotes/guides/security/crypto/CryptoSpec.html#AppA of the Java Cryptography Architecture for a list of standard signature algorithm names. This algorithm must be compatible with the private key used to sign the JAR file. If this option is not specified, SHA1withDSA, SHA256withRSA, or SHA256withECDSA will be used depending on the type of private key. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f2\-providerClass\fP option, otherwise the command will not succeed.
.TP 3
\-digestalg algorithm
.RS 3
Specifies the name of the message digest algorithm to use when digesting the entries of a jar file.
.LP
Specifies the name of the message digest algorithm to use when digesting the entries of a jar file.
.br
.br
See
.na
\f2Appendix A\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/security/crypto/CryptoSpec.html#AppA of the Java Cryptography Architecture for a list of standard message digest algorithm names. If this option is not specified, SHA\-256 will be used. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f2\-providerClass\fP option, otherwise the command will not succeed.
.LP
.RE
http://download.oracle.com/javase/7/docs/technotes/guides/security/crypto/CryptoSpec.html#AppA of the Java Cryptography Architecture for a list of standard message digest algorithm names. If this option is not specified, SHA256 will be used. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f2\-providerClass\fP option, otherwise the command will not succeed.
.TP 3
\-signedjar file
Specifies the name to be used for the signed JAR file.
.LP
If no name is specified on the command line, the name used is the same as the input JAR file name (the name of the JAR file to be signed); in other words, that file is overwritten with the signed JAR file.
Specifies the name to be used for the signed JAR file.
.br
.br
If no name is specified on the command line, the name used is the same as the input JAR file name (the name of the JAR file to be signed); in other words, that file is overwritten with the signed JAR file.
.TP 3
\-verify
If this appears on the command line, the specified JAR file will be verified, not signed. If the verification is successful, "jar verified" will be displayed. If you try to verify an unsigned JAR file, or a JAR file signed with an unsupported algorithm (e.g., RSA when you don't have an RSA provider installed), the following is displayed: "jar is unsigned. (signatures missing or not parsable)"
.LP
It is possible to verify JAR files signed using either \f3jarsigner\fP or the JDK 1.1 \f3javakey\fP tool, or both.
.LP
For further information on verification, see JAR File Verification.
If this appears on the command line, the specified JAR file will be verified, not signed. If the verification is successful, "jar verified" will be displayed. If you try to verify an unsigned JAR file, or a JAR file signed with an unsupported algorithm (e.g., RSA when you don't have an RSA provider installed), the following is displayed: "jar is unsigned. (signatures missing or not parsable)"
.br
.br
It is possible to verify JAR files signed using either \f3jarsigner\fP or the JDK 1.1 \f3javakey\fP tool, or both.
.br
.br
For further information on verification, see JAR File Verification.
.TP 3
\-certs
If this appears on the command line, along with the \f2\-verify\fP and \f2\-verbose\fP options, the output includes certificate information for each signer of the JAR file. This information includes
@ -578,7 +550,6 @@ the name of the type of certificate (stored in the .DSA file) that certifies the
o
if the certificate is an X.509 certificate (more specifically, an instance of \f2java.security.cert.X509Certificate\fP): the distinguished name of the signer
.RE
.LP
The keystore is also examined. If no keystore value is specified on the command line, the default keystore file (if any) will be checked. If the public key certificate for a signer matches an entry in the keystore, then the following information will also be displayed:
.RS 3
.TP 2
@ -596,26 +567,25 @@ If this appears on the command line, it indicates "verbose" mode, which causes \
In the past, the .DSA (signature block) file generated when a JAR file was signed used to include a complete encoded copy of the .SF file (signature file) also generated. This behavior has been changed. To reduce the overall size of the output JAR file, the .DSA file by default doesn't contain a copy of the .SF file anymore. But if \f2\-internalsf\fP appears on the command line, the old behavior is utilized. \f3This option is mainly useful for testing; in practice, it should not be used, since doing so eliminates a useful optimization.\fP
.TP 3
\-sectionsonly
If this appears on the command line, the .SF file (signature file) generated when a JAR file is signed does \f2not\fP include a header containing a hash of the whole manifest file. It just contains information and hashes related to each individual source file included in the JAR file, as described in The Signature (.SF) File .
.LP
By default, this header is added, as an optimization. When the header is present, then whenever the JAR file is verified, the verification can first check to see whether or not the hash in the header indeed matches the hash of the whole manifest file. If so, verification proceeds to the next step. If not, it is necessary to do a less optimized verification that the hash in each source file information section in the .SF file equals the hash of its corresponding section in the manifest file.
.LP
For further information, see JAR File Verification.
.LP
\f3This option is mainly useful for testing; in practice, it should not be used, since doing so eliminates a useful optimization.\fP
If this appears on the command line, the .SF file (signature file) generated when a JAR file is signed does \f2not\fP include a header containing a hash of the whole manifest file. It just contains information and hashes related to each individual source file included in the JAR file, as described in The Signature (.SF) File .
.br
.br
By default, this header is added, as an optimization. When the header is present, then whenever the JAR file is verified, the verification can first check to see whether or not the hash in the header indeed matches the hash of the whole manifest file. If so, verification proceeds to the next step. If not, it is necessary to do a less optimized verification that the hash in each source file information section in the .SF file equals the hash of its corresponding section in the manifest file.
.br
.br
For further information, see JAR File Verification.
.br
.br
\f3This option is mainly useful for testing; in practice, it should not be used, since doing so eliminates a useful optimization.\fP
.TP 3
\-protected
Either \f2true\fP or \f2false\fP. This value should be specified as \f2true\fP if a password must be given via a protected authentication path such as a dedicated PIN reader.
.RE
.RS 3
.TP 3
\-provider provider\-class\-name
Used to specify the name of cryptographic service provider's master class file when the service provider is not listed in the security properties file, \f2java.security\fP.
.LP
\-providerClass provider\-class\-name
Used to specify the name of cryptographic service provider's master class file when the service provider is not listed in the security properties file, \f2java.security\fP.
.br
.br
Used in conjunction with the \f2\-providerArg\fP \f2ConfigFilePath\fP option, keytool and jarsigner will install the provider dynamically (where \f2ConfigFilePath\fP is the path to the token configuration file). Here's an example of a command to list a PKCS#11 keystore when the Sun PKCS#11 provider has not been configured in the security properties file.
.RS 3
.LP
.nf
\f3
.fl
@ -629,19 +599,16 @@ jarsigner \-keystore NONE \-storetype PKCS11 \\
.fl
\fP
.fi
.RE
.TP 3
\-providerName providerName
If more than one provider has been configured in the \f2java.security\fP security properties file, you can use the \f2\-providerName\fP option to target a specific provider instance. The argument to this option is the name of the provider.
.LP
If more than one provider has been configured in the \f2java.security\fP security properties file, you can use the \f2\-providerName\fP option to target a specific provider instance. The argument to this option is the name of the provider.
.br
.br
For the Sun PKCS#11 provider, \f2providerName\fP is of the form \f2SunPKCS11\-\fP\f2TokenName\fP, where \f2TokenName\fP is the name suffix that the provider instance has been configured with, as detailed in the
.na
\f2configuration attributes table\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/security/p11guide.html#ATTRS. For example, the following command lists the contents of the PKCS#11 keystore provider instance with name suffix \f2SmartCard\fP:
.RS 3
.LP
http://download.oracle.com/javase/7/docs/technotes/guides/security/p11guide.html#ATTRS. For example, the following command lists the contents of the PKCS#11 keystore provider instance with name suffix \f2SmartCard\fP:
.nf
\f3
.fl
@ -653,58 +620,59 @@ jarsigner \-keystore NONE \-storetype PKCS11 \\
.fl
\fP
.fi
.RE
.TP 3
\-Jjavaoption
Passes through the specified \f2javaoption\fP string directly to the Java interpreter. (\f3jarsigner\fP is actually a "wrapper" around the interpreter.) This option should not contain any spaces. It is useful for adjusting the execution environment or memory usage. For a list of possible interpreter options, type \f2java \-h\fP or \f2java \-X\fP at the command line.
.LP
Passes through the specified \f2javaoption\fP string directly to the Java interpreter. (\f3jarsigner\fP is actually a "wrapper" around the interpreter.) This option should not contain any spaces. It is useful for adjusting the execution environment or memory usage. For a list of possible interpreter options, type \f2java \-h\fP or \f2java \-X\fP at the command line.
.TP 3
\-tsa url
If \f2"\-tsa http://example.tsa.url"\fP appears on the command line when signing a JAR file then a timestamp is generated for the signature. The URL, \f2http://example.tsa.url\fP, identifies the location of the Time Stamping Authority (TSA). It overrides any URL found via the \f2\-tsacert\fP option. The \f2\-tsa\fP option does not require the TSA's public key certificate to be present in the keystore.
.LP
If \f2"\-tsa http://example.tsa.url"\fP appears on the command line when signing a JAR file then a timestamp is generated for the signature. The URL, \f2http://example.tsa.url\fP, identifies the location of the Time Stamping Authority (TSA). It overrides any URL found via the \f2\-tsacert\fP option. The \f2\-tsa\fP option does not require the TSA's public key certificate to be present in the keystore.
.br
.br
To generate the timestamp, \f2jarsigner\fP communicates with the TSA using the Time\-Stamp Protocol (TSP) defined in
.na
\f2RFC 3161\fP @
.fi
http://www.ietf.org/rfc/rfc3161.txt. If successful, the timestamp token returned by the TSA is stored along with the signature in the signature block file.
.LP
http://www.ietf.org/rfc/rfc3161.txt. If successful, the timestamp token returned by the TSA is stored along with the signature in the signature block file.
.TP 3
\-tsacert alias
If \f2"\-tsacert alias"\fP appears on the command line when signing a JAR file then a timestamp is generated for the signature. The \f2alias\fP identifies the TSA's public key certificate in the keystore that is currently in effect. The entry's certificate is examined for a Subject Information Access extension that contains a URL identifying the location of the TSA.
.LP
The TSA's public key certificate must be present in the keystore when using \f2\-tsacert\fP.
.LP
If \f2"\-tsacert alias"\fP appears on the command line when signing a JAR file then a timestamp is generated for the signature. The \f2alias\fP identifies the TSA's public key certificate in the keystore that is currently in effect. The entry's certificate is examined for a Subject Information Access extension that contains a URL identifying the location of the TSA.
.br
.br
The TSA's public key certificate must be present in the keystore when using \f2\-tsacert\fP.
.TP 3
\-altsigner class
Specifies that an alternative signing mechanism be used. The fully\-qualified class name identifies a class file that extends the \f2com.sun.jarsigner.ContentSigner abstract class\fP. The path to this class file is defined by the \f2\-altsignerpath\fP option. If the \f2\-altsigner\fP option is used, \f2jarsigner\fP uses the signing mechanism provided by the specified class. Otherwise, \f2jarsigner\fP uses its default signing mechanism.
.LP
For example, to use the signing mechanism provided by a class named \f2com.sun.sun.jarsigner.AuthSigner\fP, use the \f2jarsigner\fP option \f2"\-altsigner com.sun.jarsigner.AuthSigner"\fP
.LP
Specifies that an alternative signing mechanism be used. The fully\-qualified class name identifies a class file that extends the \f2com.sun.jarsigner.ContentSigner abstract class\fP. The path to this class file is defined by the \f2\-altsignerpath\fP option. If the \f2\-altsigner\fP option is used, \f2jarsigner\fP uses the signing mechanism provided by the specified class. Otherwise, \f2jarsigner\fP uses its default signing mechanism.
.br
.br
For example, to use the signing mechanism provided by a class named \f2com.sun.sun.jarsigner.AuthSigner\fP, use the \f2jarsigner\fP option \f2"\-altsigner com.sun.jarsigner.AuthSigner"\fP
.TP 3
\-altsignerpath classpathlist
Specifies the path to the class file (the class file name is specified with the \f2\-altsigner\fP option described above) and any JAR files it depends on. If the class file is in a JAR file, then this specifies the path to that JAR file, as shown in the example below.
.LP
An absolute path or a path relative to the current directory may be specified. If \f2classpathlist\fP contains multiple paths or JAR files, they should be separated with a colon (\f2:\fP) on Solaris and a semi\-colon (\f2;\fP) on Windows. This option is not necessary if the class is already in the search path.
.LP
Specifies the path to the class file (the class file name is specified with the \f2\-altsigner\fP option described above) and any JAR files it depends on. If the class file is in a JAR file, then this specifies the path to that JAR file, as shown in the example below.
.br
.br
An absolute path or a path relative to the current directory may be specified. If \f2classpathlist\fP contains multiple paths or JAR files, they should be separated with a colon (\f2:\fP) on Solaris and a semi\-colon (\f2;\fP) on Windows. This option is not necessary if the class is already in the search path.
.br
.br
Example of specifying the path to a jar file that contains the class file:
.RS 3
.LP
.LP
\f2\-altsignerpath /home/user/lib/authsigner.jar\fP
.LP
.RE
.LP
Note that the JAR file name is included.
.LP
.nf
\f3
.fl
\-altsignerpath /home/user/lib/authsigner.jar
.fl
\fP
.fi
Note that the JAR file name is included.
.br
.br
Example of specifying the path to the jar file that contains the class file:
.RS 3
.LP
\f2\-altsignerpath /home/user/classes/com/sun/tools/jarsigner/\fP
.LP
.RE
.LP
Note that the JAR file name is omitted.
.nf
\f3
.fl
\-altsignerpath /home/user/classes/com/sun/tools/jarsigner/
.fl
\fP
.fi
Note that the JAR file name is omitted.
.TP 3
\-strict
During the signing or verifying process, some warning messages may be shown. If this option appears on the command line, the exit code of the tool will reflect the warning messages that are found. Read the "WARNINGS" section for details.
@ -712,25 +680,22 @@ During the signing or verifying process, some warning messages may be shown. If
\-verbose:sub\-options
For the verifying process, the \f2\-verbose\fP option takes sub\-options to determine how much information will be shown. If \f2\-certs\fP is also specified, the default mode (or sub\-option all) displays each entry as it is being processed and following that, the certificate information for each signer of the JAR file. If \f2\-certs\fP and the \f2\-verbose:grouped\fP sub\-option are specified, entries with the same signer info are grouped and displayed together along with their certificate information. If \f2\-certs\fP and the \f2\-verbose:summary\fP sub\-option are specified, then entries with the same signer info are grouped and displayed together along with their certificate information but details about each entry are summarized and displayed as "one entry (and more)". See the examples section for more information.
.RE
.SH "EXAMPLES"
.LP
.LP
.SH "EXAMPLES"
.LP
.SS
Signing a JAR File
.LP
.RS 3
.LP
.LP
Suppose you have a JAR file named "bundle.jar" and you'd like to sign it using the private key of the user whose keystore alias is "jane" in the keystore named "mystore" in the "working" directory. Suppose the keystore password is "myspass" and the password for \f2jane\fP's private key is "j638klm". You can use the following to sign the JAR file and name the signed JAR file "sbundle.jar":
Suppose you have a JAR file named "bundle.jar" and you'd like to sign it using the private key of the user whose keystore alias is "jane" in the keystore named "mystore" in the "working" directory. You can use the following to sign the JAR file and name the signed JAR file "sbundle.jar":
.LP
.nf
\f3
.fl
jarsigner \-keystore /working/mystore \-storepass myspass
jarsigner \-keystore /working/mystore \-storepass \fP\f4<keystore password>\fP\f3
.fl
\-keypass j638klm \-signedjar sbundle.jar bundle.jar jane
\-keypass \fP\f4<private key password>\fP\f3 \-signedjar sbundle.jar bundle.jar jane
.fl
\fP
.fi
@ -747,7 +712,7 @@ If you want to be prompted for the store password and the private key password,
.fl
jarsigner \-keystore /working/mystore
.fl
\-signedjar sbundle.jar bundle.jar jane
\-signedjar sbundle.jar bundle.jar jane
.fl
\fP
.fi
@ -759,7 +724,7 @@ If the keystore to be used is the default keystore (the one named ".keystore" in
.nf
\f3
.fl
jarsigner \-signedjar sbundle.jar bundle.jar jane
jarsigner \-signedjar sbundle.jar bundle.jar jane
.fl
\fP
.fi
@ -771,18 +736,14 @@ Finally, if you want the signed JAR file to simply overwrite the input JAR file
.nf
\f3
.fl
jarsigner bundle.jar jane
jarsigner bundle.jar jane
.fl
\fP
.fi
.RE
.LP
.SS
Verifying a Signed JAR File
.LP
.RS 3
.LP
.LP
To verify a signed JAR file, that is, to verify that the signature is valid and the JAR file has not been tampered with, use a command such as the following:
@ -790,7 +751,7 @@ To verify a signed JAR file, that is, to verify that the signature is valid and
.nf
\f3
.fl
jarsigner \-verify sbundle.jar
jarsigner \-verify sbundle.jar
.fl
\fP
.fi
@ -851,7 +812,7 @@ You can get more information if you use the \f2\-verbose\fP option. A sample use
Verification with Certificate Information
.LP
.LP
If you specify the \f2\-certs\fP option when verifying, along with the \f2\-verify\fP and \f2\-verbose\fP options, the output includes certificate information for each signer of the JAR file, including the certificate type, the signer distinguished name information (iff it's an X.509 certificate), and, in parentheses, the keystore alias for the signer if the public key certificate in the JAR file matches that in a keystore entry. For example,
If you specify the \f2\-certs\fP option when verifying, along with the \f2\-verify\fP and \f2\-verbose\fP options, the output includes certificate information for each signer of the JAR file, including the certificate type, the signer distinguished name information (if and only if it's an X.509 certificate), and, in parentheses, the keystore alias for the signer if the public key certificate in the JAR file matches that in a keystore entry. For example,
.LP
.nf
\f3
@ -961,10 +922,7 @@ When the \f2\-certs\fP option is used, any identity database aliases are shown i
.LP
Note that the alias "duke" is in brackets to denote that it is an identity database alias, not a keystore alias.
.LP
.RE
.SH "WARNINGS"
.LP
.LP
During the signing/verifying process, jarsigner may display various warnings. These warning codes are defined as follows:
.nf
@ -980,25 +938,25 @@ During the signing/verifying process, jarsigner may display various warnings. Th
.fl
This jar contains entries whose signer certificate has expired.
.fl
.fl
notYetValidCert 4
.fl
This jar contains entries whose signer certificate is not yet valid.
.fl
.fl
chainNotValidated 4
.fl
This jar contains entries whose certificate chain cannot be correctly validated.
.fl
.fl
badKeyUsage 8
.fl
This jar contains entries whose signer certificate's KeyUsage extension doesn't allow code signing.
.fl
.fl
badExtendedKeyUsage 8
.fl
@ -1006,33 +964,33 @@ During the signing/verifying process, jarsigner may display various warnings. Th
.fl
doesn't allow code signing.
.fl
.fl
badNetscapeCertType 8
.fl
This jar contains entries whose signer certificate's NetscapeCertType extension
This jar contains entries whose signer certificate's NetscapeCertType extension
.fl
doesn't allow code signing.
.fl
.fl
hasUnsignedEntry 16
.fl
This jar contains unsigned entries which have not been integrity\-checked.
.fl
.fl
notSignedByAlias 32
.fl
This jar contains signed entries which are not signed by the specified alias(es)
.fl
.fl
aliasNotInStore 32
.fl
This jar contains signed entries that are not signed by alias in this keystore
.fl
.fl
\fP
.fi
@ -1042,23 +1000,19 @@ During the signing/verifying process, jarsigner may display various warnings. Th
When the \f2\-strict\fP option is provided, an OR\-value of warnings detected will be returned as the exit code of the tool. For example, if a certificate used to sign an entry is expired and has a keyUsage extension that does not allow it to sign a file, an exit code 12 (=4+8) will be returned.
.LP
.LP
\f3Note\fP: Exit codes are reused because only 0\-255 is legal for Unix. In any case, if the signing/verifying process fails, the exit code
\f3Note\fP: Exit codes are reused because only 0\-255 is legal for Unix. In any case, if the signing/verifying process fails, the following exit code will be returned:
.LP
.nf
\f3
.fl
failure 1
failure 1
.fl
\fP
.fi
.LP
will be returned.
.SS
Compatibility with JDK 1.1
.LP
.RS 3
.LP
.LP
The \f3keytool\fP and \f3jarsigner\fP tools completely replace the \f3javakey\fP tool provided in JDK 1.1. These new tools provide more features than \f3javakey\fP, including the ability to protect the keystore and private keys with passwords, and the ability to verify signatures in addition to generating them.
@ -1390,7 +1344,7 @@ Default privileges granted to all code plus privileges granted in policy file. (
.nr 44 \n(83+(3*\n(38)
.nr 84 +\n(44
.nr TW \n(84
.if t .if \n(TW>\n(.li .tm Table at line 1128 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 1082 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -1590,8 +1544,6 @@ Only trusted identities can be imported into Java 2 SDK keystores.
.LP
.SH "SEE ALSO"
.LP
.LP
.RS 3
.TP 2
@ -1606,13 +1558,12 @@ the
.na
\f4Security\fP @
.fi
http://java.sun.com/docs/books/tutorial/security/index.html trail of the
http://download.oracle.com/javase/tutorial/security/index.html trail of the
.na
\f4Java Tutorial\fP @
.fi
http://java.sun.com/docs/books/tutorial/index.html for examples of the use of the \f3jarsigner\fP tool
http://download.oracle.com/javase/tutorial/index.html for examples of the use of the \f3jarsigner\fP tool
.RE
.LP
.RE

240
jdk/src/solaris/doc/sun/man/man1/java.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1994, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1994, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,7 +19,7 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH java 1 "02 Jun 2010"
.TH java 1 "10 May 2011"
.LP
.SH "Name"
@ -36,9 +36,6 @@ java \- the Java application launcher
.fl
.fi
.LP
.RS 3
.LP
.RS 3
.TP 3
@ -56,10 +53,7 @@ Argument passed to the \f3main\fP function.
.RE
.LP
.RE
.SH "DESCRIPTION"
.LP
.LP
.LP
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.
@ -70,7 +64,7 @@ The method must be declared public and static, it must not return any value, and
.nf
\f3
.fl
public static void main(String args[])
public static void main(String args[])
.fl
\fP
.fi
@ -86,77 +80,80 @@ The Java runtime searches for the startup class, and other classes used, in thre
Non\-option arguments after the class name or JAR file name are passed to the \f3main\fP function.
.LP
.SH "OPTIONS"
.LP
.LP
.LP
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.
.LP
.SH "Standard Options"
.LP
.LP
.RS 3
.TP 3
\-client
.LP
Select the Java HotSpot Client VM. A 64\-bit capable jdk currently ignores this option and instead uses the Java Hotspot Server VM.
.LP
Select the Java HotSpot Client VM. A 64\-bit capable jdk currently ignores this option and instead uses the Java Hotspot Server VM.
.br
.br
For default VM selection, see
.na
\f2Server\-Class Machine Detection\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/vm/server\-class.html
http://download.oracle.com/javase/7/docs/technotes/guides/vm/server\-class.html
.TP 3
\-server
.LP
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.
.LP
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.
.br
.br
For default VM selection, see
.na
\f2Server\-Class Machine Detection\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/vm/server\-class.html
http://download.oracle.com/javase/7/docs/technotes/guides/vm/server\-class.html
.TP 3
\-agentlib:libname[=options]
Load native agent library \f2libname\fP, e.g.
.LP
\-agentlib:hprof
.LP
\-agentlib:jdwp=help
.LP
\-agentlib:hprof=help
.LP
Load native agent library \f2libname\fP, e.g.
.br
.br
\-agentlib:hprof
.br
.br
\-agentlib:jdwp=help
.br
.br
\-agentlib:hprof=help
.br
.br
For more information, see
.na
\f2JVMTI Agent Command Line Options\fP @
.fi
http://java.sun.com/javase/6/docs/platform/jvmti/jvmti.html#starting.
http://download.oracle.com/javase/7/docs/platform/jvmti/jvmti.html#starting.
.TP 3
\-agentpath:pathname[=options]
Load a native agent library by full pathname. For more information, see
.na
\f2JVMTI Agent Command Line Options\fP @
.fi
http://java.sun.com/javase/6/docs/platform/jvmti/jvmti.html#starting.
http://download.oracle.com/javase/7/docs/platform/jvmti/jvmti.html#starting.
.TP 3
\-classpath classpath
.TP 3
\-cp classpath
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.
.LP
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.
.br
.br
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).
.LP
.br
.br
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).
.br
.br
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.
.LP
.br
.br
For more information on class paths, see
.na
\f2Setting the Class Path\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/tools/index.html#classpath.
http://download.oracle.com/javase/7/docs/technotes/tools/index.html#classpath.
.TP 3
\-Dproperty=value
Set a system property value.
@ -164,19 +161,23 @@ Set a system property value.
\-d32
.TP 3
\-d64
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.
.LP
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.
.LP
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.
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.
.br
.br
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.
.br
.br
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.
.TP 3
\-enableassertions[:<package name>"..." | :<class name> ]
.TP 3
\-ea[:<package name>"..." | :<class name> ]
Enable assertions. Assertions are disabled by default.
.LP
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.
.LP
Enable assertions. Assertions are disabled by default.
.br
.br
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.
.br
.br
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:
.nf
\f3
@ -185,26 +186,26 @@ java \-ea:com.wombat.fruitbat... <Main Class>
.fl
\fP
.fi
.LP
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.
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.
.TP 3
\-disableassertions[:<package name>"..." | :<class name> ]
.TP 3
\-da[:<package name>"..." | :<class name> ]
Disable assertions. This is the default.
.LP
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.
.LP
Disable assertions. This is the default.
.br
.br
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.
.br
.br
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:
.nf
\f3
.fl
java \-ea:com.wombat.fruitbat... \-da:com.wombat.fruitbat.Brickbat <Main Class>
java \-ea:com.wombat.fruitbat... \-da:com.wombat.fruitbat.Brickbat \fP\f4<Main Class>\fP\f3
.fl
\fP
.fi
.LP
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.
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.
.TP 3
\-enablesystemassertions
.TP 3
@ -215,29 +216,36 @@ Enable asserts in all system classes (sets the \f2default assertion status\fP fo
.TP 3
\-dsa
Disables asserts in all system classes.
.LP
.TP 3
\-jar
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
.na
\f2Java Tutorial\fP @
.fi
http://java.sun.com/docs/books/tutorial/jar for information about working with Jar files and Jar\-file manifests.
.LP
When you use this option, the JAR file is the source of all user classes, and other user class path settings are ignored.
.LP
http://download.oracle.com/javase/tutorial/deployment/jar for information about working with Jar files and Jar\-file manifests.
.br
.br
When you use this option, the JAR file is the source of all user classes, and other user class path settings are ignored.
.br
.br
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
.na
\f2Java Archive (JAR) Files\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/jar/index.html.
http://download.oracle.com/javase/7/docs/technotes/guides/jar/index.html.
.TP 3
\-javaagent:jarpath[=options]
Load a Java programming language agent, see
.na
\f2java.lang.instrument\fP @
.fi
http://java.sun.com/javase/6/docs/api/java/lang/instrument/package\-summary.html.
http://download.oracle.com/javase/7/docs/api/java/lang/instrument/package\-summary.html.
.TP 3
\-jre\-restrict\-search
Include user\-private JREs in the version search.
.TP 3
\-no\-jre\-restrict\-search
Exclude user\-private JREs in the version search.
.TP 3
\-verbose
.TP 3
@ -254,8 +262,9 @@ Report information about use of native methods and other Java Native Interface a
Display version information and exit.
.TP 3
\-version:release
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.
.LP
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.
.br
.br
\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:
.nf
\f3
@ -264,11 +273,13 @@ Specifies that the version specified by \f2release\fP is required by the class o
.fl
\fP
.fi
The meaning of the above is that the class or jar file requires either version 1.6.0_13, or a version with 1.6 as a version\-id prefix and that is not less than 1.6.0_10.. The exact syntax and definition of version strings may be found in Appendix A of the Java Network Launching Protocol & API Specification (JSR\-56).
.LP
For jar files, the usual preference is to specify version requirements in the jar file manifest rather than on the command line.
.LP
See the following NOTES section for important policy information on the use of this option.
The meaning of the above is that the class or jar file requires either version 1.6.0_13, or a version with 1.6 as a version\-id prefix and that is not less than 1.6.0_10.. The exact syntax and definition of version strings may be found in Appendix A of the Java Network Launching Protocol & API Specification (JSR\-56).
.br
.br
For jar files, the usual preference is to specify version requirements in the jar file manifest rather than on the command line.
.br
.br
See the following NOTES section for important policy information on the use of this option.
.TP 3
\-showversion
Display version information and continue.
@ -278,6 +289,9 @@ Display version information and continue.
\-help
Display usage information and exit.
.TP 3
\-splash:imagepath
Show splash screen with image specified by \f2imagepath\fP.
.TP 3
\-X
Display information about non\-standard options and exit.
.RE
@ -285,9 +299,6 @@ Display information about non\-standard options and exit.
.LP
.SS
Non\-Standard Options
.LP
.RS 3
.LP
.RS 3
.TP 3
@ -319,18 +330,20 @@ Disable class garbage collection. Use of this option will prevent memory recover
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.
.TP 3
\-Xloggc:file
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.
.LP
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.
.LP
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.
.br
.br
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.
.TP 3
\-Xmsn
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
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
.na
\f2HotSpot Ergonomics\fP @
.fi
http://download.oracle.com/javase/7/docs/technotes/guides/vm/gc\-ergonomics.html
.br
.br
Examples:
.RS 3
.LP
.nf
\f3
.fl
@ -340,19 +353,20 @@ Examples:
.fl
\-Xms6m
.fl
.fl
\fP
.fi
.RE
.TP 3
\-Xmxn
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
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
.na
\f2HotSpot Ergonomics\fP @
.fi
http://download.oracle.com/javase/7/docs/technotes/guides/vm/gc\-ergonomics.html
.br
.br
Examples:
.RS 3
.LP
.nf
\f3
.fl
@ -362,28 +376,31 @@ Examples:
.fl
\-Xmx80m
.fl
.fl
\fP
.fi
.RE
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.
.TP 3
\-Xprof
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.
.LP
.TP 3
\-Xrs
Reduces use of operating\-system signals by the Java virtual machine (JVM).
.LP
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.
.LP
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.
.LP
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.
.LP
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.
.LP
Reduces use of operating\-system signals by the Java virtual machine (JVM).
.br
.br
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.
.br
.br
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.
.br
.br
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.
.br
.br
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.
.br
.br
There are two consequences of specifying \f3\-Xrs\fP:
.RS 3
.TP 2
@ -402,12 +419,11 @@ The VM uses \f2SIGUSR1\fP and \f2SIGUSR2\fP by default, which can sometimes conf
.RE
.LP
.RE
.SH "NOTES"
.LP
.LP
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:
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:
.LP
.RS 3
.TP 3
1.
@ -422,8 +438,7 @@ Any version greater than an arbitrarily precise version\-id. For example:
.fl
\fP
.fi
.LP
Would utilize any version greater than 1.6.0_10. This is useful for a case where an interface was introduced (or a bug fixed) in the release specified.
This would utilize any version greater than \f21.6.0_10\fP. This is useful for a case where an interface was introduced (or a bug fixed) in the release specified.
.TP 3
3.
A version greater than an arbitrarily precise version\-id, bounded by the upper bound of that release family. For example:
@ -448,9 +463,22 @@ Similar to item 2. this is useful when a change was introduced in a release (1.7
.RE
.LP
.SH "SEE ALSO"
.SH "EXIT STATUS"
.LP
.LP
The following exit values are generally returned by the launcher, typically when the launcher is called with the wrong arguments, serious errors, or exceptions thrown from the Java Virtual Machine. However, a Java application may choose to return any value using the API call \f2System.exit(exitValue)\fP.
.LP
.RS 3
.TP 2
o
\f20\fP: Successful completion
.TP 2
o
\f2>0\fP: An error occurred
.RE
.LP
.SH "SEE ALSO"
.LP
.RS 3
.TP 2
@ -470,13 +498,13 @@ o
.na
\f2The Java Extensions Framework\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/extensions/index.html
http://download.oracle.com/javase/7/docs/technotes/guides/extensions/index.html
.TP 2
o
.na
\f2Security Features\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/security/index.html.
http://download.oracle.com/javase/7/docs/technotes/guides/security/index.html.
.TP 2
o
.na

719
jdk/src/solaris/doc/sun/man/man1/javac.1
View File

File diff suppressed because it is too large Load Diff

2281
jdk/src/solaris/doc/sun/man/man1/javadoc.1
View File

File diff suppressed because it is too large Load Diff

26
jdk/src/solaris/doc/sun/man/man1/javah.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1994, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1994, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,37 +19,27 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH javah 1 "02 Jun 2010"
.TH javah 1 "10 May 2011"
.LP
.SH "Name"
javah \- C Header and Stub File Generator
.LP
.RS 3
.LP
.LP
\f3javah\fP produces C header files and C source files from a Java class. These files provide the connective glue that allow your Java and C code to interact.
.LP
.RE
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
.fl
javah [ \fP\f3options\fP\f3 ] fully\-qualified\-classname. . .
.fl
javah_g [ \fP\f3options\fP\f3 ] fully\-qualified\-classname. . .
.fl
\fP
.fi
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
\f3javah\fP generates C header and source files that are needed to implement native methods. The generated header and source files are used by C programs to reference an object's instance variables from native source code. The .h file contains a struct definition whose layout parallels the layout of the corresponding class. The fields in the struct correspond to instance variables in the class.
@ -63,12 +53,7 @@ By default \f3javah\fP creates a header file for each class listed on the comman
.LP
The new native method interface, Java Native Interface (JNI), does not require header information or stub files. \f3javah\fP can still be used to generate native method function proptotypes needed for JNI\-style native methods. \f3javah\fP produces JNI\-style output by default, and places the result in the .h file.
.LP
.LP
\f3javah_g\fP is a non\-optimized version of \f3javah\fP suitable for use with debuggers like jdb(1).
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
@ -110,11 +95,10 @@ For example:
.fl
\fP
.fi
.LP
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).
.br
.br
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.
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.
.TP 3
\-bootclasspath path
Specifies path from which to load bootstrap classes. By default, the bootstrap classes are the classes implementing the core Java 2 platform located in \f2jre/lib/rt.jar\fP and several other jar files.
@ -131,8 +115,6 @@ Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the
.LP
.SH "ENVIRONMENT VARIABLES"
.LP
.LP
.RS 3
.TP 3
@ -149,8 +131,6 @@ Used to provide the system a path to user\-defined classes. Directories are sepa
.LP
.SH "SEE ALSO"
.LP
.LP
.LP
javac(1), java(1), jdb(1), javap(1), javadoc(1)

301
jdk/src/solaris/doc/sun/man/man1/javap.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1994, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1994, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,27 +19,21 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH javap 1 "02 Jun 2010"
.TH javap 1 "10 May 2011"
.LP
.SH "Name"
javap \- The Java Class File Disassembler
.LP
.RS 3
.LP
.LP
Disassembles class files.
.LP
.RE
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
.fl
javap [ \fP\f3options\fP\f3 ] class. . .
javap [ \fP\f3options\fP\f3 ] classes
.fl
\fP
.fi
@ -47,13 +41,21 @@ javap [ \fP\f3options\fP\f3 ] class. . .
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f3javap\fP command disassembles a class file. Its output depends on the options used. If no options are used, \f3javap\fP prints out the package, protected, and public fields and methods of the classes passed to it. \f3javap\fP prints its output to stdout. For example, compile the following class declaration:
The \f3javap\fP command disassembles one or more class files. Its output depends on the options used. If no options are used, \f3javap\fP prints out the package, protected, and public fields and methods of the classes passed to it. \f3javap\fP prints its output to stdout.
.LP
.RS 3
.TP 3
options
Command\-line options.
.TP 3
classes
List of one or more classes (separated by spaces) to be processed for annotations (such as \f2DocFooter.class\fP). You may specify a class that can be found in the class path, by its file name (for example, \f2/home/user/myproject/src/DocFooter.class\fP), or with a URL (for example, \f2file:///home/user/myproject/src/DocFooter.class\fP).
.RE
.LP
.LP
For example, compile the following class declaration:
.LP
.nf
\f3
@ -96,166 +98,160 @@ public class DocFooter extends Applet {
.fl
\fP
.fi
.RE
.LP
.LP
The output from \f3javap DocFooter\fP yields:
.LP
.RS 3
The output from \f3javap DocFooter.class\fP yields:
.LP
.nf
\f3
.fl
Compiled from DocFooter.java
Compiled from "DocFooter.java"
.fl
public class DocFooter extends java.applet.Applet {
.fl
java.lang.String date;
java.lang.String date;
.fl
java.lang.String email;
java.lang.String email;
.fl
public DocFooter();
public DocFooter();
.fl
public void init();
public void init();
.fl
public void paint(java.awt.Graphics);
public void paint(java.awt.Graphics);
.fl
}
.fl
\fP
.fi
.RE
.LP
.LP
The output from \f3javap \-c DocFooter\fP yields:
.LP
.RS 3
The output from \f3javap \-c DocFooter.class\fP yields:
.LP
.nf
\f3
.fl
Compiled from DocFooter.java
Compiled from "DocFooter.java"
.fl
public class DocFooter extends java.applet.Applet {
.fl
java.lang.String date;
java.lang.String date;
.fl
java.lang.String email;
.fl
public DocFooter();
java.lang.String email;
.fl
public void init();
.fl
public void paint(java.awt.Graphics);
public DocFooter();
.fl
Code:
.fl
0: aload_0
.fl
1: invokespecial #1 // Method java/applet/Applet."<init>":()V
.fl
4: return
.fl
.fl
public void init();
.fl
Code:
.fl
0: aload_0
.fl
1: sipush 500
.fl
4: bipush 100
.fl
6: invokevirtual #2 // Method resize:(II)V
.fl
9: aload_0
.fl
10: aload_0
.fl
11: ldc #3 // String LAST_UPDATED
.fl
13: invokevirtual #4 // Method getParameter:(Ljava/lang/String;)Ljava/lang/String;
.fl
16: putfield #5 // Field date:Ljava/lang/String;
.fl
19: aload_0
.fl
20: aload_0
.fl
21: ldc #6 // String EMAIL
.fl
23: invokevirtual #4 // Method getParameter:(Ljava/lang/String;)Ljava/lang/String;
.fl
26: putfield #7 // Field email:Ljava/lang/String;
.fl
29: return
.fl
.fl
public void paint(java.awt.Graphics);
.fl
Code:
.fl
0: aload_1
.fl
1: new #8 // class java/lang/StringBuilder
.fl
4: dup
.fl
5: invokespecial #9 // Method java/lang/StringBuilder."<init>":()V
.fl
8: aload_0
.fl
9: getfield #5 // Field date:Ljava/lang/String;
.fl
12: invokevirtual #10 // Method java/lang/StringBuilder.append:(Ljava/lang/String;)Ljava/lang/StringBuilder;
.fl
15: ldc #11 // String by
.fl
17: invokevirtual #10 // Method java/lang/StringBuilder.append:(Ljava/lang/String;)Ljava/lang/StringBuilder;
.fl
20: invokevirtual #12 // Method java/lang/StringBuilder.toString:()Ljava/lang/String;
.fl
23: bipush 100
.fl
25: bipush 15
.fl
27: invokevirtual #13 // Method java/awt/Graphics.drawString:(Ljava/lang/String;II)V
.fl
30: aload_1
.fl
31: aload_0
.fl
32: getfield #7 // Field email:Ljava/lang/String;
.fl
35: sipush 290
.fl
38: bipush 15
.fl
40: invokevirtual #13 // Method java/awt/Graphics.drawString:(Ljava/lang/String;II)V
.fl
43: return
.fl
}
.fl
.fl
Method DocFooter()
.fl
0 aload_0
.fl
1 invokespecial #1 <Method java.applet.Applet()>
.fl
4 return
.fl
.fl
Method void init()
.fl
0 aload_0
.fl
1 sipush 500
.fl
4 bipush 100
.fl
6 invokevirtual #2 <Method void resize(int, int)>
.fl
9 aload_0
.fl
10 aload_0
.fl
11 ldc #3 <String "LAST_UPDATED">
.fl
13 invokevirtual #4 <Method java.lang.String getParameter(java.lang.String)>
.fl
16 putfield #5 <Field java.lang.String date>
.fl
19 aload_0
.fl
20 aload_0
.fl
21 ldc #6 <String "EMAIL">
.fl
23 invokevirtual #4 <Method java.lang.String getParameter(java.lang.String)>
.fl
26 putfield #7 <Field java.lang.String email>
.fl
29 return
.fl
.fl
Method void paint(java.awt.Graphics)
.fl
0 aload_1
.fl
1 new #8 <Class java.lang.StringBuffer>
.fl
4 dup
.fl
5 invokespecial #9 <Method java.lang.StringBuffer()>
.fl
8 aload_0
.fl
9 getfield #5 <Field java.lang.String date>
.fl
12 invokevirtual #10 <Method java.lang.StringBuffer append(java.lang.String)>
.fl
15 ldc #11 <String " by ">
.fl
17 invokevirtual #10 <Method java.lang.StringBuffer append(java.lang.String)>
.fl
20 invokevirtual #12 <Method java.lang.String toString()>
.fl
23 bipush 100
.fl
25 bipush 15
.fl
27 invokevirtual #13 <Method void drawString(java.lang.String, int, int)>
.fl
30 aload_1
.fl
31 aload_0
.fl
32 getfield #7 <Field java.lang.String email>
.fl
35 sipush 290
.fl
38 bipush 15
.fl
40 invokevirtual #13 <Method void drawString(java.lang.String, int, int)>
.fl
43 return
.fl
\fP
.fi
.RE
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
\-help
\-help \-\-help \-?
Prints out help message for \f3javap\fP.
.TP 3
\-version
Prints out version information.
.TP 3
\-l
Prints out line and local variable tables.
.TP 3
@ -268,14 +264,11 @@ Shows only protected and public classes and members.
\-package
Shows only package, protected, and public classes and members. This is the default.
.TP 3
\-private
\-private \-p
Shows all classes and members.
.TP 3
\-Jflag
Pass \f2flag\fP directly to the runtime system. Some examples:
.RS 3
.LP
.nf
\f3
.fl
@ -285,11 +278,16 @@ javap \-J\-Djava.security.manager \-J\-Djava.security.policy=MyPolicy MyClassNam
.fl
\fP
.fi
.RE
.TP 3
\-s
Prints internal type signatures.
.TP 3
\-sysinfo
Shows system information (path, size, date, MD5 hash) of the class being processed.
.TP 3
\-constants
Shows static final constants.
.TP 3
\-c
Prints out disassembled code, i.e., the instructions that comprise the Java bytecodes, for each of the methods in the class. These are documented in the
.na
@ -301,22 +299,7 @@ http://java.sun.com/docs/books/vmspec/.
Prints stack size, number of \f2locals\fP and \f2args\fP for methods.
.TP 3
\-classpath path
Specifies the path \f3javap\fP uses to look up classes. Overrides the default or the CLASSPATH environment variable if it is set. Directories are separated by colons. Thus the general format for \f2path\fP is:
.nf
\f3
.fl
.:<your_path>
.fl
\fP
.fi
For example:
.nf
\f3
.fl
.:/home/avh/classes:/usr/local/java/classes
.fl
\fP
.fi
Specifies the path \f3javap\fP uses to look up classes. Overrides the default or the CLASSPATH environment variable if it is set.
.TP 3
\-bootclasspath path
Specifies path from which to load bootstrap classes. By default, the bootstrap classes are the classes implementing the core Java platform located in \f2jre/lib/rt.jar\fP and several other jar files.
@ -325,32 +308,8 @@ Specifies path from which to load bootstrap classes. By default, the bootstrap c
Overrides location at which installed extensions are searched for. The default location for extensions is the value of \f2java.ext.dirs\fP.
.RE
.LP
.SH "ENVIRONMENT VARIABLES"
.LP
.LP
.RS 3
.TP 3
CLASSPATH
Used to provide the system a path to user\-defined classes. Directories are separated by colons, for example, For example:
.RS 3
.LP
.nf
\f3
.fl
.:/home/avh/classes:/usr/local/java/classes
.fl
\fP
.fi
.RE
.RE
.LP
.SH "SEE ALSO"
.LP
.LP
.LP
javac(1), java(1), jdb(1), javah(1), javadoc(1)

208
jdk/src/solaris/doc/sun/man/man1/javaws.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,30 +19,18 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH javaws 1 "02 Jun 2010"
.TH javaws 1 "10 May 2011"
.LP
.SH "Name"
\f2javaws\fP Command Line
.LP
.LP
\
.LP
.SS
NAME
.LP
.RS 3
.SH "NAME"
.LP
.LP
\f2javaws\fP \- Java Web Start launcher command
.LP
.RE
.SS
SYNOPSIS
.LP
.RS 3
.SH "SYNOPSIS"
.LP
.LP
\f2javaws [run\-options] <jnlp>\fP
@ -50,49 +38,27 @@ SYNOPSIS
.LP
\f2javaws [control\-options]\fP
.LP
.RE
.SS
PARAMETERS
.LP
.RS 3
.SH "PARAMETERS"
.LP
.LP
\f2[run\-options]\fP
.LP
.RS 3
.LP
.LP
Command\-line run\-options. run\-options may be in any order. For a discussion of the various run\-options, see RUN\-OPTIONS below.
.LP
.RE
.LP
\f2<jnlp>\fP
.LP
.RS 3
.LP
.LP
This can be either the path of, or the Uniform Resource Locater (URL) of the JNLP (Java Network Launching Protocol) file.
.LP
.RE
.LP
\f2[control\-options]\fP
.LP
.RS 3
.LP
.LP
Command\-line control\-options. control\-options may be in any order. For a discussion of the various control\-options, see CONTROL\-OPTIONS below.
.LP
.RE
.RE
.SS
DESCRIPTION
.LP
.RS 3
.SH "DESCRIPTION"
.LP
.LP
The \f2javaws\fP command launches Java Web Start, which is the reference implementation of the Java Network Launching Protocol (JNLP). Java Web Start launches Java applications/applets hosted on a network.
@ -103,256 +69,154 @@ If a JNLP file is specified, \f2javaws\fP will launch the Java application/apple
.LP
The \f2javaws\fP launcher has a set of options that are supported in the current release. However, the options may be removed in a future release.
.LP
.RE
.SS
RUN\-OPTIONS
.LP
.RS 3
.SH "RUN\-OPTIONS"
.LP
.LP
\f2\-offline\fP
.LP
.RS 3
.LP
Run Java Web Start in offline mode.
.LP
run Java Web Start in offline mode.
.LP
.RE
.LP
\f2\-Xnosplash\fP
.LP
.RS 3
.LP
Do not display the initial splash screen.
.LP
disable the display of the initial splash screen.
.LP
.RE
.LP
\f2\-open <arguments>\fP
.LP
.RS 3
.LP
.LP
If specified, replaces the arguments in the jnlp file with \f2\-open <arguments>\fP.
.LP
.RE
.LP
\f2\-print <arguments>\fP
.LP
.RS 3
.LP
.LP
If specified, replaces the arguments in the jnlp file with \f2\-print <arguments>\fP.
.LP
.RE
.LP
\f2\-online\fP
.LP
.RS 3
.LP
Use online mode (default behavior).
.LP
run in online mode (default behavior).
.LP
.RE
.LP
\f2\-wait\fP
.LP
.RS 3
.LP
If specified, the \f2javaws\fP process will not exit until the application exits. This option does not function as described on Windows platforms.
.LP
If specified, the \f2javaws\fP process will not exit until the application exits.
.LP
.RE
.LP
\f2\-verbose\fP
.LP
.RS 3
.LP
Display additional output.
.LP
display additional output.
.LP
.RE
.LP
\f2\-J<option>\fP
.LP
.RS 3
.LP
Supply options to the VM.
.LP
supply options to the vm.
.LP
.RE
.LP
\f2\-system\fP
.LP
.RS 3
.LP
Run the application from the system cache only.
.LP
run the application from the system cache only.
.LP
.RE
.RE
.SS
CONTROL\-OPTIONS
.LP
.RS 3
.SH "CONTROL\-OPTIONS"
.LP
.LP
\f2\-viewer\fP
.LP
.RS 3
.LP
Show the Cache Viewer in the Java Control Panel.
.LP
.LP
show the Cache Viewer in the java control panel
\f2\-clearcache\fP
.LP
.LP
Remove all non\-installed applications from the cache.
.LP
.RE
.LP
\f2\-userConfig <property name>\fP
.LP
.RS 3
.LP
Clear the specified deployment property.
.LP
clear the specified deployment property.
.LP
.RE
.LP
\f2\-userConfig <property name> <property value>\fP
.LP
.RS 3
.LP
Set the specified deployment property to the specified value.
.LP
set the specified deployment property to the specified value.
.LP
.RE
.LP
\f2\-uninstall\fP
.LP
.RS 3
.LP
Remove all applications from the cache.
.LP
remove all applications from the cache.
.LP
.RE
.LP
\f2\-uninstall <jnlp>\fP
.LP
.RS 3
.LP
Remove the application from the cache.
.LP
remove the application from the cache.
.LP
.RE
.LP
\f2\-import [import\-options] <jnlp>\fP
.LP
.RS 3
.LP
Import the application to the cache.
.LP
import the application to the cache.
.LP
.RE
\f3IMPORT\-OPTIONS\fP
.SH "IMPORT\-OPTIONS"
.LP
.LP
\f2\-silent\fP
.LP
.RS 3
.LP
Import silently (with no user interface).
.LP
import silently (with no user interface).
.LP
.RE
.LP
\f2\-system\fP
.LP
.RS 3
.LP
Import application to the system cache.
.LP
import application to the system cache.
.LP
.RE
.LP
\f2\-codebase <url>\fP
.LP
.RS 3
.LP
Retrieve resources from the given codebase.
.LP
retrieve resources from the given codebase.
.LP
.RE
.LP
\f2\-shortcut\fP
.LP
.RS 3
.LP
Install shortcuts as if user allowed prompt. This option has no effect unless \f2\-silent\fP option is also used.
.LP
install shortcuts as if user allowed prompt. This option has no effect unless \f2\-silent\fP option is also used.
.LP
.RE
.LP
\f2\-association\fP
.LP
.RS 3
.LP
Install associations as if user allowed prompt. This option has no effect unless \f2\-silent\fP option is also used.
.LP
install associations as if user allowed prompt. This option has no effect unless \f2\-silent\fP option is also used.
.LP
.RE
.RE
.SS
FILES
.LP
.RS 3
.SH "FILES"
.LP
.LP
For information about the user and system cache and deployment.properties files, see
.na
\f2System\- and User\-Level Properties\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/deployment/deployment\-guide/properties.html.
http://download.oracle.com/javase/7/docs/technotes/guides/deployment/deployment\-guide/properties.html.
.LP
.RE
.SS
MORE INFORMATION
.LP
.RS 3
.SH "MORE INFORMATION"
.LP
.LP
For more information about Java Web Start, see
.na
\f2Java Web Start\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/javaws/index.html.
http://download.oracle.com/javase/7/docs/technotes/guides/javaws/index.html.
.LP
.RS 3
.LP
.LP
\
.LP
.RE
.RE

50
jdk/src/solaris/doc/sun/man/man1/jconsole.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,15 +19,13 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jconsole 1 "02 Jun 2010"
.TH jconsole 1 "10 May 2011"
.LP
.SH "Name"
jconsole \- Java Monitoring and Management Console
.LP
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -40,41 +38,40 @@ jconsole \- Java Monitoring and Management Console
.LP
.SH "PARAMETERS"
.LP
.LP
.RS 3
.TP 3
options
Options, if used, should follow immediately after the command name.
.br
.TP 3
connection = pid | host:port | jmxUrl
.RS 3
\f2pid\fP\ \ \ Process ID of a local Java VM. The Java VM must be running with the same user ID as the user ID running jconsole. See
.TP 2
o
\f2pid\fP Process ID of a local Java VM. The Java VM must be running with the same user ID as the user ID running jconsole. See
.na
\f2JMX Monitoring and Management\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/management/agent.html for details.
.br
\f2host\fP:\f2port\fP\ \ Name of the host system on which the Java VM is running and the port number specified by the system property \f2com.sun.management.jmxremote.port\fP when the Java VM was started. See
http://download.oracle.com/javase/7/docs/technotes/guides/management/agent.html for details.
.TP 2
o
\f2host\fP:\f2port\fP Name of the host system on which the Java VM is running and the port number specified by the system property \f2com.sun.management.jmxremote.port\fP when the Java VM was started. See
.na
\f2JMX Monitoring and Management\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/management/agent.html for details.
.br
\f2jmxUrl\fP\ \ Address of the JMX agent to be connected to as described in
http://download.oracle.com/javase/7/docs/technotes/guides/management/agent.html for details.
.TP 2
o
\f2jmxUrl\fP Address of the JMX agent to be connected to as described in
.na
\f2JMXServiceURL\fP @
.fi
http://java.sun.com/javase/6/docs/api/javax/management/remote/JMXServiceURL.html.
http://download.oracle.com/javase/7/docs/api/javax/management/remote/JMXServiceURL.html.
.RE
.RE
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f3jconsole\fP command launches a graphical console tool that enables you to monitor and manage Java applications and virtual machines on a local or remote machine.
@ -83,18 +80,16 @@ The \f3jconsole\fP command launches a graphical console tool that enables you to
On Windows, \f3jconsole\fP does not associate with a console window. It will, however, display a dialog box with error information if the \f3jconsole\fP command fails for some reason.
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
\-interval=n
Set the update interval to \f2n\fP seconds (default is 4 seconds).
.TP 3
\-notile\
\-notile
Do not tile windows initially (for two or more connections).
.TP 3
\-pluginpath\ plugins
\-pluginpath plugins
Specify a list of directories or JAR files which are searched for JConsole plugins. The \f2plugins\fP path should contain a provider\-configuration file named:
.br
.nf
@ -104,20 +99,19 @@ Specify a list of directories or JAR files which are searched for JConsole plugi
.fl
\fP
.fi
.LP
containing one line for each plugin specifying the fully qualified class name of the class implementing the
.na
\f2com.sun.tools.jconsole.JConsolePlugin\fP @
.fi
http://java.sun.com/javase/6/docs/jdk/api/jconsole/spec/com/sun/tools/jconsole/JConsolePlugin.html class.
http://download.oracle.com/javase/7/docs/jdk/api/jconsole/spec/com/sun/tools/jconsole/JConsolePlugin.html class.
.TP 3
\-version\
\-version
Output version information and exit.
.TP 3
\-help\
\-help
Output help message and exit.
.TP 3
\-J<flag>\
\-J<flag>
Pass <flag> to the Java virtual machine on which jconsole is run.
.RE
@ -130,13 +124,13 @@ o
.na
\f2Using JConsole\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/management/jconsole.html
http://download.oracle.com/javase/7/docs/technotes/guides/management/jconsole.html
.TP 2
o
.na
\f2Monitoring and Management for Java Platform\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/management/index.html
http://download.oracle.com/javase/7/docs/technotes/guides/management/index.html
.RE
.LP

74
jdk/src/solaris/doc/sun/man/man1/jdb.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1995, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1995, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,22 +19,16 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jdb 1 "02 Jun 2010"
.TH jdb 1 "10 May 2011"
.LP
.SH "Name"
jdb \- The Java Debugger
.LP
.RS 3
.LP
.LP
\f3jdb\fP helps you find and fix bugs in Java language programs.
.LP
.RE
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -43,9 +37,6 @@ jdb \- The Java Debugger
.fl
.fi
.LP
.RS 3
.LP
.RS 3
.TP 3
@ -60,23 +51,17 @@ Arguments passed to the \f2main()\fP method of \f2class\fP.
.RE
.LP
.RE
.SH "DESCRIPTION"
.LP
.LP
.LP
The Java Debugger, \f3jdb\fP, is a simple command\-line debugger for Java classes. It is a demonstration of the
.na
\f2Java Platform Debugger Architecture\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/jpda/index.html that provides inspection and debugging of a local or remote Java Virtual Machine.
http://download.oracle.com/javase/7/docs/technotes/guides/jpda/index.html that provides inspection and debugging of a local or remote Java Virtual Machine.
.LP
.SS
Starting a jdb Session
.LP
.RS 3
.LP
.LP
There are many ways to start a jdb session. The most frequently used way is to have \f3jdb\fP launch a new Java Virtual Machine (VM) with the main class of the application to be debugged. This is done by substituting the command \f3jdb\fP for \f3java\fP in the command line. For example, if your application's main class is MyClass, you use the following command to debug it under JDB:
@ -137,7 +122,7 @@ There are many other ways to connect the debugger to a VM, and all of them are s
.na
\f2documentation\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/jpda/conninv.html on these connection options. For information on starting a J2SE 1.4.2 or early VM for use with \f3jdb\fP see the
http://download.oracle.com/javase/7/docs/technotes/guides/jpda/conninv.html on these connection options. For information on starting a J2SE 1.4.2 or early VM for use with \f3jdb\fP see the
.na
\f21.4.2 documentation\fP @
.fi
@ -148,9 +133,6 @@ Basic jdb Commands
.LP
.LP
The following is a list of the basic \f3jdb\fP commands. The Java debugger supports other commands which you can list using \f3jdb\fP's \f2help\fP command.
.LP
.RS 3
.LP
.RS 3
.TP 3
@ -164,10 +146,12 @@ cont
Continues execution of the debugged application after a breakpoint, exception, or step.
.TP 3
print
Displays Java objects and primitive values. For variables or fields of primitive types, the actual value is printed. For objects, a short description is printed. See the \f2dump\fP command below for getting more information about an object.
.LP
\f2NOTE: To display local variables, the containing class must have been compiled with the \fP\f2javac(1)\fP\f2 \fP\f2\-g\fP option.
.LP
Displays Java objects and primitive values. For variables or fields of primitive types, the actual value is printed. For objects, a short description is printed. See the \f2dump\fP command below for getting more information about an object.
.br
.br
\f2NOTE: To display local variables, the containing class must have been compiled with the \fP\f2javac(1)\fP\f2 \fP\f2\-g\fP option.
.br
.br
\f2print\fP supports many simple Java expressions including those with method invocations, for example:
.RS 3
.TP 2
@ -188,15 +172,13 @@ o
.RE
.TP 3
dump
For primitive values, this command is identical to \f2print\fP. For objects, it prints the current value of each field defined in the object. Static and instance fields are included.
.LP
The \f2dump\fP command supports the same set of expressions as the \f2print\fP command.
For primitive values, this command is identical to \f2print\fP. For objects, it prints the current value of each field defined in the object. Static and instance fields are included.
.br
.br
The \f2dump\fP command supports the same set of expressions as the \f2print\fP command.
.TP 3
threads
List the threads that are currently running. For each thread, its name and current status are printed, as well as an index that can be used for other commands, for example:
.RS 3
.LP
.nf
\f3
.fl
@ -204,25 +186,21 @@ List the threads that are currently running. For each thread, its name and curre
.fl
\fP
.fi
.RE
In this example, the thread index is 4, the thread is an instance of java.lang.Thread, the thread name is "main", and it is currently running,
.TP 3
thread
Select a thread to be the current thread. Many \f3jdb\fP commands are based on the setting of the current thread. The thread is specified with the thread index described in the \f2threads\fP command above.
.TP 3
where
\f2where\fP with no arguments dumps the stack of the current thread. \f2where all\fP dumps the stack of all threads in the current thread group. \f2where\fP \f2threadindex\fP dumps the stack of the specified thread.
.LP
If the current thread is suspended (either through an event such as a breakpoint or through the \f2suspend\fP command), local variables and fields can be displayed with the \f2print\fP and \f2dump\fP commands. The \f2up\fP and \f2down\fP commands select which stack frame is current.
\f2where\fP with no arguments dumps the stack of the current thread. \f2where all\fP dumps the stack of all threads in the current thread group. \f2where\fP \f2threadindex\fP dumps the stack of the specified thread.
.br
.br
If the current thread is suspended (either through an event such as a breakpoint or through the \f2suspend\fP command), local variables and fields can be displayed with the \f2print\fP and \f2dump\fP commands. The \f2up\fP and \f2down\fP commands select which stack frame is current.
.RE
.LP
.RE
.SS
Breakpoints
.LP
.RS 3
.LP
.LP
Breakpoints can be set in \f3jdb\fP at line numbers or at the first instruction of a method, for example:
@ -249,22 +227,14 @@ If a method is overloaded, you must also specify its argument types so that the
.LP
The \f2clear\fP command removes breakpoints using a syntax as in "\f2clear\ MyClass:45\fP". Using the \f2clear\fP or command with no argument displays a list of all breakpoints currently set. The \f2cont\fP command continues execution.
.LP
.RE
.SS
Stepping
.LP
.RS 3
.LP
.LP
The \f2step\fP commands advances execution to the next line whether it is in the current stack frame or a called method. The \f2next\fP command advances execution to the next line in the current stack frame.
.LP
.RE
.SS
Exceptions
.LP
.RS 3
.LP
.LP
When an exception occurs for which there isn't a catch statement anywhere in the throwing thread's call stack, the VM normally prints an exception trace and exits. When running under \f3jdb\fP, however, control returns to \f3jdb\fP at the offending throw. You can then use \f3jdb\fP to diagnose the cause of the exception.
@ -278,11 +248,7 @@ The \f2ignore\fP command negates the effect of a previous \f2catch\fP command.
.LP
\f2NOTE: The \fP\f2ignore\fP command does not cause the debugged VM to ignore specific exceptions, only the debugger.
.LP
.RE
.RE
.SH "Command Line Options"
.LP
.LP
.LP
When you use \f3jdb\fP in place of the Java application launcher on the command line, \f3jdb\fP accepts many of the same options as the java command, including \f2\-D\fP, \f2\-classpath\fP, and \f2\-X<option>\fP.
@ -335,7 +301,7 @@ Other options are supported for alternate mechanisms for connecting the debugger
.na
\f2documentation\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/jpda/conninv.html on these connection alternatives.
http://download.oracle.com/javase/7/docs/technotes/guides/jpda/conninv.html on these connection alternatives.
.LP
.SS
Options Forwarded to Debuggee Process
@ -357,8 +323,6 @@ Non\-standard target VM option
.LP
.SH "SEE ALSO"
.LP
.LP
.LP
javac(1), java(1), javah(1), javap(1), javadoc(1).

33
jdk/src/solaris/doc/sun/man/man1/jhat.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2006, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2006, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,15 +19,13 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jhat 1 "02 Jun 2010"
.TH jhat 1 "10 May 2011"
.LP
.SH "Name"
jhat \- Java Heap Analysis Tool
.LP
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -40,18 +38,18 @@ jhat \- Java Heap Analysis Tool
.LP
.SH "PARAMETERS"
.LP
.LP
.RS 3
.TP 3
options
Options, if used, should follow immediately after the command name.
.br
.TP 3
heap\-dump\-file
Java binary heap dump file to be browsed. For a dump file that contains multiple heap dumps, you may specify which dump in the file by appending "#<number> to the file name, i.e. "foo.hprof#3".
.SH "DESCRIPTION"
.RE
.LP
.SH "DESCRIPTION"
.LP
.LP
The \f3jhat\fP command parses a java heap dump file and launches a webserver. jhat enables you to browse heap dumps using your favorite webbrowser. jhat supports pre\-designed queries (such as 'show all instances of a known class "Foo"') as well as \f3OQL\fP (\f3O\fPbject \f3Q\fPuery \f3L\fPanguage) \- a SQL\-like query language to query heap dumps. Help on OQL is available from the OQL help page shown by jhat. With the default port, OQL help is available at http://localhost:7000/oqlhelp/
@ -69,7 +67,7 @@ Use jconsole(1) option to obtain a heap dump via
.na
\f2HotSpotDiagnosticMXBean\fP @
.fi
http://java.sun.com/javase/6/docs/jre/api/management/extension/com/sun/management/HotSpotDiagnosticMXBean.html at runtime;
http://download.oracle.com/javase/7/docs/jre/api/management/extension/com/sun/management/HotSpotDiagnosticMXBean.html at runtime;
.TP 2
o
Heap dump will be generated when OutOfMemoryError is thrown by specifying \-XX:+HeapDumpOnOutOfMemoryError VM option;
@ -86,7 +84,8 @@ http://java.sun.com/developer/technicalArticles/Programming/HPROF.html.
.LP
\f3NOTE:\fP This tool is \f3experimental\fP and may \f3not\fP be available in future versions of the JDK.
.LP
.SH "OPTIONS"
.SH "OPTIONS"
.LP
.RS 3
.TP 3
\-stack false/true
@ -107,21 +106,22 @@ Specify a baseline heap dump. Objects in both heap dumps with the same object ID
\-debug int
Set debug level for this tool. 0 means no debug output. Set higher values for more verbose modes.
.TP 3
\-version\
\-version
Report version number and exit.
.TP 3
\-h\
\-h
Output help message and exit.
.TP 3
\-help\
\-help
Output help message and exit.
.TP 3
\-J<flag>\
\-J<flag>
Pass <flag> to the Java virtual machine on which jhat is run. For example, \-J\-Xmx512m to use a maximum heap size of 512MB.
.RE
.LP
.SH "SEE ALSO"
.SH "SEE ALSO"
.LP
.RS 3
.TP 2
o
@ -136,5 +136,6 @@ o
.fi
http://java.sun.com/developer/technicalArticles/Programming/HPROF.html
.RE
.RE
.LP

31
jdk/src/solaris/doc/sun/man/man1/jinfo.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,15 +19,13 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jinfo 1 "02 Jun 2010"
.TH jinfo 1 "10 May 2011"
.LP
.SH "Name"
jinfo \- Configuration Info
.LP
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -42,55 +40,56 @@ jinfo \- Configuration Info
.LP
.SH "PARAMETERS"
.LP
.LP
.RS 3
.TP 3
option
Options are mutually exclusive. Option, if used, should follow immediately after the command name.
.RE
.LP
.RS 3
.TP 3
pid
process id for which the configuration info is to be printed. The process must be a Java process. To get a list of Java processes running on a machine, jps(1) may be used.
.RE
.LP
.RS 3
.TP 3
executable
Java executable from which the core dump was produced.
.RE
.LP
.RS 3
.TP 3
core
core file for which the configuration info is to be printed.
.RE
.LP
.RS 3
.TP 3
remote\-hostname\-or\-IP
remote debug server's (see jsadebugd(1)) hostname or IP address.
.RE
.LP
.RS 3
.TP 3
server\-id
optional unique id, if multiple debug servers are running on the same remote host.
.RE
.RE
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
\f3jinfo\fP prints Java configuration information for a given Java process or core file or a remote debug server. Configuration information includes Java System properties and Java virtual machine command line flags. If the given process is running on a 64\-bit VM, you may need to specify the \f2\-J\-d64\fP option, e.g.:
.br
.LP
.RS 3
.LP
jinfo \-J\-d64 \-sysprops pid
.RE
.LP
.LP
\f3NOTE \- This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' need to be installed to have these tools working. Also, \fP\f4PATH\fP\f3 environment variable should contain the location of \fP\f4jvm.dll\fP\f3 used by the target process or the location from which the Crash Dump file was produced.\fP
.LP
@ -98,8 +97,6 @@ jinfo \-J\-d64 \-sysprops pid
\f3For example, \fP\f4set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3

22
jdk/src/solaris/doc/sun/man/man1/jmap.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,15 +19,13 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jmap 1 "02 Jun 2010"
.TH jmap 1 "10 May 2011"
.LP
.SH "Name"
jmap \- Memory Map
.LP
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -42,8 +40,6 @@ jmap \- Memory Map
.LP
.SH "PARAMETERS"
.LP
.LP
.RS 3
.TP 3
@ -73,14 +69,9 @@ optional unique id, if multiple debug servers are running on the same remote hos
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
\f3jmap\fP prints shared object memory maps or heap memory details of a given process or core file or a remote debug server. If the given process is running on a 64\-bit VM, you may need to specify the \f2\-J\-d64\fP option, e.g.:
.LP
.RS 3
.LP
.nf
\f3
@ -89,10 +80,11 @@ jmap \-J\-d64 \-heap pid
.fl
\fP
.fi
.RE
.LP
\f3NOTE \- This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' needs to be installed to have these tools working. Also, \fP\f4PATH\fP\f3 environment variable should contain the location of \fP\f4jvm.dll\fP\f3 used by the target process or the location from which the Crash Dump file was produced.\fP
.LP
\f3NOTE: This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' needs to be installed to have these tools working. Also, \fP\f4PATH\fP\f3 environment variable should contain the location of \fP\f4jvm.dll\fP\f3 used by the target process or the location from which the Crash Dump file was produced.\fP
.LP
.LP
\f3For example, \fP\f4set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP
.LP
@ -100,13 +92,11 @@ jmap \-J\-d64 \-heap pid
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
<no option>
When no option is used \f3jmap\fP prints shared object mappings. For each shared object loaded in the target VM, start address, the size of the mapping, and the full path of the shared object file are printed. This is similar to the Solaris \f3pmap\fP utility.
When no option is used jmap prints shared object mappings. For each shared object loaded in the target VM, start address, the size of the mapping, and the full path of the shared object file are printed. This is similar to the Solaris \f3pmap\fP utility.
.br
.TP 3
\-dump:[live,]format=b,file=<filename>

20
jdk/src/solaris/doc/sun/man/man1/jps.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,15 +19,13 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jps 1 "02 Jun 2010"
.TH jps 1 "10 May 2011"
.LP
.SH "Name"
jps \- Java Virtual Machine Process Status Tool
.LP
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -40,8 +38,6 @@ jps \- Java Virtual Machine Process Status Tool
.LP
.SH "PARAMETERS"
.LP
.LP
.RS 3
.TP 3
@ -54,8 +50,6 @@ The host identifier of the host for which the process report should be generated
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f3jps\fP tool lists the instrumented HotSpot Java Virtual Machines (JVMs) on the target system. The tool is limited to reporting information on JVMs for which it has the access permissions.
@ -76,8 +70,6 @@ The list of JVMs produced by the \f3jps\fP command may be limited by the permiss
\f3NOTE:\fP This utility is unsupported and may not be available in future versions of the JDK. It is not currently available on Windows 98 and Windows ME platforms.
.LP
.SH "OPTIONS"
.LP
.LP
.LP
The \f3jps\fP command supports a number of options that modify the output of the command. These options are subject to change or removal in the future.
@ -106,9 +98,6 @@ Pass \f2option\fP to the \f3java\fP launcher called by \f3jps\fP. For example, \
.LP
.SS
HOST IDENTIFIER
.LP
.RS 3
.LP
.LP
The host identifier, or \f2hostid\fP is a string that indicates the target system. The syntax of the \f2hostid\fP string largely corresponds to the syntax of a URI:
@ -140,10 +129,7 @@ The treatment of this parameter depends on the implementation. For the optimized
.RE
.LP
.RE
.SH "OUTPUT FORMAT"
.LP
.LP
.LP
The output of the \f3jps\fP command follows the following pattern:
@ -168,8 +154,6 @@ Where all output tokens are separated by white space. An \f2arg\fP that includes
.LP
.SH "EXAMPLES"
.LP
.LP
.LP
This section provides examples of the \f3jps\fP command.

64
jdk/src/solaris/doc/sun/man/man1/jrunscript.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2006, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2006, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,15 +19,13 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jrunscript 1 "02 Jun 2010"
.TH jrunscript 1 "10 May 2011"
.LP
.SH "Name"
jrunscript \- command line script shell
.LP
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -38,8 +36,6 @@ jrunscript \- command line script shell
.LP
.SH "PARAMETERS"
.LP
.LP
.RS 3
.TP 3
@ -52,8 +48,6 @@ Arguments, if used, should follow immediately after options or command name.
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
\f3jrunscript\fP is a command line script shell. jrunscript supports both an interactive (read\-eval\-print) mode and a batch (\-f option) mode of script execution. This is a scripting language independent shell. By default, JavaScript is the language used, but the \-l option can be used to specify a different language. Through Java to scripting language communication, jrunscript supports "exploratory programming" style.
@ -62,8 +56,6 @@ Arguments, if used, should follow immediately after options or command name.
\f3NOTE:\fP This tool is \f3experimental\fP and may \f3not\fP be available in future versions of the JDK.
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
@ -112,10 +104,8 @@ If [arguments...] are present and if no \f3\-e\fP or \f3\-f\fP option is used, t
.LP
.SH "EXAMPLES"
.LP
\f3Executing inline scripts\fP
.LP
.RS 3
.SS
Executing inline scripts
.LP
.nf
\f3
@ -126,13 +116,10 @@ jrunscript \-e "cat('http://java.sun.com')"
.fl
\fP
.fi
.RE
.LP
\f3Use specified language and evaluate given script file\fP
.LP
.RS 3
.SS
Use specified language and evaluate given script file
.LP
.nf
\f3
@ -141,42 +128,42 @@ jrunscript \-l js \-f test.js
.fl
\fP
.fi
.RE
.LP
\f3Interactive mode\fP
.LP
.RS 3
.SS
Interactive mode
.LP
.nf
\f3
.fl
jrunscript
.fl
js>print('hello world');
js> print('Hello World\\n');
.fl
hello world
Hello World
.fl
js>34 + 55
js> 34 + 55
.fl
89
89.0
.fl
js> thread(function() { print('hello world'); }
js> t = new java.lang.Thread(function() { print('Hello World\\n'); })
.fl
hello world
Thread[Thread\-0,5,main]
.fl
js> t.start()
.fl
js> Hello World
.fl
.fl
js>
.fl
\fP
.fi
.RE
.LP
\f3Run script file with script arguments\fP
.LP
.RS 3
.SS
Run script file with script arguments
.LP
.nf
\f3
@ -185,13 +172,16 @@ jrunscript test.js arg1 arg2 arg3
.fl
\fP
.fi
.RE
.LP
test.js is script file to execute and arg1, arg2 and arg3 are passed to script as script arguments. Script can access these using "arguments" array.
.SH "SEE ALSO"
.LP
.LP
If JavaScript is used, then before evaluating any user defined script, jrunscript initializes certain built\-in functions and objects. These JavaScript built\-ins are documented in jsdocs.
If JavaScript is used, then before evaluating any user defined script, jrunscript initializes certain built\-in functions and objects. These JavaScript built\-ins are documented in
.na
\f2jsdocs\fP @
.fi
http://download.oracle.com/javase/7/docs/technotes/tools/share/jsdocs/allclasses\-noframe.html.
.LP

39
jdk/src/solaris/doc/sun/man/man1/jsadebugd.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,15 +19,13 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jsadebugd 1 "02 Jun 2010"
.TH jsadebugd 1 "10 May 2011"
.LP
.SH "Name"
jsadebugd \- Serviceability Agent Debug Daemon
.LP
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -40,36 +38,17 @@ jsadebugd \- Serviceability Agent Debug Daemon
.LP
.SH "PARAMETERS"
.LP
.LP
.RS 3
.TP 3
pid
process id of the process to which the debug server should attach. The process must be a Java process. To get a list of Java processes running on a machine, jps(1) may be used. At most one instance of the debug server may be attached to a single process.
.RE
.LP
.RS 3
.TP 3
executable
.RE
.LP
.RS 3
.TP 3
Java executable from which the core dump was produced
.RE
.LP
.RS 3
.TP 3
core
Core file to which the debug server should attach.
.RE
.LP
.RS 3
.TP 3
server\-id
Optional unique id, needed if multiple debug servers are started on the same machine. This ID must be used by remote clients to identify the particular debug server to attach. Within a single machine, this ID must be unique.
@ -77,18 +56,13 @@ Optional unique id, needed if multiple debug servers are started on the same mac
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
\f3jsadebugd\fP attaches to a Java process or core file and acts as a debug server. Remote clients such as jstack(1), jmap(1), and jinfo(1) can attach to the server using Java Remote Method Invocation (RMI). Before starting \f2jsadebugd\fP,
.na
\f2rmiregistry\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/tools/index.html#rmi must be started with:
.LP
.RS 3
http://download.oracle.com/javase/7/docs/technotes/tools/index.html#rmi must be started with:
.LP
.nf
\f3
@ -97,17 +71,16 @@ http://java.sun.com/javase/6/docs/technotes/tools/index.html#rmi must be started
.fl
\fP
.fi
.RE
.LP
.LP
where \f2$JAVA_HOME\fP is the JDK installation directory. If rmiregistry was not started, jsadebugd will start an rmiregistry in a standard (1099) port internally. Debug server may be stopped by sending SIGINT (pressing Ctrl\-C) to it.
.LP
.LP
\f3NOTE \- This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' needs to be installed to have these tools working. Also, \fP\f4PATH\fP\f3 environment variable should contain the location of \fP\f4jvm.dll\fP\f3 used by the target process or the location from which the Crash Dump file was produced.\fP
\f3NOTE\fP \- This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' needs to be installed to have these tools working. Also, \f2PATH\fP environment variable should contain the location of \f2jvm.dll\fP used by the target process or the location from which the Crash Dump file was produced.
.LP
.LP
\f3For example, \fP\f4set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP
For example, \f2set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP
.LP
.SH "SEE ALSO"
.LP
@ -129,7 +102,7 @@ o
.na
\f2rmiregistry\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/tools/index.html#rmi
http://download.oracle.com/javase/7/docs/technotes/tools/index.html#rmi
.RE
.LP

20
jdk/src/solaris/doc/sun/man/man1/jstack.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,7 +19,7 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jstack 1 "02 Jun 2010"
.TH jstack 1 "10 May 2011"
.LP
.SH "Name"
@ -28,8 +28,6 @@ jstack \- Stack Trace
.LP
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -44,8 +42,6 @@ jstack \- Stack Trace
.LP
.SH "PARAMETERS"
.LP
.LP
.LP
Options are mutually exclusive. Option, if used, should follow immediately after the command name. See OPTIONS.
@ -77,16 +73,11 @@ optional unique id, if multiple debug servers are running on the same remote hos
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
\f3jstack\fP prints Java stack traces of Java threads for a given Java process or core file or a remote debug server. For each Java frame, the full class name, method name, 'bci' (byte code index) and line number, if available, are printed. With the \-m option, jstack prints both Java and native frames of all threads along with the 'pc' (program counter). For each native frame, the closest native symbol to 'pc', if available, is printed. C++ mangled names are not demangled. To demangle C++ names, the output of this command may be piped to \f3c++filt\fP. If the given process is running on a 64\-bit VM, you may need to specify the \f2\-J\-d64\fP option, e.g.:
.br
.LP
.RS 3
.LP
.nf
\f3
@ -95,7 +86,6 @@ jstack \-J\-d64 \-m pid
.fl
\fP
.fi
.RE
.LP
.LP
@ -105,8 +95,6 @@ jstack \-J\-d64 \-m pid
For example, \f2set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
@ -118,7 +106,7 @@ Long listing. Prints additional information about locks such as list of owned ja
.na
\f2ownable synchronizers\fP @
.fi
http://java.sun.com/javase/6/docs/api/java/util/concurrent/locks/AbstractOwnableSynchronizer.html.
http://download.oracle.com/javase/7/docs/api/java/util/concurrent/locks/AbstractOwnableSynchronizer.html.
.TP 3
\-m
prints mixed mode (both Java and native C/C++ frames) stack trace.
@ -153,8 +141,6 @@ jsadebugd(1)
.LP
.SH "KNOWN BUGS"
.LP
.LP
.LP
Mixed mode stack trace, the \-m option, does not work with the remote debug server.

92
jdk/src/solaris/doc/sun/man/man1/jstat.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,15 +19,13 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jstat 1 "02 Jun 2010"
.TH jstat 1 "10 May 2011"
.LP
.SH "Name"
jstat \- Java Virtual Machine Statistics Monitoring Tool
.LP
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -38,8 +36,6 @@ jstat \- Java Virtual Machine Statistics Monitoring Tool
.LP
.SH "PARAMETERS"
.LP
.LP
.RS 3
.TP 3
@ -60,16 +56,14 @@ Virtual machine identifier, a string indicating the target Java virtual machine
The syntax of the vmid string largely corresponds to the syntax of a URI. The \f2vmid\fP can vary from a simple integer representing a local JVM to a more complex construction specifying a communications protocol, port number, and other implementation\-specific values. See Virtual Machine Identifier for details.
.TP 3
interval[s|ms]
Sampling interval in the specified units, seconds (s) or milliseconds (ms). Default units are milliseconds.\ Must be a positive integer.\ If specified, \f3jstat\fP will produce its output at each interval.
Sampling interval in the specified units, seconds (s) or milliseconds (ms). Default units are milliseconds. Must be a positive integer. If specified, \f3jstat\fP will produce its output at each interval.
.TP 3
count
Number of samples to display. Default value is infinity; that is, \f3jstat\fP displays statistics until the target JVM terminates or the \f3jstat\fP command is terminated.\ Must be a positive integer.
Number of samples to display. Default value is infinity; that is, \f3jstat\fP displays statistics until the target JVM terminates or the \f3jstat\fP command is terminated. Must be a positive integer.
.RE
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f3jstat\fP tool displays performance statistics for an instrumented HotSpot Java virtual machine (JVM). The target JVM is identified by its virtual machine identifier, or \f2vmid\fP option described below.
@ -81,9 +75,6 @@ The \f3jstat\fP tool displays performance statistics for an instrumented HotSpot
.LP
.SS
VIRTUAL MACHINE IDENTIFIER
.LP
.RS 3
.LP
.LP
The syntax of the \f2vmid\fP string largely corresponds to the syntax of a URI:
@ -115,10 +106,7 @@ The treatment of this parameter depends on implementation. For the optimized loc
.RE
.LP
.RE
.SH "OPTIONS"
.LP
.LP
.LP
The \f3jstat\fP command supports two types of options, general options and output options. General options cause \f3jstat\fP to display simple usage and version information. Output options determine the content and format of the statistical output.
@ -150,14 +138,11 @@ Display list of statistics options. See the Output Options section below.
.SS
OUTPUT OPTIONS
.LP
.RS 3
.LP
If you do not specify a general option, then you can specify output options. Output options determine the content and format of \f3jstat\fP's output, and consist of a single \f2statOption\fP, plus any of the other output options (\-h, \-t, and \-J). The \f2statOption\fP must come first.
.LP
.LP
If you do not specify a general option, then you can specify output options. Output options determine the content and format of \f3jstat\fP's output, and consist of a single \f2statOption\fP, plus any of the other output options (\-h, \-t, and \-J).\ The \f2statOption\fP must come first.
.LP
.LP
Output is formatted as a table, with columns are separated by spaces. A header row with titles describes the columns.\ Use the \f3\-h\fP option to set the frequency at which the header is displayed.\ Column header names are generally consistent between the different options. In general, if two options provide a column with the same name, then the data source for the two columns are the same.
Output is formatted as a table, with columns are separated by spaces. A header row with titles describes the columns. Use the \f3\-h\fP option to set the frequency at which the header is displayed. Column header names are generally consistent between the different options. In general, if two options provide a column with the same name, then the data source for the two columns are the same.
.LP
.LP
Use the \f3\-t\fP option to display a time stamp column, labeled \f2Timestamp\fP as the first column of output. The \f2Timestamp\fP column contains the elapsed time, in seconds, since startup of the target JVM. The resolution of the time stamp is dependent on various factors and is subject to variation due to delayed thread scheduling on heavily loaded systems.
@ -171,7 +156,7 @@ Use the \f2interval\fP and \f2count\fP parameters to determine how frequently an
.RS 3
.TP 3
\-statOption
Determines the statistics information that \f3jstat\fP displays. The following table lists the available options.\ Use the \f3\-options\fP general option to display the list of options for a particular platform installation.
Determines the statistics information that \f3jstat\fP displays. The following table lists the available options. Use the \f3\-options\fP general option to display the list of options for a particular platform installation.
.br
.br
.LP
@ -457,7 +442,7 @@ HotSpot compilation method statistics.
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 230 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 215 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -697,12 +682,8 @@ Pass \f2javaOption\fP to the \f3java\fP application launcher. For example, \f3\-
.RE
.LP
.RE
.SS
STATOPTIONS AND OUTPUT
.LP
.RS 3
.LP
.LP
The following tables summarize the columns that \f3jstat\fP outputs for each \f2statOption\fP.
@ -825,7 +806,7 @@ Time spent performing class load and unload operations.
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 280 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 261 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -1082,7 +1063,7 @@ Class name and method for the last failed compilation.
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 316 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 297 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -1546,7 +1527,7 @@ Total garbage collection time.
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 386 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 367 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -2170,7 +2151,7 @@ Number of Young generation GC Events.
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 460 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 441 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -2550,7 +2531,7 @@ Cause of current Garbage Collection.
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 483 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 464 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -2866,7 +2847,7 @@ Young generation garbage collection time.
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 537 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 518 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -3094,15 +3075,14 @@ Young generation garbage collection time.
.rm 80 81
.nr 34 \n(.lu
.eo
.am 80
.am 81
.br
.di a+
.35
.ft \n(.f
.ll \n(34u*1u/3u
.if \n(.l<\n(80 .ll \n(80u
.if \n(.l<\n(81 .ll \n(81u
.in 0
NGCMN\ \ \ \ \ \ \ \ \ T}~T{
Minimum new generation capacity (KB).
.br
.di
@ -3262,9 +3242,11 @@ Number of young generation GC events.
.if \n(80<\n(38 .nr 80 \n(38
.nr 38 \w\f3Column\fP
.if \n(80<\n(38 .nr 80 \n(38
.nr 38 \wNGCMX \ \ \
.nr 38 \wNGCMN
.if \n(80<\n(38 .nr 80 \n(38
.nr 38 \wNGC \ \ \
.nr 38 \wNGCMX
.if \n(80<\n(38 .nr 80 \n(38
.nr 38 \wNGC
.if \n(80<\n(38 .nr 80 \n(38
.nr 38 \wS0CMX
.if \n(80<\n(38 .nr 80 \n(38
@ -3284,8 +3266,6 @@ Number of young generation GC events.
.if \n(80<\n(38 .nr 80 \n(38
.80
.rm 80
.nr 38 \n(a-
.if \n(80<\n(38 .nr 80 \n(38
.nr 81 0
.nr 38 \w\f3Description\fP
.if \n(81<\n(38 .nr 81 \n(38
@ -3293,6 +3273,8 @@ Number of young generation GC events.
.if \n(81<\n(38 .nr 81 \n(38
.81
.rm 81
.nr 38 \n(a-
.if \n(81<\n(38 .nr 81 \n(38
.nr 38 \n(b-
.if \n(81<\n(38 .nr 81 \n(38
.nr 38 \n(c-
@ -3321,7 +3303,7 @@ Number of young generation GC events.
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 593 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 572 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -3348,11 +3330,11 @@ Number of young generation GC events.
.ta \n(80u \n(81u
.nr 31 \n(.f
.nr 35 1m
\&\h'|\n(40u'\h'|\n(41u'
\&\h'|\n(40u'NGCMN\h'|\n(41u'
.mk ##
.nr 31 \n(##
.sp |\n(##u-1v
.nr 37 \n(40u
.nr 37 \n(41u
.in +\n(37u
.a+
.in -\n(37u
@ -3364,7 +3346,7 @@ Number of young generation GC events.
.ta \n(80u \n(81u
.nr 31 \n(.f
.nr 35 1m
\&\h'|\n(40u'NGCMX \ \ \\h'|\n(41u'
\&\h'|\n(40u'NGCMX\h'|\n(41u'
.mk ##
.nr 31 \n(##
.sp |\n(##u-1v
@ -3380,7 +3362,7 @@ Number of young generation GC events.
.ta \n(80u \n(81u
.nr 31 \n(.f
.nr 35 1m
\&\h'|\n(40u'NGC \ \ \\h'|\n(41u'
\&\h'|\n(40u'NGC\h'|\n(41u'
.mk ##
.nr 31 \n(##
.sp |\n(##u-1v
@ -3522,7 +3504,7 @@ Number of young generation GC events.
.rm i+
.rm j+
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-49
.if \n-(b.=0 .nr c. \n(.c-\n(d.-47
.LP
.SS
@ -3717,7 +3699,7 @@ Total garbage collection time.
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 635 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 614 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -4062,7 +4044,7 @@ Total garbage collection time.
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 677 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 656 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -4407,7 +4389,7 @@ Total garbage collection time.
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 719 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 698 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -4792,7 +4774,7 @@ Total garbage collection time.
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 769 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 748 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -5091,7 +5073,7 @@ Class name and method name identifying the compiled method. Class name uses "/"
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 795 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 774 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
@ -5176,10 +5158,7 @@ Class name and method name identifying the compiled method. Class name uses "/"
.if \n-(b.=0 .nr c. \n(.c-\n(d.-19
.LP
.SS
.LP
.SH ""
.SH "EXAMPLES"
.LP
.LP
This section presents some examples of monitoring a local JVM with a \f2lvmid\fP of 21891.
@ -5355,7 +5334,6 @@ This example attaches to \f2lvmid\fP 40496 on the system named \f2remote.domain\
.LP
The \f2lvmid\fP is combined with the name of the remote host to construct a \f2vmid\fP of \f240496@remote.domain\fP. This \f2vmid\fP results in the use of the \f3rmi\fP protocol to communicate to the default \f3jstatd\fP server on the remote host. The \f3jstatd\fP server is located using the \f3rmiregistry\fP on \f2remote.domain\fP that is bound to the default \f3rmiregistry\fP port (port 1099).
.LP
.RE
.SH "SEE ALSO"
.LP
.RS 3

22
jdk/src/solaris/doc/sun/man/man1/jstatd.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,15 +19,13 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jstatd 1 "02 Jun 2010"
.TH jstatd 1 "10 May 2011"
.LP
.SH "Name"
jstatd \- Virtual Machine jstat Daemon
.LP
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -41,8 +39,6 @@ jstatd [ \fP\f4options\fP\f3 ]\fP
.LP
.SH "PARAMETERS"
.LP
.LP
.RS 3
.TP 3
@ -52,8 +48,6 @@ Command\-line options. The options may be in any order. If there are redundant o
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f3jstatd\fP tool is an RMI server application that monitors for the creation and termination of instrumented HotSpot Java virtual machines (JVMs) and provides a interface to allow remote monitoring tools to attach to JVMs running on the local host.
@ -65,8 +59,6 @@ The \f3jstatd\fP server requires the presence of an RMI registry on the local ho
\f3NOTE:\fP This utility is unsupported and may or may not be available in future versions of the JDK. It is not currently available on the Windows 98 and Windows ME platforms.
.LP
.SH "OPTIONS"
.LP
.LP
.LP
The \f3jstatd\fP command supports the following options:
@ -88,8 +80,6 @@ Pass \f2option\fP to the \f3java\fP launcher called by \f3javac\fP. For example,
.LP
.SH "SECURITY"
.LP
.LP
.LP
The \f3jstatd\fP server can only monitor JVMs for which it has the appropriate native access permissions. Therefor the \f3jstatd\fP process must be running with the same user credentials as the target JVMs. Some user credentials, such as the \f2root\fP user in UNIX(TM) based systems, have permission to access the instrumentation exported by any JVM on the system. A \f3jstatd\fP process running with such credentials can monitor any JVM on the system, but introduces additional security concerns.
@ -102,7 +92,7 @@ The \f3jstatd\fP server installs an instance of RMISecurityPolicy if no other se
.na
\f2Policy File Syntax\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/security/PolicyFiles.html.
http://download.oracle.com/javase/7/docs/technotes/guides/security/PolicyFiles.html.
.LP
.LP
The following policy file will allow the \f3jstatd\fP server to run without any security exceptions. This policy is less liberal then granting all permissions to all codebases, but is more liberal than a policy that grants the minimal permissions to run the \f3jstatd\fP server.
@ -144,15 +134,11 @@ jstatd \-J\-Djava.security.policy=jstatd.all.policy\fP
For sites with more restrictive security practices, it is possible to use a custom policy file to limit access to specific trusted hosts or networks, though such techniques are subject to IP addreess spoofing attacks. If your security concerns cannot be addressed with a customized policy file, then the safest action is to not run the \f3jstatd\fP server and use the \f3jstat\fP and \f3jps\fP tools locally.
.LP
.SH "REMOTE INTERFACE"
.LP
.LP
.LP
The interface exported by the \f3jstatd\fP process is proprietary and is guaranteed to change. Users and developers are discouraged from writing to this interface.
.LP
.SH "EXAMPLES"
.LP
.LP
.LP
Here are some examples of starting \f3jstatd\fP. Note that the \f3jstatd\fP scripts automatically start the server in the background.
@ -264,7 +250,7 @@ o
.na
\f2rmiregistry\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/tools/index.html#rmi \- the Java Remote Object Registry
http://download.oracle.com/javase/7/docs/technotes/tools/index.html#rmi \- the Java Remote Object Registry
.RE
.LP

104
jdk/src/solaris/doc/sun/man/man1/jvisualvm.1 Normal file
View File

@ -0,0 +1,104 @@
." Copyright (c) 2008, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
." under the terms of the GNU General Public License version 2 only, as
." published by the Free Software Foundation.
."
." This code is distributed in the hope that it will be useful, but WITHOUT
." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
." version 2 for more details (a copy is included in the LICENSE file that
." accompanied this code).
."
." You should have received a copy of the GNU General Public License version
." 2 along with this work; if not, write to the Free Software Foundation,
." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
."
." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH jvisualvm 1 "10 May 2011"
.LP
.SH "Name"
\f2jvisualvm\fP \- Java Virtual Machine Monitoring, Troubleshooting, and Profiling Tool
.LP
.SH "SYNOPSIS"
.LP
.nf
\f3
.fl
\fP\f3jvisualvm\fP [ \f2options\fP ]
.fl
.fi
.LP
.SH "PARAMETERS"
.LP
.LP
Options, if used, should follow immediately after the command name. Options may be in any order. For a discussion of parameters that apply to a specific option, see OPTIONS below.
.LP
.SH "DESCRIPTION"
.LP
.LP
Java VisualVM is an intuitive graphical user interface that provides detailed information about Java technology\-based applications (Java applications) while they are running on a given Java Virtual Machine (JVM(*)). The name Java VisualVM comes from the fact that Java VisualVM provides information about the JVM software \f2visually\fP.
.LP
.LP
Java VisualVM combines several monitoring, troubleshooting, and profiling utilities into a single tool. For example, most of the functionality offered by the standalone tools \f2jmap\fP, \f2jinfo\fP, \f2jstat\fP and \f2jstack\fP have been integrated into Java VisualVM. Other functionalities, such as some of those offered by the JConsole tool, can be added as optional plug\-ins.
.LP
.SH "OPTIONS"
.LP
.LP
The following option is possible when you launch Java VisualVM.
.LP
.RS 3
.TP 3
\-J<jvm_option>\
Pass this \f2<jvm_option>\fP to the JVM software.
.RE
.LP
.SH "USAGE"
.LP
.LP
Java VisualVM is useful to Java application developers to troubleshoot applications and to monitor and improve the applications' performance. Java VisualVM can allow developers to generate and analyse heap dumps, track down memory leaks, perform and monitor garbage collection, and perform lightweight memory and CPU profiling. Plug\-ins also exist that expand the functionality of Java VisualVM. For example, most of the functionality of the JConsole tool is available via the MBeans Tab and JConsole Plug\-in Wrapper plug\-ins. You can choose from a catalog of standard Java VisualVM plug\-ins by selecting 'Tools' | 'Plugins' in the Java VisualVM menus.
.LP
.LP
Start Java VisualVM with the following command:
.LP
.nf
\f3
.fl
% jvisualvm \fP\f4<options>\fP\f3
.fl
\fP
.fi
.LP
.SH "SEE ALSO"
.LP
.LP
For more details about Java VisualVM see the following pages.
.LP
.RS 3
.TP 2
o
.na
\f2Java VisualVM developers' site\fP @
.fi
http://visualvm.java.net
.TP 2
o
.na
\f2Java VisualVM in Java SE platform documentation\fP @
.fi
http://download.oracle.com/javase/7/docs/technotes/guides/visualvm/index.html
.RE
.LP
.LP
\f2(* The terms "Java Virtual Machine" and "JVM" mean a Virtual Machine for the Java platform.)\fP
.LP

1002
jdk/src/solaris/doc/sun/man/man1/keytool.1
View File

File diff suppressed because it is too large Load Diff

26
jdk/src/solaris/doc/sun/man/man1/native2ascii.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,22 +19,16 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH native2ascii 1 "02 Jun 2010"
.TH native2ascii 1 "10 May 2011"
.LP
.SH "Name"
native2ascii \- Native\-to\-ASCII Converter
.LP
.RS 3
.LP
Converts a file with characters in any supported character encoding to one with ASCII and/or Unicode escapes, or visa versa.
.LP
Converts a file with native\-encoded characters (characters which are non\-Latin 1 and non\-Unicode) to one with Unicode\-encoded characters.
.LP
.RE
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -46,31 +40,29 @@ Converts a file with native\-encoded characters (characters which are non\-Latin
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The Java compiler and other Java tools can only process files which contain Latin\-1 and/or Unicode\-encoded (\\udddd notation) characters. \f2native2ascii\fP converts files which contain other character encodings into files containing Latin\-1 and/or Unicode\-encoded charaters.
\f2native2ascii\fP converts files that are encoded to any character encoding that is supported by the Java runtime environment to files encoded in ASCII, using Unicode escapes ("\\uxxxx" notation) for all characters that are not part of the ASCII character set. This process is required for properties files containing characters not in ISO\-8859\-1 character sets. The tool can also perform the reverse conversion.
.LP
.LP
If \f2outputfile\fP is omitted, standard output is used for output. If, in addition, \f2inputfile\fP is omitted, standard input is used for input.
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
\-reverse
Perform the reverse operation: convert a file with Latin\-1 and/or Unicode encoded characters to one with native\-encoded characters.
Perform the reverse operation: Convert a file encoded in ISO\-8859\-1 with Unicode escapes to a file in any character encoding supported by the Java runtime environment.
.br
.br
.TP 3
\-encoding encoding_name
Specify the encoding name which is used by the conversion procedure. The default encoding is taken from System property \f2file.encoding\fP. The \f2encoding_name\fP string must be taken from the first column of the table of supported encodings in the
Specifies the name of the character encoding to be used by the conversion procedure. If this option is not present, the default character encoding (as determined by the \f2java.nio.charset.Charset.defaultCharset\fP method) is used. The \f2encoding_name\fP string must be the name of a character encoding that is supported by the Java runtime environment \- see the
.na
\f4Supported Encodings\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/intl/encoding.doc.html document.
http://download.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html document.
.br
.br
.TP 3
\-Joption
Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for the java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes.

26
jdk/src/solaris/doc/sun/man/man1/orbd.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2001, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,14 +19,11 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH orbd 1 "02 Jun 2010"
.TH orbd 1 "10 May 2011"
.LP
.SH "Name"
orbd \- The Object Request Broker Daemon
.LP
.RS 3
.LP
.LP
\f3orbd\fP is used to enable clients to transparently locate and invoke persistent objects on servers in the CORBA environment.
@ -36,12 +33,9 @@ orbd \- The Object Request Broker Daemon
.na
\f2Naming Service\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/idl/jidlNaming.html
http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html
.LP
.RE
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -53,8 +47,6 @@ orbd <\fP\f3options\fP\f3>
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The Server Manager included with the \f3orbd\fP tool is used to enable clients to transparently locate and invoke persistent objects on servers in the CORBA environment. The persistent servers, while publishing the persistent object references in the Naming Service, include the port number of the ORBD in the object reference instead of the port number of the Server. The inclusion of an ORBD port number in the object reference for persistent object references has the following advantages:
@ -77,7 +69,7 @@ When \f2orbd\fP starts up, it also starts a naming service. For more information
.na
\f2Naming Service\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/idl/jidlNaming.html.
http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html.
.LP
.SH "OPTIONS"
.LP
@ -141,11 +133,11 @@ A Naming Service is a CORBA service that allows
.na
\f2CORBA objects\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/idl/jidlGlossary.html#CORBA%20object to be named by means of binding a name to an object reference. The
http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlGlossary.html#CORBA%20object to be named by means of binding a name to an object reference. The
.na
\f2name binding\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/idl/jidlGlossary.html#name%20binding may be stored in the naming service, and a client may supply the name to obtain the desired object reference.
http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlGlossary.html#name%20binding may be stored in the naming service, and a client may supply the name to obtain the desired object reference.
.LP
.LP
Prior to running a client or a server, you will start ORBD. ORBD includes a persistent Naming Service and a transient Naming Service, both of which are an implementation of the COS Naming Service.
@ -224,7 +216,7 @@ For more information on the Naming Service included with ORBD, see
.na
\f2Naming Service\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/idl/jidlNaming.html.
http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html.
.LP
.SH "Server Manager"
.LP
@ -239,7 +231,7 @@ Using the
.na
\f2sample tutorial\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/idl/jidlExample.html for our demonstration, you would run the \f2idlj\fP compiler and \f2javac\fP compiler as shown in the tutorial. To run the Server Manager, follow these steps for running the application:
http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlExample.html for our demonstration, you would run the \f2idlj\fP compiler and \f2javac\fP compiler as shown in the tutorial. To run the Server Manager, follow these steps for running the application:
.LP
.LP
Start \f2orbd\fP.
@ -362,7 +354,7 @@ o
.na
\f2Naming Service\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/idl/jidlNaming.html
http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html
.br
.TP 2
o

134
jdk/src/solaris/doc/sun/man/man1/pack200.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,24 +19,19 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH pack200 1 "02 Jun 2010"
.TH pack200 1 "10 May 2011"
.LP
.SH "Name"
pack200 \- JAR Packing tool
.LP
.SH "SYNOPSIS"
.LP
.LP
.LP
\f4pack200\fP\f2 [ \fP\f2options\fP ] \f2output\-file\fP \f2JAR\-file\fP
.LP
.LP
Options may be in any order. The last option on the command line or in a properties file supersedes all previously specified options.
.LP
.RS 3
.LP
.RS 3
.TP 3
@ -51,10 +46,7 @@ Name of the input file.
.RE
.LP
.RE
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f2pack200\fP tool is a Java application that transforms a JAR file into a compressed \f2pack200\fP file using the Java \f2gzip\fP compressor. The \f2pack200\fP files are highly compressed files that can be directly deployed, saving bandwidth and reducing download time.
@ -64,32 +56,20 @@ The \f2pack200\fP tool uses several options to fine\-tune and set the compressio
.LP
.SS
Typical usage:
.LP
.RS 3
.LP
.LP
\f2% pack200 myarchive.pack.gz myarchive.jar\fP
.LP
.RE
.LP
In this example, \f2myarchive.pack.gz\fP is produced using the default \f2pack200\fP settings.
.LP
.SH "OPTIONS"
.LP
.LP
.LP
\f4\-r \-\-repack\fP
.LP
.RS 3
.LP
.LP
Produces a JAR file by packing the file \f2myarchive.jar\fP and unpacking it. The resulting file can be used as an input to the \f2jarsigner(1)\fP tool.
.LP
.RS 3
.LP
.LP
\f2% pack200 \-\-repack myarchive\-packer.jar myarchive.jar\fP
@ -97,50 +77,35 @@ Produces a JAR file by packing the file \f2myarchive.jar\fP and unpacking it. Th
.LP
\f2% pack200 \-\-repack myarchive.jar\fP
.LP
.RE
.RE
.LP
\f4\-g \-\-no\-gzip\fP
.LP
.RS 3
.LP
.LP
Produces a \f2pack200\fP file. With this option a suitable compressor must be used, and the target system must use a corresponding decompresser.
.LP
.RS 3
.LP
.LP
\f2% pack200 \-\-no\-gzip myarchive.pack myarchive.jar\fP
.LP
.RE
.RE
.LP
\f4\-G \-\-strip\-debug\fP
.LP
.RS 3
.LP
.LP
Strips attributes used for debugging from the output. These include \f2SourceFile\fP, \f2LineNumberTable\fP, \f2LocalVariableTable\fP and \f2LocalVariableTypeTable\fP. Removing these attributes reduces the size of both downloads and installations but reduces the usefulness of debuggers.
.LP
.RE
.LP
\f4\-\-keep\-file\-order\fP
.LP
.LP
Preserve the order of files in the input file; this is the default behavior.
.LP
.LP
\f4\-O \-\-no\-keep\-file\-order\fP
.LP
.RS 3
.LP
.LP
The packer will reorder and transmit all elements. Additionally, the packer may remove JAR directory names. This will reduce the download size; however, certain JAR file optimizations, such as indexing, may not work correctly.
.LP
.RE
.LP
\f4\-Svalue \-\-segment\-limit=\fP\f2value\fP
.LP
.RS 3
.LP
.LP
The value is the estimated target size N (in bytes) of each archive segment. If a single input file requires
@ -151,17 +116,13 @@ more than N bytes, it will be given its own archive segment. As a special case,
The size of each segment is estimated by counting the size of each input file to be transmitted in the segment, along with the size of its name and other transmitted properties.
.LP
.LP
The default is \f21000000\fP (a million bytes). This allows input JAR files of moderate size to be transmitted in one segment. It also puts a limit on memory requirements for packers and unpackers.
The default is \-1, which means the packer will always create a single segment output file. In cases where extremely large output files are generated, users are strongly encouraged to use segmenting or break up the input file into smaller JARs.
.LP
.LP
A 10MB JAR packed without this limit will typically pack about 10% smaller, but the packer may require a larger Java heap (about ten times the segment limit).
.LP
.RE
.LP
\f4\-Evalue \-\-effort=\fP\f2value\fP
.LP
.RS 3
.LP
.LP
If the value is set to a single decimal digit, the packer will use the indicated amount of effort in compressing the archive. Level \f21\fP may produce somewhat larger size and faster compression speed, while level \f29\fP will take much longer but may produce better compression. The special value \f20\fP instructs the packer to copy through the original JAR file directly with no compression. The JSR 200 standard requires any unpacker to understand this special case as a pass\-through of the entire archive.
@ -169,12 +130,8 @@ If the value is set to a single decimal digit, the packer will use the indicated
.LP
The default is \f25\fP, investing a modest amount of time to produce reasonable compression.
.LP
.RE
.LP
\f4\-Hvalue \-\-deflate\-hint=\fP\f2value\fP
.LP
.RS 3
.LP
.LP
Overrides the default, which preserves the input information, but may cause the transmitted archive to be larger. The possible values are:
@ -195,12 +152,8 @@ Preserve deflation hints observed in the input JAR. (This is the default.)
.RE
.LP
.RE
.LP
\f4\-mvalue \-\-modification\-time=\fP\f2value\fP
.LP
.RS 3
.LP
.LP
The possible values are:
@ -215,22 +168,14 @@ Preserves modification times observed in the input JAR. (This is the default.)
.RE
.LP
.RE
.LP
\f4\-Pfile \-\-pass\-file=\fP\f2file\fP
.LP
.RS 3
.LP
.LP
Indicates that a file should be passed through bytewise with no compression. By repeating the option, multiple files may be specified. There is no pathname transformation, except that the system file separator is replaced by the JAR file separator "\f2/\fP". The resulting file names must match exactly as strings with their occurrences in the JAR file. If file is a directory name, all files under that directory will be passed.
.LP
.RE
.LP
\f4\-Uaction \-\-unknown\-attribute=\fP\f2action\fP
.LP
.RS 3
.LP
.LP
Overrides the default behavior; i.e., the classfile containing the unknown attribute will be passed through with the specified action. The possible values for actions are:
@ -248,7 +193,6 @@ Upon encountering this attribute, the entire class will be transmitted as though
.RE
.LP
.RE
.LP
\f4\-Cattribute\-name=\fP\f2layout\fP \f3\-\-class\-attribute=\fP\f2attribute\-name=action\fP
.br
@ -257,9 +201,6 @@ Upon encountering this attribute, the entire class will be transmitted as though
\f4\-Mattribute\-name=\fP\f2layout\fP \f3\-\-method\-attribute=\fP\f2attribute\-name=action\fP
.br
\f4\-Dattribute\-name=\fP\f2layout\fP \f3\-\-code\-attribute=\fP\f2attribute\-name=action\fP
.LP
.RS 3
.LP
.LP
With the above four options, the attribute layout can be specified for a class entity, such as Class attribute, Field attribute, Method attribute, and Code attribute. The attribute\-name is the name of the attribute for which the layout or action is being defined. The possible values for action are:
@ -282,18 +223,11 @@ Upon encountering this attribute, the attribute will be removed from the output.
.LP
Example: \f2\-\-class\-attribute=CompilationID=pass\fP will cause the class file containing this attribute to be passed through without further action by the packer.
.LP
.RE
.LP
\f4\-f\fP\f2 \fP\f2pack.properties\fP \f3\-\-config\-file=\fP\f2pack.properties\fP
.LP
.RS 3
.LP
.LP
A configuration file, containing Java properties to initialize the packer, may be specified on the command line.
.LP
.RS 3
.LP
.LP
\f2% pack200 \-f pack.properties myarchive.pack.gz myarchive.jar\fP
@ -317,62 +251,47 @@ A configuration file, containing Java properties to initialize the packer, may b
\f2# Change the segment limit to be unlimited.\fP
.br
\f2segment.limit=\-1\fP
.LP
.RE
.RE
.RS 3
.LP
.LP
\f4\-v \-\-verbose\fP
.LP
.RS 3
.LP
.LP
Outputs minimal messages. Multiple specification of this option will output more verbose messages.
.LP
.RE
.LP
\f4\-q \-\-quiet\fP
.LP
.RS 3
.LP
.LP
Specifies quiet operation with no messages.
.LP
.RE
.LP
\f4\-lfilename \-\-log\-file=\fP\f2filename\fP
.LP
.RS 3
.LP
.LP
Specifies a log file to output messages.
.LP
.RE
.LP
\f4\-Joption\fP
.LP
.RS 3
\f4\-? \-h \-\-help\fP
.LP
.LP
Passes option to the Java launcher called by \f2pack200\fP. For example, \f2\-J\-Xms48m\fP sets the startup memory to 48 megabytes. Although it does not begin with \f2\-X\fP, it is not a standard option of \f2pack200\fP. It is a common convention for \f2\-J\fP to pass options to the underlying VM executing applications written in Java.
Prints help information about this command.
.LP
.LP
\f4\-V \-\-version\fP
.LP
.LP
Prints version information about this command.
.LP
.LP
\f4\-J\fP\f2option\fP
.LP
.LP
Passes \f2option\fP to the Java launcher called by \f2pack200\fP. For example, \f2\-J\-Xms48m\fP sets the startup memory to 48 megabytes. Although it does not begin with \f2\-X\fP, it is not a standard option of \f2pack200\fP. It is a common convention for \f2\-J\fP to pass options to the underlying VM executing applications written in Java.
.LP
.RE
.RE
.SH "EXIT STATUS"
.LP
.LP
.LP
The following exit values are returned:
.LP
.RS 3
.LP
.LP
\f2\ 0\fP for successful completion;
@ -380,7 +299,6 @@ The following exit values are returned:
.LP
\f2>0\fP if an error occurs.
.LP
.RE
.SH "SEE ALSO"
.LP
.RS 3
@ -392,13 +310,13 @@ o
.na
\f2Java SE Documentation\fP @
.fi
http://java.sun.com/javase/6/docs/index.html
http://download.oracle.com/javase/7/docs/index.html
.TP 2
o
.na
\f2Java Deployment Guide \- Pack200\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/deployment/deployment\-guide/pack200.html
http://download.oracle.com/javase/7/docs/technotes/guides/deployment/deployment\-guide/pack200.html
.TP 2
o
jar(1) \- Java Archive Tool
@ -412,8 +330,6 @@ o
.LP
.SH "NOTES"
.LP
.LP
.LP
This command should not be confused with \f2pack(1)\fP. They are distinctly separate products.

16
jdk/src/solaris/doc/sun/man/man1/policytool.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2001, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,7 +19,7 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH policytool 1 "02 Jun 2010"
.TH policytool 1 "10 May 2011"
.LP
.SH "Name"
@ -27,8 +27,6 @@ policytool \- PolicyTool Administration GUI Utility
.LP
\f3policytool\fP reads and writes a plain text policy file based on user input via the utility GUI.
.SH "SYNOPSIS"
.LP
.LP
.RS 3
.TP 3
@ -57,7 +55,7 @@ The file name
.na
\f2the Policytool Users Guide\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/security/PolicyGuide.html.
http://download.oracle.com/javase/7/docs/technotes/guides/security/PolicyGuide.html.
.SH "OPTIONS"
.RS 3
.TP 3
@ -67,22 +65,22 @@ Loads \f2filename\fP.
.na
\f2Default Policy Implementation and Syntax\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/security/PolicyFiles.html
http://download.oracle.com/javase/7/docs/technotes/guides/security/PolicyFiles.html
.br
.na
\f2Policy Tool Users' Guide\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/security/PolicyGuide.html
http://download.oracle.com/javase/7/docs/technotes/guides/security/PolicyGuide.html
.br
.na
\f2Security Permissions\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/security/permissions.html
http://download.oracle.com/javase/7/docs/technotes/guides/security/permissions.html
.br
.na
\f2Security Overview\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/security/overview/jsoverview.html
http://download.oracle.com/javase/7/docs/technotes/guides/security/overview/jsoverview.html
.br
.RE
.RE

73
jdk/src/solaris/doc/sun/man/man1/rmic.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,22 +19,16 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH rmic 1 "02 Jun 2010"
.TH rmic 1 "10 May 2011"
.LP
.SH "Name"
rmic \- The Java RMI Compiler
.LP
.RS 3
.LP
.LP
\f3rmic\fP generates stub, skeleton, and tie classes for remote objects using either the JRMP or IIOP protocols. Also generates OMG IDL.
.LP
.RE
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -46,8 +40,6 @@ rmic [ \fP\f3options\fP\f3 ] \fP\f4package\-qualified\-class\-name(s)\fP\f3
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f3rmic\fP compiler generates stub and skeleton class files (JRMP protocol) and stub and tie class files (IIOP protocol) for remote objects. These classes files are generated from compiled Java programming language classes that are remote object implementation classes. A remote implementation class is a class that implements the interface \f2java.rmi.Remote\fP. The class names in the \f3rmic\fP command must be for classes that have been compiled successfully with the \f3javac\fP command and must be fully package qualified. For example, running \f3rmic\fP on the class file name \f2HelloImpl\fP as shown here:
@ -80,8 +72,6 @@ By default, \f3rmic\fP generates stub classes that use the 1.2 JRMP stub protoco
A stub implements only the remote interfaces, not any local interfaces that the remote object also implements. Because a JRMP stub implements the same set of remote interfaces as the remote object itself, a client can use the Java programming language's built\-in operators for casting and type checking. For IIOP, the \f2PortableRemoteObject.narrow\fP method must be used.
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
@ -90,9 +80,6 @@ Overrides location of bootstrap class files
.TP 3
\-classpath path
Specifies the path \f3rmic\fP uses to look up classes. This option overrides the default or the CLASSPATH environment variable if it is set. Directories are separated by colons. Thus the general format for \f2path\fP is:
.RS 3
.LP
.nf
\f3
.fl
@ -100,11 +87,7 @@ Specifies the path \f3rmic\fP uses to look up classes. This option overrides the
.fl
\fP
.fi
.RE
For example:
.RS 3
.LP
.nf
\f3
.fl
@ -112,13 +95,9 @@ For example:
.fl
\fP
.fi
.RE
.TP 3
\-d directory
Specifies the root destination directory for the generated class hierarchy. You can use this option to specify a destination directory for the stub, skeleton, and tie files. For example, the command
.RS 3
.LP
.nf
\f3
.fl
@ -126,7 +105,6 @@ Specifies the root destination directory for the generated class hierarchy. You
.fl
\fP
.fi
.RE
would place the stub and skeleton classes derived from \f2MyClass\fP into the directory \f2/java/classes/foo\fP. If the \f2\-d\fP option is not specified, the default behavior is as if \f2"\-d\ ."\fP were specified: the package hierarchy of the target class is created in the current directory, and stub/tie/skeleton files are placed within it. (Note that in some previous versions of \f3rmic\fP, if \f2\-d\fP was not specified, then the package hierarchy was \f2not\fP created, and all of the output files were placed directly in the current directory.)
.br
\
@ -136,16 +114,16 @@ Overrides location of installed extensions
.TP 3
\-g
Enables generation of all debugging information, including local variables. By default, only line number information is generated.
.LP
.TP 3
\-idl
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
.na
\f2Java Language to IDL Mapping\fP @
.fi
http://www.omg.org/technology/documents/formal/java_language_mapping_to_omg_idl.htm (OMG) document for a complete description.
.LP
When the \f2\-idl\fP option is used, other options also include:
http://www.omg.org/technology/documents/formal/java_language_mapping_to_omg_idl.htm (OMG) document for a complete description.
.br
.br
When the \f2\-idl\fP option is used, other options also include:
.RS 3
.TP 3
\-always or \-alwaysgenerate
@ -160,31 +138,22 @@ Specifies IDLEntity package mapping. For example:\ \f2\-idlModule foo.bar my::r
\-idlFile\ fromJavaPackage[.class]\ toIDLFile
Specifies IDLEntity file mapping. For example:\ \f2\-idlFile test.pkg.X TEST16.idl\fP.\
.RE
.LP
.TP 3
\-iiop
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.
.LP
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.
.br
.br
Invoking \f2rmic\fP with the \f2\-iiop\fP generates stubs and ties that conform to this naming convention:
.RS 3
.LP
.nf
\f3
.fl
_<implementationName>_stub.class
.fl
\fP
.br
\f3
.fl
_<interfaceName>_tie.class
.fl
\fP
.fi
.RE
.LP
When the \f2\-iiop\fP option is used, other options also include:
When the \f2\-iiop\fP option is used, other options also include:
.RS 3
.TP 3
\-always or \-alwaysgenerate
@ -197,13 +166,11 @@ Do not create stubs optimized for same\-process clients and servers.
Must be used with the \f2\-idl\fP option. Prevents addition of \f2valuetype\fP methods and initializers to emitted IDL. These methods and initializers are optional for \f2valuetype\fPs, and are generated unless the \f2\-noValueMethods\fP option is specified when using the \f2\-idl\fP option.
.TP 3
\-poa
Changes the inheritance from \f2org.omg.CORBA_2_3.portable.ObjectImpl\fP to \f2org.omg.PortableServer.Servant\fP.
.LP
The \f2PortableServer\fP module for the
Changes the inheritance from \f2org.omg.CORBA_2_3.portable.ObjectImpl\fP to \f2org.omg.PortableServer.Servant\fP. The \f2PortableServer\fP module for the
.na
\f2Portable Object Adapter\fP @
.fi
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.
http://download.oracle.com/javase/7/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.
.RE
.TP 3
\-J
@ -214,18 +181,18 @@ Retains the generated \f2.java\fP source files for the stub, skeleton, and/or ti
.TP 3
\-nowarn
Turns off warnings. If used the compiler does not print out any warnings.
.LP
.TP 3
\-nowrite
Does not write compiled classes to the file system.
.TP 3
\-vcompat
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.
.TP 3
\-verbose
Causes the compiler and linker to print out messages about what classes are being compiled and what class files are being loaded.
.LP
.TP 3
\-v1.1
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).
.LP
.TP 3
\-v1.2
(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,16 +200,11 @@ Generates stub and skeleton classes for the 1.1 JRMP stub protocol version only.
.LP
.SH "ENVIRONMENT VARIABLES"
.LP
.LP
.RS 3
.TP 3
CLASSPATH
Used to provide the system a path to user\-defined classes. Directories are separated by colons. For example,
.RS 3
.LP
.nf
\f3
.fl
@ -251,18 +213,15 @@ Used to provide the system a path to user\-defined classes. Directories are sepa
\fP
.fi
.RE
.RE
.LP
.SH "SEE ALSO"
.LP
.LP
.LP
java(1), javac(1),
.na
\f2CLASSPATH\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/tools/index.html#classpath
http://download.oracle.com/javase/7/docs/technotes/tools/index.html#classpath
.LP

38
jdk/src/solaris/doc/sun/man/man1/rmid.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1998, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,22 +19,16 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH rmid 1 "02 Jun 2010"
.TH rmid 1 "10 May 2011"
.LP
.SH "Name"
rmid \- The Java RMI Activation System Daemon
.LP
.RS 3
.LP
.LP
\f3rmid\fP starts the activation system daemon that allows objects to be registered and activated in a virtual machine (VM).
.LP
.RE
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -46,19 +40,17 @@ rmid [options]
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f3rmid\fP tool starts the activation system daemon. The activation system daemon must be started before activatable objects can be either registered with the activation system or activated in a VM. See the
.na
\f2Java RMI Specification\fP @
.fi
http://java.sun.com/javase/6/docs/platform/rmi/spec/rmiTOC.html and
http://download.oracle.com/javase/7/docs/platform/rmi/spec/rmiTOC.html and
.na
\f2Activation tutorials\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/rmi/activation/overview.html for details on how to write programs that use activatable remote objects.
http://download.oracle.com/javase/7/docs/technotes/guides/rmi/activation/overview.html for details on how to write programs that use activatable remote objects.
.LP
.LP
The daemon can be started by executing the \f2rmid\fP command, and specifying a security policy file, as follows:
@ -132,8 +124,6 @@ The \f2\-log\fP option is required. If this option is not specified, \f2rmid\fP
See the man pages for \f2inetd\fP (Solaris) or \f2xinetd\fP (Linux) for details on how to configure services to be started on demand.
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
@ -169,7 +159,6 @@ Specifies an option that is passed to the \f2java\fP interpreter running \f2rmid
.TP 3
\-J\-Dsun.rmi.activation.execPolicy=<policy>
Specifies the policy that \f2rmid\fP employs to check commands and command\-line options used to launch the VM in which an activation group runs. Please note that this option exists only in Sun's implementation of the Java RMI activation daemon. If this property is not specified on the command line, the result is the same as if \f2\-J\-Dsun.rmi.activation.execPolicy=default\fP were specified. The possible values of \f2<policy>\fP can be \f2default\fP, \f2<policyClassName>\fP, or \f2none\fP:
.LP
.RS 3
.TP 2
o
@ -255,17 +244,9 @@ The first permission granted allow \f2rmid\fP to execute the 1.7.0 version of th
The third permission granted, an \f2ExecOptionPermission\fP, allows \f2rmid\fP to launch an activation group that defines the security policy file to be \f2/files/policies/group.policy\fP. The next permission allows the \f2java.security.debug\fP property to be used by an activation group. The last permission allows any property in the \f2sun.rmi\fP property name hierarchy to be used by activation groups.
.LP
To start \f2rmid\fP with a policy file, the \f2java.security.policy\fP property needs to be specified on \f2rmid\fP's command line, for example:
.RS 3
.LP
.LP
\f2rmid \-J\-Djava.security.policy=rmid.policy\fP
.LP
\f2rmid \-J\-Djava.security.policy=rmid.policy\fP
.RE
.RE
.TP 2
o
.LP
.TP 2
o
\f4<policyClassName>\fP
@ -285,7 +266,6 @@ The \f2policyClassName\fP specifies a public class with a public, no\-argument c
\fP
.fi
Before launching an activation group, \f2rmid\fP calls the policy's \f2checkExecCommand\fP method, passing it the activation group descriptor and an array containing the complete command to launch the activation group. If the \f2checkExecCommand\fP throws a \f2SecurityException\fP, \f2rmid\fP will not launch the activation group and an \f2ActivationException\fP will be thrown to the caller attempting to activate the object.
.LP
.TP 2
o
\f3none\fP
@ -318,9 +298,9 @@ Specifies the port \f2rmid\fP's registry uses. The activation system daemon bind
\-stop
Stops the current invocation of \f2rmid\fP, for a port specified by the \f2\-port\fP option. If no port is specified, it will stop the \f2rmid\fP running on port 1098.
.RE
.SH "ENVIRONMENT VARIABLES"
.LP
.LP
.SH "ENVIRONMENT VARIABLES"
.LP
.RS 3
.TP 3
@ -337,14 +317,12 @@ Used to provide the system a path to user\-defined classes. Directories are sepa
.LP
.SH "SEE ALSO"
.LP
.LP
.LP
rmic(1),
.na
\f2CLASSPATH\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/tools/index.html#classpath, java(1)
http://download.oracle.com/javase/7/docs/technotes/tools/index.html#classpath, java(1)
.LP

27
jdk/src/solaris/doc/sun/man/man1/rmiregistry.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,22 +19,18 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH rmiregistry 1 "02 Jun 2010"
.TH rmiregistry 1 "10 May 2011"
.LP
.SH "Name"
rmiregistry \- The Java Remote Object Registry
.LP
.RS 3
.LP
.LP
The \f3rmiregistry\fP command starts a remote object registry on the specified port on the current host.
.LP
The \f3rmiregistry\fP command starts a remote object registry on the specified port on the current host.
.RE
.SH "SYNOPSIS"
.LP
.LP
.SH "SYNOPSIS"
.LP
.nf
\f3
@ -46,8 +42,6 @@ rmiregistry [\fP\f4port\fP\f3]
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f3rmiregistry\fP command creates and starts a remote object registry on the specified \f2port\fP on the current host. If \f2port\fP is omitted, the registry is started on port 1099. The \f3rmiregistry\fP command produces no output and is typically run in the background. For example:
@ -68,8 +62,6 @@ The methods of the \f2java.rmi.registry.LocateRegistry\fP class are used to get
The URL\-based methods of the \f2java.rmi.Naming\fP class operate on a registry and can be used to look up a remote object on any host, and on the local host: bind a simple (string) name to a remote object, rebind a new name to a remote object (overriding the old binding), unbind a remote object, and list the URLs bound in the registry.
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
@ -80,17 +72,12 @@ Used in conjunction with any \f2java\fP option, it passes the option following t
.LP
.SH "SEE ALSO"
.LP
.LP
.LP
java(1),
.na
\f2java.rmi.registry.LocateRegistry\fP @
.fi
http://java.sun.com/javase/6/docs/api/java/rmi/registry/LocateRegistry.html and
http://download.oracle.com/javase/7/docs/api/java/rmi/registry/LocateRegistry.html and
.na
\f2java.rmi.Naming\fP @
.fi
http://java.sun.com/javase/6/docs/api/java/rmi/Naming.html
.LP
http://download.oracle.com/javase/7/docs/api/java/rmi/Naming.html

48
jdk/src/solaris/doc/sun/man/man1/schemagen.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,7 +19,7 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH schemagen 1 "02 Jun 2010"
.TH schemagen 1 "10 May 2011"
.LP
.SH "Name"
@ -30,8 +30,7 @@ schemagen \- Java(TM) Architecture for XML Binding Schema Generator
.br
\f3Implementation Version:\fP 2.1.3
.LP
.SS
Launching schemagen
.SH "Launching schemagen"
.LP
.LP
The schema generator can be launched using the appropriate \f2schemagen\fP shell script in the \f2bin\fP directory for your platform.
@ -45,9 +44,6 @@ We also provide an Ant task to run the schema generator \- see the instructions
\f2using schemagen with Ant\fP @
.fi
https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html.
.LP
.RS 3
.LP
.nf
\f3
@ -58,19 +54,13 @@ Note: Writing schema1.xsd
.fl
\fP
.fi
.RE
.LP
.LP
If your java sources/classes reference other classes, they must be accessable on your system CLASSPATH environment variable, or they need to be given to the tool by using the \f2\-classpath\fP/\f2\-cp\fP options. Otherwise you will see errors when generating your schema.
.LP
.RS 3
.LP
\f3Command Line Options\fP
.LP
.RS 3
.SS
Command Line Options
.LP
.nf
\f3
@ -79,24 +69,29 @@ Usage: schemagen [\-options ...] <java files>
.fl
.fl
Options:
Options:
.fl
\-d <path> : Specify where to place processor and javac generated class files
\-d <path> : specify where to place processor and javac generated class files
.fl
\-cp <path> : Specify where to find user specified files
\-cp <path> : specify where to find user specified files
.fl
\-classpath <path> : Specify where to find user specified files
\-classpath <path> : specify where to find user specified files
.fl
\-help : Display this usage message
\-encoding <encoding> : specify encoding to be used for apt/javac invocation
.fl
.fl
\-episode <file> : generate episode file for separate compilation
.fl
\-version : display version information
.fl
\-help : display this usage message
.fl
\fP
.fi
.RE
.LP
.RE
.SS
Generated Resource Files
.SH "Generated Resource Files"
.LP
.LP
The current schema generator simply creates a schema file for each namespace referenced in your Java classes. There is no way to control the name of the generated schema files at this time. For that purpose, use
@ -105,7 +100,8 @@ The current schema generator simply creates a schema file for each namespace ref
.fi
https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html.
.LP
.SH "See Also"
.SH "Name"
See Also
.LP
.RS 3
.TP 2
@ -124,7 +120,7 @@ o
.na
\f2Java Architecture for XML Binding (JAXB)\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/xml/jaxb/index.html
http://download.oracle.com/javase/7/docs/technotes/guides/xml/jaxb/index.html
.RE
.LP

32
jdk/src/solaris/doc/sun/man/man1/serialver.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,22 +19,16 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH serialver 1 "02 Jun 2010"
.TH serialver 1 "10 May 2011"
.LP
.SH "Name"
serialver \- The Serial Version Command
.LP
.RS 3
.LP
.LP
The \f3serialver\fP command returns the \f2serialVersionUID\fP.
.LP
.RE
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -43,9 +37,6 @@ The \f3serialver\fP command returns the \f2serialVersionUID\fP.
.fl
.fi
.LP
.RS 3
.LP
.RS 3
.TP 3
@ -57,17 +48,12 @@ One or more class names
.RE
.LP
.RE
.SH "DESCRIPTION"
.LP
.LP
.LP
\f3serialver\fP returns the \f2serialVersionUID\fP for one or more classes in a form suitable for copying into an evolving class. When invoked with no arguments it prints a usage line.
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
@ -87,37 +73,25 @@ Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the
.LP
.SH "NOTES"
.LP
.LP
.LP
The \f3serialver\fP command loads and initializes the specified classes in its virtual machine, and by default, it does not set a security manager. If \f3serialver\fP is to be run with untrusted classes, a security manager can be set with the following option:
.LP
.RS 3
.LP
.LP
\f2\-J\-Djava.security.manager\fP
.LP
.RE
.LP
and, if necessary, a security policy can be specified with the following option:
.LP
.RS 3
.LP
.LP
\f2\-J\-Djava.security.policy=<policy file>\fP
.LP
.RE
.SH "SEE ALSO"
.LP
.LP
.LP
.na
\f2java.io.ObjectStreamClass\fP @
.fi
http://java.sun.com/javase/6/docs/api/java/io/ObjectStreamClass.html
http://download.oracle.com/javase/7/docs/api/java/io/ObjectStreamClass.html
.LP

20
jdk/src/solaris/doc/sun/man/man1/servertool.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2001, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,20 +19,14 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH servertool 1 "02 Jun 2010"
.TH servertool 1 "10 May 2011"
.LP
.SH "Name"
servertool \- The Java(TM) IDL Server Tool
.LP
.RS 3
.LP
\f3servertool\fP provides a command\-line interface for application programmers to register, unregister, startup, and shutdown a persistent server.
.RE
\f3servertool\fP provides a command\-line interface for application programmers to register, unregister, startup, and shutdown a persistent server.
.SH "SYNOPSIS"
.LP
.LP
.nf
\f3
@ -53,15 +47,11 @@ If you enter a command when starting \f2servertool\fP, the Java IDL Server Tool
The \f2\-ORBInitialPort\fP \f2nameserverport\fP option is \f3required\fP. The value for \f2nameserverport\fP must specify the port on which \f2orbd\fP is running and listening for incoming requests. When using Solaris software, you must become root to start a process on a port under 1024. For this reason, we recommend that you use a port number greater than or equal to 1024 for the \f2nameserverport\fP.
.LP
.SH "DESCRIPTION"
.LP
.LP
.LP
The \f2servertool\fP provides the command\-line interface for the application programmers to register, unregister, startup, and shutdown a persistent server. Other commands are provided to obtain various statistical information about the server.
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
@ -74,8 +64,6 @@ Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the
.LP
.SH "COMMANDS"
.LP
.LP
.RS 3
.TP 3
@ -121,7 +109,5 @@ Exit the server tool.
.LP
.SH "SEE ALSO"
.LP
.LP
orbd(1)

57
jdk/src/solaris/doc/sun/man/man1/tnameserv.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 1999, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 1999, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,7 +19,7 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH tnameserv 1 "02 Jun 2010"
.TH tnameserv 1 "10 May 2011"
.LP
.SH "Name"
@ -30,7 +30,7 @@ This document discusses using the Java IDL Transient Naming Service, \f2tnameser
.na
\f2Java IDL Naming Service Included with ORBD\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/idl/jidlNaming.html topic.
http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html topic.
.LP
.LP
Topics in this section include:
@ -120,11 +120,11 @@ For the client and server to find the Naming Service, they must be made aware of
.na
\f2The Hello World Example Using RMI\-IIOP\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/rmi\-iiop/rmiiiopexample.html. You could also use the command line options \f2\-ORBInitialPort\fP \f2nameserverport#\fP and \f2\-ORBInitialHost\fP \f2nameserverhostname\fP to tell the client and server where to find the Naming Service.
http://download.oracle.com/javase/7/docs/technotes/guides/rmi\-iiop/rmiiiopexample.html. You could also use the command line options \f2\-ORBInitialPort\fP \f2nameserverport#\fP and \f2\-ORBInitialHost\fP \f2nameserverhostname\fP to tell the client and server where to find the Naming Service.
.na
\f2Java IDL: Running the Hello World Example on TWO Machines\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/idl/tutorial/jidl2machines.html shows one way of doing this using the command line option.
http://download.oracle.com/javase/7/docs/technotes/guides/idl/tutorial/jidl2machines.html shows one way of doing this using the command line option.
.LP
.LP
For example, suppose the Transient Naming Service, \f2tnameserv\fP is running on port 1050 on host \f2nameserverhost\fP. The client is running on host \f2clienthost\fP and the server is running on host \f2serverhost\fP.
@ -170,16 +170,12 @@ The \-J option
.LP
This command\-line option is available for use with \f2tnameserve\fP:
.RS 3
.LP
.RS 3
.TP 3
\-Joption
Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. It is a common convention for \f3\-J\fP to pass options to the underlying virtual machine.
.RE
.LP
.RE
.SH "Stopping the Java\ IDL Transient Naming Service"
.LP
.LP
@ -190,28 +186,27 @@ To stop the Java\ IDL naming service, use the relevant operating system command,
.LP
The following sample program illustrates how to add names to the namespace. It is a self\-contained Transient Naming Service client that creates the following simple tree.
.LP
.nf
\f3
.fl
\fP\f3
.fl
\fP\f4Initial\fP\f3
.fl
\fP\f4Naming Context\fP\f3
.fl
/ \\
.fl
/ \\
.fl
plans \fP\f4Personal\fP\f3
.fl
/ \\
.fl
/ \\
.fl
calendar schedule\fP
.fl
.fi
.RS 3
.TP 2
o
\f4Initial Naming Context\fP
.RS 3
.TP 2
*
\f3plans\fP
.TP 2
*
\f4Personal\fP
.RS 3
.TP 2
-
\f3calendar\fP
.TP 2
-
\f3schedule\fP
.RE
.RE
.RE
.LP
.LP

80
jdk/src/solaris/doc/sun/man/man1/unpack200.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,24 +19,19 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH unpack200 1 "02 Jun 2010"
.TH unpack200 1 "10 May 2011"
.LP
.SH "Name"
unpack200 \- JAR Unpacking tool
.LP
.SH "SYNOPSIS"
.LP
.LP
.LP
\f4unpack200\fP\f2 [ \fP\f2options\fP ] \f2input\-file\fP \f2JAR\-file\fP
.LP
.LP
Options may be in any order. The last option on the command line supersedes all previously specified options.
.LP
.RS 3
.LP
.RS 3
.TP 3
@ -48,99 +43,71 @@ Name of the output JAR file.
.RE
.LP
.RE
.SH "DESCRIPTION"
.LP
.LP
.LP
\f2unpack200\fP is a native implementation that transforms a packed file produced by \f2pack200\fP(1) into a JAR file. Typical usage:
.LP
.RS 3
.LP
.LP
\f2% unpack200 myarchive.pack.gz myarchive.jar\fP
.LP
.RE
.LP
In this example, the \f2myarchive.jar\fP is produced from \f2myarchive.pack.gz\fP using the default \f2unpack200\fP settings.
.LP
.SH "OPTIONS"
.LP
.SS
Standard Options
.LP
.RS 3
.LP
.LP
\f4\-Hvalue \-\-deflate\-hint=\fP\f2value\fP
.LP
.RS 3
.LP
.LP
Sets the deflation to be \f2true\fP, \f2false\fP, or \f2keep\fP on all entries within a JAR file. The default mode is \f2keep\fP. If \f2true\fP or \f2false\fP, overrides the default behavior and sets the deflation mode on all entries within the output JAR file.
.LP
.RE
.RE
.SS
Non\-Standard Options
.LP
.RS 3
.LP
.LP
\f4\-r \-\-remove\-pack\-file\fP
.LP
.RS 3
.LP
.LP
Removes the input packed file.
.LP
.RE
.LP
\f4\-v \-\-verbose\fP
.LP
.RS 3
.LP
.LP
Outputs minimal messages. Multiple specification of this option will output more verbose messages.
.LP
.RE
.LP
\f4\-q \-\-quiet\fP
.LP
.RS 3
.LP
.LP
Specifies quiet operation with no messages.
.LP
.RE
.LP
\f4\-lfilename \-\-log\-file=\fP\f2filename\fP
.LP
.RS 3
.LP
.LP
Specifies a log file to output messages.
.LP
.RE
.RE
.SH "EXIT STATUS"
.LP
\f4\-? \-h \-\-help\fP
.LP
.LP
Prints help information about this command.
.LP
.LP
\f4\-V \-\-version\fP
.LP
.LP
Prints version information about this command.
.LP
.LP
\f4\-J\fP\f2option\fP
.LP
.LP
Passes \f2option\fP to the Java launcher called by \f2unpack200\fP.
.LP
.SH "EXIT STATUS"
.LP
.LP
The following exit values are returned:
.LP
.RS 3
.LP
.LP
\f2\ 0\fP if successful completion;
@ -148,7 +115,6 @@ The following exit values are returned:
.LP
\f2>0\fP if an error occurred.
.LP
.RE
.SH "SEE ALSO"
.LP
.RS 3
@ -160,13 +126,13 @@ o
.na
\f2Java SE Documentation\fP @
.fi
http://java.sun.com/javase/6/docs/index.html
http://download.oracle.com/javase/7/docs/index.html
.TP 2
o
.na
\f2Java Deployment Guide \- Pack200\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/deployment/deployment\-guide/pack200.html
http://download.oracle.com/javase/7/docs/technotes/guides/deployment/deployment\-guide/pack200.html
.TP 2
o
jar(1) \- Java Archive Tool
@ -180,8 +146,6 @@ o
.LP
.SH "NOTES"
.LP
.LP
.LP
This command should not be confused with \f2unpack(1)\fP. They are distinctly separate products.

12
jdk/src/solaris/doc/sun/man/man1/wsgen.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,21 +19,15 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH wsgen 1 "02 Jun 2010"
.TH wsgen 1 "10 May 2011"
.SH "Name"
wsgen \- Java(TM) API for XML Web Services (JAX\-WS) 2.0
.RS 3
.LP
.LP
\f3Specification Version:\fP 2.1
.br
\f3Implementation Version:\fP 2.1.1
.LP
.LP
The \f2wsgen\fP tool generates JAX\-WS portable artifacts used in JAX\-WS web services. The tool reads a web service endpoint implementation class (SEI) and generates all the required artifacts for web service deployment, and invocation
.LP
.RE
.SH "Overview"
.LP
The \f2wsgen\fP tool generates JAX\-WS portable artifacts used in JAX\-WS web services. The tool reads a web service endpoint class and generates all the required artifacts for web service deployment, and invocation. JAXWS 2.1.1 RI also provides a wsgen ant task, see
@ -354,7 +348,7 @@ Used only in conjunction with the \f2\-wsdl\fP option. Used to specify a particu
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 139 file Input is too wide - \n(TW units
.if t .if \n(TW>\n(.li .tm Table at line 133 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1

289
jdk/src/solaris/doc/sun/man/man1/wsimport.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,7 +19,7 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH wsimport 1 "02 Jun 2010"
.TH wsimport 1 "10 May 2011"
.SH "Name"
wsimport \- Java(TM) API for XML Web Services (JAX\-WS) 2.0
.LP
@ -684,15 +684,296 @@ Multiple JAX\-WS and JAXB binding files can be specified using \f2\-b\fP option
\f2customization documentation\fP @
.fi
https://jax\-ws.dev.java.net/nonav/2.1.1/docs/customizations.html.
.LP
The following table lists \f2wsimport\fP non\-standard options:
.LP
.TS
.if \n+(b.=1 .nr d. \n(.c-\n(c.-1
.de 35
.ps \n(.s
.vs \n(.vu
.in \n(.iu
.if \n(.u .fi
.if \n(.j .ad
.if \n(.j=0 .na
..
.nf
.nr #~ 0
.if n .nr #~ 0.6n
.ds #d .d
.if \(ts\n(.z\(ts\(ts .ds #d nl
.fc
.nr 33 \n(.s
.rm 80 81
.nr 34 \n(.lu
.eo
.am 81
.br
.di a+
.35
.ft \n(.f
.ll \n(34u*1u/3u
.if \n(.l<\n(81 .ll \n(81u
.in 0
Map headers not bound to request or response message to Java method parameters.
.br
.di
.nr a| \n(dn
.nr a- \n(dl
..
.ec \
.eo
.am 81
.br
.di b+
.35
.ft \n(.f
.ll \n(34u*1u/3u
.if \n(.l<\n(81 .ll \n(81u
.in 0
WSDL URI that specifies the file that contains authorization information; this URI is in the following format: http://\f2<user name>\fP:\f2<password>\fP@\f2<host name>\fP/\f2<Web service name>\fP?wsdl
.br
.di
.nr b| \n(dn
.nr b- \n(dl
..
.ec \
.eo
.am 81
.br
.di c+
.35
.ft \n(.f
.ll \n(34u*1u/3u
.if \n(.l<\n(81 .ll \n(81u
.in 0
Print debugging information.
.br
.di
.nr c| \n(dn
.nr c- \n(dl
..
.ec \
.eo
.am 80
.br
.di d+
.35
.ft \n(.f
.ll \n(34u*1u/3u
.if \n(.l<\n(80 .ll \n(80u
.in 0
\f3\-Xno\-addressing\-databinding\fP
.br
.di
.nr d| \n(dn
.nr d- \n(dl
..
.ec \
.eo
.am 81
.br
.di e+
.35
.ft \n(.f
.ll \n(34u*1u/3u
.if \n(.l<\n(81 .ll \n(81u
.in 0
Enable binding of W3C \f2EndpointReferenceType\fP to Java.
.br
.di
.nr e| \n(dn
.nr e- \n(dl
..
.ec \
.eo
.am 81
.br
.di f+
.35
.ft \n(.f
.ll \n(34u*1u/3u
.if \n(.l<\n(81 .ll \n(81u
.in 0
Do not compile generated Java files.
.br
.di
.nr f| \n(dn
.nr f- \n(dl
..
.ec \
.35
.nf
.ll \n(34u
.nr 80 0
.nr 38 \w\f3Option\fP
.if \n(80<\n(38 .nr 80 \n(38
.nr 38 \w\f3\-XadditionalHeaders\fP
.if \n(80<\n(38 .nr 80 \n(38
.nr 38 \w\f3\-Xauthfile <file>\fP
.if \n(80<\n(38 .nr 80 \n(38
.nr 38 \w\f3\-Xdebug\fP
.if \n(80<\n(38 .nr 80 \n(38
.nr 38 \w\f3\-Xnocompile\fP
.if \n(80<\n(38 .nr 80 \n(38
.80
.rm 80
.nr 38 \n(d-
.if \n(80<\n(38 .nr 80 \n(38
.nr 81 0
.nr 38 \w\f3Description\fP
.if \n(81<\n(38 .nr 81 \n(38
.81
.rm 81
.nr 38 \n(a-
.if \n(81<\n(38 .nr 81 \n(38
.nr 38 \n(b-
.if \n(81<\n(38 .nr 81 \n(38
.nr 38 \n(c-
.if \n(81<\n(38 .nr 81 \n(38
.nr 38 \n(e-
.if \n(81<\n(38 .nr 81 \n(38
.nr 38 \n(f-
.if \n(81<\n(38 .nr 81 \n(38
.35
.nf
.ll \n(34u
.nr 38 1n
.nr 79 0
.nr 40 \n(79+(0*\n(38)
.nr 80 +\n(40
.nr 41 \n(80+(3*\n(38)
.nr 81 +\n(41
.nr TW \n(81
.if t .if \n(TW>\n(.li .tm Table at line 193 file Input is too wide - \n(TW units
.fc  
.nr #T 0-1
.nr #a 0-1
.eo
.de T#
.ds #d .d
.if \(ts\n(.z\(ts\(ts .ds #d nl
.mk ##
.nr ## -1v
.ls 1
.ls
..
.ec
.ta \n(80u \n(81u
.nr 31 \n(.f
.nr 35 1m
\&\h'|\n(40u'\f3Option\fP\h'|\n(41u'\f3Description\fP
.ne \n(a|u+\n(.Vu
.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v)
.ta \n(80u \n(81u
.nr 31 \n(.f
.nr 35 1m
\&\h'|\n(40u'\f3\-XadditionalHeaders\fP\h'|\n(41u'
.mk ##
.nr 31 \n(##
.sp |\n(##u-1v
.nr 37 \n(41u
.in +\n(37u
.a+
.in -\n(37u
.mk 32
.if \n(32>\n(31 .nr 31 \n(32
.sp |\n(31u
.ne \n(b|u+\n(.Vu
.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v)
.ta \n(80u \n(81u
.nr 31 \n(.f
.nr 35 1m
\&\h'|\n(40u'\f3\-Xauthfile <file>\fP\h'|\n(41u'
.mk ##
.nr 31 \n(##
.sp |\n(##u-1v
.nr 37 \n(41u
.in +\n(37u
.b+
.in -\n(37u
.mk 32
.if \n(32>\n(31 .nr 31 \n(32
.sp |\n(31u
.ne \n(c|u+\n(.Vu
.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v)
.ta \n(80u \n(81u
.nr 31 \n(.f
.nr 35 1m
\&\h'|\n(40u'\f3\-Xdebug\fP\h'|\n(41u'
.mk ##
.nr 31 \n(##
.sp |\n(##u-1v
.nr 37 \n(41u
.in +\n(37u
.c+
.in -\n(37u
.mk 32
.if \n(32>\n(31 .nr 31 \n(32
.sp |\n(31u
.ne \n(d|u+\n(.Vu
.ne \n(e|u+\n(.Vu
.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v)
.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v)
.ta \n(80u \n(81u
.nr 31 \n(.f
.nr 35 1m
\&\h'|\n(40u'\h'|\n(41u'
.mk ##
.nr 31 \n(##
.sp |\n(##u-1v
.nr 37 \n(40u
.in +\n(37u
.d+
.in -\n(37u
.mk 32
.if \n(32>\n(31 .nr 31 \n(32
.sp |\n(##u-1v
.nr 37 \n(41u
.in +\n(37u
.e+
.in -\n(37u
.mk 32
.if \n(32>\n(31 .nr 31 \n(32
.sp |\n(31u
.ne \n(f|u+\n(.Vu
.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v)
.ta \n(80u \n(81u
.nr 31 \n(.f
.nr 35 1m
\&\h'|\n(40u'\f3\-Xnocompile\fP\h'|\n(41u'
.mk ##
.nr 31 \n(##
.sp |\n(##u-1v
.nr 37 \n(41u
.in +\n(37u
.f+
.in -\n(37u
.mk 32
.if \n(32>\n(31 .nr 31 \n(32
.sp |\n(31u
.fc
.nr T. 1
.T# 1
.35
.rm a+
.rm b+
.rm c+
.rm d+
.rm e+
.rm f+
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-26
.LP
.SH "Example"
.nf
\f3
.fl
\fP\f3wsimport \-p stockquote http://stockquote.xyz/quote?wsdl\fP
\fP\f3wsimport \-p stockquote http://stockquote.example.com/quote?wsdl\fP
.fl
.fi
.LP
This will generate the Java artifacts and compile them by importing the \f2http://stockquote.xyz/quote?wsdl\fP.
This will generate the Java artifacts and compile them by importing the \f2http://stockquote.example.com/quote?wsdl\fP.
.br

124
jdk/src/solaris/doc/sun/man/man1/xjc.1
View File

@ -1,4 +1,4 @@
." Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
." Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
."
." This code is free software; you can redistribute it and/or modify it
@ -19,19 +19,18 @@
." or visit www.oracle.com if you need additional information or have any
." questions.
."
.TH xjc 1 "02 Jun 2010"
.TH xjc 1 "10 May 2011"
.LP
.ad c
.SH "Name"
xjc \- Java(TM) Architecture for XML Binding
.br
Binding Compiler
Binding Compiler
.LP
.LP
\f3Specification Version:\fP 2.1
.br
\f3Reference Implementation (RI) Version:\fP 2.1.3 .ad l
\f3Reference Implementation (RI) Version:\fP 2.1.3
.LP
.SH "Launching xjc"
.LP
@ -41,84 +40,87 @@ The binding compiler can be launched using the appropriate \f2xjc\fP shell scrip
\f2using the XJC Ant task\fP @
.fi
https://jaxb.dev.java.net/nonav/2.1.3/docs/xjcTask.html.
.LP
.RS 3
.LP
.LP
\f2% xjc \-help\fP
.LP
.RE
\f3Output\fP
.LP
.RS 3
.SS
Output
.LP
.nf
\f3
.fl
Usage: xjc [\-options ...] <schema_file/URL/dir> ... [\-b <bindinfo>] ...
Usage: xjc [\-options ...] <schema file/URL/dir/jar> ... [\-b <bindinfo>] ...
.fl
If dir is specified, all schema files in it will be compiled.
.fl
If jar is specified, /META\-INF/sun\-jaxb.episode binding file will be compiled.
.fl
Options:
.fl
\-nv : do not perform strict validation of the input schema(s)
\-nv : do not perform strict validation of the input schema(s)
.fl
\-extension : allow vendor extensions \- do not strictly follow the
\-extension : allow vendor extensions \- do not strictly follow the Compatibility Rules and App E.2 from the JAXB Spec
.fl
Compatibility Rules and App E.2 from the JAXB Spec
\-b <file/dir> : specify external bindings files (each <file> must have its own \-b); if a directory is given, **/*.xjb is searched
.fl
\-b <file/dir> : specify external bindings files (each <file> must have its own \-b)
\-d <dir> : generated files will go into this directory
.fl
If a directory is given, **/*.xjb is searched
\-p <pkg> : specifies the target package
.fl
\-d <dir> : generated files will go into this directory
\-httpproxy <proxy> : set HTTP/HTTPS proxy; format is [user[:password]@]proxyHost:proxyPort
.fl
\-p <pkg> : specifies the target package
\-httpproxyfile <f> : works like \-httpproxy but takes the argument in a file to protect password
.fl
\-httpproxy <proxy> : set HTTP/HTTPS proxy. Format is [user[:password]@]proxyHost:proxyPort
\-classpath <arg> : specify where to find user class files
.fl
\-httpproxyfile <file>: set the proxy string (same format as above).
\-catalog <file> : specify catalog files to resolve external entity references; support TR9401, XCatalog, and OASIS XML Catalog format
.fl
\-classpath <arg> : specify where to find user class files
\-readOnly : generated files will be in read\-only mode
.fl
\-catalog <file> : specify catalog files to resolve external entity references
\-npa : suppress generation of package level annotations (**/package\-info.java)
.fl
support TR9401, XCatalog, and OASIS XML Catalog format.
\-no\-header : suppress generation of a file header with timestamp
.fl
\-readOnly : generated files will be in read\-only mode
\-target 2.0 : behave like XJC 2.0 and generate code that doesnt use any 2.1 features
.fl
\-npa : suppress generation of package level annotations (**/package\-info.java)
\-xmlschema : treat input as W3C XML Schema (default)
.fl
\-no\-header : suppress generation of a file header with timestamp
\-relaxng : treat input as RELAX NG (experimental,unsupported)
.fl
\-target 2.0 : behave like XJC 2.0 and generate code that doesnt use any 2.1 features.
\-relaxng\-compact : treat input as RELAX NG compact syntax (experimental,unsupported)
.fl
\-xmlschema : treat input as W3C XML Schema (default)
\-dtd : treat input as XML DTD (experimental,unsupported)
.fl
\-relaxng : treat input as RELAX NG (experimental,unsupported)
\-wsdl : treat input as WSDL and compile schemas inside it (experimental,unsupported)
.fl
\-relaxng\-compact : treat input as RELAX NG compact syntax (experimental,unsupported)
\-verbose : be extra verbose
.fl
\-dtd : treat input as XML DTD (experimental,unsupported)
\-quiet : suppress compiler output
.fl
\-wsdl : treat input as WSDL and compile schemas inside it (experimental,unsupported)
\-help : display this help message
.fl
\-verbose : be extra verbose
\-version : display version information
.fl
\-quiet : suppress compiler output
.fl
\-help : display this help message
.fl
\-version : display version information
Extensions:
.fl
\-Xlocator : enable source location support for generated code
.fl
\-Xsync\-methods : generate accessor methods with the 'synchronized' keyword
.fl
\-mark\-generated : mark the generated code as @javax.annotation.Generated
.fl
\-episode <FILE> : generate the episode file for separate compilation
.fl
\fP
.fi
.RE
.LP
.SH "OPTIONS"
.LP
.LP
.RS 3
.TP 3
@ -129,15 +131,9 @@ By default, the XJC binding compiler performs strict validation of the source sc
By default, the XJC binding compiler strictly enforces the rules outlined in the Compatibility chapter of the JAXB Specification. Appendix E.2 defines a set of W3C XML Schema features that are not completely supported by JAXB v1.0. In some cases, you may be allowed to use them in the "\-extension" mode enabled by this switch. In the default (strict) mode, you are also limited to using only the binding customizations defined in the specification. By using the "\-extension" switch, you will be allowed to use the JAXB Vendor Extensions
.TP 3
\-b <file>
Specify one or more external binding files to process. (Each binding file must have its own \f2"\-b"\fP switch.) The syntax of the external binding files is extremely flexible. You may have a single binding file that contains customizations for multiple schemas or you can break the customizations into multiple bindings files:
.RS 3
.LP
\f2xjc schema1.xsd schema2.xsd schema3.xsd \-b bindings123.xjb\fP
Specify one or more external binding files to process. (Each binding file must have its own \f2"\-b"\fP switch.) The syntax of the external binding files is extremely flexible. You may have a single binding file that contains customizations for multiple schemas or you can break the customizations into multiple bindings files: \f2xjc schema1.xsd schema2.xsd schema3.xsd \-b bindings123.xjb\fP
.br
\f2xjc schema1.xsd schema2.xsd schema3.xsd \-b bindings1.xjb \-b bindings2.xjb \-b bindings3.xjb\fP
.RE
In addition, the ordering of the schema files and binding files on the command line does not matter.
\f2xjc schema1.xsd schema2.xsd schema3.xsd \-b bindings1.xjb \-b bindings2.xjb \-b bindings3.xjb\fP In addition, the ordering of the schema files and binding files on the command line does not matter.
.TP 3
\-d <dir>
By default, the XJC binding compiler will generate the Java content classes in the current directory. Use this option to specify an alternate output directory. The output directory must already exist, the XJC binding compiler will not create it for you.
@ -199,11 +195,29 @@ Display the compiler version information.
<schema file/URL/dir>
Specify one or more schema files to compile. If you specify a directory, then xjc will scan it for all schema files and compile them.
.RE
.LP
.SS
Summary of Deprecated and Removed Command Line Options
Non\-Standard Command Line Options
.LP
.RS 3
.TP 3
\-Xlocator
Causes the generated code to expose SAX Locator information about the source XML in the Java bean instances after unmarshalling.
.TP 3
\-Xsync\-methods
Causes all of the generated method signatures to include the \f2synchronized\fP keyword.
.TP 3
\-mark\-generated
Mark the generated code with the annotation \f2@javax.annotation.Generated\fP.
.TP 3
\-episode <file>
Generate the specified episode file for separate compilation.
.RE
.LP
.SS
Deprecated and Removed Command Line Options
.LP
.RS 3
.TP 3
@ -215,13 +229,9 @@ Since the JAXB 2.0 specification has defined a portable runtime, it is no longer
.TP 3
\-source
The \-source compatibility switch was introduced in the first JAXB 2.0 Early Access release. We have decided to remove this switch from future releases of JAXB 2.0. If you need to generate 1.0.x code, please use an installation of the 1.0.x codebase.
.TP 3
\-Xlocator & \-Xsync\-methods
These switches have been disabled for now. We plan on releasing this functionality as a separate download in the future.
.RE
.LP
.RE
.SS
Compiler Restrictions
.LP
@ -280,7 +290,7 @@ o
.na
\f2Java Architecture for XML Binding (JAXB)\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/guides/xml/jaxb/index.html
http://download.oracle.com/javase/7/docs/technotes/guides/xml/jaxb/index.html
.RE
.LP