]> git.deb.at Git - pkg/abook.git/blob - README
minor documentation updates
[pkg/abook.git] / README
1
2  ABOOK by JH <jheinonen@users.sourceforge.net>
3  -----
4
5 Abook is an addressbook program with mutt mail client support.
6
7 COMPILATION
8
9 To compile abook you must have ncurses developement libraries installed.
10 Starting from version 0.4.10 abook is known to compile with the native curses
11 library of SUN Solaris and OpenBSD. Since version 0.5.0 GNU readline is
12 required.
13
14 If you compile with --enable-debug flag you should redirect standard error
15 to somewhere. (for example abook 2> debug or abook 2> /dev/null. Abook has
16 been compiled and tested successfully on following platforms:
17 (NOTE: All versions of abook haven't been tested on all platforms.)
18
19 Linux (Debian GNU/Linux 2.1/2.2, RedHat 6.x)
20 Darwin
21 Solaris 2.4
22 Solaris 2.5
23 Solaris 2.6
24 FreeBSD 3.3 (newer versions should be OK)
25 OpenBSD
26 NetBSD (reportedly requires ncurses to work properly)
27 AIX 3.2.5
28 HPUX
29 Irix 6.5
30 DEC alpha ?
31 GNU/Hurd
32
33 INSTALLATION
34
35 See INSTALL for detailed instructions.
36
37 If you want to use abook with mutt you should add following lines to your
38 ~/.muttrc or to the systemwide /etc/Muttrc file.
39
40 set query_command="abook --mutt-query '%s'"
41 macro pager A |'abook --add-email'\n
42
43 After this you can make queries from mutt using the query command ('Q')
44 and add sender e-mail addresses to the addressbook from pager using 'A'
45 command. (Of course you can choose another keybinding if you like.)
46
47 It's also recommeded to set pipe_decode variable in mutt configuration.
48 See the mutt manual for details.
49
50 UPGRADING FROM VERSION 0.4
51
52 You must import your abook 0.4 addressbook file because it is stored
53 to a different location. Configuration file is now located to $HOME/.abook/
54 directory and it's called abookrc . (without leading dot)
55
56 NOTES
57
58 If your language specific characters don't work correctly make sure
59 that your locale configuration has been done properly. (On Linux you
60 must set at least LC_CTYPE environment variable)
61
62 If you want to import a ldif file generated by abook in Netscape you
63 must use the extension ``.4ld''.
64
65 OBTAINING ABOOK
66
67 Get the latest version from http://abook.sourceforge.net/
68
69 LICENSE
70
71 All files in this distribution are released under GNU GENERAL PUBLIC LICENSE.
72 See COPYING for details.
73
74 CONTACT AUTHOR
75
76 Send bugreports, fixes, wishes etc. to Jaakko Heinonen
77 <jheinonen@users.sourceforge.net> or use the mailing list.
78