perlfunc.pod use documentation (5.6.0)
[p5sagit/p5-mst-13.2.git] / README.epoc
1 =====================================================================
2 Perl 5 README file for the EPOC operating system.
3 =====================================================================
4
5 Olaf Flebbe <o.flebbe@gmx.de>
6 http://www.linuxstart.com/~oflebbe/perl/perl5.html
7 2000-05-15
8
9 =====================================================================
10 Introduction
11 =====================================================================
12
13 EPOC is a OS for palmtops and mobile phones. For more informations look at:
14 http://www.symbian.com/
15
16 This is a port of Perl version 5.6.0 to EPOC. It runs on the Perl
17 Series 5, Series 5mx and the Psion Revo and on the Ericson M128.
18
19 Features are left out, because of restrictions of the POSIX support.
20
21 =====================================================================
22 Installation/Usage
23 =====================================================================
24
25 You will need ~4MB free space in order to install and run perl.
26
27 Install perl.sis on the EPOC machine (most likely a PSION Series 5,
28 5mx). If you do not know how to do that, you are on your own. 
29
30 Perl itself and its standard library are using 2.5 MB disk space. I
31 left out unicode support modules and modules which will not work with
32 this version. (For details look into epoc/createpkg.pl). If you like
33 to use them, you are free to copy them from a current perl release.
34
35 Copy eshell.exe from the same page you got perl to your EPOC device.
36 Start eshell.exe with a double tap.
37
38 Now you can enter: perl -de 0 in order to run the perl debugger. If
39 you are leaving perl, you get into the system screen. You have to
40 switch back manually to eshell.exe When perl is running, you will see
41 a task with the name STDOUT in the task list.
42
43 ======================================================================
44 IO Redirection
45 ======================================================================
46
47 You can redirect the output with the UNIX bourne shell syntax (this is
48 built into perl rather then eshell) For instance the following command
49 line will run the script test.pl with the output redirected to
50 stdout_file, the errors to stderr_file and input from stdin_file.
51
52 perl test.pl >stdout_file <stdin_file 2>stderr_file
53
54 Alternativly you can use 2>&1 in order to add the standard error
55 output to stdout.
56
57 ======================================================================
58 PATH Names
59 ======================================================================
60
61 Pathnames to executables in eshell.exe have to be written with
62 backslashes '\', file arguments to perl with slashes '/'. The default
63 drive of perl is the same as the drive perl.exe is located on, the
64 default path seems to be '/'.
65
66 i.e. command lines look a little bit funny:
67
68 D:\perl.exe C:/test.pl >C:/output.txt
69
70 You can automatically search for file on all EPOC drives with a ? as
71 the driver letter. For instance ?:\a.txt seraches for C:\a.txt,
72 D:\b.txt (and Z:\a.txt).
73
74 ======================================================================
75 Editors
76 ======================================================================
77
78 You may have a problem to create perl scripts. A cumbersome workaround
79 is to use the OPL Editor and exporting to text.
80
81 The OPL+ Editor is quite good. (Shareware: http://www.twiddlebit.com)
82 There is a port of vim around: 
83         http://www.starship.freeserve.co.uk/index.html
84
85 ======================================================================
86 Restrictions
87 ======================================================================
88
89 The following things are left out of this perl port:
90
91 + backquoting, pipes etc.
92
93 + system() does not inherit ressources like: file descriptors,
94   environment etc.
95
96 + signal, kill, alarm. Do not try to use them. This may be
97   impossible to implement on EPOC.
98
99 + select is missing.
100
101 + binmode does not exist. (No CR LF to LF translation for text files)
102
103 + EPOC does not handle the notion of current drive and current
104   directory very well (i.e. not at all, but it tries hard to emulate
105   one) See PATH.
106
107 + You need the shell eshell.exe in order to run perl.exe and supply
108   it with arguments.
109
110 + Heap is limited to 4MB.
111
112 ===================================================================
113 Compiling Perl 5 on the EPOC cross compiling envionment.
114 ===================================================================
115
116 Sorry, this is far too short.
117
118     You will need the C++ SDK from http://developer.epocworld.com/. 
119
120     You will need to set up the cross SDK from 
121     http://www.linuxstart.com/~oflebbe
122
123     You may have to adjust config.sh (cc, cppflags) for your epoc 
124     install location.
125
126     You may have to adjust config.sh for your cross SDK location
127
128     Get the Perl sources from your nearest CPAN site.
129
130     Unpack the sources. 
131
132       Build a native perl from this sources... 
133       cp epoc/* .
134       ./Configure -S
135       make perl
136       cp miniperl.native miniperl
137       make perl
138       perl link.pl perlmain.o lib/auto/DynaLoader/DynaLoader.a \
139          lib/auto/Data/Dumper.a \
140          lib/auto/File/Glob/Glob.a lib/auto/IO/IO.a \
141          lib/auto/Socket/Socket.a perl.a `cat ext.libs`
142       perl createpkg.pl 
143       wine "G:/bin/makesis perl.pkg perl.sis"
144
145
146 ====================================================================
147 Wish List
148 ====================================================================
149
150 - Threads ?
151 - Acess to the GUI?
152
153 ====================================================================
154 Support Status
155 ====================================================================
156
157 I'm offering this port "as is".  You can ask me questions, but I can't
158 guarantee I'll be able to answer them; I don't know much about Perl
159 internals myself.