fdupes.1

   1 .TH FDUPES 1
   2 .\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection
   3 .\" other parms are allowed: see man(7), man(1)
   4 .SH NAME
   5 fdupes \- finds duplicate files in a given set of directories
   6 .SH SYNOPSIS
   7 .B fdupes
   8 [
   9 .I options
  10 ]
  11 .I DIRECTORY
  12 \|.\|.\|.
  13
  14 .SH "DESCRIPTION"
  15 Searches the given path for duplicate files. Such files are found by
  16 comparing file sizes and MD5 signatures, followed by a
  17 byte-by-byte comparison.
  18
  19 .SH OPTIONS
  20 .TP
  21 .B -r --recurse
  22 include files residing in subdirectories
  23 .TP
  24 .B -s --symlinks
  25 follow symlinked directories
  26 .TP
  27 .B -H --hardlinks
  28 normally, when two or more files point to the same disk area they are
  29 treated as non-duplicates; this option will change this behavior
  30 .TP
  31 .B -n --noempty
  32 exclude zero-length files from consideration
  33 .TP
  34 .B -f --omitfirst
  35 omit the first file in each set of matches
  36 .TP
  37 .B -1 --sameline
  38 list each set of matches on a single line
  39 .TP
  40 .B -S --size
  41 show size of duplicate files
  42 .TP
  43 .B -q --quiet
  44 hide progress indicator
  45 .TP
  46 .B -d --delete
  47 prompt user for files to preserve, deleting all others (see
  48 .B CAVEATS
  49 below)
  50 .TP
  51 .B -v --version
  52 display fdupes version
  53 .TP
  54 .B -h --help
  55 displays help
  56 .SH "SEE ALSO"
  57 .\" Always quote multiple words for .SH
  58 .BR md5sum (1)
  59 .SH NOTES
  60 Unless
  61 .B -1
  62 or
  63 .B --sameline
  64 is specified, duplicate files are listed
  65 together in groups, each file displayed on a separate line. The
  66 groups are then separated from each other by blank lines.
  67
  68 When
  69 .B -1
  70 or
  71 .B --sameline
  72 is specified, spaces and backslash characters  (\fB\e\fP) appearing
  73 in a filename are preceded by a backslash character.
  74 .SH CAVEATS
  75 If fdupes returns with an error message such as
  76 .B fdupes: error invoking md5sum
  77 it means the program has been compiled to use an external
  78 program to calculate MD5 signatures (otherwise, fdupes uses
  79 interal routines for this purpose), and an error has occurred
  80 while attempting to execute it. If this is the case, the
  81 specified program should be properly installed prior
  82 to running fdupes.
  83
  84 When using
  85 .B \-d
  86 or
  87 .BR \-\-delete ,
  88 care should be taken to insure against
  89 accidental data loss.
  90
  91 When used together with options
  92 .B \-s
  93 or
  94 .BR \-\-symlink ,
  95 a user could accidentally
  96 preserve a symlink while deleting the file it points to.
  97
  98 Furthermore, when specifying a particular directory more than
  99 once, all files within that directory will be listed as their
 100 own duplicates, leading to data loss should a user preserve a
 101 file without its "duplicate" (the file itself!).
 102
 103 .SH AUTHOR
 104 Adrian Lopez <adrian2@caribe.net>
 105