Mercurial > hg > openjdk > aarch64-port > jdk
changeset 11030:8da88b4019f6
8131105: Header Template for nroff man pages *.1 files contains errors
Reviewed-by: katleman
line wrap: on
line diff
--- a/src/bsd/doc/man/appletviewer.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/appletviewer.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,89 +1,89 @@ -'\" t -.\" Copyright (c) 1995, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Basic Tools -.\" Title: appletviewer.1 -.\" -.if n .pl 99999 -.TH appletviewer 1 "21 November 2013" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -appletviewer \- Runs applets outside of a web browser\&. -.SH SYNOPSIS -.sp -.nf - -\fBappletviewer\fR [\fIoptions\fR] \fIurl\fR\&.\&.\&. -.fi -.sp -.TP -\fIoptions\fR -The command-line options separated by spaces\&. See Options\&. -.TP -\fIurl\fR -The location of the documents or resources to be displayed\&. You can specify multiple URLs separated by spaces\&. -.SH DESCRIPTION -The \f3appletviewer\fR command connects to the documents or resources designated by \fIurls\fR and displays each applet referenced by the documents in its own window\&. If the documents referred to by urls do not reference any applets with the \f3OBJECT\fR, \f3EMBED\fR, or \f3APPLET\fR tag, then the \f3appletviewer\fR command does nothing\&. For details about the HTML tags that the \f3appletviewer\fR command supports, see AppletViewer Tags at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/appletviewertags\&.html -.PP -The \f3appletviewer\fR command 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\&. -.PP -\fINote:\fR The \f3appletviewer\fR command is intended for development purposes only\&. For more information, see About Sample/Test Applications and Code at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/aboutCodeSamples\&.html -.SH OPTIONS -.TP --debug -.br -Starts the Applet Viewer in the Java debugger with the \f3jdb\fR command to debug the applets in the document\&. -.TP --encoding \fIencoding-name\fR -.br -Specifies the input HTML file encoding name\&. -.TP --J\fIjavaoption\fR -.br -Passes the string \f3javaoption\fR as a single argument to the Java interpreter, which runs the Applet Viewer\&. The argument should not contain spaces\&. Multiple argument words must all begin with the prefix \f3-J\fR\&. This is useful for adjusting the compiler\&'s execution environment or memory usage\&. -.PP -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1995, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: appletviewer.1 +.\" +.if n .pl 99999 +.TH appletviewer 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +appletviewer \- Runs applets outside of a web browser\&. +.SH SYNOPSIS +.sp +.nf + +\fBappletviewer\fR [\fIoptions\fR] \fIurl\fR\&.\&.\&. +.fi +.sp +.TP +\fIoptions\fR +The command-line options separated by spaces\&. See Options\&. +.TP +\fIurl\fR +The location of the documents or resources to be displayed\&. You can specify multiple URLs separated by spaces\&. +.SH DESCRIPTION +The \f3appletviewer\fR command connects to the documents or resources designated by \fIurls\fR and displays each applet referenced by the documents in its own window\&. If the documents referred to by urls do not reference any applets with the \f3OBJECT\fR, \f3EMBED\fR, or \f3APPLET\fR tag, then the \f3appletviewer\fR command does nothing\&. For details about the HTML tags that the \f3appletviewer\fR command supports, see AppletViewer Tags at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/appletviewertags\&.html +.PP +The \f3appletviewer\fR command 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\&. +.PP +\fINote:\fR The \f3appletviewer\fR command is intended for development purposes only\&. For more information, see About Sample/Test Applications and Code at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/aboutCodeSamples\&.html +.SH OPTIONS +.TP +-debug +.br +Starts the Applet Viewer in the Java debugger with the \f3jdb\fR command to debug the applets in the document\&. +.TP +-encoding \fIencoding-name\fR +.br +Specifies the input HTML file encoding name\&. +.TP +-J\fIjavaoption\fR +.br +Passes the string \f3javaoption\fR as a single argument to the Java interpreter, which runs the Applet Viewer\&. The argument should not contain spaces\&. Multiple argument words must all begin with the prefix \f3-J\fR\&. This is useful for adjusting the compiler\&'s execution environment or memory usage\&. +.PP +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/extcheck.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/extcheck.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,90 +1,90 @@ -'\" t -.\" Copyright (c) 1998, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Basic Tools -.\" Title: extcheck.1 -.\" -.if n .pl 99999 -.TH extcheck 1 "21 November 2013" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -extcheck \- Detects version conflicts between a target Java Archive (JAR) file and currently installed extension JAR files\&. -.SH SYNOPSIS -.sp -.nf - -\fBextcheck\fR [\fIoptions\fR] \fItargetfile\&.jar\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fItargetfile\&.jar\fR -The target JAR file against which the currently installed extension JAR files are compared to detect version conflicts\&. -.SH DESCRIPTION -The \f3extcheck\fR command checks a specified JAR file for title and version conflicts with any extensions installed in the Java SE SDK\&. Before installing an extension, you can use this utility to see whether the same or a more recent version of the extension is already installed\&. -.PP -The \f3extcheck\fR command compares the Specification-title and Specification-version headers in the manifest of the \f3targetfile\&.jar\fR file against the corresponding headers in all JAR files currently installed in the extension directory\&. By default, the extension directory is \f3jre/lib/ext\fR on Oracle Solaris and \f3\ejre\elib\eext\fR on Windows\&. The \f3extcheck\fR command compares version numbers in the same way as the \f3java\&.lang\&.Package\&.isCompatibleWith\fR method\&. -.PP -If no conflict is detected, then the return code is 0\&. -.PP -If the manifest of any JAR file in the extensions directory has the same \f3Specification-title\fR and the same or a newer \f3Specification-version\fR number, then a non-zero error code is returned\&. A non-zero error code is also returned when \f3targetfile\&.jar\fR does not have the \f3Specification-title\fR or \f3Specification-version\fR attributes in its manifest file\&. -.SH OPTIONS -.TP --verbose -.br -Lists JAR files in the extension directory as they are checked\&. Additionally, manifest attributes of the target JAR file and any conflicting JAR files are also reported\&. -.TP --J\fIoption\fR -.br -Passes \fIoption\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -jar(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1998, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: extcheck.1 +.\" +.if n .pl 99999 +.TH extcheck 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +extcheck \- Detects version conflicts between a target Java Archive (JAR) file and currently installed extension JAR files\&. +.SH SYNOPSIS +.sp +.nf + +\fBextcheck\fR [\fIoptions\fR] \fItargetfile\&.jar\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fItargetfile\&.jar\fR +The target JAR file against which the currently installed extension JAR files are compared to detect version conflicts\&. +.SH DESCRIPTION +The \f3extcheck\fR command checks a specified JAR file for title and version conflicts with any extensions installed in the Java SE SDK\&. Before installing an extension, you can use this utility to see whether the same or a more recent version of the extension is already installed\&. +.PP +The \f3extcheck\fR command compares the Specification-title and Specification-version headers in the manifest of the \f3targetfile\&.jar\fR file against the corresponding headers in all JAR files currently installed in the extension directory\&. By default, the extension directory is \f3jre/lib/ext\fR on Oracle Solaris and \f3\ejre\elib\eext\fR on Windows\&. The \f3extcheck\fR command compares version numbers in the same way as the \f3java\&.lang\&.Package\&.isCompatibleWith\fR method\&. +.PP +If no conflict is detected, then the return code is 0\&. +.PP +If the manifest of any JAR file in the extensions directory has the same \f3Specification-title\fR and the same or a newer \f3Specification-version\fR number, then a non-zero error code is returned\&. A non-zero error code is also returned when \f3targetfile\&.jar\fR does not have the \f3Specification-title\fR or \f3Specification-version\fR attributes in its manifest file\&. +.SH OPTIONS +.TP +-verbose +.br +Lists JAR files in the extension directory as they are checked\&. Additionally, manifest attributes of the target JAR file and any conflicting JAR files are also reported\&. +.TP +-J\fIoption\fR +.br +Passes \fIoption\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jar(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/idlj.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/idlj.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,567 +1,567 @@ -'\" t -.\" Copyright (c) 2001, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java IDL and RMI-IIOP Tools -.\" Title: idlj.1 -.\" -.if n .pl 99999 -.TH idlj 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -idlj \- Generates Java bindings for a specified Interface Definition Language (IDL) file\&. -.SH SYNOPSIS -.sp -.nf - -\fBidlj\fR [ \fIoptions\fR ] \fIidlfile\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. Options can appear in any order, but must precede the \f3idlfile\fR\&. -.TP -\fIidlfile\fR -The name of a file that contains Interface Definition Language (IDL) definitions\&. -.SH DESCRIPTION -The IDL-to-Java Compiler generates the Java bindings for a specified IDL file\&. For binding details, see Java IDL: IDL to Java Language Mapping at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/mapping/jidlMapping\&.html -.PP -Some earlier releases of the IDL-to-Java compiler were named \f3idltojava\fR\&. -.SS EMIT\ CLIENT\ AND\ SERVER\ BINDINGS -The following \f3idlj\fR command generates an IDL file named \f3My\&.idl\fR with client-side bindings\&. -.sp -.nf -\f3idlj My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -The previous syntax is equivalent to the following: -.sp -.nf -\f3idlj \-fclient My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -The next example generates the server-side bindings, and includes the client-side bindings plus the skeleton, all of which are POA (Inheritance Model)\&. -.sp -.nf -\f3idlg \-fserver My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -If you want to generate both client and server-side bindings, then use one of the following (equivalent) commands: -.sp -.nf -\f3idlj \-fclient \-fserver My\&.idl\fP -.fi -.nf -\f3idlj \-fall My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -There are two possible server-side models: the Portal Servant Inheritance Model and the Tie Model\&. See Tie Delegation Model\&. -.PP -\f3Portable Servant Inheritance Model\fR\&. The default server-side model is the Portable Servant Inheritance Model\&. Given an interface \f3My\fR defined in \f3My\&.idl\fR, the file \f3MyPOA\&.java\fR is generated\&. You must provide the implementation for the \f3My\fR interface, and the \f3My\fR interface must inherit from the \f3MyPOA\fR class\&. \f3MyPOA\&.java\fR is a stream-based skeleton that extends the \f3org\&.omg\&.PortableServer\&.Servant\fR class at http://docs\&.oracle\&.com/javase/8/docs/api/org/omg/PortableServer/Servant\&.html The \f3My\fR interface implements the \f3callHandler\fR interface and the operations interface associated with the IDL interface the skeleton implements\&.The \f3PortableServer\fR module for the Portable Object Adapter (POA) defines the native \f3Servant\fR type\&. See Portable Object Adapter (POA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/POA\&.html In the Java programming language, the \f3Servant\fR type is mapped to the Java \f3org\&.omg\&.PortableServer\&.Servant\fR class\&. It serves as the base class for all POA servant implementations and provides a number of methods that can be called by the application programmer, and methods that are called by the POA and that can be overridden by the user to control aspects of servant behavior\&.Another option for the Inheritance Model is to use the \f3-oldImplBase\fR flag to generate server-side bindings that are compatible with releases of the Java programming language before Java SE 1\&.4\&. The -\f3oldImplBase\fR flag is nonstandard, and these APIs are deprecated\&. You would use this flag only for compatibility with existing servers written in Java SE 1\&.3\&. In that case, you would need to modify an existing make file to add the \f3-oldImplBase\fR flag to the \f3idlj\fR compiler\&. Otherwise POA-based server-side mappings are generated\&. To generate server-side bindings that are backward compatible, do the following: -.sp -.nf -\f3idlj \-fclient \-fserver \-oldImplBase My\&.idl\fP -.fi -.nf -\f3idlj \-fall \-oldImplBase My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -Given an interface \f3My\fR defined in \f3My\&.idl\fR, the file \f3_MyImplBase\&.java\fR is generated\&. You must provide the implementation for the \f3My\fR interface, and the \f3My\fR interface must inherit from the \f3_MyImplBase\fR class\&. -.PP -\f3Tie Delegation Model\fR\&. 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: -.sp -.nf -\f3idlj \-fall My\&.idl\fP -.fi -.nf -\f3idlj \-fallTIE My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -For the \f3My\fR interface, the second command generates \f3MyPOATie\&.java\fR\&. The constructor to the \f3MyPOATie\fR class takes a delegate\&. In this example, using the default POA model, the constructor also needs a POA\&. You must provide the implementation for the delegate, but it does not have to inherit from any other class, only the interface \f3MyOperations\fR\&. To use it with the ORB, you must wrap your implementation within the \f3MyPOATie\fR class, for example: -.sp -.nf -\f3ORB orb = ORB\&.init(args, System\&.getProperties());\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3// Get reference to rootpoa & activate the POAManager\fP -.fi -.nf -\f3POA rootpoa = (POA)orb\&.resolve_initial_references("RootPOA");\fP -.fi -.nf -\f3rootpoa\&.the_POAManager()\&.activate();\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3// create servant and register it with the ORB\fP -.fi -.nf -\f3MyServant myDelegate = new MyServant();\fP -.fi -.nf -\f3myDelegate\&.setORB(orb); \fP -.fi -.nf -\f3\fR -.fi -.nf -\f3// create a tie, with servant being the delegate\&.\fP -.fi -.nf -\f3MyPOATie tie = new MyPOATie(myDelegate, rootpoa);\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3// obtain the objectRef for the tie\fP -.fi -.nf -\f3My ref = tie\&._this(orb);\fP -.fi -.nf -\f3\fR -.fi -.sp -You might want to use the Tie model instead of the typical Inheritance model when 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, then that slot is used up\&. With 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 a method is called\&. -.PP -For server-side generation, Tie model bindings that are compatible with versions of the IDL to Java language mapping in versions earlier than Java SE 1\&.4\&. -.sp -.nf -\f3idlj \-oldImplBase \-fall My\&.idl\fP -.fi -.nf -\f3idlj \-oldImplBase \-fallTIE My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -For the \f3My\fR interface, the this generates \f3My_Tie\&.java\fR\&. The constructor to the \f3My_Tie\fR class takes an \f3impl\fR object\&. You must provide the implementation for \f3impl\fR, but it does not have to inherit from any other class, only the interface \f3HelloOperations\fR\&. But to use it with the ORB, you must wrap your implementation within \f3My_Tie\fR, for example: -.sp -.nf -\f3ORB orb = ORB\&.init(args, System\&.getProperties());\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3// create servant and register it with the ORB\fP -.fi -.nf -\f3MyServant myDelegate = new MyServant();\fP -.fi -.nf -\f3myDelegate\&.setORB(orb); \fP -.fi -.nf -\f3\fR -.fi -.nf -\f3// create a tie, with servant being the delegate\&.\fP -.fi -.nf -\f3MyPOATie tie = new MyPOATie(myDelegate);\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3// obtain the objectRef for the tie\fP -.fi -.nf -\f3My ref = tie\&._this(orb);\fP -.fi -.nf -\f3\fR -.fi -.sp -.SS SPECIFY\ ALTERNATE\ LOCATIONS\ FOR\ EMITTED\ FILES -If you want to direct the emitted files to a directory other than the current directory, then call the compiler this way: \f3i\fR\f3dlj -td /altdir My\&.idl\fR\&. -.PP -For the \f3My\fR interface, the bindings are emitted to \f3/altdir/My\&.java\fR, etc\&., instead of \f3\&./My\&.java\fR\&. -.SS SPECIFY\ ALTERNATE\ LOCATIONS\ FOR\ INCLUDE\ FILES -If the \f3My\&.idl\fR file includes another \f3idl\fR file, \f3MyOther\&.idl\fR, then the compiler assumes that the \f3MyOther\&.idl\fR file resides in the local directory\&. If it resides in \f3/includes\fR, for example, then you call the compiler with the following command: -.sp -.nf -\f3idlj \-i /includes My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -If \f3My\&.idl\fR also included \f3Another\&.idl\fR that resided in \f3/moreIncludes\fR, for example, then you call the compiler with the following command: -.sp -.nf -\f3idlj \-i /includes \-i /moreIncludes My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -Because this form of \f3include\fR can become long, another way to indicate 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 idl\&.config in a directory that is listed in your \f3CLASSPATH\fR variable\&. Inside of \f3idl\&.config\fR, provide a line with the following form: -.sp -.nf -\f3includes=/includes;/moreIncludes\fP -.fi -.nf -\f3\fR -.fi -.sp -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, and so on\&. -.SS EMIT\ BINDINGS\ FOR\ INCLUDE\ FILES -By default, only those interfaces, structures, and so on, that are defined in the \f3idl\fR 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 \f3idl\fR files: -.sp -.nf -\f3My\&.idl file:\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3#include <MyOther\&.idl>\fP -.fi -.nf -\f3interface My\fP -.fi -.nf -\f3{\fP -.fi -.nf -\f3};\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3MyOther\&.idl file:\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3interface MyOther\fP -.fi -.nf -\f3{\fP -.fi -.nf -\f3};\fP -.fi -.nf -\f3\fR -.fi -.sp -There is a caveat to the default rule\&. Any \f3#include\fR statements that appear at the global scope are treated as described\&. These \f3#include\fR statements can be thought of as import statements\&. The \f3#include\fR statements that appear within an enclosed scope are treated as true \f3#include\fR statements, which means that the code within the included file is treated as though it appeared in the original file and, therefore, Java bindings are emitted for it\&. Here is an example: -.sp -.nf -\f3My\&.idl file:\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3#include <MyOther\&.idl>\fP -.fi -.nf -\f3interface My\fP -.fi -.nf -\f3{\fP -.fi -.nf -\f3 #include <Embedded\&.idl>\fP -.fi -.nf -\f3};\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3MyOther\&.idl file:\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3interface MyOther\fP -.fi -.nf -\f3{\fP -.fi -.nf -\f3};\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3Embedded\&.idl\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3enum E {one, two, three};\fP -.fi -.nf -\f3\fR -.fi -.sp -Run\f3idlj My\&.idl\fRto generate the following list of Java files\&. Notice that \f3MyOther\&.java\fR is not generated because it is defined in an import-like \f3#include\fR\&. But \f3E\&.java\fR was generated because it was defined in a true \f3#include\fR\&. Notice that because the \f3Embedded\&.idl\fR file is included within the scope of the interface \f3My\fR, it appears within the scope of \f3My\fR (in \f3MyPackage\fR)\&. If the \f3-emitAll\fR flag had been used, then all types in all included files would have been emitted\&. -.sp -.nf -\f3\&./MyHolder\&.java\fP -.fi -.nf -\f3\&./MyHelper\&.java\fP -.fi -.nf -\f3\&./_MyStub\&.java\fP -.fi -.nf -\f3\&./MyPackage\fP -.fi -.nf -\f3\&./MyPackage/EHolder\&.java\fP -.fi -.nf -\f3\&./MyPackage/EHelper\&.java\fP -.fi -.nf -\f3\&./MyPackage/E\&.java\fP -.fi -.nf -\f3\&./My\&.java\fP -.fi -.nf -\f3\fR -.fi -.sp -.SS INSERT\ PACKAGE\ PREFIXES -Suppose that you work for a company named ABC that has constructed the following IDL file: -.sp -.nf -\f3Widgets\&.idl file:\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3module Widgets\fP -.fi -.nf -\f3{\fP -.fi -.nf -\f3 interface W1 {\&.\&.\&.};\fP -.fi -.nf -\f3 interface W2 {\&.\&.\&.};\fP -.fi -.nf -\f3};\fP -.fi -.nf -\f3\fR -.fi -.sp -If you run this file through the IDL-to-Java compiler, then the Java bindings for W1 and W2 are placed within the \f3Widgets\fR package\&. There is an industry convention that states that a company\&'s packages should reside within a package named \f3com\&.<company name>\fR\&. To follow this convention, the package name should be \f3com\&.abc\&.Widgets\fR\&. To place this package prefix onto the Widgets module, execute the following: -.sp -.nf -\f3idlj \-pkgPrefix Widgets com\&.abc Widgets\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -If you have an IDL file that includes Widgets\&.idl, then the \f3-pkgPrefix\fR flag must appear in that command also\&. If it does not, then your IDL file will be looking for a \f3Widgets\fR package rather than a \f3com\&.abc\&.Widgets\fR package\&. -.PP -If you have a number of these packages that require prefixes, then it might be easier to place them into the idl\&.config file described previously\&. Each package prefix line should be of the form: \f3PkgPrefix\&.<type>=<prefix>\fR\&. The line for the previous example would be \f3PkgPrefix\&.Widgets=com\&.abc\fR\&. This option does not affect the Repository ID\&. -.SS DEFINE\ SYMBOLS\ BEFORE\ COMPILATION -You might 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 \f3idlj -d MYDEF My\&.idl\fRis equivalent to putting the line \f3#define MYDEF\fR inside My\&.idl\&. -.SS PRESERVE\ PREEXISTING\ BINDINGS -If the Java binding files already exist, then the \f3-keep\fR flag keeps the compiler from overwriting them\&. The default is to generate all files without considering that they already exist\&. If you have customized those files (which you should not do unless you are very comfortable with their contents), then the \f3-keep\fR option is very useful\&. The command \f3idlj -keep My\&.idl\fR emits all client-side bindings that do not already exist\&. -.SS VIEW\ COMPILATION\ PROGRESS -The IDL-to-Java compiler generates status messages as it progresses through its phases of execution\&. Use the \f3-v\fR option to activate the verbose mode: \f3idlj -v My\&.idl\fR\&. -.PP -By default the compiler does not operate in verbose mode -.SS DISPLAY\ VERSION\ INFORMATION -To display the build version of the IDL-to-Java compiler, specify the \f3-version\fR option on the command-line: \f3idlj -version\fR\&. -.PP -Version information also appears within the bindings generated by the compiler\&. Any additional options appearing on the command-line are ignored\&. -.SH OPTIONS -.TP --d \fIsymbol\fR -.br -This is equivalent to the following line in an IDL file: -.sp -.nf -\f3#define \fIsymbol\fR\fP -.fi -.nf -\f3\fR -.fi -.sp - -.TP --demitAll -.br -Emit all types, including those found in \f3#include\fR files\&. -.TP --fside -.br -Defines what bindings to emit\&. The \f3side\fR parameter can be \f3client\fR, \f3server\fR, \f3serverTIE\fR, \f3all\fR, or \f3allTIE\fR\&. The \f3-fserverTIE\fR and \f3-fallTIE\fR options cause delegate model skeletons to be emitted\&. Defaults to \f3-fclient\fR when the flag is not specified\&. -.TP --i \fIinclude-path\fR -.br -By default, the current directory is scanned for included files\&. This option adds another directory\&. -.TP --i \fIkeep\fR -.br -If a file to be generated already exists, then do not overwrite it\&. By default it is overwritten\&. -.TP --noWarn -.br -Suppress warning messages\&. -.TP --oldImplBase -.br -Generates skeletons compatible with pre-1\&.4 JDK ORBs\&. By default, the POA Inheritance Model server-side bindings are generated\&. This option provides backward-compatibility with earlier releases of the Java programming language by generating server-side bindings that are \f3ImplBase\fR Inheritance Model classes\&. -.TP --pkgPrefix \fItype\fR\fIprefix\fR -.br -Wherever \f3type\fR is encountered at file scope, prefix the generated Java package name with \f3prefix\fR for all files generated for that type\&. The type is the simple name of either a top-level module, or an IDL type defined outside of any module\&. -.TP --pkgTranslate \fItype\fR\fIpackage\fR -.br -Whenever the module name type is encountered in an identifier, replace it in the identifier with package for all files in the generated Java package\&. Note that \f3pkgPrefix\fR changes are made first\&. The type value 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\&. - -If more than one translation matches an identifier, then the longest match is chosen as shown in the following example: - -\fICommand\fR: -.sp -.nf -\f3pkgTranslate type pkg \-pkgTranslate type2\&.baz pkg2\&.fizz\fP -.fi -.nf -\f3\fR -.fi -.sp - - -\fIResulting Translation\fR: -.sp -.nf -\f3type => pkg\fP -.fi -.nf -\f3type\&.ext => pkg\&.ext\fP -.fi -.nf -\f3type\&.baz => pkg2\&.fizz\fP -.fi -.nf -\f3type2\&.baz\&.pkg => pkg2\&.fizz\&.pkg\fP -.fi -.nf -\f3\fR -.fi -.sp - - -The following package names \f3org\fR, \f3org\fR\&.o\f3mg\fR, or any subpackages of \f3org\&.omg\fR cannot be translated\&. Any attempt to translate these packages results in uncompilable code, and the use of these packages as the first argument after \f3-pkgTranslate\fR is treated as an error\&. -.TP --skeletonName \fIxxx%yyy\fR -.br -Use \f3xxx%yyy\fR as the pattern for naming the skeleton\&. The defaults are: \f3%POA\fR for the \f3POA\fR base class (\f3-fserver\fR or \f3-fall\fR), and \f3_%ImplBase\fR for the \f3oldImplBase\fR class (-\f3oldImplBase\fR) and (\f3-fserver\fR or \f3-fall\fR))\&. -.TP --td \fIdir\fR -.br -Use \fIdir\fR for the output directory instead of the current directory\&. -.TP --tieName \fIxxx%yyy\fR -.br -Use \f3xxx%yyy\fR according to the pattern\&. The defaults are: \f3%POA\fR for the \f3POA\fR base class (\f3-fserverTie or -fallTie\fR), and \f3_%Tie\fR for the \f3oldImplBase\fR tie class (-\f3oldImplBase\fR) and (\f3-fserverTie\fR or \f3-fallTie\fR)) -.TP --nowarn, -verbose -.br -Displays release information and terminates\&. -.TP --version -.br -Displays release information and terminates\&. -.SH RESTRICTIONS -Escaped identifiers in the global scope cannot have the same spelling as IDL primitive types, \f3Object\fR, or \f3ValueBase\fR\&. This is because the symbol table is preloaded with these identifiers\&. Allowing them to be redefined would overwrite their original definitions\&. Possible permanent restriction\&. -.PP -The \f3fixed\fR IDL type is not supported\&. -.SH KNOWN\ PROBLEMS -No import is generated for global identifiers\&. If you call an unexported local \f3impl\fR object, then you do get an exception, but it seems to be due to a \f3NullPointerException\fR in the \f3ServerDelegate\fR DSI code\&. -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2001, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java IDL and RMI-IIOP Tools +.\" Title: idlj.1 +.\" +.if n .pl 99999 +.TH idlj 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +idlj \- Generates Java bindings for a specified Interface Definition Language (IDL) file\&. +.SH SYNOPSIS +.sp +.nf + +\fBidlj\fR [ \fIoptions\fR ] \fIidlfile\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. Options can appear in any order, but must precede the \f3idlfile\fR\&. +.TP +\fIidlfile\fR +The name of a file that contains Interface Definition Language (IDL) definitions\&. +.SH DESCRIPTION +The IDL-to-Java Compiler generates the Java bindings for a specified IDL file\&. For binding details, see Java IDL: IDL to Java Language Mapping at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/mapping/jidlMapping\&.html +.PP +Some earlier releases of the IDL-to-Java compiler were named \f3idltojava\fR\&. +.SS EMIT\ CLIENT\ AND\ SERVER\ BINDINGS +The following \f3idlj\fR command generates an IDL file named \f3My\&.idl\fR with client-side bindings\&. +.sp +.nf +\f3idlj My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +The previous syntax is equivalent to the following: +.sp +.nf +\f3idlj \-fclient My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +The next example generates the server-side bindings, and includes the client-side bindings plus the skeleton, all of which are POA (Inheritance Model)\&. +.sp +.nf +\f3idlg \-fserver My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +If you want to generate both client and server-side bindings, then use one of the following (equivalent) commands: +.sp +.nf +\f3idlj \-fclient \-fserver My\&.idl\fP +.fi +.nf +\f3idlj \-fall My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +There are two possible server-side models: the Portal Servant Inheritance Model and the Tie Model\&. See Tie Delegation Model\&. +.PP +\f3Portable Servant Inheritance Model\fR\&. The default server-side model is the Portable Servant Inheritance Model\&. Given an interface \f3My\fR defined in \f3My\&.idl\fR, the file \f3MyPOA\&.java\fR is generated\&. You must provide the implementation for the \f3My\fR interface, and the \f3My\fR interface must inherit from the \f3MyPOA\fR class\&. \f3MyPOA\&.java\fR is a stream-based skeleton that extends the \f3org\&.omg\&.PortableServer\&.Servant\fR class at http://docs\&.oracle\&.com/javase/8/docs/api/org/omg/PortableServer/Servant\&.html The \f3My\fR interface implements the \f3callHandler\fR interface and the operations interface associated with the IDL interface the skeleton implements\&.The \f3PortableServer\fR module for the Portable Object Adapter (POA) defines the native \f3Servant\fR type\&. See Portable Object Adapter (POA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/POA\&.html In the Java programming language, the \f3Servant\fR type is mapped to the Java \f3org\&.omg\&.PortableServer\&.Servant\fR class\&. It serves as the base class for all POA servant implementations and provides a number of methods that can be called by the application programmer, and methods that are called by the POA and that can be overridden by the user to control aspects of servant behavior\&.Another option for the Inheritance Model is to use the \f3-oldImplBase\fR flag to generate server-side bindings that are compatible with releases of the Java programming language before Java SE 1\&.4\&. The -\f3oldImplBase\fR flag is nonstandard, and these APIs are deprecated\&. You would use this flag only for compatibility with existing servers written in Java SE 1\&.3\&. In that case, you would need to modify an existing make file to add the \f3-oldImplBase\fR flag to the \f3idlj\fR compiler\&. Otherwise POA-based server-side mappings are generated\&. To generate server-side bindings that are backward compatible, do the following: +.sp +.nf +\f3idlj \-fclient \-fserver \-oldImplBase My\&.idl\fP +.fi +.nf +\f3idlj \-fall \-oldImplBase My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +Given an interface \f3My\fR defined in \f3My\&.idl\fR, the file \f3_MyImplBase\&.java\fR is generated\&. You must provide the implementation for the \f3My\fR interface, and the \f3My\fR interface must inherit from the \f3_MyImplBase\fR class\&. +.PP +\f3Tie Delegation Model\fR\&. 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: +.sp +.nf +\f3idlj \-fall My\&.idl\fP +.fi +.nf +\f3idlj \-fallTIE My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +For the \f3My\fR interface, the second command generates \f3MyPOATie\&.java\fR\&. The constructor to the \f3MyPOATie\fR class takes a delegate\&. In this example, using the default POA model, the constructor also needs a POA\&. You must provide the implementation for the delegate, but it does not have to inherit from any other class, only the interface \f3MyOperations\fR\&. To use it with the ORB, you must wrap your implementation within the \f3MyPOATie\fR class, for example: +.sp +.nf +\f3ORB orb = ORB\&.init(args, System\&.getProperties());\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// Get reference to rootpoa & activate the POAManager\fP +.fi +.nf +\f3POA rootpoa = (POA)orb\&.resolve_initial_references("RootPOA");\fP +.fi +.nf +\f3rootpoa\&.the_POAManager()\&.activate();\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// create servant and register it with the ORB\fP +.fi +.nf +\f3MyServant myDelegate = new MyServant();\fP +.fi +.nf +\f3myDelegate\&.setORB(orb); \fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// create a tie, with servant being the delegate\&.\fP +.fi +.nf +\f3MyPOATie tie = new MyPOATie(myDelegate, rootpoa);\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// obtain the objectRef for the tie\fP +.fi +.nf +\f3My ref = tie\&._this(orb);\fP +.fi +.nf +\f3\fR +.fi +.sp +You might want to use the Tie model instead of the typical Inheritance model when 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, then that slot is used up\&. With 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 a method is called\&. +.PP +For server-side generation, Tie model bindings that are compatible with versions of the IDL to Java language mapping in versions earlier than Java SE 1\&.4\&. +.sp +.nf +\f3idlj \-oldImplBase \-fall My\&.idl\fP +.fi +.nf +\f3idlj \-oldImplBase \-fallTIE My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +For the \f3My\fR interface, the this generates \f3My_Tie\&.java\fR\&. The constructor to the \f3My_Tie\fR class takes an \f3impl\fR object\&. You must provide the implementation for \f3impl\fR, but it does not have to inherit from any other class, only the interface \f3HelloOperations\fR\&. But to use it with the ORB, you must wrap your implementation within \f3My_Tie\fR, for example: +.sp +.nf +\f3ORB orb = ORB\&.init(args, System\&.getProperties());\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// create servant and register it with the ORB\fP +.fi +.nf +\f3MyServant myDelegate = new MyServant();\fP +.fi +.nf +\f3myDelegate\&.setORB(orb); \fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// create a tie, with servant being the delegate\&.\fP +.fi +.nf +\f3MyPOATie tie = new MyPOATie(myDelegate);\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// obtain the objectRef for the tie\fP +.fi +.nf +\f3My ref = tie\&._this(orb);\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS SPECIFY\ ALTERNATE\ LOCATIONS\ FOR\ EMITTED\ FILES +If you want to direct the emitted files to a directory other than the current directory, then call the compiler this way: \f3i\fR\f3dlj -td /altdir My\&.idl\fR\&. +.PP +For the \f3My\fR interface, the bindings are emitted to \f3/altdir/My\&.java\fR, etc\&., instead of \f3\&./My\&.java\fR\&. +.SS SPECIFY\ ALTERNATE\ LOCATIONS\ FOR\ INCLUDE\ FILES +If the \f3My\&.idl\fR file includes another \f3idl\fR file, \f3MyOther\&.idl\fR, then the compiler assumes that the \f3MyOther\&.idl\fR file resides in the local directory\&. If it resides in \f3/includes\fR, for example, then you call the compiler with the following command: +.sp +.nf +\f3idlj \-i /includes My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +If \f3My\&.idl\fR also included \f3Another\&.idl\fR that resided in \f3/moreIncludes\fR, for example, then you call the compiler with the following command: +.sp +.nf +\f3idlj \-i /includes \-i /moreIncludes My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +Because this form of \f3include\fR can become long, another way to indicate 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 idl\&.config in a directory that is listed in your \f3CLASSPATH\fR variable\&. Inside of \f3idl\&.config\fR, provide a line with the following form: +.sp +.nf +\f3includes=/includes;/moreIncludes\fP +.fi +.nf +\f3\fR +.fi +.sp +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, and so on\&. +.SS EMIT\ BINDINGS\ FOR\ INCLUDE\ FILES +By default, only those interfaces, structures, and so on, that are defined in the \f3idl\fR 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 \f3idl\fR files: +.sp +.nf +\f3My\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3#include <MyOther\&.idl>\fP +.fi +.nf +\f3interface My\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3MyOther\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3interface MyOther\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.sp +There is a caveat to the default rule\&. Any \f3#include\fR statements that appear at the global scope are treated as described\&. These \f3#include\fR statements can be thought of as import statements\&. The \f3#include\fR statements that appear within an enclosed scope are treated as true \f3#include\fR statements, which means that the code within the included file is treated as though it appeared in the original file and, therefore, Java bindings are emitted for it\&. Here is an example: +.sp +.nf +\f3My\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3#include <MyOther\&.idl>\fP +.fi +.nf +\f3interface My\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3 #include <Embedded\&.idl>\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3MyOther\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3interface MyOther\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3Embedded\&.idl\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3enum E {one, two, three};\fP +.fi +.nf +\f3\fR +.fi +.sp +Run\f3idlj My\&.idl\fRto generate the following list of Java files\&. Notice that \f3MyOther\&.java\fR is not generated because it is defined in an import-like \f3#include\fR\&. But \f3E\&.java\fR was generated because it was defined in a true \f3#include\fR\&. Notice that because the \f3Embedded\&.idl\fR file is included within the scope of the interface \f3My\fR, it appears within the scope of \f3My\fR (in \f3MyPackage\fR)\&. If the \f3-emitAll\fR flag had been used, then all types in all included files would have been emitted\&. +.sp +.nf +\f3\&./MyHolder\&.java\fP +.fi +.nf +\f3\&./MyHelper\&.java\fP +.fi +.nf +\f3\&./_MyStub\&.java\fP +.fi +.nf +\f3\&./MyPackage\fP +.fi +.nf +\f3\&./MyPackage/EHolder\&.java\fP +.fi +.nf +\f3\&./MyPackage/EHelper\&.java\fP +.fi +.nf +\f3\&./MyPackage/E\&.java\fP +.fi +.nf +\f3\&./My\&.java\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS INSERT\ PACKAGE\ PREFIXES +Suppose that you work for a company named ABC that has constructed the following IDL file: +.sp +.nf +\f3Widgets\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3module Widgets\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3 interface W1 {\&.\&.\&.};\fP +.fi +.nf +\f3 interface W2 {\&.\&.\&.};\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.sp +If you run this file through the IDL-to-Java compiler, then the Java bindings for W1 and W2 are placed within the \f3Widgets\fR package\&. There is an industry convention that states that a company\&'s packages should reside within a package named \f3com\&.<company name>\fR\&. To follow this convention, the package name should be \f3com\&.abc\&.Widgets\fR\&. To place this package prefix onto the Widgets module, execute the following: +.sp +.nf +\f3idlj \-pkgPrefix Widgets com\&.abc Widgets\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +If you have an IDL file that includes Widgets\&.idl, then the \f3-pkgPrefix\fR flag must appear in that command also\&. If it does not, then your IDL file will be looking for a \f3Widgets\fR package rather than a \f3com\&.abc\&.Widgets\fR package\&. +.PP +If you have a number of these packages that require prefixes, then it might be easier to place them into the idl\&.config file described previously\&. Each package prefix line should be of the form: \f3PkgPrefix\&.<type>=<prefix>\fR\&. The line for the previous example would be \f3PkgPrefix\&.Widgets=com\&.abc\fR\&. This option does not affect the Repository ID\&. +.SS DEFINE\ SYMBOLS\ BEFORE\ COMPILATION +You might 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 \f3idlj -d MYDEF My\&.idl\fRis equivalent to putting the line \f3#define MYDEF\fR inside My\&.idl\&. +.SS PRESERVE\ PREEXISTING\ BINDINGS +If the Java binding files already exist, then the \f3-keep\fR flag keeps the compiler from overwriting them\&. The default is to generate all files without considering that they already exist\&. If you have customized those files (which you should not do unless you are very comfortable with their contents), then the \f3-keep\fR option is very useful\&. The command \f3idlj -keep My\&.idl\fR emits all client-side bindings that do not already exist\&. +.SS VIEW\ COMPILATION\ PROGRESS +The IDL-to-Java compiler generates status messages as it progresses through its phases of execution\&. Use the \f3-v\fR option to activate the verbose mode: \f3idlj -v My\&.idl\fR\&. +.PP +By default the compiler does not operate in verbose mode +.SS DISPLAY\ VERSION\ INFORMATION +To display the build version of the IDL-to-Java compiler, specify the \f3-version\fR option on the command-line: \f3idlj -version\fR\&. +.PP +Version information also appears within the bindings generated by the compiler\&. Any additional options appearing on the command-line are ignored\&. +.SH OPTIONS +.TP +-d \fIsymbol\fR +.br +This is equivalent to the following line in an IDL file: +.sp +.nf +\f3#define \fIsymbol\fR\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-demitAll +.br +Emit all types, including those found in \f3#include\fR files\&. +.TP +-fside +.br +Defines what bindings to emit\&. The \f3side\fR parameter can be \f3client\fR, \f3server\fR, \f3serverTIE\fR, \f3all\fR, or \f3allTIE\fR\&. The \f3-fserverTIE\fR and \f3-fallTIE\fR options cause delegate model skeletons to be emitted\&. Defaults to \f3-fclient\fR when the flag is not specified\&. +.TP +-i \fIinclude-path\fR +.br +By default, the current directory is scanned for included files\&. This option adds another directory\&. +.TP +-i \fIkeep\fR +.br +If a file to be generated already exists, then do not overwrite it\&. By default it is overwritten\&. +.TP +-noWarn +.br +Suppress warning messages\&. +.TP +-oldImplBase +.br +Generates skeletons compatible with pre-1\&.4 JDK ORBs\&. By default, the POA Inheritance Model server-side bindings are generated\&. This option provides backward-compatibility with earlier releases of the Java programming language by generating server-side bindings that are \f3ImplBase\fR Inheritance Model classes\&. +.TP +-pkgPrefix \fItype\fR\fIprefix\fR +.br +Wherever \f3type\fR is encountered at file scope, prefix the generated Java package name with \f3prefix\fR for all files generated for that type\&. The type is the simple name of either a top-level module, or an IDL type defined outside of any module\&. +.TP +-pkgTranslate \fItype\fR\fIpackage\fR +.br +Whenever the module name type is encountered in an identifier, replace it in the identifier with package for all files in the generated Java package\&. Note that \f3pkgPrefix\fR changes are made first\&. The type value 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\&. + +If more than one translation matches an identifier, then the longest match is chosen as shown in the following example: + +\fICommand\fR: +.sp +.nf +\f3pkgTranslate type pkg \-pkgTranslate type2\&.baz pkg2\&.fizz\fP +.fi +.nf +\f3\fR +.fi +.sp + + +\fIResulting Translation\fR: +.sp +.nf +\f3type => pkg\fP +.fi +.nf +\f3type\&.ext => pkg\&.ext\fP +.fi +.nf +\f3type\&.baz => pkg2\&.fizz\fP +.fi +.nf +\f3type2\&.baz\&.pkg => pkg2\&.fizz\&.pkg\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The following package names \f3org\fR, \f3org\fR\&.o\f3mg\fR, or any subpackages of \f3org\&.omg\fR cannot be translated\&. Any attempt to translate these packages results in uncompilable code, and the use of these packages as the first argument after \f3-pkgTranslate\fR is treated as an error\&. +.TP +-skeletonName \fIxxx%yyy\fR +.br +Use \f3xxx%yyy\fR as the pattern for naming the skeleton\&. The defaults are: \f3%POA\fR for the \f3POA\fR base class (\f3-fserver\fR or \f3-fall\fR), and \f3_%ImplBase\fR for the \f3oldImplBase\fR class (-\f3oldImplBase\fR) and (\f3-fserver\fR or \f3-fall\fR))\&. +.TP +-td \fIdir\fR +.br +Use \fIdir\fR for the output directory instead of the current directory\&. +.TP +-tieName \fIxxx%yyy\fR +.br +Use \f3xxx%yyy\fR according to the pattern\&. The defaults are: \f3%POA\fR for the \f3POA\fR base class (\f3-fserverTie or -fallTie\fR), and \f3_%Tie\fR for the \f3oldImplBase\fR tie class (-\f3oldImplBase\fR) and (\f3-fserverTie\fR or \f3-fallTie\fR)) +.TP +-nowarn, -verbose +.br +Displays release information and terminates\&. +.TP +-version +.br +Displays release information and terminates\&. +.SH RESTRICTIONS +Escaped identifiers in the global scope cannot have the same spelling as IDL primitive types, \f3Object\fR, or \f3ValueBase\fR\&. This is because the symbol table is preloaded with these identifiers\&. Allowing them to be redefined would overwrite their original definitions\&. Possible permanent restriction\&. +.PP +The \f3fixed\fR IDL type is not supported\&. +.SH KNOWN\ PROBLEMS +No import is generated for global identifiers\&. If you call an unexported local \f3impl\fR object, then you do get an exception, but it seems to be due to a \f3NullPointerException\fR in the \f3ServerDelegate\fR DSI code\&. +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/jar.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/jar.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,484 +1,484 @@ -'\" t -.\" Copyright (c) 1997, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Basic Tools -.\" Title: jar.1 -.\" -.if n .pl 99999 -.TH jar 1 "21 November 2013" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jar \- Manipulates Java Archive (JAR) files\&. -.SH SYNOPSIS -Create JAR file -.sp -.nf - -\fBjar c\fR[\fBefmMnv0\fR] [\fIentrypoint\fR] [\fIjarfile\fR] [\fImanifest\fR] [\fB\-C\fR \fIdir\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] -.fi -.sp - -Update JAR file -.sp -.nf - -\fBjar u\fR[\fBefmMnv0\fR] [\fIentrypoint\fR] [\fIjarfile\fR] [\fImanifest\fR] [\fB\-C\fR \fIdir\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] -.fi -.sp - -Extract JAR file -.sp -.nf - -\fBjar\fR \fBx\fR[\fBvf\fR] [\fIjarfile\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] -.fi -.sp - -List Contents of JAR file -.sp -.nf - -\fBjar\fR \fBt\fR[\fBvf\fR] [\fIjarfile\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] -.fi -.sp - -Add Index to JAR file -.sp -.nf - -\fBjar\fR \fBi\fR \fIjarfile\fR [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] -.fi -.sp -.SH DESCRIPTION -The \f3jar\fR command is a general-purpose archiving and compression tool, based on ZIP and the ZLIB compression format\&. However, the \f3jar\fR command was designed mainly to 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 (such as a browser) in a single HTTP transaction, rather than requiring a new connection for each piece\&. This dramatically improves download times\&. The \f3jar\fR command also compresses files, which further improves download time\&. The \f3jar\fR command also allows individual entries in a file to be signed by the applet author so that their origin can be authenticated\&. A JAR file can be used as a class path entry, whether or not it is compressed\&. -.PP -The syntax for the \f3jar\fR command resembles the syntax for the \f3tar\fR command\&. It has several operation modes, defined by one of the mandatory \fIoperation arguments\fR\&. Other arguments are either \fIoptions\fR that modify the behavior of the operation, or \fIoperands\fR required to perform the operation\&. -.SH OPERATION\ ARGUMENTS -When using the \f3jar\fR command, you have to select an operation to be performed by specifying one of the following operation arguments\&. You can mix them up with other one-letter options on the command line, but usually the operation argument is the first argument specified\&. -.TP -c -Create a new JAR archive\&. -.TP -i -Generate index information for a JAR archive\&. -.TP -t -List the contents of a JAR archive\&. -.TP -u -Update a JAR archive\&. -.TP -x -Extract files from a JAR archive\&. -.SH OPTIONS -Use the following options to customize how the JAR file is created, updated, extracted, or viewed: -.TP -e -Sets the class specified by the \fIentrypoint\fR operand to be the entry point\f3\fR for a standalone Java application bundled into an executable JAR file\&. The use of this option creates or overrides the \f3Main-Class\fR attribute value in the manifest file\&. The \f3e\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. - -For example, the following command creates the \f3Main\&.jar\fR archive with the \f3Main\&.class\fR file where the \f3Main-Clas\fRs attribute value in the manifest is set to \f3Main\fR: -.sp -.nf -\f3jar cfe Main\&.jar Main Main\&.class\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The Java Runtime Environment (JRE) can directly call this application by running the following command: -.sp -.nf -\f3java \-jar Main\&.jar\fP -.fi -.nf -\f3\fP -.fi -.sp - - -If the entry point class name is in a package, then it could use either the dot (\&.) or slash (/) as the delimiter\&. For example, if \f3Main\&.class\fR is in a package called \f3mydir\fR, then the entry point can be specified in one of the following ways: -.sp -.nf -\f3jar \-cfe Main\&.jar mydir/Main mydir/Main\&.class\fP -.fi -.nf -\f3jar \-cfe Main\&.jar mydir\&.Main mydir/Main\&.class\fP -.fi -.nf -\f3\fP -.fi -.sp - - -Note - -Specifying both \f3m\fR and \f3e\fR options together when a particular manifest also contains the \f3Main-Class\fR attribute results in an ambiguous \f3Main-Class\fR specification\&. The ambiguity leads to an error and the \f3jar\fR command creation or update operation is terminated\&. -.TP -f -Sets the file specified by the \fI\fR\fIjarfile\fR operand to be the name of the JAR file that is created (\f3c\fR), updated (\f3u\fR), extracted (\f3x\fR) from, or viewed (\f3t\fR)\&. Omitting the \f3f\fR option and the \fIjarfile\fR operand instructs the \f3jar\fR command to accept the JAR file name from \f3stdin\fR (for \f3x\fR and \f3t\fR) or send the JAR \f3\fRfile to \f3stdout\fR (for \f3c\fR and \f3u\fR)\&. -.TP -m -Includes names and values of attributes from the file specified by the \f3manifest\fR operand in the manifest file of the \f3jar\fR command (located in the archive at \f3META-INF/MANIFEST\&.MF\fR)\&. The \f3jar\fR command adds the attribute\(cqs name and value to the JAR file unless an entry already exists with the same name, in which case the \f3jar\fR command updates the value of the attribute\&. The \f3m\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. - -You can add special-purpose name-value attribute pairs to the manifest that are not contained in the default manifest file\&. For example, you can add attributes that specify vendor information, release information, package sealing, or to make JAR-bundled applications executable\&. For examples of using the \f3m\fR option, see Packaging Programs at http://docs\&.oracle\&.com/javase/tutorial/deployment/jar/index\&.html -.TP -M -Does not create a manifest file entry (for \f3c\fR and \f3u\fR), or delete a manifest file entry when one exists (for \f3u\fR)\&. The \f3M\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. -.TP -n -When creating (\f3c\fR) a JAR file, this option normalizes the archive so that the content is not affected by the packing and unpacking operations of the pack200(1) command\&. Without this normalization, the signature of a signed JAR can become invalid\&. -.TP -v -Generates verbose output to standard output\&. See Examples\&. -.TP -0 -(Zero) Creates (\f3c\fR) or updates (\f3u\fR) the JAR file without using ZIP compression\&. -.TP --C \fIdir\fR -.br -When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, this option temporarily changes the directory while processing files specified by the \fIfile\fR operands\&. Its operation is intended to be similar to the \f3-C\fR option of the UNIX \f3tar\fR utility\&.For example, the following command changes to the \f3classes\fR directory and adds the \f3Bar\&.class\fR file from that directory to \f3my\&.jar\fR: -.sp -.nf -\f3jar uf my\&.jar \-C classes Bar\&.class\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The following command changes to the \f3classes\fR directory and adds to \f3my\&.jar\fR all files within the classes directory (without creating a \f3classes\fR directory in the JAR file), then changes back to the original directory before changing to the \f3bin\fR directory to add \f3Xyz\&.class\fR to \f3my\&.jar\fR\&. -.sp -.nf -\f3jar uf my\&.jar \-C classes \&. \-C bin Xyz\&.class\fP -.fi -.nf -\f3\fP -.fi -.sp - - -If \f3classes\fR contained files \f3bar1\fR and \f3bar2\fR, then the JAR file will contain the following after running the previous command: -.sp -.nf -\f3% \fIjar tf my\&.jar\fR\fP -.fi -.nf -\f3META\-INF/\fP -.fi -.nf -\f3META\-INF/MANIFEST\&.MF\fP -.fi -.nf -\f3bar1\fP -.fi -.nf -\f3bar2\fP -.fi -.nf -\f3Xyz\&.class\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -\fI\fR-J\fIoption\fR -Sets the specified JVM option to be used when the JRE runs the JAR file\&. JVM options are described on the reference page for the java(1) command\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. -.SH OPERANDS -The following operands are recognized by the \f3jar\fR command\&. -.TP -\fIfile\fR -When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fIfile\fR operand defines the path and name of the file or directory that should be added to the archive\&. When extracting (\f3x\fR) or listing the contents (\f3t\fR) of a JAR file, the \fIfile\fR operand defines the path and name of the file to be extrated or listed\&. At least one valid file or directory must be specified\&. Separate multiple \fIfile\fR operands with spaces\&. If the \fIentrypoint\fR, \fIjarfile\fR, or \fImanifest\fR operands are used, the \fIfile\fR operands must be specified after them\&. -.TP -\fIentrypoint\fR -When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fIentrypoint\fR operand defines the name of the class that should be the entry point\f3\fR for a standalone Java application bundled into an executable JAR file\&. The \fIentrypoint\fR operand must be specified if the \f3e\fR option is present\&. -.TP -\fIjarfile\fR -Defines the name of the file to be created (\f3c\fR), updated (\f3u\fR), extracted (\f3x\fR), or viewed (\f3t\fR)\&. The \fIjarfile\fR operand must be specified if the \f3f\fR option is present\&. Omitting the \f3f\fR option and the \fIjarfile\fR operand instructs the \f3jar\fR command to accept the JAR file name from \f3stdin\fR (for \f3x\fR and \f3t\fR) or send the JAR \f3\fRfile to \f3stdout\fR (for \f3c\fR and \f3u\fR)\&. - -When indexing (\f3i\fR) a JAR file, specify the \fIjarfile\fR operand without the \f3f\fR option\&. -.TP -\fImanifest\fR -When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fImanifest\fR operand defines the preexisting manifest files with names and values of attributes to be included in \f3MANIFEST\&.MF\fR in the JAR file\&. The \fImanifest\fR operand must be specified if the \f3f\fR option is present\&. -.TP -\fI@arg-file\fR -To shorten or simplify the \f3jar\fR command, you can specify arguments in a separate text file and pass it to the \f3jar\fR command with the at sign (@) as a prefix\&. When the \f3jar\fR command encounters an argument beginning with the at sign, it expands the contents of that file into the argument list\&. - -An argument file can include options and arguments of the \f3jar\fR command (except the \f3-J\fR options, because they are passed to the launcher, which does not support argument files)\&. The arguments within a file can be separated by spaces or newline characters\&. File names within an argument file are relative to the current directory from which you run the \f3jar\fR command, not relative to the location of the argument file\&. Wild cards, such as the asterisk (*), that might otherwise be expanded by the operating system shell, are not expanded\&. - -The following example, shows how to create a \f3classes\&.list\fR file with names of files from the current directory output by the \f3find\fR command: -.sp -.nf -\f3find \&. \-name \&'*\&.class\&' \-print > classes\&.list\fP -.fi -.nf -\f3\fP -.fi -.sp - - -You can then execute the \f3jar\fR command and pass the \f3classes\&.list\fR file to it using the \fI@arg-file\fR syntax: -.sp -.nf -\f3jar cf my\&.jar @classes\&.list\fP -.fi -.nf -\f3\fP -.fi -.sp - - -An argument file can be specified with a path, but any file names inside the argument file that have relative paths are relative to the current working directory of the \f3jar\fR command, not to the path passed in, for example: -.sp -.nf -\f3jar @dir/classes\&.list\fP -.fi -.nf -\f3\fP -.fi -.sp - -.SH NOTES -The \f3e\fR, \f3f\fR, and \f3m\fR options must appear in the same order on the command line as the \fIentrypoint\fR, \fIjarfile\fR, and \fImanifest\fR operands, for example: -.sp -.nf -\f3jar cmef myManifestFile MyMainClass myFile\&.jar *\&.class\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH EXAMPLES -\f3Example 1 Adding All Files From the Current Directory With Verbose Output\fR -.sp -.nf -\f3% ls\fP -.fi -.nf -\f31\&.au Animator\&.class monkey\&.jpg\fP -.fi -.nf -\f32\&.au Wave\&.class spacemusic\&.au\fP -.fi -.nf -\f33\&.au at_work\&.gif\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3% jar cvf bundle\&.jar *\fP -.fi -.nf -\f3added manifest\fP -.fi -.nf -\f3adding: 1\&.au(in = 2324) (out= 67)(deflated 97%)\fP -.fi -.nf -\f3adding: 2\&.au(in = 6970) (out= 90)(deflated 98%)\fP -.fi -.nf -\f3adding: 3\&.au(in = 11616) (out= 108)(deflated 99%)\fP -.fi -.nf -\f3adding: Animator\&.class(in = 2266) (out= 66)(deflated 97%)\fP -.fi -.nf -\f3adding: Wave\&.class(in = 3778) (out= 81)(deflated 97%)\fP -.fi -.nf -\f3adding: at_work\&.gif(in = 6621) (out= 89)(deflated 98%)\fP -.fi -.nf -\f3adding: monkey\&.jpg(in = 7667) (out= 91)(deflated 98%)\fP -.fi -.nf -\f3adding: spacemusic\&.au(in = 3079) (out= 73)(deflated 97%)\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 2 Adding Files From Subdirectories\fR -.sp -.nf -\f3% ls \-F\fP -.fi -.nf -\f3audio/ classes/ images/\fP -.fi -.nf -\f3% jar cvf bundle\&.jar audio classes images\fP -.fi -.nf -\f3added manifest\fP -.fi -.nf -\f3adding: audio/(in = 0) (out= 0)(stored 0%)\fP -.fi -.nf -\f3adding: audio/1\&.au(in = 2324) (out= 67)(deflated 97%)\fP -.fi -.nf -\f3adding: audio/2\&.au(in = 6970) (out= 90)(deflated 98%)\fP -.fi -.nf -\f3adding: audio/3\&.au(in = 11616) (out= 108)(deflated 99%)\fP -.fi -.nf -\f3adding: audio/spacemusic\&.au(in = 3079) (out= 73)(deflated 97%)\fP -.fi -.nf -\f3adding: classes/(in = 0) (out= 0)(stored 0%)\fP -.fi -.nf -\f3adding: classes/Animator\&.class(in = 2266) (out= 66)(deflated 97%)\fP -.fi -.nf -\f3adding: classes/Wave\&.class(in = 3778) (out= 81)(deflated 97%)\fP -.fi -.nf -\f3adding: images/(in = 0) (out= 0)(stored 0%)\fP -.fi -.nf -\f3adding: images/monkey\&.jpg(in = 7667) (out= 91)(deflated 98%)\fP -.fi -.nf -\f3adding: images/at_work\&.gif(in = 6621) (out= 89)(deflated 98%)\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3% ls \-F\fP -.fi -.nf -\f3audio/ bundle\&.jar classes/ images/\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 3 Listing the Contents of JAR\fR -.sp -.nf -\f3% jar tf bundle\&.jar\fP -.fi -.sp -.sp -.nf -\f3META\-INF/\fP -.fi -.nf -\f3META\-INF/MANIFEST\&.MF\fP -.fi -.nf -\f3audio/1\&.au\fP -.fi -.nf -\f3audio/2\&.au\fP -.fi -.nf -\f3audio/3\&.au\fP -.fi -.nf -\f3audio/spacemusic\&.au\fP -.fi -.nf -\f3classes/Animator\&.class\fP -.fi -.nf -\f3classes/Wave\&.class\fP -.fi -.nf -\f3images/monkey\&.jpg\fP -.fi -.nf -\f3images/at_work\&.gif\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 4 Adding an Index\fR -.PP -Use the \f3i\fR option when you split the interdependent classes for a stock trade application into three JAR files: \f3main\&.jar\fR, \f3buy\&.jar\fR, and \f3sell\&.jar\fR\&. If you specify the \f3Class-Path\fR attribute in the \f3main\&.jar\fR manifest, then you can use the \f3i\fR option to speed up the class loading time for your application: -.sp -.nf -\f3Class\-Path: buy\&.jar sell\&.jar\fP -.fi -.nf -\f3jar i main\&.jar\fP -.fi -.nf -\f3\fP -.fi -.sp -An \f3INDEX\&.LIST\fR file is inserted to the \f3META-INF\fR directory\&. This enables the application class loader to download the specified JAR files when it is searching for classes or resources\&. -.PP -The application class loader uses the information stored in this file for efficient class loading\&. To copy directories, first compress files in \f3dir1\fR to \f3stdout\fR, then pipeline and extract from \f3stdin\fR to \f3dir2\fR (omitting the \f3-f\fR option from both \f3jar\fR commands): -.sp -.nf -\f3(cd dir1; jar c \&.) | (cd dir2; jar x)\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH SEE\ ALSO -.TP 0.2i -\(bu -pack200(1)\&. -.TP 0.2i -\(bu -The JAR section of The Java Tutorials at http://docs\&.oracle\&.com/javase/tutorial/deployment/jar/index\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1997, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: jar.1 +.\" +.if n .pl 99999 +.TH jar 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jar \- Manipulates Java Archive (JAR) files\&. +.SH SYNOPSIS +Create JAR file +.sp +.nf + +\fBjar c\fR[\fBefmMnv0\fR] [\fIentrypoint\fR] [\fIjarfile\fR] [\fImanifest\fR] [\fB\-C\fR \fIdir\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp + +Update JAR file +.sp +.nf + +\fBjar u\fR[\fBefmMnv0\fR] [\fIentrypoint\fR] [\fIjarfile\fR] [\fImanifest\fR] [\fB\-C\fR \fIdir\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp + +Extract JAR file +.sp +.nf + +\fBjar\fR \fBx\fR[\fBvf\fR] [\fIjarfile\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp + +List Contents of JAR file +.sp +.nf + +\fBjar\fR \fBt\fR[\fBvf\fR] [\fIjarfile\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp + +Add Index to JAR file +.sp +.nf + +\fBjar\fR \fBi\fR \fIjarfile\fR [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp +.SH DESCRIPTION +The \f3jar\fR command is a general-purpose archiving and compression tool, based on ZIP and the ZLIB compression format\&. However, the \f3jar\fR command was designed mainly to 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 (such as a browser) in a single HTTP transaction, rather than requiring a new connection for each piece\&. This dramatically improves download times\&. The \f3jar\fR command also compresses files, which further improves download time\&. The \f3jar\fR command also allows individual entries in a file to be signed by the applet author so that their origin can be authenticated\&. A JAR file can be used as a class path entry, whether or not it is compressed\&. +.PP +The syntax for the \f3jar\fR command resembles the syntax for the \f3tar\fR command\&. It has several operation modes, defined by one of the mandatory \fIoperation arguments\fR\&. Other arguments are either \fIoptions\fR that modify the behavior of the operation, or \fIoperands\fR required to perform the operation\&. +.SH OPERATION\ ARGUMENTS +When using the \f3jar\fR command, you have to select an operation to be performed by specifying one of the following operation arguments\&. You can mix them up with other one-letter options on the command line, but usually the operation argument is the first argument specified\&. +.TP +c +Create a new JAR archive\&. +.TP +i +Generate index information for a JAR archive\&. +.TP +t +List the contents of a JAR archive\&. +.TP +u +Update a JAR archive\&. +.TP +x +Extract files from a JAR archive\&. +.SH OPTIONS +Use the following options to customize how the JAR file is created, updated, extracted, or viewed: +.TP +e +Sets the class specified by the \fIentrypoint\fR operand to be the entry point\f3\fR for a standalone Java application bundled into an executable JAR file\&. The use of this option creates or overrides the \f3Main-Class\fR attribute value in the manifest file\&. The \f3e\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. + +For example, the following command creates the \f3Main\&.jar\fR archive with the \f3Main\&.class\fR file where the \f3Main-Clas\fRs attribute value in the manifest is set to \f3Main\fR: +.sp +.nf +\f3jar cfe Main\&.jar Main Main\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The Java Runtime Environment (JRE) can directly call this application by running the following command: +.sp +.nf +\f3java \-jar Main\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If the entry point class name is in a package, then it could use either the dot (\&.) or slash (/) as the delimiter\&. For example, if \f3Main\&.class\fR is in a package called \f3mydir\fR, then the entry point can be specified in one of the following ways: +.sp +.nf +\f3jar \-cfe Main\&.jar mydir/Main mydir/Main\&.class\fP +.fi +.nf +\f3jar \-cfe Main\&.jar mydir\&.Main mydir/Main\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Note + +Specifying both \f3m\fR and \f3e\fR options together when a particular manifest also contains the \f3Main-Class\fR attribute results in an ambiguous \f3Main-Class\fR specification\&. The ambiguity leads to an error and the \f3jar\fR command creation or update operation is terminated\&. +.TP +f +Sets the file specified by the \fI\fR\fIjarfile\fR operand to be the name of the JAR file that is created (\f3c\fR), updated (\f3u\fR), extracted (\f3x\fR) from, or viewed (\f3t\fR)\&. Omitting the \f3f\fR option and the \fIjarfile\fR operand instructs the \f3jar\fR command to accept the JAR file name from \f3stdin\fR (for \f3x\fR and \f3t\fR) or send the JAR \f3\fRfile to \f3stdout\fR (for \f3c\fR and \f3u\fR)\&. +.TP +m +Includes names and values of attributes from the file specified by the \f3manifest\fR operand in the manifest file of the \f3jar\fR command (located in the archive at \f3META-INF/MANIFEST\&.MF\fR)\&. The \f3jar\fR command adds the attribute\(cqs name and value to the JAR file unless an entry already exists with the same name, in which case the \f3jar\fR command updates the value of the attribute\&. The \f3m\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. + +You can add special-purpose name-value attribute pairs to the manifest that are not contained in the default manifest file\&. For example, you can add attributes that specify vendor information, release information, package sealing, or to make JAR-bundled applications executable\&. For examples of using the \f3m\fR option, see Packaging Programs at http://docs\&.oracle\&.com/javase/tutorial/deployment/jar/index\&.html +.TP +M +Does not create a manifest file entry (for \f3c\fR and \f3u\fR), or delete a manifest file entry when one exists (for \f3u\fR)\&. The \f3M\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. +.TP +n +When creating (\f3c\fR) a JAR file, this option normalizes the archive so that the content is not affected by the packing and unpacking operations of the pack200(1) command\&. Without this normalization, the signature of a signed JAR can become invalid\&. +.TP +v +Generates verbose output to standard output\&. See Examples\&. +.TP +0 +(Zero) Creates (\f3c\fR) or updates (\f3u\fR) the JAR file without using ZIP compression\&. +.TP +-C \fIdir\fR +.br +When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, this option temporarily changes the directory while processing files specified by the \fIfile\fR operands\&. Its operation is intended to be similar to the \f3-C\fR option of the UNIX \f3tar\fR utility\&.For example, the following command changes to the \f3classes\fR directory and adds the \f3Bar\&.class\fR file from that directory to \f3my\&.jar\fR: +.sp +.nf +\f3jar uf my\&.jar \-C classes Bar\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following command changes to the \f3classes\fR directory and adds to \f3my\&.jar\fR all files within the classes directory (without creating a \f3classes\fR directory in the JAR file), then changes back to the original directory before changing to the \f3bin\fR directory to add \f3Xyz\&.class\fR to \f3my\&.jar\fR\&. +.sp +.nf +\f3jar uf my\&.jar \-C classes \&. \-C bin Xyz\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If \f3classes\fR contained files \f3bar1\fR and \f3bar2\fR, then the JAR file will contain the following after running the previous command: +.sp +.nf +\f3% \fIjar tf my\&.jar\fR\fP +.fi +.nf +\f3META\-INF/\fP +.fi +.nf +\f3META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3bar1\fP +.fi +.nf +\f3bar2\fP +.fi +.nf +\f3Xyz\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +\fI\fR-J\fIoption\fR +Sets the specified JVM option to be used when the JRE runs the JAR file\&. JVM options are described on the reference page for the java(1) command\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. +.SH OPERANDS +The following operands are recognized by the \f3jar\fR command\&. +.TP +\fIfile\fR +When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fIfile\fR operand defines the path and name of the file or directory that should be added to the archive\&. When extracting (\f3x\fR) or listing the contents (\f3t\fR) of a JAR file, the \fIfile\fR operand defines the path and name of the file to be extrated or listed\&. At least one valid file or directory must be specified\&. Separate multiple \fIfile\fR operands with spaces\&. If the \fIentrypoint\fR, \fIjarfile\fR, or \fImanifest\fR operands are used, the \fIfile\fR operands must be specified after them\&. +.TP +\fIentrypoint\fR +When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fIentrypoint\fR operand defines the name of the class that should be the entry point\f3\fR for a standalone Java application bundled into an executable JAR file\&. The \fIentrypoint\fR operand must be specified if the \f3e\fR option is present\&. +.TP +\fIjarfile\fR +Defines the name of the file to be created (\f3c\fR), updated (\f3u\fR), extracted (\f3x\fR), or viewed (\f3t\fR)\&. The \fIjarfile\fR operand must be specified if the \f3f\fR option is present\&. Omitting the \f3f\fR option and the \fIjarfile\fR operand instructs the \f3jar\fR command to accept the JAR file name from \f3stdin\fR (for \f3x\fR and \f3t\fR) or send the JAR \f3\fRfile to \f3stdout\fR (for \f3c\fR and \f3u\fR)\&. + +When indexing (\f3i\fR) a JAR file, specify the \fIjarfile\fR operand without the \f3f\fR option\&. +.TP +\fImanifest\fR +When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fImanifest\fR operand defines the preexisting manifest files with names and values of attributes to be included in \f3MANIFEST\&.MF\fR in the JAR file\&. The \fImanifest\fR operand must be specified if the \f3f\fR option is present\&. +.TP +\fI@arg-file\fR +To shorten or simplify the \f3jar\fR command, you can specify arguments in a separate text file and pass it to the \f3jar\fR command with the at sign (@) as a prefix\&. When the \f3jar\fR command encounters an argument beginning with the at sign, it expands the contents of that file into the argument list\&. + +An argument file can include options and arguments of the \f3jar\fR command (except the \f3-J\fR options, because they are passed to the launcher, which does not support argument files)\&. The arguments within a file can be separated by spaces or newline characters\&. File names within an argument file are relative to the current directory from which you run the \f3jar\fR command, not relative to the location of the argument file\&. Wild cards, such as the asterisk (*), that might otherwise be expanded by the operating system shell, are not expanded\&. + +The following example, shows how to create a \f3classes\&.list\fR file with names of files from the current directory output by the \f3find\fR command: +.sp +.nf +\f3find \&. \-name \&'*\&.class\&' \-print > classes\&.list\fP +.fi +.nf +\f3\fP +.fi +.sp + + +You can then execute the \f3jar\fR command and pass the \f3classes\&.list\fR file to it using the \fI@arg-file\fR syntax: +.sp +.nf +\f3jar cf my\&.jar @classes\&.list\fP +.fi +.nf +\f3\fP +.fi +.sp + + +An argument file can be specified with a path, but any file names inside the argument file that have relative paths are relative to the current working directory of the \f3jar\fR command, not to the path passed in, for example: +.sp +.nf +\f3jar @dir/classes\&.list\fP +.fi +.nf +\f3\fP +.fi +.sp + +.SH NOTES +The \f3e\fR, \f3f\fR, and \f3m\fR options must appear in the same order on the command line as the \fIentrypoint\fR, \fIjarfile\fR, and \fImanifest\fR operands, for example: +.sp +.nf +\f3jar cmef myManifestFile MyMainClass myFile\&.jar *\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH EXAMPLES +\f3Example 1 Adding All Files From the Current Directory With Verbose Output\fR +.sp +.nf +\f3% ls\fP +.fi +.nf +\f31\&.au Animator\&.class monkey\&.jpg\fP +.fi +.nf +\f32\&.au Wave\&.class spacemusic\&.au\fP +.fi +.nf +\f33\&.au at_work\&.gif\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3% jar cvf bundle\&.jar *\fP +.fi +.nf +\f3added manifest\fP +.fi +.nf +\f3adding: 1\&.au(in = 2324) (out= 67)(deflated 97%)\fP +.fi +.nf +\f3adding: 2\&.au(in = 6970) (out= 90)(deflated 98%)\fP +.fi +.nf +\f3adding: 3\&.au(in = 11616) (out= 108)(deflated 99%)\fP +.fi +.nf +\f3adding: Animator\&.class(in = 2266) (out= 66)(deflated 97%)\fP +.fi +.nf +\f3adding: Wave\&.class(in = 3778) (out= 81)(deflated 97%)\fP +.fi +.nf +\f3adding: at_work\&.gif(in = 6621) (out= 89)(deflated 98%)\fP +.fi +.nf +\f3adding: monkey\&.jpg(in = 7667) (out= 91)(deflated 98%)\fP +.fi +.nf +\f3adding: spacemusic\&.au(in = 3079) (out= 73)(deflated 97%)\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 2 Adding Files From Subdirectories\fR +.sp +.nf +\f3% ls \-F\fP +.fi +.nf +\f3audio/ classes/ images/\fP +.fi +.nf +\f3% jar cvf bundle\&.jar audio classes images\fP +.fi +.nf +\f3added manifest\fP +.fi +.nf +\f3adding: audio/(in = 0) (out= 0)(stored 0%)\fP +.fi +.nf +\f3adding: audio/1\&.au(in = 2324) (out= 67)(deflated 97%)\fP +.fi +.nf +\f3adding: audio/2\&.au(in = 6970) (out= 90)(deflated 98%)\fP +.fi +.nf +\f3adding: audio/3\&.au(in = 11616) (out= 108)(deflated 99%)\fP +.fi +.nf +\f3adding: audio/spacemusic\&.au(in = 3079) (out= 73)(deflated 97%)\fP +.fi +.nf +\f3adding: classes/(in = 0) (out= 0)(stored 0%)\fP +.fi +.nf +\f3adding: classes/Animator\&.class(in = 2266) (out= 66)(deflated 97%)\fP +.fi +.nf +\f3adding: classes/Wave\&.class(in = 3778) (out= 81)(deflated 97%)\fP +.fi +.nf +\f3adding: images/(in = 0) (out= 0)(stored 0%)\fP +.fi +.nf +\f3adding: images/monkey\&.jpg(in = 7667) (out= 91)(deflated 98%)\fP +.fi +.nf +\f3adding: images/at_work\&.gif(in = 6621) (out= 89)(deflated 98%)\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3% ls \-F\fP +.fi +.nf +\f3audio/ bundle\&.jar classes/ images/\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 3 Listing the Contents of JAR\fR +.sp +.nf +\f3% jar tf bundle\&.jar\fP +.fi +.sp +.sp +.nf +\f3META\-INF/\fP +.fi +.nf +\f3META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3audio/1\&.au\fP +.fi +.nf +\f3audio/2\&.au\fP +.fi +.nf +\f3audio/3\&.au\fP +.fi +.nf +\f3audio/spacemusic\&.au\fP +.fi +.nf +\f3classes/Animator\&.class\fP +.fi +.nf +\f3classes/Wave\&.class\fP +.fi +.nf +\f3images/monkey\&.jpg\fP +.fi +.nf +\f3images/at_work\&.gif\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 4 Adding an Index\fR +.PP +Use the \f3i\fR option when you split the interdependent classes for a stock trade application into three JAR files: \f3main\&.jar\fR, \f3buy\&.jar\fR, and \f3sell\&.jar\fR\&. If you specify the \f3Class-Path\fR attribute in the \f3main\&.jar\fR manifest, then you can use the \f3i\fR option to speed up the class loading time for your application: +.sp +.nf +\f3Class\-Path: buy\&.jar sell\&.jar\fP +.fi +.nf +\f3jar i main\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +An \f3INDEX\&.LIST\fR file is inserted to the \f3META-INF\fR directory\&. This enables the application class loader to download the specified JAR files when it is searching for classes or resources\&. +.PP +The application class loader uses the information stored in this file for efficient class loading\&. To copy directories, first compress files in \f3dir1\fR to \f3stdout\fR, then pipeline and extract from \f3stdin\fR to \f3dir2\fR (omitting the \f3-f\fR option from both \f3jar\fR commands): +.sp +.nf +\f3(cd dir1; jar c \&.) | (cd dir2; jar x)\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +pack200(1)\&. +.TP 0.2i +\(bu +The JAR section of The Java Tutorials at http://docs\&.oracle\&.com/javase/tutorial/deployment/jar/index\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/jarsigner.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/jarsigner.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,808 +1,808 @@ -'\" t -.\" Copyright (c) 1998, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Security Tools -.\" Title: jarsigner.1 -.\" -.if n .pl 99999 -.TH jarsigner 1 "21 November 2013" "JDK 8" "Security Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jarsigner \- Signs and verifies Java Archive (JAR) files\&. -.SH SYNOPSIS -.sp -.nf - -\fBjarsigner\fR [ \fIoptions\fR ] \fIjar\-file\fR \fIalias\fR -.fi -.nf - -\fBjarsigner\fR \fB\-verify\fR [ \fIoptions\fR ] \fIjar\-file\fR [\fIalias \&.\&.\&.\fR] -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP --verify -.br -The \f3-verify\fR option can take zero or more keystore alias names after the JAR file name\&. When the \f3-verify\fR option is specified, the \f3jarsigner\fR command checks 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 \f3-keystore\fR or the default keystore\&. - -If you also specified the \f3-strict\fR option, and the \f3jarsigner\fR command detected severe warnings, the message, "jar verified, with signer errors" is displayed\&. -.TP -\fIjar-file\fR -The JAR file to be signed\&. - -If you also specified the \f3-strict\fR option, and the \f3jarsigner\fR command detected severe warnings, the message, "jar signed, with signer errors" is displayed\&. -.TP -\fIalias\fR -The aliases are defined in the keystore specified by \f3-keystore\fR or the default keystore\&. -.SH DESCRIPTION -The \f3jarsigner\fR tool has two purposes: -.TP 0.2i -\(bu -To sign Java Archive (JAR) files\&. -.TP 0.2i -\(bu -To verify the signatures and integrity of signed JAR files\&. -.PP -The JAR feature enables the packaging of class files, images, sounds, and other digital data in a single file for faster and easier distribution\&. A tool named \f3jar\fR enables developers to produce JAR files\&. (Technically, any zip file can also be considered a JAR file, although when created by the \f3jar\fR command or processed by the \f3jarsigner\fR command, JAR files also contain a \f3META-INF/MANIFEST\&.MF\fR file\&.) -.PP -A digital signature is a string of bits that is computed from some data (the data being signed) and the private key of an entity (a person, company, and so on)\&. Similar to a handwritten signature, a digital signature has many useful characteristics: -.TP 0.2i -\(bu -Its authenticity can be verified by a computation that uses the public key corresponding to the private key used to generate the signature\&. -.TP 0.2i -\(bu -It cannot be forged, assuming the private key is kept secret\&. -.TP 0.2i -\(bu -It is a function of the data signed and thus cannot be claimed to be the signature for other data as well\&. -.TP 0.2i -\(bu -The signed data cannot be changed\&. If the data is changed, then the signature cannot be verified as authentic\&. -.PP -To generate an entity\&'s signature for a file, the entity must first have a public/private key pair associated with it and one or more certificates that authenticate its public key\&. A certificate is a digitally signed statement from one entity that says that the public key of another entity has a particular value\&. -.PP -The \f3jarsigner\fR command uses key and certificate information from a keystore to generate digital signatures for JAR files\&. A keystore is a database of private keys and their associated X\&.509 certificate chains that authenticate the corresponding public keys\&. The \f3keytool\fR command is used to create and administer keystores\&. -.PP -The \f3jarsigner\fR command uses an entity\&'s private key to generate a signature\&. The signed JAR file contains, among other things, a copy of the certificate from the keystore for the public key corresponding to the private key used to sign the file\&. The \f3jarsigner\fR command can verify the digital signature of the signed JAR file using the certificate inside it (in its signature block file)\&. -.PP -The \f3jarsigner\fR command can generate signatures that include a time stamp that lets a systems or deployer (including Java Plug-in) to check whether the JAR file was signed while the signing certificate was still valid\&. In addition, APIs allow applications to obtain the timestamp information\&. -.PP -At this time, the \f3jarsigner\fR command can only sign JAR files created by the \f3jar\fR command or zip files\&. JAR files are the same as zip files, except they also have a \f3META-INF/MANIFEST\&.MF\fR file\&. A \f3META-INF/MANIFEST\&.MF\fR file is created when the \f3jarsigner\fR command signs a zip file\&. -.PP -The default \f3jarsigner\fR command behavior is to sign a JAR or zip file\&. Use the \f3-verify\fR option to verify a signed JAR file\&. -.PP -The \f3jarsigner\fR command also attempts to validate the signer\&'s certificate after signing or verifying\&. If there is a validation error or any other problem, the command generates warning messages\&. If you specify the \f3-strict\fR option, then the command treats severe warnings as errors\&. See Errors and Warnings\&. -.SS KEYSTORE\ ALIASES -All keystore entities are accessed with unique aliases\&. -.PP -When you use the \f3jarsigner\fR command to sign a JAR file, you must specify the alias for the keystore entry that contains the private key needed to generate the signature\&. For example, the following command signs the JAR file named \f3MyJARFile\&.jar\fR with the private key associated with the alias \f3duke\fR in the keystore named \f3mystore\fR in the \f3working\fR directory\&. Because no output file is specified, it overwrites \f3MyJARFile\&.jar\fR with the signed JAR file\&. -.sp -.nf -\f3jarsigner \-keystore /working/mystore \-storepass <keystore password>\fP -.fi -.nf -\f3 \-keypass <private key password> MyJARFile\&.jar duke\fP -.fi -.nf -\f3\fR -.fi -.sp -Keystores are protected with a password, so the store password must be specified\&. You are prompted for it when you do not 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 are prompted for the password when you do not specify it on the command line and it is not the same as the store password\&. -.SS KEYSTORE\ LOCATION -The \f3jarsigner\fR command has a \f3-keystore\fR option for specifying the URL of the keystore to be used\&. The keystore is by default stored in a file named \f3\&.keystore\fR in the user\&'s home directory, as determined by the \f3user\&.home\fR system property\&. -.PP -On Oracle Solaris systems, \f3user\&.home\fR defaults to the user\&'s home directory\&. -.PP -The input stream from the \f3-keystore\fR option is passed to the \f3KeyStore\&.load\fR method\&. If \f3NONE\fR is specified as the URL, then a null stream is passed to the \f3KeyStore\&.load\fR method\&. \f3NONE\fR should be specified when the \f3KeyStore\fR class is not file based, for example, when it resides on a hardware token device\&. -.SS KEYSTORE\ IMPLEMENTATION -The \f3KeyStore\fR class provided in the \f3java\&.security\fR package supplies a number of well-defined interfaces to access and modify the information in a keystore\&. You can have multiple different concrete implementations, where each implementation is for a particular type of keystore\&. -.PP -Currently, there are two command-line tools that use keystore implementations (\f3keytool\fR and \f3jarsigner\fR), and a GUI-based tool named Policy Tool\&. Because the \f3KeyStore\fR class is publicly available, JDK users can write additional security applications that use it\&. -.PP -There is a built-in default implementation provided by Oracle that implements the keystore as a file, that uses a proprietary keystore type (format) named JKS\&. The built-in implementation protects each private key with its individual password and protects the integrity of the entire keystore with a (possibly different) password\&. -.PP -Keystore implementations are provider-based, which means the application interfaces supplied by the \f3KeyStore\fR class are implemented in terms of a Service Provider Interface (SPI)\&. There is a corresponding abstract \f3KeystoreSpi\fR class, also in the \f3java\&.security package\fR, that defines the Service Provider Interface methods that providers must implement\&. The term provider refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API\&. To provide a keystore implementation, clients must implement a provider and supply a \f3KeystoreSpi\fR subclass implementation, as described in How to Implement a Provider in the Java Cryptography Architecture at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/HowToImplAProvider\&.html -.PP -Applications can choose different types of keystore implementations from different providers, with the \f3getInstance\fR factory method in the \f3KeyStore\fR 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\&. -.PP -The \f3jarsigner\fR and \f3policytool\fR commands can read file-based keystores from any location that can be specified using a URL\&. In addition, these commands can read non-file-based keystores such as those provided by MSCAPI on Windows and PKCS11 on all platforms\&. -.PP -For the \f3jarsigner\fR and \f3keytool\fR commands, you can specify a keystore type at the command line with the \f3-storetype\fR option\&. For Policy Tool, you can specify a keystore type with the \fIEdit\fR command in the \fIKeyStore\fR menu\&. -.PP -If you do not explicitly specify a keystore type, then the tools choose a keystore implementation based on the value of the \f3keystore\&.type\fR property specified in the security properties file\&. The security properties file is called \f3java\&.security\fR, and it resides in the JDK security properties directory, \f3java\&.home/lib/security\fR, where \f3java\&.home\fR is the runtime environment\&'s directory\&. The \f3jre\fR directory in the JDK or the top-level directory of the Java Runtime Environment (JRE)\&. -.PP -Each tool gets the \f3keystore\&.type\fR value and then examines all the installed providers until it finds one that implements keystores of that type\&. It then uses the keystore implementation from that provider\&. -.PP -The \f3KeyStore\fR class defines a static method named \f3getDefaultType\fR that lets applications and applets retrieve the value of the \f3keystore\&.type\fR property\&. The following line of code creates an instance of the default keystore type as specified in the \f3keystore\&.type property\fR: -.sp -.nf -\f3KeyStore keyStore = KeyStore\&.getInstance(KeyStore\&.getDefaultType());\fP -.fi -.nf -\f3\fR -.fi -.sp -The default keystore type is \f3jks\fR (the proprietary type of the keystore implementation provided by Oracle)\&. This is specified by the following line in the security properties file: -.sp -.nf -\f3keystore\&.type=jks\fP -.fi -.nf -\f3\fR -.fi -.sp -Case does not matter in keystore type designations\&. For example, \f3JKS\fR is the same as \f3jks\fR\&. -.PP -To have the tools use a keystore implementation other than the default, change that line to specify a different keystore type\&. For example, if you have a provider package that supplies a keystore implementation for a keystore type called \f3pkcs12\fR, then change the line to the following: -.sp -.nf -\f3keystore\&.type=pkcs12\fP -.fi -.nf -\f3\fR -.fi -.sp -\fINote:\fR If you use the PKCS 11 provider package, then see "KeyTool" and "JarSigner" in Java PKCS #11 Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/p11guide\&.html -.SS SUPPORTED\ ALGORITHMS -By default, the \f3jarsigner\fR command signs a JAR file using one of the following algorithms: -.TP 0.2i -\(bu -Digital Signature Algorithm (DSA) with the SHA1 digest algorithm -.TP 0.2i -\(bu -RSA algorithm with the SHA256 digest algorithm -.TP 0.2i -\(bu -Elliptic Curve (EC) cryptography algorithm with the SHA256 with Elliptic Curve Digital Signature Algorithm (ECDSA)\&. -.PP -If the signer\&'s public and private keys are DSA keys, then \f3jarsigner\fR signs the JAR file with the \f3SHA1withDSA\fR algorithm\&. If the signer\&'s keys are RSA keys, then \f3jarsigner\fR attempts to sign the JAR file with the \f3SHA256withRSA\fR algorithm\&. If the signer\&'s keys are EC keys, then \f3jarsigner\fR signs the JAR file with the \f3SHA256withECDSA\fR algorithm\&. -.PP -These default signature algorithms can be overridden using the \f3-sigalg\fR option\&. -.SS THE\ SIGNED\ JAR\ FILE -When the \f3jarsigner\fR command 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: -.TP 0.2i -\(bu -A signature file with an \f3\&.SF\fR extension -.TP 0.2i -\(bu -A signature block file with a \f3\&.DSA\fR, \f3\&.RSA\fR, or \f3\&.EC\fR extension -.PP -The base file names for these two files come from the value of the \f3-sigFile\fR option\&. For example, when the option is \f3-sigFile MKSIGN\fR, the files are named \f3MKSIGN\&.SF\fR and \f3MKSIGN\&.DSA\fR -.PP -If no \f3-sigfile\fR option appears on the command line, then the base file name for the \f3\&.SF\fR and \f3\&.DSA\fR files is the first 8 characters of the alias name specified on the command line, all converted to uppercase\&. If the alias name has fewer than 8 characters, then the full alias name is used\&. If the alias name contains any characters that are not allowed in a signature file name, then each such character is converted to an underscore (_) character in forming the file name\&. Valid characters include letters, digits, underscores, and hyphens\&. -.PP -Signature File - -A signature file (\f3\&.SF\fR file) looks similar to the manifest file that is always included in a JAR file when the \f3jarsigner\fR command is used to sign the file\&. For each source file included in the JAR file, the \f3\&.SF\fR file has three lines, such as in the manifest file, that list the following: -.TP 0.2i -\(bu -File name -.TP 0.2i -\(bu -Name of the digest algorithm (SHA) -.TP 0.2i -\(bu -SHA digest value -.PP -In the manifest file, the SHA digest value for each source file is the digest (hash) of the binary data in the source file\&. In the \f3\&.SF\fR file, the digest value for a specified source file is the hash of the three lines in the manifest file for the source file\&. -.PP -The signature file, by default, includes a header with a hash of the whole manifest file\&. The header also contains a hash of the manifest header\&. The presence of the header enables verification optimization\&. See JAR File Verification\&. -.PP -Signature Block File - -The \f3\&.SF\fR 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 that authenticates the public key corresponding to the private key used for signing\&. The file has the extension \f3\&.DSA\fR, \f3\&.RSA\fR, or \f3\&.EC\fR, depending on the digest algorithm used\&. -.SS SIGNATURE\ TIME\ STAMP -The \f3jarsigner\fR command can generate and store a signature time stamp when signing a JAR file\&. In addition, \f3jarsigner\fR supports alternative signing mechanisms\&. This behavior is optional and is controlled by the user at the time of signing through these options\&. See Options\&. -.sp -.nf -\f3\-tsa \fIurl\fR\fP -.fi -.nf -\f3\-tsacert \fIalias\fR\fP -.fi -.nf -\f3\-altsigner \fIclass\fR\fP -.fi -.nf -\f3\-altsignerpath \fIclasspathlist\fR\fP -.fi -.nf -\f3\-tsapolicyid \fIpolicyid\fR\fP -.fi -.nf -\f3\fR -.fi -.sp -.SS JAR\ FILE\ VERIFICATION -A successful JAR file verification occurs when the signatures are valid, and none of the files that were in the JAR file when the signatures were generated have changed since then\&. JAR file verification involves the following steps: -.TP 0.4i -1\&. -Verify the signature of the \f3\&.SF\fR file\&. - -The verification ensures that the signature stored in each signature block (\f3\&.DSA\fR) file was generated using the private key corresponding to the public key whose certificate (or certificate chain) also appears in the \f3\&.DSA\fR file\&. It also ensures that the signature is a valid signature of the corresponding signature (\f3\&.SF\fR) file, and thus the \f3\&.SF\fR file was not tampered with\&. -.TP 0.4i -2\&. -Verify the digest listed in each entry in the \f3\&.SF\fR file with each corresponding section in the manifest\&. - -The \f3\&.SF\fR file by default includes a header that contains a hash of the entire manifest file\&. When the header is present, the verification can check to see whether or not the hash in the header matches the hash of the manifest file\&. If there is a match, then verification proceeds to the next step\&. - -If there is no match, then a less optimized verification is required to ensure that the hash in each source file information section in the \f3\&.SF\fR file equals the hash of its corresponding section in the manifest file\&. See Signature File\&. - -One reason the hash of the manifest file that is stored in the \f3\&.SF\fR file header might not equal the hash of the current manifest file is that one or more files were added to the JAR file (with the \f3jar\fR tool) after the signature and \f3\&.SF\fR file were generated\&. When the \f3jar\fR tool is used to add files, the manifest file is changed by adding sections to it for the new files, but the \f3\&.SF\fR file is not changed\&. A verification is still considered successful when none of the files that were in the JAR file when the signature was generated have been changed since then\&. This happens when the hashes in the non-header sections of the \f3\&.SF\fR file equal the hashes of the corresponding sections in the manifest file\&. -.TP 0.4i -3\&. -Read each file in the JAR file that has an entry in the \f3\&.SF\fR file\&. While reading, compute the file\&'s digest and compare the result with the digest for this file in the manifest section\&. The digests should be the same or verification fails\&. - -If any serious verification failures occur during the verification process, then the process is stopped and a security exception is thrown\&. The \f3jarsigner\fR command catches and displays the exception\&. -.PP -\fINote:\fR You should read any addition warnings (or errors if you specified the \f3-strict\fR option), as well as the content of the certificate (by specifying the \f3-verbose\fR and \f3-certs\fR options) to determine if the signature can be trusted\&. -.SS MULTIPLE\ SIGNATURES\ FOR\ A\ JAR\ FILE -A JAR file can be signed by multiple people by running the \f3jarsigner\fR command on the file multiple times and specifying the alias for a different person each time, as follows: -.sp -.nf -\f3jarsigner myBundle\&.jar susan\fP -.fi -.nf -\f3jarsigner myBundle\&.jar kevin\fP -.fi -.nf -\f3\fR -.fi -.sp -When a JAR file is signed multiple times, there are multiple \f3\&.SF\fR and \f3\&.DSA\fR files in the resulting JAR file, one pair for each signature\&. In the previous example, the output JAR file includes files with the following names: -.sp -.nf -\f3SUSAN\&.SF\fP -.fi -.nf -\f3SUSAN\&.DSA\fP -.fi -.nf -\f3KEVIN\&.SF\fP -.fi -.nf -\f3KEVIN\&.DSA\fP -.fi -.sp -.SH OPTIONS -The following sections describe the various \f3jarsigner\fR options\&. Be aware of the following standards: -.TP 0.2i -\(bu -All option names are preceded by a minus sign (-)\&. -.TP 0.2i -\(bu -The options can be provided in any order\&. -.TP 0.2i -\(bu -Items that are in italics or underlined (option values) represent the actual values that must be supplied\&. -.TP 0.2i -\(bu -The \f3-storepass\fR, \f3-keypass\fR, \f3-sigfile\fR, \f3-sigalg\fR, \f3-digestalg\fR, \f3-signedjar\fR, and TSA-related options are only relevant when signing a JAR file; they are not relevant when verifying a signed JAR file\&. The \f3-keystore\fR option is relevant for signing and verifying a JAR file\&. In addition, aliases are specified when signing and verifying a JAR file\&. -.TP --keystore \fIurl\fR -.br -Specifies the URL that tells the keystore location\&. This defaults to the file \f3\&.keystore\fR in the user\&'s home directory, as determined by the \f3user\&.home\fR system property\&. - -A keystore is required when signing\&. You must explicitly specify a keystore when the default keystore does not exist or if you want to use one other than the default\&. - -A keystore is not required when verifying, but if one is specified or the default exists and the \f3-verbose\fR option was also specified, then additional information is output regarding whether or not any of the certificates used to verify the JAR file are contained in that keystore\&. - -The \f3-keystore\fR argument can be a file name and path specification rather than a URL, in which case it is treated the same as a file: URL, for example, the following are equivalent: -.sp -.nf -\f3\-keystore \fIfilePathAndName\fR\fP -.fi -.nf -\f3\-keystore file:\fIfilePathAndName\fR\fP -.fi -.nf -\f3\fR -.fi -.sp - - -If the Sun PKCS #11 provider was configured in the \f3java\&.security\fR security properties file (located in the JRE\&'s \f3$JAVA_HOME/lib/security directory\fR), then the \f3keytool\fR and \f3jarsigner\fR tools can operate on the PKCS #11 token by specifying these options: -.sp -.nf -\f3\-keystore NONE\fP -.fi -.nf -\f3\-storetype PKCS11\fP -.fi -.nf -\f3\fR -.fi -.sp - - -For example, the following command lists the contents of the configured PKCS#11 token: -.sp -.nf -\f3keytool \-keystore NONE \-storetype PKCS11 \-list\fP -.fi -.nf -\f3\fR -.fi -.sp - -.TP --storetype \fIstoretype\fR -.br -Specifies the type of keystore to be instantiated\&. The default keystore type is the one that is specified as the value of the \f3keystore\&.type\fR property in the security properties file, which is returned by the static \f3getDefaultType\fR method in \f3java\&.security\&.KeyStore\fR\&. - -The PIN for a PCKS #11 token can also be specified with the \f3-storepass\fR option\&. If none is specified, then the \f3keytool\fR and \f3jarsigner\fR commands 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 \f3-protected\fR option must be specified and no password options can be specified\&. -.TP --storepass[:env | :file] \fIargument\fR -.br -Specifies the password that is required to access the keystore\&. This is only needed when signing (not verifying) a JAR file\&. In that case, if a \f3-storepass\fR option is not provided at the command line, then the user is prompted for the password\&. - -If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the value \fIargument\fR\&. Otherwise, the password is retrieved as follows: -.RS -.TP 0.2i -\(bu -\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. -.TP 0.2i -\(bu -\f3file\fR: Retrieve the password from the file named \f3argument\fR\&. -.RE - - -\fINote:\fR The password should not be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system\&. -.TP --keypass [:env | :file] \fIargument\fR -.br -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\fR to sign a JAR file\&. If no password is provided on the command line, and the required password is different from the store password, then the user is prompted for it\&. - -If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the value \f3argument\fR\&. Otherwise, the password is retrieved as follows: -.RS -.TP 0.2i -\(bu -\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. -.TP 0.2i -\(bu -\f3file\fR: Retrieve the password from the file named \f3argument\fR\&. -.RE - - -\fINote:\fR The password should not be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system\&. -.TP --sigfile \fIfile\fR -.br -Specifies the base file name to be used for the generated \f3\&.SF\fR and \f3\&.DSA\fR files\&. For example, if file is \f3DUKESIGN\fR, then the generated \f3\&.SF\fR and \f3\&.DSA\fR files are named \f3DUKESIGN\&.SF\fR and \f3DUKESIGN\&.DSA\fR, and placed in the \f3META-INF\fR directory of the signed JAR file\&. - -The characters in the file must come from the set \f3a-zA-Z0-9_-\fR\&. Only letters, numbers, underscore, and hyphen characters are allowed\&. All lowercase characters are converted to uppercase for the \f3\&.SF\fR and \f3\&.DSA\fR file names\&. - -If no \f3-sigfile\fR option appears on the command line, then the base file name for the \f3\&.SF\fR and \f3\&.DSA\fR files is 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, then the full alias name is used\&. If the alias name contains any characters that are not valid in a signature file name, then each such character is converted to an underscore (_) character to form the file name\&. -.TP --sigalg \fIalgorithm\fR -.br -Specifies the name of the signature algorithm to use to sign the JAR file\&. - -For a list of standard signature algorithm names, see "Appendix A: Standard Names" in the Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA - -This algorithm must be compatible with the private key used to sign the JAR file\&. If this option is not specified, then \f3SHA1withDSA\fR, \f3SHA256withRSA\fR, or \f3SHA256withECDSA\fR are 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 \f3-providerClass\fR option; otherwise, the command will not succeed\&. -.TP --digestalg \fIalgorithm\fR -.br -Specifies the name of the message digest algorithm to use when digesting the entries of a JAR file\&. - -For a list of standard message digest algorithm names, see "Appendix A: Standard Names" in the Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA - -If this option is not specified, then \f3SHA256\fR is used\&. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f3-providerClass\fR option; otherwise, the command will not succeed\&. -.TP --certs -.br -If the \f3-certs\fR option appears on the command line with the \f3-verify\fR and \f3-verbose\fR options, then the output includes certificate information for each signer of the JAR file\&. This information includes the name of the type of certificate (stored in the \f3\&.DSA\fR file) that certifies the signer\&'s public key, and if the certificate is an X\&.509 certificate (an instance of the \f3java\&.security\&.cert\&.X509Certificate\fR), then the distinguished name of the signer\&. - -The keystore is also examined\&. If no keystore value is specified on the command line, then the default keystore file (if any) is checked\&. If the public key certificate for a signer matches an entry in the keystore, then the alias name for the keystore entry for that signer is displayed in parentheses\&. -.TP --certchain \fIfile\fR -.br -Specifies the certificate chain to be used when the certificate chain associated with the private key of the keystore entry that is addressed by the alias specified on the command line is not complete\&. This can happen when the keystore is located on a hardware token where there is not enough capacity to hold a complete certificate chain\&. The file can be a sequence of concatenated X\&.509 certificates, or a single PKCS#7 formatted data block, either in binary encoding format or in printable encoding format (also known as Base64 encoding) as defined by the Internet RFC 1421 standard\&. See Internet RFC 1421 Certificate Encoding Standard and http://tools\&.ietf\&.org/html/rfc1421\&. -.TP --verbose -.br -When the \f3-verbose\fR option appears on the command line, it indicates verbose mode, which causes \f3jarsigner\fR to output extra information about the progress of the JAR signing or verification\&. -.TP --internalsf -.br -In the past, the \f3\&.DSA\fR (signature block) file generated when a JAR file was signed included a complete encoded copy of the \f3\&.SF\fR file (signature file) also generated\&. This behavior has been changed\&. To reduce the overall size of the output JAR file, the \f3\&.DSA\fR file by default does not contain a copy of the \f3\&.SF\fR file anymore\&. If \f3-internalsf\fR appears on the command line, then the old behavior is utilized\&. This option is useful for testing\&. In practice, do not use the \f3-internalsf\fR option because it incurs higher overhead\&. -.TP --sectionsonly -.br -If the \f3-sectionsonly\fR option appears on the command line, then the \f3\&.SF\fR file (signature file) generated when a JAR file is signed does not include a header that contains a hash of the whole manifest file\&. It contains only the information and hashes related to each individual source file included in the JAR file\&. See Signature File\&. - -By default, this header is added, as an optimization\&. When the header is present, whenever the JAR file is verified, the verification can first check to see whether the hash in the header matches the hash of the whole manifest file\&. When there is a match, verification proceeds to the next step\&. When there is no match, it is necessary to do a less optimized verification that the hash in each source file information section in the \f3\&.SF\fR file equals the hash of its corresponding section in the manifest file\&. See JAR File Verification\&. - -The \f3-sectionsonly\fR option is primarily used for testing\&. It should not be used other than for testing because using it incurs higher overhead\&. -.TP --protected -.br -Values can be either \f3true\fR or \f3false\fR\&. Specify \f3true\fR when a password must be specified through a protected authentication path such as a dedicated PIN reader\&. -.TP --providerClass \fIprovider-class-name\fR -.br -Used to specify the name of cryptographic service provider\&'s master class file when the service provider is not listed in the \f3java\&.security\fR security properties file\&. - -Used with the \f3-providerArg ConfigFilePath\fR option, the \f3keytool\fR and \f3jarsigner\fR tools install the provider dynamically and use \fIConfigFilePath\fR for the path to the token configuration file\&. The following example shows a command to list a \f3PKCS #11\fR keystore when the Oracle PKCS #11 provider was not configured in the security properties file\&. -.sp -.nf -\f3jarsigner \-keystore NONE \-storetype PKCS11 \e\fP -.fi -.nf -\f3 \-providerClass sun\&.security\&.pkcs11\&.SunPKCS11 \e\fP -.fi -.nf -\f3 \-providerArg /mydir1/mydir2/token\&.config \e\fP -.fi -.nf -\f3 \-list\fP -.fi -.nf -\f3\fR -.fi -.sp - -.TP --providerName \fIproviderName\fR -.br -If more than one provider was configured in the \f3java\&.security\fR security properties file, then you can use the \f3-providerName\fR option to target a specific provider instance\&. The argument to this option is the name of the provider\&. - -For the Oracle PKCS #11 provider, \fIproviderName\fR is of the form \f3SunPKCS11-\fR\fITokenName\fR, where \fITokenName\fR is the name suffix that the provider instance has been configured with, as detailed in the configuration attributes table\&. For example, the following command lists the contents of the \f3PKCS #11\fR keystore provider instance with name suffix \f3SmartCard\fR: -.sp -.nf -\f3jarsigner \-keystore NONE \-storetype PKCS11 \e\fP -.fi -.nf -\f3 \-providerName SunPKCS11\-SmartCard \e\fP -.fi -.nf -\f3 \-list\fP -.fi -.nf -\f3\fR -.fi -.sp - -.TP --J\fIjavaoption\fR -.br -Passes through the specified \fIjavaoption\fR string directly to the Java interpreter\&. The \f3jarsigner\fR command is 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 \f3java -h\fR or \f3java -X\fR at the command line\&. -.TP --tsa \fIurl\fR -.br -If \f3-tsa http://example\&.tsa\&.url\fR appears on the command line when signing a JAR file then a time stamp is generated for the signature\&. The URL, \f3http://example\&.tsa\&.url\fR, identifies the location of the Time Stamping Authority (TSA) and overrides any URL found with the \f3-tsacert\fR option\&. The \f3-tsa\fR option does not require the TSA public key certificate to be present in the keystore\&. - -To generate the time stamp, \f3jarsigner\fR communicates with the TSA with the Time-Stamp Protocol (TSP) defined in RFC 3161\&. When successful, the time stamp token returned by the TSA is stored with the signature in the signature block file\&. -.TP --tsacert \fIalias\fR -.br -When \f3-tsacert alias\fR appears on the command line when signing a JAR file, a time stamp is generated for the signature\&. The alias identifies the TSA public key certificate in the keystore that is in effect\&. The entry\&'s certificate is examined for a Subject Information Access extension that contains a URL identifying the location of the TSA\&. - -The TSA public key certificate must be present in the keystore when using the \f3-tsacert\fR option\&. -.TP --tsapolicyid \fIpolicyid\fR -.br -Specifies the object identifier (OID) that identifies the policy ID to be sent to the TSA server\&. If this option is not specified, no policy ID is sent and the TSA server will choose a default policy ID\&. - -Object identifiers are defined by X\&.696, which is an ITU Telecommunication Standardization Sector (ITU-T) standard\&. These identifiers are typically period-separated sets of non-negative digits like \f31\&.2\&.3\&.4\fR, for example\&. -.TP --altsigner \fIclass\fR -.br -This option specifies an alternative signing mechanism\&. The fully qualified class name identifies a class file that extends the \f3com\&.sun\&.jarsigner\&.ContentSigner\fR abstract class\&. The path to this class file is defined by the \f3-altsignerpath\fR option\&. If the \f3-altsigner\fR option is used, then the \f3jarsigner\fR command uses the signing mechanism provided by the specified class\&. Otherwise, the \f3jarsigner\fR command uses its default signing mechanism\&. - -For example, to use the signing mechanism provided by a class named \f3com\&.sun\&.sun\&.jarsigner\&.AuthSigner\fR, use the jarsigner option \f3-altsigner com\&.sun\&.jarsigner\&.AuthSigner\fR\&. -.TP --altsignerpath \fIclasspathlist\fR -.br -Specifies the path to the class file and any JAR file it depends on\&. The class file name is specified with the \f3-altsigner\fR option\&. If the class file is in a JAR file, then this option specifies the path to that JAR file\&. - -An absolute path or a path relative to the current directory can be specified\&. If \fIclasspathlist\fR contains multiple paths or JAR files, then they should be separated with a colon (:) on Oracle Solaris and a semicolon (;) on Windows\&. This option is not necessary when the class is already in the search path\&. - -The following example shows how to specify the path to a JAR file that contains the class file\&. The JAR file name is included\&. -.sp -.nf -\f3\-altsignerpath /home/user/lib/authsigner\&.jar\fP -.fi -.nf -\f3\fR -.fi -.sp - - -The following example shows how to specify the path to the JAR file that contains the class file\&. The JAR file name is omitted\&. -.sp -.nf -\f3\-altsignerpath /home/user/classes/com/sun/tools/jarsigner/\fP -.fi -.nf -\f3\fR -.fi -.sp - -.TP --strict -.br -During the signing or verifying process, the command may issue warning messages\&. If you specify this option, the exit code of the tool reflects the severe warning messages that this command found\&. See Errors and Warnings\&. -.TP --verbose \fIsuboptions\fR -.br -For the verifying process, the \f3-verbose\fR option takes suboptions to determine how much information is shown\&. If the \f3-certs\fR option is also specified, then the default mode (or suboption \f3all\fR) displays each entry as it is being processed, and after that, the certificate information for each signer of the JAR file\&. If the \f3-certs\fR and the \f3-verbose:grouped\fR suboptions are specified, then entries with the same signer info are grouped and displayed together with their certificate information\&. If \f3-certs\fR and the \f3-verbose:summary\fR suboptions are specified, then entries with the same signer information are grouped and displayed together with their certificate information\&. Details about each entry are summarized and displayed as \fIone entry (and more)\fR\&. See Examples\&. -.SH ERRORS\ AND\ WARNINGS -During the signing or verifying process, the \f3jarsigner\fR command may issue various errors or warnings\&. -.PP -If there is a failure, the \f3jarsigner\fR command exits with code 1\&. If there is no failure, but there are one or more severe warnings, the \f3jarsigner\fR command exits with code 0 when the \f3-strict\fR option is \fInot\fR specified, or exits with the OR-value of the warning codes when the \f3-strict\fR is specified\&. If there is only informational warnings or no warning at all, the command always exits with code 0\&. -.PP -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, the \f3jarsigner\fR command exits with code 12 (=4+8) when the \f3-strict\fR option is specified\&. -.PP -\fINote:\fR Exit codes are reused because only the values from 0 to 255 are legal on Unix-based operating systems\&. -.PP -The following sections describes the names, codes, and descriptions of the errors and warnings that the \f3jarsigner\fR command can issue\&. -.SS FAILURE -Reasons why the \f3jarsigner\fR command fails include (but are not limited to) a command line parsing error, the inability to find a keypair to sign the JAR file, or the verification of a signed JAR fails\&. -.TP -failure -Code 1\&. The signing or verifying fails\&. -.SS SEVERE\ WARNINGS -\fINote:\fR Severe warnings are reported as errors if you specify the \f3-strict\fR option\&. -.PP -Reasons why the \f3jarsigner\fR command issues a severe warning include the certificate used to sign the JAR file has an error or the signed JAR file has other problems\&. -.TP -hasExpiredCert -Code 4\&. This jar contains entries whose signer certificate has expired\&. -.TP -notYetValidCert -Code 4\&. This jar contains entries whose signer certificate is not yet valid\&. -.TP -chainNotValidated -Code 4\&. This jar contains entries whose certificate chain cannot be correctly validated\&. -.TP -badKeyUsage -Code 8\&. This jar contains entries whose signer certificate\&'s KeyUsage extension doesn\&'t allow code signing\&. -.TP -badExtendedKeyUsage -Code 8\&. This jar contains entries whose signer certificate\&'s ExtendedKeyUsage extension doesn\&'t allow code signing\&. -.TP -badNetscapeCertType -Code 8\&. This jar contains entries whose signer certificate\&'s NetscapeCertType extension doesn\&'t allow code signing\&. -.TP -hasUnsignedEntry -Code 16\&. This jar contains unsigned entries which have not been integrity-checked\&. -.TP -notSignedByAlias -Code 32\&. This jar contains signed entries which are not signed by the specified alias(es)\&. -.TP -aliasNotInStore -Code 32\&. This jar contains signed entries that are not signed by alias in this keystore\&. -.SS INFORMATIONAL\ WARNINGS -Informational warnings include those that are not errors but regarded as bad practice\&. They do not have a code\&. -.TP -hasExpiringCert -This jar contains entries whose signer certificate will expire within six months\&. -.TP -noTimestamp -This jar contains signatures that does not include a timestamp\&. Without a timestamp, users may not be able to validate this JAR file after the signer certificate\&'s expiration date (\f3YYYY-MM-DD\fR) or after any future revocation date\&. -.SH EXAMPLES -.SS SIGN\ A\ JAR\ FILE -Use the following command to sign bundle\&.jar with the private key of a user whose keystore alias is \f3jane\fR in a keystore named \f3mystore\fR in the \f3working\fR directory and name the signed JAR file \f3sbundle\&.jar\fR: -.sp -.nf -\f3jarsigner \-keystore /working/mystore\fP -.fi -.nf -\f3 \-storepass <keystore password>\fP -.fi -.nf -\f3 \-keypass <private key password>\fP -.fi -.nf -\f3 \-signedjar sbundle\&.jar bundle\&.jar jane\fP -.fi -.nf -\f3\fR -.fi -.sp -There is no \f3-sigfile\fR specified in the previous command so the generated \f3\&.SF\fR and \f3\&.DSA\fR files to be placed in the signed JAR file have default names based on the alias name\&. They are named \f3JANE\&.SF\fR and \f3JANE\&.DSA\fR\&. -.PP -If you want to be prompted for the store password and the private key password, then you could shorten the previous command to the following: -.sp -.nf -\f3jarsigner \-keystore /working/mystore\fP -.fi -.nf -\f3 \-signedjar sbundle\&.jar bundle\&.jar jane\fP -.fi -.nf -\f3\fR -.fi -.sp -If the keystore is the default keystore (\&.keystore in your home directory), then you do not need to specify a keystore, as follows: -.sp -.nf -\f3jarsigner \-signedjar sbundle\&.jar bundle\&.jar jane\fP -.fi -.nf -\f3\fR -.fi -.sp -If you want the signed JAR file to overwrite the input JAR file (bundle\&.jar), then you do not need to specify a \f3-signedjar\fR option, as follows: -.sp -.nf -\f3jarsigner bundle\&.jar jane\fP -.fi -.nf -\f3\fR -.fi -.sp -.SS VERIFY\ A\ SIGNED\ JAR\ FILE -To verify a signed JAR file to ensure that the signature is valid and the JAR file was not been tampered with, use a command such as the following: -.sp -.nf -\f3jarsigner \-verify sbundle\&.jar\fP -.fi -.nf -\f3\fR -.fi -.sp -When the verification is successful, \f3jar verified\fR is displayed\&. Otherwise, an error message is displayed\&. You can get more information when you use the \f3-verbose\fR option\&. A sample use of \f3jarsigner\fR with the\f3-verbose\fR option follows: -.sp -.nf -\f3jarsigner \-verify \-verbose sbundle\&.jar\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST\&.MF\fP -.fi -.nf -\f3 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.SF\fP -.fi -.nf -\f3 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.DSA\fP -.fi -.nf -\f3 smk 2752 Fri Sep 26 16:12:30 PDT 1997 AclEx\&.class\fP -.fi -.nf -\f3 smk 849 Fri Sep 26 16:12:46 PDT 1997 test\&.class\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3 s = signature was verified\fP -.fi -.nf -\f3 m = entry is listed in manifest\fP -.fi -.nf -\f3 k = at least one certificate was found in keystore\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3 jar verified\&.\fP -.fi -.nf -\f3\fR -.fi -.sp -.SS VERIFICATION\ WITH\ CERTIFICATE\ INFORMATION -If you specify the \f3-certs\fR option with the \f3-verify\fR and \f3-verbose\fR options, then the output includes certificate information for each signer of the JAR file\&. The information includes the certificate type, the signer distinguished name information (when it is an X\&.509 certificate), and in parentheses, the keystore alias for the signer when the public key certificate in the JAR file matches the one in a keystore entry, for example: -.sp -.nf -\f3jarsigner \-keystore /working/mystore \-verify \-verbose \-certs myTest\&.jar\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST\&.MF\fP -.fi -.nf -\f3 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.SF\fP -.fi -.nf -\f3 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.DSA\fP -.fi -.nf -\f3 208 Fri Sep 26 16:23:30 PDT 1997 META\-INF/JAVATEST\&.SF\fP -.fi -.nf -\f3 1087 Fri Sep 26 16:23:30 PDT 1997 META\-INF/JAVATEST\&.DSA\fP -.fi -.nf -\f3 smk 2752 Fri Sep 26 16:12:30 PDT 1997 Tst\&.class\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3 X\&.509, CN=Test Group, OU=Java Software, O=Oracle, L=CUP, S=CA, C=US (javatest)\fP -.fi -.nf -\f3 X\&.509, CN=Jane Smith, OU=Java Software, O=Oracle, L=cup, S=ca, C=us (jane)\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3 s = signature was verified\fP -.fi -.nf -\f3 m = entry is listed in manifest\fP -.fi -.nf -\f3 k = at least one certificate was found in keystore\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3 jar verified\&.\fP -.fi -.nf -\f3\fR -.fi -.sp -If the certificate for a signer is not an X\&.509 certificate, then there is no distinguished name information\&. In that case, just the certificate type and the alias are shown\&. For example, if the certificate is a PGP certificate, and the alias is \f3bob\fR, then you would get: \f3PGP, (bob)\fR\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -jar(1) -.TP 0.2i -\(bu -keytool(1) -.TP 0.2i -\(bu -Trail: Security Features in Java SE at http://docs\&.oracle\&.com/javase/tutorial/security/index\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1998, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Security Tools +.\" Title: jarsigner.1 +.\" +.if n .pl 99999 +.TH jarsigner 1 "21 November 2013" "JDK 8" "Security Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jarsigner \- Signs and verifies Java Archive (JAR) files\&. +.SH SYNOPSIS +.sp +.nf + +\fBjarsigner\fR [ \fIoptions\fR ] \fIjar\-file\fR \fIalias\fR +.fi +.nf + +\fBjarsigner\fR \fB\-verify\fR [ \fIoptions\fR ] \fIjar\-file\fR [\fIalias \&.\&.\&.\fR] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +-verify +.br +The \f3-verify\fR option can take zero or more keystore alias names after the JAR file name\&. When the \f3-verify\fR option is specified, the \f3jarsigner\fR command checks 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 \f3-keystore\fR or the default keystore\&. + +If you also specified the \f3-strict\fR option, and the \f3jarsigner\fR command detected severe warnings, the message, "jar verified, with signer errors" is displayed\&. +.TP +\fIjar-file\fR +The JAR file to be signed\&. + +If you also specified the \f3-strict\fR option, and the \f3jarsigner\fR command detected severe warnings, the message, "jar signed, with signer errors" is displayed\&. +.TP +\fIalias\fR +The aliases are defined in the keystore specified by \f3-keystore\fR or the default keystore\&. +.SH DESCRIPTION +The \f3jarsigner\fR tool has two purposes: +.TP 0.2i +\(bu +To sign Java Archive (JAR) files\&. +.TP 0.2i +\(bu +To verify the signatures and integrity of signed JAR files\&. +.PP +The JAR feature enables the packaging of class files, images, sounds, and other digital data in a single file for faster and easier distribution\&. A tool named \f3jar\fR enables developers to produce JAR files\&. (Technically, any zip file can also be considered a JAR file, although when created by the \f3jar\fR command or processed by the \f3jarsigner\fR command, JAR files also contain a \f3META-INF/MANIFEST\&.MF\fR file\&.) +.PP +A digital signature is a string of bits that is computed from some data (the data being signed) and the private key of an entity (a person, company, and so on)\&. Similar to a handwritten signature, a digital signature has many useful characteristics: +.TP 0.2i +\(bu +Its authenticity can be verified by a computation that uses the public key corresponding to the private key used to generate the signature\&. +.TP 0.2i +\(bu +It cannot be forged, assuming the private key is kept secret\&. +.TP 0.2i +\(bu +It is a function of the data signed and thus cannot be claimed to be the signature for other data as well\&. +.TP 0.2i +\(bu +The signed data cannot be changed\&. If the data is changed, then the signature cannot be verified as authentic\&. +.PP +To generate an entity\&'s signature for a file, the entity must first have a public/private key pair associated with it and one or more certificates that authenticate its public key\&. A certificate is a digitally signed statement from one entity that says that the public key of another entity has a particular value\&. +.PP +The \f3jarsigner\fR command uses key and certificate information from a keystore to generate digital signatures for JAR files\&. A keystore is a database of private keys and their associated X\&.509 certificate chains that authenticate the corresponding public keys\&. The \f3keytool\fR command is used to create and administer keystores\&. +.PP +The \f3jarsigner\fR command uses an entity\&'s private key to generate a signature\&. The signed JAR file contains, among other things, a copy of the certificate from the keystore for the public key corresponding to the private key used to sign the file\&. The \f3jarsigner\fR command can verify the digital signature of the signed JAR file using the certificate inside it (in its signature block file)\&. +.PP +The \f3jarsigner\fR command can generate signatures that include a time stamp that lets a systems or deployer (including Java Plug-in) to check whether the JAR file was signed while the signing certificate was still valid\&. In addition, APIs allow applications to obtain the timestamp information\&. +.PP +At this time, the \f3jarsigner\fR command can only sign JAR files created by the \f3jar\fR command or zip files\&. JAR files are the same as zip files, except they also have a \f3META-INF/MANIFEST\&.MF\fR file\&. A \f3META-INF/MANIFEST\&.MF\fR file is created when the \f3jarsigner\fR command signs a zip file\&. +.PP +The default \f3jarsigner\fR command behavior is to sign a JAR or zip file\&. Use the \f3-verify\fR option to verify a signed JAR file\&. +.PP +The \f3jarsigner\fR command also attempts to validate the signer\&'s certificate after signing or verifying\&. If there is a validation error or any other problem, the command generates warning messages\&. If you specify the \f3-strict\fR option, then the command treats severe warnings as errors\&. See Errors and Warnings\&. +.SS KEYSTORE\ ALIASES +All keystore entities are accessed with unique aliases\&. +.PP +When you use the \f3jarsigner\fR command to sign a JAR file, you must specify the alias for the keystore entry that contains the private key needed to generate the signature\&. For example, the following command signs the JAR file named \f3MyJARFile\&.jar\fR with the private key associated with the alias \f3duke\fR in the keystore named \f3mystore\fR in the \f3working\fR directory\&. Because no output file is specified, it overwrites \f3MyJARFile\&.jar\fR with the signed JAR file\&. +.sp +.nf +\f3jarsigner \-keystore /working/mystore \-storepass <keystore password>\fP +.fi +.nf +\f3 \-keypass <private key password> MyJARFile\&.jar duke\fP +.fi +.nf +\f3\fR +.fi +.sp +Keystores are protected with a password, so the store password must be specified\&. You are prompted for it when you do not 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 are prompted for the password when you do not specify it on the command line and it is not the same as the store password\&. +.SS KEYSTORE\ LOCATION +The \f3jarsigner\fR command has a \f3-keystore\fR option for specifying the URL of the keystore to be used\&. The keystore is by default stored in a file named \f3\&.keystore\fR in the user\&'s home directory, as determined by the \f3user\&.home\fR system property\&. +.PP +On Oracle Solaris systems, \f3user\&.home\fR defaults to the user\&'s home directory\&. +.PP +The input stream from the \f3-keystore\fR option is passed to the \f3KeyStore\&.load\fR method\&. If \f3NONE\fR is specified as the URL, then a null stream is passed to the \f3KeyStore\&.load\fR method\&. \f3NONE\fR should be specified when the \f3KeyStore\fR class is not file based, for example, when it resides on a hardware token device\&. +.SS KEYSTORE\ IMPLEMENTATION +The \f3KeyStore\fR class provided in the \f3java\&.security\fR package supplies a number of well-defined interfaces to access and modify the information in a keystore\&. You can have multiple different concrete implementations, where each implementation is for a particular type of keystore\&. +.PP +Currently, there are two command-line tools that use keystore implementations (\f3keytool\fR and \f3jarsigner\fR), and a GUI-based tool named Policy Tool\&. Because the \f3KeyStore\fR class is publicly available, JDK users can write additional security applications that use it\&. +.PP +There is a built-in default implementation provided by Oracle that implements the keystore as a file, that uses a proprietary keystore type (format) named JKS\&. The built-in implementation protects each private key with its individual password and protects the integrity of the entire keystore with a (possibly different) password\&. +.PP +Keystore implementations are provider-based, which means the application interfaces supplied by the \f3KeyStore\fR class are implemented in terms of a Service Provider Interface (SPI)\&. There is a corresponding abstract \f3KeystoreSpi\fR class, also in the \f3java\&.security package\fR, that defines the Service Provider Interface methods that providers must implement\&. The term provider refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API\&. To provide a keystore implementation, clients must implement a provider and supply a \f3KeystoreSpi\fR subclass implementation, as described in How to Implement a Provider in the Java Cryptography Architecture at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/HowToImplAProvider\&.html +.PP +Applications can choose different types of keystore implementations from different providers, with the \f3getInstance\fR factory method in the \f3KeyStore\fR 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\&. +.PP +The \f3jarsigner\fR and \f3policytool\fR commands can read file-based keystores from any location that can be specified using a URL\&. In addition, these commands can read non-file-based keystores such as those provided by MSCAPI on Windows and PKCS11 on all platforms\&. +.PP +For the \f3jarsigner\fR and \f3keytool\fR commands, you can specify a keystore type at the command line with the \f3-storetype\fR option\&. For Policy Tool, you can specify a keystore type with the \fIEdit\fR command in the \fIKeyStore\fR menu\&. +.PP +If you do not explicitly specify a keystore type, then the tools choose a keystore implementation based on the value of the \f3keystore\&.type\fR property specified in the security properties file\&. The security properties file is called \f3java\&.security\fR, and it resides in the JDK security properties directory, \f3java\&.home/lib/security\fR, where \f3java\&.home\fR is the runtime environment\&'s directory\&. The \f3jre\fR directory in the JDK or the top-level directory of the Java Runtime Environment (JRE)\&. +.PP +Each tool gets the \f3keystore\&.type\fR value and then examines all the installed providers until it finds one that implements keystores of that type\&. It then uses the keystore implementation from that provider\&. +.PP +The \f3KeyStore\fR class defines a static method named \f3getDefaultType\fR that lets applications and applets retrieve the value of the \f3keystore\&.type\fR property\&. The following line of code creates an instance of the default keystore type as specified in the \f3keystore\&.type property\fR: +.sp +.nf +\f3KeyStore keyStore = KeyStore\&.getInstance(KeyStore\&.getDefaultType());\fP +.fi +.nf +\f3\fR +.fi +.sp +The default keystore type is \f3jks\fR (the proprietary type of the keystore implementation provided by Oracle)\&. This is specified by the following line in the security properties file: +.sp +.nf +\f3keystore\&.type=jks\fP +.fi +.nf +\f3\fR +.fi +.sp +Case does not matter in keystore type designations\&. For example, \f3JKS\fR is the same as \f3jks\fR\&. +.PP +To have the tools use a keystore implementation other than the default, change that line to specify a different keystore type\&. For example, if you have a provider package that supplies a keystore implementation for a keystore type called \f3pkcs12\fR, then change the line to the following: +.sp +.nf +\f3keystore\&.type=pkcs12\fP +.fi +.nf +\f3\fR +.fi +.sp +\fINote:\fR If you use the PKCS 11 provider package, then see "KeyTool" and "JarSigner" in Java PKCS #11 Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/p11guide\&.html +.SS SUPPORTED\ ALGORITHMS +By default, the \f3jarsigner\fR command signs a JAR file using one of the following algorithms: +.TP 0.2i +\(bu +Digital Signature Algorithm (DSA) with the SHA1 digest algorithm +.TP 0.2i +\(bu +RSA algorithm with the SHA256 digest algorithm +.TP 0.2i +\(bu +Elliptic Curve (EC) cryptography algorithm with the SHA256 with Elliptic Curve Digital Signature Algorithm (ECDSA)\&. +.PP +If the signer\&'s public and private keys are DSA keys, then \f3jarsigner\fR signs the JAR file with the \f3SHA1withDSA\fR algorithm\&. If the signer\&'s keys are RSA keys, then \f3jarsigner\fR attempts to sign the JAR file with the \f3SHA256withRSA\fR algorithm\&. If the signer\&'s keys are EC keys, then \f3jarsigner\fR signs the JAR file with the \f3SHA256withECDSA\fR algorithm\&. +.PP +These default signature algorithms can be overridden using the \f3-sigalg\fR option\&. +.SS THE\ SIGNED\ JAR\ FILE +When the \f3jarsigner\fR command 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: +.TP 0.2i +\(bu +A signature file with an \f3\&.SF\fR extension +.TP 0.2i +\(bu +A signature block file with a \f3\&.DSA\fR, \f3\&.RSA\fR, or \f3\&.EC\fR extension +.PP +The base file names for these two files come from the value of the \f3-sigFile\fR option\&. For example, when the option is \f3-sigFile MKSIGN\fR, the files are named \f3MKSIGN\&.SF\fR and \f3MKSIGN\&.DSA\fR +.PP +If no \f3-sigfile\fR option appears on the command line, then the base file name for the \f3\&.SF\fR and \f3\&.DSA\fR files is the first 8 characters of the alias name specified on the command line, all converted to uppercase\&. If the alias name has fewer than 8 characters, then the full alias name is used\&. If the alias name contains any characters that are not allowed in a signature file name, then each such character is converted to an underscore (_) character in forming the file name\&. Valid characters include letters, digits, underscores, and hyphens\&. +.PP +Signature File + +A signature file (\f3\&.SF\fR file) looks similar to the manifest file that is always included in a JAR file when the \f3jarsigner\fR command is used to sign the file\&. For each source file included in the JAR file, the \f3\&.SF\fR file has three lines, such as in the manifest file, that list the following: +.TP 0.2i +\(bu +File name +.TP 0.2i +\(bu +Name of the digest algorithm (SHA) +.TP 0.2i +\(bu +SHA digest value +.PP +In the manifest file, the SHA digest value for each source file is the digest (hash) of the binary data in the source file\&. In the \f3\&.SF\fR file, the digest value for a specified source file is the hash of the three lines in the manifest file for the source file\&. +.PP +The signature file, by default, includes a header with a hash of the whole manifest file\&. The header also contains a hash of the manifest header\&. The presence of the header enables verification optimization\&. See JAR File Verification\&. +.PP +Signature Block File + +The \f3\&.SF\fR 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 that authenticates the public key corresponding to the private key used for signing\&. The file has the extension \f3\&.DSA\fR, \f3\&.RSA\fR, or \f3\&.EC\fR, depending on the digest algorithm used\&. +.SS SIGNATURE\ TIME\ STAMP +The \f3jarsigner\fR command can generate and store a signature time stamp when signing a JAR file\&. In addition, \f3jarsigner\fR supports alternative signing mechanisms\&. This behavior is optional and is controlled by the user at the time of signing through these options\&. See Options\&. +.sp +.nf +\f3\-tsa \fIurl\fR\fP +.fi +.nf +\f3\-tsacert \fIalias\fR\fP +.fi +.nf +\f3\-altsigner \fIclass\fR\fP +.fi +.nf +\f3\-altsignerpath \fIclasspathlist\fR\fP +.fi +.nf +\f3\-tsapolicyid \fIpolicyid\fR\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS JAR\ FILE\ VERIFICATION +A successful JAR file verification occurs when the signatures are valid, and none of the files that were in the JAR file when the signatures were generated have changed since then\&. JAR file verification involves the following steps: +.TP 0.4i +1\&. +Verify the signature of the \f3\&.SF\fR file\&. + +The verification ensures that the signature stored in each signature block (\f3\&.DSA\fR) file was generated using the private key corresponding to the public key whose certificate (or certificate chain) also appears in the \f3\&.DSA\fR file\&. It also ensures that the signature is a valid signature of the corresponding signature (\f3\&.SF\fR) file, and thus the \f3\&.SF\fR file was not tampered with\&. +.TP 0.4i +2\&. +Verify the digest listed in each entry in the \f3\&.SF\fR file with each corresponding section in the manifest\&. + +The \f3\&.SF\fR file by default includes a header that contains a hash of the entire manifest file\&. When the header is present, the verification can check to see whether or not the hash in the header matches the hash of the manifest file\&. If there is a match, then verification proceeds to the next step\&. + +If there is no match, then a less optimized verification is required to ensure that the hash in each source file information section in the \f3\&.SF\fR file equals the hash of its corresponding section in the manifest file\&. See Signature File\&. + +One reason the hash of the manifest file that is stored in the \f3\&.SF\fR file header might not equal the hash of the current manifest file is that one or more files were added to the JAR file (with the \f3jar\fR tool) after the signature and \f3\&.SF\fR file were generated\&. When the \f3jar\fR tool is used to add files, the manifest file is changed by adding sections to it for the new files, but the \f3\&.SF\fR file is not changed\&. A verification is still considered successful when none of the files that were in the JAR file when the signature was generated have been changed since then\&. This happens when the hashes in the non-header sections of the \f3\&.SF\fR file equal the hashes of the corresponding sections in the manifest file\&. +.TP 0.4i +3\&. +Read each file in the JAR file that has an entry in the \f3\&.SF\fR file\&. While reading, compute the file\&'s digest and compare the result with the digest for this file in the manifest section\&. The digests should be the same or verification fails\&. + +If any serious verification failures occur during the verification process, then the process is stopped and a security exception is thrown\&. The \f3jarsigner\fR command catches and displays the exception\&. +.PP +\fINote:\fR You should read any addition warnings (or errors if you specified the \f3-strict\fR option), as well as the content of the certificate (by specifying the \f3-verbose\fR and \f3-certs\fR options) to determine if the signature can be trusted\&. +.SS MULTIPLE\ SIGNATURES\ FOR\ A\ JAR\ FILE +A JAR file can be signed by multiple people by running the \f3jarsigner\fR command on the file multiple times and specifying the alias for a different person each time, as follows: +.sp +.nf +\f3jarsigner myBundle\&.jar susan\fP +.fi +.nf +\f3jarsigner myBundle\&.jar kevin\fP +.fi +.nf +\f3\fR +.fi +.sp +When a JAR file is signed multiple times, there are multiple \f3\&.SF\fR and \f3\&.DSA\fR files in the resulting JAR file, one pair for each signature\&. In the previous example, the output JAR file includes files with the following names: +.sp +.nf +\f3SUSAN\&.SF\fP +.fi +.nf +\f3SUSAN\&.DSA\fP +.fi +.nf +\f3KEVIN\&.SF\fP +.fi +.nf +\f3KEVIN\&.DSA\fP +.fi +.sp +.SH OPTIONS +The following sections describe the various \f3jarsigner\fR options\&. Be aware of the following standards: +.TP 0.2i +\(bu +All option names are preceded by a minus sign (-)\&. +.TP 0.2i +\(bu +The options can be provided in any order\&. +.TP 0.2i +\(bu +Items that are in italics or underlined (option values) represent the actual values that must be supplied\&. +.TP 0.2i +\(bu +The \f3-storepass\fR, \f3-keypass\fR, \f3-sigfile\fR, \f3-sigalg\fR, \f3-digestalg\fR, \f3-signedjar\fR, and TSA-related options are only relevant when signing a JAR file; they are not relevant when verifying a signed JAR file\&. The \f3-keystore\fR option is relevant for signing and verifying a JAR file\&. In addition, aliases are specified when signing and verifying a JAR file\&. +.TP +-keystore \fIurl\fR +.br +Specifies the URL that tells the keystore location\&. This defaults to the file \f3\&.keystore\fR in the user\&'s home directory, as determined by the \f3user\&.home\fR system property\&. + +A keystore is required when signing\&. You must explicitly specify a keystore when the default keystore does not exist or if you want to use one other than the default\&. + +A keystore is not required when verifying, but if one is specified or the default exists and the \f3-verbose\fR option was also specified, then additional information is output regarding whether or not any of the certificates used to verify the JAR file are contained in that keystore\&. + +The \f3-keystore\fR argument can be a file name and path specification rather than a URL, in which case it is treated the same as a file: URL, for example, the following are equivalent: +.sp +.nf +\f3\-keystore \fIfilePathAndName\fR\fP +.fi +.nf +\f3\-keystore file:\fIfilePathAndName\fR\fP +.fi +.nf +\f3\fR +.fi +.sp + + +If the Sun PKCS #11 provider was configured in the \f3java\&.security\fR security properties file (located in the JRE\&'s \f3$JAVA_HOME/lib/security directory\fR), then the \f3keytool\fR and \f3jarsigner\fR tools can operate on the PKCS #11 token by specifying these options: +.sp +.nf +\f3\-keystore NONE\fP +.fi +.nf +\f3\-storetype PKCS11\fP +.fi +.nf +\f3\fR +.fi +.sp + + +For example, the following command lists the contents of the configured PKCS#11 token: +.sp +.nf +\f3keytool \-keystore NONE \-storetype PKCS11 \-list\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-storetype \fIstoretype\fR +.br +Specifies the type of keystore to be instantiated\&. The default keystore type is the one that is specified as the value of the \f3keystore\&.type\fR property in the security properties file, which is returned by the static \f3getDefaultType\fR method in \f3java\&.security\&.KeyStore\fR\&. + +The PIN for a PCKS #11 token can also be specified with the \f3-storepass\fR option\&. If none is specified, then the \f3keytool\fR and \f3jarsigner\fR commands 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 \f3-protected\fR option must be specified and no password options can be specified\&. +.TP +-storepass[:env | :file] \fIargument\fR +.br +Specifies the password that is required to access the keystore\&. This is only needed when signing (not verifying) a JAR file\&. In that case, if a \f3-storepass\fR option is not provided at the command line, then the user is prompted for the password\&. + +If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the value \fIargument\fR\&. Otherwise, the password is retrieved as follows: +.RS +.TP 0.2i +\(bu +\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. +.TP 0.2i +\(bu +\f3file\fR: Retrieve the password from the file named \f3argument\fR\&. +.RE + + +\fINote:\fR The password should not be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system\&. +.TP +-keypass [:env | :file] \fIargument\fR +.br +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\fR to sign a JAR file\&. If no password is provided on the command line, and the required password is different from the store password, then the user is prompted for it\&. + +If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the value \f3argument\fR\&. Otherwise, the password is retrieved as follows: +.RS +.TP 0.2i +\(bu +\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. +.TP 0.2i +\(bu +\f3file\fR: Retrieve the password from the file named \f3argument\fR\&. +.RE + + +\fINote:\fR The password should not be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system\&. +.TP +-sigfile \fIfile\fR +.br +Specifies the base file name to be used for the generated \f3\&.SF\fR and \f3\&.DSA\fR files\&. For example, if file is \f3DUKESIGN\fR, then the generated \f3\&.SF\fR and \f3\&.DSA\fR files are named \f3DUKESIGN\&.SF\fR and \f3DUKESIGN\&.DSA\fR, and placed in the \f3META-INF\fR directory of the signed JAR file\&. + +The characters in the file must come from the set \f3a-zA-Z0-9_-\fR\&. Only letters, numbers, underscore, and hyphen characters are allowed\&. All lowercase characters are converted to uppercase for the \f3\&.SF\fR and \f3\&.DSA\fR file names\&. + +If no \f3-sigfile\fR option appears on the command line, then the base file name for the \f3\&.SF\fR and \f3\&.DSA\fR files is 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, then the full alias name is used\&. If the alias name contains any characters that are not valid in a signature file name, then each such character is converted to an underscore (_) character to form the file name\&. +.TP +-sigalg \fIalgorithm\fR +.br +Specifies the name of the signature algorithm to use to sign the JAR file\&. + +For a list of standard signature algorithm names, see "Appendix A: Standard Names" in the Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA + +This algorithm must be compatible with the private key used to sign the JAR file\&. If this option is not specified, then \f3SHA1withDSA\fR, \f3SHA256withRSA\fR, or \f3SHA256withECDSA\fR are 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 \f3-providerClass\fR option; otherwise, the command will not succeed\&. +.TP +-digestalg \fIalgorithm\fR +.br +Specifies the name of the message digest algorithm to use when digesting the entries of a JAR file\&. + +For a list of standard message digest algorithm names, see "Appendix A: Standard Names" in the Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA + +If this option is not specified, then \f3SHA256\fR is used\&. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f3-providerClass\fR option; otherwise, the command will not succeed\&. +.TP +-certs +.br +If the \f3-certs\fR option appears on the command line with the \f3-verify\fR and \f3-verbose\fR options, then the output includes certificate information for each signer of the JAR file\&. This information includes the name of the type of certificate (stored in the \f3\&.DSA\fR file) that certifies the signer\&'s public key, and if the certificate is an X\&.509 certificate (an instance of the \f3java\&.security\&.cert\&.X509Certificate\fR), then the distinguished name of the signer\&. + +The keystore is also examined\&. If no keystore value is specified on the command line, then the default keystore file (if any) is checked\&. If the public key certificate for a signer matches an entry in the keystore, then the alias name for the keystore entry for that signer is displayed in parentheses\&. +.TP +-certchain \fIfile\fR +.br +Specifies the certificate chain to be used when the certificate chain associated with the private key of the keystore entry that is addressed by the alias specified on the command line is not complete\&. This can happen when the keystore is located on a hardware token where there is not enough capacity to hold a complete certificate chain\&. The file can be a sequence of concatenated X\&.509 certificates, or a single PKCS#7 formatted data block, either in binary encoding format or in printable encoding format (also known as Base64 encoding) as defined by the Internet RFC 1421 standard\&. See Internet RFC 1421 Certificate Encoding Standard and http://tools\&.ietf\&.org/html/rfc1421\&. +.TP +-verbose +.br +When the \f3-verbose\fR option appears on the command line, it indicates verbose mode, which causes \f3jarsigner\fR to output extra information about the progress of the JAR signing or verification\&. +.TP +-internalsf +.br +In the past, the \f3\&.DSA\fR (signature block) file generated when a JAR file was signed included a complete encoded copy of the \f3\&.SF\fR file (signature file) also generated\&. This behavior has been changed\&. To reduce the overall size of the output JAR file, the \f3\&.DSA\fR file by default does not contain a copy of the \f3\&.SF\fR file anymore\&. If \f3-internalsf\fR appears on the command line, then the old behavior is utilized\&. This option is useful for testing\&. In practice, do not use the \f3-internalsf\fR option because it incurs higher overhead\&. +.TP +-sectionsonly +.br +If the \f3-sectionsonly\fR option appears on the command line, then the \f3\&.SF\fR file (signature file) generated when a JAR file is signed does not include a header that contains a hash of the whole manifest file\&. It contains only the information and hashes related to each individual source file included in the JAR file\&. See Signature File\&. + +By default, this header is added, as an optimization\&. When the header is present, whenever the JAR file is verified, the verification can first check to see whether the hash in the header matches the hash of the whole manifest file\&. When there is a match, verification proceeds to the next step\&. When there is no match, it is necessary to do a less optimized verification that the hash in each source file information section in the \f3\&.SF\fR file equals the hash of its corresponding section in the manifest file\&. See JAR File Verification\&. + +The \f3-sectionsonly\fR option is primarily used for testing\&. It should not be used other than for testing because using it incurs higher overhead\&. +.TP +-protected +.br +Values can be either \f3true\fR or \f3false\fR\&. Specify \f3true\fR when a password must be specified through a protected authentication path such as a dedicated PIN reader\&. +.TP +-providerClass \fIprovider-class-name\fR +.br +Used to specify the name of cryptographic service provider\&'s master class file when the service provider is not listed in the \f3java\&.security\fR security properties file\&. + +Used with the \f3-providerArg ConfigFilePath\fR option, the \f3keytool\fR and \f3jarsigner\fR tools install the provider dynamically and use \fIConfigFilePath\fR for the path to the token configuration file\&. The following example shows a command to list a \f3PKCS #11\fR keystore when the Oracle PKCS #11 provider was not configured in the security properties file\&. +.sp +.nf +\f3jarsigner \-keystore NONE \-storetype PKCS11 \e\fP +.fi +.nf +\f3 \-providerClass sun\&.security\&.pkcs11\&.SunPKCS11 \e\fP +.fi +.nf +\f3 \-providerArg /mydir1/mydir2/token\&.config \e\fP +.fi +.nf +\f3 \-list\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-providerName \fIproviderName\fR +.br +If more than one provider was configured in the \f3java\&.security\fR security properties file, then you can use the \f3-providerName\fR option to target a specific provider instance\&. The argument to this option is the name of the provider\&. + +For the Oracle PKCS #11 provider, \fIproviderName\fR is of the form \f3SunPKCS11-\fR\fITokenName\fR, where \fITokenName\fR is the name suffix that the provider instance has been configured with, as detailed in the configuration attributes table\&. For example, the following command lists the contents of the \f3PKCS #11\fR keystore provider instance with name suffix \f3SmartCard\fR: +.sp +.nf +\f3jarsigner \-keystore NONE \-storetype PKCS11 \e\fP +.fi +.nf +\f3 \-providerName SunPKCS11\-SmartCard \e\fP +.fi +.nf +\f3 \-list\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-J\fIjavaoption\fR +.br +Passes through the specified \fIjavaoption\fR string directly to the Java interpreter\&. The \f3jarsigner\fR command is 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 \f3java -h\fR or \f3java -X\fR at the command line\&. +.TP +-tsa \fIurl\fR +.br +If \f3-tsa http://example\&.tsa\&.url\fR appears on the command line when signing a JAR file then a time stamp is generated for the signature\&. The URL, \f3http://example\&.tsa\&.url\fR, identifies the location of the Time Stamping Authority (TSA) and overrides any URL found with the \f3-tsacert\fR option\&. The \f3-tsa\fR option does not require the TSA public key certificate to be present in the keystore\&. + +To generate the time stamp, \f3jarsigner\fR communicates with the TSA with the Time-Stamp Protocol (TSP) defined in RFC 3161\&. When successful, the time stamp token returned by the TSA is stored with the signature in the signature block file\&. +.TP +-tsacert \fIalias\fR +.br +When \f3-tsacert alias\fR appears on the command line when signing a JAR file, a time stamp is generated for the signature\&. The alias identifies the TSA public key certificate in the keystore that is in effect\&. The entry\&'s certificate is examined for a Subject Information Access extension that contains a URL identifying the location of the TSA\&. + +The TSA public key certificate must be present in the keystore when using the \f3-tsacert\fR option\&. +.TP +-tsapolicyid \fIpolicyid\fR +.br +Specifies the object identifier (OID) that identifies the policy ID to be sent to the TSA server\&. If this option is not specified, no policy ID is sent and the TSA server will choose a default policy ID\&. + +Object identifiers are defined by X\&.696, which is an ITU Telecommunication Standardization Sector (ITU-T) standard\&. These identifiers are typically period-separated sets of non-negative digits like \f31\&.2\&.3\&.4\fR, for example\&. +.TP +-altsigner \fIclass\fR +.br +This option specifies an alternative signing mechanism\&. The fully qualified class name identifies a class file that extends the \f3com\&.sun\&.jarsigner\&.ContentSigner\fR abstract class\&. The path to this class file is defined by the \f3-altsignerpath\fR option\&. If the \f3-altsigner\fR option is used, then the \f3jarsigner\fR command uses the signing mechanism provided by the specified class\&. Otherwise, the \f3jarsigner\fR command uses its default signing mechanism\&. + +For example, to use the signing mechanism provided by a class named \f3com\&.sun\&.sun\&.jarsigner\&.AuthSigner\fR, use the jarsigner option \f3-altsigner com\&.sun\&.jarsigner\&.AuthSigner\fR\&. +.TP +-altsignerpath \fIclasspathlist\fR +.br +Specifies the path to the class file and any JAR file it depends on\&. The class file name is specified with the \f3-altsigner\fR option\&. If the class file is in a JAR file, then this option specifies the path to that JAR file\&. + +An absolute path or a path relative to the current directory can be specified\&. If \fIclasspathlist\fR contains multiple paths or JAR files, then they should be separated with a colon (:) on Oracle Solaris and a semicolon (;) on Windows\&. This option is not necessary when the class is already in the search path\&. + +The following example shows how to specify the path to a JAR file that contains the class file\&. The JAR file name is included\&. +.sp +.nf +\f3\-altsignerpath /home/user/lib/authsigner\&.jar\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The following example shows how to specify the path to the JAR file that contains the class file\&. The JAR file name is omitted\&. +.sp +.nf +\f3\-altsignerpath /home/user/classes/com/sun/tools/jarsigner/\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-strict +.br +During the signing or verifying process, the command may issue warning messages\&. If you specify this option, the exit code of the tool reflects the severe warning messages that this command found\&. See Errors and Warnings\&. +.TP +-verbose \fIsuboptions\fR +.br +For the verifying process, the \f3-verbose\fR option takes suboptions to determine how much information is shown\&. If the \f3-certs\fR option is also specified, then the default mode (or suboption \f3all\fR) displays each entry as it is being processed, and after that, the certificate information for each signer of the JAR file\&. If the \f3-certs\fR and the \f3-verbose:grouped\fR suboptions are specified, then entries with the same signer info are grouped and displayed together with their certificate information\&. If \f3-certs\fR and the \f3-verbose:summary\fR suboptions are specified, then entries with the same signer information are grouped and displayed together with their certificate information\&. Details about each entry are summarized and displayed as \fIone entry (and more)\fR\&. See Examples\&. +.SH ERRORS\ AND\ WARNINGS +During the signing or verifying process, the \f3jarsigner\fR command may issue various errors or warnings\&. +.PP +If there is a failure, the \f3jarsigner\fR command exits with code 1\&. If there is no failure, but there are one or more severe warnings, the \f3jarsigner\fR command exits with code 0 when the \f3-strict\fR option is \fInot\fR specified, or exits with the OR-value of the warning codes when the \f3-strict\fR is specified\&. If there is only informational warnings or no warning at all, the command always exits with code 0\&. +.PP +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, the \f3jarsigner\fR command exits with code 12 (=4+8) when the \f3-strict\fR option is specified\&. +.PP +\fINote:\fR Exit codes are reused because only the values from 0 to 255 are legal on Unix-based operating systems\&. +.PP +The following sections describes the names, codes, and descriptions of the errors and warnings that the \f3jarsigner\fR command can issue\&. +.SS FAILURE +Reasons why the \f3jarsigner\fR command fails include (but are not limited to) a command line parsing error, the inability to find a keypair to sign the JAR file, or the verification of a signed JAR fails\&. +.TP +failure +Code 1\&. The signing or verifying fails\&. +.SS SEVERE\ WARNINGS +\fINote:\fR Severe warnings are reported as errors if you specify the \f3-strict\fR option\&. +.PP +Reasons why the \f3jarsigner\fR command issues a severe warning include the certificate used to sign the JAR file has an error or the signed JAR file has other problems\&. +.TP +hasExpiredCert +Code 4\&. This jar contains entries whose signer certificate has expired\&. +.TP +notYetValidCert +Code 4\&. This jar contains entries whose signer certificate is not yet valid\&. +.TP +chainNotValidated +Code 4\&. This jar contains entries whose certificate chain cannot be correctly validated\&. +.TP +badKeyUsage +Code 8\&. This jar contains entries whose signer certificate\&'s KeyUsage extension doesn\&'t allow code signing\&. +.TP +badExtendedKeyUsage +Code 8\&. This jar contains entries whose signer certificate\&'s ExtendedKeyUsage extension doesn\&'t allow code signing\&. +.TP +badNetscapeCertType +Code 8\&. This jar contains entries whose signer certificate\&'s NetscapeCertType extension doesn\&'t allow code signing\&. +.TP +hasUnsignedEntry +Code 16\&. This jar contains unsigned entries which have not been integrity-checked\&. +.TP +notSignedByAlias +Code 32\&. This jar contains signed entries which are not signed by the specified alias(es)\&. +.TP +aliasNotInStore +Code 32\&. This jar contains signed entries that are not signed by alias in this keystore\&. +.SS INFORMATIONAL\ WARNINGS +Informational warnings include those that are not errors but regarded as bad practice\&. They do not have a code\&. +.TP +hasExpiringCert +This jar contains entries whose signer certificate will expire within six months\&. +.TP +noTimestamp +This jar contains signatures that does not include a timestamp\&. Without a timestamp, users may not be able to validate this JAR file after the signer certificate\&'s expiration date (\f3YYYY-MM-DD\fR) or after any future revocation date\&. +.SH EXAMPLES +.SS SIGN\ A\ JAR\ FILE +Use the following command to sign bundle\&.jar with the private key of a user whose keystore alias is \f3jane\fR in a keystore named \f3mystore\fR in the \f3working\fR directory and name the signed JAR file \f3sbundle\&.jar\fR: +.sp +.nf +\f3jarsigner \-keystore /working/mystore\fP +.fi +.nf +\f3 \-storepass <keystore password>\fP +.fi +.nf +\f3 \-keypass <private key password>\fP +.fi +.nf +\f3 \-signedjar sbundle\&.jar bundle\&.jar jane\fP +.fi +.nf +\f3\fR +.fi +.sp +There is no \f3-sigfile\fR specified in the previous command so the generated \f3\&.SF\fR and \f3\&.DSA\fR files to be placed in the signed JAR file have default names based on the alias name\&. They are named \f3JANE\&.SF\fR and \f3JANE\&.DSA\fR\&. +.PP +If you want to be prompted for the store password and the private key password, then you could shorten the previous command to the following: +.sp +.nf +\f3jarsigner \-keystore /working/mystore\fP +.fi +.nf +\f3 \-signedjar sbundle\&.jar bundle\&.jar jane\fP +.fi +.nf +\f3\fR +.fi +.sp +If the keystore is the default keystore (\&.keystore in your home directory), then you do not need to specify a keystore, as follows: +.sp +.nf +\f3jarsigner \-signedjar sbundle\&.jar bundle\&.jar jane\fP +.fi +.nf +\f3\fR +.fi +.sp +If you want the signed JAR file to overwrite the input JAR file (bundle\&.jar), then you do not need to specify a \f3-signedjar\fR option, as follows: +.sp +.nf +\f3jarsigner bundle\&.jar jane\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS VERIFY\ A\ SIGNED\ JAR\ FILE +To verify a signed JAR file to ensure that the signature is valid and the JAR file was not been tampered with, use a command such as the following: +.sp +.nf +\f3jarsigner \-verify sbundle\&.jar\fP +.fi +.nf +\f3\fR +.fi +.sp +When the verification is successful, \f3jar verified\fR is displayed\&. Otherwise, an error message is displayed\&. You can get more information when you use the \f3-verbose\fR option\&. A sample use of \f3jarsigner\fR with the\f3-verbose\fR option follows: +.sp +.nf +\f3jarsigner \-verify \-verbose sbundle\&.jar\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.SF\fP +.fi +.nf +\f3 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.DSA\fP +.fi +.nf +\f3 smk 2752 Fri Sep 26 16:12:30 PDT 1997 AclEx\&.class\fP +.fi +.nf +\f3 smk 849 Fri Sep 26 16:12:46 PDT 1997 test\&.class\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 s = signature was verified\fP +.fi +.nf +\f3 m = entry is listed in manifest\fP +.fi +.nf +\f3 k = at least one certificate was found in keystore\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 jar verified\&.\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS VERIFICATION\ WITH\ CERTIFICATE\ INFORMATION +If you specify the \f3-certs\fR option with the \f3-verify\fR and \f3-verbose\fR options, then the output includes certificate information for each signer of the JAR file\&. The information includes the certificate type, the signer distinguished name information (when it is an X\&.509 certificate), and in parentheses, the keystore alias for the signer when the public key certificate in the JAR file matches the one in a keystore entry, for example: +.sp +.nf +\f3jarsigner \-keystore /working/mystore \-verify \-verbose \-certs myTest\&.jar\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.SF\fP +.fi +.nf +\f3 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.DSA\fP +.fi +.nf +\f3 208 Fri Sep 26 16:23:30 PDT 1997 META\-INF/JAVATEST\&.SF\fP +.fi +.nf +\f3 1087 Fri Sep 26 16:23:30 PDT 1997 META\-INF/JAVATEST\&.DSA\fP +.fi +.nf +\f3 smk 2752 Fri Sep 26 16:12:30 PDT 1997 Tst\&.class\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 X\&.509, CN=Test Group, OU=Java Software, O=Oracle, L=CUP, S=CA, C=US (javatest)\fP +.fi +.nf +\f3 X\&.509, CN=Jane Smith, OU=Java Software, O=Oracle, L=cup, S=ca, C=us (jane)\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 s = signature was verified\fP +.fi +.nf +\f3 m = entry is listed in manifest\fP +.fi +.nf +\f3 k = at least one certificate was found in keystore\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 jar verified\&.\fP +.fi +.nf +\f3\fR +.fi +.sp +If the certificate for a signer is not an X\&.509 certificate, then there is no distinguished name information\&. In that case, just the certificate type and the alias are shown\&. For example, if the certificate is a PGP certificate, and the alias is \f3bob\fR, then you would get: \f3PGP, (bob)\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +keytool(1) +.TP 0.2i +\(bu +Trail: Security Features in Java SE at http://docs\&.oracle\&.com/javase/tutorial/security/index\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/java.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/java.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/bsd/doc/man/javac.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/javac.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,1369 +1,1369 @@ -'\" t -.\" Copyright (c) 1994, 2015, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 03 March 2015 -.\" SectDesc: Basic Tools -.\" Title: javac.1 -.\" -.if n .pl 99999 -.TH javac 1 "03 March 2015" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -javac \- Reads Java class and interface definitions and compiles them into bytecode and class files\&. -.SH SYNOPSIS -.sp -.nf - -\fBjavac\fR [ \fIoptions\fR ] [ \fIsourcefiles\fR ] [ \fIclasses\fR] [ \fI@argfiles\fR ] -.fi -.sp -Arguments can be in any order: -.TP -\fIoptions\fR -Command-line options\&. See Options\&. -.TP -\fIsourcefiles\fR -One or more source files to be compiled (such as \f3MyClass\&.java\fR)\&. -.TP -\fIclasses\fR -One or more classes to be processed for annotations (such as \f3MyPackage\&.MyClass\fR)\&. -.TP -\fI@argfiles\fR -One or more files that list options and source files\&. The \f3-J\fR options are not allowed in these files\&. See Command-Line Argument Files\&. -.SH DESCRIPTION -The \f3javac\fR command reads class and interface definitions, written in the Java programming language, and compiles them into bytecode class files\&. The \f3javac\fR command can also process annotations in Java source files and classes\&. -.PP -There are two ways to pass source code file names to \f3javac\fR\&. -.TP 0.2i -\(bu -For a small number of source files, list the file names on the command line\&. -.TP 0.2i -\(bu -For a large number of source files, list the file names in a file that is separated by blanks or line breaks\&. Use the list file name preceded by an at sign (@) with the \f3javac\fR command\&. -.PP -Source code file names must have \&.java suffixes, class file names must have \&.class suffixes, and both source and class files must have root names that identify the class\&. For example, a class called \f3MyClass\fR would be written in a source file called \f3MyClass\&.java\fR and compiled into a bytecode class file called \f3MyClass\&.class\fR\&. -.PP -Inner class definitions produce additional class files\&. These class files have names that combine the inner and outer class names, such as \f3MyClass$MyInnerClass\&.class\fR\&. -.PP -Arrange source files in a directory tree that reflects their package tree\&. For example, if all of your source files are in \f3/workspace\fR, then put the source code for \f3com\&.mysoft\&.mypack\&.MyClass\fR in \f3/workspace/com/mysoft/mypack/MyClass\&.java\fR\&. -.PP -By default, the compiler puts each class file in the same directory as its source file\&. You can specify a separate destination directory with the \f3-d\fR option\&. -.SH OPTIONS -The compiler has a set of standard options that are supported on the current development environment\&. An additional set of nonstandard options are specific to the current virtual machine and compiler implementations and are subject to change in the future\&. Nonstandard options begin with the \f3-X\fR option\&. -.TP 0.2i -\(bu -See also Cross-Compilation Options -.TP 0.2i -\(bu -See also Nonstandard Options -.SS STANDARD\ OPTIONS -.TP --A\fIkey\fR[\fI=value\fR] -.br -Specifies options to pass to annotation processors\&. These options are not interpreted by \f3javac\fR directly, but are made available for use by individual processors\&. The \f3key\fR value should be one or more identifiers separated by a dot (\&.)\&. -.TP --cp \fIpath\fR or -classpath \fIpath\fR -.br -Specifies where to find user class files, and (optionally) annotation processors and source files\&. This class path overrides the user class path in the \f3CLASSPATH\fR environment variable\&. If neither \f3CLASSPATH\fR, \f3-cp\fR nor \f3-classpath\fR is specified, then the user \fIclass path\fR is the current directory\&. See Setting the Class Path\&. - -If the \f3-sourcepath\fR option is not specified, then the user class path is also searched for source files\&. - -If the \f3-processorpath\fR option is not specified, then the class path is also searched for annotation processors\&. -.TP --Djava\&.ext\&.dirs=\fIdirectories\fR -.br -Overrides the location of installed extensions\&. -.TP --Djava\&.endorsed\&.dirs=\fIdirectories\fR -.br -Overrides the location of the endorsed standards path\&. -.TP --d \fIdirectory\fR -.br -Sets the destination directory for class files\&. The directory must already exist because \f3javac\fR does not create it\&. If a class is part of a package, then \f3javac\fR puts the class file in a subdirectory that reflects the package name and creates directories as needed\&. - -If you specify \f3-d\fR\f3/home/myclasses\fR and the class is called \f3com\&.mypackage\&.MyClass\fR, then the class file is \f3/home/myclasses/com/mypackage/MyClass\&.class\fR\&. - -If the \fI-d\fR option is not specified, then \f3javac\fR puts each class file in the same directory as the source file from which it was generated\&. - -\fINote:\fR The directory specified by the \fI-d\fR option is not automatically added to your user class path\&. -.TP --deprecation -.br -Shows a description of each use or override of a deprecated member or class\&. Without the \f3-deprecation\fR option, \f3javac\fR shows a summary of the source files that use or override deprecated members or classes\&. The \f3-deprecation\fR option is shorthand for \f3-Xlint:deprecation\fR\&. -.TP --encoding \fIencoding\fR -.br -Sets the source file encoding name, such as EUC-JP and UTF-8\&. If the \f3-encoding\fR option is not specified, then the platform default converter is used\&. -.TP --endorseddirs \fIdirectories\fR -.br -Overrides the location of the endorsed standards path\&. -.TP --extdirs \fIdirectories\fR -.br -Overrides the location of the \f3ext\fR directory\&. The directories variable is a colon-separated list of directories\&. Each JAR file in the specified directories is searched for class files\&. All JAR files found become part of the class path\&. - -If you are cross-compiling (compiling classes against bootstrap and extension classes of a different Java platform implementation), then this option specifies the directories that contain the extension classes\&. See Cross-Compilation Options for more information\&. -.TP --g -.br -Generates all debugging information, including local variables\&. By default, only line number and source file information is generated\&. -.TP --g:none -.br -Does not generate any debugging information\&. -.TP --g:[\fIkeyword list\fR] -.br -Generates only some kinds of debugging information, specified by a comma separated list of keywords\&. Valid keywords are: -.RS -.TP -source -Source file debugging information\&. -.TP -lines -Line number debugging information\&. -.TP -vars -Local variable debugging information\&. -.RE - -.TP --help -.br -Prints a synopsis of standard options\&. -.TP --implicit:[\fIclass, none\fR] -.br -Controls the generation of class files for implicitly loaded source files\&. To automatically generate class files, use \f3-implicit:class\fR\&. To suppress class file generation, use \f3-implicit:none\fR\&. If this option is not specified, then the default is to automatically generate class files\&. In this case, the compiler issues a warning if any such class files are generated when also doing annotation processing\&. The warning is not issued when the \f3-implicit\fR option is set explicitly\&. See Searching for Types\&. -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. - -\fINote:\fR The \fICLASSPATH\fR, \f3-classpath\fR, \f3-bootclasspath\fR, and \f3-extdirs\fR options do not specify the classes used to run \f3javac\fR\&. Trying to customize the compiler implementation with these options and variables is risky and often does not accomplish what you want\&. If you must customize the complier implementation, then use the \f3-J\fR option to pass options through to the underlying \f3\fRJava launcher\&. -.TP --nowarn -.br -Disables warning messages\&. This option operates the same as the \f3-Xlint:none\fR option\&. -.TP --parameters -.br -Stores formal parameter names of constructors and methods in the generated class file so that the method \f3java\&.lang\&.reflect\&.Executable\&.getParameters\fR from the Reflection API can retrieve them\&. -.TP --proc: [\fInone\fR, \fIonly\fR] -.br -Controls whether annotation processing and compilation are done\&. \f3-proc:none\fR means that compilation takes place without annotation processing\&. \f3-proc:only\fR means that only annotation processing is done, without any subsequent compilation\&. -.TP --processor \fIclass1\fR [,\fIclass2\fR,\fIclass3\fR\&.\&.\&.] -.br -Names of the annotation processors to run\&. This bypasses the default discovery process\&. -.TP --processorpath \fIpath\fR -.br -Specifies where to find annotation processors\&. If this option is not used, then the class path is searched for processors\&. -.TP --s \fIdir\fR -.br -Specifies the directory where to place the generated source files\&. The directory must already exist because \f3javac\fR does not create it\&. If a class is part of a package, then the compiler puts the source file in a subdirectory that reflects the package name and creates directories as needed\&. - -If you specify \f3-s /home/mysrc\fR and the class is called \f3com\&.mypackage\&.MyClass\fR, then the source file is put in \f3/home/mysrc/com/mypackage/MyClass\&.java\fR\&. -.TP --source \fIrelease\fR -.br -Specifies the version of source code accepted\&. The following values for \f3release\fR are allowed: -.RS -.TP -1\&.3 -The compiler does not support assertions, generics, or other language features introduced after Java SE 1\&.3\&. -.TP -1\&.4 -The compiler accepts code containing assertions, which were introduced in Java SE 1\&.4\&. -.TP -1\&.5 -The compiler accepts code containing generics and other language features introduced in Java SE 5\&. -.TP -5 -Synonym for 1\&.5\&. -.TP -1\&.6 -No language changes were introduced in Java SE 6\&. However, encoding errors in source files are now reported as errors instead of warnings as in earlier releases of Java Platform, Standard Edition\&. -.TP -6 -Synonym for 1\&.6\&. -.TP -1\&.7 -The compiler accepts code with features introduced in Java SE 7\&. -.TP -7 -Synonym for 1\&.7\&. -.TP -1\&.8 -This is the default value\&. The compiler accepts code with features introduced in Java SE 8\&. -.TP -8 -Synonym for 1\&.8\&. -.RE - -.TP --sourcepath \fIsourcepath\fR -.br -Specifies the source code path to search for class or interface definitions\&. As with the user class path, source path entries are separated by colons (:) on Oracle Solaris and semicolons on Windows and can be directories, JAR archives, or ZIP archives\&. If packages are used, then the local path name within the directory or archive must reflect the package name\&. - -\fINote:\fR Classes found through the class path might be recompiled when their source files are also found\&. See Searching for Types\&. -.TP --verbose -.br -Uses verbose output, which includes information about each class loaded and each source file compiled\&. -.TP --version -.br -Prints release information\&. -.TP --werror -.br -Terminates compilation when warnings occur\&. -.TP --X -.br -Displays information about nonstandard options and exits\&. -.SS CROSS-COMPILATION\ OPTIONS -By default, classes are compiled against the bootstrap and extension classes of the platform that \f3javac\fR shipped with\&. But \f3javac\fR also supports cross-compiling, where classes are compiled against a bootstrap and extension classes of a different Java platform implementation\&. It is important to use the \f3-bootclasspath\fR and \f3-extdirs\fR options when cross-compiling\&. -.TP --target \fIversion\fR -.br -Generates class files that target a specified release of the virtual machine\&. Class files will run on the specified target and on later releases, but not on earlier releases of the JVM\&. Valid targets are 1\&.1, 1\&.2, 1\&.3, 1\&.4, 1\&.5 (also 5), 1\&.6 (also 6), 1\&.7 (also 7), and 1\&.8 (also 8)\&. - -The default for the \f3-target\fR option depends on the value of the \f3-source\fR option: -.RS -.TP 0.2i -\(bu -If the \f3-source\fR option is not specified, then the value of the \f3-target\fR option is 1\&.8 -.TP 0.2i -\(bu -If the \f3-source\fR option is 1\&.2, then the value of the \f3-target\fR option is 1\&.4 -.TP 0.2i -\(bu -If the \f3-source\fR option is 1\&.3, then the value of the \f3-target\fR option is 1\&.4 -.TP 0.2i -\(bu -If the \f3-source\fR option is 1\&.5, then the value of the \f3-target\fR option is 1\&.8 -.TP 0.2i -\(bu -If the \f3-source\fR option is 1\&.6, then the value of the \f3-target\fR is option 1\&.8 -.TP 0.2i -\(bu -If the \f3-source\fR option is 1\&.7, then the value of the \f3-target\fR is option 1\&.8 -.TP 0.2i -\(bu -For all other values of the \f3-source\fR option, the value of the \f3-target\fR option is the value of the \f3-source\fR option\&. -.RE - -.TP --bootclasspath \fIbootclasspath\fR -.br -Cross-compiles against the specified set of boot classes\&. As with the user class path, boot class path entries are separated by colons (:) and can be directories, JAR archives, or ZIP archives\&. -.SS COMPACT\ PROFILE\ OPTION -Beginning with JDK 8, the \f3javac\fR compiler supports compact profiles\&. With compact profiles, applications that do not require the entire Java platform can be deployed and run with a smaller footprint\&. The compact profiles feature could be used to shorten the download time for applications from app stores\&. This feature makes for more compact deployment of Java applications that bundle the JRE\&. This feature is also useful in small devices\&. -.PP -The supported profile values are \f3compact1\fR, \f3compact2\fR, and \f3compact3\fR\&. These are additive layers\&. Each higher-numbered compact profile contains all of the APIs in profiles with smaller number names\&. -.TP --profile -.br -When using compact profiles, this option specifies the profile name when compiling\&. For example: -.sp -.nf -\f3javac \-profile compact1 Hello\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp - - -javac does not compile source code that uses any Java SE APIs that is not in the specified profile\&. Here is an example of the error message that results from attempting to compile such source code: -.sp -.nf -\f3cd jdk1\&.8\&.0/bin\fP -.fi -.nf -\f3\&./javac \-profile compact1 Paint\&.java\fP -.fi -.nf -\f3Paint\&.java:5: error: Applet is not available in profile \&'compact1\&'\fP -.fi -.nf -\f3import java\&.applet\&.Applet;\fP -.fi -.nf -\f3\fP -.fi -.sp - - -In this example, you can correct the error by modifying the source to not use the \f3Applet\fR class\&. You could also correct the error by compiling without the -profile option\&. Then the compilation would be run against the full set of Java SE APIs\&. (None of the compact profiles include the \f3Applet\fR class\&.) - -An alternative way to compile with compact profiles is to use the \f3-bootclasspath\fR option to specify a path to an \f3rt\&.jar\fR file that specifies a profile\&'s image\&. Using the \f3-profile\fR option instead does not require a profile image to be present on the system at compile time\&. This is useful when cross-compiling\&. -.SS NONSTANDARD\ OPTIONS -.TP --Xbootclasspath/p:\fIpath\fR -.br -Adds a suffix to the bootstrap class path\&. -.TP --Xbootclasspath/a:\fIpath\fR -.br -Adds a prefix to the bootstrap class path\&. -.TP --Xbootclasspath/:\fIpath\fR -.br -Overrides the location of the bootstrap class files\&. -.TP --Xdoclint:[-]\fIgroup\fR [\fI/access\fR] -.br -Enables or disables specific groups of checks, where \fIgroup\fR is one of the following values: \f3accessibility\fR, \f3syntax\fR, \f3reference\fR, \f3html\fR or \f3missing\fR\&. For more information about these groups of checks see the \f3-Xdoclint\fR option of the \f3javadoc\fR command\&. The \f3-Xdoclint\fR option is disabled by default in the \f3javac\fR command\&. - -The variable \fIaccess\fR specifies the minimum visibility level of classes and members that the \f3-Xdoclint\fR option checks\&. It can have one of the following values (in order of most to least visible) : \f3public\fR, \f3protected\fR, \f3package\fR and \f3private\fR\&. For example, the following option checks classes and members (with all groups of checks) that have the access level protected and higher (which includes protected, package and public): -.sp -.nf -\f3\-Xdoclint:all/protected\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The following option enables all groups of checks for all access levels, except it will not check for HTML errors for classes and members that have access level package and higher (which includes package and public): -.sp -.nf -\f3\-Xdoclint:all,\-html/package\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --Xdoclint:none -.br -Disables all groups of checks\&. -.TP --Xdoclint:all[\fI/access\fR] -.br -Enables all groups of checks\&. -.TP --Xlint -.br -\fI\fREnables all recommended warnings\&. In this release, enabling all available warnings is recommended\&. -.TP --Xlint:all -.br -\fI\fREnables all recommended warnings\&. In this release, enabling all available warnings is recommended\&. -.TP --Xlint:none -.br -Disables all warnings\&. -.TP --Xlint:\fIname\fR -.br -Disables warning name\&. See Enable or Disable Warnings with the -Xlint Option for a list of warnings you can disable with this option\&. -.TP --Xlint:\fI-name\fR -.br -Disables warning name\&. See Enable or Disable Warnings with the -Xlint Option with the \f3-Xlint\fR option to get a list of warnings that you can disable with this option\&. -.TP --Xmaxerrs \fInumber\fR -.br -Sets the maximum number of errors to print\&. -.TP --Xmaxwarns \fInumber\fR -.br -Sets the maximum number of warnings to print\&. -.TP --Xstdout \fIfilename\fR -.br -Sends compiler messages to the named file\&. By default, compiler messages go to \f3System\&.err\fR\&. -.TP --Xprefer:[\fInewer,source\fR] -.br -Specifies which file to read when both a source file and class file are found for a type\&. (See Searching for Types)\&. If the \f3-Xprefer:newer\fR option is used, then it reads the newer of the source or class file for a type (default)\&. If the \f3-Xprefer:source\fR option is used, then it reads the source file\&. Use -\f3Xprefer:source\fR when you want to be sure that any annotation processors can access annotations declared with a retention policy of \f3SOURCE\fR\&. -.TP --Xpkginfo:[\fIalways\fR,\fIlegacy\fR,\fInonempty\fR] -.br -Control whether javac generates \f3package-info\&.class\fR files from package-info\&.java files\&. Possible mode arguments for this option include the following\&. -.RS -.TP -always -Always generate a \f3package-info\&.class\fR file for every \f3package-info\&.java\fR file\&. This option may be useful if you use a build system such as Ant, which checks that each \f3\&.java\fR file has a corresponding \f3\&.class\fR file\&. -.TP -legacy -Generate a \f3package-info\&.class\fR file only if package-info\&.java contains annotations\&. Don\&'t generate a \f3package-info\&.class\fR file if package-info\&.java only contains comments\&. - -\fINote:\fR A \f3package-info\&.class\fR file might be generated but be empty if all the annotations in the package-info\&.java file have \f3RetentionPolicy\&.SOURCE\fR\&. -.TP -nonempty -Generate a \f3package-info\&.class\fR file only if package-info\&.java contains annotations with \f3RetentionPolicy\&.CLASS\fR or \f3RetentionPolicy\&.RUNTIME\fR\&. -.RE - -.TP --Xprint -.br -Prints a textual representation of specified types for debugging purposes\&. Perform neither annotation processing nor compilation\&. The format of the output could change\&. -.TP --XprintProcessorInfo -.br -Prints information about which annotations a processor is asked to process\&. -.TP --XprintRounds -.br -Prints information about initial and subsequent annotation processing rounds\&. -.SH ENABLE\ OR\ DISABLE\ WARNINGS\ WITH\ THE\ -XLINT\ OPTION -Enable warning \fIname\fR with the \f3-Xlint:name\fR option, where \f3name\fR is one of the following warning names\&. Note that you can disable a warning with the \f3-Xlint:-name:\fR option\&. -.TP -cast -Warns about unnecessary and redundant casts, for example: -.sp -.nf -\f3String s = (String) "Hello!"\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -classfile -Warns about issues related to class file contents\&. -.TP -deprecation -Warns about the use of deprecated items, for example: -.sp -.nf -\f3java\&.util\&.Date myDate = new java\&.util\&.Date();\fP -.fi -.nf -\f3int currentDay = myDate\&.getDay();\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The method \f3java\&.util\&.Date\&.getDay\fR has been deprecated since JDK 1\&.1 -.TP -dep-ann -Warns about items that are documented with an \f3@deprecated\fR Javadoc comment, but do not have a \f3@Deprecated\fR annotation, for example: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * @deprecated As of Java SE 7, replaced by {@link #newMethod()}\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3public static void deprecatedMethood() { }\fP -.fi -.nf -\f3public static void newMethod() { }\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -divzero -Warns about division by the constant integer 0, for example: -.sp -.nf -\f3int divideByZero = 42 / 0;\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -empty -Warns about empty statements after \f3if\fRstatements, for example: -.sp -.nf -\f3class E {\fP -.fi -.nf -\f3 void m() {\fP -.fi -.nf -\f3 if (true) ;\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -fallthrough -Checks the switch blocks for fall-through cases and provides a warning message for any that are found\&. Fall-through cases are cases in a switch block, other than the last case in the block, whose code does not include a break statement, allowing code execution to fall through from that case to the next case\&. For example, the code following the case 1 label in this switch block does not end with a break statement: -.sp -.nf -\f3switch (x) {\fP -.fi -.nf -\f3case 1:\fP -.fi -.nf -\f3 System\&.out\&.println("1");\fP -.fi -.nf -\f3 // No break statement here\&.\fP -.fi -.nf -\f3case 2:\fP -.fi -.nf -\f3 System\&.out\&.println("2");\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - - -If the \f3-Xlint:fallthrough\fR option was used when compiling this code, then the compiler emits a warning about possible fall-through into case, with the line number of the case in question\&. -.TP -finally -Warns about \f3finally\fR clauses that cannot complete normally, for example: -.sp -.nf -\f3public static int m() {\fP -.fi -.nf -\f3 try {\fP -.fi -.nf -\f3 throw new NullPointerException();\fP -.fi -.nf -\f3 } catch (NullPointerException(); {\fP -.fi -.nf -\f3 System\&.err\&.println("Caught NullPointerException\&.");\fP -.fi -.nf -\f3 return 1;\fP -.fi -.nf -\f3 } finally {\fP -.fi -.nf -\f3 return 0;\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The compiler generates a warning for the \f3finally\fR block in this example\&. When the \f3int\fR method is called, it returns a value of 0\&. A \f3finally\fR block executes when the \f3try\fR block exits\&. In this example, when control is transferred to the \f3catch\fR block, the \f3int\fR method exits\&. However, the \f3finally\fR block must execute, so it is executed, even though control was transferred outside the method\&. -.TP -options -Warns about issues that related to the use of command-line options\&. See Cross-Compilation Options\&. -.TP -overrides -Warns about issues regarding method overrides\&. For example, consider the following two classes: -.sp -.nf -\f3public class ClassWithVarargsMethod {\fP -.fi -.nf -\f3 void varargsMethod(String\&.\&.\&. s) { }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3public class ClassWithOverridingMethod extends ClassWithVarargsMethod {\fP -.fi -.nf -\f3 @Override\fP -.fi -.nf -\f3 void varargsMethod(String[] s) { }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The compiler generates a warning similar to the following:\&. -.sp -.nf -\f3warning: [override] varargsMethod(String[]) in ClassWithOverridingMethod \fP -.fi -.nf -\f3overrides varargsMethod(String\&.\&.\&.) in ClassWithVarargsMethod; overriding\fP -.fi -.nf -\f3method is missing \&'\&.\&.\&.\&'\fP -.fi -.nf -\f3\fP -.fi -.sp - - -When the compiler encounters a \f3varargs\fR method, it translates the \f3varargs\fR formal parameter into an array\&. In the method \f3ClassWithVarargsMethod\&.varargsMethod\fR, the compiler translates the \f3varargs\fR formal parameter \f3String\&.\&.\&. s\fR to the formal parameter \f3String[] s\fR, an array, which matches the formal parameter of the method \f3ClassWithOverridingMethod\&.varargsMethod\fR\&. Consequently, this example compiles\&. -.TP -path -Warns about invalid path elements and nonexistent path directories on the command line (with regard to the class path, the source path, and other paths)\&. Such warnings cannot be suppressed with the \f3@SuppressWarnings\fR annotation, for example: -.sp -.nf -\f3javac \-Xlint:path \-classpath /nonexistentpath Example\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -processing -Warn about issues regarding annotation processing\&. The compiler generates this warning when you have a class that has an annotation, and you use an annotation processor that cannot handle that type of exception\&. For example, the following is a simple annotation processor: - -\fISource file AnnocProc\&.java\fR: -.sp -.nf -\f3import java\&.util\&.*;\fP -.fi -.nf -\f3import javax\&.annotation\&.processing\&.*;\fP -.fi -.nf -\f3import javax\&.lang\&.model\&.*;\fP -.fi -.nf -\f3import\&.javaz\&.lang\&.model\&.element\&.*;\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3@SupportedAnnotationTypes("NotAnno")\fP -.fi -.nf -\f3public class AnnoProc extends AbstractProcessor {\fP -.fi -.nf -\f3 public boolean process(Set<? extends TypeElement> elems, RoundEnvironment renv){\fP -.fi -.nf -\f3 return true;\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 public SourceVersion getSupportedSourceVersion() {\fP -.fi -.nf -\f3 return SourceVersion\&.latest();\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - - -\fISource file AnnosWithoutProcessors\&.java\fR: -.sp -.nf -\f3@interface Anno { }\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3@Anno\fP -.fi -.nf -\f3class AnnosWithoutProcessors { }\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The following commands compile the annotation processor \f3AnnoProc\fR, then run this annotation processor against the source file \f3AnnosWithoutProcessors\&.java\fR: -.sp -.nf -\f3javac AnnoProc\&.java\fP -.fi -.nf -\f3javac \-cp \&. \-Xlint:processing \-processor AnnoProc \-proc:only AnnosWithoutProcessors\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp - - -When the compiler runs the annotation processor against the source file \f3AnnosWithoutProcessors\&.java\fR, it generates the following warning: -.sp -.nf -\f3warning: [processing] No processor claimed any of these annotations: Anno\fP -.fi -.nf -\f3\fP -.fi -.sp - - -To resolve this issue, you can rename the annotation defined and used in the class \f3AnnosWithoutProcessors\fR from \f3Anno\fR to \f3NotAnno\fR\&. -.TP -rawtypes -Warns about unchecked operations on raw types\&. The following statement generates a \f3rawtypes\fR warning: -.sp -.nf -\f3void countElements(List l) { \&.\&.\&. }\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The following example does not generate a \f3rawtypes\fR warning -.sp -.nf -\f3void countElements(List<?> l) { \&.\&.\&. }\fP -.fi -.nf -\f3\fP -.fi -.sp - - -\f3List\fR is a raw type\&. However, \f3List<?>\fR is an unbounded wildcard parameterized type\&. Because \f3List\fR is a parameterized interface, always specify its type argument\&. In this example, the \f3List\fR formal argument is specified with an unbounded wildcard (\f3?\fR) as its formal type parameter, which means that the \f3countElements\fR method can accept any instantiation of the \f3List\fR interface\&. -.TP -Serial -Warns about missing \f3serialVersionUID\fR definitions on serializable classes, for example: -.sp -.nf -\f3public class PersistentTime implements Serializable\fP -.fi -.nf -\f3{\fP -.fi -.nf -\f3 private Date time;\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 public PersistentTime() {\fP -.fi -.nf -\f3 time = Calendar\&.getInstance()\&.getTime();\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 public Date getTime() {\fP -.fi -.nf -\f3 return time;\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The compiler generates the following warning: -.sp -.nf -\f3warning: [serial] serializable class PersistentTime has no definition of\fP -.fi -.nf -\f3serialVersionUID\fP -.fi -.nf -\f3\fP -.fi -.sp - - -If a serializable class does not explicitly declare a field named \f3serialVersionUID\fR, then the serialization runtime environment calculates a default \f3serialVersionUID\fR value for that class based on various aspects of the class, as described in the Java Object Serialization Specification\&. However, it is strongly recommended that all serializable classes explicitly declare \f3serialVersionUID\fR values because the default process of computing \f3serialVersionUID\fR vales is highly sensitive to class details that can vary depending on compiler implementations, and as a result, might cause an unexpected \f3InvalidClassExceptions\fR during deserialization\&. To guarantee a consistent \f3serialVersionUID\fR value across different Java compiler implementations, a serializable class must declare an explicit \f3serialVersionUID\fR value\&. -.TP -static -Warns about issues relating to the use of statics, for example: -.sp -.nf -\f3class XLintStatic {\fP -.fi -.nf -\f3 static void m1() { }\fP -.fi -.nf -\f3 void m2() { this\&.m1(); }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The compiler generates the following warning: -.sp -.nf -\f3warning: [static] static method should be qualified by type name, \fP -.fi -.nf -\f3XLintStatic, instead of by an expression\fP -.fi -.nf -\f3\fP -.fi -.sp - - -To resolve this issue, you can call the \f3static\fR method \f3m1\fR as follows: -.sp -.nf -\f3XLintStatic\&.m1();\fP -.fi -.nf -\f3\fP -.fi -.sp - - -Alternately, you can remove the \f3static\fR keyword from the declaration of the method \f3m1\fR\&. -.TP -try -Warns about issues relating to use of \f3try\fR blocks, including try-with-resources statements\&. For example, a warning is generated for the following statement because the resource \f3ac\fR declared in the \f3try\fR block is not used: -.sp -.nf -\f3try ( AutoCloseable ac = getResource() ) { // do nothing}\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -unchecked -Gives more detail for unchecked conversion warnings that are mandated by the Java Language Specification, for example: -.sp -.nf -\f3List l = new ArrayList<Number>();\fP -.fi -.nf -\f3List<String> ls = l; // unchecked warning\fP -.fi -.nf -\f3\fP -.fi -.sp - - -During type erasure, the types \f3ArrayList<Number>\fR and \f3List<String>\fR become \f3ArrayList\fR and \f3List\fR, respectively\&. - -The \f3ls\fR command has the parameterized type \f3List<String>\fR\&. When the \f3List\fR referenced by \f3l\fR is assigned to \f3ls\fR, the compiler generates an unchecked warning\&. At compile time, the compiler and JVM cannot determine whether \f3l\fR refers to a \f3List<String>\fR type\&. In this case, \f3l\fR does not refer to a \f3List<String>\fR type\&. As a result, heap pollution occurs\&. - -A heap pollution situation occurs when the \f3List\fR object \f3l\fR, whose static type is \f3List<Number>\fR, is assigned to another \f3List\fR object, \f3ls\fR, that has a different static type, \f3List<String>\fR\&. However, the compiler still allows this assignment\&. It must allow this assignment to preserve backward compatibility with releases of Java SE that do not support generics\&. Because of type erasure, \f3List<Number>\fR and \f3List<String>\fR both become \f3List\fR\&. Consequently, the compiler allows the assignment of the object \f3l\fR\f3,\fR which has a raw type of \f3List\fR, to the object \f3ls\fR\&. -.TP -varargs -Warns about unsafe usages of variable arguments (\f3varargs\fR) methods, in particular, those that contain non-reifiable arguments, for example: -.sp -.nf -\f3public class ArrayBuilder {\fP -.fi -.nf -\f3 public static <T> void addToList (List<T> listArg, T\&.\&.\&. elements) {\fP -.fi -.nf -\f3 for (T x : elements) {\fP -.fi -.nf -\f3 listArg\&.add(x);\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - - -\fINote:\fR A non-reifiable type is a type whose type information is not fully available at runtime\&. - -The compiler generates the following warning for the definition of the method \f3ArrayBuilder\&.addToList\fR -.sp -.nf -\f3warning: [varargs] Possible heap pollution from parameterized vararg type T\fP -.fi -.nf -\f3\fP -.fi -.sp - - -When the compiler encounters a varargs method, it translates the \f3varargs\fR formal parameter into an array\&. However, the Java programming language does not permit the creation of arrays of parameterized types\&. In the method \f3ArrayBuilder\&.addToList\fR, the compiler translates the \f3varargs\fR formal parameter \f3T\&.\&.\&.\fR elements to the formal parameter \f3T[]\fR elements, an array\&. However, because of type erasure, the compiler converts the \f3varargs\fR formal parameter to \f3Object[]\fR elements\&. Consequently, there is a possibility of heap pollution\&. -.SH COMMAND-LINE\ ARGUMENT\ FILES -To shorten or simplify the \f3javac\fR command, you can specify one or more files that contain arguments to the \f3javac\fR command (except \f3-J\fR options)\&. This enables you to create \f3javac\fR commands of any length on any operating system\&. -.PP -An argument file can include \f3javac\fR options and source file names in any combination\&. The arguments within a file can be separated by spaces or new line characters\&. If a file name contains embedded spaces, then put the whole file name in double quotation marks\&. -.PP -File Names within an argument file are relative to the current directory, not the location of the argument file\&. Wild cards (*) are not allowed in these lists (such as for specifying \f3*\&.java\fR)\&. Use of the at sign (@) to recursively interpret files is not supported\&. The \f3-J\fR options are not supported because they are passed to the launcher, which does not support argument files\&. -.PP -When executing the \f3javac\fR command, pass in the path and name of each argument file with the at sign (@) leading character\&. When the \f3javac\fR command encounters an argument beginning with the at sign (@), it expands the contents of that file into the argument list\&. -.PP -\f3Example 1 Single Argument File\fR -.PP -You could use a single argument file named \f3argfile\fR to hold all \f3javac\fR arguments: -.sp -.nf -\f3javac @argfile\fP -.fi -.nf -\f3\fP -.fi -.sp -This argument file could contain the contents of both files shown in Example 2 -.PP -\f3Example 2 Two Argument Files\fR -.PP -You can create two argument files: one for the \f3javac\fR options and the other for the source file names\&. Note that the following lists have no line-continuation characters\&. -.PP -Create a file named options that contains the following: -.sp -.nf -\f3\-d classes\fP -.fi -.nf -\f3\-g\fP -.fi -.nf -\f3\-sourcepath /java/pubs/ws/1\&.3/src/share/classes\fP -.fi -.nf -\f3\fP -.fi -.sp -Create a file named classes that contains the following: -.sp -.nf -\f3MyClass1\&.java\fP -.fi -.nf -\f3MyClass2\&.java\fP -.fi -.nf -\f3MyClass3\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -Then, run the \f3javac\fR command as follows: -.sp -.nf -\f3javac @options @classes\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 3 Argument Files with Paths\fR -.PP -The argument files can have paths, but any file names inside the files are relative to the current working directory (not \f3path1\fR or \f3path2\fR): -.sp -.nf -\f3javac @path1/options @path2/classes\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH ANNOTATION\ PROCESSING -The \f3javac\fR command provides direct support for annotation processing, superseding the need for the separate annotation processing command, \f3apt\fR\&. -.PP -The API for annotation processors is defined in the \f3javax\&.annotation\&.processing\fR and j\f3avax\&.lang\&.model\fR packages and subpackages\&. -.SS HOW\ ANNOTATION\ PROCESSING\ WORKS -Unless annotation processing is disabled with the \f3-proc:none\fR option, the compiler searches for any annotation processors that are available\&. The search path can be specified with the \f3-processorpath\fR option\&. If no path is specified, then the user class path is used\&. Processors are located by means of service provider-configuration files named \f3META-INF/services/javax\&.annotation\&.processing\fR\&.Processor on the search path\&. Such files should contain the names of any annotation processors to be used, listed one per line\&. Alternatively, processors can be specified explicitly, using the \f3-processor\fR option\&. -.PP -After scanning the source files and classes on the command line to determine what annotations are present, the compiler queries the processors to determine what annotations they process\&. When a match is found, the processor is called\&. A processor can claim the annotations it processes, in which case no further attempt is made to find any processors for those annotations\&. After all of the annotations are claimed, the compiler does not search for additional processors\&. -.PP -If any processors generate new source files, then another round of annotation processing occurs: Any newly generated source files are scanned, and the annotations processed as before\&. Any processors called on previous rounds are also called on all subsequent rounds\&. This continues until no new source files are generated\&. -.PP -After a round occurs where no new source files are generated, the annotation processors are called one last time, to give them a chance to complete any remaining work\&. Finally, unless the \f3-proc:only\fR option is used, the compiler compiles the original and all generated source files\&. -.SS IMPLICITLY\ LOADED\ SOURCE\ FILES -To compile a set of source files, the compiler might need to implicitly load additional source files\&. See Searching for Types\&. Such files are currently not subject to annotation processing\&. By default, the compiler gives a warning when annotation processing occurred and any implicitly loaded source files are compiled\&. The \f3-implicit\fR option provides a way to suppress the warning\&. -.SH SEARCHING\ FOR\ TYPES -To compile a source file, the compiler often needs information about a type, but the type definition is not in the source files specified on the command line\&. The compiler needs type information for every class or interface used, extended, or implemented in the source file\&. This includes classes and interfaces not explicitly mentioned in the source file, but that provide information through inheritance\&. -.PP -For example, when you create a subclass \f3java\&.applet\&.Applet\fR, you are also using the ancestor classes of \f3Applet\fR: \f3java\&.awt\&.Panel\fR, \f3java\&.awt\&.Container\fR, \f3java\&.awt\&.Component\fR, and \f3java\&.lang\&.Object\fR\&. -.PP -When the compiler needs type information, it searches for a source file or class file that defines the type\&. The compiler searches for class files first in the bootstrap and extension classes, then in the user class path (which by default is the current directory)\&. The user class path is defined by setting the \f3CLASSPATH\fR environment variable or by using the \f3-classpath\fR option\&. -.PP -If you set the \f3-sourcepath\fR option, then the compiler searches the indicated path for source files\&. Otherwise, the compiler searches the user class path for both class files and source files\&. -.PP -You can specify different bootstrap or extension classes with the \f3-bootclasspath\fR and the \f3-extdirs\fR options\&. See Cross-Compilation Options\&. -.PP -A successful type search may produce a class file, a source file, or both\&. If both are found, then you can use the \f3-Xprefer\fR option to instruct the compiler which to use\&. If \f3newer\fR is specified, then the compiler uses the newer of the two files\&. If \f3source\fR is specified, the compiler uses the source file\&. The default is \f3newer\fR\&. -.PP -If a type search finds a source file for a required type, either by itself, or as a result of the setting for the \f3-Xprefer\fR option, then the compiler reads the source file to get the information it needs\&. By default the compiler also compiles the source file\&. You can use the \f3-implicit\fR option to specify the behavior\&. If \f3none\fR is specified, then no class files are generated for the source file\&. If \f3class\fR is specified, then class files are generated for the source file\&. -.PP -The compiler might not discover the need for some type information until after annotation processing completes\&. When the type information is found in a source file and no \f3-implicit\fR option is specified, the compiler gives a warning that the file is being compiled without being subject to annotation processing\&. To disable the warning, either specify the file on the command line (so that it will be subject to annotation processing) or use the \f3-implicit\fR option to specify whether or not class files should be generated for such source files\&. -.SH PROGRAMMATIC\ INTERFACE -The \f3javac\fR command supports the new Java Compiler API defined by the classes and interfaces in the \f3javax\&.tools\fR package\&. -.SS EXAMPLE -To compile as though providing command-line arguments, use the following syntax: -.sp -.nf -\f3JavaCompiler javac = ToolProvider\&.getSystemJavaCompiler();\fP -.fi -.nf -\f3\fP -.fi -.sp -The example writes diagnostics to the standard output stream and returns the exit code that \f3javac\fR would give when called from the command line\&. -.PP -You can use other methods in the \f3javax\&.tools\&.JavaCompiler\fR interface to handle diagnostics, control where files are read from and written to, and more\&. -.SS OLD\ INTERFACE -\fINote:\fR This API is retained for backward compatibility only\&. All new code should use the newer Java Compiler API\&. -.PP -The \f3com\&.sun\&.tools\&.javac\&.Main\fR class provides two static methods to call the compiler from a program: -.sp -.nf -\f3public static int compile(String[] args);\fP -.fi -.nf -\f3public static int compile(String[] args, PrintWriter out);\fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3args\fR parameter represents any of the command-line arguments that would typically be passed to the compiler\&. -.PP -The \f3out\fR parameter indicates where the compiler diagnostic output is directed\&. -.PP -The \f3return\fR value is equivalent to the \f3exit\fR value from \f3javac\fR\&. -.PP -\fINote:\fR All other classes and methods found in a package with names that start with \f3com\&.sun\&.tools\&.javac\fR (subpackages of \f3com\&.sun\&.tools\&.javac\fR) are strictly internal and subject to change at any time\&. -.SH EXAMPLES -\f3Example 1 Compile a Simple Program\fR -.PP -This example shows how to compile the \f3Hello\&.java\fR source file in the greetings directory\&. The class defined in \f3Hello\&.java\fR is called \f3greetings\&.Hello\fR\&. The greetings directory is the package directory both for the source file and the class file and is underneath the current directory\&. This makes it possible to use the default user class path\&. It also makes it unnecessary to specify a separate destination directory with the \f3-d\fR option\&. -.PP -The source code in \f3Hello\&.java\fR: -.sp -.nf -\f3package greetings;\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3public class Hello {\fP -.fi -.nf -\f3 public static void main(String[] args) {\fP -.fi -.nf -\f3 for (int i=0; i < args\&.length; i++) {\fP -.fi -.nf -\f3 System\&.out\&.println("Hello " + args[i]);\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp -Compile greetings\&.Hello: -.sp -.nf -\f3javac greetings/Hello\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -Run \f3greetings\&.Hello\fR: -.sp -.nf -\f3java greetings\&.Hello World Universe Everyone\fP -.fi -.nf -\f3Hello World\fP -.fi -.nf -\f3Hello Universe\fP -.fi -.nf -\f3Hello Everyone\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 2 Compile Multiple Source Files\fR -.PP -This example compiles the \f3Aloha\&.java\fR, \f3GutenTag\&.java\fR, \f3Hello\&.java\fR, and \f3Hi\&.java\fR source files in the \f3greetings\fR package\&. -.sp -.nf -\f3% javac greetings/*\&.java\fP -.fi -.nf -\f3% ls greetings\fP -.fi -.nf -\f3Aloha\&.class GutenTag\&.class Hello\&.class Hi\&.class\fP -.fi -.nf -\f3Aloha\&.java GutenTag\&.java Hello\&.java Hi\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 3 Specify a User Class Path\fR -.PP -After changing one of the source files in the previous example, recompile it: -.sp -.nf -\f3pwd\fP -.fi -.nf -\f3/examples\fP -.fi -.nf -\f3javac greetings/Hi\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -Because \f3greetings\&.Hi\fR refers to other classes in the \f3greetings\fR package, the compiler needs to find these other classes\&. The previous example works because the default user class path is the directory that contains the package directory\&. If you want to recompile this file without concern for which directory you are in, then add the examples directory to the user class path by setting \f3CLASSPATH\fR\&. This example uses the \f3-classpath\fR option\&. -.sp -.nf -\f3javac \-classpath /examples /examples/greetings/Hi\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -If you change \f3greetings\&.Hi\fR to use a banner utility, then that utility also needs to be accessible through the user class path\&. -.sp -.nf -\f3javac \-classpath /examples:/lib/Banners\&.jar \e\fP -.fi -.nf -\f3 /examples/greetings/Hi\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -To execute a class in the \f3greetings\fR package, the program needs access to the \f3greetings\fR package, and to the classes that the \f3greetings\fR classes use\&. -.sp -.nf -\f3java \-classpath /examples:/lib/Banners\&.jar greetings\&.Hi\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 4 Separate Source Files and Class Files\fR -.PP -The following example uses \f3javac\fR to compile code that runs on JVM 1\&.7\&. -.sp -.nf -\f3javac \-source 1\&.7 \-target 1\&.7 \-bootclasspath jdk1\&.7\&.0/lib/rt\&.jar \e \fP -.fi -.nf -\f3\-extdirs "" OldCode\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3-source 1\&.7\fR option specifies that release 1\&.7 (or 7) of the Java programming language be used to compile \f3OldCode\&.java\fR\&. The option \f3-target 1\&.7\fR option ensures that the generated class files are compatible with JVM 1\&.7\&. Note that in most cases, the value of the \f3-target\fR option is the value of the \f3-source\fR option; in this example, you can omit the \f3-target\fR option\&. -.PP -You must specify the \f3-bootclasspath\fR option to specify the correct version of the bootstrap classes (the \f3rt\&.jar\fR library)\&. If not, then the compiler generates a warning: -.sp -.nf -\f3javac \-source 1\&.7 OldCode\&.java\fP -.fi -.nf -\f3warning: [options] bootstrap class path not set in conjunction with \fP -.fi -.nf -\f3\-source 1\&.7\fP -.fi -.nf -\f3\fP -.fi -.sp -If you do not specify the correct version of bootstrap classes, then the compiler uses the old language rules (in this example, it uses version 1\&.7 of the Java programming language) combined with the new bootstrap classes, which can result in class files that do not work on the older platform (in this case, Java SE 7) because reference to nonexistent methods can get included\&. -.PP -\f3Example 5 Cross Compile\fR -.PP -This example uses \f3javac\fR to compile code that runs on JVM 1\&.7\&. -.sp -.nf -\f3javac \-source 1\&.7 \-target 1\&.7 \-bootclasspath jdk1\&.7\&.0/lib/rt\&.jar \e\fP -.fi -.nf -\f3 \-extdirs "" OldCode\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -The\f3-source 1\&.7\fR option specifies that release 1\&.7 (or 7) of the Java programming language to be used to compile OldCode\&.java\&. The \f3-target 1\&.7\fR option ensures that the generated class files are compatible with JVM 1\&.7\&. -.PP -You must specify the \f3-bootclasspath\fR option to specify the correct version of the bootstrap classes (the \f3rt\&.jar\fR library)\&. If not, then the compiler generates a warning: -.sp -.nf -\f3javac \-source 1\&.7 OldCode\&.java\fP -.fi -.nf -\f3warning: [options] bootstrap class path not set in conjunction with \-source 1\&.7\fP -.fi -.nf -\f3\fP -.fi -.sp -If you do not specify the correct version of bootstrap classes, then the compiler uses the old language rules combined with the new bootstrap classes\&. This combination can result in class files that do not work on the older platform (in this case, Java SE 7) because reference to nonexistent methods can get included\&. In this example, the compiler uses release 1\&.7 of the Java programming language\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -jdb(1) -.TP 0.2i -\(bu -javah(1) -.TP 0.2i -\(bu -javadoc(1) -.TP 0.2i -\(bu -jar(1) -.TP 0.2i -\(bu -jdb(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1994, 2015, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 03 March 2015 +.\" SectDesc: Basic Tools +.\" Title: javac.1 +.\" +.if n .pl 99999 +.TH javac 1 "03 March 2015" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +javac \- Reads Java class and interface definitions and compiles them into bytecode and class files\&. +.SH SYNOPSIS +.sp +.nf + +\fBjavac\fR [ \fIoptions\fR ] [ \fIsourcefiles\fR ] [ \fIclasses\fR] [ \fI@argfiles\fR ] +.fi +.sp +Arguments can be in any order: +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.TP +\fIsourcefiles\fR +One or more source files to be compiled (such as \f3MyClass\&.java\fR)\&. +.TP +\fIclasses\fR +One or more classes to be processed for annotations (such as \f3MyPackage\&.MyClass\fR)\&. +.TP +\fI@argfiles\fR +One or more files that list options and source files\&. The \f3-J\fR options are not allowed in these files\&. See Command-Line Argument Files\&. +.SH DESCRIPTION +The \f3javac\fR command reads class and interface definitions, written in the Java programming language, and compiles them into bytecode class files\&. The \f3javac\fR command can also process annotations in Java source files and classes\&. +.PP +There are two ways to pass source code file names to \f3javac\fR\&. +.TP 0.2i +\(bu +For a small number of source files, list the file names on the command line\&. +.TP 0.2i +\(bu +For a large number of source files, list the file names in a file that is separated by blanks or line breaks\&. Use the list file name preceded by an at sign (@) with the \f3javac\fR command\&. +.PP +Source code file names must have \&.java suffixes, class file names must have \&.class suffixes, and both source and class files must have root names that identify the class\&. For example, a class called \f3MyClass\fR would be written in a source file called \f3MyClass\&.java\fR and compiled into a bytecode class file called \f3MyClass\&.class\fR\&. +.PP +Inner class definitions produce additional class files\&. These class files have names that combine the inner and outer class names, such as \f3MyClass$MyInnerClass\&.class\fR\&. +.PP +Arrange source files in a directory tree that reflects their package tree\&. For example, if all of your source files are in \f3/workspace\fR, then put the source code for \f3com\&.mysoft\&.mypack\&.MyClass\fR in \f3/workspace/com/mysoft/mypack/MyClass\&.java\fR\&. +.PP +By default, the compiler puts each class file in the same directory as its source file\&. You can specify a separate destination directory with the \f3-d\fR option\&. +.SH OPTIONS +The compiler has a set of standard options that are supported on the current development environment\&. An additional set of nonstandard options are specific to the current virtual machine and compiler implementations and are subject to change in the future\&. Nonstandard options begin with the \f3-X\fR option\&. +.TP 0.2i +\(bu +See also Cross-Compilation Options +.TP 0.2i +\(bu +See also Nonstandard Options +.SS STANDARD\ OPTIONS +.TP +-A\fIkey\fR[\fI=value\fR] +.br +Specifies options to pass to annotation processors\&. These options are not interpreted by \f3javac\fR directly, but are made available for use by individual processors\&. The \f3key\fR value should be one or more identifiers separated by a dot (\&.)\&. +.TP +-cp \fIpath\fR or -classpath \fIpath\fR +.br +Specifies where to find user class files, and (optionally) annotation processors and source files\&. This class path overrides the user class path in the \f3CLASSPATH\fR environment variable\&. If neither \f3CLASSPATH\fR, \f3-cp\fR nor \f3-classpath\fR is specified, then the user \fIclass path\fR is the current directory\&. See Setting the Class Path\&. + +If the \f3-sourcepath\fR option is not specified, then the user class path is also searched for source files\&. + +If the \f3-processorpath\fR option is not specified, then the class path is also searched for annotation processors\&. +.TP +-Djava\&.ext\&.dirs=\fIdirectories\fR +.br +Overrides the location of installed extensions\&. +.TP +-Djava\&.endorsed\&.dirs=\fIdirectories\fR +.br +Overrides the location of the endorsed standards path\&. +.TP +-d \fIdirectory\fR +.br +Sets the destination directory for class files\&. The directory must already exist because \f3javac\fR does not create it\&. If a class is part of a package, then \f3javac\fR puts the class file in a subdirectory that reflects the package name and creates directories as needed\&. + +If you specify \f3-d\fR\f3/home/myclasses\fR and the class is called \f3com\&.mypackage\&.MyClass\fR, then the class file is \f3/home/myclasses/com/mypackage/MyClass\&.class\fR\&. + +If the \fI-d\fR option is not specified, then \f3javac\fR puts each class file in the same directory as the source file from which it was generated\&. + +\fINote:\fR The directory specified by the \fI-d\fR option is not automatically added to your user class path\&. +.TP +-deprecation +.br +Shows a description of each use or override of a deprecated member or class\&. Without the \f3-deprecation\fR option, \f3javac\fR shows a summary of the source files that use or override deprecated members or classes\&. The \f3-deprecation\fR option is shorthand for \f3-Xlint:deprecation\fR\&. +.TP +-encoding \fIencoding\fR +.br +Sets the source file encoding name, such as EUC-JP and UTF-8\&. If the \f3-encoding\fR option is not specified, then the platform default converter is used\&. +.TP +-endorseddirs \fIdirectories\fR +.br +Overrides the location of the endorsed standards path\&. +.TP +-extdirs \fIdirectories\fR +.br +Overrides the location of the \f3ext\fR directory\&. The directories variable is a colon-separated list of directories\&. Each JAR file in the specified directories is searched for class files\&. All JAR files found become part of the class path\&. + +If you are cross-compiling (compiling classes against bootstrap and extension classes of a different Java platform implementation), then this option specifies the directories that contain the extension classes\&. See Cross-Compilation Options for more information\&. +.TP +-g +.br +Generates all debugging information, including local variables\&. By default, only line number and source file information is generated\&. +.TP +-g:none +.br +Does not generate any debugging information\&. +.TP +-g:[\fIkeyword list\fR] +.br +Generates only some kinds of debugging information, specified by a comma separated list of keywords\&. Valid keywords are: +.RS +.TP +source +Source file debugging information\&. +.TP +lines +Line number debugging information\&. +.TP +vars +Local variable debugging information\&. +.RE + +.TP +-help +.br +Prints a synopsis of standard options\&. +.TP +-implicit:[\fIclass, none\fR] +.br +Controls the generation of class files for implicitly loaded source files\&. To automatically generate class files, use \f3-implicit:class\fR\&. To suppress class file generation, use \f3-implicit:none\fR\&. If this option is not specified, then the default is to automatically generate class files\&. In this case, the compiler issues a warning if any such class files are generated when also doing annotation processing\&. The warning is not issued when the \f3-implicit\fR option is set explicitly\&. See Searching for Types\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. + +\fINote:\fR The \fICLASSPATH\fR, \f3-classpath\fR, \f3-bootclasspath\fR, and \f3-extdirs\fR options do not specify the classes used to run \f3javac\fR\&. Trying to customize the compiler implementation with these options and variables is risky and often does not accomplish what you want\&. If you must customize the complier implementation, then use the \f3-J\fR option to pass options through to the underlying \f3\fRJava launcher\&. +.TP +-nowarn +.br +Disables warning messages\&. This option operates the same as the \f3-Xlint:none\fR option\&. +.TP +-parameters +.br +Stores formal parameter names of constructors and methods in the generated class file so that the method \f3java\&.lang\&.reflect\&.Executable\&.getParameters\fR from the Reflection API can retrieve them\&. +.TP +-proc: [\fInone\fR, \fIonly\fR] +.br +Controls whether annotation processing and compilation are done\&. \f3-proc:none\fR means that compilation takes place without annotation processing\&. \f3-proc:only\fR means that only annotation processing is done, without any subsequent compilation\&. +.TP +-processor \fIclass1\fR [,\fIclass2\fR,\fIclass3\fR\&.\&.\&.] +.br +Names of the annotation processors to run\&. This bypasses the default discovery process\&. +.TP +-processorpath \fIpath\fR +.br +Specifies where to find annotation processors\&. If this option is not used, then the class path is searched for processors\&. +.TP +-s \fIdir\fR +.br +Specifies the directory where to place the generated source files\&. The directory must already exist because \f3javac\fR does not create it\&. If a class is part of a package, then the compiler puts the source file in a subdirectory that reflects the package name and creates directories as needed\&. + +If you specify \f3-s /home/mysrc\fR and the class is called \f3com\&.mypackage\&.MyClass\fR, then the source file is put in \f3/home/mysrc/com/mypackage/MyClass\&.java\fR\&. +.TP +-source \fIrelease\fR +.br +Specifies the version of source code accepted\&. The following values for \f3release\fR are allowed: +.RS +.TP +1\&.3 +The compiler does not support assertions, generics, or other language features introduced after Java SE 1\&.3\&. +.TP +1\&.4 +The compiler accepts code containing assertions, which were introduced in Java SE 1\&.4\&. +.TP +1\&.5 +The compiler accepts code containing generics and other language features introduced in Java SE 5\&. +.TP +5 +Synonym for 1\&.5\&. +.TP +1\&.6 +No language changes were introduced in Java SE 6\&. However, encoding errors in source files are now reported as errors instead of warnings as in earlier releases of Java Platform, Standard Edition\&. +.TP +6 +Synonym for 1\&.6\&. +.TP +1\&.7 +The compiler accepts code with features introduced in Java SE 7\&. +.TP +7 +Synonym for 1\&.7\&. +.TP +1\&.8 +This is the default value\&. The compiler accepts code with features introduced in Java SE 8\&. +.TP +8 +Synonym for 1\&.8\&. +.RE + +.TP +-sourcepath \fIsourcepath\fR +.br +Specifies the source code path to search for class or interface definitions\&. As with the user class path, source path entries are separated by colons (:) on Oracle Solaris and semicolons on Windows and can be directories, JAR archives, or ZIP archives\&. If packages are used, then the local path name within the directory or archive must reflect the package name\&. + +\fINote:\fR Classes found through the class path might be recompiled when their source files are also found\&. See Searching for Types\&. +.TP +-verbose +.br +Uses verbose output, which includes information about each class loaded and each source file compiled\&. +.TP +-version +.br +Prints release information\&. +.TP +-werror +.br +Terminates compilation when warnings occur\&. +.TP +-X +.br +Displays information about nonstandard options and exits\&. +.SS CROSS-COMPILATION\ OPTIONS +By default, classes are compiled against the bootstrap and extension classes of the platform that \f3javac\fR shipped with\&. But \f3javac\fR also supports cross-compiling, where classes are compiled against a bootstrap and extension classes of a different Java platform implementation\&. It is important to use the \f3-bootclasspath\fR and \f3-extdirs\fR options when cross-compiling\&. +.TP +-target \fIversion\fR +.br +Generates class files that target a specified release of the virtual machine\&. Class files will run on the specified target and on later releases, but not on earlier releases of the JVM\&. Valid targets are 1\&.1, 1\&.2, 1\&.3, 1\&.4, 1\&.5 (also 5), 1\&.6 (also 6), 1\&.7 (also 7), and 1\&.8 (also 8)\&. + +The default for the \f3-target\fR option depends on the value of the \f3-source\fR option: +.RS +.TP 0.2i +\(bu +If the \f3-source\fR option is not specified, then the value of the \f3-target\fR option is 1\&.8 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.2, then the value of the \f3-target\fR option is 1\&.4 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.3, then the value of the \f3-target\fR option is 1\&.4 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.5, then the value of the \f3-target\fR option is 1\&.8 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.6, then the value of the \f3-target\fR is option 1\&.8 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.7, then the value of the \f3-target\fR is option 1\&.8 +.TP 0.2i +\(bu +For all other values of the \f3-source\fR option, the value of the \f3-target\fR option is the value of the \f3-source\fR option\&. +.RE + +.TP +-bootclasspath \fIbootclasspath\fR +.br +Cross-compiles against the specified set of boot classes\&. As with the user class path, boot class path entries are separated by colons (:) and can be directories, JAR archives, or ZIP archives\&. +.SS COMPACT\ PROFILE\ OPTION +Beginning with JDK 8, the \f3javac\fR compiler supports compact profiles\&. With compact profiles, applications that do not require the entire Java platform can be deployed and run with a smaller footprint\&. The compact profiles feature could be used to shorten the download time for applications from app stores\&. This feature makes for more compact deployment of Java applications that bundle the JRE\&. This feature is also useful in small devices\&. +.PP +The supported profile values are \f3compact1\fR, \f3compact2\fR, and \f3compact3\fR\&. These are additive layers\&. Each higher-numbered compact profile contains all of the APIs in profiles with smaller number names\&. +.TP +-profile +.br +When using compact profiles, this option specifies the profile name when compiling\&. For example: +.sp +.nf +\f3javac \-profile compact1 Hello\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp + + +javac does not compile source code that uses any Java SE APIs that is not in the specified profile\&. Here is an example of the error message that results from attempting to compile such source code: +.sp +.nf +\f3cd jdk1\&.8\&.0/bin\fP +.fi +.nf +\f3\&./javac \-profile compact1 Paint\&.java\fP +.fi +.nf +\f3Paint\&.java:5: error: Applet is not available in profile \&'compact1\&'\fP +.fi +.nf +\f3import java\&.applet\&.Applet;\fP +.fi +.nf +\f3\fP +.fi +.sp + + +In this example, you can correct the error by modifying the source to not use the \f3Applet\fR class\&. You could also correct the error by compiling without the -profile option\&. Then the compilation would be run against the full set of Java SE APIs\&. (None of the compact profiles include the \f3Applet\fR class\&.) + +An alternative way to compile with compact profiles is to use the \f3-bootclasspath\fR option to specify a path to an \f3rt\&.jar\fR file that specifies a profile\&'s image\&. Using the \f3-profile\fR option instead does not require a profile image to be present on the system at compile time\&. This is useful when cross-compiling\&. +.SS NONSTANDARD\ OPTIONS +.TP +-Xbootclasspath/p:\fIpath\fR +.br +Adds a suffix to the bootstrap class path\&. +.TP +-Xbootclasspath/a:\fIpath\fR +.br +Adds a prefix to the bootstrap class path\&. +.TP +-Xbootclasspath/:\fIpath\fR +.br +Overrides the location of the bootstrap class files\&. +.TP +-Xdoclint:[-]\fIgroup\fR [\fI/access\fR] +.br +Enables or disables specific groups of checks, where \fIgroup\fR is one of the following values: \f3accessibility\fR, \f3syntax\fR, \f3reference\fR, \f3html\fR or \f3missing\fR\&. For more information about these groups of checks see the \f3-Xdoclint\fR option of the \f3javadoc\fR command\&. The \f3-Xdoclint\fR option is disabled by default in the \f3javac\fR command\&. + +The variable \fIaccess\fR specifies the minimum visibility level of classes and members that the \f3-Xdoclint\fR option checks\&. It can have one of the following values (in order of most to least visible) : \f3public\fR, \f3protected\fR, \f3package\fR and \f3private\fR\&. For example, the following option checks classes and members (with all groups of checks) that have the access level protected and higher (which includes protected, package and public): +.sp +.nf +\f3\-Xdoclint:all/protected\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following option enables all groups of checks for all access levels, except it will not check for HTML errors for classes and members that have access level package and higher (which includes package and public): +.sp +.nf +\f3\-Xdoclint:all,\-html/package\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-Xdoclint:none +.br +Disables all groups of checks\&. +.TP +-Xdoclint:all[\fI/access\fR] +.br +Enables all groups of checks\&. +.TP +-Xlint +.br +\fI\fREnables all recommended warnings\&. In this release, enabling all available warnings is recommended\&. +.TP +-Xlint:all +.br +\fI\fREnables all recommended warnings\&. In this release, enabling all available warnings is recommended\&. +.TP +-Xlint:none +.br +Disables all warnings\&. +.TP +-Xlint:\fIname\fR +.br +Disables warning name\&. See Enable or Disable Warnings with the -Xlint Option for a list of warnings you can disable with this option\&. +.TP +-Xlint:\fI-name\fR +.br +Disables warning name\&. See Enable or Disable Warnings with the -Xlint Option with the \f3-Xlint\fR option to get a list of warnings that you can disable with this option\&. +.TP +-Xmaxerrs \fInumber\fR +.br +Sets the maximum number of errors to print\&. +.TP +-Xmaxwarns \fInumber\fR +.br +Sets the maximum number of warnings to print\&. +.TP +-Xstdout \fIfilename\fR +.br +Sends compiler messages to the named file\&. By default, compiler messages go to \f3System\&.err\fR\&. +.TP +-Xprefer:[\fInewer,source\fR] +.br +Specifies which file to read when both a source file and class file are found for a type\&. (See Searching for Types)\&. If the \f3-Xprefer:newer\fR option is used, then it reads the newer of the source or class file for a type (default)\&. If the \f3-Xprefer:source\fR option is used, then it reads the source file\&. Use -\f3Xprefer:source\fR when you want to be sure that any annotation processors can access annotations declared with a retention policy of \f3SOURCE\fR\&. +.TP +-Xpkginfo:[\fIalways\fR,\fIlegacy\fR,\fInonempty\fR] +.br +Control whether javac generates \f3package-info\&.class\fR files from package-info\&.java files\&. Possible mode arguments for this option include the following\&. +.RS +.TP +always +Always generate a \f3package-info\&.class\fR file for every \f3package-info\&.java\fR file\&. This option may be useful if you use a build system such as Ant, which checks that each \f3\&.java\fR file has a corresponding \f3\&.class\fR file\&. +.TP +legacy +Generate a \f3package-info\&.class\fR file only if package-info\&.java contains annotations\&. Don\&'t generate a \f3package-info\&.class\fR file if package-info\&.java only contains comments\&. + +\fINote:\fR A \f3package-info\&.class\fR file might be generated but be empty if all the annotations in the package-info\&.java file have \f3RetentionPolicy\&.SOURCE\fR\&. +.TP +nonempty +Generate a \f3package-info\&.class\fR file only if package-info\&.java contains annotations with \f3RetentionPolicy\&.CLASS\fR or \f3RetentionPolicy\&.RUNTIME\fR\&. +.RE + +.TP +-Xprint +.br +Prints a textual representation of specified types for debugging purposes\&. Perform neither annotation processing nor compilation\&. The format of the output could change\&. +.TP +-XprintProcessorInfo +.br +Prints information about which annotations a processor is asked to process\&. +.TP +-XprintRounds +.br +Prints information about initial and subsequent annotation processing rounds\&. +.SH ENABLE\ OR\ DISABLE\ WARNINGS\ WITH\ THE\ -XLINT\ OPTION +Enable warning \fIname\fR with the \f3-Xlint:name\fR option, where \f3name\fR is one of the following warning names\&. Note that you can disable a warning with the \f3-Xlint:-name:\fR option\&. +.TP +cast +Warns about unnecessary and redundant casts, for example: +.sp +.nf +\f3String s = (String) "Hello!"\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +classfile +Warns about issues related to class file contents\&. +.TP +deprecation +Warns about the use of deprecated items, for example: +.sp +.nf +\f3java\&.util\&.Date myDate = new java\&.util\&.Date();\fP +.fi +.nf +\f3int currentDay = myDate\&.getDay();\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The method \f3java\&.util\&.Date\&.getDay\fR has been deprecated since JDK 1\&.1 +.TP +dep-ann +Warns about items that are documented with an \f3@deprecated\fR Javadoc comment, but do not have a \f3@Deprecated\fR annotation, for example: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @deprecated As of Java SE 7, replaced by {@link #newMethod()}\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public static void deprecatedMethood() { }\fP +.fi +.nf +\f3public static void newMethod() { }\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +divzero +Warns about division by the constant integer 0, for example: +.sp +.nf +\f3int divideByZero = 42 / 0;\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +empty +Warns about empty statements after \f3if\fRstatements, for example: +.sp +.nf +\f3class E {\fP +.fi +.nf +\f3 void m() {\fP +.fi +.nf +\f3 if (true) ;\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +fallthrough +Checks the switch blocks for fall-through cases and provides a warning message for any that are found\&. Fall-through cases are cases in a switch block, other than the last case in the block, whose code does not include a break statement, allowing code execution to fall through from that case to the next case\&. For example, the code following the case 1 label in this switch block does not end with a break statement: +.sp +.nf +\f3switch (x) {\fP +.fi +.nf +\f3case 1:\fP +.fi +.nf +\f3 System\&.out\&.println("1");\fP +.fi +.nf +\f3 // No break statement here\&.\fP +.fi +.nf +\f3case 2:\fP +.fi +.nf +\f3 System\&.out\&.println("2");\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If the \f3-Xlint:fallthrough\fR option was used when compiling this code, then the compiler emits a warning about possible fall-through into case, with the line number of the case in question\&. +.TP +finally +Warns about \f3finally\fR clauses that cannot complete normally, for example: +.sp +.nf +\f3public static int m() {\fP +.fi +.nf +\f3 try {\fP +.fi +.nf +\f3 throw new NullPointerException();\fP +.fi +.nf +\f3 } catch (NullPointerException(); {\fP +.fi +.nf +\f3 System\&.err\&.println("Caught NullPointerException\&.");\fP +.fi +.nf +\f3 return 1;\fP +.fi +.nf +\f3 } finally {\fP +.fi +.nf +\f3 return 0;\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The compiler generates a warning for the \f3finally\fR block in this example\&. When the \f3int\fR method is called, it returns a value of 0\&. A \f3finally\fR block executes when the \f3try\fR block exits\&. In this example, when control is transferred to the \f3catch\fR block, the \f3int\fR method exits\&. However, the \f3finally\fR block must execute, so it is executed, even though control was transferred outside the method\&. +.TP +options +Warns about issues that related to the use of command-line options\&. See Cross-Compilation Options\&. +.TP +overrides +Warns about issues regarding method overrides\&. For example, consider the following two classes: +.sp +.nf +\f3public class ClassWithVarargsMethod {\fP +.fi +.nf +\f3 void varargsMethod(String\&.\&.\&. s) { }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class ClassWithOverridingMethod extends ClassWithVarargsMethod {\fP +.fi +.nf +\f3 @Override\fP +.fi +.nf +\f3 void varargsMethod(String[] s) { }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The compiler generates a warning similar to the following:\&. +.sp +.nf +\f3warning: [override] varargsMethod(String[]) in ClassWithOverridingMethod \fP +.fi +.nf +\f3overrides varargsMethod(String\&.\&.\&.) in ClassWithVarargsMethod; overriding\fP +.fi +.nf +\f3method is missing \&'\&.\&.\&.\&'\fP +.fi +.nf +\f3\fP +.fi +.sp + + +When the compiler encounters a \f3varargs\fR method, it translates the \f3varargs\fR formal parameter into an array\&. In the method \f3ClassWithVarargsMethod\&.varargsMethod\fR, the compiler translates the \f3varargs\fR formal parameter \f3String\&.\&.\&. s\fR to the formal parameter \f3String[] s\fR, an array, which matches the formal parameter of the method \f3ClassWithOverridingMethod\&.varargsMethod\fR\&. Consequently, this example compiles\&. +.TP +path +Warns about invalid path elements and nonexistent path directories on the command line (with regard to the class path, the source path, and other paths)\&. Such warnings cannot be suppressed with the \f3@SuppressWarnings\fR annotation, for example: +.sp +.nf +\f3javac \-Xlint:path \-classpath /nonexistentpath Example\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +processing +Warn about issues regarding annotation processing\&. The compiler generates this warning when you have a class that has an annotation, and you use an annotation processor that cannot handle that type of exception\&. For example, the following is a simple annotation processor: + +\fISource file AnnocProc\&.java\fR: +.sp +.nf +\f3import java\&.util\&.*;\fP +.fi +.nf +\f3import javax\&.annotation\&.processing\&.*;\fP +.fi +.nf +\f3import javax\&.lang\&.model\&.*;\fP +.fi +.nf +\f3import\&.javaz\&.lang\&.model\&.element\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3@SupportedAnnotationTypes("NotAnno")\fP +.fi +.nf +\f3public class AnnoProc extends AbstractProcessor {\fP +.fi +.nf +\f3 public boolean process(Set<? extends TypeElement> elems, RoundEnvironment renv){\fP +.fi +.nf +\f3 return true;\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public SourceVersion getSupportedSourceVersion() {\fP +.fi +.nf +\f3 return SourceVersion\&.latest();\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fISource file AnnosWithoutProcessors\&.java\fR: +.sp +.nf +\f3@interface Anno { }\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3@Anno\fP +.fi +.nf +\f3class AnnosWithoutProcessors { }\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following commands compile the annotation processor \f3AnnoProc\fR, then run this annotation processor against the source file \f3AnnosWithoutProcessors\&.java\fR: +.sp +.nf +\f3javac AnnoProc\&.java\fP +.fi +.nf +\f3javac \-cp \&. \-Xlint:processing \-processor AnnoProc \-proc:only AnnosWithoutProcessors\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp + + +When the compiler runs the annotation processor against the source file \f3AnnosWithoutProcessors\&.java\fR, it generates the following warning: +.sp +.nf +\f3warning: [processing] No processor claimed any of these annotations: Anno\fP +.fi +.nf +\f3\fP +.fi +.sp + + +To resolve this issue, you can rename the annotation defined and used in the class \f3AnnosWithoutProcessors\fR from \f3Anno\fR to \f3NotAnno\fR\&. +.TP +rawtypes +Warns about unchecked operations on raw types\&. The following statement generates a \f3rawtypes\fR warning: +.sp +.nf +\f3void countElements(List l) { \&.\&.\&. }\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following example does not generate a \f3rawtypes\fR warning +.sp +.nf +\f3void countElements(List<?> l) { \&.\&.\&. }\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\f3List\fR is a raw type\&. However, \f3List<?>\fR is an unbounded wildcard parameterized type\&. Because \f3List\fR is a parameterized interface, always specify its type argument\&. In this example, the \f3List\fR formal argument is specified with an unbounded wildcard (\f3?\fR) as its formal type parameter, which means that the \f3countElements\fR method can accept any instantiation of the \f3List\fR interface\&. +.TP +Serial +Warns about missing \f3serialVersionUID\fR definitions on serializable classes, for example: +.sp +.nf +\f3public class PersistentTime implements Serializable\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3 private Date time;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public PersistentTime() {\fP +.fi +.nf +\f3 time = Calendar\&.getInstance()\&.getTime();\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public Date getTime() {\fP +.fi +.nf +\f3 return time;\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The compiler generates the following warning: +.sp +.nf +\f3warning: [serial] serializable class PersistentTime has no definition of\fP +.fi +.nf +\f3serialVersionUID\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If a serializable class does not explicitly declare a field named \f3serialVersionUID\fR, then the serialization runtime environment calculates a default \f3serialVersionUID\fR value for that class based on various aspects of the class, as described in the Java Object Serialization Specification\&. However, it is strongly recommended that all serializable classes explicitly declare \f3serialVersionUID\fR values because the default process of computing \f3serialVersionUID\fR vales is highly sensitive to class details that can vary depending on compiler implementations, and as a result, might cause an unexpected \f3InvalidClassExceptions\fR during deserialization\&. To guarantee a consistent \f3serialVersionUID\fR value across different Java compiler implementations, a serializable class must declare an explicit \f3serialVersionUID\fR value\&. +.TP +static +Warns about issues relating to the use of statics, for example: +.sp +.nf +\f3class XLintStatic {\fP +.fi +.nf +\f3 static void m1() { }\fP +.fi +.nf +\f3 void m2() { this\&.m1(); }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The compiler generates the following warning: +.sp +.nf +\f3warning: [static] static method should be qualified by type name, \fP +.fi +.nf +\f3XLintStatic, instead of by an expression\fP +.fi +.nf +\f3\fP +.fi +.sp + + +To resolve this issue, you can call the \f3static\fR method \f3m1\fR as follows: +.sp +.nf +\f3XLintStatic\&.m1();\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Alternately, you can remove the \f3static\fR keyword from the declaration of the method \f3m1\fR\&. +.TP +try +Warns about issues relating to use of \f3try\fR blocks, including try-with-resources statements\&. For example, a warning is generated for the following statement because the resource \f3ac\fR declared in the \f3try\fR block is not used: +.sp +.nf +\f3try ( AutoCloseable ac = getResource() ) { // do nothing}\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +unchecked +Gives more detail for unchecked conversion warnings that are mandated by the Java Language Specification, for example: +.sp +.nf +\f3List l = new ArrayList<Number>();\fP +.fi +.nf +\f3List<String> ls = l; // unchecked warning\fP +.fi +.nf +\f3\fP +.fi +.sp + + +During type erasure, the types \f3ArrayList<Number>\fR and \f3List<String>\fR become \f3ArrayList\fR and \f3List\fR, respectively\&. + +The \f3ls\fR command has the parameterized type \f3List<String>\fR\&. When the \f3List\fR referenced by \f3l\fR is assigned to \f3ls\fR, the compiler generates an unchecked warning\&. At compile time, the compiler and JVM cannot determine whether \f3l\fR refers to a \f3List<String>\fR type\&. In this case, \f3l\fR does not refer to a \f3List<String>\fR type\&. As a result, heap pollution occurs\&. + +A heap pollution situation occurs when the \f3List\fR object \f3l\fR, whose static type is \f3List<Number>\fR, is assigned to another \f3List\fR object, \f3ls\fR, that has a different static type, \f3List<String>\fR\&. However, the compiler still allows this assignment\&. It must allow this assignment to preserve backward compatibility with releases of Java SE that do not support generics\&. Because of type erasure, \f3List<Number>\fR and \f3List<String>\fR both become \f3List\fR\&. Consequently, the compiler allows the assignment of the object \f3l\fR\f3,\fR which has a raw type of \f3List\fR, to the object \f3ls\fR\&. +.TP +varargs +Warns about unsafe usages of variable arguments (\f3varargs\fR) methods, in particular, those that contain non-reifiable arguments, for example: +.sp +.nf +\f3public class ArrayBuilder {\fP +.fi +.nf +\f3 public static <T> void addToList (List<T> listArg, T\&.\&.\&. elements) {\fP +.fi +.nf +\f3 for (T x : elements) {\fP +.fi +.nf +\f3 listArg\&.add(x);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fINote:\fR A non-reifiable type is a type whose type information is not fully available at runtime\&. + +The compiler generates the following warning for the definition of the method \f3ArrayBuilder\&.addToList\fR +.sp +.nf +\f3warning: [varargs] Possible heap pollution from parameterized vararg type T\fP +.fi +.nf +\f3\fP +.fi +.sp + + +When the compiler encounters a varargs method, it translates the \f3varargs\fR formal parameter into an array\&. However, the Java programming language does not permit the creation of arrays of parameterized types\&. In the method \f3ArrayBuilder\&.addToList\fR, the compiler translates the \f3varargs\fR formal parameter \f3T\&.\&.\&.\fR elements to the formal parameter \f3T[]\fR elements, an array\&. However, because of type erasure, the compiler converts the \f3varargs\fR formal parameter to \f3Object[]\fR elements\&. Consequently, there is a possibility of heap pollution\&. +.SH COMMAND-LINE\ ARGUMENT\ FILES +To shorten or simplify the \f3javac\fR command, you can specify one or more files that contain arguments to the \f3javac\fR command (except \f3-J\fR options)\&. This enables you to create \f3javac\fR commands of any length on any operating system\&. +.PP +An argument file can include \f3javac\fR options and source file names in any combination\&. The arguments within a file can be separated by spaces or new line characters\&. If a file name contains embedded spaces, then put the whole file name in double quotation marks\&. +.PP +File Names within an argument file are relative to the current directory, not the location of the argument file\&. Wild cards (*) are not allowed in these lists (such as for specifying \f3*\&.java\fR)\&. Use of the at sign (@) to recursively interpret files is not supported\&. The \f3-J\fR options are not supported because they are passed to the launcher, which does not support argument files\&. +.PP +When executing the \f3javac\fR command, pass in the path and name of each argument file with the at sign (@) leading character\&. When the \f3javac\fR command encounters an argument beginning with the at sign (@), it expands the contents of that file into the argument list\&. +.PP +\f3Example 1 Single Argument File\fR +.PP +You could use a single argument file named \f3argfile\fR to hold all \f3javac\fR arguments: +.sp +.nf +\f3javac @argfile\fP +.fi +.nf +\f3\fP +.fi +.sp +This argument file could contain the contents of both files shown in Example 2 +.PP +\f3Example 2 Two Argument Files\fR +.PP +You can create two argument files: one for the \f3javac\fR options and the other for the source file names\&. Note that the following lists have no line-continuation characters\&. +.PP +Create a file named options that contains the following: +.sp +.nf +\f3\-d classes\fP +.fi +.nf +\f3\-g\fP +.fi +.nf +\f3\-sourcepath /java/pubs/ws/1\&.3/src/share/classes\fP +.fi +.nf +\f3\fP +.fi +.sp +Create a file named classes that contains the following: +.sp +.nf +\f3MyClass1\&.java\fP +.fi +.nf +\f3MyClass2\&.java\fP +.fi +.nf +\f3MyClass3\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +Then, run the \f3javac\fR command as follows: +.sp +.nf +\f3javac @options @classes\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 3 Argument Files with Paths\fR +.PP +The argument files can have paths, but any file names inside the files are relative to the current working directory (not \f3path1\fR or \f3path2\fR): +.sp +.nf +\f3javac @path1/options @path2/classes\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH ANNOTATION\ PROCESSING +The \f3javac\fR command provides direct support for annotation processing, superseding the need for the separate annotation processing command, \f3apt\fR\&. +.PP +The API for annotation processors is defined in the \f3javax\&.annotation\&.processing\fR and j\f3avax\&.lang\&.model\fR packages and subpackages\&. +.SS HOW\ ANNOTATION\ PROCESSING\ WORKS +Unless annotation processing is disabled with the \f3-proc:none\fR option, the compiler searches for any annotation processors that are available\&. The search path can be specified with the \f3-processorpath\fR option\&. If no path is specified, then the user class path is used\&. Processors are located by means of service provider-configuration files named \f3META-INF/services/javax\&.annotation\&.processing\fR\&.Processor on the search path\&. Such files should contain the names of any annotation processors to be used, listed one per line\&. Alternatively, processors can be specified explicitly, using the \f3-processor\fR option\&. +.PP +After scanning the source files and classes on the command line to determine what annotations are present, the compiler queries the processors to determine what annotations they process\&. When a match is found, the processor is called\&. A processor can claim the annotations it processes, in which case no further attempt is made to find any processors for those annotations\&. After all of the annotations are claimed, the compiler does not search for additional processors\&. +.PP +If any processors generate new source files, then another round of annotation processing occurs: Any newly generated source files are scanned, and the annotations processed as before\&. Any processors called on previous rounds are also called on all subsequent rounds\&. This continues until no new source files are generated\&. +.PP +After a round occurs where no new source files are generated, the annotation processors are called one last time, to give them a chance to complete any remaining work\&. Finally, unless the \f3-proc:only\fR option is used, the compiler compiles the original and all generated source files\&. +.SS IMPLICITLY\ LOADED\ SOURCE\ FILES +To compile a set of source files, the compiler might need to implicitly load additional source files\&. See Searching for Types\&. Such files are currently not subject to annotation processing\&. By default, the compiler gives a warning when annotation processing occurred and any implicitly loaded source files are compiled\&. The \f3-implicit\fR option provides a way to suppress the warning\&. +.SH SEARCHING\ FOR\ TYPES +To compile a source file, the compiler often needs information about a type, but the type definition is not in the source files specified on the command line\&. The compiler needs type information for every class or interface used, extended, or implemented in the source file\&. This includes classes and interfaces not explicitly mentioned in the source file, but that provide information through inheritance\&. +.PP +For example, when you create a subclass \f3java\&.applet\&.Applet\fR, you are also using the ancestor classes of \f3Applet\fR: \f3java\&.awt\&.Panel\fR, \f3java\&.awt\&.Container\fR, \f3java\&.awt\&.Component\fR, and \f3java\&.lang\&.Object\fR\&. +.PP +When the compiler needs type information, it searches for a source file or class file that defines the type\&. The compiler searches for class files first in the bootstrap and extension classes, then in the user class path (which by default is the current directory)\&. The user class path is defined by setting the \f3CLASSPATH\fR environment variable or by using the \f3-classpath\fR option\&. +.PP +If you set the \f3-sourcepath\fR option, then the compiler searches the indicated path for source files\&. Otherwise, the compiler searches the user class path for both class files and source files\&. +.PP +You can specify different bootstrap or extension classes with the \f3-bootclasspath\fR and the \f3-extdirs\fR options\&. See Cross-Compilation Options\&. +.PP +A successful type search may produce a class file, a source file, or both\&. If both are found, then you can use the \f3-Xprefer\fR option to instruct the compiler which to use\&. If \f3newer\fR is specified, then the compiler uses the newer of the two files\&. If \f3source\fR is specified, the compiler uses the source file\&. The default is \f3newer\fR\&. +.PP +If a type search finds a source file for a required type, either by itself, or as a result of the setting for the \f3-Xprefer\fR option, then the compiler reads the source file to get the information it needs\&. By default the compiler also compiles the source file\&. You can use the \f3-implicit\fR option to specify the behavior\&. If \f3none\fR is specified, then no class files are generated for the source file\&. If \f3class\fR is specified, then class files are generated for the source file\&. +.PP +The compiler might not discover the need for some type information until after annotation processing completes\&. When the type information is found in a source file and no \f3-implicit\fR option is specified, the compiler gives a warning that the file is being compiled without being subject to annotation processing\&. To disable the warning, either specify the file on the command line (so that it will be subject to annotation processing) or use the \f3-implicit\fR option to specify whether or not class files should be generated for such source files\&. +.SH PROGRAMMATIC\ INTERFACE +The \f3javac\fR command supports the new Java Compiler API defined by the classes and interfaces in the \f3javax\&.tools\fR package\&. +.SS EXAMPLE +To compile as though providing command-line arguments, use the following syntax: +.sp +.nf +\f3JavaCompiler javac = ToolProvider\&.getSystemJavaCompiler();\fP +.fi +.nf +\f3\fP +.fi +.sp +The example writes diagnostics to the standard output stream and returns the exit code that \f3javac\fR would give when called from the command line\&. +.PP +You can use other methods in the \f3javax\&.tools\&.JavaCompiler\fR interface to handle diagnostics, control where files are read from and written to, and more\&. +.SS OLD\ INTERFACE +\fINote:\fR This API is retained for backward compatibility only\&. All new code should use the newer Java Compiler API\&. +.PP +The \f3com\&.sun\&.tools\&.javac\&.Main\fR class provides two static methods to call the compiler from a program: +.sp +.nf +\f3public static int compile(String[] args);\fP +.fi +.nf +\f3public static int compile(String[] args, PrintWriter out);\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3args\fR parameter represents any of the command-line arguments that would typically be passed to the compiler\&. +.PP +The \f3out\fR parameter indicates where the compiler diagnostic output is directed\&. +.PP +The \f3return\fR value is equivalent to the \f3exit\fR value from \f3javac\fR\&. +.PP +\fINote:\fR All other classes and methods found in a package with names that start with \f3com\&.sun\&.tools\&.javac\fR (subpackages of \f3com\&.sun\&.tools\&.javac\fR) are strictly internal and subject to change at any time\&. +.SH EXAMPLES +\f3Example 1 Compile a Simple Program\fR +.PP +This example shows how to compile the \f3Hello\&.java\fR source file in the greetings directory\&. The class defined in \f3Hello\&.java\fR is called \f3greetings\&.Hello\fR\&. The greetings directory is the package directory both for the source file and the class file and is underneath the current directory\&. This makes it possible to use the default user class path\&. It also makes it unnecessary to specify a separate destination directory with the \f3-d\fR option\&. +.PP +The source code in \f3Hello\&.java\fR: +.sp +.nf +\f3package greetings;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class Hello {\fP +.fi +.nf +\f3 public static void main(String[] args) {\fP +.fi +.nf +\f3 for (int i=0; i < args\&.length; i++) {\fP +.fi +.nf +\f3 System\&.out\&.println("Hello " + args[i]);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +Compile greetings\&.Hello: +.sp +.nf +\f3javac greetings/Hello\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +Run \f3greetings\&.Hello\fR: +.sp +.nf +\f3java greetings\&.Hello World Universe Everyone\fP +.fi +.nf +\f3Hello World\fP +.fi +.nf +\f3Hello Universe\fP +.fi +.nf +\f3Hello Everyone\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 2 Compile Multiple Source Files\fR +.PP +This example compiles the \f3Aloha\&.java\fR, \f3GutenTag\&.java\fR, \f3Hello\&.java\fR, and \f3Hi\&.java\fR source files in the \f3greetings\fR package\&. +.sp +.nf +\f3% javac greetings/*\&.java\fP +.fi +.nf +\f3% ls greetings\fP +.fi +.nf +\f3Aloha\&.class GutenTag\&.class Hello\&.class Hi\&.class\fP +.fi +.nf +\f3Aloha\&.java GutenTag\&.java Hello\&.java Hi\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 3 Specify a User Class Path\fR +.PP +After changing one of the source files in the previous example, recompile it: +.sp +.nf +\f3pwd\fP +.fi +.nf +\f3/examples\fP +.fi +.nf +\f3javac greetings/Hi\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +Because \f3greetings\&.Hi\fR refers to other classes in the \f3greetings\fR package, the compiler needs to find these other classes\&. The previous example works because the default user class path is the directory that contains the package directory\&. If you want to recompile this file without concern for which directory you are in, then add the examples directory to the user class path by setting \f3CLASSPATH\fR\&. This example uses the \f3-classpath\fR option\&. +.sp +.nf +\f3javac \-classpath /examples /examples/greetings/Hi\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +If you change \f3greetings\&.Hi\fR to use a banner utility, then that utility also needs to be accessible through the user class path\&. +.sp +.nf +\f3javac \-classpath /examples:/lib/Banners\&.jar \e\fP +.fi +.nf +\f3 /examples/greetings/Hi\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +To execute a class in the \f3greetings\fR package, the program needs access to the \f3greetings\fR package, and to the classes that the \f3greetings\fR classes use\&. +.sp +.nf +\f3java \-classpath /examples:/lib/Banners\&.jar greetings\&.Hi\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 4 Separate Source Files and Class Files\fR +.PP +The following example uses \f3javac\fR to compile code that runs on JVM 1\&.7\&. +.sp +.nf +\f3javac \-source 1\&.7 \-target 1\&.7 \-bootclasspath jdk1\&.7\&.0/lib/rt\&.jar \e \fP +.fi +.nf +\f3\-extdirs "" OldCode\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3-source 1\&.7\fR option specifies that release 1\&.7 (or 7) of the Java programming language be used to compile \f3OldCode\&.java\fR\&. The option \f3-target 1\&.7\fR option ensures that the generated class files are compatible with JVM 1\&.7\&. Note that in most cases, the value of the \f3-target\fR option is the value of the \f3-source\fR option; in this example, you can omit the \f3-target\fR option\&. +.PP +You must specify the \f3-bootclasspath\fR option to specify the correct version of the bootstrap classes (the \f3rt\&.jar\fR library)\&. If not, then the compiler generates a warning: +.sp +.nf +\f3javac \-source 1\&.7 OldCode\&.java\fP +.fi +.nf +\f3warning: [options] bootstrap class path not set in conjunction with \fP +.fi +.nf +\f3\-source 1\&.7\fP +.fi +.nf +\f3\fP +.fi +.sp +If you do not specify the correct version of bootstrap classes, then the compiler uses the old language rules (in this example, it uses version 1\&.7 of the Java programming language) combined with the new bootstrap classes, which can result in class files that do not work on the older platform (in this case, Java SE 7) because reference to nonexistent methods can get included\&. +.PP +\f3Example 5 Cross Compile\fR +.PP +This example uses \f3javac\fR to compile code that runs on JVM 1\&.7\&. +.sp +.nf +\f3javac \-source 1\&.7 \-target 1\&.7 \-bootclasspath jdk1\&.7\&.0/lib/rt\&.jar \e\fP +.fi +.nf +\f3 \-extdirs "" OldCode\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +The\f3-source 1\&.7\fR option specifies that release 1\&.7 (or 7) of the Java programming language to be used to compile OldCode\&.java\&. The \f3-target 1\&.7\fR option ensures that the generated class files are compatible with JVM 1\&.7\&. +.PP +You must specify the \f3-bootclasspath\fR option to specify the correct version of the bootstrap classes (the \f3rt\&.jar\fR library)\&. If not, then the compiler generates a warning: +.sp +.nf +\f3javac \-source 1\&.7 OldCode\&.java\fP +.fi +.nf +\f3warning: [options] bootstrap class path not set in conjunction with \-source 1\&.7\fP +.fi +.nf +\f3\fP +.fi +.sp +If you do not specify the correct version of bootstrap classes, then the compiler uses the old language rules combined with the new bootstrap classes\&. This combination can result in class files that do not work on the older platform (in this case, Java SE 7) because reference to nonexistent methods can get included\&. In this example, the compiler uses release 1\&.7 of the Java programming language\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jdb(1) +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +javadoc(1) +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +jdb(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/javadoc.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/javadoc.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,3004 +1,3004 @@ -'\" t -.\" Copyright (c) 1994, 2015, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 03 March 2015 -.\" SectDesc: Basic Tools -.\" Title: javadoc.1 -.\" -.if n .pl 99999 -.TH javadoc 1 "03 March 2015" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -javadoc \- Generates HTML pages of API documentation from Java source files\&. -.SH SYNOPSIS -.sp -.nf - -\fBjavadoc\fR {\fIpackages\fR|\fIsource\-files\fR} [\fIoptions\fR] [\fI@argfiles\fR] -.fi -.sp -.TP -\fIpackages\fR -Names of packages that you want to document, separated by spaces, for example \f3java\&.lang java\&.lang\&.reflect java\&.awt\fR\&. If you want to also document the subpackages, use the \f3-subpackages\fR option to specify the packages\&. - -By default, \f3javadoc\fR looks for the specified packages in the current directory and subdirectories\&. Use the \f3-sourcepath\fR option to specify the list of directories where to look for packages\&. -.TP -\fIsource-files\fR -Names of Java source files that you want to document, separated by spaces, for example \f3Class\&.java Object\&.java Button\&.java\fR\&. By default, \f3javadoc\fR looks for the specified classes in the current directory\&. However, you can specify the full path to the class file and use wildcard characters, for example \f3/home/src/java/awt/Graphics*\&.java\fR\&. You can also specify the path relative to the current directory\&. -.TP -\fIoptions\fR -Command-line options, separated by spaces\&. See Options\&. -.TP -\fI@argfiles\fR -Names of files that contain a list of \f3javadoc\fR command options, package names and source file names in any order\&. -.SH DESCRIPTION -The \f3javadoc\fR command parses the declarations and documentation comments in a set of Java source files and produces a corresponding set of HTML pages that describe (by default) the public and protected classes, nested classes (but not anonymous inner classes), interfaces, constructors, methods, and fields\&. You can use the \f3javadoc\fR command to generate the API documentation or the implementation documentation for a set of source files\&. -.PP -You can run the \f3javadoc\fR command on entire packages, individual source files, or both\&. When documenting entire packages, you can either use the \f3-subpackages\fR option to recursively traverse a directory and its subdirectories, or to pass in an explicit list of package names\&. When you document individual source files, pass in a list of Java source file names\&. See Simple Examples\&. -.SS PROCESS\ SOURCE\ FILES -The \f3javadoc\fR command processes files that end in source and other files described in Source Files\&. If you run the \f3javadoc\fR command by passing in individual source file names, then you can determine exactly which source files are processed\&. However, that is not how most developers want to work, because it is simpler to pass in package names\&. The \f3javadoc\fR command can be run three ways without explicitly specifying the source file names\&. You can pass in package names, use the \f3-subpackages\fR option, or use wild cards with source file names\&. In these cases, the \f3javadoc\fR command processes a source file only when the file fulfills all of the following requirements: -.TP 0.2i -\(bu -The file name prefix (with \f3\&.java\fR removed) is a valid class name\&. -.TP 0.2i -\(bu -The path name relative to the root of the source tree is a valid package name after the separators are converted to dots\&. -.TP 0.2i -\(bu -The package statement contains the valid package name\&. -.PP -Processing Links - -During a run, the \f3javadoc\fR command adds cross-reference links to package, class, and member names that are being documented as part of that run\&. Links appear in the following places\&. See Javadoc Tags for a description of the @ tags\&. -.TP 0.2i -\(bu -Declarations (return types, argument types, and field types)\&. -.TP 0.2i -\(bu -\fISee Also\fR sections that are generated from \f3@see\fR tags\&. -.TP 0.2i -\(bu -Inline text generated from \f3{@link}\fR tags\&. -.TP 0.2i -\(bu -Exception names generated from \f3@throws\fR tags\&. -.TP 0.2i -\(bu -\fISpecified by\fR links to interface members and \fIOverrides\fR links to class members\&. See Method Comment Inheritance\&. -.TP 0.2i -\(bu -Summary tables listing packages, classes and members\&. -.TP 0.2i -\(bu -Package and class inheritance trees\&. -.TP 0.2i -\(bu -The index\&. -.PP -You can add links to existing text for classes not included on the command line (but generated separately) by way of the \f3-link\fR and \f3-linkoffline\fR options\&. -.PP -Processing Details - -The \f3javadoc\fR command produces one complete document every time it runs\&. It does not do incremental builds that modify or directly incorporate the results from earlier runs\&. However, the \f3javadoc\fR command can link to results from other runs\&. -.PP -The \f3javadoc\fR command implementation requires and relies on the Java compiler\&. The \f3javadoc\fR command calls part of the \f3javac\fR command to compile the declarations and ignore the member implementations\&. The \f3javadoc\fR command builds a rich internal representation of the classes that includes the class hierarchy and use relationships to generate the HTML\&. The \f3javadoc\fR command also picks up user-supplied documentation from documentation comments in the source code\&. See Documentation Comments\&. -.PP -The \f3javadoc\fR command runs on source files that are pure stub files with no method bodies\&. This means you can write documentation comments and run the \f3javadoc\fR command in the early stages of design before API implementation\&. -.PP -Relying on the compiler ensures that the HTML output corresponds exactly with the actual implementation, which may rely on implicit, rather than explicit, source code\&. For example, the \f3javadoc\fR command documents default constructors that are present in the compiled class files but not in the source code\&. -.PP -In many cases, the \f3javadoc\fR command lets you generate documentation for source files with incomplete or erroneous code\&. You can generate documentation before all debugging and troubleshooting is done\&. The \f3javadoc\fR command does primitive checking of documentation comments\&. -.PP -When the \f3javadoc\fR command builds its internal structure for the documentation, it loads all referenced classes\&. Because of this, the \f3javadoc\fR command must be able to find all referenced classes, whether bootstrap classes, extensions, or user classes\&. See How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html -.PP -Typically, classes you create must either be loaded as an extension or in the \f3javadoc\fR command class path\&. -.SS JAVADOC\ DOCLETS -You can customize the content and format of the \f3javadoc\fR command output with doclets\&. The \f3javadoc\fR command has a default built-in doclet, called the standard doclet, that generates HTML-formatted API documentation\&. You can modify or make a subclass of the standard doclet, or write your own doclet to generate HTML, XML, MIF, RTF or whatever output format you want\&. -.PP -When a custom doclet is not specified with the \f3-doclet\fR option, the \f3javadoc\fR command uses the default standard doclet\&. The \f3javadoc\fR command has several options that are available regardless of which doclet is being used\&. The standard doclet adds a supplementary set of command-line options\&. See Options\&. -.SH SOURCE\ FILES -The \f3javadoc\fR command generates output that originates from the following types of source files: Java language source files for classes (\f3\&.java\fR), package comment files, overview comment files, and miscellaneous unprocessed files\&. This section also describes test files and template files that can also be in the source tree, but that you want to be sure not to document\&. -.SS CLASS\ SOURCE\ FILES -Each class or interface and its members can have their own documentation comments contained in a source file\&. See Documentation Comments\&. -.SS PACKAGE\ COMMENT\ FILES -Each package can have its own documentation comment, contained in its own source file, that the \f3javadoc\fR command merges into the generated package summary page\&. You typically include in this comment any documentation that applies to the entire package\&. -.PP -To create a package comment file, you can place your comments in one of the following files: -.TP 0.2i -\(bu -The \f3package-info\&.java\fR file can contain the package declaration, package annotations, package comments, and Javadoc tags\&. This file is preferred\&. -.TP 0.2i -\(bu -The \f3package\&.html\fR file contains only package comments and Javadoc tags\&. No package annotations\&. -.PP -A package can have a single \f3package\&.html\fR file or a single \f3package-info\&.java\fR file, but not both\&. Place either file in the package directory in the source tree with your source files\&. -.PP -The package-info\&.java File - -The \f3package-info\&.java\fR file can contain a package comment of the following structure\&. The comment is placed before the package declaration\&. -.PP -\fINote:\fR The comment separators \f3/**\fR and \f3*/\fR must be present, but the leading asterisks on the intermediate lines can be left off\&. -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * Provides the classes necessary to create an \fP -.fi -.nf -\f3 * applet and the classes an applet uses \fP -.fi -.nf -\f3 * to communicate with its applet context\&.\fP -.fi -.nf -\f3 * <p>\fP -.fi -.nf -\f3 * The applet framework involves two entities:\fP -.fi -.nf -\f3 * the applet and the applet context\&.\fP -.fi -.nf -\f3 * An applet is an embeddable window (see the\fP -.fi -.nf -\f3 * {@link java\&.awt\&.Panel} class) with a few extra\fP -.fi -.nf -\f3 * methods that the applet context can use to \fP -.fi -.nf -\f3 * initialize, start, and stop the applet\&.\fP -.fi -.nf -\f3 *\fP -.fi -.nf -\f3 * @since 1\&.0\fP -.fi -.nf -\f3 * @see java\&.awt\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3package java\&.lang\&.applet;\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -The package\&.html File - -The \f3package\&.html\fR file can contain a package comment of the following structure\&. The comment is placed in the \f3<body>\fR element\&. -.PP -File: \f3java/applet/package\&.html\fR -.sp -.nf -\f3<HTML>\fP -.fi -.nf -\f3<BODY>\fP -.fi -.nf -\f3Provides the classes necessary to create an applet and the \fP -.fi -.nf -\f3classes an applet uses to communicate with its applet context\&.\fP -.fi -.nf -\f3<p>\fP -.fi -.nf -\f3The applet framework involves two entities: the applet\fP -.fi -.nf -\f3and the applet context\&. An applet is an embeddable\fP -.fi -.nf -\f3window (see the {@link java\&.awt\&.Panel} class) with a\fP -.fi -.nf -\f3few extra methods that the applet context can use to\fP -.fi -.nf -\f3initialize, start, and stop the applet\&. \fP -.fi -.nf -\f3\fP -.fi -.nf -\f3@since 1\&.0 \fP -.fi -.nf -\f3@see java\&.awt\fP -.fi -.nf -\f3</BODY>\fP -.fi -.nf -\f3</HTML>\fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3package\&.html\fR file is a typical HTML file and does not include a package declaration\&. The content of the package comment file is written in HTML with one exception\&. The documentation comment should not include the comment separators \f3/**\fR and \f3*/\fR or leading asterisks\&. When writing the comment, make the first sentence a summary about the package, and do not put a title or any other text between the \f3<body>\fR tag and the first sentence\&. You can include package tags\&. All block tags must appear after the main description\&. If you add an \f3@see\fR tag in a package comment file, then it must have a fully qualified name\&. -.PP -Processing the Comment File - -When the \f3javadoc\fR command runs, it searches for the package comment file\&. If the package comment file is found, then the \f3javadoc\fR command does the following: -.TP 0.2i -\(bu -Copies the comment for processing\&. For package\&.html, the \f3javadoc\fR command copies all content between the \f3<body>\fR and \f3</body>\fR HTML tags\&. You can include a \f3<head>\fR section to put a \f3<title>\fR tag, source file copyright statement, or other information, but none of these appear in the generated documentation\&. -.TP 0.2i -\(bu -Processes the package tags\&. See Package Tags\&. -.TP 0.2i -\(bu -Inserts the processed text at the bottom of the generated package summary page\&. See Java Platform, Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html -.TP 0.2i -\(bu -Copies the first sentence of the package comment to the top of the package summary page\&. The \f3javadoc\fR command also adds the package name and this first sentence to the list of packages on the overview page\&. See Java Platform, Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html - -The end of the sentence is determined by the same rules used for the end of the first sentence of class and member main descriptions\&. -.SS OVERVIEW\ COMMENT\ FILES -Each application or set of packages that you are documenting can have its own overview documentation comment that is kept in its own source file, that the \f3javadoc\fR command merges into the generated overview page\&. You typically include in this comment any documentation that applies to the entire application or set of packages\&. -.PP -You can name the file anything you want such as overview\&.html and place it anywhere\&. A typical location is at the top of the source tree\&. -.PP -For example, if the source files for the \f3java\&.applet\fR package are contained in the /home/user/src/java/applet directory, then you could create an overview comment file at /home/user/src/overview\&.html\&. -.PP -You can have multiple overview comment files for the same set of source files in case you want to run the \f3javadoc\fR command multiple times on different sets of packages\&. For example, you could run the \f3javadoc\fR command once with \f3-private\fR for internal documentation and again without that option for public documentation\&. In this case, you could describe the documentation as public or internal in the first sentence of each overview comment file\&. -.PP -The content of the overview comment file is one big documentation comment that is written in HTML\&. Make the first sentence a summary about the application or set of packages\&. Do not put a title or any other text between the \f3<body>\fR tag and the first sentence\&. All tags except inline tags, such as an {\f3@link}\fR tag, must appear after the main description\&. If you add an \f3@see\fR tag, then it must have a fully qualified name\&. -.PP -When you run the \f3javadoc\fR command, specify the overview comment file name with the \f3-overview\fR option\&. The file is then processed similarly to that of a package comment file\&. The \f3javadoc\fR command does the following: -.TP 0.2i -\(bu -Copies all content between the \f3<body>\fR and \f3</body>\fR tags for processing\&. -.TP 0.2i -\(bu -Processes the overview tags that are present\&. See Overview Tags\&. -.TP 0.2i -\(bu -Inserts the processed text at the bottom of the generated overview page\&. See Java Platform Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html -.TP 0.2i -\(bu -Copies the first sentence of the overview comment to the top of the overview summary page\&. -.SS UNPROCESSED\ FILES -Your source files can include any files that you want the \f3javadoc\fR command to copy to the destination directory\&. These files usually include graphic files, example Java source and class files, and self-standing HTML files with a lot of content that would overwhelm the documentation comment of a typical Java source file\&. -.PP -To include unprocessed files, put them in a directory called doc-files\&. The doc-files directory can be a subdirectory of any package directory that contains source files\&. You can have one doc-files subdirectory for each package\&. -.PP -For example, if you want to include the image of a button in the \f3java\&.awt\&.Button\fR class documentation, then place the image file in the /home/user/src/java/awt/doc-files/ directory\&. Do not place the doc-files directory at /home/user/src/java/doc-files, because java is not a package\&. It does not contain any source files\&. -.PP -All links to the unprocessed files must be included in the code because the \f3javadoc\fR command does not look at the files\&. The \f3javadoc\fR command copies the directory and all of its contents to the destination\&. The following example shows how the link in the Button\&.java documentation comment might look: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * This button looks like this: \fP -.fi -.nf -\f3 * <img src="doc\-files/Button\&.gif">\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS TEST\ AND\ TEMPLATE\ FILES -You can store test and template files in the source tree in the same directory with or in a subdirectory of the directory where the source files reside\&. To prevent test and template files from being processed, run the \f3javadoc\fR command and explicitly pass in individual source file names\&. -.PP -Test files are valid, compilable source files\&. Template files are not valid, compatible source files, but they often have the \f3\&.java\fR suffix\&. -.PP -Test Files - -If you want your test files to belong to either an unnamed package or to a package other than the package that the source files are in, then put the test files in a subdirectory underneath the source files and give the directory an invalid name\&. If you put the test files in the same directory with the source and call the \f3javadoc\fR command with a command-line argument that indicates its package name, then the test files cause warnings or errors\&. If the files are in a subdirectory with an invalid name, then the test file directory is skipped and no errors or warnings are issued\&. For example, to add test files for source files in com\&.package1, put them in a subdirectory in an invalid package name\&. The following directory name is invalid because it contains a hyphen: -.sp -.nf -\f3com/package1/test\-files/\fP -.fi -.nf -\f3\fP -.fi -.sp -If your test files contain documentation comments, then you can set up a separate run of the \f3javadoc\fR command to produce test file documentation by passing in their test source file names with wild cards, such as \f3com/package1/test-files/*\&.java\fR\&. -.PP -Template Files - -If you want a template file to be in the source directory, but not generate errors when you execute the \f3javadoc\fR command, then give it an invalid file name such as \f3Buffer-Template\&.java\fR to prevent it from being processed\&. The \f3javadoc\fR command only processes source files with names, when stripped of the \f3\&.java\fR suffix, that are valid class names\&. -.SH GENERATED\ FILES -By default, the \f3javadoc\fR command uses a standard doclet that generates HTML-formatted documentation\&. The standard doclet generates basic content, cross-reference, and support pages described here\&. Each HTML page corresponds to a separate file\&. The \f3javadoc\fR command generates two types of files\&. The first type is named after classes and interfaces\&. The second type contain hyphens (such as package-summary\&.html) to prevent conflicts with the first type of file\&. -.SS BASIC\ CONTENT\ PAGES -.TP 0.2i -\(bu -One class or interface page (classname\&.html) for each class or interface being documented\&. -.TP 0.2i -\(bu -One package page (package-summary\&.html) for each package being documented\&. The \f3javadoc\fR command includes any HTML text provided in a file with the name package\&.html or package-info\&.java in the package directory of the source tree\&. -.TP 0.2i -\(bu -One overview page (overview-summary\&.html) for the entire set of packages\&. The overview page is the front page of the generated document\&. The \f3javadoc\fR command includes any HTML text provided in a file specified by the \f3-overview\fR option\&. The Overview page is created only when you pass two or more package names into the \f3javadoc\fR command\&. See HTML Frames and Options\&. -.SS CROSS-REFERENCE\ PAGES -.TP 0.2i -\(bu -One class hierarchy page for the entire set of packages (overview-tree\&.html)\&. To view the hierarchy page, click \fIOverview\fR in the navigation bar and click \fITree\fR\&. -.TP 0.2i -\(bu -One class hierarchy page for each package (package-tree\&.html) To view the hierarchy page, go to a particular package, class, or interface page, and click \fITree\fR to display the hierarchy for that package\&. -.TP 0.2i -\(bu -One use page for each package (package-use\&.html) and a separate use page for each class and interface (class-use/classname\&.html)\&. The use page describes what packages, classes, methods, constructors and fields use any part of the specified class, interface, or package\&. For example, given a class or interface A, its use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A\&. To view the use page, go to the package, class, or interface and click the \fIUse\fR link in the navigation bar\&. -.TP 0.2i -\(bu -A deprecated API page (deprecated-list\&.html) that lists all deprecated APIs and their suggested replacements\&. Avoid deprecated APIs because they can be removed in future implementations\&. -.TP 0.2i -\(bu -A constant field values page (constant-values\&.html) for the values of static fields\&. -.TP 0.2i -\(bu -A serialized form page (serialized-form\&.html) that provides information about serializable and externalizable classes with field and method descriptions\&. The information on this page is of interest to reimplementors, and not to developers who want to use the API\&. To access the serialized form page, go to any serialized class and click \fISerialized Form\fR in the See Also section of the class comment\&. The standard doclet generates a serialized form page that lists any class (public or non-public) that implements Serializable with its \f3readObject\fR and \f3writeObject\fR methods, the fields that are serialized, and the documentation comments from the \f3@serial\fR, \f3@serialField\fR, and \f3@serialData\fR tags\&. Public serializable classes can be excluded by marking them (or their package) with \f3@serial\fR exclude, and package-private serializable classes can be included by marking them (or their package) with an \f3@serial\fR include\&. As of Release 1\&.4, you can generate the complete serialized form for public and private classes by running the \f3javadoc\fR command without specifying the \f3-private\fR option\&. See Options\&. -.TP 0.2i -\(bu -An index page (\f3index-*\&.html\fR) of all class, interface, constructor, field and method names, in alphabetical order\&. The index page is internationalized for Unicode and can be generated as a single file or as a separate file for each starting character (such as A\(enZ for English)\&. -.SS SUPPORT\ PAGES -.TP 0.2i -\(bu -A help page (help-doc\&.html) that describes the navigation bar and the previous pages\&. Use \f3-helpfile\fR to override the default help file with your own custom help file\&. -.TP 0.2i -\(bu -One index\&.html file that creates the HTML frames for display\&. Load this file to display the front page with frames\&. The index\&.html file contains no text content\&. -.TP 0.2i -\(bu -Several frame files (\f3*-frame\&.html\fR) that contains lists of packages, classes, and interfaces\&. The frame files display the HTML frames\&. -.TP 0.2i -\(bu -A package list file (package-list) that is used by the \f3-link\fR and \f3-linkoffline\fR options\&. The package list file is a text file that is not reachable through links\&. -.TP 0.2i -\(bu -A style sheet file (stylesheet\&.css) that controls a limited amount of color, font family, font size, font style, and positioning information on the generated pages\&. -.TP 0.2i -\(bu -A doc-files directory that holds image, example, source code, or other files that you want copied to the destination directory\&. These files are not processed by the \f3javadoc\fR command\&. This directory is not processed unless it exists in the source tree\&. -.PP -See Options\&. -.SS HTML\ FRAMES -The \f3javadoc\fR command generates the minimum number of frames (two or three) necessary based on the values passed to the command\&. It omits the list of packages when you pass a single package name or source files that belong to a single package as an argument to the \f3javadoc\fR command\&. Instead, the \f3javadoc\fR command creates one frame in the left-hand column that displays the list of classes\&. When you pass two or more package names, the \f3javadoc\fR command creates a third frame that lists all packages and an overview page (overview-summary\&.html)\&. To bypass frames, click the \fINo Frames\fR link or enter the page set from the overview-summary\&.html page\&. -.SS GENERATED\ FILE\ STRUCTURE -The generated class and interface files are organized in the same directory hierarchy that Java source files and class files are organized\&. This structure is one directory per subpackage\&. -.PP -For example, the document generated for the \f3java\&.applet\&.Applet\fR class would be located at java/applet/Applet\&.html\&. -.PP -The file structure for the \f3java\&.applet\fR package follows, assuming that the destination directory is named \f3apidocs\fR\&. All files that contain the word \fIframe\fR appear in the upper-left or lower-left frames, as noted\&. All other HTML files appear in the right-hand frame\&. -.PP -Directories are bold\&. The asterisks (*) indicate the files and directories that are omitted when the arguments to the \f3javadoc\fR command are source file names rather than package names\&. When arguments are source file names, an empty package list is created\&. The doc-files directory is not created in the destination unless it exists in the source tree\&. See Generated Files\&. -.TP 0.2i -\(bu -\fIapidocs\fR: Top-level directory -.RS -.TP 0.2i -\(bu -index\&.html: Initial Page that sets up HTML frames -.TP 0.2i -\(bu -*overview-summary\&.html: Package list with summaries -.TP 0.2i -\(bu -overview-tree\&.html: Class hierarchy for all packages -.TP 0.2i -\(bu -deprecated-list\&.html: Deprecated APIs for all packages -.TP 0.2i -\(bu -constant-values\&.html: Static field values for all packages -.TP 0.2i -\(bu -serialized-form\&.html: Serialized forms for all packages -.TP 0.2i -\(bu -*overview-frame\&.html: All packages for display in upper-left frame -.TP 0.2i -\(bu -allclasses-frame\&.html: All classes for display in lower-left frame -.TP 0.2i -\(bu -help-doc\&.html: Help about Javadoc page organization -.TP 0.2i -\(bu -index-all\&.html: Default index created without \f3-splitindex\fR option -.TP 0.2i -\(bu -\fIindex-files\fR: Directory created with \f3-splitindex\fR option -.RS -.TP 0.2i -\(bu -index-<number>\&.html: Index files created with \f3-splitindex\fR option -.RE - -.TP 0.2i -\(bu -package-list: Package names for resolving external references -.TP 0.2i -\(bu -stylesheet\&.css: Defines fonts, colors, positions, and so on -.RE - -.TP 0.2i -\(bu -\fIjava\fR: Package directory -.RS -.TP 0.2i -\(bu -\fIapplet\fR: Subpackage directory -.RS -.TP 0.2i -\(bu -Applet\&.html: \f3Applet\fR class page -.TP 0.2i -\(bu -AppletContext\&.html: \f3AppletContext\fR interface -.TP 0.2i -\(bu -AppletStub\&.html: \f3AppletStub\fR interface -.TP 0.2i -\(bu -AudioClip\&.html: \f3AudioClip\fR interface -.TP 0.2i -\(bu -package-summary\&.html: Classes with summaries -.TP 0.2i -\(bu -package-frame\&.html: Package classes for display in lower-left frame -.TP 0.2i -\(bu -package-tree\&.html: Class hierarchy for this package -.TP 0.2i -\(bu -package-use\&.html: Where this package is used -.TP 0.2i -\(bu -\fIdoc-files\fR: Image and example files directory -.TP 0.2i -\(bu -\fIclass-use\fR: Image and examples file location - -- Applet\&.html: Uses of the Applet class - -- AppletContext\&.html: Uses of the \f3AppletContext\fR interface - -- AppletStub\&.html: Uses of the \f3AppletStub\fR interface - -- AudioClip\&.html: Uses of the \f3AudioClip\fR interface -.RE - -.RE - -.TP 0.2i -\(bu -\fIsrc-html\fR: Source code directory -.RS -.TP 0.2i -\(bu -\fIjava\fR: Package directory -.RS -.TP 0.2i -\(bu -\fIapplet\fR: Subpackage directory - -- Applet\&.html: Applet source code - -- AppletContext\&.html: \f3AppletContext\fR source code - -- AppletStub\&.html: \f3AppletStub\fR source code - -- AudioClip\&.html: \f3AudioClip\fR source code -.RE - -.RE - -.SS GENERATED\ API\ DECLARATIONS -The \f3javadoc\fR command generates a declaration at the start of each class, interface, field, constructor, and method description for that API item\&. For example, the declaration for the \f3Boolean\fR class is: -.sp -.nf -\f3public final class Boolean\fP -.fi -.nf -\f3extends Object\fP -.fi -.nf -\f3implements Serializable\fP -.fi -.nf -\f3\fP -.fi -.sp -The declaration for the \f3Boolean\&.valueOf\fR method is: -.sp -.nf -\f3public static Boolean valueOf(String s)\fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3javadoc\fR command can include the modifiers \f3public\fR, \f3protected\fR, \f3private\fR, \f3abstract\fR, \f3final\fR, \f3static\fR, \f3transient\fR, and \f3volatile\fR, but not \f3synchronized\fR or \f3native\fR\&. The \f3synchronized\fR and \f3native\fR modifiers are considered implementation detail and not part of the API specification\&. -.PP -Rather than relying on the keyword \f3synchronized\fR, APIs should document their concurrency semantics in the main description of the comment\&. For example, a description might be: A single enumeration cannot be used by multiple threads concurrently\&. The document should not describe how to achieve these semantics\&. As another example, while the \f3Hashtable\fR option should be thread-safe, there is no reason to specify that it is achieved by synchronizing all of its exported methods\&. It is better to reserve the right to synchronize internally at the bucket level for higher concurrency\&. -.SH DOCUMENTATION\ COMMENTS -This section describes source code comments and comment inheritance\&. -.SS SOURCE\ CODE\ COMMENTS -You can include documentation comments in the source code, ahead of declarations for any class, interface, method, constructor, or field\&. You can also create documentation comments for each package and another one for the overview, though their syntax is slightly different\&. A documentation comment consists of the characters between \f3/**\fR and \f3*/\fR that end it\&. Leading asterisks are allowed on each line and are described further in the following section\&. The text in a comment can continue onto multiple lines\&. -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * This is the typical format of a simple documentation comment\fP -.fi -.nf -\f3 * that spans two lines\&.\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.sp -To save space you can put a comment on one line: -.sp -.nf -\f3/** This comment takes up only one line\&. */\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Placement of Comments - -Documentation comments are recognized only when placed immediately before class, interface, constructor, method, or field declarations\&. Documentation comments placed in the body of a method are ignored\&. The \f3javadoc\fR command recognizes only one documentation comment per declaration statement\&. See Where Tags Can Be Used\&. -.PP -A common mistake is to put an \f3import\fR statement between the class comment and the class declaration\&. Do not put an \f3import\fR statement at this location because the \f3javadoc\fR command ignores the class comment\&. -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * This is the class comment for the class Whatever\&.\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3import com\&.example; // MISTAKE \- Important not to put import statement here\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3public class Whatever{ }\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Parts of Comments - -A documentation comment has a main description followed by a tag section\&. The main description begins after the starting delimiter \f3/**\fR and continues until the tag section\&. The tag section starts with the first block tag, which is defined by the first \f3@\fR character that begins a line (ignoring leading asterisks, white space, and leading separator \f3/**\fR)\&. It is possible to have a comment with only a tag section and no main description\&. The main description cannot continue after the tag section begins\&. The argument to a tag can span multiple lines\&. There can be any number of tags, and some types of tags can be repeated while others cannot\&. For example, this \f3@see\fR tag starts the tag section: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * This sentence holds the main description for this documentation comment\&.\fP -.fi -.nf -\f3 * @see java\&.lang\&.Object\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Block and inline Tags - -A tag is a special keyword within a documentation comment that the \f3javadoc\fR command processes\&. There are two kinds of tags: block tags, which appear as an \f3@tag\fR tag (also known as standalone tags), and inline tags, which appear within braces, as an \f3{@tag}\fR tag\&. To be interpreted, a block tag must appear at the beginning of a line, ignoring leading asterisks, white space, and the separator (\f3/**\fR)\&. This means you can use the \f3@\fR character elsewhere in the text and it will not be interpreted as the start of a tag\&. If you want to start a line with the \f3@\fR character and not have it be interpreted, then use the HTML entity \f3@\fR\&. Each block tag has associated text, which includes any text following the tag up to, but not including, either the next tag, or the end of the documentation comment\&. This associated text can span multiple lines\&. An inline tag is allowed and interpreted anywhere that text is allowed\&. The following example contains the \f3@deprecated\fR block tag and the \f3{@link}\fR inline tag\&. See Javadoc Tags\&. -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * @deprecated As of JDK 1\&.1, replaced by {@link #setBounds(int,int,int,int)}\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Write Comments in HTML - -The text must be written in HTML with HTML entities and HTML tags\&. You can use whichever version of HTML your browser supports\&. The standard doclet generates HTML 3\&.2-compliant code elsewhere (outside of the documentation comments) with the inclusion of cascading style sheets and frames\&. HTML 4\&.0 is preferred for generated files because of the frame sets\&. -.PP -For example, entities for the less than symbol (<) and the greater than symbol (>) should be written as \f3<\fR and \f3>\fR\&. Similarly, the ampersand (&) should be written as \f3&\fR\&. The bold HTML tag \f3<b>\fR is shown in the following example\&. -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * This is a <b>doc</b> comment\&.\fP -.fi -.nf -\f3 * @see java\&.lang\&.Object\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Leading Asterisks - -When the \f3javadoc\fR command parses a documentation comment, leading asterisks (*) on each line are discarded, and blanks and tabs that precede the initial asterisks (*) are also discarded\&. If you omit the leading asterisk on a line, then the leading white space is no longer removed so that you can paste code examples directly into a documentation comment inside a \f3<PRE>\fR tag with its indentation preserved\&. Spaces are interpreted by browsers more uniformly than tabs\&. Indentation is relative to the left margin (rather than the separator \f3/**\fR or \f3<PRE>\fR tag)\&. -.PP -First Sentence - -The first sentence of each documentation comment should be a summary sentence that contains a concise but complete description of the declared entity\&. This sentence ends at the first period that is followed by a blank, tab, or line terminator, or at the first block tag\&. The \f3javadoc\fR command copies this first sentence to the member summary at the top of the HTML page\&. -.PP -Multiple-Field Declarations - -The Java platform lets you declare multiple fields in a single statement, but this statement can have only one documentation comment that is copied for all fields\&. If you want individual documentation comments for each field, then declare each field in a separate statement\&. For example, the following documentation comment does not make sense written as a single declaration and would be better handled as two declarations: -.sp -.nf -\f3/** \fP -.fi -.nf -\f3 * The horizontal and vertical distances of point (x,y)\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3public int x, y; // Avoid this \fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3javadoc\fR command generates the following documentation from the previous code: -.sp -.nf -\f3public int x\fP -.fi -.nf -\f3\fP -.fi -.sp -The horizontal and vertical distances of point (x, y)\&. -.sp -.nf -\f3public int y\fP -.fi -.nf -\f3\fP -.fi -.sp -The horizontal and vertical distances of point (x, y)\&. -.PP -Use of Header Tags - -When writing documentation comments for members, it is best not to use HTML heading tags such as \f3<H1>\fR and \f3<H2>\fR, because the \f3javadoc\fR command creates an entire structured document, and these structural tags might interfere with the formatting of the generated document\&. However, you can use these headings in class and package comments to provide your own structure\&. -.SS METHOD\ COMMENT\ INHERITANCE -The \f3javadoc\fR command allows method comment inheritance in classes and interfaces to fill in missing text or to explicitly inherit method comments\&. Constructors, fields, and nested classes do not inherit documentation comments\&. -.PP -\fINote:\fR The source file for an inherited method must be on the path specified by the \f3-sourcepath\fR option for the documentation comment to be available to copy\&. Neither the class nor its package needs to be passed in on the command line\&. This contrasts with Release 1\&.3\&.\fIn\fR and earlier releases, where the class had to be a documented class\&. -.PP -Fill in Missing Text - -When a main description, or \f3@return\fR, \f3@param\fR, or \f3@throws\fR tag is missing from a method comment, the \f3javadoc\fR command copies the corresponding main description or tag comment from the method it overrides or implements (if any)\&. See Method Comment Inheritance\&. -.PP -When an \f3@param\fR tag for a particular parameter is missing, the comment for that parameter is copied from the method further up the inheritance hierarchy\&. When an \f3@throws\fR tag for a particular exception is missing, the \f3@throws\fR tag is copied only when that exception is declared\&. -.PP -This behavior contrasts with Release 1\&.3 and earlier, where the presence of any main description or tag would prevent all comments from being inherited\&. -.PP -See Javadoc Tags and Options\&. -.PP -Explicit Inheritance - -Insert the \f3{@inheritDoc}\fR inline tag in a method main description or \f3@return\fR, \f3@param\fR, or \f3@throws\fR tag comment\&. The corresponding inherited main description or tag comment is copied into that spot\&. -.SS CLASS\ AND\ INTERFACE\ INHERITANCE -Comment inheritance occurs in all possible cases of inheritance from classes and interfaces: -.TP 0.2i -\(bu -When a method in a class overrides a method in a superclass -.TP 0.2i -\(bu -When a method in an interface overrides a method in a superinterface -.TP 0.2i -\(bu -When a method in a class implements a method in an interface -.PP -In the first two cases, the \f3javadoc\fR command generates the subheading \fIOverrides\fR in the documentation for the overriding method\&. A link to the method being overridden is included, whether or not the comment is inherited\&. -.PP -In the third case, when a method in a specified class implements a method in an interface, the \f3javadoc\fR command generates the subheading \fISpecified by\fR in the documentation for the overriding method\&. A link to the method being implemented is included, whether or not the comment is inherited\&. -.SS METHOD\ COMMENTS\ ALGORITHM -If a method does not have a documentation comment, or has an \f3{@inheritDoc}\fR tag, then the \f3javadoc\fR command uses the following algorithm to search for an applicable comment\&. The algorithm is designed to find the most specific applicable documentation comment, and to give preference to interfaces over superclasses: -.TP 0.4i -1\&. -Look in each directly implemented (or extended) interface in the order they appear following the word \f3implements\fR (or \f3extends\fR) in the method declaration\&. Use the first documentation comment found for this method\&. -.TP 0.4i -2\&. -If Step 1 failed to find a documentation comment, then recursively apply this entire algorithm to each directly implemented (or extended) interface in the same order they were examined in Step 1\&. -.TP 0.4i -3\&. -When Step 2 fails to find a documentation comment and this is a class other than the \f3Object\fR class, but not an interface: -.RS -.TP 0.4i -1\&. -If the superclass has a documentation comment for this method, then use it\&. -.TP 0.4i -2\&. -If Step 3a failed to find a documentation comment, then recursively apply this entire algorithm to the superclass\&. -.RE - -.SH JAVADOC\ TAGS -The \f3javadoc\fR command parses special tags when they are embedded within a Java documentation comment\&. The \f3javadoc\fR tags let you autogenerate a complete, well-formatted API from your source code\&. The tags start with an at sign (\f3@\fR) and are case-sensitive\&. They must be typed with the uppercase and lowercase letters as shown\&. A tag must start at the beginning of a line (after any leading spaces and an optional asterisk), or it is treated as text\&. By convention, tags with the same name are grouped together\&. For example, put all \f3@see\fR tags together\&. For more information, see Where Tags Can Be Used\&. -.PP -Tags have the following types: -.TP 0.2i -\(bu -Bock tags: Place block tags only in the tag section that follows the description\&. Block tags have the form: \fI@tag\fR\&. -.TP 0.2i -\(bu -Inline tags: Place inline tags anywhere in the main description or in the comments for block tags\&. Inline tags are enclosed within braces: \fI{@tag}\fR\&. -.PP -For custom tags, see -tag tagname:Xaoptcmf:"taghead"\&. See also Where Tags Can Be Used\&. -.SS TAG\ DESCRIPTIONS -.TP -@author \fIname-text\fR -Introduced in JDK 1\&.0 - -Adds an Author entry with the specified name text to the generated documents when the \f3-author\fR option is used\&. A documentation comment can contain multiple \f3@author\fR tags\&. You can specify one name per \f3@author\fR tag or multiple names per tag\&. In the former case, the \f3javadoc\fR command inserts a comma (,) and space between names\&. In the latter case, the entire text is copied to the generated document without being parsed\&. Therefore, you can use multiple names per line if you want a localized name separator other than a comma\&. See @author in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@author -.TP -{@code \fItext\fR} -Introduced in JDK 1\&.5 - -Equivalent to \f3<code>{@literal}</code>\fR\&. - -Displays text in code font without interpreting the text as HTML markup or nested Javadoc tags\&. This enables you to use regular angle brackets (< and >) instead of the HTML entities (\f3<\fR and \f3>\fR) in documentation comments, such as in parameter types (\f3<Object>\fR), inequalities (\f33 < 4\fR), or arrows (\f3<-\fR)\&. For example, the documentation comment text \f3{@code A<B>C}\fR displayed in the generated HTML page unchanged as \f3A<B>C\fR\&. This means that the \f3<B>\fR is not interpreted as bold and is in code font\&. If you want the same functionality without the code font, then use the \f3{@literal}\fR tag\&. -.TP -@deprecated \fIdeprecated-text\fR -Introduced in JDK 1\&.0 - -Adds a comment indicating that this API should no longer be used (even though it may continue to work)\&. The \f3javadoc\fR command moves \f3deprecated-text\fRahead of the main description, placing it in italics and preceding it with a bold warning: Deprecated\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field\&. - -The first sentence of deprecated text should tell the user when the API was deprecated and what to use as a replacement\&. The \f3javadoc\fR command copies the first sentence to the summary section and index\&. Subsequent sentences can also explain why it was deprecated\&. You should include an \f3{@link}\fR tag (for Javadoc 1\&.2 or later) that points to the replacement API\&. - -Use the \fI@deprecated annotation\fR tag to deprecate a program element\&. See How and When to Deprecate APIs at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/deprecation/deprecation\&.html - -See also @deprecated in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@deprecated -.TP -{@docRoot} -Introduced in JDK 1\&.3 - -Represents the relative path to the generated document\&'s (destination) root directory from any generated page\&. This tag is useful when you want to include a file, such as a copyright page or company logo, that you want to reference from all generated pages\&. Linking to the copyright page from the bottom of each page is common\&. - -This \f3{@docRoot}\fR tag can be used both on the command line and in a documentation comment\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field, and includes the text portion of any tag (such as the \f3@return\fR, \f3@param\fR and \f3@deprecated\fR tags)\&. -.RS -.TP 0.2i -\(bu -On the command line, where the header, footer, or bottom are defined: \f3javadoc -bottom \&'<a href="{@docRoot}/copyright\&.html">Copyright</a>\&'\fR\&. - -When you use the \f3{@docRoot}\fR tag this way in a make file, some \f3makefile\fR programs require a special way to escape for the brace \f3{}\fR characters\&. For example, the Inprise MAKE version 5\&.2 running on Windows requires double braces: \f3{{@docRoot}}\fR\&. It also requires double (rather than single) quotation marks to enclose arguments to options such as the \f3-bottom\fR option (with the quotation marks around the \f3href\fR argument omitted)\&. -.TP 0.2i -\(bu -In a documentation comment: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * See the <a href="{@docRoot}/copyright\&.html">Copyright</a>\&.\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.sp - - -This tag is needed because the generated documents are in hierarchical directories, as deep as the number of subpackages\&. The expression: \f3<a href="{@docRoot}/copyright\&.html">\fR resolves to \f3<a href="\&.\&./\&.\&./copyright\&.html">\fR for \f3java/lang/Object\&.java\fR and \f3<a href="\&.\&./\&.\&./\&.\&./copyright\&.html">\fR for \f3java/lang/ref/Reference\&.java\fR\&. -.RE - -.TP -@exception \fIclass-name description\fR -Introduced in JDK 1\&.0 - -Identical to the \f3@throws\fR tag\&. See @throws class-name description\&. -.TP -{@inheritDoc} -Introduced in JDK 1\&.4 - -Inherits (copies) documentation from the nearest inheritable class or implementable interface into the current documentation comment at this tag\&'s location\&. This enables you to write more general comments higher up the inheritance tree and to write around the copied text\&. - -This tag is valid only in these places in a documentation comment: -.RS -.TP 0.2i -\(bu -In the main description block of a method\&. In this case, the main description is copied from a class or interface up the hierarchy\&. -.TP 0.2i -\(bu -In the text arguments of the \f3@return\fR, \f3@param,\fR and \f3@throws\fR tags of a method\&. In this case, the tag text is copied from the corresponding tag up the hierarchy\&. -.RE - - -See Method Comment Inheritance for a description of how comments are found in the inheritance hierarchy\&. Note that if this tag is missing, then the comment is or is not automatically inherited according to rules described in that section\&. -.TP -{@link \fIpackage\&.class#member label\fR} -Introduced in JDK 1\&.2 - -Inserts an inline link with a visible text label that points to the documentation for the specified package, class, or member name of a referenced class\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field, including the text portion of any tag, such as the \f3@return\fR, \f3@param\fR and \f3@deprecated\fR tags\&. See @link in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#{@link - -This tag is similar to the \f3@see\fR tag\&. Both tags require the same references and accept the same syntax for \f3package\&.class#member\fR and \f3label\fR\&. The main difference is that the \f3{@link}\fR tag generates an inline link rather than placing the link in the See Also section\&. The \f3{@link}\fR tag begins and ends with braces to separate it from the rest of the inline text\&. If you need to use the right brace (\f3}\fR) inside the label, then use the HTML entity notation \f3}\fR\&. - -There is no limit to the number of \f3{@link}\fR tags allowed in a sentence\&. You can use this tag in the main description part of any documentation comment or in the text portion of any tag, such as the \f3@deprecated\fR, \f3@return\fR or \f3@param\fR tags\&. - -For example, here is a comment that refers to the \f3getComponentAt(int, int)\fR method: -.sp -.nf -\f3Use the {@link #getComponentAt(int, int) getComponentAt} method\&.\fP -.fi -.nf -\f3\fP -.fi -.sp - - -From this code, the standard doclet generates the following HTML (assuming it refers to another class in the same package): -.sp -.nf -\f3Use the <a href="Component\&.html#getComponentAt(int, int)">getComponentAt</a> method\&.\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The previous line appears on the web page as: -.sp -.nf -\f3Use the getComponentAt method\&.\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -{@linkplain \fIpackage\&.class#member label\fR} -Introduced in JDK 1\&.4 - -Behaves the same as the \f3{@link}\fR tag, except the link label is displayed in plain text rather than code font\&. Useful when the label is plain text\&. For example, \f3Refer to {@linkplain add() the overridden method}\fR\&. displays as: Refer to the overridden method\&. -.TP -{@literal \fItext\fR} -Introduced in JDK 1\&.5 - -Displays text without interpreting the text as HTML markup or nested Javadoc tags\&. This enables you to use angle brackets (\f3< and >\fR) instead of the HTML entities (\f3<\fR and \f3>\fR) in documentation comments, such as in parameter types (\f3<Object>\fR), inequalities (\f33 < 4\fR), or arrows (<-)\&. For example, the documentation comment text \f3{@literal A<B>C}\fR displays unchanged in the generated HTML page in your browser, as \f3A<B>C\fR\&. The \f3<B>\fR is not interpreted as bold (and it is not in code font)\&. If you want the same functionality with the text in code font, then use the \f3{@code}\fR tag\&. -.TP -@param \fIparameter-name description\fR -Introduced in JDK 1\&.0 - -Adds a parameter with the specified \f3parameter-name\fR followed by the specified description to the Parameters section\&. When writing the documentation comment, you can continue the description onto multiple lines\&. This tag is valid only in a documentation comment for a method, constructor, or class\&. See @param in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@param - -The \f3parameter-name\fR can be the name of a parameter in a method or constructor, or the name of a type parameter of a class, method, or constructor\&. Use angle brackets around this parameter name to specify the use of a type parameter\&. - -Example of a type parameter of a class: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * @param <E> Type of element stored in a list\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3public interface List<E> extends Collection<E> {\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - - -Example of a type parameter of a method: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * @param string the string to be converted\fP -.fi -.nf -\f3 * @param type the type to convert the string to\fP -.fi -.nf -\f3 * @param <T> the type of the element\fP -.fi -.nf -\f3 * @param <V> the value of the element\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3<T, V extends T> V convert(String string, Class<T> type) {\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -@return \fIdescription\fR -Introduced in JDK 1\&.0 - -Adds a Returns section with the description text\&. This text should describe the return type and permissible range of values\&. This tag is valid only in a documentation comment for a method\&. See @return in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@return -.TP -@see \fIreference\fR -Introduced in JDK 1\&.0 - -Adds a \fISee Also\fR heading with a link or text entry that points to a reference\&. A documentation comment can contain any number of \f3@see\fR tags, which are all grouped under the same heading\&. The \f3@see\fR tag has three variations\&. The form is the most common\&. This tag is valid in any documentation comment: overview, package, class, interface, constructor, method, or field\&. For inserting an inline link within a sentence to a package, class, or member, see \f3{@link}\fR\&. - -\fIForm 1\fR\&. The @see \f3string\fR tag form adds a text entry for \fIstring\fR\&. No link is generated\&. The string is a book or other reference to information not available by URL\&. The \f3javadoc\fR command distinguishes this from the previous cases by searching for a double quotation mark (") as the first character\&. For example, \f3@see "The Java Programming Language"\fR that generates the following text: - -\fISee Also\fR: - -"The Java Programming Language" - -\fIForm 2\fR\&. The \f3@see <a href="URL#value">label</a>\fR form adds a link as defined by \f3URL#value\fR\&. The \f3URL#value\fR parameter is a relative or absolute URL\&. The \f3javadoc\fR command distinguishes this from other cases by searching for a less-than symbol (\f3<\fR) as the first character\&. For example, \f3@see <a href="spec\&.html#section">Java Spec</a>\fR generates the following link: - -\fISee Also\fR: - -Java Spec - -\fIForm 3\fR\&. The \f3@see package\&.class#member label\fR form adds a link with a visible text label that points to the documentation for the specified name in the Java Language that is referenced\&. The label is optional\&. If the label is omitted, then the name appears instead as visible text, suitably shortened\&. Use the \f3-noqualifier\fR option to globally remove the package name from this visible text\&. Use the label when you want the visible text to be different from the autogenerated visible text\&. See How a Name Appears\&. - -In Java SE 1\&.2 only, the name but not the label automatically appears in \f3<code>\fR HTML tags\&. Starting with Java SE 1\&.2\&.2, the \f3<code>\fR tag is always included around the visible text, whether or not a label is used\&. -.RS -.TP 0.2i -\(bu -\f3package\&.class#member\fR is any valid program element name that is referenced, such as a package, class, interface, constructor, method or field name, except that the character ahead of the member name should be a number sign (\f3#\fR)\&. The class represents any top-level or nested class or interface\&. The member represents any constructor, method, or field (not a nested class or interface)\&. If this name is in the documented classes, then the \f3javadoc\fR command create a link to it\&. To create links to external referenced classes, use the \f3-link\fR option\&. Use either of the other two \f3@see\fR tag forms to refer to the documentation of a name that does not belong to a referenced class\&. See Specify a Name\&. - -\fINote:\fR External referenced classes are classes that are not passed into the \f3javadoc\fR command on the command line\&. Links in the generated documentation to external referenced classes are called external references or external links\&. For example, if you run the \f3javadoc\fR command on only the \f3java\&.awt package\fR, then any class in \f3java\&.lang\fR, such as \f3Object\fR, is an external referenced class\&. Use the \f3-link\fR and \f3-linkoffline\fR options to link to external referenced classes\&. The source comments of external referenced classes are not available to the \f3javadoc\fR command run\&. -.TP 0.2i -\(bu -\f3label\fR is optional text that is visible as the link label\&. The label can contain white space\&. If \f3label\fR is omitted, then \f3package\&.class\&.member\fR appears, suitably shortened relative to the current class and package\&. See How a Name Appears\&. -.TP 0.2i -\(bu -A space is the delimiter between \f3package\&.class#member\fR and \f3label\fR\&. A space inside parentheses does not indicate the start of a label, so spaces can be used between parameters in a method\&. -.RE - - -\fI\fRIn the following example, an \f3@see\fR tag (in the \f3Character\fR class) refers to the equals method in the \f3String\fR class\&. The tag includes both arguments: the name \f3String#equals(Object)\fR and the label \f3equals\fR\&. -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * @see String#equals(Object) equals\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The standard doclet produces HTML that is similar to: -.sp -.nf -\f3<dl>\fP -.fi -.nf -\f3<dt><b>See Also:</b>\fP -.fi -.nf -\f3<dd><a href="\&.\&./\&.\&./java/lang/String#equals(java\&.lang\&.Object)"><code>equals<code></a>\fP -.fi -.nf -\f3</dl>\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The previous code looks similar to the following in a browser, where the label is the visible link text: - -\fISee Also\fR: - -equals -.PP -Specify a Name - -\fI\fRThis \f3package\&.class#member\fR name can be either fully qualified, such as \f3java\&.lang\&.String#toUpperCase()\fR or not, such as \f3String#toUpperCase()\fR or \f3#toUpperCase()\fR\&. If the name is less than fully qualified, then the \f3javadoc\fR command uses the standard Java compiler search order to find it\&. See Search Order for the @see Tag\&. The name can contain white space within parentheses, such as between method arguments\&.The advantage to providing shorter, partially qualified names is that they are shorter to type and there is less clutter in the source code\&. The following listing shows the different forms of the name, where \f3Class\fR can be a class or interface; Type can be a class, interface, array, or primitive; and method can be a method or constructor\&. -.sp -.nf -\f3\fITypical forms for\fR\fI @see package\&.class#member\fR\fP -.fi -.nf -\f3\fIReferencing a member of the current class\fR\fP -.fi -.nf -\f3@see #field\fP -.fi -.nf -\f3@see #method(Type, Type,\&.\&.\&.)\fP -.fi -.nf -\f3@see #method(Type argname, Type argname,\&.\&.\&.)\fP -.fi -.nf -\f3@see #constructor(Type, Type,\&.\&.\&.)\fP -.fi -.nf -\f3@see #constructor(Type argname, Type argname,\&.\&.\&.) \fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\fIReferencing another class in the current or imported packages\fR\fP -.fi -.nf -\f3@see Class#field\fP -.fi -.nf -\f3@see Class#method(Type, Type,\&.\&.\&.)\fP -.fi -.nf -\f3@see Class#method(Type argname, Type argname,\&.\&.\&.)\fP -.fi -.nf -\f3@see Class#constructor(Type, Type,\&.\&.\&.)\fP -.fi -.nf -\f3@see Class#constructor(Type argname, Type argname,\&.\&.\&.)\fP -.fi -.nf -\f3@see Class\&.NestedClass\fP -.fi -.nf -\f3@see Class \fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\fIReferencing an element in another package (fully qualified)\fR\fP -.fi -.nf -\f3@see package\&.Class#field\fP -.fi -.nf -\f3@see package\&.Class#method(Type, Type,\&.\&.\&.)\fP -.fi -.nf -\f3@see package\&.Class#method(Type argname, Type argname,\&.\&.\&.)\fP -.fi -.nf -\f3@see package\&.Class#constructor(Type, Type,\&.\&.\&.)\fP -.fi -.nf -\f3@see package\&.Class#constructor(Type argname, Type argname,\&.\&.\&.)\fP -.fi -.nf -\f3@see package\&.Class\&.NestedClass\fP -.fi -.nf -\f3@see package\&.Class\fP -.fi -.nf -\f3@see package\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3\fRNotes about the previous listing: -.TP 0.2i -\(bu -The first set of forms with no class or package causes the \f3javadoc\fR command to search only through the current class hierarchy\&. It finds a member of the current class or interface, one of its superclasses or superinterfaces, or one of its enclosing classes or interfaces (search Items 1\(en3)\&. It does not search the rest of the current package or other packages (search Items 4\(en5)\&. See Search Order for the @see Tag\&. -.TP 0.2i -\(bu -If any method or constructor is entered as a name with no parentheses, such as \f3getValue\fR, and if there is no field with the same name, then the \f3javadoc\fR command still creates a link to the method\&. If this method is overloaded, then the \f3javadoc\fR command links to the first method its search encounters, which is unspecified\&. -.TP 0.2i -\(bu -Nested classes must be specified as \f3outer\&.inner\fR, not simply \f3inner\fR, for all forms\&. -.TP 0.2i -\(bu -As stated, the number sign (\f3#\fR), rather than a dot (\f3\&.\fR) separates a member from its class\&. This enables the \f3javadoc\fR command to resolve ambiguities, because the dot also separates classes, nested classes, packages, and subpackages\&. However, the \f3javadoc\fR command properly parses a dot when there is no ambiguity, but prints a warning to alert you\&. -.PP -Search Order for the @see Tag - -\fI\fRThe \f3javadoc\fR command processes an \f3@see\fR tag that appears in a source file, package file, or overview file\&. In the latter two files, you must fully qualify the name you supply with the \f3@see\fR tag\&. In a source file, you can specify a name that is fully qualified or partially qualified\&. -.PP -The following is the search order for the \f3@see\fR tag\&. -.TP 0.4i -1\&. -The current class or interface\&. -.TP 0.4i -2\&. -Any enclosing classes and interfaces searching the closest first\&. -.TP 0.4i -3\&. -Any superclasses and superinterfaces, searching the closest first\&. -.TP 0.4i -4\&. -The current package\&. -.TP 0.4i -5\&. -Any imported packages, classes, and interfaces, searching in the order of the \f3import\fR statement\&. -.PP -The \f3javadoc\fR command continues to search recursively through Items 1-3 for each class it encounters until it finds a match\&. That is, after it searches through the current class and its enclosing class E, it searches through the superclasses of E before the enclosing classes of E\&. In Items 4 and 5, the \f3javadoc\fR command does not search classes or interfaces within a package in any specified order (that order depends on the particular compiler)\&. In Item 5, the \f3javadoc\fR command searches in \fIjava\&.lang\fR because that is imported by all programs\&. -.PP -When the \f3javadoc\fR command encounters an \f3@see\fR tag in a source file that is not fully qualified, it searches for the specified name in the same order as the Java compiler would, except the \f3javadoc\fR command does not detect certain name space ambiguities because it assumes the source code is free of these errors\&. This search order is formally defined in the Java Language Specification\&. The \f3javadoc\fR command searches for that name through all related and imported classes and packages\&. In particular, it searches in this order: -.TP 0.4i -1\&. -The current class or interface\&. -.TP 0.4i -2\&. -Any enclosing classes and interfaces, searching the closest first\&. -.TP 0.4i -3\&. -Any superclasses and superinterfaces, searching the closest first\&. -.TP 0.4i -4\&. -The current package\&. -.TP 0.4i -5\&. -Any imported packages, classes, and interfaces, searching in the order of the \f3import\fR statements\&. -.PP -The \f3javadoc\fR command does not necessarily look in subclasses, nor will it look in other packages even when their documentation is being generated in the same run\&. For example, if the \f3@see\fR tag is in the \f3java\&.awt\&.event\&.KeyEvent\fR class and refers to a name in the \f3java\&.awt package\fR, then the \f3javadoc\fR command does not look in that package unless that class imports it\&. -.PP -How a Name Appears - -\fI\fRIf \f3label\fR is omitted, then \f3package\&.class\&.member\fR appears\&. In general, it is suitably shortened relative to the current class and package\&. Shortened means the \f3javadoc\fR command displays only the minimum name necessary\&. For example, if the \f3String\&.toUpperCase()\fR method contains references to a member of the same class and to a member of a different class, then the class name is displayed only in the latter case, as shown in the following listing\&. Use the \f3-noqualifier\fR option to globally remove the package names\&. -.PP -\fIType of reference\fR: The \f3@see\fR tag refers to a member of the same class, same package -.br -\fIExample in\fR: \f3@see String#toLowerCase()\fR -.br -\fIAppears as\fR: \f3toLowerCase()\fR - omits the package and class names -.br - -.PP -\fIType of reference\fR: The \f3@see\fR tag refers to a member of a different class, same package -.br -\fIExample in\fR: \f3@see Character#toLowerCase(char)\fR -.br -\fIAppears as\fR: \f3Character\&.toLowerCase(char)\fR - omits the package name, includes the class name -.br - -.PP -\fIType of reference\fR: The \f3@see\fR tag refers to a member of a different class, different package -.br -\fIExample in\fR: \f3@see java\&.io\&.File#exists()\fR -.br -\fIAppears as\fR: \f3java\&.io\&.File\&.exists()\fR - includes the package and class names -.br - -.PP -Examples of the @see Tag - -The comment to the right shows how the name appears when the \f3@see\fR tag is in a class in another package, such as \f3java\&.applet\&.Applet\fR\&. See @see in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@see -.sp -.nf -\f3 See also:\fP -.fi -.nf -\f3@see java\&.lang\&.String // String \fP -.fi -.nf -\f3@see java\&.lang\&.String The String class // The String class \fP -.fi -.nf -\f3@see String // String \fP -.fi -.nf -\f3@see String#equals(Object) // String\&.equals(Object) \fP -.fi -.nf -\f3@see String#equals // String\&.equals(java\&.lang\&.Object) \fP -.fi -.nf -\f3@see java\&.lang\&.Object#wait(long) // java\&.lang\&.Object\&.wait(long) \fP -.fi -.nf -\f3@see Character#MAX_RADIX // Character\&.MAX_RADIX \fP -.fi -.nf -\f3@see <a href="spec\&.html">Java Spec</a> // Java Spec \fP -.fi -.nf -\f3@see "The Java Programming Language" // "The Java Programming Language" \fP -.fi -.nf -\f3\fP -.fi -.sp -\fINote:\fR You can extend the \f3@se\fR\f3e\fR tag to link to classes not being documented with the \f3-link\fR option\&. -.TP -@serial \fIfield-description\fR | include | exclude -Introduced in JDK 1\&.2 - -Used in the documentation comment for a default serializable field\&. See Documenting Serializable Fields and Data for a Class at http://docs\&.oracle\&.com/javase/8/docs/platform/serialization/spec/serial-arch\&.html#5251 - -See also Oracle\(cqs Criteria for Including Classes in the Serialized Form Specification at http://www\&.oracle\&.com/technetwork/java/javase/documentation/serialized-criteria-137781\&.html - -An optional \f3field-description\fR should explain the meaning of the field and list the acceptable values\&. When needed, the description can span multiple lines\&. The standard doclet adds this information to the serialized form page\&. See Cross-Reference Pages\&. - -If a serializable field was added to a class after the class was made serializable, then a statement should be added to its main description to identify at which version it was added\&. - -The \f3include\fR and \f3exclude\fR arguments identify whether a class or package should be included or excluded from the serialized form page\&. They work as follows: -.RS -.TP 0.2i -\(bu -A public or protected class that implements \f3Serializable\fR is included unless that class (or its package) is marked with the \f3@serial exclude\fR tag\&. -.TP 0.2i -\(bu -A private or package-private class that implements \f3Serializable\fR is excluded unless that class (or its package) is marked with the \f3@serial include\fR tag\&. -.RE - - -For example, the \f3javax\&.swing\fR package is marked with the \f3@serial\fR\f3exclude\fR tag in package\&.html or package-info\&.java\&. The public class \f3java\&.security\&.BasicPermission\fR is marked with the \f3@serial exclude\fR tag\&. The package-private class \f3java\&.util\&.PropertyPermissionCollection\fR is marked with the \f3@serial include\fR tag\&. - -The \f3@serial\fR tag at the class level overrides the \f3@serial\fR tag at the package level\&. -.TP -@serialData \fIdata-description\fR -Introduced in JDK 1\&.2 - -Uses the data description value to document the types and order of data in the serialized form\&. This data includes the optional data written by the \f3writeObject\fR method and all data (including base classes) written by the \f3Externalizable\&.writeExternal\fR method\&. - -The \f3@serialData\fR tag can be used in the documentation comment for the \f3writeObject\fR, \f3readObject\fR, \f3writeExternal\fR, \f3readExternal\fR, \f3writeReplace\fR, and \f3readResolve\fR methods\&. -.TP -@serialField \fIfield-name\fR\fIfield-type\fR\fIfield-description\fR -Introduced in JDK 1\&.2 - -Documents an \f3ObjectStreamField\fR component of the \f3serialPersistentFields\fR member of a \f3Serializable\fR class\&. Use one \f3@serialField\fR tag for each \f3ObjectStreamField\fR component\&. -.TP -@since \fIsince-text\fR -Introduced in JDK 1\&.1 - -Adds a \fISince\fR heading with the specified \f3since-text\fR value to the generated documentation\&. The text has no special internal structure\&. This tag is valid in any documentation comment: overview, package, class, interface, constructor, method, or field\&. This tag means that this change or feature has existed since the software release specified by the \f3since-text\fR value, for example: \f3@since 1\&.5\fR\&. - -For Java platform source code, the \f3@since\fR tag indicates the version of the Java platform API specification, which is not necessarily when the source code was added to the reference implementation\&. Multiple \f3@since\fR tags are allowed and are treated like multiple \f3@author\fR tags\&. You could use multiple tags when the program element is used by more than one API\&. -.TP -@throws \fIclass-name\fR\fIdescription\fR -Introduced in JDK 1\&.2 - -Behaves the same as the \f3@exception\fR tag\&. See @throws in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@exception - -The \f3@throws\fR tag adds a \fIThrows\fR subheading to the generated documentation, with the \f3class-name\fR and \f3description\fR text\&. The \fIclass-name\fR is the name of the exception that might be thrown by the method\&. This tag is valid only in the documentation comment for a method or constructor\&. If this class is not fully specified, then the \f3javadoc\fR command uses the search order to look up this class\&. Multiple \f3@throws\fR tags can be used in a specified documentation comment for the same or different exceptions\&. See Search Order for the @see Tag\&. - -To ensure that all checked exceptions are documented, when an \f3@throws\fR tag does not exist for an exception in the throws clause, the \f3javadoc\fR command adds that exception to the HTML output (with no description) as though it were documented with the \f3@throws\fR tag\&. - -The \f3@throws\fR documentation is copied from an overridden method to a subclass only when the exception is explicitly declared in the overridden method\&. The same is true for copying from an interface method to an implementing method\&. You can use the \f3{@inheritDoc}\fR tag to force the \f3@throws\fR tag to inherit documentation\&. -.TP -{@value \fIpackage\&.class#field\fR} -Introduced in JDK 1\&.4 - -Displays constant values\&. When the \f3{@value}\fR tag is used without an argument in the documentation comment of a static field, it displays the value of that constant: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * The value of this constant is {@value}\&.\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3public static final String SCRIPT_START = "<script>"\fP -.fi -.nf -\f3\fP -.fi -.sp - - -When used with the argument \f3package\&.class#field\fR in any documentation comment, he \f3{@value}\fR tag displays the value of the specified constant: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * Evaluates the script starting with {@value #SCRIPT_START}\&.\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3public String evalScript(String script) {}\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The argument \f3package\&.class#field\fR takes a form similar to that of the \f3@see\fR tag argument, except that the member must be a static field\&. - -The values of these constants are also displayed in Constant Field Values at http://docs\&.oracle\&.com/javase/8/docs/api/constant-values\&.html -.TP -@version \fIversion-text\fR -Introduced in JDK 1\&.0 - -Adds a \fIVersion\fR subheading with the specified \f3version-text\fR value to the generated documents when the \f3-version\fR option is used\&. This tag is intended to hold the current release number of the software that this code is part of, as opposed to the\f3@since\fR tag, which holds the release number where this code was introduced\&. The \f3version-text\fR value has no special internal structure\&. See @version in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@version - -A documentation comment can contain multiple \f3@version\fR tags\&. When it makes sense, you can specify one release number per \f3@version\fR tag or multiple release numbers per tag\&. In the former case, the \f3javadoc\fR command inserts a comma (,) and a space between the names\&. In the latter case, the entire text is copied to the generated document without being parsed\&. Therefore, you can use multiple names per line when you want a localized name separator other than a comma\&. -.SH WHERE\ TAGS\ CAN\ BE\ USED -The following sections describe where tags can be used\&. Note that the following tags can be used in all documentation comments: \f3@see\fR, \f3@since\fR, \f3@deprecated\fR, \f3{@link}\fR, \f3{@linkplain}\fR, and \f3{@docroot}\fR\&. -.SS OVERVIEW\ TAGS -Overview tags are tags that can appear in the documentation comment for the overview page (which resides in the source file typically named overview\&.html)\&. Similar to any other documentation comments, these tags must appear after the main description -.PP -\fINote:\fR The \f3{@link}\fR tag has a bug in overview documents in Java SE 1\&.2\&. The text appears correctly but has no link\&. The \f3{@docRoot}\fR tag does not currently work in overview documents\&. -.PP -The overview tags are the following: -.PP -@see reference || @since since-text || @serialField field-name field-type field-description || @author name-text || @version version-text || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || -.SS PACKAGE\ TAGS -Package tags are tags that can appear in the documentation comment for a package, that resides in the source file named package\&.html or package-info\&.java\&. The \f3@serial\fR tag can only be used here with the \f3include\fR or \f3exclude\fR argument\&. -.PP -The package tags are the following: -.PP -@see reference || @since since-text || @serial field-description | include | exclude || @author name-text || @version version-text || {@linkplain package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || -.SS CLASS\ AND\ INTERFACE\ TAGS -The following are tags that can appear in the documentation comment for a class or interface\&. The \f3@serial\fR tag can only be used within the documentation for a class or interface with an \f3include\fR or \f3exclude\fR argument\&. -.PP -@see reference || @since since-text || @deprecated deprecated-text || @serial field-description | include | exclude || @author name-text || @version version-text || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || -.PP -Class comment example: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * A class representing a window on the screen\&.\fP -.fi -.nf -\f3 * For example:\fP -.fi -.nf -\f3 * <pre>\fP -.fi -.nf -\f3 * Window win = new Window(parent);\fP -.fi -.nf -\f3 * win\&.show();\fP -.fi -.nf -\f3 * </pre>\fP -.fi -.nf -\f3 *\fP -.fi -.nf -\f3 * @author Sami Shaio\fP -.fi -.nf -\f3 * @version 1\&.13, 06/08/06\fP -.fi -.nf -\f3 * @see java\&.awt\&.BaseWindow\fP -.fi -.nf -\f3 * @see java\&.awt\&.Button\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3class Window extends BaseWindow {\fP -.fi -.nf -\f3 \&.\&.\&.\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS FIELD\ TAGS -These tags can appear in fields: -.PP -@see reference || @since since-text || @deprecated deprecated-text || @serial field-description | include | exclude || @serialField field-name field-type field-description || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || {@value package\&.class#field} -.PP -Field comment example: -.sp -.nf -\f3 /**\fP -.fi -.nf -\f3 * The X\-coordinate of the component\&.\fP -.fi -.nf -\f3 *\fP -.fi -.nf -\f3 * @see #getLocation()\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3 int x = 1263732;\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS CONSTRUCTOR\ AND\ METHOD\ TAGS -The following tags can appear in the documentation comment for a constructor or a method, except for the \f3@return\fR tag, which cannot appear in a constructor, and the \f3{@inheritDoc}\fR tag, which has restrictions\&. -.PP -@see reference || @since since-text || @deprecated deprecated-text || @param parameter-name description || @return description || @throws class-name description || @exception class-name description || @serialData data-description || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@inheritDoc} || {@docRoot} -.PP -\fINote:\fR The \f3@serialData\fR tag can only be used in the documentation comment for the \f3writeObject\fR, \f3readObject\fR, \f3writeExternal\fR, \f3readExternal\fR, \f3writeReplace\fR, and \f3readResolve\fR methods\&. -.PP -Method comment example: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * Returns the character at the specified index\&. An index \fP -.fi -.nf -\f3 * ranges from <code>0</code> to <code>length() \- 1</code>\fP -.fi -.nf -\f3 *\fP -.fi -.nf -\f3 * @param index the index of the desired character\&.\fP -.fi -.nf -\f3 * @return the desired character\&.\fP -.fi -.nf -\f3 * @exception StringIndexOutOfRangeException \fP -.fi -.nf -\f3 * if the index is not in the range <code>0</code> \fP -.fi -.nf -\f3 * to <code>length()\-1</code>\fP -.fi -.nf -\f3 * @see java\&.lang\&.Character#charValue()\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3 public char charAt(int index) {\fP -.fi -.nf -\f3 \&.\&.\&.\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH OPTIONS -The \f3javadoc\fR command uses doclets to determine its output\&. The \f3javadoc\fR command uses the default standard doclet unless a custom doclet is specified with the \f3-doclet\fR option\&. The \f3javadoc\fR command provides a set of command-line options that can be used with any doclet\&. These options are described in Javadoc Options\&. The standard doclet provides an additional set of command-line options that are described in Standard Doclet Options\&. All option names are not case-sensitive, but their arguments are case-sensitive\&. -.TP 0.2i -\(bu -See also Javadoc Options -.TP 0.2i -\(bu -See also Standard Doclet Options -.PP -The options are: -.PP --1\&.1 || -author || -bootclasspath classpathlist || -bottom text || -breakiterator || -charset name || -classpath classpathlist || -d directory || -docencoding name || -docfilesubdirs || -doclet class || -docletpath classpathlist || -doctitle title || -encoding || -exclude packagename1:packagename2:\&.\&.\&. || -excludedocfilessubdir name1:name2 || -extdirs dirist || -footer footer || -group groupheading packagepattern:packagepattern || -header header || -help || -helpfile path\efilename || -Jflag || -javafx ||-keywords || -link extdocURL || -linkoffline extdocURL packagelistLoc || -linksource || -locale language_country_variant || -nocomment || -nodeprecated || -nodeprecatedlist || -nohelp || -noindex || -nonavbar || -noqualifier all | packagename1:packagename2\&.\&.\&. || -nosince || -notimestamp || -notree || -overview path/filename || -package || -private || -protected || -public || -quiet || -serialwarn || -source release || -sourcepath sourcepathlist || -sourcetab tablength || -splitindex || -stylesheet path/filename || -subpackages package1:package2:\&.\&.\&. || -tag tagname:Xaoptcmf:"taghead" || -taglet class || -tagletpath tagletpathlist || -title title || -top || -use || -verbose || -version || -windowtitle title -.PP -The following options are the core Javadoc options that are available to all doclets\&. The standard doclet provides the rest of the doclets: \f3-bootclasspath\fR, \f3-breakiterator\fR, \f3-classpath\fR, \f3-doclet\fR, \f3-docletpath\fR, \f3-encoding\fR, -\f3exclude\fR, \f3-extdirs\fR, \f3-help\fR, \f3-locale\fR, \f3-\fR\f3overview\fR, \f3-package\fR, \f3-private\fR, \f3-protected\fR, \f3-public\fR, \f3-quiet\fR, \f3-source\fR, \f3-sourcepath\fR, \f3-subpackages\fR, and \f3-verbose\fR\&. -.SS JAVADOC\ OPTIONS -.TP --overview \fIpath/filename\fR -.br -Specifies that the \f3javadoc\fR command should retrieve the text for the overview documentation from the source file specified by the \fIpath/filename\fRand place it on the Overview page (overview-summary\&.html)\&. The \fIpath/filename\fRis relative to the current directory\&. - -While you can use any name you want for the \f3filename\fR value and place it anywhere you want for the path, it is typical to name it overview\&.html and place it in the source tree at the directory that contains the topmost package directories\&. In this location, no path is needed when documenting packages, because the \f3-sourcepath\fR option points to this file\&. - -For example, if the source tree for the \f3java\&.lang\fR package is /src/classes/java/lang/, then you could place the overview file at /src/classes/overview\&.html - -See Real-World Examples\&. - -For information about the file specified by \fIpath/filename,\fRsee Overview Comment Files\&. - -The overview page is created only when you pass two or more package names to the \f3javadoc\fR command\&. For a further explanation, see HTML Frames\&. The title on the overview page is set by \f3-doctitle\fR\&. -.TP --Xdoclint:(all|none|[-]\fI<group>\fR) -.br -Reports warnings for bad references, lack of accessibility and missing Javadoc comments, and reports errors for invalid Javadoc syntax and missing HTML tags\&. - -This option enables the \f3javadoc\fR command to check for all documentation comments included in the generated output\&. As always, you can select which items to include in the generated output with the standard options \f3-public\fR, \f3-protected\fR, \f3-package\fR and \f3-private\fR\&. - -When the \f3-Xdoclint\fR is enabled, it reports issues with messages similar to the \f3javac\fR command\&. The \f3javadoc\fR command prints a message, a copy of the source line, and a caret pointing at the exact position where the error was detected\&. Messages may be either warnings or errors, depending on their severity and the likelihood to cause an error if the generated documentation were run through a validator\&. For example, bad references or missing Javadoc comments do not cause the \f3javadoc\fR command to generate invalid HTML, so these issues are reported as warnings\&. Syntax errors or missing HTML end tags cause the \f3javadoc\fR command to generate invalid output, so these issues are reported as errors\&. - -By default, the \f3-Xdoclint\fR option is enabled\&. Disable it with the option \f3-Xdoclint:none\fR\&. - -Change what the \f3-Xdoclint\fR option reports with the following options: -.RS -.TP 0.2i -\(bu -\f3-Xdoclint none\fR : disable the \f3-Xdoclint\fR option -.TP 0.2i -\(bu -\f3-Xdoclint\fR\fIgroup\fR : enable \fIgroup\fR checks -.TP 0.2i -\(bu -\f3-Xdoclint all\fR : enable all groups of checks -.TP 0.2i -\(bu -\f3-Xdoclint all,\fR\fI-group\fR : enable all except \fIgroup\fR checks -.RE - - -The variable \fIgroup\fR has one of the following values: -.RS -.TP 0.2i -\(bu -\f3accessibility\fR : Checks for the issues to be detected by an accessibility checker (for example, no caption or summary attributes specified in a \f3<table>\fR tag)\&. -.TP 0.2i -\(bu -\f3html\fR : Detects high-level HTML issues, like putting block elements inside inline elements, or not closing elements that require an end tag\&. The rules are derived from theHTML 4\&.01 Specification\&. This type of check enables the \f3javadoc\fR command to detect HTML issues that many browsers might accept\&. -.TP 0.2i -\(bu -\f3missing\fR : Checks for missing Javadoc comments or tags (for example, a missing comment or class, or a missing \f3@return\fR tag or similar tag on a method)\&. -.TP 0.2i -\(bu -\f3reference\fR : Checks for issues relating to the references to Java API elements from Javadoc tags (for example, item not found in \f3@see\fR , or a bad name after \f3@param)\fR\&. -.TP 0.2i -\(bu -\f3syntax\fR : Checks for low level issues like unescaped angle brackets (\f3<\fR and \f3>\fR) and ampersands (\f3&\fR) and invalid Javadoc tags\&. -.RE - - -You can specify the \f3-Xdoclint\fR option multiple times to enable the option to check errors and warnings in multiple categories\&. Alternatively, you can specify multiple error and warning categories by using the preceding options\&. For example, use either of the following commands to check for the HTML, syntax, and accessibility issues in the file \fIfilename\fR\&. -.sp -.nf -\f3javadoc \-Xdoclint:html \-Xdoclint:syntax \-Xdoclint:accessibility \fIfilename\fR\fP -.fi -.nf -\f3javadoc \-Xdoclint:html,syntax,accessibility \fIfilename\fR\fP -.fi -.nf -\f3\fP -.fi -.sp - - -\fINote:\fR The \f3javadoc\fR command does not guarantee the completeness of these checks\&. In particular, it is not a full HTML compliance checker\&. The goal of the -\f3Xdoclint\fR option is to enable the \f3javadoc\fR command to report majority of common errors\&. - -The \f3javadoc\fR command does not attempt to fix invalid input, it just reports it\&. -.TP --public -.br -Shows only public classes and members\&. -.TP --protected -.br -Shows only protected and public classes and members\&. This is the default\&. -.TP --package -.br -Shows only package, protected, and public classes and members\&. -.TP --private -.br -Shows all classes and members\&. -.TP --help -.br -Displays the online help, which lists all of the \f3javadoc\fR and \f3doclet\fR command-line options\&. -.TP --doclet \fIclass\fR -.br -Specifies the class file that starts the doclet used in generating the documentation\&. Use the fully qualified name\&. This doclet defines the content and formats the output\&. If the \f3-doclet\fR option is not used, then the \f3javadoc\fR command uses the standard doclet for generating the default HTML format\&. This class must contain the \f3start(Root)\fR method\&. The path to this starting class is defined by the \f3-docletpath\fR option\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html -.TP --docletpath \fIclasspathlist\fR -.br -Specifies the path to the doclet starting class file (specified with the \f3-doclet\fR option) and any JAR files it depends on\&. If the starting class file is in a JAR file, then this option specifies the path to that JAR file\&. You can specify an absolute path or a path relative to the current directory\&. If \f3classpathlist\fR contains multiple paths or JAR files, then they should be separated with a colon (:) on Oracle Solaris and a semi-colon (;) on Windows\&. This option is not necessary when the doclet starting class is already in the search path\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html -.TP --1\&.1 -.br -Removed from Javadoc 1\&.4 with no replacement\&. This option created documentation with the appearance and functionality of documentation generated by Javadoc 1\&.1 (it never supported nested classes)\&. If you need this option, then use Javadoc 1\&.2 or 1\&.3 instead\&. -.TP --source \fIrelease\fR -.br -Specifies the release of source code accepted\&. The following values for the \f3release\fR parameter are allowed\&. Use the value of \f3release\fR that corresponds to the value used when you compile code with the \f3javac\fR command\&. -.RS -.TP 0.2i -\(bu -\fIRelease Value: 1\&.5\fR\&. The \f3javadoc\fR command accepts code containing generics and other language features introduced in JDK 1\&.5\&. The compiler defaults to the 1\&.5 behavior when the \f3-source\fR option is not used\&. -.TP 0.2i -\(bu -\fIRelease Value: 1\&.4\fR\&. The \f3javadoc\fR command accepts code containing assertions, which were introduced in JDK 1\&.4\&. -.TP 0.2i -\(bu -\fIRelease Value: 1\&.3\fR\&. The \f3javadoc\fR command does not support assertions, generics, or other language features introduced after JDK 1\&.3\&. -.RE - -.TP --sourcepath \fIsourcepathlist\fR -.br -Specifies the search paths for finding source files when passing package names or the \f3-subpackages\fR option into the \f3javadoc\fR command\&. Separate multiple paths with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. Note that this option is not only used to locate the source files being documented, but also to find source files that are not being documented, but whose comments are inherited by the source files being documented\&. - -You can use the \f3-sourcepath\fR option only when passing package names into the \f3javadoc\fR command\&. This will not locate source files passed into the \f3javadoc\fR command\&. To locate source files, \f3\fRchange to that directory or include the path ahead of each file, as shown at Document One or More Classes\&. If you omit \f3-sourcepath\fR, then the \f3javadoc\fR command uses the class path to find the source files (see \f3-classpath\fR)\&. The default \f3-sourcepath\fR is the value of class path\&. If \f3-classpath\fR is omitted and you pass package names into the \f3javadoc\fR command, then the \f3javadoc\fR command searches in the current directory and subdirectories for the source files\&. - -Set \f3sourcepathlist\fR to the root directory of the source tree for the package you are documenting\&. - -For example, suppose you want to document a package called \f3com\&.mypackage\fR, whose source files are located at:/home/user/src/com/mypackage/*\&.java\&. Specify the sourcepath to /home/user/src, the directory that contains com\emypackage, and then supply the package name, as follows: -.sp -.nf -\f3javadoc \-sourcepath /home/user/src/ com\&.mypackage\fP -.fi -.nf -\f3\fP -.fi -.sp - - -Notice that if you concatenate the value of sourcepath and the package name together and change the dot to a slash (/), then you have the full path to the package: - -/home/user/src/com/mypackage - -To point to two source paths: -.sp -.nf -\f3javadoc \-sourcepath /home/user1/src:/home/user2/src com\&.mypackage\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --classpath \fIclasspathlist\fR -.br -Specifies the paths where the \f3javadoc\fR command searches for referenced classes These are the documented classes plus any classes referenced by those classes\&. Separate multiple paths with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. Follow the instructions in the class path documentation for specifying the \f3classpathlist\fR value\&. - -If you omit \f3-sourcepath\fR, then the \f3javadoc\fR command uses \f3-classpath\fR to find the source files and class files (for backward compatibility)\&. If you want to search for source and class files in separate paths, then use both \f3-sourcepath\fR and \f3-classpath\fR\&. - -For example, if you want to document \f3com\&.mypackage\fR, whose source files reside in the directory /home/user/src/com/mypackage, and if this package relies on a library in /home/user/lib, then you would use the following command: -.sp -.nf -\f3javadoc \-sourcepath /home/user/lib \-classpath /home/user/src com\&.mypackage\fP -.fi -.nf -\f3\fP -.fi -.sp - - -Similar to other tools, if you do not specify \f3-classpath\fR, then the \f3javadoc\fR command uses the \f3CLASSPATH\fR environment variable when it is set\&. If both are not set, then the \f3javadoc\fR command searches for classes from the current directory\&. - -For an in-depth description of how the \f3javadoc\fR command uses \f3-classpath\fR to find user classes as it relates to extension classes and bootstrap classes, see How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html - -A class path element that contains a base name of * is considered equivalent to specifying a list of all the files in the directory with the extension \f3\&.jar\fR or \f3\&.JAR\fR\&. - -For example, if directory \f3mydir\fR contains \f3a\&.jar\fR and \f3b\&.JA\fRR, then the class path element \f3foo/*\fR is expanded to a \f3A\&.jar:b\&.JAR\fR, except that the order of JAR files is unspecified\&. All JAR files in the specified directory including hidden files are included in the list\&. A class path entry that consists of * expands to a list of all the jar files in the current directory\&. The \f3CLASSPATH\fR environment variable is similarly expanded\&. Any class path wildcard expansion occurs before the Java Virtual Machine (JVM) starts\&. No Java program ever sees unexpanded wild cards except by querying the environment, for example, by calling System\&.getenv(\f3"CLASSPATH"\fR)\&. -.TP --subpackages \fIpackage1:package2:\&.\&.\&.\fR -.br -Generates documentation from source files in the specified packages and recursively in their subpackages\&. This option is useful when adding new subpackages to the source code because they are automatically included\&. Each package argument is any top-level subpackage (such as \f3java\fR) or fully qualified package (such as \f3javax\&.swing\fR) that does not need to contain source files\&. Arguments are separated by colons on all operating systems\&. Wild cards are not allowed\&. Use \f3-sourcepath\fR to specify where to find the packages\&. This option does not process source files that are in the source tree but do not belong to the packages\&. See Process Source Files\&. - -For example, the following command generates documentation for packages named \f3java\fR and \f3javax\&.swing\fR and all of their subpackages\&. -.sp -.nf -\f3javadoc \-d docs \-sourcepath /home/user/src \-subpackages java:javax\&.swing \fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --exclude \fIpackagename1:packagename2:\&.\&.\&.\fR -.br -Unconditionally excludes the specified packages and their subpackages from the list formed by \f3-subpackages\fR\&. It excludes those packages even when they would otherwise be included by some earlier or later \f3-subpackages\fR option\&. - -The following example would include \f3java\&.io\fR, \f3java\&.util\fR, and \f3java\&.math\fR (among others), but would exclude packages rooted at \f3java\&.net\fR and \f3java\&.lang\fR\&. Notice that this example excludes \f3java\&.lang\&.ref\fR, which is a subpackage of \f3java\&.lang\fR\&. -.sp -.nf -\f3javadoc \-sourcepath /home/user/src \-subpackages java \-exclude \fP -.fi -.nf -\f3 java\&.net:java\&.lang\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --bootclasspath \fIclasspathlist\fR -.br -Specifies the paths where the boot classes reside\&. These are typically the Java platform classes\&. The \f3bootclasspath\fR is part of the search path the \f3javadoc\fR command uses to look up source and class files\&. For more information, see How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html - -Separate directories in the \f3classpathlist\fR parameters with semicolons (;) for Windows and colons (:) for Oracle Solaris\&. -.TP --extdirs \fIdirist\fR -.br -Specifies the directories where extension classes reside\&. These are any classes that use the Java Extension mechanism\&. The \f3extdirs\fR option is part of the search path the \f3javadoc\fR command uses to look up source and class files\&. See the \f3-classpath\fR option for more information\&. Separate directories in \f3dirlist\fR with semicolons (;) for Windows and colons (:) for Oracle Solaris\&. -.TP --verbose -.br -Provides more detailed messages while the \f3javadoc\fR command runs\&. Without the \f3verbose\fR option, messages appear for loading the source files, generating the documentation (one message per source file), and sorting\&. The verbose option causes the printing of additional messages that specify the number of milliseconds to parse each Java source file\&. -.TP --quiet -.br -Shuts off messages so that only the warnings and errors appear to make them easier to view\&. It also suppresses the \f3version\fR string\&. -.TP --breakiterator -.br -Uses the internationalized sentence boundary of \f3java\&.text\&.BreakIterator\fR to determine the end of the first sentence in the main description of a package, class, or member for English\&. All other locales already use the \f3BreakIterator\fR class, rather than an English language, locale-specific algorithm\&. The first sentence is copied to the package, class, or member summary and to the alphabetic index\&. From JDK 1\&.2 and later, the \f3BreakIterator\fR class is used to determine the end of a sentence for all languages except for English\&. Therefore, the \f3-breakiterator\fR option has no effect except for English from 1\&.2 and later\&. English has its own default algorithm: -.RS -.TP 0.2i -\(bu -English default sentence-break algorithm\&. Stops at a period followed by a space or an HTML block tag, such as \f3<P>\fR\&. -.TP 0.2i -\(bu -Breakiterator sentence-break algorithm\&. Stops at a period, question mark, or exclamation point followed by a space when the next word starts with a capital letter\&. This is meant to handle most abbreviations (such as "The serial no\&. is valid", but will not handle "Mr\&. Smith")\&. The \f3-breakiterator\fR option does not stop at HTML tags or sentences that begin with numbers or symbols\&. The algorithm stops at the last period in \&.\&./filename, even when embedded in an HTML tag\&. -.RE - - -In Java SE 1\&.5 the \f3-breakiterator\fR option warning messages are removed, and the default sentence-break algorithm is unchanged\&. If you have not modified your source code to eliminate the \f3-breakiterator\fR option warnings in Java SE 1\&.4\&.x, then you do not have to do anything\&. The warnings go away starting with Java SE 1\&.5\&.0\&. -.TP --locale \fIlanguage_country_variant\fR -.br -Specifies the locale that the \f3javadoc\fR command uses when it generates documentation\&. The argument is the name of the locale, as described in \f3j\fR\f3ava\&.util\&.Locale\fR documentation, such as \f3en_US\fR (English, United States) or \f3en_US_WIN\fR (Windows variant)\&. - -\fINote:\fR The \f3-locale\fR option must be placed ahead (to the left) of any options provided by the standard doclet or any other doclet\&. Otherwise, the navigation bars appear in English\&. This is the only command-line option that depends on order\&. See Standard Doclet Options\&. - -Specifying a locale causes the \f3javadoc\fR command to choose the resource files of that locale for messages such as strings in the navigation bar, headings for lists and tables, help file contents, comments in the stylesheet\&.css file, and so on\&. It also specifies the sorting order for lists sorted alphabetically, and the sentence separator to determine the end of the first sentence\&. The \f3-locale\fR option does not determine the locale of the documentation comment text specified in the source files of the documented classes\&. -.TP --encoding -.br -Specifies the encoding name of the source files, such as \f3EUCJIS/SJIS\fR\&. If this option is not specified, then the platform default converter is used\&. See also the\f3-docencoding name\fR and \f3-charset name\fR options\&. -.TP --J\fIflag\fR -.br -Passes \f3flag\fR directly to the Java Runtime Environment (JRE) that runs the \f3javadoc\fR command\&. For example, if you must ensure that the system sets aside 32 MB of memory in which to process the generated documentation, then you would call the \f3-Xmx\fR option as follows: \f3javadoc -J-Xmx32m -J-Xms32m com\&.mypackage\fR\&. Be aware that \f3-Xms\fR is optional because it only sets the size of initial memory, which is useful when you know the minimum amount of memory required\&. - -There is no space between the \f3J\fR and the \f3flag\fR\&. - -Use the \f3-version\fR option to find out what version of the \f3javadoc\fR command you are using\&. The version number of the standard doclet appears in its output stream\&. See Running the Javadoc Command\&. -.sp -.nf -\f3javadoc \-J\-version\fP -.fi -.nf -\f3java version "1\&.7\&.0_09"\fP -.fi -.nf -\f3Java(TM) SE Runtime Environment (build 1\&.7\&.0_09\-b05)\fP -.fi -.nf -\f3Java HotSpot(TM) 64\-Bit Server VM (build 23\&.5\-b02, mixed mode)\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --javafx -.br -Generates HTML documentation using the JavaFX extensions to the standard doclet\&. The generated documentation includes a Property Summary section in addition to the other summary sections generated by the standard Java doclet\&. The listed properties are linked to the sections for the getter and setter methods of each property\&. - -If there are no documentation comments written explicitly for getter and setter methods, the documentation comments from the property method are automatically copied to the generated documentation for these methods\&. This option also adds a new \f3@defaultValue\fR tag that allows documenting the default value for a property\&. - -Example: -.sp -.nf -\f3javadoc \-javafx MyClass\&.java \-d testdir\fP -.fi -.sp - -.SS STANDARD\ DOCLET\ OPTIONS -.TP --d \fIdirectory\fR -.br -Specifies the destination directory where the \f3javadoc\fR command saves the generated HTML files\&. If you omit the \f3-d\fR option, then the files are saved to the current directory\&. The \f3directory\fR value can be absolute or relative to the current working directory\&. As of Java SE 1\&.4, the destination directory is automatically created when the \f3javadoc\fR command runs\&. - -For example, the following command generates the documentation for the package \f3com\&.mypackage\fR and saves the results in the /user/doc/ directory: \f3javadoc -d\fR\f3/user/doc/\fR\f3com\&.mypackage\fR\&. -.TP --use -.br -Includes one Use page for each documented class and package\&. The page describes what packages, classes, methods, constructors and fields use any API of the specified class or package\&. Given class C, things that use class C would include subclasses of C, fields declared as C, methods that return C, and methods and constructors with parameters of type C\&. For example, you can look at the Use page for the \f3String\fR type\&. Because the \f3getName\fR method in the \f3java\&.awt\&.Font\fR class returns type \f3String\fR, the \f3getName\fR method uses \f3String\fR and so the \f3getName\fR method appears on the Use page for \f3String\fR\&.This documents only uses of the API, not the implementation\&. When a method uses \f3String\fR in its implementation, but does not take a string as an argument or return a string, that is not considered a use of \f3String\fR\&.To access the generated Use page, go to the class or package and click the \fIUse link\fR in the navigation bar\&. -.TP --version -.br -Includes the @version text in the generated docs\&. This text is omitted by default\&. To find out what version of the \f3javadoc\fR command you are using, use the \f3-J-version\fR option\&. -.TP --author -.br -Includes the \f3@author\fR text in the generated docs\&. -.TP --splitindex -.br -Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical symbols\&. -.TP --windowtitle \fItitle\fR -.br -Specifies the title to be placed in the HTML \f3<title>\fR tag\&. The text specified in the \f3title\fR tag appears in the window title and in any browser bookmarks (favorite places) that someone creates for this page\&. This title should not contain any HTML tags because the browser does not interpret them correctly\&. Use escape characters on any internal quotation marks within the \f3title\fR tag\&. If the \f3-windowtitle\fR option is omitted, then the \f3javadoc\fR command uses the value of the \f3-doctitle\fR option for the \f3-windowtitle\fR option\&. For example, \f3javadoc -windowtitle "Java SE Platform" com\&.mypackage\fR\&. -.TP --doctitle \fItitle\fR -.br -Specifies the title to place near the top of the overview summary file\&. The text specified in the \f3title\fR tag is placed as a centered, level-one heading directly beneath the top navigation bar\&. The \f3title\fR tag can contain HTML tags and white space, but when it does, you must enclose the title in quotation marks\&. Internal quotation marks within the \f3title\fR tag must be escaped\&. For example, \f3javadoc -header "<b>Java Platform </b><br>v1\&.4" com\&.mypackage\&.\fR -.TP --title \fItitle\fR -.br -No longer exists\&. It existed only in Beta releases of Javadoc 1\&.2\&. It was renamed to \f3-doctitle\fR\&. This option was renamed to make it clear that it defines the document title, rather than the window title\&. -.TP --header \fIheader\fR -.br -Specifies the header text to be placed at the top of each output file\&. The header is placed to the right of the upper navigation bar\&. The \f3header\fR can contain HTML tags and white space, but when it does, the \f3header\fR must be enclosed in quotation marks\&. Use escape characters for internal quotation marks within a header\&. For example, \f3javadoc -header "<b>Java Platform </b><br>v1\&.4" com\&.mypackage\&.\fR -.TP --footer \fIfooter\fR -.br -Specifies the footer text to be placed at the bottom of each output file\&. The \fIfooter\fR value is placed to the right of the lower navigation bar\&. The \f3footer\fR value can contain HTML tags and white space, but when it does, the \f3footer\fR value must be enclosed in quotation marks\&. Use escape characters for any internal quotation marks within a footer\&. -.TP --top -.br -Specifies the text to be placed at the top of each output file\&. -.TP --bottom \fItext\fR -.br -Specifies the text to be placed at the bottom of each output file\&. The text is placed at the bottom of the page, underneath the lower navigation bar\&. The text can contain HTML tags and white space, but when it does, the text must be enclosed in quotation marks\&. Use escape characters for any internal quotation marks within text\&. -.TP --link \fIextdocURL\fR -.br -Creates links to existing Javadoc-generated documentation of externally referenced classes\&. The \fIextdocURL\fR argument is the absolute or relative URL of the directory that contains the external Javadoc-generated documentation you want to link to\&. You can specify multiple \f3-link\fR options in a specified \f3javadoc\fR command run to link to multiple documents\&. - -The package-list file must be found in this directory (otherwise, use the \f3-linkoffline\fR option)\&. The \f3javadoc\fR command reads the package names from the package-list file and links to those packages at that URL\&. When the \f3javadoc\fR command runs, the \f3extdocURL\fR value is copied into the \f3<A HREF>\fR links that are created\&. Therefore, \f3extdocURL\fR must be the URL to the directory, and not to a file\&. You can use an absolute link for \fIextdocURL\fR to enable your documents to link to a document on any web site, or you can use a relative link to link only to a relative location\&. If you use a relative link, then the value you pass in should be the relative path from the destination directory (specified with the \f3-d\fR option) to the directory containing the packages being linked to\&.When you specify an absolute link, you usually use an HTTP link\&. However, if you want to link to a file system that has no web server, then you can use a file link\&. Use a file link only when everyone who wants to access the generated documentation shares the same file system\&.In all cases, and on all operating systems, use a slash as the separator, whether the URL is absolute or relative, and \f3h\fR\f3ttp:\fR or \f3f\fR\f3ile:\fR as specified in the URL Memo: Uniform Resource Locators at http://www\&.ietf\&.org/rfc/rfc1738\&.txt -.sp -.nf -\f3\-link http://<host>/<directory>/<directory>/\&.\&.\&./<name>\fP -.fi -.nf -\f3\-link file://<host>/<directory>/<directory>/\&.\&.\&./<name>\fP -.fi -.nf -\f3\-link <directory>/<directory>/\&.\&.\&./<name>\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Differences between the -linkoffline and -link options - -Use the \f3-link\fR option in the following cases: -.TP 0.2i -\(bu -When you use a relative path to the external API document\&. -.TP 0.2i -\(bu -When you use an absolute URL to the external API document if your shell lets you open a connection to that URL for reading\&. -.PP -Use the \f3-linkoffline\fR option when you use an absolute URL to the external API document, if your shell does not allow a program to open a connection to that URL for reading\&. This can occur when you are behind a firewall and the document you want to link to is on the other side\&. -.PP -\f3Example 1 Absolute Link to External Documents\fR -.PP -Use the following command if you want to link to the \f3java\&.lang\fR, \f3java\&.io\fR and other Java platform packages, shown at http://docs\&.oracle\&.com/javase/8/docs/api/index\&.html -.sp -.nf -\f3javadoc \-link http://docs\&.oracle\&.com/javase/8/docs/api/ com\&.mypackage\fP -.fi -.nf -\f3\fP -.fi -.sp -The command generates documentation for the package \f3com\&.mypackage\fR with links to the Java SE packages\&. The generated documentation contains links to the \f3Object\fR class, for example, in the class \f3trees\fR\&. Other options, such as the \f3-sourcepath\fR and \f3-d\fR options, are not shown\&. -.PP -\f3Example 2 Relative Link to External Documents\fR -.PP -In this example, there are two packages with documents that are generated in different runs of the \f3javadoc\fR command, and those documents are separated by a relative path\&. The packages are \f3com\&.apipackage\fR, an API, and c\f3om\&.spipackage\fR, an Service Provide Interface (SPI)\&. You want the documentation to reside in docs/api/com/apipackage and docs/spi/com/spipackage\&. Assuming that the API package documentation is already generated, and that docs is the current directory, you document the SPI package with links to the API documentation by running: \f3javadoc -d \&./spi -link \&.\&./api com\&.spipackage\fR\&. -.PP -Notice the \f3-link\fR option is relative to the destination directory (docs/spi)\&. -.PP -Notes - -The \f3-link\fR option lets you link to classes referenced to by your code, but not documented in the current \f3javadoc\fR command run\&. For these links to go to valid pages, you must know where those HTML pages are located and specify that location with \f3extdocURL\fR\&. This allows third-party documentation to link to java\&.* documentation at http://docs\&.oracle\&.com\&.Omit the \f3-link\fR option when you want the \f3javadoc\fR command to create links only to APIs within the documentation it is generating in the current run\&. Without the \f3-link\fR option, the \f3javadoc\fR command does not create links to documentation for external references because it does not know whether or where that documentation exists\&.The \f3-link\fR option can create links in several places in the generated documentation\&. See Process Source Files\&. Another use is for cross-links between sets of packages: Execute the \f3javadoc\fR command on one set of packages, then run the \f3javadoc\fR command again on another set of packages, creating links both ways between both sets\&. -.PP -How to Reference a Class - -For a link to an externally referenced class to appear (and not just its text label), the class must be referenced in the following way\&. It is not sufficient for it to be referenced in the body of a method\&. It must be referenced in either an \f3import\fR statement or in a declaration\&. Here are examples of how the class \f3java\&.io\&.File\fR can be referenced: -.PP -\fI\fRIn any kind of import statement\&. By wildcard import, import explicitly by name, or automatically import for \f3java\&.lang\&.*\fR\&. -.PP -In Java SE 1\&.3\&.\fIn\fR and 1\&.2\&.\fIn\fR, only an explicit import by name works\&. A wildcard \f3import\fR statement does not work, nor does the automatic \f3import java\&.lang\&.*\fR\&. -.PP -\fI\fRIn a declaration: \f3void mymethod(File f) {}\fR -.PP -The reference can be in the return type or parameter type of a method, constructor, field, class, or interface, or in an implements, extends, or throws statement\&. -.PP -An important corollary is that when you use the \f3-link\fR option, there can be many links that unintentionally do not appear due to this constraint\&. The text would appear without being a link\&. You can detect these by the warnings they emit\&. The simplest way to properly reference a class and add the link would be to import that class\&. -.PP -Package List - -The \f3-link\fR option requires that a file named package-list, which is generated by the \f3javadoc\fR command, exists at the URL you specify with the \f3-link\fR option\&. The package-list file is a simple text file that lists the names of packages documented at that location\&. In the earlier example, the \f3javadoc\fR command searches for a file named package-list at the specified URL, reads in the package names, and links to those packages at that URL\&. -.PP -For example, the package list for the Java SE API is located at http://docs\&.oracle\&.com/javase/8/docs/api/package-list -.PP -The package list starts as follows: -.sp -.nf -\f3java\&.applet\fP -.fi -.nf -\f3java\&.awt\fP -.fi -.nf -\f3java\&.awt\&.color\fP -.fi -.nf -\f3java\&.awt\&.datatransfer\fP -.fi -.nf -\f3java\&.awt\&.dnd\fP -.fi -.nf -\f3java\&.awt\&.event\fP -.fi -.nf -\f3java\&.awt\&.font\fP -.fi -.nf -\f3and so on \&.\&.\&.\&.\fP -.fi -.nf -\f3\fP -.fi -.sp -When \f3javadoc\fR is run without the \f3-link\fR option and encounters a name that belongs to an externally referenced class, it prints the name with no link\&. However, when the \f3-link\fR option is used, the \f3javadoc\fR command searches the package-list file at the specified \fIextdocURL\fR location for that package name\&. When it finds the package name, it prefixes the name with \fIextdocURL\fR\&. -.PP -For there to be no broken links, all of the documentation for the external references must exist at the specified URLs\&. The \f3javadoc\fR command does not check that these pages exist, but only that the package-list exists\&. -.PP -Multiple Links - -You can supply multiple \f3-link\fR options to link to any number of externally generated documents\&. Javadoc 1\&.2 has a known bug that prevents you from supplying more than one \f3-link\fR options\&. This was fixed in Javadoc 1\&.2\&.2\&. Specify a different link option for each external document to link to \f3javadoc -link extdocURL1 -link extdocURL2 \&.\&.\&. -link extdocURLn com\&.mypackage\fR where \fIextdocURL1\fR, \fIextdocURL2\fR, \&.\f3\&.\&. extdocURLn\fR point respectively to the roots of external documents, each of which contains a file named package-list\&. -.PP -Cross Links - -Note that bootstrapping might be required when cross-linking two or more documents that were previously generated\&. If package-list does not exist for either document when you run the \f3javadoc\fR command on the first document, then the package-list does not yet exist for the second document\&. Therefore, to create the external links, you must regenerate the first document after you generate the second document\&. -.PP -In this case, the purpose of first generating a document is to create its package-list (or you can create it by hand if you are certain of the package names)\&. Then, generate the second document with its external links\&. The \f3javadoc\fR command prints a warning when a needed external package-list file does not exist\&. -.TP --linkoffline \fIextdocURL packagelistLoc\fR -.br -This option is a variation of the \f3-link\fR option\&. They both create links to Javadoc-generated documentation for externally referenced classes\&. Use the \f3-link\fRo\f3ffline\fR option when linking to a document on the web when the \f3javadoc\fR command cannot access the document through a web connection\&. Use the \f3-linkoffline\fR option when package-list file of the external document is not accessible or does not exist at the \f3extdocURL\fR location, but does exist at a different location that can be specified by \f3packageListLoc\fR (typically local)\&. If \f3extdocURL\fR is accessible only on the World Wide Web, then the \f3-linkoffline\fR option removes the constraint that the \f3javadoc\fR command must have a web connection to generate documentation\&. Another use is as a work-around to update documents: After you have run the \f3javadoc\fR command on a full set of packages, you can run the \f3javadoc\fR command again on a smaller set of changed packages, so that the updated files can be inserted back into the original set\&. Examples follow\&. The \f3-linkoffline\fR option takes two arguments\&. The first is for the string to be embedded in the \f3<a href>\fR links, and the second tells the \f3-linkoffline\fR option where to find package-list: -.RS -.TP 0.2i -\(bu -The \f3extdocURL\fR value is the absolute or relative URL of the directory that contains the external Javadoc-generated documentation you want to link to\&. When relative, the value should be the relative path from the destination directory (specified with the \f3-d\fR option) to the root of the packages being linked to\&. For more information, see \fIextdocURL\fR in the \f3-link\fR option\&. -.TP 0.2i -\(bu -The \f3packagelistLoc\fR value is the path or URL to the directory that contains the package-list file for the external documentation\&. This can be a URL (http: or file:) or file path, and can be absolute or relative\&. When relative, make it relative to the current directory from where the \f3javadoc\fR command was run\&. Do not include the package-list file name\&. - -You can specify multiple \f3-linkoffline\fR options in a specified \f3javadoc\fR command run\&. Before Javadoc 1\&.2\&.2, the \f3-linkfile\fR options could be specified once\&. -.RE - -.PP -Absolute Links to External Documents - -You might have a situation where you want to link to the \f3java\&.lang\fR, \f3java\&.io\fR and other Java SE packages at http://docs\&.oracle\&.com/javase/8/docs/api/index\&.html -.PP -However, your shell does not have web access\&. In this case, do the following: -.TP 0.4i -1\&. -Open the package-list file in a browser at http://docs\&.oracle\&.com/javase/8/docs/api/package-list -.TP 0.4i -2\&. -Save the file to a local directory, and point to this local copy with the second argument, \f3packagelistLoc\fR\&. In this example, the package list file was saved to the current directory (\&.)\&. -.PP -The following command generates documentation for the package c\f3om\&.mypackage\fR with links to the Java SE packages\&. The generated documentation will contain links to the \f3Object\fR class, for example, in the class \f3trees\fR\&. Other necessary options, such as \f3-sourcepath\fR, are not shown\&. -.sp -.nf -\f3javadoc \-linkoffline http://docs\&.oracle\&.com/javase/8/docs/api/ \&. com\&.mypackage \fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Relative Links to External Documents - -It is not very common to use \f3-linkoffline\fR with relative paths, for the simple reason that the \f3-link\fR option is usually enough\&. When you use the \f3-linkoffline\fR option, the package-list file is usually local, and when you use relative links, the file you are linking to is also local, so it is usually unnecessary to give a different path for the two arguments to the \f3-linkoffline\fR option When the two arguments are identical, you can use the \f3-link\fR option\&. -.PP -Create a package-list File Manually - -If a package-list file does not exist yet, but you know what package names your document will link to, then you can manually create your own copy of this file and specify its path with \f3packagelistLoc\fR\&. An example would be the previous case where the package list for \f3com\&.spipackage\fR did not exist when \f3com\&.apipackage\fR was first generated\&. This technique is useful when you need to generate documentation that links to new external documentation whose package names you know, but which is not yet published\&. This is also a way of creating package-list files for packages generated with Javadoc 1\&.0 or 1\&.1, where package-list files were not generated\&. Similarly, two companies can share their unpublished package-list files so they can release their cross-linked documentation simultaneously\&. -.PP -Link to Multiple Documents - -You can include the \f3-linkoffline\fR option once for each generated document you want to refer to: -.sp -.nf -\f3javadoc \-linkoffline extdocURL1 packagelistLoc1 \-linkoffline extdocURL2\fP -.fi -.nf -\f3packagelistLoc2 \&.\&.\&.\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Update Documents - -You can also use the \f3-linkoffline\fR option when your project has dozens or hundreds of packages\&. If you have already run the \f3javadoc\fR command on the entire source tree, then you can quickly make small changes to documentation comments and rerun the \f3javadoc\fR command on a portion of the source tree\&. Be aware that the second run works properly only when your changes are to documentation comments and not to declarations\&. If you were to add, remove, or change any declarations from the source code, then broken links could show up in the index, package tree, inherited member lists, Use page, and other places\&. -.PP -First, create a new destination directory, such as update, for this new small run\&. In this example, the original destination directory is named html\&. In the simplest example, change directory to the parent of html\&. Set the first argument of the \f3-linkoffline\fR option to the current directory (\&.) and set the second argument to the relative path to html, where it can find package-list and pass in only the package names of the packages you want to update: -.sp -.nf -\f3javadoc \-d update \-linkoffline \&. html com\&.mypackage\fP -.fi -.nf -\f3\fP -.fi -.sp -When the \f3javadoc\fR command completes, copy these generated class pages in update/com/package (not the overview or index) to the original files in html/com/package\&. -.TP --linksource -.br -Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation\&. Links are created for classes, interfaces, constructors, methods, and fields whose declarations are in a source file\&. Otherwise, links are not created, such as for default constructors and generated classes\&. - -This option exposes all private implementation details in the included source files, including private classes, private fields, and the bodies of private methods, regardless of the \f3-public\fR, \f3-package\fR, \f3-protected\fR, and \f3-private\fR options\&. Unless you also use the \f3-private\fR option, not all private classes or interfaces are accessible through links\&. - -Each link appears on the name of the identifier in its declaration\&. For example, the link to the source code of the \f3Button\fR class would be on the word \f3Button\fR: -.sp -.nf -\f3public class Button extends Component implements Accessible\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The link to the source code of the \f3getLabel\fR method in the \f3Button\fR class is on the word \f3getLabel\fR: -.sp -.nf -\f3public String getLabel()\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --group groupheading \fIpackagepattern:packagepattern\fR -.br -Separates packages on the overview page into whatever groups you specify, one group per table\&. You specify each group with a different \f3-group\fR option\&. The groups appear on the page in the order specified on the command line\&. Packages are alphabetized within a group\&. For a specified \f3-group\fR option, the packages matching the list of \f3packagepattern\fR expressions appear in a table with the heading \fIgroupheading\fR\&. -.RS -.TP 0.2i -\(bu -The \f3groupheading\fR can be any text and can include white space\&. This text is placed in the table heading for the group\&. -.TP 0.2i -\(bu -The \f3packagepattern\fR value can be any package name at the start of any package name followed by an asterisk (*)\&. The asterisk is the only wildcard allowed and means match any characters\&. Multiple patterns can be included in a group by separating them with colons (:)\&. If you use an asterisk in a pattern or pattern list, then the pattern list must be inside quotation marks, such as \f3"java\&.lang*:java\&.util"\fR\&. -.RE - - -When you do not supply a \f3-group\fR option, all packages are placed in one group with the heading \fIPackages\fR and appropriate subheadings\&. If the subheadings do not include all documented packages (all groups), then the remaining packages appear in a separate group with the subheading Other Packages\&. - -For example, the following \f3javadoc\fR command separates the three documented packages into \fICore\fR, \fIExtension\fR, and \fIOther Packages\fR\&. The trailing dot (\&.) does not appear in \f3java\&.lang*\fR\&. Including the dot, such as \f3java\&.lang\&.*\fR omits the\f3java\&.lang\fR package\&. -.sp -.nf -\f3javadoc \-group "Core Packages" "java\&.lang*:java\&.util"\fP -.fi -.nf -\f3 \-group "Extension Packages" "javax\&.*"\fP -.fi -.nf -\f3 java\&.lang java\&.lang\&.reflect java\&.util javax\&.servlet java\&.new\fP -.fi -.nf -\f3\fP -.fi -.sp - - -\fICore Packages\fR - -\f3java\&.lang\fR - -\f3java\&.lang\&.reflect\fR - -\f3java\&.util\fR - -\fIExtension Packages\fR - -\f3javax\&.servlet\fR - -\fIOther Packages\fR - -\f3java\&.new\fR -.TP --nodeprecated -.br -Prevents the generation of any deprecated API in the documentation\&. This does what the \f3-nodeprecatedlist\fR option does, and it does not generate any deprecated API throughout the rest of the documentation\&. This is useful when writing code when you do not want to be distracted by the deprecated code\&. -.TP --nodeprecatedlist -.br -Prevents the generation of the file that contains the list of deprecated APIs (deprecated-list\&.html) and the link in the navigation bar to that page\&. The \f3javadoc\fR command continues to generate the deprecated API throughout the rest of the document\&. This is useful when your source code contains no deprecated APIs, and you want to make the navigation bar cleaner\&. -.TP --nosince -.br -Omits from the generated documents the \f3Since\fR sections associated with the \f3@since\fR tags\&. -.TP --notree -.br -Omits the class/interface hierarchy pages from the generated documents\&. These are the pages you reach using the Tree button in the navigation bar\&. The hierarchy is produced by default\&. -.TP --noindex -.br -Omits the index from the generated documents\&. The index is produced by default\&. -.TP --nohelp -.br -Omits the HELP link in the navigation bars at the top and bottom of each page of output\&. -.TP --nonavbar -.br -Prevents the generation of the navigation bar, header, and footer, that are usually found at the top and bottom of the generated pages\&. The \f3-nonavbar\fR option has no affect on the \f3-bottom\fR option\&. The \f3-nonavbar\fR option is useful when you are interested only in the content and have no need for navigation, such as when you are converting the files to PostScript or PDF for printing only\&. -.TP --helpfile \fIpath\efilename\fR -.br -Specifies the path of an alternate help file path\efilename that the HELP link in the top and bottom navigation bars link to\&. Without this option, the \f3javadoc\fR command creates a help file help-doc\&.html that is hard-coded in the \f3javadoc\fR command\&. This option lets you override the default\&. The file name can be any name and is not restricted to help-doc\&.html\&. The \f3javadoc\fR command adjusts the links in the navigation bar accordingly, for example: -.sp -.nf -\f3javadoc \-helpfile /home/user/myhelp\&.html java\&.awt\&.\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --stylesheet \fIpath/filename\fR -.br -Specifies the path of an alternate HTML stylesheet file\&. Without this option, the \f3javadoc\fR command automatically creates a stylesheet file stylesheet\&.css that is hard-coded in the \f3javadoc\fR command\&. This option lets you override the default\&. The file name can be any name and is not restricted to stylesheet\&.css, for example: -.sp -.nf -\f3javadoc \-stylesheet file /home/user/mystylesheet\&.css com\&.mypackage\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --serialwarn -.br -Generates compile-time warnings for missing \f3@serial\fR tags\&. By default, Javadoc 1\&.2\&.2 and later versions generate no serial warnings\&. This is a reversal from earlier releases\&. Use this option to display the serial warnings, which helps to properly document default serializable fields and \f3writeExternal\fR methods\&. -.TP --charset \fIname\fR -.br -Specifies the HTML character set for this document\&. The name should be a preferred MIME name as specified in the IANA Registry, Character Sets at http://www\&.iana\&.org/assignments/character-sets - -For example, \f3javadoc -charset "iso-8859-1" mypackage\fR inserts the following line in the head of every generated page: -.sp -.nf -\f3<META http\-equiv="Content\-Type" content="text/html; charset=ISO\-8859\-1">\fP -.fi -.nf -\f3\fP -.fi -.sp - - -This \f3META\fR tag is described in the HTML standard (4197265 and 4137321), HTML Document Representation, at http://www\&.w3\&.org/TR/REC-html40/charset\&.html#h-5\&.2\&.2 - -See also the \f3-encoding\fR and \f3-docencoding name\fR options\&. -.TP --docencoding \fIname\fR -.br -Specifies the encoding of the generated HTML files\&. The name should be a preferred MIME name as specified in the IANA Registry, Character Sets at http://www\&.iana\&.org/assignments/character-sets - -If you omit the \f3-docencoding\fR option but use the \f3-encoding\fR option, then the encoding of the generated HTML files is determined by the \f3-encoding\fR option, for example: \f3javadoc -docencoding "iso-8859-1" mypackage\fR\&. See also the \f3-encoding\fR and \f3-docencoding name\fR options\&. -.TP --keywords -.br -Adds HTML keyword <META> tags to the generated file for each class\&. These tags can help search engines that look for <META> tags find the pages\&. Most search engines that search the entire Internet do not look at <META> tags, because pages can misuse them\&. Search engines offered by companies that confine their searches to their own website can benefit by looking at <META> tags\&. The <META> tags include the fully qualified name of the class and the unqualified names of the fields and methods\&. Constructors are not included because they are identical to the class name\&. For example, the class \f3String\fR starts with these keywords: -.sp -.nf -\f3<META NAME="keywords" CONTENT="java\&.lang\&.String class">\fP -.fi -.nf -\f3<META NAME="keywords" CONTENT="CASE_INSENSITIVE_ORDER">\fP -.fi -.nf -\f3<META NAME="keywords" CONTENT="length()">\fP -.fi -.nf -\f3<META NAME="keywords" CONTENT="charAt()">\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --tag \fItagname\fR:Xaoptcmf:"\fItaghead\fR" -.br -Enables the \f3javadoc\fR command to interpret a simple, one-argument \f3@tagname\fR custom block tag in documentation comments\&. For the \f3javadoc\fR command to spell-check tag names, it is important to include a \f3-tag\fR option for every custom tag that is present in the source code, disabling (with \f3X\fR) those that are not being output in the current run\&.The colon (:) is always the separator\&. The \f3-tag\fR option outputs the tag heading \fItaghead\fR in bold, followed on the next line by the text from its single argument\&. Similar to any block tag, the argument text can contain inline tags, which are also interpreted\&. The output is similar to standard one-argument tags, such as the \f3@return\fR and \f3@author\fR tags\&. Omitting a value for \fItaghead\fR causes \f3tagname\fR to be the heading\&. - -\fIPlacement of tags\fR: The \f3Xaoptcmf\fR arguments determine where in the source code the tag is allowed to be placed, and whether the tag can be disabled (using \f3X\fR)\&. You can supply either \f3a\fR, to allow the tag in all places, or any combination of the other letters: - -\f3X\fR (disable tag) - -\f3a\fR (all) - -\f3o\fR (overview) - -\f3p\fR (packages) - -\f3t\fR (types, that is classes and interfaces) - -\f3c\fR (constructors) - -\f3m\fR (methods) - -\f3f\fR (fields) - -\fIExamples of single tags\fR: An example of a tag option for a tag that can be used anywhere in the source code is: \f3-tag todo:a:"To Do:"\fR\&. - -If you want the \f3@todo\fR tag to be used only with constructors, methods, and fields, then you use: \f3-tag todo:cmf:"To Do:"\fR\&. - -Notice the last colon (:) is not a parameter separator, but is part of the heading text\&. You would use either tag option for source code that contains the \f3@todo\fR tag, such as: \f3@todo The documentation for this method needs work\fR\&. - -\fIColons in tag names\fR: Use a backslash to escape a colon that you want to use in a tag name\&. Use the \f3-tag ejb\e\e:bean:a:"EJB Bean:"\fR option for the following documentation comment: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * @ejb:bean\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.sp - - -\fISpell-checking tag names\fR: Some developers put custom tags in the source code that they do not always want to output\&. In these cases, it is important to list all tags that are in the source code, enabling the ones you want to output and disabling the ones you do not want to output\&. The presence of \f3X\fR disables the tag, while its absence enables the tag\&. This gives the \f3javadoc\fR command enough information to know whether a tag it encounters is unknown, which is probably the results of a typographical error or a misspelling\&. The \f3javadoc\fR command prints a warning in these cases\&. You can add \f3X\fR to the placement values already present, so that when you want to enable the tag, you can simply delete the \f3X\fR\&. For example, if the \f3@todo\fR tag is a tag that you want to suppress on output, then you would use: \f3-tag todo:Xcmf:"To Do:"\fR\&. If you would rather keep it simple, then use this: \f3-tag todo:X\fR\&. The syntax \f3-tag todo:X\fR works even when the \f3@todo\fR tag is defined by a taglet\&. - -\fIOrder of tags\fR: The order of the \f3-ta\fR\f3g\fR and \f3-taglet\fR options determines the order the tags are output\&. You can mix the custom tags with the standard tags to intersperse them\&. The tag options for standard tags are placeholders only for determining the order\&. They take only the standard tag\&'s name\&. Subheadings for standard tags cannot be altered\&. This is illustrated in the following example\&.If the \f3-tag\fR option is missing, then the position of the \f3-tagle\fR\f3t\fR option determines its order\&. If they are both present, then whichever appears last on the command line determines its order\&. This happens because the tags and taglets are processed in the order that they appear on the command line\&. For example, if the \f3-taglet\fR and \f3-tag\fR options have the name \f3todo\fR value, then the one that appears last on the command line determines the order\&. - -\fIExample of a complete set of tags\fR: This example inserts To Do after Parameters and before Throws in the output\&. By using \f3X\fR, it also specifies that the \f3@example\fR tag might be encountered in the source code that should not be output during this run\&. If you use the \f3@argfile\fR tag, then you can put the tags on separate lines in an argument file similar to this (no line continuation characters needed): -.sp -.nf -\f3\-tag param\fP -.fi -.nf -\f3\-tag return\fP -.fi -.nf -\f3\-tag todo:a:"To Do:"\fP -.fi -.nf -\f3\-tag throws\fP -.fi -.nf -\f3\-tag see\fP -.fi -.nf -\f3\-tag example:X\fP -.fi -.nf -\f3\fP -.fi -.sp - - -When the \f3javadoc\fR command parses the documentation comments, any tag encountered that is neither a standard tag nor passed in with the \f3-tag\fR or \f3-taglet\fR options is considered unknown, and a warning is thrown\&. - -The standard tags are initially stored internally in a list in their default order\&. Whenever the \f3-tag\fR options are used, those tags get appended to this list\&. Standard tags are moved from their default position\&. Therefore, if a \f3-tag\fR option is omitted for a standard tag, then it remains in its default position\&. - -\fIAvoiding conflicts\fR: If you want to create your own namespace, then you can use a dot-separated naming convention similar to that used for packages: \f3com\&.mycompany\&.todo\fR\&. Oracle will continue to create standard tags whose names do not contain dots\&. Any tag you create will override the behavior of a tag by the same name defined by Oracle\&. If you create a \f3@todo\fR tag or taglet, then it always has the same behavior you define, even when Oracle later creates a standard tag of the same name\&. - -\fIAnnotations vs\&. Javadoc tags\fR: In general, if the markup you want to add is intended to affect or produce documentation, then it should be a Javadoc tag\&. Otherwise, it should be an annotation\&. See Custom Tags and Annotations in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#annotations - -You can also create more complex block tags or custom inline tags with the \f3-taglet\fR option\&. -.TP --taglet \fIclass\fR -.br -Specifies the class file that starts the taglet used in generating the documentation for that tag\&. Use the fully qualified name for the \f3class\fR value\&. This taglet also defines the number of text arguments that the custom tag has\&. The taglet accepts those arguments, processes them, and generates the output\&. For extensive documentation with example taglets, see: Taglet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/taglet/overview\&.html - -Taglets are useful for block or inline tags\&. They can have any number of arguments and implement custom behavior, such as making text bold, formatting bullets, writing out the text to a file, or starting other processes\&. Taglets can only determine where a tag should appear and in what form\&. All other decisions are made by the doclet\&. A taglet cannot do things such as remove a class name from the list of included classes\&. However, it can execute side effects, such as printing the tag\&'s text to a file or triggering another process\&. Use the \f3-tagletpath\fR option to specify the path to the taglet\&. The following example inserts the To Do taglet after Parameters and ahead of Throws in the generated pages\&. Alternately, you can use the \f3-taglet\fR option in place of its \f3-tag\fR option, but that might be difficult to read\&. -.sp -.nf -\f3\-taglet com\&.sun\&.tools\&.doclets\&.ToDoTaglet\fP -.fi -.nf -\f3\-tagletpath /home/taglets \fP -.fi -.nf -\f3\-tag return\fP -.fi -.nf -\f3\-tag param\fP -.fi -.nf -\f3\-tag todo\fP -.fi -.nf -\f3\-tag throws\fP -.fi -.nf -\f3\-tag see\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --tagletpath \fItagletpathlist\fR -.br -Specifies the search paths for finding taglet class files\&. The \f3tagletpathlist\fR can contain multiple paths by separating them with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. -.TP --docfilesubdirs -.br -Enables deep copying of doc-files directories\&. Subdirectories and all contents are recursively copied to the destination\&. For example, the directory doc-files/example/images and all of its contents would be copied\&. There is also an option to exclude subdirectories\&. -.TP --excludedocfilessubdir \fIname1:name2\fR -.br -Excludes any doc-files subdirectories with the specified names\&. This prevents the copying of SCCS and other source-code-control subdirectories\&. -.TP --noqualifier all | \fIpackagename1\fR:\fIpackagename2\&.\&.\&.\fR -.br -Omits qualifying package names from class names in output\&. The argument to the \f3-noqualifier\fR option is either \f3all\fR (all package qualifiers are omitted) or a colon-separate list of packages, with wild cards, to be removed as qualifiers\&. The package name is removed from places where class or interface names appear\&. See Process Source Files\&. - -The following example omits all package qualifiers: \f3-noqualifier all\fR\&. - -The following example omits \f3java\&.lang\fR and \f3java\&.io\fR package qualifiers: \f3-noqualifier java\&.lang:java\&.io\fR\&. - -The following example omits package qualifiers starting with \f3java\fR, and \f3com\&.sun\fR subpackages, but not \f3javax\fR: \f3-noqualifier java\&.*:com\&.sun\&.*\fR\&. - -Where a package qualifier would appear due to the previous behavior, the name can be suitably shortened\&. See How a Name Appears\&. This rule is in effect whether or not the \f3-noqualifier\fR option is used\&. -.TP --notimestamp -.br -Suppresses the time stamp, which is hidden in an HTML comment in the generated HTML near the top of each page\&. The \f3-notimestamp\fR option is useful when you want to run the \f3javadoc\fR command on two source bases and get the differences between \f3diff\fR them, because it prevents time stamps from causing a \f3diff\fR (which would otherwise be a \f3diff\fR on every page)\&. The time stamp includes the \f3javadoc\fR command release number, and currently appears similar to this: \f3<!-- Generated by javadoc (build 1\&.5\&.0_01) on Thu Apr 02 14:04:52 IST 2009 -->\fR\&. -.TP --nocomment -.br -Suppresses the entire comment body, including the main description and all tags, and generate only declarations\&. This option lets you reuse source files that were originally intended for a different purpose so that you can produce skeleton HTML documentation at the early stages of a new project\&. -.TP --sourcetab \fItablength\fR -.br -Specifies the number of spaces each tab uses in the source\&. -.SH COMMAND-LINE\ ARGUMENT\ FILES -To shorten or simplify the \f3javadoc\fR command, you can specify one or more files that contain arguments to the \f3javadoc\fR command (except \f3-J\fR options)\&. This enables you to create \f3javadoc\fR commands of any length on any operating system\&. -.PP -An argument file can include \f3javac\fR options and source file names in any combination\&. The arguments within a file can be space-separated or newline-separated\&. If a file name contains embedded spaces, then put the whole file name in double quotation marks\&. -.PP -File Names within an argument file are relative to the current directory, not the location of the argument file\&. Wild cards (\f3*\fR) are not allowed in these lists (such as for specifying *\&.java)\&. Using the at sign (@) to recursively interpret files is not supported\&. The \f3-J\fR options are not supported because they are passed to the launcher, which does not support argument files\&. -.PP -When you run the \f3javadoc\fR command, pass in the path and name of each argument file with the @ leading character\&. When the \f3javadoc\fR command encounters an argument beginning with the at sign (@), it expands the contents of that file into the argument list\&. -.PP -\f3Example 1 Single Argument File\fR -.PP -You could use a single argument file named \f3argfile\fR to hold all \f3javadoc\fR command arguments: \f3javadoc @argfile\fR\&. The argument file \f3\fRcontains the contents of both files, as shown in the next example\&. -.PP -\f3Example 2 Two Argument Files\fR -.PP -You can create two argument files: One for the \f3javadoc\fR command options and the other for the package names or source file names\&. Notice the following lists have no line-continuation characters\&. -.PP -Create a file named options that contains: -.sp -.nf -\f3\-d docs\-filelist \fP -.fi -.nf -\f3\-use \fP -.fi -.nf -\f3\-splitindex\fP -.fi -.nf -\f3\-windowtitle \&'Java SE 7 API Specification\&'\fP -.fi -.nf -\f3\-doctitle \&'Java SE 7 API Specification\&'\fP -.fi -.nf -\f3\-header \&'<b>Java\(tm SE 7</b>\&'\fP -.fi -.nf -\f3\-bottom \&'Copyright © 1993\-2011 Oracle and/or its affiliates\&. All rights reserved\&.\&'\fP -.fi -.nf -\f3\-group "Core Packages" "java\&.*"\fP -.fi -.nf -\f3\-overview /java/pubs/ws/1\&.7\&.0/src/share/classes/overview\-core\&.html\fP -.fi -.nf -\f3\-sourcepath /java/pubs/ws/1\&.7\&.0/src/share/classes\fP -.fi -.nf -\f3\fP -.fi -.sp -Create a file named packages that contains: -.sp -.nf -\f3com\&.mypackage1\fP -.fi -.nf -\f3com\&.mypackage2\fP -.fi -.nf -\f3com\&.mypackage3\fP -.fi -.nf -\f3\fP -.fi -.sp -Run the \f3javadoc\fR command as follows: -.sp -.nf -\f3javadoc @options @packages\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 3 Argument Files with Paths\fR -.PP -The argument files can have paths, but any file names inside the files are relative to the current working directory (not \f3path1\fR or \f3path2\fR): -.sp -.nf -\f3javadoc @path1/options @path2/packages\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 4 Option Arguments\fR -.PP -The following example saves an argument to a \f3javadoc\fR command option in an argument file\&. The \f3-bottom\fR option is used because it can have a lengthy argument\&. You could create a file named bottom to contain the text argument: -.sp -.nf -\f3<font size="\-1">\fP -.fi -.nf -\f3 <a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP -.fi -.nf -\f3 Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&. <br/>\fP -.fi -.nf -\f3 Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP -.fi -.nf -\f3 Other names may be trademarks of their respective owners\&.</font>\fP -.fi -.nf -\f3\fP -.fi -.sp -Run the \f3javadoc\fR command as follows:\f3javadoc -bottom @bottom @packages\fR\&. -.PP -You can also include the \f3-bottom\fR option at the start of the argument file and run the \f3javadoc\fR command as follows: \f3javadoc @bottom @packages\fR\&. -.SH RUNNING\ THE\ JAVADOC\ COMMAND -The release number of the \f3javadoc\fR command can be determined with the \f3javadoc -J-version\fR option\&. The release number of the standard doclet appears in the output stream\&. It can be turned off with the \f3-quiet\fR option\&. -.PP -Use the public programmatic interface to call the \f3javadoc\fR command from within programs written in the Java language\&. This interface is in \f3com\&.sun\&.tools\&.javadoc\&.Main\fR (and the \f3javadoc\fR command is reentrant)\&. For more information, see The Standard Doclet at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/standard-doclet\&.html#runningprogrammatically -.PP -The following instructions call the standard HTML doclet\&. To call a custom doclet, use the \f3-doclet\fR and \f3-docletpath\fR options\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html -.SS SIMPLE\ EXAMPLES -You can run the \f3javadoc\fR command on entire packages or individual source files\&. Each package name has a corresponding directory name\&. -.PP -In the following examples, the source files are located at /home/src/java/awt/*\&.java\&. The destination directory is /home/html\&. -.PP -Document One or More Packages - -To document a package, the source files for that package must be located in a directory that has the same name as the package\&. -.PP -If a package name has several identifiers (separated by dots, such as \f3java\&.awt\&.color\fR), then each subsequent identifier must correspond to a deeper subdirectory (such as java/awt/color)\&. -.PP -You can split the source files for a single package among two such directory trees located at different places, as long as \f3-sourcepath\fR points to them both\&. For example, src1/java/awt/color and src2/java/awt/color\&. -.PP -You can run the \f3javadoc\fR command either by changing directories (with the \f3cd\fR command) or by using the \f3-sourcepath\fR option\&. The following examples illustrate both alternatives\&. -.PP -\f3Example 1 Recursive Run from One or More Packages\fR -.PP -This example uses \f3-sourcepath\fR so the \f3javadoc\fR command can be run from any directory and \f3-subpackages\fR (a new 1\&.4 option) for recursion\&. It traverses the subpackages of the java directory excluding packages rooted at \f3java\&.net\fR and \f3java\&.lang\fR\&. Notice this excludes \f3java\&.lang\&.ref\fR, a subpackage of \f3java\&.lang\fR\&. To also traverse down other package trees, append their names to the \f3-subpackages\fR argument, such as \f3java:javax:org\&.xml\&.sax\fR\&. -.sp -.nf -\f3javadoc \-d /home/html \-sourcepath /home/src \-subpackages java \-exclude\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 2 Change to Root and Run Explicit Packages\fR -.PP -Change to the parent directory of the fully qualified package\&. Then, run the \f3javadoc\fR command with the names of one or more packages that you want to document: -.sp -.nf -\f3cd /home/src/\fP -.fi -.nf -\f3javadoc \-d /home/html java\&.awt java\&.awt\&.event\fP -.fi -.nf -\f3\fP -.fi -.sp -To also traverse down other package trees, append their names to the \f3-subpackages\fR argument, such as j\f3ava:javax:org\&.xml\&.sax\fR\&. -.PP -\f3Example 3 Run from Any Directory on Explicit Packages in One Tree\fR -.PP -In this case, it does not matter what the current directory is\&. Run the \f3javadoc\fR command and use the \f3-sourcepath\fR option with the parent directory of the top-level package\&. Provide the names of one or more packages that you want to document: -.sp -.nf -\f3javadoc \-d /home/html \-sourcepath /home/src java\&.awt java\&.awt\&.event\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 4 Run from Any Directory on Explicit Packages in Multiple Trees\fR -.PP -Run the \f3javadoc\fR command and use the \f3-sourcepath\fR option with a colon-separated list of the paths to each tree\&'s root\&. Provide the names of one or more packages that you want to document\&. All source files for a specified package do not need to be located under a single root directory, but they must be found somewhere along the source path\&. -.sp -.nf -\f3javadoc \-d /home/html \-sourcepath /home/src1:/home/src2 java\&.awt java\&.awt\&.event\fP -.fi -.nf -\f3\fP -.fi -.sp -The result is that all cases generate HTML-formatted documentation for the \f3public\fR and \f3protected\fR classes and interfaces in packages j\f3ava\&.awt\fR and \f3java\&.awt\&.even\fRt and save the HTML files in the specified destination directory\&. Because two or more packages are being generated, the document has three HTML frames: one for the list of packages, another for the list of classes, and the third for the main class pages\&. -.PP -Document One or More Classes - -The second way to run the \f3javadoc\fR command is to pass one or more source files\&. You can run \f3javadoc\fR either of the following two ways: by changing directories (with the \f3cd\fR command) or by fully specifying the path to the source files\&. Relative paths are relative to the current directory\&. The \f3-sourcepath\fR option is ignored when passing source files\&. You can use command-line wild cards, such as an asterisk (*), to specify groups of classes\&. -.PP -\f3Example 1 Change to the Source Directory\fR -.PP -Change to the directory that holds the source files\&. Then run the \f3javadoc\fR command with the names of one or more source files you want to document\&. -.PP -This example generates HTML-formatted documentation for the classes \f3Button\fR, \f3Canvas,\fR and classes that begin with \f3Graphics\fR\&. Because source files rather than package names were passed in as arguments to the \f3javadoc\fR command, the document has two frames: one for the list of classes and the other for the main page\&. -.sp -.nf -\f3cd /home/src/java/awt\fP -.fi -.nf -\f3javadoc \-d /home/html Button\&.java Canvas\&.java Graphics*\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 2 Change to the Root Directory of the Package\fR -.PP -This is useful for documenting individual source files from different subpackages off of the same root\&. Change to the package root directory, and supply the source files with paths from the root\&. -.sp -.nf -\f3cd /home/src/\fP -.fi -.nf -\f3javadoc \-d /home/html java/awt/Button\&.java java/applet/Applet\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 3 Document Files from Any Directory\fR -.PP -In this case, it does not matter what the current directory is\&. Run the \f3javadoc\fR command with the absolute path (or path relative to the current directory) to the source files you want to document\&. -.sp -.nf -\f3javadoc \-d /home/html /home/src/java/awt/Button\&.java\fP -.fi -.nf -\f3/home/src/java/awt/Graphics*\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Document Packages and Classes - -You can document entire packages and individual classes at the same time\&. Here is an example that mixes two of the previous examples\&. You can use the \f3-sourcepath\fR option for the path to the packages but not for the path to the individual classes\&. -.sp -.nf -\f3javadoc \-d /home/html \-sourcepath /home/src java\&.awt\fP -.fi -.nf -\f3/home/src/java/applet/Applet\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS REAL-WORLD\ EXAMPLES -The following command-line and \f3makefile\fR versions of the \f3javadoc\fR command run on the Java platform APIs\&. It uses 180 MB of memory to generate the documentation for the 1500 (approximately) public and protected classes in the Java SE 1\&.2\&. Both examples use absolute paths in the option arguments, so that the same \f3javadoc\fR command can be run from any directory\&. -.PP -Command-Line Example - -The following command might be too long for some shells\&. You can use a command-line argument file (or write a shell script) to overcome this limitation\&. -.PP -In the example, \f3packages\fR is the name of a file that contains the packages to process, such as \f3java\&.applet\fR\f3java\&.lang\fR\&. None of the options should contain any newline characters between the single quotation marks\&. For example, if you copy and paste this example, then delete the newline characters from the \f3-bottom\fR option\&. -.sp -.nf -\f3javadoc \-sourcepath /java/jdk/src/share/classes \e\fP -.fi -.nf -\f3\-overview /java/jdk/src/share/classes/overview\&.html \e\fP -.fi -.nf -\f3\-d /java/jdk/build/api \e\fP -.fi -.nf -\f3\-use \e\fP -.fi -.nf -\f3\-splitIndex \e\fP -.fi -.nf -\f3\-windowtitle \&'Java Platform, Standard Edition 7 API Specification\&' \e\fP -.fi -.nf -\f3\-doctitle \&'Java Platform, Standard Edition 7 API Specification\&' \e\fP -.fi -.nf -\f3\-header \&'<b>Java\(tm SE 7</b>\&' \e\fP -.fi -.nf -\f3\-bottom \&'<font size="\-1">\fP -.fi -.nf -\f3<a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP -.fi -.nf -\f3Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&.<br/>\fP -.fi -.nf -\f3Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP -.fi -.nf -\f3Other names may be trademarks of their respective owners\&.</font>\&' \e\fP -.fi -.nf -\f3\-group "Core Packages" "java\&.*:com\&.sun\&.java\&.*:org\&.omg\&.*" \e\fP -.fi -.nf -\f3\-group "Extension Packages" "javax\&.*" \e\fP -.fi -.nf -\f3\-J\-Xmx180m \e \fP -.fi -.nf -\f3@packages\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Programmatic Interface - -The Javadoc Access API enables the user to invoke the Javadoc tool directly from a Java application without executing a new process\&. -.PP -For example, the following statements are equivalent to the command \f3javadoc -d /home/html -sourcepath /home/src -subpackages java -exclude java\&.net:java\&.lang com\&.example\fR: -.sp -.nf -\f3import javax\&.tools\&.DocumentationTool;\fP -.fi -.nf -\f3import javax\&.tools\&.ToolProvider;\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3public class JavaAccessSample{\fP -.fi -.nf -\f3 public static void main(String[] args){\fP -.fi -.nf -\f3 DocumentationTool javadoc = ToolProvider\&.getSystemDocumentationTool();\fP -.fi -.nf -\f3 int rc = javadoc\&.run( null, null, null,\fP -.fi -.nf -\f3 "\-d", "/home/html",\fP -.fi -.nf -\f3 "\-sourcepath", "home/src",\fP -.fi -.nf -\f3 "\-subpackages", "java",\fP -.fi -.nf -\f3 "\-exclude", "java\&.net:java\&.lang",\fP -.fi -.nf -\f3 "com\&.example");\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3\fP -.fi -.sp -The first three arguments of the \f3run\fR method specify input, standard output, and standard error streams\&. \f3Null\fR is the default value for \f3System\&.in\fR, \f3System\&.out\fR, and \f3System\&.err\fR, respectively\&. -.SS THE\ MAKEFILE\ EXAMPLE -This is an example of a GNU \f3makefile\fR\&. Single quotation marks surround \f3makefile\fR arguments\&. For an example of a Windows \f3makefile\fR, see the \f3makefiles\fR section of the Javadoc FAQ at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137483\&.html#makefiles -.sp -.nf -\f3javadoc \-sourcepath $(SRCDIR) \e /* Sets path for source files */\fP -.fi -.nf -\f3 \-overview $(SRCDIR)/overview\&.html \e /* Sets file for overview text */\fP -.fi -.nf -\f3 \-d /java/jdk/build/api \e /* Sets destination directory */\fP -.fi -.nf -\f3 \-use \e /* Adds "Use" files */\fP -.fi -.nf -\f3 \-splitIndex \e /* Splits index A\-Z */\fP -.fi -.nf -\f3 \-windowtitle $(WINDOWTITLE) \e /* Adds a window title */\fP -.fi -.nf -\f3 \-doctitle $(DOCTITLE) \e /* Adds a doc title */\fP -.fi -.nf -\f3 \-header $(HEADER) \e /* Adds running header text */\fP -.fi -.nf -\f3 \-bottom $(BOTTOM) \e /* Adds text at bottom */\fP -.fi -.nf -\f3 \-group $(GROUPCORE) \e /* 1st subhead on overview page */\fP -.fi -.nf -\f3 \-group $(GROUPEXT) \e /* 2nd subhead on overview page */\fP -.fi -.nf -\f3 \-J\-Xmx180m \e /* Sets memory to 180MB */\fP -.fi -.nf -\f3 java\&.lang java\&.lang\&.reflect \e /* Sets packages to document */\fP -.fi -.nf -\f3 java\&.util java\&.io java\&.net \e\fP -.fi -.nf -\f3 java\&.applet\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3WINDOWTITLE = \&'Java\(tm SE 7 API Specification\&'\fP -.fi -.nf -\f3DOCTITLE = \&'Java\(tm Platform Standard Edition 7 API Specification\&'\fP -.fi -.nf -\f3HEADER = \&'<b>Java\(tm SE 7</font>\&'\fP -.fi -.nf -\f3BOTTOM = \&'<font size="\-1">\fP -.fi -.nf -\f3 <a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP -.fi -.nf -\f3 Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&.<br/>\fP -.fi -.nf -\f3 Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP -.fi -.nf -\f3 Other names may be trademarks of their respective owners\&.</font>\&'\fP -.fi -.nf -\f3GROUPCORE = \&'"Core Packages" "java\&.*:com\&.sun\&.java\&.*:org\&.omg\&.*"\&'\fP -.fi -.nf -\f3GROUPEXT = \&'"Extension Packages" "javax\&.*"\&'\fP -.fi -.nf -\f3SRCDIR = \&'/java/jdk/1\&.7\&.0/src/share/classes\&'\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS NOTES -.TP 0.2i -\(bu -If you omit the \f3-windowtitle\fR option, then the \f3javadoc\fR command copies the document title to the window title\&. The \f3-windowtitle\fR option text is similar to the the \f3-doctitle\fR option, but without HTML tags to prevent those tags from appearing as raw text in the window title\&. -.TP 0.2i -\(bu -If you omit the \f3-footer\fR option, then the \f3javadoc\fR command copies the header text to the footer\&. -.TP 0.2i -\(bu -Other important options you might want to use, but were not needed in the previous example, are the \f3-classpath\fR and \f3-link\fR options\&. -.SH GENERAL\ TROUBLESHOOTING -.TP 0.2i -\(bu -The \f3javadoc\fR command reads only files that contain valid class names\&. If the \f3javadoc\fR command is not correctly reading the contents of a file, then verify that the class names are valid\&. See Process Source Files\&. -.TP 0.2i -\(bu -See the Javadoc FAQ for information about common bugs and for troubleshooting tips at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137483\&.html -.SH ERRORS\ AND\ WARNINGS -Error and warning messages contain the file name and line number to the declaration line rather than to the particular line in the documentation comment\&. -.PP -For example, this message \f3error: cannot read: Class1\&.java\fR means that the \f3javadoc\fR command is trying to load \f3Class1\&.jav\fR\f3a\fR in the current directory\&. The class name is shown with its path (absolute or relative)\&. -.SH ENVIRONMENT -.TP -CLASSPATH -\f3CLASSPATH\fR is the environment variable that provides the path that the \f3javadoc\fR command uses to find user class files\&. This environment variable is overridden by the \f3-classpath\fR option\&. Separate directories with a semicolon for Windows or a colon for Oracle Solaris\&. - -\fIWindows example\fR: \f3\&.;C:\eclasses;C:\ehome\ejava\eclasses\fR - -\fIOracle Solaris example\fR: \f3\&.:/home/classes:/usr/local/java/classes\fR\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -javac(1) -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -jdb(1) -.TP 0.2i -\(bu -javah(1) -.TP 0.2i -\(bu -javap(1) -.SH RELATED\ DOCUMENTS -.TP 0.2i -\(bu -Javadoc Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/index\&.html -.TP 0.2i -\(bu -How Classes Are Found http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html -.TP 0.2i -\(bu -How to Write Doc Comments for the Javadoc Tool http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html -.TP 0.2i -\(bu -URL Memo, Uniform Resource Locators http://www\&.ietf\&.org/rfc/rfc1738\&.txt -.TP 0.2i -\(bu -HTML standard, HTML Document Representation (4197265 and 4137321) http://www\&.w3\&.org/TR/REC-html40/charset\&.html#h-5\&.2\&.2 -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1994, 2015, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 03 March 2015 +.\" SectDesc: Basic Tools +.\" Title: javadoc.1 +.\" +.if n .pl 99999 +.TH javadoc 1 "03 March 2015" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +javadoc \- Generates HTML pages of API documentation from Java source files\&. +.SH SYNOPSIS +.sp +.nf + +\fBjavadoc\fR {\fIpackages\fR|\fIsource\-files\fR} [\fIoptions\fR] [\fI@argfiles\fR] +.fi +.sp +.TP +\fIpackages\fR +Names of packages that you want to document, separated by spaces, for example \f3java\&.lang java\&.lang\&.reflect java\&.awt\fR\&. If you want to also document the subpackages, use the \f3-subpackages\fR option to specify the packages\&. + +By default, \f3javadoc\fR looks for the specified packages in the current directory and subdirectories\&. Use the \f3-sourcepath\fR option to specify the list of directories where to look for packages\&. +.TP +\fIsource-files\fR +Names of Java source files that you want to document, separated by spaces, for example \f3Class\&.java Object\&.java Button\&.java\fR\&. By default, \f3javadoc\fR looks for the specified classes in the current directory\&. However, you can specify the full path to the class file and use wildcard characters, for example \f3/home/src/java/awt/Graphics*\&.java\fR\&. You can also specify the path relative to the current directory\&. +.TP +\fIoptions\fR +Command-line options, separated by spaces\&. See Options\&. +.TP +\fI@argfiles\fR +Names of files that contain a list of \f3javadoc\fR command options, package names and source file names in any order\&. +.SH DESCRIPTION +The \f3javadoc\fR command parses the declarations and documentation comments in a set of Java source files and produces a corresponding set of HTML pages that describe (by default) the public and protected classes, nested classes (but not anonymous inner classes), interfaces, constructors, methods, and fields\&. You can use the \f3javadoc\fR command to generate the API documentation or the implementation documentation for a set of source files\&. +.PP +You can run the \f3javadoc\fR command on entire packages, individual source files, or both\&. When documenting entire packages, you can either use the \f3-subpackages\fR option to recursively traverse a directory and its subdirectories, or to pass in an explicit list of package names\&. When you document individual source files, pass in a list of Java source file names\&. See Simple Examples\&. +.SS PROCESS\ SOURCE\ FILES +The \f3javadoc\fR command processes files that end in source and other files described in Source Files\&. If you run the \f3javadoc\fR command by passing in individual source file names, then you can determine exactly which source files are processed\&. However, that is not how most developers want to work, because it is simpler to pass in package names\&. The \f3javadoc\fR command can be run three ways without explicitly specifying the source file names\&. You can pass in package names, use the \f3-subpackages\fR option, or use wild cards with source file names\&. In these cases, the \f3javadoc\fR command processes a source file only when the file fulfills all of the following requirements: +.TP 0.2i +\(bu +The file name prefix (with \f3\&.java\fR removed) is a valid class name\&. +.TP 0.2i +\(bu +The path name relative to the root of the source tree is a valid package name after the separators are converted to dots\&. +.TP 0.2i +\(bu +The package statement contains the valid package name\&. +.PP +Processing Links + +During a run, the \f3javadoc\fR command adds cross-reference links to package, class, and member names that are being documented as part of that run\&. Links appear in the following places\&. See Javadoc Tags for a description of the @ tags\&. +.TP 0.2i +\(bu +Declarations (return types, argument types, and field types)\&. +.TP 0.2i +\(bu +\fISee Also\fR sections that are generated from \f3@see\fR tags\&. +.TP 0.2i +\(bu +Inline text generated from \f3{@link}\fR tags\&. +.TP 0.2i +\(bu +Exception names generated from \f3@throws\fR tags\&. +.TP 0.2i +\(bu +\fISpecified by\fR links to interface members and \fIOverrides\fR links to class members\&. See Method Comment Inheritance\&. +.TP 0.2i +\(bu +Summary tables listing packages, classes and members\&. +.TP 0.2i +\(bu +Package and class inheritance trees\&. +.TP 0.2i +\(bu +The index\&. +.PP +You can add links to existing text for classes not included on the command line (but generated separately) by way of the \f3-link\fR and \f3-linkoffline\fR options\&. +.PP +Processing Details + +The \f3javadoc\fR command produces one complete document every time it runs\&. It does not do incremental builds that modify or directly incorporate the results from earlier runs\&. However, the \f3javadoc\fR command can link to results from other runs\&. +.PP +The \f3javadoc\fR command implementation requires and relies on the Java compiler\&. The \f3javadoc\fR command calls part of the \f3javac\fR command to compile the declarations and ignore the member implementations\&. The \f3javadoc\fR command builds a rich internal representation of the classes that includes the class hierarchy and use relationships to generate the HTML\&. The \f3javadoc\fR command also picks up user-supplied documentation from documentation comments in the source code\&. See Documentation Comments\&. +.PP +The \f3javadoc\fR command runs on source files that are pure stub files with no method bodies\&. This means you can write documentation comments and run the \f3javadoc\fR command in the early stages of design before API implementation\&. +.PP +Relying on the compiler ensures that the HTML output corresponds exactly with the actual implementation, which may rely on implicit, rather than explicit, source code\&. For example, the \f3javadoc\fR command documents default constructors that are present in the compiled class files but not in the source code\&. +.PP +In many cases, the \f3javadoc\fR command lets you generate documentation for source files with incomplete or erroneous code\&. You can generate documentation before all debugging and troubleshooting is done\&. The \f3javadoc\fR command does primitive checking of documentation comments\&. +.PP +When the \f3javadoc\fR command builds its internal structure for the documentation, it loads all referenced classes\&. Because of this, the \f3javadoc\fR command must be able to find all referenced classes, whether bootstrap classes, extensions, or user classes\&. See How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html +.PP +Typically, classes you create must either be loaded as an extension or in the \f3javadoc\fR command class path\&. +.SS JAVADOC\ DOCLETS +You can customize the content and format of the \f3javadoc\fR command output with doclets\&. The \f3javadoc\fR command has a default built-in doclet, called the standard doclet, that generates HTML-formatted API documentation\&. You can modify or make a subclass of the standard doclet, or write your own doclet to generate HTML, XML, MIF, RTF or whatever output format you want\&. +.PP +When a custom doclet is not specified with the \f3-doclet\fR option, the \f3javadoc\fR command uses the default standard doclet\&. The \f3javadoc\fR command has several options that are available regardless of which doclet is being used\&. The standard doclet adds a supplementary set of command-line options\&. See Options\&. +.SH SOURCE\ FILES +The \f3javadoc\fR command generates output that originates from the following types of source files: Java language source files for classes (\f3\&.java\fR), package comment files, overview comment files, and miscellaneous unprocessed files\&. This section also describes test files and template files that can also be in the source tree, but that you want to be sure not to document\&. +.SS CLASS\ SOURCE\ FILES +Each class or interface and its members can have their own documentation comments contained in a source file\&. See Documentation Comments\&. +.SS PACKAGE\ COMMENT\ FILES +Each package can have its own documentation comment, contained in its own source file, that the \f3javadoc\fR command merges into the generated package summary page\&. You typically include in this comment any documentation that applies to the entire package\&. +.PP +To create a package comment file, you can place your comments in one of the following files: +.TP 0.2i +\(bu +The \f3package-info\&.java\fR file can contain the package declaration, package annotations, package comments, and Javadoc tags\&. This file is preferred\&. +.TP 0.2i +\(bu +The \f3package\&.html\fR file contains only package comments and Javadoc tags\&. No package annotations\&. +.PP +A package can have a single \f3package\&.html\fR file or a single \f3package-info\&.java\fR file, but not both\&. Place either file in the package directory in the source tree with your source files\&. +.PP +The package-info\&.java File + +The \f3package-info\&.java\fR file can contain a package comment of the following structure\&. The comment is placed before the package declaration\&. +.PP +\fINote:\fR The comment separators \f3/**\fR and \f3*/\fR must be present, but the leading asterisks on the intermediate lines can be left off\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * Provides the classes necessary to create an \fP +.fi +.nf +\f3 * applet and the classes an applet uses \fP +.fi +.nf +\f3 * to communicate with its applet context\&.\fP +.fi +.nf +\f3 * <p>\fP +.fi +.nf +\f3 * The applet framework involves two entities:\fP +.fi +.nf +\f3 * the applet and the applet context\&.\fP +.fi +.nf +\f3 * An applet is an embeddable window (see the\fP +.fi +.nf +\f3 * {@link java\&.awt\&.Panel} class) with a few extra\fP +.fi +.nf +\f3 * methods that the applet context can use to \fP +.fi +.nf +\f3 * initialize, start, and stop the applet\&.\fP +.fi +.nf +\f3 *\fP +.fi +.nf +\f3 * @since 1\&.0\fP +.fi +.nf +\f3 * @see java\&.awt\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3package java\&.lang\&.applet;\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +The package\&.html File + +The \f3package\&.html\fR file can contain a package comment of the following structure\&. The comment is placed in the \f3<body>\fR element\&. +.PP +File: \f3java/applet/package\&.html\fR +.sp +.nf +\f3<HTML>\fP +.fi +.nf +\f3<BODY>\fP +.fi +.nf +\f3Provides the classes necessary to create an applet and the \fP +.fi +.nf +\f3classes an applet uses to communicate with its applet context\&.\fP +.fi +.nf +\f3<p>\fP +.fi +.nf +\f3The applet framework involves two entities: the applet\fP +.fi +.nf +\f3and the applet context\&. An applet is an embeddable\fP +.fi +.nf +\f3window (see the {@link java\&.awt\&.Panel} class) with a\fP +.fi +.nf +\f3few extra methods that the applet context can use to\fP +.fi +.nf +\f3initialize, start, and stop the applet\&. \fP +.fi +.nf +\f3\fP +.fi +.nf +\f3@since 1\&.0 \fP +.fi +.nf +\f3@see java\&.awt\fP +.fi +.nf +\f3</BODY>\fP +.fi +.nf +\f3</HTML>\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3package\&.html\fR file is a typical HTML file and does not include a package declaration\&. The content of the package comment file is written in HTML with one exception\&. The documentation comment should not include the comment separators \f3/**\fR and \f3*/\fR or leading asterisks\&. When writing the comment, make the first sentence a summary about the package, and do not put a title or any other text between the \f3<body>\fR tag and the first sentence\&. You can include package tags\&. All block tags must appear after the main description\&. If you add an \f3@see\fR tag in a package comment file, then it must have a fully qualified name\&. +.PP +Processing the Comment File + +When the \f3javadoc\fR command runs, it searches for the package comment file\&. If the package comment file is found, then the \f3javadoc\fR command does the following: +.TP 0.2i +\(bu +Copies the comment for processing\&. For package\&.html, the \f3javadoc\fR command copies all content between the \f3<body>\fR and \f3</body>\fR HTML tags\&. You can include a \f3<head>\fR section to put a \f3<title>\fR tag, source file copyright statement, or other information, but none of these appear in the generated documentation\&. +.TP 0.2i +\(bu +Processes the package tags\&. See Package Tags\&. +.TP 0.2i +\(bu +Inserts the processed text at the bottom of the generated package summary page\&. See Java Platform, Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html +.TP 0.2i +\(bu +Copies the first sentence of the package comment to the top of the package summary page\&. The \f3javadoc\fR command also adds the package name and this first sentence to the list of packages on the overview page\&. See Java Platform, Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html + +The end of the sentence is determined by the same rules used for the end of the first sentence of class and member main descriptions\&. +.SS OVERVIEW\ COMMENT\ FILES +Each application or set of packages that you are documenting can have its own overview documentation comment that is kept in its own source file, that the \f3javadoc\fR command merges into the generated overview page\&. You typically include in this comment any documentation that applies to the entire application or set of packages\&. +.PP +You can name the file anything you want such as overview\&.html and place it anywhere\&. A typical location is at the top of the source tree\&. +.PP +For example, if the source files for the \f3java\&.applet\fR package are contained in the /home/user/src/java/applet directory, then you could create an overview comment file at /home/user/src/overview\&.html\&. +.PP +You can have multiple overview comment files for the same set of source files in case you want to run the \f3javadoc\fR command multiple times on different sets of packages\&. For example, you could run the \f3javadoc\fR command once with \f3-private\fR for internal documentation and again without that option for public documentation\&. In this case, you could describe the documentation as public or internal in the first sentence of each overview comment file\&. +.PP +The content of the overview comment file is one big documentation comment that is written in HTML\&. Make the first sentence a summary about the application or set of packages\&. Do not put a title or any other text between the \f3<body>\fR tag and the first sentence\&. All tags except inline tags, such as an {\f3@link}\fR tag, must appear after the main description\&. If you add an \f3@see\fR tag, then it must have a fully qualified name\&. +.PP +When you run the \f3javadoc\fR command, specify the overview comment file name with the \f3-overview\fR option\&. The file is then processed similarly to that of a package comment file\&. The \f3javadoc\fR command does the following: +.TP 0.2i +\(bu +Copies all content between the \f3<body>\fR and \f3</body>\fR tags for processing\&. +.TP 0.2i +\(bu +Processes the overview tags that are present\&. See Overview Tags\&. +.TP 0.2i +\(bu +Inserts the processed text at the bottom of the generated overview page\&. See Java Platform Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html +.TP 0.2i +\(bu +Copies the first sentence of the overview comment to the top of the overview summary page\&. +.SS UNPROCESSED\ FILES +Your source files can include any files that you want the \f3javadoc\fR command to copy to the destination directory\&. These files usually include graphic files, example Java source and class files, and self-standing HTML files with a lot of content that would overwhelm the documentation comment of a typical Java source file\&. +.PP +To include unprocessed files, put them in a directory called doc-files\&. The doc-files directory can be a subdirectory of any package directory that contains source files\&. You can have one doc-files subdirectory for each package\&. +.PP +For example, if you want to include the image of a button in the \f3java\&.awt\&.Button\fR class documentation, then place the image file in the /home/user/src/java/awt/doc-files/ directory\&. Do not place the doc-files directory at /home/user/src/java/doc-files, because java is not a package\&. It does not contain any source files\&. +.PP +All links to the unprocessed files must be included in the code because the \f3javadoc\fR command does not look at the files\&. The \f3javadoc\fR command copies the directory and all of its contents to the destination\&. The following example shows how the link in the Button\&.java documentation comment might look: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This button looks like this: \fP +.fi +.nf +\f3 * <img src="doc\-files/Button\&.gif">\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS TEST\ AND\ TEMPLATE\ FILES +You can store test and template files in the source tree in the same directory with or in a subdirectory of the directory where the source files reside\&. To prevent test and template files from being processed, run the \f3javadoc\fR command and explicitly pass in individual source file names\&. +.PP +Test files are valid, compilable source files\&. Template files are not valid, compatible source files, but they often have the \f3\&.java\fR suffix\&. +.PP +Test Files + +If you want your test files to belong to either an unnamed package or to a package other than the package that the source files are in, then put the test files in a subdirectory underneath the source files and give the directory an invalid name\&. If you put the test files in the same directory with the source and call the \f3javadoc\fR command with a command-line argument that indicates its package name, then the test files cause warnings or errors\&. If the files are in a subdirectory with an invalid name, then the test file directory is skipped and no errors or warnings are issued\&. For example, to add test files for source files in com\&.package1, put them in a subdirectory in an invalid package name\&. The following directory name is invalid because it contains a hyphen: +.sp +.nf +\f3com/package1/test\-files/\fP +.fi +.nf +\f3\fP +.fi +.sp +If your test files contain documentation comments, then you can set up a separate run of the \f3javadoc\fR command to produce test file documentation by passing in their test source file names with wild cards, such as \f3com/package1/test-files/*\&.java\fR\&. +.PP +Template Files + +If you want a template file to be in the source directory, but not generate errors when you execute the \f3javadoc\fR command, then give it an invalid file name such as \f3Buffer-Template\&.java\fR to prevent it from being processed\&. The \f3javadoc\fR command only processes source files with names, when stripped of the \f3\&.java\fR suffix, that are valid class names\&. +.SH GENERATED\ FILES +By default, the \f3javadoc\fR command uses a standard doclet that generates HTML-formatted documentation\&. The standard doclet generates basic content, cross-reference, and support pages described here\&. Each HTML page corresponds to a separate file\&. The \f3javadoc\fR command generates two types of files\&. The first type is named after classes and interfaces\&. The second type contain hyphens (such as package-summary\&.html) to prevent conflicts with the first type of file\&. +.SS BASIC\ CONTENT\ PAGES +.TP 0.2i +\(bu +One class or interface page (classname\&.html) for each class or interface being documented\&. +.TP 0.2i +\(bu +One package page (package-summary\&.html) for each package being documented\&. The \f3javadoc\fR command includes any HTML text provided in a file with the name package\&.html or package-info\&.java in the package directory of the source tree\&. +.TP 0.2i +\(bu +One overview page (overview-summary\&.html) for the entire set of packages\&. The overview page is the front page of the generated document\&. The \f3javadoc\fR command includes any HTML text provided in a file specified by the \f3-overview\fR option\&. The Overview page is created only when you pass two or more package names into the \f3javadoc\fR command\&. See HTML Frames and Options\&. +.SS CROSS-REFERENCE\ PAGES +.TP 0.2i +\(bu +One class hierarchy page for the entire set of packages (overview-tree\&.html)\&. To view the hierarchy page, click \fIOverview\fR in the navigation bar and click \fITree\fR\&. +.TP 0.2i +\(bu +One class hierarchy page for each package (package-tree\&.html) To view the hierarchy page, go to a particular package, class, or interface page, and click \fITree\fR to display the hierarchy for that package\&. +.TP 0.2i +\(bu +One use page for each package (package-use\&.html) and a separate use page for each class and interface (class-use/classname\&.html)\&. The use page describes what packages, classes, methods, constructors and fields use any part of the specified class, interface, or package\&. For example, given a class or interface A, its use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A\&. To view the use page, go to the package, class, or interface and click the \fIUse\fR link in the navigation bar\&. +.TP 0.2i +\(bu +A deprecated API page (deprecated-list\&.html) that lists all deprecated APIs and their suggested replacements\&. Avoid deprecated APIs because they can be removed in future implementations\&. +.TP 0.2i +\(bu +A constant field values page (constant-values\&.html) for the values of static fields\&. +.TP 0.2i +\(bu +A serialized form page (serialized-form\&.html) that provides information about serializable and externalizable classes with field and method descriptions\&. The information on this page is of interest to reimplementors, and not to developers who want to use the API\&. To access the serialized form page, go to any serialized class and click \fISerialized Form\fR in the See Also section of the class comment\&. The standard doclet generates a serialized form page that lists any class (public or non-public) that implements Serializable with its \f3readObject\fR and \f3writeObject\fR methods, the fields that are serialized, and the documentation comments from the \f3@serial\fR, \f3@serialField\fR, and \f3@serialData\fR tags\&. Public serializable classes can be excluded by marking them (or their package) with \f3@serial\fR exclude, and package-private serializable classes can be included by marking them (or their package) with an \f3@serial\fR include\&. As of Release 1\&.4, you can generate the complete serialized form for public and private classes by running the \f3javadoc\fR command without specifying the \f3-private\fR option\&. See Options\&. +.TP 0.2i +\(bu +An index page (\f3index-*\&.html\fR) of all class, interface, constructor, field and method names, in alphabetical order\&. The index page is internationalized for Unicode and can be generated as a single file or as a separate file for each starting character (such as A\(enZ for English)\&. +.SS SUPPORT\ PAGES +.TP 0.2i +\(bu +A help page (help-doc\&.html) that describes the navigation bar and the previous pages\&. Use \f3-helpfile\fR to override the default help file with your own custom help file\&. +.TP 0.2i +\(bu +One index\&.html file that creates the HTML frames for display\&. Load this file to display the front page with frames\&. The index\&.html file contains no text content\&. +.TP 0.2i +\(bu +Several frame files (\f3*-frame\&.html\fR) that contains lists of packages, classes, and interfaces\&. The frame files display the HTML frames\&. +.TP 0.2i +\(bu +A package list file (package-list) that is used by the \f3-link\fR and \f3-linkoffline\fR options\&. The package list file is a text file that is not reachable through links\&. +.TP 0.2i +\(bu +A style sheet file (stylesheet\&.css) that controls a limited amount of color, font family, font size, font style, and positioning information on the generated pages\&. +.TP 0.2i +\(bu +A doc-files directory that holds image, example, source code, or other files that you want copied to the destination directory\&. These files are not processed by the \f3javadoc\fR command\&. This directory is not processed unless it exists in the source tree\&. +.PP +See Options\&. +.SS HTML\ FRAMES +The \f3javadoc\fR command generates the minimum number of frames (two or three) necessary based on the values passed to the command\&. It omits the list of packages when you pass a single package name or source files that belong to a single package as an argument to the \f3javadoc\fR command\&. Instead, the \f3javadoc\fR command creates one frame in the left-hand column that displays the list of classes\&. When you pass two or more package names, the \f3javadoc\fR command creates a third frame that lists all packages and an overview page (overview-summary\&.html)\&. To bypass frames, click the \fINo Frames\fR link or enter the page set from the overview-summary\&.html page\&. +.SS GENERATED\ FILE\ STRUCTURE +The generated class and interface files are organized in the same directory hierarchy that Java source files and class files are organized\&. This structure is one directory per subpackage\&. +.PP +For example, the document generated for the \f3java\&.applet\&.Applet\fR class would be located at java/applet/Applet\&.html\&. +.PP +The file structure for the \f3java\&.applet\fR package follows, assuming that the destination directory is named \f3apidocs\fR\&. All files that contain the word \fIframe\fR appear in the upper-left or lower-left frames, as noted\&. All other HTML files appear in the right-hand frame\&. +.PP +Directories are bold\&. The asterisks (*) indicate the files and directories that are omitted when the arguments to the \f3javadoc\fR command are source file names rather than package names\&. When arguments are source file names, an empty package list is created\&. The doc-files directory is not created in the destination unless it exists in the source tree\&. See Generated Files\&. +.TP 0.2i +\(bu +\fIapidocs\fR: Top-level directory +.RS +.TP 0.2i +\(bu +index\&.html: Initial Page that sets up HTML frames +.TP 0.2i +\(bu +*overview-summary\&.html: Package list with summaries +.TP 0.2i +\(bu +overview-tree\&.html: Class hierarchy for all packages +.TP 0.2i +\(bu +deprecated-list\&.html: Deprecated APIs for all packages +.TP 0.2i +\(bu +constant-values\&.html: Static field values for all packages +.TP 0.2i +\(bu +serialized-form\&.html: Serialized forms for all packages +.TP 0.2i +\(bu +*overview-frame\&.html: All packages for display in upper-left frame +.TP 0.2i +\(bu +allclasses-frame\&.html: All classes for display in lower-left frame +.TP 0.2i +\(bu +help-doc\&.html: Help about Javadoc page organization +.TP 0.2i +\(bu +index-all\&.html: Default index created without \f3-splitindex\fR option +.TP 0.2i +\(bu +\fIindex-files\fR: Directory created with \f3-splitindex\fR option +.RS +.TP 0.2i +\(bu +index-<number>\&.html: Index files created with \f3-splitindex\fR option +.RE + +.TP 0.2i +\(bu +package-list: Package names for resolving external references +.TP 0.2i +\(bu +stylesheet\&.css: Defines fonts, colors, positions, and so on +.RE + +.TP 0.2i +\(bu +\fIjava\fR: Package directory +.RS +.TP 0.2i +\(bu +\fIapplet\fR: Subpackage directory +.RS +.TP 0.2i +\(bu +Applet\&.html: \f3Applet\fR class page +.TP 0.2i +\(bu +AppletContext\&.html: \f3AppletContext\fR interface +.TP 0.2i +\(bu +AppletStub\&.html: \f3AppletStub\fR interface +.TP 0.2i +\(bu +AudioClip\&.html: \f3AudioClip\fR interface +.TP 0.2i +\(bu +package-summary\&.html: Classes with summaries +.TP 0.2i +\(bu +package-frame\&.html: Package classes for display in lower-left frame +.TP 0.2i +\(bu +package-tree\&.html: Class hierarchy for this package +.TP 0.2i +\(bu +package-use\&.html: Where this package is used +.TP 0.2i +\(bu +\fIdoc-files\fR: Image and example files directory +.TP 0.2i +\(bu +\fIclass-use\fR: Image and examples file location + +- Applet\&.html: Uses of the Applet class + +- AppletContext\&.html: Uses of the \f3AppletContext\fR interface + +- AppletStub\&.html: Uses of the \f3AppletStub\fR interface + +- AudioClip\&.html: Uses of the \f3AudioClip\fR interface +.RE + +.RE + +.TP 0.2i +\(bu +\fIsrc-html\fR: Source code directory +.RS +.TP 0.2i +\(bu +\fIjava\fR: Package directory +.RS +.TP 0.2i +\(bu +\fIapplet\fR: Subpackage directory + +- Applet\&.html: Applet source code + +- AppletContext\&.html: \f3AppletContext\fR source code + +- AppletStub\&.html: \f3AppletStub\fR source code + +- AudioClip\&.html: \f3AudioClip\fR source code +.RE + +.RE + +.SS GENERATED\ API\ DECLARATIONS +The \f3javadoc\fR command generates a declaration at the start of each class, interface, field, constructor, and method description for that API item\&. For example, the declaration for the \f3Boolean\fR class is: +.sp +.nf +\f3public final class Boolean\fP +.fi +.nf +\f3extends Object\fP +.fi +.nf +\f3implements Serializable\fP +.fi +.nf +\f3\fP +.fi +.sp +The declaration for the \f3Boolean\&.valueOf\fR method is: +.sp +.nf +\f3public static Boolean valueOf(String s)\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3javadoc\fR command can include the modifiers \f3public\fR, \f3protected\fR, \f3private\fR, \f3abstract\fR, \f3final\fR, \f3static\fR, \f3transient\fR, and \f3volatile\fR, but not \f3synchronized\fR or \f3native\fR\&. The \f3synchronized\fR and \f3native\fR modifiers are considered implementation detail and not part of the API specification\&. +.PP +Rather than relying on the keyword \f3synchronized\fR, APIs should document their concurrency semantics in the main description of the comment\&. For example, a description might be: A single enumeration cannot be used by multiple threads concurrently\&. The document should not describe how to achieve these semantics\&. As another example, while the \f3Hashtable\fR option should be thread-safe, there is no reason to specify that it is achieved by synchronizing all of its exported methods\&. It is better to reserve the right to synchronize internally at the bucket level for higher concurrency\&. +.SH DOCUMENTATION\ COMMENTS +This section describes source code comments and comment inheritance\&. +.SS SOURCE\ CODE\ COMMENTS +You can include documentation comments in the source code, ahead of declarations for any class, interface, method, constructor, or field\&. You can also create documentation comments for each package and another one for the overview, though their syntax is slightly different\&. A documentation comment consists of the characters between \f3/**\fR and \f3*/\fR that end it\&. Leading asterisks are allowed on each line and are described further in the following section\&. The text in a comment can continue onto multiple lines\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This is the typical format of a simple documentation comment\fP +.fi +.nf +\f3 * that spans two lines\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.sp +To save space you can put a comment on one line: +.sp +.nf +\f3/** This comment takes up only one line\&. */\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Placement of Comments + +Documentation comments are recognized only when placed immediately before class, interface, constructor, method, or field declarations\&. Documentation comments placed in the body of a method are ignored\&. The \f3javadoc\fR command recognizes only one documentation comment per declaration statement\&. See Where Tags Can Be Used\&. +.PP +A common mistake is to put an \f3import\fR statement between the class comment and the class declaration\&. Do not put an \f3import\fR statement at this location because the \f3javadoc\fR command ignores the class comment\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This is the class comment for the class Whatever\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3import com\&.example; // MISTAKE \- Important not to put import statement here\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class Whatever{ }\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Parts of Comments + +A documentation comment has a main description followed by a tag section\&. The main description begins after the starting delimiter \f3/**\fR and continues until the tag section\&. The tag section starts with the first block tag, which is defined by the first \f3@\fR character that begins a line (ignoring leading asterisks, white space, and leading separator \f3/**\fR)\&. It is possible to have a comment with only a tag section and no main description\&. The main description cannot continue after the tag section begins\&. The argument to a tag can span multiple lines\&. There can be any number of tags, and some types of tags can be repeated while others cannot\&. For example, this \f3@see\fR tag starts the tag section: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This sentence holds the main description for this documentation comment\&.\fP +.fi +.nf +\f3 * @see java\&.lang\&.Object\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Block and inline Tags + +A tag is a special keyword within a documentation comment that the \f3javadoc\fR command processes\&. There are two kinds of tags: block tags, which appear as an \f3@tag\fR tag (also known as standalone tags), and inline tags, which appear within braces, as an \f3{@tag}\fR tag\&. To be interpreted, a block tag must appear at the beginning of a line, ignoring leading asterisks, white space, and the separator (\f3/**\fR)\&. This means you can use the \f3@\fR character elsewhere in the text and it will not be interpreted as the start of a tag\&. If you want to start a line with the \f3@\fR character and not have it be interpreted, then use the HTML entity \f3@\fR\&. Each block tag has associated text, which includes any text following the tag up to, but not including, either the next tag, or the end of the documentation comment\&. This associated text can span multiple lines\&. An inline tag is allowed and interpreted anywhere that text is allowed\&. The following example contains the \f3@deprecated\fR block tag and the \f3{@link}\fR inline tag\&. See Javadoc Tags\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @deprecated As of JDK 1\&.1, replaced by {@link #setBounds(int,int,int,int)}\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Write Comments in HTML + +The text must be written in HTML with HTML entities and HTML tags\&. You can use whichever version of HTML your browser supports\&. The standard doclet generates HTML 3\&.2-compliant code elsewhere (outside of the documentation comments) with the inclusion of cascading style sheets and frames\&. HTML 4\&.0 is preferred for generated files because of the frame sets\&. +.PP +For example, entities for the less than symbol (<) and the greater than symbol (>) should be written as \f3<\fR and \f3>\fR\&. Similarly, the ampersand (&) should be written as \f3&\fR\&. The bold HTML tag \f3<b>\fR is shown in the following example\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This is a <b>doc</b> comment\&.\fP +.fi +.nf +\f3 * @see java\&.lang\&.Object\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Leading Asterisks + +When the \f3javadoc\fR command parses a documentation comment, leading asterisks (*) on each line are discarded, and blanks and tabs that precede the initial asterisks (*) are also discarded\&. If you omit the leading asterisk on a line, then the leading white space is no longer removed so that you can paste code examples directly into a documentation comment inside a \f3<PRE>\fR tag with its indentation preserved\&. Spaces are interpreted by browsers more uniformly than tabs\&. Indentation is relative to the left margin (rather than the separator \f3/**\fR or \f3<PRE>\fR tag)\&. +.PP +First Sentence + +The first sentence of each documentation comment should be a summary sentence that contains a concise but complete description of the declared entity\&. This sentence ends at the first period that is followed by a blank, tab, or line terminator, or at the first block tag\&. The \f3javadoc\fR command copies this first sentence to the member summary at the top of the HTML page\&. +.PP +Multiple-Field Declarations + +The Java platform lets you declare multiple fields in a single statement, but this statement can have only one documentation comment that is copied for all fields\&. If you want individual documentation comments for each field, then declare each field in a separate statement\&. For example, the following documentation comment does not make sense written as a single declaration and would be better handled as two declarations: +.sp +.nf +\f3/** \fP +.fi +.nf +\f3 * The horizontal and vertical distances of point (x,y)\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public int x, y; // Avoid this \fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3javadoc\fR command generates the following documentation from the previous code: +.sp +.nf +\f3public int x\fP +.fi +.nf +\f3\fP +.fi +.sp +The horizontal and vertical distances of point (x, y)\&. +.sp +.nf +\f3public int y\fP +.fi +.nf +\f3\fP +.fi +.sp +The horizontal and vertical distances of point (x, y)\&. +.PP +Use of Header Tags + +When writing documentation comments for members, it is best not to use HTML heading tags such as \f3<H1>\fR and \f3<H2>\fR, because the \f3javadoc\fR command creates an entire structured document, and these structural tags might interfere with the formatting of the generated document\&. However, you can use these headings in class and package comments to provide your own structure\&. +.SS METHOD\ COMMENT\ INHERITANCE +The \f3javadoc\fR command allows method comment inheritance in classes and interfaces to fill in missing text or to explicitly inherit method comments\&. Constructors, fields, and nested classes do not inherit documentation comments\&. +.PP +\fINote:\fR The source file for an inherited method must be on the path specified by the \f3-sourcepath\fR option for the documentation comment to be available to copy\&. Neither the class nor its package needs to be passed in on the command line\&. This contrasts with Release 1\&.3\&.\fIn\fR and earlier releases, where the class had to be a documented class\&. +.PP +Fill in Missing Text + +When a main description, or \f3@return\fR, \f3@param\fR, or \f3@throws\fR tag is missing from a method comment, the \f3javadoc\fR command copies the corresponding main description or tag comment from the method it overrides or implements (if any)\&. See Method Comment Inheritance\&. +.PP +When an \f3@param\fR tag for a particular parameter is missing, the comment for that parameter is copied from the method further up the inheritance hierarchy\&. When an \f3@throws\fR tag for a particular exception is missing, the \f3@throws\fR tag is copied only when that exception is declared\&. +.PP +This behavior contrasts with Release 1\&.3 and earlier, where the presence of any main description or tag would prevent all comments from being inherited\&. +.PP +See Javadoc Tags and Options\&. +.PP +Explicit Inheritance + +Insert the \f3{@inheritDoc}\fR inline tag in a method main description or \f3@return\fR, \f3@param\fR, or \f3@throws\fR tag comment\&. The corresponding inherited main description or tag comment is copied into that spot\&. +.SS CLASS\ AND\ INTERFACE\ INHERITANCE +Comment inheritance occurs in all possible cases of inheritance from classes and interfaces: +.TP 0.2i +\(bu +When a method in a class overrides a method in a superclass +.TP 0.2i +\(bu +When a method in an interface overrides a method in a superinterface +.TP 0.2i +\(bu +When a method in a class implements a method in an interface +.PP +In the first two cases, the \f3javadoc\fR command generates the subheading \fIOverrides\fR in the documentation for the overriding method\&. A link to the method being overridden is included, whether or not the comment is inherited\&. +.PP +In the third case, when a method in a specified class implements a method in an interface, the \f3javadoc\fR command generates the subheading \fISpecified by\fR in the documentation for the overriding method\&. A link to the method being implemented is included, whether or not the comment is inherited\&. +.SS METHOD\ COMMENTS\ ALGORITHM +If a method does not have a documentation comment, or has an \f3{@inheritDoc}\fR tag, then the \f3javadoc\fR command uses the following algorithm to search for an applicable comment\&. The algorithm is designed to find the most specific applicable documentation comment, and to give preference to interfaces over superclasses: +.TP 0.4i +1\&. +Look in each directly implemented (or extended) interface in the order they appear following the word \f3implements\fR (or \f3extends\fR) in the method declaration\&. Use the first documentation comment found for this method\&. +.TP 0.4i +2\&. +If Step 1 failed to find a documentation comment, then recursively apply this entire algorithm to each directly implemented (or extended) interface in the same order they were examined in Step 1\&. +.TP 0.4i +3\&. +When Step 2 fails to find a documentation comment and this is a class other than the \f3Object\fR class, but not an interface: +.RS +.TP 0.4i +1\&. +If the superclass has a documentation comment for this method, then use it\&. +.TP 0.4i +2\&. +If Step 3a failed to find a documentation comment, then recursively apply this entire algorithm to the superclass\&. +.RE + +.SH JAVADOC\ TAGS +The \f3javadoc\fR command parses special tags when they are embedded within a Java documentation comment\&. The \f3javadoc\fR tags let you autogenerate a complete, well-formatted API from your source code\&. The tags start with an at sign (\f3@\fR) and are case-sensitive\&. They must be typed with the uppercase and lowercase letters as shown\&. A tag must start at the beginning of a line (after any leading spaces and an optional asterisk), or it is treated as text\&. By convention, tags with the same name are grouped together\&. For example, put all \f3@see\fR tags together\&. For more information, see Where Tags Can Be Used\&. +.PP +Tags have the following types: +.TP 0.2i +\(bu +Bock tags: Place block tags only in the tag section that follows the description\&. Block tags have the form: \fI@tag\fR\&. +.TP 0.2i +\(bu +Inline tags: Place inline tags anywhere in the main description or in the comments for block tags\&. Inline tags are enclosed within braces: \fI{@tag}\fR\&. +.PP +For custom tags, see -tag tagname:Xaoptcmf:"taghead"\&. See also Where Tags Can Be Used\&. +.SS TAG\ DESCRIPTIONS +.TP +@author \fIname-text\fR +Introduced in JDK 1\&.0 + +Adds an Author entry with the specified name text to the generated documents when the \f3-author\fR option is used\&. A documentation comment can contain multiple \f3@author\fR tags\&. You can specify one name per \f3@author\fR tag or multiple names per tag\&. In the former case, the \f3javadoc\fR command inserts a comma (,) and space between names\&. In the latter case, the entire text is copied to the generated document without being parsed\&. Therefore, you can use multiple names per line if you want a localized name separator other than a comma\&. See @author in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@author +.TP +{@code \fItext\fR} +Introduced in JDK 1\&.5 + +Equivalent to \f3<code>{@literal}</code>\fR\&. + +Displays text in code font without interpreting the text as HTML markup or nested Javadoc tags\&. This enables you to use regular angle brackets (< and >) instead of the HTML entities (\f3<\fR and \f3>\fR) in documentation comments, such as in parameter types (\f3<Object>\fR), inequalities (\f33 < 4\fR), or arrows (\f3<-\fR)\&. For example, the documentation comment text \f3{@code A<B>C}\fR displayed in the generated HTML page unchanged as \f3A<B>C\fR\&. This means that the \f3<B>\fR is not interpreted as bold and is in code font\&. If you want the same functionality without the code font, then use the \f3{@literal}\fR tag\&. +.TP +@deprecated \fIdeprecated-text\fR +Introduced in JDK 1\&.0 + +Adds a comment indicating that this API should no longer be used (even though it may continue to work)\&. The \f3javadoc\fR command moves \f3deprecated-text\fRahead of the main description, placing it in italics and preceding it with a bold warning: Deprecated\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field\&. + +The first sentence of deprecated text should tell the user when the API was deprecated and what to use as a replacement\&. The \f3javadoc\fR command copies the first sentence to the summary section and index\&. Subsequent sentences can also explain why it was deprecated\&. You should include an \f3{@link}\fR tag (for Javadoc 1\&.2 or later) that points to the replacement API\&. + +Use the \fI@deprecated annotation\fR tag to deprecate a program element\&. See How and When to Deprecate APIs at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/deprecation/deprecation\&.html + +See also @deprecated in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@deprecated +.TP +{@docRoot} +Introduced in JDK 1\&.3 + +Represents the relative path to the generated document\&'s (destination) root directory from any generated page\&. This tag is useful when you want to include a file, such as a copyright page or company logo, that you want to reference from all generated pages\&. Linking to the copyright page from the bottom of each page is common\&. + +This \f3{@docRoot}\fR tag can be used both on the command line and in a documentation comment\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field, and includes the text portion of any tag (such as the \f3@return\fR, \f3@param\fR and \f3@deprecated\fR tags)\&. +.RS +.TP 0.2i +\(bu +On the command line, where the header, footer, or bottom are defined: \f3javadoc -bottom \&'<a href="{@docRoot}/copyright\&.html">Copyright</a>\&'\fR\&. + +When you use the \f3{@docRoot}\fR tag this way in a make file, some \f3makefile\fR programs require a special way to escape for the brace \f3{}\fR characters\&. For example, the Inprise MAKE version 5\&.2 running on Windows requires double braces: \f3{{@docRoot}}\fR\&. It also requires double (rather than single) quotation marks to enclose arguments to options such as the \f3-bottom\fR option (with the quotation marks around the \f3href\fR argument omitted)\&. +.TP 0.2i +\(bu +In a documentation comment: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * See the <a href="{@docRoot}/copyright\&.html">Copyright</a>\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This tag is needed because the generated documents are in hierarchical directories, as deep as the number of subpackages\&. The expression: \f3<a href="{@docRoot}/copyright\&.html">\fR resolves to \f3<a href="\&.\&./\&.\&./copyright\&.html">\fR for \f3java/lang/Object\&.java\fR and \f3<a href="\&.\&./\&.\&./\&.\&./copyright\&.html">\fR for \f3java/lang/ref/Reference\&.java\fR\&. +.RE + +.TP +@exception \fIclass-name description\fR +Introduced in JDK 1\&.0 + +Identical to the \f3@throws\fR tag\&. See @throws class-name description\&. +.TP +{@inheritDoc} +Introduced in JDK 1\&.4 + +Inherits (copies) documentation from the nearest inheritable class or implementable interface into the current documentation comment at this tag\&'s location\&. This enables you to write more general comments higher up the inheritance tree and to write around the copied text\&. + +This tag is valid only in these places in a documentation comment: +.RS +.TP 0.2i +\(bu +In the main description block of a method\&. In this case, the main description is copied from a class or interface up the hierarchy\&. +.TP 0.2i +\(bu +In the text arguments of the \f3@return\fR, \f3@param,\fR and \f3@throws\fR tags of a method\&. In this case, the tag text is copied from the corresponding tag up the hierarchy\&. +.RE + + +See Method Comment Inheritance for a description of how comments are found in the inheritance hierarchy\&. Note that if this tag is missing, then the comment is or is not automatically inherited according to rules described in that section\&. +.TP +{@link \fIpackage\&.class#member label\fR} +Introduced in JDK 1\&.2 + +Inserts an inline link with a visible text label that points to the documentation for the specified package, class, or member name of a referenced class\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field, including the text portion of any tag, such as the \f3@return\fR, \f3@param\fR and \f3@deprecated\fR tags\&. See @link in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#{@link + +This tag is similar to the \f3@see\fR tag\&. Both tags require the same references and accept the same syntax for \f3package\&.class#member\fR and \f3label\fR\&. The main difference is that the \f3{@link}\fR tag generates an inline link rather than placing the link in the See Also section\&. The \f3{@link}\fR tag begins and ends with braces to separate it from the rest of the inline text\&. If you need to use the right brace (\f3}\fR) inside the label, then use the HTML entity notation \f3}\fR\&. + +There is no limit to the number of \f3{@link}\fR tags allowed in a sentence\&. You can use this tag in the main description part of any documentation comment or in the text portion of any tag, such as the \f3@deprecated\fR, \f3@return\fR or \f3@param\fR tags\&. + +For example, here is a comment that refers to the \f3getComponentAt(int, int)\fR method: +.sp +.nf +\f3Use the {@link #getComponentAt(int, int) getComponentAt} method\&.\fP +.fi +.nf +\f3\fP +.fi +.sp + + +From this code, the standard doclet generates the following HTML (assuming it refers to another class in the same package): +.sp +.nf +\f3Use the <a href="Component\&.html#getComponentAt(int, int)">getComponentAt</a> method\&.\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The previous line appears on the web page as: +.sp +.nf +\f3Use the getComponentAt method\&.\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +{@linkplain \fIpackage\&.class#member label\fR} +Introduced in JDK 1\&.4 + +Behaves the same as the \f3{@link}\fR tag, except the link label is displayed in plain text rather than code font\&. Useful when the label is plain text\&. For example, \f3Refer to {@linkplain add() the overridden method}\fR\&. displays as: Refer to the overridden method\&. +.TP +{@literal \fItext\fR} +Introduced in JDK 1\&.5 + +Displays text without interpreting the text as HTML markup or nested Javadoc tags\&. This enables you to use angle brackets (\f3< and >\fR) instead of the HTML entities (\f3<\fR and \f3>\fR) in documentation comments, such as in parameter types (\f3<Object>\fR), inequalities (\f33 < 4\fR), or arrows (<-)\&. For example, the documentation comment text \f3{@literal A<B>C}\fR displays unchanged in the generated HTML page in your browser, as \f3A<B>C\fR\&. The \f3<B>\fR is not interpreted as bold (and it is not in code font)\&. If you want the same functionality with the text in code font, then use the \f3{@code}\fR tag\&. +.TP +@param \fIparameter-name description\fR +Introduced in JDK 1\&.0 + +Adds a parameter with the specified \f3parameter-name\fR followed by the specified description to the Parameters section\&. When writing the documentation comment, you can continue the description onto multiple lines\&. This tag is valid only in a documentation comment for a method, constructor, or class\&. See @param in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@param + +The \f3parameter-name\fR can be the name of a parameter in a method or constructor, or the name of a type parameter of a class, method, or constructor\&. Use angle brackets around this parameter name to specify the use of a type parameter\&. + +Example of a type parameter of a class: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @param <E> Type of element stored in a list\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public interface List<E> extends Collection<E> {\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Example of a type parameter of a method: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @param string the string to be converted\fP +.fi +.nf +\f3 * @param type the type to convert the string to\fP +.fi +.nf +\f3 * @param <T> the type of the element\fP +.fi +.nf +\f3 * @param <V> the value of the element\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3<T, V extends T> V convert(String string, Class<T> type) {\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +@return \fIdescription\fR +Introduced in JDK 1\&.0 + +Adds a Returns section with the description text\&. This text should describe the return type and permissible range of values\&. This tag is valid only in a documentation comment for a method\&. See @return in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@return +.TP +@see \fIreference\fR +Introduced in JDK 1\&.0 + +Adds a \fISee Also\fR heading with a link or text entry that points to a reference\&. A documentation comment can contain any number of \f3@see\fR tags, which are all grouped under the same heading\&. The \f3@see\fR tag has three variations\&. The form is the most common\&. This tag is valid in any documentation comment: overview, package, class, interface, constructor, method, or field\&. For inserting an inline link within a sentence to a package, class, or member, see \f3{@link}\fR\&. + +\fIForm 1\fR\&. The @see \f3string\fR tag form adds a text entry for \fIstring\fR\&. No link is generated\&. The string is a book or other reference to information not available by URL\&. The \f3javadoc\fR command distinguishes this from the previous cases by searching for a double quotation mark (") as the first character\&. For example, \f3@see "The Java Programming Language"\fR that generates the following text: + +\fISee Also\fR: + +"The Java Programming Language" + +\fIForm 2\fR\&. The \f3@see <a href="URL#value">label</a>\fR form adds a link as defined by \f3URL#value\fR\&. The \f3URL#value\fR parameter is a relative or absolute URL\&. The \f3javadoc\fR command distinguishes this from other cases by searching for a less-than symbol (\f3<\fR) as the first character\&. For example, \f3@see <a href="spec\&.html#section">Java Spec</a>\fR generates the following link: + +\fISee Also\fR: + +Java Spec + +\fIForm 3\fR\&. The \f3@see package\&.class#member label\fR form adds a link with a visible text label that points to the documentation for the specified name in the Java Language that is referenced\&. The label is optional\&. If the label is omitted, then the name appears instead as visible text, suitably shortened\&. Use the \f3-noqualifier\fR option to globally remove the package name from this visible text\&. Use the label when you want the visible text to be different from the autogenerated visible text\&. See How a Name Appears\&. + +In Java SE 1\&.2 only, the name but not the label automatically appears in \f3<code>\fR HTML tags\&. Starting with Java SE 1\&.2\&.2, the \f3<code>\fR tag is always included around the visible text, whether or not a label is used\&. +.RS +.TP 0.2i +\(bu +\f3package\&.class#member\fR is any valid program element name that is referenced, such as a package, class, interface, constructor, method or field name, except that the character ahead of the member name should be a number sign (\f3#\fR)\&. The class represents any top-level or nested class or interface\&. The member represents any constructor, method, or field (not a nested class or interface)\&. If this name is in the documented classes, then the \f3javadoc\fR command create a link to it\&. To create links to external referenced classes, use the \f3-link\fR option\&. Use either of the other two \f3@see\fR tag forms to refer to the documentation of a name that does not belong to a referenced class\&. See Specify a Name\&. + +\fINote:\fR External referenced classes are classes that are not passed into the \f3javadoc\fR command on the command line\&. Links in the generated documentation to external referenced classes are called external references or external links\&. For example, if you run the \f3javadoc\fR command on only the \f3java\&.awt package\fR, then any class in \f3java\&.lang\fR, such as \f3Object\fR, is an external referenced class\&. Use the \f3-link\fR and \f3-linkoffline\fR options to link to external referenced classes\&. The source comments of external referenced classes are not available to the \f3javadoc\fR command run\&. +.TP 0.2i +\(bu +\f3label\fR is optional text that is visible as the link label\&. The label can contain white space\&. If \f3label\fR is omitted, then \f3package\&.class\&.member\fR appears, suitably shortened relative to the current class and package\&. See How a Name Appears\&. +.TP 0.2i +\(bu +A space is the delimiter between \f3package\&.class#member\fR and \f3label\fR\&. A space inside parentheses does not indicate the start of a label, so spaces can be used between parameters in a method\&. +.RE + + +\fI\fRIn the following example, an \f3@see\fR tag (in the \f3Character\fR class) refers to the equals method in the \f3String\fR class\&. The tag includes both arguments: the name \f3String#equals(Object)\fR and the label \f3equals\fR\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @see String#equals(Object) equals\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The standard doclet produces HTML that is similar to: +.sp +.nf +\f3<dl>\fP +.fi +.nf +\f3<dt><b>See Also:</b>\fP +.fi +.nf +\f3<dd><a href="\&.\&./\&.\&./java/lang/String#equals(java\&.lang\&.Object)"><code>equals<code></a>\fP +.fi +.nf +\f3</dl>\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The previous code looks similar to the following in a browser, where the label is the visible link text: + +\fISee Also\fR: + +equals +.PP +Specify a Name + +\fI\fRThis \f3package\&.class#member\fR name can be either fully qualified, such as \f3java\&.lang\&.String#toUpperCase()\fR or not, such as \f3String#toUpperCase()\fR or \f3#toUpperCase()\fR\&. If the name is less than fully qualified, then the \f3javadoc\fR command uses the standard Java compiler search order to find it\&. See Search Order for the @see Tag\&. The name can contain white space within parentheses, such as between method arguments\&.The advantage to providing shorter, partially qualified names is that they are shorter to type and there is less clutter in the source code\&. The following listing shows the different forms of the name, where \f3Class\fR can be a class or interface; Type can be a class, interface, array, or primitive; and method can be a method or constructor\&. +.sp +.nf +\f3\fITypical forms for\fR\fI @see package\&.class#member\fR\fP +.fi +.nf +\f3\fIReferencing a member of the current class\fR\fP +.fi +.nf +\f3@see #field\fP +.fi +.nf +\f3@see #method(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see #method(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see #constructor(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see #constructor(Type argname, Type argname,\&.\&.\&.) \fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\fIReferencing another class in the current or imported packages\fR\fP +.fi +.nf +\f3@see Class#field\fP +.fi +.nf +\f3@see Class#method(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see Class#method(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see Class#constructor(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see Class#constructor(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see Class\&.NestedClass\fP +.fi +.nf +\f3@see Class \fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\fIReferencing an element in another package (fully qualified)\fR\fP +.fi +.nf +\f3@see package\&.Class#field\fP +.fi +.nf +\f3@see package\&.Class#method(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see package\&.Class#method(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see package\&.Class#constructor(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see package\&.Class#constructor(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see package\&.Class\&.NestedClass\fP +.fi +.nf +\f3@see package\&.Class\fP +.fi +.nf +\f3@see package\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3\fRNotes about the previous listing: +.TP 0.2i +\(bu +The first set of forms with no class or package causes the \f3javadoc\fR command to search only through the current class hierarchy\&. It finds a member of the current class or interface, one of its superclasses or superinterfaces, or one of its enclosing classes or interfaces (search Items 1\(en3)\&. It does not search the rest of the current package or other packages (search Items 4\(en5)\&. See Search Order for the @see Tag\&. +.TP 0.2i +\(bu +If any method or constructor is entered as a name with no parentheses, such as \f3getValue\fR, and if there is no field with the same name, then the \f3javadoc\fR command still creates a link to the method\&. If this method is overloaded, then the \f3javadoc\fR command links to the first method its search encounters, which is unspecified\&. +.TP 0.2i +\(bu +Nested classes must be specified as \f3outer\&.inner\fR, not simply \f3inner\fR, for all forms\&. +.TP 0.2i +\(bu +As stated, the number sign (\f3#\fR), rather than a dot (\f3\&.\fR) separates a member from its class\&. This enables the \f3javadoc\fR command to resolve ambiguities, because the dot also separates classes, nested classes, packages, and subpackages\&. However, the \f3javadoc\fR command properly parses a dot when there is no ambiguity, but prints a warning to alert you\&. +.PP +Search Order for the @see Tag + +\fI\fRThe \f3javadoc\fR command processes an \f3@see\fR tag that appears in a source file, package file, or overview file\&. In the latter two files, you must fully qualify the name you supply with the \f3@see\fR tag\&. In a source file, you can specify a name that is fully qualified or partially qualified\&. +.PP +The following is the search order for the \f3@see\fR tag\&. +.TP 0.4i +1\&. +The current class or interface\&. +.TP 0.4i +2\&. +Any enclosing classes and interfaces searching the closest first\&. +.TP 0.4i +3\&. +Any superclasses and superinterfaces, searching the closest first\&. +.TP 0.4i +4\&. +The current package\&. +.TP 0.4i +5\&. +Any imported packages, classes, and interfaces, searching in the order of the \f3import\fR statement\&. +.PP +The \f3javadoc\fR command continues to search recursively through Items 1-3 for each class it encounters until it finds a match\&. That is, after it searches through the current class and its enclosing class E, it searches through the superclasses of E before the enclosing classes of E\&. In Items 4 and 5, the \f3javadoc\fR command does not search classes or interfaces within a package in any specified order (that order depends on the particular compiler)\&. In Item 5, the \f3javadoc\fR command searches in \fIjava\&.lang\fR because that is imported by all programs\&. +.PP +When the \f3javadoc\fR command encounters an \f3@see\fR tag in a source file that is not fully qualified, it searches for the specified name in the same order as the Java compiler would, except the \f3javadoc\fR command does not detect certain name space ambiguities because it assumes the source code is free of these errors\&. This search order is formally defined in the Java Language Specification\&. The \f3javadoc\fR command searches for that name through all related and imported classes and packages\&. In particular, it searches in this order: +.TP 0.4i +1\&. +The current class or interface\&. +.TP 0.4i +2\&. +Any enclosing classes and interfaces, searching the closest first\&. +.TP 0.4i +3\&. +Any superclasses and superinterfaces, searching the closest first\&. +.TP 0.4i +4\&. +The current package\&. +.TP 0.4i +5\&. +Any imported packages, classes, and interfaces, searching in the order of the \f3import\fR statements\&. +.PP +The \f3javadoc\fR command does not necessarily look in subclasses, nor will it look in other packages even when their documentation is being generated in the same run\&. For example, if the \f3@see\fR tag is in the \f3java\&.awt\&.event\&.KeyEvent\fR class and refers to a name in the \f3java\&.awt package\fR, then the \f3javadoc\fR command does not look in that package unless that class imports it\&. +.PP +How a Name Appears + +\fI\fRIf \f3label\fR is omitted, then \f3package\&.class\&.member\fR appears\&. In general, it is suitably shortened relative to the current class and package\&. Shortened means the \f3javadoc\fR command displays only the minimum name necessary\&. For example, if the \f3String\&.toUpperCase()\fR method contains references to a member of the same class and to a member of a different class, then the class name is displayed only in the latter case, as shown in the following listing\&. Use the \f3-noqualifier\fR option to globally remove the package names\&. +.PP +\fIType of reference\fR: The \f3@see\fR tag refers to a member of the same class, same package +.br +\fIExample in\fR: \f3@see String#toLowerCase()\fR +.br +\fIAppears as\fR: \f3toLowerCase()\fR - omits the package and class names +.br + +.PP +\fIType of reference\fR: The \f3@see\fR tag refers to a member of a different class, same package +.br +\fIExample in\fR: \f3@see Character#toLowerCase(char)\fR +.br +\fIAppears as\fR: \f3Character\&.toLowerCase(char)\fR - omits the package name, includes the class name +.br + +.PP +\fIType of reference\fR: The \f3@see\fR tag refers to a member of a different class, different package +.br +\fIExample in\fR: \f3@see java\&.io\&.File#exists()\fR +.br +\fIAppears as\fR: \f3java\&.io\&.File\&.exists()\fR - includes the package and class names +.br + +.PP +Examples of the @see Tag + +The comment to the right shows how the name appears when the \f3@see\fR tag is in a class in another package, such as \f3java\&.applet\&.Applet\fR\&. See @see in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@see +.sp +.nf +\f3 See also:\fP +.fi +.nf +\f3@see java\&.lang\&.String // String \fP +.fi +.nf +\f3@see java\&.lang\&.String The String class // The String class \fP +.fi +.nf +\f3@see String // String \fP +.fi +.nf +\f3@see String#equals(Object) // String\&.equals(Object) \fP +.fi +.nf +\f3@see String#equals // String\&.equals(java\&.lang\&.Object) \fP +.fi +.nf +\f3@see java\&.lang\&.Object#wait(long) // java\&.lang\&.Object\&.wait(long) \fP +.fi +.nf +\f3@see Character#MAX_RADIX // Character\&.MAX_RADIX \fP +.fi +.nf +\f3@see <a href="spec\&.html">Java Spec</a> // Java Spec \fP +.fi +.nf +\f3@see "The Java Programming Language" // "The Java Programming Language" \fP +.fi +.nf +\f3\fP +.fi +.sp +\fINote:\fR You can extend the \f3@se\fR\f3e\fR tag to link to classes not being documented with the \f3-link\fR option\&. +.TP +@serial \fIfield-description\fR | include | exclude +Introduced in JDK 1\&.2 + +Used in the documentation comment for a default serializable field\&. See Documenting Serializable Fields and Data for a Class at http://docs\&.oracle\&.com/javase/8/docs/platform/serialization/spec/serial-arch\&.html#5251 + +See also Oracle\(cqs Criteria for Including Classes in the Serialized Form Specification at http://www\&.oracle\&.com/technetwork/java/javase/documentation/serialized-criteria-137781\&.html + +An optional \f3field-description\fR should explain the meaning of the field and list the acceptable values\&. When needed, the description can span multiple lines\&. The standard doclet adds this information to the serialized form page\&. See Cross-Reference Pages\&. + +If a serializable field was added to a class after the class was made serializable, then a statement should be added to its main description to identify at which version it was added\&. + +The \f3include\fR and \f3exclude\fR arguments identify whether a class or package should be included or excluded from the serialized form page\&. They work as follows: +.RS +.TP 0.2i +\(bu +A public or protected class that implements \f3Serializable\fR is included unless that class (or its package) is marked with the \f3@serial exclude\fR tag\&. +.TP 0.2i +\(bu +A private or package-private class that implements \f3Serializable\fR is excluded unless that class (or its package) is marked with the \f3@serial include\fR tag\&. +.RE + + +For example, the \f3javax\&.swing\fR package is marked with the \f3@serial\fR\f3exclude\fR tag in package\&.html or package-info\&.java\&. The public class \f3java\&.security\&.BasicPermission\fR is marked with the \f3@serial exclude\fR tag\&. The package-private class \f3java\&.util\&.PropertyPermissionCollection\fR is marked with the \f3@serial include\fR tag\&. + +The \f3@serial\fR tag at the class level overrides the \f3@serial\fR tag at the package level\&. +.TP +@serialData \fIdata-description\fR +Introduced in JDK 1\&.2 + +Uses the data description value to document the types and order of data in the serialized form\&. This data includes the optional data written by the \f3writeObject\fR method and all data (including base classes) written by the \f3Externalizable\&.writeExternal\fR method\&. + +The \f3@serialData\fR tag can be used in the documentation comment for the \f3writeObject\fR, \f3readObject\fR, \f3writeExternal\fR, \f3readExternal\fR, \f3writeReplace\fR, and \f3readResolve\fR methods\&. +.TP +@serialField \fIfield-name\fR\fIfield-type\fR\fIfield-description\fR +Introduced in JDK 1\&.2 + +Documents an \f3ObjectStreamField\fR component of the \f3serialPersistentFields\fR member of a \f3Serializable\fR class\&. Use one \f3@serialField\fR tag for each \f3ObjectStreamField\fR component\&. +.TP +@since \fIsince-text\fR +Introduced in JDK 1\&.1 + +Adds a \fISince\fR heading with the specified \f3since-text\fR value to the generated documentation\&. The text has no special internal structure\&. This tag is valid in any documentation comment: overview, package, class, interface, constructor, method, or field\&. This tag means that this change or feature has existed since the software release specified by the \f3since-text\fR value, for example: \f3@since 1\&.5\fR\&. + +For Java platform source code, the \f3@since\fR tag indicates the version of the Java platform API specification, which is not necessarily when the source code was added to the reference implementation\&. Multiple \f3@since\fR tags are allowed and are treated like multiple \f3@author\fR tags\&. You could use multiple tags when the program element is used by more than one API\&. +.TP +@throws \fIclass-name\fR\fIdescription\fR +Introduced in JDK 1\&.2 + +Behaves the same as the \f3@exception\fR tag\&. See @throws in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@exception + +The \f3@throws\fR tag adds a \fIThrows\fR subheading to the generated documentation, with the \f3class-name\fR and \f3description\fR text\&. The \fIclass-name\fR is the name of the exception that might be thrown by the method\&. This tag is valid only in the documentation comment for a method or constructor\&. If this class is not fully specified, then the \f3javadoc\fR command uses the search order to look up this class\&. Multiple \f3@throws\fR tags can be used in a specified documentation comment for the same or different exceptions\&. See Search Order for the @see Tag\&. + +To ensure that all checked exceptions are documented, when an \f3@throws\fR tag does not exist for an exception in the throws clause, the \f3javadoc\fR command adds that exception to the HTML output (with no description) as though it were documented with the \f3@throws\fR tag\&. + +The \f3@throws\fR documentation is copied from an overridden method to a subclass only when the exception is explicitly declared in the overridden method\&. The same is true for copying from an interface method to an implementing method\&. You can use the \f3{@inheritDoc}\fR tag to force the \f3@throws\fR tag to inherit documentation\&. +.TP +{@value \fIpackage\&.class#field\fR} +Introduced in JDK 1\&.4 + +Displays constant values\&. When the \f3{@value}\fR tag is used without an argument in the documentation comment of a static field, it displays the value of that constant: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * The value of this constant is {@value}\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public static final String SCRIPT_START = "<script>"\fP +.fi +.nf +\f3\fP +.fi +.sp + + +When used with the argument \f3package\&.class#field\fR in any documentation comment, he \f3{@value}\fR tag displays the value of the specified constant: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * Evaluates the script starting with {@value #SCRIPT_START}\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public String evalScript(String script) {}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The argument \f3package\&.class#field\fR takes a form similar to that of the \f3@see\fR tag argument, except that the member must be a static field\&. + +The values of these constants are also displayed in Constant Field Values at http://docs\&.oracle\&.com/javase/8/docs/api/constant-values\&.html +.TP +@version \fIversion-text\fR +Introduced in JDK 1\&.0 + +Adds a \fIVersion\fR subheading with the specified \f3version-text\fR value to the generated documents when the \f3-version\fR option is used\&. This tag is intended to hold the current release number of the software that this code is part of, as opposed to the\f3@since\fR tag, which holds the release number where this code was introduced\&. The \f3version-text\fR value has no special internal structure\&. See @version in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@version + +A documentation comment can contain multiple \f3@version\fR tags\&. When it makes sense, you can specify one release number per \f3@version\fR tag or multiple release numbers per tag\&. In the former case, the \f3javadoc\fR command inserts a comma (,) and a space between the names\&. In the latter case, the entire text is copied to the generated document without being parsed\&. Therefore, you can use multiple names per line when you want a localized name separator other than a comma\&. +.SH WHERE\ TAGS\ CAN\ BE\ USED +The following sections describe where tags can be used\&. Note that the following tags can be used in all documentation comments: \f3@see\fR, \f3@since\fR, \f3@deprecated\fR, \f3{@link}\fR, \f3{@linkplain}\fR, and \f3{@docroot}\fR\&. +.SS OVERVIEW\ TAGS +Overview tags are tags that can appear in the documentation comment for the overview page (which resides in the source file typically named overview\&.html)\&. Similar to any other documentation comments, these tags must appear after the main description +.PP +\fINote:\fR The \f3{@link}\fR tag has a bug in overview documents in Java SE 1\&.2\&. The text appears correctly but has no link\&. The \f3{@docRoot}\fR tag does not currently work in overview documents\&. +.PP +The overview tags are the following: +.PP +@see reference || @since since-text || @serialField field-name field-type field-description || @author name-text || @version version-text || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || +.SS PACKAGE\ TAGS +Package tags are tags that can appear in the documentation comment for a package, that resides in the source file named package\&.html or package-info\&.java\&. The \f3@serial\fR tag can only be used here with the \f3include\fR or \f3exclude\fR argument\&. +.PP +The package tags are the following: +.PP +@see reference || @since since-text || @serial field-description | include | exclude || @author name-text || @version version-text || {@linkplain package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || +.SS CLASS\ AND\ INTERFACE\ TAGS +The following are tags that can appear in the documentation comment for a class or interface\&. The \f3@serial\fR tag can only be used within the documentation for a class or interface with an \f3include\fR or \f3exclude\fR argument\&. +.PP +@see reference || @since since-text || @deprecated deprecated-text || @serial field-description | include | exclude || @author name-text || @version version-text || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || +.PP +Class comment example: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * A class representing a window on the screen\&.\fP +.fi +.nf +\f3 * For example:\fP +.fi +.nf +\f3 * <pre>\fP +.fi +.nf +\f3 * Window win = new Window(parent);\fP +.fi +.nf +\f3 * win\&.show();\fP +.fi +.nf +\f3 * </pre>\fP +.fi +.nf +\f3 *\fP +.fi +.nf +\f3 * @author Sami Shaio\fP +.fi +.nf +\f3 * @version 1\&.13, 06/08/06\fP +.fi +.nf +\f3 * @see java\&.awt\&.BaseWindow\fP +.fi +.nf +\f3 * @see java\&.awt\&.Button\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3class Window extends BaseWindow {\fP +.fi +.nf +\f3 \&.\&.\&.\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS FIELD\ TAGS +These tags can appear in fields: +.PP +@see reference || @since since-text || @deprecated deprecated-text || @serial field-description | include | exclude || @serialField field-name field-type field-description || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || {@value package\&.class#field} +.PP +Field comment example: +.sp +.nf +\f3 /**\fP +.fi +.nf +\f3 * The X\-coordinate of the component\&.\fP +.fi +.nf +\f3 *\fP +.fi +.nf +\f3 * @see #getLocation()\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3 int x = 1263732;\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS CONSTRUCTOR\ AND\ METHOD\ TAGS +The following tags can appear in the documentation comment for a constructor or a method, except for the \f3@return\fR tag, which cannot appear in a constructor, and the \f3{@inheritDoc}\fR tag, which has restrictions\&. +.PP +@see reference || @since since-text || @deprecated deprecated-text || @param parameter-name description || @return description || @throws class-name description || @exception class-name description || @serialData data-description || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@inheritDoc} || {@docRoot} +.PP +\fINote:\fR The \f3@serialData\fR tag can only be used in the documentation comment for the \f3writeObject\fR, \f3readObject\fR, \f3writeExternal\fR, \f3readExternal\fR, \f3writeReplace\fR, and \f3readResolve\fR methods\&. +.PP +Method comment example: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * Returns the character at the specified index\&. An index \fP +.fi +.nf +\f3 * ranges from <code>0</code> to <code>length() \- 1</code>\fP +.fi +.nf +\f3 *\fP +.fi +.nf +\f3 * @param index the index of the desired character\&.\fP +.fi +.nf +\f3 * @return the desired character\&.\fP +.fi +.nf +\f3 * @exception StringIndexOutOfRangeException \fP +.fi +.nf +\f3 * if the index is not in the range <code>0</code> \fP +.fi +.nf +\f3 * to <code>length()\-1</code>\fP +.fi +.nf +\f3 * @see java\&.lang\&.Character#charValue()\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3 public char charAt(int index) {\fP +.fi +.nf +\f3 \&.\&.\&.\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +The \f3javadoc\fR command uses doclets to determine its output\&. The \f3javadoc\fR command uses the default standard doclet unless a custom doclet is specified with the \f3-doclet\fR option\&. The \f3javadoc\fR command provides a set of command-line options that can be used with any doclet\&. These options are described in Javadoc Options\&. The standard doclet provides an additional set of command-line options that are described in Standard Doclet Options\&. All option names are not case-sensitive, but their arguments are case-sensitive\&. +.TP 0.2i +\(bu +See also Javadoc Options +.TP 0.2i +\(bu +See also Standard Doclet Options +.PP +The options are: +.PP +-1\&.1 || -author || -bootclasspath classpathlist || -bottom text || -breakiterator || -charset name || -classpath classpathlist || -d directory || -docencoding name || -docfilesubdirs || -doclet class || -docletpath classpathlist || -doctitle title || -encoding || -exclude packagename1:packagename2:\&.\&.\&. || -excludedocfilessubdir name1:name2 || -extdirs dirist || -footer footer || -group groupheading packagepattern:packagepattern || -header header || -help || -helpfile path\efilename || -Jflag || -javafx ||-keywords || -link extdocURL || -linkoffline extdocURL packagelistLoc || -linksource || -locale language_country_variant || -nocomment || -nodeprecated || -nodeprecatedlist || -nohelp || -noindex || -nonavbar || -noqualifier all | packagename1:packagename2\&.\&.\&. || -nosince || -notimestamp || -notree || -overview path/filename || -package || -private || -protected || -public || -quiet || -serialwarn || -source release || -sourcepath sourcepathlist || -sourcetab tablength || -splitindex || -stylesheet path/filename || -subpackages package1:package2:\&.\&.\&. || -tag tagname:Xaoptcmf:"taghead" || -taglet class || -tagletpath tagletpathlist || -title title || -top || -use || -verbose || -version || -windowtitle title +.PP +The following options are the core Javadoc options that are available to all doclets\&. The standard doclet provides the rest of the doclets: \f3-bootclasspath\fR, \f3-breakiterator\fR, \f3-classpath\fR, \f3-doclet\fR, \f3-docletpath\fR, \f3-encoding\fR, -\f3exclude\fR, \f3-extdirs\fR, \f3-help\fR, \f3-locale\fR, \f3-\fR\f3overview\fR, \f3-package\fR, \f3-private\fR, \f3-protected\fR, \f3-public\fR, \f3-quiet\fR, \f3-source\fR, \f3-sourcepath\fR, \f3-subpackages\fR, and \f3-verbose\fR\&. +.SS JAVADOC\ OPTIONS +.TP +-overview \fIpath/filename\fR +.br +Specifies that the \f3javadoc\fR command should retrieve the text for the overview documentation from the source file specified by the \fIpath/filename\fRand place it on the Overview page (overview-summary\&.html)\&. The \fIpath/filename\fRis relative to the current directory\&. + +While you can use any name you want for the \f3filename\fR value and place it anywhere you want for the path, it is typical to name it overview\&.html and place it in the source tree at the directory that contains the topmost package directories\&. In this location, no path is needed when documenting packages, because the \f3-sourcepath\fR option points to this file\&. + +For example, if the source tree for the \f3java\&.lang\fR package is /src/classes/java/lang/, then you could place the overview file at /src/classes/overview\&.html + +See Real-World Examples\&. + +For information about the file specified by \fIpath/filename,\fRsee Overview Comment Files\&. + +The overview page is created only when you pass two or more package names to the \f3javadoc\fR command\&. For a further explanation, see HTML Frames\&. The title on the overview page is set by \f3-doctitle\fR\&. +.TP +-Xdoclint:(all|none|[-]\fI<group>\fR) +.br +Reports warnings for bad references, lack of accessibility and missing Javadoc comments, and reports errors for invalid Javadoc syntax and missing HTML tags\&. + +This option enables the \f3javadoc\fR command to check for all documentation comments included in the generated output\&. As always, you can select which items to include in the generated output with the standard options \f3-public\fR, \f3-protected\fR, \f3-package\fR and \f3-private\fR\&. + +When the \f3-Xdoclint\fR is enabled, it reports issues with messages similar to the \f3javac\fR command\&. The \f3javadoc\fR command prints a message, a copy of the source line, and a caret pointing at the exact position where the error was detected\&. Messages may be either warnings or errors, depending on their severity and the likelihood to cause an error if the generated documentation were run through a validator\&. For example, bad references or missing Javadoc comments do not cause the \f3javadoc\fR command to generate invalid HTML, so these issues are reported as warnings\&. Syntax errors or missing HTML end tags cause the \f3javadoc\fR command to generate invalid output, so these issues are reported as errors\&. + +By default, the \f3-Xdoclint\fR option is enabled\&. Disable it with the option \f3-Xdoclint:none\fR\&. + +Change what the \f3-Xdoclint\fR option reports with the following options: +.RS +.TP 0.2i +\(bu +\f3-Xdoclint none\fR : disable the \f3-Xdoclint\fR option +.TP 0.2i +\(bu +\f3-Xdoclint\fR\fIgroup\fR : enable \fIgroup\fR checks +.TP 0.2i +\(bu +\f3-Xdoclint all\fR : enable all groups of checks +.TP 0.2i +\(bu +\f3-Xdoclint all,\fR\fI-group\fR : enable all except \fIgroup\fR checks +.RE + + +The variable \fIgroup\fR has one of the following values: +.RS +.TP 0.2i +\(bu +\f3accessibility\fR : Checks for the issues to be detected by an accessibility checker (for example, no caption or summary attributes specified in a \f3<table>\fR tag)\&. +.TP 0.2i +\(bu +\f3html\fR : Detects high-level HTML issues, like putting block elements inside inline elements, or not closing elements that require an end tag\&. The rules are derived from theHTML 4\&.01 Specification\&. This type of check enables the \f3javadoc\fR command to detect HTML issues that many browsers might accept\&. +.TP 0.2i +\(bu +\f3missing\fR : Checks for missing Javadoc comments or tags (for example, a missing comment or class, or a missing \f3@return\fR tag or similar tag on a method)\&. +.TP 0.2i +\(bu +\f3reference\fR : Checks for issues relating to the references to Java API elements from Javadoc tags (for example, item not found in \f3@see\fR , or a bad name after \f3@param)\fR\&. +.TP 0.2i +\(bu +\f3syntax\fR : Checks for low level issues like unescaped angle brackets (\f3<\fR and \f3>\fR) and ampersands (\f3&\fR) and invalid Javadoc tags\&. +.RE + + +You can specify the \f3-Xdoclint\fR option multiple times to enable the option to check errors and warnings in multiple categories\&. Alternatively, you can specify multiple error and warning categories by using the preceding options\&. For example, use either of the following commands to check for the HTML, syntax, and accessibility issues in the file \fIfilename\fR\&. +.sp +.nf +\f3javadoc \-Xdoclint:html \-Xdoclint:syntax \-Xdoclint:accessibility \fIfilename\fR\fP +.fi +.nf +\f3javadoc \-Xdoclint:html,syntax,accessibility \fIfilename\fR\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fINote:\fR The \f3javadoc\fR command does not guarantee the completeness of these checks\&. In particular, it is not a full HTML compliance checker\&. The goal of the -\f3Xdoclint\fR option is to enable the \f3javadoc\fR command to report majority of common errors\&. + +The \f3javadoc\fR command does not attempt to fix invalid input, it just reports it\&. +.TP +-public +.br +Shows only public classes and members\&. +.TP +-protected +.br +Shows only protected and public classes and members\&. This is the default\&. +.TP +-package +.br +Shows only package, protected, and public classes and members\&. +.TP +-private +.br +Shows all classes and members\&. +.TP +-help +.br +Displays the online help, which lists all of the \f3javadoc\fR and \f3doclet\fR command-line options\&. +.TP +-doclet \fIclass\fR +.br +Specifies the class file that starts the doclet used in generating the documentation\&. Use the fully qualified name\&. This doclet defines the content and formats the output\&. If the \f3-doclet\fR option is not used, then the \f3javadoc\fR command uses the standard doclet for generating the default HTML format\&. This class must contain the \f3start(Root)\fR method\&. The path to this starting class is defined by the \f3-docletpath\fR option\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html +.TP +-docletpath \fIclasspathlist\fR +.br +Specifies the path to the doclet starting class file (specified with the \f3-doclet\fR option) and any JAR files it depends on\&. If the starting class file is in a JAR file, then this option specifies the path to that JAR file\&. You can specify an absolute path or a path relative to the current directory\&. If \f3classpathlist\fR contains multiple paths or JAR files, then they should be separated with a colon (:) on Oracle Solaris and a semi-colon (;) on Windows\&. This option is not necessary when the doclet starting class is already in the search path\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html +.TP +-1\&.1 +.br +Removed from Javadoc 1\&.4 with no replacement\&. This option created documentation with the appearance and functionality of documentation generated by Javadoc 1\&.1 (it never supported nested classes)\&. If you need this option, then use Javadoc 1\&.2 or 1\&.3 instead\&. +.TP +-source \fIrelease\fR +.br +Specifies the release of source code accepted\&. The following values for the \f3release\fR parameter are allowed\&. Use the value of \f3release\fR that corresponds to the value used when you compile code with the \f3javac\fR command\&. +.RS +.TP 0.2i +\(bu +\fIRelease Value: 1\&.5\fR\&. The \f3javadoc\fR command accepts code containing generics and other language features introduced in JDK 1\&.5\&. The compiler defaults to the 1\&.5 behavior when the \f3-source\fR option is not used\&. +.TP 0.2i +\(bu +\fIRelease Value: 1\&.4\fR\&. The \f3javadoc\fR command accepts code containing assertions, which were introduced in JDK 1\&.4\&. +.TP 0.2i +\(bu +\fIRelease Value: 1\&.3\fR\&. The \f3javadoc\fR command does not support assertions, generics, or other language features introduced after JDK 1\&.3\&. +.RE + +.TP +-sourcepath \fIsourcepathlist\fR +.br +Specifies the search paths for finding source files when passing package names or the \f3-subpackages\fR option into the \f3javadoc\fR command\&. Separate multiple paths with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. Note that this option is not only used to locate the source files being documented, but also to find source files that are not being documented, but whose comments are inherited by the source files being documented\&. + +You can use the \f3-sourcepath\fR option only when passing package names into the \f3javadoc\fR command\&. This will not locate source files passed into the \f3javadoc\fR command\&. To locate source files, \f3\fRchange to that directory or include the path ahead of each file, as shown at Document One or More Classes\&. If you omit \f3-sourcepath\fR, then the \f3javadoc\fR command uses the class path to find the source files (see \f3-classpath\fR)\&. The default \f3-sourcepath\fR is the value of class path\&. If \f3-classpath\fR is omitted and you pass package names into the \f3javadoc\fR command, then the \f3javadoc\fR command searches in the current directory and subdirectories for the source files\&. + +Set \f3sourcepathlist\fR to the root directory of the source tree for the package you are documenting\&. + +For example, suppose you want to document a package called \f3com\&.mypackage\fR, whose source files are located at:/home/user/src/com/mypackage/*\&.java\&. Specify the sourcepath to /home/user/src, the directory that contains com\emypackage, and then supply the package name, as follows: +.sp +.nf +\f3javadoc \-sourcepath /home/user/src/ com\&.mypackage\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Notice that if you concatenate the value of sourcepath and the package name together and change the dot to a slash (/), then you have the full path to the package: + +/home/user/src/com/mypackage + +To point to two source paths: +.sp +.nf +\f3javadoc \-sourcepath /home/user1/src:/home/user2/src com\&.mypackage\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-classpath \fIclasspathlist\fR +.br +Specifies the paths where the \f3javadoc\fR command searches for referenced classes These are the documented classes plus any classes referenced by those classes\&. Separate multiple paths with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. Follow the instructions in the class path documentation for specifying the \f3classpathlist\fR value\&. + +If you omit \f3-sourcepath\fR, then the \f3javadoc\fR command uses \f3-classpath\fR to find the source files and class files (for backward compatibility)\&. If you want to search for source and class files in separate paths, then use both \f3-sourcepath\fR and \f3-classpath\fR\&. + +For example, if you want to document \f3com\&.mypackage\fR, whose source files reside in the directory /home/user/src/com/mypackage, and if this package relies on a library in /home/user/lib, then you would use the following command: +.sp +.nf +\f3javadoc \-sourcepath /home/user/lib \-classpath /home/user/src com\&.mypackage\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Similar to other tools, if you do not specify \f3-classpath\fR, then the \f3javadoc\fR command uses the \f3CLASSPATH\fR environment variable when it is set\&. If both are not set, then the \f3javadoc\fR command searches for classes from the current directory\&. + +For an in-depth description of how the \f3javadoc\fR command uses \f3-classpath\fR to find user classes as it relates to extension classes and bootstrap classes, see How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html + +A class path element that contains a base name of * is considered equivalent to specifying a list of all the files in the directory with the extension \f3\&.jar\fR or \f3\&.JAR\fR\&. + +For example, if directory \f3mydir\fR contains \f3a\&.jar\fR and \f3b\&.JA\fRR, then the class path element \f3foo/*\fR is expanded to a \f3A\&.jar:b\&.JAR\fR, except that the order of JAR files is unspecified\&. All JAR files in the specified directory including hidden files are included in the list\&. A class path entry that consists of * expands to a list of all the jar files in the current directory\&. The \f3CLASSPATH\fR environment variable is similarly expanded\&. Any class path wildcard expansion occurs before the Java Virtual Machine (JVM) starts\&. No Java program ever sees unexpanded wild cards except by querying the environment, for example, by calling System\&.getenv(\f3"CLASSPATH"\fR)\&. +.TP +-subpackages \fIpackage1:package2:\&.\&.\&.\fR +.br +Generates documentation from source files in the specified packages and recursively in their subpackages\&. This option is useful when adding new subpackages to the source code because they are automatically included\&. Each package argument is any top-level subpackage (such as \f3java\fR) or fully qualified package (such as \f3javax\&.swing\fR) that does not need to contain source files\&. Arguments are separated by colons on all operating systems\&. Wild cards are not allowed\&. Use \f3-sourcepath\fR to specify where to find the packages\&. This option does not process source files that are in the source tree but do not belong to the packages\&. See Process Source Files\&. + +For example, the following command generates documentation for packages named \f3java\fR and \f3javax\&.swing\fR and all of their subpackages\&. +.sp +.nf +\f3javadoc \-d docs \-sourcepath /home/user/src \-subpackages java:javax\&.swing \fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-exclude \fIpackagename1:packagename2:\&.\&.\&.\fR +.br +Unconditionally excludes the specified packages and their subpackages from the list formed by \f3-subpackages\fR\&. It excludes those packages even when they would otherwise be included by some earlier or later \f3-subpackages\fR option\&. + +The following example would include \f3java\&.io\fR, \f3java\&.util\fR, and \f3java\&.math\fR (among others), but would exclude packages rooted at \f3java\&.net\fR and \f3java\&.lang\fR\&. Notice that this example excludes \f3java\&.lang\&.ref\fR, which is a subpackage of \f3java\&.lang\fR\&. +.sp +.nf +\f3javadoc \-sourcepath /home/user/src \-subpackages java \-exclude \fP +.fi +.nf +\f3 java\&.net:java\&.lang\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-bootclasspath \fIclasspathlist\fR +.br +Specifies the paths where the boot classes reside\&. These are typically the Java platform classes\&. The \f3bootclasspath\fR is part of the search path the \f3javadoc\fR command uses to look up source and class files\&. For more information, see How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html + +Separate directories in the \f3classpathlist\fR parameters with semicolons (;) for Windows and colons (:) for Oracle Solaris\&. +.TP +-extdirs \fIdirist\fR +.br +Specifies the directories where extension classes reside\&. These are any classes that use the Java Extension mechanism\&. The \f3extdirs\fR option is part of the search path the \f3javadoc\fR command uses to look up source and class files\&. See the \f3-classpath\fR option for more information\&. Separate directories in \f3dirlist\fR with semicolons (;) for Windows and colons (:) for Oracle Solaris\&. +.TP +-verbose +.br +Provides more detailed messages while the \f3javadoc\fR command runs\&. Without the \f3verbose\fR option, messages appear for loading the source files, generating the documentation (one message per source file), and sorting\&. The verbose option causes the printing of additional messages that specify the number of milliseconds to parse each Java source file\&. +.TP +-quiet +.br +Shuts off messages so that only the warnings and errors appear to make them easier to view\&. It also suppresses the \f3version\fR string\&. +.TP +-breakiterator +.br +Uses the internationalized sentence boundary of \f3java\&.text\&.BreakIterator\fR to determine the end of the first sentence in the main description of a package, class, or member for English\&. All other locales already use the \f3BreakIterator\fR class, rather than an English language, locale-specific algorithm\&. The first sentence is copied to the package, class, or member summary and to the alphabetic index\&. From JDK 1\&.2 and later, the \f3BreakIterator\fR class is used to determine the end of a sentence for all languages except for English\&. Therefore, the \f3-breakiterator\fR option has no effect except for English from 1\&.2 and later\&. English has its own default algorithm: +.RS +.TP 0.2i +\(bu +English default sentence-break algorithm\&. Stops at a period followed by a space or an HTML block tag, such as \f3<P>\fR\&. +.TP 0.2i +\(bu +Breakiterator sentence-break algorithm\&. Stops at a period, question mark, or exclamation point followed by a space when the next word starts with a capital letter\&. This is meant to handle most abbreviations (such as "The serial no\&. is valid", but will not handle "Mr\&. Smith")\&. The \f3-breakiterator\fR option does not stop at HTML tags or sentences that begin with numbers or symbols\&. The algorithm stops at the last period in \&.\&./filename, even when embedded in an HTML tag\&. +.RE + + +In Java SE 1\&.5 the \f3-breakiterator\fR option warning messages are removed, and the default sentence-break algorithm is unchanged\&. If you have not modified your source code to eliminate the \f3-breakiterator\fR option warnings in Java SE 1\&.4\&.x, then you do not have to do anything\&. The warnings go away starting with Java SE 1\&.5\&.0\&. +.TP +-locale \fIlanguage_country_variant\fR +.br +Specifies the locale that the \f3javadoc\fR command uses when it generates documentation\&. The argument is the name of the locale, as described in \f3j\fR\f3ava\&.util\&.Locale\fR documentation, such as \f3en_US\fR (English, United States) or \f3en_US_WIN\fR (Windows variant)\&. + +\fINote:\fR The \f3-locale\fR option must be placed ahead (to the left) of any options provided by the standard doclet or any other doclet\&. Otherwise, the navigation bars appear in English\&. This is the only command-line option that depends on order\&. See Standard Doclet Options\&. + +Specifying a locale causes the \f3javadoc\fR command to choose the resource files of that locale for messages such as strings in the navigation bar, headings for lists and tables, help file contents, comments in the stylesheet\&.css file, and so on\&. It also specifies the sorting order for lists sorted alphabetically, and the sentence separator to determine the end of the first sentence\&. The \f3-locale\fR option does not determine the locale of the documentation comment text specified in the source files of the documented classes\&. +.TP +-encoding +.br +Specifies the encoding name of the source files, such as \f3EUCJIS/SJIS\fR\&. If this option is not specified, then the platform default converter is used\&. See also the\f3-docencoding name\fR and \f3-charset name\fR options\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR directly to the Java Runtime Environment (JRE) that runs the \f3javadoc\fR command\&. For example, if you must ensure that the system sets aside 32 MB of memory in which to process the generated documentation, then you would call the \f3-Xmx\fR option as follows: \f3javadoc -J-Xmx32m -J-Xms32m com\&.mypackage\fR\&. Be aware that \f3-Xms\fR is optional because it only sets the size of initial memory, which is useful when you know the minimum amount of memory required\&. + +There is no space between the \f3J\fR and the \f3flag\fR\&. + +Use the \f3-version\fR option to find out what version of the \f3javadoc\fR command you are using\&. The version number of the standard doclet appears in its output stream\&. See Running the Javadoc Command\&. +.sp +.nf +\f3javadoc \-J\-version\fP +.fi +.nf +\f3java version "1\&.7\&.0_09"\fP +.fi +.nf +\f3Java(TM) SE Runtime Environment (build 1\&.7\&.0_09\-b05)\fP +.fi +.nf +\f3Java HotSpot(TM) 64\-Bit Server VM (build 23\&.5\-b02, mixed mode)\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-javafx +.br +Generates HTML documentation using the JavaFX extensions to the standard doclet\&. The generated documentation includes a Property Summary section in addition to the other summary sections generated by the standard Java doclet\&. The listed properties are linked to the sections for the getter and setter methods of each property\&. + +If there are no documentation comments written explicitly for getter and setter methods, the documentation comments from the property method are automatically copied to the generated documentation for these methods\&. This option also adds a new \f3@defaultValue\fR tag that allows documenting the default value for a property\&. + +Example: +.sp +.nf +\f3javadoc \-javafx MyClass\&.java \-d testdir\fP +.fi +.sp + +.SS STANDARD\ DOCLET\ OPTIONS +.TP +-d \fIdirectory\fR +.br +Specifies the destination directory where the \f3javadoc\fR command saves the generated HTML files\&. If you omit the \f3-d\fR option, then the files are saved to the current directory\&. The \f3directory\fR value can be absolute or relative to the current working directory\&. As of Java SE 1\&.4, the destination directory is automatically created when the \f3javadoc\fR command runs\&. + +For example, the following command generates the documentation for the package \f3com\&.mypackage\fR and saves the results in the /user/doc/ directory: \f3javadoc -d\fR\f3/user/doc/\fR\f3com\&.mypackage\fR\&. +.TP +-use +.br +Includes one Use page for each documented class and package\&. The page describes what packages, classes, methods, constructors and fields use any API of the specified class or package\&. Given class C, things that use class C would include subclasses of C, fields declared as C, methods that return C, and methods and constructors with parameters of type C\&. For example, you can look at the Use page for the \f3String\fR type\&. Because the \f3getName\fR method in the \f3java\&.awt\&.Font\fR class returns type \f3String\fR, the \f3getName\fR method uses \f3String\fR and so the \f3getName\fR method appears on the Use page for \f3String\fR\&.This documents only uses of the API, not the implementation\&. When a method uses \f3String\fR in its implementation, but does not take a string as an argument or return a string, that is not considered a use of \f3String\fR\&.To access the generated Use page, go to the class or package and click the \fIUse link\fR in the navigation bar\&. +.TP +-version +.br +Includes the @version text in the generated docs\&. This text is omitted by default\&. To find out what version of the \f3javadoc\fR command you are using, use the \f3-J-version\fR option\&. +.TP +-author +.br +Includes the \f3@author\fR text in the generated docs\&. +.TP +-splitindex +.br +Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical symbols\&. +.TP +-windowtitle \fItitle\fR +.br +Specifies the title to be placed in the HTML \f3<title>\fR tag\&. The text specified in the \f3title\fR tag appears in the window title and in any browser bookmarks (favorite places) that someone creates for this page\&. This title should not contain any HTML tags because the browser does not interpret them correctly\&. Use escape characters on any internal quotation marks within the \f3title\fR tag\&. If the \f3-windowtitle\fR option is omitted, then the \f3javadoc\fR command uses the value of the \f3-doctitle\fR option for the \f3-windowtitle\fR option\&. For example, \f3javadoc -windowtitle "Java SE Platform" com\&.mypackage\fR\&. +.TP +-doctitle \fItitle\fR +.br +Specifies the title to place near the top of the overview summary file\&. The text specified in the \f3title\fR tag is placed as a centered, level-one heading directly beneath the top navigation bar\&. The \f3title\fR tag can contain HTML tags and white space, but when it does, you must enclose the title in quotation marks\&. Internal quotation marks within the \f3title\fR tag must be escaped\&. For example, \f3javadoc -header "<b>Java Platform </b><br>v1\&.4" com\&.mypackage\&.\fR +.TP +-title \fItitle\fR +.br +No longer exists\&. It existed only in Beta releases of Javadoc 1\&.2\&. It was renamed to \f3-doctitle\fR\&. This option was renamed to make it clear that it defines the document title, rather than the window title\&. +.TP +-header \fIheader\fR +.br +Specifies the header text to be placed at the top of each output file\&. The header is placed to the right of the upper navigation bar\&. The \f3header\fR can contain HTML tags and white space, but when it does, the \f3header\fR must be enclosed in quotation marks\&. Use escape characters for internal quotation marks within a header\&. For example, \f3javadoc -header "<b>Java Platform </b><br>v1\&.4" com\&.mypackage\&.\fR +.TP +-footer \fIfooter\fR +.br +Specifies the footer text to be placed at the bottom of each output file\&. The \fIfooter\fR value is placed to the right of the lower navigation bar\&. The \f3footer\fR value can contain HTML tags and white space, but when it does, the \f3footer\fR value must be enclosed in quotation marks\&. Use escape characters for any internal quotation marks within a footer\&. +.TP +-top +.br +Specifies the text to be placed at the top of each output file\&. +.TP +-bottom \fItext\fR +.br +Specifies the text to be placed at the bottom of each output file\&. The text is placed at the bottom of the page, underneath the lower navigation bar\&. The text can contain HTML tags and white space, but when it does, the text must be enclosed in quotation marks\&. Use escape characters for any internal quotation marks within text\&. +.TP +-link \fIextdocURL\fR +.br +Creates links to existing Javadoc-generated documentation of externally referenced classes\&. The \fIextdocURL\fR argument is the absolute or relative URL of the directory that contains the external Javadoc-generated documentation you want to link to\&. You can specify multiple \f3-link\fR options in a specified \f3javadoc\fR command run to link to multiple documents\&. + +The package-list file must be found in this directory (otherwise, use the \f3-linkoffline\fR option)\&. The \f3javadoc\fR command reads the package names from the package-list file and links to those packages at that URL\&. When the \f3javadoc\fR command runs, the \f3extdocURL\fR value is copied into the \f3<A HREF>\fR links that are created\&. Therefore, \f3extdocURL\fR must be the URL to the directory, and not to a file\&. You can use an absolute link for \fIextdocURL\fR to enable your documents to link to a document on any web site, or you can use a relative link to link only to a relative location\&. If you use a relative link, then the value you pass in should be the relative path from the destination directory (specified with the \f3-d\fR option) to the directory containing the packages being linked to\&.When you specify an absolute link, you usually use an HTTP link\&. However, if you want to link to a file system that has no web server, then you can use a file link\&. Use a file link only when everyone who wants to access the generated documentation shares the same file system\&.In all cases, and on all operating systems, use a slash as the separator, whether the URL is absolute or relative, and \f3h\fR\f3ttp:\fR or \f3f\fR\f3ile:\fR as specified in the URL Memo: Uniform Resource Locators at http://www\&.ietf\&.org/rfc/rfc1738\&.txt +.sp +.nf +\f3\-link http://<host>/<directory>/<directory>/\&.\&.\&./<name>\fP +.fi +.nf +\f3\-link file://<host>/<directory>/<directory>/\&.\&.\&./<name>\fP +.fi +.nf +\f3\-link <directory>/<directory>/\&.\&.\&./<name>\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Differences between the -linkoffline and -link options + +Use the \f3-link\fR option in the following cases: +.TP 0.2i +\(bu +When you use a relative path to the external API document\&. +.TP 0.2i +\(bu +When you use an absolute URL to the external API document if your shell lets you open a connection to that URL for reading\&. +.PP +Use the \f3-linkoffline\fR option when you use an absolute URL to the external API document, if your shell does not allow a program to open a connection to that URL for reading\&. This can occur when you are behind a firewall and the document you want to link to is on the other side\&. +.PP +\f3Example 1 Absolute Link to External Documents\fR +.PP +Use the following command if you want to link to the \f3java\&.lang\fR, \f3java\&.io\fR and other Java platform packages, shown at http://docs\&.oracle\&.com/javase/8/docs/api/index\&.html +.sp +.nf +\f3javadoc \-link http://docs\&.oracle\&.com/javase/8/docs/api/ com\&.mypackage\fP +.fi +.nf +\f3\fP +.fi +.sp +The command generates documentation for the package \f3com\&.mypackage\fR with links to the Java SE packages\&. The generated documentation contains links to the \f3Object\fR class, for example, in the class \f3trees\fR\&. Other options, such as the \f3-sourcepath\fR and \f3-d\fR options, are not shown\&. +.PP +\f3Example 2 Relative Link to External Documents\fR +.PP +In this example, there are two packages with documents that are generated in different runs of the \f3javadoc\fR command, and those documents are separated by a relative path\&. The packages are \f3com\&.apipackage\fR, an API, and c\f3om\&.spipackage\fR, an Service Provide Interface (SPI)\&. You want the documentation to reside in docs/api/com/apipackage and docs/spi/com/spipackage\&. Assuming that the API package documentation is already generated, and that docs is the current directory, you document the SPI package with links to the API documentation by running: \f3javadoc -d \&./spi -link \&.\&./api com\&.spipackage\fR\&. +.PP +Notice the \f3-link\fR option is relative to the destination directory (docs/spi)\&. +.PP +Notes + +The \f3-link\fR option lets you link to classes referenced to by your code, but not documented in the current \f3javadoc\fR command run\&. For these links to go to valid pages, you must know where those HTML pages are located and specify that location with \f3extdocURL\fR\&. This allows third-party documentation to link to java\&.* documentation at http://docs\&.oracle\&.com\&.Omit the \f3-link\fR option when you want the \f3javadoc\fR command to create links only to APIs within the documentation it is generating in the current run\&. Without the \f3-link\fR option, the \f3javadoc\fR command does not create links to documentation for external references because it does not know whether or where that documentation exists\&.The \f3-link\fR option can create links in several places in the generated documentation\&. See Process Source Files\&. Another use is for cross-links between sets of packages: Execute the \f3javadoc\fR command on one set of packages, then run the \f3javadoc\fR command again on another set of packages, creating links both ways between both sets\&. +.PP +How to Reference a Class + +For a link to an externally referenced class to appear (and not just its text label), the class must be referenced in the following way\&. It is not sufficient for it to be referenced in the body of a method\&. It must be referenced in either an \f3import\fR statement or in a declaration\&. Here are examples of how the class \f3java\&.io\&.File\fR can be referenced: +.PP +\fI\fRIn any kind of import statement\&. By wildcard import, import explicitly by name, or automatically import for \f3java\&.lang\&.*\fR\&. +.PP +In Java SE 1\&.3\&.\fIn\fR and 1\&.2\&.\fIn\fR, only an explicit import by name works\&. A wildcard \f3import\fR statement does not work, nor does the automatic \f3import java\&.lang\&.*\fR\&. +.PP +\fI\fRIn a declaration: \f3void mymethod(File f) {}\fR +.PP +The reference can be in the return type or parameter type of a method, constructor, field, class, or interface, or in an implements, extends, or throws statement\&. +.PP +An important corollary is that when you use the \f3-link\fR option, there can be many links that unintentionally do not appear due to this constraint\&. The text would appear without being a link\&. You can detect these by the warnings they emit\&. The simplest way to properly reference a class and add the link would be to import that class\&. +.PP +Package List + +The \f3-link\fR option requires that a file named package-list, which is generated by the \f3javadoc\fR command, exists at the URL you specify with the \f3-link\fR option\&. The package-list file is a simple text file that lists the names of packages documented at that location\&. In the earlier example, the \f3javadoc\fR command searches for a file named package-list at the specified URL, reads in the package names, and links to those packages at that URL\&. +.PP +For example, the package list for the Java SE API is located at http://docs\&.oracle\&.com/javase/8/docs/api/package-list +.PP +The package list starts as follows: +.sp +.nf +\f3java\&.applet\fP +.fi +.nf +\f3java\&.awt\fP +.fi +.nf +\f3java\&.awt\&.color\fP +.fi +.nf +\f3java\&.awt\&.datatransfer\fP +.fi +.nf +\f3java\&.awt\&.dnd\fP +.fi +.nf +\f3java\&.awt\&.event\fP +.fi +.nf +\f3java\&.awt\&.font\fP +.fi +.nf +\f3and so on \&.\&.\&.\&.\fP +.fi +.nf +\f3\fP +.fi +.sp +When \f3javadoc\fR is run without the \f3-link\fR option and encounters a name that belongs to an externally referenced class, it prints the name with no link\&. However, when the \f3-link\fR option is used, the \f3javadoc\fR command searches the package-list file at the specified \fIextdocURL\fR location for that package name\&. When it finds the package name, it prefixes the name with \fIextdocURL\fR\&. +.PP +For there to be no broken links, all of the documentation for the external references must exist at the specified URLs\&. The \f3javadoc\fR command does not check that these pages exist, but only that the package-list exists\&. +.PP +Multiple Links + +You can supply multiple \f3-link\fR options to link to any number of externally generated documents\&. Javadoc 1\&.2 has a known bug that prevents you from supplying more than one \f3-link\fR options\&. This was fixed in Javadoc 1\&.2\&.2\&. Specify a different link option for each external document to link to \f3javadoc -link extdocURL1 -link extdocURL2 \&.\&.\&. -link extdocURLn com\&.mypackage\fR where \fIextdocURL1\fR, \fIextdocURL2\fR, \&.\f3\&.\&. extdocURLn\fR point respectively to the roots of external documents, each of which contains a file named package-list\&. +.PP +Cross Links + +Note that bootstrapping might be required when cross-linking two or more documents that were previously generated\&. If package-list does not exist for either document when you run the \f3javadoc\fR command on the first document, then the package-list does not yet exist for the second document\&. Therefore, to create the external links, you must regenerate the first document after you generate the second document\&. +.PP +In this case, the purpose of first generating a document is to create its package-list (or you can create it by hand if you are certain of the package names)\&. Then, generate the second document with its external links\&. The \f3javadoc\fR command prints a warning when a needed external package-list file does not exist\&. +.TP +-linkoffline \fIextdocURL packagelistLoc\fR +.br +This option is a variation of the \f3-link\fR option\&. They both create links to Javadoc-generated documentation for externally referenced classes\&. Use the \f3-link\fRo\f3ffline\fR option when linking to a document on the web when the \f3javadoc\fR command cannot access the document through a web connection\&. Use the \f3-linkoffline\fR option when package-list file of the external document is not accessible or does not exist at the \f3extdocURL\fR location, but does exist at a different location that can be specified by \f3packageListLoc\fR (typically local)\&. If \f3extdocURL\fR is accessible only on the World Wide Web, then the \f3-linkoffline\fR option removes the constraint that the \f3javadoc\fR command must have a web connection to generate documentation\&. Another use is as a work-around to update documents: After you have run the \f3javadoc\fR command on a full set of packages, you can run the \f3javadoc\fR command again on a smaller set of changed packages, so that the updated files can be inserted back into the original set\&. Examples follow\&. The \f3-linkoffline\fR option takes two arguments\&. The first is for the string to be embedded in the \f3<a href>\fR links, and the second tells the \f3-linkoffline\fR option where to find package-list: +.RS +.TP 0.2i +\(bu +The \f3extdocURL\fR value is the absolute or relative URL of the directory that contains the external Javadoc-generated documentation you want to link to\&. When relative, the value should be the relative path from the destination directory (specified with the \f3-d\fR option) to the root of the packages being linked to\&. For more information, see \fIextdocURL\fR in the \f3-link\fR option\&. +.TP 0.2i +\(bu +The \f3packagelistLoc\fR value is the path or URL to the directory that contains the package-list file for the external documentation\&. This can be a URL (http: or file:) or file path, and can be absolute or relative\&. When relative, make it relative to the current directory from where the \f3javadoc\fR command was run\&. Do not include the package-list file name\&. + +You can specify multiple \f3-linkoffline\fR options in a specified \f3javadoc\fR command run\&. Before Javadoc 1\&.2\&.2, the \f3-linkfile\fR options could be specified once\&. +.RE + +.PP +Absolute Links to External Documents + +You might have a situation where you want to link to the \f3java\&.lang\fR, \f3java\&.io\fR and other Java SE packages at http://docs\&.oracle\&.com/javase/8/docs/api/index\&.html +.PP +However, your shell does not have web access\&. In this case, do the following: +.TP 0.4i +1\&. +Open the package-list file in a browser at http://docs\&.oracle\&.com/javase/8/docs/api/package-list +.TP 0.4i +2\&. +Save the file to a local directory, and point to this local copy with the second argument, \f3packagelistLoc\fR\&. In this example, the package list file was saved to the current directory (\&.)\&. +.PP +The following command generates documentation for the package c\f3om\&.mypackage\fR with links to the Java SE packages\&. The generated documentation will contain links to the \f3Object\fR class, for example, in the class \f3trees\fR\&. Other necessary options, such as \f3-sourcepath\fR, are not shown\&. +.sp +.nf +\f3javadoc \-linkoffline http://docs\&.oracle\&.com/javase/8/docs/api/ \&. com\&.mypackage \fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Relative Links to External Documents + +It is not very common to use \f3-linkoffline\fR with relative paths, for the simple reason that the \f3-link\fR option is usually enough\&. When you use the \f3-linkoffline\fR option, the package-list file is usually local, and when you use relative links, the file you are linking to is also local, so it is usually unnecessary to give a different path for the two arguments to the \f3-linkoffline\fR option When the two arguments are identical, you can use the \f3-link\fR option\&. +.PP +Create a package-list File Manually + +If a package-list file does not exist yet, but you know what package names your document will link to, then you can manually create your own copy of this file and specify its path with \f3packagelistLoc\fR\&. An example would be the previous case where the package list for \f3com\&.spipackage\fR did not exist when \f3com\&.apipackage\fR was first generated\&. This technique is useful when you need to generate documentation that links to new external documentation whose package names you know, but which is not yet published\&. This is also a way of creating package-list files for packages generated with Javadoc 1\&.0 or 1\&.1, where package-list files were not generated\&. Similarly, two companies can share their unpublished package-list files so they can release their cross-linked documentation simultaneously\&. +.PP +Link to Multiple Documents + +You can include the \f3-linkoffline\fR option once for each generated document you want to refer to: +.sp +.nf +\f3javadoc \-linkoffline extdocURL1 packagelistLoc1 \-linkoffline extdocURL2\fP +.fi +.nf +\f3packagelistLoc2 \&.\&.\&.\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Update Documents + +You can also use the \f3-linkoffline\fR option when your project has dozens or hundreds of packages\&. If you have already run the \f3javadoc\fR command on the entire source tree, then you can quickly make small changes to documentation comments and rerun the \f3javadoc\fR command on a portion of the source tree\&. Be aware that the second run works properly only when your changes are to documentation comments and not to declarations\&. If you were to add, remove, or change any declarations from the source code, then broken links could show up in the index, package tree, inherited member lists, Use page, and other places\&. +.PP +First, create a new destination directory, such as update, for this new small run\&. In this example, the original destination directory is named html\&. In the simplest example, change directory to the parent of html\&. Set the first argument of the \f3-linkoffline\fR option to the current directory (\&.) and set the second argument to the relative path to html, where it can find package-list and pass in only the package names of the packages you want to update: +.sp +.nf +\f3javadoc \-d update \-linkoffline \&. html com\&.mypackage\fP +.fi +.nf +\f3\fP +.fi +.sp +When the \f3javadoc\fR command completes, copy these generated class pages in update/com/package (not the overview or index) to the original files in html/com/package\&. +.TP +-linksource +.br +Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation\&. Links are created for classes, interfaces, constructors, methods, and fields whose declarations are in a source file\&. Otherwise, links are not created, such as for default constructors and generated classes\&. + +This option exposes all private implementation details in the included source files, including private classes, private fields, and the bodies of private methods, regardless of the \f3-public\fR, \f3-package\fR, \f3-protected\fR, and \f3-private\fR options\&. Unless you also use the \f3-private\fR option, not all private classes or interfaces are accessible through links\&. + +Each link appears on the name of the identifier in its declaration\&. For example, the link to the source code of the \f3Button\fR class would be on the word \f3Button\fR: +.sp +.nf +\f3public class Button extends Component implements Accessible\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The link to the source code of the \f3getLabel\fR method in the \f3Button\fR class is on the word \f3getLabel\fR: +.sp +.nf +\f3public String getLabel()\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-group groupheading \fIpackagepattern:packagepattern\fR +.br +Separates packages on the overview page into whatever groups you specify, one group per table\&. You specify each group with a different \f3-group\fR option\&. The groups appear on the page in the order specified on the command line\&. Packages are alphabetized within a group\&. For a specified \f3-group\fR option, the packages matching the list of \f3packagepattern\fR expressions appear in a table with the heading \fIgroupheading\fR\&. +.RS +.TP 0.2i +\(bu +The \f3groupheading\fR can be any text and can include white space\&. This text is placed in the table heading for the group\&. +.TP 0.2i +\(bu +The \f3packagepattern\fR value can be any package name at the start of any package name followed by an asterisk (*)\&. The asterisk is the only wildcard allowed and means match any characters\&. Multiple patterns can be included in a group by separating them with colons (:)\&. If you use an asterisk in a pattern or pattern list, then the pattern list must be inside quotation marks, such as \f3"java\&.lang*:java\&.util"\fR\&. +.RE + + +When you do not supply a \f3-group\fR option, all packages are placed in one group with the heading \fIPackages\fR and appropriate subheadings\&. If the subheadings do not include all documented packages (all groups), then the remaining packages appear in a separate group with the subheading Other Packages\&. + +For example, the following \f3javadoc\fR command separates the three documented packages into \fICore\fR, \fIExtension\fR, and \fIOther Packages\fR\&. The trailing dot (\&.) does not appear in \f3java\&.lang*\fR\&. Including the dot, such as \f3java\&.lang\&.*\fR omits the\f3java\&.lang\fR package\&. +.sp +.nf +\f3javadoc \-group "Core Packages" "java\&.lang*:java\&.util"\fP +.fi +.nf +\f3 \-group "Extension Packages" "javax\&.*"\fP +.fi +.nf +\f3 java\&.lang java\&.lang\&.reflect java\&.util javax\&.servlet java\&.new\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fICore Packages\fR + +\f3java\&.lang\fR + +\f3java\&.lang\&.reflect\fR + +\f3java\&.util\fR + +\fIExtension Packages\fR + +\f3javax\&.servlet\fR + +\fIOther Packages\fR + +\f3java\&.new\fR +.TP +-nodeprecated +.br +Prevents the generation of any deprecated API in the documentation\&. This does what the \f3-nodeprecatedlist\fR option does, and it does not generate any deprecated API throughout the rest of the documentation\&. This is useful when writing code when you do not want to be distracted by the deprecated code\&. +.TP +-nodeprecatedlist +.br +Prevents the generation of the file that contains the list of deprecated APIs (deprecated-list\&.html) and the link in the navigation bar to that page\&. The \f3javadoc\fR command continues to generate the deprecated API throughout the rest of the document\&. This is useful when your source code contains no deprecated APIs, and you want to make the navigation bar cleaner\&. +.TP +-nosince +.br +Omits from the generated documents the \f3Since\fR sections associated with the \f3@since\fR tags\&. +.TP +-notree +.br +Omits the class/interface hierarchy pages from the generated documents\&. These are the pages you reach using the Tree button in the navigation bar\&. The hierarchy is produced by default\&. +.TP +-noindex +.br +Omits the index from the generated documents\&. The index is produced by default\&. +.TP +-nohelp +.br +Omits the HELP link in the navigation bars at the top and bottom of each page of output\&. +.TP +-nonavbar +.br +Prevents the generation of the navigation bar, header, and footer, that are usually found at the top and bottom of the generated pages\&. The \f3-nonavbar\fR option has no affect on the \f3-bottom\fR option\&. The \f3-nonavbar\fR option is useful when you are interested only in the content and have no need for navigation, such as when you are converting the files to PostScript or PDF for printing only\&. +.TP +-helpfile \fIpath\efilename\fR +.br +Specifies the path of an alternate help file path\efilename that the HELP link in the top and bottom navigation bars link to\&. Without this option, the \f3javadoc\fR command creates a help file help-doc\&.html that is hard-coded in the \f3javadoc\fR command\&. This option lets you override the default\&. The file name can be any name and is not restricted to help-doc\&.html\&. The \f3javadoc\fR command adjusts the links in the navigation bar accordingly, for example: +.sp +.nf +\f3javadoc \-helpfile /home/user/myhelp\&.html java\&.awt\&.\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-stylesheet \fIpath/filename\fR +.br +Specifies the path of an alternate HTML stylesheet file\&. Without this option, the \f3javadoc\fR command automatically creates a stylesheet file stylesheet\&.css that is hard-coded in the \f3javadoc\fR command\&. This option lets you override the default\&. The file name can be any name and is not restricted to stylesheet\&.css, for example: +.sp +.nf +\f3javadoc \-stylesheet file /home/user/mystylesheet\&.css com\&.mypackage\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-serialwarn +.br +Generates compile-time warnings for missing \f3@serial\fR tags\&. By default, Javadoc 1\&.2\&.2 and later versions generate no serial warnings\&. This is a reversal from earlier releases\&. Use this option to display the serial warnings, which helps to properly document default serializable fields and \f3writeExternal\fR methods\&. +.TP +-charset \fIname\fR +.br +Specifies the HTML character set for this document\&. The name should be a preferred MIME name as specified in the IANA Registry, Character Sets at http://www\&.iana\&.org/assignments/character-sets + +For example, \f3javadoc -charset "iso-8859-1" mypackage\fR inserts the following line in the head of every generated page: +.sp +.nf +\f3<META http\-equiv="Content\-Type" content="text/html; charset=ISO\-8859\-1">\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This \f3META\fR tag is described in the HTML standard (4197265 and 4137321), HTML Document Representation, at http://www\&.w3\&.org/TR/REC-html40/charset\&.html#h-5\&.2\&.2 + +See also the \f3-encoding\fR and \f3-docencoding name\fR options\&. +.TP +-docencoding \fIname\fR +.br +Specifies the encoding of the generated HTML files\&. The name should be a preferred MIME name as specified in the IANA Registry, Character Sets at http://www\&.iana\&.org/assignments/character-sets + +If you omit the \f3-docencoding\fR option but use the \f3-encoding\fR option, then the encoding of the generated HTML files is determined by the \f3-encoding\fR option, for example: \f3javadoc -docencoding "iso-8859-1" mypackage\fR\&. See also the \f3-encoding\fR and \f3-docencoding name\fR options\&. +.TP +-keywords +.br +Adds HTML keyword <META> tags to the generated file for each class\&. These tags can help search engines that look for <META> tags find the pages\&. Most search engines that search the entire Internet do not look at <META> tags, because pages can misuse them\&. Search engines offered by companies that confine their searches to their own website can benefit by looking at <META> tags\&. The <META> tags include the fully qualified name of the class and the unqualified names of the fields and methods\&. Constructors are not included because they are identical to the class name\&. For example, the class \f3String\fR starts with these keywords: +.sp +.nf +\f3<META NAME="keywords" CONTENT="java\&.lang\&.String class">\fP +.fi +.nf +\f3<META NAME="keywords" CONTENT="CASE_INSENSITIVE_ORDER">\fP +.fi +.nf +\f3<META NAME="keywords" CONTENT="length()">\fP +.fi +.nf +\f3<META NAME="keywords" CONTENT="charAt()">\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-tag \fItagname\fR:Xaoptcmf:"\fItaghead\fR" +.br +Enables the \f3javadoc\fR command to interpret a simple, one-argument \f3@tagname\fR custom block tag in documentation comments\&. For the \f3javadoc\fR command to spell-check tag names, it is important to include a \f3-tag\fR option for every custom tag that is present in the source code, disabling (with \f3X\fR) those that are not being output in the current run\&.The colon (:) is always the separator\&. The \f3-tag\fR option outputs the tag heading \fItaghead\fR in bold, followed on the next line by the text from its single argument\&. Similar to any block tag, the argument text can contain inline tags, which are also interpreted\&. The output is similar to standard one-argument tags, such as the \f3@return\fR and \f3@author\fR tags\&. Omitting a value for \fItaghead\fR causes \f3tagname\fR to be the heading\&. + +\fIPlacement of tags\fR: The \f3Xaoptcmf\fR arguments determine where in the source code the tag is allowed to be placed, and whether the tag can be disabled (using \f3X\fR)\&. You can supply either \f3a\fR, to allow the tag in all places, or any combination of the other letters: + +\f3X\fR (disable tag) + +\f3a\fR (all) + +\f3o\fR (overview) + +\f3p\fR (packages) + +\f3t\fR (types, that is classes and interfaces) + +\f3c\fR (constructors) + +\f3m\fR (methods) + +\f3f\fR (fields) + +\fIExamples of single tags\fR: An example of a tag option for a tag that can be used anywhere in the source code is: \f3-tag todo:a:"To Do:"\fR\&. + +If you want the \f3@todo\fR tag to be used only with constructors, methods, and fields, then you use: \f3-tag todo:cmf:"To Do:"\fR\&. + +Notice the last colon (:) is not a parameter separator, but is part of the heading text\&. You would use either tag option for source code that contains the \f3@todo\fR tag, such as: \f3@todo The documentation for this method needs work\fR\&. + +\fIColons in tag names\fR: Use a backslash to escape a colon that you want to use in a tag name\&. Use the \f3-tag ejb\e\e:bean:a:"EJB Bean:"\fR option for the following documentation comment: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @ejb:bean\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fISpell-checking tag names\fR: Some developers put custom tags in the source code that they do not always want to output\&. In these cases, it is important to list all tags that are in the source code, enabling the ones you want to output and disabling the ones you do not want to output\&. The presence of \f3X\fR disables the tag, while its absence enables the tag\&. This gives the \f3javadoc\fR command enough information to know whether a tag it encounters is unknown, which is probably the results of a typographical error or a misspelling\&. The \f3javadoc\fR command prints a warning in these cases\&. You can add \f3X\fR to the placement values already present, so that when you want to enable the tag, you can simply delete the \f3X\fR\&. For example, if the \f3@todo\fR tag is a tag that you want to suppress on output, then you would use: \f3-tag todo:Xcmf:"To Do:"\fR\&. If you would rather keep it simple, then use this: \f3-tag todo:X\fR\&. The syntax \f3-tag todo:X\fR works even when the \f3@todo\fR tag is defined by a taglet\&. + +\fIOrder of tags\fR: The order of the \f3-ta\fR\f3g\fR and \f3-taglet\fR options determines the order the tags are output\&. You can mix the custom tags with the standard tags to intersperse them\&. The tag options for standard tags are placeholders only for determining the order\&. They take only the standard tag\&'s name\&. Subheadings for standard tags cannot be altered\&. This is illustrated in the following example\&.If the \f3-tag\fR option is missing, then the position of the \f3-tagle\fR\f3t\fR option determines its order\&. If they are both present, then whichever appears last on the command line determines its order\&. This happens because the tags and taglets are processed in the order that they appear on the command line\&. For example, if the \f3-taglet\fR and \f3-tag\fR options have the name \f3todo\fR value, then the one that appears last on the command line determines the order\&. + +\fIExample of a complete set of tags\fR: This example inserts To Do after Parameters and before Throws in the output\&. By using \f3X\fR, it also specifies that the \f3@example\fR tag might be encountered in the source code that should not be output during this run\&. If you use the \f3@argfile\fR tag, then you can put the tags on separate lines in an argument file similar to this (no line continuation characters needed): +.sp +.nf +\f3\-tag param\fP +.fi +.nf +\f3\-tag return\fP +.fi +.nf +\f3\-tag todo:a:"To Do:"\fP +.fi +.nf +\f3\-tag throws\fP +.fi +.nf +\f3\-tag see\fP +.fi +.nf +\f3\-tag example:X\fP +.fi +.nf +\f3\fP +.fi +.sp + + +When the \f3javadoc\fR command parses the documentation comments, any tag encountered that is neither a standard tag nor passed in with the \f3-tag\fR or \f3-taglet\fR options is considered unknown, and a warning is thrown\&. + +The standard tags are initially stored internally in a list in their default order\&. Whenever the \f3-tag\fR options are used, those tags get appended to this list\&. Standard tags are moved from their default position\&. Therefore, if a \f3-tag\fR option is omitted for a standard tag, then it remains in its default position\&. + +\fIAvoiding conflicts\fR: If you want to create your own namespace, then you can use a dot-separated naming convention similar to that used for packages: \f3com\&.mycompany\&.todo\fR\&. Oracle will continue to create standard tags whose names do not contain dots\&. Any tag you create will override the behavior of a tag by the same name defined by Oracle\&. If you create a \f3@todo\fR tag or taglet, then it always has the same behavior you define, even when Oracle later creates a standard tag of the same name\&. + +\fIAnnotations vs\&. Javadoc tags\fR: In general, if the markup you want to add is intended to affect or produce documentation, then it should be a Javadoc tag\&. Otherwise, it should be an annotation\&. See Custom Tags and Annotations in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#annotations + +You can also create more complex block tags or custom inline tags with the \f3-taglet\fR option\&. +.TP +-taglet \fIclass\fR +.br +Specifies the class file that starts the taglet used in generating the documentation for that tag\&. Use the fully qualified name for the \f3class\fR value\&. This taglet also defines the number of text arguments that the custom tag has\&. The taglet accepts those arguments, processes them, and generates the output\&. For extensive documentation with example taglets, see: Taglet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/taglet/overview\&.html + +Taglets are useful for block or inline tags\&. They can have any number of arguments and implement custom behavior, such as making text bold, formatting bullets, writing out the text to a file, or starting other processes\&. Taglets can only determine where a tag should appear and in what form\&. All other decisions are made by the doclet\&. A taglet cannot do things such as remove a class name from the list of included classes\&. However, it can execute side effects, such as printing the tag\&'s text to a file or triggering another process\&. Use the \f3-tagletpath\fR option to specify the path to the taglet\&. The following example inserts the To Do taglet after Parameters and ahead of Throws in the generated pages\&. Alternately, you can use the \f3-taglet\fR option in place of its \f3-tag\fR option, but that might be difficult to read\&. +.sp +.nf +\f3\-taglet com\&.sun\&.tools\&.doclets\&.ToDoTaglet\fP +.fi +.nf +\f3\-tagletpath /home/taglets \fP +.fi +.nf +\f3\-tag return\fP +.fi +.nf +\f3\-tag param\fP +.fi +.nf +\f3\-tag todo\fP +.fi +.nf +\f3\-tag throws\fP +.fi +.nf +\f3\-tag see\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-tagletpath \fItagletpathlist\fR +.br +Specifies the search paths for finding taglet class files\&. The \f3tagletpathlist\fR can contain multiple paths by separating them with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. +.TP +-docfilesubdirs +.br +Enables deep copying of doc-files directories\&. Subdirectories and all contents are recursively copied to the destination\&. For example, the directory doc-files/example/images and all of its contents would be copied\&. There is also an option to exclude subdirectories\&. +.TP +-excludedocfilessubdir \fIname1:name2\fR +.br +Excludes any doc-files subdirectories with the specified names\&. This prevents the copying of SCCS and other source-code-control subdirectories\&. +.TP +-noqualifier all | \fIpackagename1\fR:\fIpackagename2\&.\&.\&.\fR +.br +Omits qualifying package names from class names in output\&. The argument to the \f3-noqualifier\fR option is either \f3all\fR (all package qualifiers are omitted) or a colon-separate list of packages, with wild cards, to be removed as qualifiers\&. The package name is removed from places where class or interface names appear\&. See Process Source Files\&. + +The following example omits all package qualifiers: \f3-noqualifier all\fR\&. + +The following example omits \f3java\&.lang\fR and \f3java\&.io\fR package qualifiers: \f3-noqualifier java\&.lang:java\&.io\fR\&. + +The following example omits package qualifiers starting with \f3java\fR, and \f3com\&.sun\fR subpackages, but not \f3javax\fR: \f3-noqualifier java\&.*:com\&.sun\&.*\fR\&. + +Where a package qualifier would appear due to the previous behavior, the name can be suitably shortened\&. See How a Name Appears\&. This rule is in effect whether or not the \f3-noqualifier\fR option is used\&. +.TP +-notimestamp +.br +Suppresses the time stamp, which is hidden in an HTML comment in the generated HTML near the top of each page\&. The \f3-notimestamp\fR option is useful when you want to run the \f3javadoc\fR command on two source bases and get the differences between \f3diff\fR them, because it prevents time stamps from causing a \f3diff\fR (which would otherwise be a \f3diff\fR on every page)\&. The time stamp includes the \f3javadoc\fR command release number, and currently appears similar to this: \f3<!-- Generated by javadoc (build 1\&.5\&.0_01) on Thu Apr 02 14:04:52 IST 2009 -->\fR\&. +.TP +-nocomment +.br +Suppresses the entire comment body, including the main description and all tags, and generate only declarations\&. This option lets you reuse source files that were originally intended for a different purpose so that you can produce skeleton HTML documentation at the early stages of a new project\&. +.TP +-sourcetab \fItablength\fR +.br +Specifies the number of spaces each tab uses in the source\&. +.SH COMMAND-LINE\ ARGUMENT\ FILES +To shorten or simplify the \f3javadoc\fR command, you can specify one or more files that contain arguments to the \f3javadoc\fR command (except \f3-J\fR options)\&. This enables you to create \f3javadoc\fR commands of any length on any operating system\&. +.PP +An argument file can include \f3javac\fR options and source file names in any combination\&. The arguments within a file can be space-separated or newline-separated\&. If a file name contains embedded spaces, then put the whole file name in double quotation marks\&. +.PP +File Names within an argument file are relative to the current directory, not the location of the argument file\&. Wild cards (\f3*\fR) are not allowed in these lists (such as for specifying *\&.java)\&. Using the at sign (@) to recursively interpret files is not supported\&. The \f3-J\fR options are not supported because they are passed to the launcher, which does not support argument files\&. +.PP +When you run the \f3javadoc\fR command, pass in the path and name of each argument file with the @ leading character\&. When the \f3javadoc\fR command encounters an argument beginning with the at sign (@), it expands the contents of that file into the argument list\&. +.PP +\f3Example 1 Single Argument File\fR +.PP +You could use a single argument file named \f3argfile\fR to hold all \f3javadoc\fR command arguments: \f3javadoc @argfile\fR\&. The argument file \f3\fRcontains the contents of both files, as shown in the next example\&. +.PP +\f3Example 2 Two Argument Files\fR +.PP +You can create two argument files: One for the \f3javadoc\fR command options and the other for the package names or source file names\&. Notice the following lists have no line-continuation characters\&. +.PP +Create a file named options that contains: +.sp +.nf +\f3\-d docs\-filelist \fP +.fi +.nf +\f3\-use \fP +.fi +.nf +\f3\-splitindex\fP +.fi +.nf +\f3\-windowtitle \&'Java SE 7 API Specification\&'\fP +.fi +.nf +\f3\-doctitle \&'Java SE 7 API Specification\&'\fP +.fi +.nf +\f3\-header \&'<b>Java\(tm SE 7</b>\&'\fP +.fi +.nf +\f3\-bottom \&'Copyright © 1993\-2011 Oracle and/or its affiliates\&. All rights reserved\&.\&'\fP +.fi +.nf +\f3\-group "Core Packages" "java\&.*"\fP +.fi +.nf +\f3\-overview /java/pubs/ws/1\&.7\&.0/src/share/classes/overview\-core\&.html\fP +.fi +.nf +\f3\-sourcepath /java/pubs/ws/1\&.7\&.0/src/share/classes\fP +.fi +.nf +\f3\fP +.fi +.sp +Create a file named packages that contains: +.sp +.nf +\f3com\&.mypackage1\fP +.fi +.nf +\f3com\&.mypackage2\fP +.fi +.nf +\f3com\&.mypackage3\fP +.fi +.nf +\f3\fP +.fi +.sp +Run the \f3javadoc\fR command as follows: +.sp +.nf +\f3javadoc @options @packages\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 3 Argument Files with Paths\fR +.PP +The argument files can have paths, but any file names inside the files are relative to the current working directory (not \f3path1\fR or \f3path2\fR): +.sp +.nf +\f3javadoc @path1/options @path2/packages\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 4 Option Arguments\fR +.PP +The following example saves an argument to a \f3javadoc\fR command option in an argument file\&. The \f3-bottom\fR option is used because it can have a lengthy argument\&. You could create a file named bottom to contain the text argument: +.sp +.nf +\f3<font size="\-1">\fP +.fi +.nf +\f3 <a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP +.fi +.nf +\f3 Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&. <br/>\fP +.fi +.nf +\f3 Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP +.fi +.nf +\f3 Other names may be trademarks of their respective owners\&.</font>\fP +.fi +.nf +\f3\fP +.fi +.sp +Run the \f3javadoc\fR command as follows:\f3javadoc -bottom @bottom @packages\fR\&. +.PP +You can also include the \f3-bottom\fR option at the start of the argument file and run the \f3javadoc\fR command as follows: \f3javadoc @bottom @packages\fR\&. +.SH RUNNING\ THE\ JAVADOC\ COMMAND +The release number of the \f3javadoc\fR command can be determined with the \f3javadoc -J-version\fR option\&. The release number of the standard doclet appears in the output stream\&. It can be turned off with the \f3-quiet\fR option\&. +.PP +Use the public programmatic interface to call the \f3javadoc\fR command from within programs written in the Java language\&. This interface is in \f3com\&.sun\&.tools\&.javadoc\&.Main\fR (and the \f3javadoc\fR command is reentrant)\&. For more information, see The Standard Doclet at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/standard-doclet\&.html#runningprogrammatically +.PP +The following instructions call the standard HTML doclet\&. To call a custom doclet, use the \f3-doclet\fR and \f3-docletpath\fR options\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html +.SS SIMPLE\ EXAMPLES +You can run the \f3javadoc\fR command on entire packages or individual source files\&. Each package name has a corresponding directory name\&. +.PP +In the following examples, the source files are located at /home/src/java/awt/*\&.java\&. The destination directory is /home/html\&. +.PP +Document One or More Packages + +To document a package, the source files for that package must be located in a directory that has the same name as the package\&. +.PP +If a package name has several identifiers (separated by dots, such as \f3java\&.awt\&.color\fR), then each subsequent identifier must correspond to a deeper subdirectory (such as java/awt/color)\&. +.PP +You can split the source files for a single package among two such directory trees located at different places, as long as \f3-sourcepath\fR points to them both\&. For example, src1/java/awt/color and src2/java/awt/color\&. +.PP +You can run the \f3javadoc\fR command either by changing directories (with the \f3cd\fR command) or by using the \f3-sourcepath\fR option\&. The following examples illustrate both alternatives\&. +.PP +\f3Example 1 Recursive Run from One or More Packages\fR +.PP +This example uses \f3-sourcepath\fR so the \f3javadoc\fR command can be run from any directory and \f3-subpackages\fR (a new 1\&.4 option) for recursion\&. It traverses the subpackages of the java directory excluding packages rooted at \f3java\&.net\fR and \f3java\&.lang\fR\&. Notice this excludes \f3java\&.lang\&.ref\fR, a subpackage of \f3java\&.lang\fR\&. To also traverse down other package trees, append their names to the \f3-subpackages\fR argument, such as \f3java:javax:org\&.xml\&.sax\fR\&. +.sp +.nf +\f3javadoc \-d /home/html \-sourcepath /home/src \-subpackages java \-exclude\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 2 Change to Root and Run Explicit Packages\fR +.PP +Change to the parent directory of the fully qualified package\&. Then, run the \f3javadoc\fR command with the names of one or more packages that you want to document: +.sp +.nf +\f3cd /home/src/\fP +.fi +.nf +\f3javadoc \-d /home/html java\&.awt java\&.awt\&.event\fP +.fi +.nf +\f3\fP +.fi +.sp +To also traverse down other package trees, append their names to the \f3-subpackages\fR argument, such as j\f3ava:javax:org\&.xml\&.sax\fR\&. +.PP +\f3Example 3 Run from Any Directory on Explicit Packages in One Tree\fR +.PP +In this case, it does not matter what the current directory is\&. Run the \f3javadoc\fR command and use the \f3-sourcepath\fR option with the parent directory of the top-level package\&. Provide the names of one or more packages that you want to document: +.sp +.nf +\f3javadoc \-d /home/html \-sourcepath /home/src java\&.awt java\&.awt\&.event\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 4 Run from Any Directory on Explicit Packages in Multiple Trees\fR +.PP +Run the \f3javadoc\fR command and use the \f3-sourcepath\fR option with a colon-separated list of the paths to each tree\&'s root\&. Provide the names of one or more packages that you want to document\&. All source files for a specified package do not need to be located under a single root directory, but they must be found somewhere along the source path\&. +.sp +.nf +\f3javadoc \-d /home/html \-sourcepath /home/src1:/home/src2 java\&.awt java\&.awt\&.event\fP +.fi +.nf +\f3\fP +.fi +.sp +The result is that all cases generate HTML-formatted documentation for the \f3public\fR and \f3protected\fR classes and interfaces in packages j\f3ava\&.awt\fR and \f3java\&.awt\&.even\fRt and save the HTML files in the specified destination directory\&. Because two or more packages are being generated, the document has three HTML frames: one for the list of packages, another for the list of classes, and the third for the main class pages\&. +.PP +Document One or More Classes + +The second way to run the \f3javadoc\fR command is to pass one or more source files\&. You can run \f3javadoc\fR either of the following two ways: by changing directories (with the \f3cd\fR command) or by fully specifying the path to the source files\&. Relative paths are relative to the current directory\&. The \f3-sourcepath\fR option is ignored when passing source files\&. You can use command-line wild cards, such as an asterisk (*), to specify groups of classes\&. +.PP +\f3Example 1 Change to the Source Directory\fR +.PP +Change to the directory that holds the source files\&. Then run the \f3javadoc\fR command with the names of one or more source files you want to document\&. +.PP +This example generates HTML-formatted documentation for the classes \f3Button\fR, \f3Canvas,\fR and classes that begin with \f3Graphics\fR\&. Because source files rather than package names were passed in as arguments to the \f3javadoc\fR command, the document has two frames: one for the list of classes and the other for the main page\&. +.sp +.nf +\f3cd /home/src/java/awt\fP +.fi +.nf +\f3javadoc \-d /home/html Button\&.java Canvas\&.java Graphics*\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 2 Change to the Root Directory of the Package\fR +.PP +This is useful for documenting individual source files from different subpackages off of the same root\&. Change to the package root directory, and supply the source files with paths from the root\&. +.sp +.nf +\f3cd /home/src/\fP +.fi +.nf +\f3javadoc \-d /home/html java/awt/Button\&.java java/applet/Applet\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 3 Document Files from Any Directory\fR +.PP +In this case, it does not matter what the current directory is\&. Run the \f3javadoc\fR command with the absolute path (or path relative to the current directory) to the source files you want to document\&. +.sp +.nf +\f3javadoc \-d /home/html /home/src/java/awt/Button\&.java\fP +.fi +.nf +\f3/home/src/java/awt/Graphics*\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Document Packages and Classes + +You can document entire packages and individual classes at the same time\&. Here is an example that mixes two of the previous examples\&. You can use the \f3-sourcepath\fR option for the path to the packages but not for the path to the individual classes\&. +.sp +.nf +\f3javadoc \-d /home/html \-sourcepath /home/src java\&.awt\fP +.fi +.nf +\f3/home/src/java/applet/Applet\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS REAL-WORLD\ EXAMPLES +The following command-line and \f3makefile\fR versions of the \f3javadoc\fR command run on the Java platform APIs\&. It uses 180 MB of memory to generate the documentation for the 1500 (approximately) public and protected classes in the Java SE 1\&.2\&. Both examples use absolute paths in the option arguments, so that the same \f3javadoc\fR command can be run from any directory\&. +.PP +Command-Line Example + +The following command might be too long for some shells\&. You can use a command-line argument file (or write a shell script) to overcome this limitation\&. +.PP +In the example, \f3packages\fR is the name of a file that contains the packages to process, such as \f3java\&.applet\fR\f3java\&.lang\fR\&. None of the options should contain any newline characters between the single quotation marks\&. For example, if you copy and paste this example, then delete the newline characters from the \f3-bottom\fR option\&. +.sp +.nf +\f3javadoc \-sourcepath /java/jdk/src/share/classes \e\fP +.fi +.nf +\f3\-overview /java/jdk/src/share/classes/overview\&.html \e\fP +.fi +.nf +\f3\-d /java/jdk/build/api \e\fP +.fi +.nf +\f3\-use \e\fP +.fi +.nf +\f3\-splitIndex \e\fP +.fi +.nf +\f3\-windowtitle \&'Java Platform, Standard Edition 7 API Specification\&' \e\fP +.fi +.nf +\f3\-doctitle \&'Java Platform, Standard Edition 7 API Specification\&' \e\fP +.fi +.nf +\f3\-header \&'<b>Java\(tm SE 7</b>\&' \e\fP +.fi +.nf +\f3\-bottom \&'<font size="\-1">\fP +.fi +.nf +\f3<a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP +.fi +.nf +\f3Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&.<br/>\fP +.fi +.nf +\f3Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP +.fi +.nf +\f3Other names may be trademarks of their respective owners\&.</font>\&' \e\fP +.fi +.nf +\f3\-group "Core Packages" "java\&.*:com\&.sun\&.java\&.*:org\&.omg\&.*" \e\fP +.fi +.nf +\f3\-group "Extension Packages" "javax\&.*" \e\fP +.fi +.nf +\f3\-J\-Xmx180m \e \fP +.fi +.nf +\f3@packages\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Programmatic Interface + +The Javadoc Access API enables the user to invoke the Javadoc tool directly from a Java application without executing a new process\&. +.PP +For example, the following statements are equivalent to the command \f3javadoc -d /home/html -sourcepath /home/src -subpackages java -exclude java\&.net:java\&.lang com\&.example\fR: +.sp +.nf +\f3import javax\&.tools\&.DocumentationTool;\fP +.fi +.nf +\f3import javax\&.tools\&.ToolProvider;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class JavaAccessSample{\fP +.fi +.nf +\f3 public static void main(String[] args){\fP +.fi +.nf +\f3 DocumentationTool javadoc = ToolProvider\&.getSystemDocumentationTool();\fP +.fi +.nf +\f3 int rc = javadoc\&.run( null, null, null,\fP +.fi +.nf +\f3 "\-d", "/home/html",\fP +.fi +.nf +\f3 "\-sourcepath", "home/src",\fP +.fi +.nf +\f3 "\-subpackages", "java",\fP +.fi +.nf +\f3 "\-exclude", "java\&.net:java\&.lang",\fP +.fi +.nf +\f3 "com\&.example");\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.sp +The first three arguments of the \f3run\fR method specify input, standard output, and standard error streams\&. \f3Null\fR is the default value for \f3System\&.in\fR, \f3System\&.out\fR, and \f3System\&.err\fR, respectively\&. +.SS THE\ MAKEFILE\ EXAMPLE +This is an example of a GNU \f3makefile\fR\&. Single quotation marks surround \f3makefile\fR arguments\&. For an example of a Windows \f3makefile\fR, see the \f3makefiles\fR section of the Javadoc FAQ at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137483\&.html#makefiles +.sp +.nf +\f3javadoc \-sourcepath $(SRCDIR) \e /* Sets path for source files */\fP +.fi +.nf +\f3 \-overview $(SRCDIR)/overview\&.html \e /* Sets file for overview text */\fP +.fi +.nf +\f3 \-d /java/jdk/build/api \e /* Sets destination directory */\fP +.fi +.nf +\f3 \-use \e /* Adds "Use" files */\fP +.fi +.nf +\f3 \-splitIndex \e /* Splits index A\-Z */\fP +.fi +.nf +\f3 \-windowtitle $(WINDOWTITLE) \e /* Adds a window title */\fP +.fi +.nf +\f3 \-doctitle $(DOCTITLE) \e /* Adds a doc title */\fP +.fi +.nf +\f3 \-header $(HEADER) \e /* Adds running header text */\fP +.fi +.nf +\f3 \-bottom $(BOTTOM) \e /* Adds text at bottom */\fP +.fi +.nf +\f3 \-group $(GROUPCORE) \e /* 1st subhead on overview page */\fP +.fi +.nf +\f3 \-group $(GROUPEXT) \e /* 2nd subhead on overview page */\fP +.fi +.nf +\f3 \-J\-Xmx180m \e /* Sets memory to 180MB */\fP +.fi +.nf +\f3 java\&.lang java\&.lang\&.reflect \e /* Sets packages to document */\fP +.fi +.nf +\f3 java\&.util java\&.io java\&.net \e\fP +.fi +.nf +\f3 java\&.applet\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3WINDOWTITLE = \&'Java\(tm SE 7 API Specification\&'\fP +.fi +.nf +\f3DOCTITLE = \&'Java\(tm Platform Standard Edition 7 API Specification\&'\fP +.fi +.nf +\f3HEADER = \&'<b>Java\(tm SE 7</font>\&'\fP +.fi +.nf +\f3BOTTOM = \&'<font size="\-1">\fP +.fi +.nf +\f3 <a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP +.fi +.nf +\f3 Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&.<br/>\fP +.fi +.nf +\f3 Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP +.fi +.nf +\f3 Other names may be trademarks of their respective owners\&.</font>\&'\fP +.fi +.nf +\f3GROUPCORE = \&'"Core Packages" "java\&.*:com\&.sun\&.java\&.*:org\&.omg\&.*"\&'\fP +.fi +.nf +\f3GROUPEXT = \&'"Extension Packages" "javax\&.*"\&'\fP +.fi +.nf +\f3SRCDIR = \&'/java/jdk/1\&.7\&.0/src/share/classes\&'\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS NOTES +.TP 0.2i +\(bu +If you omit the \f3-windowtitle\fR option, then the \f3javadoc\fR command copies the document title to the window title\&. The \f3-windowtitle\fR option text is similar to the the \f3-doctitle\fR option, but without HTML tags to prevent those tags from appearing as raw text in the window title\&. +.TP 0.2i +\(bu +If you omit the \f3-footer\fR option, then the \f3javadoc\fR command copies the header text to the footer\&. +.TP 0.2i +\(bu +Other important options you might want to use, but were not needed in the previous example, are the \f3-classpath\fR and \f3-link\fR options\&. +.SH GENERAL\ TROUBLESHOOTING +.TP 0.2i +\(bu +The \f3javadoc\fR command reads only files that contain valid class names\&. If the \f3javadoc\fR command is not correctly reading the contents of a file, then verify that the class names are valid\&. See Process Source Files\&. +.TP 0.2i +\(bu +See the Javadoc FAQ for information about common bugs and for troubleshooting tips at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137483\&.html +.SH ERRORS\ AND\ WARNINGS +Error and warning messages contain the file name and line number to the declaration line rather than to the particular line in the documentation comment\&. +.PP +For example, this message \f3error: cannot read: Class1\&.java\fR means that the \f3javadoc\fR command is trying to load \f3Class1\&.jav\fR\f3a\fR in the current directory\&. The class name is shown with its path (absolute or relative)\&. +.SH ENVIRONMENT +.TP +CLASSPATH +\f3CLASSPATH\fR is the environment variable that provides the path that the \f3javadoc\fR command uses to find user class files\&. This environment variable is overridden by the \f3-classpath\fR option\&. Separate directories with a semicolon for Windows or a colon for Oracle Solaris\&. + +\fIWindows example\fR: \f3\&.;C:\eclasses;C:\ehome\ejava\eclasses\fR + +\fIOracle Solaris example\fR: \f3\&.:/home/classes:/usr/local/java/classes\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +javac(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jdb(1) +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +javap(1) +.SH RELATED\ DOCUMENTS +.TP 0.2i +\(bu +Javadoc Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/index\&.html +.TP 0.2i +\(bu +How Classes Are Found http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html +.TP 0.2i +\(bu +How to Write Doc Comments for the Javadoc Tool http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html +.TP 0.2i +\(bu +URL Memo, Uniform Resource Locators http://www\&.ietf\&.org/rfc/rfc1738\&.txt +.TP 0.2i +\(bu +HTML standard, HTML Document Representation (4197265 and 4137321) http://www\&.w3\&.org/TR/REC-html40/charset\&.html#h-5\&.2\&.2 +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/javah.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/javah.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,158 +1,158 @@ -'\" t -.\" Copyright (c) 1994, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Basic Tools -.\" Title: javah.1 -.\" -.if n .pl 99999 -.TH javah 1 "21 November 2013" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -javah \- Generates C header and source files from a Java class\&. -.SH SYNOPSIS -.sp -.nf - -\fBjavah\fR [ \fIoptions\fR ] f\fIully\-qualified\-class\-name \&.\&.\&.\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIfully-qualified-class-name\fR -The fully qualified location of the classes to be converted to C header and source files\&. -.SH DESCRIPTION -The \f3javah\fR command 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 \f3\&.h\fR file contains a \f3struct\fR definition with a layout that parallels the layout of the corresponding class\&. The fields in the \f3struct\fR correspond to instance variables in the class\&. -.PP -The name of the header file and the structure declared within it are derived from the name of the class\&. When the class passed to the \f3javah\fR command is inside a package, the package name is added to the beginning of both the header file name and the structure name\&. Underscores (_) are used as name delimiters\&. -.PP -By default the \f3javah\fR command creates a header file for each class listed on the command line and puts the files in the current directory\&. Use the \f3-stubs\fR option to create source files\&. Use the \f3-o\fR option to concatenate the results for all listed classes into a single file\&. -.PP -The Java Native Interface (JNI) does not require header information or stub files\&. The \f3javah\fR command can still be used to generate native method function prototypes needed for JNI-style native methods\&. The \f3javah\fR command produces JNI-style output by default and places the result in the \f3\&.h\fR file\&. -.SH OPTIONS -.TP --o \fIoutputfile\fR -.br -Concatenates the resulting header or source files for all the classes listed on the command line into an output file\&. Only one of \f3-o\fR or \f3-d\fR can be used\&. -.TP --d \fIdirectory\fR -.br -Sets the directory where the \f3javah\fR command saves the header files or the stub files\&. Only one of \f3-d\fR or \f3-o\fR can be used\&. -.TP --stubs -.br -Causes the \f3javah\fR command to generate C declarations from the Java object file\&. -.TP --verbose -.br -Indicates verbose output and causes the \f3javah\fR command to print a message to \f3stdout\fR about the status of the generated files\&. -.TP --help -.br -Prints a help message for \f3javah\fR usage\&. -.TP --version -.br -Prints \f3javah\fR command release information\&. -.TP --jni -.br -Causes the \f3javah\fR command to create an output file containing JNI-style native method function prototypes\&. This is the default output; use of \f3-jni\fR is optional\&. -.TP --classpath \fIpath\fR -.br -Specifies the path the \f3javah\fR command uses to look up classes\&. Overrides the default or the \f3CLASSPATH\fR environment variable when it is set\&. Directories are separated by colons on Oracle Solaris and semicolons on Windows\&. The general format for path is: - -\fIOracle Solaris\fR: - -\&.:\fIyour-path\fR - -Example: \f3\&.:/home/avh/classes:/usr/local/java/classes\fR - -\fIWindows\fR: - -\&.;\fIyour-path\fR - -Example: \f3\&.;C:\eusers\edac\eclasses;C:\etools\ejava\eclasses\fR - -As a special convenience, a class path element that contains a base name of * is considered equivalent to specifying a list of all the files in the directory with the extension \f3\&.jar\fR or \f3\&.JAR\fR\&. - -For example, if directory \f3mydir\fR contains \f3a\&.jar\fR and \f3b\&.JAR\fR, then the class path element \f3mydir/*\fR is expanded to a \f3A\fR\f3\&.jar:b\&.JAR\fR, except that the order of jar files is unspecified\&. All JAR files in the specified directory, including hidden ones, are included in the list\&. A class path entry that consists of * expands to a list of all the JAR files in the current directory\&. The \f3CLASSPATH\fR environment variable, where defined, is similarly expanded\&. Any class path wild card expansion occurs before the Java Virtual Machine (JVM) is started\&. A Java program will never see unexpanded wild cards except by querying the environment\&. For example, by calling \f3System\&.getenv("CLASSPATH")\fR\&. -.TP --bootclasspath \fIpath\fR -.br -Specifies the path from which to load bootstrap classes\&. By default, the bootstrap classes are the classes that implement the core Java platform located in \f3jre\elib\ert\&.jar\fR and several other JAR files\&. -.TP --old -.br -Specifies that old JDK 1\&.0-style header files should be generated\&. -.TP --force -.br -Specifies that output files should always be written\&. -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -javah(1) -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -jdb(1) -.TP 0.2i -\(bu -javap(1) -.TP 0.2i -\(bu -javadoc(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1994, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: javah.1 +.\" +.if n .pl 99999 +.TH javah 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +javah \- Generates C header and source files from a Java class\&. +.SH SYNOPSIS +.sp +.nf + +\fBjavah\fR [ \fIoptions\fR ] f\fIully\-qualified\-class\-name \&.\&.\&.\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIfully-qualified-class-name\fR +The fully qualified location of the classes to be converted to C header and source files\&. +.SH DESCRIPTION +The \f3javah\fR command 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 \f3\&.h\fR file contains a \f3struct\fR definition with a layout that parallels the layout of the corresponding class\&. The fields in the \f3struct\fR correspond to instance variables in the class\&. +.PP +The name of the header file and the structure declared within it are derived from the name of the class\&. When the class passed to the \f3javah\fR command is inside a package, the package name is added to the beginning of both the header file name and the structure name\&. Underscores (_) are used as name delimiters\&. +.PP +By default the \f3javah\fR command creates a header file for each class listed on the command line and puts the files in the current directory\&. Use the \f3-stubs\fR option to create source files\&. Use the \f3-o\fR option to concatenate the results for all listed classes into a single file\&. +.PP +The Java Native Interface (JNI) does not require header information or stub files\&. The \f3javah\fR command can still be used to generate native method function prototypes needed for JNI-style native methods\&. The \f3javah\fR command produces JNI-style output by default and places the result in the \f3\&.h\fR file\&. +.SH OPTIONS +.TP +-o \fIoutputfile\fR +.br +Concatenates the resulting header or source files for all the classes listed on the command line into an output file\&. Only one of \f3-o\fR or \f3-d\fR can be used\&. +.TP +-d \fIdirectory\fR +.br +Sets the directory where the \f3javah\fR command saves the header files or the stub files\&. Only one of \f3-d\fR or \f3-o\fR can be used\&. +.TP +-stubs +.br +Causes the \f3javah\fR command to generate C declarations from the Java object file\&. +.TP +-verbose +.br +Indicates verbose output and causes the \f3javah\fR command to print a message to \f3stdout\fR about the status of the generated files\&. +.TP +-help +.br +Prints a help message for \f3javah\fR usage\&. +.TP +-version +.br +Prints \f3javah\fR command release information\&. +.TP +-jni +.br +Causes the \f3javah\fR command to create an output file containing JNI-style native method function prototypes\&. This is the default output; use of \f3-jni\fR is optional\&. +.TP +-classpath \fIpath\fR +.br +Specifies the path the \f3javah\fR command uses to look up classes\&. Overrides the default or the \f3CLASSPATH\fR environment variable when it is set\&. Directories are separated by colons on Oracle Solaris and semicolons on Windows\&. The general format for path is: + +\fIOracle Solaris\fR: + +\&.:\fIyour-path\fR + +Example: \f3\&.:/home/avh/classes:/usr/local/java/classes\fR + +\fIWindows\fR: + +\&.;\fIyour-path\fR + +Example: \f3\&.;C:\eusers\edac\eclasses;C:\etools\ejava\eclasses\fR + +As a special convenience, a class path element that contains a base name of * is considered equivalent to specifying a list of all the files in the directory with the extension \f3\&.jar\fR or \f3\&.JAR\fR\&. + +For example, if directory \f3mydir\fR contains \f3a\&.jar\fR and \f3b\&.JAR\fR, then the class path element \f3mydir/*\fR is expanded to a \f3A\fR\f3\&.jar:b\&.JAR\fR, except that the order of jar files is unspecified\&. All JAR files in the specified directory, including hidden ones, are included in the list\&. A class path entry that consists of * expands to a list of all the JAR files in the current directory\&. The \f3CLASSPATH\fR environment variable, where defined, is similarly expanded\&. Any class path wild card expansion occurs before the Java Virtual Machine (JVM) is started\&. A Java program will never see unexpanded wild cards except by querying the environment\&. For example, by calling \f3System\&.getenv("CLASSPATH")\fR\&. +.TP +-bootclasspath \fIpath\fR +.br +Specifies the path from which to load bootstrap classes\&. By default, the bootstrap classes are the classes that implement the core Java platform located in \f3jre\elib\ert\&.jar\fR and several other JAR files\&. +.TP +-old +.br +Specifies that old JDK 1\&.0-style header files should be generated\&. +.TP +-force +.br +Specifies that output files should always be written\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jdb(1) +.TP 0.2i +\(bu +javap(1) +.TP 0.2i +\(bu +javadoc(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/javap.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/javap.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/bsd/doc/man/jcmd.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/jcmd.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/bsd/doc/man/jconsole.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/jconsole.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,112 +1,112 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java Troubleshooting, Profiling, Monitoring and Management Tools -.\" Title: jconsole.1 -.\" -.if n .pl 99999 -.TH jconsole 1 "21 November 2013" "JDK 8" "Java Troubleshooting, Profiling, Monitoring and Management Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jconsole \- Starts a graphical console that lets you monitor and manage Java applications\&. -.SH SYNOPSIS -.sp -.nf - -\fBjconsole\fR [ \fIoptions\fR ] [ connection \&.\&.\&. ] -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -connection = \fIpid\fR | \fIhost\fR:\fIport\fR | \fIjmxURL\fR -The \f3pid\fR value is the process ID of a local Java Virtual Machine (JVM)\&. The JVM must be running with the same user ID as the user ID running the \f3jconsole\fR command\&.The \f3host:port\fR values are the name of the host system on which the JVM is running, and the port number specified by the system property \f3com\&.sun\&.management\&.jmxremote\&.port\fR when the JVM was started\&.The \f3jmxUrl\fR value is the address of the JMX agent to be connected to as described in JMXServiceURL\&. - -For more information about the \f3connection\fR parameter, see Monitoring and Management Using JMX Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/agent\&.html - -See also the \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html -.SH DESCRIPTION -The \f3jconsole\fR command starts a graphical console tool that lets you monitor and manage Java applications and virtual machines on a local or remote machine\&. -.PP -On Windows, the \f3jconsole\fR command does not associate with a console window\&. It does, however, display a dialog box with error information when the \f3jconsole\fR command fails\&. -.SH OPTIONS -.TP --interval\fI=n\fR -.br -Sets the update interval to \fIn\fR seconds (default is 4 seconds)\&. -.TP --notile -.br -Does not tile windows initially (for two or more connections)\&. -.TP --pluginpath \fIplugins\fR -.br -Specifies a list of directories or JAR files to be searched for \f3JConsole\fR plug-ins\&. The \fIplugins\fR path should contain a provider-configuration file named \f3META-INF/services/com\&.sun\&.tools\&.jconsole\&.JConsolePlugin\fR that contains one line for each plug-in\&. The line specifies the fully qualified class name of the class implementing the \f3com\&.sun\&.tools\&.jconsole\&.JConsolePlugin\fR class\&. -.TP --version -.br -Displays release information and exits\&. -.TP --help -.br -Displays a help message\&. -.TP --J\fIflag\fR -.br -Passes \f3flag\fR to the JVM on which the \f3jconsole\fR command is run\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -Using JConsole at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/jconsole\&.html -.TP 0.2i -\(bu -Monitoring and Management Using JMX Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/agent\&.html -.TP 0.2i -\(bu -The \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Troubleshooting, Profiling, Monitoring and Management Tools +.\" Title: jconsole.1 +.\" +.if n .pl 99999 +.TH jconsole 1 "21 November 2013" "JDK 8" "Java Troubleshooting, Profiling, Monitoring and Management Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jconsole \- Starts a graphical console that lets you monitor and manage Java applications\&. +.SH SYNOPSIS +.sp +.nf + +\fBjconsole\fR [ \fIoptions\fR ] [ connection \&.\&.\&. ] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +connection = \fIpid\fR | \fIhost\fR:\fIport\fR | \fIjmxURL\fR +The \f3pid\fR value is the process ID of a local Java Virtual Machine (JVM)\&. The JVM must be running with the same user ID as the user ID running the \f3jconsole\fR command\&.The \f3host:port\fR values are the name of the host system on which the JVM is running, and the port number specified by the system property \f3com\&.sun\&.management\&.jmxremote\&.port\fR when the JVM was started\&.The \f3jmxUrl\fR value is the address of the JMX agent to be connected to as described in JMXServiceURL\&. + +For more information about the \f3connection\fR parameter, see Monitoring and Management Using JMX Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/agent\&.html + +See also the \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html +.SH DESCRIPTION +The \f3jconsole\fR command starts a graphical console tool that lets you monitor and manage Java applications and virtual machines on a local or remote machine\&. +.PP +On Windows, the \f3jconsole\fR command does not associate with a console window\&. It does, however, display a dialog box with error information when the \f3jconsole\fR command fails\&. +.SH OPTIONS +.TP +-interval\fI=n\fR +.br +Sets the update interval to \fIn\fR seconds (default is 4 seconds)\&. +.TP +-notile +.br +Does not tile windows initially (for two or more connections)\&. +.TP +-pluginpath \fIplugins\fR +.br +Specifies a list of directories or JAR files to be searched for \f3JConsole\fR plug-ins\&. The \fIplugins\fR path should contain a provider-configuration file named \f3META-INF/services/com\&.sun\&.tools\&.jconsole\&.JConsolePlugin\fR that contains one line for each plug-in\&. The line specifies the fully qualified class name of the class implementing the \f3com\&.sun\&.tools\&.jconsole\&.JConsolePlugin\fR class\&. +.TP +-version +.br +Displays release information and exits\&. +.TP +-help +.br +Displays a help message\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR to the JVM on which the \f3jconsole\fR command is run\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +Using JConsole at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/jconsole\&.html +.TP 0.2i +\(bu +Monitoring and Management Using JMX Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/agent\&.html +.TP 0.2i +\(bu +The \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/jdb.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/jdb.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,270 +1,270 @@ -'\" t -.\" Copyright (c) 1995, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Basic Tools -.\" Title: jdb.1 -.\" -.if n .pl 99999 -.TH jdb 1 "21 November 2013" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jdb \- Finds and fixes bugs in Java platform programs\&. -.SH SYNOPSIS -.sp -.nf - -\fBjdb\fR [\fIoptions\fR] [\fIclassname\fR] [\fIarguments\fR] -.fi -.sp -.TP -\fIoptions\fR -Command-line options\&. See Options\&. -.TP -\fIclass\fRname -Name of the main class to debug\&. -.TP -\fIarguments\fR -Arguments passed to the \f3main()\fR method of the class\&. -.SH DESCRIPTION -The Java Debugger (JDB) is a simple command-line debugger for Java classes\&. The \f3jdb\fR command and its options call the JDB\&. The \f3jdb\fR command demonstrates the Java Platform Debugger Architecture (JDBA) and provides inspection and debugging of a local or remote Java Virtual Machine (JVM)\&. See Java Platform Debugger Architecture (JDBA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/jpda/index\&.html -.SS START\ A\ JDB\ SESSION -There are many ways to start a JDB session\&. The most frequently used way is to have JDB launch a new JVM with the main class of the application to be debugged\&. Do this by substituting the \f3jdb\fR command for the \f3java\fR command in the command line\&. For example, if your application\&'s main class is \f3MyClass\fR, then use the following command to debug it under JDB: -.sp -.nf -\f3jdb MyClass\fP -.fi -.nf -\f3\fP -.fi -.sp -When started this way, the \f3jdb\fR command calls a second JVM with the specified parameters, loads the specified class, and stops the JVM before executing that class\&'s first instruction\&. -.PP -Another way to use the \f3jdb\fR command is by attaching it to a JVM that is already running\&. Syntax for starting a JVM to which the \f3jdb\fR command attaches when the JVM is running is as follows\&. This loads in-process debugging libraries and specifies the kind of connection to be made\&. -.sp -.nf -\f3java \-agentlib:jdwp=transport=dt_socket,server=y,suspend=n MyClass\fP -.fi -.nf -\f3\fP -.fi -.sp -You can then attach the \f3jdb\fR command to the JVM with the following command: -.sp -.nf -\f3jdb \-attach 8000\fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3MyClass\fR argument is not specified in the \f3jdb\fR command line in this case because the \f3jdb\fR command is connecting to an existing JVM instead of launching a new JVM\&. -.PP -There are many other ways to connect the debugger to a JVM, and all of them are supported by the \f3jdb\fR command\&. The Java Platform Debugger Architecture has additional documentation on these connection options\&. -.SS BASIC\ JDB\ COMMANDS -The following is a list of the basic \f3jdb\fR commands\&. The JDB supports other commands that you can list with the \f3-help\fR option\&. -.TP -help or ? -The \f3help\fR or \f3?\fR commands display the list of recognized commands with a brief description\&. -.TP -run -After you start JDB and set breakpoints, you can use the \f3run\fR command to execute the debugged application\&. The \f3run\fR command is available only when the \f3jdb\fR command starts the debugged application as opposed to attaching to an existing JVM\&. -.TP -cont -Continues execution of the debugged application after a breakpoint, exception, or step\&. -.TP -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 dump command to find out how to get more information about an object\&. - -\fINote:\fR To display local variables, the containing class must have been compiled with the \f3javac -g\fR option\&. - -The \f3print\fR command supports many simple Java expressions including those with method invocations, for example: -.sp -.nf -\f3print MyClass\&.myStaticField\fP -.fi -.nf -\f3print myObj\&.myInstanceField\fP -.fi -.nf -\f3print i + j + k (i, j, k are primities and either fields or local variables)\fP -.fi -.nf -\f3print myObj\&.myMethod() (if myMethod returns a non\-null)\fP -.fi -.nf -\f3print new java\&.lang\&.String("Hello")\&.length()\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -dump -For primitive values, the \f3dump\fR command is identical to the \f3print\fR command\&. For objects, the \f3dump\fR command prints the current value of each field defined in the object\&. Static and instance fields are included\&. The \f3dump\fR command supports the same set of expressions as the \f3print\fR command\&. -.TP -threads -List the threads that are currently running\&. For each thread, its name and current status are printed and an index that can be used in other commands\&. In this example, the thread index is 4, the thread is an instance of \f3java\&.lang\&.Thread\fR, the thread name is \f3main\fR, and it is currently running\&. -.sp -.nf -\f34\&. (java\&.lang\&.Thread)0x1 main running\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -thread -Select a thread to be the current thread\&. Many \f3jdb\fR commands are based on the setting of the current thread\&. The thread is specified with the thread index described in the threads command\&. -.TP -where -The \f3where\fR command with no arguments dumps the stack of the current thread\&. The \f3where\fR\f3all\fR command dumps the stack of all threads in the current thread group\&. The \f3where\fR\f3threadindex\fR command dumps the stack of the specified thread\&. - -If the current thread is suspended either through an event such as a breakpoint or through the \f3suspend\fR command, then local variables and fields can be displayed with the \f3print\fR and \f3dump\fR commands\&. The \f3up\fR and \f3down\fR commands select which stack frame is the current stack frame\&. -.SS BREAKPOINTS -Breakpoints can be set in JDB at line numbers or at the first instruction of a method, for example: -.TP 0.2i -\(bu -The command \f3stop at MyClass:22\fR sets a breakpoint at the first instruction for line 22 of the source file containing \f3MyClass\fR\&. -.TP 0.2i -\(bu -The command \f3stop in java\&.lang\&.String\&.length\fR sets a breakpoint at the beginning of the method \f3java\&.lang\&.String\&.length\fR\&. -.TP 0.2i -\(bu -The command \f3stop in MyClass\&.<clinit>\fR uses \f3<clinit>\fR to identify the static initialization code for \f3MyClass\fR\&. -.PP -When a method is overloaded, you must also specify its argument types so that the proper method can be selected for a breakpoint\&. For example, \f3MyClass\&.myMethod(int,java\&.lang\&.String)\fR or \f3MyClass\&.myMethod()\fR\&. -.PP -The \f3clear\fR command removes breakpoints using the following syntax: \f3clear MyClass:45\fR\&. Using the \f3clear\fR or \f3stop\fR command with no argument displays a list of all breakpoints currently set\&. The \f3cont\fR command continues execution\&. -.SS STEPPING -The \f3step\fR command advances execution to the next line whether it is in the current stack frame or a called method\&. The \f3next\fR command advances execution to the next line in the current stack frame\&. -.SS EXCEPTIONS -When an exception occurs for which there is not a \f3catch\fR statement anywhere in the throwing thread\&'s call stack, the JVM typically prints an exception trace and exits\&. When running under JDB, however, control returns to JDB at the offending throw\&. You can then use the \f3jdb\fR command to diagnose the cause of the exception\&. -.PP -Use the \f3catch\fR command to cause the debugged application to stop at other thrown exceptions, for example: \f3catch java\&.io\&.FileNotFoundException\fR or \f3catch\fR\f3mypackage\&.BigTroubleException\fR\&. Any exception that is an instance of the specified class or subclass stops the application at the point where it is thrown\&. -.PP -The \f3ignore\fR command negates the effect of an earlier \f3catch\fR command\&. The \f3ignore\fR command does not cause the debugged JVM to ignore specific exceptions, but only to ignore the debugger\&. -.SH OPTIONS -When you use the \f3jdb\fR command instead of the \f3java\fR command on the command line, the \f3jdb\fR command accepts many of the same options as the \f3java\fR command, including \f3-D\fR, \f3-classpath\fR, and \f3-X\fR options\&. The following list contains additional options that are accepted by the \f3jdb\fR command\&. -.PP -Other options are supported to provide alternate mechanisms for connecting the debugger to the JVM it is to debug\&. For additional documentation about these connection alternatives, see Java Platform Debugger Architecture (JPDA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/jpda/index\&.html -.TP --help -.br -Displays a help message\&. -.TP --sourcepath \fIdir1:dir2: \&. \&. \&.\fR -.br -Uses the specified path to search for source files in the specified path\&. If this option is not specified, then use the default path of dot (\&.)\&. -.TP --attach \fIaddress\fR -.br -Attaches the debugger to a running JVM with the default connection mechanism\&. -.TP --listen \fIaddress\fR -.br -Waits for a running JVM to connect to the specified address with a standard connector\&. -.TP --launch -.br -Starts the debugged application immediately upon startup of JDB\&. The \f3-launch\fR option removes the need for the \f3run\fR command\&. The debugged application is launched and then stopped just before the initial application class is loaded\&. At that point, you can set any necessary breakpoints and use the \f3cont\fR command to continue execution\&. -.TP --listconnectors -.br -List the connectors available in this JVM\&. -.TP --connect connector-name:\fIname1=value1\fR -.br -Connects to the target JVM with the named connector and listed argument values\&. -.TP --dbgtrace [\fIflags\fR] -.br -Prints information for debugging the \f3jdb\fR command\&. -.TP --tclient -.br -Runs the application in the Java HotSpot VM client\&. -.TP --tserver -.br -Runs the application in the Java HotSpot VM server\&. -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the JVM, where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH OPTIONS\ FORWARDED\ TO\ THE\ DEBUGGER\ PROCESS -.TP --v -verbose[:\fIclass\fR|gc|jni] -.br -Turns on verbose mode\&. -.TP --D\fIname\fR=\fIvalue\fR -.br -Sets a system property\&. -.TP --classpath \fIdir\fR -.br -Lists directories separated by colons in which to look for classes\&. -.TP --X\fIoption\fR -.br -Nonstandard target JVM option\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -javac(1) -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -javah(1) -.TP 0.2i -\(bu -javap(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1995, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: jdb.1 +.\" +.if n .pl 99999 +.TH jdb 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jdb \- Finds and fixes bugs in Java platform programs\&. +.SH SYNOPSIS +.sp +.nf + +\fBjdb\fR [\fIoptions\fR] [\fIclassname\fR] [\fIarguments\fR] +.fi +.sp +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.TP +\fIclass\fRname +Name of the main class to debug\&. +.TP +\fIarguments\fR +Arguments passed to the \f3main()\fR method of the class\&. +.SH DESCRIPTION +The Java Debugger (JDB) is a simple command-line debugger for Java classes\&. The \f3jdb\fR command and its options call the JDB\&. The \f3jdb\fR command demonstrates the Java Platform Debugger Architecture (JDBA) and provides inspection and debugging of a local or remote Java Virtual Machine (JVM)\&. See Java Platform Debugger Architecture (JDBA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/jpda/index\&.html +.SS START\ A\ JDB\ SESSION +There are many ways to start a JDB session\&. The most frequently used way is to have JDB launch a new JVM with the main class of the application to be debugged\&. Do this by substituting the \f3jdb\fR command for the \f3java\fR command in the command line\&. For example, if your application\&'s main class is \f3MyClass\fR, then use the following command to debug it under JDB: +.sp +.nf +\f3jdb MyClass\fP +.fi +.nf +\f3\fP +.fi +.sp +When started this way, the \f3jdb\fR command calls a second JVM with the specified parameters, loads the specified class, and stops the JVM before executing that class\&'s first instruction\&. +.PP +Another way to use the \f3jdb\fR command is by attaching it to a JVM that is already running\&. Syntax for starting a JVM to which the \f3jdb\fR command attaches when the JVM is running is as follows\&. This loads in-process debugging libraries and specifies the kind of connection to be made\&. +.sp +.nf +\f3java \-agentlib:jdwp=transport=dt_socket,server=y,suspend=n MyClass\fP +.fi +.nf +\f3\fP +.fi +.sp +You can then attach the \f3jdb\fR command to the JVM with the following command: +.sp +.nf +\f3jdb \-attach 8000\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3MyClass\fR argument is not specified in the \f3jdb\fR command line in this case because the \f3jdb\fR command is connecting to an existing JVM instead of launching a new JVM\&. +.PP +There are many other ways to connect the debugger to a JVM, and all of them are supported by the \f3jdb\fR command\&. The Java Platform Debugger Architecture has additional documentation on these connection options\&. +.SS BASIC\ JDB\ COMMANDS +The following is a list of the basic \f3jdb\fR commands\&. The JDB supports other commands that you can list with the \f3-help\fR option\&. +.TP +help or ? +The \f3help\fR or \f3?\fR commands display the list of recognized commands with a brief description\&. +.TP +run +After you start JDB and set breakpoints, you can use the \f3run\fR command to execute the debugged application\&. The \f3run\fR command is available only when the \f3jdb\fR command starts the debugged application as opposed to attaching to an existing JVM\&. +.TP +cont +Continues execution of the debugged application after a breakpoint, exception, or step\&. +.TP +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 dump command to find out how to get more information about an object\&. + +\fINote:\fR To display local variables, the containing class must have been compiled with the \f3javac -g\fR option\&. + +The \f3print\fR command supports many simple Java expressions including those with method invocations, for example: +.sp +.nf +\f3print MyClass\&.myStaticField\fP +.fi +.nf +\f3print myObj\&.myInstanceField\fP +.fi +.nf +\f3print i + j + k (i, j, k are primities and either fields or local variables)\fP +.fi +.nf +\f3print myObj\&.myMethod() (if myMethod returns a non\-null)\fP +.fi +.nf +\f3print new java\&.lang\&.String("Hello")\&.length()\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +dump +For primitive values, the \f3dump\fR command is identical to the \f3print\fR command\&. For objects, the \f3dump\fR command prints the current value of each field defined in the object\&. Static and instance fields are included\&. The \f3dump\fR command supports the same set of expressions as the \f3print\fR command\&. +.TP +threads +List the threads that are currently running\&. For each thread, its name and current status are printed and an index that can be used in other commands\&. In this example, the thread index is 4, the thread is an instance of \f3java\&.lang\&.Thread\fR, the thread name is \f3main\fR, and it is currently running\&. +.sp +.nf +\f34\&. (java\&.lang\&.Thread)0x1 main running\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +thread +Select a thread to be the current thread\&. Many \f3jdb\fR commands are based on the setting of the current thread\&. The thread is specified with the thread index described in the threads command\&. +.TP +where +The \f3where\fR command with no arguments dumps the stack of the current thread\&. The \f3where\fR\f3all\fR command dumps the stack of all threads in the current thread group\&. The \f3where\fR\f3threadindex\fR command dumps the stack of the specified thread\&. + +If the current thread is suspended either through an event such as a breakpoint or through the \f3suspend\fR command, then local variables and fields can be displayed with the \f3print\fR and \f3dump\fR commands\&. The \f3up\fR and \f3down\fR commands select which stack frame is the current stack frame\&. +.SS BREAKPOINTS +Breakpoints can be set in JDB at line numbers or at the first instruction of a method, for example: +.TP 0.2i +\(bu +The command \f3stop at MyClass:22\fR sets a breakpoint at the first instruction for line 22 of the source file containing \f3MyClass\fR\&. +.TP 0.2i +\(bu +The command \f3stop in java\&.lang\&.String\&.length\fR sets a breakpoint at the beginning of the method \f3java\&.lang\&.String\&.length\fR\&. +.TP 0.2i +\(bu +The command \f3stop in MyClass\&.<clinit>\fR uses \f3<clinit>\fR to identify the static initialization code for \f3MyClass\fR\&. +.PP +When a method is overloaded, you must also specify its argument types so that the proper method can be selected for a breakpoint\&. For example, \f3MyClass\&.myMethod(int,java\&.lang\&.String)\fR or \f3MyClass\&.myMethod()\fR\&. +.PP +The \f3clear\fR command removes breakpoints using the following syntax: \f3clear MyClass:45\fR\&. Using the \f3clear\fR or \f3stop\fR command with no argument displays a list of all breakpoints currently set\&. The \f3cont\fR command continues execution\&. +.SS STEPPING +The \f3step\fR command advances execution to the next line whether it is in the current stack frame or a called method\&. The \f3next\fR command advances execution to the next line in the current stack frame\&. +.SS EXCEPTIONS +When an exception occurs for which there is not a \f3catch\fR statement anywhere in the throwing thread\&'s call stack, the JVM typically prints an exception trace and exits\&. When running under JDB, however, control returns to JDB at the offending throw\&. You can then use the \f3jdb\fR command to diagnose the cause of the exception\&. +.PP +Use the \f3catch\fR command to cause the debugged application to stop at other thrown exceptions, for example: \f3catch java\&.io\&.FileNotFoundException\fR or \f3catch\fR\f3mypackage\&.BigTroubleException\fR\&. Any exception that is an instance of the specified class or subclass stops the application at the point where it is thrown\&. +.PP +The \f3ignore\fR command negates the effect of an earlier \f3catch\fR command\&. The \f3ignore\fR command does not cause the debugged JVM to ignore specific exceptions, but only to ignore the debugger\&. +.SH OPTIONS +When you use the \f3jdb\fR command instead of the \f3java\fR command on the command line, the \f3jdb\fR command accepts many of the same options as the \f3java\fR command, including \f3-D\fR, \f3-classpath\fR, and \f3-X\fR options\&. The following list contains additional options that are accepted by the \f3jdb\fR command\&. +.PP +Other options are supported to provide alternate mechanisms for connecting the debugger to the JVM it is to debug\&. For additional documentation about these connection alternatives, see Java Platform Debugger Architecture (JPDA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/jpda/index\&.html +.TP +-help +.br +Displays a help message\&. +.TP +-sourcepath \fIdir1:dir2: \&. \&. \&.\fR +.br +Uses the specified path to search for source files in the specified path\&. If this option is not specified, then use the default path of dot (\&.)\&. +.TP +-attach \fIaddress\fR +.br +Attaches the debugger to a running JVM with the default connection mechanism\&. +.TP +-listen \fIaddress\fR +.br +Waits for a running JVM to connect to the specified address with a standard connector\&. +.TP +-launch +.br +Starts the debugged application immediately upon startup of JDB\&. The \f3-launch\fR option removes the need for the \f3run\fR command\&. The debugged application is launched and then stopped just before the initial application class is loaded\&. At that point, you can set any necessary breakpoints and use the \f3cont\fR command to continue execution\&. +.TP +-listconnectors +.br +List the connectors available in this JVM\&. +.TP +-connect connector-name:\fIname1=value1\fR +.br +Connects to the target JVM with the named connector and listed argument values\&. +.TP +-dbgtrace [\fIflags\fR] +.br +Prints information for debugging the \f3jdb\fR command\&. +.TP +-tclient +.br +Runs the application in the Java HotSpot VM client\&. +.TP +-tserver +.br +Runs the application in the Java HotSpot VM server\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the JVM, where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH OPTIONS\ FORWARDED\ TO\ THE\ DEBUGGER\ PROCESS +.TP +-v -verbose[:\fIclass\fR|gc|jni] +.br +Turns on verbose mode\&. +.TP +-D\fIname\fR=\fIvalue\fR +.br +Sets a system property\&. +.TP +-classpath \fIdir\fR +.br +Lists directories separated by colons in which to look for classes\&. +.TP +-X\fIoption\fR +.br +Nonstandard target JVM option\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +javac(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +javap(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/jdeps.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/jdeps.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,537 +1,537 @@ -'\" t -.\" Copyright (c) 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Basic Tools -.\" Title: jdeps.1 -.\" -.if n .pl 99999 -.TH jdeps 1 "21 November 2013" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jdeps \- Java class dependency analyzer\&. -.SH SYNOPSIS -.sp -.nf - -\fBjdeps\fR [\fIoptions\fR] \fIclasses\fR \&.\&.\&. -.fi -.sp -.TP -\fIoptions\fR -Command-line options\&. See Options\&. -.TP -\fIclasses\fR -Name of the classes to analyze\&. You can specify a class that can be found in the class path, by its file name, a directory, or a JAR file\&. -.SH DESCRIPTION -The \fI\fR\f3jdeps\fR command shows the package-level or class-level dependencies of Java class files\&. The input class can be a path name to a \f3\&.class\fR file, a directory, a JAR file, or it can be a fully qualified class name to analyze all class files\&. The options determine the output\&. By default, \f3jdeps\fR outputs the dependencies to the system output\&. It can generate the dependencies in DOT language (see the \f3-dotoutput\fR option)\&. -.SH OPTIONS -.TP --dotoutput <\fIdir\fR> -.br -Destination directory for DOT file output\&. If specified, \f3jdeps\fR will generate one dot file per each analyzed archive named <\fIarchive-file-name\fR>\&.dot listing the dependencies, and also a summary file named summary\&.dot listing the dependencies among the archives\&. -.TP --s, -summary -.br -Prints dependency summary only\&. -.TP --v, -verbose -.br -Prints all class-level dependencies\&. -.TP --verbose:package -.br -Prints package-level dependencies excluding dependencies within the same archive\&. -.TP --verbose:class -.br -Prints class-level dependencies excluding dependencies within the same archive\&. -.TP --cp <\fIpath\fR>, -classpath <\fIpath\fR> -.br -Specifies where to find class files\&. - -See also Setting the Class Path\&. -.TP --p <\fIpkg name\fR>, -package <\fIpkg name\fR> -.br -Finds dependencies in the specified package\&. You can specify this option multiple times for different packages\&. The \f3-p\fR and \f3-e\fR options are mutually exclusive\&. -.TP --e <\fIregex\fR>, -regex <\fIregex\fR> -.br -Finds dependencies in packages matching the specified regular expression pattern\&. The \f3-p\fR and \f3-e\fR options are mutually exclusive\&. -.TP --include <\fIregex\fR> -.br -Restricts analysis to classes matching pattern\&. This option filters the list of classes to be analyzed\&. It can be used together with \f3-p\fR and \f3-e\fR which apply pattern to the dependencies\&. -.TP --jdkinternals -.br -Finds class-level dependences in JDK internal APIs\&. By default, it analyzes all classes specified in the \f3-classpath\fR option and in input files unless you specified the \f3-include\fR option\&. You cannot use this option with the \f3-p\fR, \f3-e\fR, and \f3-s\fR options\&. - -\fIWarning\fR: JDK internal APIs may not be accessible in upcoming releases\&. -.TP --P, -profile -.br -Shows profile or the file containing a package\&. -.TP --apionly -.br -Restricts analysis to APIs, for example, dependences from the signature of \f3public\fR and \f3protected\fR members of public classes including field type, method parameter types, returned type, and checked exception types\&. -.TP --R, -recursive -.br -Recursively traverses all dependencies\&. -.TP --version -.br -Prints version information\&. -.TP --h, -?, -help -.br -Prints help message for \f3jdeps\fR\&. -.SH EXAMPLES -Analyzing the dependencies of Notepad\&.jar\&. -.sp -.nf -\f3$ jdeps demo/jfc/Notepad/Notepad\&.jar\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3demo/jfc/Notepad/Notepad\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP -.fi -.nf -\f3 <unnamed> (Notepad\&.jar)\fP -.fi -.nf -\f3 \-> java\&.awt \fP -.fi -.nf -\f3 \-> java\&.awt\&.event \fP -.fi -.nf -\f3 \-> java\&.beans \fP -.fi -.nf -\f3 \-> java\&.io \fP -.fi -.nf -\f3 \-> java\&.lang \fP -.fi -.nf -\f3 \-> java\&.net \fP -.fi -.nf -\f3 \-> java\&.util \fP -.fi -.nf -\f3 \-> java\&.util\&.logging \fP -.fi -.nf -\f3 \-> javax\&.swing \fP -.fi -.nf -\f3 \-> javax\&.swing\&.border \fP -.fi -.nf -\f3 \-> javax\&.swing\&.event \fP -.fi -.nf -\f3 \-> javax\&.swing\&.text \fP -.fi -.nf -\f3 \-> javax\&.swing\&.tree \fP -.fi -.nf -\f3 \-> javax\&.swing\&.undo \fP -.fi -.nf -\f3\fP -.fi -.sp -Use -P or -profile option to show on which profile that Notepad depends\&. -.sp -.nf -\f3$ jdeps \-profile demo/jfc/Notepad/Notepad\&.jar \fP -.fi -.nf -\f3demo/jfc/Notepad/Notepad\&.jar \-> /usr/java/jre/lib/rt\&.jar (Full JRE)\fP -.fi -.nf -\f3 <unnamed> (Notepad\&.jar)\fP -.fi -.nf -\f3 \-> java\&.awt Full JRE\fP -.fi -.nf -\f3 \-> java\&.awt\&.event Full JRE\fP -.fi -.nf -\f3 \-> java\&.beans Full JRE\fP -.fi -.nf -\f3 \-> java\&.io compact1\fP -.fi -.nf -\f3 \-> java\&.lang compact1\fP -.fi -.nf -\f3 \-> java\&.net compact1\fP -.fi -.nf -\f3 \-> java\&.util compact1\fP -.fi -.nf -\f3 \-> java\&.util\&.logging compact1\fP -.fi -.nf -\f3 \-> javax\&.swing Full JRE\fP -.fi -.nf -\f3 \-> javax\&.swing\&.border Full JRE\fP -.fi -.nf -\f3 \-> javax\&.swing\&.event Full JRE\fP -.fi -.nf -\f3 \-> javax\&.swing\&.text Full JRE\fP -.fi -.nf -\f3 \-> javax\&.swing\&.tree Full JRE\fP -.fi -.nf -\f3 \-> javax\&.swing\&.undo Full JRE\fP -.fi -.nf -\f3\fP -.fi -.sp -Analyzing the immediate dependencies of a specific class in a given classpath, for example the \f3com\&.sun\&.tools\&.jdeps\&.Main\fR class in the tools\&.jar file\&. -.sp -.nf -\f3$ jdeps \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP -.fi -.nf -\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP -.fi -.nf -\f3 com\&.sun\&.tools\&.jdeps (tools\&.jar)\fP -.fi -.nf -\f3 \-> java\&.io \fP -.fi -.nf -\f3 \-> java\&.lang \fP -.fi -.nf -\f3\fP -.fi -.sp -Use the \f3-verbose:class\fR option to find class-level dependencies or use the \f3-v\fR or \f3-verbose\fR option to include dependencies from the same JAR file\&. -.sp -.nf -\f3$ jdeps \-verbose:class \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP -.fi -.nf -\f3 com\&.sun\&.tools\&.jdeps\&.Main (tools\&.jar)\fP -.fi -.nf -\f3 \-> java\&.io\&.PrintWriter \fP -.fi -.nf -\f3 \-> java\&.lang\&.Exception \fP -.fi -.nf -\f3 \-> java\&.lang\&.Object \fP -.fi -.nf -\f3 \-> java\&.lang\&.String \fP -.fi -.nf -\f3 \-> java\&.lang\&.System \fP -.fi -.nf -\f3\fP -.fi -.sp -Use the \f3-R\fR or \f3-recursive\fR option to analyze the transitive dependencies of the \f3com\&.sun\&.tools\&.jdeps\&.Main\fR class\&. -.sp -.nf -\f3$ jdeps \-R \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP -.fi -.nf -\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP -.fi -.nf -\f3 com\&.sun\&.tools\&.classfile (tools\&.jar)\fP -.fi -.nf -\f3 \-> java\&.io \fP -.fi -.nf -\f3 \-> java\&.lang \fP -.fi -.nf -\f3 \-> java\&.lang\&.reflect \fP -.fi -.nf -\f3 \-> java\&.nio\&.charset \fP -.fi -.nf -\f3 \-> java\&.nio\&.file \fP -.fi -.nf -\f3 \-> java\&.util \fP -.fi -.nf -\f3 \-> java\&.util\&.regex \fP -.fi -.nf -\f3 com\&.sun\&.tools\&.jdeps (tools\&.jar)\fP -.fi -.nf -\f3 \-> java\&.io \fP -.fi -.nf -\f3 \-> java\&.lang \fP -.fi -.nf -\f3 \-> java\&.nio\&.file \fP -.fi -.nf -\f3 \-> java\&.nio\&.file\&.attribute \fP -.fi -.nf -\f3 \-> java\&.text \fP -.fi -.nf -\f3 \-> java\&.util \fP -.fi -.nf -\f3 \-> java\&.util\&.jar \fP -.fi -.nf -\f3 \-> java\&.util\&.regex \fP -.fi -.nf -\f3 \-> java\&.util\&.zip \fP -.fi -.nf -\f3/usr/java/jre/lib/jce\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP -.fi -.nf -\f3 javax\&.crypto (jce\&.jar)\fP -.fi -.nf -\f3 \-> java\&.io \fP -.fi -.nf -\f3 \-> java\&.lang \fP -.fi -.nf -\f3 \-> java\&.lang\&.reflect \fP -.fi -.nf -\f3 \-> java\&.net \fP -.fi -.nf -\f3 \-> java\&.nio \fP -.fi -.nf -\f3 \-> java\&.security \fP -.fi -.nf -\f3 \-> java\&.security\&.cert \fP -.fi -.nf -\f3 \-> java\&.security\&.spec \fP -.fi -.nf -\f3 \-> java\&.util \fP -.fi -.nf -\f3 \-> java\&.util\&.concurrent \fP -.fi -.nf -\f3 \-> java\&.util\&.jar \fP -.fi -.nf -\f3 \-> java\&.util\&.regex \fP -.fi -.nf -\f3 \-> java\&.util\&.zip \fP -.fi -.nf -\f3 \-> javax\&.security\&.auth \fP -.fi -.nf -\f3 \-> sun\&.security\&.jca JDK internal API (rt\&.jar)\fP -.fi -.nf -\f3 \-> sun\&.security\&.util JDK internal API (rt\&.jar)\fP -.fi -.nf -\f3 javax\&.crypto\&.spec (jce\&.jar)\fP -.fi -.nf -\f3 \-> java\&.lang \fP -.fi -.nf -\f3 \-> java\&.security\&.spec \fP -.fi -.nf -\f3 \-> java\&.util \fP -.fi -.nf -\f3/usr/java/jre/lib/rt\&.jar \-> /usr/java/jre/lib/jce\&.jar\fP -.fi -.nf -\f3 java\&.security (rt\&.jar)\fP -.fi -.nf -\f3 \-> javax\&.crypto\fP -.fi -.nf -\f3\fP -.fi -.sp -Generate dot files of the dependencies of Notepad demo\&. -.sp -.nf -\f3$ jdeps \-dotoutput dot demo/jfc/Notepad/Notepad\&.jar\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3jdeps\fR will create one dot file for each given JAR file named <\fIfilename\fR>\&.dot in the dot directory specified in the \f3-dotoutput\fR option, and also a summary file named summary\&.dot that will list the dependencies among the JAR files -.sp -.nf -\f3$ cat dot/Notepad\&.jar\&.dot \fP -.fi -.nf -\f3digraph "Notepad\&.jar" {\fP -.fi -.nf -\f3 // Path: demo/jfc/Notepad/Notepad\&.jar\fP -.fi -.nf -\f3 "<unnamed>" \-> "java\&.awt";\fP -.fi -.nf -\f3 "<unnamed>" \-> "java\&.awt\&.event";\fP -.fi -.nf -\f3 "<unnamed>" \-> "java\&.beans";\fP -.fi -.nf -\f3 "<unnamed>" \-> "java\&.io";\fP -.fi -.nf -\f3 "<unnamed>" \-> "java\&.lang";\fP -.fi -.nf -\f3 "<unnamed>" \-> "java\&.net";\fP -.fi -.nf -\f3 "<unnamed>" \-> "java\&.util";\fP -.fi -.nf -\f3 "<unnamed>" \-> "java\&.util\&.logging";\fP -.fi -.nf -\f3 "<unnamed>" \-> "javax\&.swing";\fP -.fi -.nf -\f3 "<unnamed>" \-> "javax\&.swing\&.border";\fP -.fi -.nf -\f3 "<unnamed>" \-> "javax\&.swing\&.event";\fP -.fi -.nf -\f3 "<unnamed>" \-> "javax\&.swing\&.text";\fP -.fi -.nf -\f3 "<unnamed>" \-> "javax\&.swing\&.tree";\fP -.fi -.nf -\f3 "<unnamed>" \-> "javax\&.swing\&.undo";\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3$ cat dot/summary\&.dot\fP -.fi -.nf -\f3digraph "summary" {\fP -.fi -.nf -\f3 "Notepad\&.jar" \-> "rt\&.jar";\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH SEE\ ALSO -.TP 0.2i -\(bu -javap(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: jdeps.1 +.\" +.if n .pl 99999 +.TH jdeps 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jdeps \- Java class dependency analyzer\&. +.SH SYNOPSIS +.sp +.nf + +\fBjdeps\fR [\fIoptions\fR] \fIclasses\fR \&.\&.\&. +.fi +.sp +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.TP +\fIclasses\fR +Name of the classes to analyze\&. You can specify a class that can be found in the class path, by its file name, a directory, or a JAR file\&. +.SH DESCRIPTION +The \fI\fR\f3jdeps\fR command shows the package-level or class-level dependencies of Java class files\&. The input class can be a path name to a \f3\&.class\fR file, a directory, a JAR file, or it can be a fully qualified class name to analyze all class files\&. The options determine the output\&. By default, \f3jdeps\fR outputs the dependencies to the system output\&. It can generate the dependencies in DOT language (see the \f3-dotoutput\fR option)\&. +.SH OPTIONS +.TP +-dotoutput <\fIdir\fR> +.br +Destination directory for DOT file output\&. If specified, \f3jdeps\fR will generate one dot file per each analyzed archive named <\fIarchive-file-name\fR>\&.dot listing the dependencies, and also a summary file named summary\&.dot listing the dependencies among the archives\&. +.TP +-s, -summary +.br +Prints dependency summary only\&. +.TP +-v, -verbose +.br +Prints all class-level dependencies\&. +.TP +-verbose:package +.br +Prints package-level dependencies excluding dependencies within the same archive\&. +.TP +-verbose:class +.br +Prints class-level dependencies excluding dependencies within the same archive\&. +.TP +-cp <\fIpath\fR>, -classpath <\fIpath\fR> +.br +Specifies where to find class files\&. + +See also Setting the Class Path\&. +.TP +-p <\fIpkg name\fR>, -package <\fIpkg name\fR> +.br +Finds dependencies in the specified package\&. You can specify this option multiple times for different packages\&. The \f3-p\fR and \f3-e\fR options are mutually exclusive\&. +.TP +-e <\fIregex\fR>, -regex <\fIregex\fR> +.br +Finds dependencies in packages matching the specified regular expression pattern\&. The \f3-p\fR and \f3-e\fR options are mutually exclusive\&. +.TP +-include <\fIregex\fR> +.br +Restricts analysis to classes matching pattern\&. This option filters the list of classes to be analyzed\&. It can be used together with \f3-p\fR and \f3-e\fR which apply pattern to the dependencies\&. +.TP +-jdkinternals +.br +Finds class-level dependences in JDK internal APIs\&. By default, it analyzes all classes specified in the \f3-classpath\fR option and in input files unless you specified the \f3-include\fR option\&. You cannot use this option with the \f3-p\fR, \f3-e\fR, and \f3-s\fR options\&. + +\fIWarning\fR: JDK internal APIs may not be accessible in upcoming releases\&. +.TP +-P, -profile +.br +Shows profile or the file containing a package\&. +.TP +-apionly +.br +Restricts analysis to APIs, for example, dependences from the signature of \f3public\fR and \f3protected\fR members of public classes including field type, method parameter types, returned type, and checked exception types\&. +.TP +-R, -recursive +.br +Recursively traverses all dependencies\&. +.TP +-version +.br +Prints version information\&. +.TP +-h, -?, -help +.br +Prints help message for \f3jdeps\fR\&. +.SH EXAMPLES +Analyzing the dependencies of Notepad\&.jar\&. +.sp +.nf +\f3$ jdeps demo/jfc/Notepad/Notepad\&.jar\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3demo/jfc/Notepad/Notepad\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 <unnamed> (Notepad\&.jar)\fP +.fi +.nf +\f3 \-> java\&.awt \fP +.fi +.nf +\f3 \-> java\&.awt\&.event \fP +.fi +.nf +\f3 \-> java\&.beans \fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.net \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3 \-> java\&.util\&.logging \fP +.fi +.nf +\f3 \-> javax\&.swing \fP +.fi +.nf +\f3 \-> javax\&.swing\&.border \fP +.fi +.nf +\f3 \-> javax\&.swing\&.event \fP +.fi +.nf +\f3 \-> javax\&.swing\&.text \fP +.fi +.nf +\f3 \-> javax\&.swing\&.tree \fP +.fi +.nf +\f3 \-> javax\&.swing\&.undo \fP +.fi +.nf +\f3\fP +.fi +.sp +Use -P or -profile option to show on which profile that Notepad depends\&. +.sp +.nf +\f3$ jdeps \-profile demo/jfc/Notepad/Notepad\&.jar \fP +.fi +.nf +\f3demo/jfc/Notepad/Notepad\&.jar \-> /usr/java/jre/lib/rt\&.jar (Full JRE)\fP +.fi +.nf +\f3 <unnamed> (Notepad\&.jar)\fP +.fi +.nf +\f3 \-> java\&.awt Full JRE\fP +.fi +.nf +\f3 \-> java\&.awt\&.event Full JRE\fP +.fi +.nf +\f3 \-> java\&.beans Full JRE\fP +.fi +.nf +\f3 \-> java\&.io compact1\fP +.fi +.nf +\f3 \-> java\&.lang compact1\fP +.fi +.nf +\f3 \-> java\&.net compact1\fP +.fi +.nf +\f3 \-> java\&.util compact1\fP +.fi +.nf +\f3 \-> java\&.util\&.logging compact1\fP +.fi +.nf +\f3 \-> javax\&.swing Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.border Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.event Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.text Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.tree Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.undo Full JRE\fP +.fi +.nf +\f3\fP +.fi +.sp +Analyzing the immediate dependencies of a specific class in a given classpath, for example the \f3com\&.sun\&.tools\&.jdeps\&.Main\fR class in the tools\&.jar file\&. +.sp +.nf +\f3$ jdeps \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP +.fi +.nf +\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 com\&.sun\&.tools\&.jdeps (tools\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3\fP +.fi +.sp +Use the \f3-verbose:class\fR option to find class-level dependencies or use the \f3-v\fR or \f3-verbose\fR option to include dependencies from the same JAR file\&. +.sp +.nf +\f3$ jdeps \-verbose:class \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 com\&.sun\&.tools\&.jdeps\&.Main (tools\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io\&.PrintWriter \fP +.fi +.nf +\f3 \-> java\&.lang\&.Exception \fP +.fi +.nf +\f3 \-> java\&.lang\&.Object \fP +.fi +.nf +\f3 \-> java\&.lang\&.String \fP +.fi +.nf +\f3 \-> java\&.lang\&.System \fP +.fi +.nf +\f3\fP +.fi +.sp +Use the \f3-R\fR or \f3-recursive\fR option to analyze the transitive dependencies of the \f3com\&.sun\&.tools\&.jdeps\&.Main\fR class\&. +.sp +.nf +\f3$ jdeps \-R \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP +.fi +.nf +\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 com\&.sun\&.tools\&.classfile (tools\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.lang\&.reflect \fP +.fi +.nf +\f3 \-> java\&.nio\&.charset \fP +.fi +.nf +\f3 \-> java\&.nio\&.file \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3 \-> java\&.util\&.regex \fP +.fi +.nf +\f3 com\&.sun\&.tools\&.jdeps (tools\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.nio\&.file \fP +.fi +.nf +\f3 \-> java\&.nio\&.file\&.attribute \fP +.fi +.nf +\f3 \-> java\&.text \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3 \-> java\&.util\&.jar \fP +.fi +.nf +\f3 \-> java\&.util\&.regex \fP +.fi +.nf +\f3 \-> java\&.util\&.zip \fP +.fi +.nf +\f3/usr/java/jre/lib/jce\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 javax\&.crypto (jce\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.lang\&.reflect \fP +.fi +.nf +\f3 \-> java\&.net \fP +.fi +.nf +\f3 \-> java\&.nio \fP +.fi +.nf +\f3 \-> java\&.security \fP +.fi +.nf +\f3 \-> java\&.security\&.cert \fP +.fi +.nf +\f3 \-> java\&.security\&.spec \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3 \-> java\&.util\&.concurrent \fP +.fi +.nf +\f3 \-> java\&.util\&.jar \fP +.fi +.nf +\f3 \-> java\&.util\&.regex \fP +.fi +.nf +\f3 \-> java\&.util\&.zip \fP +.fi +.nf +\f3 \-> javax\&.security\&.auth \fP +.fi +.nf +\f3 \-> sun\&.security\&.jca JDK internal API (rt\&.jar)\fP +.fi +.nf +\f3 \-> sun\&.security\&.util JDK internal API (rt\&.jar)\fP +.fi +.nf +\f3 javax\&.crypto\&.spec (jce\&.jar)\fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.security\&.spec \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3/usr/java/jre/lib/rt\&.jar \-> /usr/java/jre/lib/jce\&.jar\fP +.fi +.nf +\f3 java\&.security (rt\&.jar)\fP +.fi +.nf +\f3 \-> javax\&.crypto\fP +.fi +.nf +\f3\fP +.fi +.sp +Generate dot files of the dependencies of Notepad demo\&. +.sp +.nf +\f3$ jdeps \-dotoutput dot demo/jfc/Notepad/Notepad\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3jdeps\fR will create one dot file for each given JAR file named <\fIfilename\fR>\&.dot in the dot directory specified in the \f3-dotoutput\fR option, and also a summary file named summary\&.dot that will list the dependencies among the JAR files +.sp +.nf +\f3$ cat dot/Notepad\&.jar\&.dot \fP +.fi +.nf +\f3digraph "Notepad\&.jar" {\fP +.fi +.nf +\f3 // Path: demo/jfc/Notepad/Notepad\&.jar\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.awt";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.awt\&.event";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.beans";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.io";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.lang";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.net";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.util";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.util\&.logging";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.border";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.event";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.text";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.tree";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.undo";\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3$ cat dot/summary\&.dot\fP +.fi +.nf +\f3digraph "summary" {\fP +.fi +.nf +\f3 "Notepad\&.jar" \-> "rt\&.jar";\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +javap(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/jhat.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/jhat.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,136 +1,136 @@ -'\" t -.\" Copyright (c) 2006, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Troubleshooting Tools -.\" Title: jhat.1 -.\" -.if n .pl 99999 -.TH jhat 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jhat \- Analyzes the Java heap\&. This command is experimental and unsupported\&. -.SH SYNOPSIS -.sp -.nf - -\fBjhat\fR [ \fIoptions\fR ] \fIheap\-dump\-file\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIheap-dump-file\fR -Java binary heap dump file to be browsed\&. For a dump file that contains multiple heap dumps, you can specify which dump in the file by appending \f3#<number>\fR to the file name, for example, \f3myfile\&.hprof#3\fR\&. -.SH DESCRIPTION -The \f3jhat\fR command parses a Java heap dump file and starts a web server\&. The \f3jhat\fR command lets you to browse heap dumps with your favorite web browser\&. The \f3jhat\fR command supports predesigned queries such as show all instances of a known class \f3MyClass\fR, and Object Query Language (OQL)\&. OQL is similar to SQL, except for querying heap dumps\&. Help on OQL is available from the OQL help page shown by the \f3jhat\fR command\&. With the default port, OQL help is available at http://localhost:7000/oqlhelp/ -.PP -There are several ways to generate a Java heap dump: -.TP 0.2i -\(bu -Use the \f3jmap -dump\fR option to obtain a heap dump at runtime\&. See jmap(1)\&. -.TP 0.2i -\(bu -Use the \f3jconsole\fR option to obtain a heap dump through \f3HotSpotDiagnosticMXBean\fR at runtime\&. See jconsole(1) and the \f3HotSpotDiagnosticMXBean\fR interface description at http://docs\&.oracle\&.com/javase/8/docs/jre/api/management/extension/com/sun/management/HotSpotDiagnosticMXBean\&.html -.TP 0.2i -\(bu -Heap dump is generated when an \f3OutOfMemoryError\fR is thrown by specifying the \f3-XX:+HeapDumpOnOutOfMemoryError\fR Java Virtual Machine (JVM) option\&. -.TP 0.2i -\(bu -Use the \f3hprof\fR command\&. See the HPROF: A Heap/CPU Profiling Tool at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/hprof\&.html -.SH OPTIONS -.TP --stack false|true -.br -Turns off tracking object allocation call stack\&. If allocation site information is not available in the heap dump, then you have to set this flag to \f3false\fR\&. The default is \f3true\fR\&. -.TP --refs false|true -.br -Turns off tracking of references to objects\&. Default is \f3true\fR\&. By default, back pointers, which are objects that point to a specified object such as referrers or incoming references, are calculated for all objects in the heap\&. -.TP --port \fIport-number\fR -.br -Sets the port for the \f3jhat\fR HTTP server\&. Default is 7000\&. -.TP --exclude \fIexclude-file\fR -.br -Specifies a file that lists data members that should be excluded from the reachable objects query\&. For example, if the file lists \f3java\&.lang\&.String\&.value\fR, then, then whenever the list of objects that are reachable from a specific object \f3o\fR are calculated, reference paths that involve \f3java\&.lang\&.String\&.value\fR field are not considered\&. -.TP --baseline \fIexclude-file\fR -.br -Specifies a baseline heap dump\&. Objects in both heap dumps with the same object ID are marked as not being new\&. Other objects are marked as new\&. This is useful for comparing two different heap dumps\&. -.TP --debug \fIint\fR -.br -Sets the debug level for this tool\&. A level of 0 means no debug output\&. Set higher values for more verbose modes\&. -.TP --version -.br -Reports the release number and exits -.TP --h -.br -Dsiplays a help message and exits\&. -.TP --help -.br -Displays a help message and exits\&. -.TP --J\fIflag\fR -.br -Passes \f3flag\fR to the Java Virtual Machine on which the \f3jhat\fR command is running\&. For example, \f3-J-Xmx512m\fR to use a maximum heap size of 512 MB\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -jmap(1) -.TP 0.2i -\(bu -jconsole(1) -.TP 0.2i -\(bu -HPROF: A Heap/CPU Profiling Tool at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/hprof\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2006, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jhat.1 +.\" +.if n .pl 99999 +.TH jhat 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jhat \- Analyzes the Java heap\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjhat\fR [ \fIoptions\fR ] \fIheap\-dump\-file\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIheap-dump-file\fR +Java binary heap dump file to be browsed\&. For a dump file that contains multiple heap dumps, you can specify which dump in the file by appending \f3#<number>\fR to the file name, for example, \f3myfile\&.hprof#3\fR\&. +.SH DESCRIPTION +The \f3jhat\fR command parses a Java heap dump file and starts a web server\&. The \f3jhat\fR command lets you to browse heap dumps with your favorite web browser\&. The \f3jhat\fR command supports predesigned queries such as show all instances of a known class \f3MyClass\fR, and Object Query Language (OQL)\&. OQL is similar to SQL, except for querying heap dumps\&. Help on OQL is available from the OQL help page shown by the \f3jhat\fR command\&. With the default port, OQL help is available at http://localhost:7000/oqlhelp/ +.PP +There are several ways to generate a Java heap dump: +.TP 0.2i +\(bu +Use the \f3jmap -dump\fR option to obtain a heap dump at runtime\&. See jmap(1)\&. +.TP 0.2i +\(bu +Use the \f3jconsole\fR option to obtain a heap dump through \f3HotSpotDiagnosticMXBean\fR at runtime\&. See jconsole(1) and the \f3HotSpotDiagnosticMXBean\fR interface description at http://docs\&.oracle\&.com/javase/8/docs/jre/api/management/extension/com/sun/management/HotSpotDiagnosticMXBean\&.html +.TP 0.2i +\(bu +Heap dump is generated when an \f3OutOfMemoryError\fR is thrown by specifying the \f3-XX:+HeapDumpOnOutOfMemoryError\fR Java Virtual Machine (JVM) option\&. +.TP 0.2i +\(bu +Use the \f3hprof\fR command\&. See the HPROF: A Heap/CPU Profiling Tool at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/hprof\&.html +.SH OPTIONS +.TP +-stack false|true +.br +Turns off tracking object allocation call stack\&. If allocation site information is not available in the heap dump, then you have to set this flag to \f3false\fR\&. The default is \f3true\fR\&. +.TP +-refs false|true +.br +Turns off tracking of references to objects\&. Default is \f3true\fR\&. By default, back pointers, which are objects that point to a specified object such as referrers or incoming references, are calculated for all objects in the heap\&. +.TP +-port \fIport-number\fR +.br +Sets the port for the \f3jhat\fR HTTP server\&. Default is 7000\&. +.TP +-exclude \fIexclude-file\fR +.br +Specifies a file that lists data members that should be excluded from the reachable objects query\&. For example, if the file lists \f3java\&.lang\&.String\&.value\fR, then, then whenever the list of objects that are reachable from a specific object \f3o\fR are calculated, reference paths that involve \f3java\&.lang\&.String\&.value\fR field are not considered\&. +.TP +-baseline \fIexclude-file\fR +.br +Specifies a baseline heap dump\&. Objects in both heap dumps with the same object ID are marked as not being new\&. Other objects are marked as new\&. This is useful for comparing two different heap dumps\&. +.TP +-debug \fIint\fR +.br +Sets the debug level for this tool\&. A level of 0 means no debug output\&. Set higher values for more verbose modes\&. +.TP +-version +.br +Reports the release number and exits +.TP +-h +.br +Dsiplays a help message and exits\&. +.TP +-help +.br +Displays a help message and exits\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR to the Java Virtual Machine on which the \f3jhat\fR command is running\&. For example, \f3-J-Xmx512m\fR to use a maximum heap size of 512 MB\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jmap(1) +.TP 0.2i +\(bu +jconsole(1) +.TP 0.2i +\(bu +HPROF: A Heap/CPU Profiling Tool at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/hprof\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/jinfo.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/jinfo.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,132 +1,132 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Troubleshooting Tools -.\" Title: jinfo.1 -.\" -.if n .pl 99999 -.TH jinfo 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jinfo \- Generates configuration information\&. This command is experimental and unsupported\&. -.SH SYNOPSIS -.sp -.nf - -\fBjinfo\fR [ \fIoption\fR ] \fIpid\fR -.fi -.nf - -\fBjinfo\fR [ \fIoption \fR] \fIexecutable core\fR -.fi -.nf - -\fBjinfo\fR [ \fIoption \fR] \fI[ servier\-id ] remote\-hostname\-or\-IP\fR -.fi -.sp -.TP -\fIoption\fR -The command-line options\&. See Options\&. -.TP -\fIpid\fR -The process ID for which the configuration information is to be printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. -.TP -\fIexecutable\fR -The Java executable from which the core dump was produced\&. -.TP -\fIcore\fR -The core file for which the configuration information is to be printed\&. -.TP -\fIremote-hostname-or-IP\fR -The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. -.TP -\fIserver-id\fR -An optional unique ID to use when multiple debug servers are running on the same remote host\&. -.SH DESCRIPTION -The \f3jinfo\fR command prints Java configuration information for a specified Java process or core file or a remote debug server\&. The configuration information includes Java system properties and Java Virtual Machine (JVM) command-line flags\&. If the specified process is running on a 64-bit JVM, then you might need to specify the \f3-J-d64\fR option, for example: \f3jinfo\fR\f3-J-d64 -sysprops pid\fR\&. -.PP -This utility is unsupported and might not be available in future releases of the JDK\&. In Windows Systems where \f3dbgeng\&.dll\fR is not present, Debugging Tools For Windows must be installed to have these tools working\&. The \f3PATH\fR environment variable should contain the location of the jvm\&.dll that is used by the target process or the location from which the crash dump file was produced\&. For example, \f3set PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR \&. -.SH OPTIONS -.TP -no-option -Prints both command-line flags and system property name-value pairs\&. -.TP --flag \fIname\fR -.br -Prints the name and value of the specified command-line flag\&. -.TP --flag \fI[+|-]name\fR -.br -enables or disables the specified Boolean command-line flag\&. -.TP --flag \fIname=value\fR -.br -Sets the specified command-line flag to the specified value\&. -.TP --flags -.br -Prints command-line flags passed to the JVM\&. -.TP --sysprops -.br -Prints Java system properties as name-value pairs\&. -.TP --h -.br -Prints a help message\&. -.TP --help -.br -Prints a help message\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -jps(1) -.TP 0.2i -\(bu -jsadebugd(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jinfo.1 +.\" +.if n .pl 99999 +.TH jinfo 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jinfo \- Generates configuration information\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjinfo\fR [ \fIoption\fR ] \fIpid\fR +.fi +.nf + +\fBjinfo\fR [ \fIoption \fR] \fIexecutable core\fR +.fi +.nf + +\fBjinfo\fR [ \fIoption \fR] \fI[ servier\-id ] remote\-hostname\-or\-IP\fR +.fi +.sp +.TP +\fIoption\fR +The command-line options\&. See Options\&. +.TP +\fIpid\fR +The process ID for which the configuration information is to be printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. +.TP +\fIexecutable\fR +The Java executable from which the core dump was produced\&. +.TP +\fIcore\fR +The core file for which the configuration information is to be printed\&. +.TP +\fIremote-hostname-or-IP\fR +The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. +.TP +\fIserver-id\fR +An optional unique ID to use when multiple debug servers are running on the same remote host\&. +.SH DESCRIPTION +The \f3jinfo\fR command prints Java configuration information for a specified Java process or core file or a remote debug server\&. The configuration information includes Java system properties and Java Virtual Machine (JVM) command-line flags\&. If the specified process is running on a 64-bit JVM, then you might need to specify the \f3-J-d64\fR option, for example: \f3jinfo\fR\f3-J-d64 -sysprops pid\fR\&. +.PP +This utility is unsupported and might not be available in future releases of the JDK\&. In Windows Systems where \f3dbgeng\&.dll\fR is not present, Debugging Tools For Windows must be installed to have these tools working\&. The \f3PATH\fR environment variable should contain the location of the jvm\&.dll that is used by the target process or the location from which the crash dump file was produced\&. For example, \f3set PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR \&. +.SH OPTIONS +.TP +no-option +Prints both command-line flags and system property name-value pairs\&. +.TP +-flag \fIname\fR +.br +Prints the name and value of the specified command-line flag\&. +.TP +-flag \fI[+|-]name\fR +.br +enables or disables the specified Boolean command-line flag\&. +.TP +-flag \fIname=value\fR +.br +Sets the specified command-line flag to the specified value\&. +.TP +-flags +.br +Prints command-line flags passed to the JVM\&. +.TP +-sysprops +.br +Prints Java system properties as name-value pairs\&. +.TP +-h +.br +Prints a help message\&. +.TP +-help +.br +Prints a help message\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jsadebugd(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/jjs.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/jjs.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/bsd/doc/man/jmap.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/jmap.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,143 +1,143 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Troubleshooting Tools -.\" Title: jmap.1 -.\" -.if n .pl 99999 -.TH jmap 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jmap \- Prints shared object memory maps or heap memory details for a process, core file, or remote debug server\&. This command is experimental and unsupported\&. -.SH SYNOPSIS -.sp -.nf - -\fBjmap\fR [ \fIoptions\fR ] \fIpid\fR -.fi -.nf - -\fBjmap\fR [ \fIoptions\fR ] \fIexecutable\fR \fIcore\fR -.fi -.nf - -\fBjmap\fR [ \fIoptions\fR ] [ \fIpid\fR ] \fIserver\-id\fR@ ] \fIremote\-hostname\-or\-IP\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIpid\fR -The process ID for which the memory map is to be printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. -.TP -\fIexecutable\fR -The Java executable from which the core dump was produced\&. -.TP -\fIcore\fR -The core file for which the memory map is to be printed\&. -.TP -\fIremote-hostname-or-IP\fR -The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. -.TP -\fIserver-id\fR -An optional unique ID to use when multiple debug servers are running on the same remote host\&. -.SH DESCRIPTION -The \f3jmap\fR command prints shared object memory maps or heap memory details of a specified process, core file, or remote debug server\&. If the specified process is running on a 64-bit Java Virtual Machine (JVM), then you might need to specify the \f3-J-d64\fR option, for example: \f3jmap\fR\f3-J-d64 -heap pid\fR\&. -.PP -\fINote:\fR This utility is unsupported and might not be available in future releases of the JDK\&. On Windows Systems where the \f3dbgeng\&.dll\fR file is not present, Debugging Tools For Windows must be installed to make these tools work\&. The \f3PATH\fR environment variable should contain the location of the \f3jvm\&.dll\fR file that is used by the target process or the location from which the crash dump file was produced, for example: \f3set PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR\&. -.SH OPTIONS -.TP -<no option> -When no option is used, the \f3jmap\fR command prints shared object mappings\&. For each shared object loaded in the target JVM, the start address, size of the mapping, and the full path of the shared object file are printed\&. This behavior is similar to the Oracle Solaris \f3pmap\fR utility\&. -.TP --dump:[live,] format=b, file=\fIfilename\fR -.br -Dumps the Java heap in \f3hprof\fR binary format to \f3filename\fR\&. The \f3live\fR suboption is optional, but when specified, only the active objects in the heap are dumped\&. To browse the heap dump, you can use the jhat(1) command to read the generated file\&. -.TP --finalizerinfo -.br -Prints information about objects that are awaiting finalization\&. -.TP --heap -.br -Prints a heap summary of the garbage collection used, the head configuration, and generation-wise heap usage\&. In addition, the number and size of interned Strings are printed\&. -.TP --histo[:live] -.br -Prints a histogram of the heap\&. For each Java class, the number of objects, memory size in bytes, and the fully qualified class names are printed\&. The JVM internal class names are printed with an asterisk (*) prefix\&. If the \f3live\fR suboption is specified, then only active objects are counted\&. -.TP --clstats -.br -Prints class loader wise statistics of Java heap\&. For each class loader, its name, how active it is, address, parent class loader, and the number and size of classes it has loaded are printed\&. -.TP --F -.br -Force\&. Use this option with the \f3jmap -dump\fR or \f3jmap -histo\fR option when the pid does not respond\&. The \f3live\fR suboption is not supported in this mode\&. -.TP --h -.br -Prints a help message\&. -.TP --help -.br -Prints a help message\&. -.TP --J\fIflag\fR -.br -Passes \f3flag\fR to the Java Virtual Machine where the \f3jmap\fR command is running\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -jhat(1) -.TP 0.2i -\(bu -jps(1) -.TP 0.2i -\(bu -jsadebugd(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jmap.1 +.\" +.if n .pl 99999 +.TH jmap 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jmap \- Prints shared object memory maps or heap memory details for a process, core file, or remote debug server\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjmap\fR [ \fIoptions\fR ] \fIpid\fR +.fi +.nf + +\fBjmap\fR [ \fIoptions\fR ] \fIexecutable\fR \fIcore\fR +.fi +.nf + +\fBjmap\fR [ \fIoptions\fR ] [ \fIpid\fR ] \fIserver\-id\fR@ ] \fIremote\-hostname\-or\-IP\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIpid\fR +The process ID for which the memory map is to be printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. +.TP +\fIexecutable\fR +The Java executable from which the core dump was produced\&. +.TP +\fIcore\fR +The core file for which the memory map is to be printed\&. +.TP +\fIremote-hostname-or-IP\fR +The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. +.TP +\fIserver-id\fR +An optional unique ID to use when multiple debug servers are running on the same remote host\&. +.SH DESCRIPTION +The \f3jmap\fR command prints shared object memory maps or heap memory details of a specified process, core file, or remote debug server\&. If the specified process is running on a 64-bit Java Virtual Machine (JVM), then you might need to specify the \f3-J-d64\fR option, for example: \f3jmap\fR\f3-J-d64 -heap pid\fR\&. +.PP +\fINote:\fR This utility is unsupported and might not be available in future releases of the JDK\&. On Windows Systems where the \f3dbgeng\&.dll\fR file is not present, Debugging Tools For Windows must be installed to make these tools work\&. The \f3PATH\fR environment variable should contain the location of the \f3jvm\&.dll\fR file that is used by the target process or the location from which the crash dump file was produced, for example: \f3set PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR\&. +.SH OPTIONS +.TP +<no option> +When no option is used, the \f3jmap\fR command prints shared object mappings\&. For each shared object loaded in the target JVM, the start address, size of the mapping, and the full path of the shared object file are printed\&. This behavior is similar to the Oracle Solaris \f3pmap\fR utility\&. +.TP +-dump:[live,] format=b, file=\fIfilename\fR +.br +Dumps the Java heap in \f3hprof\fR binary format to \f3filename\fR\&. The \f3live\fR suboption is optional, but when specified, only the active objects in the heap are dumped\&. To browse the heap dump, you can use the jhat(1) command to read the generated file\&. +.TP +-finalizerinfo +.br +Prints information about objects that are awaiting finalization\&. +.TP +-heap +.br +Prints a heap summary of the garbage collection used, the head configuration, and generation-wise heap usage\&. In addition, the number and size of interned Strings are printed\&. +.TP +-histo[:live] +.br +Prints a histogram of the heap\&. For each Java class, the number of objects, memory size in bytes, and the fully qualified class names are printed\&. The JVM internal class names are printed with an asterisk (*) prefix\&. If the \f3live\fR suboption is specified, then only active objects are counted\&. +.TP +-clstats +.br +Prints class loader wise statistics of Java heap\&. For each class loader, its name, how active it is, address, parent class loader, and the number and size of classes it has loaded are printed\&. +.TP +-F +.br +Force\&. Use this option with the \f3jmap -dump\fR or \f3jmap -histo\fR option when the pid does not respond\&. The \f3live\fR suboption is not supported in this mode\&. +.TP +-h +.br +Prints a help message\&. +.TP +-help +.br +Prints a help message\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR to the Java Virtual Machine where the \f3jmap\fR command is running\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jhat(1) +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jsadebugd(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/jps.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/jps.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,204 +1,204 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Monitoring Tools -.\" Title: jps.1 -.\" -.if n .pl 99999 -.TH jps 1 "21 November 2013" "JDK 8" "Monitoring Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jps \- Lists the instrumented Java Virtual Machines (JVMs) on the target system\&. This command is experimental and unsupported\&. -.SH SYNOPSIS -.sp -.nf - -\fBjps\fR [ \fIoptions\fR ] [ \fIhostid\fR ] -.fi -.sp -.TP -\fIoptions\fR -Command-line options\&. See Options\&. -.TP -\fIhostid\fR -The identifier of the host for which the process report should be generated\&. The \f3hostid\fR can include optional components that indicate the communications protocol, port number, and other implementation specific data\&. See Host Identifier\&. -.SH DESCRIPTION -The \f3jps\fR command lists the instrumented Java HotSpot VMs on the target system\&. The command is limited to reporting information on JVMs for which it has the access permissions\&. -.PP -If the \f3jps\fR command is run without specifying a \f3hostid\fR, then it searches for instrumented JVMs on the local host\&. If started with a \f3hostid\fR, then it searches for JVMs on the indicated host, using the specified protocol and port\&. A \f3jstatd\fR process is assumed to be running on the target host\&. -.PP -The \f3jps\fR command reports the local JVM identifier, or \f3lvmid\fR, for each instrumented JVM found on the target system\&. The \f3lvmid\fR is typically, but not necessarily, the operating system\&'s process identifier for the JVM process\&. With no options, \f3jps\fR lists each Java application\&'s \f3lvmid\fR followed by the short form of the application\&'s class name or jar file name\&. The short form of the class name or JAR file name omits the class\&'s package information or the JAR files path information\&. -.PP -The \f3jps\fR command uses the Java launcher to find the class name and arguments passed to the main method\&. If the target JVM is started with a custom launcher, then the class or JAR file name and the arguments to the \f3main\fR method are not available\&. In this case, the \f3jps\fR command outputs the string \f3Unknown\fR for the class name or JAR file name and for the arguments to the \f3main\fR method\&. -.PP -The list of JVMs produced by the \f3jps\fR command can be limited by the permissions granted to the principal running the command\&. The command only lists the JVMs for which the principle has access rights as determined by operating system-specific access control mechanisms\&. -.SH OPTIONS -The \f3jps\fR command supports a number of options that modify the output of the command\&. These options are subject to change or removal in the future\&. -.TP --q -.br -Suppresses the output of the class name, JAR file name, and arguments passed to the \f3main\fR method, producing only a list of local JVM identifiers\&. -.TP --m -.br -Displays the arguments passed to the \f3main\fR method\&. The output may be \f3null\fR for embedded JVMs\&. -.TP --l -.br -Displays the full package name for the application\&'s \f3main\fR class or the full path name to the application\&'s JAR file\&. -.TP --v -.br -Displays the arguments passed to the JVM\&. -.TP --V -.br -Suppresses the output of the class name, JAR file name, and arguments passed to the main method, producing only a list of local JVM identifiers\&. -.TP --J\f3option\fR -.br -Passes \f3option\fR to the JVM, where option is one of the \f3options\fR described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH HOST\ IDENTIFIER -The host identifier, or \f3hostid\fR is a string that indicates the target system\&. The syntax of the \f3hostid\fR string corresponds to the syntax of a URI: -.sp -.nf -\f3[protocol:][[//]hostname][:port][/servername]\fP -.fi -.nf -\f3\fP -.fi -.sp -.TP -\fIprotocol\fR -The communications protocol\&. If the \f3protocol\fR is omitted and a \f3hostname\fR is not specified, then the default protocol is a platform-specific, optimized, local protocol\&. If the protocol is omitted and a host name is specified, then the default protocol is \f3rmi\fR\&. -.TP -hostname -A hostname or IP address that indicates the target host\&. If you omit the \f3hostname\fR parameter, then the target host is the local host\&. -.TP -port -The default port for communicating with the remote server\&. If the \f3hostname\fR parameter is omitted or the \f3protocol\fR parameter specifies an optimized, local protocol, then the \f3port\fR parameter is ignored\&. Otherwise, treatment of the \f3port\fR parameter is implementation specific\&. For the default \f3rmi\fR protocol, the \f3port\fR parameter indicates the port number for the rmiregistry on the remote host\&. If the \f3port\fR parameter is omitted, and the \f3protocol\fR parameter indicates \f3rmi\fR, then the default rmiregistry port (1099) is used\&. -.TP -servername -The treatment of this parameter depends on the implementation\&. For the optimized, local protocol, this field is ignored\&. For the \f3rmi\fR protocol, this parameter is a string that represents the name of the RMI remote object on the remote host\&. See the \f3jstatd\fR command \f3-n\fRoption for more information\&. -.SH OUTPUT\ FORMAT -The output of the \f3jps\fR command follows the following pattern: -.sp -.nf -\f3lvmid [ [ classname | JARfilename | "Unknown"] [ arg* ] [ jvmarg* ] ]\fP -.fi -.nf -\f3\fP -.fi -.sp -All output tokens are separated by white space\&. An \f3arg\fR value that includes embedded white space introduces ambiguity when attempting to map arguments to their actual positional parameters\&. -.PP -\fINote:\fR It is recommended that you do not write scripts to parse \f3jps\fR output because the format might change in future releases\&. If you write scripts that parse \f3jps\fR output, then expect to modify them for future releases of this tool\&. -.SH EXAMPLES -This section provides examples of the \f3jps\fR command\&. -.PP -List the instrumented JVMs on the local host: -.sp -.nf -\f3jps\fP -.fi -.nf -\f318027 Java2Demo\&.JAR\fP -.fi -.nf -\f318032 jps\fP -.fi -.nf -\f318005 jstat\fP -.fi -.nf -\f3\fP -.fi -.sp -The following example lists the instrumented JVMs on a remote host\&. This example assumes that the \f3jstat\fR server and either the its internal RMI registry or a separate external rmiregistry process are running on the remote host on the default port (port 1099)\&. It also assumes that the local host has appropriate permissions to access the remote host\&. This example also includes the \f3-l\fR option to output the long form of the class names or JAR file names\&. -.sp -.nf -\f3jps \-l remote\&.domain\fP -.fi -.nf -\f33002 /opt/jdk1\&.7\&.0/demo/jfc/Java2D/Java2Demo\&.JAR\fP -.fi -.nf -\f32857 sun\&.tools\&.jstatd\&.jstatd\fP -.fi -.nf -\f3\fP -.fi -.sp -The following example lists the instrumented JVMs on a remote host with a non-default port for the RMI registry\&. This example assumes that the \f3jstatd\fR server, with an internal RMI registry bound to port 2002, is running on the remote host\&. This example also uses the \f3-m\fR option to include the arguments passed to the \f3main\fR method of each of the listed Java applications\&. -.sp -.nf -\f3jps \-m remote\&.domain:2002\fP -.fi -.nf -\f33002 /opt/jdk1\&.7\&.0/demo/jfc/Java2D/Java2Demo\&.JAR\fP -.fi -.nf -\f33102 sun\&.tools\&.jstatd\&.jstatd \-p 2002\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH SEE\ ALSO -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -jstat(1) -.TP 0.2i -\(bu -jstatd(1) -.TP 0.2i -\(bu -rmiregistry(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Monitoring Tools +.\" Title: jps.1 +.\" +.if n .pl 99999 +.TH jps 1 "21 November 2013" "JDK 8" "Monitoring Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jps \- Lists the instrumented Java Virtual Machines (JVMs) on the target system\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjps\fR [ \fIoptions\fR ] [ \fIhostid\fR ] +.fi +.sp +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.TP +\fIhostid\fR +The identifier of the host for which the process report should be generated\&. The \f3hostid\fR can include optional components that indicate the communications protocol, port number, and other implementation specific data\&. See Host Identifier\&. +.SH DESCRIPTION +The \f3jps\fR command lists the instrumented Java HotSpot VMs on the target system\&. The command is limited to reporting information on JVMs for which it has the access permissions\&. +.PP +If the \f3jps\fR command is run without specifying a \f3hostid\fR, then it searches for instrumented JVMs on the local host\&. If started with a \f3hostid\fR, then it searches for JVMs on the indicated host, using the specified protocol and port\&. A \f3jstatd\fR process is assumed to be running on the target host\&. +.PP +The \f3jps\fR command reports the local JVM identifier, or \f3lvmid\fR, for each instrumented JVM found on the target system\&. The \f3lvmid\fR is typically, but not necessarily, the operating system\&'s process identifier for the JVM process\&. With no options, \f3jps\fR lists each Java application\&'s \f3lvmid\fR followed by the short form of the application\&'s class name or jar file name\&. The short form of the class name or JAR file name omits the class\&'s package information or the JAR files path information\&. +.PP +The \f3jps\fR command uses the Java launcher to find the class name and arguments passed to the main method\&. If the target JVM is started with a custom launcher, then the class or JAR file name and the arguments to the \f3main\fR method are not available\&. In this case, the \f3jps\fR command outputs the string \f3Unknown\fR for the class name or JAR file name and for the arguments to the \f3main\fR method\&. +.PP +The list of JVMs produced by the \f3jps\fR command can be limited by the permissions granted to the principal running the command\&. The command only lists the JVMs for which the principle has access rights as determined by operating system-specific access control mechanisms\&. +.SH OPTIONS +The \f3jps\fR command supports a number of options that modify the output of the command\&. These options are subject to change or removal in the future\&. +.TP +-q +.br +Suppresses the output of the class name, JAR file name, and arguments passed to the \f3main\fR method, producing only a list of local JVM identifiers\&. +.TP +-m +.br +Displays the arguments passed to the \f3main\fR method\&. The output may be \f3null\fR for embedded JVMs\&. +.TP +-l +.br +Displays the full package name for the application\&'s \f3main\fR class or the full path name to the application\&'s JAR file\&. +.TP +-v +.br +Displays the arguments passed to the JVM\&. +.TP +-V +.br +Suppresses the output of the class name, JAR file name, and arguments passed to the main method, producing only a list of local JVM identifiers\&. +.TP +-J\f3option\fR +.br +Passes \f3option\fR to the JVM, where option is one of the \f3options\fR described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH HOST\ IDENTIFIER +The host identifier, or \f3hostid\fR is a string that indicates the target system\&. The syntax of the \f3hostid\fR string corresponds to the syntax of a URI: +.sp +.nf +\f3[protocol:][[//]hostname][:port][/servername]\fP +.fi +.nf +\f3\fP +.fi +.sp +.TP +\fIprotocol\fR +The communications protocol\&. If the \f3protocol\fR is omitted and a \f3hostname\fR is not specified, then the default protocol is a platform-specific, optimized, local protocol\&. If the protocol is omitted and a host name is specified, then the default protocol is \f3rmi\fR\&. +.TP +hostname +A hostname or IP address that indicates the target host\&. If you omit the \f3hostname\fR parameter, then the target host is the local host\&. +.TP +port +The default port for communicating with the remote server\&. If the \f3hostname\fR parameter is omitted or the \f3protocol\fR parameter specifies an optimized, local protocol, then the \f3port\fR parameter is ignored\&. Otherwise, treatment of the \f3port\fR parameter is implementation specific\&. For the default \f3rmi\fR protocol, the \f3port\fR parameter indicates the port number for the rmiregistry on the remote host\&. If the \f3port\fR parameter is omitted, and the \f3protocol\fR parameter indicates \f3rmi\fR, then the default rmiregistry port (1099) is used\&. +.TP +servername +The treatment of this parameter depends on the implementation\&. For the optimized, local protocol, this field is ignored\&. For the \f3rmi\fR protocol, this parameter is a string that represents the name of the RMI remote object on the remote host\&. See the \f3jstatd\fR command \f3-n\fRoption for more information\&. +.SH OUTPUT\ FORMAT +The output of the \f3jps\fR command follows the following pattern: +.sp +.nf +\f3lvmid [ [ classname | JARfilename | "Unknown"] [ arg* ] [ jvmarg* ] ]\fP +.fi +.nf +\f3\fP +.fi +.sp +All output tokens are separated by white space\&. An \f3arg\fR value that includes embedded white space introduces ambiguity when attempting to map arguments to their actual positional parameters\&. +.PP +\fINote:\fR It is recommended that you do not write scripts to parse \f3jps\fR output because the format might change in future releases\&. If you write scripts that parse \f3jps\fR output, then expect to modify them for future releases of this tool\&. +.SH EXAMPLES +This section provides examples of the \f3jps\fR command\&. +.PP +List the instrumented JVMs on the local host: +.sp +.nf +\f3jps\fP +.fi +.nf +\f318027 Java2Demo\&.JAR\fP +.fi +.nf +\f318032 jps\fP +.fi +.nf +\f318005 jstat\fP +.fi +.nf +\f3\fP +.fi +.sp +The following example lists the instrumented JVMs on a remote host\&. This example assumes that the \f3jstat\fR server and either the its internal RMI registry or a separate external rmiregistry process are running on the remote host on the default port (port 1099)\&. It also assumes that the local host has appropriate permissions to access the remote host\&. This example also includes the \f3-l\fR option to output the long form of the class names or JAR file names\&. +.sp +.nf +\f3jps \-l remote\&.domain\fP +.fi +.nf +\f33002 /opt/jdk1\&.7\&.0/demo/jfc/Java2D/Java2Demo\&.JAR\fP +.fi +.nf +\f32857 sun\&.tools\&.jstatd\&.jstatd\fP +.fi +.nf +\f3\fP +.fi +.sp +The following example lists the instrumented JVMs on a remote host with a non-default port for the RMI registry\&. This example assumes that the \f3jstatd\fR server, with an internal RMI registry bound to port 2002, is running on the remote host\&. This example also uses the \f3-m\fR option to include the arguments passed to the \f3main\fR method of each of the listed Java applications\&. +.sp +.nf +\f3jps \-m remote\&.domain:2002\fP +.fi +.nf +\f33002 /opt/jdk1\&.7\&.0/demo/jfc/Java2D/Java2Demo\&.JAR\fP +.fi +.nf +\f33102 sun\&.tools\&.jstatd\&.jstatd \-p 2002\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jstat(1) +.TP 0.2i +\(bu +jstatd(1) +.TP 0.2i +\(bu +rmiregistry(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/jrunscript.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/jrunscript.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,195 +1,195 @@ -'\" t -.\" Copyright (c) 2006, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Scripting Tools -.\" Title: jrunscript.1 -.\" -.if n .pl 99999 -.TH jrunscript 1 "21 November 2013" "JDK 8" "Scripting Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jrunscript \- Runs a command-line script shell that supports interactive and batch modes\&. This command is experimental and unsupported\&. -.SH SYNOPSIS -.sp -.nf - -\fBjrunscript\fR [\fIoptions\fR] [\fIarguments\fR] -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIarguments\fR -Arguments, when used, follow immediately after options or the command name\&. See Arguments\&. -.SH DESCRIPTION -The \f3jrunscript\fR command is a language-independent command-line script shell\&. The \f3jrunscript\fR command supports both an interactive (read-eval-print) mode and a batch (\f3-f\fR option) mode of script execution\&. By default, JavaScript is the language used, but the \f3-l\fR option can be used to specify a different language\&. By using Java to scripting language communication, the \f3jrunscript\fR command supports an exploratory programming style\&. -.SH OPTIONS -.TP --classpath \fIpath\fR -.br -Indicate where any class files are that the script needs to access\&. -.TP --cp \fIpath\fR -.br -Same as \f3-classpath\fR\f3path\fR\&. -.TP --D\fIname\fR=\fIvalue\fR -.br -Sets a Java system property\&. -.TP --J\fIflag\fR -.br -Passes \f3flag\fR directly to the Java Virtual Machine where the \f3jrunscript\fR command is running\&. -.TP --I \fIlanguage\fR -.br -Uses the specified scripting language\&. By default, JavaScript is used\&. To use other scripting languages, you must specify the corresponding script engine\&'s JAR file with the \f3-cp\fR or \f3-classpath\fR option\&. -.TP --e \fIscript\fR -.br -Evaluates the specified script\&. This option can be used to run one-line scripts that are specified completely on the command line\&. -.TP --encoding \fIencoding\fR -.br -Specifies the character encoding used to read script files\&. -.TP --f \fIscript-file\fR -.br -Evaluates the specified script file (batch mode)\&. -.TP --f - -.br -Reads and evaluates a script from standard input (interactive mode)\&. -.TP --help -.br -Displays a help message and exits\&. -.TP --? -.br -Displays a help message and exits\&. -.TP --q -.br -Lists all script engines available and exits\&. -.SH ARGUMENTS -If arguments are present and if no \f3-e\fR or \f3-f\fR option is used, then the first argument is the script file and the rest of the arguments, if any, are passed to the script\&. If arguments and \f3-e\fR or the \f3-f\fR option are used, then all arguments are passed to the script\&. If arguments, \f3-e\fR and \f3-f\fR are missing, then interactive mode is used\&. Script arguments are available to a script in an engine variable named \f3arguments\fR of type \f3String\fR array\&. -.SH EXAMPLES -.SS EXECUTE\ INLINE\ SCRIPTS -.sp -.nf -\f3jrunscript \-e "print(\&'hello world\&')"\fP -.fi -.nf -\f3jrunscript \-e "cat(\&'http://www\&.example\&.com\&')"\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS USE\ SPECIFIED\ LANGUAGE\ AND\ EVALUATE\ THE\ SCRIPT\ FILE -.sp -.nf -\f3jrunscript \-l js \-f test\&.js\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS INTERACTIVE\ MODE -.sp -.nf -\f3jrunscript\fP -.fi -.nf -\f3js> print(\&'Hello World\en\&');\fP -.fi -.nf -\f3Hello World\fP -.fi -.nf -\f3js> 34 + 55\fP -.fi -.nf -\f389\&.0\fP -.fi -.nf -\f3js> t = new java\&.lang\&.Thread(function() { print(\&'Hello World\en\&'); })\fP -.fi -.nf -\f3Thread[Thread\-0,5,main]\fP -.fi -.nf -\f3js> t\&.start()\fP -.fi -.nf -\f3js> Hello World\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3js>\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS RUN\ SCRIPT\ FILE\ WITH\ SCRIPT\ ARGUMENTS -The test\&.js file is the script file\&. The \f3arg1\fR, \f3arg2\fR and \f3arg3\fR arguments are passed to the script\&. The script can access these arguments with an arguments array\&. -.sp -.nf -\f3jrunscript test\&.js arg1 arg2 arg3\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH SEE\ ALSO -If JavaScript is used, then before it evaluates a user defined script, the \f3jrunscript\fR command initializes certain built-in functions and objects\&. These JavaScript built-ins are documented in JsDoc-Toolkit at http://code\&.google\&.com/p/jsdoc-toolkit/ -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2006, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Scripting Tools +.\" Title: jrunscript.1 +.\" +.if n .pl 99999 +.TH jrunscript 1 "21 November 2013" "JDK 8" "Scripting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jrunscript \- Runs a command-line script shell that supports interactive and batch modes\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjrunscript\fR [\fIoptions\fR] [\fIarguments\fR] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIarguments\fR +Arguments, when used, follow immediately after options or the command name\&. See Arguments\&. +.SH DESCRIPTION +The \f3jrunscript\fR command is a language-independent command-line script shell\&. The \f3jrunscript\fR command supports both an interactive (read-eval-print) mode and a batch (\f3-f\fR option) mode of script execution\&. By default, JavaScript is the language used, but the \f3-l\fR option can be used to specify a different language\&. By using Java to scripting language communication, the \f3jrunscript\fR command supports an exploratory programming style\&. +.SH OPTIONS +.TP +-classpath \fIpath\fR +.br +Indicate where any class files are that the script needs to access\&. +.TP +-cp \fIpath\fR +.br +Same as \f3-classpath\fR\f3path\fR\&. +.TP +-D\fIname\fR=\fIvalue\fR +.br +Sets a Java system property\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR directly to the Java Virtual Machine where the \f3jrunscript\fR command is running\&. +.TP +-I \fIlanguage\fR +.br +Uses the specified scripting language\&. By default, JavaScript is used\&. To use other scripting languages, you must specify the corresponding script engine\&'s JAR file with the \f3-cp\fR or \f3-classpath\fR option\&. +.TP +-e \fIscript\fR +.br +Evaluates the specified script\&. This option can be used to run one-line scripts that are specified completely on the command line\&. +.TP +-encoding \fIencoding\fR +.br +Specifies the character encoding used to read script files\&. +.TP +-f \fIscript-file\fR +.br +Evaluates the specified script file (batch mode)\&. +.TP +-f - +.br +Reads and evaluates a script from standard input (interactive mode)\&. +.TP +-help +.br +Displays a help message and exits\&. +.TP +-? +.br +Displays a help message and exits\&. +.TP +-q +.br +Lists all script engines available and exits\&. +.SH ARGUMENTS +If arguments are present and if no \f3-e\fR or \f3-f\fR option is used, then the first argument is the script file and the rest of the arguments, if any, are passed to the script\&. If arguments and \f3-e\fR or the \f3-f\fR option are used, then all arguments are passed to the script\&. If arguments, \f3-e\fR and \f3-f\fR are missing, then interactive mode is used\&. Script arguments are available to a script in an engine variable named \f3arguments\fR of type \f3String\fR array\&. +.SH EXAMPLES +.SS EXECUTE\ INLINE\ SCRIPTS +.sp +.nf +\f3jrunscript \-e "print(\&'hello world\&')"\fP +.fi +.nf +\f3jrunscript \-e "cat(\&'http://www\&.example\&.com\&')"\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS USE\ SPECIFIED\ LANGUAGE\ AND\ EVALUATE\ THE\ SCRIPT\ FILE +.sp +.nf +\f3jrunscript \-l js \-f test\&.js\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS INTERACTIVE\ MODE +.sp +.nf +\f3jrunscript\fP +.fi +.nf +\f3js> print(\&'Hello World\en\&');\fP +.fi +.nf +\f3Hello World\fP +.fi +.nf +\f3js> 34 + 55\fP +.fi +.nf +\f389\&.0\fP +.fi +.nf +\f3js> t = new java\&.lang\&.Thread(function() { print(\&'Hello World\en\&'); })\fP +.fi +.nf +\f3Thread[Thread\-0,5,main]\fP +.fi +.nf +\f3js> t\&.start()\fP +.fi +.nf +\f3js> Hello World\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3js>\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS RUN\ SCRIPT\ FILE\ WITH\ SCRIPT\ ARGUMENTS +The test\&.js file is the script file\&. The \f3arg1\fR, \f3arg2\fR and \f3arg3\fR arguments are passed to the script\&. The script can access these arguments with an arguments array\&. +.sp +.nf +\f3jrunscript test\&.js arg1 arg2 arg3\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +If JavaScript is used, then before it evaluates a user defined script, the \f3jrunscript\fR command initializes certain built-in functions and objects\&. These JavaScript built-ins are documented in JsDoc-Toolkit at http://code\&.google\&.com/p/jsdoc-toolkit/ +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/jsadebugd.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/jsadebugd.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,108 +1,108 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Troubleshooting Tools -.\" Title: jsadebugd.1 -.\" -.if n .pl 99999 -.TH jsadebugd 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jsadebugd \- Attaches to a Java process or core file and acts as a debug server\&. This command is experimental and unsupported\&. -.SH SYNOPSIS -.sp -.nf - -\fBjsadebugd\fR \fIpid\fR [ \fIserver\-id\fR ] -.fi -.nf - -\fBjsadebugd\fR \fIexecutable\fR \fIcore\fR [ \fIserver\-id\fR ] -.fi -.sp -.TP -\fIpid\fR -The process ID of the process to which the debug server attaches\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. At most one instance of the debug server can be attached to a single process\&. -.TP -\fIexecutable\fR -The Java executable from which the core dump was produced\&. -.TP -\fIcore\fR -The core file to which the debug server should attach\&. -.TP -\fIserver-id\fR -An optional unique ID that is needed when multiple debug servers are started on the same machine\&. This ID must be used by remote clients to identify the particular debug server to which to attach\&. Within a single machine, this ID must be unique\&. -.SH DESCRIPTION -The \f3jsadebugd\fR command attaches to a Java process or core file and acts as a debug server\&. Remote clients such as \f3jstack\fR, \f3jmap\fR, and \f3jinfo\fR can attach to the server through Java Remote Method Invocation (RMI)\&. Before you start the \f3jsadebugd\fR command, start the RMI registry with the \f3rmiregistry\fR command as follows where \fI$JAVA_HOME\fR is the JDK installation directory: -.sp -.nf -\f3rmiregistry \-J\-Xbootclasspath/p:$JAVA_HOME/lib/sajdi\&.jar\fP -.fi -.nf -\f3\fP -.fi -.sp -If the RMI registry was not started, then the \f3jsadebugd\fR command starts an RMI registry in a standard (1099) port internally\&. The debug server can be stopped by sending a \f3SIGINT\fR to it\&. To send a SIGINT press \fICtrl+C\fR\&. -.PP -\fINote:\fR This utility is unsupported and may or may not be available in future releases of the JDK\&. In Windows Systems where \f3dbgeng\&.dll\fR is not present, Debugging Tools For Windows must be installed to have these tools working\&. The \f3PATH\fR environment variable should contain the location of jvm\&.dll used by the target process or the location from which the crash dump file was produced\&. For example, \f3s\fR\f3et PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -jinfo(1) -.TP 0.2i -\(bu -jmap(1) -.TP 0.2i -\(bu -jps(1) -.TP 0.2i -\(bu -jstack(1) -.TP 0.2i -\(bu -rmiregistry(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jsadebugd.1 +.\" +.if n .pl 99999 +.TH jsadebugd 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jsadebugd \- Attaches to a Java process or core file and acts as a debug server\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjsadebugd\fR \fIpid\fR [ \fIserver\-id\fR ] +.fi +.nf + +\fBjsadebugd\fR \fIexecutable\fR \fIcore\fR [ \fIserver\-id\fR ] +.fi +.sp +.TP +\fIpid\fR +The process ID of the process to which the debug server attaches\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. At most one instance of the debug server can be attached to a single process\&. +.TP +\fIexecutable\fR +The Java executable from which the core dump was produced\&. +.TP +\fIcore\fR +The core file to which the debug server should attach\&. +.TP +\fIserver-id\fR +An optional unique ID that is needed when multiple debug servers are started on the same machine\&. This ID must be used by remote clients to identify the particular debug server to which to attach\&. Within a single machine, this ID must be unique\&. +.SH DESCRIPTION +The \f3jsadebugd\fR command attaches to a Java process or core file and acts as a debug server\&. Remote clients such as \f3jstack\fR, \f3jmap\fR, and \f3jinfo\fR can attach to the server through Java Remote Method Invocation (RMI)\&. Before you start the \f3jsadebugd\fR command, start the RMI registry with the \f3rmiregistry\fR command as follows where \fI$JAVA_HOME\fR is the JDK installation directory: +.sp +.nf +\f3rmiregistry \-J\-Xbootclasspath/p:$JAVA_HOME/lib/sajdi\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +If the RMI registry was not started, then the \f3jsadebugd\fR command starts an RMI registry in a standard (1099) port internally\&. The debug server can be stopped by sending a \f3SIGINT\fR to it\&. To send a SIGINT press \fICtrl+C\fR\&. +.PP +\fINote:\fR This utility is unsupported and may or may not be available in future releases of the JDK\&. In Windows Systems where \f3dbgeng\&.dll\fR is not present, Debugging Tools For Windows must be installed to have these tools working\&. The \f3PATH\fR environment variable should contain the location of jvm\&.dll used by the target process or the location from which the crash dump file was produced\&. For example, \f3s\fR\f3et PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jinfo(1) +.TP 0.2i +\(bu +jmap(1) +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jstack(1) +.TP 0.2i +\(bu +rmiregistry(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/jstack.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/jstack.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,137 +1,137 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Troubleshooting Tools -.\" Title: jstack.1 -.\" -.if n .pl 99999 -.TH jstack 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jstack \- Prints Java thread stack traces for a Java process, core file, or remote debug server\&. This command is experimental and unsupported\&. -.SH SYNOPSIS -.sp -.nf - -\fBjstack\fR [ \fIoptions\fR ] \fIpid\fR -.fi -.nf - -\fBjstack\fR [ \fIoptions\fR ] \fIexecutable\fR \fIcore\fR -.fi -.nf - -\fBjstack\fR [ \fIoptions\fR ] [ \fIserver\-id\fR@ ] \fIremote\-hostname\-or\-IP\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIpid\fR -The process ID for which the stack trace is printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. -.TP -\fIexecutable\fR -The Java executable from which the core dump was produced\&. -.TP -\fIcore\fR -The core file for which the stack trace is to be printed\&. -.TP -\fIremote-hostname-or-IP\fR -The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. -.TP -\fIserver-id\fR -An optional unique ID to use when multiple debug servers are running on the same remote host\&. -.SH DESCRIPTION -The \f3jstack\fR command prints Java stack traces of Java threads for a specified Java process, core file, or remote debug server\&. For each Java frame, the full class name, method name, byte code index (BCI), and line number, when available, are printed\&. With the \f3-m\fR option, the \f3jstack\fR command prints both Java and native frames of all threads with the program counter (PC)\&. For each native frame, the closest native symbol to PC, when available, is printed\&. C++ mangled names are not demangled\&. To demangle C++ names, the output of this command can be piped to \f3c++filt\fR\&. When the specified process is running on a 64-bit Java Virtual Machine, you might need to specify the \f3-J-d64\fR option, for example: \f3jstack -J-d64 -m pid\fR\&. -.PP -\fINote:\fR This utility is unsupported and might not be available in future release of the JDK\&. In Windows Systems where the dbgeng\&.dll file is not present, Debugging Tools For Windows must be installed so these tools work\&. The \f3PATH\fR environment variable needs to contain the location of the jvm\&.dll that is used by the target process, or the location from which the crash dump file was produced\&. For example: -.sp -.nf -\f3set PATH=<jdk>\ejre\ebin\eclient;%PATH%\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH OPTIONS -.TP --F -.br -Force a stack dump when \f3jstack\fR [\f3-l\fR] \f3pid\fR does not respond\&. -.TP --l -.br -Long listing\&. Prints additional information about locks such as a list of owned \f3java\&.util\&.concurrent\fR ownable synchronizers\&. See the \f3AbstractOwnableSynchronizer\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/util/concurrent/locks/AbstractOwnableSynchronizer\&.html -.TP --m -.br -Prints a mixed mode stack trace that has both Java and native C/C++ frames\&. -.TP --h -.br -Prints a help message\&. -.TP --help -.br -Prints a help message\&. -.SH KNOWN\ BUGS -In mixed mode stack trace, the \f3-m\fR option does not work with the remote debug server\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -pstack(1) -.TP 0.2i -\(bu -C++filt(1) -.TP 0.2i -\(bu -jps(1) -.TP 0.2i -\(bu -jsadebugd(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jstack.1 +.\" +.if n .pl 99999 +.TH jstack 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jstack \- Prints Java thread stack traces for a Java process, core file, or remote debug server\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjstack\fR [ \fIoptions\fR ] \fIpid\fR +.fi +.nf + +\fBjstack\fR [ \fIoptions\fR ] \fIexecutable\fR \fIcore\fR +.fi +.nf + +\fBjstack\fR [ \fIoptions\fR ] [ \fIserver\-id\fR@ ] \fIremote\-hostname\-or\-IP\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIpid\fR +The process ID for which the stack trace is printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. +.TP +\fIexecutable\fR +The Java executable from which the core dump was produced\&. +.TP +\fIcore\fR +The core file for which the stack trace is to be printed\&. +.TP +\fIremote-hostname-or-IP\fR +The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. +.TP +\fIserver-id\fR +An optional unique ID to use when multiple debug servers are running on the same remote host\&. +.SH DESCRIPTION +The \f3jstack\fR command prints Java stack traces of Java threads for a specified Java process, core file, or remote debug server\&. For each Java frame, the full class name, method name, byte code index (BCI), and line number, when available, are printed\&. With the \f3-m\fR option, the \f3jstack\fR command prints both Java and native frames of all threads with the program counter (PC)\&. For each native frame, the closest native symbol to PC, when available, is printed\&. C++ mangled names are not demangled\&. To demangle C++ names, the output of this command can be piped to \f3c++filt\fR\&. When the specified process is running on a 64-bit Java Virtual Machine, you might need to specify the \f3-J-d64\fR option, for example: \f3jstack -J-d64 -m pid\fR\&. +.PP +\fINote:\fR This utility is unsupported and might not be available in future release of the JDK\&. In Windows Systems where the dbgeng\&.dll file is not present, Debugging Tools For Windows must be installed so these tools work\&. The \f3PATH\fR environment variable needs to contain the location of the jvm\&.dll that is used by the target process, or the location from which the crash dump file was produced\&. For example: +.sp +.nf +\f3set PATH=<jdk>\ejre\ebin\eclient;%PATH%\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-F +.br +Force a stack dump when \f3jstack\fR [\f3-l\fR] \f3pid\fR does not respond\&. +.TP +-l +.br +Long listing\&. Prints additional information about locks such as a list of owned \f3java\&.util\&.concurrent\fR ownable synchronizers\&. See the \f3AbstractOwnableSynchronizer\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/util/concurrent/locks/AbstractOwnableSynchronizer\&.html +.TP +-m +.br +Prints a mixed mode stack trace that has both Java and native C/C++ frames\&. +.TP +-h +.br +Prints a help message\&. +.TP +-help +.br +Prints a help message\&. +.SH KNOWN\ BUGS +In mixed mode stack trace, the \f3-m\fR option does not work with the remote debug server\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +pstack(1) +.TP 0.2i +\(bu +C++filt(1) +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jsadebugd(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/jstat.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/jstat.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/bsd/doc/man/jstatd.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/jstatd.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,209 +1,209 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Monitoring Tools -.\" Title: jstatd.1 -.\" -.if n .pl 99999 -.TH jstatd 1 "21 November 2013" "JDK 8" "Monitoring Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jstatd \- Monitors Java Virtual Machines (JVMs) and enables remote monitoring tools to attach to JVMs\&. This command is experimental and unsupported\&. -.SH SYNOPSIS -.sp -.nf - -\fBjstatd\fR [ \fIoptions\fR ] -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.SH DESCRIPTION -The \f3jstatd\fR command is an RMI server application that monitors for the creation and termination of instrumented Java HotSpot VMs and provides an interface to enable remote monitoring tools to attach to JVMs that are running on the local host\&. -.PP -The \f3jstatd\fR server requires an RMI registry on the local host\&. The \f3jstatd\fR server attempts to attach to the RMI registry on the default port, or on the port you specify with the \f3-p\fR\f3port\fR option\&. If an RMI registry is not found, then one is created within the \f3jstatd\fR application that is bound to the port that is indicated by the \f3-p\fR\f3port\fR option or to the default RMI registry port when the \f3-p\fR\f3port\fR option is omitted\&. You can stop the creation of an internal RMI registry by specifying the \f3-nr\fR option\&. -.SH OPTIONS -.TP --nr -.br -Does not attempt to create an internal RMI registry within the \f3jstatd\fR process when an existing RMI registry is not found\&. -.TP --p \fIport\fR -.br -The port number where the RMI registry is expected to be found, or when not found, created if the \f3-nr\fR option is not specified\&. -.TP --n \fIrminame\fR -.br -Name to which the remote RMI object is bound in the RMI registry\&. The default name is \f3JStatRemoteHost\fR\&. If multiple \f3jstatd\fR servers are started on the same host, then the name of the exported RMI object for each server can be made unique by specifying this option\&. However, doing so requires that the unique server name be included in the monitoring client\&'s \f3hostid\fR and \f3vmid\fR strings\&. -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the JVM, where option is one of the \f3options\fR described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH SECURITY -The \f3jstatd\fR server can only monitor JVMs for which it has the appropriate native access permissions\&. Therefore, the \f3jstatd\fR process must be running with the same user credentials as the target JVMs\&. Some user credentials, such as the root user in UNIX-based systems, have permission to access the instrumentation exported by any JVM on the system\&. A \f3jstatd\fR process running with such credentials can monitor any JVM on the system, but introduces additional security concerns\&. -.PP -The \f3jstatd\fR server does not provide any authentication of remote clients\&. Therefore, running a \f3jstatd\fR server process exposes the instrumentation export by all JVMs for which the \f3jstatd\fR process has access permissions to any user on the network\&. This exposure might be undesirable in your environment, and therefore, local security policies should be considered before you start the \f3jstatd\fR process, particularly in production environments or on networks that are not secure\&. -.PP -The \f3jstatd\fR server installs an instance of \f3RMISecurityPolicy\fR when no other security manager is installed, and therefore, requires a security policy file to be specified\&. The policy file must conform to Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html -.PP -The following policy file allows the \f3jstatd\fR server to run without any security exceptions\&. This policy is less liberal than granting all permissions to all code bases, but is more liberal than a policy that grants the minimal permissions to run the \f3jstatd\fR server\&. -.sp -.nf -\f3grant codebase "file:${java\&.home}/\&.\&./lib/tools\&.jar" { \fP -.fi -.nf -\f3 permission java\&.security\&.AllPermission;\fP -.fi -.nf -\f3};\fP -.fi -.nf -\f3\fP -.fi -.sp -To use this policy setting, copy the text into a file called \f3jstatd\&.all\&.policy\fR and run the \f3jstatd\fR server as follows: -.sp -.nf -\f3jstatd \-J\-Djava\&.security\&.policy=jstatd\&.all\&.policy\fP -.fi -.nf -\f3\fP -.fi -.sp -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 address spoofing attacks\&. If your security concerns cannot be addressed with a customized policy file, then the safest action is to not run the \f3jstatd\fR server and use the \f3jstat\fR and \f3jps\fR tools locally\&. -.SH REMOTE\ INTERFACE -The interface exported by the \f3jstatd\fR process is proprietary and guaranteed to change\&. Users and developers are discouraged from writing to this interface\&. -.SH EXAMPLES -The following are examples of the \f3jstatd\fR command\&. The \f3jstatd\fR scripts automatically start the server in the background -.SS INTERNAL\ RMI\ REGISTRY -This example shows hos to start a \f3jstatd\fR session with an internal RMI registry\&. This example assumes that no other server is bound to the default RMI registry port (port 1099)\&. -.sp -.nf -\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS EXTERNAL\ RMI\ REGISTRY -This example starts a \f3jstatd\fR session with a external RMI registry\&. -.sp -.nf -\f3rmiregistry&\fP -.fi -.nf -\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP -.fi -.nf -\f3\fP -.fi -.sp -This example starts a \f3jstatd\fR session with an external RMI registry server on port 2020\&. -.sp -.nf -\f3jrmiregistry 2020&\fP -.fi -.nf -\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-p 2020\fP -.fi -.nf -\f3\fP -.fi -.sp -This example starts a \f3jstatd\fR session with an external RMI registry on port 2020 that is bound to \f3AlternateJstatdServerName\fR\&. -.sp -.nf -\f3rmiregistry 2020&\fP -.fi -.nf -\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-p 2020\fP -.fi -.nf -\f3 \-n AlternateJstatdServerName\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS STOP\ THE\ CREATION\ OF\ AN\ IN-PROCESS\ RMI\ REGISTRY -This example starts a \f3jstatd\fR session that does not create an RMI registry when one is not found\&. This example assumes an RMI registry is already running\&. If an RMI registry is not running, then an error message is displayed\&. -.sp -.nf -\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-nr\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS ENABLE\ RMI\ LOGGING -This example starts a \f3jstatd\fR session with RMI logging capabilities enabled\&. This technique is useful as a troubleshooting aid or for monitoring server activities\&. -.sp -.nf -\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP -.fi -.nf -\f3 \-J\-Djava\&.rmi\&.server\&.logCalls=true\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH SEE\ ALSO -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -jps(1) -.TP 0.2i -\(bu -jstat(1) -.TP 0.2i -\(bu -rmiregistry(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Monitoring Tools +.\" Title: jstatd.1 +.\" +.if n .pl 99999 +.TH jstatd 1 "21 November 2013" "JDK 8" "Monitoring Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jstatd \- Monitors Java Virtual Machines (JVMs) and enables remote monitoring tools to attach to JVMs\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjstatd\fR [ \fIoptions\fR ] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.SH DESCRIPTION +The \f3jstatd\fR command is an RMI server application that monitors for the creation and termination of instrumented Java HotSpot VMs and provides an interface to enable remote monitoring tools to attach to JVMs that are running on the local host\&. +.PP +The \f3jstatd\fR server requires an RMI registry on the local host\&. The \f3jstatd\fR server attempts to attach to the RMI registry on the default port, or on the port you specify with the \f3-p\fR\f3port\fR option\&. If an RMI registry is not found, then one is created within the \f3jstatd\fR application that is bound to the port that is indicated by the \f3-p\fR\f3port\fR option or to the default RMI registry port when the \f3-p\fR\f3port\fR option is omitted\&. You can stop the creation of an internal RMI registry by specifying the \f3-nr\fR option\&. +.SH OPTIONS +.TP +-nr +.br +Does not attempt to create an internal RMI registry within the \f3jstatd\fR process when an existing RMI registry is not found\&. +.TP +-p \fIport\fR +.br +The port number where the RMI registry is expected to be found, or when not found, created if the \f3-nr\fR option is not specified\&. +.TP +-n \fIrminame\fR +.br +Name to which the remote RMI object is bound in the RMI registry\&. The default name is \f3JStatRemoteHost\fR\&. If multiple \f3jstatd\fR servers are started on the same host, then the name of the exported RMI object for each server can be made unique by specifying this option\&. However, doing so requires that the unique server name be included in the monitoring client\&'s \f3hostid\fR and \f3vmid\fR strings\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the JVM, where option is one of the \f3options\fR described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH SECURITY +The \f3jstatd\fR server can only monitor JVMs for which it has the appropriate native access permissions\&. Therefore, the \f3jstatd\fR process must be running with the same user credentials as the target JVMs\&. Some user credentials, such as the root user in UNIX-based systems, have permission to access the instrumentation exported by any JVM on the system\&. A \f3jstatd\fR process running with such credentials can monitor any JVM on the system, but introduces additional security concerns\&. +.PP +The \f3jstatd\fR server does not provide any authentication of remote clients\&. Therefore, running a \f3jstatd\fR server process exposes the instrumentation export by all JVMs for which the \f3jstatd\fR process has access permissions to any user on the network\&. This exposure might be undesirable in your environment, and therefore, local security policies should be considered before you start the \f3jstatd\fR process, particularly in production environments or on networks that are not secure\&. +.PP +The \f3jstatd\fR server installs an instance of \f3RMISecurityPolicy\fR when no other security manager is installed, and therefore, requires a security policy file to be specified\&. The policy file must conform to Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html +.PP +The following policy file allows the \f3jstatd\fR server to run without any security exceptions\&. This policy is less liberal than granting all permissions to all code bases, but is more liberal than a policy that grants the minimal permissions to run the \f3jstatd\fR server\&. +.sp +.nf +\f3grant codebase "file:${java\&.home}/\&.\&./lib/tools\&.jar" { \fP +.fi +.nf +\f3 permission java\&.security\&.AllPermission;\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fP +.fi +.sp +To use this policy setting, copy the text into a file called \f3jstatd\&.all\&.policy\fR and run the \f3jstatd\fR server as follows: +.sp +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=jstatd\&.all\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp +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 address spoofing attacks\&. If your security concerns cannot be addressed with a customized policy file, then the safest action is to not run the \f3jstatd\fR server and use the \f3jstat\fR and \f3jps\fR tools locally\&. +.SH REMOTE\ INTERFACE +The interface exported by the \f3jstatd\fR process is proprietary and guaranteed to change\&. Users and developers are discouraged from writing to this interface\&. +.SH EXAMPLES +The following are examples of the \f3jstatd\fR command\&. The \f3jstatd\fR scripts automatically start the server in the background +.SS INTERNAL\ RMI\ REGISTRY +This example shows hos to start a \f3jstatd\fR session with an internal RMI registry\&. This example assumes that no other server is bound to the default RMI registry port (port 1099)\&. +.sp +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS EXTERNAL\ RMI\ REGISTRY +This example starts a \f3jstatd\fR session with a external RMI registry\&. +.sp +.nf +\f3rmiregistry&\fP +.fi +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp +This example starts a \f3jstatd\fR session with an external RMI registry server on port 2020\&. +.sp +.nf +\f3jrmiregistry 2020&\fP +.fi +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-p 2020\fP +.fi +.nf +\f3\fP +.fi +.sp +This example starts a \f3jstatd\fR session with an external RMI registry on port 2020 that is bound to \f3AlternateJstatdServerName\fR\&. +.sp +.nf +\f3rmiregistry 2020&\fP +.fi +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-p 2020\fP +.fi +.nf +\f3 \-n AlternateJstatdServerName\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS STOP\ THE\ CREATION\ OF\ AN\ IN-PROCESS\ RMI\ REGISTRY +This example starts a \f3jstatd\fR session that does not create an RMI registry when one is not found\&. This example assumes an RMI registry is already running\&. If an RMI registry is not running, then an error message is displayed\&. +.sp +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-nr\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS ENABLE\ RMI\ LOGGING +This example starts a \f3jstatd\fR session with RMI logging capabilities enabled\&. This technique is useful as a troubleshooting aid or for monitoring server activities\&. +.sp +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP +.fi +.nf +\f3 \-J\-Djava\&.rmi\&.server\&.logCalls=true\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jstat(1) +.TP 0.2i +\(bu +rmiregistry(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/keytool.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/keytool.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,1619 +1,1619 @@ -'\" t -.\" Copyright (c) 1998, 2015, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 03 March 2015 -.\" SectDesc: Security Tools -.\" Title: keytool.1 -.\" -.if n .pl 99999 -.TH keytool 1 "03 March 2015" "JDK 8" "Security Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -keytool \- Manages a keystore (database) of cryptographic keys, X\&.509 certificate chains, and trusted certificates\&. -.SH SYNOPSIS -.sp -.nf - -\fBkeytool\fR [\fIcommands\fR] -.fi -.sp -.TP -\fIcommands\fR -See Commands\&. These commands are categorized by task as follows: -.RS -.TP 0.2i -\(bu -Create or Add Data to the Keystore -.RS -.TP 0.2i -\(bu --gencert -.TP 0.2i -\(bu --genkeypair -.TP 0.2i -\(bu --genseckey -.TP 0.2i -\(bu --importcert -.TP 0.2i -\(bu --importpassword -.RE - -.TP 0.2i -\(bu -Import Contents From Another Keystore -.RS -.TP 0.2i -\(bu --importkeystore -.RE - -.TP 0.2i -\(bu -Generate Certificate Request -.RS -.TP 0.2i -\(bu --certreq -.RE - -.TP 0.2i -\(bu -Export Data -.RS -.TP 0.2i -\(bu --exportcert -.RE - -.TP 0.2i -\(bu -Display Data -.RS -.TP 0.2i -\(bu --list -.TP 0.2i -\(bu --printcert -.TP 0.2i -\(bu --printcertreq -.TP 0.2i -\(bu --printcrl -.RE - -.TP 0.2i -\(bu -Manage the Keystore -.RS -.TP 0.2i -\(bu --storepasswd -.TP 0.2i -\(bu --keypasswd -.TP 0.2i -\(bu --delete -.TP 0.2i -\(bu --changealias -.RE - -.TP 0.2i -\(bu -Get Help -.RS -.TP 0.2i -\(bu --help -.RE - -.RE - -.SH DESCRIPTION -The \f3keytool\fR command is a key and certificate management utility\&. It enables users to administer their own public/private key pairs and associated certificates for use in self-authentication (where the user authenticates himself or herself to other users and services) or data integrity and authentication services, using digital signatures\&. The \f3keytool\fR command also enables users to cache the public keys (in the form of certificates) of their communicating peers\&. -.PP -A certificate is a digitally signed statement from one entity (person, company, and so on\&.), that says that the public key (and some other information) of some other entity has a particular value\&. (See Certificate\&.) When data is digitally signed, the signature can be verified to check the data integrity and authenticity\&. Integrity means that the data has not been modified or tampered with, and authenticity means the data comes from whoever claims to have created and signed it\&. -.PP -The \f3keytool\fR command also enables users to administer secret keys and passphrases used in symmetric encryption and decryption (DES)\&. -.PP -The \f3keytool\fR command stores the keys and certificates in a keystore\&. See KeyStore aliases\&. -.SH COMMAND\ AND\ OPTION\ NOTES -See Commands for a listing and description of the various commands\&. -.TP 0.2i -\(bu -All command and option names are preceded by a minus sign (-)\&. -.TP 0.2i -\(bu -The options for each command can be provided in any order\&. -.TP 0.2i -\(bu -All items not italicized or in braces or brackets are required to appear as is\&. -.TP 0.2i -\(bu -Braces surrounding an option signify that a default value will be used when the option is not specified on the command line\&. See Option Defaults\&. Braces are also used around the \f3-v\fR, \f3-rfc\fR, and \f3-J\fR options, which only have meaning when they appear on the command line\&. They do not have any default values other than not existing\&. -.TP 0.2i -\(bu -Brackets surrounding an option signify that the user is prompted for the values when the option is not specified on the command line\&. For the \f3-keypass\fR option, if you do not specify the option on the command line, then the \f3keytool\fR command first attempts to use the keystore password to recover the private/secret key\&. If this attempt fails, then the \f3keytool\fR command prompts you for the private/secret key password\&. -.TP 0.2i -\(bu -Items in italics (option values) represent the actual values that must be supplied\&. For example, here is the format of the \f3-printcert\fR command: -.sp -.nf -\f3keytool \-printcert {\-file \fIcert_file\fR} {\-v}\fP -.fi -.sp - - - - -When you specify a \f3-printcert\fR command, replace \fIcert_file\fR with the actual file name, as follows: \f3keytool -printcert -file VScert\&.cer\fR -.TP 0.2i -\(bu -Option values must be put in quotation marks when they contain a blank (space)\&. -.TP 0.2i -\(bu -The \f3-help\fR option is the default\&. The \f3keytool\fR command is the same as \f3keytool -help\fR\&. -.SH OPTION\ DEFAULTS -The following examples show the defaults for various option values\&. -.sp -.nf -\f3\-alias "mykey"\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\-keyalg\fP -.fi -.nf -\f3 "DSA" (when using \-genkeypair)\fP -.fi -.nf -\f3 "DES" (when using \-genseckey)\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\-keysize\fP -.fi -.nf -\f3 2048 (when using \-genkeypair and \-keyalg is "RSA")\fP -.fi -.nf -\f3 1024 (when using \-genkeypair and \-keyalg is "DSA")\fP -.fi -.nf -\f3 256 (when using \-genkeypair and \-keyalg is "EC")\fP -.fi -.nf -\f3 56 (when using \-genseckey and \-keyalg is "DES")\fP -.fi -.nf -\f3 168 (when using \-genseckey and \-keyalg is "DESede")\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\-validity 90\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\-keystore <the file named \&.keystore in the user\&'s home directory>\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\-storetype <the value of the "keystore\&.type" property in the\fP -.fi -.nf -\f3 security properties file, which is returned by the static\fP -.fi -.nf -\f3 getDefaultType method in java\&.security\&.KeyStore>\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\-file\fP -.fi -.nf -\f3 stdin (if reading)\fP -.fi -.nf -\f3 stdout (if writing)\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\-protected false\fP -.fi -.nf -\f3\fP -.fi -.sp -In generating a public/private key pair, the signature algorithm (\f3-sigalg\fR option) is derived from the algorithm of the underlying private key: -.TP 0.2i -\(bu -If the underlying private key is of type DSA, then the \f3-sigalg\fR option defaults to SHA1withDSA\&. -.TP 0.2i -\(bu -If the underlying private key is of type RSA, then the \f3-sigalg\fR option defaults to SHA256withRSA\&. -.TP 0.2i -\(bu -If the underlying private key is of type EC, then the \f3-sigalg\fR option defaults to SHA256withECDSA\&. -.PP -For a full list of \f3-keyalg\fR and \f3-sigalg\fR arguments, see Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA -.SH COMMON\ OPTIONS -The \f3-v\fR option can appear for all commands except \f3-help\fR\&. When the \f3-v\fR option appears, it signifies verbose mode, which means that more information is provided in the output\&. -.PP -There is also a \f3-Jjavaoption\fR argument that can appear for any command\&. When the \f3-Jjavaoption\fR appears, the specified \f3javaoption\fR string is passed directly to the Java interpreter\&. This option does not contain any spaces\&. It is useful for adjusting the execution environment or memory usage\&. For a list of possible interpreter options, type \f3java -h\fR or \f3java -X\fR at the command line\&. -.PP -These options can appear for all commands operating on a keystore: -.TP --storetype \fIstoretype\fR -.br -This qualifier specifies the type of keystore to be instantiated\&. -.TP --keystore \fIkeystore\fR -.br -The keystore location\&. - -If the JKS \f3storetype\fR is used and a keystore file does not yet exist, then certain \f3keytool\fR commands can result in a new keystore file being created\&. For example, if \f3keytool -genkeypair\fR is called and the \f3-keystore\fR option is not specified, the default keystore file named \f3\&.keystore\fR in the user\&'s home directory is created when it does not already exist\&. Similarly, if the \f3-keystore ks_file\fR option is specified but ks_file does not exist, then it is created\&. For more information on the JKS \f3storetype\fR, see the \fIKeyStore Implementation\fR section in KeyStore aliases\&. - -Note that the input stream from the \f3-keystore\fR option is passed to the \f3KeyStore\&.load\fR method\&. If \f3NONE\fR is specified as the URL, then a null stream is passed to the \f3KeyStore\&.load\fR method\&. \f3NONE\fR should be specified if the keystore is not file-based\&. For example, when it resides on a hardware token device\&. -.TP --storepass[:\fIenv\fR| :\fIfile\fR] argument -.br -The password that is used to protect the integrity of the keystore\&. - -If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the \f3value\fR argument, which must be at least 6 characters long\&. Otherwise, the password is retrieved as follows: -.RS -.TP 0.2i -\(bu -\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. -.TP 0.2i -\(bu -\f3file\fR: Retrieve the password from the file named argument\&. -.RE - - -\fINote:\fR All other options that require passwords, such as \f3-keypass\fR, \f3-srckeypass\fR, -\f3destkeypass\fR, \f3-srcstorepass\fR, and \f3-deststorepass\fR, accept the \fIenv\fR and \fIfile\fR modifiers\&. Remember to separate the password option and the modifier with a colon (:)\&. - -The password must be provided to all commands that access the keystore contents\&. For such commands, when the \f3-storepass\fR option is not provided at the command line, the user is prompted for it\&. - -When retrieving information from the keystore, the password is optional\&. If no password is specified, then the integrity of the retrieved information cannot be verified and a warning is displayed\&. -.TP --providerName \fIprovider_name\fR -.br -Used to identify a cryptographic service provider\&'s name when listed in the security properties file\&. -.TP --providerClass \fIprovider_class_name\fR -.br -Used to specify the name of a cryptographic service provider\&'s master class file when the service provider is not listed in the security properties file\&. -.TP --providerArg \fIprovider_arg\fR -.br -Used with the \f3-providerClass\fR option to represent an optional string input argument for the constructor of \f3provider_class_name\fR\&. -.TP --protected -.br -Either \f3true\fR or \f3false\fR\&. This value should be specified as \f3true\fR when a password must be specified by way of a protected authentication path such as a dedicated PIN reader\&.Because there are two keystores involved in the \f3-importkeystore\fR command, the following two options \f3-srcprotected\fR and -\f3destprotected\fR are provided for the source keystore and the destination keystore respectively\&. -.TP --ext \fI{name{:critical} {=value}}\fR -.br -Denotes an X\&.509 certificate extension\&. The option can be used in \f3-genkeypair\fR and \f3-gencert\fR to embed extensions into the certificate generated, or in \f3-certreq\fR to show what extensions are requested in the certificate request\&. The option can appear multiple times\&. The \f3name\fR argument can be a supported extension name (see Named Extensions) or an arbitrary OID number\&. The \f3value\fR argument, when provided, denotes the argument for the extension\&. When \fIvalue\fR is omitted, that means that the default value of the extension or the extension requires no argument\&. The \f3:critical\fR modifier, when provided, means the extension\&'s \f3isCritical\fR attribute is \f3true\fR; otherwise, it is \f3false\fR\&. You can use \f3:c\fR in place of \f3:critical\fR\&. -.SH NAMED\ EXTENSIONS -The \f3keytool\fR command supports these named extensions\&. The names are not case-sensitive)\&. -.TP -BC or BasicContraints -\fIValues\fR: The full form is: \f3ca:{true|false}[,pathlen:<len>]\fR or \f3<len>\fR, which is short for \f3ca:true,pathlen:<len>\fR\&. When <\f3len\fR> is omitted, you have \f3ca:true\fR\&. -.TP -KU or KeyUsage -\fIValues\fR: \f3usage\fR(,\f3usage\fR)*, where \fIusage\fR can be one of \f3digitalSignature\fR, \f3nonRepudiation\fR (contentCommitment), \f3keyEncipherment\fR, \f3dataEncipherment\fR, \f3keyAgreement\fR, \f3keyCertSign\fR, \f3cRLSign\fR, \f3encipherOnly\fR, \f3decipherOnly\fR\&. The \fIusage\fR argument can be abbreviated with the first few letters (\f3dig\fR for \f3digitalSignature\fR) or in camel-case style (\f3dS\fR for \f3digitalSignature\fR or \f3cRLS\fR for \f3cRLSign\fR), as long as no ambiguity is found\&. The \f3usage\fR values are case-sensitive\&. -.TP -EKU or ExtendedKeyUsage -\fIValues\fR: \f3usage\fR(,\f3usage\fR)*, where \fIusage\fR can be one of \f3anyExtendedKeyUsage\fR, \f3serverAuth\fR, \f3clientAuth\fR, \f3codeSigning\fR, \f3emailProtection\fR, \f3timeStamping\fR, \f3OCSPSigning\fR, or any \fIOID string\fR\&. The \fIusage\fR argument can be abbreviated with the first few letters or in camel-case style, as long as no ambiguity is found\&. The \f3usage\fR values are case-sensitive\&. -.TP -SAN or SubjectAlternativeName -\fIValues\fR: \f3type\fR:\f3value\fR(,t\f3ype:value\fR)*, where \f3type\fR can be \f3EMAIL\fR, \f3URI\fR, \f3DNS\fR, \f3IP\fR, or \f3OID\fR\&. The \f3value\fR argument is the string format value for the \f3type\fR\&. -.TP -IAN or IssuerAlternativeName -\fIValues\fR: Same as \f3SubjectAlternativeName\fR\&. -.TP -SIA or SubjectInfoAccess -\fIValues\fR: \f3method\fR:\f3location-type\fR:\f3location-value\fR (,\f3method:location-type\fR:\f3location-value\fR)*, where \f3method\fR can be \f3timeStamping\fR, \f3caRepository\fR or any OID\&. The \f3location-type\fR and \f3location-value\fR arguments can be any \f3type\fR:\f3value\fR supported by the \f3SubjectAlternativeName\fR extension\&. -.TP -AIA or AuthorityInfoAccess -\fIValues\fR: Same as \f3SubjectInfoAccess\fR\&. The \f3method\fR argument can be \f3ocsp\fR,\f3caIssuers\fR, or any OID\&. -.PP -When \f3name\fR is OID, the value is the hexadecimal dumped DER encoding of the \f3extnValue\fR for the extension excluding the OCTET STRING type and length bytes\&. Any extra character other than standard hexadecimal numbers (0-9, a-f, A-F) are ignored in the HEX string\&. Therefore, both 01:02:03:04 and 01020304 are accepted as identical values\&. When there is no value, the extension has an empty value field\&. -.PP -A special name \f3honored\fR, used in \f3-gencert\fR only, denotes how the extensions included in the certificate request should be honored\&. The value for this name is a comma separated list of \f3all\fR (all requested extensions are honored), \f3name{:[critical|non-critical]}\fR (the named extension is honored, but using a different \f3isCritical\fR attribute) and \f3-name\fR (used with \f3all\fR, denotes an exception)\&. Requested extensions are not honored by default\&. -.PP -If, besides the\f3-ext honored\fR option, another named or OID \f3-ext\fR option is provided, this extension is added to those already honored\&. However, if this name (or OID) also appears in the honored value, then its value and criticality overrides the one in the request\&. -.PP -The \f3subjectKeyIdentifier\fR extension is always created\&. For non-self-signed certificates, the \f3authorityKeyIdentifier\fR is created\&. -.PP -\fINote:\fR Users should be aware that some combinations of extensions (and other certificate fields) may not conform to the Internet standard\&. See Certificate Conformance Warning\&. -.SH COMMANDS -.TP --gencert -.sp -.nf -\f3{\-rfc} {\-infile \fIinfile\fR} {\-outfile \fIoutfile\fR} {\-alias \fIalias\fR} {\-sigalg \fIsigalg\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-dname \fIdname\fR} {\-startdate \fIstartdate\fR {\-ext \fIext\fR}* {\-validity \fIvalDays\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-keypass \fIkeypass\fR] {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP -.fi -.sp -.sp -.nf -\f3{\-storetype \fIstoretype\fR} {\-providername \fIprovider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-v} {\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Generates a certificate as a response to a certificate request file (which can be created by the \f3keytool\fR\f3-certreq\fR command)\&. The command reads the request from \fIinfile\fR (if omitted, from the standard input), signs it using alias\&'s private key, and outputs the X\&.509 certificate into \fIoutfile\fR (if omitted, to the standard output)\&. When\f3-rfc\fR is specified, the output format is Base64-encoded PEM; otherwise, a binary DER is created\&. - -The \f3sigalg\fR value specifies the algorithm that should be used to sign the certificate\&. The \f3startdate\fR argument is the start time and date that the certificate is valid\&. The \f3valDays\fR argument tells the number of days for which the certificate should be considered valid\&. - -When \f3dname\fR is provided, it is used as the subject of the generated certificate\&. Otherwise, the one from the certificate request is used\&. - -The \f3ext\fR value shows what X\&.509 extensions will be embedded in the certificate\&. Read Common Options for the grammar of \f3-ext\fR\&. - -The \f3-gencert\fR option enables you to create certificate chains\&. The following example creates a certificate, \f3e1\fR, that contains three certificates in its certificate chain\&. - -The following commands creates four key pairs named \f3ca\fR, \f3ca1\fR, \f3ca2\fR, and \f3e1\fR: -.sp -.nf -\f3keytool \-alias ca \-dname CN=CA \-genkeypair\fP -.fi -.nf -\f3keytool \-alias ca1 \-dname CN=CA \-genkeypair\fP -.fi -.nf -\f3keytool \-alias ca2 \-dname CN=CA \-genkeypair\fP -.fi -.nf -\f3keytool \-alias e1 \-dname CN=E1 \-genkeypair\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The following two commands create a chain of signed certificates; \f3ca\fR signs \f3ca1\fR and \f3ca1\fR signs \f3ca2\fR, all of which are self-issued: -.sp -.nf -\f3keytool \-alias ca1 \-certreq |\fP -.fi -.nf -\f3 keytool \-alias ca \-gencert \-ext san=dns:ca1 |\fP -.fi -.nf -\f3 keytool \-alias ca1 \-importcert\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3keytool \-alias ca2 \-certreq |\fP -.fi -.nf -\f3 $KT \-alias ca1 \-gencert \-ext san=dns:ca2 |\fP -.fi -.nf -\f3 $KT \-alias ca2 \-importcert\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The following command creates the certificate \f3e1\fR and stores it in the file \f3e1\&.cert\fR, which is signed by \f3ca2\fR\&. As a result, \f3e1\fR should contain \f3ca\fR, \f3ca1\fR, and \f3ca2\fR in its certificate chain: -.sp -.nf -\f3keytool \-alias e1 \-certreq | keytool \-alias ca2 \-gencert > e1\&.cert\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --genkeypair -.sp -.nf -\f3{\-alias \fIalias\fR} {\-keyalg \fIkeyalg\fR} {\-keysize \fIkeysize\fR} {\-sigalg \fIsigalg\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-dname \fIdname\fR] [\-keypass \fIkeypass\fR] {\-startdate \fIvalue\fR} {\-ext \fIext\fR}*\fP -.fi -.sp -.sp -.nf -\f3{\-validity \fIvalDays\fR} {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-storepass \fIstorepass\fR]\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-v} {\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Generates a key pair (a public key and associated private key)\&. Wraps the public key into an X\&.509 v3 self-signed certificate, which is stored as a single-element certificate chain\&. This certificate chain and the private key are stored in a new keystore entry identified by alias\&. - -The \f3keyalg\fR value specifies the algorithm to be used to generate the key pair, and the \f3keysize\fR value specifies the size of each key to be generated\&. The \f3sigalg\fR value specifies the algorithm that should be used to sign the self-signed certificate\&. This algorithm must be compatible with the \f3keyalg\fR value\&. - -The \f3dname\fR value specifies the X\&.500 Distinguished Name to be associated with the value of \f3alias\fR, and is used as the issuer and subject fields in the self-signed certificate\&. If no distinguished name is provided at the command line, then the user is prompted for one\&. - -The value of \f3keypass\fR is a password used to protect the private key of the generated key pair\&. If no password is provided, then the user is prompted for it\&. If you press \fIthe Return key\fR at the prompt, then the key password is set to the same password as the keystore password\&. The \f3keypass\fR value must be at least 6 characters\&. - -The value of \f3startdate\fR specifies the issue time of the certificate, also known as the "Not Before" value of the X\&.509 certificate\&'s Validity field\&. - -The option value can be set in one of these two forms: - -\f3([+-]nnn[ymdHMS])+\fR - -\f3[yyyy/mm/dd] [HH:MM:SS]\fR - -With the first form, the issue time is shifted by the specified value from the current time\&. The value is a concatenation of a sequence of subvalues\&. Inside each subvalue, the plus sign (+) means shift forward, and the minus sign (-) means shift backward\&. The time to be shifted is \f3nnn\fR units of years, months, days, hours, minutes, or seconds (denoted by a single character of \f3y\fR, \f3m\fR, \f3d\fR, \f3H\fR, \f3M\fR, or \f3S\fR respectively)\&. The exact value of the issue time is calculated using the \f3java\&.util\&.GregorianCalendar\&.add(int field, int amount)\fR method on each subvalue, from left to right\&. For example, by specifying, the issue time will be: -.sp -.nf -\f3Calendar c = new GregorianCalendar();\fP -.fi -.nf -\f3c\&.add(Calendar\&.YEAR, \-1);\fP -.fi -.nf -\f3c\&.add(Calendar\&.MONTH, 1);\fP -.fi -.nf -\f3c\&.add(Calendar\&.DATE, \-1);\fP -.fi -.nf -\f3return c\&.getTime()\fP -.fi -.nf -\f3\fP -.fi -.sp - - -With the second form, the user sets the exact issue time in two parts, year/month/day and hour:minute:second (using the local time zone)\&. The user can provide only one part, which means the other part is the same as the current date (or time)\&. The user must provide the exact number of digits as shown in the format definition (padding with 0 when shorter)\&. When both the date and time are provided, there is one (and only one) space character between the two parts\&. The hour should always be provided in 24 hour format\&. - -When the option is not provided, the start date is the current time\&. The option can be provided at most once\&. - -The value of \f3valDays\fR specifies the number of days (starting at the date specified by \f3-startdate\fR, or the current date when \f3-startdate\fR is not specified) for which the certificate should be considered valid\&. - -This command was named \f3-genkey\fR in earlier releases\&. The old name is still supported in this release\&. The new name, \f3-genkeypair\fR, is preferred going forward\&. -.TP --genseckey -.sp -.nf -\f3{\-alias \fIalias\fR} {\-keyalg \fIkeyalg\fR} {\-keysize \fIkeysize\fR} [\-keypass \fIkeypass\fR]\fP -.fi -.sp -.sp -.nf -\f3{\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}} {\-v}\fP -.fi -.sp -.sp -.nf -\f3{\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Generates a secret key and stores it in a new \f3KeyStore\&.SecretKeyEntry\fR identified by \f3alias\fR\&. - -The value of \f3keyalg\fR specifies the algorithm to be used to generate the secret key, and the value of \f3keysize\fR specifies the size of the key to be generated\&. The \f3keypass\fR value is a password that protects the secret key\&. If no password is provided, then the user is prompted for it\&. If you press the Return key at the prompt, then the key password is set to the same password that is used for the \f3keystore\fR\&. The \f3keypass\fR value must be at least 6 characters\&. -.TP --importcert -.sp -.nf -\f3{\-alias \fIalias\fR} {\-file \fIcert_file\fR} [\-keypass \fIkeypass\fR] {\-noprompt} {\-trustcacerts}\fP -.fi -.sp -.sp -.nf -\f3{\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP -.fi -.sp -.sp -.nf -\f3{\-providerName \fIprovider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-v} {\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Reads the certificate or certificate chain (where the latter is supplied in a PKCS#7 formatted reply or a sequence of X\&.509 certificates) from the file \f3cert_file\fR, and stores it in the \f3keystore\fR entry identified by \f3alias\fR\&. If no file is specified, then the certificate or certificate chain is read from \f3stdin\fR\&. - -The \f3keytool\fR command can import X\&.509 v1, v2, and v3 certificates, and PKCS#7 formatted certificate chains consisting of certificates of that type\&. The data to be imported must be provided either in binary encoding format or in printable encoding format (also known as Base64 encoding) as defined by the Internet RFC 1421 standard\&. In the latter case, the encoding must be bounded at the beginning by a string that starts with \f3-\fR\f3----BEGIN\fR, and bounded at the end by a string that starts with \f3-----END\fR\&. - -You import a certificate for two reasons: To add it to the list of trusted certificates, and to import a certificate reply received from a certificate authority (CA) as the result of submitting a Certificate Signing Request to that CA (see the \f3-certreq\fR option in Commands)\&. - -Which type of import is intended is indicated by the value of the \f3-alias\fR option\&. If the alias does not point to a key entry, then the \f3keytool\fR command assumes you are adding a trusted certificate entry\&. In this case, the alias should not already exist in the keystore\&. If the alias does already exist, then the \f3keytool\fR command outputs an error because there is already a trusted certificate for that alias, and does not import the certificate\&. If the alias points to a key entry, then the \f3keytool\fR command assumes you are importing a certificate reply\&. -.TP --importpassword -.sp -.nf -\f3{\-alias \fIalias\fR} [\-keypass \fIkeypass\fR] {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-storepass \fIstorepass\fR]\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-v} {\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Imports a passphrase and stores it in a new \f3KeyStore\&.SecretKeyEntry\fR identified by \f3alias\fR\&. The passphrase may be supplied via the standard input stream; otherwise the user is prompted for it\&. \f3keypass\fR is a password used to protect the imported passphrase\&. If no password is provided, the user is prompted for it\&. If you press the Return key at the prompt, the key password is set to the same password as that used for the \f3keystore\fR\&. \f3keypass\fR must be at least 6 characters long\&. -.TP --importkeystore -.sp -.nf -\f3{\-srcstoretype \fIsrcstoretype\fR} {\-deststoretype \fIdeststoretype\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-srcstorepass \fIsrcstorepass\fR] [\-deststorepass \fIdeststorepass\fR] {\-srcprotected}\fP -.fi -.sp -.sp -.nf -\f3{\-destprotected} \fP -.fi -.sp -.sp -.nf -\f3{\-srcalias \fIsrcalias\fR {\-destalias \fIdestalias\fR} [\-srckeypass \fIsrckeypass\fR]} \fP -.fi -.sp -.sp -.nf -\f3[\-destkeypass \fIdestkeypass\fR] {\-noprompt}\fP -.fi -.sp -.sp -.nf -\f3{\-srcProviderName \fIsrc_provider_name\fR} {\-destProviderName \fIdest_provider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}} {\-v}\fP -.fi -.sp -.sp -.nf -\f3{\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Imports a single entry or all entries from a source keystore to a destination keystore\&. - -When the \f3-srcalias\fR option is provided, the command imports the single entry identified by the alias to the destination keystore\&. If a destination alias is not provided with \f3destalias\fR, then \f3srcalias\fR is used as the destination alias\&. If the source entry is protected by a password, then \f3srckeypass\fR is used to recover the entry\&. If \fIsrckeypass\fR is not provided, then the \f3keytool\fR command attempts to use \f3srcstorepass\fR to recover the entry\&. If \f3srcstorepass\fR is either not provided or is incorrect, then the user is prompted for a password\&. The destination entry is protected with \f3destkeypass\fR\&. If \f3destkeypass\fR is not provided, then the destination entry is protected with the source entry password\&. For example, most third-party tools require \f3storepass\fR and \f3keypass\fR in a PKCS #12 keystore to be the same\&. In order to create a PKCS #12 keystore for these tools, always specify a \f3-destkeypass\fR to be the same as \f3-deststorepass\fR\&. - -If the \f3-srcalias\fR option is not provided, then all entries in the source keystore are imported into the destination keystore\&. Each destination entry is stored under the alias from the source entry\&. If the source entry is protected by a password, then \f3srcstorepass\fR is used to recover the entry\&. If \f3srcstorepass\fR is either not provided or is incorrect, then the user is prompted for a password\&. If a source keystore entry type is not supported in the destination keystore, or if an error occurs while storing an entry into the destination keystore, then the user is prompted whether to skip the entry and continue or to quit\&. The destination entry is protected with the source entry password\&. - -If the destination alias already exists in the destination keystore, then the user is prompted to either overwrite the entry or to create a new entry under a different alias name\&. - -If the \f3-noprompt\fR option is provided, then the user is not prompted for a new destination alias\&. Existing entries are overwritten with the destination alias name\&. Entries that cannot be imported are skipped and a warning is displayed\&. -.TP --printcertreq -.sp -.nf -\f3{\-file \fIfile\fR}\fP -.fi -.sp - - -Prints the content of a PKCS #10 format certificate request, which can be generated by the \f3keytool\fR\f3-certreq\fR command\&. The command reads the request from file\&. If there is no file, then the request is read from the standard input\&. -.TP --certreq -.sp -.nf -\f3{\-alias \fIalias\fR} {\-dname \fIdname\fR} {\-sigalg \fIsigalg\fR} {\-file \fIcertreq_file\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-keypass \fIkeypass\fR] {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-v} {\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Generates a Certificate Signing Request (CSR) using the PKCS #10 format\&. - -A CSR is intended to be sent to a certificate authority (CA)\&. The CA authenticates the certificate requestor (usually off-line) and will return a certificate or certificate chain, used to replace the existing certificate chain (which initially consists of a self-signed certificate) in the keystore\&. - -The private key associated with alias is used to create the PKCS #10 certificate request\&. To access the private key, the correct password must be provided\&. If \f3keypass\fR is not provided at the command line and is different from the password used to protect the integrity of the keystore, then the user is prompted for it\&. If \f3dname\fR is provided, then it is used as the subject in the CSR\&. Otherwise, the X\&.500 Distinguished Name associated with alias is used\&. - -The \f3sigalg\fR value specifies the algorithm that should be used to sign the CSR\&. - -The CSR is stored in the file certreq_file\&. If no file is specified, then the CSR is output to \f3stdout\fR\&. - -Use the \f3importcert\fR command to import the response from the CA\&. -.TP --exportcert -.sp -.nf -\f3{\-alias \fIalias\fR} {\-file \fIcert_file\fR} {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-rfc} {\-v} {\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Reads from the keystore the certificate associated with \fIalias\fR and stores it in the cert_file file\&. When no file is specified, the certificate is output to \f3stdout\fR\&. - -The certificate is by default output in binary encoding\&. If the \f3-rfc\fR option is specified, then the output in the printable encoding format defined by the Internet RFC 1421 Certificate Encoding Standard\&. - -If \f3alias\fR refers to a trusted certificate, then that certificate is output\&. Otherwise, \f3alias\fR refers to a key entry with an associated certificate chain\&. In that case, the first certificate in the chain is returned\&. This certificate authenticates the public key of the entity addressed by \f3alias\fR\&. - -This command was named \f3-export\fR in earlier releases\&. The old name is still supported in this release\&. The new name, \f3-exportcert\fR, is preferred going forward\&. -.TP --list -.sp -.nf -\f3{\-alias \fIalias\fR} {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP -.fi -.sp -.sp -.nf -\f3{\-providerName \fIprovider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-v | \-rfc} {\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Prints to \f3stdout\fR the contents of the keystore entry identified by \f3alias\fR\&. If no \f3alias\fR is specified, then the contents of the entire keystore are printed\&. - -This command by default prints the SHA1 fingerprint of a certificate\&. If the \f3-v\fR option is specified, then the certificate is printed in human-readable format, with additional information such as the owner, issuer, serial number, and any extensions\&. If the \f3-rfc\fR option is specified, then the certificate contents are printed using the printable encoding format, as defined by the Internet RFC 1421 Certificate Encoding Standard\&. - -You cannot specify both \f3-v\fR and \f3-rfc\fR\&. -.TP --printcert -.sp -.nf -\f3{\-file \fIcert_file\fR | \-sslserver \fIhost\fR[:\fIport\fR]} {\-jarfile \fIJAR_file\fR {\-rfc} {\-v}\fP -.fi -.sp -.sp -.nf -\f3{\-Jjavaoption}\fP -.fi -.sp - - -Reads the certificate from the file cert_file, the SSL server located at host:port, or the signed JAR file \f3JAR_file\fR (with the \f3-jarfile\fR option and prints its contents in a human-readable format\&. When no port is specified, the standard HTTPS port 443 is assumed\&. Note that \f3-sslserver\fR and -file options cannot be provided at the same time\&. Otherwise, an error is reported\&. If neither option is specified, then the certificate is read from \f3stdin\fR\&. - -When\f3-rfc\fR is specified, the \f3keytool\fR command prints the certificate in PEM mode as defined by the Internet RFC 1421 Certificate Encoding standard\&. See Internet RFC 1421 Certificate Encoding Standard\&. - -If the certificate is read from a file or \f3stdin\fR, then it might be either binary encoded or in printable encoding format, as defined by the RFC 1421 Certificate Encoding standard\&. - -If the SSL server is behind a firewall, then the \f3-J-Dhttps\&.proxyHost=proxyhost\fR and \f3-J-Dhttps\&.proxyPort=proxyport\fR options can be specified on the command line for proxy tunneling\&. See Java Secure Socket Extension (JSSE) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide\&.html - -\fINote:\fR This option can be used independently of a keystore\&. -.TP --printcrl -.sp -.nf -\f3\-file \fIcrl_\fR {\-v}\fP -.fi -.sp - - -Reads the Certificate Revocation List (CRL) from the file \f3crl_\fR\&. A CRL is a list of digital certificates that were revoked by the CA that issued them\&. The CA generates the \f3crl_\fR file\&. - -\fINote:\fR This option can be used independently of a keystore\&. -.TP --storepasswd -.sp -.nf -\f3[\-new \fInew_storepass\fR] {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-v} {\-Jjavaoption}\fP -.fi -.sp - - -Changes the password used to protect the integrity of the keystore contents\&. The new password is \f3new_storepass\fR, which must be at least 6 characters\&. -.TP --keypasswd -.sp -.nf -\f3{\-alias \fIalias\fR} [\-keypass \fIold_keypass\fR] [\-new \fInew_keypass\fR] {\-storetype \fIstoretype\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}} {\-v}\fP -.fi -.sp -.sp -.nf -\f3{\-Jjavaoption}\fP -.fi -.sp - - -Changes the password under which the private/secret key identified by \f3alias\fR is protected, from \f3old_keypass\fR to \f3new_keypass\fR, which must be at least 6 characters\&. - -If the \f3-keypass\fR option is not provided at the command line, and the key password is different from the keystore password, then the user is prompted for it\&. - -If the \f3-new\fR option is not provided at the command line, then the user is prompted for it -.TP --delete -.sp -.nf -\f3[\-alias \fIalias\fR] {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP -.fi -.sp -.sp -.nf -\f3{\-providerName \fIprovider_name\fR} \fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-v} {\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Deletes from the keystore the entry identified by \f3alias\fR\&. The user is prompted for the alias, when no alias is provided at the command line\&. -.TP --changealias -.sp -.nf -\f3{\-alias \fIalias\fR} [\-destalias \fIdestalias\fR] [\-keypass \fIkeypass\fR] {\-storetype \fIstoretype\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}} {\-v}\fP -.fi -.sp -.sp -.nf -\f3{\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Move an existing keystore entry from the specified \f3alias\fR to a new alias, \f3destalias\fR\&. If no destination alias is provided, then the command prompts for one\&. If the original entry is protected with an entry password, then the password can be supplied with the \f3-keypass\fR option\&. If no key password is provided, then the \f3storepass\fR (if provided) is attempted first\&. If the attempt fails, then the user is prompted for a password\&. -.TP --help -.br -Lists the basic commands and their options\&. - -For more information about a specific command, enter the following, where \f3command_name\fR is the name of the command: \f3keytool -command_name -help\fR\&. -.SH EXAMPLES -This example walks through the sequence of steps to create a keystore for managing public/private key pair and certificates from trusted entities\&. -.SS GENERATE\ THE\ KEY\ PAIR -First, create a keystore and generate the key pair\&. You can use a command such as the following typed as a single line: -.sp -.nf -\f3keytool \-genkeypair \-dname "cn=Mark Jones, ou=Java, o=Oracle, c=US"\fP -.fi -.nf -\f3 \-alias business \-keypass <new password for private key>\fP -.fi -.nf -\f3 \-keystore /working/mykeystore\fP -.fi -.nf -\f3 \-storepass <new password for keystore> \-validity 180\fP -.fi -.nf -\f3\fP -.fi -.sp -The command creates the keystore named \f3mykeystore\fR in the working directory (assuming it does not already exist), and assigns it the password specified by \f3<new password for keystore>\fR\&. It generates a public/private key pair for the entity whose distinguished name has a common name of Mark Jones, organizational unit of Java, organization of Oracle and two-letter country code of US\&. It uses the default DSA key generation algorithm to create the keys; both are 1024 bits\&. -.PP -The command uses the default SHA1withDSA signature algorithm to create a self-signed certificate that includes the public key and the distinguished name information\&. The certificate is valid for 180 days, and is associated with the private key in a keystore entry referred to by the alias \f3business\fR\&. The private key is assigned the password specified by \f3<new password for private key>\fR\&. -.PP -The command is significantly shorter when the option defaults are accepted\&. In this case, no options are required, and the defaults are used for unspecified options that have default values\&. You are prompted for any required values\&. You could have the following: -.sp -.nf -\f3keytool \-genkeypair\fP -.fi -.nf -\f3\fP -.fi -.sp -In this case, a keystore entry with the alias \f3mykey\fR is created, with a newly generated key pair and a certificate that is valid for 90 days\&. This entry is placed in the keystore named \f3\&.keystore\fR in your home directory\&. The keystore is created when it does not already exist\&. You are prompted for the distinguished name information, the keystore password, and the private key password\&. -.PP -The rest of the examples assume you executed the \f3-genkeypair\fR command without options specified, and that you responded to the prompts with values equal to those specified in the first \f3-genkeypair\fR command\&. For example, a distinguished name of \f3cn=Mark Jones\fR, \f3ou=Java\fR, \f3o=Oracle\fR, \f3c=US\fR)\&. -.SS REQUEST\ A\ SIGNED\ CERTIFICATE\ FROM\ A\ CA -Generating the key pair created a self-signed certificate\&. A certificate is more likely to be trusted by others when it is signed by a Certification Authority (CA)\&. To get a CA signature, first generate a Certificate Signing Request (CSR), as follows: -.sp -.nf -\f3keytool \-certreq \-file MarkJ\&.csr\fP -.fi -.nf -\f3\fP -.fi -.sp -This creates a CSR for the entity identified by the default alias \f3mykey\fR and puts the request in the file named MarkJ\&.csr\&. Submit this file to a CA, such as VeriSign\&. The CA authenticates you, the requestor (usually off-line), and returns a certificate, signed by them, authenticating your public key\&. In some cases, the CA returns a chain of certificates, each one authenticating the public key of the signer of the previous certificate in the chain\&. -.SS IMPORT\ A\ CERTIFICATE\ FOR\ THE\ CA -You now need to replace the self-signed certificate with a certificate chain, where each certificate in the chain authenticates the public key of the signer of the previous certificate in the chain, up to a root CA\&. -.PP -Before you import the certificate reply from a CA, you need one or more trusted certificates in your keystore or in the \f3cacerts\fR keystore file\&. See \f3-importcert\fR in Commands\&. -.TP 0.2i -\(bu -If the certificate reply is a certificate chain, then you need the top certificate of the chain\&. The root CA certificate that authenticates the public key of the CA\&. -.TP 0.2i -\(bu -If the certificate reply is a single certificate, then you need a certificate for the issuing CA (the one that signed it)\&. If that certificate is not self-signed, then you need a certificate for its signer, and so on, up to a self-signed root CA certificate\&. -.PP -The \f3cacerts\fR keystore file ships with several VeriSign root CA certificates, so you probably will not need to import a VeriSign certificate as a trusted certificate in your keystore\&. But if you request a signed certificate from a different CA, and a certificate authenticating that CA\&'s public key was not added to \f3cacerts\fR, then you must import a certificate from the CA as a trusted certificate\&. -.PP -A certificate from a CA is usually either self-signed or signed by another CA, in which case you need a certificate that authenticates that CA\&'s public key\&. Suppose company ABC, Inc\&., is a CA, and you obtain a file named A\f3BCCA\&.cer\fR that is supposed to be a self-signed certificate from ABC, that authenticates that CA\&'s public key\&. Be careful to ensure the certificate is valid before you import it as a trusted certificate\&. View it first with the \f3keytool -printcert\fR command or the \f3keytool -importcert\fR command without the \f3-noprompt\fR option, and make sure that the displayed certificate fingerprints match the expected ones\&. You can call the person who sent the certificate, and compare the fingerprints that you see with the ones that they show or that a secure public key repository shows\&. Only when the fingerprints are equal is it guaranteed that the certificate was not replaced in transit with somebody else\&'s (for example, an attacker\&'s) certificate\&. If such an attack takes place, and you did not check the certificate before you imported it, then you would be trusting anything the attacker has signed\&. -.PP -If you trust that the certificate is valid, then you can add it to your keystore with the following command: -.sp -.nf -\f3keytool \-importcert \-alias abc \-file ABCCA\&.cer\fP -.fi -.nf -\f3\fP -.fi -.sp -This command creates a trusted certificate entry in the keystore, with the data from the file ABCCA\&.cer, and assigns the alias \f3abc\fR to the entry\&. -.SS IMPORT\ THE\ CERTIFICATE\ REPLY\ FROM\ THE\ CA -After you import a certificate that authenticates the public key of the CA you submitted your certificate signing request to (or there is already such a certificate in the cacerts file), you can import the certificate reply and replace your self-signed certificate with a certificate chain\&. This chain is the one returned by the CA in response to your request (when the CA reply is a chain), or one constructed (when the CA reply is a single certificate) using the certificate reply and trusted certificates that are already available in the keystore where you import the reply or in the \f3cacerts\fR keystore file\&. -.PP -For example, if you sent your certificate signing request to VeriSign, then you can import the reply with the following, which assumes the returned certificate is named VSMarkJ\&.cer: -.sp -.nf -\f3keytool \-importcert \-trustcacerts \-file VSMarkJ\&.cer\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS EXPORT\ A\ CERTIFICATE\ THAT\ AUTHENTICATES\ THE\ PUBLIC\ KEY -If you used the \f3jarsigner\fR command to sign a Java Archive (JAR) file, then clients that want to use the file will want to authenticate your signature\&. One way the clients can authenticate you is by first importing your public key certificate into their keystore as a trusted entry\&. -.PP -You can export the certificate and supply it to your clients\&. As an example, you can copy your certificate to a file named MJ\&.cer with the following command that assumes the entry has an alias of \f3mykey\fR: -.sp -.nf -\f3keytool \-exportcert \-alias mykey \-file MJ\&.cer\fP -.fi -.nf -\f3\fP -.fi -.sp -With the certificate and the signed JAR file, a client can use the \f3jarsigner\fR command to authenticate your signature\&. -.SS IMPORT\ KEYSTORE -The command \f3importkeystore\fR is used to import an entire keystore into another keystore, which means all entries from the source keystore, including keys and certificates, are all imported to the destination keystore within a single command\&. You can use this command to import entries from a different type of keystore\&. During the import, all new entries in the destination keystore will have the same alias names and protection passwords (for secret keys and private keys)\&. If the \f3keytool\fR command cannot recover the private keys or secret keys from the source keystore, then it prompts you for a password\&. If it detects alias duplication, then it asks you for a new alias, and you can specify a new alias or simply allow the \f3keytool\fR command to overwrite the existing one\&. -.PP -For example, to import entries from a typical JKS type keystore key\&.jks into a PKCS #11 type hardware-based keystore, use the command: -.sp -.nf -\f3keytool \-importkeystore\fP -.fi -.nf -\f3 \-srckeystore key\&.jks \-destkeystore NONE\fP -.fi -.nf -\f3 \-srcstoretype JKS \-deststoretype PKCS11\fP -.fi -.nf -\f3 \-srcstorepass <src keystore password>\fP -.fi -.nf -\f3 \-deststorepass <destination keystore pwd>\fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3importkeystore\fR command can also be used to import a single entry from a source keystore to a destination keystore\&. In this case, besides the options you see in the previous example, you need to specify the alias you want to import\&. With the \f3-srcalias\fR option specified, you can also specify the destination alias name in the command line, as well as protection password for a secret/private key and the destination protection password you want\&. The following command demonstrates this: -.sp -.nf -\f3keytool \-importkeystore\fP -.fi -.nf -\f3 \-srckeystore key\&.jks \-destkeystore NONE\fP -.fi -.nf -\f3 \-srcstoretype JKS \-deststoretype PKCS11\fP -.fi -.nf -\f3 \-srcstorepass <src keystore password>\fP -.fi -.nf -\f3 \-deststorepass <destination keystore pwd>\fP -.fi -.nf -\f3 \-srcalias myprivatekey \-destalias myoldprivatekey\fP -.fi -.nf -\f3 \-srckeypass <source entry password>\fP -.fi -.nf -\f3 \-destkeypass <destination entry password>\fP -.fi -.nf -\f3 \-noprompt\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS GENERATE\ CERTIFICATES\ FOR\ AN\ SSL\ SERVER -The following are \f3keytool\fR commands to generate key pairs and certificates for three entities: Root CA (\f3root\fR), Intermediate CA (\f3ca\fR), and SSL server (\f3server\fR)\&. Ensure that you store all the certificates in the same keystore\&. In these examples, RSA is the recommended the key algorithm\&. -.sp -.nf -\f3keytool \-genkeypair \-keystore root\&.jks \-alias root \-ext bc:c\fP -.fi -.nf -\f3keytool \-genkeypair \-keystore ca\&.jks \-alias ca \-ext bc:c\fP -.fi -.nf -\f3keytool \-genkeypair \-keystore server\&.jks \-alias server\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3keytool \-keystore root\&.jks \-alias root \-exportcert \-rfc > root\&.pem\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3keytool \-storepass <storepass> \-keystore ca\&.jks \-certreq \-alias ca |\fP -.fi -.nf -\f3 keytool \-storepass <storepass> \-keystore root\&.jks\fP -.fi -.nf -\f3 \-gencert \-alias root \-ext BC=0 \-rfc > ca\&.pem\fP -.fi -.nf -\f3keytool \-keystore ca\&.jks \-importcert \-alias ca \-file ca\&.pem\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3keytool \-storepass <storepass> \-keystore server\&.jks \-certreq \-alias server |\fP -.fi -.nf -\f3 keytool \-storepass <storepass> \-keystore ca\&.jks \-gencert \-alias ca\fP -.fi -.nf -\f3 \-ext ku:c=dig,kE \-rfc > server\&.pem\fP -.fi -.nf -\f3cat root\&.pem ca\&.pem server\&.pem |\fP -.fi -.nf -\f3 keytool \-keystore server\&.jks \-importcert \-alias server\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH TERMS -.TP -Keystore -A keystore is a storage facility for cryptographic keys and certificates\&. -.TP -Keystore entries -Keystores can have different types of entries\&. The two most applicable entry types for the \f3keytool\fR command include the following: - -\fIKey entries\fR: Each entry holds very sensitive cryptographic key information, which is stored in a protected format to prevent unauthorized access\&. Typically, a key stored in this type of entry is a secret key, or a private key accompanied by the certificate chain for the corresponding public key\&. See Certificate Chains\&. The \f3keytool\fR command can handle both types of entries, while the \f3jarsigner\fR tool only handles the latter type of entry, that is private keys and their associated certificate chains\&. - -\fITrusted certificate entries\fR: Each entry contains a single public key certificate that belongs to another party\&. The entry is called a trusted certificate because the keystore owner trusts that the public key in the certificate belongs to the identity identified by the subject (owner) of the certificate\&. The issuer of the certificate vouches for this, by signing the certificate\&. -.TP -KeyStore aliases -All keystore entries (key and trusted certificate entries) are accessed by way of unique aliases\&. - -An alias is specified when you add an entity to the keystore with the \f3-genseckey\fR command to generate a secret key, the \f3-genkeypair\fR command to generate a key pair (public and private key), or the \f3-importcert\fR command to add a certificate or certificate chain to the list of trusted certificates\&. Subsequent \f3keytool\fR commands must use this same alias to refer to the entity\&. - -For example, you can use the alias \f3duke\fR to generate a new public/private key pair and wrap the public key into a self-signed certificate with the following command\&. See Certificate Chains\&. -.sp -.nf -\f3keytool \-genkeypair \-alias duke \-keypass dukekeypasswd\fP -.fi -.nf -\f3\fP -.fi -.sp - - -This example specifies an initial password of \f3dukekeypasswd\fR required by subsequent commands to access the private key associated with the alias \f3duke\fR\&. If you later want to change Duke\&'s private key password, use a command such as the following: -.sp -.nf -\f3keytool \-keypasswd \-alias duke \-keypass dukekeypasswd \-new newpass\fP -.fi -.nf -\f3\fP -.fi -.sp - - -This changes the password from \f3dukekeypasswd\fR to \f3newpass\fR\&. A password should not be specified on a command line or in a script unless it is for testing purposes, or you are on a secure system\&. If you do not specify a required password option on a command line, then you are prompted for it\&. -.TP -KeyStore implementation -The \f3KeyStore\fR class provided in the \f3java\&.security\fR 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 type of keystore\&. - -Currently, two command-line tools (\f3keytool\fR and \f3jarsigner\fR) and a GUI-based tool named Policy Tool make use of keystore implementations\&. Because the \f3KeyStore\fR class is \f3public\fR, users can write additional security applications that use it\&. - -There is a built-in default implementation, provided by Oracle\&. It implements the keystore as a file with a proprietary keystore type (format) named JKS\&. It protects each private key with its individual password, and also protects the integrity of the entire keystore with a (possibly different) password\&. - -Keystore implementations are provider-based\&. More specifically, the application interfaces supplied by \f3KeyStore\fR are implemented in terms of a Service Provider Interface (SPI)\&. That is, there is a corresponding abstract \f3KeystoreSpi\fR class, also in the \f3java\&.security package\fR, which defines the Service Provider Interface methods that providers must implement\&. The term \fIprovider\fR refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API\&. To provide a keystore implementation, clients must implement a provider and supply a \f3KeystoreSpi\fR subclass implementation, as described in How to Implement a Provider in the Java Cryptography Architecture at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/HowToImplAProvider\&.html - -Applications can choose different types of keystore implementations from different providers, using the \f3getInstance\fR factory method supplied in the \f3KeyStore\fR class\&. A keystore type defines the storage and data format of the keystore information, and the algorithms used to protect private/secret keys in the keystore and the integrity of the keystore\&. Keystore implementations of different types are not compatible\&. - -The \f3keytool\fR command works on any file-based keystore implementation\&. It treats the keystore location that is passed to it at the command line as a file name and converts it to a \f3FileInputStream\fR, from which it loads the keystore information\&.)The \f3jarsigner\fR and \f3policytool\fR commands can read a keystore from any location that can be specified with a URL\&. - -For \f3keytool\fR and \f3jarsigner\fR, you can specify a keystore type at the command line, with the \f3-storetype\fR option\&. For Policy Tool, you can specify a keystore type with the \fIKeystore\fR menu\&. - -If you do not explicitly specify a keystore type, then the tools choose a keystore implementation based on the value of the \f3keystore\&.type\fR property specified in the security properties file\&. The security properties file is called \f3java\&.security\fR, and resides in the security properties directory, \f3java\&.home\elib\esecurity\fR on Windows and \f3java\&.home/lib/security\fR on Oracle Solaris, where \f3java\&.home\fR is the runtime environment directory\&. The \f3jre\fR directory in the SDK or the top-level directory of the Java Runtime Environment (JRE)\&. - -Each tool gets the \f3keystore\&.type\fR value and then examines all the currently installed providers until it finds one that implements a keystores of that type\&. It then uses the keystore implementation from that provider\&.The \f3KeyStore\fR class defines a static method named \f3getDefaultType\fR that lets applications and applets retrieve the value of the \f3keystore\&.type\fR property\&. The following line of code creates an instance of the default keystore type as specified in the \f3keystore\&.type\fR property: -.sp -.nf -\f3KeyStore keyStore = KeyStore\&.getInstance(KeyStore\&.getDefaultType());\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The default keystore type is \f3jks\fR, which is the proprietary type of the keystore implementation provided by Oracle\&. This is specified by the following line in the security properties file: -.sp -.nf -\f3keystore\&.type=jks\fP -.fi -.nf -\f3\fP -.fi -.sp - - -To have the tools utilize a keystore implementation other than the default, you can change that line to specify a different keystore type\&. For example, if you have a provider package that supplies a keystore implementation for a keystore type called \f3pkcs12\fR, then change the line to the following: -.sp -.nf -\f3keystore\&.type=pkcs12\fP -.fi -.nf -\f3\fP -.fi -.sp - - -\fINote:\fR Case does not matter in keystore type designations\&. For example, JKS would be considered the same as jks\&. -.TP -Certificate -A certificate (or public-key certificate) is a digitally signed statement from one entity (the issuer), saying that the public key and some other information of another entity (the subject) has some specific value\&. The following terms are related to certificates: - -\fIPublic Keys\fR: These are numbers associated with a particular entity, and are intended to be known to everyone who needs to have trusted interactions with that entity\&. Public keys are used to verify signatures\&. - -\fIDigitally Signed\fR: If some data is digitally signed, then it is stored with the identity of an entity and a signature that proves that entity knows about the data\&. The data is rendered unforgeable by signing with the entity\&'s private key\&. - -\fIIdentity\fR: A known way of addressing an entity\&. In some systems, the identity is the public key, and in others it can be anything from an Oracle Solaris UID to an email address to an X\&.509 distinguished name\&. - -\fISignature\fR: A signature is computed over some data using the private key of an entity\&. The signer, which in the case of a certificate is also known as the issuer\&. - -\fIPrivate Keys\fR: These are numbers, each of which is supposed to be known only to the particular entity whose private key it is (that is, it is supposed to be kept secret)\&. Private and public keys exist in pairs in all public key cryptography systems (also referred to as public key crypto systems)\&. In a typical public key crypto system, such as DSA, a private key corresponds to exactly one public key\&. Private keys are used to compute signatures\&. - -\fIEntity\fR: An entity is a person, organization, program, computer, business, bank, or something else you are trusting to some degree\&. - -Public key cryptography requires access to users\&' public keys\&. In a large-scale networked environment, it is impossible to guarantee that prior relationships between communicating entities were established or that a trusted repository exists with all used public keys\&. Certificates were invented as a solution to this public key distribution problem\&. Now a Certification Authority (CA) can act as a trusted third party\&. CAs are entities such as businesses that are trusted to sign (issue) certificates for other entities\&. It is assumed that CAs only create valid and reliable certificates because they are bound by legal agreements\&. There are many public Certification Authorities, such as VeriSign, Thawte, Entrust, and so on\&. - -You can also run your own Certification Authority using products such as Microsoft Certificate Server or the Entrust CA product for your organization\&. With the \f3keytool\fR command, it is possible to display, import, and export certificates\&. It is also possible to generate self-signed certificates\&. - -The \f3keytool\fR command currently handles X\&.509 certificates\&. -.TP -X\&.509 Certificates -The X\&.509 standard defines what information can go into a certificate and describes how to write it down (the data format)\&. All the data in a certificate is encoded with two related standards called ASN\&.1/DER\&. Abstract Syntax Notation 1 describes data\&. The Definite Encoding Rules describe a single way to store and transfer that data\&. - -All X\&.509 certificates have the following data, in addition to the signature: - -\fIVersion\fR: This identifies which version of the X\&.509 standard applies to this certificate, which affects what information can be specified in it\&. Thus far, three versions are defined\&. The \f3keytool\fR command can import and export v1, v2, and v3 certificates\&. It generates v3 certificates\&. - -X\&.509 Version 1 has been available since 1988, is widely deployed, and is the most generic\&. - -X\&.509 Version 2 introduced the concept of subject and issuer unique identifiers to handle the possibility of reuse of subject or issuer names over time\&. Most certificate profile documents strongly recommend that names not be reused and that certificates should not make use of unique identifiers\&. Version 2 certificates are not widely used\&. - -X\&.509 Version 3 is the most recent (1996) and supports the notion of extensions where anyone can define an extension and include it in the certificate\&. Some common extensions are: KeyUsage (limits the use of the keys to particular purposes such as \f3signing-only\fR) and AlternativeNames (allows other identities to also be associated with this public key, for example\&. DNS names, email addresses, IP addresses)\&. Extensions can be marked critical to indicate that the extension should be checked and enforced or used\&. For example, if a certificate has the KeyUsage extension marked critical and set to \f3keyCertSign\fR, then when this certificate is presented during SSL communication, it should be rejected because the certificate extension indicates that the associated private key should only be used for signing certificates and not for SSL use\&. - -\fISerial number\fR: The entity that created the certificate is responsible for assigning it a serial number to distinguish it from other certificates it issues\&. This information is used in numerous ways\&. For example, when a certificate is revoked its serial number is placed in a Certificate Revocation List (CRL)\&. - -\fISignature algorithm identifier\fR: This identifies the algorithm used by the CA to sign the certificate\&. - -\fIIssuer name\fR: The X\&.500 Distinguished Name of the entity that signed the certificate\&. See X\&.500 Distinguished Names\&. This is typically a CA\&. Using this certificate implies trusting the entity that signed this certificate\&. In some cases, such as root or top-level CA certificates, the issuer signs its own certificate\&. - -\fIValidity period\fR: Each certificate is valid only for a limited amount of time\&. This period is described by a start date and time and an end date and time, and can be as short as a few seconds or almost as long as a century\&. The validity period chosen depends on a number of factors, such as the strength of the private key used to sign the certificate, or the amount one is willing to pay for a certificate\&. This is the expected period that entities can rely on the public value, when the associated private key has not been compromised\&. - -\fISubject name\fR: The name of the entity whose public key the certificate identifies\&. This name uses the X\&.500 standard, so it is intended to be unique across the Internet\&. This is the X\&.500 Distinguished Name (DN) of the entity\&. See X\&.500 Distinguished Names\&. For example, -.sp -.nf -\f3CN=Java Duke, OU=Java Software Division, O=Oracle Corporation, C=US\fP -.fi -.nf -\f3\fP -.fi -.sp - - -These refer to the subject\&'s common name (CN), organizational unit (OU), organization (O), and country (C)\&. - -\fISubject public key information\fR: This is the public key of the entity being named with an algorithm identifier that specifies which public key crypto system this key belongs to and any associated key parameters\&. -.TP -Certificate Chains -The \f3keytool\fR command can create and manage keystore key entries that each contain a private key and an associated certificate chain\&. The first certificate in the chain contains the public key that corresponds to the private key\&. - -When keys are first generated, the chain starts off containing a single element, a self-signed certificate\&. See \f3-genkeypair\fR in Commands\&. A self-signed certificate is one for which the issuer (signer) is the same as the subject\&. The subject is the entity whose public key is being authenticated by the certificate\&. Whenever the \f3-genkeypair\fR command is called to generate a new public/private key pair, it also wraps the public key into a self-signed certificate\&. - -Later, after a Certificate Signing Request (CSR) was generated with the \f3-certreq\fR command and sent to a Certification Authority (CA), the response from the CA is imported with \f3-importcert\fR, and the self-signed certificate is replaced by a chain of certificates\&. See the \f3-certreq\fR and \f3-importcert\fR options in Commands\&. At the bottom of the chain is the certificate (reply) issued by the CA authenticating the subject\&'s public key\&. The next certificate in the chain is one that authenticates the CA\&'s public key\&. - -In many cases, this is a self-signed certificate, which is a certificate from the CA authenticating its own public key, and the last certificate in the chain\&. In other cases, the CA might return a chain of certificates\&. In this case, the bottom certificate in the chain is the same (a certificate signed by the CA, authenticating the public key of the key entry), but the second certificate in the chain is a certificate signed by a different CA that authenticates the public key of the CA you sent the CSR to\&. The next certificate in the chain is a certificate that authenticates the second CA\&'s key, and so on, until a self-signed root certificate is reached\&. Each certificate in the chain (after the first) authenticates the public key of the signer of the previous certificate in the chain\&. - -Many CAs only return the issued certificate, with no supporting chain, especially when there is a flat hierarchy (no intermediates CAs)\&. In this case, the certificate chain must be established from trusted certificate information already stored in the keystore\&. - -A different reply format (defined by the PKCS #7 standard) includes the supporting certificate chain in addition to the issued certificate\&. Both reply formats can be handled by the \f3keytool\fR command\&. - -The top-level (root) CA certificate is self-signed\&. However, the trust into the root\&'s public key does not come from the root certificate itself, but from other sources such as a newspaper\&. This is because anybody could generate a self-signed certificate with the distinguished name of, for example, the VeriSign root CA\&. The root CA public key is widely known\&. The only reason it is stored in a certificate is because this is the format understood by most tools, so the certificate in this case is only used as a vehicle to transport the root CA\&'s public key\&. Before you add the root CA certificate to your keystore, you should view it with the \f3-printcert\fR option and compare the displayed fingerprint with the well-known fingerprint obtained from a newspaper, the root CA\&'s Web page, and so on\&. -.TP -The cacerts Certificates File -A certificates file named \f3cacerts\fR resides in the security properties directory, \f3java\&.home\elib\esecurity\fR on Windows and \f3java\&.home/lib/security\fR on Oracle Solaris, where \f3java\&.home\fR is the runtime environment\&'s directory, which would be the \f3jre\fR directory in the SDK or the top-level directory of the JRE\&. - -The \f3cacerts\fR file represents a system-wide keystore with CA certificates\&. System administrators can configure and manage that file with the \f3keytool\fR command by specifying \f3jks\fR as the keystore type\&. The \f3cacerts\fR keystore file ships with a default set of root CA certificates\&. You can list the default certificates with the following command: -.sp -.nf -\f3keytool \-list \-keystore java\&.home/lib/security/cacerts\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The initial password of the \f3cacerts\fR keystore file is \f3changeit\fR\&. System administrators should change that password and the default access permission of that file upon installing the SDK\&. - -\fINote:\fR It is important to verify your \f3cacerts\fR file\&. Because you trust the CAs in the \f3cacerts\fR file as entities for signing and issuing certificates to other entities, you must manage the \f3cacerts\fR file carefully\&. The \f3cacerts\fR file should contain only certificates of the CAs you trust\&. It is your responsibility to verify the trusted root CA certificates bundled in the \f3cacerts\fR file and make your own trust decisions\&. - -To remove an untrusted CA certificate from the \f3cacerts\fR file, use the \f3delete\fR option of the \f3keytool\fR command\&. You can find the \f3cacerts\fR file in the JRE installation directory\&. Contact your system administrator if you do not have permission to edit this file -.TP -Internet RFC 1421 Certificate Encoding Standard -Certificates are often stored using the printable encoding format defined by the Internet RFC 1421 standard, instead of their binary encoding\&. This certificate format, also known as Base64 encoding, makes it easy to export certificates to other applications by email or through some other mechanism\&. - -Certificates read by the \f3-importcert\fR and \f3-printcert\fR commands can be in either this format or binary encoded\&. The \f3-exportcert\fR command by default outputs a certificate in binary encoding, but will instead output a certificate in the printable encoding format, when the \f3-rfc\fR option is specified\&. - -The \f3-list\fR command by default prints the SHA1 fingerprint of a certificate\&. If the \f3-v\fR option is specified, then the certificate is printed in human-readable format\&. If the \f3-rfc\fR option is specified, then the certificate is output in the printable encoding format\&. - -In its printable encoding format, the encoded certificate is bounded at the beginning and end by the following text: -.sp -.nf -\f3\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3encoded certificate goes here\&. \fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\-\-\-\-\-END CERTIFICATE\-\-\-\-\-\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -X\&.500 Distinguished Names -X\&.500 Distinguished Names are used to identify entities, such as those that are named by the \f3subject\fR and \f3issuer\fR (signer) fields of X\&.509 certificates\&. The \f3keytool\fR command supports the following subparts: - -\fIcommonName\fR: The common name of a person such as Susan Jones\&. - -\fIorganizationUnit\fR: The small organization (such as department or division) name\&. For example, Purchasing\&. - -\fIlocalityName\fR: The locality (city) name, for example, Palo Alto\&. - -\fIstateName\fR: State or province name, for example, California\&. - -\fIcountry\fR: Two-letter country code, for example, CH\&. - -When you supply a distinguished name string as the value of a \f3-dname\fR option, such as for the \f3-genkeypair\fR command, the string must be in the following format: -.sp -.nf -\f3CN=cName, OU=orgUnit, O=org, L=city, S=state, C=countryCode\fP -.fi -.nf -\f3\fP -.fi -.sp - - -All the italicized items represent actual values and the previous keywords are abbreviations for the following: -.sp -.nf -\f3CN=commonName\fP -.fi -.nf -\f3OU=organizationUnit\fP -.fi -.nf -\f3O=organizationName\fP -.fi -.nf -\f3L=localityName\fP -.fi -.nf -\f3S=stateName\fP -.fi -.nf -\f3C=country\fP -.fi -.nf -\f3\fP -.fi -.sp - - -A sample distinguished name string is: -.sp -.nf -\f3CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino, S=California, C=US\fP -.fi -.nf -\f3\fP -.fi -.sp - - -A sample command using such a string is: -.sp -.nf -\f3keytool \-genkeypair \-dname "CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino,\fP -.fi -.nf -\f3S=California, C=US" \-alias mark\fP -.fi -.nf -\f3\fP -.fi -.sp - - -Case does not matter for the keyword abbreviations\&. For example, CN, cn, and Cn are all treated the same\&. - -Order matters; each subcomponent must appear in the designated order\&. However, it is not necessary to have all the subcomponents\&. You can use a subset, for example: -.sp -.nf -\f3CN=Steve Meier, OU=Java, O=Oracle, C=US\fP -.fi -.nf -\f3\fP -.fi -.sp - - -If a distinguished name string value contains a comma, then the comma must be escaped by a backslash (\e) character when you specify the string on a command line, as in: -.sp -.nf -\f3cn=Peter Schuster, ou=Java\e, Product Development, o=Oracle, c=US\fP -.fi -.nf -\f3\fP -.fi -.sp - - -It is never necessary to specify a distinguished name string on a command line\&. When the distinguished name is needed for a command, but not supplied on the command line, the user is prompted for each of the subcomponents\&. In this case, a comma does not need to be escaped by a backslash (\e)\&. -.SH WARNINGS -.SS IMPORTING\ TRUSTED\ CERTIFICATES\ WARNING -\fIImportant\fR: Be sure to check a certificate very carefully before importing it as a trusted certificate\&. -.PP -Windows Example: - -View the certificate first with the \f3-printcert\fR command or the \f3-importcert\fR command without the \f3-noprompt\fR option\&. Ensure that the displayed certificate fingerprints match the expected ones\&. For example, suppose sends or emails you a certificate that you put it in a file named \f3\etmp\ecert\fR\&. Before you consider adding the certificate to your list of trusted certificates, you can execute a \f3-printcert\fR command to view its fingerprints, as follows: -.sp -.nf -\f3 keytool \-printcert \-file \etmp\ecert\fP -.fi -.nf -\f3 Owner: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP -.fi -.nf -\f3 Issuer: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP -.fi -.nf -\f3 Serial Number: 59092b34\fP -.fi -.nf -\f3 Valid from: Thu Sep 25 18:01:13 PDT 1997 until: Wed Dec 24 17:01:13 PST 1997\fP -.fi -.nf -\f3 Certificate Fingerprints:\fP -.fi -.nf -\f3 MD5: 11:81:AD:92:C8:E5:0E:A2:01:2E:D4:7A:D7:5F:07:6F\fP -.fi -.nf -\f3 SHA1: 20:B6:17:FA:EF:E5:55:8A:D0:71:1F:E8:D6:9D:C0:37:13:0E:5E:FE\fP -.fi -.nf -\f3 SHA256: 90:7B:70:0A:EA:DC:16:79:92:99:41:FF:8A:FE:EB:90:\fP -.fi -.nf -\f3 17:75:E0:90:B2:24:4D:3A:2A:16:A6:E4:11:0F:67:A4\fP -.fi -.sp - -.PP -Oracle Solaris Example: - -View the certificate first with the \f3-printcert\fR command or the \f3-importcert\fR command without the \f3-noprompt\fR option\&. Ensure that the displayed certificate fingerprints match the expected ones\&. For example, suppose someone sends or emails you a certificate that you put it in a file named \f3/tmp/cert\fR\&. Before you consider adding the certificate to your list of trusted certificates, you can execute a \f3-printcert\fR command to view its fingerprints, as follows: -.sp -.nf -\f3 keytool \-printcert \-file /tmp/cert\fP -.fi -.nf -\f3 Owner: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP -.fi -.nf -\f3 Issuer: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP -.fi -.nf -\f3 Serial Number: 59092b34\fP -.fi -.nf -\f3 Valid from: Thu Sep 25 18:01:13 PDT 1997 until: Wed Dec 24 17:01:13 PST 1997\fP -.fi -.nf -\f3 Certificate Fingerprints:\fP -.fi -.nf -\f3 MD5: 11:81:AD:92:C8:E5:0E:A2:01:2E:D4:7A:D7:5F:07:6F\fP -.fi -.nf -\f3 SHA1: 20:B6:17:FA:EF:E5:55:8A:D0:71:1F:E8:D6:9D:C0:37:13:0E:5E:FE\fP -.fi -.nf -\f3 SHA256: 90:7B:70:0A:EA:DC:16:79:92:99:41:FF:8A:FE:EB:90:\fP -.fi -.nf -\f3 17:75:E0:90:B2:24:4D:3A:2A:16:A6:E4:11:0F:67:A4\fP -.fi -.nf -\f3\fP -.fi -.sp -Then call or otherwise contact the person who sent the certificate and compare the fingerprints that you see with the ones that they show\&. Only when the fingerprints are equal is it guaranteed that the certificate was not replaced in transit with somebody else\&'s certificate such as an attacker\&'s certificate\&. If such an attack took place, and you did not check the certificate before you imported it, then you would be trusting anything the attacker signed, for example, a JAR file with malicious class files inside\&. -.PP -\fINote:\fR It is not required that you execute a \f3-printcert\fR command before importing a certificate\&. This is because before you add a certificate to the list of trusted certificates in the keystore, the \f3-importcert\fR command prints out the certificate information and prompts you to verify it\&. You can then stop the import operation\&. However, you can do this only when you call the \f3-importcert\fR command without the \f3-noprompt\fR option\&. If the \f3-noprompt\fR option is specified, then there is no interaction with the user\&. -.SS PASSWORDS\ WARNING -Most commands that operate on a keystore require the store password\&. Some commands require a private/secret key password\&. Passwords can be specified on the command line in the \f3-storepass\fR and \f3-keypass\fR options\&. However, a password should not be specified on a command line or in a script unless it is for testing, or you are on a secure system\&. When you do not specify a required password option on a command line, you are prompted for it\&. -.SS CERTIFICATE\ CONFORMANCE\ WARNING -The Internet standard RFC 5280 has defined a profile on conforming X\&.509 certificates, which includes what values and value combinations are valid for certificate fields and extensions\&. See the standard at http://tools\&.ietf\&.org/rfc/rfc5280\&.txt -.PP -The \f3keytool\fR command does not enforce all of these rules so it can generate certificates that do not conform to the standard\&. Certificates that do not conform to the standard might be rejected by JRE or other applications\&. Users should ensure that they provide the correct options for \f3-dname\fR, \f3-ext\fR, and so on\&. -.SH NOTES -.SS IMPORT\ A\ NEW\ TRUSTED\ CERTIFICATE -Before you add the certificate to the keystore, the \f3keytool\fR command verifies it by attempting to construct a chain of trust from that certificate to a self-signed certificate (belonging to a root CA), using trusted certificates that are already available in the keystore\&. -.PP -If the \f3-trustcacerts\fR option was specified, then additional certificates are considered for the chain of trust, namely the certificates in a file named \f3cacerts\fR\&. -.PP -If the \f3keytool\fR command fails to establish a trust path from the certificate to be imported up to a self-signed certificate (either from the keystore or the \f3cacerts\fR file), then the certificate information is printed, and the user is prompted to verify it by comparing the displayed certificate fingerprints with the fingerprints obtained from some other (trusted) source of information, which might be the certificate owner\&. Be very careful to ensure the certificate is valid before importing it as a trusted certificate\&. See Importing Trusted Certificates Warning\&. The user then has the option of stopping the import operation\&. If the \f3-noprompt\fR option is specified, then there is no interaction with the user\&. -.SS IMPORT\ A\ CERTIFICATE\ REPLY -When you import a certificate reply, the certificate reply is validated with trusted certificates from the keystore, and optionally, the certificates configured in the \f3cacerts\fR keystore file when the \f3-trustcacert\fR\f3s\fR option is specified\&. See The cacerts Certificates File\&. -.PP -The methods of determining whether the certificate reply is trusted are as follows: -.TP 0.2i -\(bu -If the reply is a single X\&.509 certificate, then the \f3keytool\fR command attempts to establish a trust chain, starting at the certificate reply and ending at a self-signed certificate (belonging to a root CA)\&. The certificate reply and the hierarchy of certificates is used to authenticate the certificate reply from the new certificate chain of aliases\&. If a trust chain cannot be established, then the certificate reply is not imported\&. In this case, the \f3keytool\fR command does not print the certificate and prompt the user to verify it, because it is very difficult for a user to determine the authenticity of the certificate reply\&. -.TP 0.2i -\(bu -If the reply is a PKCS #7 formatted certificate chain or a sequence of X\&.509 certificates, then the chain is ordered with the user certificate first followed by zero or more CA certificates\&. If the chain ends with a self-signed root CA certificate and the\f3-trustcacerts\fR option was specified, the \f3keytool\fR command attempts to match it with any of the trusted certificates in the keystore or the \f3cacerts\fR keystore file\&. If the chain does not end with a self-signed root CA certificate and the \f3-trustcacerts\fR option was specified, the \f3keytool\fR command tries to find one from the trusted certificates in the keystore or the \f3cacerts\fR keystore file and add it to the end of the chain\&. If the certificate is not found and the \f3-noprompt\fR option is not specified, the information of the last certificate in the chain is printed, and the user is prompted to verify it\&. -.PP -If the public key in the certificate reply matches the user\&'s public key already stored with \f3alias\fR, then the old certificate chain is replaced with the new certificate chain in the reply\&. The old chain can only be replaced with a valid \f3keypass\fR, and so the password used to protect the private key of the entry is supplied\&. If no password is provided, and the private key password is different from the keystore password, the user is prompted for it\&. -.PP -This command was named \f3-import\fR in earlier releases\&. This old name is still supported in this release\&. The new name, \f3-importcert\fR, is preferred going forward\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -jar(1) -.TP 0.2i -\(bu -jarsigner(1) -.TP 0.2i -\(bu -Trail: Security Features in Java SE at http://docs\&.oracle\&.com/javase/tutorial/security/index\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1998, 2015, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 03 March 2015 +.\" SectDesc: Security Tools +.\" Title: keytool.1 +.\" +.if n .pl 99999 +.TH keytool 1 "03 March 2015" "JDK 8" "Security Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +keytool \- Manages a keystore (database) of cryptographic keys, X\&.509 certificate chains, and trusted certificates\&. +.SH SYNOPSIS +.sp +.nf + +\fBkeytool\fR [\fIcommands\fR] +.fi +.sp +.TP +\fIcommands\fR +See Commands\&. These commands are categorized by task as follows: +.RS +.TP 0.2i +\(bu +Create or Add Data to the Keystore +.RS +.TP 0.2i +\(bu +-gencert +.TP 0.2i +\(bu +-genkeypair +.TP 0.2i +\(bu +-genseckey +.TP 0.2i +\(bu +-importcert +.TP 0.2i +\(bu +-importpassword +.RE + +.TP 0.2i +\(bu +Import Contents From Another Keystore +.RS +.TP 0.2i +\(bu +-importkeystore +.RE + +.TP 0.2i +\(bu +Generate Certificate Request +.RS +.TP 0.2i +\(bu +-certreq +.RE + +.TP 0.2i +\(bu +Export Data +.RS +.TP 0.2i +\(bu +-exportcert +.RE + +.TP 0.2i +\(bu +Display Data +.RS +.TP 0.2i +\(bu +-list +.TP 0.2i +\(bu +-printcert +.TP 0.2i +\(bu +-printcertreq +.TP 0.2i +\(bu +-printcrl +.RE + +.TP 0.2i +\(bu +Manage the Keystore +.RS +.TP 0.2i +\(bu +-storepasswd +.TP 0.2i +\(bu +-keypasswd +.TP 0.2i +\(bu +-delete +.TP 0.2i +\(bu +-changealias +.RE + +.TP 0.2i +\(bu +Get Help +.RS +.TP 0.2i +\(bu +-help +.RE + +.RE + +.SH DESCRIPTION +The \f3keytool\fR command is a key and certificate management utility\&. It enables users to administer their own public/private key pairs and associated certificates for use in self-authentication (where the user authenticates himself or herself to other users and services) or data integrity and authentication services, using digital signatures\&. The \f3keytool\fR command also enables users to cache the public keys (in the form of certificates) of their communicating peers\&. +.PP +A certificate is a digitally signed statement from one entity (person, company, and so on\&.), that says that the public key (and some other information) of some other entity has a particular value\&. (See Certificate\&.) When data is digitally signed, the signature can be verified to check the data integrity and authenticity\&. Integrity means that the data has not been modified or tampered with, and authenticity means the data comes from whoever claims to have created and signed it\&. +.PP +The \f3keytool\fR command also enables users to administer secret keys and passphrases used in symmetric encryption and decryption (DES)\&. +.PP +The \f3keytool\fR command stores the keys and certificates in a keystore\&. See KeyStore aliases\&. +.SH COMMAND\ AND\ OPTION\ NOTES +See Commands for a listing and description of the various commands\&. +.TP 0.2i +\(bu +All command and option names are preceded by a minus sign (-)\&. +.TP 0.2i +\(bu +The options for each command can be provided in any order\&. +.TP 0.2i +\(bu +All items not italicized or in braces or brackets are required to appear as is\&. +.TP 0.2i +\(bu +Braces surrounding an option signify that a default value will be used when the option is not specified on the command line\&. See Option Defaults\&. Braces are also used around the \f3-v\fR, \f3-rfc\fR, and \f3-J\fR options, which only have meaning when they appear on the command line\&. They do not have any default values other than not existing\&. +.TP 0.2i +\(bu +Brackets surrounding an option signify that the user is prompted for the values when the option is not specified on the command line\&. For the \f3-keypass\fR option, if you do not specify the option on the command line, then the \f3keytool\fR command first attempts to use the keystore password to recover the private/secret key\&. If this attempt fails, then the \f3keytool\fR command prompts you for the private/secret key password\&. +.TP 0.2i +\(bu +Items in italics (option values) represent the actual values that must be supplied\&. For example, here is the format of the \f3-printcert\fR command: +.sp +.nf +\f3keytool \-printcert {\-file \fIcert_file\fR} {\-v}\fP +.fi +.sp + + + + +When you specify a \f3-printcert\fR command, replace \fIcert_file\fR with the actual file name, as follows: \f3keytool -printcert -file VScert\&.cer\fR +.TP 0.2i +\(bu +Option values must be put in quotation marks when they contain a blank (space)\&. +.TP 0.2i +\(bu +The \f3-help\fR option is the default\&. The \f3keytool\fR command is the same as \f3keytool -help\fR\&. +.SH OPTION\ DEFAULTS +The following examples show the defaults for various option values\&. +.sp +.nf +\f3\-alias "mykey"\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-keyalg\fP +.fi +.nf +\f3 "DSA" (when using \-genkeypair)\fP +.fi +.nf +\f3 "DES" (when using \-genseckey)\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-keysize\fP +.fi +.nf +\f3 2048 (when using \-genkeypair and \-keyalg is "RSA")\fP +.fi +.nf +\f3 1024 (when using \-genkeypair and \-keyalg is "DSA")\fP +.fi +.nf +\f3 256 (when using \-genkeypair and \-keyalg is "EC")\fP +.fi +.nf +\f3 56 (when using \-genseckey and \-keyalg is "DES")\fP +.fi +.nf +\f3 168 (when using \-genseckey and \-keyalg is "DESede")\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-validity 90\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-keystore <the file named \&.keystore in the user\&'s home directory>\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-storetype <the value of the "keystore\&.type" property in the\fP +.fi +.nf +\f3 security properties file, which is returned by the static\fP +.fi +.nf +\f3 getDefaultType method in java\&.security\&.KeyStore>\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-file\fP +.fi +.nf +\f3 stdin (if reading)\fP +.fi +.nf +\f3 stdout (if writing)\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-protected false\fP +.fi +.nf +\f3\fP +.fi +.sp +In generating a public/private key pair, the signature algorithm (\f3-sigalg\fR option) is derived from the algorithm of the underlying private key: +.TP 0.2i +\(bu +If the underlying private key is of type DSA, then the \f3-sigalg\fR option defaults to SHA1withDSA\&. +.TP 0.2i +\(bu +If the underlying private key is of type RSA, then the \f3-sigalg\fR option defaults to SHA256withRSA\&. +.TP 0.2i +\(bu +If the underlying private key is of type EC, then the \f3-sigalg\fR option defaults to SHA256withECDSA\&. +.PP +For a full list of \f3-keyalg\fR and \f3-sigalg\fR arguments, see Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA +.SH COMMON\ OPTIONS +The \f3-v\fR option can appear for all commands except \f3-help\fR\&. When the \f3-v\fR option appears, it signifies verbose mode, which means that more information is provided in the output\&. +.PP +There is also a \f3-Jjavaoption\fR argument that can appear for any command\&. When the \f3-Jjavaoption\fR appears, the specified \f3javaoption\fR string is passed directly to the Java interpreter\&. This option does not contain any spaces\&. It is useful for adjusting the execution environment or memory usage\&. For a list of possible interpreter options, type \f3java -h\fR or \f3java -X\fR at the command line\&. +.PP +These options can appear for all commands operating on a keystore: +.TP +-storetype \fIstoretype\fR +.br +This qualifier specifies the type of keystore to be instantiated\&. +.TP +-keystore \fIkeystore\fR +.br +The keystore location\&. + +If the JKS \f3storetype\fR is used and a keystore file does not yet exist, then certain \f3keytool\fR commands can result in a new keystore file being created\&. For example, if \f3keytool -genkeypair\fR is called and the \f3-keystore\fR option is not specified, the default keystore file named \f3\&.keystore\fR in the user\&'s home directory is created when it does not already exist\&. Similarly, if the \f3-keystore ks_file\fR option is specified but ks_file does not exist, then it is created\&. For more information on the JKS \f3storetype\fR, see the \fIKeyStore Implementation\fR section in KeyStore aliases\&. + +Note that the input stream from the \f3-keystore\fR option is passed to the \f3KeyStore\&.load\fR method\&. If \f3NONE\fR is specified as the URL, then a null stream is passed to the \f3KeyStore\&.load\fR method\&. \f3NONE\fR should be specified if the keystore is not file-based\&. For example, when it resides on a hardware token device\&. +.TP +-storepass[:\fIenv\fR| :\fIfile\fR] argument +.br +The password that is used to protect the integrity of the keystore\&. + +If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the \f3value\fR argument, which must be at least 6 characters long\&. Otherwise, the password is retrieved as follows: +.RS +.TP 0.2i +\(bu +\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. +.TP 0.2i +\(bu +\f3file\fR: Retrieve the password from the file named argument\&. +.RE + + +\fINote:\fR All other options that require passwords, such as \f3-keypass\fR, \f3-srckeypass\fR, -\f3destkeypass\fR, \f3-srcstorepass\fR, and \f3-deststorepass\fR, accept the \fIenv\fR and \fIfile\fR modifiers\&. Remember to separate the password option and the modifier with a colon (:)\&. + +The password must be provided to all commands that access the keystore contents\&. For such commands, when the \f3-storepass\fR option is not provided at the command line, the user is prompted for it\&. + +When retrieving information from the keystore, the password is optional\&. If no password is specified, then the integrity of the retrieved information cannot be verified and a warning is displayed\&. +.TP +-providerName \fIprovider_name\fR +.br +Used to identify a cryptographic service provider\&'s name when listed in the security properties file\&. +.TP +-providerClass \fIprovider_class_name\fR +.br +Used to specify the name of a cryptographic service provider\&'s master class file when the service provider is not listed in the security properties file\&. +.TP +-providerArg \fIprovider_arg\fR +.br +Used with the \f3-providerClass\fR option to represent an optional string input argument for the constructor of \f3provider_class_name\fR\&. +.TP +-protected +.br +Either \f3true\fR or \f3false\fR\&. This value should be specified as \f3true\fR when a password must be specified by way of a protected authentication path such as a dedicated PIN reader\&.Because there are two keystores involved in the \f3-importkeystore\fR command, the following two options \f3-srcprotected\fR and -\f3destprotected\fR are provided for the source keystore and the destination keystore respectively\&. +.TP +-ext \fI{name{:critical} {=value}}\fR +.br +Denotes an X\&.509 certificate extension\&. The option can be used in \f3-genkeypair\fR and \f3-gencert\fR to embed extensions into the certificate generated, or in \f3-certreq\fR to show what extensions are requested in the certificate request\&. The option can appear multiple times\&. The \f3name\fR argument can be a supported extension name (see Named Extensions) or an arbitrary OID number\&. The \f3value\fR argument, when provided, denotes the argument for the extension\&. When \fIvalue\fR is omitted, that means that the default value of the extension or the extension requires no argument\&. The \f3:critical\fR modifier, when provided, means the extension\&'s \f3isCritical\fR attribute is \f3true\fR; otherwise, it is \f3false\fR\&. You can use \f3:c\fR in place of \f3:critical\fR\&. +.SH NAMED\ EXTENSIONS +The \f3keytool\fR command supports these named extensions\&. The names are not case-sensitive)\&. +.TP +BC or BasicContraints +\fIValues\fR: The full form is: \f3ca:{true|false}[,pathlen:<len>]\fR or \f3<len>\fR, which is short for \f3ca:true,pathlen:<len>\fR\&. When <\f3len\fR> is omitted, you have \f3ca:true\fR\&. +.TP +KU or KeyUsage +\fIValues\fR: \f3usage\fR(,\f3usage\fR)*, where \fIusage\fR can be one of \f3digitalSignature\fR, \f3nonRepudiation\fR (contentCommitment), \f3keyEncipherment\fR, \f3dataEncipherment\fR, \f3keyAgreement\fR, \f3keyCertSign\fR, \f3cRLSign\fR, \f3encipherOnly\fR, \f3decipherOnly\fR\&. The \fIusage\fR argument can be abbreviated with the first few letters (\f3dig\fR for \f3digitalSignature\fR) or in camel-case style (\f3dS\fR for \f3digitalSignature\fR or \f3cRLS\fR for \f3cRLSign\fR), as long as no ambiguity is found\&. The \f3usage\fR values are case-sensitive\&. +.TP +EKU or ExtendedKeyUsage +\fIValues\fR: \f3usage\fR(,\f3usage\fR)*, where \fIusage\fR can be one of \f3anyExtendedKeyUsage\fR, \f3serverAuth\fR, \f3clientAuth\fR, \f3codeSigning\fR, \f3emailProtection\fR, \f3timeStamping\fR, \f3OCSPSigning\fR, or any \fIOID string\fR\&. The \fIusage\fR argument can be abbreviated with the first few letters or in camel-case style, as long as no ambiguity is found\&. The \f3usage\fR values are case-sensitive\&. +.TP +SAN or SubjectAlternativeName +\fIValues\fR: \f3type\fR:\f3value\fR(,t\f3ype:value\fR)*, where \f3type\fR can be \f3EMAIL\fR, \f3URI\fR, \f3DNS\fR, \f3IP\fR, or \f3OID\fR\&. The \f3value\fR argument is the string format value for the \f3type\fR\&. +.TP +IAN or IssuerAlternativeName +\fIValues\fR: Same as \f3SubjectAlternativeName\fR\&. +.TP +SIA or SubjectInfoAccess +\fIValues\fR: \f3method\fR:\f3location-type\fR:\f3location-value\fR (,\f3method:location-type\fR:\f3location-value\fR)*, where \f3method\fR can be \f3timeStamping\fR, \f3caRepository\fR or any OID\&. The \f3location-type\fR and \f3location-value\fR arguments can be any \f3type\fR:\f3value\fR supported by the \f3SubjectAlternativeName\fR extension\&. +.TP +AIA or AuthorityInfoAccess +\fIValues\fR: Same as \f3SubjectInfoAccess\fR\&. The \f3method\fR argument can be \f3ocsp\fR,\f3caIssuers\fR, or any OID\&. +.PP +When \f3name\fR is OID, the value is the hexadecimal dumped DER encoding of the \f3extnValue\fR for the extension excluding the OCTET STRING type and length bytes\&. Any extra character other than standard hexadecimal numbers (0-9, a-f, A-F) are ignored in the HEX string\&. Therefore, both 01:02:03:04 and 01020304 are accepted as identical values\&. When there is no value, the extension has an empty value field\&. +.PP +A special name \f3honored\fR, used in \f3-gencert\fR only, denotes how the extensions included in the certificate request should be honored\&. The value for this name is a comma separated list of \f3all\fR (all requested extensions are honored), \f3name{:[critical|non-critical]}\fR (the named extension is honored, but using a different \f3isCritical\fR attribute) and \f3-name\fR (used with \f3all\fR, denotes an exception)\&. Requested extensions are not honored by default\&. +.PP +If, besides the\f3-ext honored\fR option, another named or OID \f3-ext\fR option is provided, this extension is added to those already honored\&. However, if this name (or OID) also appears in the honored value, then its value and criticality overrides the one in the request\&. +.PP +The \f3subjectKeyIdentifier\fR extension is always created\&. For non-self-signed certificates, the \f3authorityKeyIdentifier\fR is created\&. +.PP +\fINote:\fR Users should be aware that some combinations of extensions (and other certificate fields) may not conform to the Internet standard\&. See Certificate Conformance Warning\&. +.SH COMMANDS +.TP +-gencert +.sp +.nf +\f3{\-rfc} {\-infile \fIinfile\fR} {\-outfile \fIoutfile\fR} {\-alias \fIalias\fR} {\-sigalg \fIsigalg\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-dname \fIdname\fR} {\-startdate \fIstartdate\fR {\-ext \fIext\fR}* {\-validity \fIvalDays\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-keypass \fIkeypass\fR] {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP +.fi +.sp +.sp +.nf +\f3{\-storetype \fIstoretype\fR} {\-providername \fIprovider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-v} {\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Generates a certificate as a response to a certificate request file (which can be created by the \f3keytool\fR\f3-certreq\fR command)\&. The command reads the request from \fIinfile\fR (if omitted, from the standard input), signs it using alias\&'s private key, and outputs the X\&.509 certificate into \fIoutfile\fR (if omitted, to the standard output)\&. When\f3-rfc\fR is specified, the output format is Base64-encoded PEM; otherwise, a binary DER is created\&. + +The \f3sigalg\fR value specifies the algorithm that should be used to sign the certificate\&. The \f3startdate\fR argument is the start time and date that the certificate is valid\&. The \f3valDays\fR argument tells the number of days for which the certificate should be considered valid\&. + +When \f3dname\fR is provided, it is used as the subject of the generated certificate\&. Otherwise, the one from the certificate request is used\&. + +The \f3ext\fR value shows what X\&.509 extensions will be embedded in the certificate\&. Read Common Options for the grammar of \f3-ext\fR\&. + +The \f3-gencert\fR option enables you to create certificate chains\&. The following example creates a certificate, \f3e1\fR, that contains three certificates in its certificate chain\&. + +The following commands creates four key pairs named \f3ca\fR, \f3ca1\fR, \f3ca2\fR, and \f3e1\fR: +.sp +.nf +\f3keytool \-alias ca \-dname CN=CA \-genkeypair\fP +.fi +.nf +\f3keytool \-alias ca1 \-dname CN=CA \-genkeypair\fP +.fi +.nf +\f3keytool \-alias ca2 \-dname CN=CA \-genkeypair\fP +.fi +.nf +\f3keytool \-alias e1 \-dname CN=E1 \-genkeypair\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following two commands create a chain of signed certificates; \f3ca\fR signs \f3ca1\fR and \f3ca1\fR signs \f3ca2\fR, all of which are self-issued: +.sp +.nf +\f3keytool \-alias ca1 \-certreq |\fP +.fi +.nf +\f3 keytool \-alias ca \-gencert \-ext san=dns:ca1 |\fP +.fi +.nf +\f3 keytool \-alias ca1 \-importcert\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3keytool \-alias ca2 \-certreq |\fP +.fi +.nf +\f3 $KT \-alias ca1 \-gencert \-ext san=dns:ca2 |\fP +.fi +.nf +\f3 $KT \-alias ca2 \-importcert\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following command creates the certificate \f3e1\fR and stores it in the file \f3e1\&.cert\fR, which is signed by \f3ca2\fR\&. As a result, \f3e1\fR should contain \f3ca\fR, \f3ca1\fR, and \f3ca2\fR in its certificate chain: +.sp +.nf +\f3keytool \-alias e1 \-certreq | keytool \-alias ca2 \-gencert > e1\&.cert\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-genkeypair +.sp +.nf +\f3{\-alias \fIalias\fR} {\-keyalg \fIkeyalg\fR} {\-keysize \fIkeysize\fR} {\-sigalg \fIsigalg\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-dname \fIdname\fR] [\-keypass \fIkeypass\fR] {\-startdate \fIvalue\fR} {\-ext \fIext\fR}*\fP +.fi +.sp +.sp +.nf +\f3{\-validity \fIvalDays\fR} {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-storepass \fIstorepass\fR]\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-v} {\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Generates a key pair (a public key and associated private key)\&. Wraps the public key into an X\&.509 v3 self-signed certificate, which is stored as a single-element certificate chain\&. This certificate chain and the private key are stored in a new keystore entry identified by alias\&. + +The \f3keyalg\fR value specifies the algorithm to be used to generate the key pair, and the \f3keysize\fR value specifies the size of each key to be generated\&. The \f3sigalg\fR value specifies the algorithm that should be used to sign the self-signed certificate\&. This algorithm must be compatible with the \f3keyalg\fR value\&. + +The \f3dname\fR value specifies the X\&.500 Distinguished Name to be associated with the value of \f3alias\fR, and is used as the issuer and subject fields in the self-signed certificate\&. If no distinguished name is provided at the command line, then the user is prompted for one\&. + +The value of \f3keypass\fR is a password used to protect the private key of the generated key pair\&. If no password is provided, then the user is prompted for it\&. If you press \fIthe Return key\fR at the prompt, then the key password is set to the same password as the keystore password\&. The \f3keypass\fR value must be at least 6 characters\&. + +The value of \f3startdate\fR specifies the issue time of the certificate, also known as the "Not Before" value of the X\&.509 certificate\&'s Validity field\&. + +The option value can be set in one of these two forms: + +\f3([+-]nnn[ymdHMS])+\fR + +\f3[yyyy/mm/dd] [HH:MM:SS]\fR + +With the first form, the issue time is shifted by the specified value from the current time\&. The value is a concatenation of a sequence of subvalues\&. Inside each subvalue, the plus sign (+) means shift forward, and the minus sign (-) means shift backward\&. The time to be shifted is \f3nnn\fR units of years, months, days, hours, minutes, or seconds (denoted by a single character of \f3y\fR, \f3m\fR, \f3d\fR, \f3H\fR, \f3M\fR, or \f3S\fR respectively)\&. The exact value of the issue time is calculated using the \f3java\&.util\&.GregorianCalendar\&.add(int field, int amount)\fR method on each subvalue, from left to right\&. For example, by specifying, the issue time will be: +.sp +.nf +\f3Calendar c = new GregorianCalendar();\fP +.fi +.nf +\f3c\&.add(Calendar\&.YEAR, \-1);\fP +.fi +.nf +\f3c\&.add(Calendar\&.MONTH, 1);\fP +.fi +.nf +\f3c\&.add(Calendar\&.DATE, \-1);\fP +.fi +.nf +\f3return c\&.getTime()\fP +.fi +.nf +\f3\fP +.fi +.sp + + +With the second form, the user sets the exact issue time in two parts, year/month/day and hour:minute:second (using the local time zone)\&. The user can provide only one part, which means the other part is the same as the current date (or time)\&. The user must provide the exact number of digits as shown in the format definition (padding with 0 when shorter)\&. When both the date and time are provided, there is one (and only one) space character between the two parts\&. The hour should always be provided in 24 hour format\&. + +When the option is not provided, the start date is the current time\&. The option can be provided at most once\&. + +The value of \f3valDays\fR specifies the number of days (starting at the date specified by \f3-startdate\fR, or the current date when \f3-startdate\fR is not specified) for which the certificate should be considered valid\&. + +This command was named \f3-genkey\fR in earlier releases\&. The old name is still supported in this release\&. The new name, \f3-genkeypair\fR, is preferred going forward\&. +.TP +-genseckey +.sp +.nf +\f3{\-alias \fIalias\fR} {\-keyalg \fIkeyalg\fR} {\-keysize \fIkeysize\fR} [\-keypass \fIkeypass\fR]\fP +.fi +.sp +.sp +.nf +\f3{\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}} {\-v}\fP +.fi +.sp +.sp +.nf +\f3{\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Generates a secret key and stores it in a new \f3KeyStore\&.SecretKeyEntry\fR identified by \f3alias\fR\&. + +The value of \f3keyalg\fR specifies the algorithm to be used to generate the secret key, and the value of \f3keysize\fR specifies the size of the key to be generated\&. The \f3keypass\fR value is a password that protects the secret key\&. If no password is provided, then the user is prompted for it\&. If you press the Return key at the prompt, then the key password is set to the same password that is used for the \f3keystore\fR\&. The \f3keypass\fR value must be at least 6 characters\&. +.TP +-importcert +.sp +.nf +\f3{\-alias \fIalias\fR} {\-file \fIcert_file\fR} [\-keypass \fIkeypass\fR] {\-noprompt} {\-trustcacerts}\fP +.fi +.sp +.sp +.nf +\f3{\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP +.fi +.sp +.sp +.nf +\f3{\-providerName \fIprovider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-v} {\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Reads the certificate or certificate chain (where the latter is supplied in a PKCS#7 formatted reply or a sequence of X\&.509 certificates) from the file \f3cert_file\fR, and stores it in the \f3keystore\fR entry identified by \f3alias\fR\&. If no file is specified, then the certificate or certificate chain is read from \f3stdin\fR\&. + +The \f3keytool\fR command can import X\&.509 v1, v2, and v3 certificates, and PKCS#7 formatted certificate chains consisting of certificates of that type\&. The data to be imported must be provided either in binary encoding format or in printable encoding format (also known as Base64 encoding) as defined by the Internet RFC 1421 standard\&. In the latter case, the encoding must be bounded at the beginning by a string that starts with \f3-\fR\f3----BEGIN\fR, and bounded at the end by a string that starts with \f3-----END\fR\&. + +You import a certificate for two reasons: To add it to the list of trusted certificates, and to import a certificate reply received from a certificate authority (CA) as the result of submitting a Certificate Signing Request to that CA (see the \f3-certreq\fR option in Commands)\&. + +Which type of import is intended is indicated by the value of the \f3-alias\fR option\&. If the alias does not point to a key entry, then the \f3keytool\fR command assumes you are adding a trusted certificate entry\&. In this case, the alias should not already exist in the keystore\&. If the alias does already exist, then the \f3keytool\fR command outputs an error because there is already a trusted certificate for that alias, and does not import the certificate\&. If the alias points to a key entry, then the \f3keytool\fR command assumes you are importing a certificate reply\&. +.TP +-importpassword +.sp +.nf +\f3{\-alias \fIalias\fR} [\-keypass \fIkeypass\fR] {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-storepass \fIstorepass\fR]\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-v} {\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Imports a passphrase and stores it in a new \f3KeyStore\&.SecretKeyEntry\fR identified by \f3alias\fR\&. The passphrase may be supplied via the standard input stream; otherwise the user is prompted for it\&. \f3keypass\fR is a password used to protect the imported passphrase\&. If no password is provided, the user is prompted for it\&. If you press the Return key at the prompt, the key password is set to the same password as that used for the \f3keystore\fR\&. \f3keypass\fR must be at least 6 characters long\&. +.TP +-importkeystore +.sp +.nf +\f3{\-srcstoretype \fIsrcstoretype\fR} {\-deststoretype \fIdeststoretype\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-srcstorepass \fIsrcstorepass\fR] [\-deststorepass \fIdeststorepass\fR] {\-srcprotected}\fP +.fi +.sp +.sp +.nf +\f3{\-destprotected} \fP +.fi +.sp +.sp +.nf +\f3{\-srcalias \fIsrcalias\fR {\-destalias \fIdestalias\fR} [\-srckeypass \fIsrckeypass\fR]} \fP +.fi +.sp +.sp +.nf +\f3[\-destkeypass \fIdestkeypass\fR] {\-noprompt}\fP +.fi +.sp +.sp +.nf +\f3{\-srcProviderName \fIsrc_provider_name\fR} {\-destProviderName \fIdest_provider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}} {\-v}\fP +.fi +.sp +.sp +.nf +\f3{\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Imports a single entry or all entries from a source keystore to a destination keystore\&. + +When the \f3-srcalias\fR option is provided, the command imports the single entry identified by the alias to the destination keystore\&. If a destination alias is not provided with \f3destalias\fR, then \f3srcalias\fR is used as the destination alias\&. If the source entry is protected by a password, then \f3srckeypass\fR is used to recover the entry\&. If \fIsrckeypass\fR is not provided, then the \f3keytool\fR command attempts to use \f3srcstorepass\fR to recover the entry\&. If \f3srcstorepass\fR is either not provided or is incorrect, then the user is prompted for a password\&. The destination entry is protected with \f3destkeypass\fR\&. If \f3destkeypass\fR is not provided, then the destination entry is protected with the source entry password\&. For example, most third-party tools require \f3storepass\fR and \f3keypass\fR in a PKCS #12 keystore to be the same\&. In order to create a PKCS #12 keystore for these tools, always specify a \f3-destkeypass\fR to be the same as \f3-deststorepass\fR\&. + +If the \f3-srcalias\fR option is not provided, then all entries in the source keystore are imported into the destination keystore\&. Each destination entry is stored under the alias from the source entry\&. If the source entry is protected by a password, then \f3srcstorepass\fR is used to recover the entry\&. If \f3srcstorepass\fR is either not provided or is incorrect, then the user is prompted for a password\&. If a source keystore entry type is not supported in the destination keystore, or if an error occurs while storing an entry into the destination keystore, then the user is prompted whether to skip the entry and continue or to quit\&. The destination entry is protected with the source entry password\&. + +If the destination alias already exists in the destination keystore, then the user is prompted to either overwrite the entry or to create a new entry under a different alias name\&. + +If the \f3-noprompt\fR option is provided, then the user is not prompted for a new destination alias\&. Existing entries are overwritten with the destination alias name\&. Entries that cannot be imported are skipped and a warning is displayed\&. +.TP +-printcertreq +.sp +.nf +\f3{\-file \fIfile\fR}\fP +.fi +.sp + + +Prints the content of a PKCS #10 format certificate request, which can be generated by the \f3keytool\fR\f3-certreq\fR command\&. The command reads the request from file\&. If there is no file, then the request is read from the standard input\&. +.TP +-certreq +.sp +.nf +\f3{\-alias \fIalias\fR} {\-dname \fIdname\fR} {\-sigalg \fIsigalg\fR} {\-file \fIcertreq_file\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-keypass \fIkeypass\fR] {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-v} {\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Generates a Certificate Signing Request (CSR) using the PKCS #10 format\&. + +A CSR is intended to be sent to a certificate authority (CA)\&. The CA authenticates the certificate requestor (usually off-line) and will return a certificate or certificate chain, used to replace the existing certificate chain (which initially consists of a self-signed certificate) in the keystore\&. + +The private key associated with alias is used to create the PKCS #10 certificate request\&. To access the private key, the correct password must be provided\&. If \f3keypass\fR is not provided at the command line and is different from the password used to protect the integrity of the keystore, then the user is prompted for it\&. If \f3dname\fR is provided, then it is used as the subject in the CSR\&. Otherwise, the X\&.500 Distinguished Name associated with alias is used\&. + +The \f3sigalg\fR value specifies the algorithm that should be used to sign the CSR\&. + +The CSR is stored in the file certreq_file\&. If no file is specified, then the CSR is output to \f3stdout\fR\&. + +Use the \f3importcert\fR command to import the response from the CA\&. +.TP +-exportcert +.sp +.nf +\f3{\-alias \fIalias\fR} {\-file \fIcert_file\fR} {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-rfc} {\-v} {\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Reads from the keystore the certificate associated with \fIalias\fR and stores it in the cert_file file\&. When no file is specified, the certificate is output to \f3stdout\fR\&. + +The certificate is by default output in binary encoding\&. If the \f3-rfc\fR option is specified, then the output in the printable encoding format defined by the Internet RFC 1421 Certificate Encoding Standard\&. + +If \f3alias\fR refers to a trusted certificate, then that certificate is output\&. Otherwise, \f3alias\fR refers to a key entry with an associated certificate chain\&. In that case, the first certificate in the chain is returned\&. This certificate authenticates the public key of the entity addressed by \f3alias\fR\&. + +This command was named \f3-export\fR in earlier releases\&. The old name is still supported in this release\&. The new name, \f3-exportcert\fR, is preferred going forward\&. +.TP +-list +.sp +.nf +\f3{\-alias \fIalias\fR} {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP +.fi +.sp +.sp +.nf +\f3{\-providerName \fIprovider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-v | \-rfc} {\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Prints to \f3stdout\fR the contents of the keystore entry identified by \f3alias\fR\&. If no \f3alias\fR is specified, then the contents of the entire keystore are printed\&. + +This command by default prints the SHA1 fingerprint of a certificate\&. If the \f3-v\fR option is specified, then the certificate is printed in human-readable format, with additional information such as the owner, issuer, serial number, and any extensions\&. If the \f3-rfc\fR option is specified, then the certificate contents are printed using the printable encoding format, as defined by the Internet RFC 1421 Certificate Encoding Standard\&. + +You cannot specify both \f3-v\fR and \f3-rfc\fR\&. +.TP +-printcert +.sp +.nf +\f3{\-file \fIcert_file\fR | \-sslserver \fIhost\fR[:\fIport\fR]} {\-jarfile \fIJAR_file\fR {\-rfc} {\-v}\fP +.fi +.sp +.sp +.nf +\f3{\-Jjavaoption}\fP +.fi +.sp + + +Reads the certificate from the file cert_file, the SSL server located at host:port, or the signed JAR file \f3JAR_file\fR (with the \f3-jarfile\fR option and prints its contents in a human-readable format\&. When no port is specified, the standard HTTPS port 443 is assumed\&. Note that \f3-sslserver\fR and -file options cannot be provided at the same time\&. Otherwise, an error is reported\&. If neither option is specified, then the certificate is read from \f3stdin\fR\&. + +When\f3-rfc\fR is specified, the \f3keytool\fR command prints the certificate in PEM mode as defined by the Internet RFC 1421 Certificate Encoding standard\&. See Internet RFC 1421 Certificate Encoding Standard\&. + +If the certificate is read from a file or \f3stdin\fR, then it might be either binary encoded or in printable encoding format, as defined by the RFC 1421 Certificate Encoding standard\&. + +If the SSL server is behind a firewall, then the \f3-J-Dhttps\&.proxyHost=proxyhost\fR and \f3-J-Dhttps\&.proxyPort=proxyport\fR options can be specified on the command line for proxy tunneling\&. See Java Secure Socket Extension (JSSE) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide\&.html + +\fINote:\fR This option can be used independently of a keystore\&. +.TP +-printcrl +.sp +.nf +\f3\-file \fIcrl_\fR {\-v}\fP +.fi +.sp + + +Reads the Certificate Revocation List (CRL) from the file \f3crl_\fR\&. A CRL is a list of digital certificates that were revoked by the CA that issued them\&. The CA generates the \f3crl_\fR file\&. + +\fINote:\fR This option can be used independently of a keystore\&. +.TP +-storepasswd +.sp +.nf +\f3[\-new \fInew_storepass\fR] {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-v} {\-Jjavaoption}\fP +.fi +.sp + + +Changes the password used to protect the integrity of the keystore contents\&. The new password is \f3new_storepass\fR, which must be at least 6 characters\&. +.TP +-keypasswd +.sp +.nf +\f3{\-alias \fIalias\fR} [\-keypass \fIold_keypass\fR] [\-new \fInew_keypass\fR] {\-storetype \fIstoretype\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}} {\-v}\fP +.fi +.sp +.sp +.nf +\f3{\-Jjavaoption}\fP +.fi +.sp + + +Changes the password under which the private/secret key identified by \f3alias\fR is protected, from \f3old_keypass\fR to \f3new_keypass\fR, which must be at least 6 characters\&. + +If the \f3-keypass\fR option is not provided at the command line, and the key password is different from the keystore password, then the user is prompted for it\&. + +If the \f3-new\fR option is not provided at the command line, then the user is prompted for it +.TP +-delete +.sp +.nf +\f3[\-alias \fIalias\fR] {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP +.fi +.sp +.sp +.nf +\f3{\-providerName \fIprovider_name\fR} \fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-v} {\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Deletes from the keystore the entry identified by \f3alias\fR\&. The user is prompted for the alias, when no alias is provided at the command line\&. +.TP +-changealias +.sp +.nf +\f3{\-alias \fIalias\fR} [\-destalias \fIdestalias\fR] [\-keypass \fIkeypass\fR] {\-storetype \fIstoretype\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}} {\-v}\fP +.fi +.sp +.sp +.nf +\f3{\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Move an existing keystore entry from the specified \f3alias\fR to a new alias, \f3destalias\fR\&. If no destination alias is provided, then the command prompts for one\&. If the original entry is protected with an entry password, then the password can be supplied with the \f3-keypass\fR option\&. If no key password is provided, then the \f3storepass\fR (if provided) is attempted first\&. If the attempt fails, then the user is prompted for a password\&. +.TP +-help +.br +Lists the basic commands and their options\&. + +For more information about a specific command, enter the following, where \f3command_name\fR is the name of the command: \f3keytool -command_name -help\fR\&. +.SH EXAMPLES +This example walks through the sequence of steps to create a keystore for managing public/private key pair and certificates from trusted entities\&. +.SS GENERATE\ THE\ KEY\ PAIR +First, create a keystore and generate the key pair\&. You can use a command such as the following typed as a single line: +.sp +.nf +\f3keytool \-genkeypair \-dname "cn=Mark Jones, ou=Java, o=Oracle, c=US"\fP +.fi +.nf +\f3 \-alias business \-keypass <new password for private key>\fP +.fi +.nf +\f3 \-keystore /working/mykeystore\fP +.fi +.nf +\f3 \-storepass <new password for keystore> \-validity 180\fP +.fi +.nf +\f3\fP +.fi +.sp +The command creates the keystore named \f3mykeystore\fR in the working directory (assuming it does not already exist), and assigns it the password specified by \f3<new password for keystore>\fR\&. It generates a public/private key pair for the entity whose distinguished name has a common name of Mark Jones, organizational unit of Java, organization of Oracle and two-letter country code of US\&. It uses the default DSA key generation algorithm to create the keys; both are 1024 bits\&. +.PP +The command uses the default SHA1withDSA signature algorithm to create a self-signed certificate that includes the public key and the distinguished name information\&. The certificate is valid for 180 days, and is associated with the private key in a keystore entry referred to by the alias \f3business\fR\&. The private key is assigned the password specified by \f3<new password for private key>\fR\&. +.PP +The command is significantly shorter when the option defaults are accepted\&. In this case, no options are required, and the defaults are used for unspecified options that have default values\&. You are prompted for any required values\&. You could have the following: +.sp +.nf +\f3keytool \-genkeypair\fP +.fi +.nf +\f3\fP +.fi +.sp +In this case, a keystore entry with the alias \f3mykey\fR is created, with a newly generated key pair and a certificate that is valid for 90 days\&. This entry is placed in the keystore named \f3\&.keystore\fR in your home directory\&. The keystore is created when it does not already exist\&. You are prompted for the distinguished name information, the keystore password, and the private key password\&. +.PP +The rest of the examples assume you executed the \f3-genkeypair\fR command without options specified, and that you responded to the prompts with values equal to those specified in the first \f3-genkeypair\fR command\&. For example, a distinguished name of \f3cn=Mark Jones\fR, \f3ou=Java\fR, \f3o=Oracle\fR, \f3c=US\fR)\&. +.SS REQUEST\ A\ SIGNED\ CERTIFICATE\ FROM\ A\ CA +Generating the key pair created a self-signed certificate\&. A certificate is more likely to be trusted by others when it is signed by a Certification Authority (CA)\&. To get a CA signature, first generate a Certificate Signing Request (CSR), as follows: +.sp +.nf +\f3keytool \-certreq \-file MarkJ\&.csr\fP +.fi +.nf +\f3\fP +.fi +.sp +This creates a CSR for the entity identified by the default alias \f3mykey\fR and puts the request in the file named MarkJ\&.csr\&. Submit this file to a CA, such as VeriSign\&. The CA authenticates you, the requestor (usually off-line), and returns a certificate, signed by them, authenticating your public key\&. In some cases, the CA returns a chain of certificates, each one authenticating the public key of the signer of the previous certificate in the chain\&. +.SS IMPORT\ A\ CERTIFICATE\ FOR\ THE\ CA +You now need to replace the self-signed certificate with a certificate chain, where each certificate in the chain authenticates the public key of the signer of the previous certificate in the chain, up to a root CA\&. +.PP +Before you import the certificate reply from a CA, you need one or more trusted certificates in your keystore or in the \f3cacerts\fR keystore file\&. See \f3-importcert\fR in Commands\&. +.TP 0.2i +\(bu +If the certificate reply is a certificate chain, then you need the top certificate of the chain\&. The root CA certificate that authenticates the public key of the CA\&. +.TP 0.2i +\(bu +If the certificate reply is a single certificate, then you need a certificate for the issuing CA (the one that signed it)\&. If that certificate is not self-signed, then you need a certificate for its signer, and so on, up to a self-signed root CA certificate\&. +.PP +The \f3cacerts\fR keystore file ships with several VeriSign root CA certificates, so you probably will not need to import a VeriSign certificate as a trusted certificate in your keystore\&. But if you request a signed certificate from a different CA, and a certificate authenticating that CA\&'s public key was not added to \f3cacerts\fR, then you must import a certificate from the CA as a trusted certificate\&. +.PP +A certificate from a CA is usually either self-signed or signed by another CA, in which case you need a certificate that authenticates that CA\&'s public key\&. Suppose company ABC, Inc\&., is a CA, and you obtain a file named A\f3BCCA\&.cer\fR that is supposed to be a self-signed certificate from ABC, that authenticates that CA\&'s public key\&. Be careful to ensure the certificate is valid before you import it as a trusted certificate\&. View it first with the \f3keytool -printcert\fR command or the \f3keytool -importcert\fR command without the \f3-noprompt\fR option, and make sure that the displayed certificate fingerprints match the expected ones\&. You can call the person who sent the certificate, and compare the fingerprints that you see with the ones that they show or that a secure public key repository shows\&. Only when the fingerprints are equal is it guaranteed that the certificate was not replaced in transit with somebody else\&'s (for example, an attacker\&'s) certificate\&. If such an attack takes place, and you did not check the certificate before you imported it, then you would be trusting anything the attacker has signed\&. +.PP +If you trust that the certificate is valid, then you can add it to your keystore with the following command: +.sp +.nf +\f3keytool \-importcert \-alias abc \-file ABCCA\&.cer\fP +.fi +.nf +\f3\fP +.fi +.sp +This command creates a trusted certificate entry in the keystore, with the data from the file ABCCA\&.cer, and assigns the alias \f3abc\fR to the entry\&. +.SS IMPORT\ THE\ CERTIFICATE\ REPLY\ FROM\ THE\ CA +After you import a certificate that authenticates the public key of the CA you submitted your certificate signing request to (or there is already such a certificate in the cacerts file), you can import the certificate reply and replace your self-signed certificate with a certificate chain\&. This chain is the one returned by the CA in response to your request (when the CA reply is a chain), or one constructed (when the CA reply is a single certificate) using the certificate reply and trusted certificates that are already available in the keystore where you import the reply or in the \f3cacerts\fR keystore file\&. +.PP +For example, if you sent your certificate signing request to VeriSign, then you can import the reply with the following, which assumes the returned certificate is named VSMarkJ\&.cer: +.sp +.nf +\f3keytool \-importcert \-trustcacerts \-file VSMarkJ\&.cer\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS EXPORT\ A\ CERTIFICATE\ THAT\ AUTHENTICATES\ THE\ PUBLIC\ KEY +If you used the \f3jarsigner\fR command to sign a Java Archive (JAR) file, then clients that want to use the file will want to authenticate your signature\&. One way the clients can authenticate you is by first importing your public key certificate into their keystore as a trusted entry\&. +.PP +You can export the certificate and supply it to your clients\&. As an example, you can copy your certificate to a file named MJ\&.cer with the following command that assumes the entry has an alias of \f3mykey\fR: +.sp +.nf +\f3keytool \-exportcert \-alias mykey \-file MJ\&.cer\fP +.fi +.nf +\f3\fP +.fi +.sp +With the certificate and the signed JAR file, a client can use the \f3jarsigner\fR command to authenticate your signature\&. +.SS IMPORT\ KEYSTORE +The command \f3importkeystore\fR is used to import an entire keystore into another keystore, which means all entries from the source keystore, including keys and certificates, are all imported to the destination keystore within a single command\&. You can use this command to import entries from a different type of keystore\&. During the import, all new entries in the destination keystore will have the same alias names and protection passwords (for secret keys and private keys)\&. If the \f3keytool\fR command cannot recover the private keys or secret keys from the source keystore, then it prompts you for a password\&. If it detects alias duplication, then it asks you for a new alias, and you can specify a new alias or simply allow the \f3keytool\fR command to overwrite the existing one\&. +.PP +For example, to import entries from a typical JKS type keystore key\&.jks into a PKCS #11 type hardware-based keystore, use the command: +.sp +.nf +\f3keytool \-importkeystore\fP +.fi +.nf +\f3 \-srckeystore key\&.jks \-destkeystore NONE\fP +.fi +.nf +\f3 \-srcstoretype JKS \-deststoretype PKCS11\fP +.fi +.nf +\f3 \-srcstorepass <src keystore password>\fP +.fi +.nf +\f3 \-deststorepass <destination keystore pwd>\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3importkeystore\fR command can also be used to import a single entry from a source keystore to a destination keystore\&. In this case, besides the options you see in the previous example, you need to specify the alias you want to import\&. With the \f3-srcalias\fR option specified, you can also specify the destination alias name in the command line, as well as protection password for a secret/private key and the destination protection password you want\&. The following command demonstrates this: +.sp +.nf +\f3keytool \-importkeystore\fP +.fi +.nf +\f3 \-srckeystore key\&.jks \-destkeystore NONE\fP +.fi +.nf +\f3 \-srcstoretype JKS \-deststoretype PKCS11\fP +.fi +.nf +\f3 \-srcstorepass <src keystore password>\fP +.fi +.nf +\f3 \-deststorepass <destination keystore pwd>\fP +.fi +.nf +\f3 \-srcalias myprivatekey \-destalias myoldprivatekey\fP +.fi +.nf +\f3 \-srckeypass <source entry password>\fP +.fi +.nf +\f3 \-destkeypass <destination entry password>\fP +.fi +.nf +\f3 \-noprompt\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS GENERATE\ CERTIFICATES\ FOR\ AN\ SSL\ SERVER +The following are \f3keytool\fR commands to generate key pairs and certificates for three entities: Root CA (\f3root\fR), Intermediate CA (\f3ca\fR), and SSL server (\f3server\fR)\&. Ensure that you store all the certificates in the same keystore\&. In these examples, RSA is the recommended the key algorithm\&. +.sp +.nf +\f3keytool \-genkeypair \-keystore root\&.jks \-alias root \-ext bc:c\fP +.fi +.nf +\f3keytool \-genkeypair \-keystore ca\&.jks \-alias ca \-ext bc:c\fP +.fi +.nf +\f3keytool \-genkeypair \-keystore server\&.jks \-alias server\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3keytool \-keystore root\&.jks \-alias root \-exportcert \-rfc > root\&.pem\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3keytool \-storepass <storepass> \-keystore ca\&.jks \-certreq \-alias ca |\fP +.fi +.nf +\f3 keytool \-storepass <storepass> \-keystore root\&.jks\fP +.fi +.nf +\f3 \-gencert \-alias root \-ext BC=0 \-rfc > ca\&.pem\fP +.fi +.nf +\f3keytool \-keystore ca\&.jks \-importcert \-alias ca \-file ca\&.pem\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3keytool \-storepass <storepass> \-keystore server\&.jks \-certreq \-alias server |\fP +.fi +.nf +\f3 keytool \-storepass <storepass> \-keystore ca\&.jks \-gencert \-alias ca\fP +.fi +.nf +\f3 \-ext ku:c=dig,kE \-rfc > server\&.pem\fP +.fi +.nf +\f3cat root\&.pem ca\&.pem server\&.pem |\fP +.fi +.nf +\f3 keytool \-keystore server\&.jks \-importcert \-alias server\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH TERMS +.TP +Keystore +A keystore is a storage facility for cryptographic keys and certificates\&. +.TP +Keystore entries +Keystores can have different types of entries\&. The two most applicable entry types for the \f3keytool\fR command include the following: + +\fIKey entries\fR: Each entry holds very sensitive cryptographic key information, which is stored in a protected format to prevent unauthorized access\&. Typically, a key stored in this type of entry is a secret key, or a private key accompanied by the certificate chain for the corresponding public key\&. See Certificate Chains\&. The \f3keytool\fR command can handle both types of entries, while the \f3jarsigner\fR tool only handles the latter type of entry, that is private keys and their associated certificate chains\&. + +\fITrusted certificate entries\fR: Each entry contains a single public key certificate that belongs to another party\&. The entry is called a trusted certificate because the keystore owner trusts that the public key in the certificate belongs to the identity identified by the subject (owner) of the certificate\&. The issuer of the certificate vouches for this, by signing the certificate\&. +.TP +KeyStore aliases +All keystore entries (key and trusted certificate entries) are accessed by way of unique aliases\&. + +An alias is specified when you add an entity to the keystore with the \f3-genseckey\fR command to generate a secret key, the \f3-genkeypair\fR command to generate a key pair (public and private key), or the \f3-importcert\fR command to add a certificate or certificate chain to the list of trusted certificates\&. Subsequent \f3keytool\fR commands must use this same alias to refer to the entity\&. + +For example, you can use the alias \f3duke\fR to generate a new public/private key pair and wrap the public key into a self-signed certificate with the following command\&. See Certificate Chains\&. +.sp +.nf +\f3keytool \-genkeypair \-alias duke \-keypass dukekeypasswd\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This example specifies an initial password of \f3dukekeypasswd\fR required by subsequent commands to access the private key associated with the alias \f3duke\fR\&. If you later want to change Duke\&'s private key password, use a command such as the following: +.sp +.nf +\f3keytool \-keypasswd \-alias duke \-keypass dukekeypasswd \-new newpass\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This changes the password from \f3dukekeypasswd\fR to \f3newpass\fR\&. A password should not be specified on a command line or in a script unless it is for testing purposes, or you are on a secure system\&. If you do not specify a required password option on a command line, then you are prompted for it\&. +.TP +KeyStore implementation +The \f3KeyStore\fR class provided in the \f3java\&.security\fR 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 type of keystore\&. + +Currently, two command-line tools (\f3keytool\fR and \f3jarsigner\fR) and a GUI-based tool named Policy Tool make use of keystore implementations\&. Because the \f3KeyStore\fR class is \f3public\fR, users can write additional security applications that use it\&. + +There is a built-in default implementation, provided by Oracle\&. It implements the keystore as a file with a proprietary keystore type (format) named JKS\&. It protects each private key with its individual password, and also protects the integrity of the entire keystore with a (possibly different) password\&. + +Keystore implementations are provider-based\&. More specifically, the application interfaces supplied by \f3KeyStore\fR are implemented in terms of a Service Provider Interface (SPI)\&. That is, there is a corresponding abstract \f3KeystoreSpi\fR class, also in the \f3java\&.security package\fR, which defines the Service Provider Interface methods that providers must implement\&. The term \fIprovider\fR refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API\&. To provide a keystore implementation, clients must implement a provider and supply a \f3KeystoreSpi\fR subclass implementation, as described in How to Implement a Provider in the Java Cryptography Architecture at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/HowToImplAProvider\&.html + +Applications can choose different types of keystore implementations from different providers, using the \f3getInstance\fR factory method supplied in the \f3KeyStore\fR class\&. A keystore type defines the storage and data format of the keystore information, and the algorithms used to protect private/secret keys in the keystore and the integrity of the keystore\&. Keystore implementations of different types are not compatible\&. + +The \f3keytool\fR command works on any file-based keystore implementation\&. It treats the keystore location that is passed to it at the command line as a file name and converts it to a \f3FileInputStream\fR, from which it loads the keystore information\&.)The \f3jarsigner\fR and \f3policytool\fR commands can read a keystore from any location that can be specified with a URL\&. + +For \f3keytool\fR and \f3jarsigner\fR, you can specify a keystore type at the command line, with the \f3-storetype\fR option\&. For Policy Tool, you can specify a keystore type with the \fIKeystore\fR menu\&. + +If you do not explicitly specify a keystore type, then the tools choose a keystore implementation based on the value of the \f3keystore\&.type\fR property specified in the security properties file\&. The security properties file is called \f3java\&.security\fR, and resides in the security properties directory, \f3java\&.home\elib\esecurity\fR on Windows and \f3java\&.home/lib/security\fR on Oracle Solaris, where \f3java\&.home\fR is the runtime environment directory\&. The \f3jre\fR directory in the SDK or the top-level directory of the Java Runtime Environment (JRE)\&. + +Each tool gets the \f3keystore\&.type\fR value and then examines all the currently installed providers until it finds one that implements a keystores of that type\&. It then uses the keystore implementation from that provider\&.The \f3KeyStore\fR class defines a static method named \f3getDefaultType\fR that lets applications and applets retrieve the value of the \f3keystore\&.type\fR property\&. The following line of code creates an instance of the default keystore type as specified in the \f3keystore\&.type\fR property: +.sp +.nf +\f3KeyStore keyStore = KeyStore\&.getInstance(KeyStore\&.getDefaultType());\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The default keystore type is \f3jks\fR, which is the proprietary type of the keystore implementation provided by Oracle\&. This is specified by the following line in the security properties file: +.sp +.nf +\f3keystore\&.type=jks\fP +.fi +.nf +\f3\fP +.fi +.sp + + +To have the tools utilize a keystore implementation other than the default, you can change that line to specify a different keystore type\&. For example, if you have a provider package that supplies a keystore implementation for a keystore type called \f3pkcs12\fR, then change the line to the following: +.sp +.nf +\f3keystore\&.type=pkcs12\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fINote:\fR Case does not matter in keystore type designations\&. For example, JKS would be considered the same as jks\&. +.TP +Certificate +A certificate (or public-key certificate) is a digitally signed statement from one entity (the issuer), saying that the public key and some other information of another entity (the subject) has some specific value\&. The following terms are related to certificates: + +\fIPublic Keys\fR: These are numbers associated with a particular entity, and are intended to be known to everyone who needs to have trusted interactions with that entity\&. Public keys are used to verify signatures\&. + +\fIDigitally Signed\fR: If some data is digitally signed, then it is stored with the identity of an entity and a signature that proves that entity knows about the data\&. The data is rendered unforgeable by signing with the entity\&'s private key\&. + +\fIIdentity\fR: A known way of addressing an entity\&. In some systems, the identity is the public key, and in others it can be anything from an Oracle Solaris UID to an email address to an X\&.509 distinguished name\&. + +\fISignature\fR: A signature is computed over some data using the private key of an entity\&. The signer, which in the case of a certificate is also known as the issuer\&. + +\fIPrivate Keys\fR: These are numbers, each of which is supposed to be known only to the particular entity whose private key it is (that is, it is supposed to be kept secret)\&. Private and public keys exist in pairs in all public key cryptography systems (also referred to as public key crypto systems)\&. In a typical public key crypto system, such as DSA, a private key corresponds to exactly one public key\&. Private keys are used to compute signatures\&. + +\fIEntity\fR: An entity is a person, organization, program, computer, business, bank, or something else you are trusting to some degree\&. + +Public key cryptography requires access to users\&' public keys\&. In a large-scale networked environment, it is impossible to guarantee that prior relationships between communicating entities were established or that a trusted repository exists with all used public keys\&. Certificates were invented as a solution to this public key distribution problem\&. Now a Certification Authority (CA) can act as a trusted third party\&. CAs are entities such as businesses that are trusted to sign (issue) certificates for other entities\&. It is assumed that CAs only create valid and reliable certificates because they are bound by legal agreements\&. There are many public Certification Authorities, such as VeriSign, Thawte, Entrust, and so on\&. + +You can also run your own Certification Authority using products such as Microsoft Certificate Server or the Entrust CA product for your organization\&. With the \f3keytool\fR command, it is possible to display, import, and export certificates\&. It is also possible to generate self-signed certificates\&. + +The \f3keytool\fR command currently handles X\&.509 certificates\&. +.TP +X\&.509 Certificates +The X\&.509 standard defines what information can go into a certificate and describes how to write it down (the data format)\&. All the data in a certificate is encoded with two related standards called ASN\&.1/DER\&. Abstract Syntax Notation 1 describes data\&. The Definite Encoding Rules describe a single way to store and transfer that data\&. + +All X\&.509 certificates have the following data, in addition to the signature: + +\fIVersion\fR: This identifies which version of the X\&.509 standard applies to this certificate, which affects what information can be specified in it\&. Thus far, three versions are defined\&. The \f3keytool\fR command can import and export v1, v2, and v3 certificates\&. It generates v3 certificates\&. + +X\&.509 Version 1 has been available since 1988, is widely deployed, and is the most generic\&. + +X\&.509 Version 2 introduced the concept of subject and issuer unique identifiers to handle the possibility of reuse of subject or issuer names over time\&. Most certificate profile documents strongly recommend that names not be reused and that certificates should not make use of unique identifiers\&. Version 2 certificates are not widely used\&. + +X\&.509 Version 3 is the most recent (1996) and supports the notion of extensions where anyone can define an extension and include it in the certificate\&. Some common extensions are: KeyUsage (limits the use of the keys to particular purposes such as \f3signing-only\fR) and AlternativeNames (allows other identities to also be associated with this public key, for example\&. DNS names, email addresses, IP addresses)\&. Extensions can be marked critical to indicate that the extension should be checked and enforced or used\&. For example, if a certificate has the KeyUsage extension marked critical and set to \f3keyCertSign\fR, then when this certificate is presented during SSL communication, it should be rejected because the certificate extension indicates that the associated private key should only be used for signing certificates and not for SSL use\&. + +\fISerial number\fR: The entity that created the certificate is responsible for assigning it a serial number to distinguish it from other certificates it issues\&. This information is used in numerous ways\&. For example, when a certificate is revoked its serial number is placed in a Certificate Revocation List (CRL)\&. + +\fISignature algorithm identifier\fR: This identifies the algorithm used by the CA to sign the certificate\&. + +\fIIssuer name\fR: The X\&.500 Distinguished Name of the entity that signed the certificate\&. See X\&.500 Distinguished Names\&. This is typically a CA\&. Using this certificate implies trusting the entity that signed this certificate\&. In some cases, such as root or top-level CA certificates, the issuer signs its own certificate\&. + +\fIValidity period\fR: Each certificate is valid only for a limited amount of time\&. This period is described by a start date and time and an end date and time, and can be as short as a few seconds or almost as long as a century\&. The validity period chosen depends on a number of factors, such as the strength of the private key used to sign the certificate, or the amount one is willing to pay for a certificate\&. This is the expected period that entities can rely on the public value, when the associated private key has not been compromised\&. + +\fISubject name\fR: The name of the entity whose public key the certificate identifies\&. This name uses the X\&.500 standard, so it is intended to be unique across the Internet\&. This is the X\&.500 Distinguished Name (DN) of the entity\&. See X\&.500 Distinguished Names\&. For example, +.sp +.nf +\f3CN=Java Duke, OU=Java Software Division, O=Oracle Corporation, C=US\fP +.fi +.nf +\f3\fP +.fi +.sp + + +These refer to the subject\&'s common name (CN), organizational unit (OU), organization (O), and country (C)\&. + +\fISubject public key information\fR: This is the public key of the entity being named with an algorithm identifier that specifies which public key crypto system this key belongs to and any associated key parameters\&. +.TP +Certificate Chains +The \f3keytool\fR command can create and manage keystore key entries that each contain a private key and an associated certificate chain\&. The first certificate in the chain contains the public key that corresponds to the private key\&. + +When keys are first generated, the chain starts off containing a single element, a self-signed certificate\&. See \f3-genkeypair\fR in Commands\&. A self-signed certificate is one for which the issuer (signer) is the same as the subject\&. The subject is the entity whose public key is being authenticated by the certificate\&. Whenever the \f3-genkeypair\fR command is called to generate a new public/private key pair, it also wraps the public key into a self-signed certificate\&. + +Later, after a Certificate Signing Request (CSR) was generated with the \f3-certreq\fR command and sent to a Certification Authority (CA), the response from the CA is imported with \f3-importcert\fR, and the self-signed certificate is replaced by a chain of certificates\&. See the \f3-certreq\fR and \f3-importcert\fR options in Commands\&. At the bottom of the chain is the certificate (reply) issued by the CA authenticating the subject\&'s public key\&. The next certificate in the chain is one that authenticates the CA\&'s public key\&. + +In many cases, this is a self-signed certificate, which is a certificate from the CA authenticating its own public key, and the last certificate in the chain\&. In other cases, the CA might return a chain of certificates\&. In this case, the bottom certificate in the chain is the same (a certificate signed by the CA, authenticating the public key of the key entry), but the second certificate in the chain is a certificate signed by a different CA that authenticates the public key of the CA you sent the CSR to\&. The next certificate in the chain is a certificate that authenticates the second CA\&'s key, and so on, until a self-signed root certificate is reached\&. Each certificate in the chain (after the first) authenticates the public key of the signer of the previous certificate in the chain\&. + +Many CAs only return the issued certificate, with no supporting chain, especially when there is a flat hierarchy (no intermediates CAs)\&. In this case, the certificate chain must be established from trusted certificate information already stored in the keystore\&. + +A different reply format (defined by the PKCS #7 standard) includes the supporting certificate chain in addition to the issued certificate\&. Both reply formats can be handled by the \f3keytool\fR command\&. + +The top-level (root) CA certificate is self-signed\&. However, the trust into the root\&'s public key does not come from the root certificate itself, but from other sources such as a newspaper\&. This is because anybody could generate a self-signed certificate with the distinguished name of, for example, the VeriSign root CA\&. The root CA public key is widely known\&. The only reason it is stored in a certificate is because this is the format understood by most tools, so the certificate in this case is only used as a vehicle to transport the root CA\&'s public key\&. Before you add the root CA certificate to your keystore, you should view it with the \f3-printcert\fR option and compare the displayed fingerprint with the well-known fingerprint obtained from a newspaper, the root CA\&'s Web page, and so on\&. +.TP +The cacerts Certificates File +A certificates file named \f3cacerts\fR resides in the security properties directory, \f3java\&.home\elib\esecurity\fR on Windows and \f3java\&.home/lib/security\fR on Oracle Solaris, where \f3java\&.home\fR is the runtime environment\&'s directory, which would be the \f3jre\fR directory in the SDK or the top-level directory of the JRE\&. + +The \f3cacerts\fR file represents a system-wide keystore with CA certificates\&. System administrators can configure and manage that file with the \f3keytool\fR command by specifying \f3jks\fR as the keystore type\&. The \f3cacerts\fR keystore file ships with a default set of root CA certificates\&. You can list the default certificates with the following command: +.sp +.nf +\f3keytool \-list \-keystore java\&.home/lib/security/cacerts\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The initial password of the \f3cacerts\fR keystore file is \f3changeit\fR\&. System administrators should change that password and the default access permission of that file upon installing the SDK\&. + +\fINote:\fR It is important to verify your \f3cacerts\fR file\&. Because you trust the CAs in the \f3cacerts\fR file as entities for signing and issuing certificates to other entities, you must manage the \f3cacerts\fR file carefully\&. The \f3cacerts\fR file should contain only certificates of the CAs you trust\&. It is your responsibility to verify the trusted root CA certificates bundled in the \f3cacerts\fR file and make your own trust decisions\&. + +To remove an untrusted CA certificate from the \f3cacerts\fR file, use the \f3delete\fR option of the \f3keytool\fR command\&. You can find the \f3cacerts\fR file in the JRE installation directory\&. Contact your system administrator if you do not have permission to edit this file +.TP +Internet RFC 1421 Certificate Encoding Standard +Certificates are often stored using the printable encoding format defined by the Internet RFC 1421 standard, instead of their binary encoding\&. This certificate format, also known as Base64 encoding, makes it easy to export certificates to other applications by email or through some other mechanism\&. + +Certificates read by the \f3-importcert\fR and \f3-printcert\fR commands can be in either this format or binary encoded\&. The \f3-exportcert\fR command by default outputs a certificate in binary encoding, but will instead output a certificate in the printable encoding format, when the \f3-rfc\fR option is specified\&. + +The \f3-list\fR command by default prints the SHA1 fingerprint of a certificate\&. If the \f3-v\fR option is specified, then the certificate is printed in human-readable format\&. If the \f3-rfc\fR option is specified, then the certificate is output in the printable encoding format\&. + +In its printable encoding format, the encoded certificate is bounded at the beginning and end by the following text: +.sp +.nf +\f3\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3encoded certificate goes here\&. \fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-\-\-\-\-END CERTIFICATE\-\-\-\-\-\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +X\&.500 Distinguished Names +X\&.500 Distinguished Names are used to identify entities, such as those that are named by the \f3subject\fR and \f3issuer\fR (signer) fields of X\&.509 certificates\&. The \f3keytool\fR command supports the following subparts: + +\fIcommonName\fR: The common name of a person such as Susan Jones\&. + +\fIorganizationUnit\fR: The small organization (such as department or division) name\&. For example, Purchasing\&. + +\fIlocalityName\fR: The locality (city) name, for example, Palo Alto\&. + +\fIstateName\fR: State or province name, for example, California\&. + +\fIcountry\fR: Two-letter country code, for example, CH\&. + +When you supply a distinguished name string as the value of a \f3-dname\fR option, such as for the \f3-genkeypair\fR command, the string must be in the following format: +.sp +.nf +\f3CN=cName, OU=orgUnit, O=org, L=city, S=state, C=countryCode\fP +.fi +.nf +\f3\fP +.fi +.sp + + +All the italicized items represent actual values and the previous keywords are abbreviations for the following: +.sp +.nf +\f3CN=commonName\fP +.fi +.nf +\f3OU=organizationUnit\fP +.fi +.nf +\f3O=organizationName\fP +.fi +.nf +\f3L=localityName\fP +.fi +.nf +\f3S=stateName\fP +.fi +.nf +\f3C=country\fP +.fi +.nf +\f3\fP +.fi +.sp + + +A sample distinguished name string is: +.sp +.nf +\f3CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino, S=California, C=US\fP +.fi +.nf +\f3\fP +.fi +.sp + + +A sample command using such a string is: +.sp +.nf +\f3keytool \-genkeypair \-dname "CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino,\fP +.fi +.nf +\f3S=California, C=US" \-alias mark\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Case does not matter for the keyword abbreviations\&. For example, CN, cn, and Cn are all treated the same\&. + +Order matters; each subcomponent must appear in the designated order\&. However, it is not necessary to have all the subcomponents\&. You can use a subset, for example: +.sp +.nf +\f3CN=Steve Meier, OU=Java, O=Oracle, C=US\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If a distinguished name string value contains a comma, then the comma must be escaped by a backslash (\e) character when you specify the string on a command line, as in: +.sp +.nf +\f3cn=Peter Schuster, ou=Java\e, Product Development, o=Oracle, c=US\fP +.fi +.nf +\f3\fP +.fi +.sp + + +It is never necessary to specify a distinguished name string on a command line\&. When the distinguished name is needed for a command, but not supplied on the command line, the user is prompted for each of the subcomponents\&. In this case, a comma does not need to be escaped by a backslash (\e)\&. +.SH WARNINGS +.SS IMPORTING\ TRUSTED\ CERTIFICATES\ WARNING +\fIImportant\fR: Be sure to check a certificate very carefully before importing it as a trusted certificate\&. +.PP +Windows Example: + +View the certificate first with the \f3-printcert\fR command or the \f3-importcert\fR command without the \f3-noprompt\fR option\&. Ensure that the displayed certificate fingerprints match the expected ones\&. For example, suppose sends or emails you a certificate that you put it in a file named \f3\etmp\ecert\fR\&. Before you consider adding the certificate to your list of trusted certificates, you can execute a \f3-printcert\fR command to view its fingerprints, as follows: +.sp +.nf +\f3 keytool \-printcert \-file \etmp\ecert\fP +.fi +.nf +\f3 Owner: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP +.fi +.nf +\f3 Issuer: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP +.fi +.nf +\f3 Serial Number: 59092b34\fP +.fi +.nf +\f3 Valid from: Thu Sep 25 18:01:13 PDT 1997 until: Wed Dec 24 17:01:13 PST 1997\fP +.fi +.nf +\f3 Certificate Fingerprints:\fP +.fi +.nf +\f3 MD5: 11:81:AD:92:C8:E5:0E:A2:01:2E:D4:7A:D7:5F:07:6F\fP +.fi +.nf +\f3 SHA1: 20:B6:17:FA:EF:E5:55:8A:D0:71:1F:E8:D6:9D:C0:37:13:0E:5E:FE\fP +.fi +.nf +\f3 SHA256: 90:7B:70:0A:EA:DC:16:79:92:99:41:FF:8A:FE:EB:90:\fP +.fi +.nf +\f3 17:75:E0:90:B2:24:4D:3A:2A:16:A6:E4:11:0F:67:A4\fP +.fi +.sp + +.PP +Oracle Solaris Example: + +View the certificate first with the \f3-printcert\fR command or the \f3-importcert\fR command without the \f3-noprompt\fR option\&. Ensure that the displayed certificate fingerprints match the expected ones\&. For example, suppose someone sends or emails you a certificate that you put it in a file named \f3/tmp/cert\fR\&. Before you consider adding the certificate to your list of trusted certificates, you can execute a \f3-printcert\fR command to view its fingerprints, as follows: +.sp +.nf +\f3 keytool \-printcert \-file /tmp/cert\fP +.fi +.nf +\f3 Owner: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP +.fi +.nf +\f3 Issuer: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP +.fi +.nf +\f3 Serial Number: 59092b34\fP +.fi +.nf +\f3 Valid from: Thu Sep 25 18:01:13 PDT 1997 until: Wed Dec 24 17:01:13 PST 1997\fP +.fi +.nf +\f3 Certificate Fingerprints:\fP +.fi +.nf +\f3 MD5: 11:81:AD:92:C8:E5:0E:A2:01:2E:D4:7A:D7:5F:07:6F\fP +.fi +.nf +\f3 SHA1: 20:B6:17:FA:EF:E5:55:8A:D0:71:1F:E8:D6:9D:C0:37:13:0E:5E:FE\fP +.fi +.nf +\f3 SHA256: 90:7B:70:0A:EA:DC:16:79:92:99:41:FF:8A:FE:EB:90:\fP +.fi +.nf +\f3 17:75:E0:90:B2:24:4D:3A:2A:16:A6:E4:11:0F:67:A4\fP +.fi +.nf +\f3\fP +.fi +.sp +Then call or otherwise contact the person who sent the certificate and compare the fingerprints that you see with the ones that they show\&. Only when the fingerprints are equal is it guaranteed that the certificate was not replaced in transit with somebody else\&'s certificate such as an attacker\&'s certificate\&. If such an attack took place, and you did not check the certificate before you imported it, then you would be trusting anything the attacker signed, for example, a JAR file with malicious class files inside\&. +.PP +\fINote:\fR It is not required that you execute a \f3-printcert\fR command before importing a certificate\&. This is because before you add a certificate to the list of trusted certificates in the keystore, the \f3-importcert\fR command prints out the certificate information and prompts you to verify it\&. You can then stop the import operation\&. However, you can do this only when you call the \f3-importcert\fR command without the \f3-noprompt\fR option\&. If the \f3-noprompt\fR option is specified, then there is no interaction with the user\&. +.SS PASSWORDS\ WARNING +Most commands that operate on a keystore require the store password\&. Some commands require a private/secret key password\&. Passwords can be specified on the command line in the \f3-storepass\fR and \f3-keypass\fR options\&. However, a password should not be specified on a command line or in a script unless it is for testing, or you are on a secure system\&. When you do not specify a required password option on a command line, you are prompted for it\&. +.SS CERTIFICATE\ CONFORMANCE\ WARNING +The Internet standard RFC 5280 has defined a profile on conforming X\&.509 certificates, which includes what values and value combinations are valid for certificate fields and extensions\&. See the standard at http://tools\&.ietf\&.org/rfc/rfc5280\&.txt +.PP +The \f3keytool\fR command does not enforce all of these rules so it can generate certificates that do not conform to the standard\&. Certificates that do not conform to the standard might be rejected by JRE or other applications\&. Users should ensure that they provide the correct options for \f3-dname\fR, \f3-ext\fR, and so on\&. +.SH NOTES +.SS IMPORT\ A\ NEW\ TRUSTED\ CERTIFICATE +Before you add the certificate to the keystore, the \f3keytool\fR command verifies it by attempting to construct a chain of trust from that certificate to a self-signed certificate (belonging to a root CA), using trusted certificates that are already available in the keystore\&. +.PP +If the \f3-trustcacerts\fR option was specified, then additional certificates are considered for the chain of trust, namely the certificates in a file named \f3cacerts\fR\&. +.PP +If the \f3keytool\fR command fails to establish a trust path from the certificate to be imported up to a self-signed certificate (either from the keystore or the \f3cacerts\fR file), then the certificate information is printed, and the user is prompted to verify it by comparing the displayed certificate fingerprints with the fingerprints obtained from some other (trusted) source of information, which might be the certificate owner\&. Be very careful to ensure the certificate is valid before importing it as a trusted certificate\&. See Importing Trusted Certificates Warning\&. The user then has the option of stopping the import operation\&. If the \f3-noprompt\fR option is specified, then there is no interaction with the user\&. +.SS IMPORT\ A\ CERTIFICATE\ REPLY +When you import a certificate reply, the certificate reply is validated with trusted certificates from the keystore, and optionally, the certificates configured in the \f3cacerts\fR keystore file when the \f3-trustcacert\fR\f3s\fR option is specified\&. See The cacerts Certificates File\&. +.PP +The methods of determining whether the certificate reply is trusted are as follows: +.TP 0.2i +\(bu +If the reply is a single X\&.509 certificate, then the \f3keytool\fR command attempts to establish a trust chain, starting at the certificate reply and ending at a self-signed certificate (belonging to a root CA)\&. The certificate reply and the hierarchy of certificates is used to authenticate the certificate reply from the new certificate chain of aliases\&. If a trust chain cannot be established, then the certificate reply is not imported\&. In this case, the \f3keytool\fR command does not print the certificate and prompt the user to verify it, because it is very difficult for a user to determine the authenticity of the certificate reply\&. +.TP 0.2i +\(bu +If the reply is a PKCS #7 formatted certificate chain or a sequence of X\&.509 certificates, then the chain is ordered with the user certificate first followed by zero or more CA certificates\&. If the chain ends with a self-signed root CA certificate and the\f3-trustcacerts\fR option was specified, the \f3keytool\fR command attempts to match it with any of the trusted certificates in the keystore or the \f3cacerts\fR keystore file\&. If the chain does not end with a self-signed root CA certificate and the \f3-trustcacerts\fR option was specified, the \f3keytool\fR command tries to find one from the trusted certificates in the keystore or the \f3cacerts\fR keystore file and add it to the end of the chain\&. If the certificate is not found and the \f3-noprompt\fR option is not specified, the information of the last certificate in the chain is printed, and the user is prompted to verify it\&. +.PP +If the public key in the certificate reply matches the user\&'s public key already stored with \f3alias\fR, then the old certificate chain is replaced with the new certificate chain in the reply\&. The old chain can only be replaced with a valid \f3keypass\fR, and so the password used to protect the private key of the entry is supplied\&. If no password is provided, and the private key password is different from the keystore password, the user is prompted for it\&. +.PP +This command was named \f3-import\fR in earlier releases\&. This old name is still supported in this release\&. The new name, \f3-importcert\fR, is preferred going forward\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +jarsigner(1) +.TP 0.2i +\(bu +Trail: Security Features in Java SE at http://docs\&.oracle\&.com/javase/tutorial/security/index\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/native2ascii.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/native2ascii.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,86 +1,86 @@ -'\" t -.\" Copyright (c) 1997, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Internationalization Tools -.\" Title: native2ascii.1 -.\" -.if n .pl 99999 -.TH native2ascii 1 "21 November 2013" "JDK 8" "Internationalization Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -native2ascii \- Creates localizable applications by converting a file with characters in any supported character encoding to one with ASCII and/or Unicode escapes or vice versa\&. -.SH SYNOPSIS -.sp -.nf - -\fBnative2ascii\fR [ \fIinputfile\fR ] [ \fIoutputfile\fR ] -.fi -.sp -.TP -\fIinputfile\fR -The encoded file to be converted to ASCII\&. -.TP -\fIoutputfile\fR -The converted ASCII file\&. -.SH DESCRIPTION -The \f3native2ascii\fR command converts encoded files supported by the Java Runtime Environment (JRE) to files encoded in ASCII, using Unicode escapes (\f3\eu\fR\fIxxxx\fR) notation for all characters that are not part of the ASCII character set\&. This process is required for properties files that contain characters not in ISO-8859-1 character sets\&. The tool can also perform the reverse conversion\&. -.PP -If the \f3outputfile\fR value is omitted, then standard output is used for output\&. If, in addition, the \f3inputfile\fR value is omitted, then standard input is used for input\&. -.SH OPTIONS -.TP --reverse -.br -Perform the reverse operation: Converts a file encoded in ISO-8859-1 with Unicode escapes to a file in any character encoding supported by the JRE\&. -.TP --encoding \fIencoding_name\fR -.br -Specifies the name of the character encoding to be used by the conversion procedure\&. If this option is not present, then the default character encoding (as determined by the \f3java\&.nio\&.charset\&.Charset\&.defaultCharset\fR method) is used\&. The \f3encoding_name\fR string must be the name of a character encoding that is supported by the JRE\&. See Supported Encodings at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/intl/encoding\&.doc\&.html -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1997, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Internationalization Tools +.\" Title: native2ascii.1 +.\" +.if n .pl 99999 +.TH native2ascii 1 "21 November 2013" "JDK 8" "Internationalization Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +native2ascii \- Creates localizable applications by converting a file with characters in any supported character encoding to one with ASCII and/or Unicode escapes or vice versa\&. +.SH SYNOPSIS +.sp +.nf + +\fBnative2ascii\fR [ \fIinputfile\fR ] [ \fIoutputfile\fR ] +.fi +.sp +.TP +\fIinputfile\fR +The encoded file to be converted to ASCII\&. +.TP +\fIoutputfile\fR +The converted ASCII file\&. +.SH DESCRIPTION +The \f3native2ascii\fR command converts encoded files supported by the Java Runtime Environment (JRE) to files encoded in ASCII, using Unicode escapes (\f3\eu\fR\fIxxxx\fR) notation for all characters that are not part of the ASCII character set\&. This process is required for properties files that contain characters not in ISO-8859-1 character sets\&. The tool can also perform the reverse conversion\&. +.PP +If the \f3outputfile\fR value is omitted, then standard output is used for output\&. If, in addition, the \f3inputfile\fR value is omitted, then standard input is used for input\&. +.SH OPTIONS +.TP +-reverse +.br +Perform the reverse operation: Converts a file encoded in ISO-8859-1 with Unicode escapes to a file in any character encoding supported by the JRE\&. +.TP +-encoding \fIencoding_name\fR +.br +Specifies the name of the character encoding to be used by the conversion procedure\&. If this option is not present, then the default character encoding (as determined by the \f3java\&.nio\&.charset\&.Charset\&.defaultCharset\fR method) is used\&. The \f3encoding_name\fR string must be the name of a character encoding that is supported by the JRE\&. See Supported Encodings at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/intl/encoding\&.doc\&.html +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/orbd.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/orbd.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,213 +1,213 @@ -'\" t -.\" Copyright (c) 2001, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java IDL and RMI-IIOP Tools -.\" Title: orbd.1 -.\" -.if n .pl 99999 -.TH orbd 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -orbd \- Enables clients to locate and call persistent objects on servers in the CORBA environment\&. -.SH SYNOPSIS -.sp -.nf - -\fBorbd\fR [ \fIoptions\fR ] -.fi -.sp -.TP -\fIoptions\fR -Command-line options\&. See Options\&. -.SH DESCRIPTION -The \f3orbd\fR command enables clients to transparently locate and call persistent objects on servers in the CORBA environment\&. The Server Manager included with the orbd tool is used to enable clients to transparently locate and call 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: -.TP 0.2i -\(bu -The object reference in the naming service remains independent of the server life cycle\&. For example, the object reference could be published by the server in the Naming Service when it is first installed, and then, independent of how many times the server is started or shut down, the ORBD returns the correct object reference to the calling client\&. -.TP 0.2i -\(bu -The client needs to look up the object reference in the naming service only once, and can keep reusing this reference independent of the changes introduced due to server life cycle\&. -.PP -To access the ORBD Server Manager, the server must be started using \f3servertool\fR, which is a command-line interface for application programmers to register, unregister, start up, and shut down a persistent server\&. For more information on the Server Manager, see Server Manager\&. -.PP -When \f3orbd\fR starts, it also starts a naming service\&. For more information about the naming service\&. See Start and Stop the Naming Service\&. -.SH OPTIONS -.TP --ORBInitialPort \fInameserverport\fR -.br -Required\&. Specifies the port on which the name server should be started\&. After it is started, \f3orbd\fR listens for incoming requests on this port\&. On Oracle Solaris software, you must become the root user to start a process on a port below 1024\&. For this reason, Oracle recommends that you use a port number above or equal to 1024\&. -.SS NONREQUIRED\ OPTIONS -.TP --port \fIport\fR -.br -Specifies the activation port where ORBD should be started, and where ORBD will be accepting requests for persistent objects\&. The default value for this port is 1049\&. This port number is added to the port field of the persistent Interoperable Object References (IOR)\&. -.TP --defaultdb \fIdirectory\fR -.br -Specifies the base where the ORBD persistent storage directory, \f3orb\&.db\fR, is created\&. If this option is not specified, then the default value is \f3\&./orb\&.db\fR\&. -.TP --serverPollingTime \fImilliseconds\fR -.br -Specifies how often ORBD checks for the health of persistent servers registered through \f3servertool\fR\&. The default value is 1000 ms\&. The value specified for \f3milliseconds\fR must be a valid positive integer\&. -.TP --serverStartupDelay milliseconds -.br -Specifies how long ORBD waits before sending a location forward exception after a persistent server that is registered through \f3servertool\fR is restarted\&. The default value is 1000 ms\&. The value specified for \f3milliseconds\fR must be a valid positive integer\&. -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SS START\ AND\ STOP\ THE\ NAMING\ SERVICE -A naming service is a CORBA service that allows CORBA objects to be named by means of binding a name to an object reference\&. The name binding can be stored in the naming service, and a client can supply the name to obtain the desired object reference\&. -.PP -Before 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\&. -.PP -The Persistent Naming Service provides persistence for naming contexts\&. This means that this information is persistent across service shutdowns and startups, and is recoverable in the event of a service failure\&. If ORBD is restarted, then the Persistent Naming Service restores the naming context graph, so that the binding of all clients\&' and servers\&' names remains intact (persistent)\&. -.PP -For backward compatibility, \f3tnameserv\fR, a Transient Naming Service that shipped with earlier releases of the JDK, is also included in this release of Java SE\&. A transient naming service retains naming contexts as long as it is running\&. If there is a service interruption, then the naming context graph is lost\&. -.PP -The \f3-ORBInitialPort\fR argument is a required command-line argument for \f3orbd\fR, and is used to set the port number on which the naming service runs\&. The following instructions assume you can use port 1050 for the Java IDL Object Request Broker Daemon\&. When using Oracle Solaris software, you must become a root user to start a process on a port lower than 1024\&. For this reason, it is recommended that you use a port number above or equal to 1024\&. You can substitute a different port when necessary\&. -.PP -To start \f3orbd\fR from a UNIX command shell, enter: -.sp -.nf -\f3orbd \-ORBInitialPort 1050&\fP -.fi -.nf -\f3\fP -.fi -.sp -From an MS-DOS system prompt (Windows), enter: -.sp -.nf -\f3start orbd \-ORBInitialPort 1050\fP -.fi -.nf -\f3\fP -.fi -.sp -Now that ORBD is running, you can run your server and client applications\&. When running the client and server applications, they must be made aware of the port number (and machine name, when applicable) where the Naming Service is running\&. One way to do this is to add the following code to your application: -.sp -.nf -\f3Properties props = new Properties();\fP -.fi -.nf -\f3props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP -.fi -.nf -\f3props\&.put("org\&.omg\&.CORBA\&.ORBInitialHost", "MyHost");\fP -.fi -.nf -\f3ORB orb = ORB\&.init(args, props);\fP -.fi -.nf -\f3\fP -.fi -.sp -In this example, the naming service is running on port 1050 on host \f3MyHost\fR\&. Another way is to specify the port number and/or machine name when running the server or client application from the command line\&. For example, you would start your \f3HelloApplication\fR with the following command line: -.sp -.nf -\f3java HelloApplication \-ORBInitialPort 1050 \-ORBInitialHost MyHost\fP -.fi -.nf -\f3\fP -.fi -.sp -To stop the naming service, use the relevant operating system command, such as \f3pkill\fR\f3orbd\fR on Oracle Solaris, or \fICtrl+C\fR in the DOS window in which \f3orbd\fR is running\&. Note that names registered with the naming service can disappear when the service is terminated because of a transient naming service\&. The Java IDL naming service will run until it is explicitly stopped\&. -.PP -For more information about the naming service included with ORBD, see Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html -.SH SERVER\ MANAGER -To access the ORBD Server Manager and run a persistent server, the server must be started with \f3servertool\fR, which is a command-line interface for application programmers to register, unregister, start up, and shut down a persistent server\&. When a server is started using \f3servertool\fR, it must be started on the same host and port on which \f3orbd\fR is executing\&. If the server is run on a different port, then the information stored in the database for local contexts will be invalid and the service will not work properly\&. -.PP -See Java IDL: The "Hello World" Example at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlExample\&.html -.PP -In this example, you run the \f3idlj\fR compiler and \f3javac\fR compiler as shown in the tutorial\&. To run the ORBD Server Manager, follow these steps for running the application: -.PP -Start \f3orbd\fR\&. -.PP -UNIX command shell, enter: \f3orbd -ORBInitialPort 1050\fR\&. -.PP -MS-DOS system prompt (Windows), enter: \f3s\fR\f3tart orbd -ORBInitialPort 105\fR\f30\fR\&. -.PP -Port 1050 is the port on which you want the name server to run\&. The \f3-ORBInitialPort\fR option is a required command-line argument\&. When using Oracle Solaris software, you must become a root user to start a process on a port below 1024\&. For this reason, it is recommended that you use a port number above or equal to 1024\&. -.PP -Start the \f3servertool\fR: \f3servertool -ORBInitialPort 1050\fR\&. -.PP -Make sure the name server (\f3orbd\fR) port is the same as in the previous step, for example, \f3-ORBInitialPort 1050\&.\fR The \f3servertool\fR must be started on the same port as the name server\&. -.PP -In the \f3servertool\fR command line interface, start the \f3Hello\fR server from the \f3servertool\fR prompt: -.sp -.nf -\f3servertool > register \-server HelloServer \-classpath \&. \-applicationName\fP -.fi -.nf -\f3 HelloServerApName\fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3servertool\fR registers the server, assigns it the name \f3HelloServerApName\fR, and displays its server ID with a listing of all registered servers\&.Run the client application from another terminal window or prompt: -.sp -.nf -\f3java HelloClient \-ORBInitialPort 1050 \-ORBInitialHost localhost\fP -.fi -.nf -\f3\fP -.fi -.sp -For this example, you can omit \f3-ORBInitialHost localhost\fR because the name server is running on the same host as the \f3Hello\fR client\&. If the name server is running on a different host, then use the -\f3ORBInitialHost nameserverhost\fR option to specify the host on which the IDL name server is running\&.Specify the name server (\f3orbd\fR) port as done in the previous step, for example, \f3-ORBInitialPort 1050\fR\&. When you finish experimenting with the ORBD Server Manager, be sure to shut down or terminate the name server (\f3orbd\fR) and \f3servertool\fR\&. To shut down \f3orbd\fR from am MS-DOS prompt, select the window that is running the server and enter \fICtrl+C\fR to shut it down\&. -.PP -To shut down \f3orbd\fR from an Oracle Solaris shell, find the process, and terminate with the \f3kill\fR command\&. The server continues to wait for invocations until it is explicitly stopped\&. To shut down the \f3servertool\fR, type \fIquit\fR and press the \fIEnter\fR key\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -servertool(1) -.TP 0.2i -\(bu -Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2001, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java IDL and RMI-IIOP Tools +.\" Title: orbd.1 +.\" +.if n .pl 99999 +.TH orbd 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +orbd \- Enables clients to locate and call persistent objects on servers in the CORBA environment\&. +.SH SYNOPSIS +.sp +.nf + +\fBorbd\fR [ \fIoptions\fR ] +.fi +.sp +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.SH DESCRIPTION +The \f3orbd\fR command enables clients to transparently locate and call persistent objects on servers in the CORBA environment\&. The Server Manager included with the orbd tool is used to enable clients to transparently locate and call 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: +.TP 0.2i +\(bu +The object reference in the naming service remains independent of the server life cycle\&. For example, the object reference could be published by the server in the Naming Service when it is first installed, and then, independent of how many times the server is started or shut down, the ORBD returns the correct object reference to the calling client\&. +.TP 0.2i +\(bu +The client needs to look up the object reference in the naming service only once, and can keep reusing this reference independent of the changes introduced due to server life cycle\&. +.PP +To access the ORBD Server Manager, the server must be started using \f3servertool\fR, which is a command-line interface for application programmers to register, unregister, start up, and shut down a persistent server\&. For more information on the Server Manager, see Server Manager\&. +.PP +When \f3orbd\fR starts, it also starts a naming service\&. For more information about the naming service\&. See Start and Stop the Naming Service\&. +.SH OPTIONS +.TP +-ORBInitialPort \fInameserverport\fR +.br +Required\&. Specifies the port on which the name server should be started\&. After it is started, \f3orbd\fR listens for incoming requests on this port\&. On Oracle Solaris software, you must become the root user to start a process on a port below 1024\&. For this reason, Oracle recommends that you use a port number above or equal to 1024\&. +.SS NONREQUIRED\ OPTIONS +.TP +-port \fIport\fR +.br +Specifies the activation port where ORBD should be started, and where ORBD will be accepting requests for persistent objects\&. The default value for this port is 1049\&. This port number is added to the port field of the persistent Interoperable Object References (IOR)\&. +.TP +-defaultdb \fIdirectory\fR +.br +Specifies the base where the ORBD persistent storage directory, \f3orb\&.db\fR, is created\&. If this option is not specified, then the default value is \f3\&./orb\&.db\fR\&. +.TP +-serverPollingTime \fImilliseconds\fR +.br +Specifies how often ORBD checks for the health of persistent servers registered through \f3servertool\fR\&. The default value is 1000 ms\&. The value specified for \f3milliseconds\fR must be a valid positive integer\&. +.TP +-serverStartupDelay milliseconds +.br +Specifies how long ORBD waits before sending a location forward exception after a persistent server that is registered through \f3servertool\fR is restarted\&. The default value is 1000 ms\&. The value specified for \f3milliseconds\fR must be a valid positive integer\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SS START\ AND\ STOP\ THE\ NAMING\ SERVICE +A naming service is a CORBA service that allows CORBA objects to be named by means of binding a name to an object reference\&. The name binding can be stored in the naming service, and a client can supply the name to obtain the desired object reference\&. +.PP +Before 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\&. +.PP +The Persistent Naming Service provides persistence for naming contexts\&. This means that this information is persistent across service shutdowns and startups, and is recoverable in the event of a service failure\&. If ORBD is restarted, then the Persistent Naming Service restores the naming context graph, so that the binding of all clients\&' and servers\&' names remains intact (persistent)\&. +.PP +For backward compatibility, \f3tnameserv\fR, a Transient Naming Service that shipped with earlier releases of the JDK, is also included in this release of Java SE\&. A transient naming service retains naming contexts as long as it is running\&. If there is a service interruption, then the naming context graph is lost\&. +.PP +The \f3-ORBInitialPort\fR argument is a required command-line argument for \f3orbd\fR, and is used to set the port number on which the naming service runs\&. The following instructions assume you can use port 1050 for the Java IDL Object Request Broker Daemon\&. When using Oracle Solaris software, you must become a root user to start a process on a port lower than 1024\&. For this reason, it is recommended that you use a port number above or equal to 1024\&. You can substitute a different port when necessary\&. +.PP +To start \f3orbd\fR from a UNIX command shell, enter: +.sp +.nf +\f3orbd \-ORBInitialPort 1050&\fP +.fi +.nf +\f3\fP +.fi +.sp +From an MS-DOS system prompt (Windows), enter: +.sp +.nf +\f3start orbd \-ORBInitialPort 1050\fP +.fi +.nf +\f3\fP +.fi +.sp +Now that ORBD is running, you can run your server and client applications\&. When running the client and server applications, they must be made aware of the port number (and machine name, when applicable) where the Naming Service is running\&. One way to do this is to add the following code to your application: +.sp +.nf +\f3Properties props = new Properties();\fP +.fi +.nf +\f3props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP +.fi +.nf +\f3props\&.put("org\&.omg\&.CORBA\&.ORBInitialHost", "MyHost");\fP +.fi +.nf +\f3ORB orb = ORB\&.init(args, props);\fP +.fi +.nf +\f3\fP +.fi +.sp +In this example, the naming service is running on port 1050 on host \f3MyHost\fR\&. Another way is to specify the port number and/or machine name when running the server or client application from the command line\&. For example, you would start your \f3HelloApplication\fR with the following command line: +.sp +.nf +\f3java HelloApplication \-ORBInitialPort 1050 \-ORBInitialHost MyHost\fP +.fi +.nf +\f3\fP +.fi +.sp +To stop the naming service, use the relevant operating system command, such as \f3pkill\fR\f3orbd\fR on Oracle Solaris, or \fICtrl+C\fR in the DOS window in which \f3orbd\fR is running\&. Note that names registered with the naming service can disappear when the service is terminated because of a transient naming service\&. The Java IDL naming service will run until it is explicitly stopped\&. +.PP +For more information about the naming service included with ORBD, see Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html +.SH SERVER\ MANAGER +To access the ORBD Server Manager and run a persistent server, the server must be started with \f3servertool\fR, which is a command-line interface for application programmers to register, unregister, start up, and shut down a persistent server\&. When a server is started using \f3servertool\fR, it must be started on the same host and port on which \f3orbd\fR is executing\&. If the server is run on a different port, then the information stored in the database for local contexts will be invalid and the service will not work properly\&. +.PP +See Java IDL: The "Hello World" Example at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlExample\&.html +.PP +In this example, you run the \f3idlj\fR compiler and \f3javac\fR compiler as shown in the tutorial\&. To run the ORBD Server Manager, follow these steps for running the application: +.PP +Start \f3orbd\fR\&. +.PP +UNIX command shell, enter: \f3orbd -ORBInitialPort 1050\fR\&. +.PP +MS-DOS system prompt (Windows), enter: \f3s\fR\f3tart orbd -ORBInitialPort 105\fR\f30\fR\&. +.PP +Port 1050 is the port on which you want the name server to run\&. The \f3-ORBInitialPort\fR option is a required command-line argument\&. When using Oracle Solaris software, you must become a root user to start a process on a port below 1024\&. For this reason, it is recommended that you use a port number above or equal to 1024\&. +.PP +Start the \f3servertool\fR: \f3servertool -ORBInitialPort 1050\fR\&. +.PP +Make sure the name server (\f3orbd\fR) port is the same as in the previous step, for example, \f3-ORBInitialPort 1050\&.\fR The \f3servertool\fR must be started on the same port as the name server\&. +.PP +In the \f3servertool\fR command line interface, start the \f3Hello\fR server from the \f3servertool\fR prompt: +.sp +.nf +\f3servertool > register \-server HelloServer \-classpath \&. \-applicationName\fP +.fi +.nf +\f3 HelloServerApName\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3servertool\fR registers the server, assigns it the name \f3HelloServerApName\fR, and displays its server ID with a listing of all registered servers\&.Run the client application from another terminal window or prompt: +.sp +.nf +\f3java HelloClient \-ORBInitialPort 1050 \-ORBInitialHost localhost\fP +.fi +.nf +\f3\fP +.fi +.sp +For this example, you can omit \f3-ORBInitialHost localhost\fR because the name server is running on the same host as the \f3Hello\fR client\&. If the name server is running on a different host, then use the -\f3ORBInitialHost nameserverhost\fR option to specify the host on which the IDL name server is running\&.Specify the name server (\f3orbd\fR) port as done in the previous step, for example, \f3-ORBInitialPort 1050\fR\&. When you finish experimenting with the ORBD Server Manager, be sure to shut down or terminate the name server (\f3orbd\fR) and \f3servertool\fR\&. To shut down \f3orbd\fR from am MS-DOS prompt, select the window that is running the server and enter \fICtrl+C\fR to shut it down\&. +.PP +To shut down \f3orbd\fR from an Oracle Solaris shell, find the process, and terminate with the \f3kill\fR command\&. The server continues to wait for invocations until it is explicitly stopped\&. To shut down the \f3servertool\fR, type \fIquit\fR and press the \fIEnter\fR key\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +servertool(1) +.TP 0.2i +\(bu +Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/pack200.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/pack200.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,290 +1,290 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java Deployment Tools -.\" Title: pack200.1 -.\" -.if n .pl 99999 -.TH pack200 1 "21 November 2013" "JDK 8" "Java Deployment Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -pack200 \- Packages a JAR file into a compressed pack200 file for web deployment\&. -.SH SYNOPSIS -.sp -.nf - -\fBpack200\fR [\fIoptions\fR] \fIoutput\-file\fR \fIJAR\-file\fR -.fi -.sp -Options can be in any order\&. The last option on the command line or in a properties file supersedes all previously specified options\&. -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIoutput-file\fR -Name of the output file\&. -.TP -\fIJAR-file\fR -Name of the input file\&. -.SH DESCRIPTION -The \f3pack200\fR command is a Java application that transforms a JAR file into a compressed pack200 file with the Java gzip compressor\&. The pack200 files are highly compressed files that can be directly deployed to save bandwidth and reduce download time\&. -.PP -The \f3pack200\fR command has several options to fine-tune and set the compression engine\&. The typical usage is shown in the following example, where \f3myarchive\&.pack\&.gz\fR is produced with the default \f3pack200\fR command settings: -.sp -.nf -\f3pack200 myarchive\&.pack\&.gz myarchive\&.jar\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH OPTIONS -.TP --r, --repack -.br -Produces a JAR file by packing and unpacking a JAR file\&. The resulting file can be used as an input to the \f3jarsigner\fR(1) tool\&. The following example packs and unpacks the myarchive\&.jar file: -.sp -.nf -\f3pack200 \-\-repack myarchive\-packer\&.jar myarchive\&.jar\fP -.fi -.nf -\f3pack200 \-\-repack myarchive\&.jar\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The following example preserves the order of files in the input file\&. -.TP --g, --no-gzip -.br -Produces a \f3pack200\fR file\&. With this option, a suitable compressor must be used, and the target system must use a corresponding decompresser\&. -.sp -.nf -\f3pack200 \-\-no\-gzip myarchive\&.pack myarchive\&.jar\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --G, --strip-debug -.br -Strips debugging attributes from the output\&. These include \f3SourceFile\fR, \f3LineNumberTable\fR, \f3LocalVariableTable\fR and \f3LocalVariableTypeTable\fR\&. Removing these attributes reduces the size of both downloads and installations, but reduces the usefulness of debuggers\&. -.TP ---keep-file-order -.br -Preserve the order of files in the input file\&. This is the default behavior\&. -.TP --O, --no-keep-file-order -.br -The packer reorders and transmits all elements\&. The packer can also remove JAR directory names to reduce the download size\&. However, certain JAR file optimizations, such as indexing, might not work correctly\&. -.TP --S\fIvalue\fR , --segment-limit=\fIvalue\fR -.br -The value is the estimated target size \fIN\fR (in bytes) of each archive segment\&. If a single input file requires more than \fIN\fR bytes, then its own archive segment is provided\&. As a special case, a value of \f3-1\fR produces a single large segment with all input files, while a value of 0 produces one segment for each class\&. Larger archive segments result in less fragmentation and better compression, but processing them requires more memory\&. - -The size of each segment is estimated by counting the size of each input file to be transmitted in the segment with the size of its name and other transmitted properties\&. - -The default is -1, which means that the packer creates 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\&. - -A 10 MB JAR packed without this limit typically packs about 10 percent smaller, but the packer might require a larger Java heap (about 10 times the segment limit)\&. -.TP --E\fIvalue\fR , --effort=\fIvalue\fR -.br -If the value is set to a single decimal digit, then the packer uses the indicated amount of effort in compressing the archive\&. Level 1 might produce somewhat larger size and faster compression speed, while level 9 takes much longer, but can produce better compression\&. The special value 0 instructs the \f3pack200\fR command 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\&. - -The default is 5, to invest a modest amount of time to produce reasonable compression\&. -.TP --H\fIvalue\fR , --deflate-hint=\fIvalue\fR -.br -Overrides the default, which preserves the input information, but can cause the transmitted archive to be larger\&. The possible values are: \f3true\fR, \f3false\fR, or \f3keep\fR\&. - -If the \f3value\fR is \f3true\fR or false, then the \f3packer200\fR command sets the deflation hint accordingly in the output archive and does not transmit the individual deflation hints of archive elements\&. - -The \f3keep\fR value preserves deflation hints observed in the input JAR\&. This is the default\&. -.TP --m\fIvalue\fR , --modification-time=\fIvalue\fR -.br -The possible values are \f3latest\fR and \f3keep\fR\&. - -If the value is latest, then the packer attempts to determine the latest modification time, among all the available entries in the original archive, or the latest modification time of all the available entries in that segment\&. This single value is transmitted as part of the segment and applied to all the entries in each segment\&. This can marginally decrease the transmitted size of the archive at the expense of setting all installed files to a single date\&. - -If the value is \f3keep\fR, then modification times observed in the input JAR are preserved\&. This is the default\&. -.TP --P\fIfile\fR , --pass-file=\fIfile\fR -.br -Indicates that a file should be passed through bytewise with no compression\&. By repeating the option, multiple files can be specified\&. There is no pathname transformation, except that the system file separator is replaced by the JAR file separator forward slash (/)\&. The resulting file names must match exactly as strings with their occurrences in the JAR file\&. If \f3file\fR is a directory name, then all files under that directory are passed\&. -.TP --U\fIaction\fR , --unknown-attribute=\fIaction\fR -.br -Overrides the default behavior, which means that the class file that contains the unknown attribute is passed through with the specified \f3action\fR\&. The possible values for actions are \f3error\fR, \f3strip\fR, or \f3pass\fR\&. - -If the value is \f3error\fR, then the entire \f3pack200\fR command operation fails with a suitable explanation\&. - -If the value is \f3strip\fR, then the attribute is dropped\&. Removing the required Java Virtual Machine (JVM) attributes can cause class loader failures\&. - -If the value is \f3pass\fR, then the entire class is transmitted as though it is a resource\&. -.TP -.nf --C\fIattribute-name\fR=\fIlayout\fR , --class-attribute=\fIattribute-name\fR=\fIaction\fR -.br -.fi -See next option\&. -.TP -.nf --F\fIattribute-name\fR=\fIlayout\fR , --field-attribute=\fIattribute-name\fR=\fIaction\fR -.br -.fi -See next option\&. -.TP -.nf --M\fIattribute-name\fR=\fIlayout\fR , --method-attribute=\fIattribute-name\fR=\fIaction\fR -.br -.fi -See next option\&. -.TP -.nf --D\fIattribute-name\fR=\fIlayout\fR , --code-attribute=\fIattribute-name\fR=\fIaction\fR -.br -.fi -With the previous four options, the attribute layout can be specified for a class entity, such as \f3class-attribute\fR, \f3field-attribute\fR, \f3method-attribute\fR, and \f3code-attribute\fR\&. The \fIattribute-name\fR is the name of the attribute for which the layout or action is being defined\&. The possible values for \fIaction\fR are \f3some-layout-string\fR, \f3error\fR, \f3strip\fR, \f3pass\fR\&. - -\f3some-layout-string\fR: The layout language is defined in the JSR 200 specification, for example: \f3--class-attribute=SourceFile=RUH\fR\&. - -If the value is \f3error\fR, then the \f3pack200\fR operation fails with an explanation\&. - -If the value is \f3strip\fR, then the attribute is removed from the output\&. Removing JVM-required attributes can cause class loader failures\&. For example, \f3--class-attribute=CompilationID=pass\fR causes the class file that contains this attribute to be passed through without further action by the packer\&. - -If the value is \f3pass\fR, then the entire class is transmitted as though it is a resource\&. -.TP --f \fIpack\&.properties\fR , --config-file=\fIpack\&.properties\fR -.br -A configuration file, containing Java properties to initialize the packer, can be specified on the command line\&. -.sp -.nf -\f3pack200 \-f pack\&.properties myarchive\&.pack\&.gz myarchive\&.jar\fP -.fi -.nf -\f3more pack\&.properties\fP -.fi -.nf -\f3# Generic properties for the packer\&.\fP -.fi -.nf -\f3modification\&.time=latest\fP -.fi -.nf -\f3deflate\&.hint=false\fP -.fi -.nf -\f3keep\&.file\&.order=false\fP -.fi -.nf -\f3# This option will cause the files bearing new attributes to\fP -.fi -.nf -\f3# be reported as an error rather than passed uncompressed\&.\fP -.fi -.nf -\f3unknown\&.attribute=error\fP -.fi -.nf -\f3# Change the segment limit to be unlimited\&.\fP -.fi -.nf -\f3segment\&.limit=\-1\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --v, --verbose -.br -Outputs minimal messages\&. Multiple specification of this option will create more verbose messages\&. -.TP --q, --quiet -.br -Specifies quiet operation with no messages\&. -.TP --l\fIfilename\fR , --log-file=\fIfilename\fR -.br -Specifies a log file to output messages\&. -.TP --?, -h, --help -.br -Prints help information about this command\&. -.TP --V, --version -.br -Prints version information about this command\&. -.TP --J\fIoption\fR -.br -Passes the specified option to the Java Virtual Machine\&. For more information, see the reference page for the java(1) command\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. -.SH EXIT\ STATUS -The following exit values are returned: 0 for successful completion and a number greater than 0 when an error occurs\&. -.SH NOTES -This command should not be confused with \f3pack\fR(1)\&. The \f3pack\fR and \f3pack200\fR commands are separate products\&. -.PP -The Java SE API Specification provided with the JDK is the superseding authority, when there are discrepancies\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -unpack200(1) -.TP 0.2i -\(bu -jar(1) -.TP 0.2i -\(bu -jarsigner(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Deployment Tools +.\" Title: pack200.1 +.\" +.if n .pl 99999 +.TH pack200 1 "21 November 2013" "JDK 8" "Java Deployment Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +pack200 \- Packages a JAR file into a compressed pack200 file for web deployment\&. +.SH SYNOPSIS +.sp +.nf + +\fBpack200\fR [\fIoptions\fR] \fIoutput\-file\fR \fIJAR\-file\fR +.fi +.sp +Options can be in any order\&. The last option on the command line or in a properties file supersedes all previously specified options\&. +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIoutput-file\fR +Name of the output file\&. +.TP +\fIJAR-file\fR +Name of the input file\&. +.SH DESCRIPTION +The \f3pack200\fR command is a Java application that transforms a JAR file into a compressed pack200 file with the Java gzip compressor\&. The pack200 files are highly compressed files that can be directly deployed to save bandwidth and reduce download time\&. +.PP +The \f3pack200\fR command has several options to fine-tune and set the compression engine\&. The typical usage is shown in the following example, where \f3myarchive\&.pack\&.gz\fR is produced with the default \f3pack200\fR command settings: +.sp +.nf +\f3pack200 myarchive\&.pack\&.gz myarchive\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-r, --repack +.br +Produces a JAR file by packing and unpacking a JAR file\&. The resulting file can be used as an input to the \f3jarsigner\fR(1) tool\&. The following example packs and unpacks the myarchive\&.jar file: +.sp +.nf +\f3pack200 \-\-repack myarchive\-packer\&.jar myarchive\&.jar\fP +.fi +.nf +\f3pack200 \-\-repack myarchive\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following example preserves the order of files in the input file\&. +.TP +-g, --no-gzip +.br +Produces a \f3pack200\fR file\&. With this option, a suitable compressor must be used, and the target system must use a corresponding decompresser\&. +.sp +.nf +\f3pack200 \-\-no\-gzip myarchive\&.pack myarchive\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-G, --strip-debug +.br +Strips debugging attributes from the output\&. These include \f3SourceFile\fR, \f3LineNumberTable\fR, \f3LocalVariableTable\fR and \f3LocalVariableTypeTable\fR\&. Removing these attributes reduces the size of both downloads and installations, but reduces the usefulness of debuggers\&. +.TP +--keep-file-order +.br +Preserve the order of files in the input file\&. This is the default behavior\&. +.TP +-O, --no-keep-file-order +.br +The packer reorders and transmits all elements\&. The packer can also remove JAR directory names to reduce the download size\&. However, certain JAR file optimizations, such as indexing, might not work correctly\&. +.TP +-S\fIvalue\fR , --segment-limit=\fIvalue\fR +.br +The value is the estimated target size \fIN\fR (in bytes) of each archive segment\&. If a single input file requires more than \fIN\fR bytes, then its own archive segment is provided\&. As a special case, a value of \f3-1\fR produces a single large segment with all input files, while a value of 0 produces one segment for each class\&. Larger archive segments result in less fragmentation and better compression, but processing them requires more memory\&. + +The size of each segment is estimated by counting the size of each input file to be transmitted in the segment with the size of its name and other transmitted properties\&. + +The default is -1, which means that the packer creates 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\&. + +A 10 MB JAR packed without this limit typically packs about 10 percent smaller, but the packer might require a larger Java heap (about 10 times the segment limit)\&. +.TP +-E\fIvalue\fR , --effort=\fIvalue\fR +.br +If the value is set to a single decimal digit, then the packer uses the indicated amount of effort in compressing the archive\&. Level 1 might produce somewhat larger size and faster compression speed, while level 9 takes much longer, but can produce better compression\&. The special value 0 instructs the \f3pack200\fR command 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\&. + +The default is 5, to invest a modest amount of time to produce reasonable compression\&. +.TP +-H\fIvalue\fR , --deflate-hint=\fIvalue\fR +.br +Overrides the default, which preserves the input information, but can cause the transmitted archive to be larger\&. The possible values are: \f3true\fR, \f3false\fR, or \f3keep\fR\&. + +If the \f3value\fR is \f3true\fR or false, then the \f3packer200\fR command sets the deflation hint accordingly in the output archive and does not transmit the individual deflation hints of archive elements\&. + +The \f3keep\fR value preserves deflation hints observed in the input JAR\&. This is the default\&. +.TP +-m\fIvalue\fR , --modification-time=\fIvalue\fR +.br +The possible values are \f3latest\fR and \f3keep\fR\&. + +If the value is latest, then the packer attempts to determine the latest modification time, among all the available entries in the original archive, or the latest modification time of all the available entries in that segment\&. This single value is transmitted as part of the segment and applied to all the entries in each segment\&. This can marginally decrease the transmitted size of the archive at the expense of setting all installed files to a single date\&. + +If the value is \f3keep\fR, then modification times observed in the input JAR are preserved\&. This is the default\&. +.TP +-P\fIfile\fR , --pass-file=\fIfile\fR +.br +Indicates that a file should be passed through bytewise with no compression\&. By repeating the option, multiple files can be specified\&. There is no pathname transformation, except that the system file separator is replaced by the JAR file separator forward slash (/)\&. The resulting file names must match exactly as strings with their occurrences in the JAR file\&. If \f3file\fR is a directory name, then all files under that directory are passed\&. +.TP +-U\fIaction\fR , --unknown-attribute=\fIaction\fR +.br +Overrides the default behavior, which means that the class file that contains the unknown attribute is passed through with the specified \f3action\fR\&. The possible values for actions are \f3error\fR, \f3strip\fR, or \f3pass\fR\&. + +If the value is \f3error\fR, then the entire \f3pack200\fR command operation fails with a suitable explanation\&. + +If the value is \f3strip\fR, then the attribute is dropped\&. Removing the required Java Virtual Machine (JVM) attributes can cause class loader failures\&. + +If the value is \f3pass\fR, then the entire class is transmitted as though it is a resource\&. +.TP +.nf +-C\fIattribute-name\fR=\fIlayout\fR , --class-attribute=\fIattribute-name\fR=\fIaction\fR +.br +.fi +See next option\&. +.TP +.nf +-F\fIattribute-name\fR=\fIlayout\fR , --field-attribute=\fIattribute-name\fR=\fIaction\fR +.br +.fi +See next option\&. +.TP +.nf +-M\fIattribute-name\fR=\fIlayout\fR , --method-attribute=\fIattribute-name\fR=\fIaction\fR +.br +.fi +See next option\&. +.TP +.nf +-D\fIattribute-name\fR=\fIlayout\fR , --code-attribute=\fIattribute-name\fR=\fIaction\fR +.br +.fi +With the previous four options, the attribute layout can be specified for a class entity, such as \f3class-attribute\fR, \f3field-attribute\fR, \f3method-attribute\fR, and \f3code-attribute\fR\&. The \fIattribute-name\fR is the name of the attribute for which the layout or action is being defined\&. The possible values for \fIaction\fR are \f3some-layout-string\fR, \f3error\fR, \f3strip\fR, \f3pass\fR\&. + +\f3some-layout-string\fR: The layout language is defined in the JSR 200 specification, for example: \f3--class-attribute=SourceFile=RUH\fR\&. + +If the value is \f3error\fR, then the \f3pack200\fR operation fails with an explanation\&. + +If the value is \f3strip\fR, then the attribute is removed from the output\&. Removing JVM-required attributes can cause class loader failures\&. For example, \f3--class-attribute=CompilationID=pass\fR causes the class file that contains this attribute to be passed through without further action by the packer\&. + +If the value is \f3pass\fR, then the entire class is transmitted as though it is a resource\&. +.TP +-f \fIpack\&.properties\fR , --config-file=\fIpack\&.properties\fR +.br +A configuration file, containing Java properties to initialize the packer, can be specified on the command line\&. +.sp +.nf +\f3pack200 \-f pack\&.properties myarchive\&.pack\&.gz myarchive\&.jar\fP +.fi +.nf +\f3more pack\&.properties\fP +.fi +.nf +\f3# Generic properties for the packer\&.\fP +.fi +.nf +\f3modification\&.time=latest\fP +.fi +.nf +\f3deflate\&.hint=false\fP +.fi +.nf +\f3keep\&.file\&.order=false\fP +.fi +.nf +\f3# This option will cause the files bearing new attributes to\fP +.fi +.nf +\f3# be reported as an error rather than passed uncompressed\&.\fP +.fi +.nf +\f3unknown\&.attribute=error\fP +.fi +.nf +\f3# Change the segment limit to be unlimited\&.\fP +.fi +.nf +\f3segment\&.limit=\-1\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-v, --verbose +.br +Outputs minimal messages\&. Multiple specification of this option will create more verbose messages\&. +.TP +-q, --quiet +.br +Specifies quiet operation with no messages\&. +.TP +-l\fIfilename\fR , --log-file=\fIfilename\fR +.br +Specifies a log file to output messages\&. +.TP +-?, -h, --help +.br +Prints help information about this command\&. +.TP +-V, --version +.br +Prints version information about this command\&. +.TP +-J\fIoption\fR +.br +Passes the specified option to the Java Virtual Machine\&. For more information, see the reference page for the java(1) command\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. +.SH EXIT\ STATUS +The following exit values are returned: 0 for successful completion and a number greater than 0 when an error occurs\&. +.SH NOTES +This command should not be confused with \f3pack\fR(1)\&. The \f3pack\fR and \f3pack200\fR commands are separate products\&. +.PP +The Java SE API Specification provided with the JDK is the superseding authority, when there are discrepancies\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +unpack200(1) +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +jarsigner(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/policytool.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/policytool.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,114 +1,114 @@ -'\" t -.\" Copyright (c) 2001, 2015, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 03 March 2015 -.\" SectDesc: Security Tools -.\" Title: policytool.1 -.\" -.if n .pl 99999 -.TH policytool 1 "03 March 2015" "JDK 8" "Security Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -policytool \- Reads and writes a plain text policy file based on user input through the utility GUI\&. -.SH SYNOPSIS -.sp -.nf - -\fBpolicytool\fR [ \fB\-file\fR ] [ \fIfilename\fR ] -.fi -.sp -.TP --file -.br -Directs the \f3policytool\fR command to load a policy file\&. -.TP -\fIfilename\fR -The name of the file to be loaded\&. -.PP -\fIExamples\fR: -.PP -Run the policy tool administrator utility: -.sp -.nf -\f3policytool\fP -.fi -.nf -\f3\fP -.fi -.sp -Run the \f3policytool\fR command and load the specified file: -.sp -.nf -\f3policytool \-file \fImypolicyfile\fR\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH DESCRIPTION -The \f3policytool\fR command calls an administrator\&'s GUI that enables system administrators to manage the contents of local policy files\&. A policy file is a plain-text file with a \f3\&.policy\fR extension, that maps remote requestors by domain, to permission objects\&. For details, see Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html -.SH OPTIONS -.TP --file -.br -Directs the \f3policytool\fR command to load a policy file\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html -.TP 0.2i -\(bu -Policy File Creation and Management at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyGuide\&.html -.TP 0.2i -\(bu -Permissions in Java SE Development Kit (JDK) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/permissions\&.html -.TP 0.2i -\(bu -Java Security Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/overview/jsoverview\&.html -.TP 0.2i -\(bu -Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2001, 2015, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 03 March 2015 +.\" SectDesc: Security Tools +.\" Title: policytool.1 +.\" +.if n .pl 99999 +.TH policytool 1 "03 March 2015" "JDK 8" "Security Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +policytool \- Reads and writes a plain text policy file based on user input through the utility GUI\&. +.SH SYNOPSIS +.sp +.nf + +\fBpolicytool\fR [ \fB\-file\fR ] [ \fIfilename\fR ] +.fi +.sp +.TP +-file +.br +Directs the \f3policytool\fR command to load a policy file\&. +.TP +\fIfilename\fR +The name of the file to be loaded\&. +.PP +\fIExamples\fR: +.PP +Run the policy tool administrator utility: +.sp +.nf +\f3policytool\fP +.fi +.nf +\f3\fP +.fi +.sp +Run the \f3policytool\fR command and load the specified file: +.sp +.nf +\f3policytool \-file \fImypolicyfile\fR\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH DESCRIPTION +The \f3policytool\fR command calls an administrator\&'s GUI that enables system administrators to manage the contents of local policy files\&. A policy file is a plain-text file with a \f3\&.policy\fR extension, that maps remote requestors by domain, to permission objects\&. For details, see Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html +.SH OPTIONS +.TP +-file +.br +Directs the \f3policytool\fR command to load a policy file\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html +.TP 0.2i +\(bu +Policy File Creation and Management at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyGuide\&.html +.TP 0.2i +\(bu +Permissions in Java SE Development Kit (JDK) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/permissions\&.html +.TP 0.2i +\(bu +Java Security Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/overview/jsoverview\&.html +.TP 0.2i +\(bu +Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/rmic.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/rmic.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,223 +1,223 @@ -'\" t -.\" Copyright (c) 1997, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Remote Method Invocation (RMI) Tools -.\" Title: rmic.1 -.\" -.if n .pl 99999 -.TH rmic 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -rmic \- Generates stub, skeleton, and tie classes for remote objects that use the Java Remote Method Protocol (JRMP) or Internet Inter-Orb protocol (IIOP)\&. Also generates Object Management Group (OMG) Interface Definition Language (IDL) -.SH SYNOPSIS -.sp -.nf - -\fBrmic\fR [ \fIoptions\fR ] \fIpackage\-qualified\-class\-names\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line \f3options\fR\&. See Options\&. -.TP -\fIpackage-qualified-class-names\fR -Class names that include their packages, for example, \f3java\&.awt\&.Color\fR\&. -.SH DESCRIPTION -\fIDeprecation Note:\fR Support for static generation of Java Remote Method Protocol (JRMP) stubs and skeletons has been deprecated\&. Oracle recommends that you use dynamically generated JRMP stubs instead, eliminating the need to use this tool for JRMP-based applications\&. See the \f3java\&.rmi\&.server\&.UnicastRemoteObject\fR specification at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/server/UnicastRemoteObject\&.html for further information\&. -.PP -The \f3rmic\fR compiler generates stub and skeleton class files using the Java Remote Method Protocol (JRMP) and stub and tie class files (IIOP protocol) for remote objects\&. These class 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 \f3java\&.rmi\&.Remote\fR\&. The class names in the \f3rmic\fR command must be for classes that were compiled successfully with the \f3javac\fR command and must be fully package qualified\&. For example, running the \f3rmic\fR command on the class file name \f3HelloImpl\fR as shown here creates the \f3HelloImpl_Stub\&.class\fRfile in the hello subdirectory (named for the class\&'s package): -.sp -.nf -\f3rmic hello\&.HelloImpl\fP -.fi -.nf -\f3\fP -.fi -.sp -A skeleton for a remote object is a JRMP protocol server-side entity that has a method that dispatches calls to the remote object implementation\&. -.PP -A tie for a remote object is a server-side entity similar to a skeleton, but communicates with the client with the IIOP protocol\&. -.PP -A stub is a client-side proxy for a remote object that is responsible for communicating method invocations on remote objects to the server where the actual remote object implementation resides\&. A client\&'s reference to a remote object, therefore, is actually a reference to a local stub\&. -.PP -By default, the \f3rmic\fR command generates stub classes that use the 1\&.2 JRMP stub protocol version only, as though the \f3-v1\&.2\fR option was specified\&. The \f3-vcompat\fR option was the default in releases before 5\&.0\&. Use the \f3-iiop\fR option to generate stub and tie classes for the IIOP protocol\&. See Options\&. -.PP -A stub implements only the remote interfaces, and 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, a client can use the Java programming language built-in operators for casting and type checking\&. For IIOP, the \f3PortableRemoteObject\&.narrow\fR method must be used\&. -.SH OPTIONS -.TP --bootclasspath \fIpath\fR -.br -Overrides the location of bootstrap class files\&. -.TP --classpath path -.br -Specifies the path the \f3rmic\fR command uses to look up classes\&. This option overrides the default or the \f3CLASSPATH\fR environment variable when it is set\&. Directories are separated by colons\&. The general format for path is: \f3\&.:<your_path>\fR, for example: \f3\&.:/usr/local/java/classes\fR\&. -.TP --d \fIdirectory\fR -.br -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 following command places the stub and skeleton classes derived from MyClass into the directory /java/classes/exampleclass\&. -.sp -.nf -\f3rmic \-d /java/classes exampleclass\&.MyClass\fP -.fi -.nf -\f3\fP -.fi -.sp - - -If the \f3-d\fR option is not specified, then the default behavior is as if \f3-d \&.\fR was specified\&. The package hierarchy of the target class is created in the current directory, and stub/tie/skeleton files are placed within it\&. In some earlier releases of the \f3rmic\fR command, if the \f3-d\fR option was not specified, then the package hierarchy was not created, and all of the output files were placed directly in the current directory\&. -.TP --extdirs \fIpath\fR -.br -Overrides the location of installed extensions\&. -.TP --g -.br -Enables the generation of all debugging information, including local variables\&. By default, only line number information is generated\&. -.TP --idl -.br -Causes the \f3rmic\fR command to generate OMG IDL for the classes specified and any classes referenced\&. IDL provides a purely declarative, programming language-independent way to specify an API for an object\&. The IDL is used as a specification for methods and data that can be written in and called from any language that provides CORBA bindings\&. This includes Java and C++ among others\&. See Java IDL: IDL to Java Language Mapping at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/mapping/jidlMapping\&.html - -When the \f3-idl\fR option is used, other options also include: -.RS -.TP 0.2i -\(bu -The \f3-always\fR or \f3-alwaysgenerate\fR options force regeneration even when existing stubs/ties/IDL are newer than the input class\&. -.TP 0.2i -\(bu -The \f3-factory\fR option uses the \f3factory\fR keyword in generated IDL\&. -.TP 0.2i -\(bu -The \f3-idlModule\fR from J\f3avaPackage[\&.class]\fR\f3toIDLModule\fR specifies \f3IDLEntity\fR package mapping, for example: \f3-idlModule\fR\f3my\&.module my::real::idlmod\fR\&. -.TP 0.2i -\(bu -\f3-idlFile\fR\f3fromJavaPackage[\&.class] toIDLFile\fR specifies \f3IDLEntity\fR file mapping, for example: \f3-idlFile test\&.pkg\&.X TEST16\&.idl\fR\&. -.RE - -.TP --iiop -.br -Causes the \f3rmic\fR command 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 reference to a remote object is 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\&. - -If you call the \f3rmic\fR command with the \f3-iiop\fR, then it generates stubs and ties that conform to this naming convention: -.sp -.nf -\f3_<implementationName>_stub\&.class\fP -.fi -.nf -\f3_<interfaceName>_tie\&.class\fP -.fi -.nf -\f3\fP -.fi -.sp -.RS -.TP 0.2i -\(bu -When you use the \f3-iiop\fR option, other options also include: -.TP 0.2i -\(bu -The \f3-always\fR or \f3-alwaysgenerate\fR options force regeneration even when existing stubs/ties/IDL are newer than the input class\&. -.TP 0.2i -\(bu -The \f3-nolocalstubs\fR option means do not create stubs optimized for same-process clients and servers\&. -.TP 0.2i -\(bu -The \f3-noValueMethods\fR option must be used with the \f3-idl\fR option\&. The \f3-noValueMethods\fR option prevents the addition of \f3valuetype\fR methods and initializers to emitted IDL\&. These methods and initializers are optional for valuetypes, and are generated unless the \f3-noValueMethods\fR option is specified with the \f3-idl\fR option\&. -.TP 0.2i -\(bu -The \f3-poa\fR option changes the inheritance from \f3org\&.omg\&.CORBA_2_3\&.portable\&.ObjectImpl\fR to \f3org\&.omg\&.PortableServer\&.Servant\fR\&. The \f3PortableServer\fR module for the Portable Object Adapter (POA) defines the native \f3Servant\fR type\&. In the Java programming language, the \f3Servant\fR type is mapped to the \f3Java org\&.omg\&.PortableServer\&.Servant\fR class\&. It serves as the base class for all POA servant implementations and provides a number of methods that can be called by the application programmer, and methods that are called by the POA and that can 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 --J -.br -Used with any Java command, the \f3-J\fR option passes the argument that follows the \f3-J\fR (no spaces between the \f3-J\fRand the argument) to the Java interpreter -.TP --keep or -keepgenerated -.br -Retains the generated \f3\&.java\fR source files for the stub, skeleton, and tie classes and writes them to the same directory as the\f3\&.class\fR files\&. -.TP --nowarn -.br -Turns off warnings\&. When the \f3-nowarn\fR options is used\&. The compiler does not print out any warnings\&. -.TP --nowrite -.br -Does not write compiled classes to the file system\&. -.TP --vcompat (deprecated) -.br -Generates stub and skeleton classes that are compatible with both the 1\&.1 and 1\&.2 JRMP stub protocol versions\&. This option was the default in releases before 5\&.0\&. The generated stub classes use the 1\&.1 stub protocol version when loaded in a JDK 1\&.1 virtual machine and use the 1\&.2 stub protocol version when loaded into a 1\&.2 (or later) virtual machine\&. The generated skeleton classes support both 1\&.1 and 1\&.2 stub protocol versions\&. The generated classes are relatively large to support both modes of operation\&. Note: This option has been deprecated\&. See Description\&. -.TP --verbose -.br -Causes the compiler and linker to print out messages about what classes are being compiled and what class files are being loaded\&. -.TP --v1\&.1 (deprecated) -.br -Generates stub and skeleton classes for the 1\&.1 JRMP stub protocol version only\&. The \f3-v1\&.1\fR option is only useful for generating stub classes that are serialization-compatible with preexisting, statically deployed stub classes that were generated by the \f3rmic\fR command from JDK 1\&.1 and that cannot be upgraded (and dynamic class loading is not being used)\&. Note: This option has been deprecated\&. See Description\&. -.TP --v1\&.2 (deprecated) -.br -(Default) Generates stub classes for the 1\&.2 JRMP stub protocol version only\&. No skeleton classes are generated because skeleton classes are not used with the 1\&.2 stub protocol version\&. The generated stub classes do not work when they are loaded into a JDK 1\&.1 virtual machine\&. Note: This option has been deprecated\&. See Description\&. -.SH ENVIRONMENT\ VARIABLES -.TP -CLASSPATH -Used to provide the system a path to user-defined classes\&. Directories are separated by colons, for example: \f3\&.:/usr/local/java/classes\fR\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -javac(1) -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -Setting the Class Path -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1997, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Remote Method Invocation (RMI) Tools +.\" Title: rmic.1 +.\" +.if n .pl 99999 +.TH rmic 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +rmic \- Generates stub, skeleton, and tie classes for remote objects that use the Java Remote Method Protocol (JRMP) or Internet Inter-Orb protocol (IIOP)\&. Also generates Object Management Group (OMG) Interface Definition Language (IDL) +.SH SYNOPSIS +.sp +.nf + +\fBrmic\fR [ \fIoptions\fR ] \fIpackage\-qualified\-class\-names\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line \f3options\fR\&. See Options\&. +.TP +\fIpackage-qualified-class-names\fR +Class names that include their packages, for example, \f3java\&.awt\&.Color\fR\&. +.SH DESCRIPTION +\fIDeprecation Note:\fR Support for static generation of Java Remote Method Protocol (JRMP) stubs and skeletons has been deprecated\&. Oracle recommends that you use dynamically generated JRMP stubs instead, eliminating the need to use this tool for JRMP-based applications\&. See the \f3java\&.rmi\&.server\&.UnicastRemoteObject\fR specification at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/server/UnicastRemoteObject\&.html for further information\&. +.PP +The \f3rmic\fR compiler generates stub and skeleton class files using the Java Remote Method Protocol (JRMP) and stub and tie class files (IIOP protocol) for remote objects\&. These class 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 \f3java\&.rmi\&.Remote\fR\&. The class names in the \f3rmic\fR command must be for classes that were compiled successfully with the \f3javac\fR command and must be fully package qualified\&. For example, running the \f3rmic\fR command on the class file name \f3HelloImpl\fR as shown here creates the \f3HelloImpl_Stub\&.class\fRfile in the hello subdirectory (named for the class\&'s package): +.sp +.nf +\f3rmic hello\&.HelloImpl\fP +.fi +.nf +\f3\fP +.fi +.sp +A skeleton for a remote object is a JRMP protocol server-side entity that has a method that dispatches calls to the remote object implementation\&. +.PP +A tie for a remote object is a server-side entity similar to a skeleton, but communicates with the client with the IIOP protocol\&. +.PP +A stub is a client-side proxy for a remote object that is responsible for communicating method invocations on remote objects to the server where the actual remote object implementation resides\&. A client\&'s reference to a remote object, therefore, is actually a reference to a local stub\&. +.PP +By default, the \f3rmic\fR command generates stub classes that use the 1\&.2 JRMP stub protocol version only, as though the \f3-v1\&.2\fR option was specified\&. The \f3-vcompat\fR option was the default in releases before 5\&.0\&. Use the \f3-iiop\fR option to generate stub and tie classes for the IIOP protocol\&. See Options\&. +.PP +A stub implements only the remote interfaces, and 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, a client can use the Java programming language built-in operators for casting and type checking\&. For IIOP, the \f3PortableRemoteObject\&.narrow\fR method must be used\&. +.SH OPTIONS +.TP +-bootclasspath \fIpath\fR +.br +Overrides the location of bootstrap class files\&. +.TP +-classpath path +.br +Specifies the path the \f3rmic\fR command uses to look up classes\&. This option overrides the default or the \f3CLASSPATH\fR environment variable when it is set\&. Directories are separated by colons\&. The general format for path is: \f3\&.:<your_path>\fR, for example: \f3\&.:/usr/local/java/classes\fR\&. +.TP +-d \fIdirectory\fR +.br +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 following command places the stub and skeleton classes derived from MyClass into the directory /java/classes/exampleclass\&. +.sp +.nf +\f3rmic \-d /java/classes exampleclass\&.MyClass\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If the \f3-d\fR option is not specified, then the default behavior is as if \f3-d \&.\fR was specified\&. The package hierarchy of the target class is created in the current directory, and stub/tie/skeleton files are placed within it\&. In some earlier releases of the \f3rmic\fR command, if the \f3-d\fR option was not specified, then the package hierarchy was not created, and all of the output files were placed directly in the current directory\&. +.TP +-extdirs \fIpath\fR +.br +Overrides the location of installed extensions\&. +.TP +-g +.br +Enables the generation of all debugging information, including local variables\&. By default, only line number information is generated\&. +.TP +-idl +.br +Causes the \f3rmic\fR command to generate OMG IDL for the classes specified and any classes referenced\&. IDL provides a purely declarative, programming language-independent way to specify an API for an object\&. The IDL is used as a specification for methods and data that can be written in and called from any language that provides CORBA bindings\&. This includes Java and C++ among others\&. See Java IDL: IDL to Java Language Mapping at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/mapping/jidlMapping\&.html + +When the \f3-idl\fR option is used, other options also include: +.RS +.TP 0.2i +\(bu +The \f3-always\fR or \f3-alwaysgenerate\fR options force regeneration even when existing stubs/ties/IDL are newer than the input class\&. +.TP 0.2i +\(bu +The \f3-factory\fR option uses the \f3factory\fR keyword in generated IDL\&. +.TP 0.2i +\(bu +The \f3-idlModule\fR from J\f3avaPackage[\&.class]\fR\f3toIDLModule\fR specifies \f3IDLEntity\fR package mapping, for example: \f3-idlModule\fR\f3my\&.module my::real::idlmod\fR\&. +.TP 0.2i +\(bu +\f3-idlFile\fR\f3fromJavaPackage[\&.class] toIDLFile\fR specifies \f3IDLEntity\fR file mapping, for example: \f3-idlFile test\&.pkg\&.X TEST16\&.idl\fR\&. +.RE + +.TP +-iiop +.br +Causes the \f3rmic\fR command 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 reference to a remote object is 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\&. + +If you call the \f3rmic\fR command with the \f3-iiop\fR, then it generates stubs and ties that conform to this naming convention: +.sp +.nf +\f3_<implementationName>_stub\&.class\fP +.fi +.nf +\f3_<interfaceName>_tie\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp +.RS +.TP 0.2i +\(bu +When you use the \f3-iiop\fR option, other options also include: +.TP 0.2i +\(bu +The \f3-always\fR or \f3-alwaysgenerate\fR options force regeneration even when existing stubs/ties/IDL are newer than the input class\&. +.TP 0.2i +\(bu +The \f3-nolocalstubs\fR option means do not create stubs optimized for same-process clients and servers\&. +.TP 0.2i +\(bu +The \f3-noValueMethods\fR option must be used with the \f3-idl\fR option\&. The \f3-noValueMethods\fR option prevents the addition of \f3valuetype\fR methods and initializers to emitted IDL\&. These methods and initializers are optional for valuetypes, and are generated unless the \f3-noValueMethods\fR option is specified with the \f3-idl\fR option\&. +.TP 0.2i +\(bu +The \f3-poa\fR option changes the inheritance from \f3org\&.omg\&.CORBA_2_3\&.portable\&.ObjectImpl\fR to \f3org\&.omg\&.PortableServer\&.Servant\fR\&. The \f3PortableServer\fR module for the Portable Object Adapter (POA) defines the native \f3Servant\fR type\&. In the Java programming language, the \f3Servant\fR type is mapped to the \f3Java org\&.omg\&.PortableServer\&.Servant\fR class\&. It serves as the base class for all POA servant implementations and provides a number of methods that can be called by the application programmer, and methods that are called by the POA and that can 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 +-J +.br +Used with any Java command, the \f3-J\fR option passes the argument that follows the \f3-J\fR (no spaces between the \f3-J\fRand the argument) to the Java interpreter +.TP +-keep or -keepgenerated +.br +Retains the generated \f3\&.java\fR source files for the stub, skeleton, and tie classes and writes them to the same directory as the\f3\&.class\fR files\&. +.TP +-nowarn +.br +Turns off warnings\&. When the \f3-nowarn\fR options is used\&. The compiler does not print out any warnings\&. +.TP +-nowrite +.br +Does not write compiled classes to the file system\&. +.TP +-vcompat (deprecated) +.br +Generates stub and skeleton classes that are compatible with both the 1\&.1 and 1\&.2 JRMP stub protocol versions\&. This option was the default in releases before 5\&.0\&. The generated stub classes use the 1\&.1 stub protocol version when loaded in a JDK 1\&.1 virtual machine and use the 1\&.2 stub protocol version when loaded into a 1\&.2 (or later) virtual machine\&. The generated skeleton classes support both 1\&.1 and 1\&.2 stub protocol versions\&. The generated classes are relatively large to support both modes of operation\&. Note: This option has been deprecated\&. See Description\&. +.TP +-verbose +.br +Causes the compiler and linker to print out messages about what classes are being compiled and what class files are being loaded\&. +.TP +-v1\&.1 (deprecated) +.br +Generates stub and skeleton classes for the 1\&.1 JRMP stub protocol version only\&. The \f3-v1\&.1\fR option is only useful for generating stub classes that are serialization-compatible with preexisting, statically deployed stub classes that were generated by the \f3rmic\fR command from JDK 1\&.1 and that cannot be upgraded (and dynamic class loading is not being used)\&. Note: This option has been deprecated\&. See Description\&. +.TP +-v1\&.2 (deprecated) +.br +(Default) Generates stub classes for the 1\&.2 JRMP stub protocol version only\&. No skeleton classes are generated because skeleton classes are not used with the 1\&.2 stub protocol version\&. The generated stub classes do not work when they are loaded into a JDK 1\&.1 virtual machine\&. Note: This option has been deprecated\&. See Description\&. +.SH ENVIRONMENT\ VARIABLES +.TP +CLASSPATH +Used to provide the system a path to user-defined classes\&. Directories are separated by colons, for example: \f3\&.:/usr/local/java/classes\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +javac(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +Setting the Class Path +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/rmid.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/rmid.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,314 +1,314 @@ -'\" t -.\" Copyright (c) 1998, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Remote Method Invocation (RMI) Tools -.\" Title: rmid.1 -.\" -.if n .pl 99999 -.TH rmid 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -rmid \- Starts the activation system daemon that enables objects to be registered and activated in a Java Virtual Machine (JVM)\&. -.SH SYNOPSIS -.sp -.nf - -\fBrmid\fR [\fIoptions\fR] -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.SH DESCRIPTION -The \f3rmid\fR command 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 JVM\&. For details on how to write programs that use activatable objects, the \fIUsing Activation\fR tutorial at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/rmi/activation/overview\&.html -.PP -Start the daemon by executing the \f3rmid\fR command and specifying a security policy file, as follows: -.sp -.nf -\f3rmid \-J\-Djava\&.security\&.policy=rmid\&.policy\fP -.fi -.nf -\f3\fP -.fi -.sp -When you run Oracle\(cqs implementation of the \f3rmid\fR command, by default you must specify a security policy file so that the \f3rmid\fR command can verify whether or not the information in each \f3ActivationGroupDesc\fR is allowed to be used to start a JVM for an activation group\&. Specifically, the command and options specified by the \f3CommandEnvironment\fR and any properties passed to an \f3ActivationGroupDesc\fR constructor must now be explicitly allowed in the security policy file for the \f3rmid\fR command\&. The value of the \f3sun\&.rmi\&.activation\&.execPolicy\fR property dictates the policy that the \f3rmid\fR command uses to determine whether or not the information in an \f3ActivationGroupDesc\fR can be used to start a JVM for an activation group\&. For more information see the description of the -J-Dsun\&.rmi\&.activation\&.execPolicy=policy option\&. -.PP -Executing the \f3rmid\fR command starts the Activator and an internal registry on the default port1098 and binds an \f3ActivationSystem\fR to the name \f3java\&.rmi\&.activation\&.ActivationSystem\fR in this internal registry\&. -.PP -To specify an alternate port for the registry, you must specify the \f3-port\fR option when you execute the \f3rmid\fR command\&. For example, the following command starts the activation system daemon and a registry on the registry\&'s default port, 1099\&. -.sp -.nf -\f3rmid \-J\-Djava\&.security\&.policy=rmid\&.policy \-port 1099\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH START\ RMID\ ON\ DEMAND -An alternative to starting \f3rmid\fR from the command line is to configure \f3inetd\fR (Oracle Solaris) or \f3xinetd\fR (Linux) to start \f3rmid\fR on demand\&. -.PP -When RMID starts, it attempts to obtain an inherited channel (inherited from \f3inetd\fR/\f3xinetd\fR) by calling the \f3System\&.inheritedChannel\fR method\&. If the inherited channel is null or not an instance of \f3java\&.nio\&.channels\&.ServerSocketChannel\fR, then RMID assumes that it was not started by \f3inetd\fR/\f3xinetd\fR, and it starts as previously described\&. -.PP -If the inherited channel is a \f3ServerSocketChannel\fR instance, then RMID uses the \f3java\&.net\&.ServerSocket\fR obtained from the \f3ServerSocketChannel\fR as the server socket that accepts requests for the remote objects it exports: The registry in which the \f3java\&.rmi\&.activation\&.ActivationSystem\fR is bound and the \f3java\&.rmi\&.activation\&.Activator\fR remote object\&. In this mode, RMID behaves the same as when it is started from the command line, except in the following cases: -.TP 0.2i -\(bu -Output printed to \f3System\&.err\fR is redirected to a file\&. This file is located in the directory specified by the \f3java\&.io\&.tmpdir\fR system property (typically \f3/var/tmp\fR or \f3/tmp\fR) with the prefix \f3rmid-err\fR and the suffix \f3tmp\fR\&. -.TP 0.2i -\(bu -The \f3-port\fR option is not allowed\&. If this option is specified, then RMID exits with an error message\&. -.TP 0.2i -\(bu -The \f3-log\fR option is required\&. If this option is not specified, then RMID exits with an error message -.PP -See the man pages for \f3inetd\fR (Oracle Solaris) or \f3xinetd\fR (Linux) for details on how to configure services to be started on demand\&. -.SH OPTIONS -.TP --C\fIoption\fR -.br -Specifies an option that is passed as a command-line argument to each child process (activation group) of the \f3rmid\fR command when that process is created\&. For example, you could pass a property to each virtual machine spawned by the activation system daemon: -.sp -.nf -\f3rmid \-C\-Dsome\&.property=value\fP -.fi -.nf -\f3\fP -.fi -.sp - - -This ability to pass command-line arguments to child processes can be useful for debugging\&. For example, the following command enables server-call logging in all child JVMs\&. -.sp -.nf -\f3rmid \-C\-Djava\&.rmi\&.server\&.logCalls=true\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --J\fIoption\fR -.br -Specifies an option that is passed to the Java interpreter running RMID\&. For example, to specify that the \f3rmid\fR command use a policy file named \f3rmid\&.policy\fR, the \f3-J\fR option can be used to define the \f3java\&.security\&.policy\fR property on the \f3rmid\fR command line, for example: -.sp -.nf -\f3rmid \-J\-Djava\&.security\&.policy\-rmid\&.policy\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --J-Dsun\&.rmi\&.activation\&.execPolicy=\fIpolicy\fR -.br -Specifies the policy that RMID employs to check commands and command-line options used to start the JVM in which an activation group runs\&. Please note that this option exists only in Oracle\&'s implementation of the Java RMI activation daemon\&. If this property is not specified on the command line, then the result is the same as though \f3-J-Dsun\&.rmi\&.activation\&.execPolicy=default\fR were specified\&. The possible values of \f3policy\fR can be \f3default\fR, \f3policyClassName\fR, or \f3none\fR\&. -.RS -.TP 0.2i -\(bu -default - -The \f3default\fR or unspecified value \f3execPolicy\fR allows the \f3rmid\fR command to execute commands with specific command-line options only when the \f3rmid\fR command was granted permission to execute those commands and options in the security policy file that the \f3rmid\fR command uses\&. Only the default activation group implementation can be used with the default execution policy\&. - -The \f3rmid\fR command starts a JVM for an activation group with the information in the group\&'s registered activation group descriptor, an \f3ActivationGroupDesc\fR\&. The group descriptor specifies an optional \f3ActivationGroupDesc\&.CommandEnvironment\fR that includes the command to execute to start the activation group and any command-line options to be added to the command line\&. By default, the \f3rmid\fR command uses the \f3java\fR command found in \f3java\&.home\fR\&. The group descriptor also contains properties overrides that are added to the command line as options defined as: \f3-D<property>=<value>\fR\&.The \f3com\&.sun\&.rmi\&.rmid\&.ExecPermission\fR permission grants the \f3rmid\fR command permission to execute a command that is specified in the group descriptor\&'s \f3CommandEnvironment\fR to start an activation group\&. The \f3com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fR permission enables the \f3rmid\fR command to use command-line options, specified as properties overrides in the group descriptor or as options in the \f3CommandEnvironment\fR when starting the activation group\&.When granting the \f3rmid\fR command permission to execute various commands and options, the permissions \f3ExecPermission\fR and \f3ExecOptionPermission\fR must be granted to all code sources\&. - -\fIExecPermission\fR - -The \f3ExecPermission\fR class represents permission for the \f3rmid\fR command to execute a specific command to start an activation group\&. - -\fISyntax\fR: The name of an \f3ExecPermission\fR is the path name of a command to grant the \f3rmid\fR command permission to execute\&. A path name that ends in a slash (/) and an asterisk (*) indicates that all of the files contained in that directory where slash is the file-separator character, \f3File\&.separatorChar\fR\&. A path name that ends in a slash (/) and a minus sign (-) indicates all files and subdirectories contained in that directory (recursively)\&. A path name that consists of the special token \f3<<ALL FILES>>\fR matches any file\&. - -A path name that consists of an asterisk (*) indicates all the files in the current directory\&. A path name that consists of a minus sign (-) indicates all the files in the current directory and (recursively) all files and subdirectories contained in the current directory\&. - -\fIExecOptionPermission\fR - -The \f3ExecOptionPermission\fR class represents permission for the \f3rmid\fR command to use a specific command-line option when starting an activation group\&. The name of an \f3ExecOptionPermission\fR is the value of a command-line option\&. - -\fISyntax\fR: Options support a limited wild card scheme\&. An asterisk signifies a wild card match, and it can appear as the option name itself (matches any option), or an asterisk (*) can appear at the end of the option name only when the asterisk (*) follows a dot (\&.) or an equals sign (=)\&. - -For example: \f3*\fR or \f3-Dmydir\&.*\fR or \f3-Da\&.b\&.c=*\fR is valid, but \f3*mydir\fR or \f3-Da*b\fR or \f3ab*\fR is not\&. - -\fIPolicy file for rmid\fR - -When you grant the \f3rmid\fR command permission to execute various commands and options, the permissions \f3ExecPermission\fR and \f3ExecOptionPermission\fR must be granted to all code sources (universally)\&. It is safe to grant these permissions universally because only the \f3rmid\fR command checks these permissions\&. - -An example policy file that grants various execute permissions to the \f3rmid\fR command is: -.sp -.nf -\f3grant {\fP -.fi -.nf -\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecPermission\fP -.fi -.nf -\f3 "/files/apps/java/jdk1\&.7\&.0/solaris/bin/java";\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecPermission\fP -.fi -.nf -\f3 "/files/apps/rmidcmds/*";\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP -.fi -.nf -\f3 "\-Djava\&.security\&.policy=/files/policies/group\&.policy";\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP -.fi -.nf -\f3 "\-Djava\&.security\&.debug=*";\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP -.fi -.nf -\f3 "\-Dsun\&.rmi\&.*";\fP -.fi -.nf -\f3};\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The first permission granted allows the \f3rmid\fR tcommand o execute the 1\&.7\&.0 release of the \f3java\fR command, specified by its explicit path name\&. By default, the version of the \f3java\fR command found in \f3java\&.home\fR is used (the same one that the \f3rmid\fR command uses), and does not need to be specified in the policy file\&. The second permission allows the \f3rmid\fR command to execute any command in the directory \f3/files/apps/rmidcmds\fR\&. - -The third permission granted, an \f3ExecOptionPermission\fR, allows the \f3rmid\fR command to start an activation group that defines the security policy file to be \f3/files/policies/group\&.policy\fR\&. The next permission allows the \f3java\&.security\&.debug property\fR to be used by an activation group\&. The last permission allows any property in the \f3sun\&.rmi property\fR name hierarchy to be used by activation groups\&. - -To start the \f3rmid\fR command with a policy file, the \f3java\&.security\&.policy\fR property needs to be specified on the \f3rmid\fR command line, for example: - -\f3rmid -J-Djava\&.security\&.policy=rmid\&.policy\fR\&. -.TP 0.2i -\(bu -<policyClassName> - -If the default behavior is not flexible enough, then an administrator can provide, when starting the \f3rmid\fR command, the name of a class whose \f3checkExecCommand\fR method is executed to check commands to be executed by the \f3rmid\fR command\&. - -The \f3policyClassName\fR specifies a public class with a public, no-argument constructor and an implementation of the following \f3checkExecCommand\fR method: -.sp -.nf -\f3 public void checkExecCommand(ActivationGroupDesc desc, String[] command)\fP -.fi -.nf -\f3 throws SecurityException;\fP -.fi -.nf -\f3\fP -.fi -.sp - - -Before starting an activation group, the \f3rmid\fR command calls the policy\&'s \f3checkExecCommand\fR method and passes to it the activation group descriptor and an array that contains the complete command to start the activation group\&. If the \f3checkExecCommand\fR throws a \f3SecurityException\fR, then the \f3rmid\fR command does not start the activation group and an \f3ActivationException\fR is thrown to the caller attempting to activate the object\&. -.TP 0.2i -\(bu -none - -If the \f3sun\&.rmi\&.activation\&.execPolicy\fR property value is \f3none\fR, then the \f3rmid\fR command does not perform any validation of commands to start activation groups\&. -.RE - -.TP --log \fIdir\fR -.br -Specifies the name of the directory the activation system daemon uses to write its database and associated information\&. The log directory defaults to creating a log, in the directory in which the \f3rmid\fR command was executed\&. -.TP --port \fIport\fR -.br -Specifies the port the registry uses\&. The activation system daemon binds the \f3ActivationSystem\fR, with the name \f3java\&.rmi\&.activation\&.ActivationSystem\fR, in this registry\&. The \f3ActivationSystem\fR on the local machine can be obtained using the following \f3Naming\&.lookup\fR method call: -.sp -.nf -\f3import java\&.rmi\&.*; \fP -.fi -.nf -\f3 import java\&.rmi\&.activation\&.*;\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 ActivationSystem system; system = (ActivationSystem)\fP -.fi -.nf -\f3 Naming\&.lookup("//:port/java\&.rmi\&.activation\&.ActivationSystem");\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --stop -.br -Stops the current invocation of the \f3rmid\fR command for a port specified by the \f3-port\fR option\&. If no port is specified, then this option stops the \f3rmid\fR invocation running on port 1098\&. -.SH ENVIRONMENT\ VARIABLES -.TP -CLASSPATH -Used to provide the system a path to user-defined classes\&. Directories are separated by colons, for example: \f3\&.:/usr/local/java/classes\fR\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -Setting the Class Path -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1998, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Remote Method Invocation (RMI) Tools +.\" Title: rmid.1 +.\" +.if n .pl 99999 +.TH rmid 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +rmid \- Starts the activation system daemon that enables objects to be registered and activated in a Java Virtual Machine (JVM)\&. +.SH SYNOPSIS +.sp +.nf + +\fBrmid\fR [\fIoptions\fR] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.SH DESCRIPTION +The \f3rmid\fR command 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 JVM\&. For details on how to write programs that use activatable objects, the \fIUsing Activation\fR tutorial at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/rmi/activation/overview\&.html +.PP +Start the daemon by executing the \f3rmid\fR command and specifying a security policy file, as follows: +.sp +.nf +\f3rmid \-J\-Djava\&.security\&.policy=rmid\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp +When you run Oracle\(cqs implementation of the \f3rmid\fR command, by default you must specify a security policy file so that the \f3rmid\fR command can verify whether or not the information in each \f3ActivationGroupDesc\fR is allowed to be used to start a JVM for an activation group\&. Specifically, the command and options specified by the \f3CommandEnvironment\fR and any properties passed to an \f3ActivationGroupDesc\fR constructor must now be explicitly allowed in the security policy file for the \f3rmid\fR command\&. The value of the \f3sun\&.rmi\&.activation\&.execPolicy\fR property dictates the policy that the \f3rmid\fR command uses to determine whether or not the information in an \f3ActivationGroupDesc\fR can be used to start a JVM for an activation group\&. For more information see the description of the -J-Dsun\&.rmi\&.activation\&.execPolicy=policy option\&. +.PP +Executing the \f3rmid\fR command starts the Activator and an internal registry on the default port1098 and binds an \f3ActivationSystem\fR to the name \f3java\&.rmi\&.activation\&.ActivationSystem\fR in this internal registry\&. +.PP +To specify an alternate port for the registry, you must specify the \f3-port\fR option when you execute the \f3rmid\fR command\&. For example, the following command starts the activation system daemon and a registry on the registry\&'s default port, 1099\&. +.sp +.nf +\f3rmid \-J\-Djava\&.security\&.policy=rmid\&.policy \-port 1099\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH START\ RMID\ ON\ DEMAND +An alternative to starting \f3rmid\fR from the command line is to configure \f3inetd\fR (Oracle Solaris) or \f3xinetd\fR (Linux) to start \f3rmid\fR on demand\&. +.PP +When RMID starts, it attempts to obtain an inherited channel (inherited from \f3inetd\fR/\f3xinetd\fR) by calling the \f3System\&.inheritedChannel\fR method\&. If the inherited channel is null or not an instance of \f3java\&.nio\&.channels\&.ServerSocketChannel\fR, then RMID assumes that it was not started by \f3inetd\fR/\f3xinetd\fR, and it starts as previously described\&. +.PP +If the inherited channel is a \f3ServerSocketChannel\fR instance, then RMID uses the \f3java\&.net\&.ServerSocket\fR obtained from the \f3ServerSocketChannel\fR as the server socket that accepts requests for the remote objects it exports: The registry in which the \f3java\&.rmi\&.activation\&.ActivationSystem\fR is bound and the \f3java\&.rmi\&.activation\&.Activator\fR remote object\&. In this mode, RMID behaves the same as when it is started from the command line, except in the following cases: +.TP 0.2i +\(bu +Output printed to \f3System\&.err\fR is redirected to a file\&. This file is located in the directory specified by the \f3java\&.io\&.tmpdir\fR system property (typically \f3/var/tmp\fR or \f3/tmp\fR) with the prefix \f3rmid-err\fR and the suffix \f3tmp\fR\&. +.TP 0.2i +\(bu +The \f3-port\fR option is not allowed\&. If this option is specified, then RMID exits with an error message\&. +.TP 0.2i +\(bu +The \f3-log\fR option is required\&. If this option is not specified, then RMID exits with an error message +.PP +See the man pages for \f3inetd\fR (Oracle Solaris) or \f3xinetd\fR (Linux) for details on how to configure services to be started on demand\&. +.SH OPTIONS +.TP +-C\fIoption\fR +.br +Specifies an option that is passed as a command-line argument to each child process (activation group) of the \f3rmid\fR command when that process is created\&. For example, you could pass a property to each virtual machine spawned by the activation system daemon: +.sp +.nf +\f3rmid \-C\-Dsome\&.property=value\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This ability to pass command-line arguments to child processes can be useful for debugging\&. For example, the following command enables server-call logging in all child JVMs\&. +.sp +.nf +\f3rmid \-C\-Djava\&.rmi\&.server\&.logCalls=true\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-J\fIoption\fR +.br +Specifies an option that is passed to the Java interpreter running RMID\&. For example, to specify that the \f3rmid\fR command use a policy file named \f3rmid\&.policy\fR, the \f3-J\fR option can be used to define the \f3java\&.security\&.policy\fR property on the \f3rmid\fR command line, for example: +.sp +.nf +\f3rmid \-J\-Djava\&.security\&.policy\-rmid\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-J-Dsun\&.rmi\&.activation\&.execPolicy=\fIpolicy\fR +.br +Specifies the policy that RMID employs to check commands and command-line options used to start the JVM in which an activation group runs\&. Please note that this option exists only in Oracle\&'s implementation of the Java RMI activation daemon\&. If this property is not specified on the command line, then the result is the same as though \f3-J-Dsun\&.rmi\&.activation\&.execPolicy=default\fR were specified\&. The possible values of \f3policy\fR can be \f3default\fR, \f3policyClassName\fR, or \f3none\fR\&. +.RS +.TP 0.2i +\(bu +default + +The \f3default\fR or unspecified value \f3execPolicy\fR allows the \f3rmid\fR command to execute commands with specific command-line options only when the \f3rmid\fR command was granted permission to execute those commands and options in the security policy file that the \f3rmid\fR command uses\&. Only the default activation group implementation can be used with the default execution policy\&. + +The \f3rmid\fR command starts a JVM for an activation group with the information in the group\&'s registered activation group descriptor, an \f3ActivationGroupDesc\fR\&. The group descriptor specifies an optional \f3ActivationGroupDesc\&.CommandEnvironment\fR that includes the command to execute to start the activation group and any command-line options to be added to the command line\&. By default, the \f3rmid\fR command uses the \f3java\fR command found in \f3java\&.home\fR\&. The group descriptor also contains properties overrides that are added to the command line as options defined as: \f3-D<property>=<value>\fR\&.The \f3com\&.sun\&.rmi\&.rmid\&.ExecPermission\fR permission grants the \f3rmid\fR command permission to execute a command that is specified in the group descriptor\&'s \f3CommandEnvironment\fR to start an activation group\&. The \f3com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fR permission enables the \f3rmid\fR command to use command-line options, specified as properties overrides in the group descriptor or as options in the \f3CommandEnvironment\fR when starting the activation group\&.When granting the \f3rmid\fR command permission to execute various commands and options, the permissions \f3ExecPermission\fR and \f3ExecOptionPermission\fR must be granted to all code sources\&. + +\fIExecPermission\fR + +The \f3ExecPermission\fR class represents permission for the \f3rmid\fR command to execute a specific command to start an activation group\&. + +\fISyntax\fR: The name of an \f3ExecPermission\fR is the path name of a command to grant the \f3rmid\fR command permission to execute\&. A path name that ends in a slash (/) and an asterisk (*) indicates that all of the files contained in that directory where slash is the file-separator character, \f3File\&.separatorChar\fR\&. A path name that ends in a slash (/) and a minus sign (-) indicates all files and subdirectories contained in that directory (recursively)\&. A path name that consists of the special token \f3<<ALL FILES>>\fR matches any file\&. + +A path name that consists of an asterisk (*) indicates all the files in the current directory\&. A path name that consists of a minus sign (-) indicates all the files in the current directory and (recursively) all files and subdirectories contained in the current directory\&. + +\fIExecOptionPermission\fR + +The \f3ExecOptionPermission\fR class represents permission for the \f3rmid\fR command to use a specific command-line option when starting an activation group\&. The name of an \f3ExecOptionPermission\fR is the value of a command-line option\&. + +\fISyntax\fR: Options support a limited wild card scheme\&. An asterisk signifies a wild card match, and it can appear as the option name itself (matches any option), or an asterisk (*) can appear at the end of the option name only when the asterisk (*) follows a dot (\&.) or an equals sign (=)\&. + +For example: \f3*\fR or \f3-Dmydir\&.*\fR or \f3-Da\&.b\&.c=*\fR is valid, but \f3*mydir\fR or \f3-Da*b\fR or \f3ab*\fR is not\&. + +\fIPolicy file for rmid\fR + +When you grant the \f3rmid\fR command permission to execute various commands and options, the permissions \f3ExecPermission\fR and \f3ExecOptionPermission\fR must be granted to all code sources (universally)\&. It is safe to grant these permissions universally because only the \f3rmid\fR command checks these permissions\&. + +An example policy file that grants various execute permissions to the \f3rmid\fR command is: +.sp +.nf +\f3grant {\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecPermission\fP +.fi +.nf +\f3 "/files/apps/java/jdk1\&.7\&.0/solaris/bin/java";\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecPermission\fP +.fi +.nf +\f3 "/files/apps/rmidcmds/*";\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP +.fi +.nf +\f3 "\-Djava\&.security\&.policy=/files/policies/group\&.policy";\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP +.fi +.nf +\f3 "\-Djava\&.security\&.debug=*";\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP +.fi +.nf +\f3 "\-Dsun\&.rmi\&.*";\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The first permission granted allows the \f3rmid\fR tcommand o execute the 1\&.7\&.0 release of the \f3java\fR command, specified by its explicit path name\&. By default, the version of the \f3java\fR command found in \f3java\&.home\fR is used (the same one that the \f3rmid\fR command uses), and does not need to be specified in the policy file\&. The second permission allows the \f3rmid\fR command to execute any command in the directory \f3/files/apps/rmidcmds\fR\&. + +The third permission granted, an \f3ExecOptionPermission\fR, allows the \f3rmid\fR command to start an activation group that defines the security policy file to be \f3/files/policies/group\&.policy\fR\&. The next permission allows the \f3java\&.security\&.debug property\fR to be used by an activation group\&. The last permission allows any property in the \f3sun\&.rmi property\fR name hierarchy to be used by activation groups\&. + +To start the \f3rmid\fR command with a policy file, the \f3java\&.security\&.policy\fR property needs to be specified on the \f3rmid\fR command line, for example: + +\f3rmid -J-Djava\&.security\&.policy=rmid\&.policy\fR\&. +.TP 0.2i +\(bu +<policyClassName> + +If the default behavior is not flexible enough, then an administrator can provide, when starting the \f3rmid\fR command, the name of a class whose \f3checkExecCommand\fR method is executed to check commands to be executed by the \f3rmid\fR command\&. + +The \f3policyClassName\fR specifies a public class with a public, no-argument constructor and an implementation of the following \f3checkExecCommand\fR method: +.sp +.nf +\f3 public void checkExecCommand(ActivationGroupDesc desc, String[] command)\fP +.fi +.nf +\f3 throws SecurityException;\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Before starting an activation group, the \f3rmid\fR command calls the policy\&'s \f3checkExecCommand\fR method and passes to it the activation group descriptor and an array that contains the complete command to start the activation group\&. If the \f3checkExecCommand\fR throws a \f3SecurityException\fR, then the \f3rmid\fR command does not start the activation group and an \f3ActivationException\fR is thrown to the caller attempting to activate the object\&. +.TP 0.2i +\(bu +none + +If the \f3sun\&.rmi\&.activation\&.execPolicy\fR property value is \f3none\fR, then the \f3rmid\fR command does not perform any validation of commands to start activation groups\&. +.RE + +.TP +-log \fIdir\fR +.br +Specifies the name of the directory the activation system daemon uses to write its database and associated information\&. The log directory defaults to creating a log, in the directory in which the \f3rmid\fR command was executed\&. +.TP +-port \fIport\fR +.br +Specifies the port the registry uses\&. The activation system daemon binds the \f3ActivationSystem\fR, with the name \f3java\&.rmi\&.activation\&.ActivationSystem\fR, in this registry\&. The \f3ActivationSystem\fR on the local machine can be obtained using the following \f3Naming\&.lookup\fR method call: +.sp +.nf +\f3import java\&.rmi\&.*; \fP +.fi +.nf +\f3 import java\&.rmi\&.activation\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 ActivationSystem system; system = (ActivationSystem)\fP +.fi +.nf +\f3 Naming\&.lookup("//:port/java\&.rmi\&.activation\&.ActivationSystem");\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-stop +.br +Stops the current invocation of the \f3rmid\fR command for a port specified by the \f3-port\fR option\&. If no port is specified, then this option stops the \f3rmid\fR invocation running on port 1098\&. +.SH ENVIRONMENT\ VARIABLES +.TP +CLASSPATH +Used to provide the system a path to user-defined classes\&. Directories are separated by colons, for example: \f3\&.:/usr/local/java/classes\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +Setting the Class Path +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/rmiregistry.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/rmiregistry.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,98 +1,98 @@ -'\" t -.\" Copyright (c) 1997, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Remote Method Invocation (RMI) Tools -.\" Title: rmiregistry.1 -.\" -.if n .pl 99999 -.TH rmiregistry 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -rmiregistry \- Starts a remote object registry on the specified port on the current host\&. -.SH SYNOPSIS -.sp -.nf - -\fBrmiregistry\fR [ \fIport\fR ] -.fi -.sp -.TP -\fIport\fR -The number of a \f3port\fR on the current host at which to start the remote object registry\&. -.SH DESCRIPTION -The \f3rmiregistry\fR command creates and starts a remote object registry on the specified port on the current host\&. If the port is omitted, then the registry is started on port 1099\&. The \f3rmiregistry\fR command produces no output and is typically run in the background, for example: -.sp -.nf -\f3rmiregistry &\fP -.fi -.nf -\f3\fP -.fi -.sp -A remote object registry is a bootstrap naming service that is used by RMI servers on the same host to bind remote objects to names\&. Clients on local and remote hosts can then look up remote objects and make remote method invocations\&. -.PP -The registry is typically used to locate the first remote object on which an application needs to call methods\&. That object then provides application-specific support for finding other objects\&. -.PP -The methods of the \f3java\&.rmi\&.registry\&.LocateRegistry\fR class are used to get a registry operating on the local host or local host and port\&. -.PP -The URL-based methods of the \f3java\&.rmi\&.Naming\fR 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 name (string) to a remote object, rebind a new name to a remote object (overriding the old binding), unbind a remote object, and list the URL bound in the registry\&. -.SH OPTIONS -.TP --J -.br -Used with any Java option to pass the option following the \f3-J\fR (no spaces between the \f3-J\fR and the option) to the Java interpreter\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -\f3java\&.rmi\&.registry\&.LocateRegistry\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/registry/LocateRegistry\&.html -.TP 0.2i -\(bu -\f3java\&.rmi\&.Naming class description\fR at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/Naming\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1997, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Remote Method Invocation (RMI) Tools +.\" Title: rmiregistry.1 +.\" +.if n .pl 99999 +.TH rmiregistry 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +rmiregistry \- Starts a remote object registry on the specified port on the current host\&. +.SH SYNOPSIS +.sp +.nf + +\fBrmiregistry\fR [ \fIport\fR ] +.fi +.sp +.TP +\fIport\fR +The number of a \f3port\fR on the current host at which to start the remote object registry\&. +.SH DESCRIPTION +The \f3rmiregistry\fR command creates and starts a remote object registry on the specified port on the current host\&. If the port is omitted, then the registry is started on port 1099\&. The \f3rmiregistry\fR command produces no output and is typically run in the background, for example: +.sp +.nf +\f3rmiregistry &\fP +.fi +.nf +\f3\fP +.fi +.sp +A remote object registry is a bootstrap naming service that is used by RMI servers on the same host to bind remote objects to names\&. Clients on local and remote hosts can then look up remote objects and make remote method invocations\&. +.PP +The registry is typically used to locate the first remote object on which an application needs to call methods\&. That object then provides application-specific support for finding other objects\&. +.PP +The methods of the \f3java\&.rmi\&.registry\&.LocateRegistry\fR class are used to get a registry operating on the local host or local host and port\&. +.PP +The URL-based methods of the \f3java\&.rmi\&.Naming\fR 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 name (string) to a remote object, rebind a new name to a remote object (overriding the old binding), unbind a remote object, and list the URL bound in the registry\&. +.SH OPTIONS +.TP +-J +.br +Used with any Java option to pass the option following the \f3-J\fR (no spaces between the \f3-J\fR and the option) to the Java interpreter\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +\f3java\&.rmi\&.registry\&.LocateRegistry\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/registry/LocateRegistry\&.html +.TP 0.2i +\(bu +\f3java\&.rmi\&.Naming class description\fR at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/Naming\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/schemagen.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/schemagen.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,121 +1,121 @@ -'\" t -.\" Copyright (c) 2005, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java Web Services Tools -.\" Title: schemagen.1 -.\" -.if n .pl 99999 -.TH schemagen 1 "21 November 2013" "JDK 8" "Java Web Services Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -schemagen \- Generates a schema for every name space that is referenced in your Java classes\&. -.SH SYNOPSIS -.sp -.nf - -\fBschemagen\fR [ \fIoptions\fR ] \fIjava\-files\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIjava-files\fR -The Java class files to be processed\&. -.SH DESCRIPTION -The schema generator creates a schema file for each name space referenced in your Java classes\&. Currently, you cannot control the name of the generated schema files\&. To control the schema file names, see Using SchemaGen with Ant at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/schemagenTask\&.html -.PP -Start the schema generator with the appropriate \f3schemagen\fR shell script in the bin directory for your platform\&. The current schema generator can process either Java source files or class files\&. -.sp -.nf -\f3schemagen\&.sh Foo\&.java Bar\&.java \&.\&.\&.\fP -.fi -.nf -\f3Note: Writing schema1\&.xsd\fP -.fi -.nf -\f3\fP -.fi -.sp -If your java files reference other classes, then those classes must be accessible on your system \f3CLASSPATH\fR environment variable, or they need to be specified in the \f3schemagen\fR command line with the class path options\&. See Options\&. If the referenced files are not accessible or specified, then you get errors when you generate the schema\&. -.SH OPTIONS -.TP --d \fIpath\fR -.br -The location where the \f3schemagen\fR command places processor-generated and \f3javac\fR-generated class files\&. -.TP --cp \fIpath\fR -.br -The location where the \f3schemagen\fR command places user-specified files\&. -.TP --classpath \fIpath\fR -.br -The location where the \f3schemagen\fR command places user-specified files\&. -.TP --encoding \fIencoding\fR -.br -Specifies the encoding to use for \f3apt\fR or \f3javac\fR command invocations\&. -.TP --episode \fIfile\fR -.br -Generates an episode file for separate compilation\&. -.TP --version -.br -Displays release information\&. -.TP --help -.br -Displays a help message\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -Using SchemaGen with Ant at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/schemagenTask\&.html -.TP 0.2i -\(bu -Java Architecture for XML Binding (JAXB) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/xml/jaxb/index\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2005, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Web Services Tools +.\" Title: schemagen.1 +.\" +.if n .pl 99999 +.TH schemagen 1 "21 November 2013" "JDK 8" "Java Web Services Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +schemagen \- Generates a schema for every name space that is referenced in your Java classes\&. +.SH SYNOPSIS +.sp +.nf + +\fBschemagen\fR [ \fIoptions\fR ] \fIjava\-files\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIjava-files\fR +The Java class files to be processed\&. +.SH DESCRIPTION +The schema generator creates a schema file for each name space referenced in your Java classes\&. Currently, you cannot control the name of the generated schema files\&. To control the schema file names, see Using SchemaGen with Ant at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/schemagenTask\&.html +.PP +Start the schema generator with the appropriate \f3schemagen\fR shell script in the bin directory for your platform\&. The current schema generator can process either Java source files or class files\&. +.sp +.nf +\f3schemagen\&.sh Foo\&.java Bar\&.java \&.\&.\&.\fP +.fi +.nf +\f3Note: Writing schema1\&.xsd\fP +.fi +.nf +\f3\fP +.fi +.sp +If your java files reference other classes, then those classes must be accessible on your system \f3CLASSPATH\fR environment variable, or they need to be specified in the \f3schemagen\fR command line with the class path options\&. See Options\&. If the referenced files are not accessible or specified, then you get errors when you generate the schema\&. +.SH OPTIONS +.TP +-d \fIpath\fR +.br +The location where the \f3schemagen\fR command places processor-generated and \f3javac\fR-generated class files\&. +.TP +-cp \fIpath\fR +.br +The location where the \f3schemagen\fR command places user-specified files\&. +.TP +-classpath \fIpath\fR +.br +The location where the \f3schemagen\fR command places user-specified files\&. +.TP +-encoding \fIencoding\fR +.br +Specifies the encoding to use for \f3apt\fR or \f3javac\fR command invocations\&. +.TP +-episode \fIfile\fR +.br +Generates an episode file for separate compilation\&. +.TP +-version +.br +Displays release information\&. +.TP +-help +.br +Displays a help message\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +Using SchemaGen with Ant at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/schemagenTask\&.html +.TP 0.2i +\(bu +Java Architecture for XML Binding (JAXB) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/xml/jaxb/index\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/serialver.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/serialver.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,110 +1,110 @@ -'\" t -.\" Copyright (c) 1997, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Remote Method Invocation (RMI) Tools -.\" Title: serialver.1 -.\" -.if n .pl 99999 -.TH serialver 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -serialver \- Returns the serial version UID for specified classes\&. -.SH SYNOPSIS -.sp -.nf - -\fBserialver\fR [ \fIoptions\fR ] [ \fIclassnames\fR ] -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIclassnames\fR -The classes for which the \f3serialVersionUID\fR is to be returned\&. -.SH DESCRIPTION -The \f3serialver\fR command returns the \f3serialVersionUID\fR for one or more classes in a form suitable for copying into an evolving class\&. When called with no arguments, the \f3serialver\fR command prints a usage line\&. -.SH OPTIONS -.TP --classpath \fIpath-files\fR -.br -Sets the search path for application classes and resources\&. Separate classes and resources with a colon (:)\&. -.TP --show -.br -Displays a simple user interface\&. Enter the full class name and press either the \fIEnter\fR key or the \fIShow\fR button to display the \f3serialVersionUID\fR\&. -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the Java Virtual Machine, where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH NOTES -The \f3serialver\fR command loads and initializes the specified classes in its virtual machine, and by default, it does not set a security manager\&. If the \f3serialver\fR command is to be run with untrusted classes, then a security manager can be set with the following option: -.sp -.nf -\f3\-J\-Djava\&.security\&.manager\fP -.fi -.nf -\f3\fP -.fi -.sp -When necessary, a security policy can be specified with the following option: -.sp -.nf -\f3\-J\-Djava\&.security\&.policy=<policy file>\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH SEE\ ALSO -.TP 0.2i -\(bu -policytool(1) -.TP 0.2i -\(bu -The \f3java\&.io\&.ObjectStream\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/io/ObjectStreamClass\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1997, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Remote Method Invocation (RMI) Tools +.\" Title: serialver.1 +.\" +.if n .pl 99999 +.TH serialver 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +serialver \- Returns the serial version UID for specified classes\&. +.SH SYNOPSIS +.sp +.nf + +\fBserialver\fR [ \fIoptions\fR ] [ \fIclassnames\fR ] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIclassnames\fR +The classes for which the \f3serialVersionUID\fR is to be returned\&. +.SH DESCRIPTION +The \f3serialver\fR command returns the \f3serialVersionUID\fR for one or more classes in a form suitable for copying into an evolving class\&. When called with no arguments, the \f3serialver\fR command prints a usage line\&. +.SH OPTIONS +.TP +-classpath \fIpath-files\fR +.br +Sets the search path for application classes and resources\&. Separate classes and resources with a colon (:)\&. +.TP +-show +.br +Displays a simple user interface\&. Enter the full class name and press either the \fIEnter\fR key or the \fIShow\fR button to display the \f3serialVersionUID\fR\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH NOTES +The \f3serialver\fR command loads and initializes the specified classes in its virtual machine, and by default, it does not set a security manager\&. If the \f3serialver\fR command is to be run with untrusted classes, then a security manager can be set with the following option: +.sp +.nf +\f3\-J\-Djava\&.security\&.manager\fP +.fi +.nf +\f3\fP +.fi +.sp +When necessary, a security policy can be specified with the following option: +.sp +.nf +\f3\-J\-Djava\&.security\&.policy=<policy file>\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +policytool(1) +.TP 0.2i +\(bu +The \f3java\&.io\&.ObjectStream\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/io/ObjectStreamClass\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/servertool.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/servertool.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,137 +1,137 @@ -'\" t -.\" Copyright (c) 2001, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java IDL and RMI-IIOP Tools -.\" Title: servertool.1 -.\" -.if n .pl 99999 -.TH servertool 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -servertool \- Provides an easy-to-use interface for developers to register, unregister, start up, and shut down a persistent server\&. -.SH SYNOPSIS -.sp -.nf - -\fBservertool\fR \-ORBInitialPort \fInameserverport\fR [ \fIoptions\fR ] [ \fIcommands \fR] -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -commands -The command-line commands\&. See Commands\&. -.SH DESCRIPTION -The \f3servertool\fR command provides the command-line interface for developers to register, unregister, start up, and shut down a persistent server\&. Command-line commands let you obtain various statistical information about the server\&. See Commands\&. -.SH OPTIONS -.TP --ORBInitialHost \fInameserverhost\fR -.br -This options is required\&. It specifies the host machine on which the name server runs and listens for incoming requests\&. The \f3nameserverhost\fR value must specify the port on which the \f3orb\fR is running and listening for requests\&. The value defaults to \f3localhost\fR when this option is not specified\&. If \f3orbd\fR and \f3servertool\fR are running on different machines, then you must specify the name or IP address of the host on which \f3orbd\fR is running\&. - -\fINote:\fR On Oracle Solaris, you must become a root user to start a process on a port below 1024\&. Oracle recommends that you use a port number above or equal to 1024 for the \f3nameserverport\fR value\&. -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH COMMANDS -You can start the \f3servertool\fR command with or without a command-line command\&. -.TP 0.2i -\(bu -If you did not specify a command when you started \f3servertool\fR, then the command-line tool displays the \f3servertool\fR prompt where you can enter commands: \f3servertool >\fR\&. -.TP 0.2i -\(bu -If you specify a command when you start \f3servertool\fR, then the Java IDL Server Tool starts, executes the command, and exits\&. -.TP -.ll 180 -register -server \fIserver-class-name\fR -classpath \fIclasspath-to-server\fR [ -applicationName \fIapplication-name\fR -args \fIargs-to-server\fR -vmargs \fIflags-for-JVM\fR ] -Registers a new persistent server with the Object Request Broker Daemon (ORBD)\&. If the server is not already registered, then it is registered and activated\&. This command causes an installation method to be called in the \f3main\fR class of the server identified by the \f3-server\fR option\&. The installation method must be \f3public static void install(org\&.omg\&.CORBA\&.ORB)\fR\&. The install method is optional and lets developers provide their own server installation behavior, such as creating a database schema\&. -.TP -.ll 180 -unregister -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR -Unregisters a server from the ORBD with either its server ID or its application name\&. This command causes an uninstallation method to be called in the \f3main\fR class of the server identified by the \f3-server\fR option\&. The \f3uninstall\fR method must be \f3public static void uninstall(org\&.omg\&.CORBA\&.ORB)\fR\&. The \f3uninstall\fR method is optional and lets developers provide their own server uninstallation behavior, such as undoing the behavior of the \f3install\fR method\&. -.TP -getserverid -applicationName \fIapplication-name\fR -Returns the server ID that corresponds to the \f3application-name\fR value\&. -.TP -list -Lists information about all persistent servers registered with the ORBD\&. -.TP -listappnames -Lists the application names for all servers currently registered with the ORBD\&. -.TP -listactive -Lists information about all persistent servers that were started by the ORBD and are currently running\&. -.TP -.ll 180 -locate -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR [ -endpointType \fIendpointType\fR ] -Locates the endpoints (ports) of a specific type for all ORBs created by a registered server\&. If a server is not already running, then it is activated\&. If an \f3endpointType\fR value is not specified, then the plain/non-protected endpoint associated with each ORB in a server is returned\&. -.TP -.ll 180 -locateperorb -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR [ -orbid \fIORB-name\fR ] -Locates all the endpoints (ports) registered by a specific Object Request Broker (ORB) of registered server\&. If a server is not already running, then it is activated\&. If an \f3orbid\fR is not specified, then the default value of \f3""\fR is assigned to the \f3orbid\fR\&. If any ORBs are created with an \f3orbid\fR of empty string, then all ports registered by it are returned\&. -.TP -orblist -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR -Lists the \f3ORBId\fR of the ORBs defined on a server\&. An \f3ORBId\fR is the string name for the ORB created by the server\&. If the server is not already running, then it is activated\&. -.TP -shutdown -serverid \fIserver-id\fR | -applicationName application-name -Shut down an active server that is registered with ORBD\&. During execution of this command, the \f3shutdown\fR method defined in the class specified by either the \f3-serverid\fR or \f3-applicationName\fR parameter is also called to shut down the server process\&. -.TP -startup -serverid \fIserver-id\fR | -applicationName application-name -Starts up or activate a server that is registered with ORBD\&. If the server is not running, then this command starts the server\&. If the server is already running, then an error message is displayed\&. -.TP -help -Lists all the commands available to the server through the \f3servertool\fR command\&. -.TP -quit -Exits the \f3servertool\fR command\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -orbd(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2001, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java IDL and RMI-IIOP Tools +.\" Title: servertool.1 +.\" +.if n .pl 99999 +.TH servertool 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +servertool \- Provides an easy-to-use interface for developers to register, unregister, start up, and shut down a persistent server\&. +.SH SYNOPSIS +.sp +.nf + +\fBservertool\fR \-ORBInitialPort \fInameserverport\fR [ \fIoptions\fR ] [ \fIcommands \fR] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +commands +The command-line commands\&. See Commands\&. +.SH DESCRIPTION +The \f3servertool\fR command provides the command-line interface for developers to register, unregister, start up, and shut down a persistent server\&. Command-line commands let you obtain various statistical information about the server\&. See Commands\&. +.SH OPTIONS +.TP +-ORBInitialHost \fInameserverhost\fR +.br +This options is required\&. It specifies the host machine on which the name server runs and listens for incoming requests\&. The \f3nameserverhost\fR value must specify the port on which the \f3orb\fR is running and listening for requests\&. The value defaults to \f3localhost\fR when this option is not specified\&. If \f3orbd\fR and \f3servertool\fR are running on different machines, then you must specify the name or IP address of the host on which \f3orbd\fR is running\&. + +\fINote:\fR On Oracle Solaris, you must become a root user to start a process on a port below 1024\&. Oracle recommends that you use a port number above or equal to 1024 for the \f3nameserverport\fR value\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH COMMANDS +You can start the \f3servertool\fR command with or without a command-line command\&. +.TP 0.2i +\(bu +If you did not specify a command when you started \f3servertool\fR, then the command-line tool displays the \f3servertool\fR prompt where you can enter commands: \f3servertool >\fR\&. +.TP 0.2i +\(bu +If you specify a command when you start \f3servertool\fR, then the Java IDL Server Tool starts, executes the command, and exits\&. +.TP +.ll 180 +register -server \fIserver-class-name\fR -classpath \fIclasspath-to-server\fR [ -applicationName \fIapplication-name\fR -args \fIargs-to-server\fR -vmargs \fIflags-for-JVM\fR ] +Registers a new persistent server with the Object Request Broker Daemon (ORBD)\&. If the server is not already registered, then it is registered and activated\&. This command causes an installation method to be called in the \f3main\fR class of the server identified by the \f3-server\fR option\&. The installation method must be \f3public static void install(org\&.omg\&.CORBA\&.ORB)\fR\&. The install method is optional and lets developers provide their own server installation behavior, such as creating a database schema\&. +.TP +.ll 180 +unregister -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR +Unregisters a server from the ORBD with either its server ID or its application name\&. This command causes an uninstallation method to be called in the \f3main\fR class of the server identified by the \f3-server\fR option\&. The \f3uninstall\fR method must be \f3public static void uninstall(org\&.omg\&.CORBA\&.ORB)\fR\&. The \f3uninstall\fR method is optional and lets developers provide their own server uninstallation behavior, such as undoing the behavior of the \f3install\fR method\&. +.TP +getserverid -applicationName \fIapplication-name\fR +Returns the server ID that corresponds to the \f3application-name\fR value\&. +.TP +list +Lists information about all persistent servers registered with the ORBD\&. +.TP +listappnames +Lists the application names for all servers currently registered with the ORBD\&. +.TP +listactive +Lists information about all persistent servers that were started by the ORBD and are currently running\&. +.TP +.ll 180 +locate -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR [ -endpointType \fIendpointType\fR ] +Locates the endpoints (ports) of a specific type for all ORBs created by a registered server\&. If a server is not already running, then it is activated\&. If an \f3endpointType\fR value is not specified, then the plain/non-protected endpoint associated with each ORB in a server is returned\&. +.TP +.ll 180 +locateperorb -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR [ -orbid \fIORB-name\fR ] +Locates all the endpoints (ports) registered by a specific Object Request Broker (ORB) of registered server\&. If a server is not already running, then it is activated\&. If an \f3orbid\fR is not specified, then the default value of \f3""\fR is assigned to the \f3orbid\fR\&. If any ORBs are created with an \f3orbid\fR of empty string, then all ports registered by it are returned\&. +.TP +orblist -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR +Lists the \f3ORBId\fR of the ORBs defined on a server\&. An \f3ORBId\fR is the string name for the ORB created by the server\&. If the server is not already running, then it is activated\&. +.TP +shutdown -serverid \fIserver-id\fR | -applicationName application-name +Shut down an active server that is registered with ORBD\&. During execution of this command, the \f3shutdown\fR method defined in the class specified by either the \f3-serverid\fR or \f3-applicationName\fR parameter is also called to shut down the server process\&. +.TP +startup -serverid \fIserver-id\fR | -applicationName application-name +Starts up or activate a server that is registered with ORBD\&. If the server is not running, then this command starts the server\&. If the server is already running, then an error message is displayed\&. +.TP +help +Lists all the commands available to the server through the \f3servertool\fR command\&. +.TP +quit +Exits the \f3servertool\fR command\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +orbd(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/tnameserv.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/tnameserv.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,488 +1,488 @@ -'\" t -.\" Copyright (c) 1999, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java IDL and RMI-IIOP Tools -.\" Title: tnameserv.1 -.\" -.if n .pl 99999 -.TH tnameserv 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -tnameserv \- Interface Definition Language (IDL)\&. -.SH SYNOPSIS -.sp -.nf - -\fBtnameserve\fR \fB\-ORBInitialPort\fR [ \fInameserverport\fR ] -.fi -.sp -.TP --ORBInitialPort \fInameserverport\fR -.br -The initial port where the naming service listens for the bootstrap protocol used to implement the ORB \f3resolve_initial_references\fR and \f3list_initial_references\fR methods\&. -.SH DESCRIPTION -Java IDL includes the Object Request Broker Daemon (ORBD)\&. ORBD is a daemon process that contains a Bootstrap Service, a Transient Naming Service, a Persistent Naming Service, and a Server Manager\&. The Java IDL tutorials all use ORBD, but you can substitute the \f3tnameserv\fR command for the \f3orbd\fR command in any of the examples that use a Transient Naming Service\&. -.PP -See orbd(1) or Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html -.PP -The CORBA Common Object Services (COS) Naming Service provides a tree-structure directory for object references similar to a file system that provides a directory structure for files\&. The Transient Naming Service provided with Java IDL, \f3tnameserv\fR, is a simple implementation of the COS Naming Service specification\&. -.PP -Object references are stored in the name space by name and each object reference-name pair is called a name binding\&. Name bindings can be organized under naming contexts\&. Naming contexts are name bindings and serve the same organizational function as a file system subdirectory\&. All bindings are stored under the initial naming context\&. The initial naming context is the only persistent binding in the name space\&. The rest of the name space is lost when the Java IDL naming service process stops and restarts\&. -.PP -For an applet or application to use COS naming, its ORB must know the port of a host running a naming service or have access to an initial naming context string for that naming service\&. The naming service can either be the Java IDL naming service or another COS-compliant naming service\&. -.SS START\ THE\ NAMING\ SERVICE -You must start the Java IDL naming service before an application or applet that uses its naming service\&. Installation of the Java IDL product creates a script (Oracle Solaris: \f3tnameserv\fR) or executable file (Windows: \f3tnameserv\&.exe\fR) that starts the Java IDL naming service\&. Start the naming service so it runs in the background\&. -.PP -If you do not specify otherwise, then the Java IDL naming service listens on port 900 for the bootstrap protocol used to implement the ORB \f3resolve_initial_references\fR and \f3list_initial_references methods\fR, as follows: -.sp -.nf -\f3tnameserv \-ORBInitialPort nameserverport&\fP -.fi -.nf -\f3\fP -.fi -.sp -If you do not specify the name server port, then port 900 is used by default\&. When running Oracle Solaris software, you must become the root user to start a process on a port below 1024\&. For this reason, it is recommended that you use a port number greater than or equal to 1024\&. To specify a different port, for example, 1050, and to run the naming service in the background, from a UNIX command shell, enter: -.sp -.nf -\f3tnameserv \-ORBInitialPort 1050&\fP -.fi -.nf -\f3\fP -.fi -.sp -From an MS-DOS system prompt (Windows), enter: -.sp -.nf -\f3start tnameserv \-ORBInitialPort 1050\fP -.fi -.nf -\f3\fP -.fi -.sp -Clients of the name server must be made aware of the new port number\&. Do this by setting the \f3org\&.omg\&.CORBA\&.ORBInitialPort\fR property to the new port number when you create the ORB object\&. -.SS RUN\ THE\ SERVER\ AND\ CLIENT\ ON\ DIFFERENT\ HOSTS -In most of the Java IDL and RMI-IIOP tutorials, the naming service, server, and client are all running on the development machine\&. In real-world deployment, the client and server probably run on different host machines from the Naming Service\&. -.PP -For the client and server to find the Naming Service, they must be made aware of the port number and host on which the naming service is running\&. Do this by setting the \f3org\&.omg\&.CORBA\&.ORBInitialPort\fR and \f3org\&.omg\&.CORBA\&.ORBInitialHost\fR properties in the client and server files to the machine name and port number on which the Naming Service is running\&. An example of this is shown in Getting Started Using RMI-IIOP at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/rmi-iiop/rmiiiopexample\&.html -.PP -You could also use the command-line options \f3-ORBInitialPort nameserverport#\fR and \f3-ORBInitialHost nameserverhostname\fR to tell the client and server where to find the naming service\&. For one example of doing this using the command-line option, see Java IDL: The Hello World Example on Two Machines at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/tutorial/jidl2machines\&.html -.PP -For example, suppose the Transient Naming Service, \f3tnameserv\fR is running on port 1050 on host \f3nameserverhost\fR\&. The client is running on host \f3clienthost,\fR and the server is running on host \f3serverhost\fR\&. -.PP -Start \f3tnameserv\fR on the host \f3nameserverhost\fR: -.sp -.nf -\f3tnameserv \-ORBInitialPort 1050\fP -.fi -.nf -\f3\fP -.fi -.sp -Start the server on the \f3serverhost\fR: -.sp -.nf -\f3java Server \-ORBInitialPort 1050 \-ORBInitialHost nameserverhost\fP -.fi -.nf -\f3\fP -.fi -.sp -Start the client on the \f3clienthost\fR: -.sp -.nf -\f3java Client \-ORBInitialPort 1050 \-ORBInitialHost nameserverhost\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS STOP\ THE\ NAMING\ SERVICE -To stop the Java IDL naming service, use the relevant operating system command, such as \f3kill\fR for a Unix process or \f3Ctrl+C\fR for a Windows process\&. The naming service continues to wait for invocations until it is explicitly shut down\&. Note that names registered with the Java IDL naming service disappear when the service is terminated\&. -.SH OPTIONS -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH EXAMPLES -.SS ADD\ OBJECTS\ TO\ THE\ NAME\ SPACE -The following example shows how to add names to the name space\&. It is a self-contained Transient Naming Service client that creates the following simple tree\&. -.sp -.nf -\f3Initial Naming Context\fP -.fi -.nf -\f3 plans\fP -.fi -.nf -\f3 Personal\fP -.fi -.nf -\f3 calendar\fP -.fi -.nf -\f3 schedule\fP -.fi -.nf -\f3\fP -.fi -.sp -In this example, \f3plans\fR is an object reference and \f3Personal\fR is a naming context that contains two object references: \f3calendar\fR and \f3schedule\fR\&. -.sp -.nf -\f3import java\&.util\&.Properties;\fP -.fi -.nf -\f3import org\&.omg\&.CORBA\&.*;\fP -.fi -.nf -\f3import org\&.omg\&.CosNaming\&.*;\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3public class NameClient {\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 public static void main(String args[]) {\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 try {\fP -.fi -.nf -\f3\fP -.fi -.sp -In Start the Naming Service, the \f3nameserver\fR was started on port 1050\&. The following code ensures that the client program is aware of this port number\&. -.sp -.nf -\f3 Properties props = new Properties();\fP -.fi -.nf -\f3 props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP -.fi -.nf -\f3 ORB orb = ORB\&.init(args, props);\fP -.fi -.nf -\f3\fP -.fi -.sp -This code obtains the initial naming context and assigns it to \f3ctx\fR\&. The second line copies \f3ctx\fR into a dummy object reference \f3objref\fR that is attached to various names and added into the name space\&. -.sp -.nf -\f3 NamingContext ctx =\fP -.fi -.nf -\f3 NamingContextHelper\&.narrow(\fP -.fi -.nf -\f3 orb\&.resolve_initial_references("NameService"));\fP -.fi -.nf -\f3 NamingContext objref = ctx;\fP -.fi -.nf -\f3\fP -.fi -.sp -This code creates a name \f3plans\fR of type \f3text\fR and binds it to the dummy object reference\&. \f3plans\fR is then added under the initial naming context using the \f3rebind\fR method\&. The \f3rebind\fR method enables you to run this program over and over again without getting the exceptions from using the \f3bind\fR method\&. -.sp -.nf -\f3 NameComponent nc1 = new NameComponent("plans", "text");\fP -.fi -.nf -\f3 NameComponent[] name1 = {nc1};\fP -.fi -.nf -\f3 ctx\&.rebind(name1, objref);\fP -.fi -.nf -\f3 System\&.out\&.println("plans rebind successful!");\fP -.fi -.nf -\f3\fP -.fi -.sp -This code creates a naming context called \f3Personal\fR of type \f3directory\fR\&. The resulting object reference, \f3ctx2\fR, is bound to the \f3name\fR and added under the initial naming context\&. -.sp -.nf -\f3 NameComponent nc2 = new NameComponent("Personal", "directory");\fP -.fi -.nf -\f3 NameComponent[] name2 = {nc2};\fP -.fi -.nf -\f3 NamingContext ctx2 = ctx\&.bind_new_context(name2);\fP -.fi -.nf -\f3 System\&.out\&.println("new naming context added\&.\&.");\fP -.fi -.nf -\f3\fP -.fi -.sp -The remainder of the code binds the dummy object reference using the names \f3schedule\fR and \f3calendar\fR under the \f3Personal\fR naming context (\f3ctx2\fR)\&. -.sp -.nf -\f3 NameComponent nc3 = new NameComponent("schedule", "text");\fP -.fi -.nf -\f3 NameComponent[] name3 = {nc3};\fP -.fi -.nf -\f3 ctx2\&.rebind(name3, objref);\fP -.fi -.nf -\f3 System\&.out\&.println("schedule rebind successful!");\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 NameComponent nc4 = new NameComponent("calender", "text");\fP -.fi -.nf -\f3 NameComponent[] name4 = {nc4};\fP -.fi -.nf -\f3 ctx2\&.rebind(name4, objref);\fP -.fi -.nf -\f3 System\&.out\&.println("calender rebind successful!");\fP -.fi -.nf -\f3 } catch (Exception e) {\fP -.fi -.nf -\f3 e\&.printStackTrace(System\&.err);\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS BROWSING\ THE\ NAME\ SPACE -The following sample program shoes how to browse the name space\&. -.sp -.nf -\f3import java\&.util\&.Properties;\fP -.fi -.nf -\f3import org\&.omg\&.CORBA\&.*;\fP -.fi -.nf -\f3import org\&.omg\&.CosNaming\&.*;\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3public class NameClientList {\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 public static void main(String args[]) {\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 try {\fP -.fi -.nf -\f3\fP -.fi -.sp -In Start the Naming Service, the \f3nameserver\fR was started on port 1050\&. The following code ensures that the client program is aware of this port number\&. -.sp -.nf -\f3 Properties props = new Properties();\fP -.fi -.nf -\f3 props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP -.fi -.nf -\f3 ORB orb = ORB\&.init(args, props);\fP -.fi -.nf -\f3\fP -.fi -.sp -The following code obtains the initial naming context\&. -.sp -.nf -\f3 NamingContext nc =\fP -.fi -.nf -\f3 NamingContextHelper\&.narrow(\fP -.fi -.nf -\f3 orb\&.resolve_initial_references("NameService"));\fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3list\fR method lists the bindings in the naming context\&. In this case, up to 1000 bindings from the initial naming context will be returned in the \f3BindingListHolder\fR; any remaining bindings are returned in the \f3BindingIteratorHolder\fR\&. -.sp -.nf -\f3 BindingListHolder bl = new BindingListHolder();\fP -.fi -.nf -\f3 BindingIteratorHolder blIt= new BindingIteratorHolder();\fP -.fi -.nf -\f3 nc\&.list(1000, bl, blIt);\fP -.fi -.nf -\f3\fP -.fi -.sp -This code gets the array of bindings out of the returned \f3BindingListHolder\fR\&. If there are no bindings, then the program ends\&. -.sp -.nf -\f3 Binding bindings[] = bl\&.value;\fP -.fi -.nf -\f3 if (bindings\&.length == 0) return;\fP -.fi -.nf -\f3\fP -.fi -.sp -The remainder of the code loops through the bindings and prints outs the names\&. -.sp -.nf -\f3 for (int i=0; i < bindings\&.length; i++) {\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 // get the object reference for each binding\fP -.fi -.nf -\f3 org\&.omg\&.CORBA\&.Object obj = nc\&.resolve(bindings[i]\&.binding_name);\fP -.fi -.nf -\f3 String objStr = orb\&.object_to_string(obj);\fP -.fi -.nf -\f3 int lastIx = bindings[i]\&.binding_name\&.length\-1;\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 // check to see if this is a naming context\fP -.fi -.nf -\f3 if (bindings[i]\&.binding_type == BindingType\&.ncontext) {\fP -.fi -.nf -\f3 System\&.out\&.println("Context: " +\fP -.fi -.nf -\f3 bindings[i]\&.binding_name[lastIx]\&.id);\fP -.fi -.nf -\f3 } else {\fP -.fi -.nf -\f3 System\&.out\&.println("Object: " +\fP -.fi -.nf -\f3 bindings[i]\&.binding_name[lastIx]\&.id);\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3 } catch (Exception e) {\fP -.fi -.nf -\f3 e\&.printStackTrace(System\&.err)\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH SEE\ ALSO -.TP 0.2i -\(bu -orbd(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1999, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java IDL and RMI-IIOP Tools +.\" Title: tnameserv.1 +.\" +.if n .pl 99999 +.TH tnameserv 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +tnameserv \- Interface Definition Language (IDL)\&. +.SH SYNOPSIS +.sp +.nf + +\fBtnameserve\fR \fB\-ORBInitialPort\fR [ \fInameserverport\fR ] +.fi +.sp +.TP +-ORBInitialPort \fInameserverport\fR +.br +The initial port where the naming service listens for the bootstrap protocol used to implement the ORB \f3resolve_initial_references\fR and \f3list_initial_references\fR methods\&. +.SH DESCRIPTION +Java IDL includes the Object Request Broker Daemon (ORBD)\&. ORBD is a daemon process that contains a Bootstrap Service, a Transient Naming Service, a Persistent Naming Service, and a Server Manager\&. The Java IDL tutorials all use ORBD, but you can substitute the \f3tnameserv\fR command for the \f3orbd\fR command in any of the examples that use a Transient Naming Service\&. +.PP +See orbd(1) or Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html +.PP +The CORBA Common Object Services (COS) Naming Service provides a tree-structure directory for object references similar to a file system that provides a directory structure for files\&. The Transient Naming Service provided with Java IDL, \f3tnameserv\fR, is a simple implementation of the COS Naming Service specification\&. +.PP +Object references are stored in the name space by name and each object reference-name pair is called a name binding\&. Name bindings can be organized under naming contexts\&. Naming contexts are name bindings and serve the same organizational function as a file system subdirectory\&. All bindings are stored under the initial naming context\&. The initial naming context is the only persistent binding in the name space\&. The rest of the name space is lost when the Java IDL naming service process stops and restarts\&. +.PP +For an applet or application to use COS naming, its ORB must know the port of a host running a naming service or have access to an initial naming context string for that naming service\&. The naming service can either be the Java IDL naming service or another COS-compliant naming service\&. +.SS START\ THE\ NAMING\ SERVICE +You must start the Java IDL naming service before an application or applet that uses its naming service\&. Installation of the Java IDL product creates a script (Oracle Solaris: \f3tnameserv\fR) or executable file (Windows: \f3tnameserv\&.exe\fR) that starts the Java IDL naming service\&. Start the naming service so it runs in the background\&. +.PP +If you do not specify otherwise, then the Java IDL naming service listens on port 900 for the bootstrap protocol used to implement the ORB \f3resolve_initial_references\fR and \f3list_initial_references methods\fR, as follows: +.sp +.nf +\f3tnameserv \-ORBInitialPort nameserverport&\fP +.fi +.nf +\f3\fP +.fi +.sp +If you do not specify the name server port, then port 900 is used by default\&. When running Oracle Solaris software, you must become the root user to start a process on a port below 1024\&. For this reason, it is recommended that you use a port number greater than or equal to 1024\&. To specify a different port, for example, 1050, and to run the naming service in the background, from a UNIX command shell, enter: +.sp +.nf +\f3tnameserv \-ORBInitialPort 1050&\fP +.fi +.nf +\f3\fP +.fi +.sp +From an MS-DOS system prompt (Windows), enter: +.sp +.nf +\f3start tnameserv \-ORBInitialPort 1050\fP +.fi +.nf +\f3\fP +.fi +.sp +Clients of the name server must be made aware of the new port number\&. Do this by setting the \f3org\&.omg\&.CORBA\&.ORBInitialPort\fR property to the new port number when you create the ORB object\&. +.SS RUN\ THE\ SERVER\ AND\ CLIENT\ ON\ DIFFERENT\ HOSTS +In most of the Java IDL and RMI-IIOP tutorials, the naming service, server, and client are all running on the development machine\&. In real-world deployment, the client and server probably run on different host machines from the Naming Service\&. +.PP +For the client and server to find the Naming Service, they must be made aware of the port number and host on which the naming service is running\&. Do this by setting the \f3org\&.omg\&.CORBA\&.ORBInitialPort\fR and \f3org\&.omg\&.CORBA\&.ORBInitialHost\fR properties in the client and server files to the machine name and port number on which the Naming Service is running\&. An example of this is shown in Getting Started Using RMI-IIOP at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/rmi-iiop/rmiiiopexample\&.html +.PP +You could also use the command-line options \f3-ORBInitialPort nameserverport#\fR and \f3-ORBInitialHost nameserverhostname\fR to tell the client and server where to find the naming service\&. For one example of doing this using the command-line option, see Java IDL: The Hello World Example on Two Machines at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/tutorial/jidl2machines\&.html +.PP +For example, suppose the Transient Naming Service, \f3tnameserv\fR is running on port 1050 on host \f3nameserverhost\fR\&. The client is running on host \f3clienthost,\fR and the server is running on host \f3serverhost\fR\&. +.PP +Start \f3tnameserv\fR on the host \f3nameserverhost\fR: +.sp +.nf +\f3tnameserv \-ORBInitialPort 1050\fP +.fi +.nf +\f3\fP +.fi +.sp +Start the server on the \f3serverhost\fR: +.sp +.nf +\f3java Server \-ORBInitialPort 1050 \-ORBInitialHost nameserverhost\fP +.fi +.nf +\f3\fP +.fi +.sp +Start the client on the \f3clienthost\fR: +.sp +.nf +\f3java Client \-ORBInitialPort 1050 \-ORBInitialHost nameserverhost\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS STOP\ THE\ NAMING\ SERVICE +To stop the Java IDL naming service, use the relevant operating system command, such as \f3kill\fR for a Unix process or \f3Ctrl+C\fR for a Windows process\&. The naming service continues to wait for invocations until it is explicitly shut down\&. Note that names registered with the Java IDL naming service disappear when the service is terminated\&. +.SH OPTIONS +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH EXAMPLES +.SS ADD\ OBJECTS\ TO\ THE\ NAME\ SPACE +The following example shows how to add names to the name space\&. It is a self-contained Transient Naming Service client that creates the following simple tree\&. +.sp +.nf +\f3Initial Naming Context\fP +.fi +.nf +\f3 plans\fP +.fi +.nf +\f3 Personal\fP +.fi +.nf +\f3 calendar\fP +.fi +.nf +\f3 schedule\fP +.fi +.nf +\f3\fP +.fi +.sp +In this example, \f3plans\fR is an object reference and \f3Personal\fR is a naming context that contains two object references: \f3calendar\fR and \f3schedule\fR\&. +.sp +.nf +\f3import java\&.util\&.Properties;\fP +.fi +.nf +\f3import org\&.omg\&.CORBA\&.*;\fP +.fi +.nf +\f3import org\&.omg\&.CosNaming\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class NameClient {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public static void main(String args[]) {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 try {\fP +.fi +.nf +\f3\fP +.fi +.sp +In Start the Naming Service, the \f3nameserver\fR was started on port 1050\&. The following code ensures that the client program is aware of this port number\&. +.sp +.nf +\f3 Properties props = new Properties();\fP +.fi +.nf +\f3 props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP +.fi +.nf +\f3 ORB orb = ORB\&.init(args, props);\fP +.fi +.nf +\f3\fP +.fi +.sp +This code obtains the initial naming context and assigns it to \f3ctx\fR\&. The second line copies \f3ctx\fR into a dummy object reference \f3objref\fR that is attached to various names and added into the name space\&. +.sp +.nf +\f3 NamingContext ctx =\fP +.fi +.nf +\f3 NamingContextHelper\&.narrow(\fP +.fi +.nf +\f3 orb\&.resolve_initial_references("NameService"));\fP +.fi +.nf +\f3 NamingContext objref = ctx;\fP +.fi +.nf +\f3\fP +.fi +.sp +This code creates a name \f3plans\fR of type \f3text\fR and binds it to the dummy object reference\&. \f3plans\fR is then added under the initial naming context using the \f3rebind\fR method\&. The \f3rebind\fR method enables you to run this program over and over again without getting the exceptions from using the \f3bind\fR method\&. +.sp +.nf +\f3 NameComponent nc1 = new NameComponent("plans", "text");\fP +.fi +.nf +\f3 NameComponent[] name1 = {nc1};\fP +.fi +.nf +\f3 ctx\&.rebind(name1, objref);\fP +.fi +.nf +\f3 System\&.out\&.println("plans rebind successful!");\fP +.fi +.nf +\f3\fP +.fi +.sp +This code creates a naming context called \f3Personal\fR of type \f3directory\fR\&. The resulting object reference, \f3ctx2\fR, is bound to the \f3name\fR and added under the initial naming context\&. +.sp +.nf +\f3 NameComponent nc2 = new NameComponent("Personal", "directory");\fP +.fi +.nf +\f3 NameComponent[] name2 = {nc2};\fP +.fi +.nf +\f3 NamingContext ctx2 = ctx\&.bind_new_context(name2);\fP +.fi +.nf +\f3 System\&.out\&.println("new naming context added\&.\&.");\fP +.fi +.nf +\f3\fP +.fi +.sp +The remainder of the code binds the dummy object reference using the names \f3schedule\fR and \f3calendar\fR under the \f3Personal\fR naming context (\f3ctx2\fR)\&. +.sp +.nf +\f3 NameComponent nc3 = new NameComponent("schedule", "text");\fP +.fi +.nf +\f3 NameComponent[] name3 = {nc3};\fP +.fi +.nf +\f3 ctx2\&.rebind(name3, objref);\fP +.fi +.nf +\f3 System\&.out\&.println("schedule rebind successful!");\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 NameComponent nc4 = new NameComponent("calender", "text");\fP +.fi +.nf +\f3 NameComponent[] name4 = {nc4};\fP +.fi +.nf +\f3 ctx2\&.rebind(name4, objref);\fP +.fi +.nf +\f3 System\&.out\&.println("calender rebind successful!");\fP +.fi +.nf +\f3 } catch (Exception e) {\fP +.fi +.nf +\f3 e\&.printStackTrace(System\&.err);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS BROWSING\ THE\ NAME\ SPACE +The following sample program shoes how to browse the name space\&. +.sp +.nf +\f3import java\&.util\&.Properties;\fP +.fi +.nf +\f3import org\&.omg\&.CORBA\&.*;\fP +.fi +.nf +\f3import org\&.omg\&.CosNaming\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class NameClientList {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public static void main(String args[]) {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 try {\fP +.fi +.nf +\f3\fP +.fi +.sp +In Start the Naming Service, the \f3nameserver\fR was started on port 1050\&. The following code ensures that the client program is aware of this port number\&. +.sp +.nf +\f3 Properties props = new Properties();\fP +.fi +.nf +\f3 props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP +.fi +.nf +\f3 ORB orb = ORB\&.init(args, props);\fP +.fi +.nf +\f3\fP +.fi +.sp +The following code obtains the initial naming context\&. +.sp +.nf +\f3 NamingContext nc =\fP +.fi +.nf +\f3 NamingContextHelper\&.narrow(\fP +.fi +.nf +\f3 orb\&.resolve_initial_references("NameService"));\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3list\fR method lists the bindings in the naming context\&. In this case, up to 1000 bindings from the initial naming context will be returned in the \f3BindingListHolder\fR; any remaining bindings are returned in the \f3BindingIteratorHolder\fR\&. +.sp +.nf +\f3 BindingListHolder bl = new BindingListHolder();\fP +.fi +.nf +\f3 BindingIteratorHolder blIt= new BindingIteratorHolder();\fP +.fi +.nf +\f3 nc\&.list(1000, bl, blIt);\fP +.fi +.nf +\f3\fP +.fi +.sp +This code gets the array of bindings out of the returned \f3BindingListHolder\fR\&. If there are no bindings, then the program ends\&. +.sp +.nf +\f3 Binding bindings[] = bl\&.value;\fP +.fi +.nf +\f3 if (bindings\&.length == 0) return;\fP +.fi +.nf +\f3\fP +.fi +.sp +The remainder of the code loops through the bindings and prints outs the names\&. +.sp +.nf +\f3 for (int i=0; i < bindings\&.length; i++) {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 // get the object reference for each binding\fP +.fi +.nf +\f3 org\&.omg\&.CORBA\&.Object obj = nc\&.resolve(bindings[i]\&.binding_name);\fP +.fi +.nf +\f3 String objStr = orb\&.object_to_string(obj);\fP +.fi +.nf +\f3 int lastIx = bindings[i]\&.binding_name\&.length\-1;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 // check to see if this is a naming context\fP +.fi +.nf +\f3 if (bindings[i]\&.binding_type == BindingType\&.ncontext) {\fP +.fi +.nf +\f3 System\&.out\&.println("Context: " +\fP +.fi +.nf +\f3 bindings[i]\&.binding_name[lastIx]\&.id);\fP +.fi +.nf +\f3 } else {\fP +.fi +.nf +\f3 System\&.out\&.println("Object: " +\fP +.fi +.nf +\f3 bindings[i]\&.binding_name[lastIx]\&.id);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 } catch (Exception e) {\fP +.fi +.nf +\f3 e\&.printStackTrace(System\&.err)\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +orbd(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/unpack200.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/unpack200.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,137 +1,137 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java Deployment Tools -.\" Title: unpack200.1 -.\" -.if n .pl 99999 -.TH unpack200 1 "21 November 2013" "JDK 8" "Java Deployment Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -unpack200 \- Transforms a packed file produced by pack200(1) into a JAR file for web deployment\&. -.SH SYNOPSIS -.sp -.nf - -\fBunpack200\fR [ \fIoptions\fR ] input\-file \fIJAR\-file\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIinput-file\fR -Name of the input file, which can be a pack200 gzip file or a pack200 file\&. The input can also be JAR file produced by \f3pack200\fR(1) with an effort of \f30\fR, in which case the contents of the input file are copied to the output JAR file with the Pack200 marker\&. -.TP -\fIJAR-file\fR -Name of the output JAR file\&. -.SH DESCRIPTION -The \f3unpack200\fR command is a native implementation that transforms a packed file produced by \f3pack200\fR\f3(1)\fR into a JAR file\&. A typical usage follows\&. In the following example, the \f3myarchive\&.jar\fR file is produced from \f3myarchive\&.pack\&.gz\fR with the default \f3unpack200\fR command settings\&. -.sp -.nf -\f3unpack200 myarchive\&.pack\&.gz myarchive\&.jar\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH OPTIONS -.TP --Hvalue --deflate-hint=\fIvalue\fR -.br -Sets the deflation to be \f3true\fR, \f3false\fR, or \f3keep\fR on all entries within a JAR file\&. The default mode is \f3keep\fR\&. If the value is \f3true\fR or \f3false\fR, then the \f3--deflate=hint\fR option overrides the default behavior and sets the deflation mode on all entries within the output JAR file\&. -.TP --r --remove-pack-file -.br -Removes the input pack file\&. -.TP --v --verbose -.br -Displays minimal messages\&. Multiple specifications of this option displays more verbose messages\&. -.TP --q --quiet -.br -Specifies quiet operation with no messages\&. -.TP --lfilename --log-file=\fIfilename\fR -.br -Specifies a log file where output messages are logged\&. -.TP --? -h --help -.br -Prints help information about the \f3unpack200\fR command\&. -.TP --V --version -.br -Prints version information about the \f3unpack200\fR command\&. -.TP --J\fIoption\fR -.br -Passes option to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH NOTES -This command should not be confused with the \f3unpack\fR command\&. They are distinctly separate products\&. -.PP -The Java SE API Specification provided with the JDK is the superseding authority in case of discrepancies\&. -.SH EXIT\ STATUS -The following exit values are returned: 0 for successful completion, and a value that is greater than 0 when an error occurred\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -pack200(1) -.TP 0.2i -\(bu -jar(1) -.TP 0.2i -\(bu -jarsigner(1) -.TP 0.2i -\(bu -Pack200 and Compression at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/deployment/deployment-guide/pack200\&.html -.TP 0.2i -\(bu -The Java SE Technical Documentation page at http://docs\&.oracle\&.com/javase/ -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Deployment Tools +.\" Title: unpack200.1 +.\" +.if n .pl 99999 +.TH unpack200 1 "21 November 2013" "JDK 8" "Java Deployment Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +unpack200 \- Transforms a packed file produced by pack200(1) into a JAR file for web deployment\&. +.SH SYNOPSIS +.sp +.nf + +\fBunpack200\fR [ \fIoptions\fR ] input\-file \fIJAR\-file\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIinput-file\fR +Name of the input file, which can be a pack200 gzip file or a pack200 file\&. The input can also be JAR file produced by \f3pack200\fR(1) with an effort of \f30\fR, in which case the contents of the input file are copied to the output JAR file with the Pack200 marker\&. +.TP +\fIJAR-file\fR +Name of the output JAR file\&. +.SH DESCRIPTION +The \f3unpack200\fR command is a native implementation that transforms a packed file produced by \f3pack200\fR\f3(1)\fR into a JAR file\&. A typical usage follows\&. In the following example, the \f3myarchive\&.jar\fR file is produced from \f3myarchive\&.pack\&.gz\fR with the default \f3unpack200\fR command settings\&. +.sp +.nf +\f3unpack200 myarchive\&.pack\&.gz myarchive\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-Hvalue --deflate-hint=\fIvalue\fR +.br +Sets the deflation to be \f3true\fR, \f3false\fR, or \f3keep\fR on all entries within a JAR file\&. The default mode is \f3keep\fR\&. If the value is \f3true\fR or \f3false\fR, then the \f3--deflate=hint\fR option overrides the default behavior and sets the deflation mode on all entries within the output JAR file\&. +.TP +-r --remove-pack-file +.br +Removes the input pack file\&. +.TP +-v --verbose +.br +Displays minimal messages\&. Multiple specifications of this option displays more verbose messages\&. +.TP +-q --quiet +.br +Specifies quiet operation with no messages\&. +.TP +-lfilename --log-file=\fIfilename\fR +.br +Specifies a log file where output messages are logged\&. +.TP +-? -h --help +.br +Prints help information about the \f3unpack200\fR command\&. +.TP +-V --version +.br +Prints version information about the \f3unpack200\fR command\&. +.TP +-J\fIoption\fR +.br +Passes option to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH NOTES +This command should not be confused with the \f3unpack\fR command\&. They are distinctly separate products\&. +.PP +The Java SE API Specification provided with the JDK is the superseding authority in case of discrepancies\&. +.SH EXIT\ STATUS +The following exit values are returned: 0 for successful completion, and a value that is greater than 0 when an error occurred\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +pack200(1) +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +jarsigner(1) +.TP 0.2i +\(bu +Pack200 and Compression at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/deployment/deployment-guide/pack200\&.html +.TP 0.2i +\(bu +The Java SE Technical Documentation page at http://docs\&.oracle\&.com/javase/ +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/wsgen.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/wsgen.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,175 +1,175 @@ -'\" t -.\" Copyright (c) 2005, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java Web Services Tools -.\" Title: wsgen.1 -.\" -.if n .pl 99999 -.TH wsgen 1 "21 November 2013" "JDK 8" "Java Web Services Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -wsgen \- Reads a web service endpoint implementation (SEI) class and generates all of the required artifacts for web service deployment, and invocation\&. -.SH SYNOPSIS -.sp -.nf - -\fBwsgen\fR [ \fIoptions\fR ] \fISEI\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fISEI\fR -The web service endpoint implementation class (SEI) to be read\&. -.SH DESCRIPTION -The \f3wsgen\fR command 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 \f3wsgen\fR Ant task, see the \fITools\fR tab of the JAX-WS (wsgen) page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsgenant\&.html -.PP -To start the \f3wsgen\fR command, do the following: -.sp -.nf -\f3export JAXWS_HOME=/pathto/jaxws\-ri\fP -.fi -.nf -\f3$JAXWS_HOME/bin/wsgen\&.sh \-help\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH OPTIONS -.TP --classpath \fIpath\fR -.br -The location of the input class files\&. -.TP --cp \fIpath\fR -.br -The location of the input class files\&. -.TP --d \fIdirectory\fR -.br -The location for where to place generated output files\&. -.TP --extension -.br -Allow vendor extensions\&. Use of extensions can result in applications that are not portable or that do not work with other implementations\&. -.TP --help -.br -Displays a help message about the \f3wsgen\fR command\&. -.TP --keep -.br -Keeps the generated files\&. -.TP --r \fIdirectory\fR -.br -Uses this option with the \f3-wsdl\fR option to specify where to place generated resource files such as WSDLs\&. -.TP --s \fIdirectory\fR -.br -The location for where to place generated source files\&. -.TP --verbose -.br -Displays compiler messages\&. -.TP --version -.br -Prints release information\&. -.TP --wsdl [ :protocol ] \fI\fR -.br -An optional command that generates a WSDL file to review before endpoint deployment\&. The WSDL files contains a machine-readable description of how the service can be called, what parameters it expects, and what data structures it returns\&. - -By default the \f3wsgen\fR command does not generate a WSDL file\&. The \f3protocol\fR value is optional and is used to specify what protocol should be used for the WSDL binding (\f3wsdl:binding\fR)\&. Valid protocols are \f3soap1\&.1\fR and \f3Xsoap1\&.2\fR\&. The default is \f3soap1\&.1\fR\&. The \f3Xsoap1\&.2\fR protocol is not standard and can only be used with the \f3-extension\fR option\&. -.TP --servicename \fIname\fR -.br -Used only with the \f3-wsdl\fR option to specify a particular WSDL service (\f3wsdl:service\fR) name to be generated in the WSDL, for example: \f3-servicename "{http://mynamespace/}MyService"\fR\&. -.TP --portname \fIname\fR -.br -Used only with the \f3-wsdl\fR option to specify a particular WSDL port (\f3wsdl:port\fR) name to be generated in the WSDL, for example: \f3-portname "{http://mynamespace/}MyPort"\fR\&. -.SH EXAMPLES -The following example generates the wrapper classes for \f3StockService\fR with \f3@WebService\fR annotations inside stock directory\&. -.sp -.nf -\f3wsgen \-d stock \-cp myclasspath stock\&.StockService\fP -.fi -.nf -\f3\fP -.fi -.sp -The following example generates a SOAP 1\&.1 WSDL and schema for the \f3stock\&.StockService\fR class with \f3@WebService\fR annotations\&. -.sp -.nf -\f3wsgen \-wsdl \-d stock \-cp myclasspath stock\&.StockService\fP -.fi -.nf -\f3\fP -.fi -.sp -The following example generates a SOAP 1\&.2 WSDL\&. -.sp -.nf -\f3wsgen \-wsdl:Xsoap1\&.2 \-d stock \-cp myclasspath stock\&.StockService \fP -.fi -.nf -\f3\fP -.fi -.sp -\fINote:\fR You do not have to generate WSDL at development time because the JAXWS run time environment generates a WSDL for you when you deploy your service\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -wsimport(1) -.TP 0.2i -\(bu -\fIThe Tools\fR tab of the JAX-WS (wsgen) page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsgenant\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2005, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Web Services Tools +.\" Title: wsgen.1 +.\" +.if n .pl 99999 +.TH wsgen 1 "21 November 2013" "JDK 8" "Java Web Services Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +wsgen \- Reads a web service endpoint implementation (SEI) class and generates all of the required artifacts for web service deployment, and invocation\&. +.SH SYNOPSIS +.sp +.nf + +\fBwsgen\fR [ \fIoptions\fR ] \fISEI\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fISEI\fR +The web service endpoint implementation class (SEI) to be read\&. +.SH DESCRIPTION +The \f3wsgen\fR command 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 \f3wsgen\fR Ant task, see the \fITools\fR tab of the JAX-WS (wsgen) page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsgenant\&.html +.PP +To start the \f3wsgen\fR command, do the following: +.sp +.nf +\f3export JAXWS_HOME=/pathto/jaxws\-ri\fP +.fi +.nf +\f3$JAXWS_HOME/bin/wsgen\&.sh \-help\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-classpath \fIpath\fR +.br +The location of the input class files\&. +.TP +-cp \fIpath\fR +.br +The location of the input class files\&. +.TP +-d \fIdirectory\fR +.br +The location for where to place generated output files\&. +.TP +-extension +.br +Allow vendor extensions\&. Use of extensions can result in applications that are not portable or that do not work with other implementations\&. +.TP +-help +.br +Displays a help message about the \f3wsgen\fR command\&. +.TP +-keep +.br +Keeps the generated files\&. +.TP +-r \fIdirectory\fR +.br +Uses this option with the \f3-wsdl\fR option to specify where to place generated resource files such as WSDLs\&. +.TP +-s \fIdirectory\fR +.br +The location for where to place generated source files\&. +.TP +-verbose +.br +Displays compiler messages\&. +.TP +-version +.br +Prints release information\&. +.TP +-wsdl [ :protocol ] \fI\fR +.br +An optional command that generates a WSDL file to review before endpoint deployment\&. The WSDL files contains a machine-readable description of how the service can be called, what parameters it expects, and what data structures it returns\&. + +By default the \f3wsgen\fR command does not generate a WSDL file\&. The \f3protocol\fR value is optional and is used to specify what protocol should be used for the WSDL binding (\f3wsdl:binding\fR)\&. Valid protocols are \f3soap1\&.1\fR and \f3Xsoap1\&.2\fR\&. The default is \f3soap1\&.1\fR\&. The \f3Xsoap1\&.2\fR protocol is not standard and can only be used with the \f3-extension\fR option\&. +.TP +-servicename \fIname\fR +.br +Used only with the \f3-wsdl\fR option to specify a particular WSDL service (\f3wsdl:service\fR) name to be generated in the WSDL, for example: \f3-servicename "{http://mynamespace/}MyService"\fR\&. +.TP +-portname \fIname\fR +.br +Used only with the \f3-wsdl\fR option to specify a particular WSDL port (\f3wsdl:port\fR) name to be generated in the WSDL, for example: \f3-portname "{http://mynamespace/}MyPort"\fR\&. +.SH EXAMPLES +The following example generates the wrapper classes for \f3StockService\fR with \f3@WebService\fR annotations inside stock directory\&. +.sp +.nf +\f3wsgen \-d stock \-cp myclasspath stock\&.StockService\fP +.fi +.nf +\f3\fP +.fi +.sp +The following example generates a SOAP 1\&.1 WSDL and schema for the \f3stock\&.StockService\fR class with \f3@WebService\fR annotations\&. +.sp +.nf +\f3wsgen \-wsdl \-d stock \-cp myclasspath stock\&.StockService\fP +.fi +.nf +\f3\fP +.fi +.sp +The following example generates a SOAP 1\&.2 WSDL\&. +.sp +.nf +\f3wsgen \-wsdl:Xsoap1\&.2 \-d stock \-cp myclasspath stock\&.StockService \fP +.fi +.nf +\f3\fP +.fi +.sp +\fINote:\fR You do not have to generate WSDL at development time because the JAXWS run time environment generates a WSDL for you when you deploy your service\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +wsimport(1) +.TP 0.2i +\(bu +\fIThe Tools\fR tab of the JAX-WS (wsgen) page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsgenant\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/wsimport.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/wsimport.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,216 +1,216 @@ -'\" t -.\" Copyright (c) 2005, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java Web Services Tools -.\" Title: wsimport.1 -.\" -.if n .pl 99999 -.TH wsimport 1 "21 November 2013" "JDK 8" "Java Web Services Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -wsimport \- Generates JAX-WS portable artifacts that can be packaged in a web application archive (WAR) file and provides an Ant task\&. -.SH SYNOPSIS -.sp -.nf - -\fBwsimport\fR [ \fIoptions\fR ] \fIwsdl\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIwsdl\fR -The file that contains the machine-readable description of how the web service can be called, what parameters it expects, and what data structures it returns\&. -.SH DESCRIPTION -The \f3wsimport\fR command generates the following JAX-WS portable artifacts\&. These artifacts can be packaged in a WAR file with the WSDL and schema documents and the endpoint implementation to be deployed\&. The \f3wsimport\fR command also provides a \f3wsimport\fR Ant task, see the Tools tab of the Wsimport Ant Task page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html -.TP 0.2i -\(bu -Service Endpoint Interface (SEI) -.TP 0.2i -\(bu -Service -.TP 0.2i -\(bu -Exception class is mapped from \f3wsdl:fault\fR (if any) -.TP 0.2i -\(bu -Async Response Bean is derived from response \f3wsdl:message\fR (if any) -.TP 0.2i -\(bu -JAXB generated value types (mapped java classes from schema types) -.PP -To start the \f3wsgen\fR command, do the following: -.PP -\fIOracle Solaris/Linux\fR: -.sp -.nf -\f3/bin/wsimport\&.sh \-help\fP -.fi -.nf -\f3\fP -.fi -.sp -\fIWindows\fR: -.sp -.nf -\f3\ebin\ewsimport\&.bat \-help\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH OPTIONS -.TP --d \fIdirectory\fR -.br -Specifies where to place generated output files\&. -.TP --b \fIpath\fR -.br -Specifies external JAX-WS or JAXB binding files\&. Multiple JAX-WS and JAXB binding files can be specified with the \f3-b\fR option\&. You can use these files to customize package names, bean names, and so on\&. For more information about JAX-WS and JAXB binding files, see the \fIUsers Guide\fR tab of WSDL Customization at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html -.TP --B \fIjaxbOption\fR -.br -Passes the \f3jaxbOption\fR option to the JAXB schema compiler\&. -.TP --catalog -.br -Specifies a catalog file to resolve external entity references\&. The \f3-catalog\fR option supports the TR9401, XCatalog, and OASIS XML Catalog formats\&. See the \fIUsers Guide\fR tab of the Catalog Support page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/catalog-support\&.html -.TP --extension -.br -Allows vendor extensions\&. Use of extensions can result in applications that are not portable or that do not work with other implementations\&. -.TP --help -.br -Displays a help message for the \f3wsimport\fR command\&. -.TP --httpproxy: \fIhost\fR:\fIport\fR -.br -Specifies an HTTP proxy server\&. The default is 8080\&. -.TP --keep -.br -Keeps generated files\&. -.TP --p \fIname\fR -.br -Specifies a target package \fIname\fR to override the WSDL and schema binding customizations, and the default algorithm defined in the specification\&. -.TP --s \fIdirectory\fR -.br -Specifies where to place generated source files\&. -.TP --verbose -.br -Displays compiler messages\&. -.TP --version -.br -Prints release information\&. -.TP --wsdllocation \fIlocation\fR -.br -Specifies the \f3@WebServiceClient\&.wsdlLocation\fR value\&. -.TP --target -.br -Generates code according to the specified JAX-WS specification version\&. Version 2\&.0 generates compliant code for the JAX-WS 2\&.0 specification\&. -.TP --quiet -.br -Suppresses the \f3wsimport\fR command output\&. -.PP -Multiple \f3JAX-WS\fR and \f3JAXB\fR binding files can be specified using the \f3-b\fR option, and they can be used to customize various things such as package names and bean names\&. More information about \f3JAX-WS\fR and \f3JAXB\fR binding files can be found in the customization documentation at https://jax-ws\&.dev\&.java\&.net/nonav/2\&.1\&.1/docs/customizations\&.html -.SH NONSTANDARD\ OPTIONS -.TP --XadditionalHeaders -.br -Maps headers not bound to a request or response message to Java method parameters\&. -.TP --Xauthfile \fIfile\fR -.br -The WSDL URI that specifies the file that contains authorization information\&. This URI is in the following format: - -http://\fIuser-name\fR:\f3password\fR@\fIhost-name\fR/\fIweb-service-name\fR>?wsdl\&. -.TP --Xdebug -.br -Prints debugging information\&. -.TP --Xno-addressing-databinding -.br -Enables binding of W3C EndpointReferenceType to Java\&. -.TP --Xnocompile -.br -Does not compile the generated Java files\&. -.SH EXAMPLE -The following example generates the Java artifacts and compiles the artifacts by importing \f3http://stockquote\&.example\&.com/quote?wsdl\fR -.sp -.nf -\f3wsimport \-p stockquote http://stockquote\&.example\&.com/quote?wsdl\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH SEE\ ALSO -.TP 0.2i -\(bu -wsgen(1) -.TP 0.2i -\(bu -The Tools tab of Wsimport Ant Task page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html -.TP 0.2i -\(bu -The \fIUsers Guide\fR tab of Catalog Support page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/catalog-support\&.html -.TP 0.2i -\(bu -The \fIUsers Guide\fR tab of WSDL Customization page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2005, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Web Services Tools +.\" Title: wsimport.1 +.\" +.if n .pl 99999 +.TH wsimport 1 "21 November 2013" "JDK 8" "Java Web Services Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +wsimport \- Generates JAX-WS portable artifacts that can be packaged in a web application archive (WAR) file and provides an Ant task\&. +.SH SYNOPSIS +.sp +.nf + +\fBwsimport\fR [ \fIoptions\fR ] \fIwsdl\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIwsdl\fR +The file that contains the machine-readable description of how the web service can be called, what parameters it expects, and what data structures it returns\&. +.SH DESCRIPTION +The \f3wsimport\fR command generates the following JAX-WS portable artifacts\&. These artifacts can be packaged in a WAR file with the WSDL and schema documents and the endpoint implementation to be deployed\&. The \f3wsimport\fR command also provides a \f3wsimport\fR Ant task, see the Tools tab of the Wsimport Ant Task page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html +.TP 0.2i +\(bu +Service Endpoint Interface (SEI) +.TP 0.2i +\(bu +Service +.TP 0.2i +\(bu +Exception class is mapped from \f3wsdl:fault\fR (if any) +.TP 0.2i +\(bu +Async Response Bean is derived from response \f3wsdl:message\fR (if any) +.TP 0.2i +\(bu +JAXB generated value types (mapped java classes from schema types) +.PP +To start the \f3wsgen\fR command, do the following: +.PP +\fIOracle Solaris/Linux\fR: +.sp +.nf +\f3/bin/wsimport\&.sh \-help\fP +.fi +.nf +\f3\fP +.fi +.sp +\fIWindows\fR: +.sp +.nf +\f3\ebin\ewsimport\&.bat \-help\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-d \fIdirectory\fR +.br +Specifies where to place generated output files\&. +.TP +-b \fIpath\fR +.br +Specifies external JAX-WS or JAXB binding files\&. Multiple JAX-WS and JAXB binding files can be specified with the \f3-b\fR option\&. You can use these files to customize package names, bean names, and so on\&. For more information about JAX-WS and JAXB binding files, see the \fIUsers Guide\fR tab of WSDL Customization at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html +.TP +-B \fIjaxbOption\fR +.br +Passes the \f3jaxbOption\fR option to the JAXB schema compiler\&. +.TP +-catalog +.br +Specifies a catalog file to resolve external entity references\&. The \f3-catalog\fR option supports the TR9401, XCatalog, and OASIS XML Catalog formats\&. See the \fIUsers Guide\fR tab of the Catalog Support page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/catalog-support\&.html +.TP +-extension +.br +Allows vendor extensions\&. Use of extensions can result in applications that are not portable or that do not work with other implementations\&. +.TP +-help +.br +Displays a help message for the \f3wsimport\fR command\&. +.TP +-httpproxy: \fIhost\fR:\fIport\fR +.br +Specifies an HTTP proxy server\&. The default is 8080\&. +.TP +-keep +.br +Keeps generated files\&. +.TP +-p \fIname\fR +.br +Specifies a target package \fIname\fR to override the WSDL and schema binding customizations, and the default algorithm defined in the specification\&. +.TP +-s \fIdirectory\fR +.br +Specifies where to place generated source files\&. +.TP +-verbose +.br +Displays compiler messages\&. +.TP +-version +.br +Prints release information\&. +.TP +-wsdllocation \fIlocation\fR +.br +Specifies the \f3@WebServiceClient\&.wsdlLocation\fR value\&. +.TP +-target +.br +Generates code according to the specified JAX-WS specification version\&. Version 2\&.0 generates compliant code for the JAX-WS 2\&.0 specification\&. +.TP +-quiet +.br +Suppresses the \f3wsimport\fR command output\&. +.PP +Multiple \f3JAX-WS\fR and \f3JAXB\fR binding files can be specified using the \f3-b\fR option, and they can be used to customize various things such as package names and bean names\&. More information about \f3JAX-WS\fR and \f3JAXB\fR binding files can be found in the customization documentation at https://jax-ws\&.dev\&.java\&.net/nonav/2\&.1\&.1/docs/customizations\&.html +.SH NONSTANDARD\ OPTIONS +.TP +-XadditionalHeaders +.br +Maps headers not bound to a request or response message to Java method parameters\&. +.TP +-Xauthfile \fIfile\fR +.br +The WSDL URI that specifies the file that contains authorization information\&. This URI is in the following format: + +http://\fIuser-name\fR:\f3password\fR@\fIhost-name\fR/\fIweb-service-name\fR>?wsdl\&. +.TP +-Xdebug +.br +Prints debugging information\&. +.TP +-Xno-addressing-databinding +.br +Enables binding of W3C EndpointReferenceType to Java\&. +.TP +-Xnocompile +.br +Does not compile the generated Java files\&. +.SH EXAMPLE +The following example generates the Java artifacts and compiles the artifacts by importing \f3http://stockquote\&.example\&.com/quote?wsdl\fR +.sp +.nf +\f3wsimport \-p stockquote http://stockquote\&.example\&.com/quote?wsdl\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +wsgen(1) +.TP 0.2i +\(bu +The Tools tab of Wsimport Ant Task page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html +.TP 0.2i +\(bu +The \fIUsers Guide\fR tab of Catalog Support page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/catalog-support\&.html +.TP 0.2i +\(bu +The \fIUsers Guide\fR tab of WSDL Customization page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/bsd/doc/man/xjc.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/bsd/doc/man/xjc.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,232 +1,232 @@ -'\" t -.\" Copyright (c) 2005, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java Web Services Tools -.\" Title: xjc.1 -.\" -.if n .pl 99999 -.TH xjc 1 "21 November 2013" "JDK 8" "Java Web Services Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -xjc \- Compiles an XML schema file into fully annotated Java classes\&. -.SH SYNOPSIS -.sp -.nf - -\fBxjc\fR [ \fIoptions\fR ] \fBschema\fR \fIfile/URL/dir/jar\fR \&.\&.\&. [\fB\-b\fR \fIbindinfo\fR ] \&.\&.\&. -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -schema \fIfile/URL/dir/jar \&.\&.\&.\fR -The location of the XML schema file\&. If \f3dir\fR is specified, then all schema files in it are compiled\&. If \f3jar\fR is specified, then the \f3/META-INF/sun-jaxb\&.episode\fR binding file is compiled\&. -.TP --b \fIbindinfo\fR -.br -The location of the bindings files\&. -.SH DESCRIPTION -Start the binding compiler with the appropriate \f3xjc\fR shell script in the bin directory for your platform\&. There is also an Ant task to run the binding complier\&. See Using the XJC with Ant at http://jaxb\&.java\&.net/nonav/2\&.1\&.3/docs/xjcTask\&.html -.SH OPTIONS -.TP 0.2i -\(bu -See also Nonstandard Options -.TP 0.2i -\(bu -See also Deprecated and Removed Options -.TP --nv -.br -By default, the XJC binding compiler performs strict validation of the source schema before processing it\&. Use this option to disable strict schema validation\&. This does not mean that the binding compiler will not perform any validation, but means that it will perform a less-strict validation\&. -.TP --extension -.br -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 \f3-extension\fR mode enabled by this switch\&. In the default (strict) mode, you are also limited to using only the binding customization defined in the specification\&. By using the \f3-extension\fR switch, you will be allowed to use the JAXB Vendor Extensions\&. -.TP --b \fIfile\fR -.br -Specifies one or more external binding files to process\&. Each binding file must have its own \f3-b\fR switch\&. The syntax of the external binding files is flexible\&. You can have a single binding file that contains customization for multiple schemas or you can break the customization into multiple bindings files: \f3xjc schema1\&.xsd schema2\&.xsd schema3\&.xsd -b bindings123\&.xjb\fR\f3xjc schema1\&.xsd schema2\&.xsd schema3\&.xsd -b bindings1\&.xjb -b bindings2\&.xjb -b bindings3\&.xjb\fR\&. In addition, the ordering of the schema files and binding files on the command line does not matter\&. -.TP --d \fIdir\fR -.br -By default, the XJC binding compiler generates 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 does not create it for you\&. -.TP --p \fIpkg\fR -.br -When you specify a target package with this command-line option, it overrides any binding customization for the package name and the default package name algorithm defined in the specification\&. -.TP --httpproxy \fIproxy\fR -.br -Specifies the HTTP or HTTPS proxy in the format \fI[user[:password]@]proxyHost[:proxyPort]\fR\&. The old \f3-host\fR and \f3-port\fR options are still supported by the RI for backward compatibility, but they were deprecated\&. The password specified with this option is an argument that is visible to other users who use the top command\&. For greater security, use the \f3-httpproxyfile\fR option\&. -.TP --httpproxyfile file -.br -Specifies the HTTP or HTTPS proxy with a file\&. The same format as the \f3-httpproxy\fR option, but the password specified in the file is not visible to other users\&. -.TP --classpath arg -.br -Specifies where to find client application class files used by the \fIjxb:javaType\fR and xjc:\fIsuperClass\fR customization\&. -.TP --catalog file -.br -Specifies catalog files to resolve external entity references\&. Supports the TR9401, XCatalog, and OASIS XML Catalog formats\&. See XML Entity and URI Resolvers at http://xerces\&.apache\&.org/xml-commons/components/resolver/resolver-article\&.html -.TP --readOnly -.br -By default, the XJC binding compiler does not write-protect the Java source files it generates\&. Use this option to force the XJC binding compiler to mark the generated Java sources as read-only\&. -.TP --npa -.br -Suppresses the generation of package level annotations into \f3**/package-info\&.java\fR\&. Using this switch causes the generated code to internalize those annotations into the other generated classes\&. -.TP --no-header -.br -Suppresses the generation of a file header comment that includes some note and time stamp\&. Using this makes the generated code more compatible with the \f3diff\fR command\&. -.TP --target 2\&.0 -.br -Avoids generating code that relies on any JAXB 2\&.1 features\&. This will allow the generated code to run with JAXB 2\&.0 runtime environment (such as Java SE 6)\&. -.TP --xmlschema -.br -Treats input schemas as W3C XML Schema (default)\&. If you do not specify this switch, then your input schemas are treated as though they are W3C XML Schemas\&. -.TP --relaxing -.br -Treats input schemas as RELAX NG (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. -.TP --relaxing-compact -.br -Treat input schemas as RELAX NG compact syntax (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. -.TP --dtd -.br -Treats input schemas as XML DTD (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. -.TP --wsdl -.br -Treats input as WSDL and compiles schemas inside it (experimental and unsupported)\&. -.TP --quiet -.br -Suppress compiler output, such as progress information and warnings\&. -.TP --verbose -.br -Be extra verbose, such as printing informational messages or displaying stack traces upon some errors\&. -.TP --help -.br -Displays a brief summary of the compiler switches\&. -.TP --version -.br -Displays the compiler version information\&. -.TP -\fIschema file/URL/dir\fR -Specifies one or more schema files to compile\&. If you specify a directory, then the \f3xjc\fR command scans it for all schema files and compiles them\&. -.SS NONSTANDARD\ OPTIONS -.TP --XLocator -.br -Causes the generated code to expose SAX Locator information about the source XML in the Java bean instances after unmarshalling\&. -.TP --Xsync-methods -.br -Causes all of the generated method signatures to include the \f3synchronized\fR keyword\&. -.TP --mark-generated -.br -Marks the generated code with the annotation \f3@javax\&.annotation\&.Generated\fR\&. -.TP --episode file -.br -Generates the specified episode file for separate compilation\&. -.SS DEPRECATED\ AND\ REMOVED\ OPTIONS -.TP --host & -port -.br -These options are replaced with the \f3-httpproxy\fR option\&. For backward compatibility, these options are supported, but will not be documented and might be removed from future releases\&. -.TP --use-runtime -.br -Because the JAXB 2\&.0 specification has defined a portable runtime environment, it is no longer necessary for the JAXB RI to generate \f3**/impl/runtime\fRpackages\&. Therefore, this switch is obsolete and was removed\&. -.TP --source -.br -The \f3-source\fR compatibility switch was introduced in the first JAXB 2\&.0 Early Access release\&. This switch is removed from future releases of JAXB 2\&.0\&. If you need to generate 1\&.0\&.x code, then use an installation of the 1\&.0\&.x code base\&. -.SH COMPILER\ RESTRICTIONS -In general, it is safest to compile all related schemas as a single unit with the same binding compiler switches\&. Keep the following list of restrictions in mind when running the \f3xjc\fR command\&. Most of these issues only apply when you compile multiple schemas with multiple invocations of the \f3xjc\fR command\&. -.PP -To compile multiple schemas at the same time, keep the following precedence rules for the target Java package name in mind: -.TP 0.4i -1\&. -The \f3-p\fR option has the highest precedence\&. -.TP 0.4i -2\&. -\fIjaxb:package\fR customization\&. -.TP 0.4i -3\&. -If \f3targetNamespace\fR is declared, then apply the \f3t\fR\f3argetNamespace\fR to the Java package name algorithm defined in the specification\&. -.TP 0.4i -4\&. -If no \f3targetNamespace\fR is declared, then use a hard coded package named \f3generated\fR\&. -.PP -You cannot have more than one \fIjaxb:schemaBindings\fR per name space, so it is impossible to have two schemas in the same target name space compiled into different Java packages\&. -.PP -All schemas being compiled into the same Java package must be submitted to the XJC binding compiler at the same time\&. They cannot be compiled independently and work as expected\&. -.PP -Element substitution groups that are spread across multiple schema files must be compiled at the same time\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -Binding Compiler (xjc) at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/xjc\&.html -.TP 0.2i -\(bu -Java Architecture for XML Binding (JAXB) at http://www\&.oracle\&.com/technetwork/articles/javase/index-140168\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2005, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Web Services Tools +.\" Title: xjc.1 +.\" +.if n .pl 99999 +.TH xjc 1 "21 November 2013" "JDK 8" "Java Web Services Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +xjc \- Compiles an XML schema file into fully annotated Java classes\&. +.SH SYNOPSIS +.sp +.nf + +\fBxjc\fR [ \fIoptions\fR ] \fBschema\fR \fIfile/URL/dir/jar\fR \&.\&.\&. [\fB\-b\fR \fIbindinfo\fR ] \&.\&.\&. +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +schema \fIfile/URL/dir/jar \&.\&.\&.\fR +The location of the XML schema file\&. If \f3dir\fR is specified, then all schema files in it are compiled\&. If \f3jar\fR is specified, then the \f3/META-INF/sun-jaxb\&.episode\fR binding file is compiled\&. +.TP +-b \fIbindinfo\fR +.br +The location of the bindings files\&. +.SH DESCRIPTION +Start the binding compiler with the appropriate \f3xjc\fR shell script in the bin directory for your platform\&. There is also an Ant task to run the binding complier\&. See Using the XJC with Ant at http://jaxb\&.java\&.net/nonav/2\&.1\&.3/docs/xjcTask\&.html +.SH OPTIONS +.TP 0.2i +\(bu +See also Nonstandard Options +.TP 0.2i +\(bu +See also Deprecated and Removed Options +.TP +-nv +.br +By default, the XJC binding compiler performs strict validation of the source schema before processing it\&. Use this option to disable strict schema validation\&. This does not mean that the binding compiler will not perform any validation, but means that it will perform a less-strict validation\&. +.TP +-extension +.br +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 \f3-extension\fR mode enabled by this switch\&. In the default (strict) mode, you are also limited to using only the binding customization defined in the specification\&. By using the \f3-extension\fR switch, you will be allowed to use the JAXB Vendor Extensions\&. +.TP +-b \fIfile\fR +.br +Specifies one or more external binding files to process\&. Each binding file must have its own \f3-b\fR switch\&. The syntax of the external binding files is flexible\&. You can have a single binding file that contains customization for multiple schemas or you can break the customization into multiple bindings files: \f3xjc schema1\&.xsd schema2\&.xsd schema3\&.xsd -b bindings123\&.xjb\fR\f3xjc schema1\&.xsd schema2\&.xsd schema3\&.xsd -b bindings1\&.xjb -b bindings2\&.xjb -b bindings3\&.xjb\fR\&. In addition, the ordering of the schema files and binding files on the command line does not matter\&. +.TP +-d \fIdir\fR +.br +By default, the XJC binding compiler generates 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 does not create it for you\&. +.TP +-p \fIpkg\fR +.br +When you specify a target package with this command-line option, it overrides any binding customization for the package name and the default package name algorithm defined in the specification\&. +.TP +-httpproxy \fIproxy\fR +.br +Specifies the HTTP or HTTPS proxy in the format \fI[user[:password]@]proxyHost[:proxyPort]\fR\&. The old \f3-host\fR and \f3-port\fR options are still supported by the RI for backward compatibility, but they were deprecated\&. The password specified with this option is an argument that is visible to other users who use the top command\&. For greater security, use the \f3-httpproxyfile\fR option\&. +.TP +-httpproxyfile file +.br +Specifies the HTTP or HTTPS proxy with a file\&. The same format as the \f3-httpproxy\fR option, but the password specified in the file is not visible to other users\&. +.TP +-classpath arg +.br +Specifies where to find client application class files used by the \fIjxb:javaType\fR and xjc:\fIsuperClass\fR customization\&. +.TP +-catalog file +.br +Specifies catalog files to resolve external entity references\&. Supports the TR9401, XCatalog, and OASIS XML Catalog formats\&. See XML Entity and URI Resolvers at http://xerces\&.apache\&.org/xml-commons/components/resolver/resolver-article\&.html +.TP +-readOnly +.br +By default, the XJC binding compiler does not write-protect the Java source files it generates\&. Use this option to force the XJC binding compiler to mark the generated Java sources as read-only\&. +.TP +-npa +.br +Suppresses the generation of package level annotations into \f3**/package-info\&.java\fR\&. Using this switch causes the generated code to internalize those annotations into the other generated classes\&. +.TP +-no-header +.br +Suppresses the generation of a file header comment that includes some note and time stamp\&. Using this makes the generated code more compatible with the \f3diff\fR command\&. +.TP +-target 2\&.0 +.br +Avoids generating code that relies on any JAXB 2\&.1 features\&. This will allow the generated code to run with JAXB 2\&.0 runtime environment (such as Java SE 6)\&. +.TP +-xmlschema +.br +Treats input schemas as W3C XML Schema (default)\&. If you do not specify this switch, then your input schemas are treated as though they are W3C XML Schemas\&. +.TP +-relaxing +.br +Treats input schemas as RELAX NG (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. +.TP +-relaxing-compact +.br +Treat input schemas as RELAX NG compact syntax (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. +.TP +-dtd +.br +Treats input schemas as XML DTD (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. +.TP +-wsdl +.br +Treats input as WSDL and compiles schemas inside it (experimental and unsupported)\&. +.TP +-quiet +.br +Suppress compiler output, such as progress information and warnings\&. +.TP +-verbose +.br +Be extra verbose, such as printing informational messages or displaying stack traces upon some errors\&. +.TP +-help +.br +Displays a brief summary of the compiler switches\&. +.TP +-version +.br +Displays the compiler version information\&. +.TP +\fIschema file/URL/dir\fR +Specifies one or more schema files to compile\&. If you specify a directory, then the \f3xjc\fR command scans it for all schema files and compiles them\&. +.SS NONSTANDARD\ OPTIONS +.TP +-XLocator +.br +Causes the generated code to expose SAX Locator information about the source XML in the Java bean instances after unmarshalling\&. +.TP +-Xsync-methods +.br +Causes all of the generated method signatures to include the \f3synchronized\fR keyword\&. +.TP +-mark-generated +.br +Marks the generated code with the annotation \f3@javax\&.annotation\&.Generated\fR\&. +.TP +-episode file +.br +Generates the specified episode file for separate compilation\&. +.SS DEPRECATED\ AND\ REMOVED\ OPTIONS +.TP +-host & -port +.br +These options are replaced with the \f3-httpproxy\fR option\&. For backward compatibility, these options are supported, but will not be documented and might be removed from future releases\&. +.TP +-use-runtime +.br +Because the JAXB 2\&.0 specification has defined a portable runtime environment, it is no longer necessary for the JAXB RI to generate \f3**/impl/runtime\fRpackages\&. Therefore, this switch is obsolete and was removed\&. +.TP +-source +.br +The \f3-source\fR compatibility switch was introduced in the first JAXB 2\&.0 Early Access release\&. This switch is removed from future releases of JAXB 2\&.0\&. If you need to generate 1\&.0\&.x code, then use an installation of the 1\&.0\&.x code base\&. +.SH COMPILER\ RESTRICTIONS +In general, it is safest to compile all related schemas as a single unit with the same binding compiler switches\&. Keep the following list of restrictions in mind when running the \f3xjc\fR command\&. Most of these issues only apply when you compile multiple schemas with multiple invocations of the \f3xjc\fR command\&. +.PP +To compile multiple schemas at the same time, keep the following precedence rules for the target Java package name in mind: +.TP 0.4i +1\&. +The \f3-p\fR option has the highest precedence\&. +.TP 0.4i +2\&. +\fIjaxb:package\fR customization\&. +.TP 0.4i +3\&. +If \f3targetNamespace\fR is declared, then apply the \f3t\fR\f3argetNamespace\fR to the Java package name algorithm defined in the specification\&. +.TP 0.4i +4\&. +If no \f3targetNamespace\fR is declared, then use a hard coded package named \f3generated\fR\&. +.PP +You cannot have more than one \fIjaxb:schemaBindings\fR per name space, so it is impossible to have two schemas in the same target name space compiled into different Java packages\&. +.PP +All schemas being compiled into the same Java package must be submitted to the XJC binding compiler at the same time\&. They cannot be compiled independently and work as expected\&. +.PP +Element substitution groups that are spread across multiple schema files must be compiled at the same time\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +Binding Compiler (xjc) at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/xjc\&.html +.TP 0.2i +\(bu +Java Architecture for XML Binding (JAXB) at http://www\&.oracle\&.com/technetwork/articles/javase/index-140168\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/appletviewer.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/appletviewer.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,89 +1,89 @@ -'\" t -.\" Copyright (c) 1995, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Basic Tools -.\" Title: appletviewer.1 -.\" -.if n .pl 99999 -.TH appletviewer 1 "21 November 2013" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -appletviewer \- Runs applets outside of a web browser\&. -.SH SYNOPSIS -.sp -.nf - -\fBappletviewer\fR [\fIoptions\fR] \fIurl\fR\&.\&.\&. -.fi -.sp -.TP -\fIoptions\fR -The command-line options separated by spaces\&. See Options\&. -.TP -\fIurl\fR -The location of the documents or resources to be displayed\&. You can specify multiple URLs separated by spaces\&. -.SH DESCRIPTION -The \f3appletviewer\fR command connects to the documents or resources designated by \fIurls\fR and displays each applet referenced by the documents in its own window\&. If the documents referred to by urls do not reference any applets with the \f3OBJECT\fR, \f3EMBED\fR, or \f3APPLET\fR tag, then the \f3appletviewer\fR command does nothing\&. For details about the HTML tags that the \f3appletviewer\fR command supports, see AppletViewer Tags at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/appletviewertags\&.html -.PP -The \f3appletviewer\fR command 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\&. -.PP -\fINote:\fR The \f3appletviewer\fR command is intended for development purposes only\&. For more information, see About Sample/Test Applications and Code at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/aboutCodeSamples\&.html -.SH OPTIONS -.TP --debug -.br -Starts the Applet Viewer in the Java debugger with the \f3jdb\fR command to debug the applets in the document\&. -.TP --encoding \fIencoding-name\fR -.br -Specifies the input HTML file encoding name\&. -.TP --J\fIjavaoption\fR -.br -Passes the string \f3javaoption\fR as a single argument to the Java interpreter, which runs the Applet Viewer\&. The argument should not contain spaces\&. Multiple argument words must all begin with the prefix \f3-J\fR\&. This is useful for adjusting the compiler\&'s execution environment or memory usage\&. -.PP -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1995, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: appletviewer.1 +.\" +.if n .pl 99999 +.TH appletviewer 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +appletviewer \- Runs applets outside of a web browser\&. +.SH SYNOPSIS +.sp +.nf + +\fBappletviewer\fR [\fIoptions\fR] \fIurl\fR\&.\&.\&. +.fi +.sp +.TP +\fIoptions\fR +The command-line options separated by spaces\&. See Options\&. +.TP +\fIurl\fR +The location of the documents or resources to be displayed\&. You can specify multiple URLs separated by spaces\&. +.SH DESCRIPTION +The \f3appletviewer\fR command connects to the documents or resources designated by \fIurls\fR and displays each applet referenced by the documents in its own window\&. If the documents referred to by urls do not reference any applets with the \f3OBJECT\fR, \f3EMBED\fR, or \f3APPLET\fR tag, then the \f3appletviewer\fR command does nothing\&. For details about the HTML tags that the \f3appletviewer\fR command supports, see AppletViewer Tags at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/appletviewertags\&.html +.PP +The \f3appletviewer\fR command 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\&. +.PP +\fINote:\fR The \f3appletviewer\fR command is intended for development purposes only\&. For more information, see About Sample/Test Applications and Code at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/aboutCodeSamples\&.html +.SH OPTIONS +.TP +-debug +.br +Starts the Applet Viewer in the Java debugger with the \f3jdb\fR command to debug the applets in the document\&. +.TP +-encoding \fIencoding-name\fR +.br +Specifies the input HTML file encoding name\&. +.TP +-J\fIjavaoption\fR +.br +Passes the string \f3javaoption\fR as a single argument to the Java interpreter, which runs the Applet Viewer\&. The argument should not contain spaces\&. Multiple argument words must all begin with the prefix \f3-J\fR\&. This is useful for adjusting the compiler\&'s execution environment or memory usage\&. +.PP +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/extcheck.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/extcheck.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,90 +1,90 @@ -'\" t -.\" Copyright (c) 1998, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Basic Tools -.\" Title: extcheck.1 -.\" -.if n .pl 99999 -.TH extcheck 1 "21 November 2013" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -extcheck \- Detects version conflicts between a target Java Archive (JAR) file and currently installed extension JAR files\&. -.SH SYNOPSIS -.sp -.nf - -\fBextcheck\fR [\fIoptions\fR] \fItargetfile\&.jar\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fItargetfile\&.jar\fR -The target JAR file against which the currently installed extension JAR files are compared to detect version conflicts\&. -.SH DESCRIPTION -The \f3extcheck\fR command checks a specified JAR file for title and version conflicts with any extensions installed in the Java SE SDK\&. Before installing an extension, you can use this utility to see whether the same or a more recent version of the extension is already installed\&. -.PP -The \f3extcheck\fR command compares the Specification-title and Specification-version headers in the manifest of the \f3targetfile\&.jar\fR file against the corresponding headers in all JAR files currently installed in the extension directory\&. By default, the extension directory is \f3jre/lib/ext\fR on Oracle Solaris and \f3\ejre\elib\eext\fR on Windows\&. The \f3extcheck\fR command compares version numbers in the same way as the \f3java\&.lang\&.Package\&.isCompatibleWith\fR method\&. -.PP -If no conflict is detected, then the return code is 0\&. -.PP -If the manifest of any JAR file in the extensions directory has the same \f3Specification-title\fR and the same or a newer \f3Specification-version\fR number, then a non-zero error code is returned\&. A non-zero error code is also returned when \f3targetfile\&.jar\fR does not have the \f3Specification-title\fR or \f3Specification-version\fR attributes in its manifest file\&. -.SH OPTIONS -.TP --verbose -.br -Lists JAR files in the extension directory as they are checked\&. Additionally, manifest attributes of the target JAR file and any conflicting JAR files are also reported\&. -.TP --J\fIoption\fR -.br -Passes \fIoption\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -jar(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1998, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: extcheck.1 +.\" +.if n .pl 99999 +.TH extcheck 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +extcheck \- Detects version conflicts between a target Java Archive (JAR) file and currently installed extension JAR files\&. +.SH SYNOPSIS +.sp +.nf + +\fBextcheck\fR [\fIoptions\fR] \fItargetfile\&.jar\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fItargetfile\&.jar\fR +The target JAR file against which the currently installed extension JAR files are compared to detect version conflicts\&. +.SH DESCRIPTION +The \f3extcheck\fR command checks a specified JAR file for title and version conflicts with any extensions installed in the Java SE SDK\&. Before installing an extension, you can use this utility to see whether the same or a more recent version of the extension is already installed\&. +.PP +The \f3extcheck\fR command compares the Specification-title and Specification-version headers in the manifest of the \f3targetfile\&.jar\fR file against the corresponding headers in all JAR files currently installed in the extension directory\&. By default, the extension directory is \f3jre/lib/ext\fR on Oracle Solaris and \f3\ejre\elib\eext\fR on Windows\&. The \f3extcheck\fR command compares version numbers in the same way as the \f3java\&.lang\&.Package\&.isCompatibleWith\fR method\&. +.PP +If no conflict is detected, then the return code is 0\&. +.PP +If the manifest of any JAR file in the extensions directory has the same \f3Specification-title\fR and the same or a newer \f3Specification-version\fR number, then a non-zero error code is returned\&. A non-zero error code is also returned when \f3targetfile\&.jar\fR does not have the \f3Specification-title\fR or \f3Specification-version\fR attributes in its manifest file\&. +.SH OPTIONS +.TP +-verbose +.br +Lists JAR files in the extension directory as they are checked\&. Additionally, manifest attributes of the target JAR file and any conflicting JAR files are also reported\&. +.TP +-J\fIoption\fR +.br +Passes \fIoption\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jar(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/idlj.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/idlj.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,567 +1,567 @@ -'\" t -.\" Copyright (c) 2001, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java IDL and RMI-IIOP Tools -.\" Title: idlj.1 -.\" -.if n .pl 99999 -.TH idlj 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -idlj \- Generates Java bindings for a specified Interface Definition Language (IDL) file\&. -.SH SYNOPSIS -.sp -.nf - -\fBidlj\fR [ \fIoptions\fR ] \fIidlfile\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. Options can appear in any order, but must precede the \f3idlfile\fR\&. -.TP -\fIidlfile\fR -The name of a file that contains Interface Definition Language (IDL) definitions\&. -.SH DESCRIPTION -The IDL-to-Java Compiler generates the Java bindings for a specified IDL file\&. For binding details, see Java IDL: IDL to Java Language Mapping at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/mapping/jidlMapping\&.html -.PP -Some earlier releases of the IDL-to-Java compiler were named \f3idltojava\fR\&. -.SS EMIT\ CLIENT\ AND\ SERVER\ BINDINGS -The following \f3idlj\fR command generates an IDL file named \f3My\&.idl\fR with client-side bindings\&. -.sp -.nf -\f3idlj My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -The previous syntax is equivalent to the following: -.sp -.nf -\f3idlj \-fclient My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -The next example generates the server-side bindings, and includes the client-side bindings plus the skeleton, all of which are POA (Inheritance Model)\&. -.sp -.nf -\f3idlg \-fserver My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -If you want to generate both client and server-side bindings, then use one of the following (equivalent) commands: -.sp -.nf -\f3idlj \-fclient \-fserver My\&.idl\fP -.fi -.nf -\f3idlj \-fall My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -There are two possible server-side models: the Portal Servant Inheritance Model and the Tie Model\&. See Tie Delegation Model\&. -.PP -\f3Portable Servant Inheritance Model\fR\&. The default server-side model is the Portable Servant Inheritance Model\&. Given an interface \f3My\fR defined in \f3My\&.idl\fR, the file \f3MyPOA\&.java\fR is generated\&. You must provide the implementation for the \f3My\fR interface, and the \f3My\fR interface must inherit from the \f3MyPOA\fR class\&. \f3MyPOA\&.java\fR is a stream-based skeleton that extends the \f3org\&.omg\&.PortableServer\&.Servant\fR class at http://docs\&.oracle\&.com/javase/8/docs/api/org/omg/PortableServer/Servant\&.html The \f3My\fR interface implements the \f3callHandler\fR interface and the operations interface associated with the IDL interface the skeleton implements\&.The \f3PortableServer\fR module for the Portable Object Adapter (POA) defines the native \f3Servant\fR type\&. See Portable Object Adapter (POA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/POA\&.html In the Java programming language, the \f3Servant\fR type is mapped to the Java \f3org\&.omg\&.PortableServer\&.Servant\fR class\&. It serves as the base class for all POA servant implementations and provides a number of methods that can be called by the application programmer, and methods that are called by the POA and that can be overridden by the user to control aspects of servant behavior\&.Another option for the Inheritance Model is to use the \f3-oldImplBase\fR flag to generate server-side bindings that are compatible with releases of the Java programming language before Java SE 1\&.4\&. The -\f3oldImplBase\fR flag is nonstandard, and these APIs are deprecated\&. You would use this flag only for compatibility with existing servers written in Java SE 1\&.3\&. In that case, you would need to modify an existing make file to add the \f3-oldImplBase\fR flag to the \f3idlj\fR compiler\&. Otherwise POA-based server-side mappings are generated\&. To generate server-side bindings that are backward compatible, do the following: -.sp -.nf -\f3idlj \-fclient \-fserver \-oldImplBase My\&.idl\fP -.fi -.nf -\f3idlj \-fall \-oldImplBase My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -Given an interface \f3My\fR defined in \f3My\&.idl\fR, the file \f3_MyImplBase\&.java\fR is generated\&. You must provide the implementation for the \f3My\fR interface, and the \f3My\fR interface must inherit from the \f3_MyImplBase\fR class\&. -.PP -\f3Tie Delegation Model\fR\&. 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: -.sp -.nf -\f3idlj \-fall My\&.idl\fP -.fi -.nf -\f3idlj \-fallTIE My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -For the \f3My\fR interface, the second command generates \f3MyPOATie\&.java\fR\&. The constructor to the \f3MyPOATie\fR class takes a delegate\&. In this example, using the default POA model, the constructor also needs a POA\&. You must provide the implementation for the delegate, but it does not have to inherit from any other class, only the interface \f3MyOperations\fR\&. To use it with the ORB, you must wrap your implementation within the \f3MyPOATie\fR class, for example: -.sp -.nf -\f3ORB orb = ORB\&.init(args, System\&.getProperties());\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3// Get reference to rootpoa & activate the POAManager\fP -.fi -.nf -\f3POA rootpoa = (POA)orb\&.resolve_initial_references("RootPOA");\fP -.fi -.nf -\f3rootpoa\&.the_POAManager()\&.activate();\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3// create servant and register it with the ORB\fP -.fi -.nf -\f3MyServant myDelegate = new MyServant();\fP -.fi -.nf -\f3myDelegate\&.setORB(orb); \fP -.fi -.nf -\f3\fR -.fi -.nf -\f3// create a tie, with servant being the delegate\&.\fP -.fi -.nf -\f3MyPOATie tie = new MyPOATie(myDelegate, rootpoa);\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3// obtain the objectRef for the tie\fP -.fi -.nf -\f3My ref = tie\&._this(orb);\fP -.fi -.nf -\f3\fR -.fi -.sp -You might want to use the Tie model instead of the typical Inheritance model when 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, then that slot is used up\&. With 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 a method is called\&. -.PP -For server-side generation, Tie model bindings that are compatible with versions of the IDL to Java language mapping in versions earlier than Java SE 1\&.4\&. -.sp -.nf -\f3idlj \-oldImplBase \-fall My\&.idl\fP -.fi -.nf -\f3idlj \-oldImplBase \-fallTIE My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -For the \f3My\fR interface, the this generates \f3My_Tie\&.java\fR\&. The constructor to the \f3My_Tie\fR class takes an \f3impl\fR object\&. You must provide the implementation for \f3impl\fR, but it does not have to inherit from any other class, only the interface \f3HelloOperations\fR\&. But to use it with the ORB, you must wrap your implementation within \f3My_Tie\fR, for example: -.sp -.nf -\f3ORB orb = ORB\&.init(args, System\&.getProperties());\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3// create servant and register it with the ORB\fP -.fi -.nf -\f3MyServant myDelegate = new MyServant();\fP -.fi -.nf -\f3myDelegate\&.setORB(orb); \fP -.fi -.nf -\f3\fR -.fi -.nf -\f3// create a tie, with servant being the delegate\&.\fP -.fi -.nf -\f3MyPOATie tie = new MyPOATie(myDelegate);\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3// obtain the objectRef for the tie\fP -.fi -.nf -\f3My ref = tie\&._this(orb);\fP -.fi -.nf -\f3\fR -.fi -.sp -.SS SPECIFY\ ALTERNATE\ LOCATIONS\ FOR\ EMITTED\ FILES -If you want to direct the emitted files to a directory other than the current directory, then call the compiler this way: \f3i\fR\f3dlj -td /altdir My\&.idl\fR\&. -.PP -For the \f3My\fR interface, the bindings are emitted to \f3/altdir/My\&.java\fR, etc\&., instead of \f3\&./My\&.java\fR\&. -.SS SPECIFY\ ALTERNATE\ LOCATIONS\ FOR\ INCLUDE\ FILES -If the \f3My\&.idl\fR file includes another \f3idl\fR file, \f3MyOther\&.idl\fR, then the compiler assumes that the \f3MyOther\&.idl\fR file resides in the local directory\&. If it resides in \f3/includes\fR, for example, then you call the compiler with the following command: -.sp -.nf -\f3idlj \-i /includes My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -If \f3My\&.idl\fR also included \f3Another\&.idl\fR that resided in \f3/moreIncludes\fR, for example, then you call the compiler with the following command: -.sp -.nf -\f3idlj \-i /includes \-i /moreIncludes My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -Because this form of \f3include\fR can become long, another way to indicate 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 idl\&.config in a directory that is listed in your \f3CLASSPATH\fR variable\&. Inside of \f3idl\&.config\fR, provide a line with the following form: -.sp -.nf -\f3includes=/includes;/moreIncludes\fP -.fi -.nf -\f3\fR -.fi -.sp -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, and so on\&. -.SS EMIT\ BINDINGS\ FOR\ INCLUDE\ FILES -By default, only those interfaces, structures, and so on, that are defined in the \f3idl\fR 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 \f3idl\fR files: -.sp -.nf -\f3My\&.idl file:\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3#include <MyOther\&.idl>\fP -.fi -.nf -\f3interface My\fP -.fi -.nf -\f3{\fP -.fi -.nf -\f3};\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3MyOther\&.idl file:\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3interface MyOther\fP -.fi -.nf -\f3{\fP -.fi -.nf -\f3};\fP -.fi -.nf -\f3\fR -.fi -.sp -There is a caveat to the default rule\&. Any \f3#include\fR statements that appear at the global scope are treated as described\&. These \f3#include\fR statements can be thought of as import statements\&. The \f3#include\fR statements that appear within an enclosed scope are treated as true \f3#include\fR statements, which means that the code within the included file is treated as though it appeared in the original file and, therefore, Java bindings are emitted for it\&. Here is an example: -.sp -.nf -\f3My\&.idl file:\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3#include <MyOther\&.idl>\fP -.fi -.nf -\f3interface My\fP -.fi -.nf -\f3{\fP -.fi -.nf -\f3 #include <Embedded\&.idl>\fP -.fi -.nf -\f3};\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3MyOther\&.idl file:\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3interface MyOther\fP -.fi -.nf -\f3{\fP -.fi -.nf -\f3};\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3Embedded\&.idl\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3enum E {one, two, three};\fP -.fi -.nf -\f3\fR -.fi -.sp -Run\f3idlj My\&.idl\fRto generate the following list of Java files\&. Notice that \f3MyOther\&.java\fR is not generated because it is defined in an import-like \f3#include\fR\&. But \f3E\&.java\fR was generated because it was defined in a true \f3#include\fR\&. Notice that because the \f3Embedded\&.idl\fR file is included within the scope of the interface \f3My\fR, it appears within the scope of \f3My\fR (in \f3MyPackage\fR)\&. If the \f3-emitAll\fR flag had been used, then all types in all included files would have been emitted\&. -.sp -.nf -\f3\&./MyHolder\&.java\fP -.fi -.nf -\f3\&./MyHelper\&.java\fP -.fi -.nf -\f3\&./_MyStub\&.java\fP -.fi -.nf -\f3\&./MyPackage\fP -.fi -.nf -\f3\&./MyPackage/EHolder\&.java\fP -.fi -.nf -\f3\&./MyPackage/EHelper\&.java\fP -.fi -.nf -\f3\&./MyPackage/E\&.java\fP -.fi -.nf -\f3\&./My\&.java\fP -.fi -.nf -\f3\fR -.fi -.sp -.SS INSERT\ PACKAGE\ PREFIXES -Suppose that you work for a company named ABC that has constructed the following IDL file: -.sp -.nf -\f3Widgets\&.idl file:\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3module Widgets\fP -.fi -.nf -\f3{\fP -.fi -.nf -\f3 interface W1 {\&.\&.\&.};\fP -.fi -.nf -\f3 interface W2 {\&.\&.\&.};\fP -.fi -.nf -\f3};\fP -.fi -.nf -\f3\fR -.fi -.sp -If you run this file through the IDL-to-Java compiler, then the Java bindings for W1 and W2 are placed within the \f3Widgets\fR package\&. There is an industry convention that states that a company\&'s packages should reside within a package named \f3com\&.<company name>\fR\&. To follow this convention, the package name should be \f3com\&.abc\&.Widgets\fR\&. To place this package prefix onto the Widgets module, execute the following: -.sp -.nf -\f3idlj \-pkgPrefix Widgets com\&.abc Widgets\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -If you have an IDL file that includes Widgets\&.idl, then the \f3-pkgPrefix\fR flag must appear in that command also\&. If it does not, then your IDL file will be looking for a \f3Widgets\fR package rather than a \f3com\&.abc\&.Widgets\fR package\&. -.PP -If you have a number of these packages that require prefixes, then it might be easier to place them into the idl\&.config file described previously\&. Each package prefix line should be of the form: \f3PkgPrefix\&.<type>=<prefix>\fR\&. The line for the previous example would be \f3PkgPrefix\&.Widgets=com\&.abc\fR\&. This option does not affect the Repository ID\&. -.SS DEFINE\ SYMBOLS\ BEFORE\ COMPILATION -You might 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 \f3idlj -d MYDEF My\&.idl\fRis equivalent to putting the line \f3#define MYDEF\fR inside My\&.idl\&. -.SS PRESERVE\ PREEXISTING\ BINDINGS -If the Java binding files already exist, then the \f3-keep\fR flag keeps the compiler from overwriting them\&. The default is to generate all files without considering that they already exist\&. If you have customized those files (which you should not do unless you are very comfortable with their contents), then the \f3-keep\fR option is very useful\&. The command \f3idlj -keep My\&.idl\fR emits all client-side bindings that do not already exist\&. -.SS VIEW\ COMPILATION\ PROGRESS -The IDL-to-Java compiler generates status messages as it progresses through its phases of execution\&. Use the \f3-v\fR option to activate the verbose mode: \f3idlj -v My\&.idl\fR\&. -.PP -By default the compiler does not operate in verbose mode -.SS DISPLAY\ VERSION\ INFORMATION -To display the build version of the IDL-to-Java compiler, specify the \f3-version\fR option on the command-line: \f3idlj -version\fR\&. -.PP -Version information also appears within the bindings generated by the compiler\&. Any additional options appearing on the command-line are ignored\&. -.SH OPTIONS -.TP --d \fIsymbol\fR -.br -This is equivalent to the following line in an IDL file: -.sp -.nf -\f3#define \fIsymbol\fR\fP -.fi -.nf -\f3\fR -.fi -.sp - -.TP --demitAll -.br -Emit all types, including those found in \f3#include\fR files\&. -.TP --fside -.br -Defines what bindings to emit\&. The \f3side\fR parameter can be \f3client\fR, \f3server\fR, \f3serverTIE\fR, \f3all\fR, or \f3allTIE\fR\&. The \f3-fserverTIE\fR and \f3-fallTIE\fR options cause delegate model skeletons to be emitted\&. Defaults to \f3-fclient\fR when the flag is not specified\&. -.TP --i \fIinclude-path\fR -.br -By default, the current directory is scanned for included files\&. This option adds another directory\&. -.TP --i \fIkeep\fR -.br -If a file to be generated already exists, then do not overwrite it\&. By default it is overwritten\&. -.TP --noWarn -.br -Suppress warning messages\&. -.TP --oldImplBase -.br -Generates skeletons compatible with pre-1\&.4 JDK ORBs\&. By default, the POA Inheritance Model server-side bindings are generated\&. This option provides backward-compatibility with earlier releases of the Java programming language by generating server-side bindings that are \f3ImplBase\fR Inheritance Model classes\&. -.TP --pkgPrefix \fItype\fR\fIprefix\fR -.br -Wherever \f3type\fR is encountered at file scope, prefix the generated Java package name with \f3prefix\fR for all files generated for that type\&. The type is the simple name of either a top-level module, or an IDL type defined outside of any module\&. -.TP --pkgTranslate \fItype\fR\fIpackage\fR -.br -Whenever the module name type is encountered in an identifier, replace it in the identifier with package for all files in the generated Java package\&. Note that \f3pkgPrefix\fR changes are made first\&. The type value 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\&. - -If more than one translation matches an identifier, then the longest match is chosen as shown in the following example: - -\fICommand\fR: -.sp -.nf -\f3pkgTranslate type pkg \-pkgTranslate type2\&.baz pkg2\&.fizz\fP -.fi -.nf -\f3\fR -.fi -.sp - - -\fIResulting Translation\fR: -.sp -.nf -\f3type => pkg\fP -.fi -.nf -\f3type\&.ext => pkg\&.ext\fP -.fi -.nf -\f3type\&.baz => pkg2\&.fizz\fP -.fi -.nf -\f3type2\&.baz\&.pkg => pkg2\&.fizz\&.pkg\fP -.fi -.nf -\f3\fR -.fi -.sp - - -The following package names \f3org\fR, \f3org\fR\&.o\f3mg\fR, or any subpackages of \f3org\&.omg\fR cannot be translated\&. Any attempt to translate these packages results in uncompilable code, and the use of these packages as the first argument after \f3-pkgTranslate\fR is treated as an error\&. -.TP --skeletonName \fIxxx%yyy\fR -.br -Use \f3xxx%yyy\fR as the pattern for naming the skeleton\&. The defaults are: \f3%POA\fR for the \f3POA\fR base class (\f3-fserver\fR or \f3-fall\fR), and \f3_%ImplBase\fR for the \f3oldImplBase\fR class (-\f3oldImplBase\fR) and (\f3-fserver\fR or \f3-fall\fR))\&. -.TP --td \fIdir\fR -.br -Use \fIdir\fR for the output directory instead of the current directory\&. -.TP --tieName \fIxxx%yyy\fR -.br -Use \f3xxx%yyy\fR according to the pattern\&. The defaults are: \f3%POA\fR for the \f3POA\fR base class (\f3-fserverTie or -fallTie\fR), and \f3_%Tie\fR for the \f3oldImplBase\fR tie class (-\f3oldImplBase\fR) and (\f3-fserverTie\fR or \f3-fallTie\fR)) -.TP --nowarn, -verbose -.br -Displays release information and terminates\&. -.TP --version -.br -Displays release information and terminates\&. -.SH RESTRICTIONS -Escaped identifiers in the global scope cannot have the same spelling as IDL primitive types, \f3Object\fR, or \f3ValueBase\fR\&. This is because the symbol table is preloaded with these identifiers\&. Allowing them to be redefined would overwrite their original definitions\&. Possible permanent restriction\&. -.PP -The \f3fixed\fR IDL type is not supported\&. -.SH KNOWN\ PROBLEMS -No import is generated for global identifiers\&. If you call an unexported local \f3impl\fR object, then you do get an exception, but it seems to be due to a \f3NullPointerException\fR in the \f3ServerDelegate\fR DSI code\&. -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2001, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java IDL and RMI-IIOP Tools +.\" Title: idlj.1 +.\" +.if n .pl 99999 +.TH idlj 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +idlj \- Generates Java bindings for a specified Interface Definition Language (IDL) file\&. +.SH SYNOPSIS +.sp +.nf + +\fBidlj\fR [ \fIoptions\fR ] \fIidlfile\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. Options can appear in any order, but must precede the \f3idlfile\fR\&. +.TP +\fIidlfile\fR +The name of a file that contains Interface Definition Language (IDL) definitions\&. +.SH DESCRIPTION +The IDL-to-Java Compiler generates the Java bindings for a specified IDL file\&. For binding details, see Java IDL: IDL to Java Language Mapping at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/mapping/jidlMapping\&.html +.PP +Some earlier releases of the IDL-to-Java compiler were named \f3idltojava\fR\&. +.SS EMIT\ CLIENT\ AND\ SERVER\ BINDINGS +The following \f3idlj\fR command generates an IDL file named \f3My\&.idl\fR with client-side bindings\&. +.sp +.nf +\f3idlj My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +The previous syntax is equivalent to the following: +.sp +.nf +\f3idlj \-fclient My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +The next example generates the server-side bindings, and includes the client-side bindings plus the skeleton, all of which are POA (Inheritance Model)\&. +.sp +.nf +\f3idlg \-fserver My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +If you want to generate both client and server-side bindings, then use one of the following (equivalent) commands: +.sp +.nf +\f3idlj \-fclient \-fserver My\&.idl\fP +.fi +.nf +\f3idlj \-fall My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +There are two possible server-side models: the Portal Servant Inheritance Model and the Tie Model\&. See Tie Delegation Model\&. +.PP +\f3Portable Servant Inheritance Model\fR\&. The default server-side model is the Portable Servant Inheritance Model\&. Given an interface \f3My\fR defined in \f3My\&.idl\fR, the file \f3MyPOA\&.java\fR is generated\&. You must provide the implementation for the \f3My\fR interface, and the \f3My\fR interface must inherit from the \f3MyPOA\fR class\&. \f3MyPOA\&.java\fR is a stream-based skeleton that extends the \f3org\&.omg\&.PortableServer\&.Servant\fR class at http://docs\&.oracle\&.com/javase/8/docs/api/org/omg/PortableServer/Servant\&.html The \f3My\fR interface implements the \f3callHandler\fR interface and the operations interface associated with the IDL interface the skeleton implements\&.The \f3PortableServer\fR module for the Portable Object Adapter (POA) defines the native \f3Servant\fR type\&. See Portable Object Adapter (POA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/POA\&.html In the Java programming language, the \f3Servant\fR type is mapped to the Java \f3org\&.omg\&.PortableServer\&.Servant\fR class\&. It serves as the base class for all POA servant implementations and provides a number of methods that can be called by the application programmer, and methods that are called by the POA and that can be overridden by the user to control aspects of servant behavior\&.Another option for the Inheritance Model is to use the \f3-oldImplBase\fR flag to generate server-side bindings that are compatible with releases of the Java programming language before Java SE 1\&.4\&. The -\f3oldImplBase\fR flag is nonstandard, and these APIs are deprecated\&. You would use this flag only for compatibility with existing servers written in Java SE 1\&.3\&. In that case, you would need to modify an existing make file to add the \f3-oldImplBase\fR flag to the \f3idlj\fR compiler\&. Otherwise POA-based server-side mappings are generated\&. To generate server-side bindings that are backward compatible, do the following: +.sp +.nf +\f3idlj \-fclient \-fserver \-oldImplBase My\&.idl\fP +.fi +.nf +\f3idlj \-fall \-oldImplBase My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +Given an interface \f3My\fR defined in \f3My\&.idl\fR, the file \f3_MyImplBase\&.java\fR is generated\&. You must provide the implementation for the \f3My\fR interface, and the \f3My\fR interface must inherit from the \f3_MyImplBase\fR class\&. +.PP +\f3Tie Delegation Model\fR\&. 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: +.sp +.nf +\f3idlj \-fall My\&.idl\fP +.fi +.nf +\f3idlj \-fallTIE My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +For the \f3My\fR interface, the second command generates \f3MyPOATie\&.java\fR\&. The constructor to the \f3MyPOATie\fR class takes a delegate\&. In this example, using the default POA model, the constructor also needs a POA\&. You must provide the implementation for the delegate, but it does not have to inherit from any other class, only the interface \f3MyOperations\fR\&. To use it with the ORB, you must wrap your implementation within the \f3MyPOATie\fR class, for example: +.sp +.nf +\f3ORB orb = ORB\&.init(args, System\&.getProperties());\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// Get reference to rootpoa & activate the POAManager\fP +.fi +.nf +\f3POA rootpoa = (POA)orb\&.resolve_initial_references("RootPOA");\fP +.fi +.nf +\f3rootpoa\&.the_POAManager()\&.activate();\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// create servant and register it with the ORB\fP +.fi +.nf +\f3MyServant myDelegate = new MyServant();\fP +.fi +.nf +\f3myDelegate\&.setORB(orb); \fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// create a tie, with servant being the delegate\&.\fP +.fi +.nf +\f3MyPOATie tie = new MyPOATie(myDelegate, rootpoa);\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// obtain the objectRef for the tie\fP +.fi +.nf +\f3My ref = tie\&._this(orb);\fP +.fi +.nf +\f3\fR +.fi +.sp +You might want to use the Tie model instead of the typical Inheritance model when 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, then that slot is used up\&. With 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 a method is called\&. +.PP +For server-side generation, Tie model bindings that are compatible with versions of the IDL to Java language mapping in versions earlier than Java SE 1\&.4\&. +.sp +.nf +\f3idlj \-oldImplBase \-fall My\&.idl\fP +.fi +.nf +\f3idlj \-oldImplBase \-fallTIE My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +For the \f3My\fR interface, the this generates \f3My_Tie\&.java\fR\&. The constructor to the \f3My_Tie\fR class takes an \f3impl\fR object\&. You must provide the implementation for \f3impl\fR, but it does not have to inherit from any other class, only the interface \f3HelloOperations\fR\&. But to use it with the ORB, you must wrap your implementation within \f3My_Tie\fR, for example: +.sp +.nf +\f3ORB orb = ORB\&.init(args, System\&.getProperties());\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// create servant and register it with the ORB\fP +.fi +.nf +\f3MyServant myDelegate = new MyServant();\fP +.fi +.nf +\f3myDelegate\&.setORB(orb); \fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// create a tie, with servant being the delegate\&.\fP +.fi +.nf +\f3MyPOATie tie = new MyPOATie(myDelegate);\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// obtain the objectRef for the tie\fP +.fi +.nf +\f3My ref = tie\&._this(orb);\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS SPECIFY\ ALTERNATE\ LOCATIONS\ FOR\ EMITTED\ FILES +If you want to direct the emitted files to a directory other than the current directory, then call the compiler this way: \f3i\fR\f3dlj -td /altdir My\&.idl\fR\&. +.PP +For the \f3My\fR interface, the bindings are emitted to \f3/altdir/My\&.java\fR, etc\&., instead of \f3\&./My\&.java\fR\&. +.SS SPECIFY\ ALTERNATE\ LOCATIONS\ FOR\ INCLUDE\ FILES +If the \f3My\&.idl\fR file includes another \f3idl\fR file, \f3MyOther\&.idl\fR, then the compiler assumes that the \f3MyOther\&.idl\fR file resides in the local directory\&. If it resides in \f3/includes\fR, for example, then you call the compiler with the following command: +.sp +.nf +\f3idlj \-i /includes My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +If \f3My\&.idl\fR also included \f3Another\&.idl\fR that resided in \f3/moreIncludes\fR, for example, then you call the compiler with the following command: +.sp +.nf +\f3idlj \-i /includes \-i /moreIncludes My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +Because this form of \f3include\fR can become long, another way to indicate 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 idl\&.config in a directory that is listed in your \f3CLASSPATH\fR variable\&. Inside of \f3idl\&.config\fR, provide a line with the following form: +.sp +.nf +\f3includes=/includes;/moreIncludes\fP +.fi +.nf +\f3\fR +.fi +.sp +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, and so on\&. +.SS EMIT\ BINDINGS\ FOR\ INCLUDE\ FILES +By default, only those interfaces, structures, and so on, that are defined in the \f3idl\fR 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 \f3idl\fR files: +.sp +.nf +\f3My\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3#include <MyOther\&.idl>\fP +.fi +.nf +\f3interface My\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3MyOther\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3interface MyOther\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.sp +There is a caveat to the default rule\&. Any \f3#include\fR statements that appear at the global scope are treated as described\&. These \f3#include\fR statements can be thought of as import statements\&. The \f3#include\fR statements that appear within an enclosed scope are treated as true \f3#include\fR statements, which means that the code within the included file is treated as though it appeared in the original file and, therefore, Java bindings are emitted for it\&. Here is an example: +.sp +.nf +\f3My\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3#include <MyOther\&.idl>\fP +.fi +.nf +\f3interface My\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3 #include <Embedded\&.idl>\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3MyOther\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3interface MyOther\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3Embedded\&.idl\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3enum E {one, two, three};\fP +.fi +.nf +\f3\fR +.fi +.sp +Run\f3idlj My\&.idl\fRto generate the following list of Java files\&. Notice that \f3MyOther\&.java\fR is not generated because it is defined in an import-like \f3#include\fR\&. But \f3E\&.java\fR was generated because it was defined in a true \f3#include\fR\&. Notice that because the \f3Embedded\&.idl\fR file is included within the scope of the interface \f3My\fR, it appears within the scope of \f3My\fR (in \f3MyPackage\fR)\&. If the \f3-emitAll\fR flag had been used, then all types in all included files would have been emitted\&. +.sp +.nf +\f3\&./MyHolder\&.java\fP +.fi +.nf +\f3\&./MyHelper\&.java\fP +.fi +.nf +\f3\&./_MyStub\&.java\fP +.fi +.nf +\f3\&./MyPackage\fP +.fi +.nf +\f3\&./MyPackage/EHolder\&.java\fP +.fi +.nf +\f3\&./MyPackage/EHelper\&.java\fP +.fi +.nf +\f3\&./MyPackage/E\&.java\fP +.fi +.nf +\f3\&./My\&.java\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS INSERT\ PACKAGE\ PREFIXES +Suppose that you work for a company named ABC that has constructed the following IDL file: +.sp +.nf +\f3Widgets\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3module Widgets\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3 interface W1 {\&.\&.\&.};\fP +.fi +.nf +\f3 interface W2 {\&.\&.\&.};\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.sp +If you run this file through the IDL-to-Java compiler, then the Java bindings for W1 and W2 are placed within the \f3Widgets\fR package\&. There is an industry convention that states that a company\&'s packages should reside within a package named \f3com\&.<company name>\fR\&. To follow this convention, the package name should be \f3com\&.abc\&.Widgets\fR\&. To place this package prefix onto the Widgets module, execute the following: +.sp +.nf +\f3idlj \-pkgPrefix Widgets com\&.abc Widgets\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +If you have an IDL file that includes Widgets\&.idl, then the \f3-pkgPrefix\fR flag must appear in that command also\&. If it does not, then your IDL file will be looking for a \f3Widgets\fR package rather than a \f3com\&.abc\&.Widgets\fR package\&. +.PP +If you have a number of these packages that require prefixes, then it might be easier to place them into the idl\&.config file described previously\&. Each package prefix line should be of the form: \f3PkgPrefix\&.<type>=<prefix>\fR\&. The line for the previous example would be \f3PkgPrefix\&.Widgets=com\&.abc\fR\&. This option does not affect the Repository ID\&. +.SS DEFINE\ SYMBOLS\ BEFORE\ COMPILATION +You might 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 \f3idlj -d MYDEF My\&.idl\fRis equivalent to putting the line \f3#define MYDEF\fR inside My\&.idl\&. +.SS PRESERVE\ PREEXISTING\ BINDINGS +If the Java binding files already exist, then the \f3-keep\fR flag keeps the compiler from overwriting them\&. The default is to generate all files without considering that they already exist\&. If you have customized those files (which you should not do unless you are very comfortable with their contents), then the \f3-keep\fR option is very useful\&. The command \f3idlj -keep My\&.idl\fR emits all client-side bindings that do not already exist\&. +.SS VIEW\ COMPILATION\ PROGRESS +The IDL-to-Java compiler generates status messages as it progresses through its phases of execution\&. Use the \f3-v\fR option to activate the verbose mode: \f3idlj -v My\&.idl\fR\&. +.PP +By default the compiler does not operate in verbose mode +.SS DISPLAY\ VERSION\ INFORMATION +To display the build version of the IDL-to-Java compiler, specify the \f3-version\fR option on the command-line: \f3idlj -version\fR\&. +.PP +Version information also appears within the bindings generated by the compiler\&. Any additional options appearing on the command-line are ignored\&. +.SH OPTIONS +.TP +-d \fIsymbol\fR +.br +This is equivalent to the following line in an IDL file: +.sp +.nf +\f3#define \fIsymbol\fR\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-demitAll +.br +Emit all types, including those found in \f3#include\fR files\&. +.TP +-fside +.br +Defines what bindings to emit\&. The \f3side\fR parameter can be \f3client\fR, \f3server\fR, \f3serverTIE\fR, \f3all\fR, or \f3allTIE\fR\&. The \f3-fserverTIE\fR and \f3-fallTIE\fR options cause delegate model skeletons to be emitted\&. Defaults to \f3-fclient\fR when the flag is not specified\&. +.TP +-i \fIinclude-path\fR +.br +By default, the current directory is scanned for included files\&. This option adds another directory\&. +.TP +-i \fIkeep\fR +.br +If a file to be generated already exists, then do not overwrite it\&. By default it is overwritten\&. +.TP +-noWarn +.br +Suppress warning messages\&. +.TP +-oldImplBase +.br +Generates skeletons compatible with pre-1\&.4 JDK ORBs\&. By default, the POA Inheritance Model server-side bindings are generated\&. This option provides backward-compatibility with earlier releases of the Java programming language by generating server-side bindings that are \f3ImplBase\fR Inheritance Model classes\&. +.TP +-pkgPrefix \fItype\fR\fIprefix\fR +.br +Wherever \f3type\fR is encountered at file scope, prefix the generated Java package name with \f3prefix\fR for all files generated for that type\&. The type is the simple name of either a top-level module, or an IDL type defined outside of any module\&. +.TP +-pkgTranslate \fItype\fR\fIpackage\fR +.br +Whenever the module name type is encountered in an identifier, replace it in the identifier with package for all files in the generated Java package\&. Note that \f3pkgPrefix\fR changes are made first\&. The type value 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\&. + +If more than one translation matches an identifier, then the longest match is chosen as shown in the following example: + +\fICommand\fR: +.sp +.nf +\f3pkgTranslate type pkg \-pkgTranslate type2\&.baz pkg2\&.fizz\fP +.fi +.nf +\f3\fR +.fi +.sp + + +\fIResulting Translation\fR: +.sp +.nf +\f3type => pkg\fP +.fi +.nf +\f3type\&.ext => pkg\&.ext\fP +.fi +.nf +\f3type\&.baz => pkg2\&.fizz\fP +.fi +.nf +\f3type2\&.baz\&.pkg => pkg2\&.fizz\&.pkg\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The following package names \f3org\fR, \f3org\fR\&.o\f3mg\fR, or any subpackages of \f3org\&.omg\fR cannot be translated\&. Any attempt to translate these packages results in uncompilable code, and the use of these packages as the first argument after \f3-pkgTranslate\fR is treated as an error\&. +.TP +-skeletonName \fIxxx%yyy\fR +.br +Use \f3xxx%yyy\fR as the pattern for naming the skeleton\&. The defaults are: \f3%POA\fR for the \f3POA\fR base class (\f3-fserver\fR or \f3-fall\fR), and \f3_%ImplBase\fR for the \f3oldImplBase\fR class (-\f3oldImplBase\fR) and (\f3-fserver\fR or \f3-fall\fR))\&. +.TP +-td \fIdir\fR +.br +Use \fIdir\fR for the output directory instead of the current directory\&. +.TP +-tieName \fIxxx%yyy\fR +.br +Use \f3xxx%yyy\fR according to the pattern\&. The defaults are: \f3%POA\fR for the \f3POA\fR base class (\f3-fserverTie or -fallTie\fR), and \f3_%Tie\fR for the \f3oldImplBase\fR tie class (-\f3oldImplBase\fR) and (\f3-fserverTie\fR or \f3-fallTie\fR)) +.TP +-nowarn, -verbose +.br +Displays release information and terminates\&. +.TP +-version +.br +Displays release information and terminates\&. +.SH RESTRICTIONS +Escaped identifiers in the global scope cannot have the same spelling as IDL primitive types, \f3Object\fR, or \f3ValueBase\fR\&. This is because the symbol table is preloaded with these identifiers\&. Allowing them to be redefined would overwrite their original definitions\&. Possible permanent restriction\&. +.PP +The \f3fixed\fR IDL type is not supported\&. +.SH KNOWN\ PROBLEMS +No import is generated for global identifiers\&. If you call an unexported local \f3impl\fR object, then you do get an exception, but it seems to be due to a \f3NullPointerException\fR in the \f3ServerDelegate\fR DSI code\&. +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/ja/appletviewer.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/appletviewer.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/extcheck.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/extcheck.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/idlj.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/idlj.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/jar.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/jar.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/jarsigner.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/jarsigner.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/java.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/java.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/javac.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/javac.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/javadoc.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/javadoc.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/javah.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/javah.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/javap.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/javap.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/javaws.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/javaws.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/jcmd.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/jcmd.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/jconsole.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/jconsole.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/jdb.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/jdb.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/jdeps.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/jdeps.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/jhat.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/jhat.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/jinfo.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/jinfo.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/jjs.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/jjs.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/jmap.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/jmap.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/jps.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/jps.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/jrunscript.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/jrunscript.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/jsadebugd.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/jsadebugd.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/jstack.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/jstack.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/jstat.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/jstat.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/jstatd.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/jstatd.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/jvisualvm.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/jvisualvm.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/keytool.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/keytool.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/native2ascii.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/native2ascii.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/orbd.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/orbd.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/pack200.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/pack200.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/policytool.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/policytool.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/rmic.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/rmic.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/rmid.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/rmid.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/rmiregistry.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/rmiregistry.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/schemagen.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/schemagen.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/serialver.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/serialver.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/servertool.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/servertool.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/tnameserv.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/tnameserv.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/unpack200.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/unpack200.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/wsgen.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/wsgen.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/wsimport.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/wsimport.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/ja/xjc.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/ja/xjc.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/jar.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/jar.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,484 +1,484 @@ -'\" t -.\" Copyright (c) 1997, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Basic Tools -.\" Title: jar.1 -.\" -.if n .pl 99999 -.TH jar 1 "21 November 2013" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jar \- Manipulates Java Archive (JAR) files\&. -.SH SYNOPSIS -Create JAR file -.sp -.nf - -\fBjar c\fR[\fBefmMnv0\fR] [\fIentrypoint\fR] [\fIjarfile\fR] [\fImanifest\fR] [\fB\-C\fR \fIdir\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] -.fi -.sp - -Update JAR file -.sp -.nf - -\fBjar u\fR[\fBefmMnv0\fR] [\fIentrypoint\fR] [\fIjarfile\fR] [\fImanifest\fR] [\fB\-C\fR \fIdir\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] -.fi -.sp - -Extract JAR file -.sp -.nf - -\fBjar\fR \fBx\fR[\fBvf\fR] [\fIjarfile\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] -.fi -.sp - -List Contents of JAR file -.sp -.nf - -\fBjar\fR \fBt\fR[\fBvf\fR] [\fIjarfile\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] -.fi -.sp - -Add Index to JAR file -.sp -.nf - -\fBjar\fR \fBi\fR \fIjarfile\fR [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] -.fi -.sp -.SH DESCRIPTION -The \f3jar\fR command is a general-purpose archiving and compression tool, based on ZIP and the ZLIB compression format\&. However, the \f3jar\fR command was designed mainly to 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 (such as a browser) in a single HTTP transaction, rather than requiring a new connection for each piece\&. This dramatically improves download times\&. The \f3jar\fR command also compresses files, which further improves download time\&. The \f3jar\fR command also allows individual entries in a file to be signed by the applet author so that their origin can be authenticated\&. A JAR file can be used as a class path entry, whether or not it is compressed\&. -.PP -The syntax for the \f3jar\fR command resembles the syntax for the \f3tar\fR command\&. It has several operation modes, defined by one of the mandatory \fIoperation arguments\fR\&. Other arguments are either \fIoptions\fR that modify the behavior of the operation, or \fIoperands\fR required to perform the operation\&. -.SH OPERATION\ ARGUMENTS -When using the \f3jar\fR command, you have to select an operation to be performed by specifying one of the following operation arguments\&. You can mix them up with other one-letter options on the command line, but usually the operation argument is the first argument specified\&. -.TP -c -Create a new JAR archive\&. -.TP -i -Generate index information for a JAR archive\&. -.TP -t -List the contents of a JAR archive\&. -.TP -u -Update a JAR archive\&. -.TP -x -Extract files from a JAR archive\&. -.SH OPTIONS -Use the following options to customize how the JAR file is created, updated, extracted, or viewed: -.TP -e -Sets the class specified by the \fIentrypoint\fR operand to be the entry point\f3\fR for a standalone Java application bundled into an executable JAR file\&. The use of this option creates or overrides the \f3Main-Class\fR attribute value in the manifest file\&. The \f3e\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. - -For example, the following command creates the \f3Main\&.jar\fR archive with the \f3Main\&.class\fR file where the \f3Main-Clas\fRs attribute value in the manifest is set to \f3Main\fR: -.sp -.nf -\f3jar cfe Main\&.jar Main Main\&.class\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The Java Runtime Environment (JRE) can directly call this application by running the following command: -.sp -.nf -\f3java \-jar Main\&.jar\fP -.fi -.nf -\f3\fP -.fi -.sp - - -If the entry point class name is in a package, then it could use either the dot (\&.) or slash (/) as the delimiter\&. For example, if \f3Main\&.class\fR is in a package called \f3mydir\fR, then the entry point can be specified in one of the following ways: -.sp -.nf -\f3jar \-cfe Main\&.jar mydir/Main mydir/Main\&.class\fP -.fi -.nf -\f3jar \-cfe Main\&.jar mydir\&.Main mydir/Main\&.class\fP -.fi -.nf -\f3\fP -.fi -.sp - - -Note - -Specifying both \f3m\fR and \f3e\fR options together when a particular manifest also contains the \f3Main-Class\fR attribute results in an ambiguous \f3Main-Class\fR specification\&. The ambiguity leads to an error and the \f3jar\fR command creation or update operation is terminated\&. -.TP -f -Sets the file specified by the \fI\fR\fIjarfile\fR operand to be the name of the JAR file that is created (\f3c\fR), updated (\f3u\fR), extracted (\f3x\fR) from, or viewed (\f3t\fR)\&. Omitting the \f3f\fR option and the \fIjarfile\fR operand instructs the \f3jar\fR command to accept the JAR file name from \f3stdin\fR (for \f3x\fR and \f3t\fR) or send the JAR \f3\fRfile to \f3stdout\fR (for \f3c\fR and \f3u\fR)\&. -.TP -m -Includes names and values of attributes from the file specified by the \f3manifest\fR operand in the manifest file of the \f3jar\fR command (located in the archive at \f3META-INF/MANIFEST\&.MF\fR)\&. The \f3jar\fR command adds the attribute\(cqs name and value to the JAR file unless an entry already exists with the same name, in which case the \f3jar\fR command updates the value of the attribute\&. The \f3m\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. - -You can add special-purpose name-value attribute pairs to the manifest that are not contained in the default manifest file\&. For example, you can add attributes that specify vendor information, release information, package sealing, or to make JAR-bundled applications executable\&. For examples of using the \f3m\fR option, see Packaging Programs at http://docs\&.oracle\&.com/javase/tutorial/deployment/jar/index\&.html -.TP -M -Does not create a manifest file entry (for \f3c\fR and \f3u\fR), or delete a manifest file entry when one exists (for \f3u\fR)\&. The \f3M\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. -.TP -n -When creating (\f3c\fR) a JAR file, this option normalizes the archive so that the content is not affected by the packing and unpacking operations of the pack200(1) command\&. Without this normalization, the signature of a signed JAR can become invalid\&. -.TP -v -Generates verbose output to standard output\&. See Examples\&. -.TP -0 -(Zero) Creates (\f3c\fR) or updates (\f3u\fR) the JAR file without using ZIP compression\&. -.TP --C \fIdir\fR -.br -When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, this option temporarily changes the directory while processing files specified by the \fIfile\fR operands\&. Its operation is intended to be similar to the \f3-C\fR option of the UNIX \f3tar\fR utility\&.For example, the following command changes to the \f3classes\fR directory and adds the \f3Bar\&.class\fR file from that directory to \f3my\&.jar\fR: -.sp -.nf -\f3jar uf my\&.jar \-C classes Bar\&.class\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The following command changes to the \f3classes\fR directory and adds to \f3my\&.jar\fR all files within the classes directory (without creating a \f3classes\fR directory in the JAR file), then changes back to the original directory before changing to the \f3bin\fR directory to add \f3Xyz\&.class\fR to \f3my\&.jar\fR\&. -.sp -.nf -\f3jar uf my\&.jar \-C classes \&. \-C bin Xyz\&.class\fP -.fi -.nf -\f3\fP -.fi -.sp - - -If \f3classes\fR contained files \f3bar1\fR and \f3bar2\fR, then the JAR file will contain the following after running the previous command: -.sp -.nf -\f3% \fIjar tf my\&.jar\fR\fP -.fi -.nf -\f3META\-INF/\fP -.fi -.nf -\f3META\-INF/MANIFEST\&.MF\fP -.fi -.nf -\f3bar1\fP -.fi -.nf -\f3bar2\fP -.fi -.nf -\f3Xyz\&.class\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -\fI\fR-J\fIoption\fR -Sets the specified JVM option to be used when the JRE runs the JAR file\&. JVM options are described on the reference page for the java(1) command\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. -.SH OPERANDS -The following operands are recognized by the \f3jar\fR command\&. -.TP -\fIfile\fR -When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fIfile\fR operand defines the path and name of the file or directory that should be added to the archive\&. When extracting (\f3x\fR) or listing the contents (\f3t\fR) of a JAR file, the \fIfile\fR operand defines the path and name of the file to be extrated or listed\&. At least one valid file or directory must be specified\&. Separate multiple \fIfile\fR operands with spaces\&. If the \fIentrypoint\fR, \fIjarfile\fR, or \fImanifest\fR operands are used, the \fIfile\fR operands must be specified after them\&. -.TP -\fIentrypoint\fR -When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fIentrypoint\fR operand defines the name of the class that should be the entry point\f3\fR for a standalone Java application bundled into an executable JAR file\&. The \fIentrypoint\fR operand must be specified if the \f3e\fR option is present\&. -.TP -\fIjarfile\fR -Defines the name of the file to be created (\f3c\fR), updated (\f3u\fR), extracted (\f3x\fR), or viewed (\f3t\fR)\&. The \fIjarfile\fR operand must be specified if the \f3f\fR option is present\&. Omitting the \f3f\fR option and the \fIjarfile\fR operand instructs the \f3jar\fR command to accept the JAR file name from \f3stdin\fR (for \f3x\fR and \f3t\fR) or send the JAR \f3\fRfile to \f3stdout\fR (for \f3c\fR and \f3u\fR)\&. - -When indexing (\f3i\fR) a JAR file, specify the \fIjarfile\fR operand without the \f3f\fR option\&. -.TP -\fImanifest\fR -When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fImanifest\fR operand defines the preexisting manifest files with names and values of attributes to be included in \f3MANIFEST\&.MF\fR in the JAR file\&. The \fImanifest\fR operand must be specified if the \f3f\fR option is present\&. -.TP -\fI@arg-file\fR -To shorten or simplify the \f3jar\fR command, you can specify arguments in a separate text file and pass it to the \f3jar\fR command with the at sign (@) as a prefix\&. When the \f3jar\fR command encounters an argument beginning with the at sign, it expands the contents of that file into the argument list\&. - -An argument file can include options and arguments of the \f3jar\fR command (except the \f3-J\fR options, because they are passed to the launcher, which does not support argument files)\&. The arguments within a file can be separated by spaces or newline characters\&. File names within an argument file are relative to the current directory from which you run the \f3jar\fR command, not relative to the location of the argument file\&. Wild cards, such as the asterisk (*), that might otherwise be expanded by the operating system shell, are not expanded\&. - -The following example, shows how to create a \f3classes\&.list\fR file with names of files from the current directory output by the \f3find\fR command: -.sp -.nf -\f3find \&. \-name \&'*\&.class\&' \-print > classes\&.list\fP -.fi -.nf -\f3\fP -.fi -.sp - - -You can then execute the \f3jar\fR command and pass the \f3classes\&.list\fR file to it using the \fI@arg-file\fR syntax: -.sp -.nf -\f3jar cf my\&.jar @classes\&.list\fP -.fi -.nf -\f3\fP -.fi -.sp - - -An argument file can be specified with a path, but any file names inside the argument file that have relative paths are relative to the current working directory of the \f3jar\fR command, not to the path passed in, for example: -.sp -.nf -\f3jar @dir/classes\&.list\fP -.fi -.nf -\f3\fP -.fi -.sp - -.SH NOTES -The \f3e\fR, \f3f\fR, and \f3m\fR options must appear in the same order on the command line as the \fIentrypoint\fR, \fIjarfile\fR, and \fImanifest\fR operands, for example: -.sp -.nf -\f3jar cmef myManifestFile MyMainClass myFile\&.jar *\&.class\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH EXAMPLES -\f3Example 1 Adding All Files From the Current Directory With Verbose Output\fR -.sp -.nf -\f3% ls\fP -.fi -.nf -\f31\&.au Animator\&.class monkey\&.jpg\fP -.fi -.nf -\f32\&.au Wave\&.class spacemusic\&.au\fP -.fi -.nf -\f33\&.au at_work\&.gif\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3% jar cvf bundle\&.jar *\fP -.fi -.nf -\f3added manifest\fP -.fi -.nf -\f3adding: 1\&.au(in = 2324) (out= 67)(deflated 97%)\fP -.fi -.nf -\f3adding: 2\&.au(in = 6970) (out= 90)(deflated 98%)\fP -.fi -.nf -\f3adding: 3\&.au(in = 11616) (out= 108)(deflated 99%)\fP -.fi -.nf -\f3adding: Animator\&.class(in = 2266) (out= 66)(deflated 97%)\fP -.fi -.nf -\f3adding: Wave\&.class(in = 3778) (out= 81)(deflated 97%)\fP -.fi -.nf -\f3adding: at_work\&.gif(in = 6621) (out= 89)(deflated 98%)\fP -.fi -.nf -\f3adding: monkey\&.jpg(in = 7667) (out= 91)(deflated 98%)\fP -.fi -.nf -\f3adding: spacemusic\&.au(in = 3079) (out= 73)(deflated 97%)\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 2 Adding Files From Subdirectories\fR -.sp -.nf -\f3% ls \-F\fP -.fi -.nf -\f3audio/ classes/ images/\fP -.fi -.nf -\f3% jar cvf bundle\&.jar audio classes images\fP -.fi -.nf -\f3added manifest\fP -.fi -.nf -\f3adding: audio/(in = 0) (out= 0)(stored 0%)\fP -.fi -.nf -\f3adding: audio/1\&.au(in = 2324) (out= 67)(deflated 97%)\fP -.fi -.nf -\f3adding: audio/2\&.au(in = 6970) (out= 90)(deflated 98%)\fP -.fi -.nf -\f3adding: audio/3\&.au(in = 11616) (out= 108)(deflated 99%)\fP -.fi -.nf -\f3adding: audio/spacemusic\&.au(in = 3079) (out= 73)(deflated 97%)\fP -.fi -.nf -\f3adding: classes/(in = 0) (out= 0)(stored 0%)\fP -.fi -.nf -\f3adding: classes/Animator\&.class(in = 2266) (out= 66)(deflated 97%)\fP -.fi -.nf -\f3adding: classes/Wave\&.class(in = 3778) (out= 81)(deflated 97%)\fP -.fi -.nf -\f3adding: images/(in = 0) (out= 0)(stored 0%)\fP -.fi -.nf -\f3adding: images/monkey\&.jpg(in = 7667) (out= 91)(deflated 98%)\fP -.fi -.nf -\f3adding: images/at_work\&.gif(in = 6621) (out= 89)(deflated 98%)\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3% ls \-F\fP -.fi -.nf -\f3audio/ bundle\&.jar classes/ images/\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 3 Listing the Contents of JAR\fR -.sp -.nf -\f3% jar tf bundle\&.jar\fP -.fi -.sp -.sp -.nf -\f3META\-INF/\fP -.fi -.nf -\f3META\-INF/MANIFEST\&.MF\fP -.fi -.nf -\f3audio/1\&.au\fP -.fi -.nf -\f3audio/2\&.au\fP -.fi -.nf -\f3audio/3\&.au\fP -.fi -.nf -\f3audio/spacemusic\&.au\fP -.fi -.nf -\f3classes/Animator\&.class\fP -.fi -.nf -\f3classes/Wave\&.class\fP -.fi -.nf -\f3images/monkey\&.jpg\fP -.fi -.nf -\f3images/at_work\&.gif\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 4 Adding an Index\fR -.PP -Use the \f3i\fR option when you split the interdependent classes for a stock trade application into three JAR files: \f3main\&.jar\fR, \f3buy\&.jar\fR, and \f3sell\&.jar\fR\&. If you specify the \f3Class-Path\fR attribute in the \f3main\&.jar\fR manifest, then you can use the \f3i\fR option to speed up the class loading time for your application: -.sp -.nf -\f3Class\-Path: buy\&.jar sell\&.jar\fP -.fi -.nf -\f3jar i main\&.jar\fP -.fi -.nf -\f3\fP -.fi -.sp -An \f3INDEX\&.LIST\fR file is inserted to the \f3META-INF\fR directory\&. This enables the application class loader to download the specified JAR files when it is searching for classes or resources\&. -.PP -The application class loader uses the information stored in this file for efficient class loading\&. To copy directories, first compress files in \f3dir1\fR to \f3stdout\fR, then pipeline and extract from \f3stdin\fR to \f3dir2\fR (omitting the \f3-f\fR option from both \f3jar\fR commands): -.sp -.nf -\f3(cd dir1; jar c \&.) | (cd dir2; jar x)\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH SEE\ ALSO -.TP 0.2i -\(bu -pack200(1)\&. -.TP 0.2i -\(bu -The JAR section of The Java Tutorials at http://docs\&.oracle\&.com/javase/tutorial/deployment/jar/index\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1997, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: jar.1 +.\" +.if n .pl 99999 +.TH jar 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jar \- Manipulates Java Archive (JAR) files\&. +.SH SYNOPSIS +Create JAR file +.sp +.nf + +\fBjar c\fR[\fBefmMnv0\fR] [\fIentrypoint\fR] [\fIjarfile\fR] [\fImanifest\fR] [\fB\-C\fR \fIdir\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp + +Update JAR file +.sp +.nf + +\fBjar u\fR[\fBefmMnv0\fR] [\fIentrypoint\fR] [\fIjarfile\fR] [\fImanifest\fR] [\fB\-C\fR \fIdir\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp + +Extract JAR file +.sp +.nf + +\fBjar\fR \fBx\fR[\fBvf\fR] [\fIjarfile\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp + +List Contents of JAR file +.sp +.nf + +\fBjar\fR \fBt\fR[\fBvf\fR] [\fIjarfile\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp + +Add Index to JAR file +.sp +.nf + +\fBjar\fR \fBi\fR \fIjarfile\fR [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp +.SH DESCRIPTION +The \f3jar\fR command is a general-purpose archiving and compression tool, based on ZIP and the ZLIB compression format\&. However, the \f3jar\fR command was designed mainly to 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 (such as a browser) in a single HTTP transaction, rather than requiring a new connection for each piece\&. This dramatically improves download times\&. The \f3jar\fR command also compresses files, which further improves download time\&. The \f3jar\fR command also allows individual entries in a file to be signed by the applet author so that their origin can be authenticated\&. A JAR file can be used as a class path entry, whether or not it is compressed\&. +.PP +The syntax for the \f3jar\fR command resembles the syntax for the \f3tar\fR command\&. It has several operation modes, defined by one of the mandatory \fIoperation arguments\fR\&. Other arguments are either \fIoptions\fR that modify the behavior of the operation, or \fIoperands\fR required to perform the operation\&. +.SH OPERATION\ ARGUMENTS +When using the \f3jar\fR command, you have to select an operation to be performed by specifying one of the following operation arguments\&. You can mix them up with other one-letter options on the command line, but usually the operation argument is the first argument specified\&. +.TP +c +Create a new JAR archive\&. +.TP +i +Generate index information for a JAR archive\&. +.TP +t +List the contents of a JAR archive\&. +.TP +u +Update a JAR archive\&. +.TP +x +Extract files from a JAR archive\&. +.SH OPTIONS +Use the following options to customize how the JAR file is created, updated, extracted, or viewed: +.TP +e +Sets the class specified by the \fIentrypoint\fR operand to be the entry point\f3\fR for a standalone Java application bundled into an executable JAR file\&. The use of this option creates or overrides the \f3Main-Class\fR attribute value in the manifest file\&. The \f3e\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. + +For example, the following command creates the \f3Main\&.jar\fR archive with the \f3Main\&.class\fR file where the \f3Main-Clas\fRs attribute value in the manifest is set to \f3Main\fR: +.sp +.nf +\f3jar cfe Main\&.jar Main Main\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The Java Runtime Environment (JRE) can directly call this application by running the following command: +.sp +.nf +\f3java \-jar Main\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If the entry point class name is in a package, then it could use either the dot (\&.) or slash (/) as the delimiter\&. For example, if \f3Main\&.class\fR is in a package called \f3mydir\fR, then the entry point can be specified in one of the following ways: +.sp +.nf +\f3jar \-cfe Main\&.jar mydir/Main mydir/Main\&.class\fP +.fi +.nf +\f3jar \-cfe Main\&.jar mydir\&.Main mydir/Main\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Note + +Specifying both \f3m\fR and \f3e\fR options together when a particular manifest also contains the \f3Main-Class\fR attribute results in an ambiguous \f3Main-Class\fR specification\&. The ambiguity leads to an error and the \f3jar\fR command creation or update operation is terminated\&. +.TP +f +Sets the file specified by the \fI\fR\fIjarfile\fR operand to be the name of the JAR file that is created (\f3c\fR), updated (\f3u\fR), extracted (\f3x\fR) from, or viewed (\f3t\fR)\&. Omitting the \f3f\fR option and the \fIjarfile\fR operand instructs the \f3jar\fR command to accept the JAR file name from \f3stdin\fR (for \f3x\fR and \f3t\fR) or send the JAR \f3\fRfile to \f3stdout\fR (for \f3c\fR and \f3u\fR)\&. +.TP +m +Includes names and values of attributes from the file specified by the \f3manifest\fR operand in the manifest file of the \f3jar\fR command (located in the archive at \f3META-INF/MANIFEST\&.MF\fR)\&. The \f3jar\fR command adds the attribute\(cqs name and value to the JAR file unless an entry already exists with the same name, in which case the \f3jar\fR command updates the value of the attribute\&. The \f3m\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. + +You can add special-purpose name-value attribute pairs to the manifest that are not contained in the default manifest file\&. For example, you can add attributes that specify vendor information, release information, package sealing, or to make JAR-bundled applications executable\&. For examples of using the \f3m\fR option, see Packaging Programs at http://docs\&.oracle\&.com/javase/tutorial/deployment/jar/index\&.html +.TP +M +Does not create a manifest file entry (for \f3c\fR and \f3u\fR), or delete a manifest file entry when one exists (for \f3u\fR)\&. The \f3M\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. +.TP +n +When creating (\f3c\fR) a JAR file, this option normalizes the archive so that the content is not affected by the packing and unpacking operations of the pack200(1) command\&. Without this normalization, the signature of a signed JAR can become invalid\&. +.TP +v +Generates verbose output to standard output\&. See Examples\&. +.TP +0 +(Zero) Creates (\f3c\fR) or updates (\f3u\fR) the JAR file without using ZIP compression\&. +.TP +-C \fIdir\fR +.br +When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, this option temporarily changes the directory while processing files specified by the \fIfile\fR operands\&. Its operation is intended to be similar to the \f3-C\fR option of the UNIX \f3tar\fR utility\&.For example, the following command changes to the \f3classes\fR directory and adds the \f3Bar\&.class\fR file from that directory to \f3my\&.jar\fR: +.sp +.nf +\f3jar uf my\&.jar \-C classes Bar\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following command changes to the \f3classes\fR directory and adds to \f3my\&.jar\fR all files within the classes directory (without creating a \f3classes\fR directory in the JAR file), then changes back to the original directory before changing to the \f3bin\fR directory to add \f3Xyz\&.class\fR to \f3my\&.jar\fR\&. +.sp +.nf +\f3jar uf my\&.jar \-C classes \&. \-C bin Xyz\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If \f3classes\fR contained files \f3bar1\fR and \f3bar2\fR, then the JAR file will contain the following after running the previous command: +.sp +.nf +\f3% \fIjar tf my\&.jar\fR\fP +.fi +.nf +\f3META\-INF/\fP +.fi +.nf +\f3META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3bar1\fP +.fi +.nf +\f3bar2\fP +.fi +.nf +\f3Xyz\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +\fI\fR-J\fIoption\fR +Sets the specified JVM option to be used when the JRE runs the JAR file\&. JVM options are described on the reference page for the java(1) command\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. +.SH OPERANDS +The following operands are recognized by the \f3jar\fR command\&. +.TP +\fIfile\fR +When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fIfile\fR operand defines the path and name of the file or directory that should be added to the archive\&. When extracting (\f3x\fR) or listing the contents (\f3t\fR) of a JAR file, the \fIfile\fR operand defines the path and name of the file to be extrated or listed\&. At least one valid file or directory must be specified\&. Separate multiple \fIfile\fR operands with spaces\&. If the \fIentrypoint\fR, \fIjarfile\fR, or \fImanifest\fR operands are used, the \fIfile\fR operands must be specified after them\&. +.TP +\fIentrypoint\fR +When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fIentrypoint\fR operand defines the name of the class that should be the entry point\f3\fR for a standalone Java application bundled into an executable JAR file\&. The \fIentrypoint\fR operand must be specified if the \f3e\fR option is present\&. +.TP +\fIjarfile\fR +Defines the name of the file to be created (\f3c\fR), updated (\f3u\fR), extracted (\f3x\fR), or viewed (\f3t\fR)\&. The \fIjarfile\fR operand must be specified if the \f3f\fR option is present\&. Omitting the \f3f\fR option and the \fIjarfile\fR operand instructs the \f3jar\fR command to accept the JAR file name from \f3stdin\fR (for \f3x\fR and \f3t\fR) or send the JAR \f3\fRfile to \f3stdout\fR (for \f3c\fR and \f3u\fR)\&. + +When indexing (\f3i\fR) a JAR file, specify the \fIjarfile\fR operand without the \f3f\fR option\&. +.TP +\fImanifest\fR +When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fImanifest\fR operand defines the preexisting manifest files with names and values of attributes to be included in \f3MANIFEST\&.MF\fR in the JAR file\&. The \fImanifest\fR operand must be specified if the \f3f\fR option is present\&. +.TP +\fI@arg-file\fR +To shorten or simplify the \f3jar\fR command, you can specify arguments in a separate text file and pass it to the \f3jar\fR command with the at sign (@) as a prefix\&. When the \f3jar\fR command encounters an argument beginning with the at sign, it expands the contents of that file into the argument list\&. + +An argument file can include options and arguments of the \f3jar\fR command (except the \f3-J\fR options, because they are passed to the launcher, which does not support argument files)\&. The arguments within a file can be separated by spaces or newline characters\&. File names within an argument file are relative to the current directory from which you run the \f3jar\fR command, not relative to the location of the argument file\&. Wild cards, such as the asterisk (*), that might otherwise be expanded by the operating system shell, are not expanded\&. + +The following example, shows how to create a \f3classes\&.list\fR file with names of files from the current directory output by the \f3find\fR command: +.sp +.nf +\f3find \&. \-name \&'*\&.class\&' \-print > classes\&.list\fP +.fi +.nf +\f3\fP +.fi +.sp + + +You can then execute the \f3jar\fR command and pass the \f3classes\&.list\fR file to it using the \fI@arg-file\fR syntax: +.sp +.nf +\f3jar cf my\&.jar @classes\&.list\fP +.fi +.nf +\f3\fP +.fi +.sp + + +An argument file can be specified with a path, but any file names inside the argument file that have relative paths are relative to the current working directory of the \f3jar\fR command, not to the path passed in, for example: +.sp +.nf +\f3jar @dir/classes\&.list\fP +.fi +.nf +\f3\fP +.fi +.sp + +.SH NOTES +The \f3e\fR, \f3f\fR, and \f3m\fR options must appear in the same order on the command line as the \fIentrypoint\fR, \fIjarfile\fR, and \fImanifest\fR operands, for example: +.sp +.nf +\f3jar cmef myManifestFile MyMainClass myFile\&.jar *\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH EXAMPLES +\f3Example 1 Adding All Files From the Current Directory With Verbose Output\fR +.sp +.nf +\f3% ls\fP +.fi +.nf +\f31\&.au Animator\&.class monkey\&.jpg\fP +.fi +.nf +\f32\&.au Wave\&.class spacemusic\&.au\fP +.fi +.nf +\f33\&.au at_work\&.gif\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3% jar cvf bundle\&.jar *\fP +.fi +.nf +\f3added manifest\fP +.fi +.nf +\f3adding: 1\&.au(in = 2324) (out= 67)(deflated 97%)\fP +.fi +.nf +\f3adding: 2\&.au(in = 6970) (out= 90)(deflated 98%)\fP +.fi +.nf +\f3adding: 3\&.au(in = 11616) (out= 108)(deflated 99%)\fP +.fi +.nf +\f3adding: Animator\&.class(in = 2266) (out= 66)(deflated 97%)\fP +.fi +.nf +\f3adding: Wave\&.class(in = 3778) (out= 81)(deflated 97%)\fP +.fi +.nf +\f3adding: at_work\&.gif(in = 6621) (out= 89)(deflated 98%)\fP +.fi +.nf +\f3adding: monkey\&.jpg(in = 7667) (out= 91)(deflated 98%)\fP +.fi +.nf +\f3adding: spacemusic\&.au(in = 3079) (out= 73)(deflated 97%)\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 2 Adding Files From Subdirectories\fR +.sp +.nf +\f3% ls \-F\fP +.fi +.nf +\f3audio/ classes/ images/\fP +.fi +.nf +\f3% jar cvf bundle\&.jar audio classes images\fP +.fi +.nf +\f3added manifest\fP +.fi +.nf +\f3adding: audio/(in = 0) (out= 0)(stored 0%)\fP +.fi +.nf +\f3adding: audio/1\&.au(in = 2324) (out= 67)(deflated 97%)\fP +.fi +.nf +\f3adding: audio/2\&.au(in = 6970) (out= 90)(deflated 98%)\fP +.fi +.nf +\f3adding: audio/3\&.au(in = 11616) (out= 108)(deflated 99%)\fP +.fi +.nf +\f3adding: audio/spacemusic\&.au(in = 3079) (out= 73)(deflated 97%)\fP +.fi +.nf +\f3adding: classes/(in = 0) (out= 0)(stored 0%)\fP +.fi +.nf +\f3adding: classes/Animator\&.class(in = 2266) (out= 66)(deflated 97%)\fP +.fi +.nf +\f3adding: classes/Wave\&.class(in = 3778) (out= 81)(deflated 97%)\fP +.fi +.nf +\f3adding: images/(in = 0) (out= 0)(stored 0%)\fP +.fi +.nf +\f3adding: images/monkey\&.jpg(in = 7667) (out= 91)(deflated 98%)\fP +.fi +.nf +\f3adding: images/at_work\&.gif(in = 6621) (out= 89)(deflated 98%)\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3% ls \-F\fP +.fi +.nf +\f3audio/ bundle\&.jar classes/ images/\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 3 Listing the Contents of JAR\fR +.sp +.nf +\f3% jar tf bundle\&.jar\fP +.fi +.sp +.sp +.nf +\f3META\-INF/\fP +.fi +.nf +\f3META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3audio/1\&.au\fP +.fi +.nf +\f3audio/2\&.au\fP +.fi +.nf +\f3audio/3\&.au\fP +.fi +.nf +\f3audio/spacemusic\&.au\fP +.fi +.nf +\f3classes/Animator\&.class\fP +.fi +.nf +\f3classes/Wave\&.class\fP +.fi +.nf +\f3images/monkey\&.jpg\fP +.fi +.nf +\f3images/at_work\&.gif\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 4 Adding an Index\fR +.PP +Use the \f3i\fR option when you split the interdependent classes for a stock trade application into three JAR files: \f3main\&.jar\fR, \f3buy\&.jar\fR, and \f3sell\&.jar\fR\&. If you specify the \f3Class-Path\fR attribute in the \f3main\&.jar\fR manifest, then you can use the \f3i\fR option to speed up the class loading time for your application: +.sp +.nf +\f3Class\-Path: buy\&.jar sell\&.jar\fP +.fi +.nf +\f3jar i main\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +An \f3INDEX\&.LIST\fR file is inserted to the \f3META-INF\fR directory\&. This enables the application class loader to download the specified JAR files when it is searching for classes or resources\&. +.PP +The application class loader uses the information stored in this file for efficient class loading\&. To copy directories, first compress files in \f3dir1\fR to \f3stdout\fR, then pipeline and extract from \f3stdin\fR to \f3dir2\fR (omitting the \f3-f\fR option from both \f3jar\fR commands): +.sp +.nf +\f3(cd dir1; jar c \&.) | (cd dir2; jar x)\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +pack200(1)\&. +.TP 0.2i +\(bu +The JAR section of The Java Tutorials at http://docs\&.oracle\&.com/javase/tutorial/deployment/jar/index\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/jarsigner.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/jarsigner.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,808 +1,808 @@ -'\" t -.\" Copyright (c) 1998, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Security Tools -.\" Title: jarsigner.1 -.\" -.if n .pl 99999 -.TH jarsigner 1 "21 November 2013" "JDK 8" "Security Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jarsigner \- Signs and verifies Java Archive (JAR) files\&. -.SH SYNOPSIS -.sp -.nf - -\fBjarsigner\fR [ \fIoptions\fR ] \fIjar\-file\fR \fIalias\fR -.fi -.nf - -\fBjarsigner\fR \fB\-verify\fR [ \fIoptions\fR ] \fIjar\-file\fR [\fIalias \&.\&.\&.\fR] -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP --verify -.br -The \f3-verify\fR option can take zero or more keystore alias names after the JAR file name\&. When the \f3-verify\fR option is specified, the \f3jarsigner\fR command checks 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 \f3-keystore\fR or the default keystore\&. - -If you also specified the \f3-strict\fR option, and the \f3jarsigner\fR command detected severe warnings, the message, "jar verified, with signer errors" is displayed\&. -.TP -\fIjar-file\fR -The JAR file to be signed\&. - -If you also specified the \f3-strict\fR option, and the \f3jarsigner\fR command detected severe warnings, the message, "jar signed, with signer errors" is displayed\&. -.TP -\fIalias\fR -The aliases are defined in the keystore specified by \f3-keystore\fR or the default keystore\&. -.SH DESCRIPTION -The \f3jarsigner\fR tool has two purposes: -.TP 0.2i -\(bu -To sign Java Archive (JAR) files\&. -.TP 0.2i -\(bu -To verify the signatures and integrity of signed JAR files\&. -.PP -The JAR feature enables the packaging of class files, images, sounds, and other digital data in a single file for faster and easier distribution\&. A tool named \f3jar\fR enables developers to produce JAR files\&. (Technically, any zip file can also be considered a JAR file, although when created by the \f3jar\fR command or processed by the \f3jarsigner\fR command, JAR files also contain a \f3META-INF/MANIFEST\&.MF\fR file\&.) -.PP -A digital signature is a string of bits that is computed from some data (the data being signed) and the private key of an entity (a person, company, and so on)\&. Similar to a handwritten signature, a digital signature has many useful characteristics: -.TP 0.2i -\(bu -Its authenticity can be verified by a computation that uses the public key corresponding to the private key used to generate the signature\&. -.TP 0.2i -\(bu -It cannot be forged, assuming the private key is kept secret\&. -.TP 0.2i -\(bu -It is a function of the data signed and thus cannot be claimed to be the signature for other data as well\&. -.TP 0.2i -\(bu -The signed data cannot be changed\&. If the data is changed, then the signature cannot be verified as authentic\&. -.PP -To generate an entity\&'s signature for a file, the entity must first have a public/private key pair associated with it and one or more certificates that authenticate its public key\&. A certificate is a digitally signed statement from one entity that says that the public key of another entity has a particular value\&. -.PP -The \f3jarsigner\fR command uses key and certificate information from a keystore to generate digital signatures for JAR files\&. A keystore is a database of private keys and their associated X\&.509 certificate chains that authenticate the corresponding public keys\&. The \f3keytool\fR command is used to create and administer keystores\&. -.PP -The \f3jarsigner\fR command uses an entity\&'s private key to generate a signature\&. The signed JAR file contains, among other things, a copy of the certificate from the keystore for the public key corresponding to the private key used to sign the file\&. The \f3jarsigner\fR command can verify the digital signature of the signed JAR file using the certificate inside it (in its signature block file)\&. -.PP -The \f3jarsigner\fR command can generate signatures that include a time stamp that lets a systems or deployer (including Java Plug-in) to check whether the JAR file was signed while the signing certificate was still valid\&. In addition, APIs allow applications to obtain the timestamp information\&. -.PP -At this time, the \f3jarsigner\fR command can only sign JAR files created by the \f3jar\fR command or zip files\&. JAR files are the same as zip files, except they also have a \f3META-INF/MANIFEST\&.MF\fR file\&. A \f3META-INF/MANIFEST\&.MF\fR file is created when the \f3jarsigner\fR command signs a zip file\&. -.PP -The default \f3jarsigner\fR command behavior is to sign a JAR or zip file\&. Use the \f3-verify\fR option to verify a signed JAR file\&. -.PP -The \f3jarsigner\fR command also attempts to validate the signer\&'s certificate after signing or verifying\&. If there is a validation error or any other problem, the command generates warning messages\&. If you specify the \f3-strict\fR option, then the command treats severe warnings as errors\&. See Errors and Warnings\&. -.SS KEYSTORE\ ALIASES -All keystore entities are accessed with unique aliases\&. -.PP -When you use the \f3jarsigner\fR command to sign a JAR file, you must specify the alias for the keystore entry that contains the private key needed to generate the signature\&. For example, the following command signs the JAR file named \f3MyJARFile\&.jar\fR with the private key associated with the alias \f3duke\fR in the keystore named \f3mystore\fR in the \f3working\fR directory\&. Because no output file is specified, it overwrites \f3MyJARFile\&.jar\fR with the signed JAR file\&. -.sp -.nf -\f3jarsigner \-keystore /working/mystore \-storepass <keystore password>\fP -.fi -.nf -\f3 \-keypass <private key password> MyJARFile\&.jar duke\fP -.fi -.nf -\f3\fR -.fi -.sp -Keystores are protected with a password, so the store password must be specified\&. You are prompted for it when you do not 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 are prompted for the password when you do not specify it on the command line and it is not the same as the store password\&. -.SS KEYSTORE\ LOCATION -The \f3jarsigner\fR command has a \f3-keystore\fR option for specifying the URL of the keystore to be used\&. The keystore is by default stored in a file named \f3\&.keystore\fR in the user\&'s home directory, as determined by the \f3user\&.home\fR system property\&. -.PP -On Oracle Solaris systems, \f3user\&.home\fR defaults to the user\&'s home directory\&. -.PP -The input stream from the \f3-keystore\fR option is passed to the \f3KeyStore\&.load\fR method\&. If \f3NONE\fR is specified as the URL, then a null stream is passed to the \f3KeyStore\&.load\fR method\&. \f3NONE\fR should be specified when the \f3KeyStore\fR class is not file based, for example, when it resides on a hardware token device\&. -.SS KEYSTORE\ IMPLEMENTATION -The \f3KeyStore\fR class provided in the \f3java\&.security\fR package supplies a number of well-defined interfaces to access and modify the information in a keystore\&. You can have multiple different concrete implementations, where each implementation is for a particular type of keystore\&. -.PP -Currently, there are two command-line tools that use keystore implementations (\f3keytool\fR and \f3jarsigner\fR), and a GUI-based tool named Policy Tool\&. Because the \f3KeyStore\fR class is publicly available, JDK users can write additional security applications that use it\&. -.PP -There is a built-in default implementation provided by Oracle that implements the keystore as a file, that uses a proprietary keystore type (format) named JKS\&. The built-in implementation protects each private key with its individual password and protects the integrity of the entire keystore with a (possibly different) password\&. -.PP -Keystore implementations are provider-based, which means the application interfaces supplied by the \f3KeyStore\fR class are implemented in terms of a Service Provider Interface (SPI)\&. There is a corresponding abstract \f3KeystoreSpi\fR class, also in the \f3java\&.security package\fR, that defines the Service Provider Interface methods that providers must implement\&. The term provider refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API\&. To provide a keystore implementation, clients must implement a provider and supply a \f3KeystoreSpi\fR subclass implementation, as described in How to Implement a Provider in the Java Cryptography Architecture at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/HowToImplAProvider\&.html -.PP -Applications can choose different types of keystore implementations from different providers, with the \f3getInstance\fR factory method in the \f3KeyStore\fR 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\&. -.PP -The \f3jarsigner\fR and \f3policytool\fR commands can read file-based keystores from any location that can be specified using a URL\&. In addition, these commands can read non-file-based keystores such as those provided by MSCAPI on Windows and PKCS11 on all platforms\&. -.PP -For the \f3jarsigner\fR and \f3keytool\fR commands, you can specify a keystore type at the command line with the \f3-storetype\fR option\&. For Policy Tool, you can specify a keystore type with the \fIEdit\fR command in the \fIKeyStore\fR menu\&. -.PP -If you do not explicitly specify a keystore type, then the tools choose a keystore implementation based on the value of the \f3keystore\&.type\fR property specified in the security properties file\&. The security properties file is called \f3java\&.security\fR, and it resides in the JDK security properties directory, \f3java\&.home/lib/security\fR, where \f3java\&.home\fR is the runtime environment\&'s directory\&. The \f3jre\fR directory in the JDK or the top-level directory of the Java Runtime Environment (JRE)\&. -.PP -Each tool gets the \f3keystore\&.type\fR value and then examines all the installed providers until it finds one that implements keystores of that type\&. It then uses the keystore implementation from that provider\&. -.PP -The \f3KeyStore\fR class defines a static method named \f3getDefaultType\fR that lets applications and applets retrieve the value of the \f3keystore\&.type\fR property\&. The following line of code creates an instance of the default keystore type as specified in the \f3keystore\&.type property\fR: -.sp -.nf -\f3KeyStore keyStore = KeyStore\&.getInstance(KeyStore\&.getDefaultType());\fP -.fi -.nf -\f3\fR -.fi -.sp -The default keystore type is \f3jks\fR (the proprietary type of the keystore implementation provided by Oracle)\&. This is specified by the following line in the security properties file: -.sp -.nf -\f3keystore\&.type=jks\fP -.fi -.nf -\f3\fR -.fi -.sp -Case does not matter in keystore type designations\&. For example, \f3JKS\fR is the same as \f3jks\fR\&. -.PP -To have the tools use a keystore implementation other than the default, change that line to specify a different keystore type\&. For example, if you have a provider package that supplies a keystore implementation for a keystore type called \f3pkcs12\fR, then change the line to the following: -.sp -.nf -\f3keystore\&.type=pkcs12\fP -.fi -.nf -\f3\fR -.fi -.sp -\fINote:\fR If you use the PKCS 11 provider package, then see "KeyTool" and "JarSigner" in Java PKCS #11 Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/p11guide\&.html -.SS SUPPORTED\ ALGORITHMS -By default, the \f3jarsigner\fR command signs a JAR file using one of the following algorithms: -.TP 0.2i -\(bu -Digital Signature Algorithm (DSA) with the SHA1 digest algorithm -.TP 0.2i -\(bu -RSA algorithm with the SHA256 digest algorithm -.TP 0.2i -\(bu -Elliptic Curve (EC) cryptography algorithm with the SHA256 with Elliptic Curve Digital Signature Algorithm (ECDSA)\&. -.PP -If the signer\&'s public and private keys are DSA keys, then \f3jarsigner\fR signs the JAR file with the \f3SHA1withDSA\fR algorithm\&. If the signer\&'s keys are RSA keys, then \f3jarsigner\fR attempts to sign the JAR file with the \f3SHA256withRSA\fR algorithm\&. If the signer\&'s keys are EC keys, then \f3jarsigner\fR signs the JAR file with the \f3SHA256withECDSA\fR algorithm\&. -.PP -These default signature algorithms can be overridden using the \f3-sigalg\fR option\&. -.SS THE\ SIGNED\ JAR\ FILE -When the \f3jarsigner\fR command 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: -.TP 0.2i -\(bu -A signature file with an \f3\&.SF\fR extension -.TP 0.2i -\(bu -A signature block file with a \f3\&.DSA\fR, \f3\&.RSA\fR, or \f3\&.EC\fR extension -.PP -The base file names for these two files come from the value of the \f3-sigFile\fR option\&. For example, when the option is \f3-sigFile MKSIGN\fR, the files are named \f3MKSIGN\&.SF\fR and \f3MKSIGN\&.DSA\fR -.PP -If no \f3-sigfile\fR option appears on the command line, then the base file name for the \f3\&.SF\fR and \f3\&.DSA\fR files is the first 8 characters of the alias name specified on the command line, all converted to uppercase\&. If the alias name has fewer than 8 characters, then the full alias name is used\&. If the alias name contains any characters that are not allowed in a signature file name, then each such character is converted to an underscore (_) character in forming the file name\&. Valid characters include letters, digits, underscores, and hyphens\&. -.PP -Signature File - -A signature file (\f3\&.SF\fR file) looks similar to the manifest file that is always included in a JAR file when the \f3jarsigner\fR command is used to sign the file\&. For each source file included in the JAR file, the \f3\&.SF\fR file has three lines, such as in the manifest file, that list the following: -.TP 0.2i -\(bu -File name -.TP 0.2i -\(bu -Name of the digest algorithm (SHA) -.TP 0.2i -\(bu -SHA digest value -.PP -In the manifest file, the SHA digest value for each source file is the digest (hash) of the binary data in the source file\&. In the \f3\&.SF\fR file, the digest value for a specified source file is the hash of the three lines in the manifest file for the source file\&. -.PP -The signature file, by default, includes a header with a hash of the whole manifest file\&. The header also contains a hash of the manifest header\&. The presence of the header enables verification optimization\&. See JAR File Verification\&. -.PP -Signature Block File - -The \f3\&.SF\fR 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 that authenticates the public key corresponding to the private key used for signing\&. The file has the extension \f3\&.DSA\fR, \f3\&.RSA\fR, or \f3\&.EC\fR, depending on the digest algorithm used\&. -.SS SIGNATURE\ TIME\ STAMP -The \f3jarsigner\fR command can generate and store a signature time stamp when signing a JAR file\&. In addition, \f3jarsigner\fR supports alternative signing mechanisms\&. This behavior is optional and is controlled by the user at the time of signing through these options\&. See Options\&. -.sp -.nf -\f3\-tsa \fIurl\fR\fP -.fi -.nf -\f3\-tsacert \fIalias\fR\fP -.fi -.nf -\f3\-altsigner \fIclass\fR\fP -.fi -.nf -\f3\-altsignerpath \fIclasspathlist\fR\fP -.fi -.nf -\f3\-tsapolicyid \fIpolicyid\fR\fP -.fi -.nf -\f3\fR -.fi -.sp -.SS JAR\ FILE\ VERIFICATION -A successful JAR file verification occurs when the signatures are valid, and none of the files that were in the JAR file when the signatures were generated have changed since then\&. JAR file verification involves the following steps: -.TP 0.4i -1\&. -Verify the signature of the \f3\&.SF\fR file\&. - -The verification ensures that the signature stored in each signature block (\f3\&.DSA\fR) file was generated using the private key corresponding to the public key whose certificate (or certificate chain) also appears in the \f3\&.DSA\fR file\&. It also ensures that the signature is a valid signature of the corresponding signature (\f3\&.SF\fR) file, and thus the \f3\&.SF\fR file was not tampered with\&. -.TP 0.4i -2\&. -Verify the digest listed in each entry in the \f3\&.SF\fR file with each corresponding section in the manifest\&. - -The \f3\&.SF\fR file by default includes a header that contains a hash of the entire manifest file\&. When the header is present, the verification can check to see whether or not the hash in the header matches the hash of the manifest file\&. If there is a match, then verification proceeds to the next step\&. - -If there is no match, then a less optimized verification is required to ensure that the hash in each source file information section in the \f3\&.SF\fR file equals the hash of its corresponding section in the manifest file\&. See Signature File\&. - -One reason the hash of the manifest file that is stored in the \f3\&.SF\fR file header might not equal the hash of the current manifest file is that one or more files were added to the JAR file (with the \f3jar\fR tool) after the signature and \f3\&.SF\fR file were generated\&. When the \f3jar\fR tool is used to add files, the manifest file is changed by adding sections to it for the new files, but the \f3\&.SF\fR file is not changed\&. A verification is still considered successful when none of the files that were in the JAR file when the signature was generated have been changed since then\&. This happens when the hashes in the non-header sections of the \f3\&.SF\fR file equal the hashes of the corresponding sections in the manifest file\&. -.TP 0.4i -3\&. -Read each file in the JAR file that has an entry in the \f3\&.SF\fR file\&. While reading, compute the file\&'s digest and compare the result with the digest for this file in the manifest section\&. The digests should be the same or verification fails\&. - -If any serious verification failures occur during the verification process, then the process is stopped and a security exception is thrown\&. The \f3jarsigner\fR command catches and displays the exception\&. -.PP -\fINote:\fR You should read any addition warnings (or errors if you specified the \f3-strict\fR option), as well as the content of the certificate (by specifying the \f3-verbose\fR and \f3-certs\fR options) to determine if the signature can be trusted\&. -.SS MULTIPLE\ SIGNATURES\ FOR\ A\ JAR\ FILE -A JAR file can be signed by multiple people by running the \f3jarsigner\fR command on the file multiple times and specifying the alias for a different person each time, as follows: -.sp -.nf -\f3jarsigner myBundle\&.jar susan\fP -.fi -.nf -\f3jarsigner myBundle\&.jar kevin\fP -.fi -.nf -\f3\fR -.fi -.sp -When a JAR file is signed multiple times, there are multiple \f3\&.SF\fR and \f3\&.DSA\fR files in the resulting JAR file, one pair for each signature\&. In the previous example, the output JAR file includes files with the following names: -.sp -.nf -\f3SUSAN\&.SF\fP -.fi -.nf -\f3SUSAN\&.DSA\fP -.fi -.nf -\f3KEVIN\&.SF\fP -.fi -.nf -\f3KEVIN\&.DSA\fP -.fi -.sp -.SH OPTIONS -The following sections describe the various \f3jarsigner\fR options\&. Be aware of the following standards: -.TP 0.2i -\(bu -All option names are preceded by a minus sign (-)\&. -.TP 0.2i -\(bu -The options can be provided in any order\&. -.TP 0.2i -\(bu -Items that are in italics or underlined (option values) represent the actual values that must be supplied\&. -.TP 0.2i -\(bu -The \f3-storepass\fR, \f3-keypass\fR, \f3-sigfile\fR, \f3-sigalg\fR, \f3-digestalg\fR, \f3-signedjar\fR, and TSA-related options are only relevant when signing a JAR file; they are not relevant when verifying a signed JAR file\&. The \f3-keystore\fR option is relevant for signing and verifying a JAR file\&. In addition, aliases are specified when signing and verifying a JAR file\&. -.TP --keystore \fIurl\fR -.br -Specifies the URL that tells the keystore location\&. This defaults to the file \f3\&.keystore\fR in the user\&'s home directory, as determined by the \f3user\&.home\fR system property\&. - -A keystore is required when signing\&. You must explicitly specify a keystore when the default keystore does not exist or if you want to use one other than the default\&. - -A keystore is not required when verifying, but if one is specified or the default exists and the \f3-verbose\fR option was also specified, then additional information is output regarding whether or not any of the certificates used to verify the JAR file are contained in that keystore\&. - -The \f3-keystore\fR argument can be a file name and path specification rather than a URL, in which case it is treated the same as a file: URL, for example, the following are equivalent: -.sp -.nf -\f3\-keystore \fIfilePathAndName\fR\fP -.fi -.nf -\f3\-keystore file:\fIfilePathAndName\fR\fP -.fi -.nf -\f3\fR -.fi -.sp - - -If the Sun PKCS #11 provider was configured in the \f3java\&.security\fR security properties file (located in the JRE\&'s \f3$JAVA_HOME/lib/security directory\fR), then the \f3keytool\fR and \f3jarsigner\fR tools can operate on the PKCS #11 token by specifying these options: -.sp -.nf -\f3\-keystore NONE\fP -.fi -.nf -\f3\-storetype PKCS11\fP -.fi -.nf -\f3\fR -.fi -.sp - - -For example, the following command lists the contents of the configured PKCS#11 token: -.sp -.nf -\f3keytool \-keystore NONE \-storetype PKCS11 \-list\fP -.fi -.nf -\f3\fR -.fi -.sp - -.TP --storetype \fIstoretype\fR -.br -Specifies the type of keystore to be instantiated\&. The default keystore type is the one that is specified as the value of the \f3keystore\&.type\fR property in the security properties file, which is returned by the static \f3getDefaultType\fR method in \f3java\&.security\&.KeyStore\fR\&. - -The PIN for a PCKS #11 token can also be specified with the \f3-storepass\fR option\&. If none is specified, then the \f3keytool\fR and \f3jarsigner\fR commands 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 \f3-protected\fR option must be specified and no password options can be specified\&. -.TP --storepass[:env | :file] \fIargument\fR -.br -Specifies the password that is required to access the keystore\&. This is only needed when signing (not verifying) a JAR file\&. In that case, if a \f3-storepass\fR option is not provided at the command line, then the user is prompted for the password\&. - -If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the value \fIargument\fR\&. Otherwise, the password is retrieved as follows: -.RS -.TP 0.2i -\(bu -\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. -.TP 0.2i -\(bu -\f3file\fR: Retrieve the password from the file named \f3argument\fR\&. -.RE - - -\fINote:\fR The password should not be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system\&. -.TP --keypass [:env | :file] \fIargument\fR -.br -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\fR to sign a JAR file\&. If no password is provided on the command line, and the required password is different from the store password, then the user is prompted for it\&. - -If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the value \f3argument\fR\&. Otherwise, the password is retrieved as follows: -.RS -.TP 0.2i -\(bu -\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. -.TP 0.2i -\(bu -\f3file\fR: Retrieve the password from the file named \f3argument\fR\&. -.RE - - -\fINote:\fR The password should not be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system\&. -.TP --sigfile \fIfile\fR -.br -Specifies the base file name to be used for the generated \f3\&.SF\fR and \f3\&.DSA\fR files\&. For example, if file is \f3DUKESIGN\fR, then the generated \f3\&.SF\fR and \f3\&.DSA\fR files are named \f3DUKESIGN\&.SF\fR and \f3DUKESIGN\&.DSA\fR, and placed in the \f3META-INF\fR directory of the signed JAR file\&. - -The characters in the file must come from the set \f3a-zA-Z0-9_-\fR\&. Only letters, numbers, underscore, and hyphen characters are allowed\&. All lowercase characters are converted to uppercase for the \f3\&.SF\fR and \f3\&.DSA\fR file names\&. - -If no \f3-sigfile\fR option appears on the command line, then the base file name for the \f3\&.SF\fR and \f3\&.DSA\fR files is 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, then the full alias name is used\&. If the alias name contains any characters that are not valid in a signature file name, then each such character is converted to an underscore (_) character to form the file name\&. -.TP --sigalg \fIalgorithm\fR -.br -Specifies the name of the signature algorithm to use to sign the JAR file\&. - -For a list of standard signature algorithm names, see "Appendix A: Standard Names" in the Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA - -This algorithm must be compatible with the private key used to sign the JAR file\&. If this option is not specified, then \f3SHA1withDSA\fR, \f3SHA256withRSA\fR, or \f3SHA256withECDSA\fR are 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 \f3-providerClass\fR option; otherwise, the command will not succeed\&. -.TP --digestalg \fIalgorithm\fR -.br -Specifies the name of the message digest algorithm to use when digesting the entries of a JAR file\&. - -For a list of standard message digest algorithm names, see "Appendix A: Standard Names" in the Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA - -If this option is not specified, then \f3SHA256\fR is used\&. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f3-providerClass\fR option; otherwise, the command will not succeed\&. -.TP --certs -.br -If the \f3-certs\fR option appears on the command line with the \f3-verify\fR and \f3-verbose\fR options, then the output includes certificate information for each signer of the JAR file\&. This information includes the name of the type of certificate (stored in the \f3\&.DSA\fR file) that certifies the signer\&'s public key, and if the certificate is an X\&.509 certificate (an instance of the \f3java\&.security\&.cert\&.X509Certificate\fR), then the distinguished name of the signer\&. - -The keystore is also examined\&. If no keystore value is specified on the command line, then the default keystore file (if any) is checked\&. If the public key certificate for a signer matches an entry in the keystore, then the alias name for the keystore entry for that signer is displayed in parentheses\&. -.TP --certchain \fIfile\fR -.br -Specifies the certificate chain to be used when the certificate chain associated with the private key of the keystore entry that is addressed by the alias specified on the command line is not complete\&. This can happen when the keystore is located on a hardware token where there is not enough capacity to hold a complete certificate chain\&. The file can be a sequence of concatenated X\&.509 certificates, or a single PKCS#7 formatted data block, either in binary encoding format or in printable encoding format (also known as Base64 encoding) as defined by the Internet RFC 1421 standard\&. See Internet RFC 1421 Certificate Encoding Standard and http://tools\&.ietf\&.org/html/rfc1421\&. -.TP --verbose -.br -When the \f3-verbose\fR option appears on the command line, it indicates verbose mode, which causes \f3jarsigner\fR to output extra information about the progress of the JAR signing or verification\&. -.TP --internalsf -.br -In the past, the \f3\&.DSA\fR (signature block) file generated when a JAR file was signed included a complete encoded copy of the \f3\&.SF\fR file (signature file) also generated\&. This behavior has been changed\&. To reduce the overall size of the output JAR file, the \f3\&.DSA\fR file by default does not contain a copy of the \f3\&.SF\fR file anymore\&. If \f3-internalsf\fR appears on the command line, then the old behavior is utilized\&. This option is useful for testing\&. In practice, do not use the \f3-internalsf\fR option because it incurs higher overhead\&. -.TP --sectionsonly -.br -If the \f3-sectionsonly\fR option appears on the command line, then the \f3\&.SF\fR file (signature file) generated when a JAR file is signed does not include a header that contains a hash of the whole manifest file\&. It contains only the information and hashes related to each individual source file included in the JAR file\&. See Signature File\&. - -By default, this header is added, as an optimization\&. When the header is present, whenever the JAR file is verified, the verification can first check to see whether the hash in the header matches the hash of the whole manifest file\&. When there is a match, verification proceeds to the next step\&. When there is no match, it is necessary to do a less optimized verification that the hash in each source file information section in the \f3\&.SF\fR file equals the hash of its corresponding section in the manifest file\&. See JAR File Verification\&. - -The \f3-sectionsonly\fR option is primarily used for testing\&. It should not be used other than for testing because using it incurs higher overhead\&. -.TP --protected -.br -Values can be either \f3true\fR or \f3false\fR\&. Specify \f3true\fR when a password must be specified through a protected authentication path such as a dedicated PIN reader\&. -.TP --providerClass \fIprovider-class-name\fR -.br -Used to specify the name of cryptographic service provider\&'s master class file when the service provider is not listed in the \f3java\&.security\fR security properties file\&. - -Used with the \f3-providerArg ConfigFilePath\fR option, the \f3keytool\fR and \f3jarsigner\fR tools install the provider dynamically and use \fIConfigFilePath\fR for the path to the token configuration file\&. The following example shows a command to list a \f3PKCS #11\fR keystore when the Oracle PKCS #11 provider was not configured in the security properties file\&. -.sp -.nf -\f3jarsigner \-keystore NONE \-storetype PKCS11 \e\fP -.fi -.nf -\f3 \-providerClass sun\&.security\&.pkcs11\&.SunPKCS11 \e\fP -.fi -.nf -\f3 \-providerArg /mydir1/mydir2/token\&.config \e\fP -.fi -.nf -\f3 \-list\fP -.fi -.nf -\f3\fR -.fi -.sp - -.TP --providerName \fIproviderName\fR -.br -If more than one provider was configured in the \f3java\&.security\fR security properties file, then you can use the \f3-providerName\fR option to target a specific provider instance\&. The argument to this option is the name of the provider\&. - -For the Oracle PKCS #11 provider, \fIproviderName\fR is of the form \f3SunPKCS11-\fR\fITokenName\fR, where \fITokenName\fR is the name suffix that the provider instance has been configured with, as detailed in the configuration attributes table\&. For example, the following command lists the contents of the \f3PKCS #11\fR keystore provider instance with name suffix \f3SmartCard\fR: -.sp -.nf -\f3jarsigner \-keystore NONE \-storetype PKCS11 \e\fP -.fi -.nf -\f3 \-providerName SunPKCS11\-SmartCard \e\fP -.fi -.nf -\f3 \-list\fP -.fi -.nf -\f3\fR -.fi -.sp - -.TP --J\fIjavaoption\fR -.br -Passes through the specified \fIjavaoption\fR string directly to the Java interpreter\&. The \f3jarsigner\fR command is 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 \f3java -h\fR or \f3java -X\fR at the command line\&. -.TP --tsa \fIurl\fR -.br -If \f3-tsa http://example\&.tsa\&.url\fR appears on the command line when signing a JAR file then a time stamp is generated for the signature\&. The URL, \f3http://example\&.tsa\&.url\fR, identifies the location of the Time Stamping Authority (TSA) and overrides any URL found with the \f3-tsacert\fR option\&. The \f3-tsa\fR option does not require the TSA public key certificate to be present in the keystore\&. - -To generate the time stamp, \f3jarsigner\fR communicates with the TSA with the Time-Stamp Protocol (TSP) defined in RFC 3161\&. When successful, the time stamp token returned by the TSA is stored with the signature in the signature block file\&. -.TP --tsacert \fIalias\fR -.br -When \f3-tsacert alias\fR appears on the command line when signing a JAR file, a time stamp is generated for the signature\&. The alias identifies the TSA public key certificate in the keystore that is in effect\&. The entry\&'s certificate is examined for a Subject Information Access extension that contains a URL identifying the location of the TSA\&. - -The TSA public key certificate must be present in the keystore when using the \f3-tsacert\fR option\&. -.TP --tsapolicyid \fIpolicyid\fR -.br -Specifies the object identifier (OID) that identifies the policy ID to be sent to the TSA server\&. If this option is not specified, no policy ID is sent and the TSA server will choose a default policy ID\&. - -Object identifiers are defined by X\&.696, which is an ITU Telecommunication Standardization Sector (ITU-T) standard\&. These identifiers are typically period-separated sets of non-negative digits like \f31\&.2\&.3\&.4\fR, for example\&. -.TP --altsigner \fIclass\fR -.br -This option specifies an alternative signing mechanism\&. The fully qualified class name identifies a class file that extends the \f3com\&.sun\&.jarsigner\&.ContentSigner\fR abstract class\&. The path to this class file is defined by the \f3-altsignerpath\fR option\&. If the \f3-altsigner\fR option is used, then the \f3jarsigner\fR command uses the signing mechanism provided by the specified class\&. Otherwise, the \f3jarsigner\fR command uses its default signing mechanism\&. - -For example, to use the signing mechanism provided by a class named \f3com\&.sun\&.sun\&.jarsigner\&.AuthSigner\fR, use the jarsigner option \f3-altsigner com\&.sun\&.jarsigner\&.AuthSigner\fR\&. -.TP --altsignerpath \fIclasspathlist\fR -.br -Specifies the path to the class file and any JAR file it depends on\&. The class file name is specified with the \f3-altsigner\fR option\&. If the class file is in a JAR file, then this option specifies the path to that JAR file\&. - -An absolute path or a path relative to the current directory can be specified\&. If \fIclasspathlist\fR contains multiple paths or JAR files, then they should be separated with a colon (:) on Oracle Solaris and a semicolon (;) on Windows\&. This option is not necessary when the class is already in the search path\&. - -The following example shows how to specify the path to a JAR file that contains the class file\&. The JAR file name is included\&. -.sp -.nf -\f3\-altsignerpath /home/user/lib/authsigner\&.jar\fP -.fi -.nf -\f3\fR -.fi -.sp - - -The following example shows how to specify the path to the JAR file that contains the class file\&. The JAR file name is omitted\&. -.sp -.nf -\f3\-altsignerpath /home/user/classes/com/sun/tools/jarsigner/\fP -.fi -.nf -\f3\fR -.fi -.sp - -.TP --strict -.br -During the signing or verifying process, the command may issue warning messages\&. If you specify this option, the exit code of the tool reflects the severe warning messages that this command found\&. See Errors and Warnings\&. -.TP --verbose \fIsuboptions\fR -.br -For the verifying process, the \f3-verbose\fR option takes suboptions to determine how much information is shown\&. If the \f3-certs\fR option is also specified, then the default mode (or suboption \f3all\fR) displays each entry as it is being processed, and after that, the certificate information for each signer of the JAR file\&. If the \f3-certs\fR and the \f3-verbose:grouped\fR suboptions are specified, then entries with the same signer info are grouped and displayed together with their certificate information\&. If \f3-certs\fR and the \f3-verbose:summary\fR suboptions are specified, then entries with the same signer information are grouped and displayed together with their certificate information\&. Details about each entry are summarized and displayed as \fIone entry (and more)\fR\&. See Examples\&. -.SH ERRORS\ AND\ WARNINGS -During the signing or verifying process, the \f3jarsigner\fR command may issue various errors or warnings\&. -.PP -If there is a failure, the \f3jarsigner\fR command exits with code 1\&. If there is no failure, but there are one or more severe warnings, the \f3jarsigner\fR command exits with code 0 when the \f3-strict\fR option is \fInot\fR specified, or exits with the OR-value of the warning codes when the \f3-strict\fR is specified\&. If there is only informational warnings or no warning at all, the command always exits with code 0\&. -.PP -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, the \f3jarsigner\fR command exits with code 12 (=4+8) when the \f3-strict\fR option is specified\&. -.PP -\fINote:\fR Exit codes are reused because only the values from 0 to 255 are legal on Unix-based operating systems\&. -.PP -The following sections describes the names, codes, and descriptions of the errors and warnings that the \f3jarsigner\fR command can issue\&. -.SS FAILURE -Reasons why the \f3jarsigner\fR command fails include (but are not limited to) a command line parsing error, the inability to find a keypair to sign the JAR file, or the verification of a signed JAR fails\&. -.TP -failure -Code 1\&. The signing or verifying fails\&. -.SS SEVERE\ WARNINGS -\fINote:\fR Severe warnings are reported as errors if you specify the \f3-strict\fR option\&. -.PP -Reasons why the \f3jarsigner\fR command issues a severe warning include the certificate used to sign the JAR file has an error or the signed JAR file has other problems\&. -.TP -hasExpiredCert -Code 4\&. This jar contains entries whose signer certificate has expired\&. -.TP -notYetValidCert -Code 4\&. This jar contains entries whose signer certificate is not yet valid\&. -.TP -chainNotValidated -Code 4\&. This jar contains entries whose certificate chain cannot be correctly validated\&. -.TP -badKeyUsage -Code 8\&. This jar contains entries whose signer certificate\&'s KeyUsage extension doesn\&'t allow code signing\&. -.TP -badExtendedKeyUsage -Code 8\&. This jar contains entries whose signer certificate\&'s ExtendedKeyUsage extension doesn\&'t allow code signing\&. -.TP -badNetscapeCertType -Code 8\&. This jar contains entries whose signer certificate\&'s NetscapeCertType extension doesn\&'t allow code signing\&. -.TP -hasUnsignedEntry -Code 16\&. This jar contains unsigned entries which have not been integrity-checked\&. -.TP -notSignedByAlias -Code 32\&. This jar contains signed entries which are not signed by the specified alias(es)\&. -.TP -aliasNotInStore -Code 32\&. This jar contains signed entries that are not signed by alias in this keystore\&. -.SS INFORMATIONAL\ WARNINGS -Informational warnings include those that are not errors but regarded as bad practice\&. They do not have a code\&. -.TP -hasExpiringCert -This jar contains entries whose signer certificate will expire within six months\&. -.TP -noTimestamp -This jar contains signatures that does not include a timestamp\&. Without a timestamp, users may not be able to validate this JAR file after the signer certificate\&'s expiration date (\f3YYYY-MM-DD\fR) or after any future revocation date\&. -.SH EXAMPLES -.SS SIGN\ A\ JAR\ FILE -Use the following command to sign bundle\&.jar with the private key of a user whose keystore alias is \f3jane\fR in a keystore named \f3mystore\fR in the \f3working\fR directory and name the signed JAR file \f3sbundle\&.jar\fR: -.sp -.nf -\f3jarsigner \-keystore /working/mystore\fP -.fi -.nf -\f3 \-storepass <keystore password>\fP -.fi -.nf -\f3 \-keypass <private key password>\fP -.fi -.nf -\f3 \-signedjar sbundle\&.jar bundle\&.jar jane\fP -.fi -.nf -\f3\fR -.fi -.sp -There is no \f3-sigfile\fR specified in the previous command so the generated \f3\&.SF\fR and \f3\&.DSA\fR files to be placed in the signed JAR file have default names based on the alias name\&. They are named \f3JANE\&.SF\fR and \f3JANE\&.DSA\fR\&. -.PP -If you want to be prompted for the store password and the private key password, then you could shorten the previous command to the following: -.sp -.nf -\f3jarsigner \-keystore /working/mystore\fP -.fi -.nf -\f3 \-signedjar sbundle\&.jar bundle\&.jar jane\fP -.fi -.nf -\f3\fR -.fi -.sp -If the keystore is the default keystore (\&.keystore in your home directory), then you do not need to specify a keystore, as follows: -.sp -.nf -\f3jarsigner \-signedjar sbundle\&.jar bundle\&.jar jane\fP -.fi -.nf -\f3\fR -.fi -.sp -If you want the signed JAR file to overwrite the input JAR file (bundle\&.jar), then you do not need to specify a \f3-signedjar\fR option, as follows: -.sp -.nf -\f3jarsigner bundle\&.jar jane\fP -.fi -.nf -\f3\fR -.fi -.sp -.SS VERIFY\ A\ SIGNED\ JAR\ FILE -To verify a signed JAR file to ensure that the signature is valid and the JAR file was not been tampered with, use a command such as the following: -.sp -.nf -\f3jarsigner \-verify sbundle\&.jar\fP -.fi -.nf -\f3\fR -.fi -.sp -When the verification is successful, \f3jar verified\fR is displayed\&. Otherwise, an error message is displayed\&. You can get more information when you use the \f3-verbose\fR option\&. A sample use of \f3jarsigner\fR with the\f3-verbose\fR option follows: -.sp -.nf -\f3jarsigner \-verify \-verbose sbundle\&.jar\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST\&.MF\fP -.fi -.nf -\f3 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.SF\fP -.fi -.nf -\f3 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.DSA\fP -.fi -.nf -\f3 smk 2752 Fri Sep 26 16:12:30 PDT 1997 AclEx\&.class\fP -.fi -.nf -\f3 smk 849 Fri Sep 26 16:12:46 PDT 1997 test\&.class\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3 s = signature was verified\fP -.fi -.nf -\f3 m = entry is listed in manifest\fP -.fi -.nf -\f3 k = at least one certificate was found in keystore\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3 jar verified\&.\fP -.fi -.nf -\f3\fR -.fi -.sp -.SS VERIFICATION\ WITH\ CERTIFICATE\ INFORMATION -If you specify the \f3-certs\fR option with the \f3-verify\fR and \f3-verbose\fR options, then the output includes certificate information for each signer of the JAR file\&. The information includes the certificate type, the signer distinguished name information (when it is an X\&.509 certificate), and in parentheses, the keystore alias for the signer when the public key certificate in the JAR file matches the one in a keystore entry, for example: -.sp -.nf -\f3jarsigner \-keystore /working/mystore \-verify \-verbose \-certs myTest\&.jar\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST\&.MF\fP -.fi -.nf -\f3 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.SF\fP -.fi -.nf -\f3 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.DSA\fP -.fi -.nf -\f3 208 Fri Sep 26 16:23:30 PDT 1997 META\-INF/JAVATEST\&.SF\fP -.fi -.nf -\f3 1087 Fri Sep 26 16:23:30 PDT 1997 META\-INF/JAVATEST\&.DSA\fP -.fi -.nf -\f3 smk 2752 Fri Sep 26 16:12:30 PDT 1997 Tst\&.class\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3 X\&.509, CN=Test Group, OU=Java Software, O=Oracle, L=CUP, S=CA, C=US (javatest)\fP -.fi -.nf -\f3 X\&.509, CN=Jane Smith, OU=Java Software, O=Oracle, L=cup, S=ca, C=us (jane)\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3 s = signature was verified\fP -.fi -.nf -\f3 m = entry is listed in manifest\fP -.fi -.nf -\f3 k = at least one certificate was found in keystore\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3 jar verified\&.\fP -.fi -.nf -\f3\fR -.fi -.sp -If the certificate for a signer is not an X\&.509 certificate, then there is no distinguished name information\&. In that case, just the certificate type and the alias are shown\&. For example, if the certificate is a PGP certificate, and the alias is \f3bob\fR, then you would get: \f3PGP, (bob)\fR\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -jar(1) -.TP 0.2i -\(bu -keytool(1) -.TP 0.2i -\(bu -Trail: Security Features in Java SE at http://docs\&.oracle\&.com/javase/tutorial/security/index\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1998, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Security Tools +.\" Title: jarsigner.1 +.\" +.if n .pl 99999 +.TH jarsigner 1 "21 November 2013" "JDK 8" "Security Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jarsigner \- Signs and verifies Java Archive (JAR) files\&. +.SH SYNOPSIS +.sp +.nf + +\fBjarsigner\fR [ \fIoptions\fR ] \fIjar\-file\fR \fIalias\fR +.fi +.nf + +\fBjarsigner\fR \fB\-verify\fR [ \fIoptions\fR ] \fIjar\-file\fR [\fIalias \&.\&.\&.\fR] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +-verify +.br +The \f3-verify\fR option can take zero or more keystore alias names after the JAR file name\&. When the \f3-verify\fR option is specified, the \f3jarsigner\fR command checks 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 \f3-keystore\fR or the default keystore\&. + +If you also specified the \f3-strict\fR option, and the \f3jarsigner\fR command detected severe warnings, the message, "jar verified, with signer errors" is displayed\&. +.TP +\fIjar-file\fR +The JAR file to be signed\&. + +If you also specified the \f3-strict\fR option, and the \f3jarsigner\fR command detected severe warnings, the message, "jar signed, with signer errors" is displayed\&. +.TP +\fIalias\fR +The aliases are defined in the keystore specified by \f3-keystore\fR or the default keystore\&. +.SH DESCRIPTION +The \f3jarsigner\fR tool has two purposes: +.TP 0.2i +\(bu +To sign Java Archive (JAR) files\&. +.TP 0.2i +\(bu +To verify the signatures and integrity of signed JAR files\&. +.PP +The JAR feature enables the packaging of class files, images, sounds, and other digital data in a single file for faster and easier distribution\&. A tool named \f3jar\fR enables developers to produce JAR files\&. (Technically, any zip file can also be considered a JAR file, although when created by the \f3jar\fR command or processed by the \f3jarsigner\fR command, JAR files also contain a \f3META-INF/MANIFEST\&.MF\fR file\&.) +.PP +A digital signature is a string of bits that is computed from some data (the data being signed) and the private key of an entity (a person, company, and so on)\&. Similar to a handwritten signature, a digital signature has many useful characteristics: +.TP 0.2i +\(bu +Its authenticity can be verified by a computation that uses the public key corresponding to the private key used to generate the signature\&. +.TP 0.2i +\(bu +It cannot be forged, assuming the private key is kept secret\&. +.TP 0.2i +\(bu +It is a function of the data signed and thus cannot be claimed to be the signature for other data as well\&. +.TP 0.2i +\(bu +The signed data cannot be changed\&. If the data is changed, then the signature cannot be verified as authentic\&. +.PP +To generate an entity\&'s signature for a file, the entity must first have a public/private key pair associated with it and one or more certificates that authenticate its public key\&. A certificate is a digitally signed statement from one entity that says that the public key of another entity has a particular value\&. +.PP +The \f3jarsigner\fR command uses key and certificate information from a keystore to generate digital signatures for JAR files\&. A keystore is a database of private keys and their associated X\&.509 certificate chains that authenticate the corresponding public keys\&. The \f3keytool\fR command is used to create and administer keystores\&. +.PP +The \f3jarsigner\fR command uses an entity\&'s private key to generate a signature\&. The signed JAR file contains, among other things, a copy of the certificate from the keystore for the public key corresponding to the private key used to sign the file\&. The \f3jarsigner\fR command can verify the digital signature of the signed JAR file using the certificate inside it (in its signature block file)\&. +.PP +The \f3jarsigner\fR command can generate signatures that include a time stamp that lets a systems or deployer (including Java Plug-in) to check whether the JAR file was signed while the signing certificate was still valid\&. In addition, APIs allow applications to obtain the timestamp information\&. +.PP +At this time, the \f3jarsigner\fR command can only sign JAR files created by the \f3jar\fR command or zip files\&. JAR files are the same as zip files, except they also have a \f3META-INF/MANIFEST\&.MF\fR file\&. A \f3META-INF/MANIFEST\&.MF\fR file is created when the \f3jarsigner\fR command signs a zip file\&. +.PP +The default \f3jarsigner\fR command behavior is to sign a JAR or zip file\&. Use the \f3-verify\fR option to verify a signed JAR file\&. +.PP +The \f3jarsigner\fR command also attempts to validate the signer\&'s certificate after signing or verifying\&. If there is a validation error or any other problem, the command generates warning messages\&. If you specify the \f3-strict\fR option, then the command treats severe warnings as errors\&. See Errors and Warnings\&. +.SS KEYSTORE\ ALIASES +All keystore entities are accessed with unique aliases\&. +.PP +When you use the \f3jarsigner\fR command to sign a JAR file, you must specify the alias for the keystore entry that contains the private key needed to generate the signature\&. For example, the following command signs the JAR file named \f3MyJARFile\&.jar\fR with the private key associated with the alias \f3duke\fR in the keystore named \f3mystore\fR in the \f3working\fR directory\&. Because no output file is specified, it overwrites \f3MyJARFile\&.jar\fR with the signed JAR file\&. +.sp +.nf +\f3jarsigner \-keystore /working/mystore \-storepass <keystore password>\fP +.fi +.nf +\f3 \-keypass <private key password> MyJARFile\&.jar duke\fP +.fi +.nf +\f3\fR +.fi +.sp +Keystores are protected with a password, so the store password must be specified\&. You are prompted for it when you do not 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 are prompted for the password when you do not specify it on the command line and it is not the same as the store password\&. +.SS KEYSTORE\ LOCATION +The \f3jarsigner\fR command has a \f3-keystore\fR option for specifying the URL of the keystore to be used\&. The keystore is by default stored in a file named \f3\&.keystore\fR in the user\&'s home directory, as determined by the \f3user\&.home\fR system property\&. +.PP +On Oracle Solaris systems, \f3user\&.home\fR defaults to the user\&'s home directory\&. +.PP +The input stream from the \f3-keystore\fR option is passed to the \f3KeyStore\&.load\fR method\&. If \f3NONE\fR is specified as the URL, then a null stream is passed to the \f3KeyStore\&.load\fR method\&. \f3NONE\fR should be specified when the \f3KeyStore\fR class is not file based, for example, when it resides on a hardware token device\&. +.SS KEYSTORE\ IMPLEMENTATION +The \f3KeyStore\fR class provided in the \f3java\&.security\fR package supplies a number of well-defined interfaces to access and modify the information in a keystore\&. You can have multiple different concrete implementations, where each implementation is for a particular type of keystore\&. +.PP +Currently, there are two command-line tools that use keystore implementations (\f3keytool\fR and \f3jarsigner\fR), and a GUI-based tool named Policy Tool\&. Because the \f3KeyStore\fR class is publicly available, JDK users can write additional security applications that use it\&. +.PP +There is a built-in default implementation provided by Oracle that implements the keystore as a file, that uses a proprietary keystore type (format) named JKS\&. The built-in implementation protects each private key with its individual password and protects the integrity of the entire keystore with a (possibly different) password\&. +.PP +Keystore implementations are provider-based, which means the application interfaces supplied by the \f3KeyStore\fR class are implemented in terms of a Service Provider Interface (SPI)\&. There is a corresponding abstract \f3KeystoreSpi\fR class, also in the \f3java\&.security package\fR, that defines the Service Provider Interface methods that providers must implement\&. The term provider refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API\&. To provide a keystore implementation, clients must implement a provider and supply a \f3KeystoreSpi\fR subclass implementation, as described in How to Implement a Provider in the Java Cryptography Architecture at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/HowToImplAProvider\&.html +.PP +Applications can choose different types of keystore implementations from different providers, with the \f3getInstance\fR factory method in the \f3KeyStore\fR 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\&. +.PP +The \f3jarsigner\fR and \f3policytool\fR commands can read file-based keystores from any location that can be specified using a URL\&. In addition, these commands can read non-file-based keystores such as those provided by MSCAPI on Windows and PKCS11 on all platforms\&. +.PP +For the \f3jarsigner\fR and \f3keytool\fR commands, you can specify a keystore type at the command line with the \f3-storetype\fR option\&. For Policy Tool, you can specify a keystore type with the \fIEdit\fR command in the \fIKeyStore\fR menu\&. +.PP +If you do not explicitly specify a keystore type, then the tools choose a keystore implementation based on the value of the \f3keystore\&.type\fR property specified in the security properties file\&. The security properties file is called \f3java\&.security\fR, and it resides in the JDK security properties directory, \f3java\&.home/lib/security\fR, where \f3java\&.home\fR is the runtime environment\&'s directory\&. The \f3jre\fR directory in the JDK or the top-level directory of the Java Runtime Environment (JRE)\&. +.PP +Each tool gets the \f3keystore\&.type\fR value and then examines all the installed providers until it finds one that implements keystores of that type\&. It then uses the keystore implementation from that provider\&. +.PP +The \f3KeyStore\fR class defines a static method named \f3getDefaultType\fR that lets applications and applets retrieve the value of the \f3keystore\&.type\fR property\&. The following line of code creates an instance of the default keystore type as specified in the \f3keystore\&.type property\fR: +.sp +.nf +\f3KeyStore keyStore = KeyStore\&.getInstance(KeyStore\&.getDefaultType());\fP +.fi +.nf +\f3\fR +.fi +.sp +The default keystore type is \f3jks\fR (the proprietary type of the keystore implementation provided by Oracle)\&. This is specified by the following line in the security properties file: +.sp +.nf +\f3keystore\&.type=jks\fP +.fi +.nf +\f3\fR +.fi +.sp +Case does not matter in keystore type designations\&. For example, \f3JKS\fR is the same as \f3jks\fR\&. +.PP +To have the tools use a keystore implementation other than the default, change that line to specify a different keystore type\&. For example, if you have a provider package that supplies a keystore implementation for a keystore type called \f3pkcs12\fR, then change the line to the following: +.sp +.nf +\f3keystore\&.type=pkcs12\fP +.fi +.nf +\f3\fR +.fi +.sp +\fINote:\fR If you use the PKCS 11 provider package, then see "KeyTool" and "JarSigner" in Java PKCS #11 Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/p11guide\&.html +.SS SUPPORTED\ ALGORITHMS +By default, the \f3jarsigner\fR command signs a JAR file using one of the following algorithms: +.TP 0.2i +\(bu +Digital Signature Algorithm (DSA) with the SHA1 digest algorithm +.TP 0.2i +\(bu +RSA algorithm with the SHA256 digest algorithm +.TP 0.2i +\(bu +Elliptic Curve (EC) cryptography algorithm with the SHA256 with Elliptic Curve Digital Signature Algorithm (ECDSA)\&. +.PP +If the signer\&'s public and private keys are DSA keys, then \f3jarsigner\fR signs the JAR file with the \f3SHA1withDSA\fR algorithm\&. If the signer\&'s keys are RSA keys, then \f3jarsigner\fR attempts to sign the JAR file with the \f3SHA256withRSA\fR algorithm\&. If the signer\&'s keys are EC keys, then \f3jarsigner\fR signs the JAR file with the \f3SHA256withECDSA\fR algorithm\&. +.PP +These default signature algorithms can be overridden using the \f3-sigalg\fR option\&. +.SS THE\ SIGNED\ JAR\ FILE +When the \f3jarsigner\fR command 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: +.TP 0.2i +\(bu +A signature file with an \f3\&.SF\fR extension +.TP 0.2i +\(bu +A signature block file with a \f3\&.DSA\fR, \f3\&.RSA\fR, or \f3\&.EC\fR extension +.PP +The base file names for these two files come from the value of the \f3-sigFile\fR option\&. For example, when the option is \f3-sigFile MKSIGN\fR, the files are named \f3MKSIGN\&.SF\fR and \f3MKSIGN\&.DSA\fR +.PP +If no \f3-sigfile\fR option appears on the command line, then the base file name for the \f3\&.SF\fR and \f3\&.DSA\fR files is the first 8 characters of the alias name specified on the command line, all converted to uppercase\&. If the alias name has fewer than 8 characters, then the full alias name is used\&. If the alias name contains any characters that are not allowed in a signature file name, then each such character is converted to an underscore (_) character in forming the file name\&. Valid characters include letters, digits, underscores, and hyphens\&. +.PP +Signature File + +A signature file (\f3\&.SF\fR file) looks similar to the manifest file that is always included in a JAR file when the \f3jarsigner\fR command is used to sign the file\&. For each source file included in the JAR file, the \f3\&.SF\fR file has three lines, such as in the manifest file, that list the following: +.TP 0.2i +\(bu +File name +.TP 0.2i +\(bu +Name of the digest algorithm (SHA) +.TP 0.2i +\(bu +SHA digest value +.PP +In the manifest file, the SHA digest value for each source file is the digest (hash) of the binary data in the source file\&. In the \f3\&.SF\fR file, the digest value for a specified source file is the hash of the three lines in the manifest file for the source file\&. +.PP +The signature file, by default, includes a header with a hash of the whole manifest file\&. The header also contains a hash of the manifest header\&. The presence of the header enables verification optimization\&. See JAR File Verification\&. +.PP +Signature Block File + +The \f3\&.SF\fR 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 that authenticates the public key corresponding to the private key used for signing\&. The file has the extension \f3\&.DSA\fR, \f3\&.RSA\fR, or \f3\&.EC\fR, depending on the digest algorithm used\&. +.SS SIGNATURE\ TIME\ STAMP +The \f3jarsigner\fR command can generate and store a signature time stamp when signing a JAR file\&. In addition, \f3jarsigner\fR supports alternative signing mechanisms\&. This behavior is optional and is controlled by the user at the time of signing through these options\&. See Options\&. +.sp +.nf +\f3\-tsa \fIurl\fR\fP +.fi +.nf +\f3\-tsacert \fIalias\fR\fP +.fi +.nf +\f3\-altsigner \fIclass\fR\fP +.fi +.nf +\f3\-altsignerpath \fIclasspathlist\fR\fP +.fi +.nf +\f3\-tsapolicyid \fIpolicyid\fR\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS JAR\ FILE\ VERIFICATION +A successful JAR file verification occurs when the signatures are valid, and none of the files that were in the JAR file when the signatures were generated have changed since then\&. JAR file verification involves the following steps: +.TP 0.4i +1\&. +Verify the signature of the \f3\&.SF\fR file\&. + +The verification ensures that the signature stored in each signature block (\f3\&.DSA\fR) file was generated using the private key corresponding to the public key whose certificate (or certificate chain) also appears in the \f3\&.DSA\fR file\&. It also ensures that the signature is a valid signature of the corresponding signature (\f3\&.SF\fR) file, and thus the \f3\&.SF\fR file was not tampered with\&. +.TP 0.4i +2\&. +Verify the digest listed in each entry in the \f3\&.SF\fR file with each corresponding section in the manifest\&. + +The \f3\&.SF\fR file by default includes a header that contains a hash of the entire manifest file\&. When the header is present, the verification can check to see whether or not the hash in the header matches the hash of the manifest file\&. If there is a match, then verification proceeds to the next step\&. + +If there is no match, then a less optimized verification is required to ensure that the hash in each source file information section in the \f3\&.SF\fR file equals the hash of its corresponding section in the manifest file\&. See Signature File\&. + +One reason the hash of the manifest file that is stored in the \f3\&.SF\fR file header might not equal the hash of the current manifest file is that one or more files were added to the JAR file (with the \f3jar\fR tool) after the signature and \f3\&.SF\fR file were generated\&. When the \f3jar\fR tool is used to add files, the manifest file is changed by adding sections to it for the new files, but the \f3\&.SF\fR file is not changed\&. A verification is still considered successful when none of the files that were in the JAR file when the signature was generated have been changed since then\&. This happens when the hashes in the non-header sections of the \f3\&.SF\fR file equal the hashes of the corresponding sections in the manifest file\&. +.TP 0.4i +3\&. +Read each file in the JAR file that has an entry in the \f3\&.SF\fR file\&. While reading, compute the file\&'s digest and compare the result with the digest for this file in the manifest section\&. The digests should be the same or verification fails\&. + +If any serious verification failures occur during the verification process, then the process is stopped and a security exception is thrown\&. The \f3jarsigner\fR command catches and displays the exception\&. +.PP +\fINote:\fR You should read any addition warnings (or errors if you specified the \f3-strict\fR option), as well as the content of the certificate (by specifying the \f3-verbose\fR and \f3-certs\fR options) to determine if the signature can be trusted\&. +.SS MULTIPLE\ SIGNATURES\ FOR\ A\ JAR\ FILE +A JAR file can be signed by multiple people by running the \f3jarsigner\fR command on the file multiple times and specifying the alias for a different person each time, as follows: +.sp +.nf +\f3jarsigner myBundle\&.jar susan\fP +.fi +.nf +\f3jarsigner myBundle\&.jar kevin\fP +.fi +.nf +\f3\fR +.fi +.sp +When a JAR file is signed multiple times, there are multiple \f3\&.SF\fR and \f3\&.DSA\fR files in the resulting JAR file, one pair for each signature\&. In the previous example, the output JAR file includes files with the following names: +.sp +.nf +\f3SUSAN\&.SF\fP +.fi +.nf +\f3SUSAN\&.DSA\fP +.fi +.nf +\f3KEVIN\&.SF\fP +.fi +.nf +\f3KEVIN\&.DSA\fP +.fi +.sp +.SH OPTIONS +The following sections describe the various \f3jarsigner\fR options\&. Be aware of the following standards: +.TP 0.2i +\(bu +All option names are preceded by a minus sign (-)\&. +.TP 0.2i +\(bu +The options can be provided in any order\&. +.TP 0.2i +\(bu +Items that are in italics or underlined (option values) represent the actual values that must be supplied\&. +.TP 0.2i +\(bu +The \f3-storepass\fR, \f3-keypass\fR, \f3-sigfile\fR, \f3-sigalg\fR, \f3-digestalg\fR, \f3-signedjar\fR, and TSA-related options are only relevant when signing a JAR file; they are not relevant when verifying a signed JAR file\&. The \f3-keystore\fR option is relevant for signing and verifying a JAR file\&. In addition, aliases are specified when signing and verifying a JAR file\&. +.TP +-keystore \fIurl\fR +.br +Specifies the URL that tells the keystore location\&. This defaults to the file \f3\&.keystore\fR in the user\&'s home directory, as determined by the \f3user\&.home\fR system property\&. + +A keystore is required when signing\&. You must explicitly specify a keystore when the default keystore does not exist or if you want to use one other than the default\&. + +A keystore is not required when verifying, but if one is specified or the default exists and the \f3-verbose\fR option was also specified, then additional information is output regarding whether or not any of the certificates used to verify the JAR file are contained in that keystore\&. + +The \f3-keystore\fR argument can be a file name and path specification rather than a URL, in which case it is treated the same as a file: URL, for example, the following are equivalent: +.sp +.nf +\f3\-keystore \fIfilePathAndName\fR\fP +.fi +.nf +\f3\-keystore file:\fIfilePathAndName\fR\fP +.fi +.nf +\f3\fR +.fi +.sp + + +If the Sun PKCS #11 provider was configured in the \f3java\&.security\fR security properties file (located in the JRE\&'s \f3$JAVA_HOME/lib/security directory\fR), then the \f3keytool\fR and \f3jarsigner\fR tools can operate on the PKCS #11 token by specifying these options: +.sp +.nf +\f3\-keystore NONE\fP +.fi +.nf +\f3\-storetype PKCS11\fP +.fi +.nf +\f3\fR +.fi +.sp + + +For example, the following command lists the contents of the configured PKCS#11 token: +.sp +.nf +\f3keytool \-keystore NONE \-storetype PKCS11 \-list\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-storetype \fIstoretype\fR +.br +Specifies the type of keystore to be instantiated\&. The default keystore type is the one that is specified as the value of the \f3keystore\&.type\fR property in the security properties file, which is returned by the static \f3getDefaultType\fR method in \f3java\&.security\&.KeyStore\fR\&. + +The PIN for a PCKS #11 token can also be specified with the \f3-storepass\fR option\&. If none is specified, then the \f3keytool\fR and \f3jarsigner\fR commands 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 \f3-protected\fR option must be specified and no password options can be specified\&. +.TP +-storepass[:env | :file] \fIargument\fR +.br +Specifies the password that is required to access the keystore\&. This is only needed when signing (not verifying) a JAR file\&. In that case, if a \f3-storepass\fR option is not provided at the command line, then the user is prompted for the password\&. + +If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the value \fIargument\fR\&. Otherwise, the password is retrieved as follows: +.RS +.TP 0.2i +\(bu +\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. +.TP 0.2i +\(bu +\f3file\fR: Retrieve the password from the file named \f3argument\fR\&. +.RE + + +\fINote:\fR The password should not be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system\&. +.TP +-keypass [:env | :file] \fIargument\fR +.br +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\fR to sign a JAR file\&. If no password is provided on the command line, and the required password is different from the store password, then the user is prompted for it\&. + +If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the value \f3argument\fR\&. Otherwise, the password is retrieved as follows: +.RS +.TP 0.2i +\(bu +\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. +.TP 0.2i +\(bu +\f3file\fR: Retrieve the password from the file named \f3argument\fR\&. +.RE + + +\fINote:\fR The password should not be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system\&. +.TP +-sigfile \fIfile\fR +.br +Specifies the base file name to be used for the generated \f3\&.SF\fR and \f3\&.DSA\fR files\&. For example, if file is \f3DUKESIGN\fR, then the generated \f3\&.SF\fR and \f3\&.DSA\fR files are named \f3DUKESIGN\&.SF\fR and \f3DUKESIGN\&.DSA\fR, and placed in the \f3META-INF\fR directory of the signed JAR file\&. + +The characters in the file must come from the set \f3a-zA-Z0-9_-\fR\&. Only letters, numbers, underscore, and hyphen characters are allowed\&. All lowercase characters are converted to uppercase for the \f3\&.SF\fR and \f3\&.DSA\fR file names\&. + +If no \f3-sigfile\fR option appears on the command line, then the base file name for the \f3\&.SF\fR and \f3\&.DSA\fR files is 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, then the full alias name is used\&. If the alias name contains any characters that are not valid in a signature file name, then each such character is converted to an underscore (_) character to form the file name\&. +.TP +-sigalg \fIalgorithm\fR +.br +Specifies the name of the signature algorithm to use to sign the JAR file\&. + +For a list of standard signature algorithm names, see "Appendix A: Standard Names" in the Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA + +This algorithm must be compatible with the private key used to sign the JAR file\&. If this option is not specified, then \f3SHA1withDSA\fR, \f3SHA256withRSA\fR, or \f3SHA256withECDSA\fR are 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 \f3-providerClass\fR option; otherwise, the command will not succeed\&. +.TP +-digestalg \fIalgorithm\fR +.br +Specifies the name of the message digest algorithm to use when digesting the entries of a JAR file\&. + +For a list of standard message digest algorithm names, see "Appendix A: Standard Names" in the Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA + +If this option is not specified, then \f3SHA256\fR is used\&. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f3-providerClass\fR option; otherwise, the command will not succeed\&. +.TP +-certs +.br +If the \f3-certs\fR option appears on the command line with the \f3-verify\fR and \f3-verbose\fR options, then the output includes certificate information for each signer of the JAR file\&. This information includes the name of the type of certificate (stored in the \f3\&.DSA\fR file) that certifies the signer\&'s public key, and if the certificate is an X\&.509 certificate (an instance of the \f3java\&.security\&.cert\&.X509Certificate\fR), then the distinguished name of the signer\&. + +The keystore is also examined\&. If no keystore value is specified on the command line, then the default keystore file (if any) is checked\&. If the public key certificate for a signer matches an entry in the keystore, then the alias name for the keystore entry for that signer is displayed in parentheses\&. +.TP +-certchain \fIfile\fR +.br +Specifies the certificate chain to be used when the certificate chain associated with the private key of the keystore entry that is addressed by the alias specified on the command line is not complete\&. This can happen when the keystore is located on a hardware token where there is not enough capacity to hold a complete certificate chain\&. The file can be a sequence of concatenated X\&.509 certificates, or a single PKCS#7 formatted data block, either in binary encoding format or in printable encoding format (also known as Base64 encoding) as defined by the Internet RFC 1421 standard\&. See Internet RFC 1421 Certificate Encoding Standard and http://tools\&.ietf\&.org/html/rfc1421\&. +.TP +-verbose +.br +When the \f3-verbose\fR option appears on the command line, it indicates verbose mode, which causes \f3jarsigner\fR to output extra information about the progress of the JAR signing or verification\&. +.TP +-internalsf +.br +In the past, the \f3\&.DSA\fR (signature block) file generated when a JAR file was signed included a complete encoded copy of the \f3\&.SF\fR file (signature file) also generated\&. This behavior has been changed\&. To reduce the overall size of the output JAR file, the \f3\&.DSA\fR file by default does not contain a copy of the \f3\&.SF\fR file anymore\&. If \f3-internalsf\fR appears on the command line, then the old behavior is utilized\&. This option is useful for testing\&. In practice, do not use the \f3-internalsf\fR option because it incurs higher overhead\&. +.TP +-sectionsonly +.br +If the \f3-sectionsonly\fR option appears on the command line, then the \f3\&.SF\fR file (signature file) generated when a JAR file is signed does not include a header that contains a hash of the whole manifest file\&. It contains only the information and hashes related to each individual source file included in the JAR file\&. See Signature File\&. + +By default, this header is added, as an optimization\&. When the header is present, whenever the JAR file is verified, the verification can first check to see whether the hash in the header matches the hash of the whole manifest file\&. When there is a match, verification proceeds to the next step\&. When there is no match, it is necessary to do a less optimized verification that the hash in each source file information section in the \f3\&.SF\fR file equals the hash of its corresponding section in the manifest file\&. See JAR File Verification\&. + +The \f3-sectionsonly\fR option is primarily used for testing\&. It should not be used other than for testing because using it incurs higher overhead\&. +.TP +-protected +.br +Values can be either \f3true\fR or \f3false\fR\&. Specify \f3true\fR when a password must be specified through a protected authentication path such as a dedicated PIN reader\&. +.TP +-providerClass \fIprovider-class-name\fR +.br +Used to specify the name of cryptographic service provider\&'s master class file when the service provider is not listed in the \f3java\&.security\fR security properties file\&. + +Used with the \f3-providerArg ConfigFilePath\fR option, the \f3keytool\fR and \f3jarsigner\fR tools install the provider dynamically and use \fIConfigFilePath\fR for the path to the token configuration file\&. The following example shows a command to list a \f3PKCS #11\fR keystore when the Oracle PKCS #11 provider was not configured in the security properties file\&. +.sp +.nf +\f3jarsigner \-keystore NONE \-storetype PKCS11 \e\fP +.fi +.nf +\f3 \-providerClass sun\&.security\&.pkcs11\&.SunPKCS11 \e\fP +.fi +.nf +\f3 \-providerArg /mydir1/mydir2/token\&.config \e\fP +.fi +.nf +\f3 \-list\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-providerName \fIproviderName\fR +.br +If more than one provider was configured in the \f3java\&.security\fR security properties file, then you can use the \f3-providerName\fR option to target a specific provider instance\&. The argument to this option is the name of the provider\&. + +For the Oracle PKCS #11 provider, \fIproviderName\fR is of the form \f3SunPKCS11-\fR\fITokenName\fR, where \fITokenName\fR is the name suffix that the provider instance has been configured with, as detailed in the configuration attributes table\&. For example, the following command lists the contents of the \f3PKCS #11\fR keystore provider instance with name suffix \f3SmartCard\fR: +.sp +.nf +\f3jarsigner \-keystore NONE \-storetype PKCS11 \e\fP +.fi +.nf +\f3 \-providerName SunPKCS11\-SmartCard \e\fP +.fi +.nf +\f3 \-list\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-J\fIjavaoption\fR +.br +Passes through the specified \fIjavaoption\fR string directly to the Java interpreter\&. The \f3jarsigner\fR command is 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 \f3java -h\fR or \f3java -X\fR at the command line\&. +.TP +-tsa \fIurl\fR +.br +If \f3-tsa http://example\&.tsa\&.url\fR appears on the command line when signing a JAR file then a time stamp is generated for the signature\&. The URL, \f3http://example\&.tsa\&.url\fR, identifies the location of the Time Stamping Authority (TSA) and overrides any URL found with the \f3-tsacert\fR option\&. The \f3-tsa\fR option does not require the TSA public key certificate to be present in the keystore\&. + +To generate the time stamp, \f3jarsigner\fR communicates with the TSA with the Time-Stamp Protocol (TSP) defined in RFC 3161\&. When successful, the time stamp token returned by the TSA is stored with the signature in the signature block file\&. +.TP +-tsacert \fIalias\fR +.br +When \f3-tsacert alias\fR appears on the command line when signing a JAR file, a time stamp is generated for the signature\&. The alias identifies the TSA public key certificate in the keystore that is in effect\&. The entry\&'s certificate is examined for a Subject Information Access extension that contains a URL identifying the location of the TSA\&. + +The TSA public key certificate must be present in the keystore when using the \f3-tsacert\fR option\&. +.TP +-tsapolicyid \fIpolicyid\fR +.br +Specifies the object identifier (OID) that identifies the policy ID to be sent to the TSA server\&. If this option is not specified, no policy ID is sent and the TSA server will choose a default policy ID\&. + +Object identifiers are defined by X\&.696, which is an ITU Telecommunication Standardization Sector (ITU-T) standard\&. These identifiers are typically period-separated sets of non-negative digits like \f31\&.2\&.3\&.4\fR, for example\&. +.TP +-altsigner \fIclass\fR +.br +This option specifies an alternative signing mechanism\&. The fully qualified class name identifies a class file that extends the \f3com\&.sun\&.jarsigner\&.ContentSigner\fR abstract class\&. The path to this class file is defined by the \f3-altsignerpath\fR option\&. If the \f3-altsigner\fR option is used, then the \f3jarsigner\fR command uses the signing mechanism provided by the specified class\&. Otherwise, the \f3jarsigner\fR command uses its default signing mechanism\&. + +For example, to use the signing mechanism provided by a class named \f3com\&.sun\&.sun\&.jarsigner\&.AuthSigner\fR, use the jarsigner option \f3-altsigner com\&.sun\&.jarsigner\&.AuthSigner\fR\&. +.TP +-altsignerpath \fIclasspathlist\fR +.br +Specifies the path to the class file and any JAR file it depends on\&. The class file name is specified with the \f3-altsigner\fR option\&. If the class file is in a JAR file, then this option specifies the path to that JAR file\&. + +An absolute path or a path relative to the current directory can be specified\&. If \fIclasspathlist\fR contains multiple paths or JAR files, then they should be separated with a colon (:) on Oracle Solaris and a semicolon (;) on Windows\&. This option is not necessary when the class is already in the search path\&. + +The following example shows how to specify the path to a JAR file that contains the class file\&. The JAR file name is included\&. +.sp +.nf +\f3\-altsignerpath /home/user/lib/authsigner\&.jar\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The following example shows how to specify the path to the JAR file that contains the class file\&. The JAR file name is omitted\&. +.sp +.nf +\f3\-altsignerpath /home/user/classes/com/sun/tools/jarsigner/\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-strict +.br +During the signing or verifying process, the command may issue warning messages\&. If you specify this option, the exit code of the tool reflects the severe warning messages that this command found\&. See Errors and Warnings\&. +.TP +-verbose \fIsuboptions\fR +.br +For the verifying process, the \f3-verbose\fR option takes suboptions to determine how much information is shown\&. If the \f3-certs\fR option is also specified, then the default mode (or suboption \f3all\fR) displays each entry as it is being processed, and after that, the certificate information for each signer of the JAR file\&. If the \f3-certs\fR and the \f3-verbose:grouped\fR suboptions are specified, then entries with the same signer info are grouped and displayed together with their certificate information\&. If \f3-certs\fR and the \f3-verbose:summary\fR suboptions are specified, then entries with the same signer information are grouped and displayed together with their certificate information\&. Details about each entry are summarized and displayed as \fIone entry (and more)\fR\&. See Examples\&. +.SH ERRORS\ AND\ WARNINGS +During the signing or verifying process, the \f3jarsigner\fR command may issue various errors or warnings\&. +.PP +If there is a failure, the \f3jarsigner\fR command exits with code 1\&. If there is no failure, but there are one or more severe warnings, the \f3jarsigner\fR command exits with code 0 when the \f3-strict\fR option is \fInot\fR specified, or exits with the OR-value of the warning codes when the \f3-strict\fR is specified\&. If there is only informational warnings or no warning at all, the command always exits with code 0\&. +.PP +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, the \f3jarsigner\fR command exits with code 12 (=4+8) when the \f3-strict\fR option is specified\&. +.PP +\fINote:\fR Exit codes are reused because only the values from 0 to 255 are legal on Unix-based operating systems\&. +.PP +The following sections describes the names, codes, and descriptions of the errors and warnings that the \f3jarsigner\fR command can issue\&. +.SS FAILURE +Reasons why the \f3jarsigner\fR command fails include (but are not limited to) a command line parsing error, the inability to find a keypair to sign the JAR file, or the verification of a signed JAR fails\&. +.TP +failure +Code 1\&. The signing or verifying fails\&. +.SS SEVERE\ WARNINGS +\fINote:\fR Severe warnings are reported as errors if you specify the \f3-strict\fR option\&. +.PP +Reasons why the \f3jarsigner\fR command issues a severe warning include the certificate used to sign the JAR file has an error or the signed JAR file has other problems\&. +.TP +hasExpiredCert +Code 4\&. This jar contains entries whose signer certificate has expired\&. +.TP +notYetValidCert +Code 4\&. This jar contains entries whose signer certificate is not yet valid\&. +.TP +chainNotValidated +Code 4\&. This jar contains entries whose certificate chain cannot be correctly validated\&. +.TP +badKeyUsage +Code 8\&. This jar contains entries whose signer certificate\&'s KeyUsage extension doesn\&'t allow code signing\&. +.TP +badExtendedKeyUsage +Code 8\&. This jar contains entries whose signer certificate\&'s ExtendedKeyUsage extension doesn\&'t allow code signing\&. +.TP +badNetscapeCertType +Code 8\&. This jar contains entries whose signer certificate\&'s NetscapeCertType extension doesn\&'t allow code signing\&. +.TP +hasUnsignedEntry +Code 16\&. This jar contains unsigned entries which have not been integrity-checked\&. +.TP +notSignedByAlias +Code 32\&. This jar contains signed entries which are not signed by the specified alias(es)\&. +.TP +aliasNotInStore +Code 32\&. This jar contains signed entries that are not signed by alias in this keystore\&. +.SS INFORMATIONAL\ WARNINGS +Informational warnings include those that are not errors but regarded as bad practice\&. They do not have a code\&. +.TP +hasExpiringCert +This jar contains entries whose signer certificate will expire within six months\&. +.TP +noTimestamp +This jar contains signatures that does not include a timestamp\&. Without a timestamp, users may not be able to validate this JAR file after the signer certificate\&'s expiration date (\f3YYYY-MM-DD\fR) or after any future revocation date\&. +.SH EXAMPLES +.SS SIGN\ A\ JAR\ FILE +Use the following command to sign bundle\&.jar with the private key of a user whose keystore alias is \f3jane\fR in a keystore named \f3mystore\fR in the \f3working\fR directory and name the signed JAR file \f3sbundle\&.jar\fR: +.sp +.nf +\f3jarsigner \-keystore /working/mystore\fP +.fi +.nf +\f3 \-storepass <keystore password>\fP +.fi +.nf +\f3 \-keypass <private key password>\fP +.fi +.nf +\f3 \-signedjar sbundle\&.jar bundle\&.jar jane\fP +.fi +.nf +\f3\fR +.fi +.sp +There is no \f3-sigfile\fR specified in the previous command so the generated \f3\&.SF\fR and \f3\&.DSA\fR files to be placed in the signed JAR file have default names based on the alias name\&. They are named \f3JANE\&.SF\fR and \f3JANE\&.DSA\fR\&. +.PP +If you want to be prompted for the store password and the private key password, then you could shorten the previous command to the following: +.sp +.nf +\f3jarsigner \-keystore /working/mystore\fP +.fi +.nf +\f3 \-signedjar sbundle\&.jar bundle\&.jar jane\fP +.fi +.nf +\f3\fR +.fi +.sp +If the keystore is the default keystore (\&.keystore in your home directory), then you do not need to specify a keystore, as follows: +.sp +.nf +\f3jarsigner \-signedjar sbundle\&.jar bundle\&.jar jane\fP +.fi +.nf +\f3\fR +.fi +.sp +If you want the signed JAR file to overwrite the input JAR file (bundle\&.jar), then you do not need to specify a \f3-signedjar\fR option, as follows: +.sp +.nf +\f3jarsigner bundle\&.jar jane\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS VERIFY\ A\ SIGNED\ JAR\ FILE +To verify a signed JAR file to ensure that the signature is valid and the JAR file was not been tampered with, use a command such as the following: +.sp +.nf +\f3jarsigner \-verify sbundle\&.jar\fP +.fi +.nf +\f3\fR +.fi +.sp +When the verification is successful, \f3jar verified\fR is displayed\&. Otherwise, an error message is displayed\&. You can get more information when you use the \f3-verbose\fR option\&. A sample use of \f3jarsigner\fR with the\f3-verbose\fR option follows: +.sp +.nf +\f3jarsigner \-verify \-verbose sbundle\&.jar\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.SF\fP +.fi +.nf +\f3 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.DSA\fP +.fi +.nf +\f3 smk 2752 Fri Sep 26 16:12:30 PDT 1997 AclEx\&.class\fP +.fi +.nf +\f3 smk 849 Fri Sep 26 16:12:46 PDT 1997 test\&.class\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 s = signature was verified\fP +.fi +.nf +\f3 m = entry is listed in manifest\fP +.fi +.nf +\f3 k = at least one certificate was found in keystore\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 jar verified\&.\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS VERIFICATION\ WITH\ CERTIFICATE\ INFORMATION +If you specify the \f3-certs\fR option with the \f3-verify\fR and \f3-verbose\fR options, then the output includes certificate information for each signer of the JAR file\&. The information includes the certificate type, the signer distinguished name information (when it is an X\&.509 certificate), and in parentheses, the keystore alias for the signer when the public key certificate in the JAR file matches the one in a keystore entry, for example: +.sp +.nf +\f3jarsigner \-keystore /working/mystore \-verify \-verbose \-certs myTest\&.jar\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.SF\fP +.fi +.nf +\f3 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.DSA\fP +.fi +.nf +\f3 208 Fri Sep 26 16:23:30 PDT 1997 META\-INF/JAVATEST\&.SF\fP +.fi +.nf +\f3 1087 Fri Sep 26 16:23:30 PDT 1997 META\-INF/JAVATEST\&.DSA\fP +.fi +.nf +\f3 smk 2752 Fri Sep 26 16:12:30 PDT 1997 Tst\&.class\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 X\&.509, CN=Test Group, OU=Java Software, O=Oracle, L=CUP, S=CA, C=US (javatest)\fP +.fi +.nf +\f3 X\&.509, CN=Jane Smith, OU=Java Software, O=Oracle, L=cup, S=ca, C=us (jane)\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 s = signature was verified\fP +.fi +.nf +\f3 m = entry is listed in manifest\fP +.fi +.nf +\f3 k = at least one certificate was found in keystore\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 jar verified\&.\fP +.fi +.nf +\f3\fR +.fi +.sp +If the certificate for a signer is not an X\&.509 certificate, then there is no distinguished name information\&. In that case, just the certificate type and the alias are shown\&. For example, if the certificate is a PGP certificate, and the alias is \f3bob\fR, then you would get: \f3PGP, (bob)\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +keytool(1) +.TP 0.2i +\(bu +Trail: Security Features in Java SE at http://docs\&.oracle\&.com/javase/tutorial/security/index\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/java.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/java.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,5 +1,6 @@ '\" t -.\" Copyright (c) 1994, 2015, Oracle and/or its affiliates. All rights reserved. DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" Copyright (c) 1994, 2015, 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 @@ -7,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/javac.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/javac.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,1369 +1,1369 @@ -'\" t -.\" Copyright (c) 1994, 2015, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 03 March 2015 -.\" SectDesc: Basic Tools -.\" Title: javac.1 -.\" -.if n .pl 99999 -.TH javac 1 "03 March 2015" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -javac \- Reads Java class and interface definitions and compiles them into bytecode and class files\&. -.SH SYNOPSIS -.sp -.nf - -\fBjavac\fR [ \fIoptions\fR ] [ \fIsourcefiles\fR ] [ \fIclasses\fR] [ \fI@argfiles\fR ] -.fi -.sp -Arguments can be in any order: -.TP -\fIoptions\fR -Command-line options\&. See Options\&. -.TP -\fIsourcefiles\fR -One or more source files to be compiled (such as \f3MyClass\&.java\fR)\&. -.TP -\fIclasses\fR -One or more classes to be processed for annotations (such as \f3MyPackage\&.MyClass\fR)\&. -.TP -\fI@argfiles\fR -One or more files that list options and source files\&. The \f3-J\fR options are not allowed in these files\&. See Command-Line Argument Files\&. -.SH DESCRIPTION -The \f3javac\fR command reads class and interface definitions, written in the Java programming language, and compiles them into bytecode class files\&. The \f3javac\fR command can also process annotations in Java source files and classes\&. -.PP -There are two ways to pass source code file names to \f3javac\fR\&. -.TP 0.2i -\(bu -For a small number of source files, list the file names on the command line\&. -.TP 0.2i -\(bu -For a large number of source files, list the file names in a file that is separated by blanks or line breaks\&. Use the list file name preceded by an at sign (@) with the \f3javac\fR command\&. -.PP -Source code file names must have \&.java suffixes, class file names must have \&.class suffixes, and both source and class files must have root names that identify the class\&. For example, a class called \f3MyClass\fR would be written in a source file called \f3MyClass\&.java\fR and compiled into a bytecode class file called \f3MyClass\&.class\fR\&. -.PP -Inner class definitions produce additional class files\&. These class files have names that combine the inner and outer class names, such as \f3MyClass$MyInnerClass\&.class\fR\&. -.PP -Arrange source files in a directory tree that reflects their package tree\&. For example, if all of your source files are in \f3/workspace\fR, then put the source code for \f3com\&.mysoft\&.mypack\&.MyClass\fR in \f3/workspace/com/mysoft/mypack/MyClass\&.java\fR\&. -.PP -By default, the compiler puts each class file in the same directory as its source file\&. You can specify a separate destination directory with the \f3-d\fR option\&. -.SH OPTIONS -The compiler has a set of standard options that are supported on the current development environment\&. An additional set of nonstandard options are specific to the current virtual machine and compiler implementations and are subject to change in the future\&. Nonstandard options begin with the \f3-X\fR option\&. -.TP 0.2i -\(bu -See also Cross-Compilation Options -.TP 0.2i -\(bu -See also Nonstandard Options -.SS STANDARD\ OPTIONS -.TP --A\fIkey\fR[\fI=value\fR] -.br -Specifies options to pass to annotation processors\&. These options are not interpreted by \f3javac\fR directly, but are made available for use by individual processors\&. The \f3key\fR value should be one or more identifiers separated by a dot (\&.)\&. -.TP --cp \fIpath\fR or -classpath \fIpath\fR -.br -Specifies where to find user class files, and (optionally) annotation processors and source files\&. This class path overrides the user class path in the \f3CLASSPATH\fR environment variable\&. If neither \f3CLASSPATH\fR, \f3-cp\fR nor \f3-classpath\fR is specified, then the user \fIclass path\fR is the current directory\&. See Setting the Class Path\&. - -If the \f3-sourcepath\fR option is not specified, then the user class path is also searched for source files\&. - -If the \f3-processorpath\fR option is not specified, then the class path is also searched for annotation processors\&. -.TP --Djava\&.ext\&.dirs=\fIdirectories\fR -.br -Overrides the location of installed extensions\&. -.TP --Djava\&.endorsed\&.dirs=\fIdirectories\fR -.br -Overrides the location of the endorsed standards path\&. -.TP --d \fIdirectory\fR -.br -Sets the destination directory for class files\&. The directory must already exist because \f3javac\fR does not create it\&. If a class is part of a package, then \f3javac\fR puts the class file in a subdirectory that reflects the package name and creates directories as needed\&. - -If you specify \f3-d\fR\f3/home/myclasses\fR and the class is called \f3com\&.mypackage\&.MyClass\fR, then the class file is \f3/home/myclasses/com/mypackage/MyClass\&.class\fR\&. - -If the \fI-d\fR option is not specified, then \f3javac\fR puts each class file in the same directory as the source file from which it was generated\&. - -\fINote:\fR The directory specified by the \fI-d\fR option is not automatically added to your user class path\&. -.TP --deprecation -.br -Shows a description of each use or override of a deprecated member or class\&. Without the \f3-deprecation\fR option, \f3javac\fR shows a summary of the source files that use or override deprecated members or classes\&. The \f3-deprecation\fR option is shorthand for \f3-Xlint:deprecation\fR\&. -.TP --encoding \fIencoding\fR -.br -Sets the source file encoding name, such as EUC-JP and UTF-8\&. If the \f3-encoding\fR option is not specified, then the platform default converter is used\&. -.TP --endorseddirs \fIdirectories\fR -.br -Overrides the location of the endorsed standards path\&. -.TP --extdirs \fIdirectories\fR -.br -Overrides the location of the \f3ext\fR directory\&. The directories variable is a colon-separated list of directories\&. Each JAR file in the specified directories is searched for class files\&. All JAR files found become part of the class path\&. - -If you are cross-compiling (compiling classes against bootstrap and extension classes of a different Java platform implementation), then this option specifies the directories that contain the extension classes\&. See Cross-Compilation Options for more information\&. -.TP --g -.br -Generates all debugging information, including local variables\&. By default, only line number and source file information is generated\&. -.TP --g:none -.br -Does not generate any debugging information\&. -.TP --g:[\fIkeyword list\fR] -.br -Generates only some kinds of debugging information, specified by a comma separated list of keywords\&. Valid keywords are: -.RS -.TP -source -Source file debugging information\&. -.TP -lines -Line number debugging information\&. -.TP -vars -Local variable debugging information\&. -.RE - -.TP --help -.br -Prints a synopsis of standard options\&. -.TP --implicit:[\fIclass, none\fR] -.br -Controls the generation of class files for implicitly loaded source files\&. To automatically generate class files, use \f3-implicit:class\fR\&. To suppress class file generation, use \f3-implicit:none\fR\&. If this option is not specified, then the default is to automatically generate class files\&. In this case, the compiler issues a warning if any such class files are generated when also doing annotation processing\&. The warning is not issued when the \f3-implicit\fR option is set explicitly\&. See Searching for Types\&. -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. - -\fINote:\fR The \fICLASSPATH\fR, \f3-classpath\fR, \f3-bootclasspath\fR, and \f3-extdirs\fR options do not specify the classes used to run \f3javac\fR\&. Trying to customize the compiler implementation with these options and variables is risky and often does not accomplish what you want\&. If you must customize the complier implementation, then use the \f3-J\fR option to pass options through to the underlying \f3\fRJava launcher\&. -.TP --nowarn -.br -Disables warning messages\&. This option operates the same as the \f3-Xlint:none\fR option\&. -.TP --parameters -.br -Stores formal parameter names of constructors and methods in the generated class file so that the method \f3java\&.lang\&.reflect\&.Executable\&.getParameters\fR from the Reflection API can retrieve them\&. -.TP --proc: [\fInone\fR, \fIonly\fR] -.br -Controls whether annotation processing and compilation are done\&. \f3-proc:none\fR means that compilation takes place without annotation processing\&. \f3-proc:only\fR means that only annotation processing is done, without any subsequent compilation\&. -.TP --processor \fIclass1\fR [,\fIclass2\fR,\fIclass3\fR\&.\&.\&.] -.br -Names of the annotation processors to run\&. This bypasses the default discovery process\&. -.TP --processorpath \fIpath\fR -.br -Specifies where to find annotation processors\&. If this option is not used, then the class path is searched for processors\&. -.TP --s \fIdir\fR -.br -Specifies the directory where to place the generated source files\&. The directory must already exist because \f3javac\fR does not create it\&. If a class is part of a package, then the compiler puts the source file in a subdirectory that reflects the package name and creates directories as needed\&. - -If you specify \f3-s /home/mysrc\fR and the class is called \f3com\&.mypackage\&.MyClass\fR, then the source file is put in \f3/home/mysrc/com/mypackage/MyClass\&.java\fR\&. -.TP --source \fIrelease\fR -.br -Specifies the version of source code accepted\&. The following values for \f3release\fR are allowed: -.RS -.TP -1\&.3 -The compiler does not support assertions, generics, or other language features introduced after Java SE 1\&.3\&. -.TP -1\&.4 -The compiler accepts code containing assertions, which were introduced in Java SE 1\&.4\&. -.TP -1\&.5 -The compiler accepts code containing generics and other language features introduced in Java SE 5\&. -.TP -5 -Synonym for 1\&.5\&. -.TP -1\&.6 -No language changes were introduced in Java SE 6\&. However, encoding errors in source files are now reported as errors instead of warnings as in earlier releases of Java Platform, Standard Edition\&. -.TP -6 -Synonym for 1\&.6\&. -.TP -1\&.7 -The compiler accepts code with features introduced in Java SE 7\&. -.TP -7 -Synonym for 1\&.7\&. -.TP -1\&.8 -This is the default value\&. The compiler accepts code with features introduced in Java SE 8\&. -.TP -8 -Synonym for 1\&.8\&. -.RE - -.TP --sourcepath \fIsourcepath\fR -.br -Specifies the source code path to search for class or interface definitions\&. As with the user class path, source path entries are separated by colons (:) on Oracle Solaris and semicolons on Windows and can be directories, JAR archives, or ZIP archives\&. If packages are used, then the local path name within the directory or archive must reflect the package name\&. - -\fINote:\fR Classes found through the class path might be recompiled when their source files are also found\&. See Searching for Types\&. -.TP --verbose -.br -Uses verbose output, which includes information about each class loaded and each source file compiled\&. -.TP --version -.br -Prints release information\&. -.TP --werror -.br -Terminates compilation when warnings occur\&. -.TP --X -.br -Displays information about nonstandard options and exits\&. -.SS CROSS-COMPILATION\ OPTIONS -By default, classes are compiled against the bootstrap and extension classes of the platform that \f3javac\fR shipped with\&. But \f3javac\fR also supports cross-compiling, where classes are compiled against a bootstrap and extension classes of a different Java platform implementation\&. It is important to use the \f3-bootclasspath\fR and \f3-extdirs\fR options when cross-compiling\&. -.TP --target \fIversion\fR -.br -Generates class files that target a specified release of the virtual machine\&. Class files will run on the specified target and on later releases, but not on earlier releases of the JVM\&. Valid targets are 1\&.1, 1\&.2, 1\&.3, 1\&.4, 1\&.5 (also 5), 1\&.6 (also 6), 1\&.7 (also 7), and 1\&.8 (also 8)\&. - -The default for the \f3-target\fR option depends on the value of the \f3-source\fR option: -.RS -.TP 0.2i -\(bu -If the \f3-source\fR option is not specified, then the value of the \f3-target\fR option is 1\&.8 -.TP 0.2i -\(bu -If the \f3-source\fR option is 1\&.2, then the value of the \f3-target\fR option is 1\&.4 -.TP 0.2i -\(bu -If the \f3-source\fR option is 1\&.3, then the value of the \f3-target\fR option is 1\&.4 -.TP 0.2i -\(bu -If the \f3-source\fR option is 1\&.5, then the value of the \f3-target\fR option is 1\&.8 -.TP 0.2i -\(bu -If the \f3-source\fR option is 1\&.6, then the value of the \f3-target\fR is option 1\&.8 -.TP 0.2i -\(bu -If the \f3-source\fR option is 1\&.7, then the value of the \f3-target\fR is option 1\&.8 -.TP 0.2i -\(bu -For all other values of the \f3-source\fR option, the value of the \f3-target\fR option is the value of the \f3-source\fR option\&. -.RE - -.TP --bootclasspath \fIbootclasspath\fR -.br -Cross-compiles against the specified set of boot classes\&. As with the user class path, boot class path entries are separated by colons (:) and can be directories, JAR archives, or ZIP archives\&. -.SS COMPACT\ PROFILE\ OPTION -Beginning with JDK 8, the \f3javac\fR compiler supports compact profiles\&. With compact profiles, applications that do not require the entire Java platform can be deployed and run with a smaller footprint\&. The compact profiles feature could be used to shorten the download time for applications from app stores\&. This feature makes for more compact deployment of Java applications that bundle the JRE\&. This feature is also useful in small devices\&. -.PP -The supported profile values are \f3compact1\fR, \f3compact2\fR, and \f3compact3\fR\&. These are additive layers\&. Each higher-numbered compact profile contains all of the APIs in profiles with smaller number names\&. -.TP --profile -.br -When using compact profiles, this option specifies the profile name when compiling\&. For example: -.sp -.nf -\f3javac \-profile compact1 Hello\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp - - -javac does not compile source code that uses any Java SE APIs that is not in the specified profile\&. Here is an example of the error message that results from attempting to compile such source code: -.sp -.nf -\f3cd jdk1\&.8\&.0/bin\fP -.fi -.nf -\f3\&./javac \-profile compact1 Paint\&.java\fP -.fi -.nf -\f3Paint\&.java:5: error: Applet is not available in profile \&'compact1\&'\fP -.fi -.nf -\f3import java\&.applet\&.Applet;\fP -.fi -.nf -\f3\fP -.fi -.sp - - -In this example, you can correct the error by modifying the source to not use the \f3Applet\fR class\&. You could also correct the error by compiling without the -profile option\&. Then the compilation would be run against the full set of Java SE APIs\&. (None of the compact profiles include the \f3Applet\fR class\&.) - -An alternative way to compile with compact profiles is to use the \f3-bootclasspath\fR option to specify a path to an \f3rt\&.jar\fR file that specifies a profile\&'s image\&. Using the \f3-profile\fR option instead does not require a profile image to be present on the system at compile time\&. This is useful when cross-compiling\&. -.SS NONSTANDARD\ OPTIONS -.TP --Xbootclasspath/p:\fIpath\fR -.br -Adds a suffix to the bootstrap class path\&. -.TP --Xbootclasspath/a:\fIpath\fR -.br -Adds a prefix to the bootstrap class path\&. -.TP --Xbootclasspath/:\fIpath\fR -.br -Overrides the location of the bootstrap class files\&. -.TP --Xdoclint:[-]\fIgroup\fR [\fI/access\fR] -.br -Enables or disables specific groups of checks, where \fIgroup\fR is one of the following values: \f3accessibility\fR, \f3syntax\fR, \f3reference\fR, \f3html\fR or \f3missing\fR\&. For more information about these groups of checks see the \f3-Xdoclint\fR option of the \f3javadoc\fR command\&. The \f3-Xdoclint\fR option is disabled by default in the \f3javac\fR command\&. - -The variable \fIaccess\fR specifies the minimum visibility level of classes and members that the \f3-Xdoclint\fR option checks\&. It can have one of the following values (in order of most to least visible) : \f3public\fR, \f3protected\fR, \f3package\fR and \f3private\fR\&. For example, the following option checks classes and members (with all groups of checks) that have the access level protected and higher (which includes protected, package and public): -.sp -.nf -\f3\-Xdoclint:all/protected\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The following option enables all groups of checks for all access levels, except it will not check for HTML errors for classes and members that have access level package and higher (which includes package and public): -.sp -.nf -\f3\-Xdoclint:all,\-html/package\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --Xdoclint:none -.br -Disables all groups of checks\&. -.TP --Xdoclint:all[\fI/access\fR] -.br -Enables all groups of checks\&. -.TP --Xlint -.br -\fI\fREnables all recommended warnings\&. In this release, enabling all available warnings is recommended\&. -.TP --Xlint:all -.br -\fI\fREnables all recommended warnings\&. In this release, enabling all available warnings is recommended\&. -.TP --Xlint:none -.br -Disables all warnings\&. -.TP --Xlint:\fIname\fR -.br -Disables warning name\&. See Enable or Disable Warnings with the -Xlint Option for a list of warnings you can disable with this option\&. -.TP --Xlint:\fI-name\fR -.br -Disables warning name\&. See Enable or Disable Warnings with the -Xlint Option with the \f3-Xlint\fR option to get a list of warnings that you can disable with this option\&. -.TP --Xmaxerrs \fInumber\fR -.br -Sets the maximum number of errors to print\&. -.TP --Xmaxwarns \fInumber\fR -.br -Sets the maximum number of warnings to print\&. -.TP --Xstdout \fIfilename\fR -.br -Sends compiler messages to the named file\&. By default, compiler messages go to \f3System\&.err\fR\&. -.TP --Xprefer:[\fInewer,source\fR] -.br -Specifies which file to read when both a source file and class file are found for a type\&. (See Searching for Types)\&. If the \f3-Xprefer:newer\fR option is used, then it reads the newer of the source or class file for a type (default)\&. If the \f3-Xprefer:source\fR option is used, then it reads the source file\&. Use -\f3Xprefer:source\fR when you want to be sure that any annotation processors can access annotations declared with a retention policy of \f3SOURCE\fR\&. -.TP --Xpkginfo:[\fIalways\fR,\fIlegacy\fR,\fInonempty\fR] -.br -Control whether javac generates \f3package-info\&.class\fR files from package-info\&.java files\&. Possible mode arguments for this option include the following\&. -.RS -.TP -always -Always generate a \f3package-info\&.class\fR file for every \f3package-info\&.java\fR file\&. This option may be useful if you use a build system such as Ant, which checks that each \f3\&.java\fR file has a corresponding \f3\&.class\fR file\&. -.TP -legacy -Generate a \f3package-info\&.class\fR file only if package-info\&.java contains annotations\&. Don\&'t generate a \f3package-info\&.class\fR file if package-info\&.java only contains comments\&. - -\fINote:\fR A \f3package-info\&.class\fR file might be generated but be empty if all the annotations in the package-info\&.java file have \f3RetentionPolicy\&.SOURCE\fR\&. -.TP -nonempty -Generate a \f3package-info\&.class\fR file only if package-info\&.java contains annotations with \f3RetentionPolicy\&.CLASS\fR or \f3RetentionPolicy\&.RUNTIME\fR\&. -.RE - -.TP --Xprint -.br -Prints a textual representation of specified types for debugging purposes\&. Perform neither annotation processing nor compilation\&. The format of the output could change\&. -.TP --XprintProcessorInfo -.br -Prints information about which annotations a processor is asked to process\&. -.TP --XprintRounds -.br -Prints information about initial and subsequent annotation processing rounds\&. -.SH ENABLE\ OR\ DISABLE\ WARNINGS\ WITH\ THE\ -XLINT\ OPTION -Enable warning \fIname\fR with the \f3-Xlint:name\fR option, where \f3name\fR is one of the following warning names\&. Note that you can disable a warning with the \f3-Xlint:-name:\fR option\&. -.TP -cast -Warns about unnecessary and redundant casts, for example: -.sp -.nf -\f3String s = (String) "Hello!"\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -classfile -Warns about issues related to class file contents\&. -.TP -deprecation -Warns about the use of deprecated items, for example: -.sp -.nf -\f3java\&.util\&.Date myDate = new java\&.util\&.Date();\fP -.fi -.nf -\f3int currentDay = myDate\&.getDay();\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The method \f3java\&.util\&.Date\&.getDay\fR has been deprecated since JDK 1\&.1 -.TP -dep-ann -Warns about items that are documented with an \f3@deprecated\fR Javadoc comment, but do not have a \f3@Deprecated\fR annotation, for example: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * @deprecated As of Java SE 7, replaced by {@link #newMethod()}\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3public static void deprecatedMethood() { }\fP -.fi -.nf -\f3public static void newMethod() { }\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -divzero -Warns about division by the constant integer 0, for example: -.sp -.nf -\f3int divideByZero = 42 / 0;\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -empty -Warns about empty statements after \f3if\fRstatements, for example: -.sp -.nf -\f3class E {\fP -.fi -.nf -\f3 void m() {\fP -.fi -.nf -\f3 if (true) ;\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -fallthrough -Checks the switch blocks for fall-through cases and provides a warning message for any that are found\&. Fall-through cases are cases in a switch block, other than the last case in the block, whose code does not include a break statement, allowing code execution to fall through from that case to the next case\&. For example, the code following the case 1 label in this switch block does not end with a break statement: -.sp -.nf -\f3switch (x) {\fP -.fi -.nf -\f3case 1:\fP -.fi -.nf -\f3 System\&.out\&.println("1");\fP -.fi -.nf -\f3 // No break statement here\&.\fP -.fi -.nf -\f3case 2:\fP -.fi -.nf -\f3 System\&.out\&.println("2");\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - - -If the \f3-Xlint:fallthrough\fR option was used when compiling this code, then the compiler emits a warning about possible fall-through into case, with the line number of the case in question\&. -.TP -finally -Warns about \f3finally\fR clauses that cannot complete normally, for example: -.sp -.nf -\f3public static int m() {\fP -.fi -.nf -\f3 try {\fP -.fi -.nf -\f3 throw new NullPointerException();\fP -.fi -.nf -\f3 } catch (NullPointerException(); {\fP -.fi -.nf -\f3 System\&.err\&.println("Caught NullPointerException\&.");\fP -.fi -.nf -\f3 return 1;\fP -.fi -.nf -\f3 } finally {\fP -.fi -.nf -\f3 return 0;\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The compiler generates a warning for the \f3finally\fR block in this example\&. When the \f3int\fR method is called, it returns a value of 0\&. A \f3finally\fR block executes when the \f3try\fR block exits\&. In this example, when control is transferred to the \f3catch\fR block, the \f3int\fR method exits\&. However, the \f3finally\fR block must execute, so it is executed, even though control was transferred outside the method\&. -.TP -options -Warns about issues that related to the use of command-line options\&. See Cross-Compilation Options\&. -.TP -overrides -Warns about issues regarding method overrides\&. For example, consider the following two classes: -.sp -.nf -\f3public class ClassWithVarargsMethod {\fP -.fi -.nf -\f3 void varargsMethod(String\&.\&.\&. s) { }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3public class ClassWithOverridingMethod extends ClassWithVarargsMethod {\fP -.fi -.nf -\f3 @Override\fP -.fi -.nf -\f3 void varargsMethod(String[] s) { }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The compiler generates a warning similar to the following:\&. -.sp -.nf -\f3warning: [override] varargsMethod(String[]) in ClassWithOverridingMethod \fP -.fi -.nf -\f3overrides varargsMethod(String\&.\&.\&.) in ClassWithVarargsMethod; overriding\fP -.fi -.nf -\f3method is missing \&'\&.\&.\&.\&'\fP -.fi -.nf -\f3\fP -.fi -.sp - - -When the compiler encounters a \f3varargs\fR method, it translates the \f3varargs\fR formal parameter into an array\&. In the method \f3ClassWithVarargsMethod\&.varargsMethod\fR, the compiler translates the \f3varargs\fR formal parameter \f3String\&.\&.\&. s\fR to the formal parameter \f3String[] s\fR, an array, which matches the formal parameter of the method \f3ClassWithOverridingMethod\&.varargsMethod\fR\&. Consequently, this example compiles\&. -.TP -path -Warns about invalid path elements and nonexistent path directories on the command line (with regard to the class path, the source path, and other paths)\&. Such warnings cannot be suppressed with the \f3@SuppressWarnings\fR annotation, for example: -.sp -.nf -\f3javac \-Xlint:path \-classpath /nonexistentpath Example\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -processing -Warn about issues regarding annotation processing\&. The compiler generates this warning when you have a class that has an annotation, and you use an annotation processor that cannot handle that type of exception\&. For example, the following is a simple annotation processor: - -\fISource file AnnocProc\&.java\fR: -.sp -.nf -\f3import java\&.util\&.*;\fP -.fi -.nf -\f3import javax\&.annotation\&.processing\&.*;\fP -.fi -.nf -\f3import javax\&.lang\&.model\&.*;\fP -.fi -.nf -\f3import\&.javaz\&.lang\&.model\&.element\&.*;\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3@SupportedAnnotationTypes("NotAnno")\fP -.fi -.nf -\f3public class AnnoProc extends AbstractProcessor {\fP -.fi -.nf -\f3 public boolean process(Set<? extends TypeElement> elems, RoundEnvironment renv){\fP -.fi -.nf -\f3 return true;\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 public SourceVersion getSupportedSourceVersion() {\fP -.fi -.nf -\f3 return SourceVersion\&.latest();\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - - -\fISource file AnnosWithoutProcessors\&.java\fR: -.sp -.nf -\f3@interface Anno { }\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3@Anno\fP -.fi -.nf -\f3class AnnosWithoutProcessors { }\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The following commands compile the annotation processor \f3AnnoProc\fR, then run this annotation processor against the source file \f3AnnosWithoutProcessors\&.java\fR: -.sp -.nf -\f3javac AnnoProc\&.java\fP -.fi -.nf -\f3javac \-cp \&. \-Xlint:processing \-processor AnnoProc \-proc:only AnnosWithoutProcessors\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp - - -When the compiler runs the annotation processor against the source file \f3AnnosWithoutProcessors\&.java\fR, it generates the following warning: -.sp -.nf -\f3warning: [processing] No processor claimed any of these annotations: Anno\fP -.fi -.nf -\f3\fP -.fi -.sp - - -To resolve this issue, you can rename the annotation defined and used in the class \f3AnnosWithoutProcessors\fR from \f3Anno\fR to \f3NotAnno\fR\&. -.TP -rawtypes -Warns about unchecked operations on raw types\&. The following statement generates a \f3rawtypes\fR warning: -.sp -.nf -\f3void countElements(List l) { \&.\&.\&. }\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The following example does not generate a \f3rawtypes\fR warning -.sp -.nf -\f3void countElements(List<?> l) { \&.\&.\&. }\fP -.fi -.nf -\f3\fP -.fi -.sp - - -\f3List\fR is a raw type\&. However, \f3List<?>\fR is an unbounded wildcard parameterized type\&. Because \f3List\fR is a parameterized interface, always specify its type argument\&. In this example, the \f3List\fR formal argument is specified with an unbounded wildcard (\f3?\fR) as its formal type parameter, which means that the \f3countElements\fR method can accept any instantiation of the \f3List\fR interface\&. -.TP -Serial -Warns about missing \f3serialVersionUID\fR definitions on serializable classes, for example: -.sp -.nf -\f3public class PersistentTime implements Serializable\fP -.fi -.nf -\f3{\fP -.fi -.nf -\f3 private Date time;\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 public PersistentTime() {\fP -.fi -.nf -\f3 time = Calendar\&.getInstance()\&.getTime();\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 public Date getTime() {\fP -.fi -.nf -\f3 return time;\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The compiler generates the following warning: -.sp -.nf -\f3warning: [serial] serializable class PersistentTime has no definition of\fP -.fi -.nf -\f3serialVersionUID\fP -.fi -.nf -\f3\fP -.fi -.sp - - -If a serializable class does not explicitly declare a field named \f3serialVersionUID\fR, then the serialization runtime environment calculates a default \f3serialVersionUID\fR value for that class based on various aspects of the class, as described in the Java Object Serialization Specification\&. However, it is strongly recommended that all serializable classes explicitly declare \f3serialVersionUID\fR values because the default process of computing \f3serialVersionUID\fR vales is highly sensitive to class details that can vary depending on compiler implementations, and as a result, might cause an unexpected \f3InvalidClassExceptions\fR during deserialization\&. To guarantee a consistent \f3serialVersionUID\fR value across different Java compiler implementations, a serializable class must declare an explicit \f3serialVersionUID\fR value\&. -.TP -static -Warns about issues relating to the use of statics, for example: -.sp -.nf -\f3class XLintStatic {\fP -.fi -.nf -\f3 static void m1() { }\fP -.fi -.nf -\f3 void m2() { this\&.m1(); }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The compiler generates the following warning: -.sp -.nf -\f3warning: [static] static method should be qualified by type name, \fP -.fi -.nf -\f3XLintStatic, instead of by an expression\fP -.fi -.nf -\f3\fP -.fi -.sp - - -To resolve this issue, you can call the \f3static\fR method \f3m1\fR as follows: -.sp -.nf -\f3XLintStatic\&.m1();\fP -.fi -.nf -\f3\fP -.fi -.sp - - -Alternately, you can remove the \f3static\fR keyword from the declaration of the method \f3m1\fR\&. -.TP -try -Warns about issues relating to use of \f3try\fR blocks, including try-with-resources statements\&. For example, a warning is generated for the following statement because the resource \f3ac\fR declared in the \f3try\fR block is not used: -.sp -.nf -\f3try ( AutoCloseable ac = getResource() ) { // do nothing}\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -unchecked -Gives more detail for unchecked conversion warnings that are mandated by the Java Language Specification, for example: -.sp -.nf -\f3List l = new ArrayList<Number>();\fP -.fi -.nf -\f3List<String> ls = l; // unchecked warning\fP -.fi -.nf -\f3\fP -.fi -.sp - - -During type erasure, the types \f3ArrayList<Number>\fR and \f3List<String>\fR become \f3ArrayList\fR and \f3List\fR, respectively\&. - -The \f3ls\fR command has the parameterized type \f3List<String>\fR\&. When the \f3List\fR referenced by \f3l\fR is assigned to \f3ls\fR, the compiler generates an unchecked warning\&. At compile time, the compiler and JVM cannot determine whether \f3l\fR refers to a \f3List<String>\fR type\&. In this case, \f3l\fR does not refer to a \f3List<String>\fR type\&. As a result, heap pollution occurs\&. - -A heap pollution situation occurs when the \f3List\fR object \f3l\fR, whose static type is \f3List<Number>\fR, is assigned to another \f3List\fR object, \f3ls\fR, that has a different static type, \f3List<String>\fR\&. However, the compiler still allows this assignment\&. It must allow this assignment to preserve backward compatibility with releases of Java SE that do not support generics\&. Because of type erasure, \f3List<Number>\fR and \f3List<String>\fR both become \f3List\fR\&. Consequently, the compiler allows the assignment of the object \f3l\fR\f3,\fR which has a raw type of \f3List\fR, to the object \f3ls\fR\&. -.TP -varargs -Warns about unsafe usages of variable arguments (\f3varargs\fR) methods, in particular, those that contain non-reifiable arguments, for example: -.sp -.nf -\f3public class ArrayBuilder {\fP -.fi -.nf -\f3 public static <T> void addToList (List<T> listArg, T\&.\&.\&. elements) {\fP -.fi -.nf -\f3 for (T x : elements) {\fP -.fi -.nf -\f3 listArg\&.add(x);\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - - -\fINote:\fR A non-reifiable type is a type whose type information is not fully available at runtime\&. - -The compiler generates the following warning for the definition of the method \f3ArrayBuilder\&.addToList\fR -.sp -.nf -\f3warning: [varargs] Possible heap pollution from parameterized vararg type T\fP -.fi -.nf -\f3\fP -.fi -.sp - - -When the compiler encounters a varargs method, it translates the \f3varargs\fR formal parameter into an array\&. However, the Java programming language does not permit the creation of arrays of parameterized types\&. In the method \f3ArrayBuilder\&.addToList\fR, the compiler translates the \f3varargs\fR formal parameter \f3T\&.\&.\&.\fR elements to the formal parameter \f3T[]\fR elements, an array\&. However, because of type erasure, the compiler converts the \f3varargs\fR formal parameter to \f3Object[]\fR elements\&. Consequently, there is a possibility of heap pollution\&. -.SH COMMAND-LINE\ ARGUMENT\ FILES -To shorten or simplify the \f3javac\fR command, you can specify one or more files that contain arguments to the \f3javac\fR command (except \f3-J\fR options)\&. This enables you to create \f3javac\fR commands of any length on any operating system\&. -.PP -An argument file can include \f3javac\fR options and source file names in any combination\&. The arguments within a file can be separated by spaces or new line characters\&. If a file name contains embedded spaces, then put the whole file name in double quotation marks\&. -.PP -File Names within an argument file are relative to the current directory, not the location of the argument file\&. Wild cards (*) are not allowed in these lists (such as for specifying \f3*\&.java\fR)\&. Use of the at sign (@) to recursively interpret files is not supported\&. The \f3-J\fR options are not supported because they are passed to the launcher, which does not support argument files\&. -.PP -When executing the \f3javac\fR command, pass in the path and name of each argument file with the at sign (@) leading character\&. When the \f3javac\fR command encounters an argument beginning with the at sign (@), it expands the contents of that file into the argument list\&. -.PP -\f3Example 1 Single Argument File\fR -.PP -You could use a single argument file named \f3argfile\fR to hold all \f3javac\fR arguments: -.sp -.nf -\f3javac @argfile\fP -.fi -.nf -\f3\fP -.fi -.sp -This argument file could contain the contents of both files shown in Example 2 -.PP -\f3Example 2 Two Argument Files\fR -.PP -You can create two argument files: one for the \f3javac\fR options and the other for the source file names\&. Note that the following lists have no line-continuation characters\&. -.PP -Create a file named options that contains the following: -.sp -.nf -\f3\-d classes\fP -.fi -.nf -\f3\-g\fP -.fi -.nf -\f3\-sourcepath /java/pubs/ws/1\&.3/src/share/classes\fP -.fi -.nf -\f3\fP -.fi -.sp -Create a file named classes that contains the following: -.sp -.nf -\f3MyClass1\&.java\fP -.fi -.nf -\f3MyClass2\&.java\fP -.fi -.nf -\f3MyClass3\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -Then, run the \f3javac\fR command as follows: -.sp -.nf -\f3javac @options @classes\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 3 Argument Files with Paths\fR -.PP -The argument files can have paths, but any file names inside the files are relative to the current working directory (not \f3path1\fR or \f3path2\fR): -.sp -.nf -\f3javac @path1/options @path2/classes\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH ANNOTATION\ PROCESSING -The \f3javac\fR command provides direct support for annotation processing, superseding the need for the separate annotation processing command, \f3apt\fR\&. -.PP -The API for annotation processors is defined in the \f3javax\&.annotation\&.processing\fR and j\f3avax\&.lang\&.model\fR packages and subpackages\&. -.SS HOW\ ANNOTATION\ PROCESSING\ WORKS -Unless annotation processing is disabled with the \f3-proc:none\fR option, the compiler searches for any annotation processors that are available\&. The search path can be specified with the \f3-processorpath\fR option\&. If no path is specified, then the user class path is used\&. Processors are located by means of service provider-configuration files named \f3META-INF/services/javax\&.annotation\&.processing\fR\&.Processor on the search path\&. Such files should contain the names of any annotation processors to be used, listed one per line\&. Alternatively, processors can be specified explicitly, using the \f3-processor\fR option\&. -.PP -After scanning the source files and classes on the command line to determine what annotations are present, the compiler queries the processors to determine what annotations they process\&. When a match is found, the processor is called\&. A processor can claim the annotations it processes, in which case no further attempt is made to find any processors for those annotations\&. After all of the annotations are claimed, the compiler does not search for additional processors\&. -.PP -If any processors generate new source files, then another round of annotation processing occurs: Any newly generated source files are scanned, and the annotations processed as before\&. Any processors called on previous rounds are also called on all subsequent rounds\&. This continues until no new source files are generated\&. -.PP -After a round occurs where no new source files are generated, the annotation processors are called one last time, to give them a chance to complete any remaining work\&. Finally, unless the \f3-proc:only\fR option is used, the compiler compiles the original and all generated source files\&. -.SS IMPLICITLY\ LOADED\ SOURCE\ FILES -To compile a set of source files, the compiler might need to implicitly load additional source files\&. See Searching for Types\&. Such files are currently not subject to annotation processing\&. By default, the compiler gives a warning when annotation processing occurred and any implicitly loaded source files are compiled\&. The \f3-implicit\fR option provides a way to suppress the warning\&. -.SH SEARCHING\ FOR\ TYPES -To compile a source file, the compiler often needs information about a type, but the type definition is not in the source files specified on the command line\&. The compiler needs type information for every class or interface used, extended, or implemented in the source file\&. This includes classes and interfaces not explicitly mentioned in the source file, but that provide information through inheritance\&. -.PP -For example, when you create a subclass \f3java\&.applet\&.Applet\fR, you are also using the ancestor classes of \f3Applet\fR: \f3java\&.awt\&.Panel\fR, \f3java\&.awt\&.Container\fR, \f3java\&.awt\&.Component\fR, and \f3java\&.lang\&.Object\fR\&. -.PP -When the compiler needs type information, it searches for a source file or class file that defines the type\&. The compiler searches for class files first in the bootstrap and extension classes, then in the user class path (which by default is the current directory)\&. The user class path is defined by setting the \f3CLASSPATH\fR environment variable or by using the \f3-classpath\fR option\&. -.PP -If you set the \f3-sourcepath\fR option, then the compiler searches the indicated path for source files\&. Otherwise, the compiler searches the user class path for both class files and source files\&. -.PP -You can specify different bootstrap or extension classes with the \f3-bootclasspath\fR and the \f3-extdirs\fR options\&. See Cross-Compilation Options\&. -.PP -A successful type search may produce a class file, a source file, or both\&. If both are found, then you can use the \f3-Xprefer\fR option to instruct the compiler which to use\&. If \f3newer\fR is specified, then the compiler uses the newer of the two files\&. If \f3source\fR is specified, the compiler uses the source file\&. The default is \f3newer\fR\&. -.PP -If a type search finds a source file for a required type, either by itself, or as a result of the setting for the \f3-Xprefer\fR option, then the compiler reads the source file to get the information it needs\&. By default the compiler also compiles the source file\&. You can use the \f3-implicit\fR option to specify the behavior\&. If \f3none\fR is specified, then no class files are generated for the source file\&. If \f3class\fR is specified, then class files are generated for the source file\&. -.PP -The compiler might not discover the need for some type information until after annotation processing completes\&. When the type information is found in a source file and no \f3-implicit\fR option is specified, the compiler gives a warning that the file is being compiled without being subject to annotation processing\&. To disable the warning, either specify the file on the command line (so that it will be subject to annotation processing) or use the \f3-implicit\fR option to specify whether or not class files should be generated for such source files\&. -.SH PROGRAMMATIC\ INTERFACE -The \f3javac\fR command supports the new Java Compiler API defined by the classes and interfaces in the \f3javax\&.tools\fR package\&. -.SS EXAMPLE -To compile as though providing command-line arguments, use the following syntax: -.sp -.nf -\f3JavaCompiler javac = ToolProvider\&.getSystemJavaCompiler();\fP -.fi -.nf -\f3\fP -.fi -.sp -The example writes diagnostics to the standard output stream and returns the exit code that \f3javac\fR would give when called from the command line\&. -.PP -You can use other methods in the \f3javax\&.tools\&.JavaCompiler\fR interface to handle diagnostics, control where files are read from and written to, and more\&. -.SS OLD\ INTERFACE -\fINote:\fR This API is retained for backward compatibility only\&. All new code should use the newer Java Compiler API\&. -.PP -The \f3com\&.sun\&.tools\&.javac\&.Main\fR class provides two static methods to call the compiler from a program: -.sp -.nf -\f3public static int compile(String[] args);\fP -.fi -.nf -\f3public static int compile(String[] args, PrintWriter out);\fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3args\fR parameter represents any of the command-line arguments that would typically be passed to the compiler\&. -.PP -The \f3out\fR parameter indicates where the compiler diagnostic output is directed\&. -.PP -The \f3return\fR value is equivalent to the \f3exit\fR value from \f3javac\fR\&. -.PP -\fINote:\fR All other classes and methods found in a package with names that start with \f3com\&.sun\&.tools\&.javac\fR (subpackages of \f3com\&.sun\&.tools\&.javac\fR) are strictly internal and subject to change at any time\&. -.SH EXAMPLES -\f3Example 1 Compile a Simple Program\fR -.PP -This example shows how to compile the \f3Hello\&.java\fR source file in the greetings directory\&. The class defined in \f3Hello\&.java\fR is called \f3greetings\&.Hello\fR\&. The greetings directory is the package directory both for the source file and the class file and is underneath the current directory\&. This makes it possible to use the default user class path\&. It also makes it unnecessary to specify a separate destination directory with the \f3-d\fR option\&. -.PP -The source code in \f3Hello\&.java\fR: -.sp -.nf -\f3package greetings;\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3public class Hello {\fP -.fi -.nf -\f3 public static void main(String[] args) {\fP -.fi -.nf -\f3 for (int i=0; i < args\&.length; i++) {\fP -.fi -.nf -\f3 System\&.out\&.println("Hello " + args[i]);\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp -Compile greetings\&.Hello: -.sp -.nf -\f3javac greetings/Hello\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -Run \f3greetings\&.Hello\fR: -.sp -.nf -\f3java greetings\&.Hello World Universe Everyone\fP -.fi -.nf -\f3Hello World\fP -.fi -.nf -\f3Hello Universe\fP -.fi -.nf -\f3Hello Everyone\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 2 Compile Multiple Source Files\fR -.PP -This example compiles the \f3Aloha\&.java\fR, \f3GutenTag\&.java\fR, \f3Hello\&.java\fR, and \f3Hi\&.java\fR source files in the \f3greetings\fR package\&. -.sp -.nf -\f3% javac greetings/*\&.java\fP -.fi -.nf -\f3% ls greetings\fP -.fi -.nf -\f3Aloha\&.class GutenTag\&.class Hello\&.class Hi\&.class\fP -.fi -.nf -\f3Aloha\&.java GutenTag\&.java Hello\&.java Hi\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 3 Specify a User Class Path\fR -.PP -After changing one of the source files in the previous example, recompile it: -.sp -.nf -\f3pwd\fP -.fi -.nf -\f3/examples\fP -.fi -.nf -\f3javac greetings/Hi\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -Because \f3greetings\&.Hi\fR refers to other classes in the \f3greetings\fR package, the compiler needs to find these other classes\&. The previous example works because the default user class path is the directory that contains the package directory\&. If you want to recompile this file without concern for which directory you are in, then add the examples directory to the user class path by setting \f3CLASSPATH\fR\&. This example uses the \f3-classpath\fR option\&. -.sp -.nf -\f3javac \-classpath /examples /examples/greetings/Hi\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -If you change \f3greetings\&.Hi\fR to use a banner utility, then that utility also needs to be accessible through the user class path\&. -.sp -.nf -\f3javac \-classpath /examples:/lib/Banners\&.jar \e\fP -.fi -.nf -\f3 /examples/greetings/Hi\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -To execute a class in the \f3greetings\fR package, the program needs access to the \f3greetings\fR package, and to the classes that the \f3greetings\fR classes use\&. -.sp -.nf -\f3java \-classpath /examples:/lib/Banners\&.jar greetings\&.Hi\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 4 Separate Source Files and Class Files\fR -.PP -The following example uses \f3javac\fR to compile code that runs on JVM 1\&.7\&. -.sp -.nf -\f3javac \-source 1\&.7 \-target 1\&.7 \-bootclasspath jdk1\&.7\&.0/lib/rt\&.jar \e \fP -.fi -.nf -\f3\-extdirs "" OldCode\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3-source 1\&.7\fR option specifies that release 1\&.7 (or 7) of the Java programming language be used to compile \f3OldCode\&.java\fR\&. The option \f3-target 1\&.7\fR option ensures that the generated class files are compatible with JVM 1\&.7\&. Note that in most cases, the value of the \f3-target\fR option is the value of the \f3-source\fR option; in this example, you can omit the \f3-target\fR option\&. -.PP -You must specify the \f3-bootclasspath\fR option to specify the correct version of the bootstrap classes (the \f3rt\&.jar\fR library)\&. If not, then the compiler generates a warning: -.sp -.nf -\f3javac \-source 1\&.7 OldCode\&.java\fP -.fi -.nf -\f3warning: [options] bootstrap class path not set in conjunction with \fP -.fi -.nf -\f3\-source 1\&.7\fP -.fi -.nf -\f3\fP -.fi -.sp -If you do not specify the correct version of bootstrap classes, then the compiler uses the old language rules (in this example, it uses version 1\&.7 of the Java programming language) combined with the new bootstrap classes, which can result in class files that do not work on the older platform (in this case, Java SE 7) because reference to nonexistent methods can get included\&. -.PP -\f3Example 5 Cross Compile\fR -.PP -This example uses \f3javac\fR to compile code that runs on JVM 1\&.7\&. -.sp -.nf -\f3javac \-source 1\&.7 \-target 1\&.7 \-bootclasspath jdk1\&.7\&.0/lib/rt\&.jar \e\fP -.fi -.nf -\f3 \-extdirs "" OldCode\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -The\f3-source 1\&.7\fR option specifies that release 1\&.7 (or 7) of the Java programming language to be used to compile OldCode\&.java\&. The \f3-target 1\&.7\fR option ensures that the generated class files are compatible with JVM 1\&.7\&. -.PP -You must specify the \f3-bootclasspath\fR option to specify the correct version of the bootstrap classes (the \f3rt\&.jar\fR library)\&. If not, then the compiler generates a warning: -.sp -.nf -\f3javac \-source 1\&.7 OldCode\&.java\fP -.fi -.nf -\f3warning: [options] bootstrap class path not set in conjunction with \-source 1\&.7\fP -.fi -.nf -\f3\fP -.fi -.sp -If you do not specify the correct version of bootstrap classes, then the compiler uses the old language rules combined with the new bootstrap classes\&. This combination can result in class files that do not work on the older platform (in this case, Java SE 7) because reference to nonexistent methods can get included\&. In this example, the compiler uses release 1\&.7 of the Java programming language\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -jdb(1) -.TP 0.2i -\(bu -javah(1) -.TP 0.2i -\(bu -javadoc(1) -.TP 0.2i -\(bu -jar(1) -.TP 0.2i -\(bu -jdb(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1994, 2015, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 03 March 2015 +.\" SectDesc: Basic Tools +.\" Title: javac.1 +.\" +.if n .pl 99999 +.TH javac 1 "03 March 2015" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +javac \- Reads Java class and interface definitions and compiles them into bytecode and class files\&. +.SH SYNOPSIS +.sp +.nf + +\fBjavac\fR [ \fIoptions\fR ] [ \fIsourcefiles\fR ] [ \fIclasses\fR] [ \fI@argfiles\fR ] +.fi +.sp +Arguments can be in any order: +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.TP +\fIsourcefiles\fR +One or more source files to be compiled (such as \f3MyClass\&.java\fR)\&. +.TP +\fIclasses\fR +One or more classes to be processed for annotations (such as \f3MyPackage\&.MyClass\fR)\&. +.TP +\fI@argfiles\fR +One or more files that list options and source files\&. The \f3-J\fR options are not allowed in these files\&. See Command-Line Argument Files\&. +.SH DESCRIPTION +The \f3javac\fR command reads class and interface definitions, written in the Java programming language, and compiles them into bytecode class files\&. The \f3javac\fR command can also process annotations in Java source files and classes\&. +.PP +There are two ways to pass source code file names to \f3javac\fR\&. +.TP 0.2i +\(bu +For a small number of source files, list the file names on the command line\&. +.TP 0.2i +\(bu +For a large number of source files, list the file names in a file that is separated by blanks or line breaks\&. Use the list file name preceded by an at sign (@) with the \f3javac\fR command\&. +.PP +Source code file names must have \&.java suffixes, class file names must have \&.class suffixes, and both source and class files must have root names that identify the class\&. For example, a class called \f3MyClass\fR would be written in a source file called \f3MyClass\&.java\fR and compiled into a bytecode class file called \f3MyClass\&.class\fR\&. +.PP +Inner class definitions produce additional class files\&. These class files have names that combine the inner and outer class names, such as \f3MyClass$MyInnerClass\&.class\fR\&. +.PP +Arrange source files in a directory tree that reflects their package tree\&. For example, if all of your source files are in \f3/workspace\fR, then put the source code for \f3com\&.mysoft\&.mypack\&.MyClass\fR in \f3/workspace/com/mysoft/mypack/MyClass\&.java\fR\&. +.PP +By default, the compiler puts each class file in the same directory as its source file\&. You can specify a separate destination directory with the \f3-d\fR option\&. +.SH OPTIONS +The compiler has a set of standard options that are supported on the current development environment\&. An additional set of nonstandard options are specific to the current virtual machine and compiler implementations and are subject to change in the future\&. Nonstandard options begin with the \f3-X\fR option\&. +.TP 0.2i +\(bu +See also Cross-Compilation Options +.TP 0.2i +\(bu +See also Nonstandard Options +.SS STANDARD\ OPTIONS +.TP +-A\fIkey\fR[\fI=value\fR] +.br +Specifies options to pass to annotation processors\&. These options are not interpreted by \f3javac\fR directly, but are made available for use by individual processors\&. The \f3key\fR value should be one or more identifiers separated by a dot (\&.)\&. +.TP +-cp \fIpath\fR or -classpath \fIpath\fR +.br +Specifies where to find user class files, and (optionally) annotation processors and source files\&. This class path overrides the user class path in the \f3CLASSPATH\fR environment variable\&. If neither \f3CLASSPATH\fR, \f3-cp\fR nor \f3-classpath\fR is specified, then the user \fIclass path\fR is the current directory\&. See Setting the Class Path\&. + +If the \f3-sourcepath\fR option is not specified, then the user class path is also searched for source files\&. + +If the \f3-processorpath\fR option is not specified, then the class path is also searched for annotation processors\&. +.TP +-Djava\&.ext\&.dirs=\fIdirectories\fR +.br +Overrides the location of installed extensions\&. +.TP +-Djava\&.endorsed\&.dirs=\fIdirectories\fR +.br +Overrides the location of the endorsed standards path\&. +.TP +-d \fIdirectory\fR +.br +Sets the destination directory for class files\&. The directory must already exist because \f3javac\fR does not create it\&. If a class is part of a package, then \f3javac\fR puts the class file in a subdirectory that reflects the package name and creates directories as needed\&. + +If you specify \f3-d\fR\f3/home/myclasses\fR and the class is called \f3com\&.mypackage\&.MyClass\fR, then the class file is \f3/home/myclasses/com/mypackage/MyClass\&.class\fR\&. + +If the \fI-d\fR option is not specified, then \f3javac\fR puts each class file in the same directory as the source file from which it was generated\&. + +\fINote:\fR The directory specified by the \fI-d\fR option is not automatically added to your user class path\&. +.TP +-deprecation +.br +Shows a description of each use or override of a deprecated member or class\&. Without the \f3-deprecation\fR option, \f3javac\fR shows a summary of the source files that use or override deprecated members or classes\&. The \f3-deprecation\fR option is shorthand for \f3-Xlint:deprecation\fR\&. +.TP +-encoding \fIencoding\fR +.br +Sets the source file encoding name, such as EUC-JP and UTF-8\&. If the \f3-encoding\fR option is not specified, then the platform default converter is used\&. +.TP +-endorseddirs \fIdirectories\fR +.br +Overrides the location of the endorsed standards path\&. +.TP +-extdirs \fIdirectories\fR +.br +Overrides the location of the \f3ext\fR directory\&. The directories variable is a colon-separated list of directories\&. Each JAR file in the specified directories is searched for class files\&. All JAR files found become part of the class path\&. + +If you are cross-compiling (compiling classes against bootstrap and extension classes of a different Java platform implementation), then this option specifies the directories that contain the extension classes\&. See Cross-Compilation Options for more information\&. +.TP +-g +.br +Generates all debugging information, including local variables\&. By default, only line number and source file information is generated\&. +.TP +-g:none +.br +Does not generate any debugging information\&. +.TP +-g:[\fIkeyword list\fR] +.br +Generates only some kinds of debugging information, specified by a comma separated list of keywords\&. Valid keywords are: +.RS +.TP +source +Source file debugging information\&. +.TP +lines +Line number debugging information\&. +.TP +vars +Local variable debugging information\&. +.RE + +.TP +-help +.br +Prints a synopsis of standard options\&. +.TP +-implicit:[\fIclass, none\fR] +.br +Controls the generation of class files for implicitly loaded source files\&. To automatically generate class files, use \f3-implicit:class\fR\&. To suppress class file generation, use \f3-implicit:none\fR\&. If this option is not specified, then the default is to automatically generate class files\&. In this case, the compiler issues a warning if any such class files are generated when also doing annotation processing\&. The warning is not issued when the \f3-implicit\fR option is set explicitly\&. See Searching for Types\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. + +\fINote:\fR The \fICLASSPATH\fR, \f3-classpath\fR, \f3-bootclasspath\fR, and \f3-extdirs\fR options do not specify the classes used to run \f3javac\fR\&. Trying to customize the compiler implementation with these options and variables is risky and often does not accomplish what you want\&. If you must customize the complier implementation, then use the \f3-J\fR option to pass options through to the underlying \f3\fRJava launcher\&. +.TP +-nowarn +.br +Disables warning messages\&. This option operates the same as the \f3-Xlint:none\fR option\&. +.TP +-parameters +.br +Stores formal parameter names of constructors and methods in the generated class file so that the method \f3java\&.lang\&.reflect\&.Executable\&.getParameters\fR from the Reflection API can retrieve them\&. +.TP +-proc: [\fInone\fR, \fIonly\fR] +.br +Controls whether annotation processing and compilation are done\&. \f3-proc:none\fR means that compilation takes place without annotation processing\&. \f3-proc:only\fR means that only annotation processing is done, without any subsequent compilation\&. +.TP +-processor \fIclass1\fR [,\fIclass2\fR,\fIclass3\fR\&.\&.\&.] +.br +Names of the annotation processors to run\&. This bypasses the default discovery process\&. +.TP +-processorpath \fIpath\fR +.br +Specifies where to find annotation processors\&. If this option is not used, then the class path is searched for processors\&. +.TP +-s \fIdir\fR +.br +Specifies the directory where to place the generated source files\&. The directory must already exist because \f3javac\fR does not create it\&. If a class is part of a package, then the compiler puts the source file in a subdirectory that reflects the package name and creates directories as needed\&. + +If you specify \f3-s /home/mysrc\fR and the class is called \f3com\&.mypackage\&.MyClass\fR, then the source file is put in \f3/home/mysrc/com/mypackage/MyClass\&.java\fR\&. +.TP +-source \fIrelease\fR +.br +Specifies the version of source code accepted\&. The following values for \f3release\fR are allowed: +.RS +.TP +1\&.3 +The compiler does not support assertions, generics, or other language features introduced after Java SE 1\&.3\&. +.TP +1\&.4 +The compiler accepts code containing assertions, which were introduced in Java SE 1\&.4\&. +.TP +1\&.5 +The compiler accepts code containing generics and other language features introduced in Java SE 5\&. +.TP +5 +Synonym for 1\&.5\&. +.TP +1\&.6 +No language changes were introduced in Java SE 6\&. However, encoding errors in source files are now reported as errors instead of warnings as in earlier releases of Java Platform, Standard Edition\&. +.TP +6 +Synonym for 1\&.6\&. +.TP +1\&.7 +The compiler accepts code with features introduced in Java SE 7\&. +.TP +7 +Synonym for 1\&.7\&. +.TP +1\&.8 +This is the default value\&. The compiler accepts code with features introduced in Java SE 8\&. +.TP +8 +Synonym for 1\&.8\&. +.RE + +.TP +-sourcepath \fIsourcepath\fR +.br +Specifies the source code path to search for class or interface definitions\&. As with the user class path, source path entries are separated by colons (:) on Oracle Solaris and semicolons on Windows and can be directories, JAR archives, or ZIP archives\&. If packages are used, then the local path name within the directory or archive must reflect the package name\&. + +\fINote:\fR Classes found through the class path might be recompiled when their source files are also found\&. See Searching for Types\&. +.TP +-verbose +.br +Uses verbose output, which includes information about each class loaded and each source file compiled\&. +.TP +-version +.br +Prints release information\&. +.TP +-werror +.br +Terminates compilation when warnings occur\&. +.TP +-X +.br +Displays information about nonstandard options and exits\&. +.SS CROSS-COMPILATION\ OPTIONS +By default, classes are compiled against the bootstrap and extension classes of the platform that \f3javac\fR shipped with\&. But \f3javac\fR also supports cross-compiling, where classes are compiled against a bootstrap and extension classes of a different Java platform implementation\&. It is important to use the \f3-bootclasspath\fR and \f3-extdirs\fR options when cross-compiling\&. +.TP +-target \fIversion\fR +.br +Generates class files that target a specified release of the virtual machine\&. Class files will run on the specified target and on later releases, but not on earlier releases of the JVM\&. Valid targets are 1\&.1, 1\&.2, 1\&.3, 1\&.4, 1\&.5 (also 5), 1\&.6 (also 6), 1\&.7 (also 7), and 1\&.8 (also 8)\&. + +The default for the \f3-target\fR option depends on the value of the \f3-source\fR option: +.RS +.TP 0.2i +\(bu +If the \f3-source\fR option is not specified, then the value of the \f3-target\fR option is 1\&.8 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.2, then the value of the \f3-target\fR option is 1\&.4 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.3, then the value of the \f3-target\fR option is 1\&.4 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.5, then the value of the \f3-target\fR option is 1\&.8 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.6, then the value of the \f3-target\fR is option 1\&.8 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.7, then the value of the \f3-target\fR is option 1\&.8 +.TP 0.2i +\(bu +For all other values of the \f3-source\fR option, the value of the \f3-target\fR option is the value of the \f3-source\fR option\&. +.RE + +.TP +-bootclasspath \fIbootclasspath\fR +.br +Cross-compiles against the specified set of boot classes\&. As with the user class path, boot class path entries are separated by colons (:) and can be directories, JAR archives, or ZIP archives\&. +.SS COMPACT\ PROFILE\ OPTION +Beginning with JDK 8, the \f3javac\fR compiler supports compact profiles\&. With compact profiles, applications that do not require the entire Java platform can be deployed and run with a smaller footprint\&. The compact profiles feature could be used to shorten the download time for applications from app stores\&. This feature makes for more compact deployment of Java applications that bundle the JRE\&. This feature is also useful in small devices\&. +.PP +The supported profile values are \f3compact1\fR, \f3compact2\fR, and \f3compact3\fR\&. These are additive layers\&. Each higher-numbered compact profile contains all of the APIs in profiles with smaller number names\&. +.TP +-profile +.br +When using compact profiles, this option specifies the profile name when compiling\&. For example: +.sp +.nf +\f3javac \-profile compact1 Hello\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp + + +javac does not compile source code that uses any Java SE APIs that is not in the specified profile\&. Here is an example of the error message that results from attempting to compile such source code: +.sp +.nf +\f3cd jdk1\&.8\&.0/bin\fP +.fi +.nf +\f3\&./javac \-profile compact1 Paint\&.java\fP +.fi +.nf +\f3Paint\&.java:5: error: Applet is not available in profile \&'compact1\&'\fP +.fi +.nf +\f3import java\&.applet\&.Applet;\fP +.fi +.nf +\f3\fP +.fi +.sp + + +In this example, you can correct the error by modifying the source to not use the \f3Applet\fR class\&. You could also correct the error by compiling without the -profile option\&. Then the compilation would be run against the full set of Java SE APIs\&. (None of the compact profiles include the \f3Applet\fR class\&.) + +An alternative way to compile with compact profiles is to use the \f3-bootclasspath\fR option to specify a path to an \f3rt\&.jar\fR file that specifies a profile\&'s image\&. Using the \f3-profile\fR option instead does not require a profile image to be present on the system at compile time\&. This is useful when cross-compiling\&. +.SS NONSTANDARD\ OPTIONS +.TP +-Xbootclasspath/p:\fIpath\fR +.br +Adds a suffix to the bootstrap class path\&. +.TP +-Xbootclasspath/a:\fIpath\fR +.br +Adds a prefix to the bootstrap class path\&. +.TP +-Xbootclasspath/:\fIpath\fR +.br +Overrides the location of the bootstrap class files\&. +.TP +-Xdoclint:[-]\fIgroup\fR [\fI/access\fR] +.br +Enables or disables specific groups of checks, where \fIgroup\fR is one of the following values: \f3accessibility\fR, \f3syntax\fR, \f3reference\fR, \f3html\fR or \f3missing\fR\&. For more information about these groups of checks see the \f3-Xdoclint\fR option of the \f3javadoc\fR command\&. The \f3-Xdoclint\fR option is disabled by default in the \f3javac\fR command\&. + +The variable \fIaccess\fR specifies the minimum visibility level of classes and members that the \f3-Xdoclint\fR option checks\&. It can have one of the following values (in order of most to least visible) : \f3public\fR, \f3protected\fR, \f3package\fR and \f3private\fR\&. For example, the following option checks classes and members (with all groups of checks) that have the access level protected and higher (which includes protected, package and public): +.sp +.nf +\f3\-Xdoclint:all/protected\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following option enables all groups of checks for all access levels, except it will not check for HTML errors for classes and members that have access level package and higher (which includes package and public): +.sp +.nf +\f3\-Xdoclint:all,\-html/package\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-Xdoclint:none +.br +Disables all groups of checks\&. +.TP +-Xdoclint:all[\fI/access\fR] +.br +Enables all groups of checks\&. +.TP +-Xlint +.br +\fI\fREnables all recommended warnings\&. In this release, enabling all available warnings is recommended\&. +.TP +-Xlint:all +.br +\fI\fREnables all recommended warnings\&. In this release, enabling all available warnings is recommended\&. +.TP +-Xlint:none +.br +Disables all warnings\&. +.TP +-Xlint:\fIname\fR +.br +Disables warning name\&. See Enable or Disable Warnings with the -Xlint Option for a list of warnings you can disable with this option\&. +.TP +-Xlint:\fI-name\fR +.br +Disables warning name\&. See Enable or Disable Warnings with the -Xlint Option with the \f3-Xlint\fR option to get a list of warnings that you can disable with this option\&. +.TP +-Xmaxerrs \fInumber\fR +.br +Sets the maximum number of errors to print\&. +.TP +-Xmaxwarns \fInumber\fR +.br +Sets the maximum number of warnings to print\&. +.TP +-Xstdout \fIfilename\fR +.br +Sends compiler messages to the named file\&. By default, compiler messages go to \f3System\&.err\fR\&. +.TP +-Xprefer:[\fInewer,source\fR] +.br +Specifies which file to read when both a source file and class file are found for a type\&. (See Searching for Types)\&. If the \f3-Xprefer:newer\fR option is used, then it reads the newer of the source or class file for a type (default)\&. If the \f3-Xprefer:source\fR option is used, then it reads the source file\&. Use -\f3Xprefer:source\fR when you want to be sure that any annotation processors can access annotations declared with a retention policy of \f3SOURCE\fR\&. +.TP +-Xpkginfo:[\fIalways\fR,\fIlegacy\fR,\fInonempty\fR] +.br +Control whether javac generates \f3package-info\&.class\fR files from package-info\&.java files\&. Possible mode arguments for this option include the following\&. +.RS +.TP +always +Always generate a \f3package-info\&.class\fR file for every \f3package-info\&.java\fR file\&. This option may be useful if you use a build system such as Ant, which checks that each \f3\&.java\fR file has a corresponding \f3\&.class\fR file\&. +.TP +legacy +Generate a \f3package-info\&.class\fR file only if package-info\&.java contains annotations\&. Don\&'t generate a \f3package-info\&.class\fR file if package-info\&.java only contains comments\&. + +\fINote:\fR A \f3package-info\&.class\fR file might be generated but be empty if all the annotations in the package-info\&.java file have \f3RetentionPolicy\&.SOURCE\fR\&. +.TP +nonempty +Generate a \f3package-info\&.class\fR file only if package-info\&.java contains annotations with \f3RetentionPolicy\&.CLASS\fR or \f3RetentionPolicy\&.RUNTIME\fR\&. +.RE + +.TP +-Xprint +.br +Prints a textual representation of specified types for debugging purposes\&. Perform neither annotation processing nor compilation\&. The format of the output could change\&. +.TP +-XprintProcessorInfo +.br +Prints information about which annotations a processor is asked to process\&. +.TP +-XprintRounds +.br +Prints information about initial and subsequent annotation processing rounds\&. +.SH ENABLE\ OR\ DISABLE\ WARNINGS\ WITH\ THE\ -XLINT\ OPTION +Enable warning \fIname\fR with the \f3-Xlint:name\fR option, where \f3name\fR is one of the following warning names\&. Note that you can disable a warning with the \f3-Xlint:-name:\fR option\&. +.TP +cast +Warns about unnecessary and redundant casts, for example: +.sp +.nf +\f3String s = (String) "Hello!"\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +classfile +Warns about issues related to class file contents\&. +.TP +deprecation +Warns about the use of deprecated items, for example: +.sp +.nf +\f3java\&.util\&.Date myDate = new java\&.util\&.Date();\fP +.fi +.nf +\f3int currentDay = myDate\&.getDay();\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The method \f3java\&.util\&.Date\&.getDay\fR has been deprecated since JDK 1\&.1 +.TP +dep-ann +Warns about items that are documented with an \f3@deprecated\fR Javadoc comment, but do not have a \f3@Deprecated\fR annotation, for example: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @deprecated As of Java SE 7, replaced by {@link #newMethod()}\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public static void deprecatedMethood() { }\fP +.fi +.nf +\f3public static void newMethod() { }\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +divzero +Warns about division by the constant integer 0, for example: +.sp +.nf +\f3int divideByZero = 42 / 0;\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +empty +Warns about empty statements after \f3if\fRstatements, for example: +.sp +.nf +\f3class E {\fP +.fi +.nf +\f3 void m() {\fP +.fi +.nf +\f3 if (true) ;\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +fallthrough +Checks the switch blocks for fall-through cases and provides a warning message for any that are found\&. Fall-through cases are cases in a switch block, other than the last case in the block, whose code does not include a break statement, allowing code execution to fall through from that case to the next case\&. For example, the code following the case 1 label in this switch block does not end with a break statement: +.sp +.nf +\f3switch (x) {\fP +.fi +.nf +\f3case 1:\fP +.fi +.nf +\f3 System\&.out\&.println("1");\fP +.fi +.nf +\f3 // No break statement here\&.\fP +.fi +.nf +\f3case 2:\fP +.fi +.nf +\f3 System\&.out\&.println("2");\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If the \f3-Xlint:fallthrough\fR option was used when compiling this code, then the compiler emits a warning about possible fall-through into case, with the line number of the case in question\&. +.TP +finally +Warns about \f3finally\fR clauses that cannot complete normally, for example: +.sp +.nf +\f3public static int m() {\fP +.fi +.nf +\f3 try {\fP +.fi +.nf +\f3 throw new NullPointerException();\fP +.fi +.nf +\f3 } catch (NullPointerException(); {\fP +.fi +.nf +\f3 System\&.err\&.println("Caught NullPointerException\&.");\fP +.fi +.nf +\f3 return 1;\fP +.fi +.nf +\f3 } finally {\fP +.fi +.nf +\f3 return 0;\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The compiler generates a warning for the \f3finally\fR block in this example\&. When the \f3int\fR method is called, it returns a value of 0\&. A \f3finally\fR block executes when the \f3try\fR block exits\&. In this example, when control is transferred to the \f3catch\fR block, the \f3int\fR method exits\&. However, the \f3finally\fR block must execute, so it is executed, even though control was transferred outside the method\&. +.TP +options +Warns about issues that related to the use of command-line options\&. See Cross-Compilation Options\&. +.TP +overrides +Warns about issues regarding method overrides\&. For example, consider the following two classes: +.sp +.nf +\f3public class ClassWithVarargsMethod {\fP +.fi +.nf +\f3 void varargsMethod(String\&.\&.\&. s) { }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class ClassWithOverridingMethod extends ClassWithVarargsMethod {\fP +.fi +.nf +\f3 @Override\fP +.fi +.nf +\f3 void varargsMethod(String[] s) { }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The compiler generates a warning similar to the following:\&. +.sp +.nf +\f3warning: [override] varargsMethod(String[]) in ClassWithOverridingMethod \fP +.fi +.nf +\f3overrides varargsMethod(String\&.\&.\&.) in ClassWithVarargsMethod; overriding\fP +.fi +.nf +\f3method is missing \&'\&.\&.\&.\&'\fP +.fi +.nf +\f3\fP +.fi +.sp + + +When the compiler encounters a \f3varargs\fR method, it translates the \f3varargs\fR formal parameter into an array\&. In the method \f3ClassWithVarargsMethod\&.varargsMethod\fR, the compiler translates the \f3varargs\fR formal parameter \f3String\&.\&.\&. s\fR to the formal parameter \f3String[] s\fR, an array, which matches the formal parameter of the method \f3ClassWithOverridingMethod\&.varargsMethod\fR\&. Consequently, this example compiles\&. +.TP +path +Warns about invalid path elements and nonexistent path directories on the command line (with regard to the class path, the source path, and other paths)\&. Such warnings cannot be suppressed with the \f3@SuppressWarnings\fR annotation, for example: +.sp +.nf +\f3javac \-Xlint:path \-classpath /nonexistentpath Example\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +processing +Warn about issues regarding annotation processing\&. The compiler generates this warning when you have a class that has an annotation, and you use an annotation processor that cannot handle that type of exception\&. For example, the following is a simple annotation processor: + +\fISource file AnnocProc\&.java\fR: +.sp +.nf +\f3import java\&.util\&.*;\fP +.fi +.nf +\f3import javax\&.annotation\&.processing\&.*;\fP +.fi +.nf +\f3import javax\&.lang\&.model\&.*;\fP +.fi +.nf +\f3import\&.javaz\&.lang\&.model\&.element\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3@SupportedAnnotationTypes("NotAnno")\fP +.fi +.nf +\f3public class AnnoProc extends AbstractProcessor {\fP +.fi +.nf +\f3 public boolean process(Set<? extends TypeElement> elems, RoundEnvironment renv){\fP +.fi +.nf +\f3 return true;\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public SourceVersion getSupportedSourceVersion() {\fP +.fi +.nf +\f3 return SourceVersion\&.latest();\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fISource file AnnosWithoutProcessors\&.java\fR: +.sp +.nf +\f3@interface Anno { }\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3@Anno\fP +.fi +.nf +\f3class AnnosWithoutProcessors { }\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following commands compile the annotation processor \f3AnnoProc\fR, then run this annotation processor against the source file \f3AnnosWithoutProcessors\&.java\fR: +.sp +.nf +\f3javac AnnoProc\&.java\fP +.fi +.nf +\f3javac \-cp \&. \-Xlint:processing \-processor AnnoProc \-proc:only AnnosWithoutProcessors\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp + + +When the compiler runs the annotation processor against the source file \f3AnnosWithoutProcessors\&.java\fR, it generates the following warning: +.sp +.nf +\f3warning: [processing] No processor claimed any of these annotations: Anno\fP +.fi +.nf +\f3\fP +.fi +.sp + + +To resolve this issue, you can rename the annotation defined and used in the class \f3AnnosWithoutProcessors\fR from \f3Anno\fR to \f3NotAnno\fR\&. +.TP +rawtypes +Warns about unchecked operations on raw types\&. The following statement generates a \f3rawtypes\fR warning: +.sp +.nf +\f3void countElements(List l) { \&.\&.\&. }\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following example does not generate a \f3rawtypes\fR warning +.sp +.nf +\f3void countElements(List<?> l) { \&.\&.\&. }\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\f3List\fR is a raw type\&. However, \f3List<?>\fR is an unbounded wildcard parameterized type\&. Because \f3List\fR is a parameterized interface, always specify its type argument\&. In this example, the \f3List\fR formal argument is specified with an unbounded wildcard (\f3?\fR) as its formal type parameter, which means that the \f3countElements\fR method can accept any instantiation of the \f3List\fR interface\&. +.TP +Serial +Warns about missing \f3serialVersionUID\fR definitions on serializable classes, for example: +.sp +.nf +\f3public class PersistentTime implements Serializable\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3 private Date time;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public PersistentTime() {\fP +.fi +.nf +\f3 time = Calendar\&.getInstance()\&.getTime();\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public Date getTime() {\fP +.fi +.nf +\f3 return time;\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The compiler generates the following warning: +.sp +.nf +\f3warning: [serial] serializable class PersistentTime has no definition of\fP +.fi +.nf +\f3serialVersionUID\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If a serializable class does not explicitly declare a field named \f3serialVersionUID\fR, then the serialization runtime environment calculates a default \f3serialVersionUID\fR value for that class based on various aspects of the class, as described in the Java Object Serialization Specification\&. However, it is strongly recommended that all serializable classes explicitly declare \f3serialVersionUID\fR values because the default process of computing \f3serialVersionUID\fR vales is highly sensitive to class details that can vary depending on compiler implementations, and as a result, might cause an unexpected \f3InvalidClassExceptions\fR during deserialization\&. To guarantee a consistent \f3serialVersionUID\fR value across different Java compiler implementations, a serializable class must declare an explicit \f3serialVersionUID\fR value\&. +.TP +static +Warns about issues relating to the use of statics, for example: +.sp +.nf +\f3class XLintStatic {\fP +.fi +.nf +\f3 static void m1() { }\fP +.fi +.nf +\f3 void m2() { this\&.m1(); }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The compiler generates the following warning: +.sp +.nf +\f3warning: [static] static method should be qualified by type name, \fP +.fi +.nf +\f3XLintStatic, instead of by an expression\fP +.fi +.nf +\f3\fP +.fi +.sp + + +To resolve this issue, you can call the \f3static\fR method \f3m1\fR as follows: +.sp +.nf +\f3XLintStatic\&.m1();\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Alternately, you can remove the \f3static\fR keyword from the declaration of the method \f3m1\fR\&. +.TP +try +Warns about issues relating to use of \f3try\fR blocks, including try-with-resources statements\&. For example, a warning is generated for the following statement because the resource \f3ac\fR declared in the \f3try\fR block is not used: +.sp +.nf +\f3try ( AutoCloseable ac = getResource() ) { // do nothing}\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +unchecked +Gives more detail for unchecked conversion warnings that are mandated by the Java Language Specification, for example: +.sp +.nf +\f3List l = new ArrayList<Number>();\fP +.fi +.nf +\f3List<String> ls = l; // unchecked warning\fP +.fi +.nf +\f3\fP +.fi +.sp + + +During type erasure, the types \f3ArrayList<Number>\fR and \f3List<String>\fR become \f3ArrayList\fR and \f3List\fR, respectively\&. + +The \f3ls\fR command has the parameterized type \f3List<String>\fR\&. When the \f3List\fR referenced by \f3l\fR is assigned to \f3ls\fR, the compiler generates an unchecked warning\&. At compile time, the compiler and JVM cannot determine whether \f3l\fR refers to a \f3List<String>\fR type\&. In this case, \f3l\fR does not refer to a \f3List<String>\fR type\&. As a result, heap pollution occurs\&. + +A heap pollution situation occurs when the \f3List\fR object \f3l\fR, whose static type is \f3List<Number>\fR, is assigned to another \f3List\fR object, \f3ls\fR, that has a different static type, \f3List<String>\fR\&. However, the compiler still allows this assignment\&. It must allow this assignment to preserve backward compatibility with releases of Java SE that do not support generics\&. Because of type erasure, \f3List<Number>\fR and \f3List<String>\fR both become \f3List\fR\&. Consequently, the compiler allows the assignment of the object \f3l\fR\f3,\fR which has a raw type of \f3List\fR, to the object \f3ls\fR\&. +.TP +varargs +Warns about unsafe usages of variable arguments (\f3varargs\fR) methods, in particular, those that contain non-reifiable arguments, for example: +.sp +.nf +\f3public class ArrayBuilder {\fP +.fi +.nf +\f3 public static <T> void addToList (List<T> listArg, T\&.\&.\&. elements) {\fP +.fi +.nf +\f3 for (T x : elements) {\fP +.fi +.nf +\f3 listArg\&.add(x);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fINote:\fR A non-reifiable type is a type whose type information is not fully available at runtime\&. + +The compiler generates the following warning for the definition of the method \f3ArrayBuilder\&.addToList\fR +.sp +.nf +\f3warning: [varargs] Possible heap pollution from parameterized vararg type T\fP +.fi +.nf +\f3\fP +.fi +.sp + + +When the compiler encounters a varargs method, it translates the \f3varargs\fR formal parameter into an array\&. However, the Java programming language does not permit the creation of arrays of parameterized types\&. In the method \f3ArrayBuilder\&.addToList\fR, the compiler translates the \f3varargs\fR formal parameter \f3T\&.\&.\&.\fR elements to the formal parameter \f3T[]\fR elements, an array\&. However, because of type erasure, the compiler converts the \f3varargs\fR formal parameter to \f3Object[]\fR elements\&. Consequently, there is a possibility of heap pollution\&. +.SH COMMAND-LINE\ ARGUMENT\ FILES +To shorten or simplify the \f3javac\fR command, you can specify one or more files that contain arguments to the \f3javac\fR command (except \f3-J\fR options)\&. This enables you to create \f3javac\fR commands of any length on any operating system\&. +.PP +An argument file can include \f3javac\fR options and source file names in any combination\&. The arguments within a file can be separated by spaces or new line characters\&. If a file name contains embedded spaces, then put the whole file name in double quotation marks\&. +.PP +File Names within an argument file are relative to the current directory, not the location of the argument file\&. Wild cards (*) are not allowed in these lists (such as for specifying \f3*\&.java\fR)\&. Use of the at sign (@) to recursively interpret files is not supported\&. The \f3-J\fR options are not supported because they are passed to the launcher, which does not support argument files\&. +.PP +When executing the \f3javac\fR command, pass in the path and name of each argument file with the at sign (@) leading character\&. When the \f3javac\fR command encounters an argument beginning with the at sign (@), it expands the contents of that file into the argument list\&. +.PP +\f3Example 1 Single Argument File\fR +.PP +You could use a single argument file named \f3argfile\fR to hold all \f3javac\fR arguments: +.sp +.nf +\f3javac @argfile\fP +.fi +.nf +\f3\fP +.fi +.sp +This argument file could contain the contents of both files shown in Example 2 +.PP +\f3Example 2 Two Argument Files\fR +.PP +You can create two argument files: one for the \f3javac\fR options and the other for the source file names\&. Note that the following lists have no line-continuation characters\&. +.PP +Create a file named options that contains the following: +.sp +.nf +\f3\-d classes\fP +.fi +.nf +\f3\-g\fP +.fi +.nf +\f3\-sourcepath /java/pubs/ws/1\&.3/src/share/classes\fP +.fi +.nf +\f3\fP +.fi +.sp +Create a file named classes that contains the following: +.sp +.nf +\f3MyClass1\&.java\fP +.fi +.nf +\f3MyClass2\&.java\fP +.fi +.nf +\f3MyClass3\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +Then, run the \f3javac\fR command as follows: +.sp +.nf +\f3javac @options @classes\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 3 Argument Files with Paths\fR +.PP +The argument files can have paths, but any file names inside the files are relative to the current working directory (not \f3path1\fR or \f3path2\fR): +.sp +.nf +\f3javac @path1/options @path2/classes\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH ANNOTATION\ PROCESSING +The \f3javac\fR command provides direct support for annotation processing, superseding the need for the separate annotation processing command, \f3apt\fR\&. +.PP +The API for annotation processors is defined in the \f3javax\&.annotation\&.processing\fR and j\f3avax\&.lang\&.model\fR packages and subpackages\&. +.SS HOW\ ANNOTATION\ PROCESSING\ WORKS +Unless annotation processing is disabled with the \f3-proc:none\fR option, the compiler searches for any annotation processors that are available\&. The search path can be specified with the \f3-processorpath\fR option\&. If no path is specified, then the user class path is used\&. Processors are located by means of service provider-configuration files named \f3META-INF/services/javax\&.annotation\&.processing\fR\&.Processor on the search path\&. Such files should contain the names of any annotation processors to be used, listed one per line\&. Alternatively, processors can be specified explicitly, using the \f3-processor\fR option\&. +.PP +After scanning the source files and classes on the command line to determine what annotations are present, the compiler queries the processors to determine what annotations they process\&. When a match is found, the processor is called\&. A processor can claim the annotations it processes, in which case no further attempt is made to find any processors for those annotations\&. After all of the annotations are claimed, the compiler does not search for additional processors\&. +.PP +If any processors generate new source files, then another round of annotation processing occurs: Any newly generated source files are scanned, and the annotations processed as before\&. Any processors called on previous rounds are also called on all subsequent rounds\&. This continues until no new source files are generated\&. +.PP +After a round occurs where no new source files are generated, the annotation processors are called one last time, to give them a chance to complete any remaining work\&. Finally, unless the \f3-proc:only\fR option is used, the compiler compiles the original and all generated source files\&. +.SS IMPLICITLY\ LOADED\ SOURCE\ FILES +To compile a set of source files, the compiler might need to implicitly load additional source files\&. See Searching for Types\&. Such files are currently not subject to annotation processing\&. By default, the compiler gives a warning when annotation processing occurred and any implicitly loaded source files are compiled\&. The \f3-implicit\fR option provides a way to suppress the warning\&. +.SH SEARCHING\ FOR\ TYPES +To compile a source file, the compiler often needs information about a type, but the type definition is not in the source files specified on the command line\&. The compiler needs type information for every class or interface used, extended, or implemented in the source file\&. This includes classes and interfaces not explicitly mentioned in the source file, but that provide information through inheritance\&. +.PP +For example, when you create a subclass \f3java\&.applet\&.Applet\fR, you are also using the ancestor classes of \f3Applet\fR: \f3java\&.awt\&.Panel\fR, \f3java\&.awt\&.Container\fR, \f3java\&.awt\&.Component\fR, and \f3java\&.lang\&.Object\fR\&. +.PP +When the compiler needs type information, it searches for a source file or class file that defines the type\&. The compiler searches for class files first in the bootstrap and extension classes, then in the user class path (which by default is the current directory)\&. The user class path is defined by setting the \f3CLASSPATH\fR environment variable or by using the \f3-classpath\fR option\&. +.PP +If you set the \f3-sourcepath\fR option, then the compiler searches the indicated path for source files\&. Otherwise, the compiler searches the user class path for both class files and source files\&. +.PP +You can specify different bootstrap or extension classes with the \f3-bootclasspath\fR and the \f3-extdirs\fR options\&. See Cross-Compilation Options\&. +.PP +A successful type search may produce a class file, a source file, or both\&. If both are found, then you can use the \f3-Xprefer\fR option to instruct the compiler which to use\&. If \f3newer\fR is specified, then the compiler uses the newer of the two files\&. If \f3source\fR is specified, the compiler uses the source file\&. The default is \f3newer\fR\&. +.PP +If a type search finds a source file for a required type, either by itself, or as a result of the setting for the \f3-Xprefer\fR option, then the compiler reads the source file to get the information it needs\&. By default the compiler also compiles the source file\&. You can use the \f3-implicit\fR option to specify the behavior\&. If \f3none\fR is specified, then no class files are generated for the source file\&. If \f3class\fR is specified, then class files are generated for the source file\&. +.PP +The compiler might not discover the need for some type information until after annotation processing completes\&. When the type information is found in a source file and no \f3-implicit\fR option is specified, the compiler gives a warning that the file is being compiled without being subject to annotation processing\&. To disable the warning, either specify the file on the command line (so that it will be subject to annotation processing) or use the \f3-implicit\fR option to specify whether or not class files should be generated for such source files\&. +.SH PROGRAMMATIC\ INTERFACE +The \f3javac\fR command supports the new Java Compiler API defined by the classes and interfaces in the \f3javax\&.tools\fR package\&. +.SS EXAMPLE +To compile as though providing command-line arguments, use the following syntax: +.sp +.nf +\f3JavaCompiler javac = ToolProvider\&.getSystemJavaCompiler();\fP +.fi +.nf +\f3\fP +.fi +.sp +The example writes diagnostics to the standard output stream and returns the exit code that \f3javac\fR would give when called from the command line\&. +.PP +You can use other methods in the \f3javax\&.tools\&.JavaCompiler\fR interface to handle diagnostics, control where files are read from and written to, and more\&. +.SS OLD\ INTERFACE +\fINote:\fR This API is retained for backward compatibility only\&. All new code should use the newer Java Compiler API\&. +.PP +The \f3com\&.sun\&.tools\&.javac\&.Main\fR class provides two static methods to call the compiler from a program: +.sp +.nf +\f3public static int compile(String[] args);\fP +.fi +.nf +\f3public static int compile(String[] args, PrintWriter out);\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3args\fR parameter represents any of the command-line arguments that would typically be passed to the compiler\&. +.PP +The \f3out\fR parameter indicates where the compiler diagnostic output is directed\&. +.PP +The \f3return\fR value is equivalent to the \f3exit\fR value from \f3javac\fR\&. +.PP +\fINote:\fR All other classes and methods found in a package with names that start with \f3com\&.sun\&.tools\&.javac\fR (subpackages of \f3com\&.sun\&.tools\&.javac\fR) are strictly internal and subject to change at any time\&. +.SH EXAMPLES +\f3Example 1 Compile a Simple Program\fR +.PP +This example shows how to compile the \f3Hello\&.java\fR source file in the greetings directory\&. The class defined in \f3Hello\&.java\fR is called \f3greetings\&.Hello\fR\&. The greetings directory is the package directory both for the source file and the class file and is underneath the current directory\&. This makes it possible to use the default user class path\&. It also makes it unnecessary to specify a separate destination directory with the \f3-d\fR option\&. +.PP +The source code in \f3Hello\&.java\fR: +.sp +.nf +\f3package greetings;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class Hello {\fP +.fi +.nf +\f3 public static void main(String[] args) {\fP +.fi +.nf +\f3 for (int i=0; i < args\&.length; i++) {\fP +.fi +.nf +\f3 System\&.out\&.println("Hello " + args[i]);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +Compile greetings\&.Hello: +.sp +.nf +\f3javac greetings/Hello\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +Run \f3greetings\&.Hello\fR: +.sp +.nf +\f3java greetings\&.Hello World Universe Everyone\fP +.fi +.nf +\f3Hello World\fP +.fi +.nf +\f3Hello Universe\fP +.fi +.nf +\f3Hello Everyone\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 2 Compile Multiple Source Files\fR +.PP +This example compiles the \f3Aloha\&.java\fR, \f3GutenTag\&.java\fR, \f3Hello\&.java\fR, and \f3Hi\&.java\fR source files in the \f3greetings\fR package\&. +.sp +.nf +\f3% javac greetings/*\&.java\fP +.fi +.nf +\f3% ls greetings\fP +.fi +.nf +\f3Aloha\&.class GutenTag\&.class Hello\&.class Hi\&.class\fP +.fi +.nf +\f3Aloha\&.java GutenTag\&.java Hello\&.java Hi\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 3 Specify a User Class Path\fR +.PP +After changing one of the source files in the previous example, recompile it: +.sp +.nf +\f3pwd\fP +.fi +.nf +\f3/examples\fP +.fi +.nf +\f3javac greetings/Hi\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +Because \f3greetings\&.Hi\fR refers to other classes in the \f3greetings\fR package, the compiler needs to find these other classes\&. The previous example works because the default user class path is the directory that contains the package directory\&. If you want to recompile this file without concern for which directory you are in, then add the examples directory to the user class path by setting \f3CLASSPATH\fR\&. This example uses the \f3-classpath\fR option\&. +.sp +.nf +\f3javac \-classpath /examples /examples/greetings/Hi\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +If you change \f3greetings\&.Hi\fR to use a banner utility, then that utility also needs to be accessible through the user class path\&. +.sp +.nf +\f3javac \-classpath /examples:/lib/Banners\&.jar \e\fP +.fi +.nf +\f3 /examples/greetings/Hi\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +To execute a class in the \f3greetings\fR package, the program needs access to the \f3greetings\fR package, and to the classes that the \f3greetings\fR classes use\&. +.sp +.nf +\f3java \-classpath /examples:/lib/Banners\&.jar greetings\&.Hi\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 4 Separate Source Files and Class Files\fR +.PP +The following example uses \f3javac\fR to compile code that runs on JVM 1\&.7\&. +.sp +.nf +\f3javac \-source 1\&.7 \-target 1\&.7 \-bootclasspath jdk1\&.7\&.0/lib/rt\&.jar \e \fP +.fi +.nf +\f3\-extdirs "" OldCode\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3-source 1\&.7\fR option specifies that release 1\&.7 (or 7) of the Java programming language be used to compile \f3OldCode\&.java\fR\&. The option \f3-target 1\&.7\fR option ensures that the generated class files are compatible with JVM 1\&.7\&. Note that in most cases, the value of the \f3-target\fR option is the value of the \f3-source\fR option; in this example, you can omit the \f3-target\fR option\&. +.PP +You must specify the \f3-bootclasspath\fR option to specify the correct version of the bootstrap classes (the \f3rt\&.jar\fR library)\&. If not, then the compiler generates a warning: +.sp +.nf +\f3javac \-source 1\&.7 OldCode\&.java\fP +.fi +.nf +\f3warning: [options] bootstrap class path not set in conjunction with \fP +.fi +.nf +\f3\-source 1\&.7\fP +.fi +.nf +\f3\fP +.fi +.sp +If you do not specify the correct version of bootstrap classes, then the compiler uses the old language rules (in this example, it uses version 1\&.7 of the Java programming language) combined with the new bootstrap classes, which can result in class files that do not work on the older platform (in this case, Java SE 7) because reference to nonexistent methods can get included\&. +.PP +\f3Example 5 Cross Compile\fR +.PP +This example uses \f3javac\fR to compile code that runs on JVM 1\&.7\&. +.sp +.nf +\f3javac \-source 1\&.7 \-target 1\&.7 \-bootclasspath jdk1\&.7\&.0/lib/rt\&.jar \e\fP +.fi +.nf +\f3 \-extdirs "" OldCode\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +The\f3-source 1\&.7\fR option specifies that release 1\&.7 (or 7) of the Java programming language to be used to compile OldCode\&.java\&. The \f3-target 1\&.7\fR option ensures that the generated class files are compatible with JVM 1\&.7\&. +.PP +You must specify the \f3-bootclasspath\fR option to specify the correct version of the bootstrap classes (the \f3rt\&.jar\fR library)\&. If not, then the compiler generates a warning: +.sp +.nf +\f3javac \-source 1\&.7 OldCode\&.java\fP +.fi +.nf +\f3warning: [options] bootstrap class path not set in conjunction with \-source 1\&.7\fP +.fi +.nf +\f3\fP +.fi +.sp +If you do not specify the correct version of bootstrap classes, then the compiler uses the old language rules combined with the new bootstrap classes\&. This combination can result in class files that do not work on the older platform (in this case, Java SE 7) because reference to nonexistent methods can get included\&. In this example, the compiler uses release 1\&.7 of the Java programming language\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jdb(1) +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +javadoc(1) +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +jdb(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/javadoc.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/javadoc.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,3004 +1,3004 @@ -'\" t -.\" Copyright (c) 1994, 2015, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 03 March 2015 -.\" SectDesc: Basic Tools -.\" Title: javadoc.1 -.\" -.if n .pl 99999 -.TH javadoc 1 "03 March 2015" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -javadoc \- Generates HTML pages of API documentation from Java source files\&. -.SH SYNOPSIS -.sp -.nf - -\fBjavadoc\fR {\fIpackages\fR|\fIsource\-files\fR} [\fIoptions\fR] [\fI@argfiles\fR] -.fi -.sp -.TP -\fIpackages\fR -Names of packages that you want to document, separated by spaces, for example \f3java\&.lang java\&.lang\&.reflect java\&.awt\fR\&. If you want to also document the subpackages, use the \f3-subpackages\fR option to specify the packages\&. - -By default, \f3javadoc\fR looks for the specified packages in the current directory and subdirectories\&. Use the \f3-sourcepath\fR option to specify the list of directories where to look for packages\&. -.TP -\fIsource-files\fR -Names of Java source files that you want to document, separated by spaces, for example \f3Class\&.java Object\&.java Button\&.java\fR\&. By default, \f3javadoc\fR looks for the specified classes in the current directory\&. However, you can specify the full path to the class file and use wildcard characters, for example \f3/home/src/java/awt/Graphics*\&.java\fR\&. You can also specify the path relative to the current directory\&. -.TP -\fIoptions\fR -Command-line options, separated by spaces\&. See Options\&. -.TP -\fI@argfiles\fR -Names of files that contain a list of \f3javadoc\fR command options, package names and source file names in any order\&. -.SH DESCRIPTION -The \f3javadoc\fR command parses the declarations and documentation comments in a set of Java source files and produces a corresponding set of HTML pages that describe (by default) the public and protected classes, nested classes (but not anonymous inner classes), interfaces, constructors, methods, and fields\&. You can use the \f3javadoc\fR command to generate the API documentation or the implementation documentation for a set of source files\&. -.PP -You can run the \f3javadoc\fR command on entire packages, individual source files, or both\&. When documenting entire packages, you can either use the \f3-subpackages\fR option to recursively traverse a directory and its subdirectories, or to pass in an explicit list of package names\&. When you document individual source files, pass in a list of Java source file names\&. See Simple Examples\&. -.SS PROCESS\ SOURCE\ FILES -The \f3javadoc\fR command processes files that end in source and other files described in Source Files\&. If you run the \f3javadoc\fR command by passing in individual source file names, then you can determine exactly which source files are processed\&. However, that is not how most developers want to work, because it is simpler to pass in package names\&. The \f3javadoc\fR command can be run three ways without explicitly specifying the source file names\&. You can pass in package names, use the \f3-subpackages\fR option, or use wild cards with source file names\&. In these cases, the \f3javadoc\fR command processes a source file only when the file fulfills all of the following requirements: -.TP 0.2i -\(bu -The file name prefix (with \f3\&.java\fR removed) is a valid class name\&. -.TP 0.2i -\(bu -The path name relative to the root of the source tree is a valid package name after the separators are converted to dots\&. -.TP 0.2i -\(bu -The package statement contains the valid package name\&. -.PP -Processing Links - -During a run, the \f3javadoc\fR command adds cross-reference links to package, class, and member names that are being documented as part of that run\&. Links appear in the following places\&. See Javadoc Tags for a description of the @ tags\&. -.TP 0.2i -\(bu -Declarations (return types, argument types, and field types)\&. -.TP 0.2i -\(bu -\fISee Also\fR sections that are generated from \f3@see\fR tags\&. -.TP 0.2i -\(bu -Inline text generated from \f3{@link}\fR tags\&. -.TP 0.2i -\(bu -Exception names generated from \f3@throws\fR tags\&. -.TP 0.2i -\(bu -\fISpecified by\fR links to interface members and \fIOverrides\fR links to class members\&. See Method Comment Inheritance\&. -.TP 0.2i -\(bu -Summary tables listing packages, classes and members\&. -.TP 0.2i -\(bu -Package and class inheritance trees\&. -.TP 0.2i -\(bu -The index\&. -.PP -You can add links to existing text for classes not included on the command line (but generated separately) by way of the \f3-link\fR and \f3-linkoffline\fR options\&. -.PP -Processing Details - -The \f3javadoc\fR command produces one complete document every time it runs\&. It does not do incremental builds that modify or directly incorporate the results from earlier runs\&. However, the \f3javadoc\fR command can link to results from other runs\&. -.PP -The \f3javadoc\fR command implementation requires and relies on the Java compiler\&. The \f3javadoc\fR command calls part of the \f3javac\fR command to compile the declarations and ignore the member implementations\&. The \f3javadoc\fR command builds a rich internal representation of the classes that includes the class hierarchy and use relationships to generate the HTML\&. The \f3javadoc\fR command also picks up user-supplied documentation from documentation comments in the source code\&. See Documentation Comments\&. -.PP -The \f3javadoc\fR command runs on source files that are pure stub files with no method bodies\&. This means you can write documentation comments and run the \f3javadoc\fR command in the early stages of design before API implementation\&. -.PP -Relying on the compiler ensures that the HTML output corresponds exactly with the actual implementation, which may rely on implicit, rather than explicit, source code\&. For example, the \f3javadoc\fR command documents default constructors that are present in the compiled class files but not in the source code\&. -.PP -In many cases, the \f3javadoc\fR command lets you generate documentation for source files with incomplete or erroneous code\&. You can generate documentation before all debugging and troubleshooting is done\&. The \f3javadoc\fR command does primitive checking of documentation comments\&. -.PP -When the \f3javadoc\fR command builds its internal structure for the documentation, it loads all referenced classes\&. Because of this, the \f3javadoc\fR command must be able to find all referenced classes, whether bootstrap classes, extensions, or user classes\&. See How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html -.PP -Typically, classes you create must either be loaded as an extension or in the \f3javadoc\fR command class path\&. -.SS JAVADOC\ DOCLETS -You can customize the content and format of the \f3javadoc\fR command output with doclets\&. The \f3javadoc\fR command has a default built-in doclet, called the standard doclet, that generates HTML-formatted API documentation\&. You can modify or make a subclass of the standard doclet, or write your own doclet to generate HTML, XML, MIF, RTF or whatever output format you want\&. -.PP -When a custom doclet is not specified with the \f3-doclet\fR option, the \f3javadoc\fR command uses the default standard doclet\&. The \f3javadoc\fR command has several options that are available regardless of which doclet is being used\&. The standard doclet adds a supplementary set of command-line options\&. See Options\&. -.SH SOURCE\ FILES -The \f3javadoc\fR command generates output that originates from the following types of source files: Java language source files for classes (\f3\&.java\fR), package comment files, overview comment files, and miscellaneous unprocessed files\&. This section also describes test files and template files that can also be in the source tree, but that you want to be sure not to document\&. -.SS CLASS\ SOURCE\ FILES -Each class or interface and its members can have their own documentation comments contained in a source file\&. See Documentation Comments\&. -.SS PACKAGE\ COMMENT\ FILES -Each package can have its own documentation comment, contained in its own source file, that the \f3javadoc\fR command merges into the generated package summary page\&. You typically include in this comment any documentation that applies to the entire package\&. -.PP -To create a package comment file, you can place your comments in one of the following files: -.TP 0.2i -\(bu -The \f3package-info\&.java\fR file can contain the package declaration, package annotations, package comments, and Javadoc tags\&. This file is preferred\&. -.TP 0.2i -\(bu -The \f3package\&.html\fR file contains only package comments and Javadoc tags\&. No package annotations\&. -.PP -A package can have a single \f3package\&.html\fR file or a single \f3package-info\&.java\fR file, but not both\&. Place either file in the package directory in the source tree with your source files\&. -.PP -The package-info\&.java File - -The \f3package-info\&.java\fR file can contain a package comment of the following structure\&. The comment is placed before the package declaration\&. -.PP -\fINote:\fR The comment separators \f3/**\fR and \f3*/\fR must be present, but the leading asterisks on the intermediate lines can be left off\&. -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * Provides the classes necessary to create an \fP -.fi -.nf -\f3 * applet and the classes an applet uses \fP -.fi -.nf -\f3 * to communicate with its applet context\&.\fP -.fi -.nf -\f3 * <p>\fP -.fi -.nf -\f3 * The applet framework involves two entities:\fP -.fi -.nf -\f3 * the applet and the applet context\&.\fP -.fi -.nf -\f3 * An applet is an embeddable window (see the\fP -.fi -.nf -\f3 * {@link java\&.awt\&.Panel} class) with a few extra\fP -.fi -.nf -\f3 * methods that the applet context can use to \fP -.fi -.nf -\f3 * initialize, start, and stop the applet\&.\fP -.fi -.nf -\f3 *\fP -.fi -.nf -\f3 * @since 1\&.0\fP -.fi -.nf -\f3 * @see java\&.awt\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3package java\&.lang\&.applet;\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -The package\&.html File - -The \f3package\&.html\fR file can contain a package comment of the following structure\&. The comment is placed in the \f3<body>\fR element\&. -.PP -File: \f3java/applet/package\&.html\fR -.sp -.nf -\f3<HTML>\fP -.fi -.nf -\f3<BODY>\fP -.fi -.nf -\f3Provides the classes necessary to create an applet and the \fP -.fi -.nf -\f3classes an applet uses to communicate with its applet context\&.\fP -.fi -.nf -\f3<p>\fP -.fi -.nf -\f3The applet framework involves two entities: the applet\fP -.fi -.nf -\f3and the applet context\&. An applet is an embeddable\fP -.fi -.nf -\f3window (see the {@link java\&.awt\&.Panel} class) with a\fP -.fi -.nf -\f3few extra methods that the applet context can use to\fP -.fi -.nf -\f3initialize, start, and stop the applet\&. \fP -.fi -.nf -\f3\fP -.fi -.nf -\f3@since 1\&.0 \fP -.fi -.nf -\f3@see java\&.awt\fP -.fi -.nf -\f3</BODY>\fP -.fi -.nf -\f3</HTML>\fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3package\&.html\fR file is a typical HTML file and does not include a package declaration\&. The content of the package comment file is written in HTML with one exception\&. The documentation comment should not include the comment separators \f3/**\fR and \f3*/\fR or leading asterisks\&. When writing the comment, make the first sentence a summary about the package, and do not put a title or any other text between the \f3<body>\fR tag and the first sentence\&. You can include package tags\&. All block tags must appear after the main description\&. If you add an \f3@see\fR tag in a package comment file, then it must have a fully qualified name\&. -.PP -Processing the Comment File - -When the \f3javadoc\fR command runs, it searches for the package comment file\&. If the package comment file is found, then the \f3javadoc\fR command does the following: -.TP 0.2i -\(bu -Copies the comment for processing\&. For package\&.html, the \f3javadoc\fR command copies all content between the \f3<body>\fR and \f3</body>\fR HTML tags\&. You can include a \f3<head>\fR section to put a \f3<title>\fR tag, source file copyright statement, or other information, but none of these appear in the generated documentation\&. -.TP 0.2i -\(bu -Processes the package tags\&. See Package Tags\&. -.TP 0.2i -\(bu -Inserts the processed text at the bottom of the generated package summary page\&. See Java Platform, Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html -.TP 0.2i -\(bu -Copies the first sentence of the package comment to the top of the package summary page\&. The \f3javadoc\fR command also adds the package name and this first sentence to the list of packages on the overview page\&. See Java Platform, Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html - -The end of the sentence is determined by the same rules used for the end of the first sentence of class and member main descriptions\&. -.SS OVERVIEW\ COMMENT\ FILES -Each application or set of packages that you are documenting can have its own overview documentation comment that is kept in its own source file, that the \f3javadoc\fR command merges into the generated overview page\&. You typically include in this comment any documentation that applies to the entire application or set of packages\&. -.PP -You can name the file anything you want such as overview\&.html and place it anywhere\&. A typical location is at the top of the source tree\&. -.PP -For example, if the source files for the \f3java\&.applet\fR package are contained in the /home/user/src/java/applet directory, then you could create an overview comment file at /home/user/src/overview\&.html\&. -.PP -You can have multiple overview comment files for the same set of source files in case you want to run the \f3javadoc\fR command multiple times on different sets of packages\&. For example, you could run the \f3javadoc\fR command once with \f3-private\fR for internal documentation and again without that option for public documentation\&. In this case, you could describe the documentation as public or internal in the first sentence of each overview comment file\&. -.PP -The content of the overview comment file is one big documentation comment that is written in HTML\&. Make the first sentence a summary about the application or set of packages\&. Do not put a title or any other text between the \f3<body>\fR tag and the first sentence\&. All tags except inline tags, such as an {\f3@link}\fR tag, must appear after the main description\&. If you add an \f3@see\fR tag, then it must have a fully qualified name\&. -.PP -When you run the \f3javadoc\fR command, specify the overview comment file name with the \f3-overview\fR option\&. The file is then processed similarly to that of a package comment file\&. The \f3javadoc\fR command does the following: -.TP 0.2i -\(bu -Copies all content between the \f3<body>\fR and \f3</body>\fR tags for processing\&. -.TP 0.2i -\(bu -Processes the overview tags that are present\&. See Overview Tags\&. -.TP 0.2i -\(bu -Inserts the processed text at the bottom of the generated overview page\&. See Java Platform Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html -.TP 0.2i -\(bu -Copies the first sentence of the overview comment to the top of the overview summary page\&. -.SS UNPROCESSED\ FILES -Your source files can include any files that you want the \f3javadoc\fR command to copy to the destination directory\&. These files usually include graphic files, example Java source and class files, and self-standing HTML files with a lot of content that would overwhelm the documentation comment of a typical Java source file\&. -.PP -To include unprocessed files, put them in a directory called doc-files\&. The doc-files directory can be a subdirectory of any package directory that contains source files\&. You can have one doc-files subdirectory for each package\&. -.PP -For example, if you want to include the image of a button in the \f3java\&.awt\&.Button\fR class documentation, then place the image file in the /home/user/src/java/awt/doc-files/ directory\&. Do not place the doc-files directory at /home/user/src/java/doc-files, because java is not a package\&. It does not contain any source files\&. -.PP -All links to the unprocessed files must be included in the code because the \f3javadoc\fR command does not look at the files\&. The \f3javadoc\fR command copies the directory and all of its contents to the destination\&. The following example shows how the link in the Button\&.java documentation comment might look: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * This button looks like this: \fP -.fi -.nf -\f3 * <img src="doc\-files/Button\&.gif">\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS TEST\ AND\ TEMPLATE\ FILES -You can store test and template files in the source tree in the same directory with or in a subdirectory of the directory where the source files reside\&. To prevent test and template files from being processed, run the \f3javadoc\fR command and explicitly pass in individual source file names\&. -.PP -Test files are valid, compilable source files\&. Template files are not valid, compatible source files, but they often have the \f3\&.java\fR suffix\&. -.PP -Test Files - -If you want your test files to belong to either an unnamed package or to a package other than the package that the source files are in, then put the test files in a subdirectory underneath the source files and give the directory an invalid name\&. If you put the test files in the same directory with the source and call the \f3javadoc\fR command with a command-line argument that indicates its package name, then the test files cause warnings or errors\&. If the files are in a subdirectory with an invalid name, then the test file directory is skipped and no errors or warnings are issued\&. For example, to add test files for source files in com\&.package1, put them in a subdirectory in an invalid package name\&. The following directory name is invalid because it contains a hyphen: -.sp -.nf -\f3com/package1/test\-files/\fP -.fi -.nf -\f3\fP -.fi -.sp -If your test files contain documentation comments, then you can set up a separate run of the \f3javadoc\fR command to produce test file documentation by passing in their test source file names with wild cards, such as \f3com/package1/test-files/*\&.java\fR\&. -.PP -Template Files - -If you want a template file to be in the source directory, but not generate errors when you execute the \f3javadoc\fR command, then give it an invalid file name such as \f3Buffer-Template\&.java\fR to prevent it from being processed\&. The \f3javadoc\fR command only processes source files with names, when stripped of the \f3\&.java\fR suffix, that are valid class names\&. -.SH GENERATED\ FILES -By default, the \f3javadoc\fR command uses a standard doclet that generates HTML-formatted documentation\&. The standard doclet generates basic content, cross-reference, and support pages described here\&. Each HTML page corresponds to a separate file\&. The \f3javadoc\fR command generates two types of files\&. The first type is named after classes and interfaces\&. The second type contain hyphens (such as package-summary\&.html) to prevent conflicts with the first type of file\&. -.SS BASIC\ CONTENT\ PAGES -.TP 0.2i -\(bu -One class or interface page (classname\&.html) for each class or interface being documented\&. -.TP 0.2i -\(bu -One package page (package-summary\&.html) for each package being documented\&. The \f3javadoc\fR command includes any HTML text provided in a file with the name package\&.html or package-info\&.java in the package directory of the source tree\&. -.TP 0.2i -\(bu -One overview page (overview-summary\&.html) for the entire set of packages\&. The overview page is the front page of the generated document\&. The \f3javadoc\fR command includes any HTML text provided in a file specified by the \f3-overview\fR option\&. The Overview page is created only when you pass two or more package names into the \f3javadoc\fR command\&. See HTML Frames and Options\&. -.SS CROSS-REFERENCE\ PAGES -.TP 0.2i -\(bu -One class hierarchy page for the entire set of packages (overview-tree\&.html)\&. To view the hierarchy page, click \fIOverview\fR in the navigation bar and click \fITree\fR\&. -.TP 0.2i -\(bu -One class hierarchy page for each package (package-tree\&.html) To view the hierarchy page, go to a particular package, class, or interface page, and click \fITree\fR to display the hierarchy for that package\&. -.TP 0.2i -\(bu -One use page for each package (package-use\&.html) and a separate use page for each class and interface (class-use/classname\&.html)\&. The use page describes what packages, classes, methods, constructors and fields use any part of the specified class, interface, or package\&. For example, given a class or interface A, its use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A\&. To view the use page, go to the package, class, or interface and click the \fIUse\fR link in the navigation bar\&. -.TP 0.2i -\(bu -A deprecated API page (deprecated-list\&.html) that lists all deprecated APIs and their suggested replacements\&. Avoid deprecated APIs because they can be removed in future implementations\&. -.TP 0.2i -\(bu -A constant field values page (constant-values\&.html) for the values of static fields\&. -.TP 0.2i -\(bu -A serialized form page (serialized-form\&.html) that provides information about serializable and externalizable classes with field and method descriptions\&. The information on this page is of interest to reimplementors, and not to developers who want to use the API\&. To access the serialized form page, go to any serialized class and click \fISerialized Form\fR in the See Also section of the class comment\&. The standard doclet generates a serialized form page that lists any class (public or non-public) that implements Serializable with its \f3readObject\fR and \f3writeObject\fR methods, the fields that are serialized, and the documentation comments from the \f3@serial\fR, \f3@serialField\fR, and \f3@serialData\fR tags\&. Public serializable classes can be excluded by marking them (or their package) with \f3@serial\fR exclude, and package-private serializable classes can be included by marking them (or their package) with an \f3@serial\fR include\&. As of Release 1\&.4, you can generate the complete serialized form for public and private classes by running the \f3javadoc\fR command without specifying the \f3-private\fR option\&. See Options\&. -.TP 0.2i -\(bu -An index page (\f3index-*\&.html\fR) of all class, interface, constructor, field and method names, in alphabetical order\&. The index page is internationalized for Unicode and can be generated as a single file or as a separate file for each starting character (such as A\(enZ for English)\&. -.SS SUPPORT\ PAGES -.TP 0.2i -\(bu -A help page (help-doc\&.html) that describes the navigation bar and the previous pages\&. Use \f3-helpfile\fR to override the default help file with your own custom help file\&. -.TP 0.2i -\(bu -One index\&.html file that creates the HTML frames for display\&. Load this file to display the front page with frames\&. The index\&.html file contains no text content\&. -.TP 0.2i -\(bu -Several frame files (\f3*-frame\&.html\fR) that contains lists of packages, classes, and interfaces\&. The frame files display the HTML frames\&. -.TP 0.2i -\(bu -A package list file (package-list) that is used by the \f3-link\fR and \f3-linkoffline\fR options\&. The package list file is a text file that is not reachable through links\&. -.TP 0.2i -\(bu -A style sheet file (stylesheet\&.css) that controls a limited amount of color, font family, font size, font style, and positioning information on the generated pages\&. -.TP 0.2i -\(bu -A doc-files directory that holds image, example, source code, or other files that you want copied to the destination directory\&. These files are not processed by the \f3javadoc\fR command\&. This directory is not processed unless it exists in the source tree\&. -.PP -See Options\&. -.SS HTML\ FRAMES -The \f3javadoc\fR command generates the minimum number of frames (two or three) necessary based on the values passed to the command\&. It omits the list of packages when you pass a single package name or source files that belong to a single package as an argument to the \f3javadoc\fR command\&. Instead, the \f3javadoc\fR command creates one frame in the left-hand column that displays the list of classes\&. When you pass two or more package names, the \f3javadoc\fR command creates a third frame that lists all packages and an overview page (overview-summary\&.html)\&. To bypass frames, click the \fINo Frames\fR link or enter the page set from the overview-summary\&.html page\&. -.SS GENERATED\ FILE\ STRUCTURE -The generated class and interface files are organized in the same directory hierarchy that Java source files and class files are organized\&. This structure is one directory per subpackage\&. -.PP -For example, the document generated for the \f3java\&.applet\&.Applet\fR class would be located at java/applet/Applet\&.html\&. -.PP -The file structure for the \f3java\&.applet\fR package follows, assuming that the destination directory is named \f3apidocs\fR\&. All files that contain the word \fIframe\fR appear in the upper-left or lower-left frames, as noted\&. All other HTML files appear in the right-hand frame\&. -.PP -Directories are bold\&. The asterisks (*) indicate the files and directories that are omitted when the arguments to the \f3javadoc\fR command are source file names rather than package names\&. When arguments are source file names, an empty package list is created\&. The doc-files directory is not created in the destination unless it exists in the source tree\&. See Generated Files\&. -.TP 0.2i -\(bu -\fIapidocs\fR: Top-level directory -.RS -.TP 0.2i -\(bu -index\&.html: Initial Page that sets up HTML frames -.TP 0.2i -\(bu -*overview-summary\&.html: Package list with summaries -.TP 0.2i -\(bu -overview-tree\&.html: Class hierarchy for all packages -.TP 0.2i -\(bu -deprecated-list\&.html: Deprecated APIs for all packages -.TP 0.2i -\(bu -constant-values\&.html: Static field values for all packages -.TP 0.2i -\(bu -serialized-form\&.html: Serialized forms for all packages -.TP 0.2i -\(bu -*overview-frame\&.html: All packages for display in upper-left frame -.TP 0.2i -\(bu -allclasses-frame\&.html: All classes for display in lower-left frame -.TP 0.2i -\(bu -help-doc\&.html: Help about Javadoc page organization -.TP 0.2i -\(bu -index-all\&.html: Default index created without \f3-splitindex\fR option -.TP 0.2i -\(bu -\fIindex-files\fR: Directory created with \f3-splitindex\fR option -.RS -.TP 0.2i -\(bu -index-<number>\&.html: Index files created with \f3-splitindex\fR option -.RE - -.TP 0.2i -\(bu -package-list: Package names for resolving external references -.TP 0.2i -\(bu -stylesheet\&.css: Defines fonts, colors, positions, and so on -.RE - -.TP 0.2i -\(bu -\fIjava\fR: Package directory -.RS -.TP 0.2i -\(bu -\fIapplet\fR: Subpackage directory -.RS -.TP 0.2i -\(bu -Applet\&.html: \f3Applet\fR class page -.TP 0.2i -\(bu -AppletContext\&.html: \f3AppletContext\fR interface -.TP 0.2i -\(bu -AppletStub\&.html: \f3AppletStub\fR interface -.TP 0.2i -\(bu -AudioClip\&.html: \f3AudioClip\fR interface -.TP 0.2i -\(bu -package-summary\&.html: Classes with summaries -.TP 0.2i -\(bu -package-frame\&.html: Package classes for display in lower-left frame -.TP 0.2i -\(bu -package-tree\&.html: Class hierarchy for this package -.TP 0.2i -\(bu -package-use\&.html: Where this package is used -.TP 0.2i -\(bu -\fIdoc-files\fR: Image and example files directory -.TP 0.2i -\(bu -\fIclass-use\fR: Image and examples file location - -- Applet\&.html: Uses of the Applet class - -- AppletContext\&.html: Uses of the \f3AppletContext\fR interface - -- AppletStub\&.html: Uses of the \f3AppletStub\fR interface - -- AudioClip\&.html: Uses of the \f3AudioClip\fR interface -.RE - -.RE - -.TP 0.2i -\(bu -\fIsrc-html\fR: Source code directory -.RS -.TP 0.2i -\(bu -\fIjava\fR: Package directory -.RS -.TP 0.2i -\(bu -\fIapplet\fR: Subpackage directory - -- Applet\&.html: Applet source code - -- AppletContext\&.html: \f3AppletContext\fR source code - -- AppletStub\&.html: \f3AppletStub\fR source code - -- AudioClip\&.html: \f3AudioClip\fR source code -.RE - -.RE - -.SS GENERATED\ API\ DECLARATIONS -The \f3javadoc\fR command generates a declaration at the start of each class, interface, field, constructor, and method description for that API item\&. For example, the declaration for the \f3Boolean\fR class is: -.sp -.nf -\f3public final class Boolean\fP -.fi -.nf -\f3extends Object\fP -.fi -.nf -\f3implements Serializable\fP -.fi -.nf -\f3\fP -.fi -.sp -The declaration for the \f3Boolean\&.valueOf\fR method is: -.sp -.nf -\f3public static Boolean valueOf(String s)\fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3javadoc\fR command can include the modifiers \f3public\fR, \f3protected\fR, \f3private\fR, \f3abstract\fR, \f3final\fR, \f3static\fR, \f3transient\fR, and \f3volatile\fR, but not \f3synchronized\fR or \f3native\fR\&. The \f3synchronized\fR and \f3native\fR modifiers are considered implementation detail and not part of the API specification\&. -.PP -Rather than relying on the keyword \f3synchronized\fR, APIs should document their concurrency semantics in the main description of the comment\&. For example, a description might be: A single enumeration cannot be used by multiple threads concurrently\&. The document should not describe how to achieve these semantics\&. As another example, while the \f3Hashtable\fR option should be thread-safe, there is no reason to specify that it is achieved by synchronizing all of its exported methods\&. It is better to reserve the right to synchronize internally at the bucket level for higher concurrency\&. -.SH DOCUMENTATION\ COMMENTS -This section describes source code comments and comment inheritance\&. -.SS SOURCE\ CODE\ COMMENTS -You can include documentation comments in the source code, ahead of declarations for any class, interface, method, constructor, or field\&. You can also create documentation comments for each package and another one for the overview, though their syntax is slightly different\&. A documentation comment consists of the characters between \f3/**\fR and \f3*/\fR that end it\&. Leading asterisks are allowed on each line and are described further in the following section\&. The text in a comment can continue onto multiple lines\&. -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * This is the typical format of a simple documentation comment\fP -.fi -.nf -\f3 * that spans two lines\&.\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.sp -To save space you can put a comment on one line: -.sp -.nf -\f3/** This comment takes up only one line\&. */\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Placement of Comments - -Documentation comments are recognized only when placed immediately before class, interface, constructor, method, or field declarations\&. Documentation comments placed in the body of a method are ignored\&. The \f3javadoc\fR command recognizes only one documentation comment per declaration statement\&. See Where Tags Can Be Used\&. -.PP -A common mistake is to put an \f3import\fR statement between the class comment and the class declaration\&. Do not put an \f3import\fR statement at this location because the \f3javadoc\fR command ignores the class comment\&. -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * This is the class comment for the class Whatever\&.\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3import com\&.example; // MISTAKE \- Important not to put import statement here\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3public class Whatever{ }\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Parts of Comments - -A documentation comment has a main description followed by a tag section\&. The main description begins after the starting delimiter \f3/**\fR and continues until the tag section\&. The tag section starts with the first block tag, which is defined by the first \f3@\fR character that begins a line (ignoring leading asterisks, white space, and leading separator \f3/**\fR)\&. It is possible to have a comment with only a tag section and no main description\&. The main description cannot continue after the tag section begins\&. The argument to a tag can span multiple lines\&. There can be any number of tags, and some types of tags can be repeated while others cannot\&. For example, this \f3@see\fR tag starts the tag section: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * This sentence holds the main description for this documentation comment\&.\fP -.fi -.nf -\f3 * @see java\&.lang\&.Object\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Block and inline Tags - -A tag is a special keyword within a documentation comment that the \f3javadoc\fR command processes\&. There are two kinds of tags: block tags, which appear as an \f3@tag\fR tag (also known as standalone tags), and inline tags, which appear within braces, as an \f3{@tag}\fR tag\&. To be interpreted, a block tag must appear at the beginning of a line, ignoring leading asterisks, white space, and the separator (\f3/**\fR)\&. This means you can use the \f3@\fR character elsewhere in the text and it will not be interpreted as the start of a tag\&. If you want to start a line with the \f3@\fR character and not have it be interpreted, then use the HTML entity \f3@\fR\&. Each block tag has associated text, which includes any text following the tag up to, but not including, either the next tag, or the end of the documentation comment\&. This associated text can span multiple lines\&. An inline tag is allowed and interpreted anywhere that text is allowed\&. The following example contains the \f3@deprecated\fR block tag and the \f3{@link}\fR inline tag\&. See Javadoc Tags\&. -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * @deprecated As of JDK 1\&.1, replaced by {@link #setBounds(int,int,int,int)}\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Write Comments in HTML - -The text must be written in HTML with HTML entities and HTML tags\&. You can use whichever version of HTML your browser supports\&. The standard doclet generates HTML 3\&.2-compliant code elsewhere (outside of the documentation comments) with the inclusion of cascading style sheets and frames\&. HTML 4\&.0 is preferred for generated files because of the frame sets\&. -.PP -For example, entities for the less than symbol (<) and the greater than symbol (>) should be written as \f3<\fR and \f3>\fR\&. Similarly, the ampersand (&) should be written as \f3&\fR\&. The bold HTML tag \f3<b>\fR is shown in the following example\&. -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * This is a <b>doc</b> comment\&.\fP -.fi -.nf -\f3 * @see java\&.lang\&.Object\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Leading Asterisks - -When the \f3javadoc\fR command parses a documentation comment, leading asterisks (*) on each line are discarded, and blanks and tabs that precede the initial asterisks (*) are also discarded\&. If you omit the leading asterisk on a line, then the leading white space is no longer removed so that you can paste code examples directly into a documentation comment inside a \f3<PRE>\fR tag with its indentation preserved\&. Spaces are interpreted by browsers more uniformly than tabs\&. Indentation is relative to the left margin (rather than the separator \f3/**\fR or \f3<PRE>\fR tag)\&. -.PP -First Sentence - -The first sentence of each documentation comment should be a summary sentence that contains a concise but complete description of the declared entity\&. This sentence ends at the first period that is followed by a blank, tab, or line terminator, or at the first block tag\&. The \f3javadoc\fR command copies this first sentence to the member summary at the top of the HTML page\&. -.PP -Multiple-Field Declarations - -The Java platform lets you declare multiple fields in a single statement, but this statement can have only one documentation comment that is copied for all fields\&. If you want individual documentation comments for each field, then declare each field in a separate statement\&. For example, the following documentation comment does not make sense written as a single declaration and would be better handled as two declarations: -.sp -.nf -\f3/** \fP -.fi -.nf -\f3 * The horizontal and vertical distances of point (x,y)\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3public int x, y; // Avoid this \fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3javadoc\fR command generates the following documentation from the previous code: -.sp -.nf -\f3public int x\fP -.fi -.nf -\f3\fP -.fi -.sp -The horizontal and vertical distances of point (x, y)\&. -.sp -.nf -\f3public int y\fP -.fi -.nf -\f3\fP -.fi -.sp -The horizontal and vertical distances of point (x, y)\&. -.PP -Use of Header Tags - -When writing documentation comments for members, it is best not to use HTML heading tags such as \f3<H1>\fR and \f3<H2>\fR, because the \f3javadoc\fR command creates an entire structured document, and these structural tags might interfere with the formatting of the generated document\&. However, you can use these headings in class and package comments to provide your own structure\&. -.SS METHOD\ COMMENT\ INHERITANCE -The \f3javadoc\fR command allows method comment inheritance in classes and interfaces to fill in missing text or to explicitly inherit method comments\&. Constructors, fields, and nested classes do not inherit documentation comments\&. -.PP -\fINote:\fR The source file for an inherited method must be on the path specified by the \f3-sourcepath\fR option for the documentation comment to be available to copy\&. Neither the class nor its package needs to be passed in on the command line\&. This contrasts with Release 1\&.3\&.\fIn\fR and earlier releases, where the class had to be a documented class\&. -.PP -Fill in Missing Text - -When a main description, or \f3@return\fR, \f3@param\fR, or \f3@throws\fR tag is missing from a method comment, the \f3javadoc\fR command copies the corresponding main description or tag comment from the method it overrides or implements (if any)\&. See Method Comment Inheritance\&. -.PP -When an \f3@param\fR tag for a particular parameter is missing, the comment for that parameter is copied from the method further up the inheritance hierarchy\&. When an \f3@throws\fR tag for a particular exception is missing, the \f3@throws\fR tag is copied only when that exception is declared\&. -.PP -This behavior contrasts with Release 1\&.3 and earlier, where the presence of any main description or tag would prevent all comments from being inherited\&. -.PP -See Javadoc Tags and Options\&. -.PP -Explicit Inheritance - -Insert the \f3{@inheritDoc}\fR inline tag in a method main description or \f3@return\fR, \f3@param\fR, or \f3@throws\fR tag comment\&. The corresponding inherited main description or tag comment is copied into that spot\&. -.SS CLASS\ AND\ INTERFACE\ INHERITANCE -Comment inheritance occurs in all possible cases of inheritance from classes and interfaces: -.TP 0.2i -\(bu -When a method in a class overrides a method in a superclass -.TP 0.2i -\(bu -When a method in an interface overrides a method in a superinterface -.TP 0.2i -\(bu -When a method in a class implements a method in an interface -.PP -In the first two cases, the \f3javadoc\fR command generates the subheading \fIOverrides\fR in the documentation for the overriding method\&. A link to the method being overridden is included, whether or not the comment is inherited\&. -.PP -In the third case, when a method in a specified class implements a method in an interface, the \f3javadoc\fR command generates the subheading \fISpecified by\fR in the documentation for the overriding method\&. A link to the method being implemented is included, whether or not the comment is inherited\&. -.SS METHOD\ COMMENTS\ ALGORITHM -If a method does not have a documentation comment, or has an \f3{@inheritDoc}\fR tag, then the \f3javadoc\fR command uses the following algorithm to search for an applicable comment\&. The algorithm is designed to find the most specific applicable documentation comment, and to give preference to interfaces over superclasses: -.TP 0.4i -1\&. -Look in each directly implemented (or extended) interface in the order they appear following the word \f3implements\fR (or \f3extends\fR) in the method declaration\&. Use the first documentation comment found for this method\&. -.TP 0.4i -2\&. -If Step 1 failed to find a documentation comment, then recursively apply this entire algorithm to each directly implemented (or extended) interface in the same order they were examined in Step 1\&. -.TP 0.4i -3\&. -When Step 2 fails to find a documentation comment and this is a class other than the \f3Object\fR class, but not an interface: -.RS -.TP 0.4i -1\&. -If the superclass has a documentation comment for this method, then use it\&. -.TP 0.4i -2\&. -If Step 3a failed to find a documentation comment, then recursively apply this entire algorithm to the superclass\&. -.RE - -.SH JAVADOC\ TAGS -The \f3javadoc\fR command parses special tags when they are embedded within a Java documentation comment\&. The \f3javadoc\fR tags let you autogenerate a complete, well-formatted API from your source code\&. The tags start with an at sign (\f3@\fR) and are case-sensitive\&. They must be typed with the uppercase and lowercase letters as shown\&. A tag must start at the beginning of a line (after any leading spaces and an optional asterisk), or it is treated as text\&. By convention, tags with the same name are grouped together\&. For example, put all \f3@see\fR tags together\&. For more information, see Where Tags Can Be Used\&. -.PP -Tags have the following types: -.TP 0.2i -\(bu -Bock tags: Place block tags only in the tag section that follows the description\&. Block tags have the form: \fI@tag\fR\&. -.TP 0.2i -\(bu -Inline tags: Place inline tags anywhere in the main description or in the comments for block tags\&. Inline tags are enclosed within braces: \fI{@tag}\fR\&. -.PP -For custom tags, see -tag tagname:Xaoptcmf:"taghead"\&. See also Where Tags Can Be Used\&. -.SS TAG\ DESCRIPTIONS -.TP -@author \fIname-text\fR -Introduced in JDK 1\&.0 - -Adds an Author entry with the specified name text to the generated documents when the \f3-author\fR option is used\&. A documentation comment can contain multiple \f3@author\fR tags\&. You can specify one name per \f3@author\fR tag or multiple names per tag\&. In the former case, the \f3javadoc\fR command inserts a comma (,) and space between names\&. In the latter case, the entire text is copied to the generated document without being parsed\&. Therefore, you can use multiple names per line if you want a localized name separator other than a comma\&. See @author in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@author -.TP -{@code \fItext\fR} -Introduced in JDK 1\&.5 - -Equivalent to \f3<code>{@literal}</code>\fR\&. - -Displays text in code font without interpreting the text as HTML markup or nested Javadoc tags\&. This enables you to use regular angle brackets (< and >) instead of the HTML entities (\f3<\fR and \f3>\fR) in documentation comments, such as in parameter types (\f3<Object>\fR), inequalities (\f33 < 4\fR), or arrows (\f3<-\fR)\&. For example, the documentation comment text \f3{@code A<B>C}\fR displayed in the generated HTML page unchanged as \f3A<B>C\fR\&. This means that the \f3<B>\fR is not interpreted as bold and is in code font\&. If you want the same functionality without the code font, then use the \f3{@literal}\fR tag\&. -.TP -@deprecated \fIdeprecated-text\fR -Introduced in JDK 1\&.0 - -Adds a comment indicating that this API should no longer be used (even though it may continue to work)\&. The \f3javadoc\fR command moves \f3deprecated-text\fRahead of the main description, placing it in italics and preceding it with a bold warning: Deprecated\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field\&. - -The first sentence of deprecated text should tell the user when the API was deprecated and what to use as a replacement\&. The \f3javadoc\fR command copies the first sentence to the summary section and index\&. Subsequent sentences can also explain why it was deprecated\&. You should include an \f3{@link}\fR tag (for Javadoc 1\&.2 or later) that points to the replacement API\&. - -Use the \fI@deprecated annotation\fR tag to deprecate a program element\&. See How and When to Deprecate APIs at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/deprecation/deprecation\&.html - -See also @deprecated in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@deprecated -.TP -{@docRoot} -Introduced in JDK 1\&.3 - -Represents the relative path to the generated document\&'s (destination) root directory from any generated page\&. This tag is useful when you want to include a file, such as a copyright page or company logo, that you want to reference from all generated pages\&. Linking to the copyright page from the bottom of each page is common\&. - -This \f3{@docRoot}\fR tag can be used both on the command line and in a documentation comment\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field, and includes the text portion of any tag (such as the \f3@return\fR, \f3@param\fR and \f3@deprecated\fR tags)\&. -.RS -.TP 0.2i -\(bu -On the command line, where the header, footer, or bottom are defined: \f3javadoc -bottom \&'<a href="{@docRoot}/copyright\&.html">Copyright</a>\&'\fR\&. - -When you use the \f3{@docRoot}\fR tag this way in a make file, some \f3makefile\fR programs require a special way to escape for the brace \f3{}\fR characters\&. For example, the Inprise MAKE version 5\&.2 running on Windows requires double braces: \f3{{@docRoot}}\fR\&. It also requires double (rather than single) quotation marks to enclose arguments to options such as the \f3-bottom\fR option (with the quotation marks around the \f3href\fR argument omitted)\&. -.TP 0.2i -\(bu -In a documentation comment: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * See the <a href="{@docRoot}/copyright\&.html">Copyright</a>\&.\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.sp - - -This tag is needed because the generated documents are in hierarchical directories, as deep as the number of subpackages\&. The expression: \f3<a href="{@docRoot}/copyright\&.html">\fR resolves to \f3<a href="\&.\&./\&.\&./copyright\&.html">\fR for \f3java/lang/Object\&.java\fR and \f3<a href="\&.\&./\&.\&./\&.\&./copyright\&.html">\fR for \f3java/lang/ref/Reference\&.java\fR\&. -.RE - -.TP -@exception \fIclass-name description\fR -Introduced in JDK 1\&.0 - -Identical to the \f3@throws\fR tag\&. See @throws class-name description\&. -.TP -{@inheritDoc} -Introduced in JDK 1\&.4 - -Inherits (copies) documentation from the nearest inheritable class or implementable interface into the current documentation comment at this tag\&'s location\&. This enables you to write more general comments higher up the inheritance tree and to write around the copied text\&. - -This tag is valid only in these places in a documentation comment: -.RS -.TP 0.2i -\(bu -In the main description block of a method\&. In this case, the main description is copied from a class or interface up the hierarchy\&. -.TP 0.2i -\(bu -In the text arguments of the \f3@return\fR, \f3@param,\fR and \f3@throws\fR tags of a method\&. In this case, the tag text is copied from the corresponding tag up the hierarchy\&. -.RE - - -See Method Comment Inheritance for a description of how comments are found in the inheritance hierarchy\&. Note that if this tag is missing, then the comment is or is not automatically inherited according to rules described in that section\&. -.TP -{@link \fIpackage\&.class#member label\fR} -Introduced in JDK 1\&.2 - -Inserts an inline link with a visible text label that points to the documentation for the specified package, class, or member name of a referenced class\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field, including the text portion of any tag, such as the \f3@return\fR, \f3@param\fR and \f3@deprecated\fR tags\&. See @link in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#{@link - -This tag is similar to the \f3@see\fR tag\&. Both tags require the same references and accept the same syntax for \f3package\&.class#member\fR and \f3label\fR\&. The main difference is that the \f3{@link}\fR tag generates an inline link rather than placing the link in the See Also section\&. The \f3{@link}\fR tag begins and ends with braces to separate it from the rest of the inline text\&. If you need to use the right brace (\f3}\fR) inside the label, then use the HTML entity notation \f3}\fR\&. - -There is no limit to the number of \f3{@link}\fR tags allowed in a sentence\&. You can use this tag in the main description part of any documentation comment or in the text portion of any tag, such as the \f3@deprecated\fR, \f3@return\fR or \f3@param\fR tags\&. - -For example, here is a comment that refers to the \f3getComponentAt(int, int)\fR method: -.sp -.nf -\f3Use the {@link #getComponentAt(int, int) getComponentAt} method\&.\fP -.fi -.nf -\f3\fP -.fi -.sp - - -From this code, the standard doclet generates the following HTML (assuming it refers to another class in the same package): -.sp -.nf -\f3Use the <a href="Component\&.html#getComponentAt(int, int)">getComponentAt</a> method\&.\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The previous line appears on the web page as: -.sp -.nf -\f3Use the getComponentAt method\&.\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -{@linkplain \fIpackage\&.class#member label\fR} -Introduced in JDK 1\&.4 - -Behaves the same as the \f3{@link}\fR tag, except the link label is displayed in plain text rather than code font\&. Useful when the label is plain text\&. For example, \f3Refer to {@linkplain add() the overridden method}\fR\&. displays as: Refer to the overridden method\&. -.TP -{@literal \fItext\fR} -Introduced in JDK 1\&.5 - -Displays text without interpreting the text as HTML markup or nested Javadoc tags\&. This enables you to use angle brackets (\f3< and >\fR) instead of the HTML entities (\f3<\fR and \f3>\fR) in documentation comments, such as in parameter types (\f3<Object>\fR), inequalities (\f33 < 4\fR), or arrows (<-)\&. For example, the documentation comment text \f3{@literal A<B>C}\fR displays unchanged in the generated HTML page in your browser, as \f3A<B>C\fR\&. The \f3<B>\fR is not interpreted as bold (and it is not in code font)\&. If you want the same functionality with the text in code font, then use the \f3{@code}\fR tag\&. -.TP -@param \fIparameter-name description\fR -Introduced in JDK 1\&.0 - -Adds a parameter with the specified \f3parameter-name\fR followed by the specified description to the Parameters section\&. When writing the documentation comment, you can continue the description onto multiple lines\&. This tag is valid only in a documentation comment for a method, constructor, or class\&. See @param in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@param - -The \f3parameter-name\fR can be the name of a parameter in a method or constructor, or the name of a type parameter of a class, method, or constructor\&. Use angle brackets around this parameter name to specify the use of a type parameter\&. - -Example of a type parameter of a class: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * @param <E> Type of element stored in a list\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3public interface List<E> extends Collection<E> {\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - - -Example of a type parameter of a method: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * @param string the string to be converted\fP -.fi -.nf -\f3 * @param type the type to convert the string to\fP -.fi -.nf -\f3 * @param <T> the type of the element\fP -.fi -.nf -\f3 * @param <V> the value of the element\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3<T, V extends T> V convert(String string, Class<T> type) {\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -@return \fIdescription\fR -Introduced in JDK 1\&.0 - -Adds a Returns section with the description text\&. This text should describe the return type and permissible range of values\&. This tag is valid only in a documentation comment for a method\&. See @return in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@return -.TP -@see \fIreference\fR -Introduced in JDK 1\&.0 - -Adds a \fISee Also\fR heading with a link or text entry that points to a reference\&. A documentation comment can contain any number of \f3@see\fR tags, which are all grouped under the same heading\&. The \f3@see\fR tag has three variations\&. The form is the most common\&. This tag is valid in any documentation comment: overview, package, class, interface, constructor, method, or field\&. For inserting an inline link within a sentence to a package, class, or member, see \f3{@link}\fR\&. - -\fIForm 1\fR\&. The @see \f3string\fR tag form adds a text entry for \fIstring\fR\&. No link is generated\&. The string is a book or other reference to information not available by URL\&. The \f3javadoc\fR command distinguishes this from the previous cases by searching for a double quotation mark (") as the first character\&. For example, \f3@see "The Java Programming Language"\fR that generates the following text: - -\fISee Also\fR: - -"The Java Programming Language" - -\fIForm 2\fR\&. The \f3@see <a href="URL#value">label</a>\fR form adds a link as defined by \f3URL#value\fR\&. The \f3URL#value\fR parameter is a relative or absolute URL\&. The \f3javadoc\fR command distinguishes this from other cases by searching for a less-than symbol (\f3<\fR) as the first character\&. For example, \f3@see <a href="spec\&.html#section">Java Spec</a>\fR generates the following link: - -\fISee Also\fR: - -Java Spec - -\fIForm 3\fR\&. The \f3@see package\&.class#member label\fR form adds a link with a visible text label that points to the documentation for the specified name in the Java Language that is referenced\&. The label is optional\&. If the label is omitted, then the name appears instead as visible text, suitably shortened\&. Use the \f3-noqualifier\fR option to globally remove the package name from this visible text\&. Use the label when you want the visible text to be different from the autogenerated visible text\&. See How a Name Appears\&. - -In Java SE 1\&.2 only, the name but not the label automatically appears in \f3<code>\fR HTML tags\&. Starting with Java SE 1\&.2\&.2, the \f3<code>\fR tag is always included around the visible text, whether or not a label is used\&. -.RS -.TP 0.2i -\(bu -\f3package\&.class#member\fR is any valid program element name that is referenced, such as a package, class, interface, constructor, method or field name, except that the character ahead of the member name should be a number sign (\f3#\fR)\&. The class represents any top-level or nested class or interface\&. The member represents any constructor, method, or field (not a nested class or interface)\&. If this name is in the documented classes, then the \f3javadoc\fR command create a link to it\&. To create links to external referenced classes, use the \f3-link\fR option\&. Use either of the other two \f3@see\fR tag forms to refer to the documentation of a name that does not belong to a referenced class\&. See Specify a Name\&. - -\fINote:\fR External referenced classes are classes that are not passed into the \f3javadoc\fR command on the command line\&. Links in the generated documentation to external referenced classes are called external references or external links\&. For example, if you run the \f3javadoc\fR command on only the \f3java\&.awt package\fR, then any class in \f3java\&.lang\fR, such as \f3Object\fR, is an external referenced class\&. Use the \f3-link\fR and \f3-linkoffline\fR options to link to external referenced classes\&. The source comments of external referenced classes are not available to the \f3javadoc\fR command run\&. -.TP 0.2i -\(bu -\f3label\fR is optional text that is visible as the link label\&. The label can contain white space\&. If \f3label\fR is omitted, then \f3package\&.class\&.member\fR appears, suitably shortened relative to the current class and package\&. See How a Name Appears\&. -.TP 0.2i -\(bu -A space is the delimiter between \f3package\&.class#member\fR and \f3label\fR\&. A space inside parentheses does not indicate the start of a label, so spaces can be used between parameters in a method\&. -.RE - - -\fI\fRIn the following example, an \f3@see\fR tag (in the \f3Character\fR class) refers to the equals method in the \f3String\fR class\&. The tag includes both arguments: the name \f3String#equals(Object)\fR and the label \f3equals\fR\&. -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * @see String#equals(Object) equals\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The standard doclet produces HTML that is similar to: -.sp -.nf -\f3<dl>\fP -.fi -.nf -\f3<dt><b>See Also:</b>\fP -.fi -.nf -\f3<dd><a href="\&.\&./\&.\&./java/lang/String#equals(java\&.lang\&.Object)"><code>equals<code></a>\fP -.fi -.nf -\f3</dl>\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The previous code looks similar to the following in a browser, where the label is the visible link text: - -\fISee Also\fR: - -equals -.PP -Specify a Name - -\fI\fRThis \f3package\&.class#member\fR name can be either fully qualified, such as \f3java\&.lang\&.String#toUpperCase()\fR or not, such as \f3String#toUpperCase()\fR or \f3#toUpperCase()\fR\&. If the name is less than fully qualified, then the \f3javadoc\fR command uses the standard Java compiler search order to find it\&. See Search Order for the @see Tag\&. The name can contain white space within parentheses, such as between method arguments\&.The advantage to providing shorter, partially qualified names is that they are shorter to type and there is less clutter in the source code\&. The following listing shows the different forms of the name, where \f3Class\fR can be a class or interface; Type can be a class, interface, array, or primitive; and method can be a method or constructor\&. -.sp -.nf -\f3\fITypical forms for\fR\fI @see package\&.class#member\fR\fP -.fi -.nf -\f3\fIReferencing a member of the current class\fR\fP -.fi -.nf -\f3@see #field\fP -.fi -.nf -\f3@see #method(Type, Type,\&.\&.\&.)\fP -.fi -.nf -\f3@see #method(Type argname, Type argname,\&.\&.\&.)\fP -.fi -.nf -\f3@see #constructor(Type, Type,\&.\&.\&.)\fP -.fi -.nf -\f3@see #constructor(Type argname, Type argname,\&.\&.\&.) \fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\fIReferencing another class in the current or imported packages\fR\fP -.fi -.nf -\f3@see Class#field\fP -.fi -.nf -\f3@see Class#method(Type, Type,\&.\&.\&.)\fP -.fi -.nf -\f3@see Class#method(Type argname, Type argname,\&.\&.\&.)\fP -.fi -.nf -\f3@see Class#constructor(Type, Type,\&.\&.\&.)\fP -.fi -.nf -\f3@see Class#constructor(Type argname, Type argname,\&.\&.\&.)\fP -.fi -.nf -\f3@see Class\&.NestedClass\fP -.fi -.nf -\f3@see Class \fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\fIReferencing an element in another package (fully qualified)\fR\fP -.fi -.nf -\f3@see package\&.Class#field\fP -.fi -.nf -\f3@see package\&.Class#method(Type, Type,\&.\&.\&.)\fP -.fi -.nf -\f3@see package\&.Class#method(Type argname, Type argname,\&.\&.\&.)\fP -.fi -.nf -\f3@see package\&.Class#constructor(Type, Type,\&.\&.\&.)\fP -.fi -.nf -\f3@see package\&.Class#constructor(Type argname, Type argname,\&.\&.\&.)\fP -.fi -.nf -\f3@see package\&.Class\&.NestedClass\fP -.fi -.nf -\f3@see package\&.Class\fP -.fi -.nf -\f3@see package\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3\fRNotes about the previous listing: -.TP 0.2i -\(bu -The first set of forms with no class or package causes the \f3javadoc\fR command to search only through the current class hierarchy\&. It finds a member of the current class or interface, one of its superclasses or superinterfaces, or one of its enclosing classes or interfaces (search Items 1\(en3)\&. It does not search the rest of the current package or other packages (search Items 4\(en5)\&. See Search Order for the @see Tag\&. -.TP 0.2i -\(bu -If any method or constructor is entered as a name with no parentheses, such as \f3getValue\fR, and if there is no field with the same name, then the \f3javadoc\fR command still creates a link to the method\&. If this method is overloaded, then the \f3javadoc\fR command links to the first method its search encounters, which is unspecified\&. -.TP 0.2i -\(bu -Nested classes must be specified as \f3outer\&.inner\fR, not simply \f3inner\fR, for all forms\&. -.TP 0.2i -\(bu -As stated, the number sign (\f3#\fR), rather than a dot (\f3\&.\fR) separates a member from its class\&. This enables the \f3javadoc\fR command to resolve ambiguities, because the dot also separates classes, nested classes, packages, and subpackages\&. However, the \f3javadoc\fR command properly parses a dot when there is no ambiguity, but prints a warning to alert you\&. -.PP -Search Order for the @see Tag - -\fI\fRThe \f3javadoc\fR command processes an \f3@see\fR tag that appears in a source file, package file, or overview file\&. In the latter two files, you must fully qualify the name you supply with the \f3@see\fR tag\&. In a source file, you can specify a name that is fully qualified or partially qualified\&. -.PP -The following is the search order for the \f3@see\fR tag\&. -.TP 0.4i -1\&. -The current class or interface\&. -.TP 0.4i -2\&. -Any enclosing classes and interfaces searching the closest first\&. -.TP 0.4i -3\&. -Any superclasses and superinterfaces, searching the closest first\&. -.TP 0.4i -4\&. -The current package\&. -.TP 0.4i -5\&. -Any imported packages, classes, and interfaces, searching in the order of the \f3import\fR statement\&. -.PP -The \f3javadoc\fR command continues to search recursively through Items 1-3 for each class it encounters until it finds a match\&. That is, after it searches through the current class and its enclosing class E, it searches through the superclasses of E before the enclosing classes of E\&. In Items 4 and 5, the \f3javadoc\fR command does not search classes or interfaces within a package in any specified order (that order depends on the particular compiler)\&. In Item 5, the \f3javadoc\fR command searches in \fIjava\&.lang\fR because that is imported by all programs\&. -.PP -When the \f3javadoc\fR command encounters an \f3@see\fR tag in a source file that is not fully qualified, it searches for the specified name in the same order as the Java compiler would, except the \f3javadoc\fR command does not detect certain name space ambiguities because it assumes the source code is free of these errors\&. This search order is formally defined in the Java Language Specification\&. The \f3javadoc\fR command searches for that name through all related and imported classes and packages\&. In particular, it searches in this order: -.TP 0.4i -1\&. -The current class or interface\&. -.TP 0.4i -2\&. -Any enclosing classes and interfaces, searching the closest first\&. -.TP 0.4i -3\&. -Any superclasses and superinterfaces, searching the closest first\&. -.TP 0.4i -4\&. -The current package\&. -.TP 0.4i -5\&. -Any imported packages, classes, and interfaces, searching in the order of the \f3import\fR statements\&. -.PP -The \f3javadoc\fR command does not necessarily look in subclasses, nor will it look in other packages even when their documentation is being generated in the same run\&. For example, if the \f3@see\fR tag is in the \f3java\&.awt\&.event\&.KeyEvent\fR class and refers to a name in the \f3java\&.awt package\fR, then the \f3javadoc\fR command does not look in that package unless that class imports it\&. -.PP -How a Name Appears - -\fI\fRIf \f3label\fR is omitted, then \f3package\&.class\&.member\fR appears\&. In general, it is suitably shortened relative to the current class and package\&. Shortened means the \f3javadoc\fR command displays only the minimum name necessary\&. For example, if the \f3String\&.toUpperCase()\fR method contains references to a member of the same class and to a member of a different class, then the class name is displayed only in the latter case, as shown in the following listing\&. Use the \f3-noqualifier\fR option to globally remove the package names\&. -.PP -\fIType of reference\fR: The \f3@see\fR tag refers to a member of the same class, same package -.br -\fIExample in\fR: \f3@see String#toLowerCase()\fR -.br -\fIAppears as\fR: \f3toLowerCase()\fR - omits the package and class names -.br - -.PP -\fIType of reference\fR: The \f3@see\fR tag refers to a member of a different class, same package -.br -\fIExample in\fR: \f3@see Character#toLowerCase(char)\fR -.br -\fIAppears as\fR: \f3Character\&.toLowerCase(char)\fR - omits the package name, includes the class name -.br - -.PP -\fIType of reference\fR: The \f3@see\fR tag refers to a member of a different class, different package -.br -\fIExample in\fR: \f3@see java\&.io\&.File#exists()\fR -.br -\fIAppears as\fR: \f3java\&.io\&.File\&.exists()\fR - includes the package and class names -.br - -.PP -Examples of the @see Tag - -The comment to the right shows how the name appears when the \f3@see\fR tag is in a class in another package, such as \f3java\&.applet\&.Applet\fR\&. See @see in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@see -.sp -.nf -\f3 See also:\fP -.fi -.nf -\f3@see java\&.lang\&.String // String \fP -.fi -.nf -\f3@see java\&.lang\&.String The String class // The String class \fP -.fi -.nf -\f3@see String // String \fP -.fi -.nf -\f3@see String#equals(Object) // String\&.equals(Object) \fP -.fi -.nf -\f3@see String#equals // String\&.equals(java\&.lang\&.Object) \fP -.fi -.nf -\f3@see java\&.lang\&.Object#wait(long) // java\&.lang\&.Object\&.wait(long) \fP -.fi -.nf -\f3@see Character#MAX_RADIX // Character\&.MAX_RADIX \fP -.fi -.nf -\f3@see <a href="spec\&.html">Java Spec</a> // Java Spec \fP -.fi -.nf -\f3@see "The Java Programming Language" // "The Java Programming Language" \fP -.fi -.nf -\f3\fP -.fi -.sp -\fINote:\fR You can extend the \f3@se\fR\f3e\fR tag to link to classes not being documented with the \f3-link\fR option\&. -.TP -@serial \fIfield-description\fR | include | exclude -Introduced in JDK 1\&.2 - -Used in the documentation comment for a default serializable field\&. See Documenting Serializable Fields and Data for a Class at http://docs\&.oracle\&.com/javase/8/docs/platform/serialization/spec/serial-arch\&.html#5251 - -See also Oracle\(cqs Criteria for Including Classes in the Serialized Form Specification at http://www\&.oracle\&.com/technetwork/java/javase/documentation/serialized-criteria-137781\&.html - -An optional \f3field-description\fR should explain the meaning of the field and list the acceptable values\&. When needed, the description can span multiple lines\&. The standard doclet adds this information to the serialized form page\&. See Cross-Reference Pages\&. - -If a serializable field was added to a class after the class was made serializable, then a statement should be added to its main description to identify at which version it was added\&. - -The \f3include\fR and \f3exclude\fR arguments identify whether a class or package should be included or excluded from the serialized form page\&. They work as follows: -.RS -.TP 0.2i -\(bu -A public or protected class that implements \f3Serializable\fR is included unless that class (or its package) is marked with the \f3@serial exclude\fR tag\&. -.TP 0.2i -\(bu -A private or package-private class that implements \f3Serializable\fR is excluded unless that class (or its package) is marked with the \f3@serial include\fR tag\&. -.RE - - -For example, the \f3javax\&.swing\fR package is marked with the \f3@serial\fR\f3exclude\fR tag in package\&.html or package-info\&.java\&. The public class \f3java\&.security\&.BasicPermission\fR is marked with the \f3@serial exclude\fR tag\&. The package-private class \f3java\&.util\&.PropertyPermissionCollection\fR is marked with the \f3@serial include\fR tag\&. - -The \f3@serial\fR tag at the class level overrides the \f3@serial\fR tag at the package level\&. -.TP -@serialData \fIdata-description\fR -Introduced in JDK 1\&.2 - -Uses the data description value to document the types and order of data in the serialized form\&. This data includes the optional data written by the \f3writeObject\fR method and all data (including base classes) written by the \f3Externalizable\&.writeExternal\fR method\&. - -The \f3@serialData\fR tag can be used in the documentation comment for the \f3writeObject\fR, \f3readObject\fR, \f3writeExternal\fR, \f3readExternal\fR, \f3writeReplace\fR, and \f3readResolve\fR methods\&. -.TP -@serialField \fIfield-name\fR\fIfield-type\fR\fIfield-description\fR -Introduced in JDK 1\&.2 - -Documents an \f3ObjectStreamField\fR component of the \f3serialPersistentFields\fR member of a \f3Serializable\fR class\&. Use one \f3@serialField\fR tag for each \f3ObjectStreamField\fR component\&. -.TP -@since \fIsince-text\fR -Introduced in JDK 1\&.1 - -Adds a \fISince\fR heading with the specified \f3since-text\fR value to the generated documentation\&. The text has no special internal structure\&. This tag is valid in any documentation comment: overview, package, class, interface, constructor, method, or field\&. This tag means that this change or feature has existed since the software release specified by the \f3since-text\fR value, for example: \f3@since 1\&.5\fR\&. - -For Java platform source code, the \f3@since\fR tag indicates the version of the Java platform API specification, which is not necessarily when the source code was added to the reference implementation\&. Multiple \f3@since\fR tags are allowed and are treated like multiple \f3@author\fR tags\&. You could use multiple tags when the program element is used by more than one API\&. -.TP -@throws \fIclass-name\fR\fIdescription\fR -Introduced in JDK 1\&.2 - -Behaves the same as the \f3@exception\fR tag\&. See @throws in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@exception - -The \f3@throws\fR tag adds a \fIThrows\fR subheading to the generated documentation, with the \f3class-name\fR and \f3description\fR text\&. The \fIclass-name\fR is the name of the exception that might be thrown by the method\&. This tag is valid only in the documentation comment for a method or constructor\&. If this class is not fully specified, then the \f3javadoc\fR command uses the search order to look up this class\&. Multiple \f3@throws\fR tags can be used in a specified documentation comment for the same or different exceptions\&. See Search Order for the @see Tag\&. - -To ensure that all checked exceptions are documented, when an \f3@throws\fR tag does not exist for an exception in the throws clause, the \f3javadoc\fR command adds that exception to the HTML output (with no description) as though it were documented with the \f3@throws\fR tag\&. - -The \f3@throws\fR documentation is copied from an overridden method to a subclass only when the exception is explicitly declared in the overridden method\&. The same is true for copying from an interface method to an implementing method\&. You can use the \f3{@inheritDoc}\fR tag to force the \f3@throws\fR tag to inherit documentation\&. -.TP -{@value \fIpackage\&.class#field\fR} -Introduced in JDK 1\&.4 - -Displays constant values\&. When the \f3{@value}\fR tag is used without an argument in the documentation comment of a static field, it displays the value of that constant: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * The value of this constant is {@value}\&.\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3public static final String SCRIPT_START = "<script>"\fP -.fi -.nf -\f3\fP -.fi -.sp - - -When used with the argument \f3package\&.class#field\fR in any documentation comment, he \f3{@value}\fR tag displays the value of the specified constant: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * Evaluates the script starting with {@value #SCRIPT_START}\&.\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3public String evalScript(String script) {}\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The argument \f3package\&.class#field\fR takes a form similar to that of the \f3@see\fR tag argument, except that the member must be a static field\&. - -The values of these constants are also displayed in Constant Field Values at http://docs\&.oracle\&.com/javase/8/docs/api/constant-values\&.html -.TP -@version \fIversion-text\fR -Introduced in JDK 1\&.0 - -Adds a \fIVersion\fR subheading with the specified \f3version-text\fR value to the generated documents when the \f3-version\fR option is used\&. This tag is intended to hold the current release number of the software that this code is part of, as opposed to the\f3@since\fR tag, which holds the release number where this code was introduced\&. The \f3version-text\fR value has no special internal structure\&. See @version in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@version - -A documentation comment can contain multiple \f3@version\fR tags\&. When it makes sense, you can specify one release number per \f3@version\fR tag or multiple release numbers per tag\&. In the former case, the \f3javadoc\fR command inserts a comma (,) and a space between the names\&. In the latter case, the entire text is copied to the generated document without being parsed\&. Therefore, you can use multiple names per line when you want a localized name separator other than a comma\&. -.SH WHERE\ TAGS\ CAN\ BE\ USED -The following sections describe where tags can be used\&. Note that the following tags can be used in all documentation comments: \f3@see\fR, \f3@since\fR, \f3@deprecated\fR, \f3{@link}\fR, \f3{@linkplain}\fR, and \f3{@docroot}\fR\&. -.SS OVERVIEW\ TAGS -Overview tags are tags that can appear in the documentation comment for the overview page (which resides in the source file typically named overview\&.html)\&. Similar to any other documentation comments, these tags must appear after the main description -.PP -\fINote:\fR The \f3{@link}\fR tag has a bug in overview documents in Java SE 1\&.2\&. The text appears correctly but has no link\&. The \f3{@docRoot}\fR tag does not currently work in overview documents\&. -.PP -The overview tags are the following: -.PP -@see reference || @since since-text || @serialField field-name field-type field-description || @author name-text || @version version-text || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || -.SS PACKAGE\ TAGS -Package tags are tags that can appear in the documentation comment for a package, that resides in the source file named package\&.html or package-info\&.java\&. The \f3@serial\fR tag can only be used here with the \f3include\fR or \f3exclude\fR argument\&. -.PP -The package tags are the following: -.PP -@see reference || @since since-text || @serial field-description | include | exclude || @author name-text || @version version-text || {@linkplain package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || -.SS CLASS\ AND\ INTERFACE\ TAGS -The following are tags that can appear in the documentation comment for a class or interface\&. The \f3@serial\fR tag can only be used within the documentation for a class or interface with an \f3include\fR or \f3exclude\fR argument\&. -.PP -@see reference || @since since-text || @deprecated deprecated-text || @serial field-description | include | exclude || @author name-text || @version version-text || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || -.PP -Class comment example: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * A class representing a window on the screen\&.\fP -.fi -.nf -\f3 * For example:\fP -.fi -.nf -\f3 * <pre>\fP -.fi -.nf -\f3 * Window win = new Window(parent);\fP -.fi -.nf -\f3 * win\&.show();\fP -.fi -.nf -\f3 * </pre>\fP -.fi -.nf -\f3 *\fP -.fi -.nf -\f3 * @author Sami Shaio\fP -.fi -.nf -\f3 * @version 1\&.13, 06/08/06\fP -.fi -.nf -\f3 * @see java\&.awt\&.BaseWindow\fP -.fi -.nf -\f3 * @see java\&.awt\&.Button\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3class Window extends BaseWindow {\fP -.fi -.nf -\f3 \&.\&.\&.\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS FIELD\ TAGS -These tags can appear in fields: -.PP -@see reference || @since since-text || @deprecated deprecated-text || @serial field-description | include | exclude || @serialField field-name field-type field-description || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || {@value package\&.class#field} -.PP -Field comment example: -.sp -.nf -\f3 /**\fP -.fi -.nf -\f3 * The X\-coordinate of the component\&.\fP -.fi -.nf -\f3 *\fP -.fi -.nf -\f3 * @see #getLocation()\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3 int x = 1263732;\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS CONSTRUCTOR\ AND\ METHOD\ TAGS -The following tags can appear in the documentation comment for a constructor or a method, except for the \f3@return\fR tag, which cannot appear in a constructor, and the \f3{@inheritDoc}\fR tag, which has restrictions\&. -.PP -@see reference || @since since-text || @deprecated deprecated-text || @param parameter-name description || @return description || @throws class-name description || @exception class-name description || @serialData data-description || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@inheritDoc} || {@docRoot} -.PP -\fINote:\fR The \f3@serialData\fR tag can only be used in the documentation comment for the \f3writeObject\fR, \f3readObject\fR, \f3writeExternal\fR, \f3readExternal\fR, \f3writeReplace\fR, and \f3readResolve\fR methods\&. -.PP -Method comment example: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * Returns the character at the specified index\&. An index \fP -.fi -.nf -\f3 * ranges from <code>0</code> to <code>length() \- 1</code>\fP -.fi -.nf -\f3 *\fP -.fi -.nf -\f3 * @param index the index of the desired character\&.\fP -.fi -.nf -\f3 * @return the desired character\&.\fP -.fi -.nf -\f3 * @exception StringIndexOutOfRangeException \fP -.fi -.nf -\f3 * if the index is not in the range <code>0</code> \fP -.fi -.nf -\f3 * to <code>length()\-1</code>\fP -.fi -.nf -\f3 * @see java\&.lang\&.Character#charValue()\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3 public char charAt(int index) {\fP -.fi -.nf -\f3 \&.\&.\&.\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH OPTIONS -The \f3javadoc\fR command uses doclets to determine its output\&. The \f3javadoc\fR command uses the default standard doclet unless a custom doclet is specified with the \f3-doclet\fR option\&. The \f3javadoc\fR command provides a set of command-line options that can be used with any doclet\&. These options are described in Javadoc Options\&. The standard doclet provides an additional set of command-line options that are described in Standard Doclet Options\&. All option names are not case-sensitive, but their arguments are case-sensitive\&. -.TP 0.2i -\(bu -See also Javadoc Options -.TP 0.2i -\(bu -See also Standard Doclet Options -.PP -The options are: -.PP --1\&.1 || -author || -bootclasspath classpathlist || -bottom text || -breakiterator || -charset name || -classpath classpathlist || -d directory || -docencoding name || -docfilesubdirs || -doclet class || -docletpath classpathlist || -doctitle title || -encoding || -exclude packagename1:packagename2:\&.\&.\&. || -excludedocfilessubdir name1:name2 || -extdirs dirist || -footer footer || -group groupheading packagepattern:packagepattern || -header header || -help || -helpfile path\efilename || -Jflag || -javafx ||-keywords || -link extdocURL || -linkoffline extdocURL packagelistLoc || -linksource || -locale language_country_variant || -nocomment || -nodeprecated || -nodeprecatedlist || -nohelp || -noindex || -nonavbar || -noqualifier all | packagename1:packagename2\&.\&.\&. || -nosince || -notimestamp || -notree || -overview path/filename || -package || -private || -protected || -public || -quiet || -serialwarn || -source release || -sourcepath sourcepathlist || -sourcetab tablength || -splitindex || -stylesheet path/filename || -subpackages package1:package2:\&.\&.\&. || -tag tagname:Xaoptcmf:"taghead" || -taglet class || -tagletpath tagletpathlist || -title title || -top || -use || -verbose || -version || -windowtitle title -.PP -The following options are the core Javadoc options that are available to all doclets\&. The standard doclet provides the rest of the doclets: \f3-bootclasspath\fR, \f3-breakiterator\fR, \f3-classpath\fR, \f3-doclet\fR, \f3-docletpath\fR, \f3-encoding\fR, -\f3exclude\fR, \f3-extdirs\fR, \f3-help\fR, \f3-locale\fR, \f3-\fR\f3overview\fR, \f3-package\fR, \f3-private\fR, \f3-protected\fR, \f3-public\fR, \f3-quiet\fR, \f3-source\fR, \f3-sourcepath\fR, \f3-subpackages\fR, and \f3-verbose\fR\&. -.SS JAVADOC\ OPTIONS -.TP --overview \fIpath/filename\fR -.br -Specifies that the \f3javadoc\fR command should retrieve the text for the overview documentation from the source file specified by the \fIpath/filename\fRand place it on the Overview page (overview-summary\&.html)\&. The \fIpath/filename\fRis relative to the current directory\&. - -While you can use any name you want for the \f3filename\fR value and place it anywhere you want for the path, it is typical to name it overview\&.html and place it in the source tree at the directory that contains the topmost package directories\&. In this location, no path is needed when documenting packages, because the \f3-sourcepath\fR option points to this file\&. - -For example, if the source tree for the \f3java\&.lang\fR package is /src/classes/java/lang/, then you could place the overview file at /src/classes/overview\&.html - -See Real-World Examples\&. - -For information about the file specified by \fIpath/filename,\fRsee Overview Comment Files\&. - -The overview page is created only when you pass two or more package names to the \f3javadoc\fR command\&. For a further explanation, see HTML Frames\&. The title on the overview page is set by \f3-doctitle\fR\&. -.TP --Xdoclint:(all|none|[-]\fI<group>\fR) -.br -Reports warnings for bad references, lack of accessibility and missing Javadoc comments, and reports errors for invalid Javadoc syntax and missing HTML tags\&. - -This option enables the \f3javadoc\fR command to check for all documentation comments included in the generated output\&. As always, you can select which items to include in the generated output with the standard options \f3-public\fR, \f3-protected\fR, \f3-package\fR and \f3-private\fR\&. - -When the \f3-Xdoclint\fR is enabled, it reports issues with messages similar to the \f3javac\fR command\&. The \f3javadoc\fR command prints a message, a copy of the source line, and a caret pointing at the exact position where the error was detected\&. Messages may be either warnings or errors, depending on their severity and the likelihood to cause an error if the generated documentation were run through a validator\&. For example, bad references or missing Javadoc comments do not cause the \f3javadoc\fR command to generate invalid HTML, so these issues are reported as warnings\&. Syntax errors or missing HTML end tags cause the \f3javadoc\fR command to generate invalid output, so these issues are reported as errors\&. - -By default, the \f3-Xdoclint\fR option is enabled\&. Disable it with the option \f3-Xdoclint:none\fR\&. - -Change what the \f3-Xdoclint\fR option reports with the following options: -.RS -.TP 0.2i -\(bu -\f3-Xdoclint none\fR : disable the \f3-Xdoclint\fR option -.TP 0.2i -\(bu -\f3-Xdoclint\fR\fIgroup\fR : enable \fIgroup\fR checks -.TP 0.2i -\(bu -\f3-Xdoclint all\fR : enable all groups of checks -.TP 0.2i -\(bu -\f3-Xdoclint all,\fR\fI-group\fR : enable all except \fIgroup\fR checks -.RE - - -The variable \fIgroup\fR has one of the following values: -.RS -.TP 0.2i -\(bu -\f3accessibility\fR : Checks for the issues to be detected by an accessibility checker (for example, no caption or summary attributes specified in a \f3<table>\fR tag)\&. -.TP 0.2i -\(bu -\f3html\fR : Detects high-level HTML issues, like putting block elements inside inline elements, or not closing elements that require an end tag\&. The rules are derived from theHTML 4\&.01 Specification\&. This type of check enables the \f3javadoc\fR command to detect HTML issues that many browsers might accept\&. -.TP 0.2i -\(bu -\f3missing\fR : Checks for missing Javadoc comments or tags (for example, a missing comment or class, or a missing \f3@return\fR tag or similar tag on a method)\&. -.TP 0.2i -\(bu -\f3reference\fR : Checks for issues relating to the references to Java API elements from Javadoc tags (for example, item not found in \f3@see\fR , or a bad name after \f3@param)\fR\&. -.TP 0.2i -\(bu -\f3syntax\fR : Checks for low level issues like unescaped angle brackets (\f3<\fR and \f3>\fR) and ampersands (\f3&\fR) and invalid Javadoc tags\&. -.RE - - -You can specify the \f3-Xdoclint\fR option multiple times to enable the option to check errors and warnings in multiple categories\&. Alternatively, you can specify multiple error and warning categories by using the preceding options\&. For example, use either of the following commands to check for the HTML, syntax, and accessibility issues in the file \fIfilename\fR\&. -.sp -.nf -\f3javadoc \-Xdoclint:html \-Xdoclint:syntax \-Xdoclint:accessibility \fIfilename\fR\fP -.fi -.nf -\f3javadoc \-Xdoclint:html,syntax,accessibility \fIfilename\fR\fP -.fi -.nf -\f3\fP -.fi -.sp - - -\fINote:\fR The \f3javadoc\fR command does not guarantee the completeness of these checks\&. In particular, it is not a full HTML compliance checker\&. The goal of the -\f3Xdoclint\fR option is to enable the \f3javadoc\fR command to report majority of common errors\&. - -The \f3javadoc\fR command does not attempt to fix invalid input, it just reports it\&. -.TP --public -.br -Shows only public classes and members\&. -.TP --protected -.br -Shows only protected and public classes and members\&. This is the default\&. -.TP --package -.br -Shows only package, protected, and public classes and members\&. -.TP --private -.br -Shows all classes and members\&. -.TP --help -.br -Displays the online help, which lists all of the \f3javadoc\fR and \f3doclet\fR command-line options\&. -.TP --doclet \fIclass\fR -.br -Specifies the class file that starts the doclet used in generating the documentation\&. Use the fully qualified name\&. This doclet defines the content and formats the output\&. If the \f3-doclet\fR option is not used, then the \f3javadoc\fR command uses the standard doclet for generating the default HTML format\&. This class must contain the \f3start(Root)\fR method\&. The path to this starting class is defined by the \f3-docletpath\fR option\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html -.TP --docletpath \fIclasspathlist\fR -.br -Specifies the path to the doclet starting class file (specified with the \f3-doclet\fR option) and any JAR files it depends on\&. If the starting class file is in a JAR file, then this option specifies the path to that JAR file\&. You can specify an absolute path or a path relative to the current directory\&. If \f3classpathlist\fR contains multiple paths or JAR files, then they should be separated with a colon (:) on Oracle Solaris and a semi-colon (;) on Windows\&. This option is not necessary when the doclet starting class is already in the search path\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html -.TP --1\&.1 -.br -Removed from Javadoc 1\&.4 with no replacement\&. This option created documentation with the appearance and functionality of documentation generated by Javadoc 1\&.1 (it never supported nested classes)\&. If you need this option, then use Javadoc 1\&.2 or 1\&.3 instead\&. -.TP --source \fIrelease\fR -.br -Specifies the release of source code accepted\&. The following values for the \f3release\fR parameter are allowed\&. Use the value of \f3release\fR that corresponds to the value used when you compile code with the \f3javac\fR command\&. -.RS -.TP 0.2i -\(bu -\fIRelease Value: 1\&.5\fR\&. The \f3javadoc\fR command accepts code containing generics and other language features introduced in JDK 1\&.5\&. The compiler defaults to the 1\&.5 behavior when the \f3-source\fR option is not used\&. -.TP 0.2i -\(bu -\fIRelease Value: 1\&.4\fR\&. The \f3javadoc\fR command accepts code containing assertions, which were introduced in JDK 1\&.4\&. -.TP 0.2i -\(bu -\fIRelease Value: 1\&.3\fR\&. The \f3javadoc\fR command does not support assertions, generics, or other language features introduced after JDK 1\&.3\&. -.RE - -.TP --sourcepath \fIsourcepathlist\fR -.br -Specifies the search paths for finding source files when passing package names or the \f3-subpackages\fR option into the \f3javadoc\fR command\&. Separate multiple paths with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. Note that this option is not only used to locate the source files being documented, but also to find source files that are not being documented, but whose comments are inherited by the source files being documented\&. - -You can use the \f3-sourcepath\fR option only when passing package names into the \f3javadoc\fR command\&. This will not locate source files passed into the \f3javadoc\fR command\&. To locate source files, \f3\fRchange to that directory or include the path ahead of each file, as shown at Document One or More Classes\&. If you omit \f3-sourcepath\fR, then the \f3javadoc\fR command uses the class path to find the source files (see \f3-classpath\fR)\&. The default \f3-sourcepath\fR is the value of class path\&. If \f3-classpath\fR is omitted and you pass package names into the \f3javadoc\fR command, then the \f3javadoc\fR command searches in the current directory and subdirectories for the source files\&. - -Set \f3sourcepathlist\fR to the root directory of the source tree for the package you are documenting\&. - -For example, suppose you want to document a package called \f3com\&.mypackage\fR, whose source files are located at:/home/user/src/com/mypackage/*\&.java\&. Specify the sourcepath to /home/user/src, the directory that contains com\emypackage, and then supply the package name, as follows: -.sp -.nf -\f3javadoc \-sourcepath /home/user/src/ com\&.mypackage\fP -.fi -.nf -\f3\fP -.fi -.sp - - -Notice that if you concatenate the value of sourcepath and the package name together and change the dot to a slash (/), then you have the full path to the package: - -/home/user/src/com/mypackage - -To point to two source paths: -.sp -.nf -\f3javadoc \-sourcepath /home/user1/src:/home/user2/src com\&.mypackage\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --classpath \fIclasspathlist\fR -.br -Specifies the paths where the \f3javadoc\fR command searches for referenced classes These are the documented classes plus any classes referenced by those classes\&. Separate multiple paths with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. Follow the instructions in the class path documentation for specifying the \f3classpathlist\fR value\&. - -If you omit \f3-sourcepath\fR, then the \f3javadoc\fR command uses \f3-classpath\fR to find the source files and class files (for backward compatibility)\&. If you want to search for source and class files in separate paths, then use both \f3-sourcepath\fR and \f3-classpath\fR\&. - -For example, if you want to document \f3com\&.mypackage\fR, whose source files reside in the directory /home/user/src/com/mypackage, and if this package relies on a library in /home/user/lib, then you would use the following command: -.sp -.nf -\f3javadoc \-sourcepath /home/user/lib \-classpath /home/user/src com\&.mypackage\fP -.fi -.nf -\f3\fP -.fi -.sp - - -Similar to other tools, if you do not specify \f3-classpath\fR, then the \f3javadoc\fR command uses the \f3CLASSPATH\fR environment variable when it is set\&. If both are not set, then the \f3javadoc\fR command searches for classes from the current directory\&. - -For an in-depth description of how the \f3javadoc\fR command uses \f3-classpath\fR to find user classes as it relates to extension classes and bootstrap classes, see How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html - -A class path element that contains a base name of * is considered equivalent to specifying a list of all the files in the directory with the extension \f3\&.jar\fR or \f3\&.JAR\fR\&. - -For example, if directory \f3mydir\fR contains \f3a\&.jar\fR and \f3b\&.JA\fRR, then the class path element \f3foo/*\fR is expanded to a \f3A\&.jar:b\&.JAR\fR, except that the order of JAR files is unspecified\&. All JAR files in the specified directory including hidden files are included in the list\&. A class path entry that consists of * expands to a list of all the jar files in the current directory\&. The \f3CLASSPATH\fR environment variable is similarly expanded\&. Any class path wildcard expansion occurs before the Java Virtual Machine (JVM) starts\&. No Java program ever sees unexpanded wild cards except by querying the environment, for example, by calling System\&.getenv(\f3"CLASSPATH"\fR)\&. -.TP --subpackages \fIpackage1:package2:\&.\&.\&.\fR -.br -Generates documentation from source files in the specified packages and recursively in their subpackages\&. This option is useful when adding new subpackages to the source code because they are automatically included\&. Each package argument is any top-level subpackage (such as \f3java\fR) or fully qualified package (such as \f3javax\&.swing\fR) that does not need to contain source files\&. Arguments are separated by colons on all operating systems\&. Wild cards are not allowed\&. Use \f3-sourcepath\fR to specify where to find the packages\&. This option does not process source files that are in the source tree but do not belong to the packages\&. See Process Source Files\&. - -For example, the following command generates documentation for packages named \f3java\fR and \f3javax\&.swing\fR and all of their subpackages\&. -.sp -.nf -\f3javadoc \-d docs \-sourcepath /home/user/src \-subpackages java:javax\&.swing \fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --exclude \fIpackagename1:packagename2:\&.\&.\&.\fR -.br -Unconditionally excludes the specified packages and their subpackages from the list formed by \f3-subpackages\fR\&. It excludes those packages even when they would otherwise be included by some earlier or later \f3-subpackages\fR option\&. - -The following example would include \f3java\&.io\fR, \f3java\&.util\fR, and \f3java\&.math\fR (among others), but would exclude packages rooted at \f3java\&.net\fR and \f3java\&.lang\fR\&. Notice that this example excludes \f3java\&.lang\&.ref\fR, which is a subpackage of \f3java\&.lang\fR\&. -.sp -.nf -\f3javadoc \-sourcepath /home/user/src \-subpackages java \-exclude \fP -.fi -.nf -\f3 java\&.net:java\&.lang\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --bootclasspath \fIclasspathlist\fR -.br -Specifies the paths where the boot classes reside\&. These are typically the Java platform classes\&. The \f3bootclasspath\fR is part of the search path the \f3javadoc\fR command uses to look up source and class files\&. For more information, see How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html - -Separate directories in the \f3classpathlist\fR parameters with semicolons (;) for Windows and colons (:) for Oracle Solaris\&. -.TP --extdirs \fIdirist\fR -.br -Specifies the directories where extension classes reside\&. These are any classes that use the Java Extension mechanism\&. The \f3extdirs\fR option is part of the search path the \f3javadoc\fR command uses to look up source and class files\&. See the \f3-classpath\fR option for more information\&. Separate directories in \f3dirlist\fR with semicolons (;) for Windows and colons (:) for Oracle Solaris\&. -.TP --verbose -.br -Provides more detailed messages while the \f3javadoc\fR command runs\&. Without the \f3verbose\fR option, messages appear for loading the source files, generating the documentation (one message per source file), and sorting\&. The verbose option causes the printing of additional messages that specify the number of milliseconds to parse each Java source file\&. -.TP --quiet -.br -Shuts off messages so that only the warnings and errors appear to make them easier to view\&. It also suppresses the \f3version\fR string\&. -.TP --breakiterator -.br -Uses the internationalized sentence boundary of \f3java\&.text\&.BreakIterator\fR to determine the end of the first sentence in the main description of a package, class, or member for English\&. All other locales already use the \f3BreakIterator\fR class, rather than an English language, locale-specific algorithm\&. The first sentence is copied to the package, class, or member summary and to the alphabetic index\&. From JDK 1\&.2 and later, the \f3BreakIterator\fR class is used to determine the end of a sentence for all languages except for English\&. Therefore, the \f3-breakiterator\fR option has no effect except for English from 1\&.2 and later\&. English has its own default algorithm: -.RS -.TP 0.2i -\(bu -English default sentence-break algorithm\&. Stops at a period followed by a space or an HTML block tag, such as \f3<P>\fR\&. -.TP 0.2i -\(bu -Breakiterator sentence-break algorithm\&. Stops at a period, question mark, or exclamation point followed by a space when the next word starts with a capital letter\&. This is meant to handle most abbreviations (such as "The serial no\&. is valid", but will not handle "Mr\&. Smith")\&. The \f3-breakiterator\fR option does not stop at HTML tags or sentences that begin with numbers or symbols\&. The algorithm stops at the last period in \&.\&./filename, even when embedded in an HTML tag\&. -.RE - - -In Java SE 1\&.5 the \f3-breakiterator\fR option warning messages are removed, and the default sentence-break algorithm is unchanged\&. If you have not modified your source code to eliminate the \f3-breakiterator\fR option warnings in Java SE 1\&.4\&.x, then you do not have to do anything\&. The warnings go away starting with Java SE 1\&.5\&.0\&. -.TP --locale \fIlanguage_country_variant\fR -.br -Specifies the locale that the \f3javadoc\fR command uses when it generates documentation\&. The argument is the name of the locale, as described in \f3j\fR\f3ava\&.util\&.Locale\fR documentation, such as \f3en_US\fR (English, United States) or \f3en_US_WIN\fR (Windows variant)\&. - -\fINote:\fR The \f3-locale\fR option must be placed ahead (to the left) of any options provided by the standard doclet or any other doclet\&. Otherwise, the navigation bars appear in English\&. This is the only command-line option that depends on order\&. See Standard Doclet Options\&. - -Specifying a locale causes the \f3javadoc\fR command to choose the resource files of that locale for messages such as strings in the navigation bar, headings for lists and tables, help file contents, comments in the stylesheet\&.css file, and so on\&. It also specifies the sorting order for lists sorted alphabetically, and the sentence separator to determine the end of the first sentence\&. The \f3-locale\fR option does not determine the locale of the documentation comment text specified in the source files of the documented classes\&. -.TP --encoding -.br -Specifies the encoding name of the source files, such as \f3EUCJIS/SJIS\fR\&. If this option is not specified, then the platform default converter is used\&. See also the\f3-docencoding name\fR and \f3-charset name\fR options\&. -.TP --J\fIflag\fR -.br -Passes \f3flag\fR directly to the Java Runtime Environment (JRE) that runs the \f3javadoc\fR command\&. For example, if you must ensure that the system sets aside 32 MB of memory in which to process the generated documentation, then you would call the \f3-Xmx\fR option as follows: \f3javadoc -J-Xmx32m -J-Xms32m com\&.mypackage\fR\&. Be aware that \f3-Xms\fR is optional because it only sets the size of initial memory, which is useful when you know the minimum amount of memory required\&. - -There is no space between the \f3J\fR and the \f3flag\fR\&. - -Use the \f3-version\fR option to find out what version of the \f3javadoc\fR command you are using\&. The version number of the standard doclet appears in its output stream\&. See Running the Javadoc Command\&. -.sp -.nf -\f3javadoc \-J\-version\fP -.fi -.nf -\f3java version "1\&.7\&.0_09"\fP -.fi -.nf -\f3Java(TM) SE Runtime Environment (build 1\&.7\&.0_09\-b05)\fP -.fi -.nf -\f3Java HotSpot(TM) 64\-Bit Server VM (build 23\&.5\-b02, mixed mode)\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --javafx -.br -Generates HTML documentation using the JavaFX extensions to the standard doclet\&. The generated documentation includes a Property Summary section in addition to the other summary sections generated by the standard Java doclet\&. The listed properties are linked to the sections for the getter and setter methods of each property\&. - -If there are no documentation comments written explicitly for getter and setter methods, the documentation comments from the property method are automatically copied to the generated documentation for these methods\&. This option also adds a new \f3@defaultValue\fR tag that allows documenting the default value for a property\&. - -Example: -.sp -.nf -\f3javadoc \-javafx MyClass\&.java \-d testdir\fP -.fi -.sp - -.SS STANDARD\ DOCLET\ OPTIONS -.TP --d \fIdirectory\fR -.br -Specifies the destination directory where the \f3javadoc\fR command saves the generated HTML files\&. If you omit the \f3-d\fR option, then the files are saved to the current directory\&. The \f3directory\fR value can be absolute or relative to the current working directory\&. As of Java SE 1\&.4, the destination directory is automatically created when the \f3javadoc\fR command runs\&. - -For example, the following command generates the documentation for the package \f3com\&.mypackage\fR and saves the results in the /user/doc/ directory: \f3javadoc -d\fR\f3/user/doc/\fR\f3com\&.mypackage\fR\&. -.TP --use -.br -Includes one Use page for each documented class and package\&. The page describes what packages, classes, methods, constructors and fields use any API of the specified class or package\&. Given class C, things that use class C would include subclasses of C, fields declared as C, methods that return C, and methods and constructors with parameters of type C\&. For example, you can look at the Use page for the \f3String\fR type\&. Because the \f3getName\fR method in the \f3java\&.awt\&.Font\fR class returns type \f3String\fR, the \f3getName\fR method uses \f3String\fR and so the \f3getName\fR method appears on the Use page for \f3String\fR\&.This documents only uses of the API, not the implementation\&. When a method uses \f3String\fR in its implementation, but does not take a string as an argument or return a string, that is not considered a use of \f3String\fR\&.To access the generated Use page, go to the class or package and click the \fIUse link\fR in the navigation bar\&. -.TP --version -.br -Includes the @version text in the generated docs\&. This text is omitted by default\&. To find out what version of the \f3javadoc\fR command you are using, use the \f3-J-version\fR option\&. -.TP --author -.br -Includes the \f3@author\fR text in the generated docs\&. -.TP --splitindex -.br -Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical symbols\&. -.TP --windowtitle \fItitle\fR -.br -Specifies the title to be placed in the HTML \f3<title>\fR tag\&. The text specified in the \f3title\fR tag appears in the window title and in any browser bookmarks (favorite places) that someone creates for this page\&. This title should not contain any HTML tags because the browser does not interpret them correctly\&. Use escape characters on any internal quotation marks within the \f3title\fR tag\&. If the \f3-windowtitle\fR option is omitted, then the \f3javadoc\fR command uses the value of the \f3-doctitle\fR option for the \f3-windowtitle\fR option\&. For example, \f3javadoc -windowtitle "Java SE Platform" com\&.mypackage\fR\&. -.TP --doctitle \fItitle\fR -.br -Specifies the title to place near the top of the overview summary file\&. The text specified in the \f3title\fR tag is placed as a centered, level-one heading directly beneath the top navigation bar\&. The \f3title\fR tag can contain HTML tags and white space, but when it does, you must enclose the title in quotation marks\&. Internal quotation marks within the \f3title\fR tag must be escaped\&. For example, \f3javadoc -header "<b>Java Platform </b><br>v1\&.4" com\&.mypackage\&.\fR -.TP --title \fItitle\fR -.br -No longer exists\&. It existed only in Beta releases of Javadoc 1\&.2\&. It was renamed to \f3-doctitle\fR\&. This option was renamed to make it clear that it defines the document title, rather than the window title\&. -.TP --header \fIheader\fR -.br -Specifies the header text to be placed at the top of each output file\&. The header is placed to the right of the upper navigation bar\&. The \f3header\fR can contain HTML tags and white space, but when it does, the \f3header\fR must be enclosed in quotation marks\&. Use escape characters for internal quotation marks within a header\&. For example, \f3javadoc -header "<b>Java Platform </b><br>v1\&.4" com\&.mypackage\&.\fR -.TP --footer \fIfooter\fR -.br -Specifies the footer text to be placed at the bottom of each output file\&. The \fIfooter\fR value is placed to the right of the lower navigation bar\&. The \f3footer\fR value can contain HTML tags and white space, but when it does, the \f3footer\fR value must be enclosed in quotation marks\&. Use escape characters for any internal quotation marks within a footer\&. -.TP --top -.br -Specifies the text to be placed at the top of each output file\&. -.TP --bottom \fItext\fR -.br -Specifies the text to be placed at the bottom of each output file\&. The text is placed at the bottom of the page, underneath the lower navigation bar\&. The text can contain HTML tags and white space, but when it does, the text must be enclosed in quotation marks\&. Use escape characters for any internal quotation marks within text\&. -.TP --link \fIextdocURL\fR -.br -Creates links to existing Javadoc-generated documentation of externally referenced classes\&. The \fIextdocURL\fR argument is the absolute or relative URL of the directory that contains the external Javadoc-generated documentation you want to link to\&. You can specify multiple \f3-link\fR options in a specified \f3javadoc\fR command run to link to multiple documents\&. - -The package-list file must be found in this directory (otherwise, use the \f3-linkoffline\fR option)\&. The \f3javadoc\fR command reads the package names from the package-list file and links to those packages at that URL\&. When the \f3javadoc\fR command runs, the \f3extdocURL\fR value is copied into the \f3<A HREF>\fR links that are created\&. Therefore, \f3extdocURL\fR must be the URL to the directory, and not to a file\&. You can use an absolute link for \fIextdocURL\fR to enable your documents to link to a document on any web site, or you can use a relative link to link only to a relative location\&. If you use a relative link, then the value you pass in should be the relative path from the destination directory (specified with the \f3-d\fR option) to the directory containing the packages being linked to\&.When you specify an absolute link, you usually use an HTTP link\&. However, if you want to link to a file system that has no web server, then you can use a file link\&. Use a file link only when everyone who wants to access the generated documentation shares the same file system\&.In all cases, and on all operating systems, use a slash as the separator, whether the URL is absolute or relative, and \f3h\fR\f3ttp:\fR or \f3f\fR\f3ile:\fR as specified in the URL Memo: Uniform Resource Locators at http://www\&.ietf\&.org/rfc/rfc1738\&.txt -.sp -.nf -\f3\-link http://<host>/<directory>/<directory>/\&.\&.\&./<name>\fP -.fi -.nf -\f3\-link file://<host>/<directory>/<directory>/\&.\&.\&./<name>\fP -.fi -.nf -\f3\-link <directory>/<directory>/\&.\&.\&./<name>\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Differences between the -linkoffline and -link options - -Use the \f3-link\fR option in the following cases: -.TP 0.2i -\(bu -When you use a relative path to the external API document\&. -.TP 0.2i -\(bu -When you use an absolute URL to the external API document if your shell lets you open a connection to that URL for reading\&. -.PP -Use the \f3-linkoffline\fR option when you use an absolute URL to the external API document, if your shell does not allow a program to open a connection to that URL for reading\&. This can occur when you are behind a firewall and the document you want to link to is on the other side\&. -.PP -\f3Example 1 Absolute Link to External Documents\fR -.PP -Use the following command if you want to link to the \f3java\&.lang\fR, \f3java\&.io\fR and other Java platform packages, shown at http://docs\&.oracle\&.com/javase/8/docs/api/index\&.html -.sp -.nf -\f3javadoc \-link http://docs\&.oracle\&.com/javase/8/docs/api/ com\&.mypackage\fP -.fi -.nf -\f3\fP -.fi -.sp -The command generates documentation for the package \f3com\&.mypackage\fR with links to the Java SE packages\&. The generated documentation contains links to the \f3Object\fR class, for example, in the class \f3trees\fR\&. Other options, such as the \f3-sourcepath\fR and \f3-d\fR options, are not shown\&. -.PP -\f3Example 2 Relative Link to External Documents\fR -.PP -In this example, there are two packages with documents that are generated in different runs of the \f3javadoc\fR command, and those documents are separated by a relative path\&. The packages are \f3com\&.apipackage\fR, an API, and c\f3om\&.spipackage\fR, an Service Provide Interface (SPI)\&. You want the documentation to reside in docs/api/com/apipackage and docs/spi/com/spipackage\&. Assuming that the API package documentation is already generated, and that docs is the current directory, you document the SPI package with links to the API documentation by running: \f3javadoc -d \&./spi -link \&.\&./api com\&.spipackage\fR\&. -.PP -Notice the \f3-link\fR option is relative to the destination directory (docs/spi)\&. -.PP -Notes - -The \f3-link\fR option lets you link to classes referenced to by your code, but not documented in the current \f3javadoc\fR command run\&. For these links to go to valid pages, you must know where those HTML pages are located and specify that location with \f3extdocURL\fR\&. This allows third-party documentation to link to java\&.* documentation at http://docs\&.oracle\&.com\&.Omit the \f3-link\fR option when you want the \f3javadoc\fR command to create links only to APIs within the documentation it is generating in the current run\&. Without the \f3-link\fR option, the \f3javadoc\fR command does not create links to documentation for external references because it does not know whether or where that documentation exists\&.The \f3-link\fR option can create links in several places in the generated documentation\&. See Process Source Files\&. Another use is for cross-links between sets of packages: Execute the \f3javadoc\fR command on one set of packages, then run the \f3javadoc\fR command again on another set of packages, creating links both ways between both sets\&. -.PP -How to Reference a Class - -For a link to an externally referenced class to appear (and not just its text label), the class must be referenced in the following way\&. It is not sufficient for it to be referenced in the body of a method\&. It must be referenced in either an \f3import\fR statement or in a declaration\&. Here are examples of how the class \f3java\&.io\&.File\fR can be referenced: -.PP -\fI\fRIn any kind of import statement\&. By wildcard import, import explicitly by name, or automatically import for \f3java\&.lang\&.*\fR\&. -.PP -In Java SE 1\&.3\&.\fIn\fR and 1\&.2\&.\fIn\fR, only an explicit import by name works\&. A wildcard \f3import\fR statement does not work, nor does the automatic \f3import java\&.lang\&.*\fR\&. -.PP -\fI\fRIn a declaration: \f3void mymethod(File f) {}\fR -.PP -The reference can be in the return type or parameter type of a method, constructor, field, class, or interface, or in an implements, extends, or throws statement\&. -.PP -An important corollary is that when you use the \f3-link\fR option, there can be many links that unintentionally do not appear due to this constraint\&. The text would appear without being a link\&. You can detect these by the warnings they emit\&. The simplest way to properly reference a class and add the link would be to import that class\&. -.PP -Package List - -The \f3-link\fR option requires that a file named package-list, which is generated by the \f3javadoc\fR command, exists at the URL you specify with the \f3-link\fR option\&. The package-list file is a simple text file that lists the names of packages documented at that location\&. In the earlier example, the \f3javadoc\fR command searches for a file named package-list at the specified URL, reads in the package names, and links to those packages at that URL\&. -.PP -For example, the package list for the Java SE API is located at http://docs\&.oracle\&.com/javase/8/docs/api/package-list -.PP -The package list starts as follows: -.sp -.nf -\f3java\&.applet\fP -.fi -.nf -\f3java\&.awt\fP -.fi -.nf -\f3java\&.awt\&.color\fP -.fi -.nf -\f3java\&.awt\&.datatransfer\fP -.fi -.nf -\f3java\&.awt\&.dnd\fP -.fi -.nf -\f3java\&.awt\&.event\fP -.fi -.nf -\f3java\&.awt\&.font\fP -.fi -.nf -\f3and so on \&.\&.\&.\&.\fP -.fi -.nf -\f3\fP -.fi -.sp -When \f3javadoc\fR is run without the \f3-link\fR option and encounters a name that belongs to an externally referenced class, it prints the name with no link\&. However, when the \f3-link\fR option is used, the \f3javadoc\fR command searches the package-list file at the specified \fIextdocURL\fR location for that package name\&. When it finds the package name, it prefixes the name with \fIextdocURL\fR\&. -.PP -For there to be no broken links, all of the documentation for the external references must exist at the specified URLs\&. The \f3javadoc\fR command does not check that these pages exist, but only that the package-list exists\&. -.PP -Multiple Links - -You can supply multiple \f3-link\fR options to link to any number of externally generated documents\&. Javadoc 1\&.2 has a known bug that prevents you from supplying more than one \f3-link\fR options\&. This was fixed in Javadoc 1\&.2\&.2\&. Specify a different link option for each external document to link to \f3javadoc -link extdocURL1 -link extdocURL2 \&.\&.\&. -link extdocURLn com\&.mypackage\fR where \fIextdocURL1\fR, \fIextdocURL2\fR, \&.\f3\&.\&. extdocURLn\fR point respectively to the roots of external documents, each of which contains a file named package-list\&. -.PP -Cross Links - -Note that bootstrapping might be required when cross-linking two or more documents that were previously generated\&. If package-list does not exist for either document when you run the \f3javadoc\fR command on the first document, then the package-list does not yet exist for the second document\&. Therefore, to create the external links, you must regenerate the first document after you generate the second document\&. -.PP -In this case, the purpose of first generating a document is to create its package-list (or you can create it by hand if you are certain of the package names)\&. Then, generate the second document with its external links\&. The \f3javadoc\fR command prints a warning when a needed external package-list file does not exist\&. -.TP --linkoffline \fIextdocURL packagelistLoc\fR -.br -This option is a variation of the \f3-link\fR option\&. They both create links to Javadoc-generated documentation for externally referenced classes\&. Use the \f3-link\fRo\f3ffline\fR option when linking to a document on the web when the \f3javadoc\fR command cannot access the document through a web connection\&. Use the \f3-linkoffline\fR option when package-list file of the external document is not accessible or does not exist at the \f3extdocURL\fR location, but does exist at a different location that can be specified by \f3packageListLoc\fR (typically local)\&. If \f3extdocURL\fR is accessible only on the World Wide Web, then the \f3-linkoffline\fR option removes the constraint that the \f3javadoc\fR command must have a web connection to generate documentation\&. Another use is as a work-around to update documents: After you have run the \f3javadoc\fR command on a full set of packages, you can run the \f3javadoc\fR command again on a smaller set of changed packages, so that the updated files can be inserted back into the original set\&. Examples follow\&. The \f3-linkoffline\fR option takes two arguments\&. The first is for the string to be embedded in the \f3<a href>\fR links, and the second tells the \f3-linkoffline\fR option where to find package-list: -.RS -.TP 0.2i -\(bu -The \f3extdocURL\fR value is the absolute or relative URL of the directory that contains the external Javadoc-generated documentation you want to link to\&. When relative, the value should be the relative path from the destination directory (specified with the \f3-d\fR option) to the root of the packages being linked to\&. For more information, see \fIextdocURL\fR in the \f3-link\fR option\&. -.TP 0.2i -\(bu -The \f3packagelistLoc\fR value is the path or URL to the directory that contains the package-list file for the external documentation\&. This can be a URL (http: or file:) or file path, and can be absolute or relative\&. When relative, make it relative to the current directory from where the \f3javadoc\fR command was run\&. Do not include the package-list file name\&. - -You can specify multiple \f3-linkoffline\fR options in a specified \f3javadoc\fR command run\&. Before Javadoc 1\&.2\&.2, the \f3-linkfile\fR options could be specified once\&. -.RE - -.PP -Absolute Links to External Documents - -You might have a situation where you want to link to the \f3java\&.lang\fR, \f3java\&.io\fR and other Java SE packages at http://docs\&.oracle\&.com/javase/8/docs/api/index\&.html -.PP -However, your shell does not have web access\&. In this case, do the following: -.TP 0.4i -1\&. -Open the package-list file in a browser at http://docs\&.oracle\&.com/javase/8/docs/api/package-list -.TP 0.4i -2\&. -Save the file to a local directory, and point to this local copy with the second argument, \f3packagelistLoc\fR\&. In this example, the package list file was saved to the current directory (\&.)\&. -.PP -The following command generates documentation for the package c\f3om\&.mypackage\fR with links to the Java SE packages\&. The generated documentation will contain links to the \f3Object\fR class, for example, in the class \f3trees\fR\&. Other necessary options, such as \f3-sourcepath\fR, are not shown\&. -.sp -.nf -\f3javadoc \-linkoffline http://docs\&.oracle\&.com/javase/8/docs/api/ \&. com\&.mypackage \fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Relative Links to External Documents - -It is not very common to use \f3-linkoffline\fR with relative paths, for the simple reason that the \f3-link\fR option is usually enough\&. When you use the \f3-linkoffline\fR option, the package-list file is usually local, and when you use relative links, the file you are linking to is also local, so it is usually unnecessary to give a different path for the two arguments to the \f3-linkoffline\fR option When the two arguments are identical, you can use the \f3-link\fR option\&. -.PP -Create a package-list File Manually - -If a package-list file does not exist yet, but you know what package names your document will link to, then you can manually create your own copy of this file and specify its path with \f3packagelistLoc\fR\&. An example would be the previous case where the package list for \f3com\&.spipackage\fR did not exist when \f3com\&.apipackage\fR was first generated\&. This technique is useful when you need to generate documentation that links to new external documentation whose package names you know, but which is not yet published\&. This is also a way of creating package-list files for packages generated with Javadoc 1\&.0 or 1\&.1, where package-list files were not generated\&. Similarly, two companies can share their unpublished package-list files so they can release their cross-linked documentation simultaneously\&. -.PP -Link to Multiple Documents - -You can include the \f3-linkoffline\fR option once for each generated document you want to refer to: -.sp -.nf -\f3javadoc \-linkoffline extdocURL1 packagelistLoc1 \-linkoffline extdocURL2\fP -.fi -.nf -\f3packagelistLoc2 \&.\&.\&.\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Update Documents - -You can also use the \f3-linkoffline\fR option when your project has dozens or hundreds of packages\&. If you have already run the \f3javadoc\fR command on the entire source tree, then you can quickly make small changes to documentation comments and rerun the \f3javadoc\fR command on a portion of the source tree\&. Be aware that the second run works properly only when your changes are to documentation comments and not to declarations\&. If you were to add, remove, or change any declarations from the source code, then broken links could show up in the index, package tree, inherited member lists, Use page, and other places\&. -.PP -First, create a new destination directory, such as update, for this new small run\&. In this example, the original destination directory is named html\&. In the simplest example, change directory to the parent of html\&. Set the first argument of the \f3-linkoffline\fR option to the current directory (\&.) and set the second argument to the relative path to html, where it can find package-list and pass in only the package names of the packages you want to update: -.sp -.nf -\f3javadoc \-d update \-linkoffline \&. html com\&.mypackage\fP -.fi -.nf -\f3\fP -.fi -.sp -When the \f3javadoc\fR command completes, copy these generated class pages in update/com/package (not the overview or index) to the original files in html/com/package\&. -.TP --linksource -.br -Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation\&. Links are created for classes, interfaces, constructors, methods, and fields whose declarations are in a source file\&. Otherwise, links are not created, such as for default constructors and generated classes\&. - -This option exposes all private implementation details in the included source files, including private classes, private fields, and the bodies of private methods, regardless of the \f3-public\fR, \f3-package\fR, \f3-protected\fR, and \f3-private\fR options\&. Unless you also use the \f3-private\fR option, not all private classes or interfaces are accessible through links\&. - -Each link appears on the name of the identifier in its declaration\&. For example, the link to the source code of the \f3Button\fR class would be on the word \f3Button\fR: -.sp -.nf -\f3public class Button extends Component implements Accessible\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The link to the source code of the \f3getLabel\fR method in the \f3Button\fR class is on the word \f3getLabel\fR: -.sp -.nf -\f3public String getLabel()\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --group groupheading \fIpackagepattern:packagepattern\fR -.br -Separates packages on the overview page into whatever groups you specify, one group per table\&. You specify each group with a different \f3-group\fR option\&. The groups appear on the page in the order specified on the command line\&. Packages are alphabetized within a group\&. For a specified \f3-group\fR option, the packages matching the list of \f3packagepattern\fR expressions appear in a table with the heading \fIgroupheading\fR\&. -.RS -.TP 0.2i -\(bu -The \f3groupheading\fR can be any text and can include white space\&. This text is placed in the table heading for the group\&. -.TP 0.2i -\(bu -The \f3packagepattern\fR value can be any package name at the start of any package name followed by an asterisk (*)\&. The asterisk is the only wildcard allowed and means match any characters\&. Multiple patterns can be included in a group by separating them with colons (:)\&. If you use an asterisk in a pattern or pattern list, then the pattern list must be inside quotation marks, such as \f3"java\&.lang*:java\&.util"\fR\&. -.RE - - -When you do not supply a \f3-group\fR option, all packages are placed in one group with the heading \fIPackages\fR and appropriate subheadings\&. If the subheadings do not include all documented packages (all groups), then the remaining packages appear in a separate group with the subheading Other Packages\&. - -For example, the following \f3javadoc\fR command separates the three documented packages into \fICore\fR, \fIExtension\fR, and \fIOther Packages\fR\&. The trailing dot (\&.) does not appear in \f3java\&.lang*\fR\&. Including the dot, such as \f3java\&.lang\&.*\fR omits the\f3java\&.lang\fR package\&. -.sp -.nf -\f3javadoc \-group "Core Packages" "java\&.lang*:java\&.util"\fP -.fi -.nf -\f3 \-group "Extension Packages" "javax\&.*"\fP -.fi -.nf -\f3 java\&.lang java\&.lang\&.reflect java\&.util javax\&.servlet java\&.new\fP -.fi -.nf -\f3\fP -.fi -.sp - - -\fICore Packages\fR - -\f3java\&.lang\fR - -\f3java\&.lang\&.reflect\fR - -\f3java\&.util\fR - -\fIExtension Packages\fR - -\f3javax\&.servlet\fR - -\fIOther Packages\fR - -\f3java\&.new\fR -.TP --nodeprecated -.br -Prevents the generation of any deprecated API in the documentation\&. This does what the \f3-nodeprecatedlist\fR option does, and it does not generate any deprecated API throughout the rest of the documentation\&. This is useful when writing code when you do not want to be distracted by the deprecated code\&. -.TP --nodeprecatedlist -.br -Prevents the generation of the file that contains the list of deprecated APIs (deprecated-list\&.html) and the link in the navigation bar to that page\&. The \f3javadoc\fR command continues to generate the deprecated API throughout the rest of the document\&. This is useful when your source code contains no deprecated APIs, and you want to make the navigation bar cleaner\&. -.TP --nosince -.br -Omits from the generated documents the \f3Since\fR sections associated with the \f3@since\fR tags\&. -.TP --notree -.br -Omits the class/interface hierarchy pages from the generated documents\&. These are the pages you reach using the Tree button in the navigation bar\&. The hierarchy is produced by default\&. -.TP --noindex -.br -Omits the index from the generated documents\&. The index is produced by default\&. -.TP --nohelp -.br -Omits the HELP link in the navigation bars at the top and bottom of each page of output\&. -.TP --nonavbar -.br -Prevents the generation of the navigation bar, header, and footer, that are usually found at the top and bottom of the generated pages\&. The \f3-nonavbar\fR option has no affect on the \f3-bottom\fR option\&. The \f3-nonavbar\fR option is useful when you are interested only in the content and have no need for navigation, such as when you are converting the files to PostScript or PDF for printing only\&. -.TP --helpfile \fIpath\efilename\fR -.br -Specifies the path of an alternate help file path\efilename that the HELP link in the top and bottom navigation bars link to\&. Without this option, the \f3javadoc\fR command creates a help file help-doc\&.html that is hard-coded in the \f3javadoc\fR command\&. This option lets you override the default\&. The file name can be any name and is not restricted to help-doc\&.html\&. The \f3javadoc\fR command adjusts the links in the navigation bar accordingly, for example: -.sp -.nf -\f3javadoc \-helpfile /home/user/myhelp\&.html java\&.awt\&.\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --stylesheet \fIpath/filename\fR -.br -Specifies the path of an alternate HTML stylesheet file\&. Without this option, the \f3javadoc\fR command automatically creates a stylesheet file stylesheet\&.css that is hard-coded in the \f3javadoc\fR command\&. This option lets you override the default\&. The file name can be any name and is not restricted to stylesheet\&.css, for example: -.sp -.nf -\f3javadoc \-stylesheet file /home/user/mystylesheet\&.css com\&.mypackage\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --serialwarn -.br -Generates compile-time warnings for missing \f3@serial\fR tags\&. By default, Javadoc 1\&.2\&.2 and later versions generate no serial warnings\&. This is a reversal from earlier releases\&. Use this option to display the serial warnings, which helps to properly document default serializable fields and \f3writeExternal\fR methods\&. -.TP --charset \fIname\fR -.br -Specifies the HTML character set for this document\&. The name should be a preferred MIME name as specified in the IANA Registry, Character Sets at http://www\&.iana\&.org/assignments/character-sets - -For example, \f3javadoc -charset "iso-8859-1" mypackage\fR inserts the following line in the head of every generated page: -.sp -.nf -\f3<META http\-equiv="Content\-Type" content="text/html; charset=ISO\-8859\-1">\fP -.fi -.nf -\f3\fP -.fi -.sp - - -This \f3META\fR tag is described in the HTML standard (4197265 and 4137321), HTML Document Representation, at http://www\&.w3\&.org/TR/REC-html40/charset\&.html#h-5\&.2\&.2 - -See also the \f3-encoding\fR and \f3-docencoding name\fR options\&. -.TP --docencoding \fIname\fR -.br -Specifies the encoding of the generated HTML files\&. The name should be a preferred MIME name as specified in the IANA Registry, Character Sets at http://www\&.iana\&.org/assignments/character-sets - -If you omit the \f3-docencoding\fR option but use the \f3-encoding\fR option, then the encoding of the generated HTML files is determined by the \f3-encoding\fR option, for example: \f3javadoc -docencoding "iso-8859-1" mypackage\fR\&. See also the \f3-encoding\fR and \f3-docencoding name\fR options\&. -.TP --keywords -.br -Adds HTML keyword <META> tags to the generated file for each class\&. These tags can help search engines that look for <META> tags find the pages\&. Most search engines that search the entire Internet do not look at <META> tags, because pages can misuse them\&. Search engines offered by companies that confine their searches to their own website can benefit by looking at <META> tags\&. The <META> tags include the fully qualified name of the class and the unqualified names of the fields and methods\&. Constructors are not included because they are identical to the class name\&. For example, the class \f3String\fR starts with these keywords: -.sp -.nf -\f3<META NAME="keywords" CONTENT="java\&.lang\&.String class">\fP -.fi -.nf -\f3<META NAME="keywords" CONTENT="CASE_INSENSITIVE_ORDER">\fP -.fi -.nf -\f3<META NAME="keywords" CONTENT="length()">\fP -.fi -.nf -\f3<META NAME="keywords" CONTENT="charAt()">\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --tag \fItagname\fR:Xaoptcmf:"\fItaghead\fR" -.br -Enables the \f3javadoc\fR command to interpret a simple, one-argument \f3@tagname\fR custom block tag in documentation comments\&. For the \f3javadoc\fR command to spell-check tag names, it is important to include a \f3-tag\fR option for every custom tag that is present in the source code, disabling (with \f3X\fR) those that are not being output in the current run\&.The colon (:) is always the separator\&. The \f3-tag\fR option outputs the tag heading \fItaghead\fR in bold, followed on the next line by the text from its single argument\&. Similar to any block tag, the argument text can contain inline tags, which are also interpreted\&. The output is similar to standard one-argument tags, such as the \f3@return\fR and \f3@author\fR tags\&. Omitting a value for \fItaghead\fR causes \f3tagname\fR to be the heading\&. - -\fIPlacement of tags\fR: The \f3Xaoptcmf\fR arguments determine where in the source code the tag is allowed to be placed, and whether the tag can be disabled (using \f3X\fR)\&. You can supply either \f3a\fR, to allow the tag in all places, or any combination of the other letters: - -\f3X\fR (disable tag) - -\f3a\fR (all) - -\f3o\fR (overview) - -\f3p\fR (packages) - -\f3t\fR (types, that is classes and interfaces) - -\f3c\fR (constructors) - -\f3m\fR (methods) - -\f3f\fR (fields) - -\fIExamples of single tags\fR: An example of a tag option for a tag that can be used anywhere in the source code is: \f3-tag todo:a:"To Do:"\fR\&. - -If you want the \f3@todo\fR tag to be used only with constructors, methods, and fields, then you use: \f3-tag todo:cmf:"To Do:"\fR\&. - -Notice the last colon (:) is not a parameter separator, but is part of the heading text\&. You would use either tag option for source code that contains the \f3@todo\fR tag, such as: \f3@todo The documentation for this method needs work\fR\&. - -\fIColons in tag names\fR: Use a backslash to escape a colon that you want to use in a tag name\&. Use the \f3-tag ejb\e\e:bean:a:"EJB Bean:"\fR option for the following documentation comment: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * @ejb:bean\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.sp - - -\fISpell-checking tag names\fR: Some developers put custom tags in the source code that they do not always want to output\&. In these cases, it is important to list all tags that are in the source code, enabling the ones you want to output and disabling the ones you do not want to output\&. The presence of \f3X\fR disables the tag, while its absence enables the tag\&. This gives the \f3javadoc\fR command enough information to know whether a tag it encounters is unknown, which is probably the results of a typographical error or a misspelling\&. The \f3javadoc\fR command prints a warning in these cases\&. You can add \f3X\fR to the placement values already present, so that when you want to enable the tag, you can simply delete the \f3X\fR\&. For example, if the \f3@todo\fR tag is a tag that you want to suppress on output, then you would use: \f3-tag todo:Xcmf:"To Do:"\fR\&. If you would rather keep it simple, then use this: \f3-tag todo:X\fR\&. The syntax \f3-tag todo:X\fR works even when the \f3@todo\fR tag is defined by a taglet\&. - -\fIOrder of tags\fR: The order of the \f3-ta\fR\f3g\fR and \f3-taglet\fR options determines the order the tags are output\&. You can mix the custom tags with the standard tags to intersperse them\&. The tag options for standard tags are placeholders only for determining the order\&. They take only the standard tag\&'s name\&. Subheadings for standard tags cannot be altered\&. This is illustrated in the following example\&.If the \f3-tag\fR option is missing, then the position of the \f3-tagle\fR\f3t\fR option determines its order\&. If they are both present, then whichever appears last on the command line determines its order\&. This happens because the tags and taglets are processed in the order that they appear on the command line\&. For example, if the \f3-taglet\fR and \f3-tag\fR options have the name \f3todo\fR value, then the one that appears last on the command line determines the order\&. - -\fIExample of a complete set of tags\fR: This example inserts To Do after Parameters and before Throws in the output\&. By using \f3X\fR, it also specifies that the \f3@example\fR tag might be encountered in the source code that should not be output during this run\&. If you use the \f3@argfile\fR tag, then you can put the tags on separate lines in an argument file similar to this (no line continuation characters needed): -.sp -.nf -\f3\-tag param\fP -.fi -.nf -\f3\-tag return\fP -.fi -.nf -\f3\-tag todo:a:"To Do:"\fP -.fi -.nf -\f3\-tag throws\fP -.fi -.nf -\f3\-tag see\fP -.fi -.nf -\f3\-tag example:X\fP -.fi -.nf -\f3\fP -.fi -.sp - - -When the \f3javadoc\fR command parses the documentation comments, any tag encountered that is neither a standard tag nor passed in with the \f3-tag\fR or \f3-taglet\fR options is considered unknown, and a warning is thrown\&. - -The standard tags are initially stored internally in a list in their default order\&. Whenever the \f3-tag\fR options are used, those tags get appended to this list\&. Standard tags are moved from their default position\&. Therefore, if a \f3-tag\fR option is omitted for a standard tag, then it remains in its default position\&. - -\fIAvoiding conflicts\fR: If you want to create your own namespace, then you can use a dot-separated naming convention similar to that used for packages: \f3com\&.mycompany\&.todo\fR\&. Oracle will continue to create standard tags whose names do not contain dots\&. Any tag you create will override the behavior of a tag by the same name defined by Oracle\&. If you create a \f3@todo\fR tag or taglet, then it always has the same behavior you define, even when Oracle later creates a standard tag of the same name\&. - -\fIAnnotations vs\&. Javadoc tags\fR: In general, if the markup you want to add is intended to affect or produce documentation, then it should be a Javadoc tag\&. Otherwise, it should be an annotation\&. See Custom Tags and Annotations in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#annotations - -You can also create more complex block tags or custom inline tags with the \f3-taglet\fR option\&. -.TP --taglet \fIclass\fR -.br -Specifies the class file that starts the taglet used in generating the documentation for that tag\&. Use the fully qualified name for the \f3class\fR value\&. This taglet also defines the number of text arguments that the custom tag has\&. The taglet accepts those arguments, processes them, and generates the output\&. For extensive documentation with example taglets, see: Taglet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/taglet/overview\&.html - -Taglets are useful for block or inline tags\&. They can have any number of arguments and implement custom behavior, such as making text bold, formatting bullets, writing out the text to a file, or starting other processes\&. Taglets can only determine where a tag should appear and in what form\&. All other decisions are made by the doclet\&. A taglet cannot do things such as remove a class name from the list of included classes\&. However, it can execute side effects, such as printing the tag\&'s text to a file or triggering another process\&. Use the \f3-tagletpath\fR option to specify the path to the taglet\&. The following example inserts the To Do taglet after Parameters and ahead of Throws in the generated pages\&. Alternately, you can use the \f3-taglet\fR option in place of its \f3-tag\fR option, but that might be difficult to read\&. -.sp -.nf -\f3\-taglet com\&.sun\&.tools\&.doclets\&.ToDoTaglet\fP -.fi -.nf -\f3\-tagletpath /home/taglets \fP -.fi -.nf -\f3\-tag return\fP -.fi -.nf -\f3\-tag param\fP -.fi -.nf -\f3\-tag todo\fP -.fi -.nf -\f3\-tag throws\fP -.fi -.nf -\f3\-tag see\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --tagletpath \fItagletpathlist\fR -.br -Specifies the search paths for finding taglet class files\&. The \f3tagletpathlist\fR can contain multiple paths by separating them with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. -.TP --docfilesubdirs -.br -Enables deep copying of doc-files directories\&. Subdirectories and all contents are recursively copied to the destination\&. For example, the directory doc-files/example/images and all of its contents would be copied\&. There is also an option to exclude subdirectories\&. -.TP --excludedocfilessubdir \fIname1:name2\fR -.br -Excludes any doc-files subdirectories with the specified names\&. This prevents the copying of SCCS and other source-code-control subdirectories\&. -.TP --noqualifier all | \fIpackagename1\fR:\fIpackagename2\&.\&.\&.\fR -.br -Omits qualifying package names from class names in output\&. The argument to the \f3-noqualifier\fR option is either \f3all\fR (all package qualifiers are omitted) or a colon-separate list of packages, with wild cards, to be removed as qualifiers\&. The package name is removed from places where class or interface names appear\&. See Process Source Files\&. - -The following example omits all package qualifiers: \f3-noqualifier all\fR\&. - -The following example omits \f3java\&.lang\fR and \f3java\&.io\fR package qualifiers: \f3-noqualifier java\&.lang:java\&.io\fR\&. - -The following example omits package qualifiers starting with \f3java\fR, and \f3com\&.sun\fR subpackages, but not \f3javax\fR: \f3-noqualifier java\&.*:com\&.sun\&.*\fR\&. - -Where a package qualifier would appear due to the previous behavior, the name can be suitably shortened\&. See How a Name Appears\&. This rule is in effect whether or not the \f3-noqualifier\fR option is used\&. -.TP --notimestamp -.br -Suppresses the time stamp, which is hidden in an HTML comment in the generated HTML near the top of each page\&. The \f3-notimestamp\fR option is useful when you want to run the \f3javadoc\fR command on two source bases and get the differences between \f3diff\fR them, because it prevents time stamps from causing a \f3diff\fR (which would otherwise be a \f3diff\fR on every page)\&. The time stamp includes the \f3javadoc\fR command release number, and currently appears similar to this: \f3<!-- Generated by javadoc (build 1\&.5\&.0_01) on Thu Apr 02 14:04:52 IST 2009 -->\fR\&. -.TP --nocomment -.br -Suppresses the entire comment body, including the main description and all tags, and generate only declarations\&. This option lets you reuse source files that were originally intended for a different purpose so that you can produce skeleton HTML documentation at the early stages of a new project\&. -.TP --sourcetab \fItablength\fR -.br -Specifies the number of spaces each tab uses in the source\&. -.SH COMMAND-LINE\ ARGUMENT\ FILES -To shorten or simplify the \f3javadoc\fR command, you can specify one or more files that contain arguments to the \f3javadoc\fR command (except \f3-J\fR options)\&. This enables you to create \f3javadoc\fR commands of any length on any operating system\&. -.PP -An argument file can include \f3javac\fR options and source file names in any combination\&. The arguments within a file can be space-separated or newline-separated\&. If a file name contains embedded spaces, then put the whole file name in double quotation marks\&. -.PP -File Names within an argument file are relative to the current directory, not the location of the argument file\&. Wild cards (\f3*\fR) are not allowed in these lists (such as for specifying *\&.java)\&. Using the at sign (@) to recursively interpret files is not supported\&. The \f3-J\fR options are not supported because they are passed to the launcher, which does not support argument files\&. -.PP -When you run the \f3javadoc\fR command, pass in the path and name of each argument file with the @ leading character\&. When the \f3javadoc\fR command encounters an argument beginning with the at sign (@), it expands the contents of that file into the argument list\&. -.PP -\f3Example 1 Single Argument File\fR -.PP -You could use a single argument file named \f3argfile\fR to hold all \f3javadoc\fR command arguments: \f3javadoc @argfile\fR\&. The argument file \f3\fRcontains the contents of both files, as shown in the next example\&. -.PP -\f3Example 2 Two Argument Files\fR -.PP -You can create two argument files: One for the \f3javadoc\fR command options and the other for the package names or source file names\&. Notice the following lists have no line-continuation characters\&. -.PP -Create a file named options that contains: -.sp -.nf -\f3\-d docs\-filelist \fP -.fi -.nf -\f3\-use \fP -.fi -.nf -\f3\-splitindex\fP -.fi -.nf -\f3\-windowtitle \&'Java SE 7 API Specification\&'\fP -.fi -.nf -\f3\-doctitle \&'Java SE 7 API Specification\&'\fP -.fi -.nf -\f3\-header \&'<b>Java\(tm SE 7</b>\&'\fP -.fi -.nf -\f3\-bottom \&'Copyright © 1993\-2011 Oracle and/or its affiliates\&. All rights reserved\&.\&'\fP -.fi -.nf -\f3\-group "Core Packages" "java\&.*"\fP -.fi -.nf -\f3\-overview /java/pubs/ws/1\&.7\&.0/src/share/classes/overview\-core\&.html\fP -.fi -.nf -\f3\-sourcepath /java/pubs/ws/1\&.7\&.0/src/share/classes\fP -.fi -.nf -\f3\fP -.fi -.sp -Create a file named packages that contains: -.sp -.nf -\f3com\&.mypackage1\fP -.fi -.nf -\f3com\&.mypackage2\fP -.fi -.nf -\f3com\&.mypackage3\fP -.fi -.nf -\f3\fP -.fi -.sp -Run the \f3javadoc\fR command as follows: -.sp -.nf -\f3javadoc @options @packages\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 3 Argument Files with Paths\fR -.PP -The argument files can have paths, but any file names inside the files are relative to the current working directory (not \f3path1\fR or \f3path2\fR): -.sp -.nf -\f3javadoc @path1/options @path2/packages\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 4 Option Arguments\fR -.PP -The following example saves an argument to a \f3javadoc\fR command option in an argument file\&. The \f3-bottom\fR option is used because it can have a lengthy argument\&. You could create a file named bottom to contain the text argument: -.sp -.nf -\f3<font size="\-1">\fP -.fi -.nf -\f3 <a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP -.fi -.nf -\f3 Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&. <br/>\fP -.fi -.nf -\f3 Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP -.fi -.nf -\f3 Other names may be trademarks of their respective owners\&.</font>\fP -.fi -.nf -\f3\fP -.fi -.sp -Run the \f3javadoc\fR command as follows:\f3javadoc -bottom @bottom @packages\fR\&. -.PP -You can also include the \f3-bottom\fR option at the start of the argument file and run the \f3javadoc\fR command as follows: \f3javadoc @bottom @packages\fR\&. -.SH RUNNING\ THE\ JAVADOC\ COMMAND -The release number of the \f3javadoc\fR command can be determined with the \f3javadoc -J-version\fR option\&. The release number of the standard doclet appears in the output stream\&. It can be turned off with the \f3-quiet\fR option\&. -.PP -Use the public programmatic interface to call the \f3javadoc\fR command from within programs written in the Java language\&. This interface is in \f3com\&.sun\&.tools\&.javadoc\&.Main\fR (and the \f3javadoc\fR command is reentrant)\&. For more information, see The Standard Doclet at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/standard-doclet\&.html#runningprogrammatically -.PP -The following instructions call the standard HTML doclet\&. To call a custom doclet, use the \f3-doclet\fR and \f3-docletpath\fR options\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html -.SS SIMPLE\ EXAMPLES -You can run the \f3javadoc\fR command on entire packages or individual source files\&. Each package name has a corresponding directory name\&. -.PP -In the following examples, the source files are located at /home/src/java/awt/*\&.java\&. The destination directory is /home/html\&. -.PP -Document One or More Packages - -To document a package, the source files for that package must be located in a directory that has the same name as the package\&. -.PP -If a package name has several identifiers (separated by dots, such as \f3java\&.awt\&.color\fR), then each subsequent identifier must correspond to a deeper subdirectory (such as java/awt/color)\&. -.PP -You can split the source files for a single package among two such directory trees located at different places, as long as \f3-sourcepath\fR points to them both\&. For example, src1/java/awt/color and src2/java/awt/color\&. -.PP -You can run the \f3javadoc\fR command either by changing directories (with the \f3cd\fR command) or by using the \f3-sourcepath\fR option\&. The following examples illustrate both alternatives\&. -.PP -\f3Example 1 Recursive Run from One or More Packages\fR -.PP -This example uses \f3-sourcepath\fR so the \f3javadoc\fR command can be run from any directory and \f3-subpackages\fR (a new 1\&.4 option) for recursion\&. It traverses the subpackages of the java directory excluding packages rooted at \f3java\&.net\fR and \f3java\&.lang\fR\&. Notice this excludes \f3java\&.lang\&.ref\fR, a subpackage of \f3java\&.lang\fR\&. To also traverse down other package trees, append their names to the \f3-subpackages\fR argument, such as \f3java:javax:org\&.xml\&.sax\fR\&. -.sp -.nf -\f3javadoc \-d /home/html \-sourcepath /home/src \-subpackages java \-exclude\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 2 Change to Root and Run Explicit Packages\fR -.PP -Change to the parent directory of the fully qualified package\&. Then, run the \f3javadoc\fR command with the names of one or more packages that you want to document: -.sp -.nf -\f3cd /home/src/\fP -.fi -.nf -\f3javadoc \-d /home/html java\&.awt java\&.awt\&.event\fP -.fi -.nf -\f3\fP -.fi -.sp -To also traverse down other package trees, append their names to the \f3-subpackages\fR argument, such as j\f3ava:javax:org\&.xml\&.sax\fR\&. -.PP -\f3Example 3 Run from Any Directory on Explicit Packages in One Tree\fR -.PP -In this case, it does not matter what the current directory is\&. Run the \f3javadoc\fR command and use the \f3-sourcepath\fR option with the parent directory of the top-level package\&. Provide the names of one or more packages that you want to document: -.sp -.nf -\f3javadoc \-d /home/html \-sourcepath /home/src java\&.awt java\&.awt\&.event\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 4 Run from Any Directory on Explicit Packages in Multiple Trees\fR -.PP -Run the \f3javadoc\fR command and use the \f3-sourcepath\fR option with a colon-separated list of the paths to each tree\&'s root\&. Provide the names of one or more packages that you want to document\&. All source files for a specified package do not need to be located under a single root directory, but they must be found somewhere along the source path\&. -.sp -.nf -\f3javadoc \-d /home/html \-sourcepath /home/src1:/home/src2 java\&.awt java\&.awt\&.event\fP -.fi -.nf -\f3\fP -.fi -.sp -The result is that all cases generate HTML-formatted documentation for the \f3public\fR and \f3protected\fR classes and interfaces in packages j\f3ava\&.awt\fR and \f3java\&.awt\&.even\fRt and save the HTML files in the specified destination directory\&. Because two or more packages are being generated, the document has three HTML frames: one for the list of packages, another for the list of classes, and the third for the main class pages\&. -.PP -Document One or More Classes - -The second way to run the \f3javadoc\fR command is to pass one or more source files\&. You can run \f3javadoc\fR either of the following two ways: by changing directories (with the \f3cd\fR command) or by fully specifying the path to the source files\&. Relative paths are relative to the current directory\&. The \f3-sourcepath\fR option is ignored when passing source files\&. You can use command-line wild cards, such as an asterisk (*), to specify groups of classes\&. -.PP -\f3Example 1 Change to the Source Directory\fR -.PP -Change to the directory that holds the source files\&. Then run the \f3javadoc\fR command with the names of one or more source files you want to document\&. -.PP -This example generates HTML-formatted documentation for the classes \f3Button\fR, \f3Canvas,\fR and classes that begin with \f3Graphics\fR\&. Because source files rather than package names were passed in as arguments to the \f3javadoc\fR command, the document has two frames: one for the list of classes and the other for the main page\&. -.sp -.nf -\f3cd /home/src/java/awt\fP -.fi -.nf -\f3javadoc \-d /home/html Button\&.java Canvas\&.java Graphics*\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 2 Change to the Root Directory of the Package\fR -.PP -This is useful for documenting individual source files from different subpackages off of the same root\&. Change to the package root directory, and supply the source files with paths from the root\&. -.sp -.nf -\f3cd /home/src/\fP -.fi -.nf -\f3javadoc \-d /home/html java/awt/Button\&.java java/applet/Applet\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 3 Document Files from Any Directory\fR -.PP -In this case, it does not matter what the current directory is\&. Run the \f3javadoc\fR command with the absolute path (or path relative to the current directory) to the source files you want to document\&. -.sp -.nf -\f3javadoc \-d /home/html /home/src/java/awt/Button\&.java\fP -.fi -.nf -\f3/home/src/java/awt/Graphics*\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Document Packages and Classes - -You can document entire packages and individual classes at the same time\&. Here is an example that mixes two of the previous examples\&. You can use the \f3-sourcepath\fR option for the path to the packages but not for the path to the individual classes\&. -.sp -.nf -\f3javadoc \-d /home/html \-sourcepath /home/src java\&.awt\fP -.fi -.nf -\f3/home/src/java/applet/Applet\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS REAL-WORLD\ EXAMPLES -The following command-line and \f3makefile\fR versions of the \f3javadoc\fR command run on the Java platform APIs\&. It uses 180 MB of memory to generate the documentation for the 1500 (approximately) public and protected classes in the Java SE 1\&.2\&. Both examples use absolute paths in the option arguments, so that the same \f3javadoc\fR command can be run from any directory\&. -.PP -Command-Line Example - -The following command might be too long for some shells\&. You can use a command-line argument file (or write a shell script) to overcome this limitation\&. -.PP -In the example, \f3packages\fR is the name of a file that contains the packages to process, such as \f3java\&.applet\fR\f3java\&.lang\fR\&. None of the options should contain any newline characters between the single quotation marks\&. For example, if you copy and paste this example, then delete the newline characters from the \f3-bottom\fR option\&. -.sp -.nf -\f3javadoc \-sourcepath /java/jdk/src/share/classes \e\fP -.fi -.nf -\f3\-overview /java/jdk/src/share/classes/overview\&.html \e\fP -.fi -.nf -\f3\-d /java/jdk/build/api \e\fP -.fi -.nf -\f3\-use \e\fP -.fi -.nf -\f3\-splitIndex \e\fP -.fi -.nf -\f3\-windowtitle \&'Java Platform, Standard Edition 7 API Specification\&' \e\fP -.fi -.nf -\f3\-doctitle \&'Java Platform, Standard Edition 7 API Specification\&' \e\fP -.fi -.nf -\f3\-header \&'<b>Java\(tm SE 7</b>\&' \e\fP -.fi -.nf -\f3\-bottom \&'<font size="\-1">\fP -.fi -.nf -\f3<a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP -.fi -.nf -\f3Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&.<br/>\fP -.fi -.nf -\f3Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP -.fi -.nf -\f3Other names may be trademarks of their respective owners\&.</font>\&' \e\fP -.fi -.nf -\f3\-group "Core Packages" "java\&.*:com\&.sun\&.java\&.*:org\&.omg\&.*" \e\fP -.fi -.nf -\f3\-group "Extension Packages" "javax\&.*" \e\fP -.fi -.nf -\f3\-J\-Xmx180m \e \fP -.fi -.nf -\f3@packages\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Programmatic Interface - -The Javadoc Access API enables the user to invoke the Javadoc tool directly from a Java application without executing a new process\&. -.PP -For example, the following statements are equivalent to the command \f3javadoc -d /home/html -sourcepath /home/src -subpackages java -exclude java\&.net:java\&.lang com\&.example\fR: -.sp -.nf -\f3import javax\&.tools\&.DocumentationTool;\fP -.fi -.nf -\f3import javax\&.tools\&.ToolProvider;\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3public class JavaAccessSample{\fP -.fi -.nf -\f3 public static void main(String[] args){\fP -.fi -.nf -\f3 DocumentationTool javadoc = ToolProvider\&.getSystemDocumentationTool();\fP -.fi -.nf -\f3 int rc = javadoc\&.run( null, null, null,\fP -.fi -.nf -\f3 "\-d", "/home/html",\fP -.fi -.nf -\f3 "\-sourcepath", "home/src",\fP -.fi -.nf -\f3 "\-subpackages", "java",\fP -.fi -.nf -\f3 "\-exclude", "java\&.net:java\&.lang",\fP -.fi -.nf -\f3 "com\&.example");\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3\fP -.fi -.sp -The first three arguments of the \f3run\fR method specify input, standard output, and standard error streams\&. \f3Null\fR is the default value for \f3System\&.in\fR, \f3System\&.out\fR, and \f3System\&.err\fR, respectively\&. -.SS THE\ MAKEFILE\ EXAMPLE -This is an example of a GNU \f3makefile\fR\&. Single quotation marks surround \f3makefile\fR arguments\&. For an example of a Windows \f3makefile\fR, see the \f3makefiles\fR section of the Javadoc FAQ at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137483\&.html#makefiles -.sp -.nf -\f3javadoc \-sourcepath $(SRCDIR) \e /* Sets path for source files */\fP -.fi -.nf -\f3 \-overview $(SRCDIR)/overview\&.html \e /* Sets file for overview text */\fP -.fi -.nf -\f3 \-d /java/jdk/build/api \e /* Sets destination directory */\fP -.fi -.nf -\f3 \-use \e /* Adds "Use" files */\fP -.fi -.nf -\f3 \-splitIndex \e /* Splits index A\-Z */\fP -.fi -.nf -\f3 \-windowtitle $(WINDOWTITLE) \e /* Adds a window title */\fP -.fi -.nf -\f3 \-doctitle $(DOCTITLE) \e /* Adds a doc title */\fP -.fi -.nf -\f3 \-header $(HEADER) \e /* Adds running header text */\fP -.fi -.nf -\f3 \-bottom $(BOTTOM) \e /* Adds text at bottom */\fP -.fi -.nf -\f3 \-group $(GROUPCORE) \e /* 1st subhead on overview page */\fP -.fi -.nf -\f3 \-group $(GROUPEXT) \e /* 2nd subhead on overview page */\fP -.fi -.nf -\f3 \-J\-Xmx180m \e /* Sets memory to 180MB */\fP -.fi -.nf -\f3 java\&.lang java\&.lang\&.reflect \e /* Sets packages to document */\fP -.fi -.nf -\f3 java\&.util java\&.io java\&.net \e\fP -.fi -.nf -\f3 java\&.applet\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3WINDOWTITLE = \&'Java\(tm SE 7 API Specification\&'\fP -.fi -.nf -\f3DOCTITLE = \&'Java\(tm Platform Standard Edition 7 API Specification\&'\fP -.fi -.nf -\f3HEADER = \&'<b>Java\(tm SE 7</font>\&'\fP -.fi -.nf -\f3BOTTOM = \&'<font size="\-1">\fP -.fi -.nf -\f3 <a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP -.fi -.nf -\f3 Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&.<br/>\fP -.fi -.nf -\f3 Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP -.fi -.nf -\f3 Other names may be trademarks of their respective owners\&.</font>\&'\fP -.fi -.nf -\f3GROUPCORE = \&'"Core Packages" "java\&.*:com\&.sun\&.java\&.*:org\&.omg\&.*"\&'\fP -.fi -.nf -\f3GROUPEXT = \&'"Extension Packages" "javax\&.*"\&'\fP -.fi -.nf -\f3SRCDIR = \&'/java/jdk/1\&.7\&.0/src/share/classes\&'\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS NOTES -.TP 0.2i -\(bu -If you omit the \f3-windowtitle\fR option, then the \f3javadoc\fR command copies the document title to the window title\&. The \f3-windowtitle\fR option text is similar to the the \f3-doctitle\fR option, but without HTML tags to prevent those tags from appearing as raw text in the window title\&. -.TP 0.2i -\(bu -If you omit the \f3-footer\fR option, then the \f3javadoc\fR command copies the header text to the footer\&. -.TP 0.2i -\(bu -Other important options you might want to use, but were not needed in the previous example, are the \f3-classpath\fR and \f3-link\fR options\&. -.SH GENERAL\ TROUBLESHOOTING -.TP 0.2i -\(bu -The \f3javadoc\fR command reads only files that contain valid class names\&. If the \f3javadoc\fR command is not correctly reading the contents of a file, then verify that the class names are valid\&. See Process Source Files\&. -.TP 0.2i -\(bu -See the Javadoc FAQ for information about common bugs and for troubleshooting tips at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137483\&.html -.SH ERRORS\ AND\ WARNINGS -Error and warning messages contain the file name and line number to the declaration line rather than to the particular line in the documentation comment\&. -.PP -For example, this message \f3error: cannot read: Class1\&.java\fR means that the \f3javadoc\fR command is trying to load \f3Class1\&.jav\fR\f3a\fR in the current directory\&. The class name is shown with its path (absolute or relative)\&. -.SH ENVIRONMENT -.TP -CLASSPATH -\f3CLASSPATH\fR is the environment variable that provides the path that the \f3javadoc\fR command uses to find user class files\&. This environment variable is overridden by the \f3-classpath\fR option\&. Separate directories with a semicolon for Windows or a colon for Oracle Solaris\&. - -\fIWindows example\fR: \f3\&.;C:\eclasses;C:\ehome\ejava\eclasses\fR - -\fIOracle Solaris example\fR: \f3\&.:/home/classes:/usr/local/java/classes\fR\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -javac(1) -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -jdb(1) -.TP 0.2i -\(bu -javah(1) -.TP 0.2i -\(bu -javap(1) -.SH RELATED\ DOCUMENTS -.TP 0.2i -\(bu -Javadoc Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/index\&.html -.TP 0.2i -\(bu -How Classes Are Found http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html -.TP 0.2i -\(bu -How to Write Doc Comments for the Javadoc Tool http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html -.TP 0.2i -\(bu -URL Memo, Uniform Resource Locators http://www\&.ietf\&.org/rfc/rfc1738\&.txt -.TP 0.2i -\(bu -HTML standard, HTML Document Representation (4197265 and 4137321) http://www\&.w3\&.org/TR/REC-html40/charset\&.html#h-5\&.2\&.2 -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1994, 2015, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 03 March 2015 +.\" SectDesc: Basic Tools +.\" Title: javadoc.1 +.\" +.if n .pl 99999 +.TH javadoc 1 "03 March 2015" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +javadoc \- Generates HTML pages of API documentation from Java source files\&. +.SH SYNOPSIS +.sp +.nf + +\fBjavadoc\fR {\fIpackages\fR|\fIsource\-files\fR} [\fIoptions\fR] [\fI@argfiles\fR] +.fi +.sp +.TP +\fIpackages\fR +Names of packages that you want to document, separated by spaces, for example \f3java\&.lang java\&.lang\&.reflect java\&.awt\fR\&. If you want to also document the subpackages, use the \f3-subpackages\fR option to specify the packages\&. + +By default, \f3javadoc\fR looks for the specified packages in the current directory and subdirectories\&. Use the \f3-sourcepath\fR option to specify the list of directories where to look for packages\&. +.TP +\fIsource-files\fR +Names of Java source files that you want to document, separated by spaces, for example \f3Class\&.java Object\&.java Button\&.java\fR\&. By default, \f3javadoc\fR looks for the specified classes in the current directory\&. However, you can specify the full path to the class file and use wildcard characters, for example \f3/home/src/java/awt/Graphics*\&.java\fR\&. You can also specify the path relative to the current directory\&. +.TP +\fIoptions\fR +Command-line options, separated by spaces\&. See Options\&. +.TP +\fI@argfiles\fR +Names of files that contain a list of \f3javadoc\fR command options, package names and source file names in any order\&. +.SH DESCRIPTION +The \f3javadoc\fR command parses the declarations and documentation comments in a set of Java source files and produces a corresponding set of HTML pages that describe (by default) the public and protected classes, nested classes (but not anonymous inner classes), interfaces, constructors, methods, and fields\&. You can use the \f3javadoc\fR command to generate the API documentation or the implementation documentation for a set of source files\&. +.PP +You can run the \f3javadoc\fR command on entire packages, individual source files, or both\&. When documenting entire packages, you can either use the \f3-subpackages\fR option to recursively traverse a directory and its subdirectories, or to pass in an explicit list of package names\&. When you document individual source files, pass in a list of Java source file names\&. See Simple Examples\&. +.SS PROCESS\ SOURCE\ FILES +The \f3javadoc\fR command processes files that end in source and other files described in Source Files\&. If you run the \f3javadoc\fR command by passing in individual source file names, then you can determine exactly which source files are processed\&. However, that is not how most developers want to work, because it is simpler to pass in package names\&. The \f3javadoc\fR command can be run three ways without explicitly specifying the source file names\&. You can pass in package names, use the \f3-subpackages\fR option, or use wild cards with source file names\&. In these cases, the \f3javadoc\fR command processes a source file only when the file fulfills all of the following requirements: +.TP 0.2i +\(bu +The file name prefix (with \f3\&.java\fR removed) is a valid class name\&. +.TP 0.2i +\(bu +The path name relative to the root of the source tree is a valid package name after the separators are converted to dots\&. +.TP 0.2i +\(bu +The package statement contains the valid package name\&. +.PP +Processing Links + +During a run, the \f3javadoc\fR command adds cross-reference links to package, class, and member names that are being documented as part of that run\&. Links appear in the following places\&. See Javadoc Tags for a description of the @ tags\&. +.TP 0.2i +\(bu +Declarations (return types, argument types, and field types)\&. +.TP 0.2i +\(bu +\fISee Also\fR sections that are generated from \f3@see\fR tags\&. +.TP 0.2i +\(bu +Inline text generated from \f3{@link}\fR tags\&. +.TP 0.2i +\(bu +Exception names generated from \f3@throws\fR tags\&. +.TP 0.2i +\(bu +\fISpecified by\fR links to interface members and \fIOverrides\fR links to class members\&. See Method Comment Inheritance\&. +.TP 0.2i +\(bu +Summary tables listing packages, classes and members\&. +.TP 0.2i +\(bu +Package and class inheritance trees\&. +.TP 0.2i +\(bu +The index\&. +.PP +You can add links to existing text for classes not included on the command line (but generated separately) by way of the \f3-link\fR and \f3-linkoffline\fR options\&. +.PP +Processing Details + +The \f3javadoc\fR command produces one complete document every time it runs\&. It does not do incremental builds that modify or directly incorporate the results from earlier runs\&. However, the \f3javadoc\fR command can link to results from other runs\&. +.PP +The \f3javadoc\fR command implementation requires and relies on the Java compiler\&. The \f3javadoc\fR command calls part of the \f3javac\fR command to compile the declarations and ignore the member implementations\&. The \f3javadoc\fR command builds a rich internal representation of the classes that includes the class hierarchy and use relationships to generate the HTML\&. The \f3javadoc\fR command also picks up user-supplied documentation from documentation comments in the source code\&. See Documentation Comments\&. +.PP +The \f3javadoc\fR command runs on source files that are pure stub files with no method bodies\&. This means you can write documentation comments and run the \f3javadoc\fR command in the early stages of design before API implementation\&. +.PP +Relying on the compiler ensures that the HTML output corresponds exactly with the actual implementation, which may rely on implicit, rather than explicit, source code\&. For example, the \f3javadoc\fR command documents default constructors that are present in the compiled class files but not in the source code\&. +.PP +In many cases, the \f3javadoc\fR command lets you generate documentation for source files with incomplete or erroneous code\&. You can generate documentation before all debugging and troubleshooting is done\&. The \f3javadoc\fR command does primitive checking of documentation comments\&. +.PP +When the \f3javadoc\fR command builds its internal structure for the documentation, it loads all referenced classes\&. Because of this, the \f3javadoc\fR command must be able to find all referenced classes, whether bootstrap classes, extensions, or user classes\&. See How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html +.PP +Typically, classes you create must either be loaded as an extension or in the \f3javadoc\fR command class path\&. +.SS JAVADOC\ DOCLETS +You can customize the content and format of the \f3javadoc\fR command output with doclets\&. The \f3javadoc\fR command has a default built-in doclet, called the standard doclet, that generates HTML-formatted API documentation\&. You can modify or make a subclass of the standard doclet, or write your own doclet to generate HTML, XML, MIF, RTF or whatever output format you want\&. +.PP +When a custom doclet is not specified with the \f3-doclet\fR option, the \f3javadoc\fR command uses the default standard doclet\&. The \f3javadoc\fR command has several options that are available regardless of which doclet is being used\&. The standard doclet adds a supplementary set of command-line options\&. See Options\&. +.SH SOURCE\ FILES +The \f3javadoc\fR command generates output that originates from the following types of source files: Java language source files for classes (\f3\&.java\fR), package comment files, overview comment files, and miscellaneous unprocessed files\&. This section also describes test files and template files that can also be in the source tree, but that you want to be sure not to document\&. +.SS CLASS\ SOURCE\ FILES +Each class or interface and its members can have their own documentation comments contained in a source file\&. See Documentation Comments\&. +.SS PACKAGE\ COMMENT\ FILES +Each package can have its own documentation comment, contained in its own source file, that the \f3javadoc\fR command merges into the generated package summary page\&. You typically include in this comment any documentation that applies to the entire package\&. +.PP +To create a package comment file, you can place your comments in one of the following files: +.TP 0.2i +\(bu +The \f3package-info\&.java\fR file can contain the package declaration, package annotations, package comments, and Javadoc tags\&. This file is preferred\&. +.TP 0.2i +\(bu +The \f3package\&.html\fR file contains only package comments and Javadoc tags\&. No package annotations\&. +.PP +A package can have a single \f3package\&.html\fR file or a single \f3package-info\&.java\fR file, but not both\&. Place either file in the package directory in the source tree with your source files\&. +.PP +The package-info\&.java File + +The \f3package-info\&.java\fR file can contain a package comment of the following structure\&. The comment is placed before the package declaration\&. +.PP +\fINote:\fR The comment separators \f3/**\fR and \f3*/\fR must be present, but the leading asterisks on the intermediate lines can be left off\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * Provides the classes necessary to create an \fP +.fi +.nf +\f3 * applet and the classes an applet uses \fP +.fi +.nf +\f3 * to communicate with its applet context\&.\fP +.fi +.nf +\f3 * <p>\fP +.fi +.nf +\f3 * The applet framework involves two entities:\fP +.fi +.nf +\f3 * the applet and the applet context\&.\fP +.fi +.nf +\f3 * An applet is an embeddable window (see the\fP +.fi +.nf +\f3 * {@link java\&.awt\&.Panel} class) with a few extra\fP +.fi +.nf +\f3 * methods that the applet context can use to \fP +.fi +.nf +\f3 * initialize, start, and stop the applet\&.\fP +.fi +.nf +\f3 *\fP +.fi +.nf +\f3 * @since 1\&.0\fP +.fi +.nf +\f3 * @see java\&.awt\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3package java\&.lang\&.applet;\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +The package\&.html File + +The \f3package\&.html\fR file can contain a package comment of the following structure\&. The comment is placed in the \f3<body>\fR element\&. +.PP +File: \f3java/applet/package\&.html\fR +.sp +.nf +\f3<HTML>\fP +.fi +.nf +\f3<BODY>\fP +.fi +.nf +\f3Provides the classes necessary to create an applet and the \fP +.fi +.nf +\f3classes an applet uses to communicate with its applet context\&.\fP +.fi +.nf +\f3<p>\fP +.fi +.nf +\f3The applet framework involves two entities: the applet\fP +.fi +.nf +\f3and the applet context\&. An applet is an embeddable\fP +.fi +.nf +\f3window (see the {@link java\&.awt\&.Panel} class) with a\fP +.fi +.nf +\f3few extra methods that the applet context can use to\fP +.fi +.nf +\f3initialize, start, and stop the applet\&. \fP +.fi +.nf +\f3\fP +.fi +.nf +\f3@since 1\&.0 \fP +.fi +.nf +\f3@see java\&.awt\fP +.fi +.nf +\f3</BODY>\fP +.fi +.nf +\f3</HTML>\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3package\&.html\fR file is a typical HTML file and does not include a package declaration\&. The content of the package comment file is written in HTML with one exception\&. The documentation comment should not include the comment separators \f3/**\fR and \f3*/\fR or leading asterisks\&. When writing the comment, make the first sentence a summary about the package, and do not put a title or any other text between the \f3<body>\fR tag and the first sentence\&. You can include package tags\&. All block tags must appear after the main description\&. If you add an \f3@see\fR tag in a package comment file, then it must have a fully qualified name\&. +.PP +Processing the Comment File + +When the \f3javadoc\fR command runs, it searches for the package comment file\&. If the package comment file is found, then the \f3javadoc\fR command does the following: +.TP 0.2i +\(bu +Copies the comment for processing\&. For package\&.html, the \f3javadoc\fR command copies all content between the \f3<body>\fR and \f3</body>\fR HTML tags\&. You can include a \f3<head>\fR section to put a \f3<title>\fR tag, source file copyright statement, or other information, but none of these appear in the generated documentation\&. +.TP 0.2i +\(bu +Processes the package tags\&. See Package Tags\&. +.TP 0.2i +\(bu +Inserts the processed text at the bottom of the generated package summary page\&. See Java Platform, Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html +.TP 0.2i +\(bu +Copies the first sentence of the package comment to the top of the package summary page\&. The \f3javadoc\fR command also adds the package name and this first sentence to the list of packages on the overview page\&. See Java Platform, Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html + +The end of the sentence is determined by the same rules used for the end of the first sentence of class and member main descriptions\&. +.SS OVERVIEW\ COMMENT\ FILES +Each application or set of packages that you are documenting can have its own overview documentation comment that is kept in its own source file, that the \f3javadoc\fR command merges into the generated overview page\&. You typically include in this comment any documentation that applies to the entire application or set of packages\&. +.PP +You can name the file anything you want such as overview\&.html and place it anywhere\&. A typical location is at the top of the source tree\&. +.PP +For example, if the source files for the \f3java\&.applet\fR package are contained in the /home/user/src/java/applet directory, then you could create an overview comment file at /home/user/src/overview\&.html\&. +.PP +You can have multiple overview comment files for the same set of source files in case you want to run the \f3javadoc\fR command multiple times on different sets of packages\&. For example, you could run the \f3javadoc\fR command once with \f3-private\fR for internal documentation and again without that option for public documentation\&. In this case, you could describe the documentation as public or internal in the first sentence of each overview comment file\&. +.PP +The content of the overview comment file is one big documentation comment that is written in HTML\&. Make the first sentence a summary about the application or set of packages\&. Do not put a title or any other text between the \f3<body>\fR tag and the first sentence\&. All tags except inline tags, such as an {\f3@link}\fR tag, must appear after the main description\&. If you add an \f3@see\fR tag, then it must have a fully qualified name\&. +.PP +When you run the \f3javadoc\fR command, specify the overview comment file name with the \f3-overview\fR option\&. The file is then processed similarly to that of a package comment file\&. The \f3javadoc\fR command does the following: +.TP 0.2i +\(bu +Copies all content between the \f3<body>\fR and \f3</body>\fR tags for processing\&. +.TP 0.2i +\(bu +Processes the overview tags that are present\&. See Overview Tags\&. +.TP 0.2i +\(bu +Inserts the processed text at the bottom of the generated overview page\&. See Java Platform Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html +.TP 0.2i +\(bu +Copies the first sentence of the overview comment to the top of the overview summary page\&. +.SS UNPROCESSED\ FILES +Your source files can include any files that you want the \f3javadoc\fR command to copy to the destination directory\&. These files usually include graphic files, example Java source and class files, and self-standing HTML files with a lot of content that would overwhelm the documentation comment of a typical Java source file\&. +.PP +To include unprocessed files, put them in a directory called doc-files\&. The doc-files directory can be a subdirectory of any package directory that contains source files\&. You can have one doc-files subdirectory for each package\&. +.PP +For example, if you want to include the image of a button in the \f3java\&.awt\&.Button\fR class documentation, then place the image file in the /home/user/src/java/awt/doc-files/ directory\&. Do not place the doc-files directory at /home/user/src/java/doc-files, because java is not a package\&. It does not contain any source files\&. +.PP +All links to the unprocessed files must be included in the code because the \f3javadoc\fR command does not look at the files\&. The \f3javadoc\fR command copies the directory and all of its contents to the destination\&. The following example shows how the link in the Button\&.java documentation comment might look: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This button looks like this: \fP +.fi +.nf +\f3 * <img src="doc\-files/Button\&.gif">\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS TEST\ AND\ TEMPLATE\ FILES +You can store test and template files in the source tree in the same directory with or in a subdirectory of the directory where the source files reside\&. To prevent test and template files from being processed, run the \f3javadoc\fR command and explicitly pass in individual source file names\&. +.PP +Test files are valid, compilable source files\&. Template files are not valid, compatible source files, but they often have the \f3\&.java\fR suffix\&. +.PP +Test Files + +If you want your test files to belong to either an unnamed package or to a package other than the package that the source files are in, then put the test files in a subdirectory underneath the source files and give the directory an invalid name\&. If you put the test files in the same directory with the source and call the \f3javadoc\fR command with a command-line argument that indicates its package name, then the test files cause warnings or errors\&. If the files are in a subdirectory with an invalid name, then the test file directory is skipped and no errors or warnings are issued\&. For example, to add test files for source files in com\&.package1, put them in a subdirectory in an invalid package name\&. The following directory name is invalid because it contains a hyphen: +.sp +.nf +\f3com/package1/test\-files/\fP +.fi +.nf +\f3\fP +.fi +.sp +If your test files contain documentation comments, then you can set up a separate run of the \f3javadoc\fR command to produce test file documentation by passing in their test source file names with wild cards, such as \f3com/package1/test-files/*\&.java\fR\&. +.PP +Template Files + +If you want a template file to be in the source directory, but not generate errors when you execute the \f3javadoc\fR command, then give it an invalid file name such as \f3Buffer-Template\&.java\fR to prevent it from being processed\&. The \f3javadoc\fR command only processes source files with names, when stripped of the \f3\&.java\fR suffix, that are valid class names\&. +.SH GENERATED\ FILES +By default, the \f3javadoc\fR command uses a standard doclet that generates HTML-formatted documentation\&. The standard doclet generates basic content, cross-reference, and support pages described here\&. Each HTML page corresponds to a separate file\&. The \f3javadoc\fR command generates two types of files\&. The first type is named after classes and interfaces\&. The second type contain hyphens (such as package-summary\&.html) to prevent conflicts with the first type of file\&. +.SS BASIC\ CONTENT\ PAGES +.TP 0.2i +\(bu +One class or interface page (classname\&.html) for each class or interface being documented\&. +.TP 0.2i +\(bu +One package page (package-summary\&.html) for each package being documented\&. The \f3javadoc\fR command includes any HTML text provided in a file with the name package\&.html or package-info\&.java in the package directory of the source tree\&. +.TP 0.2i +\(bu +One overview page (overview-summary\&.html) for the entire set of packages\&. The overview page is the front page of the generated document\&. The \f3javadoc\fR command includes any HTML text provided in a file specified by the \f3-overview\fR option\&. The Overview page is created only when you pass two or more package names into the \f3javadoc\fR command\&. See HTML Frames and Options\&. +.SS CROSS-REFERENCE\ PAGES +.TP 0.2i +\(bu +One class hierarchy page for the entire set of packages (overview-tree\&.html)\&. To view the hierarchy page, click \fIOverview\fR in the navigation bar and click \fITree\fR\&. +.TP 0.2i +\(bu +One class hierarchy page for each package (package-tree\&.html) To view the hierarchy page, go to a particular package, class, or interface page, and click \fITree\fR to display the hierarchy for that package\&. +.TP 0.2i +\(bu +One use page for each package (package-use\&.html) and a separate use page for each class and interface (class-use/classname\&.html)\&. The use page describes what packages, classes, methods, constructors and fields use any part of the specified class, interface, or package\&. For example, given a class or interface A, its use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A\&. To view the use page, go to the package, class, or interface and click the \fIUse\fR link in the navigation bar\&. +.TP 0.2i +\(bu +A deprecated API page (deprecated-list\&.html) that lists all deprecated APIs and their suggested replacements\&. Avoid deprecated APIs because they can be removed in future implementations\&. +.TP 0.2i +\(bu +A constant field values page (constant-values\&.html) for the values of static fields\&. +.TP 0.2i +\(bu +A serialized form page (serialized-form\&.html) that provides information about serializable and externalizable classes with field and method descriptions\&. The information on this page is of interest to reimplementors, and not to developers who want to use the API\&. To access the serialized form page, go to any serialized class and click \fISerialized Form\fR in the See Also section of the class comment\&. The standard doclet generates a serialized form page that lists any class (public or non-public) that implements Serializable with its \f3readObject\fR and \f3writeObject\fR methods, the fields that are serialized, and the documentation comments from the \f3@serial\fR, \f3@serialField\fR, and \f3@serialData\fR tags\&. Public serializable classes can be excluded by marking them (or their package) with \f3@serial\fR exclude, and package-private serializable classes can be included by marking them (or their package) with an \f3@serial\fR include\&. As of Release 1\&.4, you can generate the complete serialized form for public and private classes by running the \f3javadoc\fR command without specifying the \f3-private\fR option\&. See Options\&. +.TP 0.2i +\(bu +An index page (\f3index-*\&.html\fR) of all class, interface, constructor, field and method names, in alphabetical order\&. The index page is internationalized for Unicode and can be generated as a single file or as a separate file for each starting character (such as A\(enZ for English)\&. +.SS SUPPORT\ PAGES +.TP 0.2i +\(bu +A help page (help-doc\&.html) that describes the navigation bar and the previous pages\&. Use \f3-helpfile\fR to override the default help file with your own custom help file\&. +.TP 0.2i +\(bu +One index\&.html file that creates the HTML frames for display\&. Load this file to display the front page with frames\&. The index\&.html file contains no text content\&. +.TP 0.2i +\(bu +Several frame files (\f3*-frame\&.html\fR) that contains lists of packages, classes, and interfaces\&. The frame files display the HTML frames\&. +.TP 0.2i +\(bu +A package list file (package-list) that is used by the \f3-link\fR and \f3-linkoffline\fR options\&. The package list file is a text file that is not reachable through links\&. +.TP 0.2i +\(bu +A style sheet file (stylesheet\&.css) that controls a limited amount of color, font family, font size, font style, and positioning information on the generated pages\&. +.TP 0.2i +\(bu +A doc-files directory that holds image, example, source code, or other files that you want copied to the destination directory\&. These files are not processed by the \f3javadoc\fR command\&. This directory is not processed unless it exists in the source tree\&. +.PP +See Options\&. +.SS HTML\ FRAMES +The \f3javadoc\fR command generates the minimum number of frames (two or three) necessary based on the values passed to the command\&. It omits the list of packages when you pass a single package name or source files that belong to a single package as an argument to the \f3javadoc\fR command\&. Instead, the \f3javadoc\fR command creates one frame in the left-hand column that displays the list of classes\&. When you pass two or more package names, the \f3javadoc\fR command creates a third frame that lists all packages and an overview page (overview-summary\&.html)\&. To bypass frames, click the \fINo Frames\fR link or enter the page set from the overview-summary\&.html page\&. +.SS GENERATED\ FILE\ STRUCTURE +The generated class and interface files are organized in the same directory hierarchy that Java source files and class files are organized\&. This structure is one directory per subpackage\&. +.PP +For example, the document generated for the \f3java\&.applet\&.Applet\fR class would be located at java/applet/Applet\&.html\&. +.PP +The file structure for the \f3java\&.applet\fR package follows, assuming that the destination directory is named \f3apidocs\fR\&. All files that contain the word \fIframe\fR appear in the upper-left or lower-left frames, as noted\&. All other HTML files appear in the right-hand frame\&. +.PP +Directories are bold\&. The asterisks (*) indicate the files and directories that are omitted when the arguments to the \f3javadoc\fR command are source file names rather than package names\&. When arguments are source file names, an empty package list is created\&. The doc-files directory is not created in the destination unless it exists in the source tree\&. See Generated Files\&. +.TP 0.2i +\(bu +\fIapidocs\fR: Top-level directory +.RS +.TP 0.2i +\(bu +index\&.html: Initial Page that sets up HTML frames +.TP 0.2i +\(bu +*overview-summary\&.html: Package list with summaries +.TP 0.2i +\(bu +overview-tree\&.html: Class hierarchy for all packages +.TP 0.2i +\(bu +deprecated-list\&.html: Deprecated APIs for all packages +.TP 0.2i +\(bu +constant-values\&.html: Static field values for all packages +.TP 0.2i +\(bu +serialized-form\&.html: Serialized forms for all packages +.TP 0.2i +\(bu +*overview-frame\&.html: All packages for display in upper-left frame +.TP 0.2i +\(bu +allclasses-frame\&.html: All classes for display in lower-left frame +.TP 0.2i +\(bu +help-doc\&.html: Help about Javadoc page organization +.TP 0.2i +\(bu +index-all\&.html: Default index created without \f3-splitindex\fR option +.TP 0.2i +\(bu +\fIindex-files\fR: Directory created with \f3-splitindex\fR option +.RS +.TP 0.2i +\(bu +index-<number>\&.html: Index files created with \f3-splitindex\fR option +.RE + +.TP 0.2i +\(bu +package-list: Package names for resolving external references +.TP 0.2i +\(bu +stylesheet\&.css: Defines fonts, colors, positions, and so on +.RE + +.TP 0.2i +\(bu +\fIjava\fR: Package directory +.RS +.TP 0.2i +\(bu +\fIapplet\fR: Subpackage directory +.RS +.TP 0.2i +\(bu +Applet\&.html: \f3Applet\fR class page +.TP 0.2i +\(bu +AppletContext\&.html: \f3AppletContext\fR interface +.TP 0.2i +\(bu +AppletStub\&.html: \f3AppletStub\fR interface +.TP 0.2i +\(bu +AudioClip\&.html: \f3AudioClip\fR interface +.TP 0.2i +\(bu +package-summary\&.html: Classes with summaries +.TP 0.2i +\(bu +package-frame\&.html: Package classes for display in lower-left frame +.TP 0.2i +\(bu +package-tree\&.html: Class hierarchy for this package +.TP 0.2i +\(bu +package-use\&.html: Where this package is used +.TP 0.2i +\(bu +\fIdoc-files\fR: Image and example files directory +.TP 0.2i +\(bu +\fIclass-use\fR: Image and examples file location + +- Applet\&.html: Uses of the Applet class + +- AppletContext\&.html: Uses of the \f3AppletContext\fR interface + +- AppletStub\&.html: Uses of the \f3AppletStub\fR interface + +- AudioClip\&.html: Uses of the \f3AudioClip\fR interface +.RE + +.RE + +.TP 0.2i +\(bu +\fIsrc-html\fR: Source code directory +.RS +.TP 0.2i +\(bu +\fIjava\fR: Package directory +.RS +.TP 0.2i +\(bu +\fIapplet\fR: Subpackage directory + +- Applet\&.html: Applet source code + +- AppletContext\&.html: \f3AppletContext\fR source code + +- AppletStub\&.html: \f3AppletStub\fR source code + +- AudioClip\&.html: \f3AudioClip\fR source code +.RE + +.RE + +.SS GENERATED\ API\ DECLARATIONS +The \f3javadoc\fR command generates a declaration at the start of each class, interface, field, constructor, and method description for that API item\&. For example, the declaration for the \f3Boolean\fR class is: +.sp +.nf +\f3public final class Boolean\fP +.fi +.nf +\f3extends Object\fP +.fi +.nf +\f3implements Serializable\fP +.fi +.nf +\f3\fP +.fi +.sp +The declaration for the \f3Boolean\&.valueOf\fR method is: +.sp +.nf +\f3public static Boolean valueOf(String s)\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3javadoc\fR command can include the modifiers \f3public\fR, \f3protected\fR, \f3private\fR, \f3abstract\fR, \f3final\fR, \f3static\fR, \f3transient\fR, and \f3volatile\fR, but not \f3synchronized\fR or \f3native\fR\&. The \f3synchronized\fR and \f3native\fR modifiers are considered implementation detail and not part of the API specification\&. +.PP +Rather than relying on the keyword \f3synchronized\fR, APIs should document their concurrency semantics in the main description of the comment\&. For example, a description might be: A single enumeration cannot be used by multiple threads concurrently\&. The document should not describe how to achieve these semantics\&. As another example, while the \f3Hashtable\fR option should be thread-safe, there is no reason to specify that it is achieved by synchronizing all of its exported methods\&. It is better to reserve the right to synchronize internally at the bucket level for higher concurrency\&. +.SH DOCUMENTATION\ COMMENTS +This section describes source code comments and comment inheritance\&. +.SS SOURCE\ CODE\ COMMENTS +You can include documentation comments in the source code, ahead of declarations for any class, interface, method, constructor, or field\&. You can also create documentation comments for each package and another one for the overview, though their syntax is slightly different\&. A documentation comment consists of the characters between \f3/**\fR and \f3*/\fR that end it\&. Leading asterisks are allowed on each line and are described further in the following section\&. The text in a comment can continue onto multiple lines\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This is the typical format of a simple documentation comment\fP +.fi +.nf +\f3 * that spans two lines\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.sp +To save space you can put a comment on one line: +.sp +.nf +\f3/** This comment takes up only one line\&. */\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Placement of Comments + +Documentation comments are recognized only when placed immediately before class, interface, constructor, method, or field declarations\&. Documentation comments placed in the body of a method are ignored\&. The \f3javadoc\fR command recognizes only one documentation comment per declaration statement\&. See Where Tags Can Be Used\&. +.PP +A common mistake is to put an \f3import\fR statement between the class comment and the class declaration\&. Do not put an \f3import\fR statement at this location because the \f3javadoc\fR command ignores the class comment\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This is the class comment for the class Whatever\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3import com\&.example; // MISTAKE \- Important not to put import statement here\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class Whatever{ }\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Parts of Comments + +A documentation comment has a main description followed by a tag section\&. The main description begins after the starting delimiter \f3/**\fR and continues until the tag section\&. The tag section starts with the first block tag, which is defined by the first \f3@\fR character that begins a line (ignoring leading asterisks, white space, and leading separator \f3/**\fR)\&. It is possible to have a comment with only a tag section and no main description\&. The main description cannot continue after the tag section begins\&. The argument to a tag can span multiple lines\&. There can be any number of tags, and some types of tags can be repeated while others cannot\&. For example, this \f3@see\fR tag starts the tag section: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This sentence holds the main description for this documentation comment\&.\fP +.fi +.nf +\f3 * @see java\&.lang\&.Object\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Block and inline Tags + +A tag is a special keyword within a documentation comment that the \f3javadoc\fR command processes\&. There are two kinds of tags: block tags, which appear as an \f3@tag\fR tag (also known as standalone tags), and inline tags, which appear within braces, as an \f3{@tag}\fR tag\&. To be interpreted, a block tag must appear at the beginning of a line, ignoring leading asterisks, white space, and the separator (\f3/**\fR)\&. This means you can use the \f3@\fR character elsewhere in the text and it will not be interpreted as the start of a tag\&. If you want to start a line with the \f3@\fR character and not have it be interpreted, then use the HTML entity \f3@\fR\&. Each block tag has associated text, which includes any text following the tag up to, but not including, either the next tag, or the end of the documentation comment\&. This associated text can span multiple lines\&. An inline tag is allowed and interpreted anywhere that text is allowed\&. The following example contains the \f3@deprecated\fR block tag and the \f3{@link}\fR inline tag\&. See Javadoc Tags\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @deprecated As of JDK 1\&.1, replaced by {@link #setBounds(int,int,int,int)}\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Write Comments in HTML + +The text must be written in HTML with HTML entities and HTML tags\&. You can use whichever version of HTML your browser supports\&. The standard doclet generates HTML 3\&.2-compliant code elsewhere (outside of the documentation comments) with the inclusion of cascading style sheets and frames\&. HTML 4\&.0 is preferred for generated files because of the frame sets\&. +.PP +For example, entities for the less than symbol (<) and the greater than symbol (>) should be written as \f3<\fR and \f3>\fR\&. Similarly, the ampersand (&) should be written as \f3&\fR\&. The bold HTML tag \f3<b>\fR is shown in the following example\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This is a <b>doc</b> comment\&.\fP +.fi +.nf +\f3 * @see java\&.lang\&.Object\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Leading Asterisks + +When the \f3javadoc\fR command parses a documentation comment, leading asterisks (*) on each line are discarded, and blanks and tabs that precede the initial asterisks (*) are also discarded\&. If you omit the leading asterisk on a line, then the leading white space is no longer removed so that you can paste code examples directly into a documentation comment inside a \f3<PRE>\fR tag with its indentation preserved\&. Spaces are interpreted by browsers more uniformly than tabs\&. Indentation is relative to the left margin (rather than the separator \f3/**\fR or \f3<PRE>\fR tag)\&. +.PP +First Sentence + +The first sentence of each documentation comment should be a summary sentence that contains a concise but complete description of the declared entity\&. This sentence ends at the first period that is followed by a blank, tab, or line terminator, or at the first block tag\&. The \f3javadoc\fR command copies this first sentence to the member summary at the top of the HTML page\&. +.PP +Multiple-Field Declarations + +The Java platform lets you declare multiple fields in a single statement, but this statement can have only one documentation comment that is copied for all fields\&. If you want individual documentation comments for each field, then declare each field in a separate statement\&. For example, the following documentation comment does not make sense written as a single declaration and would be better handled as two declarations: +.sp +.nf +\f3/** \fP +.fi +.nf +\f3 * The horizontal and vertical distances of point (x,y)\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public int x, y; // Avoid this \fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3javadoc\fR command generates the following documentation from the previous code: +.sp +.nf +\f3public int x\fP +.fi +.nf +\f3\fP +.fi +.sp +The horizontal and vertical distances of point (x, y)\&. +.sp +.nf +\f3public int y\fP +.fi +.nf +\f3\fP +.fi +.sp +The horizontal and vertical distances of point (x, y)\&. +.PP +Use of Header Tags + +When writing documentation comments for members, it is best not to use HTML heading tags such as \f3<H1>\fR and \f3<H2>\fR, because the \f3javadoc\fR command creates an entire structured document, and these structural tags might interfere with the formatting of the generated document\&. However, you can use these headings in class and package comments to provide your own structure\&. +.SS METHOD\ COMMENT\ INHERITANCE +The \f3javadoc\fR command allows method comment inheritance in classes and interfaces to fill in missing text or to explicitly inherit method comments\&. Constructors, fields, and nested classes do not inherit documentation comments\&. +.PP +\fINote:\fR The source file for an inherited method must be on the path specified by the \f3-sourcepath\fR option for the documentation comment to be available to copy\&. Neither the class nor its package needs to be passed in on the command line\&. This contrasts with Release 1\&.3\&.\fIn\fR and earlier releases, where the class had to be a documented class\&. +.PP +Fill in Missing Text + +When a main description, or \f3@return\fR, \f3@param\fR, or \f3@throws\fR tag is missing from a method comment, the \f3javadoc\fR command copies the corresponding main description or tag comment from the method it overrides or implements (if any)\&. See Method Comment Inheritance\&. +.PP +When an \f3@param\fR tag for a particular parameter is missing, the comment for that parameter is copied from the method further up the inheritance hierarchy\&. When an \f3@throws\fR tag for a particular exception is missing, the \f3@throws\fR tag is copied only when that exception is declared\&. +.PP +This behavior contrasts with Release 1\&.3 and earlier, where the presence of any main description or tag would prevent all comments from being inherited\&. +.PP +See Javadoc Tags and Options\&. +.PP +Explicit Inheritance + +Insert the \f3{@inheritDoc}\fR inline tag in a method main description or \f3@return\fR, \f3@param\fR, or \f3@throws\fR tag comment\&. The corresponding inherited main description or tag comment is copied into that spot\&. +.SS CLASS\ AND\ INTERFACE\ INHERITANCE +Comment inheritance occurs in all possible cases of inheritance from classes and interfaces: +.TP 0.2i +\(bu +When a method in a class overrides a method in a superclass +.TP 0.2i +\(bu +When a method in an interface overrides a method in a superinterface +.TP 0.2i +\(bu +When a method in a class implements a method in an interface +.PP +In the first two cases, the \f3javadoc\fR command generates the subheading \fIOverrides\fR in the documentation for the overriding method\&. A link to the method being overridden is included, whether or not the comment is inherited\&. +.PP +In the third case, when a method in a specified class implements a method in an interface, the \f3javadoc\fR command generates the subheading \fISpecified by\fR in the documentation for the overriding method\&. A link to the method being implemented is included, whether or not the comment is inherited\&. +.SS METHOD\ COMMENTS\ ALGORITHM +If a method does not have a documentation comment, or has an \f3{@inheritDoc}\fR tag, then the \f3javadoc\fR command uses the following algorithm to search for an applicable comment\&. The algorithm is designed to find the most specific applicable documentation comment, and to give preference to interfaces over superclasses: +.TP 0.4i +1\&. +Look in each directly implemented (or extended) interface in the order they appear following the word \f3implements\fR (or \f3extends\fR) in the method declaration\&. Use the first documentation comment found for this method\&. +.TP 0.4i +2\&. +If Step 1 failed to find a documentation comment, then recursively apply this entire algorithm to each directly implemented (or extended) interface in the same order they were examined in Step 1\&. +.TP 0.4i +3\&. +When Step 2 fails to find a documentation comment and this is a class other than the \f3Object\fR class, but not an interface: +.RS +.TP 0.4i +1\&. +If the superclass has a documentation comment for this method, then use it\&. +.TP 0.4i +2\&. +If Step 3a failed to find a documentation comment, then recursively apply this entire algorithm to the superclass\&. +.RE + +.SH JAVADOC\ TAGS +The \f3javadoc\fR command parses special tags when they are embedded within a Java documentation comment\&. The \f3javadoc\fR tags let you autogenerate a complete, well-formatted API from your source code\&. The tags start with an at sign (\f3@\fR) and are case-sensitive\&. They must be typed with the uppercase and lowercase letters as shown\&. A tag must start at the beginning of a line (after any leading spaces and an optional asterisk), or it is treated as text\&. By convention, tags with the same name are grouped together\&. For example, put all \f3@see\fR tags together\&. For more information, see Where Tags Can Be Used\&. +.PP +Tags have the following types: +.TP 0.2i +\(bu +Bock tags: Place block tags only in the tag section that follows the description\&. Block tags have the form: \fI@tag\fR\&. +.TP 0.2i +\(bu +Inline tags: Place inline tags anywhere in the main description or in the comments for block tags\&. Inline tags are enclosed within braces: \fI{@tag}\fR\&. +.PP +For custom tags, see -tag tagname:Xaoptcmf:"taghead"\&. See also Where Tags Can Be Used\&. +.SS TAG\ DESCRIPTIONS +.TP +@author \fIname-text\fR +Introduced in JDK 1\&.0 + +Adds an Author entry with the specified name text to the generated documents when the \f3-author\fR option is used\&. A documentation comment can contain multiple \f3@author\fR tags\&. You can specify one name per \f3@author\fR tag or multiple names per tag\&. In the former case, the \f3javadoc\fR command inserts a comma (,) and space between names\&. In the latter case, the entire text is copied to the generated document without being parsed\&. Therefore, you can use multiple names per line if you want a localized name separator other than a comma\&. See @author in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@author +.TP +{@code \fItext\fR} +Introduced in JDK 1\&.5 + +Equivalent to \f3<code>{@literal}</code>\fR\&. + +Displays text in code font without interpreting the text as HTML markup or nested Javadoc tags\&. This enables you to use regular angle brackets (< and >) instead of the HTML entities (\f3<\fR and \f3>\fR) in documentation comments, such as in parameter types (\f3<Object>\fR), inequalities (\f33 < 4\fR), or arrows (\f3<-\fR)\&. For example, the documentation comment text \f3{@code A<B>C}\fR displayed in the generated HTML page unchanged as \f3A<B>C\fR\&. This means that the \f3<B>\fR is not interpreted as bold and is in code font\&. If you want the same functionality without the code font, then use the \f3{@literal}\fR tag\&. +.TP +@deprecated \fIdeprecated-text\fR +Introduced in JDK 1\&.0 + +Adds a comment indicating that this API should no longer be used (even though it may continue to work)\&. The \f3javadoc\fR command moves \f3deprecated-text\fRahead of the main description, placing it in italics and preceding it with a bold warning: Deprecated\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field\&. + +The first sentence of deprecated text should tell the user when the API was deprecated and what to use as a replacement\&. The \f3javadoc\fR command copies the first sentence to the summary section and index\&. Subsequent sentences can also explain why it was deprecated\&. You should include an \f3{@link}\fR tag (for Javadoc 1\&.2 or later) that points to the replacement API\&. + +Use the \fI@deprecated annotation\fR tag to deprecate a program element\&. See How and When to Deprecate APIs at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/deprecation/deprecation\&.html + +See also @deprecated in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@deprecated +.TP +{@docRoot} +Introduced in JDK 1\&.3 + +Represents the relative path to the generated document\&'s (destination) root directory from any generated page\&. This tag is useful when you want to include a file, such as a copyright page or company logo, that you want to reference from all generated pages\&. Linking to the copyright page from the bottom of each page is common\&. + +This \f3{@docRoot}\fR tag can be used both on the command line and in a documentation comment\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field, and includes the text portion of any tag (such as the \f3@return\fR, \f3@param\fR and \f3@deprecated\fR tags)\&. +.RS +.TP 0.2i +\(bu +On the command line, where the header, footer, or bottom are defined: \f3javadoc -bottom \&'<a href="{@docRoot}/copyright\&.html">Copyright</a>\&'\fR\&. + +When you use the \f3{@docRoot}\fR tag this way in a make file, some \f3makefile\fR programs require a special way to escape for the brace \f3{}\fR characters\&. For example, the Inprise MAKE version 5\&.2 running on Windows requires double braces: \f3{{@docRoot}}\fR\&. It also requires double (rather than single) quotation marks to enclose arguments to options such as the \f3-bottom\fR option (with the quotation marks around the \f3href\fR argument omitted)\&. +.TP 0.2i +\(bu +In a documentation comment: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * See the <a href="{@docRoot}/copyright\&.html">Copyright</a>\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This tag is needed because the generated documents are in hierarchical directories, as deep as the number of subpackages\&. The expression: \f3<a href="{@docRoot}/copyright\&.html">\fR resolves to \f3<a href="\&.\&./\&.\&./copyright\&.html">\fR for \f3java/lang/Object\&.java\fR and \f3<a href="\&.\&./\&.\&./\&.\&./copyright\&.html">\fR for \f3java/lang/ref/Reference\&.java\fR\&. +.RE + +.TP +@exception \fIclass-name description\fR +Introduced in JDK 1\&.0 + +Identical to the \f3@throws\fR tag\&. See @throws class-name description\&. +.TP +{@inheritDoc} +Introduced in JDK 1\&.4 + +Inherits (copies) documentation from the nearest inheritable class or implementable interface into the current documentation comment at this tag\&'s location\&. This enables you to write more general comments higher up the inheritance tree and to write around the copied text\&. + +This tag is valid only in these places in a documentation comment: +.RS +.TP 0.2i +\(bu +In the main description block of a method\&. In this case, the main description is copied from a class or interface up the hierarchy\&. +.TP 0.2i +\(bu +In the text arguments of the \f3@return\fR, \f3@param,\fR and \f3@throws\fR tags of a method\&. In this case, the tag text is copied from the corresponding tag up the hierarchy\&. +.RE + + +See Method Comment Inheritance for a description of how comments are found in the inheritance hierarchy\&. Note that if this tag is missing, then the comment is or is not automatically inherited according to rules described in that section\&. +.TP +{@link \fIpackage\&.class#member label\fR} +Introduced in JDK 1\&.2 + +Inserts an inline link with a visible text label that points to the documentation for the specified package, class, or member name of a referenced class\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field, including the text portion of any tag, such as the \f3@return\fR, \f3@param\fR and \f3@deprecated\fR tags\&. See @link in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#{@link + +This tag is similar to the \f3@see\fR tag\&. Both tags require the same references and accept the same syntax for \f3package\&.class#member\fR and \f3label\fR\&. The main difference is that the \f3{@link}\fR tag generates an inline link rather than placing the link in the See Also section\&. The \f3{@link}\fR tag begins and ends with braces to separate it from the rest of the inline text\&. If you need to use the right brace (\f3}\fR) inside the label, then use the HTML entity notation \f3}\fR\&. + +There is no limit to the number of \f3{@link}\fR tags allowed in a sentence\&. You can use this tag in the main description part of any documentation comment or in the text portion of any tag, such as the \f3@deprecated\fR, \f3@return\fR or \f3@param\fR tags\&. + +For example, here is a comment that refers to the \f3getComponentAt(int, int)\fR method: +.sp +.nf +\f3Use the {@link #getComponentAt(int, int) getComponentAt} method\&.\fP +.fi +.nf +\f3\fP +.fi +.sp + + +From this code, the standard doclet generates the following HTML (assuming it refers to another class in the same package): +.sp +.nf +\f3Use the <a href="Component\&.html#getComponentAt(int, int)">getComponentAt</a> method\&.\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The previous line appears on the web page as: +.sp +.nf +\f3Use the getComponentAt method\&.\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +{@linkplain \fIpackage\&.class#member label\fR} +Introduced in JDK 1\&.4 + +Behaves the same as the \f3{@link}\fR tag, except the link label is displayed in plain text rather than code font\&. Useful when the label is plain text\&. For example, \f3Refer to {@linkplain add() the overridden method}\fR\&. displays as: Refer to the overridden method\&. +.TP +{@literal \fItext\fR} +Introduced in JDK 1\&.5 + +Displays text without interpreting the text as HTML markup or nested Javadoc tags\&. This enables you to use angle brackets (\f3< and >\fR) instead of the HTML entities (\f3<\fR and \f3>\fR) in documentation comments, such as in parameter types (\f3<Object>\fR), inequalities (\f33 < 4\fR), or arrows (<-)\&. For example, the documentation comment text \f3{@literal A<B>C}\fR displays unchanged in the generated HTML page in your browser, as \f3A<B>C\fR\&. The \f3<B>\fR is not interpreted as bold (and it is not in code font)\&. If you want the same functionality with the text in code font, then use the \f3{@code}\fR tag\&. +.TP +@param \fIparameter-name description\fR +Introduced in JDK 1\&.0 + +Adds a parameter with the specified \f3parameter-name\fR followed by the specified description to the Parameters section\&. When writing the documentation comment, you can continue the description onto multiple lines\&. This tag is valid only in a documentation comment for a method, constructor, or class\&. See @param in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@param + +The \f3parameter-name\fR can be the name of a parameter in a method or constructor, or the name of a type parameter of a class, method, or constructor\&. Use angle brackets around this parameter name to specify the use of a type parameter\&. + +Example of a type parameter of a class: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @param <E> Type of element stored in a list\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public interface List<E> extends Collection<E> {\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Example of a type parameter of a method: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @param string the string to be converted\fP +.fi +.nf +\f3 * @param type the type to convert the string to\fP +.fi +.nf +\f3 * @param <T> the type of the element\fP +.fi +.nf +\f3 * @param <V> the value of the element\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3<T, V extends T> V convert(String string, Class<T> type) {\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +@return \fIdescription\fR +Introduced in JDK 1\&.0 + +Adds a Returns section with the description text\&. This text should describe the return type and permissible range of values\&. This tag is valid only in a documentation comment for a method\&. See @return in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@return +.TP +@see \fIreference\fR +Introduced in JDK 1\&.0 + +Adds a \fISee Also\fR heading with a link or text entry that points to a reference\&. A documentation comment can contain any number of \f3@see\fR tags, which are all grouped under the same heading\&. The \f3@see\fR tag has three variations\&. The form is the most common\&. This tag is valid in any documentation comment: overview, package, class, interface, constructor, method, or field\&. For inserting an inline link within a sentence to a package, class, or member, see \f3{@link}\fR\&. + +\fIForm 1\fR\&. The @see \f3string\fR tag form adds a text entry for \fIstring\fR\&. No link is generated\&. The string is a book or other reference to information not available by URL\&. The \f3javadoc\fR command distinguishes this from the previous cases by searching for a double quotation mark (") as the first character\&. For example, \f3@see "The Java Programming Language"\fR that generates the following text: + +\fISee Also\fR: + +"The Java Programming Language" + +\fIForm 2\fR\&. The \f3@see <a href="URL#value">label</a>\fR form adds a link as defined by \f3URL#value\fR\&. The \f3URL#value\fR parameter is a relative or absolute URL\&. The \f3javadoc\fR command distinguishes this from other cases by searching for a less-than symbol (\f3<\fR) as the first character\&. For example, \f3@see <a href="spec\&.html#section">Java Spec</a>\fR generates the following link: + +\fISee Also\fR: + +Java Spec + +\fIForm 3\fR\&. The \f3@see package\&.class#member label\fR form adds a link with a visible text label that points to the documentation for the specified name in the Java Language that is referenced\&. The label is optional\&. If the label is omitted, then the name appears instead as visible text, suitably shortened\&. Use the \f3-noqualifier\fR option to globally remove the package name from this visible text\&. Use the label when you want the visible text to be different from the autogenerated visible text\&. See How a Name Appears\&. + +In Java SE 1\&.2 only, the name but not the label automatically appears in \f3<code>\fR HTML tags\&. Starting with Java SE 1\&.2\&.2, the \f3<code>\fR tag is always included around the visible text, whether or not a label is used\&. +.RS +.TP 0.2i +\(bu +\f3package\&.class#member\fR is any valid program element name that is referenced, such as a package, class, interface, constructor, method or field name, except that the character ahead of the member name should be a number sign (\f3#\fR)\&. The class represents any top-level or nested class or interface\&. The member represents any constructor, method, or field (not a nested class or interface)\&. If this name is in the documented classes, then the \f3javadoc\fR command create a link to it\&. To create links to external referenced classes, use the \f3-link\fR option\&. Use either of the other two \f3@see\fR tag forms to refer to the documentation of a name that does not belong to a referenced class\&. See Specify a Name\&. + +\fINote:\fR External referenced classes are classes that are not passed into the \f3javadoc\fR command on the command line\&. Links in the generated documentation to external referenced classes are called external references or external links\&. For example, if you run the \f3javadoc\fR command on only the \f3java\&.awt package\fR, then any class in \f3java\&.lang\fR, such as \f3Object\fR, is an external referenced class\&. Use the \f3-link\fR and \f3-linkoffline\fR options to link to external referenced classes\&. The source comments of external referenced classes are not available to the \f3javadoc\fR command run\&. +.TP 0.2i +\(bu +\f3label\fR is optional text that is visible as the link label\&. The label can contain white space\&. If \f3label\fR is omitted, then \f3package\&.class\&.member\fR appears, suitably shortened relative to the current class and package\&. See How a Name Appears\&. +.TP 0.2i +\(bu +A space is the delimiter between \f3package\&.class#member\fR and \f3label\fR\&. A space inside parentheses does not indicate the start of a label, so spaces can be used between parameters in a method\&. +.RE + + +\fI\fRIn the following example, an \f3@see\fR tag (in the \f3Character\fR class) refers to the equals method in the \f3String\fR class\&. The tag includes both arguments: the name \f3String#equals(Object)\fR and the label \f3equals\fR\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @see String#equals(Object) equals\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The standard doclet produces HTML that is similar to: +.sp +.nf +\f3<dl>\fP +.fi +.nf +\f3<dt><b>See Also:</b>\fP +.fi +.nf +\f3<dd><a href="\&.\&./\&.\&./java/lang/String#equals(java\&.lang\&.Object)"><code>equals<code></a>\fP +.fi +.nf +\f3</dl>\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The previous code looks similar to the following in a browser, where the label is the visible link text: + +\fISee Also\fR: + +equals +.PP +Specify a Name + +\fI\fRThis \f3package\&.class#member\fR name can be either fully qualified, such as \f3java\&.lang\&.String#toUpperCase()\fR or not, such as \f3String#toUpperCase()\fR or \f3#toUpperCase()\fR\&. If the name is less than fully qualified, then the \f3javadoc\fR command uses the standard Java compiler search order to find it\&. See Search Order for the @see Tag\&. The name can contain white space within parentheses, such as between method arguments\&.The advantage to providing shorter, partially qualified names is that they are shorter to type and there is less clutter in the source code\&. The following listing shows the different forms of the name, where \f3Class\fR can be a class or interface; Type can be a class, interface, array, or primitive; and method can be a method or constructor\&. +.sp +.nf +\f3\fITypical forms for\fR\fI @see package\&.class#member\fR\fP +.fi +.nf +\f3\fIReferencing a member of the current class\fR\fP +.fi +.nf +\f3@see #field\fP +.fi +.nf +\f3@see #method(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see #method(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see #constructor(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see #constructor(Type argname, Type argname,\&.\&.\&.) \fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\fIReferencing another class in the current or imported packages\fR\fP +.fi +.nf +\f3@see Class#field\fP +.fi +.nf +\f3@see Class#method(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see Class#method(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see Class#constructor(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see Class#constructor(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see Class\&.NestedClass\fP +.fi +.nf +\f3@see Class \fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\fIReferencing an element in another package (fully qualified)\fR\fP +.fi +.nf +\f3@see package\&.Class#field\fP +.fi +.nf +\f3@see package\&.Class#method(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see package\&.Class#method(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see package\&.Class#constructor(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see package\&.Class#constructor(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see package\&.Class\&.NestedClass\fP +.fi +.nf +\f3@see package\&.Class\fP +.fi +.nf +\f3@see package\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3\fRNotes about the previous listing: +.TP 0.2i +\(bu +The first set of forms with no class or package causes the \f3javadoc\fR command to search only through the current class hierarchy\&. It finds a member of the current class or interface, one of its superclasses or superinterfaces, or one of its enclosing classes or interfaces (search Items 1\(en3)\&. It does not search the rest of the current package or other packages (search Items 4\(en5)\&. See Search Order for the @see Tag\&. +.TP 0.2i +\(bu +If any method or constructor is entered as a name with no parentheses, such as \f3getValue\fR, and if there is no field with the same name, then the \f3javadoc\fR command still creates a link to the method\&. If this method is overloaded, then the \f3javadoc\fR command links to the first method its search encounters, which is unspecified\&. +.TP 0.2i +\(bu +Nested classes must be specified as \f3outer\&.inner\fR, not simply \f3inner\fR, for all forms\&. +.TP 0.2i +\(bu +As stated, the number sign (\f3#\fR), rather than a dot (\f3\&.\fR) separates a member from its class\&. This enables the \f3javadoc\fR command to resolve ambiguities, because the dot also separates classes, nested classes, packages, and subpackages\&. However, the \f3javadoc\fR command properly parses a dot when there is no ambiguity, but prints a warning to alert you\&. +.PP +Search Order for the @see Tag + +\fI\fRThe \f3javadoc\fR command processes an \f3@see\fR tag that appears in a source file, package file, or overview file\&. In the latter two files, you must fully qualify the name you supply with the \f3@see\fR tag\&. In a source file, you can specify a name that is fully qualified or partially qualified\&. +.PP +The following is the search order for the \f3@see\fR tag\&. +.TP 0.4i +1\&. +The current class or interface\&. +.TP 0.4i +2\&. +Any enclosing classes and interfaces searching the closest first\&. +.TP 0.4i +3\&. +Any superclasses and superinterfaces, searching the closest first\&. +.TP 0.4i +4\&. +The current package\&. +.TP 0.4i +5\&. +Any imported packages, classes, and interfaces, searching in the order of the \f3import\fR statement\&. +.PP +The \f3javadoc\fR command continues to search recursively through Items 1-3 for each class it encounters until it finds a match\&. That is, after it searches through the current class and its enclosing class E, it searches through the superclasses of E before the enclosing classes of E\&. In Items 4 and 5, the \f3javadoc\fR command does not search classes or interfaces within a package in any specified order (that order depends on the particular compiler)\&. In Item 5, the \f3javadoc\fR command searches in \fIjava\&.lang\fR because that is imported by all programs\&. +.PP +When the \f3javadoc\fR command encounters an \f3@see\fR tag in a source file that is not fully qualified, it searches for the specified name in the same order as the Java compiler would, except the \f3javadoc\fR command does not detect certain name space ambiguities because it assumes the source code is free of these errors\&. This search order is formally defined in the Java Language Specification\&. The \f3javadoc\fR command searches for that name through all related and imported classes and packages\&. In particular, it searches in this order: +.TP 0.4i +1\&. +The current class or interface\&. +.TP 0.4i +2\&. +Any enclosing classes and interfaces, searching the closest first\&. +.TP 0.4i +3\&. +Any superclasses and superinterfaces, searching the closest first\&. +.TP 0.4i +4\&. +The current package\&. +.TP 0.4i +5\&. +Any imported packages, classes, and interfaces, searching in the order of the \f3import\fR statements\&. +.PP +The \f3javadoc\fR command does not necessarily look in subclasses, nor will it look in other packages even when their documentation is being generated in the same run\&. For example, if the \f3@see\fR tag is in the \f3java\&.awt\&.event\&.KeyEvent\fR class and refers to a name in the \f3java\&.awt package\fR, then the \f3javadoc\fR command does not look in that package unless that class imports it\&. +.PP +How a Name Appears + +\fI\fRIf \f3label\fR is omitted, then \f3package\&.class\&.member\fR appears\&. In general, it is suitably shortened relative to the current class and package\&. Shortened means the \f3javadoc\fR command displays only the minimum name necessary\&. For example, if the \f3String\&.toUpperCase()\fR method contains references to a member of the same class and to a member of a different class, then the class name is displayed only in the latter case, as shown in the following listing\&. Use the \f3-noqualifier\fR option to globally remove the package names\&. +.PP +\fIType of reference\fR: The \f3@see\fR tag refers to a member of the same class, same package +.br +\fIExample in\fR: \f3@see String#toLowerCase()\fR +.br +\fIAppears as\fR: \f3toLowerCase()\fR - omits the package and class names +.br + +.PP +\fIType of reference\fR: The \f3@see\fR tag refers to a member of a different class, same package +.br +\fIExample in\fR: \f3@see Character#toLowerCase(char)\fR +.br +\fIAppears as\fR: \f3Character\&.toLowerCase(char)\fR - omits the package name, includes the class name +.br + +.PP +\fIType of reference\fR: The \f3@see\fR tag refers to a member of a different class, different package +.br +\fIExample in\fR: \f3@see java\&.io\&.File#exists()\fR +.br +\fIAppears as\fR: \f3java\&.io\&.File\&.exists()\fR - includes the package and class names +.br + +.PP +Examples of the @see Tag + +The comment to the right shows how the name appears when the \f3@see\fR tag is in a class in another package, such as \f3java\&.applet\&.Applet\fR\&. See @see in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@see +.sp +.nf +\f3 See also:\fP +.fi +.nf +\f3@see java\&.lang\&.String // String \fP +.fi +.nf +\f3@see java\&.lang\&.String The String class // The String class \fP +.fi +.nf +\f3@see String // String \fP +.fi +.nf +\f3@see String#equals(Object) // String\&.equals(Object) \fP +.fi +.nf +\f3@see String#equals // String\&.equals(java\&.lang\&.Object) \fP +.fi +.nf +\f3@see java\&.lang\&.Object#wait(long) // java\&.lang\&.Object\&.wait(long) \fP +.fi +.nf +\f3@see Character#MAX_RADIX // Character\&.MAX_RADIX \fP +.fi +.nf +\f3@see <a href="spec\&.html">Java Spec</a> // Java Spec \fP +.fi +.nf +\f3@see "The Java Programming Language" // "The Java Programming Language" \fP +.fi +.nf +\f3\fP +.fi +.sp +\fINote:\fR You can extend the \f3@se\fR\f3e\fR tag to link to classes not being documented with the \f3-link\fR option\&. +.TP +@serial \fIfield-description\fR | include | exclude +Introduced in JDK 1\&.2 + +Used in the documentation comment for a default serializable field\&. See Documenting Serializable Fields and Data for a Class at http://docs\&.oracle\&.com/javase/8/docs/platform/serialization/spec/serial-arch\&.html#5251 + +See also Oracle\(cqs Criteria for Including Classes in the Serialized Form Specification at http://www\&.oracle\&.com/technetwork/java/javase/documentation/serialized-criteria-137781\&.html + +An optional \f3field-description\fR should explain the meaning of the field and list the acceptable values\&. When needed, the description can span multiple lines\&. The standard doclet adds this information to the serialized form page\&. See Cross-Reference Pages\&. + +If a serializable field was added to a class after the class was made serializable, then a statement should be added to its main description to identify at which version it was added\&. + +The \f3include\fR and \f3exclude\fR arguments identify whether a class or package should be included or excluded from the serialized form page\&. They work as follows: +.RS +.TP 0.2i +\(bu +A public or protected class that implements \f3Serializable\fR is included unless that class (or its package) is marked with the \f3@serial exclude\fR tag\&. +.TP 0.2i +\(bu +A private or package-private class that implements \f3Serializable\fR is excluded unless that class (or its package) is marked with the \f3@serial include\fR tag\&. +.RE + + +For example, the \f3javax\&.swing\fR package is marked with the \f3@serial\fR\f3exclude\fR tag in package\&.html or package-info\&.java\&. The public class \f3java\&.security\&.BasicPermission\fR is marked with the \f3@serial exclude\fR tag\&. The package-private class \f3java\&.util\&.PropertyPermissionCollection\fR is marked with the \f3@serial include\fR tag\&. + +The \f3@serial\fR tag at the class level overrides the \f3@serial\fR tag at the package level\&. +.TP +@serialData \fIdata-description\fR +Introduced in JDK 1\&.2 + +Uses the data description value to document the types and order of data in the serialized form\&. This data includes the optional data written by the \f3writeObject\fR method and all data (including base classes) written by the \f3Externalizable\&.writeExternal\fR method\&. + +The \f3@serialData\fR tag can be used in the documentation comment for the \f3writeObject\fR, \f3readObject\fR, \f3writeExternal\fR, \f3readExternal\fR, \f3writeReplace\fR, and \f3readResolve\fR methods\&. +.TP +@serialField \fIfield-name\fR\fIfield-type\fR\fIfield-description\fR +Introduced in JDK 1\&.2 + +Documents an \f3ObjectStreamField\fR component of the \f3serialPersistentFields\fR member of a \f3Serializable\fR class\&. Use one \f3@serialField\fR tag for each \f3ObjectStreamField\fR component\&. +.TP +@since \fIsince-text\fR +Introduced in JDK 1\&.1 + +Adds a \fISince\fR heading with the specified \f3since-text\fR value to the generated documentation\&. The text has no special internal structure\&. This tag is valid in any documentation comment: overview, package, class, interface, constructor, method, or field\&. This tag means that this change or feature has existed since the software release specified by the \f3since-text\fR value, for example: \f3@since 1\&.5\fR\&. + +For Java platform source code, the \f3@since\fR tag indicates the version of the Java platform API specification, which is not necessarily when the source code was added to the reference implementation\&. Multiple \f3@since\fR tags are allowed and are treated like multiple \f3@author\fR tags\&. You could use multiple tags when the program element is used by more than one API\&. +.TP +@throws \fIclass-name\fR\fIdescription\fR +Introduced in JDK 1\&.2 + +Behaves the same as the \f3@exception\fR tag\&. See @throws in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@exception + +The \f3@throws\fR tag adds a \fIThrows\fR subheading to the generated documentation, with the \f3class-name\fR and \f3description\fR text\&. The \fIclass-name\fR is the name of the exception that might be thrown by the method\&. This tag is valid only in the documentation comment for a method or constructor\&. If this class is not fully specified, then the \f3javadoc\fR command uses the search order to look up this class\&. Multiple \f3@throws\fR tags can be used in a specified documentation comment for the same or different exceptions\&. See Search Order for the @see Tag\&. + +To ensure that all checked exceptions are documented, when an \f3@throws\fR tag does not exist for an exception in the throws clause, the \f3javadoc\fR command adds that exception to the HTML output (with no description) as though it were documented with the \f3@throws\fR tag\&. + +The \f3@throws\fR documentation is copied from an overridden method to a subclass only when the exception is explicitly declared in the overridden method\&. The same is true for copying from an interface method to an implementing method\&. You can use the \f3{@inheritDoc}\fR tag to force the \f3@throws\fR tag to inherit documentation\&. +.TP +{@value \fIpackage\&.class#field\fR} +Introduced in JDK 1\&.4 + +Displays constant values\&. When the \f3{@value}\fR tag is used without an argument in the documentation comment of a static field, it displays the value of that constant: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * The value of this constant is {@value}\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public static final String SCRIPT_START = "<script>"\fP +.fi +.nf +\f3\fP +.fi +.sp + + +When used with the argument \f3package\&.class#field\fR in any documentation comment, he \f3{@value}\fR tag displays the value of the specified constant: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * Evaluates the script starting with {@value #SCRIPT_START}\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public String evalScript(String script) {}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The argument \f3package\&.class#field\fR takes a form similar to that of the \f3@see\fR tag argument, except that the member must be a static field\&. + +The values of these constants are also displayed in Constant Field Values at http://docs\&.oracle\&.com/javase/8/docs/api/constant-values\&.html +.TP +@version \fIversion-text\fR +Introduced in JDK 1\&.0 + +Adds a \fIVersion\fR subheading with the specified \f3version-text\fR value to the generated documents when the \f3-version\fR option is used\&. This tag is intended to hold the current release number of the software that this code is part of, as opposed to the\f3@since\fR tag, which holds the release number where this code was introduced\&. The \f3version-text\fR value has no special internal structure\&. See @version in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@version + +A documentation comment can contain multiple \f3@version\fR tags\&. When it makes sense, you can specify one release number per \f3@version\fR tag or multiple release numbers per tag\&. In the former case, the \f3javadoc\fR command inserts a comma (,) and a space between the names\&. In the latter case, the entire text is copied to the generated document without being parsed\&. Therefore, you can use multiple names per line when you want a localized name separator other than a comma\&. +.SH WHERE\ TAGS\ CAN\ BE\ USED +The following sections describe where tags can be used\&. Note that the following tags can be used in all documentation comments: \f3@see\fR, \f3@since\fR, \f3@deprecated\fR, \f3{@link}\fR, \f3{@linkplain}\fR, and \f3{@docroot}\fR\&. +.SS OVERVIEW\ TAGS +Overview tags are tags that can appear in the documentation comment for the overview page (which resides in the source file typically named overview\&.html)\&. Similar to any other documentation comments, these tags must appear after the main description +.PP +\fINote:\fR The \f3{@link}\fR tag has a bug in overview documents in Java SE 1\&.2\&. The text appears correctly but has no link\&. The \f3{@docRoot}\fR tag does not currently work in overview documents\&. +.PP +The overview tags are the following: +.PP +@see reference || @since since-text || @serialField field-name field-type field-description || @author name-text || @version version-text || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || +.SS PACKAGE\ TAGS +Package tags are tags that can appear in the documentation comment for a package, that resides in the source file named package\&.html or package-info\&.java\&. The \f3@serial\fR tag can only be used here with the \f3include\fR or \f3exclude\fR argument\&. +.PP +The package tags are the following: +.PP +@see reference || @since since-text || @serial field-description | include | exclude || @author name-text || @version version-text || {@linkplain package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || +.SS CLASS\ AND\ INTERFACE\ TAGS +The following are tags that can appear in the documentation comment for a class or interface\&. The \f3@serial\fR tag can only be used within the documentation for a class or interface with an \f3include\fR or \f3exclude\fR argument\&. +.PP +@see reference || @since since-text || @deprecated deprecated-text || @serial field-description | include | exclude || @author name-text || @version version-text || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || +.PP +Class comment example: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * A class representing a window on the screen\&.\fP +.fi +.nf +\f3 * For example:\fP +.fi +.nf +\f3 * <pre>\fP +.fi +.nf +\f3 * Window win = new Window(parent);\fP +.fi +.nf +\f3 * win\&.show();\fP +.fi +.nf +\f3 * </pre>\fP +.fi +.nf +\f3 *\fP +.fi +.nf +\f3 * @author Sami Shaio\fP +.fi +.nf +\f3 * @version 1\&.13, 06/08/06\fP +.fi +.nf +\f3 * @see java\&.awt\&.BaseWindow\fP +.fi +.nf +\f3 * @see java\&.awt\&.Button\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3class Window extends BaseWindow {\fP +.fi +.nf +\f3 \&.\&.\&.\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS FIELD\ TAGS +These tags can appear in fields: +.PP +@see reference || @since since-text || @deprecated deprecated-text || @serial field-description | include | exclude || @serialField field-name field-type field-description || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || {@value package\&.class#field} +.PP +Field comment example: +.sp +.nf +\f3 /**\fP +.fi +.nf +\f3 * The X\-coordinate of the component\&.\fP +.fi +.nf +\f3 *\fP +.fi +.nf +\f3 * @see #getLocation()\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3 int x = 1263732;\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS CONSTRUCTOR\ AND\ METHOD\ TAGS +The following tags can appear in the documentation comment for a constructor or a method, except for the \f3@return\fR tag, which cannot appear in a constructor, and the \f3{@inheritDoc}\fR tag, which has restrictions\&. +.PP +@see reference || @since since-text || @deprecated deprecated-text || @param parameter-name description || @return description || @throws class-name description || @exception class-name description || @serialData data-description || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@inheritDoc} || {@docRoot} +.PP +\fINote:\fR The \f3@serialData\fR tag can only be used in the documentation comment for the \f3writeObject\fR, \f3readObject\fR, \f3writeExternal\fR, \f3readExternal\fR, \f3writeReplace\fR, and \f3readResolve\fR methods\&. +.PP +Method comment example: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * Returns the character at the specified index\&. An index \fP +.fi +.nf +\f3 * ranges from <code>0</code> to <code>length() \- 1</code>\fP +.fi +.nf +\f3 *\fP +.fi +.nf +\f3 * @param index the index of the desired character\&.\fP +.fi +.nf +\f3 * @return the desired character\&.\fP +.fi +.nf +\f3 * @exception StringIndexOutOfRangeException \fP +.fi +.nf +\f3 * if the index is not in the range <code>0</code> \fP +.fi +.nf +\f3 * to <code>length()\-1</code>\fP +.fi +.nf +\f3 * @see java\&.lang\&.Character#charValue()\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3 public char charAt(int index) {\fP +.fi +.nf +\f3 \&.\&.\&.\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +The \f3javadoc\fR command uses doclets to determine its output\&. The \f3javadoc\fR command uses the default standard doclet unless a custom doclet is specified with the \f3-doclet\fR option\&. The \f3javadoc\fR command provides a set of command-line options that can be used with any doclet\&. These options are described in Javadoc Options\&. The standard doclet provides an additional set of command-line options that are described in Standard Doclet Options\&. All option names are not case-sensitive, but their arguments are case-sensitive\&. +.TP 0.2i +\(bu +See also Javadoc Options +.TP 0.2i +\(bu +See also Standard Doclet Options +.PP +The options are: +.PP +-1\&.1 || -author || -bootclasspath classpathlist || -bottom text || -breakiterator || -charset name || -classpath classpathlist || -d directory || -docencoding name || -docfilesubdirs || -doclet class || -docletpath classpathlist || -doctitle title || -encoding || -exclude packagename1:packagename2:\&.\&.\&. || -excludedocfilessubdir name1:name2 || -extdirs dirist || -footer footer || -group groupheading packagepattern:packagepattern || -header header || -help || -helpfile path\efilename || -Jflag || -javafx ||-keywords || -link extdocURL || -linkoffline extdocURL packagelistLoc || -linksource || -locale language_country_variant || -nocomment || -nodeprecated || -nodeprecatedlist || -nohelp || -noindex || -nonavbar || -noqualifier all | packagename1:packagename2\&.\&.\&. || -nosince || -notimestamp || -notree || -overview path/filename || -package || -private || -protected || -public || -quiet || -serialwarn || -source release || -sourcepath sourcepathlist || -sourcetab tablength || -splitindex || -stylesheet path/filename || -subpackages package1:package2:\&.\&.\&. || -tag tagname:Xaoptcmf:"taghead" || -taglet class || -tagletpath tagletpathlist || -title title || -top || -use || -verbose || -version || -windowtitle title +.PP +The following options are the core Javadoc options that are available to all doclets\&. The standard doclet provides the rest of the doclets: \f3-bootclasspath\fR, \f3-breakiterator\fR, \f3-classpath\fR, \f3-doclet\fR, \f3-docletpath\fR, \f3-encoding\fR, -\f3exclude\fR, \f3-extdirs\fR, \f3-help\fR, \f3-locale\fR, \f3-\fR\f3overview\fR, \f3-package\fR, \f3-private\fR, \f3-protected\fR, \f3-public\fR, \f3-quiet\fR, \f3-source\fR, \f3-sourcepath\fR, \f3-subpackages\fR, and \f3-verbose\fR\&. +.SS JAVADOC\ OPTIONS +.TP +-overview \fIpath/filename\fR +.br +Specifies that the \f3javadoc\fR command should retrieve the text for the overview documentation from the source file specified by the \fIpath/filename\fRand place it on the Overview page (overview-summary\&.html)\&. The \fIpath/filename\fRis relative to the current directory\&. + +While you can use any name you want for the \f3filename\fR value and place it anywhere you want for the path, it is typical to name it overview\&.html and place it in the source tree at the directory that contains the topmost package directories\&. In this location, no path is needed when documenting packages, because the \f3-sourcepath\fR option points to this file\&. + +For example, if the source tree for the \f3java\&.lang\fR package is /src/classes/java/lang/, then you could place the overview file at /src/classes/overview\&.html + +See Real-World Examples\&. + +For information about the file specified by \fIpath/filename,\fRsee Overview Comment Files\&. + +The overview page is created only when you pass two or more package names to the \f3javadoc\fR command\&. For a further explanation, see HTML Frames\&. The title on the overview page is set by \f3-doctitle\fR\&. +.TP +-Xdoclint:(all|none|[-]\fI<group>\fR) +.br +Reports warnings for bad references, lack of accessibility and missing Javadoc comments, and reports errors for invalid Javadoc syntax and missing HTML tags\&. + +This option enables the \f3javadoc\fR command to check for all documentation comments included in the generated output\&. As always, you can select which items to include in the generated output with the standard options \f3-public\fR, \f3-protected\fR, \f3-package\fR and \f3-private\fR\&. + +When the \f3-Xdoclint\fR is enabled, it reports issues with messages similar to the \f3javac\fR command\&. The \f3javadoc\fR command prints a message, a copy of the source line, and a caret pointing at the exact position where the error was detected\&. Messages may be either warnings or errors, depending on their severity and the likelihood to cause an error if the generated documentation were run through a validator\&. For example, bad references or missing Javadoc comments do not cause the \f3javadoc\fR command to generate invalid HTML, so these issues are reported as warnings\&. Syntax errors or missing HTML end tags cause the \f3javadoc\fR command to generate invalid output, so these issues are reported as errors\&. + +By default, the \f3-Xdoclint\fR option is enabled\&. Disable it with the option \f3-Xdoclint:none\fR\&. + +Change what the \f3-Xdoclint\fR option reports with the following options: +.RS +.TP 0.2i +\(bu +\f3-Xdoclint none\fR : disable the \f3-Xdoclint\fR option +.TP 0.2i +\(bu +\f3-Xdoclint\fR\fIgroup\fR : enable \fIgroup\fR checks +.TP 0.2i +\(bu +\f3-Xdoclint all\fR : enable all groups of checks +.TP 0.2i +\(bu +\f3-Xdoclint all,\fR\fI-group\fR : enable all except \fIgroup\fR checks +.RE + + +The variable \fIgroup\fR has one of the following values: +.RS +.TP 0.2i +\(bu +\f3accessibility\fR : Checks for the issues to be detected by an accessibility checker (for example, no caption or summary attributes specified in a \f3<table>\fR tag)\&. +.TP 0.2i +\(bu +\f3html\fR : Detects high-level HTML issues, like putting block elements inside inline elements, or not closing elements that require an end tag\&. The rules are derived from theHTML 4\&.01 Specification\&. This type of check enables the \f3javadoc\fR command to detect HTML issues that many browsers might accept\&. +.TP 0.2i +\(bu +\f3missing\fR : Checks for missing Javadoc comments or tags (for example, a missing comment or class, or a missing \f3@return\fR tag or similar tag on a method)\&. +.TP 0.2i +\(bu +\f3reference\fR : Checks for issues relating to the references to Java API elements from Javadoc tags (for example, item not found in \f3@see\fR , or a bad name after \f3@param)\fR\&. +.TP 0.2i +\(bu +\f3syntax\fR : Checks for low level issues like unescaped angle brackets (\f3<\fR and \f3>\fR) and ampersands (\f3&\fR) and invalid Javadoc tags\&. +.RE + + +You can specify the \f3-Xdoclint\fR option multiple times to enable the option to check errors and warnings in multiple categories\&. Alternatively, you can specify multiple error and warning categories by using the preceding options\&. For example, use either of the following commands to check for the HTML, syntax, and accessibility issues in the file \fIfilename\fR\&. +.sp +.nf +\f3javadoc \-Xdoclint:html \-Xdoclint:syntax \-Xdoclint:accessibility \fIfilename\fR\fP +.fi +.nf +\f3javadoc \-Xdoclint:html,syntax,accessibility \fIfilename\fR\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fINote:\fR The \f3javadoc\fR command does not guarantee the completeness of these checks\&. In particular, it is not a full HTML compliance checker\&. The goal of the -\f3Xdoclint\fR option is to enable the \f3javadoc\fR command to report majority of common errors\&. + +The \f3javadoc\fR command does not attempt to fix invalid input, it just reports it\&. +.TP +-public +.br +Shows only public classes and members\&. +.TP +-protected +.br +Shows only protected and public classes and members\&. This is the default\&. +.TP +-package +.br +Shows only package, protected, and public classes and members\&. +.TP +-private +.br +Shows all classes and members\&. +.TP +-help +.br +Displays the online help, which lists all of the \f3javadoc\fR and \f3doclet\fR command-line options\&. +.TP +-doclet \fIclass\fR +.br +Specifies the class file that starts the doclet used in generating the documentation\&. Use the fully qualified name\&. This doclet defines the content and formats the output\&. If the \f3-doclet\fR option is not used, then the \f3javadoc\fR command uses the standard doclet for generating the default HTML format\&. This class must contain the \f3start(Root)\fR method\&. The path to this starting class is defined by the \f3-docletpath\fR option\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html +.TP +-docletpath \fIclasspathlist\fR +.br +Specifies the path to the doclet starting class file (specified with the \f3-doclet\fR option) and any JAR files it depends on\&. If the starting class file is in a JAR file, then this option specifies the path to that JAR file\&. You can specify an absolute path or a path relative to the current directory\&. If \f3classpathlist\fR contains multiple paths or JAR files, then they should be separated with a colon (:) on Oracle Solaris and a semi-colon (;) on Windows\&. This option is not necessary when the doclet starting class is already in the search path\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html +.TP +-1\&.1 +.br +Removed from Javadoc 1\&.4 with no replacement\&. This option created documentation with the appearance and functionality of documentation generated by Javadoc 1\&.1 (it never supported nested classes)\&. If you need this option, then use Javadoc 1\&.2 or 1\&.3 instead\&. +.TP +-source \fIrelease\fR +.br +Specifies the release of source code accepted\&. The following values for the \f3release\fR parameter are allowed\&. Use the value of \f3release\fR that corresponds to the value used when you compile code with the \f3javac\fR command\&. +.RS +.TP 0.2i +\(bu +\fIRelease Value: 1\&.5\fR\&. The \f3javadoc\fR command accepts code containing generics and other language features introduced in JDK 1\&.5\&. The compiler defaults to the 1\&.5 behavior when the \f3-source\fR option is not used\&. +.TP 0.2i +\(bu +\fIRelease Value: 1\&.4\fR\&. The \f3javadoc\fR command accepts code containing assertions, which were introduced in JDK 1\&.4\&. +.TP 0.2i +\(bu +\fIRelease Value: 1\&.3\fR\&. The \f3javadoc\fR command does not support assertions, generics, or other language features introduced after JDK 1\&.3\&. +.RE + +.TP +-sourcepath \fIsourcepathlist\fR +.br +Specifies the search paths for finding source files when passing package names or the \f3-subpackages\fR option into the \f3javadoc\fR command\&. Separate multiple paths with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. Note that this option is not only used to locate the source files being documented, but also to find source files that are not being documented, but whose comments are inherited by the source files being documented\&. + +You can use the \f3-sourcepath\fR option only when passing package names into the \f3javadoc\fR command\&. This will not locate source files passed into the \f3javadoc\fR command\&. To locate source files, \f3\fRchange to that directory or include the path ahead of each file, as shown at Document One or More Classes\&. If you omit \f3-sourcepath\fR, then the \f3javadoc\fR command uses the class path to find the source files (see \f3-classpath\fR)\&. The default \f3-sourcepath\fR is the value of class path\&. If \f3-classpath\fR is omitted and you pass package names into the \f3javadoc\fR command, then the \f3javadoc\fR command searches in the current directory and subdirectories for the source files\&. + +Set \f3sourcepathlist\fR to the root directory of the source tree for the package you are documenting\&. + +For example, suppose you want to document a package called \f3com\&.mypackage\fR, whose source files are located at:/home/user/src/com/mypackage/*\&.java\&. Specify the sourcepath to /home/user/src, the directory that contains com\emypackage, and then supply the package name, as follows: +.sp +.nf +\f3javadoc \-sourcepath /home/user/src/ com\&.mypackage\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Notice that if you concatenate the value of sourcepath and the package name together and change the dot to a slash (/), then you have the full path to the package: + +/home/user/src/com/mypackage + +To point to two source paths: +.sp +.nf +\f3javadoc \-sourcepath /home/user1/src:/home/user2/src com\&.mypackage\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-classpath \fIclasspathlist\fR +.br +Specifies the paths where the \f3javadoc\fR command searches for referenced classes These are the documented classes plus any classes referenced by those classes\&. Separate multiple paths with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. Follow the instructions in the class path documentation for specifying the \f3classpathlist\fR value\&. + +If you omit \f3-sourcepath\fR, then the \f3javadoc\fR command uses \f3-classpath\fR to find the source files and class files (for backward compatibility)\&. If you want to search for source and class files in separate paths, then use both \f3-sourcepath\fR and \f3-classpath\fR\&. + +For example, if you want to document \f3com\&.mypackage\fR, whose source files reside in the directory /home/user/src/com/mypackage, and if this package relies on a library in /home/user/lib, then you would use the following command: +.sp +.nf +\f3javadoc \-sourcepath /home/user/lib \-classpath /home/user/src com\&.mypackage\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Similar to other tools, if you do not specify \f3-classpath\fR, then the \f3javadoc\fR command uses the \f3CLASSPATH\fR environment variable when it is set\&. If both are not set, then the \f3javadoc\fR command searches for classes from the current directory\&. + +For an in-depth description of how the \f3javadoc\fR command uses \f3-classpath\fR to find user classes as it relates to extension classes and bootstrap classes, see How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html + +A class path element that contains a base name of * is considered equivalent to specifying a list of all the files in the directory with the extension \f3\&.jar\fR or \f3\&.JAR\fR\&. + +For example, if directory \f3mydir\fR contains \f3a\&.jar\fR and \f3b\&.JA\fRR, then the class path element \f3foo/*\fR is expanded to a \f3A\&.jar:b\&.JAR\fR, except that the order of JAR files is unspecified\&. All JAR files in the specified directory including hidden files are included in the list\&. A class path entry that consists of * expands to a list of all the jar files in the current directory\&. The \f3CLASSPATH\fR environment variable is similarly expanded\&. Any class path wildcard expansion occurs before the Java Virtual Machine (JVM) starts\&. No Java program ever sees unexpanded wild cards except by querying the environment, for example, by calling System\&.getenv(\f3"CLASSPATH"\fR)\&. +.TP +-subpackages \fIpackage1:package2:\&.\&.\&.\fR +.br +Generates documentation from source files in the specified packages and recursively in their subpackages\&. This option is useful when adding new subpackages to the source code because they are automatically included\&. Each package argument is any top-level subpackage (such as \f3java\fR) or fully qualified package (such as \f3javax\&.swing\fR) that does not need to contain source files\&. Arguments are separated by colons on all operating systems\&. Wild cards are not allowed\&. Use \f3-sourcepath\fR to specify where to find the packages\&. This option does not process source files that are in the source tree but do not belong to the packages\&. See Process Source Files\&. + +For example, the following command generates documentation for packages named \f3java\fR and \f3javax\&.swing\fR and all of their subpackages\&. +.sp +.nf +\f3javadoc \-d docs \-sourcepath /home/user/src \-subpackages java:javax\&.swing \fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-exclude \fIpackagename1:packagename2:\&.\&.\&.\fR +.br +Unconditionally excludes the specified packages and their subpackages from the list formed by \f3-subpackages\fR\&. It excludes those packages even when they would otherwise be included by some earlier or later \f3-subpackages\fR option\&. + +The following example would include \f3java\&.io\fR, \f3java\&.util\fR, and \f3java\&.math\fR (among others), but would exclude packages rooted at \f3java\&.net\fR and \f3java\&.lang\fR\&. Notice that this example excludes \f3java\&.lang\&.ref\fR, which is a subpackage of \f3java\&.lang\fR\&. +.sp +.nf +\f3javadoc \-sourcepath /home/user/src \-subpackages java \-exclude \fP +.fi +.nf +\f3 java\&.net:java\&.lang\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-bootclasspath \fIclasspathlist\fR +.br +Specifies the paths where the boot classes reside\&. These are typically the Java platform classes\&. The \f3bootclasspath\fR is part of the search path the \f3javadoc\fR command uses to look up source and class files\&. For more information, see How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html + +Separate directories in the \f3classpathlist\fR parameters with semicolons (;) for Windows and colons (:) for Oracle Solaris\&. +.TP +-extdirs \fIdirist\fR +.br +Specifies the directories where extension classes reside\&. These are any classes that use the Java Extension mechanism\&. The \f3extdirs\fR option is part of the search path the \f3javadoc\fR command uses to look up source and class files\&. See the \f3-classpath\fR option for more information\&. Separate directories in \f3dirlist\fR with semicolons (;) for Windows and colons (:) for Oracle Solaris\&. +.TP +-verbose +.br +Provides more detailed messages while the \f3javadoc\fR command runs\&. Without the \f3verbose\fR option, messages appear for loading the source files, generating the documentation (one message per source file), and sorting\&. The verbose option causes the printing of additional messages that specify the number of milliseconds to parse each Java source file\&. +.TP +-quiet +.br +Shuts off messages so that only the warnings and errors appear to make them easier to view\&. It also suppresses the \f3version\fR string\&. +.TP +-breakiterator +.br +Uses the internationalized sentence boundary of \f3java\&.text\&.BreakIterator\fR to determine the end of the first sentence in the main description of a package, class, or member for English\&. All other locales already use the \f3BreakIterator\fR class, rather than an English language, locale-specific algorithm\&. The first sentence is copied to the package, class, or member summary and to the alphabetic index\&. From JDK 1\&.2 and later, the \f3BreakIterator\fR class is used to determine the end of a sentence for all languages except for English\&. Therefore, the \f3-breakiterator\fR option has no effect except for English from 1\&.2 and later\&. English has its own default algorithm: +.RS +.TP 0.2i +\(bu +English default sentence-break algorithm\&. Stops at a period followed by a space or an HTML block tag, such as \f3<P>\fR\&. +.TP 0.2i +\(bu +Breakiterator sentence-break algorithm\&. Stops at a period, question mark, or exclamation point followed by a space when the next word starts with a capital letter\&. This is meant to handle most abbreviations (such as "The serial no\&. is valid", but will not handle "Mr\&. Smith")\&. The \f3-breakiterator\fR option does not stop at HTML tags or sentences that begin with numbers or symbols\&. The algorithm stops at the last period in \&.\&./filename, even when embedded in an HTML tag\&. +.RE + + +In Java SE 1\&.5 the \f3-breakiterator\fR option warning messages are removed, and the default sentence-break algorithm is unchanged\&. If you have not modified your source code to eliminate the \f3-breakiterator\fR option warnings in Java SE 1\&.4\&.x, then you do not have to do anything\&. The warnings go away starting with Java SE 1\&.5\&.0\&. +.TP +-locale \fIlanguage_country_variant\fR +.br +Specifies the locale that the \f3javadoc\fR command uses when it generates documentation\&. The argument is the name of the locale, as described in \f3j\fR\f3ava\&.util\&.Locale\fR documentation, such as \f3en_US\fR (English, United States) or \f3en_US_WIN\fR (Windows variant)\&. + +\fINote:\fR The \f3-locale\fR option must be placed ahead (to the left) of any options provided by the standard doclet or any other doclet\&. Otherwise, the navigation bars appear in English\&. This is the only command-line option that depends on order\&. See Standard Doclet Options\&. + +Specifying a locale causes the \f3javadoc\fR command to choose the resource files of that locale for messages such as strings in the navigation bar, headings for lists and tables, help file contents, comments in the stylesheet\&.css file, and so on\&. It also specifies the sorting order for lists sorted alphabetically, and the sentence separator to determine the end of the first sentence\&. The \f3-locale\fR option does not determine the locale of the documentation comment text specified in the source files of the documented classes\&. +.TP +-encoding +.br +Specifies the encoding name of the source files, such as \f3EUCJIS/SJIS\fR\&. If this option is not specified, then the platform default converter is used\&. See also the\f3-docencoding name\fR and \f3-charset name\fR options\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR directly to the Java Runtime Environment (JRE) that runs the \f3javadoc\fR command\&. For example, if you must ensure that the system sets aside 32 MB of memory in which to process the generated documentation, then you would call the \f3-Xmx\fR option as follows: \f3javadoc -J-Xmx32m -J-Xms32m com\&.mypackage\fR\&. Be aware that \f3-Xms\fR is optional because it only sets the size of initial memory, which is useful when you know the minimum amount of memory required\&. + +There is no space between the \f3J\fR and the \f3flag\fR\&. + +Use the \f3-version\fR option to find out what version of the \f3javadoc\fR command you are using\&. The version number of the standard doclet appears in its output stream\&. See Running the Javadoc Command\&. +.sp +.nf +\f3javadoc \-J\-version\fP +.fi +.nf +\f3java version "1\&.7\&.0_09"\fP +.fi +.nf +\f3Java(TM) SE Runtime Environment (build 1\&.7\&.0_09\-b05)\fP +.fi +.nf +\f3Java HotSpot(TM) 64\-Bit Server VM (build 23\&.5\-b02, mixed mode)\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-javafx +.br +Generates HTML documentation using the JavaFX extensions to the standard doclet\&. The generated documentation includes a Property Summary section in addition to the other summary sections generated by the standard Java doclet\&. The listed properties are linked to the sections for the getter and setter methods of each property\&. + +If there are no documentation comments written explicitly for getter and setter methods, the documentation comments from the property method are automatically copied to the generated documentation for these methods\&. This option also adds a new \f3@defaultValue\fR tag that allows documenting the default value for a property\&. + +Example: +.sp +.nf +\f3javadoc \-javafx MyClass\&.java \-d testdir\fP +.fi +.sp + +.SS STANDARD\ DOCLET\ OPTIONS +.TP +-d \fIdirectory\fR +.br +Specifies the destination directory where the \f3javadoc\fR command saves the generated HTML files\&. If you omit the \f3-d\fR option, then the files are saved to the current directory\&. The \f3directory\fR value can be absolute or relative to the current working directory\&. As of Java SE 1\&.4, the destination directory is automatically created when the \f3javadoc\fR command runs\&. + +For example, the following command generates the documentation for the package \f3com\&.mypackage\fR and saves the results in the /user/doc/ directory: \f3javadoc -d\fR\f3/user/doc/\fR\f3com\&.mypackage\fR\&. +.TP +-use +.br +Includes one Use page for each documented class and package\&. The page describes what packages, classes, methods, constructors and fields use any API of the specified class or package\&. Given class C, things that use class C would include subclasses of C, fields declared as C, methods that return C, and methods and constructors with parameters of type C\&. For example, you can look at the Use page for the \f3String\fR type\&. Because the \f3getName\fR method in the \f3java\&.awt\&.Font\fR class returns type \f3String\fR, the \f3getName\fR method uses \f3String\fR and so the \f3getName\fR method appears on the Use page for \f3String\fR\&.This documents only uses of the API, not the implementation\&. When a method uses \f3String\fR in its implementation, but does not take a string as an argument or return a string, that is not considered a use of \f3String\fR\&.To access the generated Use page, go to the class or package and click the \fIUse link\fR in the navigation bar\&. +.TP +-version +.br +Includes the @version text in the generated docs\&. This text is omitted by default\&. To find out what version of the \f3javadoc\fR command you are using, use the \f3-J-version\fR option\&. +.TP +-author +.br +Includes the \f3@author\fR text in the generated docs\&. +.TP +-splitindex +.br +Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical symbols\&. +.TP +-windowtitle \fItitle\fR +.br +Specifies the title to be placed in the HTML \f3<title>\fR tag\&. The text specified in the \f3title\fR tag appears in the window title and in any browser bookmarks (favorite places) that someone creates for this page\&. This title should not contain any HTML tags because the browser does not interpret them correctly\&. Use escape characters on any internal quotation marks within the \f3title\fR tag\&. If the \f3-windowtitle\fR option is omitted, then the \f3javadoc\fR command uses the value of the \f3-doctitle\fR option for the \f3-windowtitle\fR option\&. For example, \f3javadoc -windowtitle "Java SE Platform" com\&.mypackage\fR\&. +.TP +-doctitle \fItitle\fR +.br +Specifies the title to place near the top of the overview summary file\&. The text specified in the \f3title\fR tag is placed as a centered, level-one heading directly beneath the top navigation bar\&. The \f3title\fR tag can contain HTML tags and white space, but when it does, you must enclose the title in quotation marks\&. Internal quotation marks within the \f3title\fR tag must be escaped\&. For example, \f3javadoc -header "<b>Java Platform </b><br>v1\&.4" com\&.mypackage\&.\fR +.TP +-title \fItitle\fR +.br +No longer exists\&. It existed only in Beta releases of Javadoc 1\&.2\&. It was renamed to \f3-doctitle\fR\&. This option was renamed to make it clear that it defines the document title, rather than the window title\&. +.TP +-header \fIheader\fR +.br +Specifies the header text to be placed at the top of each output file\&. The header is placed to the right of the upper navigation bar\&. The \f3header\fR can contain HTML tags and white space, but when it does, the \f3header\fR must be enclosed in quotation marks\&. Use escape characters for internal quotation marks within a header\&. For example, \f3javadoc -header "<b>Java Platform </b><br>v1\&.4" com\&.mypackage\&.\fR +.TP +-footer \fIfooter\fR +.br +Specifies the footer text to be placed at the bottom of each output file\&. The \fIfooter\fR value is placed to the right of the lower navigation bar\&. The \f3footer\fR value can contain HTML tags and white space, but when it does, the \f3footer\fR value must be enclosed in quotation marks\&. Use escape characters for any internal quotation marks within a footer\&. +.TP +-top +.br +Specifies the text to be placed at the top of each output file\&. +.TP +-bottom \fItext\fR +.br +Specifies the text to be placed at the bottom of each output file\&. The text is placed at the bottom of the page, underneath the lower navigation bar\&. The text can contain HTML tags and white space, but when it does, the text must be enclosed in quotation marks\&. Use escape characters for any internal quotation marks within text\&. +.TP +-link \fIextdocURL\fR +.br +Creates links to existing Javadoc-generated documentation of externally referenced classes\&. The \fIextdocURL\fR argument is the absolute or relative URL of the directory that contains the external Javadoc-generated documentation you want to link to\&. You can specify multiple \f3-link\fR options in a specified \f3javadoc\fR command run to link to multiple documents\&. + +The package-list file must be found in this directory (otherwise, use the \f3-linkoffline\fR option)\&. The \f3javadoc\fR command reads the package names from the package-list file and links to those packages at that URL\&. When the \f3javadoc\fR command runs, the \f3extdocURL\fR value is copied into the \f3<A HREF>\fR links that are created\&. Therefore, \f3extdocURL\fR must be the URL to the directory, and not to a file\&. You can use an absolute link for \fIextdocURL\fR to enable your documents to link to a document on any web site, or you can use a relative link to link only to a relative location\&. If you use a relative link, then the value you pass in should be the relative path from the destination directory (specified with the \f3-d\fR option) to the directory containing the packages being linked to\&.When you specify an absolute link, you usually use an HTTP link\&. However, if you want to link to a file system that has no web server, then you can use a file link\&. Use a file link only when everyone who wants to access the generated documentation shares the same file system\&.In all cases, and on all operating systems, use a slash as the separator, whether the URL is absolute or relative, and \f3h\fR\f3ttp:\fR or \f3f\fR\f3ile:\fR as specified in the URL Memo: Uniform Resource Locators at http://www\&.ietf\&.org/rfc/rfc1738\&.txt +.sp +.nf +\f3\-link http://<host>/<directory>/<directory>/\&.\&.\&./<name>\fP +.fi +.nf +\f3\-link file://<host>/<directory>/<directory>/\&.\&.\&./<name>\fP +.fi +.nf +\f3\-link <directory>/<directory>/\&.\&.\&./<name>\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Differences between the -linkoffline and -link options + +Use the \f3-link\fR option in the following cases: +.TP 0.2i +\(bu +When you use a relative path to the external API document\&. +.TP 0.2i +\(bu +When you use an absolute URL to the external API document if your shell lets you open a connection to that URL for reading\&. +.PP +Use the \f3-linkoffline\fR option when you use an absolute URL to the external API document, if your shell does not allow a program to open a connection to that URL for reading\&. This can occur when you are behind a firewall and the document you want to link to is on the other side\&. +.PP +\f3Example 1 Absolute Link to External Documents\fR +.PP +Use the following command if you want to link to the \f3java\&.lang\fR, \f3java\&.io\fR and other Java platform packages, shown at http://docs\&.oracle\&.com/javase/8/docs/api/index\&.html +.sp +.nf +\f3javadoc \-link http://docs\&.oracle\&.com/javase/8/docs/api/ com\&.mypackage\fP +.fi +.nf +\f3\fP +.fi +.sp +The command generates documentation for the package \f3com\&.mypackage\fR with links to the Java SE packages\&. The generated documentation contains links to the \f3Object\fR class, for example, in the class \f3trees\fR\&. Other options, such as the \f3-sourcepath\fR and \f3-d\fR options, are not shown\&. +.PP +\f3Example 2 Relative Link to External Documents\fR +.PP +In this example, there are two packages with documents that are generated in different runs of the \f3javadoc\fR command, and those documents are separated by a relative path\&. The packages are \f3com\&.apipackage\fR, an API, and c\f3om\&.spipackage\fR, an Service Provide Interface (SPI)\&. You want the documentation to reside in docs/api/com/apipackage and docs/spi/com/spipackage\&. Assuming that the API package documentation is already generated, and that docs is the current directory, you document the SPI package with links to the API documentation by running: \f3javadoc -d \&./spi -link \&.\&./api com\&.spipackage\fR\&. +.PP +Notice the \f3-link\fR option is relative to the destination directory (docs/spi)\&. +.PP +Notes + +The \f3-link\fR option lets you link to classes referenced to by your code, but not documented in the current \f3javadoc\fR command run\&. For these links to go to valid pages, you must know where those HTML pages are located and specify that location with \f3extdocURL\fR\&. This allows third-party documentation to link to java\&.* documentation at http://docs\&.oracle\&.com\&.Omit the \f3-link\fR option when you want the \f3javadoc\fR command to create links only to APIs within the documentation it is generating in the current run\&. Without the \f3-link\fR option, the \f3javadoc\fR command does not create links to documentation for external references because it does not know whether or where that documentation exists\&.The \f3-link\fR option can create links in several places in the generated documentation\&. See Process Source Files\&. Another use is for cross-links between sets of packages: Execute the \f3javadoc\fR command on one set of packages, then run the \f3javadoc\fR command again on another set of packages, creating links both ways between both sets\&. +.PP +How to Reference a Class + +For a link to an externally referenced class to appear (and not just its text label), the class must be referenced in the following way\&. It is not sufficient for it to be referenced in the body of a method\&. It must be referenced in either an \f3import\fR statement or in a declaration\&. Here are examples of how the class \f3java\&.io\&.File\fR can be referenced: +.PP +\fI\fRIn any kind of import statement\&. By wildcard import, import explicitly by name, or automatically import for \f3java\&.lang\&.*\fR\&. +.PP +In Java SE 1\&.3\&.\fIn\fR and 1\&.2\&.\fIn\fR, only an explicit import by name works\&. A wildcard \f3import\fR statement does not work, nor does the automatic \f3import java\&.lang\&.*\fR\&. +.PP +\fI\fRIn a declaration: \f3void mymethod(File f) {}\fR +.PP +The reference can be in the return type or parameter type of a method, constructor, field, class, or interface, or in an implements, extends, or throws statement\&. +.PP +An important corollary is that when you use the \f3-link\fR option, there can be many links that unintentionally do not appear due to this constraint\&. The text would appear without being a link\&. You can detect these by the warnings they emit\&. The simplest way to properly reference a class and add the link would be to import that class\&. +.PP +Package List + +The \f3-link\fR option requires that a file named package-list, which is generated by the \f3javadoc\fR command, exists at the URL you specify with the \f3-link\fR option\&. The package-list file is a simple text file that lists the names of packages documented at that location\&. In the earlier example, the \f3javadoc\fR command searches for a file named package-list at the specified URL, reads in the package names, and links to those packages at that URL\&. +.PP +For example, the package list for the Java SE API is located at http://docs\&.oracle\&.com/javase/8/docs/api/package-list +.PP +The package list starts as follows: +.sp +.nf +\f3java\&.applet\fP +.fi +.nf +\f3java\&.awt\fP +.fi +.nf +\f3java\&.awt\&.color\fP +.fi +.nf +\f3java\&.awt\&.datatransfer\fP +.fi +.nf +\f3java\&.awt\&.dnd\fP +.fi +.nf +\f3java\&.awt\&.event\fP +.fi +.nf +\f3java\&.awt\&.font\fP +.fi +.nf +\f3and so on \&.\&.\&.\&.\fP +.fi +.nf +\f3\fP +.fi +.sp +When \f3javadoc\fR is run without the \f3-link\fR option and encounters a name that belongs to an externally referenced class, it prints the name with no link\&. However, when the \f3-link\fR option is used, the \f3javadoc\fR command searches the package-list file at the specified \fIextdocURL\fR location for that package name\&. When it finds the package name, it prefixes the name with \fIextdocURL\fR\&. +.PP +For there to be no broken links, all of the documentation for the external references must exist at the specified URLs\&. The \f3javadoc\fR command does not check that these pages exist, but only that the package-list exists\&. +.PP +Multiple Links + +You can supply multiple \f3-link\fR options to link to any number of externally generated documents\&. Javadoc 1\&.2 has a known bug that prevents you from supplying more than one \f3-link\fR options\&. This was fixed in Javadoc 1\&.2\&.2\&. Specify a different link option for each external document to link to \f3javadoc -link extdocURL1 -link extdocURL2 \&.\&.\&. -link extdocURLn com\&.mypackage\fR where \fIextdocURL1\fR, \fIextdocURL2\fR, \&.\f3\&.\&. extdocURLn\fR point respectively to the roots of external documents, each of which contains a file named package-list\&. +.PP +Cross Links + +Note that bootstrapping might be required when cross-linking two or more documents that were previously generated\&. If package-list does not exist for either document when you run the \f3javadoc\fR command on the first document, then the package-list does not yet exist for the second document\&. Therefore, to create the external links, you must regenerate the first document after you generate the second document\&. +.PP +In this case, the purpose of first generating a document is to create its package-list (or you can create it by hand if you are certain of the package names)\&. Then, generate the second document with its external links\&. The \f3javadoc\fR command prints a warning when a needed external package-list file does not exist\&. +.TP +-linkoffline \fIextdocURL packagelistLoc\fR +.br +This option is a variation of the \f3-link\fR option\&. They both create links to Javadoc-generated documentation for externally referenced classes\&. Use the \f3-link\fRo\f3ffline\fR option when linking to a document on the web when the \f3javadoc\fR command cannot access the document through a web connection\&. Use the \f3-linkoffline\fR option when package-list file of the external document is not accessible or does not exist at the \f3extdocURL\fR location, but does exist at a different location that can be specified by \f3packageListLoc\fR (typically local)\&. If \f3extdocURL\fR is accessible only on the World Wide Web, then the \f3-linkoffline\fR option removes the constraint that the \f3javadoc\fR command must have a web connection to generate documentation\&. Another use is as a work-around to update documents: After you have run the \f3javadoc\fR command on a full set of packages, you can run the \f3javadoc\fR command again on a smaller set of changed packages, so that the updated files can be inserted back into the original set\&. Examples follow\&. The \f3-linkoffline\fR option takes two arguments\&. The first is for the string to be embedded in the \f3<a href>\fR links, and the second tells the \f3-linkoffline\fR option where to find package-list: +.RS +.TP 0.2i +\(bu +The \f3extdocURL\fR value is the absolute or relative URL of the directory that contains the external Javadoc-generated documentation you want to link to\&. When relative, the value should be the relative path from the destination directory (specified with the \f3-d\fR option) to the root of the packages being linked to\&. For more information, see \fIextdocURL\fR in the \f3-link\fR option\&. +.TP 0.2i +\(bu +The \f3packagelistLoc\fR value is the path or URL to the directory that contains the package-list file for the external documentation\&. This can be a URL (http: or file:) or file path, and can be absolute or relative\&. When relative, make it relative to the current directory from where the \f3javadoc\fR command was run\&. Do not include the package-list file name\&. + +You can specify multiple \f3-linkoffline\fR options in a specified \f3javadoc\fR command run\&. Before Javadoc 1\&.2\&.2, the \f3-linkfile\fR options could be specified once\&. +.RE + +.PP +Absolute Links to External Documents + +You might have a situation where you want to link to the \f3java\&.lang\fR, \f3java\&.io\fR and other Java SE packages at http://docs\&.oracle\&.com/javase/8/docs/api/index\&.html +.PP +However, your shell does not have web access\&. In this case, do the following: +.TP 0.4i +1\&. +Open the package-list file in a browser at http://docs\&.oracle\&.com/javase/8/docs/api/package-list +.TP 0.4i +2\&. +Save the file to a local directory, and point to this local copy with the second argument, \f3packagelistLoc\fR\&. In this example, the package list file was saved to the current directory (\&.)\&. +.PP +The following command generates documentation for the package c\f3om\&.mypackage\fR with links to the Java SE packages\&. The generated documentation will contain links to the \f3Object\fR class, for example, in the class \f3trees\fR\&. Other necessary options, such as \f3-sourcepath\fR, are not shown\&. +.sp +.nf +\f3javadoc \-linkoffline http://docs\&.oracle\&.com/javase/8/docs/api/ \&. com\&.mypackage \fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Relative Links to External Documents + +It is not very common to use \f3-linkoffline\fR with relative paths, for the simple reason that the \f3-link\fR option is usually enough\&. When you use the \f3-linkoffline\fR option, the package-list file is usually local, and when you use relative links, the file you are linking to is also local, so it is usually unnecessary to give a different path for the two arguments to the \f3-linkoffline\fR option When the two arguments are identical, you can use the \f3-link\fR option\&. +.PP +Create a package-list File Manually + +If a package-list file does not exist yet, but you know what package names your document will link to, then you can manually create your own copy of this file and specify its path with \f3packagelistLoc\fR\&. An example would be the previous case where the package list for \f3com\&.spipackage\fR did not exist when \f3com\&.apipackage\fR was first generated\&. This technique is useful when you need to generate documentation that links to new external documentation whose package names you know, but which is not yet published\&. This is also a way of creating package-list files for packages generated with Javadoc 1\&.0 or 1\&.1, where package-list files were not generated\&. Similarly, two companies can share their unpublished package-list files so they can release their cross-linked documentation simultaneously\&. +.PP +Link to Multiple Documents + +You can include the \f3-linkoffline\fR option once for each generated document you want to refer to: +.sp +.nf +\f3javadoc \-linkoffline extdocURL1 packagelistLoc1 \-linkoffline extdocURL2\fP +.fi +.nf +\f3packagelistLoc2 \&.\&.\&.\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Update Documents + +You can also use the \f3-linkoffline\fR option when your project has dozens or hundreds of packages\&. If you have already run the \f3javadoc\fR command on the entire source tree, then you can quickly make small changes to documentation comments and rerun the \f3javadoc\fR command on a portion of the source tree\&. Be aware that the second run works properly only when your changes are to documentation comments and not to declarations\&. If you were to add, remove, or change any declarations from the source code, then broken links could show up in the index, package tree, inherited member lists, Use page, and other places\&. +.PP +First, create a new destination directory, such as update, for this new small run\&. In this example, the original destination directory is named html\&. In the simplest example, change directory to the parent of html\&. Set the first argument of the \f3-linkoffline\fR option to the current directory (\&.) and set the second argument to the relative path to html, where it can find package-list and pass in only the package names of the packages you want to update: +.sp +.nf +\f3javadoc \-d update \-linkoffline \&. html com\&.mypackage\fP +.fi +.nf +\f3\fP +.fi +.sp +When the \f3javadoc\fR command completes, copy these generated class pages in update/com/package (not the overview or index) to the original files in html/com/package\&. +.TP +-linksource +.br +Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation\&. Links are created for classes, interfaces, constructors, methods, and fields whose declarations are in a source file\&. Otherwise, links are not created, such as for default constructors and generated classes\&. + +This option exposes all private implementation details in the included source files, including private classes, private fields, and the bodies of private methods, regardless of the \f3-public\fR, \f3-package\fR, \f3-protected\fR, and \f3-private\fR options\&. Unless you also use the \f3-private\fR option, not all private classes or interfaces are accessible through links\&. + +Each link appears on the name of the identifier in its declaration\&. For example, the link to the source code of the \f3Button\fR class would be on the word \f3Button\fR: +.sp +.nf +\f3public class Button extends Component implements Accessible\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The link to the source code of the \f3getLabel\fR method in the \f3Button\fR class is on the word \f3getLabel\fR: +.sp +.nf +\f3public String getLabel()\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-group groupheading \fIpackagepattern:packagepattern\fR +.br +Separates packages on the overview page into whatever groups you specify, one group per table\&. You specify each group with a different \f3-group\fR option\&. The groups appear on the page in the order specified on the command line\&. Packages are alphabetized within a group\&. For a specified \f3-group\fR option, the packages matching the list of \f3packagepattern\fR expressions appear in a table with the heading \fIgroupheading\fR\&. +.RS +.TP 0.2i +\(bu +The \f3groupheading\fR can be any text and can include white space\&. This text is placed in the table heading for the group\&. +.TP 0.2i +\(bu +The \f3packagepattern\fR value can be any package name at the start of any package name followed by an asterisk (*)\&. The asterisk is the only wildcard allowed and means match any characters\&. Multiple patterns can be included in a group by separating them with colons (:)\&. If you use an asterisk in a pattern or pattern list, then the pattern list must be inside quotation marks, such as \f3"java\&.lang*:java\&.util"\fR\&. +.RE + + +When you do not supply a \f3-group\fR option, all packages are placed in one group with the heading \fIPackages\fR and appropriate subheadings\&. If the subheadings do not include all documented packages (all groups), then the remaining packages appear in a separate group with the subheading Other Packages\&. + +For example, the following \f3javadoc\fR command separates the three documented packages into \fICore\fR, \fIExtension\fR, and \fIOther Packages\fR\&. The trailing dot (\&.) does not appear in \f3java\&.lang*\fR\&. Including the dot, such as \f3java\&.lang\&.*\fR omits the\f3java\&.lang\fR package\&. +.sp +.nf +\f3javadoc \-group "Core Packages" "java\&.lang*:java\&.util"\fP +.fi +.nf +\f3 \-group "Extension Packages" "javax\&.*"\fP +.fi +.nf +\f3 java\&.lang java\&.lang\&.reflect java\&.util javax\&.servlet java\&.new\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fICore Packages\fR + +\f3java\&.lang\fR + +\f3java\&.lang\&.reflect\fR + +\f3java\&.util\fR + +\fIExtension Packages\fR + +\f3javax\&.servlet\fR + +\fIOther Packages\fR + +\f3java\&.new\fR +.TP +-nodeprecated +.br +Prevents the generation of any deprecated API in the documentation\&. This does what the \f3-nodeprecatedlist\fR option does, and it does not generate any deprecated API throughout the rest of the documentation\&. This is useful when writing code when you do not want to be distracted by the deprecated code\&. +.TP +-nodeprecatedlist +.br +Prevents the generation of the file that contains the list of deprecated APIs (deprecated-list\&.html) and the link in the navigation bar to that page\&. The \f3javadoc\fR command continues to generate the deprecated API throughout the rest of the document\&. This is useful when your source code contains no deprecated APIs, and you want to make the navigation bar cleaner\&. +.TP +-nosince +.br +Omits from the generated documents the \f3Since\fR sections associated with the \f3@since\fR tags\&. +.TP +-notree +.br +Omits the class/interface hierarchy pages from the generated documents\&. These are the pages you reach using the Tree button in the navigation bar\&. The hierarchy is produced by default\&. +.TP +-noindex +.br +Omits the index from the generated documents\&. The index is produced by default\&. +.TP +-nohelp +.br +Omits the HELP link in the navigation bars at the top and bottom of each page of output\&. +.TP +-nonavbar +.br +Prevents the generation of the navigation bar, header, and footer, that are usually found at the top and bottom of the generated pages\&. The \f3-nonavbar\fR option has no affect on the \f3-bottom\fR option\&. The \f3-nonavbar\fR option is useful when you are interested only in the content and have no need for navigation, such as when you are converting the files to PostScript or PDF for printing only\&. +.TP +-helpfile \fIpath\efilename\fR +.br +Specifies the path of an alternate help file path\efilename that the HELP link in the top and bottom navigation bars link to\&. Without this option, the \f3javadoc\fR command creates a help file help-doc\&.html that is hard-coded in the \f3javadoc\fR command\&. This option lets you override the default\&. The file name can be any name and is not restricted to help-doc\&.html\&. The \f3javadoc\fR command adjusts the links in the navigation bar accordingly, for example: +.sp +.nf +\f3javadoc \-helpfile /home/user/myhelp\&.html java\&.awt\&.\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-stylesheet \fIpath/filename\fR +.br +Specifies the path of an alternate HTML stylesheet file\&. Without this option, the \f3javadoc\fR command automatically creates a stylesheet file stylesheet\&.css that is hard-coded in the \f3javadoc\fR command\&. This option lets you override the default\&. The file name can be any name and is not restricted to stylesheet\&.css, for example: +.sp +.nf +\f3javadoc \-stylesheet file /home/user/mystylesheet\&.css com\&.mypackage\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-serialwarn +.br +Generates compile-time warnings for missing \f3@serial\fR tags\&. By default, Javadoc 1\&.2\&.2 and later versions generate no serial warnings\&. This is a reversal from earlier releases\&. Use this option to display the serial warnings, which helps to properly document default serializable fields and \f3writeExternal\fR methods\&. +.TP +-charset \fIname\fR +.br +Specifies the HTML character set for this document\&. The name should be a preferred MIME name as specified in the IANA Registry, Character Sets at http://www\&.iana\&.org/assignments/character-sets + +For example, \f3javadoc -charset "iso-8859-1" mypackage\fR inserts the following line in the head of every generated page: +.sp +.nf +\f3<META http\-equiv="Content\-Type" content="text/html; charset=ISO\-8859\-1">\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This \f3META\fR tag is described in the HTML standard (4197265 and 4137321), HTML Document Representation, at http://www\&.w3\&.org/TR/REC-html40/charset\&.html#h-5\&.2\&.2 + +See also the \f3-encoding\fR and \f3-docencoding name\fR options\&. +.TP +-docencoding \fIname\fR +.br +Specifies the encoding of the generated HTML files\&. The name should be a preferred MIME name as specified in the IANA Registry, Character Sets at http://www\&.iana\&.org/assignments/character-sets + +If you omit the \f3-docencoding\fR option but use the \f3-encoding\fR option, then the encoding of the generated HTML files is determined by the \f3-encoding\fR option, for example: \f3javadoc -docencoding "iso-8859-1" mypackage\fR\&. See also the \f3-encoding\fR and \f3-docencoding name\fR options\&. +.TP +-keywords +.br +Adds HTML keyword <META> tags to the generated file for each class\&. These tags can help search engines that look for <META> tags find the pages\&. Most search engines that search the entire Internet do not look at <META> tags, because pages can misuse them\&. Search engines offered by companies that confine their searches to their own website can benefit by looking at <META> tags\&. The <META> tags include the fully qualified name of the class and the unqualified names of the fields and methods\&. Constructors are not included because they are identical to the class name\&. For example, the class \f3String\fR starts with these keywords: +.sp +.nf +\f3<META NAME="keywords" CONTENT="java\&.lang\&.String class">\fP +.fi +.nf +\f3<META NAME="keywords" CONTENT="CASE_INSENSITIVE_ORDER">\fP +.fi +.nf +\f3<META NAME="keywords" CONTENT="length()">\fP +.fi +.nf +\f3<META NAME="keywords" CONTENT="charAt()">\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-tag \fItagname\fR:Xaoptcmf:"\fItaghead\fR" +.br +Enables the \f3javadoc\fR command to interpret a simple, one-argument \f3@tagname\fR custom block tag in documentation comments\&. For the \f3javadoc\fR command to spell-check tag names, it is important to include a \f3-tag\fR option for every custom tag that is present in the source code, disabling (with \f3X\fR) those that are not being output in the current run\&.The colon (:) is always the separator\&. The \f3-tag\fR option outputs the tag heading \fItaghead\fR in bold, followed on the next line by the text from its single argument\&. Similar to any block tag, the argument text can contain inline tags, which are also interpreted\&. The output is similar to standard one-argument tags, such as the \f3@return\fR and \f3@author\fR tags\&. Omitting a value for \fItaghead\fR causes \f3tagname\fR to be the heading\&. + +\fIPlacement of tags\fR: The \f3Xaoptcmf\fR arguments determine where in the source code the tag is allowed to be placed, and whether the tag can be disabled (using \f3X\fR)\&. You can supply either \f3a\fR, to allow the tag in all places, or any combination of the other letters: + +\f3X\fR (disable tag) + +\f3a\fR (all) + +\f3o\fR (overview) + +\f3p\fR (packages) + +\f3t\fR (types, that is classes and interfaces) + +\f3c\fR (constructors) + +\f3m\fR (methods) + +\f3f\fR (fields) + +\fIExamples of single tags\fR: An example of a tag option for a tag that can be used anywhere in the source code is: \f3-tag todo:a:"To Do:"\fR\&. + +If you want the \f3@todo\fR tag to be used only with constructors, methods, and fields, then you use: \f3-tag todo:cmf:"To Do:"\fR\&. + +Notice the last colon (:) is not a parameter separator, but is part of the heading text\&. You would use either tag option for source code that contains the \f3@todo\fR tag, such as: \f3@todo The documentation for this method needs work\fR\&. + +\fIColons in tag names\fR: Use a backslash to escape a colon that you want to use in a tag name\&. Use the \f3-tag ejb\e\e:bean:a:"EJB Bean:"\fR option for the following documentation comment: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @ejb:bean\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fISpell-checking tag names\fR: Some developers put custom tags in the source code that they do not always want to output\&. In these cases, it is important to list all tags that are in the source code, enabling the ones you want to output and disabling the ones you do not want to output\&. The presence of \f3X\fR disables the tag, while its absence enables the tag\&. This gives the \f3javadoc\fR command enough information to know whether a tag it encounters is unknown, which is probably the results of a typographical error or a misspelling\&. The \f3javadoc\fR command prints a warning in these cases\&. You can add \f3X\fR to the placement values already present, so that when you want to enable the tag, you can simply delete the \f3X\fR\&. For example, if the \f3@todo\fR tag is a tag that you want to suppress on output, then you would use: \f3-tag todo:Xcmf:"To Do:"\fR\&. If you would rather keep it simple, then use this: \f3-tag todo:X\fR\&. The syntax \f3-tag todo:X\fR works even when the \f3@todo\fR tag is defined by a taglet\&. + +\fIOrder of tags\fR: The order of the \f3-ta\fR\f3g\fR and \f3-taglet\fR options determines the order the tags are output\&. You can mix the custom tags with the standard tags to intersperse them\&. The tag options for standard tags are placeholders only for determining the order\&. They take only the standard tag\&'s name\&. Subheadings for standard tags cannot be altered\&. This is illustrated in the following example\&.If the \f3-tag\fR option is missing, then the position of the \f3-tagle\fR\f3t\fR option determines its order\&. If they are both present, then whichever appears last on the command line determines its order\&. This happens because the tags and taglets are processed in the order that they appear on the command line\&. For example, if the \f3-taglet\fR and \f3-tag\fR options have the name \f3todo\fR value, then the one that appears last on the command line determines the order\&. + +\fIExample of a complete set of tags\fR: This example inserts To Do after Parameters and before Throws in the output\&. By using \f3X\fR, it also specifies that the \f3@example\fR tag might be encountered in the source code that should not be output during this run\&. If you use the \f3@argfile\fR tag, then you can put the tags on separate lines in an argument file similar to this (no line continuation characters needed): +.sp +.nf +\f3\-tag param\fP +.fi +.nf +\f3\-tag return\fP +.fi +.nf +\f3\-tag todo:a:"To Do:"\fP +.fi +.nf +\f3\-tag throws\fP +.fi +.nf +\f3\-tag see\fP +.fi +.nf +\f3\-tag example:X\fP +.fi +.nf +\f3\fP +.fi +.sp + + +When the \f3javadoc\fR command parses the documentation comments, any tag encountered that is neither a standard tag nor passed in with the \f3-tag\fR or \f3-taglet\fR options is considered unknown, and a warning is thrown\&. + +The standard tags are initially stored internally in a list in their default order\&. Whenever the \f3-tag\fR options are used, those tags get appended to this list\&. Standard tags are moved from their default position\&. Therefore, if a \f3-tag\fR option is omitted for a standard tag, then it remains in its default position\&. + +\fIAvoiding conflicts\fR: If you want to create your own namespace, then you can use a dot-separated naming convention similar to that used for packages: \f3com\&.mycompany\&.todo\fR\&. Oracle will continue to create standard tags whose names do not contain dots\&. Any tag you create will override the behavior of a tag by the same name defined by Oracle\&. If you create a \f3@todo\fR tag or taglet, then it always has the same behavior you define, even when Oracle later creates a standard tag of the same name\&. + +\fIAnnotations vs\&. Javadoc tags\fR: In general, if the markup you want to add is intended to affect or produce documentation, then it should be a Javadoc tag\&. Otherwise, it should be an annotation\&. See Custom Tags and Annotations in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#annotations + +You can also create more complex block tags or custom inline tags with the \f3-taglet\fR option\&. +.TP +-taglet \fIclass\fR +.br +Specifies the class file that starts the taglet used in generating the documentation for that tag\&. Use the fully qualified name for the \f3class\fR value\&. This taglet also defines the number of text arguments that the custom tag has\&. The taglet accepts those arguments, processes them, and generates the output\&. For extensive documentation with example taglets, see: Taglet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/taglet/overview\&.html + +Taglets are useful for block or inline tags\&. They can have any number of arguments and implement custom behavior, such as making text bold, formatting bullets, writing out the text to a file, or starting other processes\&. Taglets can only determine where a tag should appear and in what form\&. All other decisions are made by the doclet\&. A taglet cannot do things such as remove a class name from the list of included classes\&. However, it can execute side effects, such as printing the tag\&'s text to a file or triggering another process\&. Use the \f3-tagletpath\fR option to specify the path to the taglet\&. The following example inserts the To Do taglet after Parameters and ahead of Throws in the generated pages\&. Alternately, you can use the \f3-taglet\fR option in place of its \f3-tag\fR option, but that might be difficult to read\&. +.sp +.nf +\f3\-taglet com\&.sun\&.tools\&.doclets\&.ToDoTaglet\fP +.fi +.nf +\f3\-tagletpath /home/taglets \fP +.fi +.nf +\f3\-tag return\fP +.fi +.nf +\f3\-tag param\fP +.fi +.nf +\f3\-tag todo\fP +.fi +.nf +\f3\-tag throws\fP +.fi +.nf +\f3\-tag see\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-tagletpath \fItagletpathlist\fR +.br +Specifies the search paths for finding taglet class files\&. The \f3tagletpathlist\fR can contain multiple paths by separating them with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. +.TP +-docfilesubdirs +.br +Enables deep copying of doc-files directories\&. Subdirectories and all contents are recursively copied to the destination\&. For example, the directory doc-files/example/images and all of its contents would be copied\&. There is also an option to exclude subdirectories\&. +.TP +-excludedocfilessubdir \fIname1:name2\fR +.br +Excludes any doc-files subdirectories with the specified names\&. This prevents the copying of SCCS and other source-code-control subdirectories\&. +.TP +-noqualifier all | \fIpackagename1\fR:\fIpackagename2\&.\&.\&.\fR +.br +Omits qualifying package names from class names in output\&. The argument to the \f3-noqualifier\fR option is either \f3all\fR (all package qualifiers are omitted) or a colon-separate list of packages, with wild cards, to be removed as qualifiers\&. The package name is removed from places where class or interface names appear\&. See Process Source Files\&. + +The following example omits all package qualifiers: \f3-noqualifier all\fR\&. + +The following example omits \f3java\&.lang\fR and \f3java\&.io\fR package qualifiers: \f3-noqualifier java\&.lang:java\&.io\fR\&. + +The following example omits package qualifiers starting with \f3java\fR, and \f3com\&.sun\fR subpackages, but not \f3javax\fR: \f3-noqualifier java\&.*:com\&.sun\&.*\fR\&. + +Where a package qualifier would appear due to the previous behavior, the name can be suitably shortened\&. See How a Name Appears\&. This rule is in effect whether or not the \f3-noqualifier\fR option is used\&. +.TP +-notimestamp +.br +Suppresses the time stamp, which is hidden in an HTML comment in the generated HTML near the top of each page\&. The \f3-notimestamp\fR option is useful when you want to run the \f3javadoc\fR command on two source bases and get the differences between \f3diff\fR them, because it prevents time stamps from causing a \f3diff\fR (which would otherwise be a \f3diff\fR on every page)\&. The time stamp includes the \f3javadoc\fR command release number, and currently appears similar to this: \f3<!-- Generated by javadoc (build 1\&.5\&.0_01) on Thu Apr 02 14:04:52 IST 2009 -->\fR\&. +.TP +-nocomment +.br +Suppresses the entire comment body, including the main description and all tags, and generate only declarations\&. This option lets you reuse source files that were originally intended for a different purpose so that you can produce skeleton HTML documentation at the early stages of a new project\&. +.TP +-sourcetab \fItablength\fR +.br +Specifies the number of spaces each tab uses in the source\&. +.SH COMMAND-LINE\ ARGUMENT\ FILES +To shorten or simplify the \f3javadoc\fR command, you can specify one or more files that contain arguments to the \f3javadoc\fR command (except \f3-J\fR options)\&. This enables you to create \f3javadoc\fR commands of any length on any operating system\&. +.PP +An argument file can include \f3javac\fR options and source file names in any combination\&. The arguments within a file can be space-separated or newline-separated\&. If a file name contains embedded spaces, then put the whole file name in double quotation marks\&. +.PP +File Names within an argument file are relative to the current directory, not the location of the argument file\&. Wild cards (\f3*\fR) are not allowed in these lists (such as for specifying *\&.java)\&. Using the at sign (@) to recursively interpret files is not supported\&. The \f3-J\fR options are not supported because they are passed to the launcher, which does not support argument files\&. +.PP +When you run the \f3javadoc\fR command, pass in the path and name of each argument file with the @ leading character\&. When the \f3javadoc\fR command encounters an argument beginning with the at sign (@), it expands the contents of that file into the argument list\&. +.PP +\f3Example 1 Single Argument File\fR +.PP +You could use a single argument file named \f3argfile\fR to hold all \f3javadoc\fR command arguments: \f3javadoc @argfile\fR\&. The argument file \f3\fRcontains the contents of both files, as shown in the next example\&. +.PP +\f3Example 2 Two Argument Files\fR +.PP +You can create two argument files: One for the \f3javadoc\fR command options and the other for the package names or source file names\&. Notice the following lists have no line-continuation characters\&. +.PP +Create a file named options that contains: +.sp +.nf +\f3\-d docs\-filelist \fP +.fi +.nf +\f3\-use \fP +.fi +.nf +\f3\-splitindex\fP +.fi +.nf +\f3\-windowtitle \&'Java SE 7 API Specification\&'\fP +.fi +.nf +\f3\-doctitle \&'Java SE 7 API Specification\&'\fP +.fi +.nf +\f3\-header \&'<b>Java\(tm SE 7</b>\&'\fP +.fi +.nf +\f3\-bottom \&'Copyright © 1993\-2011 Oracle and/or its affiliates\&. All rights reserved\&.\&'\fP +.fi +.nf +\f3\-group "Core Packages" "java\&.*"\fP +.fi +.nf +\f3\-overview /java/pubs/ws/1\&.7\&.0/src/share/classes/overview\-core\&.html\fP +.fi +.nf +\f3\-sourcepath /java/pubs/ws/1\&.7\&.0/src/share/classes\fP +.fi +.nf +\f3\fP +.fi +.sp +Create a file named packages that contains: +.sp +.nf +\f3com\&.mypackage1\fP +.fi +.nf +\f3com\&.mypackage2\fP +.fi +.nf +\f3com\&.mypackage3\fP +.fi +.nf +\f3\fP +.fi +.sp +Run the \f3javadoc\fR command as follows: +.sp +.nf +\f3javadoc @options @packages\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 3 Argument Files with Paths\fR +.PP +The argument files can have paths, but any file names inside the files are relative to the current working directory (not \f3path1\fR or \f3path2\fR): +.sp +.nf +\f3javadoc @path1/options @path2/packages\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 4 Option Arguments\fR +.PP +The following example saves an argument to a \f3javadoc\fR command option in an argument file\&. The \f3-bottom\fR option is used because it can have a lengthy argument\&. You could create a file named bottom to contain the text argument: +.sp +.nf +\f3<font size="\-1">\fP +.fi +.nf +\f3 <a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP +.fi +.nf +\f3 Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&. <br/>\fP +.fi +.nf +\f3 Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP +.fi +.nf +\f3 Other names may be trademarks of their respective owners\&.</font>\fP +.fi +.nf +\f3\fP +.fi +.sp +Run the \f3javadoc\fR command as follows:\f3javadoc -bottom @bottom @packages\fR\&. +.PP +You can also include the \f3-bottom\fR option at the start of the argument file and run the \f3javadoc\fR command as follows: \f3javadoc @bottom @packages\fR\&. +.SH RUNNING\ THE\ JAVADOC\ COMMAND +The release number of the \f3javadoc\fR command can be determined with the \f3javadoc -J-version\fR option\&. The release number of the standard doclet appears in the output stream\&. It can be turned off with the \f3-quiet\fR option\&. +.PP +Use the public programmatic interface to call the \f3javadoc\fR command from within programs written in the Java language\&. This interface is in \f3com\&.sun\&.tools\&.javadoc\&.Main\fR (and the \f3javadoc\fR command is reentrant)\&. For more information, see The Standard Doclet at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/standard-doclet\&.html#runningprogrammatically +.PP +The following instructions call the standard HTML doclet\&. To call a custom doclet, use the \f3-doclet\fR and \f3-docletpath\fR options\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html +.SS SIMPLE\ EXAMPLES +You can run the \f3javadoc\fR command on entire packages or individual source files\&. Each package name has a corresponding directory name\&. +.PP +In the following examples, the source files are located at /home/src/java/awt/*\&.java\&. The destination directory is /home/html\&. +.PP +Document One or More Packages + +To document a package, the source files for that package must be located in a directory that has the same name as the package\&. +.PP +If a package name has several identifiers (separated by dots, such as \f3java\&.awt\&.color\fR), then each subsequent identifier must correspond to a deeper subdirectory (such as java/awt/color)\&. +.PP +You can split the source files for a single package among two such directory trees located at different places, as long as \f3-sourcepath\fR points to them both\&. For example, src1/java/awt/color and src2/java/awt/color\&. +.PP +You can run the \f3javadoc\fR command either by changing directories (with the \f3cd\fR command) or by using the \f3-sourcepath\fR option\&. The following examples illustrate both alternatives\&. +.PP +\f3Example 1 Recursive Run from One or More Packages\fR +.PP +This example uses \f3-sourcepath\fR so the \f3javadoc\fR command can be run from any directory and \f3-subpackages\fR (a new 1\&.4 option) for recursion\&. It traverses the subpackages of the java directory excluding packages rooted at \f3java\&.net\fR and \f3java\&.lang\fR\&. Notice this excludes \f3java\&.lang\&.ref\fR, a subpackage of \f3java\&.lang\fR\&. To also traverse down other package trees, append their names to the \f3-subpackages\fR argument, such as \f3java:javax:org\&.xml\&.sax\fR\&. +.sp +.nf +\f3javadoc \-d /home/html \-sourcepath /home/src \-subpackages java \-exclude\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 2 Change to Root and Run Explicit Packages\fR +.PP +Change to the parent directory of the fully qualified package\&. Then, run the \f3javadoc\fR command with the names of one or more packages that you want to document: +.sp +.nf +\f3cd /home/src/\fP +.fi +.nf +\f3javadoc \-d /home/html java\&.awt java\&.awt\&.event\fP +.fi +.nf +\f3\fP +.fi +.sp +To also traverse down other package trees, append their names to the \f3-subpackages\fR argument, such as j\f3ava:javax:org\&.xml\&.sax\fR\&. +.PP +\f3Example 3 Run from Any Directory on Explicit Packages in One Tree\fR +.PP +In this case, it does not matter what the current directory is\&. Run the \f3javadoc\fR command and use the \f3-sourcepath\fR option with the parent directory of the top-level package\&. Provide the names of one or more packages that you want to document: +.sp +.nf +\f3javadoc \-d /home/html \-sourcepath /home/src java\&.awt java\&.awt\&.event\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 4 Run from Any Directory on Explicit Packages in Multiple Trees\fR +.PP +Run the \f3javadoc\fR command and use the \f3-sourcepath\fR option with a colon-separated list of the paths to each tree\&'s root\&. Provide the names of one or more packages that you want to document\&. All source files for a specified package do not need to be located under a single root directory, but they must be found somewhere along the source path\&. +.sp +.nf +\f3javadoc \-d /home/html \-sourcepath /home/src1:/home/src2 java\&.awt java\&.awt\&.event\fP +.fi +.nf +\f3\fP +.fi +.sp +The result is that all cases generate HTML-formatted documentation for the \f3public\fR and \f3protected\fR classes and interfaces in packages j\f3ava\&.awt\fR and \f3java\&.awt\&.even\fRt and save the HTML files in the specified destination directory\&. Because two or more packages are being generated, the document has three HTML frames: one for the list of packages, another for the list of classes, and the third for the main class pages\&. +.PP +Document One or More Classes + +The second way to run the \f3javadoc\fR command is to pass one or more source files\&. You can run \f3javadoc\fR either of the following two ways: by changing directories (with the \f3cd\fR command) or by fully specifying the path to the source files\&. Relative paths are relative to the current directory\&. The \f3-sourcepath\fR option is ignored when passing source files\&. You can use command-line wild cards, such as an asterisk (*), to specify groups of classes\&. +.PP +\f3Example 1 Change to the Source Directory\fR +.PP +Change to the directory that holds the source files\&. Then run the \f3javadoc\fR command with the names of one or more source files you want to document\&. +.PP +This example generates HTML-formatted documentation for the classes \f3Button\fR, \f3Canvas,\fR and classes that begin with \f3Graphics\fR\&. Because source files rather than package names were passed in as arguments to the \f3javadoc\fR command, the document has two frames: one for the list of classes and the other for the main page\&. +.sp +.nf +\f3cd /home/src/java/awt\fP +.fi +.nf +\f3javadoc \-d /home/html Button\&.java Canvas\&.java Graphics*\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 2 Change to the Root Directory of the Package\fR +.PP +This is useful for documenting individual source files from different subpackages off of the same root\&. Change to the package root directory, and supply the source files with paths from the root\&. +.sp +.nf +\f3cd /home/src/\fP +.fi +.nf +\f3javadoc \-d /home/html java/awt/Button\&.java java/applet/Applet\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 3 Document Files from Any Directory\fR +.PP +In this case, it does not matter what the current directory is\&. Run the \f3javadoc\fR command with the absolute path (or path relative to the current directory) to the source files you want to document\&. +.sp +.nf +\f3javadoc \-d /home/html /home/src/java/awt/Button\&.java\fP +.fi +.nf +\f3/home/src/java/awt/Graphics*\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Document Packages and Classes + +You can document entire packages and individual classes at the same time\&. Here is an example that mixes two of the previous examples\&. You can use the \f3-sourcepath\fR option for the path to the packages but not for the path to the individual classes\&. +.sp +.nf +\f3javadoc \-d /home/html \-sourcepath /home/src java\&.awt\fP +.fi +.nf +\f3/home/src/java/applet/Applet\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS REAL-WORLD\ EXAMPLES +The following command-line and \f3makefile\fR versions of the \f3javadoc\fR command run on the Java platform APIs\&. It uses 180 MB of memory to generate the documentation for the 1500 (approximately) public and protected classes in the Java SE 1\&.2\&. Both examples use absolute paths in the option arguments, so that the same \f3javadoc\fR command can be run from any directory\&. +.PP +Command-Line Example + +The following command might be too long for some shells\&. You can use a command-line argument file (or write a shell script) to overcome this limitation\&. +.PP +In the example, \f3packages\fR is the name of a file that contains the packages to process, such as \f3java\&.applet\fR\f3java\&.lang\fR\&. None of the options should contain any newline characters between the single quotation marks\&. For example, if you copy and paste this example, then delete the newline characters from the \f3-bottom\fR option\&. +.sp +.nf +\f3javadoc \-sourcepath /java/jdk/src/share/classes \e\fP +.fi +.nf +\f3\-overview /java/jdk/src/share/classes/overview\&.html \e\fP +.fi +.nf +\f3\-d /java/jdk/build/api \e\fP +.fi +.nf +\f3\-use \e\fP +.fi +.nf +\f3\-splitIndex \e\fP +.fi +.nf +\f3\-windowtitle \&'Java Platform, Standard Edition 7 API Specification\&' \e\fP +.fi +.nf +\f3\-doctitle \&'Java Platform, Standard Edition 7 API Specification\&' \e\fP +.fi +.nf +\f3\-header \&'<b>Java\(tm SE 7</b>\&' \e\fP +.fi +.nf +\f3\-bottom \&'<font size="\-1">\fP +.fi +.nf +\f3<a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP +.fi +.nf +\f3Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&.<br/>\fP +.fi +.nf +\f3Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP +.fi +.nf +\f3Other names may be trademarks of their respective owners\&.</font>\&' \e\fP +.fi +.nf +\f3\-group "Core Packages" "java\&.*:com\&.sun\&.java\&.*:org\&.omg\&.*" \e\fP +.fi +.nf +\f3\-group "Extension Packages" "javax\&.*" \e\fP +.fi +.nf +\f3\-J\-Xmx180m \e \fP +.fi +.nf +\f3@packages\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Programmatic Interface + +The Javadoc Access API enables the user to invoke the Javadoc tool directly from a Java application without executing a new process\&. +.PP +For example, the following statements are equivalent to the command \f3javadoc -d /home/html -sourcepath /home/src -subpackages java -exclude java\&.net:java\&.lang com\&.example\fR: +.sp +.nf +\f3import javax\&.tools\&.DocumentationTool;\fP +.fi +.nf +\f3import javax\&.tools\&.ToolProvider;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class JavaAccessSample{\fP +.fi +.nf +\f3 public static void main(String[] args){\fP +.fi +.nf +\f3 DocumentationTool javadoc = ToolProvider\&.getSystemDocumentationTool();\fP +.fi +.nf +\f3 int rc = javadoc\&.run( null, null, null,\fP +.fi +.nf +\f3 "\-d", "/home/html",\fP +.fi +.nf +\f3 "\-sourcepath", "home/src",\fP +.fi +.nf +\f3 "\-subpackages", "java",\fP +.fi +.nf +\f3 "\-exclude", "java\&.net:java\&.lang",\fP +.fi +.nf +\f3 "com\&.example");\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.sp +The first three arguments of the \f3run\fR method specify input, standard output, and standard error streams\&. \f3Null\fR is the default value for \f3System\&.in\fR, \f3System\&.out\fR, and \f3System\&.err\fR, respectively\&. +.SS THE\ MAKEFILE\ EXAMPLE +This is an example of a GNU \f3makefile\fR\&. Single quotation marks surround \f3makefile\fR arguments\&. For an example of a Windows \f3makefile\fR, see the \f3makefiles\fR section of the Javadoc FAQ at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137483\&.html#makefiles +.sp +.nf +\f3javadoc \-sourcepath $(SRCDIR) \e /* Sets path for source files */\fP +.fi +.nf +\f3 \-overview $(SRCDIR)/overview\&.html \e /* Sets file for overview text */\fP +.fi +.nf +\f3 \-d /java/jdk/build/api \e /* Sets destination directory */\fP +.fi +.nf +\f3 \-use \e /* Adds "Use" files */\fP +.fi +.nf +\f3 \-splitIndex \e /* Splits index A\-Z */\fP +.fi +.nf +\f3 \-windowtitle $(WINDOWTITLE) \e /* Adds a window title */\fP +.fi +.nf +\f3 \-doctitle $(DOCTITLE) \e /* Adds a doc title */\fP +.fi +.nf +\f3 \-header $(HEADER) \e /* Adds running header text */\fP +.fi +.nf +\f3 \-bottom $(BOTTOM) \e /* Adds text at bottom */\fP +.fi +.nf +\f3 \-group $(GROUPCORE) \e /* 1st subhead on overview page */\fP +.fi +.nf +\f3 \-group $(GROUPEXT) \e /* 2nd subhead on overview page */\fP +.fi +.nf +\f3 \-J\-Xmx180m \e /* Sets memory to 180MB */\fP +.fi +.nf +\f3 java\&.lang java\&.lang\&.reflect \e /* Sets packages to document */\fP +.fi +.nf +\f3 java\&.util java\&.io java\&.net \e\fP +.fi +.nf +\f3 java\&.applet\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3WINDOWTITLE = \&'Java\(tm SE 7 API Specification\&'\fP +.fi +.nf +\f3DOCTITLE = \&'Java\(tm Platform Standard Edition 7 API Specification\&'\fP +.fi +.nf +\f3HEADER = \&'<b>Java\(tm SE 7</font>\&'\fP +.fi +.nf +\f3BOTTOM = \&'<font size="\-1">\fP +.fi +.nf +\f3 <a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP +.fi +.nf +\f3 Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&.<br/>\fP +.fi +.nf +\f3 Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP +.fi +.nf +\f3 Other names may be trademarks of their respective owners\&.</font>\&'\fP +.fi +.nf +\f3GROUPCORE = \&'"Core Packages" "java\&.*:com\&.sun\&.java\&.*:org\&.omg\&.*"\&'\fP +.fi +.nf +\f3GROUPEXT = \&'"Extension Packages" "javax\&.*"\&'\fP +.fi +.nf +\f3SRCDIR = \&'/java/jdk/1\&.7\&.0/src/share/classes\&'\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS NOTES +.TP 0.2i +\(bu +If you omit the \f3-windowtitle\fR option, then the \f3javadoc\fR command copies the document title to the window title\&. The \f3-windowtitle\fR option text is similar to the the \f3-doctitle\fR option, but without HTML tags to prevent those tags from appearing as raw text in the window title\&. +.TP 0.2i +\(bu +If you omit the \f3-footer\fR option, then the \f3javadoc\fR command copies the header text to the footer\&. +.TP 0.2i +\(bu +Other important options you might want to use, but were not needed in the previous example, are the \f3-classpath\fR and \f3-link\fR options\&. +.SH GENERAL\ TROUBLESHOOTING +.TP 0.2i +\(bu +The \f3javadoc\fR command reads only files that contain valid class names\&. If the \f3javadoc\fR command is not correctly reading the contents of a file, then verify that the class names are valid\&. See Process Source Files\&. +.TP 0.2i +\(bu +See the Javadoc FAQ for information about common bugs and for troubleshooting tips at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137483\&.html +.SH ERRORS\ AND\ WARNINGS +Error and warning messages contain the file name and line number to the declaration line rather than to the particular line in the documentation comment\&. +.PP +For example, this message \f3error: cannot read: Class1\&.java\fR means that the \f3javadoc\fR command is trying to load \f3Class1\&.jav\fR\f3a\fR in the current directory\&. The class name is shown with its path (absolute or relative)\&. +.SH ENVIRONMENT +.TP +CLASSPATH +\f3CLASSPATH\fR is the environment variable that provides the path that the \f3javadoc\fR command uses to find user class files\&. This environment variable is overridden by the \f3-classpath\fR option\&. Separate directories with a semicolon for Windows or a colon for Oracle Solaris\&. + +\fIWindows example\fR: \f3\&.;C:\eclasses;C:\ehome\ejava\eclasses\fR + +\fIOracle Solaris example\fR: \f3\&.:/home/classes:/usr/local/java/classes\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +javac(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jdb(1) +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +javap(1) +.SH RELATED\ DOCUMENTS +.TP 0.2i +\(bu +Javadoc Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/index\&.html +.TP 0.2i +\(bu +How Classes Are Found http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html +.TP 0.2i +\(bu +How to Write Doc Comments for the Javadoc Tool http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html +.TP 0.2i +\(bu +URL Memo, Uniform Resource Locators http://www\&.ietf\&.org/rfc/rfc1738\&.txt +.TP 0.2i +\(bu +HTML standard, HTML Document Representation (4197265 and 4137321) http://www\&.w3\&.org/TR/REC-html40/charset\&.html#h-5\&.2\&.2 +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/javah.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/javah.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,158 +1,158 @@ -'\" t -.\" Copyright (c) 1994, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Basic Tools -.\" Title: javah.1 -.\" -.if n .pl 99999 -.TH javah 1 "21 November 2013" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -javah \- Generates C header and source files from a Java class\&. -.SH SYNOPSIS -.sp -.nf - -\fBjavah\fR [ \fIoptions\fR ] f\fIully\-qualified\-class\-name \&.\&.\&.\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIfully-qualified-class-name\fR -The fully qualified location of the classes to be converted to C header and source files\&. -.SH DESCRIPTION -The \f3javah\fR command 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 \f3\&.h\fR file contains a \f3struct\fR definition with a layout that parallels the layout of the corresponding class\&. The fields in the \f3struct\fR correspond to instance variables in the class\&. -.PP -The name of the header file and the structure declared within it are derived from the name of the class\&. When the class passed to the \f3javah\fR command is inside a package, the package name is added to the beginning of both the header file name and the structure name\&. Underscores (_) are used as name delimiters\&. -.PP -By default the \f3javah\fR command creates a header file for each class listed on the command line and puts the files in the current directory\&. Use the \f3-stubs\fR option to create source files\&. Use the \f3-o\fR option to concatenate the results for all listed classes into a single file\&. -.PP -The Java Native Interface (JNI) does not require header information or stub files\&. The \f3javah\fR command can still be used to generate native method function prototypes needed for JNI-style native methods\&. The \f3javah\fR command produces JNI-style output by default and places the result in the \f3\&.h\fR file\&. -.SH OPTIONS -.TP --o \fIoutputfile\fR -.br -Concatenates the resulting header or source files for all the classes listed on the command line into an output file\&. Only one of \f3-o\fR or \f3-d\fR can be used\&. -.TP --d \fIdirectory\fR -.br -Sets the directory where the \f3javah\fR command saves the header files or the stub files\&. Only one of \f3-d\fR or \f3-o\fR can be used\&. -.TP --stubs -.br -Causes the \f3javah\fR command to generate C declarations from the Java object file\&. -.TP --verbose -.br -Indicates verbose output and causes the \f3javah\fR command to print a message to \f3stdout\fR about the status of the generated files\&. -.TP --help -.br -Prints a help message for \f3javah\fR usage\&. -.TP --version -.br -Prints \f3javah\fR command release information\&. -.TP --jni -.br -Causes the \f3javah\fR command to create an output file containing JNI-style native method function prototypes\&. This is the default output; use of \f3-jni\fR is optional\&. -.TP --classpath \fIpath\fR -.br -Specifies the path the \f3javah\fR command uses to look up classes\&. Overrides the default or the \f3CLASSPATH\fR environment variable when it is set\&. Directories are separated by colons on Oracle Solaris and semicolons on Windows\&. The general format for path is: - -\fIOracle Solaris\fR: - -\&.:\fIyour-path\fR - -Example: \f3\&.:/home/avh/classes:/usr/local/java/classes\fR - -\fIWindows\fR: - -\&.;\fIyour-path\fR - -Example: \f3\&.;C:\eusers\edac\eclasses;C:\etools\ejava\eclasses\fR - -As a special convenience, a class path element that contains a base name of * is considered equivalent to specifying a list of all the files in the directory with the extension \f3\&.jar\fR or \f3\&.JAR\fR\&. - -For example, if directory \f3mydir\fR contains \f3a\&.jar\fR and \f3b\&.JAR\fR, then the class path element \f3mydir/*\fR is expanded to a \f3A\fR\f3\&.jar:b\&.JAR\fR, except that the order of jar files is unspecified\&. All JAR files in the specified directory, including hidden ones, are included in the list\&. A class path entry that consists of * expands to a list of all the JAR files in the current directory\&. The \f3CLASSPATH\fR environment variable, where defined, is similarly expanded\&. Any class path wild card expansion occurs before the Java Virtual Machine (JVM) is started\&. A Java program will never see unexpanded wild cards except by querying the environment\&. For example, by calling \f3System\&.getenv("CLASSPATH")\fR\&. -.TP --bootclasspath \fIpath\fR -.br -Specifies the path from which to load bootstrap classes\&. By default, the bootstrap classes are the classes that implement the core Java platform located in \f3jre\elib\ert\&.jar\fR and several other JAR files\&. -.TP --old -.br -Specifies that old JDK 1\&.0-style header files should be generated\&. -.TP --force -.br -Specifies that output files should always be written\&. -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -javah(1) -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -jdb(1) -.TP 0.2i -\(bu -javap(1) -.TP 0.2i -\(bu -javadoc(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1994, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: javah.1 +.\" +.if n .pl 99999 +.TH javah 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +javah \- Generates C header and source files from a Java class\&. +.SH SYNOPSIS +.sp +.nf + +\fBjavah\fR [ \fIoptions\fR ] f\fIully\-qualified\-class\-name \&.\&.\&.\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIfully-qualified-class-name\fR +The fully qualified location of the classes to be converted to C header and source files\&. +.SH DESCRIPTION +The \f3javah\fR command 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 \f3\&.h\fR file contains a \f3struct\fR definition with a layout that parallels the layout of the corresponding class\&. The fields in the \f3struct\fR correspond to instance variables in the class\&. +.PP +The name of the header file and the structure declared within it are derived from the name of the class\&. When the class passed to the \f3javah\fR command is inside a package, the package name is added to the beginning of both the header file name and the structure name\&. Underscores (_) are used as name delimiters\&. +.PP +By default the \f3javah\fR command creates a header file for each class listed on the command line and puts the files in the current directory\&. Use the \f3-stubs\fR option to create source files\&. Use the \f3-o\fR option to concatenate the results for all listed classes into a single file\&. +.PP +The Java Native Interface (JNI) does not require header information or stub files\&. The \f3javah\fR command can still be used to generate native method function prototypes needed for JNI-style native methods\&. The \f3javah\fR command produces JNI-style output by default and places the result in the \f3\&.h\fR file\&. +.SH OPTIONS +.TP +-o \fIoutputfile\fR +.br +Concatenates the resulting header or source files for all the classes listed on the command line into an output file\&. Only one of \f3-o\fR or \f3-d\fR can be used\&. +.TP +-d \fIdirectory\fR +.br +Sets the directory where the \f3javah\fR command saves the header files or the stub files\&. Only one of \f3-d\fR or \f3-o\fR can be used\&. +.TP +-stubs +.br +Causes the \f3javah\fR command to generate C declarations from the Java object file\&. +.TP +-verbose +.br +Indicates verbose output and causes the \f3javah\fR command to print a message to \f3stdout\fR about the status of the generated files\&. +.TP +-help +.br +Prints a help message for \f3javah\fR usage\&. +.TP +-version +.br +Prints \f3javah\fR command release information\&. +.TP +-jni +.br +Causes the \f3javah\fR command to create an output file containing JNI-style native method function prototypes\&. This is the default output; use of \f3-jni\fR is optional\&. +.TP +-classpath \fIpath\fR +.br +Specifies the path the \f3javah\fR command uses to look up classes\&. Overrides the default or the \f3CLASSPATH\fR environment variable when it is set\&. Directories are separated by colons on Oracle Solaris and semicolons on Windows\&. The general format for path is: + +\fIOracle Solaris\fR: + +\&.:\fIyour-path\fR + +Example: \f3\&.:/home/avh/classes:/usr/local/java/classes\fR + +\fIWindows\fR: + +\&.;\fIyour-path\fR + +Example: \f3\&.;C:\eusers\edac\eclasses;C:\etools\ejava\eclasses\fR + +As a special convenience, a class path element that contains a base name of * is considered equivalent to specifying a list of all the files in the directory with the extension \f3\&.jar\fR or \f3\&.JAR\fR\&. + +For example, if directory \f3mydir\fR contains \f3a\&.jar\fR and \f3b\&.JAR\fR, then the class path element \f3mydir/*\fR is expanded to a \f3A\fR\f3\&.jar:b\&.JAR\fR, except that the order of jar files is unspecified\&. All JAR files in the specified directory, including hidden ones, are included in the list\&. A class path entry that consists of * expands to a list of all the JAR files in the current directory\&. The \f3CLASSPATH\fR environment variable, where defined, is similarly expanded\&. Any class path wild card expansion occurs before the Java Virtual Machine (JVM) is started\&. A Java program will never see unexpanded wild cards except by querying the environment\&. For example, by calling \f3System\&.getenv("CLASSPATH")\fR\&. +.TP +-bootclasspath \fIpath\fR +.br +Specifies the path from which to load bootstrap classes\&. By default, the bootstrap classes are the classes that implement the core Java platform located in \f3jre\elib\ert\&.jar\fR and several other JAR files\&. +.TP +-old +.br +Specifies that old JDK 1\&.0-style header files should be generated\&. +.TP +-force +.br +Specifies that output files should always be written\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jdb(1) +.TP 0.2i +\(bu +javap(1) +.TP 0.2i +\(bu +javadoc(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/javap.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/javap.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/jcmd.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/jcmd.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/jconsole.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/jconsole.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,112 +1,112 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java Troubleshooting, Profiling, Monitoring and Management Tools -.\" Title: jconsole.1 -.\" -.if n .pl 99999 -.TH jconsole 1 "21 November 2013" "JDK 8" "Java Troubleshooting, Profiling, Monitoring and Management Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jconsole \- Starts a graphical console that lets you monitor and manage Java applications\&. -.SH SYNOPSIS -.sp -.nf - -\fBjconsole\fR [ \fIoptions\fR ] [ connection \&.\&.\&. ] -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -connection = \fIpid\fR | \fIhost\fR:\fIport\fR | \fIjmxURL\fR -The \f3pid\fR value is the process ID of a local Java Virtual Machine (JVM)\&. The JVM must be running with the same user ID as the user ID running the \f3jconsole\fR command\&.The \f3host:port\fR values are the name of the host system on which the JVM is running, and the port number specified by the system property \f3com\&.sun\&.management\&.jmxremote\&.port\fR when the JVM was started\&.The \f3jmxUrl\fR value is the address of the JMX agent to be connected to as described in JMXServiceURL\&. - -For more information about the \f3connection\fR parameter, see Monitoring and Management Using JMX Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/agent\&.html - -See also the \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html -.SH DESCRIPTION -The \f3jconsole\fR command starts a graphical console tool that lets you monitor and manage Java applications and virtual machines on a local or remote machine\&. -.PP -On Windows, the \f3jconsole\fR command does not associate with a console window\&. It does, however, display a dialog box with error information when the \f3jconsole\fR command fails\&. -.SH OPTIONS -.TP --interval\fI=n\fR -.br -Sets the update interval to \fIn\fR seconds (default is 4 seconds)\&. -.TP --notile -.br -Does not tile windows initially (for two or more connections)\&. -.TP --pluginpath \fIplugins\fR -.br -Specifies a list of directories or JAR files to be searched for \f3JConsole\fR plug-ins\&. The \fIplugins\fR path should contain a provider-configuration file named \f3META-INF/services/com\&.sun\&.tools\&.jconsole\&.JConsolePlugin\fR that contains one line for each plug-in\&. The line specifies the fully qualified class name of the class implementing the \f3com\&.sun\&.tools\&.jconsole\&.JConsolePlugin\fR class\&. -.TP --version -.br -Displays release information and exits\&. -.TP --help -.br -Displays a help message\&. -.TP --J\fIflag\fR -.br -Passes \f3flag\fR to the JVM on which the \f3jconsole\fR command is run\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -Using JConsole at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/jconsole\&.html -.TP 0.2i -\(bu -Monitoring and Management Using JMX Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/agent\&.html -.TP 0.2i -\(bu -The \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Troubleshooting, Profiling, Monitoring and Management Tools +.\" Title: jconsole.1 +.\" +.if n .pl 99999 +.TH jconsole 1 "21 November 2013" "JDK 8" "Java Troubleshooting, Profiling, Monitoring and Management Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jconsole \- Starts a graphical console that lets you monitor and manage Java applications\&. +.SH SYNOPSIS +.sp +.nf + +\fBjconsole\fR [ \fIoptions\fR ] [ connection \&.\&.\&. ] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +connection = \fIpid\fR | \fIhost\fR:\fIport\fR | \fIjmxURL\fR +The \f3pid\fR value is the process ID of a local Java Virtual Machine (JVM)\&. The JVM must be running with the same user ID as the user ID running the \f3jconsole\fR command\&.The \f3host:port\fR values are the name of the host system on which the JVM is running, and the port number specified by the system property \f3com\&.sun\&.management\&.jmxremote\&.port\fR when the JVM was started\&.The \f3jmxUrl\fR value is the address of the JMX agent to be connected to as described in JMXServiceURL\&. + +For more information about the \f3connection\fR parameter, see Monitoring and Management Using JMX Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/agent\&.html + +See also the \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html +.SH DESCRIPTION +The \f3jconsole\fR command starts a graphical console tool that lets you monitor and manage Java applications and virtual machines on a local or remote machine\&. +.PP +On Windows, the \f3jconsole\fR command does not associate with a console window\&. It does, however, display a dialog box with error information when the \f3jconsole\fR command fails\&. +.SH OPTIONS +.TP +-interval\fI=n\fR +.br +Sets the update interval to \fIn\fR seconds (default is 4 seconds)\&. +.TP +-notile +.br +Does not tile windows initially (for two or more connections)\&. +.TP +-pluginpath \fIplugins\fR +.br +Specifies a list of directories or JAR files to be searched for \f3JConsole\fR plug-ins\&. The \fIplugins\fR path should contain a provider-configuration file named \f3META-INF/services/com\&.sun\&.tools\&.jconsole\&.JConsolePlugin\fR that contains one line for each plug-in\&. The line specifies the fully qualified class name of the class implementing the \f3com\&.sun\&.tools\&.jconsole\&.JConsolePlugin\fR class\&. +.TP +-version +.br +Displays release information and exits\&. +.TP +-help +.br +Displays a help message\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR to the JVM on which the \f3jconsole\fR command is run\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +Using JConsole at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/jconsole\&.html +.TP 0.2i +\(bu +Monitoring and Management Using JMX Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/agent\&.html +.TP 0.2i +\(bu +The \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/jdb.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/jdb.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,270 +1,270 @@ -'\" t -.\" Copyright (c) 1995, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Basic Tools -.\" Title: jdb.1 -.\" -.if n .pl 99999 -.TH jdb 1 "21 November 2013" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jdb \- Finds and fixes bugs in Java platform programs\&. -.SH SYNOPSIS -.sp -.nf - -\fBjdb\fR [\fIoptions\fR] [\fIclassname\fR] [\fIarguments\fR] -.fi -.sp -.TP -\fIoptions\fR -Command-line options\&. See Options\&. -.TP -\fIclass\fRname -Name of the main class to debug\&. -.TP -\fIarguments\fR -Arguments passed to the \f3main()\fR method of the class\&. -.SH DESCRIPTION -The Java Debugger (JDB) is a simple command-line debugger for Java classes\&. The \f3jdb\fR command and its options call the JDB\&. The \f3jdb\fR command demonstrates the Java Platform Debugger Architecture (JDBA) and provides inspection and debugging of a local or remote Java Virtual Machine (JVM)\&. See Java Platform Debugger Architecture (JDBA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/jpda/index\&.html -.SS START\ A\ JDB\ SESSION -There are many ways to start a JDB session\&. The most frequently used way is to have JDB launch a new JVM with the main class of the application to be debugged\&. Do this by substituting the \f3jdb\fR command for the \f3java\fR command in the command line\&. For example, if your application\&'s main class is \f3MyClass\fR, then use the following command to debug it under JDB: -.sp -.nf -\f3jdb MyClass\fP -.fi -.nf -\f3\fP -.fi -.sp -When started this way, the \f3jdb\fR command calls a second JVM with the specified parameters, loads the specified class, and stops the JVM before executing that class\&'s first instruction\&. -.PP -Another way to use the \f3jdb\fR command is by attaching it to a JVM that is already running\&. Syntax for starting a JVM to which the \f3jdb\fR command attaches when the JVM is running is as follows\&. This loads in-process debugging libraries and specifies the kind of connection to be made\&. -.sp -.nf -\f3java \-agentlib:jdwp=transport=dt_socket,server=y,suspend=n MyClass\fP -.fi -.nf -\f3\fP -.fi -.sp -You can then attach the \f3jdb\fR command to the JVM with the following command: -.sp -.nf -\f3jdb \-attach 8000\fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3MyClass\fR argument is not specified in the \f3jdb\fR command line in this case because the \f3jdb\fR command is connecting to an existing JVM instead of launching a new JVM\&. -.PP -There are many other ways to connect the debugger to a JVM, and all of them are supported by the \f3jdb\fR command\&. The Java Platform Debugger Architecture has additional documentation on these connection options\&. -.SS BASIC\ JDB\ COMMANDS -The following is a list of the basic \f3jdb\fR commands\&. The JDB supports other commands that you can list with the \f3-help\fR option\&. -.TP -help or ? -The \f3help\fR or \f3?\fR commands display the list of recognized commands with a brief description\&. -.TP -run -After you start JDB and set breakpoints, you can use the \f3run\fR command to execute the debugged application\&. The \f3run\fR command is available only when the \f3jdb\fR command starts the debugged application as opposed to attaching to an existing JVM\&. -.TP -cont -Continues execution of the debugged application after a breakpoint, exception, or step\&. -.TP -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 dump command to find out how to get more information about an object\&. - -\fINote:\fR To display local variables, the containing class must have been compiled with the \f3javac -g\fR option\&. - -The \f3print\fR command supports many simple Java expressions including those with method invocations, for example: -.sp -.nf -\f3print MyClass\&.myStaticField\fP -.fi -.nf -\f3print myObj\&.myInstanceField\fP -.fi -.nf -\f3print i + j + k (i, j, k are primities and either fields or local variables)\fP -.fi -.nf -\f3print myObj\&.myMethod() (if myMethod returns a non\-null)\fP -.fi -.nf -\f3print new java\&.lang\&.String("Hello")\&.length()\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -dump -For primitive values, the \f3dump\fR command is identical to the \f3print\fR command\&. For objects, the \f3dump\fR command prints the current value of each field defined in the object\&. Static and instance fields are included\&. The \f3dump\fR command supports the same set of expressions as the \f3print\fR command\&. -.TP -threads -List the threads that are currently running\&. For each thread, its name and current status are printed and an index that can be used in other commands\&. In this example, the thread index is 4, the thread is an instance of \f3java\&.lang\&.Thread\fR, the thread name is \f3main\fR, and it is currently running\&. -.sp -.nf -\f34\&. (java\&.lang\&.Thread)0x1 main running\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -thread -Select a thread to be the current thread\&. Many \f3jdb\fR commands are based on the setting of the current thread\&. The thread is specified with the thread index described in the threads command\&. -.TP -where -The \f3where\fR command with no arguments dumps the stack of the current thread\&. The \f3where\fR\f3all\fR command dumps the stack of all threads in the current thread group\&. The \f3where\fR\f3threadindex\fR command dumps the stack of the specified thread\&. - -If the current thread is suspended either through an event such as a breakpoint or through the \f3suspend\fR command, then local variables and fields can be displayed with the \f3print\fR and \f3dump\fR commands\&. The \f3up\fR and \f3down\fR commands select which stack frame is the current stack frame\&. -.SS BREAKPOINTS -Breakpoints can be set in JDB at line numbers or at the first instruction of a method, for example: -.TP 0.2i -\(bu -The command \f3stop at MyClass:22\fR sets a breakpoint at the first instruction for line 22 of the source file containing \f3MyClass\fR\&. -.TP 0.2i -\(bu -The command \f3stop in java\&.lang\&.String\&.length\fR sets a breakpoint at the beginning of the method \f3java\&.lang\&.String\&.length\fR\&. -.TP 0.2i -\(bu -The command \f3stop in MyClass\&.<clinit>\fR uses \f3<clinit>\fR to identify the static initialization code for \f3MyClass\fR\&. -.PP -When a method is overloaded, you must also specify its argument types so that the proper method can be selected for a breakpoint\&. For example, \f3MyClass\&.myMethod(int,java\&.lang\&.String)\fR or \f3MyClass\&.myMethod()\fR\&. -.PP -The \f3clear\fR command removes breakpoints using the following syntax: \f3clear MyClass:45\fR\&. Using the \f3clear\fR or \f3stop\fR command with no argument displays a list of all breakpoints currently set\&. The \f3cont\fR command continues execution\&. -.SS STEPPING -The \f3step\fR command advances execution to the next line whether it is in the current stack frame or a called method\&. The \f3next\fR command advances execution to the next line in the current stack frame\&. -.SS EXCEPTIONS -When an exception occurs for which there is not a \f3catch\fR statement anywhere in the throwing thread\&'s call stack, the JVM typically prints an exception trace and exits\&. When running under JDB, however, control returns to JDB at the offending throw\&. You can then use the \f3jdb\fR command to diagnose the cause of the exception\&. -.PP -Use the \f3catch\fR command to cause the debugged application to stop at other thrown exceptions, for example: \f3catch java\&.io\&.FileNotFoundException\fR or \f3catch\fR\f3mypackage\&.BigTroubleException\fR\&. Any exception that is an instance of the specified class or subclass stops the application at the point where it is thrown\&. -.PP -The \f3ignore\fR command negates the effect of an earlier \f3catch\fR command\&. The \f3ignore\fR command does not cause the debugged JVM to ignore specific exceptions, but only to ignore the debugger\&. -.SH OPTIONS -When you use the \f3jdb\fR command instead of the \f3java\fR command on the command line, the \f3jdb\fR command accepts many of the same options as the \f3java\fR command, including \f3-D\fR, \f3-classpath\fR, and \f3-X\fR options\&. The following list contains additional options that are accepted by the \f3jdb\fR command\&. -.PP -Other options are supported to provide alternate mechanisms for connecting the debugger to the JVM it is to debug\&. For additional documentation about these connection alternatives, see Java Platform Debugger Architecture (JPDA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/jpda/index\&.html -.TP --help -.br -Displays a help message\&. -.TP --sourcepath \fIdir1:dir2: \&. \&. \&.\fR -.br -Uses the specified path to search for source files in the specified path\&. If this option is not specified, then use the default path of dot (\&.)\&. -.TP --attach \fIaddress\fR -.br -Attaches the debugger to a running JVM with the default connection mechanism\&. -.TP --listen \fIaddress\fR -.br -Waits for a running JVM to connect to the specified address with a standard connector\&. -.TP --launch -.br -Starts the debugged application immediately upon startup of JDB\&. The \f3-launch\fR option removes the need for the \f3run\fR command\&. The debugged application is launched and then stopped just before the initial application class is loaded\&. At that point, you can set any necessary breakpoints and use the \f3cont\fR command to continue execution\&. -.TP --listconnectors -.br -List the connectors available in this JVM\&. -.TP --connect connector-name:\fIname1=value1\fR -.br -Connects to the target JVM with the named connector and listed argument values\&. -.TP --dbgtrace [\fIflags\fR] -.br -Prints information for debugging the \f3jdb\fR command\&. -.TP --tclient -.br -Runs the application in the Java HotSpot VM client\&. -.TP --tserver -.br -Runs the application in the Java HotSpot VM server\&. -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the JVM, where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH OPTIONS\ FORWARDED\ TO\ THE\ DEBUGGER\ PROCESS -.TP --v -verbose[:\fIclass\fR|gc|jni] -.br -Turns on verbose mode\&. -.TP --D\fIname\fR=\fIvalue\fR -.br -Sets a system property\&. -.TP --classpath \fIdir\fR -.br -Lists directories separated by colons in which to look for classes\&. -.TP --X\fIoption\fR -.br -Nonstandard target JVM option\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -javac(1) -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -javah(1) -.TP 0.2i -\(bu -javap(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1995, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: jdb.1 +.\" +.if n .pl 99999 +.TH jdb 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jdb \- Finds and fixes bugs in Java platform programs\&. +.SH SYNOPSIS +.sp +.nf + +\fBjdb\fR [\fIoptions\fR] [\fIclassname\fR] [\fIarguments\fR] +.fi +.sp +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.TP +\fIclass\fRname +Name of the main class to debug\&. +.TP +\fIarguments\fR +Arguments passed to the \f3main()\fR method of the class\&. +.SH DESCRIPTION +The Java Debugger (JDB) is a simple command-line debugger for Java classes\&. The \f3jdb\fR command and its options call the JDB\&. The \f3jdb\fR command demonstrates the Java Platform Debugger Architecture (JDBA) and provides inspection and debugging of a local or remote Java Virtual Machine (JVM)\&. See Java Platform Debugger Architecture (JDBA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/jpda/index\&.html +.SS START\ A\ JDB\ SESSION +There are many ways to start a JDB session\&. The most frequently used way is to have JDB launch a new JVM with the main class of the application to be debugged\&. Do this by substituting the \f3jdb\fR command for the \f3java\fR command in the command line\&. For example, if your application\&'s main class is \f3MyClass\fR, then use the following command to debug it under JDB: +.sp +.nf +\f3jdb MyClass\fP +.fi +.nf +\f3\fP +.fi +.sp +When started this way, the \f3jdb\fR command calls a second JVM with the specified parameters, loads the specified class, and stops the JVM before executing that class\&'s first instruction\&. +.PP +Another way to use the \f3jdb\fR command is by attaching it to a JVM that is already running\&. Syntax for starting a JVM to which the \f3jdb\fR command attaches when the JVM is running is as follows\&. This loads in-process debugging libraries and specifies the kind of connection to be made\&. +.sp +.nf +\f3java \-agentlib:jdwp=transport=dt_socket,server=y,suspend=n MyClass\fP +.fi +.nf +\f3\fP +.fi +.sp +You can then attach the \f3jdb\fR command to the JVM with the following command: +.sp +.nf +\f3jdb \-attach 8000\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3MyClass\fR argument is not specified in the \f3jdb\fR command line in this case because the \f3jdb\fR command is connecting to an existing JVM instead of launching a new JVM\&. +.PP +There are many other ways to connect the debugger to a JVM, and all of them are supported by the \f3jdb\fR command\&. The Java Platform Debugger Architecture has additional documentation on these connection options\&. +.SS BASIC\ JDB\ COMMANDS +The following is a list of the basic \f3jdb\fR commands\&. The JDB supports other commands that you can list with the \f3-help\fR option\&. +.TP +help or ? +The \f3help\fR or \f3?\fR commands display the list of recognized commands with a brief description\&. +.TP +run +After you start JDB and set breakpoints, you can use the \f3run\fR command to execute the debugged application\&. The \f3run\fR command is available only when the \f3jdb\fR command starts the debugged application as opposed to attaching to an existing JVM\&. +.TP +cont +Continues execution of the debugged application after a breakpoint, exception, or step\&. +.TP +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 dump command to find out how to get more information about an object\&. + +\fINote:\fR To display local variables, the containing class must have been compiled with the \f3javac -g\fR option\&. + +The \f3print\fR command supports many simple Java expressions including those with method invocations, for example: +.sp +.nf +\f3print MyClass\&.myStaticField\fP +.fi +.nf +\f3print myObj\&.myInstanceField\fP +.fi +.nf +\f3print i + j + k (i, j, k are primities and either fields or local variables)\fP +.fi +.nf +\f3print myObj\&.myMethod() (if myMethod returns a non\-null)\fP +.fi +.nf +\f3print new java\&.lang\&.String("Hello")\&.length()\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +dump +For primitive values, the \f3dump\fR command is identical to the \f3print\fR command\&. For objects, the \f3dump\fR command prints the current value of each field defined in the object\&. Static and instance fields are included\&. The \f3dump\fR command supports the same set of expressions as the \f3print\fR command\&. +.TP +threads +List the threads that are currently running\&. For each thread, its name and current status are printed and an index that can be used in other commands\&. In this example, the thread index is 4, the thread is an instance of \f3java\&.lang\&.Thread\fR, the thread name is \f3main\fR, and it is currently running\&. +.sp +.nf +\f34\&. (java\&.lang\&.Thread)0x1 main running\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +thread +Select a thread to be the current thread\&. Many \f3jdb\fR commands are based on the setting of the current thread\&. The thread is specified with the thread index described in the threads command\&. +.TP +where +The \f3where\fR command with no arguments dumps the stack of the current thread\&. The \f3where\fR\f3all\fR command dumps the stack of all threads in the current thread group\&. The \f3where\fR\f3threadindex\fR command dumps the stack of the specified thread\&. + +If the current thread is suspended either through an event such as a breakpoint or through the \f3suspend\fR command, then local variables and fields can be displayed with the \f3print\fR and \f3dump\fR commands\&. The \f3up\fR and \f3down\fR commands select which stack frame is the current stack frame\&. +.SS BREAKPOINTS +Breakpoints can be set in JDB at line numbers or at the first instruction of a method, for example: +.TP 0.2i +\(bu +The command \f3stop at MyClass:22\fR sets a breakpoint at the first instruction for line 22 of the source file containing \f3MyClass\fR\&. +.TP 0.2i +\(bu +The command \f3stop in java\&.lang\&.String\&.length\fR sets a breakpoint at the beginning of the method \f3java\&.lang\&.String\&.length\fR\&. +.TP 0.2i +\(bu +The command \f3stop in MyClass\&.<clinit>\fR uses \f3<clinit>\fR to identify the static initialization code for \f3MyClass\fR\&. +.PP +When a method is overloaded, you must also specify its argument types so that the proper method can be selected for a breakpoint\&. For example, \f3MyClass\&.myMethod(int,java\&.lang\&.String)\fR or \f3MyClass\&.myMethod()\fR\&. +.PP +The \f3clear\fR command removes breakpoints using the following syntax: \f3clear MyClass:45\fR\&. Using the \f3clear\fR or \f3stop\fR command with no argument displays a list of all breakpoints currently set\&. The \f3cont\fR command continues execution\&. +.SS STEPPING +The \f3step\fR command advances execution to the next line whether it is in the current stack frame or a called method\&. The \f3next\fR command advances execution to the next line in the current stack frame\&. +.SS EXCEPTIONS +When an exception occurs for which there is not a \f3catch\fR statement anywhere in the throwing thread\&'s call stack, the JVM typically prints an exception trace and exits\&. When running under JDB, however, control returns to JDB at the offending throw\&. You can then use the \f3jdb\fR command to diagnose the cause of the exception\&. +.PP +Use the \f3catch\fR command to cause the debugged application to stop at other thrown exceptions, for example: \f3catch java\&.io\&.FileNotFoundException\fR or \f3catch\fR\f3mypackage\&.BigTroubleException\fR\&. Any exception that is an instance of the specified class or subclass stops the application at the point where it is thrown\&. +.PP +The \f3ignore\fR command negates the effect of an earlier \f3catch\fR command\&. The \f3ignore\fR command does not cause the debugged JVM to ignore specific exceptions, but only to ignore the debugger\&. +.SH OPTIONS +When you use the \f3jdb\fR command instead of the \f3java\fR command on the command line, the \f3jdb\fR command accepts many of the same options as the \f3java\fR command, including \f3-D\fR, \f3-classpath\fR, and \f3-X\fR options\&. The following list contains additional options that are accepted by the \f3jdb\fR command\&. +.PP +Other options are supported to provide alternate mechanisms for connecting the debugger to the JVM it is to debug\&. For additional documentation about these connection alternatives, see Java Platform Debugger Architecture (JPDA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/jpda/index\&.html +.TP +-help +.br +Displays a help message\&. +.TP +-sourcepath \fIdir1:dir2: \&. \&. \&.\fR +.br +Uses the specified path to search for source files in the specified path\&. If this option is not specified, then use the default path of dot (\&.)\&. +.TP +-attach \fIaddress\fR +.br +Attaches the debugger to a running JVM with the default connection mechanism\&. +.TP +-listen \fIaddress\fR +.br +Waits for a running JVM to connect to the specified address with a standard connector\&. +.TP +-launch +.br +Starts the debugged application immediately upon startup of JDB\&. The \f3-launch\fR option removes the need for the \f3run\fR command\&. The debugged application is launched and then stopped just before the initial application class is loaded\&. At that point, you can set any necessary breakpoints and use the \f3cont\fR command to continue execution\&. +.TP +-listconnectors +.br +List the connectors available in this JVM\&. +.TP +-connect connector-name:\fIname1=value1\fR +.br +Connects to the target JVM with the named connector and listed argument values\&. +.TP +-dbgtrace [\fIflags\fR] +.br +Prints information for debugging the \f3jdb\fR command\&. +.TP +-tclient +.br +Runs the application in the Java HotSpot VM client\&. +.TP +-tserver +.br +Runs the application in the Java HotSpot VM server\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the JVM, where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH OPTIONS\ FORWARDED\ TO\ THE\ DEBUGGER\ PROCESS +.TP +-v -verbose[:\fIclass\fR|gc|jni] +.br +Turns on verbose mode\&. +.TP +-D\fIname\fR=\fIvalue\fR +.br +Sets a system property\&. +.TP +-classpath \fIdir\fR +.br +Lists directories separated by colons in which to look for classes\&. +.TP +-X\fIoption\fR +.br +Nonstandard target JVM option\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +javac(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +javap(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/jdeps.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/jdeps.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,537 +1,537 @@ -'\" t -.\" Copyright (c) 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Basic Tools -.\" Title: jdeps.1 -.\" -.if n .pl 99999 -.TH jdeps 1 "21 November 2013" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jdeps \- Java class dependency analyzer\&. -.SH SYNOPSIS -.sp -.nf - -\fBjdeps\fR [\fIoptions\fR] \fIclasses\fR \&.\&.\&. -.fi -.sp -.TP -\fIoptions\fR -Command-line options\&. See Options\&. -.TP -\fIclasses\fR -Name of the classes to analyze\&. You can specify a class that can be found in the class path, by its file name, a directory, or a JAR file\&. -.SH DESCRIPTION -The \fI\fR\f3jdeps\fR command shows the package-level or class-level dependencies of Java class files\&. The input class can be a path name to a \f3\&.class\fR file, a directory, a JAR file, or it can be a fully qualified class name to analyze all class files\&. The options determine the output\&. By default, \f3jdeps\fR outputs the dependencies to the system output\&. It can generate the dependencies in DOT language (see the \f3-dotoutput\fR option)\&. -.SH OPTIONS -.TP --dotoutput <\fIdir\fR> -.br -Destination directory for DOT file output\&. If specified, \f3jdeps\fR will generate one dot file per each analyzed archive named <\fIarchive-file-name\fR>\&.dot listing the dependencies, and also a summary file named summary\&.dot listing the dependencies among the archives\&. -.TP --s, -summary -.br -Prints dependency summary only\&. -.TP --v, -verbose -.br -Prints all class-level dependencies\&. -.TP --verbose:package -.br -Prints package-level dependencies excluding dependencies within the same archive\&. -.TP --verbose:class -.br -Prints class-level dependencies excluding dependencies within the same archive\&. -.TP --cp <\fIpath\fR>, -classpath <\fIpath\fR> -.br -Specifies where to find class files\&. - -See also Setting the Class Path\&. -.TP --p <\fIpkg name\fR>, -package <\fIpkg name\fR> -.br -Finds dependencies in the specified package\&. You can specify this option multiple times for different packages\&. The \f3-p\fR and \f3-e\fR options are mutually exclusive\&. -.TP --e <\fIregex\fR>, -regex <\fIregex\fR> -.br -Finds dependencies in packages matching the specified regular expression pattern\&. The \f3-p\fR and \f3-e\fR options are mutually exclusive\&. -.TP --include <\fIregex\fR> -.br -Restricts analysis to classes matching pattern\&. This option filters the list of classes to be analyzed\&. It can be used together with \f3-p\fR and \f3-e\fR which apply pattern to the dependencies\&. -.TP --jdkinternals -.br -Finds class-level dependences in JDK internal APIs\&. By default, it analyzes all classes specified in the \f3-classpath\fR option and in input files unless you specified the \f3-include\fR option\&. You cannot use this option with the \f3-p\fR, \f3-e\fR, and \f3-s\fR options\&. - -\fIWarning\fR: JDK internal APIs may not be accessible in upcoming releases\&. -.TP --P, -profile -.br -Shows profile or the file containing a package\&. -.TP --apionly -.br -Restricts analysis to APIs, for example, dependences from the signature of \f3public\fR and \f3protected\fR members of public classes including field type, method parameter types, returned type, and checked exception types\&. -.TP --R, -recursive -.br -Recursively traverses all dependencies\&. -.TP --version -.br -Prints version information\&. -.TP --h, -?, -help -.br -Prints help message for \f3jdeps\fR\&. -.SH EXAMPLES -Analyzing the dependencies of Notepad\&.jar\&. -.sp -.nf -\f3$ jdeps demo/jfc/Notepad/Notepad\&.jar\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3demo/jfc/Notepad/Notepad\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP -.fi -.nf -\f3 <unnamed> (Notepad\&.jar)\fP -.fi -.nf -\f3 \-> java\&.awt \fP -.fi -.nf -\f3 \-> java\&.awt\&.event \fP -.fi -.nf -\f3 \-> java\&.beans \fP -.fi -.nf -\f3 \-> java\&.io \fP -.fi -.nf -\f3 \-> java\&.lang \fP -.fi -.nf -\f3 \-> java\&.net \fP -.fi -.nf -\f3 \-> java\&.util \fP -.fi -.nf -\f3 \-> java\&.util\&.logging \fP -.fi -.nf -\f3 \-> javax\&.swing \fP -.fi -.nf -\f3 \-> javax\&.swing\&.border \fP -.fi -.nf -\f3 \-> javax\&.swing\&.event \fP -.fi -.nf -\f3 \-> javax\&.swing\&.text \fP -.fi -.nf -\f3 \-> javax\&.swing\&.tree \fP -.fi -.nf -\f3 \-> javax\&.swing\&.undo \fP -.fi -.nf -\f3\fP -.fi -.sp -Use -P or -profile option to show on which profile that Notepad depends\&. -.sp -.nf -\f3$ jdeps \-profile demo/jfc/Notepad/Notepad\&.jar \fP -.fi -.nf -\f3demo/jfc/Notepad/Notepad\&.jar \-> /usr/java/jre/lib/rt\&.jar (Full JRE)\fP -.fi -.nf -\f3 <unnamed> (Notepad\&.jar)\fP -.fi -.nf -\f3 \-> java\&.awt Full JRE\fP -.fi -.nf -\f3 \-> java\&.awt\&.event Full JRE\fP -.fi -.nf -\f3 \-> java\&.beans Full JRE\fP -.fi -.nf -\f3 \-> java\&.io compact1\fP -.fi -.nf -\f3 \-> java\&.lang compact1\fP -.fi -.nf -\f3 \-> java\&.net compact1\fP -.fi -.nf -\f3 \-> java\&.util compact1\fP -.fi -.nf -\f3 \-> java\&.util\&.logging compact1\fP -.fi -.nf -\f3 \-> javax\&.swing Full JRE\fP -.fi -.nf -\f3 \-> javax\&.swing\&.border Full JRE\fP -.fi -.nf -\f3 \-> javax\&.swing\&.event Full JRE\fP -.fi -.nf -\f3 \-> javax\&.swing\&.text Full JRE\fP -.fi -.nf -\f3 \-> javax\&.swing\&.tree Full JRE\fP -.fi -.nf -\f3 \-> javax\&.swing\&.undo Full JRE\fP -.fi -.nf -\f3\fP -.fi -.sp -Analyzing the immediate dependencies of a specific class in a given classpath, for example the \f3com\&.sun\&.tools\&.jdeps\&.Main\fR class in the tools\&.jar file\&. -.sp -.nf -\f3$ jdeps \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP -.fi -.nf -\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP -.fi -.nf -\f3 com\&.sun\&.tools\&.jdeps (tools\&.jar)\fP -.fi -.nf -\f3 \-> java\&.io \fP -.fi -.nf -\f3 \-> java\&.lang \fP -.fi -.nf -\f3\fP -.fi -.sp -Use the \f3-verbose:class\fR option to find class-level dependencies or use the \f3-v\fR or \f3-verbose\fR option to include dependencies from the same JAR file\&. -.sp -.nf -\f3$ jdeps \-verbose:class \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP -.fi -.nf -\f3 com\&.sun\&.tools\&.jdeps\&.Main (tools\&.jar)\fP -.fi -.nf -\f3 \-> java\&.io\&.PrintWriter \fP -.fi -.nf -\f3 \-> java\&.lang\&.Exception \fP -.fi -.nf -\f3 \-> java\&.lang\&.Object \fP -.fi -.nf -\f3 \-> java\&.lang\&.String \fP -.fi -.nf -\f3 \-> java\&.lang\&.System \fP -.fi -.nf -\f3\fP -.fi -.sp -Use the \f3-R\fR or \f3-recursive\fR option to analyze the transitive dependencies of the \f3com\&.sun\&.tools\&.jdeps\&.Main\fR class\&. -.sp -.nf -\f3$ jdeps \-R \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP -.fi -.nf -\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP -.fi -.nf -\f3 com\&.sun\&.tools\&.classfile (tools\&.jar)\fP -.fi -.nf -\f3 \-> java\&.io \fP -.fi -.nf -\f3 \-> java\&.lang \fP -.fi -.nf -\f3 \-> java\&.lang\&.reflect \fP -.fi -.nf -\f3 \-> java\&.nio\&.charset \fP -.fi -.nf -\f3 \-> java\&.nio\&.file \fP -.fi -.nf -\f3 \-> java\&.util \fP -.fi -.nf -\f3 \-> java\&.util\&.regex \fP -.fi -.nf -\f3 com\&.sun\&.tools\&.jdeps (tools\&.jar)\fP -.fi -.nf -\f3 \-> java\&.io \fP -.fi -.nf -\f3 \-> java\&.lang \fP -.fi -.nf -\f3 \-> java\&.nio\&.file \fP -.fi -.nf -\f3 \-> java\&.nio\&.file\&.attribute \fP -.fi -.nf -\f3 \-> java\&.text \fP -.fi -.nf -\f3 \-> java\&.util \fP -.fi -.nf -\f3 \-> java\&.util\&.jar \fP -.fi -.nf -\f3 \-> java\&.util\&.regex \fP -.fi -.nf -\f3 \-> java\&.util\&.zip \fP -.fi -.nf -\f3/usr/java/jre/lib/jce\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP -.fi -.nf -\f3 javax\&.crypto (jce\&.jar)\fP -.fi -.nf -\f3 \-> java\&.io \fP -.fi -.nf -\f3 \-> java\&.lang \fP -.fi -.nf -\f3 \-> java\&.lang\&.reflect \fP -.fi -.nf -\f3 \-> java\&.net \fP -.fi -.nf -\f3 \-> java\&.nio \fP -.fi -.nf -\f3 \-> java\&.security \fP -.fi -.nf -\f3 \-> java\&.security\&.cert \fP -.fi -.nf -\f3 \-> java\&.security\&.spec \fP -.fi -.nf -\f3 \-> java\&.util \fP -.fi -.nf -\f3 \-> java\&.util\&.concurrent \fP -.fi -.nf -\f3 \-> java\&.util\&.jar \fP -.fi -.nf -\f3 \-> java\&.util\&.regex \fP -.fi -.nf -\f3 \-> java\&.util\&.zip \fP -.fi -.nf -\f3 \-> javax\&.security\&.auth \fP -.fi -.nf -\f3 \-> sun\&.security\&.jca JDK internal API (rt\&.jar)\fP -.fi -.nf -\f3 \-> sun\&.security\&.util JDK internal API (rt\&.jar)\fP -.fi -.nf -\f3 javax\&.crypto\&.spec (jce\&.jar)\fP -.fi -.nf -\f3 \-> java\&.lang \fP -.fi -.nf -\f3 \-> java\&.security\&.spec \fP -.fi -.nf -\f3 \-> java\&.util \fP -.fi -.nf -\f3/usr/java/jre/lib/rt\&.jar \-> /usr/java/jre/lib/jce\&.jar\fP -.fi -.nf -\f3 java\&.security (rt\&.jar)\fP -.fi -.nf -\f3 \-> javax\&.crypto\fP -.fi -.nf -\f3\fP -.fi -.sp -Generate dot files of the dependencies of Notepad demo\&. -.sp -.nf -\f3$ jdeps \-dotoutput dot demo/jfc/Notepad/Notepad\&.jar\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3jdeps\fR will create one dot file for each given JAR file named <\fIfilename\fR>\&.dot in the dot directory specified in the \f3-dotoutput\fR option, and also a summary file named summary\&.dot that will list the dependencies among the JAR files -.sp -.nf -\f3$ cat dot/Notepad\&.jar\&.dot \fP -.fi -.nf -\f3digraph "Notepad\&.jar" {\fP -.fi -.nf -\f3 // Path: demo/jfc/Notepad/Notepad\&.jar\fP -.fi -.nf -\f3 "<unnamed>" \-> "java\&.awt";\fP -.fi -.nf -\f3 "<unnamed>" \-> "java\&.awt\&.event";\fP -.fi -.nf -\f3 "<unnamed>" \-> "java\&.beans";\fP -.fi -.nf -\f3 "<unnamed>" \-> "java\&.io";\fP -.fi -.nf -\f3 "<unnamed>" \-> "java\&.lang";\fP -.fi -.nf -\f3 "<unnamed>" \-> "java\&.net";\fP -.fi -.nf -\f3 "<unnamed>" \-> "java\&.util";\fP -.fi -.nf -\f3 "<unnamed>" \-> "java\&.util\&.logging";\fP -.fi -.nf -\f3 "<unnamed>" \-> "javax\&.swing";\fP -.fi -.nf -\f3 "<unnamed>" \-> "javax\&.swing\&.border";\fP -.fi -.nf -\f3 "<unnamed>" \-> "javax\&.swing\&.event";\fP -.fi -.nf -\f3 "<unnamed>" \-> "javax\&.swing\&.text";\fP -.fi -.nf -\f3 "<unnamed>" \-> "javax\&.swing\&.tree";\fP -.fi -.nf -\f3 "<unnamed>" \-> "javax\&.swing\&.undo";\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3$ cat dot/summary\&.dot\fP -.fi -.nf -\f3digraph "summary" {\fP -.fi -.nf -\f3 "Notepad\&.jar" \-> "rt\&.jar";\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH SEE\ ALSO -.TP 0.2i -\(bu -javap(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: jdeps.1 +.\" +.if n .pl 99999 +.TH jdeps 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jdeps \- Java class dependency analyzer\&. +.SH SYNOPSIS +.sp +.nf + +\fBjdeps\fR [\fIoptions\fR] \fIclasses\fR \&.\&.\&. +.fi +.sp +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.TP +\fIclasses\fR +Name of the classes to analyze\&. You can specify a class that can be found in the class path, by its file name, a directory, or a JAR file\&. +.SH DESCRIPTION +The \fI\fR\f3jdeps\fR command shows the package-level or class-level dependencies of Java class files\&. The input class can be a path name to a \f3\&.class\fR file, a directory, a JAR file, or it can be a fully qualified class name to analyze all class files\&. The options determine the output\&. By default, \f3jdeps\fR outputs the dependencies to the system output\&. It can generate the dependencies in DOT language (see the \f3-dotoutput\fR option)\&. +.SH OPTIONS +.TP +-dotoutput <\fIdir\fR> +.br +Destination directory for DOT file output\&. If specified, \f3jdeps\fR will generate one dot file per each analyzed archive named <\fIarchive-file-name\fR>\&.dot listing the dependencies, and also a summary file named summary\&.dot listing the dependencies among the archives\&. +.TP +-s, -summary +.br +Prints dependency summary only\&. +.TP +-v, -verbose +.br +Prints all class-level dependencies\&. +.TP +-verbose:package +.br +Prints package-level dependencies excluding dependencies within the same archive\&. +.TP +-verbose:class +.br +Prints class-level dependencies excluding dependencies within the same archive\&. +.TP +-cp <\fIpath\fR>, -classpath <\fIpath\fR> +.br +Specifies where to find class files\&. + +See also Setting the Class Path\&. +.TP +-p <\fIpkg name\fR>, -package <\fIpkg name\fR> +.br +Finds dependencies in the specified package\&. You can specify this option multiple times for different packages\&. The \f3-p\fR and \f3-e\fR options are mutually exclusive\&. +.TP +-e <\fIregex\fR>, -regex <\fIregex\fR> +.br +Finds dependencies in packages matching the specified regular expression pattern\&. The \f3-p\fR and \f3-e\fR options are mutually exclusive\&. +.TP +-include <\fIregex\fR> +.br +Restricts analysis to classes matching pattern\&. This option filters the list of classes to be analyzed\&. It can be used together with \f3-p\fR and \f3-e\fR which apply pattern to the dependencies\&. +.TP +-jdkinternals +.br +Finds class-level dependences in JDK internal APIs\&. By default, it analyzes all classes specified in the \f3-classpath\fR option and in input files unless you specified the \f3-include\fR option\&. You cannot use this option with the \f3-p\fR, \f3-e\fR, and \f3-s\fR options\&. + +\fIWarning\fR: JDK internal APIs may not be accessible in upcoming releases\&. +.TP +-P, -profile +.br +Shows profile or the file containing a package\&. +.TP +-apionly +.br +Restricts analysis to APIs, for example, dependences from the signature of \f3public\fR and \f3protected\fR members of public classes including field type, method parameter types, returned type, and checked exception types\&. +.TP +-R, -recursive +.br +Recursively traverses all dependencies\&. +.TP +-version +.br +Prints version information\&. +.TP +-h, -?, -help +.br +Prints help message for \f3jdeps\fR\&. +.SH EXAMPLES +Analyzing the dependencies of Notepad\&.jar\&. +.sp +.nf +\f3$ jdeps demo/jfc/Notepad/Notepad\&.jar\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3demo/jfc/Notepad/Notepad\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 <unnamed> (Notepad\&.jar)\fP +.fi +.nf +\f3 \-> java\&.awt \fP +.fi +.nf +\f3 \-> java\&.awt\&.event \fP +.fi +.nf +\f3 \-> java\&.beans \fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.net \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3 \-> java\&.util\&.logging \fP +.fi +.nf +\f3 \-> javax\&.swing \fP +.fi +.nf +\f3 \-> javax\&.swing\&.border \fP +.fi +.nf +\f3 \-> javax\&.swing\&.event \fP +.fi +.nf +\f3 \-> javax\&.swing\&.text \fP +.fi +.nf +\f3 \-> javax\&.swing\&.tree \fP +.fi +.nf +\f3 \-> javax\&.swing\&.undo \fP +.fi +.nf +\f3\fP +.fi +.sp +Use -P or -profile option to show on which profile that Notepad depends\&. +.sp +.nf +\f3$ jdeps \-profile demo/jfc/Notepad/Notepad\&.jar \fP +.fi +.nf +\f3demo/jfc/Notepad/Notepad\&.jar \-> /usr/java/jre/lib/rt\&.jar (Full JRE)\fP +.fi +.nf +\f3 <unnamed> (Notepad\&.jar)\fP +.fi +.nf +\f3 \-> java\&.awt Full JRE\fP +.fi +.nf +\f3 \-> java\&.awt\&.event Full JRE\fP +.fi +.nf +\f3 \-> java\&.beans Full JRE\fP +.fi +.nf +\f3 \-> java\&.io compact1\fP +.fi +.nf +\f3 \-> java\&.lang compact1\fP +.fi +.nf +\f3 \-> java\&.net compact1\fP +.fi +.nf +\f3 \-> java\&.util compact1\fP +.fi +.nf +\f3 \-> java\&.util\&.logging compact1\fP +.fi +.nf +\f3 \-> javax\&.swing Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.border Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.event Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.text Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.tree Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.undo Full JRE\fP +.fi +.nf +\f3\fP +.fi +.sp +Analyzing the immediate dependencies of a specific class in a given classpath, for example the \f3com\&.sun\&.tools\&.jdeps\&.Main\fR class in the tools\&.jar file\&. +.sp +.nf +\f3$ jdeps \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP +.fi +.nf +\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 com\&.sun\&.tools\&.jdeps (tools\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3\fP +.fi +.sp +Use the \f3-verbose:class\fR option to find class-level dependencies or use the \f3-v\fR or \f3-verbose\fR option to include dependencies from the same JAR file\&. +.sp +.nf +\f3$ jdeps \-verbose:class \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 com\&.sun\&.tools\&.jdeps\&.Main (tools\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io\&.PrintWriter \fP +.fi +.nf +\f3 \-> java\&.lang\&.Exception \fP +.fi +.nf +\f3 \-> java\&.lang\&.Object \fP +.fi +.nf +\f3 \-> java\&.lang\&.String \fP +.fi +.nf +\f3 \-> java\&.lang\&.System \fP +.fi +.nf +\f3\fP +.fi +.sp +Use the \f3-R\fR or \f3-recursive\fR option to analyze the transitive dependencies of the \f3com\&.sun\&.tools\&.jdeps\&.Main\fR class\&. +.sp +.nf +\f3$ jdeps \-R \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP +.fi +.nf +\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 com\&.sun\&.tools\&.classfile (tools\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.lang\&.reflect \fP +.fi +.nf +\f3 \-> java\&.nio\&.charset \fP +.fi +.nf +\f3 \-> java\&.nio\&.file \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3 \-> java\&.util\&.regex \fP +.fi +.nf +\f3 com\&.sun\&.tools\&.jdeps (tools\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.nio\&.file \fP +.fi +.nf +\f3 \-> java\&.nio\&.file\&.attribute \fP +.fi +.nf +\f3 \-> java\&.text \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3 \-> java\&.util\&.jar \fP +.fi +.nf +\f3 \-> java\&.util\&.regex \fP +.fi +.nf +\f3 \-> java\&.util\&.zip \fP +.fi +.nf +\f3/usr/java/jre/lib/jce\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 javax\&.crypto (jce\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.lang\&.reflect \fP +.fi +.nf +\f3 \-> java\&.net \fP +.fi +.nf +\f3 \-> java\&.nio \fP +.fi +.nf +\f3 \-> java\&.security \fP +.fi +.nf +\f3 \-> java\&.security\&.cert \fP +.fi +.nf +\f3 \-> java\&.security\&.spec \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3 \-> java\&.util\&.concurrent \fP +.fi +.nf +\f3 \-> java\&.util\&.jar \fP +.fi +.nf +\f3 \-> java\&.util\&.regex \fP +.fi +.nf +\f3 \-> java\&.util\&.zip \fP +.fi +.nf +\f3 \-> javax\&.security\&.auth \fP +.fi +.nf +\f3 \-> sun\&.security\&.jca JDK internal API (rt\&.jar)\fP +.fi +.nf +\f3 \-> sun\&.security\&.util JDK internal API (rt\&.jar)\fP +.fi +.nf +\f3 javax\&.crypto\&.spec (jce\&.jar)\fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.security\&.spec \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3/usr/java/jre/lib/rt\&.jar \-> /usr/java/jre/lib/jce\&.jar\fP +.fi +.nf +\f3 java\&.security (rt\&.jar)\fP +.fi +.nf +\f3 \-> javax\&.crypto\fP +.fi +.nf +\f3\fP +.fi +.sp +Generate dot files of the dependencies of Notepad demo\&. +.sp +.nf +\f3$ jdeps \-dotoutput dot demo/jfc/Notepad/Notepad\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3jdeps\fR will create one dot file for each given JAR file named <\fIfilename\fR>\&.dot in the dot directory specified in the \f3-dotoutput\fR option, and also a summary file named summary\&.dot that will list the dependencies among the JAR files +.sp +.nf +\f3$ cat dot/Notepad\&.jar\&.dot \fP +.fi +.nf +\f3digraph "Notepad\&.jar" {\fP +.fi +.nf +\f3 // Path: demo/jfc/Notepad/Notepad\&.jar\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.awt";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.awt\&.event";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.beans";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.io";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.lang";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.net";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.util";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.util\&.logging";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.border";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.event";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.text";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.tree";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.undo";\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3$ cat dot/summary\&.dot\fP +.fi +.nf +\f3digraph "summary" {\fP +.fi +.nf +\f3 "Notepad\&.jar" \-> "rt\&.jar";\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +javap(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/jhat.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/jhat.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,136 +1,136 @@ -'\" t -.\" Copyright (c) 2006, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Troubleshooting Tools -.\" Title: jhat.1 -.\" -.if n .pl 99999 -.TH jhat 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jhat \- Analyzes the Java heap\&. This command is experimental and unsupported\&. -.SH SYNOPSIS -.sp -.nf - -\fBjhat\fR [ \fIoptions\fR ] \fIheap\-dump\-file\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIheap-dump-file\fR -Java binary heap dump file to be browsed\&. For a dump file that contains multiple heap dumps, you can specify which dump in the file by appending \f3#<number>\fR to the file name, for example, \f3myfile\&.hprof#3\fR\&. -.SH DESCRIPTION -The \f3jhat\fR command parses a Java heap dump file and starts a web server\&. The \f3jhat\fR command lets you to browse heap dumps with your favorite web browser\&. The \f3jhat\fR command supports predesigned queries such as show all instances of a known class \f3MyClass\fR, and Object Query Language (OQL)\&. OQL is similar to SQL, except for querying heap dumps\&. Help on OQL is available from the OQL help page shown by the \f3jhat\fR command\&. With the default port, OQL help is available at http://localhost:7000/oqlhelp/ -.PP -There are several ways to generate a Java heap dump: -.TP 0.2i -\(bu -Use the \f3jmap -dump\fR option to obtain a heap dump at runtime\&. See jmap(1)\&. -.TP 0.2i -\(bu -Use the \f3jconsole\fR option to obtain a heap dump through \f3HotSpotDiagnosticMXBean\fR at runtime\&. See jconsole(1) and the \f3HotSpotDiagnosticMXBean\fR interface description at http://docs\&.oracle\&.com/javase/8/docs/jre/api/management/extension/com/sun/management/HotSpotDiagnosticMXBean\&.html -.TP 0.2i -\(bu -Heap dump is generated when an \f3OutOfMemoryError\fR is thrown by specifying the \f3-XX:+HeapDumpOnOutOfMemoryError\fR Java Virtual Machine (JVM) option\&. -.TP 0.2i -\(bu -Use the \f3hprof\fR command\&. See the HPROF: A Heap/CPU Profiling Tool at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/hprof\&.html -.SH OPTIONS -.TP --stack false|true -.br -Turns off tracking object allocation call stack\&. If allocation site information is not available in the heap dump, then you have to set this flag to \f3false\fR\&. The default is \f3true\fR\&. -.TP --refs false|true -.br -Turns off tracking of references to objects\&. Default is \f3true\fR\&. By default, back pointers, which are objects that point to a specified object such as referrers or incoming references, are calculated for all objects in the heap\&. -.TP --port \fIport-number\fR -.br -Sets the port for the \f3jhat\fR HTTP server\&. Default is 7000\&. -.TP --exclude \fIexclude-file\fR -.br -Specifies a file that lists data members that should be excluded from the reachable objects query\&. For example, if the file lists \f3java\&.lang\&.String\&.value\fR, then, then whenever the list of objects that are reachable from a specific object \f3o\fR are calculated, reference paths that involve \f3java\&.lang\&.String\&.value\fR field are not considered\&. -.TP --baseline \fIexclude-file\fR -.br -Specifies a baseline heap dump\&. Objects in both heap dumps with the same object ID are marked as not being new\&. Other objects are marked as new\&. This is useful for comparing two different heap dumps\&. -.TP --debug \fIint\fR -.br -Sets the debug level for this tool\&. A level of 0 means no debug output\&. Set higher values for more verbose modes\&. -.TP --version -.br -Reports the release number and exits -.TP --h -.br -Dsiplays a help message and exits\&. -.TP --help -.br -Displays a help message and exits\&. -.TP --J\fIflag\fR -.br -Passes \f3flag\fR to the Java Virtual Machine on which the \f3jhat\fR command is running\&. For example, \f3-J-Xmx512m\fR to use a maximum heap size of 512 MB\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -jmap(1) -.TP 0.2i -\(bu -jconsole(1) -.TP 0.2i -\(bu -HPROF: A Heap/CPU Profiling Tool at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/hprof\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2006, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jhat.1 +.\" +.if n .pl 99999 +.TH jhat 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jhat \- Analyzes the Java heap\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjhat\fR [ \fIoptions\fR ] \fIheap\-dump\-file\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIheap-dump-file\fR +Java binary heap dump file to be browsed\&. For a dump file that contains multiple heap dumps, you can specify which dump in the file by appending \f3#<number>\fR to the file name, for example, \f3myfile\&.hprof#3\fR\&. +.SH DESCRIPTION +The \f3jhat\fR command parses a Java heap dump file and starts a web server\&. The \f3jhat\fR command lets you to browse heap dumps with your favorite web browser\&. The \f3jhat\fR command supports predesigned queries such as show all instances of a known class \f3MyClass\fR, and Object Query Language (OQL)\&. OQL is similar to SQL, except for querying heap dumps\&. Help on OQL is available from the OQL help page shown by the \f3jhat\fR command\&. With the default port, OQL help is available at http://localhost:7000/oqlhelp/ +.PP +There are several ways to generate a Java heap dump: +.TP 0.2i +\(bu +Use the \f3jmap -dump\fR option to obtain a heap dump at runtime\&. See jmap(1)\&. +.TP 0.2i +\(bu +Use the \f3jconsole\fR option to obtain a heap dump through \f3HotSpotDiagnosticMXBean\fR at runtime\&. See jconsole(1) and the \f3HotSpotDiagnosticMXBean\fR interface description at http://docs\&.oracle\&.com/javase/8/docs/jre/api/management/extension/com/sun/management/HotSpotDiagnosticMXBean\&.html +.TP 0.2i +\(bu +Heap dump is generated when an \f3OutOfMemoryError\fR is thrown by specifying the \f3-XX:+HeapDumpOnOutOfMemoryError\fR Java Virtual Machine (JVM) option\&. +.TP 0.2i +\(bu +Use the \f3hprof\fR command\&. See the HPROF: A Heap/CPU Profiling Tool at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/hprof\&.html +.SH OPTIONS +.TP +-stack false|true +.br +Turns off tracking object allocation call stack\&. If allocation site information is not available in the heap dump, then you have to set this flag to \f3false\fR\&. The default is \f3true\fR\&. +.TP +-refs false|true +.br +Turns off tracking of references to objects\&. Default is \f3true\fR\&. By default, back pointers, which are objects that point to a specified object such as referrers or incoming references, are calculated for all objects in the heap\&. +.TP +-port \fIport-number\fR +.br +Sets the port for the \f3jhat\fR HTTP server\&. Default is 7000\&. +.TP +-exclude \fIexclude-file\fR +.br +Specifies a file that lists data members that should be excluded from the reachable objects query\&. For example, if the file lists \f3java\&.lang\&.String\&.value\fR, then, then whenever the list of objects that are reachable from a specific object \f3o\fR are calculated, reference paths that involve \f3java\&.lang\&.String\&.value\fR field are not considered\&. +.TP +-baseline \fIexclude-file\fR +.br +Specifies a baseline heap dump\&. Objects in both heap dumps with the same object ID are marked as not being new\&. Other objects are marked as new\&. This is useful for comparing two different heap dumps\&. +.TP +-debug \fIint\fR +.br +Sets the debug level for this tool\&. A level of 0 means no debug output\&. Set higher values for more verbose modes\&. +.TP +-version +.br +Reports the release number and exits +.TP +-h +.br +Dsiplays a help message and exits\&. +.TP +-help +.br +Displays a help message and exits\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR to the Java Virtual Machine on which the \f3jhat\fR command is running\&. For example, \f3-J-Xmx512m\fR to use a maximum heap size of 512 MB\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jmap(1) +.TP 0.2i +\(bu +jconsole(1) +.TP 0.2i +\(bu +HPROF: A Heap/CPU Profiling Tool at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/hprof\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/jinfo.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/jinfo.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,132 +1,132 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Troubleshooting Tools -.\" Title: jinfo.1 -.\" -.if n .pl 99999 -.TH jinfo 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jinfo \- Generates configuration information\&. This command is experimental and unsupported\&. -.SH SYNOPSIS -.sp -.nf - -\fBjinfo\fR [ \fIoption\fR ] \fIpid\fR -.fi -.nf - -\fBjinfo\fR [ \fIoption \fR] \fIexecutable core\fR -.fi -.nf - -\fBjinfo\fR [ \fIoption \fR] \fI[ servier\-id ] remote\-hostname\-or\-IP\fR -.fi -.sp -.TP -\fIoption\fR -The command-line options\&. See Options\&. -.TP -\fIpid\fR -The process ID for which the configuration information is to be printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. -.TP -\fIexecutable\fR -The Java executable from which the core dump was produced\&. -.TP -\fIcore\fR -The core file for which the configuration information is to be printed\&. -.TP -\fIremote-hostname-or-IP\fR -The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. -.TP -\fIserver-id\fR -An optional unique ID to use when multiple debug servers are running on the same remote host\&. -.SH DESCRIPTION -The \f3jinfo\fR command prints Java configuration information for a specified Java process or core file or a remote debug server\&. The configuration information includes Java system properties and Java Virtual Machine (JVM) command-line flags\&. If the specified process is running on a 64-bit JVM, then you might need to specify the \f3-J-d64\fR option, for example: \f3jinfo\fR\f3-J-d64 -sysprops pid\fR\&. -.PP -This utility is unsupported and might not be available in future releases of the JDK\&. In Windows Systems where \f3dbgeng\&.dll\fR is not present, Debugging Tools For Windows must be installed to have these tools working\&. The \f3PATH\fR environment variable should contain the location of the jvm\&.dll that is used by the target process or the location from which the crash dump file was produced\&. For example, \f3set PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR \&. -.SH OPTIONS -.TP -no-option -Prints both command-line flags and system property name-value pairs\&. -.TP --flag \fIname\fR -.br -Prints the name and value of the specified command-line flag\&. -.TP --flag \fI[+|-]name\fR -.br -enables or disables the specified Boolean command-line flag\&. -.TP --flag \fIname=value\fR -.br -Sets the specified command-line flag to the specified value\&. -.TP --flags -.br -Prints command-line flags passed to the JVM\&. -.TP --sysprops -.br -Prints Java system properties as name-value pairs\&. -.TP --h -.br -Prints a help message\&. -.TP --help -.br -Prints a help message\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -jps(1) -.TP 0.2i -\(bu -jsadebugd(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jinfo.1 +.\" +.if n .pl 99999 +.TH jinfo 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jinfo \- Generates configuration information\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjinfo\fR [ \fIoption\fR ] \fIpid\fR +.fi +.nf + +\fBjinfo\fR [ \fIoption \fR] \fIexecutable core\fR +.fi +.nf + +\fBjinfo\fR [ \fIoption \fR] \fI[ servier\-id ] remote\-hostname\-or\-IP\fR +.fi +.sp +.TP +\fIoption\fR +The command-line options\&. See Options\&. +.TP +\fIpid\fR +The process ID for which the configuration information is to be printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. +.TP +\fIexecutable\fR +The Java executable from which the core dump was produced\&. +.TP +\fIcore\fR +The core file for which the configuration information is to be printed\&. +.TP +\fIremote-hostname-or-IP\fR +The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. +.TP +\fIserver-id\fR +An optional unique ID to use when multiple debug servers are running on the same remote host\&. +.SH DESCRIPTION +The \f3jinfo\fR command prints Java configuration information for a specified Java process or core file or a remote debug server\&. The configuration information includes Java system properties and Java Virtual Machine (JVM) command-line flags\&. If the specified process is running on a 64-bit JVM, then you might need to specify the \f3-J-d64\fR option, for example: \f3jinfo\fR\f3-J-d64 -sysprops pid\fR\&. +.PP +This utility is unsupported and might not be available in future releases of the JDK\&. In Windows Systems where \f3dbgeng\&.dll\fR is not present, Debugging Tools For Windows must be installed to have these tools working\&. The \f3PATH\fR environment variable should contain the location of the jvm\&.dll that is used by the target process or the location from which the crash dump file was produced\&. For example, \f3set PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR \&. +.SH OPTIONS +.TP +no-option +Prints both command-line flags and system property name-value pairs\&. +.TP +-flag \fIname\fR +.br +Prints the name and value of the specified command-line flag\&. +.TP +-flag \fI[+|-]name\fR +.br +enables or disables the specified Boolean command-line flag\&. +.TP +-flag \fIname=value\fR +.br +Sets the specified command-line flag to the specified value\&. +.TP +-flags +.br +Prints command-line flags passed to the JVM\&. +.TP +-sysprops +.br +Prints Java system properties as name-value pairs\&. +.TP +-h +.br +Prints a help message\&. +.TP +-help +.br +Prints a help message\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jsadebugd(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/jjs.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/jjs.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/jmap.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/jmap.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,143 +1,143 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Troubleshooting Tools -.\" Title: jmap.1 -.\" -.if n .pl 99999 -.TH jmap 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jmap \- Prints shared object memory maps or heap memory details for a process, core file, or remote debug server\&. This command is experimental and unsupported\&. -.SH SYNOPSIS -.sp -.nf - -\fBjmap\fR [ \fIoptions\fR ] \fIpid\fR -.fi -.nf - -\fBjmap\fR [ \fIoptions\fR ] \fIexecutable\fR \fIcore\fR -.fi -.nf - -\fBjmap\fR [ \fIoptions\fR ] [ \fIpid\fR ] \fIserver\-id\fR@ ] \fIremote\-hostname\-or\-IP\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIpid\fR -The process ID for which the memory map is to be printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. -.TP -\fIexecutable\fR -The Java executable from which the core dump was produced\&. -.TP -\fIcore\fR -The core file for which the memory map is to be printed\&. -.TP -\fIremote-hostname-or-IP\fR -The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. -.TP -\fIserver-id\fR -An optional unique ID to use when multiple debug servers are running on the same remote host\&. -.SH DESCRIPTION -The \f3jmap\fR command prints shared object memory maps or heap memory details of a specified process, core file, or remote debug server\&. If the specified process is running on a 64-bit Java Virtual Machine (JVM), then you might need to specify the \f3-J-d64\fR option, for example: \f3jmap\fR\f3-J-d64 -heap pid\fR\&. -.PP -\fINote:\fR This utility is unsupported and might not be available in future releases of the JDK\&. On Windows Systems where the \f3dbgeng\&.dll\fR file is not present, Debugging Tools For Windows must be installed to make these tools work\&. The \f3PATH\fR environment variable should contain the location of the \f3jvm\&.dll\fR file that is used by the target process or the location from which the crash dump file was produced, for example: \f3set PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR\&. -.SH OPTIONS -.TP -<no option> -When no option is used, the \f3jmap\fR command prints shared object mappings\&. For each shared object loaded in the target JVM, the start address, size of the mapping, and the full path of the shared object file are printed\&. This behavior is similar to the Oracle Solaris \f3pmap\fR utility\&. -.TP --dump:[live,] format=b, file=\fIfilename\fR -.br -Dumps the Java heap in \f3hprof\fR binary format to \f3filename\fR\&. The \f3live\fR suboption is optional, but when specified, only the active objects in the heap are dumped\&. To browse the heap dump, you can use the jhat(1) command to read the generated file\&. -.TP --finalizerinfo -.br -Prints information about objects that are awaiting finalization\&. -.TP --heap -.br -Prints a heap summary of the garbage collection used, the head configuration, and generation-wise heap usage\&. In addition, the number and size of interned Strings are printed\&. -.TP --histo[:live] -.br -Prints a histogram of the heap\&. For each Java class, the number of objects, memory size in bytes, and the fully qualified class names are printed\&. The JVM internal class names are printed with an asterisk (*) prefix\&. If the \f3live\fR suboption is specified, then only active objects are counted\&. -.TP --clstats -.br -Prints class loader wise statistics of Java heap\&. For each class loader, its name, how active it is, address, parent class loader, and the number and size of classes it has loaded are printed\&. -.TP --F -.br -Force\&. Use this option with the \f3jmap -dump\fR or \f3jmap -histo\fR option when the pid does not respond\&. The \f3live\fR suboption is not supported in this mode\&. -.TP --h -.br -Prints a help message\&. -.TP --help -.br -Prints a help message\&. -.TP --J\fIflag\fR -.br -Passes \f3flag\fR to the Java Virtual Machine where the \f3jmap\fR command is running\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -jhat(1) -.TP 0.2i -\(bu -jps(1) -.TP 0.2i -\(bu -jsadebugd(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jmap.1 +.\" +.if n .pl 99999 +.TH jmap 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jmap \- Prints shared object memory maps or heap memory details for a process, core file, or remote debug server\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjmap\fR [ \fIoptions\fR ] \fIpid\fR +.fi +.nf + +\fBjmap\fR [ \fIoptions\fR ] \fIexecutable\fR \fIcore\fR +.fi +.nf + +\fBjmap\fR [ \fIoptions\fR ] [ \fIpid\fR ] \fIserver\-id\fR@ ] \fIremote\-hostname\-or\-IP\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIpid\fR +The process ID for which the memory map is to be printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. +.TP +\fIexecutable\fR +The Java executable from which the core dump was produced\&. +.TP +\fIcore\fR +The core file for which the memory map is to be printed\&. +.TP +\fIremote-hostname-or-IP\fR +The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. +.TP +\fIserver-id\fR +An optional unique ID to use when multiple debug servers are running on the same remote host\&. +.SH DESCRIPTION +The \f3jmap\fR command prints shared object memory maps or heap memory details of a specified process, core file, or remote debug server\&. If the specified process is running on a 64-bit Java Virtual Machine (JVM), then you might need to specify the \f3-J-d64\fR option, for example: \f3jmap\fR\f3-J-d64 -heap pid\fR\&. +.PP +\fINote:\fR This utility is unsupported and might not be available in future releases of the JDK\&. On Windows Systems where the \f3dbgeng\&.dll\fR file is not present, Debugging Tools For Windows must be installed to make these tools work\&. The \f3PATH\fR environment variable should contain the location of the \f3jvm\&.dll\fR file that is used by the target process or the location from which the crash dump file was produced, for example: \f3set PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR\&. +.SH OPTIONS +.TP +<no option> +When no option is used, the \f3jmap\fR command prints shared object mappings\&. For each shared object loaded in the target JVM, the start address, size of the mapping, and the full path of the shared object file are printed\&. This behavior is similar to the Oracle Solaris \f3pmap\fR utility\&. +.TP +-dump:[live,] format=b, file=\fIfilename\fR +.br +Dumps the Java heap in \f3hprof\fR binary format to \f3filename\fR\&. The \f3live\fR suboption is optional, but when specified, only the active objects in the heap are dumped\&. To browse the heap dump, you can use the jhat(1) command to read the generated file\&. +.TP +-finalizerinfo +.br +Prints information about objects that are awaiting finalization\&. +.TP +-heap +.br +Prints a heap summary of the garbage collection used, the head configuration, and generation-wise heap usage\&. In addition, the number and size of interned Strings are printed\&. +.TP +-histo[:live] +.br +Prints a histogram of the heap\&. For each Java class, the number of objects, memory size in bytes, and the fully qualified class names are printed\&. The JVM internal class names are printed with an asterisk (*) prefix\&. If the \f3live\fR suboption is specified, then only active objects are counted\&. +.TP +-clstats +.br +Prints class loader wise statistics of Java heap\&. For each class loader, its name, how active it is, address, parent class loader, and the number and size of classes it has loaded are printed\&. +.TP +-F +.br +Force\&. Use this option with the \f3jmap -dump\fR or \f3jmap -histo\fR option when the pid does not respond\&. The \f3live\fR suboption is not supported in this mode\&. +.TP +-h +.br +Prints a help message\&. +.TP +-help +.br +Prints a help message\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR to the Java Virtual Machine where the \f3jmap\fR command is running\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jhat(1) +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jsadebugd(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/jps.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/jps.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,204 +1,204 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Monitoring Tools -.\" Title: jps.1 -.\" -.if n .pl 99999 -.TH jps 1 "21 November 2013" "JDK 8" "Monitoring Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jps \- Lists the instrumented Java Virtual Machines (JVMs) on the target system\&. This command is experimental and unsupported\&. -.SH SYNOPSIS -.sp -.nf - -\fBjps\fR [ \fIoptions\fR ] [ \fIhostid\fR ] -.fi -.sp -.TP -\fIoptions\fR -Command-line options\&. See Options\&. -.TP -\fIhostid\fR -The identifier of the host for which the process report should be generated\&. The \f3hostid\fR can include optional components that indicate the communications protocol, port number, and other implementation specific data\&. See Host Identifier\&. -.SH DESCRIPTION -The \f3jps\fR command lists the instrumented Java HotSpot VMs on the target system\&. The command is limited to reporting information on JVMs for which it has the access permissions\&. -.PP -If the \f3jps\fR command is run without specifying a \f3hostid\fR, then it searches for instrumented JVMs on the local host\&. If started with a \f3hostid\fR, then it searches for JVMs on the indicated host, using the specified protocol and port\&. A \f3jstatd\fR process is assumed to be running on the target host\&. -.PP -The \f3jps\fR command reports the local JVM identifier, or \f3lvmid\fR, for each instrumented JVM found on the target system\&. The \f3lvmid\fR is typically, but not necessarily, the operating system\&'s process identifier for the JVM process\&. With no options, \f3jps\fR lists each Java application\&'s \f3lvmid\fR followed by the short form of the application\&'s class name or jar file name\&. The short form of the class name or JAR file name omits the class\&'s package information or the JAR files path information\&. -.PP -The \f3jps\fR command uses the Java launcher to find the class name and arguments passed to the main method\&. If the target JVM is started with a custom launcher, then the class or JAR file name and the arguments to the \f3main\fR method are not available\&. In this case, the \f3jps\fR command outputs the string \f3Unknown\fR for the class name or JAR file name and for the arguments to the \f3main\fR method\&. -.PP -The list of JVMs produced by the \f3jps\fR command can be limited by the permissions granted to the principal running the command\&. The command only lists the JVMs for which the principle has access rights as determined by operating system-specific access control mechanisms\&. -.SH OPTIONS -The \f3jps\fR command supports a number of options that modify the output of the command\&. These options are subject to change or removal in the future\&. -.TP --q -.br -Suppresses the output of the class name, JAR file name, and arguments passed to the \f3main\fR method, producing only a list of local JVM identifiers\&. -.TP --m -.br -Displays the arguments passed to the \f3main\fR method\&. The output may be \f3null\fR for embedded JVMs\&. -.TP --l -.br -Displays the full package name for the application\&'s \f3main\fR class or the full path name to the application\&'s JAR file\&. -.TP --v -.br -Displays the arguments passed to the JVM\&. -.TP --V -.br -Suppresses the output of the class name, JAR file name, and arguments passed to the main method, producing only a list of local JVM identifiers\&. -.TP --J\f3option\fR -.br -Passes \f3option\fR to the JVM, where option is one of the \f3options\fR described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH HOST\ IDENTIFIER -The host identifier, or \f3hostid\fR is a string that indicates the target system\&. The syntax of the \f3hostid\fR string corresponds to the syntax of a URI: -.sp -.nf -\f3[protocol:][[//]hostname][:port][/servername]\fP -.fi -.nf -\f3\fP -.fi -.sp -.TP -\fIprotocol\fR -The communications protocol\&. If the \f3protocol\fR is omitted and a \f3hostname\fR is not specified, then the default protocol is a platform-specific, optimized, local protocol\&. If the protocol is omitted and a host name is specified, then the default protocol is \f3rmi\fR\&. -.TP -hostname -A hostname or IP address that indicates the target host\&. If you omit the \f3hostname\fR parameter, then the target host is the local host\&. -.TP -port -The default port for communicating with the remote server\&. If the \f3hostname\fR parameter is omitted or the \f3protocol\fR parameter specifies an optimized, local protocol, then the \f3port\fR parameter is ignored\&. Otherwise, treatment of the \f3port\fR parameter is implementation specific\&. For the default \f3rmi\fR protocol, the \f3port\fR parameter indicates the port number for the rmiregistry on the remote host\&. If the \f3port\fR parameter is omitted, and the \f3protocol\fR parameter indicates \f3rmi\fR, then the default rmiregistry port (1099) is used\&. -.TP -servername -The treatment of this parameter depends on the implementation\&. For the optimized, local protocol, this field is ignored\&. For the \f3rmi\fR protocol, this parameter is a string that represents the name of the RMI remote object on the remote host\&. See the \f3jstatd\fR command \f3-n\fRoption for more information\&. -.SH OUTPUT\ FORMAT -The output of the \f3jps\fR command follows the following pattern: -.sp -.nf -\f3lvmid [ [ classname | JARfilename | "Unknown"] [ arg* ] [ jvmarg* ] ]\fP -.fi -.nf -\f3\fP -.fi -.sp -All output tokens are separated by white space\&. An \f3arg\fR value that includes embedded white space introduces ambiguity when attempting to map arguments to their actual positional parameters\&. -.PP -\fINote:\fR It is recommended that you do not write scripts to parse \f3jps\fR output because the format might change in future releases\&. If you write scripts that parse \f3jps\fR output, then expect to modify them for future releases of this tool\&. -.SH EXAMPLES -This section provides examples of the \f3jps\fR command\&. -.PP -List the instrumented JVMs on the local host: -.sp -.nf -\f3jps\fP -.fi -.nf -\f318027 Java2Demo\&.JAR\fP -.fi -.nf -\f318032 jps\fP -.fi -.nf -\f318005 jstat\fP -.fi -.nf -\f3\fP -.fi -.sp -The following example lists the instrumented JVMs on a remote host\&. This example assumes that the \f3jstat\fR server and either the its internal RMI registry or a separate external rmiregistry process are running on the remote host on the default port (port 1099)\&. It also assumes that the local host has appropriate permissions to access the remote host\&. This example also includes the \f3-l\fR option to output the long form of the class names or JAR file names\&. -.sp -.nf -\f3jps \-l remote\&.domain\fP -.fi -.nf -\f33002 /opt/jdk1\&.7\&.0/demo/jfc/Java2D/Java2Demo\&.JAR\fP -.fi -.nf -\f32857 sun\&.tools\&.jstatd\&.jstatd\fP -.fi -.nf -\f3\fP -.fi -.sp -The following example lists the instrumented JVMs on a remote host with a non-default port for the RMI registry\&. This example assumes that the \f3jstatd\fR server, with an internal RMI registry bound to port 2002, is running on the remote host\&. This example also uses the \f3-m\fR option to include the arguments passed to the \f3main\fR method of each of the listed Java applications\&. -.sp -.nf -\f3jps \-m remote\&.domain:2002\fP -.fi -.nf -\f33002 /opt/jdk1\&.7\&.0/demo/jfc/Java2D/Java2Demo\&.JAR\fP -.fi -.nf -\f33102 sun\&.tools\&.jstatd\&.jstatd \-p 2002\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH SEE\ ALSO -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -jstat(1) -.TP 0.2i -\(bu -jstatd(1) -.TP 0.2i -\(bu -rmiregistry(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Monitoring Tools +.\" Title: jps.1 +.\" +.if n .pl 99999 +.TH jps 1 "21 November 2013" "JDK 8" "Monitoring Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jps \- Lists the instrumented Java Virtual Machines (JVMs) on the target system\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjps\fR [ \fIoptions\fR ] [ \fIhostid\fR ] +.fi +.sp +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.TP +\fIhostid\fR +The identifier of the host for which the process report should be generated\&. The \f3hostid\fR can include optional components that indicate the communications protocol, port number, and other implementation specific data\&. See Host Identifier\&. +.SH DESCRIPTION +The \f3jps\fR command lists the instrumented Java HotSpot VMs on the target system\&. The command is limited to reporting information on JVMs for which it has the access permissions\&. +.PP +If the \f3jps\fR command is run without specifying a \f3hostid\fR, then it searches for instrumented JVMs on the local host\&. If started with a \f3hostid\fR, then it searches for JVMs on the indicated host, using the specified protocol and port\&. A \f3jstatd\fR process is assumed to be running on the target host\&. +.PP +The \f3jps\fR command reports the local JVM identifier, or \f3lvmid\fR, for each instrumented JVM found on the target system\&. The \f3lvmid\fR is typically, but not necessarily, the operating system\&'s process identifier for the JVM process\&. With no options, \f3jps\fR lists each Java application\&'s \f3lvmid\fR followed by the short form of the application\&'s class name or jar file name\&. The short form of the class name or JAR file name omits the class\&'s package information or the JAR files path information\&. +.PP +The \f3jps\fR command uses the Java launcher to find the class name and arguments passed to the main method\&. If the target JVM is started with a custom launcher, then the class or JAR file name and the arguments to the \f3main\fR method are not available\&. In this case, the \f3jps\fR command outputs the string \f3Unknown\fR for the class name or JAR file name and for the arguments to the \f3main\fR method\&. +.PP +The list of JVMs produced by the \f3jps\fR command can be limited by the permissions granted to the principal running the command\&. The command only lists the JVMs for which the principle has access rights as determined by operating system-specific access control mechanisms\&. +.SH OPTIONS +The \f3jps\fR command supports a number of options that modify the output of the command\&. These options are subject to change or removal in the future\&. +.TP +-q +.br +Suppresses the output of the class name, JAR file name, and arguments passed to the \f3main\fR method, producing only a list of local JVM identifiers\&. +.TP +-m +.br +Displays the arguments passed to the \f3main\fR method\&. The output may be \f3null\fR for embedded JVMs\&. +.TP +-l +.br +Displays the full package name for the application\&'s \f3main\fR class or the full path name to the application\&'s JAR file\&. +.TP +-v +.br +Displays the arguments passed to the JVM\&. +.TP +-V +.br +Suppresses the output of the class name, JAR file name, and arguments passed to the main method, producing only a list of local JVM identifiers\&. +.TP +-J\f3option\fR +.br +Passes \f3option\fR to the JVM, where option is one of the \f3options\fR described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH HOST\ IDENTIFIER +The host identifier, or \f3hostid\fR is a string that indicates the target system\&. The syntax of the \f3hostid\fR string corresponds to the syntax of a URI: +.sp +.nf +\f3[protocol:][[//]hostname][:port][/servername]\fP +.fi +.nf +\f3\fP +.fi +.sp +.TP +\fIprotocol\fR +The communications protocol\&. If the \f3protocol\fR is omitted and a \f3hostname\fR is not specified, then the default protocol is a platform-specific, optimized, local protocol\&. If the protocol is omitted and a host name is specified, then the default protocol is \f3rmi\fR\&. +.TP +hostname +A hostname or IP address that indicates the target host\&. If you omit the \f3hostname\fR parameter, then the target host is the local host\&. +.TP +port +The default port for communicating with the remote server\&. If the \f3hostname\fR parameter is omitted or the \f3protocol\fR parameter specifies an optimized, local protocol, then the \f3port\fR parameter is ignored\&. Otherwise, treatment of the \f3port\fR parameter is implementation specific\&. For the default \f3rmi\fR protocol, the \f3port\fR parameter indicates the port number for the rmiregistry on the remote host\&. If the \f3port\fR parameter is omitted, and the \f3protocol\fR parameter indicates \f3rmi\fR, then the default rmiregistry port (1099) is used\&. +.TP +servername +The treatment of this parameter depends on the implementation\&. For the optimized, local protocol, this field is ignored\&. For the \f3rmi\fR protocol, this parameter is a string that represents the name of the RMI remote object on the remote host\&. See the \f3jstatd\fR command \f3-n\fRoption for more information\&. +.SH OUTPUT\ FORMAT +The output of the \f3jps\fR command follows the following pattern: +.sp +.nf +\f3lvmid [ [ classname | JARfilename | "Unknown"] [ arg* ] [ jvmarg* ] ]\fP +.fi +.nf +\f3\fP +.fi +.sp +All output tokens are separated by white space\&. An \f3arg\fR value that includes embedded white space introduces ambiguity when attempting to map arguments to their actual positional parameters\&. +.PP +\fINote:\fR It is recommended that you do not write scripts to parse \f3jps\fR output because the format might change in future releases\&. If you write scripts that parse \f3jps\fR output, then expect to modify them for future releases of this tool\&. +.SH EXAMPLES +This section provides examples of the \f3jps\fR command\&. +.PP +List the instrumented JVMs on the local host: +.sp +.nf +\f3jps\fP +.fi +.nf +\f318027 Java2Demo\&.JAR\fP +.fi +.nf +\f318032 jps\fP +.fi +.nf +\f318005 jstat\fP +.fi +.nf +\f3\fP +.fi +.sp +The following example lists the instrumented JVMs on a remote host\&. This example assumes that the \f3jstat\fR server and either the its internal RMI registry or a separate external rmiregistry process are running on the remote host on the default port (port 1099)\&. It also assumes that the local host has appropriate permissions to access the remote host\&. This example also includes the \f3-l\fR option to output the long form of the class names or JAR file names\&. +.sp +.nf +\f3jps \-l remote\&.domain\fP +.fi +.nf +\f33002 /opt/jdk1\&.7\&.0/demo/jfc/Java2D/Java2Demo\&.JAR\fP +.fi +.nf +\f32857 sun\&.tools\&.jstatd\&.jstatd\fP +.fi +.nf +\f3\fP +.fi +.sp +The following example lists the instrumented JVMs on a remote host with a non-default port for the RMI registry\&. This example assumes that the \f3jstatd\fR server, with an internal RMI registry bound to port 2002, is running on the remote host\&. This example also uses the \f3-m\fR option to include the arguments passed to the \f3main\fR method of each of the listed Java applications\&. +.sp +.nf +\f3jps \-m remote\&.domain:2002\fP +.fi +.nf +\f33002 /opt/jdk1\&.7\&.0/demo/jfc/Java2D/Java2Demo\&.JAR\fP +.fi +.nf +\f33102 sun\&.tools\&.jstatd\&.jstatd \-p 2002\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jstat(1) +.TP 0.2i +\(bu +jstatd(1) +.TP 0.2i +\(bu +rmiregistry(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/jrunscript.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/jrunscript.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,195 +1,195 @@ -'\" t -.\" Copyright (c) 2006, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Scripting Tools -.\" Title: jrunscript.1 -.\" -.if n .pl 99999 -.TH jrunscript 1 "21 November 2013" "JDK 8" "Scripting Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jrunscript \- Runs a command-line script shell that supports interactive and batch modes\&. This command is experimental and unsupported\&. -.SH SYNOPSIS -.sp -.nf - -\fBjrunscript\fR [\fIoptions\fR] [\fIarguments\fR] -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIarguments\fR -Arguments, when used, follow immediately after options or the command name\&. See Arguments\&. -.SH DESCRIPTION -The \f3jrunscript\fR command is a language-independent command-line script shell\&. The \f3jrunscript\fR command supports both an interactive (read-eval-print) mode and a batch (\f3-f\fR option) mode of script execution\&. By default, JavaScript is the language used, but the \f3-l\fR option can be used to specify a different language\&. By using Java to scripting language communication, the \f3jrunscript\fR command supports an exploratory programming style\&. -.SH OPTIONS -.TP --classpath \fIpath\fR -.br -Indicate where any class files are that the script needs to access\&. -.TP --cp \fIpath\fR -.br -Same as \f3-classpath\fR\f3path\fR\&. -.TP --D\fIname\fR=\fIvalue\fR -.br -Sets a Java system property\&. -.TP --J\fIflag\fR -.br -Passes \f3flag\fR directly to the Java Virtual Machine where the \f3jrunscript\fR command is running\&. -.TP --I \fIlanguage\fR -.br -Uses the specified scripting language\&. By default, JavaScript is used\&. To use other scripting languages, you must specify the corresponding script engine\&'s JAR file with the \f3-cp\fR or \f3-classpath\fR option\&. -.TP --e \fIscript\fR -.br -Evaluates the specified script\&. This option can be used to run one-line scripts that are specified completely on the command line\&. -.TP --encoding \fIencoding\fR -.br -Specifies the character encoding used to read script files\&. -.TP --f \fIscript-file\fR -.br -Evaluates the specified script file (batch mode)\&. -.TP --f - -.br -Reads and evaluates a script from standard input (interactive mode)\&. -.TP --help -.br -Displays a help message and exits\&. -.TP --? -.br -Displays a help message and exits\&. -.TP --q -.br -Lists all script engines available and exits\&. -.SH ARGUMENTS -If arguments are present and if no \f3-e\fR or \f3-f\fR option is used, then the first argument is the script file and the rest of the arguments, if any, are passed to the script\&. If arguments and \f3-e\fR or the \f3-f\fR option are used, then all arguments are passed to the script\&. If arguments, \f3-e\fR and \f3-f\fR are missing, then interactive mode is used\&. Script arguments are available to a script in an engine variable named \f3arguments\fR of type \f3String\fR array\&. -.SH EXAMPLES -.SS EXECUTE\ INLINE\ SCRIPTS -.sp -.nf -\f3jrunscript \-e "print(\&'hello world\&')"\fP -.fi -.nf -\f3jrunscript \-e "cat(\&'http://www\&.example\&.com\&')"\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS USE\ SPECIFIED\ LANGUAGE\ AND\ EVALUATE\ THE\ SCRIPT\ FILE -.sp -.nf -\f3jrunscript \-l js \-f test\&.js\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS INTERACTIVE\ MODE -.sp -.nf -\f3jrunscript\fP -.fi -.nf -\f3js> print(\&'Hello World\en\&');\fP -.fi -.nf -\f3Hello World\fP -.fi -.nf -\f3js> 34 + 55\fP -.fi -.nf -\f389\&.0\fP -.fi -.nf -\f3js> t = new java\&.lang\&.Thread(function() { print(\&'Hello World\en\&'); })\fP -.fi -.nf -\f3Thread[Thread\-0,5,main]\fP -.fi -.nf -\f3js> t\&.start()\fP -.fi -.nf -\f3js> Hello World\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3js>\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS RUN\ SCRIPT\ FILE\ WITH\ SCRIPT\ ARGUMENTS -The test\&.js file is the script file\&. The \f3arg1\fR, \f3arg2\fR and \f3arg3\fR arguments are passed to the script\&. The script can access these arguments with an arguments array\&. -.sp -.nf -\f3jrunscript test\&.js arg1 arg2 arg3\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH SEE\ ALSO -If JavaScript is used, then before it evaluates a user defined script, the \f3jrunscript\fR command initializes certain built-in functions and objects\&. These JavaScript built-ins are documented in JsDoc-Toolkit at http://code\&.google\&.com/p/jsdoc-toolkit/ -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2006, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Scripting Tools +.\" Title: jrunscript.1 +.\" +.if n .pl 99999 +.TH jrunscript 1 "21 November 2013" "JDK 8" "Scripting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jrunscript \- Runs a command-line script shell that supports interactive and batch modes\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjrunscript\fR [\fIoptions\fR] [\fIarguments\fR] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIarguments\fR +Arguments, when used, follow immediately after options or the command name\&. See Arguments\&. +.SH DESCRIPTION +The \f3jrunscript\fR command is a language-independent command-line script shell\&. The \f3jrunscript\fR command supports both an interactive (read-eval-print) mode and a batch (\f3-f\fR option) mode of script execution\&. By default, JavaScript is the language used, but the \f3-l\fR option can be used to specify a different language\&. By using Java to scripting language communication, the \f3jrunscript\fR command supports an exploratory programming style\&. +.SH OPTIONS +.TP +-classpath \fIpath\fR +.br +Indicate where any class files are that the script needs to access\&. +.TP +-cp \fIpath\fR +.br +Same as \f3-classpath\fR\f3path\fR\&. +.TP +-D\fIname\fR=\fIvalue\fR +.br +Sets a Java system property\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR directly to the Java Virtual Machine where the \f3jrunscript\fR command is running\&. +.TP +-I \fIlanguage\fR +.br +Uses the specified scripting language\&. By default, JavaScript is used\&. To use other scripting languages, you must specify the corresponding script engine\&'s JAR file with the \f3-cp\fR or \f3-classpath\fR option\&. +.TP +-e \fIscript\fR +.br +Evaluates the specified script\&. This option can be used to run one-line scripts that are specified completely on the command line\&. +.TP +-encoding \fIencoding\fR +.br +Specifies the character encoding used to read script files\&. +.TP +-f \fIscript-file\fR +.br +Evaluates the specified script file (batch mode)\&. +.TP +-f - +.br +Reads and evaluates a script from standard input (interactive mode)\&. +.TP +-help +.br +Displays a help message and exits\&. +.TP +-? +.br +Displays a help message and exits\&. +.TP +-q +.br +Lists all script engines available and exits\&. +.SH ARGUMENTS +If arguments are present and if no \f3-e\fR or \f3-f\fR option is used, then the first argument is the script file and the rest of the arguments, if any, are passed to the script\&. If arguments and \f3-e\fR or the \f3-f\fR option are used, then all arguments are passed to the script\&. If arguments, \f3-e\fR and \f3-f\fR are missing, then interactive mode is used\&. Script arguments are available to a script in an engine variable named \f3arguments\fR of type \f3String\fR array\&. +.SH EXAMPLES +.SS EXECUTE\ INLINE\ SCRIPTS +.sp +.nf +\f3jrunscript \-e "print(\&'hello world\&')"\fP +.fi +.nf +\f3jrunscript \-e "cat(\&'http://www\&.example\&.com\&')"\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS USE\ SPECIFIED\ LANGUAGE\ AND\ EVALUATE\ THE\ SCRIPT\ FILE +.sp +.nf +\f3jrunscript \-l js \-f test\&.js\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS INTERACTIVE\ MODE +.sp +.nf +\f3jrunscript\fP +.fi +.nf +\f3js> print(\&'Hello World\en\&');\fP +.fi +.nf +\f3Hello World\fP +.fi +.nf +\f3js> 34 + 55\fP +.fi +.nf +\f389\&.0\fP +.fi +.nf +\f3js> t = new java\&.lang\&.Thread(function() { print(\&'Hello World\en\&'); })\fP +.fi +.nf +\f3Thread[Thread\-0,5,main]\fP +.fi +.nf +\f3js> t\&.start()\fP +.fi +.nf +\f3js> Hello World\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3js>\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS RUN\ SCRIPT\ FILE\ WITH\ SCRIPT\ ARGUMENTS +The test\&.js file is the script file\&. The \f3arg1\fR, \f3arg2\fR and \f3arg3\fR arguments are passed to the script\&. The script can access these arguments with an arguments array\&. +.sp +.nf +\f3jrunscript test\&.js arg1 arg2 arg3\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +If JavaScript is used, then before it evaluates a user defined script, the \f3jrunscript\fR command initializes certain built-in functions and objects\&. These JavaScript built-ins are documented in JsDoc-Toolkit at http://code\&.google\&.com/p/jsdoc-toolkit/ +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/jsadebugd.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/jsadebugd.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,108 +1,108 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Troubleshooting Tools -.\" Title: jsadebugd.1 -.\" -.if n .pl 99999 -.TH jsadebugd 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jsadebugd \- Attaches to a Java process or core file and acts as a debug server\&. This command is experimental and unsupported\&. -.SH SYNOPSIS -.sp -.nf - -\fBjsadebugd\fR \fIpid\fR [ \fIserver\-id\fR ] -.fi -.nf - -\fBjsadebugd\fR \fIexecutable\fR \fIcore\fR [ \fIserver\-id\fR ] -.fi -.sp -.TP -\fIpid\fR -The process ID of the process to which the debug server attaches\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. At most one instance of the debug server can be attached to a single process\&. -.TP -\fIexecutable\fR -The Java executable from which the core dump was produced\&. -.TP -\fIcore\fR -The core file to which the debug server should attach\&. -.TP -\fIserver-id\fR -An optional unique ID that is needed when multiple debug servers are started on the same machine\&. This ID must be used by remote clients to identify the particular debug server to which to attach\&. Within a single machine, this ID must be unique\&. -.SH DESCRIPTION -The \f3jsadebugd\fR command attaches to a Java process or core file and acts as a debug server\&. Remote clients such as \f3jstack\fR, \f3jmap\fR, and \f3jinfo\fR can attach to the server through Java Remote Method Invocation (RMI)\&. Before you start the \f3jsadebugd\fR command, start the RMI registry with the \f3rmiregistry\fR command as follows where \fI$JAVA_HOME\fR is the JDK installation directory: -.sp -.nf -\f3rmiregistry \-J\-Xbootclasspath/p:$JAVA_HOME/lib/sajdi\&.jar\fP -.fi -.nf -\f3\fP -.fi -.sp -If the RMI registry was not started, then the \f3jsadebugd\fR command starts an RMI registry in a standard (1099) port internally\&. The debug server can be stopped by sending a \f3SIGINT\fR to it\&. To send a SIGINT press \fICtrl+C\fR\&. -.PP -\fINote:\fR This utility is unsupported and may or may not be available in future releases of the JDK\&. In Windows Systems where \f3dbgeng\&.dll\fR is not present, Debugging Tools For Windows must be installed to have these tools working\&. The \f3PATH\fR environment variable should contain the location of jvm\&.dll used by the target process or the location from which the crash dump file was produced\&. For example, \f3s\fR\f3et PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -jinfo(1) -.TP 0.2i -\(bu -jmap(1) -.TP 0.2i -\(bu -jps(1) -.TP 0.2i -\(bu -jstack(1) -.TP 0.2i -\(bu -rmiregistry(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jsadebugd.1 +.\" +.if n .pl 99999 +.TH jsadebugd 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jsadebugd \- Attaches to a Java process or core file and acts as a debug server\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjsadebugd\fR \fIpid\fR [ \fIserver\-id\fR ] +.fi +.nf + +\fBjsadebugd\fR \fIexecutable\fR \fIcore\fR [ \fIserver\-id\fR ] +.fi +.sp +.TP +\fIpid\fR +The process ID of the process to which the debug server attaches\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. At most one instance of the debug server can be attached to a single process\&. +.TP +\fIexecutable\fR +The Java executable from which the core dump was produced\&. +.TP +\fIcore\fR +The core file to which the debug server should attach\&. +.TP +\fIserver-id\fR +An optional unique ID that is needed when multiple debug servers are started on the same machine\&. This ID must be used by remote clients to identify the particular debug server to which to attach\&. Within a single machine, this ID must be unique\&. +.SH DESCRIPTION +The \f3jsadebugd\fR command attaches to a Java process or core file and acts as a debug server\&. Remote clients such as \f3jstack\fR, \f3jmap\fR, and \f3jinfo\fR can attach to the server through Java Remote Method Invocation (RMI)\&. Before you start the \f3jsadebugd\fR command, start the RMI registry with the \f3rmiregistry\fR command as follows where \fI$JAVA_HOME\fR is the JDK installation directory: +.sp +.nf +\f3rmiregistry \-J\-Xbootclasspath/p:$JAVA_HOME/lib/sajdi\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +If the RMI registry was not started, then the \f3jsadebugd\fR command starts an RMI registry in a standard (1099) port internally\&. The debug server can be stopped by sending a \f3SIGINT\fR to it\&. To send a SIGINT press \fICtrl+C\fR\&. +.PP +\fINote:\fR This utility is unsupported and may or may not be available in future releases of the JDK\&. In Windows Systems where \f3dbgeng\&.dll\fR is not present, Debugging Tools For Windows must be installed to have these tools working\&. The \f3PATH\fR environment variable should contain the location of jvm\&.dll used by the target process or the location from which the crash dump file was produced\&. For example, \f3s\fR\f3et PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jinfo(1) +.TP 0.2i +\(bu +jmap(1) +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jstack(1) +.TP 0.2i +\(bu +rmiregistry(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/jstack.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/jstack.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,137 +1,137 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Troubleshooting Tools -.\" Title: jstack.1 -.\" -.if n .pl 99999 -.TH jstack 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jstack \- Prints Java thread stack traces for a Java process, core file, or remote debug server\&. This command is experimental and unsupported\&. -.SH SYNOPSIS -.sp -.nf - -\fBjstack\fR [ \fIoptions\fR ] \fIpid\fR -.fi -.nf - -\fBjstack\fR [ \fIoptions\fR ] \fIexecutable\fR \fIcore\fR -.fi -.nf - -\fBjstack\fR [ \fIoptions\fR ] [ \fIserver\-id\fR@ ] \fIremote\-hostname\-or\-IP\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIpid\fR -The process ID for which the stack trace is printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. -.TP -\fIexecutable\fR -The Java executable from which the core dump was produced\&. -.TP -\fIcore\fR -The core file for which the stack trace is to be printed\&. -.TP -\fIremote-hostname-or-IP\fR -The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. -.TP -\fIserver-id\fR -An optional unique ID to use when multiple debug servers are running on the same remote host\&. -.SH DESCRIPTION -The \f3jstack\fR command prints Java stack traces of Java threads for a specified Java process, core file, or remote debug server\&. For each Java frame, the full class name, method name, byte code index (BCI), and line number, when available, are printed\&. With the \f3-m\fR option, the \f3jstack\fR command prints both Java and native frames of all threads with the program counter (PC)\&. For each native frame, the closest native symbol to PC, when available, is printed\&. C++ mangled names are not demangled\&. To demangle C++ names, the output of this command can be piped to \f3c++filt\fR\&. When the specified process is running on a 64-bit Java Virtual Machine, you might need to specify the \f3-J-d64\fR option, for example: \f3jstack -J-d64 -m pid\fR\&. -.PP -\fINote:\fR This utility is unsupported and might not be available in future release of the JDK\&. In Windows Systems where the dbgeng\&.dll file is not present, Debugging Tools For Windows must be installed so these tools work\&. The \f3PATH\fR environment variable needs to contain the location of the jvm\&.dll that is used by the target process, or the location from which the crash dump file was produced\&. For example: -.sp -.nf -\f3set PATH=<jdk>\ejre\ebin\eclient;%PATH%\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH OPTIONS -.TP --F -.br -Force a stack dump when \f3jstack\fR [\f3-l\fR] \f3pid\fR does not respond\&. -.TP --l -.br -Long listing\&. Prints additional information about locks such as a list of owned \f3java\&.util\&.concurrent\fR ownable synchronizers\&. See the \f3AbstractOwnableSynchronizer\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/util/concurrent/locks/AbstractOwnableSynchronizer\&.html -.TP --m -.br -Prints a mixed mode stack trace that has both Java and native C/C++ frames\&. -.TP --h -.br -Prints a help message\&. -.TP --help -.br -Prints a help message\&. -.SH KNOWN\ BUGS -In mixed mode stack trace, the \f3-m\fR option does not work with the remote debug server\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -pstack(1) -.TP 0.2i -\(bu -C++filt(1) -.TP 0.2i -\(bu -jps(1) -.TP 0.2i -\(bu -jsadebugd(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jstack.1 +.\" +.if n .pl 99999 +.TH jstack 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jstack \- Prints Java thread stack traces for a Java process, core file, or remote debug server\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjstack\fR [ \fIoptions\fR ] \fIpid\fR +.fi +.nf + +\fBjstack\fR [ \fIoptions\fR ] \fIexecutable\fR \fIcore\fR +.fi +.nf + +\fBjstack\fR [ \fIoptions\fR ] [ \fIserver\-id\fR@ ] \fIremote\-hostname\-or\-IP\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIpid\fR +The process ID for which the stack trace is printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. +.TP +\fIexecutable\fR +The Java executable from which the core dump was produced\&. +.TP +\fIcore\fR +The core file for which the stack trace is to be printed\&. +.TP +\fIremote-hostname-or-IP\fR +The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. +.TP +\fIserver-id\fR +An optional unique ID to use when multiple debug servers are running on the same remote host\&. +.SH DESCRIPTION +The \f3jstack\fR command prints Java stack traces of Java threads for a specified Java process, core file, or remote debug server\&. For each Java frame, the full class name, method name, byte code index (BCI), and line number, when available, are printed\&. With the \f3-m\fR option, the \f3jstack\fR command prints both Java and native frames of all threads with the program counter (PC)\&. For each native frame, the closest native symbol to PC, when available, is printed\&. C++ mangled names are not demangled\&. To demangle C++ names, the output of this command can be piped to \f3c++filt\fR\&. When the specified process is running on a 64-bit Java Virtual Machine, you might need to specify the \f3-J-d64\fR option, for example: \f3jstack -J-d64 -m pid\fR\&. +.PP +\fINote:\fR This utility is unsupported and might not be available in future release of the JDK\&. In Windows Systems where the dbgeng\&.dll file is not present, Debugging Tools For Windows must be installed so these tools work\&. The \f3PATH\fR environment variable needs to contain the location of the jvm\&.dll that is used by the target process, or the location from which the crash dump file was produced\&. For example: +.sp +.nf +\f3set PATH=<jdk>\ejre\ebin\eclient;%PATH%\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-F +.br +Force a stack dump when \f3jstack\fR [\f3-l\fR] \f3pid\fR does not respond\&. +.TP +-l +.br +Long listing\&. Prints additional information about locks such as a list of owned \f3java\&.util\&.concurrent\fR ownable synchronizers\&. See the \f3AbstractOwnableSynchronizer\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/util/concurrent/locks/AbstractOwnableSynchronizer\&.html +.TP +-m +.br +Prints a mixed mode stack trace that has both Java and native C/C++ frames\&. +.TP +-h +.br +Prints a help message\&. +.TP +-help +.br +Prints a help message\&. +.SH KNOWN\ BUGS +In mixed mode stack trace, the \f3-m\fR option does not work with the remote debug server\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +pstack(1) +.TP 0.2i +\(bu +C++filt(1) +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jsadebugd(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/jstat.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/jstat.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/linux/doc/man/jstatd.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/jstatd.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,209 +1,209 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Monitoring Tools -.\" Title: jstatd.1 -.\" -.if n .pl 99999 -.TH jstatd 1 "21 November 2013" "JDK 8" "Monitoring Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jstatd \- Monitors Java Virtual Machines (JVMs) and enables remote monitoring tools to attach to JVMs\&. This command is experimental and unsupported\&. -.SH SYNOPSIS -.sp -.nf - -\fBjstatd\fR [ \fIoptions\fR ] -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.SH DESCRIPTION -The \f3jstatd\fR command is an RMI server application that monitors for the creation and termination of instrumented Java HotSpot VMs and provides an interface to enable remote monitoring tools to attach to JVMs that are running on the local host\&. -.PP -The \f3jstatd\fR server requires an RMI registry on the local host\&. The \f3jstatd\fR server attempts to attach to the RMI registry on the default port, or on the port you specify with the \f3-p\fR\f3port\fR option\&. If an RMI registry is not found, then one is created within the \f3jstatd\fR application that is bound to the port that is indicated by the \f3-p\fR\f3port\fR option or to the default RMI registry port when the \f3-p\fR\f3port\fR option is omitted\&. You can stop the creation of an internal RMI registry by specifying the \f3-nr\fR option\&. -.SH OPTIONS -.TP --nr -.br -Does not attempt to create an internal RMI registry within the \f3jstatd\fR process when an existing RMI registry is not found\&. -.TP --p \fIport\fR -.br -The port number where the RMI registry is expected to be found, or when not found, created if the \f3-nr\fR option is not specified\&. -.TP --n \fIrminame\fR -.br -Name to which the remote RMI object is bound in the RMI registry\&. The default name is \f3JStatRemoteHost\fR\&. If multiple \f3jstatd\fR servers are started on the same host, then the name of the exported RMI object for each server can be made unique by specifying this option\&. However, doing so requires that the unique server name be included in the monitoring client\&'s \f3hostid\fR and \f3vmid\fR strings\&. -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the JVM, where option is one of the \f3options\fR described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH SECURITY -The \f3jstatd\fR server can only monitor JVMs for which it has the appropriate native access permissions\&. Therefore, the \f3jstatd\fR process must be running with the same user credentials as the target JVMs\&. Some user credentials, such as the root user in UNIX-based systems, have permission to access the instrumentation exported by any JVM on the system\&. A \f3jstatd\fR process running with such credentials can monitor any JVM on the system, but introduces additional security concerns\&. -.PP -The \f3jstatd\fR server does not provide any authentication of remote clients\&. Therefore, running a \f3jstatd\fR server process exposes the instrumentation export by all JVMs for which the \f3jstatd\fR process has access permissions to any user on the network\&. This exposure might be undesirable in your environment, and therefore, local security policies should be considered before you start the \f3jstatd\fR process, particularly in production environments or on networks that are not secure\&. -.PP -The \f3jstatd\fR server installs an instance of \f3RMISecurityPolicy\fR when no other security manager is installed, and therefore, requires a security policy file to be specified\&. The policy file must conform to Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html -.PP -The following policy file allows the \f3jstatd\fR server to run without any security exceptions\&. This policy is less liberal than granting all permissions to all code bases, but is more liberal than a policy that grants the minimal permissions to run the \f3jstatd\fR server\&. -.sp -.nf -\f3grant codebase "file:${java\&.home}/\&.\&./lib/tools\&.jar" { \fP -.fi -.nf -\f3 permission java\&.security\&.AllPermission;\fP -.fi -.nf -\f3};\fP -.fi -.nf -\f3\fP -.fi -.sp -To use this policy setting, copy the text into a file called \f3jstatd\&.all\&.policy\fR and run the \f3jstatd\fR server as follows: -.sp -.nf -\f3jstatd \-J\-Djava\&.security\&.policy=jstatd\&.all\&.policy\fP -.fi -.nf -\f3\fP -.fi -.sp -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 address spoofing attacks\&. If your security concerns cannot be addressed with a customized policy file, then the safest action is to not run the \f3jstatd\fR server and use the \f3jstat\fR and \f3jps\fR tools locally\&. -.SH REMOTE\ INTERFACE -The interface exported by the \f3jstatd\fR process is proprietary and guaranteed to change\&. Users and developers are discouraged from writing to this interface\&. -.SH EXAMPLES -The following are examples of the \f3jstatd\fR command\&. The \f3jstatd\fR scripts automatically start the server in the background -.SS INTERNAL\ RMI\ REGISTRY -This example shows hos to start a \f3jstatd\fR session with an internal RMI registry\&. This example assumes that no other server is bound to the default RMI registry port (port 1099)\&. -.sp -.nf -\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS EXTERNAL\ RMI\ REGISTRY -This example starts a \f3jstatd\fR session with a external RMI registry\&. -.sp -.nf -\f3rmiregistry&\fP -.fi -.nf -\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP -.fi -.nf -\f3\fP -.fi -.sp -This example starts a \f3jstatd\fR session with an external RMI registry server on port 2020\&. -.sp -.nf -\f3jrmiregistry 2020&\fP -.fi -.nf -\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-p 2020\fP -.fi -.nf -\f3\fP -.fi -.sp -This example starts a \f3jstatd\fR session with an external RMI registry on port 2020 that is bound to \f3AlternateJstatdServerName\fR\&. -.sp -.nf -\f3rmiregistry 2020&\fP -.fi -.nf -\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-p 2020\fP -.fi -.nf -\f3 \-n AlternateJstatdServerName\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS STOP\ THE\ CREATION\ OF\ AN\ IN-PROCESS\ RMI\ REGISTRY -This example starts a \f3jstatd\fR session that does not create an RMI registry when one is not found\&. This example assumes an RMI registry is already running\&. If an RMI registry is not running, then an error message is displayed\&. -.sp -.nf -\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-nr\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS ENABLE\ RMI\ LOGGING -This example starts a \f3jstatd\fR session with RMI logging capabilities enabled\&. This technique is useful as a troubleshooting aid or for monitoring server activities\&. -.sp -.nf -\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP -.fi -.nf -\f3 \-J\-Djava\&.rmi\&.server\&.logCalls=true\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH SEE\ ALSO -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -jps(1) -.TP 0.2i -\(bu -jstat(1) -.TP 0.2i -\(bu -rmiregistry(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Monitoring Tools +.\" Title: jstatd.1 +.\" +.if n .pl 99999 +.TH jstatd 1 "21 November 2013" "JDK 8" "Monitoring Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jstatd \- Monitors Java Virtual Machines (JVMs) and enables remote monitoring tools to attach to JVMs\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjstatd\fR [ \fIoptions\fR ] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.SH DESCRIPTION +The \f3jstatd\fR command is an RMI server application that monitors for the creation and termination of instrumented Java HotSpot VMs and provides an interface to enable remote monitoring tools to attach to JVMs that are running on the local host\&. +.PP +The \f3jstatd\fR server requires an RMI registry on the local host\&. The \f3jstatd\fR server attempts to attach to the RMI registry on the default port, or on the port you specify with the \f3-p\fR\f3port\fR option\&. If an RMI registry is not found, then one is created within the \f3jstatd\fR application that is bound to the port that is indicated by the \f3-p\fR\f3port\fR option or to the default RMI registry port when the \f3-p\fR\f3port\fR option is omitted\&. You can stop the creation of an internal RMI registry by specifying the \f3-nr\fR option\&. +.SH OPTIONS +.TP +-nr +.br +Does not attempt to create an internal RMI registry within the \f3jstatd\fR process when an existing RMI registry is not found\&. +.TP +-p \fIport\fR +.br +The port number where the RMI registry is expected to be found, or when not found, created if the \f3-nr\fR option is not specified\&. +.TP +-n \fIrminame\fR +.br +Name to which the remote RMI object is bound in the RMI registry\&. The default name is \f3JStatRemoteHost\fR\&. If multiple \f3jstatd\fR servers are started on the same host, then the name of the exported RMI object for each server can be made unique by specifying this option\&. However, doing so requires that the unique server name be included in the monitoring client\&'s \f3hostid\fR and \f3vmid\fR strings\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the JVM, where option is one of the \f3options\fR described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH SECURITY +The \f3jstatd\fR server can only monitor JVMs for which it has the appropriate native access permissions\&. Therefore, the \f3jstatd\fR process must be running with the same user credentials as the target JVMs\&. Some user credentials, such as the root user in UNIX-based systems, have permission to access the instrumentation exported by any JVM on the system\&. A \f3jstatd\fR process running with such credentials can monitor any JVM on the system, but introduces additional security concerns\&. +.PP +The \f3jstatd\fR server does not provide any authentication of remote clients\&. Therefore, running a \f3jstatd\fR server process exposes the instrumentation export by all JVMs for which the \f3jstatd\fR process has access permissions to any user on the network\&. This exposure might be undesirable in your environment, and therefore, local security policies should be considered before you start the \f3jstatd\fR process, particularly in production environments or on networks that are not secure\&. +.PP +The \f3jstatd\fR server installs an instance of \f3RMISecurityPolicy\fR when no other security manager is installed, and therefore, requires a security policy file to be specified\&. The policy file must conform to Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html +.PP +The following policy file allows the \f3jstatd\fR server to run without any security exceptions\&. This policy is less liberal than granting all permissions to all code bases, but is more liberal than a policy that grants the minimal permissions to run the \f3jstatd\fR server\&. +.sp +.nf +\f3grant codebase "file:${java\&.home}/\&.\&./lib/tools\&.jar" { \fP +.fi +.nf +\f3 permission java\&.security\&.AllPermission;\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fP +.fi +.sp +To use this policy setting, copy the text into a file called \f3jstatd\&.all\&.policy\fR and run the \f3jstatd\fR server as follows: +.sp +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=jstatd\&.all\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp +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 address spoofing attacks\&. If your security concerns cannot be addressed with a customized policy file, then the safest action is to not run the \f3jstatd\fR server and use the \f3jstat\fR and \f3jps\fR tools locally\&. +.SH REMOTE\ INTERFACE +The interface exported by the \f3jstatd\fR process is proprietary and guaranteed to change\&. Users and developers are discouraged from writing to this interface\&. +.SH EXAMPLES +The following are examples of the \f3jstatd\fR command\&. The \f3jstatd\fR scripts automatically start the server in the background +.SS INTERNAL\ RMI\ REGISTRY +This example shows hos to start a \f3jstatd\fR session with an internal RMI registry\&. This example assumes that no other server is bound to the default RMI registry port (port 1099)\&. +.sp +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS EXTERNAL\ RMI\ REGISTRY +This example starts a \f3jstatd\fR session with a external RMI registry\&. +.sp +.nf +\f3rmiregistry&\fP +.fi +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp +This example starts a \f3jstatd\fR session with an external RMI registry server on port 2020\&. +.sp +.nf +\f3jrmiregistry 2020&\fP +.fi +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-p 2020\fP +.fi +.nf +\f3\fP +.fi +.sp +This example starts a \f3jstatd\fR session with an external RMI registry on port 2020 that is bound to \f3AlternateJstatdServerName\fR\&. +.sp +.nf +\f3rmiregistry 2020&\fP +.fi +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-p 2020\fP +.fi +.nf +\f3 \-n AlternateJstatdServerName\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS STOP\ THE\ CREATION\ OF\ AN\ IN-PROCESS\ RMI\ REGISTRY +This example starts a \f3jstatd\fR session that does not create an RMI registry when one is not found\&. This example assumes an RMI registry is already running\&. If an RMI registry is not running, then an error message is displayed\&. +.sp +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-nr\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS ENABLE\ RMI\ LOGGING +This example starts a \f3jstatd\fR session with RMI logging capabilities enabled\&. This technique is useful as a troubleshooting aid or for monitoring server activities\&. +.sp +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP +.fi +.nf +\f3 \-J\-Djava\&.rmi\&.server\&.logCalls=true\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jstat(1) +.TP 0.2i +\(bu +rmiregistry(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/keytool.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/keytool.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,1619 +1,1619 @@ -'\" t -.\" Copyright (c) 1998, 2015, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 03 March 2015 -.\" SectDesc: Security Tools -.\" Title: keytool.1 -.\" -.if n .pl 99999 -.TH keytool 1 "03 March 2015" "JDK 8" "Security Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -keytool \- Manages a keystore (database) of cryptographic keys, X\&.509 certificate chains, and trusted certificates\&. -.SH SYNOPSIS -.sp -.nf - -\fBkeytool\fR [\fIcommands\fR] -.fi -.sp -.TP -\fIcommands\fR -See Commands\&. These commands are categorized by task as follows: -.RS -.TP 0.2i -\(bu -Create or Add Data to the Keystore -.RS -.TP 0.2i -\(bu --gencert -.TP 0.2i -\(bu --genkeypair -.TP 0.2i -\(bu --genseckey -.TP 0.2i -\(bu --importcert -.TP 0.2i -\(bu --importpassword -.RE - -.TP 0.2i -\(bu -Import Contents From Another Keystore -.RS -.TP 0.2i -\(bu --importkeystore -.RE - -.TP 0.2i -\(bu -Generate Certificate Request -.RS -.TP 0.2i -\(bu --certreq -.RE - -.TP 0.2i -\(bu -Export Data -.RS -.TP 0.2i -\(bu --exportcert -.RE - -.TP 0.2i -\(bu -Display Data -.RS -.TP 0.2i -\(bu --list -.TP 0.2i -\(bu --printcert -.TP 0.2i -\(bu --printcertreq -.TP 0.2i -\(bu --printcrl -.RE - -.TP 0.2i -\(bu -Manage the Keystore -.RS -.TP 0.2i -\(bu --storepasswd -.TP 0.2i -\(bu --keypasswd -.TP 0.2i -\(bu --delete -.TP 0.2i -\(bu --changealias -.RE - -.TP 0.2i -\(bu -Get Help -.RS -.TP 0.2i -\(bu --help -.RE - -.RE - -.SH DESCRIPTION -The \f3keytool\fR command is a key and certificate management utility\&. It enables users to administer their own public/private key pairs and associated certificates for use in self-authentication (where the user authenticates himself or herself to other users and services) or data integrity and authentication services, using digital signatures\&. The \f3keytool\fR command also enables users to cache the public keys (in the form of certificates) of their communicating peers\&. -.PP -A certificate is a digitally signed statement from one entity (person, company, and so on\&.), that says that the public key (and some other information) of some other entity has a particular value\&. (See Certificate\&.) When data is digitally signed, the signature can be verified to check the data integrity and authenticity\&. Integrity means that the data has not been modified or tampered with, and authenticity means the data comes from whoever claims to have created and signed it\&. -.PP -The \f3keytool\fR command also enables users to administer secret keys and passphrases used in symmetric encryption and decryption (DES)\&. -.PP -The \f3keytool\fR command stores the keys and certificates in a keystore\&. See KeyStore aliases\&. -.SH COMMAND\ AND\ OPTION\ NOTES -See Commands for a listing and description of the various commands\&. -.TP 0.2i -\(bu -All command and option names are preceded by a minus sign (-)\&. -.TP 0.2i -\(bu -The options for each command can be provided in any order\&. -.TP 0.2i -\(bu -All items not italicized or in braces or brackets are required to appear as is\&. -.TP 0.2i -\(bu -Braces surrounding an option signify that a default value will be used when the option is not specified on the command line\&. See Option Defaults\&. Braces are also used around the \f3-v\fR, \f3-rfc\fR, and \f3-J\fR options, which only have meaning when they appear on the command line\&. They do not have any default values other than not existing\&. -.TP 0.2i -\(bu -Brackets surrounding an option signify that the user is prompted for the values when the option is not specified on the command line\&. For the \f3-keypass\fR option, if you do not specify the option on the command line, then the \f3keytool\fR command first attempts to use the keystore password to recover the private/secret key\&. If this attempt fails, then the \f3keytool\fR command prompts you for the private/secret key password\&. -.TP 0.2i -\(bu -Items in italics (option values) represent the actual values that must be supplied\&. For example, here is the format of the \f3-printcert\fR command: -.sp -.nf -\f3keytool \-printcert {\-file \fIcert_file\fR} {\-v}\fP -.fi -.sp - - - - -When you specify a \f3-printcert\fR command, replace \fIcert_file\fR with the actual file name, as follows: \f3keytool -printcert -file VScert\&.cer\fR -.TP 0.2i -\(bu -Option values must be put in quotation marks when they contain a blank (space)\&. -.TP 0.2i -\(bu -The \f3-help\fR option is the default\&. The \f3keytool\fR command is the same as \f3keytool -help\fR\&. -.SH OPTION\ DEFAULTS -The following examples show the defaults for various option values\&. -.sp -.nf -\f3\-alias "mykey"\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\-keyalg\fP -.fi -.nf -\f3 "DSA" (when using \-genkeypair)\fP -.fi -.nf -\f3 "DES" (when using \-genseckey)\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\-keysize\fP -.fi -.nf -\f3 2048 (when using \-genkeypair and \-keyalg is "RSA")\fP -.fi -.nf -\f3 1024 (when using \-genkeypair and \-keyalg is "DSA")\fP -.fi -.nf -\f3 256 (when using \-genkeypair and \-keyalg is "EC")\fP -.fi -.nf -\f3 56 (when using \-genseckey and \-keyalg is "DES")\fP -.fi -.nf -\f3 168 (when using \-genseckey and \-keyalg is "DESede")\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\-validity 90\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\-keystore <the file named \&.keystore in the user\&'s home directory>\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\-storetype <the value of the "keystore\&.type" property in the\fP -.fi -.nf -\f3 security properties file, which is returned by the static\fP -.fi -.nf -\f3 getDefaultType method in java\&.security\&.KeyStore>\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\-file\fP -.fi -.nf -\f3 stdin (if reading)\fP -.fi -.nf -\f3 stdout (if writing)\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\-protected false\fP -.fi -.nf -\f3\fP -.fi -.sp -In generating a public/private key pair, the signature algorithm (\f3-sigalg\fR option) is derived from the algorithm of the underlying private key: -.TP 0.2i -\(bu -If the underlying private key is of type DSA, then the \f3-sigalg\fR option defaults to SHA1withDSA\&. -.TP 0.2i -\(bu -If the underlying private key is of type RSA, then the \f3-sigalg\fR option defaults to SHA256withRSA\&. -.TP 0.2i -\(bu -If the underlying private key is of type EC, then the \f3-sigalg\fR option defaults to SHA256withECDSA\&. -.PP -For a full list of \f3-keyalg\fR and \f3-sigalg\fR arguments, see Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA -.SH COMMON\ OPTIONS -The \f3-v\fR option can appear for all commands except \f3-help\fR\&. When the \f3-v\fR option appears, it signifies verbose mode, which means that more information is provided in the output\&. -.PP -There is also a \f3-Jjavaoption\fR argument that can appear for any command\&. When the \f3-Jjavaoption\fR appears, the specified \f3javaoption\fR string is passed directly to the Java interpreter\&. This option does not contain any spaces\&. It is useful for adjusting the execution environment or memory usage\&. For a list of possible interpreter options, type \f3java -h\fR or \f3java -X\fR at the command line\&. -.PP -These options can appear for all commands operating on a keystore: -.TP --storetype \fIstoretype\fR -.br -This qualifier specifies the type of keystore to be instantiated\&. -.TP --keystore \fIkeystore\fR -.br -The keystore location\&. - -If the JKS \f3storetype\fR is used and a keystore file does not yet exist, then certain \f3keytool\fR commands can result in a new keystore file being created\&. For example, if \f3keytool -genkeypair\fR is called and the \f3-keystore\fR option is not specified, the default keystore file named \f3\&.keystore\fR in the user\&'s home directory is created when it does not already exist\&. Similarly, if the \f3-keystore ks_file\fR option is specified but ks_file does not exist, then it is created\&. For more information on the JKS \f3storetype\fR, see the \fIKeyStore Implementation\fR section in KeyStore aliases\&. - -Note that the input stream from the \f3-keystore\fR option is passed to the \f3KeyStore\&.load\fR method\&. If \f3NONE\fR is specified as the URL, then a null stream is passed to the \f3KeyStore\&.load\fR method\&. \f3NONE\fR should be specified if the keystore is not file-based\&. For example, when it resides on a hardware token device\&. -.TP --storepass[:\fIenv\fR| :\fIfile\fR] argument -.br -The password that is used to protect the integrity of the keystore\&. - -If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the \f3value\fR argument, which must be at least 6 characters long\&. Otherwise, the password is retrieved as follows: -.RS -.TP 0.2i -\(bu -\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. -.TP 0.2i -\(bu -\f3file\fR: Retrieve the password from the file named argument\&. -.RE - - -\fINote:\fR All other options that require passwords, such as \f3-keypass\fR, \f3-srckeypass\fR, -\f3destkeypass\fR, \f3-srcstorepass\fR, and \f3-deststorepass\fR, accept the \fIenv\fR and \fIfile\fR modifiers\&. Remember to separate the password option and the modifier with a colon (:)\&. - -The password must be provided to all commands that access the keystore contents\&. For such commands, when the \f3-storepass\fR option is not provided at the command line, the user is prompted for it\&. - -When retrieving information from the keystore, the password is optional\&. If no password is specified, then the integrity of the retrieved information cannot be verified and a warning is displayed\&. -.TP --providerName \fIprovider_name\fR -.br -Used to identify a cryptographic service provider\&'s name when listed in the security properties file\&. -.TP --providerClass \fIprovider_class_name\fR -.br -Used to specify the name of a cryptographic service provider\&'s master class file when the service provider is not listed in the security properties file\&. -.TP --providerArg \fIprovider_arg\fR -.br -Used with the \f3-providerClass\fR option to represent an optional string input argument for the constructor of \f3provider_class_name\fR\&. -.TP --protected -.br -Either \f3true\fR or \f3false\fR\&. This value should be specified as \f3true\fR when a password must be specified by way of a protected authentication path such as a dedicated PIN reader\&.Because there are two keystores involved in the \f3-importkeystore\fR command, the following two options \f3-srcprotected\fR and -\f3destprotected\fR are provided for the source keystore and the destination keystore respectively\&. -.TP --ext \fI{name{:critical} {=value}}\fR -.br -Denotes an X\&.509 certificate extension\&. The option can be used in \f3-genkeypair\fR and \f3-gencert\fR to embed extensions into the certificate generated, or in \f3-certreq\fR to show what extensions are requested in the certificate request\&. The option can appear multiple times\&. The \f3name\fR argument can be a supported extension name (see Named Extensions) or an arbitrary OID number\&. The \f3value\fR argument, when provided, denotes the argument for the extension\&. When \fIvalue\fR is omitted, that means that the default value of the extension or the extension requires no argument\&. The \f3:critical\fR modifier, when provided, means the extension\&'s \f3isCritical\fR attribute is \f3true\fR; otherwise, it is \f3false\fR\&. You can use \f3:c\fR in place of \f3:critical\fR\&. -.SH NAMED\ EXTENSIONS -The \f3keytool\fR command supports these named extensions\&. The names are not case-sensitive)\&. -.TP -BC or BasicContraints -\fIValues\fR: The full form is: \f3ca:{true|false}[,pathlen:<len>]\fR or \f3<len>\fR, which is short for \f3ca:true,pathlen:<len>\fR\&. When <\f3len\fR> is omitted, you have \f3ca:true\fR\&. -.TP -KU or KeyUsage -\fIValues\fR: \f3usage\fR(,\f3usage\fR)*, where \fIusage\fR can be one of \f3digitalSignature\fR, \f3nonRepudiation\fR (contentCommitment), \f3keyEncipherment\fR, \f3dataEncipherment\fR, \f3keyAgreement\fR, \f3keyCertSign\fR, \f3cRLSign\fR, \f3encipherOnly\fR, \f3decipherOnly\fR\&. The \fIusage\fR argument can be abbreviated with the first few letters (\f3dig\fR for \f3digitalSignature\fR) or in camel-case style (\f3dS\fR for \f3digitalSignature\fR or \f3cRLS\fR for \f3cRLSign\fR), as long as no ambiguity is found\&. The \f3usage\fR values are case-sensitive\&. -.TP -EKU or ExtendedKeyUsage -\fIValues\fR: \f3usage\fR(,\f3usage\fR)*, where \fIusage\fR can be one of \f3anyExtendedKeyUsage\fR, \f3serverAuth\fR, \f3clientAuth\fR, \f3codeSigning\fR, \f3emailProtection\fR, \f3timeStamping\fR, \f3OCSPSigning\fR, or any \fIOID string\fR\&. The \fIusage\fR argument can be abbreviated with the first few letters or in camel-case style, as long as no ambiguity is found\&. The \f3usage\fR values are case-sensitive\&. -.TP -SAN or SubjectAlternativeName -\fIValues\fR: \f3type\fR:\f3value\fR(,t\f3ype:value\fR)*, where \f3type\fR can be \f3EMAIL\fR, \f3URI\fR, \f3DNS\fR, \f3IP\fR, or \f3OID\fR\&. The \f3value\fR argument is the string format value for the \f3type\fR\&. -.TP -IAN or IssuerAlternativeName -\fIValues\fR: Same as \f3SubjectAlternativeName\fR\&. -.TP -SIA or SubjectInfoAccess -\fIValues\fR: \f3method\fR:\f3location-type\fR:\f3location-value\fR (,\f3method:location-type\fR:\f3location-value\fR)*, where \f3method\fR can be \f3timeStamping\fR, \f3caRepository\fR or any OID\&. The \f3location-type\fR and \f3location-value\fR arguments can be any \f3type\fR:\f3value\fR supported by the \f3SubjectAlternativeName\fR extension\&. -.TP -AIA or AuthorityInfoAccess -\fIValues\fR: Same as \f3SubjectInfoAccess\fR\&. The \f3method\fR argument can be \f3ocsp\fR,\f3caIssuers\fR, or any OID\&. -.PP -When \f3name\fR is OID, the value is the hexadecimal dumped DER encoding of the \f3extnValue\fR for the extension excluding the OCTET STRING type and length bytes\&. Any extra character other than standard hexadecimal numbers (0-9, a-f, A-F) are ignored in the HEX string\&. Therefore, both 01:02:03:04 and 01020304 are accepted as identical values\&. When there is no value, the extension has an empty value field\&. -.PP -A special name \f3honored\fR, used in \f3-gencert\fR only, denotes how the extensions included in the certificate request should be honored\&. The value for this name is a comma separated list of \f3all\fR (all requested extensions are honored), \f3name{:[critical|non-critical]}\fR (the named extension is honored, but using a different \f3isCritical\fR attribute) and \f3-name\fR (used with \f3all\fR, denotes an exception)\&. Requested extensions are not honored by default\&. -.PP -If, besides the\f3-ext honored\fR option, another named or OID \f3-ext\fR option is provided, this extension is added to those already honored\&. However, if this name (or OID) also appears in the honored value, then its value and criticality overrides the one in the request\&. -.PP -The \f3subjectKeyIdentifier\fR extension is always created\&. For non-self-signed certificates, the \f3authorityKeyIdentifier\fR is created\&. -.PP -\fINote:\fR Users should be aware that some combinations of extensions (and other certificate fields) may not conform to the Internet standard\&. See Certificate Conformance Warning\&. -.SH COMMANDS -.TP --gencert -.sp -.nf -\f3{\-rfc} {\-infile \fIinfile\fR} {\-outfile \fIoutfile\fR} {\-alias \fIalias\fR} {\-sigalg \fIsigalg\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-dname \fIdname\fR} {\-startdate \fIstartdate\fR {\-ext \fIext\fR}* {\-validity \fIvalDays\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-keypass \fIkeypass\fR] {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP -.fi -.sp -.sp -.nf -\f3{\-storetype \fIstoretype\fR} {\-providername \fIprovider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-v} {\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Generates a certificate as a response to a certificate request file (which can be created by the \f3keytool\fR\f3-certreq\fR command)\&. The command reads the request from \fIinfile\fR (if omitted, from the standard input), signs it using alias\&'s private key, and outputs the X\&.509 certificate into \fIoutfile\fR (if omitted, to the standard output)\&. When\f3-rfc\fR is specified, the output format is Base64-encoded PEM; otherwise, a binary DER is created\&. - -The \f3sigalg\fR value specifies the algorithm that should be used to sign the certificate\&. The \f3startdate\fR argument is the start time and date that the certificate is valid\&. The \f3valDays\fR argument tells the number of days for which the certificate should be considered valid\&. - -When \f3dname\fR is provided, it is used as the subject of the generated certificate\&. Otherwise, the one from the certificate request is used\&. - -The \f3ext\fR value shows what X\&.509 extensions will be embedded in the certificate\&. Read Common Options for the grammar of \f3-ext\fR\&. - -The \f3-gencert\fR option enables you to create certificate chains\&. The following example creates a certificate, \f3e1\fR, that contains three certificates in its certificate chain\&. - -The following commands creates four key pairs named \f3ca\fR, \f3ca1\fR, \f3ca2\fR, and \f3e1\fR: -.sp -.nf -\f3keytool \-alias ca \-dname CN=CA \-genkeypair\fP -.fi -.nf -\f3keytool \-alias ca1 \-dname CN=CA \-genkeypair\fP -.fi -.nf -\f3keytool \-alias ca2 \-dname CN=CA \-genkeypair\fP -.fi -.nf -\f3keytool \-alias e1 \-dname CN=E1 \-genkeypair\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The following two commands create a chain of signed certificates; \f3ca\fR signs \f3ca1\fR and \f3ca1\fR signs \f3ca2\fR, all of which are self-issued: -.sp -.nf -\f3keytool \-alias ca1 \-certreq |\fP -.fi -.nf -\f3 keytool \-alias ca \-gencert \-ext san=dns:ca1 |\fP -.fi -.nf -\f3 keytool \-alias ca1 \-importcert\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3keytool \-alias ca2 \-certreq |\fP -.fi -.nf -\f3 $KT \-alias ca1 \-gencert \-ext san=dns:ca2 |\fP -.fi -.nf -\f3 $KT \-alias ca2 \-importcert\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The following command creates the certificate \f3e1\fR and stores it in the file \f3e1\&.cert\fR, which is signed by \f3ca2\fR\&. As a result, \f3e1\fR should contain \f3ca\fR, \f3ca1\fR, and \f3ca2\fR in its certificate chain: -.sp -.nf -\f3keytool \-alias e1 \-certreq | keytool \-alias ca2 \-gencert > e1\&.cert\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --genkeypair -.sp -.nf -\f3{\-alias \fIalias\fR} {\-keyalg \fIkeyalg\fR} {\-keysize \fIkeysize\fR} {\-sigalg \fIsigalg\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-dname \fIdname\fR] [\-keypass \fIkeypass\fR] {\-startdate \fIvalue\fR} {\-ext \fIext\fR}*\fP -.fi -.sp -.sp -.nf -\f3{\-validity \fIvalDays\fR} {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-storepass \fIstorepass\fR]\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-v} {\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Generates a key pair (a public key and associated private key)\&. Wraps the public key into an X\&.509 v3 self-signed certificate, which is stored as a single-element certificate chain\&. This certificate chain and the private key are stored in a new keystore entry identified by alias\&. - -The \f3keyalg\fR value specifies the algorithm to be used to generate the key pair, and the \f3keysize\fR value specifies the size of each key to be generated\&. The \f3sigalg\fR value specifies the algorithm that should be used to sign the self-signed certificate\&. This algorithm must be compatible with the \f3keyalg\fR value\&. - -The \f3dname\fR value specifies the X\&.500 Distinguished Name to be associated with the value of \f3alias\fR, and is used as the issuer and subject fields in the self-signed certificate\&. If no distinguished name is provided at the command line, then the user is prompted for one\&. - -The value of \f3keypass\fR is a password used to protect the private key of the generated key pair\&. If no password is provided, then the user is prompted for it\&. If you press \fIthe Return key\fR at the prompt, then the key password is set to the same password as the keystore password\&. The \f3keypass\fR value must be at least 6 characters\&. - -The value of \f3startdate\fR specifies the issue time of the certificate, also known as the "Not Before" value of the X\&.509 certificate\&'s Validity field\&. - -The option value can be set in one of these two forms: - -\f3([+-]nnn[ymdHMS])+\fR - -\f3[yyyy/mm/dd] [HH:MM:SS]\fR - -With the first form, the issue time is shifted by the specified value from the current time\&. The value is a concatenation of a sequence of subvalues\&. Inside each subvalue, the plus sign (+) means shift forward, and the minus sign (-) means shift backward\&. The time to be shifted is \f3nnn\fR units of years, months, days, hours, minutes, or seconds (denoted by a single character of \f3y\fR, \f3m\fR, \f3d\fR, \f3H\fR, \f3M\fR, or \f3S\fR respectively)\&. The exact value of the issue time is calculated using the \f3java\&.util\&.GregorianCalendar\&.add(int field, int amount)\fR method on each subvalue, from left to right\&. For example, by specifying, the issue time will be: -.sp -.nf -\f3Calendar c = new GregorianCalendar();\fP -.fi -.nf -\f3c\&.add(Calendar\&.YEAR, \-1);\fP -.fi -.nf -\f3c\&.add(Calendar\&.MONTH, 1);\fP -.fi -.nf -\f3c\&.add(Calendar\&.DATE, \-1);\fP -.fi -.nf -\f3return c\&.getTime()\fP -.fi -.nf -\f3\fP -.fi -.sp - - -With the second form, the user sets the exact issue time in two parts, year/month/day and hour:minute:second (using the local time zone)\&. The user can provide only one part, which means the other part is the same as the current date (or time)\&. The user must provide the exact number of digits as shown in the format definition (padding with 0 when shorter)\&. When both the date and time are provided, there is one (and only one) space character between the two parts\&. The hour should always be provided in 24 hour format\&. - -When the option is not provided, the start date is the current time\&. The option can be provided at most once\&. - -The value of \f3valDays\fR specifies the number of days (starting at the date specified by \f3-startdate\fR, or the current date when \f3-startdate\fR is not specified) for which the certificate should be considered valid\&. - -This command was named \f3-genkey\fR in earlier releases\&. The old name is still supported in this release\&. The new name, \f3-genkeypair\fR, is preferred going forward\&. -.TP --genseckey -.sp -.nf -\f3{\-alias \fIalias\fR} {\-keyalg \fIkeyalg\fR} {\-keysize \fIkeysize\fR} [\-keypass \fIkeypass\fR]\fP -.fi -.sp -.sp -.nf -\f3{\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}} {\-v}\fP -.fi -.sp -.sp -.nf -\f3{\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Generates a secret key and stores it in a new \f3KeyStore\&.SecretKeyEntry\fR identified by \f3alias\fR\&. - -The value of \f3keyalg\fR specifies the algorithm to be used to generate the secret key, and the value of \f3keysize\fR specifies the size of the key to be generated\&. The \f3keypass\fR value is a password that protects the secret key\&. If no password is provided, then the user is prompted for it\&. If you press the Return key at the prompt, then the key password is set to the same password that is used for the \f3keystore\fR\&. The \f3keypass\fR value must be at least 6 characters\&. -.TP --importcert -.sp -.nf -\f3{\-alias \fIalias\fR} {\-file \fIcert_file\fR} [\-keypass \fIkeypass\fR] {\-noprompt} {\-trustcacerts}\fP -.fi -.sp -.sp -.nf -\f3{\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP -.fi -.sp -.sp -.nf -\f3{\-providerName \fIprovider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-v} {\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Reads the certificate or certificate chain (where the latter is supplied in a PKCS#7 formatted reply or a sequence of X\&.509 certificates) from the file \f3cert_file\fR, and stores it in the \f3keystore\fR entry identified by \f3alias\fR\&. If no file is specified, then the certificate or certificate chain is read from \f3stdin\fR\&. - -The \f3keytool\fR command can import X\&.509 v1, v2, and v3 certificates, and PKCS#7 formatted certificate chains consisting of certificates of that type\&. The data to be imported must be provided either in binary encoding format or in printable encoding format (also known as Base64 encoding) as defined by the Internet RFC 1421 standard\&. In the latter case, the encoding must be bounded at the beginning by a string that starts with \f3-\fR\f3----BEGIN\fR, and bounded at the end by a string that starts with \f3-----END\fR\&. - -You import a certificate for two reasons: To add it to the list of trusted certificates, and to import a certificate reply received from a certificate authority (CA) as the result of submitting a Certificate Signing Request to that CA (see the \f3-certreq\fR option in Commands)\&. - -Which type of import is intended is indicated by the value of the \f3-alias\fR option\&. If the alias does not point to a key entry, then the \f3keytool\fR command assumes you are adding a trusted certificate entry\&. In this case, the alias should not already exist in the keystore\&. If the alias does already exist, then the \f3keytool\fR command outputs an error because there is already a trusted certificate for that alias, and does not import the certificate\&. If the alias points to a key entry, then the \f3keytool\fR command assumes you are importing a certificate reply\&. -.TP --importpassword -.sp -.nf -\f3{\-alias \fIalias\fR} [\-keypass \fIkeypass\fR] {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-storepass \fIstorepass\fR]\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-v} {\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Imports a passphrase and stores it in a new \f3KeyStore\&.SecretKeyEntry\fR identified by \f3alias\fR\&. The passphrase may be supplied via the standard input stream; otherwise the user is prompted for it\&. \f3keypass\fR is a password used to protect the imported passphrase\&. If no password is provided, the user is prompted for it\&. If you press the Return key at the prompt, the key password is set to the same password as that used for the \f3keystore\fR\&. \f3keypass\fR must be at least 6 characters long\&. -.TP --importkeystore -.sp -.nf -\f3{\-srcstoretype \fIsrcstoretype\fR} {\-deststoretype \fIdeststoretype\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-srcstorepass \fIsrcstorepass\fR] [\-deststorepass \fIdeststorepass\fR] {\-srcprotected}\fP -.fi -.sp -.sp -.nf -\f3{\-destprotected} \fP -.fi -.sp -.sp -.nf -\f3{\-srcalias \fIsrcalias\fR {\-destalias \fIdestalias\fR} [\-srckeypass \fIsrckeypass\fR]} \fP -.fi -.sp -.sp -.nf -\f3[\-destkeypass \fIdestkeypass\fR] {\-noprompt}\fP -.fi -.sp -.sp -.nf -\f3{\-srcProviderName \fIsrc_provider_name\fR} {\-destProviderName \fIdest_provider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}} {\-v}\fP -.fi -.sp -.sp -.nf -\f3{\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Imports a single entry or all entries from a source keystore to a destination keystore\&. - -When the \f3-srcalias\fR option is provided, the command imports the single entry identified by the alias to the destination keystore\&. If a destination alias is not provided with \f3destalias\fR, then \f3srcalias\fR is used as the destination alias\&. If the source entry is protected by a password, then \f3srckeypass\fR is used to recover the entry\&. If \fIsrckeypass\fR is not provided, then the \f3keytool\fR command attempts to use \f3srcstorepass\fR to recover the entry\&. If \f3srcstorepass\fR is either not provided or is incorrect, then the user is prompted for a password\&. The destination entry is protected with \f3destkeypass\fR\&. If \f3destkeypass\fR is not provided, then the destination entry is protected with the source entry password\&. For example, most third-party tools require \f3storepass\fR and \f3keypass\fR in a PKCS #12 keystore to be the same\&. In order to create a PKCS #12 keystore for these tools, always specify a \f3-destkeypass\fR to be the same as \f3-deststorepass\fR\&. - -If the \f3-srcalias\fR option is not provided, then all entries in the source keystore are imported into the destination keystore\&. Each destination entry is stored under the alias from the source entry\&. If the source entry is protected by a password, then \f3srcstorepass\fR is used to recover the entry\&. If \f3srcstorepass\fR is either not provided or is incorrect, then the user is prompted for a password\&. If a source keystore entry type is not supported in the destination keystore, or if an error occurs while storing an entry into the destination keystore, then the user is prompted whether to skip the entry and continue or to quit\&. The destination entry is protected with the source entry password\&. - -If the destination alias already exists in the destination keystore, then the user is prompted to either overwrite the entry or to create a new entry under a different alias name\&. - -If the \f3-noprompt\fR option is provided, then the user is not prompted for a new destination alias\&. Existing entries are overwritten with the destination alias name\&. Entries that cannot be imported are skipped and a warning is displayed\&. -.TP --printcertreq -.sp -.nf -\f3{\-file \fIfile\fR}\fP -.fi -.sp - - -Prints the content of a PKCS #10 format certificate request, which can be generated by the \f3keytool\fR\f3-certreq\fR command\&. The command reads the request from file\&. If there is no file, then the request is read from the standard input\&. -.TP --certreq -.sp -.nf -\f3{\-alias \fIalias\fR} {\-dname \fIdname\fR} {\-sigalg \fIsigalg\fR} {\-file \fIcertreq_file\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-keypass \fIkeypass\fR] {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-v} {\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Generates a Certificate Signing Request (CSR) using the PKCS #10 format\&. - -A CSR is intended to be sent to a certificate authority (CA)\&. The CA authenticates the certificate requestor (usually off-line) and will return a certificate or certificate chain, used to replace the existing certificate chain (which initially consists of a self-signed certificate) in the keystore\&. - -The private key associated with alias is used to create the PKCS #10 certificate request\&. To access the private key, the correct password must be provided\&. If \f3keypass\fR is not provided at the command line and is different from the password used to protect the integrity of the keystore, then the user is prompted for it\&. If \f3dname\fR is provided, then it is used as the subject in the CSR\&. Otherwise, the X\&.500 Distinguished Name associated with alias is used\&. - -The \f3sigalg\fR value specifies the algorithm that should be used to sign the CSR\&. - -The CSR is stored in the file certreq_file\&. If no file is specified, then the CSR is output to \f3stdout\fR\&. - -Use the \f3importcert\fR command to import the response from the CA\&. -.TP --exportcert -.sp -.nf -\f3{\-alias \fIalias\fR} {\-file \fIcert_file\fR} {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-rfc} {\-v} {\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Reads from the keystore the certificate associated with \fIalias\fR and stores it in the cert_file file\&. When no file is specified, the certificate is output to \f3stdout\fR\&. - -The certificate is by default output in binary encoding\&. If the \f3-rfc\fR option is specified, then the output in the printable encoding format defined by the Internet RFC 1421 Certificate Encoding Standard\&. - -If \f3alias\fR refers to a trusted certificate, then that certificate is output\&. Otherwise, \f3alias\fR refers to a key entry with an associated certificate chain\&. In that case, the first certificate in the chain is returned\&. This certificate authenticates the public key of the entity addressed by \f3alias\fR\&. - -This command was named \f3-export\fR in earlier releases\&. The old name is still supported in this release\&. The new name, \f3-exportcert\fR, is preferred going forward\&. -.TP --list -.sp -.nf -\f3{\-alias \fIalias\fR} {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP -.fi -.sp -.sp -.nf -\f3{\-providerName \fIprovider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-v | \-rfc} {\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Prints to \f3stdout\fR the contents of the keystore entry identified by \f3alias\fR\&. If no \f3alias\fR is specified, then the contents of the entire keystore are printed\&. - -This command by default prints the SHA1 fingerprint of a certificate\&. If the \f3-v\fR option is specified, then the certificate is printed in human-readable format, with additional information such as the owner, issuer, serial number, and any extensions\&. If the \f3-rfc\fR option is specified, then the certificate contents are printed using the printable encoding format, as defined by the Internet RFC 1421 Certificate Encoding Standard\&. - -You cannot specify both \f3-v\fR and \f3-rfc\fR\&. -.TP --printcert -.sp -.nf -\f3{\-file \fIcert_file\fR | \-sslserver \fIhost\fR[:\fIport\fR]} {\-jarfile \fIJAR_file\fR {\-rfc} {\-v}\fP -.fi -.sp -.sp -.nf -\f3{\-Jjavaoption}\fP -.fi -.sp - - -Reads the certificate from the file cert_file, the SSL server located at host:port, or the signed JAR file \f3JAR_file\fR (with the \f3-jarfile\fR option and prints its contents in a human-readable format\&. When no port is specified, the standard HTTPS port 443 is assumed\&. Note that \f3-sslserver\fR and -file options cannot be provided at the same time\&. Otherwise, an error is reported\&. If neither option is specified, then the certificate is read from \f3stdin\fR\&. - -When\f3-rfc\fR is specified, the \f3keytool\fR command prints the certificate in PEM mode as defined by the Internet RFC 1421 Certificate Encoding standard\&. See Internet RFC 1421 Certificate Encoding Standard\&. - -If the certificate is read from a file or \f3stdin\fR, then it might be either binary encoded or in printable encoding format, as defined by the RFC 1421 Certificate Encoding standard\&. - -If the SSL server is behind a firewall, then the \f3-J-Dhttps\&.proxyHost=proxyhost\fR and \f3-J-Dhttps\&.proxyPort=proxyport\fR options can be specified on the command line for proxy tunneling\&. See Java Secure Socket Extension (JSSE) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide\&.html - -\fINote:\fR This option can be used independently of a keystore\&. -.TP --printcrl -.sp -.nf -\f3\-file \fIcrl_\fR {\-v}\fP -.fi -.sp - - -Reads the Certificate Revocation List (CRL) from the file \f3crl_\fR\&. A CRL is a list of digital certificates that were revoked by the CA that issued them\&. The CA generates the \f3crl_\fR file\&. - -\fINote:\fR This option can be used independently of a keystore\&. -.TP --storepasswd -.sp -.nf -\f3[\-new \fInew_storepass\fR] {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-v} {\-Jjavaoption}\fP -.fi -.sp - - -Changes the password used to protect the integrity of the keystore contents\&. The new password is \f3new_storepass\fR, which must be at least 6 characters\&. -.TP --keypasswd -.sp -.nf -\f3{\-alias \fIalias\fR} [\-keypass \fIold_keypass\fR] [\-new \fInew_keypass\fR] {\-storetype \fIstoretype\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}} {\-v}\fP -.fi -.sp -.sp -.nf -\f3{\-Jjavaoption}\fP -.fi -.sp - - -Changes the password under which the private/secret key identified by \f3alias\fR is protected, from \f3old_keypass\fR to \f3new_keypass\fR, which must be at least 6 characters\&. - -If the \f3-keypass\fR option is not provided at the command line, and the key password is different from the keystore password, then the user is prompted for it\&. - -If the \f3-new\fR option is not provided at the command line, then the user is prompted for it -.TP --delete -.sp -.nf -\f3[\-alias \fIalias\fR] {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP -.fi -.sp -.sp -.nf -\f3{\-providerName \fIprovider_name\fR} \fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-v} {\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Deletes from the keystore the entry identified by \f3alias\fR\&. The user is prompted for the alias, when no alias is provided at the command line\&. -.TP --changealias -.sp -.nf -\f3{\-alias \fIalias\fR} [\-destalias \fIdestalias\fR] [\-keypass \fIkeypass\fR] {\-storetype \fIstoretype\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}} {\-v}\fP -.fi -.sp -.sp -.nf -\f3{\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Move an existing keystore entry from the specified \f3alias\fR to a new alias, \f3destalias\fR\&. If no destination alias is provided, then the command prompts for one\&. If the original entry is protected with an entry password, then the password can be supplied with the \f3-keypass\fR option\&. If no key password is provided, then the \f3storepass\fR (if provided) is attempted first\&. If the attempt fails, then the user is prompted for a password\&. -.TP --help -.br -Lists the basic commands and their options\&. - -For more information about a specific command, enter the following, where \f3command_name\fR is the name of the command: \f3keytool -command_name -help\fR\&. -.SH EXAMPLES -This example walks through the sequence of steps to create a keystore for managing public/private key pair and certificates from trusted entities\&. -.SS GENERATE\ THE\ KEY\ PAIR -First, create a keystore and generate the key pair\&. You can use a command such as the following typed as a single line: -.sp -.nf -\f3keytool \-genkeypair \-dname "cn=Mark Jones, ou=Java, o=Oracle, c=US"\fP -.fi -.nf -\f3 \-alias business \-keypass <new password for private key>\fP -.fi -.nf -\f3 \-keystore /working/mykeystore\fP -.fi -.nf -\f3 \-storepass <new password for keystore> \-validity 180\fP -.fi -.nf -\f3\fP -.fi -.sp -The command creates the keystore named \f3mykeystore\fR in the working directory (assuming it does not already exist), and assigns it the password specified by \f3<new password for keystore>\fR\&. It generates a public/private key pair for the entity whose distinguished name has a common name of Mark Jones, organizational unit of Java, organization of Oracle and two-letter country code of US\&. It uses the default DSA key generation algorithm to create the keys; both are 1024 bits\&. -.PP -The command uses the default SHA1withDSA signature algorithm to create a self-signed certificate that includes the public key and the distinguished name information\&. The certificate is valid for 180 days, and is associated with the private key in a keystore entry referred to by the alias \f3business\fR\&. The private key is assigned the password specified by \f3<new password for private key>\fR\&. -.PP -The command is significantly shorter when the option defaults are accepted\&. In this case, no options are required, and the defaults are used for unspecified options that have default values\&. You are prompted for any required values\&. You could have the following: -.sp -.nf -\f3keytool \-genkeypair\fP -.fi -.nf -\f3\fP -.fi -.sp -In this case, a keystore entry with the alias \f3mykey\fR is created, with a newly generated key pair and a certificate that is valid for 90 days\&. This entry is placed in the keystore named \f3\&.keystore\fR in your home directory\&. The keystore is created when it does not already exist\&. You are prompted for the distinguished name information, the keystore password, and the private key password\&. -.PP -The rest of the examples assume you executed the \f3-genkeypair\fR command without options specified, and that you responded to the prompts with values equal to those specified in the first \f3-genkeypair\fR command\&. For example, a distinguished name of \f3cn=Mark Jones\fR, \f3ou=Java\fR, \f3o=Oracle\fR, \f3c=US\fR)\&. -.SS REQUEST\ A\ SIGNED\ CERTIFICATE\ FROM\ A\ CA -Generating the key pair created a self-signed certificate\&. A certificate is more likely to be trusted by others when it is signed by a Certification Authority (CA)\&. To get a CA signature, first generate a Certificate Signing Request (CSR), as follows: -.sp -.nf -\f3keytool \-certreq \-file MarkJ\&.csr\fP -.fi -.nf -\f3\fP -.fi -.sp -This creates a CSR for the entity identified by the default alias \f3mykey\fR and puts the request in the file named MarkJ\&.csr\&. Submit this file to a CA, such as VeriSign\&. The CA authenticates you, the requestor (usually off-line), and returns a certificate, signed by them, authenticating your public key\&. In some cases, the CA returns a chain of certificates, each one authenticating the public key of the signer of the previous certificate in the chain\&. -.SS IMPORT\ A\ CERTIFICATE\ FOR\ THE\ CA -You now need to replace the self-signed certificate with a certificate chain, where each certificate in the chain authenticates the public key of the signer of the previous certificate in the chain, up to a root CA\&. -.PP -Before you import the certificate reply from a CA, you need one or more trusted certificates in your keystore or in the \f3cacerts\fR keystore file\&. See \f3-importcert\fR in Commands\&. -.TP 0.2i -\(bu -If the certificate reply is a certificate chain, then you need the top certificate of the chain\&. The root CA certificate that authenticates the public key of the CA\&. -.TP 0.2i -\(bu -If the certificate reply is a single certificate, then you need a certificate for the issuing CA (the one that signed it)\&. If that certificate is not self-signed, then you need a certificate for its signer, and so on, up to a self-signed root CA certificate\&. -.PP -The \f3cacerts\fR keystore file ships with several VeriSign root CA certificates, so you probably will not need to import a VeriSign certificate as a trusted certificate in your keystore\&. But if you request a signed certificate from a different CA, and a certificate authenticating that CA\&'s public key was not added to \f3cacerts\fR, then you must import a certificate from the CA as a trusted certificate\&. -.PP -A certificate from a CA is usually either self-signed or signed by another CA, in which case you need a certificate that authenticates that CA\&'s public key\&. Suppose company ABC, Inc\&., is a CA, and you obtain a file named A\f3BCCA\&.cer\fR that is supposed to be a self-signed certificate from ABC, that authenticates that CA\&'s public key\&. Be careful to ensure the certificate is valid before you import it as a trusted certificate\&. View it first with the \f3keytool -printcert\fR command or the \f3keytool -importcert\fR command without the \f3-noprompt\fR option, and make sure that the displayed certificate fingerprints match the expected ones\&. You can call the person who sent the certificate, and compare the fingerprints that you see with the ones that they show or that a secure public key repository shows\&. Only when the fingerprints are equal is it guaranteed that the certificate was not replaced in transit with somebody else\&'s (for example, an attacker\&'s) certificate\&. If such an attack takes place, and you did not check the certificate before you imported it, then you would be trusting anything the attacker has signed\&. -.PP -If you trust that the certificate is valid, then you can add it to your keystore with the following command: -.sp -.nf -\f3keytool \-importcert \-alias abc \-file ABCCA\&.cer\fP -.fi -.nf -\f3\fP -.fi -.sp -This command creates a trusted certificate entry in the keystore, with the data from the file ABCCA\&.cer, and assigns the alias \f3abc\fR to the entry\&. -.SS IMPORT\ THE\ CERTIFICATE\ REPLY\ FROM\ THE\ CA -After you import a certificate that authenticates the public key of the CA you submitted your certificate signing request to (or there is already such a certificate in the cacerts file), you can import the certificate reply and replace your self-signed certificate with a certificate chain\&. This chain is the one returned by the CA in response to your request (when the CA reply is a chain), or one constructed (when the CA reply is a single certificate) using the certificate reply and trusted certificates that are already available in the keystore where you import the reply or in the \f3cacerts\fR keystore file\&. -.PP -For example, if you sent your certificate signing request to VeriSign, then you can import the reply with the following, which assumes the returned certificate is named VSMarkJ\&.cer: -.sp -.nf -\f3keytool \-importcert \-trustcacerts \-file VSMarkJ\&.cer\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS EXPORT\ A\ CERTIFICATE\ THAT\ AUTHENTICATES\ THE\ PUBLIC\ KEY -If you used the \f3jarsigner\fR command to sign a Java Archive (JAR) file, then clients that want to use the file will want to authenticate your signature\&. One way the clients can authenticate you is by first importing your public key certificate into their keystore as a trusted entry\&. -.PP -You can export the certificate and supply it to your clients\&. As an example, you can copy your certificate to a file named MJ\&.cer with the following command that assumes the entry has an alias of \f3mykey\fR: -.sp -.nf -\f3keytool \-exportcert \-alias mykey \-file MJ\&.cer\fP -.fi -.nf -\f3\fP -.fi -.sp -With the certificate and the signed JAR file, a client can use the \f3jarsigner\fR command to authenticate your signature\&. -.SS IMPORT\ KEYSTORE -The command \f3importkeystore\fR is used to import an entire keystore into another keystore, which means all entries from the source keystore, including keys and certificates, are all imported to the destination keystore within a single command\&. You can use this command to import entries from a different type of keystore\&. During the import, all new entries in the destination keystore will have the same alias names and protection passwords (for secret keys and private keys)\&. If the \f3keytool\fR command cannot recover the private keys or secret keys from the source keystore, then it prompts you for a password\&. If it detects alias duplication, then it asks you for a new alias, and you can specify a new alias or simply allow the \f3keytool\fR command to overwrite the existing one\&. -.PP -For example, to import entries from a typical JKS type keystore key\&.jks into a PKCS #11 type hardware-based keystore, use the command: -.sp -.nf -\f3keytool \-importkeystore\fP -.fi -.nf -\f3 \-srckeystore key\&.jks \-destkeystore NONE\fP -.fi -.nf -\f3 \-srcstoretype JKS \-deststoretype PKCS11\fP -.fi -.nf -\f3 \-srcstorepass <src keystore password>\fP -.fi -.nf -\f3 \-deststorepass <destination keystore pwd>\fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3importkeystore\fR command can also be used to import a single entry from a source keystore to a destination keystore\&. In this case, besides the options you see in the previous example, you need to specify the alias you want to import\&. With the \f3-srcalias\fR option specified, you can also specify the destination alias name in the command line, as well as protection password for a secret/private key and the destination protection password you want\&. The following command demonstrates this: -.sp -.nf -\f3keytool \-importkeystore\fP -.fi -.nf -\f3 \-srckeystore key\&.jks \-destkeystore NONE\fP -.fi -.nf -\f3 \-srcstoretype JKS \-deststoretype PKCS11\fP -.fi -.nf -\f3 \-srcstorepass <src keystore password>\fP -.fi -.nf -\f3 \-deststorepass <destination keystore pwd>\fP -.fi -.nf -\f3 \-srcalias myprivatekey \-destalias myoldprivatekey\fP -.fi -.nf -\f3 \-srckeypass <source entry password>\fP -.fi -.nf -\f3 \-destkeypass <destination entry password>\fP -.fi -.nf -\f3 \-noprompt\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS GENERATE\ CERTIFICATES\ FOR\ AN\ SSL\ SERVER -The following are \f3keytool\fR commands to generate key pairs and certificates for three entities: Root CA (\f3root\fR), Intermediate CA (\f3ca\fR), and SSL server (\f3server\fR)\&. Ensure that you store all the certificates in the same keystore\&. In these examples, RSA is the recommended the key algorithm\&. -.sp -.nf -\f3keytool \-genkeypair \-keystore root\&.jks \-alias root \-ext bc:c\fP -.fi -.nf -\f3keytool \-genkeypair \-keystore ca\&.jks \-alias ca \-ext bc:c\fP -.fi -.nf -\f3keytool \-genkeypair \-keystore server\&.jks \-alias server\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3keytool \-keystore root\&.jks \-alias root \-exportcert \-rfc > root\&.pem\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3keytool \-storepass <storepass> \-keystore ca\&.jks \-certreq \-alias ca |\fP -.fi -.nf -\f3 keytool \-storepass <storepass> \-keystore root\&.jks\fP -.fi -.nf -\f3 \-gencert \-alias root \-ext BC=0 \-rfc > ca\&.pem\fP -.fi -.nf -\f3keytool \-keystore ca\&.jks \-importcert \-alias ca \-file ca\&.pem\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3keytool \-storepass <storepass> \-keystore server\&.jks \-certreq \-alias server |\fP -.fi -.nf -\f3 keytool \-storepass <storepass> \-keystore ca\&.jks \-gencert \-alias ca\fP -.fi -.nf -\f3 \-ext ku:c=dig,kE \-rfc > server\&.pem\fP -.fi -.nf -\f3cat root\&.pem ca\&.pem server\&.pem |\fP -.fi -.nf -\f3 keytool \-keystore server\&.jks \-importcert \-alias server\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH TERMS -.TP -Keystore -A keystore is a storage facility for cryptographic keys and certificates\&. -.TP -Keystore entries -Keystores can have different types of entries\&. The two most applicable entry types for the \f3keytool\fR command include the following: - -\fIKey entries\fR: Each entry holds very sensitive cryptographic key information, which is stored in a protected format to prevent unauthorized access\&. Typically, a key stored in this type of entry is a secret key, or a private key accompanied by the certificate chain for the corresponding public key\&. See Certificate Chains\&. The \f3keytool\fR command can handle both types of entries, while the \f3jarsigner\fR tool only handles the latter type of entry, that is private keys and their associated certificate chains\&. - -\fITrusted certificate entries\fR: Each entry contains a single public key certificate that belongs to another party\&. The entry is called a trusted certificate because the keystore owner trusts that the public key in the certificate belongs to the identity identified by the subject (owner) of the certificate\&. The issuer of the certificate vouches for this, by signing the certificate\&. -.TP -KeyStore aliases -All keystore entries (key and trusted certificate entries) are accessed by way of unique aliases\&. - -An alias is specified when you add an entity to the keystore with the \f3-genseckey\fR command to generate a secret key, the \f3-genkeypair\fR command to generate a key pair (public and private key), or the \f3-importcert\fR command to add a certificate or certificate chain to the list of trusted certificates\&. Subsequent \f3keytool\fR commands must use this same alias to refer to the entity\&. - -For example, you can use the alias \f3duke\fR to generate a new public/private key pair and wrap the public key into a self-signed certificate with the following command\&. See Certificate Chains\&. -.sp -.nf -\f3keytool \-genkeypair \-alias duke \-keypass dukekeypasswd\fP -.fi -.nf -\f3\fP -.fi -.sp - - -This example specifies an initial password of \f3dukekeypasswd\fR required by subsequent commands to access the private key associated with the alias \f3duke\fR\&. If you later want to change Duke\&'s private key password, use a command such as the following: -.sp -.nf -\f3keytool \-keypasswd \-alias duke \-keypass dukekeypasswd \-new newpass\fP -.fi -.nf -\f3\fP -.fi -.sp - - -This changes the password from \f3dukekeypasswd\fR to \f3newpass\fR\&. A password should not be specified on a command line or in a script unless it is for testing purposes, or you are on a secure system\&. If you do not specify a required password option on a command line, then you are prompted for it\&. -.TP -KeyStore implementation -The \f3KeyStore\fR class provided in the \f3java\&.security\fR 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 type of keystore\&. - -Currently, two command-line tools (\f3keytool\fR and \f3jarsigner\fR) and a GUI-based tool named Policy Tool make use of keystore implementations\&. Because the \f3KeyStore\fR class is \f3public\fR, users can write additional security applications that use it\&. - -There is a built-in default implementation, provided by Oracle\&. It implements the keystore as a file with a proprietary keystore type (format) named JKS\&. It protects each private key with its individual password, and also protects the integrity of the entire keystore with a (possibly different) password\&. - -Keystore implementations are provider-based\&. More specifically, the application interfaces supplied by \f3KeyStore\fR are implemented in terms of a Service Provider Interface (SPI)\&. That is, there is a corresponding abstract \f3KeystoreSpi\fR class, also in the \f3java\&.security package\fR, which defines the Service Provider Interface methods that providers must implement\&. The term \fIprovider\fR refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API\&. To provide a keystore implementation, clients must implement a provider and supply a \f3KeystoreSpi\fR subclass implementation, as described in How to Implement a Provider in the Java Cryptography Architecture at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/HowToImplAProvider\&.html - -Applications can choose different types of keystore implementations from different providers, using the \f3getInstance\fR factory method supplied in the \f3KeyStore\fR class\&. A keystore type defines the storage and data format of the keystore information, and the algorithms used to protect private/secret keys in the keystore and the integrity of the keystore\&. Keystore implementations of different types are not compatible\&. - -The \f3keytool\fR command works on any file-based keystore implementation\&. It treats the keystore location that is passed to it at the command line as a file name and converts it to a \f3FileInputStream\fR, from which it loads the keystore information\&.)The \f3jarsigner\fR and \f3policytool\fR commands can read a keystore from any location that can be specified with a URL\&. - -For \f3keytool\fR and \f3jarsigner\fR, you can specify a keystore type at the command line, with the \f3-storetype\fR option\&. For Policy Tool, you can specify a keystore type with the \fIKeystore\fR menu\&. - -If you do not explicitly specify a keystore type, then the tools choose a keystore implementation based on the value of the \f3keystore\&.type\fR property specified in the security properties file\&. The security properties file is called \f3java\&.security\fR, and resides in the security properties directory, \f3java\&.home\elib\esecurity\fR on Windows and \f3java\&.home/lib/security\fR on Oracle Solaris, where \f3java\&.home\fR is the runtime environment directory\&. The \f3jre\fR directory in the SDK or the top-level directory of the Java Runtime Environment (JRE)\&. - -Each tool gets the \f3keystore\&.type\fR value and then examines all the currently installed providers until it finds one that implements a keystores of that type\&. It then uses the keystore implementation from that provider\&.The \f3KeyStore\fR class defines a static method named \f3getDefaultType\fR that lets applications and applets retrieve the value of the \f3keystore\&.type\fR property\&. The following line of code creates an instance of the default keystore type as specified in the \f3keystore\&.type\fR property: -.sp -.nf -\f3KeyStore keyStore = KeyStore\&.getInstance(KeyStore\&.getDefaultType());\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The default keystore type is \f3jks\fR, which is the proprietary type of the keystore implementation provided by Oracle\&. This is specified by the following line in the security properties file: -.sp -.nf -\f3keystore\&.type=jks\fP -.fi -.nf -\f3\fP -.fi -.sp - - -To have the tools utilize a keystore implementation other than the default, you can change that line to specify a different keystore type\&. For example, if you have a provider package that supplies a keystore implementation for a keystore type called \f3pkcs12\fR, then change the line to the following: -.sp -.nf -\f3keystore\&.type=pkcs12\fP -.fi -.nf -\f3\fP -.fi -.sp - - -\fINote:\fR Case does not matter in keystore type designations\&. For example, JKS would be considered the same as jks\&. -.TP -Certificate -A certificate (or public-key certificate) is a digitally signed statement from one entity (the issuer), saying that the public key and some other information of another entity (the subject) has some specific value\&. The following terms are related to certificates: - -\fIPublic Keys\fR: These are numbers associated with a particular entity, and are intended to be known to everyone who needs to have trusted interactions with that entity\&. Public keys are used to verify signatures\&. - -\fIDigitally Signed\fR: If some data is digitally signed, then it is stored with the identity of an entity and a signature that proves that entity knows about the data\&. The data is rendered unforgeable by signing with the entity\&'s private key\&. - -\fIIdentity\fR: A known way of addressing an entity\&. In some systems, the identity is the public key, and in others it can be anything from an Oracle Solaris UID to an email address to an X\&.509 distinguished name\&. - -\fISignature\fR: A signature is computed over some data using the private key of an entity\&. The signer, which in the case of a certificate is also known as the issuer\&. - -\fIPrivate Keys\fR: These are numbers, each of which is supposed to be known only to the particular entity whose private key it is (that is, it is supposed to be kept secret)\&. Private and public keys exist in pairs in all public key cryptography systems (also referred to as public key crypto systems)\&. In a typical public key crypto system, such as DSA, a private key corresponds to exactly one public key\&. Private keys are used to compute signatures\&. - -\fIEntity\fR: An entity is a person, organization, program, computer, business, bank, or something else you are trusting to some degree\&. - -Public key cryptography requires access to users\&' public keys\&. In a large-scale networked environment, it is impossible to guarantee that prior relationships between communicating entities were established or that a trusted repository exists with all used public keys\&. Certificates were invented as a solution to this public key distribution problem\&. Now a Certification Authority (CA) can act as a trusted third party\&. CAs are entities such as businesses that are trusted to sign (issue) certificates for other entities\&. It is assumed that CAs only create valid and reliable certificates because they are bound by legal agreements\&. There are many public Certification Authorities, such as VeriSign, Thawte, Entrust, and so on\&. - -You can also run your own Certification Authority using products such as Microsoft Certificate Server or the Entrust CA product for your organization\&. With the \f3keytool\fR command, it is possible to display, import, and export certificates\&. It is also possible to generate self-signed certificates\&. - -The \f3keytool\fR command currently handles X\&.509 certificates\&. -.TP -X\&.509 Certificates -The X\&.509 standard defines what information can go into a certificate and describes how to write it down (the data format)\&. All the data in a certificate is encoded with two related standards called ASN\&.1/DER\&. Abstract Syntax Notation 1 describes data\&. The Definite Encoding Rules describe a single way to store and transfer that data\&. - -All X\&.509 certificates have the following data, in addition to the signature: - -\fIVersion\fR: This identifies which version of the X\&.509 standard applies to this certificate, which affects what information can be specified in it\&. Thus far, three versions are defined\&. The \f3keytool\fR command can import and export v1, v2, and v3 certificates\&. It generates v3 certificates\&. - -X\&.509 Version 1 has been available since 1988, is widely deployed, and is the most generic\&. - -X\&.509 Version 2 introduced the concept of subject and issuer unique identifiers to handle the possibility of reuse of subject or issuer names over time\&. Most certificate profile documents strongly recommend that names not be reused and that certificates should not make use of unique identifiers\&. Version 2 certificates are not widely used\&. - -X\&.509 Version 3 is the most recent (1996) and supports the notion of extensions where anyone can define an extension and include it in the certificate\&. Some common extensions are: KeyUsage (limits the use of the keys to particular purposes such as \f3signing-only\fR) and AlternativeNames (allows other identities to also be associated with this public key, for example\&. DNS names, email addresses, IP addresses)\&. Extensions can be marked critical to indicate that the extension should be checked and enforced or used\&. For example, if a certificate has the KeyUsage extension marked critical and set to \f3keyCertSign\fR, then when this certificate is presented during SSL communication, it should be rejected because the certificate extension indicates that the associated private key should only be used for signing certificates and not for SSL use\&. - -\fISerial number\fR: The entity that created the certificate is responsible for assigning it a serial number to distinguish it from other certificates it issues\&. This information is used in numerous ways\&. For example, when a certificate is revoked its serial number is placed in a Certificate Revocation List (CRL)\&. - -\fISignature algorithm identifier\fR: This identifies the algorithm used by the CA to sign the certificate\&. - -\fIIssuer name\fR: The X\&.500 Distinguished Name of the entity that signed the certificate\&. See X\&.500 Distinguished Names\&. This is typically a CA\&. Using this certificate implies trusting the entity that signed this certificate\&. In some cases, such as root or top-level CA certificates, the issuer signs its own certificate\&. - -\fIValidity period\fR: Each certificate is valid only for a limited amount of time\&. This period is described by a start date and time and an end date and time, and can be as short as a few seconds or almost as long as a century\&. The validity period chosen depends on a number of factors, such as the strength of the private key used to sign the certificate, or the amount one is willing to pay for a certificate\&. This is the expected period that entities can rely on the public value, when the associated private key has not been compromised\&. - -\fISubject name\fR: The name of the entity whose public key the certificate identifies\&. This name uses the X\&.500 standard, so it is intended to be unique across the Internet\&. This is the X\&.500 Distinguished Name (DN) of the entity\&. See X\&.500 Distinguished Names\&. For example, -.sp -.nf -\f3CN=Java Duke, OU=Java Software Division, O=Oracle Corporation, C=US\fP -.fi -.nf -\f3\fP -.fi -.sp - - -These refer to the subject\&'s common name (CN), organizational unit (OU), organization (O), and country (C)\&. - -\fISubject public key information\fR: This is the public key of the entity being named with an algorithm identifier that specifies which public key crypto system this key belongs to and any associated key parameters\&. -.TP -Certificate Chains -The \f3keytool\fR command can create and manage keystore key entries that each contain a private key and an associated certificate chain\&. The first certificate in the chain contains the public key that corresponds to the private key\&. - -When keys are first generated, the chain starts off containing a single element, a self-signed certificate\&. See \f3-genkeypair\fR in Commands\&. A self-signed certificate is one for which the issuer (signer) is the same as the subject\&. The subject is the entity whose public key is being authenticated by the certificate\&. Whenever the \f3-genkeypair\fR command is called to generate a new public/private key pair, it also wraps the public key into a self-signed certificate\&. - -Later, after a Certificate Signing Request (CSR) was generated with the \f3-certreq\fR command and sent to a Certification Authority (CA), the response from the CA is imported with \f3-importcert\fR, and the self-signed certificate is replaced by a chain of certificates\&. See the \f3-certreq\fR and \f3-importcert\fR options in Commands\&. At the bottom of the chain is the certificate (reply) issued by the CA authenticating the subject\&'s public key\&. The next certificate in the chain is one that authenticates the CA\&'s public key\&. - -In many cases, this is a self-signed certificate, which is a certificate from the CA authenticating its own public key, and the last certificate in the chain\&. In other cases, the CA might return a chain of certificates\&. In this case, the bottom certificate in the chain is the same (a certificate signed by the CA, authenticating the public key of the key entry), but the second certificate in the chain is a certificate signed by a different CA that authenticates the public key of the CA you sent the CSR to\&. The next certificate in the chain is a certificate that authenticates the second CA\&'s key, and so on, until a self-signed root certificate is reached\&. Each certificate in the chain (after the first) authenticates the public key of the signer of the previous certificate in the chain\&. - -Many CAs only return the issued certificate, with no supporting chain, especially when there is a flat hierarchy (no intermediates CAs)\&. In this case, the certificate chain must be established from trusted certificate information already stored in the keystore\&. - -A different reply format (defined by the PKCS #7 standard) includes the supporting certificate chain in addition to the issued certificate\&. Both reply formats can be handled by the \f3keytool\fR command\&. - -The top-level (root) CA certificate is self-signed\&. However, the trust into the root\&'s public key does not come from the root certificate itself, but from other sources such as a newspaper\&. This is because anybody could generate a self-signed certificate with the distinguished name of, for example, the VeriSign root CA\&. The root CA public key is widely known\&. The only reason it is stored in a certificate is because this is the format understood by most tools, so the certificate in this case is only used as a vehicle to transport the root CA\&'s public key\&. Before you add the root CA certificate to your keystore, you should view it with the \f3-printcert\fR option and compare the displayed fingerprint with the well-known fingerprint obtained from a newspaper, the root CA\&'s Web page, and so on\&. -.TP -The cacerts Certificates File -A certificates file named \f3cacerts\fR resides in the security properties directory, \f3java\&.home\elib\esecurity\fR on Windows and \f3java\&.home/lib/security\fR on Oracle Solaris, where \f3java\&.home\fR is the runtime environment\&'s directory, which would be the \f3jre\fR directory in the SDK or the top-level directory of the JRE\&. - -The \f3cacerts\fR file represents a system-wide keystore with CA certificates\&. System administrators can configure and manage that file with the \f3keytool\fR command by specifying \f3jks\fR as the keystore type\&. The \f3cacerts\fR keystore file ships with a default set of root CA certificates\&. You can list the default certificates with the following command: -.sp -.nf -\f3keytool \-list \-keystore java\&.home/lib/security/cacerts\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The initial password of the \f3cacerts\fR keystore file is \f3changeit\fR\&. System administrators should change that password and the default access permission of that file upon installing the SDK\&. - -\fINote:\fR It is important to verify your \f3cacerts\fR file\&. Because you trust the CAs in the \f3cacerts\fR file as entities for signing and issuing certificates to other entities, you must manage the \f3cacerts\fR file carefully\&. The \f3cacerts\fR file should contain only certificates of the CAs you trust\&. It is your responsibility to verify the trusted root CA certificates bundled in the \f3cacerts\fR file and make your own trust decisions\&. - -To remove an untrusted CA certificate from the \f3cacerts\fR file, use the \f3delete\fR option of the \f3keytool\fR command\&. You can find the \f3cacerts\fR file in the JRE installation directory\&. Contact your system administrator if you do not have permission to edit this file -.TP -Internet RFC 1421 Certificate Encoding Standard -Certificates are often stored using the printable encoding format defined by the Internet RFC 1421 standard, instead of their binary encoding\&. This certificate format, also known as Base64 encoding, makes it easy to export certificates to other applications by email or through some other mechanism\&. - -Certificates read by the \f3-importcert\fR and \f3-printcert\fR commands can be in either this format or binary encoded\&. The \f3-exportcert\fR command by default outputs a certificate in binary encoding, but will instead output a certificate in the printable encoding format, when the \f3-rfc\fR option is specified\&. - -The \f3-list\fR command by default prints the SHA1 fingerprint of a certificate\&. If the \f3-v\fR option is specified, then the certificate is printed in human-readable format\&. If the \f3-rfc\fR option is specified, then the certificate is output in the printable encoding format\&. - -In its printable encoding format, the encoded certificate is bounded at the beginning and end by the following text: -.sp -.nf -\f3\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3encoded certificate goes here\&. \fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\-\-\-\-\-END CERTIFICATE\-\-\-\-\-\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -X\&.500 Distinguished Names -X\&.500 Distinguished Names are used to identify entities, such as those that are named by the \f3subject\fR and \f3issuer\fR (signer) fields of X\&.509 certificates\&. The \f3keytool\fR command supports the following subparts: - -\fIcommonName\fR: The common name of a person such as Susan Jones\&. - -\fIorganizationUnit\fR: The small organization (such as department or division) name\&. For example, Purchasing\&. - -\fIlocalityName\fR: The locality (city) name, for example, Palo Alto\&. - -\fIstateName\fR: State or province name, for example, California\&. - -\fIcountry\fR: Two-letter country code, for example, CH\&. - -When you supply a distinguished name string as the value of a \f3-dname\fR option, such as for the \f3-genkeypair\fR command, the string must be in the following format: -.sp -.nf -\f3CN=cName, OU=orgUnit, O=org, L=city, S=state, C=countryCode\fP -.fi -.nf -\f3\fP -.fi -.sp - - -All the italicized items represent actual values and the previous keywords are abbreviations for the following: -.sp -.nf -\f3CN=commonName\fP -.fi -.nf -\f3OU=organizationUnit\fP -.fi -.nf -\f3O=organizationName\fP -.fi -.nf -\f3L=localityName\fP -.fi -.nf -\f3S=stateName\fP -.fi -.nf -\f3C=country\fP -.fi -.nf -\f3\fP -.fi -.sp - - -A sample distinguished name string is: -.sp -.nf -\f3CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino, S=California, C=US\fP -.fi -.nf -\f3\fP -.fi -.sp - - -A sample command using such a string is: -.sp -.nf -\f3keytool \-genkeypair \-dname "CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino,\fP -.fi -.nf -\f3S=California, C=US" \-alias mark\fP -.fi -.nf -\f3\fP -.fi -.sp - - -Case does not matter for the keyword abbreviations\&. For example, CN, cn, and Cn are all treated the same\&. - -Order matters; each subcomponent must appear in the designated order\&. However, it is not necessary to have all the subcomponents\&. You can use a subset, for example: -.sp -.nf -\f3CN=Steve Meier, OU=Java, O=Oracle, C=US\fP -.fi -.nf -\f3\fP -.fi -.sp - - -If a distinguished name string value contains a comma, then the comma must be escaped by a backslash (\e) character when you specify the string on a command line, as in: -.sp -.nf -\f3cn=Peter Schuster, ou=Java\e, Product Development, o=Oracle, c=US\fP -.fi -.nf -\f3\fP -.fi -.sp - - -It is never necessary to specify a distinguished name string on a command line\&. When the distinguished name is needed for a command, but not supplied on the command line, the user is prompted for each of the subcomponents\&. In this case, a comma does not need to be escaped by a backslash (\e)\&. -.SH WARNINGS -.SS IMPORTING\ TRUSTED\ CERTIFICATES\ WARNING -\fIImportant\fR: Be sure to check a certificate very carefully before importing it as a trusted certificate\&. -.PP -Windows Example: - -View the certificate first with the \f3-printcert\fR command or the \f3-importcert\fR command without the \f3-noprompt\fR option\&. Ensure that the displayed certificate fingerprints match the expected ones\&. For example, suppose sends or emails you a certificate that you put it in a file named \f3\etmp\ecert\fR\&. Before you consider adding the certificate to your list of trusted certificates, you can execute a \f3-printcert\fR command to view its fingerprints, as follows: -.sp -.nf -\f3 keytool \-printcert \-file \etmp\ecert\fP -.fi -.nf -\f3 Owner: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP -.fi -.nf -\f3 Issuer: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP -.fi -.nf -\f3 Serial Number: 59092b34\fP -.fi -.nf -\f3 Valid from: Thu Sep 25 18:01:13 PDT 1997 until: Wed Dec 24 17:01:13 PST 1997\fP -.fi -.nf -\f3 Certificate Fingerprints:\fP -.fi -.nf -\f3 MD5: 11:81:AD:92:C8:E5:0E:A2:01:2E:D4:7A:D7:5F:07:6F\fP -.fi -.nf -\f3 SHA1: 20:B6:17:FA:EF:E5:55:8A:D0:71:1F:E8:D6:9D:C0:37:13:0E:5E:FE\fP -.fi -.nf -\f3 SHA256: 90:7B:70:0A:EA:DC:16:79:92:99:41:FF:8A:FE:EB:90:\fP -.fi -.nf -\f3 17:75:E0:90:B2:24:4D:3A:2A:16:A6:E4:11:0F:67:A4\fP -.fi -.sp - -.PP -Oracle Solaris Example: - -View the certificate first with the \f3-printcert\fR command or the \f3-importcert\fR command without the \f3-noprompt\fR option\&. Ensure that the displayed certificate fingerprints match the expected ones\&. For example, suppose someone sends or emails you a certificate that you put it in a file named \f3/tmp/cert\fR\&. Before you consider adding the certificate to your list of trusted certificates, you can execute a \f3-printcert\fR command to view its fingerprints, as follows: -.sp -.nf -\f3 keytool \-printcert \-file /tmp/cert\fP -.fi -.nf -\f3 Owner: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP -.fi -.nf -\f3 Issuer: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP -.fi -.nf -\f3 Serial Number: 59092b34\fP -.fi -.nf -\f3 Valid from: Thu Sep 25 18:01:13 PDT 1997 until: Wed Dec 24 17:01:13 PST 1997\fP -.fi -.nf -\f3 Certificate Fingerprints:\fP -.fi -.nf -\f3 MD5: 11:81:AD:92:C8:E5:0E:A2:01:2E:D4:7A:D7:5F:07:6F\fP -.fi -.nf -\f3 SHA1: 20:B6:17:FA:EF:E5:55:8A:D0:71:1F:E8:D6:9D:C0:37:13:0E:5E:FE\fP -.fi -.nf -\f3 SHA256: 90:7B:70:0A:EA:DC:16:79:92:99:41:FF:8A:FE:EB:90:\fP -.fi -.nf -\f3 17:75:E0:90:B2:24:4D:3A:2A:16:A6:E4:11:0F:67:A4\fP -.fi -.nf -\f3\fP -.fi -.sp -Then call or otherwise contact the person who sent the certificate and compare the fingerprints that you see with the ones that they show\&. Only when the fingerprints are equal is it guaranteed that the certificate was not replaced in transit with somebody else\&'s certificate such as an attacker\&'s certificate\&. If such an attack took place, and you did not check the certificate before you imported it, then you would be trusting anything the attacker signed, for example, a JAR file with malicious class files inside\&. -.PP -\fINote:\fR It is not required that you execute a \f3-printcert\fR command before importing a certificate\&. This is because before you add a certificate to the list of trusted certificates in the keystore, the \f3-importcert\fR command prints out the certificate information and prompts you to verify it\&. You can then stop the import operation\&. However, you can do this only when you call the \f3-importcert\fR command without the \f3-noprompt\fR option\&. If the \f3-noprompt\fR option is specified, then there is no interaction with the user\&. -.SS PASSWORDS\ WARNING -Most commands that operate on a keystore require the store password\&. Some commands require a private/secret key password\&. Passwords can be specified on the command line in the \f3-storepass\fR and \f3-keypass\fR options\&. However, a password should not be specified on a command line or in a script unless it is for testing, or you are on a secure system\&. When you do not specify a required password option on a command line, you are prompted for it\&. -.SS CERTIFICATE\ CONFORMANCE\ WARNING -The Internet standard RFC 5280 has defined a profile on conforming X\&.509 certificates, which includes what values and value combinations are valid for certificate fields and extensions\&. See the standard at http://tools\&.ietf\&.org/rfc/rfc5280\&.txt -.PP -The \f3keytool\fR command does not enforce all of these rules so it can generate certificates that do not conform to the standard\&. Certificates that do not conform to the standard might be rejected by JRE or other applications\&. Users should ensure that they provide the correct options for \f3-dname\fR, \f3-ext\fR, and so on\&. -.SH NOTES -.SS IMPORT\ A\ NEW\ TRUSTED\ CERTIFICATE -Before you add the certificate to the keystore, the \f3keytool\fR command verifies it by attempting to construct a chain of trust from that certificate to a self-signed certificate (belonging to a root CA), using trusted certificates that are already available in the keystore\&. -.PP -If the \f3-trustcacerts\fR option was specified, then additional certificates are considered for the chain of trust, namely the certificates in a file named \f3cacerts\fR\&. -.PP -If the \f3keytool\fR command fails to establish a trust path from the certificate to be imported up to a self-signed certificate (either from the keystore or the \f3cacerts\fR file), then the certificate information is printed, and the user is prompted to verify it by comparing the displayed certificate fingerprints with the fingerprints obtained from some other (trusted) source of information, which might be the certificate owner\&. Be very careful to ensure the certificate is valid before importing it as a trusted certificate\&. See Importing Trusted Certificates Warning\&. The user then has the option of stopping the import operation\&. If the \f3-noprompt\fR option is specified, then there is no interaction with the user\&. -.SS IMPORT\ A\ CERTIFICATE\ REPLY -When you import a certificate reply, the certificate reply is validated with trusted certificates from the keystore, and optionally, the certificates configured in the \f3cacerts\fR keystore file when the \f3-trustcacert\fR\f3s\fR option is specified\&. See The cacerts Certificates File\&. -.PP -The methods of determining whether the certificate reply is trusted are as follows: -.TP 0.2i -\(bu -If the reply is a single X\&.509 certificate, then the \f3keytool\fR command attempts to establish a trust chain, starting at the certificate reply and ending at a self-signed certificate (belonging to a root CA)\&. The certificate reply and the hierarchy of certificates is used to authenticate the certificate reply from the new certificate chain of aliases\&. If a trust chain cannot be established, then the certificate reply is not imported\&. In this case, the \f3keytool\fR command does not print the certificate and prompt the user to verify it, because it is very difficult for a user to determine the authenticity of the certificate reply\&. -.TP 0.2i -\(bu -If the reply is a PKCS #7 formatted certificate chain or a sequence of X\&.509 certificates, then the chain is ordered with the user certificate first followed by zero or more CA certificates\&. If the chain ends with a self-signed root CA certificate and the\f3-trustcacerts\fR option was specified, the \f3keytool\fR command attempts to match it with any of the trusted certificates in the keystore or the \f3cacerts\fR keystore file\&. If the chain does not end with a self-signed root CA certificate and the \f3-trustcacerts\fR option was specified, the \f3keytool\fR command tries to find one from the trusted certificates in the keystore or the \f3cacerts\fR keystore file and add it to the end of the chain\&. If the certificate is not found and the \f3-noprompt\fR option is not specified, the information of the last certificate in the chain is printed, and the user is prompted to verify it\&. -.PP -If the public key in the certificate reply matches the user\&'s public key already stored with \f3alias\fR, then the old certificate chain is replaced with the new certificate chain in the reply\&. The old chain can only be replaced with a valid \f3keypass\fR, and so the password used to protect the private key of the entry is supplied\&. If no password is provided, and the private key password is different from the keystore password, the user is prompted for it\&. -.PP -This command was named \f3-import\fR in earlier releases\&. This old name is still supported in this release\&. The new name, \f3-importcert\fR, is preferred going forward\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -jar(1) -.TP 0.2i -\(bu -jarsigner(1) -.TP 0.2i -\(bu -Trail: Security Features in Java SE at http://docs\&.oracle\&.com/javase/tutorial/security/index\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1998, 2015, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 03 March 2015 +.\" SectDesc: Security Tools +.\" Title: keytool.1 +.\" +.if n .pl 99999 +.TH keytool 1 "03 March 2015" "JDK 8" "Security Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +keytool \- Manages a keystore (database) of cryptographic keys, X\&.509 certificate chains, and trusted certificates\&. +.SH SYNOPSIS +.sp +.nf + +\fBkeytool\fR [\fIcommands\fR] +.fi +.sp +.TP +\fIcommands\fR +See Commands\&. These commands are categorized by task as follows: +.RS +.TP 0.2i +\(bu +Create or Add Data to the Keystore +.RS +.TP 0.2i +\(bu +-gencert +.TP 0.2i +\(bu +-genkeypair +.TP 0.2i +\(bu +-genseckey +.TP 0.2i +\(bu +-importcert +.TP 0.2i +\(bu +-importpassword +.RE + +.TP 0.2i +\(bu +Import Contents From Another Keystore +.RS +.TP 0.2i +\(bu +-importkeystore +.RE + +.TP 0.2i +\(bu +Generate Certificate Request +.RS +.TP 0.2i +\(bu +-certreq +.RE + +.TP 0.2i +\(bu +Export Data +.RS +.TP 0.2i +\(bu +-exportcert +.RE + +.TP 0.2i +\(bu +Display Data +.RS +.TP 0.2i +\(bu +-list +.TP 0.2i +\(bu +-printcert +.TP 0.2i +\(bu +-printcertreq +.TP 0.2i +\(bu +-printcrl +.RE + +.TP 0.2i +\(bu +Manage the Keystore +.RS +.TP 0.2i +\(bu +-storepasswd +.TP 0.2i +\(bu +-keypasswd +.TP 0.2i +\(bu +-delete +.TP 0.2i +\(bu +-changealias +.RE + +.TP 0.2i +\(bu +Get Help +.RS +.TP 0.2i +\(bu +-help +.RE + +.RE + +.SH DESCRIPTION +The \f3keytool\fR command is a key and certificate management utility\&. It enables users to administer their own public/private key pairs and associated certificates for use in self-authentication (where the user authenticates himself or herself to other users and services) or data integrity and authentication services, using digital signatures\&. The \f3keytool\fR command also enables users to cache the public keys (in the form of certificates) of their communicating peers\&. +.PP +A certificate is a digitally signed statement from one entity (person, company, and so on\&.), that says that the public key (and some other information) of some other entity has a particular value\&. (See Certificate\&.) When data is digitally signed, the signature can be verified to check the data integrity and authenticity\&. Integrity means that the data has not been modified or tampered with, and authenticity means the data comes from whoever claims to have created and signed it\&. +.PP +The \f3keytool\fR command also enables users to administer secret keys and passphrases used in symmetric encryption and decryption (DES)\&. +.PP +The \f3keytool\fR command stores the keys and certificates in a keystore\&. See KeyStore aliases\&. +.SH COMMAND\ AND\ OPTION\ NOTES +See Commands for a listing and description of the various commands\&. +.TP 0.2i +\(bu +All command and option names are preceded by a minus sign (-)\&. +.TP 0.2i +\(bu +The options for each command can be provided in any order\&. +.TP 0.2i +\(bu +All items not italicized or in braces or brackets are required to appear as is\&. +.TP 0.2i +\(bu +Braces surrounding an option signify that a default value will be used when the option is not specified on the command line\&. See Option Defaults\&. Braces are also used around the \f3-v\fR, \f3-rfc\fR, and \f3-J\fR options, which only have meaning when they appear on the command line\&. They do not have any default values other than not existing\&. +.TP 0.2i +\(bu +Brackets surrounding an option signify that the user is prompted for the values when the option is not specified on the command line\&. For the \f3-keypass\fR option, if you do not specify the option on the command line, then the \f3keytool\fR command first attempts to use the keystore password to recover the private/secret key\&. If this attempt fails, then the \f3keytool\fR command prompts you for the private/secret key password\&. +.TP 0.2i +\(bu +Items in italics (option values) represent the actual values that must be supplied\&. For example, here is the format of the \f3-printcert\fR command: +.sp +.nf +\f3keytool \-printcert {\-file \fIcert_file\fR} {\-v}\fP +.fi +.sp + + + + +When you specify a \f3-printcert\fR command, replace \fIcert_file\fR with the actual file name, as follows: \f3keytool -printcert -file VScert\&.cer\fR +.TP 0.2i +\(bu +Option values must be put in quotation marks when they contain a blank (space)\&. +.TP 0.2i +\(bu +The \f3-help\fR option is the default\&. The \f3keytool\fR command is the same as \f3keytool -help\fR\&. +.SH OPTION\ DEFAULTS +The following examples show the defaults for various option values\&. +.sp +.nf +\f3\-alias "mykey"\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-keyalg\fP +.fi +.nf +\f3 "DSA" (when using \-genkeypair)\fP +.fi +.nf +\f3 "DES" (when using \-genseckey)\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-keysize\fP +.fi +.nf +\f3 2048 (when using \-genkeypair and \-keyalg is "RSA")\fP +.fi +.nf +\f3 1024 (when using \-genkeypair and \-keyalg is "DSA")\fP +.fi +.nf +\f3 256 (when using \-genkeypair and \-keyalg is "EC")\fP +.fi +.nf +\f3 56 (when using \-genseckey and \-keyalg is "DES")\fP +.fi +.nf +\f3 168 (when using \-genseckey and \-keyalg is "DESede")\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-validity 90\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-keystore <the file named \&.keystore in the user\&'s home directory>\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-storetype <the value of the "keystore\&.type" property in the\fP +.fi +.nf +\f3 security properties file, which is returned by the static\fP +.fi +.nf +\f3 getDefaultType method in java\&.security\&.KeyStore>\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-file\fP +.fi +.nf +\f3 stdin (if reading)\fP +.fi +.nf +\f3 stdout (if writing)\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-protected false\fP +.fi +.nf +\f3\fP +.fi +.sp +In generating a public/private key pair, the signature algorithm (\f3-sigalg\fR option) is derived from the algorithm of the underlying private key: +.TP 0.2i +\(bu +If the underlying private key is of type DSA, then the \f3-sigalg\fR option defaults to SHA1withDSA\&. +.TP 0.2i +\(bu +If the underlying private key is of type RSA, then the \f3-sigalg\fR option defaults to SHA256withRSA\&. +.TP 0.2i +\(bu +If the underlying private key is of type EC, then the \f3-sigalg\fR option defaults to SHA256withECDSA\&. +.PP +For a full list of \f3-keyalg\fR and \f3-sigalg\fR arguments, see Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA +.SH COMMON\ OPTIONS +The \f3-v\fR option can appear for all commands except \f3-help\fR\&. When the \f3-v\fR option appears, it signifies verbose mode, which means that more information is provided in the output\&. +.PP +There is also a \f3-Jjavaoption\fR argument that can appear for any command\&. When the \f3-Jjavaoption\fR appears, the specified \f3javaoption\fR string is passed directly to the Java interpreter\&. This option does not contain any spaces\&. It is useful for adjusting the execution environment or memory usage\&. For a list of possible interpreter options, type \f3java -h\fR or \f3java -X\fR at the command line\&. +.PP +These options can appear for all commands operating on a keystore: +.TP +-storetype \fIstoretype\fR +.br +This qualifier specifies the type of keystore to be instantiated\&. +.TP +-keystore \fIkeystore\fR +.br +The keystore location\&. + +If the JKS \f3storetype\fR is used and a keystore file does not yet exist, then certain \f3keytool\fR commands can result in a new keystore file being created\&. For example, if \f3keytool -genkeypair\fR is called and the \f3-keystore\fR option is not specified, the default keystore file named \f3\&.keystore\fR in the user\&'s home directory is created when it does not already exist\&. Similarly, if the \f3-keystore ks_file\fR option is specified but ks_file does not exist, then it is created\&. For more information on the JKS \f3storetype\fR, see the \fIKeyStore Implementation\fR section in KeyStore aliases\&. + +Note that the input stream from the \f3-keystore\fR option is passed to the \f3KeyStore\&.load\fR method\&. If \f3NONE\fR is specified as the URL, then a null stream is passed to the \f3KeyStore\&.load\fR method\&. \f3NONE\fR should be specified if the keystore is not file-based\&. For example, when it resides on a hardware token device\&. +.TP +-storepass[:\fIenv\fR| :\fIfile\fR] argument +.br +The password that is used to protect the integrity of the keystore\&. + +If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the \f3value\fR argument, which must be at least 6 characters long\&. Otherwise, the password is retrieved as follows: +.RS +.TP 0.2i +\(bu +\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. +.TP 0.2i +\(bu +\f3file\fR: Retrieve the password from the file named argument\&. +.RE + + +\fINote:\fR All other options that require passwords, such as \f3-keypass\fR, \f3-srckeypass\fR, -\f3destkeypass\fR, \f3-srcstorepass\fR, and \f3-deststorepass\fR, accept the \fIenv\fR and \fIfile\fR modifiers\&. Remember to separate the password option and the modifier with a colon (:)\&. + +The password must be provided to all commands that access the keystore contents\&. For such commands, when the \f3-storepass\fR option is not provided at the command line, the user is prompted for it\&. + +When retrieving information from the keystore, the password is optional\&. If no password is specified, then the integrity of the retrieved information cannot be verified and a warning is displayed\&. +.TP +-providerName \fIprovider_name\fR +.br +Used to identify a cryptographic service provider\&'s name when listed in the security properties file\&. +.TP +-providerClass \fIprovider_class_name\fR +.br +Used to specify the name of a cryptographic service provider\&'s master class file when the service provider is not listed in the security properties file\&. +.TP +-providerArg \fIprovider_arg\fR +.br +Used with the \f3-providerClass\fR option to represent an optional string input argument for the constructor of \f3provider_class_name\fR\&. +.TP +-protected +.br +Either \f3true\fR or \f3false\fR\&. This value should be specified as \f3true\fR when a password must be specified by way of a protected authentication path such as a dedicated PIN reader\&.Because there are two keystores involved in the \f3-importkeystore\fR command, the following two options \f3-srcprotected\fR and -\f3destprotected\fR are provided for the source keystore and the destination keystore respectively\&. +.TP +-ext \fI{name{:critical} {=value}}\fR +.br +Denotes an X\&.509 certificate extension\&. The option can be used in \f3-genkeypair\fR and \f3-gencert\fR to embed extensions into the certificate generated, or in \f3-certreq\fR to show what extensions are requested in the certificate request\&. The option can appear multiple times\&. The \f3name\fR argument can be a supported extension name (see Named Extensions) or an arbitrary OID number\&. The \f3value\fR argument, when provided, denotes the argument for the extension\&. When \fIvalue\fR is omitted, that means that the default value of the extension or the extension requires no argument\&. The \f3:critical\fR modifier, when provided, means the extension\&'s \f3isCritical\fR attribute is \f3true\fR; otherwise, it is \f3false\fR\&. You can use \f3:c\fR in place of \f3:critical\fR\&. +.SH NAMED\ EXTENSIONS +The \f3keytool\fR command supports these named extensions\&. The names are not case-sensitive)\&. +.TP +BC or BasicContraints +\fIValues\fR: The full form is: \f3ca:{true|false}[,pathlen:<len>]\fR or \f3<len>\fR, which is short for \f3ca:true,pathlen:<len>\fR\&. When <\f3len\fR> is omitted, you have \f3ca:true\fR\&. +.TP +KU or KeyUsage +\fIValues\fR: \f3usage\fR(,\f3usage\fR)*, where \fIusage\fR can be one of \f3digitalSignature\fR, \f3nonRepudiation\fR (contentCommitment), \f3keyEncipherment\fR, \f3dataEncipherment\fR, \f3keyAgreement\fR, \f3keyCertSign\fR, \f3cRLSign\fR, \f3encipherOnly\fR, \f3decipherOnly\fR\&. The \fIusage\fR argument can be abbreviated with the first few letters (\f3dig\fR for \f3digitalSignature\fR) or in camel-case style (\f3dS\fR for \f3digitalSignature\fR or \f3cRLS\fR for \f3cRLSign\fR), as long as no ambiguity is found\&. The \f3usage\fR values are case-sensitive\&. +.TP +EKU or ExtendedKeyUsage +\fIValues\fR: \f3usage\fR(,\f3usage\fR)*, where \fIusage\fR can be one of \f3anyExtendedKeyUsage\fR, \f3serverAuth\fR, \f3clientAuth\fR, \f3codeSigning\fR, \f3emailProtection\fR, \f3timeStamping\fR, \f3OCSPSigning\fR, or any \fIOID string\fR\&. The \fIusage\fR argument can be abbreviated with the first few letters or in camel-case style, as long as no ambiguity is found\&. The \f3usage\fR values are case-sensitive\&. +.TP +SAN or SubjectAlternativeName +\fIValues\fR: \f3type\fR:\f3value\fR(,t\f3ype:value\fR)*, where \f3type\fR can be \f3EMAIL\fR, \f3URI\fR, \f3DNS\fR, \f3IP\fR, or \f3OID\fR\&. The \f3value\fR argument is the string format value for the \f3type\fR\&. +.TP +IAN or IssuerAlternativeName +\fIValues\fR: Same as \f3SubjectAlternativeName\fR\&. +.TP +SIA or SubjectInfoAccess +\fIValues\fR: \f3method\fR:\f3location-type\fR:\f3location-value\fR (,\f3method:location-type\fR:\f3location-value\fR)*, where \f3method\fR can be \f3timeStamping\fR, \f3caRepository\fR or any OID\&. The \f3location-type\fR and \f3location-value\fR arguments can be any \f3type\fR:\f3value\fR supported by the \f3SubjectAlternativeName\fR extension\&. +.TP +AIA or AuthorityInfoAccess +\fIValues\fR: Same as \f3SubjectInfoAccess\fR\&. The \f3method\fR argument can be \f3ocsp\fR,\f3caIssuers\fR, or any OID\&. +.PP +When \f3name\fR is OID, the value is the hexadecimal dumped DER encoding of the \f3extnValue\fR for the extension excluding the OCTET STRING type and length bytes\&. Any extra character other than standard hexadecimal numbers (0-9, a-f, A-F) are ignored in the HEX string\&. Therefore, both 01:02:03:04 and 01020304 are accepted as identical values\&. When there is no value, the extension has an empty value field\&. +.PP +A special name \f3honored\fR, used in \f3-gencert\fR only, denotes how the extensions included in the certificate request should be honored\&. The value for this name is a comma separated list of \f3all\fR (all requested extensions are honored), \f3name{:[critical|non-critical]}\fR (the named extension is honored, but using a different \f3isCritical\fR attribute) and \f3-name\fR (used with \f3all\fR, denotes an exception)\&. Requested extensions are not honored by default\&. +.PP +If, besides the\f3-ext honored\fR option, another named or OID \f3-ext\fR option is provided, this extension is added to those already honored\&. However, if this name (or OID) also appears in the honored value, then its value and criticality overrides the one in the request\&. +.PP +The \f3subjectKeyIdentifier\fR extension is always created\&. For non-self-signed certificates, the \f3authorityKeyIdentifier\fR is created\&. +.PP +\fINote:\fR Users should be aware that some combinations of extensions (and other certificate fields) may not conform to the Internet standard\&. See Certificate Conformance Warning\&. +.SH COMMANDS +.TP +-gencert +.sp +.nf +\f3{\-rfc} {\-infile \fIinfile\fR} {\-outfile \fIoutfile\fR} {\-alias \fIalias\fR} {\-sigalg \fIsigalg\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-dname \fIdname\fR} {\-startdate \fIstartdate\fR {\-ext \fIext\fR}* {\-validity \fIvalDays\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-keypass \fIkeypass\fR] {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP +.fi +.sp +.sp +.nf +\f3{\-storetype \fIstoretype\fR} {\-providername \fIprovider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-v} {\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Generates a certificate as a response to a certificate request file (which can be created by the \f3keytool\fR\f3-certreq\fR command)\&. The command reads the request from \fIinfile\fR (if omitted, from the standard input), signs it using alias\&'s private key, and outputs the X\&.509 certificate into \fIoutfile\fR (if omitted, to the standard output)\&. When\f3-rfc\fR is specified, the output format is Base64-encoded PEM; otherwise, a binary DER is created\&. + +The \f3sigalg\fR value specifies the algorithm that should be used to sign the certificate\&. The \f3startdate\fR argument is the start time and date that the certificate is valid\&. The \f3valDays\fR argument tells the number of days for which the certificate should be considered valid\&. + +When \f3dname\fR is provided, it is used as the subject of the generated certificate\&. Otherwise, the one from the certificate request is used\&. + +The \f3ext\fR value shows what X\&.509 extensions will be embedded in the certificate\&. Read Common Options for the grammar of \f3-ext\fR\&. + +The \f3-gencert\fR option enables you to create certificate chains\&. The following example creates a certificate, \f3e1\fR, that contains three certificates in its certificate chain\&. + +The following commands creates four key pairs named \f3ca\fR, \f3ca1\fR, \f3ca2\fR, and \f3e1\fR: +.sp +.nf +\f3keytool \-alias ca \-dname CN=CA \-genkeypair\fP +.fi +.nf +\f3keytool \-alias ca1 \-dname CN=CA \-genkeypair\fP +.fi +.nf +\f3keytool \-alias ca2 \-dname CN=CA \-genkeypair\fP +.fi +.nf +\f3keytool \-alias e1 \-dname CN=E1 \-genkeypair\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following two commands create a chain of signed certificates; \f3ca\fR signs \f3ca1\fR and \f3ca1\fR signs \f3ca2\fR, all of which are self-issued: +.sp +.nf +\f3keytool \-alias ca1 \-certreq |\fP +.fi +.nf +\f3 keytool \-alias ca \-gencert \-ext san=dns:ca1 |\fP +.fi +.nf +\f3 keytool \-alias ca1 \-importcert\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3keytool \-alias ca2 \-certreq |\fP +.fi +.nf +\f3 $KT \-alias ca1 \-gencert \-ext san=dns:ca2 |\fP +.fi +.nf +\f3 $KT \-alias ca2 \-importcert\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following command creates the certificate \f3e1\fR and stores it in the file \f3e1\&.cert\fR, which is signed by \f3ca2\fR\&. As a result, \f3e1\fR should contain \f3ca\fR, \f3ca1\fR, and \f3ca2\fR in its certificate chain: +.sp +.nf +\f3keytool \-alias e1 \-certreq | keytool \-alias ca2 \-gencert > e1\&.cert\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-genkeypair +.sp +.nf +\f3{\-alias \fIalias\fR} {\-keyalg \fIkeyalg\fR} {\-keysize \fIkeysize\fR} {\-sigalg \fIsigalg\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-dname \fIdname\fR] [\-keypass \fIkeypass\fR] {\-startdate \fIvalue\fR} {\-ext \fIext\fR}*\fP +.fi +.sp +.sp +.nf +\f3{\-validity \fIvalDays\fR} {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-storepass \fIstorepass\fR]\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-v} {\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Generates a key pair (a public key and associated private key)\&. Wraps the public key into an X\&.509 v3 self-signed certificate, which is stored as a single-element certificate chain\&. This certificate chain and the private key are stored in a new keystore entry identified by alias\&. + +The \f3keyalg\fR value specifies the algorithm to be used to generate the key pair, and the \f3keysize\fR value specifies the size of each key to be generated\&. The \f3sigalg\fR value specifies the algorithm that should be used to sign the self-signed certificate\&. This algorithm must be compatible with the \f3keyalg\fR value\&. + +The \f3dname\fR value specifies the X\&.500 Distinguished Name to be associated with the value of \f3alias\fR, and is used as the issuer and subject fields in the self-signed certificate\&. If no distinguished name is provided at the command line, then the user is prompted for one\&. + +The value of \f3keypass\fR is a password used to protect the private key of the generated key pair\&. If no password is provided, then the user is prompted for it\&. If you press \fIthe Return key\fR at the prompt, then the key password is set to the same password as the keystore password\&. The \f3keypass\fR value must be at least 6 characters\&. + +The value of \f3startdate\fR specifies the issue time of the certificate, also known as the "Not Before" value of the X\&.509 certificate\&'s Validity field\&. + +The option value can be set in one of these two forms: + +\f3([+-]nnn[ymdHMS])+\fR + +\f3[yyyy/mm/dd] [HH:MM:SS]\fR + +With the first form, the issue time is shifted by the specified value from the current time\&. The value is a concatenation of a sequence of subvalues\&. Inside each subvalue, the plus sign (+) means shift forward, and the minus sign (-) means shift backward\&. The time to be shifted is \f3nnn\fR units of years, months, days, hours, minutes, or seconds (denoted by a single character of \f3y\fR, \f3m\fR, \f3d\fR, \f3H\fR, \f3M\fR, or \f3S\fR respectively)\&. The exact value of the issue time is calculated using the \f3java\&.util\&.GregorianCalendar\&.add(int field, int amount)\fR method on each subvalue, from left to right\&. For example, by specifying, the issue time will be: +.sp +.nf +\f3Calendar c = new GregorianCalendar();\fP +.fi +.nf +\f3c\&.add(Calendar\&.YEAR, \-1);\fP +.fi +.nf +\f3c\&.add(Calendar\&.MONTH, 1);\fP +.fi +.nf +\f3c\&.add(Calendar\&.DATE, \-1);\fP +.fi +.nf +\f3return c\&.getTime()\fP +.fi +.nf +\f3\fP +.fi +.sp + + +With the second form, the user sets the exact issue time in two parts, year/month/day and hour:minute:second (using the local time zone)\&. The user can provide only one part, which means the other part is the same as the current date (or time)\&. The user must provide the exact number of digits as shown in the format definition (padding with 0 when shorter)\&. When both the date and time are provided, there is one (and only one) space character between the two parts\&. The hour should always be provided in 24 hour format\&. + +When the option is not provided, the start date is the current time\&. The option can be provided at most once\&. + +The value of \f3valDays\fR specifies the number of days (starting at the date specified by \f3-startdate\fR, or the current date when \f3-startdate\fR is not specified) for which the certificate should be considered valid\&. + +This command was named \f3-genkey\fR in earlier releases\&. The old name is still supported in this release\&. The new name, \f3-genkeypair\fR, is preferred going forward\&. +.TP +-genseckey +.sp +.nf +\f3{\-alias \fIalias\fR} {\-keyalg \fIkeyalg\fR} {\-keysize \fIkeysize\fR} [\-keypass \fIkeypass\fR]\fP +.fi +.sp +.sp +.nf +\f3{\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}} {\-v}\fP +.fi +.sp +.sp +.nf +\f3{\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Generates a secret key and stores it in a new \f3KeyStore\&.SecretKeyEntry\fR identified by \f3alias\fR\&. + +The value of \f3keyalg\fR specifies the algorithm to be used to generate the secret key, and the value of \f3keysize\fR specifies the size of the key to be generated\&. The \f3keypass\fR value is a password that protects the secret key\&. If no password is provided, then the user is prompted for it\&. If you press the Return key at the prompt, then the key password is set to the same password that is used for the \f3keystore\fR\&. The \f3keypass\fR value must be at least 6 characters\&. +.TP +-importcert +.sp +.nf +\f3{\-alias \fIalias\fR} {\-file \fIcert_file\fR} [\-keypass \fIkeypass\fR] {\-noprompt} {\-trustcacerts}\fP +.fi +.sp +.sp +.nf +\f3{\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP +.fi +.sp +.sp +.nf +\f3{\-providerName \fIprovider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-v} {\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Reads the certificate or certificate chain (where the latter is supplied in a PKCS#7 formatted reply or a sequence of X\&.509 certificates) from the file \f3cert_file\fR, and stores it in the \f3keystore\fR entry identified by \f3alias\fR\&. If no file is specified, then the certificate or certificate chain is read from \f3stdin\fR\&. + +The \f3keytool\fR command can import X\&.509 v1, v2, and v3 certificates, and PKCS#7 formatted certificate chains consisting of certificates of that type\&. The data to be imported must be provided either in binary encoding format or in printable encoding format (also known as Base64 encoding) as defined by the Internet RFC 1421 standard\&. In the latter case, the encoding must be bounded at the beginning by a string that starts with \f3-\fR\f3----BEGIN\fR, and bounded at the end by a string that starts with \f3-----END\fR\&. + +You import a certificate for two reasons: To add it to the list of trusted certificates, and to import a certificate reply received from a certificate authority (CA) as the result of submitting a Certificate Signing Request to that CA (see the \f3-certreq\fR option in Commands)\&. + +Which type of import is intended is indicated by the value of the \f3-alias\fR option\&. If the alias does not point to a key entry, then the \f3keytool\fR command assumes you are adding a trusted certificate entry\&. In this case, the alias should not already exist in the keystore\&. If the alias does already exist, then the \f3keytool\fR command outputs an error because there is already a trusted certificate for that alias, and does not import the certificate\&. If the alias points to a key entry, then the \f3keytool\fR command assumes you are importing a certificate reply\&. +.TP +-importpassword +.sp +.nf +\f3{\-alias \fIalias\fR} [\-keypass \fIkeypass\fR] {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-storepass \fIstorepass\fR]\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-v} {\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Imports a passphrase and stores it in a new \f3KeyStore\&.SecretKeyEntry\fR identified by \f3alias\fR\&. The passphrase may be supplied via the standard input stream; otherwise the user is prompted for it\&. \f3keypass\fR is a password used to protect the imported passphrase\&. If no password is provided, the user is prompted for it\&. If you press the Return key at the prompt, the key password is set to the same password as that used for the \f3keystore\fR\&. \f3keypass\fR must be at least 6 characters long\&. +.TP +-importkeystore +.sp +.nf +\f3{\-srcstoretype \fIsrcstoretype\fR} {\-deststoretype \fIdeststoretype\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-srcstorepass \fIsrcstorepass\fR] [\-deststorepass \fIdeststorepass\fR] {\-srcprotected}\fP +.fi +.sp +.sp +.nf +\f3{\-destprotected} \fP +.fi +.sp +.sp +.nf +\f3{\-srcalias \fIsrcalias\fR {\-destalias \fIdestalias\fR} [\-srckeypass \fIsrckeypass\fR]} \fP +.fi +.sp +.sp +.nf +\f3[\-destkeypass \fIdestkeypass\fR] {\-noprompt}\fP +.fi +.sp +.sp +.nf +\f3{\-srcProviderName \fIsrc_provider_name\fR} {\-destProviderName \fIdest_provider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}} {\-v}\fP +.fi +.sp +.sp +.nf +\f3{\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Imports a single entry or all entries from a source keystore to a destination keystore\&. + +When the \f3-srcalias\fR option is provided, the command imports the single entry identified by the alias to the destination keystore\&. If a destination alias is not provided with \f3destalias\fR, then \f3srcalias\fR is used as the destination alias\&. If the source entry is protected by a password, then \f3srckeypass\fR is used to recover the entry\&. If \fIsrckeypass\fR is not provided, then the \f3keytool\fR command attempts to use \f3srcstorepass\fR to recover the entry\&. If \f3srcstorepass\fR is either not provided or is incorrect, then the user is prompted for a password\&. The destination entry is protected with \f3destkeypass\fR\&. If \f3destkeypass\fR is not provided, then the destination entry is protected with the source entry password\&. For example, most third-party tools require \f3storepass\fR and \f3keypass\fR in a PKCS #12 keystore to be the same\&. In order to create a PKCS #12 keystore for these tools, always specify a \f3-destkeypass\fR to be the same as \f3-deststorepass\fR\&. + +If the \f3-srcalias\fR option is not provided, then all entries in the source keystore are imported into the destination keystore\&. Each destination entry is stored under the alias from the source entry\&. If the source entry is protected by a password, then \f3srcstorepass\fR is used to recover the entry\&. If \f3srcstorepass\fR is either not provided or is incorrect, then the user is prompted for a password\&. If a source keystore entry type is not supported in the destination keystore, or if an error occurs while storing an entry into the destination keystore, then the user is prompted whether to skip the entry and continue or to quit\&. The destination entry is protected with the source entry password\&. + +If the destination alias already exists in the destination keystore, then the user is prompted to either overwrite the entry or to create a new entry under a different alias name\&. + +If the \f3-noprompt\fR option is provided, then the user is not prompted for a new destination alias\&. Existing entries are overwritten with the destination alias name\&. Entries that cannot be imported are skipped and a warning is displayed\&. +.TP +-printcertreq +.sp +.nf +\f3{\-file \fIfile\fR}\fP +.fi +.sp + + +Prints the content of a PKCS #10 format certificate request, which can be generated by the \f3keytool\fR\f3-certreq\fR command\&. The command reads the request from file\&. If there is no file, then the request is read from the standard input\&. +.TP +-certreq +.sp +.nf +\f3{\-alias \fIalias\fR} {\-dname \fIdname\fR} {\-sigalg \fIsigalg\fR} {\-file \fIcertreq_file\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-keypass \fIkeypass\fR] {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-v} {\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Generates a Certificate Signing Request (CSR) using the PKCS #10 format\&. + +A CSR is intended to be sent to a certificate authority (CA)\&. The CA authenticates the certificate requestor (usually off-line) and will return a certificate or certificate chain, used to replace the existing certificate chain (which initially consists of a self-signed certificate) in the keystore\&. + +The private key associated with alias is used to create the PKCS #10 certificate request\&. To access the private key, the correct password must be provided\&. If \f3keypass\fR is not provided at the command line and is different from the password used to protect the integrity of the keystore, then the user is prompted for it\&. If \f3dname\fR is provided, then it is used as the subject in the CSR\&. Otherwise, the X\&.500 Distinguished Name associated with alias is used\&. + +The \f3sigalg\fR value specifies the algorithm that should be used to sign the CSR\&. + +The CSR is stored in the file certreq_file\&. If no file is specified, then the CSR is output to \f3stdout\fR\&. + +Use the \f3importcert\fR command to import the response from the CA\&. +.TP +-exportcert +.sp +.nf +\f3{\-alias \fIalias\fR} {\-file \fIcert_file\fR} {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-rfc} {\-v} {\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Reads from the keystore the certificate associated with \fIalias\fR and stores it in the cert_file file\&. When no file is specified, the certificate is output to \f3stdout\fR\&. + +The certificate is by default output in binary encoding\&. If the \f3-rfc\fR option is specified, then the output in the printable encoding format defined by the Internet RFC 1421 Certificate Encoding Standard\&. + +If \f3alias\fR refers to a trusted certificate, then that certificate is output\&. Otherwise, \f3alias\fR refers to a key entry with an associated certificate chain\&. In that case, the first certificate in the chain is returned\&. This certificate authenticates the public key of the entity addressed by \f3alias\fR\&. + +This command was named \f3-export\fR in earlier releases\&. The old name is still supported in this release\&. The new name, \f3-exportcert\fR, is preferred going forward\&. +.TP +-list +.sp +.nf +\f3{\-alias \fIalias\fR} {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP +.fi +.sp +.sp +.nf +\f3{\-providerName \fIprovider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-v | \-rfc} {\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Prints to \f3stdout\fR the contents of the keystore entry identified by \f3alias\fR\&. If no \f3alias\fR is specified, then the contents of the entire keystore are printed\&. + +This command by default prints the SHA1 fingerprint of a certificate\&. If the \f3-v\fR option is specified, then the certificate is printed in human-readable format, with additional information such as the owner, issuer, serial number, and any extensions\&. If the \f3-rfc\fR option is specified, then the certificate contents are printed using the printable encoding format, as defined by the Internet RFC 1421 Certificate Encoding Standard\&. + +You cannot specify both \f3-v\fR and \f3-rfc\fR\&. +.TP +-printcert +.sp +.nf +\f3{\-file \fIcert_file\fR | \-sslserver \fIhost\fR[:\fIport\fR]} {\-jarfile \fIJAR_file\fR {\-rfc} {\-v}\fP +.fi +.sp +.sp +.nf +\f3{\-Jjavaoption}\fP +.fi +.sp + + +Reads the certificate from the file cert_file, the SSL server located at host:port, or the signed JAR file \f3JAR_file\fR (with the \f3-jarfile\fR option and prints its contents in a human-readable format\&. When no port is specified, the standard HTTPS port 443 is assumed\&. Note that \f3-sslserver\fR and -file options cannot be provided at the same time\&. Otherwise, an error is reported\&. If neither option is specified, then the certificate is read from \f3stdin\fR\&. + +When\f3-rfc\fR is specified, the \f3keytool\fR command prints the certificate in PEM mode as defined by the Internet RFC 1421 Certificate Encoding standard\&. See Internet RFC 1421 Certificate Encoding Standard\&. + +If the certificate is read from a file or \f3stdin\fR, then it might be either binary encoded or in printable encoding format, as defined by the RFC 1421 Certificate Encoding standard\&. + +If the SSL server is behind a firewall, then the \f3-J-Dhttps\&.proxyHost=proxyhost\fR and \f3-J-Dhttps\&.proxyPort=proxyport\fR options can be specified on the command line for proxy tunneling\&. See Java Secure Socket Extension (JSSE) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide\&.html + +\fINote:\fR This option can be used independently of a keystore\&. +.TP +-printcrl +.sp +.nf +\f3\-file \fIcrl_\fR {\-v}\fP +.fi +.sp + + +Reads the Certificate Revocation List (CRL) from the file \f3crl_\fR\&. A CRL is a list of digital certificates that were revoked by the CA that issued them\&. The CA generates the \f3crl_\fR file\&. + +\fINote:\fR This option can be used independently of a keystore\&. +.TP +-storepasswd +.sp +.nf +\f3[\-new \fInew_storepass\fR] {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-v} {\-Jjavaoption}\fP +.fi +.sp + + +Changes the password used to protect the integrity of the keystore contents\&. The new password is \f3new_storepass\fR, which must be at least 6 characters\&. +.TP +-keypasswd +.sp +.nf +\f3{\-alias \fIalias\fR} [\-keypass \fIold_keypass\fR] [\-new \fInew_keypass\fR] {\-storetype \fIstoretype\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}} {\-v}\fP +.fi +.sp +.sp +.nf +\f3{\-Jjavaoption}\fP +.fi +.sp + + +Changes the password under which the private/secret key identified by \f3alias\fR is protected, from \f3old_keypass\fR to \f3new_keypass\fR, which must be at least 6 characters\&. + +If the \f3-keypass\fR option is not provided at the command line, and the key password is different from the keystore password, then the user is prompted for it\&. + +If the \f3-new\fR option is not provided at the command line, then the user is prompted for it +.TP +-delete +.sp +.nf +\f3[\-alias \fIalias\fR] {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP +.fi +.sp +.sp +.nf +\f3{\-providerName \fIprovider_name\fR} \fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-v} {\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Deletes from the keystore the entry identified by \f3alias\fR\&. The user is prompted for the alias, when no alias is provided at the command line\&. +.TP +-changealias +.sp +.nf +\f3{\-alias \fIalias\fR} [\-destalias \fIdestalias\fR] [\-keypass \fIkeypass\fR] {\-storetype \fIstoretype\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}} {\-v}\fP +.fi +.sp +.sp +.nf +\f3{\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Move an existing keystore entry from the specified \f3alias\fR to a new alias, \f3destalias\fR\&. If no destination alias is provided, then the command prompts for one\&. If the original entry is protected with an entry password, then the password can be supplied with the \f3-keypass\fR option\&. If no key password is provided, then the \f3storepass\fR (if provided) is attempted first\&. If the attempt fails, then the user is prompted for a password\&. +.TP +-help +.br +Lists the basic commands and their options\&. + +For more information about a specific command, enter the following, where \f3command_name\fR is the name of the command: \f3keytool -command_name -help\fR\&. +.SH EXAMPLES +This example walks through the sequence of steps to create a keystore for managing public/private key pair and certificates from trusted entities\&. +.SS GENERATE\ THE\ KEY\ PAIR +First, create a keystore and generate the key pair\&. You can use a command such as the following typed as a single line: +.sp +.nf +\f3keytool \-genkeypair \-dname "cn=Mark Jones, ou=Java, o=Oracle, c=US"\fP +.fi +.nf +\f3 \-alias business \-keypass <new password for private key>\fP +.fi +.nf +\f3 \-keystore /working/mykeystore\fP +.fi +.nf +\f3 \-storepass <new password for keystore> \-validity 180\fP +.fi +.nf +\f3\fP +.fi +.sp +The command creates the keystore named \f3mykeystore\fR in the working directory (assuming it does not already exist), and assigns it the password specified by \f3<new password for keystore>\fR\&. It generates a public/private key pair for the entity whose distinguished name has a common name of Mark Jones, organizational unit of Java, organization of Oracle and two-letter country code of US\&. It uses the default DSA key generation algorithm to create the keys; both are 1024 bits\&. +.PP +The command uses the default SHA1withDSA signature algorithm to create a self-signed certificate that includes the public key and the distinguished name information\&. The certificate is valid for 180 days, and is associated with the private key in a keystore entry referred to by the alias \f3business\fR\&. The private key is assigned the password specified by \f3<new password for private key>\fR\&. +.PP +The command is significantly shorter when the option defaults are accepted\&. In this case, no options are required, and the defaults are used for unspecified options that have default values\&. You are prompted for any required values\&. You could have the following: +.sp +.nf +\f3keytool \-genkeypair\fP +.fi +.nf +\f3\fP +.fi +.sp +In this case, a keystore entry with the alias \f3mykey\fR is created, with a newly generated key pair and a certificate that is valid for 90 days\&. This entry is placed in the keystore named \f3\&.keystore\fR in your home directory\&. The keystore is created when it does not already exist\&. You are prompted for the distinguished name information, the keystore password, and the private key password\&. +.PP +The rest of the examples assume you executed the \f3-genkeypair\fR command without options specified, and that you responded to the prompts with values equal to those specified in the first \f3-genkeypair\fR command\&. For example, a distinguished name of \f3cn=Mark Jones\fR, \f3ou=Java\fR, \f3o=Oracle\fR, \f3c=US\fR)\&. +.SS REQUEST\ A\ SIGNED\ CERTIFICATE\ FROM\ A\ CA +Generating the key pair created a self-signed certificate\&. A certificate is more likely to be trusted by others when it is signed by a Certification Authority (CA)\&. To get a CA signature, first generate a Certificate Signing Request (CSR), as follows: +.sp +.nf +\f3keytool \-certreq \-file MarkJ\&.csr\fP +.fi +.nf +\f3\fP +.fi +.sp +This creates a CSR for the entity identified by the default alias \f3mykey\fR and puts the request in the file named MarkJ\&.csr\&. Submit this file to a CA, such as VeriSign\&. The CA authenticates you, the requestor (usually off-line), and returns a certificate, signed by them, authenticating your public key\&. In some cases, the CA returns a chain of certificates, each one authenticating the public key of the signer of the previous certificate in the chain\&. +.SS IMPORT\ A\ CERTIFICATE\ FOR\ THE\ CA +You now need to replace the self-signed certificate with a certificate chain, where each certificate in the chain authenticates the public key of the signer of the previous certificate in the chain, up to a root CA\&. +.PP +Before you import the certificate reply from a CA, you need one or more trusted certificates in your keystore or in the \f3cacerts\fR keystore file\&. See \f3-importcert\fR in Commands\&. +.TP 0.2i +\(bu +If the certificate reply is a certificate chain, then you need the top certificate of the chain\&. The root CA certificate that authenticates the public key of the CA\&. +.TP 0.2i +\(bu +If the certificate reply is a single certificate, then you need a certificate for the issuing CA (the one that signed it)\&. If that certificate is not self-signed, then you need a certificate for its signer, and so on, up to a self-signed root CA certificate\&. +.PP +The \f3cacerts\fR keystore file ships with several VeriSign root CA certificates, so you probably will not need to import a VeriSign certificate as a trusted certificate in your keystore\&. But if you request a signed certificate from a different CA, and a certificate authenticating that CA\&'s public key was not added to \f3cacerts\fR, then you must import a certificate from the CA as a trusted certificate\&. +.PP +A certificate from a CA is usually either self-signed or signed by another CA, in which case you need a certificate that authenticates that CA\&'s public key\&. Suppose company ABC, Inc\&., is a CA, and you obtain a file named A\f3BCCA\&.cer\fR that is supposed to be a self-signed certificate from ABC, that authenticates that CA\&'s public key\&. Be careful to ensure the certificate is valid before you import it as a trusted certificate\&. View it first with the \f3keytool -printcert\fR command or the \f3keytool -importcert\fR command without the \f3-noprompt\fR option, and make sure that the displayed certificate fingerprints match the expected ones\&. You can call the person who sent the certificate, and compare the fingerprints that you see with the ones that they show or that a secure public key repository shows\&. Only when the fingerprints are equal is it guaranteed that the certificate was not replaced in transit with somebody else\&'s (for example, an attacker\&'s) certificate\&. If such an attack takes place, and you did not check the certificate before you imported it, then you would be trusting anything the attacker has signed\&. +.PP +If you trust that the certificate is valid, then you can add it to your keystore with the following command: +.sp +.nf +\f3keytool \-importcert \-alias abc \-file ABCCA\&.cer\fP +.fi +.nf +\f3\fP +.fi +.sp +This command creates a trusted certificate entry in the keystore, with the data from the file ABCCA\&.cer, and assigns the alias \f3abc\fR to the entry\&. +.SS IMPORT\ THE\ CERTIFICATE\ REPLY\ FROM\ THE\ CA +After you import a certificate that authenticates the public key of the CA you submitted your certificate signing request to (or there is already such a certificate in the cacerts file), you can import the certificate reply and replace your self-signed certificate with a certificate chain\&. This chain is the one returned by the CA in response to your request (when the CA reply is a chain), or one constructed (when the CA reply is a single certificate) using the certificate reply and trusted certificates that are already available in the keystore where you import the reply or in the \f3cacerts\fR keystore file\&. +.PP +For example, if you sent your certificate signing request to VeriSign, then you can import the reply with the following, which assumes the returned certificate is named VSMarkJ\&.cer: +.sp +.nf +\f3keytool \-importcert \-trustcacerts \-file VSMarkJ\&.cer\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS EXPORT\ A\ CERTIFICATE\ THAT\ AUTHENTICATES\ THE\ PUBLIC\ KEY +If you used the \f3jarsigner\fR command to sign a Java Archive (JAR) file, then clients that want to use the file will want to authenticate your signature\&. One way the clients can authenticate you is by first importing your public key certificate into their keystore as a trusted entry\&. +.PP +You can export the certificate and supply it to your clients\&. As an example, you can copy your certificate to a file named MJ\&.cer with the following command that assumes the entry has an alias of \f3mykey\fR: +.sp +.nf +\f3keytool \-exportcert \-alias mykey \-file MJ\&.cer\fP +.fi +.nf +\f3\fP +.fi +.sp +With the certificate and the signed JAR file, a client can use the \f3jarsigner\fR command to authenticate your signature\&. +.SS IMPORT\ KEYSTORE +The command \f3importkeystore\fR is used to import an entire keystore into another keystore, which means all entries from the source keystore, including keys and certificates, are all imported to the destination keystore within a single command\&. You can use this command to import entries from a different type of keystore\&. During the import, all new entries in the destination keystore will have the same alias names and protection passwords (for secret keys and private keys)\&. If the \f3keytool\fR command cannot recover the private keys or secret keys from the source keystore, then it prompts you for a password\&. If it detects alias duplication, then it asks you for a new alias, and you can specify a new alias or simply allow the \f3keytool\fR command to overwrite the existing one\&. +.PP +For example, to import entries from a typical JKS type keystore key\&.jks into a PKCS #11 type hardware-based keystore, use the command: +.sp +.nf +\f3keytool \-importkeystore\fP +.fi +.nf +\f3 \-srckeystore key\&.jks \-destkeystore NONE\fP +.fi +.nf +\f3 \-srcstoretype JKS \-deststoretype PKCS11\fP +.fi +.nf +\f3 \-srcstorepass <src keystore password>\fP +.fi +.nf +\f3 \-deststorepass <destination keystore pwd>\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3importkeystore\fR command can also be used to import a single entry from a source keystore to a destination keystore\&. In this case, besides the options you see in the previous example, you need to specify the alias you want to import\&. With the \f3-srcalias\fR option specified, you can also specify the destination alias name in the command line, as well as protection password for a secret/private key and the destination protection password you want\&. The following command demonstrates this: +.sp +.nf +\f3keytool \-importkeystore\fP +.fi +.nf +\f3 \-srckeystore key\&.jks \-destkeystore NONE\fP +.fi +.nf +\f3 \-srcstoretype JKS \-deststoretype PKCS11\fP +.fi +.nf +\f3 \-srcstorepass <src keystore password>\fP +.fi +.nf +\f3 \-deststorepass <destination keystore pwd>\fP +.fi +.nf +\f3 \-srcalias myprivatekey \-destalias myoldprivatekey\fP +.fi +.nf +\f3 \-srckeypass <source entry password>\fP +.fi +.nf +\f3 \-destkeypass <destination entry password>\fP +.fi +.nf +\f3 \-noprompt\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS GENERATE\ CERTIFICATES\ FOR\ AN\ SSL\ SERVER +The following are \f3keytool\fR commands to generate key pairs and certificates for three entities: Root CA (\f3root\fR), Intermediate CA (\f3ca\fR), and SSL server (\f3server\fR)\&. Ensure that you store all the certificates in the same keystore\&. In these examples, RSA is the recommended the key algorithm\&. +.sp +.nf +\f3keytool \-genkeypair \-keystore root\&.jks \-alias root \-ext bc:c\fP +.fi +.nf +\f3keytool \-genkeypair \-keystore ca\&.jks \-alias ca \-ext bc:c\fP +.fi +.nf +\f3keytool \-genkeypair \-keystore server\&.jks \-alias server\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3keytool \-keystore root\&.jks \-alias root \-exportcert \-rfc > root\&.pem\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3keytool \-storepass <storepass> \-keystore ca\&.jks \-certreq \-alias ca |\fP +.fi +.nf +\f3 keytool \-storepass <storepass> \-keystore root\&.jks\fP +.fi +.nf +\f3 \-gencert \-alias root \-ext BC=0 \-rfc > ca\&.pem\fP +.fi +.nf +\f3keytool \-keystore ca\&.jks \-importcert \-alias ca \-file ca\&.pem\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3keytool \-storepass <storepass> \-keystore server\&.jks \-certreq \-alias server |\fP +.fi +.nf +\f3 keytool \-storepass <storepass> \-keystore ca\&.jks \-gencert \-alias ca\fP +.fi +.nf +\f3 \-ext ku:c=dig,kE \-rfc > server\&.pem\fP +.fi +.nf +\f3cat root\&.pem ca\&.pem server\&.pem |\fP +.fi +.nf +\f3 keytool \-keystore server\&.jks \-importcert \-alias server\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH TERMS +.TP +Keystore +A keystore is a storage facility for cryptographic keys and certificates\&. +.TP +Keystore entries +Keystores can have different types of entries\&. The two most applicable entry types for the \f3keytool\fR command include the following: + +\fIKey entries\fR: Each entry holds very sensitive cryptographic key information, which is stored in a protected format to prevent unauthorized access\&. Typically, a key stored in this type of entry is a secret key, or a private key accompanied by the certificate chain for the corresponding public key\&. See Certificate Chains\&. The \f3keytool\fR command can handle both types of entries, while the \f3jarsigner\fR tool only handles the latter type of entry, that is private keys and their associated certificate chains\&. + +\fITrusted certificate entries\fR: Each entry contains a single public key certificate that belongs to another party\&. The entry is called a trusted certificate because the keystore owner trusts that the public key in the certificate belongs to the identity identified by the subject (owner) of the certificate\&. The issuer of the certificate vouches for this, by signing the certificate\&. +.TP +KeyStore aliases +All keystore entries (key and trusted certificate entries) are accessed by way of unique aliases\&. + +An alias is specified when you add an entity to the keystore with the \f3-genseckey\fR command to generate a secret key, the \f3-genkeypair\fR command to generate a key pair (public and private key), or the \f3-importcert\fR command to add a certificate or certificate chain to the list of trusted certificates\&. Subsequent \f3keytool\fR commands must use this same alias to refer to the entity\&. + +For example, you can use the alias \f3duke\fR to generate a new public/private key pair and wrap the public key into a self-signed certificate with the following command\&. See Certificate Chains\&. +.sp +.nf +\f3keytool \-genkeypair \-alias duke \-keypass dukekeypasswd\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This example specifies an initial password of \f3dukekeypasswd\fR required by subsequent commands to access the private key associated with the alias \f3duke\fR\&. If you later want to change Duke\&'s private key password, use a command such as the following: +.sp +.nf +\f3keytool \-keypasswd \-alias duke \-keypass dukekeypasswd \-new newpass\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This changes the password from \f3dukekeypasswd\fR to \f3newpass\fR\&. A password should not be specified on a command line or in a script unless it is for testing purposes, or you are on a secure system\&. If you do not specify a required password option on a command line, then you are prompted for it\&. +.TP +KeyStore implementation +The \f3KeyStore\fR class provided in the \f3java\&.security\fR 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 type of keystore\&. + +Currently, two command-line tools (\f3keytool\fR and \f3jarsigner\fR) and a GUI-based tool named Policy Tool make use of keystore implementations\&. Because the \f3KeyStore\fR class is \f3public\fR, users can write additional security applications that use it\&. + +There is a built-in default implementation, provided by Oracle\&. It implements the keystore as a file with a proprietary keystore type (format) named JKS\&. It protects each private key with its individual password, and also protects the integrity of the entire keystore with a (possibly different) password\&. + +Keystore implementations are provider-based\&. More specifically, the application interfaces supplied by \f3KeyStore\fR are implemented in terms of a Service Provider Interface (SPI)\&. That is, there is a corresponding abstract \f3KeystoreSpi\fR class, also in the \f3java\&.security package\fR, which defines the Service Provider Interface methods that providers must implement\&. The term \fIprovider\fR refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API\&. To provide a keystore implementation, clients must implement a provider and supply a \f3KeystoreSpi\fR subclass implementation, as described in How to Implement a Provider in the Java Cryptography Architecture at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/HowToImplAProvider\&.html + +Applications can choose different types of keystore implementations from different providers, using the \f3getInstance\fR factory method supplied in the \f3KeyStore\fR class\&. A keystore type defines the storage and data format of the keystore information, and the algorithms used to protect private/secret keys in the keystore and the integrity of the keystore\&. Keystore implementations of different types are not compatible\&. + +The \f3keytool\fR command works on any file-based keystore implementation\&. It treats the keystore location that is passed to it at the command line as a file name and converts it to a \f3FileInputStream\fR, from which it loads the keystore information\&.)The \f3jarsigner\fR and \f3policytool\fR commands can read a keystore from any location that can be specified with a URL\&. + +For \f3keytool\fR and \f3jarsigner\fR, you can specify a keystore type at the command line, with the \f3-storetype\fR option\&. For Policy Tool, you can specify a keystore type with the \fIKeystore\fR menu\&. + +If you do not explicitly specify a keystore type, then the tools choose a keystore implementation based on the value of the \f3keystore\&.type\fR property specified in the security properties file\&. The security properties file is called \f3java\&.security\fR, and resides in the security properties directory, \f3java\&.home\elib\esecurity\fR on Windows and \f3java\&.home/lib/security\fR on Oracle Solaris, where \f3java\&.home\fR is the runtime environment directory\&. The \f3jre\fR directory in the SDK or the top-level directory of the Java Runtime Environment (JRE)\&. + +Each tool gets the \f3keystore\&.type\fR value and then examines all the currently installed providers until it finds one that implements a keystores of that type\&. It then uses the keystore implementation from that provider\&.The \f3KeyStore\fR class defines a static method named \f3getDefaultType\fR that lets applications and applets retrieve the value of the \f3keystore\&.type\fR property\&. The following line of code creates an instance of the default keystore type as specified in the \f3keystore\&.type\fR property: +.sp +.nf +\f3KeyStore keyStore = KeyStore\&.getInstance(KeyStore\&.getDefaultType());\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The default keystore type is \f3jks\fR, which is the proprietary type of the keystore implementation provided by Oracle\&. This is specified by the following line in the security properties file: +.sp +.nf +\f3keystore\&.type=jks\fP +.fi +.nf +\f3\fP +.fi +.sp + + +To have the tools utilize a keystore implementation other than the default, you can change that line to specify a different keystore type\&. For example, if you have a provider package that supplies a keystore implementation for a keystore type called \f3pkcs12\fR, then change the line to the following: +.sp +.nf +\f3keystore\&.type=pkcs12\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fINote:\fR Case does not matter in keystore type designations\&. For example, JKS would be considered the same as jks\&. +.TP +Certificate +A certificate (or public-key certificate) is a digitally signed statement from one entity (the issuer), saying that the public key and some other information of another entity (the subject) has some specific value\&. The following terms are related to certificates: + +\fIPublic Keys\fR: These are numbers associated with a particular entity, and are intended to be known to everyone who needs to have trusted interactions with that entity\&. Public keys are used to verify signatures\&. + +\fIDigitally Signed\fR: If some data is digitally signed, then it is stored with the identity of an entity and a signature that proves that entity knows about the data\&. The data is rendered unforgeable by signing with the entity\&'s private key\&. + +\fIIdentity\fR: A known way of addressing an entity\&. In some systems, the identity is the public key, and in others it can be anything from an Oracle Solaris UID to an email address to an X\&.509 distinguished name\&. + +\fISignature\fR: A signature is computed over some data using the private key of an entity\&. The signer, which in the case of a certificate is also known as the issuer\&. + +\fIPrivate Keys\fR: These are numbers, each of which is supposed to be known only to the particular entity whose private key it is (that is, it is supposed to be kept secret)\&. Private and public keys exist in pairs in all public key cryptography systems (also referred to as public key crypto systems)\&. In a typical public key crypto system, such as DSA, a private key corresponds to exactly one public key\&. Private keys are used to compute signatures\&. + +\fIEntity\fR: An entity is a person, organization, program, computer, business, bank, or something else you are trusting to some degree\&. + +Public key cryptography requires access to users\&' public keys\&. In a large-scale networked environment, it is impossible to guarantee that prior relationships between communicating entities were established or that a trusted repository exists with all used public keys\&. Certificates were invented as a solution to this public key distribution problem\&. Now a Certification Authority (CA) can act as a trusted third party\&. CAs are entities such as businesses that are trusted to sign (issue) certificates for other entities\&. It is assumed that CAs only create valid and reliable certificates because they are bound by legal agreements\&. There are many public Certification Authorities, such as VeriSign, Thawte, Entrust, and so on\&. + +You can also run your own Certification Authority using products such as Microsoft Certificate Server or the Entrust CA product for your organization\&. With the \f3keytool\fR command, it is possible to display, import, and export certificates\&. It is also possible to generate self-signed certificates\&. + +The \f3keytool\fR command currently handles X\&.509 certificates\&. +.TP +X\&.509 Certificates +The X\&.509 standard defines what information can go into a certificate and describes how to write it down (the data format)\&. All the data in a certificate is encoded with two related standards called ASN\&.1/DER\&. Abstract Syntax Notation 1 describes data\&. The Definite Encoding Rules describe a single way to store and transfer that data\&. + +All X\&.509 certificates have the following data, in addition to the signature: + +\fIVersion\fR: This identifies which version of the X\&.509 standard applies to this certificate, which affects what information can be specified in it\&. Thus far, three versions are defined\&. The \f3keytool\fR command can import and export v1, v2, and v3 certificates\&. It generates v3 certificates\&. + +X\&.509 Version 1 has been available since 1988, is widely deployed, and is the most generic\&. + +X\&.509 Version 2 introduced the concept of subject and issuer unique identifiers to handle the possibility of reuse of subject or issuer names over time\&. Most certificate profile documents strongly recommend that names not be reused and that certificates should not make use of unique identifiers\&. Version 2 certificates are not widely used\&. + +X\&.509 Version 3 is the most recent (1996) and supports the notion of extensions where anyone can define an extension and include it in the certificate\&. Some common extensions are: KeyUsage (limits the use of the keys to particular purposes such as \f3signing-only\fR) and AlternativeNames (allows other identities to also be associated with this public key, for example\&. DNS names, email addresses, IP addresses)\&. Extensions can be marked critical to indicate that the extension should be checked and enforced or used\&. For example, if a certificate has the KeyUsage extension marked critical and set to \f3keyCertSign\fR, then when this certificate is presented during SSL communication, it should be rejected because the certificate extension indicates that the associated private key should only be used for signing certificates and not for SSL use\&. + +\fISerial number\fR: The entity that created the certificate is responsible for assigning it a serial number to distinguish it from other certificates it issues\&. This information is used in numerous ways\&. For example, when a certificate is revoked its serial number is placed in a Certificate Revocation List (CRL)\&. + +\fISignature algorithm identifier\fR: This identifies the algorithm used by the CA to sign the certificate\&. + +\fIIssuer name\fR: The X\&.500 Distinguished Name of the entity that signed the certificate\&. See X\&.500 Distinguished Names\&. This is typically a CA\&. Using this certificate implies trusting the entity that signed this certificate\&. In some cases, such as root or top-level CA certificates, the issuer signs its own certificate\&. + +\fIValidity period\fR: Each certificate is valid only for a limited amount of time\&. This period is described by a start date and time and an end date and time, and can be as short as a few seconds or almost as long as a century\&. The validity period chosen depends on a number of factors, such as the strength of the private key used to sign the certificate, or the amount one is willing to pay for a certificate\&. This is the expected period that entities can rely on the public value, when the associated private key has not been compromised\&. + +\fISubject name\fR: The name of the entity whose public key the certificate identifies\&. This name uses the X\&.500 standard, so it is intended to be unique across the Internet\&. This is the X\&.500 Distinguished Name (DN) of the entity\&. See X\&.500 Distinguished Names\&. For example, +.sp +.nf +\f3CN=Java Duke, OU=Java Software Division, O=Oracle Corporation, C=US\fP +.fi +.nf +\f3\fP +.fi +.sp + + +These refer to the subject\&'s common name (CN), organizational unit (OU), organization (O), and country (C)\&. + +\fISubject public key information\fR: This is the public key of the entity being named with an algorithm identifier that specifies which public key crypto system this key belongs to and any associated key parameters\&. +.TP +Certificate Chains +The \f3keytool\fR command can create and manage keystore key entries that each contain a private key and an associated certificate chain\&. The first certificate in the chain contains the public key that corresponds to the private key\&. + +When keys are first generated, the chain starts off containing a single element, a self-signed certificate\&. See \f3-genkeypair\fR in Commands\&. A self-signed certificate is one for which the issuer (signer) is the same as the subject\&. The subject is the entity whose public key is being authenticated by the certificate\&. Whenever the \f3-genkeypair\fR command is called to generate a new public/private key pair, it also wraps the public key into a self-signed certificate\&. + +Later, after a Certificate Signing Request (CSR) was generated with the \f3-certreq\fR command and sent to a Certification Authority (CA), the response from the CA is imported with \f3-importcert\fR, and the self-signed certificate is replaced by a chain of certificates\&. See the \f3-certreq\fR and \f3-importcert\fR options in Commands\&. At the bottom of the chain is the certificate (reply) issued by the CA authenticating the subject\&'s public key\&. The next certificate in the chain is one that authenticates the CA\&'s public key\&. + +In many cases, this is a self-signed certificate, which is a certificate from the CA authenticating its own public key, and the last certificate in the chain\&. In other cases, the CA might return a chain of certificates\&. In this case, the bottom certificate in the chain is the same (a certificate signed by the CA, authenticating the public key of the key entry), but the second certificate in the chain is a certificate signed by a different CA that authenticates the public key of the CA you sent the CSR to\&. The next certificate in the chain is a certificate that authenticates the second CA\&'s key, and so on, until a self-signed root certificate is reached\&. Each certificate in the chain (after the first) authenticates the public key of the signer of the previous certificate in the chain\&. + +Many CAs only return the issued certificate, with no supporting chain, especially when there is a flat hierarchy (no intermediates CAs)\&. In this case, the certificate chain must be established from trusted certificate information already stored in the keystore\&. + +A different reply format (defined by the PKCS #7 standard) includes the supporting certificate chain in addition to the issued certificate\&. Both reply formats can be handled by the \f3keytool\fR command\&. + +The top-level (root) CA certificate is self-signed\&. However, the trust into the root\&'s public key does not come from the root certificate itself, but from other sources such as a newspaper\&. This is because anybody could generate a self-signed certificate with the distinguished name of, for example, the VeriSign root CA\&. The root CA public key is widely known\&. The only reason it is stored in a certificate is because this is the format understood by most tools, so the certificate in this case is only used as a vehicle to transport the root CA\&'s public key\&. Before you add the root CA certificate to your keystore, you should view it with the \f3-printcert\fR option and compare the displayed fingerprint with the well-known fingerprint obtained from a newspaper, the root CA\&'s Web page, and so on\&. +.TP +The cacerts Certificates File +A certificates file named \f3cacerts\fR resides in the security properties directory, \f3java\&.home\elib\esecurity\fR on Windows and \f3java\&.home/lib/security\fR on Oracle Solaris, where \f3java\&.home\fR is the runtime environment\&'s directory, which would be the \f3jre\fR directory in the SDK or the top-level directory of the JRE\&. + +The \f3cacerts\fR file represents a system-wide keystore with CA certificates\&. System administrators can configure and manage that file with the \f3keytool\fR command by specifying \f3jks\fR as the keystore type\&. The \f3cacerts\fR keystore file ships with a default set of root CA certificates\&. You can list the default certificates with the following command: +.sp +.nf +\f3keytool \-list \-keystore java\&.home/lib/security/cacerts\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The initial password of the \f3cacerts\fR keystore file is \f3changeit\fR\&. System administrators should change that password and the default access permission of that file upon installing the SDK\&. + +\fINote:\fR It is important to verify your \f3cacerts\fR file\&. Because you trust the CAs in the \f3cacerts\fR file as entities for signing and issuing certificates to other entities, you must manage the \f3cacerts\fR file carefully\&. The \f3cacerts\fR file should contain only certificates of the CAs you trust\&. It is your responsibility to verify the trusted root CA certificates bundled in the \f3cacerts\fR file and make your own trust decisions\&. + +To remove an untrusted CA certificate from the \f3cacerts\fR file, use the \f3delete\fR option of the \f3keytool\fR command\&. You can find the \f3cacerts\fR file in the JRE installation directory\&. Contact your system administrator if you do not have permission to edit this file +.TP +Internet RFC 1421 Certificate Encoding Standard +Certificates are often stored using the printable encoding format defined by the Internet RFC 1421 standard, instead of their binary encoding\&. This certificate format, also known as Base64 encoding, makes it easy to export certificates to other applications by email or through some other mechanism\&. + +Certificates read by the \f3-importcert\fR and \f3-printcert\fR commands can be in either this format or binary encoded\&. The \f3-exportcert\fR command by default outputs a certificate in binary encoding, but will instead output a certificate in the printable encoding format, when the \f3-rfc\fR option is specified\&. + +The \f3-list\fR command by default prints the SHA1 fingerprint of a certificate\&. If the \f3-v\fR option is specified, then the certificate is printed in human-readable format\&. If the \f3-rfc\fR option is specified, then the certificate is output in the printable encoding format\&. + +In its printable encoding format, the encoded certificate is bounded at the beginning and end by the following text: +.sp +.nf +\f3\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3encoded certificate goes here\&. \fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-\-\-\-\-END CERTIFICATE\-\-\-\-\-\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +X\&.500 Distinguished Names +X\&.500 Distinguished Names are used to identify entities, such as those that are named by the \f3subject\fR and \f3issuer\fR (signer) fields of X\&.509 certificates\&. The \f3keytool\fR command supports the following subparts: + +\fIcommonName\fR: The common name of a person such as Susan Jones\&. + +\fIorganizationUnit\fR: The small organization (such as department or division) name\&. For example, Purchasing\&. + +\fIlocalityName\fR: The locality (city) name, for example, Palo Alto\&. + +\fIstateName\fR: State or province name, for example, California\&. + +\fIcountry\fR: Two-letter country code, for example, CH\&. + +When you supply a distinguished name string as the value of a \f3-dname\fR option, such as for the \f3-genkeypair\fR command, the string must be in the following format: +.sp +.nf +\f3CN=cName, OU=orgUnit, O=org, L=city, S=state, C=countryCode\fP +.fi +.nf +\f3\fP +.fi +.sp + + +All the italicized items represent actual values and the previous keywords are abbreviations for the following: +.sp +.nf +\f3CN=commonName\fP +.fi +.nf +\f3OU=organizationUnit\fP +.fi +.nf +\f3O=organizationName\fP +.fi +.nf +\f3L=localityName\fP +.fi +.nf +\f3S=stateName\fP +.fi +.nf +\f3C=country\fP +.fi +.nf +\f3\fP +.fi +.sp + + +A sample distinguished name string is: +.sp +.nf +\f3CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino, S=California, C=US\fP +.fi +.nf +\f3\fP +.fi +.sp + + +A sample command using such a string is: +.sp +.nf +\f3keytool \-genkeypair \-dname "CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino,\fP +.fi +.nf +\f3S=California, C=US" \-alias mark\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Case does not matter for the keyword abbreviations\&. For example, CN, cn, and Cn are all treated the same\&. + +Order matters; each subcomponent must appear in the designated order\&. However, it is not necessary to have all the subcomponents\&. You can use a subset, for example: +.sp +.nf +\f3CN=Steve Meier, OU=Java, O=Oracle, C=US\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If a distinguished name string value contains a comma, then the comma must be escaped by a backslash (\e) character when you specify the string on a command line, as in: +.sp +.nf +\f3cn=Peter Schuster, ou=Java\e, Product Development, o=Oracle, c=US\fP +.fi +.nf +\f3\fP +.fi +.sp + + +It is never necessary to specify a distinguished name string on a command line\&. When the distinguished name is needed for a command, but not supplied on the command line, the user is prompted for each of the subcomponents\&. In this case, a comma does not need to be escaped by a backslash (\e)\&. +.SH WARNINGS +.SS IMPORTING\ TRUSTED\ CERTIFICATES\ WARNING +\fIImportant\fR: Be sure to check a certificate very carefully before importing it as a trusted certificate\&. +.PP +Windows Example: + +View the certificate first with the \f3-printcert\fR command or the \f3-importcert\fR command without the \f3-noprompt\fR option\&. Ensure that the displayed certificate fingerprints match the expected ones\&. For example, suppose sends or emails you a certificate that you put it in a file named \f3\etmp\ecert\fR\&. Before you consider adding the certificate to your list of trusted certificates, you can execute a \f3-printcert\fR command to view its fingerprints, as follows: +.sp +.nf +\f3 keytool \-printcert \-file \etmp\ecert\fP +.fi +.nf +\f3 Owner: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP +.fi +.nf +\f3 Issuer: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP +.fi +.nf +\f3 Serial Number: 59092b34\fP +.fi +.nf +\f3 Valid from: Thu Sep 25 18:01:13 PDT 1997 until: Wed Dec 24 17:01:13 PST 1997\fP +.fi +.nf +\f3 Certificate Fingerprints:\fP +.fi +.nf +\f3 MD5: 11:81:AD:92:C8:E5:0E:A2:01:2E:D4:7A:D7:5F:07:6F\fP +.fi +.nf +\f3 SHA1: 20:B6:17:FA:EF:E5:55:8A:D0:71:1F:E8:D6:9D:C0:37:13:0E:5E:FE\fP +.fi +.nf +\f3 SHA256: 90:7B:70:0A:EA:DC:16:79:92:99:41:FF:8A:FE:EB:90:\fP +.fi +.nf +\f3 17:75:E0:90:B2:24:4D:3A:2A:16:A6:E4:11:0F:67:A4\fP +.fi +.sp + +.PP +Oracle Solaris Example: + +View the certificate first with the \f3-printcert\fR command or the \f3-importcert\fR command without the \f3-noprompt\fR option\&. Ensure that the displayed certificate fingerprints match the expected ones\&. For example, suppose someone sends or emails you a certificate that you put it in a file named \f3/tmp/cert\fR\&. Before you consider adding the certificate to your list of trusted certificates, you can execute a \f3-printcert\fR command to view its fingerprints, as follows: +.sp +.nf +\f3 keytool \-printcert \-file /tmp/cert\fP +.fi +.nf +\f3 Owner: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP +.fi +.nf +\f3 Issuer: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP +.fi +.nf +\f3 Serial Number: 59092b34\fP +.fi +.nf +\f3 Valid from: Thu Sep 25 18:01:13 PDT 1997 until: Wed Dec 24 17:01:13 PST 1997\fP +.fi +.nf +\f3 Certificate Fingerprints:\fP +.fi +.nf +\f3 MD5: 11:81:AD:92:C8:E5:0E:A2:01:2E:D4:7A:D7:5F:07:6F\fP +.fi +.nf +\f3 SHA1: 20:B6:17:FA:EF:E5:55:8A:D0:71:1F:E8:D6:9D:C0:37:13:0E:5E:FE\fP +.fi +.nf +\f3 SHA256: 90:7B:70:0A:EA:DC:16:79:92:99:41:FF:8A:FE:EB:90:\fP +.fi +.nf +\f3 17:75:E0:90:B2:24:4D:3A:2A:16:A6:E4:11:0F:67:A4\fP +.fi +.nf +\f3\fP +.fi +.sp +Then call or otherwise contact the person who sent the certificate and compare the fingerprints that you see with the ones that they show\&. Only when the fingerprints are equal is it guaranteed that the certificate was not replaced in transit with somebody else\&'s certificate such as an attacker\&'s certificate\&. If such an attack took place, and you did not check the certificate before you imported it, then you would be trusting anything the attacker signed, for example, a JAR file with malicious class files inside\&. +.PP +\fINote:\fR It is not required that you execute a \f3-printcert\fR command before importing a certificate\&. This is because before you add a certificate to the list of trusted certificates in the keystore, the \f3-importcert\fR command prints out the certificate information and prompts you to verify it\&. You can then stop the import operation\&. However, you can do this only when you call the \f3-importcert\fR command without the \f3-noprompt\fR option\&. If the \f3-noprompt\fR option is specified, then there is no interaction with the user\&. +.SS PASSWORDS\ WARNING +Most commands that operate on a keystore require the store password\&. Some commands require a private/secret key password\&. Passwords can be specified on the command line in the \f3-storepass\fR and \f3-keypass\fR options\&. However, a password should not be specified on a command line or in a script unless it is for testing, or you are on a secure system\&. When you do not specify a required password option on a command line, you are prompted for it\&. +.SS CERTIFICATE\ CONFORMANCE\ WARNING +The Internet standard RFC 5280 has defined a profile on conforming X\&.509 certificates, which includes what values and value combinations are valid for certificate fields and extensions\&. See the standard at http://tools\&.ietf\&.org/rfc/rfc5280\&.txt +.PP +The \f3keytool\fR command does not enforce all of these rules so it can generate certificates that do not conform to the standard\&. Certificates that do not conform to the standard might be rejected by JRE or other applications\&. Users should ensure that they provide the correct options for \f3-dname\fR, \f3-ext\fR, and so on\&. +.SH NOTES +.SS IMPORT\ A\ NEW\ TRUSTED\ CERTIFICATE +Before you add the certificate to the keystore, the \f3keytool\fR command verifies it by attempting to construct a chain of trust from that certificate to a self-signed certificate (belonging to a root CA), using trusted certificates that are already available in the keystore\&. +.PP +If the \f3-trustcacerts\fR option was specified, then additional certificates are considered for the chain of trust, namely the certificates in a file named \f3cacerts\fR\&. +.PP +If the \f3keytool\fR command fails to establish a trust path from the certificate to be imported up to a self-signed certificate (either from the keystore or the \f3cacerts\fR file), then the certificate information is printed, and the user is prompted to verify it by comparing the displayed certificate fingerprints with the fingerprints obtained from some other (trusted) source of information, which might be the certificate owner\&. Be very careful to ensure the certificate is valid before importing it as a trusted certificate\&. See Importing Trusted Certificates Warning\&. The user then has the option of stopping the import operation\&. If the \f3-noprompt\fR option is specified, then there is no interaction with the user\&. +.SS IMPORT\ A\ CERTIFICATE\ REPLY +When you import a certificate reply, the certificate reply is validated with trusted certificates from the keystore, and optionally, the certificates configured in the \f3cacerts\fR keystore file when the \f3-trustcacert\fR\f3s\fR option is specified\&. See The cacerts Certificates File\&. +.PP +The methods of determining whether the certificate reply is trusted are as follows: +.TP 0.2i +\(bu +If the reply is a single X\&.509 certificate, then the \f3keytool\fR command attempts to establish a trust chain, starting at the certificate reply and ending at a self-signed certificate (belonging to a root CA)\&. The certificate reply and the hierarchy of certificates is used to authenticate the certificate reply from the new certificate chain of aliases\&. If a trust chain cannot be established, then the certificate reply is not imported\&. In this case, the \f3keytool\fR command does not print the certificate and prompt the user to verify it, because it is very difficult for a user to determine the authenticity of the certificate reply\&. +.TP 0.2i +\(bu +If the reply is a PKCS #7 formatted certificate chain or a sequence of X\&.509 certificates, then the chain is ordered with the user certificate first followed by zero or more CA certificates\&. If the chain ends with a self-signed root CA certificate and the\f3-trustcacerts\fR option was specified, the \f3keytool\fR command attempts to match it with any of the trusted certificates in the keystore or the \f3cacerts\fR keystore file\&. If the chain does not end with a self-signed root CA certificate and the \f3-trustcacerts\fR option was specified, the \f3keytool\fR command tries to find one from the trusted certificates in the keystore or the \f3cacerts\fR keystore file and add it to the end of the chain\&. If the certificate is not found and the \f3-noprompt\fR option is not specified, the information of the last certificate in the chain is printed, and the user is prompted to verify it\&. +.PP +If the public key in the certificate reply matches the user\&'s public key already stored with \f3alias\fR, then the old certificate chain is replaced with the new certificate chain in the reply\&. The old chain can only be replaced with a valid \f3keypass\fR, and so the password used to protect the private key of the entry is supplied\&. If no password is provided, and the private key password is different from the keystore password, the user is prompted for it\&. +.PP +This command was named \f3-import\fR in earlier releases\&. This old name is still supported in this release\&. The new name, \f3-importcert\fR, is preferred going forward\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +jarsigner(1) +.TP 0.2i +\(bu +Trail: Security Features in Java SE at http://docs\&.oracle\&.com/javase/tutorial/security/index\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/native2ascii.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/native2ascii.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,86 +1,86 @@ -'\" t -.\" Copyright (c) 1997, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Internationalization Tools -.\" Title: native2ascii.1 -.\" -.if n .pl 99999 -.TH native2ascii 1 "21 November 2013" "JDK 8" "Internationalization Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -native2ascii \- Creates localizable applications by converting a file with characters in any supported character encoding to one with ASCII and/or Unicode escapes or vice versa\&. -.SH SYNOPSIS -.sp -.nf - -\fBnative2ascii\fR [ \fIinputfile\fR ] [ \fIoutputfile\fR ] -.fi -.sp -.TP -\fIinputfile\fR -The encoded file to be converted to ASCII\&. -.TP -\fIoutputfile\fR -The converted ASCII file\&. -.SH DESCRIPTION -The \f3native2ascii\fR command converts encoded files supported by the Java Runtime Environment (JRE) to files encoded in ASCII, using Unicode escapes (\f3\eu\fR\fIxxxx\fR) notation for all characters that are not part of the ASCII character set\&. This process is required for properties files that contain characters not in ISO-8859-1 character sets\&. The tool can also perform the reverse conversion\&. -.PP -If the \f3outputfile\fR value is omitted, then standard output is used for output\&. If, in addition, the \f3inputfile\fR value is omitted, then standard input is used for input\&. -.SH OPTIONS -.TP --reverse -.br -Perform the reverse operation: Converts a file encoded in ISO-8859-1 with Unicode escapes to a file in any character encoding supported by the JRE\&. -.TP --encoding \fIencoding_name\fR -.br -Specifies the name of the character encoding to be used by the conversion procedure\&. If this option is not present, then the default character encoding (as determined by the \f3java\&.nio\&.charset\&.Charset\&.defaultCharset\fR method) is used\&. The \f3encoding_name\fR string must be the name of a character encoding that is supported by the JRE\&. See Supported Encodings at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/intl/encoding\&.doc\&.html -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1997, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Internationalization Tools +.\" Title: native2ascii.1 +.\" +.if n .pl 99999 +.TH native2ascii 1 "21 November 2013" "JDK 8" "Internationalization Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +native2ascii \- Creates localizable applications by converting a file with characters in any supported character encoding to one with ASCII and/or Unicode escapes or vice versa\&. +.SH SYNOPSIS +.sp +.nf + +\fBnative2ascii\fR [ \fIinputfile\fR ] [ \fIoutputfile\fR ] +.fi +.sp +.TP +\fIinputfile\fR +The encoded file to be converted to ASCII\&. +.TP +\fIoutputfile\fR +The converted ASCII file\&. +.SH DESCRIPTION +The \f3native2ascii\fR command converts encoded files supported by the Java Runtime Environment (JRE) to files encoded in ASCII, using Unicode escapes (\f3\eu\fR\fIxxxx\fR) notation for all characters that are not part of the ASCII character set\&. This process is required for properties files that contain characters not in ISO-8859-1 character sets\&. The tool can also perform the reverse conversion\&. +.PP +If the \f3outputfile\fR value is omitted, then standard output is used for output\&. If, in addition, the \f3inputfile\fR value is omitted, then standard input is used for input\&. +.SH OPTIONS +.TP +-reverse +.br +Perform the reverse operation: Converts a file encoded in ISO-8859-1 with Unicode escapes to a file in any character encoding supported by the JRE\&. +.TP +-encoding \fIencoding_name\fR +.br +Specifies the name of the character encoding to be used by the conversion procedure\&. If this option is not present, then the default character encoding (as determined by the \f3java\&.nio\&.charset\&.Charset\&.defaultCharset\fR method) is used\&. The \f3encoding_name\fR string must be the name of a character encoding that is supported by the JRE\&. See Supported Encodings at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/intl/encoding\&.doc\&.html +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/orbd.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/orbd.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,213 +1,213 @@ -'\" t -.\" Copyright (c) 2001, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java IDL and RMI-IIOP Tools -.\" Title: orbd.1 -.\" -.if n .pl 99999 -.TH orbd 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -orbd \- Enables clients to locate and call persistent objects on servers in the CORBA environment\&. -.SH SYNOPSIS -.sp -.nf - -\fBorbd\fR [ \fIoptions\fR ] -.fi -.sp -.TP -\fIoptions\fR -Command-line options\&. See Options\&. -.SH DESCRIPTION -The \f3orbd\fR command enables clients to transparently locate and call persistent objects on servers in the CORBA environment\&. The Server Manager included with the orbd tool is used to enable clients to transparently locate and call 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: -.TP 0.2i -\(bu -The object reference in the naming service remains independent of the server life cycle\&. For example, the object reference could be published by the server in the Naming Service when it is first installed, and then, independent of how many times the server is started or shut down, the ORBD returns the correct object reference to the calling client\&. -.TP 0.2i -\(bu -The client needs to look up the object reference in the naming service only once, and can keep reusing this reference independent of the changes introduced due to server life cycle\&. -.PP -To access the ORBD Server Manager, the server must be started using \f3servertool\fR, which is a command-line interface for application programmers to register, unregister, start up, and shut down a persistent server\&. For more information on the Server Manager, see Server Manager\&. -.PP -When \f3orbd\fR starts, it also starts a naming service\&. For more information about the naming service\&. See Start and Stop the Naming Service\&. -.SH OPTIONS -.TP --ORBInitialPort \fInameserverport\fR -.br -Required\&. Specifies the port on which the name server should be started\&. After it is started, \f3orbd\fR listens for incoming requests on this port\&. On Oracle Solaris software, you must become the root user to start a process on a port below 1024\&. For this reason, Oracle recommends that you use a port number above or equal to 1024\&. -.SS NONREQUIRED\ OPTIONS -.TP --port \fIport\fR -.br -Specifies the activation port where ORBD should be started, and where ORBD will be accepting requests for persistent objects\&. The default value for this port is 1049\&. This port number is added to the port field of the persistent Interoperable Object References (IOR)\&. -.TP --defaultdb \fIdirectory\fR -.br -Specifies the base where the ORBD persistent storage directory, \f3orb\&.db\fR, is created\&. If this option is not specified, then the default value is \f3\&./orb\&.db\fR\&. -.TP --serverPollingTime \fImilliseconds\fR -.br -Specifies how often ORBD checks for the health of persistent servers registered through \f3servertool\fR\&. The default value is 1000 ms\&. The value specified for \f3milliseconds\fR must be a valid positive integer\&. -.TP --serverStartupDelay milliseconds -.br -Specifies how long ORBD waits before sending a location forward exception after a persistent server that is registered through \f3servertool\fR is restarted\&. The default value is 1000 ms\&. The value specified for \f3milliseconds\fR must be a valid positive integer\&. -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SS START\ AND\ STOP\ THE\ NAMING\ SERVICE -A naming service is a CORBA service that allows CORBA objects to be named by means of binding a name to an object reference\&. The name binding can be stored in the naming service, and a client can supply the name to obtain the desired object reference\&. -.PP -Before 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\&. -.PP -The Persistent Naming Service provides persistence for naming contexts\&. This means that this information is persistent across service shutdowns and startups, and is recoverable in the event of a service failure\&. If ORBD is restarted, then the Persistent Naming Service restores the naming context graph, so that the binding of all clients\&' and servers\&' names remains intact (persistent)\&. -.PP -For backward compatibility, \f3tnameserv\fR, a Transient Naming Service that shipped with earlier releases of the JDK, is also included in this release of Java SE\&. A transient naming service retains naming contexts as long as it is running\&. If there is a service interruption, then the naming context graph is lost\&. -.PP -The \f3-ORBInitialPort\fR argument is a required command-line argument for \f3orbd\fR, and is used to set the port number on which the naming service runs\&. The following instructions assume you can use port 1050 for the Java IDL Object Request Broker Daemon\&. When using Oracle Solaris software, you must become a root user to start a process on a port lower than 1024\&. For this reason, it is recommended that you use a port number above or equal to 1024\&. You can substitute a different port when necessary\&. -.PP -To start \f3orbd\fR from a UNIX command shell, enter: -.sp -.nf -\f3orbd \-ORBInitialPort 1050&\fP -.fi -.nf -\f3\fP -.fi -.sp -From an MS-DOS system prompt (Windows), enter: -.sp -.nf -\f3start orbd \-ORBInitialPort 1050\fP -.fi -.nf -\f3\fP -.fi -.sp -Now that ORBD is running, you can run your server and client applications\&. When running the client and server applications, they must be made aware of the port number (and machine name, when applicable) where the Naming Service is running\&. One way to do this is to add the following code to your application: -.sp -.nf -\f3Properties props = new Properties();\fP -.fi -.nf -\f3props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP -.fi -.nf -\f3props\&.put("org\&.omg\&.CORBA\&.ORBInitialHost", "MyHost");\fP -.fi -.nf -\f3ORB orb = ORB\&.init(args, props);\fP -.fi -.nf -\f3\fP -.fi -.sp -In this example, the naming service is running on port 1050 on host \f3MyHost\fR\&. Another way is to specify the port number and/or machine name when running the server or client application from the command line\&. For example, you would start your \f3HelloApplication\fR with the following command line: -.sp -.nf -\f3java HelloApplication \-ORBInitialPort 1050 \-ORBInitialHost MyHost\fP -.fi -.nf -\f3\fP -.fi -.sp -To stop the naming service, use the relevant operating system command, such as \f3pkill\fR\f3orbd\fR on Oracle Solaris, or \fICtrl+C\fR in the DOS window in which \f3orbd\fR is running\&. Note that names registered with the naming service can disappear when the service is terminated because of a transient naming service\&. The Java IDL naming service will run until it is explicitly stopped\&. -.PP -For more information about the naming service included with ORBD, see Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html -.SH SERVER\ MANAGER -To access the ORBD Server Manager and run a persistent server, the server must be started with \f3servertool\fR, which is a command-line interface for application programmers to register, unregister, start up, and shut down a persistent server\&. When a server is started using \f3servertool\fR, it must be started on the same host and port on which \f3orbd\fR is executing\&. If the server is run on a different port, then the information stored in the database for local contexts will be invalid and the service will not work properly\&. -.PP -See Java IDL: The "Hello World" Example at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlExample\&.html -.PP -In this example, you run the \f3idlj\fR compiler and \f3javac\fR compiler as shown in the tutorial\&. To run the ORBD Server Manager, follow these steps for running the application: -.PP -Start \f3orbd\fR\&. -.PP -UNIX command shell, enter: \f3orbd -ORBInitialPort 1050\fR\&. -.PP -MS-DOS system prompt (Windows), enter: \f3s\fR\f3tart orbd -ORBInitialPort 105\fR\f30\fR\&. -.PP -Port 1050 is the port on which you want the name server to run\&. The \f3-ORBInitialPort\fR option is a required command-line argument\&. When using Oracle Solaris software, you must become a root user to start a process on a port below 1024\&. For this reason, it is recommended that you use a port number above or equal to 1024\&. -.PP -Start the \f3servertool\fR: \f3servertool -ORBInitialPort 1050\fR\&. -.PP -Make sure the name server (\f3orbd\fR) port is the same as in the previous step, for example, \f3-ORBInitialPort 1050\&.\fR The \f3servertool\fR must be started on the same port as the name server\&. -.PP -In the \f3servertool\fR command line interface, start the \f3Hello\fR server from the \f3servertool\fR prompt: -.sp -.nf -\f3servertool > register \-server HelloServer \-classpath \&. \-applicationName\fP -.fi -.nf -\f3 HelloServerApName\fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3servertool\fR registers the server, assigns it the name \f3HelloServerApName\fR, and displays its server ID with a listing of all registered servers\&.Run the client application from another terminal window or prompt: -.sp -.nf -\f3java HelloClient \-ORBInitialPort 1050 \-ORBInitialHost localhost\fP -.fi -.nf -\f3\fP -.fi -.sp -For this example, you can omit \f3-ORBInitialHost localhost\fR because the name server is running on the same host as the \f3Hello\fR client\&. If the name server is running on a different host, then use the -\f3ORBInitialHost nameserverhost\fR option to specify the host on which the IDL name server is running\&.Specify the name server (\f3orbd\fR) port as done in the previous step, for example, \f3-ORBInitialPort 1050\fR\&. When you finish experimenting with the ORBD Server Manager, be sure to shut down or terminate the name server (\f3orbd\fR) and \f3servertool\fR\&. To shut down \f3orbd\fR from am MS-DOS prompt, select the window that is running the server and enter \fICtrl+C\fR to shut it down\&. -.PP -To shut down \f3orbd\fR from an Oracle Solaris shell, find the process, and terminate with the \f3kill\fR command\&. The server continues to wait for invocations until it is explicitly stopped\&. To shut down the \f3servertool\fR, type \fIquit\fR and press the \fIEnter\fR key\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -servertool(1) -.TP 0.2i -\(bu -Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2001, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java IDL and RMI-IIOP Tools +.\" Title: orbd.1 +.\" +.if n .pl 99999 +.TH orbd 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +orbd \- Enables clients to locate and call persistent objects on servers in the CORBA environment\&. +.SH SYNOPSIS +.sp +.nf + +\fBorbd\fR [ \fIoptions\fR ] +.fi +.sp +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.SH DESCRIPTION +The \f3orbd\fR command enables clients to transparently locate and call persistent objects on servers in the CORBA environment\&. The Server Manager included with the orbd tool is used to enable clients to transparently locate and call 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: +.TP 0.2i +\(bu +The object reference in the naming service remains independent of the server life cycle\&. For example, the object reference could be published by the server in the Naming Service when it is first installed, and then, independent of how many times the server is started or shut down, the ORBD returns the correct object reference to the calling client\&. +.TP 0.2i +\(bu +The client needs to look up the object reference in the naming service only once, and can keep reusing this reference independent of the changes introduced due to server life cycle\&. +.PP +To access the ORBD Server Manager, the server must be started using \f3servertool\fR, which is a command-line interface for application programmers to register, unregister, start up, and shut down a persistent server\&. For more information on the Server Manager, see Server Manager\&. +.PP +When \f3orbd\fR starts, it also starts a naming service\&. For more information about the naming service\&. See Start and Stop the Naming Service\&. +.SH OPTIONS +.TP +-ORBInitialPort \fInameserverport\fR +.br +Required\&. Specifies the port on which the name server should be started\&. After it is started, \f3orbd\fR listens for incoming requests on this port\&. On Oracle Solaris software, you must become the root user to start a process on a port below 1024\&. For this reason, Oracle recommends that you use a port number above or equal to 1024\&. +.SS NONREQUIRED\ OPTIONS +.TP +-port \fIport\fR +.br +Specifies the activation port where ORBD should be started, and where ORBD will be accepting requests for persistent objects\&. The default value for this port is 1049\&. This port number is added to the port field of the persistent Interoperable Object References (IOR)\&. +.TP +-defaultdb \fIdirectory\fR +.br +Specifies the base where the ORBD persistent storage directory, \f3orb\&.db\fR, is created\&. If this option is not specified, then the default value is \f3\&./orb\&.db\fR\&. +.TP +-serverPollingTime \fImilliseconds\fR +.br +Specifies how often ORBD checks for the health of persistent servers registered through \f3servertool\fR\&. The default value is 1000 ms\&. The value specified for \f3milliseconds\fR must be a valid positive integer\&. +.TP +-serverStartupDelay milliseconds +.br +Specifies how long ORBD waits before sending a location forward exception after a persistent server that is registered through \f3servertool\fR is restarted\&. The default value is 1000 ms\&. The value specified for \f3milliseconds\fR must be a valid positive integer\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SS START\ AND\ STOP\ THE\ NAMING\ SERVICE +A naming service is a CORBA service that allows CORBA objects to be named by means of binding a name to an object reference\&. The name binding can be stored in the naming service, and a client can supply the name to obtain the desired object reference\&. +.PP +Before 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\&. +.PP +The Persistent Naming Service provides persistence for naming contexts\&. This means that this information is persistent across service shutdowns and startups, and is recoverable in the event of a service failure\&. If ORBD is restarted, then the Persistent Naming Service restores the naming context graph, so that the binding of all clients\&' and servers\&' names remains intact (persistent)\&. +.PP +For backward compatibility, \f3tnameserv\fR, a Transient Naming Service that shipped with earlier releases of the JDK, is also included in this release of Java SE\&. A transient naming service retains naming contexts as long as it is running\&. If there is a service interruption, then the naming context graph is lost\&. +.PP +The \f3-ORBInitialPort\fR argument is a required command-line argument for \f3orbd\fR, and is used to set the port number on which the naming service runs\&. The following instructions assume you can use port 1050 for the Java IDL Object Request Broker Daemon\&. When using Oracle Solaris software, you must become a root user to start a process on a port lower than 1024\&. For this reason, it is recommended that you use a port number above or equal to 1024\&. You can substitute a different port when necessary\&. +.PP +To start \f3orbd\fR from a UNIX command shell, enter: +.sp +.nf +\f3orbd \-ORBInitialPort 1050&\fP +.fi +.nf +\f3\fP +.fi +.sp +From an MS-DOS system prompt (Windows), enter: +.sp +.nf +\f3start orbd \-ORBInitialPort 1050\fP +.fi +.nf +\f3\fP +.fi +.sp +Now that ORBD is running, you can run your server and client applications\&. When running the client and server applications, they must be made aware of the port number (and machine name, when applicable) where the Naming Service is running\&. One way to do this is to add the following code to your application: +.sp +.nf +\f3Properties props = new Properties();\fP +.fi +.nf +\f3props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP +.fi +.nf +\f3props\&.put("org\&.omg\&.CORBA\&.ORBInitialHost", "MyHost");\fP +.fi +.nf +\f3ORB orb = ORB\&.init(args, props);\fP +.fi +.nf +\f3\fP +.fi +.sp +In this example, the naming service is running on port 1050 on host \f3MyHost\fR\&. Another way is to specify the port number and/or machine name when running the server or client application from the command line\&. For example, you would start your \f3HelloApplication\fR with the following command line: +.sp +.nf +\f3java HelloApplication \-ORBInitialPort 1050 \-ORBInitialHost MyHost\fP +.fi +.nf +\f3\fP +.fi +.sp +To stop the naming service, use the relevant operating system command, such as \f3pkill\fR\f3orbd\fR on Oracle Solaris, or \fICtrl+C\fR in the DOS window in which \f3orbd\fR is running\&. Note that names registered with the naming service can disappear when the service is terminated because of a transient naming service\&. The Java IDL naming service will run until it is explicitly stopped\&. +.PP +For more information about the naming service included with ORBD, see Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html +.SH SERVER\ MANAGER +To access the ORBD Server Manager and run a persistent server, the server must be started with \f3servertool\fR, which is a command-line interface for application programmers to register, unregister, start up, and shut down a persistent server\&. When a server is started using \f3servertool\fR, it must be started on the same host and port on which \f3orbd\fR is executing\&. If the server is run on a different port, then the information stored in the database for local contexts will be invalid and the service will not work properly\&. +.PP +See Java IDL: The "Hello World" Example at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlExample\&.html +.PP +In this example, you run the \f3idlj\fR compiler and \f3javac\fR compiler as shown in the tutorial\&. To run the ORBD Server Manager, follow these steps for running the application: +.PP +Start \f3orbd\fR\&. +.PP +UNIX command shell, enter: \f3orbd -ORBInitialPort 1050\fR\&. +.PP +MS-DOS system prompt (Windows), enter: \f3s\fR\f3tart orbd -ORBInitialPort 105\fR\f30\fR\&. +.PP +Port 1050 is the port on which you want the name server to run\&. The \f3-ORBInitialPort\fR option is a required command-line argument\&. When using Oracle Solaris software, you must become a root user to start a process on a port below 1024\&. For this reason, it is recommended that you use a port number above or equal to 1024\&. +.PP +Start the \f3servertool\fR: \f3servertool -ORBInitialPort 1050\fR\&. +.PP +Make sure the name server (\f3orbd\fR) port is the same as in the previous step, for example, \f3-ORBInitialPort 1050\&.\fR The \f3servertool\fR must be started on the same port as the name server\&. +.PP +In the \f3servertool\fR command line interface, start the \f3Hello\fR server from the \f3servertool\fR prompt: +.sp +.nf +\f3servertool > register \-server HelloServer \-classpath \&. \-applicationName\fP +.fi +.nf +\f3 HelloServerApName\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3servertool\fR registers the server, assigns it the name \f3HelloServerApName\fR, and displays its server ID with a listing of all registered servers\&.Run the client application from another terminal window or prompt: +.sp +.nf +\f3java HelloClient \-ORBInitialPort 1050 \-ORBInitialHost localhost\fP +.fi +.nf +\f3\fP +.fi +.sp +For this example, you can omit \f3-ORBInitialHost localhost\fR because the name server is running on the same host as the \f3Hello\fR client\&. If the name server is running on a different host, then use the -\f3ORBInitialHost nameserverhost\fR option to specify the host on which the IDL name server is running\&.Specify the name server (\f3orbd\fR) port as done in the previous step, for example, \f3-ORBInitialPort 1050\fR\&. When you finish experimenting with the ORBD Server Manager, be sure to shut down or terminate the name server (\f3orbd\fR) and \f3servertool\fR\&. To shut down \f3orbd\fR from am MS-DOS prompt, select the window that is running the server and enter \fICtrl+C\fR to shut it down\&. +.PP +To shut down \f3orbd\fR from an Oracle Solaris shell, find the process, and terminate with the \f3kill\fR command\&. The server continues to wait for invocations until it is explicitly stopped\&. To shut down the \f3servertool\fR, type \fIquit\fR and press the \fIEnter\fR key\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +servertool(1) +.TP 0.2i +\(bu +Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/pack200.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/pack200.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,290 +1,290 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java Deployment Tools -.\" Title: pack200.1 -.\" -.if n .pl 99999 -.TH pack200 1 "21 November 2013" "JDK 8" "Java Deployment Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -pack200 \- Packages a JAR file into a compressed pack200 file for web deployment\&. -.SH SYNOPSIS -.sp -.nf - -\fBpack200\fR [\fIoptions\fR] \fIoutput\-file\fR \fIJAR\-file\fR -.fi -.sp -Options can be in any order\&. The last option on the command line or in a properties file supersedes all previously specified options\&. -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIoutput-file\fR -Name of the output file\&. -.TP -\fIJAR-file\fR -Name of the input file\&. -.SH DESCRIPTION -The \f3pack200\fR command is a Java application that transforms a JAR file into a compressed pack200 file with the Java gzip compressor\&. The pack200 files are highly compressed files that can be directly deployed to save bandwidth and reduce download time\&. -.PP -The \f3pack200\fR command has several options to fine-tune and set the compression engine\&. The typical usage is shown in the following example, where \f3myarchive\&.pack\&.gz\fR is produced with the default \f3pack200\fR command settings: -.sp -.nf -\f3pack200 myarchive\&.pack\&.gz myarchive\&.jar\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH OPTIONS -.TP --r, --repack -.br -Produces a JAR file by packing and unpacking a JAR file\&. The resulting file can be used as an input to the \f3jarsigner\fR(1) tool\&. The following example packs and unpacks the myarchive\&.jar file: -.sp -.nf -\f3pack200 \-\-repack myarchive\-packer\&.jar myarchive\&.jar\fP -.fi -.nf -\f3pack200 \-\-repack myarchive\&.jar\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The following example preserves the order of files in the input file\&. -.TP --g, --no-gzip -.br -Produces a \f3pack200\fR file\&. With this option, a suitable compressor must be used, and the target system must use a corresponding decompresser\&. -.sp -.nf -\f3pack200 \-\-no\-gzip myarchive\&.pack myarchive\&.jar\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --G, --strip-debug -.br -Strips debugging attributes from the output\&. These include \f3SourceFile\fR, \f3LineNumberTable\fR, \f3LocalVariableTable\fR and \f3LocalVariableTypeTable\fR\&. Removing these attributes reduces the size of both downloads and installations, but reduces the usefulness of debuggers\&. -.TP ---keep-file-order -.br -Preserve the order of files in the input file\&. This is the default behavior\&. -.TP --O, --no-keep-file-order -.br -The packer reorders and transmits all elements\&. The packer can also remove JAR directory names to reduce the download size\&. However, certain JAR file optimizations, such as indexing, might not work correctly\&. -.TP --S\fIvalue\fR , --segment-limit=\fIvalue\fR -.br -The value is the estimated target size \fIN\fR (in bytes) of each archive segment\&. If a single input file requires more than \fIN\fR bytes, then its own archive segment is provided\&. As a special case, a value of \f3-1\fR produces a single large segment with all input files, while a value of 0 produces one segment for each class\&. Larger archive segments result in less fragmentation and better compression, but processing them requires more memory\&. - -The size of each segment is estimated by counting the size of each input file to be transmitted in the segment with the size of its name and other transmitted properties\&. - -The default is -1, which means that the packer creates 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\&. - -A 10 MB JAR packed without this limit typically packs about 10 percent smaller, but the packer might require a larger Java heap (about 10 times the segment limit)\&. -.TP --E\fIvalue\fR , --effort=\fIvalue\fR -.br -If the value is set to a single decimal digit, then the packer uses the indicated amount of effort in compressing the archive\&. Level 1 might produce somewhat larger size and faster compression speed, while level 9 takes much longer, but can produce better compression\&. The special value 0 instructs the \f3pack200\fR command 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\&. - -The default is 5, to invest a modest amount of time to produce reasonable compression\&. -.TP --H\fIvalue\fR , --deflate-hint=\fIvalue\fR -.br -Overrides the default, which preserves the input information, but can cause the transmitted archive to be larger\&. The possible values are: \f3true\fR, \f3false\fR, or \f3keep\fR\&. - -If the \f3value\fR is \f3true\fR or false, then the \f3packer200\fR command sets the deflation hint accordingly in the output archive and does not transmit the individual deflation hints of archive elements\&. - -The \f3keep\fR value preserves deflation hints observed in the input JAR\&. This is the default\&. -.TP --m\fIvalue\fR , --modification-time=\fIvalue\fR -.br -The possible values are \f3latest\fR and \f3keep\fR\&. - -If the value is latest, then the packer attempts to determine the latest modification time, among all the available entries in the original archive, or the latest modification time of all the available entries in that segment\&. This single value is transmitted as part of the segment and applied to all the entries in each segment\&. This can marginally decrease the transmitted size of the archive at the expense of setting all installed files to a single date\&. - -If the value is \f3keep\fR, then modification times observed in the input JAR are preserved\&. This is the default\&. -.TP --P\fIfile\fR , --pass-file=\fIfile\fR -.br -Indicates that a file should be passed through bytewise with no compression\&. By repeating the option, multiple files can be specified\&. There is no pathname transformation, except that the system file separator is replaced by the JAR file separator forward slash (/)\&. The resulting file names must match exactly as strings with their occurrences in the JAR file\&. If \f3file\fR is a directory name, then all files under that directory are passed\&. -.TP --U\fIaction\fR , --unknown-attribute=\fIaction\fR -.br -Overrides the default behavior, which means that the class file that contains the unknown attribute is passed through with the specified \f3action\fR\&. The possible values for actions are \f3error\fR, \f3strip\fR, or \f3pass\fR\&. - -If the value is \f3error\fR, then the entire \f3pack200\fR command operation fails with a suitable explanation\&. - -If the value is \f3strip\fR, then the attribute is dropped\&. Removing the required Java Virtual Machine (JVM) attributes can cause class loader failures\&. - -If the value is \f3pass\fR, then the entire class is transmitted as though it is a resource\&. -.TP -.nf --C\fIattribute-name\fR=\fIlayout\fR , --class-attribute=\fIattribute-name\fR=\fIaction\fR -.br -.fi -See next option\&. -.TP -.nf --F\fIattribute-name\fR=\fIlayout\fR , --field-attribute=\fIattribute-name\fR=\fIaction\fR -.br -.fi -See next option\&. -.TP -.nf --M\fIattribute-name\fR=\fIlayout\fR , --method-attribute=\fIattribute-name\fR=\fIaction\fR -.br -.fi -See next option\&. -.TP -.nf --D\fIattribute-name\fR=\fIlayout\fR , --code-attribute=\fIattribute-name\fR=\fIaction\fR -.br -.fi -With the previous four options, the attribute layout can be specified for a class entity, such as \f3class-attribute\fR, \f3field-attribute\fR, \f3method-attribute\fR, and \f3code-attribute\fR\&. The \fIattribute-name\fR is the name of the attribute for which the layout or action is being defined\&. The possible values for \fIaction\fR are \f3some-layout-string\fR, \f3error\fR, \f3strip\fR, \f3pass\fR\&. - -\f3some-layout-string\fR: The layout language is defined in the JSR 200 specification, for example: \f3--class-attribute=SourceFile=RUH\fR\&. - -If the value is \f3error\fR, then the \f3pack200\fR operation fails with an explanation\&. - -If the value is \f3strip\fR, then the attribute is removed from the output\&. Removing JVM-required attributes can cause class loader failures\&. For example, \f3--class-attribute=CompilationID=pass\fR causes the class file that contains this attribute to be passed through without further action by the packer\&. - -If the value is \f3pass\fR, then the entire class is transmitted as though it is a resource\&. -.TP --f \fIpack\&.properties\fR , --config-file=\fIpack\&.properties\fR -.br -A configuration file, containing Java properties to initialize the packer, can be specified on the command line\&. -.sp -.nf -\f3pack200 \-f pack\&.properties myarchive\&.pack\&.gz myarchive\&.jar\fP -.fi -.nf -\f3more pack\&.properties\fP -.fi -.nf -\f3# Generic properties for the packer\&.\fP -.fi -.nf -\f3modification\&.time=latest\fP -.fi -.nf -\f3deflate\&.hint=false\fP -.fi -.nf -\f3keep\&.file\&.order=false\fP -.fi -.nf -\f3# This option will cause the files bearing new attributes to\fP -.fi -.nf -\f3# be reported as an error rather than passed uncompressed\&.\fP -.fi -.nf -\f3unknown\&.attribute=error\fP -.fi -.nf -\f3# Change the segment limit to be unlimited\&.\fP -.fi -.nf -\f3segment\&.limit=\-1\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --v, --verbose -.br -Outputs minimal messages\&. Multiple specification of this option will create more verbose messages\&. -.TP --q, --quiet -.br -Specifies quiet operation with no messages\&. -.TP --l\fIfilename\fR , --log-file=\fIfilename\fR -.br -Specifies a log file to output messages\&. -.TP --?, -h, --help -.br -Prints help information about this command\&. -.TP --V, --version -.br -Prints version information about this command\&. -.TP --J\fIoption\fR -.br -Passes the specified option to the Java Virtual Machine\&. For more information, see the reference page for the java(1) command\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. -.SH EXIT\ STATUS -The following exit values are returned: 0 for successful completion and a number greater than 0 when an error occurs\&. -.SH NOTES -This command should not be confused with \f3pack\fR(1)\&. The \f3pack\fR and \f3pack200\fR commands are separate products\&. -.PP -The Java SE API Specification provided with the JDK is the superseding authority, when there are discrepancies\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -unpack200(1) -.TP 0.2i -\(bu -jar(1) -.TP 0.2i -\(bu -jarsigner(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Deployment Tools +.\" Title: pack200.1 +.\" +.if n .pl 99999 +.TH pack200 1 "21 November 2013" "JDK 8" "Java Deployment Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +pack200 \- Packages a JAR file into a compressed pack200 file for web deployment\&. +.SH SYNOPSIS +.sp +.nf + +\fBpack200\fR [\fIoptions\fR] \fIoutput\-file\fR \fIJAR\-file\fR +.fi +.sp +Options can be in any order\&. The last option on the command line or in a properties file supersedes all previously specified options\&. +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIoutput-file\fR +Name of the output file\&. +.TP +\fIJAR-file\fR +Name of the input file\&. +.SH DESCRIPTION +The \f3pack200\fR command is a Java application that transforms a JAR file into a compressed pack200 file with the Java gzip compressor\&. The pack200 files are highly compressed files that can be directly deployed to save bandwidth and reduce download time\&. +.PP +The \f3pack200\fR command has several options to fine-tune and set the compression engine\&. The typical usage is shown in the following example, where \f3myarchive\&.pack\&.gz\fR is produced with the default \f3pack200\fR command settings: +.sp +.nf +\f3pack200 myarchive\&.pack\&.gz myarchive\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-r, --repack +.br +Produces a JAR file by packing and unpacking a JAR file\&. The resulting file can be used as an input to the \f3jarsigner\fR(1) tool\&. The following example packs and unpacks the myarchive\&.jar file: +.sp +.nf +\f3pack200 \-\-repack myarchive\-packer\&.jar myarchive\&.jar\fP +.fi +.nf +\f3pack200 \-\-repack myarchive\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following example preserves the order of files in the input file\&. +.TP +-g, --no-gzip +.br +Produces a \f3pack200\fR file\&. With this option, a suitable compressor must be used, and the target system must use a corresponding decompresser\&. +.sp +.nf +\f3pack200 \-\-no\-gzip myarchive\&.pack myarchive\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-G, --strip-debug +.br +Strips debugging attributes from the output\&. These include \f3SourceFile\fR, \f3LineNumberTable\fR, \f3LocalVariableTable\fR and \f3LocalVariableTypeTable\fR\&. Removing these attributes reduces the size of both downloads and installations, but reduces the usefulness of debuggers\&. +.TP +--keep-file-order +.br +Preserve the order of files in the input file\&. This is the default behavior\&. +.TP +-O, --no-keep-file-order +.br +The packer reorders and transmits all elements\&. The packer can also remove JAR directory names to reduce the download size\&. However, certain JAR file optimizations, such as indexing, might not work correctly\&. +.TP +-S\fIvalue\fR , --segment-limit=\fIvalue\fR +.br +The value is the estimated target size \fIN\fR (in bytes) of each archive segment\&. If a single input file requires more than \fIN\fR bytes, then its own archive segment is provided\&. As a special case, a value of \f3-1\fR produces a single large segment with all input files, while a value of 0 produces one segment for each class\&. Larger archive segments result in less fragmentation and better compression, but processing them requires more memory\&. + +The size of each segment is estimated by counting the size of each input file to be transmitted in the segment with the size of its name and other transmitted properties\&. + +The default is -1, which means that the packer creates 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\&. + +A 10 MB JAR packed without this limit typically packs about 10 percent smaller, but the packer might require a larger Java heap (about 10 times the segment limit)\&. +.TP +-E\fIvalue\fR , --effort=\fIvalue\fR +.br +If the value is set to a single decimal digit, then the packer uses the indicated amount of effort in compressing the archive\&. Level 1 might produce somewhat larger size and faster compression speed, while level 9 takes much longer, but can produce better compression\&. The special value 0 instructs the \f3pack200\fR command 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\&. + +The default is 5, to invest a modest amount of time to produce reasonable compression\&. +.TP +-H\fIvalue\fR , --deflate-hint=\fIvalue\fR +.br +Overrides the default, which preserves the input information, but can cause the transmitted archive to be larger\&. The possible values are: \f3true\fR, \f3false\fR, or \f3keep\fR\&. + +If the \f3value\fR is \f3true\fR or false, then the \f3packer200\fR command sets the deflation hint accordingly in the output archive and does not transmit the individual deflation hints of archive elements\&. + +The \f3keep\fR value preserves deflation hints observed in the input JAR\&. This is the default\&. +.TP +-m\fIvalue\fR , --modification-time=\fIvalue\fR +.br +The possible values are \f3latest\fR and \f3keep\fR\&. + +If the value is latest, then the packer attempts to determine the latest modification time, among all the available entries in the original archive, or the latest modification time of all the available entries in that segment\&. This single value is transmitted as part of the segment and applied to all the entries in each segment\&. This can marginally decrease the transmitted size of the archive at the expense of setting all installed files to a single date\&. + +If the value is \f3keep\fR, then modification times observed in the input JAR are preserved\&. This is the default\&. +.TP +-P\fIfile\fR , --pass-file=\fIfile\fR +.br +Indicates that a file should be passed through bytewise with no compression\&. By repeating the option, multiple files can be specified\&. There is no pathname transformation, except that the system file separator is replaced by the JAR file separator forward slash (/)\&. The resulting file names must match exactly as strings with their occurrences in the JAR file\&. If \f3file\fR is a directory name, then all files under that directory are passed\&. +.TP +-U\fIaction\fR , --unknown-attribute=\fIaction\fR +.br +Overrides the default behavior, which means that the class file that contains the unknown attribute is passed through with the specified \f3action\fR\&. The possible values for actions are \f3error\fR, \f3strip\fR, or \f3pass\fR\&. + +If the value is \f3error\fR, then the entire \f3pack200\fR command operation fails with a suitable explanation\&. + +If the value is \f3strip\fR, then the attribute is dropped\&. Removing the required Java Virtual Machine (JVM) attributes can cause class loader failures\&. + +If the value is \f3pass\fR, then the entire class is transmitted as though it is a resource\&. +.TP +.nf +-C\fIattribute-name\fR=\fIlayout\fR , --class-attribute=\fIattribute-name\fR=\fIaction\fR +.br +.fi +See next option\&. +.TP +.nf +-F\fIattribute-name\fR=\fIlayout\fR , --field-attribute=\fIattribute-name\fR=\fIaction\fR +.br +.fi +See next option\&. +.TP +.nf +-M\fIattribute-name\fR=\fIlayout\fR , --method-attribute=\fIattribute-name\fR=\fIaction\fR +.br +.fi +See next option\&. +.TP +.nf +-D\fIattribute-name\fR=\fIlayout\fR , --code-attribute=\fIattribute-name\fR=\fIaction\fR +.br +.fi +With the previous four options, the attribute layout can be specified for a class entity, such as \f3class-attribute\fR, \f3field-attribute\fR, \f3method-attribute\fR, and \f3code-attribute\fR\&. The \fIattribute-name\fR is the name of the attribute for which the layout or action is being defined\&. The possible values for \fIaction\fR are \f3some-layout-string\fR, \f3error\fR, \f3strip\fR, \f3pass\fR\&. + +\f3some-layout-string\fR: The layout language is defined in the JSR 200 specification, for example: \f3--class-attribute=SourceFile=RUH\fR\&. + +If the value is \f3error\fR, then the \f3pack200\fR operation fails with an explanation\&. + +If the value is \f3strip\fR, then the attribute is removed from the output\&. Removing JVM-required attributes can cause class loader failures\&. For example, \f3--class-attribute=CompilationID=pass\fR causes the class file that contains this attribute to be passed through without further action by the packer\&. + +If the value is \f3pass\fR, then the entire class is transmitted as though it is a resource\&. +.TP +-f \fIpack\&.properties\fR , --config-file=\fIpack\&.properties\fR +.br +A configuration file, containing Java properties to initialize the packer, can be specified on the command line\&. +.sp +.nf +\f3pack200 \-f pack\&.properties myarchive\&.pack\&.gz myarchive\&.jar\fP +.fi +.nf +\f3more pack\&.properties\fP +.fi +.nf +\f3# Generic properties for the packer\&.\fP +.fi +.nf +\f3modification\&.time=latest\fP +.fi +.nf +\f3deflate\&.hint=false\fP +.fi +.nf +\f3keep\&.file\&.order=false\fP +.fi +.nf +\f3# This option will cause the files bearing new attributes to\fP +.fi +.nf +\f3# be reported as an error rather than passed uncompressed\&.\fP +.fi +.nf +\f3unknown\&.attribute=error\fP +.fi +.nf +\f3# Change the segment limit to be unlimited\&.\fP +.fi +.nf +\f3segment\&.limit=\-1\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-v, --verbose +.br +Outputs minimal messages\&. Multiple specification of this option will create more verbose messages\&. +.TP +-q, --quiet +.br +Specifies quiet operation with no messages\&. +.TP +-l\fIfilename\fR , --log-file=\fIfilename\fR +.br +Specifies a log file to output messages\&. +.TP +-?, -h, --help +.br +Prints help information about this command\&. +.TP +-V, --version +.br +Prints version information about this command\&. +.TP +-J\fIoption\fR +.br +Passes the specified option to the Java Virtual Machine\&. For more information, see the reference page for the java(1) command\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. +.SH EXIT\ STATUS +The following exit values are returned: 0 for successful completion and a number greater than 0 when an error occurs\&. +.SH NOTES +This command should not be confused with \f3pack\fR(1)\&. The \f3pack\fR and \f3pack200\fR commands are separate products\&. +.PP +The Java SE API Specification provided with the JDK is the superseding authority, when there are discrepancies\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +unpack200(1) +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +jarsigner(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/policytool.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/policytool.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,114 +1,114 @@ -'\" t -.\" Copyright (c) 2001, 2015, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 03 March 2015 -.\" SectDesc: Security Tools -.\" Title: policytool.1 -.\" -.if n .pl 99999 -.TH policytool 1 "03 March 2015" "JDK 8" "Security Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -policytool \- Reads and writes a plain text policy file based on user input through the utility GUI\&. -.SH SYNOPSIS -.sp -.nf - -\fBpolicytool\fR [ \fB\-file\fR ] [ \fIfilename\fR ] -.fi -.sp -.TP --file -.br -Directs the \f3policytool\fR command to load a policy file\&. -.TP -\fIfilename\fR -The name of the file to be loaded\&. -.PP -\fIExamples\fR: -.PP -Run the policy tool administrator utility: -.sp -.nf -\f3policytool\fP -.fi -.nf -\f3\fP -.fi -.sp -Run the \f3policytool\fR command and load the specified file: -.sp -.nf -\f3policytool \-file \fImypolicyfile\fR\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH DESCRIPTION -The \f3policytool\fR command calls an administrator\&'s GUI that enables system administrators to manage the contents of local policy files\&. A policy file is a plain-text file with a \f3\&.policy\fR extension, that maps remote requestors by domain, to permission objects\&. For details, see Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html -.SH OPTIONS -.TP --file -.br -Directs the \f3policytool\fR command to load a policy file\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html -.TP 0.2i -\(bu -Policy File Creation and Management at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyGuide\&.html -.TP 0.2i -\(bu -Permissions in Java SE Development Kit (JDK) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/permissions\&.html -.TP 0.2i -\(bu -Java Security Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/overview/jsoverview\&.html -.TP 0.2i -\(bu -Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2001, 2015, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 03 March 2015 +.\" SectDesc: Security Tools +.\" Title: policytool.1 +.\" +.if n .pl 99999 +.TH policytool 1 "03 March 2015" "JDK 8" "Security Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +policytool \- Reads and writes a plain text policy file based on user input through the utility GUI\&. +.SH SYNOPSIS +.sp +.nf + +\fBpolicytool\fR [ \fB\-file\fR ] [ \fIfilename\fR ] +.fi +.sp +.TP +-file +.br +Directs the \f3policytool\fR command to load a policy file\&. +.TP +\fIfilename\fR +The name of the file to be loaded\&. +.PP +\fIExamples\fR: +.PP +Run the policy tool administrator utility: +.sp +.nf +\f3policytool\fP +.fi +.nf +\f3\fP +.fi +.sp +Run the \f3policytool\fR command and load the specified file: +.sp +.nf +\f3policytool \-file \fImypolicyfile\fR\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH DESCRIPTION +The \f3policytool\fR command calls an administrator\&'s GUI that enables system administrators to manage the contents of local policy files\&. A policy file is a plain-text file with a \f3\&.policy\fR extension, that maps remote requestors by domain, to permission objects\&. For details, see Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html +.SH OPTIONS +.TP +-file +.br +Directs the \f3policytool\fR command to load a policy file\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html +.TP 0.2i +\(bu +Policy File Creation and Management at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyGuide\&.html +.TP 0.2i +\(bu +Permissions in Java SE Development Kit (JDK) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/permissions\&.html +.TP 0.2i +\(bu +Java Security Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/overview/jsoverview\&.html +.TP 0.2i +\(bu +Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/rmic.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/rmic.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,223 +1,223 @@ -'\" t -.\" Copyright (c) 1997, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Remote Method Invocation (RMI) Tools -.\" Title: rmic.1 -.\" -.if n .pl 99999 -.TH rmic 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -rmic \- Generates stub, skeleton, and tie classes for remote objects that use the Java Remote Method Protocol (JRMP) or Internet Inter-Orb protocol (IIOP)\&. Also generates Object Management Group (OMG) Interface Definition Language (IDL) -.SH SYNOPSIS -.sp -.nf - -\fBrmic\fR [ \fIoptions\fR ] \fIpackage\-qualified\-class\-names\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line \f3options\fR\&. See Options\&. -.TP -\fIpackage-qualified-class-names\fR -Class names that include their packages, for example, \f3java\&.awt\&.Color\fR\&. -.SH DESCRIPTION -\fIDeprecation Note:\fR Support for static generation of Java Remote Method Protocol (JRMP) stubs and skeletons has been deprecated\&. Oracle recommends that you use dynamically generated JRMP stubs instead, eliminating the need to use this tool for JRMP-based applications\&. See the \f3java\&.rmi\&.server\&.UnicastRemoteObject\fR specification at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/server/UnicastRemoteObject\&.html for further information\&. -.PP -The \f3rmic\fR compiler generates stub and skeleton class files using the Java Remote Method Protocol (JRMP) and stub and tie class files (IIOP protocol) for remote objects\&. These class 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 \f3java\&.rmi\&.Remote\fR\&. The class names in the \f3rmic\fR command must be for classes that were compiled successfully with the \f3javac\fR command and must be fully package qualified\&. For example, running the \f3rmic\fR command on the class file name \f3HelloImpl\fR as shown here creates the \f3HelloImpl_Stub\&.class\fRfile in the hello subdirectory (named for the class\&'s package): -.sp -.nf -\f3rmic hello\&.HelloImpl\fP -.fi -.nf -\f3\fP -.fi -.sp -A skeleton for a remote object is a JRMP protocol server-side entity that has a method that dispatches calls to the remote object implementation\&. -.PP -A tie for a remote object is a server-side entity similar to a skeleton, but communicates with the client with the IIOP protocol\&. -.PP -A stub is a client-side proxy for a remote object that is responsible for communicating method invocations on remote objects to the server where the actual remote object implementation resides\&. A client\&'s reference to a remote object, therefore, is actually a reference to a local stub\&. -.PP -By default, the \f3rmic\fR command generates stub classes that use the 1\&.2 JRMP stub protocol version only, as though the \f3-v1\&.2\fR option was specified\&. The \f3-vcompat\fR option was the default in releases before 5\&.0\&. Use the \f3-iiop\fR option to generate stub and tie classes for the IIOP protocol\&. See Options\&. -.PP -A stub implements only the remote interfaces, and 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, a client can use the Java programming language built-in operators for casting and type checking\&. For IIOP, the \f3PortableRemoteObject\&.narrow\fR method must be used\&. -.SH OPTIONS -.TP --bootclasspath \fIpath\fR -.br -Overrides the location of bootstrap class files\&. -.TP --classpath path -.br -Specifies the path the \f3rmic\fR command uses to look up classes\&. This option overrides the default or the \f3CLASSPATH\fR environment variable when it is set\&. Directories are separated by colons\&. The general format for path is: \f3\&.:<your_path>\fR, for example: \f3\&.:/usr/local/java/classes\fR\&. -.TP --d \fIdirectory\fR -.br -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 following command places the stub and skeleton classes derived from MyClass into the directory /java/classes/exampleclass\&. -.sp -.nf -\f3rmic \-d /java/classes exampleclass\&.MyClass\fP -.fi -.nf -\f3\fP -.fi -.sp - - -If the \f3-d\fR option is not specified, then the default behavior is as if \f3-d \&.\fR was specified\&. The package hierarchy of the target class is created in the current directory, and stub/tie/skeleton files are placed within it\&. In some earlier releases of the \f3rmic\fR command, if the \f3-d\fR option was not specified, then the package hierarchy was not created, and all of the output files were placed directly in the current directory\&. -.TP --extdirs \fIpath\fR -.br -Overrides the location of installed extensions\&. -.TP --g -.br -Enables the generation of all debugging information, including local variables\&. By default, only line number information is generated\&. -.TP --idl -.br -Causes the \f3rmic\fR command to generate OMG IDL for the classes specified and any classes referenced\&. IDL provides a purely declarative, programming language-independent way to specify an API for an object\&. The IDL is used as a specification for methods and data that can be written in and called from any language that provides CORBA bindings\&. This includes Java and C++ among others\&. See Java IDL: IDL to Java Language Mapping at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/mapping/jidlMapping\&.html - -When the \f3-idl\fR option is used, other options also include: -.RS -.TP 0.2i -\(bu -The \f3-always\fR or \f3-alwaysgenerate\fR options force regeneration even when existing stubs/ties/IDL are newer than the input class\&. -.TP 0.2i -\(bu -The \f3-factory\fR option uses the \f3factory\fR keyword in generated IDL\&. -.TP 0.2i -\(bu -The \f3-idlModule\fR from J\f3avaPackage[\&.class]\fR\f3toIDLModule\fR specifies \f3IDLEntity\fR package mapping, for example: \f3-idlModule\fR\f3my\&.module my::real::idlmod\fR\&. -.TP 0.2i -\(bu -\f3-idlFile\fR\f3fromJavaPackage[\&.class] toIDLFile\fR specifies \f3IDLEntity\fR file mapping, for example: \f3-idlFile test\&.pkg\&.X TEST16\&.idl\fR\&. -.RE - -.TP --iiop -.br -Causes the \f3rmic\fR command 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 reference to a remote object is 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\&. - -If you call the \f3rmic\fR command with the \f3-iiop\fR, then it generates stubs and ties that conform to this naming convention: -.sp -.nf -\f3_<implementationName>_stub\&.class\fP -.fi -.nf -\f3_<interfaceName>_tie\&.class\fP -.fi -.nf -\f3\fP -.fi -.sp -.RS -.TP 0.2i -\(bu -When you use the \f3-iiop\fR option, other options also include: -.TP 0.2i -\(bu -The \f3-always\fR or \f3-alwaysgenerate\fR options force regeneration even when existing stubs/ties/IDL are newer than the input class\&. -.TP 0.2i -\(bu -The \f3-nolocalstubs\fR option means do not create stubs optimized for same-process clients and servers\&. -.TP 0.2i -\(bu -The \f3-noValueMethods\fR option must be used with the \f3-idl\fR option\&. The \f3-noValueMethods\fR option prevents the addition of \f3valuetype\fR methods and initializers to emitted IDL\&. These methods and initializers are optional for valuetypes, and are generated unless the \f3-noValueMethods\fR option is specified with the \f3-idl\fR option\&. -.TP 0.2i -\(bu -The \f3-poa\fR option changes the inheritance from \f3org\&.omg\&.CORBA_2_3\&.portable\&.ObjectImpl\fR to \f3org\&.omg\&.PortableServer\&.Servant\fR\&. The \f3PortableServer\fR module for the Portable Object Adapter (POA) defines the native \f3Servant\fR type\&. In the Java programming language, the \f3Servant\fR type is mapped to the \f3Java org\&.omg\&.PortableServer\&.Servant\fR class\&. It serves as the base class for all POA servant implementations and provides a number of methods that can be called by the application programmer, and methods that are called by the POA and that can 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 --J -.br -Used with any Java command, the \f3-J\fR option passes the argument that follows the \f3-J\fR (no spaces between the \f3-J\fRand the argument) to the Java interpreter -.TP --keep or -keepgenerated -.br -Retains the generated \f3\&.java\fR source files for the stub, skeleton, and tie classes and writes them to the same directory as the\f3\&.class\fR files\&. -.TP --nowarn -.br -Turns off warnings\&. When the \f3-nowarn\fR options is used\&. The compiler does not print out any warnings\&. -.TP --nowrite -.br -Does not write compiled classes to the file system\&. -.TP --vcompat (deprecated) -.br -Generates stub and skeleton classes that are compatible with both the 1\&.1 and 1\&.2 JRMP stub protocol versions\&. This option was the default in releases before 5\&.0\&. The generated stub classes use the 1\&.1 stub protocol version when loaded in a JDK 1\&.1 virtual machine and use the 1\&.2 stub protocol version when loaded into a 1\&.2 (or later) virtual machine\&. The generated skeleton classes support both 1\&.1 and 1\&.2 stub protocol versions\&. The generated classes are relatively large to support both modes of operation\&. Note: This option has been deprecated\&. See Description\&. -.TP --verbose -.br -Causes the compiler and linker to print out messages about what classes are being compiled and what class files are being loaded\&. -.TP --v1\&.1 (deprecated) -.br -Generates stub and skeleton classes for the 1\&.1 JRMP stub protocol version only\&. The \f3-v1\&.1\fR option is only useful for generating stub classes that are serialization-compatible with preexisting, statically deployed stub classes that were generated by the \f3rmic\fR command from JDK 1\&.1 and that cannot be upgraded (and dynamic class loading is not being used)\&. Note: This option has been deprecated\&. See Description\&. -.TP --v1\&.2 (deprecated) -.br -(Default) Generates stub classes for the 1\&.2 JRMP stub protocol version only\&. No skeleton classes are generated because skeleton classes are not used with the 1\&.2 stub protocol version\&. The generated stub classes do not work when they are loaded into a JDK 1\&.1 virtual machine\&. Note: This option has been deprecated\&. See Description\&. -.SH ENVIRONMENT\ VARIABLES -.TP -CLASSPATH -Used to provide the system a path to user-defined classes\&. Directories are separated by colons, for example: \f3\&.:/usr/local/java/classes\fR\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -javac(1) -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -Setting the Class Path -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1997, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Remote Method Invocation (RMI) Tools +.\" Title: rmic.1 +.\" +.if n .pl 99999 +.TH rmic 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +rmic \- Generates stub, skeleton, and tie classes for remote objects that use the Java Remote Method Protocol (JRMP) or Internet Inter-Orb protocol (IIOP)\&. Also generates Object Management Group (OMG) Interface Definition Language (IDL) +.SH SYNOPSIS +.sp +.nf + +\fBrmic\fR [ \fIoptions\fR ] \fIpackage\-qualified\-class\-names\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line \f3options\fR\&. See Options\&. +.TP +\fIpackage-qualified-class-names\fR +Class names that include their packages, for example, \f3java\&.awt\&.Color\fR\&. +.SH DESCRIPTION +\fIDeprecation Note:\fR Support for static generation of Java Remote Method Protocol (JRMP) stubs and skeletons has been deprecated\&. Oracle recommends that you use dynamically generated JRMP stubs instead, eliminating the need to use this tool for JRMP-based applications\&. See the \f3java\&.rmi\&.server\&.UnicastRemoteObject\fR specification at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/server/UnicastRemoteObject\&.html for further information\&. +.PP +The \f3rmic\fR compiler generates stub and skeleton class files using the Java Remote Method Protocol (JRMP) and stub and tie class files (IIOP protocol) for remote objects\&. These class 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 \f3java\&.rmi\&.Remote\fR\&. The class names in the \f3rmic\fR command must be for classes that were compiled successfully with the \f3javac\fR command and must be fully package qualified\&. For example, running the \f3rmic\fR command on the class file name \f3HelloImpl\fR as shown here creates the \f3HelloImpl_Stub\&.class\fRfile in the hello subdirectory (named for the class\&'s package): +.sp +.nf +\f3rmic hello\&.HelloImpl\fP +.fi +.nf +\f3\fP +.fi +.sp +A skeleton for a remote object is a JRMP protocol server-side entity that has a method that dispatches calls to the remote object implementation\&. +.PP +A tie for a remote object is a server-side entity similar to a skeleton, but communicates with the client with the IIOP protocol\&. +.PP +A stub is a client-side proxy for a remote object that is responsible for communicating method invocations on remote objects to the server where the actual remote object implementation resides\&. A client\&'s reference to a remote object, therefore, is actually a reference to a local stub\&. +.PP +By default, the \f3rmic\fR command generates stub classes that use the 1\&.2 JRMP stub protocol version only, as though the \f3-v1\&.2\fR option was specified\&. The \f3-vcompat\fR option was the default in releases before 5\&.0\&. Use the \f3-iiop\fR option to generate stub and tie classes for the IIOP protocol\&. See Options\&. +.PP +A stub implements only the remote interfaces, and 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, a client can use the Java programming language built-in operators for casting and type checking\&. For IIOP, the \f3PortableRemoteObject\&.narrow\fR method must be used\&. +.SH OPTIONS +.TP +-bootclasspath \fIpath\fR +.br +Overrides the location of bootstrap class files\&. +.TP +-classpath path +.br +Specifies the path the \f3rmic\fR command uses to look up classes\&. This option overrides the default or the \f3CLASSPATH\fR environment variable when it is set\&. Directories are separated by colons\&. The general format for path is: \f3\&.:<your_path>\fR, for example: \f3\&.:/usr/local/java/classes\fR\&. +.TP +-d \fIdirectory\fR +.br +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 following command places the stub and skeleton classes derived from MyClass into the directory /java/classes/exampleclass\&. +.sp +.nf +\f3rmic \-d /java/classes exampleclass\&.MyClass\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If the \f3-d\fR option is not specified, then the default behavior is as if \f3-d \&.\fR was specified\&. The package hierarchy of the target class is created in the current directory, and stub/tie/skeleton files are placed within it\&. In some earlier releases of the \f3rmic\fR command, if the \f3-d\fR option was not specified, then the package hierarchy was not created, and all of the output files were placed directly in the current directory\&. +.TP +-extdirs \fIpath\fR +.br +Overrides the location of installed extensions\&. +.TP +-g +.br +Enables the generation of all debugging information, including local variables\&. By default, only line number information is generated\&. +.TP +-idl +.br +Causes the \f3rmic\fR command to generate OMG IDL for the classes specified and any classes referenced\&. IDL provides a purely declarative, programming language-independent way to specify an API for an object\&. The IDL is used as a specification for methods and data that can be written in and called from any language that provides CORBA bindings\&. This includes Java and C++ among others\&. See Java IDL: IDL to Java Language Mapping at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/mapping/jidlMapping\&.html + +When the \f3-idl\fR option is used, other options also include: +.RS +.TP 0.2i +\(bu +The \f3-always\fR or \f3-alwaysgenerate\fR options force regeneration even when existing stubs/ties/IDL are newer than the input class\&. +.TP 0.2i +\(bu +The \f3-factory\fR option uses the \f3factory\fR keyword in generated IDL\&. +.TP 0.2i +\(bu +The \f3-idlModule\fR from J\f3avaPackage[\&.class]\fR\f3toIDLModule\fR specifies \f3IDLEntity\fR package mapping, for example: \f3-idlModule\fR\f3my\&.module my::real::idlmod\fR\&. +.TP 0.2i +\(bu +\f3-idlFile\fR\f3fromJavaPackage[\&.class] toIDLFile\fR specifies \f3IDLEntity\fR file mapping, for example: \f3-idlFile test\&.pkg\&.X TEST16\&.idl\fR\&. +.RE + +.TP +-iiop +.br +Causes the \f3rmic\fR command 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 reference to a remote object is 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\&. + +If you call the \f3rmic\fR command with the \f3-iiop\fR, then it generates stubs and ties that conform to this naming convention: +.sp +.nf +\f3_<implementationName>_stub\&.class\fP +.fi +.nf +\f3_<interfaceName>_tie\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp +.RS +.TP 0.2i +\(bu +When you use the \f3-iiop\fR option, other options also include: +.TP 0.2i +\(bu +The \f3-always\fR or \f3-alwaysgenerate\fR options force regeneration even when existing stubs/ties/IDL are newer than the input class\&. +.TP 0.2i +\(bu +The \f3-nolocalstubs\fR option means do not create stubs optimized for same-process clients and servers\&. +.TP 0.2i +\(bu +The \f3-noValueMethods\fR option must be used with the \f3-idl\fR option\&. The \f3-noValueMethods\fR option prevents the addition of \f3valuetype\fR methods and initializers to emitted IDL\&. These methods and initializers are optional for valuetypes, and are generated unless the \f3-noValueMethods\fR option is specified with the \f3-idl\fR option\&. +.TP 0.2i +\(bu +The \f3-poa\fR option changes the inheritance from \f3org\&.omg\&.CORBA_2_3\&.portable\&.ObjectImpl\fR to \f3org\&.omg\&.PortableServer\&.Servant\fR\&. The \f3PortableServer\fR module for the Portable Object Adapter (POA) defines the native \f3Servant\fR type\&. In the Java programming language, the \f3Servant\fR type is mapped to the \f3Java org\&.omg\&.PortableServer\&.Servant\fR class\&. It serves as the base class for all POA servant implementations and provides a number of methods that can be called by the application programmer, and methods that are called by the POA and that can 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 +-J +.br +Used with any Java command, the \f3-J\fR option passes the argument that follows the \f3-J\fR (no spaces between the \f3-J\fRand the argument) to the Java interpreter +.TP +-keep or -keepgenerated +.br +Retains the generated \f3\&.java\fR source files for the stub, skeleton, and tie classes and writes them to the same directory as the\f3\&.class\fR files\&. +.TP +-nowarn +.br +Turns off warnings\&. When the \f3-nowarn\fR options is used\&. The compiler does not print out any warnings\&. +.TP +-nowrite +.br +Does not write compiled classes to the file system\&. +.TP +-vcompat (deprecated) +.br +Generates stub and skeleton classes that are compatible with both the 1\&.1 and 1\&.2 JRMP stub protocol versions\&. This option was the default in releases before 5\&.0\&. The generated stub classes use the 1\&.1 stub protocol version when loaded in a JDK 1\&.1 virtual machine and use the 1\&.2 stub protocol version when loaded into a 1\&.2 (or later) virtual machine\&. The generated skeleton classes support both 1\&.1 and 1\&.2 stub protocol versions\&. The generated classes are relatively large to support both modes of operation\&. Note: This option has been deprecated\&. See Description\&. +.TP +-verbose +.br +Causes the compiler and linker to print out messages about what classes are being compiled and what class files are being loaded\&. +.TP +-v1\&.1 (deprecated) +.br +Generates stub and skeleton classes for the 1\&.1 JRMP stub protocol version only\&. The \f3-v1\&.1\fR option is only useful for generating stub classes that are serialization-compatible with preexisting, statically deployed stub classes that were generated by the \f3rmic\fR command from JDK 1\&.1 and that cannot be upgraded (and dynamic class loading is not being used)\&. Note: This option has been deprecated\&. See Description\&. +.TP +-v1\&.2 (deprecated) +.br +(Default) Generates stub classes for the 1\&.2 JRMP stub protocol version only\&. No skeleton classes are generated because skeleton classes are not used with the 1\&.2 stub protocol version\&. The generated stub classes do not work when they are loaded into a JDK 1\&.1 virtual machine\&. Note: This option has been deprecated\&. See Description\&. +.SH ENVIRONMENT\ VARIABLES +.TP +CLASSPATH +Used to provide the system a path to user-defined classes\&. Directories are separated by colons, for example: \f3\&.:/usr/local/java/classes\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +javac(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +Setting the Class Path +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/rmid.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/rmid.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,314 +1,314 @@ -'\" t -.\" Copyright (c) 1998, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Remote Method Invocation (RMI) Tools -.\" Title: rmid.1 -.\" -.if n .pl 99999 -.TH rmid 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -rmid \- Starts the activation system daemon that enables objects to be registered and activated in a Java Virtual Machine (JVM)\&. -.SH SYNOPSIS -.sp -.nf - -\fBrmid\fR [\fIoptions\fR] -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.SH DESCRIPTION -The \f3rmid\fR command 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 JVM\&. For details on how to write programs that use activatable objects, the \fIUsing Activation\fR tutorial at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/rmi/activation/overview\&.html -.PP -Start the daemon by executing the \f3rmid\fR command and specifying a security policy file, as follows: -.sp -.nf -\f3rmid \-J\-Djava\&.security\&.policy=rmid\&.policy\fP -.fi -.nf -\f3\fP -.fi -.sp -When you run Oracle\(cqs implementation of the \f3rmid\fR command, by default you must specify a security policy file so that the \f3rmid\fR command can verify whether or not the information in each \f3ActivationGroupDesc\fR is allowed to be used to start a JVM for an activation group\&. Specifically, the command and options specified by the \f3CommandEnvironment\fR and any properties passed to an \f3ActivationGroupDesc\fR constructor must now be explicitly allowed in the security policy file for the \f3rmid\fR command\&. The value of the \f3sun\&.rmi\&.activation\&.execPolicy\fR property dictates the policy that the \f3rmid\fR command uses to determine whether or not the information in an \f3ActivationGroupDesc\fR can be used to start a JVM for an activation group\&. For more information see the description of the -J-Dsun\&.rmi\&.activation\&.execPolicy=policy option\&. -.PP -Executing the \f3rmid\fR command starts the Activator and an internal registry on the default port1098 and binds an \f3ActivationSystem\fR to the name \f3java\&.rmi\&.activation\&.ActivationSystem\fR in this internal registry\&. -.PP -To specify an alternate port for the registry, you must specify the \f3-port\fR option when you execute the \f3rmid\fR command\&. For example, the following command starts the activation system daemon and a registry on the registry\&'s default port, 1099\&. -.sp -.nf -\f3rmid \-J\-Djava\&.security\&.policy=rmid\&.policy \-port 1099\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH START\ RMID\ ON\ DEMAND -An alternative to starting \f3rmid\fR from the command line is to configure \f3inetd\fR (Oracle Solaris) or \f3xinetd\fR (Linux) to start \f3rmid\fR on demand\&. -.PP -When RMID starts, it attempts to obtain an inherited channel (inherited from \f3inetd\fR/\f3xinetd\fR) by calling the \f3System\&.inheritedChannel\fR method\&. If the inherited channel is null or not an instance of \f3java\&.nio\&.channels\&.ServerSocketChannel\fR, then RMID assumes that it was not started by \f3inetd\fR/\f3xinetd\fR, and it starts as previously described\&. -.PP -If the inherited channel is a \f3ServerSocketChannel\fR instance, then RMID uses the \f3java\&.net\&.ServerSocket\fR obtained from the \f3ServerSocketChannel\fR as the server socket that accepts requests for the remote objects it exports: The registry in which the \f3java\&.rmi\&.activation\&.ActivationSystem\fR is bound and the \f3java\&.rmi\&.activation\&.Activator\fR remote object\&. In this mode, RMID behaves the same as when it is started from the command line, except in the following cases: -.TP 0.2i -\(bu -Output printed to \f3System\&.err\fR is redirected to a file\&. This file is located in the directory specified by the \f3java\&.io\&.tmpdir\fR system property (typically \f3/var/tmp\fR or \f3/tmp\fR) with the prefix \f3rmid-err\fR and the suffix \f3tmp\fR\&. -.TP 0.2i -\(bu -The \f3-port\fR option is not allowed\&. If this option is specified, then RMID exits with an error message\&. -.TP 0.2i -\(bu -The \f3-log\fR option is required\&. If this option is not specified, then RMID exits with an error message -.PP -See the man pages for \f3inetd\fR (Oracle Solaris) or \f3xinetd\fR (Linux) for details on how to configure services to be started on demand\&. -.SH OPTIONS -.TP --C\fIoption\fR -.br -Specifies an option that is passed as a command-line argument to each child process (activation group) of the \f3rmid\fR command when that process is created\&. For example, you could pass a property to each virtual machine spawned by the activation system daemon: -.sp -.nf -\f3rmid \-C\-Dsome\&.property=value\fP -.fi -.nf -\f3\fP -.fi -.sp - - -This ability to pass command-line arguments to child processes can be useful for debugging\&. For example, the following command enables server-call logging in all child JVMs\&. -.sp -.nf -\f3rmid \-C\-Djava\&.rmi\&.server\&.logCalls=true\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --J\fIoption\fR -.br -Specifies an option that is passed to the Java interpreter running RMID\&. For example, to specify that the \f3rmid\fR command use a policy file named \f3rmid\&.policy\fR, the \f3-J\fR option can be used to define the \f3java\&.security\&.policy\fR property on the \f3rmid\fR command line, for example: -.sp -.nf -\f3rmid \-J\-Djava\&.security\&.policy\-rmid\&.policy\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --J-Dsun\&.rmi\&.activation\&.execPolicy=\fIpolicy\fR -.br -Specifies the policy that RMID employs to check commands and command-line options used to start the JVM in which an activation group runs\&. Please note that this option exists only in Oracle\&'s implementation of the Java RMI activation daemon\&. If this property is not specified on the command line, then the result is the same as though \f3-J-Dsun\&.rmi\&.activation\&.execPolicy=default\fR were specified\&. The possible values of \f3policy\fR can be \f3default\fR, \f3policyClassName\fR, or \f3none\fR\&. -.RS -.TP 0.2i -\(bu -default - -The \f3default\fR or unspecified value \f3execPolicy\fR allows the \f3rmid\fR command to execute commands with specific command-line options only when the \f3rmid\fR command was granted permission to execute those commands and options in the security policy file that the \f3rmid\fR command uses\&. Only the default activation group implementation can be used with the default execution policy\&. - -The \f3rmid\fR command starts a JVM for an activation group with the information in the group\&'s registered activation group descriptor, an \f3ActivationGroupDesc\fR\&. The group descriptor specifies an optional \f3ActivationGroupDesc\&.CommandEnvironment\fR that includes the command to execute to start the activation group and any command-line options to be added to the command line\&. By default, the \f3rmid\fR command uses the \f3java\fR command found in \f3java\&.home\fR\&. The group descriptor also contains properties overrides that are added to the command line as options defined as: \f3-D<property>=<value>\fR\&.The \f3com\&.sun\&.rmi\&.rmid\&.ExecPermission\fR permission grants the \f3rmid\fR command permission to execute a command that is specified in the group descriptor\&'s \f3CommandEnvironment\fR to start an activation group\&. The \f3com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fR permission enables the \f3rmid\fR command to use command-line options, specified as properties overrides in the group descriptor or as options in the \f3CommandEnvironment\fR when starting the activation group\&.When granting the \f3rmid\fR command permission to execute various commands and options, the permissions \f3ExecPermission\fR and \f3ExecOptionPermission\fR must be granted to all code sources\&. - -\fIExecPermission\fR - -The \f3ExecPermission\fR class represents permission for the \f3rmid\fR command to execute a specific command to start an activation group\&. - -\fISyntax\fR: The name of an \f3ExecPermission\fR is the path name of a command to grant the \f3rmid\fR command permission to execute\&. A path name that ends in a slash (/) and an asterisk (*) indicates that all of the files contained in that directory where slash is the file-separator character, \f3File\&.separatorChar\fR\&. A path name that ends in a slash (/) and a minus sign (-) indicates all files and subdirectories contained in that directory (recursively)\&. A path name that consists of the special token \f3<<ALL FILES>>\fR matches any file\&. - -A path name that consists of an asterisk (*) indicates all the files in the current directory\&. A path name that consists of a minus sign (-) indicates all the files in the current directory and (recursively) all files and subdirectories contained in the current directory\&. - -\fIExecOptionPermission\fR - -The \f3ExecOptionPermission\fR class represents permission for the \f3rmid\fR command to use a specific command-line option when starting an activation group\&. The name of an \f3ExecOptionPermission\fR is the value of a command-line option\&. - -\fISyntax\fR: Options support a limited wild card scheme\&. An asterisk signifies a wild card match, and it can appear as the option name itself (matches any option), or an asterisk (*) can appear at the end of the option name only when the asterisk (*) follows a dot (\&.) or an equals sign (=)\&. - -For example: \f3*\fR or \f3-Dmydir\&.*\fR or \f3-Da\&.b\&.c=*\fR is valid, but \f3*mydir\fR or \f3-Da*b\fR or \f3ab*\fR is not\&. - -\fIPolicy file for rmid\fR - -When you grant the \f3rmid\fR command permission to execute various commands and options, the permissions \f3ExecPermission\fR and \f3ExecOptionPermission\fR must be granted to all code sources (universally)\&. It is safe to grant these permissions universally because only the \f3rmid\fR command checks these permissions\&. - -An example policy file that grants various execute permissions to the \f3rmid\fR command is: -.sp -.nf -\f3grant {\fP -.fi -.nf -\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecPermission\fP -.fi -.nf -\f3 "/files/apps/java/jdk1\&.7\&.0/solaris/bin/java";\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecPermission\fP -.fi -.nf -\f3 "/files/apps/rmidcmds/*";\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP -.fi -.nf -\f3 "\-Djava\&.security\&.policy=/files/policies/group\&.policy";\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP -.fi -.nf -\f3 "\-Djava\&.security\&.debug=*";\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP -.fi -.nf -\f3 "\-Dsun\&.rmi\&.*";\fP -.fi -.nf -\f3};\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The first permission granted allows the \f3rmid\fR tcommand o execute the 1\&.7\&.0 release of the \f3java\fR command, specified by its explicit path name\&. By default, the version of the \f3java\fR command found in \f3java\&.home\fR is used (the same one that the \f3rmid\fR command uses), and does not need to be specified in the policy file\&. The second permission allows the \f3rmid\fR command to execute any command in the directory \f3/files/apps/rmidcmds\fR\&. - -The third permission granted, an \f3ExecOptionPermission\fR, allows the \f3rmid\fR command to start an activation group that defines the security policy file to be \f3/files/policies/group\&.policy\fR\&. The next permission allows the \f3java\&.security\&.debug property\fR to be used by an activation group\&. The last permission allows any property in the \f3sun\&.rmi property\fR name hierarchy to be used by activation groups\&. - -To start the \f3rmid\fR command with a policy file, the \f3java\&.security\&.policy\fR property needs to be specified on the \f3rmid\fR command line, for example: - -\f3rmid -J-Djava\&.security\&.policy=rmid\&.policy\fR\&. -.TP 0.2i -\(bu -<policyClassName> - -If the default behavior is not flexible enough, then an administrator can provide, when starting the \f3rmid\fR command, the name of a class whose \f3checkExecCommand\fR method is executed to check commands to be executed by the \f3rmid\fR command\&. - -The \f3policyClassName\fR specifies a public class with a public, no-argument constructor and an implementation of the following \f3checkExecCommand\fR method: -.sp -.nf -\f3 public void checkExecCommand(ActivationGroupDesc desc, String[] command)\fP -.fi -.nf -\f3 throws SecurityException;\fP -.fi -.nf -\f3\fP -.fi -.sp - - -Before starting an activation group, the \f3rmid\fR command calls the policy\&'s \f3checkExecCommand\fR method and passes to it the activation group descriptor and an array that contains the complete command to start the activation group\&. If the \f3checkExecCommand\fR throws a \f3SecurityException\fR, then the \f3rmid\fR command does not start the activation group and an \f3ActivationException\fR is thrown to the caller attempting to activate the object\&. -.TP 0.2i -\(bu -none - -If the \f3sun\&.rmi\&.activation\&.execPolicy\fR property value is \f3none\fR, then the \f3rmid\fR command does not perform any validation of commands to start activation groups\&. -.RE - -.TP --log \fIdir\fR -.br -Specifies the name of the directory the activation system daemon uses to write its database and associated information\&. The log directory defaults to creating a log, in the directory in which the \f3rmid\fR command was executed\&. -.TP --port \fIport\fR -.br -Specifies the port the registry uses\&. The activation system daemon binds the \f3ActivationSystem\fR, with the name \f3java\&.rmi\&.activation\&.ActivationSystem\fR, in this registry\&. The \f3ActivationSystem\fR on the local machine can be obtained using the following \f3Naming\&.lookup\fR method call: -.sp -.nf -\f3import java\&.rmi\&.*; \fP -.fi -.nf -\f3 import java\&.rmi\&.activation\&.*;\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 ActivationSystem system; system = (ActivationSystem)\fP -.fi -.nf -\f3 Naming\&.lookup("//:port/java\&.rmi\&.activation\&.ActivationSystem");\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --stop -.br -Stops the current invocation of the \f3rmid\fR command for a port specified by the \f3-port\fR option\&. If no port is specified, then this option stops the \f3rmid\fR invocation running on port 1098\&. -.SH ENVIRONMENT\ VARIABLES -.TP -CLASSPATH -Used to provide the system a path to user-defined classes\&. Directories are separated by colons, for example: \f3\&.:/usr/local/java/classes\fR\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -Setting the Class Path -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1998, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Remote Method Invocation (RMI) Tools +.\" Title: rmid.1 +.\" +.if n .pl 99999 +.TH rmid 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +rmid \- Starts the activation system daemon that enables objects to be registered and activated in a Java Virtual Machine (JVM)\&. +.SH SYNOPSIS +.sp +.nf + +\fBrmid\fR [\fIoptions\fR] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.SH DESCRIPTION +The \f3rmid\fR command 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 JVM\&. For details on how to write programs that use activatable objects, the \fIUsing Activation\fR tutorial at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/rmi/activation/overview\&.html +.PP +Start the daemon by executing the \f3rmid\fR command and specifying a security policy file, as follows: +.sp +.nf +\f3rmid \-J\-Djava\&.security\&.policy=rmid\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp +When you run Oracle\(cqs implementation of the \f3rmid\fR command, by default you must specify a security policy file so that the \f3rmid\fR command can verify whether or not the information in each \f3ActivationGroupDesc\fR is allowed to be used to start a JVM for an activation group\&. Specifically, the command and options specified by the \f3CommandEnvironment\fR and any properties passed to an \f3ActivationGroupDesc\fR constructor must now be explicitly allowed in the security policy file for the \f3rmid\fR command\&. The value of the \f3sun\&.rmi\&.activation\&.execPolicy\fR property dictates the policy that the \f3rmid\fR command uses to determine whether or not the information in an \f3ActivationGroupDesc\fR can be used to start a JVM for an activation group\&. For more information see the description of the -J-Dsun\&.rmi\&.activation\&.execPolicy=policy option\&. +.PP +Executing the \f3rmid\fR command starts the Activator and an internal registry on the default port1098 and binds an \f3ActivationSystem\fR to the name \f3java\&.rmi\&.activation\&.ActivationSystem\fR in this internal registry\&. +.PP +To specify an alternate port for the registry, you must specify the \f3-port\fR option when you execute the \f3rmid\fR command\&. For example, the following command starts the activation system daemon and a registry on the registry\&'s default port, 1099\&. +.sp +.nf +\f3rmid \-J\-Djava\&.security\&.policy=rmid\&.policy \-port 1099\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH START\ RMID\ ON\ DEMAND +An alternative to starting \f3rmid\fR from the command line is to configure \f3inetd\fR (Oracle Solaris) or \f3xinetd\fR (Linux) to start \f3rmid\fR on demand\&. +.PP +When RMID starts, it attempts to obtain an inherited channel (inherited from \f3inetd\fR/\f3xinetd\fR) by calling the \f3System\&.inheritedChannel\fR method\&. If the inherited channel is null or not an instance of \f3java\&.nio\&.channels\&.ServerSocketChannel\fR, then RMID assumes that it was not started by \f3inetd\fR/\f3xinetd\fR, and it starts as previously described\&. +.PP +If the inherited channel is a \f3ServerSocketChannel\fR instance, then RMID uses the \f3java\&.net\&.ServerSocket\fR obtained from the \f3ServerSocketChannel\fR as the server socket that accepts requests for the remote objects it exports: The registry in which the \f3java\&.rmi\&.activation\&.ActivationSystem\fR is bound and the \f3java\&.rmi\&.activation\&.Activator\fR remote object\&. In this mode, RMID behaves the same as when it is started from the command line, except in the following cases: +.TP 0.2i +\(bu +Output printed to \f3System\&.err\fR is redirected to a file\&. This file is located in the directory specified by the \f3java\&.io\&.tmpdir\fR system property (typically \f3/var/tmp\fR or \f3/tmp\fR) with the prefix \f3rmid-err\fR and the suffix \f3tmp\fR\&. +.TP 0.2i +\(bu +The \f3-port\fR option is not allowed\&. If this option is specified, then RMID exits with an error message\&. +.TP 0.2i +\(bu +The \f3-log\fR option is required\&. If this option is not specified, then RMID exits with an error message +.PP +See the man pages for \f3inetd\fR (Oracle Solaris) or \f3xinetd\fR (Linux) for details on how to configure services to be started on demand\&. +.SH OPTIONS +.TP +-C\fIoption\fR +.br +Specifies an option that is passed as a command-line argument to each child process (activation group) of the \f3rmid\fR command when that process is created\&. For example, you could pass a property to each virtual machine spawned by the activation system daemon: +.sp +.nf +\f3rmid \-C\-Dsome\&.property=value\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This ability to pass command-line arguments to child processes can be useful for debugging\&. For example, the following command enables server-call logging in all child JVMs\&. +.sp +.nf +\f3rmid \-C\-Djava\&.rmi\&.server\&.logCalls=true\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-J\fIoption\fR +.br +Specifies an option that is passed to the Java interpreter running RMID\&. For example, to specify that the \f3rmid\fR command use a policy file named \f3rmid\&.policy\fR, the \f3-J\fR option can be used to define the \f3java\&.security\&.policy\fR property on the \f3rmid\fR command line, for example: +.sp +.nf +\f3rmid \-J\-Djava\&.security\&.policy\-rmid\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-J-Dsun\&.rmi\&.activation\&.execPolicy=\fIpolicy\fR +.br +Specifies the policy that RMID employs to check commands and command-line options used to start the JVM in which an activation group runs\&. Please note that this option exists only in Oracle\&'s implementation of the Java RMI activation daemon\&. If this property is not specified on the command line, then the result is the same as though \f3-J-Dsun\&.rmi\&.activation\&.execPolicy=default\fR were specified\&. The possible values of \f3policy\fR can be \f3default\fR, \f3policyClassName\fR, or \f3none\fR\&. +.RS +.TP 0.2i +\(bu +default + +The \f3default\fR or unspecified value \f3execPolicy\fR allows the \f3rmid\fR command to execute commands with specific command-line options only when the \f3rmid\fR command was granted permission to execute those commands and options in the security policy file that the \f3rmid\fR command uses\&. Only the default activation group implementation can be used with the default execution policy\&. + +The \f3rmid\fR command starts a JVM for an activation group with the information in the group\&'s registered activation group descriptor, an \f3ActivationGroupDesc\fR\&. The group descriptor specifies an optional \f3ActivationGroupDesc\&.CommandEnvironment\fR that includes the command to execute to start the activation group and any command-line options to be added to the command line\&. By default, the \f3rmid\fR command uses the \f3java\fR command found in \f3java\&.home\fR\&. The group descriptor also contains properties overrides that are added to the command line as options defined as: \f3-D<property>=<value>\fR\&.The \f3com\&.sun\&.rmi\&.rmid\&.ExecPermission\fR permission grants the \f3rmid\fR command permission to execute a command that is specified in the group descriptor\&'s \f3CommandEnvironment\fR to start an activation group\&. The \f3com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fR permission enables the \f3rmid\fR command to use command-line options, specified as properties overrides in the group descriptor or as options in the \f3CommandEnvironment\fR when starting the activation group\&.When granting the \f3rmid\fR command permission to execute various commands and options, the permissions \f3ExecPermission\fR and \f3ExecOptionPermission\fR must be granted to all code sources\&. + +\fIExecPermission\fR + +The \f3ExecPermission\fR class represents permission for the \f3rmid\fR command to execute a specific command to start an activation group\&. + +\fISyntax\fR: The name of an \f3ExecPermission\fR is the path name of a command to grant the \f3rmid\fR command permission to execute\&. A path name that ends in a slash (/) and an asterisk (*) indicates that all of the files contained in that directory where slash is the file-separator character, \f3File\&.separatorChar\fR\&. A path name that ends in a slash (/) and a minus sign (-) indicates all files and subdirectories contained in that directory (recursively)\&. A path name that consists of the special token \f3<<ALL FILES>>\fR matches any file\&. + +A path name that consists of an asterisk (*) indicates all the files in the current directory\&. A path name that consists of a minus sign (-) indicates all the files in the current directory and (recursively) all files and subdirectories contained in the current directory\&. + +\fIExecOptionPermission\fR + +The \f3ExecOptionPermission\fR class represents permission for the \f3rmid\fR command to use a specific command-line option when starting an activation group\&. The name of an \f3ExecOptionPermission\fR is the value of a command-line option\&. + +\fISyntax\fR: Options support a limited wild card scheme\&. An asterisk signifies a wild card match, and it can appear as the option name itself (matches any option), or an asterisk (*) can appear at the end of the option name only when the asterisk (*) follows a dot (\&.) or an equals sign (=)\&. + +For example: \f3*\fR or \f3-Dmydir\&.*\fR or \f3-Da\&.b\&.c=*\fR is valid, but \f3*mydir\fR or \f3-Da*b\fR or \f3ab*\fR is not\&. + +\fIPolicy file for rmid\fR + +When you grant the \f3rmid\fR command permission to execute various commands and options, the permissions \f3ExecPermission\fR and \f3ExecOptionPermission\fR must be granted to all code sources (universally)\&. It is safe to grant these permissions universally because only the \f3rmid\fR command checks these permissions\&. + +An example policy file that grants various execute permissions to the \f3rmid\fR command is: +.sp +.nf +\f3grant {\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecPermission\fP +.fi +.nf +\f3 "/files/apps/java/jdk1\&.7\&.0/solaris/bin/java";\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecPermission\fP +.fi +.nf +\f3 "/files/apps/rmidcmds/*";\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP +.fi +.nf +\f3 "\-Djava\&.security\&.policy=/files/policies/group\&.policy";\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP +.fi +.nf +\f3 "\-Djava\&.security\&.debug=*";\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP +.fi +.nf +\f3 "\-Dsun\&.rmi\&.*";\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The first permission granted allows the \f3rmid\fR tcommand o execute the 1\&.7\&.0 release of the \f3java\fR command, specified by its explicit path name\&. By default, the version of the \f3java\fR command found in \f3java\&.home\fR is used (the same one that the \f3rmid\fR command uses), and does not need to be specified in the policy file\&. The second permission allows the \f3rmid\fR command to execute any command in the directory \f3/files/apps/rmidcmds\fR\&. + +The third permission granted, an \f3ExecOptionPermission\fR, allows the \f3rmid\fR command to start an activation group that defines the security policy file to be \f3/files/policies/group\&.policy\fR\&. The next permission allows the \f3java\&.security\&.debug property\fR to be used by an activation group\&. The last permission allows any property in the \f3sun\&.rmi property\fR name hierarchy to be used by activation groups\&. + +To start the \f3rmid\fR command with a policy file, the \f3java\&.security\&.policy\fR property needs to be specified on the \f3rmid\fR command line, for example: + +\f3rmid -J-Djava\&.security\&.policy=rmid\&.policy\fR\&. +.TP 0.2i +\(bu +<policyClassName> + +If the default behavior is not flexible enough, then an administrator can provide, when starting the \f3rmid\fR command, the name of a class whose \f3checkExecCommand\fR method is executed to check commands to be executed by the \f3rmid\fR command\&. + +The \f3policyClassName\fR specifies a public class with a public, no-argument constructor and an implementation of the following \f3checkExecCommand\fR method: +.sp +.nf +\f3 public void checkExecCommand(ActivationGroupDesc desc, String[] command)\fP +.fi +.nf +\f3 throws SecurityException;\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Before starting an activation group, the \f3rmid\fR command calls the policy\&'s \f3checkExecCommand\fR method and passes to it the activation group descriptor and an array that contains the complete command to start the activation group\&. If the \f3checkExecCommand\fR throws a \f3SecurityException\fR, then the \f3rmid\fR command does not start the activation group and an \f3ActivationException\fR is thrown to the caller attempting to activate the object\&. +.TP 0.2i +\(bu +none + +If the \f3sun\&.rmi\&.activation\&.execPolicy\fR property value is \f3none\fR, then the \f3rmid\fR command does not perform any validation of commands to start activation groups\&. +.RE + +.TP +-log \fIdir\fR +.br +Specifies the name of the directory the activation system daemon uses to write its database and associated information\&. The log directory defaults to creating a log, in the directory in which the \f3rmid\fR command was executed\&. +.TP +-port \fIport\fR +.br +Specifies the port the registry uses\&. The activation system daemon binds the \f3ActivationSystem\fR, with the name \f3java\&.rmi\&.activation\&.ActivationSystem\fR, in this registry\&. The \f3ActivationSystem\fR on the local machine can be obtained using the following \f3Naming\&.lookup\fR method call: +.sp +.nf +\f3import java\&.rmi\&.*; \fP +.fi +.nf +\f3 import java\&.rmi\&.activation\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 ActivationSystem system; system = (ActivationSystem)\fP +.fi +.nf +\f3 Naming\&.lookup("//:port/java\&.rmi\&.activation\&.ActivationSystem");\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-stop +.br +Stops the current invocation of the \f3rmid\fR command for a port specified by the \f3-port\fR option\&. If no port is specified, then this option stops the \f3rmid\fR invocation running on port 1098\&. +.SH ENVIRONMENT\ VARIABLES +.TP +CLASSPATH +Used to provide the system a path to user-defined classes\&. Directories are separated by colons, for example: \f3\&.:/usr/local/java/classes\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +Setting the Class Path +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/rmiregistry.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/rmiregistry.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,98 +1,98 @@ -'\" t -.\" Copyright (c) 1997, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Remote Method Invocation (RMI) Tools -.\" Title: rmiregistry.1 -.\" -.if n .pl 99999 -.TH rmiregistry 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -rmiregistry \- Starts a remote object registry on the specified port on the current host\&. -.SH SYNOPSIS -.sp -.nf - -\fBrmiregistry\fR [ \fIport\fR ] -.fi -.sp -.TP -\fIport\fR -The number of a \f3port\fR on the current host at which to start the remote object registry\&. -.SH DESCRIPTION -The \f3rmiregistry\fR command creates and starts a remote object registry on the specified port on the current host\&. If the port is omitted, then the registry is started on port 1099\&. The \f3rmiregistry\fR command produces no output and is typically run in the background, for example: -.sp -.nf -\f3rmiregistry &\fP -.fi -.nf -\f3\fP -.fi -.sp -A remote object registry is a bootstrap naming service that is used by RMI servers on the same host to bind remote objects to names\&. Clients on local and remote hosts can then look up remote objects and make remote method invocations\&. -.PP -The registry is typically used to locate the first remote object on which an application needs to call methods\&. That object then provides application-specific support for finding other objects\&. -.PP -The methods of the \f3java\&.rmi\&.registry\&.LocateRegistry\fR class are used to get a registry operating on the local host or local host and port\&. -.PP -The URL-based methods of the \f3java\&.rmi\&.Naming\fR 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 name (string) to a remote object, rebind a new name to a remote object (overriding the old binding), unbind a remote object, and list the URL bound in the registry\&. -.SH OPTIONS -.TP --J -.br -Used with any Java option to pass the option following the \f3-J\fR (no spaces between the \f3-J\fR and the option) to the Java interpreter\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -\f3java\&.rmi\&.registry\&.LocateRegistry\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/registry/LocateRegistry\&.html -.TP 0.2i -\(bu -\f3java\&.rmi\&.Naming class description\fR at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/Naming\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1997, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Remote Method Invocation (RMI) Tools +.\" Title: rmiregistry.1 +.\" +.if n .pl 99999 +.TH rmiregistry 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +rmiregistry \- Starts a remote object registry on the specified port on the current host\&. +.SH SYNOPSIS +.sp +.nf + +\fBrmiregistry\fR [ \fIport\fR ] +.fi +.sp +.TP +\fIport\fR +The number of a \f3port\fR on the current host at which to start the remote object registry\&. +.SH DESCRIPTION +The \f3rmiregistry\fR command creates and starts a remote object registry on the specified port on the current host\&. If the port is omitted, then the registry is started on port 1099\&. The \f3rmiregistry\fR command produces no output and is typically run in the background, for example: +.sp +.nf +\f3rmiregistry &\fP +.fi +.nf +\f3\fP +.fi +.sp +A remote object registry is a bootstrap naming service that is used by RMI servers on the same host to bind remote objects to names\&. Clients on local and remote hosts can then look up remote objects and make remote method invocations\&. +.PP +The registry is typically used to locate the first remote object on which an application needs to call methods\&. That object then provides application-specific support for finding other objects\&. +.PP +The methods of the \f3java\&.rmi\&.registry\&.LocateRegistry\fR class are used to get a registry operating on the local host or local host and port\&. +.PP +The URL-based methods of the \f3java\&.rmi\&.Naming\fR 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 name (string) to a remote object, rebind a new name to a remote object (overriding the old binding), unbind a remote object, and list the URL bound in the registry\&. +.SH OPTIONS +.TP +-J +.br +Used with any Java option to pass the option following the \f3-J\fR (no spaces between the \f3-J\fR and the option) to the Java interpreter\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +\f3java\&.rmi\&.registry\&.LocateRegistry\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/registry/LocateRegistry\&.html +.TP 0.2i +\(bu +\f3java\&.rmi\&.Naming class description\fR at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/Naming\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/schemagen.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/schemagen.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,121 +1,121 @@ -'\" t -.\" Copyright (c) 2005, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java Web Services Tools -.\" Title: schemagen.1 -.\" -.if n .pl 99999 -.TH schemagen 1 "21 November 2013" "JDK 8" "Java Web Services Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -schemagen \- Generates a schema for every name space that is referenced in your Java classes\&. -.SH SYNOPSIS -.sp -.nf - -\fBschemagen\fR [ \fIoptions\fR ] \fIjava\-files\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIjava-files\fR -The Java class files to be processed\&. -.SH DESCRIPTION -The schema generator creates a schema file for each name space referenced in your Java classes\&. Currently, you cannot control the name of the generated schema files\&. To control the schema file names, see Using SchemaGen with Ant at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/schemagenTask\&.html -.PP -Start the schema generator with the appropriate \f3schemagen\fR shell script in the bin directory for your platform\&. The current schema generator can process either Java source files or class files\&. -.sp -.nf -\f3schemagen\&.sh Foo\&.java Bar\&.java \&.\&.\&.\fP -.fi -.nf -\f3Note: Writing schema1\&.xsd\fP -.fi -.nf -\f3\fP -.fi -.sp -If your java files reference other classes, then those classes must be accessible on your system \f3CLASSPATH\fR environment variable, or they need to be specified in the \f3schemagen\fR command line with the class path options\&. See Options\&. If the referenced files are not accessible or specified, then you get errors when you generate the schema\&. -.SH OPTIONS -.TP --d \fIpath\fR -.br -The location where the \f3schemagen\fR command places processor-generated and \f3javac\fR-generated class files\&. -.TP --cp \fIpath\fR -.br -The location where the \f3schemagen\fR command places user-specified files\&. -.TP --classpath \fIpath\fR -.br -The location where the \f3schemagen\fR command places user-specified files\&. -.TP --encoding \fIencoding\fR -.br -Specifies the encoding to use for \f3apt\fR or \f3javac\fR command invocations\&. -.TP --episode \fIfile\fR -.br -Generates an episode file for separate compilation\&. -.TP --version -.br -Displays release information\&. -.TP --help -.br -Displays a help message\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -Using SchemaGen with Ant at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/schemagenTask\&.html -.TP 0.2i -\(bu -Java Architecture for XML Binding (JAXB) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/xml/jaxb/index\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2005, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Web Services Tools +.\" Title: schemagen.1 +.\" +.if n .pl 99999 +.TH schemagen 1 "21 November 2013" "JDK 8" "Java Web Services Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +schemagen \- Generates a schema for every name space that is referenced in your Java classes\&. +.SH SYNOPSIS +.sp +.nf + +\fBschemagen\fR [ \fIoptions\fR ] \fIjava\-files\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIjava-files\fR +The Java class files to be processed\&. +.SH DESCRIPTION +The schema generator creates a schema file for each name space referenced in your Java classes\&. Currently, you cannot control the name of the generated schema files\&. To control the schema file names, see Using SchemaGen with Ant at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/schemagenTask\&.html +.PP +Start the schema generator with the appropriate \f3schemagen\fR shell script in the bin directory for your platform\&. The current schema generator can process either Java source files or class files\&. +.sp +.nf +\f3schemagen\&.sh Foo\&.java Bar\&.java \&.\&.\&.\fP +.fi +.nf +\f3Note: Writing schema1\&.xsd\fP +.fi +.nf +\f3\fP +.fi +.sp +If your java files reference other classes, then those classes must be accessible on your system \f3CLASSPATH\fR environment variable, or they need to be specified in the \f3schemagen\fR command line with the class path options\&. See Options\&. If the referenced files are not accessible or specified, then you get errors when you generate the schema\&. +.SH OPTIONS +.TP +-d \fIpath\fR +.br +The location where the \f3schemagen\fR command places processor-generated and \f3javac\fR-generated class files\&. +.TP +-cp \fIpath\fR +.br +The location where the \f3schemagen\fR command places user-specified files\&. +.TP +-classpath \fIpath\fR +.br +The location where the \f3schemagen\fR command places user-specified files\&. +.TP +-encoding \fIencoding\fR +.br +Specifies the encoding to use for \f3apt\fR or \f3javac\fR command invocations\&. +.TP +-episode \fIfile\fR +.br +Generates an episode file for separate compilation\&. +.TP +-version +.br +Displays release information\&. +.TP +-help +.br +Displays a help message\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +Using SchemaGen with Ant at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/schemagenTask\&.html +.TP 0.2i +\(bu +Java Architecture for XML Binding (JAXB) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/xml/jaxb/index\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/serialver.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/serialver.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,110 +1,110 @@ -'\" t -.\" Copyright (c) 1997, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Remote Method Invocation (RMI) Tools -.\" Title: serialver.1 -.\" -.if n .pl 99999 -.TH serialver 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -serialver \- Returns the serial version UID for specified classes\&. -.SH SYNOPSIS -.sp -.nf - -\fBserialver\fR [ \fIoptions\fR ] [ \fIclassnames\fR ] -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIclassnames\fR -The classes for which the \f3serialVersionUID\fR is to be returned\&. -.SH DESCRIPTION -The \f3serialver\fR command returns the \f3serialVersionUID\fR for one or more classes in a form suitable for copying into an evolving class\&. When called with no arguments, the \f3serialver\fR command prints a usage line\&. -.SH OPTIONS -.TP --classpath \fIpath-files\fR -.br -Sets the search path for application classes and resources\&. Separate classes and resources with a colon (:)\&. -.TP --show -.br -Displays a simple user interface\&. Enter the full class name and press either the \fIEnter\fR key or the \fIShow\fR button to display the \f3serialVersionUID\fR\&. -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the Java Virtual Machine, where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH NOTES -The \f3serialver\fR command loads and initializes the specified classes in its virtual machine, and by default, it does not set a security manager\&. If the \f3serialver\fR command is to be run with untrusted classes, then a security manager can be set with the following option: -.sp -.nf -\f3\-J\-Djava\&.security\&.manager\fP -.fi -.nf -\f3\fP -.fi -.sp -When necessary, a security policy can be specified with the following option: -.sp -.nf -\f3\-J\-Djava\&.security\&.policy=<policy file>\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH SEE\ ALSO -.TP 0.2i -\(bu -policytool(1) -.TP 0.2i -\(bu -The \f3java\&.io\&.ObjectStream\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/io/ObjectStreamClass\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1997, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Remote Method Invocation (RMI) Tools +.\" Title: serialver.1 +.\" +.if n .pl 99999 +.TH serialver 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +serialver \- Returns the serial version UID for specified classes\&. +.SH SYNOPSIS +.sp +.nf + +\fBserialver\fR [ \fIoptions\fR ] [ \fIclassnames\fR ] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIclassnames\fR +The classes for which the \f3serialVersionUID\fR is to be returned\&. +.SH DESCRIPTION +The \f3serialver\fR command returns the \f3serialVersionUID\fR for one or more classes in a form suitable for copying into an evolving class\&. When called with no arguments, the \f3serialver\fR command prints a usage line\&. +.SH OPTIONS +.TP +-classpath \fIpath-files\fR +.br +Sets the search path for application classes and resources\&. Separate classes and resources with a colon (:)\&. +.TP +-show +.br +Displays a simple user interface\&. Enter the full class name and press either the \fIEnter\fR key or the \fIShow\fR button to display the \f3serialVersionUID\fR\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH NOTES +The \f3serialver\fR command loads and initializes the specified classes in its virtual machine, and by default, it does not set a security manager\&. If the \f3serialver\fR command is to be run with untrusted classes, then a security manager can be set with the following option: +.sp +.nf +\f3\-J\-Djava\&.security\&.manager\fP +.fi +.nf +\f3\fP +.fi +.sp +When necessary, a security policy can be specified with the following option: +.sp +.nf +\f3\-J\-Djava\&.security\&.policy=<policy file>\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +policytool(1) +.TP 0.2i +\(bu +The \f3java\&.io\&.ObjectStream\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/io/ObjectStreamClass\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/servertool.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/servertool.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,137 +1,137 @@ -'\" t -.\" Copyright (c) 2001, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java IDL and RMI-IIOP Tools -.\" Title: servertool.1 -.\" -.if n .pl 99999 -.TH servertool 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -servertool \- Provides an easy-to-use interface for developers to register, unregister, start up, and shut down a persistent server\&. -.SH SYNOPSIS -.sp -.nf - -\fBservertool\fR \-ORBInitialPort \fInameserverport\fR [ \fIoptions\fR ] [ \fIcommands \fR] -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -commands -The command-line commands\&. See Commands\&. -.SH DESCRIPTION -The \f3servertool\fR command provides the command-line interface for developers to register, unregister, start up, and shut down a persistent server\&. Command-line commands let you obtain various statistical information about the server\&. See Commands\&. -.SH OPTIONS -.TP --ORBInitialHost \fInameserverhost\fR -.br -This options is required\&. It specifies the host machine on which the name server runs and listens for incoming requests\&. The \f3nameserverhost\fR value must specify the port on which the \f3orb\fR is running and listening for requests\&. The value defaults to \f3localhost\fR when this option is not specified\&. If \f3orbd\fR and \f3servertool\fR are running on different machines, then you must specify the name or IP address of the host on which \f3orbd\fR is running\&. - -\fINote:\fR On Oracle Solaris, you must become a root user to start a process on a port below 1024\&. Oracle recommends that you use a port number above or equal to 1024 for the \f3nameserverport\fR value\&. -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH COMMANDS -You can start the \f3servertool\fR command with or without a command-line command\&. -.TP 0.2i -\(bu -If you did not specify a command when you started \f3servertool\fR, then the command-line tool displays the \f3servertool\fR prompt where you can enter commands: \f3servertool >\fR\&. -.TP 0.2i -\(bu -If you specify a command when you start \f3servertool\fR, then the Java IDL Server Tool starts, executes the command, and exits\&. -.TP -.ll 180 -register -server \fIserver-class-name\fR -classpath \fIclasspath-to-server\fR [ -applicationName \fIapplication-name\fR -args \fIargs-to-server\fR -vmargs \fIflags-for-JVM\fR ] -Registers a new persistent server with the Object Request Broker Daemon (ORBD)\&. If the server is not already registered, then it is registered and activated\&. This command causes an installation method to be called in the \f3main\fR class of the server identified by the \f3-server\fR option\&. The installation method must be \f3public static void install(org\&.omg\&.CORBA\&.ORB)\fR\&. The install method is optional and lets developers provide their own server installation behavior, such as creating a database schema\&. -.TP -.ll 180 -unregister -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR -Unregisters a server from the ORBD with either its server ID or its application name\&. This command causes an uninstallation method to be called in the \f3main\fR class of the server identified by the \f3-server\fR option\&. The \f3uninstall\fR method must be \f3public static void uninstall(org\&.omg\&.CORBA\&.ORB)\fR\&. The \f3uninstall\fR method is optional and lets developers provide their own server uninstallation behavior, such as undoing the behavior of the \f3install\fR method\&. -.TP -getserverid -applicationName \fIapplication-name\fR -Returns the server ID that corresponds to the \f3application-name\fR value\&. -.TP -list -Lists information about all persistent servers registered with the ORBD\&. -.TP -listappnames -Lists the application names for all servers currently registered with the ORBD\&. -.TP -listactive -Lists information about all persistent servers that were started by the ORBD and are currently running\&. -.TP -.ll 180 -locate -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR [ -endpointType \fIendpointType\fR ] -Locates the endpoints (ports) of a specific type for all ORBs created by a registered server\&. If a server is not already running, then it is activated\&. If an \f3endpointType\fR value is not specified, then the plain/non-protected endpoint associated with each ORB in a server is returned\&. -.TP -.ll 180 -locateperorb -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR [ -orbid \fIORB-name\fR ] -Locates all the endpoints (ports) registered by a specific Object Request Broker (ORB) of registered server\&. If a server is not already running, then it is activated\&. If an \f3orbid\fR is not specified, then the default value of \f3""\fR is assigned to the \f3orbid\fR\&. If any ORBs are created with an \f3orbid\fR of empty string, then all ports registered by it are returned\&. -.TP -orblist -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR -Lists the \f3ORBId\fR of the ORBs defined on a server\&. An \f3ORBId\fR is the string name for the ORB created by the server\&. If the server is not already running, then it is activated\&. -.TP -shutdown -serverid \fIserver-id\fR | -applicationName application-name -Shut down an active server that is registered with ORBD\&. During execution of this command, the \f3shutdown\fR method defined in the class specified by either the \f3-serverid\fR or \f3-applicationName\fR parameter is also called to shut down the server process\&. -.TP -startup -serverid \fIserver-id\fR | -applicationName application-name -Starts up or activate a server that is registered with ORBD\&. If the server is not running, then this command starts the server\&. If the server is already running, then an error message is displayed\&. -.TP -help -Lists all the commands available to the server through the \f3servertool\fR command\&. -.TP -quit -Exits the \f3servertool\fR command\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -orbd(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2001, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java IDL and RMI-IIOP Tools +.\" Title: servertool.1 +.\" +.if n .pl 99999 +.TH servertool 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +servertool \- Provides an easy-to-use interface for developers to register, unregister, start up, and shut down a persistent server\&. +.SH SYNOPSIS +.sp +.nf + +\fBservertool\fR \-ORBInitialPort \fInameserverport\fR [ \fIoptions\fR ] [ \fIcommands \fR] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +commands +The command-line commands\&. See Commands\&. +.SH DESCRIPTION +The \f3servertool\fR command provides the command-line interface for developers to register, unregister, start up, and shut down a persistent server\&. Command-line commands let you obtain various statistical information about the server\&. See Commands\&. +.SH OPTIONS +.TP +-ORBInitialHost \fInameserverhost\fR +.br +This options is required\&. It specifies the host machine on which the name server runs and listens for incoming requests\&. The \f3nameserverhost\fR value must specify the port on which the \f3orb\fR is running and listening for requests\&. The value defaults to \f3localhost\fR when this option is not specified\&. If \f3orbd\fR and \f3servertool\fR are running on different machines, then you must specify the name or IP address of the host on which \f3orbd\fR is running\&. + +\fINote:\fR On Oracle Solaris, you must become a root user to start a process on a port below 1024\&. Oracle recommends that you use a port number above or equal to 1024 for the \f3nameserverport\fR value\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH COMMANDS +You can start the \f3servertool\fR command with or without a command-line command\&. +.TP 0.2i +\(bu +If you did not specify a command when you started \f3servertool\fR, then the command-line tool displays the \f3servertool\fR prompt where you can enter commands: \f3servertool >\fR\&. +.TP 0.2i +\(bu +If you specify a command when you start \f3servertool\fR, then the Java IDL Server Tool starts, executes the command, and exits\&. +.TP +.ll 180 +register -server \fIserver-class-name\fR -classpath \fIclasspath-to-server\fR [ -applicationName \fIapplication-name\fR -args \fIargs-to-server\fR -vmargs \fIflags-for-JVM\fR ] +Registers a new persistent server with the Object Request Broker Daemon (ORBD)\&. If the server is not already registered, then it is registered and activated\&. This command causes an installation method to be called in the \f3main\fR class of the server identified by the \f3-server\fR option\&. The installation method must be \f3public static void install(org\&.omg\&.CORBA\&.ORB)\fR\&. The install method is optional and lets developers provide their own server installation behavior, such as creating a database schema\&. +.TP +.ll 180 +unregister -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR +Unregisters a server from the ORBD with either its server ID or its application name\&. This command causes an uninstallation method to be called in the \f3main\fR class of the server identified by the \f3-server\fR option\&. The \f3uninstall\fR method must be \f3public static void uninstall(org\&.omg\&.CORBA\&.ORB)\fR\&. The \f3uninstall\fR method is optional and lets developers provide their own server uninstallation behavior, such as undoing the behavior of the \f3install\fR method\&. +.TP +getserverid -applicationName \fIapplication-name\fR +Returns the server ID that corresponds to the \f3application-name\fR value\&. +.TP +list +Lists information about all persistent servers registered with the ORBD\&. +.TP +listappnames +Lists the application names for all servers currently registered with the ORBD\&. +.TP +listactive +Lists information about all persistent servers that were started by the ORBD and are currently running\&. +.TP +.ll 180 +locate -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR [ -endpointType \fIendpointType\fR ] +Locates the endpoints (ports) of a specific type for all ORBs created by a registered server\&. If a server is not already running, then it is activated\&. If an \f3endpointType\fR value is not specified, then the plain/non-protected endpoint associated with each ORB in a server is returned\&. +.TP +.ll 180 +locateperorb -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR [ -orbid \fIORB-name\fR ] +Locates all the endpoints (ports) registered by a specific Object Request Broker (ORB) of registered server\&. If a server is not already running, then it is activated\&. If an \f3orbid\fR is not specified, then the default value of \f3""\fR is assigned to the \f3orbid\fR\&. If any ORBs are created with an \f3orbid\fR of empty string, then all ports registered by it are returned\&. +.TP +orblist -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR +Lists the \f3ORBId\fR of the ORBs defined on a server\&. An \f3ORBId\fR is the string name for the ORB created by the server\&. If the server is not already running, then it is activated\&. +.TP +shutdown -serverid \fIserver-id\fR | -applicationName application-name +Shut down an active server that is registered with ORBD\&. During execution of this command, the \f3shutdown\fR method defined in the class specified by either the \f3-serverid\fR or \f3-applicationName\fR parameter is also called to shut down the server process\&. +.TP +startup -serverid \fIserver-id\fR | -applicationName application-name +Starts up or activate a server that is registered with ORBD\&. If the server is not running, then this command starts the server\&. If the server is already running, then an error message is displayed\&. +.TP +help +Lists all the commands available to the server through the \f3servertool\fR command\&. +.TP +quit +Exits the \f3servertool\fR command\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +orbd(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/tnameserv.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/tnameserv.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,488 +1,488 @@ -'\" t -.\" Copyright (c) 1999, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java IDL and RMI-IIOP Tools -.\" Title: tnameserv.1 -.\" -.if n .pl 99999 -.TH tnameserv 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -tnameserv \- Interface Definition Language (IDL)\&. -.SH SYNOPSIS -.sp -.nf - -\fBtnameserve\fR \fB\-ORBInitialPort\fR [ \fInameserverport\fR ] -.fi -.sp -.TP --ORBInitialPort \fInameserverport\fR -.br -The initial port where the naming service listens for the bootstrap protocol used to implement the ORB \f3resolve_initial_references\fR and \f3list_initial_references\fR methods\&. -.SH DESCRIPTION -Java IDL includes the Object Request Broker Daemon (ORBD)\&. ORBD is a daemon process that contains a Bootstrap Service, a Transient Naming Service, a Persistent Naming Service, and a Server Manager\&. The Java IDL tutorials all use ORBD, but you can substitute the \f3tnameserv\fR command for the \f3orbd\fR command in any of the examples that use a Transient Naming Service\&. -.PP -See orbd(1) or Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html -.PP -The CORBA Common Object Services (COS) Naming Service provides a tree-structure directory for object references similar to a file system that provides a directory structure for files\&. The Transient Naming Service provided with Java IDL, \f3tnameserv\fR, is a simple implementation of the COS Naming Service specification\&. -.PP -Object references are stored in the name space by name and each object reference-name pair is called a name binding\&. Name bindings can be organized under naming contexts\&. Naming contexts are name bindings and serve the same organizational function as a file system subdirectory\&. All bindings are stored under the initial naming context\&. The initial naming context is the only persistent binding in the name space\&. The rest of the name space is lost when the Java IDL naming service process stops and restarts\&. -.PP -For an applet or application to use COS naming, its ORB must know the port of a host running a naming service or have access to an initial naming context string for that naming service\&. The naming service can either be the Java IDL naming service or another COS-compliant naming service\&. -.SS START\ THE\ NAMING\ SERVICE -You must start the Java IDL naming service before an application or applet that uses its naming service\&. Installation of the Java IDL product creates a script (Oracle Solaris: \f3tnameserv\fR) or executable file (Windows: \f3tnameserv\&.exe\fR) that starts the Java IDL naming service\&. Start the naming service so it runs in the background\&. -.PP -If you do not specify otherwise, then the Java IDL naming service listens on port 900 for the bootstrap protocol used to implement the ORB \f3resolve_initial_references\fR and \f3list_initial_references methods\fR, as follows: -.sp -.nf -\f3tnameserv \-ORBInitialPort nameserverport&\fP -.fi -.nf -\f3\fP -.fi -.sp -If you do not specify the name server port, then port 900 is used by default\&. When running Oracle Solaris software, you must become the root user to start a process on a port below 1024\&. For this reason, it is recommended that you use a port number greater than or equal to 1024\&. To specify a different port, for example, 1050, and to run the naming service in the background, from a UNIX command shell, enter: -.sp -.nf -\f3tnameserv \-ORBInitialPort 1050&\fP -.fi -.nf -\f3\fP -.fi -.sp -From an MS-DOS system prompt (Windows), enter: -.sp -.nf -\f3start tnameserv \-ORBInitialPort 1050\fP -.fi -.nf -\f3\fP -.fi -.sp -Clients of the name server must be made aware of the new port number\&. Do this by setting the \f3org\&.omg\&.CORBA\&.ORBInitialPort\fR property to the new port number when you create the ORB object\&. -.SS RUN\ THE\ SERVER\ AND\ CLIENT\ ON\ DIFFERENT\ HOSTS -In most of the Java IDL and RMI-IIOP tutorials, the naming service, server, and client are all running on the development machine\&. In real-world deployment, the client and server probably run on different host machines from the Naming Service\&. -.PP -For the client and server to find the Naming Service, they must be made aware of the port number and host on which the naming service is running\&. Do this by setting the \f3org\&.omg\&.CORBA\&.ORBInitialPort\fR and \f3org\&.omg\&.CORBA\&.ORBInitialHost\fR properties in the client and server files to the machine name and port number on which the Naming Service is running\&. An example of this is shown in Getting Started Using RMI-IIOP at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/rmi-iiop/rmiiiopexample\&.html -.PP -You could also use the command-line options \f3-ORBInitialPort nameserverport#\fR and \f3-ORBInitialHost nameserverhostname\fR to tell the client and server where to find the naming service\&. For one example of doing this using the command-line option, see Java IDL: The Hello World Example on Two Machines at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/tutorial/jidl2machines\&.html -.PP -For example, suppose the Transient Naming Service, \f3tnameserv\fR is running on port 1050 on host \f3nameserverhost\fR\&. The client is running on host \f3clienthost,\fR and the server is running on host \f3serverhost\fR\&. -.PP -Start \f3tnameserv\fR on the host \f3nameserverhost\fR: -.sp -.nf -\f3tnameserv \-ORBInitialPort 1050\fP -.fi -.nf -\f3\fP -.fi -.sp -Start the server on the \f3serverhost\fR: -.sp -.nf -\f3java Server \-ORBInitialPort 1050 \-ORBInitialHost nameserverhost\fP -.fi -.nf -\f3\fP -.fi -.sp -Start the client on the \f3clienthost\fR: -.sp -.nf -\f3java Client \-ORBInitialPort 1050 \-ORBInitialHost nameserverhost\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS STOP\ THE\ NAMING\ SERVICE -To stop the Java IDL naming service, use the relevant operating system command, such as \f3kill\fR for a Unix process or \f3Ctrl+C\fR for a Windows process\&. The naming service continues to wait for invocations until it is explicitly shut down\&. Note that names registered with the Java IDL naming service disappear when the service is terminated\&. -.SH OPTIONS -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH EXAMPLES -.SS ADD\ OBJECTS\ TO\ THE\ NAME\ SPACE -The following example shows how to add names to the name space\&. It is a self-contained Transient Naming Service client that creates the following simple tree\&. -.sp -.nf -\f3Initial Naming Context\fP -.fi -.nf -\f3 plans\fP -.fi -.nf -\f3 Personal\fP -.fi -.nf -\f3 calendar\fP -.fi -.nf -\f3 schedule\fP -.fi -.nf -\f3\fP -.fi -.sp -In this example, \f3plans\fR is an object reference and \f3Personal\fR is a naming context that contains two object references: \f3calendar\fR and \f3schedule\fR\&. -.sp -.nf -\f3import java\&.util\&.Properties;\fP -.fi -.nf -\f3import org\&.omg\&.CORBA\&.*;\fP -.fi -.nf -\f3import org\&.omg\&.CosNaming\&.*;\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3public class NameClient {\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 public static void main(String args[]) {\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 try {\fP -.fi -.nf -\f3\fP -.fi -.sp -In Start the Naming Service, the \f3nameserver\fR was started on port 1050\&. The following code ensures that the client program is aware of this port number\&. -.sp -.nf -\f3 Properties props = new Properties();\fP -.fi -.nf -\f3 props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP -.fi -.nf -\f3 ORB orb = ORB\&.init(args, props);\fP -.fi -.nf -\f3\fP -.fi -.sp -This code obtains the initial naming context and assigns it to \f3ctx\fR\&. The second line copies \f3ctx\fR into a dummy object reference \f3objref\fR that is attached to various names and added into the name space\&. -.sp -.nf -\f3 NamingContext ctx =\fP -.fi -.nf -\f3 NamingContextHelper\&.narrow(\fP -.fi -.nf -\f3 orb\&.resolve_initial_references("NameService"));\fP -.fi -.nf -\f3 NamingContext objref = ctx;\fP -.fi -.nf -\f3\fP -.fi -.sp -This code creates a name \f3plans\fR of type \f3text\fR and binds it to the dummy object reference\&. \f3plans\fR is then added under the initial naming context using the \f3rebind\fR method\&. The \f3rebind\fR method enables you to run this program over and over again without getting the exceptions from using the \f3bind\fR method\&. -.sp -.nf -\f3 NameComponent nc1 = new NameComponent("plans", "text");\fP -.fi -.nf -\f3 NameComponent[] name1 = {nc1};\fP -.fi -.nf -\f3 ctx\&.rebind(name1, objref);\fP -.fi -.nf -\f3 System\&.out\&.println("plans rebind successful!");\fP -.fi -.nf -\f3\fP -.fi -.sp -This code creates a naming context called \f3Personal\fR of type \f3directory\fR\&. The resulting object reference, \f3ctx2\fR, is bound to the \f3name\fR and added under the initial naming context\&. -.sp -.nf -\f3 NameComponent nc2 = new NameComponent("Personal", "directory");\fP -.fi -.nf -\f3 NameComponent[] name2 = {nc2};\fP -.fi -.nf -\f3 NamingContext ctx2 = ctx\&.bind_new_context(name2);\fP -.fi -.nf -\f3 System\&.out\&.println("new naming context added\&.\&.");\fP -.fi -.nf -\f3\fP -.fi -.sp -The remainder of the code binds the dummy object reference using the names \f3schedule\fR and \f3calendar\fR under the \f3Personal\fR naming context (\f3ctx2\fR)\&. -.sp -.nf -\f3 NameComponent nc3 = new NameComponent("schedule", "text");\fP -.fi -.nf -\f3 NameComponent[] name3 = {nc3};\fP -.fi -.nf -\f3 ctx2\&.rebind(name3, objref);\fP -.fi -.nf -\f3 System\&.out\&.println("schedule rebind successful!");\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 NameComponent nc4 = new NameComponent("calender", "text");\fP -.fi -.nf -\f3 NameComponent[] name4 = {nc4};\fP -.fi -.nf -\f3 ctx2\&.rebind(name4, objref);\fP -.fi -.nf -\f3 System\&.out\&.println("calender rebind successful!");\fP -.fi -.nf -\f3 } catch (Exception e) {\fP -.fi -.nf -\f3 e\&.printStackTrace(System\&.err);\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS BROWSING\ THE\ NAME\ SPACE -The following sample program shoes how to browse the name space\&. -.sp -.nf -\f3import java\&.util\&.Properties;\fP -.fi -.nf -\f3import org\&.omg\&.CORBA\&.*;\fP -.fi -.nf -\f3import org\&.omg\&.CosNaming\&.*;\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3public class NameClientList {\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 public static void main(String args[]) {\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 try {\fP -.fi -.nf -\f3\fP -.fi -.sp -In Start the Naming Service, the \f3nameserver\fR was started on port 1050\&. The following code ensures that the client program is aware of this port number\&. -.sp -.nf -\f3 Properties props = new Properties();\fP -.fi -.nf -\f3 props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP -.fi -.nf -\f3 ORB orb = ORB\&.init(args, props);\fP -.fi -.nf -\f3\fP -.fi -.sp -The following code obtains the initial naming context\&. -.sp -.nf -\f3 NamingContext nc =\fP -.fi -.nf -\f3 NamingContextHelper\&.narrow(\fP -.fi -.nf -\f3 orb\&.resolve_initial_references("NameService"));\fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3list\fR method lists the bindings in the naming context\&. In this case, up to 1000 bindings from the initial naming context will be returned in the \f3BindingListHolder\fR; any remaining bindings are returned in the \f3BindingIteratorHolder\fR\&. -.sp -.nf -\f3 BindingListHolder bl = new BindingListHolder();\fP -.fi -.nf -\f3 BindingIteratorHolder blIt= new BindingIteratorHolder();\fP -.fi -.nf -\f3 nc\&.list(1000, bl, blIt);\fP -.fi -.nf -\f3\fP -.fi -.sp -This code gets the array of bindings out of the returned \f3BindingListHolder\fR\&. If there are no bindings, then the program ends\&. -.sp -.nf -\f3 Binding bindings[] = bl\&.value;\fP -.fi -.nf -\f3 if (bindings\&.length == 0) return;\fP -.fi -.nf -\f3\fP -.fi -.sp -The remainder of the code loops through the bindings and prints outs the names\&. -.sp -.nf -\f3 for (int i=0; i < bindings\&.length; i++) {\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 // get the object reference for each binding\fP -.fi -.nf -\f3 org\&.omg\&.CORBA\&.Object obj = nc\&.resolve(bindings[i]\&.binding_name);\fP -.fi -.nf -\f3 String objStr = orb\&.object_to_string(obj);\fP -.fi -.nf -\f3 int lastIx = bindings[i]\&.binding_name\&.length\-1;\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 // check to see if this is a naming context\fP -.fi -.nf -\f3 if (bindings[i]\&.binding_type == BindingType\&.ncontext) {\fP -.fi -.nf -\f3 System\&.out\&.println("Context: " +\fP -.fi -.nf -\f3 bindings[i]\&.binding_name[lastIx]\&.id);\fP -.fi -.nf -\f3 } else {\fP -.fi -.nf -\f3 System\&.out\&.println("Object: " +\fP -.fi -.nf -\f3 bindings[i]\&.binding_name[lastIx]\&.id);\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3 } catch (Exception e) {\fP -.fi -.nf -\f3 e\&.printStackTrace(System\&.err)\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH SEE\ ALSO -.TP 0.2i -\(bu -orbd(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1999, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java IDL and RMI-IIOP Tools +.\" Title: tnameserv.1 +.\" +.if n .pl 99999 +.TH tnameserv 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +tnameserv \- Interface Definition Language (IDL)\&. +.SH SYNOPSIS +.sp +.nf + +\fBtnameserve\fR \fB\-ORBInitialPort\fR [ \fInameserverport\fR ] +.fi +.sp +.TP +-ORBInitialPort \fInameserverport\fR +.br +The initial port where the naming service listens for the bootstrap protocol used to implement the ORB \f3resolve_initial_references\fR and \f3list_initial_references\fR methods\&. +.SH DESCRIPTION +Java IDL includes the Object Request Broker Daemon (ORBD)\&. ORBD is a daemon process that contains a Bootstrap Service, a Transient Naming Service, a Persistent Naming Service, and a Server Manager\&. The Java IDL tutorials all use ORBD, but you can substitute the \f3tnameserv\fR command for the \f3orbd\fR command in any of the examples that use a Transient Naming Service\&. +.PP +See orbd(1) or Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html +.PP +The CORBA Common Object Services (COS) Naming Service provides a tree-structure directory for object references similar to a file system that provides a directory structure for files\&. The Transient Naming Service provided with Java IDL, \f3tnameserv\fR, is a simple implementation of the COS Naming Service specification\&. +.PP +Object references are stored in the name space by name and each object reference-name pair is called a name binding\&. Name bindings can be organized under naming contexts\&. Naming contexts are name bindings and serve the same organizational function as a file system subdirectory\&. All bindings are stored under the initial naming context\&. The initial naming context is the only persistent binding in the name space\&. The rest of the name space is lost when the Java IDL naming service process stops and restarts\&. +.PP +For an applet or application to use COS naming, its ORB must know the port of a host running a naming service or have access to an initial naming context string for that naming service\&. The naming service can either be the Java IDL naming service or another COS-compliant naming service\&. +.SS START\ THE\ NAMING\ SERVICE +You must start the Java IDL naming service before an application or applet that uses its naming service\&. Installation of the Java IDL product creates a script (Oracle Solaris: \f3tnameserv\fR) or executable file (Windows: \f3tnameserv\&.exe\fR) that starts the Java IDL naming service\&. Start the naming service so it runs in the background\&. +.PP +If you do not specify otherwise, then the Java IDL naming service listens on port 900 for the bootstrap protocol used to implement the ORB \f3resolve_initial_references\fR and \f3list_initial_references methods\fR, as follows: +.sp +.nf +\f3tnameserv \-ORBInitialPort nameserverport&\fP +.fi +.nf +\f3\fP +.fi +.sp +If you do not specify the name server port, then port 900 is used by default\&. When running Oracle Solaris software, you must become the root user to start a process on a port below 1024\&. For this reason, it is recommended that you use a port number greater than or equal to 1024\&. To specify a different port, for example, 1050, and to run the naming service in the background, from a UNIX command shell, enter: +.sp +.nf +\f3tnameserv \-ORBInitialPort 1050&\fP +.fi +.nf +\f3\fP +.fi +.sp +From an MS-DOS system prompt (Windows), enter: +.sp +.nf +\f3start tnameserv \-ORBInitialPort 1050\fP +.fi +.nf +\f3\fP +.fi +.sp +Clients of the name server must be made aware of the new port number\&. Do this by setting the \f3org\&.omg\&.CORBA\&.ORBInitialPort\fR property to the new port number when you create the ORB object\&. +.SS RUN\ THE\ SERVER\ AND\ CLIENT\ ON\ DIFFERENT\ HOSTS +In most of the Java IDL and RMI-IIOP tutorials, the naming service, server, and client are all running on the development machine\&. In real-world deployment, the client and server probably run on different host machines from the Naming Service\&. +.PP +For the client and server to find the Naming Service, they must be made aware of the port number and host on which the naming service is running\&. Do this by setting the \f3org\&.omg\&.CORBA\&.ORBInitialPort\fR and \f3org\&.omg\&.CORBA\&.ORBInitialHost\fR properties in the client and server files to the machine name and port number on which the Naming Service is running\&. An example of this is shown in Getting Started Using RMI-IIOP at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/rmi-iiop/rmiiiopexample\&.html +.PP +You could also use the command-line options \f3-ORBInitialPort nameserverport#\fR and \f3-ORBInitialHost nameserverhostname\fR to tell the client and server where to find the naming service\&. For one example of doing this using the command-line option, see Java IDL: The Hello World Example on Two Machines at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/tutorial/jidl2machines\&.html +.PP +For example, suppose the Transient Naming Service, \f3tnameserv\fR is running on port 1050 on host \f3nameserverhost\fR\&. The client is running on host \f3clienthost,\fR and the server is running on host \f3serverhost\fR\&. +.PP +Start \f3tnameserv\fR on the host \f3nameserverhost\fR: +.sp +.nf +\f3tnameserv \-ORBInitialPort 1050\fP +.fi +.nf +\f3\fP +.fi +.sp +Start the server on the \f3serverhost\fR: +.sp +.nf +\f3java Server \-ORBInitialPort 1050 \-ORBInitialHost nameserverhost\fP +.fi +.nf +\f3\fP +.fi +.sp +Start the client on the \f3clienthost\fR: +.sp +.nf +\f3java Client \-ORBInitialPort 1050 \-ORBInitialHost nameserverhost\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS STOP\ THE\ NAMING\ SERVICE +To stop the Java IDL naming service, use the relevant operating system command, such as \f3kill\fR for a Unix process or \f3Ctrl+C\fR for a Windows process\&. The naming service continues to wait for invocations until it is explicitly shut down\&. Note that names registered with the Java IDL naming service disappear when the service is terminated\&. +.SH OPTIONS +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH EXAMPLES +.SS ADD\ OBJECTS\ TO\ THE\ NAME\ SPACE +The following example shows how to add names to the name space\&. It is a self-contained Transient Naming Service client that creates the following simple tree\&. +.sp +.nf +\f3Initial Naming Context\fP +.fi +.nf +\f3 plans\fP +.fi +.nf +\f3 Personal\fP +.fi +.nf +\f3 calendar\fP +.fi +.nf +\f3 schedule\fP +.fi +.nf +\f3\fP +.fi +.sp +In this example, \f3plans\fR is an object reference and \f3Personal\fR is a naming context that contains two object references: \f3calendar\fR and \f3schedule\fR\&. +.sp +.nf +\f3import java\&.util\&.Properties;\fP +.fi +.nf +\f3import org\&.omg\&.CORBA\&.*;\fP +.fi +.nf +\f3import org\&.omg\&.CosNaming\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class NameClient {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public static void main(String args[]) {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 try {\fP +.fi +.nf +\f3\fP +.fi +.sp +In Start the Naming Service, the \f3nameserver\fR was started on port 1050\&. The following code ensures that the client program is aware of this port number\&. +.sp +.nf +\f3 Properties props = new Properties();\fP +.fi +.nf +\f3 props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP +.fi +.nf +\f3 ORB orb = ORB\&.init(args, props);\fP +.fi +.nf +\f3\fP +.fi +.sp +This code obtains the initial naming context and assigns it to \f3ctx\fR\&. The second line copies \f3ctx\fR into a dummy object reference \f3objref\fR that is attached to various names and added into the name space\&. +.sp +.nf +\f3 NamingContext ctx =\fP +.fi +.nf +\f3 NamingContextHelper\&.narrow(\fP +.fi +.nf +\f3 orb\&.resolve_initial_references("NameService"));\fP +.fi +.nf +\f3 NamingContext objref = ctx;\fP +.fi +.nf +\f3\fP +.fi +.sp +This code creates a name \f3plans\fR of type \f3text\fR and binds it to the dummy object reference\&. \f3plans\fR is then added under the initial naming context using the \f3rebind\fR method\&. The \f3rebind\fR method enables you to run this program over and over again without getting the exceptions from using the \f3bind\fR method\&. +.sp +.nf +\f3 NameComponent nc1 = new NameComponent("plans", "text");\fP +.fi +.nf +\f3 NameComponent[] name1 = {nc1};\fP +.fi +.nf +\f3 ctx\&.rebind(name1, objref);\fP +.fi +.nf +\f3 System\&.out\&.println("plans rebind successful!");\fP +.fi +.nf +\f3\fP +.fi +.sp +This code creates a naming context called \f3Personal\fR of type \f3directory\fR\&. The resulting object reference, \f3ctx2\fR, is bound to the \f3name\fR and added under the initial naming context\&. +.sp +.nf +\f3 NameComponent nc2 = new NameComponent("Personal", "directory");\fP +.fi +.nf +\f3 NameComponent[] name2 = {nc2};\fP +.fi +.nf +\f3 NamingContext ctx2 = ctx\&.bind_new_context(name2);\fP +.fi +.nf +\f3 System\&.out\&.println("new naming context added\&.\&.");\fP +.fi +.nf +\f3\fP +.fi +.sp +The remainder of the code binds the dummy object reference using the names \f3schedule\fR and \f3calendar\fR under the \f3Personal\fR naming context (\f3ctx2\fR)\&. +.sp +.nf +\f3 NameComponent nc3 = new NameComponent("schedule", "text");\fP +.fi +.nf +\f3 NameComponent[] name3 = {nc3};\fP +.fi +.nf +\f3 ctx2\&.rebind(name3, objref);\fP +.fi +.nf +\f3 System\&.out\&.println("schedule rebind successful!");\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 NameComponent nc4 = new NameComponent("calender", "text");\fP +.fi +.nf +\f3 NameComponent[] name4 = {nc4};\fP +.fi +.nf +\f3 ctx2\&.rebind(name4, objref);\fP +.fi +.nf +\f3 System\&.out\&.println("calender rebind successful!");\fP +.fi +.nf +\f3 } catch (Exception e) {\fP +.fi +.nf +\f3 e\&.printStackTrace(System\&.err);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS BROWSING\ THE\ NAME\ SPACE +The following sample program shoes how to browse the name space\&. +.sp +.nf +\f3import java\&.util\&.Properties;\fP +.fi +.nf +\f3import org\&.omg\&.CORBA\&.*;\fP +.fi +.nf +\f3import org\&.omg\&.CosNaming\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class NameClientList {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public static void main(String args[]) {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 try {\fP +.fi +.nf +\f3\fP +.fi +.sp +In Start the Naming Service, the \f3nameserver\fR was started on port 1050\&. The following code ensures that the client program is aware of this port number\&. +.sp +.nf +\f3 Properties props = new Properties();\fP +.fi +.nf +\f3 props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP +.fi +.nf +\f3 ORB orb = ORB\&.init(args, props);\fP +.fi +.nf +\f3\fP +.fi +.sp +The following code obtains the initial naming context\&. +.sp +.nf +\f3 NamingContext nc =\fP +.fi +.nf +\f3 NamingContextHelper\&.narrow(\fP +.fi +.nf +\f3 orb\&.resolve_initial_references("NameService"));\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3list\fR method lists the bindings in the naming context\&. In this case, up to 1000 bindings from the initial naming context will be returned in the \f3BindingListHolder\fR; any remaining bindings are returned in the \f3BindingIteratorHolder\fR\&. +.sp +.nf +\f3 BindingListHolder bl = new BindingListHolder();\fP +.fi +.nf +\f3 BindingIteratorHolder blIt= new BindingIteratorHolder();\fP +.fi +.nf +\f3 nc\&.list(1000, bl, blIt);\fP +.fi +.nf +\f3\fP +.fi +.sp +This code gets the array of bindings out of the returned \f3BindingListHolder\fR\&. If there are no bindings, then the program ends\&. +.sp +.nf +\f3 Binding bindings[] = bl\&.value;\fP +.fi +.nf +\f3 if (bindings\&.length == 0) return;\fP +.fi +.nf +\f3\fP +.fi +.sp +The remainder of the code loops through the bindings and prints outs the names\&. +.sp +.nf +\f3 for (int i=0; i < bindings\&.length; i++) {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 // get the object reference for each binding\fP +.fi +.nf +\f3 org\&.omg\&.CORBA\&.Object obj = nc\&.resolve(bindings[i]\&.binding_name);\fP +.fi +.nf +\f3 String objStr = orb\&.object_to_string(obj);\fP +.fi +.nf +\f3 int lastIx = bindings[i]\&.binding_name\&.length\-1;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 // check to see if this is a naming context\fP +.fi +.nf +\f3 if (bindings[i]\&.binding_type == BindingType\&.ncontext) {\fP +.fi +.nf +\f3 System\&.out\&.println("Context: " +\fP +.fi +.nf +\f3 bindings[i]\&.binding_name[lastIx]\&.id);\fP +.fi +.nf +\f3 } else {\fP +.fi +.nf +\f3 System\&.out\&.println("Object: " +\fP +.fi +.nf +\f3 bindings[i]\&.binding_name[lastIx]\&.id);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 } catch (Exception e) {\fP +.fi +.nf +\f3 e\&.printStackTrace(System\&.err)\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +orbd(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/unpack200.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/unpack200.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,137 +1,137 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java Deployment Tools -.\" Title: unpack200.1 -.\" -.if n .pl 99999 -.TH unpack200 1 "21 November 2013" "JDK 8" "Java Deployment Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -unpack200 \- Transforms a packed file produced by pack200(1) into a JAR file for web deployment\&. -.SH SYNOPSIS -.sp -.nf - -\fBunpack200\fR [ \fIoptions\fR ] input\-file \fIJAR\-file\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIinput-file\fR -Name of the input file, which can be a pack200 gzip file or a pack200 file\&. The input can also be JAR file produced by \f3pack200\fR(1) with an effort of \f30\fR, in which case the contents of the input file are copied to the output JAR file with the Pack200 marker\&. -.TP -\fIJAR-file\fR -Name of the output JAR file\&. -.SH DESCRIPTION -The \f3unpack200\fR command is a native implementation that transforms a packed file produced by \f3pack200\fR\f3(1)\fR into a JAR file\&. A typical usage follows\&. In the following example, the \f3myarchive\&.jar\fR file is produced from \f3myarchive\&.pack\&.gz\fR with the default \f3unpack200\fR command settings\&. -.sp -.nf -\f3unpack200 myarchive\&.pack\&.gz myarchive\&.jar\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH OPTIONS -.TP --Hvalue --deflate-hint=\fIvalue\fR -.br -Sets the deflation to be \f3true\fR, \f3false\fR, or \f3keep\fR on all entries within a JAR file\&. The default mode is \f3keep\fR\&. If the value is \f3true\fR or \f3false\fR, then the \f3--deflate=hint\fR option overrides the default behavior and sets the deflation mode on all entries within the output JAR file\&. -.TP --r --remove-pack-file -.br -Removes the input pack file\&. -.TP --v --verbose -.br -Displays minimal messages\&. Multiple specifications of this option displays more verbose messages\&. -.TP --q --quiet -.br -Specifies quiet operation with no messages\&. -.TP --lfilename --log-file=\fIfilename\fR -.br -Specifies a log file where output messages are logged\&. -.TP --? -h --help -.br -Prints help information about the \f3unpack200\fR command\&. -.TP --V --version -.br -Prints version information about the \f3unpack200\fR command\&. -.TP --J\fIoption\fR -.br -Passes option to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH NOTES -This command should not be confused with the \f3unpack\fR command\&. They are distinctly separate products\&. -.PP -The Java SE API Specification provided with the JDK is the superseding authority in case of discrepancies\&. -.SH EXIT\ STATUS -The following exit values are returned: 0 for successful completion, and a value that is greater than 0 when an error occurred\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -pack200(1) -.TP 0.2i -\(bu -jar(1) -.TP 0.2i -\(bu -jarsigner(1) -.TP 0.2i -\(bu -Pack200 and Compression at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/deployment/deployment-guide/pack200\&.html -.TP 0.2i -\(bu -The Java SE Technical Documentation page at http://docs\&.oracle\&.com/javase/ -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Deployment Tools +.\" Title: unpack200.1 +.\" +.if n .pl 99999 +.TH unpack200 1 "21 November 2013" "JDK 8" "Java Deployment Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +unpack200 \- Transforms a packed file produced by pack200(1) into a JAR file for web deployment\&. +.SH SYNOPSIS +.sp +.nf + +\fBunpack200\fR [ \fIoptions\fR ] input\-file \fIJAR\-file\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIinput-file\fR +Name of the input file, which can be a pack200 gzip file or a pack200 file\&. The input can also be JAR file produced by \f3pack200\fR(1) with an effort of \f30\fR, in which case the contents of the input file are copied to the output JAR file with the Pack200 marker\&. +.TP +\fIJAR-file\fR +Name of the output JAR file\&. +.SH DESCRIPTION +The \f3unpack200\fR command is a native implementation that transforms a packed file produced by \f3pack200\fR\f3(1)\fR into a JAR file\&. A typical usage follows\&. In the following example, the \f3myarchive\&.jar\fR file is produced from \f3myarchive\&.pack\&.gz\fR with the default \f3unpack200\fR command settings\&. +.sp +.nf +\f3unpack200 myarchive\&.pack\&.gz myarchive\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-Hvalue --deflate-hint=\fIvalue\fR +.br +Sets the deflation to be \f3true\fR, \f3false\fR, or \f3keep\fR on all entries within a JAR file\&. The default mode is \f3keep\fR\&. If the value is \f3true\fR or \f3false\fR, then the \f3--deflate=hint\fR option overrides the default behavior and sets the deflation mode on all entries within the output JAR file\&. +.TP +-r --remove-pack-file +.br +Removes the input pack file\&. +.TP +-v --verbose +.br +Displays minimal messages\&. Multiple specifications of this option displays more verbose messages\&. +.TP +-q --quiet +.br +Specifies quiet operation with no messages\&. +.TP +-lfilename --log-file=\fIfilename\fR +.br +Specifies a log file where output messages are logged\&. +.TP +-? -h --help +.br +Prints help information about the \f3unpack200\fR command\&. +.TP +-V --version +.br +Prints version information about the \f3unpack200\fR command\&. +.TP +-J\fIoption\fR +.br +Passes option to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH NOTES +This command should not be confused with the \f3unpack\fR command\&. They are distinctly separate products\&. +.PP +The Java SE API Specification provided with the JDK is the superseding authority in case of discrepancies\&. +.SH EXIT\ STATUS +The following exit values are returned: 0 for successful completion, and a value that is greater than 0 when an error occurred\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +pack200(1) +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +jarsigner(1) +.TP 0.2i +\(bu +Pack200 and Compression at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/deployment/deployment-guide/pack200\&.html +.TP 0.2i +\(bu +The Java SE Technical Documentation page at http://docs\&.oracle\&.com/javase/ +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/wsgen.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/wsgen.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,175 +1,175 @@ -'\" t -.\" Copyright (c) 2005, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java Web Services Tools -.\" Title: wsgen.1 -.\" -.if n .pl 99999 -.TH wsgen 1 "21 November 2013" "JDK 8" "Java Web Services Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -wsgen \- Reads a web service endpoint implementation (SEI) class and generates all of the required artifacts for web service deployment, and invocation\&. -.SH SYNOPSIS -.sp -.nf - -\fBwsgen\fR [ \fIoptions\fR ] \fISEI\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fISEI\fR -The web service endpoint implementation class (SEI) to be read\&. -.SH DESCRIPTION -The \f3wsgen\fR command 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 \f3wsgen\fR Ant task, see the \fITools\fR tab of the JAX-WS (wsgen) page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsgenant\&.html -.PP -To start the \f3wsgen\fR command, do the following: -.sp -.nf -\f3export JAXWS_HOME=/pathto/jaxws\-ri\fP -.fi -.nf -\f3$JAXWS_HOME/bin/wsgen\&.sh \-help\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH OPTIONS -.TP --classpath \fIpath\fR -.br -The location of the input class files\&. -.TP --cp \fIpath\fR -.br -The location of the input class files\&. -.TP --d \fIdirectory\fR -.br -The location for where to place generated output files\&. -.TP --extension -.br -Allow vendor extensions\&. Use of extensions can result in applications that are not portable or that do not work with other implementations\&. -.TP --help -.br -Displays a help message about the \f3wsgen\fR command\&. -.TP --keep -.br -Keeps the generated files\&. -.TP --r \fIdirectory\fR -.br -Uses this option with the \f3-wsdl\fR option to specify where to place generated resource files such as WSDLs\&. -.TP --s \fIdirectory\fR -.br -The location for where to place generated source files\&. -.TP --verbose -.br -Displays compiler messages\&. -.TP --version -.br -Prints release information\&. -.TP --wsdl [ :protocol ] \fI\fR -.br -An optional command that generates a WSDL file to review before endpoint deployment\&. The WSDL files contains a machine-readable description of how the service can be called, what parameters it expects, and what data structures it returns\&. - -By default the \f3wsgen\fR command does not generate a WSDL file\&. The \f3protocol\fR value is optional and is used to specify what protocol should be used for the WSDL binding (\f3wsdl:binding\fR)\&. Valid protocols are \f3soap1\&.1\fR and \f3Xsoap1\&.2\fR\&. The default is \f3soap1\&.1\fR\&. The \f3Xsoap1\&.2\fR protocol is not standard and can only be used with the \f3-extension\fR option\&. -.TP --servicename \fIname\fR -.br -Used only with the \f3-wsdl\fR option to specify a particular WSDL service (\f3wsdl:service\fR) name to be generated in the WSDL, for example: \f3-servicename "{http://mynamespace/}MyService"\fR\&. -.TP --portname \fIname\fR -.br -Used only with the \f3-wsdl\fR option to specify a particular WSDL port (\f3wsdl:port\fR) name to be generated in the WSDL, for example: \f3-portname "{http://mynamespace/}MyPort"\fR\&. -.SH EXAMPLES -The following example generates the wrapper classes for \f3StockService\fR with \f3@WebService\fR annotations inside stock directory\&. -.sp -.nf -\f3wsgen \-d stock \-cp myclasspath stock\&.StockService\fP -.fi -.nf -\f3\fP -.fi -.sp -The following example generates a SOAP 1\&.1 WSDL and schema for the \f3stock\&.StockService\fR class with \f3@WebService\fR annotations\&. -.sp -.nf -\f3wsgen \-wsdl \-d stock \-cp myclasspath stock\&.StockService\fP -.fi -.nf -\f3\fP -.fi -.sp -The following example generates a SOAP 1\&.2 WSDL\&. -.sp -.nf -\f3wsgen \-wsdl:Xsoap1\&.2 \-d stock \-cp myclasspath stock\&.StockService \fP -.fi -.nf -\f3\fP -.fi -.sp -\fINote:\fR You do not have to generate WSDL at development time because the JAXWS run time environment generates a WSDL for you when you deploy your service\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -wsimport(1) -.TP 0.2i -\(bu -\fIThe Tools\fR tab of the JAX-WS (wsgen) page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsgenant\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2005, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Web Services Tools +.\" Title: wsgen.1 +.\" +.if n .pl 99999 +.TH wsgen 1 "21 November 2013" "JDK 8" "Java Web Services Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +wsgen \- Reads a web service endpoint implementation (SEI) class and generates all of the required artifacts for web service deployment, and invocation\&. +.SH SYNOPSIS +.sp +.nf + +\fBwsgen\fR [ \fIoptions\fR ] \fISEI\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fISEI\fR +The web service endpoint implementation class (SEI) to be read\&. +.SH DESCRIPTION +The \f3wsgen\fR command 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 \f3wsgen\fR Ant task, see the \fITools\fR tab of the JAX-WS (wsgen) page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsgenant\&.html +.PP +To start the \f3wsgen\fR command, do the following: +.sp +.nf +\f3export JAXWS_HOME=/pathto/jaxws\-ri\fP +.fi +.nf +\f3$JAXWS_HOME/bin/wsgen\&.sh \-help\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-classpath \fIpath\fR +.br +The location of the input class files\&. +.TP +-cp \fIpath\fR +.br +The location of the input class files\&. +.TP +-d \fIdirectory\fR +.br +The location for where to place generated output files\&. +.TP +-extension +.br +Allow vendor extensions\&. Use of extensions can result in applications that are not portable or that do not work with other implementations\&. +.TP +-help +.br +Displays a help message about the \f3wsgen\fR command\&. +.TP +-keep +.br +Keeps the generated files\&. +.TP +-r \fIdirectory\fR +.br +Uses this option with the \f3-wsdl\fR option to specify where to place generated resource files such as WSDLs\&. +.TP +-s \fIdirectory\fR +.br +The location for where to place generated source files\&. +.TP +-verbose +.br +Displays compiler messages\&. +.TP +-version +.br +Prints release information\&. +.TP +-wsdl [ :protocol ] \fI\fR +.br +An optional command that generates a WSDL file to review before endpoint deployment\&. The WSDL files contains a machine-readable description of how the service can be called, what parameters it expects, and what data structures it returns\&. + +By default the \f3wsgen\fR command does not generate a WSDL file\&. The \f3protocol\fR value is optional and is used to specify what protocol should be used for the WSDL binding (\f3wsdl:binding\fR)\&. Valid protocols are \f3soap1\&.1\fR and \f3Xsoap1\&.2\fR\&. The default is \f3soap1\&.1\fR\&. The \f3Xsoap1\&.2\fR protocol is not standard and can only be used with the \f3-extension\fR option\&. +.TP +-servicename \fIname\fR +.br +Used only with the \f3-wsdl\fR option to specify a particular WSDL service (\f3wsdl:service\fR) name to be generated in the WSDL, for example: \f3-servicename "{http://mynamespace/}MyService"\fR\&. +.TP +-portname \fIname\fR +.br +Used only with the \f3-wsdl\fR option to specify a particular WSDL port (\f3wsdl:port\fR) name to be generated in the WSDL, for example: \f3-portname "{http://mynamespace/}MyPort"\fR\&. +.SH EXAMPLES +The following example generates the wrapper classes for \f3StockService\fR with \f3@WebService\fR annotations inside stock directory\&. +.sp +.nf +\f3wsgen \-d stock \-cp myclasspath stock\&.StockService\fP +.fi +.nf +\f3\fP +.fi +.sp +The following example generates a SOAP 1\&.1 WSDL and schema for the \f3stock\&.StockService\fR class with \f3@WebService\fR annotations\&. +.sp +.nf +\f3wsgen \-wsdl \-d stock \-cp myclasspath stock\&.StockService\fP +.fi +.nf +\f3\fP +.fi +.sp +The following example generates a SOAP 1\&.2 WSDL\&. +.sp +.nf +\f3wsgen \-wsdl:Xsoap1\&.2 \-d stock \-cp myclasspath stock\&.StockService \fP +.fi +.nf +\f3\fP +.fi +.sp +\fINote:\fR You do not have to generate WSDL at development time because the JAXWS run time environment generates a WSDL for you when you deploy your service\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +wsimport(1) +.TP 0.2i +\(bu +\fIThe Tools\fR tab of the JAX-WS (wsgen) page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsgenant\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/wsimport.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/wsimport.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,216 +1,216 @@ -'\" t -.\" Copyright (c) 2005, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java Web Services Tools -.\" Title: wsimport.1 -.\" -.if n .pl 99999 -.TH wsimport 1 "21 November 2013" "JDK 8" "Java Web Services Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -wsimport \- Generates JAX-WS portable artifacts that can be packaged in a web application archive (WAR) file and provides an Ant task\&. -.SH SYNOPSIS -.sp -.nf - -\fBwsimport\fR [ \fIoptions\fR ] \fIwsdl\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIwsdl\fR -The file that contains the machine-readable description of how the web service can be called, what parameters it expects, and what data structures it returns\&. -.SH DESCRIPTION -The \f3wsimport\fR command generates the following JAX-WS portable artifacts\&. These artifacts can be packaged in a WAR file with the WSDL and schema documents and the endpoint implementation to be deployed\&. The \f3wsimport\fR command also provides a \f3wsimport\fR Ant task, see the Tools tab of the Wsimport Ant Task page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html -.TP 0.2i -\(bu -Service Endpoint Interface (SEI) -.TP 0.2i -\(bu -Service -.TP 0.2i -\(bu -Exception class is mapped from \f3wsdl:fault\fR (if any) -.TP 0.2i -\(bu -Async Response Bean is derived from response \f3wsdl:message\fR (if any) -.TP 0.2i -\(bu -JAXB generated value types (mapped java classes from schema types) -.PP -To start the \f3wsgen\fR command, do the following: -.PP -\fIOracle Solaris/Linux\fR: -.sp -.nf -\f3/bin/wsimport\&.sh \-help\fP -.fi -.nf -\f3\fP -.fi -.sp -\fIWindows\fR: -.sp -.nf -\f3\ebin\ewsimport\&.bat \-help\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH OPTIONS -.TP --d \fIdirectory\fR -.br -Specifies where to place generated output files\&. -.TP --b \fIpath\fR -.br -Specifies external JAX-WS or JAXB binding files\&. Multiple JAX-WS and JAXB binding files can be specified with the \f3-b\fR option\&. You can use these files to customize package names, bean names, and so on\&. For more information about JAX-WS and JAXB binding files, see the \fIUsers Guide\fR tab of WSDL Customization at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html -.TP --B \fIjaxbOption\fR -.br -Passes the \f3jaxbOption\fR option to the JAXB schema compiler\&. -.TP --catalog -.br -Specifies a catalog file to resolve external entity references\&. The \f3-catalog\fR option supports the TR9401, XCatalog, and OASIS XML Catalog formats\&. See the \fIUsers Guide\fR tab of the Catalog Support page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/catalog-support\&.html -.TP --extension -.br -Allows vendor extensions\&. Use of extensions can result in applications that are not portable or that do not work with other implementations\&. -.TP --help -.br -Displays a help message for the \f3wsimport\fR command\&. -.TP --httpproxy: \fIhost\fR:\fIport\fR -.br -Specifies an HTTP proxy server\&. The default is 8080\&. -.TP --keep -.br -Keeps generated files\&. -.TP --p \fIname\fR -.br -Specifies a target package \fIname\fR to override the WSDL and schema binding customizations, and the default algorithm defined in the specification\&. -.TP --s \fIdirectory\fR -.br -Specifies where to place generated source files\&. -.TP --verbose -.br -Displays compiler messages\&. -.TP --version -.br -Prints release information\&. -.TP --wsdllocation \fIlocation\fR -.br -Specifies the \f3@WebServiceClient\&.wsdlLocation\fR value\&. -.TP --target -.br -Generates code according to the specified JAX-WS specification version\&. Version 2\&.0 generates compliant code for the JAX-WS 2\&.0 specification\&. -.TP --quiet -.br -Suppresses the \f3wsimport\fR command output\&. -.PP -Multiple \f3JAX-WS\fR and \f3JAXB\fR binding files can be specified using the \f3-b\fR option, and they can be used to customize various things such as package names and bean names\&. More information about \f3JAX-WS\fR and \f3JAXB\fR binding files can be found in the customization documentation at https://jax-ws\&.dev\&.java\&.net/nonav/2\&.1\&.1/docs/customizations\&.html -.SH NONSTANDARD\ OPTIONS -.TP --XadditionalHeaders -.br -Maps headers not bound to a request or response message to Java method parameters\&. -.TP --Xauthfile \fIfile\fR -.br -The WSDL URI that specifies the file that contains authorization information\&. This URI is in the following format: - -http://\fIuser-name\fR:\f3password\fR@\fIhost-name\fR/\fIweb-service-name\fR>?wsdl\&. -.TP --Xdebug -.br -Prints debugging information\&. -.TP --Xno-addressing-databinding -.br -Enables binding of W3C EndpointReferenceType to Java\&. -.TP --Xnocompile -.br -Does not compile the generated Java files\&. -.SH EXAMPLE -The following example generates the Java artifacts and compiles the artifacts by importing \f3http://stockquote\&.example\&.com/quote?wsdl\fR -.sp -.nf -\f3wsimport \-p stockquote http://stockquote\&.example\&.com/quote?wsdl\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH SEE\ ALSO -.TP 0.2i -\(bu -wsgen(1) -.TP 0.2i -\(bu -The Tools tab of Wsimport Ant Task page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html -.TP 0.2i -\(bu -The \fIUsers Guide\fR tab of Catalog Support page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/catalog-support\&.html -.TP 0.2i -\(bu -The \fIUsers Guide\fR tab of WSDL Customization page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2005, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Web Services Tools +.\" Title: wsimport.1 +.\" +.if n .pl 99999 +.TH wsimport 1 "21 November 2013" "JDK 8" "Java Web Services Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +wsimport \- Generates JAX-WS portable artifacts that can be packaged in a web application archive (WAR) file and provides an Ant task\&. +.SH SYNOPSIS +.sp +.nf + +\fBwsimport\fR [ \fIoptions\fR ] \fIwsdl\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIwsdl\fR +The file that contains the machine-readable description of how the web service can be called, what parameters it expects, and what data structures it returns\&. +.SH DESCRIPTION +The \f3wsimport\fR command generates the following JAX-WS portable artifacts\&. These artifacts can be packaged in a WAR file with the WSDL and schema documents and the endpoint implementation to be deployed\&. The \f3wsimport\fR command also provides a \f3wsimport\fR Ant task, see the Tools tab of the Wsimport Ant Task page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html +.TP 0.2i +\(bu +Service Endpoint Interface (SEI) +.TP 0.2i +\(bu +Service +.TP 0.2i +\(bu +Exception class is mapped from \f3wsdl:fault\fR (if any) +.TP 0.2i +\(bu +Async Response Bean is derived from response \f3wsdl:message\fR (if any) +.TP 0.2i +\(bu +JAXB generated value types (mapped java classes from schema types) +.PP +To start the \f3wsgen\fR command, do the following: +.PP +\fIOracle Solaris/Linux\fR: +.sp +.nf +\f3/bin/wsimport\&.sh \-help\fP +.fi +.nf +\f3\fP +.fi +.sp +\fIWindows\fR: +.sp +.nf +\f3\ebin\ewsimport\&.bat \-help\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-d \fIdirectory\fR +.br +Specifies where to place generated output files\&. +.TP +-b \fIpath\fR +.br +Specifies external JAX-WS or JAXB binding files\&. Multiple JAX-WS and JAXB binding files can be specified with the \f3-b\fR option\&. You can use these files to customize package names, bean names, and so on\&. For more information about JAX-WS and JAXB binding files, see the \fIUsers Guide\fR tab of WSDL Customization at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html +.TP +-B \fIjaxbOption\fR +.br +Passes the \f3jaxbOption\fR option to the JAXB schema compiler\&. +.TP +-catalog +.br +Specifies a catalog file to resolve external entity references\&. The \f3-catalog\fR option supports the TR9401, XCatalog, and OASIS XML Catalog formats\&. See the \fIUsers Guide\fR tab of the Catalog Support page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/catalog-support\&.html +.TP +-extension +.br +Allows vendor extensions\&. Use of extensions can result in applications that are not portable or that do not work with other implementations\&. +.TP +-help +.br +Displays a help message for the \f3wsimport\fR command\&. +.TP +-httpproxy: \fIhost\fR:\fIport\fR +.br +Specifies an HTTP proxy server\&. The default is 8080\&. +.TP +-keep +.br +Keeps generated files\&. +.TP +-p \fIname\fR +.br +Specifies a target package \fIname\fR to override the WSDL and schema binding customizations, and the default algorithm defined in the specification\&. +.TP +-s \fIdirectory\fR +.br +Specifies where to place generated source files\&. +.TP +-verbose +.br +Displays compiler messages\&. +.TP +-version +.br +Prints release information\&. +.TP +-wsdllocation \fIlocation\fR +.br +Specifies the \f3@WebServiceClient\&.wsdlLocation\fR value\&. +.TP +-target +.br +Generates code according to the specified JAX-WS specification version\&. Version 2\&.0 generates compliant code for the JAX-WS 2\&.0 specification\&. +.TP +-quiet +.br +Suppresses the \f3wsimport\fR command output\&. +.PP +Multiple \f3JAX-WS\fR and \f3JAXB\fR binding files can be specified using the \f3-b\fR option, and they can be used to customize various things such as package names and bean names\&. More information about \f3JAX-WS\fR and \f3JAXB\fR binding files can be found in the customization documentation at https://jax-ws\&.dev\&.java\&.net/nonav/2\&.1\&.1/docs/customizations\&.html +.SH NONSTANDARD\ OPTIONS +.TP +-XadditionalHeaders +.br +Maps headers not bound to a request or response message to Java method parameters\&. +.TP +-Xauthfile \fIfile\fR +.br +The WSDL URI that specifies the file that contains authorization information\&. This URI is in the following format: + +http://\fIuser-name\fR:\f3password\fR@\fIhost-name\fR/\fIweb-service-name\fR>?wsdl\&. +.TP +-Xdebug +.br +Prints debugging information\&. +.TP +-Xno-addressing-databinding +.br +Enables binding of W3C EndpointReferenceType to Java\&. +.TP +-Xnocompile +.br +Does not compile the generated Java files\&. +.SH EXAMPLE +The following example generates the Java artifacts and compiles the artifacts by importing \f3http://stockquote\&.example\&.com/quote?wsdl\fR +.sp +.nf +\f3wsimport \-p stockquote http://stockquote\&.example\&.com/quote?wsdl\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +wsgen(1) +.TP 0.2i +\(bu +The Tools tab of Wsimport Ant Task page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html +.TP 0.2i +\(bu +The \fIUsers Guide\fR tab of Catalog Support page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/catalog-support\&.html +.TP 0.2i +\(bu +The \fIUsers Guide\fR tab of WSDL Customization page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/linux/doc/man/xjc.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/linux/doc/man/xjc.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,232 +1,232 @@ -'\" t -.\" Copyright (c) 2005, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java Web Services Tools -.\" Title: xjc.1 -.\" -.if n .pl 99999 -.TH xjc 1 "21 November 2013" "JDK 8" "Java Web Services Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -xjc \- Compiles an XML schema file into fully annotated Java classes\&. -.SH SYNOPSIS -.sp -.nf - -\fBxjc\fR [ \fIoptions\fR ] \fBschema\fR \fIfile/URL/dir/jar\fR \&.\&.\&. [\fB\-b\fR \fIbindinfo\fR ] \&.\&.\&. -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -schema \fIfile/URL/dir/jar \&.\&.\&.\fR -The location of the XML schema file\&. If \f3dir\fR is specified, then all schema files in it are compiled\&. If \f3jar\fR is specified, then the \f3/META-INF/sun-jaxb\&.episode\fR binding file is compiled\&. -.TP --b \fIbindinfo\fR -.br -The location of the bindings files\&. -.SH DESCRIPTION -Start the binding compiler with the appropriate \f3xjc\fR shell script in the bin directory for your platform\&. There is also an Ant task to run the binding complier\&. See Using the XJC with Ant at http://jaxb\&.java\&.net/nonav/2\&.1\&.3/docs/xjcTask\&.html -.SH OPTIONS -.TP 0.2i -\(bu -See also Nonstandard Options -.TP 0.2i -\(bu -See also Deprecated and Removed Options -.TP --nv -.br -By default, the XJC binding compiler performs strict validation of the source schema before processing it\&. Use this option to disable strict schema validation\&. This does not mean that the binding compiler will not perform any validation, but means that it will perform a less-strict validation\&. -.TP --extension -.br -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 \f3-extension\fR mode enabled by this switch\&. In the default (strict) mode, you are also limited to using only the binding customization defined in the specification\&. By using the \f3-extension\fR switch, you will be allowed to use the JAXB Vendor Extensions\&. -.TP --b \fIfile\fR -.br -Specifies one or more external binding files to process\&. Each binding file must have its own \f3-b\fR switch\&. The syntax of the external binding files is flexible\&. You can have a single binding file that contains customization for multiple schemas or you can break the customization into multiple bindings files: \f3xjc schema1\&.xsd schema2\&.xsd schema3\&.xsd -b bindings123\&.xjb\fR\f3xjc schema1\&.xsd schema2\&.xsd schema3\&.xsd -b bindings1\&.xjb -b bindings2\&.xjb -b bindings3\&.xjb\fR\&. In addition, the ordering of the schema files and binding files on the command line does not matter\&. -.TP --d \fIdir\fR -.br -By default, the XJC binding compiler generates 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 does not create it for you\&. -.TP --p \fIpkg\fR -.br -When you specify a target package with this command-line option, it overrides any binding customization for the package name and the default package name algorithm defined in the specification\&. -.TP --httpproxy \fIproxy\fR -.br -Specifies the HTTP or HTTPS proxy in the format \fI[user[:password]@]proxyHost[:proxyPort]\fR\&. The old \f3-host\fR and \f3-port\fR options are still supported by the RI for backward compatibility, but they were deprecated\&. The password specified with this option is an argument that is visible to other users who use the top command\&. For greater security, use the \f3-httpproxyfile\fR option\&. -.TP --httpproxyfile file -.br -Specifies the HTTP or HTTPS proxy with a file\&. The same format as the \f3-httpproxy\fR option, but the password specified in the file is not visible to other users\&. -.TP --classpath arg -.br -Specifies where to find client application class files used by the \fIjxb:javaType\fR and xjc:\fIsuperClass\fR customization\&. -.TP --catalog file -.br -Specifies catalog files to resolve external entity references\&. Supports the TR9401, XCatalog, and OASIS XML Catalog formats\&. See XML Entity and URI Resolvers at http://xerces\&.apache\&.org/xml-commons/components/resolver/resolver-article\&.html -.TP --readOnly -.br -By default, the XJC binding compiler does not write-protect the Java source files it generates\&. Use this option to force the XJC binding compiler to mark the generated Java sources as read-only\&. -.TP --npa -.br -Suppresses the generation of package level annotations into \f3**/package-info\&.java\fR\&. Using this switch causes the generated code to internalize those annotations into the other generated classes\&. -.TP --no-header -.br -Suppresses the generation of a file header comment that includes some note and time stamp\&. Using this makes the generated code more compatible with the \f3diff\fR command\&. -.TP --target 2\&.0 -.br -Avoids generating code that relies on any JAXB 2\&.1 features\&. This will allow the generated code to run with JAXB 2\&.0 runtime environment (such as Java SE 6)\&. -.TP --xmlschema -.br -Treats input schemas as W3C XML Schema (default)\&. If you do not specify this switch, then your input schemas are treated as though they are W3C XML Schemas\&. -.TP --relaxing -.br -Treats input schemas as RELAX NG (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. -.TP --relaxing-compact -.br -Treat input schemas as RELAX NG compact syntax (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. -.TP --dtd -.br -Treats input schemas as XML DTD (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. -.TP --wsdl -.br -Treats input as WSDL and compiles schemas inside it (experimental and unsupported)\&. -.TP --quiet -.br -Suppress compiler output, such as progress information and warnings\&. -.TP --verbose -.br -Be extra verbose, such as printing informational messages or displaying stack traces upon some errors\&. -.TP --help -.br -Displays a brief summary of the compiler switches\&. -.TP --version -.br -Displays the compiler version information\&. -.TP -\fIschema file/URL/dir\fR -Specifies one or more schema files to compile\&. If you specify a directory, then the \f3xjc\fR command scans it for all schema files and compiles them\&. -.SS NONSTANDARD\ OPTIONS -.TP --XLocator -.br -Causes the generated code to expose SAX Locator information about the source XML in the Java bean instances after unmarshalling\&. -.TP --Xsync-methods -.br -Causes all of the generated method signatures to include the \f3synchronized\fR keyword\&. -.TP --mark-generated -.br -Marks the generated code with the annotation \f3@javax\&.annotation\&.Generated\fR\&. -.TP --episode file -.br -Generates the specified episode file for separate compilation\&. -.SS DEPRECATED\ AND\ REMOVED\ OPTIONS -.TP --host & -port -.br -These options are replaced with the \f3-httpproxy\fR option\&. For backward compatibility, these options are supported, but will not be documented and might be removed from future releases\&. -.TP --use-runtime -.br -Because the JAXB 2\&.0 specification has defined a portable runtime environment, it is no longer necessary for the JAXB RI to generate \f3**/impl/runtime\fRpackages\&. Therefore, this switch is obsolete and was removed\&. -.TP --source -.br -The \f3-source\fR compatibility switch was introduced in the first JAXB 2\&.0 Early Access release\&. This switch is removed from future releases of JAXB 2\&.0\&. If you need to generate 1\&.0\&.x code, then use an installation of the 1\&.0\&.x code base\&. -.SH COMPILER\ RESTRICTIONS -In general, it is safest to compile all related schemas as a single unit with the same binding compiler switches\&. Keep the following list of restrictions in mind when running the \f3xjc\fR command\&. Most of these issues only apply when you compile multiple schemas with multiple invocations of the \f3xjc\fR command\&. -.PP -To compile multiple schemas at the same time, keep the following precedence rules for the target Java package name in mind: -.TP 0.4i -1\&. -The \f3-p\fR option has the highest precedence\&. -.TP 0.4i -2\&. -\fIjaxb:package\fR customization\&. -.TP 0.4i -3\&. -If \f3targetNamespace\fR is declared, then apply the \f3t\fR\f3argetNamespace\fR to the Java package name algorithm defined in the specification\&. -.TP 0.4i -4\&. -If no \f3targetNamespace\fR is declared, then use a hard coded package named \f3generated\fR\&. -.PP -You cannot have more than one \fIjaxb:schemaBindings\fR per name space, so it is impossible to have two schemas in the same target name space compiled into different Java packages\&. -.PP -All schemas being compiled into the same Java package must be submitted to the XJC binding compiler at the same time\&. They cannot be compiled independently and work as expected\&. -.PP -Element substitution groups that are spread across multiple schema files must be compiled at the same time\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -Binding Compiler (xjc) at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/xjc\&.html -.TP 0.2i -\(bu -Java Architecture for XML Binding (JAXB) at http://www\&.oracle\&.com/technetwork/articles/javase/index-140168\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2005, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Web Services Tools +.\" Title: xjc.1 +.\" +.if n .pl 99999 +.TH xjc 1 "21 November 2013" "JDK 8" "Java Web Services Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +xjc \- Compiles an XML schema file into fully annotated Java classes\&. +.SH SYNOPSIS +.sp +.nf + +\fBxjc\fR [ \fIoptions\fR ] \fBschema\fR \fIfile/URL/dir/jar\fR \&.\&.\&. [\fB\-b\fR \fIbindinfo\fR ] \&.\&.\&. +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +schema \fIfile/URL/dir/jar \&.\&.\&.\fR +The location of the XML schema file\&. If \f3dir\fR is specified, then all schema files in it are compiled\&. If \f3jar\fR is specified, then the \f3/META-INF/sun-jaxb\&.episode\fR binding file is compiled\&. +.TP +-b \fIbindinfo\fR +.br +The location of the bindings files\&. +.SH DESCRIPTION +Start the binding compiler with the appropriate \f3xjc\fR shell script in the bin directory for your platform\&. There is also an Ant task to run the binding complier\&. See Using the XJC with Ant at http://jaxb\&.java\&.net/nonav/2\&.1\&.3/docs/xjcTask\&.html +.SH OPTIONS +.TP 0.2i +\(bu +See also Nonstandard Options +.TP 0.2i +\(bu +See also Deprecated and Removed Options +.TP +-nv +.br +By default, the XJC binding compiler performs strict validation of the source schema before processing it\&. Use this option to disable strict schema validation\&. This does not mean that the binding compiler will not perform any validation, but means that it will perform a less-strict validation\&. +.TP +-extension +.br +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 \f3-extension\fR mode enabled by this switch\&. In the default (strict) mode, you are also limited to using only the binding customization defined in the specification\&. By using the \f3-extension\fR switch, you will be allowed to use the JAXB Vendor Extensions\&. +.TP +-b \fIfile\fR +.br +Specifies one or more external binding files to process\&. Each binding file must have its own \f3-b\fR switch\&. The syntax of the external binding files is flexible\&. You can have a single binding file that contains customization for multiple schemas or you can break the customization into multiple bindings files: \f3xjc schema1\&.xsd schema2\&.xsd schema3\&.xsd -b bindings123\&.xjb\fR\f3xjc schema1\&.xsd schema2\&.xsd schema3\&.xsd -b bindings1\&.xjb -b bindings2\&.xjb -b bindings3\&.xjb\fR\&. In addition, the ordering of the schema files and binding files on the command line does not matter\&. +.TP +-d \fIdir\fR +.br +By default, the XJC binding compiler generates 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 does not create it for you\&. +.TP +-p \fIpkg\fR +.br +When you specify a target package with this command-line option, it overrides any binding customization for the package name and the default package name algorithm defined in the specification\&. +.TP +-httpproxy \fIproxy\fR +.br +Specifies the HTTP or HTTPS proxy in the format \fI[user[:password]@]proxyHost[:proxyPort]\fR\&. The old \f3-host\fR and \f3-port\fR options are still supported by the RI for backward compatibility, but they were deprecated\&. The password specified with this option is an argument that is visible to other users who use the top command\&. For greater security, use the \f3-httpproxyfile\fR option\&. +.TP +-httpproxyfile file +.br +Specifies the HTTP or HTTPS proxy with a file\&. The same format as the \f3-httpproxy\fR option, but the password specified in the file is not visible to other users\&. +.TP +-classpath arg +.br +Specifies where to find client application class files used by the \fIjxb:javaType\fR and xjc:\fIsuperClass\fR customization\&. +.TP +-catalog file +.br +Specifies catalog files to resolve external entity references\&. Supports the TR9401, XCatalog, and OASIS XML Catalog formats\&. See XML Entity and URI Resolvers at http://xerces\&.apache\&.org/xml-commons/components/resolver/resolver-article\&.html +.TP +-readOnly +.br +By default, the XJC binding compiler does not write-protect the Java source files it generates\&. Use this option to force the XJC binding compiler to mark the generated Java sources as read-only\&. +.TP +-npa +.br +Suppresses the generation of package level annotations into \f3**/package-info\&.java\fR\&. Using this switch causes the generated code to internalize those annotations into the other generated classes\&. +.TP +-no-header +.br +Suppresses the generation of a file header comment that includes some note and time stamp\&. Using this makes the generated code more compatible with the \f3diff\fR command\&. +.TP +-target 2\&.0 +.br +Avoids generating code that relies on any JAXB 2\&.1 features\&. This will allow the generated code to run with JAXB 2\&.0 runtime environment (such as Java SE 6)\&. +.TP +-xmlschema +.br +Treats input schemas as W3C XML Schema (default)\&. If you do not specify this switch, then your input schemas are treated as though they are W3C XML Schemas\&. +.TP +-relaxing +.br +Treats input schemas as RELAX NG (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. +.TP +-relaxing-compact +.br +Treat input schemas as RELAX NG compact syntax (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. +.TP +-dtd +.br +Treats input schemas as XML DTD (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. +.TP +-wsdl +.br +Treats input as WSDL and compiles schemas inside it (experimental and unsupported)\&. +.TP +-quiet +.br +Suppress compiler output, such as progress information and warnings\&. +.TP +-verbose +.br +Be extra verbose, such as printing informational messages or displaying stack traces upon some errors\&. +.TP +-help +.br +Displays a brief summary of the compiler switches\&. +.TP +-version +.br +Displays the compiler version information\&. +.TP +\fIschema file/URL/dir\fR +Specifies one or more schema files to compile\&. If you specify a directory, then the \f3xjc\fR command scans it for all schema files and compiles them\&. +.SS NONSTANDARD\ OPTIONS +.TP +-XLocator +.br +Causes the generated code to expose SAX Locator information about the source XML in the Java bean instances after unmarshalling\&. +.TP +-Xsync-methods +.br +Causes all of the generated method signatures to include the \f3synchronized\fR keyword\&. +.TP +-mark-generated +.br +Marks the generated code with the annotation \f3@javax\&.annotation\&.Generated\fR\&. +.TP +-episode file +.br +Generates the specified episode file for separate compilation\&. +.SS DEPRECATED\ AND\ REMOVED\ OPTIONS +.TP +-host & -port +.br +These options are replaced with the \f3-httpproxy\fR option\&. For backward compatibility, these options are supported, but will not be documented and might be removed from future releases\&. +.TP +-use-runtime +.br +Because the JAXB 2\&.0 specification has defined a portable runtime environment, it is no longer necessary for the JAXB RI to generate \f3**/impl/runtime\fRpackages\&. Therefore, this switch is obsolete and was removed\&. +.TP +-source +.br +The \f3-source\fR compatibility switch was introduced in the first JAXB 2\&.0 Early Access release\&. This switch is removed from future releases of JAXB 2\&.0\&. If you need to generate 1\&.0\&.x code, then use an installation of the 1\&.0\&.x code base\&. +.SH COMPILER\ RESTRICTIONS +In general, it is safest to compile all related schemas as a single unit with the same binding compiler switches\&. Keep the following list of restrictions in mind when running the \f3xjc\fR command\&. Most of these issues only apply when you compile multiple schemas with multiple invocations of the \f3xjc\fR command\&. +.PP +To compile multiple schemas at the same time, keep the following precedence rules for the target Java package name in mind: +.TP 0.4i +1\&. +The \f3-p\fR option has the highest precedence\&. +.TP 0.4i +2\&. +\fIjaxb:package\fR customization\&. +.TP 0.4i +3\&. +If \f3targetNamespace\fR is declared, then apply the \f3t\fR\f3argetNamespace\fR to the Java package name algorithm defined in the specification\&. +.TP 0.4i +4\&. +If no \f3targetNamespace\fR is declared, then use a hard coded package named \f3generated\fR\&. +.PP +You cannot have more than one \fIjaxb:schemaBindings\fR per name space, so it is impossible to have two schemas in the same target name space compiled into different Java packages\&. +.PP +All schemas being compiled into the same Java package must be submitted to the XJC binding compiler at the same time\&. They cannot be compiled independently and work as expected\&. +.PP +Element substitution groups that are spread across multiple schema files must be compiled at the same time\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +Binding Compiler (xjc) at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/xjc\&.html +.TP 0.2i +\(bu +Java Architecture for XML Binding (JAXB) at http://www\&.oracle\&.com/technetwork/articles/javase/index-140168\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/appletviewer.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/appletviewer.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,89 +1,89 @@ -'\" t -.\" Copyright (c) 1995, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Basic Tools -.\" Title: appletviewer.1 -.\" -.if n .pl 99999 -.TH appletviewer 1 "21 November 2013" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -appletviewer \- Runs applets outside of a web browser\&. -.SH SYNOPSIS -.sp -.nf - -\fBappletviewer\fR [\fIoptions\fR] \fIurl\fR\&.\&.\&. -.fi -.sp -.TP -\fIoptions\fR -The command-line options separated by spaces\&. See Options\&. -.TP -\fIurl\fR -The location of the documents or resources to be displayed\&. You can specify multiple URLs separated by spaces\&. -.SH DESCRIPTION -The \f3appletviewer\fR command connects to the documents or resources designated by \fIurls\fR and displays each applet referenced by the documents in its own window\&. If the documents referred to by urls do not reference any applets with the \f3OBJECT\fR, \f3EMBED\fR, or \f3APPLET\fR tag, then the \f3appletviewer\fR command does nothing\&. For details about the HTML tags that the \f3appletviewer\fR command supports, see AppletViewer Tags at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/appletviewertags\&.html -.PP -The \f3appletviewer\fR command 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\&. -.PP -\fINote:\fR The \f3appletviewer\fR command is intended for development purposes only\&. For more information, see About Sample/Test Applications and Code at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/aboutCodeSamples\&.html -.SH OPTIONS -.TP --debug -.br -Starts the Applet Viewer in the Java debugger with the \f3jdb\fR command to debug the applets in the document\&. -.TP --encoding \fIencoding-name\fR -.br -Specifies the input HTML file encoding name\&. -.TP --J\fIjavaoption\fR -.br -Passes the string \f3javaoption\fR as a single argument to the Java interpreter, which runs the Applet Viewer\&. The argument should not contain spaces\&. Multiple argument words must all begin with the prefix \f3-J\fR\&. This is useful for adjusting the compiler\&'s execution environment or memory usage\&. -.PP -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1995, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: appletviewer.1 +.\" +.if n .pl 99999 +.TH appletviewer 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +appletviewer \- Runs applets outside of a web browser\&. +.SH SYNOPSIS +.sp +.nf + +\fBappletviewer\fR [\fIoptions\fR] \fIurl\fR\&.\&.\&. +.fi +.sp +.TP +\fIoptions\fR +The command-line options separated by spaces\&. See Options\&. +.TP +\fIurl\fR +The location of the documents or resources to be displayed\&. You can specify multiple URLs separated by spaces\&. +.SH DESCRIPTION +The \f3appletviewer\fR command connects to the documents or resources designated by \fIurls\fR and displays each applet referenced by the documents in its own window\&. If the documents referred to by urls do not reference any applets with the \f3OBJECT\fR, \f3EMBED\fR, or \f3APPLET\fR tag, then the \f3appletviewer\fR command does nothing\&. For details about the HTML tags that the \f3appletviewer\fR command supports, see AppletViewer Tags at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/appletviewertags\&.html +.PP +The \f3appletviewer\fR command 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\&. +.PP +\fINote:\fR The \f3appletviewer\fR command is intended for development purposes only\&. For more information, see About Sample/Test Applications and Code at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/aboutCodeSamples\&.html +.SH OPTIONS +.TP +-debug +.br +Starts the Applet Viewer in the Java debugger with the \f3jdb\fR command to debug the applets in the document\&. +.TP +-encoding \fIencoding-name\fR +.br +Specifies the input HTML file encoding name\&. +.TP +-J\fIjavaoption\fR +.br +Passes the string \f3javaoption\fR as a single argument to the Java interpreter, which runs the Applet Viewer\&. The argument should not contain spaces\&. Multiple argument words must all begin with the prefix \f3-J\fR\&. This is useful for adjusting the compiler\&'s execution environment or memory usage\&. +.PP +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/extcheck.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/extcheck.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,90 +1,90 @@ -'\" t -.\" Copyright (c) 1998, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Basic Tools -.\" Title: extcheck.1 -.\" -.if n .pl 99999 -.TH extcheck 1 "21 November 2013" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -extcheck \- Detects version conflicts between a target Java Archive (JAR) file and currently installed extension JAR files\&. -.SH SYNOPSIS -.sp -.nf - -\fBextcheck\fR [\fIoptions\fR] \fItargetfile\&.jar\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fItargetfile\&.jar\fR -The target JAR file against which the currently installed extension JAR files are compared to detect version conflicts\&. -.SH DESCRIPTION -The \f3extcheck\fR command checks a specified JAR file for title and version conflicts with any extensions installed in the Java SE SDK\&. Before installing an extension, you can use this utility to see whether the same or a more recent version of the extension is already installed\&. -.PP -The \f3extcheck\fR command compares the Specification-title and Specification-version headers in the manifest of the \f3targetfile\&.jar\fR file against the corresponding headers in all JAR files currently installed in the extension directory\&. By default, the extension directory is \f3jre/lib/ext\fR on Oracle Solaris and \f3\ejre\elib\eext\fR on Windows\&. The \f3extcheck\fR command compares version numbers in the same way as the \f3java\&.lang\&.Package\&.isCompatibleWith\fR method\&. -.PP -If no conflict is detected, then the return code is 0\&. -.PP -If the manifest of any JAR file in the extensions directory has the same \f3Specification-title\fR and the same or a newer \f3Specification-version\fR number, then a non-zero error code is returned\&. A non-zero error code is also returned when \f3targetfile\&.jar\fR does not have the \f3Specification-title\fR or \f3Specification-version\fR attributes in its manifest file\&. -.SH OPTIONS -.TP --verbose -.br -Lists JAR files in the extension directory as they are checked\&. Additionally, manifest attributes of the target JAR file and any conflicting JAR files are also reported\&. -.TP --J\fIoption\fR -.br -Passes \fIoption\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -jar(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1998, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: extcheck.1 +.\" +.if n .pl 99999 +.TH extcheck 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +extcheck \- Detects version conflicts between a target Java Archive (JAR) file and currently installed extension JAR files\&. +.SH SYNOPSIS +.sp +.nf + +\fBextcheck\fR [\fIoptions\fR] \fItargetfile\&.jar\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fItargetfile\&.jar\fR +The target JAR file against which the currently installed extension JAR files are compared to detect version conflicts\&. +.SH DESCRIPTION +The \f3extcheck\fR command checks a specified JAR file for title and version conflicts with any extensions installed in the Java SE SDK\&. Before installing an extension, you can use this utility to see whether the same or a more recent version of the extension is already installed\&. +.PP +The \f3extcheck\fR command compares the Specification-title and Specification-version headers in the manifest of the \f3targetfile\&.jar\fR file against the corresponding headers in all JAR files currently installed in the extension directory\&. By default, the extension directory is \f3jre/lib/ext\fR on Oracle Solaris and \f3\ejre\elib\eext\fR on Windows\&. The \f3extcheck\fR command compares version numbers in the same way as the \f3java\&.lang\&.Package\&.isCompatibleWith\fR method\&. +.PP +If no conflict is detected, then the return code is 0\&. +.PP +If the manifest of any JAR file in the extensions directory has the same \f3Specification-title\fR and the same or a newer \f3Specification-version\fR number, then a non-zero error code is returned\&. A non-zero error code is also returned when \f3targetfile\&.jar\fR does not have the \f3Specification-title\fR or \f3Specification-version\fR attributes in its manifest file\&. +.SH OPTIONS +.TP +-verbose +.br +Lists JAR files in the extension directory as they are checked\&. Additionally, manifest attributes of the target JAR file and any conflicting JAR files are also reported\&. +.TP +-J\fIoption\fR +.br +Passes \fIoption\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jar(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/idlj.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/idlj.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,567 +1,567 @@ -'\" t -.\" Copyright (c) 2001, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java IDL and RMI-IIOP Tools -.\" Title: idlj.1 -.\" -.if n .pl 99999 -.TH idlj 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -idlj \- Generates Java bindings for a specified Interface Definition Language (IDL) file\&. -.SH SYNOPSIS -.sp -.nf - -\fBidlj\fR [ \fIoptions\fR ] \fIidlfile\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. Options can appear in any order, but must precede the \f3idlfile\fR\&. -.TP -\fIidlfile\fR -The name of a file that contains Interface Definition Language (IDL) definitions\&. -.SH DESCRIPTION -The IDL-to-Java Compiler generates the Java bindings for a specified IDL file\&. For binding details, see Java IDL: IDL to Java Language Mapping at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/mapping/jidlMapping\&.html -.PP -Some earlier releases of the IDL-to-Java compiler were named \f3idltojava\fR\&. -.SS EMIT\ CLIENT\ AND\ SERVER\ BINDINGS -The following \f3idlj\fR command generates an IDL file named \f3My\&.idl\fR with client-side bindings\&. -.sp -.nf -\f3idlj My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -The previous syntax is equivalent to the following: -.sp -.nf -\f3idlj \-fclient My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -The next example generates the server-side bindings, and includes the client-side bindings plus the skeleton, all of which are POA (Inheritance Model)\&. -.sp -.nf -\f3idlg \-fserver My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -If you want to generate both client and server-side bindings, then use one of the following (equivalent) commands: -.sp -.nf -\f3idlj \-fclient \-fserver My\&.idl\fP -.fi -.nf -\f3idlj \-fall My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -There are two possible server-side models: the Portal Servant Inheritance Model and the Tie Model\&. See Tie Delegation Model\&. -.PP -\f3Portable Servant Inheritance Model\fR\&. The default server-side model is the Portable Servant Inheritance Model\&. Given an interface \f3My\fR defined in \f3My\&.idl\fR, the file \f3MyPOA\&.java\fR is generated\&. You must provide the implementation for the \f3My\fR interface, and the \f3My\fR interface must inherit from the \f3MyPOA\fR class\&. \f3MyPOA\&.java\fR is a stream-based skeleton that extends the \f3org\&.omg\&.PortableServer\&.Servant\fR class at http://docs\&.oracle\&.com/javase/8/docs/api/org/omg/PortableServer/Servant\&.html The \f3My\fR interface implements the \f3callHandler\fR interface and the operations interface associated with the IDL interface the skeleton implements\&.The \f3PortableServer\fR module for the Portable Object Adapter (POA) defines the native \f3Servant\fR type\&. See Portable Object Adapter (POA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/POA\&.html In the Java programming language, the \f3Servant\fR type is mapped to the Java \f3org\&.omg\&.PortableServer\&.Servant\fR class\&. It serves as the base class for all POA servant implementations and provides a number of methods that can be called by the application programmer, and methods that are called by the POA and that can be overridden by the user to control aspects of servant behavior\&.Another option for the Inheritance Model is to use the \f3-oldImplBase\fR flag to generate server-side bindings that are compatible with releases of the Java programming language before Java SE 1\&.4\&. The -\f3oldImplBase\fR flag is nonstandard, and these APIs are deprecated\&. You would use this flag only for compatibility with existing servers written in Java SE 1\&.3\&. In that case, you would need to modify an existing make file to add the \f3-oldImplBase\fR flag to the \f3idlj\fR compiler\&. Otherwise POA-based server-side mappings are generated\&. To generate server-side bindings that are backward compatible, do the following: -.sp -.nf -\f3idlj \-fclient \-fserver \-oldImplBase My\&.idl\fP -.fi -.nf -\f3idlj \-fall \-oldImplBase My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -Given an interface \f3My\fR defined in \f3My\&.idl\fR, the file \f3_MyImplBase\&.java\fR is generated\&. You must provide the implementation for the \f3My\fR interface, and the \f3My\fR interface must inherit from the \f3_MyImplBase\fR class\&. -.PP -\f3Tie Delegation Model\fR\&. 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: -.sp -.nf -\f3idlj \-fall My\&.idl\fP -.fi -.nf -\f3idlj \-fallTIE My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -For the \f3My\fR interface, the second command generates \f3MyPOATie\&.java\fR\&. The constructor to the \f3MyPOATie\fR class takes a delegate\&. In this example, using the default POA model, the constructor also needs a POA\&. You must provide the implementation for the delegate, but it does not have to inherit from any other class, only the interface \f3MyOperations\fR\&. To use it with the ORB, you must wrap your implementation within the \f3MyPOATie\fR class, for example: -.sp -.nf -\f3ORB orb = ORB\&.init(args, System\&.getProperties());\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3// Get reference to rootpoa & activate the POAManager\fP -.fi -.nf -\f3POA rootpoa = (POA)orb\&.resolve_initial_references("RootPOA");\fP -.fi -.nf -\f3rootpoa\&.the_POAManager()\&.activate();\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3// create servant and register it with the ORB\fP -.fi -.nf -\f3MyServant myDelegate = new MyServant();\fP -.fi -.nf -\f3myDelegate\&.setORB(orb); \fP -.fi -.nf -\f3\fR -.fi -.nf -\f3// create a tie, with servant being the delegate\&.\fP -.fi -.nf -\f3MyPOATie tie = new MyPOATie(myDelegate, rootpoa);\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3// obtain the objectRef for the tie\fP -.fi -.nf -\f3My ref = tie\&._this(orb);\fP -.fi -.nf -\f3\fR -.fi -.sp -You might want to use the Tie model instead of the typical Inheritance model when 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, then that slot is used up\&. With 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 a method is called\&. -.PP -For server-side generation, Tie model bindings that are compatible with versions of the IDL to Java language mapping in versions earlier than Java SE 1\&.4\&. -.sp -.nf -\f3idlj \-oldImplBase \-fall My\&.idl\fP -.fi -.nf -\f3idlj \-oldImplBase \-fallTIE My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -For the \f3My\fR interface, the this generates \f3My_Tie\&.java\fR\&. The constructor to the \f3My_Tie\fR class takes an \f3impl\fR object\&. You must provide the implementation for \f3impl\fR, but it does not have to inherit from any other class, only the interface \f3HelloOperations\fR\&. But to use it with the ORB, you must wrap your implementation within \f3My_Tie\fR, for example: -.sp -.nf -\f3ORB orb = ORB\&.init(args, System\&.getProperties());\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3// create servant and register it with the ORB\fP -.fi -.nf -\f3MyServant myDelegate = new MyServant();\fP -.fi -.nf -\f3myDelegate\&.setORB(orb); \fP -.fi -.nf -\f3\fR -.fi -.nf -\f3// create a tie, with servant being the delegate\&.\fP -.fi -.nf -\f3MyPOATie tie = new MyPOATie(myDelegate);\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3// obtain the objectRef for the tie\fP -.fi -.nf -\f3My ref = tie\&._this(orb);\fP -.fi -.nf -\f3\fR -.fi -.sp -.SS SPECIFY\ ALTERNATE\ LOCATIONS\ FOR\ EMITTED\ FILES -If you want to direct the emitted files to a directory other than the current directory, then call the compiler this way: \f3i\fR\f3dlj -td /altdir My\&.idl\fR\&. -.PP -For the \f3My\fR interface, the bindings are emitted to \f3/altdir/My\&.java\fR, etc\&., instead of \f3\&./My\&.java\fR\&. -.SS SPECIFY\ ALTERNATE\ LOCATIONS\ FOR\ INCLUDE\ FILES -If the \f3My\&.idl\fR file includes another \f3idl\fR file, \f3MyOther\&.idl\fR, then the compiler assumes that the \f3MyOther\&.idl\fR file resides in the local directory\&. If it resides in \f3/includes\fR, for example, then you call the compiler with the following command: -.sp -.nf -\f3idlj \-i /includes My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -If \f3My\&.idl\fR also included \f3Another\&.idl\fR that resided in \f3/moreIncludes\fR, for example, then you call the compiler with the following command: -.sp -.nf -\f3idlj \-i /includes \-i /moreIncludes My\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -Because this form of \f3include\fR can become long, another way to indicate 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 idl\&.config in a directory that is listed in your \f3CLASSPATH\fR variable\&. Inside of \f3idl\&.config\fR, provide a line with the following form: -.sp -.nf -\f3includes=/includes;/moreIncludes\fP -.fi -.nf -\f3\fR -.fi -.sp -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, and so on\&. -.SS EMIT\ BINDINGS\ FOR\ INCLUDE\ FILES -By default, only those interfaces, structures, and so on, that are defined in the \f3idl\fR 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 \f3idl\fR files: -.sp -.nf -\f3My\&.idl file:\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3#include <MyOther\&.idl>\fP -.fi -.nf -\f3interface My\fP -.fi -.nf -\f3{\fP -.fi -.nf -\f3};\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3MyOther\&.idl file:\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3interface MyOther\fP -.fi -.nf -\f3{\fP -.fi -.nf -\f3};\fP -.fi -.nf -\f3\fR -.fi -.sp -There is a caveat to the default rule\&. Any \f3#include\fR statements that appear at the global scope are treated as described\&. These \f3#include\fR statements can be thought of as import statements\&. The \f3#include\fR statements that appear within an enclosed scope are treated as true \f3#include\fR statements, which means that the code within the included file is treated as though it appeared in the original file and, therefore, Java bindings are emitted for it\&. Here is an example: -.sp -.nf -\f3My\&.idl file:\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3#include <MyOther\&.idl>\fP -.fi -.nf -\f3interface My\fP -.fi -.nf -\f3{\fP -.fi -.nf -\f3 #include <Embedded\&.idl>\fP -.fi -.nf -\f3};\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3MyOther\&.idl file:\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3interface MyOther\fP -.fi -.nf -\f3{\fP -.fi -.nf -\f3};\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3Embedded\&.idl\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3enum E {one, two, three};\fP -.fi -.nf -\f3\fR -.fi -.sp -Run\f3idlj My\&.idl\fRto generate the following list of Java files\&. Notice that \f3MyOther\&.java\fR is not generated because it is defined in an import-like \f3#include\fR\&. But \f3E\&.java\fR was generated because it was defined in a true \f3#include\fR\&. Notice that because the \f3Embedded\&.idl\fR file is included within the scope of the interface \f3My\fR, it appears within the scope of \f3My\fR (in \f3MyPackage\fR)\&. If the \f3-emitAll\fR flag had been used, then all types in all included files would have been emitted\&. -.sp -.nf -\f3\&./MyHolder\&.java\fP -.fi -.nf -\f3\&./MyHelper\&.java\fP -.fi -.nf -\f3\&./_MyStub\&.java\fP -.fi -.nf -\f3\&./MyPackage\fP -.fi -.nf -\f3\&./MyPackage/EHolder\&.java\fP -.fi -.nf -\f3\&./MyPackage/EHelper\&.java\fP -.fi -.nf -\f3\&./MyPackage/E\&.java\fP -.fi -.nf -\f3\&./My\&.java\fP -.fi -.nf -\f3\fR -.fi -.sp -.SS INSERT\ PACKAGE\ PREFIXES -Suppose that you work for a company named ABC that has constructed the following IDL file: -.sp -.nf -\f3Widgets\&.idl file:\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3module Widgets\fP -.fi -.nf -\f3{\fP -.fi -.nf -\f3 interface W1 {\&.\&.\&.};\fP -.fi -.nf -\f3 interface W2 {\&.\&.\&.};\fP -.fi -.nf -\f3};\fP -.fi -.nf -\f3\fR -.fi -.sp -If you run this file through the IDL-to-Java compiler, then the Java bindings for W1 and W2 are placed within the \f3Widgets\fR package\&. There is an industry convention that states that a company\&'s packages should reside within a package named \f3com\&.<company name>\fR\&. To follow this convention, the package name should be \f3com\&.abc\&.Widgets\fR\&. To place this package prefix onto the Widgets module, execute the following: -.sp -.nf -\f3idlj \-pkgPrefix Widgets com\&.abc Widgets\&.idl\fP -.fi -.nf -\f3\fR -.fi -.sp -If you have an IDL file that includes Widgets\&.idl, then the \f3-pkgPrefix\fR flag must appear in that command also\&. If it does not, then your IDL file will be looking for a \f3Widgets\fR package rather than a \f3com\&.abc\&.Widgets\fR package\&. -.PP -If you have a number of these packages that require prefixes, then it might be easier to place them into the idl\&.config file described previously\&. Each package prefix line should be of the form: \f3PkgPrefix\&.<type>=<prefix>\fR\&. The line for the previous example would be \f3PkgPrefix\&.Widgets=com\&.abc\fR\&. This option does not affect the Repository ID\&. -.SS DEFINE\ SYMBOLS\ BEFORE\ COMPILATION -You might 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 \f3idlj -d MYDEF My\&.idl\fRis equivalent to putting the line \f3#define MYDEF\fR inside My\&.idl\&. -.SS PRESERVE\ PREEXISTING\ BINDINGS -If the Java binding files already exist, then the \f3-keep\fR flag keeps the compiler from overwriting them\&. The default is to generate all files without considering that they already exist\&. If you have customized those files (which you should not do unless you are very comfortable with their contents), then the \f3-keep\fR option is very useful\&. The command \f3idlj -keep My\&.idl\fR emits all client-side bindings that do not already exist\&. -.SS VIEW\ COMPILATION\ PROGRESS -The IDL-to-Java compiler generates status messages as it progresses through its phases of execution\&. Use the \f3-v\fR option to activate the verbose mode: \f3idlj -v My\&.idl\fR\&. -.PP -By default the compiler does not operate in verbose mode -.SS DISPLAY\ VERSION\ INFORMATION -To display the build version of the IDL-to-Java compiler, specify the \f3-version\fR option on the command-line: \f3idlj -version\fR\&. -.PP -Version information also appears within the bindings generated by the compiler\&. Any additional options appearing on the command-line are ignored\&. -.SH OPTIONS -.TP --d \fIsymbol\fR -.br -This is equivalent to the following line in an IDL file: -.sp -.nf -\f3#define \fIsymbol\fR\fP -.fi -.nf -\f3\fR -.fi -.sp - -.TP --demitAll -.br -Emit all types, including those found in \f3#include\fR files\&. -.TP --fside -.br -Defines what bindings to emit\&. The \f3side\fR parameter can be \f3client\fR, \f3server\fR, \f3serverTIE\fR, \f3all\fR, or \f3allTIE\fR\&. The \f3-fserverTIE\fR and \f3-fallTIE\fR options cause delegate model skeletons to be emitted\&. Defaults to \f3-fclient\fR when the flag is not specified\&. -.TP --i \fIinclude-path\fR -.br -By default, the current directory is scanned for included files\&. This option adds another directory\&. -.TP --i \fIkeep\fR -.br -If a file to be generated already exists, then do not overwrite it\&. By default it is overwritten\&. -.TP --noWarn -.br -Suppress warning messages\&. -.TP --oldImplBase -.br -Generates skeletons compatible with pre-1\&.4 JDK ORBs\&. By default, the POA Inheritance Model server-side bindings are generated\&. This option provides backward-compatibility with earlier releases of the Java programming language by generating server-side bindings that are \f3ImplBase\fR Inheritance Model classes\&. -.TP --pkgPrefix \fItype\fR\fIprefix\fR -.br -Wherever \f3type\fR is encountered at file scope, prefix the generated Java package name with \f3prefix\fR for all files generated for that type\&. The type is the simple name of either a top-level module, or an IDL type defined outside of any module\&. -.TP --pkgTranslate \fItype\fR\fIpackage\fR -.br -Whenever the module name type is encountered in an identifier, replace it in the identifier with package for all files in the generated Java package\&. Note that \f3pkgPrefix\fR changes are made first\&. The type value 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\&. - -If more than one translation matches an identifier, then the longest match is chosen as shown in the following example: - -\fICommand\fR: -.sp -.nf -\f3pkgTranslate type pkg \-pkgTranslate type2\&.baz pkg2\&.fizz\fP -.fi -.nf -\f3\fR -.fi -.sp - - -\fIResulting Translation\fR: -.sp -.nf -\f3type => pkg\fP -.fi -.nf -\f3type\&.ext => pkg\&.ext\fP -.fi -.nf -\f3type\&.baz => pkg2\&.fizz\fP -.fi -.nf -\f3type2\&.baz\&.pkg => pkg2\&.fizz\&.pkg\fP -.fi -.nf -\f3\fR -.fi -.sp - - -The following package names \f3org\fR, \f3org\fR\&.o\f3mg\fR, or any subpackages of \f3org\&.omg\fR cannot be translated\&. Any attempt to translate these packages results in uncompilable code, and the use of these packages as the first argument after \f3-pkgTranslate\fR is treated as an error\&. -.TP --skeletonName \fIxxx%yyy\fR -.br -Use \f3xxx%yyy\fR as the pattern for naming the skeleton\&. The defaults are: \f3%POA\fR for the \f3POA\fR base class (\f3-fserver\fR or \f3-fall\fR), and \f3_%ImplBase\fR for the \f3oldImplBase\fR class (-\f3oldImplBase\fR) and (\f3-fserver\fR or \f3-fall\fR))\&. -.TP --td \fIdir\fR -.br -Use \fIdir\fR for the output directory instead of the current directory\&. -.TP --tieName \fIxxx%yyy\fR -.br -Use \f3xxx%yyy\fR according to the pattern\&. The defaults are: \f3%POA\fR for the \f3POA\fR base class (\f3-fserverTie or -fallTie\fR), and \f3_%Tie\fR for the \f3oldImplBase\fR tie class (-\f3oldImplBase\fR) and (\f3-fserverTie\fR or \f3-fallTie\fR)) -.TP --nowarn, -verbose -.br -Displays release information and terminates\&. -.TP --version -.br -Displays release information and terminates\&. -.SH RESTRICTIONS -Escaped identifiers in the global scope cannot have the same spelling as IDL primitive types, \f3Object\fR, or \f3ValueBase\fR\&. This is because the symbol table is preloaded with these identifiers\&. Allowing them to be redefined would overwrite their original definitions\&. Possible permanent restriction\&. -.PP -The \f3fixed\fR IDL type is not supported\&. -.SH KNOWN\ PROBLEMS -No import is generated for global identifiers\&. If you call an unexported local \f3impl\fR object, then you do get an exception, but it seems to be due to a \f3NullPointerException\fR in the \f3ServerDelegate\fR DSI code\&. -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2001, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java IDL and RMI-IIOP Tools +.\" Title: idlj.1 +.\" +.if n .pl 99999 +.TH idlj 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +idlj \- Generates Java bindings for a specified Interface Definition Language (IDL) file\&. +.SH SYNOPSIS +.sp +.nf + +\fBidlj\fR [ \fIoptions\fR ] \fIidlfile\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. Options can appear in any order, but must precede the \f3idlfile\fR\&. +.TP +\fIidlfile\fR +The name of a file that contains Interface Definition Language (IDL) definitions\&. +.SH DESCRIPTION +The IDL-to-Java Compiler generates the Java bindings for a specified IDL file\&. For binding details, see Java IDL: IDL to Java Language Mapping at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/mapping/jidlMapping\&.html +.PP +Some earlier releases of the IDL-to-Java compiler were named \f3idltojava\fR\&. +.SS EMIT\ CLIENT\ AND\ SERVER\ BINDINGS +The following \f3idlj\fR command generates an IDL file named \f3My\&.idl\fR with client-side bindings\&. +.sp +.nf +\f3idlj My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +The previous syntax is equivalent to the following: +.sp +.nf +\f3idlj \-fclient My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +The next example generates the server-side bindings, and includes the client-side bindings plus the skeleton, all of which are POA (Inheritance Model)\&. +.sp +.nf +\f3idlg \-fserver My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +If you want to generate both client and server-side bindings, then use one of the following (equivalent) commands: +.sp +.nf +\f3idlj \-fclient \-fserver My\&.idl\fP +.fi +.nf +\f3idlj \-fall My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +There are two possible server-side models: the Portal Servant Inheritance Model and the Tie Model\&. See Tie Delegation Model\&. +.PP +\f3Portable Servant Inheritance Model\fR\&. The default server-side model is the Portable Servant Inheritance Model\&. Given an interface \f3My\fR defined in \f3My\&.idl\fR, the file \f3MyPOA\&.java\fR is generated\&. You must provide the implementation for the \f3My\fR interface, and the \f3My\fR interface must inherit from the \f3MyPOA\fR class\&. \f3MyPOA\&.java\fR is a stream-based skeleton that extends the \f3org\&.omg\&.PortableServer\&.Servant\fR class at http://docs\&.oracle\&.com/javase/8/docs/api/org/omg/PortableServer/Servant\&.html The \f3My\fR interface implements the \f3callHandler\fR interface and the operations interface associated with the IDL interface the skeleton implements\&.The \f3PortableServer\fR module for the Portable Object Adapter (POA) defines the native \f3Servant\fR type\&. See Portable Object Adapter (POA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/POA\&.html In the Java programming language, the \f3Servant\fR type is mapped to the Java \f3org\&.omg\&.PortableServer\&.Servant\fR class\&. It serves as the base class for all POA servant implementations and provides a number of methods that can be called by the application programmer, and methods that are called by the POA and that can be overridden by the user to control aspects of servant behavior\&.Another option for the Inheritance Model is to use the \f3-oldImplBase\fR flag to generate server-side bindings that are compatible with releases of the Java programming language before Java SE 1\&.4\&. The -\f3oldImplBase\fR flag is nonstandard, and these APIs are deprecated\&. You would use this flag only for compatibility with existing servers written in Java SE 1\&.3\&. In that case, you would need to modify an existing make file to add the \f3-oldImplBase\fR flag to the \f3idlj\fR compiler\&. Otherwise POA-based server-side mappings are generated\&. To generate server-side bindings that are backward compatible, do the following: +.sp +.nf +\f3idlj \-fclient \-fserver \-oldImplBase My\&.idl\fP +.fi +.nf +\f3idlj \-fall \-oldImplBase My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +Given an interface \f3My\fR defined in \f3My\&.idl\fR, the file \f3_MyImplBase\&.java\fR is generated\&. You must provide the implementation for the \f3My\fR interface, and the \f3My\fR interface must inherit from the \f3_MyImplBase\fR class\&. +.PP +\f3Tie Delegation Model\fR\&. 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: +.sp +.nf +\f3idlj \-fall My\&.idl\fP +.fi +.nf +\f3idlj \-fallTIE My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +For the \f3My\fR interface, the second command generates \f3MyPOATie\&.java\fR\&. The constructor to the \f3MyPOATie\fR class takes a delegate\&. In this example, using the default POA model, the constructor also needs a POA\&. You must provide the implementation for the delegate, but it does not have to inherit from any other class, only the interface \f3MyOperations\fR\&. To use it with the ORB, you must wrap your implementation within the \f3MyPOATie\fR class, for example: +.sp +.nf +\f3ORB orb = ORB\&.init(args, System\&.getProperties());\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// Get reference to rootpoa & activate the POAManager\fP +.fi +.nf +\f3POA rootpoa = (POA)orb\&.resolve_initial_references("RootPOA");\fP +.fi +.nf +\f3rootpoa\&.the_POAManager()\&.activate();\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// create servant and register it with the ORB\fP +.fi +.nf +\f3MyServant myDelegate = new MyServant();\fP +.fi +.nf +\f3myDelegate\&.setORB(orb); \fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// create a tie, with servant being the delegate\&.\fP +.fi +.nf +\f3MyPOATie tie = new MyPOATie(myDelegate, rootpoa);\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// obtain the objectRef for the tie\fP +.fi +.nf +\f3My ref = tie\&._this(orb);\fP +.fi +.nf +\f3\fR +.fi +.sp +You might want to use the Tie model instead of the typical Inheritance model when 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, then that slot is used up\&. With 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 a method is called\&. +.PP +For server-side generation, Tie model bindings that are compatible with versions of the IDL to Java language mapping in versions earlier than Java SE 1\&.4\&. +.sp +.nf +\f3idlj \-oldImplBase \-fall My\&.idl\fP +.fi +.nf +\f3idlj \-oldImplBase \-fallTIE My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +For the \f3My\fR interface, the this generates \f3My_Tie\&.java\fR\&. The constructor to the \f3My_Tie\fR class takes an \f3impl\fR object\&. You must provide the implementation for \f3impl\fR, but it does not have to inherit from any other class, only the interface \f3HelloOperations\fR\&. But to use it with the ORB, you must wrap your implementation within \f3My_Tie\fR, for example: +.sp +.nf +\f3ORB orb = ORB\&.init(args, System\&.getProperties());\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// create servant and register it with the ORB\fP +.fi +.nf +\f3MyServant myDelegate = new MyServant();\fP +.fi +.nf +\f3myDelegate\&.setORB(orb); \fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// create a tie, with servant being the delegate\&.\fP +.fi +.nf +\f3MyPOATie tie = new MyPOATie(myDelegate);\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// obtain the objectRef for the tie\fP +.fi +.nf +\f3My ref = tie\&._this(orb);\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS SPECIFY\ ALTERNATE\ LOCATIONS\ FOR\ EMITTED\ FILES +If you want to direct the emitted files to a directory other than the current directory, then call the compiler this way: \f3i\fR\f3dlj -td /altdir My\&.idl\fR\&. +.PP +For the \f3My\fR interface, the bindings are emitted to \f3/altdir/My\&.java\fR, etc\&., instead of \f3\&./My\&.java\fR\&. +.SS SPECIFY\ ALTERNATE\ LOCATIONS\ FOR\ INCLUDE\ FILES +If the \f3My\&.idl\fR file includes another \f3idl\fR file, \f3MyOther\&.idl\fR, then the compiler assumes that the \f3MyOther\&.idl\fR file resides in the local directory\&. If it resides in \f3/includes\fR, for example, then you call the compiler with the following command: +.sp +.nf +\f3idlj \-i /includes My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +If \f3My\&.idl\fR also included \f3Another\&.idl\fR that resided in \f3/moreIncludes\fR, for example, then you call the compiler with the following command: +.sp +.nf +\f3idlj \-i /includes \-i /moreIncludes My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +Because this form of \f3include\fR can become long, another way to indicate 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 idl\&.config in a directory that is listed in your \f3CLASSPATH\fR variable\&. Inside of \f3idl\&.config\fR, provide a line with the following form: +.sp +.nf +\f3includes=/includes;/moreIncludes\fP +.fi +.nf +\f3\fR +.fi +.sp +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, and so on\&. +.SS EMIT\ BINDINGS\ FOR\ INCLUDE\ FILES +By default, only those interfaces, structures, and so on, that are defined in the \f3idl\fR 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 \f3idl\fR files: +.sp +.nf +\f3My\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3#include <MyOther\&.idl>\fP +.fi +.nf +\f3interface My\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3MyOther\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3interface MyOther\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.sp +There is a caveat to the default rule\&. Any \f3#include\fR statements that appear at the global scope are treated as described\&. These \f3#include\fR statements can be thought of as import statements\&. The \f3#include\fR statements that appear within an enclosed scope are treated as true \f3#include\fR statements, which means that the code within the included file is treated as though it appeared in the original file and, therefore, Java bindings are emitted for it\&. Here is an example: +.sp +.nf +\f3My\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3#include <MyOther\&.idl>\fP +.fi +.nf +\f3interface My\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3 #include <Embedded\&.idl>\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3MyOther\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3interface MyOther\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3Embedded\&.idl\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3enum E {one, two, three};\fP +.fi +.nf +\f3\fR +.fi +.sp +Run\f3idlj My\&.idl\fRto generate the following list of Java files\&. Notice that \f3MyOther\&.java\fR is not generated because it is defined in an import-like \f3#include\fR\&. But \f3E\&.java\fR was generated because it was defined in a true \f3#include\fR\&. Notice that because the \f3Embedded\&.idl\fR file is included within the scope of the interface \f3My\fR, it appears within the scope of \f3My\fR (in \f3MyPackage\fR)\&. If the \f3-emitAll\fR flag had been used, then all types in all included files would have been emitted\&. +.sp +.nf +\f3\&./MyHolder\&.java\fP +.fi +.nf +\f3\&./MyHelper\&.java\fP +.fi +.nf +\f3\&./_MyStub\&.java\fP +.fi +.nf +\f3\&./MyPackage\fP +.fi +.nf +\f3\&./MyPackage/EHolder\&.java\fP +.fi +.nf +\f3\&./MyPackage/EHelper\&.java\fP +.fi +.nf +\f3\&./MyPackage/E\&.java\fP +.fi +.nf +\f3\&./My\&.java\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS INSERT\ PACKAGE\ PREFIXES +Suppose that you work for a company named ABC that has constructed the following IDL file: +.sp +.nf +\f3Widgets\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3module Widgets\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3 interface W1 {\&.\&.\&.};\fP +.fi +.nf +\f3 interface W2 {\&.\&.\&.};\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.sp +If you run this file through the IDL-to-Java compiler, then the Java bindings for W1 and W2 are placed within the \f3Widgets\fR package\&. There is an industry convention that states that a company\&'s packages should reside within a package named \f3com\&.<company name>\fR\&. To follow this convention, the package name should be \f3com\&.abc\&.Widgets\fR\&. To place this package prefix onto the Widgets module, execute the following: +.sp +.nf +\f3idlj \-pkgPrefix Widgets com\&.abc Widgets\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +If you have an IDL file that includes Widgets\&.idl, then the \f3-pkgPrefix\fR flag must appear in that command also\&. If it does not, then your IDL file will be looking for a \f3Widgets\fR package rather than a \f3com\&.abc\&.Widgets\fR package\&. +.PP +If you have a number of these packages that require prefixes, then it might be easier to place them into the idl\&.config file described previously\&. Each package prefix line should be of the form: \f3PkgPrefix\&.<type>=<prefix>\fR\&. The line for the previous example would be \f3PkgPrefix\&.Widgets=com\&.abc\fR\&. This option does not affect the Repository ID\&. +.SS DEFINE\ SYMBOLS\ BEFORE\ COMPILATION +You might 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 \f3idlj -d MYDEF My\&.idl\fRis equivalent to putting the line \f3#define MYDEF\fR inside My\&.idl\&. +.SS PRESERVE\ PREEXISTING\ BINDINGS +If the Java binding files already exist, then the \f3-keep\fR flag keeps the compiler from overwriting them\&. The default is to generate all files without considering that they already exist\&. If you have customized those files (which you should not do unless you are very comfortable with their contents), then the \f3-keep\fR option is very useful\&. The command \f3idlj -keep My\&.idl\fR emits all client-side bindings that do not already exist\&. +.SS VIEW\ COMPILATION\ PROGRESS +The IDL-to-Java compiler generates status messages as it progresses through its phases of execution\&. Use the \f3-v\fR option to activate the verbose mode: \f3idlj -v My\&.idl\fR\&. +.PP +By default the compiler does not operate in verbose mode +.SS DISPLAY\ VERSION\ INFORMATION +To display the build version of the IDL-to-Java compiler, specify the \f3-version\fR option on the command-line: \f3idlj -version\fR\&. +.PP +Version information also appears within the bindings generated by the compiler\&. Any additional options appearing on the command-line are ignored\&. +.SH OPTIONS +.TP +-d \fIsymbol\fR +.br +This is equivalent to the following line in an IDL file: +.sp +.nf +\f3#define \fIsymbol\fR\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-demitAll +.br +Emit all types, including those found in \f3#include\fR files\&. +.TP +-fside +.br +Defines what bindings to emit\&. The \f3side\fR parameter can be \f3client\fR, \f3server\fR, \f3serverTIE\fR, \f3all\fR, or \f3allTIE\fR\&. The \f3-fserverTIE\fR and \f3-fallTIE\fR options cause delegate model skeletons to be emitted\&. Defaults to \f3-fclient\fR when the flag is not specified\&. +.TP +-i \fIinclude-path\fR +.br +By default, the current directory is scanned for included files\&. This option adds another directory\&. +.TP +-i \fIkeep\fR +.br +If a file to be generated already exists, then do not overwrite it\&. By default it is overwritten\&. +.TP +-noWarn +.br +Suppress warning messages\&. +.TP +-oldImplBase +.br +Generates skeletons compatible with pre-1\&.4 JDK ORBs\&. By default, the POA Inheritance Model server-side bindings are generated\&. This option provides backward-compatibility with earlier releases of the Java programming language by generating server-side bindings that are \f3ImplBase\fR Inheritance Model classes\&. +.TP +-pkgPrefix \fItype\fR\fIprefix\fR +.br +Wherever \f3type\fR is encountered at file scope, prefix the generated Java package name with \f3prefix\fR for all files generated for that type\&. The type is the simple name of either a top-level module, or an IDL type defined outside of any module\&. +.TP +-pkgTranslate \fItype\fR\fIpackage\fR +.br +Whenever the module name type is encountered in an identifier, replace it in the identifier with package for all files in the generated Java package\&. Note that \f3pkgPrefix\fR changes are made first\&. The type value 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\&. + +If more than one translation matches an identifier, then the longest match is chosen as shown in the following example: + +\fICommand\fR: +.sp +.nf +\f3pkgTranslate type pkg \-pkgTranslate type2\&.baz pkg2\&.fizz\fP +.fi +.nf +\f3\fR +.fi +.sp + + +\fIResulting Translation\fR: +.sp +.nf +\f3type => pkg\fP +.fi +.nf +\f3type\&.ext => pkg\&.ext\fP +.fi +.nf +\f3type\&.baz => pkg2\&.fizz\fP +.fi +.nf +\f3type2\&.baz\&.pkg => pkg2\&.fizz\&.pkg\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The following package names \f3org\fR, \f3org\fR\&.o\f3mg\fR, or any subpackages of \f3org\&.omg\fR cannot be translated\&. Any attempt to translate these packages results in uncompilable code, and the use of these packages as the first argument after \f3-pkgTranslate\fR is treated as an error\&. +.TP +-skeletonName \fIxxx%yyy\fR +.br +Use \f3xxx%yyy\fR as the pattern for naming the skeleton\&. The defaults are: \f3%POA\fR for the \f3POA\fR base class (\f3-fserver\fR or \f3-fall\fR), and \f3_%ImplBase\fR for the \f3oldImplBase\fR class (-\f3oldImplBase\fR) and (\f3-fserver\fR or \f3-fall\fR))\&. +.TP +-td \fIdir\fR +.br +Use \fIdir\fR for the output directory instead of the current directory\&. +.TP +-tieName \fIxxx%yyy\fR +.br +Use \f3xxx%yyy\fR according to the pattern\&. The defaults are: \f3%POA\fR for the \f3POA\fR base class (\f3-fserverTie or -fallTie\fR), and \f3_%Tie\fR for the \f3oldImplBase\fR tie class (-\f3oldImplBase\fR) and (\f3-fserverTie\fR or \f3-fallTie\fR)) +.TP +-nowarn, -verbose +.br +Displays release information and terminates\&. +.TP +-version +.br +Displays release information and terminates\&. +.SH RESTRICTIONS +Escaped identifiers in the global scope cannot have the same spelling as IDL primitive types, \f3Object\fR, or \f3ValueBase\fR\&. This is because the symbol table is preloaded with these identifiers\&. Allowing them to be redefined would overwrite their original definitions\&. Possible permanent restriction\&. +.PP +The \f3fixed\fR IDL type is not supported\&. +.SH KNOWN\ PROBLEMS +No import is generated for global identifiers\&. If you call an unexported local \f3impl\fR object, then you do get an exception, but it seems to be due to a \f3NullPointerException\fR in the \f3ServerDelegate\fR DSI code\&. +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/ja/appletviewer.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/appletviewer.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/extcheck.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/extcheck.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/idlj.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/idlj.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/jar.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/jar.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/jarsigner.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/jarsigner.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/java.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/java.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/javac.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/javac.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/javadoc.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/javadoc.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/javah.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/javah.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/javap.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/javap.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/jcmd.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/jcmd.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/jconsole.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/jconsole.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/jdb.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/jdb.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/jdeps.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/jdeps.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/jhat.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/jhat.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/jinfo.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/jinfo.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/jjs.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/jjs.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/jmap.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/jmap.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/jps.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/jps.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/jrunscript.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/jrunscript.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/jsadebugd.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/jsadebugd.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/jstack.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/jstack.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/jstat.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/jstat.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/jstatd.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/jstatd.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/jvisualvm.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/jvisualvm.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/keytool.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/keytool.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/native2ascii.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/native2ascii.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/orbd.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/orbd.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/pack200.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/pack200.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/policytool.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/policytool.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/rmic.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/rmic.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/rmid.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/rmid.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/rmiregistry.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/rmiregistry.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/schemagen.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/schemagen.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/serialver.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/serialver.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/servertool.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/servertool.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/tnameserv.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/tnameserv.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/unpack200.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/unpack200.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/wsgen.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/wsgen.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/wsimport.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/wsimport.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/ja/xjc.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/ja/xjc.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/jar.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/jar.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,484 +1,484 @@ -'\" t -.\" Copyright (c) 1997, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Basic Tools -.\" Title: jar.1 -.\" -.if n .pl 99999 -.TH jar 1 "21 November 2013" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jar \- Manipulates Java Archive (JAR) files\&. -.SH SYNOPSIS -Create JAR file -.sp -.nf - -\fBjar c\fR[\fBefmMnv0\fR] [\fIentrypoint\fR] [\fIjarfile\fR] [\fImanifest\fR] [\fB\-C\fR \fIdir\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] -.fi -.sp - -Update JAR file -.sp -.nf - -\fBjar u\fR[\fBefmMnv0\fR] [\fIentrypoint\fR] [\fIjarfile\fR] [\fImanifest\fR] [\fB\-C\fR \fIdir\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] -.fi -.sp - -Extract JAR file -.sp -.nf - -\fBjar\fR \fBx\fR[\fBvf\fR] [\fIjarfile\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] -.fi -.sp - -List Contents of JAR file -.sp -.nf - -\fBjar\fR \fBt\fR[\fBvf\fR] [\fIjarfile\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] -.fi -.sp - -Add Index to JAR file -.sp -.nf - -\fBjar\fR \fBi\fR \fIjarfile\fR [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] -.fi -.sp -.SH DESCRIPTION -The \f3jar\fR command is a general-purpose archiving and compression tool, based on ZIP and the ZLIB compression format\&. However, the \f3jar\fR command was designed mainly to 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 (such as a browser) in a single HTTP transaction, rather than requiring a new connection for each piece\&. This dramatically improves download times\&. The \f3jar\fR command also compresses files, which further improves download time\&. The \f3jar\fR command also allows individual entries in a file to be signed by the applet author so that their origin can be authenticated\&. A JAR file can be used as a class path entry, whether or not it is compressed\&. -.PP -The syntax for the \f3jar\fR command resembles the syntax for the \f3tar\fR command\&. It has several operation modes, defined by one of the mandatory \fIoperation arguments\fR\&. Other arguments are either \fIoptions\fR that modify the behavior of the operation, or \fIoperands\fR required to perform the operation\&. -.SH OPERATION\ ARGUMENTS -When using the \f3jar\fR command, you have to select an operation to be performed by specifying one of the following operation arguments\&. You can mix them up with other one-letter options on the command line, but usually the operation argument is the first argument specified\&. -.TP -c -Create a new JAR archive\&. -.TP -i -Generate index information for a JAR archive\&. -.TP -t -List the contents of a JAR archive\&. -.TP -u -Update a JAR archive\&. -.TP -x -Extract files from a JAR archive\&. -.SH OPTIONS -Use the following options to customize how the JAR file is created, updated, extracted, or viewed: -.TP -e -Sets the class specified by the \fIentrypoint\fR operand to be the entry point\f3\fR for a standalone Java application bundled into an executable JAR file\&. The use of this option creates or overrides the \f3Main-Class\fR attribute value in the manifest file\&. The \f3e\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. - -For example, the following command creates the \f3Main\&.jar\fR archive with the \f3Main\&.class\fR file where the \f3Main-Clas\fRs attribute value in the manifest is set to \f3Main\fR: -.sp -.nf -\f3jar cfe Main\&.jar Main Main\&.class\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The Java Runtime Environment (JRE) can directly call this application by running the following command: -.sp -.nf -\f3java \-jar Main\&.jar\fP -.fi -.nf -\f3\fP -.fi -.sp - - -If the entry point class name is in a package, then it could use either the dot (\&.) or slash (/) as the delimiter\&. For example, if \f3Main\&.class\fR is in a package called \f3mydir\fR, then the entry point can be specified in one of the following ways: -.sp -.nf -\f3jar \-cfe Main\&.jar mydir/Main mydir/Main\&.class\fP -.fi -.nf -\f3jar \-cfe Main\&.jar mydir\&.Main mydir/Main\&.class\fP -.fi -.nf -\f3\fP -.fi -.sp - - -Note - -Specifying both \f3m\fR and \f3e\fR options together when a particular manifest also contains the \f3Main-Class\fR attribute results in an ambiguous \f3Main-Class\fR specification\&. The ambiguity leads to an error and the \f3jar\fR command creation or update operation is terminated\&. -.TP -f -Sets the file specified by the \fI\fR\fIjarfile\fR operand to be the name of the JAR file that is created (\f3c\fR), updated (\f3u\fR), extracted (\f3x\fR) from, or viewed (\f3t\fR)\&. Omitting the \f3f\fR option and the \fIjarfile\fR operand instructs the \f3jar\fR command to accept the JAR file name from \f3stdin\fR (for \f3x\fR and \f3t\fR) or send the JAR \f3\fRfile to \f3stdout\fR (for \f3c\fR and \f3u\fR)\&. -.TP -m -Includes names and values of attributes from the file specified by the \f3manifest\fR operand in the manifest file of the \f3jar\fR command (located in the archive at \f3META-INF/MANIFEST\&.MF\fR)\&. The \f3jar\fR command adds the attribute\(cqs name and value to the JAR file unless an entry already exists with the same name, in which case the \f3jar\fR command updates the value of the attribute\&. The \f3m\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. - -You can add special-purpose name-value attribute pairs to the manifest that are not contained in the default manifest file\&. For example, you can add attributes that specify vendor information, release information, package sealing, or to make JAR-bundled applications executable\&. For examples of using the \f3m\fR option, see Packaging Programs at http://docs\&.oracle\&.com/javase/tutorial/deployment/jar/index\&.html -.TP -M -Does not create a manifest file entry (for \f3c\fR and \f3u\fR), or delete a manifest file entry when one exists (for \f3u\fR)\&. The \f3M\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. -.TP -n -When creating (\f3c\fR) a JAR file, this option normalizes the archive so that the content is not affected by the packing and unpacking operations of the pack200(1) command\&. Without this normalization, the signature of a signed JAR can become invalid\&. -.TP -v -Generates verbose output to standard output\&. See Examples\&. -.TP -0 -(Zero) Creates (\f3c\fR) or updates (\f3u\fR) the JAR file without using ZIP compression\&. -.TP --C \fIdir\fR -.br -When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, this option temporarily changes the directory while processing files specified by the \fIfile\fR operands\&. Its operation is intended to be similar to the \f3-C\fR option of the UNIX \f3tar\fR utility\&.For example, the following command changes to the \f3classes\fR directory and adds the \f3Bar\&.class\fR file from that directory to \f3my\&.jar\fR: -.sp -.nf -\f3jar uf my\&.jar \-C classes Bar\&.class\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The following command changes to the \f3classes\fR directory and adds to \f3my\&.jar\fR all files within the classes directory (without creating a \f3classes\fR directory in the JAR file), then changes back to the original directory before changing to the \f3bin\fR directory to add \f3Xyz\&.class\fR to \f3my\&.jar\fR\&. -.sp -.nf -\f3jar uf my\&.jar \-C classes \&. \-C bin Xyz\&.class\fP -.fi -.nf -\f3\fP -.fi -.sp - - -If \f3classes\fR contained files \f3bar1\fR and \f3bar2\fR, then the JAR file will contain the following after running the previous command: -.sp -.nf -\f3% \fIjar tf my\&.jar\fR\fP -.fi -.nf -\f3META\-INF/\fP -.fi -.nf -\f3META\-INF/MANIFEST\&.MF\fP -.fi -.nf -\f3bar1\fP -.fi -.nf -\f3bar2\fP -.fi -.nf -\f3Xyz\&.class\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -\fI\fR-J\fIoption\fR -Sets the specified JVM option to be used when the JRE runs the JAR file\&. JVM options are described on the reference page for the java(1) command\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. -.SH OPERANDS -The following operands are recognized by the \f3jar\fR command\&. -.TP -\fIfile\fR -When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fIfile\fR operand defines the path and name of the file or directory that should be added to the archive\&. When extracting (\f3x\fR) or listing the contents (\f3t\fR) of a JAR file, the \fIfile\fR operand defines the path and name of the file to be extrated or listed\&. At least one valid file or directory must be specified\&. Separate multiple \fIfile\fR operands with spaces\&. If the \fIentrypoint\fR, \fIjarfile\fR, or \fImanifest\fR operands are used, the \fIfile\fR operands must be specified after them\&. -.TP -\fIentrypoint\fR -When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fIentrypoint\fR operand defines the name of the class that should be the entry point\f3\fR for a standalone Java application bundled into an executable JAR file\&. The \fIentrypoint\fR operand must be specified if the \f3e\fR option is present\&. -.TP -\fIjarfile\fR -Defines the name of the file to be created (\f3c\fR), updated (\f3u\fR), extracted (\f3x\fR), or viewed (\f3t\fR)\&. The \fIjarfile\fR operand must be specified if the \f3f\fR option is present\&. Omitting the \f3f\fR option and the \fIjarfile\fR operand instructs the \f3jar\fR command to accept the JAR file name from \f3stdin\fR (for \f3x\fR and \f3t\fR) or send the JAR \f3\fRfile to \f3stdout\fR (for \f3c\fR and \f3u\fR)\&. - -When indexing (\f3i\fR) a JAR file, specify the \fIjarfile\fR operand without the \f3f\fR option\&. -.TP -\fImanifest\fR -When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fImanifest\fR operand defines the preexisting manifest files with names and values of attributes to be included in \f3MANIFEST\&.MF\fR in the JAR file\&. The \fImanifest\fR operand must be specified if the \f3f\fR option is present\&. -.TP -\fI@arg-file\fR -To shorten or simplify the \f3jar\fR command, you can specify arguments in a separate text file and pass it to the \f3jar\fR command with the at sign (@) as a prefix\&. When the \f3jar\fR command encounters an argument beginning with the at sign, it expands the contents of that file into the argument list\&. - -An argument file can include options and arguments of the \f3jar\fR command (except the \f3-J\fR options, because they are passed to the launcher, which does not support argument files)\&. The arguments within a file can be separated by spaces or newline characters\&. File names within an argument file are relative to the current directory from which you run the \f3jar\fR command, not relative to the location of the argument file\&. Wild cards, such as the asterisk (*), that might otherwise be expanded by the operating system shell, are not expanded\&. - -The following example, shows how to create a \f3classes\&.list\fR file with names of files from the current directory output by the \f3find\fR command: -.sp -.nf -\f3find \&. \-name \&'*\&.class\&' \-print > classes\&.list\fP -.fi -.nf -\f3\fP -.fi -.sp - - -You can then execute the \f3jar\fR command and pass the \f3classes\&.list\fR file to it using the \fI@arg-file\fR syntax: -.sp -.nf -\f3jar cf my\&.jar @classes\&.list\fP -.fi -.nf -\f3\fP -.fi -.sp - - -An argument file can be specified with a path, but any file names inside the argument file that have relative paths are relative to the current working directory of the \f3jar\fR command, not to the path passed in, for example: -.sp -.nf -\f3jar @dir/classes\&.list\fP -.fi -.nf -\f3\fP -.fi -.sp - -.SH NOTES -The \f3e\fR, \f3f\fR, and \f3m\fR options must appear in the same order on the command line as the \fIentrypoint\fR, \fIjarfile\fR, and \fImanifest\fR operands, for example: -.sp -.nf -\f3jar cmef myManifestFile MyMainClass myFile\&.jar *\&.class\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH EXAMPLES -\f3Example 1 Adding All Files From the Current Directory With Verbose Output\fR -.sp -.nf -\f3% ls\fP -.fi -.nf -\f31\&.au Animator\&.class monkey\&.jpg\fP -.fi -.nf -\f32\&.au Wave\&.class spacemusic\&.au\fP -.fi -.nf -\f33\&.au at_work\&.gif\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3% jar cvf bundle\&.jar *\fP -.fi -.nf -\f3added manifest\fP -.fi -.nf -\f3adding: 1\&.au(in = 2324) (out= 67)(deflated 97%)\fP -.fi -.nf -\f3adding: 2\&.au(in = 6970) (out= 90)(deflated 98%)\fP -.fi -.nf -\f3adding: 3\&.au(in = 11616) (out= 108)(deflated 99%)\fP -.fi -.nf -\f3adding: Animator\&.class(in = 2266) (out= 66)(deflated 97%)\fP -.fi -.nf -\f3adding: Wave\&.class(in = 3778) (out= 81)(deflated 97%)\fP -.fi -.nf -\f3adding: at_work\&.gif(in = 6621) (out= 89)(deflated 98%)\fP -.fi -.nf -\f3adding: monkey\&.jpg(in = 7667) (out= 91)(deflated 98%)\fP -.fi -.nf -\f3adding: spacemusic\&.au(in = 3079) (out= 73)(deflated 97%)\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 2 Adding Files From Subdirectories\fR -.sp -.nf -\f3% ls \-F\fP -.fi -.nf -\f3audio/ classes/ images/\fP -.fi -.nf -\f3% jar cvf bundle\&.jar audio classes images\fP -.fi -.nf -\f3added manifest\fP -.fi -.nf -\f3adding: audio/(in = 0) (out= 0)(stored 0%)\fP -.fi -.nf -\f3adding: audio/1\&.au(in = 2324) (out= 67)(deflated 97%)\fP -.fi -.nf -\f3adding: audio/2\&.au(in = 6970) (out= 90)(deflated 98%)\fP -.fi -.nf -\f3adding: audio/3\&.au(in = 11616) (out= 108)(deflated 99%)\fP -.fi -.nf -\f3adding: audio/spacemusic\&.au(in = 3079) (out= 73)(deflated 97%)\fP -.fi -.nf -\f3adding: classes/(in = 0) (out= 0)(stored 0%)\fP -.fi -.nf -\f3adding: classes/Animator\&.class(in = 2266) (out= 66)(deflated 97%)\fP -.fi -.nf -\f3adding: classes/Wave\&.class(in = 3778) (out= 81)(deflated 97%)\fP -.fi -.nf -\f3adding: images/(in = 0) (out= 0)(stored 0%)\fP -.fi -.nf -\f3adding: images/monkey\&.jpg(in = 7667) (out= 91)(deflated 98%)\fP -.fi -.nf -\f3adding: images/at_work\&.gif(in = 6621) (out= 89)(deflated 98%)\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3% ls \-F\fP -.fi -.nf -\f3audio/ bundle\&.jar classes/ images/\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 3 Listing the Contents of JAR\fR -.sp -.nf -\f3% jar tf bundle\&.jar\fP -.fi -.sp -.sp -.nf -\f3META\-INF/\fP -.fi -.nf -\f3META\-INF/MANIFEST\&.MF\fP -.fi -.nf -\f3audio/1\&.au\fP -.fi -.nf -\f3audio/2\&.au\fP -.fi -.nf -\f3audio/3\&.au\fP -.fi -.nf -\f3audio/spacemusic\&.au\fP -.fi -.nf -\f3classes/Animator\&.class\fP -.fi -.nf -\f3classes/Wave\&.class\fP -.fi -.nf -\f3images/monkey\&.jpg\fP -.fi -.nf -\f3images/at_work\&.gif\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 4 Adding an Index\fR -.PP -Use the \f3i\fR option when you split the interdependent classes for a stock trade application into three JAR files: \f3main\&.jar\fR, \f3buy\&.jar\fR, and \f3sell\&.jar\fR\&. If you specify the \f3Class-Path\fR attribute in the \f3main\&.jar\fR manifest, then you can use the \f3i\fR option to speed up the class loading time for your application: -.sp -.nf -\f3Class\-Path: buy\&.jar sell\&.jar\fP -.fi -.nf -\f3jar i main\&.jar\fP -.fi -.nf -\f3\fP -.fi -.sp -An \f3INDEX\&.LIST\fR file is inserted to the \f3META-INF\fR directory\&. This enables the application class loader to download the specified JAR files when it is searching for classes or resources\&. -.PP -The application class loader uses the information stored in this file for efficient class loading\&. To copy directories, first compress files in \f3dir1\fR to \f3stdout\fR, then pipeline and extract from \f3stdin\fR to \f3dir2\fR (omitting the \f3-f\fR option from both \f3jar\fR commands): -.sp -.nf -\f3(cd dir1; jar c \&.) | (cd dir2; jar x)\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH SEE\ ALSO -.TP 0.2i -\(bu -pack200(1)\&. -.TP 0.2i -\(bu -The JAR section of The Java Tutorials at http://docs\&.oracle\&.com/javase/tutorial/deployment/jar/index\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1997, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: jar.1 +.\" +.if n .pl 99999 +.TH jar 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jar \- Manipulates Java Archive (JAR) files\&. +.SH SYNOPSIS +Create JAR file +.sp +.nf + +\fBjar c\fR[\fBefmMnv0\fR] [\fIentrypoint\fR] [\fIjarfile\fR] [\fImanifest\fR] [\fB\-C\fR \fIdir\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp + +Update JAR file +.sp +.nf + +\fBjar u\fR[\fBefmMnv0\fR] [\fIentrypoint\fR] [\fIjarfile\fR] [\fImanifest\fR] [\fB\-C\fR \fIdir\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp + +Extract JAR file +.sp +.nf + +\fBjar\fR \fBx\fR[\fBvf\fR] [\fIjarfile\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp + +List Contents of JAR file +.sp +.nf + +\fBjar\fR \fBt\fR[\fBvf\fR] [\fIjarfile\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp + +Add Index to JAR file +.sp +.nf + +\fBjar\fR \fBi\fR \fIjarfile\fR [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp +.SH DESCRIPTION +The \f3jar\fR command is a general-purpose archiving and compression tool, based on ZIP and the ZLIB compression format\&. However, the \f3jar\fR command was designed mainly to 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 (such as a browser) in a single HTTP transaction, rather than requiring a new connection for each piece\&. This dramatically improves download times\&. The \f3jar\fR command also compresses files, which further improves download time\&. The \f3jar\fR command also allows individual entries in a file to be signed by the applet author so that their origin can be authenticated\&. A JAR file can be used as a class path entry, whether or not it is compressed\&. +.PP +The syntax for the \f3jar\fR command resembles the syntax for the \f3tar\fR command\&. It has several operation modes, defined by one of the mandatory \fIoperation arguments\fR\&. Other arguments are either \fIoptions\fR that modify the behavior of the operation, or \fIoperands\fR required to perform the operation\&. +.SH OPERATION\ ARGUMENTS +When using the \f3jar\fR command, you have to select an operation to be performed by specifying one of the following operation arguments\&. You can mix them up with other one-letter options on the command line, but usually the operation argument is the first argument specified\&. +.TP +c +Create a new JAR archive\&. +.TP +i +Generate index information for a JAR archive\&. +.TP +t +List the contents of a JAR archive\&. +.TP +u +Update a JAR archive\&. +.TP +x +Extract files from a JAR archive\&. +.SH OPTIONS +Use the following options to customize how the JAR file is created, updated, extracted, or viewed: +.TP +e +Sets the class specified by the \fIentrypoint\fR operand to be the entry point\f3\fR for a standalone Java application bundled into an executable JAR file\&. The use of this option creates or overrides the \f3Main-Class\fR attribute value in the manifest file\&. The \f3e\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. + +For example, the following command creates the \f3Main\&.jar\fR archive with the \f3Main\&.class\fR file where the \f3Main-Clas\fRs attribute value in the manifest is set to \f3Main\fR: +.sp +.nf +\f3jar cfe Main\&.jar Main Main\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The Java Runtime Environment (JRE) can directly call this application by running the following command: +.sp +.nf +\f3java \-jar Main\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If the entry point class name is in a package, then it could use either the dot (\&.) or slash (/) as the delimiter\&. For example, if \f3Main\&.class\fR is in a package called \f3mydir\fR, then the entry point can be specified in one of the following ways: +.sp +.nf +\f3jar \-cfe Main\&.jar mydir/Main mydir/Main\&.class\fP +.fi +.nf +\f3jar \-cfe Main\&.jar mydir\&.Main mydir/Main\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Note + +Specifying both \f3m\fR and \f3e\fR options together when a particular manifest also contains the \f3Main-Class\fR attribute results in an ambiguous \f3Main-Class\fR specification\&. The ambiguity leads to an error and the \f3jar\fR command creation or update operation is terminated\&. +.TP +f +Sets the file specified by the \fI\fR\fIjarfile\fR operand to be the name of the JAR file that is created (\f3c\fR), updated (\f3u\fR), extracted (\f3x\fR) from, or viewed (\f3t\fR)\&. Omitting the \f3f\fR option and the \fIjarfile\fR operand instructs the \f3jar\fR command to accept the JAR file name from \f3stdin\fR (for \f3x\fR and \f3t\fR) or send the JAR \f3\fRfile to \f3stdout\fR (for \f3c\fR and \f3u\fR)\&. +.TP +m +Includes names and values of attributes from the file specified by the \f3manifest\fR operand in the manifest file of the \f3jar\fR command (located in the archive at \f3META-INF/MANIFEST\&.MF\fR)\&. The \f3jar\fR command adds the attribute\(cqs name and value to the JAR file unless an entry already exists with the same name, in which case the \f3jar\fR command updates the value of the attribute\&. The \f3m\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. + +You can add special-purpose name-value attribute pairs to the manifest that are not contained in the default manifest file\&. For example, you can add attributes that specify vendor information, release information, package sealing, or to make JAR-bundled applications executable\&. For examples of using the \f3m\fR option, see Packaging Programs at http://docs\&.oracle\&.com/javase/tutorial/deployment/jar/index\&.html +.TP +M +Does not create a manifest file entry (for \f3c\fR and \f3u\fR), or delete a manifest file entry when one exists (for \f3u\fR)\&. The \f3M\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. +.TP +n +When creating (\f3c\fR) a JAR file, this option normalizes the archive so that the content is not affected by the packing and unpacking operations of the pack200(1) command\&. Without this normalization, the signature of a signed JAR can become invalid\&. +.TP +v +Generates verbose output to standard output\&. See Examples\&. +.TP +0 +(Zero) Creates (\f3c\fR) or updates (\f3u\fR) the JAR file without using ZIP compression\&. +.TP +-C \fIdir\fR +.br +When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, this option temporarily changes the directory while processing files specified by the \fIfile\fR operands\&. Its operation is intended to be similar to the \f3-C\fR option of the UNIX \f3tar\fR utility\&.For example, the following command changes to the \f3classes\fR directory and adds the \f3Bar\&.class\fR file from that directory to \f3my\&.jar\fR: +.sp +.nf +\f3jar uf my\&.jar \-C classes Bar\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following command changes to the \f3classes\fR directory and adds to \f3my\&.jar\fR all files within the classes directory (without creating a \f3classes\fR directory in the JAR file), then changes back to the original directory before changing to the \f3bin\fR directory to add \f3Xyz\&.class\fR to \f3my\&.jar\fR\&. +.sp +.nf +\f3jar uf my\&.jar \-C classes \&. \-C bin Xyz\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If \f3classes\fR contained files \f3bar1\fR and \f3bar2\fR, then the JAR file will contain the following after running the previous command: +.sp +.nf +\f3% \fIjar tf my\&.jar\fR\fP +.fi +.nf +\f3META\-INF/\fP +.fi +.nf +\f3META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3bar1\fP +.fi +.nf +\f3bar2\fP +.fi +.nf +\f3Xyz\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +\fI\fR-J\fIoption\fR +Sets the specified JVM option to be used when the JRE runs the JAR file\&. JVM options are described on the reference page for the java(1) command\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. +.SH OPERANDS +The following operands are recognized by the \f3jar\fR command\&. +.TP +\fIfile\fR +When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fIfile\fR operand defines the path and name of the file or directory that should be added to the archive\&. When extracting (\f3x\fR) or listing the contents (\f3t\fR) of a JAR file, the \fIfile\fR operand defines the path and name of the file to be extrated or listed\&. At least one valid file or directory must be specified\&. Separate multiple \fIfile\fR operands with spaces\&. If the \fIentrypoint\fR, \fIjarfile\fR, or \fImanifest\fR operands are used, the \fIfile\fR operands must be specified after them\&. +.TP +\fIentrypoint\fR +When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fIentrypoint\fR operand defines the name of the class that should be the entry point\f3\fR for a standalone Java application bundled into an executable JAR file\&. The \fIentrypoint\fR operand must be specified if the \f3e\fR option is present\&. +.TP +\fIjarfile\fR +Defines the name of the file to be created (\f3c\fR), updated (\f3u\fR), extracted (\f3x\fR), or viewed (\f3t\fR)\&. The \fIjarfile\fR operand must be specified if the \f3f\fR option is present\&. Omitting the \f3f\fR option and the \fIjarfile\fR operand instructs the \f3jar\fR command to accept the JAR file name from \f3stdin\fR (for \f3x\fR and \f3t\fR) or send the JAR \f3\fRfile to \f3stdout\fR (for \f3c\fR and \f3u\fR)\&. + +When indexing (\f3i\fR) a JAR file, specify the \fIjarfile\fR operand without the \f3f\fR option\&. +.TP +\fImanifest\fR +When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fImanifest\fR operand defines the preexisting manifest files with names and values of attributes to be included in \f3MANIFEST\&.MF\fR in the JAR file\&. The \fImanifest\fR operand must be specified if the \f3f\fR option is present\&. +.TP +\fI@arg-file\fR +To shorten or simplify the \f3jar\fR command, you can specify arguments in a separate text file and pass it to the \f3jar\fR command with the at sign (@) as a prefix\&. When the \f3jar\fR command encounters an argument beginning with the at sign, it expands the contents of that file into the argument list\&. + +An argument file can include options and arguments of the \f3jar\fR command (except the \f3-J\fR options, because they are passed to the launcher, which does not support argument files)\&. The arguments within a file can be separated by spaces or newline characters\&. File names within an argument file are relative to the current directory from which you run the \f3jar\fR command, not relative to the location of the argument file\&. Wild cards, such as the asterisk (*), that might otherwise be expanded by the operating system shell, are not expanded\&. + +The following example, shows how to create a \f3classes\&.list\fR file with names of files from the current directory output by the \f3find\fR command: +.sp +.nf +\f3find \&. \-name \&'*\&.class\&' \-print > classes\&.list\fP +.fi +.nf +\f3\fP +.fi +.sp + + +You can then execute the \f3jar\fR command and pass the \f3classes\&.list\fR file to it using the \fI@arg-file\fR syntax: +.sp +.nf +\f3jar cf my\&.jar @classes\&.list\fP +.fi +.nf +\f3\fP +.fi +.sp + + +An argument file can be specified with a path, but any file names inside the argument file that have relative paths are relative to the current working directory of the \f3jar\fR command, not to the path passed in, for example: +.sp +.nf +\f3jar @dir/classes\&.list\fP +.fi +.nf +\f3\fP +.fi +.sp + +.SH NOTES +The \f3e\fR, \f3f\fR, and \f3m\fR options must appear in the same order on the command line as the \fIentrypoint\fR, \fIjarfile\fR, and \fImanifest\fR operands, for example: +.sp +.nf +\f3jar cmef myManifestFile MyMainClass myFile\&.jar *\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH EXAMPLES +\f3Example 1 Adding All Files From the Current Directory With Verbose Output\fR +.sp +.nf +\f3% ls\fP +.fi +.nf +\f31\&.au Animator\&.class monkey\&.jpg\fP +.fi +.nf +\f32\&.au Wave\&.class spacemusic\&.au\fP +.fi +.nf +\f33\&.au at_work\&.gif\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3% jar cvf bundle\&.jar *\fP +.fi +.nf +\f3added manifest\fP +.fi +.nf +\f3adding: 1\&.au(in = 2324) (out= 67)(deflated 97%)\fP +.fi +.nf +\f3adding: 2\&.au(in = 6970) (out= 90)(deflated 98%)\fP +.fi +.nf +\f3adding: 3\&.au(in = 11616) (out= 108)(deflated 99%)\fP +.fi +.nf +\f3adding: Animator\&.class(in = 2266) (out= 66)(deflated 97%)\fP +.fi +.nf +\f3adding: Wave\&.class(in = 3778) (out= 81)(deflated 97%)\fP +.fi +.nf +\f3adding: at_work\&.gif(in = 6621) (out= 89)(deflated 98%)\fP +.fi +.nf +\f3adding: monkey\&.jpg(in = 7667) (out= 91)(deflated 98%)\fP +.fi +.nf +\f3adding: spacemusic\&.au(in = 3079) (out= 73)(deflated 97%)\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 2 Adding Files From Subdirectories\fR +.sp +.nf +\f3% ls \-F\fP +.fi +.nf +\f3audio/ classes/ images/\fP +.fi +.nf +\f3% jar cvf bundle\&.jar audio classes images\fP +.fi +.nf +\f3added manifest\fP +.fi +.nf +\f3adding: audio/(in = 0) (out= 0)(stored 0%)\fP +.fi +.nf +\f3adding: audio/1\&.au(in = 2324) (out= 67)(deflated 97%)\fP +.fi +.nf +\f3adding: audio/2\&.au(in = 6970) (out= 90)(deflated 98%)\fP +.fi +.nf +\f3adding: audio/3\&.au(in = 11616) (out= 108)(deflated 99%)\fP +.fi +.nf +\f3adding: audio/spacemusic\&.au(in = 3079) (out= 73)(deflated 97%)\fP +.fi +.nf +\f3adding: classes/(in = 0) (out= 0)(stored 0%)\fP +.fi +.nf +\f3adding: classes/Animator\&.class(in = 2266) (out= 66)(deflated 97%)\fP +.fi +.nf +\f3adding: classes/Wave\&.class(in = 3778) (out= 81)(deflated 97%)\fP +.fi +.nf +\f3adding: images/(in = 0) (out= 0)(stored 0%)\fP +.fi +.nf +\f3adding: images/monkey\&.jpg(in = 7667) (out= 91)(deflated 98%)\fP +.fi +.nf +\f3adding: images/at_work\&.gif(in = 6621) (out= 89)(deflated 98%)\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3% ls \-F\fP +.fi +.nf +\f3audio/ bundle\&.jar classes/ images/\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 3 Listing the Contents of JAR\fR +.sp +.nf +\f3% jar tf bundle\&.jar\fP +.fi +.sp +.sp +.nf +\f3META\-INF/\fP +.fi +.nf +\f3META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3audio/1\&.au\fP +.fi +.nf +\f3audio/2\&.au\fP +.fi +.nf +\f3audio/3\&.au\fP +.fi +.nf +\f3audio/spacemusic\&.au\fP +.fi +.nf +\f3classes/Animator\&.class\fP +.fi +.nf +\f3classes/Wave\&.class\fP +.fi +.nf +\f3images/monkey\&.jpg\fP +.fi +.nf +\f3images/at_work\&.gif\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 4 Adding an Index\fR +.PP +Use the \f3i\fR option when you split the interdependent classes for a stock trade application into three JAR files: \f3main\&.jar\fR, \f3buy\&.jar\fR, and \f3sell\&.jar\fR\&. If you specify the \f3Class-Path\fR attribute in the \f3main\&.jar\fR manifest, then you can use the \f3i\fR option to speed up the class loading time for your application: +.sp +.nf +\f3Class\-Path: buy\&.jar sell\&.jar\fP +.fi +.nf +\f3jar i main\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +An \f3INDEX\&.LIST\fR file is inserted to the \f3META-INF\fR directory\&. This enables the application class loader to download the specified JAR files when it is searching for classes or resources\&. +.PP +The application class loader uses the information stored in this file for efficient class loading\&. To copy directories, first compress files in \f3dir1\fR to \f3stdout\fR, then pipeline and extract from \f3stdin\fR to \f3dir2\fR (omitting the \f3-f\fR option from both \f3jar\fR commands): +.sp +.nf +\f3(cd dir1; jar c \&.) | (cd dir2; jar x)\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +pack200(1)\&. +.TP 0.2i +\(bu +The JAR section of The Java Tutorials at http://docs\&.oracle\&.com/javase/tutorial/deployment/jar/index\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/jarsigner.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/jarsigner.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,808 +1,808 @@ -'\" t -.\" Copyright (c) 1998, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Security Tools -.\" Title: jarsigner.1 -.\" -.if n .pl 99999 -.TH jarsigner 1 "21 November 2013" "JDK 8" "Security Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jarsigner \- Signs and verifies Java Archive (JAR) files\&. -.SH SYNOPSIS -.sp -.nf - -\fBjarsigner\fR [ \fIoptions\fR ] \fIjar\-file\fR \fIalias\fR -.fi -.nf - -\fBjarsigner\fR \fB\-verify\fR [ \fIoptions\fR ] \fIjar\-file\fR [\fIalias \&.\&.\&.\fR] -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP --verify -.br -The \f3-verify\fR option can take zero or more keystore alias names after the JAR file name\&. When the \f3-verify\fR option is specified, the \f3jarsigner\fR command checks 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 \f3-keystore\fR or the default keystore\&. - -If you also specified the \f3-strict\fR option, and the \f3jarsigner\fR command detected severe warnings, the message, "jar verified, with signer errors" is displayed\&. -.TP -\fIjar-file\fR -The JAR file to be signed\&. - -If you also specified the \f3-strict\fR option, and the \f3jarsigner\fR command detected severe warnings, the message, "jar signed, with signer errors" is displayed\&. -.TP -\fIalias\fR -The aliases are defined in the keystore specified by \f3-keystore\fR or the default keystore\&. -.SH DESCRIPTION -The \f3jarsigner\fR tool has two purposes: -.TP 0.2i -\(bu -To sign Java Archive (JAR) files\&. -.TP 0.2i -\(bu -To verify the signatures and integrity of signed JAR files\&. -.PP -The JAR feature enables the packaging of class files, images, sounds, and other digital data in a single file for faster and easier distribution\&. A tool named \f3jar\fR enables developers to produce JAR files\&. (Technically, any zip file can also be considered a JAR file, although when created by the \f3jar\fR command or processed by the \f3jarsigner\fR command, JAR files also contain a \f3META-INF/MANIFEST\&.MF\fR file\&.) -.PP -A digital signature is a string of bits that is computed from some data (the data being signed) and the private key of an entity (a person, company, and so on)\&. Similar to a handwritten signature, a digital signature has many useful characteristics: -.TP 0.2i -\(bu -Its authenticity can be verified by a computation that uses the public key corresponding to the private key used to generate the signature\&. -.TP 0.2i -\(bu -It cannot be forged, assuming the private key is kept secret\&. -.TP 0.2i -\(bu -It is a function of the data signed and thus cannot be claimed to be the signature for other data as well\&. -.TP 0.2i -\(bu -The signed data cannot be changed\&. If the data is changed, then the signature cannot be verified as authentic\&. -.PP -To generate an entity\&'s signature for a file, the entity must first have a public/private key pair associated with it and one or more certificates that authenticate its public key\&. A certificate is a digitally signed statement from one entity that says that the public key of another entity has a particular value\&. -.PP -The \f3jarsigner\fR command uses key and certificate information from a keystore to generate digital signatures for JAR files\&. A keystore is a database of private keys and their associated X\&.509 certificate chains that authenticate the corresponding public keys\&. The \f3keytool\fR command is used to create and administer keystores\&. -.PP -The \f3jarsigner\fR command uses an entity\&'s private key to generate a signature\&. The signed JAR file contains, among other things, a copy of the certificate from the keystore for the public key corresponding to the private key used to sign the file\&. The \f3jarsigner\fR command can verify the digital signature of the signed JAR file using the certificate inside it (in its signature block file)\&. -.PP -The \f3jarsigner\fR command can generate signatures that include a time stamp that lets a systems or deployer (including Java Plug-in) to check whether the JAR file was signed while the signing certificate was still valid\&. In addition, APIs allow applications to obtain the timestamp information\&. -.PP -At this time, the \f3jarsigner\fR command can only sign JAR files created by the \f3jar\fR command or zip files\&. JAR files are the same as zip files, except they also have a \f3META-INF/MANIFEST\&.MF\fR file\&. A \f3META-INF/MANIFEST\&.MF\fR file is created when the \f3jarsigner\fR command signs a zip file\&. -.PP -The default \f3jarsigner\fR command behavior is to sign a JAR or zip file\&. Use the \f3-verify\fR option to verify a signed JAR file\&. -.PP -The \f3jarsigner\fR command also attempts to validate the signer\&'s certificate after signing or verifying\&. If there is a validation error or any other problem, the command generates warning messages\&. If you specify the \f3-strict\fR option, then the command treats severe warnings as errors\&. See Errors and Warnings\&. -.SS KEYSTORE\ ALIASES -All keystore entities are accessed with unique aliases\&. -.PP -When you use the \f3jarsigner\fR command to sign a JAR file, you must specify the alias for the keystore entry that contains the private key needed to generate the signature\&. For example, the following command signs the JAR file named \f3MyJARFile\&.jar\fR with the private key associated with the alias \f3duke\fR in the keystore named \f3mystore\fR in the \f3working\fR directory\&. Because no output file is specified, it overwrites \f3MyJARFile\&.jar\fR with the signed JAR file\&. -.sp -.nf -\f3jarsigner \-keystore /working/mystore \-storepass <keystore password>\fP -.fi -.nf -\f3 \-keypass <private key password> MyJARFile\&.jar duke\fP -.fi -.nf -\f3\fR -.fi -.sp -Keystores are protected with a password, so the store password must be specified\&. You are prompted for it when you do not 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 are prompted for the password when you do not specify it on the command line and it is not the same as the store password\&. -.SS KEYSTORE\ LOCATION -The \f3jarsigner\fR command has a \f3-keystore\fR option for specifying the URL of the keystore to be used\&. The keystore is by default stored in a file named \f3\&.keystore\fR in the user\&'s home directory, as determined by the \f3user\&.home\fR system property\&. -.PP -On Oracle Solaris systems, \f3user\&.home\fR defaults to the user\&'s home directory\&. -.PP -The input stream from the \f3-keystore\fR option is passed to the \f3KeyStore\&.load\fR method\&. If \f3NONE\fR is specified as the URL, then a null stream is passed to the \f3KeyStore\&.load\fR method\&. \f3NONE\fR should be specified when the \f3KeyStore\fR class is not file based, for example, when it resides on a hardware token device\&. -.SS KEYSTORE\ IMPLEMENTATION -The \f3KeyStore\fR class provided in the \f3java\&.security\fR package supplies a number of well-defined interfaces to access and modify the information in a keystore\&. You can have multiple different concrete implementations, where each implementation is for a particular type of keystore\&. -.PP -Currently, there are two command-line tools that use keystore implementations (\f3keytool\fR and \f3jarsigner\fR), and a GUI-based tool named Policy Tool\&. Because the \f3KeyStore\fR class is publicly available, JDK users can write additional security applications that use it\&. -.PP -There is a built-in default implementation provided by Oracle that implements the keystore as a file, that uses a proprietary keystore type (format) named JKS\&. The built-in implementation protects each private key with its individual password and protects the integrity of the entire keystore with a (possibly different) password\&. -.PP -Keystore implementations are provider-based, which means the application interfaces supplied by the \f3KeyStore\fR class are implemented in terms of a Service Provider Interface (SPI)\&. There is a corresponding abstract \f3KeystoreSpi\fR class, also in the \f3java\&.security package\fR, that defines the Service Provider Interface methods that providers must implement\&. The term provider refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API\&. To provide a keystore implementation, clients must implement a provider and supply a \f3KeystoreSpi\fR subclass implementation, as described in How to Implement a Provider in the Java Cryptography Architecture at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/HowToImplAProvider\&.html -.PP -Applications can choose different types of keystore implementations from different providers, with the \f3getInstance\fR factory method in the \f3KeyStore\fR 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\&. -.PP -The \f3jarsigner\fR and \f3policytool\fR commands can read file-based keystores from any location that can be specified using a URL\&. In addition, these commands can read non-file-based keystores such as those provided by MSCAPI on Windows and PKCS11 on all platforms\&. -.PP -For the \f3jarsigner\fR and \f3keytool\fR commands, you can specify a keystore type at the command line with the \f3-storetype\fR option\&. For Policy Tool, you can specify a keystore type with the \fIEdit\fR command in the \fIKeyStore\fR menu\&. -.PP -If you do not explicitly specify a keystore type, then the tools choose a keystore implementation based on the value of the \f3keystore\&.type\fR property specified in the security properties file\&. The security properties file is called \f3java\&.security\fR, and it resides in the JDK security properties directory, \f3java\&.home/lib/security\fR, where \f3java\&.home\fR is the runtime environment\&'s directory\&. The \f3jre\fR directory in the JDK or the top-level directory of the Java Runtime Environment (JRE)\&. -.PP -Each tool gets the \f3keystore\&.type\fR value and then examines all the installed providers until it finds one that implements keystores of that type\&. It then uses the keystore implementation from that provider\&. -.PP -The \f3KeyStore\fR class defines a static method named \f3getDefaultType\fR that lets applications and applets retrieve the value of the \f3keystore\&.type\fR property\&. The following line of code creates an instance of the default keystore type as specified in the \f3keystore\&.type property\fR: -.sp -.nf -\f3KeyStore keyStore = KeyStore\&.getInstance(KeyStore\&.getDefaultType());\fP -.fi -.nf -\f3\fR -.fi -.sp -The default keystore type is \f3jks\fR (the proprietary type of the keystore implementation provided by Oracle)\&. This is specified by the following line in the security properties file: -.sp -.nf -\f3keystore\&.type=jks\fP -.fi -.nf -\f3\fR -.fi -.sp -Case does not matter in keystore type designations\&. For example, \f3JKS\fR is the same as \f3jks\fR\&. -.PP -To have the tools use a keystore implementation other than the default, change that line to specify a different keystore type\&. For example, if you have a provider package that supplies a keystore implementation for a keystore type called \f3pkcs12\fR, then change the line to the following: -.sp -.nf -\f3keystore\&.type=pkcs12\fP -.fi -.nf -\f3\fR -.fi -.sp -\fINote:\fR If you use the PKCS 11 provider package, then see "KeyTool" and "JarSigner" in Java PKCS #11 Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/p11guide\&.html -.SS SUPPORTED\ ALGORITHMS -By default, the \f3jarsigner\fR command signs a JAR file using one of the following algorithms: -.TP 0.2i -\(bu -Digital Signature Algorithm (DSA) with the SHA1 digest algorithm -.TP 0.2i -\(bu -RSA algorithm with the SHA256 digest algorithm -.TP 0.2i -\(bu -Elliptic Curve (EC) cryptography algorithm with the SHA256 with Elliptic Curve Digital Signature Algorithm (ECDSA)\&. -.PP -If the signer\&'s public and private keys are DSA keys, then \f3jarsigner\fR signs the JAR file with the \f3SHA1withDSA\fR algorithm\&. If the signer\&'s keys are RSA keys, then \f3jarsigner\fR attempts to sign the JAR file with the \f3SHA256withRSA\fR algorithm\&. If the signer\&'s keys are EC keys, then \f3jarsigner\fR signs the JAR file with the \f3SHA256withECDSA\fR algorithm\&. -.PP -These default signature algorithms can be overridden using the \f3-sigalg\fR option\&. -.SS THE\ SIGNED\ JAR\ FILE -When the \f3jarsigner\fR command 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: -.TP 0.2i -\(bu -A signature file with an \f3\&.SF\fR extension -.TP 0.2i -\(bu -A signature block file with a \f3\&.DSA\fR, \f3\&.RSA\fR, or \f3\&.EC\fR extension -.PP -The base file names for these two files come from the value of the \f3-sigFile\fR option\&. For example, when the option is \f3-sigFile MKSIGN\fR, the files are named \f3MKSIGN\&.SF\fR and \f3MKSIGN\&.DSA\fR -.PP -If no \f3-sigfile\fR option appears on the command line, then the base file name for the \f3\&.SF\fR and \f3\&.DSA\fR files is the first 8 characters of the alias name specified on the command line, all converted to uppercase\&. If the alias name has fewer than 8 characters, then the full alias name is used\&. If the alias name contains any characters that are not allowed in a signature file name, then each such character is converted to an underscore (_) character in forming the file name\&. Valid characters include letters, digits, underscores, and hyphens\&. -.PP -Signature File - -A signature file (\f3\&.SF\fR file) looks similar to the manifest file that is always included in a JAR file when the \f3jarsigner\fR command is used to sign the file\&. For each source file included in the JAR file, the \f3\&.SF\fR file has three lines, such as in the manifest file, that list the following: -.TP 0.2i -\(bu -File name -.TP 0.2i -\(bu -Name of the digest algorithm (SHA) -.TP 0.2i -\(bu -SHA digest value -.PP -In the manifest file, the SHA digest value for each source file is the digest (hash) of the binary data in the source file\&. In the \f3\&.SF\fR file, the digest value for a specified source file is the hash of the three lines in the manifest file for the source file\&. -.PP -The signature file, by default, includes a header with a hash of the whole manifest file\&. The header also contains a hash of the manifest header\&. The presence of the header enables verification optimization\&. See JAR File Verification\&. -.PP -Signature Block File - -The \f3\&.SF\fR 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 that authenticates the public key corresponding to the private key used for signing\&. The file has the extension \f3\&.DSA\fR, \f3\&.RSA\fR, or \f3\&.EC\fR, depending on the digest algorithm used\&. -.SS SIGNATURE\ TIME\ STAMP -The \f3jarsigner\fR command can generate and store a signature time stamp when signing a JAR file\&. In addition, \f3jarsigner\fR supports alternative signing mechanisms\&. This behavior is optional and is controlled by the user at the time of signing through these options\&. See Options\&. -.sp -.nf -\f3\-tsa \fIurl\fR\fP -.fi -.nf -\f3\-tsacert \fIalias\fR\fP -.fi -.nf -\f3\-altsigner \fIclass\fR\fP -.fi -.nf -\f3\-altsignerpath \fIclasspathlist\fR\fP -.fi -.nf -\f3\-tsapolicyid \fIpolicyid\fR\fP -.fi -.nf -\f3\fR -.fi -.sp -.SS JAR\ FILE\ VERIFICATION -A successful JAR file verification occurs when the signatures are valid, and none of the files that were in the JAR file when the signatures were generated have changed since then\&. JAR file verification involves the following steps: -.TP 0.4i -1\&. -Verify the signature of the \f3\&.SF\fR file\&. - -The verification ensures that the signature stored in each signature block (\f3\&.DSA\fR) file was generated using the private key corresponding to the public key whose certificate (or certificate chain) also appears in the \f3\&.DSA\fR file\&. It also ensures that the signature is a valid signature of the corresponding signature (\f3\&.SF\fR) file, and thus the \f3\&.SF\fR file was not tampered with\&. -.TP 0.4i -2\&. -Verify the digest listed in each entry in the \f3\&.SF\fR file with each corresponding section in the manifest\&. - -The \f3\&.SF\fR file by default includes a header that contains a hash of the entire manifest file\&. When the header is present, the verification can check to see whether or not the hash in the header matches the hash of the manifest file\&. If there is a match, then verification proceeds to the next step\&. - -If there is no match, then a less optimized verification is required to ensure that the hash in each source file information section in the \f3\&.SF\fR file equals the hash of its corresponding section in the manifest file\&. See Signature File\&. - -One reason the hash of the manifest file that is stored in the \f3\&.SF\fR file header might not equal the hash of the current manifest file is that one or more files were added to the JAR file (with the \f3jar\fR tool) after the signature and \f3\&.SF\fR file were generated\&. When the \f3jar\fR tool is used to add files, the manifest file is changed by adding sections to it for the new files, but the \f3\&.SF\fR file is not changed\&. A verification is still considered successful when none of the files that were in the JAR file when the signature was generated have been changed since then\&. This happens when the hashes in the non-header sections of the \f3\&.SF\fR file equal the hashes of the corresponding sections in the manifest file\&. -.TP 0.4i -3\&. -Read each file in the JAR file that has an entry in the \f3\&.SF\fR file\&. While reading, compute the file\&'s digest and compare the result with the digest for this file in the manifest section\&. The digests should be the same or verification fails\&. - -If any serious verification failures occur during the verification process, then the process is stopped and a security exception is thrown\&. The \f3jarsigner\fR command catches and displays the exception\&. -.PP -\fINote:\fR You should read any addition warnings (or errors if you specified the \f3-strict\fR option), as well as the content of the certificate (by specifying the \f3-verbose\fR and \f3-certs\fR options) to determine if the signature can be trusted\&. -.SS MULTIPLE\ SIGNATURES\ FOR\ A\ JAR\ FILE -A JAR file can be signed by multiple people by running the \f3jarsigner\fR command on the file multiple times and specifying the alias for a different person each time, as follows: -.sp -.nf -\f3jarsigner myBundle\&.jar susan\fP -.fi -.nf -\f3jarsigner myBundle\&.jar kevin\fP -.fi -.nf -\f3\fR -.fi -.sp -When a JAR file is signed multiple times, there are multiple \f3\&.SF\fR and \f3\&.DSA\fR files in the resulting JAR file, one pair for each signature\&. In the previous example, the output JAR file includes files with the following names: -.sp -.nf -\f3SUSAN\&.SF\fP -.fi -.nf -\f3SUSAN\&.DSA\fP -.fi -.nf -\f3KEVIN\&.SF\fP -.fi -.nf -\f3KEVIN\&.DSA\fP -.fi -.sp -.SH OPTIONS -The following sections describe the various \f3jarsigner\fR options\&. Be aware of the following standards: -.TP 0.2i -\(bu -All option names are preceded by a minus sign (-)\&. -.TP 0.2i -\(bu -The options can be provided in any order\&. -.TP 0.2i -\(bu -Items that are in italics or underlined (option values) represent the actual values that must be supplied\&. -.TP 0.2i -\(bu -The \f3-storepass\fR, \f3-keypass\fR, \f3-sigfile\fR, \f3-sigalg\fR, \f3-digestalg\fR, \f3-signedjar\fR, and TSA-related options are only relevant when signing a JAR file; they are not relevant when verifying a signed JAR file\&. The \f3-keystore\fR option is relevant for signing and verifying a JAR file\&. In addition, aliases are specified when signing and verifying a JAR file\&. -.TP --keystore \fIurl\fR -.br -Specifies the URL that tells the keystore location\&. This defaults to the file \f3\&.keystore\fR in the user\&'s home directory, as determined by the \f3user\&.home\fR system property\&. - -A keystore is required when signing\&. You must explicitly specify a keystore when the default keystore does not exist or if you want to use one other than the default\&. - -A keystore is not required when verifying, but if one is specified or the default exists and the \f3-verbose\fR option was also specified, then additional information is output regarding whether or not any of the certificates used to verify the JAR file are contained in that keystore\&. - -The \f3-keystore\fR argument can be a file name and path specification rather than a URL, in which case it is treated the same as a file: URL, for example, the following are equivalent: -.sp -.nf -\f3\-keystore \fIfilePathAndName\fR\fP -.fi -.nf -\f3\-keystore file:\fIfilePathAndName\fR\fP -.fi -.nf -\f3\fR -.fi -.sp - - -If the Sun PKCS #11 provider was configured in the \f3java\&.security\fR security properties file (located in the JRE\&'s \f3$JAVA_HOME/lib/security directory\fR), then the \f3keytool\fR and \f3jarsigner\fR tools can operate on the PKCS #11 token by specifying these options: -.sp -.nf -\f3\-keystore NONE\fP -.fi -.nf -\f3\-storetype PKCS11\fP -.fi -.nf -\f3\fR -.fi -.sp - - -For example, the following command lists the contents of the configured PKCS#11 token: -.sp -.nf -\f3keytool \-keystore NONE \-storetype PKCS11 \-list\fP -.fi -.nf -\f3\fR -.fi -.sp - -.TP --storetype \fIstoretype\fR -.br -Specifies the type of keystore to be instantiated\&. The default keystore type is the one that is specified as the value of the \f3keystore\&.type\fR property in the security properties file, which is returned by the static \f3getDefaultType\fR method in \f3java\&.security\&.KeyStore\fR\&. - -The PIN for a PCKS #11 token can also be specified with the \f3-storepass\fR option\&. If none is specified, then the \f3keytool\fR and \f3jarsigner\fR commands 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 \f3-protected\fR option must be specified and no password options can be specified\&. -.TP --storepass[:env | :file] \fIargument\fR -.br -Specifies the password that is required to access the keystore\&. This is only needed when signing (not verifying) a JAR file\&. In that case, if a \f3-storepass\fR option is not provided at the command line, then the user is prompted for the password\&. - -If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the value \fIargument\fR\&. Otherwise, the password is retrieved as follows: -.RS -.TP 0.2i -\(bu -\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. -.TP 0.2i -\(bu -\f3file\fR: Retrieve the password from the file named \f3argument\fR\&. -.RE - - -\fINote:\fR The password should not be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system\&. -.TP --keypass [:env | :file] \fIargument\fR -.br -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\fR to sign a JAR file\&. If no password is provided on the command line, and the required password is different from the store password, then the user is prompted for it\&. - -If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the value \f3argument\fR\&. Otherwise, the password is retrieved as follows: -.RS -.TP 0.2i -\(bu -\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. -.TP 0.2i -\(bu -\f3file\fR: Retrieve the password from the file named \f3argument\fR\&. -.RE - - -\fINote:\fR The password should not be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system\&. -.TP --sigfile \fIfile\fR -.br -Specifies the base file name to be used for the generated \f3\&.SF\fR and \f3\&.DSA\fR files\&. For example, if file is \f3DUKESIGN\fR, then the generated \f3\&.SF\fR and \f3\&.DSA\fR files are named \f3DUKESIGN\&.SF\fR and \f3DUKESIGN\&.DSA\fR, and placed in the \f3META-INF\fR directory of the signed JAR file\&. - -The characters in the file must come from the set \f3a-zA-Z0-9_-\fR\&. Only letters, numbers, underscore, and hyphen characters are allowed\&. All lowercase characters are converted to uppercase for the \f3\&.SF\fR and \f3\&.DSA\fR file names\&. - -If no \f3-sigfile\fR option appears on the command line, then the base file name for the \f3\&.SF\fR and \f3\&.DSA\fR files is 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, then the full alias name is used\&. If the alias name contains any characters that are not valid in a signature file name, then each such character is converted to an underscore (_) character to form the file name\&. -.TP --sigalg \fIalgorithm\fR -.br -Specifies the name of the signature algorithm to use to sign the JAR file\&. - -For a list of standard signature algorithm names, see "Appendix A: Standard Names" in the Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA - -This algorithm must be compatible with the private key used to sign the JAR file\&. If this option is not specified, then \f3SHA1withDSA\fR, \f3SHA256withRSA\fR, or \f3SHA256withECDSA\fR are 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 \f3-providerClass\fR option; otherwise, the command will not succeed\&. -.TP --digestalg \fIalgorithm\fR -.br -Specifies the name of the message digest algorithm to use when digesting the entries of a JAR file\&. - -For a list of standard message digest algorithm names, see "Appendix A: Standard Names" in the Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA - -If this option is not specified, then \f3SHA256\fR is used\&. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f3-providerClass\fR option; otherwise, the command will not succeed\&. -.TP --certs -.br -If the \f3-certs\fR option appears on the command line with the \f3-verify\fR and \f3-verbose\fR options, then the output includes certificate information for each signer of the JAR file\&. This information includes the name of the type of certificate (stored in the \f3\&.DSA\fR file) that certifies the signer\&'s public key, and if the certificate is an X\&.509 certificate (an instance of the \f3java\&.security\&.cert\&.X509Certificate\fR), then the distinguished name of the signer\&. - -The keystore is also examined\&. If no keystore value is specified on the command line, then the default keystore file (if any) is checked\&. If the public key certificate for a signer matches an entry in the keystore, then the alias name for the keystore entry for that signer is displayed in parentheses\&. -.TP --certchain \fIfile\fR -.br -Specifies the certificate chain to be used when the certificate chain associated with the private key of the keystore entry that is addressed by the alias specified on the command line is not complete\&. This can happen when the keystore is located on a hardware token where there is not enough capacity to hold a complete certificate chain\&. The file can be a sequence of concatenated X\&.509 certificates, or a single PKCS#7 formatted data block, either in binary encoding format or in printable encoding format (also known as Base64 encoding) as defined by the Internet RFC 1421 standard\&. See Internet RFC 1421 Certificate Encoding Standard and http://tools\&.ietf\&.org/html/rfc1421\&. -.TP --verbose -.br -When the \f3-verbose\fR option appears on the command line, it indicates verbose mode, which causes \f3jarsigner\fR to output extra information about the progress of the JAR signing or verification\&. -.TP --internalsf -.br -In the past, the \f3\&.DSA\fR (signature block) file generated when a JAR file was signed included a complete encoded copy of the \f3\&.SF\fR file (signature file) also generated\&. This behavior has been changed\&. To reduce the overall size of the output JAR file, the \f3\&.DSA\fR file by default does not contain a copy of the \f3\&.SF\fR file anymore\&. If \f3-internalsf\fR appears on the command line, then the old behavior is utilized\&. This option is useful for testing\&. In practice, do not use the \f3-internalsf\fR option because it incurs higher overhead\&. -.TP --sectionsonly -.br -If the \f3-sectionsonly\fR option appears on the command line, then the \f3\&.SF\fR file (signature file) generated when a JAR file is signed does not include a header that contains a hash of the whole manifest file\&. It contains only the information and hashes related to each individual source file included in the JAR file\&. See Signature File\&. - -By default, this header is added, as an optimization\&. When the header is present, whenever the JAR file is verified, the verification can first check to see whether the hash in the header matches the hash of the whole manifest file\&. When there is a match, verification proceeds to the next step\&. When there is no match, it is necessary to do a less optimized verification that the hash in each source file information section in the \f3\&.SF\fR file equals the hash of its corresponding section in the manifest file\&. See JAR File Verification\&. - -The \f3-sectionsonly\fR option is primarily used for testing\&. It should not be used other than for testing because using it incurs higher overhead\&. -.TP --protected -.br -Values can be either \f3true\fR or \f3false\fR\&. Specify \f3true\fR when a password must be specified through a protected authentication path such as a dedicated PIN reader\&. -.TP --providerClass \fIprovider-class-name\fR -.br -Used to specify the name of cryptographic service provider\&'s master class file when the service provider is not listed in the \f3java\&.security\fR security properties file\&. - -Used with the \f3-providerArg ConfigFilePath\fR option, the \f3keytool\fR and \f3jarsigner\fR tools install the provider dynamically and use \fIConfigFilePath\fR for the path to the token configuration file\&. The following example shows a command to list a \f3PKCS #11\fR keystore when the Oracle PKCS #11 provider was not configured in the security properties file\&. -.sp -.nf -\f3jarsigner \-keystore NONE \-storetype PKCS11 \e\fP -.fi -.nf -\f3 \-providerClass sun\&.security\&.pkcs11\&.SunPKCS11 \e\fP -.fi -.nf -\f3 \-providerArg /mydir1/mydir2/token\&.config \e\fP -.fi -.nf -\f3 \-list\fP -.fi -.nf -\f3\fR -.fi -.sp - -.TP --providerName \fIproviderName\fR -.br -If more than one provider was configured in the \f3java\&.security\fR security properties file, then you can use the \f3-providerName\fR option to target a specific provider instance\&. The argument to this option is the name of the provider\&. - -For the Oracle PKCS #11 provider, \fIproviderName\fR is of the form \f3SunPKCS11-\fR\fITokenName\fR, where \fITokenName\fR is the name suffix that the provider instance has been configured with, as detailed in the configuration attributes table\&. For example, the following command lists the contents of the \f3PKCS #11\fR keystore provider instance with name suffix \f3SmartCard\fR: -.sp -.nf -\f3jarsigner \-keystore NONE \-storetype PKCS11 \e\fP -.fi -.nf -\f3 \-providerName SunPKCS11\-SmartCard \e\fP -.fi -.nf -\f3 \-list\fP -.fi -.nf -\f3\fR -.fi -.sp - -.TP --J\fIjavaoption\fR -.br -Passes through the specified \fIjavaoption\fR string directly to the Java interpreter\&. The \f3jarsigner\fR command is 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 \f3java -h\fR or \f3java -X\fR at the command line\&. -.TP --tsa \fIurl\fR -.br -If \f3-tsa http://example\&.tsa\&.url\fR appears on the command line when signing a JAR file then a time stamp is generated for the signature\&. The URL, \f3http://example\&.tsa\&.url\fR, identifies the location of the Time Stamping Authority (TSA) and overrides any URL found with the \f3-tsacert\fR option\&. The \f3-tsa\fR option does not require the TSA public key certificate to be present in the keystore\&. - -To generate the time stamp, \f3jarsigner\fR communicates with the TSA with the Time-Stamp Protocol (TSP) defined in RFC 3161\&. When successful, the time stamp token returned by the TSA is stored with the signature in the signature block file\&. -.TP --tsacert \fIalias\fR -.br -When \f3-tsacert alias\fR appears on the command line when signing a JAR file, a time stamp is generated for the signature\&. The alias identifies the TSA public key certificate in the keystore that is in effect\&. The entry\&'s certificate is examined for a Subject Information Access extension that contains a URL identifying the location of the TSA\&. - -The TSA public key certificate must be present in the keystore when using the \f3-tsacert\fR option\&. -.TP --tsapolicyid \fIpolicyid\fR -.br -Specifies the object identifier (OID) that identifies the policy ID to be sent to the TSA server\&. If this option is not specified, no policy ID is sent and the TSA server will choose a default policy ID\&. - -Object identifiers are defined by X\&.696, which is an ITU Telecommunication Standardization Sector (ITU-T) standard\&. These identifiers are typically period-separated sets of non-negative digits like \f31\&.2\&.3\&.4\fR, for example\&. -.TP --altsigner \fIclass\fR -.br -This option specifies an alternative signing mechanism\&. The fully qualified class name identifies a class file that extends the \f3com\&.sun\&.jarsigner\&.ContentSigner\fR abstract class\&. The path to this class file is defined by the \f3-altsignerpath\fR option\&. If the \f3-altsigner\fR option is used, then the \f3jarsigner\fR command uses the signing mechanism provided by the specified class\&. Otherwise, the \f3jarsigner\fR command uses its default signing mechanism\&. - -For example, to use the signing mechanism provided by a class named \f3com\&.sun\&.sun\&.jarsigner\&.AuthSigner\fR, use the jarsigner option \f3-altsigner com\&.sun\&.jarsigner\&.AuthSigner\fR\&. -.TP --altsignerpath \fIclasspathlist\fR -.br -Specifies the path to the class file and any JAR file it depends on\&. The class file name is specified with the \f3-altsigner\fR option\&. If the class file is in a JAR file, then this option specifies the path to that JAR file\&. - -An absolute path or a path relative to the current directory can be specified\&. If \fIclasspathlist\fR contains multiple paths or JAR files, then they should be separated with a colon (:) on Oracle Solaris and a semicolon (;) on Windows\&. This option is not necessary when the class is already in the search path\&. - -The following example shows how to specify the path to a JAR file that contains the class file\&. The JAR file name is included\&. -.sp -.nf -\f3\-altsignerpath /home/user/lib/authsigner\&.jar\fP -.fi -.nf -\f3\fR -.fi -.sp - - -The following example shows how to specify the path to the JAR file that contains the class file\&. The JAR file name is omitted\&. -.sp -.nf -\f3\-altsignerpath /home/user/classes/com/sun/tools/jarsigner/\fP -.fi -.nf -\f3\fR -.fi -.sp - -.TP --strict -.br -During the signing or verifying process, the command may issue warning messages\&. If you specify this option, the exit code of the tool reflects the severe warning messages that this command found\&. See Errors and Warnings\&. -.TP --verbose \fIsuboptions\fR -.br -For the verifying process, the \f3-verbose\fR option takes suboptions to determine how much information is shown\&. If the \f3-certs\fR option is also specified, then the default mode (or suboption \f3all\fR) displays each entry as it is being processed, and after that, the certificate information for each signer of the JAR file\&. If the \f3-certs\fR and the \f3-verbose:grouped\fR suboptions are specified, then entries with the same signer info are grouped and displayed together with their certificate information\&. If \f3-certs\fR and the \f3-verbose:summary\fR suboptions are specified, then entries with the same signer information are grouped and displayed together with their certificate information\&. Details about each entry are summarized and displayed as \fIone entry (and more)\fR\&. See Examples\&. -.SH ERRORS\ AND\ WARNINGS -During the signing or verifying process, the \f3jarsigner\fR command may issue various errors or warnings\&. -.PP -If there is a failure, the \f3jarsigner\fR command exits with code 1\&. If there is no failure, but there are one or more severe warnings, the \f3jarsigner\fR command exits with code 0 when the \f3-strict\fR option is \fInot\fR specified, or exits with the OR-value of the warning codes when the \f3-strict\fR is specified\&. If there is only informational warnings or no warning at all, the command always exits with code 0\&. -.PP -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, the \f3jarsigner\fR command exits with code 12 (=4+8) when the \f3-strict\fR option is specified\&. -.PP -\fINote:\fR Exit codes are reused because only the values from 0 to 255 are legal on Unix-based operating systems\&. -.PP -The following sections describes the names, codes, and descriptions of the errors and warnings that the \f3jarsigner\fR command can issue\&. -.SS FAILURE -Reasons why the \f3jarsigner\fR command fails include (but are not limited to) a command line parsing error, the inability to find a keypair to sign the JAR file, or the verification of a signed JAR fails\&. -.TP -failure -Code 1\&. The signing or verifying fails\&. -.SS SEVERE\ WARNINGS -\fINote:\fR Severe warnings are reported as errors if you specify the \f3-strict\fR option\&. -.PP -Reasons why the \f3jarsigner\fR command issues a severe warning include the certificate used to sign the JAR file has an error or the signed JAR file has other problems\&. -.TP -hasExpiredCert -Code 4\&. This jar contains entries whose signer certificate has expired\&. -.TP -notYetValidCert -Code 4\&. This jar contains entries whose signer certificate is not yet valid\&. -.TP -chainNotValidated -Code 4\&. This jar contains entries whose certificate chain cannot be correctly validated\&. -.TP -badKeyUsage -Code 8\&. This jar contains entries whose signer certificate\&'s KeyUsage extension doesn\&'t allow code signing\&. -.TP -badExtendedKeyUsage -Code 8\&. This jar contains entries whose signer certificate\&'s ExtendedKeyUsage extension doesn\&'t allow code signing\&. -.TP -badNetscapeCertType -Code 8\&. This jar contains entries whose signer certificate\&'s NetscapeCertType extension doesn\&'t allow code signing\&. -.TP -hasUnsignedEntry -Code 16\&. This jar contains unsigned entries which have not been integrity-checked\&. -.TP -notSignedByAlias -Code 32\&. This jar contains signed entries which are not signed by the specified alias(es)\&. -.TP -aliasNotInStore -Code 32\&. This jar contains signed entries that are not signed by alias in this keystore\&. -.SS INFORMATIONAL\ WARNINGS -Informational warnings include those that are not errors but regarded as bad practice\&. They do not have a code\&. -.TP -hasExpiringCert -This jar contains entries whose signer certificate will expire within six months\&. -.TP -noTimestamp -This jar contains signatures that does not include a timestamp\&. Without a timestamp, users may not be able to validate this JAR file after the signer certificate\&'s expiration date (\f3YYYY-MM-DD\fR) or after any future revocation date\&. -.SH EXAMPLES -.SS SIGN\ A\ JAR\ FILE -Use the following command to sign bundle\&.jar with the private key of a user whose keystore alias is \f3jane\fR in a keystore named \f3mystore\fR in the \f3working\fR directory and name the signed JAR file \f3sbundle\&.jar\fR: -.sp -.nf -\f3jarsigner \-keystore /working/mystore\fP -.fi -.nf -\f3 \-storepass <keystore password>\fP -.fi -.nf -\f3 \-keypass <private key password>\fP -.fi -.nf -\f3 \-signedjar sbundle\&.jar bundle\&.jar jane\fP -.fi -.nf -\f3\fR -.fi -.sp -There is no \f3-sigfile\fR specified in the previous command so the generated \f3\&.SF\fR and \f3\&.DSA\fR files to be placed in the signed JAR file have default names based on the alias name\&. They are named \f3JANE\&.SF\fR and \f3JANE\&.DSA\fR\&. -.PP -If you want to be prompted for the store password and the private key password, then you could shorten the previous command to the following: -.sp -.nf -\f3jarsigner \-keystore /working/mystore\fP -.fi -.nf -\f3 \-signedjar sbundle\&.jar bundle\&.jar jane\fP -.fi -.nf -\f3\fR -.fi -.sp -If the keystore is the default keystore (\&.keystore in your home directory), then you do not need to specify a keystore, as follows: -.sp -.nf -\f3jarsigner \-signedjar sbundle\&.jar bundle\&.jar jane\fP -.fi -.nf -\f3\fR -.fi -.sp -If you want the signed JAR file to overwrite the input JAR file (bundle\&.jar), then you do not need to specify a \f3-signedjar\fR option, as follows: -.sp -.nf -\f3jarsigner bundle\&.jar jane\fP -.fi -.nf -\f3\fR -.fi -.sp -.SS VERIFY\ A\ SIGNED\ JAR\ FILE -To verify a signed JAR file to ensure that the signature is valid and the JAR file was not been tampered with, use a command such as the following: -.sp -.nf -\f3jarsigner \-verify sbundle\&.jar\fP -.fi -.nf -\f3\fR -.fi -.sp -When the verification is successful, \f3jar verified\fR is displayed\&. Otherwise, an error message is displayed\&. You can get more information when you use the \f3-verbose\fR option\&. A sample use of \f3jarsigner\fR with the\f3-verbose\fR option follows: -.sp -.nf -\f3jarsigner \-verify \-verbose sbundle\&.jar\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST\&.MF\fP -.fi -.nf -\f3 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.SF\fP -.fi -.nf -\f3 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.DSA\fP -.fi -.nf -\f3 smk 2752 Fri Sep 26 16:12:30 PDT 1997 AclEx\&.class\fP -.fi -.nf -\f3 smk 849 Fri Sep 26 16:12:46 PDT 1997 test\&.class\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3 s = signature was verified\fP -.fi -.nf -\f3 m = entry is listed in manifest\fP -.fi -.nf -\f3 k = at least one certificate was found in keystore\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3 jar verified\&.\fP -.fi -.nf -\f3\fR -.fi -.sp -.SS VERIFICATION\ WITH\ CERTIFICATE\ INFORMATION -If you specify the \f3-certs\fR option with the \f3-verify\fR and \f3-verbose\fR options, then the output includes certificate information for each signer of the JAR file\&. The information includes the certificate type, the signer distinguished name information (when it is an X\&.509 certificate), and in parentheses, the keystore alias for the signer when the public key certificate in the JAR file matches the one in a keystore entry, for example: -.sp -.nf -\f3jarsigner \-keystore /working/mystore \-verify \-verbose \-certs myTest\&.jar\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST\&.MF\fP -.fi -.nf -\f3 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.SF\fP -.fi -.nf -\f3 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.DSA\fP -.fi -.nf -\f3 208 Fri Sep 26 16:23:30 PDT 1997 META\-INF/JAVATEST\&.SF\fP -.fi -.nf -\f3 1087 Fri Sep 26 16:23:30 PDT 1997 META\-INF/JAVATEST\&.DSA\fP -.fi -.nf -\f3 smk 2752 Fri Sep 26 16:12:30 PDT 1997 Tst\&.class\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3 X\&.509, CN=Test Group, OU=Java Software, O=Oracle, L=CUP, S=CA, C=US (javatest)\fP -.fi -.nf -\f3 X\&.509, CN=Jane Smith, OU=Java Software, O=Oracle, L=cup, S=ca, C=us (jane)\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3 s = signature was verified\fP -.fi -.nf -\f3 m = entry is listed in manifest\fP -.fi -.nf -\f3 k = at least one certificate was found in keystore\fP -.fi -.nf -\f3\fR -.fi -.nf -\f3 jar verified\&.\fP -.fi -.nf -\f3\fR -.fi -.sp -If the certificate for a signer is not an X\&.509 certificate, then there is no distinguished name information\&. In that case, just the certificate type and the alias are shown\&. For example, if the certificate is a PGP certificate, and the alias is \f3bob\fR, then you would get: \f3PGP, (bob)\fR\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -jar(1) -.TP 0.2i -\(bu -keytool(1) -.TP 0.2i -\(bu -Trail: Security Features in Java SE at http://docs\&.oracle\&.com/javase/tutorial/security/index\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1998, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Security Tools +.\" Title: jarsigner.1 +.\" +.if n .pl 99999 +.TH jarsigner 1 "21 November 2013" "JDK 8" "Security Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jarsigner \- Signs and verifies Java Archive (JAR) files\&. +.SH SYNOPSIS +.sp +.nf + +\fBjarsigner\fR [ \fIoptions\fR ] \fIjar\-file\fR \fIalias\fR +.fi +.nf + +\fBjarsigner\fR \fB\-verify\fR [ \fIoptions\fR ] \fIjar\-file\fR [\fIalias \&.\&.\&.\fR] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +-verify +.br +The \f3-verify\fR option can take zero or more keystore alias names after the JAR file name\&. When the \f3-verify\fR option is specified, the \f3jarsigner\fR command checks 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 \f3-keystore\fR or the default keystore\&. + +If you also specified the \f3-strict\fR option, and the \f3jarsigner\fR command detected severe warnings, the message, "jar verified, with signer errors" is displayed\&. +.TP +\fIjar-file\fR +The JAR file to be signed\&. + +If you also specified the \f3-strict\fR option, and the \f3jarsigner\fR command detected severe warnings, the message, "jar signed, with signer errors" is displayed\&. +.TP +\fIalias\fR +The aliases are defined in the keystore specified by \f3-keystore\fR or the default keystore\&. +.SH DESCRIPTION +The \f3jarsigner\fR tool has two purposes: +.TP 0.2i +\(bu +To sign Java Archive (JAR) files\&. +.TP 0.2i +\(bu +To verify the signatures and integrity of signed JAR files\&. +.PP +The JAR feature enables the packaging of class files, images, sounds, and other digital data in a single file for faster and easier distribution\&. A tool named \f3jar\fR enables developers to produce JAR files\&. (Technically, any zip file can also be considered a JAR file, although when created by the \f3jar\fR command or processed by the \f3jarsigner\fR command, JAR files also contain a \f3META-INF/MANIFEST\&.MF\fR file\&.) +.PP +A digital signature is a string of bits that is computed from some data (the data being signed) and the private key of an entity (a person, company, and so on)\&. Similar to a handwritten signature, a digital signature has many useful characteristics: +.TP 0.2i +\(bu +Its authenticity can be verified by a computation that uses the public key corresponding to the private key used to generate the signature\&. +.TP 0.2i +\(bu +It cannot be forged, assuming the private key is kept secret\&. +.TP 0.2i +\(bu +It is a function of the data signed and thus cannot be claimed to be the signature for other data as well\&. +.TP 0.2i +\(bu +The signed data cannot be changed\&. If the data is changed, then the signature cannot be verified as authentic\&. +.PP +To generate an entity\&'s signature for a file, the entity must first have a public/private key pair associated with it and one or more certificates that authenticate its public key\&. A certificate is a digitally signed statement from one entity that says that the public key of another entity has a particular value\&. +.PP +The \f3jarsigner\fR command uses key and certificate information from a keystore to generate digital signatures for JAR files\&. A keystore is a database of private keys and their associated X\&.509 certificate chains that authenticate the corresponding public keys\&. The \f3keytool\fR command is used to create and administer keystores\&. +.PP +The \f3jarsigner\fR command uses an entity\&'s private key to generate a signature\&. The signed JAR file contains, among other things, a copy of the certificate from the keystore for the public key corresponding to the private key used to sign the file\&. The \f3jarsigner\fR command can verify the digital signature of the signed JAR file using the certificate inside it (in its signature block file)\&. +.PP +The \f3jarsigner\fR command can generate signatures that include a time stamp that lets a systems or deployer (including Java Plug-in) to check whether the JAR file was signed while the signing certificate was still valid\&. In addition, APIs allow applications to obtain the timestamp information\&. +.PP +At this time, the \f3jarsigner\fR command can only sign JAR files created by the \f3jar\fR command or zip files\&. JAR files are the same as zip files, except they also have a \f3META-INF/MANIFEST\&.MF\fR file\&. A \f3META-INF/MANIFEST\&.MF\fR file is created when the \f3jarsigner\fR command signs a zip file\&. +.PP +The default \f3jarsigner\fR command behavior is to sign a JAR or zip file\&. Use the \f3-verify\fR option to verify a signed JAR file\&. +.PP +The \f3jarsigner\fR command also attempts to validate the signer\&'s certificate after signing or verifying\&. If there is a validation error or any other problem, the command generates warning messages\&. If you specify the \f3-strict\fR option, then the command treats severe warnings as errors\&. See Errors and Warnings\&. +.SS KEYSTORE\ ALIASES +All keystore entities are accessed with unique aliases\&. +.PP +When you use the \f3jarsigner\fR command to sign a JAR file, you must specify the alias for the keystore entry that contains the private key needed to generate the signature\&. For example, the following command signs the JAR file named \f3MyJARFile\&.jar\fR with the private key associated with the alias \f3duke\fR in the keystore named \f3mystore\fR in the \f3working\fR directory\&. Because no output file is specified, it overwrites \f3MyJARFile\&.jar\fR with the signed JAR file\&. +.sp +.nf +\f3jarsigner \-keystore /working/mystore \-storepass <keystore password>\fP +.fi +.nf +\f3 \-keypass <private key password> MyJARFile\&.jar duke\fP +.fi +.nf +\f3\fR +.fi +.sp +Keystores are protected with a password, so the store password must be specified\&. You are prompted for it when you do not 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 are prompted for the password when you do not specify it on the command line and it is not the same as the store password\&. +.SS KEYSTORE\ LOCATION +The \f3jarsigner\fR command has a \f3-keystore\fR option for specifying the URL of the keystore to be used\&. The keystore is by default stored in a file named \f3\&.keystore\fR in the user\&'s home directory, as determined by the \f3user\&.home\fR system property\&. +.PP +On Oracle Solaris systems, \f3user\&.home\fR defaults to the user\&'s home directory\&. +.PP +The input stream from the \f3-keystore\fR option is passed to the \f3KeyStore\&.load\fR method\&. If \f3NONE\fR is specified as the URL, then a null stream is passed to the \f3KeyStore\&.load\fR method\&. \f3NONE\fR should be specified when the \f3KeyStore\fR class is not file based, for example, when it resides on a hardware token device\&. +.SS KEYSTORE\ IMPLEMENTATION +The \f3KeyStore\fR class provided in the \f3java\&.security\fR package supplies a number of well-defined interfaces to access and modify the information in a keystore\&. You can have multiple different concrete implementations, where each implementation is for a particular type of keystore\&. +.PP +Currently, there are two command-line tools that use keystore implementations (\f3keytool\fR and \f3jarsigner\fR), and a GUI-based tool named Policy Tool\&. Because the \f3KeyStore\fR class is publicly available, JDK users can write additional security applications that use it\&. +.PP +There is a built-in default implementation provided by Oracle that implements the keystore as a file, that uses a proprietary keystore type (format) named JKS\&. The built-in implementation protects each private key with its individual password and protects the integrity of the entire keystore with a (possibly different) password\&. +.PP +Keystore implementations are provider-based, which means the application interfaces supplied by the \f3KeyStore\fR class are implemented in terms of a Service Provider Interface (SPI)\&. There is a corresponding abstract \f3KeystoreSpi\fR class, also in the \f3java\&.security package\fR, that defines the Service Provider Interface methods that providers must implement\&. The term provider refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API\&. To provide a keystore implementation, clients must implement a provider and supply a \f3KeystoreSpi\fR subclass implementation, as described in How to Implement a Provider in the Java Cryptography Architecture at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/HowToImplAProvider\&.html +.PP +Applications can choose different types of keystore implementations from different providers, with the \f3getInstance\fR factory method in the \f3KeyStore\fR 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\&. +.PP +The \f3jarsigner\fR and \f3policytool\fR commands can read file-based keystores from any location that can be specified using a URL\&. In addition, these commands can read non-file-based keystores such as those provided by MSCAPI on Windows and PKCS11 on all platforms\&. +.PP +For the \f3jarsigner\fR and \f3keytool\fR commands, you can specify a keystore type at the command line with the \f3-storetype\fR option\&. For Policy Tool, you can specify a keystore type with the \fIEdit\fR command in the \fIKeyStore\fR menu\&. +.PP +If you do not explicitly specify a keystore type, then the tools choose a keystore implementation based on the value of the \f3keystore\&.type\fR property specified in the security properties file\&. The security properties file is called \f3java\&.security\fR, and it resides in the JDK security properties directory, \f3java\&.home/lib/security\fR, where \f3java\&.home\fR is the runtime environment\&'s directory\&. The \f3jre\fR directory in the JDK or the top-level directory of the Java Runtime Environment (JRE)\&. +.PP +Each tool gets the \f3keystore\&.type\fR value and then examines all the installed providers until it finds one that implements keystores of that type\&. It then uses the keystore implementation from that provider\&. +.PP +The \f3KeyStore\fR class defines a static method named \f3getDefaultType\fR that lets applications and applets retrieve the value of the \f3keystore\&.type\fR property\&. The following line of code creates an instance of the default keystore type as specified in the \f3keystore\&.type property\fR: +.sp +.nf +\f3KeyStore keyStore = KeyStore\&.getInstance(KeyStore\&.getDefaultType());\fP +.fi +.nf +\f3\fR +.fi +.sp +The default keystore type is \f3jks\fR (the proprietary type of the keystore implementation provided by Oracle)\&. This is specified by the following line in the security properties file: +.sp +.nf +\f3keystore\&.type=jks\fP +.fi +.nf +\f3\fR +.fi +.sp +Case does not matter in keystore type designations\&. For example, \f3JKS\fR is the same as \f3jks\fR\&. +.PP +To have the tools use a keystore implementation other than the default, change that line to specify a different keystore type\&. For example, if you have a provider package that supplies a keystore implementation for a keystore type called \f3pkcs12\fR, then change the line to the following: +.sp +.nf +\f3keystore\&.type=pkcs12\fP +.fi +.nf +\f3\fR +.fi +.sp +\fINote:\fR If you use the PKCS 11 provider package, then see "KeyTool" and "JarSigner" in Java PKCS #11 Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/p11guide\&.html +.SS SUPPORTED\ ALGORITHMS +By default, the \f3jarsigner\fR command signs a JAR file using one of the following algorithms: +.TP 0.2i +\(bu +Digital Signature Algorithm (DSA) with the SHA1 digest algorithm +.TP 0.2i +\(bu +RSA algorithm with the SHA256 digest algorithm +.TP 0.2i +\(bu +Elliptic Curve (EC) cryptography algorithm with the SHA256 with Elliptic Curve Digital Signature Algorithm (ECDSA)\&. +.PP +If the signer\&'s public and private keys are DSA keys, then \f3jarsigner\fR signs the JAR file with the \f3SHA1withDSA\fR algorithm\&. If the signer\&'s keys are RSA keys, then \f3jarsigner\fR attempts to sign the JAR file with the \f3SHA256withRSA\fR algorithm\&. If the signer\&'s keys are EC keys, then \f3jarsigner\fR signs the JAR file with the \f3SHA256withECDSA\fR algorithm\&. +.PP +These default signature algorithms can be overridden using the \f3-sigalg\fR option\&. +.SS THE\ SIGNED\ JAR\ FILE +When the \f3jarsigner\fR command 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: +.TP 0.2i +\(bu +A signature file with an \f3\&.SF\fR extension +.TP 0.2i +\(bu +A signature block file with a \f3\&.DSA\fR, \f3\&.RSA\fR, or \f3\&.EC\fR extension +.PP +The base file names for these two files come from the value of the \f3-sigFile\fR option\&. For example, when the option is \f3-sigFile MKSIGN\fR, the files are named \f3MKSIGN\&.SF\fR and \f3MKSIGN\&.DSA\fR +.PP +If no \f3-sigfile\fR option appears on the command line, then the base file name for the \f3\&.SF\fR and \f3\&.DSA\fR files is the first 8 characters of the alias name specified on the command line, all converted to uppercase\&. If the alias name has fewer than 8 characters, then the full alias name is used\&. If the alias name contains any characters that are not allowed in a signature file name, then each such character is converted to an underscore (_) character in forming the file name\&. Valid characters include letters, digits, underscores, and hyphens\&. +.PP +Signature File + +A signature file (\f3\&.SF\fR file) looks similar to the manifest file that is always included in a JAR file when the \f3jarsigner\fR command is used to sign the file\&. For each source file included in the JAR file, the \f3\&.SF\fR file has three lines, such as in the manifest file, that list the following: +.TP 0.2i +\(bu +File name +.TP 0.2i +\(bu +Name of the digest algorithm (SHA) +.TP 0.2i +\(bu +SHA digest value +.PP +In the manifest file, the SHA digest value for each source file is the digest (hash) of the binary data in the source file\&. In the \f3\&.SF\fR file, the digest value for a specified source file is the hash of the three lines in the manifest file for the source file\&. +.PP +The signature file, by default, includes a header with a hash of the whole manifest file\&. The header also contains a hash of the manifest header\&. The presence of the header enables verification optimization\&. See JAR File Verification\&. +.PP +Signature Block File + +The \f3\&.SF\fR 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 that authenticates the public key corresponding to the private key used for signing\&. The file has the extension \f3\&.DSA\fR, \f3\&.RSA\fR, or \f3\&.EC\fR, depending on the digest algorithm used\&. +.SS SIGNATURE\ TIME\ STAMP +The \f3jarsigner\fR command can generate and store a signature time stamp when signing a JAR file\&. In addition, \f3jarsigner\fR supports alternative signing mechanisms\&. This behavior is optional and is controlled by the user at the time of signing through these options\&. See Options\&. +.sp +.nf +\f3\-tsa \fIurl\fR\fP +.fi +.nf +\f3\-tsacert \fIalias\fR\fP +.fi +.nf +\f3\-altsigner \fIclass\fR\fP +.fi +.nf +\f3\-altsignerpath \fIclasspathlist\fR\fP +.fi +.nf +\f3\-tsapolicyid \fIpolicyid\fR\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS JAR\ FILE\ VERIFICATION +A successful JAR file verification occurs when the signatures are valid, and none of the files that were in the JAR file when the signatures were generated have changed since then\&. JAR file verification involves the following steps: +.TP 0.4i +1\&. +Verify the signature of the \f3\&.SF\fR file\&. + +The verification ensures that the signature stored in each signature block (\f3\&.DSA\fR) file was generated using the private key corresponding to the public key whose certificate (or certificate chain) also appears in the \f3\&.DSA\fR file\&. It also ensures that the signature is a valid signature of the corresponding signature (\f3\&.SF\fR) file, and thus the \f3\&.SF\fR file was not tampered with\&. +.TP 0.4i +2\&. +Verify the digest listed in each entry in the \f3\&.SF\fR file with each corresponding section in the manifest\&. + +The \f3\&.SF\fR file by default includes a header that contains a hash of the entire manifest file\&. When the header is present, the verification can check to see whether or not the hash in the header matches the hash of the manifest file\&. If there is a match, then verification proceeds to the next step\&. + +If there is no match, then a less optimized verification is required to ensure that the hash in each source file information section in the \f3\&.SF\fR file equals the hash of its corresponding section in the manifest file\&. See Signature File\&. + +One reason the hash of the manifest file that is stored in the \f3\&.SF\fR file header might not equal the hash of the current manifest file is that one or more files were added to the JAR file (with the \f3jar\fR tool) after the signature and \f3\&.SF\fR file were generated\&. When the \f3jar\fR tool is used to add files, the manifest file is changed by adding sections to it for the new files, but the \f3\&.SF\fR file is not changed\&. A verification is still considered successful when none of the files that were in the JAR file when the signature was generated have been changed since then\&. This happens when the hashes in the non-header sections of the \f3\&.SF\fR file equal the hashes of the corresponding sections in the manifest file\&. +.TP 0.4i +3\&. +Read each file in the JAR file that has an entry in the \f3\&.SF\fR file\&. While reading, compute the file\&'s digest and compare the result with the digest for this file in the manifest section\&. The digests should be the same or verification fails\&. + +If any serious verification failures occur during the verification process, then the process is stopped and a security exception is thrown\&. The \f3jarsigner\fR command catches and displays the exception\&. +.PP +\fINote:\fR You should read any addition warnings (or errors if you specified the \f3-strict\fR option), as well as the content of the certificate (by specifying the \f3-verbose\fR and \f3-certs\fR options) to determine if the signature can be trusted\&. +.SS MULTIPLE\ SIGNATURES\ FOR\ A\ JAR\ FILE +A JAR file can be signed by multiple people by running the \f3jarsigner\fR command on the file multiple times and specifying the alias for a different person each time, as follows: +.sp +.nf +\f3jarsigner myBundle\&.jar susan\fP +.fi +.nf +\f3jarsigner myBundle\&.jar kevin\fP +.fi +.nf +\f3\fR +.fi +.sp +When a JAR file is signed multiple times, there are multiple \f3\&.SF\fR and \f3\&.DSA\fR files in the resulting JAR file, one pair for each signature\&. In the previous example, the output JAR file includes files with the following names: +.sp +.nf +\f3SUSAN\&.SF\fP +.fi +.nf +\f3SUSAN\&.DSA\fP +.fi +.nf +\f3KEVIN\&.SF\fP +.fi +.nf +\f3KEVIN\&.DSA\fP +.fi +.sp +.SH OPTIONS +The following sections describe the various \f3jarsigner\fR options\&. Be aware of the following standards: +.TP 0.2i +\(bu +All option names are preceded by a minus sign (-)\&. +.TP 0.2i +\(bu +The options can be provided in any order\&. +.TP 0.2i +\(bu +Items that are in italics or underlined (option values) represent the actual values that must be supplied\&. +.TP 0.2i +\(bu +The \f3-storepass\fR, \f3-keypass\fR, \f3-sigfile\fR, \f3-sigalg\fR, \f3-digestalg\fR, \f3-signedjar\fR, and TSA-related options are only relevant when signing a JAR file; they are not relevant when verifying a signed JAR file\&. The \f3-keystore\fR option is relevant for signing and verifying a JAR file\&. In addition, aliases are specified when signing and verifying a JAR file\&. +.TP +-keystore \fIurl\fR +.br +Specifies the URL that tells the keystore location\&. This defaults to the file \f3\&.keystore\fR in the user\&'s home directory, as determined by the \f3user\&.home\fR system property\&. + +A keystore is required when signing\&. You must explicitly specify a keystore when the default keystore does not exist or if you want to use one other than the default\&. + +A keystore is not required when verifying, but if one is specified or the default exists and the \f3-verbose\fR option was also specified, then additional information is output regarding whether or not any of the certificates used to verify the JAR file are contained in that keystore\&. + +The \f3-keystore\fR argument can be a file name and path specification rather than a URL, in which case it is treated the same as a file: URL, for example, the following are equivalent: +.sp +.nf +\f3\-keystore \fIfilePathAndName\fR\fP +.fi +.nf +\f3\-keystore file:\fIfilePathAndName\fR\fP +.fi +.nf +\f3\fR +.fi +.sp + + +If the Sun PKCS #11 provider was configured in the \f3java\&.security\fR security properties file (located in the JRE\&'s \f3$JAVA_HOME/lib/security directory\fR), then the \f3keytool\fR and \f3jarsigner\fR tools can operate on the PKCS #11 token by specifying these options: +.sp +.nf +\f3\-keystore NONE\fP +.fi +.nf +\f3\-storetype PKCS11\fP +.fi +.nf +\f3\fR +.fi +.sp + + +For example, the following command lists the contents of the configured PKCS#11 token: +.sp +.nf +\f3keytool \-keystore NONE \-storetype PKCS11 \-list\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-storetype \fIstoretype\fR +.br +Specifies the type of keystore to be instantiated\&. The default keystore type is the one that is specified as the value of the \f3keystore\&.type\fR property in the security properties file, which is returned by the static \f3getDefaultType\fR method in \f3java\&.security\&.KeyStore\fR\&. + +The PIN for a PCKS #11 token can also be specified with the \f3-storepass\fR option\&. If none is specified, then the \f3keytool\fR and \f3jarsigner\fR commands 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 \f3-protected\fR option must be specified and no password options can be specified\&. +.TP +-storepass[:env | :file] \fIargument\fR +.br +Specifies the password that is required to access the keystore\&. This is only needed when signing (not verifying) a JAR file\&. In that case, if a \f3-storepass\fR option is not provided at the command line, then the user is prompted for the password\&. + +If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the value \fIargument\fR\&. Otherwise, the password is retrieved as follows: +.RS +.TP 0.2i +\(bu +\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. +.TP 0.2i +\(bu +\f3file\fR: Retrieve the password from the file named \f3argument\fR\&. +.RE + + +\fINote:\fR The password should not be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system\&. +.TP +-keypass [:env | :file] \fIargument\fR +.br +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\fR to sign a JAR file\&. If no password is provided on the command line, and the required password is different from the store password, then the user is prompted for it\&. + +If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the value \f3argument\fR\&. Otherwise, the password is retrieved as follows: +.RS +.TP 0.2i +\(bu +\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. +.TP 0.2i +\(bu +\f3file\fR: Retrieve the password from the file named \f3argument\fR\&. +.RE + + +\fINote:\fR The password should not be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system\&. +.TP +-sigfile \fIfile\fR +.br +Specifies the base file name to be used for the generated \f3\&.SF\fR and \f3\&.DSA\fR files\&. For example, if file is \f3DUKESIGN\fR, then the generated \f3\&.SF\fR and \f3\&.DSA\fR files are named \f3DUKESIGN\&.SF\fR and \f3DUKESIGN\&.DSA\fR, and placed in the \f3META-INF\fR directory of the signed JAR file\&. + +The characters in the file must come from the set \f3a-zA-Z0-9_-\fR\&. Only letters, numbers, underscore, and hyphen characters are allowed\&. All lowercase characters are converted to uppercase for the \f3\&.SF\fR and \f3\&.DSA\fR file names\&. + +If no \f3-sigfile\fR option appears on the command line, then the base file name for the \f3\&.SF\fR and \f3\&.DSA\fR files is 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, then the full alias name is used\&. If the alias name contains any characters that are not valid in a signature file name, then each such character is converted to an underscore (_) character to form the file name\&. +.TP +-sigalg \fIalgorithm\fR +.br +Specifies the name of the signature algorithm to use to sign the JAR file\&. + +For a list of standard signature algorithm names, see "Appendix A: Standard Names" in the Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA + +This algorithm must be compatible with the private key used to sign the JAR file\&. If this option is not specified, then \f3SHA1withDSA\fR, \f3SHA256withRSA\fR, or \f3SHA256withECDSA\fR are 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 \f3-providerClass\fR option; otherwise, the command will not succeed\&. +.TP +-digestalg \fIalgorithm\fR +.br +Specifies the name of the message digest algorithm to use when digesting the entries of a JAR file\&. + +For a list of standard message digest algorithm names, see "Appendix A: Standard Names" in the Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA + +If this option is not specified, then \f3SHA256\fR is used\&. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f3-providerClass\fR option; otherwise, the command will not succeed\&. +.TP +-certs +.br +If the \f3-certs\fR option appears on the command line with the \f3-verify\fR and \f3-verbose\fR options, then the output includes certificate information for each signer of the JAR file\&. This information includes the name of the type of certificate (stored in the \f3\&.DSA\fR file) that certifies the signer\&'s public key, and if the certificate is an X\&.509 certificate (an instance of the \f3java\&.security\&.cert\&.X509Certificate\fR), then the distinguished name of the signer\&. + +The keystore is also examined\&. If no keystore value is specified on the command line, then the default keystore file (if any) is checked\&. If the public key certificate for a signer matches an entry in the keystore, then the alias name for the keystore entry for that signer is displayed in parentheses\&. +.TP +-certchain \fIfile\fR +.br +Specifies the certificate chain to be used when the certificate chain associated with the private key of the keystore entry that is addressed by the alias specified on the command line is not complete\&. This can happen when the keystore is located on a hardware token where there is not enough capacity to hold a complete certificate chain\&. The file can be a sequence of concatenated X\&.509 certificates, or a single PKCS#7 formatted data block, either in binary encoding format or in printable encoding format (also known as Base64 encoding) as defined by the Internet RFC 1421 standard\&. See Internet RFC 1421 Certificate Encoding Standard and http://tools\&.ietf\&.org/html/rfc1421\&. +.TP +-verbose +.br +When the \f3-verbose\fR option appears on the command line, it indicates verbose mode, which causes \f3jarsigner\fR to output extra information about the progress of the JAR signing or verification\&. +.TP +-internalsf +.br +In the past, the \f3\&.DSA\fR (signature block) file generated when a JAR file was signed included a complete encoded copy of the \f3\&.SF\fR file (signature file) also generated\&. This behavior has been changed\&. To reduce the overall size of the output JAR file, the \f3\&.DSA\fR file by default does not contain a copy of the \f3\&.SF\fR file anymore\&. If \f3-internalsf\fR appears on the command line, then the old behavior is utilized\&. This option is useful for testing\&. In practice, do not use the \f3-internalsf\fR option because it incurs higher overhead\&. +.TP +-sectionsonly +.br +If the \f3-sectionsonly\fR option appears on the command line, then the \f3\&.SF\fR file (signature file) generated when a JAR file is signed does not include a header that contains a hash of the whole manifest file\&. It contains only the information and hashes related to each individual source file included in the JAR file\&. See Signature File\&. + +By default, this header is added, as an optimization\&. When the header is present, whenever the JAR file is verified, the verification can first check to see whether the hash in the header matches the hash of the whole manifest file\&. When there is a match, verification proceeds to the next step\&. When there is no match, it is necessary to do a less optimized verification that the hash in each source file information section in the \f3\&.SF\fR file equals the hash of its corresponding section in the manifest file\&. See JAR File Verification\&. + +The \f3-sectionsonly\fR option is primarily used for testing\&. It should not be used other than for testing because using it incurs higher overhead\&. +.TP +-protected +.br +Values can be either \f3true\fR or \f3false\fR\&. Specify \f3true\fR when a password must be specified through a protected authentication path such as a dedicated PIN reader\&. +.TP +-providerClass \fIprovider-class-name\fR +.br +Used to specify the name of cryptographic service provider\&'s master class file when the service provider is not listed in the \f3java\&.security\fR security properties file\&. + +Used with the \f3-providerArg ConfigFilePath\fR option, the \f3keytool\fR and \f3jarsigner\fR tools install the provider dynamically and use \fIConfigFilePath\fR for the path to the token configuration file\&. The following example shows a command to list a \f3PKCS #11\fR keystore when the Oracle PKCS #11 provider was not configured in the security properties file\&. +.sp +.nf +\f3jarsigner \-keystore NONE \-storetype PKCS11 \e\fP +.fi +.nf +\f3 \-providerClass sun\&.security\&.pkcs11\&.SunPKCS11 \e\fP +.fi +.nf +\f3 \-providerArg /mydir1/mydir2/token\&.config \e\fP +.fi +.nf +\f3 \-list\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-providerName \fIproviderName\fR +.br +If more than one provider was configured in the \f3java\&.security\fR security properties file, then you can use the \f3-providerName\fR option to target a specific provider instance\&. The argument to this option is the name of the provider\&. + +For the Oracle PKCS #11 provider, \fIproviderName\fR is of the form \f3SunPKCS11-\fR\fITokenName\fR, where \fITokenName\fR is the name suffix that the provider instance has been configured with, as detailed in the configuration attributes table\&. For example, the following command lists the contents of the \f3PKCS #11\fR keystore provider instance with name suffix \f3SmartCard\fR: +.sp +.nf +\f3jarsigner \-keystore NONE \-storetype PKCS11 \e\fP +.fi +.nf +\f3 \-providerName SunPKCS11\-SmartCard \e\fP +.fi +.nf +\f3 \-list\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-J\fIjavaoption\fR +.br +Passes through the specified \fIjavaoption\fR string directly to the Java interpreter\&. The \f3jarsigner\fR command is 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 \f3java -h\fR or \f3java -X\fR at the command line\&. +.TP +-tsa \fIurl\fR +.br +If \f3-tsa http://example\&.tsa\&.url\fR appears on the command line when signing a JAR file then a time stamp is generated for the signature\&. The URL, \f3http://example\&.tsa\&.url\fR, identifies the location of the Time Stamping Authority (TSA) and overrides any URL found with the \f3-tsacert\fR option\&. The \f3-tsa\fR option does not require the TSA public key certificate to be present in the keystore\&. + +To generate the time stamp, \f3jarsigner\fR communicates with the TSA with the Time-Stamp Protocol (TSP) defined in RFC 3161\&. When successful, the time stamp token returned by the TSA is stored with the signature in the signature block file\&. +.TP +-tsacert \fIalias\fR +.br +When \f3-tsacert alias\fR appears on the command line when signing a JAR file, a time stamp is generated for the signature\&. The alias identifies the TSA public key certificate in the keystore that is in effect\&. The entry\&'s certificate is examined for a Subject Information Access extension that contains a URL identifying the location of the TSA\&. + +The TSA public key certificate must be present in the keystore when using the \f3-tsacert\fR option\&. +.TP +-tsapolicyid \fIpolicyid\fR +.br +Specifies the object identifier (OID) that identifies the policy ID to be sent to the TSA server\&. If this option is not specified, no policy ID is sent and the TSA server will choose a default policy ID\&. + +Object identifiers are defined by X\&.696, which is an ITU Telecommunication Standardization Sector (ITU-T) standard\&. These identifiers are typically period-separated sets of non-negative digits like \f31\&.2\&.3\&.4\fR, for example\&. +.TP +-altsigner \fIclass\fR +.br +This option specifies an alternative signing mechanism\&. The fully qualified class name identifies a class file that extends the \f3com\&.sun\&.jarsigner\&.ContentSigner\fR abstract class\&. The path to this class file is defined by the \f3-altsignerpath\fR option\&. If the \f3-altsigner\fR option is used, then the \f3jarsigner\fR command uses the signing mechanism provided by the specified class\&. Otherwise, the \f3jarsigner\fR command uses its default signing mechanism\&. + +For example, to use the signing mechanism provided by a class named \f3com\&.sun\&.sun\&.jarsigner\&.AuthSigner\fR, use the jarsigner option \f3-altsigner com\&.sun\&.jarsigner\&.AuthSigner\fR\&. +.TP +-altsignerpath \fIclasspathlist\fR +.br +Specifies the path to the class file and any JAR file it depends on\&. The class file name is specified with the \f3-altsigner\fR option\&. If the class file is in a JAR file, then this option specifies the path to that JAR file\&. + +An absolute path or a path relative to the current directory can be specified\&. If \fIclasspathlist\fR contains multiple paths or JAR files, then they should be separated with a colon (:) on Oracle Solaris and a semicolon (;) on Windows\&. This option is not necessary when the class is already in the search path\&. + +The following example shows how to specify the path to a JAR file that contains the class file\&. The JAR file name is included\&. +.sp +.nf +\f3\-altsignerpath /home/user/lib/authsigner\&.jar\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The following example shows how to specify the path to the JAR file that contains the class file\&. The JAR file name is omitted\&. +.sp +.nf +\f3\-altsignerpath /home/user/classes/com/sun/tools/jarsigner/\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-strict +.br +During the signing or verifying process, the command may issue warning messages\&. If you specify this option, the exit code of the tool reflects the severe warning messages that this command found\&. See Errors and Warnings\&. +.TP +-verbose \fIsuboptions\fR +.br +For the verifying process, the \f3-verbose\fR option takes suboptions to determine how much information is shown\&. If the \f3-certs\fR option is also specified, then the default mode (or suboption \f3all\fR) displays each entry as it is being processed, and after that, the certificate information for each signer of the JAR file\&. If the \f3-certs\fR and the \f3-verbose:grouped\fR suboptions are specified, then entries with the same signer info are grouped and displayed together with their certificate information\&. If \f3-certs\fR and the \f3-verbose:summary\fR suboptions are specified, then entries with the same signer information are grouped and displayed together with their certificate information\&. Details about each entry are summarized and displayed as \fIone entry (and more)\fR\&. See Examples\&. +.SH ERRORS\ AND\ WARNINGS +During the signing or verifying process, the \f3jarsigner\fR command may issue various errors or warnings\&. +.PP +If there is a failure, the \f3jarsigner\fR command exits with code 1\&. If there is no failure, but there are one or more severe warnings, the \f3jarsigner\fR command exits with code 0 when the \f3-strict\fR option is \fInot\fR specified, or exits with the OR-value of the warning codes when the \f3-strict\fR is specified\&. If there is only informational warnings or no warning at all, the command always exits with code 0\&. +.PP +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, the \f3jarsigner\fR command exits with code 12 (=4+8) when the \f3-strict\fR option is specified\&. +.PP +\fINote:\fR Exit codes are reused because only the values from 0 to 255 are legal on Unix-based operating systems\&. +.PP +The following sections describes the names, codes, and descriptions of the errors and warnings that the \f3jarsigner\fR command can issue\&. +.SS FAILURE +Reasons why the \f3jarsigner\fR command fails include (but are not limited to) a command line parsing error, the inability to find a keypair to sign the JAR file, or the verification of a signed JAR fails\&. +.TP +failure +Code 1\&. The signing or verifying fails\&. +.SS SEVERE\ WARNINGS +\fINote:\fR Severe warnings are reported as errors if you specify the \f3-strict\fR option\&. +.PP +Reasons why the \f3jarsigner\fR command issues a severe warning include the certificate used to sign the JAR file has an error or the signed JAR file has other problems\&. +.TP +hasExpiredCert +Code 4\&. This jar contains entries whose signer certificate has expired\&. +.TP +notYetValidCert +Code 4\&. This jar contains entries whose signer certificate is not yet valid\&. +.TP +chainNotValidated +Code 4\&. This jar contains entries whose certificate chain cannot be correctly validated\&. +.TP +badKeyUsage +Code 8\&. This jar contains entries whose signer certificate\&'s KeyUsage extension doesn\&'t allow code signing\&. +.TP +badExtendedKeyUsage +Code 8\&. This jar contains entries whose signer certificate\&'s ExtendedKeyUsage extension doesn\&'t allow code signing\&. +.TP +badNetscapeCertType +Code 8\&. This jar contains entries whose signer certificate\&'s NetscapeCertType extension doesn\&'t allow code signing\&. +.TP +hasUnsignedEntry +Code 16\&. This jar contains unsigned entries which have not been integrity-checked\&. +.TP +notSignedByAlias +Code 32\&. This jar contains signed entries which are not signed by the specified alias(es)\&. +.TP +aliasNotInStore +Code 32\&. This jar contains signed entries that are not signed by alias in this keystore\&. +.SS INFORMATIONAL\ WARNINGS +Informational warnings include those that are not errors but regarded as bad practice\&. They do not have a code\&. +.TP +hasExpiringCert +This jar contains entries whose signer certificate will expire within six months\&. +.TP +noTimestamp +This jar contains signatures that does not include a timestamp\&. Without a timestamp, users may not be able to validate this JAR file after the signer certificate\&'s expiration date (\f3YYYY-MM-DD\fR) or after any future revocation date\&. +.SH EXAMPLES +.SS SIGN\ A\ JAR\ FILE +Use the following command to sign bundle\&.jar with the private key of a user whose keystore alias is \f3jane\fR in a keystore named \f3mystore\fR in the \f3working\fR directory and name the signed JAR file \f3sbundle\&.jar\fR: +.sp +.nf +\f3jarsigner \-keystore /working/mystore\fP +.fi +.nf +\f3 \-storepass <keystore password>\fP +.fi +.nf +\f3 \-keypass <private key password>\fP +.fi +.nf +\f3 \-signedjar sbundle\&.jar bundle\&.jar jane\fP +.fi +.nf +\f3\fR +.fi +.sp +There is no \f3-sigfile\fR specified in the previous command so the generated \f3\&.SF\fR and \f3\&.DSA\fR files to be placed in the signed JAR file have default names based on the alias name\&. They are named \f3JANE\&.SF\fR and \f3JANE\&.DSA\fR\&. +.PP +If you want to be prompted for the store password and the private key password, then you could shorten the previous command to the following: +.sp +.nf +\f3jarsigner \-keystore /working/mystore\fP +.fi +.nf +\f3 \-signedjar sbundle\&.jar bundle\&.jar jane\fP +.fi +.nf +\f3\fR +.fi +.sp +If the keystore is the default keystore (\&.keystore in your home directory), then you do not need to specify a keystore, as follows: +.sp +.nf +\f3jarsigner \-signedjar sbundle\&.jar bundle\&.jar jane\fP +.fi +.nf +\f3\fR +.fi +.sp +If you want the signed JAR file to overwrite the input JAR file (bundle\&.jar), then you do not need to specify a \f3-signedjar\fR option, as follows: +.sp +.nf +\f3jarsigner bundle\&.jar jane\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS VERIFY\ A\ SIGNED\ JAR\ FILE +To verify a signed JAR file to ensure that the signature is valid and the JAR file was not been tampered with, use a command such as the following: +.sp +.nf +\f3jarsigner \-verify sbundle\&.jar\fP +.fi +.nf +\f3\fR +.fi +.sp +When the verification is successful, \f3jar verified\fR is displayed\&. Otherwise, an error message is displayed\&. You can get more information when you use the \f3-verbose\fR option\&. A sample use of \f3jarsigner\fR with the\f3-verbose\fR option follows: +.sp +.nf +\f3jarsigner \-verify \-verbose sbundle\&.jar\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.SF\fP +.fi +.nf +\f3 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.DSA\fP +.fi +.nf +\f3 smk 2752 Fri Sep 26 16:12:30 PDT 1997 AclEx\&.class\fP +.fi +.nf +\f3 smk 849 Fri Sep 26 16:12:46 PDT 1997 test\&.class\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 s = signature was verified\fP +.fi +.nf +\f3 m = entry is listed in manifest\fP +.fi +.nf +\f3 k = at least one certificate was found in keystore\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 jar verified\&.\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS VERIFICATION\ WITH\ CERTIFICATE\ INFORMATION +If you specify the \f3-certs\fR option with the \f3-verify\fR and \f3-verbose\fR options, then the output includes certificate information for each signer of the JAR file\&. The information includes the certificate type, the signer distinguished name information (when it is an X\&.509 certificate), and in parentheses, the keystore alias for the signer when the public key certificate in the JAR file matches the one in a keystore entry, for example: +.sp +.nf +\f3jarsigner \-keystore /working/mystore \-verify \-verbose \-certs myTest\&.jar\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.SF\fP +.fi +.nf +\f3 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.DSA\fP +.fi +.nf +\f3 208 Fri Sep 26 16:23:30 PDT 1997 META\-INF/JAVATEST\&.SF\fP +.fi +.nf +\f3 1087 Fri Sep 26 16:23:30 PDT 1997 META\-INF/JAVATEST\&.DSA\fP +.fi +.nf +\f3 smk 2752 Fri Sep 26 16:12:30 PDT 1997 Tst\&.class\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 X\&.509, CN=Test Group, OU=Java Software, O=Oracle, L=CUP, S=CA, C=US (javatest)\fP +.fi +.nf +\f3 X\&.509, CN=Jane Smith, OU=Java Software, O=Oracle, L=cup, S=ca, C=us (jane)\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 s = signature was verified\fP +.fi +.nf +\f3 m = entry is listed in manifest\fP +.fi +.nf +\f3 k = at least one certificate was found in keystore\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 jar verified\&.\fP +.fi +.nf +\f3\fR +.fi +.sp +If the certificate for a signer is not an X\&.509 certificate, then there is no distinguished name information\&. In that case, just the certificate type and the alias are shown\&. For example, if the certificate is a PGP certificate, and the alias is \f3bob\fR, then you would get: \f3PGP, (bob)\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +keytool(1) +.TP 0.2i +\(bu +Trail: Security Features in Java SE at http://docs\&.oracle\&.com/javase/tutorial/security/index\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/java.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/java.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/javac.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/javac.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,1369 +1,1369 @@ -'\" t -.\" Copyright (c) 1994, 2015, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 03 March 2015 -.\" SectDesc: Basic Tools -.\" Title: javac.1 -.\" -.if n .pl 99999 -.TH javac 1 "03 March 2015" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -javac \- Reads Java class and interface definitions and compiles them into bytecode and class files\&. -.SH SYNOPSIS -.sp -.nf - -\fBjavac\fR [ \fIoptions\fR ] [ \fIsourcefiles\fR ] [ \fIclasses\fR] [ \fI@argfiles\fR ] -.fi -.sp -Arguments can be in any order: -.TP -\fIoptions\fR -Command-line options\&. See Options\&. -.TP -\fIsourcefiles\fR -One or more source files to be compiled (such as \f3MyClass\&.java\fR)\&. -.TP -\fIclasses\fR -One or more classes to be processed for annotations (such as \f3MyPackage\&.MyClass\fR)\&. -.TP -\fI@argfiles\fR -One or more files that list options and source files\&. The \f3-J\fR options are not allowed in these files\&. See Command-Line Argument Files\&. -.SH DESCRIPTION -The \f3javac\fR command reads class and interface definitions, written in the Java programming language, and compiles them into bytecode class files\&. The \f3javac\fR command can also process annotations in Java source files and classes\&. -.PP -There are two ways to pass source code file names to \f3javac\fR\&. -.TP 0.2i -\(bu -For a small number of source files, list the file names on the command line\&. -.TP 0.2i -\(bu -For a large number of source files, list the file names in a file that is separated by blanks or line breaks\&. Use the list file name preceded by an at sign (@) with the \f3javac\fR command\&. -.PP -Source code file names must have \&.java suffixes, class file names must have \&.class suffixes, and both source and class files must have root names that identify the class\&. For example, a class called \f3MyClass\fR would be written in a source file called \f3MyClass\&.java\fR and compiled into a bytecode class file called \f3MyClass\&.class\fR\&. -.PP -Inner class definitions produce additional class files\&. These class files have names that combine the inner and outer class names, such as \f3MyClass$MyInnerClass\&.class\fR\&. -.PP -Arrange source files in a directory tree that reflects their package tree\&. For example, if all of your source files are in \f3/workspace\fR, then put the source code for \f3com\&.mysoft\&.mypack\&.MyClass\fR in \f3/workspace/com/mysoft/mypack/MyClass\&.java\fR\&. -.PP -By default, the compiler puts each class file in the same directory as its source file\&. You can specify a separate destination directory with the \f3-d\fR option\&. -.SH OPTIONS -The compiler has a set of standard options that are supported on the current development environment\&. An additional set of nonstandard options are specific to the current virtual machine and compiler implementations and are subject to change in the future\&. Nonstandard options begin with the \f3-X\fR option\&. -.TP 0.2i -\(bu -See also Cross-Compilation Options -.TP 0.2i -\(bu -See also Nonstandard Options -.SS STANDARD\ OPTIONS -.TP --A\fIkey\fR[\fI=value\fR] -.br -Specifies options to pass to annotation processors\&. These options are not interpreted by \f3javac\fR directly, but are made available for use by individual processors\&. The \f3key\fR value should be one or more identifiers separated by a dot (\&.)\&. -.TP --cp \fIpath\fR or -classpath \fIpath\fR -.br -Specifies where to find user class files, and (optionally) annotation processors and source files\&. This class path overrides the user class path in the \f3CLASSPATH\fR environment variable\&. If neither \f3CLASSPATH\fR, \f3-cp\fR nor \f3-classpath\fR is specified, then the user \fIclass path\fR is the current directory\&. See Setting the Class Path\&. - -If the \f3-sourcepath\fR option is not specified, then the user class path is also searched for source files\&. - -If the \f3-processorpath\fR option is not specified, then the class path is also searched for annotation processors\&. -.TP --Djava\&.ext\&.dirs=\fIdirectories\fR -.br -Overrides the location of installed extensions\&. -.TP --Djava\&.endorsed\&.dirs=\fIdirectories\fR -.br -Overrides the location of the endorsed standards path\&. -.TP --d \fIdirectory\fR -.br -Sets the destination directory for class files\&. The directory must already exist because \f3javac\fR does not create it\&. If a class is part of a package, then \f3javac\fR puts the class file in a subdirectory that reflects the package name and creates directories as needed\&. - -If you specify \f3-d\fR\f3/home/myclasses\fR and the class is called \f3com\&.mypackage\&.MyClass\fR, then the class file is \f3/home/myclasses/com/mypackage/MyClass\&.class\fR\&. - -If the \fI-d\fR option is not specified, then \f3javac\fR puts each class file in the same directory as the source file from which it was generated\&. - -\fINote:\fR The directory specified by the \fI-d\fR option is not automatically added to your user class path\&. -.TP --deprecation -.br -Shows a description of each use or override of a deprecated member or class\&. Without the \f3-deprecation\fR option, \f3javac\fR shows a summary of the source files that use or override deprecated members or classes\&. The \f3-deprecation\fR option is shorthand for \f3-Xlint:deprecation\fR\&. -.TP --encoding \fIencoding\fR -.br -Sets the source file encoding name, such as EUC-JP and UTF-8\&. If the \f3-encoding\fR option is not specified, then the platform default converter is used\&. -.TP --endorseddirs \fIdirectories\fR -.br -Overrides the location of the endorsed standards path\&. -.TP --extdirs \fIdirectories\fR -.br -Overrides the location of the \f3ext\fR directory\&. The directories variable is a colon-separated list of directories\&. Each JAR file in the specified directories is searched for class files\&. All JAR files found become part of the class path\&. - -If you are cross-compiling (compiling classes against bootstrap and extension classes of a different Java platform implementation), then this option specifies the directories that contain the extension classes\&. See Cross-Compilation Options for more information\&. -.TP --g -.br -Generates all debugging information, including local variables\&. By default, only line number and source file information is generated\&. -.TP --g:none -.br -Does not generate any debugging information\&. -.TP --g:[\fIkeyword list\fR] -.br -Generates only some kinds of debugging information, specified by a comma separated list of keywords\&. Valid keywords are: -.RS -.TP -source -Source file debugging information\&. -.TP -lines -Line number debugging information\&. -.TP -vars -Local variable debugging information\&. -.RE - -.TP --help -.br -Prints a synopsis of standard options\&. -.TP --implicit:[\fIclass, none\fR] -.br -Controls the generation of class files for implicitly loaded source files\&. To automatically generate class files, use \f3-implicit:class\fR\&. To suppress class file generation, use \f3-implicit:none\fR\&. If this option is not specified, then the default is to automatically generate class files\&. In this case, the compiler issues a warning if any such class files are generated when also doing annotation processing\&. The warning is not issued when the \f3-implicit\fR option is set explicitly\&. See Searching for Types\&. -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. - -\fINote:\fR The \fICLASSPATH\fR, \f3-classpath\fR, \f3-bootclasspath\fR, and \f3-extdirs\fR options do not specify the classes used to run \f3javac\fR\&. Trying to customize the compiler implementation with these options and variables is risky and often does not accomplish what you want\&. If you must customize the complier implementation, then use the \f3-J\fR option to pass options through to the underlying \f3\fRJava launcher\&. -.TP --nowarn -.br -Disables warning messages\&. This option operates the same as the \f3-Xlint:none\fR option\&. -.TP --parameters -.br -Stores formal parameter names of constructors and methods in the generated class file so that the method \f3java\&.lang\&.reflect\&.Executable\&.getParameters\fR from the Reflection API can retrieve them\&. -.TP --proc: [\fInone\fR, \fIonly\fR] -.br -Controls whether annotation processing and compilation are done\&. \f3-proc:none\fR means that compilation takes place without annotation processing\&. \f3-proc:only\fR means that only annotation processing is done, without any subsequent compilation\&. -.TP --processor \fIclass1\fR [,\fIclass2\fR,\fIclass3\fR\&.\&.\&.] -.br -Names of the annotation processors to run\&. This bypasses the default discovery process\&. -.TP --processorpath \fIpath\fR -.br -Specifies where to find annotation processors\&. If this option is not used, then the class path is searched for processors\&. -.TP --s \fIdir\fR -.br -Specifies the directory where to place the generated source files\&. The directory must already exist because \f3javac\fR does not create it\&. If a class is part of a package, then the compiler puts the source file in a subdirectory that reflects the package name and creates directories as needed\&. - -If you specify \f3-s /home/mysrc\fR and the class is called \f3com\&.mypackage\&.MyClass\fR, then the source file is put in \f3/home/mysrc/com/mypackage/MyClass\&.java\fR\&. -.TP --source \fIrelease\fR -.br -Specifies the version of source code accepted\&. The following values for \f3release\fR are allowed: -.RS -.TP -1\&.3 -The compiler does not support assertions, generics, or other language features introduced after Java SE 1\&.3\&. -.TP -1\&.4 -The compiler accepts code containing assertions, which were introduced in Java SE 1\&.4\&. -.TP -1\&.5 -The compiler accepts code containing generics and other language features introduced in Java SE 5\&. -.TP -5 -Synonym for 1\&.5\&. -.TP -1\&.6 -No language changes were introduced in Java SE 6\&. However, encoding errors in source files are now reported as errors instead of warnings as in earlier releases of Java Platform, Standard Edition\&. -.TP -6 -Synonym for 1\&.6\&. -.TP -1\&.7 -The compiler accepts code with features introduced in Java SE 7\&. -.TP -7 -Synonym for 1\&.7\&. -.TP -1\&.8 -This is the default value\&. The compiler accepts code with features introduced in Java SE 8\&. -.TP -8 -Synonym for 1\&.8\&. -.RE - -.TP --sourcepath \fIsourcepath\fR -.br -Specifies the source code path to search for class or interface definitions\&. As with the user class path, source path entries are separated by colons (:) on Oracle Solaris and semicolons on Windows and can be directories, JAR archives, or ZIP archives\&. If packages are used, then the local path name within the directory or archive must reflect the package name\&. - -\fINote:\fR Classes found through the class path might be recompiled when their source files are also found\&. See Searching for Types\&. -.TP --verbose -.br -Uses verbose output, which includes information about each class loaded and each source file compiled\&. -.TP --version -.br -Prints release information\&. -.TP --werror -.br -Terminates compilation when warnings occur\&. -.TP --X -.br -Displays information about nonstandard options and exits\&. -.SS CROSS-COMPILATION\ OPTIONS -By default, classes are compiled against the bootstrap and extension classes of the platform that \f3javac\fR shipped with\&. But \f3javac\fR also supports cross-compiling, where classes are compiled against a bootstrap and extension classes of a different Java platform implementation\&. It is important to use the \f3-bootclasspath\fR and \f3-extdirs\fR options when cross-compiling\&. -.TP --target \fIversion\fR -.br -Generates class files that target a specified release of the virtual machine\&. Class files will run on the specified target and on later releases, but not on earlier releases of the JVM\&. Valid targets are 1\&.1, 1\&.2, 1\&.3, 1\&.4, 1\&.5 (also 5), 1\&.6 (also 6), 1\&.7 (also 7), and 1\&.8 (also 8)\&. - -The default for the \f3-target\fR option depends on the value of the \f3-source\fR option: -.RS -.TP 0.2i -\(bu -If the \f3-source\fR option is not specified, then the value of the \f3-target\fR option is 1\&.8 -.TP 0.2i -\(bu -If the \f3-source\fR option is 1\&.2, then the value of the \f3-target\fR option is 1\&.4 -.TP 0.2i -\(bu -If the \f3-source\fR option is 1\&.3, then the value of the \f3-target\fR option is 1\&.4 -.TP 0.2i -\(bu -If the \f3-source\fR option is 1\&.5, then the value of the \f3-target\fR option is 1\&.8 -.TP 0.2i -\(bu -If the \f3-source\fR option is 1\&.6, then the value of the \f3-target\fR is option 1\&.8 -.TP 0.2i -\(bu -If the \f3-source\fR option is 1\&.7, then the value of the \f3-target\fR is option 1\&.8 -.TP 0.2i -\(bu -For all other values of the \f3-source\fR option, the value of the \f3-target\fR option is the value of the \f3-source\fR option\&. -.RE - -.TP --bootclasspath \fIbootclasspath\fR -.br -Cross-compiles against the specified set of boot classes\&. As with the user class path, boot class path entries are separated by colons (:) and can be directories, JAR archives, or ZIP archives\&. -.SS COMPACT\ PROFILE\ OPTION -Beginning with JDK 8, the \f3javac\fR compiler supports compact profiles\&. With compact profiles, applications that do not require the entire Java platform can be deployed and run with a smaller footprint\&. The compact profiles feature could be used to shorten the download time for applications from app stores\&. This feature makes for more compact deployment of Java applications that bundle the JRE\&. This feature is also useful in small devices\&. -.PP -The supported profile values are \f3compact1\fR, \f3compact2\fR, and \f3compact3\fR\&. These are additive layers\&. Each higher-numbered compact profile contains all of the APIs in profiles with smaller number names\&. -.TP --profile -.br -When using compact profiles, this option specifies the profile name when compiling\&. For example: -.sp -.nf -\f3javac \-profile compact1 Hello\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp - - -javac does not compile source code that uses any Java SE APIs that is not in the specified profile\&. Here is an example of the error message that results from attempting to compile such source code: -.sp -.nf -\f3cd jdk1\&.8\&.0/bin\fP -.fi -.nf -\f3\&./javac \-profile compact1 Paint\&.java\fP -.fi -.nf -\f3Paint\&.java:5: error: Applet is not available in profile \&'compact1\&'\fP -.fi -.nf -\f3import java\&.applet\&.Applet;\fP -.fi -.nf -\f3\fP -.fi -.sp - - -In this example, you can correct the error by modifying the source to not use the \f3Applet\fR class\&. You could also correct the error by compiling without the -profile option\&. Then the compilation would be run against the full set of Java SE APIs\&. (None of the compact profiles include the \f3Applet\fR class\&.) - -An alternative way to compile with compact profiles is to use the \f3-bootclasspath\fR option to specify a path to an \f3rt\&.jar\fR file that specifies a profile\&'s image\&. Using the \f3-profile\fR option instead does not require a profile image to be present on the system at compile time\&. This is useful when cross-compiling\&. -.SS NONSTANDARD\ OPTIONS -.TP --Xbootclasspath/p:\fIpath\fR -.br -Adds a suffix to the bootstrap class path\&. -.TP --Xbootclasspath/a:\fIpath\fR -.br -Adds a prefix to the bootstrap class path\&. -.TP --Xbootclasspath/:\fIpath\fR -.br -Overrides the location of the bootstrap class files\&. -.TP --Xdoclint:[-]\fIgroup\fR [\fI/access\fR] -.br -Enables or disables specific groups of checks, where \fIgroup\fR is one of the following values: \f3accessibility\fR, \f3syntax\fR, \f3reference\fR, \f3html\fR or \f3missing\fR\&. For more information about these groups of checks see the \f3-Xdoclint\fR option of the \f3javadoc\fR command\&. The \f3-Xdoclint\fR option is disabled by default in the \f3javac\fR command\&. - -The variable \fIaccess\fR specifies the minimum visibility level of classes and members that the \f3-Xdoclint\fR option checks\&. It can have one of the following values (in order of most to least visible) : \f3public\fR, \f3protected\fR, \f3package\fR and \f3private\fR\&. For example, the following option checks classes and members (with all groups of checks) that have the access level protected and higher (which includes protected, package and public): -.sp -.nf -\f3\-Xdoclint:all/protected\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The following option enables all groups of checks for all access levels, except it will not check for HTML errors for classes and members that have access level package and higher (which includes package and public): -.sp -.nf -\f3\-Xdoclint:all,\-html/package\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --Xdoclint:none -.br -Disables all groups of checks\&. -.TP --Xdoclint:all[\fI/access\fR] -.br -Enables all groups of checks\&. -.TP --Xlint -.br -\fI\fREnables all recommended warnings\&. In this release, enabling all available warnings is recommended\&. -.TP --Xlint:all -.br -\fI\fREnables all recommended warnings\&. In this release, enabling all available warnings is recommended\&. -.TP --Xlint:none -.br -Disables all warnings\&. -.TP --Xlint:\fIname\fR -.br -Disables warning name\&. See Enable or Disable Warnings with the -Xlint Option for a list of warnings you can disable with this option\&. -.TP --Xlint:\fI-name\fR -.br -Disables warning name\&. See Enable or Disable Warnings with the -Xlint Option with the \f3-Xlint\fR option to get a list of warnings that you can disable with this option\&. -.TP --Xmaxerrs \fInumber\fR -.br -Sets the maximum number of errors to print\&. -.TP --Xmaxwarns \fInumber\fR -.br -Sets the maximum number of warnings to print\&. -.TP --Xstdout \fIfilename\fR -.br -Sends compiler messages to the named file\&. By default, compiler messages go to \f3System\&.err\fR\&. -.TP --Xprefer:[\fInewer,source\fR] -.br -Specifies which file to read when both a source file and class file are found for a type\&. (See Searching for Types)\&. If the \f3-Xprefer:newer\fR option is used, then it reads the newer of the source or class file for a type (default)\&. If the \f3-Xprefer:source\fR option is used, then it reads the source file\&. Use -\f3Xprefer:source\fR when you want to be sure that any annotation processors can access annotations declared with a retention policy of \f3SOURCE\fR\&. -.TP --Xpkginfo:[\fIalways\fR,\fIlegacy\fR,\fInonempty\fR] -.br -Control whether javac generates \f3package-info\&.class\fR files from package-info\&.java files\&. Possible mode arguments for this option include the following\&. -.RS -.TP -always -Always generate a \f3package-info\&.class\fR file for every \f3package-info\&.java\fR file\&. This option may be useful if you use a build system such as Ant, which checks that each \f3\&.java\fR file has a corresponding \f3\&.class\fR file\&. -.TP -legacy -Generate a \f3package-info\&.class\fR file only if package-info\&.java contains annotations\&. Don\&'t generate a \f3package-info\&.class\fR file if package-info\&.java only contains comments\&. - -\fINote:\fR A \f3package-info\&.class\fR file might be generated but be empty if all the annotations in the package-info\&.java file have \f3RetentionPolicy\&.SOURCE\fR\&. -.TP -nonempty -Generate a \f3package-info\&.class\fR file only if package-info\&.java contains annotations with \f3RetentionPolicy\&.CLASS\fR or \f3RetentionPolicy\&.RUNTIME\fR\&. -.RE - -.TP --Xprint -.br -Prints a textual representation of specified types for debugging purposes\&. Perform neither annotation processing nor compilation\&. The format of the output could change\&. -.TP --XprintProcessorInfo -.br -Prints information about which annotations a processor is asked to process\&. -.TP --XprintRounds -.br -Prints information about initial and subsequent annotation processing rounds\&. -.SH ENABLE\ OR\ DISABLE\ WARNINGS\ WITH\ THE\ -XLINT\ OPTION -Enable warning \fIname\fR with the \f3-Xlint:name\fR option, where \f3name\fR is one of the following warning names\&. Note that you can disable a warning with the \f3-Xlint:-name:\fR option\&. -.TP -cast -Warns about unnecessary and redundant casts, for example: -.sp -.nf -\f3String s = (String) "Hello!"\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -classfile -Warns about issues related to class file contents\&. -.TP -deprecation -Warns about the use of deprecated items, for example: -.sp -.nf -\f3java\&.util\&.Date myDate = new java\&.util\&.Date();\fP -.fi -.nf -\f3int currentDay = myDate\&.getDay();\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The method \f3java\&.util\&.Date\&.getDay\fR has been deprecated since JDK 1\&.1 -.TP -dep-ann -Warns about items that are documented with an \f3@deprecated\fR Javadoc comment, but do not have a \f3@Deprecated\fR annotation, for example: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * @deprecated As of Java SE 7, replaced by {@link #newMethod()}\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3public static void deprecatedMethood() { }\fP -.fi -.nf -\f3public static void newMethod() { }\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -divzero -Warns about division by the constant integer 0, for example: -.sp -.nf -\f3int divideByZero = 42 / 0;\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -empty -Warns about empty statements after \f3if\fRstatements, for example: -.sp -.nf -\f3class E {\fP -.fi -.nf -\f3 void m() {\fP -.fi -.nf -\f3 if (true) ;\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -fallthrough -Checks the switch blocks for fall-through cases and provides a warning message for any that are found\&. Fall-through cases are cases in a switch block, other than the last case in the block, whose code does not include a break statement, allowing code execution to fall through from that case to the next case\&. For example, the code following the case 1 label in this switch block does not end with a break statement: -.sp -.nf -\f3switch (x) {\fP -.fi -.nf -\f3case 1:\fP -.fi -.nf -\f3 System\&.out\&.println("1");\fP -.fi -.nf -\f3 // No break statement here\&.\fP -.fi -.nf -\f3case 2:\fP -.fi -.nf -\f3 System\&.out\&.println("2");\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - - -If the \f3-Xlint:fallthrough\fR option was used when compiling this code, then the compiler emits a warning about possible fall-through into case, with the line number of the case in question\&. -.TP -finally -Warns about \f3finally\fR clauses that cannot complete normally, for example: -.sp -.nf -\f3public static int m() {\fP -.fi -.nf -\f3 try {\fP -.fi -.nf -\f3 throw new NullPointerException();\fP -.fi -.nf -\f3 } catch (NullPointerException(); {\fP -.fi -.nf -\f3 System\&.err\&.println("Caught NullPointerException\&.");\fP -.fi -.nf -\f3 return 1;\fP -.fi -.nf -\f3 } finally {\fP -.fi -.nf -\f3 return 0;\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The compiler generates a warning for the \f3finally\fR block in this example\&. When the \f3int\fR method is called, it returns a value of 0\&. A \f3finally\fR block executes when the \f3try\fR block exits\&. In this example, when control is transferred to the \f3catch\fR block, the \f3int\fR method exits\&. However, the \f3finally\fR block must execute, so it is executed, even though control was transferred outside the method\&. -.TP -options -Warns about issues that related to the use of command-line options\&. See Cross-Compilation Options\&. -.TP -overrides -Warns about issues regarding method overrides\&. For example, consider the following two classes: -.sp -.nf -\f3public class ClassWithVarargsMethod {\fP -.fi -.nf -\f3 void varargsMethod(String\&.\&.\&. s) { }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3public class ClassWithOverridingMethod extends ClassWithVarargsMethod {\fP -.fi -.nf -\f3 @Override\fP -.fi -.nf -\f3 void varargsMethod(String[] s) { }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The compiler generates a warning similar to the following:\&. -.sp -.nf -\f3warning: [override] varargsMethod(String[]) in ClassWithOverridingMethod \fP -.fi -.nf -\f3overrides varargsMethod(String\&.\&.\&.) in ClassWithVarargsMethod; overriding\fP -.fi -.nf -\f3method is missing \&'\&.\&.\&.\&'\fP -.fi -.nf -\f3\fP -.fi -.sp - - -When the compiler encounters a \f3varargs\fR method, it translates the \f3varargs\fR formal parameter into an array\&. In the method \f3ClassWithVarargsMethod\&.varargsMethod\fR, the compiler translates the \f3varargs\fR formal parameter \f3String\&.\&.\&. s\fR to the formal parameter \f3String[] s\fR, an array, which matches the formal parameter of the method \f3ClassWithOverridingMethod\&.varargsMethod\fR\&. Consequently, this example compiles\&. -.TP -path -Warns about invalid path elements and nonexistent path directories on the command line (with regard to the class path, the source path, and other paths)\&. Such warnings cannot be suppressed with the \f3@SuppressWarnings\fR annotation, for example: -.sp -.nf -\f3javac \-Xlint:path \-classpath /nonexistentpath Example\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -processing -Warn about issues regarding annotation processing\&. The compiler generates this warning when you have a class that has an annotation, and you use an annotation processor that cannot handle that type of exception\&. For example, the following is a simple annotation processor: - -\fISource file AnnocProc\&.java\fR: -.sp -.nf -\f3import java\&.util\&.*;\fP -.fi -.nf -\f3import javax\&.annotation\&.processing\&.*;\fP -.fi -.nf -\f3import javax\&.lang\&.model\&.*;\fP -.fi -.nf -\f3import\&.javaz\&.lang\&.model\&.element\&.*;\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3@SupportedAnnotationTypes("NotAnno")\fP -.fi -.nf -\f3public class AnnoProc extends AbstractProcessor {\fP -.fi -.nf -\f3 public boolean process(Set<? extends TypeElement> elems, RoundEnvironment renv){\fP -.fi -.nf -\f3 return true;\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 public SourceVersion getSupportedSourceVersion() {\fP -.fi -.nf -\f3 return SourceVersion\&.latest();\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - - -\fISource file AnnosWithoutProcessors\&.java\fR: -.sp -.nf -\f3@interface Anno { }\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3@Anno\fP -.fi -.nf -\f3class AnnosWithoutProcessors { }\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The following commands compile the annotation processor \f3AnnoProc\fR, then run this annotation processor against the source file \f3AnnosWithoutProcessors\&.java\fR: -.sp -.nf -\f3javac AnnoProc\&.java\fP -.fi -.nf -\f3javac \-cp \&. \-Xlint:processing \-processor AnnoProc \-proc:only AnnosWithoutProcessors\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp - - -When the compiler runs the annotation processor against the source file \f3AnnosWithoutProcessors\&.java\fR, it generates the following warning: -.sp -.nf -\f3warning: [processing] No processor claimed any of these annotations: Anno\fP -.fi -.nf -\f3\fP -.fi -.sp - - -To resolve this issue, you can rename the annotation defined and used in the class \f3AnnosWithoutProcessors\fR from \f3Anno\fR to \f3NotAnno\fR\&. -.TP -rawtypes -Warns about unchecked operations on raw types\&. The following statement generates a \f3rawtypes\fR warning: -.sp -.nf -\f3void countElements(List l) { \&.\&.\&. }\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The following example does not generate a \f3rawtypes\fR warning -.sp -.nf -\f3void countElements(List<?> l) { \&.\&.\&. }\fP -.fi -.nf -\f3\fP -.fi -.sp - - -\f3List\fR is a raw type\&. However, \f3List<?>\fR is an unbounded wildcard parameterized type\&. Because \f3List\fR is a parameterized interface, always specify its type argument\&. In this example, the \f3List\fR formal argument is specified with an unbounded wildcard (\f3?\fR) as its formal type parameter, which means that the \f3countElements\fR method can accept any instantiation of the \f3List\fR interface\&. -.TP -Serial -Warns about missing \f3serialVersionUID\fR definitions on serializable classes, for example: -.sp -.nf -\f3public class PersistentTime implements Serializable\fP -.fi -.nf -\f3{\fP -.fi -.nf -\f3 private Date time;\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 public PersistentTime() {\fP -.fi -.nf -\f3 time = Calendar\&.getInstance()\&.getTime();\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 public Date getTime() {\fP -.fi -.nf -\f3 return time;\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The compiler generates the following warning: -.sp -.nf -\f3warning: [serial] serializable class PersistentTime has no definition of\fP -.fi -.nf -\f3serialVersionUID\fP -.fi -.nf -\f3\fP -.fi -.sp - - -If a serializable class does not explicitly declare a field named \f3serialVersionUID\fR, then the serialization runtime environment calculates a default \f3serialVersionUID\fR value for that class based on various aspects of the class, as described in the Java Object Serialization Specification\&. However, it is strongly recommended that all serializable classes explicitly declare \f3serialVersionUID\fR values because the default process of computing \f3serialVersionUID\fR vales is highly sensitive to class details that can vary depending on compiler implementations, and as a result, might cause an unexpected \f3InvalidClassExceptions\fR during deserialization\&. To guarantee a consistent \f3serialVersionUID\fR value across different Java compiler implementations, a serializable class must declare an explicit \f3serialVersionUID\fR value\&. -.TP -static -Warns about issues relating to the use of statics, for example: -.sp -.nf -\f3class XLintStatic {\fP -.fi -.nf -\f3 static void m1() { }\fP -.fi -.nf -\f3 void m2() { this\&.m1(); }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The compiler generates the following warning: -.sp -.nf -\f3warning: [static] static method should be qualified by type name, \fP -.fi -.nf -\f3XLintStatic, instead of by an expression\fP -.fi -.nf -\f3\fP -.fi -.sp - - -To resolve this issue, you can call the \f3static\fR method \f3m1\fR as follows: -.sp -.nf -\f3XLintStatic\&.m1();\fP -.fi -.nf -\f3\fP -.fi -.sp - - -Alternately, you can remove the \f3static\fR keyword from the declaration of the method \f3m1\fR\&. -.TP -try -Warns about issues relating to use of \f3try\fR blocks, including try-with-resources statements\&. For example, a warning is generated for the following statement because the resource \f3ac\fR declared in the \f3try\fR block is not used: -.sp -.nf -\f3try ( AutoCloseable ac = getResource() ) { // do nothing}\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -unchecked -Gives more detail for unchecked conversion warnings that are mandated by the Java Language Specification, for example: -.sp -.nf -\f3List l = new ArrayList<Number>();\fP -.fi -.nf -\f3List<String> ls = l; // unchecked warning\fP -.fi -.nf -\f3\fP -.fi -.sp - - -During type erasure, the types \f3ArrayList<Number>\fR and \f3List<String>\fR become \f3ArrayList\fR and \f3List\fR, respectively\&. - -The \f3ls\fR command has the parameterized type \f3List<String>\fR\&. When the \f3List\fR referenced by \f3l\fR is assigned to \f3ls\fR, the compiler generates an unchecked warning\&. At compile time, the compiler and JVM cannot determine whether \f3l\fR refers to a \f3List<String>\fR type\&. In this case, \f3l\fR does not refer to a \f3List<String>\fR type\&. As a result, heap pollution occurs\&. - -A heap pollution situation occurs when the \f3List\fR object \f3l\fR, whose static type is \f3List<Number>\fR, is assigned to another \f3List\fR object, \f3ls\fR, that has a different static type, \f3List<String>\fR\&. However, the compiler still allows this assignment\&. It must allow this assignment to preserve backward compatibility with releases of Java SE that do not support generics\&. Because of type erasure, \f3List<Number>\fR and \f3List<String>\fR both become \f3List\fR\&. Consequently, the compiler allows the assignment of the object \f3l\fR\f3,\fR which has a raw type of \f3List\fR, to the object \f3ls\fR\&. -.TP -varargs -Warns about unsafe usages of variable arguments (\f3varargs\fR) methods, in particular, those that contain non-reifiable arguments, for example: -.sp -.nf -\f3public class ArrayBuilder {\fP -.fi -.nf -\f3 public static <T> void addToList (List<T> listArg, T\&.\&.\&. elements) {\fP -.fi -.nf -\f3 for (T x : elements) {\fP -.fi -.nf -\f3 listArg\&.add(x);\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - - -\fINote:\fR A non-reifiable type is a type whose type information is not fully available at runtime\&. - -The compiler generates the following warning for the definition of the method \f3ArrayBuilder\&.addToList\fR -.sp -.nf -\f3warning: [varargs] Possible heap pollution from parameterized vararg type T\fP -.fi -.nf -\f3\fP -.fi -.sp - - -When the compiler encounters a varargs method, it translates the \f3varargs\fR formal parameter into an array\&. However, the Java programming language does not permit the creation of arrays of parameterized types\&. In the method \f3ArrayBuilder\&.addToList\fR, the compiler translates the \f3varargs\fR formal parameter \f3T\&.\&.\&.\fR elements to the formal parameter \f3T[]\fR elements, an array\&. However, because of type erasure, the compiler converts the \f3varargs\fR formal parameter to \f3Object[]\fR elements\&. Consequently, there is a possibility of heap pollution\&. -.SH COMMAND-LINE\ ARGUMENT\ FILES -To shorten or simplify the \f3javac\fR command, you can specify one or more files that contain arguments to the \f3javac\fR command (except \f3-J\fR options)\&. This enables you to create \f3javac\fR commands of any length on any operating system\&. -.PP -An argument file can include \f3javac\fR options and source file names in any combination\&. The arguments within a file can be separated by spaces or new line characters\&. If a file name contains embedded spaces, then put the whole file name in double quotation marks\&. -.PP -File Names within an argument file are relative to the current directory, not the location of the argument file\&. Wild cards (*) are not allowed in these lists (such as for specifying \f3*\&.java\fR)\&. Use of the at sign (@) to recursively interpret files is not supported\&. The \f3-J\fR options are not supported because they are passed to the launcher, which does not support argument files\&. -.PP -When executing the \f3javac\fR command, pass in the path and name of each argument file with the at sign (@) leading character\&. When the \f3javac\fR command encounters an argument beginning with the at sign (@), it expands the contents of that file into the argument list\&. -.PP -\f3Example 1 Single Argument File\fR -.PP -You could use a single argument file named \f3argfile\fR to hold all \f3javac\fR arguments: -.sp -.nf -\f3javac @argfile\fP -.fi -.nf -\f3\fP -.fi -.sp -This argument file could contain the contents of both files shown in Example 2 -.PP -\f3Example 2 Two Argument Files\fR -.PP -You can create two argument files: one for the \f3javac\fR options and the other for the source file names\&. Note that the following lists have no line-continuation characters\&. -.PP -Create a file named options that contains the following: -.sp -.nf -\f3\-d classes\fP -.fi -.nf -\f3\-g\fP -.fi -.nf -\f3\-sourcepath /java/pubs/ws/1\&.3/src/share/classes\fP -.fi -.nf -\f3\fP -.fi -.sp -Create a file named classes that contains the following: -.sp -.nf -\f3MyClass1\&.java\fP -.fi -.nf -\f3MyClass2\&.java\fP -.fi -.nf -\f3MyClass3\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -Then, run the \f3javac\fR command as follows: -.sp -.nf -\f3javac @options @classes\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 3 Argument Files with Paths\fR -.PP -The argument files can have paths, but any file names inside the files are relative to the current working directory (not \f3path1\fR or \f3path2\fR): -.sp -.nf -\f3javac @path1/options @path2/classes\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH ANNOTATION\ PROCESSING -The \f3javac\fR command provides direct support for annotation processing, superseding the need for the separate annotation processing command, \f3apt\fR\&. -.PP -The API for annotation processors is defined in the \f3javax\&.annotation\&.processing\fR and j\f3avax\&.lang\&.model\fR packages and subpackages\&. -.SS HOW\ ANNOTATION\ PROCESSING\ WORKS -Unless annotation processing is disabled with the \f3-proc:none\fR option, the compiler searches for any annotation processors that are available\&. The search path can be specified with the \f3-processorpath\fR option\&. If no path is specified, then the user class path is used\&. Processors are located by means of service provider-configuration files named \f3META-INF/services/javax\&.annotation\&.processing\fR\&.Processor on the search path\&. Such files should contain the names of any annotation processors to be used, listed one per line\&. Alternatively, processors can be specified explicitly, using the \f3-processor\fR option\&. -.PP -After scanning the source files and classes on the command line to determine what annotations are present, the compiler queries the processors to determine what annotations they process\&. When a match is found, the processor is called\&. A processor can claim the annotations it processes, in which case no further attempt is made to find any processors for those annotations\&. After all of the annotations are claimed, the compiler does not search for additional processors\&. -.PP -If any processors generate new source files, then another round of annotation processing occurs: Any newly generated source files are scanned, and the annotations processed as before\&. Any processors called on previous rounds are also called on all subsequent rounds\&. This continues until no new source files are generated\&. -.PP -After a round occurs where no new source files are generated, the annotation processors are called one last time, to give them a chance to complete any remaining work\&. Finally, unless the \f3-proc:only\fR option is used, the compiler compiles the original and all generated source files\&. -.SS IMPLICITLY\ LOADED\ SOURCE\ FILES -To compile a set of source files, the compiler might need to implicitly load additional source files\&. See Searching for Types\&. Such files are currently not subject to annotation processing\&. By default, the compiler gives a warning when annotation processing occurred and any implicitly loaded source files are compiled\&. The \f3-implicit\fR option provides a way to suppress the warning\&. -.SH SEARCHING\ FOR\ TYPES -To compile a source file, the compiler often needs information about a type, but the type definition is not in the source files specified on the command line\&. The compiler needs type information for every class or interface used, extended, or implemented in the source file\&. This includes classes and interfaces not explicitly mentioned in the source file, but that provide information through inheritance\&. -.PP -For example, when you create a subclass \f3java\&.applet\&.Applet\fR, you are also using the ancestor classes of \f3Applet\fR: \f3java\&.awt\&.Panel\fR, \f3java\&.awt\&.Container\fR, \f3java\&.awt\&.Component\fR, and \f3java\&.lang\&.Object\fR\&. -.PP -When the compiler needs type information, it searches for a source file or class file that defines the type\&. The compiler searches for class files first in the bootstrap and extension classes, then in the user class path (which by default is the current directory)\&. The user class path is defined by setting the \f3CLASSPATH\fR environment variable or by using the \f3-classpath\fR option\&. -.PP -If you set the \f3-sourcepath\fR option, then the compiler searches the indicated path for source files\&. Otherwise, the compiler searches the user class path for both class files and source files\&. -.PP -You can specify different bootstrap or extension classes with the \f3-bootclasspath\fR and the \f3-extdirs\fR options\&. See Cross-Compilation Options\&. -.PP -A successful type search may produce a class file, a source file, or both\&. If both are found, then you can use the \f3-Xprefer\fR option to instruct the compiler which to use\&. If \f3newer\fR is specified, then the compiler uses the newer of the two files\&. If \f3source\fR is specified, the compiler uses the source file\&. The default is \f3newer\fR\&. -.PP -If a type search finds a source file for a required type, either by itself, or as a result of the setting for the \f3-Xprefer\fR option, then the compiler reads the source file to get the information it needs\&. By default the compiler also compiles the source file\&. You can use the \f3-implicit\fR option to specify the behavior\&. If \f3none\fR is specified, then no class files are generated for the source file\&. If \f3class\fR is specified, then class files are generated for the source file\&. -.PP -The compiler might not discover the need for some type information until after annotation processing completes\&. When the type information is found in a source file and no \f3-implicit\fR option is specified, the compiler gives a warning that the file is being compiled without being subject to annotation processing\&. To disable the warning, either specify the file on the command line (so that it will be subject to annotation processing) or use the \f3-implicit\fR option to specify whether or not class files should be generated for such source files\&. -.SH PROGRAMMATIC\ INTERFACE -The \f3javac\fR command supports the new Java Compiler API defined by the classes and interfaces in the \f3javax\&.tools\fR package\&. -.SS EXAMPLE -To compile as though providing command-line arguments, use the following syntax: -.sp -.nf -\f3JavaCompiler javac = ToolProvider\&.getSystemJavaCompiler();\fP -.fi -.nf -\f3\fP -.fi -.sp -The example writes diagnostics to the standard output stream and returns the exit code that \f3javac\fR would give when called from the command line\&. -.PP -You can use other methods in the \f3javax\&.tools\&.JavaCompiler\fR interface to handle diagnostics, control where files are read from and written to, and more\&. -.SS OLD\ INTERFACE -\fINote:\fR This API is retained for backward compatibility only\&. All new code should use the newer Java Compiler API\&. -.PP -The \f3com\&.sun\&.tools\&.javac\&.Main\fR class provides two static methods to call the compiler from a program: -.sp -.nf -\f3public static int compile(String[] args);\fP -.fi -.nf -\f3public static int compile(String[] args, PrintWriter out);\fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3args\fR parameter represents any of the command-line arguments that would typically be passed to the compiler\&. -.PP -The \f3out\fR parameter indicates where the compiler diagnostic output is directed\&. -.PP -The \f3return\fR value is equivalent to the \f3exit\fR value from \f3javac\fR\&. -.PP -\fINote:\fR All other classes and methods found in a package with names that start with \f3com\&.sun\&.tools\&.javac\fR (subpackages of \f3com\&.sun\&.tools\&.javac\fR) are strictly internal and subject to change at any time\&. -.SH EXAMPLES -\f3Example 1 Compile a Simple Program\fR -.PP -This example shows how to compile the \f3Hello\&.java\fR source file in the greetings directory\&. The class defined in \f3Hello\&.java\fR is called \f3greetings\&.Hello\fR\&. The greetings directory is the package directory both for the source file and the class file and is underneath the current directory\&. This makes it possible to use the default user class path\&. It also makes it unnecessary to specify a separate destination directory with the \f3-d\fR option\&. -.PP -The source code in \f3Hello\&.java\fR: -.sp -.nf -\f3package greetings;\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3public class Hello {\fP -.fi -.nf -\f3 public static void main(String[] args) {\fP -.fi -.nf -\f3 for (int i=0; i < args\&.length; i++) {\fP -.fi -.nf -\f3 System\&.out\&.println("Hello " + args[i]);\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp -Compile greetings\&.Hello: -.sp -.nf -\f3javac greetings/Hello\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -Run \f3greetings\&.Hello\fR: -.sp -.nf -\f3java greetings\&.Hello World Universe Everyone\fP -.fi -.nf -\f3Hello World\fP -.fi -.nf -\f3Hello Universe\fP -.fi -.nf -\f3Hello Everyone\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 2 Compile Multiple Source Files\fR -.PP -This example compiles the \f3Aloha\&.java\fR, \f3GutenTag\&.java\fR, \f3Hello\&.java\fR, and \f3Hi\&.java\fR source files in the \f3greetings\fR package\&. -.sp -.nf -\f3% javac greetings/*\&.java\fP -.fi -.nf -\f3% ls greetings\fP -.fi -.nf -\f3Aloha\&.class GutenTag\&.class Hello\&.class Hi\&.class\fP -.fi -.nf -\f3Aloha\&.java GutenTag\&.java Hello\&.java Hi\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 3 Specify a User Class Path\fR -.PP -After changing one of the source files in the previous example, recompile it: -.sp -.nf -\f3pwd\fP -.fi -.nf -\f3/examples\fP -.fi -.nf -\f3javac greetings/Hi\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -Because \f3greetings\&.Hi\fR refers to other classes in the \f3greetings\fR package, the compiler needs to find these other classes\&. The previous example works because the default user class path is the directory that contains the package directory\&. If you want to recompile this file without concern for which directory you are in, then add the examples directory to the user class path by setting \f3CLASSPATH\fR\&. This example uses the \f3-classpath\fR option\&. -.sp -.nf -\f3javac \-classpath /examples /examples/greetings/Hi\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -If you change \f3greetings\&.Hi\fR to use a banner utility, then that utility also needs to be accessible through the user class path\&. -.sp -.nf -\f3javac \-classpath /examples:/lib/Banners\&.jar \e\fP -.fi -.nf -\f3 /examples/greetings/Hi\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -To execute a class in the \f3greetings\fR package, the program needs access to the \f3greetings\fR package, and to the classes that the \f3greetings\fR classes use\&. -.sp -.nf -\f3java \-classpath /examples:/lib/Banners\&.jar greetings\&.Hi\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 4 Separate Source Files and Class Files\fR -.PP -The following example uses \f3javac\fR to compile code that runs on JVM 1\&.7\&. -.sp -.nf -\f3javac \-source 1\&.7 \-target 1\&.7 \-bootclasspath jdk1\&.7\&.0/lib/rt\&.jar \e \fP -.fi -.nf -\f3\-extdirs "" OldCode\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3-source 1\&.7\fR option specifies that release 1\&.7 (or 7) of the Java programming language be used to compile \f3OldCode\&.java\fR\&. The option \f3-target 1\&.7\fR option ensures that the generated class files are compatible with JVM 1\&.7\&. Note that in most cases, the value of the \f3-target\fR option is the value of the \f3-source\fR option; in this example, you can omit the \f3-target\fR option\&. -.PP -You must specify the \f3-bootclasspath\fR option to specify the correct version of the bootstrap classes (the \f3rt\&.jar\fR library)\&. If not, then the compiler generates a warning: -.sp -.nf -\f3javac \-source 1\&.7 OldCode\&.java\fP -.fi -.nf -\f3warning: [options] bootstrap class path not set in conjunction with \fP -.fi -.nf -\f3\-source 1\&.7\fP -.fi -.nf -\f3\fP -.fi -.sp -If you do not specify the correct version of bootstrap classes, then the compiler uses the old language rules (in this example, it uses version 1\&.7 of the Java programming language) combined with the new bootstrap classes, which can result in class files that do not work on the older platform (in this case, Java SE 7) because reference to nonexistent methods can get included\&. -.PP -\f3Example 5 Cross Compile\fR -.PP -This example uses \f3javac\fR to compile code that runs on JVM 1\&.7\&. -.sp -.nf -\f3javac \-source 1\&.7 \-target 1\&.7 \-bootclasspath jdk1\&.7\&.0/lib/rt\&.jar \e\fP -.fi -.nf -\f3 \-extdirs "" OldCode\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -The\f3-source 1\&.7\fR option specifies that release 1\&.7 (or 7) of the Java programming language to be used to compile OldCode\&.java\&. The \f3-target 1\&.7\fR option ensures that the generated class files are compatible with JVM 1\&.7\&. -.PP -You must specify the \f3-bootclasspath\fR option to specify the correct version of the bootstrap classes (the \f3rt\&.jar\fR library)\&. If not, then the compiler generates a warning: -.sp -.nf -\f3javac \-source 1\&.7 OldCode\&.java\fP -.fi -.nf -\f3warning: [options] bootstrap class path not set in conjunction with \-source 1\&.7\fP -.fi -.nf -\f3\fP -.fi -.sp -If you do not specify the correct version of bootstrap classes, then the compiler uses the old language rules combined with the new bootstrap classes\&. This combination can result in class files that do not work on the older platform (in this case, Java SE 7) because reference to nonexistent methods can get included\&. In this example, the compiler uses release 1\&.7 of the Java programming language\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -jdb(1) -.TP 0.2i -\(bu -javah(1) -.TP 0.2i -\(bu -javadoc(1) -.TP 0.2i -\(bu -jar(1) -.TP 0.2i -\(bu -jdb(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1994, 2015, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 03 March 2015 +.\" SectDesc: Basic Tools +.\" Title: javac.1 +.\" +.if n .pl 99999 +.TH javac 1 "03 March 2015" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +javac \- Reads Java class and interface definitions and compiles them into bytecode and class files\&. +.SH SYNOPSIS +.sp +.nf + +\fBjavac\fR [ \fIoptions\fR ] [ \fIsourcefiles\fR ] [ \fIclasses\fR] [ \fI@argfiles\fR ] +.fi +.sp +Arguments can be in any order: +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.TP +\fIsourcefiles\fR +One or more source files to be compiled (such as \f3MyClass\&.java\fR)\&. +.TP +\fIclasses\fR +One or more classes to be processed for annotations (such as \f3MyPackage\&.MyClass\fR)\&. +.TP +\fI@argfiles\fR +One or more files that list options and source files\&. The \f3-J\fR options are not allowed in these files\&. See Command-Line Argument Files\&. +.SH DESCRIPTION +The \f3javac\fR command reads class and interface definitions, written in the Java programming language, and compiles them into bytecode class files\&. The \f3javac\fR command can also process annotations in Java source files and classes\&. +.PP +There are two ways to pass source code file names to \f3javac\fR\&. +.TP 0.2i +\(bu +For a small number of source files, list the file names on the command line\&. +.TP 0.2i +\(bu +For a large number of source files, list the file names in a file that is separated by blanks or line breaks\&. Use the list file name preceded by an at sign (@) with the \f3javac\fR command\&. +.PP +Source code file names must have \&.java suffixes, class file names must have \&.class suffixes, and both source and class files must have root names that identify the class\&. For example, a class called \f3MyClass\fR would be written in a source file called \f3MyClass\&.java\fR and compiled into a bytecode class file called \f3MyClass\&.class\fR\&. +.PP +Inner class definitions produce additional class files\&. These class files have names that combine the inner and outer class names, such as \f3MyClass$MyInnerClass\&.class\fR\&. +.PP +Arrange source files in a directory tree that reflects their package tree\&. For example, if all of your source files are in \f3/workspace\fR, then put the source code for \f3com\&.mysoft\&.mypack\&.MyClass\fR in \f3/workspace/com/mysoft/mypack/MyClass\&.java\fR\&. +.PP +By default, the compiler puts each class file in the same directory as its source file\&. You can specify a separate destination directory with the \f3-d\fR option\&. +.SH OPTIONS +The compiler has a set of standard options that are supported on the current development environment\&. An additional set of nonstandard options are specific to the current virtual machine and compiler implementations and are subject to change in the future\&. Nonstandard options begin with the \f3-X\fR option\&. +.TP 0.2i +\(bu +See also Cross-Compilation Options +.TP 0.2i +\(bu +See also Nonstandard Options +.SS STANDARD\ OPTIONS +.TP +-A\fIkey\fR[\fI=value\fR] +.br +Specifies options to pass to annotation processors\&. These options are not interpreted by \f3javac\fR directly, but are made available for use by individual processors\&. The \f3key\fR value should be one or more identifiers separated by a dot (\&.)\&. +.TP +-cp \fIpath\fR or -classpath \fIpath\fR +.br +Specifies where to find user class files, and (optionally) annotation processors and source files\&. This class path overrides the user class path in the \f3CLASSPATH\fR environment variable\&. If neither \f3CLASSPATH\fR, \f3-cp\fR nor \f3-classpath\fR is specified, then the user \fIclass path\fR is the current directory\&. See Setting the Class Path\&. + +If the \f3-sourcepath\fR option is not specified, then the user class path is also searched for source files\&. + +If the \f3-processorpath\fR option is not specified, then the class path is also searched for annotation processors\&. +.TP +-Djava\&.ext\&.dirs=\fIdirectories\fR +.br +Overrides the location of installed extensions\&. +.TP +-Djava\&.endorsed\&.dirs=\fIdirectories\fR +.br +Overrides the location of the endorsed standards path\&. +.TP +-d \fIdirectory\fR +.br +Sets the destination directory for class files\&. The directory must already exist because \f3javac\fR does not create it\&. If a class is part of a package, then \f3javac\fR puts the class file in a subdirectory that reflects the package name and creates directories as needed\&. + +If you specify \f3-d\fR\f3/home/myclasses\fR and the class is called \f3com\&.mypackage\&.MyClass\fR, then the class file is \f3/home/myclasses/com/mypackage/MyClass\&.class\fR\&. + +If the \fI-d\fR option is not specified, then \f3javac\fR puts each class file in the same directory as the source file from which it was generated\&. + +\fINote:\fR The directory specified by the \fI-d\fR option is not automatically added to your user class path\&. +.TP +-deprecation +.br +Shows a description of each use or override of a deprecated member or class\&. Without the \f3-deprecation\fR option, \f3javac\fR shows a summary of the source files that use or override deprecated members or classes\&. The \f3-deprecation\fR option is shorthand for \f3-Xlint:deprecation\fR\&. +.TP +-encoding \fIencoding\fR +.br +Sets the source file encoding name, such as EUC-JP and UTF-8\&. If the \f3-encoding\fR option is not specified, then the platform default converter is used\&. +.TP +-endorseddirs \fIdirectories\fR +.br +Overrides the location of the endorsed standards path\&. +.TP +-extdirs \fIdirectories\fR +.br +Overrides the location of the \f3ext\fR directory\&. The directories variable is a colon-separated list of directories\&. Each JAR file in the specified directories is searched for class files\&. All JAR files found become part of the class path\&. + +If you are cross-compiling (compiling classes against bootstrap and extension classes of a different Java platform implementation), then this option specifies the directories that contain the extension classes\&. See Cross-Compilation Options for more information\&. +.TP +-g +.br +Generates all debugging information, including local variables\&. By default, only line number and source file information is generated\&. +.TP +-g:none +.br +Does not generate any debugging information\&. +.TP +-g:[\fIkeyword list\fR] +.br +Generates only some kinds of debugging information, specified by a comma separated list of keywords\&. Valid keywords are: +.RS +.TP +source +Source file debugging information\&. +.TP +lines +Line number debugging information\&. +.TP +vars +Local variable debugging information\&. +.RE + +.TP +-help +.br +Prints a synopsis of standard options\&. +.TP +-implicit:[\fIclass, none\fR] +.br +Controls the generation of class files for implicitly loaded source files\&. To automatically generate class files, use \f3-implicit:class\fR\&. To suppress class file generation, use \f3-implicit:none\fR\&. If this option is not specified, then the default is to automatically generate class files\&. In this case, the compiler issues a warning if any such class files are generated when also doing annotation processing\&. The warning is not issued when the \f3-implicit\fR option is set explicitly\&. See Searching for Types\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. + +\fINote:\fR The \fICLASSPATH\fR, \f3-classpath\fR, \f3-bootclasspath\fR, and \f3-extdirs\fR options do not specify the classes used to run \f3javac\fR\&. Trying to customize the compiler implementation with these options and variables is risky and often does not accomplish what you want\&. If you must customize the complier implementation, then use the \f3-J\fR option to pass options through to the underlying \f3\fRJava launcher\&. +.TP +-nowarn +.br +Disables warning messages\&. This option operates the same as the \f3-Xlint:none\fR option\&. +.TP +-parameters +.br +Stores formal parameter names of constructors and methods in the generated class file so that the method \f3java\&.lang\&.reflect\&.Executable\&.getParameters\fR from the Reflection API can retrieve them\&. +.TP +-proc: [\fInone\fR, \fIonly\fR] +.br +Controls whether annotation processing and compilation are done\&. \f3-proc:none\fR means that compilation takes place without annotation processing\&. \f3-proc:only\fR means that only annotation processing is done, without any subsequent compilation\&. +.TP +-processor \fIclass1\fR [,\fIclass2\fR,\fIclass3\fR\&.\&.\&.] +.br +Names of the annotation processors to run\&. This bypasses the default discovery process\&. +.TP +-processorpath \fIpath\fR +.br +Specifies where to find annotation processors\&. If this option is not used, then the class path is searched for processors\&. +.TP +-s \fIdir\fR +.br +Specifies the directory where to place the generated source files\&. The directory must already exist because \f3javac\fR does not create it\&. If a class is part of a package, then the compiler puts the source file in a subdirectory that reflects the package name and creates directories as needed\&. + +If you specify \f3-s /home/mysrc\fR and the class is called \f3com\&.mypackage\&.MyClass\fR, then the source file is put in \f3/home/mysrc/com/mypackage/MyClass\&.java\fR\&. +.TP +-source \fIrelease\fR +.br +Specifies the version of source code accepted\&. The following values for \f3release\fR are allowed: +.RS +.TP +1\&.3 +The compiler does not support assertions, generics, or other language features introduced after Java SE 1\&.3\&. +.TP +1\&.4 +The compiler accepts code containing assertions, which were introduced in Java SE 1\&.4\&. +.TP +1\&.5 +The compiler accepts code containing generics and other language features introduced in Java SE 5\&. +.TP +5 +Synonym for 1\&.5\&. +.TP +1\&.6 +No language changes were introduced in Java SE 6\&. However, encoding errors in source files are now reported as errors instead of warnings as in earlier releases of Java Platform, Standard Edition\&. +.TP +6 +Synonym for 1\&.6\&. +.TP +1\&.7 +The compiler accepts code with features introduced in Java SE 7\&. +.TP +7 +Synonym for 1\&.7\&. +.TP +1\&.8 +This is the default value\&. The compiler accepts code with features introduced in Java SE 8\&. +.TP +8 +Synonym for 1\&.8\&. +.RE + +.TP +-sourcepath \fIsourcepath\fR +.br +Specifies the source code path to search for class or interface definitions\&. As with the user class path, source path entries are separated by colons (:) on Oracle Solaris and semicolons on Windows and can be directories, JAR archives, or ZIP archives\&. If packages are used, then the local path name within the directory or archive must reflect the package name\&. + +\fINote:\fR Classes found through the class path might be recompiled when their source files are also found\&. See Searching for Types\&. +.TP +-verbose +.br +Uses verbose output, which includes information about each class loaded and each source file compiled\&. +.TP +-version +.br +Prints release information\&. +.TP +-werror +.br +Terminates compilation when warnings occur\&. +.TP +-X +.br +Displays information about nonstandard options and exits\&. +.SS CROSS-COMPILATION\ OPTIONS +By default, classes are compiled against the bootstrap and extension classes of the platform that \f3javac\fR shipped with\&. But \f3javac\fR also supports cross-compiling, where classes are compiled against a bootstrap and extension classes of a different Java platform implementation\&. It is important to use the \f3-bootclasspath\fR and \f3-extdirs\fR options when cross-compiling\&. +.TP +-target \fIversion\fR +.br +Generates class files that target a specified release of the virtual machine\&. Class files will run on the specified target and on later releases, but not on earlier releases of the JVM\&. Valid targets are 1\&.1, 1\&.2, 1\&.3, 1\&.4, 1\&.5 (also 5), 1\&.6 (also 6), 1\&.7 (also 7), and 1\&.8 (also 8)\&. + +The default for the \f3-target\fR option depends on the value of the \f3-source\fR option: +.RS +.TP 0.2i +\(bu +If the \f3-source\fR option is not specified, then the value of the \f3-target\fR option is 1\&.8 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.2, then the value of the \f3-target\fR option is 1\&.4 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.3, then the value of the \f3-target\fR option is 1\&.4 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.5, then the value of the \f3-target\fR option is 1\&.8 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.6, then the value of the \f3-target\fR is option 1\&.8 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.7, then the value of the \f3-target\fR is option 1\&.8 +.TP 0.2i +\(bu +For all other values of the \f3-source\fR option, the value of the \f3-target\fR option is the value of the \f3-source\fR option\&. +.RE + +.TP +-bootclasspath \fIbootclasspath\fR +.br +Cross-compiles against the specified set of boot classes\&. As with the user class path, boot class path entries are separated by colons (:) and can be directories, JAR archives, or ZIP archives\&. +.SS COMPACT\ PROFILE\ OPTION +Beginning with JDK 8, the \f3javac\fR compiler supports compact profiles\&. With compact profiles, applications that do not require the entire Java platform can be deployed and run with a smaller footprint\&. The compact profiles feature could be used to shorten the download time for applications from app stores\&. This feature makes for more compact deployment of Java applications that bundle the JRE\&. This feature is also useful in small devices\&. +.PP +The supported profile values are \f3compact1\fR, \f3compact2\fR, and \f3compact3\fR\&. These are additive layers\&. Each higher-numbered compact profile contains all of the APIs in profiles with smaller number names\&. +.TP +-profile +.br +When using compact profiles, this option specifies the profile name when compiling\&. For example: +.sp +.nf +\f3javac \-profile compact1 Hello\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp + + +javac does not compile source code that uses any Java SE APIs that is not in the specified profile\&. Here is an example of the error message that results from attempting to compile such source code: +.sp +.nf +\f3cd jdk1\&.8\&.0/bin\fP +.fi +.nf +\f3\&./javac \-profile compact1 Paint\&.java\fP +.fi +.nf +\f3Paint\&.java:5: error: Applet is not available in profile \&'compact1\&'\fP +.fi +.nf +\f3import java\&.applet\&.Applet;\fP +.fi +.nf +\f3\fP +.fi +.sp + + +In this example, you can correct the error by modifying the source to not use the \f3Applet\fR class\&. You could also correct the error by compiling without the -profile option\&. Then the compilation would be run against the full set of Java SE APIs\&. (None of the compact profiles include the \f3Applet\fR class\&.) + +An alternative way to compile with compact profiles is to use the \f3-bootclasspath\fR option to specify a path to an \f3rt\&.jar\fR file that specifies a profile\&'s image\&. Using the \f3-profile\fR option instead does not require a profile image to be present on the system at compile time\&. This is useful when cross-compiling\&. +.SS NONSTANDARD\ OPTIONS +.TP +-Xbootclasspath/p:\fIpath\fR +.br +Adds a suffix to the bootstrap class path\&. +.TP +-Xbootclasspath/a:\fIpath\fR +.br +Adds a prefix to the bootstrap class path\&. +.TP +-Xbootclasspath/:\fIpath\fR +.br +Overrides the location of the bootstrap class files\&. +.TP +-Xdoclint:[-]\fIgroup\fR [\fI/access\fR] +.br +Enables or disables specific groups of checks, where \fIgroup\fR is one of the following values: \f3accessibility\fR, \f3syntax\fR, \f3reference\fR, \f3html\fR or \f3missing\fR\&. For more information about these groups of checks see the \f3-Xdoclint\fR option of the \f3javadoc\fR command\&. The \f3-Xdoclint\fR option is disabled by default in the \f3javac\fR command\&. + +The variable \fIaccess\fR specifies the minimum visibility level of classes and members that the \f3-Xdoclint\fR option checks\&. It can have one of the following values (in order of most to least visible) : \f3public\fR, \f3protected\fR, \f3package\fR and \f3private\fR\&. For example, the following option checks classes and members (with all groups of checks) that have the access level protected and higher (which includes protected, package and public): +.sp +.nf +\f3\-Xdoclint:all/protected\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following option enables all groups of checks for all access levels, except it will not check for HTML errors for classes and members that have access level package and higher (which includes package and public): +.sp +.nf +\f3\-Xdoclint:all,\-html/package\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-Xdoclint:none +.br +Disables all groups of checks\&. +.TP +-Xdoclint:all[\fI/access\fR] +.br +Enables all groups of checks\&. +.TP +-Xlint +.br +\fI\fREnables all recommended warnings\&. In this release, enabling all available warnings is recommended\&. +.TP +-Xlint:all +.br +\fI\fREnables all recommended warnings\&. In this release, enabling all available warnings is recommended\&. +.TP +-Xlint:none +.br +Disables all warnings\&. +.TP +-Xlint:\fIname\fR +.br +Disables warning name\&. See Enable or Disable Warnings with the -Xlint Option for a list of warnings you can disable with this option\&. +.TP +-Xlint:\fI-name\fR +.br +Disables warning name\&. See Enable or Disable Warnings with the -Xlint Option with the \f3-Xlint\fR option to get a list of warnings that you can disable with this option\&. +.TP +-Xmaxerrs \fInumber\fR +.br +Sets the maximum number of errors to print\&. +.TP +-Xmaxwarns \fInumber\fR +.br +Sets the maximum number of warnings to print\&. +.TP +-Xstdout \fIfilename\fR +.br +Sends compiler messages to the named file\&. By default, compiler messages go to \f3System\&.err\fR\&. +.TP +-Xprefer:[\fInewer,source\fR] +.br +Specifies which file to read when both a source file and class file are found for a type\&. (See Searching for Types)\&. If the \f3-Xprefer:newer\fR option is used, then it reads the newer of the source or class file for a type (default)\&. If the \f3-Xprefer:source\fR option is used, then it reads the source file\&. Use -\f3Xprefer:source\fR when you want to be sure that any annotation processors can access annotations declared with a retention policy of \f3SOURCE\fR\&. +.TP +-Xpkginfo:[\fIalways\fR,\fIlegacy\fR,\fInonempty\fR] +.br +Control whether javac generates \f3package-info\&.class\fR files from package-info\&.java files\&. Possible mode arguments for this option include the following\&. +.RS +.TP +always +Always generate a \f3package-info\&.class\fR file for every \f3package-info\&.java\fR file\&. This option may be useful if you use a build system such as Ant, which checks that each \f3\&.java\fR file has a corresponding \f3\&.class\fR file\&. +.TP +legacy +Generate a \f3package-info\&.class\fR file only if package-info\&.java contains annotations\&. Don\&'t generate a \f3package-info\&.class\fR file if package-info\&.java only contains comments\&. + +\fINote:\fR A \f3package-info\&.class\fR file might be generated but be empty if all the annotations in the package-info\&.java file have \f3RetentionPolicy\&.SOURCE\fR\&. +.TP +nonempty +Generate a \f3package-info\&.class\fR file only if package-info\&.java contains annotations with \f3RetentionPolicy\&.CLASS\fR or \f3RetentionPolicy\&.RUNTIME\fR\&. +.RE + +.TP +-Xprint +.br +Prints a textual representation of specified types for debugging purposes\&. Perform neither annotation processing nor compilation\&. The format of the output could change\&. +.TP +-XprintProcessorInfo +.br +Prints information about which annotations a processor is asked to process\&. +.TP +-XprintRounds +.br +Prints information about initial and subsequent annotation processing rounds\&. +.SH ENABLE\ OR\ DISABLE\ WARNINGS\ WITH\ THE\ -XLINT\ OPTION +Enable warning \fIname\fR with the \f3-Xlint:name\fR option, where \f3name\fR is one of the following warning names\&. Note that you can disable a warning with the \f3-Xlint:-name:\fR option\&. +.TP +cast +Warns about unnecessary and redundant casts, for example: +.sp +.nf +\f3String s = (String) "Hello!"\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +classfile +Warns about issues related to class file contents\&. +.TP +deprecation +Warns about the use of deprecated items, for example: +.sp +.nf +\f3java\&.util\&.Date myDate = new java\&.util\&.Date();\fP +.fi +.nf +\f3int currentDay = myDate\&.getDay();\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The method \f3java\&.util\&.Date\&.getDay\fR has been deprecated since JDK 1\&.1 +.TP +dep-ann +Warns about items that are documented with an \f3@deprecated\fR Javadoc comment, but do not have a \f3@Deprecated\fR annotation, for example: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @deprecated As of Java SE 7, replaced by {@link #newMethod()}\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public static void deprecatedMethood() { }\fP +.fi +.nf +\f3public static void newMethod() { }\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +divzero +Warns about division by the constant integer 0, for example: +.sp +.nf +\f3int divideByZero = 42 / 0;\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +empty +Warns about empty statements after \f3if\fRstatements, for example: +.sp +.nf +\f3class E {\fP +.fi +.nf +\f3 void m() {\fP +.fi +.nf +\f3 if (true) ;\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +fallthrough +Checks the switch blocks for fall-through cases and provides a warning message for any that are found\&. Fall-through cases are cases in a switch block, other than the last case in the block, whose code does not include a break statement, allowing code execution to fall through from that case to the next case\&. For example, the code following the case 1 label in this switch block does not end with a break statement: +.sp +.nf +\f3switch (x) {\fP +.fi +.nf +\f3case 1:\fP +.fi +.nf +\f3 System\&.out\&.println("1");\fP +.fi +.nf +\f3 // No break statement here\&.\fP +.fi +.nf +\f3case 2:\fP +.fi +.nf +\f3 System\&.out\&.println("2");\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If the \f3-Xlint:fallthrough\fR option was used when compiling this code, then the compiler emits a warning about possible fall-through into case, with the line number of the case in question\&. +.TP +finally +Warns about \f3finally\fR clauses that cannot complete normally, for example: +.sp +.nf +\f3public static int m() {\fP +.fi +.nf +\f3 try {\fP +.fi +.nf +\f3 throw new NullPointerException();\fP +.fi +.nf +\f3 } catch (NullPointerException(); {\fP +.fi +.nf +\f3 System\&.err\&.println("Caught NullPointerException\&.");\fP +.fi +.nf +\f3 return 1;\fP +.fi +.nf +\f3 } finally {\fP +.fi +.nf +\f3 return 0;\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The compiler generates a warning for the \f3finally\fR block in this example\&. When the \f3int\fR method is called, it returns a value of 0\&. A \f3finally\fR block executes when the \f3try\fR block exits\&. In this example, when control is transferred to the \f3catch\fR block, the \f3int\fR method exits\&. However, the \f3finally\fR block must execute, so it is executed, even though control was transferred outside the method\&. +.TP +options +Warns about issues that related to the use of command-line options\&. See Cross-Compilation Options\&. +.TP +overrides +Warns about issues regarding method overrides\&. For example, consider the following two classes: +.sp +.nf +\f3public class ClassWithVarargsMethod {\fP +.fi +.nf +\f3 void varargsMethod(String\&.\&.\&. s) { }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class ClassWithOverridingMethod extends ClassWithVarargsMethod {\fP +.fi +.nf +\f3 @Override\fP +.fi +.nf +\f3 void varargsMethod(String[] s) { }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The compiler generates a warning similar to the following:\&. +.sp +.nf +\f3warning: [override] varargsMethod(String[]) in ClassWithOverridingMethod \fP +.fi +.nf +\f3overrides varargsMethod(String\&.\&.\&.) in ClassWithVarargsMethod; overriding\fP +.fi +.nf +\f3method is missing \&'\&.\&.\&.\&'\fP +.fi +.nf +\f3\fP +.fi +.sp + + +When the compiler encounters a \f3varargs\fR method, it translates the \f3varargs\fR formal parameter into an array\&. In the method \f3ClassWithVarargsMethod\&.varargsMethod\fR, the compiler translates the \f3varargs\fR formal parameter \f3String\&.\&.\&. s\fR to the formal parameter \f3String[] s\fR, an array, which matches the formal parameter of the method \f3ClassWithOverridingMethod\&.varargsMethod\fR\&. Consequently, this example compiles\&. +.TP +path +Warns about invalid path elements and nonexistent path directories on the command line (with regard to the class path, the source path, and other paths)\&. Such warnings cannot be suppressed with the \f3@SuppressWarnings\fR annotation, for example: +.sp +.nf +\f3javac \-Xlint:path \-classpath /nonexistentpath Example\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +processing +Warn about issues regarding annotation processing\&. The compiler generates this warning when you have a class that has an annotation, and you use an annotation processor that cannot handle that type of exception\&. For example, the following is a simple annotation processor: + +\fISource file AnnocProc\&.java\fR: +.sp +.nf +\f3import java\&.util\&.*;\fP +.fi +.nf +\f3import javax\&.annotation\&.processing\&.*;\fP +.fi +.nf +\f3import javax\&.lang\&.model\&.*;\fP +.fi +.nf +\f3import\&.javaz\&.lang\&.model\&.element\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3@SupportedAnnotationTypes("NotAnno")\fP +.fi +.nf +\f3public class AnnoProc extends AbstractProcessor {\fP +.fi +.nf +\f3 public boolean process(Set<? extends TypeElement> elems, RoundEnvironment renv){\fP +.fi +.nf +\f3 return true;\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public SourceVersion getSupportedSourceVersion() {\fP +.fi +.nf +\f3 return SourceVersion\&.latest();\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fISource file AnnosWithoutProcessors\&.java\fR: +.sp +.nf +\f3@interface Anno { }\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3@Anno\fP +.fi +.nf +\f3class AnnosWithoutProcessors { }\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following commands compile the annotation processor \f3AnnoProc\fR, then run this annotation processor against the source file \f3AnnosWithoutProcessors\&.java\fR: +.sp +.nf +\f3javac AnnoProc\&.java\fP +.fi +.nf +\f3javac \-cp \&. \-Xlint:processing \-processor AnnoProc \-proc:only AnnosWithoutProcessors\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp + + +When the compiler runs the annotation processor against the source file \f3AnnosWithoutProcessors\&.java\fR, it generates the following warning: +.sp +.nf +\f3warning: [processing] No processor claimed any of these annotations: Anno\fP +.fi +.nf +\f3\fP +.fi +.sp + + +To resolve this issue, you can rename the annotation defined and used in the class \f3AnnosWithoutProcessors\fR from \f3Anno\fR to \f3NotAnno\fR\&. +.TP +rawtypes +Warns about unchecked operations on raw types\&. The following statement generates a \f3rawtypes\fR warning: +.sp +.nf +\f3void countElements(List l) { \&.\&.\&. }\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following example does not generate a \f3rawtypes\fR warning +.sp +.nf +\f3void countElements(List<?> l) { \&.\&.\&. }\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\f3List\fR is a raw type\&. However, \f3List<?>\fR is an unbounded wildcard parameterized type\&. Because \f3List\fR is a parameterized interface, always specify its type argument\&. In this example, the \f3List\fR formal argument is specified with an unbounded wildcard (\f3?\fR) as its formal type parameter, which means that the \f3countElements\fR method can accept any instantiation of the \f3List\fR interface\&. +.TP +Serial +Warns about missing \f3serialVersionUID\fR definitions on serializable classes, for example: +.sp +.nf +\f3public class PersistentTime implements Serializable\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3 private Date time;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public PersistentTime() {\fP +.fi +.nf +\f3 time = Calendar\&.getInstance()\&.getTime();\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public Date getTime() {\fP +.fi +.nf +\f3 return time;\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The compiler generates the following warning: +.sp +.nf +\f3warning: [serial] serializable class PersistentTime has no definition of\fP +.fi +.nf +\f3serialVersionUID\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If a serializable class does not explicitly declare a field named \f3serialVersionUID\fR, then the serialization runtime environment calculates a default \f3serialVersionUID\fR value for that class based on various aspects of the class, as described in the Java Object Serialization Specification\&. However, it is strongly recommended that all serializable classes explicitly declare \f3serialVersionUID\fR values because the default process of computing \f3serialVersionUID\fR vales is highly sensitive to class details that can vary depending on compiler implementations, and as a result, might cause an unexpected \f3InvalidClassExceptions\fR during deserialization\&. To guarantee a consistent \f3serialVersionUID\fR value across different Java compiler implementations, a serializable class must declare an explicit \f3serialVersionUID\fR value\&. +.TP +static +Warns about issues relating to the use of statics, for example: +.sp +.nf +\f3class XLintStatic {\fP +.fi +.nf +\f3 static void m1() { }\fP +.fi +.nf +\f3 void m2() { this\&.m1(); }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The compiler generates the following warning: +.sp +.nf +\f3warning: [static] static method should be qualified by type name, \fP +.fi +.nf +\f3XLintStatic, instead of by an expression\fP +.fi +.nf +\f3\fP +.fi +.sp + + +To resolve this issue, you can call the \f3static\fR method \f3m1\fR as follows: +.sp +.nf +\f3XLintStatic\&.m1();\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Alternately, you can remove the \f3static\fR keyword from the declaration of the method \f3m1\fR\&. +.TP +try +Warns about issues relating to use of \f3try\fR blocks, including try-with-resources statements\&. For example, a warning is generated for the following statement because the resource \f3ac\fR declared in the \f3try\fR block is not used: +.sp +.nf +\f3try ( AutoCloseable ac = getResource() ) { // do nothing}\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +unchecked +Gives more detail for unchecked conversion warnings that are mandated by the Java Language Specification, for example: +.sp +.nf +\f3List l = new ArrayList<Number>();\fP +.fi +.nf +\f3List<String> ls = l; // unchecked warning\fP +.fi +.nf +\f3\fP +.fi +.sp + + +During type erasure, the types \f3ArrayList<Number>\fR and \f3List<String>\fR become \f3ArrayList\fR and \f3List\fR, respectively\&. + +The \f3ls\fR command has the parameterized type \f3List<String>\fR\&. When the \f3List\fR referenced by \f3l\fR is assigned to \f3ls\fR, the compiler generates an unchecked warning\&. At compile time, the compiler and JVM cannot determine whether \f3l\fR refers to a \f3List<String>\fR type\&. In this case, \f3l\fR does not refer to a \f3List<String>\fR type\&. As a result, heap pollution occurs\&. + +A heap pollution situation occurs when the \f3List\fR object \f3l\fR, whose static type is \f3List<Number>\fR, is assigned to another \f3List\fR object, \f3ls\fR, that has a different static type, \f3List<String>\fR\&. However, the compiler still allows this assignment\&. It must allow this assignment to preserve backward compatibility with releases of Java SE that do not support generics\&. Because of type erasure, \f3List<Number>\fR and \f3List<String>\fR both become \f3List\fR\&. Consequently, the compiler allows the assignment of the object \f3l\fR\f3,\fR which has a raw type of \f3List\fR, to the object \f3ls\fR\&. +.TP +varargs +Warns about unsafe usages of variable arguments (\f3varargs\fR) methods, in particular, those that contain non-reifiable arguments, for example: +.sp +.nf +\f3public class ArrayBuilder {\fP +.fi +.nf +\f3 public static <T> void addToList (List<T> listArg, T\&.\&.\&. elements) {\fP +.fi +.nf +\f3 for (T x : elements) {\fP +.fi +.nf +\f3 listArg\&.add(x);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fINote:\fR A non-reifiable type is a type whose type information is not fully available at runtime\&. + +The compiler generates the following warning for the definition of the method \f3ArrayBuilder\&.addToList\fR +.sp +.nf +\f3warning: [varargs] Possible heap pollution from parameterized vararg type T\fP +.fi +.nf +\f3\fP +.fi +.sp + + +When the compiler encounters a varargs method, it translates the \f3varargs\fR formal parameter into an array\&. However, the Java programming language does not permit the creation of arrays of parameterized types\&. In the method \f3ArrayBuilder\&.addToList\fR, the compiler translates the \f3varargs\fR formal parameter \f3T\&.\&.\&.\fR elements to the formal parameter \f3T[]\fR elements, an array\&. However, because of type erasure, the compiler converts the \f3varargs\fR formal parameter to \f3Object[]\fR elements\&. Consequently, there is a possibility of heap pollution\&. +.SH COMMAND-LINE\ ARGUMENT\ FILES +To shorten or simplify the \f3javac\fR command, you can specify one or more files that contain arguments to the \f3javac\fR command (except \f3-J\fR options)\&. This enables you to create \f3javac\fR commands of any length on any operating system\&. +.PP +An argument file can include \f3javac\fR options and source file names in any combination\&. The arguments within a file can be separated by spaces or new line characters\&. If a file name contains embedded spaces, then put the whole file name in double quotation marks\&. +.PP +File Names within an argument file are relative to the current directory, not the location of the argument file\&. Wild cards (*) are not allowed in these lists (such as for specifying \f3*\&.java\fR)\&. Use of the at sign (@) to recursively interpret files is not supported\&. The \f3-J\fR options are not supported because they are passed to the launcher, which does not support argument files\&. +.PP +When executing the \f3javac\fR command, pass in the path and name of each argument file with the at sign (@) leading character\&. When the \f3javac\fR command encounters an argument beginning with the at sign (@), it expands the contents of that file into the argument list\&. +.PP +\f3Example 1 Single Argument File\fR +.PP +You could use a single argument file named \f3argfile\fR to hold all \f3javac\fR arguments: +.sp +.nf +\f3javac @argfile\fP +.fi +.nf +\f3\fP +.fi +.sp +This argument file could contain the contents of both files shown in Example 2 +.PP +\f3Example 2 Two Argument Files\fR +.PP +You can create two argument files: one for the \f3javac\fR options and the other for the source file names\&. Note that the following lists have no line-continuation characters\&. +.PP +Create a file named options that contains the following: +.sp +.nf +\f3\-d classes\fP +.fi +.nf +\f3\-g\fP +.fi +.nf +\f3\-sourcepath /java/pubs/ws/1\&.3/src/share/classes\fP +.fi +.nf +\f3\fP +.fi +.sp +Create a file named classes that contains the following: +.sp +.nf +\f3MyClass1\&.java\fP +.fi +.nf +\f3MyClass2\&.java\fP +.fi +.nf +\f3MyClass3\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +Then, run the \f3javac\fR command as follows: +.sp +.nf +\f3javac @options @classes\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 3 Argument Files with Paths\fR +.PP +The argument files can have paths, but any file names inside the files are relative to the current working directory (not \f3path1\fR or \f3path2\fR): +.sp +.nf +\f3javac @path1/options @path2/classes\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH ANNOTATION\ PROCESSING +The \f3javac\fR command provides direct support for annotation processing, superseding the need for the separate annotation processing command, \f3apt\fR\&. +.PP +The API for annotation processors is defined in the \f3javax\&.annotation\&.processing\fR and j\f3avax\&.lang\&.model\fR packages and subpackages\&. +.SS HOW\ ANNOTATION\ PROCESSING\ WORKS +Unless annotation processing is disabled with the \f3-proc:none\fR option, the compiler searches for any annotation processors that are available\&. The search path can be specified with the \f3-processorpath\fR option\&. If no path is specified, then the user class path is used\&. Processors are located by means of service provider-configuration files named \f3META-INF/services/javax\&.annotation\&.processing\fR\&.Processor on the search path\&. Such files should contain the names of any annotation processors to be used, listed one per line\&. Alternatively, processors can be specified explicitly, using the \f3-processor\fR option\&. +.PP +After scanning the source files and classes on the command line to determine what annotations are present, the compiler queries the processors to determine what annotations they process\&. When a match is found, the processor is called\&. A processor can claim the annotations it processes, in which case no further attempt is made to find any processors for those annotations\&. After all of the annotations are claimed, the compiler does not search for additional processors\&. +.PP +If any processors generate new source files, then another round of annotation processing occurs: Any newly generated source files are scanned, and the annotations processed as before\&. Any processors called on previous rounds are also called on all subsequent rounds\&. This continues until no new source files are generated\&. +.PP +After a round occurs where no new source files are generated, the annotation processors are called one last time, to give them a chance to complete any remaining work\&. Finally, unless the \f3-proc:only\fR option is used, the compiler compiles the original and all generated source files\&. +.SS IMPLICITLY\ LOADED\ SOURCE\ FILES +To compile a set of source files, the compiler might need to implicitly load additional source files\&. See Searching for Types\&. Such files are currently not subject to annotation processing\&. By default, the compiler gives a warning when annotation processing occurred and any implicitly loaded source files are compiled\&. The \f3-implicit\fR option provides a way to suppress the warning\&. +.SH SEARCHING\ FOR\ TYPES +To compile a source file, the compiler often needs information about a type, but the type definition is not in the source files specified on the command line\&. The compiler needs type information for every class or interface used, extended, or implemented in the source file\&. This includes classes and interfaces not explicitly mentioned in the source file, but that provide information through inheritance\&. +.PP +For example, when you create a subclass \f3java\&.applet\&.Applet\fR, you are also using the ancestor classes of \f3Applet\fR: \f3java\&.awt\&.Panel\fR, \f3java\&.awt\&.Container\fR, \f3java\&.awt\&.Component\fR, and \f3java\&.lang\&.Object\fR\&. +.PP +When the compiler needs type information, it searches for a source file or class file that defines the type\&. The compiler searches for class files first in the bootstrap and extension classes, then in the user class path (which by default is the current directory)\&. The user class path is defined by setting the \f3CLASSPATH\fR environment variable or by using the \f3-classpath\fR option\&. +.PP +If you set the \f3-sourcepath\fR option, then the compiler searches the indicated path for source files\&. Otherwise, the compiler searches the user class path for both class files and source files\&. +.PP +You can specify different bootstrap or extension classes with the \f3-bootclasspath\fR and the \f3-extdirs\fR options\&. See Cross-Compilation Options\&. +.PP +A successful type search may produce a class file, a source file, or both\&. If both are found, then you can use the \f3-Xprefer\fR option to instruct the compiler which to use\&. If \f3newer\fR is specified, then the compiler uses the newer of the two files\&. If \f3source\fR is specified, the compiler uses the source file\&. The default is \f3newer\fR\&. +.PP +If a type search finds a source file for a required type, either by itself, or as a result of the setting for the \f3-Xprefer\fR option, then the compiler reads the source file to get the information it needs\&. By default the compiler also compiles the source file\&. You can use the \f3-implicit\fR option to specify the behavior\&. If \f3none\fR is specified, then no class files are generated for the source file\&. If \f3class\fR is specified, then class files are generated for the source file\&. +.PP +The compiler might not discover the need for some type information until after annotation processing completes\&. When the type information is found in a source file and no \f3-implicit\fR option is specified, the compiler gives a warning that the file is being compiled without being subject to annotation processing\&. To disable the warning, either specify the file on the command line (so that it will be subject to annotation processing) or use the \f3-implicit\fR option to specify whether or not class files should be generated for such source files\&. +.SH PROGRAMMATIC\ INTERFACE +The \f3javac\fR command supports the new Java Compiler API defined by the classes and interfaces in the \f3javax\&.tools\fR package\&. +.SS EXAMPLE +To compile as though providing command-line arguments, use the following syntax: +.sp +.nf +\f3JavaCompiler javac = ToolProvider\&.getSystemJavaCompiler();\fP +.fi +.nf +\f3\fP +.fi +.sp +The example writes diagnostics to the standard output stream and returns the exit code that \f3javac\fR would give when called from the command line\&. +.PP +You can use other methods in the \f3javax\&.tools\&.JavaCompiler\fR interface to handle diagnostics, control where files are read from and written to, and more\&. +.SS OLD\ INTERFACE +\fINote:\fR This API is retained for backward compatibility only\&. All new code should use the newer Java Compiler API\&. +.PP +The \f3com\&.sun\&.tools\&.javac\&.Main\fR class provides two static methods to call the compiler from a program: +.sp +.nf +\f3public static int compile(String[] args);\fP +.fi +.nf +\f3public static int compile(String[] args, PrintWriter out);\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3args\fR parameter represents any of the command-line arguments that would typically be passed to the compiler\&. +.PP +The \f3out\fR parameter indicates where the compiler diagnostic output is directed\&. +.PP +The \f3return\fR value is equivalent to the \f3exit\fR value from \f3javac\fR\&. +.PP +\fINote:\fR All other classes and methods found in a package with names that start with \f3com\&.sun\&.tools\&.javac\fR (subpackages of \f3com\&.sun\&.tools\&.javac\fR) are strictly internal and subject to change at any time\&. +.SH EXAMPLES +\f3Example 1 Compile a Simple Program\fR +.PP +This example shows how to compile the \f3Hello\&.java\fR source file in the greetings directory\&. The class defined in \f3Hello\&.java\fR is called \f3greetings\&.Hello\fR\&. The greetings directory is the package directory both for the source file and the class file and is underneath the current directory\&. This makes it possible to use the default user class path\&. It also makes it unnecessary to specify a separate destination directory with the \f3-d\fR option\&. +.PP +The source code in \f3Hello\&.java\fR: +.sp +.nf +\f3package greetings;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class Hello {\fP +.fi +.nf +\f3 public static void main(String[] args) {\fP +.fi +.nf +\f3 for (int i=0; i < args\&.length; i++) {\fP +.fi +.nf +\f3 System\&.out\&.println("Hello " + args[i]);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +Compile greetings\&.Hello: +.sp +.nf +\f3javac greetings/Hello\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +Run \f3greetings\&.Hello\fR: +.sp +.nf +\f3java greetings\&.Hello World Universe Everyone\fP +.fi +.nf +\f3Hello World\fP +.fi +.nf +\f3Hello Universe\fP +.fi +.nf +\f3Hello Everyone\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 2 Compile Multiple Source Files\fR +.PP +This example compiles the \f3Aloha\&.java\fR, \f3GutenTag\&.java\fR, \f3Hello\&.java\fR, and \f3Hi\&.java\fR source files in the \f3greetings\fR package\&. +.sp +.nf +\f3% javac greetings/*\&.java\fP +.fi +.nf +\f3% ls greetings\fP +.fi +.nf +\f3Aloha\&.class GutenTag\&.class Hello\&.class Hi\&.class\fP +.fi +.nf +\f3Aloha\&.java GutenTag\&.java Hello\&.java Hi\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 3 Specify a User Class Path\fR +.PP +After changing one of the source files in the previous example, recompile it: +.sp +.nf +\f3pwd\fP +.fi +.nf +\f3/examples\fP +.fi +.nf +\f3javac greetings/Hi\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +Because \f3greetings\&.Hi\fR refers to other classes in the \f3greetings\fR package, the compiler needs to find these other classes\&. The previous example works because the default user class path is the directory that contains the package directory\&. If you want to recompile this file without concern for which directory you are in, then add the examples directory to the user class path by setting \f3CLASSPATH\fR\&. This example uses the \f3-classpath\fR option\&. +.sp +.nf +\f3javac \-classpath /examples /examples/greetings/Hi\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +If you change \f3greetings\&.Hi\fR to use a banner utility, then that utility also needs to be accessible through the user class path\&. +.sp +.nf +\f3javac \-classpath /examples:/lib/Banners\&.jar \e\fP +.fi +.nf +\f3 /examples/greetings/Hi\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +To execute a class in the \f3greetings\fR package, the program needs access to the \f3greetings\fR package, and to the classes that the \f3greetings\fR classes use\&. +.sp +.nf +\f3java \-classpath /examples:/lib/Banners\&.jar greetings\&.Hi\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 4 Separate Source Files and Class Files\fR +.PP +The following example uses \f3javac\fR to compile code that runs on JVM 1\&.7\&. +.sp +.nf +\f3javac \-source 1\&.7 \-target 1\&.7 \-bootclasspath jdk1\&.7\&.0/lib/rt\&.jar \e \fP +.fi +.nf +\f3\-extdirs "" OldCode\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3-source 1\&.7\fR option specifies that release 1\&.7 (or 7) of the Java programming language be used to compile \f3OldCode\&.java\fR\&. The option \f3-target 1\&.7\fR option ensures that the generated class files are compatible with JVM 1\&.7\&. Note that in most cases, the value of the \f3-target\fR option is the value of the \f3-source\fR option; in this example, you can omit the \f3-target\fR option\&. +.PP +You must specify the \f3-bootclasspath\fR option to specify the correct version of the bootstrap classes (the \f3rt\&.jar\fR library)\&. If not, then the compiler generates a warning: +.sp +.nf +\f3javac \-source 1\&.7 OldCode\&.java\fP +.fi +.nf +\f3warning: [options] bootstrap class path not set in conjunction with \fP +.fi +.nf +\f3\-source 1\&.7\fP +.fi +.nf +\f3\fP +.fi +.sp +If you do not specify the correct version of bootstrap classes, then the compiler uses the old language rules (in this example, it uses version 1\&.7 of the Java programming language) combined with the new bootstrap classes, which can result in class files that do not work on the older platform (in this case, Java SE 7) because reference to nonexistent methods can get included\&. +.PP +\f3Example 5 Cross Compile\fR +.PP +This example uses \f3javac\fR to compile code that runs on JVM 1\&.7\&. +.sp +.nf +\f3javac \-source 1\&.7 \-target 1\&.7 \-bootclasspath jdk1\&.7\&.0/lib/rt\&.jar \e\fP +.fi +.nf +\f3 \-extdirs "" OldCode\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +The\f3-source 1\&.7\fR option specifies that release 1\&.7 (or 7) of the Java programming language to be used to compile OldCode\&.java\&. The \f3-target 1\&.7\fR option ensures that the generated class files are compatible with JVM 1\&.7\&. +.PP +You must specify the \f3-bootclasspath\fR option to specify the correct version of the bootstrap classes (the \f3rt\&.jar\fR library)\&. If not, then the compiler generates a warning: +.sp +.nf +\f3javac \-source 1\&.7 OldCode\&.java\fP +.fi +.nf +\f3warning: [options] bootstrap class path not set in conjunction with \-source 1\&.7\fP +.fi +.nf +\f3\fP +.fi +.sp +If you do not specify the correct version of bootstrap classes, then the compiler uses the old language rules combined with the new bootstrap classes\&. This combination can result in class files that do not work on the older platform (in this case, Java SE 7) because reference to nonexistent methods can get included\&. In this example, the compiler uses release 1\&.7 of the Java programming language\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jdb(1) +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +javadoc(1) +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +jdb(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/javadoc.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/javadoc.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,3004 +1,3004 @@ -'\" t -.\" Copyright (c) 1994, 2015, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 03 March 2015 -.\" SectDesc: Basic Tools -.\" Title: javadoc.1 -.\" -.if n .pl 99999 -.TH javadoc 1 "03 March 2015" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -javadoc \- Generates HTML pages of API documentation from Java source files\&. -.SH SYNOPSIS -.sp -.nf - -\fBjavadoc\fR {\fIpackages\fR|\fIsource\-files\fR} [\fIoptions\fR] [\fI@argfiles\fR] -.fi -.sp -.TP -\fIpackages\fR -Names of packages that you want to document, separated by spaces, for example \f3java\&.lang java\&.lang\&.reflect java\&.awt\fR\&. If you want to also document the subpackages, use the \f3-subpackages\fR option to specify the packages\&. - -By default, \f3javadoc\fR looks for the specified packages in the current directory and subdirectories\&. Use the \f3-sourcepath\fR option to specify the list of directories where to look for packages\&. -.TP -\fIsource-files\fR -Names of Java source files that you want to document, separated by spaces, for example \f3Class\&.java Object\&.java Button\&.java\fR\&. By default, \f3javadoc\fR looks for the specified classes in the current directory\&. However, you can specify the full path to the class file and use wildcard characters, for example \f3/home/src/java/awt/Graphics*\&.java\fR\&. You can also specify the path relative to the current directory\&. -.TP -\fIoptions\fR -Command-line options, separated by spaces\&. See Options\&. -.TP -\fI@argfiles\fR -Names of files that contain a list of \f3javadoc\fR command options, package names and source file names in any order\&. -.SH DESCRIPTION -The \f3javadoc\fR command parses the declarations and documentation comments in a set of Java source files and produces a corresponding set of HTML pages that describe (by default) the public and protected classes, nested classes (but not anonymous inner classes), interfaces, constructors, methods, and fields\&. You can use the \f3javadoc\fR command to generate the API documentation or the implementation documentation for a set of source files\&. -.PP -You can run the \f3javadoc\fR command on entire packages, individual source files, or both\&. When documenting entire packages, you can either use the \f3-subpackages\fR option to recursively traverse a directory and its subdirectories, or to pass in an explicit list of package names\&. When you document individual source files, pass in a list of Java source file names\&. See Simple Examples\&. -.SS PROCESS\ SOURCE\ FILES -The \f3javadoc\fR command processes files that end in source and other files described in Source Files\&. If you run the \f3javadoc\fR command by passing in individual source file names, then you can determine exactly which source files are processed\&. However, that is not how most developers want to work, because it is simpler to pass in package names\&. The \f3javadoc\fR command can be run three ways without explicitly specifying the source file names\&. You can pass in package names, use the \f3-subpackages\fR option, or use wild cards with source file names\&. In these cases, the \f3javadoc\fR command processes a source file only when the file fulfills all of the following requirements: -.TP 0.2i -\(bu -The file name prefix (with \f3\&.java\fR removed) is a valid class name\&. -.TP 0.2i -\(bu -The path name relative to the root of the source tree is a valid package name after the separators are converted to dots\&. -.TP 0.2i -\(bu -The package statement contains the valid package name\&. -.PP -Processing Links - -During a run, the \f3javadoc\fR command adds cross-reference links to package, class, and member names that are being documented as part of that run\&. Links appear in the following places\&. See Javadoc Tags for a description of the @ tags\&. -.TP 0.2i -\(bu -Declarations (return types, argument types, and field types)\&. -.TP 0.2i -\(bu -\fISee Also\fR sections that are generated from \f3@see\fR tags\&. -.TP 0.2i -\(bu -Inline text generated from \f3{@link}\fR tags\&. -.TP 0.2i -\(bu -Exception names generated from \f3@throws\fR tags\&. -.TP 0.2i -\(bu -\fISpecified by\fR links to interface members and \fIOverrides\fR links to class members\&. See Method Comment Inheritance\&. -.TP 0.2i -\(bu -Summary tables listing packages, classes and members\&. -.TP 0.2i -\(bu -Package and class inheritance trees\&. -.TP 0.2i -\(bu -The index\&. -.PP -You can add links to existing text for classes not included on the command line (but generated separately) by way of the \f3-link\fR and \f3-linkoffline\fR options\&. -.PP -Processing Details - -The \f3javadoc\fR command produces one complete document every time it runs\&. It does not do incremental builds that modify or directly incorporate the results from earlier runs\&. However, the \f3javadoc\fR command can link to results from other runs\&. -.PP -The \f3javadoc\fR command implementation requires and relies on the Java compiler\&. The \f3javadoc\fR command calls part of the \f3javac\fR command to compile the declarations and ignore the member implementations\&. The \f3javadoc\fR command builds a rich internal representation of the classes that includes the class hierarchy and use relationships to generate the HTML\&. The \f3javadoc\fR command also picks up user-supplied documentation from documentation comments in the source code\&. See Documentation Comments\&. -.PP -The \f3javadoc\fR command runs on source files that are pure stub files with no method bodies\&. This means you can write documentation comments and run the \f3javadoc\fR command in the early stages of design before API implementation\&. -.PP -Relying on the compiler ensures that the HTML output corresponds exactly with the actual implementation, which may rely on implicit, rather than explicit, source code\&. For example, the \f3javadoc\fR command documents default constructors that are present in the compiled class files but not in the source code\&. -.PP -In many cases, the \f3javadoc\fR command lets you generate documentation for source files with incomplete or erroneous code\&. You can generate documentation before all debugging and troubleshooting is done\&. The \f3javadoc\fR command does primitive checking of documentation comments\&. -.PP -When the \f3javadoc\fR command builds its internal structure for the documentation, it loads all referenced classes\&. Because of this, the \f3javadoc\fR command must be able to find all referenced classes, whether bootstrap classes, extensions, or user classes\&. See How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html -.PP -Typically, classes you create must either be loaded as an extension or in the \f3javadoc\fR command class path\&. -.SS JAVADOC\ DOCLETS -You can customize the content and format of the \f3javadoc\fR command output with doclets\&. The \f3javadoc\fR command has a default built-in doclet, called the standard doclet, that generates HTML-formatted API documentation\&. You can modify or make a subclass of the standard doclet, or write your own doclet to generate HTML, XML, MIF, RTF or whatever output format you want\&. -.PP -When a custom doclet is not specified with the \f3-doclet\fR option, the \f3javadoc\fR command uses the default standard doclet\&. The \f3javadoc\fR command has several options that are available regardless of which doclet is being used\&. The standard doclet adds a supplementary set of command-line options\&. See Options\&. -.SH SOURCE\ FILES -The \f3javadoc\fR command generates output that originates from the following types of source files: Java language source files for classes (\f3\&.java\fR), package comment files, overview comment files, and miscellaneous unprocessed files\&. This section also describes test files and template files that can also be in the source tree, but that you want to be sure not to document\&. -.SS CLASS\ SOURCE\ FILES -Each class or interface and its members can have their own documentation comments contained in a source file\&. See Documentation Comments\&. -.SS PACKAGE\ COMMENT\ FILES -Each package can have its own documentation comment, contained in its own source file, that the \f3javadoc\fR command merges into the generated package summary page\&. You typically include in this comment any documentation that applies to the entire package\&. -.PP -To create a package comment file, you can place your comments in one of the following files: -.TP 0.2i -\(bu -The \f3package-info\&.java\fR file can contain the package declaration, package annotations, package comments, and Javadoc tags\&. This file is preferred\&. -.TP 0.2i -\(bu -The \f3package\&.html\fR file contains only package comments and Javadoc tags\&. No package annotations\&. -.PP -A package can have a single \f3package\&.html\fR file or a single \f3package-info\&.java\fR file, but not both\&. Place either file in the package directory in the source tree with your source files\&. -.PP -The package-info\&.java File - -The \f3package-info\&.java\fR file can contain a package comment of the following structure\&. The comment is placed before the package declaration\&. -.PP -\fINote:\fR The comment separators \f3/**\fR and \f3*/\fR must be present, but the leading asterisks on the intermediate lines can be left off\&. -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * Provides the classes necessary to create an \fP -.fi -.nf -\f3 * applet and the classes an applet uses \fP -.fi -.nf -\f3 * to communicate with its applet context\&.\fP -.fi -.nf -\f3 * <p>\fP -.fi -.nf -\f3 * The applet framework involves two entities:\fP -.fi -.nf -\f3 * the applet and the applet context\&.\fP -.fi -.nf -\f3 * An applet is an embeddable window (see the\fP -.fi -.nf -\f3 * {@link java\&.awt\&.Panel} class) with a few extra\fP -.fi -.nf -\f3 * methods that the applet context can use to \fP -.fi -.nf -\f3 * initialize, start, and stop the applet\&.\fP -.fi -.nf -\f3 *\fP -.fi -.nf -\f3 * @since 1\&.0\fP -.fi -.nf -\f3 * @see java\&.awt\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3package java\&.lang\&.applet;\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -The package\&.html File - -The \f3package\&.html\fR file can contain a package comment of the following structure\&. The comment is placed in the \f3<body>\fR element\&. -.PP -File: \f3java/applet/package\&.html\fR -.sp -.nf -\f3<HTML>\fP -.fi -.nf -\f3<BODY>\fP -.fi -.nf -\f3Provides the classes necessary to create an applet and the \fP -.fi -.nf -\f3classes an applet uses to communicate with its applet context\&.\fP -.fi -.nf -\f3<p>\fP -.fi -.nf -\f3The applet framework involves two entities: the applet\fP -.fi -.nf -\f3and the applet context\&. An applet is an embeddable\fP -.fi -.nf -\f3window (see the {@link java\&.awt\&.Panel} class) with a\fP -.fi -.nf -\f3few extra methods that the applet context can use to\fP -.fi -.nf -\f3initialize, start, and stop the applet\&. \fP -.fi -.nf -\f3\fP -.fi -.nf -\f3@since 1\&.0 \fP -.fi -.nf -\f3@see java\&.awt\fP -.fi -.nf -\f3</BODY>\fP -.fi -.nf -\f3</HTML>\fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3package\&.html\fR file is a typical HTML file and does not include a package declaration\&. The content of the package comment file is written in HTML with one exception\&. The documentation comment should not include the comment separators \f3/**\fR and \f3*/\fR or leading asterisks\&. When writing the comment, make the first sentence a summary about the package, and do not put a title or any other text between the \f3<body>\fR tag and the first sentence\&. You can include package tags\&. All block tags must appear after the main description\&. If you add an \f3@see\fR tag in a package comment file, then it must have a fully qualified name\&. -.PP -Processing the Comment File - -When the \f3javadoc\fR command runs, it searches for the package comment file\&. If the package comment file is found, then the \f3javadoc\fR command does the following: -.TP 0.2i -\(bu -Copies the comment for processing\&. For package\&.html, the \f3javadoc\fR command copies all content between the \f3<body>\fR and \f3</body>\fR HTML tags\&. You can include a \f3<head>\fR section to put a \f3<title>\fR tag, source file copyright statement, or other information, but none of these appear in the generated documentation\&. -.TP 0.2i -\(bu -Processes the package tags\&. See Package Tags\&. -.TP 0.2i -\(bu -Inserts the processed text at the bottom of the generated package summary page\&. See Java Platform, Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html -.TP 0.2i -\(bu -Copies the first sentence of the package comment to the top of the package summary page\&. The \f3javadoc\fR command also adds the package name and this first sentence to the list of packages on the overview page\&. See Java Platform, Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html - -The end of the sentence is determined by the same rules used for the end of the first sentence of class and member main descriptions\&. -.SS OVERVIEW\ COMMENT\ FILES -Each application or set of packages that you are documenting can have its own overview documentation comment that is kept in its own source file, that the \f3javadoc\fR command merges into the generated overview page\&. You typically include in this comment any documentation that applies to the entire application or set of packages\&. -.PP -You can name the file anything you want such as overview\&.html and place it anywhere\&. A typical location is at the top of the source tree\&. -.PP -For example, if the source files for the \f3java\&.applet\fR package are contained in the /home/user/src/java/applet directory, then you could create an overview comment file at /home/user/src/overview\&.html\&. -.PP -You can have multiple overview comment files for the same set of source files in case you want to run the \f3javadoc\fR command multiple times on different sets of packages\&. For example, you could run the \f3javadoc\fR command once with \f3-private\fR for internal documentation and again without that option for public documentation\&. In this case, you could describe the documentation as public or internal in the first sentence of each overview comment file\&. -.PP -The content of the overview comment file is one big documentation comment that is written in HTML\&. Make the first sentence a summary about the application or set of packages\&. Do not put a title or any other text between the \f3<body>\fR tag and the first sentence\&. All tags except inline tags, such as an {\f3@link}\fR tag, must appear after the main description\&. If you add an \f3@see\fR tag, then it must have a fully qualified name\&. -.PP -When you run the \f3javadoc\fR command, specify the overview comment file name with the \f3-overview\fR option\&. The file is then processed similarly to that of a package comment file\&. The \f3javadoc\fR command does the following: -.TP 0.2i -\(bu -Copies all content between the \f3<body>\fR and \f3</body>\fR tags for processing\&. -.TP 0.2i -\(bu -Processes the overview tags that are present\&. See Overview Tags\&. -.TP 0.2i -\(bu -Inserts the processed text at the bottom of the generated overview page\&. See Java Platform Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html -.TP 0.2i -\(bu -Copies the first sentence of the overview comment to the top of the overview summary page\&. -.SS UNPROCESSED\ FILES -Your source files can include any files that you want the \f3javadoc\fR command to copy to the destination directory\&. These files usually include graphic files, example Java source and class files, and self-standing HTML files with a lot of content that would overwhelm the documentation comment of a typical Java source file\&. -.PP -To include unprocessed files, put them in a directory called doc-files\&. The doc-files directory can be a subdirectory of any package directory that contains source files\&. You can have one doc-files subdirectory for each package\&. -.PP -For example, if you want to include the image of a button in the \f3java\&.awt\&.Button\fR class documentation, then place the image file in the /home/user/src/java/awt/doc-files/ directory\&. Do not place the doc-files directory at /home/user/src/java/doc-files, because java is not a package\&. It does not contain any source files\&. -.PP -All links to the unprocessed files must be included in the code because the \f3javadoc\fR command does not look at the files\&. The \f3javadoc\fR command copies the directory and all of its contents to the destination\&. The following example shows how the link in the Button\&.java documentation comment might look: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * This button looks like this: \fP -.fi -.nf -\f3 * <img src="doc\-files/Button\&.gif">\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS TEST\ AND\ TEMPLATE\ FILES -You can store test and template files in the source tree in the same directory with or in a subdirectory of the directory where the source files reside\&. To prevent test and template files from being processed, run the \f3javadoc\fR command and explicitly pass in individual source file names\&. -.PP -Test files are valid, compilable source files\&. Template files are not valid, compatible source files, but they often have the \f3\&.java\fR suffix\&. -.PP -Test Files - -If you want your test files to belong to either an unnamed package or to a package other than the package that the source files are in, then put the test files in a subdirectory underneath the source files and give the directory an invalid name\&. If you put the test files in the same directory with the source and call the \f3javadoc\fR command with a command-line argument that indicates its package name, then the test files cause warnings or errors\&. If the files are in a subdirectory with an invalid name, then the test file directory is skipped and no errors or warnings are issued\&. For example, to add test files for source files in com\&.package1, put them in a subdirectory in an invalid package name\&. The following directory name is invalid because it contains a hyphen: -.sp -.nf -\f3com/package1/test\-files/\fP -.fi -.nf -\f3\fP -.fi -.sp -If your test files contain documentation comments, then you can set up a separate run of the \f3javadoc\fR command to produce test file documentation by passing in their test source file names with wild cards, such as \f3com/package1/test-files/*\&.java\fR\&. -.PP -Template Files - -If you want a template file to be in the source directory, but not generate errors when you execute the \f3javadoc\fR command, then give it an invalid file name such as \f3Buffer-Template\&.java\fR to prevent it from being processed\&. The \f3javadoc\fR command only processes source files with names, when stripped of the \f3\&.java\fR suffix, that are valid class names\&. -.SH GENERATED\ FILES -By default, the \f3javadoc\fR command uses a standard doclet that generates HTML-formatted documentation\&. The standard doclet generates basic content, cross-reference, and support pages described here\&. Each HTML page corresponds to a separate file\&. The \f3javadoc\fR command generates two types of files\&. The first type is named after classes and interfaces\&. The second type contain hyphens (such as package-summary\&.html) to prevent conflicts with the first type of file\&. -.SS BASIC\ CONTENT\ PAGES -.TP 0.2i -\(bu -One class or interface page (classname\&.html) for each class or interface being documented\&. -.TP 0.2i -\(bu -One package page (package-summary\&.html) for each package being documented\&. The \f3javadoc\fR command includes any HTML text provided in a file with the name package\&.html or package-info\&.java in the package directory of the source tree\&. -.TP 0.2i -\(bu -One overview page (overview-summary\&.html) for the entire set of packages\&. The overview page is the front page of the generated document\&. The \f3javadoc\fR command includes any HTML text provided in a file specified by the \f3-overview\fR option\&. The Overview page is created only when you pass two or more package names into the \f3javadoc\fR command\&. See HTML Frames and Options\&. -.SS CROSS-REFERENCE\ PAGES -.TP 0.2i -\(bu -One class hierarchy page for the entire set of packages (overview-tree\&.html)\&. To view the hierarchy page, click \fIOverview\fR in the navigation bar and click \fITree\fR\&. -.TP 0.2i -\(bu -One class hierarchy page for each package (package-tree\&.html) To view the hierarchy page, go to a particular package, class, or interface page, and click \fITree\fR to display the hierarchy for that package\&. -.TP 0.2i -\(bu -One use page for each package (package-use\&.html) and a separate use page for each class and interface (class-use/classname\&.html)\&. The use page describes what packages, classes, methods, constructors and fields use any part of the specified class, interface, or package\&. For example, given a class or interface A, its use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A\&. To view the use page, go to the package, class, or interface and click the \fIUse\fR link in the navigation bar\&. -.TP 0.2i -\(bu -A deprecated API page (deprecated-list\&.html) that lists all deprecated APIs and their suggested replacements\&. Avoid deprecated APIs because they can be removed in future implementations\&. -.TP 0.2i -\(bu -A constant field values page (constant-values\&.html) for the values of static fields\&. -.TP 0.2i -\(bu -A serialized form page (serialized-form\&.html) that provides information about serializable and externalizable classes with field and method descriptions\&. The information on this page is of interest to reimplementors, and not to developers who want to use the API\&. To access the serialized form page, go to any serialized class and click \fISerialized Form\fR in the See Also section of the class comment\&. The standard doclet generates a serialized form page that lists any class (public or non-public) that implements Serializable with its \f3readObject\fR and \f3writeObject\fR methods, the fields that are serialized, and the documentation comments from the \f3@serial\fR, \f3@serialField\fR, and \f3@serialData\fR tags\&. Public serializable classes can be excluded by marking them (or their package) with \f3@serial\fR exclude, and package-private serializable classes can be included by marking them (or their package) with an \f3@serial\fR include\&. As of Release 1\&.4, you can generate the complete serialized form for public and private classes by running the \f3javadoc\fR command without specifying the \f3-private\fR option\&. See Options\&. -.TP 0.2i -\(bu -An index page (\f3index-*\&.html\fR) of all class, interface, constructor, field and method names, in alphabetical order\&. The index page is internationalized for Unicode and can be generated as a single file or as a separate file for each starting character (such as A\(enZ for English)\&. -.SS SUPPORT\ PAGES -.TP 0.2i -\(bu -A help page (help-doc\&.html) that describes the navigation bar and the previous pages\&. Use \f3-helpfile\fR to override the default help file with your own custom help file\&. -.TP 0.2i -\(bu -One index\&.html file that creates the HTML frames for display\&. Load this file to display the front page with frames\&. The index\&.html file contains no text content\&. -.TP 0.2i -\(bu -Several frame files (\f3*-frame\&.html\fR) that contains lists of packages, classes, and interfaces\&. The frame files display the HTML frames\&. -.TP 0.2i -\(bu -A package list file (package-list) that is used by the \f3-link\fR and \f3-linkoffline\fR options\&. The package list file is a text file that is not reachable through links\&. -.TP 0.2i -\(bu -A style sheet file (stylesheet\&.css) that controls a limited amount of color, font family, font size, font style, and positioning information on the generated pages\&. -.TP 0.2i -\(bu -A doc-files directory that holds image, example, source code, or other files that you want copied to the destination directory\&. These files are not processed by the \f3javadoc\fR command\&. This directory is not processed unless it exists in the source tree\&. -.PP -See Options\&. -.SS HTML\ FRAMES -The \f3javadoc\fR command generates the minimum number of frames (two or three) necessary based on the values passed to the command\&. It omits the list of packages when you pass a single package name or source files that belong to a single package as an argument to the \f3javadoc\fR command\&. Instead, the \f3javadoc\fR command creates one frame in the left-hand column that displays the list of classes\&. When you pass two or more package names, the \f3javadoc\fR command creates a third frame that lists all packages and an overview page (overview-summary\&.html)\&. To bypass frames, click the \fINo Frames\fR link or enter the page set from the overview-summary\&.html page\&. -.SS GENERATED\ FILE\ STRUCTURE -The generated class and interface files are organized in the same directory hierarchy that Java source files and class files are organized\&. This structure is one directory per subpackage\&. -.PP -For example, the document generated for the \f3java\&.applet\&.Applet\fR class would be located at java/applet/Applet\&.html\&. -.PP -The file structure for the \f3java\&.applet\fR package follows, assuming that the destination directory is named \f3apidocs\fR\&. All files that contain the word \fIframe\fR appear in the upper-left or lower-left frames, as noted\&. All other HTML files appear in the right-hand frame\&. -.PP -Directories are bold\&. The asterisks (*) indicate the files and directories that are omitted when the arguments to the \f3javadoc\fR command are source file names rather than package names\&. When arguments are source file names, an empty package list is created\&. The doc-files directory is not created in the destination unless it exists in the source tree\&. See Generated Files\&. -.TP 0.2i -\(bu -\fIapidocs\fR: Top-level directory -.RS -.TP 0.2i -\(bu -index\&.html: Initial Page that sets up HTML frames -.TP 0.2i -\(bu -*overview-summary\&.html: Package list with summaries -.TP 0.2i -\(bu -overview-tree\&.html: Class hierarchy for all packages -.TP 0.2i -\(bu -deprecated-list\&.html: Deprecated APIs for all packages -.TP 0.2i -\(bu -constant-values\&.html: Static field values for all packages -.TP 0.2i -\(bu -serialized-form\&.html: Serialized forms for all packages -.TP 0.2i -\(bu -*overview-frame\&.html: All packages for display in upper-left frame -.TP 0.2i -\(bu -allclasses-frame\&.html: All classes for display in lower-left frame -.TP 0.2i -\(bu -help-doc\&.html: Help about Javadoc page organization -.TP 0.2i -\(bu -index-all\&.html: Default index created without \f3-splitindex\fR option -.TP 0.2i -\(bu -\fIindex-files\fR: Directory created with \f3-splitindex\fR option -.RS -.TP 0.2i -\(bu -index-<number>\&.html: Index files created with \f3-splitindex\fR option -.RE - -.TP 0.2i -\(bu -package-list: Package names for resolving external references -.TP 0.2i -\(bu -stylesheet\&.css: Defines fonts, colors, positions, and so on -.RE - -.TP 0.2i -\(bu -\fIjava\fR: Package directory -.RS -.TP 0.2i -\(bu -\fIapplet\fR: Subpackage directory -.RS -.TP 0.2i -\(bu -Applet\&.html: \f3Applet\fR class page -.TP 0.2i -\(bu -AppletContext\&.html: \f3AppletContext\fR interface -.TP 0.2i -\(bu -AppletStub\&.html: \f3AppletStub\fR interface -.TP 0.2i -\(bu -AudioClip\&.html: \f3AudioClip\fR interface -.TP 0.2i -\(bu -package-summary\&.html: Classes with summaries -.TP 0.2i -\(bu -package-frame\&.html: Package classes for display in lower-left frame -.TP 0.2i -\(bu -package-tree\&.html: Class hierarchy for this package -.TP 0.2i -\(bu -package-use\&.html: Where this package is used -.TP 0.2i -\(bu -\fIdoc-files\fR: Image and example files directory -.TP 0.2i -\(bu -\fIclass-use\fR: Image and examples file location - -- Applet\&.html: Uses of the Applet class - -- AppletContext\&.html: Uses of the \f3AppletContext\fR interface - -- AppletStub\&.html: Uses of the \f3AppletStub\fR interface - -- AudioClip\&.html: Uses of the \f3AudioClip\fR interface -.RE - -.RE - -.TP 0.2i -\(bu -\fIsrc-html\fR: Source code directory -.RS -.TP 0.2i -\(bu -\fIjava\fR: Package directory -.RS -.TP 0.2i -\(bu -\fIapplet\fR: Subpackage directory - -- Applet\&.html: Applet source code - -- AppletContext\&.html: \f3AppletContext\fR source code - -- AppletStub\&.html: \f3AppletStub\fR source code - -- AudioClip\&.html: \f3AudioClip\fR source code -.RE - -.RE - -.SS GENERATED\ API\ DECLARATIONS -The \f3javadoc\fR command generates a declaration at the start of each class, interface, field, constructor, and method description for that API item\&. For example, the declaration for the \f3Boolean\fR class is: -.sp -.nf -\f3public final class Boolean\fP -.fi -.nf -\f3extends Object\fP -.fi -.nf -\f3implements Serializable\fP -.fi -.nf -\f3\fP -.fi -.sp -The declaration for the \f3Boolean\&.valueOf\fR method is: -.sp -.nf -\f3public static Boolean valueOf(String s)\fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3javadoc\fR command can include the modifiers \f3public\fR, \f3protected\fR, \f3private\fR, \f3abstract\fR, \f3final\fR, \f3static\fR, \f3transient\fR, and \f3volatile\fR, but not \f3synchronized\fR or \f3native\fR\&. The \f3synchronized\fR and \f3native\fR modifiers are considered implementation detail and not part of the API specification\&. -.PP -Rather than relying on the keyword \f3synchronized\fR, APIs should document their concurrency semantics in the main description of the comment\&. For example, a description might be: A single enumeration cannot be used by multiple threads concurrently\&. The document should not describe how to achieve these semantics\&. As another example, while the \f3Hashtable\fR option should be thread-safe, there is no reason to specify that it is achieved by synchronizing all of its exported methods\&. It is better to reserve the right to synchronize internally at the bucket level for higher concurrency\&. -.SH DOCUMENTATION\ COMMENTS -This section describes source code comments and comment inheritance\&. -.SS SOURCE\ CODE\ COMMENTS -You can include documentation comments in the source code, ahead of declarations for any class, interface, method, constructor, or field\&. You can also create documentation comments for each package and another one for the overview, though their syntax is slightly different\&. A documentation comment consists of the characters between \f3/**\fR and \f3*/\fR that end it\&. Leading asterisks are allowed on each line and are described further in the following section\&. The text in a comment can continue onto multiple lines\&. -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * This is the typical format of a simple documentation comment\fP -.fi -.nf -\f3 * that spans two lines\&.\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.sp -To save space you can put a comment on one line: -.sp -.nf -\f3/** This comment takes up only one line\&. */\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Placement of Comments - -Documentation comments are recognized only when placed immediately before class, interface, constructor, method, or field declarations\&. Documentation comments placed in the body of a method are ignored\&. The \f3javadoc\fR command recognizes only one documentation comment per declaration statement\&. See Where Tags Can Be Used\&. -.PP -A common mistake is to put an \f3import\fR statement between the class comment and the class declaration\&. Do not put an \f3import\fR statement at this location because the \f3javadoc\fR command ignores the class comment\&. -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * This is the class comment for the class Whatever\&.\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3import com\&.example; // MISTAKE \- Important not to put import statement here\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3public class Whatever{ }\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Parts of Comments - -A documentation comment has a main description followed by a tag section\&. The main description begins after the starting delimiter \f3/**\fR and continues until the tag section\&. The tag section starts with the first block tag, which is defined by the first \f3@\fR character that begins a line (ignoring leading asterisks, white space, and leading separator \f3/**\fR)\&. It is possible to have a comment with only a tag section and no main description\&. The main description cannot continue after the tag section begins\&. The argument to a tag can span multiple lines\&. There can be any number of tags, and some types of tags can be repeated while others cannot\&. For example, this \f3@see\fR tag starts the tag section: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * This sentence holds the main description for this documentation comment\&.\fP -.fi -.nf -\f3 * @see java\&.lang\&.Object\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Block and inline Tags - -A tag is a special keyword within a documentation comment that the \f3javadoc\fR command processes\&. There are two kinds of tags: block tags, which appear as an \f3@tag\fR tag (also known as standalone tags), and inline tags, which appear within braces, as an \f3{@tag}\fR tag\&. To be interpreted, a block tag must appear at the beginning of a line, ignoring leading asterisks, white space, and the separator (\f3/**\fR)\&. This means you can use the \f3@\fR character elsewhere in the text and it will not be interpreted as the start of a tag\&. If you want to start a line with the \f3@\fR character and not have it be interpreted, then use the HTML entity \f3@\fR\&. Each block tag has associated text, which includes any text following the tag up to, but not including, either the next tag, or the end of the documentation comment\&. This associated text can span multiple lines\&. An inline tag is allowed and interpreted anywhere that text is allowed\&. The following example contains the \f3@deprecated\fR block tag and the \f3{@link}\fR inline tag\&. See Javadoc Tags\&. -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * @deprecated As of JDK 1\&.1, replaced by {@link #setBounds(int,int,int,int)}\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Write Comments in HTML - -The text must be written in HTML with HTML entities and HTML tags\&. You can use whichever version of HTML your browser supports\&. The standard doclet generates HTML 3\&.2-compliant code elsewhere (outside of the documentation comments) with the inclusion of cascading style sheets and frames\&. HTML 4\&.0 is preferred for generated files because of the frame sets\&. -.PP -For example, entities for the less than symbol (<) and the greater than symbol (>) should be written as \f3<\fR and \f3>\fR\&. Similarly, the ampersand (&) should be written as \f3&\fR\&. The bold HTML tag \f3<b>\fR is shown in the following example\&. -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * This is a <b>doc</b> comment\&.\fP -.fi -.nf -\f3 * @see java\&.lang\&.Object\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Leading Asterisks - -When the \f3javadoc\fR command parses a documentation comment, leading asterisks (*) on each line are discarded, and blanks and tabs that precede the initial asterisks (*) are also discarded\&. If you omit the leading asterisk on a line, then the leading white space is no longer removed so that you can paste code examples directly into a documentation comment inside a \f3<PRE>\fR tag with its indentation preserved\&. Spaces are interpreted by browsers more uniformly than tabs\&. Indentation is relative to the left margin (rather than the separator \f3/**\fR or \f3<PRE>\fR tag)\&. -.PP -First Sentence - -The first sentence of each documentation comment should be a summary sentence that contains a concise but complete description of the declared entity\&. This sentence ends at the first period that is followed by a blank, tab, or line terminator, or at the first block tag\&. The \f3javadoc\fR command copies this first sentence to the member summary at the top of the HTML page\&. -.PP -Multiple-Field Declarations - -The Java platform lets you declare multiple fields in a single statement, but this statement can have only one documentation comment that is copied for all fields\&. If you want individual documentation comments for each field, then declare each field in a separate statement\&. For example, the following documentation comment does not make sense written as a single declaration and would be better handled as two declarations: -.sp -.nf -\f3/** \fP -.fi -.nf -\f3 * The horizontal and vertical distances of point (x,y)\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3public int x, y; // Avoid this \fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3javadoc\fR command generates the following documentation from the previous code: -.sp -.nf -\f3public int x\fP -.fi -.nf -\f3\fP -.fi -.sp -The horizontal and vertical distances of point (x, y)\&. -.sp -.nf -\f3public int y\fP -.fi -.nf -\f3\fP -.fi -.sp -The horizontal and vertical distances of point (x, y)\&. -.PP -Use of Header Tags - -When writing documentation comments for members, it is best not to use HTML heading tags such as \f3<H1>\fR and \f3<H2>\fR, because the \f3javadoc\fR command creates an entire structured document, and these structural tags might interfere with the formatting of the generated document\&. However, you can use these headings in class and package comments to provide your own structure\&. -.SS METHOD\ COMMENT\ INHERITANCE -The \f3javadoc\fR command allows method comment inheritance in classes and interfaces to fill in missing text or to explicitly inherit method comments\&. Constructors, fields, and nested classes do not inherit documentation comments\&. -.PP -\fINote:\fR The source file for an inherited method must be on the path specified by the \f3-sourcepath\fR option for the documentation comment to be available to copy\&. Neither the class nor its package needs to be passed in on the command line\&. This contrasts with Release 1\&.3\&.\fIn\fR and earlier releases, where the class had to be a documented class\&. -.PP -Fill in Missing Text - -When a main description, or \f3@return\fR, \f3@param\fR, or \f3@throws\fR tag is missing from a method comment, the \f3javadoc\fR command copies the corresponding main description or tag comment from the method it overrides or implements (if any)\&. See Method Comment Inheritance\&. -.PP -When an \f3@param\fR tag for a particular parameter is missing, the comment for that parameter is copied from the method further up the inheritance hierarchy\&. When an \f3@throws\fR tag for a particular exception is missing, the \f3@throws\fR tag is copied only when that exception is declared\&. -.PP -This behavior contrasts with Release 1\&.3 and earlier, where the presence of any main description or tag would prevent all comments from being inherited\&. -.PP -See Javadoc Tags and Options\&. -.PP -Explicit Inheritance - -Insert the \f3{@inheritDoc}\fR inline tag in a method main description or \f3@return\fR, \f3@param\fR, or \f3@throws\fR tag comment\&. The corresponding inherited main description or tag comment is copied into that spot\&. -.SS CLASS\ AND\ INTERFACE\ INHERITANCE -Comment inheritance occurs in all possible cases of inheritance from classes and interfaces: -.TP 0.2i -\(bu -When a method in a class overrides a method in a superclass -.TP 0.2i -\(bu -When a method in an interface overrides a method in a superinterface -.TP 0.2i -\(bu -When a method in a class implements a method in an interface -.PP -In the first two cases, the \f3javadoc\fR command generates the subheading \fIOverrides\fR in the documentation for the overriding method\&. A link to the method being overridden is included, whether or not the comment is inherited\&. -.PP -In the third case, when a method in a specified class implements a method in an interface, the \f3javadoc\fR command generates the subheading \fISpecified by\fR in the documentation for the overriding method\&. A link to the method being implemented is included, whether or not the comment is inherited\&. -.SS METHOD\ COMMENTS\ ALGORITHM -If a method does not have a documentation comment, or has an \f3{@inheritDoc}\fR tag, then the \f3javadoc\fR command uses the following algorithm to search for an applicable comment\&. The algorithm is designed to find the most specific applicable documentation comment, and to give preference to interfaces over superclasses: -.TP 0.4i -1\&. -Look in each directly implemented (or extended) interface in the order they appear following the word \f3implements\fR (or \f3extends\fR) in the method declaration\&. Use the first documentation comment found for this method\&. -.TP 0.4i -2\&. -If Step 1 failed to find a documentation comment, then recursively apply this entire algorithm to each directly implemented (or extended) interface in the same order they were examined in Step 1\&. -.TP 0.4i -3\&. -When Step 2 fails to find a documentation comment and this is a class other than the \f3Object\fR class, but not an interface: -.RS -.TP 0.4i -1\&. -If the superclass has a documentation comment for this method, then use it\&. -.TP 0.4i -2\&. -If Step 3a failed to find a documentation comment, then recursively apply this entire algorithm to the superclass\&. -.RE - -.SH JAVADOC\ TAGS -The \f3javadoc\fR command parses special tags when they are embedded within a Java documentation comment\&. The \f3javadoc\fR tags let you autogenerate a complete, well-formatted API from your source code\&. The tags start with an at sign (\f3@\fR) and are case-sensitive\&. They must be typed with the uppercase and lowercase letters as shown\&. A tag must start at the beginning of a line (after any leading spaces and an optional asterisk), or it is treated as text\&. By convention, tags with the same name are grouped together\&. For example, put all \f3@see\fR tags together\&. For more information, see Where Tags Can Be Used\&. -.PP -Tags have the following types: -.TP 0.2i -\(bu -Bock tags: Place block tags only in the tag section that follows the description\&. Block tags have the form: \fI@tag\fR\&. -.TP 0.2i -\(bu -Inline tags: Place inline tags anywhere in the main description or in the comments for block tags\&. Inline tags are enclosed within braces: \fI{@tag}\fR\&. -.PP -For custom tags, see -tag tagname:Xaoptcmf:"taghead"\&. See also Where Tags Can Be Used\&. -.SS TAG\ DESCRIPTIONS -.TP -@author \fIname-text\fR -Introduced in JDK 1\&.0 - -Adds an Author entry with the specified name text to the generated documents when the \f3-author\fR option is used\&. A documentation comment can contain multiple \f3@author\fR tags\&. You can specify one name per \f3@author\fR tag or multiple names per tag\&. In the former case, the \f3javadoc\fR command inserts a comma (,) and space between names\&. In the latter case, the entire text is copied to the generated document without being parsed\&. Therefore, you can use multiple names per line if you want a localized name separator other than a comma\&. See @author in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@author -.TP -{@code \fItext\fR} -Introduced in JDK 1\&.5 - -Equivalent to \f3<code>{@literal}</code>\fR\&. - -Displays text in code font without interpreting the text as HTML markup or nested Javadoc tags\&. This enables you to use regular angle brackets (< and >) instead of the HTML entities (\f3<\fR and \f3>\fR) in documentation comments, such as in parameter types (\f3<Object>\fR), inequalities (\f33 < 4\fR), or arrows (\f3<-\fR)\&. For example, the documentation comment text \f3{@code A<B>C}\fR displayed in the generated HTML page unchanged as \f3A<B>C\fR\&. This means that the \f3<B>\fR is not interpreted as bold and is in code font\&. If you want the same functionality without the code font, then use the \f3{@literal}\fR tag\&. -.TP -@deprecated \fIdeprecated-text\fR -Introduced in JDK 1\&.0 - -Adds a comment indicating that this API should no longer be used (even though it may continue to work)\&. The \f3javadoc\fR command moves \f3deprecated-text\fRahead of the main description, placing it in italics and preceding it with a bold warning: Deprecated\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field\&. - -The first sentence of deprecated text should tell the user when the API was deprecated and what to use as a replacement\&. The \f3javadoc\fR command copies the first sentence to the summary section and index\&. Subsequent sentences can also explain why it was deprecated\&. You should include an \f3{@link}\fR tag (for Javadoc 1\&.2 or later) that points to the replacement API\&. - -Use the \fI@deprecated annotation\fR tag to deprecate a program element\&. See How and When to Deprecate APIs at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/deprecation/deprecation\&.html - -See also @deprecated in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@deprecated -.TP -{@docRoot} -Introduced in JDK 1\&.3 - -Represents the relative path to the generated document\&'s (destination) root directory from any generated page\&. This tag is useful when you want to include a file, such as a copyright page or company logo, that you want to reference from all generated pages\&. Linking to the copyright page from the bottom of each page is common\&. - -This \f3{@docRoot}\fR tag can be used both on the command line and in a documentation comment\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field, and includes the text portion of any tag (such as the \f3@return\fR, \f3@param\fR and \f3@deprecated\fR tags)\&. -.RS -.TP 0.2i -\(bu -On the command line, where the header, footer, or bottom are defined: \f3javadoc -bottom \&'<a href="{@docRoot}/copyright\&.html">Copyright</a>\&'\fR\&. - -When you use the \f3{@docRoot}\fR tag this way in a make file, some \f3makefile\fR programs require a special way to escape for the brace \f3{}\fR characters\&. For example, the Inprise MAKE version 5\&.2 running on Windows requires double braces: \f3{{@docRoot}}\fR\&. It also requires double (rather than single) quotation marks to enclose arguments to options such as the \f3-bottom\fR option (with the quotation marks around the \f3href\fR argument omitted)\&. -.TP 0.2i -\(bu -In a documentation comment: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * See the <a href="{@docRoot}/copyright\&.html">Copyright</a>\&.\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.sp - - -This tag is needed because the generated documents are in hierarchical directories, as deep as the number of subpackages\&. The expression: \f3<a href="{@docRoot}/copyright\&.html">\fR resolves to \f3<a href="\&.\&./\&.\&./copyright\&.html">\fR for \f3java/lang/Object\&.java\fR and \f3<a href="\&.\&./\&.\&./\&.\&./copyright\&.html">\fR for \f3java/lang/ref/Reference\&.java\fR\&. -.RE - -.TP -@exception \fIclass-name description\fR -Introduced in JDK 1\&.0 - -Identical to the \f3@throws\fR tag\&. See @throws class-name description\&. -.TP -{@inheritDoc} -Introduced in JDK 1\&.4 - -Inherits (copies) documentation from the nearest inheritable class or implementable interface into the current documentation comment at this tag\&'s location\&. This enables you to write more general comments higher up the inheritance tree and to write around the copied text\&. - -This tag is valid only in these places in a documentation comment: -.RS -.TP 0.2i -\(bu -In the main description block of a method\&. In this case, the main description is copied from a class or interface up the hierarchy\&. -.TP 0.2i -\(bu -In the text arguments of the \f3@return\fR, \f3@param,\fR and \f3@throws\fR tags of a method\&. In this case, the tag text is copied from the corresponding tag up the hierarchy\&. -.RE - - -See Method Comment Inheritance for a description of how comments are found in the inheritance hierarchy\&. Note that if this tag is missing, then the comment is or is not automatically inherited according to rules described in that section\&. -.TP -{@link \fIpackage\&.class#member label\fR} -Introduced in JDK 1\&.2 - -Inserts an inline link with a visible text label that points to the documentation for the specified package, class, or member name of a referenced class\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field, including the text portion of any tag, such as the \f3@return\fR, \f3@param\fR and \f3@deprecated\fR tags\&. See @link in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#{@link - -This tag is similar to the \f3@see\fR tag\&. Both tags require the same references and accept the same syntax for \f3package\&.class#member\fR and \f3label\fR\&. The main difference is that the \f3{@link}\fR tag generates an inline link rather than placing the link in the See Also section\&. The \f3{@link}\fR tag begins and ends with braces to separate it from the rest of the inline text\&. If you need to use the right brace (\f3}\fR) inside the label, then use the HTML entity notation \f3}\fR\&. - -There is no limit to the number of \f3{@link}\fR tags allowed in a sentence\&. You can use this tag in the main description part of any documentation comment or in the text portion of any tag, such as the \f3@deprecated\fR, \f3@return\fR or \f3@param\fR tags\&. - -For example, here is a comment that refers to the \f3getComponentAt(int, int)\fR method: -.sp -.nf -\f3Use the {@link #getComponentAt(int, int) getComponentAt} method\&.\fP -.fi -.nf -\f3\fP -.fi -.sp - - -From this code, the standard doclet generates the following HTML (assuming it refers to another class in the same package): -.sp -.nf -\f3Use the <a href="Component\&.html#getComponentAt(int, int)">getComponentAt</a> method\&.\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The previous line appears on the web page as: -.sp -.nf -\f3Use the getComponentAt method\&.\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -{@linkplain \fIpackage\&.class#member label\fR} -Introduced in JDK 1\&.4 - -Behaves the same as the \f3{@link}\fR tag, except the link label is displayed in plain text rather than code font\&. Useful when the label is plain text\&. For example, \f3Refer to {@linkplain add() the overridden method}\fR\&. displays as: Refer to the overridden method\&. -.TP -{@literal \fItext\fR} -Introduced in JDK 1\&.5 - -Displays text without interpreting the text as HTML markup or nested Javadoc tags\&. This enables you to use angle brackets (\f3< and >\fR) instead of the HTML entities (\f3<\fR and \f3>\fR) in documentation comments, such as in parameter types (\f3<Object>\fR), inequalities (\f33 < 4\fR), or arrows (<-)\&. For example, the documentation comment text \f3{@literal A<B>C}\fR displays unchanged in the generated HTML page in your browser, as \f3A<B>C\fR\&. The \f3<B>\fR is not interpreted as bold (and it is not in code font)\&. If you want the same functionality with the text in code font, then use the \f3{@code}\fR tag\&. -.TP -@param \fIparameter-name description\fR -Introduced in JDK 1\&.0 - -Adds a parameter with the specified \f3parameter-name\fR followed by the specified description to the Parameters section\&. When writing the documentation comment, you can continue the description onto multiple lines\&. This tag is valid only in a documentation comment for a method, constructor, or class\&. See @param in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@param - -The \f3parameter-name\fR can be the name of a parameter in a method or constructor, or the name of a type parameter of a class, method, or constructor\&. Use angle brackets around this parameter name to specify the use of a type parameter\&. - -Example of a type parameter of a class: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * @param <E> Type of element stored in a list\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3public interface List<E> extends Collection<E> {\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - - -Example of a type parameter of a method: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * @param string the string to be converted\fP -.fi -.nf -\f3 * @param type the type to convert the string to\fP -.fi -.nf -\f3 * @param <T> the type of the element\fP -.fi -.nf -\f3 * @param <V> the value of the element\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3<T, V extends T> V convert(String string, Class<T> type) {\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -@return \fIdescription\fR -Introduced in JDK 1\&.0 - -Adds a Returns section with the description text\&. This text should describe the return type and permissible range of values\&. This tag is valid only in a documentation comment for a method\&. See @return in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@return -.TP -@see \fIreference\fR -Introduced in JDK 1\&.0 - -Adds a \fISee Also\fR heading with a link or text entry that points to a reference\&. A documentation comment can contain any number of \f3@see\fR tags, which are all grouped under the same heading\&. The \f3@see\fR tag has three variations\&. The form is the most common\&. This tag is valid in any documentation comment: overview, package, class, interface, constructor, method, or field\&. For inserting an inline link within a sentence to a package, class, or member, see \f3{@link}\fR\&. - -\fIForm 1\fR\&. The @see \f3string\fR tag form adds a text entry for \fIstring\fR\&. No link is generated\&. The string is a book or other reference to information not available by URL\&. The \f3javadoc\fR command distinguishes this from the previous cases by searching for a double quotation mark (") as the first character\&. For example, \f3@see "The Java Programming Language"\fR that generates the following text: - -\fISee Also\fR: - -"The Java Programming Language" - -\fIForm 2\fR\&. The \f3@see <a href="URL#value">label</a>\fR form adds a link as defined by \f3URL#value\fR\&. The \f3URL#value\fR parameter is a relative or absolute URL\&. The \f3javadoc\fR command distinguishes this from other cases by searching for a less-than symbol (\f3<\fR) as the first character\&. For example, \f3@see <a href="spec\&.html#section">Java Spec</a>\fR generates the following link: - -\fISee Also\fR: - -Java Spec - -\fIForm 3\fR\&. The \f3@see package\&.class#member label\fR form adds a link with a visible text label that points to the documentation for the specified name in the Java Language that is referenced\&. The label is optional\&. If the label is omitted, then the name appears instead as visible text, suitably shortened\&. Use the \f3-noqualifier\fR option to globally remove the package name from this visible text\&. Use the label when you want the visible text to be different from the autogenerated visible text\&. See How a Name Appears\&. - -In Java SE 1\&.2 only, the name but not the label automatically appears in \f3<code>\fR HTML tags\&. Starting with Java SE 1\&.2\&.2, the \f3<code>\fR tag is always included around the visible text, whether or not a label is used\&. -.RS -.TP 0.2i -\(bu -\f3package\&.class#member\fR is any valid program element name that is referenced, such as a package, class, interface, constructor, method or field name, except that the character ahead of the member name should be a number sign (\f3#\fR)\&. The class represents any top-level or nested class or interface\&. The member represents any constructor, method, or field (not a nested class or interface)\&. If this name is in the documented classes, then the \f3javadoc\fR command create a link to it\&. To create links to external referenced classes, use the \f3-link\fR option\&. Use either of the other two \f3@see\fR tag forms to refer to the documentation of a name that does not belong to a referenced class\&. See Specify a Name\&. - -\fINote:\fR External referenced classes are classes that are not passed into the \f3javadoc\fR command on the command line\&. Links in the generated documentation to external referenced classes are called external references or external links\&. For example, if you run the \f3javadoc\fR command on only the \f3java\&.awt package\fR, then any class in \f3java\&.lang\fR, such as \f3Object\fR, is an external referenced class\&. Use the \f3-link\fR and \f3-linkoffline\fR options to link to external referenced classes\&. The source comments of external referenced classes are not available to the \f3javadoc\fR command run\&. -.TP 0.2i -\(bu -\f3label\fR is optional text that is visible as the link label\&. The label can contain white space\&. If \f3label\fR is omitted, then \f3package\&.class\&.member\fR appears, suitably shortened relative to the current class and package\&. See How a Name Appears\&. -.TP 0.2i -\(bu -A space is the delimiter between \f3package\&.class#member\fR and \f3label\fR\&. A space inside parentheses does not indicate the start of a label, so spaces can be used between parameters in a method\&. -.RE - - -\fI\fRIn the following example, an \f3@see\fR tag (in the \f3Character\fR class) refers to the equals method in the \f3String\fR class\&. The tag includes both arguments: the name \f3String#equals(Object)\fR and the label \f3equals\fR\&. -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * @see String#equals(Object) equals\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The standard doclet produces HTML that is similar to: -.sp -.nf -\f3<dl>\fP -.fi -.nf -\f3<dt><b>See Also:</b>\fP -.fi -.nf -\f3<dd><a href="\&.\&./\&.\&./java/lang/String#equals(java\&.lang\&.Object)"><code>equals<code></a>\fP -.fi -.nf -\f3</dl>\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The previous code looks similar to the following in a browser, where the label is the visible link text: - -\fISee Also\fR: - -equals -.PP -Specify a Name - -\fI\fRThis \f3package\&.class#member\fR name can be either fully qualified, such as \f3java\&.lang\&.String#toUpperCase()\fR or not, such as \f3String#toUpperCase()\fR or \f3#toUpperCase()\fR\&. If the name is less than fully qualified, then the \f3javadoc\fR command uses the standard Java compiler search order to find it\&. See Search Order for the @see Tag\&. The name can contain white space within parentheses, such as between method arguments\&.The advantage to providing shorter, partially qualified names is that they are shorter to type and there is less clutter in the source code\&. The following listing shows the different forms of the name, where \f3Class\fR can be a class or interface; Type can be a class, interface, array, or primitive; and method can be a method or constructor\&. -.sp -.nf -\f3\fITypical forms for\fR\fI @see package\&.class#member\fR\fP -.fi -.nf -\f3\fIReferencing a member of the current class\fR\fP -.fi -.nf -\f3@see #field\fP -.fi -.nf -\f3@see #method(Type, Type,\&.\&.\&.)\fP -.fi -.nf -\f3@see #method(Type argname, Type argname,\&.\&.\&.)\fP -.fi -.nf -\f3@see #constructor(Type, Type,\&.\&.\&.)\fP -.fi -.nf -\f3@see #constructor(Type argname, Type argname,\&.\&.\&.) \fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\fIReferencing another class in the current or imported packages\fR\fP -.fi -.nf -\f3@see Class#field\fP -.fi -.nf -\f3@see Class#method(Type, Type,\&.\&.\&.)\fP -.fi -.nf -\f3@see Class#method(Type argname, Type argname,\&.\&.\&.)\fP -.fi -.nf -\f3@see Class#constructor(Type, Type,\&.\&.\&.)\fP -.fi -.nf -\f3@see Class#constructor(Type argname, Type argname,\&.\&.\&.)\fP -.fi -.nf -\f3@see Class\&.NestedClass\fP -.fi -.nf -\f3@see Class \fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\fIReferencing an element in another package (fully qualified)\fR\fP -.fi -.nf -\f3@see package\&.Class#field\fP -.fi -.nf -\f3@see package\&.Class#method(Type, Type,\&.\&.\&.)\fP -.fi -.nf -\f3@see package\&.Class#method(Type argname, Type argname,\&.\&.\&.)\fP -.fi -.nf -\f3@see package\&.Class#constructor(Type, Type,\&.\&.\&.)\fP -.fi -.nf -\f3@see package\&.Class#constructor(Type argname, Type argname,\&.\&.\&.)\fP -.fi -.nf -\f3@see package\&.Class\&.NestedClass\fP -.fi -.nf -\f3@see package\&.Class\fP -.fi -.nf -\f3@see package\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3\fRNotes about the previous listing: -.TP 0.2i -\(bu -The first set of forms with no class or package causes the \f3javadoc\fR command to search only through the current class hierarchy\&. It finds a member of the current class or interface, one of its superclasses or superinterfaces, or one of its enclosing classes or interfaces (search Items 1\(en3)\&. It does not search the rest of the current package or other packages (search Items 4\(en5)\&. See Search Order for the @see Tag\&. -.TP 0.2i -\(bu -If any method or constructor is entered as a name with no parentheses, such as \f3getValue\fR, and if there is no field with the same name, then the \f3javadoc\fR command still creates a link to the method\&. If this method is overloaded, then the \f3javadoc\fR command links to the first method its search encounters, which is unspecified\&. -.TP 0.2i -\(bu -Nested classes must be specified as \f3outer\&.inner\fR, not simply \f3inner\fR, for all forms\&. -.TP 0.2i -\(bu -As stated, the number sign (\f3#\fR), rather than a dot (\f3\&.\fR) separates a member from its class\&. This enables the \f3javadoc\fR command to resolve ambiguities, because the dot also separates classes, nested classes, packages, and subpackages\&. However, the \f3javadoc\fR command properly parses a dot when there is no ambiguity, but prints a warning to alert you\&. -.PP -Search Order for the @see Tag - -\fI\fRThe \f3javadoc\fR command processes an \f3@see\fR tag that appears in a source file, package file, or overview file\&. In the latter two files, you must fully qualify the name you supply with the \f3@see\fR tag\&. In a source file, you can specify a name that is fully qualified or partially qualified\&. -.PP -The following is the search order for the \f3@see\fR tag\&. -.TP 0.4i -1\&. -The current class or interface\&. -.TP 0.4i -2\&. -Any enclosing classes and interfaces searching the closest first\&. -.TP 0.4i -3\&. -Any superclasses and superinterfaces, searching the closest first\&. -.TP 0.4i -4\&. -The current package\&. -.TP 0.4i -5\&. -Any imported packages, classes, and interfaces, searching in the order of the \f3import\fR statement\&. -.PP -The \f3javadoc\fR command continues to search recursively through Items 1-3 for each class it encounters until it finds a match\&. That is, after it searches through the current class and its enclosing class E, it searches through the superclasses of E before the enclosing classes of E\&. In Items 4 and 5, the \f3javadoc\fR command does not search classes or interfaces within a package in any specified order (that order depends on the particular compiler)\&. In Item 5, the \f3javadoc\fR command searches in \fIjava\&.lang\fR because that is imported by all programs\&. -.PP -When the \f3javadoc\fR command encounters an \f3@see\fR tag in a source file that is not fully qualified, it searches for the specified name in the same order as the Java compiler would, except the \f3javadoc\fR command does not detect certain name space ambiguities because it assumes the source code is free of these errors\&. This search order is formally defined in the Java Language Specification\&. The \f3javadoc\fR command searches for that name through all related and imported classes and packages\&. In particular, it searches in this order: -.TP 0.4i -1\&. -The current class or interface\&. -.TP 0.4i -2\&. -Any enclosing classes and interfaces, searching the closest first\&. -.TP 0.4i -3\&. -Any superclasses and superinterfaces, searching the closest first\&. -.TP 0.4i -4\&. -The current package\&. -.TP 0.4i -5\&. -Any imported packages, classes, and interfaces, searching in the order of the \f3import\fR statements\&. -.PP -The \f3javadoc\fR command does not necessarily look in subclasses, nor will it look in other packages even when their documentation is being generated in the same run\&. For example, if the \f3@see\fR tag is in the \f3java\&.awt\&.event\&.KeyEvent\fR class and refers to a name in the \f3java\&.awt package\fR, then the \f3javadoc\fR command does not look in that package unless that class imports it\&. -.PP -How a Name Appears - -\fI\fRIf \f3label\fR is omitted, then \f3package\&.class\&.member\fR appears\&. In general, it is suitably shortened relative to the current class and package\&. Shortened means the \f3javadoc\fR command displays only the minimum name necessary\&. For example, if the \f3String\&.toUpperCase()\fR method contains references to a member of the same class and to a member of a different class, then the class name is displayed only in the latter case, as shown in the following listing\&. Use the \f3-noqualifier\fR option to globally remove the package names\&. -.PP -\fIType of reference\fR: The \f3@see\fR tag refers to a member of the same class, same package -.br -\fIExample in\fR: \f3@see String#toLowerCase()\fR -.br -\fIAppears as\fR: \f3toLowerCase()\fR - omits the package and class names -.br - -.PP -\fIType of reference\fR: The \f3@see\fR tag refers to a member of a different class, same package -.br -\fIExample in\fR: \f3@see Character#toLowerCase(char)\fR -.br -\fIAppears as\fR: \f3Character\&.toLowerCase(char)\fR - omits the package name, includes the class name -.br - -.PP -\fIType of reference\fR: The \f3@see\fR tag refers to a member of a different class, different package -.br -\fIExample in\fR: \f3@see java\&.io\&.File#exists()\fR -.br -\fIAppears as\fR: \f3java\&.io\&.File\&.exists()\fR - includes the package and class names -.br - -.PP -Examples of the @see Tag - -The comment to the right shows how the name appears when the \f3@see\fR tag is in a class in another package, such as \f3java\&.applet\&.Applet\fR\&. See @see in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@see -.sp -.nf -\f3 See also:\fP -.fi -.nf -\f3@see java\&.lang\&.String // String \fP -.fi -.nf -\f3@see java\&.lang\&.String The String class // The String class \fP -.fi -.nf -\f3@see String // String \fP -.fi -.nf -\f3@see String#equals(Object) // String\&.equals(Object) \fP -.fi -.nf -\f3@see String#equals // String\&.equals(java\&.lang\&.Object) \fP -.fi -.nf -\f3@see java\&.lang\&.Object#wait(long) // java\&.lang\&.Object\&.wait(long) \fP -.fi -.nf -\f3@see Character#MAX_RADIX // Character\&.MAX_RADIX \fP -.fi -.nf -\f3@see <a href="spec\&.html">Java Spec</a> // Java Spec \fP -.fi -.nf -\f3@see "The Java Programming Language" // "The Java Programming Language" \fP -.fi -.nf -\f3\fP -.fi -.sp -\fINote:\fR You can extend the \f3@se\fR\f3e\fR tag to link to classes not being documented with the \f3-link\fR option\&. -.TP -@serial \fIfield-description\fR | include | exclude -Introduced in JDK 1\&.2 - -Used in the documentation comment for a default serializable field\&. See Documenting Serializable Fields and Data for a Class at http://docs\&.oracle\&.com/javase/8/docs/platform/serialization/spec/serial-arch\&.html#5251 - -See also Oracle\(cqs Criteria for Including Classes in the Serialized Form Specification at http://www\&.oracle\&.com/technetwork/java/javase/documentation/serialized-criteria-137781\&.html - -An optional \f3field-description\fR should explain the meaning of the field and list the acceptable values\&. When needed, the description can span multiple lines\&. The standard doclet adds this information to the serialized form page\&. See Cross-Reference Pages\&. - -If a serializable field was added to a class after the class was made serializable, then a statement should be added to its main description to identify at which version it was added\&. - -The \f3include\fR and \f3exclude\fR arguments identify whether a class or package should be included or excluded from the serialized form page\&. They work as follows: -.RS -.TP 0.2i -\(bu -A public or protected class that implements \f3Serializable\fR is included unless that class (or its package) is marked with the \f3@serial exclude\fR tag\&. -.TP 0.2i -\(bu -A private or package-private class that implements \f3Serializable\fR is excluded unless that class (or its package) is marked with the \f3@serial include\fR tag\&. -.RE - - -For example, the \f3javax\&.swing\fR package is marked with the \f3@serial\fR\f3exclude\fR tag in package\&.html or package-info\&.java\&. The public class \f3java\&.security\&.BasicPermission\fR is marked with the \f3@serial exclude\fR tag\&. The package-private class \f3java\&.util\&.PropertyPermissionCollection\fR is marked with the \f3@serial include\fR tag\&. - -The \f3@serial\fR tag at the class level overrides the \f3@serial\fR tag at the package level\&. -.TP -@serialData \fIdata-description\fR -Introduced in JDK 1\&.2 - -Uses the data description value to document the types and order of data in the serialized form\&. This data includes the optional data written by the \f3writeObject\fR method and all data (including base classes) written by the \f3Externalizable\&.writeExternal\fR method\&. - -The \f3@serialData\fR tag can be used in the documentation comment for the \f3writeObject\fR, \f3readObject\fR, \f3writeExternal\fR, \f3readExternal\fR, \f3writeReplace\fR, and \f3readResolve\fR methods\&. -.TP -@serialField \fIfield-name\fR\fIfield-type\fR\fIfield-description\fR -Introduced in JDK 1\&.2 - -Documents an \f3ObjectStreamField\fR component of the \f3serialPersistentFields\fR member of a \f3Serializable\fR class\&. Use one \f3@serialField\fR tag for each \f3ObjectStreamField\fR component\&. -.TP -@since \fIsince-text\fR -Introduced in JDK 1\&.1 - -Adds a \fISince\fR heading with the specified \f3since-text\fR value to the generated documentation\&. The text has no special internal structure\&. This tag is valid in any documentation comment: overview, package, class, interface, constructor, method, or field\&. This tag means that this change or feature has existed since the software release specified by the \f3since-text\fR value, for example: \f3@since 1\&.5\fR\&. - -For Java platform source code, the \f3@since\fR tag indicates the version of the Java platform API specification, which is not necessarily when the source code was added to the reference implementation\&. Multiple \f3@since\fR tags are allowed and are treated like multiple \f3@author\fR tags\&. You could use multiple tags when the program element is used by more than one API\&. -.TP -@throws \fIclass-name\fR\fIdescription\fR -Introduced in JDK 1\&.2 - -Behaves the same as the \f3@exception\fR tag\&. See @throws in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@exception - -The \f3@throws\fR tag adds a \fIThrows\fR subheading to the generated documentation, with the \f3class-name\fR and \f3description\fR text\&. The \fIclass-name\fR is the name of the exception that might be thrown by the method\&. This tag is valid only in the documentation comment for a method or constructor\&. If this class is not fully specified, then the \f3javadoc\fR command uses the search order to look up this class\&. Multiple \f3@throws\fR tags can be used in a specified documentation comment for the same or different exceptions\&. See Search Order for the @see Tag\&. - -To ensure that all checked exceptions are documented, when an \f3@throws\fR tag does not exist for an exception in the throws clause, the \f3javadoc\fR command adds that exception to the HTML output (with no description) as though it were documented with the \f3@throws\fR tag\&. - -The \f3@throws\fR documentation is copied from an overridden method to a subclass only when the exception is explicitly declared in the overridden method\&. The same is true for copying from an interface method to an implementing method\&. You can use the \f3{@inheritDoc}\fR tag to force the \f3@throws\fR tag to inherit documentation\&. -.TP -{@value \fIpackage\&.class#field\fR} -Introduced in JDK 1\&.4 - -Displays constant values\&. When the \f3{@value}\fR tag is used without an argument in the documentation comment of a static field, it displays the value of that constant: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * The value of this constant is {@value}\&.\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3public static final String SCRIPT_START = "<script>"\fP -.fi -.nf -\f3\fP -.fi -.sp - - -When used with the argument \f3package\&.class#field\fR in any documentation comment, he \f3{@value}\fR tag displays the value of the specified constant: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * Evaluates the script starting with {@value #SCRIPT_START}\&.\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3public String evalScript(String script) {}\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The argument \f3package\&.class#field\fR takes a form similar to that of the \f3@see\fR tag argument, except that the member must be a static field\&. - -The values of these constants are also displayed in Constant Field Values at http://docs\&.oracle\&.com/javase/8/docs/api/constant-values\&.html -.TP -@version \fIversion-text\fR -Introduced in JDK 1\&.0 - -Adds a \fIVersion\fR subheading with the specified \f3version-text\fR value to the generated documents when the \f3-version\fR option is used\&. This tag is intended to hold the current release number of the software that this code is part of, as opposed to the\f3@since\fR tag, which holds the release number where this code was introduced\&. The \f3version-text\fR value has no special internal structure\&. See @version in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@version - -A documentation comment can contain multiple \f3@version\fR tags\&. When it makes sense, you can specify one release number per \f3@version\fR tag or multiple release numbers per tag\&. In the former case, the \f3javadoc\fR command inserts a comma (,) and a space between the names\&. In the latter case, the entire text is copied to the generated document without being parsed\&. Therefore, you can use multiple names per line when you want a localized name separator other than a comma\&. -.SH WHERE\ TAGS\ CAN\ BE\ USED -The following sections describe where tags can be used\&. Note that the following tags can be used in all documentation comments: \f3@see\fR, \f3@since\fR, \f3@deprecated\fR, \f3{@link}\fR, \f3{@linkplain}\fR, and \f3{@docroot}\fR\&. -.SS OVERVIEW\ TAGS -Overview tags are tags that can appear in the documentation comment for the overview page (which resides in the source file typically named overview\&.html)\&. Similar to any other documentation comments, these tags must appear after the main description -.PP -\fINote:\fR The \f3{@link}\fR tag has a bug in overview documents in Java SE 1\&.2\&. The text appears correctly but has no link\&. The \f3{@docRoot}\fR tag does not currently work in overview documents\&. -.PP -The overview tags are the following: -.PP -@see reference || @since since-text || @serialField field-name field-type field-description || @author name-text || @version version-text || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || -.SS PACKAGE\ TAGS -Package tags are tags that can appear in the documentation comment for a package, that resides in the source file named package\&.html or package-info\&.java\&. The \f3@serial\fR tag can only be used here with the \f3include\fR or \f3exclude\fR argument\&. -.PP -The package tags are the following: -.PP -@see reference || @since since-text || @serial field-description | include | exclude || @author name-text || @version version-text || {@linkplain package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || -.SS CLASS\ AND\ INTERFACE\ TAGS -The following are tags that can appear in the documentation comment for a class or interface\&. The \f3@serial\fR tag can only be used within the documentation for a class or interface with an \f3include\fR or \f3exclude\fR argument\&. -.PP -@see reference || @since since-text || @deprecated deprecated-text || @serial field-description | include | exclude || @author name-text || @version version-text || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || -.PP -Class comment example: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * A class representing a window on the screen\&.\fP -.fi -.nf -\f3 * For example:\fP -.fi -.nf -\f3 * <pre>\fP -.fi -.nf -\f3 * Window win = new Window(parent);\fP -.fi -.nf -\f3 * win\&.show();\fP -.fi -.nf -\f3 * </pre>\fP -.fi -.nf -\f3 *\fP -.fi -.nf -\f3 * @author Sami Shaio\fP -.fi -.nf -\f3 * @version 1\&.13, 06/08/06\fP -.fi -.nf -\f3 * @see java\&.awt\&.BaseWindow\fP -.fi -.nf -\f3 * @see java\&.awt\&.Button\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3class Window extends BaseWindow {\fP -.fi -.nf -\f3 \&.\&.\&.\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS FIELD\ TAGS -These tags can appear in fields: -.PP -@see reference || @since since-text || @deprecated deprecated-text || @serial field-description | include | exclude || @serialField field-name field-type field-description || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || {@value package\&.class#field} -.PP -Field comment example: -.sp -.nf -\f3 /**\fP -.fi -.nf -\f3 * The X\-coordinate of the component\&.\fP -.fi -.nf -\f3 *\fP -.fi -.nf -\f3 * @see #getLocation()\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3 int x = 1263732;\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS CONSTRUCTOR\ AND\ METHOD\ TAGS -The following tags can appear in the documentation comment for a constructor or a method, except for the \f3@return\fR tag, which cannot appear in a constructor, and the \f3{@inheritDoc}\fR tag, which has restrictions\&. -.PP -@see reference || @since since-text || @deprecated deprecated-text || @param parameter-name description || @return description || @throws class-name description || @exception class-name description || @serialData data-description || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@inheritDoc} || {@docRoot} -.PP -\fINote:\fR The \f3@serialData\fR tag can only be used in the documentation comment for the \f3writeObject\fR, \f3readObject\fR, \f3writeExternal\fR, \f3readExternal\fR, \f3writeReplace\fR, and \f3readResolve\fR methods\&. -.PP -Method comment example: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * Returns the character at the specified index\&. An index \fP -.fi -.nf -\f3 * ranges from <code>0</code> to <code>length() \- 1</code>\fP -.fi -.nf -\f3 *\fP -.fi -.nf -\f3 * @param index the index of the desired character\&.\fP -.fi -.nf -\f3 * @return the desired character\&.\fP -.fi -.nf -\f3 * @exception StringIndexOutOfRangeException \fP -.fi -.nf -\f3 * if the index is not in the range <code>0</code> \fP -.fi -.nf -\f3 * to <code>length()\-1</code>\fP -.fi -.nf -\f3 * @see java\&.lang\&.Character#charValue()\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3 public char charAt(int index) {\fP -.fi -.nf -\f3 \&.\&.\&.\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH OPTIONS -The \f3javadoc\fR command uses doclets to determine its output\&. The \f3javadoc\fR command uses the default standard doclet unless a custom doclet is specified with the \f3-doclet\fR option\&. The \f3javadoc\fR command provides a set of command-line options that can be used with any doclet\&. These options are described in Javadoc Options\&. The standard doclet provides an additional set of command-line options that are described in Standard Doclet Options\&. All option names are not case-sensitive, but their arguments are case-sensitive\&. -.TP 0.2i -\(bu -See also Javadoc Options -.TP 0.2i -\(bu -See also Standard Doclet Options -.PP -The options are: -.PP --1\&.1 || -author || -bootclasspath classpathlist || -bottom text || -breakiterator || -charset name || -classpath classpathlist || -d directory || -docencoding name || -docfilesubdirs || -doclet class || -docletpath classpathlist || -doctitle title || -encoding || -exclude packagename1:packagename2:\&.\&.\&. || -excludedocfilessubdir name1:name2 || -extdirs dirist || -footer footer || -group groupheading packagepattern:packagepattern || -header header || -help || -helpfile path\efilename || -Jflag || -javafx ||-keywords || -link extdocURL || -linkoffline extdocURL packagelistLoc || -linksource || -locale language_country_variant || -nocomment || -nodeprecated || -nodeprecatedlist || -nohelp || -noindex || -nonavbar || -noqualifier all | packagename1:packagename2\&.\&.\&. || -nosince || -notimestamp || -notree || -overview path/filename || -package || -private || -protected || -public || -quiet || -serialwarn || -source release || -sourcepath sourcepathlist || -sourcetab tablength || -splitindex || -stylesheet path/filename || -subpackages package1:package2:\&.\&.\&. || -tag tagname:Xaoptcmf:"taghead" || -taglet class || -tagletpath tagletpathlist || -title title || -top || -use || -verbose || -version || -windowtitle title -.PP -The following options are the core Javadoc options that are available to all doclets\&. The standard doclet provides the rest of the doclets: \f3-bootclasspath\fR, \f3-breakiterator\fR, \f3-classpath\fR, \f3-doclet\fR, \f3-docletpath\fR, \f3-encoding\fR, -\f3exclude\fR, \f3-extdirs\fR, \f3-help\fR, \f3-locale\fR, \f3-\fR\f3overview\fR, \f3-package\fR, \f3-private\fR, \f3-protected\fR, \f3-public\fR, \f3-quiet\fR, \f3-source\fR, \f3-sourcepath\fR, \f3-subpackages\fR, and \f3-verbose\fR\&. -.SS JAVADOC\ OPTIONS -.TP --overview \fIpath/filename\fR -.br -Specifies that the \f3javadoc\fR command should retrieve the text for the overview documentation from the source file specified by the \fIpath/filename\fRand place it on the Overview page (overview-summary\&.html)\&. The \fIpath/filename\fRis relative to the current directory\&. - -While you can use any name you want for the \f3filename\fR value and place it anywhere you want for the path, it is typical to name it overview\&.html and place it in the source tree at the directory that contains the topmost package directories\&. In this location, no path is needed when documenting packages, because the \f3-sourcepath\fR option points to this file\&. - -For example, if the source tree for the \f3java\&.lang\fR package is /src/classes/java/lang/, then you could place the overview file at /src/classes/overview\&.html - -See Real-World Examples\&. - -For information about the file specified by \fIpath/filename,\fRsee Overview Comment Files\&. - -The overview page is created only when you pass two or more package names to the \f3javadoc\fR command\&. For a further explanation, see HTML Frames\&. The title on the overview page is set by \f3-doctitle\fR\&. -.TP --Xdoclint:(all|none|[-]\fI<group>\fR) -.br -Reports warnings for bad references, lack of accessibility and missing Javadoc comments, and reports errors for invalid Javadoc syntax and missing HTML tags\&. - -This option enables the \f3javadoc\fR command to check for all documentation comments included in the generated output\&. As always, you can select which items to include in the generated output with the standard options \f3-public\fR, \f3-protected\fR, \f3-package\fR and \f3-private\fR\&. - -When the \f3-Xdoclint\fR is enabled, it reports issues with messages similar to the \f3javac\fR command\&. The \f3javadoc\fR command prints a message, a copy of the source line, and a caret pointing at the exact position where the error was detected\&. Messages may be either warnings or errors, depending on their severity and the likelihood to cause an error if the generated documentation were run through a validator\&. For example, bad references or missing Javadoc comments do not cause the \f3javadoc\fR command to generate invalid HTML, so these issues are reported as warnings\&. Syntax errors or missing HTML end tags cause the \f3javadoc\fR command to generate invalid output, so these issues are reported as errors\&. - -By default, the \f3-Xdoclint\fR option is enabled\&. Disable it with the option \f3-Xdoclint:none\fR\&. - -Change what the \f3-Xdoclint\fR option reports with the following options: -.RS -.TP 0.2i -\(bu -\f3-Xdoclint none\fR : disable the \f3-Xdoclint\fR option -.TP 0.2i -\(bu -\f3-Xdoclint\fR\fIgroup\fR : enable \fIgroup\fR checks -.TP 0.2i -\(bu -\f3-Xdoclint all\fR : enable all groups of checks -.TP 0.2i -\(bu -\f3-Xdoclint all,\fR\fI-group\fR : enable all except \fIgroup\fR checks -.RE - - -The variable \fIgroup\fR has one of the following values: -.RS -.TP 0.2i -\(bu -\f3accessibility\fR : Checks for the issues to be detected by an accessibility checker (for example, no caption or summary attributes specified in a \f3<table>\fR tag)\&. -.TP 0.2i -\(bu -\f3html\fR : Detects high-level HTML issues, like putting block elements inside inline elements, or not closing elements that require an end tag\&. The rules are derived from theHTML 4\&.01 Specification\&. This type of check enables the \f3javadoc\fR command to detect HTML issues that many browsers might accept\&. -.TP 0.2i -\(bu -\f3missing\fR : Checks for missing Javadoc comments or tags (for example, a missing comment or class, or a missing \f3@return\fR tag or similar tag on a method)\&. -.TP 0.2i -\(bu -\f3reference\fR : Checks for issues relating to the references to Java API elements from Javadoc tags (for example, item not found in \f3@see\fR , or a bad name after \f3@param)\fR\&. -.TP 0.2i -\(bu -\f3syntax\fR : Checks for low level issues like unescaped angle brackets (\f3<\fR and \f3>\fR) and ampersands (\f3&\fR) and invalid Javadoc tags\&. -.RE - - -You can specify the \f3-Xdoclint\fR option multiple times to enable the option to check errors and warnings in multiple categories\&. Alternatively, you can specify multiple error and warning categories by using the preceding options\&. For example, use either of the following commands to check for the HTML, syntax, and accessibility issues in the file \fIfilename\fR\&. -.sp -.nf -\f3javadoc \-Xdoclint:html \-Xdoclint:syntax \-Xdoclint:accessibility \fIfilename\fR\fP -.fi -.nf -\f3javadoc \-Xdoclint:html,syntax,accessibility \fIfilename\fR\fP -.fi -.nf -\f3\fP -.fi -.sp - - -\fINote:\fR The \f3javadoc\fR command does not guarantee the completeness of these checks\&. In particular, it is not a full HTML compliance checker\&. The goal of the -\f3Xdoclint\fR option is to enable the \f3javadoc\fR command to report majority of common errors\&. - -The \f3javadoc\fR command does not attempt to fix invalid input, it just reports it\&. -.TP --public -.br -Shows only public classes and members\&. -.TP --protected -.br -Shows only protected and public classes and members\&. This is the default\&. -.TP --package -.br -Shows only package, protected, and public classes and members\&. -.TP --private -.br -Shows all classes and members\&. -.TP --help -.br -Displays the online help, which lists all of the \f3javadoc\fR and \f3doclet\fR command-line options\&. -.TP --doclet \fIclass\fR -.br -Specifies the class file that starts the doclet used in generating the documentation\&. Use the fully qualified name\&. This doclet defines the content and formats the output\&. If the \f3-doclet\fR option is not used, then the \f3javadoc\fR command uses the standard doclet for generating the default HTML format\&. This class must contain the \f3start(Root)\fR method\&. The path to this starting class is defined by the \f3-docletpath\fR option\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html -.TP --docletpath \fIclasspathlist\fR -.br -Specifies the path to the doclet starting class file (specified with the \f3-doclet\fR option) and any JAR files it depends on\&. If the starting class file is in a JAR file, then this option specifies the path to that JAR file\&. You can specify an absolute path or a path relative to the current directory\&. If \f3classpathlist\fR contains multiple paths or JAR files, then they should be separated with a colon (:) on Oracle Solaris and a semi-colon (;) on Windows\&. This option is not necessary when the doclet starting class is already in the search path\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html -.TP --1\&.1 -.br -Removed from Javadoc 1\&.4 with no replacement\&. This option created documentation with the appearance and functionality of documentation generated by Javadoc 1\&.1 (it never supported nested classes)\&. If you need this option, then use Javadoc 1\&.2 or 1\&.3 instead\&. -.TP --source \fIrelease\fR -.br -Specifies the release of source code accepted\&. The following values for the \f3release\fR parameter are allowed\&. Use the value of \f3release\fR that corresponds to the value used when you compile code with the \f3javac\fR command\&. -.RS -.TP 0.2i -\(bu -\fIRelease Value: 1\&.5\fR\&. The \f3javadoc\fR command accepts code containing generics and other language features introduced in JDK 1\&.5\&. The compiler defaults to the 1\&.5 behavior when the \f3-source\fR option is not used\&. -.TP 0.2i -\(bu -\fIRelease Value: 1\&.4\fR\&. The \f3javadoc\fR command accepts code containing assertions, which were introduced in JDK 1\&.4\&. -.TP 0.2i -\(bu -\fIRelease Value: 1\&.3\fR\&. The \f3javadoc\fR command does not support assertions, generics, or other language features introduced after JDK 1\&.3\&. -.RE - -.TP --sourcepath \fIsourcepathlist\fR -.br -Specifies the search paths for finding source files when passing package names or the \f3-subpackages\fR option into the \f3javadoc\fR command\&. Separate multiple paths with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. Note that this option is not only used to locate the source files being documented, but also to find source files that are not being documented, but whose comments are inherited by the source files being documented\&. - -You can use the \f3-sourcepath\fR option only when passing package names into the \f3javadoc\fR command\&. This will not locate source files passed into the \f3javadoc\fR command\&. To locate source files, \f3\fRchange to that directory or include the path ahead of each file, as shown at Document One or More Classes\&. If you omit \f3-sourcepath\fR, then the \f3javadoc\fR command uses the class path to find the source files (see \f3-classpath\fR)\&. The default \f3-sourcepath\fR is the value of class path\&. If \f3-classpath\fR is omitted and you pass package names into the \f3javadoc\fR command, then the \f3javadoc\fR command searches in the current directory and subdirectories for the source files\&. - -Set \f3sourcepathlist\fR to the root directory of the source tree for the package you are documenting\&. - -For example, suppose you want to document a package called \f3com\&.mypackage\fR, whose source files are located at:/home/user/src/com/mypackage/*\&.java\&. Specify the sourcepath to /home/user/src, the directory that contains com\emypackage, and then supply the package name, as follows: -.sp -.nf -\f3javadoc \-sourcepath /home/user/src/ com\&.mypackage\fP -.fi -.nf -\f3\fP -.fi -.sp - - -Notice that if you concatenate the value of sourcepath and the package name together and change the dot to a slash (/), then you have the full path to the package: - -/home/user/src/com/mypackage - -To point to two source paths: -.sp -.nf -\f3javadoc \-sourcepath /home/user1/src:/home/user2/src com\&.mypackage\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --classpath \fIclasspathlist\fR -.br -Specifies the paths where the \f3javadoc\fR command searches for referenced classes These are the documented classes plus any classes referenced by those classes\&. Separate multiple paths with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. Follow the instructions in the class path documentation for specifying the \f3classpathlist\fR value\&. - -If you omit \f3-sourcepath\fR, then the \f3javadoc\fR command uses \f3-classpath\fR to find the source files and class files (for backward compatibility)\&. If you want to search for source and class files in separate paths, then use both \f3-sourcepath\fR and \f3-classpath\fR\&. - -For example, if you want to document \f3com\&.mypackage\fR, whose source files reside in the directory /home/user/src/com/mypackage, and if this package relies on a library in /home/user/lib, then you would use the following command: -.sp -.nf -\f3javadoc \-sourcepath /home/user/lib \-classpath /home/user/src com\&.mypackage\fP -.fi -.nf -\f3\fP -.fi -.sp - - -Similar to other tools, if you do not specify \f3-classpath\fR, then the \f3javadoc\fR command uses the \f3CLASSPATH\fR environment variable when it is set\&. If both are not set, then the \f3javadoc\fR command searches for classes from the current directory\&. - -For an in-depth description of how the \f3javadoc\fR command uses \f3-classpath\fR to find user classes as it relates to extension classes and bootstrap classes, see How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html - -A class path element that contains a base name of * is considered equivalent to specifying a list of all the files in the directory with the extension \f3\&.jar\fR or \f3\&.JAR\fR\&. - -For example, if directory \f3mydir\fR contains \f3a\&.jar\fR and \f3b\&.JA\fRR, then the class path element \f3foo/*\fR is expanded to a \f3A\&.jar:b\&.JAR\fR, except that the order of JAR files is unspecified\&. All JAR files in the specified directory including hidden files are included in the list\&. A class path entry that consists of * expands to a list of all the jar files in the current directory\&. The \f3CLASSPATH\fR environment variable is similarly expanded\&. Any class path wildcard expansion occurs before the Java Virtual Machine (JVM) starts\&. No Java program ever sees unexpanded wild cards except by querying the environment, for example, by calling System\&.getenv(\f3"CLASSPATH"\fR)\&. -.TP --subpackages \fIpackage1:package2:\&.\&.\&.\fR -.br -Generates documentation from source files in the specified packages and recursively in their subpackages\&. This option is useful when adding new subpackages to the source code because they are automatically included\&. Each package argument is any top-level subpackage (such as \f3java\fR) or fully qualified package (such as \f3javax\&.swing\fR) that does not need to contain source files\&. Arguments are separated by colons on all operating systems\&. Wild cards are not allowed\&. Use \f3-sourcepath\fR to specify where to find the packages\&. This option does not process source files that are in the source tree but do not belong to the packages\&. See Process Source Files\&. - -For example, the following command generates documentation for packages named \f3java\fR and \f3javax\&.swing\fR and all of their subpackages\&. -.sp -.nf -\f3javadoc \-d docs \-sourcepath /home/user/src \-subpackages java:javax\&.swing \fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --exclude \fIpackagename1:packagename2:\&.\&.\&.\fR -.br -Unconditionally excludes the specified packages and their subpackages from the list formed by \f3-subpackages\fR\&. It excludes those packages even when they would otherwise be included by some earlier or later \f3-subpackages\fR option\&. - -The following example would include \f3java\&.io\fR, \f3java\&.util\fR, and \f3java\&.math\fR (among others), but would exclude packages rooted at \f3java\&.net\fR and \f3java\&.lang\fR\&. Notice that this example excludes \f3java\&.lang\&.ref\fR, which is a subpackage of \f3java\&.lang\fR\&. -.sp -.nf -\f3javadoc \-sourcepath /home/user/src \-subpackages java \-exclude \fP -.fi -.nf -\f3 java\&.net:java\&.lang\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --bootclasspath \fIclasspathlist\fR -.br -Specifies the paths where the boot classes reside\&. These are typically the Java platform classes\&. The \f3bootclasspath\fR is part of the search path the \f3javadoc\fR command uses to look up source and class files\&. For more information, see How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html - -Separate directories in the \f3classpathlist\fR parameters with semicolons (;) for Windows and colons (:) for Oracle Solaris\&. -.TP --extdirs \fIdirist\fR -.br -Specifies the directories where extension classes reside\&. These are any classes that use the Java Extension mechanism\&. The \f3extdirs\fR option is part of the search path the \f3javadoc\fR command uses to look up source and class files\&. See the \f3-classpath\fR option for more information\&. Separate directories in \f3dirlist\fR with semicolons (;) for Windows and colons (:) for Oracle Solaris\&. -.TP --verbose -.br -Provides more detailed messages while the \f3javadoc\fR command runs\&. Without the \f3verbose\fR option, messages appear for loading the source files, generating the documentation (one message per source file), and sorting\&. The verbose option causes the printing of additional messages that specify the number of milliseconds to parse each Java source file\&. -.TP --quiet -.br -Shuts off messages so that only the warnings and errors appear to make them easier to view\&. It also suppresses the \f3version\fR string\&. -.TP --breakiterator -.br -Uses the internationalized sentence boundary of \f3java\&.text\&.BreakIterator\fR to determine the end of the first sentence in the main description of a package, class, or member for English\&. All other locales already use the \f3BreakIterator\fR class, rather than an English language, locale-specific algorithm\&. The first sentence is copied to the package, class, or member summary and to the alphabetic index\&. From JDK 1\&.2 and later, the \f3BreakIterator\fR class is used to determine the end of a sentence for all languages except for English\&. Therefore, the \f3-breakiterator\fR option has no effect except for English from 1\&.2 and later\&. English has its own default algorithm: -.RS -.TP 0.2i -\(bu -English default sentence-break algorithm\&. Stops at a period followed by a space or an HTML block tag, such as \f3<P>\fR\&. -.TP 0.2i -\(bu -Breakiterator sentence-break algorithm\&. Stops at a period, question mark, or exclamation point followed by a space when the next word starts with a capital letter\&. This is meant to handle most abbreviations (such as "The serial no\&. is valid", but will not handle "Mr\&. Smith")\&. The \f3-breakiterator\fR option does not stop at HTML tags or sentences that begin with numbers or symbols\&. The algorithm stops at the last period in \&.\&./filename, even when embedded in an HTML tag\&. -.RE - - -In Java SE 1\&.5 the \f3-breakiterator\fR option warning messages are removed, and the default sentence-break algorithm is unchanged\&. If you have not modified your source code to eliminate the \f3-breakiterator\fR option warnings in Java SE 1\&.4\&.x, then you do not have to do anything\&. The warnings go away starting with Java SE 1\&.5\&.0\&. -.TP --locale \fIlanguage_country_variant\fR -.br -Specifies the locale that the \f3javadoc\fR command uses when it generates documentation\&. The argument is the name of the locale, as described in \f3j\fR\f3ava\&.util\&.Locale\fR documentation, such as \f3en_US\fR (English, United States) or \f3en_US_WIN\fR (Windows variant)\&. - -\fINote:\fR The \f3-locale\fR option must be placed ahead (to the left) of any options provided by the standard doclet or any other doclet\&. Otherwise, the navigation bars appear in English\&. This is the only command-line option that depends on order\&. See Standard Doclet Options\&. - -Specifying a locale causes the \f3javadoc\fR command to choose the resource files of that locale for messages such as strings in the navigation bar, headings for lists and tables, help file contents, comments in the stylesheet\&.css file, and so on\&. It also specifies the sorting order for lists sorted alphabetically, and the sentence separator to determine the end of the first sentence\&. The \f3-locale\fR option does not determine the locale of the documentation comment text specified in the source files of the documented classes\&. -.TP --encoding -.br -Specifies the encoding name of the source files, such as \f3EUCJIS/SJIS\fR\&. If this option is not specified, then the platform default converter is used\&. See also the\f3-docencoding name\fR and \f3-charset name\fR options\&. -.TP --J\fIflag\fR -.br -Passes \f3flag\fR directly to the Java Runtime Environment (JRE) that runs the \f3javadoc\fR command\&. For example, if you must ensure that the system sets aside 32 MB of memory in which to process the generated documentation, then you would call the \f3-Xmx\fR option as follows: \f3javadoc -J-Xmx32m -J-Xms32m com\&.mypackage\fR\&. Be aware that \f3-Xms\fR is optional because it only sets the size of initial memory, which is useful when you know the minimum amount of memory required\&. - -There is no space between the \f3J\fR and the \f3flag\fR\&. - -Use the \f3-version\fR option to find out what version of the \f3javadoc\fR command you are using\&. The version number of the standard doclet appears in its output stream\&. See Running the Javadoc Command\&. -.sp -.nf -\f3javadoc \-J\-version\fP -.fi -.nf -\f3java version "1\&.7\&.0_09"\fP -.fi -.nf -\f3Java(TM) SE Runtime Environment (build 1\&.7\&.0_09\-b05)\fP -.fi -.nf -\f3Java HotSpot(TM) 64\-Bit Server VM (build 23\&.5\-b02, mixed mode)\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --javafx -.br -Generates HTML documentation using the JavaFX extensions to the standard doclet\&. The generated documentation includes a Property Summary section in addition to the other summary sections generated by the standard Java doclet\&. The listed properties are linked to the sections for the getter and setter methods of each property\&. - -If there are no documentation comments written explicitly for getter and setter methods, the documentation comments from the property method are automatically copied to the generated documentation for these methods\&. This option also adds a new \f3@defaultValue\fR tag that allows documenting the default value for a property\&. - -Example: -.sp -.nf -\f3javadoc \-javafx MyClass\&.java \-d testdir\fP -.fi -.sp - -.SS STANDARD\ DOCLET\ OPTIONS -.TP --d \fIdirectory\fR -.br -Specifies the destination directory where the \f3javadoc\fR command saves the generated HTML files\&. If you omit the \f3-d\fR option, then the files are saved to the current directory\&. The \f3directory\fR value can be absolute or relative to the current working directory\&. As of Java SE 1\&.4, the destination directory is automatically created when the \f3javadoc\fR command runs\&. - -For example, the following command generates the documentation for the package \f3com\&.mypackage\fR and saves the results in the /user/doc/ directory: \f3javadoc -d\fR\f3/user/doc/\fR\f3com\&.mypackage\fR\&. -.TP --use -.br -Includes one Use page for each documented class and package\&. The page describes what packages, classes, methods, constructors and fields use any API of the specified class or package\&. Given class C, things that use class C would include subclasses of C, fields declared as C, methods that return C, and methods and constructors with parameters of type C\&. For example, you can look at the Use page for the \f3String\fR type\&. Because the \f3getName\fR method in the \f3java\&.awt\&.Font\fR class returns type \f3String\fR, the \f3getName\fR method uses \f3String\fR and so the \f3getName\fR method appears on the Use page for \f3String\fR\&.This documents only uses of the API, not the implementation\&. When a method uses \f3String\fR in its implementation, but does not take a string as an argument or return a string, that is not considered a use of \f3String\fR\&.To access the generated Use page, go to the class or package and click the \fIUse link\fR in the navigation bar\&. -.TP --version -.br -Includes the @version text in the generated docs\&. This text is omitted by default\&. To find out what version of the \f3javadoc\fR command you are using, use the \f3-J-version\fR option\&. -.TP --author -.br -Includes the \f3@author\fR text in the generated docs\&. -.TP --splitindex -.br -Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical symbols\&. -.TP --windowtitle \fItitle\fR -.br -Specifies the title to be placed in the HTML \f3<title>\fR tag\&. The text specified in the \f3title\fR tag appears in the window title and in any browser bookmarks (favorite places) that someone creates for this page\&. This title should not contain any HTML tags because the browser does not interpret them correctly\&. Use escape characters on any internal quotation marks within the \f3title\fR tag\&. If the \f3-windowtitle\fR option is omitted, then the \f3javadoc\fR command uses the value of the \f3-doctitle\fR option for the \f3-windowtitle\fR option\&. For example, \f3javadoc -windowtitle "Java SE Platform" com\&.mypackage\fR\&. -.TP --doctitle \fItitle\fR -.br -Specifies the title to place near the top of the overview summary file\&. The text specified in the \f3title\fR tag is placed as a centered, level-one heading directly beneath the top navigation bar\&. The \f3title\fR tag can contain HTML tags and white space, but when it does, you must enclose the title in quotation marks\&. Internal quotation marks within the \f3title\fR tag must be escaped\&. For example, \f3javadoc -header "<b>Java Platform </b><br>v1\&.4" com\&.mypackage\&.\fR -.TP --title \fItitle\fR -.br -No longer exists\&. It existed only in Beta releases of Javadoc 1\&.2\&. It was renamed to \f3-doctitle\fR\&. This option was renamed to make it clear that it defines the document title, rather than the window title\&. -.TP --header \fIheader\fR -.br -Specifies the header text to be placed at the top of each output file\&. The header is placed to the right of the upper navigation bar\&. The \f3header\fR can contain HTML tags and white space, but when it does, the \f3header\fR must be enclosed in quotation marks\&. Use escape characters for internal quotation marks within a header\&. For example, \f3javadoc -header "<b>Java Platform </b><br>v1\&.4" com\&.mypackage\&.\fR -.TP --footer \fIfooter\fR -.br -Specifies the footer text to be placed at the bottom of each output file\&. The \fIfooter\fR value is placed to the right of the lower navigation bar\&. The \f3footer\fR value can contain HTML tags and white space, but when it does, the \f3footer\fR value must be enclosed in quotation marks\&. Use escape characters for any internal quotation marks within a footer\&. -.TP --top -.br -Specifies the text to be placed at the top of each output file\&. -.TP --bottom \fItext\fR -.br -Specifies the text to be placed at the bottom of each output file\&. The text is placed at the bottom of the page, underneath the lower navigation bar\&. The text can contain HTML tags and white space, but when it does, the text must be enclosed in quotation marks\&. Use escape characters for any internal quotation marks within text\&. -.TP --link \fIextdocURL\fR -.br -Creates links to existing Javadoc-generated documentation of externally referenced classes\&. The \fIextdocURL\fR argument is the absolute or relative URL of the directory that contains the external Javadoc-generated documentation you want to link to\&. You can specify multiple \f3-link\fR options in a specified \f3javadoc\fR command run to link to multiple documents\&. - -The package-list file must be found in this directory (otherwise, use the \f3-linkoffline\fR option)\&. The \f3javadoc\fR command reads the package names from the package-list file and links to those packages at that URL\&. When the \f3javadoc\fR command runs, the \f3extdocURL\fR value is copied into the \f3<A HREF>\fR links that are created\&. Therefore, \f3extdocURL\fR must be the URL to the directory, and not to a file\&. You can use an absolute link for \fIextdocURL\fR to enable your documents to link to a document on any web site, or you can use a relative link to link only to a relative location\&. If you use a relative link, then the value you pass in should be the relative path from the destination directory (specified with the \f3-d\fR option) to the directory containing the packages being linked to\&.When you specify an absolute link, you usually use an HTTP link\&. However, if you want to link to a file system that has no web server, then you can use a file link\&. Use a file link only when everyone who wants to access the generated documentation shares the same file system\&.In all cases, and on all operating systems, use a slash as the separator, whether the URL is absolute or relative, and \f3h\fR\f3ttp:\fR or \f3f\fR\f3ile:\fR as specified in the URL Memo: Uniform Resource Locators at http://www\&.ietf\&.org/rfc/rfc1738\&.txt -.sp -.nf -\f3\-link http://<host>/<directory>/<directory>/\&.\&.\&./<name>\fP -.fi -.nf -\f3\-link file://<host>/<directory>/<directory>/\&.\&.\&./<name>\fP -.fi -.nf -\f3\-link <directory>/<directory>/\&.\&.\&./<name>\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Differences between the -linkoffline and -link options - -Use the \f3-link\fR option in the following cases: -.TP 0.2i -\(bu -When you use a relative path to the external API document\&. -.TP 0.2i -\(bu -When you use an absolute URL to the external API document if your shell lets you open a connection to that URL for reading\&. -.PP -Use the \f3-linkoffline\fR option when you use an absolute URL to the external API document, if your shell does not allow a program to open a connection to that URL for reading\&. This can occur when you are behind a firewall and the document you want to link to is on the other side\&. -.PP -\f3Example 1 Absolute Link to External Documents\fR -.PP -Use the following command if you want to link to the \f3java\&.lang\fR, \f3java\&.io\fR and other Java platform packages, shown at http://docs\&.oracle\&.com/javase/8/docs/api/index\&.html -.sp -.nf -\f3javadoc \-link http://docs\&.oracle\&.com/javase/8/docs/api/ com\&.mypackage\fP -.fi -.nf -\f3\fP -.fi -.sp -The command generates documentation for the package \f3com\&.mypackage\fR with links to the Java SE packages\&. The generated documentation contains links to the \f3Object\fR class, for example, in the class \f3trees\fR\&. Other options, such as the \f3-sourcepath\fR and \f3-d\fR options, are not shown\&. -.PP -\f3Example 2 Relative Link to External Documents\fR -.PP -In this example, there are two packages with documents that are generated in different runs of the \f3javadoc\fR command, and those documents are separated by a relative path\&. The packages are \f3com\&.apipackage\fR, an API, and c\f3om\&.spipackage\fR, an Service Provide Interface (SPI)\&. You want the documentation to reside in docs/api/com/apipackage and docs/spi/com/spipackage\&. Assuming that the API package documentation is already generated, and that docs is the current directory, you document the SPI package with links to the API documentation by running: \f3javadoc -d \&./spi -link \&.\&./api com\&.spipackage\fR\&. -.PP -Notice the \f3-link\fR option is relative to the destination directory (docs/spi)\&. -.PP -Notes - -The \f3-link\fR option lets you link to classes referenced to by your code, but not documented in the current \f3javadoc\fR command run\&. For these links to go to valid pages, you must know where those HTML pages are located and specify that location with \f3extdocURL\fR\&. This allows third-party documentation to link to java\&.* documentation at http://docs\&.oracle\&.com\&.Omit the \f3-link\fR option when you want the \f3javadoc\fR command to create links only to APIs within the documentation it is generating in the current run\&. Without the \f3-link\fR option, the \f3javadoc\fR command does not create links to documentation for external references because it does not know whether or where that documentation exists\&.The \f3-link\fR option can create links in several places in the generated documentation\&. See Process Source Files\&. Another use is for cross-links between sets of packages: Execute the \f3javadoc\fR command on one set of packages, then run the \f3javadoc\fR command again on another set of packages, creating links both ways between both sets\&. -.PP -How to Reference a Class - -For a link to an externally referenced class to appear (and not just its text label), the class must be referenced in the following way\&. It is not sufficient for it to be referenced in the body of a method\&. It must be referenced in either an \f3import\fR statement or in a declaration\&. Here are examples of how the class \f3java\&.io\&.File\fR can be referenced: -.PP -\fI\fRIn any kind of import statement\&. By wildcard import, import explicitly by name, or automatically import for \f3java\&.lang\&.*\fR\&. -.PP -In Java SE 1\&.3\&.\fIn\fR and 1\&.2\&.\fIn\fR, only an explicit import by name works\&. A wildcard \f3import\fR statement does not work, nor does the automatic \f3import java\&.lang\&.*\fR\&. -.PP -\fI\fRIn a declaration: \f3void mymethod(File f) {}\fR -.PP -The reference can be in the return type or parameter type of a method, constructor, field, class, or interface, or in an implements, extends, or throws statement\&. -.PP -An important corollary is that when you use the \f3-link\fR option, there can be many links that unintentionally do not appear due to this constraint\&. The text would appear without being a link\&. You can detect these by the warnings they emit\&. The simplest way to properly reference a class and add the link would be to import that class\&. -.PP -Package List - -The \f3-link\fR option requires that a file named package-list, which is generated by the \f3javadoc\fR command, exists at the URL you specify with the \f3-link\fR option\&. The package-list file is a simple text file that lists the names of packages documented at that location\&. In the earlier example, the \f3javadoc\fR command searches for a file named package-list at the specified URL, reads in the package names, and links to those packages at that URL\&. -.PP -For example, the package list for the Java SE API is located at http://docs\&.oracle\&.com/javase/8/docs/api/package-list -.PP -The package list starts as follows: -.sp -.nf -\f3java\&.applet\fP -.fi -.nf -\f3java\&.awt\fP -.fi -.nf -\f3java\&.awt\&.color\fP -.fi -.nf -\f3java\&.awt\&.datatransfer\fP -.fi -.nf -\f3java\&.awt\&.dnd\fP -.fi -.nf -\f3java\&.awt\&.event\fP -.fi -.nf -\f3java\&.awt\&.font\fP -.fi -.nf -\f3and so on \&.\&.\&.\&.\fP -.fi -.nf -\f3\fP -.fi -.sp -When \f3javadoc\fR is run without the \f3-link\fR option and encounters a name that belongs to an externally referenced class, it prints the name with no link\&. However, when the \f3-link\fR option is used, the \f3javadoc\fR command searches the package-list file at the specified \fIextdocURL\fR location for that package name\&. When it finds the package name, it prefixes the name with \fIextdocURL\fR\&. -.PP -For there to be no broken links, all of the documentation for the external references must exist at the specified URLs\&. The \f3javadoc\fR command does not check that these pages exist, but only that the package-list exists\&. -.PP -Multiple Links - -You can supply multiple \f3-link\fR options to link to any number of externally generated documents\&. Javadoc 1\&.2 has a known bug that prevents you from supplying more than one \f3-link\fR options\&. This was fixed in Javadoc 1\&.2\&.2\&. Specify a different link option for each external document to link to \f3javadoc -link extdocURL1 -link extdocURL2 \&.\&.\&. -link extdocURLn com\&.mypackage\fR where \fIextdocURL1\fR, \fIextdocURL2\fR, \&.\f3\&.\&. extdocURLn\fR point respectively to the roots of external documents, each of which contains a file named package-list\&. -.PP -Cross Links - -Note that bootstrapping might be required when cross-linking two or more documents that were previously generated\&. If package-list does not exist for either document when you run the \f3javadoc\fR command on the first document, then the package-list does not yet exist for the second document\&. Therefore, to create the external links, you must regenerate the first document after you generate the second document\&. -.PP -In this case, the purpose of first generating a document is to create its package-list (or you can create it by hand if you are certain of the package names)\&. Then, generate the second document with its external links\&. The \f3javadoc\fR command prints a warning when a needed external package-list file does not exist\&. -.TP --linkoffline \fIextdocURL packagelistLoc\fR -.br -This option is a variation of the \f3-link\fR option\&. They both create links to Javadoc-generated documentation for externally referenced classes\&. Use the \f3-link\fRo\f3ffline\fR option when linking to a document on the web when the \f3javadoc\fR command cannot access the document through a web connection\&. Use the \f3-linkoffline\fR option when package-list file of the external document is not accessible or does not exist at the \f3extdocURL\fR location, but does exist at a different location that can be specified by \f3packageListLoc\fR (typically local)\&. If \f3extdocURL\fR is accessible only on the World Wide Web, then the \f3-linkoffline\fR option removes the constraint that the \f3javadoc\fR command must have a web connection to generate documentation\&. Another use is as a work-around to update documents: After you have run the \f3javadoc\fR command on a full set of packages, you can run the \f3javadoc\fR command again on a smaller set of changed packages, so that the updated files can be inserted back into the original set\&. Examples follow\&. The \f3-linkoffline\fR option takes two arguments\&. The first is for the string to be embedded in the \f3<a href>\fR links, and the second tells the \f3-linkoffline\fR option where to find package-list: -.RS -.TP 0.2i -\(bu -The \f3extdocURL\fR value is the absolute or relative URL of the directory that contains the external Javadoc-generated documentation you want to link to\&. When relative, the value should be the relative path from the destination directory (specified with the \f3-d\fR option) to the root of the packages being linked to\&. For more information, see \fIextdocURL\fR in the \f3-link\fR option\&. -.TP 0.2i -\(bu -The \f3packagelistLoc\fR value is the path or URL to the directory that contains the package-list file for the external documentation\&. This can be a URL (http: or file:) or file path, and can be absolute or relative\&. When relative, make it relative to the current directory from where the \f3javadoc\fR command was run\&. Do not include the package-list file name\&. - -You can specify multiple \f3-linkoffline\fR options in a specified \f3javadoc\fR command run\&. Before Javadoc 1\&.2\&.2, the \f3-linkfile\fR options could be specified once\&. -.RE - -.PP -Absolute Links to External Documents - -You might have a situation where you want to link to the \f3java\&.lang\fR, \f3java\&.io\fR and other Java SE packages at http://docs\&.oracle\&.com/javase/8/docs/api/index\&.html -.PP -However, your shell does not have web access\&. In this case, do the following: -.TP 0.4i -1\&. -Open the package-list file in a browser at http://docs\&.oracle\&.com/javase/8/docs/api/package-list -.TP 0.4i -2\&. -Save the file to a local directory, and point to this local copy with the second argument, \f3packagelistLoc\fR\&. In this example, the package list file was saved to the current directory (\&.)\&. -.PP -The following command generates documentation for the package c\f3om\&.mypackage\fR with links to the Java SE packages\&. The generated documentation will contain links to the \f3Object\fR class, for example, in the class \f3trees\fR\&. Other necessary options, such as \f3-sourcepath\fR, are not shown\&. -.sp -.nf -\f3javadoc \-linkoffline http://docs\&.oracle\&.com/javase/8/docs/api/ \&. com\&.mypackage \fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Relative Links to External Documents - -It is not very common to use \f3-linkoffline\fR with relative paths, for the simple reason that the \f3-link\fR option is usually enough\&. When you use the \f3-linkoffline\fR option, the package-list file is usually local, and when you use relative links, the file you are linking to is also local, so it is usually unnecessary to give a different path for the two arguments to the \f3-linkoffline\fR option When the two arguments are identical, you can use the \f3-link\fR option\&. -.PP -Create a package-list File Manually - -If a package-list file does not exist yet, but you know what package names your document will link to, then you can manually create your own copy of this file and specify its path with \f3packagelistLoc\fR\&. An example would be the previous case where the package list for \f3com\&.spipackage\fR did not exist when \f3com\&.apipackage\fR was first generated\&. This technique is useful when you need to generate documentation that links to new external documentation whose package names you know, but which is not yet published\&. This is also a way of creating package-list files for packages generated with Javadoc 1\&.0 or 1\&.1, where package-list files were not generated\&. Similarly, two companies can share their unpublished package-list files so they can release their cross-linked documentation simultaneously\&. -.PP -Link to Multiple Documents - -You can include the \f3-linkoffline\fR option once for each generated document you want to refer to: -.sp -.nf -\f3javadoc \-linkoffline extdocURL1 packagelistLoc1 \-linkoffline extdocURL2\fP -.fi -.nf -\f3packagelistLoc2 \&.\&.\&.\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Update Documents - -You can also use the \f3-linkoffline\fR option when your project has dozens or hundreds of packages\&. If you have already run the \f3javadoc\fR command on the entire source tree, then you can quickly make small changes to documentation comments and rerun the \f3javadoc\fR command on a portion of the source tree\&. Be aware that the second run works properly only when your changes are to documentation comments and not to declarations\&. If you were to add, remove, or change any declarations from the source code, then broken links could show up in the index, package tree, inherited member lists, Use page, and other places\&. -.PP -First, create a new destination directory, such as update, for this new small run\&. In this example, the original destination directory is named html\&. In the simplest example, change directory to the parent of html\&. Set the first argument of the \f3-linkoffline\fR option to the current directory (\&.) and set the second argument to the relative path to html, where it can find package-list and pass in only the package names of the packages you want to update: -.sp -.nf -\f3javadoc \-d update \-linkoffline \&. html com\&.mypackage\fP -.fi -.nf -\f3\fP -.fi -.sp -When the \f3javadoc\fR command completes, copy these generated class pages in update/com/package (not the overview or index) to the original files in html/com/package\&. -.TP --linksource -.br -Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation\&. Links are created for classes, interfaces, constructors, methods, and fields whose declarations are in a source file\&. Otherwise, links are not created, such as for default constructors and generated classes\&. - -This option exposes all private implementation details in the included source files, including private classes, private fields, and the bodies of private methods, regardless of the \f3-public\fR, \f3-package\fR, \f3-protected\fR, and \f3-private\fR options\&. Unless you also use the \f3-private\fR option, not all private classes or interfaces are accessible through links\&. - -Each link appears on the name of the identifier in its declaration\&. For example, the link to the source code of the \f3Button\fR class would be on the word \f3Button\fR: -.sp -.nf -\f3public class Button extends Component implements Accessible\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The link to the source code of the \f3getLabel\fR method in the \f3Button\fR class is on the word \f3getLabel\fR: -.sp -.nf -\f3public String getLabel()\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --group groupheading \fIpackagepattern:packagepattern\fR -.br -Separates packages on the overview page into whatever groups you specify, one group per table\&. You specify each group with a different \f3-group\fR option\&. The groups appear on the page in the order specified on the command line\&. Packages are alphabetized within a group\&. For a specified \f3-group\fR option, the packages matching the list of \f3packagepattern\fR expressions appear in a table with the heading \fIgroupheading\fR\&. -.RS -.TP 0.2i -\(bu -The \f3groupheading\fR can be any text and can include white space\&. This text is placed in the table heading for the group\&. -.TP 0.2i -\(bu -The \f3packagepattern\fR value can be any package name at the start of any package name followed by an asterisk (*)\&. The asterisk is the only wildcard allowed and means match any characters\&. Multiple patterns can be included in a group by separating them with colons (:)\&. If you use an asterisk in a pattern or pattern list, then the pattern list must be inside quotation marks, such as \f3"java\&.lang*:java\&.util"\fR\&. -.RE - - -When you do not supply a \f3-group\fR option, all packages are placed in one group with the heading \fIPackages\fR and appropriate subheadings\&. If the subheadings do not include all documented packages (all groups), then the remaining packages appear in a separate group with the subheading Other Packages\&. - -For example, the following \f3javadoc\fR command separates the three documented packages into \fICore\fR, \fIExtension\fR, and \fIOther Packages\fR\&. The trailing dot (\&.) does not appear in \f3java\&.lang*\fR\&. Including the dot, such as \f3java\&.lang\&.*\fR omits the\f3java\&.lang\fR package\&. -.sp -.nf -\f3javadoc \-group "Core Packages" "java\&.lang*:java\&.util"\fP -.fi -.nf -\f3 \-group "Extension Packages" "javax\&.*"\fP -.fi -.nf -\f3 java\&.lang java\&.lang\&.reflect java\&.util javax\&.servlet java\&.new\fP -.fi -.nf -\f3\fP -.fi -.sp - - -\fICore Packages\fR - -\f3java\&.lang\fR - -\f3java\&.lang\&.reflect\fR - -\f3java\&.util\fR - -\fIExtension Packages\fR - -\f3javax\&.servlet\fR - -\fIOther Packages\fR - -\f3java\&.new\fR -.TP --nodeprecated -.br -Prevents the generation of any deprecated API in the documentation\&. This does what the \f3-nodeprecatedlist\fR option does, and it does not generate any deprecated API throughout the rest of the documentation\&. This is useful when writing code when you do not want to be distracted by the deprecated code\&. -.TP --nodeprecatedlist -.br -Prevents the generation of the file that contains the list of deprecated APIs (deprecated-list\&.html) and the link in the navigation bar to that page\&. The \f3javadoc\fR command continues to generate the deprecated API throughout the rest of the document\&. This is useful when your source code contains no deprecated APIs, and you want to make the navigation bar cleaner\&. -.TP --nosince -.br -Omits from the generated documents the \f3Since\fR sections associated with the \f3@since\fR tags\&. -.TP --notree -.br -Omits the class/interface hierarchy pages from the generated documents\&. These are the pages you reach using the Tree button in the navigation bar\&. The hierarchy is produced by default\&. -.TP --noindex -.br -Omits the index from the generated documents\&. The index is produced by default\&. -.TP --nohelp -.br -Omits the HELP link in the navigation bars at the top and bottom of each page of output\&. -.TP --nonavbar -.br -Prevents the generation of the navigation bar, header, and footer, that are usually found at the top and bottom of the generated pages\&. The \f3-nonavbar\fR option has no affect on the \f3-bottom\fR option\&. The \f3-nonavbar\fR option is useful when you are interested only in the content and have no need for navigation, such as when you are converting the files to PostScript or PDF for printing only\&. -.TP --helpfile \fIpath\efilename\fR -.br -Specifies the path of an alternate help file path\efilename that the HELP link in the top and bottom navigation bars link to\&. Without this option, the \f3javadoc\fR command creates a help file help-doc\&.html that is hard-coded in the \f3javadoc\fR command\&. This option lets you override the default\&. The file name can be any name and is not restricted to help-doc\&.html\&. The \f3javadoc\fR command adjusts the links in the navigation bar accordingly, for example: -.sp -.nf -\f3javadoc \-helpfile /home/user/myhelp\&.html java\&.awt\&.\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --stylesheet \fIpath/filename\fR -.br -Specifies the path of an alternate HTML stylesheet file\&. Without this option, the \f3javadoc\fR command automatically creates a stylesheet file stylesheet\&.css that is hard-coded in the \f3javadoc\fR command\&. This option lets you override the default\&. The file name can be any name and is not restricted to stylesheet\&.css, for example: -.sp -.nf -\f3javadoc \-stylesheet file /home/user/mystylesheet\&.css com\&.mypackage\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --serialwarn -.br -Generates compile-time warnings for missing \f3@serial\fR tags\&. By default, Javadoc 1\&.2\&.2 and later versions generate no serial warnings\&. This is a reversal from earlier releases\&. Use this option to display the serial warnings, which helps to properly document default serializable fields and \f3writeExternal\fR methods\&. -.TP --charset \fIname\fR -.br -Specifies the HTML character set for this document\&. The name should be a preferred MIME name as specified in the IANA Registry, Character Sets at http://www\&.iana\&.org/assignments/character-sets - -For example, \f3javadoc -charset "iso-8859-1" mypackage\fR inserts the following line in the head of every generated page: -.sp -.nf -\f3<META http\-equiv="Content\-Type" content="text/html; charset=ISO\-8859\-1">\fP -.fi -.nf -\f3\fP -.fi -.sp - - -This \f3META\fR tag is described in the HTML standard (4197265 and 4137321), HTML Document Representation, at http://www\&.w3\&.org/TR/REC-html40/charset\&.html#h-5\&.2\&.2 - -See also the \f3-encoding\fR and \f3-docencoding name\fR options\&. -.TP --docencoding \fIname\fR -.br -Specifies the encoding of the generated HTML files\&. The name should be a preferred MIME name as specified in the IANA Registry, Character Sets at http://www\&.iana\&.org/assignments/character-sets - -If you omit the \f3-docencoding\fR option but use the \f3-encoding\fR option, then the encoding of the generated HTML files is determined by the \f3-encoding\fR option, for example: \f3javadoc -docencoding "iso-8859-1" mypackage\fR\&. See also the \f3-encoding\fR and \f3-docencoding name\fR options\&. -.TP --keywords -.br -Adds HTML keyword <META> tags to the generated file for each class\&. These tags can help search engines that look for <META> tags find the pages\&. Most search engines that search the entire Internet do not look at <META> tags, because pages can misuse them\&. Search engines offered by companies that confine their searches to their own website can benefit by looking at <META> tags\&. The <META> tags include the fully qualified name of the class and the unqualified names of the fields and methods\&. Constructors are not included because they are identical to the class name\&. For example, the class \f3String\fR starts with these keywords: -.sp -.nf -\f3<META NAME="keywords" CONTENT="java\&.lang\&.String class">\fP -.fi -.nf -\f3<META NAME="keywords" CONTENT="CASE_INSENSITIVE_ORDER">\fP -.fi -.nf -\f3<META NAME="keywords" CONTENT="length()">\fP -.fi -.nf -\f3<META NAME="keywords" CONTENT="charAt()">\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --tag \fItagname\fR:Xaoptcmf:"\fItaghead\fR" -.br -Enables the \f3javadoc\fR command to interpret a simple, one-argument \f3@tagname\fR custom block tag in documentation comments\&. For the \f3javadoc\fR command to spell-check tag names, it is important to include a \f3-tag\fR option for every custom tag that is present in the source code, disabling (with \f3X\fR) those that are not being output in the current run\&.The colon (:) is always the separator\&. The \f3-tag\fR option outputs the tag heading \fItaghead\fR in bold, followed on the next line by the text from its single argument\&. Similar to any block tag, the argument text can contain inline tags, which are also interpreted\&. The output is similar to standard one-argument tags, such as the \f3@return\fR and \f3@author\fR tags\&. Omitting a value for \fItaghead\fR causes \f3tagname\fR to be the heading\&. - -\fIPlacement of tags\fR: The \f3Xaoptcmf\fR arguments determine where in the source code the tag is allowed to be placed, and whether the tag can be disabled (using \f3X\fR)\&. You can supply either \f3a\fR, to allow the tag in all places, or any combination of the other letters: - -\f3X\fR (disable tag) - -\f3a\fR (all) - -\f3o\fR (overview) - -\f3p\fR (packages) - -\f3t\fR (types, that is classes and interfaces) - -\f3c\fR (constructors) - -\f3m\fR (methods) - -\f3f\fR (fields) - -\fIExamples of single tags\fR: An example of a tag option for a tag that can be used anywhere in the source code is: \f3-tag todo:a:"To Do:"\fR\&. - -If you want the \f3@todo\fR tag to be used only with constructors, methods, and fields, then you use: \f3-tag todo:cmf:"To Do:"\fR\&. - -Notice the last colon (:) is not a parameter separator, but is part of the heading text\&. You would use either tag option for source code that contains the \f3@todo\fR tag, such as: \f3@todo The documentation for this method needs work\fR\&. - -\fIColons in tag names\fR: Use a backslash to escape a colon that you want to use in a tag name\&. Use the \f3-tag ejb\e\e:bean:a:"EJB Bean:"\fR option for the following documentation comment: -.sp -.nf -\f3/**\fP -.fi -.nf -\f3 * @ejb:bean\fP -.fi -.nf -\f3 */\fP -.fi -.nf -\f3\fP -.fi -.sp - - -\fISpell-checking tag names\fR: Some developers put custom tags in the source code that they do not always want to output\&. In these cases, it is important to list all tags that are in the source code, enabling the ones you want to output and disabling the ones you do not want to output\&. The presence of \f3X\fR disables the tag, while its absence enables the tag\&. This gives the \f3javadoc\fR command enough information to know whether a tag it encounters is unknown, which is probably the results of a typographical error or a misspelling\&. The \f3javadoc\fR command prints a warning in these cases\&. You can add \f3X\fR to the placement values already present, so that when you want to enable the tag, you can simply delete the \f3X\fR\&. For example, if the \f3@todo\fR tag is a tag that you want to suppress on output, then you would use: \f3-tag todo:Xcmf:"To Do:"\fR\&. If you would rather keep it simple, then use this: \f3-tag todo:X\fR\&. The syntax \f3-tag todo:X\fR works even when the \f3@todo\fR tag is defined by a taglet\&. - -\fIOrder of tags\fR: The order of the \f3-ta\fR\f3g\fR and \f3-taglet\fR options determines the order the tags are output\&. You can mix the custom tags with the standard tags to intersperse them\&. The tag options for standard tags are placeholders only for determining the order\&. They take only the standard tag\&'s name\&. Subheadings for standard tags cannot be altered\&. This is illustrated in the following example\&.If the \f3-tag\fR option is missing, then the position of the \f3-tagle\fR\f3t\fR option determines its order\&. If they are both present, then whichever appears last on the command line determines its order\&. This happens because the tags and taglets are processed in the order that they appear on the command line\&. For example, if the \f3-taglet\fR and \f3-tag\fR options have the name \f3todo\fR value, then the one that appears last on the command line determines the order\&. - -\fIExample of a complete set of tags\fR: This example inserts To Do after Parameters and before Throws in the output\&. By using \f3X\fR, it also specifies that the \f3@example\fR tag might be encountered in the source code that should not be output during this run\&. If you use the \f3@argfile\fR tag, then you can put the tags on separate lines in an argument file similar to this (no line continuation characters needed): -.sp -.nf -\f3\-tag param\fP -.fi -.nf -\f3\-tag return\fP -.fi -.nf -\f3\-tag todo:a:"To Do:"\fP -.fi -.nf -\f3\-tag throws\fP -.fi -.nf -\f3\-tag see\fP -.fi -.nf -\f3\-tag example:X\fP -.fi -.nf -\f3\fP -.fi -.sp - - -When the \f3javadoc\fR command parses the documentation comments, any tag encountered that is neither a standard tag nor passed in with the \f3-tag\fR or \f3-taglet\fR options is considered unknown, and a warning is thrown\&. - -The standard tags are initially stored internally in a list in their default order\&. Whenever the \f3-tag\fR options are used, those tags get appended to this list\&. Standard tags are moved from their default position\&. Therefore, if a \f3-tag\fR option is omitted for a standard tag, then it remains in its default position\&. - -\fIAvoiding conflicts\fR: If you want to create your own namespace, then you can use a dot-separated naming convention similar to that used for packages: \f3com\&.mycompany\&.todo\fR\&. Oracle will continue to create standard tags whose names do not contain dots\&. Any tag you create will override the behavior of a tag by the same name defined by Oracle\&. If you create a \f3@todo\fR tag or taglet, then it always has the same behavior you define, even when Oracle later creates a standard tag of the same name\&. - -\fIAnnotations vs\&. Javadoc tags\fR: In general, if the markup you want to add is intended to affect or produce documentation, then it should be a Javadoc tag\&. Otherwise, it should be an annotation\&. See Custom Tags and Annotations in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#annotations - -You can also create more complex block tags or custom inline tags with the \f3-taglet\fR option\&. -.TP --taglet \fIclass\fR -.br -Specifies the class file that starts the taglet used in generating the documentation for that tag\&. Use the fully qualified name for the \f3class\fR value\&. This taglet also defines the number of text arguments that the custom tag has\&. The taglet accepts those arguments, processes them, and generates the output\&. For extensive documentation with example taglets, see: Taglet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/taglet/overview\&.html - -Taglets are useful for block or inline tags\&. They can have any number of arguments and implement custom behavior, such as making text bold, formatting bullets, writing out the text to a file, or starting other processes\&. Taglets can only determine where a tag should appear and in what form\&. All other decisions are made by the doclet\&. A taglet cannot do things such as remove a class name from the list of included classes\&. However, it can execute side effects, such as printing the tag\&'s text to a file or triggering another process\&. Use the \f3-tagletpath\fR option to specify the path to the taglet\&. The following example inserts the To Do taglet after Parameters and ahead of Throws in the generated pages\&. Alternately, you can use the \f3-taglet\fR option in place of its \f3-tag\fR option, but that might be difficult to read\&. -.sp -.nf -\f3\-taglet com\&.sun\&.tools\&.doclets\&.ToDoTaglet\fP -.fi -.nf -\f3\-tagletpath /home/taglets \fP -.fi -.nf -\f3\-tag return\fP -.fi -.nf -\f3\-tag param\fP -.fi -.nf -\f3\-tag todo\fP -.fi -.nf -\f3\-tag throws\fP -.fi -.nf -\f3\-tag see\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --tagletpath \fItagletpathlist\fR -.br -Specifies the search paths for finding taglet class files\&. The \f3tagletpathlist\fR can contain multiple paths by separating them with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. -.TP --docfilesubdirs -.br -Enables deep copying of doc-files directories\&. Subdirectories and all contents are recursively copied to the destination\&. For example, the directory doc-files/example/images and all of its contents would be copied\&. There is also an option to exclude subdirectories\&. -.TP --excludedocfilessubdir \fIname1:name2\fR -.br -Excludes any doc-files subdirectories with the specified names\&. This prevents the copying of SCCS and other source-code-control subdirectories\&. -.TP --noqualifier all | \fIpackagename1\fR:\fIpackagename2\&.\&.\&.\fR -.br -Omits qualifying package names from class names in output\&. The argument to the \f3-noqualifier\fR option is either \f3all\fR (all package qualifiers are omitted) or a colon-separate list of packages, with wild cards, to be removed as qualifiers\&. The package name is removed from places where class or interface names appear\&. See Process Source Files\&. - -The following example omits all package qualifiers: \f3-noqualifier all\fR\&. - -The following example omits \f3java\&.lang\fR and \f3java\&.io\fR package qualifiers: \f3-noqualifier java\&.lang:java\&.io\fR\&. - -The following example omits package qualifiers starting with \f3java\fR, and \f3com\&.sun\fR subpackages, but not \f3javax\fR: \f3-noqualifier java\&.*:com\&.sun\&.*\fR\&. - -Where a package qualifier would appear due to the previous behavior, the name can be suitably shortened\&. See How a Name Appears\&. This rule is in effect whether or not the \f3-noqualifier\fR option is used\&. -.TP --notimestamp -.br -Suppresses the time stamp, which is hidden in an HTML comment in the generated HTML near the top of each page\&. The \f3-notimestamp\fR option is useful when you want to run the \f3javadoc\fR command on two source bases and get the differences between \f3diff\fR them, because it prevents time stamps from causing a \f3diff\fR (which would otherwise be a \f3diff\fR on every page)\&. The time stamp includes the \f3javadoc\fR command release number, and currently appears similar to this: \f3<!-- Generated by javadoc (build 1\&.5\&.0_01) on Thu Apr 02 14:04:52 IST 2009 -->\fR\&. -.TP --nocomment -.br -Suppresses the entire comment body, including the main description and all tags, and generate only declarations\&. This option lets you reuse source files that were originally intended for a different purpose so that you can produce skeleton HTML documentation at the early stages of a new project\&. -.TP --sourcetab \fItablength\fR -.br -Specifies the number of spaces each tab uses in the source\&. -.SH COMMAND-LINE\ ARGUMENT\ FILES -To shorten or simplify the \f3javadoc\fR command, you can specify one or more files that contain arguments to the \f3javadoc\fR command (except \f3-J\fR options)\&. This enables you to create \f3javadoc\fR commands of any length on any operating system\&. -.PP -An argument file can include \f3javac\fR options and source file names in any combination\&. The arguments within a file can be space-separated or newline-separated\&. If a file name contains embedded spaces, then put the whole file name in double quotation marks\&. -.PP -File Names within an argument file are relative to the current directory, not the location of the argument file\&. Wild cards (\f3*\fR) are not allowed in these lists (such as for specifying *\&.java)\&. Using the at sign (@) to recursively interpret files is not supported\&. The \f3-J\fR options are not supported because they are passed to the launcher, which does not support argument files\&. -.PP -When you run the \f3javadoc\fR command, pass in the path and name of each argument file with the @ leading character\&. When the \f3javadoc\fR command encounters an argument beginning with the at sign (@), it expands the contents of that file into the argument list\&. -.PP -\f3Example 1 Single Argument File\fR -.PP -You could use a single argument file named \f3argfile\fR to hold all \f3javadoc\fR command arguments: \f3javadoc @argfile\fR\&. The argument file \f3\fRcontains the contents of both files, as shown in the next example\&. -.PP -\f3Example 2 Two Argument Files\fR -.PP -You can create two argument files: One for the \f3javadoc\fR command options and the other for the package names or source file names\&. Notice the following lists have no line-continuation characters\&. -.PP -Create a file named options that contains: -.sp -.nf -\f3\-d docs\-filelist \fP -.fi -.nf -\f3\-use \fP -.fi -.nf -\f3\-splitindex\fP -.fi -.nf -\f3\-windowtitle \&'Java SE 7 API Specification\&'\fP -.fi -.nf -\f3\-doctitle \&'Java SE 7 API Specification\&'\fP -.fi -.nf -\f3\-header \&'<b>Java\(tm SE 7</b>\&'\fP -.fi -.nf -\f3\-bottom \&'Copyright © 1993\-2011 Oracle and/or its affiliates\&. All rights reserved\&.\&'\fP -.fi -.nf -\f3\-group "Core Packages" "java\&.*"\fP -.fi -.nf -\f3\-overview /java/pubs/ws/1\&.7\&.0/src/share/classes/overview\-core\&.html\fP -.fi -.nf -\f3\-sourcepath /java/pubs/ws/1\&.7\&.0/src/share/classes\fP -.fi -.nf -\f3\fP -.fi -.sp -Create a file named packages that contains: -.sp -.nf -\f3com\&.mypackage1\fP -.fi -.nf -\f3com\&.mypackage2\fP -.fi -.nf -\f3com\&.mypackage3\fP -.fi -.nf -\f3\fP -.fi -.sp -Run the \f3javadoc\fR command as follows: -.sp -.nf -\f3javadoc @options @packages\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 3 Argument Files with Paths\fR -.PP -The argument files can have paths, but any file names inside the files are relative to the current working directory (not \f3path1\fR or \f3path2\fR): -.sp -.nf -\f3javadoc @path1/options @path2/packages\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 4 Option Arguments\fR -.PP -The following example saves an argument to a \f3javadoc\fR command option in an argument file\&. The \f3-bottom\fR option is used because it can have a lengthy argument\&. You could create a file named bottom to contain the text argument: -.sp -.nf -\f3<font size="\-1">\fP -.fi -.nf -\f3 <a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP -.fi -.nf -\f3 Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&. <br/>\fP -.fi -.nf -\f3 Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP -.fi -.nf -\f3 Other names may be trademarks of their respective owners\&.</font>\fP -.fi -.nf -\f3\fP -.fi -.sp -Run the \f3javadoc\fR command as follows:\f3javadoc -bottom @bottom @packages\fR\&. -.PP -You can also include the \f3-bottom\fR option at the start of the argument file and run the \f3javadoc\fR command as follows: \f3javadoc @bottom @packages\fR\&. -.SH RUNNING\ THE\ JAVADOC\ COMMAND -The release number of the \f3javadoc\fR command can be determined with the \f3javadoc -J-version\fR option\&. The release number of the standard doclet appears in the output stream\&. It can be turned off with the \f3-quiet\fR option\&. -.PP -Use the public programmatic interface to call the \f3javadoc\fR command from within programs written in the Java language\&. This interface is in \f3com\&.sun\&.tools\&.javadoc\&.Main\fR (and the \f3javadoc\fR command is reentrant)\&. For more information, see The Standard Doclet at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/standard-doclet\&.html#runningprogrammatically -.PP -The following instructions call the standard HTML doclet\&. To call a custom doclet, use the \f3-doclet\fR and \f3-docletpath\fR options\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html -.SS SIMPLE\ EXAMPLES -You can run the \f3javadoc\fR command on entire packages or individual source files\&. Each package name has a corresponding directory name\&. -.PP -In the following examples, the source files are located at /home/src/java/awt/*\&.java\&. The destination directory is /home/html\&. -.PP -Document One or More Packages - -To document a package, the source files for that package must be located in a directory that has the same name as the package\&. -.PP -If a package name has several identifiers (separated by dots, such as \f3java\&.awt\&.color\fR), then each subsequent identifier must correspond to a deeper subdirectory (such as java/awt/color)\&. -.PP -You can split the source files for a single package among two such directory trees located at different places, as long as \f3-sourcepath\fR points to them both\&. For example, src1/java/awt/color and src2/java/awt/color\&. -.PP -You can run the \f3javadoc\fR command either by changing directories (with the \f3cd\fR command) or by using the \f3-sourcepath\fR option\&. The following examples illustrate both alternatives\&. -.PP -\f3Example 1 Recursive Run from One or More Packages\fR -.PP -This example uses \f3-sourcepath\fR so the \f3javadoc\fR command can be run from any directory and \f3-subpackages\fR (a new 1\&.4 option) for recursion\&. It traverses the subpackages of the java directory excluding packages rooted at \f3java\&.net\fR and \f3java\&.lang\fR\&. Notice this excludes \f3java\&.lang\&.ref\fR, a subpackage of \f3java\&.lang\fR\&. To also traverse down other package trees, append their names to the \f3-subpackages\fR argument, such as \f3java:javax:org\&.xml\&.sax\fR\&. -.sp -.nf -\f3javadoc \-d /home/html \-sourcepath /home/src \-subpackages java \-exclude\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 2 Change to Root and Run Explicit Packages\fR -.PP -Change to the parent directory of the fully qualified package\&. Then, run the \f3javadoc\fR command with the names of one or more packages that you want to document: -.sp -.nf -\f3cd /home/src/\fP -.fi -.nf -\f3javadoc \-d /home/html java\&.awt java\&.awt\&.event\fP -.fi -.nf -\f3\fP -.fi -.sp -To also traverse down other package trees, append their names to the \f3-subpackages\fR argument, such as j\f3ava:javax:org\&.xml\&.sax\fR\&. -.PP -\f3Example 3 Run from Any Directory on Explicit Packages in One Tree\fR -.PP -In this case, it does not matter what the current directory is\&. Run the \f3javadoc\fR command and use the \f3-sourcepath\fR option with the parent directory of the top-level package\&. Provide the names of one or more packages that you want to document: -.sp -.nf -\f3javadoc \-d /home/html \-sourcepath /home/src java\&.awt java\&.awt\&.event\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 4 Run from Any Directory on Explicit Packages in Multiple Trees\fR -.PP -Run the \f3javadoc\fR command and use the \f3-sourcepath\fR option with a colon-separated list of the paths to each tree\&'s root\&. Provide the names of one or more packages that you want to document\&. All source files for a specified package do not need to be located under a single root directory, but they must be found somewhere along the source path\&. -.sp -.nf -\f3javadoc \-d /home/html \-sourcepath /home/src1:/home/src2 java\&.awt java\&.awt\&.event\fP -.fi -.nf -\f3\fP -.fi -.sp -The result is that all cases generate HTML-formatted documentation for the \f3public\fR and \f3protected\fR classes and interfaces in packages j\f3ava\&.awt\fR and \f3java\&.awt\&.even\fRt and save the HTML files in the specified destination directory\&. Because two or more packages are being generated, the document has three HTML frames: one for the list of packages, another for the list of classes, and the third for the main class pages\&. -.PP -Document One or More Classes - -The second way to run the \f3javadoc\fR command is to pass one or more source files\&. You can run \f3javadoc\fR either of the following two ways: by changing directories (with the \f3cd\fR command) or by fully specifying the path to the source files\&. Relative paths are relative to the current directory\&. The \f3-sourcepath\fR option is ignored when passing source files\&. You can use command-line wild cards, such as an asterisk (*), to specify groups of classes\&. -.PP -\f3Example 1 Change to the Source Directory\fR -.PP -Change to the directory that holds the source files\&. Then run the \f3javadoc\fR command with the names of one or more source files you want to document\&. -.PP -This example generates HTML-formatted documentation for the classes \f3Button\fR, \f3Canvas,\fR and classes that begin with \f3Graphics\fR\&. Because source files rather than package names were passed in as arguments to the \f3javadoc\fR command, the document has two frames: one for the list of classes and the other for the main page\&. -.sp -.nf -\f3cd /home/src/java/awt\fP -.fi -.nf -\f3javadoc \-d /home/html Button\&.java Canvas\&.java Graphics*\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 2 Change to the Root Directory of the Package\fR -.PP -This is useful for documenting individual source files from different subpackages off of the same root\&. Change to the package root directory, and supply the source files with paths from the root\&. -.sp -.nf -\f3cd /home/src/\fP -.fi -.nf -\f3javadoc \-d /home/html java/awt/Button\&.java java/applet/Applet\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3Example 3 Document Files from Any Directory\fR -.PP -In this case, it does not matter what the current directory is\&. Run the \f3javadoc\fR command with the absolute path (or path relative to the current directory) to the source files you want to document\&. -.sp -.nf -\f3javadoc \-d /home/html /home/src/java/awt/Button\&.java\fP -.fi -.nf -\f3/home/src/java/awt/Graphics*\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Document Packages and Classes - -You can document entire packages and individual classes at the same time\&. Here is an example that mixes two of the previous examples\&. You can use the \f3-sourcepath\fR option for the path to the packages but not for the path to the individual classes\&. -.sp -.nf -\f3javadoc \-d /home/html \-sourcepath /home/src java\&.awt\fP -.fi -.nf -\f3/home/src/java/applet/Applet\&.java\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS REAL-WORLD\ EXAMPLES -The following command-line and \f3makefile\fR versions of the \f3javadoc\fR command run on the Java platform APIs\&. It uses 180 MB of memory to generate the documentation for the 1500 (approximately) public and protected classes in the Java SE 1\&.2\&. Both examples use absolute paths in the option arguments, so that the same \f3javadoc\fR command can be run from any directory\&. -.PP -Command-Line Example - -The following command might be too long for some shells\&. You can use a command-line argument file (or write a shell script) to overcome this limitation\&. -.PP -In the example, \f3packages\fR is the name of a file that contains the packages to process, such as \f3java\&.applet\fR\f3java\&.lang\fR\&. None of the options should contain any newline characters between the single quotation marks\&. For example, if you copy and paste this example, then delete the newline characters from the \f3-bottom\fR option\&. -.sp -.nf -\f3javadoc \-sourcepath /java/jdk/src/share/classes \e\fP -.fi -.nf -\f3\-overview /java/jdk/src/share/classes/overview\&.html \e\fP -.fi -.nf -\f3\-d /java/jdk/build/api \e\fP -.fi -.nf -\f3\-use \e\fP -.fi -.nf -\f3\-splitIndex \e\fP -.fi -.nf -\f3\-windowtitle \&'Java Platform, Standard Edition 7 API Specification\&' \e\fP -.fi -.nf -\f3\-doctitle \&'Java Platform, Standard Edition 7 API Specification\&' \e\fP -.fi -.nf -\f3\-header \&'<b>Java\(tm SE 7</b>\&' \e\fP -.fi -.nf -\f3\-bottom \&'<font size="\-1">\fP -.fi -.nf -\f3<a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP -.fi -.nf -\f3Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&.<br/>\fP -.fi -.nf -\f3Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP -.fi -.nf -\f3Other names may be trademarks of their respective owners\&.</font>\&' \e\fP -.fi -.nf -\f3\-group "Core Packages" "java\&.*:com\&.sun\&.java\&.*:org\&.omg\&.*" \e\fP -.fi -.nf -\f3\-group "Extension Packages" "javax\&.*" \e\fP -.fi -.nf -\f3\-J\-Xmx180m \e \fP -.fi -.nf -\f3@packages\fP -.fi -.nf -\f3\fP -.fi -.sp - -.PP -Programmatic Interface - -The Javadoc Access API enables the user to invoke the Javadoc tool directly from a Java application without executing a new process\&. -.PP -For example, the following statements are equivalent to the command \f3javadoc -d /home/html -sourcepath /home/src -subpackages java -exclude java\&.net:java\&.lang com\&.example\fR: -.sp -.nf -\f3import javax\&.tools\&.DocumentationTool;\fP -.fi -.nf -\f3import javax\&.tools\&.ToolProvider;\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3public class JavaAccessSample{\fP -.fi -.nf -\f3 public static void main(String[] args){\fP -.fi -.nf -\f3 DocumentationTool javadoc = ToolProvider\&.getSystemDocumentationTool();\fP -.fi -.nf -\f3 int rc = javadoc\&.run( null, null, null,\fP -.fi -.nf -\f3 "\-d", "/home/html",\fP -.fi -.nf -\f3 "\-sourcepath", "home/src",\fP -.fi -.nf -\f3 "\-subpackages", "java",\fP -.fi -.nf -\f3 "\-exclude", "java\&.net:java\&.lang",\fP -.fi -.nf -\f3 "com\&.example");\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3\fP -.fi -.sp -The first three arguments of the \f3run\fR method specify input, standard output, and standard error streams\&. \f3Null\fR is the default value for \f3System\&.in\fR, \f3System\&.out\fR, and \f3System\&.err\fR, respectively\&. -.SS THE\ MAKEFILE\ EXAMPLE -This is an example of a GNU \f3makefile\fR\&. Single quotation marks surround \f3makefile\fR arguments\&. For an example of a Windows \f3makefile\fR, see the \f3makefiles\fR section of the Javadoc FAQ at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137483\&.html#makefiles -.sp -.nf -\f3javadoc \-sourcepath $(SRCDIR) \e /* Sets path for source files */\fP -.fi -.nf -\f3 \-overview $(SRCDIR)/overview\&.html \e /* Sets file for overview text */\fP -.fi -.nf -\f3 \-d /java/jdk/build/api \e /* Sets destination directory */\fP -.fi -.nf -\f3 \-use \e /* Adds "Use" files */\fP -.fi -.nf -\f3 \-splitIndex \e /* Splits index A\-Z */\fP -.fi -.nf -\f3 \-windowtitle $(WINDOWTITLE) \e /* Adds a window title */\fP -.fi -.nf -\f3 \-doctitle $(DOCTITLE) \e /* Adds a doc title */\fP -.fi -.nf -\f3 \-header $(HEADER) \e /* Adds running header text */\fP -.fi -.nf -\f3 \-bottom $(BOTTOM) \e /* Adds text at bottom */\fP -.fi -.nf -\f3 \-group $(GROUPCORE) \e /* 1st subhead on overview page */\fP -.fi -.nf -\f3 \-group $(GROUPEXT) \e /* 2nd subhead on overview page */\fP -.fi -.nf -\f3 \-J\-Xmx180m \e /* Sets memory to 180MB */\fP -.fi -.nf -\f3 java\&.lang java\&.lang\&.reflect \e /* Sets packages to document */\fP -.fi -.nf -\f3 java\&.util java\&.io java\&.net \e\fP -.fi -.nf -\f3 java\&.applet\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3WINDOWTITLE = \&'Java\(tm SE 7 API Specification\&'\fP -.fi -.nf -\f3DOCTITLE = \&'Java\(tm Platform Standard Edition 7 API Specification\&'\fP -.fi -.nf -\f3HEADER = \&'<b>Java\(tm SE 7</font>\&'\fP -.fi -.nf -\f3BOTTOM = \&'<font size="\-1">\fP -.fi -.nf -\f3 <a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP -.fi -.nf -\f3 Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&.<br/>\fP -.fi -.nf -\f3 Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP -.fi -.nf -\f3 Other names may be trademarks of their respective owners\&.</font>\&'\fP -.fi -.nf -\f3GROUPCORE = \&'"Core Packages" "java\&.*:com\&.sun\&.java\&.*:org\&.omg\&.*"\&'\fP -.fi -.nf -\f3GROUPEXT = \&'"Extension Packages" "javax\&.*"\&'\fP -.fi -.nf -\f3SRCDIR = \&'/java/jdk/1\&.7\&.0/src/share/classes\&'\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS NOTES -.TP 0.2i -\(bu -If you omit the \f3-windowtitle\fR option, then the \f3javadoc\fR command copies the document title to the window title\&. The \f3-windowtitle\fR option text is similar to the the \f3-doctitle\fR option, but without HTML tags to prevent those tags from appearing as raw text in the window title\&. -.TP 0.2i -\(bu -If you omit the \f3-footer\fR option, then the \f3javadoc\fR command copies the header text to the footer\&. -.TP 0.2i -\(bu -Other important options you might want to use, but were not needed in the previous example, are the \f3-classpath\fR and \f3-link\fR options\&. -.SH GENERAL\ TROUBLESHOOTING -.TP 0.2i -\(bu -The \f3javadoc\fR command reads only files that contain valid class names\&. If the \f3javadoc\fR command is not correctly reading the contents of a file, then verify that the class names are valid\&. See Process Source Files\&. -.TP 0.2i -\(bu -See the Javadoc FAQ for information about common bugs and for troubleshooting tips at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137483\&.html -.SH ERRORS\ AND\ WARNINGS -Error and warning messages contain the file name and line number to the declaration line rather than to the particular line in the documentation comment\&. -.PP -For example, this message \f3error: cannot read: Class1\&.java\fR means that the \f3javadoc\fR command is trying to load \f3Class1\&.jav\fR\f3a\fR in the current directory\&. The class name is shown with its path (absolute or relative)\&. -.SH ENVIRONMENT -.TP -CLASSPATH -\f3CLASSPATH\fR is the environment variable that provides the path that the \f3javadoc\fR command uses to find user class files\&. This environment variable is overridden by the \f3-classpath\fR option\&. Separate directories with a semicolon for Windows or a colon for Oracle Solaris\&. - -\fIWindows example\fR: \f3\&.;C:\eclasses;C:\ehome\ejava\eclasses\fR - -\fIOracle Solaris example\fR: \f3\&.:/home/classes:/usr/local/java/classes\fR\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -javac(1) -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -jdb(1) -.TP 0.2i -\(bu -javah(1) -.TP 0.2i -\(bu -javap(1) -.SH RELATED\ DOCUMENTS -.TP 0.2i -\(bu -Javadoc Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/index\&.html -.TP 0.2i -\(bu -How Classes Are Found http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html -.TP 0.2i -\(bu -How to Write Doc Comments for the Javadoc Tool http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html -.TP 0.2i -\(bu -URL Memo, Uniform Resource Locators http://www\&.ietf\&.org/rfc/rfc1738\&.txt -.TP 0.2i -\(bu -HTML standard, HTML Document Representation (4197265 and 4137321) http://www\&.w3\&.org/TR/REC-html40/charset\&.html#h-5\&.2\&.2 -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1994, 2015, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 03 March 2015 +.\" SectDesc: Basic Tools +.\" Title: javadoc.1 +.\" +.if n .pl 99999 +.TH javadoc 1 "03 March 2015" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +javadoc \- Generates HTML pages of API documentation from Java source files\&. +.SH SYNOPSIS +.sp +.nf + +\fBjavadoc\fR {\fIpackages\fR|\fIsource\-files\fR} [\fIoptions\fR] [\fI@argfiles\fR] +.fi +.sp +.TP +\fIpackages\fR +Names of packages that you want to document, separated by spaces, for example \f3java\&.lang java\&.lang\&.reflect java\&.awt\fR\&. If you want to also document the subpackages, use the \f3-subpackages\fR option to specify the packages\&. + +By default, \f3javadoc\fR looks for the specified packages in the current directory and subdirectories\&. Use the \f3-sourcepath\fR option to specify the list of directories where to look for packages\&. +.TP +\fIsource-files\fR +Names of Java source files that you want to document, separated by spaces, for example \f3Class\&.java Object\&.java Button\&.java\fR\&. By default, \f3javadoc\fR looks for the specified classes in the current directory\&. However, you can specify the full path to the class file and use wildcard characters, for example \f3/home/src/java/awt/Graphics*\&.java\fR\&. You can also specify the path relative to the current directory\&. +.TP +\fIoptions\fR +Command-line options, separated by spaces\&. See Options\&. +.TP +\fI@argfiles\fR +Names of files that contain a list of \f3javadoc\fR command options, package names and source file names in any order\&. +.SH DESCRIPTION +The \f3javadoc\fR command parses the declarations and documentation comments in a set of Java source files and produces a corresponding set of HTML pages that describe (by default) the public and protected classes, nested classes (but not anonymous inner classes), interfaces, constructors, methods, and fields\&. You can use the \f3javadoc\fR command to generate the API documentation or the implementation documentation for a set of source files\&. +.PP +You can run the \f3javadoc\fR command on entire packages, individual source files, or both\&. When documenting entire packages, you can either use the \f3-subpackages\fR option to recursively traverse a directory and its subdirectories, or to pass in an explicit list of package names\&. When you document individual source files, pass in a list of Java source file names\&. See Simple Examples\&. +.SS PROCESS\ SOURCE\ FILES +The \f3javadoc\fR command processes files that end in source and other files described in Source Files\&. If you run the \f3javadoc\fR command by passing in individual source file names, then you can determine exactly which source files are processed\&. However, that is not how most developers want to work, because it is simpler to pass in package names\&. The \f3javadoc\fR command can be run three ways without explicitly specifying the source file names\&. You can pass in package names, use the \f3-subpackages\fR option, or use wild cards with source file names\&. In these cases, the \f3javadoc\fR command processes a source file only when the file fulfills all of the following requirements: +.TP 0.2i +\(bu +The file name prefix (with \f3\&.java\fR removed) is a valid class name\&. +.TP 0.2i +\(bu +The path name relative to the root of the source tree is a valid package name after the separators are converted to dots\&. +.TP 0.2i +\(bu +The package statement contains the valid package name\&. +.PP +Processing Links + +During a run, the \f3javadoc\fR command adds cross-reference links to package, class, and member names that are being documented as part of that run\&. Links appear in the following places\&. See Javadoc Tags for a description of the @ tags\&. +.TP 0.2i +\(bu +Declarations (return types, argument types, and field types)\&. +.TP 0.2i +\(bu +\fISee Also\fR sections that are generated from \f3@see\fR tags\&. +.TP 0.2i +\(bu +Inline text generated from \f3{@link}\fR tags\&. +.TP 0.2i +\(bu +Exception names generated from \f3@throws\fR tags\&. +.TP 0.2i +\(bu +\fISpecified by\fR links to interface members and \fIOverrides\fR links to class members\&. See Method Comment Inheritance\&. +.TP 0.2i +\(bu +Summary tables listing packages, classes and members\&. +.TP 0.2i +\(bu +Package and class inheritance trees\&. +.TP 0.2i +\(bu +The index\&. +.PP +You can add links to existing text for classes not included on the command line (but generated separately) by way of the \f3-link\fR and \f3-linkoffline\fR options\&. +.PP +Processing Details + +The \f3javadoc\fR command produces one complete document every time it runs\&. It does not do incremental builds that modify or directly incorporate the results from earlier runs\&. However, the \f3javadoc\fR command can link to results from other runs\&. +.PP +The \f3javadoc\fR command implementation requires and relies on the Java compiler\&. The \f3javadoc\fR command calls part of the \f3javac\fR command to compile the declarations and ignore the member implementations\&. The \f3javadoc\fR command builds a rich internal representation of the classes that includes the class hierarchy and use relationships to generate the HTML\&. The \f3javadoc\fR command also picks up user-supplied documentation from documentation comments in the source code\&. See Documentation Comments\&. +.PP +The \f3javadoc\fR command runs on source files that are pure stub files with no method bodies\&. This means you can write documentation comments and run the \f3javadoc\fR command in the early stages of design before API implementation\&. +.PP +Relying on the compiler ensures that the HTML output corresponds exactly with the actual implementation, which may rely on implicit, rather than explicit, source code\&. For example, the \f3javadoc\fR command documents default constructors that are present in the compiled class files but not in the source code\&. +.PP +In many cases, the \f3javadoc\fR command lets you generate documentation for source files with incomplete or erroneous code\&. You can generate documentation before all debugging and troubleshooting is done\&. The \f3javadoc\fR command does primitive checking of documentation comments\&. +.PP +When the \f3javadoc\fR command builds its internal structure for the documentation, it loads all referenced classes\&. Because of this, the \f3javadoc\fR command must be able to find all referenced classes, whether bootstrap classes, extensions, or user classes\&. See How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html +.PP +Typically, classes you create must either be loaded as an extension or in the \f3javadoc\fR command class path\&. +.SS JAVADOC\ DOCLETS +You can customize the content and format of the \f3javadoc\fR command output with doclets\&. The \f3javadoc\fR command has a default built-in doclet, called the standard doclet, that generates HTML-formatted API documentation\&. You can modify or make a subclass of the standard doclet, or write your own doclet to generate HTML, XML, MIF, RTF or whatever output format you want\&. +.PP +When a custom doclet is not specified with the \f3-doclet\fR option, the \f3javadoc\fR command uses the default standard doclet\&. The \f3javadoc\fR command has several options that are available regardless of which doclet is being used\&. The standard doclet adds a supplementary set of command-line options\&. See Options\&. +.SH SOURCE\ FILES +The \f3javadoc\fR command generates output that originates from the following types of source files: Java language source files for classes (\f3\&.java\fR), package comment files, overview comment files, and miscellaneous unprocessed files\&. This section also describes test files and template files that can also be in the source tree, but that you want to be sure not to document\&. +.SS CLASS\ SOURCE\ FILES +Each class or interface and its members can have their own documentation comments contained in a source file\&. See Documentation Comments\&. +.SS PACKAGE\ COMMENT\ FILES +Each package can have its own documentation comment, contained in its own source file, that the \f3javadoc\fR command merges into the generated package summary page\&. You typically include in this comment any documentation that applies to the entire package\&. +.PP +To create a package comment file, you can place your comments in one of the following files: +.TP 0.2i +\(bu +The \f3package-info\&.java\fR file can contain the package declaration, package annotations, package comments, and Javadoc tags\&. This file is preferred\&. +.TP 0.2i +\(bu +The \f3package\&.html\fR file contains only package comments and Javadoc tags\&. No package annotations\&. +.PP +A package can have a single \f3package\&.html\fR file or a single \f3package-info\&.java\fR file, but not both\&. Place either file in the package directory in the source tree with your source files\&. +.PP +The package-info\&.java File + +The \f3package-info\&.java\fR file can contain a package comment of the following structure\&. The comment is placed before the package declaration\&. +.PP +\fINote:\fR The comment separators \f3/**\fR and \f3*/\fR must be present, but the leading asterisks on the intermediate lines can be left off\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * Provides the classes necessary to create an \fP +.fi +.nf +\f3 * applet and the classes an applet uses \fP +.fi +.nf +\f3 * to communicate with its applet context\&.\fP +.fi +.nf +\f3 * <p>\fP +.fi +.nf +\f3 * The applet framework involves two entities:\fP +.fi +.nf +\f3 * the applet and the applet context\&.\fP +.fi +.nf +\f3 * An applet is an embeddable window (see the\fP +.fi +.nf +\f3 * {@link java\&.awt\&.Panel} class) with a few extra\fP +.fi +.nf +\f3 * methods that the applet context can use to \fP +.fi +.nf +\f3 * initialize, start, and stop the applet\&.\fP +.fi +.nf +\f3 *\fP +.fi +.nf +\f3 * @since 1\&.0\fP +.fi +.nf +\f3 * @see java\&.awt\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3package java\&.lang\&.applet;\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +The package\&.html File + +The \f3package\&.html\fR file can contain a package comment of the following structure\&. The comment is placed in the \f3<body>\fR element\&. +.PP +File: \f3java/applet/package\&.html\fR +.sp +.nf +\f3<HTML>\fP +.fi +.nf +\f3<BODY>\fP +.fi +.nf +\f3Provides the classes necessary to create an applet and the \fP +.fi +.nf +\f3classes an applet uses to communicate with its applet context\&.\fP +.fi +.nf +\f3<p>\fP +.fi +.nf +\f3The applet framework involves two entities: the applet\fP +.fi +.nf +\f3and the applet context\&. An applet is an embeddable\fP +.fi +.nf +\f3window (see the {@link java\&.awt\&.Panel} class) with a\fP +.fi +.nf +\f3few extra methods that the applet context can use to\fP +.fi +.nf +\f3initialize, start, and stop the applet\&. \fP +.fi +.nf +\f3\fP +.fi +.nf +\f3@since 1\&.0 \fP +.fi +.nf +\f3@see java\&.awt\fP +.fi +.nf +\f3</BODY>\fP +.fi +.nf +\f3</HTML>\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3package\&.html\fR file is a typical HTML file and does not include a package declaration\&. The content of the package comment file is written in HTML with one exception\&. The documentation comment should not include the comment separators \f3/**\fR and \f3*/\fR or leading asterisks\&. When writing the comment, make the first sentence a summary about the package, and do not put a title or any other text between the \f3<body>\fR tag and the first sentence\&. You can include package tags\&. All block tags must appear after the main description\&. If you add an \f3@see\fR tag in a package comment file, then it must have a fully qualified name\&. +.PP +Processing the Comment File + +When the \f3javadoc\fR command runs, it searches for the package comment file\&. If the package comment file is found, then the \f3javadoc\fR command does the following: +.TP 0.2i +\(bu +Copies the comment for processing\&. For package\&.html, the \f3javadoc\fR command copies all content between the \f3<body>\fR and \f3</body>\fR HTML tags\&. You can include a \f3<head>\fR section to put a \f3<title>\fR tag, source file copyright statement, or other information, but none of these appear in the generated documentation\&. +.TP 0.2i +\(bu +Processes the package tags\&. See Package Tags\&. +.TP 0.2i +\(bu +Inserts the processed text at the bottom of the generated package summary page\&. See Java Platform, Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html +.TP 0.2i +\(bu +Copies the first sentence of the package comment to the top of the package summary page\&. The \f3javadoc\fR command also adds the package name and this first sentence to the list of packages on the overview page\&. See Java Platform, Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html + +The end of the sentence is determined by the same rules used for the end of the first sentence of class and member main descriptions\&. +.SS OVERVIEW\ COMMENT\ FILES +Each application or set of packages that you are documenting can have its own overview documentation comment that is kept in its own source file, that the \f3javadoc\fR command merges into the generated overview page\&. You typically include in this comment any documentation that applies to the entire application or set of packages\&. +.PP +You can name the file anything you want such as overview\&.html and place it anywhere\&. A typical location is at the top of the source tree\&. +.PP +For example, if the source files for the \f3java\&.applet\fR package are contained in the /home/user/src/java/applet directory, then you could create an overview comment file at /home/user/src/overview\&.html\&. +.PP +You can have multiple overview comment files for the same set of source files in case you want to run the \f3javadoc\fR command multiple times on different sets of packages\&. For example, you could run the \f3javadoc\fR command once with \f3-private\fR for internal documentation and again without that option for public documentation\&. In this case, you could describe the documentation as public or internal in the first sentence of each overview comment file\&. +.PP +The content of the overview comment file is one big documentation comment that is written in HTML\&. Make the first sentence a summary about the application or set of packages\&. Do not put a title or any other text between the \f3<body>\fR tag and the first sentence\&. All tags except inline tags, such as an {\f3@link}\fR tag, must appear after the main description\&. If you add an \f3@see\fR tag, then it must have a fully qualified name\&. +.PP +When you run the \f3javadoc\fR command, specify the overview comment file name with the \f3-overview\fR option\&. The file is then processed similarly to that of a package comment file\&. The \f3javadoc\fR command does the following: +.TP 0.2i +\(bu +Copies all content between the \f3<body>\fR and \f3</body>\fR tags for processing\&. +.TP 0.2i +\(bu +Processes the overview tags that are present\&. See Overview Tags\&. +.TP 0.2i +\(bu +Inserts the processed text at the bottom of the generated overview page\&. See Java Platform Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html +.TP 0.2i +\(bu +Copies the first sentence of the overview comment to the top of the overview summary page\&. +.SS UNPROCESSED\ FILES +Your source files can include any files that you want the \f3javadoc\fR command to copy to the destination directory\&. These files usually include graphic files, example Java source and class files, and self-standing HTML files with a lot of content that would overwhelm the documentation comment of a typical Java source file\&. +.PP +To include unprocessed files, put them in a directory called doc-files\&. The doc-files directory can be a subdirectory of any package directory that contains source files\&. You can have one doc-files subdirectory for each package\&. +.PP +For example, if you want to include the image of a button in the \f3java\&.awt\&.Button\fR class documentation, then place the image file in the /home/user/src/java/awt/doc-files/ directory\&. Do not place the doc-files directory at /home/user/src/java/doc-files, because java is not a package\&. It does not contain any source files\&. +.PP +All links to the unprocessed files must be included in the code because the \f3javadoc\fR command does not look at the files\&. The \f3javadoc\fR command copies the directory and all of its contents to the destination\&. The following example shows how the link in the Button\&.java documentation comment might look: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This button looks like this: \fP +.fi +.nf +\f3 * <img src="doc\-files/Button\&.gif">\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS TEST\ AND\ TEMPLATE\ FILES +You can store test and template files in the source tree in the same directory with or in a subdirectory of the directory where the source files reside\&. To prevent test and template files from being processed, run the \f3javadoc\fR command and explicitly pass in individual source file names\&. +.PP +Test files are valid, compilable source files\&. Template files are not valid, compatible source files, but they often have the \f3\&.java\fR suffix\&. +.PP +Test Files + +If you want your test files to belong to either an unnamed package or to a package other than the package that the source files are in, then put the test files in a subdirectory underneath the source files and give the directory an invalid name\&. If you put the test files in the same directory with the source and call the \f3javadoc\fR command with a command-line argument that indicates its package name, then the test files cause warnings or errors\&. If the files are in a subdirectory with an invalid name, then the test file directory is skipped and no errors or warnings are issued\&. For example, to add test files for source files in com\&.package1, put them in a subdirectory in an invalid package name\&. The following directory name is invalid because it contains a hyphen: +.sp +.nf +\f3com/package1/test\-files/\fP +.fi +.nf +\f3\fP +.fi +.sp +If your test files contain documentation comments, then you can set up a separate run of the \f3javadoc\fR command to produce test file documentation by passing in their test source file names with wild cards, such as \f3com/package1/test-files/*\&.java\fR\&. +.PP +Template Files + +If you want a template file to be in the source directory, but not generate errors when you execute the \f3javadoc\fR command, then give it an invalid file name such as \f3Buffer-Template\&.java\fR to prevent it from being processed\&. The \f3javadoc\fR command only processes source files with names, when stripped of the \f3\&.java\fR suffix, that are valid class names\&. +.SH GENERATED\ FILES +By default, the \f3javadoc\fR command uses a standard doclet that generates HTML-formatted documentation\&. The standard doclet generates basic content, cross-reference, and support pages described here\&. Each HTML page corresponds to a separate file\&. The \f3javadoc\fR command generates two types of files\&. The first type is named after classes and interfaces\&. The second type contain hyphens (such as package-summary\&.html) to prevent conflicts with the first type of file\&. +.SS BASIC\ CONTENT\ PAGES +.TP 0.2i +\(bu +One class or interface page (classname\&.html) for each class or interface being documented\&. +.TP 0.2i +\(bu +One package page (package-summary\&.html) for each package being documented\&. The \f3javadoc\fR command includes any HTML text provided in a file with the name package\&.html or package-info\&.java in the package directory of the source tree\&. +.TP 0.2i +\(bu +One overview page (overview-summary\&.html) for the entire set of packages\&. The overview page is the front page of the generated document\&. The \f3javadoc\fR command includes any HTML text provided in a file specified by the \f3-overview\fR option\&. The Overview page is created only when you pass two or more package names into the \f3javadoc\fR command\&. See HTML Frames and Options\&. +.SS CROSS-REFERENCE\ PAGES +.TP 0.2i +\(bu +One class hierarchy page for the entire set of packages (overview-tree\&.html)\&. To view the hierarchy page, click \fIOverview\fR in the navigation bar and click \fITree\fR\&. +.TP 0.2i +\(bu +One class hierarchy page for each package (package-tree\&.html) To view the hierarchy page, go to a particular package, class, or interface page, and click \fITree\fR to display the hierarchy for that package\&. +.TP 0.2i +\(bu +One use page for each package (package-use\&.html) and a separate use page for each class and interface (class-use/classname\&.html)\&. The use page describes what packages, classes, methods, constructors and fields use any part of the specified class, interface, or package\&. For example, given a class or interface A, its use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A\&. To view the use page, go to the package, class, or interface and click the \fIUse\fR link in the navigation bar\&. +.TP 0.2i +\(bu +A deprecated API page (deprecated-list\&.html) that lists all deprecated APIs and their suggested replacements\&. Avoid deprecated APIs because they can be removed in future implementations\&. +.TP 0.2i +\(bu +A constant field values page (constant-values\&.html) for the values of static fields\&. +.TP 0.2i +\(bu +A serialized form page (serialized-form\&.html) that provides information about serializable and externalizable classes with field and method descriptions\&. The information on this page is of interest to reimplementors, and not to developers who want to use the API\&. To access the serialized form page, go to any serialized class and click \fISerialized Form\fR in the See Also section of the class comment\&. The standard doclet generates a serialized form page that lists any class (public or non-public) that implements Serializable with its \f3readObject\fR and \f3writeObject\fR methods, the fields that are serialized, and the documentation comments from the \f3@serial\fR, \f3@serialField\fR, and \f3@serialData\fR tags\&. Public serializable classes can be excluded by marking them (or their package) with \f3@serial\fR exclude, and package-private serializable classes can be included by marking them (or their package) with an \f3@serial\fR include\&. As of Release 1\&.4, you can generate the complete serialized form for public and private classes by running the \f3javadoc\fR command without specifying the \f3-private\fR option\&. See Options\&. +.TP 0.2i +\(bu +An index page (\f3index-*\&.html\fR) of all class, interface, constructor, field and method names, in alphabetical order\&. The index page is internationalized for Unicode and can be generated as a single file or as a separate file for each starting character (such as A\(enZ for English)\&. +.SS SUPPORT\ PAGES +.TP 0.2i +\(bu +A help page (help-doc\&.html) that describes the navigation bar and the previous pages\&. Use \f3-helpfile\fR to override the default help file with your own custom help file\&. +.TP 0.2i +\(bu +One index\&.html file that creates the HTML frames for display\&. Load this file to display the front page with frames\&. The index\&.html file contains no text content\&. +.TP 0.2i +\(bu +Several frame files (\f3*-frame\&.html\fR) that contains lists of packages, classes, and interfaces\&. The frame files display the HTML frames\&. +.TP 0.2i +\(bu +A package list file (package-list) that is used by the \f3-link\fR and \f3-linkoffline\fR options\&. The package list file is a text file that is not reachable through links\&. +.TP 0.2i +\(bu +A style sheet file (stylesheet\&.css) that controls a limited amount of color, font family, font size, font style, and positioning information on the generated pages\&. +.TP 0.2i +\(bu +A doc-files directory that holds image, example, source code, or other files that you want copied to the destination directory\&. These files are not processed by the \f3javadoc\fR command\&. This directory is not processed unless it exists in the source tree\&. +.PP +See Options\&. +.SS HTML\ FRAMES +The \f3javadoc\fR command generates the minimum number of frames (two or three) necessary based on the values passed to the command\&. It omits the list of packages when you pass a single package name or source files that belong to a single package as an argument to the \f3javadoc\fR command\&. Instead, the \f3javadoc\fR command creates one frame in the left-hand column that displays the list of classes\&. When you pass two or more package names, the \f3javadoc\fR command creates a third frame that lists all packages and an overview page (overview-summary\&.html)\&. To bypass frames, click the \fINo Frames\fR link or enter the page set from the overview-summary\&.html page\&. +.SS GENERATED\ FILE\ STRUCTURE +The generated class and interface files are organized in the same directory hierarchy that Java source files and class files are organized\&. This structure is one directory per subpackage\&. +.PP +For example, the document generated for the \f3java\&.applet\&.Applet\fR class would be located at java/applet/Applet\&.html\&. +.PP +The file structure for the \f3java\&.applet\fR package follows, assuming that the destination directory is named \f3apidocs\fR\&. All files that contain the word \fIframe\fR appear in the upper-left or lower-left frames, as noted\&. All other HTML files appear in the right-hand frame\&. +.PP +Directories are bold\&. The asterisks (*) indicate the files and directories that are omitted when the arguments to the \f3javadoc\fR command are source file names rather than package names\&. When arguments are source file names, an empty package list is created\&. The doc-files directory is not created in the destination unless it exists in the source tree\&. See Generated Files\&. +.TP 0.2i +\(bu +\fIapidocs\fR: Top-level directory +.RS +.TP 0.2i +\(bu +index\&.html: Initial Page that sets up HTML frames +.TP 0.2i +\(bu +*overview-summary\&.html: Package list with summaries +.TP 0.2i +\(bu +overview-tree\&.html: Class hierarchy for all packages +.TP 0.2i +\(bu +deprecated-list\&.html: Deprecated APIs for all packages +.TP 0.2i +\(bu +constant-values\&.html: Static field values for all packages +.TP 0.2i +\(bu +serialized-form\&.html: Serialized forms for all packages +.TP 0.2i +\(bu +*overview-frame\&.html: All packages for display in upper-left frame +.TP 0.2i +\(bu +allclasses-frame\&.html: All classes for display in lower-left frame +.TP 0.2i +\(bu +help-doc\&.html: Help about Javadoc page organization +.TP 0.2i +\(bu +index-all\&.html: Default index created without \f3-splitindex\fR option +.TP 0.2i +\(bu +\fIindex-files\fR: Directory created with \f3-splitindex\fR option +.RS +.TP 0.2i +\(bu +index-<number>\&.html: Index files created with \f3-splitindex\fR option +.RE + +.TP 0.2i +\(bu +package-list: Package names for resolving external references +.TP 0.2i +\(bu +stylesheet\&.css: Defines fonts, colors, positions, and so on +.RE + +.TP 0.2i +\(bu +\fIjava\fR: Package directory +.RS +.TP 0.2i +\(bu +\fIapplet\fR: Subpackage directory +.RS +.TP 0.2i +\(bu +Applet\&.html: \f3Applet\fR class page +.TP 0.2i +\(bu +AppletContext\&.html: \f3AppletContext\fR interface +.TP 0.2i +\(bu +AppletStub\&.html: \f3AppletStub\fR interface +.TP 0.2i +\(bu +AudioClip\&.html: \f3AudioClip\fR interface +.TP 0.2i +\(bu +package-summary\&.html: Classes with summaries +.TP 0.2i +\(bu +package-frame\&.html: Package classes for display in lower-left frame +.TP 0.2i +\(bu +package-tree\&.html: Class hierarchy for this package +.TP 0.2i +\(bu +package-use\&.html: Where this package is used +.TP 0.2i +\(bu +\fIdoc-files\fR: Image and example files directory +.TP 0.2i +\(bu +\fIclass-use\fR: Image and examples file location + +- Applet\&.html: Uses of the Applet class + +- AppletContext\&.html: Uses of the \f3AppletContext\fR interface + +- AppletStub\&.html: Uses of the \f3AppletStub\fR interface + +- AudioClip\&.html: Uses of the \f3AudioClip\fR interface +.RE + +.RE + +.TP 0.2i +\(bu +\fIsrc-html\fR: Source code directory +.RS +.TP 0.2i +\(bu +\fIjava\fR: Package directory +.RS +.TP 0.2i +\(bu +\fIapplet\fR: Subpackage directory + +- Applet\&.html: Applet source code + +- AppletContext\&.html: \f3AppletContext\fR source code + +- AppletStub\&.html: \f3AppletStub\fR source code + +- AudioClip\&.html: \f3AudioClip\fR source code +.RE + +.RE + +.SS GENERATED\ API\ DECLARATIONS +The \f3javadoc\fR command generates a declaration at the start of each class, interface, field, constructor, and method description for that API item\&. For example, the declaration for the \f3Boolean\fR class is: +.sp +.nf +\f3public final class Boolean\fP +.fi +.nf +\f3extends Object\fP +.fi +.nf +\f3implements Serializable\fP +.fi +.nf +\f3\fP +.fi +.sp +The declaration for the \f3Boolean\&.valueOf\fR method is: +.sp +.nf +\f3public static Boolean valueOf(String s)\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3javadoc\fR command can include the modifiers \f3public\fR, \f3protected\fR, \f3private\fR, \f3abstract\fR, \f3final\fR, \f3static\fR, \f3transient\fR, and \f3volatile\fR, but not \f3synchronized\fR or \f3native\fR\&. The \f3synchronized\fR and \f3native\fR modifiers are considered implementation detail and not part of the API specification\&. +.PP +Rather than relying on the keyword \f3synchronized\fR, APIs should document their concurrency semantics in the main description of the comment\&. For example, a description might be: A single enumeration cannot be used by multiple threads concurrently\&. The document should not describe how to achieve these semantics\&. As another example, while the \f3Hashtable\fR option should be thread-safe, there is no reason to specify that it is achieved by synchronizing all of its exported methods\&. It is better to reserve the right to synchronize internally at the bucket level for higher concurrency\&. +.SH DOCUMENTATION\ COMMENTS +This section describes source code comments and comment inheritance\&. +.SS SOURCE\ CODE\ COMMENTS +You can include documentation comments in the source code, ahead of declarations for any class, interface, method, constructor, or field\&. You can also create documentation comments for each package and another one for the overview, though their syntax is slightly different\&. A documentation comment consists of the characters between \f3/**\fR and \f3*/\fR that end it\&. Leading asterisks are allowed on each line and are described further in the following section\&. The text in a comment can continue onto multiple lines\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This is the typical format of a simple documentation comment\fP +.fi +.nf +\f3 * that spans two lines\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.sp +To save space you can put a comment on one line: +.sp +.nf +\f3/** This comment takes up only one line\&. */\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Placement of Comments + +Documentation comments are recognized only when placed immediately before class, interface, constructor, method, or field declarations\&. Documentation comments placed in the body of a method are ignored\&. The \f3javadoc\fR command recognizes only one documentation comment per declaration statement\&. See Where Tags Can Be Used\&. +.PP +A common mistake is to put an \f3import\fR statement between the class comment and the class declaration\&. Do not put an \f3import\fR statement at this location because the \f3javadoc\fR command ignores the class comment\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This is the class comment for the class Whatever\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3import com\&.example; // MISTAKE \- Important not to put import statement here\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class Whatever{ }\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Parts of Comments + +A documentation comment has a main description followed by a tag section\&. The main description begins after the starting delimiter \f3/**\fR and continues until the tag section\&. The tag section starts with the first block tag, which is defined by the first \f3@\fR character that begins a line (ignoring leading asterisks, white space, and leading separator \f3/**\fR)\&. It is possible to have a comment with only a tag section and no main description\&. The main description cannot continue after the tag section begins\&. The argument to a tag can span multiple lines\&. There can be any number of tags, and some types of tags can be repeated while others cannot\&. For example, this \f3@see\fR tag starts the tag section: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This sentence holds the main description for this documentation comment\&.\fP +.fi +.nf +\f3 * @see java\&.lang\&.Object\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Block and inline Tags + +A tag is a special keyword within a documentation comment that the \f3javadoc\fR command processes\&. There are two kinds of tags: block tags, which appear as an \f3@tag\fR tag (also known as standalone tags), and inline tags, which appear within braces, as an \f3{@tag}\fR tag\&. To be interpreted, a block tag must appear at the beginning of a line, ignoring leading asterisks, white space, and the separator (\f3/**\fR)\&. This means you can use the \f3@\fR character elsewhere in the text and it will not be interpreted as the start of a tag\&. If you want to start a line with the \f3@\fR character and not have it be interpreted, then use the HTML entity \f3@\fR\&. Each block tag has associated text, which includes any text following the tag up to, but not including, either the next tag, or the end of the documentation comment\&. This associated text can span multiple lines\&. An inline tag is allowed and interpreted anywhere that text is allowed\&. The following example contains the \f3@deprecated\fR block tag and the \f3{@link}\fR inline tag\&. See Javadoc Tags\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @deprecated As of JDK 1\&.1, replaced by {@link #setBounds(int,int,int,int)}\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Write Comments in HTML + +The text must be written in HTML with HTML entities and HTML tags\&. You can use whichever version of HTML your browser supports\&. The standard doclet generates HTML 3\&.2-compliant code elsewhere (outside of the documentation comments) with the inclusion of cascading style sheets and frames\&. HTML 4\&.0 is preferred for generated files because of the frame sets\&. +.PP +For example, entities for the less than symbol (<) and the greater than symbol (>) should be written as \f3<\fR and \f3>\fR\&. Similarly, the ampersand (&) should be written as \f3&\fR\&. The bold HTML tag \f3<b>\fR is shown in the following example\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This is a <b>doc</b> comment\&.\fP +.fi +.nf +\f3 * @see java\&.lang\&.Object\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Leading Asterisks + +When the \f3javadoc\fR command parses a documentation comment, leading asterisks (*) on each line are discarded, and blanks and tabs that precede the initial asterisks (*) are also discarded\&. If you omit the leading asterisk on a line, then the leading white space is no longer removed so that you can paste code examples directly into a documentation comment inside a \f3<PRE>\fR tag with its indentation preserved\&. Spaces are interpreted by browsers more uniformly than tabs\&. Indentation is relative to the left margin (rather than the separator \f3/**\fR or \f3<PRE>\fR tag)\&. +.PP +First Sentence + +The first sentence of each documentation comment should be a summary sentence that contains a concise but complete description of the declared entity\&. This sentence ends at the first period that is followed by a blank, tab, or line terminator, or at the first block tag\&. The \f3javadoc\fR command copies this first sentence to the member summary at the top of the HTML page\&. +.PP +Multiple-Field Declarations + +The Java platform lets you declare multiple fields in a single statement, but this statement can have only one documentation comment that is copied for all fields\&. If you want individual documentation comments for each field, then declare each field in a separate statement\&. For example, the following documentation comment does not make sense written as a single declaration and would be better handled as two declarations: +.sp +.nf +\f3/** \fP +.fi +.nf +\f3 * The horizontal and vertical distances of point (x,y)\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public int x, y; // Avoid this \fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3javadoc\fR command generates the following documentation from the previous code: +.sp +.nf +\f3public int x\fP +.fi +.nf +\f3\fP +.fi +.sp +The horizontal and vertical distances of point (x, y)\&. +.sp +.nf +\f3public int y\fP +.fi +.nf +\f3\fP +.fi +.sp +The horizontal and vertical distances of point (x, y)\&. +.PP +Use of Header Tags + +When writing documentation comments for members, it is best not to use HTML heading tags such as \f3<H1>\fR and \f3<H2>\fR, because the \f3javadoc\fR command creates an entire structured document, and these structural tags might interfere with the formatting of the generated document\&. However, you can use these headings in class and package comments to provide your own structure\&. +.SS METHOD\ COMMENT\ INHERITANCE +The \f3javadoc\fR command allows method comment inheritance in classes and interfaces to fill in missing text or to explicitly inherit method comments\&. Constructors, fields, and nested classes do not inherit documentation comments\&. +.PP +\fINote:\fR The source file for an inherited method must be on the path specified by the \f3-sourcepath\fR option for the documentation comment to be available to copy\&. Neither the class nor its package needs to be passed in on the command line\&. This contrasts with Release 1\&.3\&.\fIn\fR and earlier releases, where the class had to be a documented class\&. +.PP +Fill in Missing Text + +When a main description, or \f3@return\fR, \f3@param\fR, or \f3@throws\fR tag is missing from a method comment, the \f3javadoc\fR command copies the corresponding main description or tag comment from the method it overrides or implements (if any)\&. See Method Comment Inheritance\&. +.PP +When an \f3@param\fR tag for a particular parameter is missing, the comment for that parameter is copied from the method further up the inheritance hierarchy\&. When an \f3@throws\fR tag for a particular exception is missing, the \f3@throws\fR tag is copied only when that exception is declared\&. +.PP +This behavior contrasts with Release 1\&.3 and earlier, where the presence of any main description or tag would prevent all comments from being inherited\&. +.PP +See Javadoc Tags and Options\&. +.PP +Explicit Inheritance + +Insert the \f3{@inheritDoc}\fR inline tag in a method main description or \f3@return\fR, \f3@param\fR, or \f3@throws\fR tag comment\&. The corresponding inherited main description or tag comment is copied into that spot\&. +.SS CLASS\ AND\ INTERFACE\ INHERITANCE +Comment inheritance occurs in all possible cases of inheritance from classes and interfaces: +.TP 0.2i +\(bu +When a method in a class overrides a method in a superclass +.TP 0.2i +\(bu +When a method in an interface overrides a method in a superinterface +.TP 0.2i +\(bu +When a method in a class implements a method in an interface +.PP +In the first two cases, the \f3javadoc\fR command generates the subheading \fIOverrides\fR in the documentation for the overriding method\&. A link to the method being overridden is included, whether or not the comment is inherited\&. +.PP +In the third case, when a method in a specified class implements a method in an interface, the \f3javadoc\fR command generates the subheading \fISpecified by\fR in the documentation for the overriding method\&. A link to the method being implemented is included, whether or not the comment is inherited\&. +.SS METHOD\ COMMENTS\ ALGORITHM +If a method does not have a documentation comment, or has an \f3{@inheritDoc}\fR tag, then the \f3javadoc\fR command uses the following algorithm to search for an applicable comment\&. The algorithm is designed to find the most specific applicable documentation comment, and to give preference to interfaces over superclasses: +.TP 0.4i +1\&. +Look in each directly implemented (or extended) interface in the order they appear following the word \f3implements\fR (or \f3extends\fR) in the method declaration\&. Use the first documentation comment found for this method\&. +.TP 0.4i +2\&. +If Step 1 failed to find a documentation comment, then recursively apply this entire algorithm to each directly implemented (or extended) interface in the same order they were examined in Step 1\&. +.TP 0.4i +3\&. +When Step 2 fails to find a documentation comment and this is a class other than the \f3Object\fR class, but not an interface: +.RS +.TP 0.4i +1\&. +If the superclass has a documentation comment for this method, then use it\&. +.TP 0.4i +2\&. +If Step 3a failed to find a documentation comment, then recursively apply this entire algorithm to the superclass\&. +.RE + +.SH JAVADOC\ TAGS +The \f3javadoc\fR command parses special tags when they are embedded within a Java documentation comment\&. The \f3javadoc\fR tags let you autogenerate a complete, well-formatted API from your source code\&. The tags start with an at sign (\f3@\fR) and are case-sensitive\&. They must be typed with the uppercase and lowercase letters as shown\&. A tag must start at the beginning of a line (after any leading spaces and an optional asterisk), or it is treated as text\&. By convention, tags with the same name are grouped together\&. For example, put all \f3@see\fR tags together\&. For more information, see Where Tags Can Be Used\&. +.PP +Tags have the following types: +.TP 0.2i +\(bu +Bock tags: Place block tags only in the tag section that follows the description\&. Block tags have the form: \fI@tag\fR\&. +.TP 0.2i +\(bu +Inline tags: Place inline tags anywhere in the main description or in the comments for block tags\&. Inline tags are enclosed within braces: \fI{@tag}\fR\&. +.PP +For custom tags, see -tag tagname:Xaoptcmf:"taghead"\&. See also Where Tags Can Be Used\&. +.SS TAG\ DESCRIPTIONS +.TP +@author \fIname-text\fR +Introduced in JDK 1\&.0 + +Adds an Author entry with the specified name text to the generated documents when the \f3-author\fR option is used\&. A documentation comment can contain multiple \f3@author\fR tags\&. You can specify one name per \f3@author\fR tag or multiple names per tag\&. In the former case, the \f3javadoc\fR command inserts a comma (,) and space between names\&. In the latter case, the entire text is copied to the generated document without being parsed\&. Therefore, you can use multiple names per line if you want a localized name separator other than a comma\&. See @author in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@author +.TP +{@code \fItext\fR} +Introduced in JDK 1\&.5 + +Equivalent to \f3<code>{@literal}</code>\fR\&. + +Displays text in code font without interpreting the text as HTML markup or nested Javadoc tags\&. This enables you to use regular angle brackets (< and >) instead of the HTML entities (\f3<\fR and \f3>\fR) in documentation comments, such as in parameter types (\f3<Object>\fR), inequalities (\f33 < 4\fR), or arrows (\f3<-\fR)\&. For example, the documentation comment text \f3{@code A<B>C}\fR displayed in the generated HTML page unchanged as \f3A<B>C\fR\&. This means that the \f3<B>\fR is not interpreted as bold and is in code font\&. If you want the same functionality without the code font, then use the \f3{@literal}\fR tag\&. +.TP +@deprecated \fIdeprecated-text\fR +Introduced in JDK 1\&.0 + +Adds a comment indicating that this API should no longer be used (even though it may continue to work)\&. The \f3javadoc\fR command moves \f3deprecated-text\fRahead of the main description, placing it in italics and preceding it with a bold warning: Deprecated\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field\&. + +The first sentence of deprecated text should tell the user when the API was deprecated and what to use as a replacement\&. The \f3javadoc\fR command copies the first sentence to the summary section and index\&. Subsequent sentences can also explain why it was deprecated\&. You should include an \f3{@link}\fR tag (for Javadoc 1\&.2 or later) that points to the replacement API\&. + +Use the \fI@deprecated annotation\fR tag to deprecate a program element\&. See How and When to Deprecate APIs at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/deprecation/deprecation\&.html + +See also @deprecated in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@deprecated +.TP +{@docRoot} +Introduced in JDK 1\&.3 + +Represents the relative path to the generated document\&'s (destination) root directory from any generated page\&. This tag is useful when you want to include a file, such as a copyright page or company logo, that you want to reference from all generated pages\&. Linking to the copyright page from the bottom of each page is common\&. + +This \f3{@docRoot}\fR tag can be used both on the command line and in a documentation comment\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field, and includes the text portion of any tag (such as the \f3@return\fR, \f3@param\fR and \f3@deprecated\fR tags)\&. +.RS +.TP 0.2i +\(bu +On the command line, where the header, footer, or bottom are defined: \f3javadoc -bottom \&'<a href="{@docRoot}/copyright\&.html">Copyright</a>\&'\fR\&. + +When you use the \f3{@docRoot}\fR tag this way in a make file, some \f3makefile\fR programs require a special way to escape for the brace \f3{}\fR characters\&. For example, the Inprise MAKE version 5\&.2 running on Windows requires double braces: \f3{{@docRoot}}\fR\&. It also requires double (rather than single) quotation marks to enclose arguments to options such as the \f3-bottom\fR option (with the quotation marks around the \f3href\fR argument omitted)\&. +.TP 0.2i +\(bu +In a documentation comment: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * See the <a href="{@docRoot}/copyright\&.html">Copyright</a>\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This tag is needed because the generated documents are in hierarchical directories, as deep as the number of subpackages\&. The expression: \f3<a href="{@docRoot}/copyright\&.html">\fR resolves to \f3<a href="\&.\&./\&.\&./copyright\&.html">\fR for \f3java/lang/Object\&.java\fR and \f3<a href="\&.\&./\&.\&./\&.\&./copyright\&.html">\fR for \f3java/lang/ref/Reference\&.java\fR\&. +.RE + +.TP +@exception \fIclass-name description\fR +Introduced in JDK 1\&.0 + +Identical to the \f3@throws\fR tag\&. See @throws class-name description\&. +.TP +{@inheritDoc} +Introduced in JDK 1\&.4 + +Inherits (copies) documentation from the nearest inheritable class or implementable interface into the current documentation comment at this tag\&'s location\&. This enables you to write more general comments higher up the inheritance tree and to write around the copied text\&. + +This tag is valid only in these places in a documentation comment: +.RS +.TP 0.2i +\(bu +In the main description block of a method\&. In this case, the main description is copied from a class or interface up the hierarchy\&. +.TP 0.2i +\(bu +In the text arguments of the \f3@return\fR, \f3@param,\fR and \f3@throws\fR tags of a method\&. In this case, the tag text is copied from the corresponding tag up the hierarchy\&. +.RE + + +See Method Comment Inheritance for a description of how comments are found in the inheritance hierarchy\&. Note that if this tag is missing, then the comment is or is not automatically inherited according to rules described in that section\&. +.TP +{@link \fIpackage\&.class#member label\fR} +Introduced in JDK 1\&.2 + +Inserts an inline link with a visible text label that points to the documentation for the specified package, class, or member name of a referenced class\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field, including the text portion of any tag, such as the \f3@return\fR, \f3@param\fR and \f3@deprecated\fR tags\&. See @link in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#{@link + +This tag is similar to the \f3@see\fR tag\&. Both tags require the same references and accept the same syntax for \f3package\&.class#member\fR and \f3label\fR\&. The main difference is that the \f3{@link}\fR tag generates an inline link rather than placing the link in the See Also section\&. The \f3{@link}\fR tag begins and ends with braces to separate it from the rest of the inline text\&. If you need to use the right brace (\f3}\fR) inside the label, then use the HTML entity notation \f3}\fR\&. + +There is no limit to the number of \f3{@link}\fR tags allowed in a sentence\&. You can use this tag in the main description part of any documentation comment or in the text portion of any tag, such as the \f3@deprecated\fR, \f3@return\fR or \f3@param\fR tags\&. + +For example, here is a comment that refers to the \f3getComponentAt(int, int)\fR method: +.sp +.nf +\f3Use the {@link #getComponentAt(int, int) getComponentAt} method\&.\fP +.fi +.nf +\f3\fP +.fi +.sp + + +From this code, the standard doclet generates the following HTML (assuming it refers to another class in the same package): +.sp +.nf +\f3Use the <a href="Component\&.html#getComponentAt(int, int)">getComponentAt</a> method\&.\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The previous line appears on the web page as: +.sp +.nf +\f3Use the getComponentAt method\&.\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +{@linkplain \fIpackage\&.class#member label\fR} +Introduced in JDK 1\&.4 + +Behaves the same as the \f3{@link}\fR tag, except the link label is displayed in plain text rather than code font\&. Useful when the label is plain text\&. For example, \f3Refer to {@linkplain add() the overridden method}\fR\&. displays as: Refer to the overridden method\&. +.TP +{@literal \fItext\fR} +Introduced in JDK 1\&.5 + +Displays text without interpreting the text as HTML markup or nested Javadoc tags\&. This enables you to use angle brackets (\f3< and >\fR) instead of the HTML entities (\f3<\fR and \f3>\fR) in documentation comments, such as in parameter types (\f3<Object>\fR), inequalities (\f33 < 4\fR), or arrows (<-)\&. For example, the documentation comment text \f3{@literal A<B>C}\fR displays unchanged in the generated HTML page in your browser, as \f3A<B>C\fR\&. The \f3<B>\fR is not interpreted as bold (and it is not in code font)\&. If you want the same functionality with the text in code font, then use the \f3{@code}\fR tag\&. +.TP +@param \fIparameter-name description\fR +Introduced in JDK 1\&.0 + +Adds a parameter with the specified \f3parameter-name\fR followed by the specified description to the Parameters section\&. When writing the documentation comment, you can continue the description onto multiple lines\&. This tag is valid only in a documentation comment for a method, constructor, or class\&. See @param in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@param + +The \f3parameter-name\fR can be the name of a parameter in a method or constructor, or the name of a type parameter of a class, method, or constructor\&. Use angle brackets around this parameter name to specify the use of a type parameter\&. + +Example of a type parameter of a class: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @param <E> Type of element stored in a list\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public interface List<E> extends Collection<E> {\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Example of a type parameter of a method: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @param string the string to be converted\fP +.fi +.nf +\f3 * @param type the type to convert the string to\fP +.fi +.nf +\f3 * @param <T> the type of the element\fP +.fi +.nf +\f3 * @param <V> the value of the element\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3<T, V extends T> V convert(String string, Class<T> type) {\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +@return \fIdescription\fR +Introduced in JDK 1\&.0 + +Adds a Returns section with the description text\&. This text should describe the return type and permissible range of values\&. This tag is valid only in a documentation comment for a method\&. See @return in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@return +.TP +@see \fIreference\fR +Introduced in JDK 1\&.0 + +Adds a \fISee Also\fR heading with a link or text entry that points to a reference\&. A documentation comment can contain any number of \f3@see\fR tags, which are all grouped under the same heading\&. The \f3@see\fR tag has three variations\&. The form is the most common\&. This tag is valid in any documentation comment: overview, package, class, interface, constructor, method, or field\&. For inserting an inline link within a sentence to a package, class, or member, see \f3{@link}\fR\&. + +\fIForm 1\fR\&. The @see \f3string\fR tag form adds a text entry for \fIstring\fR\&. No link is generated\&. The string is a book or other reference to information not available by URL\&. The \f3javadoc\fR command distinguishes this from the previous cases by searching for a double quotation mark (") as the first character\&. For example, \f3@see "The Java Programming Language"\fR that generates the following text: + +\fISee Also\fR: + +"The Java Programming Language" + +\fIForm 2\fR\&. The \f3@see <a href="URL#value">label</a>\fR form adds a link as defined by \f3URL#value\fR\&. The \f3URL#value\fR parameter is a relative or absolute URL\&. The \f3javadoc\fR command distinguishes this from other cases by searching for a less-than symbol (\f3<\fR) as the first character\&. For example, \f3@see <a href="spec\&.html#section">Java Spec</a>\fR generates the following link: + +\fISee Also\fR: + +Java Spec + +\fIForm 3\fR\&. The \f3@see package\&.class#member label\fR form adds a link with a visible text label that points to the documentation for the specified name in the Java Language that is referenced\&. The label is optional\&. If the label is omitted, then the name appears instead as visible text, suitably shortened\&. Use the \f3-noqualifier\fR option to globally remove the package name from this visible text\&. Use the label when you want the visible text to be different from the autogenerated visible text\&. See How a Name Appears\&. + +In Java SE 1\&.2 only, the name but not the label automatically appears in \f3<code>\fR HTML tags\&. Starting with Java SE 1\&.2\&.2, the \f3<code>\fR tag is always included around the visible text, whether or not a label is used\&. +.RS +.TP 0.2i +\(bu +\f3package\&.class#member\fR is any valid program element name that is referenced, such as a package, class, interface, constructor, method or field name, except that the character ahead of the member name should be a number sign (\f3#\fR)\&. The class represents any top-level or nested class or interface\&. The member represents any constructor, method, or field (not a nested class or interface)\&. If this name is in the documented classes, then the \f3javadoc\fR command create a link to it\&. To create links to external referenced classes, use the \f3-link\fR option\&. Use either of the other two \f3@see\fR tag forms to refer to the documentation of a name that does not belong to a referenced class\&. See Specify a Name\&. + +\fINote:\fR External referenced classes are classes that are not passed into the \f3javadoc\fR command on the command line\&. Links in the generated documentation to external referenced classes are called external references or external links\&. For example, if you run the \f3javadoc\fR command on only the \f3java\&.awt package\fR, then any class in \f3java\&.lang\fR, such as \f3Object\fR, is an external referenced class\&. Use the \f3-link\fR and \f3-linkoffline\fR options to link to external referenced classes\&. The source comments of external referenced classes are not available to the \f3javadoc\fR command run\&. +.TP 0.2i +\(bu +\f3label\fR is optional text that is visible as the link label\&. The label can contain white space\&. If \f3label\fR is omitted, then \f3package\&.class\&.member\fR appears, suitably shortened relative to the current class and package\&. See How a Name Appears\&. +.TP 0.2i +\(bu +A space is the delimiter between \f3package\&.class#member\fR and \f3label\fR\&. A space inside parentheses does not indicate the start of a label, so spaces can be used between parameters in a method\&. +.RE + + +\fI\fRIn the following example, an \f3@see\fR tag (in the \f3Character\fR class) refers to the equals method in the \f3String\fR class\&. The tag includes both arguments: the name \f3String#equals(Object)\fR and the label \f3equals\fR\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @see String#equals(Object) equals\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The standard doclet produces HTML that is similar to: +.sp +.nf +\f3<dl>\fP +.fi +.nf +\f3<dt><b>See Also:</b>\fP +.fi +.nf +\f3<dd><a href="\&.\&./\&.\&./java/lang/String#equals(java\&.lang\&.Object)"><code>equals<code></a>\fP +.fi +.nf +\f3</dl>\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The previous code looks similar to the following in a browser, where the label is the visible link text: + +\fISee Also\fR: + +equals +.PP +Specify a Name + +\fI\fRThis \f3package\&.class#member\fR name can be either fully qualified, such as \f3java\&.lang\&.String#toUpperCase()\fR or not, such as \f3String#toUpperCase()\fR or \f3#toUpperCase()\fR\&. If the name is less than fully qualified, then the \f3javadoc\fR command uses the standard Java compiler search order to find it\&. See Search Order for the @see Tag\&. The name can contain white space within parentheses, such as between method arguments\&.The advantage to providing shorter, partially qualified names is that they are shorter to type and there is less clutter in the source code\&. The following listing shows the different forms of the name, where \f3Class\fR can be a class or interface; Type can be a class, interface, array, or primitive; and method can be a method or constructor\&. +.sp +.nf +\f3\fITypical forms for\fR\fI @see package\&.class#member\fR\fP +.fi +.nf +\f3\fIReferencing a member of the current class\fR\fP +.fi +.nf +\f3@see #field\fP +.fi +.nf +\f3@see #method(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see #method(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see #constructor(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see #constructor(Type argname, Type argname,\&.\&.\&.) \fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\fIReferencing another class in the current or imported packages\fR\fP +.fi +.nf +\f3@see Class#field\fP +.fi +.nf +\f3@see Class#method(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see Class#method(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see Class#constructor(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see Class#constructor(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see Class\&.NestedClass\fP +.fi +.nf +\f3@see Class \fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\fIReferencing an element in another package (fully qualified)\fR\fP +.fi +.nf +\f3@see package\&.Class#field\fP +.fi +.nf +\f3@see package\&.Class#method(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see package\&.Class#method(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see package\&.Class#constructor(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see package\&.Class#constructor(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see package\&.Class\&.NestedClass\fP +.fi +.nf +\f3@see package\&.Class\fP +.fi +.nf +\f3@see package\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3\fRNotes about the previous listing: +.TP 0.2i +\(bu +The first set of forms with no class or package causes the \f3javadoc\fR command to search only through the current class hierarchy\&. It finds a member of the current class or interface, one of its superclasses or superinterfaces, or one of its enclosing classes or interfaces (search Items 1\(en3)\&. It does not search the rest of the current package or other packages (search Items 4\(en5)\&. See Search Order for the @see Tag\&. +.TP 0.2i +\(bu +If any method or constructor is entered as a name with no parentheses, such as \f3getValue\fR, and if there is no field with the same name, then the \f3javadoc\fR command still creates a link to the method\&. If this method is overloaded, then the \f3javadoc\fR command links to the first method its search encounters, which is unspecified\&. +.TP 0.2i +\(bu +Nested classes must be specified as \f3outer\&.inner\fR, not simply \f3inner\fR, for all forms\&. +.TP 0.2i +\(bu +As stated, the number sign (\f3#\fR), rather than a dot (\f3\&.\fR) separates a member from its class\&. This enables the \f3javadoc\fR command to resolve ambiguities, because the dot also separates classes, nested classes, packages, and subpackages\&. However, the \f3javadoc\fR command properly parses a dot when there is no ambiguity, but prints a warning to alert you\&. +.PP +Search Order for the @see Tag + +\fI\fRThe \f3javadoc\fR command processes an \f3@see\fR tag that appears in a source file, package file, or overview file\&. In the latter two files, you must fully qualify the name you supply with the \f3@see\fR tag\&. In a source file, you can specify a name that is fully qualified or partially qualified\&. +.PP +The following is the search order for the \f3@see\fR tag\&. +.TP 0.4i +1\&. +The current class or interface\&. +.TP 0.4i +2\&. +Any enclosing classes and interfaces searching the closest first\&. +.TP 0.4i +3\&. +Any superclasses and superinterfaces, searching the closest first\&. +.TP 0.4i +4\&. +The current package\&. +.TP 0.4i +5\&. +Any imported packages, classes, and interfaces, searching in the order of the \f3import\fR statement\&. +.PP +The \f3javadoc\fR command continues to search recursively through Items 1-3 for each class it encounters until it finds a match\&. That is, after it searches through the current class and its enclosing class E, it searches through the superclasses of E before the enclosing classes of E\&. In Items 4 and 5, the \f3javadoc\fR command does not search classes or interfaces within a package in any specified order (that order depends on the particular compiler)\&. In Item 5, the \f3javadoc\fR command searches in \fIjava\&.lang\fR because that is imported by all programs\&. +.PP +When the \f3javadoc\fR command encounters an \f3@see\fR tag in a source file that is not fully qualified, it searches for the specified name in the same order as the Java compiler would, except the \f3javadoc\fR command does not detect certain name space ambiguities because it assumes the source code is free of these errors\&. This search order is formally defined in the Java Language Specification\&. The \f3javadoc\fR command searches for that name through all related and imported classes and packages\&. In particular, it searches in this order: +.TP 0.4i +1\&. +The current class or interface\&. +.TP 0.4i +2\&. +Any enclosing classes and interfaces, searching the closest first\&. +.TP 0.4i +3\&. +Any superclasses and superinterfaces, searching the closest first\&. +.TP 0.4i +4\&. +The current package\&. +.TP 0.4i +5\&. +Any imported packages, classes, and interfaces, searching in the order of the \f3import\fR statements\&. +.PP +The \f3javadoc\fR command does not necessarily look in subclasses, nor will it look in other packages even when their documentation is being generated in the same run\&. For example, if the \f3@see\fR tag is in the \f3java\&.awt\&.event\&.KeyEvent\fR class and refers to a name in the \f3java\&.awt package\fR, then the \f3javadoc\fR command does not look in that package unless that class imports it\&. +.PP +How a Name Appears + +\fI\fRIf \f3label\fR is omitted, then \f3package\&.class\&.member\fR appears\&. In general, it is suitably shortened relative to the current class and package\&. Shortened means the \f3javadoc\fR command displays only the minimum name necessary\&. For example, if the \f3String\&.toUpperCase()\fR method contains references to a member of the same class and to a member of a different class, then the class name is displayed only in the latter case, as shown in the following listing\&. Use the \f3-noqualifier\fR option to globally remove the package names\&. +.PP +\fIType of reference\fR: The \f3@see\fR tag refers to a member of the same class, same package +.br +\fIExample in\fR: \f3@see String#toLowerCase()\fR +.br +\fIAppears as\fR: \f3toLowerCase()\fR - omits the package and class names +.br + +.PP +\fIType of reference\fR: The \f3@see\fR tag refers to a member of a different class, same package +.br +\fIExample in\fR: \f3@see Character#toLowerCase(char)\fR +.br +\fIAppears as\fR: \f3Character\&.toLowerCase(char)\fR - omits the package name, includes the class name +.br + +.PP +\fIType of reference\fR: The \f3@see\fR tag refers to a member of a different class, different package +.br +\fIExample in\fR: \f3@see java\&.io\&.File#exists()\fR +.br +\fIAppears as\fR: \f3java\&.io\&.File\&.exists()\fR - includes the package and class names +.br + +.PP +Examples of the @see Tag + +The comment to the right shows how the name appears when the \f3@see\fR tag is in a class in another package, such as \f3java\&.applet\&.Applet\fR\&. See @see in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@see +.sp +.nf +\f3 See also:\fP +.fi +.nf +\f3@see java\&.lang\&.String // String \fP +.fi +.nf +\f3@see java\&.lang\&.String The String class // The String class \fP +.fi +.nf +\f3@see String // String \fP +.fi +.nf +\f3@see String#equals(Object) // String\&.equals(Object) \fP +.fi +.nf +\f3@see String#equals // String\&.equals(java\&.lang\&.Object) \fP +.fi +.nf +\f3@see java\&.lang\&.Object#wait(long) // java\&.lang\&.Object\&.wait(long) \fP +.fi +.nf +\f3@see Character#MAX_RADIX // Character\&.MAX_RADIX \fP +.fi +.nf +\f3@see <a href="spec\&.html">Java Spec</a> // Java Spec \fP +.fi +.nf +\f3@see "The Java Programming Language" // "The Java Programming Language" \fP +.fi +.nf +\f3\fP +.fi +.sp +\fINote:\fR You can extend the \f3@se\fR\f3e\fR tag to link to classes not being documented with the \f3-link\fR option\&. +.TP +@serial \fIfield-description\fR | include | exclude +Introduced in JDK 1\&.2 + +Used in the documentation comment for a default serializable field\&. See Documenting Serializable Fields and Data for a Class at http://docs\&.oracle\&.com/javase/8/docs/platform/serialization/spec/serial-arch\&.html#5251 + +See also Oracle\(cqs Criteria for Including Classes in the Serialized Form Specification at http://www\&.oracle\&.com/technetwork/java/javase/documentation/serialized-criteria-137781\&.html + +An optional \f3field-description\fR should explain the meaning of the field and list the acceptable values\&. When needed, the description can span multiple lines\&. The standard doclet adds this information to the serialized form page\&. See Cross-Reference Pages\&. + +If a serializable field was added to a class after the class was made serializable, then a statement should be added to its main description to identify at which version it was added\&. + +The \f3include\fR and \f3exclude\fR arguments identify whether a class or package should be included or excluded from the serialized form page\&. They work as follows: +.RS +.TP 0.2i +\(bu +A public or protected class that implements \f3Serializable\fR is included unless that class (or its package) is marked with the \f3@serial exclude\fR tag\&. +.TP 0.2i +\(bu +A private or package-private class that implements \f3Serializable\fR is excluded unless that class (or its package) is marked with the \f3@serial include\fR tag\&. +.RE + + +For example, the \f3javax\&.swing\fR package is marked with the \f3@serial\fR\f3exclude\fR tag in package\&.html or package-info\&.java\&. The public class \f3java\&.security\&.BasicPermission\fR is marked with the \f3@serial exclude\fR tag\&. The package-private class \f3java\&.util\&.PropertyPermissionCollection\fR is marked with the \f3@serial include\fR tag\&. + +The \f3@serial\fR tag at the class level overrides the \f3@serial\fR tag at the package level\&. +.TP +@serialData \fIdata-description\fR +Introduced in JDK 1\&.2 + +Uses the data description value to document the types and order of data in the serialized form\&. This data includes the optional data written by the \f3writeObject\fR method and all data (including base classes) written by the \f3Externalizable\&.writeExternal\fR method\&. + +The \f3@serialData\fR tag can be used in the documentation comment for the \f3writeObject\fR, \f3readObject\fR, \f3writeExternal\fR, \f3readExternal\fR, \f3writeReplace\fR, and \f3readResolve\fR methods\&. +.TP +@serialField \fIfield-name\fR\fIfield-type\fR\fIfield-description\fR +Introduced in JDK 1\&.2 + +Documents an \f3ObjectStreamField\fR component of the \f3serialPersistentFields\fR member of a \f3Serializable\fR class\&. Use one \f3@serialField\fR tag for each \f3ObjectStreamField\fR component\&. +.TP +@since \fIsince-text\fR +Introduced in JDK 1\&.1 + +Adds a \fISince\fR heading with the specified \f3since-text\fR value to the generated documentation\&. The text has no special internal structure\&. This tag is valid in any documentation comment: overview, package, class, interface, constructor, method, or field\&. This tag means that this change or feature has existed since the software release specified by the \f3since-text\fR value, for example: \f3@since 1\&.5\fR\&. + +For Java platform source code, the \f3@since\fR tag indicates the version of the Java platform API specification, which is not necessarily when the source code was added to the reference implementation\&. Multiple \f3@since\fR tags are allowed and are treated like multiple \f3@author\fR tags\&. You could use multiple tags when the program element is used by more than one API\&. +.TP +@throws \fIclass-name\fR\fIdescription\fR +Introduced in JDK 1\&.2 + +Behaves the same as the \f3@exception\fR tag\&. See @throws in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@exception + +The \f3@throws\fR tag adds a \fIThrows\fR subheading to the generated documentation, with the \f3class-name\fR and \f3description\fR text\&. The \fIclass-name\fR is the name of the exception that might be thrown by the method\&. This tag is valid only in the documentation comment for a method or constructor\&. If this class is not fully specified, then the \f3javadoc\fR command uses the search order to look up this class\&. Multiple \f3@throws\fR tags can be used in a specified documentation comment for the same or different exceptions\&. See Search Order for the @see Tag\&. + +To ensure that all checked exceptions are documented, when an \f3@throws\fR tag does not exist for an exception in the throws clause, the \f3javadoc\fR command adds that exception to the HTML output (with no description) as though it were documented with the \f3@throws\fR tag\&. + +The \f3@throws\fR documentation is copied from an overridden method to a subclass only when the exception is explicitly declared in the overridden method\&. The same is true for copying from an interface method to an implementing method\&. You can use the \f3{@inheritDoc}\fR tag to force the \f3@throws\fR tag to inherit documentation\&. +.TP +{@value \fIpackage\&.class#field\fR} +Introduced in JDK 1\&.4 + +Displays constant values\&. When the \f3{@value}\fR tag is used without an argument in the documentation comment of a static field, it displays the value of that constant: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * The value of this constant is {@value}\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public static final String SCRIPT_START = "<script>"\fP +.fi +.nf +\f3\fP +.fi +.sp + + +When used with the argument \f3package\&.class#field\fR in any documentation comment, he \f3{@value}\fR tag displays the value of the specified constant: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * Evaluates the script starting with {@value #SCRIPT_START}\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public String evalScript(String script) {}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The argument \f3package\&.class#field\fR takes a form similar to that of the \f3@see\fR tag argument, except that the member must be a static field\&. + +The values of these constants are also displayed in Constant Field Values at http://docs\&.oracle\&.com/javase/8/docs/api/constant-values\&.html +.TP +@version \fIversion-text\fR +Introduced in JDK 1\&.0 + +Adds a \fIVersion\fR subheading with the specified \f3version-text\fR value to the generated documents when the \f3-version\fR option is used\&. This tag is intended to hold the current release number of the software that this code is part of, as opposed to the\f3@since\fR tag, which holds the release number where this code was introduced\&. The \f3version-text\fR value has no special internal structure\&. See @version in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@version + +A documentation comment can contain multiple \f3@version\fR tags\&. When it makes sense, you can specify one release number per \f3@version\fR tag or multiple release numbers per tag\&. In the former case, the \f3javadoc\fR command inserts a comma (,) and a space between the names\&. In the latter case, the entire text is copied to the generated document without being parsed\&. Therefore, you can use multiple names per line when you want a localized name separator other than a comma\&. +.SH WHERE\ TAGS\ CAN\ BE\ USED +The following sections describe where tags can be used\&. Note that the following tags can be used in all documentation comments: \f3@see\fR, \f3@since\fR, \f3@deprecated\fR, \f3{@link}\fR, \f3{@linkplain}\fR, and \f3{@docroot}\fR\&. +.SS OVERVIEW\ TAGS +Overview tags are tags that can appear in the documentation comment for the overview page (which resides in the source file typically named overview\&.html)\&. Similar to any other documentation comments, these tags must appear after the main description +.PP +\fINote:\fR The \f3{@link}\fR tag has a bug in overview documents in Java SE 1\&.2\&. The text appears correctly but has no link\&. The \f3{@docRoot}\fR tag does not currently work in overview documents\&. +.PP +The overview tags are the following: +.PP +@see reference || @since since-text || @serialField field-name field-type field-description || @author name-text || @version version-text || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || +.SS PACKAGE\ TAGS +Package tags are tags that can appear in the documentation comment for a package, that resides in the source file named package\&.html or package-info\&.java\&. The \f3@serial\fR tag can only be used here with the \f3include\fR or \f3exclude\fR argument\&. +.PP +The package tags are the following: +.PP +@see reference || @since since-text || @serial field-description | include | exclude || @author name-text || @version version-text || {@linkplain package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || +.SS CLASS\ AND\ INTERFACE\ TAGS +The following are tags that can appear in the documentation comment for a class or interface\&. The \f3@serial\fR tag can only be used within the documentation for a class or interface with an \f3include\fR or \f3exclude\fR argument\&. +.PP +@see reference || @since since-text || @deprecated deprecated-text || @serial field-description | include | exclude || @author name-text || @version version-text || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || +.PP +Class comment example: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * A class representing a window on the screen\&.\fP +.fi +.nf +\f3 * For example:\fP +.fi +.nf +\f3 * <pre>\fP +.fi +.nf +\f3 * Window win = new Window(parent);\fP +.fi +.nf +\f3 * win\&.show();\fP +.fi +.nf +\f3 * </pre>\fP +.fi +.nf +\f3 *\fP +.fi +.nf +\f3 * @author Sami Shaio\fP +.fi +.nf +\f3 * @version 1\&.13, 06/08/06\fP +.fi +.nf +\f3 * @see java\&.awt\&.BaseWindow\fP +.fi +.nf +\f3 * @see java\&.awt\&.Button\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3class Window extends BaseWindow {\fP +.fi +.nf +\f3 \&.\&.\&.\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS FIELD\ TAGS +These tags can appear in fields: +.PP +@see reference || @since since-text || @deprecated deprecated-text || @serial field-description | include | exclude || @serialField field-name field-type field-description || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || {@value package\&.class#field} +.PP +Field comment example: +.sp +.nf +\f3 /**\fP +.fi +.nf +\f3 * The X\-coordinate of the component\&.\fP +.fi +.nf +\f3 *\fP +.fi +.nf +\f3 * @see #getLocation()\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3 int x = 1263732;\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS CONSTRUCTOR\ AND\ METHOD\ TAGS +The following tags can appear in the documentation comment for a constructor or a method, except for the \f3@return\fR tag, which cannot appear in a constructor, and the \f3{@inheritDoc}\fR tag, which has restrictions\&. +.PP +@see reference || @since since-text || @deprecated deprecated-text || @param parameter-name description || @return description || @throws class-name description || @exception class-name description || @serialData data-description || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@inheritDoc} || {@docRoot} +.PP +\fINote:\fR The \f3@serialData\fR tag can only be used in the documentation comment for the \f3writeObject\fR, \f3readObject\fR, \f3writeExternal\fR, \f3readExternal\fR, \f3writeReplace\fR, and \f3readResolve\fR methods\&. +.PP +Method comment example: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * Returns the character at the specified index\&. An index \fP +.fi +.nf +\f3 * ranges from <code>0</code> to <code>length() \- 1</code>\fP +.fi +.nf +\f3 *\fP +.fi +.nf +\f3 * @param index the index of the desired character\&.\fP +.fi +.nf +\f3 * @return the desired character\&.\fP +.fi +.nf +\f3 * @exception StringIndexOutOfRangeException \fP +.fi +.nf +\f3 * if the index is not in the range <code>0</code> \fP +.fi +.nf +\f3 * to <code>length()\-1</code>\fP +.fi +.nf +\f3 * @see java\&.lang\&.Character#charValue()\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3 public char charAt(int index) {\fP +.fi +.nf +\f3 \&.\&.\&.\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +The \f3javadoc\fR command uses doclets to determine its output\&. The \f3javadoc\fR command uses the default standard doclet unless a custom doclet is specified with the \f3-doclet\fR option\&. The \f3javadoc\fR command provides a set of command-line options that can be used with any doclet\&. These options are described in Javadoc Options\&. The standard doclet provides an additional set of command-line options that are described in Standard Doclet Options\&. All option names are not case-sensitive, but their arguments are case-sensitive\&. +.TP 0.2i +\(bu +See also Javadoc Options +.TP 0.2i +\(bu +See also Standard Doclet Options +.PP +The options are: +.PP +-1\&.1 || -author || -bootclasspath classpathlist || -bottom text || -breakiterator || -charset name || -classpath classpathlist || -d directory || -docencoding name || -docfilesubdirs || -doclet class || -docletpath classpathlist || -doctitle title || -encoding || -exclude packagename1:packagename2:\&.\&.\&. || -excludedocfilessubdir name1:name2 || -extdirs dirist || -footer footer || -group groupheading packagepattern:packagepattern || -header header || -help || -helpfile path\efilename || -Jflag || -javafx ||-keywords || -link extdocURL || -linkoffline extdocURL packagelistLoc || -linksource || -locale language_country_variant || -nocomment || -nodeprecated || -nodeprecatedlist || -nohelp || -noindex || -nonavbar || -noqualifier all | packagename1:packagename2\&.\&.\&. || -nosince || -notimestamp || -notree || -overview path/filename || -package || -private || -protected || -public || -quiet || -serialwarn || -source release || -sourcepath sourcepathlist || -sourcetab tablength || -splitindex || -stylesheet path/filename || -subpackages package1:package2:\&.\&.\&. || -tag tagname:Xaoptcmf:"taghead" || -taglet class || -tagletpath tagletpathlist || -title title || -top || -use || -verbose || -version || -windowtitle title +.PP +The following options are the core Javadoc options that are available to all doclets\&. The standard doclet provides the rest of the doclets: \f3-bootclasspath\fR, \f3-breakiterator\fR, \f3-classpath\fR, \f3-doclet\fR, \f3-docletpath\fR, \f3-encoding\fR, -\f3exclude\fR, \f3-extdirs\fR, \f3-help\fR, \f3-locale\fR, \f3-\fR\f3overview\fR, \f3-package\fR, \f3-private\fR, \f3-protected\fR, \f3-public\fR, \f3-quiet\fR, \f3-source\fR, \f3-sourcepath\fR, \f3-subpackages\fR, and \f3-verbose\fR\&. +.SS JAVADOC\ OPTIONS +.TP +-overview \fIpath/filename\fR +.br +Specifies that the \f3javadoc\fR command should retrieve the text for the overview documentation from the source file specified by the \fIpath/filename\fRand place it on the Overview page (overview-summary\&.html)\&. The \fIpath/filename\fRis relative to the current directory\&. + +While you can use any name you want for the \f3filename\fR value and place it anywhere you want for the path, it is typical to name it overview\&.html and place it in the source tree at the directory that contains the topmost package directories\&. In this location, no path is needed when documenting packages, because the \f3-sourcepath\fR option points to this file\&. + +For example, if the source tree for the \f3java\&.lang\fR package is /src/classes/java/lang/, then you could place the overview file at /src/classes/overview\&.html + +See Real-World Examples\&. + +For information about the file specified by \fIpath/filename,\fRsee Overview Comment Files\&. + +The overview page is created only when you pass two or more package names to the \f3javadoc\fR command\&. For a further explanation, see HTML Frames\&. The title on the overview page is set by \f3-doctitle\fR\&. +.TP +-Xdoclint:(all|none|[-]\fI<group>\fR) +.br +Reports warnings for bad references, lack of accessibility and missing Javadoc comments, and reports errors for invalid Javadoc syntax and missing HTML tags\&. + +This option enables the \f3javadoc\fR command to check for all documentation comments included in the generated output\&. As always, you can select which items to include in the generated output with the standard options \f3-public\fR, \f3-protected\fR, \f3-package\fR and \f3-private\fR\&. + +When the \f3-Xdoclint\fR is enabled, it reports issues with messages similar to the \f3javac\fR command\&. The \f3javadoc\fR command prints a message, a copy of the source line, and a caret pointing at the exact position where the error was detected\&. Messages may be either warnings or errors, depending on their severity and the likelihood to cause an error if the generated documentation were run through a validator\&. For example, bad references or missing Javadoc comments do not cause the \f3javadoc\fR command to generate invalid HTML, so these issues are reported as warnings\&. Syntax errors or missing HTML end tags cause the \f3javadoc\fR command to generate invalid output, so these issues are reported as errors\&. + +By default, the \f3-Xdoclint\fR option is enabled\&. Disable it with the option \f3-Xdoclint:none\fR\&. + +Change what the \f3-Xdoclint\fR option reports with the following options: +.RS +.TP 0.2i +\(bu +\f3-Xdoclint none\fR : disable the \f3-Xdoclint\fR option +.TP 0.2i +\(bu +\f3-Xdoclint\fR\fIgroup\fR : enable \fIgroup\fR checks +.TP 0.2i +\(bu +\f3-Xdoclint all\fR : enable all groups of checks +.TP 0.2i +\(bu +\f3-Xdoclint all,\fR\fI-group\fR : enable all except \fIgroup\fR checks +.RE + + +The variable \fIgroup\fR has one of the following values: +.RS +.TP 0.2i +\(bu +\f3accessibility\fR : Checks for the issues to be detected by an accessibility checker (for example, no caption or summary attributes specified in a \f3<table>\fR tag)\&. +.TP 0.2i +\(bu +\f3html\fR : Detects high-level HTML issues, like putting block elements inside inline elements, or not closing elements that require an end tag\&. The rules are derived from theHTML 4\&.01 Specification\&. This type of check enables the \f3javadoc\fR command to detect HTML issues that many browsers might accept\&. +.TP 0.2i +\(bu +\f3missing\fR : Checks for missing Javadoc comments or tags (for example, a missing comment or class, or a missing \f3@return\fR tag or similar tag on a method)\&. +.TP 0.2i +\(bu +\f3reference\fR : Checks for issues relating to the references to Java API elements from Javadoc tags (for example, item not found in \f3@see\fR , or a bad name after \f3@param)\fR\&. +.TP 0.2i +\(bu +\f3syntax\fR : Checks for low level issues like unescaped angle brackets (\f3<\fR and \f3>\fR) and ampersands (\f3&\fR) and invalid Javadoc tags\&. +.RE + + +You can specify the \f3-Xdoclint\fR option multiple times to enable the option to check errors and warnings in multiple categories\&. Alternatively, you can specify multiple error and warning categories by using the preceding options\&. For example, use either of the following commands to check for the HTML, syntax, and accessibility issues in the file \fIfilename\fR\&. +.sp +.nf +\f3javadoc \-Xdoclint:html \-Xdoclint:syntax \-Xdoclint:accessibility \fIfilename\fR\fP +.fi +.nf +\f3javadoc \-Xdoclint:html,syntax,accessibility \fIfilename\fR\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fINote:\fR The \f3javadoc\fR command does not guarantee the completeness of these checks\&. In particular, it is not a full HTML compliance checker\&. The goal of the -\f3Xdoclint\fR option is to enable the \f3javadoc\fR command to report majority of common errors\&. + +The \f3javadoc\fR command does not attempt to fix invalid input, it just reports it\&. +.TP +-public +.br +Shows only public classes and members\&. +.TP +-protected +.br +Shows only protected and public classes and members\&. This is the default\&. +.TP +-package +.br +Shows only package, protected, and public classes and members\&. +.TP +-private +.br +Shows all classes and members\&. +.TP +-help +.br +Displays the online help, which lists all of the \f3javadoc\fR and \f3doclet\fR command-line options\&. +.TP +-doclet \fIclass\fR +.br +Specifies the class file that starts the doclet used in generating the documentation\&. Use the fully qualified name\&. This doclet defines the content and formats the output\&. If the \f3-doclet\fR option is not used, then the \f3javadoc\fR command uses the standard doclet for generating the default HTML format\&. This class must contain the \f3start(Root)\fR method\&. The path to this starting class is defined by the \f3-docletpath\fR option\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html +.TP +-docletpath \fIclasspathlist\fR +.br +Specifies the path to the doclet starting class file (specified with the \f3-doclet\fR option) and any JAR files it depends on\&. If the starting class file is in a JAR file, then this option specifies the path to that JAR file\&. You can specify an absolute path or a path relative to the current directory\&. If \f3classpathlist\fR contains multiple paths or JAR files, then they should be separated with a colon (:) on Oracle Solaris and a semi-colon (;) on Windows\&. This option is not necessary when the doclet starting class is already in the search path\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html +.TP +-1\&.1 +.br +Removed from Javadoc 1\&.4 with no replacement\&. This option created documentation with the appearance and functionality of documentation generated by Javadoc 1\&.1 (it never supported nested classes)\&. If you need this option, then use Javadoc 1\&.2 or 1\&.3 instead\&. +.TP +-source \fIrelease\fR +.br +Specifies the release of source code accepted\&. The following values for the \f3release\fR parameter are allowed\&. Use the value of \f3release\fR that corresponds to the value used when you compile code with the \f3javac\fR command\&. +.RS +.TP 0.2i +\(bu +\fIRelease Value: 1\&.5\fR\&. The \f3javadoc\fR command accepts code containing generics and other language features introduced in JDK 1\&.5\&. The compiler defaults to the 1\&.5 behavior when the \f3-source\fR option is not used\&. +.TP 0.2i +\(bu +\fIRelease Value: 1\&.4\fR\&. The \f3javadoc\fR command accepts code containing assertions, which were introduced in JDK 1\&.4\&. +.TP 0.2i +\(bu +\fIRelease Value: 1\&.3\fR\&. The \f3javadoc\fR command does not support assertions, generics, or other language features introduced after JDK 1\&.3\&. +.RE + +.TP +-sourcepath \fIsourcepathlist\fR +.br +Specifies the search paths for finding source files when passing package names or the \f3-subpackages\fR option into the \f3javadoc\fR command\&. Separate multiple paths with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. Note that this option is not only used to locate the source files being documented, but also to find source files that are not being documented, but whose comments are inherited by the source files being documented\&. + +You can use the \f3-sourcepath\fR option only when passing package names into the \f3javadoc\fR command\&. This will not locate source files passed into the \f3javadoc\fR command\&. To locate source files, \f3\fRchange to that directory or include the path ahead of each file, as shown at Document One or More Classes\&. If you omit \f3-sourcepath\fR, then the \f3javadoc\fR command uses the class path to find the source files (see \f3-classpath\fR)\&. The default \f3-sourcepath\fR is the value of class path\&. If \f3-classpath\fR is omitted and you pass package names into the \f3javadoc\fR command, then the \f3javadoc\fR command searches in the current directory and subdirectories for the source files\&. + +Set \f3sourcepathlist\fR to the root directory of the source tree for the package you are documenting\&. + +For example, suppose you want to document a package called \f3com\&.mypackage\fR, whose source files are located at:/home/user/src/com/mypackage/*\&.java\&. Specify the sourcepath to /home/user/src, the directory that contains com\emypackage, and then supply the package name, as follows: +.sp +.nf +\f3javadoc \-sourcepath /home/user/src/ com\&.mypackage\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Notice that if you concatenate the value of sourcepath and the package name together and change the dot to a slash (/), then you have the full path to the package: + +/home/user/src/com/mypackage + +To point to two source paths: +.sp +.nf +\f3javadoc \-sourcepath /home/user1/src:/home/user2/src com\&.mypackage\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-classpath \fIclasspathlist\fR +.br +Specifies the paths where the \f3javadoc\fR command searches for referenced classes These are the documented classes plus any classes referenced by those classes\&. Separate multiple paths with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. Follow the instructions in the class path documentation for specifying the \f3classpathlist\fR value\&. + +If you omit \f3-sourcepath\fR, then the \f3javadoc\fR command uses \f3-classpath\fR to find the source files and class files (for backward compatibility)\&. If you want to search for source and class files in separate paths, then use both \f3-sourcepath\fR and \f3-classpath\fR\&. + +For example, if you want to document \f3com\&.mypackage\fR, whose source files reside in the directory /home/user/src/com/mypackage, and if this package relies on a library in /home/user/lib, then you would use the following command: +.sp +.nf +\f3javadoc \-sourcepath /home/user/lib \-classpath /home/user/src com\&.mypackage\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Similar to other tools, if you do not specify \f3-classpath\fR, then the \f3javadoc\fR command uses the \f3CLASSPATH\fR environment variable when it is set\&. If both are not set, then the \f3javadoc\fR command searches for classes from the current directory\&. + +For an in-depth description of how the \f3javadoc\fR command uses \f3-classpath\fR to find user classes as it relates to extension classes and bootstrap classes, see How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html + +A class path element that contains a base name of * is considered equivalent to specifying a list of all the files in the directory with the extension \f3\&.jar\fR or \f3\&.JAR\fR\&. + +For example, if directory \f3mydir\fR contains \f3a\&.jar\fR and \f3b\&.JA\fRR, then the class path element \f3foo/*\fR is expanded to a \f3A\&.jar:b\&.JAR\fR, except that the order of JAR files is unspecified\&. All JAR files in the specified directory including hidden files are included in the list\&. A class path entry that consists of * expands to a list of all the jar files in the current directory\&. The \f3CLASSPATH\fR environment variable is similarly expanded\&. Any class path wildcard expansion occurs before the Java Virtual Machine (JVM) starts\&. No Java program ever sees unexpanded wild cards except by querying the environment, for example, by calling System\&.getenv(\f3"CLASSPATH"\fR)\&. +.TP +-subpackages \fIpackage1:package2:\&.\&.\&.\fR +.br +Generates documentation from source files in the specified packages and recursively in their subpackages\&. This option is useful when adding new subpackages to the source code because they are automatically included\&. Each package argument is any top-level subpackage (such as \f3java\fR) or fully qualified package (such as \f3javax\&.swing\fR) that does not need to contain source files\&. Arguments are separated by colons on all operating systems\&. Wild cards are not allowed\&. Use \f3-sourcepath\fR to specify where to find the packages\&. This option does not process source files that are in the source tree but do not belong to the packages\&. See Process Source Files\&. + +For example, the following command generates documentation for packages named \f3java\fR and \f3javax\&.swing\fR and all of their subpackages\&. +.sp +.nf +\f3javadoc \-d docs \-sourcepath /home/user/src \-subpackages java:javax\&.swing \fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-exclude \fIpackagename1:packagename2:\&.\&.\&.\fR +.br +Unconditionally excludes the specified packages and their subpackages from the list formed by \f3-subpackages\fR\&. It excludes those packages even when they would otherwise be included by some earlier or later \f3-subpackages\fR option\&. + +The following example would include \f3java\&.io\fR, \f3java\&.util\fR, and \f3java\&.math\fR (among others), but would exclude packages rooted at \f3java\&.net\fR and \f3java\&.lang\fR\&. Notice that this example excludes \f3java\&.lang\&.ref\fR, which is a subpackage of \f3java\&.lang\fR\&. +.sp +.nf +\f3javadoc \-sourcepath /home/user/src \-subpackages java \-exclude \fP +.fi +.nf +\f3 java\&.net:java\&.lang\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-bootclasspath \fIclasspathlist\fR +.br +Specifies the paths where the boot classes reside\&. These are typically the Java platform classes\&. The \f3bootclasspath\fR is part of the search path the \f3javadoc\fR command uses to look up source and class files\&. For more information, see How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html + +Separate directories in the \f3classpathlist\fR parameters with semicolons (;) for Windows and colons (:) for Oracle Solaris\&. +.TP +-extdirs \fIdirist\fR +.br +Specifies the directories where extension classes reside\&. These are any classes that use the Java Extension mechanism\&. The \f3extdirs\fR option is part of the search path the \f3javadoc\fR command uses to look up source and class files\&. See the \f3-classpath\fR option for more information\&. Separate directories in \f3dirlist\fR with semicolons (;) for Windows and colons (:) for Oracle Solaris\&. +.TP +-verbose +.br +Provides more detailed messages while the \f3javadoc\fR command runs\&. Without the \f3verbose\fR option, messages appear for loading the source files, generating the documentation (one message per source file), and sorting\&. The verbose option causes the printing of additional messages that specify the number of milliseconds to parse each Java source file\&. +.TP +-quiet +.br +Shuts off messages so that only the warnings and errors appear to make them easier to view\&. It also suppresses the \f3version\fR string\&. +.TP +-breakiterator +.br +Uses the internationalized sentence boundary of \f3java\&.text\&.BreakIterator\fR to determine the end of the first sentence in the main description of a package, class, or member for English\&. All other locales already use the \f3BreakIterator\fR class, rather than an English language, locale-specific algorithm\&. The first sentence is copied to the package, class, or member summary and to the alphabetic index\&. From JDK 1\&.2 and later, the \f3BreakIterator\fR class is used to determine the end of a sentence for all languages except for English\&. Therefore, the \f3-breakiterator\fR option has no effect except for English from 1\&.2 and later\&. English has its own default algorithm: +.RS +.TP 0.2i +\(bu +English default sentence-break algorithm\&. Stops at a period followed by a space or an HTML block tag, such as \f3<P>\fR\&. +.TP 0.2i +\(bu +Breakiterator sentence-break algorithm\&. Stops at a period, question mark, or exclamation point followed by a space when the next word starts with a capital letter\&. This is meant to handle most abbreviations (such as "The serial no\&. is valid", but will not handle "Mr\&. Smith")\&. The \f3-breakiterator\fR option does not stop at HTML tags or sentences that begin with numbers or symbols\&. The algorithm stops at the last period in \&.\&./filename, even when embedded in an HTML tag\&. +.RE + + +In Java SE 1\&.5 the \f3-breakiterator\fR option warning messages are removed, and the default sentence-break algorithm is unchanged\&. If you have not modified your source code to eliminate the \f3-breakiterator\fR option warnings in Java SE 1\&.4\&.x, then you do not have to do anything\&. The warnings go away starting with Java SE 1\&.5\&.0\&. +.TP +-locale \fIlanguage_country_variant\fR +.br +Specifies the locale that the \f3javadoc\fR command uses when it generates documentation\&. The argument is the name of the locale, as described in \f3j\fR\f3ava\&.util\&.Locale\fR documentation, such as \f3en_US\fR (English, United States) or \f3en_US_WIN\fR (Windows variant)\&. + +\fINote:\fR The \f3-locale\fR option must be placed ahead (to the left) of any options provided by the standard doclet or any other doclet\&. Otherwise, the navigation bars appear in English\&. This is the only command-line option that depends on order\&. See Standard Doclet Options\&. + +Specifying a locale causes the \f3javadoc\fR command to choose the resource files of that locale for messages such as strings in the navigation bar, headings for lists and tables, help file contents, comments in the stylesheet\&.css file, and so on\&. It also specifies the sorting order for lists sorted alphabetically, and the sentence separator to determine the end of the first sentence\&. The \f3-locale\fR option does not determine the locale of the documentation comment text specified in the source files of the documented classes\&. +.TP +-encoding +.br +Specifies the encoding name of the source files, such as \f3EUCJIS/SJIS\fR\&. If this option is not specified, then the platform default converter is used\&. See also the\f3-docencoding name\fR and \f3-charset name\fR options\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR directly to the Java Runtime Environment (JRE) that runs the \f3javadoc\fR command\&. For example, if you must ensure that the system sets aside 32 MB of memory in which to process the generated documentation, then you would call the \f3-Xmx\fR option as follows: \f3javadoc -J-Xmx32m -J-Xms32m com\&.mypackage\fR\&. Be aware that \f3-Xms\fR is optional because it only sets the size of initial memory, which is useful when you know the minimum amount of memory required\&. + +There is no space between the \f3J\fR and the \f3flag\fR\&. + +Use the \f3-version\fR option to find out what version of the \f3javadoc\fR command you are using\&. The version number of the standard doclet appears in its output stream\&. See Running the Javadoc Command\&. +.sp +.nf +\f3javadoc \-J\-version\fP +.fi +.nf +\f3java version "1\&.7\&.0_09"\fP +.fi +.nf +\f3Java(TM) SE Runtime Environment (build 1\&.7\&.0_09\-b05)\fP +.fi +.nf +\f3Java HotSpot(TM) 64\-Bit Server VM (build 23\&.5\-b02, mixed mode)\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-javafx +.br +Generates HTML documentation using the JavaFX extensions to the standard doclet\&. The generated documentation includes a Property Summary section in addition to the other summary sections generated by the standard Java doclet\&. The listed properties are linked to the sections for the getter and setter methods of each property\&. + +If there are no documentation comments written explicitly for getter and setter methods, the documentation comments from the property method are automatically copied to the generated documentation for these methods\&. This option also adds a new \f3@defaultValue\fR tag that allows documenting the default value for a property\&. + +Example: +.sp +.nf +\f3javadoc \-javafx MyClass\&.java \-d testdir\fP +.fi +.sp + +.SS STANDARD\ DOCLET\ OPTIONS +.TP +-d \fIdirectory\fR +.br +Specifies the destination directory where the \f3javadoc\fR command saves the generated HTML files\&. If you omit the \f3-d\fR option, then the files are saved to the current directory\&. The \f3directory\fR value can be absolute or relative to the current working directory\&. As of Java SE 1\&.4, the destination directory is automatically created when the \f3javadoc\fR command runs\&. + +For example, the following command generates the documentation for the package \f3com\&.mypackage\fR and saves the results in the /user/doc/ directory: \f3javadoc -d\fR\f3/user/doc/\fR\f3com\&.mypackage\fR\&. +.TP +-use +.br +Includes one Use page for each documented class and package\&. The page describes what packages, classes, methods, constructors and fields use any API of the specified class or package\&. Given class C, things that use class C would include subclasses of C, fields declared as C, methods that return C, and methods and constructors with parameters of type C\&. For example, you can look at the Use page for the \f3String\fR type\&. Because the \f3getName\fR method in the \f3java\&.awt\&.Font\fR class returns type \f3String\fR, the \f3getName\fR method uses \f3String\fR and so the \f3getName\fR method appears on the Use page for \f3String\fR\&.This documents only uses of the API, not the implementation\&. When a method uses \f3String\fR in its implementation, but does not take a string as an argument or return a string, that is not considered a use of \f3String\fR\&.To access the generated Use page, go to the class or package and click the \fIUse link\fR in the navigation bar\&. +.TP +-version +.br +Includes the @version text in the generated docs\&. This text is omitted by default\&. To find out what version of the \f3javadoc\fR command you are using, use the \f3-J-version\fR option\&. +.TP +-author +.br +Includes the \f3@author\fR text in the generated docs\&. +.TP +-splitindex +.br +Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical symbols\&. +.TP +-windowtitle \fItitle\fR +.br +Specifies the title to be placed in the HTML \f3<title>\fR tag\&. The text specified in the \f3title\fR tag appears in the window title and in any browser bookmarks (favorite places) that someone creates for this page\&. This title should not contain any HTML tags because the browser does not interpret them correctly\&. Use escape characters on any internal quotation marks within the \f3title\fR tag\&. If the \f3-windowtitle\fR option is omitted, then the \f3javadoc\fR command uses the value of the \f3-doctitle\fR option for the \f3-windowtitle\fR option\&. For example, \f3javadoc -windowtitle "Java SE Platform" com\&.mypackage\fR\&. +.TP +-doctitle \fItitle\fR +.br +Specifies the title to place near the top of the overview summary file\&. The text specified in the \f3title\fR tag is placed as a centered, level-one heading directly beneath the top navigation bar\&. The \f3title\fR tag can contain HTML tags and white space, but when it does, you must enclose the title in quotation marks\&. Internal quotation marks within the \f3title\fR tag must be escaped\&. For example, \f3javadoc -header "<b>Java Platform </b><br>v1\&.4" com\&.mypackage\&.\fR +.TP +-title \fItitle\fR +.br +No longer exists\&. It existed only in Beta releases of Javadoc 1\&.2\&. It was renamed to \f3-doctitle\fR\&. This option was renamed to make it clear that it defines the document title, rather than the window title\&. +.TP +-header \fIheader\fR +.br +Specifies the header text to be placed at the top of each output file\&. The header is placed to the right of the upper navigation bar\&. The \f3header\fR can contain HTML tags and white space, but when it does, the \f3header\fR must be enclosed in quotation marks\&. Use escape characters for internal quotation marks within a header\&. For example, \f3javadoc -header "<b>Java Platform </b><br>v1\&.4" com\&.mypackage\&.\fR +.TP +-footer \fIfooter\fR +.br +Specifies the footer text to be placed at the bottom of each output file\&. The \fIfooter\fR value is placed to the right of the lower navigation bar\&. The \f3footer\fR value can contain HTML tags and white space, but when it does, the \f3footer\fR value must be enclosed in quotation marks\&. Use escape characters for any internal quotation marks within a footer\&. +.TP +-top +.br +Specifies the text to be placed at the top of each output file\&. +.TP +-bottom \fItext\fR +.br +Specifies the text to be placed at the bottom of each output file\&. The text is placed at the bottom of the page, underneath the lower navigation bar\&. The text can contain HTML tags and white space, but when it does, the text must be enclosed in quotation marks\&. Use escape characters for any internal quotation marks within text\&. +.TP +-link \fIextdocURL\fR +.br +Creates links to existing Javadoc-generated documentation of externally referenced classes\&. The \fIextdocURL\fR argument is the absolute or relative URL of the directory that contains the external Javadoc-generated documentation you want to link to\&. You can specify multiple \f3-link\fR options in a specified \f3javadoc\fR command run to link to multiple documents\&. + +The package-list file must be found in this directory (otherwise, use the \f3-linkoffline\fR option)\&. The \f3javadoc\fR command reads the package names from the package-list file and links to those packages at that URL\&. When the \f3javadoc\fR command runs, the \f3extdocURL\fR value is copied into the \f3<A HREF>\fR links that are created\&. Therefore, \f3extdocURL\fR must be the URL to the directory, and not to a file\&. You can use an absolute link for \fIextdocURL\fR to enable your documents to link to a document on any web site, or you can use a relative link to link only to a relative location\&. If you use a relative link, then the value you pass in should be the relative path from the destination directory (specified with the \f3-d\fR option) to the directory containing the packages being linked to\&.When you specify an absolute link, you usually use an HTTP link\&. However, if you want to link to a file system that has no web server, then you can use a file link\&. Use a file link only when everyone who wants to access the generated documentation shares the same file system\&.In all cases, and on all operating systems, use a slash as the separator, whether the URL is absolute or relative, and \f3h\fR\f3ttp:\fR or \f3f\fR\f3ile:\fR as specified in the URL Memo: Uniform Resource Locators at http://www\&.ietf\&.org/rfc/rfc1738\&.txt +.sp +.nf +\f3\-link http://<host>/<directory>/<directory>/\&.\&.\&./<name>\fP +.fi +.nf +\f3\-link file://<host>/<directory>/<directory>/\&.\&.\&./<name>\fP +.fi +.nf +\f3\-link <directory>/<directory>/\&.\&.\&./<name>\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Differences between the -linkoffline and -link options + +Use the \f3-link\fR option in the following cases: +.TP 0.2i +\(bu +When you use a relative path to the external API document\&. +.TP 0.2i +\(bu +When you use an absolute URL to the external API document if your shell lets you open a connection to that URL for reading\&. +.PP +Use the \f3-linkoffline\fR option when you use an absolute URL to the external API document, if your shell does not allow a program to open a connection to that URL for reading\&. This can occur when you are behind a firewall and the document you want to link to is on the other side\&. +.PP +\f3Example 1 Absolute Link to External Documents\fR +.PP +Use the following command if you want to link to the \f3java\&.lang\fR, \f3java\&.io\fR and other Java platform packages, shown at http://docs\&.oracle\&.com/javase/8/docs/api/index\&.html +.sp +.nf +\f3javadoc \-link http://docs\&.oracle\&.com/javase/8/docs/api/ com\&.mypackage\fP +.fi +.nf +\f3\fP +.fi +.sp +The command generates documentation for the package \f3com\&.mypackage\fR with links to the Java SE packages\&. The generated documentation contains links to the \f3Object\fR class, for example, in the class \f3trees\fR\&. Other options, such as the \f3-sourcepath\fR and \f3-d\fR options, are not shown\&. +.PP +\f3Example 2 Relative Link to External Documents\fR +.PP +In this example, there are two packages with documents that are generated in different runs of the \f3javadoc\fR command, and those documents are separated by a relative path\&. The packages are \f3com\&.apipackage\fR, an API, and c\f3om\&.spipackage\fR, an Service Provide Interface (SPI)\&. You want the documentation to reside in docs/api/com/apipackage and docs/spi/com/spipackage\&. Assuming that the API package documentation is already generated, and that docs is the current directory, you document the SPI package with links to the API documentation by running: \f3javadoc -d \&./spi -link \&.\&./api com\&.spipackage\fR\&. +.PP +Notice the \f3-link\fR option is relative to the destination directory (docs/spi)\&. +.PP +Notes + +The \f3-link\fR option lets you link to classes referenced to by your code, but not documented in the current \f3javadoc\fR command run\&. For these links to go to valid pages, you must know where those HTML pages are located and specify that location with \f3extdocURL\fR\&. This allows third-party documentation to link to java\&.* documentation at http://docs\&.oracle\&.com\&.Omit the \f3-link\fR option when you want the \f3javadoc\fR command to create links only to APIs within the documentation it is generating in the current run\&. Without the \f3-link\fR option, the \f3javadoc\fR command does not create links to documentation for external references because it does not know whether or where that documentation exists\&.The \f3-link\fR option can create links in several places in the generated documentation\&. See Process Source Files\&. Another use is for cross-links between sets of packages: Execute the \f3javadoc\fR command on one set of packages, then run the \f3javadoc\fR command again on another set of packages, creating links both ways between both sets\&. +.PP +How to Reference a Class + +For a link to an externally referenced class to appear (and not just its text label), the class must be referenced in the following way\&. It is not sufficient for it to be referenced in the body of a method\&. It must be referenced in either an \f3import\fR statement or in a declaration\&. Here are examples of how the class \f3java\&.io\&.File\fR can be referenced: +.PP +\fI\fRIn any kind of import statement\&. By wildcard import, import explicitly by name, or automatically import for \f3java\&.lang\&.*\fR\&. +.PP +In Java SE 1\&.3\&.\fIn\fR and 1\&.2\&.\fIn\fR, only an explicit import by name works\&. A wildcard \f3import\fR statement does not work, nor does the automatic \f3import java\&.lang\&.*\fR\&. +.PP +\fI\fRIn a declaration: \f3void mymethod(File f) {}\fR +.PP +The reference can be in the return type or parameter type of a method, constructor, field, class, or interface, or in an implements, extends, or throws statement\&. +.PP +An important corollary is that when you use the \f3-link\fR option, there can be many links that unintentionally do not appear due to this constraint\&. The text would appear without being a link\&. You can detect these by the warnings they emit\&. The simplest way to properly reference a class and add the link would be to import that class\&. +.PP +Package List + +The \f3-link\fR option requires that a file named package-list, which is generated by the \f3javadoc\fR command, exists at the URL you specify with the \f3-link\fR option\&. The package-list file is a simple text file that lists the names of packages documented at that location\&. In the earlier example, the \f3javadoc\fR command searches for a file named package-list at the specified URL, reads in the package names, and links to those packages at that URL\&. +.PP +For example, the package list for the Java SE API is located at http://docs\&.oracle\&.com/javase/8/docs/api/package-list +.PP +The package list starts as follows: +.sp +.nf +\f3java\&.applet\fP +.fi +.nf +\f3java\&.awt\fP +.fi +.nf +\f3java\&.awt\&.color\fP +.fi +.nf +\f3java\&.awt\&.datatransfer\fP +.fi +.nf +\f3java\&.awt\&.dnd\fP +.fi +.nf +\f3java\&.awt\&.event\fP +.fi +.nf +\f3java\&.awt\&.font\fP +.fi +.nf +\f3and so on \&.\&.\&.\&.\fP +.fi +.nf +\f3\fP +.fi +.sp +When \f3javadoc\fR is run without the \f3-link\fR option and encounters a name that belongs to an externally referenced class, it prints the name with no link\&. However, when the \f3-link\fR option is used, the \f3javadoc\fR command searches the package-list file at the specified \fIextdocURL\fR location for that package name\&. When it finds the package name, it prefixes the name with \fIextdocURL\fR\&. +.PP +For there to be no broken links, all of the documentation for the external references must exist at the specified URLs\&. The \f3javadoc\fR command does not check that these pages exist, but only that the package-list exists\&. +.PP +Multiple Links + +You can supply multiple \f3-link\fR options to link to any number of externally generated documents\&. Javadoc 1\&.2 has a known bug that prevents you from supplying more than one \f3-link\fR options\&. This was fixed in Javadoc 1\&.2\&.2\&. Specify a different link option for each external document to link to \f3javadoc -link extdocURL1 -link extdocURL2 \&.\&.\&. -link extdocURLn com\&.mypackage\fR where \fIextdocURL1\fR, \fIextdocURL2\fR, \&.\f3\&.\&. extdocURLn\fR point respectively to the roots of external documents, each of which contains a file named package-list\&. +.PP +Cross Links + +Note that bootstrapping might be required when cross-linking two or more documents that were previously generated\&. If package-list does not exist for either document when you run the \f3javadoc\fR command on the first document, then the package-list does not yet exist for the second document\&. Therefore, to create the external links, you must regenerate the first document after you generate the second document\&. +.PP +In this case, the purpose of first generating a document is to create its package-list (or you can create it by hand if you are certain of the package names)\&. Then, generate the second document with its external links\&. The \f3javadoc\fR command prints a warning when a needed external package-list file does not exist\&. +.TP +-linkoffline \fIextdocURL packagelistLoc\fR +.br +This option is a variation of the \f3-link\fR option\&. They both create links to Javadoc-generated documentation for externally referenced classes\&. Use the \f3-link\fRo\f3ffline\fR option when linking to a document on the web when the \f3javadoc\fR command cannot access the document through a web connection\&. Use the \f3-linkoffline\fR option when package-list file of the external document is not accessible or does not exist at the \f3extdocURL\fR location, but does exist at a different location that can be specified by \f3packageListLoc\fR (typically local)\&. If \f3extdocURL\fR is accessible only on the World Wide Web, then the \f3-linkoffline\fR option removes the constraint that the \f3javadoc\fR command must have a web connection to generate documentation\&. Another use is as a work-around to update documents: After you have run the \f3javadoc\fR command on a full set of packages, you can run the \f3javadoc\fR command again on a smaller set of changed packages, so that the updated files can be inserted back into the original set\&. Examples follow\&. The \f3-linkoffline\fR option takes two arguments\&. The first is for the string to be embedded in the \f3<a href>\fR links, and the second tells the \f3-linkoffline\fR option where to find package-list: +.RS +.TP 0.2i +\(bu +The \f3extdocURL\fR value is the absolute or relative URL of the directory that contains the external Javadoc-generated documentation you want to link to\&. When relative, the value should be the relative path from the destination directory (specified with the \f3-d\fR option) to the root of the packages being linked to\&. For more information, see \fIextdocURL\fR in the \f3-link\fR option\&. +.TP 0.2i +\(bu +The \f3packagelistLoc\fR value is the path or URL to the directory that contains the package-list file for the external documentation\&. This can be a URL (http: or file:) or file path, and can be absolute or relative\&. When relative, make it relative to the current directory from where the \f3javadoc\fR command was run\&. Do not include the package-list file name\&. + +You can specify multiple \f3-linkoffline\fR options in a specified \f3javadoc\fR command run\&. Before Javadoc 1\&.2\&.2, the \f3-linkfile\fR options could be specified once\&. +.RE + +.PP +Absolute Links to External Documents + +You might have a situation where you want to link to the \f3java\&.lang\fR, \f3java\&.io\fR and other Java SE packages at http://docs\&.oracle\&.com/javase/8/docs/api/index\&.html +.PP +However, your shell does not have web access\&. In this case, do the following: +.TP 0.4i +1\&. +Open the package-list file in a browser at http://docs\&.oracle\&.com/javase/8/docs/api/package-list +.TP 0.4i +2\&. +Save the file to a local directory, and point to this local copy with the second argument, \f3packagelistLoc\fR\&. In this example, the package list file was saved to the current directory (\&.)\&. +.PP +The following command generates documentation for the package c\f3om\&.mypackage\fR with links to the Java SE packages\&. The generated documentation will contain links to the \f3Object\fR class, for example, in the class \f3trees\fR\&. Other necessary options, such as \f3-sourcepath\fR, are not shown\&. +.sp +.nf +\f3javadoc \-linkoffline http://docs\&.oracle\&.com/javase/8/docs/api/ \&. com\&.mypackage \fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Relative Links to External Documents + +It is not very common to use \f3-linkoffline\fR with relative paths, for the simple reason that the \f3-link\fR option is usually enough\&. When you use the \f3-linkoffline\fR option, the package-list file is usually local, and when you use relative links, the file you are linking to is also local, so it is usually unnecessary to give a different path for the two arguments to the \f3-linkoffline\fR option When the two arguments are identical, you can use the \f3-link\fR option\&. +.PP +Create a package-list File Manually + +If a package-list file does not exist yet, but you know what package names your document will link to, then you can manually create your own copy of this file and specify its path with \f3packagelistLoc\fR\&. An example would be the previous case where the package list for \f3com\&.spipackage\fR did not exist when \f3com\&.apipackage\fR was first generated\&. This technique is useful when you need to generate documentation that links to new external documentation whose package names you know, but which is not yet published\&. This is also a way of creating package-list files for packages generated with Javadoc 1\&.0 or 1\&.1, where package-list files were not generated\&. Similarly, two companies can share their unpublished package-list files so they can release their cross-linked documentation simultaneously\&. +.PP +Link to Multiple Documents + +You can include the \f3-linkoffline\fR option once for each generated document you want to refer to: +.sp +.nf +\f3javadoc \-linkoffline extdocURL1 packagelistLoc1 \-linkoffline extdocURL2\fP +.fi +.nf +\f3packagelistLoc2 \&.\&.\&.\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Update Documents + +You can also use the \f3-linkoffline\fR option when your project has dozens or hundreds of packages\&. If you have already run the \f3javadoc\fR command on the entire source tree, then you can quickly make small changes to documentation comments and rerun the \f3javadoc\fR command on a portion of the source tree\&. Be aware that the second run works properly only when your changes are to documentation comments and not to declarations\&. If you were to add, remove, or change any declarations from the source code, then broken links could show up in the index, package tree, inherited member lists, Use page, and other places\&. +.PP +First, create a new destination directory, such as update, for this new small run\&. In this example, the original destination directory is named html\&. In the simplest example, change directory to the parent of html\&. Set the first argument of the \f3-linkoffline\fR option to the current directory (\&.) and set the second argument to the relative path to html, where it can find package-list and pass in only the package names of the packages you want to update: +.sp +.nf +\f3javadoc \-d update \-linkoffline \&. html com\&.mypackage\fP +.fi +.nf +\f3\fP +.fi +.sp +When the \f3javadoc\fR command completes, copy these generated class pages in update/com/package (not the overview or index) to the original files in html/com/package\&. +.TP +-linksource +.br +Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation\&. Links are created for classes, interfaces, constructors, methods, and fields whose declarations are in a source file\&. Otherwise, links are not created, such as for default constructors and generated classes\&. + +This option exposes all private implementation details in the included source files, including private classes, private fields, and the bodies of private methods, regardless of the \f3-public\fR, \f3-package\fR, \f3-protected\fR, and \f3-private\fR options\&. Unless you also use the \f3-private\fR option, not all private classes or interfaces are accessible through links\&. + +Each link appears on the name of the identifier in its declaration\&. For example, the link to the source code of the \f3Button\fR class would be on the word \f3Button\fR: +.sp +.nf +\f3public class Button extends Component implements Accessible\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The link to the source code of the \f3getLabel\fR method in the \f3Button\fR class is on the word \f3getLabel\fR: +.sp +.nf +\f3public String getLabel()\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-group groupheading \fIpackagepattern:packagepattern\fR +.br +Separates packages on the overview page into whatever groups you specify, one group per table\&. You specify each group with a different \f3-group\fR option\&. The groups appear on the page in the order specified on the command line\&. Packages are alphabetized within a group\&. For a specified \f3-group\fR option, the packages matching the list of \f3packagepattern\fR expressions appear in a table with the heading \fIgroupheading\fR\&. +.RS +.TP 0.2i +\(bu +The \f3groupheading\fR can be any text and can include white space\&. This text is placed in the table heading for the group\&. +.TP 0.2i +\(bu +The \f3packagepattern\fR value can be any package name at the start of any package name followed by an asterisk (*)\&. The asterisk is the only wildcard allowed and means match any characters\&. Multiple patterns can be included in a group by separating them with colons (:)\&. If you use an asterisk in a pattern or pattern list, then the pattern list must be inside quotation marks, such as \f3"java\&.lang*:java\&.util"\fR\&. +.RE + + +When you do not supply a \f3-group\fR option, all packages are placed in one group with the heading \fIPackages\fR and appropriate subheadings\&. If the subheadings do not include all documented packages (all groups), then the remaining packages appear in a separate group with the subheading Other Packages\&. + +For example, the following \f3javadoc\fR command separates the three documented packages into \fICore\fR, \fIExtension\fR, and \fIOther Packages\fR\&. The trailing dot (\&.) does not appear in \f3java\&.lang*\fR\&. Including the dot, such as \f3java\&.lang\&.*\fR omits the\f3java\&.lang\fR package\&. +.sp +.nf +\f3javadoc \-group "Core Packages" "java\&.lang*:java\&.util"\fP +.fi +.nf +\f3 \-group "Extension Packages" "javax\&.*"\fP +.fi +.nf +\f3 java\&.lang java\&.lang\&.reflect java\&.util javax\&.servlet java\&.new\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fICore Packages\fR + +\f3java\&.lang\fR + +\f3java\&.lang\&.reflect\fR + +\f3java\&.util\fR + +\fIExtension Packages\fR + +\f3javax\&.servlet\fR + +\fIOther Packages\fR + +\f3java\&.new\fR +.TP +-nodeprecated +.br +Prevents the generation of any deprecated API in the documentation\&. This does what the \f3-nodeprecatedlist\fR option does, and it does not generate any deprecated API throughout the rest of the documentation\&. This is useful when writing code when you do not want to be distracted by the deprecated code\&. +.TP +-nodeprecatedlist +.br +Prevents the generation of the file that contains the list of deprecated APIs (deprecated-list\&.html) and the link in the navigation bar to that page\&. The \f3javadoc\fR command continues to generate the deprecated API throughout the rest of the document\&. This is useful when your source code contains no deprecated APIs, and you want to make the navigation bar cleaner\&. +.TP +-nosince +.br +Omits from the generated documents the \f3Since\fR sections associated with the \f3@since\fR tags\&. +.TP +-notree +.br +Omits the class/interface hierarchy pages from the generated documents\&. These are the pages you reach using the Tree button in the navigation bar\&. The hierarchy is produced by default\&. +.TP +-noindex +.br +Omits the index from the generated documents\&. The index is produced by default\&. +.TP +-nohelp +.br +Omits the HELP link in the navigation bars at the top and bottom of each page of output\&. +.TP +-nonavbar +.br +Prevents the generation of the navigation bar, header, and footer, that are usually found at the top and bottom of the generated pages\&. The \f3-nonavbar\fR option has no affect on the \f3-bottom\fR option\&. The \f3-nonavbar\fR option is useful when you are interested only in the content and have no need for navigation, such as when you are converting the files to PostScript or PDF for printing only\&. +.TP +-helpfile \fIpath\efilename\fR +.br +Specifies the path of an alternate help file path\efilename that the HELP link in the top and bottom navigation bars link to\&. Without this option, the \f3javadoc\fR command creates a help file help-doc\&.html that is hard-coded in the \f3javadoc\fR command\&. This option lets you override the default\&. The file name can be any name and is not restricted to help-doc\&.html\&. The \f3javadoc\fR command adjusts the links in the navigation bar accordingly, for example: +.sp +.nf +\f3javadoc \-helpfile /home/user/myhelp\&.html java\&.awt\&.\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-stylesheet \fIpath/filename\fR +.br +Specifies the path of an alternate HTML stylesheet file\&. Without this option, the \f3javadoc\fR command automatically creates a stylesheet file stylesheet\&.css that is hard-coded in the \f3javadoc\fR command\&. This option lets you override the default\&. The file name can be any name and is not restricted to stylesheet\&.css, for example: +.sp +.nf +\f3javadoc \-stylesheet file /home/user/mystylesheet\&.css com\&.mypackage\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-serialwarn +.br +Generates compile-time warnings for missing \f3@serial\fR tags\&. By default, Javadoc 1\&.2\&.2 and later versions generate no serial warnings\&. This is a reversal from earlier releases\&. Use this option to display the serial warnings, which helps to properly document default serializable fields and \f3writeExternal\fR methods\&. +.TP +-charset \fIname\fR +.br +Specifies the HTML character set for this document\&. The name should be a preferred MIME name as specified in the IANA Registry, Character Sets at http://www\&.iana\&.org/assignments/character-sets + +For example, \f3javadoc -charset "iso-8859-1" mypackage\fR inserts the following line in the head of every generated page: +.sp +.nf +\f3<META http\-equiv="Content\-Type" content="text/html; charset=ISO\-8859\-1">\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This \f3META\fR tag is described in the HTML standard (4197265 and 4137321), HTML Document Representation, at http://www\&.w3\&.org/TR/REC-html40/charset\&.html#h-5\&.2\&.2 + +See also the \f3-encoding\fR and \f3-docencoding name\fR options\&. +.TP +-docencoding \fIname\fR +.br +Specifies the encoding of the generated HTML files\&. The name should be a preferred MIME name as specified in the IANA Registry, Character Sets at http://www\&.iana\&.org/assignments/character-sets + +If you omit the \f3-docencoding\fR option but use the \f3-encoding\fR option, then the encoding of the generated HTML files is determined by the \f3-encoding\fR option, for example: \f3javadoc -docencoding "iso-8859-1" mypackage\fR\&. See also the \f3-encoding\fR and \f3-docencoding name\fR options\&. +.TP +-keywords +.br +Adds HTML keyword <META> tags to the generated file for each class\&. These tags can help search engines that look for <META> tags find the pages\&. Most search engines that search the entire Internet do not look at <META> tags, because pages can misuse them\&. Search engines offered by companies that confine their searches to their own website can benefit by looking at <META> tags\&. The <META> tags include the fully qualified name of the class and the unqualified names of the fields and methods\&. Constructors are not included because they are identical to the class name\&. For example, the class \f3String\fR starts with these keywords: +.sp +.nf +\f3<META NAME="keywords" CONTENT="java\&.lang\&.String class">\fP +.fi +.nf +\f3<META NAME="keywords" CONTENT="CASE_INSENSITIVE_ORDER">\fP +.fi +.nf +\f3<META NAME="keywords" CONTENT="length()">\fP +.fi +.nf +\f3<META NAME="keywords" CONTENT="charAt()">\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-tag \fItagname\fR:Xaoptcmf:"\fItaghead\fR" +.br +Enables the \f3javadoc\fR command to interpret a simple, one-argument \f3@tagname\fR custom block tag in documentation comments\&. For the \f3javadoc\fR command to spell-check tag names, it is important to include a \f3-tag\fR option for every custom tag that is present in the source code, disabling (with \f3X\fR) those that are not being output in the current run\&.The colon (:) is always the separator\&. The \f3-tag\fR option outputs the tag heading \fItaghead\fR in bold, followed on the next line by the text from its single argument\&. Similar to any block tag, the argument text can contain inline tags, which are also interpreted\&. The output is similar to standard one-argument tags, such as the \f3@return\fR and \f3@author\fR tags\&. Omitting a value for \fItaghead\fR causes \f3tagname\fR to be the heading\&. + +\fIPlacement of tags\fR: The \f3Xaoptcmf\fR arguments determine where in the source code the tag is allowed to be placed, and whether the tag can be disabled (using \f3X\fR)\&. You can supply either \f3a\fR, to allow the tag in all places, or any combination of the other letters: + +\f3X\fR (disable tag) + +\f3a\fR (all) + +\f3o\fR (overview) + +\f3p\fR (packages) + +\f3t\fR (types, that is classes and interfaces) + +\f3c\fR (constructors) + +\f3m\fR (methods) + +\f3f\fR (fields) + +\fIExamples of single tags\fR: An example of a tag option for a tag that can be used anywhere in the source code is: \f3-tag todo:a:"To Do:"\fR\&. + +If you want the \f3@todo\fR tag to be used only with constructors, methods, and fields, then you use: \f3-tag todo:cmf:"To Do:"\fR\&. + +Notice the last colon (:) is not a parameter separator, but is part of the heading text\&. You would use either tag option for source code that contains the \f3@todo\fR tag, such as: \f3@todo The documentation for this method needs work\fR\&. + +\fIColons in tag names\fR: Use a backslash to escape a colon that you want to use in a tag name\&. Use the \f3-tag ejb\e\e:bean:a:"EJB Bean:"\fR option for the following documentation comment: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @ejb:bean\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fISpell-checking tag names\fR: Some developers put custom tags in the source code that they do not always want to output\&. In these cases, it is important to list all tags that are in the source code, enabling the ones you want to output and disabling the ones you do not want to output\&. The presence of \f3X\fR disables the tag, while its absence enables the tag\&. This gives the \f3javadoc\fR command enough information to know whether a tag it encounters is unknown, which is probably the results of a typographical error or a misspelling\&. The \f3javadoc\fR command prints a warning in these cases\&. You can add \f3X\fR to the placement values already present, so that when you want to enable the tag, you can simply delete the \f3X\fR\&. For example, if the \f3@todo\fR tag is a tag that you want to suppress on output, then you would use: \f3-tag todo:Xcmf:"To Do:"\fR\&. If you would rather keep it simple, then use this: \f3-tag todo:X\fR\&. The syntax \f3-tag todo:X\fR works even when the \f3@todo\fR tag is defined by a taglet\&. + +\fIOrder of tags\fR: The order of the \f3-ta\fR\f3g\fR and \f3-taglet\fR options determines the order the tags are output\&. You can mix the custom tags with the standard tags to intersperse them\&. The tag options for standard tags are placeholders only for determining the order\&. They take only the standard tag\&'s name\&. Subheadings for standard tags cannot be altered\&. This is illustrated in the following example\&.If the \f3-tag\fR option is missing, then the position of the \f3-tagle\fR\f3t\fR option determines its order\&. If they are both present, then whichever appears last on the command line determines its order\&. This happens because the tags and taglets are processed in the order that they appear on the command line\&. For example, if the \f3-taglet\fR and \f3-tag\fR options have the name \f3todo\fR value, then the one that appears last on the command line determines the order\&. + +\fIExample of a complete set of tags\fR: This example inserts To Do after Parameters and before Throws in the output\&. By using \f3X\fR, it also specifies that the \f3@example\fR tag might be encountered in the source code that should not be output during this run\&. If you use the \f3@argfile\fR tag, then you can put the tags on separate lines in an argument file similar to this (no line continuation characters needed): +.sp +.nf +\f3\-tag param\fP +.fi +.nf +\f3\-tag return\fP +.fi +.nf +\f3\-tag todo:a:"To Do:"\fP +.fi +.nf +\f3\-tag throws\fP +.fi +.nf +\f3\-tag see\fP +.fi +.nf +\f3\-tag example:X\fP +.fi +.nf +\f3\fP +.fi +.sp + + +When the \f3javadoc\fR command parses the documentation comments, any tag encountered that is neither a standard tag nor passed in with the \f3-tag\fR or \f3-taglet\fR options is considered unknown, and a warning is thrown\&. + +The standard tags are initially stored internally in a list in their default order\&. Whenever the \f3-tag\fR options are used, those tags get appended to this list\&. Standard tags are moved from their default position\&. Therefore, if a \f3-tag\fR option is omitted for a standard tag, then it remains in its default position\&. + +\fIAvoiding conflicts\fR: If you want to create your own namespace, then you can use a dot-separated naming convention similar to that used for packages: \f3com\&.mycompany\&.todo\fR\&. Oracle will continue to create standard tags whose names do not contain dots\&. Any tag you create will override the behavior of a tag by the same name defined by Oracle\&. If you create a \f3@todo\fR tag or taglet, then it always has the same behavior you define, even when Oracle later creates a standard tag of the same name\&. + +\fIAnnotations vs\&. Javadoc tags\fR: In general, if the markup you want to add is intended to affect or produce documentation, then it should be a Javadoc tag\&. Otherwise, it should be an annotation\&. See Custom Tags and Annotations in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#annotations + +You can also create more complex block tags or custom inline tags with the \f3-taglet\fR option\&. +.TP +-taglet \fIclass\fR +.br +Specifies the class file that starts the taglet used in generating the documentation for that tag\&. Use the fully qualified name for the \f3class\fR value\&. This taglet also defines the number of text arguments that the custom tag has\&. The taglet accepts those arguments, processes them, and generates the output\&. For extensive documentation with example taglets, see: Taglet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/taglet/overview\&.html + +Taglets are useful for block or inline tags\&. They can have any number of arguments and implement custom behavior, such as making text bold, formatting bullets, writing out the text to a file, or starting other processes\&. Taglets can only determine where a tag should appear and in what form\&. All other decisions are made by the doclet\&. A taglet cannot do things such as remove a class name from the list of included classes\&. However, it can execute side effects, such as printing the tag\&'s text to a file or triggering another process\&. Use the \f3-tagletpath\fR option to specify the path to the taglet\&. The following example inserts the To Do taglet after Parameters and ahead of Throws in the generated pages\&. Alternately, you can use the \f3-taglet\fR option in place of its \f3-tag\fR option, but that might be difficult to read\&. +.sp +.nf +\f3\-taglet com\&.sun\&.tools\&.doclets\&.ToDoTaglet\fP +.fi +.nf +\f3\-tagletpath /home/taglets \fP +.fi +.nf +\f3\-tag return\fP +.fi +.nf +\f3\-tag param\fP +.fi +.nf +\f3\-tag todo\fP +.fi +.nf +\f3\-tag throws\fP +.fi +.nf +\f3\-tag see\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-tagletpath \fItagletpathlist\fR +.br +Specifies the search paths for finding taglet class files\&. The \f3tagletpathlist\fR can contain multiple paths by separating them with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. +.TP +-docfilesubdirs +.br +Enables deep copying of doc-files directories\&. Subdirectories and all contents are recursively copied to the destination\&. For example, the directory doc-files/example/images and all of its contents would be copied\&. There is also an option to exclude subdirectories\&. +.TP +-excludedocfilessubdir \fIname1:name2\fR +.br +Excludes any doc-files subdirectories with the specified names\&. This prevents the copying of SCCS and other source-code-control subdirectories\&. +.TP +-noqualifier all | \fIpackagename1\fR:\fIpackagename2\&.\&.\&.\fR +.br +Omits qualifying package names from class names in output\&. The argument to the \f3-noqualifier\fR option is either \f3all\fR (all package qualifiers are omitted) or a colon-separate list of packages, with wild cards, to be removed as qualifiers\&. The package name is removed from places where class or interface names appear\&. See Process Source Files\&. + +The following example omits all package qualifiers: \f3-noqualifier all\fR\&. + +The following example omits \f3java\&.lang\fR and \f3java\&.io\fR package qualifiers: \f3-noqualifier java\&.lang:java\&.io\fR\&. + +The following example omits package qualifiers starting with \f3java\fR, and \f3com\&.sun\fR subpackages, but not \f3javax\fR: \f3-noqualifier java\&.*:com\&.sun\&.*\fR\&. + +Where a package qualifier would appear due to the previous behavior, the name can be suitably shortened\&. See How a Name Appears\&. This rule is in effect whether or not the \f3-noqualifier\fR option is used\&. +.TP +-notimestamp +.br +Suppresses the time stamp, which is hidden in an HTML comment in the generated HTML near the top of each page\&. The \f3-notimestamp\fR option is useful when you want to run the \f3javadoc\fR command on two source bases and get the differences between \f3diff\fR them, because it prevents time stamps from causing a \f3diff\fR (which would otherwise be a \f3diff\fR on every page)\&. The time stamp includes the \f3javadoc\fR command release number, and currently appears similar to this: \f3<!-- Generated by javadoc (build 1\&.5\&.0_01) on Thu Apr 02 14:04:52 IST 2009 -->\fR\&. +.TP +-nocomment +.br +Suppresses the entire comment body, including the main description and all tags, and generate only declarations\&. This option lets you reuse source files that were originally intended for a different purpose so that you can produce skeleton HTML documentation at the early stages of a new project\&. +.TP +-sourcetab \fItablength\fR +.br +Specifies the number of spaces each tab uses in the source\&. +.SH COMMAND-LINE\ ARGUMENT\ FILES +To shorten or simplify the \f3javadoc\fR command, you can specify one or more files that contain arguments to the \f3javadoc\fR command (except \f3-J\fR options)\&. This enables you to create \f3javadoc\fR commands of any length on any operating system\&. +.PP +An argument file can include \f3javac\fR options and source file names in any combination\&. The arguments within a file can be space-separated or newline-separated\&. If a file name contains embedded spaces, then put the whole file name in double quotation marks\&. +.PP +File Names within an argument file are relative to the current directory, not the location of the argument file\&. Wild cards (\f3*\fR) are not allowed in these lists (such as for specifying *\&.java)\&. Using the at sign (@) to recursively interpret files is not supported\&. The \f3-J\fR options are not supported because they are passed to the launcher, which does not support argument files\&. +.PP +When you run the \f3javadoc\fR command, pass in the path and name of each argument file with the @ leading character\&. When the \f3javadoc\fR command encounters an argument beginning with the at sign (@), it expands the contents of that file into the argument list\&. +.PP +\f3Example 1 Single Argument File\fR +.PP +You could use a single argument file named \f3argfile\fR to hold all \f3javadoc\fR command arguments: \f3javadoc @argfile\fR\&. The argument file \f3\fRcontains the contents of both files, as shown in the next example\&. +.PP +\f3Example 2 Two Argument Files\fR +.PP +You can create two argument files: One for the \f3javadoc\fR command options and the other for the package names or source file names\&. Notice the following lists have no line-continuation characters\&. +.PP +Create a file named options that contains: +.sp +.nf +\f3\-d docs\-filelist \fP +.fi +.nf +\f3\-use \fP +.fi +.nf +\f3\-splitindex\fP +.fi +.nf +\f3\-windowtitle \&'Java SE 7 API Specification\&'\fP +.fi +.nf +\f3\-doctitle \&'Java SE 7 API Specification\&'\fP +.fi +.nf +\f3\-header \&'<b>Java\(tm SE 7</b>\&'\fP +.fi +.nf +\f3\-bottom \&'Copyright © 1993\-2011 Oracle and/or its affiliates\&. All rights reserved\&.\&'\fP +.fi +.nf +\f3\-group "Core Packages" "java\&.*"\fP +.fi +.nf +\f3\-overview /java/pubs/ws/1\&.7\&.0/src/share/classes/overview\-core\&.html\fP +.fi +.nf +\f3\-sourcepath /java/pubs/ws/1\&.7\&.0/src/share/classes\fP +.fi +.nf +\f3\fP +.fi +.sp +Create a file named packages that contains: +.sp +.nf +\f3com\&.mypackage1\fP +.fi +.nf +\f3com\&.mypackage2\fP +.fi +.nf +\f3com\&.mypackage3\fP +.fi +.nf +\f3\fP +.fi +.sp +Run the \f3javadoc\fR command as follows: +.sp +.nf +\f3javadoc @options @packages\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 3 Argument Files with Paths\fR +.PP +The argument files can have paths, but any file names inside the files are relative to the current working directory (not \f3path1\fR or \f3path2\fR): +.sp +.nf +\f3javadoc @path1/options @path2/packages\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 4 Option Arguments\fR +.PP +The following example saves an argument to a \f3javadoc\fR command option in an argument file\&. The \f3-bottom\fR option is used because it can have a lengthy argument\&. You could create a file named bottom to contain the text argument: +.sp +.nf +\f3<font size="\-1">\fP +.fi +.nf +\f3 <a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP +.fi +.nf +\f3 Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&. <br/>\fP +.fi +.nf +\f3 Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP +.fi +.nf +\f3 Other names may be trademarks of their respective owners\&.</font>\fP +.fi +.nf +\f3\fP +.fi +.sp +Run the \f3javadoc\fR command as follows:\f3javadoc -bottom @bottom @packages\fR\&. +.PP +You can also include the \f3-bottom\fR option at the start of the argument file and run the \f3javadoc\fR command as follows: \f3javadoc @bottom @packages\fR\&. +.SH RUNNING\ THE\ JAVADOC\ COMMAND +The release number of the \f3javadoc\fR command can be determined with the \f3javadoc -J-version\fR option\&. The release number of the standard doclet appears in the output stream\&. It can be turned off with the \f3-quiet\fR option\&. +.PP +Use the public programmatic interface to call the \f3javadoc\fR command from within programs written in the Java language\&. This interface is in \f3com\&.sun\&.tools\&.javadoc\&.Main\fR (and the \f3javadoc\fR command is reentrant)\&. For more information, see The Standard Doclet at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/standard-doclet\&.html#runningprogrammatically +.PP +The following instructions call the standard HTML doclet\&. To call a custom doclet, use the \f3-doclet\fR and \f3-docletpath\fR options\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html +.SS SIMPLE\ EXAMPLES +You can run the \f3javadoc\fR command on entire packages or individual source files\&. Each package name has a corresponding directory name\&. +.PP +In the following examples, the source files are located at /home/src/java/awt/*\&.java\&. The destination directory is /home/html\&. +.PP +Document One or More Packages + +To document a package, the source files for that package must be located in a directory that has the same name as the package\&. +.PP +If a package name has several identifiers (separated by dots, such as \f3java\&.awt\&.color\fR), then each subsequent identifier must correspond to a deeper subdirectory (such as java/awt/color)\&. +.PP +You can split the source files for a single package among two such directory trees located at different places, as long as \f3-sourcepath\fR points to them both\&. For example, src1/java/awt/color and src2/java/awt/color\&. +.PP +You can run the \f3javadoc\fR command either by changing directories (with the \f3cd\fR command) or by using the \f3-sourcepath\fR option\&. The following examples illustrate both alternatives\&. +.PP +\f3Example 1 Recursive Run from One or More Packages\fR +.PP +This example uses \f3-sourcepath\fR so the \f3javadoc\fR command can be run from any directory and \f3-subpackages\fR (a new 1\&.4 option) for recursion\&. It traverses the subpackages of the java directory excluding packages rooted at \f3java\&.net\fR and \f3java\&.lang\fR\&. Notice this excludes \f3java\&.lang\&.ref\fR, a subpackage of \f3java\&.lang\fR\&. To also traverse down other package trees, append their names to the \f3-subpackages\fR argument, such as \f3java:javax:org\&.xml\&.sax\fR\&. +.sp +.nf +\f3javadoc \-d /home/html \-sourcepath /home/src \-subpackages java \-exclude\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 2 Change to Root and Run Explicit Packages\fR +.PP +Change to the parent directory of the fully qualified package\&. Then, run the \f3javadoc\fR command with the names of one or more packages that you want to document: +.sp +.nf +\f3cd /home/src/\fP +.fi +.nf +\f3javadoc \-d /home/html java\&.awt java\&.awt\&.event\fP +.fi +.nf +\f3\fP +.fi +.sp +To also traverse down other package trees, append their names to the \f3-subpackages\fR argument, such as j\f3ava:javax:org\&.xml\&.sax\fR\&. +.PP +\f3Example 3 Run from Any Directory on Explicit Packages in One Tree\fR +.PP +In this case, it does not matter what the current directory is\&. Run the \f3javadoc\fR command and use the \f3-sourcepath\fR option with the parent directory of the top-level package\&. Provide the names of one or more packages that you want to document: +.sp +.nf +\f3javadoc \-d /home/html \-sourcepath /home/src java\&.awt java\&.awt\&.event\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 4 Run from Any Directory on Explicit Packages in Multiple Trees\fR +.PP +Run the \f3javadoc\fR command and use the \f3-sourcepath\fR option with a colon-separated list of the paths to each tree\&'s root\&. Provide the names of one or more packages that you want to document\&. All source files for a specified package do not need to be located under a single root directory, but they must be found somewhere along the source path\&. +.sp +.nf +\f3javadoc \-d /home/html \-sourcepath /home/src1:/home/src2 java\&.awt java\&.awt\&.event\fP +.fi +.nf +\f3\fP +.fi +.sp +The result is that all cases generate HTML-formatted documentation for the \f3public\fR and \f3protected\fR classes and interfaces in packages j\f3ava\&.awt\fR and \f3java\&.awt\&.even\fRt and save the HTML files in the specified destination directory\&. Because two or more packages are being generated, the document has three HTML frames: one for the list of packages, another for the list of classes, and the third for the main class pages\&. +.PP +Document One or More Classes + +The second way to run the \f3javadoc\fR command is to pass one or more source files\&. You can run \f3javadoc\fR either of the following two ways: by changing directories (with the \f3cd\fR command) or by fully specifying the path to the source files\&. Relative paths are relative to the current directory\&. The \f3-sourcepath\fR option is ignored when passing source files\&. You can use command-line wild cards, such as an asterisk (*), to specify groups of classes\&. +.PP +\f3Example 1 Change to the Source Directory\fR +.PP +Change to the directory that holds the source files\&. Then run the \f3javadoc\fR command with the names of one or more source files you want to document\&. +.PP +This example generates HTML-formatted documentation for the classes \f3Button\fR, \f3Canvas,\fR and classes that begin with \f3Graphics\fR\&. Because source files rather than package names were passed in as arguments to the \f3javadoc\fR command, the document has two frames: one for the list of classes and the other for the main page\&. +.sp +.nf +\f3cd /home/src/java/awt\fP +.fi +.nf +\f3javadoc \-d /home/html Button\&.java Canvas\&.java Graphics*\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 2 Change to the Root Directory of the Package\fR +.PP +This is useful for documenting individual source files from different subpackages off of the same root\&. Change to the package root directory, and supply the source files with paths from the root\&. +.sp +.nf +\f3cd /home/src/\fP +.fi +.nf +\f3javadoc \-d /home/html java/awt/Button\&.java java/applet/Applet\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 3 Document Files from Any Directory\fR +.PP +In this case, it does not matter what the current directory is\&. Run the \f3javadoc\fR command with the absolute path (or path relative to the current directory) to the source files you want to document\&. +.sp +.nf +\f3javadoc \-d /home/html /home/src/java/awt/Button\&.java\fP +.fi +.nf +\f3/home/src/java/awt/Graphics*\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Document Packages and Classes + +You can document entire packages and individual classes at the same time\&. Here is an example that mixes two of the previous examples\&. You can use the \f3-sourcepath\fR option for the path to the packages but not for the path to the individual classes\&. +.sp +.nf +\f3javadoc \-d /home/html \-sourcepath /home/src java\&.awt\fP +.fi +.nf +\f3/home/src/java/applet/Applet\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS REAL-WORLD\ EXAMPLES +The following command-line and \f3makefile\fR versions of the \f3javadoc\fR command run on the Java platform APIs\&. It uses 180 MB of memory to generate the documentation for the 1500 (approximately) public and protected classes in the Java SE 1\&.2\&. Both examples use absolute paths in the option arguments, so that the same \f3javadoc\fR command can be run from any directory\&. +.PP +Command-Line Example + +The following command might be too long for some shells\&. You can use a command-line argument file (or write a shell script) to overcome this limitation\&. +.PP +In the example, \f3packages\fR is the name of a file that contains the packages to process, such as \f3java\&.applet\fR\f3java\&.lang\fR\&. None of the options should contain any newline characters between the single quotation marks\&. For example, if you copy and paste this example, then delete the newline characters from the \f3-bottom\fR option\&. +.sp +.nf +\f3javadoc \-sourcepath /java/jdk/src/share/classes \e\fP +.fi +.nf +\f3\-overview /java/jdk/src/share/classes/overview\&.html \e\fP +.fi +.nf +\f3\-d /java/jdk/build/api \e\fP +.fi +.nf +\f3\-use \e\fP +.fi +.nf +\f3\-splitIndex \e\fP +.fi +.nf +\f3\-windowtitle \&'Java Platform, Standard Edition 7 API Specification\&' \e\fP +.fi +.nf +\f3\-doctitle \&'Java Platform, Standard Edition 7 API Specification\&' \e\fP +.fi +.nf +\f3\-header \&'<b>Java\(tm SE 7</b>\&' \e\fP +.fi +.nf +\f3\-bottom \&'<font size="\-1">\fP +.fi +.nf +\f3<a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP +.fi +.nf +\f3Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&.<br/>\fP +.fi +.nf +\f3Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP +.fi +.nf +\f3Other names may be trademarks of their respective owners\&.</font>\&' \e\fP +.fi +.nf +\f3\-group "Core Packages" "java\&.*:com\&.sun\&.java\&.*:org\&.omg\&.*" \e\fP +.fi +.nf +\f3\-group "Extension Packages" "javax\&.*" \e\fP +.fi +.nf +\f3\-J\-Xmx180m \e \fP +.fi +.nf +\f3@packages\fP +.fi +.nf +\f3\fP +.fi +.sp + +.PP +Programmatic Interface + +The Javadoc Access API enables the user to invoke the Javadoc tool directly from a Java application without executing a new process\&. +.PP +For example, the following statements are equivalent to the command \f3javadoc -d /home/html -sourcepath /home/src -subpackages java -exclude java\&.net:java\&.lang com\&.example\fR: +.sp +.nf +\f3import javax\&.tools\&.DocumentationTool;\fP +.fi +.nf +\f3import javax\&.tools\&.ToolProvider;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class JavaAccessSample{\fP +.fi +.nf +\f3 public static void main(String[] args){\fP +.fi +.nf +\f3 DocumentationTool javadoc = ToolProvider\&.getSystemDocumentationTool();\fP +.fi +.nf +\f3 int rc = javadoc\&.run( null, null, null,\fP +.fi +.nf +\f3 "\-d", "/home/html",\fP +.fi +.nf +\f3 "\-sourcepath", "home/src",\fP +.fi +.nf +\f3 "\-subpackages", "java",\fP +.fi +.nf +\f3 "\-exclude", "java\&.net:java\&.lang",\fP +.fi +.nf +\f3 "com\&.example");\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.sp +The first three arguments of the \f3run\fR method specify input, standard output, and standard error streams\&. \f3Null\fR is the default value for \f3System\&.in\fR, \f3System\&.out\fR, and \f3System\&.err\fR, respectively\&. +.SS THE\ MAKEFILE\ EXAMPLE +This is an example of a GNU \f3makefile\fR\&. Single quotation marks surround \f3makefile\fR arguments\&. For an example of a Windows \f3makefile\fR, see the \f3makefiles\fR section of the Javadoc FAQ at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137483\&.html#makefiles +.sp +.nf +\f3javadoc \-sourcepath $(SRCDIR) \e /* Sets path for source files */\fP +.fi +.nf +\f3 \-overview $(SRCDIR)/overview\&.html \e /* Sets file for overview text */\fP +.fi +.nf +\f3 \-d /java/jdk/build/api \e /* Sets destination directory */\fP +.fi +.nf +\f3 \-use \e /* Adds "Use" files */\fP +.fi +.nf +\f3 \-splitIndex \e /* Splits index A\-Z */\fP +.fi +.nf +\f3 \-windowtitle $(WINDOWTITLE) \e /* Adds a window title */\fP +.fi +.nf +\f3 \-doctitle $(DOCTITLE) \e /* Adds a doc title */\fP +.fi +.nf +\f3 \-header $(HEADER) \e /* Adds running header text */\fP +.fi +.nf +\f3 \-bottom $(BOTTOM) \e /* Adds text at bottom */\fP +.fi +.nf +\f3 \-group $(GROUPCORE) \e /* 1st subhead on overview page */\fP +.fi +.nf +\f3 \-group $(GROUPEXT) \e /* 2nd subhead on overview page */\fP +.fi +.nf +\f3 \-J\-Xmx180m \e /* Sets memory to 180MB */\fP +.fi +.nf +\f3 java\&.lang java\&.lang\&.reflect \e /* Sets packages to document */\fP +.fi +.nf +\f3 java\&.util java\&.io java\&.net \e\fP +.fi +.nf +\f3 java\&.applet\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3WINDOWTITLE = \&'Java\(tm SE 7 API Specification\&'\fP +.fi +.nf +\f3DOCTITLE = \&'Java\(tm Platform Standard Edition 7 API Specification\&'\fP +.fi +.nf +\f3HEADER = \&'<b>Java\(tm SE 7</font>\&'\fP +.fi +.nf +\f3BOTTOM = \&'<font size="\-1">\fP +.fi +.nf +\f3 <a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP +.fi +.nf +\f3 Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&.<br/>\fP +.fi +.nf +\f3 Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP +.fi +.nf +\f3 Other names may be trademarks of their respective owners\&.</font>\&'\fP +.fi +.nf +\f3GROUPCORE = \&'"Core Packages" "java\&.*:com\&.sun\&.java\&.*:org\&.omg\&.*"\&'\fP +.fi +.nf +\f3GROUPEXT = \&'"Extension Packages" "javax\&.*"\&'\fP +.fi +.nf +\f3SRCDIR = \&'/java/jdk/1\&.7\&.0/src/share/classes\&'\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS NOTES +.TP 0.2i +\(bu +If you omit the \f3-windowtitle\fR option, then the \f3javadoc\fR command copies the document title to the window title\&. The \f3-windowtitle\fR option text is similar to the the \f3-doctitle\fR option, but without HTML tags to prevent those tags from appearing as raw text in the window title\&. +.TP 0.2i +\(bu +If you omit the \f3-footer\fR option, then the \f3javadoc\fR command copies the header text to the footer\&. +.TP 0.2i +\(bu +Other important options you might want to use, but were not needed in the previous example, are the \f3-classpath\fR and \f3-link\fR options\&. +.SH GENERAL\ TROUBLESHOOTING +.TP 0.2i +\(bu +The \f3javadoc\fR command reads only files that contain valid class names\&. If the \f3javadoc\fR command is not correctly reading the contents of a file, then verify that the class names are valid\&. See Process Source Files\&. +.TP 0.2i +\(bu +See the Javadoc FAQ for information about common bugs and for troubleshooting tips at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137483\&.html +.SH ERRORS\ AND\ WARNINGS +Error and warning messages contain the file name and line number to the declaration line rather than to the particular line in the documentation comment\&. +.PP +For example, this message \f3error: cannot read: Class1\&.java\fR means that the \f3javadoc\fR command is trying to load \f3Class1\&.jav\fR\f3a\fR in the current directory\&. The class name is shown with its path (absolute or relative)\&. +.SH ENVIRONMENT +.TP +CLASSPATH +\f3CLASSPATH\fR is the environment variable that provides the path that the \f3javadoc\fR command uses to find user class files\&. This environment variable is overridden by the \f3-classpath\fR option\&. Separate directories with a semicolon for Windows or a colon for Oracle Solaris\&. + +\fIWindows example\fR: \f3\&.;C:\eclasses;C:\ehome\ejava\eclasses\fR + +\fIOracle Solaris example\fR: \f3\&.:/home/classes:/usr/local/java/classes\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +javac(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jdb(1) +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +javap(1) +.SH RELATED\ DOCUMENTS +.TP 0.2i +\(bu +Javadoc Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/index\&.html +.TP 0.2i +\(bu +How Classes Are Found http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html +.TP 0.2i +\(bu +How to Write Doc Comments for the Javadoc Tool http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html +.TP 0.2i +\(bu +URL Memo, Uniform Resource Locators http://www\&.ietf\&.org/rfc/rfc1738\&.txt +.TP 0.2i +\(bu +HTML standard, HTML Document Representation (4197265 and 4137321) http://www\&.w3\&.org/TR/REC-html40/charset\&.html#h-5\&.2\&.2 +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/javah.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/javah.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,158 +1,158 @@ -'\" t -.\" Copyright (c) 1994, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Basic Tools -.\" Title: javah.1 -.\" -.if n .pl 99999 -.TH javah 1 "21 November 2013" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -javah \- Generates C header and source files from a Java class\&. -.SH SYNOPSIS -.sp -.nf - -\fBjavah\fR [ \fIoptions\fR ] f\fIully\-qualified\-class\-name \&.\&.\&.\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIfully-qualified-class-name\fR -The fully qualified location of the classes to be converted to C header and source files\&. -.SH DESCRIPTION -The \f3javah\fR command 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 \f3\&.h\fR file contains a \f3struct\fR definition with a layout that parallels the layout of the corresponding class\&. The fields in the \f3struct\fR correspond to instance variables in the class\&. -.PP -The name of the header file and the structure declared within it are derived from the name of the class\&. When the class passed to the \f3javah\fR command is inside a package, the package name is added to the beginning of both the header file name and the structure name\&. Underscores (_) are used as name delimiters\&. -.PP -By default the \f3javah\fR command creates a header file for each class listed on the command line and puts the files in the current directory\&. Use the \f3-stubs\fR option to create source files\&. Use the \f3-o\fR option to concatenate the results for all listed classes into a single file\&. -.PP -The Java Native Interface (JNI) does not require header information or stub files\&. The \f3javah\fR command can still be used to generate native method function prototypes needed for JNI-style native methods\&. The \f3javah\fR command produces JNI-style output by default and places the result in the \f3\&.h\fR file\&. -.SH OPTIONS -.TP --o \fIoutputfile\fR -.br -Concatenates the resulting header or source files for all the classes listed on the command line into an output file\&. Only one of \f3-o\fR or \f3-d\fR can be used\&. -.TP --d \fIdirectory\fR -.br -Sets the directory where the \f3javah\fR command saves the header files or the stub files\&. Only one of \f3-d\fR or \f3-o\fR can be used\&. -.TP --stubs -.br -Causes the \f3javah\fR command to generate C declarations from the Java object file\&. -.TP --verbose -.br -Indicates verbose output and causes the \f3javah\fR command to print a message to \f3stdout\fR about the status of the generated files\&. -.TP --help -.br -Prints a help message for \f3javah\fR usage\&. -.TP --version -.br -Prints \f3javah\fR command release information\&. -.TP --jni -.br -Causes the \f3javah\fR command to create an output file containing JNI-style native method function prototypes\&. This is the default output; use of \f3-jni\fR is optional\&. -.TP --classpath \fIpath\fR -.br -Specifies the path the \f3javah\fR command uses to look up classes\&. Overrides the default or the \f3CLASSPATH\fR environment variable when it is set\&. Directories are separated by colons on Oracle Solaris and semicolons on Windows\&. The general format for path is: - -\fIOracle Solaris\fR: - -\&.:\fIyour-path\fR - -Example: \f3\&.:/home/avh/classes:/usr/local/java/classes\fR - -\fIWindows\fR: - -\&.;\fIyour-path\fR - -Example: \f3\&.;C:\eusers\edac\eclasses;C:\etools\ejava\eclasses\fR - -As a special convenience, a class path element that contains a base name of * is considered equivalent to specifying a list of all the files in the directory with the extension \f3\&.jar\fR or \f3\&.JAR\fR\&. - -For example, if directory \f3mydir\fR contains \f3a\&.jar\fR and \f3b\&.JAR\fR, then the class path element \f3mydir/*\fR is expanded to a \f3A\fR\f3\&.jar:b\&.JAR\fR, except that the order of jar files is unspecified\&. All JAR files in the specified directory, including hidden ones, are included in the list\&. A class path entry that consists of * expands to a list of all the JAR files in the current directory\&. The \f3CLASSPATH\fR environment variable, where defined, is similarly expanded\&. Any class path wild card expansion occurs before the Java Virtual Machine (JVM) is started\&. A Java program will never see unexpanded wild cards except by querying the environment\&. For example, by calling \f3System\&.getenv("CLASSPATH")\fR\&. -.TP --bootclasspath \fIpath\fR -.br -Specifies the path from which to load bootstrap classes\&. By default, the bootstrap classes are the classes that implement the core Java platform located in \f3jre\elib\ert\&.jar\fR and several other JAR files\&. -.TP --old -.br -Specifies that old JDK 1\&.0-style header files should be generated\&. -.TP --force -.br -Specifies that output files should always be written\&. -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -javah(1) -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -jdb(1) -.TP 0.2i -\(bu -javap(1) -.TP 0.2i -\(bu -javadoc(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1994, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: javah.1 +.\" +.if n .pl 99999 +.TH javah 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +javah \- Generates C header and source files from a Java class\&. +.SH SYNOPSIS +.sp +.nf + +\fBjavah\fR [ \fIoptions\fR ] f\fIully\-qualified\-class\-name \&.\&.\&.\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIfully-qualified-class-name\fR +The fully qualified location of the classes to be converted to C header and source files\&. +.SH DESCRIPTION +The \f3javah\fR command 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 \f3\&.h\fR file contains a \f3struct\fR definition with a layout that parallels the layout of the corresponding class\&. The fields in the \f3struct\fR correspond to instance variables in the class\&. +.PP +The name of the header file and the structure declared within it are derived from the name of the class\&. When the class passed to the \f3javah\fR command is inside a package, the package name is added to the beginning of both the header file name and the structure name\&. Underscores (_) are used as name delimiters\&. +.PP +By default the \f3javah\fR command creates a header file for each class listed on the command line and puts the files in the current directory\&. Use the \f3-stubs\fR option to create source files\&. Use the \f3-o\fR option to concatenate the results for all listed classes into a single file\&. +.PP +The Java Native Interface (JNI) does not require header information or stub files\&. The \f3javah\fR command can still be used to generate native method function prototypes needed for JNI-style native methods\&. The \f3javah\fR command produces JNI-style output by default and places the result in the \f3\&.h\fR file\&. +.SH OPTIONS +.TP +-o \fIoutputfile\fR +.br +Concatenates the resulting header or source files for all the classes listed on the command line into an output file\&. Only one of \f3-o\fR or \f3-d\fR can be used\&. +.TP +-d \fIdirectory\fR +.br +Sets the directory where the \f3javah\fR command saves the header files or the stub files\&. Only one of \f3-d\fR or \f3-o\fR can be used\&. +.TP +-stubs +.br +Causes the \f3javah\fR command to generate C declarations from the Java object file\&. +.TP +-verbose +.br +Indicates verbose output and causes the \f3javah\fR command to print a message to \f3stdout\fR about the status of the generated files\&. +.TP +-help +.br +Prints a help message for \f3javah\fR usage\&. +.TP +-version +.br +Prints \f3javah\fR command release information\&. +.TP +-jni +.br +Causes the \f3javah\fR command to create an output file containing JNI-style native method function prototypes\&. This is the default output; use of \f3-jni\fR is optional\&. +.TP +-classpath \fIpath\fR +.br +Specifies the path the \f3javah\fR command uses to look up classes\&. Overrides the default or the \f3CLASSPATH\fR environment variable when it is set\&. Directories are separated by colons on Oracle Solaris and semicolons on Windows\&. The general format for path is: + +\fIOracle Solaris\fR: + +\&.:\fIyour-path\fR + +Example: \f3\&.:/home/avh/classes:/usr/local/java/classes\fR + +\fIWindows\fR: + +\&.;\fIyour-path\fR + +Example: \f3\&.;C:\eusers\edac\eclasses;C:\etools\ejava\eclasses\fR + +As a special convenience, a class path element that contains a base name of * is considered equivalent to specifying a list of all the files in the directory with the extension \f3\&.jar\fR or \f3\&.JAR\fR\&. + +For example, if directory \f3mydir\fR contains \f3a\&.jar\fR and \f3b\&.JAR\fR, then the class path element \f3mydir/*\fR is expanded to a \f3A\fR\f3\&.jar:b\&.JAR\fR, except that the order of jar files is unspecified\&. All JAR files in the specified directory, including hidden ones, are included in the list\&. A class path entry that consists of * expands to a list of all the JAR files in the current directory\&. The \f3CLASSPATH\fR environment variable, where defined, is similarly expanded\&. Any class path wild card expansion occurs before the Java Virtual Machine (JVM) is started\&. A Java program will never see unexpanded wild cards except by querying the environment\&. For example, by calling \f3System\&.getenv("CLASSPATH")\fR\&. +.TP +-bootclasspath \fIpath\fR +.br +Specifies the path from which to load bootstrap classes\&. By default, the bootstrap classes are the classes that implement the core Java platform located in \f3jre\elib\ert\&.jar\fR and several other JAR files\&. +.TP +-old +.br +Specifies that old JDK 1\&.0-style header files should be generated\&. +.TP +-force +.br +Specifies that output files should always be written\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jdb(1) +.TP 0.2i +\(bu +javap(1) +.TP 0.2i +\(bu +javadoc(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/javap.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/javap.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/jcmd.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/jcmd.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/jconsole.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/jconsole.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,112 +1,112 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java Troubleshooting, Profiling, Monitoring and Management Tools -.\" Title: jconsole.1 -.\" -.if n .pl 99999 -.TH jconsole 1 "21 November 2013" "JDK 8" "Java Troubleshooting, Profiling, Monitoring and Management Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jconsole \- Starts a graphical console that lets you monitor and manage Java applications\&. -.SH SYNOPSIS -.sp -.nf - -\fBjconsole\fR [ \fIoptions\fR ] [ connection \&.\&.\&. ] -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -connection = \fIpid\fR | \fIhost\fR:\fIport\fR | \fIjmxURL\fR -The \f3pid\fR value is the process ID of a local Java Virtual Machine (JVM)\&. The JVM must be running with the same user ID as the user ID running the \f3jconsole\fR command\&.The \f3host:port\fR values are the name of the host system on which the JVM is running, and the port number specified by the system property \f3com\&.sun\&.management\&.jmxremote\&.port\fR when the JVM was started\&.The \f3jmxUrl\fR value is the address of the JMX agent to be connected to as described in JMXServiceURL\&. - -For more information about the \f3connection\fR parameter, see Monitoring and Management Using JMX Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/agent\&.html - -See also the \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html -.SH DESCRIPTION -The \f3jconsole\fR command starts a graphical console tool that lets you monitor and manage Java applications and virtual machines on a local or remote machine\&. -.PP -On Windows, the \f3jconsole\fR command does not associate with a console window\&. It does, however, display a dialog box with error information when the \f3jconsole\fR command fails\&. -.SH OPTIONS -.TP --interval\fI=n\fR -.br -Sets the update interval to \fIn\fR seconds (default is 4 seconds)\&. -.TP --notile -.br -Does not tile windows initially (for two or more connections)\&. -.TP --pluginpath \fIplugins\fR -.br -Specifies a list of directories or JAR files to be searched for \f3JConsole\fR plug-ins\&. The \fIplugins\fR path should contain a provider-configuration file named \f3META-INF/services/com\&.sun\&.tools\&.jconsole\&.JConsolePlugin\fR that contains one line for each plug-in\&. The line specifies the fully qualified class name of the class implementing the \f3com\&.sun\&.tools\&.jconsole\&.JConsolePlugin\fR class\&. -.TP --version -.br -Displays release information and exits\&. -.TP --help -.br -Displays a help message\&. -.TP --J\fIflag\fR -.br -Passes \f3flag\fR to the JVM on which the \f3jconsole\fR command is run\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -Using JConsole at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/jconsole\&.html -.TP 0.2i -\(bu -Monitoring and Management Using JMX Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/agent\&.html -.TP 0.2i -\(bu -The \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Troubleshooting, Profiling, Monitoring and Management Tools +.\" Title: jconsole.1 +.\" +.if n .pl 99999 +.TH jconsole 1 "21 November 2013" "JDK 8" "Java Troubleshooting, Profiling, Monitoring and Management Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jconsole \- Starts a graphical console that lets you monitor and manage Java applications\&. +.SH SYNOPSIS +.sp +.nf + +\fBjconsole\fR [ \fIoptions\fR ] [ connection \&.\&.\&. ] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +connection = \fIpid\fR | \fIhost\fR:\fIport\fR | \fIjmxURL\fR +The \f3pid\fR value is the process ID of a local Java Virtual Machine (JVM)\&. The JVM must be running with the same user ID as the user ID running the \f3jconsole\fR command\&.The \f3host:port\fR values are the name of the host system on which the JVM is running, and the port number specified by the system property \f3com\&.sun\&.management\&.jmxremote\&.port\fR when the JVM was started\&.The \f3jmxUrl\fR value is the address of the JMX agent to be connected to as described in JMXServiceURL\&. + +For more information about the \f3connection\fR parameter, see Monitoring and Management Using JMX Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/agent\&.html + +See also the \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html +.SH DESCRIPTION +The \f3jconsole\fR command starts a graphical console tool that lets you monitor and manage Java applications and virtual machines on a local or remote machine\&. +.PP +On Windows, the \f3jconsole\fR command does not associate with a console window\&. It does, however, display a dialog box with error information when the \f3jconsole\fR command fails\&. +.SH OPTIONS +.TP +-interval\fI=n\fR +.br +Sets the update interval to \fIn\fR seconds (default is 4 seconds)\&. +.TP +-notile +.br +Does not tile windows initially (for two or more connections)\&. +.TP +-pluginpath \fIplugins\fR +.br +Specifies a list of directories or JAR files to be searched for \f3JConsole\fR plug-ins\&. The \fIplugins\fR path should contain a provider-configuration file named \f3META-INF/services/com\&.sun\&.tools\&.jconsole\&.JConsolePlugin\fR that contains one line for each plug-in\&. The line specifies the fully qualified class name of the class implementing the \f3com\&.sun\&.tools\&.jconsole\&.JConsolePlugin\fR class\&. +.TP +-version +.br +Displays release information and exits\&. +.TP +-help +.br +Displays a help message\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR to the JVM on which the \f3jconsole\fR command is run\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +Using JConsole at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/jconsole\&.html +.TP 0.2i +\(bu +Monitoring and Management Using JMX Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/agent\&.html +.TP 0.2i +\(bu +The \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/jdb.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/jdb.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,270 +1,270 @@ -'\" t -.\" Copyright (c) 1995, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Basic Tools -.\" Title: jdb.1 -.\" -.if n .pl 99999 -.TH jdb 1 "21 November 2013" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jdb \- Finds and fixes bugs in Java platform programs\&. -.SH SYNOPSIS -.sp -.nf - -\fBjdb\fR [\fIoptions\fR] [\fIclassname\fR] [\fIarguments\fR] -.fi -.sp -.TP -\fIoptions\fR -Command-line options\&. See Options\&. -.TP -\fIclass\fRname -Name of the main class to debug\&. -.TP -\fIarguments\fR -Arguments passed to the \f3main()\fR method of the class\&. -.SH DESCRIPTION -The Java Debugger (JDB) is a simple command-line debugger for Java classes\&. The \f3jdb\fR command and its options call the JDB\&. The \f3jdb\fR command demonstrates the Java Platform Debugger Architecture (JDBA) and provides inspection and debugging of a local or remote Java Virtual Machine (JVM)\&. See Java Platform Debugger Architecture (JDBA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/jpda/index\&.html -.SS START\ A\ JDB\ SESSION -There are many ways to start a JDB session\&. The most frequently used way is to have JDB launch a new JVM with the main class of the application to be debugged\&. Do this by substituting the \f3jdb\fR command for the \f3java\fR command in the command line\&. For example, if your application\&'s main class is \f3MyClass\fR, then use the following command to debug it under JDB: -.sp -.nf -\f3jdb MyClass\fP -.fi -.nf -\f3\fP -.fi -.sp -When started this way, the \f3jdb\fR command calls a second JVM with the specified parameters, loads the specified class, and stops the JVM before executing that class\&'s first instruction\&. -.PP -Another way to use the \f3jdb\fR command is by attaching it to a JVM that is already running\&. Syntax for starting a JVM to which the \f3jdb\fR command attaches when the JVM is running is as follows\&. This loads in-process debugging libraries and specifies the kind of connection to be made\&. -.sp -.nf -\f3java \-agentlib:jdwp=transport=dt_socket,server=y,suspend=n MyClass\fP -.fi -.nf -\f3\fP -.fi -.sp -You can then attach the \f3jdb\fR command to the JVM with the following command: -.sp -.nf -\f3jdb \-attach 8000\fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3MyClass\fR argument is not specified in the \f3jdb\fR command line in this case because the \f3jdb\fR command is connecting to an existing JVM instead of launching a new JVM\&. -.PP -There are many other ways to connect the debugger to a JVM, and all of them are supported by the \f3jdb\fR command\&. The Java Platform Debugger Architecture has additional documentation on these connection options\&. -.SS BASIC\ JDB\ COMMANDS -The following is a list of the basic \f3jdb\fR commands\&. The JDB supports other commands that you can list with the \f3-help\fR option\&. -.TP -help or ? -The \f3help\fR or \f3?\fR commands display the list of recognized commands with a brief description\&. -.TP -run -After you start JDB and set breakpoints, you can use the \f3run\fR command to execute the debugged application\&. The \f3run\fR command is available only when the \f3jdb\fR command starts the debugged application as opposed to attaching to an existing JVM\&. -.TP -cont -Continues execution of the debugged application after a breakpoint, exception, or step\&. -.TP -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 dump command to find out how to get more information about an object\&. - -\fINote:\fR To display local variables, the containing class must have been compiled with the \f3javac -g\fR option\&. - -The \f3print\fR command supports many simple Java expressions including those with method invocations, for example: -.sp -.nf -\f3print MyClass\&.myStaticField\fP -.fi -.nf -\f3print myObj\&.myInstanceField\fP -.fi -.nf -\f3print i + j + k (i, j, k are primities and either fields or local variables)\fP -.fi -.nf -\f3print myObj\&.myMethod() (if myMethod returns a non\-null)\fP -.fi -.nf -\f3print new java\&.lang\&.String("Hello")\&.length()\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -dump -For primitive values, the \f3dump\fR command is identical to the \f3print\fR command\&. For objects, the \f3dump\fR command prints the current value of each field defined in the object\&. Static and instance fields are included\&. The \f3dump\fR command supports the same set of expressions as the \f3print\fR command\&. -.TP -threads -List the threads that are currently running\&. For each thread, its name and current status are printed and an index that can be used in other commands\&. In this example, the thread index is 4, the thread is an instance of \f3java\&.lang\&.Thread\fR, the thread name is \f3main\fR, and it is currently running\&. -.sp -.nf -\f34\&. (java\&.lang\&.Thread)0x1 main running\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -thread -Select a thread to be the current thread\&. Many \f3jdb\fR commands are based on the setting of the current thread\&. The thread is specified with the thread index described in the threads command\&. -.TP -where -The \f3where\fR command with no arguments dumps the stack of the current thread\&. The \f3where\fR\f3all\fR command dumps the stack of all threads in the current thread group\&. The \f3where\fR\f3threadindex\fR command dumps the stack of the specified thread\&. - -If the current thread is suspended either through an event such as a breakpoint or through the \f3suspend\fR command, then local variables and fields can be displayed with the \f3print\fR and \f3dump\fR commands\&. The \f3up\fR and \f3down\fR commands select which stack frame is the current stack frame\&. -.SS BREAKPOINTS -Breakpoints can be set in JDB at line numbers or at the first instruction of a method, for example: -.TP 0.2i -\(bu -The command \f3stop at MyClass:22\fR sets a breakpoint at the first instruction for line 22 of the source file containing \f3MyClass\fR\&. -.TP 0.2i -\(bu -The command \f3stop in java\&.lang\&.String\&.length\fR sets a breakpoint at the beginning of the method \f3java\&.lang\&.String\&.length\fR\&. -.TP 0.2i -\(bu -The command \f3stop in MyClass\&.<clinit>\fR uses \f3<clinit>\fR to identify the static initialization code for \f3MyClass\fR\&. -.PP -When a method is overloaded, you must also specify its argument types so that the proper method can be selected for a breakpoint\&. For example, \f3MyClass\&.myMethod(int,java\&.lang\&.String)\fR or \f3MyClass\&.myMethod()\fR\&. -.PP -The \f3clear\fR command removes breakpoints using the following syntax: \f3clear MyClass:45\fR\&. Using the \f3clear\fR or \f3stop\fR command with no argument displays a list of all breakpoints currently set\&. The \f3cont\fR command continues execution\&. -.SS STEPPING -The \f3step\fR command advances execution to the next line whether it is in the current stack frame or a called method\&. The \f3next\fR command advances execution to the next line in the current stack frame\&. -.SS EXCEPTIONS -When an exception occurs for which there is not a \f3catch\fR statement anywhere in the throwing thread\&'s call stack, the JVM typically prints an exception trace and exits\&. When running under JDB, however, control returns to JDB at the offending throw\&. You can then use the \f3jdb\fR command to diagnose the cause of the exception\&. -.PP -Use the \f3catch\fR command to cause the debugged application to stop at other thrown exceptions, for example: \f3catch java\&.io\&.FileNotFoundException\fR or \f3catch\fR\f3mypackage\&.BigTroubleException\fR\&. Any exception that is an instance of the specified class or subclass stops the application at the point where it is thrown\&. -.PP -The \f3ignore\fR command negates the effect of an earlier \f3catch\fR command\&. The \f3ignore\fR command does not cause the debugged JVM to ignore specific exceptions, but only to ignore the debugger\&. -.SH OPTIONS -When you use the \f3jdb\fR command instead of the \f3java\fR command on the command line, the \f3jdb\fR command accepts many of the same options as the \f3java\fR command, including \f3-D\fR, \f3-classpath\fR, and \f3-X\fR options\&. The following list contains additional options that are accepted by the \f3jdb\fR command\&. -.PP -Other options are supported to provide alternate mechanisms for connecting the debugger to the JVM it is to debug\&. For additional documentation about these connection alternatives, see Java Platform Debugger Architecture (JPDA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/jpda/index\&.html -.TP --help -.br -Displays a help message\&. -.TP --sourcepath \fIdir1:dir2: \&. \&. \&.\fR -.br -Uses the specified path to search for source files in the specified path\&. If this option is not specified, then use the default path of dot (\&.)\&. -.TP --attach \fIaddress\fR -.br -Attaches the debugger to a running JVM with the default connection mechanism\&. -.TP --listen \fIaddress\fR -.br -Waits for a running JVM to connect to the specified address with a standard connector\&. -.TP --launch -.br -Starts the debugged application immediately upon startup of JDB\&. The \f3-launch\fR option removes the need for the \f3run\fR command\&. The debugged application is launched and then stopped just before the initial application class is loaded\&. At that point, you can set any necessary breakpoints and use the \f3cont\fR command to continue execution\&. -.TP --listconnectors -.br -List the connectors available in this JVM\&. -.TP --connect connector-name:\fIname1=value1\fR -.br -Connects to the target JVM with the named connector and listed argument values\&. -.TP --dbgtrace [\fIflags\fR] -.br -Prints information for debugging the \f3jdb\fR command\&. -.TP --tclient -.br -Runs the application in the Java HotSpot VM client\&. -.TP --tserver -.br -Runs the application in the Java HotSpot VM server\&. -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the JVM, where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH OPTIONS\ FORWARDED\ TO\ THE\ DEBUGGER\ PROCESS -.TP --v -verbose[:\fIclass\fR|gc|jni] -.br -Turns on verbose mode\&. -.TP --D\fIname\fR=\fIvalue\fR -.br -Sets a system property\&. -.TP --classpath \fIdir\fR -.br -Lists directories separated by colons in which to look for classes\&. -.TP --X\fIoption\fR -.br -Nonstandard target JVM option\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -javac(1) -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -javah(1) -.TP 0.2i -\(bu -javap(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1995, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: jdb.1 +.\" +.if n .pl 99999 +.TH jdb 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jdb \- Finds and fixes bugs in Java platform programs\&. +.SH SYNOPSIS +.sp +.nf + +\fBjdb\fR [\fIoptions\fR] [\fIclassname\fR] [\fIarguments\fR] +.fi +.sp +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.TP +\fIclass\fRname +Name of the main class to debug\&. +.TP +\fIarguments\fR +Arguments passed to the \f3main()\fR method of the class\&. +.SH DESCRIPTION +The Java Debugger (JDB) is a simple command-line debugger for Java classes\&. The \f3jdb\fR command and its options call the JDB\&. The \f3jdb\fR command demonstrates the Java Platform Debugger Architecture (JDBA) and provides inspection and debugging of a local or remote Java Virtual Machine (JVM)\&. See Java Platform Debugger Architecture (JDBA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/jpda/index\&.html +.SS START\ A\ JDB\ SESSION +There are many ways to start a JDB session\&. The most frequently used way is to have JDB launch a new JVM with the main class of the application to be debugged\&. Do this by substituting the \f3jdb\fR command for the \f3java\fR command in the command line\&. For example, if your application\&'s main class is \f3MyClass\fR, then use the following command to debug it under JDB: +.sp +.nf +\f3jdb MyClass\fP +.fi +.nf +\f3\fP +.fi +.sp +When started this way, the \f3jdb\fR command calls a second JVM with the specified parameters, loads the specified class, and stops the JVM before executing that class\&'s first instruction\&. +.PP +Another way to use the \f3jdb\fR command is by attaching it to a JVM that is already running\&. Syntax for starting a JVM to which the \f3jdb\fR command attaches when the JVM is running is as follows\&. This loads in-process debugging libraries and specifies the kind of connection to be made\&. +.sp +.nf +\f3java \-agentlib:jdwp=transport=dt_socket,server=y,suspend=n MyClass\fP +.fi +.nf +\f3\fP +.fi +.sp +You can then attach the \f3jdb\fR command to the JVM with the following command: +.sp +.nf +\f3jdb \-attach 8000\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3MyClass\fR argument is not specified in the \f3jdb\fR command line in this case because the \f3jdb\fR command is connecting to an existing JVM instead of launching a new JVM\&. +.PP +There are many other ways to connect the debugger to a JVM, and all of them are supported by the \f3jdb\fR command\&. The Java Platform Debugger Architecture has additional documentation on these connection options\&. +.SS BASIC\ JDB\ COMMANDS +The following is a list of the basic \f3jdb\fR commands\&. The JDB supports other commands that you can list with the \f3-help\fR option\&. +.TP +help or ? +The \f3help\fR or \f3?\fR commands display the list of recognized commands with a brief description\&. +.TP +run +After you start JDB and set breakpoints, you can use the \f3run\fR command to execute the debugged application\&. The \f3run\fR command is available only when the \f3jdb\fR command starts the debugged application as opposed to attaching to an existing JVM\&. +.TP +cont +Continues execution of the debugged application after a breakpoint, exception, or step\&. +.TP +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 dump command to find out how to get more information about an object\&. + +\fINote:\fR To display local variables, the containing class must have been compiled with the \f3javac -g\fR option\&. + +The \f3print\fR command supports many simple Java expressions including those with method invocations, for example: +.sp +.nf +\f3print MyClass\&.myStaticField\fP +.fi +.nf +\f3print myObj\&.myInstanceField\fP +.fi +.nf +\f3print i + j + k (i, j, k are primities and either fields or local variables)\fP +.fi +.nf +\f3print myObj\&.myMethod() (if myMethod returns a non\-null)\fP +.fi +.nf +\f3print new java\&.lang\&.String("Hello")\&.length()\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +dump +For primitive values, the \f3dump\fR command is identical to the \f3print\fR command\&. For objects, the \f3dump\fR command prints the current value of each field defined in the object\&. Static and instance fields are included\&. The \f3dump\fR command supports the same set of expressions as the \f3print\fR command\&. +.TP +threads +List the threads that are currently running\&. For each thread, its name and current status are printed and an index that can be used in other commands\&. In this example, the thread index is 4, the thread is an instance of \f3java\&.lang\&.Thread\fR, the thread name is \f3main\fR, and it is currently running\&. +.sp +.nf +\f34\&. (java\&.lang\&.Thread)0x1 main running\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +thread +Select a thread to be the current thread\&. Many \f3jdb\fR commands are based on the setting of the current thread\&. The thread is specified with the thread index described in the threads command\&. +.TP +where +The \f3where\fR command with no arguments dumps the stack of the current thread\&. The \f3where\fR\f3all\fR command dumps the stack of all threads in the current thread group\&. The \f3where\fR\f3threadindex\fR command dumps the stack of the specified thread\&. + +If the current thread is suspended either through an event such as a breakpoint or through the \f3suspend\fR command, then local variables and fields can be displayed with the \f3print\fR and \f3dump\fR commands\&. The \f3up\fR and \f3down\fR commands select which stack frame is the current stack frame\&. +.SS BREAKPOINTS +Breakpoints can be set in JDB at line numbers or at the first instruction of a method, for example: +.TP 0.2i +\(bu +The command \f3stop at MyClass:22\fR sets a breakpoint at the first instruction for line 22 of the source file containing \f3MyClass\fR\&. +.TP 0.2i +\(bu +The command \f3stop in java\&.lang\&.String\&.length\fR sets a breakpoint at the beginning of the method \f3java\&.lang\&.String\&.length\fR\&. +.TP 0.2i +\(bu +The command \f3stop in MyClass\&.<clinit>\fR uses \f3<clinit>\fR to identify the static initialization code for \f3MyClass\fR\&. +.PP +When a method is overloaded, you must also specify its argument types so that the proper method can be selected for a breakpoint\&. For example, \f3MyClass\&.myMethod(int,java\&.lang\&.String)\fR or \f3MyClass\&.myMethod()\fR\&. +.PP +The \f3clear\fR command removes breakpoints using the following syntax: \f3clear MyClass:45\fR\&. Using the \f3clear\fR or \f3stop\fR command with no argument displays a list of all breakpoints currently set\&. The \f3cont\fR command continues execution\&. +.SS STEPPING +The \f3step\fR command advances execution to the next line whether it is in the current stack frame or a called method\&. The \f3next\fR command advances execution to the next line in the current stack frame\&. +.SS EXCEPTIONS +When an exception occurs for which there is not a \f3catch\fR statement anywhere in the throwing thread\&'s call stack, the JVM typically prints an exception trace and exits\&. When running under JDB, however, control returns to JDB at the offending throw\&. You can then use the \f3jdb\fR command to diagnose the cause of the exception\&. +.PP +Use the \f3catch\fR command to cause the debugged application to stop at other thrown exceptions, for example: \f3catch java\&.io\&.FileNotFoundException\fR or \f3catch\fR\f3mypackage\&.BigTroubleException\fR\&. Any exception that is an instance of the specified class or subclass stops the application at the point where it is thrown\&. +.PP +The \f3ignore\fR command negates the effect of an earlier \f3catch\fR command\&. The \f3ignore\fR command does not cause the debugged JVM to ignore specific exceptions, but only to ignore the debugger\&. +.SH OPTIONS +When you use the \f3jdb\fR command instead of the \f3java\fR command on the command line, the \f3jdb\fR command accepts many of the same options as the \f3java\fR command, including \f3-D\fR, \f3-classpath\fR, and \f3-X\fR options\&. The following list contains additional options that are accepted by the \f3jdb\fR command\&. +.PP +Other options are supported to provide alternate mechanisms for connecting the debugger to the JVM it is to debug\&. For additional documentation about these connection alternatives, see Java Platform Debugger Architecture (JPDA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/jpda/index\&.html +.TP +-help +.br +Displays a help message\&. +.TP +-sourcepath \fIdir1:dir2: \&. \&. \&.\fR +.br +Uses the specified path to search for source files in the specified path\&. If this option is not specified, then use the default path of dot (\&.)\&. +.TP +-attach \fIaddress\fR +.br +Attaches the debugger to a running JVM with the default connection mechanism\&. +.TP +-listen \fIaddress\fR +.br +Waits for a running JVM to connect to the specified address with a standard connector\&. +.TP +-launch +.br +Starts the debugged application immediately upon startup of JDB\&. The \f3-launch\fR option removes the need for the \f3run\fR command\&. The debugged application is launched and then stopped just before the initial application class is loaded\&. At that point, you can set any necessary breakpoints and use the \f3cont\fR command to continue execution\&. +.TP +-listconnectors +.br +List the connectors available in this JVM\&. +.TP +-connect connector-name:\fIname1=value1\fR +.br +Connects to the target JVM with the named connector and listed argument values\&. +.TP +-dbgtrace [\fIflags\fR] +.br +Prints information for debugging the \f3jdb\fR command\&. +.TP +-tclient +.br +Runs the application in the Java HotSpot VM client\&. +.TP +-tserver +.br +Runs the application in the Java HotSpot VM server\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the JVM, where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH OPTIONS\ FORWARDED\ TO\ THE\ DEBUGGER\ PROCESS +.TP +-v -verbose[:\fIclass\fR|gc|jni] +.br +Turns on verbose mode\&. +.TP +-D\fIname\fR=\fIvalue\fR +.br +Sets a system property\&. +.TP +-classpath \fIdir\fR +.br +Lists directories separated by colons in which to look for classes\&. +.TP +-X\fIoption\fR +.br +Nonstandard target JVM option\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +javac(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +javap(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/jdeps.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/jdeps.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,537 +1,537 @@ -'\" t -.\" Copyright (c) 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Basic Tools -.\" Title: jdeps.1 -.\" -.if n .pl 99999 -.TH jdeps 1 "21 November 2013" "JDK 8" "Basic Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jdeps \- Java class dependency analyzer\&. -.SH SYNOPSIS -.sp -.nf - -\fBjdeps\fR [\fIoptions\fR] \fIclasses\fR \&.\&.\&. -.fi -.sp -.TP -\fIoptions\fR -Command-line options\&. See Options\&. -.TP -\fIclasses\fR -Name of the classes to analyze\&. You can specify a class that can be found in the class path, by its file name, a directory, or a JAR file\&. -.SH DESCRIPTION -The \fI\fR\f3jdeps\fR command shows the package-level or class-level dependencies of Java class files\&. The input class can be a path name to a \f3\&.class\fR file, a directory, a JAR file, or it can be a fully qualified class name to analyze all class files\&. The options determine the output\&. By default, \f3jdeps\fR outputs the dependencies to the system output\&. It can generate the dependencies in DOT language (see the \f3-dotoutput\fR option)\&. -.SH OPTIONS -.TP --dotoutput <\fIdir\fR> -.br -Destination directory for DOT file output\&. If specified, \f3jdeps\fR will generate one dot file per each analyzed archive named <\fIarchive-file-name\fR>\&.dot listing the dependencies, and also a summary file named summary\&.dot listing the dependencies among the archives\&. -.TP --s, -summary -.br -Prints dependency summary only\&. -.TP --v, -verbose -.br -Prints all class-level dependencies\&. -.TP --verbose:package -.br -Prints package-level dependencies excluding dependencies within the same archive\&. -.TP --verbose:class -.br -Prints class-level dependencies excluding dependencies within the same archive\&. -.TP --cp <\fIpath\fR>, -classpath <\fIpath\fR> -.br -Specifies where to find class files\&. - -See also Setting the Class Path\&. -.TP --p <\fIpkg name\fR>, -package <\fIpkg name\fR> -.br -Finds dependencies in the specified package\&. You can specify this option multiple times for different packages\&. The \f3-p\fR and \f3-e\fR options are mutually exclusive\&. -.TP --e <\fIregex\fR>, -regex <\fIregex\fR> -.br -Finds dependencies in packages matching the specified regular expression pattern\&. The \f3-p\fR and \f3-e\fR options are mutually exclusive\&. -.TP --include <\fIregex\fR> -.br -Restricts analysis to classes matching pattern\&. This option filters the list of classes to be analyzed\&. It can be used together with \f3-p\fR and \f3-e\fR which apply pattern to the dependencies\&. -.TP --jdkinternals -.br -Finds class-level dependences in JDK internal APIs\&. By default, it analyzes all classes specified in the \f3-classpath\fR option and in input files unless you specified the \f3-include\fR option\&. You cannot use this option with the \f3-p\fR, \f3-e\fR, and \f3-s\fR options\&. - -\fIWarning\fR: JDK internal APIs may not be accessible in upcoming releases\&. -.TP --P, -profile -.br -Shows profile or the file containing a package\&. -.TP --apionly -.br -Restricts analysis to APIs, for example, dependences from the signature of \f3public\fR and \f3protected\fR members of public classes including field type, method parameter types, returned type, and checked exception types\&. -.TP --R, -recursive -.br -Recursively traverses all dependencies\&. -.TP --version -.br -Prints version information\&. -.TP --h, -?, -help -.br -Prints help message for \f3jdeps\fR\&. -.SH EXAMPLES -Analyzing the dependencies of Notepad\&.jar\&. -.sp -.nf -\f3$ jdeps demo/jfc/Notepad/Notepad\&.jar\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3demo/jfc/Notepad/Notepad\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP -.fi -.nf -\f3 <unnamed> (Notepad\&.jar)\fP -.fi -.nf -\f3 \-> java\&.awt \fP -.fi -.nf -\f3 \-> java\&.awt\&.event \fP -.fi -.nf -\f3 \-> java\&.beans \fP -.fi -.nf -\f3 \-> java\&.io \fP -.fi -.nf -\f3 \-> java\&.lang \fP -.fi -.nf -\f3 \-> java\&.net \fP -.fi -.nf -\f3 \-> java\&.util \fP -.fi -.nf -\f3 \-> java\&.util\&.logging \fP -.fi -.nf -\f3 \-> javax\&.swing \fP -.fi -.nf -\f3 \-> javax\&.swing\&.border \fP -.fi -.nf -\f3 \-> javax\&.swing\&.event \fP -.fi -.nf -\f3 \-> javax\&.swing\&.text \fP -.fi -.nf -\f3 \-> javax\&.swing\&.tree \fP -.fi -.nf -\f3 \-> javax\&.swing\&.undo \fP -.fi -.nf -\f3\fP -.fi -.sp -Use -P or -profile option to show on which profile that Notepad depends\&. -.sp -.nf -\f3$ jdeps \-profile demo/jfc/Notepad/Notepad\&.jar \fP -.fi -.nf -\f3demo/jfc/Notepad/Notepad\&.jar \-> /usr/java/jre/lib/rt\&.jar (Full JRE)\fP -.fi -.nf -\f3 <unnamed> (Notepad\&.jar)\fP -.fi -.nf -\f3 \-> java\&.awt Full JRE\fP -.fi -.nf -\f3 \-> java\&.awt\&.event Full JRE\fP -.fi -.nf -\f3 \-> java\&.beans Full JRE\fP -.fi -.nf -\f3 \-> java\&.io compact1\fP -.fi -.nf -\f3 \-> java\&.lang compact1\fP -.fi -.nf -\f3 \-> java\&.net compact1\fP -.fi -.nf -\f3 \-> java\&.util compact1\fP -.fi -.nf -\f3 \-> java\&.util\&.logging compact1\fP -.fi -.nf -\f3 \-> javax\&.swing Full JRE\fP -.fi -.nf -\f3 \-> javax\&.swing\&.border Full JRE\fP -.fi -.nf -\f3 \-> javax\&.swing\&.event Full JRE\fP -.fi -.nf -\f3 \-> javax\&.swing\&.text Full JRE\fP -.fi -.nf -\f3 \-> javax\&.swing\&.tree Full JRE\fP -.fi -.nf -\f3 \-> javax\&.swing\&.undo Full JRE\fP -.fi -.nf -\f3\fP -.fi -.sp -Analyzing the immediate dependencies of a specific class in a given classpath, for example the \f3com\&.sun\&.tools\&.jdeps\&.Main\fR class in the tools\&.jar file\&. -.sp -.nf -\f3$ jdeps \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP -.fi -.nf -\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP -.fi -.nf -\f3 com\&.sun\&.tools\&.jdeps (tools\&.jar)\fP -.fi -.nf -\f3 \-> java\&.io \fP -.fi -.nf -\f3 \-> java\&.lang \fP -.fi -.nf -\f3\fP -.fi -.sp -Use the \f3-verbose:class\fR option to find class-level dependencies or use the \f3-v\fR or \f3-verbose\fR option to include dependencies from the same JAR file\&. -.sp -.nf -\f3$ jdeps \-verbose:class \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP -.fi -.nf -\f3 com\&.sun\&.tools\&.jdeps\&.Main (tools\&.jar)\fP -.fi -.nf -\f3 \-> java\&.io\&.PrintWriter \fP -.fi -.nf -\f3 \-> java\&.lang\&.Exception \fP -.fi -.nf -\f3 \-> java\&.lang\&.Object \fP -.fi -.nf -\f3 \-> java\&.lang\&.String \fP -.fi -.nf -\f3 \-> java\&.lang\&.System \fP -.fi -.nf -\f3\fP -.fi -.sp -Use the \f3-R\fR or \f3-recursive\fR option to analyze the transitive dependencies of the \f3com\&.sun\&.tools\&.jdeps\&.Main\fR class\&. -.sp -.nf -\f3$ jdeps \-R \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP -.fi -.nf -\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP -.fi -.nf -\f3 com\&.sun\&.tools\&.classfile (tools\&.jar)\fP -.fi -.nf -\f3 \-> java\&.io \fP -.fi -.nf -\f3 \-> java\&.lang \fP -.fi -.nf -\f3 \-> java\&.lang\&.reflect \fP -.fi -.nf -\f3 \-> java\&.nio\&.charset \fP -.fi -.nf -\f3 \-> java\&.nio\&.file \fP -.fi -.nf -\f3 \-> java\&.util \fP -.fi -.nf -\f3 \-> java\&.util\&.regex \fP -.fi -.nf -\f3 com\&.sun\&.tools\&.jdeps (tools\&.jar)\fP -.fi -.nf -\f3 \-> java\&.io \fP -.fi -.nf -\f3 \-> java\&.lang \fP -.fi -.nf -\f3 \-> java\&.nio\&.file \fP -.fi -.nf -\f3 \-> java\&.nio\&.file\&.attribute \fP -.fi -.nf -\f3 \-> java\&.text \fP -.fi -.nf -\f3 \-> java\&.util \fP -.fi -.nf -\f3 \-> java\&.util\&.jar \fP -.fi -.nf -\f3 \-> java\&.util\&.regex \fP -.fi -.nf -\f3 \-> java\&.util\&.zip \fP -.fi -.nf -\f3/usr/java/jre/lib/jce\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP -.fi -.nf -\f3 javax\&.crypto (jce\&.jar)\fP -.fi -.nf -\f3 \-> java\&.io \fP -.fi -.nf -\f3 \-> java\&.lang \fP -.fi -.nf -\f3 \-> java\&.lang\&.reflect \fP -.fi -.nf -\f3 \-> java\&.net \fP -.fi -.nf -\f3 \-> java\&.nio \fP -.fi -.nf -\f3 \-> java\&.security \fP -.fi -.nf -\f3 \-> java\&.security\&.cert \fP -.fi -.nf -\f3 \-> java\&.security\&.spec \fP -.fi -.nf -\f3 \-> java\&.util \fP -.fi -.nf -\f3 \-> java\&.util\&.concurrent \fP -.fi -.nf -\f3 \-> java\&.util\&.jar \fP -.fi -.nf -\f3 \-> java\&.util\&.regex \fP -.fi -.nf -\f3 \-> java\&.util\&.zip \fP -.fi -.nf -\f3 \-> javax\&.security\&.auth \fP -.fi -.nf -\f3 \-> sun\&.security\&.jca JDK internal API (rt\&.jar)\fP -.fi -.nf -\f3 \-> sun\&.security\&.util JDK internal API (rt\&.jar)\fP -.fi -.nf -\f3 javax\&.crypto\&.spec (jce\&.jar)\fP -.fi -.nf -\f3 \-> java\&.lang \fP -.fi -.nf -\f3 \-> java\&.security\&.spec \fP -.fi -.nf -\f3 \-> java\&.util \fP -.fi -.nf -\f3/usr/java/jre/lib/rt\&.jar \-> /usr/java/jre/lib/jce\&.jar\fP -.fi -.nf -\f3 java\&.security (rt\&.jar)\fP -.fi -.nf -\f3 \-> javax\&.crypto\fP -.fi -.nf -\f3\fP -.fi -.sp -Generate dot files of the dependencies of Notepad demo\&. -.sp -.nf -\f3$ jdeps \-dotoutput dot demo/jfc/Notepad/Notepad\&.jar\fP -.fi -.nf -\f3\fP -.fi -.sp -\f3jdeps\fR will create one dot file for each given JAR file named <\fIfilename\fR>\&.dot in the dot directory specified in the \f3-dotoutput\fR option, and also a summary file named summary\&.dot that will list the dependencies among the JAR files -.sp -.nf -\f3$ cat dot/Notepad\&.jar\&.dot \fP -.fi -.nf -\f3digraph "Notepad\&.jar" {\fP -.fi -.nf -\f3 // Path: demo/jfc/Notepad/Notepad\&.jar\fP -.fi -.nf -\f3 "<unnamed>" \-> "java\&.awt";\fP -.fi -.nf -\f3 "<unnamed>" \-> "java\&.awt\&.event";\fP -.fi -.nf -\f3 "<unnamed>" \-> "java\&.beans";\fP -.fi -.nf -\f3 "<unnamed>" \-> "java\&.io";\fP -.fi -.nf -\f3 "<unnamed>" \-> "java\&.lang";\fP -.fi -.nf -\f3 "<unnamed>" \-> "java\&.net";\fP -.fi -.nf -\f3 "<unnamed>" \-> "java\&.util";\fP -.fi -.nf -\f3 "<unnamed>" \-> "java\&.util\&.logging";\fP -.fi -.nf -\f3 "<unnamed>" \-> "javax\&.swing";\fP -.fi -.nf -\f3 "<unnamed>" \-> "javax\&.swing\&.border";\fP -.fi -.nf -\f3 "<unnamed>" \-> "javax\&.swing\&.event";\fP -.fi -.nf -\f3 "<unnamed>" \-> "javax\&.swing\&.text";\fP -.fi -.nf -\f3 "<unnamed>" \-> "javax\&.swing\&.tree";\fP -.fi -.nf -\f3 "<unnamed>" \-> "javax\&.swing\&.undo";\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3$ cat dot/summary\&.dot\fP -.fi -.nf -\f3digraph "summary" {\fP -.fi -.nf -\f3 "Notepad\&.jar" \-> "rt\&.jar";\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH SEE\ ALSO -.TP 0.2i -\(bu -javap(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: jdeps.1 +.\" +.if n .pl 99999 +.TH jdeps 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jdeps \- Java class dependency analyzer\&. +.SH SYNOPSIS +.sp +.nf + +\fBjdeps\fR [\fIoptions\fR] \fIclasses\fR \&.\&.\&. +.fi +.sp +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.TP +\fIclasses\fR +Name of the classes to analyze\&. You can specify a class that can be found in the class path, by its file name, a directory, or a JAR file\&. +.SH DESCRIPTION +The \fI\fR\f3jdeps\fR command shows the package-level or class-level dependencies of Java class files\&. The input class can be a path name to a \f3\&.class\fR file, a directory, a JAR file, or it can be a fully qualified class name to analyze all class files\&. The options determine the output\&. By default, \f3jdeps\fR outputs the dependencies to the system output\&. It can generate the dependencies in DOT language (see the \f3-dotoutput\fR option)\&. +.SH OPTIONS +.TP +-dotoutput <\fIdir\fR> +.br +Destination directory for DOT file output\&. If specified, \f3jdeps\fR will generate one dot file per each analyzed archive named <\fIarchive-file-name\fR>\&.dot listing the dependencies, and also a summary file named summary\&.dot listing the dependencies among the archives\&. +.TP +-s, -summary +.br +Prints dependency summary only\&. +.TP +-v, -verbose +.br +Prints all class-level dependencies\&. +.TP +-verbose:package +.br +Prints package-level dependencies excluding dependencies within the same archive\&. +.TP +-verbose:class +.br +Prints class-level dependencies excluding dependencies within the same archive\&. +.TP +-cp <\fIpath\fR>, -classpath <\fIpath\fR> +.br +Specifies where to find class files\&. + +See also Setting the Class Path\&. +.TP +-p <\fIpkg name\fR>, -package <\fIpkg name\fR> +.br +Finds dependencies in the specified package\&. You can specify this option multiple times for different packages\&. The \f3-p\fR and \f3-e\fR options are mutually exclusive\&. +.TP +-e <\fIregex\fR>, -regex <\fIregex\fR> +.br +Finds dependencies in packages matching the specified regular expression pattern\&. The \f3-p\fR and \f3-e\fR options are mutually exclusive\&. +.TP +-include <\fIregex\fR> +.br +Restricts analysis to classes matching pattern\&. This option filters the list of classes to be analyzed\&. It can be used together with \f3-p\fR and \f3-e\fR which apply pattern to the dependencies\&. +.TP +-jdkinternals +.br +Finds class-level dependences in JDK internal APIs\&. By default, it analyzes all classes specified in the \f3-classpath\fR option and in input files unless you specified the \f3-include\fR option\&. You cannot use this option with the \f3-p\fR, \f3-e\fR, and \f3-s\fR options\&. + +\fIWarning\fR: JDK internal APIs may not be accessible in upcoming releases\&. +.TP +-P, -profile +.br +Shows profile or the file containing a package\&. +.TP +-apionly +.br +Restricts analysis to APIs, for example, dependences from the signature of \f3public\fR and \f3protected\fR members of public classes including field type, method parameter types, returned type, and checked exception types\&. +.TP +-R, -recursive +.br +Recursively traverses all dependencies\&. +.TP +-version +.br +Prints version information\&. +.TP +-h, -?, -help +.br +Prints help message for \f3jdeps\fR\&. +.SH EXAMPLES +Analyzing the dependencies of Notepad\&.jar\&. +.sp +.nf +\f3$ jdeps demo/jfc/Notepad/Notepad\&.jar\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3demo/jfc/Notepad/Notepad\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 <unnamed> (Notepad\&.jar)\fP +.fi +.nf +\f3 \-> java\&.awt \fP +.fi +.nf +\f3 \-> java\&.awt\&.event \fP +.fi +.nf +\f3 \-> java\&.beans \fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.net \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3 \-> java\&.util\&.logging \fP +.fi +.nf +\f3 \-> javax\&.swing \fP +.fi +.nf +\f3 \-> javax\&.swing\&.border \fP +.fi +.nf +\f3 \-> javax\&.swing\&.event \fP +.fi +.nf +\f3 \-> javax\&.swing\&.text \fP +.fi +.nf +\f3 \-> javax\&.swing\&.tree \fP +.fi +.nf +\f3 \-> javax\&.swing\&.undo \fP +.fi +.nf +\f3\fP +.fi +.sp +Use -P or -profile option to show on which profile that Notepad depends\&. +.sp +.nf +\f3$ jdeps \-profile demo/jfc/Notepad/Notepad\&.jar \fP +.fi +.nf +\f3demo/jfc/Notepad/Notepad\&.jar \-> /usr/java/jre/lib/rt\&.jar (Full JRE)\fP +.fi +.nf +\f3 <unnamed> (Notepad\&.jar)\fP +.fi +.nf +\f3 \-> java\&.awt Full JRE\fP +.fi +.nf +\f3 \-> java\&.awt\&.event Full JRE\fP +.fi +.nf +\f3 \-> java\&.beans Full JRE\fP +.fi +.nf +\f3 \-> java\&.io compact1\fP +.fi +.nf +\f3 \-> java\&.lang compact1\fP +.fi +.nf +\f3 \-> java\&.net compact1\fP +.fi +.nf +\f3 \-> java\&.util compact1\fP +.fi +.nf +\f3 \-> java\&.util\&.logging compact1\fP +.fi +.nf +\f3 \-> javax\&.swing Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.border Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.event Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.text Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.tree Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.undo Full JRE\fP +.fi +.nf +\f3\fP +.fi +.sp +Analyzing the immediate dependencies of a specific class in a given classpath, for example the \f3com\&.sun\&.tools\&.jdeps\&.Main\fR class in the tools\&.jar file\&. +.sp +.nf +\f3$ jdeps \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP +.fi +.nf +\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 com\&.sun\&.tools\&.jdeps (tools\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3\fP +.fi +.sp +Use the \f3-verbose:class\fR option to find class-level dependencies or use the \f3-v\fR or \f3-verbose\fR option to include dependencies from the same JAR file\&. +.sp +.nf +\f3$ jdeps \-verbose:class \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 com\&.sun\&.tools\&.jdeps\&.Main (tools\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io\&.PrintWriter \fP +.fi +.nf +\f3 \-> java\&.lang\&.Exception \fP +.fi +.nf +\f3 \-> java\&.lang\&.Object \fP +.fi +.nf +\f3 \-> java\&.lang\&.String \fP +.fi +.nf +\f3 \-> java\&.lang\&.System \fP +.fi +.nf +\f3\fP +.fi +.sp +Use the \f3-R\fR or \f3-recursive\fR option to analyze the transitive dependencies of the \f3com\&.sun\&.tools\&.jdeps\&.Main\fR class\&. +.sp +.nf +\f3$ jdeps \-R \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP +.fi +.nf +\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 com\&.sun\&.tools\&.classfile (tools\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.lang\&.reflect \fP +.fi +.nf +\f3 \-> java\&.nio\&.charset \fP +.fi +.nf +\f3 \-> java\&.nio\&.file \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3 \-> java\&.util\&.regex \fP +.fi +.nf +\f3 com\&.sun\&.tools\&.jdeps (tools\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.nio\&.file \fP +.fi +.nf +\f3 \-> java\&.nio\&.file\&.attribute \fP +.fi +.nf +\f3 \-> java\&.text \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3 \-> java\&.util\&.jar \fP +.fi +.nf +\f3 \-> java\&.util\&.regex \fP +.fi +.nf +\f3 \-> java\&.util\&.zip \fP +.fi +.nf +\f3/usr/java/jre/lib/jce\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 javax\&.crypto (jce\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.lang\&.reflect \fP +.fi +.nf +\f3 \-> java\&.net \fP +.fi +.nf +\f3 \-> java\&.nio \fP +.fi +.nf +\f3 \-> java\&.security \fP +.fi +.nf +\f3 \-> java\&.security\&.cert \fP +.fi +.nf +\f3 \-> java\&.security\&.spec \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3 \-> java\&.util\&.concurrent \fP +.fi +.nf +\f3 \-> java\&.util\&.jar \fP +.fi +.nf +\f3 \-> java\&.util\&.regex \fP +.fi +.nf +\f3 \-> java\&.util\&.zip \fP +.fi +.nf +\f3 \-> javax\&.security\&.auth \fP +.fi +.nf +\f3 \-> sun\&.security\&.jca JDK internal API (rt\&.jar)\fP +.fi +.nf +\f3 \-> sun\&.security\&.util JDK internal API (rt\&.jar)\fP +.fi +.nf +\f3 javax\&.crypto\&.spec (jce\&.jar)\fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.security\&.spec \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3/usr/java/jre/lib/rt\&.jar \-> /usr/java/jre/lib/jce\&.jar\fP +.fi +.nf +\f3 java\&.security (rt\&.jar)\fP +.fi +.nf +\f3 \-> javax\&.crypto\fP +.fi +.nf +\f3\fP +.fi +.sp +Generate dot files of the dependencies of Notepad demo\&. +.sp +.nf +\f3$ jdeps \-dotoutput dot demo/jfc/Notepad/Notepad\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3jdeps\fR will create one dot file for each given JAR file named <\fIfilename\fR>\&.dot in the dot directory specified in the \f3-dotoutput\fR option, and also a summary file named summary\&.dot that will list the dependencies among the JAR files +.sp +.nf +\f3$ cat dot/Notepad\&.jar\&.dot \fP +.fi +.nf +\f3digraph "Notepad\&.jar" {\fP +.fi +.nf +\f3 // Path: demo/jfc/Notepad/Notepad\&.jar\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.awt";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.awt\&.event";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.beans";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.io";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.lang";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.net";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.util";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.util\&.logging";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.border";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.event";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.text";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.tree";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.undo";\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3$ cat dot/summary\&.dot\fP +.fi +.nf +\f3digraph "summary" {\fP +.fi +.nf +\f3 "Notepad\&.jar" \-> "rt\&.jar";\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +javap(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/jhat.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/jhat.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,136 +1,136 @@ -'\" t -.\" Copyright (c) 2006, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Troubleshooting Tools -.\" Title: jhat.1 -.\" -.if n .pl 99999 -.TH jhat 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jhat \- Analyzes the Java heap\&. This command is experimental and unsupported\&. -.SH SYNOPSIS -.sp -.nf - -\fBjhat\fR [ \fIoptions\fR ] \fIheap\-dump\-file\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIheap-dump-file\fR -Java binary heap dump file to be browsed\&. For a dump file that contains multiple heap dumps, you can specify which dump in the file by appending \f3#<number>\fR to the file name, for example, \f3myfile\&.hprof#3\fR\&. -.SH DESCRIPTION -The \f3jhat\fR command parses a Java heap dump file and starts a web server\&. The \f3jhat\fR command lets you to browse heap dumps with your favorite web browser\&. The \f3jhat\fR command supports predesigned queries such as show all instances of a known class \f3MyClass\fR, and Object Query Language (OQL)\&. OQL is similar to SQL, except for querying heap dumps\&. Help on OQL is available from the OQL help page shown by the \f3jhat\fR command\&. With the default port, OQL help is available at http://localhost:7000/oqlhelp/ -.PP -There are several ways to generate a Java heap dump: -.TP 0.2i -\(bu -Use the \f3jmap -dump\fR option to obtain a heap dump at runtime\&. See jmap(1)\&. -.TP 0.2i -\(bu -Use the \f3jconsole\fR option to obtain a heap dump through \f3HotSpotDiagnosticMXBean\fR at runtime\&. See jconsole(1) and the \f3HotSpotDiagnosticMXBean\fR interface description at http://docs\&.oracle\&.com/javase/8/docs/jre/api/management/extension/com/sun/management/HotSpotDiagnosticMXBean\&.html -.TP 0.2i -\(bu -Heap dump is generated when an \f3OutOfMemoryError\fR is thrown by specifying the \f3-XX:+HeapDumpOnOutOfMemoryError\fR Java Virtual Machine (JVM) option\&. -.TP 0.2i -\(bu -Use the \f3hprof\fR command\&. See the HPROF: A Heap/CPU Profiling Tool at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/hprof\&.html -.SH OPTIONS -.TP --stack false|true -.br -Turns off tracking object allocation call stack\&. If allocation site information is not available in the heap dump, then you have to set this flag to \f3false\fR\&. The default is \f3true\fR\&. -.TP --refs false|true -.br -Turns off tracking of references to objects\&. Default is \f3true\fR\&. By default, back pointers, which are objects that point to a specified object such as referrers or incoming references, are calculated for all objects in the heap\&. -.TP --port \fIport-number\fR -.br -Sets the port for the \f3jhat\fR HTTP server\&. Default is 7000\&. -.TP --exclude \fIexclude-file\fR -.br -Specifies a file that lists data members that should be excluded from the reachable objects query\&. For example, if the file lists \f3java\&.lang\&.String\&.value\fR, then, then whenever the list of objects that are reachable from a specific object \f3o\fR are calculated, reference paths that involve \f3java\&.lang\&.String\&.value\fR field are not considered\&. -.TP --baseline \fIexclude-file\fR -.br -Specifies a baseline heap dump\&. Objects in both heap dumps with the same object ID are marked as not being new\&. Other objects are marked as new\&. This is useful for comparing two different heap dumps\&. -.TP --debug \fIint\fR -.br -Sets the debug level for this tool\&. A level of 0 means no debug output\&. Set higher values for more verbose modes\&. -.TP --version -.br -Reports the release number and exits -.TP --h -.br -Dsiplays a help message and exits\&. -.TP --help -.br -Displays a help message and exits\&. -.TP --J\fIflag\fR -.br -Passes \f3flag\fR to the Java Virtual Machine on which the \f3jhat\fR command is running\&. For example, \f3-J-Xmx512m\fR to use a maximum heap size of 512 MB\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -jmap(1) -.TP 0.2i -\(bu -jconsole(1) -.TP 0.2i -\(bu -HPROF: A Heap/CPU Profiling Tool at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/hprof\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2006, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jhat.1 +.\" +.if n .pl 99999 +.TH jhat 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jhat \- Analyzes the Java heap\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjhat\fR [ \fIoptions\fR ] \fIheap\-dump\-file\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIheap-dump-file\fR +Java binary heap dump file to be browsed\&. For a dump file that contains multiple heap dumps, you can specify which dump in the file by appending \f3#<number>\fR to the file name, for example, \f3myfile\&.hprof#3\fR\&. +.SH DESCRIPTION +The \f3jhat\fR command parses a Java heap dump file and starts a web server\&. The \f3jhat\fR command lets you to browse heap dumps with your favorite web browser\&. The \f3jhat\fR command supports predesigned queries such as show all instances of a known class \f3MyClass\fR, and Object Query Language (OQL)\&. OQL is similar to SQL, except for querying heap dumps\&. Help on OQL is available from the OQL help page shown by the \f3jhat\fR command\&. With the default port, OQL help is available at http://localhost:7000/oqlhelp/ +.PP +There are several ways to generate a Java heap dump: +.TP 0.2i +\(bu +Use the \f3jmap -dump\fR option to obtain a heap dump at runtime\&. See jmap(1)\&. +.TP 0.2i +\(bu +Use the \f3jconsole\fR option to obtain a heap dump through \f3HotSpotDiagnosticMXBean\fR at runtime\&. See jconsole(1) and the \f3HotSpotDiagnosticMXBean\fR interface description at http://docs\&.oracle\&.com/javase/8/docs/jre/api/management/extension/com/sun/management/HotSpotDiagnosticMXBean\&.html +.TP 0.2i +\(bu +Heap dump is generated when an \f3OutOfMemoryError\fR is thrown by specifying the \f3-XX:+HeapDumpOnOutOfMemoryError\fR Java Virtual Machine (JVM) option\&. +.TP 0.2i +\(bu +Use the \f3hprof\fR command\&. See the HPROF: A Heap/CPU Profiling Tool at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/hprof\&.html +.SH OPTIONS +.TP +-stack false|true +.br +Turns off tracking object allocation call stack\&. If allocation site information is not available in the heap dump, then you have to set this flag to \f3false\fR\&. The default is \f3true\fR\&. +.TP +-refs false|true +.br +Turns off tracking of references to objects\&. Default is \f3true\fR\&. By default, back pointers, which are objects that point to a specified object such as referrers or incoming references, are calculated for all objects in the heap\&. +.TP +-port \fIport-number\fR +.br +Sets the port for the \f3jhat\fR HTTP server\&. Default is 7000\&. +.TP +-exclude \fIexclude-file\fR +.br +Specifies a file that lists data members that should be excluded from the reachable objects query\&. For example, if the file lists \f3java\&.lang\&.String\&.value\fR, then, then whenever the list of objects that are reachable from a specific object \f3o\fR are calculated, reference paths that involve \f3java\&.lang\&.String\&.value\fR field are not considered\&. +.TP +-baseline \fIexclude-file\fR +.br +Specifies a baseline heap dump\&. Objects in both heap dumps with the same object ID are marked as not being new\&. Other objects are marked as new\&. This is useful for comparing two different heap dumps\&. +.TP +-debug \fIint\fR +.br +Sets the debug level for this tool\&. A level of 0 means no debug output\&. Set higher values for more verbose modes\&. +.TP +-version +.br +Reports the release number and exits +.TP +-h +.br +Dsiplays a help message and exits\&. +.TP +-help +.br +Displays a help message and exits\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR to the Java Virtual Machine on which the \f3jhat\fR command is running\&. For example, \f3-J-Xmx512m\fR to use a maximum heap size of 512 MB\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jmap(1) +.TP 0.2i +\(bu +jconsole(1) +.TP 0.2i +\(bu +HPROF: A Heap/CPU Profiling Tool at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/hprof\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/jinfo.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/jinfo.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,132 +1,132 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Troubleshooting Tools -.\" Title: jinfo.1 -.\" -.if n .pl 99999 -.TH jinfo 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jinfo \- Generates configuration information\&. This command is experimental and unsupported\&. -.SH SYNOPSIS -.sp -.nf - -\fBjinfo\fR [ \fIoption\fR ] \fIpid\fR -.fi -.nf - -\fBjinfo\fR [ \fIoption \fR] \fIexecutable core\fR -.fi -.nf - -\fBjinfo\fR [ \fIoption \fR] \fI[ servier\-id ] remote\-hostname\-or\-IP\fR -.fi -.sp -.TP -\fIoption\fR -The command-line options\&. See Options\&. -.TP -\fIpid\fR -The process ID for which the configuration information is to be printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. -.TP -\fIexecutable\fR -The Java executable from which the core dump was produced\&. -.TP -\fIcore\fR -The core file for which the configuration information is to be printed\&. -.TP -\fIremote-hostname-or-IP\fR -The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. -.TP -\fIserver-id\fR -An optional unique ID to use when multiple debug servers are running on the same remote host\&. -.SH DESCRIPTION -The \f3jinfo\fR command prints Java configuration information for a specified Java process or core file or a remote debug server\&. The configuration information includes Java system properties and Java Virtual Machine (JVM) command-line flags\&. If the specified process is running on a 64-bit JVM, then you might need to specify the \f3-J-d64\fR option, for example: \f3jinfo\fR\f3-J-d64 -sysprops pid\fR\&. -.PP -This utility is unsupported and might not be available in future releases of the JDK\&. In Windows Systems where \f3dbgeng\&.dll\fR is not present, Debugging Tools For Windows must be installed to have these tools working\&. The \f3PATH\fR environment variable should contain the location of the jvm\&.dll that is used by the target process or the location from which the crash dump file was produced\&. For example, \f3set PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR \&. -.SH OPTIONS -.TP -no-option -Prints both command-line flags and system property name-value pairs\&. -.TP --flag \fIname\fR -.br -Prints the name and value of the specified command-line flag\&. -.TP --flag \fI[+|-]name\fR -.br -enables or disables the specified Boolean command-line flag\&. -.TP --flag \fIname=value\fR -.br -Sets the specified command-line flag to the specified value\&. -.TP --flags -.br -Prints command-line flags passed to the JVM\&. -.TP --sysprops -.br -Prints Java system properties as name-value pairs\&. -.TP --h -.br -Prints a help message\&. -.TP --help -.br -Prints a help message\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -jps(1) -.TP 0.2i -\(bu -jsadebugd(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jinfo.1 +.\" +.if n .pl 99999 +.TH jinfo 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jinfo \- Generates configuration information\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjinfo\fR [ \fIoption\fR ] \fIpid\fR +.fi +.nf + +\fBjinfo\fR [ \fIoption \fR] \fIexecutable core\fR +.fi +.nf + +\fBjinfo\fR [ \fIoption \fR] \fI[ servier\-id ] remote\-hostname\-or\-IP\fR +.fi +.sp +.TP +\fIoption\fR +The command-line options\&. See Options\&. +.TP +\fIpid\fR +The process ID for which the configuration information is to be printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. +.TP +\fIexecutable\fR +The Java executable from which the core dump was produced\&. +.TP +\fIcore\fR +The core file for which the configuration information is to be printed\&. +.TP +\fIremote-hostname-or-IP\fR +The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. +.TP +\fIserver-id\fR +An optional unique ID to use when multiple debug servers are running on the same remote host\&. +.SH DESCRIPTION +The \f3jinfo\fR command prints Java configuration information for a specified Java process or core file or a remote debug server\&. The configuration information includes Java system properties and Java Virtual Machine (JVM) command-line flags\&. If the specified process is running on a 64-bit JVM, then you might need to specify the \f3-J-d64\fR option, for example: \f3jinfo\fR\f3-J-d64 -sysprops pid\fR\&. +.PP +This utility is unsupported and might not be available in future releases of the JDK\&. In Windows Systems where \f3dbgeng\&.dll\fR is not present, Debugging Tools For Windows must be installed to have these tools working\&. The \f3PATH\fR environment variable should contain the location of the jvm\&.dll that is used by the target process or the location from which the crash dump file was produced\&. For example, \f3set PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR \&. +.SH OPTIONS +.TP +no-option +Prints both command-line flags and system property name-value pairs\&. +.TP +-flag \fIname\fR +.br +Prints the name and value of the specified command-line flag\&. +.TP +-flag \fI[+|-]name\fR +.br +enables or disables the specified Boolean command-line flag\&. +.TP +-flag \fIname=value\fR +.br +Sets the specified command-line flag to the specified value\&. +.TP +-flags +.br +Prints command-line flags passed to the JVM\&. +.TP +-sysprops +.br +Prints Java system properties as name-value pairs\&. +.TP +-h +.br +Prints a help message\&. +.TP +-help +.br +Prints a help message\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jsadebugd(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/jjs.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/jjs.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/jmap.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/jmap.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,143 +1,143 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Troubleshooting Tools -.\" Title: jmap.1 -.\" -.if n .pl 99999 -.TH jmap 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jmap \- Prints shared object memory maps or heap memory details for a process, core file, or remote debug server\&. This command is experimental and unsupported\&. -.SH SYNOPSIS -.sp -.nf - -\fBjmap\fR [ \fIoptions\fR ] \fIpid\fR -.fi -.nf - -\fBjmap\fR [ \fIoptions\fR ] \fIexecutable\fR \fIcore\fR -.fi -.nf - -\fBjmap\fR [ \fIoptions\fR ] [ \fIpid\fR ] \fIserver\-id\fR@ ] \fIremote\-hostname\-or\-IP\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIpid\fR -The process ID for which the memory map is to be printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. -.TP -\fIexecutable\fR -The Java executable from which the core dump was produced\&. -.TP -\fIcore\fR -The core file for which the memory map is to be printed\&. -.TP -\fIremote-hostname-or-IP\fR -The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. -.TP -\fIserver-id\fR -An optional unique ID to use when multiple debug servers are running on the same remote host\&. -.SH DESCRIPTION -The \f3jmap\fR command prints shared object memory maps or heap memory details of a specified process, core file, or remote debug server\&. If the specified process is running on a 64-bit Java Virtual Machine (JVM), then you might need to specify the \f3-J-d64\fR option, for example: \f3jmap\fR\f3-J-d64 -heap pid\fR\&. -.PP -\fINote:\fR This utility is unsupported and might not be available in future releases of the JDK\&. On Windows Systems where the \f3dbgeng\&.dll\fR file is not present, Debugging Tools For Windows must be installed to make these tools work\&. The \f3PATH\fR environment variable should contain the location of the \f3jvm\&.dll\fR file that is used by the target process or the location from which the crash dump file was produced, for example: \f3set PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR\&. -.SH OPTIONS -.TP -<no option> -When no option is used, the \f3jmap\fR command prints shared object mappings\&. For each shared object loaded in the target JVM, the start address, size of the mapping, and the full path of the shared object file are printed\&. This behavior is similar to the Oracle Solaris \f3pmap\fR utility\&. -.TP --dump:[live,] format=b, file=\fIfilename\fR -.br -Dumps the Java heap in \f3hprof\fR binary format to \f3filename\fR\&. The \f3live\fR suboption is optional, but when specified, only the active objects in the heap are dumped\&. To browse the heap dump, you can use the jhat(1) command to read the generated file\&. -.TP --finalizerinfo -.br -Prints information about objects that are awaiting finalization\&. -.TP --heap -.br -Prints a heap summary of the garbage collection used, the head configuration, and generation-wise heap usage\&. In addition, the number and size of interned Strings are printed\&. -.TP --histo[:live] -.br -Prints a histogram of the heap\&. For each Java class, the number of objects, memory size in bytes, and the fully qualified class names are printed\&. The JVM internal class names are printed with an asterisk (*) prefix\&. If the \f3live\fR suboption is specified, then only active objects are counted\&. -.TP --clstats -.br -Prints class loader wise statistics of Java heap\&. For each class loader, its name, how active it is, address, parent class loader, and the number and size of classes it has loaded are printed\&. -.TP --F -.br -Force\&. Use this option with the \f3jmap -dump\fR or \f3jmap -histo\fR option when the pid does not respond\&. The \f3live\fR suboption is not supported in this mode\&. -.TP --h -.br -Prints a help message\&. -.TP --help -.br -Prints a help message\&. -.TP --J\fIflag\fR -.br -Passes \f3flag\fR to the Java Virtual Machine where the \f3jmap\fR command is running\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -jhat(1) -.TP 0.2i -\(bu -jps(1) -.TP 0.2i -\(bu -jsadebugd(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jmap.1 +.\" +.if n .pl 99999 +.TH jmap 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jmap \- Prints shared object memory maps or heap memory details for a process, core file, or remote debug server\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjmap\fR [ \fIoptions\fR ] \fIpid\fR +.fi +.nf + +\fBjmap\fR [ \fIoptions\fR ] \fIexecutable\fR \fIcore\fR +.fi +.nf + +\fBjmap\fR [ \fIoptions\fR ] [ \fIpid\fR ] \fIserver\-id\fR@ ] \fIremote\-hostname\-or\-IP\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIpid\fR +The process ID for which the memory map is to be printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. +.TP +\fIexecutable\fR +The Java executable from which the core dump was produced\&. +.TP +\fIcore\fR +The core file for which the memory map is to be printed\&. +.TP +\fIremote-hostname-or-IP\fR +The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. +.TP +\fIserver-id\fR +An optional unique ID to use when multiple debug servers are running on the same remote host\&. +.SH DESCRIPTION +The \f3jmap\fR command prints shared object memory maps or heap memory details of a specified process, core file, or remote debug server\&. If the specified process is running on a 64-bit Java Virtual Machine (JVM), then you might need to specify the \f3-J-d64\fR option, for example: \f3jmap\fR\f3-J-d64 -heap pid\fR\&. +.PP +\fINote:\fR This utility is unsupported and might not be available in future releases of the JDK\&. On Windows Systems where the \f3dbgeng\&.dll\fR file is not present, Debugging Tools For Windows must be installed to make these tools work\&. The \f3PATH\fR environment variable should contain the location of the \f3jvm\&.dll\fR file that is used by the target process or the location from which the crash dump file was produced, for example: \f3set PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR\&. +.SH OPTIONS +.TP +<no option> +When no option is used, the \f3jmap\fR command prints shared object mappings\&. For each shared object loaded in the target JVM, the start address, size of the mapping, and the full path of the shared object file are printed\&. This behavior is similar to the Oracle Solaris \f3pmap\fR utility\&. +.TP +-dump:[live,] format=b, file=\fIfilename\fR +.br +Dumps the Java heap in \f3hprof\fR binary format to \f3filename\fR\&. The \f3live\fR suboption is optional, but when specified, only the active objects in the heap are dumped\&. To browse the heap dump, you can use the jhat(1) command to read the generated file\&. +.TP +-finalizerinfo +.br +Prints information about objects that are awaiting finalization\&. +.TP +-heap +.br +Prints a heap summary of the garbage collection used, the head configuration, and generation-wise heap usage\&. In addition, the number and size of interned Strings are printed\&. +.TP +-histo[:live] +.br +Prints a histogram of the heap\&. For each Java class, the number of objects, memory size in bytes, and the fully qualified class names are printed\&. The JVM internal class names are printed with an asterisk (*) prefix\&. If the \f3live\fR suboption is specified, then only active objects are counted\&. +.TP +-clstats +.br +Prints class loader wise statistics of Java heap\&. For each class loader, its name, how active it is, address, parent class loader, and the number and size of classes it has loaded are printed\&. +.TP +-F +.br +Force\&. Use this option with the \f3jmap -dump\fR or \f3jmap -histo\fR option when the pid does not respond\&. The \f3live\fR suboption is not supported in this mode\&. +.TP +-h +.br +Prints a help message\&. +.TP +-help +.br +Prints a help message\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR to the Java Virtual Machine where the \f3jmap\fR command is running\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jhat(1) +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jsadebugd(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/jps.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/jps.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,204 +1,204 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Monitoring Tools -.\" Title: jps.1 -.\" -.if n .pl 99999 -.TH jps 1 "21 November 2013" "JDK 8" "Monitoring Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jps \- Lists the instrumented Java Virtual Machines (JVMs) on the target system\&. This command is experimental and unsupported\&. -.SH SYNOPSIS -.sp -.nf - -\fBjps\fR [ \fIoptions\fR ] [ \fIhostid\fR ] -.fi -.sp -.TP -\fIoptions\fR -Command-line options\&. See Options\&. -.TP -\fIhostid\fR -The identifier of the host for which the process report should be generated\&. The \f3hostid\fR can include optional components that indicate the communications protocol, port number, and other implementation specific data\&. See Host Identifier\&. -.SH DESCRIPTION -The \f3jps\fR command lists the instrumented Java HotSpot VMs on the target system\&. The command is limited to reporting information on JVMs for which it has the access permissions\&. -.PP -If the \f3jps\fR command is run without specifying a \f3hostid\fR, then it searches for instrumented JVMs on the local host\&. If started with a \f3hostid\fR, then it searches for JVMs on the indicated host, using the specified protocol and port\&. A \f3jstatd\fR process is assumed to be running on the target host\&. -.PP -The \f3jps\fR command reports the local JVM identifier, or \f3lvmid\fR, for each instrumented JVM found on the target system\&. The \f3lvmid\fR is typically, but not necessarily, the operating system\&'s process identifier for the JVM process\&. With no options, \f3jps\fR lists each Java application\&'s \f3lvmid\fR followed by the short form of the application\&'s class name or jar file name\&. The short form of the class name or JAR file name omits the class\&'s package information or the JAR files path information\&. -.PP -The \f3jps\fR command uses the Java launcher to find the class name and arguments passed to the main method\&. If the target JVM is started with a custom launcher, then the class or JAR file name and the arguments to the \f3main\fR method are not available\&. In this case, the \f3jps\fR command outputs the string \f3Unknown\fR for the class name or JAR file name and for the arguments to the \f3main\fR method\&. -.PP -The list of JVMs produced by the \f3jps\fR command can be limited by the permissions granted to the principal running the command\&. The command only lists the JVMs for which the principle has access rights as determined by operating system-specific access control mechanisms\&. -.SH OPTIONS -The \f3jps\fR command supports a number of options that modify the output of the command\&. These options are subject to change or removal in the future\&. -.TP --q -.br -Suppresses the output of the class name, JAR file name, and arguments passed to the \f3main\fR method, producing only a list of local JVM identifiers\&. -.TP --m -.br -Displays the arguments passed to the \f3main\fR method\&. The output may be \f3null\fR for embedded JVMs\&. -.TP --l -.br -Displays the full package name for the application\&'s \f3main\fR class or the full path name to the application\&'s JAR file\&. -.TP --v -.br -Displays the arguments passed to the JVM\&. -.TP --V -.br -Suppresses the output of the class name, JAR file name, and arguments passed to the main method, producing only a list of local JVM identifiers\&. -.TP --J\f3option\fR -.br -Passes \f3option\fR to the JVM, where option is one of the \f3options\fR described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH HOST\ IDENTIFIER -The host identifier, or \f3hostid\fR is a string that indicates the target system\&. The syntax of the \f3hostid\fR string corresponds to the syntax of a URI: -.sp -.nf -\f3[protocol:][[//]hostname][:port][/servername]\fP -.fi -.nf -\f3\fP -.fi -.sp -.TP -\fIprotocol\fR -The communications protocol\&. If the \f3protocol\fR is omitted and a \f3hostname\fR is not specified, then the default protocol is a platform-specific, optimized, local protocol\&. If the protocol is omitted and a host name is specified, then the default protocol is \f3rmi\fR\&. -.TP -hostname -A hostname or IP address that indicates the target host\&. If you omit the \f3hostname\fR parameter, then the target host is the local host\&. -.TP -port -The default port for communicating with the remote server\&. If the \f3hostname\fR parameter is omitted or the \f3protocol\fR parameter specifies an optimized, local protocol, then the \f3port\fR parameter is ignored\&. Otherwise, treatment of the \f3port\fR parameter is implementation specific\&. For the default \f3rmi\fR protocol, the \f3port\fR parameter indicates the port number for the rmiregistry on the remote host\&. If the \f3port\fR parameter is omitted, and the \f3protocol\fR parameter indicates \f3rmi\fR, then the default rmiregistry port (1099) is used\&. -.TP -servername -The treatment of this parameter depends on the implementation\&. For the optimized, local protocol, this field is ignored\&. For the \f3rmi\fR protocol, this parameter is a string that represents the name of the RMI remote object on the remote host\&. See the \f3jstatd\fR command \f3-n\fRoption for more information\&. -.SH OUTPUT\ FORMAT -The output of the \f3jps\fR command follows the following pattern: -.sp -.nf -\f3lvmid [ [ classname | JARfilename | "Unknown"] [ arg* ] [ jvmarg* ] ]\fP -.fi -.nf -\f3\fP -.fi -.sp -All output tokens are separated by white space\&. An \f3arg\fR value that includes embedded white space introduces ambiguity when attempting to map arguments to their actual positional parameters\&. -.PP -\fINote:\fR It is recommended that you do not write scripts to parse \f3jps\fR output because the format might change in future releases\&. If you write scripts that parse \f3jps\fR output, then expect to modify them for future releases of this tool\&. -.SH EXAMPLES -This section provides examples of the \f3jps\fR command\&. -.PP -List the instrumented JVMs on the local host: -.sp -.nf -\f3jps\fP -.fi -.nf -\f318027 Java2Demo\&.JAR\fP -.fi -.nf -\f318032 jps\fP -.fi -.nf -\f318005 jstat\fP -.fi -.nf -\f3\fP -.fi -.sp -The following example lists the instrumented JVMs on a remote host\&. This example assumes that the \f3jstat\fR server and either the its internal RMI registry or a separate external rmiregistry process are running on the remote host on the default port (port 1099)\&. It also assumes that the local host has appropriate permissions to access the remote host\&. This example also includes the \f3-l\fR option to output the long form of the class names or JAR file names\&. -.sp -.nf -\f3jps \-l remote\&.domain\fP -.fi -.nf -\f33002 /opt/jdk1\&.7\&.0/demo/jfc/Java2D/Java2Demo\&.JAR\fP -.fi -.nf -\f32857 sun\&.tools\&.jstatd\&.jstatd\fP -.fi -.nf -\f3\fP -.fi -.sp -The following example lists the instrumented JVMs on a remote host with a non-default port for the RMI registry\&. This example assumes that the \f3jstatd\fR server, with an internal RMI registry bound to port 2002, is running on the remote host\&. This example also uses the \f3-m\fR option to include the arguments passed to the \f3main\fR method of each of the listed Java applications\&. -.sp -.nf -\f3jps \-m remote\&.domain:2002\fP -.fi -.nf -\f33002 /opt/jdk1\&.7\&.0/demo/jfc/Java2D/Java2Demo\&.JAR\fP -.fi -.nf -\f33102 sun\&.tools\&.jstatd\&.jstatd \-p 2002\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH SEE\ ALSO -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -jstat(1) -.TP 0.2i -\(bu -jstatd(1) -.TP 0.2i -\(bu -rmiregistry(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Monitoring Tools +.\" Title: jps.1 +.\" +.if n .pl 99999 +.TH jps 1 "21 November 2013" "JDK 8" "Monitoring Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jps \- Lists the instrumented Java Virtual Machines (JVMs) on the target system\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjps\fR [ \fIoptions\fR ] [ \fIhostid\fR ] +.fi +.sp +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.TP +\fIhostid\fR +The identifier of the host for which the process report should be generated\&. The \f3hostid\fR can include optional components that indicate the communications protocol, port number, and other implementation specific data\&. See Host Identifier\&. +.SH DESCRIPTION +The \f3jps\fR command lists the instrumented Java HotSpot VMs on the target system\&. The command is limited to reporting information on JVMs for which it has the access permissions\&. +.PP +If the \f3jps\fR command is run without specifying a \f3hostid\fR, then it searches for instrumented JVMs on the local host\&. If started with a \f3hostid\fR, then it searches for JVMs on the indicated host, using the specified protocol and port\&. A \f3jstatd\fR process is assumed to be running on the target host\&. +.PP +The \f3jps\fR command reports the local JVM identifier, or \f3lvmid\fR, for each instrumented JVM found on the target system\&. The \f3lvmid\fR is typically, but not necessarily, the operating system\&'s process identifier for the JVM process\&. With no options, \f3jps\fR lists each Java application\&'s \f3lvmid\fR followed by the short form of the application\&'s class name or jar file name\&. The short form of the class name or JAR file name omits the class\&'s package information or the JAR files path information\&. +.PP +The \f3jps\fR command uses the Java launcher to find the class name and arguments passed to the main method\&. If the target JVM is started with a custom launcher, then the class or JAR file name and the arguments to the \f3main\fR method are not available\&. In this case, the \f3jps\fR command outputs the string \f3Unknown\fR for the class name or JAR file name and for the arguments to the \f3main\fR method\&. +.PP +The list of JVMs produced by the \f3jps\fR command can be limited by the permissions granted to the principal running the command\&. The command only lists the JVMs for which the principle has access rights as determined by operating system-specific access control mechanisms\&. +.SH OPTIONS +The \f3jps\fR command supports a number of options that modify the output of the command\&. These options are subject to change or removal in the future\&. +.TP +-q +.br +Suppresses the output of the class name, JAR file name, and arguments passed to the \f3main\fR method, producing only a list of local JVM identifiers\&. +.TP +-m +.br +Displays the arguments passed to the \f3main\fR method\&. The output may be \f3null\fR for embedded JVMs\&. +.TP +-l +.br +Displays the full package name for the application\&'s \f3main\fR class or the full path name to the application\&'s JAR file\&. +.TP +-v +.br +Displays the arguments passed to the JVM\&. +.TP +-V +.br +Suppresses the output of the class name, JAR file name, and arguments passed to the main method, producing only a list of local JVM identifiers\&. +.TP +-J\f3option\fR +.br +Passes \f3option\fR to the JVM, where option is one of the \f3options\fR described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH HOST\ IDENTIFIER +The host identifier, or \f3hostid\fR is a string that indicates the target system\&. The syntax of the \f3hostid\fR string corresponds to the syntax of a URI: +.sp +.nf +\f3[protocol:][[//]hostname][:port][/servername]\fP +.fi +.nf +\f3\fP +.fi +.sp +.TP +\fIprotocol\fR +The communications protocol\&. If the \f3protocol\fR is omitted and a \f3hostname\fR is not specified, then the default protocol is a platform-specific, optimized, local protocol\&. If the protocol is omitted and a host name is specified, then the default protocol is \f3rmi\fR\&. +.TP +hostname +A hostname or IP address that indicates the target host\&. If you omit the \f3hostname\fR parameter, then the target host is the local host\&. +.TP +port +The default port for communicating with the remote server\&. If the \f3hostname\fR parameter is omitted or the \f3protocol\fR parameter specifies an optimized, local protocol, then the \f3port\fR parameter is ignored\&. Otherwise, treatment of the \f3port\fR parameter is implementation specific\&. For the default \f3rmi\fR protocol, the \f3port\fR parameter indicates the port number for the rmiregistry on the remote host\&. If the \f3port\fR parameter is omitted, and the \f3protocol\fR parameter indicates \f3rmi\fR, then the default rmiregistry port (1099) is used\&. +.TP +servername +The treatment of this parameter depends on the implementation\&. For the optimized, local protocol, this field is ignored\&. For the \f3rmi\fR protocol, this parameter is a string that represents the name of the RMI remote object on the remote host\&. See the \f3jstatd\fR command \f3-n\fRoption for more information\&. +.SH OUTPUT\ FORMAT +The output of the \f3jps\fR command follows the following pattern: +.sp +.nf +\f3lvmid [ [ classname | JARfilename | "Unknown"] [ arg* ] [ jvmarg* ] ]\fP +.fi +.nf +\f3\fP +.fi +.sp +All output tokens are separated by white space\&. An \f3arg\fR value that includes embedded white space introduces ambiguity when attempting to map arguments to their actual positional parameters\&. +.PP +\fINote:\fR It is recommended that you do not write scripts to parse \f3jps\fR output because the format might change in future releases\&. If you write scripts that parse \f3jps\fR output, then expect to modify them for future releases of this tool\&. +.SH EXAMPLES +This section provides examples of the \f3jps\fR command\&. +.PP +List the instrumented JVMs on the local host: +.sp +.nf +\f3jps\fP +.fi +.nf +\f318027 Java2Demo\&.JAR\fP +.fi +.nf +\f318032 jps\fP +.fi +.nf +\f318005 jstat\fP +.fi +.nf +\f3\fP +.fi +.sp +The following example lists the instrumented JVMs on a remote host\&. This example assumes that the \f3jstat\fR server and either the its internal RMI registry or a separate external rmiregistry process are running on the remote host on the default port (port 1099)\&. It also assumes that the local host has appropriate permissions to access the remote host\&. This example also includes the \f3-l\fR option to output the long form of the class names or JAR file names\&. +.sp +.nf +\f3jps \-l remote\&.domain\fP +.fi +.nf +\f33002 /opt/jdk1\&.7\&.0/demo/jfc/Java2D/Java2Demo\&.JAR\fP +.fi +.nf +\f32857 sun\&.tools\&.jstatd\&.jstatd\fP +.fi +.nf +\f3\fP +.fi +.sp +The following example lists the instrumented JVMs on a remote host with a non-default port for the RMI registry\&. This example assumes that the \f3jstatd\fR server, with an internal RMI registry bound to port 2002, is running on the remote host\&. This example also uses the \f3-m\fR option to include the arguments passed to the \f3main\fR method of each of the listed Java applications\&. +.sp +.nf +\f3jps \-m remote\&.domain:2002\fP +.fi +.nf +\f33002 /opt/jdk1\&.7\&.0/demo/jfc/Java2D/Java2Demo\&.JAR\fP +.fi +.nf +\f33102 sun\&.tools\&.jstatd\&.jstatd \-p 2002\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jstat(1) +.TP 0.2i +\(bu +jstatd(1) +.TP 0.2i +\(bu +rmiregistry(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/jrunscript.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/jrunscript.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,195 +1,195 @@ -'\" t -.\" Copyright (c) 2006, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Scripting Tools -.\" Title: jrunscript.1 -.\" -.if n .pl 99999 -.TH jrunscript 1 "21 November 2013" "JDK 8" "Scripting Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jrunscript \- Runs a command-line script shell that supports interactive and batch modes\&. This command is experimental and unsupported\&. -.SH SYNOPSIS -.sp -.nf - -\fBjrunscript\fR [\fIoptions\fR] [\fIarguments\fR] -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIarguments\fR -Arguments, when used, follow immediately after options or the command name\&. See Arguments\&. -.SH DESCRIPTION -The \f3jrunscript\fR command is a language-independent command-line script shell\&. The \f3jrunscript\fR command supports both an interactive (read-eval-print) mode and a batch (\f3-f\fR option) mode of script execution\&. By default, JavaScript is the language used, but the \f3-l\fR option can be used to specify a different language\&. By using Java to scripting language communication, the \f3jrunscript\fR command supports an exploratory programming style\&. -.SH OPTIONS -.TP --classpath \fIpath\fR -.br -Indicate where any class files are that the script needs to access\&. -.TP --cp \fIpath\fR -.br -Same as \f3-classpath\fR\f3path\fR\&. -.TP --D\fIname\fR=\fIvalue\fR -.br -Sets a Java system property\&. -.TP --J\fIflag\fR -.br -Passes \f3flag\fR directly to the Java Virtual Machine where the \f3jrunscript\fR command is running\&. -.TP --I \fIlanguage\fR -.br -Uses the specified scripting language\&. By default, JavaScript is used\&. To use other scripting languages, you must specify the corresponding script engine\&'s JAR file with the \f3-cp\fR or \f3-classpath\fR option\&. -.TP --e \fIscript\fR -.br -Evaluates the specified script\&. This option can be used to run one-line scripts that are specified completely on the command line\&. -.TP --encoding \fIencoding\fR -.br -Specifies the character encoding used to read script files\&. -.TP --f \fIscript-file\fR -.br -Evaluates the specified script file (batch mode)\&. -.TP --f - -.br -Reads and evaluates a script from standard input (interactive mode)\&. -.TP --help -.br -Displays a help message and exits\&. -.TP --? -.br -Displays a help message and exits\&. -.TP --q -.br -Lists all script engines available and exits\&. -.SH ARGUMENTS -If arguments are present and if no \f3-e\fR or \f3-f\fR option is used, then the first argument is the script file and the rest of the arguments, if any, are passed to the script\&. If arguments and \f3-e\fR or the \f3-f\fR option are used, then all arguments are passed to the script\&. If arguments, \f3-e\fR and \f3-f\fR are missing, then interactive mode is used\&. Script arguments are available to a script in an engine variable named \f3arguments\fR of type \f3String\fR array\&. -.SH EXAMPLES -.SS EXECUTE\ INLINE\ SCRIPTS -.sp -.nf -\f3jrunscript \-e "print(\&'hello world\&')"\fP -.fi -.nf -\f3jrunscript \-e "cat(\&'http://www\&.example\&.com\&')"\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS USE\ SPECIFIED\ LANGUAGE\ AND\ EVALUATE\ THE\ SCRIPT\ FILE -.sp -.nf -\f3jrunscript \-l js \-f test\&.js\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS INTERACTIVE\ MODE -.sp -.nf -\f3jrunscript\fP -.fi -.nf -\f3js> print(\&'Hello World\en\&');\fP -.fi -.nf -\f3Hello World\fP -.fi -.nf -\f3js> 34 + 55\fP -.fi -.nf -\f389\&.0\fP -.fi -.nf -\f3js> t = new java\&.lang\&.Thread(function() { print(\&'Hello World\en\&'); })\fP -.fi -.nf -\f3Thread[Thread\-0,5,main]\fP -.fi -.nf -\f3js> t\&.start()\fP -.fi -.nf -\f3js> Hello World\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3js>\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS RUN\ SCRIPT\ FILE\ WITH\ SCRIPT\ ARGUMENTS -The test\&.js file is the script file\&. The \f3arg1\fR, \f3arg2\fR and \f3arg3\fR arguments are passed to the script\&. The script can access these arguments with an arguments array\&. -.sp -.nf -\f3jrunscript test\&.js arg1 arg2 arg3\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH SEE\ ALSO -If JavaScript is used, then before it evaluates a user defined script, the \f3jrunscript\fR command initializes certain built-in functions and objects\&. These JavaScript built-ins are documented in JsDoc-Toolkit at http://code\&.google\&.com/p/jsdoc-toolkit/ -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2006, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Scripting Tools +.\" Title: jrunscript.1 +.\" +.if n .pl 99999 +.TH jrunscript 1 "21 November 2013" "JDK 8" "Scripting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jrunscript \- Runs a command-line script shell that supports interactive and batch modes\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjrunscript\fR [\fIoptions\fR] [\fIarguments\fR] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIarguments\fR +Arguments, when used, follow immediately after options or the command name\&. See Arguments\&. +.SH DESCRIPTION +The \f3jrunscript\fR command is a language-independent command-line script shell\&. The \f3jrunscript\fR command supports both an interactive (read-eval-print) mode and a batch (\f3-f\fR option) mode of script execution\&. By default, JavaScript is the language used, but the \f3-l\fR option can be used to specify a different language\&. By using Java to scripting language communication, the \f3jrunscript\fR command supports an exploratory programming style\&. +.SH OPTIONS +.TP +-classpath \fIpath\fR +.br +Indicate where any class files are that the script needs to access\&. +.TP +-cp \fIpath\fR +.br +Same as \f3-classpath\fR\f3path\fR\&. +.TP +-D\fIname\fR=\fIvalue\fR +.br +Sets a Java system property\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR directly to the Java Virtual Machine where the \f3jrunscript\fR command is running\&. +.TP +-I \fIlanguage\fR +.br +Uses the specified scripting language\&. By default, JavaScript is used\&. To use other scripting languages, you must specify the corresponding script engine\&'s JAR file with the \f3-cp\fR or \f3-classpath\fR option\&. +.TP +-e \fIscript\fR +.br +Evaluates the specified script\&. This option can be used to run one-line scripts that are specified completely on the command line\&. +.TP +-encoding \fIencoding\fR +.br +Specifies the character encoding used to read script files\&. +.TP +-f \fIscript-file\fR +.br +Evaluates the specified script file (batch mode)\&. +.TP +-f - +.br +Reads and evaluates a script from standard input (interactive mode)\&. +.TP +-help +.br +Displays a help message and exits\&. +.TP +-? +.br +Displays a help message and exits\&. +.TP +-q +.br +Lists all script engines available and exits\&. +.SH ARGUMENTS +If arguments are present and if no \f3-e\fR or \f3-f\fR option is used, then the first argument is the script file and the rest of the arguments, if any, are passed to the script\&. If arguments and \f3-e\fR or the \f3-f\fR option are used, then all arguments are passed to the script\&. If arguments, \f3-e\fR and \f3-f\fR are missing, then interactive mode is used\&. Script arguments are available to a script in an engine variable named \f3arguments\fR of type \f3String\fR array\&. +.SH EXAMPLES +.SS EXECUTE\ INLINE\ SCRIPTS +.sp +.nf +\f3jrunscript \-e "print(\&'hello world\&')"\fP +.fi +.nf +\f3jrunscript \-e "cat(\&'http://www\&.example\&.com\&')"\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS USE\ SPECIFIED\ LANGUAGE\ AND\ EVALUATE\ THE\ SCRIPT\ FILE +.sp +.nf +\f3jrunscript \-l js \-f test\&.js\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS INTERACTIVE\ MODE +.sp +.nf +\f3jrunscript\fP +.fi +.nf +\f3js> print(\&'Hello World\en\&');\fP +.fi +.nf +\f3Hello World\fP +.fi +.nf +\f3js> 34 + 55\fP +.fi +.nf +\f389\&.0\fP +.fi +.nf +\f3js> t = new java\&.lang\&.Thread(function() { print(\&'Hello World\en\&'); })\fP +.fi +.nf +\f3Thread[Thread\-0,5,main]\fP +.fi +.nf +\f3js> t\&.start()\fP +.fi +.nf +\f3js> Hello World\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3js>\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS RUN\ SCRIPT\ FILE\ WITH\ SCRIPT\ ARGUMENTS +The test\&.js file is the script file\&. The \f3arg1\fR, \f3arg2\fR and \f3arg3\fR arguments are passed to the script\&. The script can access these arguments with an arguments array\&. +.sp +.nf +\f3jrunscript test\&.js arg1 arg2 arg3\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +If JavaScript is used, then before it evaluates a user defined script, the \f3jrunscript\fR command initializes certain built-in functions and objects\&. These JavaScript built-ins are documented in JsDoc-Toolkit at http://code\&.google\&.com/p/jsdoc-toolkit/ +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/jsadebugd.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/jsadebugd.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,108 +1,108 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Troubleshooting Tools -.\" Title: jsadebugd.1 -.\" -.if n .pl 99999 -.TH jsadebugd 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jsadebugd \- Attaches to a Java process or core file and acts as a debug server\&. This command is experimental and unsupported\&. -.SH SYNOPSIS -.sp -.nf - -\fBjsadebugd\fR \fIpid\fR [ \fIserver\-id\fR ] -.fi -.nf - -\fBjsadebugd\fR \fIexecutable\fR \fIcore\fR [ \fIserver\-id\fR ] -.fi -.sp -.TP -\fIpid\fR -The process ID of the process to which the debug server attaches\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. At most one instance of the debug server can be attached to a single process\&. -.TP -\fIexecutable\fR -The Java executable from which the core dump was produced\&. -.TP -\fIcore\fR -The core file to which the debug server should attach\&. -.TP -\fIserver-id\fR -An optional unique ID that is needed when multiple debug servers are started on the same machine\&. This ID must be used by remote clients to identify the particular debug server to which to attach\&. Within a single machine, this ID must be unique\&. -.SH DESCRIPTION -The \f3jsadebugd\fR command attaches to a Java process or core file and acts as a debug server\&. Remote clients such as \f3jstack\fR, \f3jmap\fR, and \f3jinfo\fR can attach to the server through Java Remote Method Invocation (RMI)\&. Before you start the \f3jsadebugd\fR command, start the RMI registry with the \f3rmiregistry\fR command as follows where \fI$JAVA_HOME\fR is the JDK installation directory: -.sp -.nf -\f3rmiregistry \-J\-Xbootclasspath/p:$JAVA_HOME/lib/sajdi\&.jar\fP -.fi -.nf -\f3\fP -.fi -.sp -If the RMI registry was not started, then the \f3jsadebugd\fR command starts an RMI registry in a standard (1099) port internally\&. The debug server can be stopped by sending a \f3SIGINT\fR to it\&. To send a SIGINT press \fICtrl+C\fR\&. -.PP -\fINote:\fR This utility is unsupported and may or may not be available in future releases of the JDK\&. In Windows Systems where \f3dbgeng\&.dll\fR is not present, Debugging Tools For Windows must be installed to have these tools working\&. The \f3PATH\fR environment variable should contain the location of jvm\&.dll used by the target process or the location from which the crash dump file was produced\&. For example, \f3s\fR\f3et PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -jinfo(1) -.TP 0.2i -\(bu -jmap(1) -.TP 0.2i -\(bu -jps(1) -.TP 0.2i -\(bu -jstack(1) -.TP 0.2i -\(bu -rmiregistry(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jsadebugd.1 +.\" +.if n .pl 99999 +.TH jsadebugd 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jsadebugd \- Attaches to a Java process or core file and acts as a debug server\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjsadebugd\fR \fIpid\fR [ \fIserver\-id\fR ] +.fi +.nf + +\fBjsadebugd\fR \fIexecutable\fR \fIcore\fR [ \fIserver\-id\fR ] +.fi +.sp +.TP +\fIpid\fR +The process ID of the process to which the debug server attaches\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. At most one instance of the debug server can be attached to a single process\&. +.TP +\fIexecutable\fR +The Java executable from which the core dump was produced\&. +.TP +\fIcore\fR +The core file to which the debug server should attach\&. +.TP +\fIserver-id\fR +An optional unique ID that is needed when multiple debug servers are started on the same machine\&. This ID must be used by remote clients to identify the particular debug server to which to attach\&. Within a single machine, this ID must be unique\&. +.SH DESCRIPTION +The \f3jsadebugd\fR command attaches to a Java process or core file and acts as a debug server\&. Remote clients such as \f3jstack\fR, \f3jmap\fR, and \f3jinfo\fR can attach to the server through Java Remote Method Invocation (RMI)\&. Before you start the \f3jsadebugd\fR command, start the RMI registry with the \f3rmiregistry\fR command as follows where \fI$JAVA_HOME\fR is the JDK installation directory: +.sp +.nf +\f3rmiregistry \-J\-Xbootclasspath/p:$JAVA_HOME/lib/sajdi\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +If the RMI registry was not started, then the \f3jsadebugd\fR command starts an RMI registry in a standard (1099) port internally\&. The debug server can be stopped by sending a \f3SIGINT\fR to it\&. To send a SIGINT press \fICtrl+C\fR\&. +.PP +\fINote:\fR This utility is unsupported and may or may not be available in future releases of the JDK\&. In Windows Systems where \f3dbgeng\&.dll\fR is not present, Debugging Tools For Windows must be installed to have these tools working\&. The \f3PATH\fR environment variable should contain the location of jvm\&.dll used by the target process or the location from which the crash dump file was produced\&. For example, \f3s\fR\f3et PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jinfo(1) +.TP 0.2i +\(bu +jmap(1) +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jstack(1) +.TP 0.2i +\(bu +rmiregistry(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/jstack.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/jstack.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,137 +1,137 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Troubleshooting Tools -.\" Title: jstack.1 -.\" -.if n .pl 99999 -.TH jstack 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jstack \- Prints Java thread stack traces for a Java process, core file, or remote debug server\&. This command is experimental and unsupported\&. -.SH SYNOPSIS -.sp -.nf - -\fBjstack\fR [ \fIoptions\fR ] \fIpid\fR -.fi -.nf - -\fBjstack\fR [ \fIoptions\fR ] \fIexecutable\fR \fIcore\fR -.fi -.nf - -\fBjstack\fR [ \fIoptions\fR ] [ \fIserver\-id\fR@ ] \fIremote\-hostname\-or\-IP\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIpid\fR -The process ID for which the stack trace is printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. -.TP -\fIexecutable\fR -The Java executable from which the core dump was produced\&. -.TP -\fIcore\fR -The core file for which the stack trace is to be printed\&. -.TP -\fIremote-hostname-or-IP\fR -The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. -.TP -\fIserver-id\fR -An optional unique ID to use when multiple debug servers are running on the same remote host\&. -.SH DESCRIPTION -The \f3jstack\fR command prints Java stack traces of Java threads for a specified Java process, core file, or remote debug server\&. For each Java frame, the full class name, method name, byte code index (BCI), and line number, when available, are printed\&. With the \f3-m\fR option, the \f3jstack\fR command prints both Java and native frames of all threads with the program counter (PC)\&. For each native frame, the closest native symbol to PC, when available, is printed\&. C++ mangled names are not demangled\&. To demangle C++ names, the output of this command can be piped to \f3c++filt\fR\&. When the specified process is running on a 64-bit Java Virtual Machine, you might need to specify the \f3-J-d64\fR option, for example: \f3jstack -J-d64 -m pid\fR\&. -.PP -\fINote:\fR This utility is unsupported and might not be available in future release of the JDK\&. In Windows Systems where the dbgeng\&.dll file is not present, Debugging Tools For Windows must be installed so these tools work\&. The \f3PATH\fR environment variable needs to contain the location of the jvm\&.dll that is used by the target process, or the location from which the crash dump file was produced\&. For example: -.sp -.nf -\f3set PATH=<jdk>\ejre\ebin\eclient;%PATH%\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH OPTIONS -.TP --F -.br -Force a stack dump when \f3jstack\fR [\f3-l\fR] \f3pid\fR does not respond\&. -.TP --l -.br -Long listing\&. Prints additional information about locks such as a list of owned \f3java\&.util\&.concurrent\fR ownable synchronizers\&. See the \f3AbstractOwnableSynchronizer\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/util/concurrent/locks/AbstractOwnableSynchronizer\&.html -.TP --m -.br -Prints a mixed mode stack trace that has both Java and native C/C++ frames\&. -.TP --h -.br -Prints a help message\&. -.TP --help -.br -Prints a help message\&. -.SH KNOWN\ BUGS -In mixed mode stack trace, the \f3-m\fR option does not work with the remote debug server\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -pstack(1) -.TP 0.2i -\(bu -C++filt(1) -.TP 0.2i -\(bu -jps(1) -.TP 0.2i -\(bu -jsadebugd(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jstack.1 +.\" +.if n .pl 99999 +.TH jstack 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jstack \- Prints Java thread stack traces for a Java process, core file, or remote debug server\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjstack\fR [ \fIoptions\fR ] \fIpid\fR +.fi +.nf + +\fBjstack\fR [ \fIoptions\fR ] \fIexecutable\fR \fIcore\fR +.fi +.nf + +\fBjstack\fR [ \fIoptions\fR ] [ \fIserver\-id\fR@ ] \fIremote\-hostname\-or\-IP\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIpid\fR +The process ID for which the stack trace is printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. +.TP +\fIexecutable\fR +The Java executable from which the core dump was produced\&. +.TP +\fIcore\fR +The core file for which the stack trace is to be printed\&. +.TP +\fIremote-hostname-or-IP\fR +The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. +.TP +\fIserver-id\fR +An optional unique ID to use when multiple debug servers are running on the same remote host\&. +.SH DESCRIPTION +The \f3jstack\fR command prints Java stack traces of Java threads for a specified Java process, core file, or remote debug server\&. For each Java frame, the full class name, method name, byte code index (BCI), and line number, when available, are printed\&. With the \f3-m\fR option, the \f3jstack\fR command prints both Java and native frames of all threads with the program counter (PC)\&. For each native frame, the closest native symbol to PC, when available, is printed\&. C++ mangled names are not demangled\&. To demangle C++ names, the output of this command can be piped to \f3c++filt\fR\&. When the specified process is running on a 64-bit Java Virtual Machine, you might need to specify the \f3-J-d64\fR option, for example: \f3jstack -J-d64 -m pid\fR\&. +.PP +\fINote:\fR This utility is unsupported and might not be available in future release of the JDK\&. In Windows Systems where the dbgeng\&.dll file is not present, Debugging Tools For Windows must be installed so these tools work\&. The \f3PATH\fR environment variable needs to contain the location of the jvm\&.dll that is used by the target process, or the location from which the crash dump file was produced\&. For example: +.sp +.nf +\f3set PATH=<jdk>\ejre\ebin\eclient;%PATH%\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-F +.br +Force a stack dump when \f3jstack\fR [\f3-l\fR] \f3pid\fR does not respond\&. +.TP +-l +.br +Long listing\&. Prints additional information about locks such as a list of owned \f3java\&.util\&.concurrent\fR ownable synchronizers\&. See the \f3AbstractOwnableSynchronizer\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/util/concurrent/locks/AbstractOwnableSynchronizer\&.html +.TP +-m +.br +Prints a mixed mode stack trace that has both Java and native C/C++ frames\&. +.TP +-h +.br +Prints a help message\&. +.TP +-help +.br +Prints a help message\&. +.SH KNOWN\ BUGS +In mixed mode stack trace, the \f3-m\fR option does not work with the remote debug server\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +pstack(1) +.TP 0.2i +\(bu +C++filt(1) +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jsadebugd(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/jstat.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/jstat.1 Wed Jul 15 12:12:46 2015 -0700 @@ -8,7 +8,7 @@ .\" .\" 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 +.\" 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). .\"
--- a/src/solaris/doc/sun/man/man1/jstatd.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/jstatd.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,209 +1,209 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Monitoring Tools -.\" Title: jstatd.1 -.\" -.if n .pl 99999 -.TH jstatd 1 "21 November 2013" "JDK 8" "Monitoring Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -jstatd \- Monitors Java Virtual Machines (JVMs) and enables remote monitoring tools to attach to JVMs\&. This command is experimental and unsupported\&. -.SH SYNOPSIS -.sp -.nf - -\fBjstatd\fR [ \fIoptions\fR ] -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.SH DESCRIPTION -The \f3jstatd\fR command is an RMI server application that monitors for the creation and termination of instrumented Java HotSpot VMs and provides an interface to enable remote monitoring tools to attach to JVMs that are running on the local host\&. -.PP -The \f3jstatd\fR server requires an RMI registry on the local host\&. The \f3jstatd\fR server attempts to attach to the RMI registry on the default port, or on the port you specify with the \f3-p\fR\f3port\fR option\&. If an RMI registry is not found, then one is created within the \f3jstatd\fR application that is bound to the port that is indicated by the \f3-p\fR\f3port\fR option or to the default RMI registry port when the \f3-p\fR\f3port\fR option is omitted\&. You can stop the creation of an internal RMI registry by specifying the \f3-nr\fR option\&. -.SH OPTIONS -.TP --nr -.br -Does not attempt to create an internal RMI registry within the \f3jstatd\fR process when an existing RMI registry is not found\&. -.TP --p \fIport\fR -.br -The port number where the RMI registry is expected to be found, or when not found, created if the \f3-nr\fR option is not specified\&. -.TP --n \fIrminame\fR -.br -Name to which the remote RMI object is bound in the RMI registry\&. The default name is \f3JStatRemoteHost\fR\&. If multiple \f3jstatd\fR servers are started on the same host, then the name of the exported RMI object for each server can be made unique by specifying this option\&. However, doing so requires that the unique server name be included in the monitoring client\&'s \f3hostid\fR and \f3vmid\fR strings\&. -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the JVM, where option is one of the \f3options\fR described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH SECURITY -The \f3jstatd\fR server can only monitor JVMs for which it has the appropriate native access permissions\&. Therefore, the \f3jstatd\fR process must be running with the same user credentials as the target JVMs\&. Some user credentials, such as the root user in UNIX-based systems, have permission to access the instrumentation exported by any JVM on the system\&. A \f3jstatd\fR process running with such credentials can monitor any JVM on the system, but introduces additional security concerns\&. -.PP -The \f3jstatd\fR server does not provide any authentication of remote clients\&. Therefore, running a \f3jstatd\fR server process exposes the instrumentation export by all JVMs for which the \f3jstatd\fR process has access permissions to any user on the network\&. This exposure might be undesirable in your environment, and therefore, local security policies should be considered before you start the \f3jstatd\fR process, particularly in production environments or on networks that are not secure\&. -.PP -The \f3jstatd\fR server installs an instance of \f3RMISecurityPolicy\fR when no other security manager is installed, and therefore, requires a security policy file to be specified\&. The policy file must conform to Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html -.PP -The following policy file allows the \f3jstatd\fR server to run without any security exceptions\&. This policy is less liberal than granting all permissions to all code bases, but is more liberal than a policy that grants the minimal permissions to run the \f3jstatd\fR server\&. -.sp -.nf -\f3grant codebase "file:${java\&.home}/\&.\&./lib/tools\&.jar" { \fP -.fi -.nf -\f3 permission java\&.security\&.AllPermission;\fP -.fi -.nf -\f3};\fP -.fi -.nf -\f3\fP -.fi -.sp -To use this policy setting, copy the text into a file called \f3jstatd\&.all\&.policy\fR and run the \f3jstatd\fR server as follows: -.sp -.nf -\f3jstatd \-J\-Djava\&.security\&.policy=jstatd\&.all\&.policy\fP -.fi -.nf -\f3\fP -.fi -.sp -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 address spoofing attacks\&. If your security concerns cannot be addressed with a customized policy file, then the safest action is to not run the \f3jstatd\fR server and use the \f3jstat\fR and \f3jps\fR tools locally\&. -.SH REMOTE\ INTERFACE -The interface exported by the \f3jstatd\fR process is proprietary and guaranteed to change\&. Users and developers are discouraged from writing to this interface\&. -.SH EXAMPLES -The following are examples of the \f3jstatd\fR command\&. The \f3jstatd\fR scripts automatically start the server in the background -.SS INTERNAL\ RMI\ REGISTRY -This example shows hos to start a \f3jstatd\fR session with an internal RMI registry\&. This example assumes that no other server is bound to the default RMI registry port (port 1099)\&. -.sp -.nf -\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS EXTERNAL\ RMI\ REGISTRY -This example starts a \f3jstatd\fR session with a external RMI registry\&. -.sp -.nf -\f3rmiregistry&\fP -.fi -.nf -\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP -.fi -.nf -\f3\fP -.fi -.sp -This example starts a \f3jstatd\fR session with an external RMI registry server on port 2020\&. -.sp -.nf -\f3jrmiregistry 2020&\fP -.fi -.nf -\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-p 2020\fP -.fi -.nf -\f3\fP -.fi -.sp -This example starts a \f3jstatd\fR session with an external RMI registry on port 2020 that is bound to \f3AlternateJstatdServerName\fR\&. -.sp -.nf -\f3rmiregistry 2020&\fP -.fi -.nf -\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-p 2020\fP -.fi -.nf -\f3 \-n AlternateJstatdServerName\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS STOP\ THE\ CREATION\ OF\ AN\ IN-PROCESS\ RMI\ REGISTRY -This example starts a \f3jstatd\fR session that does not create an RMI registry when one is not found\&. This example assumes an RMI registry is already running\&. If an RMI registry is not running, then an error message is displayed\&. -.sp -.nf -\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-nr\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS ENABLE\ RMI\ LOGGING -This example starts a \f3jstatd\fR session with RMI logging capabilities enabled\&. This technique is useful as a troubleshooting aid or for monitoring server activities\&. -.sp -.nf -\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP -.fi -.nf -\f3 \-J\-Djava\&.rmi\&.server\&.logCalls=true\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH SEE\ ALSO -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -jps(1) -.TP 0.2i -\(bu -jstat(1) -.TP 0.2i -\(bu -rmiregistry(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Monitoring Tools +.\" Title: jstatd.1 +.\" +.if n .pl 99999 +.TH jstatd 1 "21 November 2013" "JDK 8" "Monitoring Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jstatd \- Monitors Java Virtual Machines (JVMs) and enables remote monitoring tools to attach to JVMs\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjstatd\fR [ \fIoptions\fR ] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.SH DESCRIPTION +The \f3jstatd\fR command is an RMI server application that monitors for the creation and termination of instrumented Java HotSpot VMs and provides an interface to enable remote monitoring tools to attach to JVMs that are running on the local host\&. +.PP +The \f3jstatd\fR server requires an RMI registry on the local host\&. The \f3jstatd\fR server attempts to attach to the RMI registry on the default port, or on the port you specify with the \f3-p\fR\f3port\fR option\&. If an RMI registry is not found, then one is created within the \f3jstatd\fR application that is bound to the port that is indicated by the \f3-p\fR\f3port\fR option or to the default RMI registry port when the \f3-p\fR\f3port\fR option is omitted\&. You can stop the creation of an internal RMI registry by specifying the \f3-nr\fR option\&. +.SH OPTIONS +.TP +-nr +.br +Does not attempt to create an internal RMI registry within the \f3jstatd\fR process when an existing RMI registry is not found\&. +.TP +-p \fIport\fR +.br +The port number where the RMI registry is expected to be found, or when not found, created if the \f3-nr\fR option is not specified\&. +.TP +-n \fIrminame\fR +.br +Name to which the remote RMI object is bound in the RMI registry\&. The default name is \f3JStatRemoteHost\fR\&. If multiple \f3jstatd\fR servers are started on the same host, then the name of the exported RMI object for each server can be made unique by specifying this option\&. However, doing so requires that the unique server name be included in the monitoring client\&'s \f3hostid\fR and \f3vmid\fR strings\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the JVM, where option is one of the \f3options\fR described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH SECURITY +The \f3jstatd\fR server can only monitor JVMs for which it has the appropriate native access permissions\&. Therefore, the \f3jstatd\fR process must be running with the same user credentials as the target JVMs\&. Some user credentials, such as the root user in UNIX-based systems, have permission to access the instrumentation exported by any JVM on the system\&. A \f3jstatd\fR process running with such credentials can monitor any JVM on the system, but introduces additional security concerns\&. +.PP +The \f3jstatd\fR server does not provide any authentication of remote clients\&. Therefore, running a \f3jstatd\fR server process exposes the instrumentation export by all JVMs for which the \f3jstatd\fR process has access permissions to any user on the network\&. This exposure might be undesirable in your environment, and therefore, local security policies should be considered before you start the \f3jstatd\fR process, particularly in production environments or on networks that are not secure\&. +.PP +The \f3jstatd\fR server installs an instance of \f3RMISecurityPolicy\fR when no other security manager is installed, and therefore, requires a security policy file to be specified\&. The policy file must conform to Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html +.PP +The following policy file allows the \f3jstatd\fR server to run without any security exceptions\&. This policy is less liberal than granting all permissions to all code bases, but is more liberal than a policy that grants the minimal permissions to run the \f3jstatd\fR server\&. +.sp +.nf +\f3grant codebase "file:${java\&.home}/\&.\&./lib/tools\&.jar" { \fP +.fi +.nf +\f3 permission java\&.security\&.AllPermission;\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fP +.fi +.sp +To use this policy setting, copy the text into a file called \f3jstatd\&.all\&.policy\fR and run the \f3jstatd\fR server as follows: +.sp +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=jstatd\&.all\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp +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 address spoofing attacks\&. If your security concerns cannot be addressed with a customized policy file, then the safest action is to not run the \f3jstatd\fR server and use the \f3jstat\fR and \f3jps\fR tools locally\&. +.SH REMOTE\ INTERFACE +The interface exported by the \f3jstatd\fR process is proprietary and guaranteed to change\&. Users and developers are discouraged from writing to this interface\&. +.SH EXAMPLES +The following are examples of the \f3jstatd\fR command\&. The \f3jstatd\fR scripts automatically start the server in the background +.SS INTERNAL\ RMI\ REGISTRY +This example shows hos to start a \f3jstatd\fR session with an internal RMI registry\&. This example assumes that no other server is bound to the default RMI registry port (port 1099)\&. +.sp +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS EXTERNAL\ RMI\ REGISTRY +This example starts a \f3jstatd\fR session with a external RMI registry\&. +.sp +.nf +\f3rmiregistry&\fP +.fi +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp +This example starts a \f3jstatd\fR session with an external RMI registry server on port 2020\&. +.sp +.nf +\f3jrmiregistry 2020&\fP +.fi +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-p 2020\fP +.fi +.nf +\f3\fP +.fi +.sp +This example starts a \f3jstatd\fR session with an external RMI registry on port 2020 that is bound to \f3AlternateJstatdServerName\fR\&. +.sp +.nf +\f3rmiregistry 2020&\fP +.fi +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-p 2020\fP +.fi +.nf +\f3 \-n AlternateJstatdServerName\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS STOP\ THE\ CREATION\ OF\ AN\ IN-PROCESS\ RMI\ REGISTRY +This example starts a \f3jstatd\fR session that does not create an RMI registry when one is not found\&. This example assumes an RMI registry is already running\&. If an RMI registry is not running, then an error message is displayed\&. +.sp +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-nr\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS ENABLE\ RMI\ LOGGING +This example starts a \f3jstatd\fR session with RMI logging capabilities enabled\&. This technique is useful as a troubleshooting aid or for monitoring server activities\&. +.sp +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP +.fi +.nf +\f3 \-J\-Djava\&.rmi\&.server\&.logCalls=true\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jstat(1) +.TP 0.2i +\(bu +rmiregistry(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/keytool.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/keytool.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,1619 +1,1619 @@ -'\" t -.\" Copyright (c) 1998, 2015, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 03 March 2015 -.\" SectDesc: Security Tools -.\" Title: keytool.1 -.\" -.if n .pl 99999 -.TH keytool 1 "03 March 2015" "JDK 8" "Security Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -keytool \- Manages a keystore (database) of cryptographic keys, X\&.509 certificate chains, and trusted certificates\&. -.SH SYNOPSIS -.sp -.nf - -\fBkeytool\fR [\fIcommands\fR] -.fi -.sp -.TP -\fIcommands\fR -See Commands\&. These commands are categorized by task as follows: -.RS -.TP 0.2i -\(bu -Create or Add Data to the Keystore -.RS -.TP 0.2i -\(bu --gencert -.TP 0.2i -\(bu --genkeypair -.TP 0.2i -\(bu --genseckey -.TP 0.2i -\(bu --importcert -.TP 0.2i -\(bu --importpassword -.RE - -.TP 0.2i -\(bu -Import Contents From Another Keystore -.RS -.TP 0.2i -\(bu --importkeystore -.RE - -.TP 0.2i -\(bu -Generate Certificate Request -.RS -.TP 0.2i -\(bu --certreq -.RE - -.TP 0.2i -\(bu -Export Data -.RS -.TP 0.2i -\(bu --exportcert -.RE - -.TP 0.2i -\(bu -Display Data -.RS -.TP 0.2i -\(bu --list -.TP 0.2i -\(bu --printcert -.TP 0.2i -\(bu --printcertreq -.TP 0.2i -\(bu --printcrl -.RE - -.TP 0.2i -\(bu -Manage the Keystore -.RS -.TP 0.2i -\(bu --storepasswd -.TP 0.2i -\(bu --keypasswd -.TP 0.2i -\(bu --delete -.TP 0.2i -\(bu --changealias -.RE - -.TP 0.2i -\(bu -Get Help -.RS -.TP 0.2i -\(bu --help -.RE - -.RE - -.SH DESCRIPTION -The \f3keytool\fR command is a key and certificate management utility\&. It enables users to administer their own public/private key pairs and associated certificates for use in self-authentication (where the user authenticates himself or herself to other users and services) or data integrity and authentication services, using digital signatures\&. The \f3keytool\fR command also enables users to cache the public keys (in the form of certificates) of their communicating peers\&. -.PP -A certificate is a digitally signed statement from one entity (person, company, and so on\&.), that says that the public key (and some other information) of some other entity has a particular value\&. (See Certificate\&.) When data is digitally signed, the signature can be verified to check the data integrity and authenticity\&. Integrity means that the data has not been modified or tampered with, and authenticity means the data comes from whoever claims to have created and signed it\&. -.PP -The \f3keytool\fR command also enables users to administer secret keys and passphrases used in symmetric encryption and decryption (DES)\&. -.PP -The \f3keytool\fR command stores the keys and certificates in a keystore\&. See KeyStore aliases\&. -.SH COMMAND\ AND\ OPTION\ NOTES -See Commands for a listing and description of the various commands\&. -.TP 0.2i -\(bu -All command and option names are preceded by a minus sign (-)\&. -.TP 0.2i -\(bu -The options for each command can be provided in any order\&. -.TP 0.2i -\(bu -All items not italicized or in braces or brackets are required to appear as is\&. -.TP 0.2i -\(bu -Braces surrounding an option signify that a default value will be used when the option is not specified on the command line\&. See Option Defaults\&. Braces are also used around the \f3-v\fR, \f3-rfc\fR, and \f3-J\fR options, which only have meaning when they appear on the command line\&. They do not have any default values other than not existing\&. -.TP 0.2i -\(bu -Brackets surrounding an option signify that the user is prompted for the values when the option is not specified on the command line\&. For the \f3-keypass\fR option, if you do not specify the option on the command line, then the \f3keytool\fR command first attempts to use the keystore password to recover the private/secret key\&. If this attempt fails, then the \f3keytool\fR command prompts you for the private/secret key password\&. -.TP 0.2i -\(bu -Items in italics (option values) represent the actual values that must be supplied\&. For example, here is the format of the \f3-printcert\fR command: -.sp -.nf -\f3keytool \-printcert {\-file \fIcert_file\fR} {\-v}\fP -.fi -.sp - - - - -When you specify a \f3-printcert\fR command, replace \fIcert_file\fR with the actual file name, as follows: \f3keytool -printcert -file VScert\&.cer\fR -.TP 0.2i -\(bu -Option values must be put in quotation marks when they contain a blank (space)\&. -.TP 0.2i -\(bu -The \f3-help\fR option is the default\&. The \f3keytool\fR command is the same as \f3keytool -help\fR\&. -.SH OPTION\ DEFAULTS -The following examples show the defaults for various option values\&. -.sp -.nf -\f3\-alias "mykey"\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\-keyalg\fP -.fi -.nf -\f3 "DSA" (when using \-genkeypair)\fP -.fi -.nf -\f3 "DES" (when using \-genseckey)\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\-keysize\fP -.fi -.nf -\f3 2048 (when using \-genkeypair and \-keyalg is "RSA")\fP -.fi -.nf -\f3 1024 (when using \-genkeypair and \-keyalg is "DSA")\fP -.fi -.nf -\f3 256 (when using \-genkeypair and \-keyalg is "EC")\fP -.fi -.nf -\f3 56 (when using \-genseckey and \-keyalg is "DES")\fP -.fi -.nf -\f3 168 (when using \-genseckey and \-keyalg is "DESede")\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\-validity 90\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\-keystore <the file named \&.keystore in the user\&'s home directory>\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\-storetype <the value of the "keystore\&.type" property in the\fP -.fi -.nf -\f3 security properties file, which is returned by the static\fP -.fi -.nf -\f3 getDefaultType method in java\&.security\&.KeyStore>\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\-file\fP -.fi -.nf -\f3 stdin (if reading)\fP -.fi -.nf -\f3 stdout (if writing)\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\-protected false\fP -.fi -.nf -\f3\fP -.fi -.sp -In generating a public/private key pair, the signature algorithm (\f3-sigalg\fR option) is derived from the algorithm of the underlying private key: -.TP 0.2i -\(bu -If the underlying private key is of type DSA, then the \f3-sigalg\fR option defaults to SHA1withDSA\&. -.TP 0.2i -\(bu -If the underlying private key is of type RSA, then the \f3-sigalg\fR option defaults to SHA256withRSA\&. -.TP 0.2i -\(bu -If the underlying private key is of type EC, then the \f3-sigalg\fR option defaults to SHA256withECDSA\&. -.PP -For a full list of \f3-keyalg\fR and \f3-sigalg\fR arguments, see Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA -.SH COMMON\ OPTIONS -The \f3-v\fR option can appear for all commands except \f3-help\fR\&. When the \f3-v\fR option appears, it signifies verbose mode, which means that more information is provided in the output\&. -.PP -There is also a \f3-Jjavaoption\fR argument that can appear for any command\&. When the \f3-Jjavaoption\fR appears, the specified \f3javaoption\fR string is passed directly to the Java interpreter\&. This option does not contain any spaces\&. It is useful for adjusting the execution environment or memory usage\&. For a list of possible interpreter options, type \f3java -h\fR or \f3java -X\fR at the command line\&. -.PP -These options can appear for all commands operating on a keystore: -.TP --storetype \fIstoretype\fR -.br -This qualifier specifies the type of keystore to be instantiated\&. -.TP --keystore \fIkeystore\fR -.br -The keystore location\&. - -If the JKS \f3storetype\fR is used and a keystore file does not yet exist, then certain \f3keytool\fR commands can result in a new keystore file being created\&. For example, if \f3keytool -genkeypair\fR is called and the \f3-keystore\fR option is not specified, the default keystore file named \f3\&.keystore\fR in the user\&'s home directory is created when it does not already exist\&. Similarly, if the \f3-keystore ks_file\fR option is specified but ks_file does not exist, then it is created\&. For more information on the JKS \f3storetype\fR, see the \fIKeyStore Implementation\fR section in KeyStore aliases\&. - -Note that the input stream from the \f3-keystore\fR option is passed to the \f3KeyStore\&.load\fR method\&. If \f3NONE\fR is specified as the URL, then a null stream is passed to the \f3KeyStore\&.load\fR method\&. \f3NONE\fR should be specified if the keystore is not file-based\&. For example, when it resides on a hardware token device\&. -.TP --storepass[:\fIenv\fR| :\fIfile\fR] argument -.br -The password that is used to protect the integrity of the keystore\&. - -If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the \f3value\fR argument, which must be at least 6 characters long\&. Otherwise, the password is retrieved as follows: -.RS -.TP 0.2i -\(bu -\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. -.TP 0.2i -\(bu -\f3file\fR: Retrieve the password from the file named argument\&. -.RE - - -\fINote:\fR All other options that require passwords, such as \f3-keypass\fR, \f3-srckeypass\fR, -\f3destkeypass\fR, \f3-srcstorepass\fR, and \f3-deststorepass\fR, accept the \fIenv\fR and \fIfile\fR modifiers\&. Remember to separate the password option and the modifier with a colon (:)\&. - -The password must be provided to all commands that access the keystore contents\&. For such commands, when the \f3-storepass\fR option is not provided at the command line, the user is prompted for it\&. - -When retrieving information from the keystore, the password is optional\&. If no password is specified, then the integrity of the retrieved information cannot be verified and a warning is displayed\&. -.TP --providerName \fIprovider_name\fR -.br -Used to identify a cryptographic service provider\&'s name when listed in the security properties file\&. -.TP --providerClass \fIprovider_class_name\fR -.br -Used to specify the name of a cryptographic service provider\&'s master class file when the service provider is not listed in the security properties file\&. -.TP --providerArg \fIprovider_arg\fR -.br -Used with the \f3-providerClass\fR option to represent an optional string input argument for the constructor of \f3provider_class_name\fR\&. -.TP --protected -.br -Either \f3true\fR or \f3false\fR\&. This value should be specified as \f3true\fR when a password must be specified by way of a protected authentication path such as a dedicated PIN reader\&.Because there are two keystores involved in the \f3-importkeystore\fR command, the following two options \f3-srcprotected\fR and -\f3destprotected\fR are provided for the source keystore and the destination keystore respectively\&. -.TP --ext \fI{name{:critical} {=value}}\fR -.br -Denotes an X\&.509 certificate extension\&. The option can be used in \f3-genkeypair\fR and \f3-gencert\fR to embed extensions into the certificate generated, or in \f3-certreq\fR to show what extensions are requested in the certificate request\&. The option can appear multiple times\&. The \f3name\fR argument can be a supported extension name (see Named Extensions) or an arbitrary OID number\&. The \f3value\fR argument, when provided, denotes the argument for the extension\&. When \fIvalue\fR is omitted, that means that the default value of the extension or the extension requires no argument\&. The \f3:critical\fR modifier, when provided, means the extension\&'s \f3isCritical\fR attribute is \f3true\fR; otherwise, it is \f3false\fR\&. You can use \f3:c\fR in place of \f3:critical\fR\&. -.SH NAMED\ EXTENSIONS -The \f3keytool\fR command supports these named extensions\&. The names are not case-sensitive)\&. -.TP -BC or BasicContraints -\fIValues\fR: The full form is: \f3ca:{true|false}[,pathlen:<len>]\fR or \f3<len>\fR, which is short for \f3ca:true,pathlen:<len>\fR\&. When <\f3len\fR> is omitted, you have \f3ca:true\fR\&. -.TP -KU or KeyUsage -\fIValues\fR: \f3usage\fR(,\f3usage\fR)*, where \fIusage\fR can be one of \f3digitalSignature\fR, \f3nonRepudiation\fR (contentCommitment), \f3keyEncipherment\fR, \f3dataEncipherment\fR, \f3keyAgreement\fR, \f3keyCertSign\fR, \f3cRLSign\fR, \f3encipherOnly\fR, \f3decipherOnly\fR\&. The \fIusage\fR argument can be abbreviated with the first few letters (\f3dig\fR for \f3digitalSignature\fR) or in camel-case style (\f3dS\fR for \f3digitalSignature\fR or \f3cRLS\fR for \f3cRLSign\fR), as long as no ambiguity is found\&. The \f3usage\fR values are case-sensitive\&. -.TP -EKU or ExtendedKeyUsage -\fIValues\fR: \f3usage\fR(,\f3usage\fR)*, where \fIusage\fR can be one of \f3anyExtendedKeyUsage\fR, \f3serverAuth\fR, \f3clientAuth\fR, \f3codeSigning\fR, \f3emailProtection\fR, \f3timeStamping\fR, \f3OCSPSigning\fR, or any \fIOID string\fR\&. The \fIusage\fR argument can be abbreviated with the first few letters or in camel-case style, as long as no ambiguity is found\&. The \f3usage\fR values are case-sensitive\&. -.TP -SAN or SubjectAlternativeName -\fIValues\fR: \f3type\fR:\f3value\fR(,t\f3ype:value\fR)*, where \f3type\fR can be \f3EMAIL\fR, \f3URI\fR, \f3DNS\fR, \f3IP\fR, or \f3OID\fR\&. The \f3value\fR argument is the string format value for the \f3type\fR\&. -.TP -IAN or IssuerAlternativeName -\fIValues\fR: Same as \f3SubjectAlternativeName\fR\&. -.TP -SIA or SubjectInfoAccess -\fIValues\fR: \f3method\fR:\f3location-type\fR:\f3location-value\fR (,\f3method:location-type\fR:\f3location-value\fR)*, where \f3method\fR can be \f3timeStamping\fR, \f3caRepository\fR or any OID\&. The \f3location-type\fR and \f3location-value\fR arguments can be any \f3type\fR:\f3value\fR supported by the \f3SubjectAlternativeName\fR extension\&. -.TP -AIA or AuthorityInfoAccess -\fIValues\fR: Same as \f3SubjectInfoAccess\fR\&. The \f3method\fR argument can be \f3ocsp\fR,\f3caIssuers\fR, or any OID\&. -.PP -When \f3name\fR is OID, the value is the hexadecimal dumped DER encoding of the \f3extnValue\fR for the extension excluding the OCTET STRING type and length bytes\&. Any extra character other than standard hexadecimal numbers (0-9, a-f, A-F) are ignored in the HEX string\&. Therefore, both 01:02:03:04 and 01020304 are accepted as identical values\&. When there is no value, the extension has an empty value field\&. -.PP -A special name \f3honored\fR, used in \f3-gencert\fR only, denotes how the extensions included in the certificate request should be honored\&. The value for this name is a comma separated list of \f3all\fR (all requested extensions are honored), \f3name{:[critical|non-critical]}\fR (the named extension is honored, but using a different \f3isCritical\fR attribute) and \f3-name\fR (used with \f3all\fR, denotes an exception)\&. Requested extensions are not honored by default\&. -.PP -If, besides the\f3-ext honored\fR option, another named or OID \f3-ext\fR option is provided, this extension is added to those already honored\&. However, if this name (or OID) also appears in the honored value, then its value and criticality overrides the one in the request\&. -.PP -The \f3subjectKeyIdentifier\fR extension is always created\&. For non-self-signed certificates, the \f3authorityKeyIdentifier\fR is created\&. -.PP -\fINote:\fR Users should be aware that some combinations of extensions (and other certificate fields) may not conform to the Internet standard\&. See Certificate Conformance Warning\&. -.SH COMMANDS -.TP --gencert -.sp -.nf -\f3{\-rfc} {\-infile \fIinfile\fR} {\-outfile \fIoutfile\fR} {\-alias \fIalias\fR} {\-sigalg \fIsigalg\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-dname \fIdname\fR} {\-startdate \fIstartdate\fR {\-ext \fIext\fR}* {\-validity \fIvalDays\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-keypass \fIkeypass\fR] {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP -.fi -.sp -.sp -.nf -\f3{\-storetype \fIstoretype\fR} {\-providername \fIprovider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-v} {\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Generates a certificate as a response to a certificate request file (which can be created by the \f3keytool\fR\f3-certreq\fR command)\&. The command reads the request from \fIinfile\fR (if omitted, from the standard input), signs it using alias\&'s private key, and outputs the X\&.509 certificate into \fIoutfile\fR (if omitted, to the standard output)\&. When\f3-rfc\fR is specified, the output format is Base64-encoded PEM; otherwise, a binary DER is created\&. - -The \f3sigalg\fR value specifies the algorithm that should be used to sign the certificate\&. The \f3startdate\fR argument is the start time and date that the certificate is valid\&. The \f3valDays\fR argument tells the number of days for which the certificate should be considered valid\&. - -When \f3dname\fR is provided, it is used as the subject of the generated certificate\&. Otherwise, the one from the certificate request is used\&. - -The \f3ext\fR value shows what X\&.509 extensions will be embedded in the certificate\&. Read Common Options for the grammar of \f3-ext\fR\&. - -The \f3-gencert\fR option enables you to create certificate chains\&. The following example creates a certificate, \f3e1\fR, that contains three certificates in its certificate chain\&. - -The following commands creates four key pairs named \f3ca\fR, \f3ca1\fR, \f3ca2\fR, and \f3e1\fR: -.sp -.nf -\f3keytool \-alias ca \-dname CN=CA \-genkeypair\fP -.fi -.nf -\f3keytool \-alias ca1 \-dname CN=CA \-genkeypair\fP -.fi -.nf -\f3keytool \-alias ca2 \-dname CN=CA \-genkeypair\fP -.fi -.nf -\f3keytool \-alias e1 \-dname CN=E1 \-genkeypair\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The following two commands create a chain of signed certificates; \f3ca\fR signs \f3ca1\fR and \f3ca1\fR signs \f3ca2\fR, all of which are self-issued: -.sp -.nf -\f3keytool \-alias ca1 \-certreq |\fP -.fi -.nf -\f3 keytool \-alias ca \-gencert \-ext san=dns:ca1 |\fP -.fi -.nf -\f3 keytool \-alias ca1 \-importcert\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3keytool \-alias ca2 \-certreq |\fP -.fi -.nf -\f3 $KT \-alias ca1 \-gencert \-ext san=dns:ca2 |\fP -.fi -.nf -\f3 $KT \-alias ca2 \-importcert\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The following command creates the certificate \f3e1\fR and stores it in the file \f3e1\&.cert\fR, which is signed by \f3ca2\fR\&. As a result, \f3e1\fR should contain \f3ca\fR, \f3ca1\fR, and \f3ca2\fR in its certificate chain: -.sp -.nf -\f3keytool \-alias e1 \-certreq | keytool \-alias ca2 \-gencert > e1\&.cert\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --genkeypair -.sp -.nf -\f3{\-alias \fIalias\fR} {\-keyalg \fIkeyalg\fR} {\-keysize \fIkeysize\fR} {\-sigalg \fIsigalg\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-dname \fIdname\fR] [\-keypass \fIkeypass\fR] {\-startdate \fIvalue\fR} {\-ext \fIext\fR}*\fP -.fi -.sp -.sp -.nf -\f3{\-validity \fIvalDays\fR} {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-storepass \fIstorepass\fR]\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-v} {\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Generates a key pair (a public key and associated private key)\&. Wraps the public key into an X\&.509 v3 self-signed certificate, which is stored as a single-element certificate chain\&. This certificate chain and the private key are stored in a new keystore entry identified by alias\&. - -The \f3keyalg\fR value specifies the algorithm to be used to generate the key pair, and the \f3keysize\fR value specifies the size of each key to be generated\&. The \f3sigalg\fR value specifies the algorithm that should be used to sign the self-signed certificate\&. This algorithm must be compatible with the \f3keyalg\fR value\&. - -The \f3dname\fR value specifies the X\&.500 Distinguished Name to be associated with the value of \f3alias\fR, and is used as the issuer and subject fields in the self-signed certificate\&. If no distinguished name is provided at the command line, then the user is prompted for one\&. - -The value of \f3keypass\fR is a password used to protect the private key of the generated key pair\&. If no password is provided, then the user is prompted for it\&. If you press \fIthe Return key\fR at the prompt, then the key password is set to the same password as the keystore password\&. The \f3keypass\fR value must be at least 6 characters\&. - -The value of \f3startdate\fR specifies the issue time of the certificate, also known as the "Not Before" value of the X\&.509 certificate\&'s Validity field\&. - -The option value can be set in one of these two forms: - -\f3([+-]nnn[ymdHMS])+\fR - -\f3[yyyy/mm/dd] [HH:MM:SS]\fR - -With the first form, the issue time is shifted by the specified value from the current time\&. The value is a concatenation of a sequence of subvalues\&. Inside each subvalue, the plus sign (+) means shift forward, and the minus sign (-) means shift backward\&. The time to be shifted is \f3nnn\fR units of years, months, days, hours, minutes, or seconds (denoted by a single character of \f3y\fR, \f3m\fR, \f3d\fR, \f3H\fR, \f3M\fR, or \f3S\fR respectively)\&. The exact value of the issue time is calculated using the \f3java\&.util\&.GregorianCalendar\&.add(int field, int amount)\fR method on each subvalue, from left to right\&. For example, by specifying, the issue time will be: -.sp -.nf -\f3Calendar c = new GregorianCalendar();\fP -.fi -.nf -\f3c\&.add(Calendar\&.YEAR, \-1);\fP -.fi -.nf -\f3c\&.add(Calendar\&.MONTH, 1);\fP -.fi -.nf -\f3c\&.add(Calendar\&.DATE, \-1);\fP -.fi -.nf -\f3return c\&.getTime()\fP -.fi -.nf -\f3\fP -.fi -.sp - - -With the second form, the user sets the exact issue time in two parts, year/month/day and hour:minute:second (using the local time zone)\&. The user can provide only one part, which means the other part is the same as the current date (or time)\&. The user must provide the exact number of digits as shown in the format definition (padding with 0 when shorter)\&. When both the date and time are provided, there is one (and only one) space character between the two parts\&. The hour should always be provided in 24 hour format\&. - -When the option is not provided, the start date is the current time\&. The option can be provided at most once\&. - -The value of \f3valDays\fR specifies the number of days (starting at the date specified by \f3-startdate\fR, or the current date when \f3-startdate\fR is not specified) for which the certificate should be considered valid\&. - -This command was named \f3-genkey\fR in earlier releases\&. The old name is still supported in this release\&. The new name, \f3-genkeypair\fR, is preferred going forward\&. -.TP --genseckey -.sp -.nf -\f3{\-alias \fIalias\fR} {\-keyalg \fIkeyalg\fR} {\-keysize \fIkeysize\fR} [\-keypass \fIkeypass\fR]\fP -.fi -.sp -.sp -.nf -\f3{\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}} {\-v}\fP -.fi -.sp -.sp -.nf -\f3{\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Generates a secret key and stores it in a new \f3KeyStore\&.SecretKeyEntry\fR identified by \f3alias\fR\&. - -The value of \f3keyalg\fR specifies the algorithm to be used to generate the secret key, and the value of \f3keysize\fR specifies the size of the key to be generated\&. The \f3keypass\fR value is a password that protects the secret key\&. If no password is provided, then the user is prompted for it\&. If you press the Return key at the prompt, then the key password is set to the same password that is used for the \f3keystore\fR\&. The \f3keypass\fR value must be at least 6 characters\&. -.TP --importcert -.sp -.nf -\f3{\-alias \fIalias\fR} {\-file \fIcert_file\fR} [\-keypass \fIkeypass\fR] {\-noprompt} {\-trustcacerts}\fP -.fi -.sp -.sp -.nf -\f3{\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP -.fi -.sp -.sp -.nf -\f3{\-providerName \fIprovider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-v} {\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Reads the certificate or certificate chain (where the latter is supplied in a PKCS#7 formatted reply or a sequence of X\&.509 certificates) from the file \f3cert_file\fR, and stores it in the \f3keystore\fR entry identified by \f3alias\fR\&. If no file is specified, then the certificate or certificate chain is read from \f3stdin\fR\&. - -The \f3keytool\fR command can import X\&.509 v1, v2, and v3 certificates, and PKCS#7 formatted certificate chains consisting of certificates of that type\&. The data to be imported must be provided either in binary encoding format or in printable encoding format (also known as Base64 encoding) as defined by the Internet RFC 1421 standard\&. In the latter case, the encoding must be bounded at the beginning by a string that starts with \f3-\fR\f3----BEGIN\fR, and bounded at the end by a string that starts with \f3-----END\fR\&. - -You import a certificate for two reasons: To add it to the list of trusted certificates, and to import a certificate reply received from a certificate authority (CA) as the result of submitting a Certificate Signing Request to that CA (see the \f3-certreq\fR option in Commands)\&. - -Which type of import is intended is indicated by the value of the \f3-alias\fR option\&. If the alias does not point to a key entry, then the \f3keytool\fR command assumes you are adding a trusted certificate entry\&. In this case, the alias should not already exist in the keystore\&. If the alias does already exist, then the \f3keytool\fR command outputs an error because there is already a trusted certificate for that alias, and does not import the certificate\&. If the alias points to a key entry, then the \f3keytool\fR command assumes you are importing a certificate reply\&. -.TP --importpassword -.sp -.nf -\f3{\-alias \fIalias\fR} [\-keypass \fIkeypass\fR] {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-storepass \fIstorepass\fR]\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-v} {\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Imports a passphrase and stores it in a new \f3KeyStore\&.SecretKeyEntry\fR identified by \f3alias\fR\&. The passphrase may be supplied via the standard input stream; otherwise the user is prompted for it\&. \f3keypass\fR is a password used to protect the imported passphrase\&. If no password is provided, the user is prompted for it\&. If you press the Return key at the prompt, the key password is set to the same password as that used for the \f3keystore\fR\&. \f3keypass\fR must be at least 6 characters long\&. -.TP --importkeystore -.sp -.nf -\f3{\-srcstoretype \fIsrcstoretype\fR} {\-deststoretype \fIdeststoretype\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-srcstorepass \fIsrcstorepass\fR] [\-deststorepass \fIdeststorepass\fR] {\-srcprotected}\fP -.fi -.sp -.sp -.nf -\f3{\-destprotected} \fP -.fi -.sp -.sp -.nf -\f3{\-srcalias \fIsrcalias\fR {\-destalias \fIdestalias\fR} [\-srckeypass \fIsrckeypass\fR]} \fP -.fi -.sp -.sp -.nf -\f3[\-destkeypass \fIdestkeypass\fR] {\-noprompt}\fP -.fi -.sp -.sp -.nf -\f3{\-srcProviderName \fIsrc_provider_name\fR} {\-destProviderName \fIdest_provider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}} {\-v}\fP -.fi -.sp -.sp -.nf -\f3{\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Imports a single entry or all entries from a source keystore to a destination keystore\&. - -When the \f3-srcalias\fR option is provided, the command imports the single entry identified by the alias to the destination keystore\&. If a destination alias is not provided with \f3destalias\fR, then \f3srcalias\fR is used as the destination alias\&. If the source entry is protected by a password, then \f3srckeypass\fR is used to recover the entry\&. If \fIsrckeypass\fR is not provided, then the \f3keytool\fR command attempts to use \f3srcstorepass\fR to recover the entry\&. If \f3srcstorepass\fR is either not provided or is incorrect, then the user is prompted for a password\&. The destination entry is protected with \f3destkeypass\fR\&. If \f3destkeypass\fR is not provided, then the destination entry is protected with the source entry password\&. For example, most third-party tools require \f3storepass\fR and \f3keypass\fR in a PKCS #12 keystore to be the same\&. In order to create a PKCS #12 keystore for these tools, always specify a \f3-destkeypass\fR to be the same as \f3-deststorepass\fR\&. - -If the \f3-srcalias\fR option is not provided, then all entries in the source keystore are imported into the destination keystore\&. Each destination entry is stored under the alias from the source entry\&. If the source entry is protected by a password, then \f3srcstorepass\fR is used to recover the entry\&. If \f3srcstorepass\fR is either not provided or is incorrect, then the user is prompted for a password\&. If a source keystore entry type is not supported in the destination keystore, or if an error occurs while storing an entry into the destination keystore, then the user is prompted whether to skip the entry and continue or to quit\&. The destination entry is protected with the source entry password\&. - -If the destination alias already exists in the destination keystore, then the user is prompted to either overwrite the entry or to create a new entry under a different alias name\&. - -If the \f3-noprompt\fR option is provided, then the user is not prompted for a new destination alias\&. Existing entries are overwritten with the destination alias name\&. Entries that cannot be imported are skipped and a warning is displayed\&. -.TP --printcertreq -.sp -.nf -\f3{\-file \fIfile\fR}\fP -.fi -.sp - - -Prints the content of a PKCS #10 format certificate request, which can be generated by the \f3keytool\fR\f3-certreq\fR command\&. The command reads the request from file\&. If there is no file, then the request is read from the standard input\&. -.TP --certreq -.sp -.nf -\f3{\-alias \fIalias\fR} {\-dname \fIdname\fR} {\-sigalg \fIsigalg\fR} {\-file \fIcertreq_file\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-keypass \fIkeypass\fR] {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-v} {\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Generates a Certificate Signing Request (CSR) using the PKCS #10 format\&. - -A CSR is intended to be sent to a certificate authority (CA)\&. The CA authenticates the certificate requestor (usually off-line) and will return a certificate or certificate chain, used to replace the existing certificate chain (which initially consists of a self-signed certificate) in the keystore\&. - -The private key associated with alias is used to create the PKCS #10 certificate request\&. To access the private key, the correct password must be provided\&. If \f3keypass\fR is not provided at the command line and is different from the password used to protect the integrity of the keystore, then the user is prompted for it\&. If \f3dname\fR is provided, then it is used as the subject in the CSR\&. Otherwise, the X\&.500 Distinguished Name associated with alias is used\&. - -The \f3sigalg\fR value specifies the algorithm that should be used to sign the CSR\&. - -The CSR is stored in the file certreq_file\&. If no file is specified, then the CSR is output to \f3stdout\fR\&. - -Use the \f3importcert\fR command to import the response from the CA\&. -.TP --exportcert -.sp -.nf -\f3{\-alias \fIalias\fR} {\-file \fIcert_file\fR} {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-rfc} {\-v} {\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Reads from the keystore the certificate associated with \fIalias\fR and stores it in the cert_file file\&. When no file is specified, the certificate is output to \f3stdout\fR\&. - -The certificate is by default output in binary encoding\&. If the \f3-rfc\fR option is specified, then the output in the printable encoding format defined by the Internet RFC 1421 Certificate Encoding Standard\&. - -If \f3alias\fR refers to a trusted certificate, then that certificate is output\&. Otherwise, \f3alias\fR refers to a key entry with an associated certificate chain\&. In that case, the first certificate in the chain is returned\&. This certificate authenticates the public key of the entity addressed by \f3alias\fR\&. - -This command was named \f3-export\fR in earlier releases\&. The old name is still supported in this release\&. The new name, \f3-exportcert\fR, is preferred going forward\&. -.TP --list -.sp -.nf -\f3{\-alias \fIalias\fR} {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP -.fi -.sp -.sp -.nf -\f3{\-providerName \fIprovider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-v | \-rfc} {\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Prints to \f3stdout\fR the contents of the keystore entry identified by \f3alias\fR\&. If no \f3alias\fR is specified, then the contents of the entire keystore are printed\&. - -This command by default prints the SHA1 fingerprint of a certificate\&. If the \f3-v\fR option is specified, then the certificate is printed in human-readable format, with additional information such as the owner, issuer, serial number, and any extensions\&. If the \f3-rfc\fR option is specified, then the certificate contents are printed using the printable encoding format, as defined by the Internet RFC 1421 Certificate Encoding Standard\&. - -You cannot specify both \f3-v\fR and \f3-rfc\fR\&. -.TP --printcert -.sp -.nf -\f3{\-file \fIcert_file\fR | \-sslserver \fIhost\fR[:\fIport\fR]} {\-jarfile \fIJAR_file\fR {\-rfc} {\-v}\fP -.fi -.sp -.sp -.nf -\f3{\-Jjavaoption}\fP -.fi -.sp - - -Reads the certificate from the file cert_file, the SSL server located at host:port, or the signed JAR file \f3JAR_file\fR (with the \f3-jarfile\fR option and prints its contents in a human-readable format\&. When no port is specified, the standard HTTPS port 443 is assumed\&. Note that \f3-sslserver\fR and -file options cannot be provided at the same time\&. Otherwise, an error is reported\&. If neither option is specified, then the certificate is read from \f3stdin\fR\&. - -When\f3-rfc\fR is specified, the \f3keytool\fR command prints the certificate in PEM mode as defined by the Internet RFC 1421 Certificate Encoding standard\&. See Internet RFC 1421 Certificate Encoding Standard\&. - -If the certificate is read from a file or \f3stdin\fR, then it might be either binary encoded or in printable encoding format, as defined by the RFC 1421 Certificate Encoding standard\&. - -If the SSL server is behind a firewall, then the \f3-J-Dhttps\&.proxyHost=proxyhost\fR and \f3-J-Dhttps\&.proxyPort=proxyport\fR options can be specified on the command line for proxy tunneling\&. See Java Secure Socket Extension (JSSE) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide\&.html - -\fINote:\fR This option can be used independently of a keystore\&. -.TP --printcrl -.sp -.nf -\f3\-file \fIcrl_\fR {\-v}\fP -.fi -.sp - - -Reads the Certificate Revocation List (CRL) from the file \f3crl_\fR\&. A CRL is a list of digital certificates that were revoked by the CA that issued them\&. The CA generates the \f3crl_\fR file\&. - -\fINote:\fR This option can be used independently of a keystore\&. -.TP --storepasswd -.sp -.nf -\f3[\-new \fInew_storepass\fR] {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP -.fi -.sp -.sp -.nf -\f3[\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-v} {\-Jjavaoption}\fP -.fi -.sp - - -Changes the password used to protect the integrity of the keystore contents\&. The new password is \f3new_storepass\fR, which must be at least 6 characters\&. -.TP --keypasswd -.sp -.nf -\f3{\-alias \fIalias\fR} [\-keypass \fIold_keypass\fR] [\-new \fInew_keypass\fR] {\-storetype \fIstoretype\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}} {\-v}\fP -.fi -.sp -.sp -.nf -\f3{\-Jjavaoption}\fP -.fi -.sp - - -Changes the password under which the private/secret key identified by \f3alias\fR is protected, from \f3old_keypass\fR to \f3new_keypass\fR, which must be at least 6 characters\&. - -If the \f3-keypass\fR option is not provided at the command line, and the key password is different from the keystore password, then the user is prompted for it\&. - -If the \f3-new\fR option is not provided at the command line, then the user is prompted for it -.TP --delete -.sp -.nf -\f3[\-alias \fIalias\fR] {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP -.fi -.sp -.sp -.nf -\f3{\-providerName \fIprovider_name\fR} \fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP -.fi -.sp -.sp -.nf -\f3{\-v} {\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Deletes from the keystore the entry identified by \f3alias\fR\&. The user is prompted for the alias, when no alias is provided at the command line\&. -.TP --changealias -.sp -.nf -\f3{\-alias \fIalias\fR} [\-destalias \fIdestalias\fR] [\-keypass \fIkeypass\fR] {\-storetype \fIstoretype\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP -.fi -.sp -.sp -.nf -\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}} {\-v}\fP -.fi -.sp -.sp -.nf -\f3{\-protected} {\-Jjavaoption}\fP -.fi -.sp - - -Move an existing keystore entry from the specified \f3alias\fR to a new alias, \f3destalias\fR\&. If no destination alias is provided, then the command prompts for one\&. If the original entry is protected with an entry password, then the password can be supplied with the \f3-keypass\fR option\&. If no key password is provided, then the \f3storepass\fR (if provided) is attempted first\&. If the attempt fails, then the user is prompted for a password\&. -.TP --help -.br -Lists the basic commands and their options\&. - -For more information about a specific command, enter the following, where \f3command_name\fR is the name of the command: \f3keytool -command_name -help\fR\&. -.SH EXAMPLES -This example walks through the sequence of steps to create a keystore for managing public/private key pair and certificates from trusted entities\&. -.SS GENERATE\ THE\ KEY\ PAIR -First, create a keystore and generate the key pair\&. You can use a command such as the following typed as a single line: -.sp -.nf -\f3keytool \-genkeypair \-dname "cn=Mark Jones, ou=Java, o=Oracle, c=US"\fP -.fi -.nf -\f3 \-alias business \-keypass <new password for private key>\fP -.fi -.nf -\f3 \-keystore /working/mykeystore\fP -.fi -.nf -\f3 \-storepass <new password for keystore> \-validity 180\fP -.fi -.nf -\f3\fP -.fi -.sp -The command creates the keystore named \f3mykeystore\fR in the working directory (assuming it does not already exist), and assigns it the password specified by \f3<new password for keystore>\fR\&. It generates a public/private key pair for the entity whose distinguished name has a common name of Mark Jones, organizational unit of Java, organization of Oracle and two-letter country code of US\&. It uses the default DSA key generation algorithm to create the keys; both are 1024 bits\&. -.PP -The command uses the default SHA1withDSA signature algorithm to create a self-signed certificate that includes the public key and the distinguished name information\&. The certificate is valid for 180 days, and is associated with the private key in a keystore entry referred to by the alias \f3business\fR\&. The private key is assigned the password specified by \f3<new password for private key>\fR\&. -.PP -The command is significantly shorter when the option defaults are accepted\&. In this case, no options are required, and the defaults are used for unspecified options that have default values\&. You are prompted for any required values\&. You could have the following: -.sp -.nf -\f3keytool \-genkeypair\fP -.fi -.nf -\f3\fP -.fi -.sp -In this case, a keystore entry with the alias \f3mykey\fR is created, with a newly generated key pair and a certificate that is valid for 90 days\&. This entry is placed in the keystore named \f3\&.keystore\fR in your home directory\&. The keystore is created when it does not already exist\&. You are prompted for the distinguished name information, the keystore password, and the private key password\&. -.PP -The rest of the examples assume you executed the \f3-genkeypair\fR command without options specified, and that you responded to the prompts with values equal to those specified in the first \f3-genkeypair\fR command\&. For example, a distinguished name of \f3cn=Mark Jones\fR, \f3ou=Java\fR, \f3o=Oracle\fR, \f3c=US\fR)\&. -.SS REQUEST\ A\ SIGNED\ CERTIFICATE\ FROM\ A\ CA -Generating the key pair created a self-signed certificate\&. A certificate is more likely to be trusted by others when it is signed by a Certification Authority (CA)\&. To get a CA signature, first generate a Certificate Signing Request (CSR), as follows: -.sp -.nf -\f3keytool \-certreq \-file MarkJ\&.csr\fP -.fi -.nf -\f3\fP -.fi -.sp -This creates a CSR for the entity identified by the default alias \f3mykey\fR and puts the request in the file named MarkJ\&.csr\&. Submit this file to a CA, such as VeriSign\&. The CA authenticates you, the requestor (usually off-line), and returns a certificate, signed by them, authenticating your public key\&. In some cases, the CA returns a chain of certificates, each one authenticating the public key of the signer of the previous certificate in the chain\&. -.SS IMPORT\ A\ CERTIFICATE\ FOR\ THE\ CA -You now need to replace the self-signed certificate with a certificate chain, where each certificate in the chain authenticates the public key of the signer of the previous certificate in the chain, up to a root CA\&. -.PP -Before you import the certificate reply from a CA, you need one or more trusted certificates in your keystore or in the \f3cacerts\fR keystore file\&. See \f3-importcert\fR in Commands\&. -.TP 0.2i -\(bu -If the certificate reply is a certificate chain, then you need the top certificate of the chain\&. The root CA certificate that authenticates the public key of the CA\&. -.TP 0.2i -\(bu -If the certificate reply is a single certificate, then you need a certificate for the issuing CA (the one that signed it)\&. If that certificate is not self-signed, then you need a certificate for its signer, and so on, up to a self-signed root CA certificate\&. -.PP -The \f3cacerts\fR keystore file ships with several VeriSign root CA certificates, so you probably will not need to import a VeriSign certificate as a trusted certificate in your keystore\&. But if you request a signed certificate from a different CA, and a certificate authenticating that CA\&'s public key was not added to \f3cacerts\fR, then you must import a certificate from the CA as a trusted certificate\&. -.PP -A certificate from a CA is usually either self-signed or signed by another CA, in which case you need a certificate that authenticates that CA\&'s public key\&. Suppose company ABC, Inc\&., is a CA, and you obtain a file named A\f3BCCA\&.cer\fR that is supposed to be a self-signed certificate from ABC, that authenticates that CA\&'s public key\&. Be careful to ensure the certificate is valid before you import it as a trusted certificate\&. View it first with the \f3keytool -printcert\fR command or the \f3keytool -importcert\fR command without the \f3-noprompt\fR option, and make sure that the displayed certificate fingerprints match the expected ones\&. You can call the person who sent the certificate, and compare the fingerprints that you see with the ones that they show or that a secure public key repository shows\&. Only when the fingerprints are equal is it guaranteed that the certificate was not replaced in transit with somebody else\&'s (for example, an attacker\&'s) certificate\&. If such an attack takes place, and you did not check the certificate before you imported it, then you would be trusting anything the attacker has signed\&. -.PP -If you trust that the certificate is valid, then you can add it to your keystore with the following command: -.sp -.nf -\f3keytool \-importcert \-alias abc \-file ABCCA\&.cer\fP -.fi -.nf -\f3\fP -.fi -.sp -This command creates a trusted certificate entry in the keystore, with the data from the file ABCCA\&.cer, and assigns the alias \f3abc\fR to the entry\&. -.SS IMPORT\ THE\ CERTIFICATE\ REPLY\ FROM\ THE\ CA -After you import a certificate that authenticates the public key of the CA you submitted your certificate signing request to (or there is already such a certificate in the cacerts file), you can import the certificate reply and replace your self-signed certificate with a certificate chain\&. This chain is the one returned by the CA in response to your request (when the CA reply is a chain), or one constructed (when the CA reply is a single certificate) using the certificate reply and trusted certificates that are already available in the keystore where you import the reply or in the \f3cacerts\fR keystore file\&. -.PP -For example, if you sent your certificate signing request to VeriSign, then you can import the reply with the following, which assumes the returned certificate is named VSMarkJ\&.cer: -.sp -.nf -\f3keytool \-importcert \-trustcacerts \-file VSMarkJ\&.cer\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS EXPORT\ A\ CERTIFICATE\ THAT\ AUTHENTICATES\ THE\ PUBLIC\ KEY -If you used the \f3jarsigner\fR command to sign a Java Archive (JAR) file, then clients that want to use the file will want to authenticate your signature\&. One way the clients can authenticate you is by first importing your public key certificate into their keystore as a trusted entry\&. -.PP -You can export the certificate and supply it to your clients\&. As an example, you can copy your certificate to a file named MJ\&.cer with the following command that assumes the entry has an alias of \f3mykey\fR: -.sp -.nf -\f3keytool \-exportcert \-alias mykey \-file MJ\&.cer\fP -.fi -.nf -\f3\fP -.fi -.sp -With the certificate and the signed JAR file, a client can use the \f3jarsigner\fR command to authenticate your signature\&. -.SS IMPORT\ KEYSTORE -The command \f3importkeystore\fR is used to import an entire keystore into another keystore, which means all entries from the source keystore, including keys and certificates, are all imported to the destination keystore within a single command\&. You can use this command to import entries from a different type of keystore\&. During the import, all new entries in the destination keystore will have the same alias names and protection passwords (for secret keys and private keys)\&. If the \f3keytool\fR command cannot recover the private keys or secret keys from the source keystore, then it prompts you for a password\&. If it detects alias duplication, then it asks you for a new alias, and you can specify a new alias or simply allow the \f3keytool\fR command to overwrite the existing one\&. -.PP -For example, to import entries from a typical JKS type keystore key\&.jks into a PKCS #11 type hardware-based keystore, use the command: -.sp -.nf -\f3keytool \-importkeystore\fP -.fi -.nf -\f3 \-srckeystore key\&.jks \-destkeystore NONE\fP -.fi -.nf -\f3 \-srcstoretype JKS \-deststoretype PKCS11\fP -.fi -.nf -\f3 \-srcstorepass <src keystore password>\fP -.fi -.nf -\f3 \-deststorepass <destination keystore pwd>\fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3importkeystore\fR command can also be used to import a single entry from a source keystore to a destination keystore\&. In this case, besides the options you see in the previous example, you need to specify the alias you want to import\&. With the \f3-srcalias\fR option specified, you can also specify the destination alias name in the command line, as well as protection password for a secret/private key and the destination protection password you want\&. The following command demonstrates this: -.sp -.nf -\f3keytool \-importkeystore\fP -.fi -.nf -\f3 \-srckeystore key\&.jks \-destkeystore NONE\fP -.fi -.nf -\f3 \-srcstoretype JKS \-deststoretype PKCS11\fP -.fi -.nf -\f3 \-srcstorepass <src keystore password>\fP -.fi -.nf -\f3 \-deststorepass <destination keystore pwd>\fP -.fi -.nf -\f3 \-srcalias myprivatekey \-destalias myoldprivatekey\fP -.fi -.nf -\f3 \-srckeypass <source entry password>\fP -.fi -.nf -\f3 \-destkeypass <destination entry password>\fP -.fi -.nf -\f3 \-noprompt\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS GENERATE\ CERTIFICATES\ FOR\ AN\ SSL\ SERVER -The following are \f3keytool\fR commands to generate key pairs and certificates for three entities: Root CA (\f3root\fR), Intermediate CA (\f3ca\fR), and SSL server (\f3server\fR)\&. Ensure that you store all the certificates in the same keystore\&. In these examples, RSA is the recommended the key algorithm\&. -.sp -.nf -\f3keytool \-genkeypair \-keystore root\&.jks \-alias root \-ext bc:c\fP -.fi -.nf -\f3keytool \-genkeypair \-keystore ca\&.jks \-alias ca \-ext bc:c\fP -.fi -.nf -\f3keytool \-genkeypair \-keystore server\&.jks \-alias server\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3keytool \-keystore root\&.jks \-alias root \-exportcert \-rfc > root\&.pem\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3keytool \-storepass <storepass> \-keystore ca\&.jks \-certreq \-alias ca |\fP -.fi -.nf -\f3 keytool \-storepass <storepass> \-keystore root\&.jks\fP -.fi -.nf -\f3 \-gencert \-alias root \-ext BC=0 \-rfc > ca\&.pem\fP -.fi -.nf -\f3keytool \-keystore ca\&.jks \-importcert \-alias ca \-file ca\&.pem\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3keytool \-storepass <storepass> \-keystore server\&.jks \-certreq \-alias server |\fP -.fi -.nf -\f3 keytool \-storepass <storepass> \-keystore ca\&.jks \-gencert \-alias ca\fP -.fi -.nf -\f3 \-ext ku:c=dig,kE \-rfc > server\&.pem\fP -.fi -.nf -\f3cat root\&.pem ca\&.pem server\&.pem |\fP -.fi -.nf -\f3 keytool \-keystore server\&.jks \-importcert \-alias server\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH TERMS -.TP -Keystore -A keystore is a storage facility for cryptographic keys and certificates\&. -.TP -Keystore entries -Keystores can have different types of entries\&. The two most applicable entry types for the \f3keytool\fR command include the following: - -\fIKey entries\fR: Each entry holds very sensitive cryptographic key information, which is stored in a protected format to prevent unauthorized access\&. Typically, a key stored in this type of entry is a secret key, or a private key accompanied by the certificate chain for the corresponding public key\&. See Certificate Chains\&. The \f3keytool\fR command can handle both types of entries, while the \f3jarsigner\fR tool only handles the latter type of entry, that is private keys and their associated certificate chains\&. - -\fITrusted certificate entries\fR: Each entry contains a single public key certificate that belongs to another party\&. The entry is called a trusted certificate because the keystore owner trusts that the public key in the certificate belongs to the identity identified by the subject (owner) of the certificate\&. The issuer of the certificate vouches for this, by signing the certificate\&. -.TP -KeyStore aliases -All keystore entries (key and trusted certificate entries) are accessed by way of unique aliases\&. - -An alias is specified when you add an entity to the keystore with the \f3-genseckey\fR command to generate a secret key, the \f3-genkeypair\fR command to generate a key pair (public and private key), or the \f3-importcert\fR command to add a certificate or certificate chain to the list of trusted certificates\&. Subsequent \f3keytool\fR commands must use this same alias to refer to the entity\&. - -For example, you can use the alias \f3duke\fR to generate a new public/private key pair and wrap the public key into a self-signed certificate with the following command\&. See Certificate Chains\&. -.sp -.nf -\f3keytool \-genkeypair \-alias duke \-keypass dukekeypasswd\fP -.fi -.nf -\f3\fP -.fi -.sp - - -This example specifies an initial password of \f3dukekeypasswd\fR required by subsequent commands to access the private key associated with the alias \f3duke\fR\&. If you later want to change Duke\&'s private key password, use a command such as the following: -.sp -.nf -\f3keytool \-keypasswd \-alias duke \-keypass dukekeypasswd \-new newpass\fP -.fi -.nf -\f3\fP -.fi -.sp - - -This changes the password from \f3dukekeypasswd\fR to \f3newpass\fR\&. A password should not be specified on a command line or in a script unless it is for testing purposes, or you are on a secure system\&. If you do not specify a required password option on a command line, then you are prompted for it\&. -.TP -KeyStore implementation -The \f3KeyStore\fR class provided in the \f3java\&.security\fR 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 type of keystore\&. - -Currently, two command-line tools (\f3keytool\fR and \f3jarsigner\fR) and a GUI-based tool named Policy Tool make use of keystore implementations\&. Because the \f3KeyStore\fR class is \f3public\fR, users can write additional security applications that use it\&. - -There is a built-in default implementation, provided by Oracle\&. It implements the keystore as a file with a proprietary keystore type (format) named JKS\&. It protects each private key with its individual password, and also protects the integrity of the entire keystore with a (possibly different) password\&. - -Keystore implementations are provider-based\&. More specifically, the application interfaces supplied by \f3KeyStore\fR are implemented in terms of a Service Provider Interface (SPI)\&. That is, there is a corresponding abstract \f3KeystoreSpi\fR class, also in the \f3java\&.security package\fR, which defines the Service Provider Interface methods that providers must implement\&. The term \fIprovider\fR refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API\&. To provide a keystore implementation, clients must implement a provider and supply a \f3KeystoreSpi\fR subclass implementation, as described in How to Implement a Provider in the Java Cryptography Architecture at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/HowToImplAProvider\&.html - -Applications can choose different types of keystore implementations from different providers, using the \f3getInstance\fR factory method supplied in the \f3KeyStore\fR class\&. A keystore type defines the storage and data format of the keystore information, and the algorithms used to protect private/secret keys in the keystore and the integrity of the keystore\&. Keystore implementations of different types are not compatible\&. - -The \f3keytool\fR command works on any file-based keystore implementation\&. It treats the keystore location that is passed to it at the command line as a file name and converts it to a \f3FileInputStream\fR, from which it loads the keystore information\&.)The \f3jarsigner\fR and \f3policytool\fR commands can read a keystore from any location that can be specified with a URL\&. - -For \f3keytool\fR and \f3jarsigner\fR, you can specify a keystore type at the command line, with the \f3-storetype\fR option\&. For Policy Tool, you can specify a keystore type with the \fIKeystore\fR menu\&. - -If you do not explicitly specify a keystore type, then the tools choose a keystore implementation based on the value of the \f3keystore\&.type\fR property specified in the security properties file\&. The security properties file is called \f3java\&.security\fR, and resides in the security properties directory, \f3java\&.home\elib\esecurity\fR on Windows and \f3java\&.home/lib/security\fR on Oracle Solaris, where \f3java\&.home\fR is the runtime environment directory\&. The \f3jre\fR directory in the SDK or the top-level directory of the Java Runtime Environment (JRE)\&. - -Each tool gets the \f3keystore\&.type\fR value and then examines all the currently installed providers until it finds one that implements a keystores of that type\&. It then uses the keystore implementation from that provider\&.The \f3KeyStore\fR class defines a static method named \f3getDefaultType\fR that lets applications and applets retrieve the value of the \f3keystore\&.type\fR property\&. The following line of code creates an instance of the default keystore type as specified in the \f3keystore\&.type\fR property: -.sp -.nf -\f3KeyStore keyStore = KeyStore\&.getInstance(KeyStore\&.getDefaultType());\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The default keystore type is \f3jks\fR, which is the proprietary type of the keystore implementation provided by Oracle\&. This is specified by the following line in the security properties file: -.sp -.nf -\f3keystore\&.type=jks\fP -.fi -.nf -\f3\fP -.fi -.sp - - -To have the tools utilize a keystore implementation other than the default, you can change that line to specify a different keystore type\&. For example, if you have a provider package that supplies a keystore implementation for a keystore type called \f3pkcs12\fR, then change the line to the following: -.sp -.nf -\f3keystore\&.type=pkcs12\fP -.fi -.nf -\f3\fP -.fi -.sp - - -\fINote:\fR Case does not matter in keystore type designations\&. For example, JKS would be considered the same as jks\&. -.TP -Certificate -A certificate (or public-key certificate) is a digitally signed statement from one entity (the issuer), saying that the public key and some other information of another entity (the subject) has some specific value\&. The following terms are related to certificates: - -\fIPublic Keys\fR: These are numbers associated with a particular entity, and are intended to be known to everyone who needs to have trusted interactions with that entity\&. Public keys are used to verify signatures\&. - -\fIDigitally Signed\fR: If some data is digitally signed, then it is stored with the identity of an entity and a signature that proves that entity knows about the data\&. The data is rendered unforgeable by signing with the entity\&'s private key\&. - -\fIIdentity\fR: A known way of addressing an entity\&. In some systems, the identity is the public key, and in others it can be anything from an Oracle Solaris UID to an email address to an X\&.509 distinguished name\&. - -\fISignature\fR: A signature is computed over some data using the private key of an entity\&. The signer, which in the case of a certificate is also known as the issuer\&. - -\fIPrivate Keys\fR: These are numbers, each of which is supposed to be known only to the particular entity whose private key it is (that is, it is supposed to be kept secret)\&. Private and public keys exist in pairs in all public key cryptography systems (also referred to as public key crypto systems)\&. In a typical public key crypto system, such as DSA, a private key corresponds to exactly one public key\&. Private keys are used to compute signatures\&. - -\fIEntity\fR: An entity is a person, organization, program, computer, business, bank, or something else you are trusting to some degree\&. - -Public key cryptography requires access to users\&' public keys\&. In a large-scale networked environment, it is impossible to guarantee that prior relationships between communicating entities were established or that a trusted repository exists with all used public keys\&. Certificates were invented as a solution to this public key distribution problem\&. Now a Certification Authority (CA) can act as a trusted third party\&. CAs are entities such as businesses that are trusted to sign (issue) certificates for other entities\&. It is assumed that CAs only create valid and reliable certificates because they are bound by legal agreements\&. There are many public Certification Authorities, such as VeriSign, Thawte, Entrust, and so on\&. - -You can also run your own Certification Authority using products such as Microsoft Certificate Server or the Entrust CA product for your organization\&. With the \f3keytool\fR command, it is possible to display, import, and export certificates\&. It is also possible to generate self-signed certificates\&. - -The \f3keytool\fR command currently handles X\&.509 certificates\&. -.TP -X\&.509 Certificates -The X\&.509 standard defines what information can go into a certificate and describes how to write it down (the data format)\&. All the data in a certificate is encoded with two related standards called ASN\&.1/DER\&. Abstract Syntax Notation 1 describes data\&. The Definite Encoding Rules describe a single way to store and transfer that data\&. - -All X\&.509 certificates have the following data, in addition to the signature: - -\fIVersion\fR: This identifies which version of the X\&.509 standard applies to this certificate, which affects what information can be specified in it\&. Thus far, three versions are defined\&. The \f3keytool\fR command can import and export v1, v2, and v3 certificates\&. It generates v3 certificates\&. - -X\&.509 Version 1 has been available since 1988, is widely deployed, and is the most generic\&. - -X\&.509 Version 2 introduced the concept of subject and issuer unique identifiers to handle the possibility of reuse of subject or issuer names over time\&. Most certificate profile documents strongly recommend that names not be reused and that certificates should not make use of unique identifiers\&. Version 2 certificates are not widely used\&. - -X\&.509 Version 3 is the most recent (1996) and supports the notion of extensions where anyone can define an extension and include it in the certificate\&. Some common extensions are: KeyUsage (limits the use of the keys to particular purposes such as \f3signing-only\fR) and AlternativeNames (allows other identities to also be associated with this public key, for example\&. DNS names, email addresses, IP addresses)\&. Extensions can be marked critical to indicate that the extension should be checked and enforced or used\&. For example, if a certificate has the KeyUsage extension marked critical and set to \f3keyCertSign\fR, then when this certificate is presented during SSL communication, it should be rejected because the certificate extension indicates that the associated private key should only be used for signing certificates and not for SSL use\&. - -\fISerial number\fR: The entity that created the certificate is responsible for assigning it a serial number to distinguish it from other certificates it issues\&. This information is used in numerous ways\&. For example, when a certificate is revoked its serial number is placed in a Certificate Revocation List (CRL)\&. - -\fISignature algorithm identifier\fR: This identifies the algorithm used by the CA to sign the certificate\&. - -\fIIssuer name\fR: The X\&.500 Distinguished Name of the entity that signed the certificate\&. See X\&.500 Distinguished Names\&. This is typically a CA\&. Using this certificate implies trusting the entity that signed this certificate\&. In some cases, such as root or top-level CA certificates, the issuer signs its own certificate\&. - -\fIValidity period\fR: Each certificate is valid only for a limited amount of time\&. This period is described by a start date and time and an end date and time, and can be as short as a few seconds or almost as long as a century\&. The validity period chosen depends on a number of factors, such as the strength of the private key used to sign the certificate, or the amount one is willing to pay for a certificate\&. This is the expected period that entities can rely on the public value, when the associated private key has not been compromised\&. - -\fISubject name\fR: The name of the entity whose public key the certificate identifies\&. This name uses the X\&.500 standard, so it is intended to be unique across the Internet\&. This is the X\&.500 Distinguished Name (DN) of the entity\&. See X\&.500 Distinguished Names\&. For example, -.sp -.nf -\f3CN=Java Duke, OU=Java Software Division, O=Oracle Corporation, C=US\fP -.fi -.nf -\f3\fP -.fi -.sp - - -These refer to the subject\&'s common name (CN), organizational unit (OU), organization (O), and country (C)\&. - -\fISubject public key information\fR: This is the public key of the entity being named with an algorithm identifier that specifies which public key crypto system this key belongs to and any associated key parameters\&. -.TP -Certificate Chains -The \f3keytool\fR command can create and manage keystore key entries that each contain a private key and an associated certificate chain\&. The first certificate in the chain contains the public key that corresponds to the private key\&. - -When keys are first generated, the chain starts off containing a single element, a self-signed certificate\&. See \f3-genkeypair\fR in Commands\&. A self-signed certificate is one for which the issuer (signer) is the same as the subject\&. The subject is the entity whose public key is being authenticated by the certificate\&. Whenever the \f3-genkeypair\fR command is called to generate a new public/private key pair, it also wraps the public key into a self-signed certificate\&. - -Later, after a Certificate Signing Request (CSR) was generated with the \f3-certreq\fR command and sent to a Certification Authority (CA), the response from the CA is imported with \f3-importcert\fR, and the self-signed certificate is replaced by a chain of certificates\&. See the \f3-certreq\fR and \f3-importcert\fR options in Commands\&. At the bottom of the chain is the certificate (reply) issued by the CA authenticating the subject\&'s public key\&. The next certificate in the chain is one that authenticates the CA\&'s public key\&. - -In many cases, this is a self-signed certificate, which is a certificate from the CA authenticating its own public key, and the last certificate in the chain\&. In other cases, the CA might return a chain of certificates\&. In this case, the bottom certificate in the chain is the same (a certificate signed by the CA, authenticating the public key of the key entry), but the second certificate in the chain is a certificate signed by a different CA that authenticates the public key of the CA you sent the CSR to\&. The next certificate in the chain is a certificate that authenticates the second CA\&'s key, and so on, until a self-signed root certificate is reached\&. Each certificate in the chain (after the first) authenticates the public key of the signer of the previous certificate in the chain\&. - -Many CAs only return the issued certificate, with no supporting chain, especially when there is a flat hierarchy (no intermediates CAs)\&. In this case, the certificate chain must be established from trusted certificate information already stored in the keystore\&. - -A different reply format (defined by the PKCS #7 standard) includes the supporting certificate chain in addition to the issued certificate\&. Both reply formats can be handled by the \f3keytool\fR command\&. - -The top-level (root) CA certificate is self-signed\&. However, the trust into the root\&'s public key does not come from the root certificate itself, but from other sources such as a newspaper\&. This is because anybody could generate a self-signed certificate with the distinguished name of, for example, the VeriSign root CA\&. The root CA public key is widely known\&. The only reason it is stored in a certificate is because this is the format understood by most tools, so the certificate in this case is only used as a vehicle to transport the root CA\&'s public key\&. Before you add the root CA certificate to your keystore, you should view it with the \f3-printcert\fR option and compare the displayed fingerprint with the well-known fingerprint obtained from a newspaper, the root CA\&'s Web page, and so on\&. -.TP -The cacerts Certificates File -A certificates file named \f3cacerts\fR resides in the security properties directory, \f3java\&.home\elib\esecurity\fR on Windows and \f3java\&.home/lib/security\fR on Oracle Solaris, where \f3java\&.home\fR is the runtime environment\&'s directory, which would be the \f3jre\fR directory in the SDK or the top-level directory of the JRE\&. - -The \f3cacerts\fR file represents a system-wide keystore with CA certificates\&. System administrators can configure and manage that file with the \f3keytool\fR command by specifying \f3jks\fR as the keystore type\&. The \f3cacerts\fR keystore file ships with a default set of root CA certificates\&. You can list the default certificates with the following command: -.sp -.nf -\f3keytool \-list \-keystore java\&.home/lib/security/cacerts\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The initial password of the \f3cacerts\fR keystore file is \f3changeit\fR\&. System administrators should change that password and the default access permission of that file upon installing the SDK\&. - -\fINote:\fR It is important to verify your \f3cacerts\fR file\&. Because you trust the CAs in the \f3cacerts\fR file as entities for signing and issuing certificates to other entities, you must manage the \f3cacerts\fR file carefully\&. The \f3cacerts\fR file should contain only certificates of the CAs you trust\&. It is your responsibility to verify the trusted root CA certificates bundled in the \f3cacerts\fR file and make your own trust decisions\&. - -To remove an untrusted CA certificate from the \f3cacerts\fR file, use the \f3delete\fR option of the \f3keytool\fR command\&. You can find the \f3cacerts\fR file in the JRE installation directory\&. Contact your system administrator if you do not have permission to edit this file -.TP -Internet RFC 1421 Certificate Encoding Standard -Certificates are often stored using the printable encoding format defined by the Internet RFC 1421 standard, instead of their binary encoding\&. This certificate format, also known as Base64 encoding, makes it easy to export certificates to other applications by email or through some other mechanism\&. - -Certificates read by the \f3-importcert\fR and \f3-printcert\fR commands can be in either this format or binary encoded\&. The \f3-exportcert\fR command by default outputs a certificate in binary encoding, but will instead output a certificate in the printable encoding format, when the \f3-rfc\fR option is specified\&. - -The \f3-list\fR command by default prints the SHA1 fingerprint of a certificate\&. If the \f3-v\fR option is specified, then the certificate is printed in human-readable format\&. If the \f3-rfc\fR option is specified, then the certificate is output in the printable encoding format\&. - -In its printable encoding format, the encoded certificate is bounded at the beginning and end by the following text: -.sp -.nf -\f3\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3encoded certificate goes here\&. \fP -.fi -.nf -\f3\fP -.fi -.nf -\f3\-\-\-\-\-END CERTIFICATE\-\-\-\-\-\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP -X\&.500 Distinguished Names -X\&.500 Distinguished Names are used to identify entities, such as those that are named by the \f3subject\fR and \f3issuer\fR (signer) fields of X\&.509 certificates\&. The \f3keytool\fR command supports the following subparts: - -\fIcommonName\fR: The common name of a person such as Susan Jones\&. - -\fIorganizationUnit\fR: The small organization (such as department or division) name\&. For example, Purchasing\&. - -\fIlocalityName\fR: The locality (city) name, for example, Palo Alto\&. - -\fIstateName\fR: State or province name, for example, California\&. - -\fIcountry\fR: Two-letter country code, for example, CH\&. - -When you supply a distinguished name string as the value of a \f3-dname\fR option, such as for the \f3-genkeypair\fR command, the string must be in the following format: -.sp -.nf -\f3CN=cName, OU=orgUnit, O=org, L=city, S=state, C=countryCode\fP -.fi -.nf -\f3\fP -.fi -.sp - - -All the italicized items represent actual values and the previous keywords are abbreviations for the following: -.sp -.nf -\f3CN=commonName\fP -.fi -.nf -\f3OU=organizationUnit\fP -.fi -.nf -\f3O=organizationName\fP -.fi -.nf -\f3L=localityName\fP -.fi -.nf -\f3S=stateName\fP -.fi -.nf -\f3C=country\fP -.fi -.nf -\f3\fP -.fi -.sp - - -A sample distinguished name string is: -.sp -.nf -\f3CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino, S=California, C=US\fP -.fi -.nf -\f3\fP -.fi -.sp - - -A sample command using such a string is: -.sp -.nf -\f3keytool \-genkeypair \-dname "CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino,\fP -.fi -.nf -\f3S=California, C=US" \-alias mark\fP -.fi -.nf -\f3\fP -.fi -.sp - - -Case does not matter for the keyword abbreviations\&. For example, CN, cn, and Cn are all treated the same\&. - -Order matters; each subcomponent must appear in the designated order\&. However, it is not necessary to have all the subcomponents\&. You can use a subset, for example: -.sp -.nf -\f3CN=Steve Meier, OU=Java, O=Oracle, C=US\fP -.fi -.nf -\f3\fP -.fi -.sp - - -If a distinguished name string value contains a comma, then the comma must be escaped by a backslash (\e) character when you specify the string on a command line, as in: -.sp -.nf -\f3cn=Peter Schuster, ou=Java\e, Product Development, o=Oracle, c=US\fP -.fi -.nf -\f3\fP -.fi -.sp - - -It is never necessary to specify a distinguished name string on a command line\&. When the distinguished name is needed for a command, but not supplied on the command line, the user is prompted for each of the subcomponents\&. In this case, a comma does not need to be escaped by a backslash (\e)\&. -.SH WARNINGS -.SS IMPORTING\ TRUSTED\ CERTIFICATES\ WARNING -\fIImportant\fR: Be sure to check a certificate very carefully before importing it as a trusted certificate\&. -.PP -Windows Example: - -View the certificate first with the \f3-printcert\fR command or the \f3-importcert\fR command without the \f3-noprompt\fR option\&. Ensure that the displayed certificate fingerprints match the expected ones\&. For example, suppose sends or emails you a certificate that you put it in a file named \f3\etmp\ecert\fR\&. Before you consider adding the certificate to your list of trusted certificates, you can execute a \f3-printcert\fR command to view its fingerprints, as follows: -.sp -.nf -\f3 keytool \-printcert \-file \etmp\ecert\fP -.fi -.nf -\f3 Owner: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP -.fi -.nf -\f3 Issuer: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP -.fi -.nf -\f3 Serial Number: 59092b34\fP -.fi -.nf -\f3 Valid from: Thu Sep 25 18:01:13 PDT 1997 until: Wed Dec 24 17:01:13 PST 1997\fP -.fi -.nf -\f3 Certificate Fingerprints:\fP -.fi -.nf -\f3 MD5: 11:81:AD:92:C8:E5:0E:A2:01:2E:D4:7A:D7:5F:07:6F\fP -.fi -.nf -\f3 SHA1: 20:B6:17:FA:EF:E5:55:8A:D0:71:1F:E8:D6:9D:C0:37:13:0E:5E:FE\fP -.fi -.nf -\f3 SHA256: 90:7B:70:0A:EA:DC:16:79:92:99:41:FF:8A:FE:EB:90:\fP -.fi -.nf -\f3 17:75:E0:90:B2:24:4D:3A:2A:16:A6:E4:11:0F:67:A4\fP -.fi -.sp - -.PP -Oracle Solaris Example: - -View the certificate first with the \f3-printcert\fR command or the \f3-importcert\fR command without the \f3-noprompt\fR option\&. Ensure that the displayed certificate fingerprints match the expected ones\&. For example, suppose someone sends or emails you a certificate that you put it in a file named \f3/tmp/cert\fR\&. Before you consider adding the certificate to your list of trusted certificates, you can execute a \f3-printcert\fR command to view its fingerprints, as follows: -.sp -.nf -\f3 keytool \-printcert \-file /tmp/cert\fP -.fi -.nf -\f3 Owner: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP -.fi -.nf -\f3 Issuer: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP -.fi -.nf -\f3 Serial Number: 59092b34\fP -.fi -.nf -\f3 Valid from: Thu Sep 25 18:01:13 PDT 1997 until: Wed Dec 24 17:01:13 PST 1997\fP -.fi -.nf -\f3 Certificate Fingerprints:\fP -.fi -.nf -\f3 MD5: 11:81:AD:92:C8:E5:0E:A2:01:2E:D4:7A:D7:5F:07:6F\fP -.fi -.nf -\f3 SHA1: 20:B6:17:FA:EF:E5:55:8A:D0:71:1F:E8:D6:9D:C0:37:13:0E:5E:FE\fP -.fi -.nf -\f3 SHA256: 90:7B:70:0A:EA:DC:16:79:92:99:41:FF:8A:FE:EB:90:\fP -.fi -.nf -\f3 17:75:E0:90:B2:24:4D:3A:2A:16:A6:E4:11:0F:67:A4\fP -.fi -.nf -\f3\fP -.fi -.sp -Then call or otherwise contact the person who sent the certificate and compare the fingerprints that you see with the ones that they show\&. Only when the fingerprints are equal is it guaranteed that the certificate was not replaced in transit with somebody else\&'s certificate such as an attacker\&'s certificate\&. If such an attack took place, and you did not check the certificate before you imported it, then you would be trusting anything the attacker signed, for example, a JAR file with malicious class files inside\&. -.PP -\fINote:\fR It is not required that you execute a \f3-printcert\fR command before importing a certificate\&. This is because before you add a certificate to the list of trusted certificates in the keystore, the \f3-importcert\fR command prints out the certificate information and prompts you to verify it\&. You can then stop the import operation\&. However, you can do this only when you call the \f3-importcert\fR command without the \f3-noprompt\fR option\&. If the \f3-noprompt\fR option is specified, then there is no interaction with the user\&. -.SS PASSWORDS\ WARNING -Most commands that operate on a keystore require the store password\&. Some commands require a private/secret key password\&. Passwords can be specified on the command line in the \f3-storepass\fR and \f3-keypass\fR options\&. However, a password should not be specified on a command line or in a script unless it is for testing, or you are on a secure system\&. When you do not specify a required password option on a command line, you are prompted for it\&. -.SS CERTIFICATE\ CONFORMANCE\ WARNING -The Internet standard RFC 5280 has defined a profile on conforming X\&.509 certificates, which includes what values and value combinations are valid for certificate fields and extensions\&. See the standard at http://tools\&.ietf\&.org/rfc/rfc5280\&.txt -.PP -The \f3keytool\fR command does not enforce all of these rules so it can generate certificates that do not conform to the standard\&. Certificates that do not conform to the standard might be rejected by JRE or other applications\&. Users should ensure that they provide the correct options for \f3-dname\fR, \f3-ext\fR, and so on\&. -.SH NOTES -.SS IMPORT\ A\ NEW\ TRUSTED\ CERTIFICATE -Before you add the certificate to the keystore, the \f3keytool\fR command verifies it by attempting to construct a chain of trust from that certificate to a self-signed certificate (belonging to a root CA), using trusted certificates that are already available in the keystore\&. -.PP -If the \f3-trustcacerts\fR option was specified, then additional certificates are considered for the chain of trust, namely the certificates in a file named \f3cacerts\fR\&. -.PP -If the \f3keytool\fR command fails to establish a trust path from the certificate to be imported up to a self-signed certificate (either from the keystore or the \f3cacerts\fR file), then the certificate information is printed, and the user is prompted to verify it by comparing the displayed certificate fingerprints with the fingerprints obtained from some other (trusted) source of information, which might be the certificate owner\&. Be very careful to ensure the certificate is valid before importing it as a trusted certificate\&. See Importing Trusted Certificates Warning\&. The user then has the option of stopping the import operation\&. If the \f3-noprompt\fR option is specified, then there is no interaction with the user\&. -.SS IMPORT\ A\ CERTIFICATE\ REPLY -When you import a certificate reply, the certificate reply is validated with trusted certificates from the keystore, and optionally, the certificates configured in the \f3cacerts\fR keystore file when the \f3-trustcacert\fR\f3s\fR option is specified\&. See The cacerts Certificates File\&. -.PP -The methods of determining whether the certificate reply is trusted are as follows: -.TP 0.2i -\(bu -If the reply is a single X\&.509 certificate, then the \f3keytool\fR command attempts to establish a trust chain, starting at the certificate reply and ending at a self-signed certificate (belonging to a root CA)\&. The certificate reply and the hierarchy of certificates is used to authenticate the certificate reply from the new certificate chain of aliases\&. If a trust chain cannot be established, then the certificate reply is not imported\&. In this case, the \f3keytool\fR command does not print the certificate and prompt the user to verify it, because it is very difficult for a user to determine the authenticity of the certificate reply\&. -.TP 0.2i -\(bu -If the reply is a PKCS #7 formatted certificate chain or a sequence of X\&.509 certificates, then the chain is ordered with the user certificate first followed by zero or more CA certificates\&. If the chain ends with a self-signed root CA certificate and the\f3-trustcacerts\fR option was specified, the \f3keytool\fR command attempts to match it with any of the trusted certificates in the keystore or the \f3cacerts\fR keystore file\&. If the chain does not end with a self-signed root CA certificate and the \f3-trustcacerts\fR option was specified, the \f3keytool\fR command tries to find one from the trusted certificates in the keystore or the \f3cacerts\fR keystore file and add it to the end of the chain\&. If the certificate is not found and the \f3-noprompt\fR option is not specified, the information of the last certificate in the chain is printed, and the user is prompted to verify it\&. -.PP -If the public key in the certificate reply matches the user\&'s public key already stored with \f3alias\fR, then the old certificate chain is replaced with the new certificate chain in the reply\&. The old chain can only be replaced with a valid \f3keypass\fR, and so the password used to protect the private key of the entry is supplied\&. If no password is provided, and the private key password is different from the keystore password, the user is prompted for it\&. -.PP -This command was named \f3-import\fR in earlier releases\&. This old name is still supported in this release\&. The new name, \f3-importcert\fR, is preferred going forward\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -jar(1) -.TP 0.2i -\(bu -jarsigner(1) -.TP 0.2i -\(bu -Trail: Security Features in Java SE at http://docs\&.oracle\&.com/javase/tutorial/security/index\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1998, 2015, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 03 March 2015 +.\" SectDesc: Security Tools +.\" Title: keytool.1 +.\" +.if n .pl 99999 +.TH keytool 1 "03 March 2015" "JDK 8" "Security Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +keytool \- Manages a keystore (database) of cryptographic keys, X\&.509 certificate chains, and trusted certificates\&. +.SH SYNOPSIS +.sp +.nf + +\fBkeytool\fR [\fIcommands\fR] +.fi +.sp +.TP +\fIcommands\fR +See Commands\&. These commands are categorized by task as follows: +.RS +.TP 0.2i +\(bu +Create or Add Data to the Keystore +.RS +.TP 0.2i +\(bu +-gencert +.TP 0.2i +\(bu +-genkeypair +.TP 0.2i +\(bu +-genseckey +.TP 0.2i +\(bu +-importcert +.TP 0.2i +\(bu +-importpassword +.RE + +.TP 0.2i +\(bu +Import Contents From Another Keystore +.RS +.TP 0.2i +\(bu +-importkeystore +.RE + +.TP 0.2i +\(bu +Generate Certificate Request +.RS +.TP 0.2i +\(bu +-certreq +.RE + +.TP 0.2i +\(bu +Export Data +.RS +.TP 0.2i +\(bu +-exportcert +.RE + +.TP 0.2i +\(bu +Display Data +.RS +.TP 0.2i +\(bu +-list +.TP 0.2i +\(bu +-printcert +.TP 0.2i +\(bu +-printcertreq +.TP 0.2i +\(bu +-printcrl +.RE + +.TP 0.2i +\(bu +Manage the Keystore +.RS +.TP 0.2i +\(bu +-storepasswd +.TP 0.2i +\(bu +-keypasswd +.TP 0.2i +\(bu +-delete +.TP 0.2i +\(bu +-changealias +.RE + +.TP 0.2i +\(bu +Get Help +.RS +.TP 0.2i +\(bu +-help +.RE + +.RE + +.SH DESCRIPTION +The \f3keytool\fR command is a key and certificate management utility\&. It enables users to administer their own public/private key pairs and associated certificates for use in self-authentication (where the user authenticates himself or herself to other users and services) or data integrity and authentication services, using digital signatures\&. The \f3keytool\fR command also enables users to cache the public keys (in the form of certificates) of their communicating peers\&. +.PP +A certificate is a digitally signed statement from one entity (person, company, and so on\&.), that says that the public key (and some other information) of some other entity has a particular value\&. (See Certificate\&.) When data is digitally signed, the signature can be verified to check the data integrity and authenticity\&. Integrity means that the data has not been modified or tampered with, and authenticity means the data comes from whoever claims to have created and signed it\&. +.PP +The \f3keytool\fR command also enables users to administer secret keys and passphrases used in symmetric encryption and decryption (DES)\&. +.PP +The \f3keytool\fR command stores the keys and certificates in a keystore\&. See KeyStore aliases\&. +.SH COMMAND\ AND\ OPTION\ NOTES +See Commands for a listing and description of the various commands\&. +.TP 0.2i +\(bu +All command and option names are preceded by a minus sign (-)\&. +.TP 0.2i +\(bu +The options for each command can be provided in any order\&. +.TP 0.2i +\(bu +All items not italicized or in braces or brackets are required to appear as is\&. +.TP 0.2i +\(bu +Braces surrounding an option signify that a default value will be used when the option is not specified on the command line\&. See Option Defaults\&. Braces are also used around the \f3-v\fR, \f3-rfc\fR, and \f3-J\fR options, which only have meaning when they appear on the command line\&. They do not have any default values other than not existing\&. +.TP 0.2i +\(bu +Brackets surrounding an option signify that the user is prompted for the values when the option is not specified on the command line\&. For the \f3-keypass\fR option, if you do not specify the option on the command line, then the \f3keytool\fR command first attempts to use the keystore password to recover the private/secret key\&. If this attempt fails, then the \f3keytool\fR command prompts you for the private/secret key password\&. +.TP 0.2i +\(bu +Items in italics (option values) represent the actual values that must be supplied\&. For example, here is the format of the \f3-printcert\fR command: +.sp +.nf +\f3keytool \-printcert {\-file \fIcert_file\fR} {\-v}\fP +.fi +.sp + + + + +When you specify a \f3-printcert\fR command, replace \fIcert_file\fR with the actual file name, as follows: \f3keytool -printcert -file VScert\&.cer\fR +.TP 0.2i +\(bu +Option values must be put in quotation marks when they contain a blank (space)\&. +.TP 0.2i +\(bu +The \f3-help\fR option is the default\&. The \f3keytool\fR command is the same as \f3keytool -help\fR\&. +.SH OPTION\ DEFAULTS +The following examples show the defaults for various option values\&. +.sp +.nf +\f3\-alias "mykey"\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-keyalg\fP +.fi +.nf +\f3 "DSA" (when using \-genkeypair)\fP +.fi +.nf +\f3 "DES" (when using \-genseckey)\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-keysize\fP +.fi +.nf +\f3 2048 (when using \-genkeypair and \-keyalg is "RSA")\fP +.fi +.nf +\f3 1024 (when using \-genkeypair and \-keyalg is "DSA")\fP +.fi +.nf +\f3 256 (when using \-genkeypair and \-keyalg is "EC")\fP +.fi +.nf +\f3 56 (when using \-genseckey and \-keyalg is "DES")\fP +.fi +.nf +\f3 168 (when using \-genseckey and \-keyalg is "DESede")\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-validity 90\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-keystore <the file named \&.keystore in the user\&'s home directory>\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-storetype <the value of the "keystore\&.type" property in the\fP +.fi +.nf +\f3 security properties file, which is returned by the static\fP +.fi +.nf +\f3 getDefaultType method in java\&.security\&.KeyStore>\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-file\fP +.fi +.nf +\f3 stdin (if reading)\fP +.fi +.nf +\f3 stdout (if writing)\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-protected false\fP +.fi +.nf +\f3\fP +.fi +.sp +In generating a public/private key pair, the signature algorithm (\f3-sigalg\fR option) is derived from the algorithm of the underlying private key: +.TP 0.2i +\(bu +If the underlying private key is of type DSA, then the \f3-sigalg\fR option defaults to SHA1withDSA\&. +.TP 0.2i +\(bu +If the underlying private key is of type RSA, then the \f3-sigalg\fR option defaults to SHA256withRSA\&. +.TP 0.2i +\(bu +If the underlying private key is of type EC, then the \f3-sigalg\fR option defaults to SHA256withECDSA\&. +.PP +For a full list of \f3-keyalg\fR and \f3-sigalg\fR arguments, see Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA +.SH COMMON\ OPTIONS +The \f3-v\fR option can appear for all commands except \f3-help\fR\&. When the \f3-v\fR option appears, it signifies verbose mode, which means that more information is provided in the output\&. +.PP +There is also a \f3-Jjavaoption\fR argument that can appear for any command\&. When the \f3-Jjavaoption\fR appears, the specified \f3javaoption\fR string is passed directly to the Java interpreter\&. This option does not contain any spaces\&. It is useful for adjusting the execution environment or memory usage\&. For a list of possible interpreter options, type \f3java -h\fR or \f3java -X\fR at the command line\&. +.PP +These options can appear for all commands operating on a keystore: +.TP +-storetype \fIstoretype\fR +.br +This qualifier specifies the type of keystore to be instantiated\&. +.TP +-keystore \fIkeystore\fR +.br +The keystore location\&. + +If the JKS \f3storetype\fR is used and a keystore file does not yet exist, then certain \f3keytool\fR commands can result in a new keystore file being created\&. For example, if \f3keytool -genkeypair\fR is called and the \f3-keystore\fR option is not specified, the default keystore file named \f3\&.keystore\fR in the user\&'s home directory is created when it does not already exist\&. Similarly, if the \f3-keystore ks_file\fR option is specified but ks_file does not exist, then it is created\&. For more information on the JKS \f3storetype\fR, see the \fIKeyStore Implementation\fR section in KeyStore aliases\&. + +Note that the input stream from the \f3-keystore\fR option is passed to the \f3KeyStore\&.load\fR method\&. If \f3NONE\fR is specified as the URL, then a null stream is passed to the \f3KeyStore\&.load\fR method\&. \f3NONE\fR should be specified if the keystore is not file-based\&. For example, when it resides on a hardware token device\&. +.TP +-storepass[:\fIenv\fR| :\fIfile\fR] argument +.br +The password that is used to protect the integrity of the keystore\&. + +If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the \f3value\fR argument, which must be at least 6 characters long\&. Otherwise, the password is retrieved as follows: +.RS +.TP 0.2i +\(bu +\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. +.TP 0.2i +\(bu +\f3file\fR: Retrieve the password from the file named argument\&. +.RE + + +\fINote:\fR All other options that require passwords, such as \f3-keypass\fR, \f3-srckeypass\fR, -\f3destkeypass\fR, \f3-srcstorepass\fR, and \f3-deststorepass\fR, accept the \fIenv\fR and \fIfile\fR modifiers\&. Remember to separate the password option and the modifier with a colon (:)\&. + +The password must be provided to all commands that access the keystore contents\&. For such commands, when the \f3-storepass\fR option is not provided at the command line, the user is prompted for it\&. + +When retrieving information from the keystore, the password is optional\&. If no password is specified, then the integrity of the retrieved information cannot be verified and a warning is displayed\&. +.TP +-providerName \fIprovider_name\fR +.br +Used to identify a cryptographic service provider\&'s name when listed in the security properties file\&. +.TP +-providerClass \fIprovider_class_name\fR +.br +Used to specify the name of a cryptographic service provider\&'s master class file when the service provider is not listed in the security properties file\&. +.TP +-providerArg \fIprovider_arg\fR +.br +Used with the \f3-providerClass\fR option to represent an optional string input argument for the constructor of \f3provider_class_name\fR\&. +.TP +-protected +.br +Either \f3true\fR or \f3false\fR\&. This value should be specified as \f3true\fR when a password must be specified by way of a protected authentication path such as a dedicated PIN reader\&.Because there are two keystores involved in the \f3-importkeystore\fR command, the following two options \f3-srcprotected\fR and -\f3destprotected\fR are provided for the source keystore and the destination keystore respectively\&. +.TP +-ext \fI{name{:critical} {=value}}\fR +.br +Denotes an X\&.509 certificate extension\&. The option can be used in \f3-genkeypair\fR and \f3-gencert\fR to embed extensions into the certificate generated, or in \f3-certreq\fR to show what extensions are requested in the certificate request\&. The option can appear multiple times\&. The \f3name\fR argument can be a supported extension name (see Named Extensions) or an arbitrary OID number\&. The \f3value\fR argument, when provided, denotes the argument for the extension\&. When \fIvalue\fR is omitted, that means that the default value of the extension or the extension requires no argument\&. The \f3:critical\fR modifier, when provided, means the extension\&'s \f3isCritical\fR attribute is \f3true\fR; otherwise, it is \f3false\fR\&. You can use \f3:c\fR in place of \f3:critical\fR\&. +.SH NAMED\ EXTENSIONS +The \f3keytool\fR command supports these named extensions\&. The names are not case-sensitive)\&. +.TP +BC or BasicContraints +\fIValues\fR: The full form is: \f3ca:{true|false}[,pathlen:<len>]\fR or \f3<len>\fR, which is short for \f3ca:true,pathlen:<len>\fR\&. When <\f3len\fR> is omitted, you have \f3ca:true\fR\&. +.TP +KU or KeyUsage +\fIValues\fR: \f3usage\fR(,\f3usage\fR)*, where \fIusage\fR can be one of \f3digitalSignature\fR, \f3nonRepudiation\fR (contentCommitment), \f3keyEncipherment\fR, \f3dataEncipherment\fR, \f3keyAgreement\fR, \f3keyCertSign\fR, \f3cRLSign\fR, \f3encipherOnly\fR, \f3decipherOnly\fR\&. The \fIusage\fR argument can be abbreviated with the first few letters (\f3dig\fR for \f3digitalSignature\fR) or in camel-case style (\f3dS\fR for \f3digitalSignature\fR or \f3cRLS\fR for \f3cRLSign\fR), as long as no ambiguity is found\&. The \f3usage\fR values are case-sensitive\&. +.TP +EKU or ExtendedKeyUsage +\fIValues\fR: \f3usage\fR(,\f3usage\fR)*, where \fIusage\fR can be one of \f3anyExtendedKeyUsage\fR, \f3serverAuth\fR, \f3clientAuth\fR, \f3codeSigning\fR, \f3emailProtection\fR, \f3timeStamping\fR, \f3OCSPSigning\fR, or any \fIOID string\fR\&. The \fIusage\fR argument can be abbreviated with the first few letters or in camel-case style, as long as no ambiguity is found\&. The \f3usage\fR values are case-sensitive\&. +.TP +SAN or SubjectAlternativeName +\fIValues\fR: \f3type\fR:\f3value\fR(,t\f3ype:value\fR)*, where \f3type\fR can be \f3EMAIL\fR, \f3URI\fR, \f3DNS\fR, \f3IP\fR, or \f3OID\fR\&. The \f3value\fR argument is the string format value for the \f3type\fR\&. +.TP +IAN or IssuerAlternativeName +\fIValues\fR: Same as \f3SubjectAlternativeName\fR\&. +.TP +SIA or SubjectInfoAccess +\fIValues\fR: \f3method\fR:\f3location-type\fR:\f3location-value\fR (,\f3method:location-type\fR:\f3location-value\fR)*, where \f3method\fR can be \f3timeStamping\fR, \f3caRepository\fR or any OID\&. The \f3location-type\fR and \f3location-value\fR arguments can be any \f3type\fR:\f3value\fR supported by the \f3SubjectAlternativeName\fR extension\&. +.TP +AIA or AuthorityInfoAccess +\fIValues\fR: Same as \f3SubjectInfoAccess\fR\&. The \f3method\fR argument can be \f3ocsp\fR,\f3caIssuers\fR, or any OID\&. +.PP +When \f3name\fR is OID, the value is the hexadecimal dumped DER encoding of the \f3extnValue\fR for the extension excluding the OCTET STRING type and length bytes\&. Any extra character other than standard hexadecimal numbers (0-9, a-f, A-F) are ignored in the HEX string\&. Therefore, both 01:02:03:04 and 01020304 are accepted as identical values\&. When there is no value, the extension has an empty value field\&. +.PP +A special name \f3honored\fR, used in \f3-gencert\fR only, denotes how the extensions included in the certificate request should be honored\&. The value for this name is a comma separated list of \f3all\fR (all requested extensions are honored), \f3name{:[critical|non-critical]}\fR (the named extension is honored, but using a different \f3isCritical\fR attribute) and \f3-name\fR (used with \f3all\fR, denotes an exception)\&. Requested extensions are not honored by default\&. +.PP +If, besides the\f3-ext honored\fR option, another named or OID \f3-ext\fR option is provided, this extension is added to those already honored\&. However, if this name (or OID) also appears in the honored value, then its value and criticality overrides the one in the request\&. +.PP +The \f3subjectKeyIdentifier\fR extension is always created\&. For non-self-signed certificates, the \f3authorityKeyIdentifier\fR is created\&. +.PP +\fINote:\fR Users should be aware that some combinations of extensions (and other certificate fields) may not conform to the Internet standard\&. See Certificate Conformance Warning\&. +.SH COMMANDS +.TP +-gencert +.sp +.nf +\f3{\-rfc} {\-infile \fIinfile\fR} {\-outfile \fIoutfile\fR} {\-alias \fIalias\fR} {\-sigalg \fIsigalg\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-dname \fIdname\fR} {\-startdate \fIstartdate\fR {\-ext \fIext\fR}* {\-validity \fIvalDays\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-keypass \fIkeypass\fR] {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP +.fi +.sp +.sp +.nf +\f3{\-storetype \fIstoretype\fR} {\-providername \fIprovider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-v} {\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Generates a certificate as a response to a certificate request file (which can be created by the \f3keytool\fR\f3-certreq\fR command)\&. The command reads the request from \fIinfile\fR (if omitted, from the standard input), signs it using alias\&'s private key, and outputs the X\&.509 certificate into \fIoutfile\fR (if omitted, to the standard output)\&. When\f3-rfc\fR is specified, the output format is Base64-encoded PEM; otherwise, a binary DER is created\&. + +The \f3sigalg\fR value specifies the algorithm that should be used to sign the certificate\&. The \f3startdate\fR argument is the start time and date that the certificate is valid\&. The \f3valDays\fR argument tells the number of days for which the certificate should be considered valid\&. + +When \f3dname\fR is provided, it is used as the subject of the generated certificate\&. Otherwise, the one from the certificate request is used\&. + +The \f3ext\fR value shows what X\&.509 extensions will be embedded in the certificate\&. Read Common Options for the grammar of \f3-ext\fR\&. + +The \f3-gencert\fR option enables you to create certificate chains\&. The following example creates a certificate, \f3e1\fR, that contains three certificates in its certificate chain\&. + +The following commands creates four key pairs named \f3ca\fR, \f3ca1\fR, \f3ca2\fR, and \f3e1\fR: +.sp +.nf +\f3keytool \-alias ca \-dname CN=CA \-genkeypair\fP +.fi +.nf +\f3keytool \-alias ca1 \-dname CN=CA \-genkeypair\fP +.fi +.nf +\f3keytool \-alias ca2 \-dname CN=CA \-genkeypair\fP +.fi +.nf +\f3keytool \-alias e1 \-dname CN=E1 \-genkeypair\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following two commands create a chain of signed certificates; \f3ca\fR signs \f3ca1\fR and \f3ca1\fR signs \f3ca2\fR, all of which are self-issued: +.sp +.nf +\f3keytool \-alias ca1 \-certreq |\fP +.fi +.nf +\f3 keytool \-alias ca \-gencert \-ext san=dns:ca1 |\fP +.fi +.nf +\f3 keytool \-alias ca1 \-importcert\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3keytool \-alias ca2 \-certreq |\fP +.fi +.nf +\f3 $KT \-alias ca1 \-gencert \-ext san=dns:ca2 |\fP +.fi +.nf +\f3 $KT \-alias ca2 \-importcert\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following command creates the certificate \f3e1\fR and stores it in the file \f3e1\&.cert\fR, which is signed by \f3ca2\fR\&. As a result, \f3e1\fR should contain \f3ca\fR, \f3ca1\fR, and \f3ca2\fR in its certificate chain: +.sp +.nf +\f3keytool \-alias e1 \-certreq | keytool \-alias ca2 \-gencert > e1\&.cert\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-genkeypair +.sp +.nf +\f3{\-alias \fIalias\fR} {\-keyalg \fIkeyalg\fR} {\-keysize \fIkeysize\fR} {\-sigalg \fIsigalg\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-dname \fIdname\fR] [\-keypass \fIkeypass\fR] {\-startdate \fIvalue\fR} {\-ext \fIext\fR}*\fP +.fi +.sp +.sp +.nf +\f3{\-validity \fIvalDays\fR} {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-storepass \fIstorepass\fR]\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-v} {\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Generates a key pair (a public key and associated private key)\&. Wraps the public key into an X\&.509 v3 self-signed certificate, which is stored as a single-element certificate chain\&. This certificate chain and the private key are stored in a new keystore entry identified by alias\&. + +The \f3keyalg\fR value specifies the algorithm to be used to generate the key pair, and the \f3keysize\fR value specifies the size of each key to be generated\&. The \f3sigalg\fR value specifies the algorithm that should be used to sign the self-signed certificate\&. This algorithm must be compatible with the \f3keyalg\fR value\&. + +The \f3dname\fR value specifies the X\&.500 Distinguished Name to be associated with the value of \f3alias\fR, and is used as the issuer and subject fields in the self-signed certificate\&. If no distinguished name is provided at the command line, then the user is prompted for one\&. + +The value of \f3keypass\fR is a password used to protect the private key of the generated key pair\&. If no password is provided, then the user is prompted for it\&. If you press \fIthe Return key\fR at the prompt, then the key password is set to the same password as the keystore password\&. The \f3keypass\fR value must be at least 6 characters\&. + +The value of \f3startdate\fR specifies the issue time of the certificate, also known as the "Not Before" value of the X\&.509 certificate\&'s Validity field\&. + +The option value can be set in one of these two forms: + +\f3([+-]nnn[ymdHMS])+\fR + +\f3[yyyy/mm/dd] [HH:MM:SS]\fR + +With the first form, the issue time is shifted by the specified value from the current time\&. The value is a concatenation of a sequence of subvalues\&. Inside each subvalue, the plus sign (+) means shift forward, and the minus sign (-) means shift backward\&. The time to be shifted is \f3nnn\fR units of years, months, days, hours, minutes, or seconds (denoted by a single character of \f3y\fR, \f3m\fR, \f3d\fR, \f3H\fR, \f3M\fR, or \f3S\fR respectively)\&. The exact value of the issue time is calculated using the \f3java\&.util\&.GregorianCalendar\&.add(int field, int amount)\fR method on each subvalue, from left to right\&. For example, by specifying, the issue time will be: +.sp +.nf +\f3Calendar c = new GregorianCalendar();\fP +.fi +.nf +\f3c\&.add(Calendar\&.YEAR, \-1);\fP +.fi +.nf +\f3c\&.add(Calendar\&.MONTH, 1);\fP +.fi +.nf +\f3c\&.add(Calendar\&.DATE, \-1);\fP +.fi +.nf +\f3return c\&.getTime()\fP +.fi +.nf +\f3\fP +.fi +.sp + + +With the second form, the user sets the exact issue time in two parts, year/month/day and hour:minute:second (using the local time zone)\&. The user can provide only one part, which means the other part is the same as the current date (or time)\&. The user must provide the exact number of digits as shown in the format definition (padding with 0 when shorter)\&. When both the date and time are provided, there is one (and only one) space character between the two parts\&. The hour should always be provided in 24 hour format\&. + +When the option is not provided, the start date is the current time\&. The option can be provided at most once\&. + +The value of \f3valDays\fR specifies the number of days (starting at the date specified by \f3-startdate\fR, or the current date when \f3-startdate\fR is not specified) for which the certificate should be considered valid\&. + +This command was named \f3-genkey\fR in earlier releases\&. The old name is still supported in this release\&. The new name, \f3-genkeypair\fR, is preferred going forward\&. +.TP +-genseckey +.sp +.nf +\f3{\-alias \fIalias\fR} {\-keyalg \fIkeyalg\fR} {\-keysize \fIkeysize\fR} [\-keypass \fIkeypass\fR]\fP +.fi +.sp +.sp +.nf +\f3{\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}} {\-v}\fP +.fi +.sp +.sp +.nf +\f3{\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Generates a secret key and stores it in a new \f3KeyStore\&.SecretKeyEntry\fR identified by \f3alias\fR\&. + +The value of \f3keyalg\fR specifies the algorithm to be used to generate the secret key, and the value of \f3keysize\fR specifies the size of the key to be generated\&. The \f3keypass\fR value is a password that protects the secret key\&. If no password is provided, then the user is prompted for it\&. If you press the Return key at the prompt, then the key password is set to the same password that is used for the \f3keystore\fR\&. The \f3keypass\fR value must be at least 6 characters\&. +.TP +-importcert +.sp +.nf +\f3{\-alias \fIalias\fR} {\-file \fIcert_file\fR} [\-keypass \fIkeypass\fR] {\-noprompt} {\-trustcacerts}\fP +.fi +.sp +.sp +.nf +\f3{\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP +.fi +.sp +.sp +.nf +\f3{\-providerName \fIprovider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-v} {\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Reads the certificate or certificate chain (where the latter is supplied in a PKCS#7 formatted reply or a sequence of X\&.509 certificates) from the file \f3cert_file\fR, and stores it in the \f3keystore\fR entry identified by \f3alias\fR\&. If no file is specified, then the certificate or certificate chain is read from \f3stdin\fR\&. + +The \f3keytool\fR command can import X\&.509 v1, v2, and v3 certificates, and PKCS#7 formatted certificate chains consisting of certificates of that type\&. The data to be imported must be provided either in binary encoding format or in printable encoding format (also known as Base64 encoding) as defined by the Internet RFC 1421 standard\&. In the latter case, the encoding must be bounded at the beginning by a string that starts with \f3-\fR\f3----BEGIN\fR, and bounded at the end by a string that starts with \f3-----END\fR\&. + +You import a certificate for two reasons: To add it to the list of trusted certificates, and to import a certificate reply received from a certificate authority (CA) as the result of submitting a Certificate Signing Request to that CA (see the \f3-certreq\fR option in Commands)\&. + +Which type of import is intended is indicated by the value of the \f3-alias\fR option\&. If the alias does not point to a key entry, then the \f3keytool\fR command assumes you are adding a trusted certificate entry\&. In this case, the alias should not already exist in the keystore\&. If the alias does already exist, then the \f3keytool\fR command outputs an error because there is already a trusted certificate for that alias, and does not import the certificate\&. If the alias points to a key entry, then the \f3keytool\fR command assumes you are importing a certificate reply\&. +.TP +-importpassword +.sp +.nf +\f3{\-alias \fIalias\fR} [\-keypass \fIkeypass\fR] {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-storepass \fIstorepass\fR]\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-v} {\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Imports a passphrase and stores it in a new \f3KeyStore\&.SecretKeyEntry\fR identified by \f3alias\fR\&. The passphrase may be supplied via the standard input stream; otherwise the user is prompted for it\&. \f3keypass\fR is a password used to protect the imported passphrase\&. If no password is provided, the user is prompted for it\&. If you press the Return key at the prompt, the key password is set to the same password as that used for the \f3keystore\fR\&. \f3keypass\fR must be at least 6 characters long\&. +.TP +-importkeystore +.sp +.nf +\f3{\-srcstoretype \fIsrcstoretype\fR} {\-deststoretype \fIdeststoretype\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-srcstorepass \fIsrcstorepass\fR] [\-deststorepass \fIdeststorepass\fR] {\-srcprotected}\fP +.fi +.sp +.sp +.nf +\f3{\-destprotected} \fP +.fi +.sp +.sp +.nf +\f3{\-srcalias \fIsrcalias\fR {\-destalias \fIdestalias\fR} [\-srckeypass \fIsrckeypass\fR]} \fP +.fi +.sp +.sp +.nf +\f3[\-destkeypass \fIdestkeypass\fR] {\-noprompt}\fP +.fi +.sp +.sp +.nf +\f3{\-srcProviderName \fIsrc_provider_name\fR} {\-destProviderName \fIdest_provider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}} {\-v}\fP +.fi +.sp +.sp +.nf +\f3{\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Imports a single entry or all entries from a source keystore to a destination keystore\&. + +When the \f3-srcalias\fR option is provided, the command imports the single entry identified by the alias to the destination keystore\&. If a destination alias is not provided with \f3destalias\fR, then \f3srcalias\fR is used as the destination alias\&. If the source entry is protected by a password, then \f3srckeypass\fR is used to recover the entry\&. If \fIsrckeypass\fR is not provided, then the \f3keytool\fR command attempts to use \f3srcstorepass\fR to recover the entry\&. If \f3srcstorepass\fR is either not provided or is incorrect, then the user is prompted for a password\&. The destination entry is protected with \f3destkeypass\fR\&. If \f3destkeypass\fR is not provided, then the destination entry is protected with the source entry password\&. For example, most third-party tools require \f3storepass\fR and \f3keypass\fR in a PKCS #12 keystore to be the same\&. In order to create a PKCS #12 keystore for these tools, always specify a \f3-destkeypass\fR to be the same as \f3-deststorepass\fR\&. + +If the \f3-srcalias\fR option is not provided, then all entries in the source keystore are imported into the destination keystore\&. Each destination entry is stored under the alias from the source entry\&. If the source entry is protected by a password, then \f3srcstorepass\fR is used to recover the entry\&. If \f3srcstorepass\fR is either not provided or is incorrect, then the user is prompted for a password\&. If a source keystore entry type is not supported in the destination keystore, or if an error occurs while storing an entry into the destination keystore, then the user is prompted whether to skip the entry and continue or to quit\&. The destination entry is protected with the source entry password\&. + +If the destination alias already exists in the destination keystore, then the user is prompted to either overwrite the entry or to create a new entry under a different alias name\&. + +If the \f3-noprompt\fR option is provided, then the user is not prompted for a new destination alias\&. Existing entries are overwritten with the destination alias name\&. Entries that cannot be imported are skipped and a warning is displayed\&. +.TP +-printcertreq +.sp +.nf +\f3{\-file \fIfile\fR}\fP +.fi +.sp + + +Prints the content of a PKCS #10 format certificate request, which can be generated by the \f3keytool\fR\f3-certreq\fR command\&. The command reads the request from file\&. If there is no file, then the request is read from the standard input\&. +.TP +-certreq +.sp +.nf +\f3{\-alias \fIalias\fR} {\-dname \fIdname\fR} {\-sigalg \fIsigalg\fR} {\-file \fIcertreq_file\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-keypass \fIkeypass\fR] {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-v} {\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Generates a Certificate Signing Request (CSR) using the PKCS #10 format\&. + +A CSR is intended to be sent to a certificate authority (CA)\&. The CA authenticates the certificate requestor (usually off-line) and will return a certificate or certificate chain, used to replace the existing certificate chain (which initially consists of a self-signed certificate) in the keystore\&. + +The private key associated with alias is used to create the PKCS #10 certificate request\&. To access the private key, the correct password must be provided\&. If \f3keypass\fR is not provided at the command line and is different from the password used to protect the integrity of the keystore, then the user is prompted for it\&. If \f3dname\fR is provided, then it is used as the subject in the CSR\&. Otherwise, the X\&.500 Distinguished Name associated with alias is used\&. + +The \f3sigalg\fR value specifies the algorithm that should be used to sign the CSR\&. + +The CSR is stored in the file certreq_file\&. If no file is specified, then the CSR is output to \f3stdout\fR\&. + +Use the \f3importcert\fR command to import the response from the CA\&. +.TP +-exportcert +.sp +.nf +\f3{\-alias \fIalias\fR} {\-file \fIcert_file\fR} {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-rfc} {\-v} {\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Reads from the keystore the certificate associated with \fIalias\fR and stores it in the cert_file file\&. When no file is specified, the certificate is output to \f3stdout\fR\&. + +The certificate is by default output in binary encoding\&. If the \f3-rfc\fR option is specified, then the output in the printable encoding format defined by the Internet RFC 1421 Certificate Encoding Standard\&. + +If \f3alias\fR refers to a trusted certificate, then that certificate is output\&. Otherwise, \f3alias\fR refers to a key entry with an associated certificate chain\&. In that case, the first certificate in the chain is returned\&. This certificate authenticates the public key of the entity addressed by \f3alias\fR\&. + +This command was named \f3-export\fR in earlier releases\&. The old name is still supported in this release\&. The new name, \f3-exportcert\fR, is preferred going forward\&. +.TP +-list +.sp +.nf +\f3{\-alias \fIalias\fR} {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP +.fi +.sp +.sp +.nf +\f3{\-providerName \fIprovider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-v | \-rfc} {\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Prints to \f3stdout\fR the contents of the keystore entry identified by \f3alias\fR\&. If no \f3alias\fR is specified, then the contents of the entire keystore are printed\&. + +This command by default prints the SHA1 fingerprint of a certificate\&. If the \f3-v\fR option is specified, then the certificate is printed in human-readable format, with additional information such as the owner, issuer, serial number, and any extensions\&. If the \f3-rfc\fR option is specified, then the certificate contents are printed using the printable encoding format, as defined by the Internet RFC 1421 Certificate Encoding Standard\&. + +You cannot specify both \f3-v\fR and \f3-rfc\fR\&. +.TP +-printcert +.sp +.nf +\f3{\-file \fIcert_file\fR | \-sslserver \fIhost\fR[:\fIport\fR]} {\-jarfile \fIJAR_file\fR {\-rfc} {\-v}\fP +.fi +.sp +.sp +.nf +\f3{\-Jjavaoption}\fP +.fi +.sp + + +Reads the certificate from the file cert_file, the SSL server located at host:port, or the signed JAR file \f3JAR_file\fR (with the \f3-jarfile\fR option and prints its contents in a human-readable format\&. When no port is specified, the standard HTTPS port 443 is assumed\&. Note that \f3-sslserver\fR and -file options cannot be provided at the same time\&. Otherwise, an error is reported\&. If neither option is specified, then the certificate is read from \f3stdin\fR\&. + +When\f3-rfc\fR is specified, the \f3keytool\fR command prints the certificate in PEM mode as defined by the Internet RFC 1421 Certificate Encoding standard\&. See Internet RFC 1421 Certificate Encoding Standard\&. + +If the certificate is read from a file or \f3stdin\fR, then it might be either binary encoded or in printable encoding format, as defined by the RFC 1421 Certificate Encoding standard\&. + +If the SSL server is behind a firewall, then the \f3-J-Dhttps\&.proxyHost=proxyhost\fR and \f3-J-Dhttps\&.proxyPort=proxyport\fR options can be specified on the command line for proxy tunneling\&. See Java Secure Socket Extension (JSSE) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide\&.html + +\fINote:\fR This option can be used independently of a keystore\&. +.TP +-printcrl +.sp +.nf +\f3\-file \fIcrl_\fR {\-v}\fP +.fi +.sp + + +Reads the Certificate Revocation List (CRL) from the file \f3crl_\fR\&. A CRL is a list of digital certificates that were revoked by the CA that issued them\&. The CA generates the \f3crl_\fR file\&. + +\fINote:\fR This option can be used independently of a keystore\&. +.TP +-storepasswd +.sp +.nf +\f3[\-new \fInew_storepass\fR] {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR}\fP +.fi +.sp +.sp +.nf +\f3[\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-v} {\-Jjavaoption}\fP +.fi +.sp + + +Changes the password used to protect the integrity of the keystore contents\&. The new password is \f3new_storepass\fR, which must be at least 6 characters\&. +.TP +-keypasswd +.sp +.nf +\f3{\-alias \fIalias\fR} [\-keypass \fIold_keypass\fR] [\-new \fInew_keypass\fR] {\-storetype \fIstoretype\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}} {\-v}\fP +.fi +.sp +.sp +.nf +\f3{\-Jjavaoption}\fP +.fi +.sp + + +Changes the password under which the private/secret key identified by \f3alias\fR is protected, from \f3old_keypass\fR to \f3new_keypass\fR, which must be at least 6 characters\&. + +If the \f3-keypass\fR option is not provided at the command line, and the key password is different from the keystore password, then the user is prompted for it\&. + +If the \f3-new\fR option is not provided at the command line, then the user is prompted for it +.TP +-delete +.sp +.nf +\f3[\-alias \fIalias\fR] {\-storetype \fIstoretype\fR} {\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR]\fP +.fi +.sp +.sp +.nf +\f3{\-providerName \fIprovider_name\fR} \fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}}\fP +.fi +.sp +.sp +.nf +\f3{\-v} {\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Deletes from the keystore the entry identified by \f3alias\fR\&. The user is prompted for the alias, when no alias is provided at the command line\&. +.TP +-changealias +.sp +.nf +\f3{\-alias \fIalias\fR} [\-destalias \fIdestalias\fR] [\-keypass \fIkeypass\fR] {\-storetype \fIstoretype\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-keystore \fIkeystore\fR} [\-storepass \fIstorepass\fR] {\-providerName \fIprovider_name\fR}\fP +.fi +.sp +.sp +.nf +\f3{\-providerClass \fIprovider_class_name\fR {\-providerArg \fIprovider_arg\fR}} {\-v}\fP +.fi +.sp +.sp +.nf +\f3{\-protected} {\-Jjavaoption}\fP +.fi +.sp + + +Move an existing keystore entry from the specified \f3alias\fR to a new alias, \f3destalias\fR\&. If no destination alias is provided, then the command prompts for one\&. If the original entry is protected with an entry password, then the password can be supplied with the \f3-keypass\fR option\&. If no key password is provided, then the \f3storepass\fR (if provided) is attempted first\&. If the attempt fails, then the user is prompted for a password\&. +.TP +-help +.br +Lists the basic commands and their options\&. + +For more information about a specific command, enter the following, where \f3command_name\fR is the name of the command: \f3keytool -command_name -help\fR\&. +.SH EXAMPLES +This example walks through the sequence of steps to create a keystore for managing public/private key pair and certificates from trusted entities\&. +.SS GENERATE\ THE\ KEY\ PAIR +First, create a keystore and generate the key pair\&. You can use a command such as the following typed as a single line: +.sp +.nf +\f3keytool \-genkeypair \-dname "cn=Mark Jones, ou=Java, o=Oracle, c=US"\fP +.fi +.nf +\f3 \-alias business \-keypass <new password for private key>\fP +.fi +.nf +\f3 \-keystore /working/mykeystore\fP +.fi +.nf +\f3 \-storepass <new password for keystore> \-validity 180\fP +.fi +.nf +\f3\fP +.fi +.sp +The command creates the keystore named \f3mykeystore\fR in the working directory (assuming it does not already exist), and assigns it the password specified by \f3<new password for keystore>\fR\&. It generates a public/private key pair for the entity whose distinguished name has a common name of Mark Jones, organizational unit of Java, organization of Oracle and two-letter country code of US\&. It uses the default DSA key generation algorithm to create the keys; both are 1024 bits\&. +.PP +The command uses the default SHA1withDSA signature algorithm to create a self-signed certificate that includes the public key and the distinguished name information\&. The certificate is valid for 180 days, and is associated with the private key in a keystore entry referred to by the alias \f3business\fR\&. The private key is assigned the password specified by \f3<new password for private key>\fR\&. +.PP +The command is significantly shorter when the option defaults are accepted\&. In this case, no options are required, and the defaults are used for unspecified options that have default values\&. You are prompted for any required values\&. You could have the following: +.sp +.nf +\f3keytool \-genkeypair\fP +.fi +.nf +\f3\fP +.fi +.sp +In this case, a keystore entry with the alias \f3mykey\fR is created, with a newly generated key pair and a certificate that is valid for 90 days\&. This entry is placed in the keystore named \f3\&.keystore\fR in your home directory\&. The keystore is created when it does not already exist\&. You are prompted for the distinguished name information, the keystore password, and the private key password\&. +.PP +The rest of the examples assume you executed the \f3-genkeypair\fR command without options specified, and that you responded to the prompts with values equal to those specified in the first \f3-genkeypair\fR command\&. For example, a distinguished name of \f3cn=Mark Jones\fR, \f3ou=Java\fR, \f3o=Oracle\fR, \f3c=US\fR)\&. +.SS REQUEST\ A\ SIGNED\ CERTIFICATE\ FROM\ A\ CA +Generating the key pair created a self-signed certificate\&. A certificate is more likely to be trusted by others when it is signed by a Certification Authority (CA)\&. To get a CA signature, first generate a Certificate Signing Request (CSR), as follows: +.sp +.nf +\f3keytool \-certreq \-file MarkJ\&.csr\fP +.fi +.nf +\f3\fP +.fi +.sp +This creates a CSR for the entity identified by the default alias \f3mykey\fR and puts the request in the file named MarkJ\&.csr\&. Submit this file to a CA, such as VeriSign\&. The CA authenticates you, the requestor (usually off-line), and returns a certificate, signed by them, authenticating your public key\&. In some cases, the CA returns a chain of certificates, each one authenticating the public key of the signer of the previous certificate in the chain\&. +.SS IMPORT\ A\ CERTIFICATE\ FOR\ THE\ CA +You now need to replace the self-signed certificate with a certificate chain, where each certificate in the chain authenticates the public key of the signer of the previous certificate in the chain, up to a root CA\&. +.PP +Before you import the certificate reply from a CA, you need one or more trusted certificates in your keystore or in the \f3cacerts\fR keystore file\&. See \f3-importcert\fR in Commands\&. +.TP 0.2i +\(bu +If the certificate reply is a certificate chain, then you need the top certificate of the chain\&. The root CA certificate that authenticates the public key of the CA\&. +.TP 0.2i +\(bu +If the certificate reply is a single certificate, then you need a certificate for the issuing CA (the one that signed it)\&. If that certificate is not self-signed, then you need a certificate for its signer, and so on, up to a self-signed root CA certificate\&. +.PP +The \f3cacerts\fR keystore file ships with several VeriSign root CA certificates, so you probably will not need to import a VeriSign certificate as a trusted certificate in your keystore\&. But if you request a signed certificate from a different CA, and a certificate authenticating that CA\&'s public key was not added to \f3cacerts\fR, then you must import a certificate from the CA as a trusted certificate\&. +.PP +A certificate from a CA is usually either self-signed or signed by another CA, in which case you need a certificate that authenticates that CA\&'s public key\&. Suppose company ABC, Inc\&., is a CA, and you obtain a file named A\f3BCCA\&.cer\fR that is supposed to be a self-signed certificate from ABC, that authenticates that CA\&'s public key\&. Be careful to ensure the certificate is valid before you import it as a trusted certificate\&. View it first with the \f3keytool -printcert\fR command or the \f3keytool -importcert\fR command without the \f3-noprompt\fR option, and make sure that the displayed certificate fingerprints match the expected ones\&. You can call the person who sent the certificate, and compare the fingerprints that you see with the ones that they show or that a secure public key repository shows\&. Only when the fingerprints are equal is it guaranteed that the certificate was not replaced in transit with somebody else\&'s (for example, an attacker\&'s) certificate\&. If such an attack takes place, and you did not check the certificate before you imported it, then you would be trusting anything the attacker has signed\&. +.PP +If you trust that the certificate is valid, then you can add it to your keystore with the following command: +.sp +.nf +\f3keytool \-importcert \-alias abc \-file ABCCA\&.cer\fP +.fi +.nf +\f3\fP +.fi +.sp +This command creates a trusted certificate entry in the keystore, with the data from the file ABCCA\&.cer, and assigns the alias \f3abc\fR to the entry\&. +.SS IMPORT\ THE\ CERTIFICATE\ REPLY\ FROM\ THE\ CA +After you import a certificate that authenticates the public key of the CA you submitted your certificate signing request to (or there is already such a certificate in the cacerts file), you can import the certificate reply and replace your self-signed certificate with a certificate chain\&. This chain is the one returned by the CA in response to your request (when the CA reply is a chain), or one constructed (when the CA reply is a single certificate) using the certificate reply and trusted certificates that are already available in the keystore where you import the reply or in the \f3cacerts\fR keystore file\&. +.PP +For example, if you sent your certificate signing request to VeriSign, then you can import the reply with the following, which assumes the returned certificate is named VSMarkJ\&.cer: +.sp +.nf +\f3keytool \-importcert \-trustcacerts \-file VSMarkJ\&.cer\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS EXPORT\ A\ CERTIFICATE\ THAT\ AUTHENTICATES\ THE\ PUBLIC\ KEY +If you used the \f3jarsigner\fR command to sign a Java Archive (JAR) file, then clients that want to use the file will want to authenticate your signature\&. One way the clients can authenticate you is by first importing your public key certificate into their keystore as a trusted entry\&. +.PP +You can export the certificate and supply it to your clients\&. As an example, you can copy your certificate to a file named MJ\&.cer with the following command that assumes the entry has an alias of \f3mykey\fR: +.sp +.nf +\f3keytool \-exportcert \-alias mykey \-file MJ\&.cer\fP +.fi +.nf +\f3\fP +.fi +.sp +With the certificate and the signed JAR file, a client can use the \f3jarsigner\fR command to authenticate your signature\&. +.SS IMPORT\ KEYSTORE +The command \f3importkeystore\fR is used to import an entire keystore into another keystore, which means all entries from the source keystore, including keys and certificates, are all imported to the destination keystore within a single command\&. You can use this command to import entries from a different type of keystore\&. During the import, all new entries in the destination keystore will have the same alias names and protection passwords (for secret keys and private keys)\&. If the \f3keytool\fR command cannot recover the private keys or secret keys from the source keystore, then it prompts you for a password\&. If it detects alias duplication, then it asks you for a new alias, and you can specify a new alias or simply allow the \f3keytool\fR command to overwrite the existing one\&. +.PP +For example, to import entries from a typical JKS type keystore key\&.jks into a PKCS #11 type hardware-based keystore, use the command: +.sp +.nf +\f3keytool \-importkeystore\fP +.fi +.nf +\f3 \-srckeystore key\&.jks \-destkeystore NONE\fP +.fi +.nf +\f3 \-srcstoretype JKS \-deststoretype PKCS11\fP +.fi +.nf +\f3 \-srcstorepass <src keystore password>\fP +.fi +.nf +\f3 \-deststorepass <destination keystore pwd>\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3importkeystore\fR command can also be used to import a single entry from a source keystore to a destination keystore\&. In this case, besides the options you see in the previous example, you need to specify the alias you want to import\&. With the \f3-srcalias\fR option specified, you can also specify the destination alias name in the command line, as well as protection password for a secret/private key and the destination protection password you want\&. The following command demonstrates this: +.sp +.nf +\f3keytool \-importkeystore\fP +.fi +.nf +\f3 \-srckeystore key\&.jks \-destkeystore NONE\fP +.fi +.nf +\f3 \-srcstoretype JKS \-deststoretype PKCS11\fP +.fi +.nf +\f3 \-srcstorepass <src keystore password>\fP +.fi +.nf +\f3 \-deststorepass <destination keystore pwd>\fP +.fi +.nf +\f3 \-srcalias myprivatekey \-destalias myoldprivatekey\fP +.fi +.nf +\f3 \-srckeypass <source entry password>\fP +.fi +.nf +\f3 \-destkeypass <destination entry password>\fP +.fi +.nf +\f3 \-noprompt\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS GENERATE\ CERTIFICATES\ FOR\ AN\ SSL\ SERVER +The following are \f3keytool\fR commands to generate key pairs and certificates for three entities: Root CA (\f3root\fR), Intermediate CA (\f3ca\fR), and SSL server (\f3server\fR)\&. Ensure that you store all the certificates in the same keystore\&. In these examples, RSA is the recommended the key algorithm\&. +.sp +.nf +\f3keytool \-genkeypair \-keystore root\&.jks \-alias root \-ext bc:c\fP +.fi +.nf +\f3keytool \-genkeypair \-keystore ca\&.jks \-alias ca \-ext bc:c\fP +.fi +.nf +\f3keytool \-genkeypair \-keystore server\&.jks \-alias server\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3keytool \-keystore root\&.jks \-alias root \-exportcert \-rfc > root\&.pem\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3keytool \-storepass <storepass> \-keystore ca\&.jks \-certreq \-alias ca |\fP +.fi +.nf +\f3 keytool \-storepass <storepass> \-keystore root\&.jks\fP +.fi +.nf +\f3 \-gencert \-alias root \-ext BC=0 \-rfc > ca\&.pem\fP +.fi +.nf +\f3keytool \-keystore ca\&.jks \-importcert \-alias ca \-file ca\&.pem\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3keytool \-storepass <storepass> \-keystore server\&.jks \-certreq \-alias server |\fP +.fi +.nf +\f3 keytool \-storepass <storepass> \-keystore ca\&.jks \-gencert \-alias ca\fP +.fi +.nf +\f3 \-ext ku:c=dig,kE \-rfc > server\&.pem\fP +.fi +.nf +\f3cat root\&.pem ca\&.pem server\&.pem |\fP +.fi +.nf +\f3 keytool \-keystore server\&.jks \-importcert \-alias server\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH TERMS +.TP +Keystore +A keystore is a storage facility for cryptographic keys and certificates\&. +.TP +Keystore entries +Keystores can have different types of entries\&. The two most applicable entry types for the \f3keytool\fR command include the following: + +\fIKey entries\fR: Each entry holds very sensitive cryptographic key information, which is stored in a protected format to prevent unauthorized access\&. Typically, a key stored in this type of entry is a secret key, or a private key accompanied by the certificate chain for the corresponding public key\&. See Certificate Chains\&. The \f3keytool\fR command can handle both types of entries, while the \f3jarsigner\fR tool only handles the latter type of entry, that is private keys and their associated certificate chains\&. + +\fITrusted certificate entries\fR: Each entry contains a single public key certificate that belongs to another party\&. The entry is called a trusted certificate because the keystore owner trusts that the public key in the certificate belongs to the identity identified by the subject (owner) of the certificate\&. The issuer of the certificate vouches for this, by signing the certificate\&. +.TP +KeyStore aliases +All keystore entries (key and trusted certificate entries) are accessed by way of unique aliases\&. + +An alias is specified when you add an entity to the keystore with the \f3-genseckey\fR command to generate a secret key, the \f3-genkeypair\fR command to generate a key pair (public and private key), or the \f3-importcert\fR command to add a certificate or certificate chain to the list of trusted certificates\&. Subsequent \f3keytool\fR commands must use this same alias to refer to the entity\&. + +For example, you can use the alias \f3duke\fR to generate a new public/private key pair and wrap the public key into a self-signed certificate with the following command\&. See Certificate Chains\&. +.sp +.nf +\f3keytool \-genkeypair \-alias duke \-keypass dukekeypasswd\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This example specifies an initial password of \f3dukekeypasswd\fR required by subsequent commands to access the private key associated with the alias \f3duke\fR\&. If you later want to change Duke\&'s private key password, use a command such as the following: +.sp +.nf +\f3keytool \-keypasswd \-alias duke \-keypass dukekeypasswd \-new newpass\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This changes the password from \f3dukekeypasswd\fR to \f3newpass\fR\&. A password should not be specified on a command line or in a script unless it is for testing purposes, or you are on a secure system\&. If you do not specify a required password option on a command line, then you are prompted for it\&. +.TP +KeyStore implementation +The \f3KeyStore\fR class provided in the \f3java\&.security\fR 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 type of keystore\&. + +Currently, two command-line tools (\f3keytool\fR and \f3jarsigner\fR) and a GUI-based tool named Policy Tool make use of keystore implementations\&. Because the \f3KeyStore\fR class is \f3public\fR, users can write additional security applications that use it\&. + +There is a built-in default implementation, provided by Oracle\&. It implements the keystore as a file with a proprietary keystore type (format) named JKS\&. It protects each private key with its individual password, and also protects the integrity of the entire keystore with a (possibly different) password\&. + +Keystore implementations are provider-based\&. More specifically, the application interfaces supplied by \f3KeyStore\fR are implemented in terms of a Service Provider Interface (SPI)\&. That is, there is a corresponding abstract \f3KeystoreSpi\fR class, also in the \f3java\&.security package\fR, which defines the Service Provider Interface methods that providers must implement\&. The term \fIprovider\fR refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API\&. To provide a keystore implementation, clients must implement a provider and supply a \f3KeystoreSpi\fR subclass implementation, as described in How to Implement a Provider in the Java Cryptography Architecture at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/HowToImplAProvider\&.html + +Applications can choose different types of keystore implementations from different providers, using the \f3getInstance\fR factory method supplied in the \f3KeyStore\fR class\&. A keystore type defines the storage and data format of the keystore information, and the algorithms used to protect private/secret keys in the keystore and the integrity of the keystore\&. Keystore implementations of different types are not compatible\&. + +The \f3keytool\fR command works on any file-based keystore implementation\&. It treats the keystore location that is passed to it at the command line as a file name and converts it to a \f3FileInputStream\fR, from which it loads the keystore information\&.)The \f3jarsigner\fR and \f3policytool\fR commands can read a keystore from any location that can be specified with a URL\&. + +For \f3keytool\fR and \f3jarsigner\fR, you can specify a keystore type at the command line, with the \f3-storetype\fR option\&. For Policy Tool, you can specify a keystore type with the \fIKeystore\fR menu\&. + +If you do not explicitly specify a keystore type, then the tools choose a keystore implementation based on the value of the \f3keystore\&.type\fR property specified in the security properties file\&. The security properties file is called \f3java\&.security\fR, and resides in the security properties directory, \f3java\&.home\elib\esecurity\fR on Windows and \f3java\&.home/lib/security\fR on Oracle Solaris, where \f3java\&.home\fR is the runtime environment directory\&. The \f3jre\fR directory in the SDK or the top-level directory of the Java Runtime Environment (JRE)\&. + +Each tool gets the \f3keystore\&.type\fR value and then examines all the currently installed providers until it finds one that implements a keystores of that type\&. It then uses the keystore implementation from that provider\&.The \f3KeyStore\fR class defines a static method named \f3getDefaultType\fR that lets applications and applets retrieve the value of the \f3keystore\&.type\fR property\&. The following line of code creates an instance of the default keystore type as specified in the \f3keystore\&.type\fR property: +.sp +.nf +\f3KeyStore keyStore = KeyStore\&.getInstance(KeyStore\&.getDefaultType());\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The default keystore type is \f3jks\fR, which is the proprietary type of the keystore implementation provided by Oracle\&. This is specified by the following line in the security properties file: +.sp +.nf +\f3keystore\&.type=jks\fP +.fi +.nf +\f3\fP +.fi +.sp + + +To have the tools utilize a keystore implementation other than the default, you can change that line to specify a different keystore type\&. For example, if you have a provider package that supplies a keystore implementation for a keystore type called \f3pkcs12\fR, then change the line to the following: +.sp +.nf +\f3keystore\&.type=pkcs12\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fINote:\fR Case does not matter in keystore type designations\&. For example, JKS would be considered the same as jks\&. +.TP +Certificate +A certificate (or public-key certificate) is a digitally signed statement from one entity (the issuer), saying that the public key and some other information of another entity (the subject) has some specific value\&. The following terms are related to certificates: + +\fIPublic Keys\fR: These are numbers associated with a particular entity, and are intended to be known to everyone who needs to have trusted interactions with that entity\&. Public keys are used to verify signatures\&. + +\fIDigitally Signed\fR: If some data is digitally signed, then it is stored with the identity of an entity and a signature that proves that entity knows about the data\&. The data is rendered unforgeable by signing with the entity\&'s private key\&. + +\fIIdentity\fR: A known way of addressing an entity\&. In some systems, the identity is the public key, and in others it can be anything from an Oracle Solaris UID to an email address to an X\&.509 distinguished name\&. + +\fISignature\fR: A signature is computed over some data using the private key of an entity\&. The signer, which in the case of a certificate is also known as the issuer\&. + +\fIPrivate Keys\fR: These are numbers, each of which is supposed to be known only to the particular entity whose private key it is (that is, it is supposed to be kept secret)\&. Private and public keys exist in pairs in all public key cryptography systems (also referred to as public key crypto systems)\&. In a typical public key crypto system, such as DSA, a private key corresponds to exactly one public key\&. Private keys are used to compute signatures\&. + +\fIEntity\fR: An entity is a person, organization, program, computer, business, bank, or something else you are trusting to some degree\&. + +Public key cryptography requires access to users\&' public keys\&. In a large-scale networked environment, it is impossible to guarantee that prior relationships between communicating entities were established or that a trusted repository exists with all used public keys\&. Certificates were invented as a solution to this public key distribution problem\&. Now a Certification Authority (CA) can act as a trusted third party\&. CAs are entities such as businesses that are trusted to sign (issue) certificates for other entities\&. It is assumed that CAs only create valid and reliable certificates because they are bound by legal agreements\&. There are many public Certification Authorities, such as VeriSign, Thawte, Entrust, and so on\&. + +You can also run your own Certification Authority using products such as Microsoft Certificate Server or the Entrust CA product for your organization\&. With the \f3keytool\fR command, it is possible to display, import, and export certificates\&. It is also possible to generate self-signed certificates\&. + +The \f3keytool\fR command currently handles X\&.509 certificates\&. +.TP +X\&.509 Certificates +The X\&.509 standard defines what information can go into a certificate and describes how to write it down (the data format)\&. All the data in a certificate is encoded with two related standards called ASN\&.1/DER\&. Abstract Syntax Notation 1 describes data\&. The Definite Encoding Rules describe a single way to store and transfer that data\&. + +All X\&.509 certificates have the following data, in addition to the signature: + +\fIVersion\fR: This identifies which version of the X\&.509 standard applies to this certificate, which affects what information can be specified in it\&. Thus far, three versions are defined\&. The \f3keytool\fR command can import and export v1, v2, and v3 certificates\&. It generates v3 certificates\&. + +X\&.509 Version 1 has been available since 1988, is widely deployed, and is the most generic\&. + +X\&.509 Version 2 introduced the concept of subject and issuer unique identifiers to handle the possibility of reuse of subject or issuer names over time\&. Most certificate profile documents strongly recommend that names not be reused and that certificates should not make use of unique identifiers\&. Version 2 certificates are not widely used\&. + +X\&.509 Version 3 is the most recent (1996) and supports the notion of extensions where anyone can define an extension and include it in the certificate\&. Some common extensions are: KeyUsage (limits the use of the keys to particular purposes such as \f3signing-only\fR) and AlternativeNames (allows other identities to also be associated with this public key, for example\&. DNS names, email addresses, IP addresses)\&. Extensions can be marked critical to indicate that the extension should be checked and enforced or used\&. For example, if a certificate has the KeyUsage extension marked critical and set to \f3keyCertSign\fR, then when this certificate is presented during SSL communication, it should be rejected because the certificate extension indicates that the associated private key should only be used for signing certificates and not for SSL use\&. + +\fISerial number\fR: The entity that created the certificate is responsible for assigning it a serial number to distinguish it from other certificates it issues\&. This information is used in numerous ways\&. For example, when a certificate is revoked its serial number is placed in a Certificate Revocation List (CRL)\&. + +\fISignature algorithm identifier\fR: This identifies the algorithm used by the CA to sign the certificate\&. + +\fIIssuer name\fR: The X\&.500 Distinguished Name of the entity that signed the certificate\&. See X\&.500 Distinguished Names\&. This is typically a CA\&. Using this certificate implies trusting the entity that signed this certificate\&. In some cases, such as root or top-level CA certificates, the issuer signs its own certificate\&. + +\fIValidity period\fR: Each certificate is valid only for a limited amount of time\&. This period is described by a start date and time and an end date and time, and can be as short as a few seconds or almost as long as a century\&. The validity period chosen depends on a number of factors, such as the strength of the private key used to sign the certificate, or the amount one is willing to pay for a certificate\&. This is the expected period that entities can rely on the public value, when the associated private key has not been compromised\&. + +\fISubject name\fR: The name of the entity whose public key the certificate identifies\&. This name uses the X\&.500 standard, so it is intended to be unique across the Internet\&. This is the X\&.500 Distinguished Name (DN) of the entity\&. See X\&.500 Distinguished Names\&. For example, +.sp +.nf +\f3CN=Java Duke, OU=Java Software Division, O=Oracle Corporation, C=US\fP +.fi +.nf +\f3\fP +.fi +.sp + + +These refer to the subject\&'s common name (CN), organizational unit (OU), organization (O), and country (C)\&. + +\fISubject public key information\fR: This is the public key of the entity being named with an algorithm identifier that specifies which public key crypto system this key belongs to and any associated key parameters\&. +.TP +Certificate Chains +The \f3keytool\fR command can create and manage keystore key entries that each contain a private key and an associated certificate chain\&. The first certificate in the chain contains the public key that corresponds to the private key\&. + +When keys are first generated, the chain starts off containing a single element, a self-signed certificate\&. See \f3-genkeypair\fR in Commands\&. A self-signed certificate is one for which the issuer (signer) is the same as the subject\&. The subject is the entity whose public key is being authenticated by the certificate\&. Whenever the \f3-genkeypair\fR command is called to generate a new public/private key pair, it also wraps the public key into a self-signed certificate\&. + +Later, after a Certificate Signing Request (CSR) was generated with the \f3-certreq\fR command and sent to a Certification Authority (CA), the response from the CA is imported with \f3-importcert\fR, and the self-signed certificate is replaced by a chain of certificates\&. See the \f3-certreq\fR and \f3-importcert\fR options in Commands\&. At the bottom of the chain is the certificate (reply) issued by the CA authenticating the subject\&'s public key\&. The next certificate in the chain is one that authenticates the CA\&'s public key\&. + +In many cases, this is a self-signed certificate, which is a certificate from the CA authenticating its own public key, and the last certificate in the chain\&. In other cases, the CA might return a chain of certificates\&. In this case, the bottom certificate in the chain is the same (a certificate signed by the CA, authenticating the public key of the key entry), but the second certificate in the chain is a certificate signed by a different CA that authenticates the public key of the CA you sent the CSR to\&. The next certificate in the chain is a certificate that authenticates the second CA\&'s key, and so on, until a self-signed root certificate is reached\&. Each certificate in the chain (after the first) authenticates the public key of the signer of the previous certificate in the chain\&. + +Many CAs only return the issued certificate, with no supporting chain, especially when there is a flat hierarchy (no intermediates CAs)\&. In this case, the certificate chain must be established from trusted certificate information already stored in the keystore\&. + +A different reply format (defined by the PKCS #7 standard) includes the supporting certificate chain in addition to the issued certificate\&. Both reply formats can be handled by the \f3keytool\fR command\&. + +The top-level (root) CA certificate is self-signed\&. However, the trust into the root\&'s public key does not come from the root certificate itself, but from other sources such as a newspaper\&. This is because anybody could generate a self-signed certificate with the distinguished name of, for example, the VeriSign root CA\&. The root CA public key is widely known\&. The only reason it is stored in a certificate is because this is the format understood by most tools, so the certificate in this case is only used as a vehicle to transport the root CA\&'s public key\&. Before you add the root CA certificate to your keystore, you should view it with the \f3-printcert\fR option and compare the displayed fingerprint with the well-known fingerprint obtained from a newspaper, the root CA\&'s Web page, and so on\&. +.TP +The cacerts Certificates File +A certificates file named \f3cacerts\fR resides in the security properties directory, \f3java\&.home\elib\esecurity\fR on Windows and \f3java\&.home/lib/security\fR on Oracle Solaris, where \f3java\&.home\fR is the runtime environment\&'s directory, which would be the \f3jre\fR directory in the SDK or the top-level directory of the JRE\&. + +The \f3cacerts\fR file represents a system-wide keystore with CA certificates\&. System administrators can configure and manage that file with the \f3keytool\fR command by specifying \f3jks\fR as the keystore type\&. The \f3cacerts\fR keystore file ships with a default set of root CA certificates\&. You can list the default certificates with the following command: +.sp +.nf +\f3keytool \-list \-keystore java\&.home/lib/security/cacerts\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The initial password of the \f3cacerts\fR keystore file is \f3changeit\fR\&. System administrators should change that password and the default access permission of that file upon installing the SDK\&. + +\fINote:\fR It is important to verify your \f3cacerts\fR file\&. Because you trust the CAs in the \f3cacerts\fR file as entities for signing and issuing certificates to other entities, you must manage the \f3cacerts\fR file carefully\&. The \f3cacerts\fR file should contain only certificates of the CAs you trust\&. It is your responsibility to verify the trusted root CA certificates bundled in the \f3cacerts\fR file and make your own trust decisions\&. + +To remove an untrusted CA certificate from the \f3cacerts\fR file, use the \f3delete\fR option of the \f3keytool\fR command\&. You can find the \f3cacerts\fR file in the JRE installation directory\&. Contact your system administrator if you do not have permission to edit this file +.TP +Internet RFC 1421 Certificate Encoding Standard +Certificates are often stored using the printable encoding format defined by the Internet RFC 1421 standard, instead of their binary encoding\&. This certificate format, also known as Base64 encoding, makes it easy to export certificates to other applications by email or through some other mechanism\&. + +Certificates read by the \f3-importcert\fR and \f3-printcert\fR commands can be in either this format or binary encoded\&. The \f3-exportcert\fR command by default outputs a certificate in binary encoding, but will instead output a certificate in the printable encoding format, when the \f3-rfc\fR option is specified\&. + +The \f3-list\fR command by default prints the SHA1 fingerprint of a certificate\&. If the \f3-v\fR option is specified, then the certificate is printed in human-readable format\&. If the \f3-rfc\fR option is specified, then the certificate is output in the printable encoding format\&. + +In its printable encoding format, the encoded certificate is bounded at the beginning and end by the following text: +.sp +.nf +\f3\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3encoded certificate goes here\&. \fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-\-\-\-\-END CERTIFICATE\-\-\-\-\-\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +X\&.500 Distinguished Names +X\&.500 Distinguished Names are used to identify entities, such as those that are named by the \f3subject\fR and \f3issuer\fR (signer) fields of X\&.509 certificates\&. The \f3keytool\fR command supports the following subparts: + +\fIcommonName\fR: The common name of a person such as Susan Jones\&. + +\fIorganizationUnit\fR: The small organization (such as department or division) name\&. For example, Purchasing\&. + +\fIlocalityName\fR: The locality (city) name, for example, Palo Alto\&. + +\fIstateName\fR: State or province name, for example, California\&. + +\fIcountry\fR: Two-letter country code, for example, CH\&. + +When you supply a distinguished name string as the value of a \f3-dname\fR option, such as for the \f3-genkeypair\fR command, the string must be in the following format: +.sp +.nf +\f3CN=cName, OU=orgUnit, O=org, L=city, S=state, C=countryCode\fP +.fi +.nf +\f3\fP +.fi +.sp + + +All the italicized items represent actual values and the previous keywords are abbreviations for the following: +.sp +.nf +\f3CN=commonName\fP +.fi +.nf +\f3OU=organizationUnit\fP +.fi +.nf +\f3O=organizationName\fP +.fi +.nf +\f3L=localityName\fP +.fi +.nf +\f3S=stateName\fP +.fi +.nf +\f3C=country\fP +.fi +.nf +\f3\fP +.fi +.sp + + +A sample distinguished name string is: +.sp +.nf +\f3CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino, S=California, C=US\fP +.fi +.nf +\f3\fP +.fi +.sp + + +A sample command using such a string is: +.sp +.nf +\f3keytool \-genkeypair \-dname "CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino,\fP +.fi +.nf +\f3S=California, C=US" \-alias mark\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Case does not matter for the keyword abbreviations\&. For example, CN, cn, and Cn are all treated the same\&. + +Order matters; each subcomponent must appear in the designated order\&. However, it is not necessary to have all the subcomponents\&. You can use a subset, for example: +.sp +.nf +\f3CN=Steve Meier, OU=Java, O=Oracle, C=US\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If a distinguished name string value contains a comma, then the comma must be escaped by a backslash (\e) character when you specify the string on a command line, as in: +.sp +.nf +\f3cn=Peter Schuster, ou=Java\e, Product Development, o=Oracle, c=US\fP +.fi +.nf +\f3\fP +.fi +.sp + + +It is never necessary to specify a distinguished name string on a command line\&. When the distinguished name is needed for a command, but not supplied on the command line, the user is prompted for each of the subcomponents\&. In this case, a comma does not need to be escaped by a backslash (\e)\&. +.SH WARNINGS +.SS IMPORTING\ TRUSTED\ CERTIFICATES\ WARNING +\fIImportant\fR: Be sure to check a certificate very carefully before importing it as a trusted certificate\&. +.PP +Windows Example: + +View the certificate first with the \f3-printcert\fR command or the \f3-importcert\fR command without the \f3-noprompt\fR option\&. Ensure that the displayed certificate fingerprints match the expected ones\&. For example, suppose sends or emails you a certificate that you put it in a file named \f3\etmp\ecert\fR\&. Before you consider adding the certificate to your list of trusted certificates, you can execute a \f3-printcert\fR command to view its fingerprints, as follows: +.sp +.nf +\f3 keytool \-printcert \-file \etmp\ecert\fP +.fi +.nf +\f3 Owner: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP +.fi +.nf +\f3 Issuer: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP +.fi +.nf +\f3 Serial Number: 59092b34\fP +.fi +.nf +\f3 Valid from: Thu Sep 25 18:01:13 PDT 1997 until: Wed Dec 24 17:01:13 PST 1997\fP +.fi +.nf +\f3 Certificate Fingerprints:\fP +.fi +.nf +\f3 MD5: 11:81:AD:92:C8:E5:0E:A2:01:2E:D4:7A:D7:5F:07:6F\fP +.fi +.nf +\f3 SHA1: 20:B6:17:FA:EF:E5:55:8A:D0:71:1F:E8:D6:9D:C0:37:13:0E:5E:FE\fP +.fi +.nf +\f3 SHA256: 90:7B:70:0A:EA:DC:16:79:92:99:41:FF:8A:FE:EB:90:\fP +.fi +.nf +\f3 17:75:E0:90:B2:24:4D:3A:2A:16:A6:E4:11:0F:67:A4\fP +.fi +.sp + +.PP +Oracle Solaris Example: + +View the certificate first with the \f3-printcert\fR command or the \f3-importcert\fR command without the \f3-noprompt\fR option\&. Ensure that the displayed certificate fingerprints match the expected ones\&. For example, suppose someone sends or emails you a certificate that you put it in a file named \f3/tmp/cert\fR\&. Before you consider adding the certificate to your list of trusted certificates, you can execute a \f3-printcert\fR command to view its fingerprints, as follows: +.sp +.nf +\f3 keytool \-printcert \-file /tmp/cert\fP +.fi +.nf +\f3 Owner: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP +.fi +.nf +\f3 Issuer: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP +.fi +.nf +\f3 Serial Number: 59092b34\fP +.fi +.nf +\f3 Valid from: Thu Sep 25 18:01:13 PDT 1997 until: Wed Dec 24 17:01:13 PST 1997\fP +.fi +.nf +\f3 Certificate Fingerprints:\fP +.fi +.nf +\f3 MD5: 11:81:AD:92:C8:E5:0E:A2:01:2E:D4:7A:D7:5F:07:6F\fP +.fi +.nf +\f3 SHA1: 20:B6:17:FA:EF:E5:55:8A:D0:71:1F:E8:D6:9D:C0:37:13:0E:5E:FE\fP +.fi +.nf +\f3 SHA256: 90:7B:70:0A:EA:DC:16:79:92:99:41:FF:8A:FE:EB:90:\fP +.fi +.nf +\f3 17:75:E0:90:B2:24:4D:3A:2A:16:A6:E4:11:0F:67:A4\fP +.fi +.nf +\f3\fP +.fi +.sp +Then call or otherwise contact the person who sent the certificate and compare the fingerprints that you see with the ones that they show\&. Only when the fingerprints are equal is it guaranteed that the certificate was not replaced in transit with somebody else\&'s certificate such as an attacker\&'s certificate\&. If such an attack took place, and you did not check the certificate before you imported it, then you would be trusting anything the attacker signed, for example, a JAR file with malicious class files inside\&. +.PP +\fINote:\fR It is not required that you execute a \f3-printcert\fR command before importing a certificate\&. This is because before you add a certificate to the list of trusted certificates in the keystore, the \f3-importcert\fR command prints out the certificate information and prompts you to verify it\&. You can then stop the import operation\&. However, you can do this only when you call the \f3-importcert\fR command without the \f3-noprompt\fR option\&. If the \f3-noprompt\fR option is specified, then there is no interaction with the user\&. +.SS PASSWORDS\ WARNING +Most commands that operate on a keystore require the store password\&. Some commands require a private/secret key password\&. Passwords can be specified on the command line in the \f3-storepass\fR and \f3-keypass\fR options\&. However, a password should not be specified on a command line or in a script unless it is for testing, or you are on a secure system\&. When you do not specify a required password option on a command line, you are prompted for it\&. +.SS CERTIFICATE\ CONFORMANCE\ WARNING +The Internet standard RFC 5280 has defined a profile on conforming X\&.509 certificates, which includes what values and value combinations are valid for certificate fields and extensions\&. See the standard at http://tools\&.ietf\&.org/rfc/rfc5280\&.txt +.PP +The \f3keytool\fR command does not enforce all of these rules so it can generate certificates that do not conform to the standard\&. Certificates that do not conform to the standard might be rejected by JRE or other applications\&. Users should ensure that they provide the correct options for \f3-dname\fR, \f3-ext\fR, and so on\&. +.SH NOTES +.SS IMPORT\ A\ NEW\ TRUSTED\ CERTIFICATE +Before you add the certificate to the keystore, the \f3keytool\fR command verifies it by attempting to construct a chain of trust from that certificate to a self-signed certificate (belonging to a root CA), using trusted certificates that are already available in the keystore\&. +.PP +If the \f3-trustcacerts\fR option was specified, then additional certificates are considered for the chain of trust, namely the certificates in a file named \f3cacerts\fR\&. +.PP +If the \f3keytool\fR command fails to establish a trust path from the certificate to be imported up to a self-signed certificate (either from the keystore or the \f3cacerts\fR file), then the certificate information is printed, and the user is prompted to verify it by comparing the displayed certificate fingerprints with the fingerprints obtained from some other (trusted) source of information, which might be the certificate owner\&. Be very careful to ensure the certificate is valid before importing it as a trusted certificate\&. See Importing Trusted Certificates Warning\&. The user then has the option of stopping the import operation\&. If the \f3-noprompt\fR option is specified, then there is no interaction with the user\&. +.SS IMPORT\ A\ CERTIFICATE\ REPLY +When you import a certificate reply, the certificate reply is validated with trusted certificates from the keystore, and optionally, the certificates configured in the \f3cacerts\fR keystore file when the \f3-trustcacert\fR\f3s\fR option is specified\&. See The cacerts Certificates File\&. +.PP +The methods of determining whether the certificate reply is trusted are as follows: +.TP 0.2i +\(bu +If the reply is a single X\&.509 certificate, then the \f3keytool\fR command attempts to establish a trust chain, starting at the certificate reply and ending at a self-signed certificate (belonging to a root CA)\&. The certificate reply and the hierarchy of certificates is used to authenticate the certificate reply from the new certificate chain of aliases\&. If a trust chain cannot be established, then the certificate reply is not imported\&. In this case, the \f3keytool\fR command does not print the certificate and prompt the user to verify it, because it is very difficult for a user to determine the authenticity of the certificate reply\&. +.TP 0.2i +\(bu +If the reply is a PKCS #7 formatted certificate chain or a sequence of X\&.509 certificates, then the chain is ordered with the user certificate first followed by zero or more CA certificates\&. If the chain ends with a self-signed root CA certificate and the\f3-trustcacerts\fR option was specified, the \f3keytool\fR command attempts to match it with any of the trusted certificates in the keystore or the \f3cacerts\fR keystore file\&. If the chain does not end with a self-signed root CA certificate and the \f3-trustcacerts\fR option was specified, the \f3keytool\fR command tries to find one from the trusted certificates in the keystore or the \f3cacerts\fR keystore file and add it to the end of the chain\&. If the certificate is not found and the \f3-noprompt\fR option is not specified, the information of the last certificate in the chain is printed, and the user is prompted to verify it\&. +.PP +If the public key in the certificate reply matches the user\&'s public key already stored with \f3alias\fR, then the old certificate chain is replaced with the new certificate chain in the reply\&. The old chain can only be replaced with a valid \f3keypass\fR, and so the password used to protect the private key of the entry is supplied\&. If no password is provided, and the private key password is different from the keystore password, the user is prompted for it\&. +.PP +This command was named \f3-import\fR in earlier releases\&. This old name is still supported in this release\&. The new name, \f3-importcert\fR, is preferred going forward\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +jarsigner(1) +.TP 0.2i +\(bu +Trail: Security Features in Java SE at http://docs\&.oracle\&.com/javase/tutorial/security/index\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/native2ascii.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/native2ascii.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,86 +1,86 @@ -'\" t -.\" Copyright (c) 1997, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Internationalization Tools -.\" Title: native2ascii.1 -.\" -.if n .pl 99999 -.TH native2ascii 1 "21 November 2013" "JDK 8" "Internationalization Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -native2ascii \- Creates localizable applications by converting a file with characters in any supported character encoding to one with ASCII and/or Unicode escapes or vice versa\&. -.SH SYNOPSIS -.sp -.nf - -\fBnative2ascii\fR [ \fIinputfile\fR ] [ \fIoutputfile\fR ] -.fi -.sp -.TP -\fIinputfile\fR -The encoded file to be converted to ASCII\&. -.TP -\fIoutputfile\fR -The converted ASCII file\&. -.SH DESCRIPTION -The \f3native2ascii\fR command converts encoded files supported by the Java Runtime Environment (JRE) to files encoded in ASCII, using Unicode escapes (\f3\eu\fR\fIxxxx\fR) notation for all characters that are not part of the ASCII character set\&. This process is required for properties files that contain characters not in ISO-8859-1 character sets\&. The tool can also perform the reverse conversion\&. -.PP -If the \f3outputfile\fR value is omitted, then standard output is used for output\&. If, in addition, the \f3inputfile\fR value is omitted, then standard input is used for input\&. -.SH OPTIONS -.TP --reverse -.br -Perform the reverse operation: Converts a file encoded in ISO-8859-1 with Unicode escapes to a file in any character encoding supported by the JRE\&. -.TP --encoding \fIencoding_name\fR -.br -Specifies the name of the character encoding to be used by the conversion procedure\&. If this option is not present, then the default character encoding (as determined by the \f3java\&.nio\&.charset\&.Charset\&.defaultCharset\fR method) is used\&. The \f3encoding_name\fR string must be the name of a character encoding that is supported by the JRE\&. See Supported Encodings at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/intl/encoding\&.doc\&.html -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1997, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Internationalization Tools +.\" Title: native2ascii.1 +.\" +.if n .pl 99999 +.TH native2ascii 1 "21 November 2013" "JDK 8" "Internationalization Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +native2ascii \- Creates localizable applications by converting a file with characters in any supported character encoding to one with ASCII and/or Unicode escapes or vice versa\&. +.SH SYNOPSIS +.sp +.nf + +\fBnative2ascii\fR [ \fIinputfile\fR ] [ \fIoutputfile\fR ] +.fi +.sp +.TP +\fIinputfile\fR +The encoded file to be converted to ASCII\&. +.TP +\fIoutputfile\fR +The converted ASCII file\&. +.SH DESCRIPTION +The \f3native2ascii\fR command converts encoded files supported by the Java Runtime Environment (JRE) to files encoded in ASCII, using Unicode escapes (\f3\eu\fR\fIxxxx\fR) notation for all characters that are not part of the ASCII character set\&. This process is required for properties files that contain characters not in ISO-8859-1 character sets\&. The tool can also perform the reverse conversion\&. +.PP +If the \f3outputfile\fR value is omitted, then standard output is used for output\&. If, in addition, the \f3inputfile\fR value is omitted, then standard input is used for input\&. +.SH OPTIONS +.TP +-reverse +.br +Perform the reverse operation: Converts a file encoded in ISO-8859-1 with Unicode escapes to a file in any character encoding supported by the JRE\&. +.TP +-encoding \fIencoding_name\fR +.br +Specifies the name of the character encoding to be used by the conversion procedure\&. If this option is not present, then the default character encoding (as determined by the \f3java\&.nio\&.charset\&.Charset\&.defaultCharset\fR method) is used\&. The \f3encoding_name\fR string must be the name of a character encoding that is supported by the JRE\&. See Supported Encodings at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/intl/encoding\&.doc\&.html +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/orbd.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/orbd.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,213 +1,213 @@ -'\" t -.\" Copyright (c) 2001, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java IDL and RMI-IIOP Tools -.\" Title: orbd.1 -.\" -.if n .pl 99999 -.TH orbd 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -orbd \- Enables clients to locate and call persistent objects on servers in the CORBA environment\&. -.SH SYNOPSIS -.sp -.nf - -\fBorbd\fR [ \fIoptions\fR ] -.fi -.sp -.TP -\fIoptions\fR -Command-line options\&. See Options\&. -.SH DESCRIPTION -The \f3orbd\fR command enables clients to transparently locate and call persistent objects on servers in the CORBA environment\&. The Server Manager included with the orbd tool is used to enable clients to transparently locate and call 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: -.TP 0.2i -\(bu -The object reference in the naming service remains independent of the server life cycle\&. For example, the object reference could be published by the server in the Naming Service when it is first installed, and then, independent of how many times the server is started or shut down, the ORBD returns the correct object reference to the calling client\&. -.TP 0.2i -\(bu -The client needs to look up the object reference in the naming service only once, and can keep reusing this reference independent of the changes introduced due to server life cycle\&. -.PP -To access the ORBD Server Manager, the server must be started using \f3servertool\fR, which is a command-line interface for application programmers to register, unregister, start up, and shut down a persistent server\&. For more information on the Server Manager, see Server Manager\&. -.PP -When \f3orbd\fR starts, it also starts a naming service\&. For more information about the naming service\&. See Start and Stop the Naming Service\&. -.SH OPTIONS -.TP --ORBInitialPort \fInameserverport\fR -.br -Required\&. Specifies the port on which the name server should be started\&. After it is started, \f3orbd\fR listens for incoming requests on this port\&. On Oracle Solaris software, you must become the root user to start a process on a port below 1024\&. For this reason, Oracle recommends that you use a port number above or equal to 1024\&. -.SS NONREQUIRED\ OPTIONS -.TP --port \fIport\fR -.br -Specifies the activation port where ORBD should be started, and where ORBD will be accepting requests for persistent objects\&. The default value for this port is 1049\&. This port number is added to the port field of the persistent Interoperable Object References (IOR)\&. -.TP --defaultdb \fIdirectory\fR -.br -Specifies the base where the ORBD persistent storage directory, \f3orb\&.db\fR, is created\&. If this option is not specified, then the default value is \f3\&./orb\&.db\fR\&. -.TP --serverPollingTime \fImilliseconds\fR -.br -Specifies how often ORBD checks for the health of persistent servers registered through \f3servertool\fR\&. The default value is 1000 ms\&. The value specified for \f3milliseconds\fR must be a valid positive integer\&. -.TP --serverStartupDelay milliseconds -.br -Specifies how long ORBD waits before sending a location forward exception after a persistent server that is registered through \f3servertool\fR is restarted\&. The default value is 1000 ms\&. The value specified for \f3milliseconds\fR must be a valid positive integer\&. -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SS START\ AND\ STOP\ THE\ NAMING\ SERVICE -A naming service is a CORBA service that allows CORBA objects to be named by means of binding a name to an object reference\&. The name binding can be stored in the naming service, and a client can supply the name to obtain the desired object reference\&. -.PP -Before 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\&. -.PP -The Persistent Naming Service provides persistence for naming contexts\&. This means that this information is persistent across service shutdowns and startups, and is recoverable in the event of a service failure\&. If ORBD is restarted, then the Persistent Naming Service restores the naming context graph, so that the binding of all clients\&' and servers\&' names remains intact (persistent)\&. -.PP -For backward compatibility, \f3tnameserv\fR, a Transient Naming Service that shipped with earlier releases of the JDK, is also included in this release of Java SE\&. A transient naming service retains naming contexts as long as it is running\&. If there is a service interruption, then the naming context graph is lost\&. -.PP -The \f3-ORBInitialPort\fR argument is a required command-line argument for \f3orbd\fR, and is used to set the port number on which the naming service runs\&. The following instructions assume you can use port 1050 for the Java IDL Object Request Broker Daemon\&. When using Oracle Solaris software, you must become a root user to start a process on a port lower than 1024\&. For this reason, it is recommended that you use a port number above or equal to 1024\&. You can substitute a different port when necessary\&. -.PP -To start \f3orbd\fR from a UNIX command shell, enter: -.sp -.nf -\f3orbd \-ORBInitialPort 1050&\fP -.fi -.nf -\f3\fP -.fi -.sp -From an MS-DOS system prompt (Windows), enter: -.sp -.nf -\f3start orbd \-ORBInitialPort 1050\fP -.fi -.nf -\f3\fP -.fi -.sp -Now that ORBD is running, you can run your server and client applications\&. When running the client and server applications, they must be made aware of the port number (and machine name, when applicable) where the Naming Service is running\&. One way to do this is to add the following code to your application: -.sp -.nf -\f3Properties props = new Properties();\fP -.fi -.nf -\f3props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP -.fi -.nf -\f3props\&.put("org\&.omg\&.CORBA\&.ORBInitialHost", "MyHost");\fP -.fi -.nf -\f3ORB orb = ORB\&.init(args, props);\fP -.fi -.nf -\f3\fP -.fi -.sp -In this example, the naming service is running on port 1050 on host \f3MyHost\fR\&. Another way is to specify the port number and/or machine name when running the server or client application from the command line\&. For example, you would start your \f3HelloApplication\fR with the following command line: -.sp -.nf -\f3java HelloApplication \-ORBInitialPort 1050 \-ORBInitialHost MyHost\fP -.fi -.nf -\f3\fP -.fi -.sp -To stop the naming service, use the relevant operating system command, such as \f3pkill\fR\f3orbd\fR on Oracle Solaris, or \fICtrl+C\fR in the DOS window in which \f3orbd\fR is running\&. Note that names registered with the naming service can disappear when the service is terminated because of a transient naming service\&. The Java IDL naming service will run until it is explicitly stopped\&. -.PP -For more information about the naming service included with ORBD, see Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html -.SH SERVER\ MANAGER -To access the ORBD Server Manager and run a persistent server, the server must be started with \f3servertool\fR, which is a command-line interface for application programmers to register, unregister, start up, and shut down a persistent server\&. When a server is started using \f3servertool\fR, it must be started on the same host and port on which \f3orbd\fR is executing\&. If the server is run on a different port, then the information stored in the database for local contexts will be invalid and the service will not work properly\&. -.PP -See Java IDL: The "Hello World" Example at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlExample\&.html -.PP -In this example, you run the \f3idlj\fR compiler and \f3javac\fR compiler as shown in the tutorial\&. To run the ORBD Server Manager, follow these steps for running the application: -.PP -Start \f3orbd\fR\&. -.PP -UNIX command shell, enter: \f3orbd -ORBInitialPort 1050\fR\&. -.PP -MS-DOS system prompt (Windows), enter: \f3s\fR\f3tart orbd -ORBInitialPort 105\fR\f30\fR\&. -.PP -Port 1050 is the port on which you want the name server to run\&. The \f3-ORBInitialPort\fR option is a required command-line argument\&. When using Oracle Solaris software, you must become a root user to start a process on a port below 1024\&. For this reason, it is recommended that you use a port number above or equal to 1024\&. -.PP -Start the \f3servertool\fR: \f3servertool -ORBInitialPort 1050\fR\&. -.PP -Make sure the name server (\f3orbd\fR) port is the same as in the previous step, for example, \f3-ORBInitialPort 1050\&.\fR The \f3servertool\fR must be started on the same port as the name server\&. -.PP -In the \f3servertool\fR command line interface, start the \f3Hello\fR server from the \f3servertool\fR prompt: -.sp -.nf -\f3servertool > register \-server HelloServer \-classpath \&. \-applicationName\fP -.fi -.nf -\f3 HelloServerApName\fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3servertool\fR registers the server, assigns it the name \f3HelloServerApName\fR, and displays its server ID with a listing of all registered servers\&.Run the client application from another terminal window or prompt: -.sp -.nf -\f3java HelloClient \-ORBInitialPort 1050 \-ORBInitialHost localhost\fP -.fi -.nf -\f3\fP -.fi -.sp -For this example, you can omit \f3-ORBInitialHost localhost\fR because the name server is running on the same host as the \f3Hello\fR client\&. If the name server is running on a different host, then use the -\f3ORBInitialHost nameserverhost\fR option to specify the host on which the IDL name server is running\&.Specify the name server (\f3orbd\fR) port as done in the previous step, for example, \f3-ORBInitialPort 1050\fR\&. When you finish experimenting with the ORBD Server Manager, be sure to shut down or terminate the name server (\f3orbd\fR) and \f3servertool\fR\&. To shut down \f3orbd\fR from am MS-DOS prompt, select the window that is running the server and enter \fICtrl+C\fR to shut it down\&. -.PP -To shut down \f3orbd\fR from an Oracle Solaris shell, find the process, and terminate with the \f3kill\fR command\&. The server continues to wait for invocations until it is explicitly stopped\&. To shut down the \f3servertool\fR, type \fIquit\fR and press the \fIEnter\fR key\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -servertool(1) -.TP 0.2i -\(bu -Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2001, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java IDL and RMI-IIOP Tools +.\" Title: orbd.1 +.\" +.if n .pl 99999 +.TH orbd 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +orbd \- Enables clients to locate and call persistent objects on servers in the CORBA environment\&. +.SH SYNOPSIS +.sp +.nf + +\fBorbd\fR [ \fIoptions\fR ] +.fi +.sp +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.SH DESCRIPTION +The \f3orbd\fR command enables clients to transparently locate and call persistent objects on servers in the CORBA environment\&. The Server Manager included with the orbd tool is used to enable clients to transparently locate and call 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: +.TP 0.2i +\(bu +The object reference in the naming service remains independent of the server life cycle\&. For example, the object reference could be published by the server in the Naming Service when it is first installed, and then, independent of how many times the server is started or shut down, the ORBD returns the correct object reference to the calling client\&. +.TP 0.2i +\(bu +The client needs to look up the object reference in the naming service only once, and can keep reusing this reference independent of the changes introduced due to server life cycle\&. +.PP +To access the ORBD Server Manager, the server must be started using \f3servertool\fR, which is a command-line interface for application programmers to register, unregister, start up, and shut down a persistent server\&. For more information on the Server Manager, see Server Manager\&. +.PP +When \f3orbd\fR starts, it also starts a naming service\&. For more information about the naming service\&. See Start and Stop the Naming Service\&. +.SH OPTIONS +.TP +-ORBInitialPort \fInameserverport\fR +.br +Required\&. Specifies the port on which the name server should be started\&. After it is started, \f3orbd\fR listens for incoming requests on this port\&. On Oracle Solaris software, you must become the root user to start a process on a port below 1024\&. For this reason, Oracle recommends that you use a port number above or equal to 1024\&. +.SS NONREQUIRED\ OPTIONS +.TP +-port \fIport\fR +.br +Specifies the activation port where ORBD should be started, and where ORBD will be accepting requests for persistent objects\&. The default value for this port is 1049\&. This port number is added to the port field of the persistent Interoperable Object References (IOR)\&. +.TP +-defaultdb \fIdirectory\fR +.br +Specifies the base where the ORBD persistent storage directory, \f3orb\&.db\fR, is created\&. If this option is not specified, then the default value is \f3\&./orb\&.db\fR\&. +.TP +-serverPollingTime \fImilliseconds\fR +.br +Specifies how often ORBD checks for the health of persistent servers registered through \f3servertool\fR\&. The default value is 1000 ms\&. The value specified for \f3milliseconds\fR must be a valid positive integer\&. +.TP +-serverStartupDelay milliseconds +.br +Specifies how long ORBD waits before sending a location forward exception after a persistent server that is registered through \f3servertool\fR is restarted\&. The default value is 1000 ms\&. The value specified for \f3milliseconds\fR must be a valid positive integer\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SS START\ AND\ STOP\ THE\ NAMING\ SERVICE +A naming service is a CORBA service that allows CORBA objects to be named by means of binding a name to an object reference\&. The name binding can be stored in the naming service, and a client can supply the name to obtain the desired object reference\&. +.PP +Before 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\&. +.PP +The Persistent Naming Service provides persistence for naming contexts\&. This means that this information is persistent across service shutdowns and startups, and is recoverable in the event of a service failure\&. If ORBD is restarted, then the Persistent Naming Service restores the naming context graph, so that the binding of all clients\&' and servers\&' names remains intact (persistent)\&. +.PP +For backward compatibility, \f3tnameserv\fR, a Transient Naming Service that shipped with earlier releases of the JDK, is also included in this release of Java SE\&. A transient naming service retains naming contexts as long as it is running\&. If there is a service interruption, then the naming context graph is lost\&. +.PP +The \f3-ORBInitialPort\fR argument is a required command-line argument for \f3orbd\fR, and is used to set the port number on which the naming service runs\&. The following instructions assume you can use port 1050 for the Java IDL Object Request Broker Daemon\&. When using Oracle Solaris software, you must become a root user to start a process on a port lower than 1024\&. For this reason, it is recommended that you use a port number above or equal to 1024\&. You can substitute a different port when necessary\&. +.PP +To start \f3orbd\fR from a UNIX command shell, enter: +.sp +.nf +\f3orbd \-ORBInitialPort 1050&\fP +.fi +.nf +\f3\fP +.fi +.sp +From an MS-DOS system prompt (Windows), enter: +.sp +.nf +\f3start orbd \-ORBInitialPort 1050\fP +.fi +.nf +\f3\fP +.fi +.sp +Now that ORBD is running, you can run your server and client applications\&. When running the client and server applications, they must be made aware of the port number (and machine name, when applicable) where the Naming Service is running\&. One way to do this is to add the following code to your application: +.sp +.nf +\f3Properties props = new Properties();\fP +.fi +.nf +\f3props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP +.fi +.nf +\f3props\&.put("org\&.omg\&.CORBA\&.ORBInitialHost", "MyHost");\fP +.fi +.nf +\f3ORB orb = ORB\&.init(args, props);\fP +.fi +.nf +\f3\fP +.fi +.sp +In this example, the naming service is running on port 1050 on host \f3MyHost\fR\&. Another way is to specify the port number and/or machine name when running the server or client application from the command line\&. For example, you would start your \f3HelloApplication\fR with the following command line: +.sp +.nf +\f3java HelloApplication \-ORBInitialPort 1050 \-ORBInitialHost MyHost\fP +.fi +.nf +\f3\fP +.fi +.sp +To stop the naming service, use the relevant operating system command, such as \f3pkill\fR\f3orbd\fR on Oracle Solaris, or \fICtrl+C\fR in the DOS window in which \f3orbd\fR is running\&. Note that names registered with the naming service can disappear when the service is terminated because of a transient naming service\&. The Java IDL naming service will run until it is explicitly stopped\&. +.PP +For more information about the naming service included with ORBD, see Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html +.SH SERVER\ MANAGER +To access the ORBD Server Manager and run a persistent server, the server must be started with \f3servertool\fR, which is a command-line interface for application programmers to register, unregister, start up, and shut down a persistent server\&. When a server is started using \f3servertool\fR, it must be started on the same host and port on which \f3orbd\fR is executing\&. If the server is run on a different port, then the information stored in the database for local contexts will be invalid and the service will not work properly\&. +.PP +See Java IDL: The "Hello World" Example at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlExample\&.html +.PP +In this example, you run the \f3idlj\fR compiler and \f3javac\fR compiler as shown in the tutorial\&. To run the ORBD Server Manager, follow these steps for running the application: +.PP +Start \f3orbd\fR\&. +.PP +UNIX command shell, enter: \f3orbd -ORBInitialPort 1050\fR\&. +.PP +MS-DOS system prompt (Windows), enter: \f3s\fR\f3tart orbd -ORBInitialPort 105\fR\f30\fR\&. +.PP +Port 1050 is the port on which you want the name server to run\&. The \f3-ORBInitialPort\fR option is a required command-line argument\&. When using Oracle Solaris software, you must become a root user to start a process on a port below 1024\&. For this reason, it is recommended that you use a port number above or equal to 1024\&. +.PP +Start the \f3servertool\fR: \f3servertool -ORBInitialPort 1050\fR\&. +.PP +Make sure the name server (\f3orbd\fR) port is the same as in the previous step, for example, \f3-ORBInitialPort 1050\&.\fR The \f3servertool\fR must be started on the same port as the name server\&. +.PP +In the \f3servertool\fR command line interface, start the \f3Hello\fR server from the \f3servertool\fR prompt: +.sp +.nf +\f3servertool > register \-server HelloServer \-classpath \&. \-applicationName\fP +.fi +.nf +\f3 HelloServerApName\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3servertool\fR registers the server, assigns it the name \f3HelloServerApName\fR, and displays its server ID with a listing of all registered servers\&.Run the client application from another terminal window or prompt: +.sp +.nf +\f3java HelloClient \-ORBInitialPort 1050 \-ORBInitialHost localhost\fP +.fi +.nf +\f3\fP +.fi +.sp +For this example, you can omit \f3-ORBInitialHost localhost\fR because the name server is running on the same host as the \f3Hello\fR client\&. If the name server is running on a different host, then use the -\f3ORBInitialHost nameserverhost\fR option to specify the host on which the IDL name server is running\&.Specify the name server (\f3orbd\fR) port as done in the previous step, for example, \f3-ORBInitialPort 1050\fR\&. When you finish experimenting with the ORBD Server Manager, be sure to shut down or terminate the name server (\f3orbd\fR) and \f3servertool\fR\&. To shut down \f3orbd\fR from am MS-DOS prompt, select the window that is running the server and enter \fICtrl+C\fR to shut it down\&. +.PP +To shut down \f3orbd\fR from an Oracle Solaris shell, find the process, and terminate with the \f3kill\fR command\&. The server continues to wait for invocations until it is explicitly stopped\&. To shut down the \f3servertool\fR, type \fIquit\fR and press the \fIEnter\fR key\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +servertool(1) +.TP 0.2i +\(bu +Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/pack200.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/pack200.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,290 +1,290 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java Deployment Tools -.\" Title: pack200.1 -.\" -.if n .pl 99999 -.TH pack200 1 "21 November 2013" "JDK 8" "Java Deployment Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -pack200 \- Packages a JAR file into a compressed pack200 file for web deployment\&. -.SH SYNOPSIS -.sp -.nf - -\fBpack200\fR [\fIoptions\fR] \fIoutput\-file\fR \fIJAR\-file\fR -.fi -.sp -Options can be in any order\&. The last option on the command line or in a properties file supersedes all previously specified options\&. -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIoutput-file\fR -Name of the output file\&. -.TP -\fIJAR-file\fR -Name of the input file\&. -.SH DESCRIPTION -The \f3pack200\fR command is a Java application that transforms a JAR file into a compressed pack200 file with the Java gzip compressor\&. The pack200 files are highly compressed files that can be directly deployed to save bandwidth and reduce download time\&. -.PP -The \f3pack200\fR command has several options to fine-tune and set the compression engine\&. The typical usage is shown in the following example, where \f3myarchive\&.pack\&.gz\fR is produced with the default \f3pack200\fR command settings: -.sp -.nf -\f3pack200 myarchive\&.pack\&.gz myarchive\&.jar\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH OPTIONS -.TP --r, --repack -.br -Produces a JAR file by packing and unpacking a JAR file\&. The resulting file can be used as an input to the \f3jarsigner\fR(1) tool\&. The following example packs and unpacks the myarchive\&.jar file: -.sp -.nf -\f3pack200 \-\-repack myarchive\-packer\&.jar myarchive\&.jar\fP -.fi -.nf -\f3pack200 \-\-repack myarchive\&.jar\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The following example preserves the order of files in the input file\&. -.TP --g, --no-gzip -.br -Produces a \f3pack200\fR file\&. With this option, a suitable compressor must be used, and the target system must use a corresponding decompresser\&. -.sp -.nf -\f3pack200 \-\-no\-gzip myarchive\&.pack myarchive\&.jar\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --G, --strip-debug -.br -Strips debugging attributes from the output\&. These include \f3SourceFile\fR, \f3LineNumberTable\fR, \f3LocalVariableTable\fR and \f3LocalVariableTypeTable\fR\&. Removing these attributes reduces the size of both downloads and installations, but reduces the usefulness of debuggers\&. -.TP ---keep-file-order -.br -Preserve the order of files in the input file\&. This is the default behavior\&. -.TP --O, --no-keep-file-order -.br -The packer reorders and transmits all elements\&. The packer can also remove JAR directory names to reduce the download size\&. However, certain JAR file optimizations, such as indexing, might not work correctly\&. -.TP --S\fIvalue\fR , --segment-limit=\fIvalue\fR -.br -The value is the estimated target size \fIN\fR (in bytes) of each archive segment\&. If a single input file requires more than \fIN\fR bytes, then its own archive segment is provided\&. As a special case, a value of \f3-1\fR produces a single large segment with all input files, while a value of 0 produces one segment for each class\&. Larger archive segments result in less fragmentation and better compression, but processing them requires more memory\&. - -The size of each segment is estimated by counting the size of each input file to be transmitted in the segment with the size of its name and other transmitted properties\&. - -The default is -1, which means that the packer creates 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\&. - -A 10 MB JAR packed without this limit typically packs about 10 percent smaller, but the packer might require a larger Java heap (about 10 times the segment limit)\&. -.TP --E\fIvalue\fR , --effort=\fIvalue\fR -.br -If the value is set to a single decimal digit, then the packer uses the indicated amount of effort in compressing the archive\&. Level 1 might produce somewhat larger size and faster compression speed, while level 9 takes much longer, but can produce better compression\&. The special value 0 instructs the \f3pack200\fR command 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\&. - -The default is 5, to invest a modest amount of time to produce reasonable compression\&. -.TP --H\fIvalue\fR , --deflate-hint=\fIvalue\fR -.br -Overrides the default, which preserves the input information, but can cause the transmitted archive to be larger\&. The possible values are: \f3true\fR, \f3false\fR, or \f3keep\fR\&. - -If the \f3value\fR is \f3true\fR or false, then the \f3packer200\fR command sets the deflation hint accordingly in the output archive and does not transmit the individual deflation hints of archive elements\&. - -The \f3keep\fR value preserves deflation hints observed in the input JAR\&. This is the default\&. -.TP --m\fIvalue\fR , --modification-time=\fIvalue\fR -.br -The possible values are \f3latest\fR and \f3keep\fR\&. - -If the value is latest, then the packer attempts to determine the latest modification time, among all the available entries in the original archive, or the latest modification time of all the available entries in that segment\&. This single value is transmitted as part of the segment and applied to all the entries in each segment\&. This can marginally decrease the transmitted size of the archive at the expense of setting all installed files to a single date\&. - -If the value is \f3keep\fR, then modification times observed in the input JAR are preserved\&. This is the default\&. -.TP --P\fIfile\fR , --pass-file=\fIfile\fR -.br -Indicates that a file should be passed through bytewise with no compression\&. By repeating the option, multiple files can be specified\&. There is no pathname transformation, except that the system file separator is replaced by the JAR file separator forward slash (/)\&. The resulting file names must match exactly as strings with their occurrences in the JAR file\&. If \f3file\fR is a directory name, then all files under that directory are passed\&. -.TP --U\fIaction\fR , --unknown-attribute=\fIaction\fR -.br -Overrides the default behavior, which means that the class file that contains the unknown attribute is passed through with the specified \f3action\fR\&. The possible values for actions are \f3error\fR, \f3strip\fR, or \f3pass\fR\&. - -If the value is \f3error\fR, then the entire \f3pack200\fR command operation fails with a suitable explanation\&. - -If the value is \f3strip\fR, then the attribute is dropped\&. Removing the required Java Virtual Machine (JVM) attributes can cause class loader failures\&. - -If the value is \f3pass\fR, then the entire class is transmitted as though it is a resource\&. -.TP -.nf --C\fIattribute-name\fR=\fIlayout\fR , --class-attribute=\fIattribute-name\fR=\fIaction\fR -.br -.fi -See next option\&. -.TP -.nf --F\fIattribute-name\fR=\fIlayout\fR , --field-attribute=\fIattribute-name\fR=\fIaction\fR -.br -.fi -See next option\&. -.TP -.nf --M\fIattribute-name\fR=\fIlayout\fR , --method-attribute=\fIattribute-name\fR=\fIaction\fR -.br -.fi -See next option\&. -.TP -.nf --D\fIattribute-name\fR=\fIlayout\fR , --code-attribute=\fIattribute-name\fR=\fIaction\fR -.br -.fi -With the previous four options, the attribute layout can be specified for a class entity, such as \f3class-attribute\fR, \f3field-attribute\fR, \f3method-attribute\fR, and \f3code-attribute\fR\&. The \fIattribute-name\fR is the name of the attribute for which the layout or action is being defined\&. The possible values for \fIaction\fR are \f3some-layout-string\fR, \f3error\fR, \f3strip\fR, \f3pass\fR\&. - -\f3some-layout-string\fR: The layout language is defined in the JSR 200 specification, for example: \f3--class-attribute=SourceFile=RUH\fR\&. - -If the value is \f3error\fR, then the \f3pack200\fR operation fails with an explanation\&. - -If the value is \f3strip\fR, then the attribute is removed from the output\&. Removing JVM-required attributes can cause class loader failures\&. For example, \f3--class-attribute=CompilationID=pass\fR causes the class file that contains this attribute to be passed through without further action by the packer\&. - -If the value is \f3pass\fR, then the entire class is transmitted as though it is a resource\&. -.TP --f \fIpack\&.properties\fR , --config-file=\fIpack\&.properties\fR -.br -A configuration file, containing Java properties to initialize the packer, can be specified on the command line\&. -.sp -.nf -\f3pack200 \-f pack\&.properties myarchive\&.pack\&.gz myarchive\&.jar\fP -.fi -.nf -\f3more pack\&.properties\fP -.fi -.nf -\f3# Generic properties for the packer\&.\fP -.fi -.nf -\f3modification\&.time=latest\fP -.fi -.nf -\f3deflate\&.hint=false\fP -.fi -.nf -\f3keep\&.file\&.order=false\fP -.fi -.nf -\f3# This option will cause the files bearing new attributes to\fP -.fi -.nf -\f3# be reported as an error rather than passed uncompressed\&.\fP -.fi -.nf -\f3unknown\&.attribute=error\fP -.fi -.nf -\f3# Change the segment limit to be unlimited\&.\fP -.fi -.nf -\f3segment\&.limit=\-1\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --v, --verbose -.br -Outputs minimal messages\&. Multiple specification of this option will create more verbose messages\&. -.TP --q, --quiet -.br -Specifies quiet operation with no messages\&. -.TP --l\fIfilename\fR , --log-file=\fIfilename\fR -.br -Specifies a log file to output messages\&. -.TP --?, -h, --help -.br -Prints help information about this command\&. -.TP --V, --version -.br -Prints version information about this command\&. -.TP --J\fIoption\fR -.br -Passes the specified option to the Java Virtual Machine\&. For more information, see the reference page for the java(1) command\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. -.SH EXIT\ STATUS -The following exit values are returned: 0 for successful completion and a number greater than 0 when an error occurs\&. -.SH NOTES -This command should not be confused with \f3pack\fR(1)\&. The \f3pack\fR and \f3pack200\fR commands are separate products\&. -.PP -The Java SE API Specification provided with the JDK is the superseding authority, when there are discrepancies\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -unpack200(1) -.TP 0.2i -\(bu -jar(1) -.TP 0.2i -\(bu -jarsigner(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Deployment Tools +.\" Title: pack200.1 +.\" +.if n .pl 99999 +.TH pack200 1 "21 November 2013" "JDK 8" "Java Deployment Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +pack200 \- Packages a JAR file into a compressed pack200 file for web deployment\&. +.SH SYNOPSIS +.sp +.nf + +\fBpack200\fR [\fIoptions\fR] \fIoutput\-file\fR \fIJAR\-file\fR +.fi +.sp +Options can be in any order\&. The last option on the command line or in a properties file supersedes all previously specified options\&. +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIoutput-file\fR +Name of the output file\&. +.TP +\fIJAR-file\fR +Name of the input file\&. +.SH DESCRIPTION +The \f3pack200\fR command is a Java application that transforms a JAR file into a compressed pack200 file with the Java gzip compressor\&. The pack200 files are highly compressed files that can be directly deployed to save bandwidth and reduce download time\&. +.PP +The \f3pack200\fR command has several options to fine-tune and set the compression engine\&. The typical usage is shown in the following example, where \f3myarchive\&.pack\&.gz\fR is produced with the default \f3pack200\fR command settings: +.sp +.nf +\f3pack200 myarchive\&.pack\&.gz myarchive\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-r, --repack +.br +Produces a JAR file by packing and unpacking a JAR file\&. The resulting file can be used as an input to the \f3jarsigner\fR(1) tool\&. The following example packs and unpacks the myarchive\&.jar file: +.sp +.nf +\f3pack200 \-\-repack myarchive\-packer\&.jar myarchive\&.jar\fP +.fi +.nf +\f3pack200 \-\-repack myarchive\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following example preserves the order of files in the input file\&. +.TP +-g, --no-gzip +.br +Produces a \f3pack200\fR file\&. With this option, a suitable compressor must be used, and the target system must use a corresponding decompresser\&. +.sp +.nf +\f3pack200 \-\-no\-gzip myarchive\&.pack myarchive\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-G, --strip-debug +.br +Strips debugging attributes from the output\&. These include \f3SourceFile\fR, \f3LineNumberTable\fR, \f3LocalVariableTable\fR and \f3LocalVariableTypeTable\fR\&. Removing these attributes reduces the size of both downloads and installations, but reduces the usefulness of debuggers\&. +.TP +--keep-file-order +.br +Preserve the order of files in the input file\&. This is the default behavior\&. +.TP +-O, --no-keep-file-order +.br +The packer reorders and transmits all elements\&. The packer can also remove JAR directory names to reduce the download size\&. However, certain JAR file optimizations, such as indexing, might not work correctly\&. +.TP +-S\fIvalue\fR , --segment-limit=\fIvalue\fR +.br +The value is the estimated target size \fIN\fR (in bytes) of each archive segment\&. If a single input file requires more than \fIN\fR bytes, then its own archive segment is provided\&. As a special case, a value of \f3-1\fR produces a single large segment with all input files, while a value of 0 produces one segment for each class\&. Larger archive segments result in less fragmentation and better compression, but processing them requires more memory\&. + +The size of each segment is estimated by counting the size of each input file to be transmitted in the segment with the size of its name and other transmitted properties\&. + +The default is -1, which means that the packer creates 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\&. + +A 10 MB JAR packed without this limit typically packs about 10 percent smaller, but the packer might require a larger Java heap (about 10 times the segment limit)\&. +.TP +-E\fIvalue\fR , --effort=\fIvalue\fR +.br +If the value is set to a single decimal digit, then the packer uses the indicated amount of effort in compressing the archive\&. Level 1 might produce somewhat larger size and faster compression speed, while level 9 takes much longer, but can produce better compression\&. The special value 0 instructs the \f3pack200\fR command 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\&. + +The default is 5, to invest a modest amount of time to produce reasonable compression\&. +.TP +-H\fIvalue\fR , --deflate-hint=\fIvalue\fR +.br +Overrides the default, which preserves the input information, but can cause the transmitted archive to be larger\&. The possible values are: \f3true\fR, \f3false\fR, or \f3keep\fR\&. + +If the \f3value\fR is \f3true\fR or false, then the \f3packer200\fR command sets the deflation hint accordingly in the output archive and does not transmit the individual deflation hints of archive elements\&. + +The \f3keep\fR value preserves deflation hints observed in the input JAR\&. This is the default\&. +.TP +-m\fIvalue\fR , --modification-time=\fIvalue\fR +.br +The possible values are \f3latest\fR and \f3keep\fR\&. + +If the value is latest, then the packer attempts to determine the latest modification time, among all the available entries in the original archive, or the latest modification time of all the available entries in that segment\&. This single value is transmitted as part of the segment and applied to all the entries in each segment\&. This can marginally decrease the transmitted size of the archive at the expense of setting all installed files to a single date\&. + +If the value is \f3keep\fR, then modification times observed in the input JAR are preserved\&. This is the default\&. +.TP +-P\fIfile\fR , --pass-file=\fIfile\fR +.br +Indicates that a file should be passed through bytewise with no compression\&. By repeating the option, multiple files can be specified\&. There is no pathname transformation, except that the system file separator is replaced by the JAR file separator forward slash (/)\&. The resulting file names must match exactly as strings with their occurrences in the JAR file\&. If \f3file\fR is a directory name, then all files under that directory are passed\&. +.TP +-U\fIaction\fR , --unknown-attribute=\fIaction\fR +.br +Overrides the default behavior, which means that the class file that contains the unknown attribute is passed through with the specified \f3action\fR\&. The possible values for actions are \f3error\fR, \f3strip\fR, or \f3pass\fR\&. + +If the value is \f3error\fR, then the entire \f3pack200\fR command operation fails with a suitable explanation\&. + +If the value is \f3strip\fR, then the attribute is dropped\&. Removing the required Java Virtual Machine (JVM) attributes can cause class loader failures\&. + +If the value is \f3pass\fR, then the entire class is transmitted as though it is a resource\&. +.TP +.nf +-C\fIattribute-name\fR=\fIlayout\fR , --class-attribute=\fIattribute-name\fR=\fIaction\fR +.br +.fi +See next option\&. +.TP +.nf +-F\fIattribute-name\fR=\fIlayout\fR , --field-attribute=\fIattribute-name\fR=\fIaction\fR +.br +.fi +See next option\&. +.TP +.nf +-M\fIattribute-name\fR=\fIlayout\fR , --method-attribute=\fIattribute-name\fR=\fIaction\fR +.br +.fi +See next option\&. +.TP +.nf +-D\fIattribute-name\fR=\fIlayout\fR , --code-attribute=\fIattribute-name\fR=\fIaction\fR +.br +.fi +With the previous four options, the attribute layout can be specified for a class entity, such as \f3class-attribute\fR, \f3field-attribute\fR, \f3method-attribute\fR, and \f3code-attribute\fR\&. The \fIattribute-name\fR is the name of the attribute for which the layout or action is being defined\&. The possible values for \fIaction\fR are \f3some-layout-string\fR, \f3error\fR, \f3strip\fR, \f3pass\fR\&. + +\f3some-layout-string\fR: The layout language is defined in the JSR 200 specification, for example: \f3--class-attribute=SourceFile=RUH\fR\&. + +If the value is \f3error\fR, then the \f3pack200\fR operation fails with an explanation\&. + +If the value is \f3strip\fR, then the attribute is removed from the output\&. Removing JVM-required attributes can cause class loader failures\&. For example, \f3--class-attribute=CompilationID=pass\fR causes the class file that contains this attribute to be passed through without further action by the packer\&. + +If the value is \f3pass\fR, then the entire class is transmitted as though it is a resource\&. +.TP +-f \fIpack\&.properties\fR , --config-file=\fIpack\&.properties\fR +.br +A configuration file, containing Java properties to initialize the packer, can be specified on the command line\&. +.sp +.nf +\f3pack200 \-f pack\&.properties myarchive\&.pack\&.gz myarchive\&.jar\fP +.fi +.nf +\f3more pack\&.properties\fP +.fi +.nf +\f3# Generic properties for the packer\&.\fP +.fi +.nf +\f3modification\&.time=latest\fP +.fi +.nf +\f3deflate\&.hint=false\fP +.fi +.nf +\f3keep\&.file\&.order=false\fP +.fi +.nf +\f3# This option will cause the files bearing new attributes to\fP +.fi +.nf +\f3# be reported as an error rather than passed uncompressed\&.\fP +.fi +.nf +\f3unknown\&.attribute=error\fP +.fi +.nf +\f3# Change the segment limit to be unlimited\&.\fP +.fi +.nf +\f3segment\&.limit=\-1\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-v, --verbose +.br +Outputs minimal messages\&. Multiple specification of this option will create more verbose messages\&. +.TP +-q, --quiet +.br +Specifies quiet operation with no messages\&. +.TP +-l\fIfilename\fR , --log-file=\fIfilename\fR +.br +Specifies a log file to output messages\&. +.TP +-?, -h, --help +.br +Prints help information about this command\&. +.TP +-V, --version +.br +Prints version information about this command\&. +.TP +-J\fIoption\fR +.br +Passes the specified option to the Java Virtual Machine\&. For more information, see the reference page for the java(1) command\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. +.SH EXIT\ STATUS +The following exit values are returned: 0 for successful completion and a number greater than 0 when an error occurs\&. +.SH NOTES +This command should not be confused with \f3pack\fR(1)\&. The \f3pack\fR and \f3pack200\fR commands are separate products\&. +.PP +The Java SE API Specification provided with the JDK is the superseding authority, when there are discrepancies\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +unpack200(1) +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +jarsigner(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/policytool.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/policytool.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,114 +1,114 @@ -'\" t -.\" Copyright (c) 2001, 2015, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 03 March 2015 -.\" SectDesc: Security Tools -.\" Title: policytool.1 -.\" -.if n .pl 99999 -.TH policytool 1 "03 March 2015" "JDK 8" "Security Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -policytool \- Reads and writes a plain text policy file based on user input through the utility GUI\&. -.SH SYNOPSIS -.sp -.nf - -\fBpolicytool\fR [ \fB\-file\fR ] [ \fIfilename\fR ] -.fi -.sp -.TP --file -.br -Directs the \f3policytool\fR command to load a policy file\&. -.TP -\fIfilename\fR -The name of the file to be loaded\&. -.PP -\fIExamples\fR: -.PP -Run the policy tool administrator utility: -.sp -.nf -\f3policytool\fP -.fi -.nf -\f3\fP -.fi -.sp -Run the \f3policytool\fR command and load the specified file: -.sp -.nf -\f3policytool \-file \fImypolicyfile\fR\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH DESCRIPTION -The \f3policytool\fR command calls an administrator\&'s GUI that enables system administrators to manage the contents of local policy files\&. A policy file is a plain-text file with a \f3\&.policy\fR extension, that maps remote requestors by domain, to permission objects\&. For details, see Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html -.SH OPTIONS -.TP --file -.br -Directs the \f3policytool\fR command to load a policy file\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html -.TP 0.2i -\(bu -Policy File Creation and Management at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyGuide\&.html -.TP 0.2i -\(bu -Permissions in Java SE Development Kit (JDK) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/permissions\&.html -.TP 0.2i -\(bu -Java Security Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/overview/jsoverview\&.html -.TP 0.2i -\(bu -Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2001, 2015, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 03 March 2015 +.\" SectDesc: Security Tools +.\" Title: policytool.1 +.\" +.if n .pl 99999 +.TH policytool 1 "03 March 2015" "JDK 8" "Security Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +policytool \- Reads and writes a plain text policy file based on user input through the utility GUI\&. +.SH SYNOPSIS +.sp +.nf + +\fBpolicytool\fR [ \fB\-file\fR ] [ \fIfilename\fR ] +.fi +.sp +.TP +-file +.br +Directs the \f3policytool\fR command to load a policy file\&. +.TP +\fIfilename\fR +The name of the file to be loaded\&. +.PP +\fIExamples\fR: +.PP +Run the policy tool administrator utility: +.sp +.nf +\f3policytool\fP +.fi +.nf +\f3\fP +.fi +.sp +Run the \f3policytool\fR command and load the specified file: +.sp +.nf +\f3policytool \-file \fImypolicyfile\fR\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH DESCRIPTION +The \f3policytool\fR command calls an administrator\&'s GUI that enables system administrators to manage the contents of local policy files\&. A policy file is a plain-text file with a \f3\&.policy\fR extension, that maps remote requestors by domain, to permission objects\&. For details, see Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html +.SH OPTIONS +.TP +-file +.br +Directs the \f3policytool\fR command to load a policy file\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html +.TP 0.2i +\(bu +Policy File Creation and Management at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyGuide\&.html +.TP 0.2i +\(bu +Permissions in Java SE Development Kit (JDK) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/permissions\&.html +.TP 0.2i +\(bu +Java Security Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/overview/jsoverview\&.html +.TP 0.2i +\(bu +Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/rmic.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/rmic.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,223 +1,223 @@ -'\" t -.\" Copyright (c) 1997, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Remote Method Invocation (RMI) Tools -.\" Title: rmic.1 -.\" -.if n .pl 99999 -.TH rmic 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -rmic \- Generates stub, skeleton, and tie classes for remote objects that use the Java Remote Method Protocol (JRMP) or Internet Inter-Orb protocol (IIOP)\&. Also generates Object Management Group (OMG) Interface Definition Language (IDL) -.SH SYNOPSIS -.sp -.nf - -\fBrmic\fR [ \fIoptions\fR ] \fIpackage\-qualified\-class\-names\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line \f3options\fR\&. See Options\&. -.TP -\fIpackage-qualified-class-names\fR -Class names that include their packages, for example, \f3java\&.awt\&.Color\fR\&. -.SH DESCRIPTION -\fIDeprecation Note:\fR Support for static generation of Java Remote Method Protocol (JRMP) stubs and skeletons has been deprecated\&. Oracle recommends that you use dynamically generated JRMP stubs instead, eliminating the need to use this tool for JRMP-based applications\&. See the \f3java\&.rmi\&.server\&.UnicastRemoteObject\fR specification at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/server/UnicastRemoteObject\&.html for further information\&. -.PP -The \f3rmic\fR compiler generates stub and skeleton class files using the Java Remote Method Protocol (JRMP) and stub and tie class files (IIOP protocol) for remote objects\&. These class 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 \f3java\&.rmi\&.Remote\fR\&. The class names in the \f3rmic\fR command must be for classes that were compiled successfully with the \f3javac\fR command and must be fully package qualified\&. For example, running the \f3rmic\fR command on the class file name \f3HelloImpl\fR as shown here creates the \f3HelloImpl_Stub\&.class\fRfile in the hello subdirectory (named for the class\&'s package): -.sp -.nf -\f3rmic hello\&.HelloImpl\fP -.fi -.nf -\f3\fP -.fi -.sp -A skeleton for a remote object is a JRMP protocol server-side entity that has a method that dispatches calls to the remote object implementation\&. -.PP -A tie for a remote object is a server-side entity similar to a skeleton, but communicates with the client with the IIOP protocol\&. -.PP -A stub is a client-side proxy for a remote object that is responsible for communicating method invocations on remote objects to the server where the actual remote object implementation resides\&. A client\&'s reference to a remote object, therefore, is actually a reference to a local stub\&. -.PP -By default, the \f3rmic\fR command generates stub classes that use the 1\&.2 JRMP stub protocol version only, as though the \f3-v1\&.2\fR option was specified\&. The \f3-vcompat\fR option was the default in releases before 5\&.0\&. Use the \f3-iiop\fR option to generate stub and tie classes for the IIOP protocol\&. See Options\&. -.PP -A stub implements only the remote interfaces, and 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, a client can use the Java programming language built-in operators for casting and type checking\&. For IIOP, the \f3PortableRemoteObject\&.narrow\fR method must be used\&. -.SH OPTIONS -.TP --bootclasspath \fIpath\fR -.br -Overrides the location of bootstrap class files\&. -.TP --classpath path -.br -Specifies the path the \f3rmic\fR command uses to look up classes\&. This option overrides the default or the \f3CLASSPATH\fR environment variable when it is set\&. Directories are separated by colons\&. The general format for path is: \f3\&.:<your_path>\fR, for example: \f3\&.:/usr/local/java/classes\fR\&. -.TP --d \fIdirectory\fR -.br -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 following command places the stub and skeleton classes derived from MyClass into the directory /java/classes/exampleclass\&. -.sp -.nf -\f3rmic \-d /java/classes exampleclass\&.MyClass\fP -.fi -.nf -\f3\fP -.fi -.sp - - -If the \f3-d\fR option is not specified, then the default behavior is as if \f3-d \&.\fR was specified\&. The package hierarchy of the target class is created in the current directory, and stub/tie/skeleton files are placed within it\&. In some earlier releases of the \f3rmic\fR command, if the \f3-d\fR option was not specified, then the package hierarchy was not created, and all of the output files were placed directly in the current directory\&. -.TP --extdirs \fIpath\fR -.br -Overrides the location of installed extensions\&. -.TP --g -.br -Enables the generation of all debugging information, including local variables\&. By default, only line number information is generated\&. -.TP --idl -.br -Causes the \f3rmic\fR command to generate OMG IDL for the classes specified and any classes referenced\&. IDL provides a purely declarative, programming language-independent way to specify an API for an object\&. The IDL is used as a specification for methods and data that can be written in and called from any language that provides CORBA bindings\&. This includes Java and C++ among others\&. See Java IDL: IDL to Java Language Mapping at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/mapping/jidlMapping\&.html - -When the \f3-idl\fR option is used, other options also include: -.RS -.TP 0.2i -\(bu -The \f3-always\fR or \f3-alwaysgenerate\fR options force regeneration even when existing stubs/ties/IDL are newer than the input class\&. -.TP 0.2i -\(bu -The \f3-factory\fR option uses the \f3factory\fR keyword in generated IDL\&. -.TP 0.2i -\(bu -The \f3-idlModule\fR from J\f3avaPackage[\&.class]\fR\f3toIDLModule\fR specifies \f3IDLEntity\fR package mapping, for example: \f3-idlModule\fR\f3my\&.module my::real::idlmod\fR\&. -.TP 0.2i -\(bu -\f3-idlFile\fR\f3fromJavaPackage[\&.class] toIDLFile\fR specifies \f3IDLEntity\fR file mapping, for example: \f3-idlFile test\&.pkg\&.X TEST16\&.idl\fR\&. -.RE - -.TP --iiop -.br -Causes the \f3rmic\fR command 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 reference to a remote object is 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\&. - -If you call the \f3rmic\fR command with the \f3-iiop\fR, then it generates stubs and ties that conform to this naming convention: -.sp -.nf -\f3_<implementationName>_stub\&.class\fP -.fi -.nf -\f3_<interfaceName>_tie\&.class\fP -.fi -.nf -\f3\fP -.fi -.sp -.RS -.TP 0.2i -\(bu -When you use the \f3-iiop\fR option, other options also include: -.TP 0.2i -\(bu -The \f3-always\fR or \f3-alwaysgenerate\fR options force regeneration even when existing stubs/ties/IDL are newer than the input class\&. -.TP 0.2i -\(bu -The \f3-nolocalstubs\fR option means do not create stubs optimized for same-process clients and servers\&. -.TP 0.2i -\(bu -The \f3-noValueMethods\fR option must be used with the \f3-idl\fR option\&. The \f3-noValueMethods\fR option prevents the addition of \f3valuetype\fR methods and initializers to emitted IDL\&. These methods and initializers are optional for valuetypes, and are generated unless the \f3-noValueMethods\fR option is specified with the \f3-idl\fR option\&. -.TP 0.2i -\(bu -The \f3-poa\fR option changes the inheritance from \f3org\&.omg\&.CORBA_2_3\&.portable\&.ObjectImpl\fR to \f3org\&.omg\&.PortableServer\&.Servant\fR\&. The \f3PortableServer\fR module for the Portable Object Adapter (POA) defines the native \f3Servant\fR type\&. In the Java programming language, the \f3Servant\fR type is mapped to the \f3Java org\&.omg\&.PortableServer\&.Servant\fR class\&. It serves as the base class for all POA servant implementations and provides a number of methods that can be called by the application programmer, and methods that are called by the POA and that can 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 --J -.br -Used with any Java command, the \f3-J\fR option passes the argument that follows the \f3-J\fR (no spaces between the \f3-J\fRand the argument) to the Java interpreter -.TP --keep or -keepgenerated -.br -Retains the generated \f3\&.java\fR source files for the stub, skeleton, and tie classes and writes them to the same directory as the\f3\&.class\fR files\&. -.TP --nowarn -.br -Turns off warnings\&. When the \f3-nowarn\fR options is used\&. The compiler does not print out any warnings\&. -.TP --nowrite -.br -Does not write compiled classes to the file system\&. -.TP --vcompat (deprecated) -.br -Generates stub and skeleton classes that are compatible with both the 1\&.1 and 1\&.2 JRMP stub protocol versions\&. This option was the default in releases before 5\&.0\&. The generated stub classes use the 1\&.1 stub protocol version when loaded in a JDK 1\&.1 virtual machine and use the 1\&.2 stub protocol version when loaded into a 1\&.2 (or later) virtual machine\&. The generated skeleton classes support both 1\&.1 and 1\&.2 stub protocol versions\&. The generated classes are relatively large to support both modes of operation\&. Note: This option has been deprecated\&. See Description\&. -.TP --verbose -.br -Causes the compiler and linker to print out messages about what classes are being compiled and what class files are being loaded\&. -.TP --v1\&.1 (deprecated) -.br -Generates stub and skeleton classes for the 1\&.1 JRMP stub protocol version only\&. The \f3-v1\&.1\fR option is only useful for generating stub classes that are serialization-compatible with preexisting, statically deployed stub classes that were generated by the \f3rmic\fR command from JDK 1\&.1 and that cannot be upgraded (and dynamic class loading is not being used)\&. Note: This option has been deprecated\&. See Description\&. -.TP --v1\&.2 (deprecated) -.br -(Default) Generates stub classes for the 1\&.2 JRMP stub protocol version only\&. No skeleton classes are generated because skeleton classes are not used with the 1\&.2 stub protocol version\&. The generated stub classes do not work when they are loaded into a JDK 1\&.1 virtual machine\&. Note: This option has been deprecated\&. See Description\&. -.SH ENVIRONMENT\ VARIABLES -.TP -CLASSPATH -Used to provide the system a path to user-defined classes\&. Directories are separated by colons, for example: \f3\&.:/usr/local/java/classes\fR\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -javac(1) -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -Setting the Class Path -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1997, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Remote Method Invocation (RMI) Tools +.\" Title: rmic.1 +.\" +.if n .pl 99999 +.TH rmic 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +rmic \- Generates stub, skeleton, and tie classes for remote objects that use the Java Remote Method Protocol (JRMP) or Internet Inter-Orb protocol (IIOP)\&. Also generates Object Management Group (OMG) Interface Definition Language (IDL) +.SH SYNOPSIS +.sp +.nf + +\fBrmic\fR [ \fIoptions\fR ] \fIpackage\-qualified\-class\-names\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line \f3options\fR\&. See Options\&. +.TP +\fIpackage-qualified-class-names\fR +Class names that include their packages, for example, \f3java\&.awt\&.Color\fR\&. +.SH DESCRIPTION +\fIDeprecation Note:\fR Support for static generation of Java Remote Method Protocol (JRMP) stubs and skeletons has been deprecated\&. Oracle recommends that you use dynamically generated JRMP stubs instead, eliminating the need to use this tool for JRMP-based applications\&. See the \f3java\&.rmi\&.server\&.UnicastRemoteObject\fR specification at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/server/UnicastRemoteObject\&.html for further information\&. +.PP +The \f3rmic\fR compiler generates stub and skeleton class files using the Java Remote Method Protocol (JRMP) and stub and tie class files (IIOP protocol) for remote objects\&. These class 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 \f3java\&.rmi\&.Remote\fR\&. The class names in the \f3rmic\fR command must be for classes that were compiled successfully with the \f3javac\fR command and must be fully package qualified\&. For example, running the \f3rmic\fR command on the class file name \f3HelloImpl\fR as shown here creates the \f3HelloImpl_Stub\&.class\fRfile in the hello subdirectory (named for the class\&'s package): +.sp +.nf +\f3rmic hello\&.HelloImpl\fP +.fi +.nf +\f3\fP +.fi +.sp +A skeleton for a remote object is a JRMP protocol server-side entity that has a method that dispatches calls to the remote object implementation\&. +.PP +A tie for a remote object is a server-side entity similar to a skeleton, but communicates with the client with the IIOP protocol\&. +.PP +A stub is a client-side proxy for a remote object that is responsible for communicating method invocations on remote objects to the server where the actual remote object implementation resides\&. A client\&'s reference to a remote object, therefore, is actually a reference to a local stub\&. +.PP +By default, the \f3rmic\fR command generates stub classes that use the 1\&.2 JRMP stub protocol version only, as though the \f3-v1\&.2\fR option was specified\&. The \f3-vcompat\fR option was the default in releases before 5\&.0\&. Use the \f3-iiop\fR option to generate stub and tie classes for the IIOP protocol\&. See Options\&. +.PP +A stub implements only the remote interfaces, and 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, a client can use the Java programming language built-in operators for casting and type checking\&. For IIOP, the \f3PortableRemoteObject\&.narrow\fR method must be used\&. +.SH OPTIONS +.TP +-bootclasspath \fIpath\fR +.br +Overrides the location of bootstrap class files\&. +.TP +-classpath path +.br +Specifies the path the \f3rmic\fR command uses to look up classes\&. This option overrides the default or the \f3CLASSPATH\fR environment variable when it is set\&. Directories are separated by colons\&. The general format for path is: \f3\&.:<your_path>\fR, for example: \f3\&.:/usr/local/java/classes\fR\&. +.TP +-d \fIdirectory\fR +.br +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 following command places the stub and skeleton classes derived from MyClass into the directory /java/classes/exampleclass\&. +.sp +.nf +\f3rmic \-d /java/classes exampleclass\&.MyClass\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If the \f3-d\fR option is not specified, then the default behavior is as if \f3-d \&.\fR was specified\&. The package hierarchy of the target class is created in the current directory, and stub/tie/skeleton files are placed within it\&. In some earlier releases of the \f3rmic\fR command, if the \f3-d\fR option was not specified, then the package hierarchy was not created, and all of the output files were placed directly in the current directory\&. +.TP +-extdirs \fIpath\fR +.br +Overrides the location of installed extensions\&. +.TP +-g +.br +Enables the generation of all debugging information, including local variables\&. By default, only line number information is generated\&. +.TP +-idl +.br +Causes the \f3rmic\fR command to generate OMG IDL for the classes specified and any classes referenced\&. IDL provides a purely declarative, programming language-independent way to specify an API for an object\&. The IDL is used as a specification for methods and data that can be written in and called from any language that provides CORBA bindings\&. This includes Java and C++ among others\&. See Java IDL: IDL to Java Language Mapping at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/mapping/jidlMapping\&.html + +When the \f3-idl\fR option is used, other options also include: +.RS +.TP 0.2i +\(bu +The \f3-always\fR or \f3-alwaysgenerate\fR options force regeneration even when existing stubs/ties/IDL are newer than the input class\&. +.TP 0.2i +\(bu +The \f3-factory\fR option uses the \f3factory\fR keyword in generated IDL\&. +.TP 0.2i +\(bu +The \f3-idlModule\fR from J\f3avaPackage[\&.class]\fR\f3toIDLModule\fR specifies \f3IDLEntity\fR package mapping, for example: \f3-idlModule\fR\f3my\&.module my::real::idlmod\fR\&. +.TP 0.2i +\(bu +\f3-idlFile\fR\f3fromJavaPackage[\&.class] toIDLFile\fR specifies \f3IDLEntity\fR file mapping, for example: \f3-idlFile test\&.pkg\&.X TEST16\&.idl\fR\&. +.RE + +.TP +-iiop +.br +Causes the \f3rmic\fR command 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 reference to a remote object is 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\&. + +If you call the \f3rmic\fR command with the \f3-iiop\fR, then it generates stubs and ties that conform to this naming convention: +.sp +.nf +\f3_<implementationName>_stub\&.class\fP +.fi +.nf +\f3_<interfaceName>_tie\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp +.RS +.TP 0.2i +\(bu +When you use the \f3-iiop\fR option, other options also include: +.TP 0.2i +\(bu +The \f3-always\fR or \f3-alwaysgenerate\fR options force regeneration even when existing stubs/ties/IDL are newer than the input class\&. +.TP 0.2i +\(bu +The \f3-nolocalstubs\fR option means do not create stubs optimized for same-process clients and servers\&. +.TP 0.2i +\(bu +The \f3-noValueMethods\fR option must be used with the \f3-idl\fR option\&. The \f3-noValueMethods\fR option prevents the addition of \f3valuetype\fR methods and initializers to emitted IDL\&. These methods and initializers are optional for valuetypes, and are generated unless the \f3-noValueMethods\fR option is specified with the \f3-idl\fR option\&. +.TP 0.2i +\(bu +The \f3-poa\fR option changes the inheritance from \f3org\&.omg\&.CORBA_2_3\&.portable\&.ObjectImpl\fR to \f3org\&.omg\&.PortableServer\&.Servant\fR\&. The \f3PortableServer\fR module for the Portable Object Adapter (POA) defines the native \f3Servant\fR type\&. In the Java programming language, the \f3Servant\fR type is mapped to the \f3Java org\&.omg\&.PortableServer\&.Servant\fR class\&. It serves as the base class for all POA servant implementations and provides a number of methods that can be called by the application programmer, and methods that are called by the POA and that can 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 +-J +.br +Used with any Java command, the \f3-J\fR option passes the argument that follows the \f3-J\fR (no spaces between the \f3-J\fRand the argument) to the Java interpreter +.TP +-keep or -keepgenerated +.br +Retains the generated \f3\&.java\fR source files for the stub, skeleton, and tie classes and writes them to the same directory as the\f3\&.class\fR files\&. +.TP +-nowarn +.br +Turns off warnings\&. When the \f3-nowarn\fR options is used\&. The compiler does not print out any warnings\&. +.TP +-nowrite +.br +Does not write compiled classes to the file system\&. +.TP +-vcompat (deprecated) +.br +Generates stub and skeleton classes that are compatible with both the 1\&.1 and 1\&.2 JRMP stub protocol versions\&. This option was the default in releases before 5\&.0\&. The generated stub classes use the 1\&.1 stub protocol version when loaded in a JDK 1\&.1 virtual machine and use the 1\&.2 stub protocol version when loaded into a 1\&.2 (or later) virtual machine\&. The generated skeleton classes support both 1\&.1 and 1\&.2 stub protocol versions\&. The generated classes are relatively large to support both modes of operation\&. Note: This option has been deprecated\&. See Description\&. +.TP +-verbose +.br +Causes the compiler and linker to print out messages about what classes are being compiled and what class files are being loaded\&. +.TP +-v1\&.1 (deprecated) +.br +Generates stub and skeleton classes for the 1\&.1 JRMP stub protocol version only\&. The \f3-v1\&.1\fR option is only useful for generating stub classes that are serialization-compatible with preexisting, statically deployed stub classes that were generated by the \f3rmic\fR command from JDK 1\&.1 and that cannot be upgraded (and dynamic class loading is not being used)\&. Note: This option has been deprecated\&. See Description\&. +.TP +-v1\&.2 (deprecated) +.br +(Default) Generates stub classes for the 1\&.2 JRMP stub protocol version only\&. No skeleton classes are generated because skeleton classes are not used with the 1\&.2 stub protocol version\&. The generated stub classes do not work when they are loaded into a JDK 1\&.1 virtual machine\&. Note: This option has been deprecated\&. See Description\&. +.SH ENVIRONMENT\ VARIABLES +.TP +CLASSPATH +Used to provide the system a path to user-defined classes\&. Directories are separated by colons, for example: \f3\&.:/usr/local/java/classes\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +javac(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +Setting the Class Path +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/rmid.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/rmid.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,314 +1,314 @@ -'\" t -.\" Copyright (c) 1998, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Remote Method Invocation (RMI) Tools -.\" Title: rmid.1 -.\" -.if n .pl 99999 -.TH rmid 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -rmid \- Starts the activation system daemon that enables objects to be registered and activated in a Java Virtual Machine (JVM)\&. -.SH SYNOPSIS -.sp -.nf - -\fBrmid\fR [\fIoptions\fR] -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.SH DESCRIPTION -The \f3rmid\fR command 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 JVM\&. For details on how to write programs that use activatable objects, the \fIUsing Activation\fR tutorial at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/rmi/activation/overview\&.html -.PP -Start the daemon by executing the \f3rmid\fR command and specifying a security policy file, as follows: -.sp -.nf -\f3rmid \-J\-Djava\&.security\&.policy=rmid\&.policy\fP -.fi -.nf -\f3\fP -.fi -.sp -When you run Oracle\(cqs implementation of the \f3rmid\fR command, by default you must specify a security policy file so that the \f3rmid\fR command can verify whether or not the information in each \f3ActivationGroupDesc\fR is allowed to be used to start a JVM for an activation group\&. Specifically, the command and options specified by the \f3CommandEnvironment\fR and any properties passed to an \f3ActivationGroupDesc\fR constructor must now be explicitly allowed in the security policy file for the \f3rmid\fR command\&. The value of the \f3sun\&.rmi\&.activation\&.execPolicy\fR property dictates the policy that the \f3rmid\fR command uses to determine whether or not the information in an \f3ActivationGroupDesc\fR can be used to start a JVM for an activation group\&. For more information see the description of the -J-Dsun\&.rmi\&.activation\&.execPolicy=policy option\&. -.PP -Executing the \f3rmid\fR command starts the Activator and an internal registry on the default port1098 and binds an \f3ActivationSystem\fR to the name \f3java\&.rmi\&.activation\&.ActivationSystem\fR in this internal registry\&. -.PP -To specify an alternate port for the registry, you must specify the \f3-port\fR option when you execute the \f3rmid\fR command\&. For example, the following command starts the activation system daemon and a registry on the registry\&'s default port, 1099\&. -.sp -.nf -\f3rmid \-J\-Djava\&.security\&.policy=rmid\&.policy \-port 1099\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH START\ RMID\ ON\ DEMAND -An alternative to starting \f3rmid\fR from the command line is to configure \f3inetd\fR (Oracle Solaris) or \f3xinetd\fR (Linux) to start \f3rmid\fR on demand\&. -.PP -When RMID starts, it attempts to obtain an inherited channel (inherited from \f3inetd\fR/\f3xinetd\fR) by calling the \f3System\&.inheritedChannel\fR method\&. If the inherited channel is null or not an instance of \f3java\&.nio\&.channels\&.ServerSocketChannel\fR, then RMID assumes that it was not started by \f3inetd\fR/\f3xinetd\fR, and it starts as previously described\&. -.PP -If the inherited channel is a \f3ServerSocketChannel\fR instance, then RMID uses the \f3java\&.net\&.ServerSocket\fR obtained from the \f3ServerSocketChannel\fR as the server socket that accepts requests for the remote objects it exports: The registry in which the \f3java\&.rmi\&.activation\&.ActivationSystem\fR is bound and the \f3java\&.rmi\&.activation\&.Activator\fR remote object\&. In this mode, RMID behaves the same as when it is started from the command line, except in the following cases: -.TP 0.2i -\(bu -Output printed to \f3System\&.err\fR is redirected to a file\&. This file is located in the directory specified by the \f3java\&.io\&.tmpdir\fR system property (typically \f3/var/tmp\fR or \f3/tmp\fR) with the prefix \f3rmid-err\fR and the suffix \f3tmp\fR\&. -.TP 0.2i -\(bu -The \f3-port\fR option is not allowed\&. If this option is specified, then RMID exits with an error message\&. -.TP 0.2i -\(bu -The \f3-log\fR option is required\&. If this option is not specified, then RMID exits with an error message -.PP -See the man pages for \f3inetd\fR (Oracle Solaris) or \f3xinetd\fR (Linux) for details on how to configure services to be started on demand\&. -.SH OPTIONS -.TP --C\fIoption\fR -.br -Specifies an option that is passed as a command-line argument to each child process (activation group) of the \f3rmid\fR command when that process is created\&. For example, you could pass a property to each virtual machine spawned by the activation system daemon: -.sp -.nf -\f3rmid \-C\-Dsome\&.property=value\fP -.fi -.nf -\f3\fP -.fi -.sp - - -This ability to pass command-line arguments to child processes can be useful for debugging\&. For example, the following command enables server-call logging in all child JVMs\&. -.sp -.nf -\f3rmid \-C\-Djava\&.rmi\&.server\&.logCalls=true\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --J\fIoption\fR -.br -Specifies an option that is passed to the Java interpreter running RMID\&. For example, to specify that the \f3rmid\fR command use a policy file named \f3rmid\&.policy\fR, the \f3-J\fR option can be used to define the \f3java\&.security\&.policy\fR property on the \f3rmid\fR command line, for example: -.sp -.nf -\f3rmid \-J\-Djava\&.security\&.policy\-rmid\&.policy\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --J-Dsun\&.rmi\&.activation\&.execPolicy=\fIpolicy\fR -.br -Specifies the policy that RMID employs to check commands and command-line options used to start the JVM in which an activation group runs\&. Please note that this option exists only in Oracle\&'s implementation of the Java RMI activation daemon\&. If this property is not specified on the command line, then the result is the same as though \f3-J-Dsun\&.rmi\&.activation\&.execPolicy=default\fR were specified\&. The possible values of \f3policy\fR can be \f3default\fR, \f3policyClassName\fR, or \f3none\fR\&. -.RS -.TP 0.2i -\(bu -default - -The \f3default\fR or unspecified value \f3execPolicy\fR allows the \f3rmid\fR command to execute commands with specific command-line options only when the \f3rmid\fR command was granted permission to execute those commands and options in the security policy file that the \f3rmid\fR command uses\&. Only the default activation group implementation can be used with the default execution policy\&. - -The \f3rmid\fR command starts a JVM for an activation group with the information in the group\&'s registered activation group descriptor, an \f3ActivationGroupDesc\fR\&. The group descriptor specifies an optional \f3ActivationGroupDesc\&.CommandEnvironment\fR that includes the command to execute to start the activation group and any command-line options to be added to the command line\&. By default, the \f3rmid\fR command uses the \f3java\fR command found in \f3java\&.home\fR\&. The group descriptor also contains properties overrides that are added to the command line as options defined as: \f3-D<property>=<value>\fR\&.The \f3com\&.sun\&.rmi\&.rmid\&.ExecPermission\fR permission grants the \f3rmid\fR command permission to execute a command that is specified in the group descriptor\&'s \f3CommandEnvironment\fR to start an activation group\&. The \f3com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fR permission enables the \f3rmid\fR command to use command-line options, specified as properties overrides in the group descriptor or as options in the \f3CommandEnvironment\fR when starting the activation group\&.When granting the \f3rmid\fR command permission to execute various commands and options, the permissions \f3ExecPermission\fR and \f3ExecOptionPermission\fR must be granted to all code sources\&. - -\fIExecPermission\fR - -The \f3ExecPermission\fR class represents permission for the \f3rmid\fR command to execute a specific command to start an activation group\&. - -\fISyntax\fR: The name of an \f3ExecPermission\fR is the path name of a command to grant the \f3rmid\fR command permission to execute\&. A path name that ends in a slash (/) and an asterisk (*) indicates that all of the files contained in that directory where slash is the file-separator character, \f3File\&.separatorChar\fR\&. A path name that ends in a slash (/) and a minus sign (-) indicates all files and subdirectories contained in that directory (recursively)\&. A path name that consists of the special token \f3<<ALL FILES>>\fR matches any file\&. - -A path name that consists of an asterisk (*) indicates all the files in the current directory\&. A path name that consists of a minus sign (-) indicates all the files in the current directory and (recursively) all files and subdirectories contained in the current directory\&. - -\fIExecOptionPermission\fR - -The \f3ExecOptionPermission\fR class represents permission for the \f3rmid\fR command to use a specific command-line option when starting an activation group\&. The name of an \f3ExecOptionPermission\fR is the value of a command-line option\&. - -\fISyntax\fR: Options support a limited wild card scheme\&. An asterisk signifies a wild card match, and it can appear as the option name itself (matches any option), or an asterisk (*) can appear at the end of the option name only when the asterisk (*) follows a dot (\&.) or an equals sign (=)\&. - -For example: \f3*\fR or \f3-Dmydir\&.*\fR or \f3-Da\&.b\&.c=*\fR is valid, but \f3*mydir\fR or \f3-Da*b\fR or \f3ab*\fR is not\&. - -\fIPolicy file for rmid\fR - -When you grant the \f3rmid\fR command permission to execute various commands and options, the permissions \f3ExecPermission\fR and \f3ExecOptionPermission\fR must be granted to all code sources (universally)\&. It is safe to grant these permissions universally because only the \f3rmid\fR command checks these permissions\&. - -An example policy file that grants various execute permissions to the \f3rmid\fR command is: -.sp -.nf -\f3grant {\fP -.fi -.nf -\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecPermission\fP -.fi -.nf -\f3 "/files/apps/java/jdk1\&.7\&.0/solaris/bin/java";\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecPermission\fP -.fi -.nf -\f3 "/files/apps/rmidcmds/*";\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP -.fi -.nf -\f3 "\-Djava\&.security\&.policy=/files/policies/group\&.policy";\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP -.fi -.nf -\f3 "\-Djava\&.security\&.debug=*";\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP -.fi -.nf -\f3 "\-Dsun\&.rmi\&.*";\fP -.fi -.nf -\f3};\fP -.fi -.nf -\f3\fP -.fi -.sp - - -The first permission granted allows the \f3rmid\fR tcommand o execute the 1\&.7\&.0 release of the \f3java\fR command, specified by its explicit path name\&. By default, the version of the \f3java\fR command found in \f3java\&.home\fR is used (the same one that the \f3rmid\fR command uses), and does not need to be specified in the policy file\&. The second permission allows the \f3rmid\fR command to execute any command in the directory \f3/files/apps/rmidcmds\fR\&. - -The third permission granted, an \f3ExecOptionPermission\fR, allows the \f3rmid\fR command to start an activation group that defines the security policy file to be \f3/files/policies/group\&.policy\fR\&. The next permission allows the \f3java\&.security\&.debug property\fR to be used by an activation group\&. The last permission allows any property in the \f3sun\&.rmi property\fR name hierarchy to be used by activation groups\&. - -To start the \f3rmid\fR command with a policy file, the \f3java\&.security\&.policy\fR property needs to be specified on the \f3rmid\fR command line, for example: - -\f3rmid -J-Djava\&.security\&.policy=rmid\&.policy\fR\&. -.TP 0.2i -\(bu -<policyClassName> - -If the default behavior is not flexible enough, then an administrator can provide, when starting the \f3rmid\fR command, the name of a class whose \f3checkExecCommand\fR method is executed to check commands to be executed by the \f3rmid\fR command\&. - -The \f3policyClassName\fR specifies a public class with a public, no-argument constructor and an implementation of the following \f3checkExecCommand\fR method: -.sp -.nf -\f3 public void checkExecCommand(ActivationGroupDesc desc, String[] command)\fP -.fi -.nf -\f3 throws SecurityException;\fP -.fi -.nf -\f3\fP -.fi -.sp - - -Before starting an activation group, the \f3rmid\fR command calls the policy\&'s \f3checkExecCommand\fR method and passes to it the activation group descriptor and an array that contains the complete command to start the activation group\&. If the \f3checkExecCommand\fR throws a \f3SecurityException\fR, then the \f3rmid\fR command does not start the activation group and an \f3ActivationException\fR is thrown to the caller attempting to activate the object\&. -.TP 0.2i -\(bu -none - -If the \f3sun\&.rmi\&.activation\&.execPolicy\fR property value is \f3none\fR, then the \f3rmid\fR command does not perform any validation of commands to start activation groups\&. -.RE - -.TP --log \fIdir\fR -.br -Specifies the name of the directory the activation system daemon uses to write its database and associated information\&. The log directory defaults to creating a log, in the directory in which the \f3rmid\fR command was executed\&. -.TP --port \fIport\fR -.br -Specifies the port the registry uses\&. The activation system daemon binds the \f3ActivationSystem\fR, with the name \f3java\&.rmi\&.activation\&.ActivationSystem\fR, in this registry\&. The \f3ActivationSystem\fR on the local machine can be obtained using the following \f3Naming\&.lookup\fR method call: -.sp -.nf -\f3import java\&.rmi\&.*; \fP -.fi -.nf -\f3 import java\&.rmi\&.activation\&.*;\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 ActivationSystem system; system = (ActivationSystem)\fP -.fi -.nf -\f3 Naming\&.lookup("//:port/java\&.rmi\&.activation\&.ActivationSystem");\fP -.fi -.nf -\f3\fP -.fi -.sp - -.TP --stop -.br -Stops the current invocation of the \f3rmid\fR command for a port specified by the \f3-port\fR option\&. If no port is specified, then this option stops the \f3rmid\fR invocation running on port 1098\&. -.SH ENVIRONMENT\ VARIABLES -.TP -CLASSPATH -Used to provide the system a path to user-defined classes\&. Directories are separated by colons, for example: \f3\&.:/usr/local/java/classes\fR\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -Setting the Class Path -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1998, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Remote Method Invocation (RMI) Tools +.\" Title: rmid.1 +.\" +.if n .pl 99999 +.TH rmid 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +rmid \- Starts the activation system daemon that enables objects to be registered and activated in a Java Virtual Machine (JVM)\&. +.SH SYNOPSIS +.sp +.nf + +\fBrmid\fR [\fIoptions\fR] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.SH DESCRIPTION +The \f3rmid\fR command 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 JVM\&. For details on how to write programs that use activatable objects, the \fIUsing Activation\fR tutorial at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/rmi/activation/overview\&.html +.PP +Start the daemon by executing the \f3rmid\fR command and specifying a security policy file, as follows: +.sp +.nf +\f3rmid \-J\-Djava\&.security\&.policy=rmid\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp +When you run Oracle\(cqs implementation of the \f3rmid\fR command, by default you must specify a security policy file so that the \f3rmid\fR command can verify whether or not the information in each \f3ActivationGroupDesc\fR is allowed to be used to start a JVM for an activation group\&. Specifically, the command and options specified by the \f3CommandEnvironment\fR and any properties passed to an \f3ActivationGroupDesc\fR constructor must now be explicitly allowed in the security policy file for the \f3rmid\fR command\&. The value of the \f3sun\&.rmi\&.activation\&.execPolicy\fR property dictates the policy that the \f3rmid\fR command uses to determine whether or not the information in an \f3ActivationGroupDesc\fR can be used to start a JVM for an activation group\&. For more information see the description of the -J-Dsun\&.rmi\&.activation\&.execPolicy=policy option\&. +.PP +Executing the \f3rmid\fR command starts the Activator and an internal registry on the default port1098 and binds an \f3ActivationSystem\fR to the name \f3java\&.rmi\&.activation\&.ActivationSystem\fR in this internal registry\&. +.PP +To specify an alternate port for the registry, you must specify the \f3-port\fR option when you execute the \f3rmid\fR command\&. For example, the following command starts the activation system daemon and a registry on the registry\&'s default port, 1099\&. +.sp +.nf +\f3rmid \-J\-Djava\&.security\&.policy=rmid\&.policy \-port 1099\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH START\ RMID\ ON\ DEMAND +An alternative to starting \f3rmid\fR from the command line is to configure \f3inetd\fR (Oracle Solaris) or \f3xinetd\fR (Linux) to start \f3rmid\fR on demand\&. +.PP +When RMID starts, it attempts to obtain an inherited channel (inherited from \f3inetd\fR/\f3xinetd\fR) by calling the \f3System\&.inheritedChannel\fR method\&. If the inherited channel is null or not an instance of \f3java\&.nio\&.channels\&.ServerSocketChannel\fR, then RMID assumes that it was not started by \f3inetd\fR/\f3xinetd\fR, and it starts as previously described\&. +.PP +If the inherited channel is a \f3ServerSocketChannel\fR instance, then RMID uses the \f3java\&.net\&.ServerSocket\fR obtained from the \f3ServerSocketChannel\fR as the server socket that accepts requests for the remote objects it exports: The registry in which the \f3java\&.rmi\&.activation\&.ActivationSystem\fR is bound and the \f3java\&.rmi\&.activation\&.Activator\fR remote object\&. In this mode, RMID behaves the same as when it is started from the command line, except in the following cases: +.TP 0.2i +\(bu +Output printed to \f3System\&.err\fR is redirected to a file\&. This file is located in the directory specified by the \f3java\&.io\&.tmpdir\fR system property (typically \f3/var/tmp\fR or \f3/tmp\fR) with the prefix \f3rmid-err\fR and the suffix \f3tmp\fR\&. +.TP 0.2i +\(bu +The \f3-port\fR option is not allowed\&. If this option is specified, then RMID exits with an error message\&. +.TP 0.2i +\(bu +The \f3-log\fR option is required\&. If this option is not specified, then RMID exits with an error message +.PP +See the man pages for \f3inetd\fR (Oracle Solaris) or \f3xinetd\fR (Linux) for details on how to configure services to be started on demand\&. +.SH OPTIONS +.TP +-C\fIoption\fR +.br +Specifies an option that is passed as a command-line argument to each child process (activation group) of the \f3rmid\fR command when that process is created\&. For example, you could pass a property to each virtual machine spawned by the activation system daemon: +.sp +.nf +\f3rmid \-C\-Dsome\&.property=value\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This ability to pass command-line arguments to child processes can be useful for debugging\&. For example, the following command enables server-call logging in all child JVMs\&. +.sp +.nf +\f3rmid \-C\-Djava\&.rmi\&.server\&.logCalls=true\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-J\fIoption\fR +.br +Specifies an option that is passed to the Java interpreter running RMID\&. For example, to specify that the \f3rmid\fR command use a policy file named \f3rmid\&.policy\fR, the \f3-J\fR option can be used to define the \f3java\&.security\&.policy\fR property on the \f3rmid\fR command line, for example: +.sp +.nf +\f3rmid \-J\-Djava\&.security\&.policy\-rmid\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-J-Dsun\&.rmi\&.activation\&.execPolicy=\fIpolicy\fR +.br +Specifies the policy that RMID employs to check commands and command-line options used to start the JVM in which an activation group runs\&. Please note that this option exists only in Oracle\&'s implementation of the Java RMI activation daemon\&. If this property is not specified on the command line, then the result is the same as though \f3-J-Dsun\&.rmi\&.activation\&.execPolicy=default\fR were specified\&. The possible values of \f3policy\fR can be \f3default\fR, \f3policyClassName\fR, or \f3none\fR\&. +.RS +.TP 0.2i +\(bu +default + +The \f3default\fR or unspecified value \f3execPolicy\fR allows the \f3rmid\fR command to execute commands with specific command-line options only when the \f3rmid\fR command was granted permission to execute those commands and options in the security policy file that the \f3rmid\fR command uses\&. Only the default activation group implementation can be used with the default execution policy\&. + +The \f3rmid\fR command starts a JVM for an activation group with the information in the group\&'s registered activation group descriptor, an \f3ActivationGroupDesc\fR\&. The group descriptor specifies an optional \f3ActivationGroupDesc\&.CommandEnvironment\fR that includes the command to execute to start the activation group and any command-line options to be added to the command line\&. By default, the \f3rmid\fR command uses the \f3java\fR command found in \f3java\&.home\fR\&. The group descriptor also contains properties overrides that are added to the command line as options defined as: \f3-D<property>=<value>\fR\&.The \f3com\&.sun\&.rmi\&.rmid\&.ExecPermission\fR permission grants the \f3rmid\fR command permission to execute a command that is specified in the group descriptor\&'s \f3CommandEnvironment\fR to start an activation group\&. The \f3com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fR permission enables the \f3rmid\fR command to use command-line options, specified as properties overrides in the group descriptor or as options in the \f3CommandEnvironment\fR when starting the activation group\&.When granting the \f3rmid\fR command permission to execute various commands and options, the permissions \f3ExecPermission\fR and \f3ExecOptionPermission\fR must be granted to all code sources\&. + +\fIExecPermission\fR + +The \f3ExecPermission\fR class represents permission for the \f3rmid\fR command to execute a specific command to start an activation group\&. + +\fISyntax\fR: The name of an \f3ExecPermission\fR is the path name of a command to grant the \f3rmid\fR command permission to execute\&. A path name that ends in a slash (/) and an asterisk (*) indicates that all of the files contained in that directory where slash is the file-separator character, \f3File\&.separatorChar\fR\&. A path name that ends in a slash (/) and a minus sign (-) indicates all files and subdirectories contained in that directory (recursively)\&. A path name that consists of the special token \f3<<ALL FILES>>\fR matches any file\&. + +A path name that consists of an asterisk (*) indicates all the files in the current directory\&. A path name that consists of a minus sign (-) indicates all the files in the current directory and (recursively) all files and subdirectories contained in the current directory\&. + +\fIExecOptionPermission\fR + +The \f3ExecOptionPermission\fR class represents permission for the \f3rmid\fR command to use a specific command-line option when starting an activation group\&. The name of an \f3ExecOptionPermission\fR is the value of a command-line option\&. + +\fISyntax\fR: Options support a limited wild card scheme\&. An asterisk signifies a wild card match, and it can appear as the option name itself (matches any option), or an asterisk (*) can appear at the end of the option name only when the asterisk (*) follows a dot (\&.) or an equals sign (=)\&. + +For example: \f3*\fR or \f3-Dmydir\&.*\fR or \f3-Da\&.b\&.c=*\fR is valid, but \f3*mydir\fR or \f3-Da*b\fR or \f3ab*\fR is not\&. + +\fIPolicy file for rmid\fR + +When you grant the \f3rmid\fR command permission to execute various commands and options, the permissions \f3ExecPermission\fR and \f3ExecOptionPermission\fR must be granted to all code sources (universally)\&. It is safe to grant these permissions universally because only the \f3rmid\fR command checks these permissions\&. + +An example policy file that grants various execute permissions to the \f3rmid\fR command is: +.sp +.nf +\f3grant {\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecPermission\fP +.fi +.nf +\f3 "/files/apps/java/jdk1\&.7\&.0/solaris/bin/java";\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecPermission\fP +.fi +.nf +\f3 "/files/apps/rmidcmds/*";\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP +.fi +.nf +\f3 "\-Djava\&.security\&.policy=/files/policies/group\&.policy";\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP +.fi +.nf +\f3 "\-Djava\&.security\&.debug=*";\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP +.fi +.nf +\f3 "\-Dsun\&.rmi\&.*";\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The first permission granted allows the \f3rmid\fR tcommand o execute the 1\&.7\&.0 release of the \f3java\fR command, specified by its explicit path name\&. By default, the version of the \f3java\fR command found in \f3java\&.home\fR is used (the same one that the \f3rmid\fR command uses), and does not need to be specified in the policy file\&. The second permission allows the \f3rmid\fR command to execute any command in the directory \f3/files/apps/rmidcmds\fR\&. + +The third permission granted, an \f3ExecOptionPermission\fR, allows the \f3rmid\fR command to start an activation group that defines the security policy file to be \f3/files/policies/group\&.policy\fR\&. The next permission allows the \f3java\&.security\&.debug property\fR to be used by an activation group\&. The last permission allows any property in the \f3sun\&.rmi property\fR name hierarchy to be used by activation groups\&. + +To start the \f3rmid\fR command with a policy file, the \f3java\&.security\&.policy\fR property needs to be specified on the \f3rmid\fR command line, for example: + +\f3rmid -J-Djava\&.security\&.policy=rmid\&.policy\fR\&. +.TP 0.2i +\(bu +<policyClassName> + +If the default behavior is not flexible enough, then an administrator can provide, when starting the \f3rmid\fR command, the name of a class whose \f3checkExecCommand\fR method is executed to check commands to be executed by the \f3rmid\fR command\&. + +The \f3policyClassName\fR specifies a public class with a public, no-argument constructor and an implementation of the following \f3checkExecCommand\fR method: +.sp +.nf +\f3 public void checkExecCommand(ActivationGroupDesc desc, String[] command)\fP +.fi +.nf +\f3 throws SecurityException;\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Before starting an activation group, the \f3rmid\fR command calls the policy\&'s \f3checkExecCommand\fR method and passes to it the activation group descriptor and an array that contains the complete command to start the activation group\&. If the \f3checkExecCommand\fR throws a \f3SecurityException\fR, then the \f3rmid\fR command does not start the activation group and an \f3ActivationException\fR is thrown to the caller attempting to activate the object\&. +.TP 0.2i +\(bu +none + +If the \f3sun\&.rmi\&.activation\&.execPolicy\fR property value is \f3none\fR, then the \f3rmid\fR command does not perform any validation of commands to start activation groups\&. +.RE + +.TP +-log \fIdir\fR +.br +Specifies the name of the directory the activation system daemon uses to write its database and associated information\&. The log directory defaults to creating a log, in the directory in which the \f3rmid\fR command was executed\&. +.TP +-port \fIport\fR +.br +Specifies the port the registry uses\&. The activation system daemon binds the \f3ActivationSystem\fR, with the name \f3java\&.rmi\&.activation\&.ActivationSystem\fR, in this registry\&. The \f3ActivationSystem\fR on the local machine can be obtained using the following \f3Naming\&.lookup\fR method call: +.sp +.nf +\f3import java\&.rmi\&.*; \fP +.fi +.nf +\f3 import java\&.rmi\&.activation\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 ActivationSystem system; system = (ActivationSystem)\fP +.fi +.nf +\f3 Naming\&.lookup("//:port/java\&.rmi\&.activation\&.ActivationSystem");\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-stop +.br +Stops the current invocation of the \f3rmid\fR command for a port specified by the \f3-port\fR option\&. If no port is specified, then this option stops the \f3rmid\fR invocation running on port 1098\&. +.SH ENVIRONMENT\ VARIABLES +.TP +CLASSPATH +Used to provide the system a path to user-defined classes\&. Directories are separated by colons, for example: \f3\&.:/usr/local/java/classes\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +Setting the Class Path +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/rmiregistry.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/rmiregistry.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,98 +1,98 @@ -'\" t -.\" Copyright (c) 1997, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Remote Method Invocation (RMI) Tools -.\" Title: rmiregistry.1 -.\" -.if n .pl 99999 -.TH rmiregistry 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -rmiregistry \- Starts a remote object registry on the specified port on the current host\&. -.SH SYNOPSIS -.sp -.nf - -\fBrmiregistry\fR [ \fIport\fR ] -.fi -.sp -.TP -\fIport\fR -The number of a \f3port\fR on the current host at which to start the remote object registry\&. -.SH DESCRIPTION -The \f3rmiregistry\fR command creates and starts a remote object registry on the specified port on the current host\&. If the port is omitted, then the registry is started on port 1099\&. The \f3rmiregistry\fR command produces no output and is typically run in the background, for example: -.sp -.nf -\f3rmiregistry &\fP -.fi -.nf -\f3\fP -.fi -.sp -A remote object registry is a bootstrap naming service that is used by RMI servers on the same host to bind remote objects to names\&. Clients on local and remote hosts can then look up remote objects and make remote method invocations\&. -.PP -The registry is typically used to locate the first remote object on which an application needs to call methods\&. That object then provides application-specific support for finding other objects\&. -.PP -The methods of the \f3java\&.rmi\&.registry\&.LocateRegistry\fR class are used to get a registry operating on the local host or local host and port\&. -.PP -The URL-based methods of the \f3java\&.rmi\&.Naming\fR 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 name (string) to a remote object, rebind a new name to a remote object (overriding the old binding), unbind a remote object, and list the URL bound in the registry\&. -.SH OPTIONS -.TP --J -.br -Used with any Java option to pass the option following the \f3-J\fR (no spaces between the \f3-J\fR and the option) to the Java interpreter\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -java(1) -.TP 0.2i -\(bu -\f3java\&.rmi\&.registry\&.LocateRegistry\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/registry/LocateRegistry\&.html -.TP 0.2i -\(bu -\f3java\&.rmi\&.Naming class description\fR at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/Naming\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1997, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Remote Method Invocation (RMI) Tools +.\" Title: rmiregistry.1 +.\" +.if n .pl 99999 +.TH rmiregistry 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +rmiregistry \- Starts a remote object registry on the specified port on the current host\&. +.SH SYNOPSIS +.sp +.nf + +\fBrmiregistry\fR [ \fIport\fR ] +.fi +.sp +.TP +\fIport\fR +The number of a \f3port\fR on the current host at which to start the remote object registry\&. +.SH DESCRIPTION +The \f3rmiregistry\fR command creates and starts a remote object registry on the specified port on the current host\&. If the port is omitted, then the registry is started on port 1099\&. The \f3rmiregistry\fR command produces no output and is typically run in the background, for example: +.sp +.nf +\f3rmiregistry &\fP +.fi +.nf +\f3\fP +.fi +.sp +A remote object registry is a bootstrap naming service that is used by RMI servers on the same host to bind remote objects to names\&. Clients on local and remote hosts can then look up remote objects and make remote method invocations\&. +.PP +The registry is typically used to locate the first remote object on which an application needs to call methods\&. That object then provides application-specific support for finding other objects\&. +.PP +The methods of the \f3java\&.rmi\&.registry\&.LocateRegistry\fR class are used to get a registry operating on the local host or local host and port\&. +.PP +The URL-based methods of the \f3java\&.rmi\&.Naming\fR 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 name (string) to a remote object, rebind a new name to a remote object (overriding the old binding), unbind a remote object, and list the URL bound in the registry\&. +.SH OPTIONS +.TP +-J +.br +Used with any Java option to pass the option following the \f3-J\fR (no spaces between the \f3-J\fR and the option) to the Java interpreter\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +\f3java\&.rmi\&.registry\&.LocateRegistry\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/registry/LocateRegistry\&.html +.TP 0.2i +\(bu +\f3java\&.rmi\&.Naming class description\fR at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/Naming\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/schemagen.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/schemagen.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,121 +1,121 @@ -'\" t -.\" Copyright (c) 2005, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java Web Services Tools -.\" Title: schemagen.1 -.\" -.if n .pl 99999 -.TH schemagen 1 "21 November 2013" "JDK 8" "Java Web Services Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -schemagen \- Generates a schema for every name space that is referenced in your Java classes\&. -.SH SYNOPSIS -.sp -.nf - -\fBschemagen\fR [ \fIoptions\fR ] \fIjava\-files\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIjava-files\fR -The Java class files to be processed\&. -.SH DESCRIPTION -The schema generator creates a schema file for each name space referenced in your Java classes\&. Currently, you cannot control the name of the generated schema files\&. To control the schema file names, see Using SchemaGen with Ant at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/schemagenTask\&.html -.PP -Start the schema generator with the appropriate \f3schemagen\fR shell script in the bin directory for your platform\&. The current schema generator can process either Java source files or class files\&. -.sp -.nf -\f3schemagen\&.sh Foo\&.java Bar\&.java \&.\&.\&.\fP -.fi -.nf -\f3Note: Writing schema1\&.xsd\fP -.fi -.nf -\f3\fP -.fi -.sp -If your java files reference other classes, then those classes must be accessible on your system \f3CLASSPATH\fR environment variable, or they need to be specified in the \f3schemagen\fR command line with the class path options\&. See Options\&. If the referenced files are not accessible or specified, then you get errors when you generate the schema\&. -.SH OPTIONS -.TP --d \fIpath\fR -.br -The location where the \f3schemagen\fR command places processor-generated and \f3javac\fR-generated class files\&. -.TP --cp \fIpath\fR -.br -The location where the \f3schemagen\fR command places user-specified files\&. -.TP --classpath \fIpath\fR -.br -The location where the \f3schemagen\fR command places user-specified files\&. -.TP --encoding \fIencoding\fR -.br -Specifies the encoding to use for \f3apt\fR or \f3javac\fR command invocations\&. -.TP --episode \fIfile\fR -.br -Generates an episode file for separate compilation\&. -.TP --version -.br -Displays release information\&. -.TP --help -.br -Displays a help message\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -Using SchemaGen with Ant at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/schemagenTask\&.html -.TP 0.2i -\(bu -Java Architecture for XML Binding (JAXB) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/xml/jaxb/index\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2005, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Web Services Tools +.\" Title: schemagen.1 +.\" +.if n .pl 99999 +.TH schemagen 1 "21 November 2013" "JDK 8" "Java Web Services Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +schemagen \- Generates a schema for every name space that is referenced in your Java classes\&. +.SH SYNOPSIS +.sp +.nf + +\fBschemagen\fR [ \fIoptions\fR ] \fIjava\-files\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIjava-files\fR +The Java class files to be processed\&. +.SH DESCRIPTION +The schema generator creates a schema file for each name space referenced in your Java classes\&. Currently, you cannot control the name of the generated schema files\&. To control the schema file names, see Using SchemaGen with Ant at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/schemagenTask\&.html +.PP +Start the schema generator with the appropriate \f3schemagen\fR shell script in the bin directory for your platform\&. The current schema generator can process either Java source files or class files\&. +.sp +.nf +\f3schemagen\&.sh Foo\&.java Bar\&.java \&.\&.\&.\fP +.fi +.nf +\f3Note: Writing schema1\&.xsd\fP +.fi +.nf +\f3\fP +.fi +.sp +If your java files reference other classes, then those classes must be accessible on your system \f3CLASSPATH\fR environment variable, or they need to be specified in the \f3schemagen\fR command line with the class path options\&. See Options\&. If the referenced files are not accessible or specified, then you get errors when you generate the schema\&. +.SH OPTIONS +.TP +-d \fIpath\fR +.br +The location where the \f3schemagen\fR command places processor-generated and \f3javac\fR-generated class files\&. +.TP +-cp \fIpath\fR +.br +The location where the \f3schemagen\fR command places user-specified files\&. +.TP +-classpath \fIpath\fR +.br +The location where the \f3schemagen\fR command places user-specified files\&. +.TP +-encoding \fIencoding\fR +.br +Specifies the encoding to use for \f3apt\fR or \f3javac\fR command invocations\&. +.TP +-episode \fIfile\fR +.br +Generates an episode file for separate compilation\&. +.TP +-version +.br +Displays release information\&. +.TP +-help +.br +Displays a help message\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +Using SchemaGen with Ant at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/schemagenTask\&.html +.TP 0.2i +\(bu +Java Architecture for XML Binding (JAXB) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/xml/jaxb/index\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/serialver.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/serialver.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,110 +1,110 @@ -'\" t -.\" Copyright (c) 1997, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Remote Method Invocation (RMI) Tools -.\" Title: serialver.1 -.\" -.if n .pl 99999 -.TH serialver 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -serialver \- Returns the serial version UID for specified classes\&. -.SH SYNOPSIS -.sp -.nf - -\fBserialver\fR [ \fIoptions\fR ] [ \fIclassnames\fR ] -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIclassnames\fR -The classes for which the \f3serialVersionUID\fR is to be returned\&. -.SH DESCRIPTION -The \f3serialver\fR command returns the \f3serialVersionUID\fR for one or more classes in a form suitable for copying into an evolving class\&. When called with no arguments, the \f3serialver\fR command prints a usage line\&. -.SH OPTIONS -.TP --classpath \fIpath-files\fR -.br -Sets the search path for application classes and resources\&. Separate classes and resources with a colon (:)\&. -.TP --show -.br -Displays a simple user interface\&. Enter the full class name and press either the \fIEnter\fR key or the \fIShow\fR button to display the \f3serialVersionUID\fR\&. -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the Java Virtual Machine, where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH NOTES -The \f3serialver\fR command loads and initializes the specified classes in its virtual machine, and by default, it does not set a security manager\&. If the \f3serialver\fR command is to be run with untrusted classes, then a security manager can be set with the following option: -.sp -.nf -\f3\-J\-Djava\&.security\&.manager\fP -.fi -.nf -\f3\fP -.fi -.sp -When necessary, a security policy can be specified with the following option: -.sp -.nf -\f3\-J\-Djava\&.security\&.policy=<policy file>\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH SEE\ ALSO -.TP 0.2i -\(bu -policytool(1) -.TP 0.2i -\(bu -The \f3java\&.io\&.ObjectStream\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/io/ObjectStreamClass\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1997, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Remote Method Invocation (RMI) Tools +.\" Title: serialver.1 +.\" +.if n .pl 99999 +.TH serialver 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +serialver \- Returns the serial version UID for specified classes\&. +.SH SYNOPSIS +.sp +.nf + +\fBserialver\fR [ \fIoptions\fR ] [ \fIclassnames\fR ] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIclassnames\fR +The classes for which the \f3serialVersionUID\fR is to be returned\&. +.SH DESCRIPTION +The \f3serialver\fR command returns the \f3serialVersionUID\fR for one or more classes in a form suitable for copying into an evolving class\&. When called with no arguments, the \f3serialver\fR command prints a usage line\&. +.SH OPTIONS +.TP +-classpath \fIpath-files\fR +.br +Sets the search path for application classes and resources\&. Separate classes and resources with a colon (:)\&. +.TP +-show +.br +Displays a simple user interface\&. Enter the full class name and press either the \fIEnter\fR key or the \fIShow\fR button to display the \f3serialVersionUID\fR\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH NOTES +The \f3serialver\fR command loads and initializes the specified classes in its virtual machine, and by default, it does not set a security manager\&. If the \f3serialver\fR command is to be run with untrusted classes, then a security manager can be set with the following option: +.sp +.nf +\f3\-J\-Djava\&.security\&.manager\fP +.fi +.nf +\f3\fP +.fi +.sp +When necessary, a security policy can be specified with the following option: +.sp +.nf +\f3\-J\-Djava\&.security\&.policy=<policy file>\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +policytool(1) +.TP 0.2i +\(bu +The \f3java\&.io\&.ObjectStream\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/io/ObjectStreamClass\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/servertool.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/servertool.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,137 +1,137 @@ -'\" t -.\" Copyright (c) 2001, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java IDL and RMI-IIOP Tools -.\" Title: servertool.1 -.\" -.if n .pl 99999 -.TH servertool 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -servertool \- Provides an easy-to-use interface for developers to register, unregister, start up, and shut down a persistent server\&. -.SH SYNOPSIS -.sp -.nf - -\fBservertool\fR \-ORBInitialPort \fInameserverport\fR [ \fIoptions\fR ] [ \fIcommands \fR] -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -commands -The command-line commands\&. See Commands\&. -.SH DESCRIPTION -The \f3servertool\fR command provides the command-line interface for developers to register, unregister, start up, and shut down a persistent server\&. Command-line commands let you obtain various statistical information about the server\&. See Commands\&. -.SH OPTIONS -.TP --ORBInitialHost \fInameserverhost\fR -.br -This options is required\&. It specifies the host machine on which the name server runs and listens for incoming requests\&. The \f3nameserverhost\fR value must specify the port on which the \f3orb\fR is running and listening for requests\&. The value defaults to \f3localhost\fR when this option is not specified\&. If \f3orbd\fR and \f3servertool\fR are running on different machines, then you must specify the name or IP address of the host on which \f3orbd\fR is running\&. - -\fINote:\fR On Oracle Solaris, you must become a root user to start a process on a port below 1024\&. Oracle recommends that you use a port number above or equal to 1024 for the \f3nameserverport\fR value\&. -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH COMMANDS -You can start the \f3servertool\fR command with or without a command-line command\&. -.TP 0.2i -\(bu -If you did not specify a command when you started \f3servertool\fR, then the command-line tool displays the \f3servertool\fR prompt where you can enter commands: \f3servertool >\fR\&. -.TP 0.2i -\(bu -If you specify a command when you start \f3servertool\fR, then the Java IDL Server Tool starts, executes the command, and exits\&. -.TP -.ll 180 -register -server \fIserver-class-name\fR -classpath \fIclasspath-to-server\fR [ -applicationName \fIapplication-name\fR -args \fIargs-to-server\fR -vmargs \fIflags-for-JVM\fR ] -Registers a new persistent server with the Object Request Broker Daemon (ORBD)\&. If the server is not already registered, then it is registered and activated\&. This command causes an installation method to be called in the \f3main\fR class of the server identified by the \f3-server\fR option\&. The installation method must be \f3public static void install(org\&.omg\&.CORBA\&.ORB)\fR\&. The install method is optional and lets developers provide their own server installation behavior, such as creating a database schema\&. -.TP -.ll 180 -unregister -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR -Unregisters a server from the ORBD with either its server ID or its application name\&. This command causes an uninstallation method to be called in the \f3main\fR class of the server identified by the \f3-server\fR option\&. The \f3uninstall\fR method must be \f3public static void uninstall(org\&.omg\&.CORBA\&.ORB)\fR\&. The \f3uninstall\fR method is optional and lets developers provide their own server uninstallation behavior, such as undoing the behavior of the \f3install\fR method\&. -.TP -getserverid -applicationName \fIapplication-name\fR -Returns the server ID that corresponds to the \f3application-name\fR value\&. -.TP -list -Lists information about all persistent servers registered with the ORBD\&. -.TP -listappnames -Lists the application names for all servers currently registered with the ORBD\&. -.TP -listactive -Lists information about all persistent servers that were started by the ORBD and are currently running\&. -.TP -.ll 180 -locate -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR [ -endpointType \fIendpointType\fR ] -Locates the endpoints (ports) of a specific type for all ORBs created by a registered server\&. If a server is not already running, then it is activated\&. If an \f3endpointType\fR value is not specified, then the plain/non-protected endpoint associated with each ORB in a server is returned\&. -.TP -.ll 180 -locateperorb -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR [ -orbid \fIORB-name\fR ] -Locates all the endpoints (ports) registered by a specific Object Request Broker (ORB) of registered server\&. If a server is not already running, then it is activated\&. If an \f3orbid\fR is not specified, then the default value of \f3""\fR is assigned to the \f3orbid\fR\&. If any ORBs are created with an \f3orbid\fR of empty string, then all ports registered by it are returned\&. -.TP -orblist -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR -Lists the \f3ORBId\fR of the ORBs defined on a server\&. An \f3ORBId\fR is the string name for the ORB created by the server\&. If the server is not already running, then it is activated\&. -.TP -shutdown -serverid \fIserver-id\fR | -applicationName application-name -Shut down an active server that is registered with ORBD\&. During execution of this command, the \f3shutdown\fR method defined in the class specified by either the \f3-serverid\fR or \f3-applicationName\fR parameter is also called to shut down the server process\&. -.TP -startup -serverid \fIserver-id\fR | -applicationName application-name -Starts up or activate a server that is registered with ORBD\&. If the server is not running, then this command starts the server\&. If the server is already running, then an error message is displayed\&. -.TP -help -Lists all the commands available to the server through the \f3servertool\fR command\&. -.TP -quit -Exits the \f3servertool\fR command\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -orbd(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2001, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java IDL and RMI-IIOP Tools +.\" Title: servertool.1 +.\" +.if n .pl 99999 +.TH servertool 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +servertool \- Provides an easy-to-use interface for developers to register, unregister, start up, and shut down a persistent server\&. +.SH SYNOPSIS +.sp +.nf + +\fBservertool\fR \-ORBInitialPort \fInameserverport\fR [ \fIoptions\fR ] [ \fIcommands \fR] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +commands +The command-line commands\&. See Commands\&. +.SH DESCRIPTION +The \f3servertool\fR command provides the command-line interface for developers to register, unregister, start up, and shut down a persistent server\&. Command-line commands let you obtain various statistical information about the server\&. See Commands\&. +.SH OPTIONS +.TP +-ORBInitialHost \fInameserverhost\fR +.br +This options is required\&. It specifies the host machine on which the name server runs and listens for incoming requests\&. The \f3nameserverhost\fR value must specify the port on which the \f3orb\fR is running and listening for requests\&. The value defaults to \f3localhost\fR when this option is not specified\&. If \f3orbd\fR and \f3servertool\fR are running on different machines, then you must specify the name or IP address of the host on which \f3orbd\fR is running\&. + +\fINote:\fR On Oracle Solaris, you must become a root user to start a process on a port below 1024\&. Oracle recommends that you use a port number above or equal to 1024 for the \f3nameserverport\fR value\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH COMMANDS +You can start the \f3servertool\fR command with or without a command-line command\&. +.TP 0.2i +\(bu +If you did not specify a command when you started \f3servertool\fR, then the command-line tool displays the \f3servertool\fR prompt where you can enter commands: \f3servertool >\fR\&. +.TP 0.2i +\(bu +If you specify a command when you start \f3servertool\fR, then the Java IDL Server Tool starts, executes the command, and exits\&. +.TP +.ll 180 +register -server \fIserver-class-name\fR -classpath \fIclasspath-to-server\fR [ -applicationName \fIapplication-name\fR -args \fIargs-to-server\fR -vmargs \fIflags-for-JVM\fR ] +Registers a new persistent server with the Object Request Broker Daemon (ORBD)\&. If the server is not already registered, then it is registered and activated\&. This command causes an installation method to be called in the \f3main\fR class of the server identified by the \f3-server\fR option\&. The installation method must be \f3public static void install(org\&.omg\&.CORBA\&.ORB)\fR\&. The install method is optional and lets developers provide their own server installation behavior, such as creating a database schema\&. +.TP +.ll 180 +unregister -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR +Unregisters a server from the ORBD with either its server ID or its application name\&. This command causes an uninstallation method to be called in the \f3main\fR class of the server identified by the \f3-server\fR option\&. The \f3uninstall\fR method must be \f3public static void uninstall(org\&.omg\&.CORBA\&.ORB)\fR\&. The \f3uninstall\fR method is optional and lets developers provide their own server uninstallation behavior, such as undoing the behavior of the \f3install\fR method\&. +.TP +getserverid -applicationName \fIapplication-name\fR +Returns the server ID that corresponds to the \f3application-name\fR value\&. +.TP +list +Lists information about all persistent servers registered with the ORBD\&. +.TP +listappnames +Lists the application names for all servers currently registered with the ORBD\&. +.TP +listactive +Lists information about all persistent servers that were started by the ORBD and are currently running\&. +.TP +.ll 180 +locate -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR [ -endpointType \fIendpointType\fR ] +Locates the endpoints (ports) of a specific type for all ORBs created by a registered server\&. If a server is not already running, then it is activated\&. If an \f3endpointType\fR value is not specified, then the plain/non-protected endpoint associated with each ORB in a server is returned\&. +.TP +.ll 180 +locateperorb -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR [ -orbid \fIORB-name\fR ] +Locates all the endpoints (ports) registered by a specific Object Request Broker (ORB) of registered server\&. If a server is not already running, then it is activated\&. If an \f3orbid\fR is not specified, then the default value of \f3""\fR is assigned to the \f3orbid\fR\&. If any ORBs are created with an \f3orbid\fR of empty string, then all ports registered by it are returned\&. +.TP +orblist -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR +Lists the \f3ORBId\fR of the ORBs defined on a server\&. An \f3ORBId\fR is the string name for the ORB created by the server\&. If the server is not already running, then it is activated\&. +.TP +shutdown -serverid \fIserver-id\fR | -applicationName application-name +Shut down an active server that is registered with ORBD\&. During execution of this command, the \f3shutdown\fR method defined in the class specified by either the \f3-serverid\fR or \f3-applicationName\fR parameter is also called to shut down the server process\&. +.TP +startup -serverid \fIserver-id\fR | -applicationName application-name +Starts up or activate a server that is registered with ORBD\&. If the server is not running, then this command starts the server\&. If the server is already running, then an error message is displayed\&. +.TP +help +Lists all the commands available to the server through the \f3servertool\fR command\&. +.TP +quit +Exits the \f3servertool\fR command\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +orbd(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/tnameserv.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/tnameserv.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,488 +1,488 @@ -'\" t -.\" Copyright (c) 1999, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java IDL and RMI-IIOP Tools -.\" Title: tnameserv.1 -.\" -.if n .pl 99999 -.TH tnameserv 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -tnameserv \- Interface Definition Language (IDL)\&. -.SH SYNOPSIS -.sp -.nf - -\fBtnameserve\fR \fB\-ORBInitialPort\fR [ \fInameserverport\fR ] -.fi -.sp -.TP --ORBInitialPort \fInameserverport\fR -.br -The initial port where the naming service listens for the bootstrap protocol used to implement the ORB \f3resolve_initial_references\fR and \f3list_initial_references\fR methods\&. -.SH DESCRIPTION -Java IDL includes the Object Request Broker Daemon (ORBD)\&. ORBD is a daemon process that contains a Bootstrap Service, a Transient Naming Service, a Persistent Naming Service, and a Server Manager\&. The Java IDL tutorials all use ORBD, but you can substitute the \f3tnameserv\fR command for the \f3orbd\fR command in any of the examples that use a Transient Naming Service\&. -.PP -See orbd(1) or Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html -.PP -The CORBA Common Object Services (COS) Naming Service provides a tree-structure directory for object references similar to a file system that provides a directory structure for files\&. The Transient Naming Service provided with Java IDL, \f3tnameserv\fR, is a simple implementation of the COS Naming Service specification\&. -.PP -Object references are stored in the name space by name and each object reference-name pair is called a name binding\&. Name bindings can be organized under naming contexts\&. Naming contexts are name bindings and serve the same organizational function as a file system subdirectory\&. All bindings are stored under the initial naming context\&. The initial naming context is the only persistent binding in the name space\&. The rest of the name space is lost when the Java IDL naming service process stops and restarts\&. -.PP -For an applet or application to use COS naming, its ORB must know the port of a host running a naming service or have access to an initial naming context string for that naming service\&. The naming service can either be the Java IDL naming service or another COS-compliant naming service\&. -.SS START\ THE\ NAMING\ SERVICE -You must start the Java IDL naming service before an application or applet that uses its naming service\&. Installation of the Java IDL product creates a script (Oracle Solaris: \f3tnameserv\fR) or executable file (Windows: \f3tnameserv\&.exe\fR) that starts the Java IDL naming service\&. Start the naming service so it runs in the background\&. -.PP -If you do not specify otherwise, then the Java IDL naming service listens on port 900 for the bootstrap protocol used to implement the ORB \f3resolve_initial_references\fR and \f3list_initial_references methods\fR, as follows: -.sp -.nf -\f3tnameserv \-ORBInitialPort nameserverport&\fP -.fi -.nf -\f3\fP -.fi -.sp -If you do not specify the name server port, then port 900 is used by default\&. When running Oracle Solaris software, you must become the root user to start a process on a port below 1024\&. For this reason, it is recommended that you use a port number greater than or equal to 1024\&. To specify a different port, for example, 1050, and to run the naming service in the background, from a UNIX command shell, enter: -.sp -.nf -\f3tnameserv \-ORBInitialPort 1050&\fP -.fi -.nf -\f3\fP -.fi -.sp -From an MS-DOS system prompt (Windows), enter: -.sp -.nf -\f3start tnameserv \-ORBInitialPort 1050\fP -.fi -.nf -\f3\fP -.fi -.sp -Clients of the name server must be made aware of the new port number\&. Do this by setting the \f3org\&.omg\&.CORBA\&.ORBInitialPort\fR property to the new port number when you create the ORB object\&. -.SS RUN\ THE\ SERVER\ AND\ CLIENT\ ON\ DIFFERENT\ HOSTS -In most of the Java IDL and RMI-IIOP tutorials, the naming service, server, and client are all running on the development machine\&. In real-world deployment, the client and server probably run on different host machines from the Naming Service\&. -.PP -For the client and server to find the Naming Service, they must be made aware of the port number and host on which the naming service is running\&. Do this by setting the \f3org\&.omg\&.CORBA\&.ORBInitialPort\fR and \f3org\&.omg\&.CORBA\&.ORBInitialHost\fR properties in the client and server files to the machine name and port number on which the Naming Service is running\&. An example of this is shown in Getting Started Using RMI-IIOP at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/rmi-iiop/rmiiiopexample\&.html -.PP -You could also use the command-line options \f3-ORBInitialPort nameserverport#\fR and \f3-ORBInitialHost nameserverhostname\fR to tell the client and server where to find the naming service\&. For one example of doing this using the command-line option, see Java IDL: The Hello World Example on Two Machines at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/tutorial/jidl2machines\&.html -.PP -For example, suppose the Transient Naming Service, \f3tnameserv\fR is running on port 1050 on host \f3nameserverhost\fR\&. The client is running on host \f3clienthost,\fR and the server is running on host \f3serverhost\fR\&. -.PP -Start \f3tnameserv\fR on the host \f3nameserverhost\fR: -.sp -.nf -\f3tnameserv \-ORBInitialPort 1050\fP -.fi -.nf -\f3\fP -.fi -.sp -Start the server on the \f3serverhost\fR: -.sp -.nf -\f3java Server \-ORBInitialPort 1050 \-ORBInitialHost nameserverhost\fP -.fi -.nf -\f3\fP -.fi -.sp -Start the client on the \f3clienthost\fR: -.sp -.nf -\f3java Client \-ORBInitialPort 1050 \-ORBInitialHost nameserverhost\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS STOP\ THE\ NAMING\ SERVICE -To stop the Java IDL naming service, use the relevant operating system command, such as \f3kill\fR for a Unix process or \f3Ctrl+C\fR for a Windows process\&. The naming service continues to wait for invocations until it is explicitly shut down\&. Note that names registered with the Java IDL naming service disappear when the service is terminated\&. -.SH OPTIONS -.TP --J\fIoption\fR -.br -Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH EXAMPLES -.SS ADD\ OBJECTS\ TO\ THE\ NAME\ SPACE -The following example shows how to add names to the name space\&. It is a self-contained Transient Naming Service client that creates the following simple tree\&. -.sp -.nf -\f3Initial Naming Context\fP -.fi -.nf -\f3 plans\fP -.fi -.nf -\f3 Personal\fP -.fi -.nf -\f3 calendar\fP -.fi -.nf -\f3 schedule\fP -.fi -.nf -\f3\fP -.fi -.sp -In this example, \f3plans\fR is an object reference and \f3Personal\fR is a naming context that contains two object references: \f3calendar\fR and \f3schedule\fR\&. -.sp -.nf -\f3import java\&.util\&.Properties;\fP -.fi -.nf -\f3import org\&.omg\&.CORBA\&.*;\fP -.fi -.nf -\f3import org\&.omg\&.CosNaming\&.*;\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3public class NameClient {\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 public static void main(String args[]) {\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 try {\fP -.fi -.nf -\f3\fP -.fi -.sp -In Start the Naming Service, the \f3nameserver\fR was started on port 1050\&. The following code ensures that the client program is aware of this port number\&. -.sp -.nf -\f3 Properties props = new Properties();\fP -.fi -.nf -\f3 props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP -.fi -.nf -\f3 ORB orb = ORB\&.init(args, props);\fP -.fi -.nf -\f3\fP -.fi -.sp -This code obtains the initial naming context and assigns it to \f3ctx\fR\&. The second line copies \f3ctx\fR into a dummy object reference \f3objref\fR that is attached to various names and added into the name space\&. -.sp -.nf -\f3 NamingContext ctx =\fP -.fi -.nf -\f3 NamingContextHelper\&.narrow(\fP -.fi -.nf -\f3 orb\&.resolve_initial_references("NameService"));\fP -.fi -.nf -\f3 NamingContext objref = ctx;\fP -.fi -.nf -\f3\fP -.fi -.sp -This code creates a name \f3plans\fR of type \f3text\fR and binds it to the dummy object reference\&. \f3plans\fR is then added under the initial naming context using the \f3rebind\fR method\&. The \f3rebind\fR method enables you to run this program over and over again without getting the exceptions from using the \f3bind\fR method\&. -.sp -.nf -\f3 NameComponent nc1 = new NameComponent("plans", "text");\fP -.fi -.nf -\f3 NameComponent[] name1 = {nc1};\fP -.fi -.nf -\f3 ctx\&.rebind(name1, objref);\fP -.fi -.nf -\f3 System\&.out\&.println("plans rebind successful!");\fP -.fi -.nf -\f3\fP -.fi -.sp -This code creates a naming context called \f3Personal\fR of type \f3directory\fR\&. The resulting object reference, \f3ctx2\fR, is bound to the \f3name\fR and added under the initial naming context\&. -.sp -.nf -\f3 NameComponent nc2 = new NameComponent("Personal", "directory");\fP -.fi -.nf -\f3 NameComponent[] name2 = {nc2};\fP -.fi -.nf -\f3 NamingContext ctx2 = ctx\&.bind_new_context(name2);\fP -.fi -.nf -\f3 System\&.out\&.println("new naming context added\&.\&.");\fP -.fi -.nf -\f3\fP -.fi -.sp -The remainder of the code binds the dummy object reference using the names \f3schedule\fR and \f3calendar\fR under the \f3Personal\fR naming context (\f3ctx2\fR)\&. -.sp -.nf -\f3 NameComponent nc3 = new NameComponent("schedule", "text");\fP -.fi -.nf -\f3 NameComponent[] name3 = {nc3};\fP -.fi -.nf -\f3 ctx2\&.rebind(name3, objref);\fP -.fi -.nf -\f3 System\&.out\&.println("schedule rebind successful!");\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 NameComponent nc4 = new NameComponent("calender", "text");\fP -.fi -.nf -\f3 NameComponent[] name4 = {nc4};\fP -.fi -.nf -\f3 ctx2\&.rebind(name4, objref);\fP -.fi -.nf -\f3 System\&.out\&.println("calender rebind successful!");\fP -.fi -.nf -\f3 } catch (Exception e) {\fP -.fi -.nf -\f3 e\&.printStackTrace(System\&.err);\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp -.SS BROWSING\ THE\ NAME\ SPACE -The following sample program shoes how to browse the name space\&. -.sp -.nf -\f3import java\&.util\&.Properties;\fP -.fi -.nf -\f3import org\&.omg\&.CORBA\&.*;\fP -.fi -.nf -\f3import org\&.omg\&.CosNaming\&.*;\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3public class NameClientList {\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 public static void main(String args[]) {\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 try {\fP -.fi -.nf -\f3\fP -.fi -.sp -In Start the Naming Service, the \f3nameserver\fR was started on port 1050\&. The following code ensures that the client program is aware of this port number\&. -.sp -.nf -\f3 Properties props = new Properties();\fP -.fi -.nf -\f3 props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP -.fi -.nf -\f3 ORB orb = ORB\&.init(args, props);\fP -.fi -.nf -\f3\fP -.fi -.sp -The following code obtains the initial naming context\&. -.sp -.nf -\f3 NamingContext nc =\fP -.fi -.nf -\f3 NamingContextHelper\&.narrow(\fP -.fi -.nf -\f3 orb\&.resolve_initial_references("NameService"));\fP -.fi -.nf -\f3\fP -.fi -.sp -The \f3list\fR method lists the bindings in the naming context\&. In this case, up to 1000 bindings from the initial naming context will be returned in the \f3BindingListHolder\fR; any remaining bindings are returned in the \f3BindingIteratorHolder\fR\&. -.sp -.nf -\f3 BindingListHolder bl = new BindingListHolder();\fP -.fi -.nf -\f3 BindingIteratorHolder blIt= new BindingIteratorHolder();\fP -.fi -.nf -\f3 nc\&.list(1000, bl, blIt);\fP -.fi -.nf -\f3\fP -.fi -.sp -This code gets the array of bindings out of the returned \f3BindingListHolder\fR\&. If there are no bindings, then the program ends\&. -.sp -.nf -\f3 Binding bindings[] = bl\&.value;\fP -.fi -.nf -\f3 if (bindings\&.length == 0) return;\fP -.fi -.nf -\f3\fP -.fi -.sp -The remainder of the code loops through the bindings and prints outs the names\&. -.sp -.nf -\f3 for (int i=0; i < bindings\&.length; i++) {\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 // get the object reference for each binding\fP -.fi -.nf -\f3 org\&.omg\&.CORBA\&.Object obj = nc\&.resolve(bindings[i]\&.binding_name);\fP -.fi -.nf -\f3 String objStr = orb\&.object_to_string(obj);\fP -.fi -.nf -\f3 int lastIx = bindings[i]\&.binding_name\&.length\-1;\fP -.fi -.nf -\f3\fP -.fi -.nf -\f3 // check to see if this is a naming context\fP -.fi -.nf -\f3 if (bindings[i]\&.binding_type == BindingType\&.ncontext) {\fP -.fi -.nf -\f3 System\&.out\&.println("Context: " +\fP -.fi -.nf -\f3 bindings[i]\&.binding_name[lastIx]\&.id);\fP -.fi -.nf -\f3 } else {\fP -.fi -.nf -\f3 System\&.out\&.println("Object: " +\fP -.fi -.nf -\f3 bindings[i]\&.binding_name[lastIx]\&.id);\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3 } catch (Exception e) {\fP -.fi -.nf -\f3 e\&.printStackTrace(System\&.err)\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3 }\fP -.fi -.nf -\f3}\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH SEE\ ALSO -.TP 0.2i -\(bu -orbd(1) -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 1999, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java IDL and RMI-IIOP Tools +.\" Title: tnameserv.1 +.\" +.if n .pl 99999 +.TH tnameserv 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +tnameserv \- Interface Definition Language (IDL)\&. +.SH SYNOPSIS +.sp +.nf + +\fBtnameserve\fR \fB\-ORBInitialPort\fR [ \fInameserverport\fR ] +.fi +.sp +.TP +-ORBInitialPort \fInameserverport\fR +.br +The initial port where the naming service listens for the bootstrap protocol used to implement the ORB \f3resolve_initial_references\fR and \f3list_initial_references\fR methods\&. +.SH DESCRIPTION +Java IDL includes the Object Request Broker Daemon (ORBD)\&. ORBD is a daemon process that contains a Bootstrap Service, a Transient Naming Service, a Persistent Naming Service, and a Server Manager\&. The Java IDL tutorials all use ORBD, but you can substitute the \f3tnameserv\fR command for the \f3orbd\fR command in any of the examples that use a Transient Naming Service\&. +.PP +See orbd(1) or Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html +.PP +The CORBA Common Object Services (COS) Naming Service provides a tree-structure directory for object references similar to a file system that provides a directory structure for files\&. The Transient Naming Service provided with Java IDL, \f3tnameserv\fR, is a simple implementation of the COS Naming Service specification\&. +.PP +Object references are stored in the name space by name and each object reference-name pair is called a name binding\&. Name bindings can be organized under naming contexts\&. Naming contexts are name bindings and serve the same organizational function as a file system subdirectory\&. All bindings are stored under the initial naming context\&. The initial naming context is the only persistent binding in the name space\&. The rest of the name space is lost when the Java IDL naming service process stops and restarts\&. +.PP +For an applet or application to use COS naming, its ORB must know the port of a host running a naming service or have access to an initial naming context string for that naming service\&. The naming service can either be the Java IDL naming service or another COS-compliant naming service\&. +.SS START\ THE\ NAMING\ SERVICE +You must start the Java IDL naming service before an application or applet that uses its naming service\&. Installation of the Java IDL product creates a script (Oracle Solaris: \f3tnameserv\fR) or executable file (Windows: \f3tnameserv\&.exe\fR) that starts the Java IDL naming service\&. Start the naming service so it runs in the background\&. +.PP +If you do not specify otherwise, then the Java IDL naming service listens on port 900 for the bootstrap protocol used to implement the ORB \f3resolve_initial_references\fR and \f3list_initial_references methods\fR, as follows: +.sp +.nf +\f3tnameserv \-ORBInitialPort nameserverport&\fP +.fi +.nf +\f3\fP +.fi +.sp +If you do not specify the name server port, then port 900 is used by default\&. When running Oracle Solaris software, you must become the root user to start a process on a port below 1024\&. For this reason, it is recommended that you use a port number greater than or equal to 1024\&. To specify a different port, for example, 1050, and to run the naming service in the background, from a UNIX command shell, enter: +.sp +.nf +\f3tnameserv \-ORBInitialPort 1050&\fP +.fi +.nf +\f3\fP +.fi +.sp +From an MS-DOS system prompt (Windows), enter: +.sp +.nf +\f3start tnameserv \-ORBInitialPort 1050\fP +.fi +.nf +\f3\fP +.fi +.sp +Clients of the name server must be made aware of the new port number\&. Do this by setting the \f3org\&.omg\&.CORBA\&.ORBInitialPort\fR property to the new port number when you create the ORB object\&. +.SS RUN\ THE\ SERVER\ AND\ CLIENT\ ON\ DIFFERENT\ HOSTS +In most of the Java IDL and RMI-IIOP tutorials, the naming service, server, and client are all running on the development machine\&. In real-world deployment, the client and server probably run on different host machines from the Naming Service\&. +.PP +For the client and server to find the Naming Service, they must be made aware of the port number and host on which the naming service is running\&. Do this by setting the \f3org\&.omg\&.CORBA\&.ORBInitialPort\fR and \f3org\&.omg\&.CORBA\&.ORBInitialHost\fR properties in the client and server files to the machine name and port number on which the Naming Service is running\&. An example of this is shown in Getting Started Using RMI-IIOP at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/rmi-iiop/rmiiiopexample\&.html +.PP +You could also use the command-line options \f3-ORBInitialPort nameserverport#\fR and \f3-ORBInitialHost nameserverhostname\fR to tell the client and server where to find the naming service\&. For one example of doing this using the command-line option, see Java IDL: The Hello World Example on Two Machines at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/tutorial/jidl2machines\&.html +.PP +For example, suppose the Transient Naming Service, \f3tnameserv\fR is running on port 1050 on host \f3nameserverhost\fR\&. The client is running on host \f3clienthost,\fR and the server is running on host \f3serverhost\fR\&. +.PP +Start \f3tnameserv\fR on the host \f3nameserverhost\fR: +.sp +.nf +\f3tnameserv \-ORBInitialPort 1050\fP +.fi +.nf +\f3\fP +.fi +.sp +Start the server on the \f3serverhost\fR: +.sp +.nf +\f3java Server \-ORBInitialPort 1050 \-ORBInitialHost nameserverhost\fP +.fi +.nf +\f3\fP +.fi +.sp +Start the client on the \f3clienthost\fR: +.sp +.nf +\f3java Client \-ORBInitialPort 1050 \-ORBInitialHost nameserverhost\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS STOP\ THE\ NAMING\ SERVICE +To stop the Java IDL naming service, use the relevant operating system command, such as \f3kill\fR for a Unix process or \f3Ctrl+C\fR for a Windows process\&. The naming service continues to wait for invocations until it is explicitly shut down\&. Note that names registered with the Java IDL naming service disappear when the service is terminated\&. +.SH OPTIONS +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH EXAMPLES +.SS ADD\ OBJECTS\ TO\ THE\ NAME\ SPACE +The following example shows how to add names to the name space\&. It is a self-contained Transient Naming Service client that creates the following simple tree\&. +.sp +.nf +\f3Initial Naming Context\fP +.fi +.nf +\f3 plans\fP +.fi +.nf +\f3 Personal\fP +.fi +.nf +\f3 calendar\fP +.fi +.nf +\f3 schedule\fP +.fi +.nf +\f3\fP +.fi +.sp +In this example, \f3plans\fR is an object reference and \f3Personal\fR is a naming context that contains two object references: \f3calendar\fR and \f3schedule\fR\&. +.sp +.nf +\f3import java\&.util\&.Properties;\fP +.fi +.nf +\f3import org\&.omg\&.CORBA\&.*;\fP +.fi +.nf +\f3import org\&.omg\&.CosNaming\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class NameClient {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public static void main(String args[]) {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 try {\fP +.fi +.nf +\f3\fP +.fi +.sp +In Start the Naming Service, the \f3nameserver\fR was started on port 1050\&. The following code ensures that the client program is aware of this port number\&. +.sp +.nf +\f3 Properties props = new Properties();\fP +.fi +.nf +\f3 props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP +.fi +.nf +\f3 ORB orb = ORB\&.init(args, props);\fP +.fi +.nf +\f3\fP +.fi +.sp +This code obtains the initial naming context and assigns it to \f3ctx\fR\&. The second line copies \f3ctx\fR into a dummy object reference \f3objref\fR that is attached to various names and added into the name space\&. +.sp +.nf +\f3 NamingContext ctx =\fP +.fi +.nf +\f3 NamingContextHelper\&.narrow(\fP +.fi +.nf +\f3 orb\&.resolve_initial_references("NameService"));\fP +.fi +.nf +\f3 NamingContext objref = ctx;\fP +.fi +.nf +\f3\fP +.fi +.sp +This code creates a name \f3plans\fR of type \f3text\fR and binds it to the dummy object reference\&. \f3plans\fR is then added under the initial naming context using the \f3rebind\fR method\&. The \f3rebind\fR method enables you to run this program over and over again without getting the exceptions from using the \f3bind\fR method\&. +.sp +.nf +\f3 NameComponent nc1 = new NameComponent("plans", "text");\fP +.fi +.nf +\f3 NameComponent[] name1 = {nc1};\fP +.fi +.nf +\f3 ctx\&.rebind(name1, objref);\fP +.fi +.nf +\f3 System\&.out\&.println("plans rebind successful!");\fP +.fi +.nf +\f3\fP +.fi +.sp +This code creates a naming context called \f3Personal\fR of type \f3directory\fR\&. The resulting object reference, \f3ctx2\fR, is bound to the \f3name\fR and added under the initial naming context\&. +.sp +.nf +\f3 NameComponent nc2 = new NameComponent("Personal", "directory");\fP +.fi +.nf +\f3 NameComponent[] name2 = {nc2};\fP +.fi +.nf +\f3 NamingContext ctx2 = ctx\&.bind_new_context(name2);\fP +.fi +.nf +\f3 System\&.out\&.println("new naming context added\&.\&.");\fP +.fi +.nf +\f3\fP +.fi +.sp +The remainder of the code binds the dummy object reference using the names \f3schedule\fR and \f3calendar\fR under the \f3Personal\fR naming context (\f3ctx2\fR)\&. +.sp +.nf +\f3 NameComponent nc3 = new NameComponent("schedule", "text");\fP +.fi +.nf +\f3 NameComponent[] name3 = {nc3};\fP +.fi +.nf +\f3 ctx2\&.rebind(name3, objref);\fP +.fi +.nf +\f3 System\&.out\&.println("schedule rebind successful!");\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 NameComponent nc4 = new NameComponent("calender", "text");\fP +.fi +.nf +\f3 NameComponent[] name4 = {nc4};\fP +.fi +.nf +\f3 ctx2\&.rebind(name4, objref);\fP +.fi +.nf +\f3 System\&.out\&.println("calender rebind successful!");\fP +.fi +.nf +\f3 } catch (Exception e) {\fP +.fi +.nf +\f3 e\&.printStackTrace(System\&.err);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS BROWSING\ THE\ NAME\ SPACE +The following sample program shoes how to browse the name space\&. +.sp +.nf +\f3import java\&.util\&.Properties;\fP +.fi +.nf +\f3import org\&.omg\&.CORBA\&.*;\fP +.fi +.nf +\f3import org\&.omg\&.CosNaming\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class NameClientList {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public static void main(String args[]) {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 try {\fP +.fi +.nf +\f3\fP +.fi +.sp +In Start the Naming Service, the \f3nameserver\fR was started on port 1050\&. The following code ensures that the client program is aware of this port number\&. +.sp +.nf +\f3 Properties props = new Properties();\fP +.fi +.nf +\f3 props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP +.fi +.nf +\f3 ORB orb = ORB\&.init(args, props);\fP +.fi +.nf +\f3\fP +.fi +.sp +The following code obtains the initial naming context\&. +.sp +.nf +\f3 NamingContext nc =\fP +.fi +.nf +\f3 NamingContextHelper\&.narrow(\fP +.fi +.nf +\f3 orb\&.resolve_initial_references("NameService"));\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3list\fR method lists the bindings in the naming context\&. In this case, up to 1000 bindings from the initial naming context will be returned in the \f3BindingListHolder\fR; any remaining bindings are returned in the \f3BindingIteratorHolder\fR\&. +.sp +.nf +\f3 BindingListHolder bl = new BindingListHolder();\fP +.fi +.nf +\f3 BindingIteratorHolder blIt= new BindingIteratorHolder();\fP +.fi +.nf +\f3 nc\&.list(1000, bl, blIt);\fP +.fi +.nf +\f3\fP +.fi +.sp +This code gets the array of bindings out of the returned \f3BindingListHolder\fR\&. If there are no bindings, then the program ends\&. +.sp +.nf +\f3 Binding bindings[] = bl\&.value;\fP +.fi +.nf +\f3 if (bindings\&.length == 0) return;\fP +.fi +.nf +\f3\fP +.fi +.sp +The remainder of the code loops through the bindings and prints outs the names\&. +.sp +.nf +\f3 for (int i=0; i < bindings\&.length; i++) {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 // get the object reference for each binding\fP +.fi +.nf +\f3 org\&.omg\&.CORBA\&.Object obj = nc\&.resolve(bindings[i]\&.binding_name);\fP +.fi +.nf +\f3 String objStr = orb\&.object_to_string(obj);\fP +.fi +.nf +\f3 int lastIx = bindings[i]\&.binding_name\&.length\-1;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 // check to see if this is a naming context\fP +.fi +.nf +\f3 if (bindings[i]\&.binding_type == BindingType\&.ncontext) {\fP +.fi +.nf +\f3 System\&.out\&.println("Context: " +\fP +.fi +.nf +\f3 bindings[i]\&.binding_name[lastIx]\&.id);\fP +.fi +.nf +\f3 } else {\fP +.fi +.nf +\f3 System\&.out\&.println("Object: " +\fP +.fi +.nf +\f3 bindings[i]\&.binding_name[lastIx]\&.id);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 } catch (Exception e) {\fP +.fi +.nf +\f3 e\&.printStackTrace(System\&.err)\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +orbd(1) +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/unpack200.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/unpack200.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,137 +1,137 @@ -'\" t -.\" Copyright (c) 2004, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java Deployment Tools -.\" Title: unpack200.1 -.\" -.if n .pl 99999 -.TH unpack200 1 "21 November 2013" "JDK 8" "Java Deployment Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -unpack200 \- Transforms a packed file produced by pack200(1) into a JAR file for web deployment\&. -.SH SYNOPSIS -.sp -.nf - -\fBunpack200\fR [ \fIoptions\fR ] input\-file \fIJAR\-file\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIinput-file\fR -Name of the input file, which can be a pack200 gzip file or a pack200 file\&. The input can also be JAR file produced by \f3pack200\fR(1) with an effort of \f30\fR, in which case the contents of the input file are copied to the output JAR file with the Pack200 marker\&. -.TP -\fIJAR-file\fR -Name of the output JAR file\&. -.SH DESCRIPTION -The \f3unpack200\fR command is a native implementation that transforms a packed file produced by \f3pack200\fR\f3(1)\fR into a JAR file\&. A typical usage follows\&. In the following example, the \f3myarchive\&.jar\fR file is produced from \f3myarchive\&.pack\&.gz\fR with the default \f3unpack200\fR command settings\&. -.sp -.nf -\f3unpack200 myarchive\&.pack\&.gz myarchive\&.jar\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH OPTIONS -.TP --Hvalue --deflate-hint=\fIvalue\fR -.br -Sets the deflation to be \f3true\fR, \f3false\fR, or \f3keep\fR on all entries within a JAR file\&. The default mode is \f3keep\fR\&. If the value is \f3true\fR or \f3false\fR, then the \f3--deflate=hint\fR option overrides the default behavior and sets the deflation mode on all entries within the output JAR file\&. -.TP --r --remove-pack-file -.br -Removes the input pack file\&. -.TP --v --verbose -.br -Displays minimal messages\&. Multiple specifications of this option displays more verbose messages\&. -.TP --q --quiet -.br -Specifies quiet operation with no messages\&. -.TP --lfilename --log-file=\fIfilename\fR -.br -Specifies a log file where output messages are logged\&. -.TP --? -h --help -.br -Prints help information about the \f3unpack200\fR command\&. -.TP --V --version -.br -Prints version information about the \f3unpack200\fR command\&. -.TP --J\fIoption\fR -.br -Passes option to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.SH NOTES -This command should not be confused with the \f3unpack\fR command\&. They are distinctly separate products\&. -.PP -The Java SE API Specification provided with the JDK is the superseding authority in case of discrepancies\&. -.SH EXIT\ STATUS -The following exit values are returned: 0 for successful completion, and a value that is greater than 0 when an error occurred\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -pack200(1) -.TP 0.2i -\(bu -jar(1) -.TP 0.2i -\(bu -jarsigner(1) -.TP 0.2i -\(bu -Pack200 and Compression at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/deployment/deployment-guide/pack200\&.html -.TP 0.2i -\(bu -The Java SE Technical Documentation page at http://docs\&.oracle\&.com/javase/ -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2004, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Deployment Tools +.\" Title: unpack200.1 +.\" +.if n .pl 99999 +.TH unpack200 1 "21 November 2013" "JDK 8" "Java Deployment Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +unpack200 \- Transforms a packed file produced by pack200(1) into a JAR file for web deployment\&. +.SH SYNOPSIS +.sp +.nf + +\fBunpack200\fR [ \fIoptions\fR ] input\-file \fIJAR\-file\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIinput-file\fR +Name of the input file, which can be a pack200 gzip file or a pack200 file\&. The input can also be JAR file produced by \f3pack200\fR(1) with an effort of \f30\fR, in which case the contents of the input file are copied to the output JAR file with the Pack200 marker\&. +.TP +\fIJAR-file\fR +Name of the output JAR file\&. +.SH DESCRIPTION +The \f3unpack200\fR command is a native implementation that transforms a packed file produced by \f3pack200\fR\f3(1)\fR into a JAR file\&. A typical usage follows\&. In the following example, the \f3myarchive\&.jar\fR file is produced from \f3myarchive\&.pack\&.gz\fR with the default \f3unpack200\fR command settings\&. +.sp +.nf +\f3unpack200 myarchive\&.pack\&.gz myarchive\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-Hvalue --deflate-hint=\fIvalue\fR +.br +Sets the deflation to be \f3true\fR, \f3false\fR, or \f3keep\fR on all entries within a JAR file\&. The default mode is \f3keep\fR\&. If the value is \f3true\fR or \f3false\fR, then the \f3--deflate=hint\fR option overrides the default behavior and sets the deflation mode on all entries within the output JAR file\&. +.TP +-r --remove-pack-file +.br +Removes the input pack file\&. +.TP +-v --verbose +.br +Displays minimal messages\&. Multiple specifications of this option displays more verbose messages\&. +.TP +-q --quiet +.br +Specifies quiet operation with no messages\&. +.TP +-lfilename --log-file=\fIfilename\fR +.br +Specifies a log file where output messages are logged\&. +.TP +-? -h --help +.br +Prints help information about the \f3unpack200\fR command\&. +.TP +-V --version +.br +Prints version information about the \f3unpack200\fR command\&. +.TP +-J\fIoption\fR +.br +Passes option to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH NOTES +This command should not be confused with the \f3unpack\fR command\&. They are distinctly separate products\&. +.PP +The Java SE API Specification provided with the JDK is the superseding authority in case of discrepancies\&. +.SH EXIT\ STATUS +The following exit values are returned: 0 for successful completion, and a value that is greater than 0 when an error occurred\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +pack200(1) +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +jarsigner(1) +.TP 0.2i +\(bu +Pack200 and Compression at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/deployment/deployment-guide/pack200\&.html +.TP 0.2i +\(bu +The Java SE Technical Documentation page at http://docs\&.oracle\&.com/javase/ +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/wsgen.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/wsgen.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,175 +1,175 @@ -'\" t -.\" Copyright (c) 2005, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java Web Services Tools -.\" Title: wsgen.1 -.\" -.if n .pl 99999 -.TH wsgen 1 "21 November 2013" "JDK 8" "Java Web Services Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -wsgen \- Reads a web service endpoint implementation (SEI) class and generates all of the required artifacts for web service deployment, and invocation\&. -.SH SYNOPSIS -.sp -.nf - -\fBwsgen\fR [ \fIoptions\fR ] \fISEI\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fISEI\fR -The web service endpoint implementation class (SEI) to be read\&. -.SH DESCRIPTION -The \f3wsgen\fR command 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 \f3wsgen\fR Ant task, see the \fITools\fR tab of the JAX-WS (wsgen) page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsgenant\&.html -.PP -To start the \f3wsgen\fR command, do the following: -.sp -.nf -\f3export JAXWS_HOME=/pathto/jaxws\-ri\fP -.fi -.nf -\f3$JAXWS_HOME/bin/wsgen\&.sh \-help\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH OPTIONS -.TP --classpath \fIpath\fR -.br -The location of the input class files\&. -.TP --cp \fIpath\fR -.br -The location of the input class files\&. -.TP --d \fIdirectory\fR -.br -The location for where to place generated output files\&. -.TP --extension -.br -Allow vendor extensions\&. Use of extensions can result in applications that are not portable or that do not work with other implementations\&. -.TP --help -.br -Displays a help message about the \f3wsgen\fR command\&. -.TP --keep -.br -Keeps the generated files\&. -.TP --r \fIdirectory\fR -.br -Uses this option with the \f3-wsdl\fR option to specify where to place generated resource files such as WSDLs\&. -.TP --s \fIdirectory\fR -.br -The location for where to place generated source files\&. -.TP --verbose -.br -Displays compiler messages\&. -.TP --version -.br -Prints release information\&. -.TP --wsdl [ :protocol ] \fI\fR -.br -An optional command that generates a WSDL file to review before endpoint deployment\&. The WSDL files contains a machine-readable description of how the service can be called, what parameters it expects, and what data structures it returns\&. - -By default the \f3wsgen\fR command does not generate a WSDL file\&. The \f3protocol\fR value is optional and is used to specify what protocol should be used for the WSDL binding (\f3wsdl:binding\fR)\&. Valid protocols are \f3soap1\&.1\fR and \f3Xsoap1\&.2\fR\&. The default is \f3soap1\&.1\fR\&. The \f3Xsoap1\&.2\fR protocol is not standard and can only be used with the \f3-extension\fR option\&. -.TP --servicename \fIname\fR -.br -Used only with the \f3-wsdl\fR option to specify a particular WSDL service (\f3wsdl:service\fR) name to be generated in the WSDL, for example: \f3-servicename "{http://mynamespace/}MyService"\fR\&. -.TP --portname \fIname\fR -.br -Used only with the \f3-wsdl\fR option to specify a particular WSDL port (\f3wsdl:port\fR) name to be generated in the WSDL, for example: \f3-portname "{http://mynamespace/}MyPort"\fR\&. -.SH EXAMPLES -The following example generates the wrapper classes for \f3StockService\fR with \f3@WebService\fR annotations inside stock directory\&. -.sp -.nf -\f3wsgen \-d stock \-cp myclasspath stock\&.StockService\fP -.fi -.nf -\f3\fP -.fi -.sp -The following example generates a SOAP 1\&.1 WSDL and schema for the \f3stock\&.StockService\fR class with \f3@WebService\fR annotations\&. -.sp -.nf -\f3wsgen \-wsdl \-d stock \-cp myclasspath stock\&.StockService\fP -.fi -.nf -\f3\fP -.fi -.sp -The following example generates a SOAP 1\&.2 WSDL\&. -.sp -.nf -\f3wsgen \-wsdl:Xsoap1\&.2 \-d stock \-cp myclasspath stock\&.StockService \fP -.fi -.nf -\f3\fP -.fi -.sp -\fINote:\fR You do not have to generate WSDL at development time because the JAXWS run time environment generates a WSDL for you when you deploy your service\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -wsimport(1) -.TP 0.2i -\(bu -\fIThe Tools\fR tab of the JAX-WS (wsgen) page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsgenant\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2005, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Web Services Tools +.\" Title: wsgen.1 +.\" +.if n .pl 99999 +.TH wsgen 1 "21 November 2013" "JDK 8" "Java Web Services Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +wsgen \- Reads a web service endpoint implementation (SEI) class and generates all of the required artifacts for web service deployment, and invocation\&. +.SH SYNOPSIS +.sp +.nf + +\fBwsgen\fR [ \fIoptions\fR ] \fISEI\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fISEI\fR +The web service endpoint implementation class (SEI) to be read\&. +.SH DESCRIPTION +The \f3wsgen\fR command 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 \f3wsgen\fR Ant task, see the \fITools\fR tab of the JAX-WS (wsgen) page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsgenant\&.html +.PP +To start the \f3wsgen\fR command, do the following: +.sp +.nf +\f3export JAXWS_HOME=/pathto/jaxws\-ri\fP +.fi +.nf +\f3$JAXWS_HOME/bin/wsgen\&.sh \-help\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-classpath \fIpath\fR +.br +The location of the input class files\&. +.TP +-cp \fIpath\fR +.br +The location of the input class files\&. +.TP +-d \fIdirectory\fR +.br +The location for where to place generated output files\&. +.TP +-extension +.br +Allow vendor extensions\&. Use of extensions can result in applications that are not portable or that do not work with other implementations\&. +.TP +-help +.br +Displays a help message about the \f3wsgen\fR command\&. +.TP +-keep +.br +Keeps the generated files\&. +.TP +-r \fIdirectory\fR +.br +Uses this option with the \f3-wsdl\fR option to specify where to place generated resource files such as WSDLs\&. +.TP +-s \fIdirectory\fR +.br +The location for where to place generated source files\&. +.TP +-verbose +.br +Displays compiler messages\&. +.TP +-version +.br +Prints release information\&. +.TP +-wsdl [ :protocol ] \fI\fR +.br +An optional command that generates a WSDL file to review before endpoint deployment\&. The WSDL files contains a machine-readable description of how the service can be called, what parameters it expects, and what data structures it returns\&. + +By default the \f3wsgen\fR command does not generate a WSDL file\&. The \f3protocol\fR value is optional and is used to specify what protocol should be used for the WSDL binding (\f3wsdl:binding\fR)\&. Valid protocols are \f3soap1\&.1\fR and \f3Xsoap1\&.2\fR\&. The default is \f3soap1\&.1\fR\&. The \f3Xsoap1\&.2\fR protocol is not standard and can only be used with the \f3-extension\fR option\&. +.TP +-servicename \fIname\fR +.br +Used only with the \f3-wsdl\fR option to specify a particular WSDL service (\f3wsdl:service\fR) name to be generated in the WSDL, for example: \f3-servicename "{http://mynamespace/}MyService"\fR\&. +.TP +-portname \fIname\fR +.br +Used only with the \f3-wsdl\fR option to specify a particular WSDL port (\f3wsdl:port\fR) name to be generated in the WSDL, for example: \f3-portname "{http://mynamespace/}MyPort"\fR\&. +.SH EXAMPLES +The following example generates the wrapper classes for \f3StockService\fR with \f3@WebService\fR annotations inside stock directory\&. +.sp +.nf +\f3wsgen \-d stock \-cp myclasspath stock\&.StockService\fP +.fi +.nf +\f3\fP +.fi +.sp +The following example generates a SOAP 1\&.1 WSDL and schema for the \f3stock\&.StockService\fR class with \f3@WebService\fR annotations\&. +.sp +.nf +\f3wsgen \-wsdl \-d stock \-cp myclasspath stock\&.StockService\fP +.fi +.nf +\f3\fP +.fi +.sp +The following example generates a SOAP 1\&.2 WSDL\&. +.sp +.nf +\f3wsgen \-wsdl:Xsoap1\&.2 \-d stock \-cp myclasspath stock\&.StockService \fP +.fi +.nf +\f3\fP +.fi +.sp +\fINote:\fR You do not have to generate WSDL at development time because the JAXWS run time environment generates a WSDL for you when you deploy your service\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +wsimport(1) +.TP 0.2i +\(bu +\fIThe Tools\fR tab of the JAX-WS (wsgen) page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsgenant\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/wsimport.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/wsimport.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,216 +1,216 @@ -'\" t -.\" Copyright (c) 2005, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java Web Services Tools -.\" Title: wsimport.1 -.\" -.if n .pl 99999 -.TH wsimport 1 "21 November 2013" "JDK 8" "Java Web Services Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -wsimport \- Generates JAX-WS portable artifacts that can be packaged in a web application archive (WAR) file and provides an Ant task\&. -.SH SYNOPSIS -.sp -.nf - -\fBwsimport\fR [ \fIoptions\fR ] \fIwsdl\fR -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -\fIwsdl\fR -The file that contains the machine-readable description of how the web service can be called, what parameters it expects, and what data structures it returns\&. -.SH DESCRIPTION -The \f3wsimport\fR command generates the following JAX-WS portable artifacts\&. These artifacts can be packaged in a WAR file with the WSDL and schema documents and the endpoint implementation to be deployed\&. The \f3wsimport\fR command also provides a \f3wsimport\fR Ant task, see the Tools tab of the Wsimport Ant Task page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html -.TP 0.2i -\(bu -Service Endpoint Interface (SEI) -.TP 0.2i -\(bu -Service -.TP 0.2i -\(bu -Exception class is mapped from \f3wsdl:fault\fR (if any) -.TP 0.2i -\(bu -Async Response Bean is derived from response \f3wsdl:message\fR (if any) -.TP 0.2i -\(bu -JAXB generated value types (mapped java classes from schema types) -.PP -To start the \f3wsgen\fR command, do the following: -.PP -\fIOracle Solaris/Linux\fR: -.sp -.nf -\f3/bin/wsimport\&.sh \-help\fP -.fi -.nf -\f3\fP -.fi -.sp -\fIWindows\fR: -.sp -.nf -\f3\ebin\ewsimport\&.bat \-help\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH OPTIONS -.TP --d \fIdirectory\fR -.br -Specifies where to place generated output files\&. -.TP --b \fIpath\fR -.br -Specifies external JAX-WS or JAXB binding files\&. Multiple JAX-WS and JAXB binding files can be specified with the \f3-b\fR option\&. You can use these files to customize package names, bean names, and so on\&. For more information about JAX-WS and JAXB binding files, see the \fIUsers Guide\fR tab of WSDL Customization at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html -.TP --B \fIjaxbOption\fR -.br -Passes the \f3jaxbOption\fR option to the JAXB schema compiler\&. -.TP --catalog -.br -Specifies a catalog file to resolve external entity references\&. The \f3-catalog\fR option supports the TR9401, XCatalog, and OASIS XML Catalog formats\&. See the \fIUsers Guide\fR tab of the Catalog Support page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/catalog-support\&.html -.TP --extension -.br -Allows vendor extensions\&. Use of extensions can result in applications that are not portable or that do not work with other implementations\&. -.TP --help -.br -Displays a help message for the \f3wsimport\fR command\&. -.TP --httpproxy: \fIhost\fR:\fIport\fR -.br -Specifies an HTTP proxy server\&. The default is 8080\&. -.TP --keep -.br -Keeps generated files\&. -.TP --p \fIname\fR -.br -Specifies a target package \fIname\fR to override the WSDL and schema binding customizations, and the default algorithm defined in the specification\&. -.TP --s \fIdirectory\fR -.br -Specifies where to place generated source files\&. -.TP --verbose -.br -Displays compiler messages\&. -.TP --version -.br -Prints release information\&. -.TP --wsdllocation \fIlocation\fR -.br -Specifies the \f3@WebServiceClient\&.wsdlLocation\fR value\&. -.TP --target -.br -Generates code according to the specified JAX-WS specification version\&. Version 2\&.0 generates compliant code for the JAX-WS 2\&.0 specification\&. -.TP --quiet -.br -Suppresses the \f3wsimport\fR command output\&. -.PP -Multiple \f3JAX-WS\fR and \f3JAXB\fR binding files can be specified using the \f3-b\fR option, and they can be used to customize various things such as package names and bean names\&. More information about \f3JAX-WS\fR and \f3JAXB\fR binding files can be found in the customization documentation at https://jax-ws\&.dev\&.java\&.net/nonav/2\&.1\&.1/docs/customizations\&.html -.SH NONSTANDARD\ OPTIONS -.TP --XadditionalHeaders -.br -Maps headers not bound to a request or response message to Java method parameters\&. -.TP --Xauthfile \fIfile\fR -.br -The WSDL URI that specifies the file that contains authorization information\&. This URI is in the following format: - -http://\fIuser-name\fR:\f3password\fR@\fIhost-name\fR/\fIweb-service-name\fR>?wsdl\&. -.TP --Xdebug -.br -Prints debugging information\&. -.TP --Xno-addressing-databinding -.br -Enables binding of W3C EndpointReferenceType to Java\&. -.TP --Xnocompile -.br -Does not compile the generated Java files\&. -.SH EXAMPLE -The following example generates the Java artifacts and compiles the artifacts by importing \f3http://stockquote\&.example\&.com/quote?wsdl\fR -.sp -.nf -\f3wsimport \-p stockquote http://stockquote\&.example\&.com/quote?wsdl\fP -.fi -.nf -\f3\fP -.fi -.sp -.SH SEE\ ALSO -.TP 0.2i -\(bu -wsgen(1) -.TP 0.2i -\(bu -The Tools tab of Wsimport Ant Task page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html -.TP 0.2i -\(bu -The \fIUsers Guide\fR tab of Catalog Support page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/catalog-support\&.html -.TP 0.2i -\(bu -The \fIUsers Guide\fR tab of WSDL Customization page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2005, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Web Services Tools +.\" Title: wsimport.1 +.\" +.if n .pl 99999 +.TH wsimport 1 "21 November 2013" "JDK 8" "Java Web Services Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +wsimport \- Generates JAX-WS portable artifacts that can be packaged in a web application archive (WAR) file and provides an Ant task\&. +.SH SYNOPSIS +.sp +.nf + +\fBwsimport\fR [ \fIoptions\fR ] \fIwsdl\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIwsdl\fR +The file that contains the machine-readable description of how the web service can be called, what parameters it expects, and what data structures it returns\&. +.SH DESCRIPTION +The \f3wsimport\fR command generates the following JAX-WS portable artifacts\&. These artifacts can be packaged in a WAR file with the WSDL and schema documents and the endpoint implementation to be deployed\&. The \f3wsimport\fR command also provides a \f3wsimport\fR Ant task, see the Tools tab of the Wsimport Ant Task page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html +.TP 0.2i +\(bu +Service Endpoint Interface (SEI) +.TP 0.2i +\(bu +Service +.TP 0.2i +\(bu +Exception class is mapped from \f3wsdl:fault\fR (if any) +.TP 0.2i +\(bu +Async Response Bean is derived from response \f3wsdl:message\fR (if any) +.TP 0.2i +\(bu +JAXB generated value types (mapped java classes from schema types) +.PP +To start the \f3wsgen\fR command, do the following: +.PP +\fIOracle Solaris/Linux\fR: +.sp +.nf +\f3/bin/wsimport\&.sh \-help\fP +.fi +.nf +\f3\fP +.fi +.sp +\fIWindows\fR: +.sp +.nf +\f3\ebin\ewsimport\&.bat \-help\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-d \fIdirectory\fR +.br +Specifies where to place generated output files\&. +.TP +-b \fIpath\fR +.br +Specifies external JAX-WS or JAXB binding files\&. Multiple JAX-WS and JAXB binding files can be specified with the \f3-b\fR option\&. You can use these files to customize package names, bean names, and so on\&. For more information about JAX-WS and JAXB binding files, see the \fIUsers Guide\fR tab of WSDL Customization at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html +.TP +-B \fIjaxbOption\fR +.br +Passes the \f3jaxbOption\fR option to the JAXB schema compiler\&. +.TP +-catalog +.br +Specifies a catalog file to resolve external entity references\&. The \f3-catalog\fR option supports the TR9401, XCatalog, and OASIS XML Catalog formats\&. See the \fIUsers Guide\fR tab of the Catalog Support page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/catalog-support\&.html +.TP +-extension +.br +Allows vendor extensions\&. Use of extensions can result in applications that are not portable or that do not work with other implementations\&. +.TP +-help +.br +Displays a help message for the \f3wsimport\fR command\&. +.TP +-httpproxy: \fIhost\fR:\fIport\fR +.br +Specifies an HTTP proxy server\&. The default is 8080\&. +.TP +-keep +.br +Keeps generated files\&. +.TP +-p \fIname\fR +.br +Specifies a target package \fIname\fR to override the WSDL and schema binding customizations, and the default algorithm defined in the specification\&. +.TP +-s \fIdirectory\fR +.br +Specifies where to place generated source files\&. +.TP +-verbose +.br +Displays compiler messages\&. +.TP +-version +.br +Prints release information\&. +.TP +-wsdllocation \fIlocation\fR +.br +Specifies the \f3@WebServiceClient\&.wsdlLocation\fR value\&. +.TP +-target +.br +Generates code according to the specified JAX-WS specification version\&. Version 2\&.0 generates compliant code for the JAX-WS 2\&.0 specification\&. +.TP +-quiet +.br +Suppresses the \f3wsimport\fR command output\&. +.PP +Multiple \f3JAX-WS\fR and \f3JAXB\fR binding files can be specified using the \f3-b\fR option, and they can be used to customize various things such as package names and bean names\&. More information about \f3JAX-WS\fR and \f3JAXB\fR binding files can be found in the customization documentation at https://jax-ws\&.dev\&.java\&.net/nonav/2\&.1\&.1/docs/customizations\&.html +.SH NONSTANDARD\ OPTIONS +.TP +-XadditionalHeaders +.br +Maps headers not bound to a request or response message to Java method parameters\&. +.TP +-Xauthfile \fIfile\fR +.br +The WSDL URI that specifies the file that contains authorization information\&. This URI is in the following format: + +http://\fIuser-name\fR:\f3password\fR@\fIhost-name\fR/\fIweb-service-name\fR>?wsdl\&. +.TP +-Xdebug +.br +Prints debugging information\&. +.TP +-Xno-addressing-databinding +.br +Enables binding of W3C EndpointReferenceType to Java\&. +.TP +-Xnocompile +.br +Does not compile the generated Java files\&. +.SH EXAMPLE +The following example generates the Java artifacts and compiles the artifacts by importing \f3http://stockquote\&.example\&.com/quote?wsdl\fR +.sp +.nf +\f3wsimport \-p stockquote http://stockquote\&.example\&.com/quote?wsdl\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +wsgen(1) +.TP 0.2i +\(bu +The Tools tab of Wsimport Ant Task page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html +.TP 0.2i +\(bu +The \fIUsers Guide\fR tab of Catalog Support page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/catalog-support\&.html +.TP 0.2i +\(bu +The \fIUsers Guide\fR tab of WSDL Customization page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html +.RE +.br +'pl 8.5i +'bp
--- a/src/solaris/doc/sun/man/man1/xjc.1 Mon Jul 13 10:50:59 2015 -0700 +++ b/src/solaris/doc/sun/man/man1/xjc.1 Wed Jul 15 12:12:46 2015 -0700 @@ -1,232 +1,232 @@ -'\" t -.\" Copyright (c) 2005, 2013, 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. -.\" -.\" Arch: generic -.\" Software: JDK 8 -.\" Date: 21 November 2013 -.\" SectDesc: Java Web Services Tools -.\" Title: xjc.1 -.\" -.if n .pl 99999 -.TH xjc 1 "21 November 2013" "JDK 8" "Java Web Services Tools" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- - -.SH NAME -xjc \- Compiles an XML schema file into fully annotated Java classes\&. -.SH SYNOPSIS -.sp -.nf - -\fBxjc\fR [ \fIoptions\fR ] \fBschema\fR \fIfile/URL/dir/jar\fR \&.\&.\&. [\fB\-b\fR \fIbindinfo\fR ] \&.\&.\&. -.fi -.sp -.TP -\fIoptions\fR -The command-line options\&. See Options\&. -.TP -schema \fIfile/URL/dir/jar \&.\&.\&.\fR -The location of the XML schema file\&. If \f3dir\fR is specified, then all schema files in it are compiled\&. If \f3jar\fR is specified, then the \f3/META-INF/sun-jaxb\&.episode\fR binding file is compiled\&. -.TP --b \fIbindinfo\fR -.br -The location of the bindings files\&. -.SH DESCRIPTION -Start the binding compiler with the appropriate \f3xjc\fR shell script in the bin directory for your platform\&. There is also an Ant task to run the binding complier\&. See Using the XJC with Ant at http://jaxb\&.java\&.net/nonav/2\&.1\&.3/docs/xjcTask\&.html -.SH OPTIONS -.TP 0.2i -\(bu -See also Nonstandard Options -.TP 0.2i -\(bu -See also Deprecated and Removed Options -.TP --nv -.br -By default, the XJC binding compiler performs strict validation of the source schema before processing it\&. Use this option to disable strict schema validation\&. This does not mean that the binding compiler will not perform any validation, but means that it will perform a less-strict validation\&. -.TP --extension -.br -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 \f3-extension\fR mode enabled by this switch\&. In the default (strict) mode, you are also limited to using only the binding customization defined in the specification\&. By using the \f3-extension\fR switch, you will be allowed to use the JAXB Vendor Extensions\&. -.TP --b \fIfile\fR -.br -Specifies one or more external binding files to process\&. Each binding file must have its own \f3-b\fR switch\&. The syntax of the external binding files is flexible\&. You can have a single binding file that contains customization for multiple schemas or you can break the customization into multiple bindings files: \f3xjc schema1\&.xsd schema2\&.xsd schema3\&.xsd -b bindings123\&.xjb\fR\f3xjc schema1\&.xsd schema2\&.xsd schema3\&.xsd -b bindings1\&.xjb -b bindings2\&.xjb -b bindings3\&.xjb\fR\&. In addition, the ordering of the schema files and binding files on the command line does not matter\&. -.TP --d \fIdir\fR -.br -By default, the XJC binding compiler generates 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 does not create it for you\&. -.TP --p \fIpkg\fR -.br -When you specify a target package with this command-line option, it overrides any binding customization for the package name and the default package name algorithm defined in the specification\&. -.TP --httpproxy \fIproxy\fR -.br -Specifies the HTTP or HTTPS proxy in the format \fI[user[:password]@]proxyHost[:proxyPort]\fR\&. The old \f3-host\fR and \f3-port\fR options are still supported by the RI for backward compatibility, but they were deprecated\&. The password specified with this option is an argument that is visible to other users who use the top command\&. For greater security, use the \f3-httpproxyfile\fR option\&. -.TP --httpproxyfile file -.br -Specifies the HTTP or HTTPS proxy with a file\&. The same format as the \f3-httpproxy\fR option, but the password specified in the file is not visible to other users\&. -.TP --classpath arg -.br -Specifies where to find client application class files used by the \fIjxb:javaType\fR and xjc:\fIsuperClass\fR customization\&. -.TP --catalog file -.br -Specifies catalog files to resolve external entity references\&. Supports the TR9401, XCatalog, and OASIS XML Catalog formats\&. See XML Entity and URI Resolvers at http://xerces\&.apache\&.org/xml-commons/components/resolver/resolver-article\&.html -.TP --readOnly -.br -By default, the XJC binding compiler does not write-protect the Java source files it generates\&. Use this option to force the XJC binding compiler to mark the generated Java sources as read-only\&. -.TP --npa -.br -Suppresses the generation of package level annotations into \f3**/package-info\&.java\fR\&. Using this switch causes the generated code to internalize those annotations into the other generated classes\&. -.TP --no-header -.br -Suppresses the generation of a file header comment that includes some note and time stamp\&. Using this makes the generated code more compatible with the \f3diff\fR command\&. -.TP --target 2\&.0 -.br -Avoids generating code that relies on any JAXB 2\&.1 features\&. This will allow the generated code to run with JAXB 2\&.0 runtime environment (such as Java SE 6)\&. -.TP --xmlschema -.br -Treats input schemas as W3C XML Schema (default)\&. If you do not specify this switch, then your input schemas are treated as though they are W3C XML Schemas\&. -.TP --relaxing -.br -Treats input schemas as RELAX NG (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. -.TP --relaxing-compact -.br -Treat input schemas as RELAX NG compact syntax (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. -.TP --dtd -.br -Treats input schemas as XML DTD (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. -.TP --wsdl -.br -Treats input as WSDL and compiles schemas inside it (experimental and unsupported)\&. -.TP --quiet -.br -Suppress compiler output, such as progress information and warnings\&. -.TP --verbose -.br -Be extra verbose, such as printing informational messages or displaying stack traces upon some errors\&. -.TP --help -.br -Displays a brief summary of the compiler switches\&. -.TP --version -.br -Displays the compiler version information\&. -.TP -\fIschema file/URL/dir\fR -Specifies one or more schema files to compile\&. If you specify a directory, then the \f3xjc\fR command scans it for all schema files and compiles them\&. -.SS NONSTANDARD\ OPTIONS -.TP --XLocator -.br -Causes the generated code to expose SAX Locator information about the source XML in the Java bean instances after unmarshalling\&. -.TP --Xsync-methods -.br -Causes all of the generated method signatures to include the \f3synchronized\fR keyword\&. -.TP --mark-generated -.br -Marks the generated code with the annotation \f3@javax\&.annotation\&.Generated\fR\&. -.TP --episode file -.br -Generates the specified episode file for separate compilation\&. -.SS DEPRECATED\ AND\ REMOVED\ OPTIONS -.TP --host & -port -.br -These options are replaced with the \f3-httpproxy\fR option\&. For backward compatibility, these options are supported, but will not be documented and might be removed from future releases\&. -.TP --use-runtime -.br -Because the JAXB 2\&.0 specification has defined a portable runtime environment, it is no longer necessary for the JAXB RI to generate \f3**/impl/runtime\fRpackages\&. Therefore, this switch is obsolete and was removed\&. -.TP --source -.br -The \f3-source\fR compatibility switch was introduced in the first JAXB 2\&.0 Early Access release\&. This switch is removed from future releases of JAXB 2\&.0\&. If you need to generate 1\&.0\&.x code, then use an installation of the 1\&.0\&.x code base\&. -.SH COMPILER\ RESTRICTIONS -In general, it is safest to compile all related schemas as a single unit with the same binding compiler switches\&. Keep the following list of restrictions in mind when running the \f3xjc\fR command\&. Most of these issues only apply when you compile multiple schemas with multiple invocations of the \f3xjc\fR command\&. -.PP -To compile multiple schemas at the same time, keep the following precedence rules for the target Java package name in mind: -.TP 0.4i -1\&. -The \f3-p\fR option has the highest precedence\&. -.TP 0.4i -2\&. -\fIjaxb:package\fR customization\&. -.TP 0.4i -3\&. -If \f3targetNamespace\fR is declared, then apply the \f3t\fR\f3argetNamespace\fR to the Java package name algorithm defined in the specification\&. -.TP 0.4i -4\&. -If no \f3targetNamespace\fR is declared, then use a hard coded package named \f3generated\fR\&. -.PP -You cannot have more than one \fIjaxb:schemaBindings\fR per name space, so it is impossible to have two schemas in the same target name space compiled into different Java packages\&. -.PP -All schemas being compiled into the same Java package must be submitted to the XJC binding compiler at the same time\&. They cannot be compiled independently and work as expected\&. -.PP -Element substitution groups that are spread across multiple schema files must be compiled at the same time\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu -Binding Compiler (xjc) at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/xjc\&.html -.TP 0.2i -\(bu -Java Architecture for XML Binding (JAXB) at http://www\&.oracle\&.com/technetwork/articles/javase/index-140168\&.html -.RE -.br -'pl 8.5i -'bp +'\" t +.\" Copyright (c) 2005, 2013, 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. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Web Services Tools +.\" Title: xjc.1 +.\" +.if n .pl 99999 +.TH xjc 1 "21 November 2013" "JDK 8" "Java Web Services Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +xjc \- Compiles an XML schema file into fully annotated Java classes\&. +.SH SYNOPSIS +.sp +.nf + +\fBxjc\fR [ \fIoptions\fR ] \fBschema\fR \fIfile/URL/dir/jar\fR \&.\&.\&. [\fB\-b\fR \fIbindinfo\fR ] \&.\&.\&. +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +schema \fIfile/URL/dir/jar \&.\&.\&.\fR +The location of the XML schema file\&. If \f3dir\fR is specified, then all schema files in it are compiled\&. If \f3jar\fR is specified, then the \f3/META-INF/sun-jaxb\&.episode\fR binding file is compiled\&. +.TP +-b \fIbindinfo\fR +.br +The location of the bindings files\&. +.SH DESCRIPTION +Start the binding compiler with the appropriate \f3xjc\fR shell script in the bin directory for your platform\&. There is also an Ant task to run the binding complier\&. See Using the XJC with Ant at http://jaxb\&.java\&.net/nonav/2\&.1\&.3/docs/xjcTask\&.html +.SH OPTIONS +.TP 0.2i +\(bu +See also Nonstandard Options +.TP 0.2i +\(bu +See also Deprecated and Removed Options +.TP +-nv +.br +By default, the XJC binding compiler performs strict validation of the source schema before processing it\&. Use this option to disable strict schema validation\&. This does not mean that the binding compiler will not perform any validation, but means that it will perform a less-strict validation\&. +.TP +-extension +.br +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 \f3-extension\fR mode enabled by this switch\&. In the default (strict) mode, you are also limited to using only the binding customization defined in the specification\&. By using the \f3-extension\fR switch, you will be allowed to use the JAXB Vendor Extensions\&. +.TP +-b \fIfile\fR +.br +Specifies one or more external binding files to process\&. Each binding file must have its own \f3-b\fR switch\&. The syntax of the external binding files is flexible\&. You can have a single binding file that contains customization for multiple schemas or you can break the customization into multiple bindings files: \f3xjc schema1\&.xsd schema2\&.xsd schema3\&.xsd -b bindings123\&.xjb\fR\f3xjc schema1\&.xsd schema2\&.xsd schema3\&.xsd -b bindings1\&.xjb -b bindings2\&.xjb -b bindings3\&.xjb\fR\&. In addition, the ordering of the schema files and binding files on the command line does not matter\&. +.TP +-d \fIdir\fR +.br +By default, the XJC binding compiler generates 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 does not create it for you\&. +.TP +-p \fIpkg\fR +.br +When you specify a target package with this command-line option, it overrides any binding customization for the package name and the default package name algorithm defined in the specification\&. +.TP +-httpproxy \fIproxy\fR +.br +Specifies the HTTP or HTTPS proxy in the format \fI[user[:password]@]proxyHost[:proxyPort]\fR\&. The old \f3-host\fR and \f3-port\fR options are still supported by the RI for backward compatibility, but they were deprecated\&. The password specified with this option is an argument that is visible to other users who use the top command\&. For greater security, use the \f3-httpproxyfile\fR option\&. +.TP +-httpproxyfile file +.br +Specifies the HTTP or HTTPS proxy with a file\&. The same format as the \f3-httpproxy\fR option, but the password specified in the file is not visible to other users\&. +.TP +-classpath arg +.br +Specifies where to find client application class files used by the \fIjxb:javaType\fR and xjc:\fIsuperClass\fR customization\&. +.TP +-catalog file +.br +Specifies catalog files to resolve external entity references\&. Supports the TR9401, XCatalog, and OASIS XML Catalog formats\&. See XML Entity and URI Resolvers at http://xerces\&.apache\&.org/xml-commons/components/resolver/resolver-article\&.html +.TP +-readOnly +.br +By default, the XJC binding compiler does not write-protect the Java source files it generates\&. Use this option to force the XJC binding compiler to mark the generated Java sources as read-only\&. +.TP +-npa +.br +Suppresses the generation of package level annotations into \f3**/package-info\&.java\fR\&. Using this switch causes the generated code to internalize those annotations into the other generated classes\&. +.TP +-no-header +.br +Suppresses the generation of a file header comment that includes some note and time stamp\&. Using this makes the generated code more compatible with the \f3diff\fR command\&. +.TP +-target 2\&.0 +.br +Avoids generating code that relies on any JAXB 2\&.1 features\&. This will allow the generated code to run with JAXB 2\&.0 runtime environment (such as Java SE 6)\&. +.TP +-xmlschema +.br +Treats input schemas as W3C XML Schema (default)\&. If you do not specify this switch, then your input schemas are treated as though they are W3C XML Schemas\&. +.TP +-relaxing +.br +Treats input schemas as RELAX NG (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. +.TP +-relaxing-compact +.br +Treat input schemas as RELAX NG compact syntax (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. +.TP +-dtd +.br +Treats input schemas as XML DTD (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. +.TP +-wsdl +.br +Treats input as WSDL and compiles schemas inside it (experimental and unsupported)\&. +.TP +-quiet +.br +Suppress compiler output, such as progress information and warnings\&. +.TP +-verbose +.br +Be extra verbose, such as printing informational messages or displaying stack traces upon some errors\&. +.TP +-help +.br +Displays a brief summary of the compiler switches\&. +.TP +-version +.br +Displays the compiler version information\&. +.TP +\fIschema file/URL/dir\fR +Specifies one or more schema files to compile\&. If you specify a directory, then the \f3xjc\fR command scans it for all schema files and compiles them\&. +.SS NONSTANDARD\ OPTIONS +.TP +-XLocator +.br +Causes the generated code to expose SAX Locator information about the source XML in the Java bean instances after unmarshalling\&. +.TP +-Xsync-methods +.br +Causes all of the generated method signatures to include the \f3synchronized\fR keyword\&. +.TP +-mark-generated +.br +Marks the generated code with the annotation \f3@javax\&.annotation\&.Generated\fR\&. +.TP +-episode file +.br +Generates the specified episode file for separate compilation\&. +.SS DEPRECATED\ AND\ REMOVED\ OPTIONS +.TP +-host & -port +.br +These options are replaced with the \f3-httpproxy\fR option\&. For backward compatibility, these options are supported, but will not be documented and might be removed from future releases\&. +.TP +-use-runtime +.br +Because the JAXB 2\&.0 specification has defined a portable runtime environment, it is no longer necessary for the JAXB RI to generate \f3**/impl/runtime\fRpackages\&. Therefore, this switch is obsolete and was removed\&. +.TP +-source +.br +The \f3-source\fR compatibility switch was introduced in the first JAXB 2\&.0 Early Access release\&. This switch is removed from future releases of JAXB 2\&.0\&. If you need to generate 1\&.0\&.x code, then use an installation of the 1\&.0\&.x code base\&. +.SH COMPILER\ RESTRICTIONS +In general, it is safest to compile all related schemas as a single unit with the same binding compiler switches\&. Keep the following list of restrictions in mind when running the \f3xjc\fR command\&. Most of these issues only apply when you compile multiple schemas with multiple invocations of the \f3xjc\fR command\&. +.PP +To compile multiple schemas at the same time, keep the following precedence rules for the target Java package name in mind: +.TP 0.4i +1\&. +The \f3-p\fR option has the highest precedence\&. +.TP 0.4i +2\&. +\fIjaxb:package\fR customization\&. +.TP 0.4i +3\&. +If \f3targetNamespace\fR is declared, then apply the \f3t\fR\f3argetNamespace\fR to the Java package name algorithm defined in the specification\&. +.TP 0.4i +4\&. +If no \f3targetNamespace\fR is declared, then use a hard coded package named \f3generated\fR\&. +.PP +You cannot have more than one \fIjaxb:schemaBindings\fR per name space, so it is impossible to have two schemas in the same target name space compiled into different Java packages\&. +.PP +All schemas being compiled into the same Java package must be submitted to the XJC binding compiler at the same time\&. They cannot be compiled independently and work as expected\&. +.PP +Element substitution groups that are spread across multiple schema files must be compiled at the same time\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +Binding Compiler (xjc) at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/xjc\&.html +.TP 0.2i +\(bu +Java Architecture for XML Binding (JAXB) at http://www\&.oracle\&.com/technetwork/articles/javase/index-140168\&.html +.RE +.br +'pl 8.5i +'bp