← Back to branch summary

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

« back to all changes in this revision

Viewing changes to eclipse.1.xml

  • 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
http://bugs.debian.org/558693
https://launchpad.net/bugs/293573
https://launchpad.net/bugs/460944
http://bugs.debian.org/541638
https://launchpad.net/bugs/491880
https://launchpad.net/bugs/445009
https://launchpad.net/bugs/494065
* 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:
eclipse.1.xml
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
 
 
3
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
 
4
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
5
<!-- lifted from troff+man by doclifter -->
 
6
<refentry id='eclipse1'>
 
7
<refmeta>
 
8
<refentrytitle>eclipse</refentrytitle>
 
9
<manvolnum>1</manvolnum>
 
10
</refmeta>
 
11
<refnamediv id='name'>
 
12
<refname>eclipse</refname>
 
13
<refpurpose>extensible tool platform and Java IDE</refpurpose>
 
14
</refnamediv>
 
15
<!-- body begins here -->
 
16
<refsynopsisdiv id='synopsis'>
 
17
<cmdsynopsis>
 
18
  <command>eclipse</command>    
 
19
    <arg choice='opt'><arg choice='plain'><replaceable>platform</replaceable></arg><arg choice='plain'><replaceable>options</replaceable></arg></arg>
 
20
    <arg choice='opt'><arg choice='plain'>-vmargs </arg><arg choice='opt'><arg choice='plain'><replaceable>Java</replaceable></arg><arg choice='plain'><replaceable>VM</replaceable></arg><arg choice='plain'><replaceable>arguments</replaceable></arg></arg></arg>
 
21
</cmdsynopsis>
 
22
</refsynopsisdiv>
 
23
 
 
24
 
 
25
<refsect1 id='description'><title>DESCRIPTION</title>
 
26
<para>
 
27
The <command>Eclipse</command> Platform is an open and 
 
28
 extensible platform for anything and yet nothing in particular. It provides a 
 
29
 foundation for constructing and running integrated software-development tools. 
 
30
 The <command>Eclipse</command> Platform allows tool builders 
 
31
 to independently develop tools that integrate with other people's tools so 
 
32
 seamlessly you can't tell where one tool ends and another starts.</para>
 
33
 
 
34
 <para>When invoked without selecting any particular application, the <command>eclipse</command>
 
35
 command will start the <command>Eclipse</command> Platform with the Java Development
 
36
 Tools (JDT) functionality enabled and ready to use.</para>
 
37
 
 
38
<para>This manual page documents the command-line arguments for the
 
39
<command>Eclipse</command> Platform and it is based on the
 
40
Runtime Options help item in the <command>Eclipse</command>
 
41
<ulink url="#authors" xrefstyle="AUTHORS">online help</ulink><!-- (see xref endterm="authors" linkend="authors" xrefstyle="AUTHORS"></xref> AUTHORS below)-->.</para>
 
42
 
 
43
</refsect1>
 
44
 
 
45
<refsect1 id='platform_options'><title>PLATFORM OPTIONS</title>
 
46
<para>  Listed below are the command line arguments processed by various parts of the 
 
47
<command>Eclipse</command> runtime.
 
48
Many of these values can also be specified using System properties either on the command line
 
49
using <command>-D VM</command> arguments, by specifying their values in a <filename>config.ini</filename> file or by using a
 
50
<filename>&lt;launcher&gt;.ini</filename> file. Using the two latter techniques it is possible to customize 
 
51
<command>Eclipse</command> without using command line arguments at all.</para>
 
52
 
 
53
<para>For each argument in the list, its corresponding System property key is given (in {}). Also
 
54
given is the <command>Eclipse</command> runtime layer in which the 
 
55
command line argument is processed (in ()). </para>
 
56
 
 
57
<variablelist remap='TP'>
 
58
 
 
59
<varlistentry>
 
60
        <term><option>
 
61
          -application &lt;id&gt; (Runtime)
 
62
        </option></term>
 
63
        <listitem>
 
64
        <para>
 
