File: INSTALL

package info (click to toggle)
eudc 1.28b-5
  • links: PTS
  • area: main
  • in suites: potato
  • size: 336 kB
  • ctags: 160
  • sloc: lisp: 2,239; sh: 56; makefile: 50
file content (95 lines) | stat: -rw-r--r-- 3,155 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

Emacs Unified Directory Client (EUDC)
==============================


Installation Instructions
-------------------------

IMPORTANT: This archive is intended for GNU Emacs and versions of XEmacs prior
to 21.0.  Users of XEmacs 21.0 are advised to use the XEmacs EUDC package
instead.

* Required packages
  -----------------

EUDC requires the Custom package.  This package is part of all recent releases
of Emacs and XEmacs. If you are running GNU Emacs 19.34 or XEmacs 19.14 then
you will need to install Custom before
(http://www.dina.kvl.dk/~abraham/custom/)

If you want to use the BBDB backend you will also need to install it since it
is not part of the standard distribution of Emacs or XEmacs
(http://pw2.netcom.com/~simmonmt/bbdb/).

If you want to use the LDAP backend read the paragraph `LDAP Support' below.


* Byte-compilation of lisp files
  ------------------------------

On Windows NT, you need the Cygwin tools (http://www.cygnus.com). Rename 
GNUmakefile.cygwin as GNUmakefile.

If you installed Custom or BBDB outside Emacs' default load path then edit the
GNUmakefile.

Type `make -k' at a shell prompt to bytecompile the elisp files.  You can safely
ignore most of the compilation warnings.


* Moving the files
  ----------------

Copy the *.el and *.elc files to somewhere Emacs can find them.  Optionally
edit your init file to add a new directory to your load-path.

Copy the eudc.info to a directory in your info path.  If you are running GNU
Emacs or XEmacs 20 or lower, also edit the dir file to add an entry for EUDC.


* Edit your init file
  -------------------

Add the following to your .emacs init file:

  (require 'eudc-autoloads)


* LDAP Support
  ------------

XEmacs 21.0 and above can be compiled with internal LDAP support, but if you
are running XEmacs 21.0, you are using the XEmacs EUDC package and not this
one, right ?

For other versions of Emacs, this archive comes with ldap.el which is not
strictly part of EUDC but emulates the API that can be natively built into
XEmacs 21.0.  It provides LDAP support through an external command line program
called `ldapsearch' which is available in most LDAP toolkit distributions:
  - LDAP 3.3 from the University of Michigan 
    (get it from <URL:http://www.umich.edu/~dirsvcs/ldap/>)
  - OpenLDAP 1.0.3 from the OpenLDAP Foundation
    (get it from <URL:http://www.openldap.org/>)
  - LDAP SDK 1.0 from Netscape Corp.
    (get it from <URL:http://developer.netscape.com/>)

You need to install one of these toolkits and make the `ldapsearch' visible in
your PATH or set the variable `ldap-ldapsearch-program' appropriately in your
init file.

***IMPORTANT***: When declaring a new LDAP server do not forget to declare an
appropriate search base in `ldap-host-parameters-alist' or
`ldap-default-search-base' otherwise your queries will probably fail.


* Read the documentation
  ----------------------

EUDC deals with several directory services, it is therefore complex though I
went great lengths trying to make it easy to use.  I also took the time to
write an extensive manual, please read it before asking questions.


Oscar Figueiredo
December, 1998