| J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | .'" t |
| 2 | ." |
| 3 | ." Copyright 2004-2006 Sun Microsystems, Inc. All Rights Reserved. |
| 4 | ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 5 | ." |
| 6 | ." This code is free software; you can redistribute it and/or modify it |
| 7 | ." under the terms of the GNU General Public License version 2 only, as |
| 8 | ." published by the Free Software Foundation. |
| 9 | ." |
| 10 | ." This code is distributed in the hope that it will be useful, but WITHOUT |
| 11 | ." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 12 | ." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 13 | ." version 2 for more details (a copy is included in the LICENSE file that |
| 14 | ." accompanied this code). |
| 15 | ." |
| 16 | ." You should have received a copy of the GNU General Public License version |
| 17 | ." 2 along with this work; if not, write to the Free Software Foundation, |
| 18 | ." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 19 | ." |
| 20 | ." Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 21 | ." CA 95054 USA or visit www.sun.com if you need additional information or |
| 22 | ." have any questions. |
| 23 | ." |
| 24 | ." ` |
| 25 | .TH jconsole 1 "07 Aug 2006" |
| 26 | ." Generated by html2man |
| 27 | |
| 28 | .LP |
| 29 | .SH NAME |
| 30 | jconsole \- Java Monitoring and Management Console |
| 31 | .LP |
| 32 | .SH "SYNOPSIS" |
| 33 | .LP |
| 34 | |
| 35 | .LP |
| 36 | .nf |
| 37 | \f3 |
| 38 | .fl |
| 39 | \fP\f3jconsole\fP [ \f2options\fP ] [ connection ... ] |
| 40 | .fl |
| 41 | |
| 42 | .fl |
| 43 | .fi |
| 44 | |
| 45 | .LP |
| 46 | .SH "PARAMETERS" |
| 47 | .LP |
| 48 | |
| 49 | .LP |
| 50 | .RS 3 |
| 51 | .TP 3 |
| 52 | options |
| 53 | Options, if used, should follow immediately after the command name. |
| 54 | .br |
| 55 | .TP 3 |
| 56 | connection = pid | host:port | jmxUrl |
| 57 | .RS 3 |
| 58 | \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 JMX Monitoring and Management for details. |
| 59 | .br |
| 60 | \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 JMX Monitoring and Management for details. |
| 61 | .br |
| 62 | \f2jmxUrl\fP\ \ Address of the JMX agent to be connected to as described in JMXServiceURL. |
| 63 | .RE |
| 64 | .RE |
| 65 | |
| 66 | .LP |
| 67 | .SH "DESCRIPTION" |
| 68 | .LP |
| 69 | |
| 70 | .LP |
| 71 | .LP |
| 72 | 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. |
| 73 | .LP |
| 74 | .LP |
| 75 | 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. |
| 76 | .LP |
| 77 | .SH "OPTIONS" |
| 78 | .LP |
| 79 | |
| 80 | .LP |
| 81 | .RS 3 |
| 82 | .TP 3 |
| 83 | \-interval=n |
| 84 | Set the update interval to \f2n\fP seconds (default is 4 seconds). |
| 85 | .TP 3 |
| 86 | \-notile\ |
| 87 | Do not tile windows initially (for two or more connections). |
| 88 | .TP 3 |
| 89 | \-pluginpath\ plugins |
| 90 | 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: |
| 91 | .br |
| 92 | .nf |
| 93 | \f3 |
| 94 | .fl |
| 95 | META\-INF/services/com.sun.tools.jconsole.JConsolePlugin |
| 96 | .fl |
| 97 | \fP |
| 98 | .fi |
| 99 | .LP |
| 100 | containing one line for each plugin specifying the fully qualified class name of the class implementing the com.sun.tools.jconsole.JConsolePlugin class. |
| 101 | .TP 3 |
| 102 | \-version\ |
| 103 | Output version information and exit. |
| 104 | .TP 3 |
| 105 | \-help\ |
| 106 | Output help message and exit. |
| 107 | .TP 3 |
| 108 | \-J<flag>\ |
| 109 | Pass <flag> to the Java virtual machine on which jconsole is run. |
| 110 | .RE |
| 111 | |
| 112 | .LP |
| 113 | .SH "SEE ALSO" |
| 114 | .LP |
| 115 | .RS 3 |
| 116 | .TP 2 |
| 117 | o |
| 118 | Using JConsole |
| 119 | .TP 2 |
| 120 | o |
| 121 | Monitoring and Management for Java Platform |
| 122 | .RE |
| 123 | |
| 124 | .LP |
| 125 | |
| 126 | .LP |
| 127 | |