Small fix.
[double-file-scanner.git] / README.txt
blob62aae3394a4a9419ee915b7751359d00e26f4d99
1 Double File Scanner
2 Copyright (C) 2014-2017 LoRd_MuldeR <MuldeR2@GMX.de>. Some rights reserved.
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
18 Please check http://muldersoft.com/ for news and updates!
21 ------------------------------------------------------------------------------
22 1. Introduction
23 ------------------------------------------------------------------------------
25 The purpose of this tool is scanning the selected directory or directories for
26 duplicate files, i.e. files with identical content. Duplicate files are
27 identified by first calculating the SHA-1 digest of each file and then looking
28 for values that appear more than once. In particular, files with identical
29 content are guaranteed to have the same SHA-1 digest, while files with
30 differing content will have different SHA-1 values with very high certainty.
32 All computed SHA-1 values are stored in a hash table, so collisions are found
33 quickly and we do NOT need to compare every digest to every other one. Also,
34 the files are processed concurrently in multiple "worker" threads in order to
35 parallelize and speed-up the SHA-1 computations on multi-core processors. On
36 our test machine it took ~15 minutes to analyse all the ~260,000 files on the
37 system drive (~63.5 GB). During this operation ~44,000 duplicates were found.
39 Once the scan is completed, the program provides commands to review, rename or
40 delete the duplicate files manually. Alternatively, the "automatic clean-up"
41 wizard may be invoked in order to remove ALL redundant files at a single blow.
42 Optionally, the list of duplicates can be exported to the XML or INI format.
45 ------------------------------------------------------------------------------
46 2. Platform Support
47 ------------------------------------------------------------------------------
49 The following platforms are supported:
50 - Windows 10, 32-Bit and 64-Bit versions
51 - Windows 8 and 8.1, 32-Bit and 64-Bit versions
52 - Windows 7, 32-Bit and 64-Bit versions
54 Platforms that should work too, but are not tested extensively:
55 - Windows Vista, 32-Bit and 64-Bit versions
56 - Windows XP, Service Pack 3 is required!
57 - Windows XP Professional x64 Edition, Service Pack 2 is required!
60 ------------------------------------------------------------------------------
61 3. Anti-Virus Warning
62 ------------------------------------------------------------------------------
64 Anti-Virus programs can interfere with the Double File Scanner software and
65 significantly slow down the process! Therefore it is highly recommend to turn
66 off the "real time scanner" or "guard" feature of your Anti-Virus program
67 while the Double File Scanner is running. But don't forget to re-enable it!
70 ------------------------------------------------------------------------------
71 4. Command-Line Options
72 ------------------------------------------------------------------------------
74 The following command-line options are available:
75   --console           Enable the debug console
76   --scan <directory>  Scan the specified directory, can be used multiple times
78 List of influential environment variables:
79   DBLSCAN_THREADS     Set the number of worker threads (default: auto detect)
82 ------------------------------------------------------------------------------
83 5. Source Code
84 ------------------------------------------------------------------------------
86 Find the Double File Scanner source code at our official Git mirrors:
87 - https://github.com/lordmulder/DoubleFilerScanner
88 - https://gitlab.com/double-file-scanner/double-file-scanner
89 - https://bitbucket.org/muldersoft/doubefilescanner
90 - https://app.assembla.com/spaces/doublefilerscanner/
92 More free software available at MuldeR's OpenSource Projects web-site:
93 http://muldersoft.com/
96 ------------------------------------------------------------------------------
97 6. Frequently Asked Question
98 ------------------------------------------------------------------------------
100 Q: Can the scanning process be aborted?
101 A: Yes, simply press the 'ESC' key!
102   
103 Q: Can the scanning process be suspended/resumed?
104 A: Yes, simply press the 'Pause' key!
107 E.O.F.