diff --git a/doc/guide/LDAPwww.gif b/doc/guide/LDAPwww.gif deleted file mode 100644 index b593bc983e..0000000000 Binary files a/doc/guide/LDAPwww.gif and /dev/null differ diff --git a/doc/guide/config.sdf b/doc/guide/admin/config.sdf similarity index 86% rename from doc/guide/config.sdf rename to doc/guide/admin/config.sdf index 2d7399fbc4..c91acf56c0 100644 --- a/doc/guide/config.sdf +++ b/doc/guide/admin/config.sdf @@ -14,7 +14,7 @@ In this configuration, you run a {{I:slapd}} which provides directory service for your local domain only. It does not interact with other directory servers in any way. This configuration is shown in Figure 2. -!import "figure_2.gif"; align="center"; title="Local service via slapd configuration" +!import "config_local.gif"; align="center"; title="Local service via slapd configuration" FT: Figure 2: Local service via slapd configuration. Use this configuration if you are just starting out (it's the one the @@ -32,7 +32,7 @@ X.500 world (you don't have to run the ldapd yourself - you can just point to somebody else who does and doesn't mind you pointing to their service). This configuration is shown in Figure 3. -!import "figure_3.gif"; align="center"; title="Local service via slapd + X.500 referrals configuration" +!import "config_x500ref.gif"; align="center"; title="Local service via slapd + X.500 referrals configuration" FT: Figure 3: Local service via slapd + X.500 referrals configuration Use this configuration if you want to provide local service but still want @@ -50,7 +50,7 @@ rest of the X.500 world. LDAP clients gain access to the directory through an ldapd which runs at your site. This configuration is shown in Figure 4. -!import "figure_4.gif"; align="center"; title="Local service via X.500 and ldapd configuration" +!import "config_x500fe.gif"; align="center"; title="Local service via X.500 and ldapd configuration" FT: Figure 4: Local service via X.500 and ldapd configuration Use this configuration if you are already running an X.500 service. @@ -65,7 +65,7 @@ The slurpd daemon is used to propagate changes from a master slapd to one or more slave slapds. An example master-slave configuration is shown in figure 5. -!import "figure_5.gif"; align="center"; title="Master slapd with two slaves replicated with slurpd" +!import "config_repl.gif"; align="center"; title="Master slapd with two slaves replicated with slurpd" FT: Figure 5: Master slapd with two slaves replicated with slurpd This configuration can be used in conjunction with the first two diff --git a/doc/guide/figure_2.gif b/doc/guide/admin/config_local.gif similarity index 100% rename from doc/guide/figure_2.gif rename to doc/guide/admin/config_local.gif diff --git a/doc/guide/figure_5.gif b/doc/guide/admin/config_repl.gif similarity index 100% rename from doc/guide/figure_5.gif rename to doc/guide/admin/config_repl.gif diff --git a/doc/guide/figure_4.gif b/doc/guide/admin/config_x500fe.gif similarity index 100% rename from doc/guide/figure_4.gif rename to doc/guide/admin/config_x500fe.gif diff --git a/doc/guide/figure_3.gif b/doc/guide/admin/config_x500ref.gif similarity index 100% rename from doc/guide/figure_3.gif rename to doc/guide/admin/config_x500ref.gif diff --git a/doc/guide/dbtools.sdf b/doc/guide/admin/dbtools.sdf similarity index 100% rename from doc/guide/dbtools.sdf rename to doc/guide/admin/dbtools.sdf diff --git a/doc/guide/install.sdf b/doc/guide/admin/install.sdf similarity index 100% rename from doc/guide/install.sdf rename to doc/guide/admin/install.sdf diff --git a/doc/guide/intro.sdf b/doc/guide/admin/intro.sdf similarity index 99% rename from doc/guide/intro.sdf rename to doc/guide/admin/intro.sdf index 27da553be1..24dbcc54bd 100644 --- a/doc/guide/intro.sdf +++ b/doc/guide/admin/intro.sdf @@ -69,7 +69,7 @@ think of. Figure 1 shows an example LDAP directory tree, which should help make things clear. -!import "figure_1.gif"; align="center"; title="An example LDAP directory tree" +!import "intro_tree.gif"; align="center"; title="An example LDAP directory tree" FT: Figure 1: An example LDAP directory tree. diff --git a/doc/guide/figure_1.gif b/doc/guide/admin/intro_tree.gif similarity index 100% rename from doc/guide/figure_1.gif rename to doc/guide/admin/intro_tree.gif diff --git a/doc/guide/admin/master.sdf b/doc/guide/admin/master.sdf new file mode 100644 index 0000000000..9c85a69cc0 --- /dev/null +++ b/doc/guide/admin/master.sdf @@ -0,0 +1,31 @@ +# Copyright 1999, The OpenLDAP Foundation, All Rights Reserved. +# COPYING RESTRICTIONS APPLY, see COPYRIGHT. +# +# SDF master file for the OpenLDAP Administrator's guide +# master.sdf + +# title information +!include "title.sdf" + +# Document copyright, publishing info, acknowledgements, preface +!include "preamble.sdf"; plain + +# Chapters +!include "intro.sdf"; chapter +!include "quickstart.sdf"; chapter +!include "config.sdf"; chapter +!include "install.sdf"; chapter +!include "slapdconfig.sdf"; chapter +!include "runningslapd.sdf"; chapter +!include "monitoringslapd.sdf"; chapter +!include "dbtools.sdf"; chapter +!include "tuning.sdf"; chapter +!include "referrals.sdf"; chapter +!include "replication.sdf"; chapter + +# Appendices +!include "../release/autoconf.sdf"; appendix + +# Software Copyright/License +!include "../release/copyright.sdf"; appendix +!include "../release/license.sdf"; appendix diff --git a/doc/guide/monitoringslapd.sdf b/doc/guide/admin/monitoringslapd.sdf similarity index 100% rename from doc/guide/monitoringslapd.sdf rename to doc/guide/admin/monitoringslapd.sdf diff --git a/doc/guide/preamble.sdf b/doc/guide/admin/preamble.sdf similarity index 100% rename from doc/guide/preamble.sdf rename to doc/guide/admin/preamble.sdf diff --git a/doc/guide/quickstart.sdf b/doc/guide/admin/quickstart.sdf similarity index 100% rename from doc/guide/quickstart.sdf rename to doc/guide/admin/quickstart.sdf diff --git a/doc/guide/referrals.sdf b/doc/guide/admin/referrals.sdf similarity index 100% rename from doc/guide/referrals.sdf rename to doc/guide/admin/referrals.sdf diff --git a/doc/guide/figure_6.gif b/doc/guide/admin/replication.gif similarity index 100% rename from doc/guide/figure_6.gif rename to doc/guide/admin/replication.gif diff --git a/doc/guide/replication.sdf b/doc/guide/admin/replication.sdf similarity index 99% rename from doc/guide/replication.sdf rename to doc/guide/admin/replication.sdf index a915227c7f..660536e7e9 100644 --- a/doc/guide/replication.sdf +++ b/doc/guide/admin/replication.sdf @@ -381,7 +381,7 @@ X.500 DSA, slurpd runs on the master slapd host, and sends changes to an ldapd which acts as a gateway to the X.500 DSA: -!import "figure_1.gif"; align="center"; title="Replication from slapd to an X.500 DSA" +!import "replication.gif"; align="center"; title="Replication from slapd to an X.500 DSA" FT: Figure 6: Replication from slapd to an X.500 DSA Note that the X.500 DSA must be a read-only copy. Since diff --git a/doc/guide/runningslapd.sdf b/doc/guide/admin/runningslapd.sdf similarity index 100% rename from doc/guide/runningslapd.sdf rename to doc/guide/admin/runningslapd.sdf diff --git a/doc/guide/slapdconfig.sdf b/doc/guide/admin/slapdconfig.sdf similarity index 100% rename from doc/guide/slapdconfig.sdf rename to doc/guide/admin/slapdconfig.sdf diff --git a/doc/guide/title.sdf b/doc/guide/admin/title.sdf similarity index 100% rename from doc/guide/title.sdf rename to doc/guide/admin/title.sdf diff --git a/doc/guide/tuning.sdf b/doc/guide/admin/tuning.sdf similarity index 100% rename from doc/guide/tuning.sdf rename to doc/guide/admin/tuning.sdf diff --git a/doc/guide/master.sdf b/doc/guide/master.sdf deleted file mode 100644 index 62471e9586..0000000000 --- a/doc/guide/master.sdf +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 1999, The OpenLDAP Foundation, All Rights Reserved. -# COPYING RESTRICTIONS APPLY, see COPYRIGHT. -# -# master.sdf -# SDF master file for the OpenLDAP Administrator's guide - -# title information -!include "title.sdf" - -# Document copyright, publishing info, acknowledgements, preface -!include "preamble.sdf"; plain - -# Chapters -!include "intro.sdf" -!include "quickstart.sdf" -!include "config.sdf" -!include "install.sdf" -!include "slapdconfig.sdf" -!include "runningslapd.sdf" -!include "monitoringslapd.sdf" -!include "dbtools.sdf" -!include "tuning.sdf" -!include "referrals.sdf" -!include "replication.sdf" - -# Appendices - -# Software Copyright/License -!include "copyright.sdf"; appendix -!include "license.sdf"; appendix diff --git a/doc/guide/release/autoconf-install.txt b/doc/guide/release/autoconf-install.txt new file mode 100644 index 0000000000..50dbe439d0 --- /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 0000000000..f5c41f0cf1 --- /dev/null +++ b/doc/guide/release/autoconf.sdf @@ -0,0 +1,6 @@ +# +# Generic Autoconf INSTALL +# + +H1: General Configure Instructions +!include "autoconf-install.txt" ; verbatim diff --git a/doc/guide/copyright-plain.sdf b/doc/guide/release/copyright-plain.sdf similarity index 100% rename from doc/guide/copyright-plain.sdf rename to doc/guide/release/copyright-plain.sdf diff --git a/doc/guide/copyright.sdf b/doc/guide/release/copyright.sdf similarity index 100% rename from doc/guide/copyright.sdf rename to doc/guide/release/copyright.sdf diff --git a/doc/guide/license-plain.sdf b/doc/guide/release/license-plain.sdf similarity index 100% rename from doc/guide/license-plain.sdf rename to doc/guide/release/license-plain.sdf diff --git a/doc/guide/license.sdf b/doc/guide/release/license.sdf similarity index 100% rename from doc/guide/license.sdf rename to doc/guide/release/license.sdf