annotate src/bsd/doc/man/jcmd.1 @ 10483:aa861c627760

8067380: Update nroff to integrate changes made in 8u40 Reviewed-by: kvn, coffeys
author rgallard
date Mon, 02 Feb 2015 10:12:21 -0800
parents 66c98bd811f1
children 3f44d82b41fb
rev   line source
rgallard@8813 1 '\" t
rgallard@10483 2 .\" Copyright (c) 2012, 2015, Oracle and/or its affiliates. All rights reserved.
rgallard@10483 3 .\"
rgallard@10483 4 .\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
rgallard@10483 5 .\"
rgallard@10483 6 .\" This code is free software; you can redistribute it and/or modify it
rgallard@10483 7 .\" under the terms of the GNU General Public License version 2 only, as
rgallard@10483 8 .\" published by the Free Software Foundation.
rgallard@10483 9 .\"
rgallard@10483 10 .\" This code is distributed in the hope that it will be useful, but WITHOUT
rgallard@10483 11 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
rgallard@10483 12 .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
rgallard@10483 13 .\" version 2 for more details (a copy is included in the LICENSE file that
rgallard@10483 14 .\" accompanied this code).
rgallard@10483 15 .\"
rgallard@10483 16 .\" You should have received a copy of the GNU General Public License version
rgallard@10483 17 .\" 2 along with this work; if not, write to the Free Software Foundation,
rgallard@10483 18 .\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
rgallard@10483 19 .\"
rgallard@10483 20 .\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
rgallard@10483 21 .\" or visit www.oracle.com if you need additional information or have any
rgallard@10483 22 .\" questions.
rgallard@10483 23 .\"
rgallard@10483 24 .\" Title: jcmd
rgallard@10483 25 .\" Language: English
rgallard@10483 26 .\" Date: 03 March 2015
rgallard@10483 27 .\" SectDesc: Troubleshooting Tools
rgallard@10483 28 .\" Software: JDK 8
rgallard@10483 29 .\" Arch: generic
rgallard@10483 30 .\" Part Number: E38207-04
rgallard@10483 31 .\" Doc ID: JSSON
rgallard@8813 32 .\"
rgallard@8813 33 .if n .pl 99999
rgallard@10483 34 .TH "jcmd" "1" "03 March 2015" "JDK 8" "Troubleshooting Tools"
rgallard@10483 35 .\" -----------------------------------------------------------------
rgallard@10483 36 .\" * Define some portability stuff
rgallard@10483 37 .\" -----------------------------------------------------------------
rgallard@10483 38 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
rgallard@10483 39 .\" http://bugs.debian.org/507673
rgallard@10483 40 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
rgallard@10483 41 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
rgallard@10483 42 .ie \n(.g .ds Aq \(aq
rgallard@10483 43 .el .ds Aq '
rgallard@10483 44 .\" -----------------------------------------------------------------
rgallard@10483 45 .\" * set default formatting
rgallard@10483 46 .\" -----------------------------------------------------------------
rgallard@10483 47 .\" disable hyphenation
rgallard@10483 48 .nh
rgallard@10483 49 .\" disable justification (adjust text to left margin only)
rgallard@10483 50 .ad l
rgallard@10483 51 .\" -----------------------------------------------------------------
rgallard@10483 52 .\" * MAIN CONTENT STARTS HERE *
rgallard@10483 53 .\" -----------------------------------------------------------------
rgallard@10483 54 .SH "NAME"
rgallard@8813 55 jcmd \- Sends diagnostic command requests to a running Java Virtual Machine (JVM)\&.
rgallard@10483 56 .SH "SYNOPSIS"
rgallard@10483 57 .sp
rgallard@10483 58 .if n \{\
rgallard@10483 59 .RS 4
rgallard@10483 60 .\}
rgallard@10483 61 .nf
rgallard@8813 62 \fBjcmd\fR [\fB\-l\fR|\fB\-h\fR|\fB\-help\fR]
rgallard@10483 63 .fi
rgallard@10483 64 .if n \{\
rgallard@10483 65 .RE
rgallard@10483 66 .\}
rgallard@10483 67 .sp
rgallard@10483 68 .if n \{\
rgallard@10483 69 .RS 4
rgallard@10483 70 .\}
rgallard@10483 71 .nf
rgallard@8813 72 \fBjcmd\fR \fIpid\fR|\fImain\-class\fR \fBPerfCounter\&.print\fR
rgallard@10483 73 .fi
rgallard@10483 74 .if n \{\
rgallard@10483 75 .RE
rgallard@10483 76 .\}
rgallard@10483 77 .sp
rgallard@10483 78 .if n \{\
rgallard@10483 79 .RS 4
rgallard@10483 80 .\}
rgallard@10483 81 .nf
rgallard@8813 82 \fBjcmd\fR \fIpid\fR|\fImain\-class\fR \fB\-f\fR \fIfilename\fR
rgallard@10483 83 .fi
rgallard@10483 84 .if n \{\
rgallard@10483 85 .RE
rgallard@10483 86 .\}
rgallard@10483 87 .sp
rgallard@10483 88 .if n \{\
rgallard@10483 89 .RS 4
rgallard@10483 90 .\}
rgallard@10483 91 .nf
rgallard@8813 92 \fBjcmd\fR \fIpid\fR|\fImain\-class\fR \fIcommand\fR[ \fIarguments\fR]
rgallard@10483 93 .fi
rgallard@10483 94 .if n \{\
rgallard@10483 95 .RE
rgallard@10483 96 .\}
rgallard@10483 97 .SH "DESCRIPTION"
rgallard@8813 98 .PP
rgallard@10483 99 The
rgallard@10483 100 \fBjcmd\fR
rgallard@10483 101 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\&.
rgallard@10483 102 .if n \{\
rgallard@10483 103 .sp
rgallard@10483 104 .\}
rgallard@10483 105 .RS 4
rgallard@10483 106 .it 1 an-trap
rgallard@10483 107 .nr an-no-space-flag 1
rgallard@10483 108 .nr an-break-flag 1
rgallard@10483 109 .br
rgallard@10483 110 .ps +1
rgallard@10483 111 \fBNote\fR
rgallard@10483 112 .ps -1
rgallard@10483 113 .br
rgallard@10483 114 .TS
rgallard@10483 115 allbox tab(:);
rgallard@10483 116 l.
rgallard@10483 117 T{
rgallard@8813 118 .PP
rgallard@10483 119 To invoke diagnostic commands from a remote machine or with different identifiers, you can use the
rgallard@10483 120 \fBcom\&.sun\&.management\&.DiagnosticCommandMBean\fR
rgallard@10483 121 interface\&. For more information about the
rgallard@10483 122 \fBDiagnosticCommandMBean\fR
rgallard@10483 123 interface, see the API documentation at http://docs\&.oracle\&.com/javase/8/docs/jre/api/management/extension/com/sun/management/DiagnosticCommandMBean\&.html
rgallard@10483 124 T}
rgallard@10483 125 .TE
rgallard@10483 126 .sp 1
rgallard@10483 127 .sp .5v
rgallard@10483 128 .RE
rgallard@8813 129 .PP
rgallard@10483 130 If you run
rgallard@10483 131 \fBjcmd\fR
rgallard@10483 132 without arguments or with the
rgallard@10483 133 \fB\-l\fR
rgallard@10483 134 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
rgallard@10483 135 \fBjcmd\fR
rgallard@10483 136 with the
rgallard@10483 137 \fB\-h\fR
rgallard@10483 138 or
rgallard@10483 139 \fB\-help\fR
rgallard@10483 140 option prints the tool\(cqs help message\&.
rgallard@10483 141 .PP
rgallard@10483 142 If you specify the processes identifier (\fIpid\fR) or the main class (\fImain\-class\fR) as the first argument,
rgallard@10483 143 \fBjcmd\fR
rgallard@10483 144 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
rgallard@10483 145 \fB0\fR
rgallard@10483 146 as the process identifier\&. Use one of the following as the diagnostic command request:
rgallard@10483 147 .PP
rgallard@8813 148 Perfcounter\&.print
rgallard@10483 149 .RS 4
rgallard@8813 150 Prints the performance counters available for the specified Java process\&. The list of performance counters might vary with the Java process\&.
rgallard@10483 151 .RE
rgallard@10483 152 .PP
rgallard@10483 153 \-f \fIfilename\fR
rgallard@10483 154 .RS 4
rgallard@10483 155 The name of the file from which to read diagnostic commands and send them to the specified Java process\&. Used only with the
rgallard@10483 156 \fB\-f\fR
rgallard@10483 157 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
rgallard@10483 158 \fBstop\fR
rgallard@10483 159 keyword is read\&.
rgallard@10483 160 .RE
rgallard@10483 161 .PP
rgallard@10483 162 \fIcommand\fR [\fIarguments\fR]
rgallard@10483 163 .RS 4
rgallard@10483 164 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
rgallard@10483 165 \fBhelp\fR
rgallard@10483 166 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
rgallard@10483 167 \fBhelp\fR
rgallard@10483 168 command\&.
rgallard@10483 169 .sp
rgallard@10483 170 \fBNote:\fR
rgallard@10483 171 If any arguments contain spaces, you must surround them with single or double quotation marks (\fB\*(Aq\fR
rgallard@10483 172 or
rgallard@10483 173 \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)\&.
rgallard@10483 174 .RE
rgallard@10483 175 .SH "OPTIONS"
rgallard@10483 176 .PP
rgallard@10483 177 Options are mutually exclusive\&.
rgallard@10483 178 .PP
rgallard@10483 179 \-f \fIfilename\fR
rgallard@10483 180 .RS 4
rgallard@10483 181 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
rgallard@10483 182 \fBstop\fR
rgallard@10483 183 keyword is read\&.
rgallard@10483 184 .RE
rgallard@10483 185 .PP
rgallard@10483 186 \-h
rgallard@8813 187 .br
rgallard@10483 188 \-help
rgallard@10483 189 .RS 4
rgallard@10483 190 Prints a help message\&.
rgallard@10483 191 .RE
rgallard@10483 192 .PP
rgallard@10483 193 \-l
rgallard@10483 194 .RS 4
rgallard@10483 195 Prints the list of running Java processes identifiers with the main class and command\-line arguments\&.
rgallard@10483 196 .RE
rgallard@10483 197 .SH "SEE ALSO"
rgallard@10483 198 .sp
rgallard@10483 199 .RS 4
rgallard@10483 200 .ie n \{\
rgallard@10483 201 \h'-04'\(bu\h'+03'\c
rgallard@10483 202 .\}
rgallard@10483 203 .el \{\
rgallard@10483 204 .sp -1
rgallard@10483 205 .IP \(bu 2.3
rgallard@10483 206 .\}
rgallard@10483 207 jps(1)
rgallard@10483 208 .RE
rgallard@8813 209 .br
rgallard@10483 210 'pl 8.5i
rgallard@10483 211 'bp