From 84583b6494bb063a6d8d06150449c09a5f14b25f Mon Sep 17 00:00:00 2001 From: Kurt Zeilenga Date: Sat, 9 Sep 2000 23:16:09 +0000 Subject: [PATCH] Update install docs Shift burden from INSTALL/Quick Start to install chapter Clean up example LDIF --- doc/guide/admin/dbtools.sdf | 32 ++++---- doc/guide/admin/install.sdf | 8 +- doc/guide/admin/quickstart.sdf | 26 +++--- doc/guide/release/install.sdf | 142 +++------------------------------ 4 files changed, 45 insertions(+), 163 deletions(-) diff --git a/doc/guide/admin/dbtools.sdf b/doc/guide/admin/dbtools.sdf index 560ed093b7..02cb58130c 100644 --- a/doc/guide/admin/dbtools.sdf +++ b/doc/guide/admin/dbtools.sdf @@ -83,13 +83,14 @@ could be used: > index cn,sn,uid > index objectClass pres,eq -See {{SECT:The slapd Configuration File}} section for more details -on this option. Once you have configured things to your liking, -start up slapd, connect with your LDAP client, and start adding -entries. For example, to add a the organizational entry followed -by a Postmaster entry using the {{I:ldapadd}} tool, you could create -an {{TERM:LDIF}} file called {{EX:entries.ldif}} with the contents: - +See {{SECT:The slapd Configuration File}} section for more details on +this option. Once you have configured things to your liking, start up +slapd, connect with your LDAP client, and start adding entries. For +example, to add an organization entry and an organizational role entry +using the {{I:ldapadd}} tool, you could create an {{TERM:LDIF}} file +called {{EX:entries.ldif}} with the contents: + +> # Organization for Example Corporation > dc=example, dc=com > objectClass=dcObject > objectClass=organization @@ -97,10 +98,11 @@ an {{TERM:LDIF}} file called {{EX:entries.ldif}} with the contents: > o=Example Corporation > description=The Example Corporation > -> cn=Postmaster, dc=example, dc=com +> # Organizational Role for Directory Manager +> cn=Manager, dc=example, dc=com > objectClass=organizationalRole -> cn=Postmaster -> description=OpenLDAP Postmaster +> cn=Manager +> description=Directory Manager and then use a command like this to actually create the entry: @@ -317,14 +319,14 @@ should be obtained from the file {{F:/path/to/file.jpeg}}. Multiple entries within the same LDIF file are separated by blank lines. Here's an example of an LDIF file containing three entries. -> # First Entry +> # Barbara's Entry > dn: cn=Barbara J Jensen, dc=example, dc=com > cn: Barbara J Jensen > cn: Babs Jensen > objectClass: person > sn: Jensen > -> # Second Entry +> # Bjorn's Entry > dn: cn=Bjorn J Jensen, dc=example, dc=com > cn: Bjorn J Jensen > cn: Bjorn Jensen @@ -332,10 +334,10 @@ lines. Here's an example of an LDIF file containing three entries. > sn: Jensen > # Base64 encoded JPEG photo > jpegPhoto:: /9j/4AAQSkZJRgABAAAAAQABAAD/2wBDABALD -> A4MChAODQ4SERATGCgaGBYWGDEjJR0oOjM9PDkzODdASFxOQ -> ERXRTc4UG1RV19iZ2hnPk1xeXBkeFxlZ2P/2wBDARESEhgVG +> A4MChAODQ4SERATGCgaGBYWGDEjJR0oOjM9PDkzODdASFxOQ +> ERXRTc4UG1RV19iZ2hnPk1xeXBkeFxlZ2P/2wBDARESEhgVG > -> # Third Entry +> # Jennifer's Entry > dn: cn=Jennifer J Jensen, dc=example, dc=com > cn: Jennifer J Jensen > cn: Jennifer Jensen diff --git a/doc/guide/admin/install.sdf b/doc/guide/admin/install.sdf index cf427fa103..ebb7bc42c4 100644 --- a/doc/guide/admin/install.sdf +++ b/doc/guide/admin/install.sdf @@ -163,8 +163,8 @@ and their usage. !endif > ./configure --help -The {{EX:configure}} script will also look at certain environment variables -for certain settings. These environment variables are: +The {{EX:configure}} script will also look at various environment variables +for certain settings. These environment variables include: !block table; align=Center; coltags="EX,N"; title="Table 4.1: Environment Variables" Variable Description @@ -175,10 +175,6 @@ LDFLAGS Specify linker flags LIBS Specify additional libraries !endblock -Note: If you intend to build OpenLDAP for multiple platforms from a -single source tree you should consult the {{F:INSTALL}} file in the -top level distribution directory before running {{EX:configure}}. - Now run the configure script with any desired configuration options or environment variables. diff --git a/doc/guide/admin/quickstart.sdf b/doc/guide/admin/quickstart.sdf index ed1a592bf2..fdc2187a63 100644 --- a/doc/guide/admin/quickstart.sdf +++ b/doc/guide/admin/quickstart.sdf @@ -50,15 +50,19 @@ name of the release. .{{S: }} -+{{B: Review the release documents}} ++{{B: Review documentation}} -. You should now review the {{F:COPYRIGHT}}, {{F:LICENSE}}, {{F:README}} -and {{F:INSTALL}} documents provided with the distribution. +. You should now review the {{F:COPYRIGHT}}, {{F:LICENSE}}, +{{F:README}} and {{F:INSTALL}} documents provided with the distribution. The {{F:COPYRIGHT}} and {{F:LICENSE}} provide information on acceptable use, copying, and limitation of warranty of OpenLDAP -software. The {{F:README}} and {{F:INSTALL}} documents provide -detailed information on prerequisite software and installation -procedures. +software. + +.{{S: }} +. You should also review other chapters of this document. +In particular, the {{SECT:Building and Installing OpenLDAP Software}} +chapter of this document provides detailed information on prerequisite +software and installation procedures. .{{S: }} @@ -207,9 +211,8 @@ in the {{slapd}}(8) manual page and the ..{{EX:dc: }} ..{{EX: }} ..{{EX:dn: cn=Manager, dc=, dc=}} -..{{EX:objectclass: person}} +..{{EX:objectclass: organizationalRole}} ..{{EX:cn: Manager}} -..{{EX:sn: Manager}} . Be sure to replace and with the appropriate domain components of your domain name. should be replaced @@ -222,10 +225,9 @@ to trim any leading whitespace from the example: ..{{EX:o: Example Company}} ..{{EX:dc: example}} ..{{EX: }} -..{{EX:dn: cn=Bob Smith, dc=example, dc=com}} -..{{EX:objectclass: person}} -..{{EX:cn: Bob Smith}} -..{{EX:sn: Smith}} +..{{EX:dn: cn=Manager, dc=example, dc=com}} +..{{EX:objectclass: organizationalRole}} +..{{EX:cn: Manager}} . Now, you may run {{ldapadd}}(1) to insert these entries into your directory. diff --git a/doc/guide/release/install.sdf b/doc/guide/release/install.sdf index 91d4755169..3a454cbc5a 100644 --- a/doc/guide/release/install.sdf +++ b/doc/guide/release/install.sdf @@ -5,7 +5,10 @@ P1: Making and Installing the OpenLDAP Distribution This file provides brief instructions on how to build and install -OpenLDAP on UNIX (and UNIX-{{like}}) system. +OpenLDAP on UNIX (and UNIX-{{like}}) system. More detailed +information and instructions can be found in +{{The OpenLDAP Administrator's Guide}} +({{URL:http://www.openldap.org/doc/admin/}}). It is recommended that you read, or at least skim through, ALL of the instructions in this file before attempting to build the @@ -13,7 +16,7 @@ software. It is also recommended you review {{The OpenLDAP Administrator's Guide}} -({{URL:http://www.openldap.org/doc/admin/}}) and +({{URL:http://www.openldap.org/doc/admin/}}), the {{Frequently Asked Questions}} ({{URL:http://www.openldap.org/faq/}}) pages, in particular the {{Installation section}} ({{URL:http://www.openldap.org/faq/index.cgi?file=8}}) @@ -42,11 +45,9 @@ these options is provided in the 'CONFIGURE OPTIONS' section below. .The {{EX:configure}} script uses environmental variables for -determining compiler/linker options. See the 'USING ENVIRONMENT -VARIABLES' section for commonly used settings. - -.These environment variables are used: +determining compiler/linker options including: +> Variable Description Example > CC C compiler gcc > CFLAGS C flags -O -g > CPPFLAGS cpp flags -I/path/include -Ddef @@ -54,9 +55,6 @@ VARIABLES' section for commonly used settings. > 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] @@ -91,15 +89,16 @@ return to step 4 after reviewing your configuration settings. You may want to consult the {{Installation}} section of the {{FAQ}} if you have not done so already. -+ install the binaries and man pages. You may need to be {{superuser}} -to do this (depending on where you are installing things): ++ install the binaries and man pages. You may need to be come 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! -See the {{Administrator's Guide}} and the manual pages for the -individual applications for configuration and use information. +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 @@ -112,123 +111,6 @@ the OpenLDAP configuration directory (normally > slapd.conf Standalone LDAP daemon > schema/*.schema Schema Definitions -There are section 5 man pages for these configuration 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) {{EX:VPATH}} support. -If your {{make}}(1) program is old and doesn't have {{EX:VPATH}} -support, install {{BSD Make}} or {{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 "{{F:..}}" with the appropriate path ) - -+ Continue as above (starting at step 6). - - -P2: CONFIGURE OPTIONS - -Regrettably, this section has not been written (yet). See -"{{EX:./configure --help}}" for current list of options. For general -information about how to use "{{EX:configure}}", please read -{{F: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[label=Warning]: Executables built in your environment may not run -in your users' environments. The portability of executables -between environments is your responsibility. - -Supported Environmental Variables: - -> CC C compiler cc -> CFLAGS C flags -O -g -> 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 {{EX:CC}} environment variable to tell configure to -use a specific compiler. For example, to use {{GNU C -Compiler}} instead of the default compiler, use: - -E: % [env] CC=gcc ./configure - -.You can also use {{EX: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 {{EX:CFLAGS}} to specify compiler flags) - -* Preprocessor Flags - -.You may specify additional preprocessor flags by setting -{{EX:CPPFLAGS}}. For example, if you would like to use headers -installed in {{F:/usr/local/include}}, use: - -E: % [env] CPPFLAGS="-I/usr/local/include" ./configure - -.You can also use {{EX:CPPFLAGS}} to specify preprocessor macros. - -E: % [env] CPPFLAGS="-D__SPECIAL_FLAG__" ./configure - -* Linker Flags - -.You may specify additional linker flags by setting {{EX:LDFLAGS}}. -For example, if you would like to use libraries installed -in {{F:/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 {{F:/usr/css/bin}} for commands, use: - -E: % [env] PATH="/usr/css/bin:$PATH" ./configure - -* Using locally installed software - -.To use software under installed under {{F:/usr/local}}. - -E: [env] \ -E: CPPFLAGS="-I/usr/local/include" \ -E: LDFLAGS="-L/usr/local/lib" \ -E: ./configure - -Note: You may have to add additional flags if your system -supports shared libraries. - End of OpenLDAP INSTALL file. -- 2.39.5