openldap/doc/guide/admin/master.sdf

# $OpenLDAP$
# Copyright 1999-2018 The OpenLDAP Foundation, All Rights Reserved.
# COPYING RESTRICTIONS APPLY, see COPYRIGHT.
#
# master file for the OpenLDAP Administrator's Guide
#
#
# To generate guide for distribution:
#   sdf -2html guide.sdf
#   sdf -2txt guide.sdf
#   cp guide.{html,txt} $distribution/doc/guide
#
# To generate pages for web
#	sdf -2topics index.sdf
#
!include "../preamble.sdf"; plain

# title information
!include "title.sdf"
PB:

# Document copyright, publishing info, acknowledgements, preface
!include "preface.sdf"; about
PB:

# Chapters
!include "intro.sdf"; chapter
PB:

!include "quickstart.sdf"; chapter
PB:

!include "config.sdf"; chapter
PB:

!include "install.sdf"; chapter
PB:

!include "slapdconf2.sdf"; chapter
PB:

!include "slapdconfig.sdf"; chapter
PB:

!include "runningslapd.sdf"; chapter
PB:

!include "access-control.sdf"; chapter
PB:

!include "limits.sdf"; chapter
PB:

!include "dbtools.sdf"; chapter
PB:

!include "backends.sdf"; chapter
PB:

!include "overlays.sdf"; chapter
PB:

!include "schema.sdf"; chapter
PB:

!include "security.sdf"; chapter
PB:

!include "sasl.sdf"; chapter
PB:

!include "tls.sdf"; chapter
PB:

!include "referrals.sdf"; chapter
PB:

!include "replication.sdf"; chapter
PB:

!include "maintenance.sdf"; chapter
PB:

!include "monitoringslapd.sdf"; chapter
PB:

!include "tuning.sdf"; chapter
PB:

!include "troubleshooting.sdf"; chapter
PB:

# Appendices 
!include "appendix-changes.sdf"; appendix
PB:

# Upgrade from 2.3.x
!include "appendix-upgrading.sdf"; appendix
PB:

# Common Errors
!include "appendix-common-errors.sdf"; appendix
PB:

# What versions we recommend 
!include "appendix-recommended-versions.sdf"; appendix
PB:

# Real Deployments
!include "appendix-deployments.sdf"; appendix
PB:

# Contributions
!include "appendix-contrib.sdf"; appendix
PB:

# Config file examples
!include "appendix-configs.sdf"; appendix
PB:

# LDAP Result Codes
!include "appendix-ldap-result-codes.sdf"; appendix
PB:


# Terms
!include "glossary.sdf"; appendix
PB:

# Autoconf 
!include "../release/autoconf.sdf"; appendix
PB:

# Software Copyright/License
!include "../release/copyright.sdf"; appendix
PB:

!include "../release/license.sdf"; appendix
Add RCSids 1999-09-30 12:57:45 -04:00			`# $OpenLDAP$`
Happy New Year 2018-03-22 11:35:24 -04:00			`# Copyright 1999-2018 The OpenLDAP Foundation, All Rights Reserved.`
Reorganize tree to better support multiple documents. 1999-05-01 18:11:02 -04:00			`# COPYING RESTRICTIONS APPLY, see COPYRIGHT.`
			`#`
Cleanup formatting. Reorganization preamble information for sharing between documents. Add -2topics navigation. 1999-05-02 21:19:22 -04:00			`# master file for the OpenLDAP Administrator's Guide`
			`#`
			`#`
			`# To generate guide for distribution:`
			`# sdf -2html guide.sdf`
			`# sdf -2txt guide.sdf`
			`# cp guide.{html,txt} $distribution/doc/guide`
			`#`
			`# To generate pages for web`
			`# sdf -2topics index.sdf`
			`#`
			`!include "../preamble.sdf"; plain`
Reorganize tree to better support multiple documents. 1999-05-01 18:11:02 -04:00
			`# title information`
			`!include "title.sdf"`
Revamp chapter 1 2000-07-22 20:20:04 -04:00			`PB:`
Reorganize tree to better support multiple documents. 1999-05-01 18:11:02 -04:00
			`# Document copyright, publishing info, acknowledgements, preface`
