a1f2a60202ccb672b462901ebcb055be010d1c47
[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 When looking for identical files,
23 .B finddup
24 by default associates a group ID to every content, and prints it along
25 the file names.
26
27 .SH "OPTIONS"
28 .TP
29 \fB-h\fR
30 display help and exit
31 .TP
32 \fB-d\fR
33 ignore files and directories starting with a dot
34 .TP
35 \fB-c\fR
36 do not show which files from DIR2 corresponds to files from DIR1
37 .TP
38 \fB-g\fR
39 do not show the file group IDs
40 .TP
41 \fB-p\fR
42 show progress information in stderr
43 .TP
44 \fB-r\fR
45 show the real path of the files
46
47 .SH "BUGS"
48
49 None known, probably many. Valgrind does not complain though.
50
51 .SH "WISH LIST"
52
53 The format of the output should definitely be improved. Not clear how.
54
55 The comparison algorithm could definitely use some MD5 kind of
56 signature. I doubt it would really speed up a lot.
57
58 Their should be some fancy option to run two instances of the command
59 on different machines so that comparison could be done without disk
60 access where the disk are physically.
61
62 .SH "EXAMPLES"
63
64 .B finddup -cg blah something
65
66 .fi
67 List files found in
68 .B ./blah/
69 which have a matching file with same content in
70 .B ./something/
71 without the group IDs
72
73 .P
74 .B finddup sources not:/mnt/backup
75
76 .fi
77 List all files found in
78 .B ./sources/
79 which do not have content-matching equivalent in
80 .B /mnt/backup
81
82 .P
83 .B finddup tralala cuicui
84
85 .fi
86 List groups of files with same content which exist both in
87 .B ./tralala/
88 and
89 .B ./cuicui/
90
91 .SH "AUTHOR"
92
93 Written by Francois Fleuret <francois@fleuret.org> and distributed
94 under the terms of the GNU General Public License version 3 as
95 published by the Free Software Foundation. This is free software: you
96 are free to change and redistribute it. There is NO WARRANTY, to the
97 extent permitted by law.