contrib/purge/README

hg.repository: make protocol table driven.
allows extensions to add new protocols.

What is "hg purge"?
===================
"purge" is a simple extension for the Mercurial source control management
system (http://www.selenic.com/mercurial).
This extension adds a "purge" command to "hg" that removes files not known
to Mercurial, this is useful to test local and uncommitted changes in the
otherwise clean source tree.

This means that Mercurial will delete:
 - Unknown files: files marked with "?" by "hg status"
 - Ignored files: files usually ignored by Mercurial because they match a
   pattern in a ".hgignore" file
 - Empty directories: infact Mercurial ignores directories unless they
   contain files under source control managment
But it will leave untouched:
 - Unmodified files tracked by Mercurial
 - Modified files tracked by Mercurial
 - New files added to the repository (with "hg add")

Be careful with "hg purge", you could irreversibly delete some files you
forgot to add to the repository. If you only want to print the list of
files that this program would delete use:
  hg purge --print

To get the most recent version of "hg purge" visit its home page:
  http://www.barisione.org/apps.html#hg-purge

This program was inspired by the "cvspurge" script contained in CVS utilities
(http://www.red-bean.com/cvsutils/).


How to install
==============
The purge extension is distributed with Mercurial, to activate it you need to
put these lines in your ~/.hgrc:

  [extensions]
  hgext.purge=

For more information on the configuration files see the man page for "hgrc":
  man 5 hgrc


How to use "hg purge"
====================
For help on the usage of "hg purge" use:
  hg help purge


License
=======
Copyright (C) 2006 - Marco Barisione <[e-mail]>

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

A copy of the GNU General Public License is distributed along
with Mercurial in the file COPYING.