Java Dynamic Management Kit 5.1 Getting Started Guide

1.4 Overview of the Product Documentation

Java DMK includes both printable and online documentation, as well as a set of programming examples.

1.4.1 Online HTML Files

You can view HTML documentation after installation of the product. On the machine where you installed the product, open one of the following URLs in any browser:

installDir/SUNWjdmk/5.1/doc/index.html

The page contains links to all the product documentation that is supplied online with Java DMK.

1.4.2 Printable Documents

Complete PDF versions of the books listed in the preceding section are also supplied with the CD—ROM release of Java DMK 5.1. These files are also located in the /doc directory on the CD-ROM.

The documents are formatted for U.S. Letter paper size (8.5 × 11 inches), but they can be loaded by any appropriate document viewer or printed directly to any printer. The text area on each page fits on most standard paper sizes.

1.4.3 Programming Examples

Sample applications that demonstrate most of the functionality of the Java DMK are provided in the examples package of the product. If you installed this package, the Java source files and README text files for these applications are located in subdirectories:

The examples in the /legacy subdirectory demonstrate the features that have been deprecated in Java DMK version 5.1, but retained for reasons of backwards compatibility.


Note –

In the Solaris operating environment, you need to be root user to write to this directory. To compile the example programs, users should copy the examples hierarchy to a more accessible location.


The README file for each example gives a brief explanation of the source files and the instructions for running its application. Further explanation for most examples is available in the Java Dynamic Management Kit 5.1 Tutorial.

1.4.4 API Documentation

The API documentation generated by the Javadoc utility provides the full description of all classes, interfaces, and methods in the Java DMK APIs.

The generated API documentation for the Java DMK is found in the following location after installation:

installDir/SUNWjdmk/5.1/doc/index.html