1. INTRODUCTION
================

This is a set of scripts and tools we use to maintain our internal LDAP
data and servers. Some of these scripts uses LDAP to talk to the
Directory Server directly, some generate LDIF files, and some are just
nice to have utilities... :)

These tools are provided as is, use them at your own risk. We are still
changing the scripts, fixing bugs and adding more features. All scripts
are completely unsupported, if you send me questions I can't promise to
answer, but I'll of course do my best. If you find bugs, or have ideas for
improvements, I appreciate any feedback.



2. REQUIREMENTS
===============

In order to use most of these tools and scripts, you must have

	Perl v5.003	I've tested these scripts and tools using Perl
	-----------	v5.003 and v5.004, on Solaris and Irix. We do
			recommend using v5.004_3 or later.


	LDAP SDK v3.0	The C library, and include file, to write LDAP
	-------------	clients in the C language. This is needed in
			order to build the Perl extension module, which
			extends Perl with the LDAP functionality. You
			can download this from the Netscape Developers
			Web site (http://developer.netscape.com).

			NOTE: The v1.0 release for Irix doesn't work
			properly, so if you're on Irix, contact your
			Netscape support representative.

	DS-3.0		The Netscape Directory Server v3.0 or later, if
	------		you want to build and use the plugins.


	Ldapc-1.x	The LDAP extension to Perl-5. You need to compile
	---------	and install this package, which requires a C
			compiler, and of course a perl5 installation.


	LdapUtil.pm	This is the "main" configuration file for all the
	-----------	scripts and tools. Modify this file to fit your
			environment, and install it in your perl5 site Perl
			directory (e.g. /usr/lib/perl5/site_perl).

			This module also implements a set of important
			classes used by many of the scripts. This file is
			in the .../lib directory.


	NSS.pm		This is a package with some classes to get data
	------		from the NIS server. This is used by the NIS to
			LDAP synchronization scripts.


	LDAP server	We have only tested these scripts and tools against
	-----------	the Netscape Directory Server, v1.03 and 3.0Beta2.
			If you plan to use the Gateway, you must have the
			CGIs from 3.0Beta2 or later, but you can still use
			DS-v1.03 for the LDAP lookups.



3. CONTENTS
===========

These are the main components, each package has a separate directory.
Please consult each individual README file for more information.

	ldapp		The Perl5 extension, to implement the LDAP SDK API
	-----		calls. This is needed by all Perl scripts.


	perl		All the scripts we have written in Perl.
	----


	lib		Perl5 and Java classes, used by the Perl and Java
	---		scripts.


	c		A set of C programs and libraries, implementing
	-		some performance critical tools. This is still
			very much work in progress...


	java		Java scripts and tools. There is nothing here yet.
	----



4. OTHER
========

If you have any questions or problems, feel free to contact me at

	leif@netscape.com


-- Leif

-----------------------------------------------------
$Id: README,v 1.11 1998/03/09 03:57:59 leif Exp $
