Documentation Contents

Command Name - followed by More Descriptive Command Title

SYNOPSIS

   commandname [ options ] [ sourcefiles ] [ classes ] [ @argfiles ]

PARAMETERS

For example, you could introduce items like the following, as required.

DESCRIPTION

Generally, what does a user do with this tool?

For what purpose was this tool developed?

You could state general differences in use/functionality for each OS (operating system) we support.

OPTIONS

Place your introduction here. Then, if you have different categories of options, use multiple level 3 headings to create sub-sections as necessary. Options should be listed alphabetically within a sub-section.

Following are a few option examples from the jconsole and apt man pages. They are divided into three sub-sections, just to give an example of what sub-sections look like.

jconsole Options

-interval=n
Set the update interval to n seconds (default is 4 seconds).
-notile 
Do not tile windows initially (for two or more connections).
-pluginpath  plugins
Specify a list of directories or JAR files which are searched for JConsole plugins. The plugins path should contain a provider-configuration file named:
   META-INF/services/com.sun.tools.jconsole.JConsolePlugin

containing one line for each plugin specifying the fully qualified class name of the class implementing the com.sun.tools.jconsole.JConsolePlugin class.

-version 
Output version information and exit.
-help 
Output help message and exit.
-J<flag> 
Pass <flag> to the Java virtual machine on which jconsole is run.

apt Specific Options

-s dir
Specify the directory root under which processor-generated source files will be placed; files are placed in subdirectories based on package namespace.
-nocompile
Do not compile source files to class files.
-print
Print out textual representation of specified types; perform no annotation processing or compilation.
-A[key[=val]]
Options to pass to annotation processors -- these are not interpreted by apt directly, but are made available for use by individual processors
-factorypath path
Specify where to find annotation processor factories; if this option is used, the classpath is not searched for factories.
-factory classname
Name of annotation processor factory to use; bypasses default discovery process

apt Options shared with javac

-d dir
Specify where to place processor and javac generated class files
-cp path or -classpath path
Specify where to find user class files and annotation processor factories. If -factorypath is given, the classpath is not searched for factories.

Consult the javac(1) man page for information on javac options.

USAGE

Use this section to briefly mention some common ways a developer might use this tool.

EXAMPLES

Here are some examples of starting jstatd. Note that the jstatd scripts automatically start the server in the background.

Using Internal RMI Registry

This example demonstrates starting jstatd with an internal RMI registry. This example assumes that no other server is bound to the default RMI Registry port (port 1099).

jstatd -J-Djava.security.policy=all.policy

Using External RMI Registry

This example demonstrates starting jstatd with a external RMI registry.

rmiregistry&
jstatd -J-Djava.security.policy=all.policy

This example demonstrates starting jstatd with an external RMI registry server on port 2020.

rmiregistry 2020&
jstatd -J-Djava.security.policy=all.policy -p 2020

This example demonstrates starting jstatd with an external RMI registry on port 2020, bound to name AlternateJstatdServerName.

rmiregistry 2020&
jstatd -J-Djava.security.policy=all.policy -p 2020 -n AlternateJstatdServerName

Inhibiting creation of an in-process RMI registry

This example demonstrates starting jstatd such that it will not create a RMI registry if one is not found. This example assumes an RMI registry is already running. If it is not, an appropriate error message is emitted.

jstatd -J-Djava.security.policy=all.policy -nr

Enabling RMI logging capabilities.

This example demonstrates starting jstatd with RMI logging capabilities enabled. This technique is useful as a troubleshooting aid or for monitoring server activities.

jstatd -J-Djava.security.policy=all.policy -J-Djava.rmi.server.logCalls=true

SEE ALSO

Following is a SEE ALSO section taken from the jstatd man page.

Oracle and/or its affiliates Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved.
Contact Us