diff --git a/Makefile.am b/Makefile.am index 5007b71..eccc3eb 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,6 +1,6 @@ # process this file with automake to create a Makefile.in -SUBDIRS = src debian +SUBDIRS = src doc debian # make required device file diff --git a/configure.in b/configure.in index 813ad2a..254a8f1 100644 --- a/configure.in +++ b/configure.in @@ -23,4 +23,10 @@ AC_SUBST(lt_age) CFLAGS="$CFLAGS -Wall -Wunused" -AC_OUTPUT([ Makefile src/Makefile debian/Makefile ]) +AC_OUTPUT([ +Makefile +src/Makefile +doc/Makefile +doc/testlibraw.1 +debian/Makefile +]) diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..f639a2c --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,3 @@ +# man files for testlibraw +man_MANS = testlibraw.1 +EXTRA_DIST = testlibraw.1.in diff --git a/doc/testlibraw.1.in b/doc/testlibraw.1.in new file mode 100644 index 0000000..69dde13 --- /dev/null +++ b/doc/testlibraw.1.in @@ -0,0 +1,30 @@ +.TH testlibraw 1 "libraw1394 @VERSION@" "" "Linux IEEE 1394" +.SH NAME +testlibraw \- run basic functionality tests on libraw1394 +.SH SYNOPSIS +.B testlibraw +.SH DESCRIPTION +testlibraw attaches to the Linux IEEE 1394 subsystem through libraw1394 and +tries to read data from all connected nodes. It therefore acts as a check that: +.IP * +libraw1394 is installed correctly +.IP * +the IEEE 1394 subsystem is loaded in the kernel and of a supported version +.IP * +libraw1394 and kernel side raw1394 can communicate +.IP * +connected nodes can be reached and do respond. +.PP +The read transactions are of a form that all powered up nodes conforming to the +IEEE 1394 standard have to be able to respond to. +.PP +The source of this program also acts as a demonstration of libraw1394 +programming, including initialization, transactions and the event loop. +.SH EXAMPLE RUN +FIXME: insert example here +.SH BUGS +None known. +.SH SEE ALSO +http://linux1394.sourceforge.net/ +.SH AUTHOR +Andreas Bombe diff --git a/src/Makefile.am b/src/Makefile.am index 6f16238..9e1fe70 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -20,5 +20,5 @@ libraw1394_la_SOURCES = \ pkginclude_HEADERS = raw1394.h csr.h ieee1394.h # testlibraw -noinst_PROGRAMS = testlibraw +bin_PROGRAMS = testlibraw testlibraw_LDADD = libraw1394.la