README

   1
   2                       Net::Telnet, version 3.01
   3
   4     Copyright (c) 1997 Jay Rogers.  All rights reserved.  This program
   5     is free software; you can redistribute it and/or modify it under
   6     the same terms as Perl itself.
   7
   8
   9   What's In It For You
  10   --------------------
  11
  12    .  You'd like to communicate with another host or device via a
  13       TELNET port and you'd like some specialized routines to help you
  14       login and do other interactive things.
  15
  16    .  You're not familiar with sockets and you want a simple way to
  17       make client connections to TCP services.
  18
  19    .  You want to be able to specify your own time-out while
  20       connecting, reading, and writing.
  21
  22    .  You're communicating with an interactive program at the other
  23       end of some socket or pipe and you want to wait for certain
  24       patterns to appear.
  25
  26
  27   Archive Location
  28   ----------------
  29
  30     .  In the CPAN directory: modules/by-module/Net/
  31
  32     .  To find a CPAN site near you see http://cpan.perl.org/SITES.html
  33
  34
  35   Prerequisites
  36   -------------
  37
  38     .  Perl Version 5.002 or later
  39
  40     .  A Windows 95/NT machine requires Perl version 5.003_07 or later
  41
  42     .  No other modules are required that don't already come with a
  43        standard distribution of Perl.
  44
  45
  46   Description
  47   -----------
  48
  49     Net::Telnet allows you to make client connections to a TCP port
  50     and do network I/O, especially to a port using the TELNET
  51     protocol.  Simple I/O methods such as print, get, and getline are
  52     provided.  More sophisticated interactive features are provided
  53     because connecting to a TELNET port ultimately means communicating
  54     with a program designed for human interaction.  These interactive
  55     features include the ability to specify a timeout and to wait for
  56     patterns to appear in the input stream, such as the prompt from a
  57     shell.
  58
  59     Here's an example that prints who's logged-on to the remote host
  60     sparky.  In addition to a username and password, you must also
  61     know the user's shell prompt, which for this example is bash$
  62
  63         use Net::Telnet ();
  64         $t = new Net::Telnet (Timeout => 10,
  65                               Prompt => '/bash\$ $/');
  66         $t->open("sparky");
  67         $t->login($username, $passwd);
  68         @lines = $t->cmd("/usr/bin/who");
  69         print @lines;
  70
  71     See the user documentation for more examples.
  72
  73     This is an alpha version - meaning that the interface may change
  74     in future versions.  Contact me, Jay Rogers <jay@rgrs.com>, if you
  75     find any bugs or have suggestions for improvement.
  76
  77
  78   Documentation
  79   -------------
  80
  81     User documentation in POD format is contained within the module
  82     source (i.e. the .pm file).  Installing using "make install"
  83     places this documentation in a man page in the perl library under
  84     the directory "man/man3".
  85
  86
  87   Installation
  88   ------------
  89
  90     To install, cd to the directory containing the unpacked
  91     distribution and do one of the following:
  92
  93     a.  Create a makefile by running Makefile.PL using the perl
  94         program into whose library you want to install and then run
  95         make three times:
  96
  97             perl Makefile.PL
  98             make
  99             make test
 100             make install
 101
 102     b.  To install into a private library, for example your home
 103         directory:
 104
 105             perl Makefile.PL INSTALLSITELIB=$HOME/lib INSTALLMAN3DIR=$HOME/man
 106             make
 107             make test
 108             make pure_install
 109
 110     c.  Alternatively, you can just copy or move Telnet.pm
 111         from the distribution into a directory named Net/ in the Perl
 112         library.  You can then manually build the documentation using
 113         pod2man or pod2html.
 114
 115 --
 116 Jay Rogers
 117 jay@rgrs.com
 118 December 27, 1997