This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Initial integration of libnet-1.0703.
[perl5.git] / 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 The distribution also contains a module (Net::PH) which facilitates
22 comunicate with with servers using the CCSO Nameserver Server-Client
23 Protocol
24
25 FUTURE WORK
26
27 AVAILABILITY
28
29 The latest version of libnet is available from the Comprehensive Perl
30 Archive Network (CPAN). To find a CPAN site near you see:
31
32     http://www.perl.com/CPAN
33                             ^ no slash here !!
34
35 INSTALLATION
36
37 In order to use this package you will need Perl version 5.002 or
38 better.  You install libnet, as you would install any perl module
39 library, by running these commands:
40
41    perl Makefile.PL
42    make
43    make test
44    make install
45
46 If you want to install a private copy of libnet in your home
47 directory, then you should try to produce the initial Makefile with
48 something like this command:
49
50   perl Makefile.PL PREFIX=~/perl
51
52
53 The Makefile.PL program will start out by checking your perl
54 installation for a few packages that are recommended to be installed
55 together with libnet.  These packages should be available on CPAN
56 (described above).
57
58 CONFIGURE
59
60 Normally when perl Makefile.PL is run it will run Configure which will ask some
61 questions about your system. The results of these questions will be stored in
62 the Net::Config package. If you are on a system when this script cannot be run
63 for some reason then the file Config.eg can be edited manually and installed
64 as Net::Config (Net/Comfig.pm)
65
66 DOCUMENTATION
67
68 See ChangeLog for recent changes.  POD style documentation is included
69 in all modules and scripts.  These are normally converted to manual
70 pages and installed as part of the "make install" process.  You should
71 also be able to use the 'perldoc' utility to extract documentation from
72 the module files directly.
73
74 DEMOS
75
76 The demos directory does contain a few demo scripts. These should be
77 run from the top directory like
78
79     demos/smtp.self -user my-email-address -debug
80
81 However I do not guarantee these scripts to work.
82
83 SUPPORT
84
85 Questions about how to use this library should be directed to the
86 comp.lang.perl.modules USENET Newsgroup.  Bug reports and suggestions
87 for improvements can be sendt to me at <gbarr@pobox.com>. 
88
89 Most of the modules in this library have an option to output a debug
90 transcript to STDERR. When reporting bugs/problems please, if possible,
91 include a transcript of a run.
92
93 COPYRIGHT
94
95   © 1996-98 Graham Barr. All rights reserved.
96
97 This library is free software; you can redistribute it and/or modify
98 it under the same terms as Perl itself.
99
100 Share and Enjoy!