|

``rmlint`` finds space waste and other broken things on your filesystem and offers
to remove it. It is able to find:

.. hlist::
   :columns: 2

   + Duplicate files & directories.
   + Nonstripped Binaries
   + Broken symlinks.
   + Empty files.
   + Recursive empty directories.
   + Files with broken user or group id.

**Key Features:**

.. hlist::
   :columns: 3

   + Extremely fast.
   + Flexible and easy commandline options.
   + Choice of several hashes for hash-based duplicate detection
   + Option for exact byte-by-byte comparison (only slightly slower).
   + Numerous output options.
   + Option to store time of last run; next time will only scan new files.
   + Many options for original selection / prioritisation.
   + Can handle very large file sets (millions of files).
   + Colorful progressbar. (😃)


User manual
-----------

Although ``rmlint`` is easy to use, you might want to read these chapters first.
They show you the basic principles and most of the advanced options:

.. toctree::
   :maxdepth: 2

   install
   tutorial
   gui
   cautions
   faq

If you have usage questions or find weird behaviour, you can also try to reach
us via *IRC* in ``#rmlint`` on ``irc.freenode.net``.

Since version ``2.4.0`` we also feature an optional graphical user interface:

.. raw:: html

   <center>
    <iframe srcdoc="<a href='https://player.vimeo.com/video/139999878'>Vimeo video: Shredder - a GUI frontend to rmlint</a>" width="780"
    height="450"
    frameborder="0" webkitallowfullscreen mozallowfullscreen
    allowfullscreen></iframe>
   </center>

Informative reference
---------------------

These chapters are informative and are not essential for the average
user. People that want to extend ``rmlint`` might want to read this though: 

.. toctree::
   :maxdepth: 1
       
   developers
   translators
   benchmarks
   Online-manpage of rmlint(1) <rmlint.1>

The Changelog_ is also updated with new and futures features, fixes and overall
changes.

.. _Changelog: https://github.com/sahib/rmlint/blob/develop/CHANGELOG.md


Authors
-------

``rmlint`` was and is written by: 

===================================  ============================= ===========================================
*Christopher Pahl*                   https://github.com/sahib      2010-2019
*Daniel Thomas*                      https://github.com/SeeSpotRun 2014-2019
===================================  ============================= ===========================================

Additional thanks to:

.. hlist::
    :columns: 3

    - `vvs-`_ (Scalability testing)
    - *Attila* Toth 
    - All sane bugreporters (there are not many)
    - All packagers, porters and patchers.


.. _qitta: https://github.com/qitta
.. _dieterbe: https://github.com/Dieterbe
.. _`My cats`: http://imgur.com/gallery/rims0yl
.. _`vvs-`: https://github.com/vvs-?tab=activity

License
-------

``rmlint`` is licensed under the terms of GPLv3_.

.. _GPLv3: http://www.gnu.org/copyleft/gpl.htm
.. _sahib: https://github.com/sahib
.. _SeeSpotRun: https://github.com/SeeSpotRun

Donations
---------

If you think rmlint saved [*]_ you some serious time and/or space, you might
consider a donation. You can donate either via *Flattr* or via *PayPal*:

