| <?xml version="1.0" encoding="UTF-8"?> |
| <!-- |
| Copyright 2002-2004 The Apache Software Foundation |
| |
| Licensed under the Apache License, Version 2.0 (the "License"); |
| you may not use this file except in compliance with the License. |
| You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://apache.org/forrest/dtd/document-v12.dtd"> |
| <document> |
| <header> |
| <title>Building Forrest</title> |
| </header> |
| <body> |
| <section id="getting_from_source"> |
| <title>Getting the Forrest source</title> |
| <section> |
| <title>Step-by-step Subversion (SVN) instructions</title> |
| <note>If you are behind a proxy, see <link |
| href="http://subversion.tigris.org/project_faq.html#proxy">this FAQ</link>.</note> |
| <ol> |
| <li>Make sure you have a recent release of <link href="http://subversion.tigris.org/">Subversion</link> installed.</li> |
| <li>At a command prompt, enter "<code>svn co http://svn.apache.org/repos/asf/xml/forrest/trunk forrest</code>"</li> |
| <li>This will create a directory called "<code>forrest</code>" where the Forrest source will be stored.</li> |
| </ol> |
| <p>In case you want to update your Forrest source tree to the current version, change to the |
| "<code>forrest</code>" directory and invoke "<code>svn up</code>".</p> |
| <p>To see what changes you've made, invoke "<code>svn stat</code>"</p> |
| </section> |
| </section> |
| |
| <section id="building"> |
| <title>Building and Installing Forrest</title> |
| <p> |
| To build Forrest, type <code>build</code> on Windows, or <code>./build.sh</code> on |
| Unix. If everything is successful, you should see a message like this: |
| </p> |
| <source> |
| *----------------------------------------------------------------- |
| | installation notice |
| *----------------------------------------------------------------- |
| | You have succesfully built the shell-bat distribution of Forrest. |
| | Please find it at: ./build/dist/shbat |
| | Please copy the contents to the install directory of your choice |
| | Please have the environment variable FORREST_HOME point to it. |
| | It is recommended to add |
| | unix: $FORREST_HOME/bin: to your $PATH |
| | win: %FORREST_HOME%\bin; to your %PATH% |
| | Calling |
| | unix: $FORREST_HOME/bin/forrest -projecthelp |
| | win: %FORREST_HOME%\bin\forrest -projecthelp |
| | will list options for the 'forrest' command |
| | More help at http://xml.apache.org/forrest/ and forrest-dev@xml.apache.org |
| *----------------------------------------------------------------- |
| </source> |
| <p> |
| You now have the binary distribution built in <code>build/dist/shbat</code>. |
| Copy it somewhere more sensible if you like (e.g. |
| <code>/usr/local/forrest</code> on Unix), though if you intend to update your |
| Forrest from SVN, leaving it where it is would be best.</p> |
| <p> |
| As the message says, you need to add the distribution's <code>bin/</code> |
| ("binary") directory to your PATH variable, so the <code>'forrest'</code> |
| command is available everywhere: |
| </p> |
| <source> |
| ~/apache/xml-forrest$ export FORREST_HOME=`pwd`/build/dist/shbat |
| ~/apache/xml-forrest$ export PATH=$PATH:$FORREST_HOME/bin |
| </source> |
| <p> |
| After updating the Forrest source from SVN, or after you have made changes, you |
| will need to build forrest again. In Windows, run <code>build</code>. In Unix, |
| run <code>./build.sh</code> |
| </p> |
| </section> |
| |
| </body> |
| </document> |