65
        The identifier of the application to run. The value given here
 
66
            overrides any application defined by the product being run</para>
 
67
          <para>
 
68
            This is equivalent to setting the property
 
69
            <emphasis>eclipse.application</emphasis> to
 
70
            &lt;id&gt;.
 
71
          </para>
 
72
        </listitem>
 
73
      </varlistentry>
 
74
      <varlistentry>
 
75
        <term><option>
 
76
          -arch &lt;architecture&gt; (OSGi) 
 
77
        </option></term>
 
78
        <listitem>
 
79
        <para>The processor architecture value.</para>
 
80
          <para>
 
81
            This is equivalent to setting the property <emphasis>osgi.arch</emphasis> to
 
82
            &lt;architecture&gt;.
 
83
          </para>
 
84
        </listitem>
 
85
      </varlistentry>
 
86
      <varlistentry>
 
87
        <term><option>
 
88
          -clean (OSGi) 
 
89
        </option></term>
 
90
        <listitem>
 
91
         <para>
 
92
            If set to &quot;true&quot;, any cached data used by the OSGi
 
93
            framework and eclipse runtime will be wiped clean. This will clean
 
94
            the caches used to store bundle dependency resolution and eclipse
 
95
            extension registry data. Using this option will force eclipse to
 
96
            reinitialize these caches.
 
97
          </para>
 
98
          <para>
 
99
            This is equivalent to setting the property <emphasis>osgi.clean</emphasis> to
 
100
            &quot;true&quot;.
 
101
          </para>
 
102
        </listitem>
 
103
      </varlistentry>
 
104
      <varlistentry>
 
105
        <term><option>
 
106
          -configuration &lt;location&gt; (Main)
 
107
        </option></term>
 
108
        <listitem>
 
109
        <para>The configuration location for this run of the platform. The
 
110
            configuration determines what plug-ins will run as well as various
 
111
            other system settings. See the On-line Help for details (SEE ALSO below).</para>
 
112
          <para>
 
113
            This is equivalent to setting the property <emphasis>osgi.configuration.area</emphasis>
 
114
            to &lt;location&gt;.
 
115
          </para>
 
116
        </listitem>
 
117
      </varlistentry>
 
118
      <varlistentry>
 
119
        <term><option>
 
120
          -console [port] (OSGi) 
 
121
        </option></term>
 
122
        <listitem>
 
123
        <para>If set to a non-null value, the OSGi console (if installed) is
 
124
            enabled. If the value is a suitable integer, it is interpreted as
 
125
            the port on which the console listens and directs its output to the
 
126
            given port. Handy for investigating the state of the system.</para>
 
127
          <para>
 
128
            This is equivalent to setting the property <emphasis>osgi.console</emphasis> to [port] or the
 
129
            empty string if the default port is to be used (i.e., when the port is not specified).
 
130
          </para>
 
131
        </listitem>
 
132
      </varlistentry>
 
133
      <varlistentry>
 
134
        <term><option>
 
135
          -consoleLog (Runtime)
 
136
        </option></term>
 
137
        <listitem>
 
138
        <para>If &quot;true&quot;, any log output is also sent to Java's
 
139
            System.out (typically back to the command shell if any). Handy when
 
140
            combined with -debug.</para>
 
141
          <para>
 
142
            This is equivalent to setting the property <emphasis>eclipse.consoleLog</emphasis> to
 
143
            &quot;true&quot;.
 
144
          </para>
 
145
        </listitem>
 
146
      </varlistentry>
 
147
      <varlistentry>
 
148
        <term><option>
 
149
          -data &lt;location&gt; (OSGi)<literallayout></literallayout> 
 
150
        </option></term>
 
151
        <listitem>
 
152
          <para>
 
153
            This is equivalent to setting the property <emphasis>osgi.instance.area</emphasis> to
 
154
            &lt;location&gt;.
 
155
          </para>
 
156
        </listitem>
 
157
      </varlistentry>
 
158
      <varlistentry>
 
159
        <term><option>
 
160
          -debug [options file] (OSGi)
 
