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