4 LSDB (The Lovely Sister Database) is a rolodex-like database program
5 for SEMI based MUA. It's intended to be a lightweight relacement for
6 BBDB (The Insidious Big Brother Database). Unfortunately, it
7 currently doesn't support the all features of BBDB.
10 LSDB works under following environment at least:
13 - XEmacs 21.4 or later
15 You will also need the following libraries:
18 ftp://ftp.m17n.org/pub/mule/apel/
20 ftp://ftp.m17n.org/pub/mule/flim/
24 .. (a) run in expanded place
26 If you don't want to install other directories, please do only
31 You can specify the emacs command name, for example
33 % make install EMACS=xemacs
35 If `EMACS=...' is omitted, EMACS=emacs is used.
39 If you want to install other directories, please do following:
43 .. (c) install as a XEmacs package
45 If you want to install to XEmacs package directory, please do
48 % make install-package
50 .* MUA Specific Installation
52 There are the convenient ways to get the LSDB functions insinuate into
53 some particular MUA. Only Semi-gnus and Wanderlust are currently
56 If you use Semi-gnus or its variant, put the following lines into your
57 ~/.gnus and you will get the functions in this package autoloaded.
59 (autoload 'lsdb-gnus-insinuate "lsdb")
60 (autoload 'lsdb-gnus-insinuate-message "lsdb")
61 (add-hook 'gnus-startup-hook 'lsdb-gnus-insinuate)
62 (add-hook 'message-setup-hook
64 (define-key message-mode-map "\M-\t" 'lsdb-complete-name)))
65 (add-hook 'gnus-summary-mode-hook
67 (define-key gnus-summary-mode-map ":" 'lsdb-toggle-buffer)))
69 If you use Wanderlust, put the following lines into your ~/.wl:
72 (add-hook 'wl-draft-mode-hook
74 (define-key wl-draft-mode-map "\M-\t" 'lsdb-complete-name)))
75 (add-hook 'wl-summary-mode-hook
77 (define-key wl-summary-mode-map ":" 'lsdb-toggle-buffer)))
79 If you use Mew, put the following lines into your ~/.mew:
80 (autoload 'lsdb-mew-insinuate "lsdb")
81 (add-hook 'mew-init-hook 'lsdb-mew-insinuate)
82 (add-hook 'mew-draft-mode-hook
84 (define-key mew-draft-header-map "\M-I" 'lsdb-complete-name)))
85 (add-hook 'mew-summary-mode-hook
87 (define-key mew-summary-mode-map ":" 'lsdb-toggle-buffer)))
89 If you use MU-CITE, put the following lines into your ~/.emacs:
90 (autoload 'lsdb-mu-insinuate "lsdb")
91 (eval-after-load "mu-cite"
94 If you want to use x-face-e21 instead of the LSDB's builtin X-Face
95 functions, set lsdb-insert-x-face-function as follows:
96 (setq lsdb-insert-x-face-function
99 (insert-image (x-face-create-image x-face :scale-factor 0.5))))
102 If you found bugs, please drop a note to the Lsdb-info Mailing List:
104 lsdb-info@lists.sourceforge.jp
107 Latest version of LSDB can be found at:
109 http://sourceforge.jp/projects/lsdb/files/
112 The API are quite simple but not written in a way that maximizes
116 . : Gathering Records
117 . , lsdb-update-records<f>
118 lsdb-update-records<f> is called from the buffer which contains raw
119 contents of MIME entity. Once it is called, it returns a list of
120 records which could be gathered from the buffer.
123 . , lsdb-display-record<f>
124 lsdb-display-record<f> takes only one record, pops up a window, and
125 displays the formatted contents of the record within the window.
126 If you want to multiple records such as search results at the same
127 time, use lsdb-display-records<f> instead.
129 .. Internal Data Model
130 . : Primary Hash Table
131 lsdb-hash-table is the variable which holds all the records in LSDB.
132 You can operate on this variable in similar fashion to CL's
133 hash-table: lsdb-puthash for puthash, lsdb-gethash to gethash,
134 lsdh-maphash to maphash are available to you. For example, you can
135 write the following expression to get the record for "Daiki Ueno":
137 (lsdb-gethash "Daiki Ueno" lsdb-hash-table)
141 ((last-modified . "2002-04-23")
142 (creation-date . "2002-04-26")
143 (net "ueno@unixuser.org")
144 (mailing-list "emacs-mime-ja")
146 (user-agent "T-gnus/6.15.6 (based on Oort Gnus v0.06) (revision 03)"))
148 . : Secondary Hash Tables
149 LSDB can also have one or more secondary hash tables. These hash
150 tables are mainly used to hint lsdb-hash-table to gather additional
151 relationship information between record name and entries. For
152 example, lsdb-address-cache is a kind of secondary hash table which
153 maintains the mapping of mail addresses to record names.
155 The variable lsdb-secondary-hash-tables holds a list where each
156 element is corresponding to the name of global variable such as
157 lsdb-address-cache. When the primary hash table is loaded or saved,
158 the secondary hash tables will be handled automatically.
160 . , Operate on Secondary Hash Tables
161 You will need to follow the manner of the LSDB hooks.
163 . ; lsdb-lookup-full-name-functions
164 List of functions to pick up the existing full-name of the sender.
165 The sender is passed to each function as the argument.
167 . ; lsdb-update-record-functions
168 List of functions called after a record is modified.
169 The modified record is passed to each function as the argument.
173 Development of LSDB uses CVS. So latest developing version is
176 . : cvs login (first time only)
178 % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root login
180 CVS password: [CR] # NULL string
184 % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root checkout lsdb
186 If you would like to join CVS based development, please send mail to
190 with your account name and your public key for ssh. cvsroot is
191 :ext:cvs@cvs.m17n.org:/cvs/root.
193 If you cannot use ssh, please send UNIX /etc/passwd style crypted
194 password. you can commit with the cvsroot
195 :pserver:<accountname>@cvs.m17n.org:/cvs/root.
197 We hope you will join the open development.
201 Daiki Ueno <ueno@unixuser.org>
202 Hideyuki SHIRAI <shirai@rdmg.mgcs.mei.co.jp> (support for Mew)
203 Yuuichi Teranishi <teranisi@gohome.org>
206 The following `outline-layout' local variable setting:
207 - closes all topics from the first topic to just before the third-to-last,
208 - shows the children of the third to last (config vars)
209 - and the second to last (code section),
210 - and closes the last topic (this local-variables section).
212 outline-layout: (0 : -1 -1 0)