161
        </option></term>
 
162
        <listitem>
 
163
          <para>
 
164
            This is equivalent to setting the property <emphasis>osgi.debug</emphasis> to
 
165
            [options file] or the empty string to simply enable debug (i.e., if
 
166
            the options file location is not specified).
 
167
          </para>
 
168
        </listitem>
 
169
      </varlistentry>
 
170
      <varlistentry>
 
171
        <term><option>
 
172
          -dev [entries] (OSGi)
 
173
        </option></term>
 
174
        <listitem>
 
175
          <para>
 
176
            This is equivalent to setting the property <emphasis>osgi.dev</emphasis> to
 
177
            [entries] or the empty string to simply enable dev mode (i.e., if
 
178
            entries are not specified).
 
179
          </para>
 
180
        </listitem>
 
181
      </varlistentry>
 
182
      <varlistentry>
 
183
        <term><option>
 
184
          -eclipse.keyring &lt;file path&gt; (Equinox)
 
185
        </option></term>
 
186
        <listitem>
 
187
          <para>
 
188
            Set to override location of the default secure storage.
 
189
          </para>
 
190
        </listitem>
 
191
      </varlistentry>
 
192
      <varlistentry>
 
193
        <term><option>
 
194
          -eclipse.password &lt;file path&gt; (Equinox)
 
195
        </option></term>
 
196
        <listitem>
 
197
          <para>
 
198
            If specified, the secure storage treats contents of the file as a
 
199
            default password. When not set, password providers are used to
 
200
            obtain a password.
 
201
          </para>
 
202
        </listitem>
 
203
      </varlistentry>
 
204
      <varlistentry>
 
205
        <term><option>
 
206
          -feature &lt;feature id&gt; (Runtime)
 
207
        </option></term>
 
208
        <listitem>
 
209
          <para>
 
210
            This is equivalent to setting the property <emphasis>eclipse.product</emphasis> to &lt;feature
 
211
            id&gt;.
 
212
          </para>
 
213
        </listitem>
 
214
      </varlistentry>
 
215
      <varlistentry>
 
216
        <term><option>
 
217
          -framework &lt;location&gt; (Main) 
 
218
        </option></term>
 
219
        <listitem>
 
220
          <para>
 
221
            This is equivalent to setting the property <emphasis>osgi.framework</emphasis> to
 
222
            &lt;location&gt;.
 
223
          </para>
 
224
        </listitem>
 
225
      </varlistentry>
 
226
      <varlistentry>
 
227
        <term><option>
 
228
          -initialize (Main)
 
229
        </option></term>
 
230
        <listitem>
 
231
          <para>
 
232
            Initializes the configuration being run. All runtime related data
 
233
            structures and caches are refreshed. Any user/plug-in defined
 
234
            configuration data is not purged. No application is run, any
 
235
            product specifications are ignored and no UI is presented (e.g.,
 
236
            the splash screen is not drawn).
 
237
          </para>
 
238
        </listitem>
 
239
      </varlistentry>
 
240
      <varlistentry>
 
241
        <term><option>
 
242
          -install &lt;location&gt; (Main)
 
243
        </option></term>
 
244
        <listitem>
 
245
          <para>
 
246
            This is equivalent to setting the property <emphasis>osgi.install.area</emphasis> to
 
247
            &lt;location&gt;.
 
248
          </para>
 
249
        </listitem>
 
250
      </varlistentry>
 
251
      <varlistentry>
 
252
        <term><option>
 
253
          -keyring &lt;location&gt; (Runtime)
 
254
        </option></term>
 
255
        <listitem>
 
256
          <para>
 
257
            The location of the authorization database on disk. This argument
 
258
            has to be used together with the -password argument.
 
259
          </para>
 
260
        </listitem>
 
261
      </varlistentry>
 
262
      <varlistentry>
 
263
        <term><option>
 
264
          --launcher.library &lt;location&gt; (Executable)
 
265
        </option></term>
 
266
        <listitem>
 
267
          <para>
 
