README.netware

   1 If you read this file _as_is_, just ignore the funny characters you
   2 see.  It is written in the POD format (see pod/perlpod.pod) which is
   3 specifically designed to be readable as is.
   4
   5 =head1 NAME
   6
   7 perlnetware - Perl for NetWare
   8
   9 =head1 DESCRIPTION
  10
  11 This file gives instructions for building Perl 5.7 and above, and also
  12 Perl modules for NetWare. Before you start, you may want to read the
  13 README file found in the top level directory into which the Perl source
  14 code distribution was extracted. Make sure you read and understand
  15 the terms under which the software is being distributed.
  16
  17 =head1 BUILD
  18
  19 This section describes the steps to be performed to build a Perl NLM
  20 and other associated NLMs.
  21
  22 =head2 Tools & SDK
  23
  24 The build requires CodeWarrior compiler and linker.  In addition,
  25 the "NetWare SDK", "NLM & NetWare Libraries for C" and
  26 "NetWare Server Protocol Libraries for C", all available at
  27 L<http://developer.novell.com/wiki/index.php/Category:Novell_Developer_Kit>,
  28 are required. Microsoft Visual C++ version 4.2 or later is also
  29 required.
  30
  31 =head2 Setup
  32
  33 The build process is dependent on the location of the NetWare SDK.
  34 Once the Tools & SDK are installed, the build environment has to
  35 be setup.  The following batch files setup the environment.
  36
  37 =over 4
  38
  39 =item SetNWBld.bat
  40
  41 The Execution of this file takes 2 parameters as input. The first
  42 being the NetWare SDK path, second being the path for CodeWarrior
  43 Compiler & tools. Execution of this file sets these paths and also
  44 sets the build type to Release by default.
  45
  46 =item Buildtype.bat
  47
  48 This is used to set the build type to debug or release. Change the
  49 build type only after executing SetNWBld.bat
  50
  51 =item *
  52
  53 Example:
  54   1. Typing "buildtype d on" at the command prompt causes the buildtype
  55      to be set to Debug type with D2 flag set.
  56   2. Typing "buildtype d off" or "buildtype d" at the command prompt causes
  57      the buildtype to be set to Debug type with D1 flag set.
  58   2. Typing "buildtype r" at the command prompt sets it to Release Build type.
  59
  60 =back
  61
  62 =head2 Make
  63
  64 The make process runs only under WinNT shell.  The NetWare makefile is
  65 located under the NetWare folder.  This makes use of miniperl.exe to
  66 run some of the Perl scripts. To create miniperl.exe, first set the
  67 required paths for Visual c++ compilier (specify vcvars32 location) at
  68 the command prompt.  Then run nmake from win32 folder through WinNT
  69 command prompt.  The build process can be stopped after miniperl.exe
  70 is created. Then run nmake from NetWare folder through WinNT command
  71 prompt.
  72
  73 Currently the following two build types are tested on NetWare:
  74
  75 =over 4
  76
  77 =item *
  78
  79 USE_MULTI, USE_ITHREADS & USE_IMP_SYS defined
  80
  81 =item *
  82
  83 USE_MULTI & USE_IMP_SYS defined and USE_ITHREADS not defined
  84
  85 =back
  86
  87 =head2 Interpreter
  88
  89 Once miniperl.exe creation is over, run nmake from the NetWare folder.
  90 This will build the Perl interpreter for NetWare as I<perl.nlm>.
  91 This is copied under the I<Release> folder if you are doing
  92 a release build, else will be copied under I<Debug> folder for debug builds.
  93
  94 =head2 Extensions
  95
  96 The make process also creates the Perl extensions as I<<Extension>.nlm>
  97
  98 =head1 INSTALL
  99
 100 To install NetWare Perl onto a NetWare server, first map the Sys
 101 volume of a NetWare server to I<i:>. This is because the makefile by
 102 default sets the drive letter to I<i:>.  Type I<nmake nwinstall> from
 103 NetWare folder on a WinNT command prompt.  This will copy the binaries
 104 and module files onto the NetWare server under I<sys:\Perl>
 105 folder. The Perl interpreter, I<perl.nlm>, is copied under
 106 I<sys:\perl\system> folder.  Copy this to I<sys:\system> folder.
 107
 108 Example: At the command prompt Type "nmake nwinstall".
 109           This will install NetWare Perl on the NetWare Server.
 110           Similiarly if you type "nmake install",
 111           This will cause the binaries to be installed on the local machine.
 112           (Typically under the c:\perl folder)
 113
 114 =head1 BUILD NEW EXTENSIONS
 115
 116 To build extensions other than standard extensions, NetWare Perl has
 117 to be installed on Windows along with Windows Perl. The Perl for
 118 Windows can be either downloaded from the CPAN site and built using
 119 the sources, or the binaries can be directly downloaded from the
 120 ActiveState site.  Installation can be done by invoking I<nmake
 121 install> from the NetWare folder on a WinNT command prompt after
 122 building NetWare Perl by following steps given above.  This will copy
 123 all the *.pm files and other required files.  Documentation files are
 124 not copied.  Thus one must first install Windows Perl, Then install
 125 NetWare Perl.
 126
 127 Once this is done, do the following to build any extension:
 128
 129 =over 4
 130
 131 =item *
 132
 133 Change to the extension directory where its source files are present.
 134
 135 =item *
 136
 137 Run the following command at the command prompt:
 138
 139     perl -II<path to NetWare lib dir> -II<path to lib> Makefile.pl
 140
 141 Example:
 142
 143     perl -Ic:/perl/5.6.1/lib/NetWare-x86-multi-thread -Ic:\perl\5.6.1\lib MakeFile.pl
 144
 145 or
 146
 147     perl -Ic:/perl/5.8.0/lib/NetWare-x86-multi-thread -Ic:\perl\5.8.0\lib MakeFile.pl
 148
 149 =item *
 150
 151 nmake
 152
 153 =item *
 154
 155 nmake install
 156
 157 Install will copy the files into the Windows machine where NetWare
 158 Perl is installed and these files may have to be copied to the NetWare
 159 server manually. Alternatively, pass I<INSTALLSITELIB=i:\perl\lib> as
 160 an input to makefile.pl above. Here I<i:> is the mapped drive to the
 161 sys: volume of the server where Perl on NetWare is installed. Now
 162 typing I<nmake install>, will copy the files onto the NetWare server.
 163
 164 Example: You can execute the following on the command prompt.
 165
 166           perl -Ic:/perl/5.6.1/lib/NetWare-x86-multi-thread -Ic:\perl\5.6.1\lib MakeFile.pl
 167           INSTALLSITELIB=i:\perl\lib
 168
 169 or
 170
 171           perl -Ic:/perl/5.8.0/lib/NetWare-x86-multi-thread -Ic:\perl\5.8.0\lib MakeFile.pl
 172           INSTALLSITELIB=i:\perl\lib
 173
 174 =item *
 175
 176 Note: Some modules downloaded from CPAN may require NetWare related
 177 API in order to build on NetWare.  Other modules may however build
 178 smoothly with or without minor changes depending on the type of
 179 module.
 180
 181 =back
 182
 183 =head1 ACKNOWLEDGEMENTS
 184
 185 The makefile for Win32 is used as a reference to create the makefile
 186 for NetWare.  Also, the make process for NetWare port uses
 187 miniperl.exe to run scripts during the make and installation process.
 188
 189 =head1 AUTHORS
 190
 191 Anantha Kesari H Y (hyanantha@novell.com)
 192 Aditya C (caditya@novell.com)
 193
 194 =head1 DATE
 195
 196 =over 4
 197
 198 =item *
 199
 200 Created - 18 Jan 2001
 201
 202 =item *
 203
 204 Modified - 25 June 2001
 205
 206 =item *
 207
 208 Modified - 13 July 2001
 209
 210 =item *
 211
 212 Modified - 28 May 2002
 213
 214 =back