.. image:: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAF0AAAAUCAYAAADvJjFnAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyNpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuNS1jMDE0IDc5LjE1MTQ4MSwgMjAxMy8wMy8xMy0xMjowOToxNSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENDIChNYWNpbnRvc2gpIiB4bXBNTTpJbnN0YW5jZUlEPSJ4bXAuaWlkOjBCNUJBMzg3QjFGRjExRTVCRjE4RDUwMjgzMTMxMTZDIiB4bXBNTTpEb2N1bWVudElEPSJ4bXAuZGlkOjBCNUJBMzg4QjFGRjExRTVCRjE4RDUwMjgzMTMxMTZDIj4gPHhtcE1NOkRlcml2ZWRGcm9tIHN0UmVmOmluc3RhbmNlSUQ9InhtcC5paWQ6MEI1QkEzODVCMUZGMTFFNUJGMThENTAyODMxMzExNkMiIHN0UmVmOmRvY3VtZW50SUQ9InhtcC5kaWQ6MEI1QkEzODZCMUZGMTFFNUJGMThENTAyODMxMzExNkMiLz4gPC9yZGY6RGVzY3JpcHRpb24+IDwvcmRmOlJERj4gPC94OnhtcG1ldGE+IDw/eHBhY2tldCBlbmQ9InIiPz64sPXSAAAFMUlEQVR42uxYe0xbVRj/TntbC6zFFYWtc5rswSOG9A9gU0HHlvAHMjQhMcY0Ib4i+AfiWEQlMSDqYlCRCOpAjZGka7Igf6xuLiFKl4AGmW6sJlCCug3GILZEylPae4/nnPaW1nu7lfUSH+mXnN5zvu87j/6+x/nuRa+cOaRFWNWEkfAkAGyHBG0KIVDNIL/mpPZy9lscYPRGSoq+/sgDn0OSxkCEKKSIMaa/IADPxmqkiXELzOZ+5KxOoB0knvdvW/D+8cLKjgkjhwXh6dr7P4FkTarUOggxG6lBdcubTS26EogHSa3VgJ+DRzlewHekaLZGVRwZGQG73Q6jo6OwuroqkWu1WmhoaIDc3NyIYEJIjJYE2CL5sY/kDJWew37MQJIo+P3Q3t4OAwMDURdRqVRQV1fHAPd6vWAwGKTRIqBN/SPP5L4H10g0nf2t6z8BPMWbw1FcUQRcrVZDRUUFFBcXQ3p6OnR1dUFfXx8DvL6+HgoKCsDtdkNTUxN0dHRIN4nT1d9+6Jws3zraCM7fHbDn9jx6hcS8jyXnddihz4SWH56I4Nfvs8G1hXG27qaCTo7JCQIOpYLwlCIC3tzcDNnZ2Yzf09MjAZwdmPTn5+flLxAFDupZnYah6/YInnvlemhtvIF9dJwejDqTRJ/yPGFrbhZRvAnoUgHN4ZSoh4uAU1peXmaGqK2tDQFOKRrgLAUJ8R90joBx7soJ6doy++zdmgelu6qIN2eReQFjOa4G5r683wbGJBPrv0Mi6OtfO+ESiRbKF+dS/qcjdXDgbgsbD03bYb+pnOmK68QHOjmrXFjSS5MSTSnhVFlZCVarFQoLC2PfhKwfTxN9ORa5aUsmPGtuZZ7/petdFiHUAPu2lzN5PwHNQwxB6cwvnTDpdcHSmpf1WUQRGe27mU5gbZqK+q9amW68/4U2ijfxdKkrilVKRkaGRKbRaDZs2XiJhn7xTksE79sr1og8SffRqfUwPnceTk90wtSCCy7M9MObB05D7p3F8N3UKdZoP414+zeX1+fT/sO7qxjoIl+0Z7ezMWQoZdKLQC5SPrABkikyEEIxXAw46juYUiUjBalsT1UELxw0cR+X5zxrdxmySGrIl8hvNI7Gdy9PK5rTKd7k5QjHBC4ln88n8fTZ2dnABaXTSd5KGfQKoE69t/PHIzImDRuTfahxqvLeZ0+Qkd9ovFG9Wwad4K2it2ksNDg4CBaLBbq7uyP4DoeDPXNycv7xGrhsbzUD/NjA43C070HW/m0UrF6EoFdG+k5q6vpngeHhYWhra2P5KDk5OcQfGxuD3t5e1i8vL5dPL0rUYPgm6wTly2sLbHjwHgtMkYsvMy1fMn8lqFO2uxoukpxP9RjftwA7ScVzn+kRGCcpKhioypxfktNlwsdkMkFjY2MI8JaWFqZcUlLCysiZmRnm4RRwnuehqKgIzGazbK7HCoXnzdah8q9cH0OSRg/mbQdZ+37yFHiCOVmcbyc6tGw8tMvCcJ2cH2P8kz+3wOGs5+Gxe1+CLy68ptjLndw50VPH8/Fnzw2RvL5e9Yqv9OGARyMKeE1NDXAcJ3G/Dy9VwcTUaOKjSxjNT64CBzyOAJwSBdzpdEJra6ss4PTSpDmcppS/e7jSnwH+f994WU5Hc4trHuMWbVqEjH7EstlscayOwouYBAUrFyyol1SIV9tePFEKBPhAWSj8SbxTUAAtHKp7Ew3Av4Zhac4HujXjT+jVYzXps7dd/MCHVkox4g0Jf9wcUmFuMUkwjhw/erboLwEGAEWscT1pVpBeAAAAAElFTkSuQmCC
   :target: http://flattr.com/thing/302682/libglyr
   :align: center 
   :width: 9%
   :alt: flattr-badge-large.png

