platform-update-home/doc/working/documentation/standalone_update.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.16 - (view) (download) (as text)

1 : dbirsan 1.1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 :     <html>
3 :     <head>
4 :     <title>Standalone update</title>
5 :    
6 :     <meta http-equiv="content-type"
7 :     content="text/html; charset=ISO-8859-1">
8 :     </head>
9 :     <body>
10 :     <h3>Standalone update</h3>
11 : dbirsan 1.2 With the most recent code, you can install/update/enable/disable
12 :     a feature or list the features available on a remote site by running eclipse in a command line mode.<br>
13 : dbirsan 1.8 You can also, mirror chosen features from an update site to a local update site mirror.<br>
14 : dbirsan 1.1 <br>
15 : dbirsan 1.2 Launch eclipse as follows, where [ ] means optional argument and arguments in italics must be provided by the user.<br>
16 : dbirsan 1.4 <br>
17 : dbirsan 1.1 <b>Installing a feature from a remote site</b>:<br>
18 : dbirsan 1.12 java -cp startup.jar org.eclipse.core.launcher.Main <br>
19 : dbirsan 1.9 &nbsp;&nbsp;&nbsp; -application&nbsp; org.eclipse.update.core.standaloneUpdate<br>
20 :     &nbsp;&nbsp;&nbsp; -command install <br>
21 :     &nbsp;&nbsp;&nbsp; -featureId <i>feature_id </i><br>
22 :     &nbsp;&nbsp;&nbsp; -version <i>version </i><br>
23 :     &nbsp;&nbsp;&nbsp; -from <i>remote_site_url</i> <br>
24 :     &nbsp;&nbsp;&nbsp; [-to <i>target_site_dir</i>] <br>
25 : dbirsan 1.2 <p>
26 : dbirsan 1.12 <b>Example:</b> <code>java -cp startup.jar org.eclipse.core.launcher.Main -application org.eclipse.update.core.standaloneUpdate -command install -from http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/platform-update-home/optionalSite/ -featureId com.example.root -version 1.0.0</code>
27 : dbirsan 1.2 </p>
28 : dbirsan 1.1 <br>
29 : dbirsan 1.7 <b>Updating an existing feature or all features</b>:<br>
30 : dbirsan 1.12 java -cp startup.jar org.eclipse.core.launcher.Main <br>
31 : dbirsan 1.9 &nbsp;&nbsp;&nbsp; -application&nbsp; org.eclipse.update.core.standaloneUpdate<br>
32 : dbirsan 1.1 &nbsp;&nbsp;&nbsp; -command update<br>
33 : dbirsan 1.7 &nbsp;&nbsp;&nbsp; [-featureId <i>feature_id </i>]<br>
34 : dbirsan 1.1 <br>
35 :     <b>Enabling (configuring) a specified feature:</b><br>
36 : dbirsan 1.12 java -cp startup.jar org.eclipse.core.launcher.Main <br>
37 : dbirsan 1.9 &nbsp;&nbsp;&nbsp; -application&nbsp; org.eclipse.update.core.standaloneUpdate<br>
38 : dbirsan 1.1 &nbsp;&nbsp;&nbsp; -command enable<br>
39 : dbirsan 1.6 &nbsp;&nbsp;&nbsp; -featureId <i>feature_id </i><br>
40 : dbirsan 1.1 &nbsp;&nbsp;&nbsp; -version <i>version </i><br>
41 : dbirsan 1.8 &nbsp;&nbsp;&nbsp; [-to <i>target_site_dir</i>] <br>
42 : dbirsan 1.1 <br>
43 :     <b>Disabling (unconfiguring) a specified feature:</b><br>
44 : dbirsan 1.12 java -cp startup.jar org.eclipse.core.launcher.Main <br>
45 : dbirsan 1.9 &nbsp;&nbsp;&nbsp; -application&nbsp; org.eclipse.update.core.standaloneUpdate<br>
46 :     &nbsp;&nbsp;&nbsp; -command disable<br>
47 :     &nbsp;&nbsp;&nbsp; -featureId <i>feature_id </i><br>
48 :     &nbsp;&nbsp;&nbsp; -version <i>version </i><br>
49 :     &nbsp;&nbsp;&nbsp; [-to <i>target_site_dir</i>] <br>
50 : dbirsan 1.1 <br>
51 : dbirsan 1.9 <b>Uninstalling a specified feature:</b><br>
52 : dbirsan 1.12 java -cp startup.jar org.eclipse.core.launcher.Main <br>
53 : dbirsan 1.9 &nbsp;&nbsp;&nbsp; -application&nbsp; org.eclipse.update.core.standaloneUpdate<br>
54 :     &nbsp;&nbsp;&nbsp; -command uninstall<br>
55 : dbirsan 1.6 &nbsp;&nbsp;&nbsp; -featureId <i>feature_id </i><br>
56 : dbirsan 1.1 &nbsp;&nbsp;&nbsp; -version <i>version </i><br>
57 : dbirsan 1.8 &nbsp;&nbsp;&nbsp; [-to <i>target_site_dir</i>] <br>
58 : dbirsan 1.1 <br>
59 : dbirsan 1.8 In all the above commands where the -to target_site_dir is specified, corresponding
60 :     configured target site at given directory will be used. If it is not specified,
61 :     then the default local product site is used.<br>
62 :     <br>
63 :     If you only need to verify if the operation would succeed, in the above commands, (i.e. it satisfies the constraints), without actually performing it,
64 : dbirsan 1.9 then add <b><em>-verifyOnly=true</em></b> to the list of arguments.<br>
65 : dbirsan 1.8
66 :     <br><b>Searching a remote site, listing all available features for install:</b><br>
67 : dbirsan 1.12 java -cp startup.jar org.eclipse.core.launcher.Main <br>
68 : dbirsan 1.9 &nbsp;&nbsp;&nbsp; -application&nbsp; org.eclipse.update.core.standaloneUpdate<br>
69 : dbirsan 1.1 &nbsp;&nbsp;&nbsp; -command search<br>
70 :     &nbsp;&nbsp;&nbsp; -from <i>remote_site_url</i> <br>
71 : dbirsan 1.14
72 : dbirsan 1.15 <br><b>Listing installed features:</b><br>
73 : dbirsan 1.14 java -cp startup.jar org.eclipse.core.launcher.Main <br>
74 :     &nbsp;&nbsp;&nbsp; -application&nbsp; org.eclipse.update.core.standaloneUpdate<br>
75 : dbirsan 1.15 &nbsp;&nbsp;&nbsp; -command listFeatures<br>
76 : dbirsan 1.14 &nbsp;&nbsp;&nbsp; -from <i>local_site_dir</i> <br>
77 : dbirsan 1.16 <br>
78 :     The features are listed as:
79 :     <br>
80 :     <code>
81 :     Site: <em>site url </em><br>
82 :     &nbsp;&nbsp;Feature: <em>id version</em> enabled (or disabled)
83 :     </code>
84 :     <br>
85 : dbirsan 1.14
86 :     <br><b>Adding a local site with more features:</b><br>
87 :     java -cp startup.jar org.eclipse.core.launcher.Main <br>
88 :     &nbsp;&nbsp;&nbsp; -application&nbsp; org.eclipse.update.core.standaloneUpdate<br>
89 :     &nbsp;&nbsp;&nbsp; -command addSite<br>
90 :     &nbsp;&nbsp;&nbsp; -from <i>local_site_dir</i> <br>
91 :    
92 : dbirsan 1.15 <br><b>Removing a local site:</b><br>
93 :     java -cp startup.jar org.eclipse.core.launcher.Main <br>
94 :     &nbsp;&nbsp;&nbsp; -application&nbsp; org.eclipse.update.core.standaloneUpdate<br>
95 :     &nbsp;&nbsp;&nbsp; -command removeSite<br>
96 :     &nbsp;&nbsp;&nbsp; -to <i>local_site_dir</i> <br>
97 :    
98 : dbirsan 1.1 <br>
99 : dbirsan 1.8 <b>Mirroring feature(s) from a remote site:</b><br>
100 : dbirsan 1.12 java -cp startup.jar org.eclipse.core.launcher.Main <br>
101 : dbirsan 1.9 &nbsp;&nbsp;&nbsp; -application&nbsp; org.eclipse.update.core.standaloneUpdate<br>
102 : dbirsan 1.8 &nbsp;&nbsp;&nbsp; -command mirror<br>
103 :     &nbsp;&nbsp;&nbsp; -from <i>remote_site_url</i> <br>
104 :     &nbsp;&nbsp;&nbsp; -to <i>target_site_dir</i><br>
105 :     &nbsp;&nbsp;&nbsp; [-featureId <i>feature_id</i>]<br>
106 :     &nbsp;&nbsp;&nbsp; [-version <i>version</i>]<br>
107 : dbirsan 1.11 &nbsp;&nbsp;&nbsp; [-mirrorURL <i>mirror_site_url</i>]<br>
108 : dbirsan 1.10 <br>
109 : dbirsan 1.13 If -mirrorURL is specified, an update policy will be generated in
110 :     &lt;target_site_dir&gt;/policy.xml file. The resulting policy.xml
111 :     maps all features from the mirror site to the specified URL.
112 :     The policy.xml can be used as is, or its fragments
113 :     can be included into custom designed policy file.
114 :     <br>
115 : dbirsan 1.1 <br>
116 : dbirsan 1.12 The return code for each command is either 0 (success) or 1 (failure).<br>
117 : dbirsan 1.5 <br>
118 : dbirsan 1.12 Additionally, most <A
119 :     href="http://dev.eclipse.org/help21/topic/org.eclipse.platform.doc.user/tasks/running_eclipse.htm">options
120 :     accepted by Eclipse executable</A> can be passed. They are especially
121 :     useful during debugging and for specifying target environment for installed features.
122 :     For example, passing option
123 :     <code>-ws gtk</code>
124 :     will set windowing system to GTK.<br>
125 : dbirsan 1.1 </body>
126 :     </html>