'\" -*- coding: us-ascii -*-
.if \n(.g .ds T< \\FC
.if \n(.g .ds T> \\F[\n[.fam]]
.de URL
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
.TH eclipse 1 "21 February 2018" "" ""
.SH NAME
eclipse \- extensible tool platform and Java IDE
.SH SYNOPSIS
'nh
.fi
.ad l
\fBeclipse\fR \kx
.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
'in \n(.iu+\nxu
[ \fIplatform\fR \fIoptions\fR ] [ \fB-vmargs \fR[ \fIJava\fR \fIVM\fR \fIarguments\fR ]]
'in \n(.iu-\nxu
.ad b
'hy
.SH DESCRIPTION
The \fBEclipse\fR Platform is an open and
extensible platform for anything and yet nothing in particular. It provides a
foundation for constructing and running integrated software-development tools.
The \fBEclipse\fR Platform allows tool builders
to independently develop tools that integrate with other people's tools so
seamlessly you can't tell where one tool ends and another starts.
.PP
When invoked without selecting any particular application, the \fBeclipse\fR
command will start the \fBEclipse\fR Platform with the Java Development
Tools (JDT) functionality enabled and ready to use.
.PP
This manual page documents the command-line arguments for the
\fBEclipse\fR Platform and it is based on the
Runtime Options help item in the \fBEclipse\fR
.URL #authors "online help"
\&.
.SH "PLATFORM OPTIONS"
Listed below are the command line arguments processed by various parts of the
\fBEclipse\fR runtime.
Many of these values can also be specified using System properties either on the command line
using \fB-D VM\fR arguments, by specifying their values in a \*(T<\fIconfig.ini\fR\*(T> file or by using a
\*(T<\fI<launcher>.ini\fR\*(T> file. Using the two latter techniques it is possible to customize
\fBEclipse\fR without using command line arguments at all.
.PP
For each argument in the list, its corresponding System property key is given (in {}). Also
given is the \fBEclipse\fR runtime layer in which the
command line argument is processed (in ()). 
.TP 
\*(T<\fB\-application <id> (Runtime) \fR\*(T>
The identifier of the application to run. The value given here
overrides any application defined by the product being run.

This is equivalent to setting the property
\fIeclipse.application\fR to
<id>.
.TP 
\*(T<\fB\-arch <architecture> (OSGi) \fR\*(T>
The processor architecture value.

This is equivalent to setting the property \fIosgi.arch\fR to
<architecture>.
.TP 
\*(T<\fB\-clean (OSGi) \fR\*(T>
Wipe clean any cached data used by the OSGi
framework and \fBeclipse\fR runtime. This will clean
the caches used to store bundle dependency resolution and \fBeclipse\fR
extension registry data. Using this option will force \fBeclipse\fR to
reinitialize these caches.

This is equivalent to setting the property \fIosgi.clean\fR to
"true".
.TP 
\*(T<\fB\-configuration <location> (Main) \fR\*(T>
The configuration location for this run of the platform. The
configuration determines what plug-ins will run as well as various
other system settings. See the On-line Help for details (SEE ALSO below).

This is equivalent to setting the property \fIosgi.configuration.area\fR
to <location>.
.TP 
\*(T<\fB\-console [port] (OSGi) \fR\*(T>
Enable the OSGi console (if installed). If the [port] value is a suitable integer, it is interpreted as
the port on which the console listens and directs its output to the
given port. Handy for investigating the state of the system.

This is equivalent to setting the property \fIosgi.console\fR to [port] or the
empty string if the default port is to be used (i.e., when the port is not specified).
.TP 
\*(T<\fB\-consoleLog (Runtime) \fR\*(T>
Any log output is also sent to Java's
System.out (typically back to the command shell if any). Handy when
combined with \fB-debug\fR.

This is equivalent to setting the property \fIeclipse.consoleLog\fR to
"true".
.TP 
\*(T<\fB\-data <location> (OSGi)\fR\*(T>\*(T<\fB\fR\*(T>\*(T<\fB \fR\*(T>
The instance data location for this session. Plug-ins use this
location to store their data. For example, the Resources plug-in
uses this as the default location for projects (aka the workspace).
See the On-line Help for details (SEE ALSO below).

This is equivalent to setting the property \fIosgi.instance.area\fR to
<location>.
.TP 
\*(T<\fB\-debug [options file] (OSGi) \fR\*(T>
Put the platform in debug mode. If [options file] is given, it is interpreted as the location of the
\*(T<\fI\&.options\fR\*(T> file. This file indicates what debug points are available
for a plug-in and whether or not they are enabled. If a location is
not specified, the platform searches for the\*(T<\fI .options\fR\*(T> file under
the install directory.

This is equivalent to setting the property \fIosgi.debug\fR to
[options file] or the empty string to simply enable debug (i.e., if
the options file location is not specified).
.TP 
\*(T<\fB\-dev [entries] (OSGi) \fR\*(T>
Turn on dev mode. If given, [entries] should be a comma-separated class path entries
which are added to the class path of each plug-in or a URL to a
Java properties file containing custom classpath additions for a
set of plug-ins. For each plug-in requiring a customized dev time
classpath the file will contain an entry of the
form.

This is equivalent to setting the property \fIosgi.dev\fR to
[entries] or the empty string to simply enable dev mode (i.e., if
entries are not specified).
.TP 
\*(T<\fB\-eclipse.keyring <file path> (Equinox) \fR\*(T>
Set to override location of the default secure storage.
.TP 
\*(T<\fB\-eclipse.password <file path> (Equinox) \fR\*(T>
If specified, the secure storage treats contents of the file as a
default password. When not set, password providers are used to
obtain a password.
.TP 
\*(T<\fB\-feature <feature id> (Runtime) \fR\*(T>
Set the identifier of the product being run. This controls various
branding information and what application is used.

This is equivalent to setting the property \fIeclipse.product\fR to <feature
id>.
.TP 
\*(T<\fB\-framework <location> (Main) \fR\*(T>
Set the URL location of the OSGi framework. Useful if the \fBEclipse\fR
install is disjoint. See the On-line Help for details (SEE ALSO below).

This is equivalent to setting the property \fIosgi.framework\fR to
<location>.
.TP 
\*(T<\fB\-initialize (Main) \fR\*(T>
Initializes the configuration being run. All runtime related data
structures and caches are refreshed. Any user/plug-in defined
configuration data is not purged. No application is run, any
product specifications are ignored and no UI is presented (e.g.,
the splash screen is not drawn).
.TP 
\*(T<\fB\-install <location> (Main) \fR\*(T>
Set the install location of the platform. This option indicates the
location of the basic \fBEclipse\fR plug-ins and is useful if the \fBEclipse\fR
install is disjoint.

This is equivalent to setting the property \fIosgi.install.area\fR to
<location>.
.TP 
\*(T<\fB\-keyring <location> (Runtime) \fR\*(T>
The location of the authorization database on disk. This argument
has to be used together with the \fB-password\fR argument.
.TP 
\*(T<\fB\-\-launcher.library <location> (Executable) \fR\*(T>
The location of the \fBeclipse\fR executable's companion shared
library. If not specified the executable looks in the plugins
directory for the appropriate
\fIorg.eclipse.equinox.launcher.[platform] fragment\fR with the highest
version and uses the shared library named \*(T<\fIeclipse_*\fR\*(T> inside.
.TP 
\*(T<\fB\-\-launcher.ini <location> (Executable) \fR\*(T>
The location of the product .ini file to use. If not
specified the executable will look for a file beside the launcher
with the same name and the extension \*(T<\fI.ini\fR\*(T>. (ie., \*(T<\fI/usr/bin/eclipse\fR\*(T>
looks for \*(T<\fIeclipse.ini\fR\*(T>, \*(T<\fI/opt/product\fR\*(T> looks for
\*(T<\fIproduct.ini\fR\*(T>).
.TP 
\*(T<\fB\-\-launcher.suppressErrors (Executable) \fR\*(T>
If specified the executable will not display any error or message
dialogs. This is useful if the executable is being used in an
unattended situation.
.TP 
\*(T<\fB\-\-launcher.XXMaxPermSize <value> (Executable) \fR\*(T>
If specified, and the executable detects that the VM being used is
a Sun VM, then the launcher will automatically add the
\*(T<\fB\-XX:MaxPermSize=<value>\fR\*(T> vm argument. The executable is
not capable of detecting Sun VMs on all
platforms.
.TP 
\*(T<\fB\-name <string> \fR\*(T>
The name to be displayed in task bar item when the application
starts up. When not set, the name is the name of the executable.
.TP 
\*(T<\fB\-nl <locale> (OSGi) \fR\*(T>
The name of the locale on which \fBEclipse\fR platform will run. NL
values should follow the standard Java locale naming conventions.

This is equivalent to setting the property
\fIosgi.nl\fR to
<locale>.
.TP 
\*(T<\fB\-noExit (OSGi) \fR\*(T>
Disable automatic termination of the VM after the \fBeclipse\fR
application has ended. This is useful for examining the OSGi
framework after the \fBeclipse\fR application has ended.

This is equivalent to setting the property
\fIosgi.noShutdown\fR to
"true".
.TP 
\*(T<\fB\-noLazyRegistryCacheLoading (Runtime) \fR\*(T>
Deactivate the platform's plug-in registry cache loading
optimization. By default, configuration elements are
loaded from the registry cache (when available) only on demand,
reducing memory footprint. This option forces the registry cache to
be fully loaded at startup.

This is equivalent to setting the property
\fIeclipse.noLazyRegistryCacheLoading\fR
to "true".
.TP 
\*(T<\fB\-noRegistryCache (Runtime) \fR\*(T>
The internal extension registry cache will
neither be read nor written.

This is equivalent to setting the property
\fIeclipse.noRegistryCache\fR
to "true".
.TP 
\*(T<\fB\-noSplash (Executable, Main) \fR\*(T>
Controls whether or not the splash screen is shown.
.TP 
\*(T<\fB\-os <operating system> (OSGi) \fR\*(T>
The operating system value. The value should be one of the \fBEclipse\fR
processor architecture names known to \fBEclipse\fR (e.g., x86, sparc,
\&...).

This is equivalent to setting the property
\fIosgi.os\fR to
<operating system>.
.TP 
\*(T<\fB\-password <password> (Runtime) \fR\*(T>
The password for the authorization database.
.TP 
\*(T<\fB\-pluginCustomization <location> (Runtime) \fR\*(T>
The file system location of a properties file containing default
settings for plug-in preferences. These default settings override
default settings specified in the primary feature. Relative paths
are interpreted relative to the current working directory for
\fBeclipse\fR itself.

This is equivalent to setting the property
\fIeclipse.pluginCustomization\fR
to <location>
.TP 
\*(T<\fB\-product <id> (OSGi) \fR\*(T>
The identifier of the product being run. This controls various
branding information and what application is used.

This is equivalent to setting the property
\fIeclipse.product\fR to <id>.
.TP 
\*(T<\fB\-showSplash <bitmap> (Executable, Main) \fR\*(T>
Specifies the bitmap to use in the splash screen. If specified, the
launcher may be able to show the splash screen before starting the
Java VM. If not specified, Main will find the bitmap using
the \fIosgi.splashLocation\fR and \fIosgi.splashPath\fR
properties.
.TP 
\*(T<\fB\-startup <location> (Executable) \fR\*(T>
The location of jar used to startup \fBeclipse\fR. The jar referred to
should have the \fIMain-Class\fR attribute set to
\fIorg.eclipse.equinox.launcher.Main\fR. If this parameter is not set,
the executable will look in the plugins directory for
the \fIorg.eclipse.equinox.launcher bundle\fR with the highest
version.
.TP 
\*(T<\fB\-user <location> (OSGi) \fR\*(T>
Set the location of the user area. The user area contains data (e.g.,
preferences) specific to the OS user and independent of any \fBEclipse\fR
install, configuration or instance. See the On-line Help for details (SEE ALSO below).

This is equivalent to setting the property
\fIosgi.user.area\fR to
<location>.
.TP 
\*(T<\fB\-vm <path to java vm> (Executable, Main) \fR\*(T>
When passed to the \fBEclipse\fR executable, this option is used to
locate the Java VM to use to run \fBEclipse\fR. It should be the full
file system path to an appropriate: Java\*(T<\fI jre/bin\fR\*(T> directory, Java
Executable, Java shared library (\*(T<\fIlibjvm.so\fR\*(T>), or a Java
VM Execution Environment description file. If not specified,
the \fBEclipse\fR executable uses a search algorithm to locate a suitable
VM. In any event, the executable then passes the path to the actual
VM used to Java Main using the \fB-vm\fR argument. Java Main then stores
this value in \fIeclipse.vm\fR.
.TP 
\*(T<\fB\-vmargs [vmargs*] (Executable, Main) \fR\*(T>
when passed to the \fBEclipse\fR, this option is used to customize the
operation of the Java VM to use to run \fBEclipse\fR. If specified, this
option must come at the end of the command line. Even if not
specified on the executable command line, the executable will
automatically add the relevant arguments (including the class being
launched) to the command line passed into Java using the \fB-vmargs\fR
argument. Java Main then stores this value in
\fIeclipse.vmargs\fR.
.TP 
\*(T<\fB\-ws <window system> (OSGi) \fR\*(T>
Set the window system value. The value should be one of the \fBEclipse\fR
window system names known to \fBEclipse\fR (e.g., win32, motif, ...).

This is equivalent to setting the property
\fIosgi.ws\fR to
<window system>.
.SH "SEE ALSO"
\fBjava\fR(1),
\fBecj\fR(1).
.PP
\fBEclipse\fR On-line Help \(lahttp://help.eclipse.org/\(ra
Platform Plug-in Developer Guide > Reference > Other reference information >
Runtime Options.
.SH FILES
The system wide config.ini file is \*(T<\fI/etc/eclipse.ini\fR\*(T>. User level Configuration file is
\*(T<\fI$HOME/.eclipse/org.eclipse.platform_<version>_<id>/configuration/config.ini\fR\*(T>.
.SH AUTHORS
The \fBEclipse\fR Project was originally created by IBM in November 2001 and
supported by a consortium of software vendors. The \fBEclipse\fR Foundation was
created in January 2004 as an independent not-for-profit corporation to act as the steward of the
\fBEclipse\fR community.
.PP
This manual page was semi-automatically transformed from the
Runtime Options HTML help using \fBpandoc\fR and
\fBdocbook2x-man\fR by Pablo Duboue <pablo.duboue@gmail.com>.