~ubuntu-branches/ubuntu/utopic/duff/utopic-proposed

« back to all changes in this revision

Viewing changes to README

  • Committer: Package Import Robot
  • Author(s): Kamal Mostafa
  • Date: 2012-01-29 08:02:46 UTC
  • Revision ID: package-import@ubuntu.com-20120129080246-jd9w62dkx0v5q7r1
Tags: upstream-0.5.2
ImportĀ upstreamĀ versionĀ 0.5.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
duff - Duplicate file finder
 
2
============================
 
3
 
 
4
0. Introduction
 
5
===============
 
6
 
 
7
Duff is a command-line utility for identifying duplicates in a given set of
 
8
files.  It attempts to be usably fast and uses the SHA family of message
 
9
digests as a part of the comparisons.
 
10
 
 
11
The project website is here:
 
12
 
 
13
  http://duff.sourceforge.net/
 
14
 
 
15
Duff resides in public Git repository on SourceForge.net:
 
16
 
 
17
  git://duff.git.sourceforge.net/gitroot/duff/duff
 
18
 
 
19
The version numbering scheme for duff is as follows:
 
20
 
 
21
 * The first number is the major version.  This will be updated upon what the
 
22
   author considers a round of feature completion.
 
23
 
 
24
 * The second number is the minor version number.  This is updated for releases
 
25
   that include minor new features, or features that do not change the
 
26
   functionality of the program.
 
27
 
 
28
 * The third number, if present, is the bugfix release number.  This indicates
 
29
   a release which only fixes bugs present in a previous major or minor release.
 
30
 
 
31
 
 
32
1. License and copyright
 
33
========================
 
34
 
 
35
Duff is copyright (c) 2005 Camilla Berglund <elmindreda@elmindreda.org>
 
36
 
 
37
Duff is licensed under the zlib/libpng license.  See the file `COPYING' for
 
38
license details.  The license is also included at the top of each source file.
 
39
 
 
40
Duff contains shaX-asaddi.
 
41
Copyright (c) 2001-2003 Allan Saddi <allan@saddi.com>
 
42
See the files `src/sha*.c' and `src/sha*.h' for license details.
 
43
 
 
44
Duff uses the gettext.h convenience header from GNU gettext.
 
45
Copyright (C) 1995-1998, 2000-2002, 2004-2006, 2009 Free Software Foundation,
 
46
Inc.  See the `lib/gettex.h' for license details.
 
47
 
 
48
Duff comes with a number of files provided by the GNU autoconf, automake and
 
49
gettext packages.  See the individual files in question for license details.
 
50
 
 
51
 
 
52
2. Project news
 
53
===============
 
54
 
 
55
See the file `NEWS'.
 
56
 
 
57
 
 
58
3. Building Duff
 
59
================
 
60
 
 
61
If you got this source tree from a Git repository then you will need to
 
62
bootstrap the build environment using first `gettextize' and then `autoreconf
 
63
-i'.  Note that this requires that GNU autoconf, automake and gettext are
 
64
installed.  Also note that running gettextize may cause a few duplicate entries
 
65
in various build files.  If you got the source tree using Git, you can remove
 
66
these with `git reset --hard' before moving on.
 
67
 
 
68
If (or once) you have a `configure' script, go ahead and run it.  No additional
 
69
magic should be required.  If it is, then that's a bug and should be reported.
 
70
 
 
71
This release of duff has been successfully built on the following systems:
 
72
 
 
73
  Cygwin 1.7 i686
 
74
  Mac OS X 10.7 x86_64
 
75
  Ubuntu Natty x86_64
 
76
 
 
77
Earlier releases have been successfully built on the following systems:
 
78
 
 
79
  Arch Linux x86
 
80
  Cygwin 1.7 i686
 
81
  Darwin 7.9.0 powerpc
 
82
  Debian Etch powerpc
 
83
  Debian Etch x86
 
84
  Debian Lenny x86
 
85
  Debian Sarge alpha
 
86
  Debian Wheezy amd64
 
87
  FreeBSD 4.11 x86
 
88
  FreeBSD 5.4 x86
 
89
  FreeBSD 8.2 i386
 
90
  Mac OS X 10.3 powerpc
 
91
  Mac OS X 10.4 powerpc
 
92
  Mac OS X 10.6 i386
 
93
  Mac OS X 10.6 x86_64
 
94
  Mac OS X 10.6 x86_64 (with MacPorts gettext)
 
