This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perlsub - indicate version requirement for "delete local"
[perl5.git] / README.netware
index f453086..4e35f39 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.
@@ -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
 
@@ -35,42 +36,37 @@ be setup.  The following batch files setup the environment.
 
 =over 4
 
-=item *
+=item SetNWBld.bat
 
-If you want to build with Default settings you can follow the One step
-process given below to create the default Build Environment.
+The Execution of this file takes 2 parameters as input. The first
+being the NetWare SDK path, second being the path for CodeWarrior
+Compiler & tools. Execution of this file sets these paths and also
+sets the build type to Release by default.
 
-=item SetNWDef.bat
+=item Buildtype.bat
 
-The Execution of this file takes 2 parameters as input.The first being
-the NetWare SDK path, Second being the path for CodeWarrior Compiler &
-other tools. Execution of this file sets the Build type to
-Release(default) , the NetWare SDK path, path for Compiler & other
-tools.
+This is used to set the build type to debug or release. Change the
+build type only after executing SetNWBld.bat
 
-=item Custom Build Environment
+Example:
 
-If you want to change the default settings you could do so by
-following the steps listed below.
+=over
 
-=item Buildtype.bat
+=item 1.
 
-This sets the build type to release or debug.
+Typing "buildtype d on" at the command prompt causes the buildtype
+to be set to Debug type with D2 flag set. 
 
-=item *
+=item 2.
 
-Example: Typing "buildtype d on" at the command prompt causes the
-buildtype to be set to Debug type.  Typing "buildtype r" at the
-command prompt sets it to Release Build type.
+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 SetNWBld.bat
+=item 3.
 
-This sets the NetWare SDK path, path to Compiler & other tools.
+Typing "buildtype r" at the command prompt sets it to Release Build type.
 
-These batch files are under NetWare\bat folder.  These batch files
-call a couple of other batch files to setup the environment.  Invoking
-the batch file with I</now> will show the current settings and I</h>
-or I</?> gives the usage help.
+=back
 
 =back
 
@@ -79,13 +75,13 @@ or I</?> gives the usage help.
 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
 prompt.
 
-Currently the following two build types are tested on NetWare
+Currently the following two build types are tested on NetWare:
 
 =over 4
 
@@ -110,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
@@ -120,12 +116,13 @@ and module files onto the NetWare server under I<sys:\Perl>
 folder. The Perl interpreter, I<perl.nlm>, is copied under
 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.  Similarly if you type
-"nmake install", This will cause the binaries to be installed on the
-local machine.  (Typically under the c:\perl folder)
+Example: At the command prompt Type "nmake nwinstall".
+          This will install NetWare Perl on the NetWare Server.
+          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
@@ -135,7 +132,7 @@ ActiveState site.  Installation can be done by invoking I<nmake
 install> from the NetWare folder on a WinNT command prompt after
 building NetWare Perl by following steps given above.  This will copy
 all the *.pm files and other required files.  Documentation files are
-not copied.Thus one must first install Windows Perl, Then install
+not copied.  Thus one must first install Windows Perl, Then install
 NetWare Perl.
 
 Once this is done, do the following to build any extension:
@@ -154,7 +151,13 @@ Run the following command at the command prompt:
 
 Example:
 
-    perl -Ic:/perl/5.7.2/lib/NetWare-x86-multi-thread -Ic:\perl\5.7.2\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
 
 =item *
 
@@ -173,29 +176,37 @@ 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.7.2/lib/NetWare-x86-multi-thread -Ic:\perl\5.7.2\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
 
 =item * 
 
-Note: Some modules downloaded from CPAN may require NetWare related API
-in order to build on NetWare.Other modules may however build smoothly with or
-without minor changes depending on the type of module.
+Note: Some modules downloaded from CPAN may require NetWare related
+API in order to build on NetWare.  Other modules may however build
+smoothly with or without minor changes depending on the type of
+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
 
@@ -213,6 +224,6 @@ Modified - 13 July 2001
 
 =item *
 
-Modified - 8 May 2002
+Modified - 28 May 2002
 
 =back