diff options
| author | Thomas Fitzsimmons | 2015-12-06 19:33:24 -0500 |
|---|---|---|
| committer | Thomas Fitzsimmons | 2015-12-06 19:37:40 -0500 |
| commit | 0a45afa30fae6543fd21f3102ae259f02c1b9042 (patch) | |
| tree | 48df2a3e63579834b35f508561eff9ceb650b7df /doc | |
| parent | b44caf951a93ab4b911391bccecb36d0bbab8d71 (diff) | |
| download | emacs-0a45afa30fae6543fd21f3102ae259f02c1b9042.tar.gz emacs-0a45afa30fae6543fd21f3102ae259f02c1b9042.zip | |
Make eudcb-ph.el obsolete
* doc/misc/eudc.texi: Bump version to 1.40.0.
Remove PH/QI sections and mentions.
* lisp/obsolete/eudcb-ph.el: Make obsolete.
* lisp/net/eudc-vars.el (eudc-known-protocols): Remove ph.
(eudc-ph-bbdb-conversion-alist): Make obsolete.
* etc/NEWS: Mention this. (Bug#21191)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/misc/eudc.texi | 92 |
1 files changed, 14 insertions, 78 deletions
diff --git a/doc/misc/eudc.texi b/doc/misc/eudc.texi index 33c9a0eb3a9..8d59e97b44e 100644 --- a/doc/misc/eudc.texi +++ b/doc/misc/eudc.texi | |||
| @@ -9,11 +9,10 @@ | |||
| 9 | @c %**end of header | 9 | @c %**end of header |
| 10 | 10 | ||
| 11 | @copying | 11 | @copying |
| 12 | This file documents EUDC v1.30b. | 12 | This file documents EUDC version 1.40.0. |
| 13 | 13 | ||
| 14 | EUDC is the Emacs Unified Directory Client, a common interface to | 14 | EUDC is the Emacs Unified Directory Client, a common interface to |
| 15 | directory servers using various protocols such as LDAP or the CCSO white | 15 | directory servers and contact information. |
| 16 | pages directory system (PH/QI) | ||
| 17 | 16 | ||
| 18 | Copyright @copyright{} 1998, 2000--2015 Free Software Foundation, Inc. | 17 | Copyright @copyright{} 1998, 2000--2015 Free Software Foundation, Inc. |
| 19 | 18 | ||
| @@ -32,7 +31,7 @@ modify this GNU manual.'' | |||
| 32 | 31 | ||
| 33 | @dircategory Emacs network features | 32 | @dircategory Emacs network features |
| 34 | @direntry | 33 | @direntry |
| 35 | * EUDC: (eudc). Emacs client for directory servers (LDAP, PH). | 34 | * EUDC: (eudc). Emacs client for directory servers (LDAP, BBDB). |
| 36 | @end direntry | 35 | @end direntry |
| 37 | 36 | ||
| 38 | @footnotestyle end | 37 | @footnotestyle end |
| @@ -41,7 +40,7 @@ modify this GNU manual.'' | |||
| 41 | @title EUDC Manual | 40 | @title EUDC Manual |
| 42 | @subtitle The Emacs Unified Directory Client | 41 | @subtitle The Emacs Unified Directory Client |
| 43 | @author by Oscar Figueiredo | 42 | @author by Oscar Figueiredo |
| 44 | @code{1.30b} | 43 | @code{1.40.0} |
| 45 | 44 | ||
| 46 | @page | 45 | @page |
| 47 | @vskip 0pt plus 1fill | 46 | @vskip 0pt plus 1fill |
| @@ -83,8 +82,6 @@ Currently supported back-ends are: | |||
| 83 | @item | 82 | @item |
| 84 | LDAP, Lightweight Directory Access Protocol | 83 | LDAP, Lightweight Directory Access Protocol |
| 85 | @item | 84 | @item |
| 86 | CCSO PH/QI | ||
| 87 | @item | ||
| 88 | BBDB, Big Brother's Insidious Database | 85 | BBDB, Big Brother's Insidious Database |
| 89 | @end itemize | 86 | @end itemize |
| 90 | 87 | ||
| @@ -109,7 +106,6 @@ Interface to BBDB to let you insert server records into your own BBDB database | |||
| 109 | 106 | ||
| 110 | @menu | 107 | @menu |
| 111 | * LDAP:: What is LDAP ? | 108 | * LDAP:: What is LDAP ? |
| 112 | * CCSO PH/QI:: What is CCSO, PH, QI ? | ||
| 113 | * BBDB:: What is BBDB ? | 109 | * BBDB:: What is BBDB ? |
| 114 | @end menu | 110 | @end menu |
| 115 | 111 | ||
| @@ -141,30 +137,6 @@ EUDC requires external support to access LDAP directory servers | |||
| 141 | (@pxref{LDAP Configuration}) | 137 | (@pxref{LDAP Configuration}) |
| 142 | 138 | ||
| 143 | 139 | ||
| 144 | @node CCSO PH/QI | ||
| 145 | @section CCSO PH/QI | ||
| 146 | |||
| 147 | The Central Computing Services Office (CCSO) of the University of | ||
| 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. | ||
| 153 | |||
| 154 | The system consists of two parts: a database server traditionally called | ||
| 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. | ||
| 166 | |||
| 167 | |||
| 168 | @node BBDB | 140 | @node BBDB |
| 169 | @section BBDB | 141 | @section BBDB |
| 170 | 142 | ||
| @@ -175,14 +147,14 @@ and news readers. | |||
| 175 | 147 | ||
| 176 | It is often used as an enhanced email address book. | 148 | It is often used as an enhanced email address book. |
| 177 | 149 | ||
| 178 | EUDC considers BBDB as a directory server back end just like LDAP or | 150 | EUDC considers BBDB as a directory server back end just like LDAP, |
| 179 | PH/QI servers, though BBDB has no client/server protocol and thus always | 151 | though BBDB has no client/server protocol and thus always resides |
| 180 | resides locally on your machine. The point in this is not to offer an | 152 | 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 | 153 | 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 | 154 | more flexible ways to do that), but rather to offer an interface to |
| 183 | local directory that is consistent with the interface to external | 155 | your local directory that is consistent with the interface to external |
| 184 | directories (LDAP, PH/QI). This is particularly interesting when | 156 | LDAP directories. This is particularly interesting when performing |
| 185 | performing queries on multiple servers. | 157 | queries on multiple servers. |
| 186 | 158 | ||
| 187 | EUDC also offers a means to insert results from directory queries into | 159 | EUDC also offers a means to insert results from directory queries into |
| 188 | your own local BBDB (@pxref{Creating BBDB Records}) | 160 | your own local BBDB (@pxref{Creating BBDB Records}) |
| @@ -473,7 +445,7 @@ it will be ignored anyway. | |||
| 473 | 445 | ||
| 474 | @defvar eudc-protocol | 446 | @defvar eudc-protocol |
| 475 | The directory protocol to use to query the server. Currently supported | 447 | The directory protocol to use to query the server. Currently supported |
| 476 | protocols in this version of EUDC are @code{ph}, @code{ldap} and @code{bbdb}. | 448 | protocols in this version of EUDC are @code{ldap} and @code{bbdb}. |
| 477 | @end defvar | 449 | @end defvar |
| 478 | 450 | ||
| 479 | @deffn Command eudc-set-server | 451 | @deffn Command eudc-set-server |
| @@ -510,11 +482,8 @@ attributes are ignored. Default is @code{t}. | |||
| 510 | 482 | ||
| 511 | Directory standards may authorize different instances of the same | 483 | Directory standards may authorize different instances of the same |
| 512 | attribute in a record. For instance the record of a person may contain | 484 | attribute in a record. For instance the record of a person may contain |
| 513 | several email fields containing different email addresses. When using | 485 | several email fields containing different email addresses, in which |
| 514 | a QI directory server this is difficult to distinguish from attributes | 486 | case EUDC will consider the attribute duplicated. |
| 515 | having multi-line values such as the postal address that may contain a | ||
| 516 | line for the street and another one for the zip code and city name. In | ||
| 517 | both cases, EUDC will consider the attribute duplicated. | ||
| 518 | 487 | ||
| 519 | EUDC has several methods to deal with duplicated attributes. The | 488 | EUDC has several methods to deal with duplicated attributes. The |
| 520 | available methods are: | 489 | available methods are: |
| @@ -956,39 +925,6 @@ convenience functions to parse phones and addresses. | |||
| 956 | @end table | 925 | @end table |
| 957 | @end defvar | 926 | @end defvar |
| 958 | 927 | ||
| 959 | The default value of the PH-specific value of that variable is | ||
| 960 | @code{eudc-ph-bbdb-conversion-alist}: | ||
| 961 | |||
| 962 | @lisp | ||
| 963 | ((name . name) | ||
| 964 | (net . email) | ||
| 965 | (address . (eudc-bbdbify-address address "Address")) | ||
| 966 | (phone . ((eudc-bbdbify-phone phone "Phone") | ||
| 967 | (eudc-bbdbify-phone office_phone "Office Phone")))) | ||
| 968 | @end lisp | ||
| 969 | |||
| 970 | This means that: | ||
| 971 | |||
| 972 | @itemize @bullet | ||
| 973 | @item | ||
| 974 | the @code{name} field of the BBDB record gets its value | ||
| 975 | from the @code{name} attribute of the directory record | ||
| 976 | @item | ||
| 977 | the @code{net} field of the BBDB record gets its value | ||
| 978 | from the @code{email} attribute of the directory record | ||
| 979 | @item | ||
| 980 | the @code{address} field of the BBDB record is obtained by parsing the | ||
| 981 | @code{address} attribute of the directory record with the function | ||
| 982 | @code{eudc-bbdbify-address} | ||
| 983 | @item | ||
| 984 | two @code{phone} fields are created (when possible) in the BBDB record. | ||
| 985 | The first one has @cite{Phone} for location and its value is obtained by | ||
| 986 | parsing the @code{phone} attribute of the PH/QI record with the function | ||
| 987 | @code{eudc-bbdbify-phone}. The second one has @cite{Office Phone} for location | ||
| 988 | its value is obtained by parsing the @code{office_phone} attribute of the | ||
| 989 | PH/QI record with the function @code{eudc-bbdbify-phone}. | ||
| 990 | @end itemize | ||
| 991 | |||
| 992 | @defun eudc-bbdbify-phone phone location | 928 | @defun eudc-bbdbify-phone phone location |
| 993 | This is a convenience function provided for use in | 929 | This is a convenience function provided for use in |
| 994 | @code{eudc-bbdb-conversion-alist}. It parses @var{phone} into a vector | 930 | @code{eudc-bbdb-conversion-alist}. It parses @var{phone} into a vector |