GTKtalog README file

WARNING:
Version 0.1.0 is a new version, with new internal concepts.
Ncatalog is still compatible with GTKtalog 0.0.18.

GTKtalog-0.1.x is fully incompatible with any other previous versions of NCatalog or GTKtalog.
GTKtalog-0.1.4 and up should read old catalogs if compiled with ./configure --enable-catalog2
Old catalogs can also be converted with an external converter. For more information about where
to download this converter, try the download section of http://gtktalog.sourceforge.net.

For instructions on how to compile and install GTKtalog, read the INSTALL file.

GTKtalog is a tool to make disk catalog: you can use it to create a really small database with
images of files and directories of your CDs. Then you can browse all your CDs very quickly, see
contents of some files (tar.gz, rpm files ...). You can assign a category and a description to each
directory and file. You can look for files in your database using filename, category, description
and/or file information parameters, and find in which CD the file you are looking for is. Ncatalog
let you browse and search for files in GTKtalog databases without X window. It uses ncurse to
display a text user interface. NCatalog is included in the GTKtalog 0.0.18 (and up) archive. 

I. How to use and edit a catalog?
=================================
To begin, you have to edit the GTKtalog configuration by using the "Setup" function in the "Edit"
list of the menubar. At this time, you must config plugins (softwares) you want to use and the
CD-rom config informations to use the fast add disk function.

To add a disk to the curent catalog, go in the Edit menu and choose the "Add disk" function. You
will see a dialog for choosing the directory location of the disk. You have to input a disk label
at this time, but will be able to change it.

The other solution is to use the "fast add" button, and set the disk label while gtktalog mount,
scan, umount and eject  your CD.

To see files informations loaded by plugins, you just have to double click on the file. To edit the
information, click on the file with the right button and choose edit informations.

To edit disk, folder or file data, select it with the left mouse button, then right click and
choose the edit option.  Alternatively, a middle mouse button click accomplishes the same thing.
When you edit a disk or a folder, you can propagate category and desciption informations in
subfolders and directory without changing the catalog size!

To add a category, go to Edit->Edit_category menu, or if you are editing a disk, file, or folder,
click on the button to the right of the "Change category" frame.

To edit the description information, just type in the entry field or use an old description with
using the combo box.


II. What are categories for? 
=============================
Each catalog can have many categories. For example, if you have CD's with MP3's you can have
folders with techno music, and another with rock or rap. So, you can give the category techno for
the first, rap for the second, and rock for the third. With it, you can do more powerful searchs.

III. What use is the "Clean descriptions" function?
====================================================
When you edit your database a few times, you can have descriptions entries which are not used, or
some descriptions with the same information. You should use the "Clean descriptions" to remove
all descriptions and have a smaller database.


IV. How do I search for a file?
==============================
Click on "Find file" for the find file dialog. You can choose the category in which one you want to
search. You can search folders or files, ...., with case sensitive or not..

In the result windows, if you double click on a file or folder the parent folder or the folder
itself will be opened in the main window (the browser catalog window).  You can sort files by name,
disk, path, size, date, category or description by pressing on buttons on the top of each column.


V. How to change or add icons
=============================

This is not supported in setup. However, read the file ${HOME}/.gtktalog/gtktalog.cf.
The syntax is obvious:
AddIcon icon_file_name extension [extension [extension [...]]]


VI. Why do some folder names have -> at the end and an adress after?
====================================================================
This means that the folder is a symbolic link. If you go in this folder, the list of files it will
appear are the file of the target. You can remove the -> and the adress in the name without
destroying the link! If you mail me you need an option to edit the symbolic link, maybe i will
enable it.


VII. This file!
==============
Maybe, you will be able to know how other functions works, but if you want to make a better README
file, your contribution is welcome.

NOTE. I changed many things from 0.0.18 to 0.1.0. I tried to keep this README file up to date.
But This is quite hard. Tell us what should be modified in this file.
Yves

VIII.1 Why have I coded GTKtalog? (Mathieu)
===========================================
Because other disk catalog don't do what i want them to do! That's a good reason. ;o)
I've tried to do the smaller database as possible.

VIII.2 Why did I joined the project ? (Yves)
============================================
The first and historic reason is that there was no autoconf/automake support, so I had to add it
before I compile GTKtalog.
Why did I continue then ? Because GTKtalog does exactly what I expect from such a soft (even if
one or two features are not coded yet). And there was so much to do then.
The changed between 0.0.18 and 0.1.0 are all the second times I do them. It was like an exam where
I could see what I did well or what I hadn't understood yet.


Mail: gtktalog@caramail.com (Mathieu VILLEGAS)
      ymettier@free.fr      (Yves METTIER)
http://gtktalog.sourceforge.net (primary site)

http://gtktalog.iskewl.com (old primary site. Now a mirror of http://gtktalog.sourceforge.net)
http://gtktalog.netpedia.net (old secondary site. Will be maintained ?)
