blob: 8c7fefac19fdc3f61a5de725b5b46bc03c0cd5dc [file] [log] [blame]
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<title>ASF: Installing Xalan-C++</title>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="resources/apache-xalan.css" />
</head>
<!--
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
-->
<body>
<div id="title">
<table class="HdrTitle">
<tbody>
<tr>
<th rowspan="2">
<a href="../index.html">
<img alt="Trademark Logo" src="resources/XalanC-Logo-tm.png" width="190" height="90" />
</a>
</th>
<th text-align="center" width="75%">
<a href="index.html">Xalan-C/C++ Version 1.11</a>
</th>
</tr>
<tr>
<td valign="middle">Installing Xalan-C++</td>
</tr>
</tbody>
</table>
<table class="HdrButtons" align="center" border="1">
<tbody>
<tr>
<td>
<a href="http://www.apache.org">Apache Foundation</a>
</td>
<td>
<a href="http://xalan.apache.org">Xalan Project</a>
</td>
<td>
<a href="http://xerces.apache.org">Xerces Project</a>
</td>
<td>
<a href="http://www.w3.org/TR">Web Consortium</a>
</td>
<td>
<a href="http://www.oasis-open.org/standards">Oasis Open</a>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navLeft">
<ul>
<li>
<a href="resources.html">Resources</a>
<br />
</li>
<li>
<a href="../index.html">Home</a>
</li></ul><hr /><ul>
<li>
<a href="index.html">Xalan-C++ 1.11</a>
</li>
<li>
<a href="whatsnew.html">What's New</a>
</li>
<li>
<a href="license.html">Licenses</a>
</li></ul><hr /><ul>
<li>
<a href="overview.html">Overview</a>
</li>
<li>
<a href="charter.html">Charter</a>
</li></ul><hr /><ul>
<li>
<a href="download.html">Download</a>
</li>
<li>
<a href="buildlibs.html">Build Libraries</a>
</li>
<li>Installation<br />
</li>
<li>
<a href="builddocs.html">Build Documents</a>
</li></ul><hr /><ul>
<li>
<a href="samples.html">Sample Apps</a>
</li>
<li>
<a href="commandline.html">Command Line</a>
</li>
<li>
<a href="usagepatterns.html">Usage Patterns</a>
</li></ul><hr /><ul>
<li>
<a href="programming.html">Programming</a>
</li>
<li>
<a href="extensions.html">Extensions</a>
</li>
<li>
<a href="extensionslib.html">Extensions Library</a>
</li>
<li>
<a href="apiDocs/index.html">API Reference</a>
</li></ul><hr /><ul>
<li>
<a href="faq.html">Xalan-C FAQs</a>
</li></ul><hr /><ul>
<li>
<a href="whatsnew.html#bugs">Bugs</a>
</li>
<li>
<a href="http://xml.apache.org/xalan-j/test/run.html#how-to-run-c">Testing</a>
</li>
<li>
<a href="secureweb.html">Web Security</a>
</li>
</ul>
</div>
<div id="content">
<h2>Installing Xalan-C++</h2>
<ul>
<li>
<a href="#SourcePkgs">Install Source Packages</a>
</li>
<li>
<a href="#BinaryPkgs">Install Binary Packages</a>
</li>
<ul>
<li>
<a href="#InsWin">Install Windows Packages</a>
</li>
<li>
<a href="#InsUnx">InstallUNIX Packages</a>
</li>
<li>
<a href="#InsPkgs">Other Packages</a>
</li>
</ul>
<li>
<a href="#XalanDocPkg">Install Documentation Packages</a>
</li>
<ul>
<li>
<a href="">Xalan-C User Guide</a>
</li>
<li>
<a href="">Xalan-C API Reference</a>
</li>
</ul>
</ul>
<p>A pre-requisite for using the Xalan-C/C++ XSLT library is to
have a working Xerces-C/C++ XML Parser library. Xerces-C/C++
must be of version 3.0 or newer. Xerces-C/C++ Version 3.1.1 is preferred.
</p>
<p>The Xalan-C/C++ project is providing several types of packages.
</p>
<p>Source packages contain all of the source code to build the
Xalan-C/C++ library, the sample programs, and the documentation.
There are UNIX scripts and Windows project files by which the
library and sample programs can be built.
There are also scripts for building the User Guide web pages and
a Doxygen configuration for building the interactive API Reference.
</p>
<p>Binary packages contain compiled libraries and the Xalan
command line program. The binary packages also contain C/C++
header files for basic software development.
</p>
<p>Documentation packages contain pre-built directories of web
page html files for the Xalan-C/C++ User Guide and the interactive
API Reference for programmers.
</p>
<a name="SourcePkgs">&#8204;</a>
<p align="right" size="2">
<a href="#content">(top)</a>
</p>
<h3>Install Source Packages</h3>
<p>We have no package managers for source packages. You just extract
the contents of the distribution <b>
<i>zip</i>
</b> file or <b>
<i>tar</i>
</b> file
into a source directory of your choosing.
</p>
<p>You also need to have the necessary C/C++ compiler tools installed
and a working copy of the Xerces-C/C++ XML parser library.
</p>
<p>Building the
<a href="builddocs.html#buildweb">User Guide</a>
from sources requires a working Xalan command line program.
</p>
<p>Building the interactive
<a href="builddocs.html#buildapi">API Reference</a>
requires a UNIX or Linux system with a current copy of
Doxygen and GraphViz installed.
</p>
<p>The building of a library from sources results in a directory from which
a binary package can be made.
<a href="buildlibs.html#unixbldenv">UNIX and Linux builds</a>
are automatically targeted to an install destination.
<a href="buildlibs.html#winbldinst">Installing a Windows build</a>
requires that the specific compiled products be copied to a usable
destination directory.
</p>
<a name="BinaryPkgs">&#8204;</a>
<p align="right" size="2">
<a href="#content">(top)</a>
</p>
<h3>Install Binary Packages</h3>
<p>The binary packages distributed by <b>
<i>zip</i>
</b> files
and <b>
<i>tar</i>
</b> files are usually extracted to the install
<code>{target}</code> directory.
After extracting the contents, you then need to manually perform
some minor system configuration.
</p>
<p>Packages that are handled by a package manager are usually
installed and configured according to package maintainer.</p>
<a name="InsWin">&#8204;</a>
<p align="right" size="2">
<a href="#content">(top)</a>
</p>
<h4>Install Windows Packages</h4>
<p>The Xalan-C and Xerces-C packages can be installed to the same
<code>{target}</code>
directory tree. The debug and release builds have different names
for the shared <code>*.DLL</code> files.
</p>
<p>Windows operating systems require that the <code>{target}\bin</code>
directory be added to the PATH environment. You can make the path
a permanent part of the SYSTEM or user login DESKTOP environment.
The PATH environment variable should contain an entry
where the <code>{target}\bin\*.DLL</code> files are found.
</p>
<ol>
<li>Right-Click on the computer icon.</li>
<li>Select Properties.</li>
<li>Select Advanced System Settings.</li>
<li>Select Environment Variables.</li>
<li>Add the <code>{target}\bin</code> directory to the
system PATH environment variable.</li>
</ol>
<p>The XP, NT, 2000 and 2003 systems allow environment variables to be
set explicitly to individual user accounts.
The Vista, Win-7, and 2008 systems have security administration that
gets in the way of updating individual user environments.
</p>
<p>In a command window or a command environment, you can add the following
shell command to set a temporary path to the XALAN <code>{target}\bin</code>
directory.
</p>
<blockquote class="source">
<pre>set PATH=%PATH%;{target}\bin</pre>
</blockquote>
<a name="InsUnx">&#8204;</a>
<p align="right" size="2">
<a href="#content">(top)</a>
</p>
<h4>Install UNIX Packages</h4>
<p>The path to the <code>Xalan</code> command line executable program should be added
to the PATH environment variable.</p>
<p>The path to the shared objects should be added to the system
configuration or overridden by specific entry in an environment
by which shared objects can be found.</p>
<p>Here is some more detailed information on
<a href="buildlibs.html#unixlibpath">UNIX Runtime</a> configuration.
</p>
<a name="InsPkgs">&#8204;</a>
<p align="right" size="2">
<a href="#content">(top)</a>
</p>
<h4>Install Other Packages</h4>
<p>These packages are usually installed and configured by a package manager.
You should refer to the documentation provided by the package maintainer.
</p>
<a name="XalanDocPkg">&#8204;</a>
<p align="right" size="2">
<a href="#content">(top)</a>
</p>
<h3>Install Documentation Packages</h3>
<p>The documentation packages are distributed as <b>
<i>tar</i>
</b> files
and <b>
<i>zip</i>
</b> files. You just extract the files into a directory
that is reachable by your favorite web browser. The head of the
documentation tree starts at the <a href="index.html">
<code>{docs}/xalan-c</code>
</a> directory.
</p>
<p>
<b>TO DO:</b>
</p>
<p>Rework the xalan/c/trunk/xdocs/sources/ scripts so that the
source documentation builds are
targeted to the xalan/c/trunk/build/docs/xalan-c/ directory path.
</p>
<p>Add a documentation script that performs a post-processing
operation when building the API Reference from Doxygen to relocate
the constructed products to the xalan/c/trunk/build/docs/xalan-c/apiDocs/
directory path.
</p>
<p>Details are found in our <a href="builddocs.html">Build Documents</a> pages.
</p>
<a name="DocWebPkg">&#8204;</a>
<p align="right" size="2">
<a href="#content">(top)</a>
</p>
<h4>Install Xalan-C User Guide</h4>
<p>Extract the distributed <b>
<i>tar</i>
</b> file or <b>
<i>zip</i>
</b>
file to the <code>{docs}</code> directory. The package populates
the <code>{docs}/xalan-c/*</code> directory containing the Xalan-C
User Guide web pages.
</p>
<a name="DocApiPkg">&#8204;</a>
<p align="right" size="2">
<a href="#content">(top)</a>
</p>
<h4>Install Xalan-C API Reference</h4>
<p>Extract the distributed <b>
<i>tar</i>
</b> file or <b>
<i>zip</i>
</b>
file to the <code>{docs}</code> directory. The package populates
the <code>{docs}/xalan-c/apiDocs/*</code> directory containing the
Xalan-C API Reference for programmers.
</p>
<p align="right" size="2">
<a href="#content">(top)</a>
</p>
</div>
<div id="footer">Copyright © 1999-2012 The Apache Software Foundation<br />Apache, Xalan, and the Feather logo are trademarks of The Apache Software Foundation<div class="small">Web Page created on - Fri 06/15/2012</div>
</div>
</body>
</html>