@c %**start of header
@setfilename ../info/eudc
@settitle Emacs Unified Directory Client (EUDC) Manual
-@iftex
@afourpaper
-@end iftex
@c %**end of header
-@footnotestyle end
-
-@ifinfo
-@dircategory Emacs
-@direntry
-* EUDC: (eudc). A client for directory servers (LDAP, PH)
-@end direntry
-
-This file documents EUDC v1.30b
-
-EUDC is part of Emacs.
+@copying
+This file documents EUDC v1.30b.
EUDC is the Emacs Unified Directory Client, a common interface to
directory servers using various protocols such as LDAP or the CCSO white
pages directory system (PH/QI)
-Copyright @copyright{} 1998, 2000 Free Software Foundation, Inc.
-
-Permission is granted to make and distribute verbatim
-copies of this manual provided the copyright notice and
-this permission notice are preserved on all copies.
-
-@ignore
-Permission is granted to process this file through TeX
-and print the results, provided the printed document
-carries a copying permission notice identical to this
-one except for the removal of this paragraph (this
-paragraph not being relevant to the printed manual).
-@end ignore
-
-Permission is granted to copy and distribute modified
-versions of this manual under the conditions for
-verbatim copying and the terms of the ``GNU General
-Public License'', and provided that the entire
-resulting derived work is distributed under the terms
-of a permission notice identical to this one.
-
-Permission is granted to copy and distribute
-translations of this manual into another language,
-under the above conditions for modified versions,
-except that this permission notice may be stated in a
-translation approved by the Free Software Foundation.
-@end ifinfo
+Copyright 1998, 2000, 2001, 2002 Free Software Foundation, Inc.
+
+@quotation
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.1 or
+any later version published by the Free Software Foundation; with no
+Invariant Sections, with the Front-Cover texts being ``A GNU
+Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
+license is included in the section entitled ``GNU Free Documentation
+License'' in the Emacs manual.
+
+(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
+this GNU Manual, like GNU software. Copies published by the Free
+Software Foundation raise funds for GNU development.''
+
+This document is part of a collection distributed under the GNU Free
+Documentation License. If you want to distribute this document
+separately from the collection, you can do so by adding a copy of the
+license to the document, as described in section 6 of the license.
+@end quotation
+@end copying
+
+@dircategory Emacs
+@direntry
+* EUDC: (eudc). An Emacs client for directory servers (LDAP, PH).
+@end direntry
+
+@footnotestyle end
@titlepage
@title{EUDC Manual}
@page
@vskip 0pt plus 1fill
- Copyright @copyright{} 1998, 2000 Free Software Foundation, Inc.
-
- Permission is granted to make and distribute verbatim
- copies of this manual provided the copyright notice and
- this permission notice are preserved on all copies.
-
- @ignore
- Permission is granted to process this file through TeX
- and print the results, provided the printed document
- carries a copying permission notice identical to this
- one except for the removal of this paragraph (this
- paragraph not being relevant to the printed manual).
-
- @end ignore
-
- Permission is granted to copy and distribute modified
- versions of this manual under the conditions for
- verbatim copying and the terms of the ``GNU General
- Public License'', and provided that the entire
- resulting derived work is distributed under the terms
- of a permission notice identical to this one.
-
- Permission is granted to copy and distribute
- translations of this manual into another language,
- under the above conditions for modified versions,
- except that this permission notice may be stated in a
- translation approved by the Free Software Foundation.
+@insertcopying
@end titlepage
-@ifinfo
+@ifnottex
@node Top, Overview, (dir), (dir)
@comment node-name, next, previous, up
A common interface to directory servers using various protocols such as
LDAP or the CCSO white pages directory system (PH/QI)
-@end ifinfo
+@end ifnottex
@menu
* Overview:: Summary of EUDC features
* Installation:: How to install EUDC
* Usage:: The various usage possibilities explained
* Credits:: Who's done what
-* Variables Index::
+* Command and Function Index::
+* Variables Index::
@end menu
@comment node-name, next, previous, up
@chapter Overview
-EUDC, the Emacs Unified Directory Client, provides a common user
+EUDC, the @dfn{Emacs Unified Directory Client}, provides a common user
interface to access directory servers using different directory
-protocols.
+protocols.
Currently supported back-ends are:
The main features of the EUDC interface are:
@itemize @bullet
-@item
+@item
Queries using a customizable form
@item
Inline query expansion (for instance you can expand a name
@comment node-name, next, previous, up
@section LDAP
-LDAP, Lightweight Directory Access Protocol, is a communication
+LDAP, @dfn{the Lightweight Directory Access Protocol}, is a communication
protocol for directory applications defined in RFC 1777.
Quoted from RFC 1777:
@comment node-name, next, previous, up
@section BBDB
-BBDB is the Big Brother's Insiduous Database, a package for Emacs
+BBDB is the @dfn{Big Brother's Insiduous Database}, a package for Emacs
originally written by Jamie Zawinski which provides rolodex-like
database functionality featuring tight integration with the Emacs mail
and news readers.
It is often used as an enhanced email 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
+EUDC considers BBDB as a directory server back end 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
+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 when
performing queries on multiple servers.
email composition buffers (@pxref{Inline Query Expansion})
@lisp
-(eval-after-load
+(eval-after-load
"message"
'(define-key message-mode-map [(control ?c) (tab)] 'eudc-expand-inline))
-(eval-after-load
+(eval-after-load
"sendmail"
'(define-key mail-mode-map [(control ?c) (tab)] 'eudc-expand-inline))
@end lisp
LDAP support is added by means of @file{ldap.el} which is part of Emacs.
@file{ldap.el} needs an external command line utility named
-@file{ldapsearch} which is available as part of LDAP toolkits. above.
+@file{ldapsearch} which is available as part of LDAP toolkits:
@itemize @bullet
@item
submenu of the @samp{Tools} submenu.
@menu
-* Querying Servers:: How queries are performed and handled
+* Querying Servers:: How queries are performed and handled
* Query Form:: How to use and customize the query form
* Display of Query Results:: Controlling how query results are presented
* 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
+* Multi-server Queries:: How to query multiple servers successively
* Creating BBDB Records:: How to insert query results into your BBDB
* Server/Protocol Locals:: Customizing on a per server/protocol basis
@end menu
server. You will not need this unless your server runs on a port other
than the default (which depends on the protocol).
If the directory server resides on your own computer (which is the case
-if you use the BBDB backend) then `localhost' is a reasonable value but
+if you use the BBDB back end) then `localhost' is a reasonable value but
it will be ignored anyway.
@end defvar
@end defvar
@deffn Command eudc-set-server
-This command accessible from @samp{Server} submenu lets you specify a
+This command accessible from @samp{New Server} submenu lets you specify a
new directory server and protocol.
@end deffn
@defvar eudc-duplicate-attribute-handling-method
A method to handle entries containing duplicate attributes. This is
-either an alist @code{(@var{attr} . @var{method})} or a symbol
+either an alist of elements @code{(@var{attr} . @var{method})}, or a symbol
@var{method}. The alist form of the variable associates a method to an
-individual attribute name, the second form specifies a method applicable
+individual attribute name; the second form specifies a method applicable
to all attribute names. Available methods are: @code{list},
-@code{first}, @code{concat}, @code{duplicate} (see above). Defaults to
+@code{first}, @code{concat}, and @code{duplicate} (see above). The default is
@code{list}.
@end defvar
@code{phone}.
@defvar eudc-query-form-attributes
+@findex eudc-get-attribute-list
A list of attributes presented in the query form. Attribute names in
this list should be either EUDC attribute names or valid attribute
names. You can get a list of valid attribute names for the current
protocol with the @samp{List Valid Attribute Names} menu item or the
-@kbd{M-x eudc-get-attribute-list} command. Defaults to @code{name},
+@kbd{M-x eudc-get-attribute-list} command. Defaults to @code{name},
@code{email} and @code{phone}.
@end defvar
The fields that are returned for each record
are controlled by @code{eudc-default-return-attributes} (@pxref{Return
-Attributes}).
+Attributes}).
The display of each individual field can be performed by an arbitrary
-function which allows specific processing for binary values like images
-or audio samples as well as values with computer semantics like URLs.
+function which allows specific processing for binary values, such as
+images or audio samples, as well as values with semantics, such as
+URLs.
@defvar eudc-attribute-display-method-alist
An alist specifying methods to display attribute values. Each member of
Locals}). For instance, it is defined as follows for LDAP:
@lisp
-(eudc-protocol-set 'eudc-attribute-display-method-alist
+(eudc-protocol-set 'eudc-attribute-display-method-alist
'(("jpegphoto" . eudc-display-jpeg-inline)
("labeledurl" . eudc-display-url)
("audio" . eudc-display-sound)
("labeledurl" . eudc-display-url)
- ("url" . eudc-display-url))
+ ("url" . eudc-display-url))
'ldap)
@end lisp
@section Inline Query Expansion
Inline query expansion is a powerful method to get completion from your
-directory server. The most common usage is for expanding names to email
-addresses in mail message buffers. The expansion is performed by the
+directory server. The most common usage is for expanding names to email
+addresses in mail message buffers. The expansion is performed by the
command @kbd{M-x eudc-expand-inline} which is available from the
-@samp{Directory Search} menu but can also be conveniently bound to a key
-shortcut (@pxref{Installation}) The operation is controlled by the
-variables @code{eudc-inline-expansion-format},
+@samp{Expand Inline Query} menu item but can also be conveniently
+bound to a key shortcut (@pxref{Installation}). The operation is
+controlled by the variables @code{eudc-inline-expansion-format},
@code{eudc-inline-query-format},
@code{eudc-expanding-overwrites-query} and
@code{eudc-multiple-match-handling-method}.
-If the query fails for a server, other servers may be tried successively
+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
string consists of the buffer substring from the point back to the
preceding comma, colon or beginning of
-line. @code{eudc-inline-query-format} controls how individual words
+line. @code{eudc-inline-query-format} controls how individual words
are mapped onto directory attribute names. After querying the server
for the given string, the expansion specified by
@code{eudc-inline-expansion-format} is inserted in the buffer at
@end deffn
@defvar eudc-inline-query-format
-Format of an inline expansion query.
+Format of an inline expansion query.
This is actually a list of @var{format}s. A @var{format} is a list of
one or more EUDC attribute names. A @var{format} applies if it contains
as many attributes as individual words in the inline query string. If
is found. If @code{nil} all the words will be mapped onto the default
server/protocol attribute name (generally @code{name}).
-For instance, use the following
+For instance, use the following
@lisp
(setq eudc-inline-query-format '((name)
(firstname)
(firstname name)))
@end lisp
+@noindent
to indicate that single word expansion queries are to be considered as
surnames and if no match is found then they should be tried as first
names. Inline queries consisting of two words are considered as
-consisting of a first name followed by a surname. If the query consists
+consisting of a first name followed by a surname. If the query consists
of more than two words, then the first one is considered as the first
name and the remaining words are all considered as surname constituents.
@defvar eudc-inline-expansion-format
This variable lets you control exactly what is inserted into the buffer
-upon an inline expansion request. It is a list whose first element is a
-string passed to @code{format}. Remaining elements are symbols
+upon an inline expansion request. It is a list whose first element is a
+string passed to @code{format}. Remaining elements are symbols
corresponding to directory attribute names. The corresponding attribute
-values are passed as additional arguments to @code{format}. Default is
+values are passed as additional arguments to @code{format}. Default is
@code{("%s" email)} but you may want to consider a value like @code{("%s
<%s>" name email)}
@end defvar
The first match is considered as being the only one, the others are
discarded.
@item select
-A selection buffer pops up where you can choose a particular match. This
+A selection buffer pops up where you can choose a particular match. This
is the default value of the variable.
@item all
The expansion uses all records successively
@item abort
-An error is signaled. The expansion aborts.
+An error is signaled. The expansion aborts.
@end table
-
-Defaults to @code{select}
+Default is @code{select}
@end defvar
@comment node-name, next, previous, up
@section The Server Hotlist
-EUDC lets you maintain a list of frequently used servers so that you
-can easily switch from one to another. This hotlist appears in the
-@samp{Server} submenu. You select a server in this list by clicking on
-its name. You can add the current server to the list with the command
-@kbd{M-x eudc-bookmark-current-server}. The list is contained in the variable
+EUDC lets you maintain a list of frequently used servers so that you
+can easily switch from one to another. This hotlist appears in the
+@samp{Server} submenu. You select a server in this list by clicking on
+its name. You can add the current server to the list with the command
+@kbd{M-x 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}).
The hotlist is also used to make queries on multiple servers
-successively (@pxref{Multi-server Queries}). The order in which the
+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.
@defvar eudc-options-file
The name of a file where EUDC stores its internal variables
-(the hotlist and the current server). EUDC will try to load
+(the hotlist and the current server). EUDC will try to load
that file upon initialization so, if you choose a file name
different from the defaults @file{~/.eudc-options}, be sure to set this
variable to the appropriate value @emph{before} EUDC is itself
The hotlist edit buffer offers a means to manage a list of frequently
used servers. Commands are available in the context pop-up menu
generally bound to the right mouse button. Those commands also have
-equivalent keybindings.
+equivalent key bindings.
@deffn Command eudc-hotlist-add-server
Bound to @kbd{a}.
@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:
+trying to perform an inline query. Possible values are:
@table @code
@item current-server
Only the current directory server is tried
@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
+performing a multi-server query. The default, @code{nil}, indicates
that all available servers should be tried.
@end defvar
@comment node-name, next, previous, up
@section Creating BBDB Records
+@findex eudc-insert-record-at-point-into-bbdb
+@findex eudc-try-bbdb-insert
With EUDC, you can automatically create BBDB records
(@pxref{Top,,BBDB,bbdb,BBDB Manual}) from records you get from a
-directory server. You do this by moving point to the appropriate
+directory server. You do this by moving point to the appropriate
record in a query result display buffer and invoking the command
@kbd{M-x eudc-insert-record-at-point-into-bbdb} with the
-keyboard binding @kbd{b} @footnote{This keybinding does not actually
+keyboard binding @kbd{b}@footnote{This key binding does not actually
call @code{eudc-insert-record-at-point-into-bbdb} but uses
-@code{eudc-try-bbdb-insert} instead.}, or with the menu. EUDC
+@code{eudc-try-bbdb-insert} instead.}, or with the menu. EUDC
cannot update an existing BBDB record and will signal an error if you
try to insert a record matching an existing one.
+@findex eudc-batch-export-records-to-bbdb
It is also possible to export to BBDB the whole batch of records
contained in the directory query result with the command
@kbd{M-x eudc-batch-export-records-to-bbdb}.
Because directory systems may not enforce a strict record format, local
server installations may use different attribute names and have
-different ways to organize the information. Furthermore BBDB has its own
-record structure. For these reasons converting a record from its
+different ways to organize the information. Furthermore BBDB has its own
+record structure. For these reasons converting a record from its
external directory format to the BBDB format is a highly customizable
process.
The value of this variable should be a symbol naming an alist defining a
mapping between BBDB field names onto directory attribute names records.
This is a protocol-local variable and is initialized upon protocol
-switch (@pxref{Server/Protocol Locals}) The alist is made of cells of the
-form @code{(@var{bbdb-field} . @var{spec-or-list})}.
+switch (@pxref{Server/Protocol Locals}). The alist is made of cells of the
+form @code{(@var{bbdb-field} . @var{spec-or-list})}.
@var{bbdb-field} is the name of a field
that must be defined in your BBDB environment (standard field names are
@code{name}, @code{company}, @code{net}, @code{phone}, @code{address}
-and @code{notes}).
+and @code{notes}).
@var{spec-or-list} is either a single mapping specification or a list of
-mapping specifications. Lists of mapping specifications are valid for
+mapping specifications. Lists of mapping specifications are valid for
the @code{phone} and @code{address} BBDB fields only. @var{spec}s are
actually s-expressions which are evaluated as follows:
@table @asis
-@item a string
+@item a string
evaluates to itself
@item a symbol
-evaluates to the symbol value. Symbols corresponding to directory
+evaluates to the symbol value. Symbols corresponding to directory
attribute names present in the record evaluate to the value of the field
in the record
@item a form
-is evaluated as a function. The argument list may contain attribute
-names which evaluate to the corresponding values in the record. The form
+is evaluated as a function. The argument list may contain attribute
+names which evaluate to the corresponding values in the record. The form
evaluation should return something appropriate for the particular
@var{bbdb-field} (see @code{bbdb-create-internal}).
@code{eudc-bbdbify-phone} and @code{eudc-bbdbify-address} are provided as
This means that:
@itemize @bullet
-@item
+@item
the @code{name} field of the BBDB record gets its value
from the @code{name} attribute of the directory record
@item
two @code{phone} fields are created (when possible) in the BBDB record.
The first one has @cite{Phone} for location and its value is obtained by
parsing the @code{phone} attribute of the PH/QI record with the function
-@code{eudc-bbdbify-phone}. The second one has @cite{Office Phone} for location
+@code{eudc-bbdbify-phone}. The second one has @cite{Office Phone} for location
its value is obtained by parsing the @code{office_phone} attribute of the
PH/QI record with the function @code{eudc-bbdbify-phone}.
@end itemize
@defun eudc-bbdbify-phone phone location
This is a convenience function provided for use in
-@code{eudc-bbdb-conversion-alist}. It parses @var{phone} into a vector
-compatible with @code{bbdb-create-internal}. @var{phone} is either a string
+@code{eudc-bbdb-conversion-alist}. It parses @var{phone} into a vector
+compatible with @code{bbdb-create-internal}. @var{phone} is either a string
supposedly containing a phone number or a list of such strings which are
concatenated. @var{location} is used as the phone location for BBDB.
@end defun
@defun eudc-bbdbify-address addr location
This is a convenience function provided for use in
-@code{eudc-bbdb-conversion-alist}. It parses @var{addr} into a vector
-compatible with @code{bbdb-create-internal}. @var{addr} should be an
-address string of no more than four lines or a list of lines. The last
-line is searched for the zip code, city and state name. @var{location}
+@code{eudc-bbdb-conversion-alist}. It parses @var{addr} into a vector
+compatible with @code{bbdb-create-internal}. @var{addr} should be an
+address string of no more than four lines or a list of lines. The last
+line is searched for the zip code, city and state name. @var{location}
is used as the phone location for BBDB.
@end defun
EUDC can be customized independently for each server or directory
protocol. All variables can be given local bindings that are activated
-when a particular server and/or protocol becomes active. This is much
+when a particular server and/or protocol becomes active. This is much
like buffer-local bindings but on a per server or per protocol basis.
@menu
@end defun
The following functions allow you to set the value of a variable with
-various degrees of localness.
+various degrees of locality.
@defun eudc-default-set var val
Set the EUDC default value of @var{var} to @var{val}.
@end defun
@defun eudc-variable-server-value var [server]
-Return the value of @var{var} local to @var{server}.
+Return the value of @var{var} local to @var{server}.
Return @code{unbound} if @var{var} has no value local to @var{server}.
@var{server} defaults to @code{eudc-server}.
@end defun
-
Changing a protocol-local or server-local value of a variable has no
effect on its current value. The following command is used to
synchronize the current values of variables with their local values
-@node Credits, Variables Index, Usage, Top
+@node Credits, Command and Function Index, Usage, Top
@comment node-name, next, previous, up
@chapter Credits
-EUDC was written by Oscar Figueiredo based on @file{ph.el} by the
+EUDC was written by Oscar Figueiredo based on @file{ph.el} by the
same author.
Thanks to Soren Dayton for his suggestions, his enthusiasm and his help
in testing and proofreading the code and docs of @file{ph.el}.
-@node Variables Index, , Credits, Top
+@node Command and Function Index, Variables Index, Credits, Top
+@comment node-name, next, previous, up
+@unnumbered Command and Function Index
+
+@printindex fn
+
+@node Variables Index, , Command and Function Index, Top
@comment node-name, next, previous, up
@unnumbered Variables Index
HCoop / bpt / emacs.git / blobdiff