Lot of cosmetics + added the -i option.

[finddup.git] / finddup.1

diff --git a/finddup.1 b/finddup.1
index d0c0eba..71e0e57 100644 (file)
--- a/finddup.1
+++ b/finddup.1
@@ -1,9 +1,9 @@
+.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.
 
 \" 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 two directories (or not)
 .SH "NAME"
 
 finddup \- Find files common to two directories (or not)


@@ -14,23 +14,82 @@ finddup \- Find files common to two directories (or not)
 
 .SH "DESCRIPTION"
 
 
 .SH "DESCRIPTION"
 

-With a single directory argument, \fBfinddup\fP prints the duplicate
+With a single directory argument, \fBfinddup\fP prints the duplicated

 files found in it. With two directories, it prints either the files
 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
+common to both DIR1 and DIR2, or with the `not:' prefix, the ones

 present in DIR1 and not in DIR2.
 
 present in DIR1 and not in DIR2.
 

+It compares files by first comparing their sizes, hence goes
+reasonably fast.
+
+When looking for identical files, \fBfinddup\fP associates by default
+a group ID to every content, and prints it along the file names.
+
+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
 .SH "OPTIONS"
 .TP
 \fB-h\fR
 display help and exit
 .TP

+\fB-d\fR
+ignore files and directories starting with a dot
+.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
 \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"
 
 
 .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 -cg blah something
+
+.fi
+List files found in \fB./blah/\fR which have a matching file with same
+content in \fB./something/\fR. Do not display the group IDs.
+
+.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"
 
 
 .SH "AUTHOR"