changeset 5388:0039f5c7fb51

7182971: Need to include documentation content for JCMD man page Reviewed-by: robilad, tbell
author bpatel
date Wed, 11 Jul 2012 16:19:41 -0700
parents dcee29cd4b80
children 09145b546a2b 05c69338ee73
files src/linux/doc/man/jcmd.1 src/solaris/doc/sun/man/man1/jcmd.1
diffstat 2 files changed, 10 insertions(+), 22 deletions(-) [+]
line wrap: on
line diff
--- a/src/linux/doc/man/jcmd.1	Wed Jul 11 21:48:16 2012 +0100
+++ b/src/linux/doc/man/jcmd.1	Wed Jul 11 16:19:41 2012 -0700
@@ -19,7 +19,7 @@
 ." or visit www.oracle.com if you need additional information or have any
 ." questions.
 ."
-.TH jcmd 1 "16 Mar 2012"
+.TH jcmd 1 "10 Jul 2012"
 
 .LP
 .SH "Name"
@@ -56,7 +56,7 @@
 When a process id is specified on the command line, jcmd sends the diagnostic command request to the process with this id.
 .LP
 .LP
-When a main class is specified on the command line, jcmd sends the diagnostic command request to all Java processes with this main class.
+When a main class is specified on the command line, jcmd sends the diagnostic command request to all Java processes for which the command line argument is a substring of the Java process' main class.
 .LP
 .LP
 With the PerfCounter.print argument, jcmd prints the performance counters available on the targeted Java process(es).
@@ -73,11 +73,9 @@
 .TP 3
 \-l 
 Prints the list of running Java processes with their process id, their main class and their command line arguments. 
-.br
 .TP 3
 \-h 
 Prints a help message. 
-.br
 .TP 3
 \-help 
 Prints a help message. 
@@ -90,19 +88,15 @@
 .TP 3
 pid 
 Identifies the process that receives the diagnostic command requests. The process must be a Java process. To get a list of Java processes running on a machine, use jps(1) or jcmd(1). 
-.br
 .TP 3
 main class 
-Main class of the process that receives the diagnostic command requests. If several running Java processes share this main class, the diagnostic command request is sent to all these processes. To get a list of Java processes running on a machine, use jps(1) or jcmd(1). 
-.br
+Main class of the process that receives the diagnostic command requests. When matching processes, any process whose main class name contains the specified string as a substring will be matched. If several running Java processes share this main class, the diagnostic command request is sent to all these processes. To get a list of Java processes running on a machine, use jps(1) or jcmd(1). 
 .TP 3
 command [arguments] 
-Invoke the diagnostic command called \f2command\fP on the targeted Java process(es). The list of available diagnostic commands for a given process can be obtained by invoking the \f3help\fP command on this process. Each diagnostic command has its own set of \f2arguments\fP, which can be obtained by invoking the \f3help\fP command followed by the command name. 
-.br
+Invoke the diagnostic command called \f2command\fP on the targeted Java process(es). The list of available diagnostic commands for a given process can be obtained by invoking the \f3help\fP command on this process. Each diagnostic command has its own set of \f2arguments\fP, which can be obtained by invoking the the command name followed by \f3help\fP. 
 .TP 3
-Counter.print 
+PerfCounter.print 
 Print the performance counters available on the targeted Java process(es). The list of performance counters may vary with the Java process. 
-.br
 .TP 3
 \-f file 
 Read commands from \f2file\fP and invoke them on the targeted Java process(es). In \f2file\fP, each command must be written on a single line. Lines starting with # are ignored. Processing of \f2file\fP ends when all lines have been invoked or when a line containing the \f3stop\fP keyword is read. 
--- a/src/solaris/doc/sun/man/man1/jcmd.1	Wed Jul 11 21:48:16 2012 +0100
+++ b/src/solaris/doc/sun/man/man1/jcmd.1	Wed Jul 11 16:19:41 2012 -0700
@@ -19,7 +19,7 @@
 ." or visit www.oracle.com if you need additional information or have any
 ." questions.
 ."
-.TH jcmd 1 "16 Mar 2012"
+.TH jcmd 1 "10 Jul 2012"
 
 .LP
 .SH "Name"
@@ -56,7 +56,7 @@
 When a process id is specified on the command line, jcmd sends the diagnostic command request to the process with this id.
 .LP
 .LP
-When a main class is specified on the command line, jcmd sends the diagnostic command request to all Java processes with this main class.
+When a main class is specified on the command line, jcmd sends the diagnostic command request to all Java processes for which the command line argument is a substring of the Java process' main class.
 .LP
 .LP
 With the PerfCounter.print argument, jcmd prints the performance counters available on the targeted Java process(es).
@@ -73,11 +73,9 @@
 .TP 3
 \-l 
 Prints the list of running Java processes with their process id, their main class and their command line arguments. 
-.br
 .TP 3
 \-h 
 Prints a help message. 
-.br
 .TP 3
 \-help 
 Prints a help message. 
@@ -90,19 +88,15 @@
 .TP 3
 pid 
 Identifies the process that receives the diagnostic command requests. The process must be a Java process. To get a list of Java processes running on a machine, use jps(1) or jcmd(1). 
-.br
 .TP 3
 main class 
-Main class of the process that receives the diagnostic command requests. If several running Java processes share this main class, the diagnostic command request is sent to all these processes. To get a list of Java processes running on a machine, use jps(1) or jcmd(1). 
-.br
+Main class of the process that receives the diagnostic command requests. When matching processes, any process whose main class name contains the specified string as a substring will be matched. If several running Java processes share this main class, the diagnostic command request is sent to all these processes. To get a list of Java processes running on a machine, use jps(1) or jcmd(1). 
 .TP 3
 command [arguments] 
-Invoke the diagnostic command called \f2command\fP on the targeted Java process(es). The list of available diagnostic commands for a given process can be obtained by invoking the \f3help\fP command on this process. Each diagnostic command has its own set of \f2arguments\fP, which can be obtained by invoking the \f3help\fP command followed by the command name. 
-.br
+Invoke the diagnostic command called \f2command\fP on the targeted Java process(es). The list of available diagnostic commands for a given process can be obtained by invoking the \f3help\fP command on this process. Each diagnostic command has its own set of \f2arguments\fP, which can be obtained by invoking the the command name followed by \f3help\fP. 
 .TP 3
-Counter.print 
+PerfCounter.print 
 Print the performance counters available on the targeted Java process(es). The list of performance counters may vary with the Java process. 
-.br
 .TP 3
 \-f file 
 Read commands from \f2file\fP and invoke them on the targeted Java process(es). In \f2file\fP, each command must be written on a single line. Lines starting with # are ignored. Processing of \f2file\fP ends when all lines have been invoked or when a line containing the \f3stop\fP keyword is read.