summaryrefslogtreecommitdiff
path: root/html/index.html
blob: 2ba4498191f8d67a68e3a19d23967b66f57dbcf2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
<!doctype html public "-//W3C//DTD HTML 3.2//EN">
<html>
<head>
<title>The Insidious Big Brother DataBase @ SourceForge</title>
<link rel="stylesheet" href="bbdb.css">
</head>

<body>

<h1 align="center"
><img src="images/headright.gif" alt="head" width="50" height="25">
The Insidious Big Brother Database
<img src="images/headleft.gif" alt="head" width="50" height="25"></h1>

<p align="center">Quicklinks:
  <a href="#get">get the bbdb</a>
| <a href="#lists">mailing lists</a>
| <a href="#links">links</a>
| <a href="#manual">manual</a>
| <a href="faq.html">FAQ</a>
| <a href="http://sourceforge.net/projects/bbdb/">project home</a>
| <a href="http://freshmeat.net/projects/bbdb/">freshmeat entry</a>
</p>

<h2>What is The Insidious Big Brother Database?</h2>

<p>The Insidious Big Brother Database (BBDB) is a contact management
utility created by <a href="http://www.jwz.org/">Jamie Zawinski</a> for
use with <a href="http://www.gnu.org/emacs">Emacs</a>.  For many years it was
maintained by <a href="http://www.waider.ie/">Waider</a>.  Since February 2007
BBDB is maintained by <a href="http://www.robf.de">Robert Widhopf-Fenk</a>.</p> 

<p>It is tightly
integrated with several mail and news readers (see below), allowing it
to create database entries directly from mail and news messages.  As is 
usual with applications for Emacs, this record creation can be
configured in many ways, ranging from a boolean create/don't create
setting to creation based on the result of a user-supplied function.</p>

<p>Database records can be used to store many types of
information, from name and address to URLs and X-Face images.
This information can be displayed when a message from an entity
named in a database record is recieved.  In addition, messages
from database members can be tagged in the Gnus Summary Buffer,
and Gnus scoring can be configured based on the contents of
database records.  Supercite citations can even be preset
through the use of records in the BBDB.</p>

<h2>Requirements:</h2>

<h3>Supported versions of Emacs</h3>

Starting with 2.35 there is no active support for Emacsens < 21.4!    
<dl>
 <dt><strong><a href="http://www.gnu.org/">Gnu</a>
   <a href="http://www.gnu.org/software/emacs/emacs.html">Emacs</a></strong>
  <dd>versions 21.4 and above</dd>
 <dt><strong><a href="http://www.xemacs.org/">XEmacs</a></strong>
  <dd>versions 21.4 and above</dd>
</dl>

<h3>Supported Mail and News readers</h3>

<p>The BBDB can be used without a mail- or news-reader.  It has,
however, been optimized for use with one.</p>
<ul>
  <li><a href="http://www.gnus.org/">Gnus</a></li>
  <li><a href="http://www.wonderworks.com/vm/">VM</a></li>
  <li>MH-e</li>
  <li>Rmail</li>
  <li>UNIX <a href="http://www.netscape.com/">Netscape</a> Mail
   (via bbdb-srv)</li>
  <li>UNIX <a href="http://www.netscape.com/">Netscape</a> News
   (via bbdb-srv)</li>
</ul>

<h2><a name="get">Getting the BBDB</a></h2>

<p><a href="bbdb-2.35.tar.gz">BBDB 2.35</a> is the current
stable released version, released on January  30, 2007.</p>

<p>The current version, 2.36, is tagged on the git repository
  git://github.com/barak/BBDB.git which also holds the development
  version.  At least, those doing development there think so.
    </p>

<h3>Compilation notes:</h3>

