Upload 0.6.1-2 to unstable

[pkg/abook.git] / README

diff --git a/README b/README
index a46abe16fa7fcf73e0c1ef19708fe6f1a35bd870..e739b53527b74ed9e9f7e3fa6b76b646952bd7e3 100644 (file)
--- a/README
+++ b/README
@@ -1,45 +1,67 @@
 
- ABOOK by JH <jheinonen@bigfoot.com>
+ ABOOK by JH <jheinonen@users.sourceforge.net>
  -----
 
 Abook is an addressbook program with mutt mail client support.
 
 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.
-
-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.)
-
-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)
+To compile abook you must have ncurses development libraries installed.
+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. Please note that other readline implementations don't work.
+
+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 (distributions with moderately new GNU ncurses and GNU readline libraries
+       should work)
+Darwin
+Solaris
+FreeBSD
 OpenBSD
-NetBSD (reportedly requires ncurses to work properly)
+NetBSD
+GNU/Hurd
 AIX 3.2.5
-DEC alpha ?
+HPUX
 Irix 6.5
+DEC alpha ?
 
 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'"
+macro pager A |'abook --add-email'\n
+
+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 recommended to set pipe_decode variable in mutt configuration.
+See the mutt manual for details.
+
+Abook can also convert from/to mutt alias files and a number of other formats.
+Mutt groups are fully supported.
+
+UPGRADING FROM VERSION 0.5
+
+See RELEASE_NOTES .
+
+UPGRADING FROM VERSION 0.4
 
-After this you can make queries from mutt using the query command ( Q ).
+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
 
-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)
 
@@ -55,9 +77,8 @@ LICENSE
 All files in this distribution are released under GNU GENERAL PUBLIC LICENSE.
 See COPYING for details.
 
-CONTACT AUTHOR
+CONTACT AUTHORS
 
-Send bugreports, fixes, wishes etc. to Jaakko Heinonen <jheinonen@bigfoot.com>
-or preferably use the mailing list. (See http://abook.sourceforge.net/ for
-details)
+Send bugreports, fixes, wishes etc. to abook mailing list:
+https://lists.sourceforge.net/lists/listinfo/abook-devel