perlsub - indicate version requirement for "delete local"

[perl5.git] / README.netware

diff --git a/README.netware b/README.netware
index 3dd70a6..4e35f39 100644 (file)
--- a/README.netware
+++ b/README.netware
@@ -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.
@@ -24,8 +24,9 @@ and other associated NLMs.
 The build requires CodeWarrior compiler and linker.  In addition,
 the "NetWare SDK", "NLM & NetWare Libraries for C" and
 "NetWare Server Protocol Libraries for C", all available at
-L<http://developer.novell.com/ndk/>, are also required.
-Microsoft Visual C++ version 4.2 or later is also required.
+L<http://developer.novell.com/wiki/index.php/Category:Novell_Developer_Kit>,
+are required. Microsoft Visual C++ version 4.2 or later is also
+required.
 
 =head2 Setup
 
@@ -47,14 +48,25 @@ sets the build type to Release by default.
 This is used to set the build type to debug or release. Change the
 build type only after executing SetNWBld.bat
 
-=item *
-
 Example:
-  1. Typing "buildtype d on" at the command prompt causes the buildtype
-     to be set to Debug type with D2 flag set. 
-  2. Typing "buildtype d off" or "buildtype d" at the command prompt causes
-     the buildtype to be set to Debug type with D1 flag set. 
-  2. Typing "buildtype r" at the command prompt sets it to Release Build type.
+
+=over
+
+=item 1.
+
+Typing "buildtype d on" at the command prompt causes the buildtype
+to be set to Debug type with D2 flag set. 
+
+=item 2.
+
+Typing "buildtype d off" or "buildtype d" at the command prompt causes
+the buildtype to be set to Debug type with D1 flag set. 
+
+=item 3.
+
+Typing "buildtype r" at the command prompt sets it to Release Build type.
+
+=back
 
 =back
 
@@ -63,7 +75,7 @@ Example:
 The make process runs only under WinNT shell.  The NetWare makefile is
 located under the NetWare folder.  This makes use of miniperl.exe to
 run some of the Perl scripts. To create miniperl.exe, first set the
-required paths for Visual c++ compilier (specify vcvars32 location) at
+required paths for Visual c++ compiler (specify vcvars32 location) at
 the command prompt.  Then run nmake from win32 folder through WinNT
 command prompt.  The build process can be stopped after miniperl.exe
 is created. Then run nmake from NetWare folder through WinNT command
@@ -94,7 +106,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
@@ -106,11 +118,11 @@ I<sys:\perl\system> folder.  Copy this to I<sys:\system> folder.
 
 Example: At the command prompt Type "nmake nwinstall".
           This will install NetWare Perl on the NetWare Server.
-          Similiarly if you type "nmake install",
-          This will cause the binaries to be installed on the local machine.
+          Similarly, if you type "nmake install",
+          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
@@ -139,11 +151,13 @@ Run the following command at the command prompt:
 
 Example:
 
-    perl -Ic:/perl/5.6.1/lib/NetWare-x86-multi-thread -Ic:\perl\5.6.1\lib MakeFile.pl
+    perl -Ic:/perl/5.6.1/lib/NetWare-x86-multi-thread           \
+                                -Ic:\perl\5.6.1\lib MakeFile.pl
 
 or
 
-    perl -Ic:/perl/5.8.0/lib/NetWare-x86-multi-thread -Ic:\perl\5.8.0\lib MakeFile.pl
+    perl -Ic:/perl/5.8.0/lib/NetWare-x86-multi-thread           \
+                                -Ic:\perl\5.8.0\lib MakeFile.pl
 
 =item *
 
@@ -162,13 +176,15 @@ typing I<nmake install>, will copy the files onto the NetWare server.
 
 Example: You can execute the following on the command prompt.
 
-          perl -Ic:/perl/5.6.1/lib/NetWare-x86-multi-thread -Ic:\perl\5.6.1\lib MakeFile.pl
-          INSTALLSITELIB=i:\perl\lib
+  perl -Ic:/perl/5.6.1/lib/NetWare-x86-multi-thread             \
+                                -Ic:\perl\5.6.1\lib MakeFile.pl
+  INSTALLSITELIB=i:\perl\lib
 
 or
 
-          perl -Ic:/perl/5.8.0/lib/NetWare-x86-multi-thread -Ic:\perl\5.8.0\lib MakeFile.pl
-          INSTALLSITELIB=i:\perl\lib
+  perl -Ic:/perl/5.8.0/lib/NetWare-x86-multi-thread             \
+                                -Ic:\perl\5.8.0\lib MakeFile.pl
+  INSTALLSITELIB=i:\perl\lib
 
 =item * 
 
@@ -179,18 +195,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