

                          Appindex browser, version 0.7
                                 readme file

              Copyright(c)1999-2000 Martin Hinner <mhi@penguin.cz>
              $Id: README,v 0.7 2000/04/16 16:07:09 mhi Exp root $
              Homepage:       http://www.penguin.cz/~mhi/appindex/
              FTP:    ftp://ftp.penguin.cz/pub/users/mhi/appindex/

               This is appindex, Freshmeat appindex and Linux
                 Software Map offline ncurses-based browser.

            -------------------------------------------------

Compiling and installing
------------------------
  Simple type ./configure to prepare Makefiles, 'make all' to build appindex
and 'make install' to install it. All files are installed to /usr/bin, /usr/man
and /etc directory. If you'll have any problems with compiling/installing
please send me e-mail. I am using GNU binutils 2.9.1, egcs 2.91.66, flex 2.5.4
and bison 1.25 to compile this program. You can download some pre-compiled
binaries or RPM packages from my ftp directory. Debian package will be
available soon.

If you were using previous versions of appindex you can remove all appindex
files from /usr/local tree, because appindex is now installed to /usr/bin,
/usr/man, /etc and /var/lib/appindex directory.

This appindex distribution doesn't contain appindex database. You must download
it separately from the web or ftp. Use fetchappindex script to do this or
download it manually and put appindex.db.[bz2|gz] in the /var/lib/appindex/
directory. Note that older versions used appindex.txt file (from the
http://freshmeat.net/backend/ directory). This file is obsolete now, please
prefer appindex.db from ftp://ftp.penguin.cz/pub/users/mhi/db/ . Database is
generated daily at 7:13am MET-1DST.

LSM browser
-----------
This program can be used also as LSM database browser. The LSM is a directory
of information about each of the software packages available via FTP for the
Linux operating system. For more information see http://www.execpc.com/lsm/.

The LSM-part of appindex is not finished yet, nevertheless you can try it.
Download LSM.current.gz file from the LSM webpage, put it in the
/var/lib/appindex/ directory and run `appindex -l`.

Fulltext search
---------------
Appindex since version 0.7 supports "fulltext" search! Here are some examples:

author:mhi
author:mhi and filesystem
homepage:penguin.cz and name:print
name:vxtools
author:redhat.com or author:debian.org

Please note that you can substitute "and" with "&" and "or" with "|", so the
last expression may be: author:redhat.com|author:debian.org

Building binary packages
------------------------
If you successfully compiled appindex on your OS you can *simply* make binary
package for the others. After compiling and installing type `make binary'. It
should produce file called "../appindex-$(version)-$(arch).tar.bz2" (e.g.
appindex-0.5-i386-linux-gnu.tar.bz2). Send me this file with short
description (e.g. compiled on SPARC Solaris X.Y) please and I will put it on
ftp.penguin.cz.

Using
-----
 See appindex(1) manual page and source code.

Configuration
-------------
  For more information see /etc/appindex.conf file and appindex(1) manual page.
You may also find useful source code, specially appindex.l and appindex.y.

Thanks
------
  Thanks to Mike <logan@dct.com> for Solaris 7 patches and KELEMEN Peter
  <fuji@debian.org> for Debian package.

--
  Please send bug reports, comments and suggestions to <mhi@penguin.cz>.
