Fix some of the pods to produce more standard manpages,
authorRafael Garcia-Suarez <rgarciasuarez@gmail.com>
Sat, 13 Dec 2003 12:21:26 +0000 (12:21 +0000)
committerRafael Garcia-Suarez <rgarciasuarez@gmail.com>
Sat, 13 Dec 2003 12:21:26 +0000 (12:21 +0000)
as reported by Eric S. Raymond.

p4raw-id: //depot/perl@21885

README.ce
README.netware
lib/Getopt/Std.pm
lib/diagnostics.pm

index e8d4c49..83505af 100644 (file)
--- a/README.ce
+++ b/README.ce
@@ -2,17 +2,17 @@ If you read this file _as_is_, just ignore the funny characters you
 see.  It is written in the POD format (see pod/perlpod.pod) which is
 specifically designed to be readable as is.
 
-=head1 Name
+=head1 NAME
 
-Perl for WinCE
+perlce - Perl for WinCE
 
-=head1 Description
+=head1 DESCRIPTION
 
 This file gives the instructions for building Perl5.8 and above for
 WinCE.  Please read and understand the terms under which this
 software is distributed.
 
-=head1 Build
+=head1 BUILD
 
 This section describes the steps to be performed to build PerlCE.
 You may find additional and newer information about building perl
@@ -126,7 +126,7 @@ in this case.
 All questions related to building for WinCE devices could be asked in
 perlce-users@lists.sourceforge.net mailing list.
 
-=head1 Acknowledgements
+=head1 ACKNOWLEDGEMENTS
 
 The port for Win32 was used as a reference.
 
index 3dd70a6..df56abc 100644 (file)
@@ -2,11 +2,11 @@ If you read this file _as_is_, just ignore the funny characters you
 see.  It is written in the POD format (see pod/perlpod.pod) which is
 specifically designed to be readable as is.
 
-=head1 Name
+=head1 NAME
 
-Perl for NetWare
+perlnetware - Perl for NetWare
 
-=head1 Description
+=head1 DESCRIPTION
 
 This file gives instructions for building Perl 5.7 and above, and also 
 Perl modules for NetWare. Before you start, you may want to read the
@@ -14,7 +14,7 @@ README file found in the top level directory into which the Perl source
 code distribution was extracted. Make sure you read and understand
 the terms under which the software is being distributed.
 
-=head1 Build
+=head1 BUILD
 
 This section describes the steps to be performed to build a Perl NLM
 and other associated NLMs.
@@ -94,7 +94,7 @@ a release build, else will be copied under I<Debug> folder for debug builds.
 
 The make process also creates the Perl extensions as I<<Extension>.nlm>
 
-=head1 Install
+=head1 INSTALL
 
 To install NetWare Perl onto a NetWare server, first map the Sys
 volume of a NetWare server to I<i:>. This is because the makefile by
@@ -110,7 +110,7 @@ Example: At the command prompt Type "nmake nwinstall".
           This will cause the binaries to be installed on the local machine.
           (Typically under the c:\perl folder)
 
-=head1 Build new extensions
+=head1 BUILD NEW EXTENSIONS
 
 To build extensions other than standard extensions, NetWare Perl has
 to be installed on Windows along with Windows Perl. The Perl for
@@ -179,18 +179,18 @@ module.
 
 =back
 
-=head1 Acknowledgements
+=head1 ACKNOWLEDGEMENTS
 
 The makefile for Win32 is used as a reference to create the makefile
 for NetWare.  Also, the make process for NetWare port uses
 miniperl.exe to run scripts during the make and installation process.
 
-=head1 Authors
+=head1 AUTHORS
 
 Anantha Kesari H Y (hyanantha@novell.com)
 Aditya C (caditya@novell.com)
 
-=head1 Date
+=head1 DATE
 
 =over 4
 
index 1783adb..00c9020 100644 (file)
@@ -4,9 +4,7 @@ require Exporter;
 
 =head1 NAME
 
-getopt - Process single-character switches with switch clustering
-
-getopts - Process single-character switches with switch clustering
+getopt, getopts - Process single-character switches with switch clustering
 
 =head1 SYNOPSIS
 
index 0d1a7e2..2b75113 100755 (executable)
@@ -2,13 +2,11 @@ package diagnostics;
 
 =head1 NAME
 
-diagnostics - Perl compiler pragma to force verbose warning diagnostics
-
-splain - filter to produce verbose descriptions of perl warning diagnostics
+diagnostics, splain - produce verbose warning diagnostics
 
 =head1 SYNOPSIS
 
-As a pragma:
+Using the C<diagnostics> pragma:
 
     use diagnostics;
     use diagnostics -verbose;
@@ -16,12 +14,11 @@ As a pragma:
     enable  diagnostics;
     disable diagnostics;
 
-As a program:
+Using the C<splain> standalone filter program:
 
     perl program 2>diag.out
     splain [-v] [-p] diag.out
 
-
 =head1 DESCRIPTION
 
 =head2 The C<diagnostics> Pragma