This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
README.ce: Change some C<> into F<>
[perl5.git] / README.ce
CommitLineData
e1caacb4
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.
4
c7bcd97d 5=head1 NAME
e1caacb4 6
c7bcd97d 7perlce - Perl for WinCE
e1caacb4 8
75472953
VK
9=head1 Building Perl for WinCE
10
11=head2 DESCRIPTION
e1caacb4 12
2e64bfdb 13This file gives the instructions for building Perl5.8 and above for
e1caacb4
JH
14WinCE. Please read and understand the terms under which this
15software is distributed.
16
75472953 17=head2 General explanations on cross-compiling WinCE
e1caacb4 18
75472953
VK
19=over
20
21=item *
22
9b15f68e 23F<miniperl> is built. This is a single executable (without DLL), intended
75472953
VK
24to run on Win32, and it will facilitate remaining build process; all binaries
25built after it are foreign and should not run locally.
26
9b15f68e 27F<miniperl> is built using F<./win32/Makefile>; this is part of normal
75472953
VK
28build process invoked as dependency from wince/Makefile.ce
29
30=item *
31
9b15f68e 32After F<miniperl> is built, F<configpm> is invoked to create right F<Config.pm>
75472953 33in right place and its corresponding Cross.pm.
2e64bfdb 34
9b15f68e
KW
35Unlike Win32 build, miniperl will not have F<Config.pm> of host within reach;
36it rather will use F<Config.pm> from within cross-compilation directories.
2e64bfdb 37
9b15f68e
KW
38File F<Cross.pm> is dead simple: for given cross-architecture places in @INC
39a path where perl modules are, and right F<Config.pm> in that place.
e1caacb4 40
75472953 41That said, C<miniperl -Ilib -MConfig -we 1> should report an error, because
9b15f68e 42it can not find F<Config.pm>. If it does not give an error -- wrong F<Config.pm>
75472953
VK
43is substituted, and resulting binaries will be a mess.
44
45C<miniperl -MCross -MConfig -we 1> should run okay, and it will provide right
9b15f68e 46F<Config.pm> for further compilations.
75472953
VK
47
48=item *
49
9b15f68e
KW
50During extensions build phase, a script F<./win32/buldext.pl> is invoked,
51which in turn steps in F<./ext> subdirectories and performs a build of
75472953
VK
52each extension in turn.
53
9b15f68e 54All invokes of F<Makefile.PL> are provided with C<-MCross> so to enable cross-
75472953
VK
55compile.
56
75472953 57=back
8f33b42a 58
75472953
VK
59=head2 BUILD
60
61This section describes the steps to be performed to build PerlCE.
62You may find additional information about building perl for WinCE
63at L<http://perlce.sourceforge.net> and some pre-built binaries.
64
65=head3 Tools & SDK
e1caacb4 66
2e64bfdb
JH
67For compiling, you need following:
68
69=over 4
70
71=item * Microsoft Embedded Visual Tools
72
73=item * Microsoft Visual C++
74
75=item * Rainer Keuchel's celib-sources
76
77=item * Rainer Keuchel's console-sources
78
79=back
e1caacb4 80
75472953 81Needed source files can be downloaded at
464a08e7 82L<http://perlce.sourceforge.net>
e1caacb4 83
75472953 84=head3 Make
e1caacb4 85
9b15f68e 86Normally you only need to edit F<./win32/ce-helpers/compile.bat>
2e64bfdb 87to reflect your system and run it.
e1caacb4 88
9b15f68e 89File F<./win32/ce-helpers/compile.bat> is actually a wrapper to call
45496817
VK
90C<nmake -f makefile.ce> with appropriate parameters and it accepts extra
91parameters and forwards them to C<nmake> command as additional
2e64bfdb 92arguments. You should pass target this way.
e1caacb4 93
8f33b42a 94To prepare distribution you need to do following:
2e64bfdb
JH
95
96=over 4
97
9b15f68e 98=item * go to F<./win32> subdirectory
2e64bfdb 99
9b15f68e 100=item * edit file F<./win32/ce-helpers/compile.bat>
e1caacb4 101
2e64bfdb
JH
102=item * run
103 compile.bat
e1caacb4 104
2e64bfdb
JH
105=item * run
106 compile.bat dist
e1caacb4 107
2e64bfdb
JH
108=back
109
9b15f68e 110F<Makefile.ce> has C<CROSS_NAME> macro, and it is used further to refer to
8f33b42a
VK
111your cross-compilation scheme. You could assign a name to it, but this
112is not necessary, because by default it is assigned after your machine
113configuration name, such as "wince-sh3-hpc-wce211", and this is enough
114to distinguish different builds at the same time. This option could be
115handy for several different builds on same platform to perform, say,
116threaded build. In a following example we assume that all required
117environment variables are set properly for C cross-compiler (a special
9b15f68e 118*.bat file could fit perfectly to this purpose) and your F<compile.bat>
45496817 119has proper "MACHINE" parameter set, to, say, C<wince-mips-pocket-wce300>.
8f33b42a
VK
120
121 compile.bat
122 compile.bat dist
123 compile.bat CROSS_NAME=mips-wce300-thr "USE_ITHREADS=define" "USE_IMP_SYS=define" "USE_MULTI=define"
124 compile.bat CROSS_NAME=mips-wce300-thr "USE_ITHREADS=define" "USE_IMP_SYS=define" "USE_MULTI=define" dist
125
126If all goes okay and no errors during a build, you'll get two independent
45496817 127distributions: C<wince-mips-pocket-wce300> and C<mips-wce300-thr>.
8f33b42a 128
45496817
VK
129Target C<dist> prepares distribution file set. Target C<zipdist> performs
130same as C<dist> but additionally compresses distribution files into zip
8f33b42a
VK
131archive.
132
9b15f68e
KW
133NOTE: during a build there could be created a number (or one) of F<Config.pm>
134for cross-compilation ("foreign" F<Config.pm>) and those are hidden inside
135F<../xlib/$(CROSS_NAME)> with other auxiliary files, but, and this is important to
136note, there should be B<no> F<Config.pm> for host miniperl.
8f33b42a
VK
137If you'll get an error that perl could not find Config.pm somewhere in building
138process this means something went wrong. Most probably you forgot to
139specify a cross-compilation when invoking miniperl.exe to Makefile.PL
140When building an extension for cross-compilation your command line should
141look like
142
143 ..\miniperl.exe -I..\lib -MCross=mips-wce300-thr Makefile.PL
144
145or just
146
147 ..\miniperl.exe -I..\lib -MCross Makefile.PL
148
149to refer a cross-compilation that was created last time.
150
8f33b42a 151All questions related to building for WinCE devices could be asked in
ef39d023 152F<perlce-user@lists.sourceforge.net> mailing list.
e1caacb4 153
75472953
VK
154=head1 Using Perl on WinCE
155
156=head2 DESCRIPTION
157
158PerlCE is currently linked with a simple console window, so it also
159works on non-hpc devices.
160
9b15f68e
KW
161The simple stdio implementation creates the files F<stdin.txt>,
162F<stdout.txt> and F<stderr.txt>, so you might examine them if your
f858446f 163console has only a limited number of cols.
75472953
VK
164
165When exitcode is non-zero, a message box appears, otherwise the
166console closes, so you might have to catch an exit with
167status 0 in your program to see any output.
168
9b15f68e
KW
169stdout/stderr now go into the files F</perl-stdout.txt> and
170F</perl-stderr.txt.>
45496817
VK
171
172PerlIDE is handy to deal with perlce.
75472953
VK
173
174=head2 LIMITATIONS
175
176No fork(), pipe(), popen() etc.
177
178=head2 ENVIRONMENT
179
180All environment vars must be stored in HKLM\Environment as
181strings. They are read at process startup.
182
45496817
VK
183=over
184
185=item PERL5LIB
186
187Usual perl lib path (semi-list).
188
189=item PATH
190
191Semi-list for executables.
192
193=item TMP
194
195- Tempdir.
196
197=item UNIXROOTPATH
198
9b15f68e 199- Root for accessing some special files, i.e. F</dev/null>, F</etc/services>.
45496817
VK
200
201=item ROWS/COLS
202
203- Rows/cols for console.
204
205=item HOME
206
207- Home directory.
208
209=item CONSOLEFONTSIZE
210
211- Size for console font.
212
213=back
75472953
VK
214
215You can set these with cereg.exe, a (remote) registry editor
216or via the PerlIDE.
217
218=head2 REGISTRY
219
220To start perl by clicking on a perl source file, you have
9b15f68e 221to make the according entries in HKCR (see F<ce-helpers/wince-reg.bat>).
75472953
VK
222cereg.exe (which must be executed on a desktop pc with
223ActiveSync) is reported not to work on some devices.
224You have to create the registry entries by hand using a
225registry editor.
226
75472953
VK
227=head2 XS
228
229The following Win32-Methods are built-in:
230
231 newXS("Win32::GetCwd", w32_GetCwd, file);
232 newXS("Win32::SetCwd", w32_SetCwd, file);
233 newXS("Win32::GetTickCount", w32_GetTickCount, file);
234 newXS("Win32::GetOSVersion", w32_GetOSVersion, file);
235 newXS("Win32::IsWinNT", w32_IsWinNT, file);
236 newXS("Win32::IsWin95", w32_IsWin95, file);
237 newXS("Win32::IsWinCE", w32_IsWinCE, file);
238 newXS("Win32::CopyFile", w32_CopyFile, file);
239 newXS("Win32::Sleep", w32_Sleep, file);
240 newXS("Win32::MessageBox", w32_MessageBox, file);
241 newXS("Win32::GetPowerStatus", w32_GetPowerStatus, file);
242 newXS("Win32::GetOemInfo", w32_GetOemInfo, file);
243 newXS("Win32::ShellEx", w32_ShellEx, file);
244
245=head2 BUGS
246
247Opening files for read-write is currently not supported if
248they use stdio (normal perl file handles).
249
250If you find bugs or if it does not work at all on your
251device, send mail to the address below. Please report
252the details of your device (processor, ceversion,
253devicetype (hpc/palm/pocket)) and the date of the downloaded
254files.
255
256=head2 INSTALLATION
257
258Currently installation instructions are at L<http://perlce.sourceforge.net/>.
259
260After installation & testing processes will stabilize, information will
261be more precise.
262
c7bcd97d 263=head1 ACKNOWLEDGEMENTS
e1caacb4
JH
264
265The port for Win32 was used as a reference.
266
45496817
VK
267=head1 History of WinCE port
268
269=over
270
271=item 5.6.0
272
273Initial port of perl to WinCE. It was performed in separate directory
9b15f68e
KW
274named F<wince>. This port was based on contents of F<./win32> directory.
275F<miniperl> was not built, user must have HOST perl and properly edit
276F<makefile.ce> to reflect this.
45496817
VK
277
278=item 5.8.0
279
9b15f68e 280wince port was kept in the same F<./wince> directory, and F<wince/Makefile.ce>
45496817
VK
281was used to invoke native compiler to create HOST miniperl, which then
282facilitates cross-compiling process.
283Extension building support was added.
284
285=item 5.9.4
286
9b15f68e
KW
287Two directories F<./win32> and F<./wince> were merged, so perlce build
288process comes in F<./win32> directory.
45496817 289
ef39d023 290=back
45496817 291
2e64bfdb 292=head1 AUTHORS
e1caacb4 293
75472953
VK
294=over
295
296=item Rainer Keuchel <coyxc@rainer-keuchel.de>
297
298provided initial port of Perl, which appears to be most essential work, as
299it was a breakthrough on having Perl ported at all.
300Many thanks and obligations to Rainer!
301
302=item Vadim Konovalov
303
304made further support of WinCE port.
305
306=back