README revision 797b7557ad71a61ffb72a68f4457a3d999e7e252
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater/*
3e02c9e33656dcd9c364633d42dd785d3e6fdd66Automatic Updater * CDDL HEADER START
3e02c9e33656dcd9c364633d42dd785d3e6fdd66Automatic Updater *
3e02c9e33656dcd9c364633d42dd785d3e6fdd66Automatic Updater * The contents of this file are subject to the terms of the
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater * Common Development and Distribution License, Version 1.0 only
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater * (the "License"). You may not use this file except in compliance
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater * with the License.
3e02c9e33656dcd9c364633d42dd785d3e6fdd66Automatic Updater *
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater * You can obtain a copy of the license at
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater * trunk/opends/resource/legal-notices/OpenDS.LICENSE
3e02c9e33656dcd9c364633d42dd785d3e6fdd66Automatic Updater * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater * See the License for the specific language governing permissions
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater * and limitations under the License.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater *
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater * When distributing Covered Code, include this CDDL HEADER in each
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater * file and include the License file at
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater * add the following below this CDDL HEADER, with the fields enclosed
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater * by brackets "[]" replaced with your own identifying information:
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater * Portions Copyright [yyyy] [name of copyright owner]
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater *
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater * CDDL HEADER END
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater *
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater *
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater * Portions Copyright 2007 Sun Microsystems, Inc.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater */
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater WHAT is winlauncher.exe
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater ========================
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updaterwinlauncher.exe is a small windows executable that is intended to be used by
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updaterthe command line files to perform certain operations. It is not intended to
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updaterbe a final user interface and that is one of the reasons why is placed under
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updaterthe lib subdirectory.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic UpdaterSee the comments in winlauncher.c file and common.c for more information.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater WHAT is opends_service.exe
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater ========================
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updateropends_service.exe is a small windows executable that is intended to be used by
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updaterthe command line files to be able to run OpenDS as a windows service (or not
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updaterto configure it as windows service). It is not intended to be a final user
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updaterinterface and that is one of the reasons why is placed under the lib
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updatersubdirectory.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic UpdaterSee the comments in service.c file and common.c for more information.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater WHAT is launcher_administrator.exe
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater ========================
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updaterlauncher_administrator.exe is a small windows executable that is intended to
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updaterbe used by the command line files to launch operations that require
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updateradministrator privileges on Vista. Basically is a wrapper containing a
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updatermanifest that specifies to require administrator privileges to be run. This
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updateris required if UAC is enabled on Vista so that we have a prompt for the user
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updaterasking for confirmation.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic UpdaterSee the comments in winlauncher.c file and common.c for more information.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater INSTRUCTIONS TO COMPILE winlauncher.exe
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater ========================
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic UpdaterUsing Visual C++ and the command line you must set your environment
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updatervariables to point to your Visual Studio install. You can set the environment
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updatervariables by changing to the \bin subdirectory of your Visual C++ installation
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updaterand running the VCVARS32.bat batch file.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic UpdaterThis will basically update your PATH, INCLUDE and LIB environment variables
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updaterto point to the correct paths of your Visual Studio install.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic UpdaterGo to the directory where the source files winlauncher.c, winlauncher.h,
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updatercommon.c and common.h are and launch the following command:
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater> cl winlauncher.c common.c
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic UpdaterThis will generate the binary winlauncher.exe.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic UpdaterNOTE: An alternative to this mode is to compile winlauncher.exe using the
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic UpdaterMakefile by running:
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater> nmake all
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater(See INSTRUCTIONS TO COMPILE opends_service.exe for more information).
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater************************
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic UpdaterUsing Visual C++ graphical interface you just must to Create a Project and add
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updaterwinlauncher.c, winlauncher.h, common.c and common.h to the project.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic UpdaterYou can build winlauncher.c and then winlauncher.exe with the commands in the
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updatermenu 'Build'.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater************************
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic UpdaterUsing gcc (for instance you can get it with the open source project MinGW -
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic UpdaterMinimalist GNU for Windows), you must include the directory where the gcc
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updaterbinaries are on your PATH environment variable.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic UpdaterGo to the directory where the source files winlauncher.c and winlauncher.h are
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updaterand launch the following command:
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater> gcc common.c winlauncher.c -o winlauncher.exe
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic UpdaterThis will generate the binary winlauncher.exe.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater INSTRUCTIONS TO COMPILE opends_service.exe and administrator_launcher.exe
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater ========================
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updaterservice.c (the main code file for opends_service.exe) uses windows resources and
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updaterso
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic UpdaterThe fastest way of generating opends_service.exe is to do it using the command
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updaterline.
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic UpdaterUsing Visual C++ and the command line you must set your environment
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updatervariables to point to your Visual Studio install. You can set the environment
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updatervariables by changing to the \bin subdirectory of your Visual C++ installation
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updaterand running the VCVARS32.bat batch file.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic UpdaterThen go to the directory where the source files are and run the following
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updatercommand:
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater> nmake all
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic UpdaterThis command will generate both opends_service.exe and winlauncher.exe.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic UpdaterSee the comments in the file Makefile for more information.
590c12cfe3b9a179ab2faa1be791a069c81882e0Automatic Updater