Skip to content
Snippets Groups Projects
Commit 5355f6f1d6ab authored by oscarf's avatar oscarf
Browse files

Updated to release 1.25

parent 4708bf65f667
No related branches found
No related tags found
No related merge requests found
......@@ -14,7 +14,7 @@
* EUDC:: A client for directory servers (LDAP, PH)
@end direntry
This file documents EUDC v1.10
This file documents EUDC v1.25
EUDC is part of XEmacs.
......@@ -92,7 +92,7 @@
@comment node-name, next, previous, up
This manual documents EUDC v1.10, the Emacs Unified Directory Client.
This manual documents EUDC v1.25, the Emacs Unified Directory Client.
A common interface interface to directory servers using various
protocols such as LDAP or the CCSO white pages directory system (PH/QI)
......@@ -100,8 +100,8 @@
@end ifinfo
@menu
* Overview:: Summary of eudc features
* Installation:: How to install eudc
* Overview:: Summary of EUDC features
* Installation:: How to install EUDC
* Usage:: The various usage possibilities explained
* Credits:: Who's done what
* Variables Index::
......@@ -119,10 +119,10 @@
interface to access directory servers using different directory
protocols.
Currently supported protocols are:
Currently supported back-ends are:
@itemize @bullet
@item
LDAP, Lightweight Directory Access Protocol
@item
CCSO PH/QI
......@@ -123,9 +123,11 @@
@itemize @bullet
@item
LDAP, Lightweight Directory Access Protocol
@item
CCSO PH/QI
@item
BBDB, Big Brother's Insiduous Database
@end itemize
The main features of the EUDC interface are:
......@@ -138,6 +140,9 @@
to an e-mail address in a mail message buffer using a server as an
address book)
@item
Multiple servers can be tried in turn until a match is found for an
inline query
@item
Fast minibuffer queries for e-mail addresses and phone numbers
@item
Interface to BBDB to let you insert server records into your own BBDB database
......@@ -147,6 +152,7 @@
@menu
* LDAP:: What is LDAP ?
* CCSO PH/QI:: What is CCSO, PH, QI ?
* BBDB:: What is BBDB ?
@end menu
......@@ -176,7 +182,7 @@
(@pxref{LDAP Requirements})
@node CCSO PH/QI, , LDAP, Overview
@node CCSO PH/QI, BBDB, LDAP, Overview
@comment node-name, next, previous, up
@section CCSO PH/QI
......@@ -201,4 +207,7 @@
EUDC.
@node BBDB, , CCSO PH/QI, Overview
@comment node-name, next, previous, up
@section BBDB
......@@ -204,2 +213,6 @@
BBDB is the Big Brother's Insiduous Database, a package for Emacs
originally written by Jamie Zawinski and which provides rolodex-like
database functionality with tight integration with the Emacs mail and
news readers.
......@@ -205,4 +218,17 @@
It is often used as an enhanced e-mail address book.
EUDC considers BBDB as a directory server backend just like LDAP or
PH/QI servers though BBDB has no client/server protocol and thus always
resides locally on your machine. The point in this is not to offer an
alternate way to query your BBDB database (BBDB itself provides much
more flexible ways to do that) but rather to offer an interface to your
local directory that is consistent with the interface to external
directories (LDAP, PH/QI). This is particularly interesting to perform
queries on multiple servers.
EUDC also offers a means to insert results from directory queries into
your own local BBDB (@pxref{Creating BBDB Records})
@node Installation, Usage, Overview, Top
@comment node-name, next, previous, up
......@@ -272,6 +298,7 @@
* Query Form:: How to use and customize the query form
* Inline Query Expansion:: How to use and customize inline queries
* The Server Hotlist:: How to use and manage the server hotlist
* Multi-server Queries:: How to query multiple servers sucessively
* Creating BBDB Records:: How to insert query results into your BBDB
* Protocol Locals:: Protocol specific customizations
@end menu
......@@ -471,7 +498,10 @@
variables @code{eudc-inline-expansion-format},
@code{eudc-inline-query-format-list},
@code{eudc-expanding-overwrites-query} and
@code{eudc-multiple-match-handling-method}
@code{eudc-multiple-match-handling-method}.
If the query fails for a server, other servers may be tried successively
until one of them finds a match (@pxref{Multi-server Queries}).
@deffn Command eudc-expand-inline replace-p
Query the server and expand the query string before point. The query
......@@ -525,7 +555,7 @@
@node The Server Hotlist, Creating BBDB Records, Inline Query Expansion, Usage
@node The Server Hotlist, Multi-server Queries, Inline Query Expansion, Usage
@comment node-name, next, previous, up
@section The Server Hotlist
......@@ -536,7 +566,12 @@
@code{eudc-bookmark-current-server}. The list is contained in the variable
@code{eudc-server-hotlist} which is stored in and retrieved from the file
designated by @code{eudc-options-file}. EUDC also provides a facility to
edit the hotlist interactively (@pxref{The Hotlist Edit Buffer})
edit the hotlist interactively (@pxref{The Hotlist Edit Buffer}).
The hotlist is also used to make queries on multiple servers
successively (@pxref{Multi-server Queries}). The order in which the
servers are tried is the order they appear in the hotlist, therefore it
is important to sort the hotlist appropriately.
@deffn Command eudc-bookmark-server server
Add @var{server} to the hotlist of servers
......@@ -556,6 +591,6 @@
@end defvar
@menu
* The Hotlist Edit Buffer:: An interactive hotlist editing facility
* The Hotlist Edit Buffer:: An interactive hotlist editing facility
@end menu
......@@ -560,6 +595,6 @@
@end menu
@node The Hotlist Edit Buffer
@node The Hotlist Edit Buffer, , The Server Hotlist, The Server Hotlist
@comment node-name, next, previous, up
@subsection The Hotlist Edit Buffer
......@@ -596,4 +631,7 @@
@end deffn
@node Multi-server Queries, Creating BBDB Records, The Server Hotlist, Usage
@comment node-name, next, previous, up
@section Multi-server Queries
......@@ -599,5 +637,33 @@
@node Creating BBDB Records, Protocol Locals, The Server Hotlist, Usage
When using inline query expansion (@pxref{Inline Query Expansion}), EUDC
can try to query successively a sequence of directory servers until one
of them successfully finds a match for the query.
@defvar eudc-inline-expansion-servers
This variable controls which servers are tried and in which order when
trying to perform an inline query. Possible values are:
@table @code
@item current-server
Only the current directory server is tried
@item hotlist
The servers in the hotlist are tried in order until one finds a match
for the query or `eudc-max-servers-to-query' is reached
@item server-then-hotlist
The current server then the servers in the hotlist are tried in the
order they appear in the hotlist until one of them finds a match or
`eudc-max-servers-to-query' is reached. This is the default.
@end table
@end defvar
@defvar eudc-max-servers-to-query
This variable indicates the maximum number of servers to query when
performing a multi-server query. The default, @code{nil}, indicates
that all available servers should be tried.
@end defvar
@node Creating BBDB Records, Protocol Locals, Multi-server Queries, Usage
@comment node-name, next, previous, up
@section Creating BBDB Records
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment