You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@etch.apache.org by ve...@apache.org on 2011/12/15 15:35:39 UTC
svn commit: r1214782 [5/5] - in /incubator/etch/site/trunk/content/etch: ./
documentation/ documentation/architecture.data/
documentation/howto-logger-filter.data/ documentation/resources/
Added: incubator/etch/site/trunk/content/etch/documentation/setup-guide-for-users.html
URL: http://svn.apache.org/viewvc/incubator/etch/site/trunk/content/etch/documentation/setup-guide-for-users.html?rev=1214782&view=auto
==============================================================================
--- incubator/etch/site/trunk/content/etch/documentation/setup-guide-for-users.html (added)
+++ incubator/etch/site/trunk/content/etch/documentation/setup-guide-for-users.html Thu Dec 15 14:35:38 2011
@@ -0,0 +1,307 @@
+
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<HTML>
+ <HEAD>
+ <LINK type="text/css" rel="stylesheet" href="resources/space.css">
+ <STYLE type="text/css">
+ .footer {
+ background-image: url('https://cwiki.apache.org/confluence/images/border/border_bottom.gif');
+ background-repeat: repeat-x;
+ background-position: left top;
+ padding-top: 4px;
+ color: #666;
+ }
+ </STYLE>
+ <SCRIPT type="text/javascript" language="javascript">
+ var hide = null;
+ var show = null;
+ var children = null;
+
+ function init() {
+ /* Search form initialization */
+ var form = document.forms['search'];
+ if (form != null) {
+ form.elements['domains'].value = location.hostname;
+ form.elements['sitesearch'].value = location.hostname;
+ }
+
+ /* Children initialization */
+ hide = document.getElementById('hide');
+ show = document.getElementById('show');
+ children = document.all != null ?
+ document.all['children'] :
+ document.getElementById('children');
+ if (children != null) {
+ children.style.display = 'none';
+ show.style.display = 'inline';
+ hide.style.display = 'none';
+ }
+ }
+
+ function showChildren() {
+ children.style.display = 'block';
+ show.style.display = 'none';
+ hide.style.display = 'inline';
+ }
+
+ function hideChildren() {
+ children.style.display = 'none';
+ show.style.display = 'inline';
+ hide.style.display = 'none';
+ }
+ </SCRIPT>
+ <TITLE>Setup Guide for Users</TITLE>
+ <META http-equiv="Content-Type" content="text/html;charset=UTF-8"></HEAD>
+ <BODY onload="init()">
+ <DIV id="PageContent">
+ <DIV class="pagecontent">
+ <DIV class="wiki-content">
+
+<TABLE>
+<TR>
+<TD class="" valign="top" width="90%">
+<P><H1><A name="SetupGuideforUsers-GettingStarteddocumentationforupcomingRelease1.1"></A>Getting Started documentation for upcoming Release 1.1</H1>
+
+<H2><A name="SetupGuideforUsers-BinaryDistribution"></A>Binary Distribution</H2>
+
+<P>The top-level structure of the install image is:</P>
+
+<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
+<PRE class="code-java">
+ ChangeLog.txt
+ DISCLAIMER.txt
+ LICENSE.txt
+ LICENSE_THIRD_PARTY.txt
+ NOTICE.txt
+ NOTICE_THIRD_PARTY.txt
+ README.txt
+ RELEASE_NOTES.txt
+ bin/
+ examples/
+ lib/
+ binding-c/
+ binding-csharp/
+ binding-java/
+ uninst.exe (<SPAN class="code-keyword">for</SPAN> windows use only)
+</PRE>
+</DIV></DIV>
+
+<P>Please take a moment to review the RELEASE_NOTES.txt, ChangeLog.txt and<BR>
+LICENSE.txt files.</P>
+
+<P>The Windows installer (apache-etch-1.1.0-incubating-setup.exe) has created a <BR>
+user environment variable (ETCH_HOME) which points to the Etch installation<BR>
+directory. If you installed Etch using either</P>
+
+<P> apache-etch-1.1.0-incubating-windows-x86-bin.zip</P>
+
+<P>or</P>
+
+<P> apache-etch-1.1.0-incubating-linux-x86-bin.tgz</P>
+
+<P>you will want to create this environment variable yourself:</P>
+
+<P>windows:</P>
+<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
+<PRE class="code-java">
+ set ETCH_HOME=C:\Program Files\Apache Software Foundation\apache-etch-1.1.0
+</PRE>
+</DIV></DIV>
+
+<P>*nix:</P>
+<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
+<PRE class="code-java">
+ export ETCH_HOME=/path/to/apache-etch-1.1.0
+</PRE>
+</DIV></DIV>
+
+<P>The bin directory has also been put on your path by the Windows installer. If<BR>
+you are using the archives, you will need to do this yourself:</P>
+
+<P>windows:</P>
+<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
+<PRE class="code-java">
+ PATH %PATH%;%ETCH_HOME%\bin
+</PRE>
+</DIV></DIV>
+
+<P>*nix:</P>
+<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
+<PRE class="code-java">
+ export PATH=<SPAN class="code-quote">"$PATH:$ETCH_HOME/bin"</SPAN>
+</PRE>
+</DIV></DIV>
+
+<P>The bin/ directory contains a Windows bat script and a unix shell script.</P>
+
+<P>You will also need to have a java runtime installed (later versions of sun jre<BR>
+or jdk 1.5 or any version of 1.6 or later). A JAVA_HOME environment variable<BR>
+should point to the installation directory of the java runtime. If you are going<BR>
+to compile java source you will need the jdk.</P>
+
+<P>After the installer has been run and the environment setup, at a windows<BR>
+command line or shell prompt, you should be able to run the etch compiler and<BR>
+see some basic output:</P>
+
+<P>windows:</P>
+<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
+<PRE class="code-java">
+ C:\>etch -v
+ Etch version is Apache Etch 1.1.0-incubating (some build info)
+</PRE>
+</DIV></DIV>
+
+<P>unix:</P>
+<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
+<PRE class="code-java">
+ bash-3.2$ etch -v
+ Etch version is Apache Etch 1.1.0-incubating (some build info)
+</PRE>
+</DIV></DIV>
+
+<P>The lib directory contains the various jar files for the compiler and the Apache Velocity dependency jar:</P>
+
+<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
+<PRE class="code-java">
+ apache-etch-java-compiler-1.1.0-incubating.jar
+ apache-etch-java-compiler-1.1.0-incubating-src.jar
+ ...
+</PRE>
+</DIV></DIV>
+
+<P>The top level folders binding-c, binding-java and binding-csharp contain the language specific <BR>
+runtime libraries:</P>
+
+<H2><A name="SetupGuideforUsers-BindingforJava"></A>Binding for Java</H2>
+
+<P>binding-java is organized as follows:</P>
+
+<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
+<PRE class="code-java">
+ apache-etch-java-runtime-1.1.0-incubating-src.zip
+ lib/
+ apache-etch-java-runtime-1.1.0-incubating.jar
+</PRE>
+</DIV></DIV>
+
+<P>The generated java source from the etch compiler needs apache-etch-java-runtime-1.1.0-incubating.jar.<BR>
+There is source code to go with it in apache-etch-java-runtime-1.1.0-incubating-src.zip.</P>
+
+<H2><A name="SetupGuideforUsers-BindingforC%23"></A>Binding for C#</H2>
+
+<P>binding-csharp is organized as follows:</P>
+
+<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
+<PRE class="code-java">
+ apache-etch-csharp-runtime-1.1.0-incubating-src.zip
+ lib/
+ ApacheEtchCsharpIncubating.dll
+ ApacheEtchCsharpIncubating.pdb
+</PRE>
+</DIV></DIV>
+
+<P>The generated c# source from the etch compiler needs ApacheEtchCsharpIncubating.dll<BR>
+The C# (.NET 2.0 and later) ApacheEtchCsharpIncubating.dll should be added to any C# projects.<BR>
+There is source code to go with it in apache-etch-csharp-runtime-1.1.0-incubating-src.zip.</P>
+
+<H2><A name="SetupGuideforUsers-BindingforC"></A>Binding for C</H2>
+
+<P>binding-c is organized as follows:</P>
+
+<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
+<PRE class="code-java">
+ bin/
+ apr-1-config (on linux)
+ apriconv (on linux)
+ include/
+ [etch-*].h (on win32)
+ apr-1 (on linux)
+ lib/
+ etch.lib (on win32)
+ etch.pdb (on win32)
+ libetch.a (on linux)
+ extern/
+ apr/
+ bin/
+ libapr-1.dll (on win32)
+ libapr-1.pdb (on win32)
+ libapriconv-1.dll (on win32)
+ libapriconv-1.pdb (on win32)
+ iconv/
+ [iconv*]-stuff
+ include/
+ [apr-*].h
+ lib/
+ libapr-1.lib (on win32)
+ libapriconv-1.lib (on win32)
+ libapr-1.so (on linux)
+ libapriconv-1.so (on linux)
+ apache-etch-c-runtime-1.1.0-incubating-src.zip
+</PRE>
+</DIV></DIV>
+
+<P>Generated C source depends on the dlls/so/a/h files mentioned above. The best choice to <BR>
+build generated code using the c binding is cmake. You can use the examples/helloworld <BR>
+example as a reference. The C binding has external dependencies to the Apache Portable <BR>
+Runtime (APR). We ship dll/so/h for the apr in the extern folder. There is source code <BR>
+to go with it in apache-etch-c-runtime-1.1.0-incubating-src.zip</P>
+
+<H2><A name="SetupGuideforUsers-AntPlugin"></A>Ant Plugin</H2>
+
+<P>There is an ant plugin which you can use with ant 1.7.0 or later to invoke the<BR>
+compiler as a task. It is documented on the wiki referenced above. You can also see examples <BR>
+of its usage in the build.xml files in the examples folder</P>
+
+<H2><A name="SetupGuideforUsers-Maven"></A>Maven</H2>
+
+<P>If you are using maven, then you might want to install the Etch artifacts into<BR>
+your local maven repository. There is a Windows bat script to do this in the<BR>
+maven directory:</P>
+
+<P> etch-maven-install.bat</P>
+
+<P>You need to have maven on your path when you run this script. The file<BR>
+etch-java-runtime-1.1.0.jar will be installed into your local repository with<BR>
+group "etch.etch", artifact id "etch-java-runtime", and version "1.1.0". You<BR>
+may then reference Etch from your maven projects.</P>
+
+<H2><A name="SetupGuideforUsers-PythonandXMLBindings"></A>Python and XML Bindings</H2>
+
+<P>The source distribution includes code to support XML and python bindings, but<BR>
+these bindings are not yet complete, and there is no build products associated<BR>
+with those. They are mainly there to 1) capture the code contribution from<BR>
+cisco systems, and 2) inspire any fence sitters, ah, helpers to jump in and<BR>
+contribute.</P>
+
+<H2><A name="SetupGuideforUsers-Examples"></A>Examples</H2>
+
+<P>Examples have been provided in the examples/ subdirectory. Start with the HelloWorld<BR>
+example, it contains code for all three language bindings. There is a readme<BR>
+file in each example's directory which explains how to build and run it.</P>
+
+<H2><A name="SetupGuideforUsers-Tests"></A>Tests</H2>
+
+<P>Unit tests can be had by checking out the source code from the subversion<BR>
+repository and performing a complete build:</P>
+
+<P> <A href="http://svn.apache.org/repos/asf/incubator/etch/releases/release-1.1.0-incubating" class="external-link" rel="nofollow">http://svn.apache.org/repos/asf/incubator/etch/releases/release-1.1.0-incubating</A></P>
+
+<H2><A name="SetupGuideforUsers-Help"></A>Help</H2>
+
+<P>For help, see the wiki or send email to etch-user@incubator.apache.org. See<BR>
+RELEASE_NOTES.txt for specific information for this release.</P></P></TD></TR></TBODY></TABLE>
+ </DIV>
+
+
+
+ </DIV>
+ </DIV>
+ <!--
+ <div class="footer">
+ Generated by
+ <a href="http://www.atlassian.com/confluence/">Atlassian Confluence</a> (Version: 3.2 Build: 1810 Mar 16, 2010)
+ <a href="http://could.it/autoexport/">Auto Export Plugin</a> (Version: 1.0.0- dkulp)
+ </div>
+ -->
+ </BODY>
+</HTML>