diff options
Diffstat (limited to 'src/solaris/doc/sun/man/man1/jcmd.1')
-rw-r--r-- | src/solaris/doc/sun/man/man1/jcmd.1 | 289 |
1 files changed, 193 insertions, 96 deletions
diff --git a/src/solaris/doc/sun/man/man1/jcmd.1 b/src/solaris/doc/sun/man/man1/jcmd.1 index f789bdc52..37cd47a27 100644 --- a/src/solaris/doc/sun/man/man1/jcmd.1 +++ b/src/solaris/doc/sun/man/man1/jcmd.1 @@ -1,114 +1,211 @@ '\" t -.\" Copyright (c) 2012, 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: jcmd.1 +.\" Copyright (c) 2012, 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. +.\" +.\" Title: jcmd +.\" Language: English +.\" Date: 03 March 2015 +.\" SectDesc: Troubleshooting Tools +.\" Software: JDK 8 +.\" Arch: generic +.\" Part Number: E38207-04 +.\" Doc ID: JSSON .\" .if n .pl 99999 -.TH jcmd 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 +.TH "jcmd" "1" "03 March 2015" "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" jcmd \- Sends diagnostic command requests to a running Java Virtual Machine (JVM)\&. -.SH SYNOPSIS -.sp -.nf - +.SH "SYNOPSIS" +.sp +.if n \{\ +.RS 4 +.\} +.nf \fBjcmd\fR [\fB\-l\fR|\fB\-h\fR|\fB\-help\fR] -.fi -.nf - +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf \fBjcmd\fR \fIpid\fR|\fImain\-class\fR \fBPerfCounter\&.print\fR -.fi -.nf - +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf \fBjcmd\fR \fIpid\fR|\fImain\-class\fR \fB\-f\fR \fIfilename\fR -.fi -.nf - +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf \fBjcmd\fR \fIpid\fR|\fImain\-class\fR \fIcommand\fR[ \fIarguments\fR] -.fi -.sp -.SH DESCRIPTION -The \f3jcmd\fR utility is used to send diagnostic command requests to the JVM\&. It must be used on the same machine on which the JVM is running, and have the same effective user and group identifiers that were used to launch the JVM\&. +.fi +.if n \{\ +.RE +.\} +.SH "DESCRIPTION" +.PP +The +\fBjcmd\fR +utility is used to send diagnostic command requests to the JVM\&. It must be used on the same machine on which the JVM is running, and have the same effective user and group identifiers that were used to launch the JVM\&. +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBNote\fR +.ps -1 +.br +.TS +allbox tab(:); +l. +T{ +.PP +To invoke diagnostic commands from a remote machine or with different identifiers, you can use the +\fBcom\&.sun\&.management\&.DiagnosticCommandMBean\fR +interface\&. For more information about the +\fBDiagnosticCommandMBean\fR +interface, see the API documentation at http://docs\&.oracle\&.com/javase/8/docs/jre/api/management/extension/com/sun/management/DiagnosticCommandMBean\&.html +T} +.TE +.sp 1 +.sp .5v +.RE .PP -\fINote:\fR To invoke diagnostic commands from a remote machine or with different identiers, you can use the \f3com\&.sun\&.management\&.DiagnosticCommandMBean\fR interface\&. For more information about the \f3DiagnosticCommandMBean\fR interface, see the API documentation at http://download\&.java\&.net/jdk8/docs/jre/api/management/extension/com/sun/management/DiagnosticCommandMBean\&.html +If you run +\fBjcmd\fR +without arguments or with the +\fB\-l\fR +option, it prints the list of running Java process identifiers with the main class and command\-line arguments that were used to launch the process\&. Running +\fBjcmd\fR +with the +\fB\-h\fR +or +\fB\-help\fR +option prints the tool\(cqs help message\&. .PP -If you run \f3jcmd\fR without arguments or with the \f3-l\fR option, it prints the list of running Java process identifiers with the main class and command-line arguments that were used to launch the process\&. Running \f3jcmd\fR with the \f3-h\fR or \f3-help\fR option prints the tool\(cqs help message\&. +If you specify the processes identifier (\fIpid\fR) or the main class (\fImain\-class\fR) as the first argument, +\fBjcmd\fR +sends the diagnostic command request to the Java process with the specified identifier or to all Java processes with the specified name of the main class\&. You can also send the diagnostic command request to all available Java processes by specifying +\fB0\fR +as the process identifier\&. Use one of the following as the diagnostic command request: .PP -If you specify the processes identifier (\fIpid\fR) or the main class (\fImain-class\fR) as the first argument, \f3jcmd\fR sends the diagnostic command request to the Java process with the specified identifier or to all Java processes with the specified name of the main class\&. You can also send the diagnostic command request to all available Java processes by specifying \f30\fR as the process identifier\&. Use one of the following as the diagnostic command request: -.TP Perfcounter\&.print +.RS 4 Prints the performance counters available for the specified Java process\&. The list of performance counters might vary with the Java process\&. -.TP --f \fIfilename\fR -.br -The name of the file from which to read diagnostic commands and send them to the specified Java process\&. Used only with the \f3-f\fR option\&. Each command in the file must be written on a single line\&. Lines starting with a number sign (\f3#\fR) are ignored\&. Processing of the file ends when all lines have been read or when a line containing the \f3stop\fR keyword is read\&. -.TP +.RE +.PP +\-f \fIfilename\fR +.RS 4 +The name of the file from which to read diagnostic commands and send them to the specified Java process\&. Used only with the +\fB\-f\fR +option\&. Each command in the file must be written on a single line\&. Lines starting with a number sign (\fB#\fR) are ignored\&. Processing of the file ends when all lines have been read or when a line containing the +\fBstop\fR +keyword is read\&. +.RE +.PP \fIcommand\fR [\fIarguments\fR] -The command to be sent to the specified Java process\&. The list of available diagnostic commands for a given process can be obtained by sending the \f3help\fR command to this process\&. Each diagnostic command has its own set of arguments\&. To see the description, syntax, and a list of available arguments for a command, use the name of the command as the argument for the \f3help\fR command\&. - -\fINote:\fR If any arguments contain spaces, you must surround them with single or double quotation marks (\f3\&'\fR or \f3"\fR)\&. In addition, you must escape single or double quotation marks with a backslash (\f3\e\fR) to prevent the operating system shell from processing quotation marks\&. Alternatively, you can surround these arguments with single quotation marks and then with double quotation marks (or with double quotation marks and then with single quotation marks)\&. -.SH OPTIONS +.RS 4 +The command to be sent to the specified Java process\&. The list of available diagnostic commands for a given process can be obtained by sending the +\fBhelp\fR +command to this process\&. Each diagnostic command has its own set of arguments\&. To see the description, syntax, and a list of available arguments for a command, use the name of the command as the argument for the +\fBhelp\fR +command\&. +.sp +\fBNote:\fR +If any arguments contain spaces, you must surround them with single or double quotation marks (\fB\*(Aq\fR +or +\fB"\fR)\&. In addition, you must escape single or double quotation marks with a backslash (\fB\e\fR) to prevent the operating system shell from processing quotation marks\&. Alternatively, you can surround these arguments with single quotation marks and then with double quotation marks (or with double quotation marks and then with single quotation marks)\&. +.RE +.SH "OPTIONS" +.PP Options are mutually exclusive\&. -.TP --f \fIfilename\fR -.br -Reads commands from the specified file\&. This option can be used only if you specify the process identifier or the main class as the first argument\&. Each command in the file must be written on a single line\&. Lines starting with a number sign (\f3#\fR) are ignored\&. Processing of the file ends when all lines have been read or when a line containing the \f3stop\fR keyword is read\&. -.TP --h, -help +.PP +\-f \fIfilename\fR +.RS 4 +Reads commands from the specified file\&. This option can be used only if you specify the process identifier or the main class as the first argument\&. Each command in the file must be written on a single line\&. Lines starting with a number sign (\fB#\fR) are ignored\&. Processing of the file ends when all lines have been read or when a line containing the +\fBstop\fR +keyword is read\&. +.RE +.PP +\-h .br +\-help +.RS 4 Prints a help message\&. -.TP --l -.br -Prints the list of running Java processes identifiers with the main class and command-line arguments\&. -.SH SEE\ ALSO -.TP 0.2i -\(bu +.RE +.PP +\-l +.RS 4 +Prints the list of running Java processes identifiers with the main class and command\-line arguments\&. +.RE +.SH "SEE ALSO" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} jps(1) -.RE
-.br
-'pl 8.5i
-'bp
+.RE +.br +'pl 8.5i +'bp |