Typo.

[finddup.git] / finddup.1

diff --git a/finddup.1 b/finddup.1
index 9c5afda..8ab867c 100644 (file)
--- a/finddup.1
+++ b/finddup.1
@@ -1,34 +1,79 @@
+.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 \- A simple command line utility for size-sorting files
+finddup \- Find files common to two directories (or not)
 
 .SH "SYNOPSIS"
 
-\fBfinddup\fP [OPTION]... [FILE]...
+\fBfinddup\fP [OPTION]... DIR1 [[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.
 
 .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
+.TP
+\fB-g\fR
+do not show the file group IDs (one group for each content)
+.TP
+\fB-p\fR
+show progress information in stderr
+.TP
 \fB-r\fR
 shows the real path of the files
 
 .SH "BUGS"
 
-None known, probably many though.
+None known, probably many. Valgrind does not complain though.
+
+While not a bug per se, the format of the output should definitely be
+improved. Not clear how.
+
+.SH "EXAMPLES"
+.nf
+.B finddup -cg blah something
+
+.fi
+List files found in
+.B ./blah/
+which have a matching file with exact same content in
+.B ./something/
+without the group IDs
+
+.P
+.B finddup ./sources not:./backup
+
+.fi
+List all files found in
+.B ./sources/
+which do not have content-matching equivalent in
+.B ./backup.sources
+
+.P
+.B finddup ./tralala ./cuicui | sort -n
+
+.fi
+List groups of files with same content which exist both in
+.B ./tralala/
+and
+.B ./cuicui/
 
 .SH "AUTHOR"