summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorGravatar aeb 2001-02-28 01:21:15 +0000
committerGravatar aeb 2001-02-28 01:21:15 +0000
commitd64c821b1497d3368f24065b91c87ba7dc0955fd (patch)
treee7348b2c974366360b3da801ed24db588a494472 /doc
parentLet received iso header be big endian, to be consistent. (diff)
testlibraw gets installed now.
Added man page for testlibraw. git-svn-id: svn://svn.linux1394.org/libraw1394/trunk@55 53a565d1-3bb7-0310-b661-cf11e63c67ab
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am3
-rw-r--r--doc/testlibraw.1.in30
2 files changed, 33 insertions, 0 deletions
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 <aeb@debian.org>