.. contents::


CleanLinks enforces the absence of dangling symbolic links; i.e., symbolic links
pointing to targets which no longer exist.


CleanLinks will remove dangling symlinks, symlinks to directories with the
--directory option and empty directories.

The behavior has been modified from the XFree86 ``cleanlinks`` V1.2, by not
removing directory symlinks by default. Which is a little safer as far a user
expectations are concerned.


A GNU/Linux system or compatible is needed.

There is nothing to compile, so no compilers are needed.

    * coreutils
    * util-linux
    * findutils


Installing is done by the following three commands::

    $ ./configure
    $ make
    # make install (as root)

The default ``configure`` uses ``--prefix=/usr/local`` and this works fine.
Run ``./configure``, with some options if you wish. The standard options
are documented in the INSTALL file. The most interesting ones are
the usual ``--prefix=/usr``.

For more configuration details run::

    $ ./configure --help

If there are any errors during configuration, check your build environment
and try to find the error, otherwise file a bug-report on the issue tracker
or contact one of the authors.

These files will be installed.

    * ${bindir}/cleanlinks
    * ${mandir}/man1/cleanlinks.1


To run ``cleanlinks`` just type on a console::

    $ cleanlinks

There are a few command line options. See the manual page or run for details::

    $ cleanlinks --help

Or look into the documention in the doc/ directory.


CleanLinks is distributed under the terms of the MIT License. A copy
of the license can be found in the file COPYING included with the source code of
the program. If not, see <>.

Ideas, questions, patches and bug reports

Home page:

Primary distribution point:

Ideas, questions, patches and bug reports:

If you add something, or fix a bug, please send a patch (in 'diff -u'
format) to the issue tracker or one of the authors.

------------ -----   -----       ----       ---       --         -
Erik Southworth, 2009,2010 (s6v)