95
  NetBSD 1.6.1 sparc
 
96
  Red Hat Enterprise 4.0 x86
 
97
  SunOS 5.9 sparc64
 
98
  Ubuntu Breezy x86
 
99
  Ubuntu Jaunty x86
 
100
  Ubuntu Lucid amd64
 
101
  Ubuntu Maverick amd64
 
102
 
 
103
The tools used were GCC and GNU or BSD make.  However, it should build on most
 
104
Unix systems without modifications.
 
105
 
 
106
 
 
107
4. Installing Duff
 
108
==================
 
109
 
 
110
See the file `INSTALL'.
 
111
 
 
112
 
 
113
5. Using Duff
 
114
=============
 
115
 
 
116
See the accompanying manpage duff(1).
 
117
 
 
118
To read the manpage before installation, use the following command:
 
119
 
 
120
  groff -mdoc -Tascii duff.1 | less -R
 
121
 
 
122
On GNU/Linux systems, however, the following command may suffice:
 
123
 
 
124
  man -l duff.1
 
125
 
 
126
 
 
127
6. Hacking Duff
 
128
===============
 
129
 
 
130
See the file `HACKING'.
 
131
 
 
132
 
 
133
7. Bugs, feedback and patches
 
134
=============================
 
135
 
 
136
Please send bug reports, feedback, patches and cookies to:
 
137
 
 
138
  Camilla Berglund <elmindreda@elmindreda.org>
 
139
 
 
140
Or, if you prefer, you may use the trackers on SF.net to report bugs, submit
 
141
patches or request features:
 
142
 
 
143
  http://sourceforge.net/projects/duff
 
144
 
 
145
For more involved discussions, please join the mailing list:
 
146
 
 
147
  http://lists.sourceforge.net/lists/listinfo/duff-devel
 
148
 
 
149
 
 
150
8. Credits and thanks
 
151
=====================
 
152
 
 
153
The following (alphabetically listed) people have contributed to duff, either
 
154
by reporting bugs, suggesting new features or submitting patches:
 
155
 
 
156
Harald Barth
 
157
Alexander Bostrom
 
158
Magnus Danielsson
 
159
Stephan Hegel
 
160
Patrik Jarnefelt
 
161
Rasmus Kaj
 
162
Mika Kuoppala
 
163
Richard Levitte
 
164
Fernando Lopez
 
165
Clemens Lucas Fries
 
166
Kamal Mostafa
 
167
Ross Newell
 
168
Allan Saddi <allan@saddi.com>
 
169
 
 
170
...and everyone I forgot.  Did I forget you?  Drop me an email.
 
171
 
 
172
 
 
173
9. Disambiguation
 
174
=================
 
175
 
 
176
This is duff the Unix command-line utility, not DUFF the Windows program.
 
177
If you wish to find duplicate files on Windows, use DUFF.
 
178
 
 
179
DUFF also has a SourceForge.net URL:
 
180
 
 
181
  http://dff.sourceforge.net/
 
182
 
 
183
 
 
184
10. Release history
 
185
===================
 
186
 
 
187
Version 0.1 was named `duplicate' and was never released anywhere.
 
188
 
 
189
Version 0.2 was the first release named duff.  It lacked a real checksumming
 
190
algorithm, and was thus only released to a few individuals, during the first
 
191
half of 2005.
 
192
 
 
193
Version 0.3 was the first official release, on November 22, 2005, after a
 
194
long search for a suitably licensed implementation of SHA1.
 
195
 
 
196
Version 0.3.1 was a bugfix release, on November 27, 2005, adding a single
 
197
feature (-z), which just happened to get included.
 
198
 
 
199
Version 0.4 was the second feature release, on January 13, 2006, adding a
 
200
number of missing and/or requested features as well as bug fixes.  It was the
 
201
first release to be considered stable and safe enough for everyday use.
 
202
 
 
203
Version 0.5 was the third feature release, on April 11, 2011, adding a number
 
204
of minor features and fixing a number of bugs.  It was mostly intended to get
 
205
the ball rolling again and thus low on features.
 
206
 
 
207
Version 0.5.1 was a bugfix release, on January 17, 2012, adding a single bugfix
 
208
and a new default cluster header for thorough mode.
 
209
 
 
210
Version 0.5.2 was an minor release, on January 29, 2012, adding a number of
 
211
optimizations, prefixing error and warning messages with the program name and
 
212
modifying the default sampling limit.
 
213