You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by ch...@apache.org on 2007/04/19 15:56:50 UTC
svn commit: r530416 -
/webservices/axis2/trunk/c/xdocs/docs/installationguide.html
Author: chatra
Date: Thu Apr 19 06:56:47 2007
New Revision: 530416
URL: http://svn.apache.org/viewvc?view=rev&rev=530416
Log:
reviewed and committing patch in https://issues.apache.org/jira/browse/AXIS2C-590
Modified:
webservices/axis2/trunk/c/xdocs/docs/installationguide.html
Modified: webservices/axis2/trunk/c/xdocs/docs/installationguide.html
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/xdocs/docs/installationguide.html?view=diff&rev=530416&r1=530415&r2=530416
==============================================================================
--- webservices/axis2/trunk/c/xdocs/docs/installationguide.html (original)
+++ webservices/axis2/trunk/c/xdocs/docs/installationguide.html Thu Apr 19 06:56:47 2007
@@ -6,74 +6,73 @@
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
<title>Apache Axis2/C Installation Guide</title>
- <meta name="generator" content="Bluefish 1.0.5"/>
</head>
<body>
<h1>Apache Axis2/C Installation Guide</h1>
-<p>This document will guide you on how to install Axis2/C and run the server
-and client samples on Linux and Microsoft Windows operating systems.</p>
+<p>This document guides you on how to install Axis2/C, and run the server and
+client samples on Linux and Microsoft Windows operating systems.</p>
-<p>This release comes in two forms, source and binary. This document covers both those forms.</p>
+<p>This release comes in two forms, source and binary. This document covers
+both forms.</p>
<p>Please send your feedback to the developer mailing list: <a
-href="mailto:axis-c-dev@ws.apache.org">axis-c-dev@ws.apache.org</a> (please
-remember to prefix the subject with [Axis2]). To subscribe to developer
-mailing list see <a href="http://ws.apache.org/axis2/c/mail-lists.html">here</a>.</p>
+href="mailto:axis-c-dev@ws.apache.org">axis-c-dev@ws.apache.org</a>
+(Subscription details are available on the <a
+href="http://ws.apache.org/axis2/c/mail-lists.html">Axis2 site</a>.) Please
+remember to prefix the subject with [Axis2].</p>
<h2>Contents</h2>
<ul>
<li><a href="#linux">Installing and Running on Linux</a>
<ul>
- <li><a href="#linux_binary">Using Binary Release</a></li>
- <li><a href="#linux_source">Using Source Release</a></li>
+ <li><a href="#linux_binary">Using the Binary Release</a></li>
+ <li><a href="#linux_source">Using the Source Release</a></li>
</ul>
</li>
<li><a href="#win">Installing and Running on Microsoft Windows (win32)</a>
<ul>
- <li><a href="#win_binary">Using Binary Release</a>
- </li>
- <li><a href="#win_source">Using Source Release</a>
- </li>
+ <li><a href="#win_binary">Using the Binary Release</a></li>
+ <li><a href="#win_source">Using the Source Release</a></li>
</ul>
</li>
</ul>
-
<a id="linux"></a>
<h2>1. Installing and Running on Linux</h2>
-<p>This can be done using binary or source distributions.(You can download the two distributions <a href="http://ws.apache.org/axis2/c/download.cgi"> here</a>)</p>
+<p>This can be done using binary or source distributions. (<a
+href="http://ws.apache.org/axis2/c/download.cgi">Download</a> the two
+distributions)</p>
-<p>To get both the binary and source distributions working, you need
-<a href="http://xmlsoft.org/downloads.html">Libxml2</a>.</p>
-
-<p><b>Note :</b> Most Linux systems have Libxml2 installed by default. On MS
-Windows you need to download and install Libxml2.</p>
+<p>To get both the binary and source distributions working, you need <a
+href="http://xmlsoft.org/downloads.html">Libxml2</a>.</p>
+<p><b>Note:</b> Most Linux systems have Libxml2 installed by default. On MS
+Windows, you need to download and install Libxml2.</p>
<a id="linux_binary"></a>
-<h3>1.1. Installing Binary Distribution</h3>
+<h3>1.1. Installing the Binary Distribution</h3>
-<p>The following steps need to be followed to install and run
-Axis2/C binary distribution on Linux : - </p>
+<p>The following steps have to be followed to install and run the Axis2/C
+binary distribution on Linux : </p>
<ol>
- <li>Extract the binary tar package to a folder</li>
- <li>Set AXIS2C_HOME environment variable pointing to the location where you
- have extracted Axis2/C
+ <li>Extract the binary tar package to a folder.</li>
+ <li>Set the AXIS2C_HOME environment variable pointing to the location where
+ you have extracted Axis2/C
<ul>
<li>AXIS2C_HOME='/your_path_to_axis2c'</li>
<li>export AXIS2C_HOME</li>
- <p><strong>Note :</strong> You will need to set AXIS2C_HOME only if you
- need to run Axis2/C samples. The reason is that the samples
- use AXIS2C_HOME to get the path to Axis2/C repository. To write your own
- services or clients this is not a requirement.</p>
+ <p><strong>Note:</strong> You will need to set the AXIS2C_HOME only if
+ you need to run the Axis2/C samples. The reason is that the samples use
+ AXIS2C_HOME to get the path to the Axis2/C repository. This is not
+ required to write your own services or clients. </p>
</ul>
</li>
<li>Run the simple axis server:
<ul>
- <li>To start the simple axis server on default port 9090, run the
+ <li>To start the simple axis server on the default port 9090, run the
following commands.
<ul>
<li>cd /your_path_to_axis2c/bin</li>
@@ -81,8 +80,9 @@
</ul>
</li>
<li>To see the possible command line options run ./axis2_http_server -h
- <p><strong>Note :</strong> If you run into shared library problems, try
- setting the LD_LIBRARY_PATH to include the lib folder containing the Axis2/C libs.</p>
+ <p><strong>Note:</strong> If you run into shared library problems,
+ try setting the LD_LIBRARY_PATH to include the lib folder containing
+ the Axis2/C libs.</p>
<ul>
<li>LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/your_path_to_axis2c/lib</li>
<li>export LD_LIBRARY_PATH</li>
@@ -93,54 +93,54 @@
<li>Run the sample clients in a new shell
<ul>
<li>cd /your_path_to_axis2c/bin/samples</li>
- <li>To run client for echo service
+ <li>To run the client for echo service
<ul>
<li>./echo</li>
</ul>
</li>
- <li>To run client for math service
+ <li>To run the client for math service
<ul>
<li>./math</li>
</ul>
</li>
- <li>To see the possible command line options for sample clients run
- them with '-h' option</li>
- <p><strong>Note :</strong> If you run into shared library problems, try
+ <li>To see the possible command line options for the sample clients,
+ run them with the '-h' option</li>
+ <p><strong>Note:</strong> If you run into shared library problems, try
setting the LD_LIBRARY_PATH</p>
<ul>
- <li>LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/your_path_to_axis2c/lib</li>
- <li>export LD_LIBRARY_PATH</li>
+ <li>LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/your_path_to_axis2c/lib</li>
+ <li>export LD_LIBRARY_PATH</li>
</ul>
</ul>
</li>
</ol>
-
<a id="linux_source"></a>
-<h3>1.2. Installing Source Distribution</h3>
-<p>The following steps need to be followed to install and run Axis2/C using
-source distribution on Linux : - </p>
+<h3>1.2. Installing the Source Distribution</h3>
+
+<p>The following steps have to be followed to install and run Axis2/C using
+the source distribution on Linux :</p>
<ol>
- <li>Extract the source tar package to a folder</li>
- <li>Set AXIS2C_HOME environment variable pointing to the location where you
- want to install Axis2/C
+ <li>Extract the source tar package to a folder.</li>
+ <li>Set the AXIS2C_HOME environment variable pointing to the location where
+ you want to install Axis2/C
<ul>
<li>AXIS2C_HOME='/your_desired_path_to_axis2c_installation'</li>
<li>export AXIS2C_HOME</li>
- <p><strong>Note :</strong> You will need to set AXIS2C_HOME only if you
- need to run Axis2/C samples. The reason is that the samples
- use AXIS2C_HOME to get the path to Axis2/C repository. To write your own
- services or clients this is not a requirement.</p>
+ <p><strong>Note:</strong> You will have to set AXIS2C_HOME only if you
+ want to run the Axis2/C samples. The reason is that the samples use
+ AXIS2C_HOME to get the path to the Axis2/C repository. This is not
+ required to write your own services or clients.</p>
</ul>
</li>
- <li>Then go to the folder where you extracted the source
+ <li>Then go to the folder where you extracted the source.
<ul>
<li>cd /your_path_to_axis2c_source</li>
</ul>
</li>
<li>Build the source
<ul>
- <li>This can be done using the following command sequence in the
+ <li>This can be done using the following command sequence, in the
directory where you have extracted the source:
<ul>
<li>./configure</li>
@@ -149,11 +149,11 @@
</ul>
</li>
<li>Use './configure --help' for possible command line options.</li>
- <li><strong>Note :</strong>If you do not provide a --prefix configure
- option, the default installation would be /usr/local/axis2c
+ <li><strong>Note:</strong> If you do not provide a --prefix configure
+ option, the default installation would be in the /usr/local/axis2c
directory.</li>
- <li>You may need to try Axis2/C with Guththila XML parser. You can do
- that by providing --enable-guththila=yes option when configuring
+ <li>You may have to try Axis2/C with Guththila XML parser. You can do
+ that by providing the --enable-guththila=yes option when configuring.
<ul>
<li>./configure --enable-guththila=yes [other configuration
options]</li>
@@ -161,7 +161,7 @@
<li>make install</li>
</ul>
</li>
- <li>If you need to get the samples working, you also need to build the
+ <li>If you want to get the samples working, you have to build the
samples. <br />
To build the samples:
<ul>
@@ -175,75 +175,77 @@
<li>make install</li>
</ul>
</li>
- <li>Please run "./configure --help" in samples folder for more
- information on configure options.</li>
- <li><strong>Note :</strong> If you do not provide a --prefix configure
- option, samples will by default be installed into
+ <li>Please run "./configure --help" in the samples folder for more
+ information on the configure options.</li>
+ <li><strong>Note:</strong> If you do not provide a --prefix configure
+ option, by default, the samples will be installed into the
"/usr/local/axis2c/bin/samples" directory.</li>
</ul>
</li>
<li>Go to where you installed Axis2/C.</li>
- <li>Start simple axis server
+ <li>Start the simple axis server.
<ul>
- <li>To start the simple axis server on port 9090 run the following
- command lines
+ <li>To start the simple axis server on port 9090, run the following
+ command lines.
<ul>
<li>cd /path_you_installed_axis2c/bin</li>
<li>./axis2_http_server</li>
</ul>
</li>
- <li>To see the possible command line options run ./axis2_http_server -h</li>
- <li><strong>Note :</strong> You may need to be logged in as a superuser to
- run the simple axis server, if you installed Axis2/C as super user.</li>
+ <li>To see the possible command line options, run ./axis2_http_server
+ -h</li>
+ <li><strong>Note:</strong> You may have to be logged in as a superuser
+ to run the simple axis server if you installed Axis2/C as a super
+ user.</li>
</ul>
</li>
- <li>Run the sample clients in a new shell using the following command lines
+ <li>Run the sample clients in a new shell using the following command lines.
<ul>
<li>cd /path_you_installed_axis2c/bin/samples</li>
- <li>to run client for echo service
+ <li>To run the client for the echo service
<ul>
<li>./echo</li>
</ul>
</li>
- <li>to run client for math service
+ <li>To run the client for the math service
<ul>
<li>./math</li>
</ul>
</li>
- <li>To see the possible command line options for sample clients run
- them with '-h' option</li>
+ <li>To see the possible command line options for the sample clients,
+ run them with the '-h' option</li>
</ul>
</li>
</ol>
-
<a id="win"></a>
<h2>2. Installing and Running on Microsoft Windows</h2>
-<p>This too can be done using either binary or source distributions.
-(You can download the two distributions <a href="http://ws.apache.org/axis2/c/download.cgi"> here</a>)</p>
-
-<p>For both the binary and source distributions, you need to
-download <a href="http://xmlsoft.org/downloads.html">Libxml2</a>.</p>
+<p>This too can be done using binary or source distributions. (<a
+href="http://ws.apache.org/axis2/c/download.cgi">Download</a> the two
+distributions.) </p>
+<p>For both binary and source distributions, you have to download <a
+href="http://xmlsoft.org/downloads.html">Libxml2</a>.</p>
<a id="win_binary"></a>
-<h3>2. 1. Installing Binary Distribution</h3>
-<a id="bin_req"></a>
+<h3>2. 1. Installing the Binary Distribution </h3>
<h4>2.1.1. Requirements</h4>
<ul>
- <li>The binaries shipped with this version are compiled with Microsoft
+ <li>The binaries shipped with this version are compiled with the Microsoft
Visual Studio compiler (cl)</li>
- <p>(Note: you can <a href="http://msdn.microsoft.com/vstudio/express/downloads/">download Microsoft VSExpress2005 edition</a>
- from the Microsoft Web site and install it to run these binaries)</p>
+ <p>(<strong>Note</strong>: you can <a
+ href="http://msdn.microsoft.com/vstudio/express/downloads/">download the
+ Microsoft VSExpress2005 edition</a> from the Microsoft Web site and install
+ it to run these binaries.)</p>
<li>You also need the following DLLs:
<ul>
<li>libxml2.dll [http://www.xmlsoft.org - download the version >=
- libxml2-2.6.27.win32]</li>
- <li>iconv.dll [http://www.gnu.org/software/libiconv/ - download the version >=
- iconv-1.9.1.win32]</li>
+ libxml2-2.6.27.win32]</li>
+ <li>iconv.dll [http://www.gnu.org/software/libiconv/ - download the
+ version >= iconv-1.9.1.win32]</li>
<li>zlib1.dll [http://www.gzip.org/zlib/ - download the version >=
zlib-1.2.3.win32]</li>
</ul>
@@ -251,7 +253,7 @@
</ul>
<a id="bin_binaries"></a>
-<h4>2.1.2. Binaries in The Release</h4>
+<h4>2.1.2. Binaries in the Release</h4>
<ul>
<li>Extract the binary distribution to a folder of your choice. (example:
C:\axis2c)</li>
@@ -262,38 +264,39 @@
<p><em>The above folders contain the following files:</em></p>
<ul>
- <li>bin - server and other executable</li>
- <li>bin\samples - client samples go here</li>
+ <li>bin - server and other executables</li>
+ <li>bin\samples - client samples </li>
<li>lib - library modules</li>
<li>services - deployed services</li>
<li>modules - deployed modules</li>
- <li>include - all include files of Axis2/C</li>
+ <li>include - all Include files of Axis2/C</li>
<li>logs - system and client logs are written to this folder</li>
</ul>
- <li>Copy libxml2.dll, iconv.dll and zlib1.dll downloaded to
+ <li>Copy libxml2.dll, iconv.dll, and zlib1.dll downloaded to
C:\axis2c\lib</li>
</ul>
<a id="bin_run"></a>
-<h4>2.1.3. Running The Binaries</h4>
+<h4>2.1.3. Running the Binaries</h4>
<ul>
<li>First, you need to set a couple of environment variables before you can
run the server and samples.
<ul>
<li>Set the variable AXIS2C_HOME to the deploy folder (C:\axis2c)</li>
- <li>Add the path to lib directory to the PATH variable
- (%AXIS2C_HOME%\lib)</li>
+ <li>Add the path to the lib directory to the PATH variable
+ (%AXIS2C_HOME%\lib)</li>
</ul>
</li>
- <li>Now everything is set to run the server<p>
- C:\axis2c\bin\>axis2_http_server.exe</p></li>
- <li>If the server is running successfully you should see the message
+ <li>Now everything is set to run the server.
+ <p>C:\axis2c\bin\>axis2_http_server.exe</p>
+ </li>
+ <li>If the server is running successfully, you will see the message
"Started Simple Axis2 HTTP Server..."</li>
- <li>The log is by default created in %AXIS2C_HOME%\logs folder with the
- name axis2.log.</li>
- <li>(Note: You may provide command line options to change the default
- behavior. Use the command "axis2_http_server.exe -h" to learn about the
- usage)</li>
+ <li>By default, the log is created in the %AXIS2C_HOME%\logs folder with
+ the name axis2.log.</li>
+ <li>(<strong>Note</strong>: You can provide command line options to change
+ the default behavior. Use the command "axis2_http_server.exe -h" to learn
+ about the usage)</li>
<li>Now you can run any sample client located in %AXIS2C_HOME%\bin\samples\
<ul>
<li>Example: C:\axis2c\bin\samples\> echo.exe</li>
@@ -303,22 +306,23 @@
<a id="win_source"></a>
<h3>2. 2. Installing Source Distribution</h3>
-<a id="src_req"></a>
<h4>2.2.1. Requirements</h4>
<ul>
<li>The makefile shipped with this version needs Microsoft Visual Studio
- Compiler (cl) and nmake build tool.</li>
+ Compiler (cl) and the NMake build tool.</li>
- <p>(Note: You can <a href="http://msdn.microsoft.com/vstudio/express/downloads/">download Microsoft VSExpress2005 edition and Platform SDK </a>
- from Microsoft Web site. You will need to add the path to Platform SDK
- Include and Lib folders to makefile)</p>
+ <p>(Note: You can <a
+ href="http://msdn.microsoft.com/vstudio/express/downloads/">download the
+ Microsoft VSExpress2005 edition and Platform SDK</a> from the Microsoft Web
+ site. You will need to add the path to the Platform SDK Include and Lib
+ folders to the makefile)</p>
<li>You also need
<ul>
<li>Libxml2 [http://www.xmlsoft.org - download the version >=
libxml2-2.6.27.win32]</li>
- <li>iconv [http://www.gnu.org/software/libiconv/ - download the version >=
- iconv-1.9.1.win32]</li>
+ <li>iconv [http://www.gnu.org/software/libiconv/ - download the version
+ >= iconv-1.9.1.win32]</li>
<li>zlib [http://www.gzip.org/zlib/ - download the version >=
zlib-1.2.3.win32]</li>
</ul>
@@ -326,52 +330,56 @@
</ul>
<a id="edit"></a>
-<h4>2.2.3. Editing configure.in File</h4>
-<p>Please edit <source_distribution>\build\win32\configure.in file to include following information. </p>
+<h4>2.2.3. Editing the configure.in File</h4>
+
+<p>Please edit the <source_distribution>\build\win32\configure.in file
+to include the following information.</p>
<ul>
<li>The default paths for Libxml2 and iconv are specified in configure.in
<ul>
- <li>Example:If libxml2 is installed into C:\libxml2, edit configure.in file accordingly.</li>
+ <li>Example:If libxml2 is installed into C:\libxml2, edit the
+ configure.in file accordingly.</li>
</ul>
</li>
- <li>You can either extract Libxml2 to this folder, in which case folder
+ <li>You can either extract Libxml2 to this folder, in which case the folder
structure for C:\libxml2 should look like the following:</li>
<p><img alt="Figure: C:\libxml2 Folder Structure"
src="images/folder_structure_libxml2.jpg" /></p>
- <p>Or extract to a location of your choice and edit the configure.in
- accordingly.</p>
+ <p>Else, extract it to a location of your choice and edit the configure.in
+ file accordingly.</p>
<li>You need to have zlib1.dll in a library path. You may copy this DLL to
libxml2/lib.</li>
- <li>If you need the parser to use Guththila XML parser, ENABLE_GUTHTHILA option should be set to 1 in configure.in
+ <li>If you need the parser to use Guththila XML parser, the
+ ENABLE_GUTHTHILA option should be set to 1 in configure.in
<ul>
- <li>Example: ENABLE_GUTHTHILA = 1 </li>
+ <li>Example: ENABLE_GUTHTHILA = 1</li>
</ul>
</li>
</ul>
-
<a id="src_compile"></a>
-<h4>2.2.4. Compiling The Source</h4>
+<h4>2.2.4. Compiling the Source</h4>
-<p>The following steps will take you through the source compilation</p>
+<p>The following steps will take you through the source compilation.</p>
<ul>
<li>Extract the source distribution to a folder of your choice. (Example:
C:\axis2c)</li>
- <li>Edit configure.in file as explained in the section 2.2.3 </li>
+ <li>Edit the configure.in file as explained in the section 2.2.3</li>
<li>Open a DOS shell</li>
<li>cd C:\axis2c\build\win32</li>
<li>to access .Net tools, run
<ul>
<li>C:\axis2c\build\win32> vcvars32.bat</li>
</ul>
- <p>(Note: You may need to set the PATH environment variable to
- vcvars32.bat if Windows complaints that it cannot find this batch file. This file is located in
- <your MS Visual Studio install Directory>\VC\bin directory.)</p>
+ <p>(<strong>Note</strong>: You may have to set the PATH environment
+ variable to vcvars32.bat if MS Windows gives an error indicating that it
+ cannot find this batch file. This file is located in <your MS Visual
+ Studio install Directory>\VC\bin directory.)</p>
</li>
- <li>To build the system and create the binary files in a directory named deploy under build
- directory:
+ <li>To build the system and create the binary files in a directory named
+ deploy under the build directory,
<ul>
<li>C:\axis2c\build\win32>nmake install</li>
</ul>
@@ -394,28 +402,28 @@
</ul>
<a id="src_run"></a>
-<h4>2.2.5. Running The Binaries</h4>
+<h4>2.2.5. Running the Binaries</h4>
<ul>
- <li>You need to set couple of environment variables before you can run the
- server and samples.
+ <li>You need to set a couple of environment variables before you can run
+ the server and samples.
<ul>
<li>Set the variable AXIS2C_HOME to the deploy folder
(C:\axis2c\build\deploy)</li>
- <li>Add the path to lib directory to PATH variable
- (%AXIS2C_HOME%\lib)</li>
+ <li>Add the path to the lib directory to the PATH variable
+ (%AXIS2C_HOME%\lib)</li>
<li>Copy libxml2.dll, iconv.dll and zlib1.dll to Axis2/C lib folder
(%AXIS2C_HOME%\lib)</li>
</ul>
</li>
<li>Now run the server - C:\axis2c\build\deploy\bin>
axis2_http_server.exe</li>
- <li>If server is running successfully you should see the message "Started
- Simple Axis2 HTTP Server..."</li>
- <li>The log is by default created under %AXIS2C_HOME%\logs folder with the
- name axis2.log.</li>
- <li>(Note: you may provide command line options to change the default
- behavior. Use the command "axis2_http_server.exe -h" to learn about the
- usage)</li>
+ <li>If the server is running successfully, you will see the message
+ "Started Simple Axis2 HTTP Server..."</li>
+ <li>By default, the log is created under the %AXIS2C_HOME%\logs folder with
+ the name axis2.log.</li>
+ <li>(<strong>Note</strong>: You can provide command line options to change
+ the default behavior. Use the command "axis2_http_server.exe -h" to learn
+ about the usage)</li>
<li>Now you can run any sample client deployed under
%AXIS2C_HOME%\bin\samples\
<ul>
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org