added example to documentation

diff --git a/Changes b/Changes
index 991346d..34b2a5f 100644 (file)
--- a/Changes
+++ b/Changes
@@ -1,5 +1,8 @@
 Revision history for Perl extension Net::SSH.
 
+0.02  Sat Nov 25 22:44:21 2000
+       - documentation updates
+
 0.01  Thu Aug 17 17:44:21 2000
        - original version; created by h2xs 1.19
 

diff --git a/SSH.pm b/SSH.pm
index 607cddd..715eec1 100644 (file)
--- a/SSH.pm
+++ b/SSH.pm
@@ -8,7 +8,7 @@ use IPC::Open3;
 
 @ISA = qw(Exporter);
 @EXPORT_OK = qw( ssh issh sshopen2 sshopen3 );
-$VERSION = '0.01';
+$VERSION = '0.02';
 
 $ssh = "ssh";
 
@@ -94,10 +94,33 @@ sub _yesno {
 
 =back
 
+=head1 EXAMPLE
+
+  use Net::SSH qw(sshopen2);
+  use strict;
+
+  my $user = "username";
+  my $host = "hostname";
+  my $cmd = "command";
+
+  sshopen2("$user\@$host", *READER, *WRITER, "$cmd") || die "ssh: $!";
+
+  while (<READER>) {
+      chomp();
+      print "$_\n";
+  }
+
+  close(READER);
+  close(WRITER);
+
 =head1 AUTHOR
 
 Ivan Kohler <ivan-netssh_pod@420.am>
 
+=head1 CREDITS
+
+ John Harrison <japh@in-ta.net> contributed an example for the documentation.
+
 =head1 BUGS
 
 Not OO.