diff INSTALL.txt @ 202:1e3a5019c4ed

* INSTALL.txt, LICENCE.txt, doku/source/LICENCE.txt, doku/source/conf.py, doku/source/functionality.txt, doku/source/index.txt, doku/source/restrictions.txt: Added some formatting, a section about the setup of environment vars needed for runtime, added some more features.
author Stephan Holl <stephan.holl@intevation.de>
date Thu, 21 Jul 2011 09:38:44 +0200
parents 43f1cbdcd597
children 64cd6a115372
line wrap: on
line diff
--- a/INSTALL.txt	Wed Jul 20 18:30:00 2011 +0200
+++ b/INSTALL.txt	Thu Jul 21 09:38:44 2011 +0200
@@ -11,12 +11,12 @@
 
  * Sun Java6 SDK to build, JRE to run
  * ArcGIS Desktop10.x or ArcEngine10.x with a valid licence enabled
- * UMN MapServer with Java MapScript-bindings (recent development-version)
- * Apache Webserver for displaying the resulting Mapfiles
+ * UMN MapServer with Java MapScript-bindings (>=6.0.1 or recent development-version)
+ * Apache2 Webserver for displaying the resulting Mapfiles
  * Optional: MapServer compiled with ArcSDE-plugin
  * Optional: GDAL/OGR compiled with ArcSDE-support
  * Optional: GDAL/OGR compiled with FileGeodatabase-support 
-
+ * Optional: Other GDAL/OGR-related tools.
 
 
 ------------
@@ -53,7 +53,7 @@
 
 The current documentation uses the Windows binary-builds from http://www.gisinternals.com/sdk/
 
-1. Unzip the ZIP-file at c:/ms_6.1-dev
+1. Unzip the ZIP-file at ``c:/ms_6.1-dev``
 
 #. Configure Apache Webserver to find the cgi-bin-folder::
 
@@ -65,7 +65,7 @@
         Allow from all
     </Location>
 
-#. Copy mapserv.exe from c:/ms_6.1-dev/bin/apps/ms to c:/ms_6.1-dev/bin/
+#. Copy mapserv.exe from ``c:/ms_6.1-dev/bin/apps/ms`` to ``c:/ms_6.1-dev/bin/``
 
 
 Create run-environment
@@ -75,21 +75,68 @@
 The following steps assume the runtime folder to be c:/mxd2map/. This path can
 be changed.
 
-1. Copy mxd2map.jar to c:/mxd2map/.
+1. Copy ``mxd2map.jar`` to ``c:/mxd2map/``.
 
-#. Copy folder "conf" from repository to c:/mxd2map/
+#. Copy folder "conf" from repository to ``c:/mxd2map/``
 
-#. Create folder c:/mxd2map/lib/
+#. Create folder ``c:/mxd2map/lib/``
 
 #. Get log4j from http://logging.apache.org/log4j/1.2/download.html
 
 #. Get jargs http://jargs.sourceforge.net/ (Version 1.0)
 
-#. Build the libraries and copy the resulting jar-files to c:/mxd2map/lib/
-
-#. Copy mapscript.jar and mapscript.dll to c:/mxd2map/lib/
+#. Build the libraries and copy the resulting jar-files to ``c:/mxd2map/lib/``
 
-#. Create a folder c:/mxd2map/logs/
+#. Copy mapscript.jar and mapscript.dll to ``c:/mxd2map/lib/``
 
-#. Create or copy a converter.properties file to c:/mxd2map/
+#. Create a folder ``c:/mxd2map/logs/``
 
+#. Create or copy a converter.properties file to ``c:/mxd2map/``
+
+Setup environment-variables
+---------------------------
+
+For running the converter it is necessary to set up some environment
+variables and adjust the path accordingly.
+
+The following example shows the minimum env-vars needed::
+
+    @echo off
+    if "%1" == "setenv" goto setenv
+    
+    %comspec% /k SDKShell.bat setenv %1
+    goto exit
+    
+    :setenv
+    @echo Setting environment for using the GDAL and MapServer tools.
+    
+    if "%2"=="hideoci" goto hideoci
+    
+    set ocipath=0
+    set _path="%PATH:;=" "%"
+    for %%p in (%_path%) do if not "%%~p"=="" if exist %%~p\oci.dll set ocipath=1
+    
+    if "%ocipath%"=="0" goto hideoci
+    @echo WARNING: If you encounter problems with missing oci libraries then type:
+    @echo   SDKShell hideoci
+    goto setenv2
+    
+    :hideoci
+    @echo Hiding the OCI plugin library.
+    if not exist %CD%\bin\gdal\plugins-optional mkdir %CD%\bin\gdal\plugins-optional
+    if exist %CD%\bin\gdal\plugins\ogr_OCI.dll move %CD%\bin\gdal\plugins\ogr_OCI.dll %CD%\bin\gdal\plugins-optional\ogr_OCI.dll
+    if exist %CD%\bin\gdal\plugins\gdal_GEOR.dll move %CD%\bin\gdal\plugins\gdal_GEOR.dll %CD%\bin\gdal\plugins-optional\gdal_GEOR.dll
+    
+    :setenv2
+    SET PATH=C:\Program Files\ArcGIS\DeveloperKit10.0\java\jre\bin;C:\Program Files\ArcGIS\Engine10.0\bin;%CD%\bin;%CD%\bin;%CD%\bin\gdal\python\osgeo;%CD%\bin\proj\apps;%CD%\bin\gdal\apps;%CD%\bin\ms\apps;%CD%\bin\gdal\csharp;%CD%\bin\ms\csharp;%CD%\bin\curl;%CD%\bin\ms\java;C:\Program Files\Vim\vim71;C:\Program Files\TortoiseHg;%PATH%
+    SET GDAL_DATA=%CD%\bin\gdal-data
+    SET GDAL_DRIVER_PATH=%CD%\bin\gdal\plugins
+    SET PYTHONPATH=%CD%\bin\gdal\python\osgeo
+    SET PROJ_LIB=%CD%\bin\proj\SHARE
+    SET CURL_CA_BUNDLE=C:\ms4w\Apache\conf\ca-bundle\cacert.pem
+
+    :exit
+
+The above batch-script ``SDKShell.bat`` needs to be sources before working
+with MXD2map.
+
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)