releasing version 1.73-1
[debian/dupmerge.git] / readme.txt
1 dupmerge overview
2 =================
3
4 Dupmerge reads a list of files from standard input (eg., as produced by 
5 "find . -print") and looks securely for identical files. When it finds 
6 two or more identical files, all but one are unlinked to reclaim the 
7 disk space and recreated as hard links to the remaining copy.
8
9 Remarks: 
10 dumpmerge should be used only for backups or archives, where duplicate
11 files are not needed; it should not be used without nodo mode for /home,
12 /tmp, /var and most other directories.
13 The normal mode, hard linking of multiple files, causes no problems in backups
14 or archives and can also be used on CDs/DVDs. On filesystems without hard
15 links, e. g. FAT (FAT12, FAT16, FAT32, VFAT ...), it can work only with soft
16 links (often called shortcuts).
17 The sparse mode never causes problems (on file systems which support sparse). 
18 The deletion mode can cause trouble e. g. with ebooks or html documents with
19 pictures which are multiple. Therefore the deletion mode should only be used
20 with files which are not assoziated, e. g. audio or video files. The deletion
21 mode works on all (writable) file systems.
22
23 Normal mode: Saves approx. 20 % space.
24
25 Sparse mode: Saves approx. 0.2 % space.
26
27 Deletion mode: Deletes approx. 10 % of the files.
28
29 Many similar programs can be found on freshmeat.net or sourceforge.net by
30 searching for duplicate.
31 I found clink, dmerge, duff, Dupseek, epac, fdf, fdfind, fdupe, fdupes,
32 find_duplicates, freedup, freedups, fslint, ftwin, highlnk, WeedIt, and whatpix.
33
34 Most of these programs are not secure: highlnk and FSlint do use md5sum
35 which is a cryptografical weak hash and therefore they are vunerable to md5sum
36 collsions. With the hashing they are fast (O(n)) but not safe.
37 Another point is handling files as zero-terminated strings to avoid problems
38 with stray filenames, which is done correct from dupmerge.
39
40 If you want to delete all hard links (regular files with more than one hard
41 link), you only have to type
42 find . -type f -links +1 -exec rm -- {} \;
43
44
45 RF, 2007-10-29