annotate src/bsd/doc/man/jcmd.1 @ 8813:66c98bd811f1

8029043: Update nroff files for JDK 8 Reviewed-by: weijun, alanb, ksrini, naoto
author rgallard
date Mon, 25 Nov 2013 20:19:02 -0800
parents
children aa861c627760
rev   line source
rgallard@8813 1 '\" t
rgallard@8813 2 .\" Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
rgallard@8813 3 .\"
rgallard@8813 4 .\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
rgallard@8813 5 .\"
rgallard@8813 6 .\" This code is free software; you can redistribute it and/or modify it
rgallard@8813 7 .\" under the terms of the GNU General Public License version 2 only, as
rgallard@8813 8 .\" published by the Free Software Foundation.
rgallard@8813 9 .\"
rgallard@8813 10 .\" This code is distributed in the hope that it will be useful, but WITHOUT
rgallard@8813 11 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
rgallard@8813 12 .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
rgallard@8813 13 .\" version 2 for more details (a copy is included in the LICENSE file that
rgallard@8813 14 .\" accompanied this code).
rgallard@8813 15 .\"
rgallard@8813 16 .\" You should have received a copy of the GNU General Public License version
rgallard@8813 17 .\" 2 along with this work; if not, write to the Free Software Foundation,
rgallard@8813 18 .\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
rgallard@8813 19 .\"
rgallard@8813 20 .\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
rgallard@8813 21 .\" or visit www.oracle.com if you need additional information or have any
rgallard@8813 22 .\" questions.
rgallard@8813 23 .\"
rgallard@8813 24 .\" Arch: generic
rgallard@8813 25 .\" Software: JDK 8
rgallard@8813 26 .\" Date: 21 November 2013
rgallard@8813 27 .\" SectDesc: Troubleshooting Tools
rgallard@8813 28 .\" Title: jcmd.1
rgallard@8813 29 .\"
rgallard@8813 30 .if n .pl 99999
rgallard@8813 31 .TH jcmd 1 "21 November 2013" "JDK 8" "Troubleshooting Tools"
rgallard@8813 32 .\" -----------------------------------------------------------------
rgallard@8813 33 .\" * Define some portability stuff
rgallard@8813 34 .\" -----------------------------------------------------------------
rgallard@8813 35 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
rgallard@8813 36 .\" http://bugs.debian.org/507673
rgallard@8813 37 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
rgallard@8813 38 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
rgallard@8813 39 .ie \n(.g .ds Aq \(aq
rgallard@8813 40 .el .ds Aq '
rgallard@8813 41 .\" -----------------------------------------------------------------
rgallard@8813 42 .\" * set default formatting
rgallard@8813 43 .\" -----------------------------------------------------------------
rgallard@8813 44 .\" disable hyphenation
rgallard@8813 45 .nh
rgallard@8813 46 .\" disable justification (adjust text to left margin only)
rgallard@8813 47 .ad l
rgallard@8813 48 .\" -----------------------------------------------------------------
rgallard@8813 49 .\" * MAIN CONTENT STARTS HERE *
rgallard@8813 50 .\" -----------------------------------------------------------------
rgallard@8813 51
rgallard@8813 52 .SH NAME
rgallard@8813 53 jcmd \- Sends diagnostic command requests to a running Java Virtual Machine (JVM)\&.
rgallard@8813 54 .SH SYNOPSIS
rgallard@8813 55 .sp
rgallard@8813 56 .nf
rgallard@8813 57
rgallard@8813 58 \fBjcmd\fR [\fB\-l\fR|\fB\-h\fR|\fB\-help\fR]
rgallard@8813 59 .fi
rgallard@8813 60 .nf
rgallard@8813 61
rgallard@8813 62 \fBjcmd\fR \fIpid\fR|\fImain\-class\fR \fBPerfCounter\&.print\fR
rgallard@8813 63 .fi
rgallard@8813 64 .nf
rgallard@8813 65
rgallard@8813 66 \fBjcmd\fR \fIpid\fR|\fImain\-class\fR \fB\-f\fR \fIfilename\fR
rgallard@8813 67 .fi
rgallard@8813 68 .nf
rgallard@8813 69
rgallard@8813 70 \fBjcmd\fR \fIpid\fR|\fImain\-class\fR \fIcommand\fR[ \fIarguments\fR]
rgallard@8813 71 .fi
rgallard@8813 72 .sp
rgallard@8813 73 .SH DESCRIPTION
rgallard@8813 74 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\&.
rgallard@8813 75 .PP
rgallard@8813 76 \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
rgallard@8813 77 .PP
rgallard@8813 78 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\&.
rgallard@8813 79 .PP
rgallard@8813 80 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:
rgallard@8813 81 .TP
rgallard@8813 82 Perfcounter\&.print
rgallard@8813 83 Prints the performance counters available for the specified Java process\&. The list of performance counters might vary with the Java process\&.
rgallard@8813 84 .TP
rgallard@8813 85 -f \fIfilename\fR
rgallard@8813 86 .br
rgallard@8813 87 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\&.
rgallard@8813 88 .TP
rgallard@8813 89 \fIcommand\fR [\fIarguments\fR]
rgallard@8813 90 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\&.
rgallard@8813 91
rgallard@8813 92 \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)\&.
rgallard@8813 93 .SH OPTIONS
rgallard@8813 94 Options are mutually exclusive\&.
rgallard@8813 95 .TP
rgallard@8813 96 -f \fIfilename\fR
rgallard@8813 97 .br
rgallard@8813 98 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\&.
rgallard@8813 99 .TP
rgallard@8813 100 -h, -help
rgallard@8813 101 .br
rgallard@8813 102 Prints a help message\&.
rgallard@8813 103 .TP
rgallard@8813 104 -l
rgallard@8813 105 .br
rgallard@8813 106 Prints the list of running Java processes identifiers with the main class and command-line arguments\&.
rgallard@8813 107 .SH SEE\ ALSO
rgallard@8813 108 .TP 0.2i
rgallard@8813 109 \(bu
rgallard@8813 110 jps(1)
rgallard@8813 111 .RE
rgallard@8813 112 .br
rgallard@8813 113 'pl 8.5i
rgallard@8813 114 'bp