You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xerces.apache.org by tn...@apache.org on 2002/04/01 23:10:44 UTC
cvs commit: xml-xerces/c/doc build-misc.xml build-other.xml build-winunix.xml build.xml install.xml
tng 02/04/01 13:10:44
Modified: c/doc build-misc.xml build-other.xml build-winunix.xml
build.xml install.xml
Log:
Doc Update: Clarify some installation / build instructions.
Revision Changes Path
1.8 +3 -2 xml-xerces/c/doc/build-misc.xml
Index: build-misc.xml
===================================================================
RCS file: /home/cvs/xml-xerces/c/doc/build-misc.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- build-misc.xml 7 Mar 2002 15:53:40 -0000 1.7
+++ build-misc.xml 1 Apr 2002 21:10:43 -0000 1.8
@@ -3,8 +3,9 @@
<s1 title="Other Build Instructions">
<anchor name="ICUPerl"/>
- <s2 title="Building &XercesCName; with ICU using bundled Perl scripts on Windows">
- <p>As mentioned earlier, &XercesCName; may be built in stand-alone mode using
+ <s2 title="Building &XercesCName; with ICU using bundled Perl scripts">
+ <p>The following instruction is for Windows environment. But the idea is similar on UNIX platforms.</p>
+ <p>&XercesCName; may be built in stand-alone mode using
native encoding support and also using ICU where you get support over 180
different encodings. ICU stands for International Components for Unicode and is an
open source distribution from IBM. You can get
1.13 +6 -8 xml-xerces/c/doc/build-other.xml
Index: build-other.xml
===================================================================
RCS file: /home/cvs/xml-xerces/c/doc/build-other.xml,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- build-other.xml 7 Mar 2002 15:53:40 -0000 1.12
+++ build-other.xml 1 Apr 2002 21:10:43 -0000 1.13
@@ -299,11 +299,9 @@
<anchor name="OS2VisualAge"/>
<s2 title="Building &XercesCName; on OS/2 using Visual Age C++">
- <p>OS/2 is a favourite IBM PC platforms. The only
- option in this platform is to use
+ <p>Here are the steps you need to build &XercesCName; from the source distribution using
<jump href="http://www-4.ibm.com/software/ad/vacpp/">Visual Age C++ compiler</jump>.
- Here are the steps you need to build &XercesCName; using
- Visual Age C++ on OS/2.</p>
+ on OS/2.</p>
<s3 title="Building &XercesCName; library">
<p><em>Requirements:</em></p>
<ul>
@@ -400,17 +398,17 @@
for OS/2 (VAC++).</p>
<ul>
- <li> In the <code>XercesCSrcInstallDir;\samples\Projects\OS2\VACPP40</code> directory,
+ <li> In the <code>&XercesCSrcInstallDir;\samples\Projects\OS2\VACPP40</code> directory,
find and edit the VAC++ configuration file <code>basedir.icc</code>.</li>
<li>All of the directories used to build the samples are defined in
<code>basedir.icc</code>. You need to edit the directories to match your system.
Here are the directories you need to assign:
- SRC_DIR -- <code>XercesCSrcInstallDir;</code>
+ SRC_DIR -- <code>&XercesCSrcInstallDir;</code>
This is where VAC++ should look to find the samples
directories containing the source files.
- BASE_DIR -- The install directory <code>XercesCSrcInstallDir;</code>.
+ BASE_DIR -- The install directory <code>&XercesCSrcInstallDir;</code>.
VAC++ will store the compiled samples in the <code>bin</code>
directory under BASE_DIR. It will also look for the
<code>xerces-c.lib</code> file in the <code>lib</code> directory under BASE_DIR.
@@ -422,7 +420,7 @@
<li>Start the Command Line in the VAC++ folder.</li>
- <li>Navigate to the <code>XercesCSrcInstallDir;\samples\Projects\OS2\VACPP40</code> directory.</li>
+ <li>Navigate to the <code>&XercesCSrcInstallDir;\samples\Projects\OS2\VACPP40</code> directory.</li>
<li>Run <code>bldsamples.cmd</code></li>
1.15 +6 -49 xml-xerces/c/doc/build-winunix.xml
Index: build-winunix.xml
===================================================================
RCS file: /home/cvs/xml-xerces/c/doc/build-winunix.xml,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- build-winunix.xml 7 Mar 2002 15:53:40 -0000 1.14
+++ build-winunix.xml 1 Apr 2002 21:10:43 -0000 1.15
@@ -4,12 +4,12 @@
<s1 title="Building on Windows and UNIX">
<anchor name="WinNT"/>
<s2 title="Building &XercesCName; on Windows NT/2000">
- <p>&XercesCName; comes with Microsoft Visual C++ projects and workspaces to
+ <p>&XercesCName; source distribution comes with Microsoft Visual C++ projects and workspaces to
help you build &XercesCName;. The following describes the steps you need
to build &XercesCName;.</p>
<s3 title="Building &XercesCName; library">
- <p>To build &XercesCName; from it source (using MSVC), you will
+ <p>To build &XercesCName; from the source distribution (using MSVC), you will
need to open the workspace containing the project. If you are
building your application, you may want to add the &XercesCName;
project inside your applications's workspace.</p>
@@ -43,53 +43,9 @@
</s3>
</s2>
- <anchor name="WinVisualAge"/>
- <s2 title="Building &XercesCName; on Windows using Visual Age C++">
- <p>A few unsupported projects are also packaged with &XercesCName;. Due to
- origins of &XercesCName; inside IBM labs, we do have projects for IBM's
- <jump href="http://www-4.ibm.com/software/ad/vacpp/">Visual Age C++ compiler</jump> on Windows.
- The following describes the steps you need to build &XercesCName; using
- Visual Age C++.</p>
-
- <s3 title="Building &XercesCName; library">
- <p><em>Requirements:</em></p>
-
- <ul>
- <li>VisualAge C++ Version 4.0 with Fixpak 1:
- <br/>Download the
- <jump href="http://www-4.ibm.com/software/ad/vacpp/service/csd.html">Fixpak</jump>
- from the IBM VisualAge C++ Corrective Services web page.</li>
- </ul>
-
- <p>To include the ICU library:</p>
-
- <ul>
- <li>ICU Build:
- <br/>You should have the
- <jump href="http://oss.software.ibm.com/icu/">ICU Library</jump>
- in the same directory as the &XercesCName; library. For example if
- &XercesCName; is at the top level of the d drive, put the ICU
- library at the top level of d e.g. d:/&XercesCInstallDir; d:/icu.</li>
- </ul>
-
- <p><em>Instructions:</em></p>
- <ol>
- <li>Change the directory to d:\&XercesCInstallDir;\Projects\Win32</li>
- <li>If a d:\&XercesCInstallDir;\Project\Win32\VACPP40 directory does not exist, create it.</li>
- <li>Copy the IBM VisualAge project file, <code>XML4C2X.icc</code>,
- to the VACPP40 directory.</li>
- <li>From the VisualAge main menu enter the project file name and path.</li>
- <li>When the build finishes the status bar displays this message: Last Compile
- completed Successfully with warnings on date.</li>
- </ol>
- <note>These instructions assume that you install in drive d:\.
- Replace d with the appropriate drive letter.</note>
- </s3>
- </s2>
-
<anchor name="WinBorland"/>
<s2 title="Building &XercesCName; on Windows using Borland C++Builder">
- <p>&XercesCName; comes with Borland C++Builder projects to help you
+ <p>&XercesCName; sourec distribution comes with Borland C++Builder projects to help you
build &XercesCName;. The following describes the steps you need to build
&XercesCName;.</p>
@@ -178,7 +134,7 @@
understanding that you know how to interpret it for the other UNIX flavors.</p>
<note>If you wish to build &XercesCName; with ICU,
- look at the <jump href="build-misc.html#faq-1">Building ICU</jump>.
+ look at the <jump href="build-misc.html#faq-1">Building with ICU using bundled perl script</jump>.
It tells you where you can get ICU and how to build &XercesCName; with it.</note>
<s3 title="Setting build environment variables">
@@ -196,7 +152,8 @@
</s3>
<s3 title="Building &XercesCName; library">
- <p>As mentioned earlier, you must be ready with the GNU tools like
+ <p>As mentioned earlier, to build &XercesCName; from the source distribution,
+ you must be ready with the GNU tools like
<jump href="http://www.gnu.org/software/autoconf/autoconf.html">autoconf</jump> and
<jump href="http://www.gnu.org/software/make/make.html">gmake</jump>
before you attempt the build.</p>
1.21 +1 -2 xml-xerces/c/doc/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/xml-xerces/c/doc/build.xml,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -r1.20 -r1.21
--- build.xml 13 Feb 2002 19:49:39 -0000 1.20
+++ build.xml 1 Apr 2002 21:10:43 -0000 1.21
@@ -8,7 +8,6 @@
or jump directly to:</p>
<ul>
<li><jump href="build-winunix.html#WinNT">Building &XercesCName; on Windows NT/2000</jump></li>
- <li><jump href="build-winunix.html#WinVisualAge">Building &XercesCName; on Windows using Visual Age C++</jump></li>
<li><jump href="build-winunix.html#WinBorland">Building &XercesCName; on Windows using Borland C++Builder</jump></li>
<li><jump href="build-winunix.html#UNIX">Building &XercesCName; on UNIX platforms</jump></li>
<li><jump href="build-winunix.html#UNIX_SingleThread">Building &XercesCName; as a single-threaded library on Unix platforms</jump></li>
@@ -29,7 +28,7 @@
<p>Read the <jump href="build-misc.html">Other Build Instructions</jump> document
or jump directly to:</p>
<ul>
- <li><jump href="build-misc.html#ICUPerl">Building &XercesCName; with ICU using bundled Perl scripts on Windows</jump></li>
+ <li><jump href="build-misc.html#ICUPerl">Building &XercesCName; with ICU using bundled Perl scripts</jump></li>
<li><jump href="build-misc.html#WinCOM">Building &XercesCName; COM Wrapper on Windows</jump></li>
<li><jump href="build-misc.html#UserDoc">Building User Documentation</jump></li>
<li><jump href="build-misc.html#PortInfo">I wish to port &XercesCProjectName; to my favourite platform. Do you have any suggestions?</jump></li>
1.6 +60 -25 xml-xerces/c/doc/install.xml
Index: install.xml
===================================================================
RCS file: /home/cvs/xml-xerces/c/doc/install.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- install.xml 20 Feb 2002 21:01:56 -0000 1.5
+++ install.xml 1 Apr 2002 21:10:43 -0000 1.6
@@ -5,12 +5,27 @@
<s2 title="Windows NT/2000">
- <p>Install the binary &XercesCName; release by using <code>unzip</code>
- on the <ref>file</ref>-win32.zip archive in the Windows environment. You can
+ <s3 title="Source distribution">
+ <p>The &XercesCName; source is available in the source distribution.
+ </p>
+ <p>Install the &XercesCName; source distribution by using <code>unzip</code>
+ on the &XercesCSrcInstallDir;.zip archive in the Windows environment. You can
+ use WinZip, or any other UnZip utility.</p>
+<source>unzip &XercesCSrcInstallDir;.zip</source>
+ <p>This creates a '&XercesCSrcInstallDir;' sub-directory
+ containing the &XercesCName; source distribution. </p>
+
+ <p>If you need to build the &XercesCName; source after installation,
+ please follow the <jump href="build.html">Build Instructions</jump>.</p>
+
+ </s3>
+ <s3 title="Binary distribution">
+ <p>Install the &XercesCName; binary distribution by using <code>unzip</code>
+ on the &XercesCInstallDir;-win32.zip archive in the Windows environment. You can
use WinZip, or any other UnZip utility.</p>
<source>unzip &XercesCInstallDir;-win32.zip</source>
<p>This creates a '&XercesCInstallDir;-win32' sub-directory
- containing the &XercesCName; distribution. </p>
+ containing the &XercesCName; binary distribution. </p>
<p>You need to add the '&XercesCInstallDir;-win32\bin'
directory to your path: </p>
@@ -23,22 +38,49 @@
To do this under Windows 2000 add this line to your AUTOEXEC.BAT file:</p>
<source>SET PATH=<full_path_to_&XercesCInstallDir;>\bin;%PATH%</source>
<p>or run the <code>SET PATH</code> command in your shell window.</p>
+
+ <p>The binary distribution has the built parser library and some samples executables.
+ Please refer to the <jump href="samples.html">Samples</jump> for how to run the samples.</p>
+
+ </s3>
</s2>
<s2 title="UNIX">
- <p>Binary installation of this release is to extract the files from the
- compressed .tar archive (using 'tar').</p>
-<source>cd $HOME
+ <s3 title="Source distribution">
+ <p>The &XercesCName; source is available in the source distribution.
+ </p>
+ <p>Install the &XercesCName; source distribution &XercesCSrcInstallDir;.tar.gz by extracting the files
+ from the compressed archive.</p>
+<source>
+gunzip &XercesCSrcInstallDir;.tar.gz
+tar &XercesCSrcInstallDir;.tar
+</source>
+ <p>This creates a '&XercesCSrcInstallDir;' sub-directory
+ containing the &XercesCName; source distribution. </p>
+
+ <note>On Solaris, please use <code>gtar</code> instead of tar. See
+ <jump href="faq-distrib.html#faq-11">FAQ</jump> for more information.</note>
+
+ <p>If you need to build the &XercesCName; source after installation,
+ please follow the <jump href="build.html">Build Instructions</jump>.</p>
+
+ </s3>
+ <s3 title="Binary distribution">
+ <p>Install the binary distribution &XercesCInstallDir;-xxx.tar.gz by extracting the files
+ from the compressed archive; where 'xxx' is the corresponding UNIX platform.
+ For example:</p>
+<source>
gunzip &XercesCInstallDir;-linux.tar.gz
-tar -xvf &XercesCInstallDir;-linux.tar</source>
+tar -xvf &XercesCInstallDir;-linux.tar
+</source>
<p>This will create an '&XercesCInstallDir;-linux' sub-directory
- (in the home directory)
- which contains the &XercesCName; distribution. You will need to add the
- &XercesCInstallDir;-linux/bin directory to your PATH environment variable:</p>
+ containing the &XercesCName; binary distribution. </p>
- <note>On Solaris, you may need to use <code>gtar</code> instead of tar. See
+ <note>On Solaris, please use <code>gtar</code> instead of tar. See
<jump href="faq-distrib.html#faq-11">FAQ</jump> for more information.</note>
+ <p>You will need to add the
+ &XercesCInstallDir;-linux/bin directory to your PATH environment variable:</p>
<p>For Bourne Shell, K Shell or Bash, type: </p>
<source>export PATH="$PATH:$HOME/&XercesCInstallDir;-linux/bin"</source>
@@ -48,31 +90,24 @@
<p>If you wish to make this setting permanent, you need to change
your profile by changing your setup files which can be either .profile or .kshrc.</p>
- <p>In addition, you will also need to set the environment variables XERCESCROOT,
- ICUROOT and the library search path. (LIBPATH on AIX, LD_LIBRARY_PATH on
- Solaris and Linux, SHLIB_PATH on HP-UX).</p>
-
- <note>XERCESCROOT and ICUROOT are needed only if you intend to
- recompile the samples or build your own applications. The library path is
- necessary to link the shared libraries at runtime.</note>
+ <p>In addition, you will also need to set the library search path.
+ (LIBPATH on AIX, LD_LIBRARY_PATH on Solaris and Linux, SHLIB_PATH on HP-UX).</p>
<p>For Bourne Shell, K Shell or Bash, type:</p>
-<source>export XERCESCROOT=<wherever you installed &XercesCName;>
-export ICUROOT=<wherever you installed ICU>
+<source>
export LIBPATH=$XERCESCROOT/lib:$LIBPATH (on AIX)
export LD_LIBRARY_PATH=$XERCESCROOT/lib:$LD_LIBRARY_PATH (on Solaris, Linux)
export SHLIB_PATH=$XERCESCROOT/lib:$SHLIB_PATH (on HP-UX)</source>
<p>For C Shell, type:</p>
-<source>setenv XERCESCROOT "<wherever you installed &XercesCName;>"
-setenv ICUROOT "<wherever you installed ICU>"
+<source>
setenv LIBPATH "$XERCESCROOT/lib:$LIBPATH" (on AIX)
setenv LD_LIBRARY_PATH "$XERCESCROOT/lib:$LD_LIBRARY_PATH" (on Solaris, Linux)
setenv SHLIB_PATH "$XERCESCROOT/lib:$SHLIB_PATH" (on HP-UX)</source>
- <note>If you need to build the samples after installation,
- make sure you read and follow the <jump href="build.html">
- Build Instructions</jump>.</note>
+ <p>The binary distribution has the built parser library and some samples executables.
+ Please refer to the <jump href="samples.html">Samples</jump> for how to run the samples.</p>
+ </s3>
</s2>
</s1>
---------------------------------------------------------------------
To unsubscribe, e-mail: xerces-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: xerces-cvs-help@xml.apache.org