From cbfcbc3466f87acf62312a9fb4f746a728d57d70 Mon Sep 17 00:00:00 2001 From: Kurt Zeilenga Date: Sat, 25 Sep 1999 17:17:51 +0000 Subject: [PATCH] Misc cleanup --- doc/guide/admin/config.sdf | 8 ++++---- doc/guide/admin/intro.sdf | 2 +- doc/guide/admin/quickstart.sdf | 9 +++++---- doc/guide/admin/title.sdf | 2 +- doc/guide/preamble.sdf | 25 +++++++++++++++++++++++-- doc/guide/release/copyright-plain.sdf | 6 +++++- doc/guide/release/copyright.sdf | 6 +++--- doc/guide/release/license-plain.sdf | 5 +++++ doc/guide/release/license.sdf | 25 +++++++++++++++++-------- 9 files changed, 64 insertions(+), 24 deletions(-) diff --git a/doc/guide/admin/config.sdf b/doc/guide/admin/config.sdf index 439cca466a..ee2e260d9a 100644 --- a/doc/guide/admin/config.sdf +++ b/doc/guide/admin/config.sdf @@ -15,7 +15,7 @@ for your local domain only. It does not interact with other directory servers in any way. This configuration is shown in Figure 2. !import "config_local.gif"; align="center"; title="Local service via slapd configuration" -FT: Figure 2: Local service via slapd configuration. +FT[align="Center"] Figure 2: Local service via slapd configuration. Use this configuration if you are just starting out (it's the one the quick-start guide makes for you) or if you want to provide a local @@ -33,7 +33,7 @@ point to somebody else who does and doesn't mind you pointing to their service). This configuration is shown in Figure 3. !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 +FT[align="Center"] Figure 3: Local service via slapd + X.500 referrals configuration Use this configuration if you want to provide local service but still want to be connected to the rest of the X.500 world. Remember, you don't @@ -51,7 +51,7 @@ through an ldapd which runs at your site. This configuration is shown in Figure 4. !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 +FT[align="Center"] Figure 4: Local service via X.500 and ldapd configuration Use this configuration if you are already running an X.500 service. Slapd is not involved in this configuration, so you can probably stop @@ -66,7 +66,7 @@ to one or more slave slapds. An example master-slave configuration is shown in figure 5. !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 +FT[align="Center"] Figure 5: Master slapd with two slaves replicated with slurpd This configuration can be used in conjunction with the first two configurations in situations where a single slapd does not provide the diff --git a/doc/guide/admin/intro.sdf b/doc/guide/admin/intro.sdf index 668d3f4f18..f4c84bef40 100644 --- a/doc/guide/admin/intro.sdf +++ b/doc/guide/admin/intro.sdf @@ -73,7 +73,7 @@ make things clear. !import "intro_tree.gif"; align="center"; title="An example LDAP directory tree" -FT: Figure 1: An example LDAP directory tree. +FT[align="Center"] Figure 1: An example LDAP directory tree. In addition, LDAP allows you to control which attributes are required and diff --git a/doc/guide/admin/quickstart.sdf b/doc/guide/admin/quickstart.sdf index 4592f61975..17356e723e 100644 --- a/doc/guide/admin/quickstart.sdf +++ b/doc/guide/admin/quickstart.sdf @@ -18,12 +18,13 @@ you can retrieve using this URL: .If you are reading this guide, you have probably already done this. -+ {{B:Untar the distribution}}. Pick a place for the LDAP source to live, cd ++ {{B:Untar the distribution}}. +.Pick a place for the LDAP source to live, cd there, and untar it. For example: -.{{EX: cd /usr/local/src}} -.{{EX: gunzip -c openldap-release.tgz | tar xvfB -}} -.{{EX: cd ldap}} +.{{EX:cd /usr/local/src}} +.{{EX:gunzip -c openldap-release.tgz | tar xvfB -}} +.{{EX:cd ldap}} + {{B: Configure the software}}. . You will have to edit two files to configure things for your site. diff --git a/doc/guide/admin/title.sdf b/doc/guide/admin/title.sdf index 9c1f8f3654..271d116ae6 100644 --- a/doc/guide/admin/title.sdf +++ b/doc/guide/admin/title.sdf @@ -5,7 +5,7 @@ # Master: master.sdf # -!define DOC_TYPE "OpenLDAP Administrators Guide" +!define DOC_TYPE "Administrator's Guide" !build_title diff --git a/doc/guide/preamble.sdf b/doc/guide/preamble.sdf index 1fc1e35cef..fd8a29bdea 100644 --- a/doc/guide/preamble.sdf +++ b/doc/guide/preamble.sdf @@ -5,21 +5,42 @@ # Preamble for all OpenLDAP SDF documents # +!default VERSION 2.0 + # # Paths are relative to the main subdirectories # !define DOC_AUTHOR "OpenLDAP <{{URL:http://www.openldap.org/}}>" -!define DOC_TYPE "OpenLDAP" +!define DOC_NAME "OpenLDAP" +!define DOC_TYPE "Guide" !define DOC_LOGO "../images/LDAPwww.gif" +# should create a smaller logo for HTML and TOPIC purposes #!define DOC_HTML_LOGO "../images/LDAPwww.gif" #!define DOC_TOPIC_LOGO "../images/LDAPwww.gif" !define DOC_LOF_TITLE "Figures" !define DOC_LOF - !define HTML_URL_HOME "http://www.openldap.org/" !define HTML_URL_CATALOG "../index.html" +!block organisations; data +Name Long Jump +OpenLDAP OpenLDAP http://www.openldap.org/ +OLF The OpenLDAP Foundation http://www.openldap.org/foundation/ +OLP The OpenLDAP Project http://www.openldap.org/project/ +UM University of Michigan http://www.umich.edu/ +IETF Internet Engineering Task Force http://www.ietf.org/ +!endblock + +!block terms; data +Term Definition +FAQ Frequently Asked Questions +ITS Issue Tracking System +LDAP Lightweight Directory Access Protocol +RFC Request for Comments +URL Uniform Resource Locator +WWW World Wide Web +!endblock diff --git a/doc/guide/release/copyright-plain.sdf b/doc/guide/release/copyright-plain.sdf index fda650e00f..391f5de1a5 100644 --- a/doc/guide/release/copyright-plain.sdf +++ b/doc/guide/release/copyright-plain.sdf @@ -1,5 +1,9 @@ +# Copyright 1999, The OpenLDAP Foundation, All Rights Reserved. +# COPYING RESTRICTIONS APPLY, see COPYRIGHT. + # # Plain Copyright for Software Distribution # -!define NO_C +!define HTML_TITLE "OpenLDAP Copyright" +!include "../plain.sdf" !include "copyright.sdf"; plain diff --git a/doc/guide/release/copyright.sdf b/doc/guide/release/copyright.sdf index 8bfad45bf8..bed69c2cad 100644 --- a/doc/guide/release/copyright.sdf +++ b/doc/guide/release/copyright.sdf @@ -1,10 +1,10 @@ # Copyright 1999, The OpenLDAP Foundation, All Rights Reserved. # COPYING RESTRICTIONS APPLY, see COPYRIGHT. -!if NO_C -!define copyright 'Copyright' -!else +!if OPT_PP_HTML !define copyright '[[c]] Copyright' +!else +!define copyright 'Copyright' !endif H1: OpenLDAP Software Copyrights diff --git a/doc/guide/release/license-plain.sdf b/doc/guide/release/license-plain.sdf index 5bd27b23ed..c800e1c98a 100644 --- a/doc/guide/release/license-plain.sdf +++ b/doc/guide/release/license-plain.sdf @@ -1,4 +1,9 @@ +# Copyright 1999, The OpenLDAP Foundation, All Rights Reserved. +# COPYING RESTRICTIONS APPLY, see COPYRIGHT. + # # Plain License 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 index ae2d8f3f1e..9bfbad7f3e 100644 --- a/doc/guide/release/license.sdf +++ b/doc/guide/release/license.sdf @@ -1,15 +1,24 @@ +# Copyright 1999, The OpenLDAP Foundation, All Rights Reserved. +# COPYING RESTRICTIONS APPLY, see COPYRIGHT. + +!if OPT_PP_HTML +!define copyright '[[c]] Copyright' +!else +!define copyright 'Copyright' +!endif + H1: The OpenLDAP Public License -Version 1.4, 18 January 1999 -Copyright 1998-1999, The OpenLDAP Foundation. -All Rights Reserved. +.Version 1.5, 5 May 1999 +.[[copyright]] 1998-1999, The OpenLDAP Foundation. +.All Rights Reserved. -. Note: This license is derived from the {{I:Artistic License}} -as distributed with the {{I:Perl Programming Language}}. +Note: This license is derived from the {{Artistic License}} +as distributed with the {{Perl Programming Language}}. As significant differences exist, {{B: the complete license should be read}}. -H2: Preamble +P2[notoc] Preamble The intent of this document is to state the conditions under which a Package may be copied, such that the Copyright Holder @@ -18,7 +27,7 @@ package, while giving the users of the package the right to use and distribute the Package in a more-or-less customary fashion, plus the right to make reasonable modifications. -H2: Definitions +P2[notoc] Definitions . "Package" refers to the collection of files distributed by the Copyright Holder, and derivatives of that collection of files @@ -45,7 +54,7 @@ itself, though there may be fees involved in handling the item. It also means that recipients of the item may redistribute it under the same conditions they received it. -H2: Terms and Conditions +P2[notoc] Terms and Conditions ^ You may make and give away verbatim copies of the source form of the Standard Version of this Package without restriction, provided -- 2.39.5