document how to set APPLLIB_EXP
[perl.git] / README.epoc
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 specially designed to be readable as is.
4
5 =head1 NAME
6
7 README.epoc - Perl for EPOC
8
9 =head1 SYNOPSIS
10
11 Perl 5 README file for the EPOC Release 5 operating system.
12
13 =head1 INTRODUCTION
14
15 EPOC is an OS for palmtops and mobile phones. For more informations look at:
16 http://www.symbian.com/
17
18 This is a port of perl to the epocemx SDK by Eberhard Mattes, which
19 itself uses the SDK by symbian. Essentially epocemx it is a POSIX
20 look alike environment for the EPOC OS. For more informations look at: 
21 http://www.windhager.de/~mattes/epocemx/
22
23 perl and epocemx runs on Epoc Release 5 machines: Psion 5mx, 5mx Pro,
24 Psion Revo, Psion Netbook and on the Ericson M128. It may run on Epoc
25 Release 3 Hardware (Series 5 classic), too. For more information about
26 this hardware please refer to http://www.psion.com/
27
28 Vendors which like to have support for their devices are free to send
29 me a sample. 
30
31 =head1 INSTALLING PERL ON EPOC
32
33 You can download a ready-to-install version from
34 http://www.science-computing.de/o.flebbe/perl/
35
36 You will need at least ~6MB free space in order to install and run
37 perl.
38
39 Please install the emxusr.sis package from
40 http://www.windhager.de/~mattes/epocemx/ first.
41
42 Install perl.sis on the EPOC machine. If you do not know how to do
43 that, consult your PsiWin documentation.
44
45 Perl itself and its standard library is using 4 MB disk space.
46 Unicode support and some other modules are left out. (For details,
47 please look into epoc/createpkg.pl). If you like to use these modules,
48 you are free to copy them from a current perl release.
49
50 =head1 STARTING PERL ON EPOC
51
52 Please use the epocemx shell to start perl. perl integrates with the
53 conventions of epocemx. 
54
55 =head2 Editors on Epoc
56
57 A suitable text editor can be downloaded from symbian
58 http://www.symbian.com/developer/downloads/files/editor.zip
59
60 =head2 Features of Perl on Epoc
61
62 The built-in function EPOC::getcwd returns the current directory.
63
64 =head2 Restrictions of Perl on Epoc
65
66 Features are left out, because of restrictions of the POSIX support in
67 EPOC:
68
69 =over 4
70
71 =item * 
72
73 socket IO is only implemented poorly. You can only use sysread and
74 syswrite on them. The commands read, write, print, <> do not work for
75 sockets. This may change iff epocemx supports sockets.
76
77 =item *
78
79 kill, alarm and signals. Do not try to use them. This may be
80 impossible to implement on EPOC.
81
82 =item *
83
84 select is missing.
85
86 =item *
87
88 binmode does not exist. (No CR LF to LF translation for text files)
89
90 =item *
91
92 EPOC does not handle the notion of current drive and current
93 directory very well (i.e. not at all, but it tries hard to emulate
94 one). See PATH.
95
96 =item *
97
98 Heap is limited to 4MB.
99
100 =item *
101
102 Dynamic loading is not implemented.
103
104 =back
105
106 =head2 Compiling Perl 5 on the EPOC cross compiling environment
107
108 Sorry, this is far too short.
109
110 =over 4
111
112 =item *
113
114 You will need the epocemx SDK from Eberhard Mattes. 
115
116 =item *
117
118 Get the Perl sources from your nearest CPAN site.
119
120 =item *
121
122 Unpack the sources. 
123
124 =item *
125
126 Build a native perl from this sources... Make sure to save the
127 miniperl executable as miniperl.native.
128
129 Start again from scratch
130
131       cp epoc/* .
132       ./Configure -S
133       make 
134       cp miniperl.native miniperl
135       touch miniperl.exe
136       make
137       perl createpkg.pl 
138
139       emxsis perl.pkg perl.sis
140
141 =back
142
143 =head1 SUPPORT STATUS OF PERL ON EPOC
144
145 I'm offering this port "as is". You can ask me questions, but I can't
146 guarantee I'll be able to answer them. Since the port to epocemx is
147 quite new, please check the web for updates first.
148
149 Very special thanks to Eberhard Mattes for epocemx.
150
151 =head1 AUTHOR
152
153 Olaf Flebbe <o.flebbe@science-computing.de>
154 http://www.science-computing.de/o.flebbe/perl/
155
156 =head1 LAST UPDATE
157
158 2002-03-26
159
160 =cut