268
            The location of the eclipse executable's companion shared
 
269
            library. If not specified the executable looks in the plugins
 
270
            directory for the appropriate
 
271
            org.eclipse.equinox.launcher.[platform] fragment with the highest
 
272
            version and uses the shared library named eclipse_* inside.
 
273
          </para>
 
274
        </listitem>
 
275
      </varlistentry>
 
276
      <varlistentry>
 
277
        <term><option>
 
278
          --launcher.ini &lt;location&gt; (Executable)
 
279
        </option></term>
 
280
        <listitem>
 
281
          <para>
 
282
          <!-- NOTE ECLIPSE.EXE HERE -->
 
283
            The location of the product .ini file to use. If not
 
284
            specified the executable will look for a file beside the launcher
 
285
            with the same name and the extension .ini. (ie eclipse.exe
 
286
            looks for eclipse.ini, product.exe looks for product.ini).
 
287
          </para>
 
288
        </listitem>
 
289
      </varlistentry>
 
290
      <varlistentry>
 
291
        <term><option>
 
292
          --launcher.suppressErrors (Executable)
 
293
        </option></term>
 
294
        <listitem>
 
295
          <para>
 
296
            If specified the executable will not display any error or message
 
297
            dialogs. This is useful if the executable is being used in an
 
298
            unattended situation.
 
299
          </para>
 
300
        </listitem>
 
301
      </varlistentry>
 
302
     <varlistentry>
 
303
        <term><option>
 
304
          --launcher.XXMaxPermSize &lt;value&gt; (Executable)
 
305
        </option></term>
 
306
        <listitem>
 
307
          <para>
 
308
            If specified, and the executable detects that the VM being used is
 
309
            a Sun VM, then the launcher will automatically add the
 
310
            -XX:MaxPermSize=&lt;value&gt; vm argument.&nbsp; The executable is
 
311
            not capable of detecting Sun VMs on all
 
312
            platforms.<literallayout></literallayout>
 
313
          </para>
 
314
        </listitem>
 
315
      </varlistentry>
 
316
      <varlistentry>
 
317
        <term><option>
 
318
          -name &lt;string&gt;
 
319
        </option></term>
 
320
        <listitem>
 
321
          <para>
 
322
            The name to be displayed in task bar item when the application
 
323
            starts up. When not set, the name is the name of the executable.
 
324
          </para>
 
325
        </listitem>
 
326
      </varlistentry>
 
327
      <varlistentry>
 
328
        <term><option>
 
329
          -nl &lt;locale&gt; (OSGi)
 
330
        </option></term>
 
331
        <listitem>
 
332
          <para>
 
333
            This is equivalent to setting the property
 
334
            <emphasis>osgi.nl</emphasis> to
 
335
            &lt;locale&gt;.
 
336
          </para>
 
337
        </listitem>
 
338
      </varlistentry>
 
339
      <varlistentry>
 
340
        <term><option>
 
341
          -noExit (OSGi)
 
342
        </option></term>
 
343
        <listitem>
 
344
          <para>
 
345
            This is equivalent to setting the property
 
346
            <emphasis>osgi.noShutdown</emphasis> to
 
347
            &quot;true&quot;.
 
348
          </para>
 
349
        </listitem>
 
350
      </varlistentry>
 
351
      <varlistentry>
 
352
        <term><option>
 
353
          -noLazyRegistryCacheLoading (Runtime) 
 
354
        </option></term>
 
355
        <listitem>
 
356
          <para>
 
357
            This is equivalent to setting the property
 
358
            <emphasis>eclipse.noLazyRegistryCacheLoading</emphasis>
 
359
            to &quot;true&quot;.
 
360
          </para>
 
361
        </listitem>
 
362
      </varlistentry>
 
363
      <varlistentry>
 
364
        <term><option>
 
365
          -noRegistryCache (Runtime) 
 
366
        </option></term>
 
367
        <listitem>
 
368
          <para>
 
369
            This is equivalent to setting the property
 
370
            <emphasis>eclipse.noRegistryCache</emphasis>
 
