Commit | Line | Data |
406c51ee |
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 |
dea4d7df |
6 | can be found a various places on the WEB, for a starting |
406c51ee |
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 |
406c51ee |
19 | |
20 | AVAILABILITY |
21 | |
22 | The latest version of libnet is available from the Comprehensive Perl |
23 | Archive Network (CPAN). To find a CPAN site near you see: |
24 | |
f92f3fcb |
25 | http://search.cpan.org/~gbarr/libnet/ |
26 | |
27 | The subversion source repository can be browsed at |
28 | |
29 | http://svn.mutatus.co.uk/browse/libnet/ |
30 | |
31 | If you have a subversion client, then you can checkout the latest code with |
32 | |
33 | svn co http://svn.mutatus.co.uk/repos/libnet/trunk libnet |
406c51ee |
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 | |
686337f3 |
60 | Normally when perl Makefile.PL is run it will run Configure which will |
61 | ask some questions about your system. The results of these questions |
d1be9408 |
62 | will be stored in a file called libnet.cfg which will be installed |
686337f3 |
63 | alongside the other perl modules in this distribution. The Makefile.PL |
64 | will run Configure in an interactive mode unless these exists a file |
65 | called libnet.cfg in the build directory. |
66 | |
67 | If you are on a system which cannot run this script you can create an |
68 | empty file to make Makefile.PL skip running Configure. If you want to |
69 | keep your existing settings and not run interactivly the simple run |
70 | |
71 | Configure -d |
72 | |
73 | before running the Makefile.PL. |
406c51ee |
74 | |
75 | DOCUMENTATION |
76 | |
77 | See ChangeLog for recent changes. POD style documentation is included |
78 | in all modules and scripts. These are normally converted to manual |
79 | pages and installed as part of the "make install" process. You should |
80 | also be able to use the 'perldoc' utility to extract documentation from |
81 | the module files directly. |
82 | |
83 | DEMOS |
84 | |
85 | The demos directory does contain a few demo scripts. These should be |
86 | run from the top directory like |
87 | |
88 | demos/smtp.self -user my-email-address -debug |
89 | |
90 | However I do not guarantee these scripts to work. |
91 | |
92 | SUPPORT |
93 | |
94 | Questions about how to use this library should be directed to the |
95 | comp.lang.perl.modules USENET Newsgroup. Bug reports and suggestions |
686337f3 |
96 | for improvements can be sent to me at <gbarr@pobox.com>. |
406c51ee |
97 | |
98 | Most of the modules in this library have an option to output a debug |
99 | transcript to STDERR. When reporting bugs/problems please, if possible, |
100 | include a transcript of a run. |
101 | |
102 | COPYRIGHT |
103 | |
f92f3fcb |
104 | © 1996-2004 Graham Barr. All rights reserved. |
406c51ee |
105 | |
106 | This library is free software; you can redistribute it and/or modify |
107 | it under the same terms as Perl itself. |
108 | |
109 | Share and Enjoy! |