Imported Upstream version 2.1.2
[platform/upstream/fdupes.git] / 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 NOTES
102 Unless
103 .B -1
104 or
105 .B --sameline
106 is specified, duplicate files are listed
107 together in groups, each file displayed on a separate line. The
108 groups are then separated from each other by blank lines.
109
110 When
111 .B -1
112 or
113 .B --sameline
114 is specified, spaces and backslash characters  (\fB\e\fP) appearing
115 in a filename are preceded by a backslash character.
116
117 .SH EXAMPLES
118 .TP
119 .B fdupes a --recurse: b
120 will follow subdirectories under b, but not those under a.
121 .TP
122 .B fdupes a --recurse b
123 will follow subdirectories under both a and b.
124
125 .SH CAVEATS
126 When using
127 .B \-d
128 or
129 .BR \-\-delete ,
130 care should be taken to insure against
131 accidental data loss.
132
133 When used together with options
134 .B \-s
135 or
136 .BR \-\-symlink ,
137 a user could accidentally
138 preserve a symlink while deleting the file it points to.
139
140 Furthermore, when specifying a particular directory more than
141 once, all files within that directory will be listed as their
142 own duplicates, leading to data loss should a user preserve a
143 file without its "duplicate" (the file itself!).
144
145 .SH AUTHOR
146 Adrian Lopez <adrian2@caribe.net>
147