build.xhtml revision e7b21c8124ec55ffacc49c1e28a8685834715484
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt<?xml version="1.0" encoding="UTF-8"?>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt<html xmlns="http://www.w3.org/1999/xhtml">
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <head>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <title>How to build {OpenGrok</title>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt </head>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <body>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <h1>How to build {OpenGrok</h1>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <p>The easiest way to build (or modify) {OpenGrok is by using
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <a href="http://www.netbeans.org">NetBeans</a>, but you can also build
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt {OpenGrok from the command line.
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt </p>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <h2>Requirements</h2>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <p>You need the following:</p>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <ul>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <li><a href="http://java.sun.com/javase/downloads/index.jsp">JDK</a>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt 1.6 or higher</li>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <li><a href="http://ant.apache.org/">Apache Ant</a> 1.8 or later
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt if you don't intend to build using NetBeans</li>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <li>The source code is located in a
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <a href="http://www.selenic.com/mercurial/wiki/">Mercurial</a>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt repository</li>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <li>The analyzers are generated from lex by using
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <a href="http://jflex.de/">JFlex</a></li>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt </ul>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <h2>Check out the source</h2>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <p>The first thing you need to do is to check out the source code. You
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt might do this from within NetBeans if you have the Mercurial plugin
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt installed, or you can check out the source with the following
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt command:
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt </p>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <pre>git clone https://github.com/OpenGrok/OpenGrok</pre>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <h2>Prepare the source for compilation</h2>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <p>Copy <code>JFlex.jar</code> into the <code>lib</code> directory in
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt the OpenGrok source. (If you are using NetBeans, you could
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt alternatively add JFlex.jar to Ant's classpath at
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt Tools-&gt;Options-&gt;Miscellaneous-&gt;Ant. If you are
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt running Ant from the command line, it should also work if you put
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt JFlex.jar into your <code>~/.ant/lib</code> directory.)
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt </p>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <h2>Compile the source</h2>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <p>If you use NetBeans you should be able to open OpenGrok as a project
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt and build it from there. If you want to build from the command line,
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt execute the following command:</p>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <pre>ant</pre>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt <p>If the build is successful, you should now find the
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt binaries under the <code>dist</code> directory.</p>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt </body>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt</html>
f3ad877eb05befbc862b0233d985758c0caef29aEvan Hunt