
			Katalog README
			
1. What is this?
Katalog is set of three sh scripts to manipulate CD catalogs.

2. katadd
It makes list of files at CD and writes it to a file. See: katadd -h.

3. katsch
Katsch is used to search for an regexp in bases. See: katsch -h.
    
4. katls
It gives you a list of currently installed databases. See: katls -h.

5. Settings
Katalog reads settings from files in following succession:
- /etc/katalogrc
- /usr/local/etc/katalogrc
- .katalogrc
- katalogrc
- $HOME/.katalogrc
Arguments given to program override settings from files.

6. Bases
All bases are stored in /usr/share/katalog by default. Every base has it's
own .dsc file with base description. Format of bases is veri simple. In one line
is location of one file on CD-ROM. Content of compressed file is separed with #
(hash). Example:
AfterStep/AfterStep-1.0.tar.gz#AfterStep-1.0/CHANGES
This means, that in archive AfterStep/AfterStep-1.0.tar.gz is file
AfterStep-1.0/CHANGES. It can take a lot of time to create a base with a lot of
compressed files and their contents, so You can turn off this feature. To save
space on disk, all bases are compressed with gzip or bzip2. You can define
program used to compress bases in configuration file, but only gzip and bzip2
are allowed.

7. Contents of compressed files.
If You decided so while creating base, then contents of compressed files (this
while .tar.gz, .tar.bz2, .zip and .rpm files are recognized) were saved to base
too. This means that for file foo.tgz not only his name was saved, but also:

foo.tgz#file1
foo.tgz#file2.txt
foo.tgz#bar/file3.doc

were saved (where file1, file2.txt and bar/file3.doc are part of foo.tgz
archive). Archive name is separated from its content with '#'.

8. Where to find current Katalog version?
Current version with GPG signature You can find here:
http://www.ceti.pl/eaquer/katalog/

9. Program GPG signature
You can verify source tarball with it's own GPG signature. You can find
signature at my home page:
http://www.ceti.pl/eaquer/katalog/katalog-VERSION.tar.bz2.asc
My GPG key is at http://www.ceti.pl/eaquer/pgp

10. Greetings
siva9 - for all ;-),
KaCzY - he found some bugs, ideas: use of bzip2, automount and reverse (-r),
stasiek - for... fribzdi ;-),
Grzegorz Goawski - for new ideas and PLD spec,
Peter Frbel - searching in bases descriptions, SPEC for SuSE, eject idea.

11. Contact
My email address: maciekk@linux.sky.pl.

----
Sorry for my english. Any grammatical bugreprots welcome. :-)

$Id: README,v 1.5 2002/06/28 19:18:58 eaquer Exp $
 vim:tw=80:
