1|
2
3``rmlint`` finds space waste and other broken things on your filesystem and offers
4to remove it. It is able to find:
5
6.. hlist::
7   :columns: 2
8
9   + Duplicate files & directories.
10   + Nonstripped Binaries
11   + Broken symlinks.
12   + Empty files.
13   + Recursive empty directories.
14   + Files with broken user or group id.
15
16.. raw:: html
17
18    <script type="text/javascript" src="https://asciinema.org/a/8leoh1nqxz7t5o3jkedkh4421.js" id="asciicast-8leoh1nqxz7t5o3jkedkh4421" async></script>
19
20|
21
22
23**Key Features:**
24
25.. hlist::
26   :columns: 3
27
28   + Extremely fast.
29   + Flexible and easy commandline options.
30   + Choice of several hashes for hash-based duplicate detection
31   + Option for exact byte-by-byte comparison (only slightly slower).
32   + Numerous output options.
33   + Option to store time of last run; next time will only scan new files.
34   + Many options for original selection / prioritisation.
35   + Can handle very large file sets (millions of files).
36   + Colorful progressbar. (��)
37
38----
39
40.. .. image:: https://raw.githubusercontent.com/sahib/rmlint/develop/docs/_static/logo.png
41..    :align: left
42..    :width: 150
43
44.. raw:: html
45
46    <center>
47
48.. image:: https://readthedocs.org/projects/rmlint/badge/?version=latest
49   :target: http://rmlint.rtfd.org
50   :width: 8%
51
52.. image:: https://img.shields.io/travis/sahib/rmlint/develop.svg?style=flat
53   :target: https://travis-ci.org/sahib/rmlint
54   :width: 8%
55
56.. image:: https://img.shields.io/github/issues/sahib/rmlint.svg?style=flat
57   :target: https://github.com/sahib/rmlint/issues
58   :width: 8%
59
60.. image:: https://img.shields.io/github/release/sahib/rmlint.svg?style=flat
61   :target: https://github.com/sahib/rmlint/releases
62   :width: 8%
63
64.. image:: http://img.shields.io/badge/license-GPLv3-4AC51C.svg?style=flat
65   :target: https://www.gnu.org/licenses/quick-guide-gplv3.html.en
66   :width: 8%
67
68
69.. raw:: html
70
71    </center>
72
73User manual
74-----------
75
76Although ``rmlint`` is easy to use, you might want to read these chapters first.
77They show you the basic principles and most of the advanced options:
78
79.. toctree::
80   :maxdepth: 2
81
82   install
83   tutorial
84   gui
85   cautions
86   faq
87
88If you have usage questions or find weird behaviour, you can also try to reach
89us via *IRC* in ``#rmlint`` on ``irc.freenode.net``.
90
91Since version ``2.4.0`` we also feature an optional graphical user interface:
92
93.. raw:: html
94
95   <center>
96    <iframe src="https://player.vimeo.com/video/139999878" width="780"
97    height="450"
98    frameborder="0" webkitallowfullscreen mozallowfullscreen
99    allowfullscreen></iframe>
100   </center>
101
102Informative reference
103---------------------
104
105These chapters are informative and are not essential for the average
106user. People that want to extend ``rmlint`` might want to read this though:
107
108.. toctree::
109   :maxdepth: 1
110
111   developers
112   translators
113   benchmarks
114   Online-manpage of rmlint(1) <rmlint.1>
115
116The Changelog_ is also updated with new and futures features, fixes and overall
117changes.
118
119.. _Changelog: https://github.com/sahib/rmlint/blob/develop/CHANGELOG.md
120
121
122Authors
123-------
124
125``rmlint`` was and is written by:
126
127===================================  ============================= ===========================================
128*Christopher Pahl*                   https://github.com/sahib      2010-2019
129*Daniel Thomas*                      https://github.com/SeeSpotRun 2014-2019
130===================================  ============================= ===========================================
131
132Additional thanks to:
133
134.. hlist::
135    :columns: 3
136
137    - `vvs-`_ (Scalability testing)
138    - *Attila* Toth
139    - All sane bugreporters (there are not many)
140    - All packagers, porters and patchers.
141
142
143.. _qitta: https://github.com/qitta
144.. _dieterbe: https://github.com/Dieterbe
145.. _`My cats`: http://imgur.com/gallery/rims0yl
146.. _`vvs-`: https://github.com/vvs-?tab=activity
147
148License
149-------
150
151``rmlint`` is licensed under the terms of GPLv3_.
152
153.. _GPLv3: http://www.gnu.org/copyleft/gpl.htm
154.. _sahib: https://github.com/sahib
155.. _SeeSpotRun: https://github.com/SeeSpotRun
156
157Donations
158---------
159
160If you think rmlint saved [*]_ you some serious time and/or space, you might
161consider a donation. You can donate either via *Flattr* or via *PayPal*:
162
163.. image:: http://api.flattr.com/button/flattr-badge-large.png
164   :target: http://flattr.com/thing/302682/libglyr
165   :align: center
166   :width: 9%
167
168.. raw:: html
169
170   <br />
171   <center>
172       <form action="https://www.paypal.com/cgi-bin/webscr" method="post">
173           <input type="hidden" name="cmd" value="_s-xclick">
174           <input type="hidden" name="hosted_button_id" value="JXCXKRMS8EDVC">
175           <input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
176           <img alt="" border="0" src="https://www.paypalobjects.com/de_DE/i/scr/pixel.gif" width="1" height="1">
177       </form>
178   </center>
179   <br />
180
181Or just buy us a beer if we ever meet. Nice emails are okay too.
182
183.. [*] If it freed you from your beloved data: *Sorry.* [*]_
184.. [*] Please file a bug or read the source and provide a patch. [*]_
185.. [*] For more than 100GB of data loss we owe you one beer. [*]_
186.. [*] If you don't like beer or there's only Budweiser available, you can order
187   a Club Mate.
188