Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
View | Details | Raw Unified | Return to bug 126599
Collapse All | Expand All

(-)reference/misc/runtime-options.html (-7 / +74 lines)
Lines 247-252 Link Here
247
  <dd>This property is set at the time eclipse is started.  The value of this property a string 
247
  <dd>This property is set at the time eclipse is started.  The value of this property a string 
248
      representation of the value returned by System.currentTimeMillis().  This value is not
248
      representation of the value returned by System.currentTimeMillis().  This value is not
249
      intended to be set by users.</dd>
249
      intended to be set by users.</dd>
250
  <dt><a name="eclipsestateSaveDelayInterval" id="eclipsestateSaveDelayInterval"></a>eclipse.stateSaveDelayInterval</dt>
251
  <dd>the delay interval (in milliseconds) for persisting state change requests.  The default 
252
    is 30000 ms (30 seconds).  State change requests are delayed to prevent massive amounts 
253
    of disk writes while performing administrative operations (e.g. installing bundles).  
254
    The delay interval is used to wait for a period of inactivity before persisting the 
255
    framework state information.</dd>
250
  <dt><a name="eclipsevm" id="eclipsevm"></a>eclipse.vm {-vm}</dt>
256
  <dt><a name="eclipsevm" id="eclipsevm"></a>eclipse.vm {-vm}</dt>
251
  <dd>the path to the Java executable used to run Eclipse. This information is
257
  <dd>the path to the Java executable used to run Eclipse. This information is
252
  used to construct relaunch command lines.</dd>
258
  used to construct relaunch command lines.</dd>
Lines 261-266 Link Here
261
  <dt><a name="osgibaseconfigurationarea"></a>osgi.baseConfiguration.area</dt>
267
  <dt><a name="osgibaseconfigurationarea"></a>osgi.baseConfiguration.area</dt>
262
  <dd>specifies a base configuration that is used when 
268
  <dd>specifies a base configuration that is used when 
263
      <a href="#osgiconfigurationarea">osgi.configuration.area</a> is not specified.</dd>
269
      <a href="#osgiconfigurationarea">osgi.configuration.area</a> is not specified.</dd>
270
  <dt><a name="osgibundlefilelimit"></a>osgi.bundlefile.limit</dt>
271
  <dd>specifies a limit on the number of jar files the framework will keep open.  
272
      The minimum value allowed is 10.  By default the value is unlimited.</dd>
264
  <dt><a name="osgibundles"></a>osgi.bundles</dt>
273
  <dt><a name="osgibundles"></a>osgi.bundles</dt>
265
  <dd>The comma-separated list of bundles which are automatically installed
274
  <dd>The comma-separated list of bundles which are automatically installed
266
    and optionally started
275
    and optionally started
Lines 296-308 Link Here
296
  <dt><a name="osgiconsole"></a>osgi.console {-console} </dt>
305
  <dt><a name="osgiconsole"></a>osgi.console {-console} </dt>
297
  <dd>if set to a non-null value, the OSGi console (if installed) is enabled.
306
  <dd>if set to a non-null value, the OSGi console (if installed) is enabled.
298
    If the value is a suitable integer, it is interpreted as the port on which
307
    If the value is a suitable integer, it is interpreted as the port on which
299
    the console listens and directs its output
308
    the console listens and directs its output to the given port. Handy for investigating
300
    to the
309
    the state of the system.</dd>
301
    given port.
302
Handy for investigating
303
  the state of the system.   </dd>
304
  <dt><a name="osgiconsoleclass"></a>osgi.console.class</dt>
310
  <dt><a name="osgiconsoleclass"></a>osgi.console.class</dt>
305
  <dd>the class name of the console to run if requested</dd>
311
  <dd>the class name of the console to run if requested</dd>
312
  <dt><a name="osgiconsoleencoding"></a>osgi.console.encoding</dt>
313
  <dd>if set then the specified value is used as the encoding for the console (see
314
    <a href="#osgiconsole">osgi.console</a>).  If not set then the value of the file.encoding 
315
    property is used.  If file.encoding is not set then iso8859-1 is used as the default.
316
  </dd>
317
  <dt><a name="osgicontextClassLoaderParent"></a>osgi.contextClassLoaderParent</dt>
318
  <dd>the classloader type to use as the parent classloader of the context
319
    classloader used by the Framework.  The valid types are the following:
320
    <ul type=disc>
321
      <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
322
          mso-list:l2 level1 lfo3;tab-stops:list .5in'><b>app</b> - the application classloader.</li>
323
      <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
324
     mso-list:l2 level1 lfo3;tab-stops:list .5in'><b>boot</b> - the boot classloader.</li>
325
      <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
326
     mso-list:l2 level1 lfo3;tab-stops:list .5in'><b>ext</b> - the extension classloader.</li>
