diff options
Diffstat (limited to 'doc/guide/release')
-rw-r--r-- | doc/guide/release/autoconf-install.txt | 183 | ||||
-rw-r--r-- | doc/guide/release/autoconf.sdf | 16 | ||||
-rw-r--r-- | doc/guide/release/copyright-plain.sdf | 10 | ||||
-rw-r--r-- | doc/guide/release/copyright.sdf | 89 | ||||
-rw-r--r-- | doc/guide/release/install.sdf | 100 | ||||
-rw-r--r-- | doc/guide/release/license-plain.sdf | 10 | ||||
-rw-r--r-- | doc/guide/release/license.sdf | 15 |
7 files changed, 423 insertions, 0 deletions
diff --git a/doc/guide/release/autoconf-install.txt b/doc/guide/release/autoconf-install.txt new file mode 100644 index 0000000..50dbe43 --- /dev/null +++ b/doc/guide/release/autoconf-install.txt @@ -0,0 +1,183 @@ +Basic Installation +================== + + These are generic installation instructions. + + The `configure' shell script attempts to guess correct values for +various system-dependent variables used during compilation. It uses +those values to create a `Makefile' in each directory of the package. +It may also create one or more `.h' files containing system-dependent +definitions. Finally, it creates a shell script `config.status' that +you can run in the future to recreate the current configuration, a file +`config.cache' that saves the results of its tests to speed up +reconfiguring, and a file `config.log' containing compiler output +(useful mainly for debugging `configure'). + + If you need to do unusual things to compile the package, please try +to figure out how `configure' could check whether to do them, and mail +diffs or instructions to the address given in the `README' so they can +be considered for the next release. If at some point `config.cache' +contains results you don't want to keep, you may remove or edit it. + + The file `configure.in' is used to create `configure' by a program +called `autoconf'. You only need `configure.in' if you want to change +it or regenerate `configure' using a newer version of `autoconf'. + +The simplest way to compile this package is: + + 1. `cd' to the directory containing the package's source code and type + `./configure' to configure the package for your system. If you're + using `csh' on an old version of System V, you might need to type + `sh ./configure' instead to prevent `csh' from trying to execute + `configure' itself. + + Running `configure' takes awhile. While running, it prints some + messages telling which features it is checking for. + + 2. Type `make' to compile the package. + + 3. Optionally, type `make check' to run any self-tests that come with + the package. + + 4. Type `make install' to install the programs and any data files and + documentation. + + 5. You can remove the program binaries and object files from the + source code directory by typing `make clean'. To also remove the + files that `configure' created (so you can compile the package for + a different kind of computer), type `make distclean'. There is + also a `make maintainer-clean' target, but that is intended mainly + for the package's developers. If you use it, you may have to get + all sorts of other programs in order to regenerate files that came + with the distribution. + +Compilers and Options +===================== + + Some systems require unusual options for compilation or linking that +the `configure' script does not know about. You can give `configure' +initial values for variables by setting them in the environment. Using +a Bourne-compatible shell, you can do that on the command line like +this: + CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure + +Or on systems that have the `env' program, you can do it like this: + env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure + +Compiling For Multiple Architectures +==================================== + + You can compile the package for more than one kind of computer at the +same time, by placing the object files for each architecture in their +own directory. To do this, you must use a version of `make' that +supports the `VPATH' variable, such as GNU `make'. `cd' to the +directory where you want the object files and executables to go and run +the `configure' script. `configure' automatically checks for the +source code in the directory that `configure' is in and in `..'. + + If you have to use a `make' that does not supports the `VPATH' +variable, you have to compile the package for one architecture at a time +in the source code directory. After you have installed the package for +one architecture, use `make distclean' before reconfiguring for another +architecture. + +Installation Names +================== + + By default, `make install' will install the package's files in +`/usr/local/bin', `/usr/local/man', etc. You can specify an +installation prefix other than `/usr/local' by giving `configure' the +option `--prefix=PATH'. + + You can specify separate installation prefixes for +architecture-specific files and architecture-independent files. If you +give `configure' the option `--exec-prefix=PATH', the package will use +PATH as the prefix for installing programs and libraries. +Documentation and other data files will still use the regular prefix. + + In addition, if you use an unusual directory layout you can give +options like `--bindir=PATH' to specify different values for particular +kinds of files. Run `configure --help' for a list of the directories +you can set and what kinds of files go in them. + + If the package supports it, you can cause programs to be installed +with an extra prefix or suffix on their names by giving `configure' the +option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. + +Optional Features +================= + + Some packages pay attention to `--enable-FEATURE' options to +`configure', where FEATURE indicates an optional part of the package. +They may also pay attention to `--with-PACKAGE' options, where PACKAGE +is something like `gnu-as' or `x' (for the X Window System). The +`README' should mention any `--enable-' and `--with-' options that the +package recognizes. + + For packages that use the X Window System, `configure' can usually +find the X include and library files automatically, but if it doesn't, +you can use the `configure' options `--x-includes=DIR' and +`--x-libraries=DIR' to specify their locations. + +Specifying the System Type +========================== + + There may be some features `configure' can not figure out +automatically, but needs to determine by the type of host the package +will run on. Usually `configure' can figure that out, but if it prints +a message saying it can not guess the host type, give it the +`--host=TYPE' option. TYPE can either be a short name for the system +type, such as `sun4', or a canonical name with three fields: + CPU-COMPANY-SYSTEM + +See the file `config.sub' for the possible values of each field. If +`config.sub' isn't included in this package, then this package doesn't +need to know the host type. + + If you are building compiler tools for cross-compiling, you can also +use the `--target=TYPE' option to select the type of system they will +produce code for and the `--build=TYPE' option to select the type of +system on which you are compiling the package. + +Sharing Defaults +================ + + If you want to set default values for `configure' scripts to share, +you can create a site shell script called `config.site' that gives +default values for variables like `CC', `cache_file', and `prefix'. +`configure' looks for `PREFIX/share/config.site' if it exists, then +`PREFIX/etc/config.site' if it exists. Or, you can set the +`CONFIG_SITE' environment variable to the location of the site script. +A warning: not all `configure' scripts look for a site script. + +Operation Controls +================== + + `configure' recognizes the following options to control how it +operates. + +`--cache-file=FILE' + Use and save the results of the tests in FILE instead of + `./config.cache'. Set FILE to `/dev/null' to disable caching, for + debugging `configure'. + +`--help' + Print a summary of the options to `configure', and exit. + +`--quiet' +`--silent' +`-q' + Do not print messages saying which checks are being made. To + suppress all normal output, redirect it to `/dev/null' (any error + messages will still be shown). + +`--srcdir=DIR' + Look for the package's source code in directory DIR. Usually + `configure' can determine that directory automatically. + +`--version' + Print the version of Autoconf used to generate the `configure' + script, and exit. + +`configure' also accepts some other, not widely useful, options. + diff --git a/doc/guide/release/autoconf.sdf b/doc/guide/release/autoconf.sdf new file mode 100644 index 0000000..008c288 --- /dev/null +++ b/doc/guide/release/autoconf.sdf @@ -0,0 +1,16 @@ +# $OpenLDAP$ +# +# Generic Autoconf INSTALL +# + +H1: Generic configure Instructions + +#!block inline +#<FONT FACE="Courier"> +#!endblock + +!include "../release/autoconf-install.txt" ; verbatim + +#!block inline +#</FONT> +#!endblock diff --git a/doc/guide/release/copyright-plain.sdf b/doc/guide/release/copyright-plain.sdf new file mode 100644 index 0000000..f5e838e --- /dev/null +++ b/doc/guide/release/copyright-plain.sdf @@ -0,0 +1,10 @@ +# $OpenLDAP$ +# Copyright 1999-2022 The OpenLDAP Foundation, All Rights Reserved. +# COPYING RESTRICTIONS APPLY, see COPYRIGHT. + +# +# Plain Copyright for Software Distribution +# +!define HTML_TITLE "OpenLDAP Copyright Notices" +!include "../plain.sdf" +!include "copyright.sdf"; plain diff --git a/doc/guide/release/copyright.sdf b/doc/guide/release/copyright.sdf new file mode 100644 index 0000000..90ff8a4 --- /dev/null +++ b/doc/guide/release/copyright.sdf @@ -0,0 +1,89 @@ +# $OpenLDAP$ +# Copyright 1999-2022 The OpenLDAP Foundation, All Rights Reserved. +# COPYING RESTRICTIONS APPLY, see COPYRIGHT. + +# This file should match ../../../COPYRIGHT (except in formatting) + +!if OPT_PP_HTML +!define copyright '[[c]] Copyright' +!else +!define copyright 'Copyright' +!endif + +H1: OpenLDAP Software Copyright Notices + +H2: OpenLDAP Copyright Notice + +!block nofill +[[copyright]] 1998-2013 The OpenLDAP Foundation. +{{All rights reserved.}} +!endblock + +Redistribution and use in source and binary forms, with or without +modification, are permitted {{only as authorized}} by the {{SECT:OpenLDAP +Public License}}. + +A copy of this license is available in file {{F:LICENSE}} in the +top-level directory of the distribution or, alternatively, at +<{{URL:http://www.OpenLDAP.org/license.html}}>. + +OpenLDAP is a registered trademark of the OpenLDAP Foundation. + +Individual files and/or contributed packages may be copyright by +other parties and their use subject to additional restrictions. + +This work is derived from the University of Michigan LDAP v3.3 +distribution. Information concerning this software is available +at <{{URL:http://www.umich.edu/~dirsvcs/ldap/ldap.html}}>. + +This work also contains materials derived from public sources. + +Additional information about OpenLDAP software can be obtained at +<{{URL:http://www.OpenLDAP.org/}}>. + + +H2: Additional Copyright Notices + +!block nofill +Portions [[copyright]] 1998-2013 Kurt D. Zeilenga. +Portions [[copyright]] 1998-2006 Net Boolean Incorporated. +Portions [[copyright]] 2001-2006 IBM Corporation. +{{All rights reserved.}} +!endblock + +Redistribution and use in source and binary forms, with or without +modification, are permitted only as authorized by the {{SECT:OpenLDAP +Public License}}. + + +!block nofill +Portions [[copyright]] 1999-2008 Howard Y.H. Chu. +Portions [[copyright]] 1999-2008 Symas Corporation. +Portions [[copyright]] 1998-2003 Hallvard B. Furuseth. +Portions [[copyright]] 2007-2011 Gavin Henry. +Portions [[copyright]] 2007-2011 Suretec Systems Limited. +{{All rights reserved.}} +!endblock + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that this notice is preserved. +The names of the copyright holders may not be used to endorse or +promote products derived from this software without their specific +prior written permission. This software is provided ``as is'' +without express or implied warranty. + + +H2: University of Michigan Copyright Notice + +!block nofill +Portions [[copyright]] 1992-1996 Regents of the University of Michigan. +{{All rights reserved.}} +!endblock + +Redistribution and use in source and binary forms are permitted +provided that this notice is preserved and that due credit is given +to the University of Michigan at Ann Arbor. The name of the University +may not be used to endorse or promote products derived from this +software without specific prior written permission. This software +is provided ``as is'' without express or implied warranty. + diff --git a/doc/guide/release/install.sdf b/doc/guide/release/install.sdf new file mode 100644 index 0000000..5825fcc --- /dev/null +++ b/doc/guide/release/install.sdf @@ -0,0 +1,100 @@ +# $OpenLDAP$ +# Copyright 1999-2022 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}}) 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. + +P2: Making and Installing the OpenLDAP Distribution + +^ Unpack the distribution and change directory: + +E: % tar xfz openldap-VERSION.tgz +E: % cd openldap-VERSION + +.(replacing {{EX:VERSION}} with the appropriate version string). If +you are reading this file, you probably have already done this! + + ++ Type: + +E: % ./configure --help + +.to list available configuration options. + +.The {{EX:configure}} script also looks for compiler/linker options +on the command line and in the environment. These include: + +> Variable Description Example +> CC C compiler gcc +> CFLAGS C flags -O -g +> CPPFLAGS cpp flags -I/path/include -D__FOO__=42 +> LDFLAGS ld flags -L/usr/local/lib +> LIBS libraries -llib +> PATH command path /usr/local/bin:/usr/bin:/bin + +!if $var{'OPT_TARGET'} eq 'txt' +.See doc/install/configure for generic configure documentation. +!endif + ++ Configure the build system: + +E: % ./configure [options] [var=value ...] + +.If all goes well, the {{EX:configure}} script will automatically detect +the appropriate settings. If the {{EX:configure}} script fails, you should +read the {{FILE:config.log}} file that it generated to see what it was trying +to do and exactly what failed. You may need to specify additional +options and/or variables besides those listed above to +obtain desired results, depending on your operating system. + ++ 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 3 after reviewing the configuration settings. + ++ Test the standalone system: + +.This step requires the standalone LDAP server, {{slapd}}(8), +with {{MDB}} support. + +E: % make test + +.If all goes well, the system has been built as configured. If not, +return to step 2 after reviewing your configuration settings. + ++ Install the software. 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. Enjoy! + +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 +{{FILE:/usr/local/etc/openldap}}). + +> ldap.conf client defaults +> slapd.conf Standalone LDAP daemon +> lload.conf LDAP Load Balancer daemon +> schema/*.schema Schema Definitions + diff --git a/doc/guide/release/license-plain.sdf b/doc/guide/release/license-plain.sdf new file mode 100644 index 0000000..c84a006 --- /dev/null +++ b/doc/guide/release/license-plain.sdf @@ -0,0 +1,10 @@ +# $OpenLDAP$ +# Copyright 1999-2022 The OpenLDAP Foundation, All Rights Reserved. +# COPYING RESTRICTIONS APPLY, see COPYRIGHT. + +# +# Plain Copyright for Software Distribution +# +!define HTML_TITLE "OpenLDAP Public License" +!include "../plain.sdf" +!include "license.sdf"; plain diff --git a/doc/guide/release/license.sdf b/doc/guide/release/license.sdf new file mode 100644 index 0000000..939fcf8 --- /dev/null +++ b/doc/guide/release/license.sdf @@ -0,0 +1,15 @@ +# $OpenLDAP$ +# Copyright 2000-2022 The OpenLDAP Foundation, All Rights Reserved. +# COPYING RESTRICTIONS APPLY, see COPYRIGHT. + +H1: OpenLDAP Public License + +#!block inline +#<FONT FACE="Courier"> +#!endblock + +!include "../../../LICENSE" ; verbatim + +#!block inline +#</FONT> +#!endblock |