~ubuntu-branches/ubuntu/precise/eclipse/precise

« back to all changes in this revision

Viewing changes to debian/extra/eclipse.1

  • Committer: Bazaar Package Importer
  • Author(s): Benjamin Drung
  • Date: 2010-01-30 18:55:04 UTC
  • Revision ID: james.westby@ubuntu.com-20100130185504-wrngmv5peoqz77zu
Tags: 3.5.1+repack~3-0ubuntu2
* Rebase to packaging from pkg-java/eclipse (thanks to Niels Thykier):
  + Set a sane file limit for osgi-bundles. (Closes: #558693, LP: #293573)
  + Inject update sites on first run. (LP: #460944)
  + Prevent conflict with swt-gtk's swt packages.
    - Rename our swt packages.
    - Do not install conflicting symlinks/files.
    (Closes: #541638, LP: #491880)
  + Imported patch from Fedora that fixes seg. faults in libpango.
    (LP: #445009)
  + Update manpage. (LP: #494065)
  + Bump Standards-Version to 3.8.4.
* Re-add versioned dependency on libcommons-el-java, libjetty-java,
  libservlet2.4-java; the packages are now available in Ubuntu.
* Drop versioned dependency on liblucene2-java and libmx4j-java; they are not
  yet available in Ubuntu.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH ECLIPSE 1
2
 
.SH NAME
3
 
eclipse \- A kind of universal tool platform.
4
 
.SH SYNOPSIS
5
 
.B eclipse
6
 
.I "[platform options]" "[\-vmargs [Java VM arguments]]"
7
 
.SH "DESCRIPTION"
8
 
.B Eclipse
9
 
is a kind of universal tool platform - an open extensible IDE for anything and nothing in paticular.
10
 
.PP
11
 
This manual page documents briefly 
12
 
.BR Eclipse,
13
 
a kind of universal tool platform.
14
 
This manual page was written for the Debian GNU/Linux distribution
15
 
because the original program does not have a manual page. Most of description are 
16
 
just cut and paste from Eclipse's document.
17
 
 
18
 
.SH PLATFORM OPTIONS
19
 
A summary of platform options are included below. Some of this options can 
20
 
be set by editing ~/.eclipse/eclipserc (but options given on the commandline
21
 
will overwrite them). This is usefull, when you start eclipse via menu entry.
22
 
.TP
23
 
.B \-arch <architecture>
24
 
Defines the processor architecture on which the Eclipse platform is running. 
25
 
The Eclipse platform ordinarily computes the optimal setting using the 
26
 
prevailing value of Java os.arch property. If specified here, this is the 
27
 
value that the Eclipse platform uses. The value specified here is available 
28
 
to plug-ins as BootLoader.getOSArch(). Example values: "x86", "sparc", 
29
 
"PA-RISC", "ppc".
30
 
.TP
31
 
.B \-application <applicationId>
32
 
The application to run. Applications are declared by plug-ins supplying 
33
 
extensions to the org.eclipse.core.runtime.applications extension point. 
34
 
This argument is typically not needed. If specified, the value overrides 
35
 
the value supplied by the configuration. If not specified, the Eclipse 
36
 
Workbench is run.
37
 
.TP
38
 
.B \-clean
39
 
Any cached data used by the OSGi framework and eclipse runtime will be wiped 
40
 
clean. This will clean the caches used to store bundle dependency resolution 
41
 
and eclipse extension registry data. Using this option will force eclipse to 
42
 
reinitialize these caches.
43
 
.TP
44
 
.B \-configuration <configurationFileURL>
45
 
The location for the Eclipse Platform configuration file, expressed as a 
46
 
URL. The configuration file determines the location of the Eclipse platform, 
47
 
the set of available plug-ins, and the primary feature. Note that relative 
48
 
URLs are not allowed. The configuration file is written to this location 
49
 
when the Eclipse platform is installed or updated.
50
 
.TP
51
 
.B \-console [port]
52
 
If set to a non-null value, the OSGi console (if installed) is enabled. If 
53
 
the value is a suitable integer, it is interpreted as the port on which 
54
 
the console listens and directs its output to the given port. Handy for 
55
 
investigating the state of the system.
56
 
.TP
57
 
.B \-consolelog
58
 
Mirrors the Eclipse platform's error log to the console used to run Eclipse. 
59
 
Handy when combined with \-debug.
60
 
.TP
61
 
.B \-data <workspacePath>
62
 
The path of the workspace on which to run the Eclipse platform. The 
63
 
workspace location is also the default location for projects. Relative paths 
64
 
are interpreted relative to the directory that Eclipse was started from.
65
 
.TP
66
 
.B \-debug [optionsFile]
67
 
Puts the platform in debug mode and loads the debug options from the file at 
68
 
the given location, if specified. This file indicates which debug points are 
69
 
available for a plug-in and whether or not they are enabled. If a file 
70
 
location is not given, the platform looks in the directory that eclipse was 
71
 
started from for a file called ".options". Both URLs and file system paths 
72
 
are allowed as file locations.
73
 
.PP
74
 
.B Note:
75
 
On Debian, eclipse expects that the following arguments is a path to a
76
 
option file. You are not allowed to omit this file!
77
 
.TP
78
 
.B \-dev [classpathEntries]
79
 
Puts the platform in development mode. The optional classpath entries (a 
80
 
comma separated list) are added to the runtime classpath of each plug-in. For 
81
 
example, when the workspace contains plug-ins being developed, specifying 
82
 
\-dev bin adds a classpath entry for each plug-in project's directory named
83
 
bin, allowing freshly generated class files to be found there. Redundant or 
84
 
non-existent classpath entries are eliminated.
85
 
.TP
86
 
.B \-endSplash <command> 
87
 
Specifies the command to use to take down the splash screen. Typically 
88
 
supplied by the Eclipse executable.
89
 
.TP
90
 
.B \-feature <feature id>
91
 
The identifier of the product being run. This controls various branding 
92
 
information and what application is used.
93
 
.TP
94
 
.B \-framework <location>
95
 
The URL location of the OSGi framework. Useful if the Eclipse install is 
96
 
disjoint.
97
 
.TP
98
 
.B \-initialize
99
 
Initializes the configuration being run. All runtime related data structures 
100
 
and caches are refreshed. Any user/plug-in defined configuration data is not 
101
 
purged. No application is run, any product specifications are ignored and no 
102
 
UI is presented (e.g., the splash screen is not drawn)
103
 
.TP
104
 
.B \-install <location>
105
 
The install location of the platform. This setting indicates the location of 
106
 
the basic Eclipse plug-ins and is useful if the Eclipse install is disjoint.
107
 
.TP
108
 
.B \-keyring <keyringFilePath>
109
 
The location of the authorization database (or "key ring" file) on disk. This 
110
 
argument must be used in conjunction with the \-password option. Relative
111
 
paths are interpreted relative to the directory that Eclipse was started from.
112
 
.TP
113
 
.B \-name <string> 
114
 
The name to be displayed in task bar item when the application starts up. When 
115
 
not set, the name is the name of the executable.
116
 
.TP
117
 
.B \-nl <locale>
118
 
Defines the name of the locale on which the Eclipse platform is running. The 
119
 
Eclipse platform ordinarily computes the optimal setting automatically. If 
120
 
specified here, this is the value that the Eclipse platform uses. The value 
121
 
specified here is available to plug-ins as BootLoader.getNL(). Example 
122
 
values: "en_US" and "fr_FR_EURO".
123
 
.PP
124
 
You need to install additonal language strings, before that works! Such
125
 
strings are available in the
126
 
.B eclipse-i18n
127
 
package.
128
 
.TP
129
 
.B \-noExit
130
 
The VM will not exit after the eclipse application has ended. This is useful
131
 
for examining the OSGi framework after the eclipse application has ended.
132
 
.TP
133
 
.B \-noLazyRegistryCacheLoading
134
 
The platform's plug-in registry cache loading optimization is deactivated. 
135
 
By default, configuration elements are loaded from the registry cache 
136
 
(when available) only on demand, reducing memory footprint. This option 
137
 
forces the registry cache to be fully loaded at startup.
138
 
.TP
139
 
.B \-noRegistryCache
140
 
The internal extension registry cache is neither read or written
141
 
.TP
142
 
.B \-nosplash
143
 
Runs the platform without putting up the splash screen.
144
 
.TP
145
 
.B \-os <operatingSystem>
146
 
Defines the operating system on which the Eclipse platform is running. The 
147
 
Eclipse platform ordinarily computes the optimal setting using the 
148
 
prevailing value of Java os.name property. If specified here, this is the 
149
 
value that the Eclipse platform uses. The value specified here is available 
150
 
to plug-ins as BootLoader.getOS(), and used to resolve occurrences of the 
151
 
$os$ variable in paths mentioned in the plug-in manifest file. Example 
152
 
values: "win32", "linux", "hpux", "solaris", "aix".
153
 
.TP
154
 
.B \-password <password>
155
 
The password for the authorization database. Used in conjunction with the 
156
 
\-keyring option.
157
 
.TP
158
 
.B \-perspective <perspectiveId>
159
 
The perspective to open in the active workbench window on startup. If this 
160
 
parameter is not specified, the perspective that was active on shutdown will 
161
 
be opened.
162
 
.TP
163
 
.B \-plugincustomization <propertiesFile>
164
 
The location of a properties file containing default settings for plug-in 
165
 
preferences. These default settings override default settings specified in 
166
 
the primary feature. Relative paths are interpreted relative to the directory 
167
 
that eclipse was started from.
168
 
.TP
169
 
.B \-product <productId>
170
 
The ID of the product to run. The product gives the launched instance of 
171
 
Eclipse its personality, and determines the product customization information 
172
 
used. This replaces \-feature, which is still supported for compatibility.
173
 
.TP
174
 
.B \-refresh
175
 
Option for performing a global refresh of the workspace on startup. This will 
176
 
reconcile any changes that were made in the file system since the platform 
177
 
was last run.
178
 
.TP
179
 
.B \-showlocation
180
 
Option for displaying the location of the workspace in the window title bar. 
181
 
In release 2.0 this option only worked in conjunction with the \-data command
182
 
line argument.
183
 
.TP
184
 
.B \-showSplash <command>
185
 
Specifies the command to use to show the splash screen. Typically supplied
186
 
by the Eclipse executable.
187
 
.TP
188
 
.B \-startup <location> 
189
 
The location of jar used to startup eclipse. The jar referred to must have 
190
 
the Main-Class attribute set. If this parameter is not set, the startup.jar 
191
 
located in the same folder than the executable is used.
192
 
.TP
193
 
.B \-user <location> 
194
 
The location of the user area. The user area contains data (e.g., preferences) 
195
 
specific to the OS user and independent of any Eclipse install, configuration 
196
 
or instance. 
197
 
.TP
198
 
.B \-vm <vmPath>
199
 
The location of Java Runtime executable to use to run the Eclipse platform.
200
 
Relative paths are interpreted relative to the directory that eclipse was
201
 
started from.
202
 
.TP
203
 
.B \-vmargs <args>
204
 
When passed to the Eclipse, this option is used to customize the operation of 
205
 
the Java VM used to run Eclipse. If specified, this option must come at the 
206
 
end of the command line. The given arguments are dependant on VM that is 
207
 
being run.
208
 
.TP
209
 
.B \-ws <window system>
210
 
The window system value. The value should be one of the Eclipse window system 
211
 
names known to Eclipse (e.g., win32, motif, ...).
212
 
.SH NOTES
213
 
Eclipse will search for a java virtual machine in this order: VM given with
214
 
the "\-vm <JVM>" argument, $JAVA_HOME/bin/java from $HOME/.eclipse/eclipserc 
215
 
and then in the environment and at last use /usr/bin/java.
216
 
.SH SEE ALSO
217
 
java(1)
218
 
.SH FILES
219
 
Configuration file is $HOME/.eclipse/eclipserc, error log in
220
 
<workspace>/.metadata/.log, where <workspace> is the path to your workspace.
221
 
.SH BUGS
222
 
Eclipse has a bugzilla, which can be found at bugs.eclipse.org.
223
 
.SH AUTHOR
224
 
This manual page was written by Takashi Okamoto <tora@debian.org>,
225
 
for the Debian GNU/Linux system (but may be used by others). It was updated
226
 
by Jan Schulz <debian@katzien.de> and Stephan Michels <stephan@apache.org>.