libhfsp preliminary release
Author: Yevgeny Binder <yev@freeshell.org>
Written for the NetBSD Project
Sponsored by Google Summer of Code 2005


ABOUT LIBHFSP
-------------
libhfsp is a library which provides routines for read-only access of HFS+
volumes on NetBSD. It is a work in progress and is in no way ready for use by
either end-users or developers. Eventually, this library will become part of a
kernel-level HFS+ filesystem.

Additional information and news can be found at:

    http://netbsd-soc.sourceforge.net/projects/hfs/

libhfsp is developed and released under a BSD license; please consult the
LICENSE file for more information.


COMPILING
---------
At the prompt, simply type 'make'. This will compile libhfsp along with a sample
program that uses it.

This software has only been tested on NetBSD 2.0.2/i386, so there's no guarantee
that it will compile or run on any other system. In fact, it might not even work
on the same one.


EXAMPLE
-------
Included with the library is a sample program that opens an HFS+ volume,
displays some useful information about it, and lists the full path of every file
it has. At present, there is no facility provided to read the Apple Partition
Map and locate the HFS+ volume on disk, so you will need to manually find and
enter the offset of the volume from the start of the disk.

Usage:  hfsptest device offset

    device  -  path to the device node (located in /dev) of the disk
    offset  -  offset to the start of the volume from the start of the disk
               in 512-byte blocks

        
LIMITATIONS
-----------
The library currently does not work correctly (or at all) with volumes which:

    - have an HFS wrapper
    - contain ANY files or folders with non-ASCII characters in their name
    - are formatted with the original HFS, or with HFSX, a minor variant of HFS+
    - are journaled but whose journal is not empty (i.e. unclean volumes)
    
Please keep in mind that this software has not undergone any thorough testing,
since it is constantly being revised. While it does not write any data, you
should still not use it on any machine or disk which you value in any way.