4ba180726f60a73954b8e4d101b854b6138c77a5
[finddup.git] / finddup.1
1 .TH "FINDDUP" 1 "Mar 2010" "Francois Fleuret" "User Commands"
2
3 \" This man page was written by Francois Fleuret <francois@fleuret.org>
4 \" and is distributed under a Creative Commons Attribution-Share Alike
5 \" 3.0 License.
6
7 .SH "NAME"
8
9 finddup \- Find files common to two directories (or not)
10
11 .SH "SYNOPSIS"
12
13 \fBfinddup\fP [OPTION]... DIR1 [[not:]DIR2]
14
15 .SH "DESCRIPTION"
16
17 With a single directory argument, \fBfinddup\fP prints the duplicated
18 files found in it. With two directories, it prints either the files
19 common to both DIR1 and DIR2, or with the `not:' prefix, the ones
20 present in DIR1 and not in DIR2.
21
22 It compares files by first comparing their sizes, hence goes
23 reasonably fast.
24
25 When looking for identical files,
26 .B finddup
27 by default associates a group ID to every content, and prints it along
28 the file names.
29
30 .SH "OPTIONS"
31 .TP
32 \fB-h\fR
33 display help and exit
34 .TP
35 \fB-d\fR
36 ignore files and directories starting with a dot
37 .TP
38 \fB-c\fR
39 do not show which files from DIR2 corresponds to files from DIR1
40 .TP
41 \fB-g\fR
42 do not show the file group IDs
43 .TP
44 \fB-p\fR
45 show progress information in stderr
46 .TP
47 \fB-r\fR
48 show the real path of the files
49
50 .SH "BUGS"
51
52 None known, probably many. Valgrind does not complain though.
53
54 .SH "WISH LIST"
55
56 The format of the output should definitely be improved. Not clear how.
57
58 The comparison algorithm could definitely use some MD5 kind of
59 signature. I doubt it would really speed up a lot.
60
61 Their should be some fancy option to run two instances of the command
62 on different machines so that comparison could be done without disk
63 access where the disk are physically.
64
65 .SH "EXAMPLES"
66
67 .B finddup -cg blah something
68
69 .fi
70 List files found in
71 .B ./blah/
72 which have a matching file with same content in
73 .B ./something/
74 without the group IDs
75
76 .P
77 .B finddup sources not:/mnt/backup
78
79 .fi
80 List all files found in
81 .B ./sources/
82 which do not have content-matching equivalent in
83 .B /mnt/backup
84
85 .P
86 .B finddup tralala cuicui
87
88 .fi
89 List groups of files with same content which exist both in
90 .B ./tralala/
91 and
92 .B ./cuicui/
93
94 .SH "AUTHOR"
95
96 Written by Francois Fleuret <francois@fleuret.org> and distributed
97 under the terms of the GNU General Public License version 3 as
98 published by the Free Software Foundation. This is free software: you
99 are free to change and redistribute it. There is NO WARRANTY, to the
100 extent permitted by law.