bpatel | 4bf512b | 2011-05-11 08:30:46 -0700 | [diff] [blame] | 1 | ." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 2 | ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 3 | ." |
| 4 | ." This code is free software; you can redistribute it and/or modify it |
| 5 | ." under the terms of the GNU General Public License version 2 only, as |
| 6 | ." published by the Free Software Foundation. |
| 7 | ." |
| 8 | ." This code is distributed in the hope that it will be useful, but WITHOUT |
| 9 | ." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 10 | ." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 11 | ." version 2 for more details (a copy is included in the LICENSE file that |
| 12 | ." accompanied this code). |
| 13 | ." |
| 14 | ." You should have received a copy of the GNU General Public License version |
| 15 | ." 2 along with this work; if not, write to the Free Software Foundation, |
| 16 | ." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 17 | ." |
ohair | 2283b9d | 2010-05-25 15:58:33 -0700 | [diff] [blame] | 18 | ." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| 19 | ." or visit www.oracle.com if you need additional information or have any |
| 20 | ." questions. |
tbell | 16c34dd | 2009-05-04 18:28:26 -0700 | [diff] [blame] | 21 | ." |
bpatel | 4bf512b | 2011-05-11 08:30:46 -0700 | [diff] [blame] | 22 | .TH jconsole 1 "10 May 2011" |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 23 | |
| 24 | .LP |
tbell | 16c34dd | 2009-05-04 18:28:26 -0700 | [diff] [blame] | 25 | .SH "Name" |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 26 | jconsole \- Java Monitoring and Management Console |
| 27 | .LP |
| 28 | .SH "SYNOPSIS" |
| 29 | .LP |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 30 | .nf |
| 31 | \f3 |
| 32 | .fl |
| 33 | \fP\f3jconsole\fP [ \f2options\fP ] [ connection ... ] |
| 34 | .fl |
| 35 | |
| 36 | .fl |
| 37 | .fi |
| 38 | |
| 39 | .LP |
| 40 | .SH "PARAMETERS" |
| 41 | .LP |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 42 | .RS 3 |
| 43 | .TP 3 |
| 44 | options |
| 45 | Options, if used, should follow immediately after the command name. |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 46 | .TP 3 |
| 47 | connection = pid | host:port | jmxUrl |
| 48 | .RS 3 |
bpatel | 4bf512b | 2011-05-11 08:30:46 -0700 | [diff] [blame] | 49 | .TP 2 |
| 50 | o |
| 51 | \f2pid\fP Process ID of a local Java VM. The Java VM must be running with the same user ID as the user ID running jconsole. See |
tbell | 16c34dd | 2009-05-04 18:28:26 -0700 | [diff] [blame] | 52 | .na |
| 53 | \f2JMX Monitoring and Management\fP @ |
| 54 | .fi |
bpatel | 4bf512b | 2011-05-11 08:30:46 -0700 | [diff] [blame] | 55 | http://download.oracle.com/javase/7/docs/technotes/guides/management/agent.html for details. |
| 56 | .TP 2 |
| 57 | o |
| 58 | \f2host\fP:\f2port\fP Name of the host system on which the Java VM is running and the port number specified by the system property \f2com.sun.management.jmxremote.port\fP when the Java VM was started. See |
tbell | 16c34dd | 2009-05-04 18:28:26 -0700 | [diff] [blame] | 59 | .na |
| 60 | \f2JMX Monitoring and Management\fP @ |
| 61 | .fi |
bpatel | 4bf512b | 2011-05-11 08:30:46 -0700 | [diff] [blame] | 62 | http://download.oracle.com/javase/7/docs/technotes/guides/management/agent.html for details. |
| 63 | .TP 2 |
| 64 | o |
| 65 | \f2jmxUrl\fP Address of the JMX agent to be connected to as described in |
tbell | 16c34dd | 2009-05-04 18:28:26 -0700 | [diff] [blame] | 66 | .na |
| 67 | \f2JMXServiceURL\fP @ |
| 68 | .fi |
bpatel | 4bf512b | 2011-05-11 08:30:46 -0700 | [diff] [blame] | 69 | http://download.oracle.com/javase/7/docs/api/javax/management/remote/JMXServiceURL.html. |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 70 | .RE |
| 71 | .RE |
| 72 | |
| 73 | .LP |
| 74 | .SH "DESCRIPTION" |
| 75 | .LP |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 76 | .LP |
| 77 | The \f3jconsole\fP command launches a graphical console tool that enables you to monitor and manage Java applications and virtual machines on a local or remote machine. |
| 78 | .LP |
| 79 | .LP |
| 80 | On Windows, \f3jconsole\fP does not associate with a console window. It will, however, display a dialog box with error information if the \f3jconsole\fP command fails for some reason. |
| 81 | .LP |
| 82 | .SH "OPTIONS" |
| 83 | .LP |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 84 | .RS 3 |
| 85 | .TP 3 |
| 86 | \-interval=n |
| 87 | Set the update interval to \f2n\fP seconds (default is 4 seconds). |
| 88 | .TP 3 |
bpatel | 4bf512b | 2011-05-11 08:30:46 -0700 | [diff] [blame] | 89 | \-notile |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 90 | Do not tile windows initially (for two or more connections). |
| 91 | .TP 3 |
bpatel | 4bf512b | 2011-05-11 08:30:46 -0700 | [diff] [blame] | 92 | \-pluginpath plugins |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 93 | Specify a list of directories or JAR files which are searched for JConsole plugins. The \f2plugins\fP path should contain a provider\-configuration file named: |
| 94 | .br |
| 95 | .nf |
| 96 | \f3 |
| 97 | .fl |
| 98 | META\-INF/services/com.sun.tools.jconsole.JConsolePlugin |
| 99 | .fl |
| 100 | \fP |
| 101 | .fi |
tbell | 16c34dd | 2009-05-04 18:28:26 -0700 | [diff] [blame] | 102 | containing one line for each plugin specifying the fully qualified class name of the class implementing the |
| 103 | .na |
| 104 | \f2com.sun.tools.jconsole.JConsolePlugin\fP @ |
| 105 | .fi |
bpatel | 4bf512b | 2011-05-11 08:30:46 -0700 | [diff] [blame] | 106 | http://download.oracle.com/javase/7/docs/jdk/api/jconsole/spec/com/sun/tools/jconsole/JConsolePlugin.html class. |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 107 | .TP 3 |
bpatel | 4bf512b | 2011-05-11 08:30:46 -0700 | [diff] [blame] | 108 | \-version |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 109 | Output version information and exit. |
| 110 | .TP 3 |
bpatel | 4bf512b | 2011-05-11 08:30:46 -0700 | [diff] [blame] | 111 | \-help |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 112 | Output help message and exit. |
| 113 | .TP 3 |
bpatel | 4bf512b | 2011-05-11 08:30:46 -0700 | [diff] [blame] | 114 | \-J<flag> |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 115 | Pass <flag> to the Java virtual machine on which jconsole is run. |
| 116 | .RE |
| 117 | |
| 118 | .LP |
| 119 | .SH "SEE ALSO" |
| 120 | .LP |
| 121 | .RS 3 |
| 122 | .TP 2 |
| 123 | o |
tbell | 16c34dd | 2009-05-04 18:28:26 -0700 | [diff] [blame] | 124 | .na |
| 125 | \f2Using JConsole\fP @ |
| 126 | .fi |
bpatel | 4bf512b | 2011-05-11 08:30:46 -0700 | [diff] [blame] | 127 | http://download.oracle.com/javase/7/docs/technotes/guides/management/jconsole.html |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 128 | .TP 2 |
| 129 | o |
tbell | 16c34dd | 2009-05-04 18:28:26 -0700 | [diff] [blame] | 130 | .na |
| 131 | \f2Monitoring and Management for Java Platform\fP @ |
| 132 | .fi |
bpatel | 4bf512b | 2011-05-11 08:30:46 -0700 | [diff] [blame] | 133 | http://download.oracle.com/javase/7/docs/technotes/guides/management/index.html |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 134 | .RE |
| 135 | |
| 136 | .LP |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 137 | |