Lot of cosmetics + added the -i option.
[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, \fBfinddup\fP associates by default
26 a group ID to every content, and prints it along the file names.
27
28 Note that
29 .B finddup DIR
30 is the same as
31 .B finddup -i DIR DIR
32
33 .SH "OPTIONS"
34 .TP
35 \fB-h\fR
36 display help and exit
37 .TP
38 \fB-d\fR
39 ignore files and directories starting with a dot
40 .TP
41 \fB-c\fR
42 do not show which files from DIR2 corresponds to files from DIR1
43 (hence, show only the files from DIR1 which have an identical twin in
44 DIR2)
45 .TP
46 \fB-g\fR
47 do not show the file group IDs
48 .TP
49 \fB-p\fR
50 show progress information in stderr
51 .TP
52 \fB-r\fR
53 show the real path of the files
54 .TP
55 \fB-i\fR
56 files with same inode are considered as different
57
58 .SH "BUGS"
59
60 None known, probably many. Valgrind does not complain though.
61
62 .SH "WISH LIST"
63
64 The format of the output should definitely be improved. Not clear how.
65
66 The comparison algorithm could definitely use some MD5 kind of
67 signature. However, I doubt it would improve speed much.
68
69 Their should be some fancy option to link two instances of the command
70 running on different machines to reduce network disk accesses.
71
72 .SH "EXAMPLES"
73
74 .B finddup -cg blah something
75
76 .fi
77 List files found in \fB./blah/\fR which have a matching file with same
78 content in \fB./something/\fR. Do not display the group IDs.
79
80 .P
81 .B finddup sources not:/mnt/backup
82
83 .fi
84 List all files found in \fB./sources/\fR which do not have
85 content-matching equivalent in \fB/mnt/backup\fR.
86
87 .P
88 .B finddup tralala cuicui
89
90 .fi
91 List groups of files with same content which exist both in
92 \fB./tralala/\fR and \fB./cuicui/\fR.
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.