327
      <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
328
     mso-list:l2 level1 lfo3;tab-stops:list .5in'><b>fwk</b> - the framework classloader.</li>
329
      <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
330
     mso-list:l2 level1 lfo3;tab-stops:list .5in'><b>ccl</b> - the original context classloader 
331
     that was set when the framework launched (default value).</li>
332
    </ul>
333
  </dd>
306
  <dt><a name="osgidebug"></a>osgi.debug {-debug}</dt>
334
  <dt><a name="osgidebug"></a>osgi.debug {-debug}</dt>
307
  <dd>if set to a non-null value, the platform is put in debug mode. If the value
335
  <dd>if set to a non-null value, the platform is put in debug mode. If the value
308
    is a string it is interpreted as the location of the
336
    is a string it is interpreted as the location of the
Lines 322-327 Link Here
322
    the file will contain an entry of the form<br>
350
    the file will contain an entry of the form<br>
323
<pre>    &lt;plug-in id&gt;=&lt;comma separated list of classpath entries to add&gt;</pre>
351
<pre>    &lt;plug-in id&gt;=&lt;comma separated list of classpath entries to add&gt;</pre>
324
    where plug-in id &quot;*&quot; matches any plug-in not otherwise mentioned.</dd>
352
    where plug-in id &quot;*&quot; matches any plug-in not otherwise mentioned.</dd>
353
  <dt><a name="osgifilepermissionscommand"></a>osgi.filepermissions.command</dt>
354
  <dd>specifies an optional OS specific command to set file permissions on extracted
355
      native code.  On some operating systems it is required that native libraries be 
356
      set to executable.  This optional property allows you to specify the command. 
357
      For example, on a UNIX style OS you could have the following value:
358
      <pre>    osgi.filepermissions.command=&quot;chmod +rx [fullpath]&quot;</pre>
359
      The [fullpath] is used to substitute the actual file path by the framework.
360
  </dd>
325
  <dt><a name="o.pngramework"></a>osgi.framework</dt>
361
  <dt><a name="o.pngramework"></a>osgi.framework</dt>
326
  <dd>the URL location of the OSGi framework. Useful if the Eclipse install
362
  <dd>the URL location of the OSGi framework. Useful if the Eclipse install
327
  is disjoint. See the section on <a href="#locations">locations</a> for more details. </dd>
363
  is disjoint. See the section on <a href="#locations">locations</a> for more details. </dd>
Lines 331-338 Link Here
331
    (see <a href="#o.pngramework">osgi.framework</a>)</dd>
367
    (see <a href="#o.pngramework">osgi.framework</a>)</dd>
332
  <dt><a name="osgiframeworkextensions"></a>osgi.framework.extensions</dt>
368
  <dt><a name="osgiframeworkextensions"></a>osgi.framework.extensions</dt>
333
  <dd>a comma-separated list of framework extensions.  Each entry is of the form:<br>
369
  <dd>a comma-separated list of framework extensions.  Each entry is of the form:<br>
334
	 <pre>    &lt;URL | simple bundle location&gt;</pre>
370
	 <pre>    &lt;simple bundle location&gt;</pre>
335
      If a simple bundle location is specified (not a URL) then a search is done in parent directory of the 
371
      Simple bundle locations are searched in the parent directory of the 
336
      org.eclipse.osgi bundle.  Framework extensions may be used to run Eclipse with a different
372
      org.eclipse.osgi bundle.  Framework extensions may be used to run Eclipse with a different
337
      framework adaptor.  The framework extension may contain an eclipse.properties file to set 
373
      framework adaptor.  The framework extension may contain an eclipse.properties file to set 
338
      system properties.  For example, a framework extension that provides a framework adaptor 
374
      system properties.  For example, a framework extension that provides a framework adaptor 
Lines 344-349 Link Here
344
  &quot;jar&quot; indicates that the Eclipse OSGi Framework is contained in a single jar.
380
  &quot;jar&quot; indicates that the Eclipse OSGi Framework is contained in a single jar.
345
  The value &quot;folder&quot; indicates that the Eclipse OSGi Framework is contained in a 
381
  The value &quot;folder&quot; indicates that the Eclipse OSGi Framework is contained in a 
346
  directory.</dd>
382
  directory.</dd>
383
  <dt><a name="osgiframeworklibraryextensions"></a>osgi.framework.library.extensions</dt>
384
  <dd>a comma separated list of additional library file extensions that
385
    must be searched for.  If not set then only the library name returned by
386
    System.mapLibraryName(String) will be used to search.  This is needed for
387
    certain operating systems which allow more than one extension for a library. 
388
    For example AIX allows library extensions of .a and .so, but
389
    System.mapLibraryName(String) will only return names with the .a extension.</dd>
