]> git.sur5r.net Git - openldap/blobdiff - doc/guide/release/install.sdf
Misc. cleanup
[openldap] / doc / guide / release / install.sdf
index 0a8ff31b47f1fd3bfcd8501076c55211c4299edf..b8cd7e0a2f2c3a1eb8568d6002ee053bffa3069a 100644 (file)
@@ -1,21 +1,20 @@
 # $OpenLDAP$
-# Copyright 1999-2000, The OpenLDAP Foundation, All Rights Reserved.
+# Copyright 1999-2001, The OpenLDAP Foundation, All Rights Reserved.
 # COPYING RESTRICTIONS APPLY, see COPYRIGHT.
 
 P1: Making and Installing the OpenLDAP Distribution
 
 This file provides brief instructions on how to build and install
-OpenLDAP on UNIX (and UNIX-{{like}}) system.  For other systems,
-please consult {{The OpenLDAP Administrator's Guide}}
-{{URL:http://www.openldap.org/devel/admin/}}.
+OpenLDAP on UNIX (and UNIX-{{like}}) systems.  More detailed
+information and instructions can be found in
+{{The OpenLDAP Administrator's Guide}}
+(available from {{URL:http://www.openldap.org/doc/}}).
 
 It is recommended that you read, or at least skim through, ALL of
 the instructions in this file before attempting to build the
 software.
 
-It is also recommended your review
-{{The OpenLDAP Administrator's Guide}}
-({{URL:http://www.openldap.org/devel/admin/}}) and
+It is also recommended you review
 the {{Frequently Asked Questions}} ({{URL:http://www.openldap.org/faq/}})
 pages, in particular the
 {{Installation section}} ({{URL:http://www.openldap.org/faq/index.cgi?file=8}})
@@ -39,16 +38,12 @@ you are reading this file, you probably have already done this!
 
 E:     % ./configure --help
 
-.to list available configuration options.   A description of
-these options is provided in the 'CONFIGURE OPTIONS' section
-below.
+.to list available configuration options.
 
-.The {{EX:configure}} script uses environmental variables for
-determining compiler/linker options.  See the 'USING ENVIRONMENT
-VARIABLES' section for commonly used settings.
-
-.These environment variables are used: 
+.The {{EX:configure}} script uses environment variables for
+determining compiler/linker options including:
 
+>      Variable        Description     Example
 >      CC              C compiler      gcc
 >      CFLAGS          C flags         -O -g
 >      CPPFLAGS        cpp flags       -I/path/include -Ddef
@@ -56,14 +51,11 @@ VARIABLES' section for commonly used settings.
 >      LIBS            libraries       -llib
 >      PATH            command path    /usr/local/bin:/usr/bin:/bin
 
-.See the 'USING ENVIRONMENT VARIABLES' section for information
-on how to use the variables. 
-
 + Configure the build system
 
 E:     % [env settings] ./configure [options]
 
-.If all goes well, the {{EX:configure}} script with automatically
+.If all goes well, the {{EX:configure}} script will automatically
 detect the appropriate settings.  However, you may need to
 specify options and/or environment variables to obtain desired
 results.
@@ -84,7 +76,7 @@ if you have not done so already.
 + Test the standalone system
 
 .This step requires the standalone LDAP server, {{slapd}}(8),
-with {{LDBM}} support.
+with {{BDB}} or {{LDBM}} support.
 
 E:     % make test
 
@@ -93,144 +85,25 @@ return to step 4 after reviewing your configuration settings.  You
 may want to consult the {{Installation}} section of the {{FAQ}}
 if you have not done so already.
 
-+ install the binaries and man pages.  You may need to be {{superuser}}
-to do this (depending on where you are installing things):
++ Install the binaries and man pages.  You may need to become the
+{{super-user}} (e.g. {{EX:root}}) to do this (depending on where you
+are installing things):
 
 E:     % su root -c 'make install'
 
 + That's it!
 
-See the {{Administrator's Guide}} and the manual pages for the
-individual applications for configuration and use information.
+See the {{OpenLDAP Administrator's Guide}} and the manual pages
+for the individual applications for configuration and use information.
 You may also want to edit the configuration files used by the
 various components.  These configuration files are located in
 the OpenLDAP configuration directory (normally
 {{F:/usr/local/etc/openldap}}).
 
 >      ldap.conf               client defaults
->      ldapfilter.conf         search filter configuration
->      ldapsearchprefs.conf    search object definitions
->      ldaptemplates.conf      display template definitions
 >      slapd.conf              Standalone LDAP daemon
 >      schema/*.schema         Schema Definitions
 
-There are section 5 man pages for these configuration files.
-
-
-P2: Building OpenLDAP For More Than One Platform
-
-You can build OpenLDAP for more than one platform from the
-same source tree.
-This is accomplished by using {{make}}(1) {{EX:VPATH}} support.
-If your {{make}}(1) program is old and doesn't have {{EX:VPATH}}
-support, install {{BSD Make}} or {{GNU Make}}.
-
-Follow these steps for each different platform:
-
-^ Create a directory for the platform object files.
-
-E:     % mkdir obj-platform
-
-+ Change your working directory to the platform object directory.
-
-E:     % cd obj-platform
-
-+ Configure the build system
-
-E:     % [env settings] ../configure --src-dir=.. [options]
-
-. ( replace "{{F:..}}" with the appropriate path )
-
-+ Continue as above (starting at step 6).
-
-
-P2: CONFIGURE OPTIONS
-
-Regrettably, this section has not been written (yet).  See
-"{{EX:./configure --help}}" for current list of options.  For general
-information about how to use "{{EX:configure}}", please read
-{{F:doc/install/configure}}.
-
-
-P2: USING ENVIRONMENT VARIABLES
-
-The configure script will also use your environmental
-variables for determining compiler/linker options.   This can
-be used to manual specify features and compilation options.
-
-Note[label=Warning]: Executables built in your environment may not run
-in your users' environments.  The portability of executables
-between environments is your responsibility.
-
-Supported Environmental Variables:
-
->      CC              C compiler      cc
->      CFLAGS          C flags         -O -g
->      CPPFLAGS        cpp flags       -I/path/include -Ddef
->      LDFLAGS         ld flags        -L/usr/local/lib
->      LIBS            libraries       -llib
->      PATH            command path    /usr/local/bin:/usr/bin:/bin
-
-* Including alternative compilers
-
-.Use the {{EX:CC}} environment variable to tell configure to
-use a specific compiler.  For example, to use {{GNU C
-Compiler}} instead of the default compiler, use:
-
-E:     % [env] CC=gcc ./configure 
-
-.You can also use {{EX:CC}} use specific flags with the
-specified compiler.  For example, to require strict
-{{ANSI C}} using the {{GNU C Compiler}}, use:
-
-E:     % [env] CC="gcc -ansi -pedantic" ./configure
-
-.(you can use {{EX:CFLAGS}} to specify compiler flags)
-
-* Preprocessor Flags
-
-.You may specify additional preprocessor flags by setting
-{{EX:CPPFLAGS}}.  For example, if you would like to use headers
-installed in {{F:/usr/local/include}}, use:
-
-E:     % [env] CPPFLAGS="-I/usr/local/include" ./configure
-
-.You can also use {{EX:CPPFLAGS}} to specify preprocessor macros.
-
-E:     % [env] CPPFLAGS="-D__SPECIAL_FLAG__" ./configure
-
-* Linker Flags
-
-.You may specify additional linker flags by setting {{EX:LDFLAGS}}.
-For example, if you would like to use libraries installed
-in {{F:/usr/local/lib}}, use:
-
-E:     % [env] LDFLAGS="-L/usr/local/lib" ./configure
-
-.You can also use CPPFLAGS to specify linker flags:
-
-E:     % [env] LDFLAGS="-Bstatic" ./configure
-
-* Path
-
-.You may alter your path to affect configure ability to
-find (or not find) commands.  For example, to have configure
-additionally look in {{F:/usr/css/bin}} for commands, use:
-
-E:     % [env] PATH="/usr/css/bin:$PATH" ./configure
-       
-* Using locally installed software
-
-.To use software under installed under {{F:/usr/local}}.
-
-E:     [env] \
-E:             CPPFLAGS="-I/usr/local/include" \
-E:             LDFLAGS="-L/usr/local/lib" \
-E:             ./configure
-
-Note: You may have add additional flags if your system
-supports shared libraries.
-
 
 End of OpenLDAP INSTALL file.