lib/Net/README.libnet

   1 libnet is a collection of Perl modules which provides a simple
   2 and consistent programming interface (API) to the client side
   3 of various protocols used in the internet community.
   4
   5 For details of each protocol please refer to the RFC. RFC's
   6 can be found a various places on the WEB, for a staring
   7 point look at:
   8
   9     http://www.yahoo.com/Computers_and_Internet/Standards/RFCs/
  10
  11 The RFC implemented in this distribution are
  12
  13 Net::FTP        RFC959          File Transfer Protocol
  14 Net::SMTP       RFC821          Simple Mail Transfer Protocol
  15 Net::Time       RFC867          Daytime Protocol
  16 Net::Time       RFC868          Time Protocol
  17 Net::NNTP       RFC977          Network News Transfer Protocol
  18 Net::POP3       RFC1939         Post Office Protocol 3
  19 Net::SNPP       RFC1861         Simple Network Pager Protocol
  20
  21 FUTURE WORK
  22
  23 AVAILABILITY
  24
  25 The latest version of libnet is available from the Comprehensive Perl
  26 Archive Network (CPAN). To find a CPAN site near you see:
  27
  28     http://www.perl.com/CPAN
  29                             ^ no slash here !!
  30
  31 INSTALLATION
  32
  33 In order to use this package you will need Perl version 5.002 or
  34 better.  You install libnet, as you would install any perl module
  35 library, by running these commands:
  36
  37    perl Makefile.PL
  38    make
  39    make test
  40    make install
  41
  42 If you want to install a private copy of libnet in your home
  43 directory, then you should try to produce the initial Makefile with
  44 something like this command:
  45
  46   perl Makefile.PL PREFIX=~/perl
  47
  48
  49 The Makefile.PL program will start out by checking your perl
  50 installation for a few packages that are recommended to be installed
  51 together with libnet.  These packages should be available on CPAN
  52 (described above).
  53
  54 CONFIGURE
  55
  56 Normally when perl Makefile.PL is run it will run Configure which will
  57 ask some questions about your system. The results of these questions
  58 will be stored in a file called libnet.cfg which will be installed
  59 alongside the other perl modules in this distribution. The Makefile.PL
  60 will run Configure in an interactive mode unless these exists a file
  61 called libnet.cfg in the build directory.
  62
  63 If you are on a system which cannot run this script you can create an
  64 empty file to make Makefile.PL skip running Configure. If you want to
  65 keep your existing settings and not run interactivly the simple run
  66
  67   Configure -d
  68
  69 before running the Makefile.PL.
  70
  71 DOCUMENTATION
  72
  73 See ChangeLog for recent changes.  POD style documentation is included
  74 in all modules and scripts.  These are normally converted to manual
  75 pages and installed as part of the "make install" process.  You should
  76 also be able to use the 'perldoc' utility to extract documentation from
  77 the module files directly.
  78
  79 DEMOS
  80
  81 The demos directory does contain a few demo scripts. These should be
  82 run from the top directory like
  83
  84     demos/smtp.self -user my-email-address -debug
  85
  86 However I do not guarantee these scripts to work.
  87
  88 SUPPORT
  89
  90 Questions about how to use this library should be directed to the
  91 comp.lang.perl.modules USENET Newsgroup.  Bug reports and suggestions
  92 for improvements can be sent to me at <gbarr@pobox.com>.
  93
  94 Most of the modules in this library have an option to output a debug
  95 transcript to STDERR. When reporting bugs/problems please, if possible,
  96 include a transcript of a run.
  97
  98 COPYRIGHT
  99
 100   © 1996-2000 Graham Barr. All rights reserved.
 101
 102 This library is free software; you can redistribute it and/or modify
 103 it under the same terms as Perl itself.
 104
 105 Share and Enjoy!