jps.1 revision 6073:cea72c2bf071 
1." Copyright (c) 2004, 2012, Oracle and/or its affiliates. All rights reserved.
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 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.
21."
22.TH jps 1 "10 May 2011"
23
24.LP
25.SH "Name"
26jps \- Java Virtual Machine Process Status Tool
27.LP
28.SH "SYNOPSIS"
29.LP
30.nf
31\f3
32.fl
33\fP\f3jps\fP [ \f2options\fP ] [ \f2hostid\fP ]
34.br
35
36.fl
37.fi
38
39.LP
40.SH "PARAMETERS"
41.LP
42.RS 3
43.TP 3
44options
45Command\-line options.
46.TP 3
47hostid
48The host identifier of the host for which the process report should be generated. The \f2hostid\fP may include optional components that indicate the communications protocol, port number, and other implementation specific data.
49.RE
50
51.LP
52.SH "DESCRIPTION"
53.LP
54.LP
55The \f3jps\fP tool lists the instrumented HotSpot Java Virtual Machines (JVMs) on the target system. The tool is limited to reporting information on JVMs for which it has the access permissions.
56.LP
57.LP
58If \f3jps\fP is run without specifying a \f2hostid\fP, it will look for instrumented JVMs on the local host. If started with a \f2hostid\fP, it will look for JVMs on the indicated host, using the specified protocol and port. A \f3jstatd\fP process is assumed to be running on the target host.
59.LP
60.LP
61The \f3jps\fP command will report the local VM identifier, or \f2lvmid\fP, for each instrumented JVM found on the target system. The \f3lvmid\fP is typically, but not necessarily, the operating system's process identifier for the JVM process. With no options, \f3jps\fP will list each Java application's \f2lvmid\fP followed by the short form of the application's class name or jar file name. The short form of the class name or JAR file name omits the class's package information or the JAR files path information.
62.LP
63.LP
64The \f3jps\fP command uses the \f3java\fP launcher to find the class name and arguments passed to the \f2main\fP method. If the target JVM is started with a custom launcher, the class name (or JAR file name) and the arguments to the \f2main\fP method will not be available. In this case, the \f3jps\fP command will output the string \f2Unknown\fP for the class name or JAR file name and for the arguments to the main method.
65.LP
66.LP
67The list of JVMs produced by the \f3jps\fP command may be limited by the permissions granted to the principal running the command. The command will only list the JVMs for which the principle has access rights as determined by operating system specific access control mechanisms.
68.LP
69.LP
70\f3NOTE:\fP This utility is unsupported and may not be available in future versions of the JDK. It is not currently available on Windows 98 and Windows ME platforms.
71.LP
72.SH "OPTIONS"
73.LP
74.LP
75The \f3jps\fP command supports a number of options that modify the output of the command. These options are subject to change or removal in the future.
76.LP
77.RS 3
78.TP 3
79\-q
80Suppress the output of the class name, JAR file name, and arguments passed to the \f2main\fP method, producing only a list of local VM identifiers.
81.TP 3
82\-m
83Output the arguments passed to the main method. The output may be null for embedded JVMs.
84.TP 3
85\-l
86Output the full package name for the application's main class or the full path name to the application's JAR file.
87.TP 3
88\-v
89Output the arguments passed to the JVM.
90.TP 3
91\-V
92Output the arguments passed to the JVM through the flags file (the .hotspotrc file or the file specified by the \-XX:Flags=<\f2filename\fP> argument).
93.TP 3
94\-Joption
95Pass \f2option\fP to the \f3java\fP launcher called by \f3jps\fP. For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. It is a common convention for \f3\-J\fP to pass options to the underlying VM executing applications written in Java.
96.RE
97
98.LP
99.SS
100HOST IDENTIFIER
101.LP
102.LP
103The host identifier, or \f2hostid\fP is a string that indicates the target system. The syntax of the \f2hostid\fP string largely corresponds to the syntax of a URI:
104.LP
105.nf
106\f3
107.fl
108[\fP\f4protocol\fP\f3:][[//]\fP\f4hostname\fP\f3][:\fP\f4port\fP\f3][/\fP\f4servername\fP\f3]\fP
109.br
110\f3
111.fl
112\fP
113.fi
114
115.LP
116.RS 3
117.TP 3
118protocol
119The communications protocol. If the \f2protocol\fP is omitted and a \f2hostname\fP is not specified, the default protocol is a platform specific, optimized, local protocol. If the \f2protocol\fP is omitted and a \f2hostname\fP is specified, then the default protocol is \f3rmi\fP.
120.TP 3
121hostname
122A hostname or IP address indicating the target host. If \f2hostname\fP is omitted, then the target host is the local host.
123.TP 3
124port
125The default port for communicating with the remote server. If the \f2hostname\fP is omitted or the \f2protocol\fP specifies an optimized, local protocol, then \f2port\fP is ignored. Otherwise, treatment of the \f2port\fP parameter is implementation specific. For the default \f3rmi\fP protocol the \f2port\fP indicates the port number for the rmiregistry on the remote host. If \f2port\fP is omitted, and \f2protocol\fP indicates \f3rmi\fP, then the default rmiregistry port (1099) is used.
126.TP 3
127servername
128The treatment of this parameter depends on the implementation. For the optimized, local protocol, this field is ignored. For the \f3rmi\fP protocol, this parameter is a string representing the name of the RMI remote object on the remote host. See the \f3\-n\fP option for the jstatd(1) command.
129.RE
130
131.LP
132.SH "OUTPUT FORMAT"
133.LP
134.LP
135The output of the \f3jps\fP command follows the following pattern:
136.LP
137.nf
138\f3
139.fl
140\fP\f4lvmid\fP\f3 [ [ \fP\f4classname\fP\f3 | \fP\f4JARfilename\fP\f3 | "Unknown"] [ \fP\f4arg\fP\f3* ] [ \fP\f4jvmarg\fP\f3* ] ]\fP
141.br
142\f3
143.fl
144\fP
145.fi
146
147.LP
148.LP
149Where all output tokens are separated by white space. An \f2arg\fP that includes embedded white space will introduce ambiguity when attempting to map arguments to their actual positional parameters.
150.br
151.br
152\f3NOTE\fP: You are advised not to write scripts to parse \f3jps\fP output since the format may change in future releases. If you choose to write scripts that parse \f3jps\fP output, expect to modify them for future releases of this tool.
153.br
154
155.LP
156.SH "EXAMPLES"
157.LP
158.LP
159This section provides examples of the \f3jps\fP command.
160.LP
161.LP
162Listing the instrumented JVMs on the local host:
163.LP
164.nf
165\f3
166.fl
167\fP\f3jps\fP
168.br
169
170.fl
17118027 Java2Demo.JAR
172.br
173
174.fl
17518032 jps
176.br
177
178.fl
17918005 jstat
180.br
181
182.fl
183.fi
184
185.LP
186.LP
187Listing the instrumented JVMs on a remote host:
188.LP
189.LP
190This example assumes that the \f3jstat\fP server and either the its internal RMI registry or a separate external \f3rmiregistry\fP process are running on the remote host on the default port (port 1099). It also assumes that the local host has appropriate permissions to access the remote host. This example also includes the \f2\-l\fP option to output the long form of the class names or JAR file names.
191.LP
192.nf
193\f3
194.fl
195\fP\f3jps \-l remote.domain\fP
196.br
197
198.fl
1993002 /opt/jdk1.7.0/demo/jfc/Java2D/Java2Demo.JAR
200.br
201
202.fl
2032857 sun.tools.jstatd.jstatd
204.br
205
206.fl
207.fi
208
209.LP
210.LP
211Listing the instrumented JVMs on a remote host with a non\-default port for the RMI registry
212.LP
213.LP
214This example assumes that the \f3jstatd\fP server, with an internal RMI registry bound to port 2002, is running on the remote host. This example also uses the \f2\-m\fP option to include the arguments passed to the \f2main\fP method of each of the listed Java applications.
215.LP
216.nf
217\f3
218.fl
219\fP\f3jps \-m remote.domain:2002\fP
220.br
221
222.fl
2233002 /opt/jdk1.7.0/demo/jfc/Java2D/Java2Demo.JAR
224.br
225
226.fl
2273102 sun.tools.jstatd.jstatd \-p 2002
228.fl
229.fi
230
231.LP
232.SH "SEE ALSO"
233.LP
234.RS 3
235.TP 2
236o
237java(1) \- the Java Application Launcher
238.TP 2
239o
240jstat(1) \- the Java virtual machine Statistics Monitoring Tool
241.TP 2
242o
243jstatd(1) \- the jstat daemon
244.TP 2
245o
246rmiregistry(1) \- the Java Remote Object Registry
247.RE
248
249.LP
250
251