From: Michael Stevens Date: Thu, 15 Mar 2001 21:25:18 +0000 (+0000) Subject: more pod patches X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=bbc7dcd2bd43efd6773e46b614c6eb1db5af78d2;p=p5sagit%2Fp5-mst-13.2.git more pod patches Message-ID: <20010315212518.A18870@firedrake.org> p4raw-id: //depot/perl@9176 --- diff --git a/configpm b/configpm index 31b416b..6b5252c 100755 --- a/configpm +++ b/configpm @@ -418,7 +418,7 @@ EOF print CONFIG < - + Stores package in the output. - + =back =head1 EXAMPLES diff --git a/ext/DB_File/DB_File.pm b/ext/DB_File/DB_File.pm index c830216..344227f 100644 --- a/ext/DB_File/DB_File.pm +++ b/ext/DB_File/DB_File.pm @@ -388,8 +388,8 @@ DB_File - Perl5 access to Berkeley DB version 1.x =head1 SYNOPSIS - use DB_File ; - + use DB_File; + [$X =] tie %hash, 'DB_File', [$filename, $flags, $mode, $DB_HASH] ; [$X =] tie %hash, 'DB_File', $filename, $flags, $mode, $DB_BTREE ; [$X =] tie @array, 'DB_File', $filename, $flags, $mode, $DB_RECNO ; @@ -699,7 +699,7 @@ contents of the database. here is the output: Banana Exists - + orange -> orange tomato -> red banana -> yellow @@ -797,13 +797,13 @@ code: $filename = "tree" ; unlink $filename ; - + # Enable duplicate records $DB_BTREE->{'flags'} = R_DUP ; - + tie %h, "DB_File", $filename, O_RDWR|O_CREAT, 0640, $DB_BTREE or die "Cannot open $filename: $!\n"; - + # Add some key/value pairs to the file $h{'Wall'} = 'Larry' ; $h{'Wall'} = 'Brick' ; # Note the duplicate key @@ -847,25 +847,25 @@ Here is the script above rewritten using the C API method. use warnings ; use strict ; use DB_File ; - + use vars qw($filename $x %h $status $key $value) ; $filename = "tree" ; unlink $filename ; - + # Enable duplicate records $DB_BTREE->{'flags'} = R_DUP ; - + $x = tie %h, "DB_File", $filename, O_RDWR|O_CREAT, 0640, $DB_BTREE or die "Cannot open $filename: $!\n"; - + # Add some key/value pairs to the file $h{'Wall'} = 'Larry' ; $h{'Wall'} = 'Brick' ; # Note the duplicate key $h{'Wall'} = 'Brick' ; # Note the duplicate key and value $h{'Smith'} = 'John' ; $h{'mouse'} = 'mickey' ; - + # iterate through the btree using seq # and print each key/value pair. $key = $value = 0 ; @@ -873,7 +873,7 @@ Here is the script above rewritten using the C API method. $status == 0 ; $status = $x->seq($key, $value, R_NEXT) ) { print "$key -> $value\n" } - + undef $x ; untie %h ; @@ -919,14 +919,14 @@ this: use warnings ; use strict ; use DB_File ; - + use vars qw($filename $x %h ) ; $filename = "tree" ; - + # Enable duplicate records $DB_BTREE->{'flags'} = R_DUP ; - + $x = tie %h, "DB_File", $filename, O_RDWR|O_CREAT, 0640, $DB_BTREE or die "Cannot open $filename: $!\n"; @@ -942,7 +942,7 @@ this: @list = $x->get_dup("Smith") ; print "Smith => [@list]\n" ; - + @list = $x->get_dup("Dog") ; print "Dog => [@list]\n" ; @@ -969,23 +969,23 @@ Assuming the database from the previous example: use warnings ; use strict ; use DB_File ; - + use vars qw($filename $x %h $found) ; my $filename = "tree" ; - + # Enable duplicate records $DB_BTREE->{'flags'} = R_DUP ; - + $x = tie %h, "DB_File", $filename, O_RDWR|O_CREAT, 0640, $DB_BTREE or die "Cannot open $filename: $!\n"; $found = ( $x->find_dup("Wall", "Larry") == 0 ? "" : "not") ; print "Larry Wall is $found there\n" ; - + $found = ( $x->find_dup("Wall", "Harry") == 0 ? "" : "not") ; print "Harry Wall is $found there\n" ; - + undef $x ; untie %h ; @@ -1008,14 +1008,14 @@ Again assuming the existence of the C database use warnings ; use strict ; use DB_File ; - + use vars qw($filename $x %h $found) ; my $filename = "tree" ; - + # Enable duplicate records $DB_BTREE->{'flags'} = R_DUP ; - + $x = tie %h, "DB_File", $filename, O_RDWR|O_CREAT, 0640, $DB_BTREE or die "Cannot open $filename: $!\n"; @@ -1023,7 +1023,7 @@ Again assuming the existence of the C database $found = ( $x->find_dup("Wall", "Larry") == 0 ? "" : "not") ; print "Larry Wall is $found there\n" ; - + undef $x ; untie %h ; @@ -1071,22 +1071,22 @@ and print the first matching key/value pair given a partial key. $x = tie %h, "DB_File", $filename, O_RDWR|O_CREAT, 0640, $DB_BTREE or die "Cannot open $filename: $!\n"; - + # Add some key/value pairs to the file $h{'mouse'} = 'mickey' ; $h{'Wall'} = 'Larry' ; $h{'Walls'} = 'Brick' ; $h{'Smith'} = 'John' ; - + $key = $value = 0 ; print "IN ORDER\n" ; for ($st = $x->seq($key, $value, R_FIRST) ; $st == 0 ; $st = $x->seq($key, $value, R_NEXT) ) - + { print "$key -> $value\n" } - + print "\nPARTIAL MATCH\n" ; match "Wa" ; @@ -1250,14 +1250,14 @@ L). use vars qw(@h $H $file $i) ; use DB_File ; use Fcntl ; - + $file = "text" ; unlink $file ; $H = tie @h, "DB_File", $file, O_RDWR|O_CREAT, 0640, $DB_RECNO or die "Cannot open file $file: $!\n" ; - + # first create a text file to play with $h[0] = "zero" ; $h[1] = "one" ; @@ -1265,7 +1265,7 @@ L). $h[3] = "three" ; $h[4] = "four" ; - + # Print the records in order. # # The length method is needed here because evaluating a tied diff --git a/ext/Data/Dumper/Dumper.pm b/ext/Data/Dumper/Dumper.pm index a8e59ab..b092a22 100644 --- a/ext/Data/Dumper/Dumper.pm +++ b/ext/Data/Dumper/Dumper.pm @@ -592,7 +592,6 @@ __END__ Data::Dumper - stringified perl data structures, suitable for both printing and C - =head1 SYNOPSIS use Data::Dumper; diff --git a/ext/Devel/Peek/Peek.pm b/ext/Devel/Peek/Peek.pm index 0850172..112412a 100644 --- a/ext/Devel/Peek/Peek.pm +++ b/ext/Devel/Peek/Peek.pm @@ -432,7 +432,7 @@ Looks like this: This shows that -=over +=over 4 =item * diff --git a/ext/Filter/Util/Call/Call.pm b/ext/Filter/Util/Call/Call.pm index 1936bbe..a21f671 100644 --- a/ext/Filter/Util/Call/Call.pm +++ b/ext/Filter/Util/Call/Call.pm @@ -58,7 +58,7 @@ __END__ Filter::Util::Call - Perl Source Filter Utility Module =head1 SYNOPSIS - + use Filter::Util::Call ; =head1 DESCRIPTION @@ -74,7 +74,7 @@ filter> and the second as I. Here is a skeleton for the I: package MyFilter ; - + use Filter::Util::Call ; sub import @@ -82,28 +82,28 @@ Here is a skeleton for the I: my($type, @arguments) = @_ ; filter_add([]) ; } - + sub filter { my($self) = @_ ; my($status) ; - + $status = filter_read() ; $status ; } - + 1 ; and this is the equivalent skeleton for the I: package MyFilter ; - + use Filter::Util::Call ; sub import { my($type, @arguments) = @_ ; - + filter_add( sub { @@ -112,7 +112,7 @@ and this is the equivalent skeleton for the I: $status ; } ) } - + 1 ; To make use of either of the two filter modules above, place the line @@ -293,26 +293,26 @@ occurrences of the string C<"Joe"> to C<"Jim">. Not particularly Useful, but it is the first example and I wanted to keep it simple. package Joe2Jim ; - + use Filter::Util::Call ; sub import { my($type) = @_ ; - + filter_add(bless []) ; } - + sub filter { my($self) = @_ ; my($status) ; - + s/Joe/Jim/g if ($status = filter_read()) > 0 ; $status ; } - + 1 ; Here is an example of using the filter: @@ -333,10 +333,10 @@ I. To reflect its enhanced role, the filter is called C. package Subst ; - + use Filter::Util::Call ; use Carp ; - + sub import { croak("usage: use Subst qw(from to)") @@ -371,14 +371,14 @@ will print a count of the number of substitutions actually made. Note that C<$status> is set to C<1> in this case. package Count ; - + use Filter::Util::Call ; - + sub filter { my ($self) = @_ ; my ($status) ; - + if (($status = filter_read()) > 0 ) { s/Joe/Jim/g ; ++ $$self ; @@ -391,14 +391,14 @@ Note that C<$status> is set to C<1> in this case. $status ; } - + sub import { my ($self) = @_ ; my ($count) = 0 ; filter_add(\$count) ; } - + 1 ; Here is a script which uses it: @@ -429,38 +429,38 @@ When used as a filter we want to invoke it like this: Here is the module. package NewSubst ; - + use Filter::Util::Call ; use Carp ; - + sub import { my ($self, $start, $stop, $from, $to) = @_ ; my ($found) = 0 ; croak("usage: use Subst qw(start stop from to)") unless @_ == 5 ; - + filter_add( sub { my ($status) ; - + if (($status = filter_read()) > 0) { - + $found = 1 if $found == 0 and /$start/ ; - + if ($found) { s/$from/$to/ ; filter_del() if /$stop/ ; } - + } $status ; } ) - + } - + 1 ; =head1 AUTHOR diff --git a/ext/IO/lib/IO/Handle.pm b/ext/IO/lib/IO/Handle.pm index fb754a6..063341a 100644 --- a/ext/IO/lib/IO/Handle.pm +++ b/ext/IO/lib/IO/Handle.pm @@ -100,7 +100,7 @@ The following methods are not supported on a per-filehandle basis. Furthermore, for doing normal I/O you might need these: -=over +=over 4 =item $io->fdopen ( FD, MODE ) @@ -206,7 +206,7 @@ failure. Lastly, there is a special method for working under B<-T> and setuid/gid scripts: -=over +=over 4 =item $io->untaint diff --git a/ext/IO/lib/IO/Seekable.pm b/ext/IO/lib/IO/Seekable.pm index 243a971..d3dfa1e 100644 --- a/ext/IO/lib/IO/Seekable.pm +++ b/ext/IO/lib/IO/Seekable.pm @@ -34,7 +34,7 @@ Uses the value of a previous getpos call to return to a previously visited position. Returns "0 but true" on success, C on failure. =back - + See L for complete descriptions of each of the following supported C methods, which are just front ends for the corresponding built-in functions: @@ -80,7 +80,7 @@ of zero is returned as the string C<"0 but true"> Returns the IO::File's current position, or -1 on error. =back - + =head1 SEE ALSO L, diff --git a/ext/IO/lib/IO/Socket/UNIX.pm b/ext/IO/lib/IO/Socket/UNIX.pm index 2a11752..5365242 100644 --- a/ext/IO/lib/IO/Socket/UNIX.pm +++ b/ext/IO/lib/IO/Socket/UNIX.pm @@ -103,7 +103,7 @@ be a C specification. NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE - + As of VERSION 1.18 all IO::Socket objects have autoflush turned on by default. This was not the case with earlier releases. diff --git a/ext/IPC/SysV/Msg.pm b/ext/IPC/SysV/Msg.pm index 120a5b2..a093238 100644 --- a/ext/IPC/SysV/Msg.pm +++ b/ext/IPC/SysV/Msg.pm @@ -126,6 +126,8 @@ IPC::Msg - SysV Msg IPC object class =head1 DESCRIPTION +A class providing an object based interface to SysV IPC message queues. + =head1 METHODS =over 4 diff --git a/ext/IPC/SysV/Semaphore.pm b/ext/IPC/SysV/Semaphore.pm index faf7411..1dac5dc 100644 --- a/ext/IPC/SysV/Semaphore.pm +++ b/ext/IPC/SysV/Semaphore.pm @@ -172,6 +172,8 @@ IPC::Semaphore - SysV Semaphore IPC object class =head1 DESCRIPTION +A class providing an object based interface to SysV IPC semaphores. + =head1 METHODS =over 4 diff --git a/ext/IPC/SysV/SysV.pm b/ext/IPC/SysV/SysV.pm index bebb8fd..0cc7400 100644 --- a/ext/IPC/SysV/SysV.pm +++ b/ext/IPC/SysV/SysV.pm @@ -74,7 +74,7 @@ C defines and conditionally exports all the constants defined in your system include files which are needed by the SysV IPC calls. -=over +=over 4 =item ftok( PATH, ID ) diff --git a/ext/NDBM_File/NDBM_File.pm b/ext/NDBM_File/NDBM_File.pm index b280459..a088bd3 100644 --- a/ext/NDBM_File/NDBM_File.pm +++ b/ext/NDBM_File/NDBM_File.pm @@ -28,11 +28,11 @@ NDBM_File - Tied access to ndbm files $h{newkey} = newvalue; print $h{oldkey}; ... - + untie %h; - + =head1 DESCRIPTION - + C establishes a connection between a Perl hash variable and a file in NDBM_File format;. You can manipulate the data in the file just as if it were in a Perl hash, but when your program exits, the diff --git a/ext/ODBM_File/ODBM_File.pm b/ext/ODBM_File/ODBM_File.pm index 9e8e008..c7b61d8 100644 --- a/ext/ODBM_File/ODBM_File.pm +++ b/ext/ODBM_File/ODBM_File.pm @@ -28,11 +28,11 @@ ODBM_File - Tied access to odbm files $h{newkey} = newvalue; print $h{oldkey}; ... - + untie %h; - + =head1 DESCRIPTION - + C establishes a connection between a Perl hash variable and a file in ODBM_File format;. You can manipulate the data in the file just as if it were in a Perl hash, but when your program exits, the diff --git a/ext/Socket/Socket.pm b/ext/Socket/Socket.pm index 90e16e6..344c87d 100644 --- a/ext/Socket/Socket.pm +++ b/ext/Socket/Socket.pm @@ -56,7 +56,7 @@ be imported individually, and with the C<:crlf> export tag: In addition, some structure manipulation functions are available: -=over +=over 4 =item inet_aton HOSTNAME diff --git a/ext/Storable/Storable.pm b/ext/Storable/Storable.pm index 86c5135..fa15b01 100644 --- a/ext/Storable/Storable.pm +++ b/ext/Storable/Storable.pm @@ -527,7 +527,7 @@ same object. Here is the hooking interface: -=over +=over 4 =item C I, I @@ -596,7 +596,7 @@ Returned value: none. Predicates are not exportable. They must be called by explicitely prefixing them with the Storable package name. -=over +=over 4 =item C @@ -623,7 +623,7 @@ serialization string? There are a few things you need to know however: -=over +=over 4 =item * diff --git a/ext/Sys/Syslog/Syslog.pm b/ext/Sys/Syslog/Syslog.pm index 71f5b82..9c05dcd 100644 --- a/ext/Sys/Syslog/Syslog.pm +++ b/ext/Sys/Syslog/Syslog.pm @@ -46,7 +46,7 @@ just like C. Syslog provides the functions: -=over +=over 4 =item openlog $ident, $logopt, $facility diff --git a/ext/Thread/Thread.pm b/ext/Thread/Thread.pm index f8a8a26..3a54548 100644 --- a/ext/Thread/Thread.pm +++ b/ext/Thread/Thread.pm @@ -22,7 +22,7 @@ Thread - manipulate threads in Perl (EXPERIMENTAL, subject to change) $result = $t->eval; $t->detach; $flags = $t->flags; - + if ($t->done) { $t->join; } diff --git a/ext/Thread/Thread/Queue.pm b/ext/Thread/Thread/Queue.pm index 831573c..8ace16d 100644 --- a/ext/Thread/Thread/Queue.pm +++ b/ext/Thread/Thread/Queue.pm @@ -59,7 +59,7 @@ before checking to make sure that it stays in a consistent state) =head1 SEE ALSO L - + =cut sub new { diff --git a/ext/attrs/attrs.pm b/ext/attrs/attrs.pm index 2070632..6c50bea 100644 --- a/ext/attrs/attrs.pm +++ b/ext/attrs/attrs.pm @@ -31,7 +31,7 @@ C on a subroutine reference or name returns its list of attribute names. Notice that C is not exported. Valid attributes are as follows. -=over +=over 4 =item method diff --git a/jpl/JNI/JNI.pm b/jpl/JNI/JNI.pm index edbc1e6..c3ade26 100644 --- a/jpl/JNI/JNI.pm +++ b/jpl/JNI/JNI.pm @@ -269,6 +269,8 @@ JNI - Perl encapsulation of the Java Native Interface =head1 DESCRIPTION +This module provides an encapsulation in Perl of the Java Native Interface. + =head1 Exported constants JNI_ABORT diff --git a/lib/CPAN.pm b/lib/CPAN.pm index fdaadb3..7cab8c6 100644 --- a/lib/CPAN.pm +++ b/lib/CPAN.pm @@ -6181,7 +6181,7 @@ beta and partially even alpha. In the following paragraphs only those methods are documented that have proven useful over a longer time and thus are unlikely to change. -=over +=over 4 =item CPAN::Author::as_glimpse() @@ -6746,7 +6746,7 @@ that you can configure ncftp so that it works for your firewall. Firewalls can be categorized into three basic types. -=over +=over 4 =item http firewall @@ -6780,7 +6780,7 @@ FTP connections need to be done in a passive mode. There are two that I can think off. -=over +=over 4 =item SOCKS @@ -6819,7 +6819,7 @@ Your milage may vary... =head1 FAQ -=over +=over 4 =item 1) diff --git a/lib/Class/Struct.pm b/lib/Class/Struct.pm index 185a8ff..57b8c86 100644 --- a/lib/Class/Struct.pm +++ b/lib/Class/Struct.pm @@ -361,7 +361,7 @@ optionally preceded by a C<'*'>. The accessor method provided by C for an element depends on the declared type of the element. -=over +=over 4 =item Scalar (C<'$'> or C<'*$'>) @@ -437,7 +437,7 @@ See Example 3 below for an example of initialization. =head1 EXAMPLES -=over +=over 4 =item Example 1 diff --git a/lib/Dumpvalue.pm b/lib/Dumpvalue.pm index c8282cf..9794625 100644 --- a/lib/Dumpvalue.pm +++ b/lib/Dumpvalue.pm @@ -495,7 +495,7 @@ A new dumper is created by a call Recognized options: -=over +=over 4 =item C, C @@ -563,7 +563,7 @@ method and set() method (which accept multiple arguments). =head2 Methods -=over +=over 4 =item dumpValue diff --git a/lib/ExtUtils/Embed.pm b/lib/ExtUtils/Embed.pm index c4167a3..b5a1bae 100644 --- a/lib/ExtUtils/Embed.pm +++ b/lib/ExtUtils/Embed.pm @@ -295,7 +295,7 @@ ccdlflags(), xsi_header(), xsi_protos(), xsi_body() =head1 FUNCTIONS -=over +=over 4 =item xsinit() diff --git a/lib/ExtUtils/Installed.pm b/lib/ExtUtils/Installed.pm index 6961c6f..b7ff815 100644 --- a/lib/ExtUtils/Installed.pm +++ b/lib/ExtUtils/Installed.pm @@ -208,7 +208,7 @@ described below. =head1 FUNCTIONS -=over +=over 4 =item new() diff --git a/lib/ExtUtils/MM_Cygwin.pm b/lib/ExtUtils/MM_Cygwin.pm index abb491f..45833ca 100644 --- a/lib/ExtUtils/MM_Cygwin.pm +++ b/lib/ExtUtils/MM_Cygwin.pm @@ -103,7 +103,7 @@ ExtUtils::MM_Cygwin - methods to override UN*X behaviour in ExtUtils::MakeMaker See ExtUtils::MM_Unix for a documentation of the methods provided there. -=over +=over 4 =item canonpath diff --git a/lib/ExtUtils/MM_OS2.pm b/lib/ExtUtils/MM_OS2.pm index d6bbc1c..a4bcf73 100644 --- a/lib/ExtUtils/MM_OS2.pm +++ b/lib/ExtUtils/MM_OS2.pm @@ -14,6 +14,28 @@ ExtUtils::MakeMaker->import(qw( $Verbose &neatvalue)); unshift @MM::ISA, 'ExtUtils::MM_OS2'; +=pod + +=head1 NAME + +ExtUtils::MM_OS2 - methods to override UN*X behaviour in ExtUtils::MakeMaker + +=head1 SYNOPSIS + + use ExtUtils::MM_OS2; # Done internally by ExtUtils::MakeMaker if needed + +=head1 DESCRIPTION + +See ExtUtils::MM_Unix for a documentation of the methods provided +there. This package overrides the implementation of these methods, not +the semantics. + +=head1 METHODS + +=over 4 + +=cut + sub dlsyms { my($self,%attribs) = @_; @@ -120,19 +142,11 @@ sub export_list } 1; -__END__ - -=head1 NAME - -ExtUtils::MM_OS2 - methods to override UN*X behaviour in ExtUtils::MakeMaker -=head1 SYNOPSIS - - use ExtUtils::MM_OS2; # Done internally by ExtUtils::MakeMaker if needed +__END__ -=head1 DESCRIPTION +=pod -See ExtUtils::MM_Unix for a documentation of the methods provided -there. This package overrides the implementation of these methods, not -the semantics. +=back +=cut diff --git a/lib/ExtUtils/MM_VMS.pm b/lib/ExtUtils/MM_VMS.pm index b753e2a..ef5b541 100644 --- a/lib/ExtUtils/MM_VMS.pm +++ b/lib/ExtUtils/MM_VMS.pm @@ -41,7 +41,7 @@ the semantics. =head2 Methods always loaded -=over +=over 4 =item wraplist @@ -173,7 +173,7 @@ For overridden methods, documentation is limited to an explanation of why this method overrides the MM_Unix method; see the ExtUtils::MM_Unix documentation for more details. -=over +=over 4 =item guess_name (override) diff --git a/lib/ExtUtils/MM_Win32.pm b/lib/ExtUtils/MM_Win32.pm index 80e247d..709be20 100644 --- a/lib/ExtUtils/MM_Win32.pm +++ b/lib/ExtUtils/MM_Win32.pm @@ -16,7 +16,7 @@ See ExtUtils::MM_Unix for a documentation of the methods provided there. This package overrides the implementation of these methods, not the semantics. -=over +=over 4 =cut diff --git a/lib/ExtUtils/Manifest.pm b/lib/ExtUtils/Manifest.pm index 3ac0fbf..244214a 100644 --- a/lib/ExtUtils/Manifest.pm +++ b/lib/ExtUtils/Manifest.pm @@ -447,7 +447,7 @@ produced. All diagnostic output is sent to C. -=over +=over 4 =item C I diff --git a/lib/ExtUtils/Mksymlists.pm b/lib/ExtUtils/Mksymlists.pm index c06b393..5f5ea06 100644 --- a/lib/ExtUtils/Mksymlists.pm +++ b/lib/ExtUtils/Mksymlists.pm @@ -217,7 +217,7 @@ C, which is exported by default from C. It takes one argument, a list of key-value pairs, in which the following keys are recognized: -=over +=over 4 =item DLBASE diff --git a/lib/ExtUtils/Packlist.pm b/lib/ExtUtils/Packlist.pm index 88ea206..309d727 100644 --- a/lib/ExtUtils/Packlist.pm +++ b/lib/ExtUtils/Packlist.pm @@ -200,7 +200,7 @@ filename followed by the key=value pairs from the hash. Reading back the =head1 FUNCTIONS -=over +=over 4 =item new() diff --git a/lib/File/Basename.pm b/lib/File/Basename.pm index 94aac2d..297386f 100644 --- a/lib/File/Basename.pm +++ b/lib/File/Basename.pm @@ -95,7 +95,7 @@ would yield $dir eq 'Doc_Root:[Help]' $type eq '.Rnh' -=over +=over 4 =item C diff --git a/lib/File/Spec/VMS.pm b/lib/File/Spec/VMS.pm index 60b0ec8..57c4005 100644 --- a/lib/File/Spec/VMS.pm +++ b/lib/File/Spec/VMS.pm @@ -26,7 +26,7 @@ See File::Spec::Unix for a documentation of the methods provided there. This package overrides the implementation of these methods, not the semantics. -=over +=over 4 =item eliminate_macros @@ -138,7 +138,7 @@ sub fixpath { =head2 Methods always loaded -=over +=over 4 =item canonpath (override) diff --git a/lib/File/Spec/Win32.pm b/lib/File/Spec/Win32.pm index f5d6cda..860ae0c 100644 --- a/lib/File/Spec/Win32.pm +++ b/lib/File/Spec/Win32.pm @@ -23,7 +23,7 @@ See File::Spec::Unix for a documentation of the methods provided there. This package overrides the implementation of these methods, not the semantics. -=over +=over 4 =item devnull diff --git a/lib/FileHandle.pm b/lib/FileHandle.pm index 5eb3a89..cd80d19 100644 --- a/lib/FileHandle.pm +++ b/lib/FileHandle.pm @@ -225,7 +225,7 @@ supported C methods: Furthermore, for doing normal I/O you might need these: -=over +=over 4 =item $fh->print diff --git a/lib/Filter/Simple.pm b/lib/Filter/Simple.pm index d5aa55af..fc41362 100644 --- a/lib/Filter/Simple.pm +++ b/lib/Filter/Simple.pm @@ -52,7 +52,6 @@ __END__ Filter::Simple - Simplified source filtering - =head1 SYNOPSIS # in MyFilter.pm: @@ -141,7 +140,7 @@ to the sequence C in any piece of code following a C statement (until the next C statement, if any): package BANG; - + use Filter::Util::Call ; sub import { @@ -198,7 +197,7 @@ contents of $_ to change the source code in the desired manner. In other words, the previous example, would become: package BANG; - + use Filter::Simple sub { s/BANG\s+BANG/die 'BANG' if \$BANG/g; }; @@ -218,7 +217,7 @@ list to the filtering subroutine, so the BANG.pm filter could easily be made parametric: package BANG; - + use Filter::Simple sub { my ($die_msg, $var_name) = @_; s/BANG\s+BANG/die '$die_msg' if \${$var_name}/g; diff --git a/lib/Getopt/Long.pm b/lib/Getopt/Long.pm index 472527d..ff0475b 100644 --- a/lib/Getopt/Long.pm +++ b/lib/Getopt/Long.pm @@ -1326,7 +1326,7 @@ used on the command line. The argument specification can be -=over +=over 4 =item ! @@ -1352,7 +1352,7 @@ The C<+> specifier is ignored if the option destination is not a scalar. The option requires an argument of the given type. Supported types are: -=over +=over 4 =item s diff --git a/lib/Locale/Constants.pm b/lib/Locale/Constants.pm index cc11969..957207e 100644 --- a/lib/Locale/Constants.pm +++ b/lib/Locale/Constants.pm @@ -31,7 +31,7 @@ Locale::Constants - constants for Locale codes =head1 SYNOPSIS use Locale::Constants; - + $codeset = LOCALE_CODE_ALPHA_2; =head1 DESCRIPTION diff --git a/lib/Locale/Country.pm b/lib/Locale/Country.pm index f60b135..ea446ee 100644 --- a/lib/Locale/Country.pm +++ b/lib/Locale/Country.pm @@ -7,13 +7,13 @@ Locale::Country - ISO codes for country identification (ISO 3166) =head1 SYNOPSIS use Locale::Country; - + $country = code2country('jp'); # $country gets 'Japan' $code = country2code('Norway'); # $code gets 'no' - + @codes = all_country_codes(); @names = all_country_names(); - + # add "uk" as a pseudo country code for United Kingdom Locale::Country::_alias_code('uk' => 'gb'); @@ -285,7 +285,7 @@ an ISO standard. If you would like 'uk' to work as the two-letter code for United Kingdom, use the following: use Locale::Country; - + Locale::Country::_alias_code('uk' => 'gb'); With this code, both "uk" and "gb" are valid codes for United Kingdom, @@ -325,7 +325,7 @@ The user is prompted for a country code, and then told the corresponding country name: $| = 1; # turn off buffering - + print "Enter country code: "; chop($code = ); $country = code2country($code, LOCALE_CODE_ALPHA_2); diff --git a/lib/Locale/Language.pm b/lib/Locale/Language.pm index 391cffa..c561157 100644 --- a/lib/Locale/Language.pm +++ b/lib/Locale/Language.pm @@ -7,10 +7,10 @@ Locale::Language - ISO two letter codes for language identification (ISO 639) =head1 SYNOPSIS use Locale::Language; - + $lang = code2language('en'); # $lang gets 'English' $code = language2code('French'); # $code gets 'fr' - + @codes = all_language_codes(); @names = all_language_names(); @@ -173,7 +173,7 @@ The user is prompted for a language code, and then told the corresponding language name: $| = 1; # turn off buffering - + print "Enter language code: "; chop($code = ); $lang = code2language($code); diff --git a/lib/Term/ANSIColor.pm b/lib/Term/ANSIColor.pm index b61efcb..09ca297 100644 --- a/lib/Term/ANSIColor.pm +++ b/lib/Term/ANSIColor.pm @@ -187,7 +187,7 @@ Term::ANSIColor - Color screen output using ANSI escape sequences This module has two interfaces, one through color() and colored() and the other through constants. - + color() takes any number of strings as arguments and considers them to be space-separated lists of attributes. It then forms and returns the escape sequence to set those attributes. It doesn't print it out, just returns diff --git a/lib/Test.pm b/lib/Test.pm index 89b9cec..19a9089 100644 --- a/lib/Test.pm +++ b/lib/Test.pm @@ -151,7 +151,7 @@ __END__ =head1 NAME - Test - provides a simple framework for writing test scripts +Test - provides a simple framework for writing test scripts =head1 SYNOPSIS diff --git a/lib/Test/Harness.pm b/lib/Test/Harness.pm index 55a84fe..73f3f79 100644 --- a/lib/Test/Harness.pm +++ b/lib/Test/Harness.pm @@ -650,7 +650,7 @@ test program. =over 4 -=item B<1..M> +=item B<'1..M'> This header tells how many tests there will be. It should be the first line output by your test program (but its okay if its preceded diff --git a/lib/Text/Wrap.pm b/lib/Text/Wrap.pm index 579e09b..3c88508 100644 --- a/lib/Text/Wrap.pm +++ b/lib/Text/Wrap.pm @@ -120,7 +120,7 @@ B $huge = 'overflow'; B - + use Text::Wrap $Text::Wrap::columns = 72; diff --git a/lib/Tie/Array.pm b/lib/Tie/Array.pm index f4c6193..5b8423e 100644 --- a/lib/Tie/Array.pm +++ b/lib/Tie/Array.pm @@ -179,7 +179,7 @@ For developers wishing to write their own tied arrays, the required methods are briefly defined below. See the L section for more detailed descriptive, as well as example code: -=over +=over 4 =item TIEARRAY classname, LIST diff --git a/lib/Tie/Handle.pm b/lib/Tie/Handle.pm index 81b0792..638cdf7 100644 --- a/lib/Tie/Handle.pm +++ b/lib/Tie/Handle.pm @@ -33,7 +33,7 @@ For developers wishing to write their own tied-handle classes, the methods are summarized below. The L section not only documents these, but has sample code as well: -=over +=over 4 =item TIEHANDLE classname, LIST diff --git a/lib/Tie/Hash.pm b/lib/Tie/Hash.pm index 7399d8b..3231155 100644 --- a/lib/Tie/Hash.pm +++ b/lib/Tie/Hash.pm @@ -10,24 +10,24 @@ Tie::Hash, Tie::StdHash - base class definitions for tied hashes package NewHash; require Tie::Hash; - + @ISA = (Tie::Hash); - + sub DELETE { ... } # Provides needed method sub CLEAR { ... } # Overrides inherited method - - + + package NewStdHash; require Tie::Hash; - + @ISA = (Tie::StdHash); - + # All methods provided by default, define only those needing overrides sub DELETE { ... } - - + + package main; - + tie %new_hash, 'NewHash'; tie %new_std_hash, 'NewStdHash'; @@ -46,7 +46,7 @@ For developers wishing to write their own tied hashes, the required methods are briefly defined below. See the L section for more detailed descriptive, as well as example code: -=over +=over 4 =item TIEHASH classname, LIST diff --git a/lib/Tie/Scalar.pm b/lib/Tie/Scalar.pm index 39480c8..bcaad0b 100644 --- a/lib/Tie/Scalar.pm +++ b/lib/Tie/Scalar.pm @@ -47,7 +47,7 @@ For developers wishing to write their own tied-scalar classes, the methods are summarized below. The L section not only documents these, but has sample code as well: -=over +=over 4 =item TIESCALAR classname, LIST diff --git a/lib/User/pwent.pm b/lib/User/pwent.pm index edd5f51..91d23bd 100644 --- a/lib/User/pwent.pm +++ b/lib/User/pwent.pm @@ -287,7 +287,7 @@ Tom Christiansen =head1 HISTORY -=over +=over 4 =item March 18th, 2000 diff --git a/lib/autouse.pm b/lib/autouse.pm index 179c382..5e4f30f 100644 --- a/lib/autouse.pm +++ b/lib/autouse.pm @@ -116,7 +116,7 @@ with the correct definitions. Using C will move important steps of your program's execution from compile time to runtime. This can -=over +=over 4 =item * diff --git a/lib/overload.pm b/lib/overload.pm index 21a4b67..d355f6a 100644 --- a/lib/overload.pm +++ b/lib/overload.pm @@ -267,7 +267,7 @@ is called with arguments C<($a,undef,'')> when $a++ is executed. Two types of mutators have different calling conventions: -=over +=over 4 =item C<++> and C<--> @@ -450,7 +450,7 @@ A computer-readable form of the above table is available in the hash Inheritance interacts with overloading in two ways. -=over +=over 4 =item Strings as values of C directive @@ -1028,7 +1028,7 @@ reference to the intermediate array, which keeps a reference to an actual array, and the access hash. The tie()ing object for the access hash is a reference to a reference to the actual array, so -=over +=over 4 =item * @@ -1058,8 +1058,8 @@ Put this in F in your Perl library directory: } This module is very unusual as overloaded modules go: it does not -provide any usual overloaded operators, instead it provides the L operator C. In this example the corresponding +provide any usual overloaded operators, instead it provides the +L operator C. In this example the corresponding subroutine returns an object which encapsulates operations done over the objects: C contains C<['n', 3]>, C<2 + new symbolic 3> contains C<['+', 2, ['n', 3]]>. diff --git a/os2/OS2/ExtAttr/ExtAttr.pm b/os2/OS2/ExtAttr/ExtAttr.pm index bebbcc9..c8b462c 100644 --- a/os2/OS2/ExtAttr/ExtAttr.pm +++ b/os2/OS2/ExtAttr/ExtAttr.pm @@ -133,7 +133,7 @@ OS2::ExtAttr - Perl access to extended attributes. tie %ea, 'OS2::ExtAttr', 'my.file'; print $ea{eaname}; $ea{myfield} = 'value'; - + untie %ea; =head1 DESCRIPTION diff --git a/os2/OS2/Process/Process.pm b/os2/OS2/Process/Process.pm index 88de2bf..556732e 100644 --- a/os2/OS2/Process/Process.pm +++ b/os2/OS2/Process/Process.pm @@ -128,14 +128,14 @@ C, get_title() and C are implemented. my_type() returns the type of the current process (one of "FS", "DOS", "VIO", "PM", "DETACH" and "UNKNOWN"), or C on error. -=over +=over 4 =item C returns the type of the executable file C, or dies on error. The bits 0-2 of the result contain one of the values -=over +=over 4 =item C (0) @@ -158,7 +158,7 @@ Application type is window-API. The remaining bits should be masked with the following values to determine the type of the executable: -=over +=over 4 =item C (8) @@ -204,46 +204,46 @@ to suppress). returns a list of the following data: -=over +=over 4 -=item +=item * Title of the process (in the C list); -=item +=item * window handle of switch entry of the process (in the C list); -=item +=item * window handle of the icon of the process; -=item +=item * process handle of the owner of the entry in C list; -=item +=item * process id of the owner of the entry in C list; -=item +=item * session id of the owner of the entry in C list; -=item +=item * whether visible in C list; -=item +=item * whether item cannot be switched to (note that it is not actually grayed in the C list)); -=item +=item * whether participates in jump sequence; -=item +=item * program type. Possible values are: @@ -263,7 +263,6 @@ is a windowed WIN-OS/2 program, it runs in a PROG_WINDOWEDVDM session. Likewise, if it's a full-screen WIN-OS/2 program, it runs in a PROG_VDM session. - =back =item C