jdk/src/linux/doc/man/jconsole.1
changeset 9573 c02ff5a7c67b
parent 5865 47da38a8c0f0
child 21743 3d979da7bdf0
equal deleted inserted replaced
9572:6f64c69a7574 9573:c02ff5a7c67b
     1 ." Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
     1 ." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
     2 ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     2 ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     3 ."
     3 ."
     4 ." This code is free software; you can redistribute it and/or modify it
     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
     5 ." under the terms of the GNU General Public License version 2 only, as
     6 ." published by the Free Software Foundation.
     6 ." published by the Free Software Foundation.
    17 ."
    17 ."
    18 ." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    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
    19 ." or visit www.oracle.com if you need additional information or have any
    20 ." questions.
    20 ." questions.
    21 ."
    21 ."
    22 .TH jconsole 1 "02 Jun 2010"
    22 .TH jconsole 1 "10 May 2011"
    23 
    23 
    24 .LP
    24 .LP
    25 .SH "Name"
    25 .SH "Name"
    26 jconsole \- Java Monitoring and Management Console
    26 jconsole \- Java Monitoring and Management Console
    27 .LP
    27 .LP
    28 .SH "SYNOPSIS"
    28 .SH "SYNOPSIS"
    29 .LP
       
    30 
       
    31 .LP
    29 .LP
    32 .nf
    30 .nf
    33 \f3
    31 \f3
    34 .fl
    32 .fl
    35 \fP\f3jconsole\fP [ \f2options\fP ] [ connection ... ]
    33 \fP\f3jconsole\fP [ \f2options\fP ] [ connection ... ]
    39 .fi
    37 .fi
    40 
    38 
    41 .LP
    39 .LP
    42 .SH "PARAMETERS"
    40 .SH "PARAMETERS"
    43 .LP
    41 .LP
    44 
       
    45 .LP
       
    46 .RS 3
    42 .RS 3
    47 .TP 3
    43 .TP 3
    48 options 
    44 options 
    49 Options, if used, should follow immediately after the command name. 
    45 Options, if used, should follow immediately after the command name. 
    50 .br
       
    51 .TP 3
    46 .TP 3
    52 connection = pid | host:port | jmxUrl 
    47 connection = pid | host:port | jmxUrl 
    53 .RS 3
    48 .RS 3
    54 \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 
    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 
    55 .na
    52 .na
    56 \f2JMX Monitoring and Management\fP @
    53 \f2JMX Monitoring and Management\fP @
    57 .fi
    54 .fi
    58 http://java.sun.com/javase/6/docs/technotes/guides/management/agent.html for details. 
    55 http://download.oracle.com/javase/7/docs/technotes/guides/management/agent.html for details. 
    59 .br
    56 .TP 2
    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 
    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 
    61 .na
    59 .na
    62 \f2JMX Monitoring and Management\fP @
    60 \f2JMX Monitoring and Management\fP @
    63 .fi
    61 .fi
    64 http://java.sun.com/javase/6/docs/technotes/guides/management/agent.html for details. 
    62 http://download.oracle.com/javase/7/docs/technotes/guides/management/agent.html for details. 
    65 .br
    63 .TP 2
    66 \f2jmxUrl\fP\ \  Address of the JMX agent to be connected to as described in 
    64 o
       
    65 \f2jmxUrl\fP Address of the JMX agent to be connected to as described in 
    67 .na
    66 .na
    68 \f2JMXServiceURL\fP @
    67 \f2JMXServiceURL\fP @
    69 .fi
    68 .fi
    70 http://java.sun.com/javase/6/docs/api/javax/management/remote/JMXServiceURL.html. 
    69 http://download.oracle.com/javase/7/docs/api/javax/management/remote/JMXServiceURL.html. 
    71 .RE
    70 .RE
    72 .RE
    71 .RE
    73 
    72 
    74 .LP
    73 .LP
    75 .SH "DESCRIPTION"
    74 .SH "DESCRIPTION"
    76 .LP
       
    77 
       
    78 .LP
    75 .LP
    79 .LP
    76 .LP
    80 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.
    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.
    81 .LP
    78 .LP
    82 .LP
    79 .LP
    83 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.
    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.
    84 .LP
    81 .LP
    85 .SH "OPTIONS"
    82 .SH "OPTIONS"
    86 .LP
    83 .LP
    87 
       
    88 .LP
       
    89 .RS 3
    84 .RS 3
    90 .TP 3
    85 .TP 3
    91 \-interval=n 
    86 \-interval=n 
    92 Set the update interval to \f2n\fP seconds (default is 4 seconds). 
    87 Set the update interval to \f2n\fP seconds (default is 4 seconds). 
    93 .TP 3
    88 .TP 3
    94 \-notile\  
    89 \-notile 
    95 Do not tile windows initially (for two or more connections). 
    90 Do not tile windows initially (for two or more connections). 
    96 .TP 3
    91 .TP 3
    97 \-pluginpath\  plugins 
    92 \-pluginpath plugins 
    98 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:
    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:
    99 .br
    94 .br
   100 .nf
    95 .nf
   101 \f3
    96 \f3
   102 .fl
    97 .fl
   103    META\-INF/services/com.sun.tools.jconsole.JConsolePlugin
    98    META\-INF/services/com.sun.tools.jconsole.JConsolePlugin
   104 .fl
    99 .fl
   105 \fP
   100 \fP
   106 .fi
   101 .fi
   107 .LP
       
   108 containing one line for each plugin specifying the fully qualified class name of the class implementing the 
   102 containing one line for each plugin specifying the fully qualified class name of the class implementing the 
   109 .na
   103 .na
   110 \f2com.sun.tools.jconsole.JConsolePlugin\fP @
   104 \f2com.sun.tools.jconsole.JConsolePlugin\fP @
   111 .fi
   105 .fi
   112 http://java.sun.com/javase/6/docs/jdk/api/jconsole/spec/com/sun/tools/jconsole/JConsolePlugin.html class.  
   106 http://download.oracle.com/javase/7/docs/jdk/api/jconsole/spec/com/sun/tools/jconsole/JConsolePlugin.html class. 
   113 .TP 3
   107 .TP 3
   114 \-version\  
   108 \-version 
   115 Output version information and exit. 
   109 Output version information and exit. 
   116 .TP 3
   110 .TP 3
   117 \-help\  
   111 \-help 
   118 Output help message and exit. 
   112 Output help message and exit. 
   119 .TP 3
   113 .TP 3
   120 \-J<flag>\  
   114 \-J<flag> 
   121 Pass <flag> to the Java virtual machine on which jconsole is run. 
   115 Pass <flag> to the Java virtual machine on which jconsole is run. 
   122 .RE
   116 .RE
   123 
   117 
   124 .LP
   118 .LP
   125 .SH "SEE ALSO"
   119 .SH "SEE ALSO"
   128 .TP 2
   122 .TP 2
   129 o
   123 o
   130 .na
   124 .na
   131 \f2Using JConsole\fP @
   125 \f2Using JConsole\fP @
   132 .fi
   126 .fi
   133 http://java.sun.com/javase/6/docs/technotes/guides/management/jconsole.html 
   127 http://download.oracle.com/javase/7/docs/technotes/guides/management/jconsole.html 
   134 .TP 2
   128 .TP 2
   135 o
   129 o
   136 .na
   130 .na
   137 \f2Monitoring and Management for Java Platform\fP @
   131 \f2Monitoring and Management for Java Platform\fP @
   138 .fi
   132 .fi
   139 http://java.sun.com/javase/6/docs/technotes/guides/management/index.html 
   133 http://download.oracle.com/javase/7/docs/technotes/guides/management/index.html 
   140 .RE
   134 .RE
   141 
   135 
   142 .LP
   136 .LP
   143  
   137