371
            to &quot;true&quot;.
 
372
          </para>
 
373
        </listitem>
 
374
      </varlistentry>
 
375
      <varlistentry>
 
376
        <term><option>
 
377
          -noSplash (Executable, Main)
 
378
        </option></term>
 
379
        <listitem>
 
380
          <para>
 
381
            Controls whether or not the splash screen is shown.
 
382
          </para>
 
383
        </listitem>
 
384
      </varlistentry>
 
385
      <varlistentry>
 
386
        <term><option>
 
387
          -os &lt;operating system&gt; (OSGi) 
 
388
        </option></term>
 
389
        <listitem>
 
390
          <para>
 
391
            This is equivalent to setting the property
 
392
            <emphasis>osgi.os</emphasis> to
 
393
            &lt;operating system&gt;.
 
394
          </para>
 
395
        </listitem>
 
396
      </varlistentry>
 
397
      <varlistentry>
 
398
        <term><option>
 
399
          -password &lt;password&gt; (Runtime) 
 
400
        </option></term>
 
401
        <listitem>
 
402
          <para>
 
403
            The password for the authorization database.
 
404
          </para>
 
405
        </listitem>
 
406
      </varlistentry>
 
407
      <varlistentry>
 
408
        <term><option>
 
409
          -pluginCustomization &lt;location&gt; (Runtime) 
 
410
        </option></term>
 
411
        <listitem>
 
412
          <para>
 
413
            This is equivalent to setting the property
 
414
            <emphasis>eclipse.pluginCustomization</emphasis>
 
415
            to &lt;location&gt;
 
416
          </para>
 
417
        </listitem>
 
418
      </varlistentry>
 
419
      <varlistentry>
 
420
        <term><option>
 
421
          -product &lt;id&gt; (OSGi) 
 
422
        </option></term>
 
423
        <listitem>
 
424
          <para>
 
425
            This is equivalent to setting the property
 
426
            <emphasis>eclipse.product</emphasis> to &lt;id&gt;.
 
427
          </para>
 
428
        </listitem>
 
429
      </varlistentry>
 
430
      <varlistentry>
 
431
        <term><option>
 
432
          -showSplash &lt;bitmap&gt; (Executable, Main) 
 
433
        </option></term>
 
434
        <listitem>
 
435
          <para>
 
436
            Specifies the bitmap to use in the splash screen. If specified, the
 
437
            launcher may be able to show the splash screen before starting the
 
438
            Java VM.&nbsp; If not specified, Main will find the bitmap using
 
439
            the <emphasis>osgi.splashLocation</emphasis> and <emphasis>osgi.splashPath</emphasis>
 
440
            properties.<literallayout></literallayout>
 
441
          </para>
 
442
        </listitem>
 
443
      </varlistentry>
 
444
      <varlistentry>
 
445
        <term><option>
 
446
          -startup &lt;location&gt; (Executable)
 
447
        </option></term>
 
448
        <listitem>
 
449
          <para>
 
450
            The location of jar used to startup eclipse. The jar referred to
 
451
            should have the Main-Class attribute set to
 
452
            org.eclipse.equinox.launcher.Main. If this parameter is not set,
 
453
            the executable will look in the plugins directory for
 
454
            theorg.eclipse.equinox.launcher bundle with the highest
 
455
            version.<literallayout></literallayout>
 
456
          </para>
 
457
        </listitem>
 
458
      </varlistentry>
 
459
      <varlistentry>
 
460
        <term><option>
 
461
          -user &lt;location&gt; (OSGi) 
 
462
        </option></term>
 
463
        <listitem>
 
464
          <para>
 
465
            This is equivalent to setting the property
 
466
            <emphasis>osgi.user.area</emphasis> to
 
467
            &lt;location&gt;.
 
468
          </para>
 
469
        </listitem>
 
470
      </varlistentry>
 
471
      <varlistentry>
 
472
        <term><option>
 
473
          -vm &lt;path to java vm&gt; (Executable, Main) 
 
474
        </option></term>
 
