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