Cosmetics (variable name changes).
[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 [[and:|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. The and: prefix is assumed by default
21 and necessary only if you have a directory name starting with `not:'.
22
23 This command compares files by first comparing their sizes, hence goes
24 reasonably fast.
25
26 When looking for identical files, \fBfinddup\fP associates by default
27 a group ID to every content, and prints it along the file names. Use
28 the \fB-g\fP to switch it off.
29
30 Note that
31 .B finddup DIR
32 is the same as
33 .B finddup -i DIR DIR
34
35 .SH "OPTIONS"
36 .TP
37 \fB-h\fR
38 display help and exit
39 .TP
40 \fB-d\fR
41 ignore files and directories starting with a dot
42 .TP
43 \fB-0\fR
44 ignore empty files
45 .TP
46 \fB-c\fR
47 do not show which files from DIR2 corresponds to files from DIR1
48 (hence, show only the files from DIR1 which have an identical twin in
49 DIR2)
50 .TP
51 \fB-g\fR
52 do not show the file group IDs
53 .TP
54 \fB-p\fR
55 show progress information in stderr
56 .TP
57 \fB-r\fR
58 show the real path of the files
59 .TP
60 \fB-i\fR
61 files with same inode are considered as different
62
63 .SH "BUGS"
64
65 None known, probably many. Valgrind does not complain though.
66
67 .SH "WISH LIST"
68
69 The format of the output should definitely be improved. Not clear how.
70
71 The comparison algorithm could definitely use some MD5 kind of
72 signature. However, I doubt it would improve speed much.
73
74 Their should be some fancy option to link two instances of the command
75 running on different machines to reduce network disk accesses.
76
77 .SH "EXAMPLES"
78
79 .B finddup -cg blah something
80
81 .fi
82 List files found in \fB./blah/\fR which have a matching file with same
83 content in \fB./something/\fR. Do not display the group IDs.
84
85 .P
86 .B finddup sources not:/mnt/backup
87
88 .fi
89 List all files found in \fB./sources/\fR which do not have
90 content-matching equivalent in \fB/mnt/backup\fR.
91
92 .P
93 .B finddup tralala cuicui
94
95 .fi
96 List groups of files with same content which exist both in
97 \fB./tralala/\fR and \fB./cuicui/\fR.
98
99 .SH "AUTHOR"
100
101 Written by Francois Fleuret <francois@fleuret.org> and distributed
102 under the terms of the GNU General Public License version 3 as
103 published by the Free Software Foundation. This is free software: you
104 are free to change and redistribute it. There is NO WARRANTY, to the
105 extent permitted by law.