****************************************************************************
		      README -- Konserve -- 0.9
****************************************************************************

Contents
****************************************************************************

* What's Konserve?
* Installation
* Konserve on the Internet
* Bugs and Caveats
* On Hacking Konserve

****************************************************************************

* What's Konserve?

    Konserve is a small backup application for the KDE 3.x environment. It
  lives in the system tray and is able to create backups of several
  directories or files periodically.
    Konserve uses standard KDE network transparency to upload your backups
  to wherever you want. Also it is possibly to restore a incidently
  deleted file or directory from a backup file with just one mouse click.
    A nice wizard helps you with the first steps in using Konserve.

* Installation

    See file INSTALL for the detailed installation instructions. Please
  note that this program _expects_ to be installed in the standard KDE
  directory structure. If it is not it won't load its icons and the
  documentation correctly. One way to make sure Konserve will be installed
  in the right place is to use configure in the following way:

  ./configure --prefix=$(kde-config --prefix)

  Please read about 'make uninstall' below if you want to remove Konserve
  again from your hard disk.

* Konserve on the Internet

    The website currently is http://www.simnacher.net/konserve/konserve.html.
  Please have a look at it for the latest version.

* Bugs and Caveats

  Alpha-Software:	

    Please note that this is *alpha* software. I'm using it now on my own
  PC to keep backups of for example the Konserve sources itself and
  I have not shot myself in the foot. But I can not guarantee that this
  is impossible to happen.

  Remote Backups:

    When backups are copied to a remote computer, the automatic generation
  of archive names does not work. So it is adviceable to use a file name. For
  example an Archive url might look like:

	ftp://myname@remotehost.org/home/me/file.tar.gz

  Key Usage in Preferences Dialog:

    The preferences dialog only works correctly when the Add button to
  add new backup profiles has been clicked with the mouse or the Alt-A
  shortcut has been used. Adding backup profiles via TAB+Return or only
  Return does not work.

  User Interface:

    Pop-up-menu->Preferences->Backup Profile:
  If you have selected a backup profile and you type something in the
  edit field the backup profile name will also change in the list-box.
  Konserve currently does not handle this and it will mess up the
  configuration file.

  Deep Directory Structure:

    Very deep directory structures will take a very long time and will
  eventually exceed Konserves capabilities as reported by Markus Neff.
  So you might not use Konserve to do a backup of your /usr directory.

  Cyclic links:

    Konserve can not handle cyclic links. If Konserve is used to create
  backups of directory trees containing cyclic links, it will write
  the same files to the backup file very often.

  Autoconf/Automake:

    I am using autoconf v2.52 and automake v1.4. I am not sure if 
  everything builds find if you use other versions. Markus Neff has
  reported that automake v1.5 works fine too.

  'make uninstall':

    'make uninstall' removes all files of Konserve installed by
  'make install' except those directories that are considered standard
  directories of the KDE directory structure.

  English Language:

    And, well, i think the English used in the documentation is probably not
  the best. So please do not hesitate to inform me about words that
  do not fit in the context and sentences that are screwed up or any other
  kind of mistake you find.

  configure --enable-final:

    The --enable-final option to the configure script does not work
  due to the peculiarity of the konserve build system.

* On Hacking Konserve

    You are interested in hacking Konserve? Great, I am already waiting 
  for your patches :-). While coding, you might consider using the testsuite
  that comes with Konserve. It is constantly broken, because I use it during
  coding but I have not put much effort in maintaining older tests. I hope
  this will change in the future.
    In order to use it you will have to install the CPPUNIT library (see
  http://cppunit.sourceforge.net).
    Additionally you have to enable Exceptions in the configure.in.in file
  by removing the dnl in 'dnl CXXFLAGS="$CXXFLAGS $USE_EXCEPTIONS"'.
    Then type 'make' in the toplevel direcotry and 'make  check' in the
  tests directory. After the build you can run the single tests. Currently
  it is not possible to run them all at once.

****************************************************************************
I hope you will enjoy this piece of software.              Florian Simnacher
****************************************************************************
