This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Clean up docmentation installation errors.
authorPerl 5 Porters <perl5-porters@africa.nicoh.com>
Sat, 24 Aug 1996 23:56:18 +0000 (23:56 +0000)
committerAndy Dougherty <doughera@lafcol.lafayette.edu>
Sat, 24 Aug 1996 23:56:18 +0000 (23:56 +0000)
ext/IO/IO.pm
ext/IO/lib/IO/Seekable.pm
ext/IO/lib/IO/Select.pm
lib/AutoSplit.pm
lib/FindBin.pm
lib/sigtrap.pm
pod/perlapio.pod
pod/perlre.pod
pod/perltrap.pod
pod/perlxstut.pod
pod/pod2man.PL

index 645837b..cb6d5d8 100644 (file)
@@ -10,3 +10,26 @@ use IO::Socket;
 
 1;
 
+=head1 NAME
+
+IO - load various IO modules
+
+=head1 SYNOPSIS
+
+    use IO;
+
+=head1 DESCRIPTION
+
+C<IO> provides a simple mechanism to load all of the IO modules at one go.
+Currently this includes:
+
+       IO::Handle
+       IO::Seekable
+       IO::File
+       IO::Pipe
+       IO::Socket
+
+For more information on any of these modules, please see its respective
+documentation.
+
+=cut
index bfa0b2a..045e4d5 100644 (file)
@@ -6,6 +6,12 @@ package IO::Seekable;
 
 IO::Seekable - supply seek based methods for I/O objects
 
+=head1 SYNOPSIS
+
+       use IO::Seekable;
+       package IO::Something;
+       @ISA = qw(IO::Seekable);
+
 =head1 DESCRIPTION
 
 C<IO::Seekable> does not have a constuctor of its own as is intended to
index ed8c2bb..113b2b4 100644 (file)
@@ -6,7 +6,7 @@ package IO::Select;
 
 IO::Select - OO interface to the system select call
 
-=head1 SYNOPSYS
+=head1 SYNOPSIS
 
     use IO::Select;
 
index b1d797a..b582f78 100644 (file)
@@ -21,7 +21,7 @@ AutoSplit - split a package for autoloading
  use AutoSplit; autosplit($file, $dir, $keep, $check, $modtime);
 
 for perl versions 5.002 and later:
+
  perl -MAutoSplit -e 'autosplit($ARGV[0], $ARGV[1], $k, $chk, $modtime)' ...
 
 =head1 DESCRIPTION
index ecfa300..4bfc098 100644 (file)
@@ -28,7 +28,7 @@ directories <root>/bin and <root>/lib and then the above example will allow
 the use of modules in the lib directory without knowing where the software
 tree is installed.
 
-If perl is invoked using the -e option or the perl script is read from
+If perl is invoked using the B<-e> option or the perl script is read from
 C<STDIN> then FindBin sets both C<$Bin> and C<$RealBin> to the current
 directory.
 
@@ -46,7 +46,7 @@ if perl is invoked as
    perl filename
 
 and I<filename> does not have executable rights and a program called I<filename>
-exists in the users C<$ENV{PATH}> which satisfies both -x and -T then FindBin
+exists in the users C<$ENV{PATH}> which satisfies both B<-x> and B<-T> then FindBin
 assumes that it was invoked via the C<$ENV{PATH}>.
 
 Workaround is to invoke perl as
index f90f46b..378ca89 100644 (file)
@@ -160,7 +160,7 @@ installed handlers.
 These options affect which handler will be used for subsequently
 installed signals.
 
-=over
+=over 4
 
 =item B<stack-trace>
 
@@ -185,7 +185,7 @@ assignment to an element of C<%SIG>.
 
 B<sigtrap> has two built-in lists of signals to trap.  They are:
 
-=over
+=over 4
 
 =item B<normal-signals>
 
@@ -210,6 +210,8 @@ B<sigtrap> this list is used.
 
 =head2 OTHER
 
