tbell | 16c34dd | 2009-05-04 18:28:26 -0700 | [diff] [blame^] | 1 | ." Copyright 2006 Sun Microsystems, Inc. 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 | ." |
| 18 | ." Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 19 | ." CA 95054 USA or visit www.sun.com if you need additional information or |
| 20 | ." have any questions. |
tbell | 16c34dd | 2009-05-04 18:28:26 -0700 | [diff] [blame^] | 21 | ." |
| 22 | .TH jconsole 1 "04 May 2009" |
| 23 | ." Generated from HTML by html2man (author: Eric Armstrong) |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 24 | |
| 25 | .LP |
tbell | 16c34dd | 2009-05-04 18:28:26 -0700 | [diff] [blame^] | 26 | .SH "Name" |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 27 | jconsole \- Java Monitoring and Management Console |
| 28 | .LP |
| 29 | .SH "SYNOPSIS" |
| 30 | .LP |
| 31 | |
| 32 | .LP |
| 33 | .nf |
| 34 | \f3 |
| 35 | .fl |
| 36 | \fP\f3jconsole\fP [ \f2options\fP ] [ connection ... ] |
| 37 | .fl |
| 38 | |
| 39 | .fl |
| 40 | .fi |
| 41 | |
| 42 | .LP |
| 43 | .SH "PARAMETERS" |
| 44 | .LP |
| 45 | |
| 46 | .LP |
| 47 | .RS 3 |
| 48 | .TP 3 |
| 49 | options |
| 50 | Options, if used, should follow immediately after the command name. |
| 51 | .br |
| 52 | .TP 3 |
| 53 | connection = pid | host:port | jmxUrl |
| 54 | .RS 3 |
tbell | 16c34dd | 2009-05-04 18:28:26 -0700 | [diff] [blame^] | 55 | \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 |
| 56 | .na |
| 57 | \f2JMX Monitoring and Management\fP @ |
| 58 | .fi |
| 59 | http://java.sun.com/javase/6/docs/technotes/guides/management/agent.html for details. |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 60 | .br |
tbell | 16c34dd | 2009-05-04 18:28:26 -0700 | [diff] [blame^] | 61 | \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 |
| 62 | .na |
| 63 | \f2JMX Monitoring and Management\fP @ |
| 64 | .fi |
| 65 | http://java.sun.com/javase/6/docs/technotes/guides/management/agent.html for details. |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 66 | .br |
tbell | 16c34dd | 2009-05-04 18:28:26 -0700 | [diff] [blame^] | 67 | \f2jmxUrl\fP\ \ Address of the JMX agent to be connected to as described in |
| 68 | .na |
| 69 | \f2JMXServiceURL\fP @ |
| 70 | .fi |
| 71 | http://java.sun.com/javase/6/docs/api/javax/management/remote/JMXServiceURL.html. |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 72 | .RE |
| 73 | .RE |
| 74 | |
| 75 | .LP |
| 76 | .SH "DESCRIPTION" |
| 77 | .LP |
| 78 | |
| 79 | .LP |
| 80 | .LP |
| 81 | 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. |
| 82 | .LP |
| 83 | .LP |
| 84 | 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. |
| 85 | .LP |
| 86 | .SH "OPTIONS" |
| 87 | .LP |
| 88 | |
| 89 | .LP |
| 90 | .RS 3 |
| 91 | .TP 3 |
| 92 | \-interval=n |
| 93 | Set the update interval to \f2n\fP seconds (default is 4 seconds). |
| 94 | .TP 3 |
| 95 | \-notile\ |
| 96 | Do not tile windows initially (for two or more connections). |
| 97 | .TP 3 |
| 98 | \-pluginpath\ plugins |
| 99 | 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: |
| 100 | .br |
| 101 | .nf |
| 102 | \f3 |
| 103 | .fl |
| 104 | META\-INF/services/com.sun.tools.jconsole.JConsolePlugin |
| 105 | .fl |
| 106 | \fP |
| 107 | .fi |
| 108 | .LP |
tbell | 16c34dd | 2009-05-04 18:28:26 -0700 | [diff] [blame^] | 109 | containing one line for each plugin specifying the fully qualified class name of the class implementing the |
| 110 | .na |
| 111 | \f2com.sun.tools.jconsole.JConsolePlugin\fP @ |
| 112 | .fi |
| 113 | http://java.sun.com/javase/6/docs/jdk/api/jconsole/spec/com/sun/tools/jconsole/JConsolePlugin.html class. |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 114 | .TP 3 |
| 115 | \-version\ |
| 116 | Output version information and exit. |
| 117 | .TP 3 |
| 118 | \-help\ |
| 119 | Output help message and exit. |
| 120 | .TP 3 |
| 121 | \-J<flag>\ |
| 122 | Pass <flag> to the Java virtual machine on which jconsole is run. |
| 123 | .RE |
| 124 | |
| 125 | .LP |
| 126 | .SH "SEE ALSO" |
| 127 | .LP |
| 128 | .RS 3 |
| 129 | .TP 2 |
| 130 | o |
tbell | 16c34dd | 2009-05-04 18:28:26 -0700 | [diff] [blame^] | 131 | .na |
| 132 | \f2Using JConsole\fP @ |
| 133 | .fi |
| 134 | http://java.sun.com/javase/6/docs/technotes/guides/management/jconsole.html |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 135 | .TP 2 |
| 136 | o |
tbell | 16c34dd | 2009-05-04 18:28:26 -0700 | [diff] [blame^] | 137 | .na |
| 138 | \f2Monitoring and Management for Java Platform\fP @ |
| 139 | .fi |
| 140 | http://java.sun.com/javase/6/docs/technotes/guides/management/index.html |
duke | 6e45e10 | 2007-12-01 00:00:00 +0000 | [diff] [blame] | 141 | .RE |
| 142 | |
| 143 | .LP |
| 144 | |
| 145 | .LP |
| 146 | |