390
  <dt><a name="osgiframeworkuseSystemProperties"></a>osgi.framework.useSystemProperties</dt>
391
  <dd>controls whether the framework properties are backed by the global System properties 
392
    or held privately for each instance of the framework.  By default the framework properties
393
    are backed by the System properties (e.g. true).  This property is useful when running 
394
    multiple instances of the OSGi Framework within the same VM and each instance has a separate
395
    set of configuration properties (e.g. set in the config.ini).</dd>
396
  <dt><a name="osgihookconfigurators"></a>osgi.hook.configurators</dt>
397
  <dd>a comma separated list of hook configurators.  If this property is set then the list of 
398
    configurators specified will be the only configurators used.  Any hook configurators 
399
    specified in hookconfigurators.properties files will be ignored.</dd>
400
  <dt><a name="osgihookconfiguratorsinclude"></a>osgi.hook.configurators.include</dt>
401
  <dd>a comma separated list of additional hook configuratiors.  This is helpful for 
402
    configuring optional hook configurators.  This option is ignored if the 
403
    <a href="#osgihookconfigurators">osgi.hook.configurators</a> option is used.</dd>
404
  <dt><a name="osgihookconfiguratorsexclude"></a>osgi.hook.configurators.exclude</dt>
405
  <dd>a comma separated list of hook configurators to exclude.  This is helpful for disabling 
406
    hook configurators that are specified in hook configurator properties files.  This option 
407
    is ignored if the <a href="#osgihookconfigurators">osgi.hook.configurators</a> option is used.</dd>
347
  <dt><a name="osgijavaprofile"></a>osgi.java.profile</dt>
408
  <dt><a name="osgijavaprofile"></a>osgi.java.profile</dt>
348
  <dd>a URL to the JRE profile file to use.  A JRE profile contains values for the properties
409
  <dd>a URL to the JRE profile file to use.  A JRE profile contains values for the properties
349
     org.osgi.framework.system.packages and org.osgi.framework.bootdelegation.  If 
410
     org.osgi.framework.system.packages and org.osgi.framework.bootdelegation.  If 
Lines 406-411 Link Here
406
  <dt><a name="osginl"></a>osgi.nl {-nl}</dt>
467
  <dt><a name="osginl"></a>osgi.nl {-nl}</dt>
407
  <dd>the name of the locale on which Eclipse platform will run. NL values should
468
  <dd>the name of the locale on which Eclipse platform will run. NL values should
408
    follow the standard Java locale naming conventions.</dd>
469
    follow the standard Java locale naming conventions.</dd>
470
  <dt><a name="osginluser"></a>osgi.nl.user</dt>
471
  <dd>the name of the locale when the user explicitly adds -nl to the command-line arguments.</dd>
409
  <dt><a name="osginoshutdown"></a>osgi.noShutdown {-noExit}</dt>
472
  <dt><a name="osginoshutdown"></a>osgi.noShutdown {-noExit}</dt>
410
  <dd>if &quot;true&quot;, the VM will not exit after the eclipse application has ended.  This
473
  <dd>if &quot;true&quot;, the VM will not exit after the eclipse application has ended.  This
411
      is useful for examining the OSGi framework after the eclipse application has ended.</dd>
474
      is useful for examining the OSGi framework after the eclipse application has ended.</dd>
Lines 445-450 Link Here
445
  <dt><a name="osgisplashpath"></a>osgi.splashPath</dt>
508
  <dt><a name="osgisplashpath"></a>osgi.splashPath</dt>
446
  <dd>a comma separated list of URLs to search for a file called splash.bmp.
509
  <dd>a comma separated list of URLs to search for a file called splash.bmp.
447
  This property is overriden by any value set in <a href="#osgisplashlocation">osgi.splashLocation</a>.</dd>
510
  This property is overriden by any value set in <a href="#osgisplashlocation">osgi.splashLocation</a>.</dd>
511
  <dt><a name="osgisupportsignatureverify"></a>osgi.support.signature.verify</dt>
512
  <dd>valid values are &quot;true&quot; or &quot;false&quot; default is &quot;false&quot;.  
513
    When set to &quot;true&quot; the framework will load certificates from signed jars and
514
    verify the content is not corrupted at runtime.</dd>
448
  <dt><a name="osgisyspath"></a>osgi.syspath</dt>
515
  <dt><a name="osgisyspath"></a>osgi.syspath</dt>
449
  <dd>set to the path where the eclipse OSGi Framework (org.eclipse.osgi) implementation 
516
  <dd>set to the path where the eclipse OSGi Framework (org.eclipse.osgi) implementation 
450
  is located.  For example, &quot;&lt;eclipse install path&gt;/eclipse/plugins&quot;.
517
  is located.  For example, &quot;&lt;eclipse install path&gt;/eclipse/plugins&quot;.

Return to bug 126599