X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=SSH.pm;h=0a441333e28e10234714daf8695f03a60e8d1c62;hb=d28f4970158166eba309962013e9f49886570c92;hp=81ee35bd84ad724763bdac9e804166a26724520c;hpb=b36296a20bb4cd814949c6b92ee46851fd78906d;p=Net-SSH.git

diff --git a/SSH.pm b/SSH.pm
index 81ee35b..0a44133 100644
--- 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,19 +94,54 @@ 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 FREQUENTLY ASKED QUESTIONS
+
+Q: How do you supply a password to connect with ssh within a perl script
+using the Net::SSH module?
+
+A: You don't.  Use RSA or DSA keys.  See the ssh-keygen(1) manpage.
+
+Q: My script is "leaking" ssh processes.
+
+A: See L<perlfaq8/"How do I avoid zombies on a Unix system">, L<IPC::Open2>,
+L<IPC::Open3> and L<perlfunc/waitpid>.
+
 =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
 
-ssh(1), L<IPC::Open2>, L<IPC::Open3>
+ssh-keygen(1), ssh(1), L<IPC::Open2>, L<IPC::Open3>
 
 =cut