X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?a=blobdiff_plain;f=finddup.1;h=12e7a3242a5433110bfcb17ee0c34ede72a48df4;hb=9ff8fd7269f6a579c17118d564b5ef053c47c8c2;hp=989cff9330e5164b1f1b81116602c1b58d41e4ad;hpb=87eea2c3b5958b578cdf32f5e01d3c733bdf7615;p=finddup.git

diff --git a/finddup.1 b/finddup.1
index 989cff9..12e7a32 100644
--- a/finddup.1
+++ b/finddup.1
@@ -1,41 +1,100 @@
+.TH "FINDDUP" 1 "Mar 2010" "Francois Fleuret" "User Commands"
+
 \" This man page was written by Francois Fleuret <francois@fleuret.org>
 \" and is distributed under a Creative Commons Attribution-Share Alike
 \" 3.0 License.
 
-.TH "FINDDUP" 1 "Mar 2010" "Francois Fleuret" "User Commands"
-
 .SH "NAME"
 
-finddup \- Find files common to several directories or not
+finddup \- Find files common to two directories (or not)
 
 .SH "SYNOPSIS"
 
-\fBfinddup\fP [OPTION]... DIR1 [[^]DIR2]
+\fBfinddup\fP [OPTION]... DIR1 [[and:|not:]DIR2]
 
 .SH "DESCRIPTION"
 
-\fBfinddup\fP is a command line utility to find duplicate files, files
-common to two directories or files existing in one directories and not
-in another one.
+With a single directory argument, \fBfinddup\fP prints the duplicated
+files found in it. With two directories, it prints either the files
+common to both DIR1 and DIR2, or with the `not:' prefix, the ones
+present in DIR1 and not in DIR2. The and: prefix is assumed by default
+and necessary only if you have a directory name starting with `not:'.
+
+This command compares files by first comparing their sizes, hence goes
+reasonably fast.
 
-With a single directory argument, prints the duplicate files found in
-it. With two directories, prints the files common to both.
+When looking for identical files, \fBfinddup\fP associates by default
+a group ID to every content, and prints it along the file names. Use
+the \fB-g\fP to switch it off.
 
-If the second directory name starts with a ^, prints the files
-existing in DIR1 which do not exist in DIR2.
+Note that
+.B finddup DIR
+is the same as
+.B finddup -i DIR DIR
 
 .SH "OPTIONS"
 .TP
 \fB-h\fR
 display help and exit
 .TP
+\fB-d\fR
+ignore files and directories starting with a dot
+.TP
+\fB-0\fR
+ignore empty files
+.TP
+\fB-c\fR
+do not show which files from DIR2 corresponds to files from DIR1
+(hence, show only the files from DIR1 which have an identical twin in
+DIR2)
+.TP
+\fB-g\fR
+do not show the file group IDs
+.TP
+\fB-p\fR
+show progress information in stderr
+.TP
 \fB-r\fR
-shows the real path of the files
+show the real path of the files
+.TP
+\fB-i\fR
+files with same inode are considered as different
 
 .SH "BUGS"
 
-Every pair of different files with same content are listed, which
-results in K^2 printed lines when K files are similar.
+None known, probably many. Valgrind does not complain though.
+
+.SH "WISH LIST"
+
+The format of the output should definitely be improved. Not clear how.
+
+The comparison algorithm could definitely use some MD5 kind of
+signature. However, I doubt it would improve speed much.
+
+Their should be some fancy option to link two instances of the command
+running on different machines to reduce network disk accesses.
+
+.SH "EXAMPLES"
+
+.B finddup -p0d blah
+
+.fi
+List duplicated files in directory ./blah/, show a progress bar,
+ignore empty files and files and directories starting with a dot.
+
+.P
+.B finddup sources not:/mnt/backup
+
+.fi
+List all files found in \fB./sources/\fR which do not have
+content-matching equivalent in \fB/mnt/backup/\fR.
+
+.P
+.B finddup tralala cuicui
+
+.fi
+List groups of files with same content which exist both in
+\fB./tralala/\fR and \fB./cuicui/\fR.
 
 .SH "AUTHOR"