<ol>
 <li>BBDB uses autoconf to generate its Makefiles, so it should work
     anywhere that autoconf works. The tarballed version comes with
     prebuilt configure script and Makefiles; the CVS version will
     require you to use autoconf to generate the configure
     script. If you don't have autoconf, you can get download a <a
     href="configure">prebuilt configure script</a>. Please note that
     the Makefiles in the tarball are built using the defaults,
     i.e. Emacs to compile with and no extra directories
     specified.</li>

 <li>Texinfo 3.11 (or later) is required to compile the texinfo
     documentation.  It is available at <a
     href="ftp://ftp.gnu.org/pub/gnu">the GNU FTP
     site</a>. Precompiled info files are included in the
     tarball. Some work has been done by ShengHuo ZHU to make this
     unnecessary.</li>

 <li>Building on platforms without <tt>make</tt> or running BBDB
     uncompiled can be assisted by downloading a <a
     href="bbdb-autoloads.el">prebuilt bbdb-autoloads.el</a>. A
     <tt>make.bat</tt> for Windows platforms is in the works; see the
     mailing list archives for more details.
</ol>

<h2>CVS tree</h2>

<p>The development and release versions are available via Anon-CVS
to the CVS tree at <code>bbdb.cvs.sourceforge.net</code>.  To access the
tree, log in with the following command:

<pre>
cvs -d :pserver:anonymous@bbdb.cvs.sourceforge.net:/cvsroot/bbdb login
</pre>

The password is blank; just hit return at the prompt.</p>

To check out a version of the BBDB, use one of the following commands:

<pre>
cvs -d :pserver:anonymous@bbdb.cvs.sourceforge.net:/cvsroot/bbdb checkout bbdb
cvs -d :pserver:anonymous@bbdb.cvs.sourceforge.net:/cvsroot/bbdb checkout -r rev bbdb
</pre>

<p>The first command will check out a copy of the latest version.
Usually this latest version will be a development version, but it may
fetch a release version if the command is executed soon enough after a
release version is made available.</p>

<p>The second command allows control of the version retrieved, through
the <code>-r rev</code> argument.  The <code>rev</code> portion of the
argument should be replaced with a word of the form:</p>

<center><code>BBDB_</code><var>x</var><code>_</code><var>yy</var></center>

<p><var>x</var> and <var>yy</var> are components of the version to be
retrieved, as in <var>x</var>.<var>yy</var>.
<strong>Note:</strong> <code>unoff</code> should be appended to the
above word for all versions prior to 2.00.</p>

To retrieve version 1.90, use the following argument:<br>

<pre>
-r BBDB_1_90unoff
</pre>

To retrieve version 2.34, use the following argument:<br>

<pre>
-r BBDB_2_34
</pre>

<h2><a name="manual">Manual</a></h2>

<p>You may browse <a href="bbdb.html">HTML version of the texinfo
manual that accompanies BBDB</a>, which is generated by <a
href="http://www.mathematik.uni-kl.de/~obachman/Texi2html"
><code>texi2html</code></a>.</p>

<h2><a name="lists">Mailing Lists</a></h2>

<p>There are two mailing lists for the BBDB:</p>

<dl>
 <dt><strong>bbdb-info</strong></dt>
  <dd>General discussion about the BBDB, both for users and developers.
   The archive for mails up to end of April 2000 can be found at
   <a
   href="http://www.mail-archive.com/bbdb-info%40xemacs.org/">http://www.mail-archive.com/bbdb-info%40xemacs.org/</a>. Since April 2000 mails are archived at
   <a
   href="http://www.mail-archive.com/bbdb-info%40lists.sourceforge.net/">http://www.mail-archive.com/bbdb-info%40lists.sourceforge.net/</a>.

  <p>SourceForge has built-in archiving which didn't initially
  seem to be working, but is apparently okay now. You can find this
  linked off the <a
  href="http://sourceforge.net/projects/bbdb/">project home</a> on
  SourceForge.</p>

 <dt><strong>bbdb-announce</strong></dt>
  <dd>Announcements of new BBDB versions.  This list is moderated, and
   has very low volume.</dd>
</dl>