+=over 4
+
 =item B<untrapped>
 
 This token tells B<sigtrap> only to install handlers for subsequently
index 85900f1..5d87ff0 100644 (file)
@@ -89,7 +89,7 @@ These are is fprintf()/vfprintf equivalents.
 =item B<PerlIO_stdoutf(fmt,...)>
 
 This is printf() equivalent. printf is #defined to this function,
-so it is (currently) legal to use printf(fmt,...) in perl sources.
+so it is (currently) legal to use C<printf(fmt,...)> in perl sources.
 
 =item B<PerlIO_read(f,buf,count)>, B<PerlIO_write(f,buf,count)>
 
index a364916..6d21a65 100644 (file)
@@ -156,7 +156,7 @@ WARNING below.) The scope of $<digit> (and C<$`>, C<$&>, and C<$'>)
 extends to the end of the enclosing BLOCK or eval string, or to the next
 successful pattern match, whichever comes first.  If you want to use
 parentheses to delimit a subpattern (e.g. a set of alternatives) without
-saving it as a subpattern, follow the ( with a ?.
+saving it as a subpattern, follow the ( with a ?:.
 
 You may have as many parentheses as you wish.  If you have more
 than 9 substrings, the variables $10, $11, ... refer to the
index be58bc5..c3a3165 100644 (file)
@@ -796,7 +796,7 @@ that perl4 exhibits only for scalars.
     # SUB: this should never appear
     # SUB: this should never appear
 
-=back 
+=back
 
 =head2 Context Traps - scalar, list contexts
 
@@ -868,6 +868,8 @@ Probably a bug.
 
 Perl4-to-Perl5 traps involving precedence order.
 
+=over 5
+
 =item * 
 
 These are now semantic errors because of precedence:
@@ -1324,6 +1326,8 @@ immediately.
 
 Everything else.
 
+=over 5
+
 =item * Unclassified
 
 C<require>/C<do> trap using returned value
index 592f2ee..85a8c71 100644 (file)
@@ -88,7 +88,7 @@ test" is sufficient.
 Our first extension will be very simple.  When we call the routine in the
 extension, it will print out a well-known message and return.
 
-Run "h2xs -A -n Mytest".  This creates a directory named Mytest, possibly under
+Run C<h2xs -A -n Mytest>.  This creates a directory named Mytest, possibly under
 ext/ if that directory exists in the current working directory.  Several files
 will be created in the Mytest dir, including MANIFEST, Makefile.PL, Mytest.pm,
 Mytest.xs, test.pl, and Changes.
@@ -271,7 +271,7 @@ contain the shared library that we will build.  Once we have tested it, we
 can install it into its final location.
 
 Invoking the test script via "make test" did something very important.  It
-invoked perl with all those -I arguments so that it could find the various
+invoked perl with all those C<-I> arguments so that it could find the various
 files that are part of the extension.
 
 It is I<very> important that while you are still testing extensions that
@@ -582,11 +582,13 @@ for equality, but rather the difference being below a certain epsilon factor,
 
 Run "make test" and all should be well.
 
-=head 2 WHAT HAS HAPPENED HERE?
+=head2 WHAT HAS HAPPENED HERE?
 
 Unlike previous examples, we've now run h2xs on a real include file.  This
 has caused some extra goodies to appear in both the .pm and .xs files.
 
+=over 4
+
 =item *
 
 In the .xs file, there's now a #include declaration with the full path to
index 8c054ca..85c98c5 100644 (file)
@@ -402,7 +402,7 @@ if ($name ne 'something') {
                    $oops++;
                    warn "$0: Improper man page - no dash in NAME header in paragraph $. of $ARGV[0]\n"
                }
-               %namedesc = split /\s+-\s+/;
+               %namedesc = split /\s+-+\s+/;
                last FCHECK;
            }
            next if /^=cut\b/;  # DB_File and Net::Ping have =cut before NAME