Would help to actually pass the data read back out

1 files changed, 50 insertions, 0 deletions

diff --git a/libvxi11client/perlbits/README b/libvxi11client/perlbits/README
new file mode 100644
index 0000000..a789fc8
--- /dev/null
+++ b/libvxi11client/perlbits/README
@@ -0,0 +1,50 @@
+VXI11-Client version 0.01
+=========================
+
+This module is a wrapper around a C library that uses libc's built in
+Sun RPC support to talk to VXI11 networked instruments.
+
+It supports only one instrument at a time.
+
+Interrupts work by creating the interrupt channel, enabling interrupts 
+and then using wait_for_interrupt() to wait for an interrupt to happen.
+wait_for_interrupt() blocks until a interrupt happens or a timeout occurs. 
+If an interrupt happens before it is called it returns immediately.
+If multiple interrupts happen before it is called it will return immediately
+until all the fired interrupts are cleared.
+
+Return codes work like this;
+1   - is a success
+0   - means the request failed locally, the state inside the client is
+incorrect, i.e. calling to enable interrupts before creating the channel
+or that the server couldn't be contacted
+< 0 - Any negative value is the negated VXI-11 error code from the server
+
+The only exceptions to this are the read and write methods
+0   - Error as above or zero bytes read/written
+> 0 - Number of bytes read/written
+
+INSTALLATION
+
+To install this module type the following:
+
+   perl Makefile.PL
+   make
+   make test
+   make install
+
+DEPENDENCIES
+
+This module requires these other modules and libraries:
+
+  glib/gthread
+
+COPYRIGHT AND LICENCE
+
+Put the correct copyright and licence information here.
+
+Copyright (C) 2013 by daniel
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself, either Perl version 5.14.2 or,
+at your option, any later version of Perl 5 you may have available.