Commit | Line | Data |
---|---|---|
4009494e GM |
1 | \input texinfo.tex |
2 | @c %**start of header | |
db78a8cb | 3 | @setfilename ../../info/eudc |
4009494e GM |
4 | @settitle Emacs Unified Directory Client (EUDC) Manual |
5 | @afourpaper | |
dcd812be PE |
6 | @documentencoding UTF-8 |
7 | @documentlanguage en | |
4009494e GM |
8 | @c %**end of header |
9 | ||
10 | @copying | |
11 | This file documents EUDC v1.30b. | |
12 | ||
13 | EUDC is the Emacs Unified Directory Client, a common interface to | |
14 | directory servers using various protocols such as LDAP or the CCSO white | |
15 | pages directory system (PH/QI) | |
16 | ||
ab422c4d | 17 | Copyright @copyright{} 1998, 2000--2013 Free Software Foundation, Inc. |
4009494e GM |
18 | |
19 | @quotation | |
20 | Permission is granted to copy, distribute and/or modify this document | |
6a2c4aec | 21 | under the terms of the GNU Free Documentation License, Version 1.3 or |
4009494e | 22 | any later version published by the Free Software Foundation; with no |
debf4439 GM |
23 | Invariant Sections, with the Front-Cover texts being ``A GNU Manual'', |
24 | and with the Back-Cover Texts as in (a) below. A copy of the license | |
25 | is included in the section entitled ``GNU Free Documentation License''. | |
4009494e | 26 | |
6f093307 | 27 | (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and |
6bf430d1 | 28 | modify this GNU manual.'' |
4009494e GM |
29 | @end quotation |
30 | @end copying | |
31 | ||
0c973505 | 32 | @dircategory Emacs network features |
4009494e | 33 | @direntry |
62e034c2 | 34 | * EUDC: (eudc). Emacs client for directory servers (LDAP, PH). |
4009494e GM |
35 | @end direntry |
36 | ||
37 | @footnotestyle end | |
38 | ||
39 | @titlepage | |
db671917 AS |
40 | @title EUDC Manual |
41 | @subtitle The Emacs Unified Directory Client | |
4009494e GM |
42 | @author by Oscar Figueiredo |
43 | @code{1.30b} | |
44 | ||
45 | @page | |
46 | @vskip 0pt plus 1fill | |
47 | @insertcopying | |
48 | @end titlepage | |
49 | ||
5dc584b5 KB |
50 | @contents |
51 | ||
4009494e | 52 | @ifnottex |
563a450c | 53 | @node Top |
8a36c07f | 54 | @top Emacs Unified Directory Client |
4009494e | 55 | |
5dc584b5 | 56 | @insertcopying |
4009494e GM |
57 | @end ifnottex |
58 | ||
59 | @menu | |
60 | * Overview:: Summary of EUDC features | |
61 | * Installation:: How to install EUDC | |
62 | * Usage:: The various usage possibilities explained | |
63 | * Credits:: Who's done what | |
64 | * GNU Free Documentation License:: The license for this documentation. | |
65 | * Command and Function Index:: | |
66 | * Variables Index:: | |
67 | @end menu | |
68 | ||
69 | ||
70 | ||
71 | ||
72 | ||
563a450c | 73 | @node Overview |
4009494e GM |
74 | @chapter Overview |
75 | ||
76 | EUDC, the @dfn{Emacs Unified Directory Client}, provides a common user | |
77 | interface to access directory servers using different directory | |
78 | protocols. | |
79 | ||
80 | Currently supported back-ends are: | |
81 | ||
82 | @itemize @bullet | |
83 | @item | |
84 | LDAP, Lightweight Directory Access Protocol | |
85 | @item | |
86 | CCSO PH/QI | |
87 | @item | |
88 | BBDB, Big Brother's Insidious Database | |
89 | @end itemize | |
90 | ||
91 | The main features of the EUDC interface are: | |
92 | ||
93 | @itemize @bullet | |
94 | @item | |
95 | Queries using a customizable form | |
96 | @item | |
97 | Inline query expansion (for instance you can expand a name | |
98 | to an email address in a mail message buffer using a server as an | |
99 | address book) | |
100 | @item | |
101 | Multiple servers can be tried in turn until a match is found for an | |
102 | inline query | |
103 | @item | |
104 | Fast minibuffer queries for email addresses and phone numbers | |
105 | @item | |
106 | Interface to BBDB to let you insert server records into your own BBDB database | |
107 | (@pxref{Top,,BBDB,bbdb,BBDB Manual}) | |
108 | @end itemize | |
109 | ||
110 | @menu | |
111 | * LDAP:: What is LDAP ? | |
112 | * CCSO PH/QI:: What is CCSO, PH, QI ? | |
113 | * BBDB:: What is BBDB ? | |
114 | @end menu | |
115 | ||
116 | ||
117 | ||
563a450c | 118 | @node LDAP |
4009494e GM |
119 | @section LDAP |
120 | ||
121 | LDAP, @dfn{the Lightweight Directory Access Protocol}, is a communication | |
122 | protocol for directory applications defined in RFC 1777. | |
123 | ||
124 | Quoted from RFC 1777: | |
125 | ||
126 | @quotation | |
127 | [LDAP] is designed to provide access to the X.500 Directory while not | |
128 | incurring the resource requirements of the Directory Access Protocol | |
129 | (DAP). This protocol is specifically targeted at simple management | |
130 | applications and browser applications that provide simple read/write | |
131 | interactive access to the X.500 Directory, and is intended to be a | |
132 | complement to the DAP itself. | |
133 | @end quotation | |
134 | ||
135 | LDAP servers usually store (but are not limited to) information about | |
136 | people such as their name, phone number, email address, office | |
137 | location, etc@enddots{} More information about LDAP can be found at | |
e1a8c4c0 | 138 | @url{http://www.openldap.org/}. |
4009494e GM |
139 | |
140 | EUDC requires external support to access LDAP directory servers | |
141 | (@pxref{LDAP Requirements}) | |
142 | ||
143 | ||
563a450c | 144 | @node CCSO PH/QI |
4009494e GM |
145 | @section CCSO PH/QI |
146 | ||
147 | The Central Computing Services Office (CCSO) of the University of | |
e1a8c4c0 GM |
148 | Illinois at Urbana Champaign created and freely distributed a |
149 | directory system that was used by many organizations in the 1990s. | |
150 | The system records information about people such as their address, | |
151 | phone number, email, academic information or any other details it was | |
152 | configured to. Nowadays this system is not widely used. | |
4009494e GM |
153 | |
154 | The system consists of two parts: a database server traditionally called | |
6338a049 GM |
155 | @samp{qi} and a command-line client called @samp{ph}. |
156 | @ignore | |
157 | Until 2010, the code could be downloaded from | |
158 | @url{http://www-dev.cites.uiuc.edu/ph/}. | |
159 | @end ignore | |
160 | ||
161 | The original command-line @samp{ph} client that came with the | |
162 | @samp{ph/qi} distribution provided additional features that are | |
163 | not implemented in EUDC, like the possibility to communicate with the | |
164 | server in login-mode, which made it possible to change records in the | |
165 | database. | |
4009494e GM |
166 | |
167 | ||
563a450c | 168 | @node BBDB |
4009494e GM |
169 | @section BBDB |
170 | ||
171 | BBDB is the @dfn{Big Brother's Insidious Database}, a package for Emacs | |
172 | originally written by Jamie Zawinski which provides rolodex-like | |
173 | database functionality featuring tight integration with the Emacs mail | |
174 | and news readers. | |
175 | ||
176 | It is often used as an enhanced email address book. | |
177 | ||
178 | EUDC considers BBDB as a directory server back end just like LDAP or | |
179 | PH/QI servers, though BBDB has no client/server protocol and thus always | |
180 | resides locally on your machine. The point in this is not to offer an | |
181 | alternate way to query your BBDB database (BBDB itself provides much | |
182 | more flexible ways to do that), but rather to offer an interface to your | |
183 | local directory that is consistent with the interface to external | |
184 | directories (LDAP, PH/QI). This is particularly interesting when | |
185 | performing queries on multiple servers. | |
186 | ||
187 | EUDC also offers a means to insert results from directory queries into | |
188 | your own local BBDB (@pxref{Creating BBDB Records}) | |
189 | ||
563a450c | 190 | @node Installation |
4009494e GM |
191 | @chapter Installation |
192 | ||
193 | Add the following to your @file{.emacs} init file: | |
194 | @lisp | |
195 | (require 'eudc) | |
196 | @end lisp | |
197 | This will install EUDC at startup. | |
198 | ||
199 | After installing EUDC you will find (the next time you launch Emacs) a | |
200 | new @code{Directory Search} submenu in the @samp{Tools} menu that will | |
201 | give you access to EUDC. | |
202 | ||
203 | You may also find it useful to add the following to your @file{.emacs} | |
204 | initialization file to add a shortcut for email address expansion in | |
205 | email composition buffers (@pxref{Inline Query Expansion}) | |
206 | ||
207 | @lisp | |
208 | (eval-after-load | |
209 | "message" | |
210 | '(define-key message-mode-map [(control ?c) (tab)] 'eudc-expand-inline)) | |
211 | (eval-after-load | |
212 | "sendmail" | |
213 | '(define-key mail-mode-map [(control ?c) (tab)] 'eudc-expand-inline)) | |
214 | @end lisp | |
215 | ||
216 | @menu | |
217 | * LDAP Requirements:: EUDC needs external support for LDAP | |
218 | @end menu | |
219 | ||
563a450c | 220 | @node LDAP Requirements |
4009494e GM |
221 | @section LDAP Requirements |
222 | ||
e1a8c4c0 | 223 | LDAP support is added by means of @file{ldap.el}, which is part of Emacs. |
4009494e | 224 | @file{ldap.el} needs an external command line utility named |
e1a8c4c0 GM |
225 | @file{ldapsearch}, available as part of Open LDAP |
226 | (@url{http://www.openldap.org/}). | |
4009494e GM |
227 | |
228 | ||
563a450c | 229 | @node Usage |
4009494e GM |
230 | @chapter Usage |
231 | ||
1df7defd | 232 | This chapter describes the usage of EUDC@. Most functions and |
4009494e GM |
233 | customization options are available through the @samp{Directory Search} |
234 | submenu of the @samp{Tools} submenu. | |
235 | ||
236 | @menu | |
237 | * Querying Servers:: How queries are performed and handled | |
238 | * Query Form:: How to use and customize the query form | |
239 | * Display of Query Results:: Controlling how query results are presented | |
240 | * Inline Query Expansion:: How to use and customize inline queries | |
241 | * The Server Hotlist:: How to use and manage the server hotlist | |
242 | * Multi-server Queries:: How to query multiple servers successively | |
243 | * Creating BBDB Records:: How to insert query results into your BBDB | |
244 | * Server/Protocol Locals:: Customizing on a per server/protocol basis | |
245 | @end menu | |
246 | ||
247 | ||
563a450c | 248 | @node Querying Servers |
4009494e GM |
249 | @section Querying Servers |
250 | ||
251 | EUDC's basic functionality is to let you query a directory server and | |
252 | return the results back to you. There are several things you may want | |
253 | to customize in this process. | |
254 | ||
255 | ||
256 | @menu | |
257 | * Selecting a Server:: The first thing to do | |
258 | * Return Attributes:: Configuring what the server should return | |
259 | * Duplicate Attributes:: What to do when records have duplicate attributes | |
260 | @end menu | |
261 | ||
563a450c | 262 | @node Selecting a Server |
4009494e GM |
263 | @subsection Selecting a Server |
264 | ||
265 | Before doing any query you will need to set the directory server. You | |
266 | need to specify the name of the host machine running the server software | |
267 | and the protocol to use. If you do not set the server in any fashion, | |
268 | EUDC will ask you for one when you make your first query. | |
269 | ||
270 | You can set the server by selecting one from your hotlist of servers | |
271 | (@pxref{The Server Hotlist}) available in the @samp{Server} submenu or | |
272 | by selecting @samp{New Server} in that same menu. | |
273 | ||
274 | LDAP servers generally require some configuration before you can perform | |
275 | queries on them. In particular, the @dfn{search base} must be | |
276 | configured. If the server you select has no configured search base then | |
277 | EUDC will propose you to configure it at this point. A customization | |
278 | buffer will be displayed where you can edit the search base and other | |
279 | parameters for the server. | |
280 | ||
281 | @defvar eudc-server | |
282 | The name or IP address of the remote directory server. A TCP port number | |
283 | may be specified by appending a colon and a number to the name of the | |
284 | server. You will not need this unless your server runs on a port other | |
285 | than the default (which depends on the protocol). | |
286 | If the directory server resides on your own computer (which is the case | |
287 | if you use the BBDB back end) then `localhost' is a reasonable value but | |
288 | it will be ignored anyway. | |
289 | @end defvar | |
290 | ||
291 | @defvar eudc-protocol | |
292 | The directory protocol to use to query the server. Currently supported | |
293 | protocols in this version of EUDC are @code{ph}, @code{ldap} and @code{bbdb}. | |
294 | @end defvar | |
295 | ||
296 | @deffn Command eudc-set-server | |
297 | This command accessible from @samp{New Server} submenu lets you specify a | |
298 | new directory server and protocol. | |
299 | @end deffn | |
300 | ||
563a450c | 301 | @node Return Attributes |
4009494e GM |
302 | @subsection Return Attributes |
303 | ||
304 | Directory servers may be configured to return a default set of | |
305 | attributes for each record matching a query if the query specifies none. | |
306 | The variable @code{eudc-default-return-attributes} controls the return | |
307 | attributes you want to see, if different from the server defaults. | |
308 | ||
309 | @defvar eudc-default-return-attributes | |
310 | A list of the default attributes to extract from directory entries. If | |
311 | set to the symbol @code{all} then all available attributes are | |
312 | returned. A value of @code{nil}, the default, means to return the | |
313 | default attributes as configured in the server. | |
314 | @end defvar | |
315 | ||
316 | The server may return several matching records to a query. Some of the | |
317 | records may however not contain all the attributes you requested. You can | |
318 | discard those records. | |
319 | ||
320 | @defopt eudc-strict-return-matches | |
321 | If non-@code{nil}, entries that do not contain all the requested return | |
322 | attributes are ignored. Default is @code{t}. | |
323 | @end defopt | |
324 | ||
563a450c | 325 | @node Duplicate Attributes |
4009494e GM |
326 | @subsection Duplicate Attributes |
327 | ||
328 | Directory standards may authorize different instances of the same | |
329 | attribute in a record. For instance the record of a person may contain | |
330 | several email fields containing different email addresses. When using | |
331 | a QI directory server this is difficult to distinguish from attributes | |
332 | having multi-line values such as the postal address that may contain a | |
333 | line for the street and another one for the zip code and city name. In | |
334 | both cases, EUDC will consider the attribute duplicated. | |
335 | ||
336 | EUDC has several methods to deal with duplicated attributes. The | |
337 | available methods are: | |
338 | ||
339 | @table @code | |
340 | @item list | |
341 | Makes a list with the different values of the duplicate attribute. The | |
342 | record is returned with only one instance of the attribute with a list | |
343 | of all the different values as a value. This is the default method that | |
344 | is used to handle duplicate fields for which no other method has been | |
345 | specified. | |
346 | @item first | |
347 | Discards all the duplicate values of the field keeping only the first | |
348 | one. | |
349 | @item concat | |
350 | Concatenates the different values using a newline as a separator. The | |
351 | record keeps only one instance of the field the value of which is a | |
352 | single multi-line string. | |
353 | @item duplicate | |
354 | Duplicates the whole record into as many instances as there are different | |
355 | values for the field. This is the default for the email field. Thus a | |
356 | record containing 3 different email addresses is duplicated into three | |
357 | different records each having a single email address. This is | |
358 | particularly useful in combination with @code{select} as the method to | |
359 | handle multiple matches in inline expansion queries (@pxref{Inline Query | |
360 | Expansion}) because you are presented with the 3 addresses in a | |
361 | selection buffer | |
362 | @end table | |
363 | ||
364 | Because a method may not be applicable to all fields, the variable | |
365 | @code{eudc-duplicate-attribute-handling-method} lets you specify either a | |
366 | default method for all fields or a method for each individual field. | |
367 | ||
368 | @defvar eudc-duplicate-attribute-handling-method | |
369 | A method to handle entries containing duplicate attributes. This is | |
370 | either an alist of elements @code{(@var{attr} . @var{method})}, or a symbol | |
371 | @var{method}. The alist form of the variable associates a method to an | |
372 | individual attribute name; the second form specifies a method applicable | |
373 | to all attribute names. Available methods are: @code{list}, | |
374 | @code{first}, @code{concat}, and @code{duplicate} (see above). The default is | |
375 | @code{list}. | |
376 | @end defvar | |
377 | ||
378 | ||
379 | ||
563a450c | 380 | @node Query Form |
4009494e GM |
381 | @section Query Form |
382 | ||
383 | The simplest way to query your directory server is to use the query | |
384 | form. You display the query form with the @samp{Query with Form} menu | |
385 | item or by invoking the command @kbd{M-x eudc-query-form}. The attribute | |
386 | names presented in this form are defined by the | |
387 | @code{eudc-query-form-attributes} variable (unless a non-@code{nil} | |
388 | argument is supplied to @code{eudc-query-form}). | |
389 | ||
390 | Since the different directory protocols to which EUDC interfaces may | |
391 | use different names for equivalent attributes, EUDC defines its own set | |
392 | of attribute names and a mapping between these names and their | |
393 | protocol-specific equivalent through the variable | |
394 | @code{eudc-protocol-attributes-translation-alist}. Names currently | |
395 | defined by EUDC are @code{name}, @code{firstname}, @code{email} and | |
396 | @code{phone}. | |
397 | ||
398 | @defvar eudc-query-form-attributes | |
399 | @findex eudc-get-attribute-list | |
400 | A list of attributes presented in the query form. Attribute names in | |
401 | this list should be either EUDC attribute names or valid attribute | |
402 | names. You can get a list of valid attribute names for the current | |
403 | protocol with the @samp{List Valid Attribute Names} menu item or the | |
404 | @kbd{M-x eudc-get-attribute-list} command. Defaults to @code{name}, | |
405 | @code{email} and @code{phone}. | |
406 | @end defvar | |
407 | ||
408 | @deffn Command eudc-query-form get-fields-from-server | |
409 | Display a form to query the directory server. If given a non-@code{nil} | |
410 | argument the function first queries the server for the existing fields | |
411 | and displays a corresponding form. Not all protocols may support a | |
412 | non-@code{nil} argument here. | |
413 | @end deffn | |
414 | ||
415 | Since the names of the fields may not be explicit enough or adapted to | |
416 | be directly displayed as prompt strings in the form, the variable | |
417 | @code{eudc-user-attribute-names-alist} lets you define more explicit | |
418 | names for directory attribute names. This variable is ignored if | |
419 | @code{eudc-use-raw-directory-names} is non-@code{nil}. | |
420 | ||
421 | @defvar eudc-user-attribute-names-alist | |
422 | This is an alist of user-defined names for the directory attributes used in | |
423 | query/response forms. Prompt strings for attributes that are not in this | |
424 | alist are derived by splitting the attribute name at underscores and | |
425 | capitalizing the individual words. | |
426 | @end defvar | |
427 | ||
428 | @defvar eudc-use-raw-directory-names | |
429 | If non-@code{nil}, use attributes names as defined in the directory. | |
430 | Otherwise, directory query/response forms display the user attribute | |
431 | names defined in @code{eudc-user-attribute-names-alist}. | |
432 | @end defvar | |
433 | ||
563a450c | 434 | @node Display of Query Results |
4009494e GM |
435 | @section Display of Query Results |
436 | ||
437 | Upon successful completion of a form query, EUDC will display a buffer | |
438 | containing the results of the query. | |
439 | ||
440 | The fields that are returned for each record | |
441 | are controlled by @code{eudc-default-return-attributes} (@pxref{Return | |
442 | Attributes}). | |
443 | ||
444 | The display of each individual field can be performed by an arbitrary | |
445 | function which allows specific processing for binary values, such as | |
446 | images or audio samples, as well as values with semantics, such as | |
447 | URLs. | |
448 | ||
449 | @defvar eudc-attribute-display-method-alist | |
450 | An alist specifying methods to display attribute values. Each member of | |
451 | the list is of the form @code{(@var{name} . @var{func})} where | |
452 | @var{name} is a lowercased string naming a directory attribute | |
453 | (translated according to @code{eudc-user-attribute-names-alist} if | |
454 | @code{eudc-use-raw-directory-names} is non-@code{nil}) and @var{func} a | |
455 | function that will be passed the corresponding attribute values for | |
456 | display. | |
457 | @end defvar | |
458 | ||
459 | This variable has protocol-local definitions (see @pxref{Server/Protocol | |
460 | Locals}). For instance, it is defined as follows for LDAP: | |
461 | ||
462 | @lisp | |
463 | (eudc-protocol-set 'eudc-attribute-display-method-alist | |
464 | '(("jpegphoto" . eudc-display-jpeg-inline) | |
465 | ("labeledurl" . eudc-display-url) | |
466 | ("audio" . eudc-display-sound) | |
467 | ("labeledurl" . eudc-display-url) | |
468 | ("url" . eudc-display-url)) | |
469 | 'ldap) | |
470 | @end lisp | |
471 | ||
472 | EUDC provides a set of built-in functions to display binary value types: | |
473 | ||
474 | @defun eudc-display-generic-binary data | |
475 | Display a button for unidentified binary @var{data}. | |
476 | @end defun | |
477 | ||
478 | @defun eudc-display-url url | |
479 | Display URL and make it clickable. | |
480 | @end defun | |
481 | ||
482 | @defun eudc-display-sound data | |
483 | Display a button to play the sound @var{data}. | |
484 | @end defun | |
485 | ||
486 | @defun eudc-display-jpeg-inline data | |
487 | Display the JPEG @var{data} inline at point if possible. | |
488 | @end defun | |
489 | ||
490 | @defun eudc-display-jpeg-as-button data | |
491 | Display a button for the JPEG @var{data}. | |
492 | @end defun | |
493 | ||
494 | Right-clicking on a binary value button pops up a contextual menu with | |
495 | options to process the value. Among these are saving the attribute | |
496 | value to a file or sending it to an external viewer command. External | |
497 | viewers should expect the value on their standard input and should | |
498 | display it or perform arbitrary processing on it. Messages sent to | |
499 | standard output are discarded. External viewers are listed in the | |
500 | variable @code{eudc-external-viewers} which you can customize. | |
501 | ||
502 | @defvar eudc-external-viewers | |
503 | This is a list of viewer program specifications. Each specification is | |
504 | a list whose first element is a string naming the viewer for unique | |
505 | identification, the second element is the executable program which | |
506 | should be invoked and the following elements are arguments that should | |
507 | be passed to the program. | |
508 | @end defvar | |
509 | ||
510 | ||
563a450c | 511 | @node Inline Query Expansion |
4009494e GM |
512 | @section Inline Query Expansion |
513 | ||
514 | Inline query expansion is a powerful method to get completion from your | |
515 | directory server. The most common usage is for expanding names to email | |
516 | addresses in mail message buffers. The expansion is performed by the | |
517 | command @kbd{M-x eudc-expand-inline} which is available from the | |
518 | @samp{Expand Inline Query} menu item but can also be conveniently | |
519 | bound to a key shortcut (@pxref{Installation}). The operation is | |
520 | controlled by the variables @code{eudc-inline-expansion-format}, | |
521 | @code{eudc-inline-query-format}, | |
522 | @code{eudc-expanding-overwrites-query} and | |
523 | @code{eudc-multiple-match-handling-method}. | |
524 | ||
525 | If the query fails for a server, other servers may be tried successively | |
526 | until one of them finds a match (@pxref{Multi-server Queries}). | |
527 | ||
528 | @deffn Command eudc-expand-inline replace-p | |
529 | Query the server and expand the query string before point. The query | |
530 | string consists of the buffer substring from the point back to the | |
531 | preceding comma, colon or beginning of | |
532 | line. @code{eudc-inline-query-format} controls how individual words | |
533 | are mapped onto directory attribute names. After querying the server | |
534 | for the given string, the expansion specified by | |
535 | @code{eudc-inline-expansion-format} is inserted in the buffer at | |
536 | point. If @var{replace-p} is @code{t} then this expansion replaces the | |
537 | query string in the buffer. If @code{eudc-expanding-overwrites-query} | |
538 | is non-@code{nil} then the meaning of @var{replace-p} is negated. | |
539 | @end deffn | |
540 | ||
541 | @defvar eudc-inline-query-format | |
542 | Format of an inline expansion query. | |
543 | This is actually a list of @var{format}s. A @var{format} is a list of | |
544 | one or more EUDC attribute names. A @var{format} applies if it contains | |
545 | as many attributes as individual words in the inline query string. If | |
546 | several @var{format}s apply then they are tried in order until a match | |
547 | is found. If @code{nil} all the words will be mapped onto the default | |
548 | server/protocol attribute name (generally @code{name}). | |
549 | ||
550 | For instance, use the following | |
551 | @lisp | |
552 | (setq eudc-inline-query-format '((name) | |
553 | (firstname) | |
554 | (firstname name))) | |
555 | @end lisp | |
556 | @noindent | |
557 | to indicate that single word expansion queries are to be considered as | |
558 | surnames and if no match is found then they should be tried as first | |
559 | names. Inline queries consisting of two words are considered as | |
560 | consisting of a first name followed by a surname. If the query consists | |
561 | of more than two words, then the first one is considered as the first | |
562 | name and the remaining words are all considered as surname constituents. | |
563 | ||
564 | @var{format}s are in fact not limited to EUDC attribute names, you can | |
565 | use server or protocol specific names in them. It may be safer if you | |
566 | do so, to set the variable @code{eudc-inline-query-format} in a protocol | |
567 | or server local fashion (see @pxref{Server/Protocol Locals}). | |
568 | ||
569 | For instance you could use the following to match up to three words | |
570 | against the @code{cn} attribute of LDAP servers: | |
571 | @lisp | |
572 | (eudc-protocol-set 'eudc-inline-query-format | |
573 | '((cn) | |
574 | (cn cn) | |
575 | (cn cn cn)) | |
576 | 'ldap) | |
577 | @end lisp | |
578 | @end defvar | |
579 | ||
580 | @defvar eudc-inline-expansion-format | |
581 | This variable lets you control exactly what is inserted into the buffer | |
582 | upon an inline expansion request. It is a list whose first element is a | |
583 | string passed to @code{format}. Remaining elements are symbols | |
584 | corresponding to directory attribute names. The corresponding attribute | |
585 | values are passed as additional arguments to @code{format}. Default is | |
586 | @code{("%s" email)} but you may want to consider a value like @code{("%s | |
587 | <%s>" name email)} | |
588 | @end defvar | |
589 | ||
590 | @defvar eudc-multiple-match-handling-method | |
591 | This variable controls what to do when multiple entries match a query | |
592 | for an inline expansion. Possible values are: | |
593 | @table @code | |
594 | @item first | |
595 | The first match is considered as being the only one, the others are | |
596 | discarded. | |
597 | @item select | |
598 | A selection buffer pops up where you can choose a particular match. This | |
599 | is the default value of the variable. | |
600 | @item all | |
601 | The expansion uses all records successively | |
602 | @item abort | |
603 | An error is signaled. The expansion aborts. | |
604 | @end table | |
605 | ||
606 | Default is @code{select} | |
607 | @end defvar | |
608 | ||
609 | ||
610 | ||
563a450c | 611 | @node The Server Hotlist |
4009494e GM |
612 | @section The Server Hotlist |
613 | ||
614 | EUDC lets you maintain a list of frequently used servers so that you | |
615 | can easily switch from one to another. This hotlist appears in the | |
616 | @samp{Server} submenu. You select a server in this list by clicking on | |
617 | its name. You can add the current server to the list with the command | |
618 | @kbd{M-x eudc-bookmark-current-server}. The list is contained in the variable | |
619 | @code{eudc-server-hotlist} which is stored in and retrieved from the file | |
620 | designated by @code{eudc-options-file}. EUDC also provides a facility to | |
621 | edit the hotlist interactively (@pxref{The Hotlist Edit Buffer}). | |
622 | ||
623 | The hotlist is also used to make queries on multiple servers | |
624 | successively (@pxref{Multi-server Queries}). The order in which the | |
625 | servers are tried is the order they appear in the hotlist, therefore it | |
626 | is important to sort the hotlist appropriately. | |
627 | ||
628 | @deffn Command eudc-bookmark-server server | |
629 | Add @var{server} to the hotlist of servers | |
630 | @end deffn | |
631 | ||
632 | @deffn Command eudc-bookmark-current-server | |
633 | Add the current server to the hotlist of servers | |
634 | @end deffn | |
635 | ||
636 | @defvar eudc-options-file | |
637 | The name of a file where EUDC stores its internal variables | |
638 | (the hotlist and the current server). EUDC will try to load | |
639 | that file upon initialization so, if you choose a file name | |
640 | different from the defaults @file{~/.eudc-options}, be sure to set this | |
641 | variable to the appropriate value @emph{before} EUDC is itself | |
642 | loaded. | |
643 | @end defvar | |
644 | ||
645 | @menu | |
646 | * The Hotlist Edit Buffer:: An interactive hotlist editing facility | |
647 | @end menu | |
648 | ||
563a450c | 649 | @node The Hotlist Edit Buffer |
4009494e GM |
650 | @subsection The Hotlist Edit Buffer |
651 | ||
652 | The hotlist edit buffer offers a means to manage a list of frequently | |
653 | used servers. Commands are available in the context pop-up menu | |
654 | generally bound to the right mouse button. Those commands also have | |
655 | equivalent key bindings. | |
656 | ||
657 | @deffn Command eudc-hotlist-add-server | |
658 | Bound to @kbd{a}. | |
659 | Add a new server to the hotlist on the line after point | |
660 | @end deffn | |
661 | ||
662 | @deffn Command eudc-hotlist-delete-server | |
663 | Bound to @kbd{d}. | |
664 | Delete the server on the line point is on | |
665 | @end deffn | |
666 | ||
667 | @deffn Command eudc-hotlist-select-server | |
668 | Bound to @kbd{s}. | |
669 | Select the server the point is on as the current directory server for | |
670 | the next queries | |
671 | @end deffn | |
672 | ||
673 | @deffn Command eudc-hotlist-transpose-servers | |
674 | Bound to @kbd{t}. | |
675 | Bubble up the server the point is on to the top of the list | |
676 | @end deffn | |
677 | ||
678 | @deffn Command eudc-hotlist-quit-edit | |
679 | Bound to @kbd{q}. | |
680 | Save the changes and quit the hotlist edit buffer. Use @kbd{x} or | |
681 | @kbd{M-x kill-buffer} to exit without saving. | |
682 | @end deffn | |
683 | ||
684 | ||
563a450c | 685 | @node Multi-server Queries |
4009494e GM |
686 | @section Multi-server Queries |
687 | ||
688 | When using inline query expansion (@pxref{Inline Query Expansion}), EUDC | |
689 | can try to query successively a sequence of directory servers until one | |
690 | of them successfully finds a match for the query. | |
691 | ||
692 | @defvar eudc-inline-expansion-servers | |
693 | This variable controls which servers are tried and in which order when | |
694 | trying to perform an inline query. Possible values are: | |
695 | @table @code | |
696 | @item current-server | |
697 | Only the current directory server is tried | |
698 | @item hotlist | |
699 | The servers in the hotlist are tried in order until one finds a match | |
700 | for the query or `eudc-max-servers-to-query' is reached | |
701 | @item server-then-hotlist | |
702 | The current server then the servers in the hotlist are tried in the | |
703 | order they appear in the hotlist until one of them finds a match or | |
704 | `eudc-max-servers-to-query' is reached. This is the default. | |
705 | @end table | |
706 | @end defvar | |
707 | ||
708 | @defvar eudc-max-servers-to-query | |
709 | This variable indicates the maximum number of servers to query when | |
710 | performing a multi-server query. The default, @code{nil}, indicates | |
711 | that all available servers should be tried. | |
712 | @end defvar | |
713 | ||
714 | ||
715 | ||
563a450c | 716 | @node Creating BBDB Records |
4009494e GM |
717 | @section Creating BBDB Records |
718 | ||
719 | @findex eudc-insert-record-at-point-into-bbdb | |
720 | @findex eudc-try-bbdb-insert | |
721 | With EUDC, you can automatically create BBDB records | |
722 | (@pxref{Top,,BBDB,bbdb,BBDB Manual}) from records you get from a | |
723 | directory server. You do this by moving point to the appropriate | |
724 | record in a query result display buffer and invoking the command | |
725 | @kbd{M-x eudc-insert-record-at-point-into-bbdb} with the | |
726 | keyboard binding @kbd{b}@footnote{This key binding does not actually | |
727 | call @code{eudc-insert-record-at-point-into-bbdb} but uses | |
728 | @code{eudc-try-bbdb-insert} instead.}, or with the menu. EUDC | |
729 | cannot update an existing BBDB record and will signal an error if you | |
730 | try to insert a record matching an existing one. | |
731 | ||
732 | @findex eudc-batch-export-records-to-bbdb | |
733 | It is also possible to export to BBDB the whole batch of records | |
734 | contained in the directory query result with the command | |
735 | @kbd{M-x eudc-batch-export-records-to-bbdb}. | |
736 | ||
737 | Because directory systems may not enforce a strict record format, local | |
738 | server installations may use different attribute names and have | |
739 | different ways to organize the information. Furthermore BBDB has its own | |
740 | record structure. For these reasons converting a record from its | |
741 | external directory format to the BBDB format is a highly customizable | |
742 | process. | |
743 | ||
744 | @defvar eudc-bbdb-conversion-alist | |
745 | The value of this variable should be a symbol naming an alist defining a | |
746 | mapping between BBDB field names onto directory attribute names records. | |
747 | This is a protocol-local variable and is initialized upon protocol | |
748 | switch (@pxref{Server/Protocol Locals}). The alist is made of cells of the | |
749 | form @code{(@var{bbdb-field} . @var{spec-or-list})}. | |
750 | @var{bbdb-field} is the name of a field | |
751 | that must be defined in your BBDB environment (standard field names are | |
752 | @code{name}, @code{company}, @code{net}, @code{phone}, @code{address} | |
753 | and @code{notes}). | |
754 | @var{spec-or-list} is either a single mapping specification or a list of | |
755 | mapping specifications. Lists of mapping specifications are valid for | |
756 | the @code{phone} and @code{address} BBDB fields only. @var{spec}s are | |
757 | actually s-expressions which are evaluated as follows: | |
758 | ||
759 | @table @asis | |
760 | @item a string | |
761 | evaluates to itself | |
762 | @item a symbol | |
763 | evaluates to the symbol value. Symbols corresponding to directory | |
764 | attribute names present in the record evaluate to the value of the field | |
765 | in the record | |
766 | @item a form | |
767 | is evaluated as a function. The argument list may contain attribute | |
768 | names which evaluate to the corresponding values in the record. The form | |
769 | evaluation should return something appropriate for the particular | |
770 | @var{bbdb-field} (see @code{bbdb-create-internal}). | |
771 | @code{eudc-bbdbify-phone} and @code{eudc-bbdbify-address} are provided as | |
772 | convenience functions to parse phones and addresses. | |
773 | @end table | |
774 | @end defvar | |
775 | ||
776 | The default value of the PH-specific value of that variable is | |
777 | @code{eudc-ph-bbdb-conversion-alist}: | |
778 | ||
779 | @lisp | |
780 | ((name . name) | |
781 | (net . email) | |
782 | (address . (eudc-bbdbify-address address "Address")) | |
783 | (phone . ((eudc-bbdbify-phone phone "Phone") | |
784 | (eudc-bbdbify-phone office_phone "Office Phone")))) | |
785 | @end lisp | |
786 | ||
787 | This means that: | |
788 | ||
789 | @itemize @bullet | |
790 | @item | |
791 | the @code{name} field of the BBDB record gets its value | |
792 | from the @code{name} attribute of the directory record | |
793 | @item | |
794 | the @code{net} field of the BBDB record gets its value | |
795 | from the @code{email} attribute of the directory record | |
796 | @item | |
797 | the @code{address} field of the BBDB record is obtained by parsing the | |
798 | @code{address} attribute of the directory record with the function | |
799 | @code{eudc-bbdbify-address} | |
800 | @item | |
801 | two @code{phone} fields are created (when possible) in the BBDB record. | |
802 | The first one has @cite{Phone} for location and its value is obtained by | |
803 | parsing the @code{phone} attribute of the PH/QI record with the function | |
804 | @code{eudc-bbdbify-phone}. The second one has @cite{Office Phone} for location | |
805 | its value is obtained by parsing the @code{office_phone} attribute of the | |
806 | PH/QI record with the function @code{eudc-bbdbify-phone}. | |
807 | @end itemize | |
808 | ||
809 | @defun eudc-bbdbify-phone phone location | |
810 | This is a convenience function provided for use in | |
811 | @code{eudc-bbdb-conversion-alist}. It parses @var{phone} into a vector | |
812 | compatible with @code{bbdb-create-internal}. @var{phone} is either a string | |
813 | supposedly containing a phone number or a list of such strings which are | |
814 | concatenated. @var{location} is used as the phone location for BBDB. | |
815 | @end defun | |
816 | ||
817 | @defun eudc-bbdbify-address addr location | |
818 | This is a convenience function provided for use in | |
819 | @code{eudc-bbdb-conversion-alist}. It parses @var{addr} into a vector | |
820 | compatible with @code{bbdb-create-internal}. @var{addr} should be an | |
821 | address string of no more than four lines or a list of lines. The last | |
822 | line is searched for the zip code, city and state name. @var{location} | |
823 | is used as the phone location for BBDB. | |
824 | @end defun | |
825 | ||
826 | Note that only a subset of the attributes you selected with | |
827 | @code{eudc-default-return-attributes} and that are actually displayed may | |
828 | actually be inserted as part of the newly created BBDB record. | |
829 | ||
830 | ||
563a450c | 831 | @node Server/Protocol Locals |
4009494e GM |
832 | @section Server/Protocol Locals |
833 | ||
834 | EUDC can be customized independently for each server or directory | |
835 | protocol. All variables can be given local bindings that are activated | |
836 | when a particular server and/or protocol becomes active. This is much | |
837 | like buffer-local bindings but on a per server or per protocol basis. | |
838 | ||
839 | @menu | |
840 | * Manipulating local bindings:: Functions to set and query local bindings | |
841 | @end menu | |
842 | ||
563a450c | 843 | @node Manipulating local bindings |
4009494e GM |
844 | @subsection Manipulating local bindings |
845 | ||
846 | EUDC offers functions that let you set and query variables on a per | |
847 | server or per protocol basis. | |
848 | ||
849 | The following predicates allow you to test the existence of | |
850 | server/protocol local bindings for a particular variable. | |
851 | ||
852 | @defun eudc-server-local-variable-p var | |
853 | Return non-@code{nil} if @var{var} has server-local bindings | |
854 | @end defun | |
855 | ||
856 | @defun eudc-protocol-local-variable-p var | |
857 | Return non-@code{nil} if @var{var} has protocol-local bindings | |
858 | @end defun | |
859 | ||
860 | The following functions allow you to set the value of a variable with | |
861 | various degrees of locality. | |
862 | ||
863 | @defun eudc-default-set var val | |
864 | Set the EUDC default value of @var{var} to @var{val}. | |
865 | The current binding of @var{var} (if local to the current server or | |
866 | protocol) is not changed. | |
867 | @end defun | |
868 | ||
869 | @defun eudc-protocol-set var val &optional protocol | |
870 | Set the binding of @var{var} local to @var{protocol} to @var{val}. If | |
871 | omitted, @var{protocol} defaults to the current value of | |
872 | @code{eudc-protocol}. The current binding of @var{var} is changed only | |
873 | if @var{protocol} is omitted. | |
874 | @end defun | |
875 | ||
876 | @defun eudc-server-set var val &optional server | |
877 | Set the binding of @var{var} local to @var{server} to @var{val}. If | |
878 | omitted, @var{server} defaults to the current value of | |
879 | @code{eudc-server}. The current binding of @var{var} is changed only if | |
880 | @var{server} is omitted. | |
881 | @end defun | |
882 | ||
883 | @defun eudc-set var val | |
884 | Set the most local (server, protocol or default) binding of @var{var} to | |
885 | @var{val}. The current binding of @var{var} is also set to @var{val}. | |
886 | @end defun | |
887 | ||
888 | The following variables allow you to query the various bindings of a | |
889 | variable (local or non-local). | |
890 | ||
891 | @defun eudc-variable-default-value var | |
892 | Return the default binding of @var{var} (outside of a particular server | |
893 | or protocol local binding). | |
894 | Return @code{unbound} if @var{var} has no EUDC default value. | |
895 | @end defun | |
896 | ||
897 | @defun eudc-variable-protocol-value var &optional protocol | |
898 | Return the value of @var{var} local to @var{protocol}. Return | |
899 | @code{unbound} if @var{var} has no value local to @var{protocol}. | |
900 | @var{protocol} defaults to @code{eudc-protocol}. | |
901 | @end defun | |
902 | ||
903 | @defun eudc-variable-server-value var [server] | |
904 | Return the value of @var{var} local to @var{server}. | |
905 | Return @code{unbound} if @var{var} has no value local to @var{server}. | |
906 | @var{server} defaults to @code{eudc-server}. | |
907 | @end defun | |
908 | ||
909 | Changing a protocol-local or server-local value of a variable has no | |
910 | effect on its current value. The following command is used to | |
911 | synchronize the current values of variables with their local values | |
912 | given the current @code{eudc-server} and @code{eudc-protocol}: | |
913 | ||
914 | @defun eudc-update-local-variables | |
915 | Update all EUDC variables according to their local settings. | |
916 | @end defun | |
917 | ||
918 | ||
919 | ||
563a450c | 920 | @node Credits |
4009494e GM |
921 | @chapter Credits |
922 | ||
923 | EUDC was written by Oscar Figueiredo based on @file{ph.el} by the | |
924 | same author. | |
925 | ||
926 | Thanks to Soren Dayton for his suggestions, his enthusiasm and his help | |
927 | in testing and proofreading the code and docs of @file{ph.el}. | |
928 | ||
563a450c | 929 | @node GNU Free Documentation License |
4009494e GM |
930 | @appendix GNU Free Documentation License |
931 | @include doclicense.texi | |
932 | ||
563a450c | 933 | @node Command and Function Index |
4009494e GM |
934 | @unnumbered Command and Function Index |
935 | ||
936 | @printindex fn | |
937 | ||
563a450c | 938 | @node Variables Index |
4009494e GM |
939 | @unnumbered Variables Index |
940 | ||
941 | @printindex vr | |
942 | ||
4009494e | 943 | @bye |