Cleanup formatting. Reorganization preamble information for sharing between documents. Add -2topics navigation. 1999-05-02 21:19:22 -04:00			`!include "preface.sdf"; about`
Revamp chapter 1 2000-07-22 20:20:04 -04:00			`PB:`
Reorganize tree to better support multiple documents. 1999-05-01 18:11:02 -04:00
			`# Chapters`
			`!include "intro.sdf"; chapter`
Revamp chapter 1 2000-07-22 20:20:04 -04:00			`PB:`
Comment out tuning and monitoring chapters... 2000-08-07 22:25:43 -04:00
Reorganize tree to better support multiple documents. 1999-05-01 18:11:02 -04:00			`!include "quickstart.sdf"; chapter`
Revamp chapter 1 2000-07-22 20:20:04 -04:00			`PB:`
Comment out tuning and monitoring chapters... 2000-08-07 22:25:43 -04:00
Reorganize tree to better support multiple documents. 1999-05-01 18:11:02 -04:00			`!include "config.sdf"; chapter`
Revamp chapter 1 2000-07-22 20:20:04 -04:00			`PB:`
Comment out tuning and monitoring chapters... 2000-08-07 22:25:43 -04:00
Reorganize tree to better support multiple documents. 1999-05-01 18:11:02 -04:00			`!include "install.sdf"; chapter`
Revamp chapter 1 2000-07-22 20:20:04 -04:00			`PB:`
Comment out tuning and monitoring chapters... 2000-08-07 22:25:43 -04:00
Preliminary slapd.d info, very incomplete 2005-05-10 07:32:25 -04:00			`!include "slapdconf2.sdf"; chapter`
			`PB:`

Reorganize tree to better support multiple documents. 1999-05-01 18:11:02 -04:00			`!include "slapdconfig.sdf"; chapter`
Revamp chapter 1 2000-07-22 20:20:04 -04:00			`PB:`
Comment out tuning and monitoring chapters... 2000-08-07 22:25:43 -04:00
reorder chapters and start of a migration/upgrade section. 2008-11-25 10:14:23 -05:00			`!include "runningslapd.sdf"; chapter`
New Access Control Section, including a new Sets section incorporating ITS#5278, ITS#5279 and ITS#5281. 2008-03-14 18:53:34 -04:00			`PB:`

