Commit | Line | Data |
---|---|---|
3d513fb7 JH |
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. | |
2986a63f | 4 | |
c7bcd97d | 5 | =head1 NAME |
2986a63f | 6 | |
c7bcd97d | 7 | perlnetware - Perl for NetWare |
2986a63f | 8 | |
c7bcd97d | 9 | =head1 DESCRIPTION |
2986a63f | 10 | |
0cf85a06 JH |
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. | |
2986a63f | 16 | |
c7bcd97d | 17 | =head1 BUILD |
2986a63f | 18 | |
3d513fb7 JH |
19 | This section describes the steps to be performed to build a Perl NLM |
20 | and other associated NLMs. | |
2986a63f JH |
21 | |
22 | =head2 Tools & SDK | |
23 | ||
0cf85a06 | 24 | The build requires CodeWarrior compiler and linker. In addition, |
8e39ca14 JH |
25 | the "NetWare SDK", "NLM & NetWare Libraries for C" and |
26 | "NetWare Server Protocol Libraries for C", all available at | |
0a31a4b2 S |
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. | |
8e39ca14 | 30 | |
2986a63f JH |
31 | =head2 Setup |
32 | ||
3d513fb7 | 33 | The build process is dependent on the location of the NetWare SDK. |
0cf85a06 | 34 | Once the Tools & SDK are installed, the build environment has to |
3d513fb7 | 35 | be setup. The following batch files setup the environment. |
2986a63f | 36 | |
9fba2765 | 37 | =over 4 |
0cf85a06 | 38 | |
f355267c | 39 | =item SetNWBld.bat |
0cf85a06 | 40 | |
f355267c JH |
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. | |
0cf85a06 | 45 | |
3d513fb7 | 46 | =item Buildtype.bat |
2986a63f | 47 | |
f355267c JH |
48 | This is used to set the build type to debug or release. Change the |
49 | build type only after executing SetNWBld.bat | |
2986a63f | 50 | |
0cf85a06 | 51 | =item * |
2986a63f | 52 | |
f355267c JH |
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. | |
2986a63f | 59 | |
9fba2765 JH |
60 | =back |
61 | ||
2986a63f JH |
62 | =head2 Make |
63 | ||
79b683f6 JH |
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. | |
2986a63f | 72 | |
3a1825b5 | 73 | Currently the following two build types are tested on NetWare: |
2986a63f JH |
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 | ||
8e39ca14 JH |
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. | |
2986a63f JH |
93 | |
94 | =head2 Extensions | |
95 | ||
0cf85a06 | 96 | The make process also creates the Perl extensions as I<<Extension>.nlm> |
2986a63f | 97 | |
c7bcd97d | 98 | =head1 INSTALL |
2986a63f | 99 | |
79b683f6 JH |
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. | |
0cf85a06 | 107 | |
f355267c JH |
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) | |
2986a63f | 113 | |
c7bcd97d | 114 | =head1 BUILD NEW EXTENSIONS |
2986a63f | 115 | |
3d513fb7 | 116 | To build extensions other than standard extensions, NetWare Perl has |
79b683f6 JH |
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 | |
3a1825b5 | 124 | not copied. Thus one must first install Windows Perl, Then install |
0cf85a06 JH |
125 | NetWare Perl. |
126 | ||
127 | Once this is done, do the following to build any extension: | |
2986a63f JH |
128 | |
129 | =over 4 | |
130 | ||
131 | =item * | |
3d513fb7 | 132 | |
0cf85a06 JH |
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: | |
2986a63f | 138 | |
0cf85a06 | 139 | perl -II<path to NetWare lib dir> -II<path to lib> Makefile.pl |
3d513fb7 | 140 | |
0cf85a06 JH |
141 | Example: |
142 | ||
b972f34f JH |
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 | |
2986a63f JH |
148 | |
149 | =item * | |
3d513fb7 | 150 | |
2986a63f JH |
151 | nmake |
152 | ||
153 | =item * | |
2986a63f | 154 | |
3d513fb7 | 155 | nmake install |
2986a63f | 156 | |
3d513fb7 | 157 | Install will copy the files into the Windows machine where NetWare |
79b683f6 JH |
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 | |
0cf85a06 JH |
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. | |
3d513fb7 | 163 | |
0cf85a06 | 164 | Example: You can execute the following on the command prompt. |
2986a63f | 165 | |
b972f34f JH |
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 | |
0cf85a06 | 172 | INSTALLSITELIB=i:\perl\lib |
2986a63f | 173 | |
9fba2765 | 174 | =item * |
2986a63f | 175 | |
f355267c | 176 | Note: Some modules downloaded from CPAN may require NetWare related |
3a1825b5 | 177 | API in order to build on NetWare. Other modules may however build |
f355267c JH |
178 | smoothly with or without minor changes depending on the type of |
179 | module. | |
2986a63f | 180 | |
3d513fb7 JH |
181 | =back |
182 | ||
c7bcd97d | 183 | =head1 ACKNOWLEDGEMENTS |
2986a63f | 184 | |
b252981a | 185 | The makefile for Win32 is used as a reference to create the makefile |
0cf85a06 | 186 | for NetWare. Also, the make process for NetWare port uses |
8e39ca14 | 187 | miniperl.exe to run scripts during the make and installation process. |
2986a63f | 188 | |
c7bcd97d | 189 | =head1 AUTHORS |
2986a63f | 190 | |
8e39ca14 | 191 | Anantha Kesari H Y (hyanantha@novell.com) |
0cf85a06 | 192 | Aditya C (caditya@novell.com) |
2986a63f | 193 | |
c7bcd97d | 194 | =head1 DATE |
2986a63f JH |
195 | |
196 | =over 4 | |
197 | ||
198 | =item * | |
199 | ||
0cf85a06 | 200 | Created - 18 Jan 2001 |
2986a63f JH |
201 | |
202 | =item * | |
203 | ||
0cf85a06 | 204 | Modified - 25 June 2001 |
2986a63f | 205 | |
8e39ca14 JH |
206 | =item * |
207 | ||
0cf85a06 | 208 | Modified - 13 July 2001 |
8e39ca14 | 209 | |
0cf85a06 | 210 | =item * |
3d513fb7 | 211 | |
f355267c | 212 | Modified - 28 May 2002 |
0cf85a06 JH |
213 | |
214 | =back |