]> git.sur5r.net Git - openldap/commitdiff
Add SDF version of INSTALL.
authorKurt Zeilenga <kurt@openldap.org>
Thu, 30 Sep 1999 17:01:02 +0000 (17:01 +0000)
committerKurt Zeilenga <kurt@openldap.org>
Thu, 30 Sep 1999 17:01:02 +0000 (17:01 +0000)
doc/guide/plain.sdf [new file with mode: 0644]
doc/guide/release/install.sdf [new file with mode: 0644]

diff --git a/doc/guide/plain.sdf b/doc/guide/plain.sdf
new file mode 100644 (file)
index 0000000..c12874f
--- /dev/null
@@ -0,0 +1,18 @@
+# $OpenLDAP$
+# Copyright 1999, The OpenLDAP Foundation, All Rights Reserved.
+# COPYING RESTRICTIONS APPLY, see COPYRIGHT.
+
+# template for plain documents
+!macro HTML_PRE_SECTION
+!endmacro
+!macro HTML_POST_SECTION
+!endmacro
+
+!macro HTML_HEADER
+!endmacro
+!macro HTML_FOOTER
+{{INLINE:<SMALL>______<BR>}}
+Copyright 1999, The OpenLDAP Foundation. {{EMAIL:info@openldap.org}}
+All Rights Reserved.
+{{INLINE:</SMALL>}}
+!endmacro
diff --git a/doc/guide/release/install.sdf b/doc/guide/release/install.sdf
new file mode 100644 (file)
index 0000000..b41978d
--- /dev/null
@@ -0,0 +1,231 @@
+# $OpenLDAP$
+# Copyright 1999, The OpenLDAP Foundation, All Rights Reserved.
+# COPYING RESTRICTIONS APPLY, see COPYRIGHT.
+
+P1: Making and Installing the OpenLDAP Distribution
+
+It is recommended that you read or at least skim through ALL of the
+instructions in this file before attempting to build the software.
+
+The OpenLDAP Installation FAQ is available at:
+
+.{{URL:http://www.openldap.org/faq/index.cgi?file=8}}
+
+You should also check for platform specific hints.
+These are located in doc/install/hints or:
+
+.{{URL:http://www.openldap.org/faq/index.cgi?file=9}}
+
+
+P2: Making and Installing the OpenLDAP Distribution
+
+^ untar the distribution and cd to the top:
+
+E:     % tar xfz openldap-VERSION.tgz
+E:     % cd openldap-VERSION
+
+.If you are reading this file, you probably have already done this!
+
+
++ Type:
+
+E:     % ./configure --help
+
+.to list available configuration options.   A description of
+these options is provided in the 'CONFIGURE OPTIONS' section
+below.
+
+.The configure script uses environmental variables for
+determining compiler/linker options.  See the HINTS
+section for commonly used settings. 
+
+.These environment variables are used: 
+
+>      CC              C compiler      gcc
+>      CFLAGS          C flags         -ansi
+>      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
+
+.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 configure script with auto-detect the
+appropriate settings.  Use configure enable/with options and/or
+environment variables to obtain desired results.
+
++ Review the file include/ldapconfig.h.edit.
+
+.You generally do not need to modify this file.  
+
+E:     % view include/ldapconfig.h.edit
+
++ Build dependencies
+
+E:     % make depend
+
++ Build the system
+
+E:     % make
+
+.If all goes well, the system will build as configured.  If not,
+return to step 4 after reviewing the configuration settings.
+
+.You may want to consult the doc/install/hints file for your
+platform.
+
++ Test the standalone system
+
+.This step requires the standalone LDAP server (slapd) with
+LDBM support.
+
+E:     % cd tests
+E:     % make
+E:     % cd ..
+
+.If all goes well, the system has been built as configured.  If not,
+return to step 4 after reviewing your configuration settings.
+
+.You may want to consult the doc/install/hints file for your
+platform.
+
++ install the binaries and man pages.  You may need to be superuser to
+do this (depending on where you are installing things):
+
+E:     % su root -c make install
+
++ That's it!
+
+.See the man pages for the individual applications for
+information on configuring and using them.  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 /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
+
+.There are section 5 man pages for all of these 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) VPATH support.
+If your make(1) program is old and doesn't have VPATH support,
+install 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 ".." with the appropriate path )
+
++ Continue as above (starting at step 6).
+
+Note: make depend in VPATH environment is not yet supported.
+
+
+P2: CONFIGURE OPTIONS
+
+Regrettably, this section has not been written (yet).  See
+"./configure --help" for current list of options.  For general
+information about how to use "configure", please read:
+       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: If you change environment setting, be sure to remove
+any config.cache before running ./configure.
+
+Supported Environmental Variables:
+
+>      CC              C compiler      cc
+>      CFLAGS          C flags         -ansi
+>      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 CC environment variable to tell configure to
+use a specific compiler.  For example, to use ecgs
+instead of the compiler configure choose, use:
+
+E:     % [env] CC=egcc ./configure 
+
+.You can also use 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 CFLAGS to specify compiler flags)
+
+* Preprocessor Flags
+
+.You may specify additional preprocessor flags by setting
+CPPFLAGS.  For example, if you would like to use headers
+installed in /usr/local/include, use:
+
+E:     % [env] CPPFLAGS="-I/usr/local/include" ./configure
+
+.You can also use CPPFLAGS to specify preprocessor macros.
+
+E:     % [env] CPPFLAGS="-D__SPECIAL_FLAG__" ./configure
+
+* Linker Flags
+
+.You may specify additional linker flags by setting LDFLAGS.
+For example, if you would like to use libraries installed
+in /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 /usr/css/bin for commands, use:
+
+E:     % [env] PATH="/usr/css/bin:$PATH" ./configure
+       
+
+* Use local software
+
+E:     % [env] \
+E:             CPPFLAGS="-I/usr/local/include" \
+E:             LDFLAGS="-L/usr/local/lib" \
+E:             ./configure
+
+
+End of OpenLDAP INSTALL file.