README revision 3231
cd348e325366620fe047edcc849e3c9424828599Peter Bray/*
cd348e325366620fe047edcc849e3c9424828599Peter Bray * CDDL HEADER START
0ca9a2c194523c517c3aafe5758e217ac88d6baaLubos Kosco *
cd348e325366620fe047edcc849e3c9424828599Peter Bray * The contents of this file are subject to the terms of the
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray * Common Development and Distribution License, Version 1.0 only
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray * (the "License"). You may not use this file except in compliance
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal * with the License.
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray *
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray * You can obtain a copy of the license at
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter Bray * trunk/opends/resource/legal-notices/OpenDS.LICENSE
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
2b024356b830395446c55f50f9f724a63612e578Lubos Kosco * See the License for the specific language governing permissions
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray * and limitations under the License.
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray *
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter Bray * When distributing Covered Code, include this CDDL HEADER in each
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter Bray * file and include the License file at
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray * add the following below this CDDL HEADER, with the fields enclosed
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray * by brackets "[]" replaced with your own identifying information:
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter Bray * Portions Copyright [yyyy] [name of copyright owner]
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray *
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray * CDDL HEADER END
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray *
d961aa46ea0d50fed47802497e45226b1965b12dVladimir Kotal *
d961aa46ea0d50fed47802497e45226b1965b12dVladimir Kotal * Copyright 2008 Sun Microsystems, Inc.
d961aa46ea0d50fed47802497e45226b1965b12dVladimir Kotal */
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray
cd71fb134e037849c77364b50940b1870c4684ceVladimir Kotal WHAT is winlauncher.exe
cd71fb134e037849c77364b50940b1870c4684ceVladimir Kotal ========================
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Braywinlauncher.exe is a small windows executable that is intended to be used by
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Braythe command line files to perform certain operations. It is not intended to
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Braybe a final user interface and that is one of the reasons why is placed under
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Braythe lib subdirectory.
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir KotalSee the comments in winlauncher.c file and common.c for more information.
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray WHAT is opends_service.exe
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter Bray ========================
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotalopends_service.exe is a small windows executable that is intended to be used by
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotalthe command line files to be able to run OpenDS as a windows service (or not
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotalto configure it as windows service). It is not intended to be a final user
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotalinterface and that is one of the reasons why is placed under the lib
b17cb0705d90907337b3528aa7b8ed1700806f26Vladimir Kotalsubdirectory.
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir KotalSee the comments in service.c file and common.c for more information.
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal WHAT is launcher_administrator.exe
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal ========================
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotallauncher_administrator.exe is a small windows executable that is intended to
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotalbe used by the command line files to launch operations that require
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotaladministrator privileges on Vista. Basically is a wrapper containing a
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotalmanifest that specifies to require administrator privileges to be run. This
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotalis required if UAC is enabled on Vista so that we have a prompt for the user
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotalasking for confirmation.
3ba66fbb56ef22f183da783a1b2718280c357a4eStanislav Kozina
3ba66fbb56ef22f183da783a1b2718280c357a4eStanislav KozinaSee the comments in winlauncher.c file and common.c for more information.
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal INSTRUCTIONS TO COMPILE winlauncher.exe
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter Bray ========================
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter Bray
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter BrayUsing Visual C++ and the command line you must set your environment
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Brayvariables to point to your Visual Studio install. You can set the environment
0ca9a2c194523c517c3aafe5758e217ac88d6baaLubos Koscovariables by changing to the \bin subdirectory of your Visual C++ installation
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotaland running the VCVARS32.bat batch file.
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir KotalThis will basically update your PATH, INCLUDE and LIB environment variables
cd348e325366620fe047edcc849e3c9424828599Peter Brayto point to the correct paths of your Visual Studio install.
3b0448fdd830b8d04c6a71511e5d26a4fc3b5b80Lubos Kosco
cd348e325366620fe047edcc849e3c9424828599Peter BrayGo to the directory where the source files winlauncher.c, winlauncher.h,
cd348e325366620fe047edcc849e3c9424828599Peter Braycommon.c and common.h are and launch the following command:
cd348e325366620fe047edcc849e3c9424828599Peter Bray
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal> cl winlauncher.c common.c
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal
43dac746513591adbd09bc4f417feb385f4fd87eVladimir KotalThis will generate the binary winlauncher.exe.
fbf97ea1786d1e25add88bbfb91810170473bc9fLubos Kosco
fbf97ea1786d1e25add88bbfb91810170473bc9fLubos KoscoNOTE: An alternative to this mode is to compile winlauncher.exe using the
fbf97ea1786d1e25add88bbfb91810170473bc9fLubos KoscoMakefile by running:
fbf97ea1786d1e25add88bbfb91810170473bc9fLubos Kosco
fbf97ea1786d1e25add88bbfb91810170473bc9fLubos Kosco> nmake all
fbf97ea1786d1e25add88bbfb91810170473bc9fLubos Kosco
fbf97ea1786d1e25add88bbfb91810170473bc9fLubos Kosco(See INSTRUCTIONS TO COMPILE opends_service.exe for more information).
fbf97ea1786d1e25add88bbfb91810170473bc9fLubos Kosco
f21b682cd9b414738a4f5a38b56f6682e537e1d2Trond Norbye************************
3b0448fdd830b8d04c6a71511e5d26a4fc3b5b80Lubos Kosco
3b0448fdd830b8d04c6a71511e5d26a4fc3b5b80Lubos KoscoUsing Visual C++ graphical interface you just must to Create a Project and add
cd348e325366620fe047edcc849e3c9424828599Peter Braywinlauncher.c, winlauncher.h, common.c and common.h to the project.
cd348e325366620fe047edcc849e3c9424828599Peter BrayYou can build winlauncher.c and then winlauncher.exe with the commands in the
cd348e325366620fe047edcc849e3c9424828599Peter Braymenu 'Build'.
cd348e325366620fe047edcc849e3c9424828599Peter Bray
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray************************
cd348e325366620fe047edcc849e3c9424828599Peter Bray
2cf31ec93bd5d8a2efeab511ce051da51e69aedaLubos KoscoUsing gcc (for instance you can get it with the open source project MinGW -
2cf31ec93bd5d8a2efeab511ce051da51e69aedaLubos KoscoMinimalist GNU for Windows), you must include the directory where the gcc
43dac746513591adbd09bc4f417feb385f4fd87eVladimir Kotalbinaries are on your PATH environment variable.
43dac746513591adbd09bc4f417feb385f4fd87eVladimir KotalGo to the directory where the source files winlauncher.c and winlauncher.h are
2cf31ec93bd5d8a2efeab511ce051da51e69aedaLubos Koscoand launch the following command:
43dac746513591adbd09bc4f417feb385f4fd87eVladimir Kotal
43dac746513591adbd09bc4f417feb385f4fd87eVladimir Kotal> gcc common.c winlauncher.c -o winlauncher.exe
2cf31ec93bd5d8a2efeab511ce051da51e69aedaLubos Kosco
0ca9a2c194523c517c3aafe5758e217ac88d6baaLubos KoscoThis will generate the binary winlauncher.exe.
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray INSTRUCTIONS TO COMPILE opends_service.exe and administrator_launcher.exe
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray ========================
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Brayservice.c (the main code file for opends_service.exe) uses windows resources and
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Brayso
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray
d2a02e104622a26dd90fa88f4f17188f2039809fPeter BrayThe fastest way of generating opends_service.exe is to do it using the command
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Brayline.
d2a02e104622a26dd90fa88f4f17188f2039809fPeter BrayUsing Visual C++ and the command line you must set your environment
cd348e325366620fe047edcc849e3c9424828599Peter Brayvariables to point to your Visual Studio install. You can set the environment
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Brayvariables by changing to the \bin subdirectory of your Visual C++ installation
cd348e325366620fe047edcc849e3c9424828599Peter Brayand running the VCVARS32.bat batch file.
cd348e325366620fe047edcc849e3c9424828599Peter Bray
d2a02e104622a26dd90fa88f4f17188f2039809fPeter BrayThen go to the directory where the source files are and run the following
cd348e325366620fe047edcc849e3c9424828599Peter Braycommand:
cd348e325366620fe047edcc849e3c9424828599Peter Bray
cd348e325366620fe047edcc849e3c9424828599Peter Bray> nmake all
cd348e325366620fe047edcc849e3c9424828599Peter Bray
cd348e325366620fe047edcc849e3c9424828599Peter BrayThis command will generate both opends_service.exe and winlauncher.exe.
cd348e325366620fe047edcc849e3c9424828599Peter Bray
cd348e325366620fe047edcc849e3c9424828599Peter BraySee the comments in the file Makefile for more information.
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray