Read Me

qlsdup - Duplicate file searcher with GUI
(c) 2013 by Peter Weinert

TOC

0. Licenses
1. Build
1.1 Linux / POSIX-compliant
1.2 Windows
1.3 MAC-OS
2. Install
3. Usage
3.1 Symlink-Warning
4. Contact
5. License
6. Change Log

===========================================================================

0. Licenses

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program. If not, see
 <http://www.gnu.org/licenses/>.

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

 3rd Party license stuff:
 
 This program uses Qt version 4.
 
 Qt is a C++ toolkit for cross-platform application development.
 
 Qt provides single-source portability across MS Windows, Mac OS X, Linux,
 and all major commercial Unix variants. Qt is also available for embedded
 devices as Qt for Embedded Linux and Qt for Windows CE.
 
 Qt is available under three different licensing options designed to
 accommodate the needs of our various users.
  
 Qt licensed under our commercial license agreement is appropriate for
 development of proprietary/commercial software where you do not want
 to share any source code with third parties or otherwise cannot comply
 with the terms of the GNU LGPL version 2.1 or GNU GPL version 3.0.
 
 Qt licensed under the GNU LGPL version 2.1 is appropriate for the
 development of Qt applications (proprietary or open source) provided
 you can comply with the terms and conditions of the GNU LGPL version 2.1.
 
 Qt licensed under the GNU General Public License version 3.0 is appropriate
 for the development of Qt applications where you wish to use such applications
 in combination with software subject to the terms of the GNU GPL version 3.0
 or where you are otherwise willing to comply with the terms of the GNU GPL
 version 3.0.

 Please see qt.digia.com/product/licensing for an overview of Qt licensing.

 Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).

 Qt is a Digia product. See qt.digia.com for more information.

===========================================================================

1. Build

To build lsdup you need the Qt4 development package or Qt4-SDK and a compiler
supported by Qt4.

Tested with:
 - openSuSE 12.3 (Qt 4.8.x & gcc 4.7.2)
 - Windows7-64-Pro, (Qt 4.8.2 with MinGW 4.4)
 - MacOS: in progress: as soon as summer's over i'll turn the heating (Power G5)
   on again and make sure it's working fine here.... so far i assume, if the 
   great troublemaker (windows) is working fine and a (somewhat) POSIX compliant
   system (Linux) is working fine, Macs should be compiling / working also......

1.1 Linux / POSIX-compliant

Simply run the script "build.sh" to generate the executable.
The script is in an early state so it doesn't check anything or supports
system-wide installation.
To speed-up the build process you can edit the file and edit  "ncore=1"
to the number of cores in your system, if you have a multi-core / multi-cpu
system.

1.2 Windows

Open a Qt4 console, navigate to this directory and run qmake.
Depending on installed development environment use make / nmake / jom / ...
to build the application.

1.3 MAC-OS

See Linux instructions. If this doesn't work (and you have the required
development tools installed) manually  run qmake to generate makefile and
then use make or xcode to build the application.

===========================================================================

2. Install

The application is always built to bin and is named "lsdup(.exe)".
The executable contains everything therefore you can put it anywhere
inside your PATH to be able to start it from within a shell or create
a link at any conveniant place.

Automated install script will follow somewhere later.

===========================================================================

3. Usage

Simply start the application. The UI should be self explanatory. Just
play around a little bit, as long as you dont't press "Delete Selection"
or "Symlink Selection" in the Results tab you won't change anything in
your system!
The tabs become active only when there's data available.

3.1 Symlink-Warning

Use option "Symbolic Link" in configuration with extreme caution!
If enabled symbolic links will be evaluated and may be compared with
their link target. Depending on selection when deleting you might
end up deleting the original data and leaving only a broken link!

===========================================================================

4. Contact

Project page (including forum for questions, etc.) can be found at:

http://sourceforge.net/projects/qlsdup/

===========================================================================

5. License

See 'gplv3.text'.

===========================================================================

6. Change Log

v1.0.2
-------

 - fixed remaining overhead count when all instances of a file
   are deleted
 - added possibility to cancel processing
 - cleanly exit dupe-search-thread when exiting application during
   processing
 - fixed missing list/tree items after deletion

v1.0.1
------
 
 - fix executable name
 - improve compare performance (read & compare larger block)
 - improve perfomance building result tree
 - update excess usage when removing / linking duplicates

v1.0.0
------

- Initial version