post 0.5 update

[pkg/abook.git] / README

diff --git a/README b/README
index 9ff172f4c6ccf43018a15c6e5ddfbee01d1ed8dd..ffe2de92b2592b0426cf0b2588a9e1fc18ffdbb6 100644 (file)
--- a/README
+++ b/README
@@ -7,40 +7,54 @@ Abook is an addressbook program with mutt mail client support.
 COMPILATION
 
 To compile abook you must have ncurses developement libraries installed.
 COMPILATION
 
 To compile abook you must have ncurses developement libraries installed.

-Starting from version 0.4.10 abook is know to compile with the native curses
-library of SUN Solaris and OpenBSD.
+Starting from version 0.4.10 abook is known to compile with the native curses
+library of SUN Solaris and OpenBSD. Since version 0.5.0 GNU readline is
+required.

 
 

-If you compile with --enable-debug flag you should run abook like this:
-abook 2> debug or abook 2> /dev/null. Abook has been compiled and tested
-successfully on following platforms: (NOTE: All versions of abook haven't
-been tested on all platforms.)
+If you compile with --enable-debug flag you should redirect standard error
+to somewhere. (for example abook 2> debug or abook 2> /dev/null. Abook has
+been compiled and tested successfully on following platforms:
+(NOTE: All versions of abook haven't been tested on all platforms.)

 
 Linux (Debian GNU/Linux 2.1/2.2, RedHat 6.x)
 Solaris 2.4
 Solaris 2.5
 Solaris 2.6
 
 Linux (Debian GNU/Linux 2.1/2.2, RedHat 6.x)
 Solaris 2.4
 Solaris 2.5
 Solaris 2.6

-FreeBSD 3.3 (newer versions should work)
+FreeBSD 3.3 (newer versions should be OK)

 OpenBSD
 NetBSD (reportedly requires ncurses to work properly)
 AIX 3.2.5
 HPUX
 Irix 6.5
 DEC alpha ?
 OpenBSD
 NetBSD (reportedly requires ncurses to work properly)
 AIX 3.2.5
 HPUX
 Irix 6.5
 DEC alpha ?

+GNU/Hurd

 
 INSTALLATION
 
 See INSTALL for detailed instructions.
 
 
 INSTALLATION
 
 See INSTALL for detailed instructions.
 

-If you want to use abook with mutt you should add following line to your
+If you want to use abook with mutt you should add following lines to your

 ~/.muttrc or to the systemwide /etc/Muttrc file.
 
 set query_command="abook --mutt-query '%s'"
 ~/.muttrc or to the systemwide /etc/Muttrc file.
 
 set query_command="abook --mutt-query '%s'"

+macro pager A |'abook --add-email'\n

 
 

-After this you can make queries from mutt using the query command ( Q ).
+After this you can make queries from mutt using the query command ('Q')
+and add sender e-mail addresses to the addressbook from pager using 'A'
+command. (Of course you can choose another keybinding if you like.)
+
+It's also recommeded to set pipe_decode variable in mutt configuration.
+See the mutt manual for details.
+
+UPGRADING FROM VERSION 0.4
+
+You must import your abook 0.4 addressbook file because it is stored
+to a different location. Configuration file is now located to $HOME/.abook/
+directory and it's called abookrc . (without leading dot)

 
 NOTES
 
 
 NOTES
 

-If your language specific characters doesn't work correctly make sure
+If your language specific characters don't work correctly make sure

 that your locale configuration has been done properly. (On Linux you
 must set at least LC_CTYPE environment variable)
 
 that your locale configuration has been done properly. (On Linux you
 must set at least LC_CTYPE environment variable)
 


@@ -59,6 +73,5 @@ See COPYING for details.
 CONTACT AUTHOR
 
 Send bugreports, fixes, wishes etc. to Jaakko Heinonen
 CONTACT AUTHOR
 
 Send bugreports, fixes, wishes etc. to Jaakko Heinonen

-<jheinonen@users.sourceforge.net> or preferably use the mailing list. (See
-http://abook.sourceforge.net/ for details)
+<jheinonen@users.sourceforge.net> or use the mailing list.