annotate src/bsd/doc/man/jcmd.1 @ 13229:0939503b7477

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