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