.. raw:: html

   <br />
   <center>
       <form action="https://www.paypal.com/cgi-bin/webscr" method="post">
           <input type="hidden" name="cmd" value="_s-xclick">
           <input type="hidden" name="hosted_button_id" value="JXCXKRMS8EDVC">
           <input type="image" src="data:image/gif;base64,R0lGODlhSgAVAPcmAP+sLf7iq/7gpf7ksf7en/+6Tf+vM7+LNv+xOu7bskBedhA+a/+0QN+aLo9/WHBuWxA+aoCQl0BfeXB+f2BhUc+TMn+Jg7+YU76zkZ+HVp6jmX+Nj97Qre+iKo6Xk56gke+yT/63R3+LiTBUdO7Tm1BdXs4HAkBfd+7ZrH+Khs+VON7MomB0fkBgeq6ojf7HbGBze765o87Bnp6hlf/s0M7Do/7Rhb62mjBKWxA7YjBUczBUcv64SmB2gp9+Qs7EqP/89jBTcY6Uif+lNEBedN+dNIBwSa6wov/NgtEQBY6Vjb+OO/7amP++Xf+3RlBpev7UjP/Ti6+QVb++r8+hUs6/mf/05P/CYNEOBc6+lN7Knf7epP+oLH+MjJ6fjVBrfmBmXf/05v/ryf61Rv/ZoCBJbv/it3BoTY6WkP/py//YnyBCX/+vOkBVYP+/Wf63S767qP7WjP65Tf/w2f/FZu/gwv/u0++kMVBsgmB1gP7hqmB4h//uzv7dnv/w2HCAhP7Qf66smf+mLf/boP6/WTBMYf7Jcv+uM//y2yBIba6unv/sz//itv+pNP+yP/7mt/+pJv/15//rzv7pvv/syP/dqv/46v/03//OhP/w0/+/Xv+xOAAzZswAAP+ZMwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH5BAEAACYALAAAAABKABUAAAj/AE0IHGjCk8GDCBMqXMiwocOEBCMONLgoTKSLGC8CAZKxo8ePIEN+tJLGoMSJcyypXMmypcuXMGPKfGnH00lPfi7p3Mmzp8+fQIMKDYrIJkFPYjIpXcq0qdOnUKNKncrHaMFBlLJq3cqVUoSvEaZ0HUuWa52yaClFMeppktu3cONOgsOpbt09cvPqfXsEz96/k6DY9MRjy6PDiBMr9sBJw6MELTj9OBxjgwcOhznESKBhQ4LDnDdoSJBAEacWmH9Y/qy49WEbPAy+MTSgtu3buHtwqlE7EKcuA3SPWLCA9xdOEkYgH4CCuATkaOzOmMFp+AIUuLMP0ENIjsExIWwE/xhPvnx5HZzI3+Ak4gOnPwFWcMoTAP2HABDSyxAhI8CJ9CJwcoN8JwTgnhLmJRjACyGEYJAjDDDwQh8CVGjhhRVyooCFQnDixROcaJHhhpzsMKIAVbCgQBklCqAAJwJ0qEAKLHCSAoYYMuFGhAwYxAYCQDJARxwEFGmkkRhwMkGRJCQCAQlEcFJkFpzAkOSSV5IAQRAuuKAkAVsSYEGVFpSJwZFHAnIFkGwadIgBcMZpQAF01kmnA5w8cIEUhXDiQAEPcJIBCG1wcgGeGRSA6AV5glCCoFRwUkIBjD6gKBgg2EmnE3LKaZAgAIQq6qikUmAXJzkYEeodONSVgw8AmLCqQqyczNoqJ2twskQRdVEAwBl2wUrqsKJyMRgkyCar7LIVHODsActC0mwHyDZbLbTIHtBAB9pC0kC33h5AbbTkIsvWEJukq+667Lbr7rvwxitvuo1Y5UkTmuSr77789uvvvwAHLLAmVgnkCRKYJKzwwgw37PDDEEccccETqVHJxRhnrPHGHHfs8ccck0HxUZ6YIcnJKKNMAw0pt+zyyzDHDDMjJp1E8kM456wzQycFBAA7" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
           <img alt="" border="0" src="data:image/gif;base64,R0lGODlhAQABAAD/ACwAAAAAAQABAAACADs=" width="1" height="1">
       </form>
   </center>
   <br />

Or just buy us a beer if we ever meet. Nice emails are okay too.

.. [*] If it freed you from your beloved data: *Sorry.* [*]_
.. [*] Please file a bug or read the source and provide a patch. [*]_
.. [*] For more than 100GB of data loss we owe you one beer. [*]_
.. [*] If you don't like beer or there's only Budweiser available, you can order
   a Club Mate.
