• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<?xml version="1.0"?>
2
3<!--
4   Copyright (c) 2009, 2018 Mountainminds GmbH & Co. KG and Contributors
5   This program and the accompanying materials are made available under
6   the terms of the Eclipse Public License 2.0 which is available at
7   http://www.eclipse.org/legal/epl-2.0
8
9   SPDX-License-Identifier: EPL-2.0
10
11   Contributors:
12      Marc R. Hoffmann - initial API and implementation
13-->
14
15<xsl:stylesheet version="1.0"
16	xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
17	xmlns="http://www.w3.org/1999/xhtml" exclude-result-prefixes="xdoc">
18
19	<xsl:output method="xml" indent="yes" encoding="UTF-8"
20		doctype-public="-//W3C//DTD XHTML 1.0 Strict//EN" doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd" />
21
22	<xsl:param name="qualified.bundle.version" />
23	<xsl:param name="jacoco.home.url" />
24	<xsl:param name="copyright.years" />
25
26	<xsl:template match="/">
27		<html>
28			<head>
29				<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
30				<link rel="stylesheet" href="resources/doc.css" charset="UTF-8"
31					type="text/css" />
32				<link rel="shortcut icon" href="resources/report.gif" type="image/gif" />
33				<title>
34					JaCoCo - Command Line Interface
35				</title>
36			</head>
37			<body>
38				<div class="breadcrumb">
39					<a href="../index.html" class="el_report">JaCoCo</a> &gt;
40					<a href="index.html" class="el_group">Documentation</a> &gt;
41					<span class="el_source">Command Line Interface</span>
42				</div>
43				<div id="content">
44
45					<h1>Command Line Interface</h1>
46
47					<p>
48					  JaCoCo comes with a command line interface to perform
49					  basic operations from the command line. The command line
50					  tools with all dependencies are packaged in
51					  <code>jacococli.jar</code> and are available with the
52					  JaCoCo download. Java 1.5 or greater is required for
53					  execution.
54					</p>
55
56					<p>
57					  For more sophisticated usage especially with larger
58					  projects please use our
59					  <a href="integrations.html">integrations</a> with various
60					  build tools.
61					</p>
62
63					<p>
64					  The following commands are available. Each command has a
65					  list of optional and required parameters. Some parameters
66					  can be specified multiple times to provide multiple values.
67					</p>
68
69					<p class="hint">
70					  <b>Warning:</b> Although a <code>instrument</code> command
71					  is provided the preferred way for code coverage analysis
72					  with JaCoCo is on-the-fly instrumentation with the
73					  <a href="agent.html">JaCoCo agent</a>. Offline
74					  instrumentation has several drawbacks and should only be
75					  used if a specific scenario explicitly requires this mode.
76					  Please consult <a href="offline.html">documentation</a>
77					  about offline instrumentation before using this mode.
78					</p>
79
80					<xsl:apply-templates select="documentation" />
81				</div>
82				<div class="footer">
83					<span class="right">
84						<a href="{$jacoco.home.url}">JaCoCo</a>
85						&#160;
86						<xsl:value-of select="$qualified.bundle.version" />
87					</span>
88					<a href="../doc/license.html">Copyright</a>
89					&#169;
90					<xsl:value-of select="$copyright.years" />
91					Mountainminds GmbH &amp; Co. KG and Contributors
92				</div>
93			</body>
94		</html>
95	</xsl:template>
96
97	<xsl:template match="command">
98		<h2><xsl:value-of select="@name" /></h2>
99		<pre class="source" style="white-space: pre-wrap">
100			<xsl:value-of select="usage" />
101		</pre>
102		<p><xsl:value-of select="description" /></p>
103		<table class="coverage">
104			<thead>
105				<tr>
106					<td>Option</td>
107					<td>Description</td>
108					<td>Required</td>
109					<td>Multiple</td>
110				</tr>
111			</thead>
112			<tbody>
113				<xsl:for-each select="option">
114					<tr>
115						<td><code><xsl:value-of select="usage" /></code></td>
116						<td><xsl:value-of select="description" /></td>
117						<td style="text-align:center"><xsl:if test="@required = 'true'">&#x25fc;</xsl:if></td>
118						<td style="text-align:center"><xsl:if test="@multiple = 'true'">&#x25fc;</xsl:if></td>
119					</tr>
120				</xsl:for-each>
121			</tbody>
122		</table>
123	</xsl:template>
124
125</xsl:stylesheet>
126