Overview

##########
CleanLinks
##########

.. contents::

About
=====

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

Features
========

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.

Requirements
============

A GNU/Linux system or compatible is needed.

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

CleanLinks
    * coreutils
    * util-linux
    * findutils

Installation
============

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

Usage
=====

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.

License
=======

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 <http://www.rpath.com/permanent/mit-license.html>.

Ideas, questions, patches and bug reports
=========================================

Home page:
    http://bitbucket.org/superstition/cleanlinks/wiki/

Primary distribution point:
    http://bitbucket.org/superstition/cleanlinks/downloads/

Ideas, questions, patches and bug reports:
    See http://bitbucket.org/superstition/cleanlinks/issues/

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)

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.