blob: 9fe0c6f6108caf377637b9c3aca679755a1b41e3 [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +00001.'" t
2." Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
3." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4."
5." This code is free software; you can redistribute it and/or modify it
6." under the terms of the GNU General Public License version 2 only, as
7." published by the Free Software Foundation.
8."
9." This code is distributed in the hope that it will be useful, but WITHOUT
10." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12." version 2 for more details (a copy is included in the LICENSE file that
13." accompanied this code).
14."
15." You should have received a copy of the GNU General Public License version
16." 2 along with this work; if not, write to the Free Software Foundation,
17." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18."
19." Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
20." CA 95054 USA or visit www.sun.com if you need additional information or
21." have any questions.
22." `
23.TH javaws 1 "05 Aug 2006"
24." Generated by html2roff
25
26.LP
27
28.LP
29.SH NAME
30\f2javaws\fP Command Line
31.LP
32
33.LP
34.LP
35\
36.LP
37.SS
38NAME
39.LP
40
41.LP
42.LP
43\f2javaws\fP \- Java Web Start launcher command
44.LP
45.SS
46SYNOPSIS
47.LP
48
49.LP
50.LP
51\f2javaws [ options ] [ URL ]\fP
52.LP
53.SS
54PARAMETERS
55.LP
56
57.LP
58.LP
59\f2options\fP
60.LP
61.RS 3
62
63.LP
64.LP
65Command\-line options. Options may be in any order. For a discussion of the various options, see OPTIONS below.
66.LP
67.RE
68.LP
69\f2URL\fP
70.LP
71.RS 3
72
73.LP
74.LP
75Uniform Resource Locator (\f2URL\fP) of the JNLP (Java Net\-work Launching Protocol) file.
76.LP
77.RE
78.SS
79DESCRIPTION
80.LP
81
82.LP
83.LP
84The \f2javaws\fP command launches Java Web Start, which is the reference implementation of the Java Network Launching Protocol (JNLP). Java Web Start launches Java applications/applets hosted on a network.
85.LP
86.LP
87Without any options \f2javaws\fP will launch the Java JNLP Application Manager, from which users can launch applications/applet or configure Java Web Start.
88.LP
89.LP
90If a \f2URL\fP for a JNLP file is specified, \f2javaws\fP will launch the Java application/applet specified in the JNLP file.
91.LP
92.SS
93OPTIONS
94.LP
95
96.LP
97.LP
98The \f2javaws\fP launcher has a set of options that are supported in the current release. However, the options may be removed in a future release. All \f2\-X\fP options are non\-standard and subject to change.
99.LP
100.LP
101\f2\-offline\fP
102.LP
103.RS 3
104
105.LP
106.LP
107Runs Java Web Start in offline mode.
108.LP
109.RE
110.LP
111\f2\-uninstall <URL>\fP
112.LP
113.RS 3
114
115.LP
116.LP
117Removes a specific application/applet from the user's cache, as indicated by the URL for the JNLP file. If \f2<URL>\fP is not specified, the entire cache is removed. Java Web Start will exit after the command is completed.
118.LP
119.RE
120.LP
121\f2\-updateVersions\fP
122.LP
123.RS 3
124
125.LP
126.LP
127Updates the Java Web Start configuration file based on the current machine's settings. Java Web Start will exit after the command is completed.
128.LP
129.RE
130.LP
131\f2\-Xclearcache\fP
132.LP
133.RS 3
134
135.LP
136.LP
137Clears the user's cache. Java Web Start will exit after the command is completed.
138.LP
139.RE
140.LP
141\f2\-Xnosplash\fP
142.LP
143.RS 3
144
145.LP
146.LP
147Disables the display of the initial splash screen.
148.LP
149.RE
150.LP
151\f2\-import\fP
152.LP
153.RS 3
154
155.LP
156.LP
157Imports the application specified by URL into the user's cache but does not run it.
158.LP
159.RE
160.LP
161\f2\-silent\fP
162.LP
163.RS 3
164
165.LP
166.LP
167When used with the \f2\-import\fP option, imports in silent mode; i.e., there will be no UI pop up. The process exit code will be either 0 if successful or 1 if not.
168.LP
169.RE
170.LP
171\f2\-codebase <url>\fP
172.LP
173.RS 3
174
175.LP
176.LP
177Replaces the codebase with \f2<url>\fP in the jnlp file specified when importing the resources. \f2<url>\fP must be a valid \f2URL\fP.
178.LP
179.RE
180.LP
181\f2\-system\fP
182.LP
183.RS 3
184
185.LP
186.LP
187Uses the system cache instead of the user cache.
188.LP
189.RE
190.LP
191\f2\-shortcut\fP
192.LP
193.RS 3
194
195.LP
196.LP
197Allows the creation of shortcuts during silent import.
198.LP
199.RE
200.LP
201\f2\-association\fP
202.LP
203.RS 3
204
205.LP
206.LP
207Allows the creation of associations during silent import.
208.LP
209.RE
210.LP
211\f2\-open <arguments>\fP
212.LP
213.RS 3
214
215.LP
216.LP
217If specified, replaces the arguments in the jnlp file with \f2\-open <arguments>\fP.
218.LP
219.RE
220.LP
221\f2\-print <arguments>\fP
222.LP
223.RS 3
224
225.LP
226.LP
227If specified, replaces the arguments in the jnlp file with \f2\-print <arguments>\fP.
228.LP
229.RE
230.LP
231\f2\-online\fP
232.LP
233.RS 3
234
235.LP
236.LP
237Runs in online mode (default behavior).
238.LP
239.RE
240.LP
241\f2\-viewer\fP
242.LP
243.RS 3
244
245.LP
246.LP
247Runs the Java Application Cache Viewer (default if no URL is specified).
248.LP
249.RE
250.LP
251\f2\-userConfig <property name>\fP
252.LP
253.RS 3
254
255.LP
256.LP
257Clears the specified deployment property.
258.LP
259.RE
260.LP
261\f2\-userConfig <property name> <property value>\fP
262.LP
263.RS 3
264
265.LP
266.LP
267Sets the specified deployment property to the specified value.
268.LP
269.RE
270.LP
271\f2\-wait\fP
272.LP
273.RS 3
274
275.LP
276.LP
277If specified, the \f2javaws\fP process will not exit until the application exits.
278.LP
279.RE
280.LP
281\
282.LP
283.SS
284FILES
285.LP
286
287.LP
288.LP
289For information about the user and system cache and deployment.properties files, see
290.na
291\f2System\- and User\-Level Properties\fP @
292.fi
293http://java.sun.com/javase/6/docs/technotes/guides/deployment/deployment\-guide/properties.html.
294.LP
295.SS
296MORE INFORMATION
297.LP
298
299.LP
300.LP
301For more information about Java Web Start, see
302.na
303\f2Java Web Start version 1.5.0\fP @
304.fi
305http://java.sun.com/javase/6/docs/technotes/guides/javaws/index.html.
306.LP
307.RS 3
308
309.LP
310.LP
311\
312.LP
313.RE
314