Skip to content
Browse files

Various doc cleanups

  • Loading branch information...
1 parent 1c9f4dc commit 1af2256543ae6892455b5d797dfa1600b5ec0fb2 @gbarr committed Nov 20, 2001
Showing with 52 additions and 52 deletions.
  1. +1 −1 Config.eg
  2. +3 −3 Net/Config.pm
  3. +10 −10 Net/FTP.pm
  4. +3 −3 Net/NNTP.pm
  5. +3 −3 Net/POP3.pm
  6. +3 −3 Net/SMTP.pm
  7. +28 −28 Net/libnetFAQ.pod
  8. +1 −1 README
View
2 Config.eg
@@ -26,7 +26,7 @@ use strict;
# your internet domain
inet_domain => undef,
- # If you have an ftp proxy firewall (not a http firewall)
+ # If you have an ftp proxy firewall (not an http firewall)
# then set this to the name of the firewall
ftp_firewall => undef,
View
6 Net/Config.pm
@@ -13,7 +13,7 @@ use strict;
@EXPORT = qw(%NetConfig);
@ISA = qw(Net::LocalCfg Exporter);
-$VERSION = "1.09"; # $Id: //depot/libnet/Net/Config.pm#15 $
+$VERSION = "1.09"; # $Id: //depot/libnet/Net/Config.pm#16 $
eval { local $SIG{__DIE__}; require Net::LocalCfg };
@@ -193,7 +193,7 @@ Your internet domain name
=item ftp_firewall
-If you have an FTP proxy firewall (B<NOT> a HTTP or SOCKS firewall)
+If you have an FTP proxy firewall (B<NOT> an HTTP or SOCKS firewall)
then this value should be set to the firewall hostname. If your firewall
does not listen to port 21, then this value should be set to
C<"hostname:port"> (eg C<"hostname:99">)
@@ -309,6 +309,6 @@ If true then C<Configure> will check each hostname given that it exists
=for html <hr>
-I<$Id: //depot/libnet/Net/Config.pm#15 $>
+I<$Id: //depot/libnet/Net/Config.pm#16 $>
=cut
View
20 Net/FTP.pm
@@ -22,7 +22,7 @@ use Net::Config;
use Fcntl qw(O_WRONLY O_RDONLY O_APPEND O_CREAT O_TRUNC);
# use AutoLoader qw(AUTOLOAD);
-$VERSION = "2.62"; # $Id: //depot/libnet/Net/FTP.pm#63 $
+$VERSION = "2.62"; # $Id: //depot/libnet/Net/FTP.pm#64 $
@ISA = qw(Exporter Net::Cmd IO::Socket::INET);
# Someday I will "use constant", when I am not bothered to much about
@@ -1243,17 +1243,17 @@ this if you really know what you're doing).
=item new (HOST [,OPTIONS])
This is the constructor for a new Net::FTP object. C<HOST> is the
-name of the remote host to which a FTP connection is required.
+name of the remote host to which an FTP connection is required.
C<OPTIONS> are passed in a hash like fashion, using key and value pairs.
Possible options are:
-B<Firewall> - The name of a machine which acts as a FTP firewall. This can be
+B<Firewall> - The name of a machine which acts as an FTP firewall. This can be
overridden by an environment variable C<FTP_FIREWALL>. If specified, and the
given host cannot be directly connected to, then the
connection is made to the firewall machine and the string C<@hostname> is
appended to the login identifier. This kind of setup is also refered to
-as a ftp proxy.
+as an ftp proxy.
B<FirewallType> - The type of firewall running on the machine indicated by
B<Firewall>. This can be overridden by an environment variable
@@ -1390,7 +1390,7 @@ a scalar context, returns a reference to a list.
=item get ( REMOTE_FILE [, LOCAL_FILE [, WHERE]] )
Get C<REMOTE_FILE> from the server and store locally. C<LOCAL_FILE> may be
-a filename or a filehandle. If not specified the the file will be stored in
+a filename or a filehandle. If not specified, the file will be stored in
the current directory with the same leafname as the remote file.
If C<WHERE> is given then the first C<WHERE> bytes of the file will
@@ -1472,7 +1472,7 @@ reference to a C<Net::FTP::dataconn> based object.
=item nlst ( [ DIR ] )
-Send a C<NLST> command to the server, with an optional parameter.
+Send an C<NLST> command to the server, with an optional parameter.
=item list ( [ DIR ] )
@@ -1513,7 +1513,7 @@ C<put_unique> and those that do not require data connections.
=item port ( [ PORT ] )
Send a C<PORT> command to the server. If C<PORT> is specified then it is sent
-to the server. If not the a listen socket is created and the correct information
+to the server. If not, then a listen socket is created and the correct information
sent to the server.
=item pasv ()
@@ -1589,15 +1589,15 @@ be performed using these.
Read C<SIZE> bytes of data from the server and place it into C<BUFFER>, also
performing any <CRLF> translation necessary. C<TIMEOUT> is optional, if not
-given the the timeout value from the command connection will be used.
+given, the timeout value from the command connection will be used.
Returns the number of bytes read before any <CRLF> translation.
=item write ( BUFFER, SIZE [, TIMEOUT ] )
Write C<SIZE> bytes of data from C<BUFFER> to the server, also
performing any <CRLF> translation necessary. C<TIMEOUT> is optional, if not
-given the the timeout value from the command connection will be used.
+given, the timeout value from the command connection will be used.
Returns the number of bytes written before any <CRLF> translation.
@@ -1714,6 +1714,6 @@ under the same terms as Perl itself.
=for html <hr>
-I<$Id: //depot/libnet/Net/FTP.pm#63 $>
+I<$Id: //depot/libnet/Net/FTP.pm#64 $>
=cut
View
6 Net/NNTP.pm
@@ -14,7 +14,7 @@ use Carp;
use Time::Local;
use Net::Config;
-$VERSION = "2.20"; # $Id: //depot/libnet/Net/NNTP.pm#13 $
+$VERSION = "2.20"; # $Id: //depot/libnet/Net/NNTP.pm#14 $
@ISA = qw(Net::Cmd IO::Socket::INET);
sub new
@@ -1016,7 +1016,7 @@ the beginning of the test string just inside the open square
bracket.
The final operation uses the backslash character to
-invalidate the special meaning of the a open square bracket C<[>,
+invalidate the special meaning of an open square bracket C<[>,
the asterisk, backslash or the question mark. Two backslashes in
sequence will result in the evaluation of the backslash as a
character with no special meaning.
@@ -1064,6 +1064,6 @@ it under the same terms as Perl itself.
=for html <hr>
-I<$Id: //depot/libnet/Net/NNTP.pm#13 $>
+I<$Id: //depot/libnet/Net/NNTP.pm#14 $>
=cut
View
6 Net/POP3.pm
@@ -13,7 +13,7 @@ use Net::Cmd;
use Carp;
use Net::Config;
-$VERSION = "2.22"; # $Id: //depot/libnet/Net/POP3.pm#19 $
+$VERSION = "2.22"; # $Id: //depot/libnet/Net/POP3.pm#20 $
@ISA = qw(Net::Cmd IO::Socket::INET);
@@ -417,7 +417,7 @@ Send the PASS command. Returns the number of messages in the mailbox.
=item login ( [ USER [, PASS ]] )
-Send both the the USER and PASS commands. If C<PASS> is not given the
+Send both the USER and PASS commands. If C<PASS> is not given the
C<Net::POP3> uses C<Net::Netrc> to lookup the password using the host
and username. If the username is not specified then the current user name
will be used.
@@ -520,6 +520,6 @@ it under the same terms as Perl itself.
=for html <hr>
-I<$Id: //depot/libnet/Net/POP3.pm#19 $>
+I<$Id: //depot/libnet/Net/POP3.pm#20 $>
=cut
View
6 Net/SMTP.pm
@@ -16,7 +16,7 @@ use IO::Socket;
use Net::Cmd;
use Net::Config;
-$VERSION = "2.18"; # $Id: //depot/libnet/Net/SMTP.pm#18 $
+$VERSION = "2.18"; # $Id: //depot/libnet/Net/SMTP.pm#19 $
@ISA = qw(Net::Cmd IO::Socket::INET);
@@ -470,7 +470,7 @@ known as mailhost:
=item new Net::SMTP [ HOST, ] [ OPTIONS ]
This is the constructor for a new Net::SMTP object. C<HOST> is the
-name of the remote host to which a SMTP connection is required.
+name of the remote host to which an SMTP connection is required.
If C<HOST> is not given, then the C<SMTP_Host> specified in C<Net::Config>
will be used.
@@ -641,6 +641,6 @@ it under the same terms as Perl itself.
=for html <hr>
-I<$Id: //depot/libnet/Net/SMTP.pm#18 $>
+I<$Id: //depot/libnet/Net/SMTP.pm#19 $>
=cut
View
56 Net/libnetFAQ.pod
@@ -6,8 +6,8 @@ libnetFAQ - libnet Frequently Asked Questions
=head2 Where to get this document
-This document is distributed with the libnet disribution, and is also
-avaliable on the libnet web page at
+This document is distributed with the libnet distribution, and is also
+available on the libnet web page at
http://www.pobox.com/~gbarr/libnet/
@@ -20,7 +20,7 @@ gbarr@pobox.com.
Copyright (c) 1997-1998 Graham Barr. All rights reserved.
This document is free; you can redistribute it and/or modify it
-under the terms of the Artistic Licence.
+under the terms of the Artistic License.
=head2 Disclaimer
@@ -35,7 +35,7 @@ in respect of this information or its use.
=head2 What is libnet ?
libnet is a collection of perl5 modules which all related to network
-programming. The majority of the modules avaliable provided the
+programming. The majority of the modules available provided the
client side of popular server-client protocols that are used in
the internet community.
@@ -55,7 +55,7 @@ these modules.
=head2 What machines support libnet ?
-libnet itself is an entirly perl-code distribution so it should work
+libnet itself is an entirely perl-code distribution so it should work
on any machine that perl runs on. However IO may not work
with some machines and earlier releases of perl. But this
should not be the case with perl version 5.004 or later.
@@ -65,16 +65,16 @@ should not be the case with perl version 5.004 or later.
The latest libnet release is always on CPAN, you will find it
in
- http://www.perl.com/CPAN/modules/by-module/Net/
+ http://www.cpan.org/modules/by-module/Net/
-The latest release and information is also avaliable on the libnet web page
+The latest release and information is also available on the libnet web page
at
http://www.pobox.com/~gbarr/libnet/
=head1 Using Net::FTP
-=head2 How do I download files from a FTP server ?
+=head2 How do I download files from an FTP server ?
An example taken from an article posted to comp.lang.perl.misc
@@ -135,9 +135,9 @@ But this is not guaranteed to work.
=head2 Can I do a reget operation like the ftp command ?
-=head2 How do I get a directory listing from a FTP server ?
+=head2 How do I get a directory listing from an FTP server ?
-=head2 Changeing directory to "" does not fail ?
+=head2 Changing directory to "" does not fail ?
Passing an argument of "" to ->cwd() has the same affect of calling ->cwd()
without any arguments. Turn on Debug (I<See below>) and you will see what is
@@ -155,19 +155,19 @@ gives
=head2 I am behind a SOCKS firewall, but the Firewall option does not work ?
The Firewall option is only for support of one type of firewall. The type
-supported is a ftp proxy.
+supported is an ftp proxy.
To use Net::FTP, or any other module in the libnet distribution,
through a SOCKS firewall you must create a socks-ified perl executable
by compiling perl with the socks library.
-=head2 I am behind a FTP proxy firewall, but cannot access machines outside ?
+=head2 I am behind an FTP proxy firewall, but cannot access machines outside ?
-Net::FTP implements the most popular ftp proxy firewall approach. The sceme
-implemented is that where you loginin to the firewall with C<user@hostname>
+Net::FTP implements the most popular ftp proxy firewall approach. The scheme
+implemented is that where you log in to the firewall with C<user@hostname>
I have heard of one other type of firewall which requires a login to the
-firewall with an accont, then a second login with C<user@hostname>. You can
+firewall with an account, then a second login with C<user@hostname>. You can
still use Net::FTP to traverse these firewalls, but a more manual approach
must be taken, eg
@@ -178,7 +178,7 @@ must be taken, eg
=head2 My ftp proxy firewall does not listen on port 21
FTP servers usually listen on the same port number, port 21, as any other
-FTP server. But there is no reason why thi has to be the case.
+FTP server. But there is no reason why this has to be the case.
If you pass a port number to Net::FTP then it assumes this is the port
number of the final destination. By default Net::FTP will always try
@@ -201,7 +201,7 @@ chmod command via the C<SITE> command. This can be done with
=head2 I have seen scripts call a method message, but cannot find it documented ?
Net::FTP, like several other packages in libnet, inherits from Net::Cmd, so
-all the methods described in Net::Cmd are also avaliable on Net::FTP
+all the methods described in Net::Cmd are also available on Net::FTP
objects.
=head2 Why does Net::FTP not implement mput and mget methods
@@ -241,14 +241,14 @@ of this protocol.
=head2 The verify method always returns true ?
-Well it may seem thay way, but it does not. The verify method returns true
-if the command suceeded. If you pass verify an address which the
-server would normally have to forward to another machine the the command
-will suceed with something like
+Well it may seem that way, but it does not. The verify method returns true
+if the command succeeded. If you pass verify an address which the
+server would normally have to forward to another machine, the command
+will succeed with something like
252 Couldn't verify <someone@there> but will attempt delivery anyway
-This command will only fail if you pass it an address in a domain the
+This command will fail only if you pass it an address in a domain
the server directly delivers for, and that address does not exist.
=head1 Debugging scripts
@@ -259,7 +259,7 @@ Most of the libnet client classes allow options to be passed to the
constructor, in most cases one option is called C<Debug>. Passing
this option with a non-zero value will turn on a protocol trace, which
will be sent to STDERR. This trace can be useful to see what commands
-are being sent to the remote server and what responces are being
+are being sent to the remote server and what responses are being
received back.
#!/your/path/to/perl
@@ -287,14 +287,14 @@ this script would output something like
Net::FTP=GLOB(0x8152974)>>> QUIT
Net::FTP=GLOB(0x8152974)<<< 221 Goodbye.
-The first few lines tell you the modules that Net::FTP uses and thier versions,
-this is usefule data to me when a user reports a bug. The last seven lines
+The first few lines tell you the modules that Net::FTP uses and their versions,
+this is useful data to me when a user reports a bug. The last seven lines
show the communication with the server. Each line has three parts. The first
part is the object itself, this is useful for separating the output
-if you are using mutiple objects. The second part is either C<<<<<> to
+if you are using multiple objects. The second part is either C<<<<<> to
show data coming from the server or C<&gt&gt&gt&gt> to show data
going to the server. The remainder of the line is the command
-being sent or responce being received.
+being sent or response being received.
=head1 AUTHOR AND COPYRIGHT
@@ -303,5 +303,5 @@ All rights reserved.
=for html <hr>
-I<$Id: //depot/libnet/Net/libnetFAQ.pod#4 $>
+I<$Id: //depot/libnet/Net/libnetFAQ.pod#5 $>
View
2 README
@@ -55,7 +55,7 @@ CONFIGURE
Normally when perl Makefile.PL is run it will run Configure which will
ask some questions about your system. The results of these questions
-will be stored in in a file called libnet.cfg which will be installed
+will be stored in a file called libnet.cfg which will be installed
alongside the other perl modules in this distribution. The Makefile.PL
will run Configure in an interactive mode unless these exists a file
called libnet.cfg in the build directory.

0 comments on commit 1af2256

Please sign in to comment.
Something went wrong with that request. Please try again.