clarify address and device parameters in docs

1 files changed, 27 insertions, 6 deletions

diff --git a/libvxi11client/perlbits/Client.pm b/libvxi11client/perlbits/Client.pm
index d477031..baf1c26 100644
--- a/libvxi11client/perlbits/Client.pm
+++ b/libvxi11client/perlbits/Client.pm
@@ -183,7 +183,7 @@ __END__
 
 =head1 NAME
 
-VXI11::Client - Perl module for interfacing with VXI-11 networked test and measurement equipment
+VXI11::Client - Implements a Linux VXI-11 client for controlling test and measurement equipment
 
 =head1 DOWNLOAD
 
@@ -236,7 +236,7 @@ Once unzipped, use the standard perl module install sequence:
 
 =begin html
 
-VXI11::Client implements a client for VXI-11 networked instruments.
+VXI11::Client implements a Linux client for VXI-11 networked instruments.
 This module was developed to support 
 <a href="http://www.avtechpulse.com/">Avtech Electrosystems</a>
 pulse generators with the
@@ -246,7 +246,8 @@ as well as VXI-11.3 instrumentation from other manufacturers (oscilloscopes, etc
 =end html
 
 Tested on Linux (Fedora 17 x86_64, primarily). It has not been tested on other
-operating systems at this time.
+operating systems at this time. This module relies on the glib and gthread
+libraries.
 
 =head2 BASIC I/O
 
@@ -321,7 +322,7 @@ The interrupts can be shut down using:
 
   $instr->vxi_disable_srq();		# local to your instrument
   $instr->vxi_destroy_intr_chan();	# local to your instrument
-  vxi_startinterruptserver();		# affects all instruments
+  vxi_stopinterruptserver();		# affects all instruments
 
 Use of the interrupt channel is optional. Simpler applications can 
 omit it, and rely on explicit status checks of the instrument. To
@@ -374,6 +375,16 @@ Shutdown the local RPC server.
 Open a link to an instrument. Use the returned instance to call 
 the object methods below.
 
+"address" is the IP address or hostname of your instrument. If
+you are using a VXI-to-GPIB gateway, it is the IP address of the
+gateway.
+
+"device" is an additional parameter used only when connecting
+thorugh a VXI-to-GPIB gateway, such as the ICS 8065. If used,
+it will have the form of "gpib0,2", where "gpib0" refers to the
+gateway, and ",2" refers to the instrument on the GPIB bus at
+GPIB address 2.
+
 =item $retcode = $instr->vxi_close();	
 
 Destroy the link to the instrument and destroy the local RPC client.
@@ -494,6 +505,10 @@ The only exceptions to this are the read and write methods:
 
 =head1 SAMPLE SCRIPTS
 
+These samples assume that the connected instrument follows the IEEE-488.2
+and SCPI standards. Beware that some instruments do not follow these
+standards!
+
 =head2 MINIMAL IDENTIFICATION SCRIPT
 
   #!/usr/bin/perl
@@ -675,9 +690,15 @@ The only exceptions to this are the read and write methods:
 
 The VXI-11.3 specifications.
 
-=head1 AUTHOR
+=head1 AUTHORS
+
+=over
+
+=item Daniel Palmer, daniel@0x0f.com
 
-Dr. Michael J. Chudobiak, mjc@avtechpulse.com
+=item Dr. Michael J. Chudobiak, mjc@avtechpulse.com
+
+=back
 
 =head1 COPYRIGHT AND LICENSE