Deduper - Readme
================

Deduper is a Perl program for locating and disposing of duplicated files in a filesystem. As of this version, it has been tested on Linux, OpenBSD and Windows.

The Deduper File Deuplicator is a Perl program. You will need a Perl interpreter installed in your system and the following modules:

* Digest::SHA
* File::Find
* Getopt::Std

If you are running a conventional Linux distribution, you most likely already have them. This program supports no GUI at the moment.

How to use it
=============

Usage: deduper [options] folder (folder2 folder3 ...)

If one or more folders are passed to the program, Deduper locates duplicated files in the given folders based on their SHA256 checksum, and prints their information to the standard output.

The behaviour of the program can be altered using the following option switches:

-f: Follow directory symlinks (default is not to follow symlinks).
-o: Delete older duplicated files and leave the newest only. Use with caution.
-n: Delete newer duplicated files and leave the oldest only. Use with caution.
--help: Show this message and exit.
--version: Print version and copyright information and exit.
-n and -r are mutually exclussive.

The Deduper File Deduplicator ignores file symlinks. It is also unable to interpretate hardlinks as what they are, and it will consider each hardlink to be a different file.

Symlink functionality is not available under Operating Systems and filesystems that don't support symlinks.

License
=======

Deduper is distributed under the 3-clause BSD license.
