************************************
*** braz -- Find and link        ***  v 1.0a2, 2001-10-30
*** together identical files     ***  (c) 2001 Bertrand Petit
************************************
    Release notes


This the first release of braz, a unix tool designed to find identical
files in a file system and link them together to gain space.


==============================================================================
Release status
==============================================================================

The software, currently in alpha stage, is currently known to work on
FreeBSD and NetBSD systems. Currently it can only be built under
systems providing the Message Digest library (libmd) that seems to be
specific to the BSD world. Replacements that I'm not aware of may
exist. If you know such libraries, please send any necessary patches
to adapt braz to them.


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

This program is distributed in source code only, you shall build it
first.

1. Edit the Makefile. Inlined comments will guide you there.

2. Run make. GNU make is recommended! Other make-like utilities may
   not work with this makefile.

3. **Important**: read the manual page and perform some tests on copies
   or discardable data. You are advised that this program modifies
   the file system. It is potentially dangerous.

4. Install the program with "make install".

5. If your brand new installation required some changes to the program,
   please send unified diffs to the author (see the Contact section
   bellow).

6. If your brand new installation was done on an operating system not
   listed in this document, please report your system details to the
   author (see the Contact section bellow).


==============================================================================
Contact
==============================================================================

Questions, bug reports, patches, etc. are welcome. Please mail your
queries to < braz at phoe dot frmug dot org >. Note that things such
as HTML e-mails, word documents, etc. will be blindly discarded.


==============================================================================
Fine print
==============================================================================

This program is (c) 2001 by Bertrand Petit. It is distributed under
the terms of the license similar to the Berkeley license reproduced
bellow.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

3. Neither the name of the author nor the names of its contributors
   may be used to endorse or promote products derived from this software
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


------------------------------------------------------------------------------
End of file README
------------------------------------------------------------------------------