Imported Upstream version 1.40
[platform/upstream/fdupes.git] / README
1 Introduction
2 --------------------------------------------------------------------
3 FDUPES is a program for identifying duplicate files residing
4 within specified directories. 
5
6
7 Usage
8 --------------------------------------------------------------------
9 Usage: fdupes [options] DIRECTORY...
10
11  -r --recurse           include files residing in subdirectories
12  -s --symlinks          follow symlinks
13  -H --hardlinks         normally, when two or more files point to the same
14                         disk area they are treated as non-duplicates; this
15                         option will change this behavior
16  -n --noempty           exclude zero-length files from consideration
17  -f --omitfirst         omit the first file in each set of matches
18  -1 --sameline          list each set of matches on a single line
19  -S --size              show size of duplicate files
20  -q --quiet             hide progress indicator
21  -d --delete            prompt user for files to preserve and delete all
22                         others; important: under particular circumstances,
23                         data may be lost when using this option together
24                         with -s or --symlinks, or when specifying a
25                         particular directory more than once; refer to the
26                         fdupes documentation for additional information
27  -v --version           display fdupes version
28  -h --help              display this help message
29
30 Unless -1 or --sameline is specified, duplicate files are listed 
31 together in groups, each file displayed on a separate line. The
32 groups are then separated from each other by blank lines.
33
34 When -1 or --sameline is specified, spaces and backslash characters (\) 
35 appearing in a filename are preceded by a backslash character. For
36 instance, "with spaces" becomes "with\ spaces".
37
38 When using -d or --delete, care should be taken to insure against
39 accidental data loss. While no information will be immediately
40 lost, using this option together with -s or --symlink can lead 
41 to confusing information being presented to the user when prompted
42 for files to preserve. Specifically, a user could accidentally
43 preserve a symlink while deleting the file it points to. A similar
44 problem arises when specifying a particular directory more than 
45 once. All files within that directory will be listed as their own
46 duplicates, leading to data loss should a user preserve a file 
47 without its "duplicate" (the file itself!).
48
49
50 Contact Information for Adrian Lopez
51 --------------------------------------------------------------------
52 email: adrian2@caribe.net
53
54
55 Legal Information
56 --------------------------------------------------------------------
57 FDUPES Copyright (c) 1999 Adrian Lopez
58
59 Permission is hereby granted, free of charge, to any person
60 obtaining a copy of this software and associated documentation files
61 (the "Software"), to deal in the Software without restriction,
62 including without limitation the rights to use, copy, modify, merge,
63 publish, distribute, sublicense, and/or sell copies of the Software,
64 and to permit persons to whom the Software is furnished to do so,
65 subject to the following conditions:
66
67 The above copyright notice and this permission notice shall be
68 included in all copies or substantial portions of the Software.
69
70 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 
71 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
72 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
73 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 
74 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 
75 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 
76 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.