475
        <listitem>
 
476
          <para>
 
477
          <!-- NOTE JVM.DLL HERE -->
 
478
            When passed to the Eclipse executable, this option is used to
 
479
            locate the Java VM to use to run Eclipse. It should be the full
 
480
            file system path to an appropriate: Java jre/bin directory, Java
 
481
            Executable, Java shared library (jvm.dll or libjvm.so), or a Java
 
482
            VM Execution Environment description file. If not specified,
 
483
            the Eclipse executable uses a search algorithm to locate a suitable
 
484
            VM. In any event, the executable then passes the path to the actual
 
485
            VM used to Java Main using the -vm argument. Java Main then stores
 
486
            this value in <emphasis>eclipse.vm</emphasis>.
 
487
          </para>
 
488
        </listitem>
 
489
      </varlistentry>
 
490
      <varlistentry>
 
491
        <term><option>
 
492
          -vmargs [vmargs*] (Executable, Main) 
 
493
        </option></term>
 
494
        <listitem>
 
495
          <para>
 
496
            when passed to the Eclipse, this option is used to customize the
 
497
            operation of the Java VM to use to run Eclipse. If specified, this
 
498
            option must come at the end of the command line. Even if not
 
499
            specified on the executable command line, the executable will
 
500
            automatically add the relevant arguments (including the class being
 
501
            launched) to the command line passed into Java using the -vmargs
 
502
            argument. Java Main then stores this value in
 
503
            <emphasis>eclipse.vmargs</emphasis>.
 
504
          </para>
 
505
        </listitem>
 
506
      </varlistentry>
 
507
      <varlistentry>
 
508
        <term><option>
 
509
          -ws &lt;window system&gt; (OSGi) 
 
510
        </option></term>
 
511
        <listitem>
 
512
          <para>
 
513
            This is equivalent to setting the property
 
514
            <emphasis>osgi.ws</emphasis> to
 
515
            &lt;window system&gt;.
 
516
          </para>
 
517
        </listitem>
 
518
      </varlistentry>
 
519
 
 
520
  </variablelist>
 
521
</refsect1>
 
522
 
 
523
<refsect1 id='see_also'><title>SEE ALSO</title>
 
524
<para><citerefentry><refentrytitle>java</refentrytitle><manvolnum>1</manvolnum></citerefentry>, 
 
525
<citerefentry><refentrytitle>ecj</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
 
526
<para><command>Eclipse</command> On-line Help <ulink url='http://help.eclipse.org/'>http://help.eclipse.org/</ulink>
 
527
<glossterm>Platform Plug-in Developer Guide</glossterm> &gt; <glossterm>Reference</glossterm> &gt; <glossterm>Other reference information</glossterm>  &gt;
 
528
<glossterm>Runtime Options</glossterm>.</para>
 
529
 
 
530
</refsect1>
 
531
 
 
532
<refsect1 id='files'><title>FILES</title>
 
533
<para>The system wide config.ini file is <filename>/etc/eclipse.ini</filename>. User level Configuration file is 
 
534
<filename>$HOME/.eclipse/org.eclipse.platform_&lt;version&gt;_&lt;id&gt;/configuration/config.ini</filename>.</para>
 
535
</refsect1>
 
536
 
 
537
<refsect1 XrefLabel="AUTHORS" id="authors"><title>AUTHORS</title>
 
538
<para>
 
539
The <command>Eclipse</command> Project was originally created by IBM in November 2001 and 
 
540
supported by a consortium of software vendors. The <command>Eclipse</command> Foundation was 
 
541
created in January 2004 as an independent not-for-profit corporation to act as the steward of the 
 
542
<command>Eclipse</command> community.
 
543
</para>
 
544
<para>This manual page was semi-automatically transformed from the
 
545
Runtime Options HTML help using <command>pandoc</command> and 
 
546
<command>docbook2x-man</command> by Pablo Duboue &lt;pablo.duboue@gmail.com&gt;.</para>
 
547
 
 
548
</refsect1>
 
549
</refentry>