~ubuntu-branches/ubuntu/trusty/proguard/trusty

« back to all changes in this revision

Viewing changes to docs/manual/ant.html

  • Committer: Package Import Robot
  • Author(s): tony mancill
  • Date: 2013-06-06 21:43:59 UTC
  • mfrom: (7.1.1 quantal)
  • Revision ID: package-import@ubuntu.com-20130606214359-anr49am8ewoj0taa
Tags: 4.8-0.1
* Non-maintainer upload.
* New upstream release. (Closes: #678049, #643255)
* Sync changes from Ubuntu packaging.
  - Thank you to Sebastian Carneiro.
* Bump Standards-Version to 3.9.4.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!doctype html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
 
1
<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
2
<html>
3
3
<head>
4
4
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
5
5
<meta http-equiv="content-style-type" content="text/css">
6
6
<link rel="stylesheet" type="text/css" href="style.css">
7
7
<title>Ant Task</title>
 
8
<script type="text/javascript" language="JavaScript">
 
9
<!--
 
10
if (window.self==window.top)
 
11
  window.top.location.replace("../index.html#"+window.location.pathname+window.location.hash);
 
12
else {
 
13
  var hash="#"+window.location.pathname.replace(window.top.location.pathname.replace("index.html", ""), "");
 
14
  if (window.top.location.hash!=hash)
 
15
    window.top.location.hash=hash;
 
16
}
 
17
//-->
 
18
</script>
8
19
</head>
9
20
<body>
10
21
 
89
100
<p>
90
101
 
91
102
Secondly, the use of <code>&lt;</code> and <code>&gt;</code> characters would
92
 
upset the structure of the XML build file. Environment variables are now
93
 
enclosed by an opening <code>${</code> and a closing <code>}</code>. This
94
 
syntax also allows you to use Ant properties within the ProGuard
95
 
configuration. Other occurrences of <code>&lt;</code> and <code>&gt;</code>
96
 
have to be encoded as <code>&amp;lt;</code> and <code>&amp;gt;</code>.
 
103
upset the structure of the XML build file. Environment variables can be
 
104
specified with the usual Ant style <code>${...}</code>, instead of the ProGuard
 
105
style <code>&lt;...&gt;</code>.  Other occurrences of <code>&lt;</code> and
 
106
<code>&gt;</code> have to be encoded as <code>&amp;lt;</code> and
 
107
<code>&amp;gt;</code> respectively.
97
108
<p>
98
109
 
99
110
<h3>3. XML configuration tags</h3>
107
118
files in the <code>examples/ant</code> directory of the ProGuard distribution.
108
119
<p>
109
120
 
110
 
<a name="proguard">&nbsp;</a>
111
 
<h2>Task Attributes and Nested Elements</h2>
 
121
<h2><a name="proguard">Task Attributes and Nested Elements</a></h2>
112
122
 
113
123
The <code><b>&lt;proguard&gt;</b></code> task and the
114
124
<code><b>&lt;proguardconfiguration&gt;</b></code> task can have the following
120
130
<dt><a name="configuration_attribute"><code><b>configuration</b></code></a>
121
131
    = "<i>filename</i>"</dt>
122
132
<dd>Read and merge options from the given ProGuard-style configuration
123
 
    file. Note: for reading XML-style configurations, use the <a
 
133
    file. Note: for reading multiple configuration files or XML-style
 
134
    configurations, use the <a
124
135
    href="#configuration_element"><code>configuration</code></a>
125
136
    <i>element</i>.</dd>
126
137
 
127
 
<dt><a href="usage.html#dontskipnonpubliclibraryclasses"><code><b>skipnonpubliclibraryclasses</b></code></a>
 
138
<dt><a href="usage.html#skipnonpubliclibraryclasses"><code><b>skipnonpubliclibraryclasses</b></code></a>
128
139
    = "<i>boolean</i>"
129
 
    (default = true)</dt>
 
140
    (default = false)</dt>
130
141
<dd>Ignore non-public library classes.</dd>
131
142
 
132
143
<dt><a href="usage.html#dontskipnonpubliclibraryclassmembers"><code><b>skipnonpubliclibraryclassmembers</b></code></a>
242
253
<dd>Repackage all class files that are renamed into the single given
243
254
    package.</dd>
244
255
 
 
256
<dt><a href="usage.html#keepparameternames"><code><b>keepparameternames</b></code></a>
 
257
    = "<i>boolean</i>"
 
258
   (default = false)</dt>
 
259
<dd>Keep the parameter names and types of methods that are kept.</dd>
 
260
 
245
261
<dt><a href="usage.html#renamesourcefileattribute"><code><b>renamesourcefileattribute</b></code></a>
246
262
    = "<i>string</i>"
247
263
    (default = none)</dt>
257
273
<dt><a href="usage.html#microedition"><code><b>microedition</b></code></a>
258
274
    = "<i>boolean</i>"
259
275
    (default = false)</dt>
260
 
<dd>Targets the processed class files at Java Micro Edition.</dd>
 
276
<dd>Target the processed class files at Java Micro Edition.</dd>
261
277
 
262
278
<dt><a href="usage.html#verbose"><code><b>verbose</b></code></a>
263
279
    = "<i>boolean</i>"
305
321
<dt><a href="usage.html#outjars"><code><b>&lt;outjar</b></code></a>
306
322
    <a href="#classpath"><i>class_path</i></a>
307
323
    <code><b>/&gt;</b></code></dt>
308
 
<dd>Specifies the name of the output jars (or wars, ears, zips, or
 
324
<dd>Specifies the names of the output jars (or wars, ears, zips, or
309
325
    directories).</dd>
310
326
 
311
327
<dt><a href="usage.html#libraryjars"><code><b>&lt;libraryjar</b></code></a>
436
452
    filter. <i>Only use this option if you know what you're doing!</i></dd>
437
453
 
438
454
<dt><a name="configuration_element"><code><b>&lt;configuration refid = </b></code></a>"<i>ref_id</i>"
 
455
    <code><b>/&gt;</b></code><br/>
 
456
    <code><b>&lt;configuration file = </b></code>"<i>name</i>"
439
457
    <code><b>/&gt;</b></code></dt>
440
 
<dd>Includes the configuration specified in the
 
458
<dd>The first form includes the XML-style configuration specified in a
441
459
    <code>&lt;proguardconfiguration&gt;</code> task (or
442
 
    <code>&lt;proguard&gt;</code> task) with the attribute <code>id</code> =
443
 
    "<i>ref_id</i>". Note that only the nested elements of this configuration
444
 
    are considered, not the attributes. Also note: for reading ProGuard-style
445
 
    configuration files, use the <a
446
 
    href="#configuration_attribute"><code>configuration</code></a>
447
 
    <i>attribute</i>.</dd>
 
460
    <code>&lt;proguard&gt;</code> task) with attribute <code>id</code> =
 
461
    "<i>ref_id</i>". Only the nested elements of this configuration are
 
462
    considered, not the attributes.
 
463
    <p>
 
464
    The second form includes the ProGuard-style configuration from the specified
 
465
    file. The element is actually a <code>fileset</code> element and supports
 
466
    all of its attributes and nested elements, including multiple files.
 
467
    </dd>
448
468
 
449
469
</dl>
450
470
 
451
 
<a name="classpath">&nbsp;</a>
452
 
<h2>Class Path Attributes and Nested Elements</h2>
 
471
<h2><a name="classpath">Class Path Attributes and Nested Elements</a></h2>
453
472
 
454
 
The jar tags are path tags, so they can have any of the path attributes (or
455
 
nested elements). The most common attributes are:
 
473
The jar elements are <code>path</code> elements, so they can have any of the
 
474
standard <code>path</code> attributes and nested elements. The most common
 
475
attributes are:
456
476
 
457
477
<dl>
458
478
 
472
492
 
473
493
</dl>
474
494
 
475
 
In addition, the jar tags can have ProGuard-style filter attributes:
 
495
In addition, the jar elements can have ProGuard-style filter attributes:
476
496
 
477
497
<dl>
478
498
 
499
519
 
500
520
</dl>
501
521
 
502
 
<a name="keepmodifier">&nbsp;</a>
503
 
<h2>Keep Modifier Attributes</h2>
 
522
<h2><a name="keepmodifier">Keep Modifier Attributes</a></h2>
504
523
 
505
524
The keep tags can have the following <i>modifier</i> attributes:
506
525
 
526
545
 
527
546
</dl>
528
547
 
529
 
<a name="classspecification">&nbsp;</a>
530
 
<h2>Class Specification Attributes and Nested Elements</h2>
 
548
<h2><a name="classspecification">Class Specification Attributes and Nested Elements</a></h2>
531
549
 
532
550
The keep tags can have the following <i>class_specification</i> attributes and
533
551
<i>class_member_specifications</i> nested elements:
538
556
<dd>The optional access modifiers of the class. Any space-separated list of
539
557
    "public", "final", and "abstract", with optional negators "!".</dd>
540
558
 
 
559
<dt><code><b>annotation</b></code> = "<i>annotation_name</i>"</dt>
 
560
<dd>The optional fully qualified name of an annotation of the class, with
 
561
    optional wildcards.</dd>
 
562
 
541
563
<dt><code><b>type</b></code> = "<i>type</i>"</dt>
542
564
<dd>The optional type of the class: one of "class", "interface", or
543
565
    "!interface".</dd>
546
568
<dd>The optional fully qualified name of the class, with optional
547
569
    wildcards.</dd>
548
570
 
 
571
<dt><code><b>extendsannotation</b></code> = "<i>annotation_name</i>"</dt>
 
572
<dd>The optional fully qualified name of an annotation of the the class that
 
573
    the specified classes must extend, with optional wildcards.</dd>
 
574
 
549
575
<dt><code><b>extends</b></code> = "<i>class_name</i>"</dt>
550
576
<dd>The optional fully qualified name of the class the specified classes
551
577
    must extend, with optional wildcards.</dd>
571
597
 
572
598
</dl>
573
599
 
574
 
<a name="classmemberspecification">&nbsp;</a>
575
 
<h2>Class Member Specification Attributes</h2>
 
600
<h2><a name="classmemberspecification">Class Member Specification Attributes</a></h2>
576
601
 
577
602
The class member tags can have the following <i>class_member_specification</i>
578
603
attributes:
584
609
    "public", "protected", "private", "static", etc., with optional negators
585
610
    "!".</dd>
586
611
 
 
612
<dt><code><b>annotation</b></code> = "<i>annotation_name</i>"</dt>
 
613
<dd>The optional fully qualified name of an annotation of the class member,
 
614
    with optional wildcards.</dd>
 
615
 
587
616
<dt><code><b>type</b></code> = "<i>type</i>"</dt>
588
617
<dd>The optional fully qualified type of the class member, with optional
589
618
    wildcards. Not applicable for constructors, but required for methods for
601
630
 
602
631
</dl>
603
632
 
604
 
<hr>
 
633
<hr />
 
634
<noscript><div><a target="_top" href="../index.html" class="button">Show menu</a></div></noscript>
605
635
<address>
606
 
Copyright &copy; 2002-2009
607
 
<a href="http://www.graphics.cornell.edu/~eric/">Eric Lafortune</a>.
 
636
Copyright &copy; 2002-2012
 
637
<a target="other" href="http://www.lafortune.eu/">Eric Lafortune</a>.
608
638
</address>
609
639
</body>
610
640
</html>