libraw1394/README

				   libraw1394
				   ==========

1. About libraw1394

	libraw1394 is the only supported interface to the kernel side raw1394 of
the Linux IEEE-1394 subsystem, which provides direct access to the connected
1394 buses to user space.  Through libraw1394/raw1394, applications can directly
send to and receive from other nodes without requiring a kernel driver for the
protocol in question.

	The reason for making a library the interface to the kernel is to avoid
a program dependancy on the kernel version, which would hinder development and
optimization of raw1394.  If development changed the protocol and made it
incompatible with previous versions only the libraw1394 has to be upgraded to
match the kernel version (instead of all applications).


2. Copyleft

	libraw1394 itself is licensed under the Lesser General Public License
(short LGPL, see file COPYING.LIB in the source distribution).  Other files in
the source archives not belonging to but being part of the build procedure of
libraw1394 are under their own licenses, as stated at the top of the individual
files.


3. API documentation

	Finally there is something, in the doc subdirectory.  The file is
libraw1394.sgml (it's Docbook format), and there are preformatted PostScript and
HTML available.  This documentation is not complete yet!  I hopefully will have
a libraw1394 0.9.1 out soon with finished documentation.


4. Multithreading

	This library should be multithreadable with the restriction that one
raw1394handle_t may be used only within a single thread.  Multiple threads
operating on the same handle would royally mess up the kernel-user protocol.
Simply use separate handles for each thread in which you need to use libraw1394.


5. Autoconf macro

	Along with the library an autoconf macro gets installed (in
$prefix/share/aclocal).  It is called the following way:

AC_LIB_RAW1394(MINIMUMVERSION[,ACTION_IF_FOUND[,ACTION_IF_NOT_FOUND]])

	Versions prior to 0.9 can not be checked and appear as "not found".
This macro sets the variables LIBRAW1394_CPPFLAGS, LIBRAW1394_CFLAGS and
LIBRAW1394_LIBS.  You have to include those into your build variables so that
the build process correctly links with libraw1394.


6. Maintainer

	Maintainer of libraw1394 is currently Andreas Bombe.  Send suggestions,
bug reports and fixes to andreas.bombe@munich.netsurf.de.  See the file AUTHORS
for a complete list of contributors to libraw1394.

	You can get updates through this project's homepage on SourceForge, see
http://sourceforge.net/project/?group_id=2514 for more information.  You can
also submit bugs through this page.


2001-05-14  Andreas Bombe