mirror of
https://github.com/arsenetar/dupeguru.git
synced 2026-01-22 06:37:17 +00:00
Update documentation
This commit is contained in:
Virgil Dupras
@@ -28,12 +28,16 @@ dupeGuru's source code is on Github and thus managed in a Git repository. At all
|
||||
be able to build from source a fresh checkout of the ``master`` branch using instructions from the
|
||||
``README.md`` file at the root of this project. If you can't, it's a bug. Please report it.
|
||||
|
||||
Bugfixes happen directly in the ``master`` branch, but feature development takes place in the
|
||||
``develop`` branch. When implementing a big feature, it's possible that it gets its own branch until
|
||||
it's stable enough to merge into ``develop``.
|
||||
``master`` is the main development branch, and thus represents what going to be included in the
|
||||
next feature release. When needed, we create maintenance branches for bugfixes of the current
|
||||
feature release.
|
||||
|
||||
Every release is tagged, the tag name containing the edition and its version. For example, release
|
||||
6.6.0 of dupeGuru ME is tagged ``me6.6.0``.
|
||||
When implementing a big feature, it's possible that it gets its own branch until
|
||||
it's stable enough to merge into ``master``.
|
||||
|
||||
Every release is tagged, the tag name containing the edition (for old versions) and its version.
|
||||
For example, release 6.6.0 of dupeGuru ME is tagged ``me6.6.0``. Newer releases are tagged only
|
||||
with the version number (because editions don't exist anymore), for example ``4.0.0``.
|
||||
|
||||
Once you're past building the software, the :doc:`developer documentation </developer/index>` should
|
||||
be enough to get you started with actual development. Then again, proper documentation is a very
|
||||
@@ -77,7 +81,7 @@ agree on what should be added to the documentation.
|
||||
**Translation**. Creating or improving an existing translation is a very good way to contribute to
|
||||
dupeGuru. For more information about how to do that, you can refer to the `translator guide`_.
|
||||
|
||||
.. _been open source: http://www.hardcoded.net/articles/free-as-in-speech-fair-as-in-trade
|
||||
.. _been open source: https://www.hardcoded.net/articles/free-as-in-speech-fair-as-in-trade
|
||||
.. _let me know: mailto:hsoft@hardcoded.net
|
||||
.. _Source code repository: https://github.com/hsoft/dupeguru
|
||||
.. _Issue Tracker: https://github.com/hsoft/dupeguru/issues
|
||||
|
||||
@@ -3,10 +3,9 @@ Credits
|
||||
|
||||
Below is the list of people who contributed, directly or indirectly to dupeGuru.
|
||||
|
||||
| **Virgil Dupras, Developer** (`Website <http://www.hardcoded.net>`__)
|
||||
| **Virgil Dupras, Developer** (`Website <https://www.hardcoded.net>`__)
|
||||
|
||||
| **Jérôme Cantin, Icon designer**
|
||||
| Icons in dupeGuru are from him
|
||||
| **Jérôme Cantin, Main icon**
|
||||
|
||||
| **Gregor Tätzner, German localization**
|
||||
|
||||
@@ -32,14 +31,3 @@ Below is the list of people who contributed, directly or indirectly to dupeGuru.
|
||||
|
||||
| **Phan Anh, Vietnamese localization**
|
||||
|
||||
| **Python, Programming language** (`Website <http://www.python.org>`__)
|
||||
| The bestest of the bests
|
||||
|
||||
| **PyQt, Python-to-Qt bridge** (`Website <http://www.riverbankcomputing.co.uk>`__)
|
||||
| Used for the Windows version
|
||||
|
||||
| **Sparkle, Auto-update library** (`Website <http://andymatuschak.org/pages/sparkle>`__)
|
||||
| Used for the Mac OS X version
|
||||
|
||||
| **You, dupeGuru user**
|
||||
| You rock.
|
||||
|
||||
@@ -6,19 +6,12 @@ Frequently Asked Questions
|
||||
What is dupeGuru?
|
||||
-----------------
|
||||
|
||||
dupeGuru is a tool to find duplicate files on your computer. It can scan either filenames or
|
||||
contents. The filename scan features a fuzzy matching algorithm that can find duplicate
|
||||
filenames even when they are not exactly the same.
|
||||
dupeGuru is a tool to find duplicate files on your computer. It has three operational modes:
|
||||
Standard, Music and Picture. Each mode has its own specialized preferences.
|
||||
|
||||
dupeGuru also comes in two extra flavors: Music Edition and Picture Edition. These editions behave
|
||||
like the normal dupeGuru, but has specialized options.
|
||||
|
||||
dupeGuru Music Edition [ME] is made to scan songs. It can base its scan on filenames, tags or
|
||||
contents. The filename and tag scans feature a fuzzy matching algorithm that can find duplicate
|
||||
filenames or tags even when they are not exactly the same.
|
||||
|
||||
dupeGuru Picture Edition [PE] is made to scan pictures. Not only can it find exact matches, but it
|
||||
can also find duplicates among pictures of different kind (PNG, JPG, GIF etc..) and quality.
|
||||
Each mode has multiple scan types, such as filename, contents, tags. Some scan types feature
|
||||
advanced fuzzy matching algorithm, allowing you to find duplicates that other more rigid duplicate
|
||||
scanners can't.
|
||||
|
||||
What makes it special?
|
||||
----------------------
|
||||
@@ -107,8 +100,6 @@ I want to mark all duplicates containing the word "copy". How do I do that?
|
||||
I want to remove all songs that are more than 3 seconds away from their reference file. What can I do?
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
*ME only*
|
||||
|
||||
* Enable the :doc:`Dupes Only <results>` mode.
|
||||
* Enable the **Delta Values** mode.
|
||||
* Click on the "Time" column to sort the results by time.
|
||||
@@ -120,8 +111,6 @@ I want to remove all songs that are more than 3 seconds away from their referenc
|
||||
I want to make my highest bitrate songs reference files. What can I do?
|
||||
-----------------------------------------------------------------------
|
||||
|
||||
*ME only*
|
||||
|
||||
* Enable the :doc:`Dupes Only <results>` mode.
|
||||
* Enable the **Delta Values** mode.
|
||||
* Click on the "Bitrate" column to sort the results by bitrate.
|
||||
@@ -155,31 +144,24 @@ I've tried to send my duplicates to Trash, but dupeGuru is telling me it can't d
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
Most of the time, the reason why dupeGuru can't send files to Trash is because of file permissions.
|
||||
You need *write* permissions on files you want to send to Trash. If you're not familiar with the
|
||||
command line, you can use utilities such as `BatChmod`_ to fix your permissions.
|
||||
You need *write* permissions on files you want to send to Trash.
|
||||
|
||||
If dupeGuru still gives you troubles after fixing your permissions, try enabling the "Directly
|
||||
delete files" option that is offered to you when you activate Send to Trash. This will not send
|
||||
files to the Trash, but delete them immediately. In some cases, for example on network storage
|
||||
(NAS), this has been known to work when normal deletion didn't.
|
||||
|
||||
*PE only.* If you're trying to delete *iPhoto* pictures, then the reason for the failure is
|
||||
different. The deletion fails because dupeGuru can't communicate with iPhoto. Be aware that for the
|
||||
deletion to work correctly, you're not supposed to play around iPhoto while dupeGuru is working.
|
||||
Also, sometimes, the Applescript system doesn't seem to know where to find iPhoto to launch it. It
|
||||
might help in these cases to launch iPhoto *before* you send your duplicates to Trash.
|
||||
If this fail, `HS forums`_ might be of some help.
|
||||
|
||||
If all of this fail, `HS forums`_ might be of some help.
|
||||
Why is Picture mode's contents scan so slow?
|
||||
--------------------------------------------
|
||||
|
||||
Why is dupeGuru PE so slower than other editions?
|
||||
-------------------------------------------------
|
||||
This scanning method is very different from methods. It can detect duplicate photos even if they
|
||||
are not exactly the same. This very cool capability has a cost: time. Every picture has to be
|
||||
individually and fuzzily matched to all others, and this takes a lot of CPU power.
|
||||
|
||||
dupeGuru PE's scanning method is very different from dupeGuru's. dupeGuru PE can detect duplicate
|
||||
photos even if they are not exactly the same. This very cool capability has a cost: time. Every
|
||||
picture has to be individually and fuzzily matched to all others, and this takes a lot of CPU power.
|
||||
|
||||
If all you need to find is exact duplicates, just use the standard edition of dupeGuru with the
|
||||
Contents scan method. If your photos have EXIF tags, you can also try PE's "EXIF" scan method which
|
||||
If all you need to find is exact duplicates, just use the standard mode of dupeGuru with the
|
||||
Contents scan method. If your photos have EXIF tags, you can also try the "EXIF" scan method which
|
||||
is much faster.
|
||||
|
||||
Where are user files located?
|
||||
@@ -190,18 +172,12 @@ Where they're located depends on your platform:
|
||||
|
||||
* Linux: ``~/.local/share/data/Hardcoded Software/dupeGuru``
|
||||
* Mac OS X: ``~/Library/Application Support/dupeGuru``
|
||||
* Windows: ``\Users\<username>\AppData\Local\Hardcoded Software\dupeGuru``
|
||||
|
||||
Preferences are stored elsewhere:
|
||||
|
||||
* Linux: ``~/.config/Hardcoded Software/dupeGuru.conf``
|
||||
* Mac OS X: In the built-in ``defaults`` system, as ``com.hardcoded-software.dupeguru``
|
||||
* Windows: In the registry, as ``HKEY_CURRENT_USER\Software\Hardcoded Software\dupeGuru``
|
||||
|
||||
For Music Edition and Picture Edition, replace "dupeGuru" by "dupeGuru Music Edition" and
|
||||
"dupeGuru Picture Edition".
|
||||
|
||||
.. _BatChmod: http://www.lagentesoft.com/batchmod/index.html
|
||||
.. _HS forums: https://forum.hardcoded.net/
|
||||
.. _Github: https://github.com/hsoft/dupeguru
|
||||
.. _open an issue: https://github.com/hsoft/dupeguru/wiki/issue-labels
|
||||
|
||||
@@ -2,13 +2,45 @@ Folder Selection
|
||||
================
|
||||
|
||||
The first window you see when you launch dupeGuru is the folder selection window. This windows
|
||||
contains the list of the folders that will be scanned when you click on **Scan**.
|
||||
contains the basic input dupeGuru needs to start a scan:
|
||||
|
||||
This window is quite straightforward to use. If you want to add a folder, click on the **+** button.
|
||||
If you added folder before, a popup menu with a list of recent folders you added will pop. You can
|
||||
click on one of them to add it directly to your list. If you click on the first item of the popup
|
||||
menu, **Add New Folder...**, you will be prompted for a folder to add. If you never added a folder,
|
||||
no menu will pop and you will directly be prompted for a new folder to add.
|
||||
* An Application Mode selection
|
||||
* A Scan Type selection
|
||||
* Folders to scan
|
||||
|
||||
Application Mode
|
||||
----------------
|
||||
|
||||
dupeGuru had three main modes: Standard, Music and Picture.
|
||||
|
||||
Standard is for any type of files. This makes this mode the most polyvalent, but it lacks
|
||||
specialized features other modes have.
|
||||
|
||||
Music mode scans only music files, but it supports tags comparison and its results window has many
|
||||
audio-related informational columns.
|
||||
|
||||
Picture mode scans only pictures, but its contents scan type is a powerful fuzzy matcher that can
|
||||
find pictures that are similar without being exactly the same.
|
||||
|
||||
Choosing an application mode not only changes available scan types in the selector below, but also
|
||||
changes available options in the preferences panel. Thus, if you want to fine tune your scan, be
|
||||
sure to open the preferences panel **after** you've selected the application mode.
|
||||
|
||||
Scan Type
|
||||
---------
|
||||
|
||||
This selector determines the type of the scan we'll do. See :doc:`scan` for details about scan
|
||||
types.
|
||||
|
||||
Folder List
|
||||
-----------
|
||||
|
||||
To add a folder, click on the **+** button. If you added folder before, a popup
|
||||
menu with a list of recent folders you added will pop. You can click on one of
|
||||
them to add it directly to your list. If you click on the first item of the
|
||||
popup menu, **Add New Folder...**, you will be prompted for a folder to add. If
|
||||
you never added a folder, no menu will pop and you will directly be prompted
|
||||
for a new folder to add.
|
||||
|
||||
An alternate way to add folders to the list is to drag them in the list.
|
||||
|
||||
@@ -37,31 +69,8 @@ folder if you want to be sure that you won't delete any file from it.
|
||||
When you set the state of a directory, all subfolders of this folder automatically inherit this
|
||||
state unless you explicitly set a subfolder's state.
|
||||
|
||||
.. _iphoto:
|
||||
Scan
|
||||
----
|
||||
|
||||
iPhoto and Aperture libraries
|
||||
-----------------------------
|
||||
|
||||
dupeGuru Picture Edition supports iPhoto and Aperture, which means that it knows how to read these
|
||||
libraries and how to communicate with iPhoto and Aperture to remove photos from them. To use this
|
||||
feature, use the special "Add iPhoto Library" and "Add Aperture Library" buttons in the menu that
|
||||
pops up when you click the "+" button. This will then add a special folder for those libraries.
|
||||
|
||||
When duplicates are deleted (sent to trash) from an iPhoto library, it's sent to iPhoto's
|
||||
trash.
|
||||
|
||||
When duplicates are deleted (sent to trash) from an Aperture library, it unfortunately can't
|
||||
send it directly to trash, but it creates a special project called "dupeGuru Trash" in Aperture
|
||||
and send all photos in there. You can then send this project to the trash manually.
|
||||
|
||||
iTunes library
|
||||
--------------
|
||||
|
||||
dupeGuru Music Edition supports iTunes, which means that it knows how to read its libraries and how
|
||||
to communicate with iTunes to remove songs from it. To use this feature, use the special
|
||||
"Add iTunes Library" button in the menu that pops up when you click the "+" button. This will
|
||||
then add a special folder for those libraries.
|
||||
|
||||
When duplicates are deleted from an iTunes library, it's sent to the system trash, like a
|
||||
normal file, but it's also removed from iTunes, thus avoiding ending up with missing entries
|
||||
(entries with the "!" logo next to them).
|
||||
When you're ready, click on the **Scan** button to initiate the scanning process. When it's done,
|
||||
you'll be shown the :doc:`results`.
|
||||
|
||||
@@ -1,47 +1,24 @@
|
||||
|appname| help
|
||||
===============
|
||||
dupeGuru help
|
||||
=============
|
||||
|
||||
.. only:: edition_se
|
||||
|
||||
This help document is also available in these languages:
|
||||
|
||||
* `French <http://www.hardcoded.net/dupeguru/help/fr>`__
|
||||
* `German <http://www.hardcoded.net/dupeguru/help/de>`__
|
||||
* `Armenian <http://www.hardcoded.net/dupeguru/help/hy>`__
|
||||
* `Russian <http://www.hardcoded.net/dupeguru/help/ru>`__
|
||||
* `Ukrainian <http://www.hardcoded.net/dupeguru/help/uk>`__
|
||||
This help document is also available in these languages:
|
||||
|
||||
.. only:: edition_me
|
||||
|
||||
This help document is also available in these languages:
|
||||
|
||||
* `French <http://www.hardcoded.net/dupeguru_me/help/fr>`__
|
||||
* `German <http://www.hardcoded.net/dupeguru_me/help/de>`__
|
||||
* `Armenian <http://www.hardcoded.net/dupeguru_me/help/hy>`__
|
||||
* `Russian <http://www.hardcoded.net/dupeguru_me/help/ru>`__
|
||||
* `Ukrainian <http://www.hardcoded.net/dupeguru_me/help/uk>`__
|
||||
* `French <http://www.hardcoded.net/dupeguru/help/fr>`__
|
||||
* `German <http://www.hardcoded.net/dupeguru/help/de>`__
|
||||
* `Armenian <http://www.hardcoded.net/dupeguru/help/hy>`__
|
||||
* `Russian <http://www.hardcoded.net/dupeguru/help/ru>`__
|
||||
* `Ukrainian <http://www.hardcoded.net/dupeguru/help/uk>`__
|
||||
|
||||
.. only:: edition_pe
|
||||
|
||||
This help document is also available in these languages:
|
||||
|
||||
* `French <http://www.hardcoded.net/dupeguru_pe/help/fr>`__
|
||||
* `German <http://www.hardcoded.net/dupeguru_pe/help/de>`__
|
||||
* `Armenian <http://www.hardcoded.net/dupeguru_pe/help/hy>`__
|
||||
* `Russian <http://www.hardcoded.net/dupeguru_pe/help/ru>`__
|
||||
* `Ukrainian <http://www.hardcoded.net/dupeguru_pe/help/uk>`__
|
||||
|
||||
.. only:: edition_se or edition_me
|
||||
dupeGuru is a tool to find duplicate files on your computer. It has three
|
||||
modes, Standard, Music and Picture, with each mode having its own scan types
|
||||
and little features.
|
||||
|
||||
|appname| is a tool to find duplicate files on your computer. It can scan either filenames or contents. The filename scan features a fuzzy matching algorithm that can find duplicate filenames even when they are not exactly the same.
|
||||
Although dupeGuru can easily be used without documentation, reading this file
|
||||
will help you to master it. If you are looking for guidance for your first
|
||||
duplicate scan, you can take a look at the :doc:`Quick Start <quick_start>`
|
||||
section.
|
||||
|
||||
.. only:: edition_pe
|
||||
|
||||
dupeGuru Picture Edition (PE for short) is a tool to find duplicate pictures on your computer. Not only can it find exact matches, but it can also find duplicates among pictures of different kind (PNG, JPG, GIF etc..) and quality.
|
||||
|
||||
Although dupeGuru can easily be used without documentation, reading this file will help you to master it. If you are looking for guidance for your first duplicate scan, you can take a look at the :doc:`Quick Start <quick_start>` section.
|
||||
|
||||
It is a good idea to keep |appname| updated. You can download the latest version on its `homepage`_.
|
||||
It is a good idea to keep dupeGuru updated. You can download the latest version on its `homepage`_.
|
||||
|
||||
Contents:
|
||||
|
||||
@@ -65,3 +42,5 @@ Indices and tables
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`search`
|
||||
|
||||
.. _homepage: https://www.hardcoded.net/dupeguru
|
||||
|
||||
@@ -1,27 +1,18 @@
|
||||
Preferences
|
||||
===========
|
||||
|
||||
**Scan Type:**
|
||||
Basic scan type to use. See :doc:`scan` for details.
|
||||
**Tags to scan:**
|
||||
When using the **Tags** scan type, you can select the tags that will be used for comparison.
|
||||
|
||||
.. only:: edition_me
|
||||
**Word weighting:**
|
||||
See :ref:`word-weighting`.
|
||||
|
||||
**Tags to scan:**
|
||||
When using the **Tags** scan type, you can select the tags that will be used for comparison.
|
||||
**Match similar words:**
|
||||
See :ref:`similarity-matching`.
|
||||
|
||||
.. only:: edition_se or edition_me
|
||||
|
||||
**Word weighting:**
|
||||
See :ref:`word-weighting`.
|
||||
|
||||
**Match similar words:**
|
||||
See :ref:`similarity-matching`.
|
||||
|
||||
.. only:: edition_pe
|
||||
|
||||
**Match pictures of different dimensions:**
|
||||
If you check this box, pictures of different dimensions will be allowed in the same
|
||||
duplicate group.
|
||||
**Match pictures of different dimensions:**
|
||||
If you check this box, pictures of different dimensions will be allowed in the same
|
||||
duplicate group.
|
||||
|
||||
.. _filter-hardness:
|
||||
|
||||
@@ -84,4 +75,4 @@ will contain spaces. Here's an example custom command::
|
||||
"C:\Program Files\SuperDiffProg\SuperDiffProg.exe" "%d" "%r"
|
||||
|
||||
.. _inode: http://en.wikipedia.org/wiki/Inode
|
||||
.. _regular-expressions.info: http://www.regular-expressions.info
|
||||
.. _regular-expressions.info: http://www.regular-expressions.info
|
||||
|
||||
@@ -167,10 +167,6 @@ Action Menu
|
||||
**Rename Selected:**
|
||||
Prompts you for a new name, and then rename the selected file.
|
||||
|
||||
**Warning about moving files in iPhoto/iTunes/Aperture:** When using the "Move Marked" action on
|
||||
duplicates that come from iPhoto, Aperture or iTunes, files are copied, not moved. dupeGuru cannot
|
||||
use the Move action on those files.
|
||||
|
||||
Deletion Options
|
||||
----------------
|
||||
|
||||
|
||||
@@ -4,8 +4,8 @@ The scanning process
|
||||
.. contents::
|
||||
|
||||
dupeGuru has 3 basic ways of scanning: :ref:`worded-scan` and :ref:`contents-scan` and
|
||||
:ref:`picture blocks <picture-blocks-scan>`. The first two modes are for the Standard and Music
|
||||
editions, the last is for the Picture edition. The scanning process is configured through the
|
||||
:ref:`picture blocks <picture-blocks-scan>`. The first two types are for the Standard and Music
|
||||
modes, the last is for the Picture mode. The scanning process is configured through the
|
||||
:doc:`Preference pane <preferences>`.
|
||||
|
||||
.. _worded-scan:
|
||||
@@ -13,8 +13,6 @@ editions, the last is for the Picture edition. The scanning process is configure
|
||||
Worded scans
|
||||
------------
|
||||
|
||||
*Standard and Music Editions only*.
|
||||
|
||||
Worded scans extract a string from each file and split it into words. The string can come from two
|
||||
different sources: **Filename** or **Tags** (Music Edition only).
|
||||
|
||||
@@ -38,8 +36,6 @@ we have a duplicate match. For example, "a b c d" and "c d e" have a matching pe
|
||||
Fields
|
||||
^^^^^^
|
||||
|
||||
*Music Edition only*.
|
||||
|
||||
Song filenames often come with multiple and distinct parts and this can cause problems. For example,
|
||||
let's take these two songs: "Dolly Parton - I Will Always Love You" and
|
||||
"Whitney Houston - I Will Always Love You". They are clearly not the same song (they come from
|
||||
@@ -112,23 +108,13 @@ having the same MD5 hash *and* the same size by accident is still very, very sma
|
||||
|
||||
The :ref:`filter hardness <filter-hardness>` preference is ignored in this scan.
|
||||
|
||||
Audio contents
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
*Music Edition only*.
|
||||
|
||||
This mode is very much like the normal contents scan. The only difference is that it ignores
|
||||
metadata included in the file and only compares audio data. *It doesn't do audio data fuzzy
|
||||
matching, only exact matching. It would be really cool to have that, but we aren't there yet.*
|
||||
|
||||
Folders
|
||||
^^^^^^^
|
||||
|
||||
*Standard Edition only*.
|
||||
|
||||
This is a special Contents scan type. It works like a normal contens scan, but instead of trying to
|
||||
find duplicate files, it tries to find duplicate folders. A folder is duplicate to another if all
|
||||
files it contains have the same contents as the other folder's file.
|
||||
This is a special Contents scan type. It works like a normal contents scan, but
|
||||
instead of trying to find duplicate files, it tries to find duplicate folders.
|
||||
A folder is duplicate to another if all files it contains have the same
|
||||
contents as the other folder's file.
|
||||
|
||||
This scan is, of course, recursive and subfolders are checked. dupeGuru keeps only the biggest
|
||||
fishes. Therefore, if two folders that are considered as matching contain subfolders, these
|
||||
@@ -141,9 +127,7 @@ With this mode, we end up with folders as results instead of files.
|
||||
Picture blocks
|
||||
--------------
|
||||
|
||||
*Picture Edition only*.
|
||||
|
||||
dupeGuru Picture Edition stands apart of its two friends. Its scan types are completely different.
|
||||
dupeGuru Picture mode stands apart of its two friends. Its scan types are completely different.
|
||||
The first one is its "Contents" scan, which is a bit too generic, hence the name we use here,
|
||||
"Picture blocks".
|
||||
|
||||
@@ -174,8 +158,6 @@ algorithm and want to improve dupeGuru, by all means, let me know!
|
||||
EXIF Timestamp
|
||||
--------------
|
||||
|
||||
*Picture Edition only*.
|
||||
|
||||
This one is easy. We read the EXIF information of every picture and extract the ``DateTimeOriginal``
|
||||
tag. If the tag is the same for two pictures, they're considered duplicates.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user