aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2001-09-20 15:42:36 +0000
committerEli Zaretskii2001-09-20 15:42:36 +0000
commit346e701f4572101b4f77c3f2532fec394f50c2b5 (patch)
tree557eaf3dbe1dd4b8146c4e3f56790318a6de40b2
parent906b3163a21a2b549762ef13c88dddb6e26d2721 (diff)
downloademacs-346e701f4572101b4f77c3f2532fec394f50c2b5.tar.gz
emacs-346e701f4572101b4f77c3f2532fec394f50c2b5.zip
Add a Command Index, for the sake of C-h C-f and C-h C-k.
-rw-r--r--man/eudc.texi106
1 files changed, 58 insertions, 48 deletions
diff --git a/man/eudc.texi b/man/eudc.texi
index 400de151a12..880d1d80723 100644
--- a/man/eudc.texi
+++ b/man/eudc.texi
@@ -88,6 +88,7 @@ LDAP or the CCSO white pages directory system (PH/QI)
88* Installation:: How to install EUDC 88* Installation:: How to install EUDC
89* Usage:: The various usage possibilities explained 89* Usage:: The various usage possibilities explained
90* Credits:: Who's done what 90* Credits:: Who's done what
91* Command and Function Index::
91* Variables Index:: 92* Variables Index::
92@end menu 93@end menu
93 94
@@ -99,7 +100,7 @@ LDAP or the CCSO white pages directory system (PH/QI)
99@comment node-name, next, previous, up 100@comment node-name, next, previous, up
100@chapter Overview 101@chapter Overview
101 102
102EUDC, the Emacs Unified Directory Client, provides a common user 103EUDC, the @dfn{Emacs Unified Directory Client}, provides a common user
103interface to access directory servers using different directory 104interface to access directory servers using different directory
104protocols. 105protocols.
105 106
@@ -145,7 +146,7 @@ Interface to BBDB to let you insert server records into your own BBDB database
145@comment node-name, next, previous, up 146@comment node-name, next, previous, up
146@section LDAP 147@section LDAP
147 148
148LDAP, Lightweight Directory Access Protocol, is a communication 149LDAP, @dfn{the Lightweight Directory Access Protocol}, is a communication
149protocol for directory applications defined in RFC 1777. 150protocol for directory applications defined in RFC 1777.
150 151
151Quoted from RFC 1777: 152Quoted from RFC 1777:
@@ -196,7 +197,7 @@ EUDC.
196@comment node-name, next, previous, up 197@comment node-name, next, previous, up
197@section BBDB 198@section BBDB
198 199
199BBDB is the Big Brother's Insiduous Database, a package for Emacs 200BBDB is the @dfn{Big Brother's Insiduous Database}, a package for Emacs
200originally written by Jamie Zawinski which provides rolodex-like 201originally written by Jamie Zawinski which provides rolodex-like
201database functionality featuring tight integration with the Emacs mail 202database functionality featuring tight integration with the Emacs mail
202and news readers. 203and news readers.
@@ -252,7 +253,7 @@ email composition buffers (@pxref{Inline Query Expansion})
252 253
253LDAP support is added by means of @file{ldap.el} which is part of Emacs. 254LDAP support is added by means of @file{ldap.el} which is part of Emacs.
254@file{ldap.el} needs an external command line utility named 255@file{ldap.el} needs an external command line utility named
255@file{ldapsearch} which is available as part of LDAP toolkits. above. 256@file{ldapsearch} which is available as part of LDAP toolkits:
256 257
257@itemize @bullet 258@itemize @bullet
258@item 259@item
@@ -334,7 +335,7 @@ protocols in this version of EUDC are @code{ph}, @code{ldap} and @code{bbdb}.
334@end defvar 335@end defvar
335 336
336@deffn Command eudc-set-server 337@deffn Command eudc-set-server
337This command accessible from @samp{Server} submenu lets you specify a 338This command accessible from @samp{New Server} submenu lets you specify a
338new directory server and protocol. 339new directory server and protocol.
339@end deffn 340@end deffn
340 341
@@ -437,11 +438,12 @@ defined by EUDC are @code{name}, @code{firstname}, @code{email} and
437@code{phone}. 438@code{phone}.
438 439
439@defvar eudc-query-form-attributes 440@defvar eudc-query-form-attributes
441@findex eudc-get-attribute-list
440A list of attributes presented in the query form. Attribute names in 442A list of attributes presented in the query form. Attribute names in
441this list should be either EUDC attribute names or valid attribute 443this list should be either EUDC attribute names or valid attribute
442names. You can get a list of valid attribute names for the current 444names. You can get a list of valid attribute names for the current
443protocol with the @samp{List Valid Attribute Names} menu item or the 445protocol with the @samp{List Valid Attribute Names} menu item or the
444@kbd{M-x eudc-get-attribute-list} command. Defaults to @code{name}, 446@kbd{M-x eudc-get-attribute-list} command. Defaults to @code{name},
445@code{email} and @code{phone}. 447@code{email} and @code{phone}.
446@end defvar 448@end defvar
447 449
@@ -554,12 +556,12 @@ be passed to the program.
554@section Inline Query Expansion 556@section Inline Query Expansion
555 557
556Inline query expansion is a powerful method to get completion from your 558Inline query expansion is a powerful method to get completion from your
557directory server. The most common usage is for expanding names to email 559directory server. The most common usage is for expanding names to email
558addresses in mail message buffers. The expansion is performed by the 560addresses in mail message buffers. The expansion is performed by the
559command @kbd{M-x eudc-expand-inline} which is available from the 561command @kbd{M-x eudc-expand-inline} which is available from the
560@samp{Directory Search} menu but can also be conveniently bound to a key 562@samp{Expand Inline Query} menu item but can also be conveniently
561shortcut (@pxref{Installation}) The operation is controlled by the 563bound to a key shortcut (@pxref{Installation}). The operation is
562variables @code{eudc-inline-expansion-format}, 564controlled by the variables @code{eudc-inline-expansion-format},
563@code{eudc-inline-query-format}, 565@code{eudc-inline-query-format},
564@code{eudc-expanding-overwrites-query} and 566@code{eudc-expanding-overwrites-query} and
565@code{eudc-multiple-match-handling-method}. 567@code{eudc-multiple-match-handling-method}.
@@ -571,7 +573,7 @@ until one of them finds a match (@pxref{Multi-server Queries}).
571Query the server and expand the query string before point. The query 573Query the server and expand the query string before point. The query
572string consists of the buffer substring from the point back to the 574string consists of the buffer substring from the point back to the
573preceding comma, colon or beginning of 575preceding comma, colon or beginning of
574line. @code{eudc-inline-query-format} controls how individual words 576line. @code{eudc-inline-query-format} controls how individual words
575are mapped onto directory attribute names. After querying the server 577are mapped onto directory attribute names. After querying the server
576for the given string, the expansion specified by 578for the given string, the expansion specified by
577@code{eudc-inline-expansion-format} is inserted in the buffer at 579@code{eudc-inline-expansion-format} is inserted in the buffer at
@@ -595,6 +597,7 @@ For instance, use the following
595 (firstname) 597 (firstname)
596 (firstname name))) 598 (firstname name)))
597@end lisp 599@end lisp
600@noindent
598to indicate that single word expansion queries are to be considered as 601to indicate that single word expansion queries are to be considered as
599surnames and if no match is found then they should be tried as first 602surnames and if no match is found then they should be tried as first
600names. Inline queries consisting of two words are considered as 603names. Inline queries consisting of two words are considered as
@@ -620,10 +623,10 @@ against the @code{cn} attribute of LDAP servers:
620 623
621@defvar eudc-inline-expansion-format 624@defvar eudc-inline-expansion-format
622This variable lets you control exactly what is inserted into the buffer 625This variable lets you control exactly what is inserted into the buffer
623upon an inline expansion request. It is a list whose first element is a 626upon an inline expansion request. It is a list whose first element is a
624string passed to @code{format}. Remaining elements are symbols 627string passed to @code{format}. Remaining elements are symbols
625corresponding to directory attribute names. The corresponding attribute 628corresponding to directory attribute names. The corresponding attribute
626values are passed as additional arguments to @code{format}. Default is 629values are passed as additional arguments to @code{format}. Default is
627@code{("%s" email)} but you may want to consider a value like @code{("%s 630@code{("%s" email)} but you may want to consider a value like @code{("%s
628<%s>" name email)} 631<%s>" name email)}
629@end defvar 632@end defvar
@@ -636,16 +639,15 @@ for an inline expansion. Possible values are:
636The first match is considered as being the only one, the others are 639The first match is considered as being the only one, the others are
637discarded. 640discarded.
638@item select 641@item select
639A selection buffer pops up where you can choose a particular match. This 642A selection buffer pops up where you can choose a particular match. This
640is the default value of the variable. 643is the default value of the variable.
641@item all 644@item all
642The expansion uses all records successively 645The expansion uses all records successively
643@item abort 646@item abort
644An error is signaled. The expansion aborts. 647An error is signaled. The expansion aborts.
645@end table 648@end table
646 649
647 650Default is @code{select}
648Defaults to @code{select}
649@end defvar 651@end defvar
650 652
651 653
@@ -655,16 +657,16 @@ Defaults to @code{select}
655@section The Server Hotlist 657@section The Server Hotlist
656 658
657EUDC lets you maintain a list of frequently used servers so that you 659EUDC lets you maintain a list of frequently used servers so that you
658can easily switch from one to another. This hotlist appears in the 660can easily switch from one to another. This hotlist appears in the
659@samp{Server} submenu. You select a server in this list by clicking on 661@samp{Server} submenu. You select a server in this list by clicking on
660its name. You can add the current server to the list with the command 662its name. You can add the current server to the list with the command
661@kbd{M-x eudc-bookmark-current-server}. The list is contained in the variable 663@kbd{M-x eudc-bookmark-current-server}. The list is contained in the variable
662@code{eudc-server-hotlist} which is stored in and retrieved from the file 664@code{eudc-server-hotlist} which is stored in and retrieved from the file
663designated by @code{eudc-options-file}. EUDC also provides a facility to 665designated by @code{eudc-options-file}. EUDC also provides a facility to
664edit the hotlist interactively (@pxref{The Hotlist Edit Buffer}). 666edit the hotlist interactively (@pxref{The Hotlist Edit Buffer}).
665 667
666The hotlist is also used to make queries on multiple servers 668The hotlist is also used to make queries on multiple servers
667successively (@pxref{Multi-server Queries}). The order in which the 669successively (@pxref{Multi-server Queries}). The order in which the
668servers are tried is the order they appear in the hotlist, therefore it 670servers are tried is the order they appear in the hotlist, therefore it
669is important to sort the hotlist appropriately. 671is important to sort the hotlist appropriately.
670 672
@@ -678,7 +680,7 @@ Add the current server to the hotlist of servers
678 680
679@defvar eudc-options-file 681@defvar eudc-options-file
680The name of a file where EUDC stores its internal variables 682The name of a file where EUDC stores its internal variables
681(the hotlist and the current server). EUDC will try to load 683(the hotlist and the current server). EUDC will try to load
682that file upon initialization so, if you choose a file name 684that file upon initialization so, if you choose a file name
683different from the defaults @file{~/.eudc-options}, be sure to set this 685different from the defaults @file{~/.eudc-options}, be sure to set this
684variable to the appropriate value @emph{before} EUDC is itself 686variable to the appropriate value @emph{before} EUDC is itself
@@ -736,7 +738,7 @@ of them successfully finds a match for the query.
736 738
737@defvar eudc-inline-expansion-servers 739@defvar eudc-inline-expansion-servers
738This variable controls which servers are tried and in which order when 740This variable controls which servers are tried and in which order when
739trying to perform an inline query. Possible values are: 741trying to perform an inline query. Possible values are:
740@table @code 742@table @code
741@item current-server 743@item current-server
742Only the current directory server is tried 744Only the current directory server is tried
@@ -752,7 +754,7 @@ order they appear in the hotlist until one of them finds a match or
752 754
753@defvar eudc-max-servers-to-query 755@defvar eudc-max-servers-to-query
754This variable indicates the maximum number of servers to query when 756This variable indicates the maximum number of servers to query when
755performing a multi-server query. The default, @code{nil}, indicates 757performing a multi-server query. The default, @code{nil}, indicates
756that all available servers should be tried. 758that all available servers should be tried.
757@end defvar 759@end defvar
758 760
@@ -762,25 +764,28 @@ that all available servers should be tried.
762@comment node-name, next, previous, up 764@comment node-name, next, previous, up
763@section Creating BBDB Records 765@section Creating BBDB Records
764 766
767@findex eudc-insert-record-at-point-into-bbdb
768@findex eudc-try-bbdb-insert
765With EUDC, you can automatically create BBDB records 769With EUDC, you can automatically create BBDB records
766(@pxref{Top,,BBDB,bbdb,BBDB Manual}) from records you get from a 770(@pxref{Top,,BBDB,bbdb,BBDB Manual}) from records you get from a
767directory server. You do this by moving point to the appropriate 771directory server. You do this by moving point to the appropriate
768record in a query result display buffer and invoking the command 772record in a query result display buffer and invoking the command
769@kbd{M-x eudc-insert-record-at-point-into-bbdb} with the 773@kbd{M-x eudc-insert-record-at-point-into-bbdb} with the
770keyboard binding @kbd{b} @footnote{This key binding does not actually 774keyboard binding @kbd{b}@footnote{This key binding does not actually
771call @code{eudc-insert-record-at-point-into-bbdb} but uses 775call @code{eudc-insert-record-at-point-into-bbdb} but uses
772@code{eudc-try-bbdb-insert} instead.}, or with the menu. EUDC 776@code{eudc-try-bbdb-insert} instead.}, or with the menu. EUDC
773cannot update an existing BBDB record and will signal an error if you 777cannot update an existing BBDB record and will signal an error if you
774try to insert a record matching an existing one. 778try to insert a record matching an existing one.
775 779
780@findex eudc-batch-export-records-to-bbdb
776It is also possible to export to BBDB the whole batch of records 781It is also possible to export to BBDB the whole batch of records
777contained in the directory query result with the command 782contained in the directory query result with the command
778@kbd{M-x eudc-batch-export-records-to-bbdb}. 783@kbd{M-x eudc-batch-export-records-to-bbdb}.
779 784
780Because directory systems may not enforce a strict record format, local 785Because directory systems may not enforce a strict record format, local
781server installations may use different attribute names and have 786server installations may use different attribute names and have
782different ways to organize the information. Furthermore BBDB has its own 787different ways to organize the information. Furthermore BBDB has its own
783record structure. For these reasons converting a record from its 788record structure. For these reasons converting a record from its
784external directory format to the BBDB format is a highly customizable 789external directory format to the BBDB format is a highly customizable
785process. 790process.
786 791
@@ -788,14 +793,14 @@ process.
788The value of this variable should be a symbol naming an alist defining a 793The value of this variable should be a symbol naming an alist defining a
789mapping between BBDB field names onto directory attribute names records. 794mapping between BBDB field names onto directory attribute names records.
790This is a protocol-local variable and is initialized upon protocol 795This is a protocol-local variable and is initialized upon protocol
791switch (@pxref{Server/Protocol Locals}) The alist is made of cells of the 796switch (@pxref{Server/Protocol Locals}). The alist is made of cells of the
792form @code{(@var{bbdb-field} . @var{spec-or-list})}. 797form @code{(@var{bbdb-field} . @var{spec-or-list})}.
793@var{bbdb-field} is the name of a field 798@var{bbdb-field} is the name of a field
794that must be defined in your BBDB environment (standard field names are 799that must be defined in your BBDB environment (standard field names are
795@code{name}, @code{company}, @code{net}, @code{phone}, @code{address} 800@code{name}, @code{company}, @code{net}, @code{phone}, @code{address}
796and @code{notes}). 801and @code{notes}).
797@var{spec-or-list} is either a single mapping specification or a list of 802@var{spec-or-list} is either a single mapping specification or a list of
798mapping specifications. Lists of mapping specifications are valid for 803mapping specifications. Lists of mapping specifications are valid for
799the @code{phone} and @code{address} BBDB fields only. @var{spec}s are 804the @code{phone} and @code{address} BBDB fields only. @var{spec}s are
800actually s-expressions which are evaluated as follows: 805actually s-expressions which are evaluated as follows:
801 806
@@ -803,12 +808,12 @@ actually s-expressions which are evaluated as follows:
803@item a string 808@item a string
804evaluates to itself 809evaluates to itself
805@item a symbol 810@item a symbol
806evaluates to the symbol value. Symbols corresponding to directory 811evaluates to the symbol value. Symbols corresponding to directory
807attribute names present in the record evaluate to the value of the field 812attribute names present in the record evaluate to the value of the field
808in the record 813in the record
809@item a form 814@item a form
810is evaluated as a function. The argument list may contain attribute 815is evaluated as a function. The argument list may contain attribute
811names which evaluate to the corresponding values in the record. The form 816names which evaluate to the corresponding values in the record. The form
812evaluation should return something appropriate for the particular 817evaluation should return something appropriate for the particular
813@var{bbdb-field} (see @code{bbdb-create-internal}). 818@var{bbdb-field} (see @code{bbdb-create-internal}).
814@code{eudc-bbdbify-phone} and @code{eudc-bbdbify-address} are provided as 819@code{eudc-bbdbify-phone} and @code{eudc-bbdbify-address} are provided as
@@ -844,25 +849,25 @@ the @code{address} field of the BBDB record is obtained by parsing the
844two @code{phone} fields are created (when possible) in the BBDB record. 849two @code{phone} fields are created (when possible) in the BBDB record.
845The first one has @cite{Phone} for location and its value is obtained by 850The first one has @cite{Phone} for location and its value is obtained by
846parsing the @code{phone} attribute of the PH/QI record with the function 851parsing the @code{phone} attribute of the PH/QI record with the function
847@code{eudc-bbdbify-phone}. The second one has @cite{Office Phone} for location 852@code{eudc-bbdbify-phone}. The second one has @cite{Office Phone} for location
848its value is obtained by parsing the @code{office_phone} attribute of the 853its value is obtained by parsing the @code{office_phone} attribute of the
849PH/QI record with the function @code{eudc-bbdbify-phone}. 854PH/QI record with the function @code{eudc-bbdbify-phone}.
850@end itemize 855@end itemize
851 856
852@defun eudc-bbdbify-phone phone location 857@defun eudc-bbdbify-phone phone location
853This is a convenience function provided for use in 858This is a convenience function provided for use in
854@code{eudc-bbdb-conversion-alist}. It parses @var{phone} into a vector 859@code{eudc-bbdb-conversion-alist}. It parses @var{phone} into a vector
855compatible with @code{bbdb-create-internal}. @var{phone} is either a string 860compatible with @code{bbdb-create-internal}. @var{phone} is either a string
856supposedly containing a phone number or a list of such strings which are 861supposedly containing a phone number or a list of such strings which are
857concatenated. @var{location} is used as the phone location for BBDB. 862concatenated. @var{location} is used as the phone location for BBDB.
858@end defun 863@end defun
859 864
860@defun eudc-bbdbify-address addr location 865@defun eudc-bbdbify-address addr location
861This is a convenience function provided for use in 866This is a convenience function provided for use in
862@code{eudc-bbdb-conversion-alist}. It parses @var{addr} into a vector 867@code{eudc-bbdb-conversion-alist}. It parses @var{addr} into a vector
863compatible with @code{bbdb-create-internal}. @var{addr} should be an 868compatible with @code{bbdb-create-internal}. @var{addr} should be an
864address string of no more than four lines or a list of lines. The last 869address string of no more than four lines or a list of lines. The last
865line is searched for the zip code, city and state name. @var{location} 870line is searched for the zip code, city and state name. @var{location}
866is used as the phone location for BBDB. 871is used as the phone location for BBDB.
867@end defun 872@end defun
868 873
@@ -877,7 +882,7 @@ actually be inserted as part of the newly created BBDB record.
877 882
878EUDC can be customized independently for each server or directory 883EUDC can be customized independently for each server or directory
879protocol. All variables can be given local bindings that are activated 884protocol. All variables can be given local bindings that are activated
880when a particular server and/or protocol becomes active. This is much 885when a particular server and/or protocol becomes active. This is much
881like buffer-local bindings but on a per server or per protocol basis. 886like buffer-local bindings but on a per server or per protocol basis.
882 887
883@menu 888@menu
@@ -951,7 +956,6 @@ Return @code{unbound} if @var{var} has no value local to @var{server}.
951@var{server} defaults to @code{eudc-server}. 956@var{server} defaults to @code{eudc-server}.
952@end defun 957@end defun
953 958
954
955Changing a protocol-local or server-local value of a variable has no 959Changing a protocol-local or server-local value of a variable has no
956effect on its current value. The following command is used to 960effect on its current value. The following command is used to
957synchronize the current values of variables with their local values 961synchronize the current values of variables with their local values
@@ -963,7 +967,7 @@ Update all EUDC variables according to their local settings.
963 967
964 968
965 969
966@node Credits, Variables Index, Usage, Top 970@node Credits, Command and Function Index, Usage, Top
967@comment node-name, next, previous, up 971@comment node-name, next, previous, up
968@chapter Credits 972@chapter Credits
969 973
@@ -973,7 +977,13 @@ same author.
973Thanks to Soren Dayton for his suggestions, his enthusiasm and his help 977Thanks to Soren Dayton for his suggestions, his enthusiasm and his help
974in testing and proofreading the code and docs of @file{ph.el}. 978in testing and proofreading the code and docs of @file{ph.el}.
975 979
976@node Variables Index, , Credits, Top 980@node Command and Function Index, Variables Index, Credits, Top
981@comment node-name, next, previous, up
982@unnumbered Command and Function Index
983
984@printindex fn
985
986@node Variables Index, , Command and Function Index, Top
977@comment node-name, next, previous, up 987@comment node-name, next, previous, up
978@unnumbered Variables Index 988@unnumbered Variables Index
979 989