To subscribe to either mailing list, send mail to
<var>listname</var><code>-request@lists.sourceforge.net</code> with
<code>subscribe</code> as the body. You will receive a reply
requesting confirmation of your subscription; return the confirmation
as described in the email, and you're on the list. Alternatively you
can visit the list signup page, linked from the <a
href="http://sourceforge.net/projects/bbdb">project page</a>.

<h2><a name="links">Links</a></h2>

<p>Several people have been hacking at BBDB and have pages describing
what they're at. Please check which version of BBDB they apply to
before attempting to use them!</p>

<ul>
 <li><a href="http://www.emacswiki.org/cgi-bin/alex/">Alex Schroeder</a>
  has done some work on <a
  href="http://www.geocities.com/kensanata/bbdb-funcs.html">address
  formats and pine/mailrc integration</a>. He's also responsible for
  making BBDB handle non-US addresses a lot better.</li>

 <li><a href="http://www.Jochen-Kuepper.de/">Jochen
  K&uuml;pper</a> has done some work on
  <code>bbdb-print</code>, which is now in CVS.</li>

 <li>Thomas DeWeese</a> wrote a <a
   href="http://pilotmanager.sourceforge.net/">PilotManager</a> plugin
   called SyncBBDB, and also implemented the
   multiple-same-name-records support. <a
   href="http://syncbbdb2.sourceforge.net/">SyncBBDB</a> is now
   maintained by Aaron Kaplan.</li>

 <li><a href="http://www.splode.com/~friedman/">Noah Friedman</a> is
 currently maintaining <a href="http://www.jwz.org/">jwz</a>'s <a
 href="http://www.splode.com/~friedman/software/emacs-lisp/index.html#bbdb-pilot-jwz">bbdb-pilot.el</a>.</li>

 <li><a href="http://meltin.net/people/martin/">Martin
 Schwenke</a> has written some code to export BBDB records to a Nokia
 phone via <a href="http://www.gnokii.org/">gnokii</a>. You can find
 it at <a href="http://meltin.net/hacks/emacs/">Martin's web
 site</a>.</li>

 <li>Broken: <a href="http://www.valente.de/aldo/palm/">Aldo Valente</a> has
   done some work on making SyncAB (from PilotManager) work with
   BBDB.</li>

 <li>Broken:<a href="http://t2100cdt.kippona.net/linux/emacs/mew/">Chris
  Beggy</a> has managed to get BBDB working with Mew, a mailreader
  with Japanese language support. There's a bbdb-mew.el on his page
  which should probably make it into the official tree at some
  point.</li>

 <li>Broken:<a href="http://www.esperi.demon.co.uk/nix/">Nix</a> has some
   expiry code for BBDB which allows you to automatically discard old
   BBDB records.</li>

 <li><a
   href="http://www.inf.tu-dresden.de/~s1010824/data/lbdb2bbdb.tar.gz">lbdb2bdb</a>
   is some code by Steffen Liebergeld to migrate lbdb data to bbdb.</li>

 <li><a
   href="http://www.neilvandyke.org/bbdb2tbird/">bbdb2tbird</a>
   is some code by Neil Van Dyke to migrate BBDB data to the Thunderbird
   address book.</li>
	  
 <li>The <code>bits</code> subdirectory in the source tree contains
  random bits and pieces that I've collected but not
  integrated, including a generic export filter of sorts and PGP and
  Outlook integration/interaction. Please note that at least some of
  this hasn't been modfied to work with versions later than
  2.00.06.</li>

</ul>

<hr>
<address><a href="http://www.robf.de/">Robert Widhopf-Fenk</a> (based on
<a href="http://www.waider.ie/">Waiders</a> and Matt Simmons' BBDB page</a>)</address>


<p align="center">Hosted by<br><a href="http://sourceforge.net/"><img
src="http://sourceforge.net/images/sflogo2-steel.png" vspace="0"
border=0 width="143" height="70" alt="sourceforge.net"></a></p>
</body>
</html>