added example to documentation

[Net-SSH.git] / SSH.pm

diff --git a/SSH.pm b/SSH.pm
index 81ee35b..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,15 +94,38 @@ 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@420.am>
+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.
 
-Look at IPC::Session?
+Look at IPC::Session (also fsh)
 
 =head1 SEE ALSO