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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd">
<html>
<!-- Created on February, 4 2006 by texi2html 1.76 -->
<!--
Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
Karl Berry <karl@freefriends.org>
Olaf Bachmann <obachman@mathematik.uni-kl.de>
and many others.
Maintained by: Many creative people <dev@texi2html.cvshome.org>
Send bugs and suggestions to <users@texi2html.cvshome.org>
-->
<head>
<title>Insidious Big Brother Database User Manual: 1.1 Installation</title>
<meta name="description" content="Insidious Big Brother Database User Manual: 1.1 Installation">
<meta name="keywords" content="Insidious Big Brother Database User Manual: 1.1 Installation">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2html 1.76">
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
pre.display {font-family: serif}
pre.format {font-family: serif}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: serif; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: serif; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.sansserif {font-family:sans-serif; font-weight:normal;}
ul.toc {list-style: none}
-->
</style>
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Installation"></a>
<a name="SEC2"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC3" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 1.1 Installation </h2>
<p>This program consists of several groups of files, organized by
directory:
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC3">1.1.1 General Prerequisites</a></td><td> </td><td align="left" valign="top"> General <b>BBDB</b> requirements
</td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
File Installation
</pre></th></tr><tr><td align="left" valign="top"><a href="#SEC4">1.1.2 Normal User Installation</a></td><td> </td><td align="left" valign="top"> "Normal" Installations
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC10">1.1.3 XEmacs Package Installation</a></td><td> </td><td align="left" valign="top"> Installing as an XEmacs package
</td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
Initial Configuration
</pre></th></tr><tr><td align="left" valign="top"><a href="#SEC13">1.1.4 Initial Configuration</a></td><td> </td><td align="left" valign="top"> How to initially set up the <b>BBDB</b>
</td></tr>
</table>
<hr size="6">
<a name="General-Prerequisites"></a>
<a name="SEC3"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC2" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC4" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC2" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.1.1 General Prerequisites </h3>
<p>Various parts of the <b>BBDB</b> require extra packages to be available
that are not part of the <b>BBDB</b> distribution. Please note that with
one exception no extra packages (beyond those which ship with both GNU
Emacs and XEmacs) are required for the use of <b>BBDB</b> core
functionality.<a name="DOCF1" href="bbdb_fot.html#FOOT1">(1)</a> This one exception
applies to XEmacs 20.5 users - the <code>xemacs-base</code> package must be
installed for the correct operation of the core <b>BBDB</b> functionality.
The table below lists the requirements of the various portions of the
<b>BBDB</b>. Please note that the absence of any of the below optional
packages will not affect core <b>BBDB</b> functionality.
</p>
<table>
<tr><td> <br><p> BBDB file
</p></td><td> <br><p> Package needed
</p></td><td> <br><p> GNU 19.34
</p></td><td> <br><p> GNU 20.2
</p></td><td><p> XEmacs<br> </p><p align="center"> >=20.4
</p></td><td><p> XEmacs<br> </p><p align="center"> 20.5
</p>
</td></tr>
<tr><td><p> <code>bbdb-ftp</code>
</p></td><td><p> EFS or <br> Ange-FTP
</p></td><td> <p align="center"> B
</p></td><td> <p align="center"> B
</p></td><td> <p align="center"> B
</p></td><td> <p align="center"> P
</p>
</td></tr>
<tr><td><p> <code>bbdb-gnus</code>
</p></td><td><p> Gnus[1]
</p></td><td> <p align="center"> B
</p></td><td> <p align="center"> B
</p></td><td> <p align="center"> B
</p></td><td> <p align="center"> P
</p>
</td></tr>
<tr><td><p> <code>bbdb-mhe</code>
</p></td><td><p> MH-E
</p></td><td> <p align="center"> B
</p></td><td> <p align="center"> B
</p></td><td> <p align="center"> B
</p></td><td> <p align="center"> P
</p>
</td></tr>
<tr><td><p> <code>bbdb-reportmail</code>
</p></td><td><p> Reportmail
</p></td><td>
</td><td>
</td><td> <p align="center"> B
</p></td><td> <p align="center"> P[2]
</p>
</td></tr>
<tr><td><p> <code>bbdb-sc</code>
</p></td><td><p> Supercite
</p></td><td> <p align="center"> B
</p></td><td>
</td><td> <p align="center"> B
</p></td><td> <p align="center"> P
</p>
</td></tr>
<tr><td><p> <code>bbdb-srv</code>
</p></td><td><p> <code>gnuserv</code> and <br> <code>itimer</code>
</p></td><td>
</td><td>
</td><td> <p align="center"> B
</p></td><td> <p align="center"> B
</p>
</td></tr>
<tr><td><p> <code>bbdb-vm</code>
</p></td><td><p> VM[4]
</p></td><td>
</td><td>
</td><td> <p align="center"> B
</p></td><td> <p align="center"> P
</p>
</td></tr>
<tr><td><p> <code>bbdb-w3</code>
</p></td><td><p> <code>browse-url</code>
</p></td><td> <p align="center"> B
</p></td><td> <p align="center"> B
</p></td><td> <p align="center"> B
</p></td><td> <p align="center"> P[3]
</p></td></tr>
</table>
<br>
<p><b>NOTES:</b>
</p><ol>
<li>
The old GNUS mail/newsreader should still work. Please keep in mind
that you have a relatively recent Emacs (GNU 19.34 or later, XEmacs
19.15 or later), you are probably using Gnus.
</li><li>
As of this writing, Reportmail is available as
part of the <code>edit-utils</code> package.
</li><li>
As of this writing, <code>browse-url</code> is
available as part of the <code>mail-lib</code> package.
</li><li>
The source release of VM is currently required due to the use of macros
from the VM codebase in <b>BBDB</b>'s VM integration.
</li></ol>
<p>Please also note that the XEmacs package locations are as of this
writing. As the XEmacs 20.5 package system is still in development, the
locations may change without warning.
</p>
<hr size="6">
<a name="Normal-User"></a>
<a name="SEC4"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC3" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC10" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC2" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.1.2 Normal User Installation </h3>
<a name="SEC5"></a>
<h3 class="subheading"> Configuring the compilation process </h3>
<p>First of all, you should run the <code>configure</code> script at the toplevel
of the distribution. This script will perform a number of checks on
your system and generate the <tt>`Makefile'</tt>'s accordingly.
</p>
<p>The <code>configure</code> script also comes with a number of options that
lets you customize the compilation process. These options are described
below where appropriate.
</p>
<a name="SEC6"></a>
<h3 class="subheading"> Byte Compiling the Lisp files </h3>
<p>First, you need to byte-compile the appropriate <b>BBDB</b> Lisp files.
While this is in theory an optional step, it is virtually required in
practice due to speed reasons.
</p>
<p>In order to byte-compile the lisp files, an Emacs of some sort must be
used. By default (at <code>configure</code> time), <code>emacs</code> and
<code>xemacs</code> will be tried in that order. If you want to use a special
Emacs flavor (or if you want to use <code>xemacs</code> at the first place),
you should pass the <code>--with-emacs=PROG</code> option to <code>configure</code>.
</p>
<p>In order to successfully compile the <b>BBDB</b>, the build process also
needs to know the location of the various optional packages. If the
directories containing these optional packages are in the default Emacs
search path (the <code>load-path</code> variable), no other changes need be
made for the build process to complete successfully.
</p>
<p>If the optional packages are not in the default search path, the build
process will not find them unless explicitly told of their location(s).
To tell the build process where to find Gnus, MH-E, and/or VM, use the
<code>configure</code> options <code>--with-gnus-dir=DIR</code>,
<code>--with-mhe-dir=DIR</code>, and/or <code>--with-vm-dir=DIR</code> variables
respectively. To tell the build process where to find any other
package(s), pass the directories containing the lisp files for the
package(s) to the <code>configure</code> option <code>--with-other-dirs=DIRS</code>.
If multiple directories are to be added, they should be separated by
spaces or colons, and should <b>not</b> be quoted. For example, to
add the <tt>`/p/local/elisp/footnote'</tt> and <tt>`/p/local/elisp/sc'</tt>
directories, call the <code>configure</code> script as follows:
</p>
<table><tr><td> </td><td><pre class="example"> <code>configure --with-other-dirs=/p/local/elisp/footnote:/p/local/elisp/sc</code>
</pre></td></tr></table>
<p>After configuring, run one of the following commands:
</p>
<p>You can also combine the above <code>make</code> commands. For example, to
build the <b>BBDB</b> with support for <code>Gnus</code> and <code>VM</code>, you can
do so by typing:
</p>
<table><tr><td> </td><td><pre class="example">make gnus vm
</pre></td></tr></table>
<a name="SEC7"></a>
<h3 class="subheading"> Moving the files to their final destination </h3>
<a name="SEC8"></a>
<h4 class="subsubheading"> Lisp files </h4>
<p>As stated above, the <tt>`lisp'</tt> subdirectory contains the Emacs Lisp source
files for the <b>BBDB</b>. Therefore, these files must be in the Emacs
<code>load-path</code>. There are several ways of doing this, three of which are
described below:
</p>
<ul>
<li>
Add the <tt>`lisp'</tt> directory from the source distribution to the
<code>load-path</code>. This will allow you to run the <b>BBDB</b> in-place. This
method is recommended for normal users or <b>BBDB</b> developers, especially if
disk usage is an issue. It is <b>not</b> recommended for site-wide
installations.
</li><li>
Link the <tt>`lisp'</tt> directory into your <tt>`site-lisp'</tt> directory. This is
for a site-wide installation, but it is subject to the following caveat. If you
link the <tt>`lisp'</tt> directory into <tt>`site-lisp'</tt>, you will make life more
difficult for yourself down the road, as you will not be able to make changes to
the source directory (new versions, patches, etc) without having an effect on
other users who now depend on it. This directory will automatically be added to
the <code>load-path</code> when Emacs starts.
</li><li>
Make a directory whose sole purpose in life is containing the production copies
of the <b>BBDB</b> source and byte-compiled source files. Either put this
directory under <tt>`site-lisp'</tt> (or put it somewhere else and link it into
<tt>`site-lisp'</tt>). This directory will automatically be added to the
<code>load-path</code> when Emacs starts. This is the best of the three listed here,
as it allows for a degree of separation between the (possibly changing) source
tree and the production code.
</li></ul>
<a name="SEC9"></a>
<h4 class="subsubheading"> texinfo files </h4>
<p>The <tt>`bbdb.info'</tt> file in this directory contains the documentation
for the <b>BBDB</b>. This file should either be linked or copied to a
directory on the default path for the <code>info</code> program or listed in
the <code>INFOPATH</code> environment variable.
</p>
<hr size="6">
<a name="XEmacs-Package"></a>
<a name="SEC10"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC4" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC13" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC2" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.1.3 XEmacs Package Installation </h3>
<p><b>NOTE:</b> XEmacs packages are currently supported only under XEmacs
versions after and including 20.5. If you are not running such a version
of XEmacs, you should install the <b>BBDB</b> according to the instructions
in <a href="#SEC4">Normal User Installation</a>.
</p>
<a name="SEC11"></a>
<h3 class="subheading"> Configuring / Byte Compiling </h3>
<p>The configuration and byte-compilation procedures are the same as in the
Normal User installation. See <a href="#SEC4">Normal User Installation</a>.
</p>
<a name="SEC12"></a>
<h3 class="subheading"> Moving the files to their final destination </h3>
<p>Support is provided for the automatic installation of the <b>BBDB</b> in an
XEmacs package directory. The following <code>configure</code> options are
available for you:
</p>
<dl compact="compact">
<dt> <b><code>--with-package-dir=DIR</code></b></dt>
<dd><p>This option sets the root of the XEmacs package directory. By default,
<tt>`/usr/local/lib/xemacs/site-packages'</tt> is used.
</p></dd>
<dt> <b><code>--with-symlinks</code></b></dt>
<dd><p>If this option is used, the installation will be done by making symbolic
links to the sources instead of copying the files.
</p></dd>
<dt> <b><code>--with-linkpath=PATH</code></b></dt>
<dd><p>Without this option, the installation process uses the output of
<code>pwd</code> to determine the current directory. If something else should
be used, you should provide an alternate name for the BBDB toplevel
directory by using <code>--with-linkpath</code>. If, for example, <code>pwd</code>
returns <tt>`/p/local/elisp/bbdb'</tt>, but you prefer to use
<tt>`/usr/local/elisp/bbdb/...'</tt> for the links, usr this:
<code>configure --with-linkpath=/usr/local/elisp/bbdb</code>. This option is
ignored if <code>--with-symlinks</code> is not used.
</p></dd>
</dl>
<p>To perform the (un)installation, use the command <code>make (un)install-pkg</code>.
This will compile the <tt>`lisp/auto-autoloads.el'</tt> file and will
install the appropriate files to the appropriate places. The final
installation tree will take the following form:
</p>
<dl compact="compact">
<dt> <code>$(PACKAGEDIR)/</code></dt>
<dd><dl compact="compact">
<dt> <code>lisp/</code></dt>
<dd><dl compact="compact">
<dt> <code>bbdb/</code></dt>
<dd><p> <i><b>BBDB</b> lisp source files. This directory contains a copy of all
<code>.el</code> and <code>.elc</code> files from the <tt>`lisp'</tt> source directory,
or is a symbolic link to it.</i>
</p></dd>
</dl>
</dd>
<dt> <code>info/</code></dt>
<dd><dl compact="compact">
<dt> <code>bbdb.info*</code></dt>
<dd><p> <i><b>BBDB</b> documentation files. These are either copies of the info
files from the <tt>`texinfo'</tt> source directory, or are symbolic links to
them.</i>
</p></dd>
</dl>
</dd>
<dt> <code>etc/</code></dt>
<dd><dl compact="compact">
<dt> <code>bbdb/</code></dt>
<dd><dl compact="compact">
<dt> <code>tex/</code></dt>
<dd><p> <i><b>BBDB</b> support files for bbdb-print. This directory contains a
copy of the appropriate files from the <tt>`tex'</tt> source directory, or
is a symbolic link to it.</i>
</p></dd>
<dt> <code>utils/</code></dt>
<dd><p> <i><b>BBDB</b> miscellaneous utilities. This directory contains a copy
of the appropriate files from the <tt>`utils'</tt> source directory, or is a
symbolic link to it.</i>
</p></dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
<hr size="6">
<a name="Initial-Configuration"></a>
<a name="SEC13"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC10" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC19" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC2" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.1.4 Initial Configuration </h3>
<p>The simplest way to configure the <b>BBDB</b> is to include the following
forms in your Emacs configuration file:
</p>
<table><tr><td> </td><td><pre class="example"><code>(require 'bbdb)</code>
<code>(bbdb-initialize)</code>
</pre></td></tr></table>
<p><b>Note:</b> The forms above replace the autoloads needed for previous
versions of the <b>BBDB</b>.
</p>
<p>This will set up the <b>BBDB</b> for basic querying and record manipulation
(the Core Functionality referred to in the Prerequisites section). It
will not enable any of the mailreader-, newsreader- or other
package-specific <b>BBDB</b> features. To enable some or all of these
features, the <code>(bbdb-initialize)</code> form can be enable as shown
below. Alternatively, the features can be enabled manually as described
in the following sections.
</p>
<a name="SEC14"></a>
<h3 class="subheading"> Modifying <code>(bbdb-initialize)</code> </h3>
<p>The <code>bbdb-initialize</code> function can be used to enable the various
package-specific <b>BBDB</b> functions. This feature activation is
accomplished through the passing of symbols which tell the function
which features to activate. These symbols are outlined below and in the
Emacs documentation for the <code>bbdb-initialize</code><a name="DOCF2" href="bbdb_fot.html#FOOT2">(2)</a>
</p>
<a name="SEC15"></a>
<h4 class="subsubheading"> Initialization symbols for mail and news readers </h4>
<dl compact="compact">
<dt> <code>gnus</code></dt>
<dd><p> Initialize support for Gnus<a name="DOCF3" href="bbdb_fot.html#FOOT3">(3)</a>. If you pass the <code>gnus</code> symbol, you should
probably also pass the <code>message</code> symbol.
</p></dd>
<dt> <code>mh-e</code></dt>
<dd><p> Initialize support for the MH-E mail reader.
</p></dd>
<dt> <code>rmail</code></dt>
<dd><p> Initialize support for the RMAIL mail reader.
</p></dd>
<dt> <code>sendmail</code></dt>
<dd><p> Initialize support for sendmail (<kbd>M-x mail</kbd>)
</p></dd>
<dt> <code>vm</code></dt>
<dd><p> Initialize support for the VM mail reader.<a name="DOCF4" href="bbdb_fot.html#FOOT4">(4)</a>
</p></dd>
</dl>
<a name="SEC16"></a>
<h4 class="subsubheading"> Initialization symbols for other packages </h4>
<dl compact="compact">
<dt> <code>message</code></dt>
<dd><p> Initialize support for Message mode (the mail composition program
included with Gnus).
</p></dd>
<dt> <code>reportmail</code></dt>
<dd><p> Initialize support for the Reportmail mail notification package.
</p></dd>
<dt> <code>sc</code></dt>
<dd><p> Initialize support for the Supercite message citation package.
Additional initialization is required for Supercite to work with the
<b>BBDB</b>. See section <a href="#SEC26">Initializing <b>BBDB</b> support for Supercite</a>.
</p></dd>
<dt> <code>w3</code></dt>
<dd><p> Initialize support for Web browsers.
</p></dd>
</dl>
<a name="SEC17"></a>
<h4 class="subsubheading"> Initialization example </h4>
<p>To initialize support for Gnus 5.5, Message mode, Supercite, and Web
browsers, the following forms would be used:
</p>
<table><tr><td> </td><td><pre class="example">(require 'bbdb)
(bbdb-initialize 'gnus 'message 'sc 'w3)
</pre></td></tr></table>
<a name="SEC18"></a>
<h4 class="subsubheading"> Manual initialization </h4>
<p>If your initialization needs exceed those provided by
<code>bbdb-initialize</code>, refer to the following sections for a
description of the procedures necessary for enabling <b>BBDB</b> support
for the packages listed above. The procedures described are the same as
those carried out by the <code>bbdb-initialize</code> function when passed the
appropriate symbols. That is, the procedure listed in the RMAIL Prep
section below is the same as than executed by <code>bbdb-initialize</code>
when the <code>rmail</code> symbol is passed.
</p>
<table class="menu" border="0" cellspacing="0">
<p>Mail and News readers:
</p>
<tr><td align="left" valign="top"><a href="#SEC19">1.1.4.1 Initializing <b>BBDB</b> support for Gnus</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#SEC20">1.1.4.2 Initializing <b>BBDB</b> support for MH-E</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#SEC21">1.1.4.3 Initializing <b>BBDB</b> support for RMAIL</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#SEC22">1.1.4.4 Initializing <b>BBDB</b> support for Sendmail</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#SEC23">1.1.4.5 Initializing <b>BBDB</b> support for VM</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
Other packages:
</pre></th></tr><tr><td align="left" valign="top"><a href="#SEC24">1.1.4.6 Initializing <b>BBDB</b> support for Message mode</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#SEC25">1.1.4.7 Initializing <b>BBDB</b> support for Reportmail</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#SEC26">1.1.4.8 Initializing <b>BBDB</b> support for Supercite</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#SEC27">1.1.4.9 Initializing <b>BBDB</b> support for Web Browsers</a></td><td> </td><td align="left" valign="top"></td></tr>
</table>
<hr size="6">
<a name="Gnus-Prep"></a>
<a name="SEC19"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC13" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC20" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC13" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 1.1.4.1 Initializing <b>BBDB</b> support for Gnus </h4>
<p>To take advantage of the <b>Gnus</b> features of the <b>BBDB</b>, add one of
the following forms to your Emacs configuration file:
</p>
<p>For Gnus 3.14 or older:
</p>
<p><code>(add-hook 'gnus-Startup-hook 'bbdb-insinuate-gnus)</code>
</p>
<p>For Gnus 3.15 or newer:
</p>
<p><code>(add-hook 'gnus-startup-hook 'bbdb-insinuate-gnus)</code>
</p>
<p><code>bbdb-insinuate-gnus</code> adds bindings for the default keys to
<b>Gnus</b> and configures <b>Gnus</b> to notify the <b>BBDB</b> when new
messages are loaded. This notification is required if the <b>BBDB</b> is
to be able to display <b>BBDB</b> entries for messages displayed in
<b>Gnus</b>.
</p>
<hr size="6">
<a name="MH_002dE-Prep"></a>
<a name="SEC20"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC19" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC21" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC13" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 1.1.4.2 Initializing <b>BBDB</b> support for MH-E </h4>
<p>To take advantage of the <b>MH-E</b> features of the <b>BBDB</b>, add the
following form to your Emacs configuration file:
</p>
<table><tr><td> </td><td><pre class="example">(add-hook 'mh-folder-mode-hook 'bbdb-insinuate-mh)
</pre></td></tr></table>
<p><code>bbdb-insinuate-mh</code> adds bindings for the default keys to
<b>MH-E</b> and configures <b>MH-E</b> to notify the <b>BBDB</b> when new
messages are loaded. This notification is required if the <b>BBDB</b> is
to be able to display <b>BBDB</b> entries for messages displayed in
<b>MH-E</b>.
</p>
<hr size="6">
<a name="RMAIL-Prep"></a>
<a name="SEC21"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC20" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC22" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC13" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 1.1.4.3 Initializing <b>BBDB</b> support for RMAIL </h4>
<p>To take advantage of the <b>RMAIL</b> features of the <b>BBDB</b>, add the
following form to your Emacs configuration file:
</p>
<table><tr><td> </td><td><pre class="example">(add-hook 'rmail-mode-hook 'bbdb-insinuate-rmail)
</pre></td></tr></table>
<p><code>bbdb-insinuate-rmail</code> adds bindings for the default keys to
<b>RMAIL</b> and configures <b>RMAIL</b> to notify the <b>BBDB</b> when new
messages are loaded. This notification is required if the <b>BBDB</b> is
to be able to display <b>BBDB</b> entries for messages displayed in
<b>RMAIL</b>.
</p>
<hr size="6">
<a name="Sendmail-Prep"></a>
<a name="SEC22"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC21" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC23" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC13" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 1.1.4.4 Initializing <b>BBDB</b> support for Sendmail </h4>
<p>To take advantage of send-mail-mode (the one invoked with <code>M-x
mail</code>) features of the <b>BBDB</b>, add the following form to your Emacs
configuration file:
</p>
<table><tr><td> </td><td><pre class="example">(add-hook 'mail-setup-hook 'bbdb-insinuate-sendmail)
</pre></td></tr></table>
<p><code>bbdb-insinuate-sendmail</code> enables auto-completion in
send-mail-mode.
</p>
<hr size="6">
<a name="VM-Prep"></a>
<a name="SEC23"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC22" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC24" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC13" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 1.1.4.5 Initializing <b>BBDB</b> support for VM </h4>
<p>To take advantage of the <b>VM</b> features of the <b>BBDB</b>, either add
<code>'vm</code> to the parameters of the <code>(bbdb-initialize)</code> form, or
add the following form to your <tt>`~/.vm'</tt> file:
</p>
<table><tr><td> </td><td><pre class="example"><code>(bbdb-insinuate-vm)</code>
</pre></td></tr></table>
<p><code>bbdb-insinuate-vm</code> adds bindings for the default keys to <b>VM</b>
and configures <b>VM</b> to notify the <b>BBDB</b> when new messages are
loaded. This notification is required if the <b>BBDB</b> is to be able to
display <b>BBDB</b> entries for messages displayed in <b>VM</b>.
</p>
<hr size="6">
<a name="Message-Prep"></a>
<a name="SEC24"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC23" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC25" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC13" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 1.1.4.6 Initializing <b>BBDB</b> support for Message mode </h4>
<p>To allow the <b>BBDB</b> to be used in Message mode, add the following form
to your Emacs initialization file:
</p>
<table><tr><td> </td><td><pre class="example"><code>(bbdb-insinuate-message)</code>
</pre></td></tr></table>
<p><code>bbdb-insinuate-message</code> adds a binding for <kbd>M-TAB</kbd> to Message
mode. This will enable completion of addressees based on <b>BBDB</b>
records. See <a href="#SEC54">Using the <b>BBDB</b> with Message Mode</a> for more details on the operation
of Message mode <b>BBDB</b> record completion.
</p>
<hr size="6">
<a name="Reportmail-Prep"></a>
<a name="SEC25"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC24" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC26" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC13" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 1.1.4.7 Initializing <b>BBDB</b> support for Reportmail </h4>
<p>To allow the Reportmail package to report information from <b>BBDB</b>
records for new mail, add the following form to your Emacs
initialization file:
</p>
<table><tr><td> </td><td><pre class="example"><code>(bbdb-insinuate-reportmail)</code>
</pre></td></tr></table>
<p><code>bbdb-insinuate-reportmail</code> adds to the
<code>display-time-get-field</code> function to allow access to <b>BBDB</b>
records during new mail information display. See <a href="#SEC55">Using the <b>BBDB</b> with Reportmail</a>
for more details on the operation of Reportmail with the <b>BBDB</b>.
</p>
<hr size="6">
<a name="Supercite-Prep"></a>
<a name="SEC26"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC25" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC27" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC13" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 1.1.4.8 Initializing <b>BBDB</b> support for Supercite </h4>
<p>To allow the <b>BBDB</b> to assist in the storage of Supercite citations,
add the following form to your Emacs initialization file:
</p>
<table><tr><td> </td><td><pre class="example"><code>(bbdb-insinuate-sc)</code>
</pre></td></tr></table>
<p><code>bbdb-insinuate-sc</code> adds <b>BBDB</b> functions to two Supercite hooks
- <code>sc-post-hook</code> and <code>sc-attribs-postselect-hook</code>. See
<a href="#SEC56">Using the <b>BBDB</b> with Supercite</a> for more details on the operation of Supercite
citation management using the <b>BBDB</b>.
</p>
<p>Three other Supercite variables must be set/modified to allow the
<b>BBDB</b> to work with it. These variables are not automatically set as
it would be impossible to reliably set them without interfering with
other user customizations. The modifications are:
</p>
<dl compact="compact">
<dt> <code>sc-preferred-attribution-list</code></dt>
<dd><p><code>"sc-consult"</code> should be added to the list. An example
configuration is:
</p>
<table><tr><td> </td><td><pre class="example">(setq sc-preferred-attribution-list
'("sc-lastchoice" "x-attribution" "sc-consult"
"initials" "firstname" "lastname"))
</pre></td></tr></table>
</dd>
<dt> <code>sc-attrib-selection-list</code></dt>
<dd><p>The following form should be added to <code>sc-attrib-selection-list</code>:
</p>
<table><tr><td> </td><td><pre class="example"> '(("sc-from-address"
((".*" . (bbdb/sc-consult-attr
(sc-mail-field "sc-from-address"))))))
</pre></td></tr></table>
</dd>
<dt> <code>sc-mail-glom-frame</code></dt>
<dd><p>The following form should be added to <code>sc-mail-glom-frame</code>, to
allow the retrieval of the name of a person who is a) in the <b>BBDB</b>
and b) has only included their net address in the message in question.
</p>
<table><tr><td> </td><td><pre class="example"> ("^$" (progn (bbdb/sc-default)
(list 'abort '(step . 0))))
</pre></td></tr></table>
<p>An example configuration is as follows:
</p>
<table><tr><td> </td><td><pre class="example"><code>(setq sc-mail-glom-frame</code>
<code> '((begin (setq sc-mail-headers-start (point)))</code>
<code> ("^x-attribution:[ \t]+.*$" (sc-mail-fetch-field t) nil t)</code>
<code> ("^\\S +:.*$" (sc-mail-fetch-field) nil t)</code>
<code> ("^$" (progn (bbdb/sc-default)</code>
<code> (list 'abort '(step . 0))))</code>
<code> ("^[ \t]+" (sc-mail-append-field))</code>
<code> (sc-mail-warn-if-non-rfc822-p (sc-mail-error-in-mail-field))</code>
<code> (end (setq sc-mail-headers-end (point)))))</code>
</pre></td></tr></table></dd>
</dl>
<p>The above is also documented in <tt>`bbdb-sc.el'</tt>. The
<code>bbdb/sc-setup-variables</code> function has been provided as an example for
Supercite variable initialization. Please note that while
<code>bbdb/sc-setup-variables</code> makes every attempt to safely configure
the Supercite variables, it will not always work. Specifically, the
variables <code>sc-attrib-selection-list</code> and <code>sc-mail-glom-frame</code>
will not be overridden if they have already been defined.
</p>
<hr size="6">
<a name="Web-Browser-Prep"></a>
<a name="SEC27"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC26" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC28" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC13" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 1.1.4.9 Initializing <b>BBDB</b> support for Web Browsers </h4>
<p>To allow URLs to be added to <b>BBDB</b> records, add the following form to
your Emacs initialization file:
</p>
<table><tr><td> </td><td><pre class="example"><code>(bbdb-insinuate-w3)</code>
</pre></td></tr></table>
<p><code>bbdb-insinuate-w3</code> adds the definition of <kbd>:</kbd> to the W3
keymap.
</p>
<p>The other <code>bbdb-w3</code> functions, specifically the passing of URLs
from <b>BBDB</b> records to Web browsers, do not require initialization
within the <b>BBDB</b>. They do, however, require the configuration of the
<code>browse-url</code> package so it knows to which Web browser URLs are to
be passed. For more details on the operation of <code>bbdb-w3</code>, see
<a href="#SEC57">Using the <b>BBDB</b> with Web Browsers</a>.
</p>
<hr size="6">
<a name="The-BBDB"></a>
<a name="SEC28"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC27" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC29" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 1.2 The <b>BBDB</b> </h2>
<p>This section discusses the basics of the <b>BBDB</b> - an overview of the
database's layout, and a discussion of the basic <b>BBDB</b> manipulation
commands.
</p>
<p>The database itself lives in a file which is named by the variable
<code>bbdb-file</code>. If this variable is not set, the database is assumed
to be in <tt>`~/.bbdb'</tt>.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC29">1.2.1 Database Fields</a></td><td> </td><td align="left" valign="top"> Description of database fields
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC30">1.2.2 Basic searching commands</a></td><td> </td><td align="left" valign="top"> Basic database searching commands
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC31">1.2.3 Advanced searching commands</a></td><td> </td><td align="left" valign="top"> Advanced database searching commands
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC32">1.2.4 Manual record addition</a></td><td> </td><td align="left" valign="top"> Adding records by hand
</td></tr>
</table>
<hr size="6">
<a name="Database-Fields"></a>
<a name="SEC29"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC28" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC30" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC28" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.2.1 Database Fields </h3>
<p>The database is organized as a set of records, where each record
corresponds to one person or organization. Each record has several
fields, and each field is of one of several types. Below, the built-in
types are listed, followed by a description of how and why some types
can be used more than once in a single record:
<a name="IDX1"></a>
</p>
<table>
<tr><td><p> Type
</p></td><td><p> Description
</p></td><td><p> Notes
</p>
</td></tr>
<tr><td><p> <code>name</code>
</p></td><td><p> The name of this person, or none if the record corresponds to an
organization.
</p></td><td><p> Single value, single instance.
</p>
</td></tr>
<tr><td><p> <code>company</code>
</p></td><td><p> The name of this person's organization, or none.
</p></td><td><p> Single value, single instance.
</p>
</td></tr>
<tr><td><p> <code>AKA</code>
</p></td><td><p> A list of other names for this person.
</p></td><td><p> Multiple values through commas.
</p>
</td></tr>
<tr><td><p> <code>net</code>
</p></td><td><p> A list of this person's network addresses.
</p></td><td><p> Multiple values through commas.
</p>
</td></tr>
<tr><td><p> <code>address</code>
</p></td><td><p> A list of postal (physical) addresses for this person.
</p></td><td><p> Multiple values through multiple occurences.
</p>
</td></tr>
<tr><td><p> <code>phone</code>
</p></td><td><p> A list of telephone numbers for this person.
</p></td><td><p> Multiple values through multiple occurences.
</p>
</td></tr>
<tr><td><p> <code>notes</code>
</p></td><td><p> Random commentary.
</p></td><td><p> Multiple values through multiple occurences.
</p>
</td></tr>
</table>
<p>The field types listed above can be classified into four categories, as
indicated by the comments in the `Notes' column.
</p>
<p>Field types marked as "Single value, single occurrence" may only occur
once per record. Each occurrence can only have a single value. For
example, there will be only one field of type <code>name</code> in a record.
It will be named <code>name</code>, and will contain a single value (the
person's name).
</p>
<p>The types marked as "Multiple values through commas" are essentially the
same as the single value, single occurrence field types, but with one
crucial difference: they can contain multiple values in the form of a
comma-separated list. So, for example, while a <code>name</code> field with a
value of "foo, bar" would be treated as if it contained the single value
"foo, bar", a <code>net</code> field with the same data would be thought of as
having two separate values - "foo" and "bar". As in the single
occurrence, single value field types, there will be only one occurrence
of each "Multiple values through commas" field type, and the occurrence
will have the same name as the type.
</p>
<p>The "Multiple values through multiple occurrences" field type is the
most flexible of the four listed here. There can be multiple
occurrences of each type. This type necessarily does not have the name
restriction imposed by the previous two types. For example, there can
be multiple fields of the <code>address</code> type, none of which have to be
named <code>address</code>. One could be named <code>home</code>, and the other
could be named <code>work</code>.
</p>
<p>Special properties of the <code>notes</code> field type: All user-defined
fields that don't fit into the other predefined field types
(<code>name</code>, <code>company</code>, <code>AKA</code>, <code>net</code>, <code>address</code>,
and <code>phone</code>) will be created as a <code>notes</code>-type field. In
addition, several of the user-defined field names are "special". That
is, the <b>BBDB</b> treats the values of these "special" fields differently
than it does other user-defined fields. The "special" fields are:
</p>
<a name="IDX2"></a>
<dl compact="compact">
<dt> <code>attribution</code></dt>
<dd><a name="IDX3"></a>
<p><i>(Available only when the Supercite-specific <b>BBDB</b> functions have been
enabled)</i> Used for the storage of Supercite attributions. For initialization
details, see <a href="#SEC26">Initializing <b>BBDB</b> support for Supercite</a>. For usage details, see <a href="#SEC56">Using the <b>BBDB</b> with Supercite</a>. The field used can be changed by changing the value of
<code>bbdb/sc-attribution-field</code>.
</p></dd>
<dt> <code>aka</code></dt>
<dd><p>Used to store non-primary names associated with a given record.
</p></dd>
<dt> <code>face</code></dt>
<dd><p><i>(XEmacs only)</i> Used for the storage of image data. This data is to be
in the format output by <code>compface</code>, and commonly found in
<code>X-Face:</code> headers in messages. If face support has been compiled
into XEmacs, the image contained in the <code>face</code> header will be
displayed when the record is viewed.
</p></dd>
<dt> <code>finger-host</code></dt>
<dd><a name="IDX4"></a>
<p>Address used in place of the listed net address for fingering the entity
indicated by the record. See section <a href="#SEC33">BBDB Mode</a>. The field used can be changed by
changing the value of <code>bbdb-finger-host-field</code>.
</p></dd>
<dt> <code>gnus-score</code></dt>
<dd><a name="IDX5"></a>
<p><b>Gnus</b> scoring adjustment for this person. For initialization details, see
<a href="#SEC19">Initializing <b>BBDB</b> support for Gnus</a>. For usage details, see <a href="#SEC42">Gnus-specific Features</a>. The field used
can be changed by changing the value of <code>bbdb/gnus-score-field</code>.
</p></dd>
<dt> <code>mail-alias</code></dt>
<dd><a name="IDX6"></a>
<p>Value used instead of <code>name</code> for completion. See section <a href="#SEC39">Mail Sending Interfaces</a>.
</p></dd>
<dt> <code>mail-name</code></dt>
<dd><p><i>(Available only when the Reportmail-specific <b>BBDB</b> functions have been
enabled)</i> Used for the storage of non-default names to be used in the
reporting of new mail by Reportmail. For initialization details,
see <a href="#SEC25">Initializing <b>BBDB</b> support for Reportmail</a>. For usage details, see <a href="#SEC55">Using the <b>BBDB</b> with Reportmail</a>.
</p></dd>
<dt> <code>mark-char</code></dt>
<dd><p>The field containing the character to be used for marking a given poster
in the Gnus Summary Buffer. For usage details, see <a href="#SEC44">Gnus Summary Buffer Enhancements</a>.
</p></dd>
<dt> <code>tex-name</code></dt>
<dd><a name="IDX7"></a>
<a name="IDX8"></a>
<p>The value of this field is used in place of the <code>name</code> field when
printing the database using <code>bbdb-print</code>. See section <a href="#SEC64"><code>bbdb-print</code></a>.
</p></dd>
<dt> <code>www</code></dt>
<dd><p>This field contains the URL associated with the <b>BBDB</b> record. Common uses
are with <code>bbdb-snarf</code> (see section <a href="#SEC65"><code>bbdb-snarf</code></a>) and the <b>BBDB</b>/Web Browser
functionality (for initialization details, see <a href="#SEC27">Initializing <b>BBDB</b> support for Web Browsers</a>. For
usage details, see <a href="#SEC57">Using the <b>BBDB</b> with Web Browsers</a>).
</p></dd>
</dl>
<hr size="6">
<a name="Basic-Searching"></a>
<a name="SEC30"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC29" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC31" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC28" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.2.2 Basic searching commands </h3>
<p>You can list the contents of the database with the command
<kbd>M-x bbdb</kbd>. You will be prompted for a regular expression, and all
records which match that regexp in the name, company, network address,
or any notes fields will be displayed.
<a name="IDX9"></a>
<a name="IDX10"></a>
<a name="IDX11"></a>
<a name="IDX12"></a>
<a name="IDX13"></a>
<a name="IDX14"></a>
</p>
<p>A narrower search may be made by using the commands <kbd>bbdb-name</kbd>,
<kbd>bbdb-company,</kbd> <kbd>bbdb-net,</kbd> or <kbd>bbdb-notes</kbd>. These commands
limit their searches to the name, company, email address, and notes
fields, respectively. If these commands are given a prefix argument,
the listing displayed will be one line per entry; otherwise, the full
database entry will be shown on multiple lines.
</p>
<p>The functions described above are predefined to certain keys in the
<code>*BBDB*</code> buffer. See section <a href="#SEC33">BBDB Mode</a>. for more details.
</p>
<a name="IDX15"></a>
<p>The <code>bbdb-notes</code> command will prompt for the notes field to search
(<kbd>RET</kbd> for all). In this way you can limit your searches to the
contents of one particular user-defined notes field. (You can add
user-defined fields with the <code>bbdb-insert-new-field</code> command;
See section <a href="#SEC33">BBDB Mode</a>.)
</p>
<a name="IDX16"></a>
<a name="IDX17"></a>
<hr size="6">
<a name="Advanced-Searching"></a>
<a name="SEC31"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC30" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC32" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC28" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.2.3 Advanced searching commands </h3>
<p>The following functions can be used to search for records based on
creation and/or modification dates. These functions will match records
that have <code>timestamp</code> and/or <code>creation-date</code> fields (as
appropriate. See section <a href="#SEC61">Predefined Hooks</a>. for more information on these
fields, which are created by default.
</p>
<dl compact="compact">
<dd><a name="IDX18"></a>
</dd>
<dt> <code>bbdb-timestamp-older</code></dt>
<dd><p>Display all records modified before a given date. If this function is
called interactively, it will prompt for a date. If it is being called
non-interactively, the date should be provided as a string in
<samp>`yyyy-mm-dd'</samp> format.
</p>
<a name="IDX19"></a>
</dd>
<dt> <code>bbdb-timestamp-newer</code></dt>
<dd><p>Display all records modified after a given date. If this function is
called interactively, it will prompt for a date. If it is being called
non-interactively, the date should be provided as a string in
<samp>`yyyy-mm-dd'</samp> format.
</p>
<a name="IDX20"></a>
</dd>
<dt> <code>bbdb-creation-older</code></dt>
<dd><p>Display all records created before a given date. If this function is
called interactively, it will prompt for a date. If it is being called
non-interactively, the date should be provided as a string in
<samp>`yyyy-mm-dd'</samp> format.
</p>
<a name="IDX21"></a>
</dd>
<dt> <code>bbdb-creation-newer</code></dt>
<dd><p>Display all records created after a given date. If this function is
called interactively, it will prompt for a date. If it is being called
non-interactively, the date should be provided as a string in
<samp>`yyyy-mm-dd'</samp> format.
</p>
<a name="IDX22"></a>
</dd>
<dt> <code>bbdb-creation-no-change</code></dt>
<dd><p>Display all records that have not been changed since creation.
</p></dd>
</dl>
<hr size="6">
<a name="Manual-Record-Addition"></a>
<a name="SEC32"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC31" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC33" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC28" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.2.4 Manual record addition </h3>
<p>There are several ways to add new entries to the Insidious Big Brother
Database; the most straightforward is to use <kbd>M-x bbdb-create</kbd>,
which will prompt you for all relevant information. However, the
easiest way is to allow them to be added automatically by one of the
mail or news-reading interfaces (See section <a href="#SEC36">Interfaces</a>.).
</p>
<a name="IDX23"></a>
<a name="IDX24"></a>
<p>There is also <kbd>bbdb-snarf</kbd> (See section <a href="#SEC65"><code>bbdb-snarf</code></a>), which will
attempt to create a record from a text block. Note that this depends
on particular formatting and may not do exactly what you want.
</p>
<hr size="6">
<a name="BBDB-Mode"></a>
<a name="SEC33"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC32" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC34" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 1.3 BBDB Mode </h2>
<hr size="6">
<a name="SEC34"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC33" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC35" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC33" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.3.1 Functions bound to keys in <b>BBDB</b> Mode </h3>
<p>When the <samp>`*BBDB*'</samp> buffer is active (either summoned by one of the
commands in the previous section [See section <a href="#SEC28">The <b>BBDB</b></a>.] or by your mail
or news program), a variety of commands become available for database
manipulation. Some of the commands listed below take numeric arguments.
These arguments can be generated by entering the number before pressing
the key(s) corresponding to the desired command. The output (if any) of
the listed commands will be displayed in the <samp>`*BBDB*'</samp> buffer, and
can be navigated through using the usual cursor motion commands.
<a name="IDX25"></a>
<a name="IDX26"></a>
</p>
<dl compact="compact">
<dt> <kbd>e</kbd></dt>
<dd><a name="IDX27"></a>
<a name="IDX28"></a>
<a name="IDX29"></a>
<p>(<code>bbdb-edit-current-field</code>) Edit the field on the current line. If
the cursor is in the middle of a multi-line field, such as an address or
comments section, then the entire field is edited, not just the current
line.
</p>
</dd>
<dt> <kbd>;</kbd></dt>
<dd><a name="IDX30"></a>
<p>(<code>bbdb-edit-notes</code>) A shortcut for editing the <var>notes</var> field.
</p>
</dd>
<dt> <kbd>d, C-k</kbd></dt>
<dd><a name="IDX31"></a>
<a name="IDX32"></a>
<a name="IDX33"></a>
<p>(<code>bbdb-delete-current-field-or-record</code>) Delete the field on the
current line. If the current line is the first line of a record, the
<b>BBDB</b> will, after prompting the user, delete the entire record from
the database. This may also be applied to multiple records at once by
<kbd>*</kbd>.
</p>
</dd>
<dt> <kbd>C-o</kbd></dt>
<dd><a name="IDX34"></a>
<a name="IDX35"></a>
<a name="IDX36"></a>
<a name="IDX37"></a>
<p>(<code>bbdb-insert-new-field</code>) Inserts a new field into the current
record. You are prompted (with completion) for the type of field to
insert (<b>phone</b>, <b>address</b>, <b>notes</b>, etc); if the string you type
is not a known field type, you will be asked whether to add a new field
with the entered name of type <code>notes</code>.
</p>
<a name="IDX38"></a>
<a name="IDX39"></a>
<a name="IDX40"></a>
<p>If you are inserting a new phone-number field, you can control whether
it is a North American or European phone number by providing a prefix
argument. A prefix arg of <kbd>^U</kbd> means it's to be a euronumber, and
any other prefix arg means it's to be a a structured North American
number. If no prefix argument is supplied, the style used is controlled
by the variable <code>bbdb-north-american-phone-numbers-p</code>.
</p>
</dd>
<dt> <kbd>C-x C-t</kbd></dt>
<dd><a name="IDX41"></a>
<a name="IDX42"></a>
<a name="IDX43"></a>
<p>(<code>bbdb-transpose-fields</code>) This is like the <code>transpose-lines</code>
command, but it is for <b>BBDB</b> fields. If the cursor is on a field of
a <b>BBDB</b> record, that field and the previous field will be
transposed.
</p>
<p>With non-zero numeric argument <var>ARG</var>, the previous field is moved
past <var>ARG</var> fields. With argument 0, the field indicated by
<i>point</i> is interchanged with the one indicated by <i>mark</i>.
</p>
<p>Both fields must be in the same record, and must be of the same basic type
(that is, you can use this command to change the order in which phone-number
fields are listed, but you can't use it to make an address appear before a
phone number; the order of field types is fixed.)
</p>
</dd>
<dt> <kbd>n, p</kbd></dt>
<dd><a name="IDX44"></a>
<a name="IDX45"></a>
<p>(<code>bbdb-next-record</code>, <code>bbdb-prev-record</code>) Move to the next and
previous displayed record, respectively.
</p>
</dd>
<dt> <kbd>t</kbd></dt>
<dd><a name="IDX46"></a>
<p>(<code>bbdb-toggle-records-display-layout</code>) Toggles the display layout of a
record. With a numeric argument
of 0, the current record will be made displayed in one line layout; with any
other argument, the current record will be shown in multi-line layout.
</p>
<p>If <kbd>*t</kbd> is used instead of simply <kbd>t</kbd>, then the state of all
records will be changed instead of just the one at point. In this case,
a numeric argument of 0 means that all records will unconditionally be
made one-line layout; any other numeric argument means that all of the records
will unconditionally be shown expanded; and no numeric argument means
that the records are made to be in the opposite state of the record
under point.
</p>
</dd>
<dt> <kbd>T</kbd></dt>
<dd><a name="IDX47"></a>
<p>(<code>bbdb-display-record-completely</code>)
Show all the fields of the current record.
The display layout `full-multi-line' is used for this.
</p>
</dd>
<dt> <kbd>o</kbd></dt>
<dd><a name="IDX48"></a>
<p>(<code>bbdb-omit-record</code>) Removes the current record from the display,
but does not delete it from the database; it merely makes it seem as if
the most recent search had not matched this record. With a numeric
argument, omit the next N records. With a negative argument, go
backwards.
</p>
</dd>
<dt> <kbd>m</kbd></dt>
<dd><a name="IDX49"></a>
<a name="IDX50"></a>
<a name="IDX51"></a>
<p>(<code>bbdb-send-mail</code>) Begin composing mail to the person represented
by the current record. The first email address is used. Normally, the
mail-sending package which is used is determined by which mail-reading
package is loaded; that is, if <b>MH-E</b> is loaded, then <code>mh-send</code>
will be used; if <b>VM</b> is loaded, then <code>vm-mail</code> is used; if
<b>message</b> is loaded, then it is used; otherwise, <code>mail</code> is used.
You can override this by setting the variable
<code>bbdb-send-mail-style</code> to one of the symbols <code>vm</code>, <code>mh</code>,
<code>message</code>, or <code>mail</code>.
</p>
<p>If <kbd>*m</kbd> is used instead of simply <kbd>m</kbd>, then mail will be sent to
all of the folks listed in the <samp>`*BBDB*'</samp> buffer instead of just the
person under point.
</p>
<p>This function does not at present use the facility provided by
<code>compose-mail</code> and <code>mail-user-agent</code>. In a future version of
the <b>BBDB</b>, it will.
</p>
</dd>
<dt> <kbd>s, C-x C-s</kbd></dt>
<dd><a name="IDX52"></a>
<a name="IDX53"></a>
<p>(<code>bbdb-save-db</code>) Saves the <b>BBDB</b> file to disk.
</p>
</dd>
<dt> <kbd>r</kbd></dt>
<dd><a name="IDX54"></a>
<a name="IDX55"></a>
<a name="IDX56"></a>
<p>(<code>bbdb-refile-record</code>) Merge the current record into some other record;
that is, delete the record under point after copying all of the data
within it into some other record. this is useful if you realize that
somehow a redundant record has gotten into the database, and you want to
merge it with another.
</p>
<p>If both records have names and/or companies, you are asked which to use.
Phone numbers, addresses, and network addresses are simply concatenated.
The first record is the record under the point; the second is prompted
for. Completion behavior is as dictated by the variable
<code>bbdb-completion-type</code>.
</p>
</dd>
<dt> <kbd>M-d</kbd></dt>
<dd><a name="IDX57"></a>
<a name="IDX58"></a>
<p>(<code>bbdb-dial</code>) This command will attempt to dial the phone number
currently at point, or if point is at the start of a record, the first
phone number in the record. An extension, if present, is disregarded.
</p>
<p>The method of dialling is controlled by <code>bbdb-modem-dial</code>. If this
variable is nil, the <b>BBDB</b> will play touchtones corresponding to the
number to be dialled. Otherwise, this variable is treated as a modem
command string to be prepended to the number prior to feeding it to
<code>bbdb-modem-device</code>.
</p>
<p>The <b>BBDB</b> plays touchtones using <code>bbdb-sound-player</code> to play the
sounds and the elements of <code>bbdb-sound-files</code> as the audio to be
played. The first ten elements of <code>bbdb-sound-files</code> correspond to
the touchtones for the digits <samp>`0'</samp> to <samp>`9'</samp>, while the eleventh
and twelfth elements correspond to <samp>`#'</samp> and <samp>`*'</samp>
respectively. The default configuration assumes a Solaris[tm]
installation with the demonstration sound files in
<code>/usr/demo/SOUND/sounds</code>.
</p>
<p>The actual number dialled depends on the following variables:
</p>
<dl compact="compact">
<dt> <code>bbdb-dial-local-prefix-alist</code> </dt>
<dd><a name="IDX59"></a>
<p>This is a list of (SEXPR REPLACEMENT) pairs. SEXPR is evaluated to
produce a regular expression which is then applied to the number. If it
matches, whatever it matches is replaced by REPLACEMENT. The match and
replace is performed using each item in the list that matches, in
sequence, so that the output from one item may become input to another.
The default value for this variable is to remove
<code>(bbdb-default-area-code)</code> (i.e. the value of that variable, in
parenthesis) from the start of the number to be dialled.
</p>
<p><b>Note:</b> If this procedure produces a transformed number then no
further modifications (such as prefix additions, below) will be made to
the number before dialling.
</p>
<p>Using a prefix argument to <code>bbdb-dial</code> disables the processing of
this variable. The other modifiers, below, are not affected by
this.
</p>
</dd>
<dt> <code>bbdb-dial-local-prefix</code></dt>
<dd><a name="IDX60"></a>
<p>If the number to be dialled starts with a zero, it is deemed to be a
local number, and <code>bbdb-dial-local-prefix</code> is prepended to it (see
note above concerning <code>bbdb-dial-local-prefix-alist</code> processing,
however).
</p>
</dd>
<dt> <code>bbdb-dial-long-distance-prefix</code></dt>
<dd><a name="IDX61"></a>
<p>If the number to be dialled starts with a plus sign (+), it is deemed to
be a long distance number, and <code>bbdb-dial-long-distance-prefix</code> is
prepended to it (see note above concerning
<code>bbdb-dial-local-prefix-alist</code> processing, however).
</p>
</dd>
</dl>
</dd>
<dt> <kbd>f</kbd></dt>
<dd><a name="IDX62"></a>
<a name="IDX63"></a>
<p>(<code>bbdb-finger</code>) This command fingers the network address of a
<b>BBDB</b> record. If this command is executed from the <samp>`*BBDB*'</samp> buffer,
it fingers the network address of the record which is at point; otherwise,
it prompts in the minibuffer (with completion) for a user to finger. With a
numeric prefix argument, it fingers the <i>N</i>th network address of the
current record; with a prefix argument of <kbd>^U</kbd>, it fingers all of them.
The <samp>`*finger*'</samp> buffer is filled asynchronously, meaning that you don't
have to wait around for it to finish; but fingering another user before
the first finger has finished could have unpredictable results.
</p>
<p>If this command is executed from the <samp>`*BBDB*'</samp> buffer, it may be prefixed
with <kbd>*</kbd> (as in <kbd>*f</kbd> instead of simply <kbd>f</kbd>), meaning to
finger all of the users currently listed instead of just the one under
point. The numeric prefix argument has the same interpretation.
</p>
<a name="IDX64"></a>
<p>You can define a special network address to "finger" by defining a field
<code>finger-host</code>. The name of the field to be fingered can be changed
by setting <code>bbdb-finger-host-field</code>.
</p>
</dd>
<dt> <kbd>q</kbd></dt>
<dd><a name="IDX65"></a>
<p>(<code>bbdb-bury-buffer</code>) Hides the <samp>`*BBDB*'</samp> buffer. <b>Note:</b>
This command does <b>not</b> kill the <samp>`*BBDB*'</samp> buffer.
</p>
</dd>
<dt> <kbd>?</kbd></dt>
<dd><a name="IDX66"></a>
<p>(<code>bbdb-help</code>) This displays a one-line help message in the
minibuffer, showing some of the most common bbdb-mode commands.
</p>
</dd>
<dt> <kbd>i</kbd></dt>
<dd><a name="IDX67"></a>
<p>(<code>bbdb-info</code>) This documentation is displayed. Please note that
either <tt>`bbdb'</tt> or <tt>`bbdb.info'</tt> must be installed in one of the
info directories known to Emacs for this command to work.
</p>
<dl compact="compact">
<dt> <code>bbdb-info-file</code></dt>
<dd><a name="IDX68"></a>
<p>If this documentation is not installed in the standard Info directory,
then you should set this variable to the name of the texinfo-formatted
version of this file; the <code>bbdb-info</code> command will use this file
instead.
</p></dd>
</dl>
</dd>
<dt> <kbd>W</kbd></dt>
<dd><a name="IDX69"></a>
<a name="IDX70"></a>
<p>(<code>bbdb-www</code>) Displays the Web page listed in the <code>www</code> field
of the current record. See section <a href="#SEC57">Using the <b>BBDB</b> with Web Browsers</a>.
</p>
</dd>
<dt> <kbd>P</kbd></dt>
<dd><a name="IDX71"></a>
<a name="IDX72"></a>
<p>(<code>bbdb-print</code>) Creates a TeX file that contains a pretty-printed version
of <b>BBDB</b> records. If prefixed by <kbd>*</kbd>, only the records currently
displayed will print. See section <a href="#SEC64"><code>bbdb-print</code></a>.
</p>
</dd>
<dt> <kbd>h</kbd></dt>
<dd><a name="IDX73"></a>
<p>Moves point to another window via the <code>other-window</code> function.
</p>
</dd>
<dt> <kbd>c</kbd></dt>
<dd><a name="IDX74"></a>
<a name="IDX75"></a>
<p>(<code>bbdb-create</code>) Create a new database record from information
supplied by the user.
</p>
</dd>
<dt> <kbd>C</kbd></dt>
<dd><a name="IDX76"></a>
<a name="IDX77"></a>
<p>(<code>bbdb-changed</code>) Display all records that have been changed since
the last time the database was saved.
</p>
</dd>
<dt> <kbd>b</kbd></dt>
<dd><a name="IDX78"></a>
<a name="IDX79"></a>
<p>(<code>bbdb</code>) Begin a new database search. The results of the new
search will be displayed in place of the results of the old search.
</p>
</dd>
<dt> <kbd>S a, S c, S o, S n</kbd></dt>
<dd><a name="IDX80"></a>
<a name="IDX81"></a>
<a name="IDX82"></a>
<a name="IDX83"></a>
<a name="IDX84"></a>
<p>(<code>bbdb-net</code>, <code>bbdb-company</code>, <code>bbdb-notes</code>,
<code>bbdb-name</code>)<br>
Begin a new database search. This search will be
limited to the net address, company, notes, or name fields,
respectively, of database records. See section <a href="#SEC30">Basic searching commands</a>. for more
details.
</p>
</dd>
<dt> <kbd>*</kbd></dt>
<dd><a name="IDX85"></a>
<p><code>bbdb-append-records</code> will make the next display/search
command to append its results to the BBDB buffer instead of replacing its
content.
</p>
<p>With an prefix arg (C-u) toggle between always append and no append.
With an prefix arg that is a positive number append will be enabled for that
many times.
With any other argument append will be enabled once."
</p>
</dd>
</dl>
<hr size="6">
<a name="SEC35"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC34" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC36" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC33" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.3.2 Other database manipulation functions </h3>
<dl compact="compact">
<dd><a name="IDX86"></a>
</dd>
<dt> <code>bbdb-kill-older</code></dt>
<dd><p>If called interactively (or with a single argument - a date in
<samp>`yyyy-mm-dd'</samp> format), it will kill all records that were last
modified before the given date as determined by the <code>timestamp</code>
field. See section <a href="#SEC61">Predefined Hooks</a>. If called non-interactively with a
date (in <samp>`yyyy-mm-dd'</samp> format), a comparison function and an action
function, the comparison function is applied to the <code>timestamp</code>
field of all records, and the action function applied to those for whom
the comparison function returns true. If <samp>`nil'</samp> is supplied as the
comparison function, <code>string-lessp</code> is used.
</p>
</dd>
</dl>
<hr size="6">
<a name="Interfaces"></a>
<a name="SEC36"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC35" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC37" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 1.4 Interfaces </h2>
<p>The <b>BBDB</b> interfaces itself with several message-handling packages, but
certain parameters control its behavior depending on whether it is
being used from within a mail reader or a news reader.
</p>
<p>In all of these packages, two new keybindings will be added:
</p>
<dl compact="compact">
<dt> <kbd>:</kbd></dt>
<dd><a name="IDX87"></a>
<a name="IDX88"></a>
<a name="IDX89"></a>
<a name="IDX90"></a>
<a name="IDX91"></a>
<p>(<code>bbdb/<i>package</i>-show-sender</code>) Displays the <b>BBDB</b> entry corresponding
to the author of the current message. If there is none, you will be
asked whether to create one. The function called is
<code>bbdb/<i>package</i>-show-sender</code>, where <code><i>package</i></code> is either
<code>gnus</code>, <code>mh</code>, <code>rmail</code>, or <code>vm</code>, depending on the
mail or news program being used when the command is invoked.
</p>
</dd>
<dt> <kbd>;</kbd></dt>
<dd><a name="IDX92"></a>
<a name="IDX93"></a>
<a name="IDX94"></a>
<a name="IDX95"></a>
<a name="IDX96"></a>
<p>(<code>bbdb/<i>package</i>-annotate-sender</code>) Lets you edit the <samp>`notes'</samp>
field of the <b>BBDB</b> record corresponding to the sender of the current
message. If there is no record for the current author, you will be
asked whether to create one. The function called is
<code>bbdb/<i>package</i>-annotate-sender</code>, where <code><i>package</i></code> is
either <code>gnus</code>, <code>mh</code>, <code>rmail</code>, or <code>vm</code>, depending on
the mail or news program being used when the command is invoked.
</p></dd>
</dl>
<p>These keybindings (and several other features) will not be
available unless you call the appropriate "insinuation"
function; See section <a href="#SEC2">Installation</a>.
</p>
<p>It is possible to configure <b>BBDB</b> so that it automatically creates a
record when it sees a message from a person who is not in the database.
It is also possible to have text automatically added to the notes field
of the corresponding record depending on the contents of the message
headers. See section <a href="#SEC60">Customization Hooks</a>.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC37">1.4.1 Mail Reading Interfaces</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#SEC38">1.4.2 News Reading Interfaces</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#SEC39">1.4.3 Mail Sending Interfaces</a></td><td> </td><td align="left" valign="top"></td></tr>
</table>
<hr size="6">
<a name="Mail-Reading-Interfaces"></a>
<a name="SEC37"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC36" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC38" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC36" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.4.1 Mail Reading Interfaces </h3>
<p>There are BBDB interfaces for the following mail readers:
</p>
<ul>
<li>
<b>Gnus</b>, a news- and email- reader written by Lars Magne Ingebrigtsen
(based on <b>GNUS</b> by Mansanobu Umeda).
</li><li>
<b>MH-E</b>, the Emacs interface to <b>Mail Handler</b> (<b>MH</b>), from the
standard emacs library, but packaged separately from XEmacs since
version 20.4.
</li><li>
<b>RMAIL</b>, from the standard emacs library (packaged separately for
XEmacs users as of 20.4);
</li><li>
<b>View Mail</b>, by Kyle Jones, version 5.31 or newer;
</li></ul>
<hr size="6">
<a name="News-Reading-Interfaces"></a>
<a name="SEC38"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC37" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC39" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC36" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.4.2 News Reading Interfaces </h3>
<p>There are BBDB interfaces for the following news readers:
</p>
<ul>
<li>
<b>GNUS</b>, a newsreader written by Masanobu Umeda.
</li><li>
<b>Gnus</b>, the modern news- and email-reading incarnation of <b>GNUS</b>.
<b>Gnus</b> is written by Lars Magne Ingebrigtsen.
</li></ul>
<hr size="6">
<a name="Mail-Sending-Interfaces"></a>
<a name="SEC39"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC38" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC40" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC36" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.4.3 Mail Sending Interfaces </h3>
<p>When sending mail, the keystroke <kbd>M-TAB</kbd> is bound to the
function <code>bbdb-complete-name</code>. This will take the string that
you have typed (from point back to the preceding colon, comma, or
the beginning of the line) and will complete that against the
contents of the database. What you have typed may be an initial
subsequence of a person's full name or network address; if it
completes ambiguously, then what you have typed will be replaced
with the common portion of the matches. Typing <kbd>M-TAB</kbd> again will
show a list of possible completions. If it completes unambiguously,
then an address will be inserted. The variable
<code>bbdb-completion-type</code> controls whether completion is done on real
names, or network addresses, or both. The address inserted is normally
of the form <code>User Name <email-address></code>; however, if
<code>User Name</code> has an address of the form
<code><user.name@somedomain></code>, only the <code><email-address></code> portion
is inserted. This can be overridden by setting
<code>bbdb-dwim-net-address-allow-redundancy</code> to <code>t</code>.
</p>
<p>This binding is automatically set by the various insinuation functions
documented earlier in this manual. (See section <a href="#SEC13">Initial Configuration</a>.)
Briefly, the forms for these functions are:
</p>
<dl compact="compact">
<dt> <b>Gnus</b></dt>
<dd><p><code>(add-hook 'gnus-Startup-hook 'bbdb-insinuate-gnus)</code> <i>for Gnus 3.14 or older</i><br>
<code>(add-hook 'gnus-startup-hook 'bbdb-insinuate-gnus)</code> <i>for Gnus 3.15 or newer</i>
</p></dd>
<dt> <b>MH-E</b></dt>
<dd><p><code>(add-hook 'mh-folder-mode-hook 'bbdb-insinuate-mh)</code>
</p></dd>
<dt> <b>RMAIL</b></dt>
<dd><p><code>(add-hook 'rmail-mode-hook 'bbdb-insinuate-rmail)</code>
</p></dd>
<dt> <b>sendmail</b></dt>
<dd><p><code>(add-hook 'mail-setup-hook 'bbdb-insinuate-sendmail)</code>
</p></dd>
<dt> <b>VM</b></dt>
<dd><p><code>(bbdb-insinuate-vm)</code> <i>Add to <tt>`~/.vm'</tt> file</i>
</p></dd>
</dl>
<p>The above forms should be added to your Emacs initialization file,
except where otherwise noted.
</p>
<p>You can control what "real name" is inserted with the
<code>mail-alias</code> field: if a record has a <code>mail-alias</code>
field, then that is used instead of their <code>name</code> field.
</p>
<a name="IDX97"></a>
<p>If the variable <code>bbdb-completion-display-record</code> is true (the
default) then when you successfully complete an address with
<kbd>M-TAB</kbd>, the corresponding record will be appended to
the <samp>`*BBDB*'</samp> buffer. The buffer will not be displayed if it
is not already visible, but the record will be displayed there.
</p>
<a name="IDX98"></a>
<a name="IDX99"></a>
<p>When sending mail, you can use the command <code>bbdb-yank-addresses</code>
to CC the current message to the people currently displayed in
the <samp>`*BBDB*'</samp> buffer. This is useful if you are in the midst of
sending or replying to a message, and you decide to add some recipients.
You can use one of the <kbd>M-x bbdb</kbd> commands to display the set of
people that you want to CC the message to, and then execute this command
to add them to the list.
</p>
<hr size="6">
<a name="SEC40"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC39" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC41" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC36" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="unnumberedsubsec"> Mailing Lists and Mail Aliases </h3>
<p>If you are using Jamie Zawinski's <tt>`mail-abbrevs.el'</tt> package, which
uses the word-abbrev mechanism for mail aliases, then you can store your
mail aliases in the BBDB instead of duplicating the information
elsewhere.
</p>
<p>If you want a mail alias to be defined for a person, simply add a
<code>mail-alias</code> field to their record. You may have multiple aliases
for the same person; simply separate them with commas.
</p>
<p>For convenience there is the function <code>bbdb-add-or-remove-mail-alias</code>
bound to <kbd>a</kbd> which adds an alias to one or multiple records when prefixed
by a <kbd>*</kbd>. Called with a prefix argument <kbd>C-u</kbd> it will remove
the given alias.
</p>
<p>If more than one person has the same mail-alias, then that alias expands
to the addresses of all of those people; in this way you can maintain
mailing lists within the BBDB.
</p>
<p>When you want to group aliases as in <code>.mailrc</code> you may just
retained the group aliases in your <code>.mailrc</code>.
</p>
<p>To actually define the aliases which are stored in the BBDB, call the
function <code>bbdb-define-all-aliases</code> from your
<code>mail-setup-hook</code> (or <code>message-setup-hook</code> if you use
Message mode coming with Gnus). This will search the database, and
call <code>define-mail-alias</code> to define each of the resulting
aliases.
</p>
<hr size="6">
<a name="Reader_002dspecific-Features"></a>
<a name="SEC41"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC40" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC42" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 1.5 Reader-specific Features </h2>
<p>There are features of the <b>BBDB</b> that are available only for specific
mail- and news-readers. These features are described below.
</p>
<p>The headers which are parsed for email addresses and what records are
displayed can be controlled by the following variables:
<a name="IDX100"></a>
<a name="IDX101"></a>
<a name="IDX102"></a>
<a name="IDX103"></a>
<code>bbdb-get-addresses-from-headers</code> controls which headers are parsed
for sender addresses when calling the show-sender function of your MUA.
<code>bbdb-get-addresses-to-headers</code> controls which headers are parsed
for recipients addresses when calling the show-all-recipients function
of your MUA. When using the pop up feature it will search for the
addresses in <code>bbdb-get-addresses-headers</code> and display them. By
default it will list only the first address, but by setting
<code>bbdb-get-only-first-address-p</code> to <code>nil</code> one will will get
records for all addresses.
</p>
<p>If there is no MUA specific variable for ignoring certain addresses then
those addresses matching <code>bbdb-user-mail-names</code> will be ignored.
</p>
<p><b>BBDB</b> adds the bindings <kbd>:</kbd> for showing all senders and <kbd>;</kbd>
for editing the notes of the sender.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC42">1.5.1 Gnus-specific Features</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#SEC48">1.5.2 VM-specific features</a></td><td> </td><td align="left" valign="top"> VM-specific Features
</td></tr>
</table>
<hr size="6">
<a name="Gnus-Features"></a>
<a name="SEC42"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC41" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC43" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC41" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.5.1 Gnus-specific Features </h3>
<p>The <b>BBDB</b> can be used to provide score information, or to integrate
database information into the <b>Gnus</b> Summary buffer or the <b>GNUS</b>
Subject List.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC43">1.5.1.1 Scoring</a></td><td> </td><td align="left" valign="top"> Store score adjustments in the <b>BBDB</b>
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC44">1.5.1.2 Gnus Summary Buffer Enhancements</a></td><td> </td><td align="left" valign="top"> <b>BBDB</b> information in the Summary buffer
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC47">1.5.1.3 GNUS Summary Buffer Enhancements</a></td><td> </td><td align="left" valign="top"> <b>BBDB</b> information in the Subject List
</td></tr>
</table>
<hr size="6">
<a name="Gnus-Scoring"></a>
<a name="SEC43"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC42" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC44" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC42" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 1.5.1.1 Scoring </h4>
<p>The <b>BBDB</b> can provide scoring information to <b>Gnus</b> in one of two
ways.
</p>
<ol>
<li>
Articles whose authors appear in the <b>BBDB</b> and who have
<code>gnus-score</code> fields will have their scores adjusted by the value
contained in that field.
</li><li>
Articles whose authors appear in the <b>BBDB</b> but who do not have
<code>gnus-score</code> fields will have their scores adjusted by
<code>bbdb/gnus-score-default</code>. If <code>bbdb/gnus-score-default</code> is
<code>nil</code>, no score adjustment will be made.
</li></ol>
<p>The <b>BBDB</b> by default searches the field contained in
<code>bbdb/gnus-score-field</code> for score values. To have the <b>BBDB</b> use
a different field, change the value of this variable.
</p>
<p>To enable <b>BBDB</b>-assisted scoring, add the <code>bbdb/gnus-score</code>
function to <code>gnus-score-find-score-files-function</code>. Assuming that
you want to preserve the default value of this variable, use a form
similar to the following:
</p>
<table><tr><td> </td><td><pre class="example">(setq gnus-score-find-score-files-function
'(gnus-score-find-bnews bbdb/gnus-score))
</pre></td></tr></table>
<p><b>Note:</b> The default value in <b>Gnus</b> 5.5 is <code>gnus-score-find-bnews</code>.
Check your configuration before using the above code, as your values may
be different.
</p>
<hr size="6">
<a name="Gnus-Summary-Buffer"></a>
<a name="SEC44"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC43" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC42" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 1.5.1.2 Gnus Summary Buffer Enhancements </h4>
<p><b>Gnus</b> can use the <b>BBDB</b> to do one of two things:
</p>
<ul>
<li>
Mark authors in the Summary Buffer who have records in the <b>BBDB</b> with
a user-defined mark character. See Marking Posters, below.
</li><li>
For authors in the Summary Buffer who also have records in the <b>BBDB</b>,
replace their name as listed in the Summary Buffer with their name as
stored in the <b>BBDB</b>. See Using Names from the <b>BBDB</b>, below.
</li></ul>
<a name="SEC45"></a>
<h4 class="subsubheading"> Marking Posters </h4>
<p>Authors with records in the <b>BBDB</b> can be marked either with a
user-defined mark character, or with a default one. The marking is
enabled by the use of a Gnus user format code, as determined by
<code>bbdb/gnus-summary-in-bbdb-format-letter</code>. This variable, which
defaults to <samp>`b'</samp>, is used to create a format code which is intended
for use in <code>gnus-summary-line-format</code>. The format code is created
by concatenating <samp>`%u'</samp> with the value of
<code>bbdb/gnus-summary-in-bbdb-format-letter</code>. In the default case
this results in the creation of the format code <samp>`%ub'</samp>.
</p>
<p>Posts are marked as follows: If the record for the poster has the field
indicated in <code>bbdb-message-marker-field</code> (the default is
<code>mark-char</code>), the value of that field is used as the mark
character.<a name="DOCF5" href="bbdb_fot.html#FOOT5">(5)</a> If no such field is present, the value of
<code>bbdb/gnus-summary-known-poster-mark</code> will be used instead. If the
author is not in the <b>BBDB</b>, a space will be used as the mark character.
</p>
<a name="SEC46"></a>
<h4 class="subsubheading"> Using Names from the <b>BBDB</b> </h4>
<p>The names reported for authors of posts in the Summary buffer can be
altered to conform to the values present in their respective <b>BBDB</b>
records (if any). This rewriting is enabled by the use of a Gnus user
format code, as determined by
<code>bbdb/gnus-summary-user-format-letter</code>. This variable, which
defaults to <samp>`B'</samp>, is used to create a format code which is intended
for use in <code>gnus-summary-line-format</code>. The format code is created
by concatenating <samp>`%u'</samp> with the value of
<code>bbdb/gnus-summary-user-format-letter</code>. In the default case this
results in the creation of the format code <samp>`%uB'</samp>. This format code
is intended to <b>replace</b> the format code previously used in the Summary
buffer format line to indicate the author and/or net address (usually
<samp>`%a'</samp>, <samp>`%n'</samp>, and/or <samp>`$N'</samp>).
</p>
<p>The effects of this format code are in two independent parts - the
marking of known posters, and the rewriting of posters names. The
first, the marking of posters, occurs only when
<code>bbdb/gnus-summary-mark-known-posters</code> is <code>t</code> (the default)
and the posters have entries in the <b>BBDB</b>. When this variable is
true, the marking occurs as described in the previous section, Marking
Posters, above.
</p>
<p>The poster name rewriting is done for all posters - not just for those
with records in the <b>BBDB</b>. That said, rewriting rules for posters in
the <b>BBDB</b> are more flexible than for those not listed. The rewriting is
governed by two variables, as described below.
</p>
<p><code>bbdb/gnus-summary-prefer-real-names</code> can have one of three values -
<samp>`t'</samp>, <samp>`bbdb'</samp>, or <code>nil</code>. In general, this variable governs
the preference between net addresses and names. If it is <samp>`t'</samp>, the
name (if any) will be used. If <samp>`nil'</samp>, the net address will be
used. The third value, <samp>`bbdb'</samp>, can be used as a method for
distinguishing between authors with records in the <b>BBDB</b> and those
without. If the variable is set to <samp>`bbdb'</samp>, the name from the
<b>BBDB</b> record will be used if the author has a record in the
<b>BBDB</b>. If the author is not in the <b>BBDB</b>, the net address from
the message will be printed. This variable makes little sense if
<code>bbdb/gnus-summary-prefer-bbdb-data</code> is <samp>`nil'</samp>, as no names
will be printed in the Summary buffer in this case - only net addresses.
</p>
<p><code>bbdb/gnus-summary-prefer-bbdb-data</code> is used to (dis)allow use of
the <b>BBDB</b> for author data retrieval. If it is <samp>`t'</samp>, data from
the <b>BBDB</b> will be used if available. If it is <samp>`nil'</samp>, data from
the <b>BBDB</b> will not be used.
</p>
<p>In the following examples, assume the following:
</p>
<ol>
<li>
Message: <code>From: Jamie <jwz@netscape.com></code><br>
<b>BBDB</b>: No record
</li><li>
Message: <code>From: Matt <simmonmt@acm.org></code><br>
<b>BBDB</b>: Name: <samp>`Matthew'</samp>, Net: <samp>`simmonmt@purdue.edu'</samp>
</li></ol>
<table>
<tr><td><p> <code>bbdb/gnus-summary-prefer-bbdb-data</code>
</p></td><td> <p align="center"> <code>t</code>
</p></td><td> <p align="center"> <code>t</code>
</p></td><td> <p align="center"> <code>nil</code>
</p></td></tr>
<tr><td><p> <code>bbdb/gnus-summary-prefer-real-names</code>
</p></td><td> <p align="center"> <code>t</code>
</p></td><td> <p align="center"> <code>bbdb</code>
</p></td><td> <p align="center"> <code>t</code>
</p></td></tr>
<tr><td><p> Printed in Summary buffer for
</p></td><td>
</td><td>
</td><td>
</td></tr>
<tr><td> <p align="center"> Case 1
</p></td><td> <p align="center"> Jamie
</p></td><td> <p align="center"> jwz@netscape.com
</p></td><td> <p align="center"> Jamie
</p></td></tr>
<tr><td> <p align="center"> Case 2
</p></td><td> <p align="center"> Matthew
</p></td><td> <p align="center"> Matthew
</p></td><td> <p align="center"> Matt
</p></td></tr>
</table>
<hr size="6">
<a name="GNUS-Subject-List"></a>
<a name="SEC47"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC44" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC48" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC42" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 1.5.1.3 GNUS Summary Buffer Enhancements </h4>
<p><i>This section is remarkably terse, as I don't have a copy of <b>GNUS</b>.
If anybody can provide more descriptive information, please let me
know.</i>
</p>
<table><tr><td> </td><td><pre class="example">(autoload 'bbdb/gnus-lines-and-from "bbdb-gnus")
(setq gnus-optional-headers 'bbdb/gnus-lines-and-from)
</pre></td></tr></table>
<dl compact="compact">
<dt> <code>bbdb/gnus-mark-known-posters</code></dt>
<dd><a name="IDX104"></a>
<a name="IDX105"></a>
<p>If <code>t</code> (the default), then the <b>GNUS</b> subject list will contain an
indication of those messages posted by people who have entries in
the Insidious Big Brother Database (they will be marked with an
asterisk.)
</p>
<a name="IDX106"></a>
<p>You can change the character used to mark records on a record-by-record
basis by adding a <code>mark-char</code> property to the record, whose value
is be the string to display (preferably one character.)
</p>
</dd>
<dt> <code>bbdb/gnus-header-prefer-real-names</code></dt>
<dd><a name="IDX107"></a>
<p>Default: <code>nil</code>. if <code>t</code>, then the <b>GNUS</b> subject list will
display real names instead of network addresses.
</p>
</dd>
<dt> <code>bbdb/gnus-header-show-bbdb-names</code></dt>
<dd><a name="IDX108"></a>
<p>Default: <code>t</code>. If both this variable and
the <code>bbdb/gnus-header-prefer-real-names</code> variable are true, then
for news messages from people who are in your database, the name displayed
will be the primary name from the database, rather than the one from
the <samp>`From:'</samp> line of the message. This doesn't affect the names of
people who aren't in the database, of course.
</p>
</dd>
<dt> <code>bbdb/gnus-lines-and-from-length</code></dt>
<dd><a name="IDX109"></a>
<p>Default: 18. The number of characters used to display <samp>`From:'</samp> info in
<b>GNUS</b>, if you have set <code>gnus-optional-headers</code> to
<code>bbdb/gnus-lines-and-from</code>.
</p></dd>
</dl>
<hr size="6">
<a name="VM-Features"></a>
<a name="SEC48"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC47" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC49" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC41" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.5.2 VM-specific features </h3>
<p>The <b>BBDB</b> can be used to integrate database information into the
message summary.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC49">1.5.2.1 VM Message Summary Enhancements</a></td><td> </td><td align="left" valign="top"> <b>BBDB</b> information in message summary
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC50">1.5.2.2 VM configuration of what records the <b>BBDB</b> buffer shows</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC51">1.5.2.3 VM automatic setup of <code>vm-set-auto-folder-alist</code></a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC52">1.5.2.4 VM automatic adding of labels</a></td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr size="6">
<a name="VM-Message-Summary"></a>
<a name="SEC49"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC48" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC50" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC48" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 1.5.2.1 VM Message Summary Enhancements </h4>
<p>VM users can cause their summary buffer to display the name of the
message sender according to <b>BBDB</b> data, instead of according to the
contents of the current message's headers. In VM 5.40 or later, use
the summary format control <code>%UB"</code> instead of <code>"%F"</code>, and the
current record name will be shown there if available. If no entry is
found it behaves like <code>"%F"</code>. See the documentation for
<code>vm-summary-format</code> for more details. Warning, this may
significantly slow down summary generation for large folders.
</p>
<hr size="6">
<a name="VM-what-records-are-displayed"></a>
<a name="SEC50"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC49" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC51" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC48" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 1.5.2.2 VM configuration of what records the <b>BBDB</b> buffer shows </h4>
<p>Email addresses which match <code>vm-summary-uninteresting-senders</code> are
ignored.
</p>
<p>The records in the <b>BBDB</b> buffer are listed in the same order as found.
</p>
<hr size="6">
<a name="VM-automatic-setup-of-vm_002dset_002dauto_002dfolder_002dalist"></a>
<a name="SEC51"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC50" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC52" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC48" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 1.5.2.3 VM automatic setup of <code>vm-set-auto-folder-alist</code> </h4>
<p>VM users can setup the <code>vm-set-auto-folder-alist</code> automatically by
calling <code>bbdb/vm-set-auto-folder-alist</code>. This adds for each <b>BBDB</b>
record containing a <code>bbdb/vm-set-auto-folder-alist-field</code> an entry
to <code>vm-set-auto-folder-alist</code>.
</p>
<p>The record field can contain a string which is used as folder name or
if it starts with a <code>'</code> it is treated as lisp expression returning
a folder name.
</p>
<hr size="6">
<a name="VM-automatic-adding-of-labels"></a>
<a name="SEC52"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC51" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC53" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC48" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 1.5.2.4 VM automatic adding of labels </h4>
<p><code>bbdb/vm-auto-add-label-list</code> is a
List used by <code>bbdb/vm-auto-add-label</code> to automatically label messages.
Each element in the list is either a string or a list of two strings.
If a single string then it is used as both the field value to check for
and the label to apply to the message. If a list of two strings, the first
is the field value to search for and the second is the label to apply.
</p>
<p><code>bbdb/vm-auto-add-label-field bbdb-define-all-aliases-field</code> is the
field used by <code>bbdb/vm-auto-add-label</code> to automatically label messages.
Value is either a single symbol or a list of symbols of bbdb fields that
<code>bbdb/vm-auto-add-label</code> uses to check for labels to apply to messages.
Defaults to <code>bbdb-define-all-aliases-field</code> which is typically
<code>mail-alias</code>.
</p>
<p><code>bbdb/vm-auto-add-label</code> automatically adds labels to messages
based on the <code>bbdb/vm-auto-add-label-field
bbdb-define-all-aliases-field</code> field. Add this to
<code>bbdb-notice-hook</code> and if using VM each message that bbdb notices
will be checked. If the sender has a value in the
<code>bbdb/vm-auto-add-label-field</code> in their BBDB record that matches a
value in <code>bbdb/vm-auto-add-label-list</code> then a VM label will be
added to the message.
</p>
<p>This works great when `bbdb-user-mail-names' is set. As a result mail
that you send to people (and copy yourself on) is labeled as well.
</p>
<hr size="6">
<a name="Other-Packages"></a>
<a name="SEC53"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC52" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC54" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 1.6 Using the <b>BBDB</b> with other packages </h2>
<p>The <b>BBDB</b> adds functionality to several packages. The following sections
detail these augmentations.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC54">1.6.1 Using the <b>BBDB</b> with Message Mode</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#SEC55">1.6.2 Using the <b>BBDB</b> with Reportmail</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#SEC56">1.6.3 Using the <b>BBDB</b> with Supercite</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#SEC57">1.6.4 Using the <b>BBDB</b> with Web Browsers</a></td><td> </td><td align="left" valign="top"></td></tr>
</table>
<hr size="6">
<a name="Using-Message-Mode"></a>
<a name="SEC54"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC53" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC55" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC53" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.6.1 Using the <b>BBDB</b> with Message Mode </h3>
<p>At this time, the only feature the <b>BBDB</b> adds to Message mode is the binding
to <kbd>M-TAB</kbd> which allows for <b>BBDB</b> record completion.
</p>
<hr size="6">
<a name="Using-Reportmail"></a>
<a name="SEC55"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC54" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC56" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC53" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.6.2 Using the <b>BBDB</b> with Reportmail </h3>
<p>The <b>BBDB</b> can modify the <tt>`reportmail.el'</tt> package to use information
from <b>BBDB</b> records when identifying the senders or recipients of e-mail
messages.
</p>
<p>In normal operation, Reportmail displays the name and net address sender and
recipient of incoming messages. The <b>BBDB</b> can be configured to intercept
and rewrite this information before it appears in the Emacs mode-line. It
first attempts to rewrite the sender and/or recipient information by
substituting those addresses with information from the <b>BBDB</b>. Replacement
information is first sought from the <code>mail-name</code> field in the respective
<b>BBDB</b> records. If no such field is found, the <code>name</code> field is
returned. If no <b>BBDB</b> record is found, no rewriting is performed.
</p>
<p>The <b>BBDB</b>-Reportmail augmentation is accomplished through the advising of
the Reportmail <code>display-time-get-field</code> function in order to do
a-posteriori modification of the returned value. The augmentation uses the
<code>bbdb/reportmail-alternate-full-name</code> function to retrieve data from the
<b>BBDB</b> for use in rewriting.
</p>
<hr size="6">
<a name="Using-Supercite"></a>
<a name="SEC56"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC55" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC57" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC53" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.6.3 Using the <b>BBDB</b> with Supercite </h3>
<p>The <b>BBDB</b> can be used with Supercite to store attributions with <b>BBDB</b>
records. Normally, when a non-default attribution is entered for a given
message, the entered attribution is used for that message, and is then
discarded. When the <b>BBDB</b>-Supercite augmentation is enabled, the
non-default attribution will be added to the record (if any) for the entity
being cited. This poor explanation sounds complicated, but it's not. If a
message from <samp>`Jamie Zawinski <jwz@netscape.com>'</samp> is being replied to,
Supercite will, by default, suggest the citation <samp>`Jamie'</samp>. If the
non-default citation <samp>`jwz'</samp> is entered, Supercite can save it with the
<b>BBDB</b> record for <samp>`Jamie Zawinski'</samp> in the <code>attribution</code> field.
</p>
<p>The field used can be changed by changing the value of
<code>bbdb/sc-attribution-field</code>.
</p>
<hr size="6">
<a name="Using-Web-Browsers"></a>
<a name="SEC57"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC56" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC58" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC53" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.6.4 Using the <b>BBDB</b> with Web Browsers </h3>
<p>The <b>BBDB</b>/Web Browser integration is in two parts, one which is
automatically enabled, and one which must be manually enabled (see section <a href="#SEC27">Initializing <b>BBDB</b> support for Web Browsers</a>). The first feature added is the ability to display the URL
associated with a given record in a Web Browser. The second is the ability to
add URLs to <b>BBDB</b> records from within W3, the Emacs Web Browser.
</p>
<p>Pressing <kbd>W</kbd> in the <code>*BBDB*</code> buffer while the cursor is positioned
over a record with a <code>www</code> field will cause the first URL in the field to
be loaded in a Web Browser. This functionality uses <code>browse-url</code> to
display URLs - see the documentation for <code>browse-url</code> for information on
selecting the browser to be used.
</p>
<p>If W3 is used, and if the <b>BBDB</b>/W3 functionality has been enabled as
described in <a href="#SEC27">Initializing <b>BBDB</b> support for Web Browsers</a>, pressing the <kbd>:</kbd> key will add the URL
currently being displayed in W3 to a user-specified <b>BBDB</b> record.
</p>
<hr size="6">
<a name="Options"></a>
<a name="SEC58"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC57" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC59" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 1.7 Options </h2>
<p>There are many variables which control the behavior of the Insidious Big
Brother Database, and there are many hook-variables which can be used to
modify its behavior in more complex ways. Several pieces of functionality
are included which use the hooks in this way.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC59">1.7.1 Customization Parameters</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#SEC60">1.7.2 Customization Hooks</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#SEC61">1.7.3 Predefined Hooks</a></td><td> </td><td align="left" valign="top"></td></tr>
</table>
<hr size="6">
<a name="Customization-Parameters"></a>
<a name="SEC59"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC58" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC60" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC58" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.7.1 Customization Parameters </h3>
<dl compact="compact">
<dt> <code>bbdb-file</code></dt>
<dd><a name="IDX110"></a>
<p>The name of the file which contains your personal database. Default:
<tt>`~/.bbdb'</tt>.
</p>
</dd>
<dt> <code>bbdb-default-area-code</code></dt>
<dd><a name="IDX111"></a>
<a name="IDX112"></a>
<p>The default area code to use when prompting for a new phone number.
Default: 415. This must be a number, not a string.
</p>
</dd>
<dt> <code>bbdb-north-american-phone-numbers-p</code></dt>
<dd><a name="IDX113"></a>
<a name="IDX114"></a>
<a name="IDX115"></a>
<p>Whether syntax-checking of phone numbers should be enforced. Default:
<code>t</code>. This only works for Bell-system phone numbers. If this is true,
then you can't enter invalid phone numbers, and all phone numbers are
pretty-printed in the same way. European phone numbers don't have as
strict a syntax, however, so this is a harder problem for them (on which
I am punting).
</p>
<p>You can have both styles of phone number in your database by providing a
prefix argument to the <code>bbdb-insert-new-field</code> command.
</p>
</dd>
<dt> <code>bbdb-check-zip-codes-p</code></dt>
<dd><a name="IDX116"></a>
<a name="IDX117"></a>
<a name="IDX118"></a>
<a name="IDX119"></a>
<a name="IDX120"></a>
<a name="IDX121"></a>
<a name="IDX122"></a>
<a name="IDX123"></a>
<p>Whether syntax-checking of zip codes should be enforced. Default:
<code>t</code>. If this is true, you can't enter invalid zip codes. A zip
code is valid if it matches one of the regular expressions in the
variable <code>bbdb-legal-zip-codes</code>.
</p>
</dd>
<dt> <code>bbdb-address-formatting-alist</code></dt>
<dd><a name="IDX124"></a>
<a name="IDX125"></a>
<a name="IDX126"></a>
<a name="IDX127"></a>
<p>Controls the display of addresses in the buffer. Each entry in this
list consists of an identifying function and a formatting function.
The identifying function must accept an address and return <code>t</code> if
the associated formatting function is to be used. The formatting
function must insert the formatted address in the current buffer.
Identifying functions usually base their decision on the zip code
format or on the country name. The default entries will format an
address using continental style if the zip code matches
<code>bbdb-continental-zip-regexp</code>. If the zip code does not match,
addresses are formatted in US style.
</p>
</dd>
<dt> <code>bbdb-continental-zip-regexp</code></dt>
<dd><a name="IDX128"></a>
<a name="IDX129"></a>
<a name="IDX130"></a>
<p>Decides whether an address should be formatted using US or European
style. If the zip code of an address matches the regular expression,
the European style is used. This works only if the expression
<code>(bbdb-address-is-continental . bbdb-format-address-continental)</code>
is part of <code>bbdb-address-formatting-alist</code>.
</p>
</dd>
<dt> <code>bbdb-electric-p</code></dt>
<dd><a name="IDX131"></a>
<a name="IDX132"></a>
<p>Whether bbdb mode should be <i>"electric"</i> like <code>electric-buffer-list</code>.
Default: <code>t</code>. What this means is that the BBDB buffer which pops
up when you use it can be disposed of by pressing the space bar, at
which point your window configuration will be restored to what it was
before you invoked the db list. (The <code>bbdb-mode</code> commands still
work as well.)
</p>
<p>There are some problems with electric modes; for example, keyboard
macros and incremental search don't work. (This is not a bug in BBDB,
but in <tt>`electric.el'</tt>.)
</p>
</dd>
<dt> <code>bbdb-case-fold-search</code></dt>
<dd><a name="IDX133"></a>
<p>Default: the same as <code>case-fold-search</code>. <code>case-fold-search</code> is
bound to this by <kbd>M-x bbdb</kbd> and related commands. This variable lets
the case-sensitivity of <kbd>^S</kbd> and of the bbdb searching commands be
different.
</p>
</dd>
<dt> <code>bbdb/mail-auto-create-p</code></dt>
<dd><a name="IDX134"></a>
<p>If this is <code>t</code> (the default), then <b>VM</b>, <b>MH</b>, and <b>RMAIL</b>
will automatically create new bbdb records for people you receive mail
from. If this variable is a function name or lambda expression, then it
is called with no arguments to decide whether an entry should be
automatically created. You can use this to, for example, not create
records for messages which have reached you through a particular mailing
list, or to only create records automatically if the mail has a
particular subject. See the variables
<code>bbdb-ignore-most-messages-alist</code> and
<code>bbdb-ignore-some-messages-alist</code> (See section <a href="#SEC61">Predefined Hooks</a>.)
</p>
</dd>
<dt> <code>bbdb/news-auto-create-p</code></dt>
<dd><a name="IDX135"></a>
<a name="IDX136"></a>
<p>If this is <code>t</code> (default: <code>nil</code>), then <b>GNUS</b> will
automatically create new <b>BBDB</b> records for people you read messages
by. If this is a function name or lambda expression, then it is called
with no arguments to decide whether an entry should be automatically
created. You can use this to, for example, create or not create
messages which have a particular subject. See the variable
<code>bbdb-auto-notes-alist</code> (See section <a href="#SEC61">Predefined Hooks</a>.).
</p>
<p>If you want to autocreate messages based on the current newsgroup, it's
probably a better idea to set this variable to <code>t</code> or <code>nil</code> from your
<code>gnus-select-group-hook</code> instead.
</p>
<p>To automatically remember users in certain groups, you can do something
like
</p><table><tr><td> </td><td><pre class="example">(setq gnus-select-group-hook
'(lambda ()
(setq bbdb/news-auto-create-p
(or (string= "some.news.group" gnus-newsgroup-name)
(string= "other.news.group" gnus-newsgroup-name)))))
</pre></td></tr></table>
</dd>
<dt> <code>bbdb-quiet-about-name-mismatches</code></dt>
<dd><a name="IDX137"></a>
<p>If this is false (the default), then <b>BBDB</b> will prompt you when it notices a
name change, that is, when the "real name" in a message doesn't correspond
to a record already in the database with the same network address. As in,
<i>"John Smith <jqs@frob.com>"</i> versus
<i>"John Q. Smith <jqs@frob.com>".</i> If this is true, then you will
not be asked if you want to change it (and it will not be changed.)
If a number then it is the number of seconds to sit-for while
displaying the name mismatch.
</p>
</dd>
<dt> <code>bbdb-use-alternate-names</code></dt>
<dd><a name="IDX138"></a>
<a name="IDX139"></a>
<a name="IDX140"></a>
<p>If this is false, then the <b>BBDB</b> will not use the <b>AKA</b> field.
Otherwise (the default) then the mail and news interfaces will ask you
if you want to add an alternate name when a name-change is noticed, and
will ask you whether the new name should be made the primary one.
Note that if <code>bbdb-quiet-about-name-mismatches</code> is true, you will
not be asked any questions about alternate names.
</p>
</dd>
<dt> <code>bbdb-readonly-p</code></dt>
<dd><a name="IDX141"></a>
<p>If this is true (default: <code>nil</code>), then nothing will attempt to change the
database implicitly, and you will be prevented from doing it
explicitly. If you have more than one emacs running at the same time,
you might want to arrange for this to be set to <code>t</code> in all but one of
them.
</p>
</dd>
<dt> <code>bbdb-auto-revert-p</code></dt>
<dd><a name="IDX142"></a>
<p>If this variable is true (default: <code>nil</code>) and the <b>BBDB</b> file is noticed to
have changed on disk, it will be automatically reverted without
prompting you first. Otherwise you will be asked. (But if the file has
changed and you have made changes in memory as well, you will always be
asked.)
</p>
</dd>
<dt> <code>bbdb-notice-auto-save-file</code></dt>
<dd><a name="IDX143"></a>
<a name="IDX144"></a>
<p>If this is true (default: <code>nil</code>), then the <b>BBDB</b> will notice when its
auto-save file is newer than the file is was read from, and will offer
to revert.
</p>
</dd>
<dt> <code>bbdb-use-pop-up</code></dt>
<dd><a name="IDX145"></a>
<a name="IDX146"></a>
<p>If true (the default), display a continuously-updating <b>BBDB</b>
window while in <b>VM</b>, <b>MH</b>, <b>RMAIL</b>, or <b>GNUS</b>.
Each time a new message is selected, the record corresponding to
that message's sender will be displayed in another window. The
buffer in this other window will be in bbdb-mode, and all
corresponding commands will be available.
</p>
<p>This buffer will be positioned on the screen by finding the tallest
of the windows present, and splitting it such that the bottom
<code>bbdb-pop-up-target-lines</code> lines of the window display the
<samp>`*BBDB*'</samp> buffer. With the default configurations of <b>VM</b>,
<b>MH</b>, <b>RMAIL</b>, and <b>GNUS</b>, this means that the bbdb-list
buffer will be just below the message-body buffer.
</p>
<p>If this is the symbol <code>horiz</code>, then the <b>BBDB</b> window will be
stacked horizontally instead of vertically, if there is room to do that
tastefully.
</p>
</dd>
<dt> <code>bbdb-pop-up-target-lines</code></dt>
<dd><a name="IDX147"></a>
<p>Desired number of lines in a <b>VM/MH/RMAIL/GNUS</b> pop-up <b>BBDB</b> window,
default 5.
</p>
</dd>
<dt> <code>bbdb-completion-type</code></dt>
<dd><a name="IDX148"></a>
<a name="IDX149"></a>
<a name="IDX150"></a>
<a name="IDX151"></a>
<a name="IDX152"></a>
<p>Controls the behavior of the <code>bbdb-complete-name</code> command. If <code>nil</code>
(the default), completion is done across the set of all full-names and
user-ids in the database; if the symbol <code>name</code>, completion is
done on real-names only; if the symbol <code>net</code>, completion is done
on network addresses only; if it is <code>primary</code>, then completion is
done only across the set of primary network addresses (the first address
in the list of addresses for a given user). If it is
<code>primary-or-name</code>, completion is done across primaries and real
names.
</p>
</dd>
<dt> <code>bbdb-expand-mail-aliases</code></dt>
<dd><a name="IDX153"></a>
<a name="IDX154"></a>
<a name="IDX155"></a>
<a name="IDX156"></a>
<a name="IDX157"></a>
<p>If non-nil, expand mail aliases in `bbdb-complete-name'.
</p>
</dd>
<dt> <code>bbdb-complete-name-allow-cycling</code></dt>
<dd><a name="IDX158"></a>
<a name="IDX159"></a>
<a name="IDX160"></a>
<a name="IDX161"></a>
<a name="IDX162"></a>
<p>Whether to allow cycling of email addresses when calling
`bbdb-complete-name' on a completed address in a composition buffer."
</p>
</dd>
<dt> <code>bbdb-complete-name-full-completion</code></dt>
<dd><a name="IDX163"></a>
<a name="IDX164"></a>
<a name="IDX165"></a>
<a name="IDX166"></a>
<a name="IDX167"></a>
<p>Show full expanded completion rather than partial matches.
If t then do it always, if a number then just is the number of
completions for a specific match is below that number.
</p>
</dd>
<dt> <code>bbdb-user-mail-names</code></dt>
<dd><a name="IDX168"></a>
<p>A regular expression identifying the addresses that belong to you. If a
message from an address matching this is seen, the <b>BBDB</b> record for the
<samp>`To:'</samp> line will be shown instead of the one for the <samp>`From:'</samp>
line. If this is <code>nil</code>, it will default to the value of
<code>(user-login-name)</code>.
</p>
</dd>
<dt> <code>bbdb-always-add-addresses</code></dt>
<dd><a name="IDX169"></a>
<p>If this is <code>t</code>, then whenever the Insidious Big Brother Database
notices a new email address corresponding to a person who is in the
database, it will add it to the database. If this is <code>nil</code> (the
default), then whenever a new network address is noticed for a person in
the database, you will be asked whether to add the address. If this is
the symbol <code>never</code> (really if it is not <code>t</code> and not <code>nil</code>)
then new network addresses will never be automatically added.
</p>
</dd>
<dt> <code>bbdb-new-nets-always-primary</code></dt>
<dd><a name="IDX170"></a>
<p>If this is <code>t</code>, then when the Insidious Big Brother Database adds a new
address to a record, it will always add it to the front of the list of
addresses, making it the primary address. If this is <code>nil</code> (the default),
then you will be asked. If this is the symbol <code>never</code> (really if
it is not <code>t</code> and not <code>nil</code>) then new network addresses will
always be added to the end of the list.
</p>
</dd>
<dt> <code>bbdb-canonicalize-redundant-nets-p</code></dt>
<dd><a name="IDX171"></a>
<p>If this is non-<code>nil</code>, redundant network addresses will be ignored.
If a record has an address of the form <code>foo@baz.com</code>, setting this
to <code>t</code> will cause subsequently-noticed addresses
like <code>foo@bar.baz.com</code> to be ignored (since we already have a more
general form of that address.) This is similar in function to one of
the possible uses of the variable <code>bbdb-canonicalize-net-hook</code>
but is somewhat more automatic. (This can't quite be implemented in
terms of the canonicalize-net-hook because it needs access to the
database to determine whether an address is redundant, and the
canonicalize-net-hook is purely a textual manipulation which is
performed before any database access.)
</p>
</dd>
<dt> <code>bbdb-message-caching-enabled</code></dt>
<dd><a name="IDX172"></a>
<p>Whether caching of the message->bbdb-record association should be
used for the interfaces which support it (<b>VM</b>, <b>MH</b>, and
<b>RMAIL</b>). This can speed things up a lot. One implication of
this variable being true (the default) is that the
<code>bbdb-notice-hook</code> will not be called each time a message is
selected, but only the first time. Likewise, if selecting a message
would generate a question (whether to add an address, change the
name, etc) you will only be asked that question the very first time
the message is selected.
</p>
</dd>
<dt> <code>bbdb-offer-save</code></dt>
<dd><a name="IDX173"></a>
<p>If <code>t</code> (the default), then certain actions will cause the <b>BBDB</b> to
ask you whether you wish to save the database. If <code>nil</code>, then the
offer to save will never be made. If not <code>t</code> and not <code>nil</code>, then
any time it would ask you, it will just save it without asking.
</p>
</dd>
</dl>
<hr size="6">
<a name="Customization-Hooks"></a>
<a name="SEC60"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC59" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC61" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC58" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.7.2 Customization Hooks </h3>
<p>All of the hooks variables described below may be set to a symbol or
lambda expression, which will be funcalled; or may be set to a list of
symbols or lambda expressions, each of which will be funcalled in turn.
Almost all hooks in Emacs work this way. But notice that some of the
hooks described below are called with arguments.
</p>
<dl compact="compact">
<dt> <code>bbdb-list-hook</code></dt>
<dd><a name="IDX174"></a>
<p>Hook or hooks invoked after the bbdb-list-buffer is filled in. Invoked
with no arguments.
</p>
</dd>
<dt> <code>bbdb-create-hook</code></dt>
<dd><a name="IDX175"></a>
<p>Hook or hooks invoked each time a new bbdb-record is created. Invoked
with one argument, the new record. This is called <em>before</em> the record is
added to the database. Note that <code>bbdb-change-hook</code> will be called as
well.
</p>
</dd>
<dt> <code>bbdb-change-hook</code></dt>
<dd><a name="IDX176"></a>
<p>Hook or hooks invoked each time a bbdb-record is altered. Invoked with
one argument, the record. This is called <em>before</em> the database buffer
is modified. Note that if a new bbdb record is created, both this hook and
<code>bbdb-create-hook</code> will be called.
</p>
</dd>
<dt> <code>bbdb-mode-hook</code></dt>
<dd><a name="IDX177"></a>
<p>Hook or hooks invoked when the <samp>`*BBDB*'</samp> buffer is created.
</p>
</dd>
<dt> <code>bbdb-notice-hook</code></dt>
<dd><a name="IDX178"></a>
<p>Hook or hooks invoked each time a bbdb-record is "noticed," that
is, each time it is displayed by the news or mail interfaces.
Invoked with one argument, the new record. The record need not have
been modified for this to be called - use <code>bbdb-change-hook</code> for that.
You can use this to, for example, add something to the notes field
based on the subject of the current message. It is up to your hook
to determine whether it is running in <b>GNUS</b>, <b>VM</b>,
<b>MH</b>, or <b>RMAIL</b>, and to act appropriately.
</p>
<p>Also note that <code>bbdb-change-hook</code> will <em>not</em> be called as a
result of any modifications you may make to the record inside this
hook.
</p>
<p>Beware that if the variable <code>bbdb-message-caching-enabled</code> is
true (a good idea) then when you are using <b>VM</b>, <b>MH</b>, or
<b>RMAIL</b>, this hook will be called only the first time that
message is selected. (The <b>GNUS</b> interface does not use caching.)
When debugging the value of this hook, it is a good idea to set
caching-enabled to <code>nil</code>.
</p>
</dd>
<dt> <code>bbdb-after-read-db-hook</code></dt>
<dd><a name="IDX179"></a>
<p>Hook or hooks invoked (with no arguments) just after the Insidious Big
Brother Database is read in. Note that this can be called more than once if
the <b>BBDB</b> is reverted. One possible use for this is to rename the
<tt>`.bbdb'</tt> buffer; for example
</p>
<p><code>(setq bbdb-after-read-db-hook '(lambda () (rename-buffer " bbdb")))</code>
</p>
<p>will cause the buffer visiting the <code>bbdb-file</code> to be
called <code>" bbdb"</code>. The leading space in its name will prevent
it from showing up in the buffer list.
</p>
</dd>
<dt> <code>bbdb-load-hook</code></dt>
<dd><a name="IDX180"></a>
<p>Hook or hooks invoked (with no arguments) when the Insidious Big Brother
Database code is first loaded. WARNING: Slow functions should not be
put on this hook, as the <b>BBDB</b> code will, if not loaded before, be
loaded during the first use of <b>BBDB</b>-related Customization
functions. Slow functions should be put on <code>bbdb-initialize-hook</code>.
</p>
</dd>
<dt> <code>bbdb-initialize-hook</code></dt>
<dd><a name="IDX181"></a>
<a name="IDX182"></a>
<p>Hook or hooks invoked (with no arguments) when the
<code>bbdb-initialize</code> function is called.
</p>
</dd>
<dt> <code>bbdb-canonicalize-net-hook</code></dt>
<dd><a name="IDX183"></a>
<p>If this is non-<code>nil</code>, it should be a function of one argument: a
network address string. (Note that, unlike the other hook-variables
described above, this may not be a list of functions.) Whenever the
Insidious Big Brother Database "notices" a message, the corresponding
network address will be passed to this function first, as a kind of
"filter" to do whatever transformations upon it you like before it is
compared against or added to the database. For example: it is the case
that <code>CS.CMU.EDU</code> is a valid return address for all mail
originating at a machine in the <code>.CS.CMU.EDU</code> domain. So, if you
wanted all such addresses to be canonically hashed as
<code>user@CS.CMU.EDU</code>, instead of as <code>user@somehost.CS.CMU.EDU</code>,
you might set this variable to a function like this:
</p>
<table><tr><td> </td><td><pre class="example">(setq bbdb-canonicalize-net-hook
'(lambda (addr)
(cond ((string-match
"\\`\\([^@]+@\\).*\\.\\(CS\\.CMU\\.EDU\\)\\'"
addr)
(concat (substring addr
(match-beginning 1) (match-end 1))
(substring addr
(match-beginning 2) (match-end 2))))
(t addr))))
</pre></td></tr></table>
<p>You could also use this function to rewrite UUCP-style addresses into
domain-style addresses, or any number of other things.
</p>
<p>This function will be called repeatedly until it returns a value EQ to the
value passed in. So multiple rewrite rules might apply to a single
address.
</p>
<p>There is an example of the use of this variable in the
file <tt>`bbdb-hooks.el'</tt>: the function
<code>sample-bbdb-canonicalize-net-hook</code>.
</p></dd>
</dl>
<a name="IDX184"></a>
<a name="IDX185"></a>
<p>The <code>bbdb-canonicalize-net-hook</code> is powerful in that it allows
arbitrary rewriting of addresses, however, in many cases that is
overkill. The function <code>bbdb-delete-redundant-nets</code> can be
used as a value of <code>bbdb-change-hook</code> to cause network addresses
which appear to be "redundant" to be deleted each time a modification
is made to a record.
</p>
<p>This works as follows: suppose one gets mail from <code>user@foo.bar.com</code>,
and then later gets mail from <code>user@bar.com</code>. At this point, one
can generally delete the <code>user@foo.bar.com</code> address, since the
<code>user@bar.com</code> address is more general. (See also the
variable `bbdb-canonicalize-redundant-nets-p', which has the effect of
ignoring subsequent addresses from <code>user@quux.bar.com</code> if the
address <code>user@bar.com</code> is already known.)
</p>
<hr size="6">
<a name="Predefined-Hooks"></a>
<a name="SEC61"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC60" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC62" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC58" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.7.3 Predefined Hooks </h3>
<p>If the variable <code>bbdb-change-hook</code> is set to the symbol
<code>bbdb-timestamp-hook</code> (the default), then every record in the
database will have a field named <samp>`timestamp'</samp>, which will always
contain the date and time at which this record was created or last
modified.
</p>
<a name="IDX186"></a>
<p>If the variable <code>bbdb-create-hook</code> is set to the symbol
<code>bbdb-creation-date-hook</code> (the default), then every record in the
database will have a field named <samp>`creation-date'</samp>, which will
contain the date and time at which this record was added to the
database.
</p>
<a name="IDX187"></a>
<a name="IDX188"></a>
<a name="IDX189"></a>
<p>If the variable <code>bbdb/mail-auto-create-p</code> is set to the symbol
<code>bbdb-ignore-most-messages-hook</code>, then the variable
<code>bbdb-ignore-most-messages-alist</code> will determine which messages
should have records automatically created for them. The format of this
alist is
</p><table><tr><td> </td><td><pre class="example">(( <var>HEADER-NAME</var> . <var>REGEXP</var> ) … )
</pre></td></tr></table>
<p>for example,
</p><table><tr><td> </td><td><pre class="example">(("From" . "@.*\\.maximegalon\\.edu")
("Subject" . "time travel"))
</pre></td></tr></table>
<p>will cause <b>BBDB</b> entries to be made only for messages sent by
people at Maximegalon U., or (that's <em>or</em>) people posting
about time travel.
</p>
<p>There may be only one entry per header in this alist: that is,
</p>
<table><tr><td> </td><td><pre class="example">(("From" . "addr1\\|addr2") … )
</pre></td></tr></table>
<p>is legal, but
</p>
<table><tr><td> </td><td><pre class="example">(("From" . "addr1") ("From" . "addr2") … )
</pre></td></tr></table>
<p>is not.
</p>
<a name="IDX190"></a>
<a name="IDX191"></a>
<a name="IDX192"></a>
<a name="IDX193"></a>
<p>If the variable <code>bbdb/mail-auto-create-p</code> is set to the symbol
<code>bbdb-ignore-some-messages-hook</code>, then the variable
<code>bbdb-ignore-some-messages-alist</code> will determine which messages
should have records automatically created for them. This is the exact
inverse of the semantics of the <code>bbdb-ignore-most-messages-alist</code>:
the alist specifies which messages should <em>not</em> have records
automatically created for them, instead of which should. For
example,
</p>
<table><tr><td> </td><td><pre class="example">(("From" . "mailer.daemon")
("To" . "mailing-list-1\\|mailing-list-2")
("CC" . "mailing-list-1\\|mailing-list-2"))
</pre></td></tr></table>
<p>will cause <b>BBDB</b> entries to not be made for messages from any mailer daemon,
or messages sent to or <b>CC</b>ed to either of two mailing lists.
</p>
<p>The variable <code>bbdb/news-auto-create-p</code> may be set to either of the
above-mentioned functions as well, to get this behavior for netnews
messages instead of mail messages.
</p>
<a name="IDX194"></a>
<a name="IDX195"></a>
<a name="IDX196"></a>
<p>If the variable <code>bbdb-notice-hook</code> is set to the symbol
<code>bbdb-auto-notes-hook</code>, then the variable <code>bbdb-auto-notes-alist</code>
may be used to automatically add text to the notes fields of the records
corresponding to certain messages. The format of this alist is
</p>
<table><tr><td> </td><td><pre class="example">(( <var>HEADER-NAME</var>
(<var>REGEXP</var> . <var>STRING</var>) … )
… )
</pre></td></tr></table>
<p>for example,
</p>
<table><tr><td> </td><td><pre class="example">(("To" ("-vm@" . "VM mailing list"))
("Subject" ("sprocket" . "mail about sprockets")
("you bonehead" . "called me a bonehead")))
</pre></td></tr></table>
<p>will cause the text <code>"VM mailing list"</code> to be added to the notes field of
the record corresponding to anyone you get mail from via one of the <b>VM</b>
mailing lists. If, that is, <code>bbdb/mail-auto-create-p</code> is set such
that the record would have been created, or if the record already
existed.
</p>
<p>The format of elements of this list may also be
</p>
<table><tr><td> </td><td><pre class="example">(<var>REGEXP</var> <var>FIELD-NAME</var> <var>STRING</var>)
</pre></td></tr></table>
<p>or
</p><table><tr><td> </td><td><pre class="example">(<var>REGEXP</var> <var>FIELD-NAME</var> <var>STRING</var> <var>REPLACE-P</var>)
</pre></td></tr></table>
<p>meaning add the given string to the named field. The field-name may not
be <samp>`name'</samp>, <samp>`aka'</samp>, <samp>`address'</samp>, <samp>`phone'</samp>, or <samp>`net'</samp>
(builtin fields) but must be either <samp>`notes'</samp>, <samp>`company'</samp>, or the
name of a user-defined note-field.
</p>
<table><tr><td> </td><td><pre class="example">("pattern" . "string to add")
</pre></td></tr></table>
<p>is equivalent to
</p>
<table><tr><td> </td><td><pre class="example">("pattern" notes "string to add")
</pre></td></tr></table>
<p><var>STRING</var> can contain <code>\&</code> or <code>\N</code> escapes like in the function
<code>replace-match</code>. For example, to automatically add the contents of the
<b>organization</b> field of a message to the <code>company</code> field of a <b>BBDB</b>
record, you can use this:
</p>
<table><tr><td> </td><td><pre class="example">("Organization" (".*" company "\\&"))
</pre></td></tr></table>
<p>(Note you need two \ to get a single \ into a lisp string literal.)
</p>
<p>If STRING is an integer <i>N</i>, the <i>N</i>th matching subexpression is
used, so the above example could be written more efficiently as
</p>
<table><tr><td> </td><td><pre class="example">("Organization" (".*" company 0))
</pre></td></tr></table>
<p>If STRING is neither a string or an integer, it should be a function
which is called with the contents of the field, and the result of the
function call is used.
</p>
<p>If the <var>REPLACE-P</var> flag is true, then the string replaces the old
contents instead of being appended to it.
</p>
<p>If multiple clauses match the message, all of the corresponding strings
will be added.
</p>
<p>If the string is being appended (<var>REPLACE-P</var> is false or not
provided) then the new string is appended to the end of the existing
field value, with an intervening newline. So each piece of text
automatically added to this field will go on its own line.
</p>
<p>You can control what the separator is by putting a <code>field-separator</code>
property on the symbol naming the field. For example, to make text
automatically added to a field named <code>newsgroups</code> be separated by
commas, you could do
</p>
<table><tr><td> </td><td><pre class="example">(put 'newsgroups 'field-separator "; ")
</pre></td></tr></table>
<p>This variable works for news as well. You might want to arrange for
this to have a different value when in mail as when in news.
</p>
<p>There may be only one entry per header in this alist: that is,
</p>
<table><tr><td> </td><td><pre class="example"> (("Subject" ("\\bfoo\\b" . "Foo!!")
("bar" . "Bar!")))
</pre></td></tr></table>
<p>will work, but
</p>
<table><tr><td> </td><td><pre class="example"> (("Subject" ("\\bfoo\\b" . "Foo!!"))
("Subject" ("bar" . "Bar!")))
</pre></td></tr></table>
<p>will not.
</p>
<p>Here's a more complicated example: some people include bitmaps of
themselves in their mail messages in an <b>X-Face:</b> header field.
You can capture this field into the <samp>`*BBDB*'</samp> with the
following:
</p>
<table><tr><td> </td><td><pre class="example">(setq bbdb-auto-notes-alist
(append bbdb-auto-notes-alist
(list "x-face"
(list (concat "[ \t\n]*\\([^ \t\n]*\\)"
"\\([ \t\n]+\\([^ \t\n]+\\)\\)?"
"\\([ \t\n]+\\([^ \t\n]+\\)\\)?"
"\\([ \t\n]+\\([^ \t\n]+\\)\\)?"
)
'face
"\\1\\3\\5\\7"))))
</pre></td></tr></table>
<p>(The calls to <code>list</code> and <code>concat</code> are just for readability, it
could easily be a constant.) The tricky bit here is that it strips out
the newlines and whitespace used for header continuation, which are not
actually a part of the face data. So though the mail message may have
the face data on multiple lines, the entry in the <samp>`*BBDB*'</samp> will
be just one line.
</p>
<a name="IDX197"></a>
<p><code>bbdb-auto-notes-ignore</code> is an alist of headers and regexps to
ignore in <code>bbdb-auto-notes-hook</code>. Each element looks like
</p>
<table><tr><td> </td><td><pre class="example">(<var>HEADER</var> . <var>REGEXP</var>)
</pre></td></tr></table>
<p>for example,
</p>
<table><tr><td> </td><td><pre class="example">("Organization" . "^Gatewayed from\\|^Source only")
</pre></td></tr></table>
<p>would exclude the phony <code>Organization:</code> headers in GNU mailing-lists
gatewayed to the <code>gnu.*</code> newsgroups. Note that this exclusion
applies only to a single field, not to the entire message. For that,
use the variable <code>bbdb-auto-notes-ignore-all</code>.
</p>
<a name="IDX198"></a>
<p><code>bbdb-auto-notes-ignore-all</code> is an alist of headers and regexps
which cause the entire message to be ignored in <code>bbdb-auto-notes-hook</code>.
Each element looks like
</p>
<table><tr><td> </td><td><pre class="example">(<var>HEADER</var> . <var>REGEXP</var>)
</pre></td></tr></table>
<p>for example,
</p>
<table><tr><td> </td><td><pre class="example">("From" . "BLAT\\.COM")
</pre></td></tr></table>
<p>would exclude any notes recording for message coming from <code>BLAT.COM</code>.
Note that this is different from <code>bbdb-auto-notes-ignore</code>, which
applies only to a particular header field, rather than the entire message.
</p>
<hr size="6">
<a name="Utilities"></a>
<a name="SEC62"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC61" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC63" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 1.8 Utilities </h2>
<p>This section describes <b>BBDB</b> functionality that does not fit neatly into
other sections.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC63">1.8.1 <code>bbdb-ftp</code></a></td><td> </td><td align="left" valign="top"> Storing FTP sites in the <b>BBDB</b>
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC64">1.8.2 <code>bbdb-print</code></a></td><td> </td><td align="left" valign="top"> Print the <b>BBDB</b>
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC65">1.8.3 <code>bbdb-snarf</code></a></td><td> </td><td align="left" valign="top"> Record generation from raw text
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC66">1.8.4 <code>bbdb-srv</code></a></td><td> </td><td align="left" valign="top"> External control of the <b>BBDB</b>
</td></tr>
</table>
<hr size="6">
<a name="bbdb_002dftp"></a>
<a name="SEC63"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC62" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC64" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC62" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.8.1 <code>bbdb-ftp</code> </h3>
<p>The <code>bbdb-ftp</code> utility enables the storage of FTP sites as <b>BBDB</b>
records. The <code>bbdb-create-ftp-site</code> function is used to create a
<b>BBDB</b> record for an FTP site. The command will prompt for information
needed to create the record. The FTP site for a given record can be accessed
with the <code>bbdb-ftp</code> command.
</p>
<hr size="6">
<a name="bbdb_002dprint"></a>
<a name="SEC64"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC63" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC65" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC62" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.8.2 <code>bbdb-print</code> </h3>
<p><code>bbdb-print</code> is a utility for pretty-printing entries from the <b>BBDB</b>
using TeX. It is invoked by pressing <kbd>P</kbd> in the <code>*BBDB*</code> buffer -
this will cause all records in the <b>BBDB</b> to be printed as governed by the
variables described below. If <kbd>P</kbd> is prefixed by a <kbd>*</kbd>, only the
currently-displayed records will be printed. Once invoked, <code>bbdb-print</code>
will generate the TeX output in a buffer named <tt>`~/bbdb.tex'</tt> (controlled
by <code>bbdb-print-file-name</code>). The generated output will be shown, and must
be <b>manually</b> saved.
</p>
<p>For each record printed, <code>bbdb-print</code> will look for the presence of the
<code>tex-name</code> field. If this field is found, its value will be printed
instead of the <code>name</code> field for the record in question. This field is
intended to allow the storage of names with accents or other characters that
would be illegal in the address portion of a message. While other fields have
special characters quoted by <code>bbdb-print</code> as described below, the
contents of the <code>tex-name</code> field (if present) are used verbatim.
</p>
<p>The following variables govern the printing of records (and of the printing of
the fields therein):
</p>
<dl compact="compact">
<dt> <code>bbdb-print-omit-fields</code></dt>
<dd><a name="IDX199"></a>
<p>This variable should be set to a list of the fields that are not to be printed
by <code>bbdb-print</code>. It defaults to:<br>
</p><p align="center"> <code>(omit tex-name aka mail-alias)</code>
</p>
</dd>
<dt> <code>bbdb-print-file-name</code></dt>
<dd><a name="IDX200"></a>
<p>The name of the file where generated TeX output is to be stored. The default
is <tt>`~/bbdb.tex'</tt>.
</p>
</dd>
<dt> <code>bbdb-print-require</code></dt>
<dd><a name="IDX201"></a>
<p>The fields required for printing a record. This allows, for example, only
records with phone numbers to be printed. The value of the value of the
variable will be evaluated once for each record, and the record will be
printed only if the evaluation returns a non-nil value. The symbols
<code>name</code>, <code>company</code>, <code>net</code>, <code>phone</code>, <code>address</code>, and
<code>notes</code> will be set to the appropriate values during evaluation; they
will be nil if the field does not exist or is elided.
</p>
<p>The value of this variable can be any lisp expression, but typically
it will be used for a boolean combination of the field variables, as
in the following simple examples:
</p>
<ul>
<li> Print only people whose phone numbers are known:<br>
<p align="center"> <code>(setq bbdb-print-require 'phone)</code>
</p></li><li> Print people whose names AND companies are known:<br>
<p align="center"> <code>(setq bbdb-print-require '(and name company))</code>
</p></li><li> Print people whose names, and either addresses OR phone numbers are
known:<br>
<p align="center"> <code>(setq bbdb-print-require '(and name (or address phone))).</code>
</p>
<p>The default value is:<br>
</p><p align="center"> <code>(or address phone)</code>
</p></li></ul>
</dd>
<dt> <code>bbdb-print-alist</code></dt>
<dd><a name="IDX202"></a>
<p>Formatting options for all formats of <code>bbdb-print</code>. The value is an
alist of the form<br>
</p><p align="center"> <code>((<var>OPTION</var> . <var>VALUE</var>) (<var>OPTION</var> . <var>VALUE</var>) ...)</code>
</p>
<p>Separate settings can be configured using <code>bbdb-print-brief-alist</code> and
<code>bbdb-print-full-alist</code>. Settings in these variables will override the
ones in <code>bbdb-print-alist</code>.
</p>
<p>The possible options and legal settings are:
</p><dl compact="compact">
<dt> <code>columns</code></dt>
<dd><p><code>1</code>, <code>2</code>, <code>3</code>, <code>4</code>, <code>quad</code> (4 little
2-column pages per sheet) or <code>grid</code> (12 credit-card-sized pages per
sheet).
</p>
</dd>
<dt> <code>separator</code></dt>
<dd><p><code>0</code>-<code>7</code>, the style of heading for each letter. <code>0</code>=none,
<code>1</code>=line, <code>2</code>=boxed letters, <code>3</code>=large boxed letters,
<code>4</code>=large letters, <code>5</code>=letters with lines, <code>6</code>=letters with
suits, <code>7</code>=boxed letters with suits.
</p>
</dd>
<dt> <code>omit-area-code</code></dt>
<dd><p>A regular expression matching area codes to omit.
</p>
</dd>
<dt> <code>phone-on-first-line</code></dt>
<dd><p>If <code>t</code>, the first phone number will be put on the same line as the name.
If <code>nil</code>, the name will be the only text on the line. If set to a
string, the field of type <code>phone</code> whose name matches the string will be
used. The string should be a valid regular expression.
</p>
</dd>
<dt> <code>n-phones</code></dt>
<dd><p>Maximum number of phone numbers to include.
</p>
</dd>
<dt> <code>n-addresses</code></dt>
<dd><p>Maximum number of addresses to include.
</p>
</dd>
<dt> <code>include-files</code></dt>
<dd><p>List of TeX files to <code>\input</code>. If the filenames are not absolute, the
files must be located somewhere in the TeX input path.
</p>
</dd>
<dt> <code>ps-fonts</code></dt>
<dd><p>Postscript fonts (TimesNewRoman and Courier) will be used if the value
is non-<code>nil</code>. Standard TeX fonts (ec-fonts) will be used
otherwise.
</p>
</dd>
<dt> <code>font-size</code></dt>
<dd><p>The integer point size of the font to be used.
</p>
</dd>
<dt> <code>hsize</code></dt>
<dd><p>The horizontal dimension of the pages. The value must be a string, and must
be a valid TeX dimension. Alternatively, the TeX default will be used if the
value is <code>nil</code>.
</p>
</dd>
<dt> <code>vsize</code></dt>
<dd><p>The vertical dimension of the pages. The value must be a string, and must
be a valid TeX dimension. Alternatively, the TeX default will be used if the
value is <code>nil</code>.
</p>
</dd>
<dt> <code>hoffset</code></dt>
<dd><p>The TeX output will be offset to the right by the value of this option. The
value must be either a string containing a valid TeX dimension or <code>nil</code>
or <code>0</code> to use the default TeX horizontal offset.
</p>
</dd>
<dt> <code>voffset</code></dt>
<dd><p>The TeX output will be offset downward by the value of this option. The
value must be either a string containing a valid TeX dimension or <code>nil</code>
or <code>0</code> to use the default TeX vertical offset.
</p>
</dd>
<dt> <code>quad-hsize</code></dt>
<dd><p>Horizontal size to be used for the individual pages in the quad format. The
value must be a string containing a valid TeX dimension.
</p>
</dd>
<dt> <code>quad-vsize</code></dt>
<dd><p>Vertical size to be used for the individual pages in the quad format. The
value must be a string containing a valid TeX dimension.
</p></dd>
</dl>
<p>The default value is
</p><table><tr><td> </td><td><pre class="example">((omit-area-code . "(<var>AREA-CODE</var>)")
(phone-on-first-line . "^[ \t]*$")
(ps-fonts . nil)
(font-size . 6)
(quad-hsize . "3.15in")
(quad-vsize . "4.5in"))
</pre></td></tr></table>
<p>Where <var>AREA-CODE</var> is the value of <code>bbdb-default-area-code</code> or
<samp>`000'</samp> if there is no default area code.
</p>
</dd>
<dt> <code>bbdb-print-brief-alist</code></dt>
<dd><a name="IDX203"></a>
<p>Extra options for the <code>bbdb-print</code> brief format. The value(s) of
this variable can either supplement or override the values in
<code>bbdb-print-alist</code>. The format and possible values of this variable are
as in <code>bbdb-print-alist</code>, described above.
</p>
<p>The default value is
</p><table><tr><td> </td><td><pre class="example">((columns . 1)
(separator . 1)
(n-phones . 2)
(n-addresses . 1)
(include-files "bbdb-print-brief" "bbdb-cols"))
</pre></td></tr></table>
</dd>
<dt> <code>bbdb-print-full-alist</code></dt>
<dd><a name="IDX204"></a>
<p>Extra options for the <code>bbdb-print</code> non-brief format. The value(s) of
this variable can either supplement or override the values in
<code>bbdb-print-alist</code>. The format and possible values of this variable are
as in <code>bbdb-print-alist</code>, described above.
</p>
<p>The default value is
</p><table><tr><td> </td><td><pre class="example">((columns . 3)
(separator . 2)
(include-files "bbdb-print" "bbdb-cols"))
</pre></td></tr></table>
</dd>
<dt> <code>bbdb-print-prolog</code></dt>
<dd><a name="IDX205"></a>
<p>TeX statements to include at the beginning of the <code>bbdb-print</code> output
file.
</p>
</dd>
<dt> <code>bbdb-print-epilog</code></dt>
<dd><a name="IDX206"></a>
<p>TeX statements to include at the end of the <code>bbdb-print</code> output file.
</p>
</dd>
</dl>
<hr size="6">
<a name="bbdb_002dsnarf"></a>
<a name="SEC65"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC64" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC66" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC62" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.8.3 <code>bbdb-snarf</code> </h3>
<p><code>bbdb-snarf</code> provides the ability to generate <b>BBDB</b> records from raw
text. If invoked as <code>bbdb-snarf</code>, it attempts to generate the record
from the information around point (the cursor). If invoked as
<code>bbdb-snarf-region</code><a name="DOCF6" href="bbdb_fot.html#FOOT6">(6)</a>, the active region is used to generate the record.
</p>
<p><b>Restrictions:</b>
</p>
<ol>
<li>
<code>bbdb-snarf</code> currently recognizes only US-style phone numbers.
</li><li>
<code>bbdb-snarf</code> works best with things that look like mailing addresses.
</li></ol>
<p>Example of an address that <code>bbdb-snarf</code> will recognize:
</p>
<table><tr><td> </td><td><pre class="example">another test person
1234 Gridley St.
Los Angeles, CA 91342
555-1212
test@person.net
http://www.foo.bar/
other stuff about this person
</pre></td></tr></table>
<hr size="6">
<a name="bbdb_002dsrv"></a>
<a name="SEC66"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC65" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC67" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC62" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.8.4 <code>bbdb-srv</code> </h3>
<p><code>bbdb-srv</code> provides the ability to initiate the display of <b>BBDB</b>
records from outside of Emacs. This allows external programs to cause
the <b>BBDB</b> record for a given person to appear in the running Emacs
when, for example, mail is recieved from that person. One specific
application, described below, is the integration of Netscape and the
<b>BBDB</b>, allowing the display of <b>BBDB</b> records corresponding to Mail
and/or News messages displayed in Netscape.
</p>
<p><code>bbdb-srv</code> is composed of two parts - an external Perl script
(<tt>`utils/bbdb-srv.pl'</tt>), and an Emacs Lisp file
(<tt>`lisp/bbdb-srv.el'</tt>). The external portion is used to send
commands to the internal portion.
</p>
<p><b>NOTE:</b> <code>bbdb-srv</code> requires <code>gnuserv</code> and <code>itimer</code>,
both included with XEmacs. <code>gnuserv</code> must be started with the
<code>gnuserv-start</code> command before <code>bbdb-srv</code> can be used.
</p>
<p>In it's most basic form, mail or news headers are passed to the Perl
script. The Perl script then causes the <b>BBDB</b> record (if any)
corresponding to the passed headers to be displayed in the running
Emacs. While <code>bbdb-srv</code> will operate with just a <samp>`From:'</samp>
field, it works better when passed both <samp>`From:'</samp> and <samp>`To:'</samp>
headers. When <code>bbdb-srv</code> notices that the logged-in user is named
in the <samp>`From:'</samp> header, it will attempt to display the record (if
any) for the person named in the <samp>`To:'</samp> header. If no <samp>`To:'</samp>
header is passed, it falls back on the record (if any) for the logged-in
user (the person named in the <samp>`From:'</samp> header).
</p>
<p>An example manual invocation of <code>bbdb-srv</code> is as follows:
</p>
<table><tr><td> </td><td><pre class="example">% cat |bbdb-srv.pl
From: Jamie Zawinski <jwz@netscape.com>
To: Matt Simmons <simmonmt@acm.org>
<kbd>CTRL-D</kbd>
</pre></td></tr></table>
<p>If the invoking user is Jamie Zawinski, the record for Matt Simmons (if
any) will be displayed. If the invoking user is not Jamie Zawinski, the
record for Jamie Zawinski (if any) will be displayed.
</p>
<p>As mentioned above <code>bbdb-srv</code> can be used with Netscape Mail and
Netscape News. Please note that it can only be used with the UNIX
versions 3.0b2 and greater of these applications. To allow Netscape to
use <code>bbdb-srv</code>, set the <samp>`NS_MSG_DISPLAY_HOOK'</samp> variable to
<code>bbdb-srv.pl</code><a name="DOCF7" href="bbdb_fot.html#FOOT7">(7)</a> as follows:
</p>
<p>Bourne Shell (<tt>`/bin/sh'</tt>) and variants:
</p><table><tr><td> </td><td><pre class="example"># NS_MSG_DISPLAY_HOOK bbdb-srv.pl
# export NS_MSG_DISPLAY_HOOK
</pre></td></tr></table>
<p>C-Shell (<tt>`/bin/csh'</tt>) and variants:
</p><table><tr><td> </td><td><pre class="example">% setenv NS_MSG_DISPLAY_HOOK bbdb-srv.pl
</pre></td></tr></table>
<p>The following variables can be used to customize the behavior of
<code>bbdb-srv</code>:
</p>
<dl compact="compact">
<dd><a name="IDX207"></a>
</dd>
<dt> <code>bbdb/srv-auto-create-p</code></dt>
<dd><p>This variable is similar to <code>bbdb/news-auto-create-p</code> and
<code>bbdb/mail-auto-create-p</code>. That is, when headers are passed in to
<code>bbdb-srv</code>, a new <b>BBDB</b> record can be created if none exists,
depending on the value of this variable. Possible values are:
</p><dl compact="compact">
<dt> <code>t</code></dt>
<dd><p>Automatically create new <b>BBDB</b> records if the headers passed in do
not correspond to an already-existing record.
</p></dd>
<dt> <code>nil</code></dt>
<dd><p>Do not automatically create new <b>BBDB</b> records.
</p></dd>
<dt> <var>FUNCTION</var></dt>
<dd><p><var>FUNCTION</var> is called. If it returns <code>t</code>, a record will be
created for the person named in the <samp>`From:'</samp> header. If it returns
<code>nil</code>, no record will be created.
</p>
<p>A suggested function for use is
<code>bbdb/srv-auto-create-mail-news-dispatcher</code>. This function will
attempt to determine the source of the passed headers - whether they
were part of a mail message or of a news article. The action (if any)
dictated by the value of either <code>bbdb/mail-auto-create-p</code> or
<code>bbdb/news-auto-create-p</code>, based on the determined source of the
passed headers.
</p>
</dd>
</dl>
<a name="IDX208"></a>
</dd>
<dt> <code>bbdb/srv/display-delay</code></dt>
<dd><p><code>bbdb-srv</code> pauses between displaying the records corresponding to
each passed set of headers. This variable controls the length of time
(in seconds) of the delay between the display of different records.
Note when setting this variable that only one set of headers can be
queued at a time. If three sets of headers are passed to
<code>bbdb-srv</code> in less than the delay time, only the first and last
will be displayed.
</p></dd>
</dl>
<hr size="6">
<a name="Internals"></a>
<a name="SEC67"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC66" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC68" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 1.9 Internals </h2>
<p><b>This section is currently a dumping ground for things that should
eventually go here, but were found elsewhere in the file.</b>
</p>
<p><b>INFORMATION IN THIS SECTION IS FOR INFORMATIONAL PURPOSES ONLY. IT
SHOULD NOT BE TAKEN AS DOCUMENTATION OF AN EXTERNAL API. EVERYTHING
LISTED BELOW IS SUBJECT TO CHANGE WITHOUT NOTICE</b>
</p>
<p>The first time you use
one of the <b>BBDB</b> commands, this file is read into an emacs buffer, and
remains there. As you make changes to the database, this buffer is
changed as well, ensuring that if it is auto-saved, it will be saved in
its most current state.
</p>
<hr size="6">
<a name="SEC68"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC67" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC69" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC67" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.9.1 BBDB data file format </h3>
<p>The data file is arranged in a hierarchical fashion. At the top level
are vectors, with one vector per database record. It is <b>very</b>
important that each vector be on its own line, as the BBDB builds and
stores markers based on this layout. The markers are then used to
increase the speed of database modifications (more on this later). The
record vectors contain the individual fields of the record. These
fields can be of any type, but are currently integers, strings, lists of
strings, alists, vectors, or lists of vectors. In the case of fields
that contain one or more vectors, they can be further broken down in
terms of the fields of their component vectors.
</p>
<p>In an effort to provide a more concrete example to illustrate the above,
and to provide a reference for database accessor and modifier functions,
we describe the database format below. This description starts with the
fields of the individual record vectors, and drills down through the
vectors used by some of the fields.
</p>
<hr size="6">
<a name="SEC69"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC68" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC70" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC68" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 1.9.1.1 Record Vectors </h4>
<table>
<tr><td><p> <b>Name</b>
</p></td><td><p> <b>Type</b>
</p></td><td><p> <b>Accessor and Modifier</b>
</p></td><td><p> <b>Description</b>
</p>
</td></tr>
<tr><td><p> First name
</p></td><td><p> String
</p></td><td><p> <code>bbdb-record-firstname</code><br>
<code>bbdb-record-set-firstname</code>
</p></td><td><p> Entity's first name
</p>
</td></tr>
<tr><td><p> Last name
</p></td><td><p> String
</p></td><td><p> <code>bbdb-record-lastname</code><br>
<code>bbdb-record-set-lastname</code>
</p></td><td><p> Entity's last name
</p>
</td></tr>
<tr><td><p> AKAs
</p></td><td><p> List of Strings
</p></td><td><p> <code>bbdb-record-aka</code><br>
<code>bbdb-record-set-aka</code>
</p></td><td><p> Alternate names for entity
</p>
</td></tr>
<tr><td><p> Company
</p></td><td><p> String
</p></td><td><p> <code>bbdb-record-company</code><br>
<code>bbdb-record-set-company</code>
</p></td><td><p> Company with which entity is associated
</p>
</td></tr>
<tr><td><p> Phones
</p></td><td><p> List of Vectors
</p></td><td><p> <code>bbdb-record-phones</code><br>
<code>bbdb-record-set-phones</code>
</p></td><td><p> List of phone number vectors
</p>
</td></tr>
<tr><td><p> Addresses
</p></td><td><p> List of Vectors
</p></td><td><p> <code>bbdb-record-addresses</code><br>
<code>bbdb-record-set-addresses</code>
</p></td><td><p> List of address vectors
</p>
</td></tr>
<tr><td><p> Net address
</p></td><td><p> List of Strings
</p></td><td><p> <code>bbdb-record-net</code><br>
<code>bbdb-record-set-net</code>
</p></td><td><p> List of network addresses
</p>
</td></tr>
<tr><td><p> Notes
</p></td><td><p> String or Alist
</p></td><td><p> <code>bbdb-record-raw-notes</code><br>
<code>bbdb-record-set-raw-notes</code>
</p></td><td><p> String or Association list of note fields (strings)
</p>
</td></tr>
<tr><td><p> Cache
</p></td><td><p> Vector
</p></td><td><p> <code>bbdb-record-cache</code><br>
<code>bbdb-record-set-cache</code>
</p></td><td><p> Record cache.<br>
<i>Internal version only.</i>
</p>
</td></tr>
</table>
<p>The phone, address and cache vector fields are described below. Please
note that, as indicated in the table above, the cache is present only in
the internal version of the database - it is not written out as part of
the <tt>`.bbdb'</tt> file.
</p>
<p>In addition, the accessor and modifier functions for the notes alist
are described.
</p>
<hr size="6">
<a name="SEC70"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC69" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC71" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC68" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 1.9.1.2 Phone Vectors </h4>
<p>To access the fields in the below table, you must first get the list of
phone vectors using the <code>bbdb-record-phones</code> function. Note that
if you alter the phones field with the <code>bbdb-record-set-phones</code>
function, you are altering the entire phones list for the given record.
Use the modifier functions below for modifications to individual phone
vectors.
</p>
<table>
<tr><td><p> <b>Name</b>
</p></td><td><p> <b>Type</b>
</p></td><td><p> <b>Accessor and Modifier</b>
</p></td><td><p> <b>Description</b>
</p>
</td></tr>
<tr><td><p> Location
</p></td><td><p> String
</p></td><td><p> <code>bbdb-phone-location</code><br>
<code>bbdb-phone-set-location</code>
</p></td><td><p> Phone number identifier
</p>
</td></tr>
<tr><td><p> Area
</p></td><td><p> Integer
</p></td><td><p> <code>bbdb-phone-area</code><br>
<code>bbdb-phone-set-area</code>
</p></td><td><p> Area code for phone number
</p>
</td></tr>
<tr><td><p> Exchange
</p></td><td><p> Integer
</p></td><td><p> <code>bbdb-phone-exchange</code><br>
<code>bbdb-phone-set-exchange</code>
</p></td><td><p> Exchange (aka prefix) for phone number
</p>
</td></tr>
<tr><td><p> Suffix
</p></td><td><p> Integer
</p></td><td><p> <code>bbdb-phone-suffix</code><br>
<code>bbdb-phone-set-suffix</code>
</p></td><td><p> Suffix for phone number
</p>
</td></tr>
<tr><td><p> Extension
</p></td><td><p> Integer
</p></td><td><p> <code>bbdb-phone-extension</code><br>
<code>bbdb-phone-set-extension</code>
</p></td><td><p> Phone number extension (<samp>`0'</samp> if none)
</p>
</td></tr>
</table>
<hr size="6">
<a name="SEC71"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC70" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC72" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC68" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 1.9.1.3 Address Vectors </h4>
<p>To access the fields in the below table, you must first get the list of
address vectors using the <code>bbdb-record-addresses</code> function. Note
that if you alter the addresses field with the
<code>bbdb-record-set-addresses</code> function, you are altering the entire
addresses list for the given record. Use the modifier functions below
for modifications to individual address vectors.
</p>
<table>
<tr><td><p> <b>Name</b>
</p></td><td><p> <b>Type</b>
</p></td><td><p> <b>Accessor and Modifier</b>
</p></td><td><p> <b>Description</b>
</p>
</td></tr>
<tr><td><p> Location
</p></td><td><p> String
</p></td><td><p> <code>bbdb-address-location</code><br>
<code>bbdb-address-set-location</code>
</p></td><td><p> Address identifier
</p>
</td></tr>
<tr><td><p> Streets
</p></td><td><p> List
</p></td><td><p> <code>bbdb-address-streets</code><br>
<code>bbdb-address-set-streets</code>
</p></td><td><p> List of street address lines. <code>nil</code> if none.
</p>
</td></tr>
<tr><td><p> Street3
</p></td><td><p> String
</p></td><td><p> <code>bbdb-address-street3</code><br>
<code>bbdb-address-set-street3</code>
</p></td><td><p> Third line of street address. "" if none.
</p>
</td></tr>
<tr><td><p> City
</p></td><td><p> String
</p></td><td><p> <code>bbdb-address-city</code><br>
<code>bbdb-address-set-city</code>
</p></td><td><p> City name
</p>
</td></tr>
<tr><td><p> State
</p></td><td><p> String
</p></td><td><p> <code>bbdb-address-state</code><br>
<code>bbdb-address-set-state</code>
</p></td><td><p> State abbreviation
</p>
</td></tr>
<tr><td><p> Zip
</p></td><td><p> Integer (american)
List (non-american)
</p></td><td><p> <code>bbdb-address-zip</code><br>
<code>bbdb-address-set-zip</code>
</p></td><td><p> Zip code
</p>
</td></tr>
<tr><td><p> Country
</p></td><td><p> String
</p></td><td><p> <code>bbdb-address-country</code><br>
<code>bbdb-address-set-country</code>
</p></td><td><p> Country
</p>
</td></tr>
</table>
<hr size="6">
<a name="SEC72"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC71" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC73" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC68" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 1.9.1.4 Cache Vector </h4>
<p>This vector is present only in the internal database representation. It
is not written out to the database file because it contains information
aggregated from the rest of the record that is reconstructed when the
database is read. To write the cache information to the database file
would increase the risk of database inconsistency, and would violate the
principles of normalization.
</p>
<p>To access the cache fields using the functions listed below that begin
with <code>bbdb-cache-</code>, you must first get the cache vector using the
<code>bbdb-record-cache</code> function. The functions that begin with
<code>bbdb-record-</code> get the cache vector internally. Note that if you
alter the cache field in the high-level record with the
<code>bbdb-record-set-cache</code> function, you are altering the entire cache
vector for the given record. Use the modifier functions below for
modifications to individual cache fields.
</p>
<table>
<tr><td><p> <b>Name</b>
</p></td><td><p> <b>Type</b>
</p></td><td><p> <b>Accessor and Modifier</b>
</p></td><td><p> <b>Description</b>
</p>
</td></tr>
<tr><td><p> Name Cache
</p></td><td><p> String
</p></td><td><p> <code>bbdb-cache-namecache</code><br>
<code>bbdb-cache-set-namecache</code>
</p></td><td><p> Preconcatenated name of entity
</p>
</td></tr>
<tr><td><p> Sort Key
</p></td><td><p> String
</p></td><td><p> <code>bbdb-cache-sortkey</code><br>
<code>bbdb-cache-set-sortkey</code>
</p></td><td><p> Preconcatenated sort key for record
</p>
</td></tr>
<tr><td><p> Marker
</p></td><td><p> Marker
</p></td><td><p> <code>bbdb-cache-marker</code><br>
<code>bbdb-record-marker</code><br>
<code>bbdb-cache-set-marker</code><br>
<code>bbdb-record-set-marker</code><br>
</p></td><td><p> Marker in <tt>`.bbdb'</tt> for start of record
</p>
</td></tr>
<tr><td><p> Deleted
</p></td><td><p> Boolean
</p></td><td><p> <code>bbdb-cache-deleted-p</code><br>
<code>bbdb-record-deleted-p</code><br>
<code>bbdb-cache-set-deleted-p</code><br>
<code>bbdb-record-set-deleted-p</code>
</p></td><td><p> Set to <code>t</code> if record has been deleted, <code>nil</code> if not
</p>
</td></tr>
</table>
<p>The functions listed above will return <code>nil</code> if their respective
cache fields are not set. The functions listed below will return the
value of their cache fields if set, but will also build (and set) the
correct field values if the fields are unset:
</p>
<dl compact="compact">
<dt> <code>bbdb-record-name</code></dt>
<dd><p>Return the name in the Name Cache field of the cache (if set). If
the name has not been built yet (if the field is <code>nil</code>), the name is
built, stored in the Name Cache field, and returned.
</p>
</dd>
<dt> <code>bbdb-record-sortkey</code></dt>
<dd><p>Return the name it the Sort Key field of the cache (if set). If the
Sort Key field has not yet been set (if the field is <code>nil</code>), the
Sort Key is built, stored in the Sort Key field, and returned.
</p>
</dd>
</dl>
<hr size="6">
<a name="SEC73"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC72" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC74" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC68" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 1.9.1.5 Notes String or Alist </h4>
<p>If there is only a single note for a given record, the notes field for
that record will be a string. If there is more than one note, the notes
field will be an association list (alist) with elements of the form
</p>
<p align="center"> ( <var>NAME</var> . <var>VALUE</var> )
</p>
<p>where <var>NAME</var> is the symbol for the name of the note, and
<var>VALUE</var> is the value of the note.
</p>
<hr size="6">
<a name="SEC74"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC73" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC75" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC68" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 1.9.1.6 Example BBDB record </h4>
<hr size="6">
<a name="Mailing-Lists"></a>
<a name="SEC75"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC74" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC76" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 1.10 Mailing Lists </h2>
<p>(If you are looking for a way to create mailing lists with <b>BBDB</b>, you
should be looking at the section on See section <a href="#SEC39">Mail Sending Interfaces</a>.)
</p>
<p>There are three mailing lists for the <b>BBDB</b>.
<code>bbdb-info@lists.sourceforge.net</code> gets moderate traffic, and is
intended for the discussion and distribution of development versions of
the <b>BBDB</b>. Users of development versions of the <b>BBDB</b> should be
subscribed to this list. It is also to this list that bugs should be
reported. See section <a href="#SEC83">Known Bugs</a>. for instructions on submitting bug reports.
</p>
<p>The second mailing list <code>bbdb-announce@lists.sourceforge.net</code> has
very low volume. Any user of the <b>BBDB</b> should consider subscribing to
this list, as new releases and security issues will be posted here.
</p>
<p>A third mailing list, <code>bbdb-cvs@lists.sourceforge.net</code>, is
intended for developers to follow the changes made to the <b>BBDB</b>
development version. Developers of the <b>BBDB</b> should consider to
subscribe to this list.
</p>
<hr size="6">
<a name="Changes"></a>
<a name="SEC76"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC75" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC77" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 1.11 Changes in this Version </h2>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC77">1.11.1 Major Changes</a></td><td> </td><td align="left" valign="top"> Major changes in this version
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC79">1.11.2 Other Changes</a></td><td> </td><td align="left" valign="top"> Not-so-major changes
</td></tr>
</table>
<hr size="6">
<a name="Major-Changes"></a>
<a name="SEC77"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC76" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC79" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC76" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.11.1 Major Changes </h3>
<a name="SEC78"></a>
<h4 class="subsubheading"> Database File Version Change </h4>
<p>(the following version-migration text will move in a future version. It is in
this section currently because new users will likely not experience it)
</p>
<p>There has been a version change in the <b>BBDB</b> database file. The new
version supports non-US zip codes, and an additional "Country" field
in addresses.
</p>
<p>An automatic version-migration mechanism has been implemented that allows
older version <tt>`.bbdb'</tt> files to either be migrated to the new version, or
used as-is without migrating. When the <b>BBDB</b> detects a database file with
an old version, it will display the features that have been introduced <b>in
the database file</b> from the time of the older version's implementation. It
will offer the choice of migration or use of the <b>BBDB</b> with the
older-version file.
</p>
<p>If migration is chosen, the database file will be automatically changed to the
new format. If migration is declined, the file will kept in the older format
in the <code>.bbdb</code> buffer, but will be stored internally in the new format.
When changes need to be made to the <code>.bbdb</code> buffer, changed records will
be reverse-migrated from their internal version to that of the disk file.
</p>
<hr size="6">
<a name="Other-Changes"></a>
<a name="SEC79"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC77" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC81" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC76" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.11.2 Other Changes </h3>
<a name="SEC80"></a>
<h4 class="subsubheading"> TeX Output </h4>
<p>By default, ec fonts are used for TeX output instead of cm fonts. With
the <code>ps-fonts</code> option set in <code>bbdb-print-alist</code>, TimesNewRoman
and Courier fonts are used.
</p>
<ul>
</ul>
<hr size="6">
<a name="The-Latest-Version"></a>
<a name="SEC81"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC79" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC82" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 1.12 The Latest Version </h2>
<p>Released versions of the <b>BBDB</b> can be found at the
following site:
</p>
<ul>
<li>
WWW: <code>http://bbdb.sourceforge.net</code>
</li><li>
FTP: <code>ftp://ftp.sourceforge.net/pub/bbdb</code>
</li></ul>
<p>Development versions of the <b>BBDB</b> can be obtained in the
following ways:
</p>
<ul>
<li>
WWW: <code>http://bbdb.sourceforge.net</code>
</li><li>
Anonymous CVS: See <code>http://bbdb.sourceforge.net</code> for instructions.
</li></ul>
<p>Users of development versions of the <b>BBDB</b> should subscribe to the
<code>bbdb-info</code> mailing list. See section <a href="#SEC75">Mailing Lists</a>.
</p>
<hr size="6">
<a name="The-Future"></a>
<a name="SEC82"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC81" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC83" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 1.13 The Future </h2>
<p>The future consists of Bugs and Features.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC83">1.13.1 Known Bugs</a></td><td> </td><td align="left" valign="top"> Known Bugs, and how to submit new ones
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC84">1.13.2 TODO List</a></td><td> </td><td align="left" valign="top"> The TODO List
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC88">1.13.3 End of Life (EOL) Statements</a></td><td> </td><td align="left" valign="top"> EOL (End Of Life) Statements
</td></tr>
</table>
<hr size="6">
<a name="Known-Bugs"></a>
<a name="SEC83"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC82" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC82" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.13.1 Known Bugs </h3>
<ol>
<li>
<b><kbd>M-TAB</kbd> conflicts with ispell.</b> Workaround: The binding
installed by the <b>BBDB</b> for address completion/expansion conflicts with
that used by ispell. The suggested workarounds are to rebind the ispell
key (the <b>BBDB</b> binding is not configurable at this time), to manually
invoke ispell via <kbd>M-x</kbd>, or to not use ispell completion functionality
in <b>BBDB</b>-enabled message composition buffers. The following is an
example of such a rebinding, supplied by Kai Gro�johan:
<table><tr><td> </td><td><pre class="lisp">(defun my-message-mode-keys ()
(define-key message-mode-map (kbd "M-TAB") 'bbdb-complete-name))
(add-hook 'message-mode-hook 'my-message-mode-keys)
</pre></td></tr></table>
</li><li>
<b><b>BBDB</b> and abbrev expansion is inconsistent.</b> Workaround:
Currently, <kbd>M-TAB</kbd> must be used to expand/complete against <b>BBDB</b>
names and net addresses, and <kbd>TAB</kbd> must be used to expand abbrevs (the
values in the <code>mail-alias</code> field). Unification is planned for a
future version.
</li><li>
<b>The <code>*BBDB*</code> buffer does not always come up when the first
article in a Gnus Summary Buffer is selected.</b> Workaround: Pressing
<kbd>g</kbd> to reload the article. This will cause the <code>*BBDB*</code> buffer
to be displayed.
</li><li>
<b>Expansion will fail when the name to be expanded is a subset of
the name for another record.</b> For example, if you have entries for
<samp>`John'</samp> and <samp>`Johnathan'</samp>, you will not be able to expand the
name for <samp>`John'</samp>. Workaround: Use the net address for the subset
name (<samp>`John'</samp> in this example).
</li></ol>
<a name="IDX209"></a>
<p>It is commonly known that there are no bugs in the <b>BBDB</b>. Bugs
found in defiance of this rule should be submitted using <kbd>M-x
bbdb-submit-bug-report</kbd>. These bug reports will bbe sent to the
<code>bbdb-info</code> mailing list (see section <a href="#SEC75">Mailing Lists</a>) and are
available from public archives. Other big brothers may be reading
your bug reports.
</p>
<hr size="6">
<a name="TODO-List"></a>
<a name="SEC84"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC83" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC88" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC82" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.13.2 TODO List </h3>
<a name="SEC85"></a>
<h4 class="subsubheading"> The Near Future </h4>
<ul>
<li>
Add bbdb/<i>MUA</i>-delete-sender-record
</li><li>
Configurable completion. Should allow user to specify "complete on
names first, then nets", etc.
</li><li>
More variables for upgrading. Specifically a variable that lets users
specify extra fields for upgrading (an alist <samp>`(a . b)'</samp> that says
field <samp>`a'</samp> should be upgraded the same way as field <samp>`b'</samp>.
</li><li>
Change all functions that switch on MUAs to use compose-mail (ex:
<code>bbdb-send-mail-internal</code>).
</li><li>
Soren Dayton's method for generically extending the <b>BBDB</b> with
special-purpose fields
</li><li>
Sorting records on alternate keys. <code>bbdb-sort-by</code> from Boris
Goldowsky.
</li><li>
Sorting individual types of fields - Sam Steingold's method.
</li><li>
Button 3 menus (Mark Moll and Soren Dayton)
</li><li>
Conditionalized erasure of properties when text is pasted into the <b>BBDB</b>.
</li><li>
Should notice when there are <samp>`Reply-To:'</samp> addresses.
</li><li>
Should have a command for merging together two divergent copies of
a <tt>`.bbdb'</tt> file (in case you read mail on one machine and news on
another, for instance.)
</li><li>
The <samp>`*BBDB*'</samp> buffer should be resized to exactly fit what it's
displaying, even when not in "electric" mode.
</li><li>
It should be possible to do completion on last names as well as first
names.
</li><li>
The BBDB buffer is left at the top of the stack when GNUS is exited
because GNUS runs its exit-hooks too early. This should be fixed.
</li><li>
String area codes (German area codes can begin with zeroes) patch from
<code>Michael Sperber <sperber@informatik.uni-tuebingen.de></code>
</li><li>
Default country variable, similar to <code>bbdb-default-area-code</code>.
</li><li>
Make format self-describing in comment
</li><li>
ISO-8859-x characters in records for printing.
</li><li>
Prefix for <kbd>W</kbd> (<code>bbdb-www</code>) command to allow selection of
different addresses.
</li><li>
Generalized buttons (via extents) for fields. Example: <samp>`(a . b)'</samp>
means create button that calls <samp>`b'</samp> for each entry in the <samp>`a'</samp>
field.
</li><li>
Remove support for GNUS. Start with lisp Makefile (remove nntp and gnus
loads).
</li><li>
More flexible auto-addition. Conditionalizing of addition (conditions
or supplied function). Prompt if multiple records that meet criteria exist.
</li><li>
Different output formats. See Toby Speight's <code><s8iurdodvm.fsf@plato.ansa.co.uk></code>
and Bin Mu's <code><199801221605.KAA23663@DerivaTech.Com></code>.
</li><li>
Generalized area-code-split program that could split, for example, based
on input copied (or straight fetch of page) from the Bellcore NANP page.
</li><li>
Print multivalue (comma-separated) fields with one value per line
</li><li>
Easier BBDB extension. See <code><xcdyb30f3hb.fsf@ra.cs.uchicago.edu></code>
from Soren Dayton.
</li><li>
Take birthdays from the <b>BBDB</b>, add them to calendar. From Boris
Goldowsky.
</li><li>
Make mail aliases file for other mailers. From Boris Goldowsky.
</li><li>
Various patches from Boris Goldowsky in <tt>`bbdb-ext'</tt>.
</li><li>
Various other patches:
<ul class="toc">
<li>-
<code>bbdb-filters-0.2</code>
</li><li>-
<code>bbdb-frame.el</code>
</li><li>-
<code>bbdb-letter-1.0</code>
</li><li>-
<code>bbdb-plz</code>
</li><li>-
<code>bbdb-query</code>
</li><li>-
<code>country</code>
</li><li>-
<code>country-info</code>
</li></ul>
<p>Note that these files have not been investigated. They may or
may not be incorporated.
</p>
</li><li>
Ability to remove all properties from copied strings.
</li></ul>
<a name="SEC86"></a>
<h4 class="subsubheading"> Not-So-Near Future </h4>
<ul>
<li>
Fix Gnus scoring so it rebuilds when gnus-score disappears
</li><li>
Multiline note fields
</li><li>
Change key to be some kind of unique number
</li><li>
There should be better support for non-American addresses and phone
numbers. This might be Near Future if somebody volunteers to send me patches.
</li><li>
Should reimplement "electric" mode to not be so broken.
</li><li>
The <kbd>*C-o</kbd> keystroke should add a field to all displayed records.
Perhaps <kbd>*;</kbd> should append some text to an arbitrary field of all
displayed records.
</li><li>
Multiple <tt>`.bbdb'</tt> files with precedence relationships. See Wes
Hardaker's <br><code><sdu3awz75a.fsf@oakdale.ucdavis.edu></code>
</li><li>
Automatically grab information about a person from their sig. See
Graham Clark's <code>info-bbdb</code> post
<code><6282.199706161624@havra.dcs.ed.ac.uk></code> and Adrian Aichner's
<code>info-bbdb</code> post
<code><rxsiuzebpgp.fsf@midnight.ecf.teradyne.com></code>. Would like to have
<code>bbdb-snarf</code> attack the sig then compare the snarfed data with the
header data.
</li></ul>
<a name="SEC87"></a>
<h4 class="subsubheading"> Thoughts </h4>
<ul>
<li>
Are there enough hooks?
</li><li>
The interfaces should share more code.
</li><li>
The <code>bbdb-create-internal</code> function should be more forgiving.
</li><li>
More <kbd>*</kbd> commands in general, including <kbd>*d</kbd>.
</li></ul>
<hr size="6">
<a name="EOL-Statements"></a>
<a name="SEC88"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC84" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC89" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC82" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 1.13.3 End of Life (EOL) Statements </h3>
<p>The items in the following list describe items for which support will be
removed in coming versions of the <b>BBDB</b>. The items listed are
guaranteed to be supported and present only until the EOL date. They
may be removed without warning at any time thereafter.
</p>
<ol>
<li>
<code>advertized-bbdb-delete-current-field-or-record</code><br>
Support for this function will be removed for version 2.2. It is
recommended that all code depending on this variable be switched to use
<code>bbdb-delete-current-field-or-record</code>. The two functions have the
same calling conventions and effects. This EOL statement was added for
version 2.1.
</li><li>
Support for the GNUS (not Gnus) newsreader<br>
The GNUS-specific parts of the <b>BBDB</b> will be actively removed for the
2.2 release. No further maintenance and/or bugfixes are planned for
GNUS code at this time. This EOL statement was added for version 2.1.
</li></ol>
<hr size="6">
<a name="Thanks"></a>
<a name="SEC89"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC88" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 1.14 Thanks </h2>
<p>Thanks to everyone on the info-bbdb mailing list for many useful
suggestions. This hack would be far less insidious without their input!
</p>
<a name="SEC90"></a>
<h3 class="subheading"> Thanks list for versions after 2.00.06. </h3>
<p>Thanks to Alex Schroeder, Ronan Waide, Thomas DeWeese, Robert Fenk,
Didier Verna, Bill Carpenter.
</p>
<a name="SEC91"></a>
<h3 class="subheading"> Thanks list for versions after 1.51 prior to and including 2.00.06. </h3>
<p>Thanks to Adrian Aichner, Kees de Bruin, David Carlton, Soren Dayton,
Brian Edmonds, Boris Goldowsky, Seth Golub, John Heidemann, Christopher
Kline, Carsten Leonhardt, Hrvoje Niksic, Jens-Ulrik Hoger Petersen,
Colin Rafferty, Matt Simmons, Sam Steingold, Marco Walther, Christoph
Wedler.
</p>
<a name="SEC92"></a>
<h3 class="subheading"> Thanks list for versions prior to and including 1.51. </h3>
<p>And special thanks to Sebastian Kremer, Joe Wells, Todd Kaufmann, Andy
Norman, Ivan Vazquez, Stewart Clamen, Roland McGrath, Dave Brennan,
Kimball Collins, Dirk Grunwald, Philippe Queinnec, Boris Putanec, Dave
Disser, Francois Felix Ingrand, Sean Owens, Guido Bosch, Lance Brown,
Tom Emerson, George Hartzell, Luis Miguel Silveira, Kimmo Suominen,
Derek Upham, David Zuhn, Rod Whitby, Richard Mlynarik.
</p>
<p>Last, but not least, thanks to Jamie Zawinski for writing <b>BBDB</b> in the
first place.
</p>
<hr size="6">
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="bbdb.html#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="bbdb.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_2.html#SEC93" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="bbdb_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<p>
<font size="-1">
This document was generated by <em>Joerg Jaspert</em> on <em>February, 4 2006</em> using <a href="http://texi2html.cvshome.org/"><em>texi2html 1.76</em></a>.
</font>
<br>
</p>
</body>
</html>
|