reorder chapters and start of a migration/upgrade section. 2008-11-25 10:14:23 -05:00			`!include "access-control.sdf"; chapter`
Revamp chapter 1 2000-07-22 20:20:04 -04:00			`PB:`
Comment out tuning and monitoring chapters... 2000-08-07 22:25:43 -04:00
(ITS#5818) Limits chapter for Admin Guide 2008-11-25 13:10:34 -05:00			`!include "limits.sdf"; chapter`
			`PB:`

Reorganize tree to better support multiple documents. 1999-05-01 18:11:02 -04:00			`!include "dbtools.sdf"; chapter`
Revamp chapter 1 2000-07-22 20:20:04 -04:00			`PB:`
Comment out tuning and monitoring chapters... 2000-08-07 22:25:43 -04:00
New TOC, new sdf files and merging/reworking of existing data. Makefile updated and tested also. 2007-06-01 13:45:42 -04:00			`!include "backends.sdf"; chapter`
			`PB:`

			`!include "overlays.sdf"; chapter`
			`PB:`

Split out schema from slapdconfig.sdf and flush it out a bit (more work needed). Need separate "Advanced Access Control" chapter as well (but leaving 'basic' in slapdconfig.sdf. 2000-08-10 22:52:27 -04:00			`!include "schema.sdf"; chapter`
			`PB:`

Reorganize chapters 2002-06-17 20:05:23 -04:00			`!include "security.sdf"; chapter`
			`PB:`

Rework intro and sasl a bit. Add TLS.sdf (needs to be written) Reorder chapter 2001-05-12 02:15:42 -04:00			`!include "sasl.sdf"; chapter`
			`PB:`

			`!include "tls.sdf"; chapter`
			`PB:`

New TOC, new sdf files and merging/reworking of existing data. Makefile updated and tested also. 2007-06-01 13:45:42 -04:00			`!include "referrals.sdf"; chapter`
(ITS#4770) monitoringslapd.sdf patch from Gavin Henry 2006-12-08 12:18:37 -05:00			`PB:`
Reorganize chapters 2002-06-17 20:05:23 -04:00
New TOC, new sdf files and merging/reworking of existing data. Makefile updated and tested also. 2007-06-01 13:45:42 -04:00			`!include "replication.sdf"; chapter`
			`PB:`
Comment out tuning and monitoring chapters... 2000-08-07 22:25:43 -04:00
New TOC, new sdf files and merging/reworking of existing data. Makefile updated and tested also. 2007-06-01 13:45:42 -04:00			`!include "maintenance.sdf"; chapter`
Revamp chapter 1 2000-07-22 20:20:04 -04:00			`PB:`
Comment out tuning and monitoring chapters... 2000-08-07 22:25:43 -04:00
New TOC, new sdf files and merging/reworking of existing data. Makefile updated and tested also. 2007-06-01 13:45:42 -04:00			`!include "monitoringslapd.sdf"; chapter`
Revamp chapter 1 2000-07-22 20:20:04 -04:00			`PB:`
Reorganize tree to better support multiple documents. 1999-05-01 18:11:02 -04:00
New TOC, new sdf files and merging/reworking of existing data. Makefile updated and tested also. 2007-06-01 13:45:42 -04:00			`!include "tuning.sdf"; chapter`
Initial proxy cache and syncrepl chapters 2003-09-16 01:16:33 -04:00			`PB:`

New TOC, new sdf files and merging/reworking of existing data. Makefile updated and tested also. 2007-06-01 13:45:42 -04:00			`!include "troubleshooting.sdf"; chapter`
Initial proxy cache and syncrepl chapters 2003-09-16 01:16:33 -04:00			`PB:`

Reorganize tree to better support multiple documents. 1999-05-01 18:11:02 -04:00			`# Appendices`
New Changes Appendix, plus various other additions and fixes. 2007-08-24 19:24:34 -04:00			`!include "appendix-changes.sdf"; appendix`
			`PB:`

Upgrading from 2.3.x Appendix added. Please comment. 2007-09-03 18:59:36 -04:00			`# Upgrade from 2.3.x`
			`!include "appendix-upgrading.sdf"; appendix`
			`PB:`

Add new appendices to main docs and spell check 2007-09-30 18:47:48 -04:00			`# Common Errors`
			`!include "appendix-common-errors.sdf"; appendix`
			`PB:`

New appendix on dependency versions. Could someone look at the table and tell me why I'm getting: './appendix-recommended-versions.sdf warning, block on 16: {{ phrase not terminated'. Everything looks matched to me. New to tables ;-) 2007-10-13 17:54:42 -04:00			`# What versions we recommend`
			`!include "appendix-recommended-versions.sdf"; appendix`
			`PB:`

Add new appendices to main docs and spell check 2007-09-30 18:47:48 -04:00			`# Real Deployments`
			`!include "appendix-deployments.sdf"; appendix`
			`PB:`

			`# Contributions`
			`!include "appendix-contrib.sdf"; appendix`
			`PB:`

New TOC, new sdf files and merging/reworking of existing data. Makefile updated and tested also. 2007-06-01 13:45:42 -04:00			`# Config file examples`
			`!include "appendix-configs.sdf"; appendix`
			`PB:`

Add new appendices to main docs and spell check 2007-09-30 18:47:48 -04:00			`# LDAP Result Codes`
			`!include "appendix-ldap-result-codes.sdf"; appendix`
			`PB:`


Add glossary of terms 2006-12-06 22:26:45 -05:00			`# Terms`
			`!include "glossary.sdf"; appendix`
			`PB:`

			`# Autoconf`
Reorganize tree to better support multiple documents. 1999-05-01 18:11:02 -04:00			`!include "../release/autoconf.sdf"; appendix`
Revamp chapter 1 2000-07-22 20:20:04 -04:00			`PB:`
Reorganize tree to better support multiple documents. 1999-05-01 18:11:02 -04:00
			`# Software Copyright/License`
			`!include "../release/copyright.sdf"; appendix`
Revamp chapter 1 2000-07-22 20:20:04 -04:00			`PB:`
Comment out tuning and monitoring chapters... 2000-08-07 22:25:43 -04:00
Reorganize tree to better support multiple documents. 1999-05-01 18:11:02 -04:00			`!include "../release/license.sdf"; appendix`