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 for every directory given follow subdirectories encountered within
  23 .TP
  24 .B -R --recurse:
  25 for each directory given after this option follow subdirectories
  26 encountered within (note the ':' at the end of option; see the
  27 Examples section below for further explanation)
  28 .TP
  29 .B -s --symlinks
  30 follow symlinked directories
  31 .TP
  32 .B -H --hardlinks
  33 normally, when two or more files point to the same disk area they are
  34 treated as non-duplicates; this option will change this behavior
  35 .TP
  36 .B -G --minsize\fR=\fISIZE\fR
  37 consider only files greater than or equal to SIZE
  38 .TP
  39 .B -L --maxsize=\fR=\fISIZE\fR
  40 consider only files less than or equal to SIZE
  41 .TP
  42 .B -n --noempty
  43 exclude zero-length files from consideration
  44 .TP
  45 .B -A --nohidden
  46 exclude hidden files from consideration
  47 .TP
  48 .B -f --omitfirst
  49 omit the first file in each set of matches
  50 .TP
  51 .B -1 --sameline
  52 list each set of matches on a single line
  53 .TP
  54 .B -S --size
  55 show size of duplicate files
  56 .TP
  57 .B  -t --time
  58 show modification time of duplicate files
  59 .TP
  60 .B -m --summarize
  61 summarize duplicate file information
  62 .TP
  63 .B -q --quiet
  64 hide progress indicator
  65 .TP
  66 .B -d --delete
  67 prompt user for files to preserve, deleting all others (see
  68 .B CAVEATS
  69 below)
  70 .TP
  71 .B -P --plain
  72 with --delete, use line-based prompt (as with older versions of
  73 fdupes) instead of screen-mode interface
  74 .TP
  75 .B -N --noprompt
  76 when used together with \-\-delete, preserve the first file in each
  77 set of duplicates and delete the others without prompting the user
  78 .TP
  79 .B -I --immediate
  80 delete duplicates as they are encountered, without
  81 grouping into sets; implies --noprompt
  82 .TP
  83 .B -p --permissions
  84 don't consider files with different owner/group or permission bits as duplicates
  85 .TP
  86 .B -o --order\fR=\fIWORD\fR
  87 order files according to WORD:
  88 time - sort by modification time, ctime - sort by status change time, name - sort by filename
  89 .TP
  90 .B -i --reverse
  91 reverse order while sorting
  92 .TP
  93 .B -l --log\fR=\fILOGFILE\fR
  94 log file deletion choices to LOGFILE
  95 .TP
  96 .B -v --version
  97 display fdupes version
  98 .TP
  99 .B -h --help
 100 displays help
 101 .SH "SEE ALSO"
 102 .\" Always quote multiple words for .SH
 103 .BR md5sum (1)
 104 .SH NOTES
 105 Unless
 106 .B -1
 107 or
 108 .B --sameline
 109 is specified, duplicate files are listed
 110 together in groups, each file displayed on a separate line. The
 111 groups are then separated from each other by blank lines.
 112
 113 When
 114 .B -1
 115 or
 116 .B --sameline
 117 is specified, spaces and backslash characters  (\fB\e\fP) appearing
 118 in a filename are preceded by a backslash character.
 119
 120 .SH EXAMPLES
 121 .TP
 122 .B fdupes a --recurse: b
 123 will follow subdirectories under b, but not those under a.
 124 .TP
 125 .B fdupes a --recurse b
 126 will follow subdirectories under both a and b.
 127
 128 .SH CAVEATS
 129 If fdupes returns with an error message such as
 130 .B fdupes: error invoking md5sum
 131 it means the program has been compiled to use an external
 132 program to calculate MD5 signatures (otherwise, fdupes uses
 133 internal routines for this purpose), and an error has occurred
 134 while attempting to execute it. If this is the case, the
 135 specified program should be properly installed prior
 136 to running fdupes.
 137
 138 When using
 139 .B \-d
 140 or
 141 .BR \-\-delete ,
 142 care should be taken to insure against
 143 accidental data loss.
 144
 145 When used together with options
 146 .B \-s
 147 or
 148 .BR \-\-symlink ,
 149 a user could accidentally
 150 preserve a symlink while deleting the file it points to.
 151
 152 Furthermore, when specifying a particular directory more than
 153 once, all files within that directory will be listed as their
 154 own duplicates, leading to data loss should a user preserve a
 155 file without its "duplicate" (the file itself!).
 156
 157 .SH AUTHOR
 158 Adrian Lopez <adrian2@caribe.net>
 159