Eclipse ランタイム・オプション
最終変更日時 2004 年 8 月 4 日 (水) 14:45
Eclipse プラットフォームは、高度に構成可能です。構成の入力は、コマンド行引き数とシステム・プロパティー設定の書式を取ります。多くの場合、コマンド行引き数は、関連したシステム・プロパティーを設定するためのショートカットです。
実際、コマンド行引き数よりも多くのシステム・プロパティー設定があります。
コマンド行引き数
以下に、Eclipse ランタイムのさまざまな部分で処理されるコマンド行引き数をリストします。
また、以下の値の多くは、-D VM 引き数を使用してコマンド行でシステム・プロパティーを指定するか、または config.ini ファイルに値を指定してシステム・プロパティーを指定することもできます。
後者の手法を使用すると、コマンド行引き数を使用せずに Eclipse をカスタマイズすることができます。
リスト内の各引き数ごとに、対応するシステム・プロパティー・キーが示されています ({} 内)。
また、コマンド行引き数が処理される Eclipse ランタイム・レイヤーも示されています (() 内)。
これは、特殊なニーズを満たすようランタイムのパーツを置き換える場合に役立ちます。
- -application <id> (Runtime)
- eclipse.application を <id> に設定した場合と同等
- -arch <architecture> (OSGi)
- osgi.arch を <architecture> に設定した場合と同等
- -clean (OSGi) 新機能
- osgi.clean を "true" に設定した場合と同等
- -configuration <location> (Main)
- osgi.configuration.area
を <location> に設定した場合と同等
- -console [port] (OSGi) 新機能
- osgi.console を [port] に設定するか、またはデフォルト・ポートが使用される場合 (つまり、ポートが指定されていない場合) は空ストリングを設定した場合と同等
- -consoleLog (Runtime)
- eclispe.consoleLog を "true" に設定した場合と同等
- -data <location> (OSGi)
- osgi.instance.area
を <location> に設定した場合と同等
- -debug [options file] (OSGi)
- osgi.debug を [options file] に設定するか、またはデバッグのみを使用可能にするために空ストリングを設定した場合 (つまり、オプション・ファイルのロケーションが指定されていない場合) と同等
- -dev [entries] (OSGi)
- osgi.dev を [entries] に設定するか、または空ストリングを設定して DEV モードのみを使用可能にする場合 (つまり、エントリーが指定されていない場合) と同等
- -endSplash <command> (Main)
- スプラッシュ画面を停止する場合に使用するコマンドを指定します。
通常、Eclipse 実行可能ファイルで指定されます。
- -feature <feature id> (Runtime)
- eclipse.product を <feature id> に設定した場合と同等
- -framework <location> (Main) 新機能
- osgi.framework を <location> に設定した場合と同等
- -initialize (Main)
- 実行する構成を初期化します。データ構造およびキャッシュに関連するすべてのランタイムが最新表示されます。
構成データが定義されているユーザー/プラグインは、パージされません。
アプリケーションは実行されず、製品仕様は無視され、UI は表示されません (例えば、スプラッシュ画面が描画されません)。
- -install <location> (Main)
- osgi.install.area
を <location> に設定した場合と同等
- -keyring <location> (Runtime)
- ディスク上の許可データベースのロケーション。
この引き数は、-password 引き数と共に使用する必要があります。
- -nl <locale> (OSGi)
- osgi.nl を<locale> に設定した場合と同等
- -noLazyRegistryCacheLoading (Runtime)
- eclipse.noLazyRegistryCacheLoading を"true" に設定した場合と同等
- -noRegistryCache
(Runtime)
- eclipse.noRegistryCache を "true" に設定した場合と同等
- -noSplash (Executable, Main)
- スプラッシュ画面を表示するかどうかを制御します。
- -os <operating system> (OSGi)
- osgi.os を <operating system> に設定した場合と同等
- -password <password> (Runtime)
- 許可データベースのパスワード
-
- -pluginCustomization <location> (Runtime)
- eclipse.pluginCustomization を <location> に設定した場合と同等
- -product <id> (OSGi) 新機能
- eclipse.product を <id> に設定した場合と同等
- -showSplash <command> (Main)
- スプラッシュ画面を表示する場合に使用するコマンドを指定します。
通常、Eclipse 実行可能ファイルで指定されます。
- -user <location> (OSGi) 新機能
- osgi.user.area
を <location> に設定した場合と同等
- -vm <path to java executable> (Executable, Main) 新機能
- Eclipse 実行可能ファイルに渡されると、このオプションは、Eclipse を実行するために使用する Java VM を検索する場合に使用されます。
適切な Java 実行可能ファイルのファイル・システムの絶対パスである必要があります。このオプションを指定しない場合、Eclipse 実行可能ファイルは、検索アルゴリズムを使用して、適切な VM を検索します。
いずれの場合も、実行可能ファイルは、-vm 引き数を使用して、Java Main に対して使用される実際の VM のパスを渡します。Java
Main は、この値を eclipse.vm に保管します。
- -vmargs [vmargs*] (Executable,
Main) 新機能
- Eclipse に渡されると、このオプションは、Eclipse を実行するために使用する Java VM の操作をカスタマイズする場合に使用されます。
このオプションは、指定されると、コマンド行の最後に表示されます。
このオプションが実行可能コマンド行に指定されていない場合でも、実行可能ファイルは、-vmargs 引き数を使用して Java に渡されるコマンド行に関連引き数 (起動されるクラスを含む) を自動的に追加します。
Java
Main は、この値を eclipse.vmargs に保管します。
- -ws <window system> (OSGi)
- osgi.ws を <window system> に設定した場合と同等
廃止されたコマンド行引き数
以下のコマンド行引き数は、すでに関係がないか、または置き換えられており、ランタイムで消費されて、後方互換性を維持するために実行されているアプリケーションには渡されません。
- -boot
- 『-configuration』を参照
- -classLoaderProperties
- 現在は関係なし
- -firstUse
- 現在は関係なし
- -newUpdates
- 現在は関係なし
- -noPackagePrefixes
- 現在は関係なし
- -noUpdate
- 現在は関係なし
- -plugins
- 現在は関係なし
- -update
- 現在は関係なし
その他
以下のコマンド行引き数は、さまざまな Eclipse プラグインによって定義され、定義するプラグインがインストール、解決、および活動化されている場合にのみサポートされます。
- -noVersionCheck (workbench)
- <description>
- -perspective (workbench)
- <description>
- -refresh (org.eclipse.core.resources)
- <description>
- -showLocation (org.eclipse.ui.ide.workbench)
- <description>
- -allowDeadlock
- <description>
システム・プロパティー
以下のシステム・プロパティーが、Eclipse ランタイムで使用されます。
「osgi」で始まるプロパティーは、OSGi フレームワーク実装に固有で、「eclipse」で始まるプロパティーは、OSGi フレームワークの一番上に階層化されている Eclipse ランタイムに固有のものです。
以下のプロパティーの多くには、同等のコマンド行があります (『コマンド行引き数』セクションで中括弧 {} 内の値を参照)。ユーザーは、コマンド行またはプロパティー設定を自由に使用して、値を指定できます。プロパティーは、以下のように設定されます。
- -DpropName=propValue を Java VM に対する VM 引き数として使用する
- 適切な構成領域で config.ini ファイルに必要なプロパティーを設定する
- eclipse.application {-application}
- 実行するアプリケーションの ID。
ここに指定された値は、実行中の製品で定義されているアプリケーションを
オーバーライドします (『eclipse.product』を参照)。
- eclipse.commands
- sdf
- eclipse.consoleLog
- 「true」の場合は、Java の System.out にログ出力も送信されます (通常、ある場合はコマンド・シェルに戻ります)。-debug と組み合わせた場合に便利です。
- eclipse.debug.startupTime
- このセッションの Java VM が開始された時間 (ミリ秒)
- eclipse.exitcode
- <description>
- eclipse.exitdata
- <description>
- eclipse.manifestConverter
- 既存の plugin.xml ファイルを manifest.mf ファイルに変換するときに使用するマニフェスト・コンバーター・クラスのクラス名
- eclipse.noExtensionMunging
- 「true」の場合、既存のレジストリー拡張は現状のままとなります。
デフォルトでは、このような拡張は、Eclipse 3.0 で検出された新規拡張ポイント ID を使用するよう更新されます。
- eclipse.noLazyRegistryCacheLoading {-noLazyRegistryCacheLoading}
- 「true」の場合、最適化をロードするプラットフォームのプラグイン・レジストリー・キャッシュが、非活動化されます。デフォルトでは、要求された場合のみ、構成エレメントがレジストリー・キャッシュから
ロードされ (使用可能な場合)、メモリー・フットプリントが減らされます。
このオプションにより、レジストリー・キャッシュの完全なロードが始動時に強制的に行われます。
- eclipse.noRegistryCache {-noRegistryCache}
- 「true」の場合、内部拡張レジストリー・キャッシュは、読み取りおよび書き込みができません。
- eclipse.pluginCustomization {-pluginCustomization}
- プラグイン設定のためのデフォルト設定が入っている、プロパティー・ファイルのファイル・システム・ロケーション。
これらのデフォルト設定は、1 次フィーチャーに指定されたデフォルト設定をオーバーライドします。
相対パスは、Eclipse 自体の現行作業ディレクトリーに対する相対位置として解釈されます。
- eclipse.product {-product}
- 実行する製品の ID。
これにより、さまざまなブランド情報および使用されるアプリケーションが制御されます。
- eclipse.vm {-vm}
- Eclipse を実行するときに使用される Java 実行可能ファイルのパス。
この情報は、再起動コマンド行を構成するのに使用されます。
- eclipse.vmargs {-vmargs}
- Eclipse を実行するときに使用される VM 引き数をリストします。
この情報は、再起動コマンド行を構成するのに使用されます。
- osgi.adaptor
- 使用する OSGi フレームワーク・アダプターのクラス名。
- osgi.arch {-arch}
- 『-arch』を参照
- osgi.baseConfiguration.area
- asf
- osgi.bundles
- システムが起動し、実行されると、自動的にインストールされ、開始 (オプション) されるバンドルのコンマで区切られたリスト。各エントリーの書式は、以下のようになります。
<URL | simple bundle location>[@ [<start-level>] [":start"]]
開始レベル (>0 の整数) が省略された場合、フレームワークは、バンドルのデフォルトの開始レベルを使用します。
"start" タグが追加されている場合、バンドルは、インストール後に開始済みとしてマークされます。
単純なバンドル・ロケーションは、フレームワークの親ディレクトリーに関連していると解釈されます。
開始レベルは、バンドルが実行される必要がある OSGi 開始レベルを示しています。
この値が設定されていない場合は、システムが適切なデフォルトを計算します。
- osgi.clean
- 「true」に設定すると、OSGi フレームワークおよび Eclipse ランタイムのキャッシュ・データは削除されます。 これにより、ストアにバンドルする依存関係の解決と Eclipse 拡張レジストリー・データに使用されたキャッシュが削除されます。 このオプションにより Eclipse はこれらのキャッシュを強制的に再初期化します。
- osgi.configuration.cascaded
- 「true」に設定すると、この構成は、親構成にカスケードされます。詳しくは、『ロケーション』を参照してください。
- osgi.configuration.area {-configuration}
- このプラットフォームの実行の構成ロケーション。
この構成により、実行するプラグインおよびその他システム設定が決定されます。
詳しくは、『ロケーション』を参照してください。
- osgi.configuration.area.default
- このプラットフォームの実行のデフォルト構成ロケーション。
この構成により、実行するプラグインおよびその他システム設定が決定されます。
この値 (デフォルト設定) は、osgi.configuration.area の値が設定されていない場合にのみ使用されます。
詳しくは、『ロケーション』を参照してください。
- osgi.console {-console}
- ヌル以外の値を設定すると、OSGi コンソール (インストールされている場合) が使用可能になります。
値が適切な整数の場合は、コンソールが listen し、指定されたポートに出力を送信するポートと解釈されます。
システムの状態を確認する場合に役立ちます。
- osgi.console.class
- 必要に応じて実行するコンソールのクラス名
- osgi.debug {-debug}
- ヌル以外の値を設定すると、プラットフォームがデバッグ・モードになります。
値がストリングの場合は、.options ファイルのロケーションと解釈されます。
このファイルは、プラグイン用としてどのデバッグ・ポイントを選択できるか、およびそれらのデバッグ・ポイントが使用可能になっているかどうかを示します。
ロケーションが指定されていない場合、プラットフォームは、インストール・ディレクトリーで .options ファイルを検索します。
- osgi.dev {-dev}
- 空ストリングを設定すると、DEV モードがオンになります。
このプロパティーは、各プラグインのクラスパス、または一連のプラグインのカスタム・クラスパスの追加を含む Java プロパティー・ファイルの URL に追加される、コンマで区切られたクラスパス・エントリーに設定することもできます。
カスタマイズされた DEV 時のクラスパスを必要とする各プラグインについて、ファイルには、以下の書式のエントリーが含まれます。
<plug-in id>=<comma separated list of classpath entries to add>
ここで、プラグイン ID "*" は、特に指定がない限り、すべてのプラグインと一致します。
- osgi.framework
- OSGi フレームワークの URL ロケーション。Eclipse インストールが非結合の場合に役立ちます。詳しくは、『ロケーション』を参照してください。
- osgi.frameworkClassPath
- OSGi フレームワーク実装のクラスパス・エントリーのコンマで区切られたリスト。
関連ロケーションは、フレームワーク・ロケーションに関連していると解釈されます (『osgi.framework』を参照)。
- osgi.install.area {-install}
- プラットフォームのインストール・ロケーション。この設定は、基本 Eclipse プラグインのロケーションを示し、Eclipse インストールが非結合の場合に役立ちます。
詳しくは、『ロケーション』を参照してください。
- osgi.instance.area {-data}
- このセッションのインスタンス・データ・ロケーション。プラグインはこのロケーションを使用して、データを保管します。
例えば、リソース・プラグインは、プロジェクトのデフォルト・ロケーションとしてこのロケーションを使用します (ワークスペースとも言います)。詳しくは、『ロケーション』を参照してください。
- osgi.instance.area.default
- このセッションのデフォルト・インスタンス・データ・ロケーション。プラグインはこのロケーションを使用して、データを保管します。
例えば、リソース・プラグインは、プロジェクトのデフォルト・ロケーションとしてこのロケーションを使用します (ワークスペースとも言います)。この値 (デフォルト設定) は、osgi.instance.area の値が設定されていない場合にのみ使用されます。
詳しくは、『ロケーション』を参照してください。
- osgi.manifest.cache
- 生成されるマニフェストが発見され、生成されるロケーション。
デフォルトは、構成領域内ですが、マニフェスト・キャッシュは別の場所に保管することができます。
- osgi.nl {-nl}
- Eclipse プラットフォームが稼働しているロケールの名前。
NL 値は、標準 Java ロケール命名規則に従う必要があります。
- osgi.os {-os}
- オペレーティング・システム値。この値は、Eclipse で認識されるいずれかの Eclipse プロセッサーのアーキテクチャー名である必要があります (x86、sparc など)。
- osgi.splashLocation
- Eclipse の開始時に表示されるスプラッシュ画面 (.bmp ファイル) の絶対 URL ロケーション。
このプロパティーは、osgi.splashPath に設定された値をオーバーライドします。
- osgi.splashPath
- ファイル splash.bmp を検索する URL のコンマで区切られたリスト。
このプロパティーは、osgi.splashLocation に設定された値でオーバーライドされます。
- osgi.user.area {-user}
- ユーザー域のロケーション。ユーザー域には、OS に固有で、かつ Eclipse インストール、構成、
またはインスタンスに依存しないデータ (設定など) が含まれます。詳しくは、『ロケーション』を参照してください。
- osgi.user.area.default
- ユーザー域のデフォルト・ロケーション。ユーザー域には、OS に固有で、かつ Eclipse インストール、構成、
またはインスタンスに依存しないデータ (設定など) が含まれます。この値 (デフォルト設定) は、osgi.user.area の値が設定されていない場合にのみ使用されます。
詳しくは、『ロケーション』を参照してください。
- osgi.ws {-ws}
- ウィンドウ・システム値。この値は、Eclipse で認識されるいずれかの Eclipse ウィンドウ・システム名である必要があります (win32、motif など)。.
- osgi.syspath
- <xxx をまだ使用しますか?名前を修正してください。>
ロケーション
Eclipse ランタイムは、プラグイン開発者コンテキストがデータの読み取り/保管をし、Eclipse ユーザーがデータ共用および可視性を制御するロケーション を複数定義します。Eclipse は、ロケーションの以下の概念を定義します。
- User (-user) {osgi.user.area} [@none, @noDefault, @user.home, @user.dir,
filepath, url]
- ユーザー・ロケーションは、ユーザーに固有のものです。通常、ユーザー・ロケーションは、Java
user.home
システム・プロパティーの値に基づいていますが、オーバーライドすることができます。ユーザー・スコープ済み設定やログイン情報などの情報は、ユーザー・ロケーションにあります。
- Install (-install) {osgi.install.area} [@user.home, @user.dir, filepath,
url]
- インストール・ロケーションとは、Eclipse 自体がインストールされているロケーションのことです。
実際には、このロケーションは、実行される startup.jar または eclipse.exe の親であるディレクトリー (通常は「eclipse」) です。インストールが多くのユーザーで共有されるため、このロケーションは、通常のユーザーには読み取り専用と見なされます。インストール・ロケーションを設定し、Eclipse から startup.jar を切り離すことができます。
- Configuration (-configuration) {osgi.configuration.area} [@none, @noDefault,
@user.home, @user.dir, filepath, url]
- 構成ロケーションには、実行するインストールの (サブ) セットを識別し、管理するファイルが含まれます。このため、インストールごとに数多くの構成がある場合があります。
インストールにはデフォルト 構成領域がありますが、通常の始動シナリオでは、ランタイムが、より書き込み可能な構成ロケーションを検索します。
- Instance (-data) {osgi.instance.area} [@none, @noDefault, @user.home,
@user.dir, filepath, url]
- インスタンス・ロケーションには、ユーザー定義データ成果物が含まれます。
例えば、リソース・プラグインは、インスタンス領域をワークスペース・ロケーション (プロジェクトのデフォルト・ホーム) として使用します。その他のプラグインは、このロケーション内のどのファイルにも自由に書き込むことができます。
ユーザーは、これらのロケーションを設定できますが、値が指定されていない場合は Eclipse が適切なデフォルトを計算します。
ロケーションを設定する最も一般的なユース・ケースは、インスタンス領域、または IDE コンテキストではワークスペースです。特定のデータ・セットでデフォルトの Eclipse 構成を実行するには、以下を指定します。
eclipse -data c:\mydata
詳細
ロケーションは、URL です。簡単にするために、ファイル・パスも受け入れられ、自動的にファイル (URL) に変換されます。
制御をより良くするために、便宜上、数多くの事前定義済みシンボリック・ロケーションも使用できます。ロケーション・タイプとシンボリック値のすべての組み合わせが有効というわけではありません。
以下の表は、可能な組み合わせの詳細を示しています。
デフォルトのケースは、設定されるすべてのロケーションに対して有効および書き込み可能であるため、一部のプラグインは、可能としてリストされているその他のセットアップでも失敗することがあります。例えば、インスタンス領域が定義されていない場合にユーザー・データにフォーカスしているプラグイン (Eclipse リソース・プラグインなど) が多くの処理を行うことを期待することはできません。
プラグイン開発者は、サポートするセットアップを選択して、機能を設計することができます。
- @none
- 対応するロケーションが明示的に設定されたり、デフォルト値に対して設定されてはいけないことを示します。例えば、ユーザー・データのない RCP スタイル・アプリケーションは、osgi.instance.area=@none を使用して、関係のないファイルがディスクに書き込まれることを回避します。
@none の後に、追加のパス・セグメントを付けないでください。
- @noDefault
- ロケーションを強制的に未定義にするか、または明示的に定義します (Eclipse
は、デフォルト値を自動的に計算しません)。これは、対応するロケーション内のデータを許可し、Eclipse デフォルト値が適切ではない場合に役立ちます。@noDefault の後に、追加のパス・セグメントを付けないでください。
- @user.home
- Eclipse を誘導して、ユーザーのホーム・ディレクトリーに関連するロケーション値を計算します。
@user.home の後には、追加のパス・セグメントを付けることができます。
すべての場合において、ストリング「@user.home」は、Java "user.home" システム・プロパティーの値に置換されます。例:
osgi.instance.area=@user.home/myWorkspace
この値は、以下のようになります。
file:/users/bob/myWorkspace
- @user.dir
- Eclipse を誘導して、現行作業ディレクトリーに関連するロケーション値を計算します。
@user.dir の後には、追加のパス・セグメントを付けることができます。
すべての場合で、ストリング「@user.dir」は、Java "user.dir" システム・プロパティーの値に置換されます。例:
osgi.instance.area=@user.dir/myWorkspace
この値は、以下のようになります。
file:/usr/share/eclipse/myWorkspace
ロケーション/値 |
デフォルトのサポート |
ファイル/URL
|
@none
|
@noDefault
|
@user.home
|
@user.dir
|
インスタンス
|
はい
|
はい
|
はい
|
はい
|
はい
|
はい (デフォルト)
|
構成
|
はい
|
はい
|
はい*
|
はい*
|
はい
|
はい
|
インストール
|
いいえ
|
はい
|
いいえ
|
いいえ
|
はい
|
はい
|
ユーザー
|
はい
|
はい
|
はい
|
はい
|
はい
|
はい
|
* は、このセットアップが技術的には可能ですが、プログラム的に管理が困難であることを示しています。
特に、構成ロケーションがない場合、Eclipse ランタイムは、OSGi フレームワークの開始中にのみ取得します。
