This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
todos for perl 5.12
[perl5.git] / README.epoc
index b4bcca6..5cfa4df 100644 (file)
-=====================================================================
-Perl 5 README file for the EPOC operating system.
-=====================================================================
+If you read this file _as_is_, just ignore the funny characters you
+see. It is written in the POD format (see pod/perlpod.pod) which is
+specially designed to be readable as is.
 
-Olaf Flebbe <o.flebbe@gmx.de>
-http://www.linuxstart.com/~oflebbe/perl/perl5.html
-2000-02-20
+=head1 NAME
 
-=====================================================================
-Introduction
-=====================================================================
+README.epoc - Perl for EPOC
 
-EPOC is a OS for palmtops and mobile phones. For more informations look at:
+=head1 SYNOPSIS
+
+Perl 5 README file for the EPOC Release 5 operating system.
+
+=head1 INTRODUCTION
+
+EPOC is an OS for palmtops and mobile phones. For more informations look at:
 http://www.symbian.com/
 
-This is a port of Perl version 5.5.650 to EPOC. It runs on the Perl
-Series 5, Series 5mx and the Psion Revo. I have no reports for other
-EPOC devices.
+This is a port of perl to the epocemx SDK by Eberhard Mattes, which
+itself uses the SDK by symbian. Essentially epocemx it is a POSIX
+look alike environment for the EPOC OS.  For more information look at: 
+http://epocemx.sourceforge.net/
+
+perl and epocemx runs on Epoc Release 5 machines: Psion 5mx, 5mx Pro,
+Psion Revo, Psion Netbook and on the Ericsson M128. It may run on Epoc
+Release 3 Hardware (Series 5 classic), too. For more information about
+this hardware please refer to http://www.psion.com/
 
-Features are left out, because of restrictions of the POSIX support.
+Vendors which like to have support for their devices are free to send
+me a sample. 
 
-=====================================================================
-Installation/Usage
-=====================================================================
+=head1 INSTALLING PERL ON EPOC
 
-You will need ~4MB free space in order to install and run perl.
+You can download a ready-to-install version from
+http://www.oflebbe.de/oflebbe/perl/
 
-Install perl.sis on the EPOC machine (most likely a PSION Series 5,
-5mx). If you do not know how to do that, you are on your own. 
+You will need at least ~6MB free space in order to install and run perl.
 
-Perl itself and its standard library are using 2.5 MB disk space. I
-left out unicode support modules and modules which will not work with
-this version. (For details look into epoc/createpkg.pl). If you like
-to use them, you are free to copy them from a current perl release.
+Please install the emxusr.sis package from
+http://epocemx.sourceforge.net/ first.
 
-Copy eshell.exe from the same page you got perl to your EPOC device.
-Start eshell.exe with a double tap.
+Install perl.sis on the EPOC machine. If you do not know how to do
+that, consult your PsiWin documentation.
 
-Now you can enter: perl -de 0 in order to run the perl debugger. If
-you are leaving perl, you get into the system screen. You have to
-switch back manually to eshell.exe When perl is running, you will see
-a task with the name STDOUT in the task list.
+Perl itself and its standard library is using 4 MB disk space.
+Unicode support and some other modules are left out. (For details,
+please look into epoc/createpkg.pl). If you like to use these modules,
+you are free to copy them from a current perl release.
 
-======================================================================
-IO Redirection
-======================================================================
+=head1 STARTING PERL ON EPOC
 
-You can redirect the output with the UNIX bourne shell syntax (this is
-built into perl rather then eshell) For instance the following command
-line will run the script test.pl with the output redirected to
-stdout_file, the errors to stderr_file and input from stdin_file.
+Please use the epocemx shell to start perl. perl integrates with the
+conventions of epocemx. 
 
-perl test.pl >stdout_file <stdin_file 2>stderr_file
+=head2 Editors on Epoc
 
-Alternativly you can use 2>&1 in order to add the standard error
-output to stdout.
+A suitable text editor can be downloaded from symbian
+http://www.symbian.com/developer/downloads/files/editor.zip
 
-======================================================================
-PATH Names
-======================================================================
+=head2 Features of Perl on Epoc
 
-Pathnames to executables in eshell.exe have to be written with
-backslashes '\', file arguments to perl with slashes '/'. The default
-drive of perl is the same as the drive perl.exe is located on, the
-default path seems to be '/'.
+The built-in function EPOC::getcwd returns the current directory.
 
-i.e. command lines look a little bit funny:
+=head2 Restrictions of Perl on Epoc
 
-D:\perl.exe C:/test.pl >C:/output.txt
+Features are left out, because of restrictions of the POSIX support in
+EPOC:
 
-You can automatically search for file on all EPOC drives with a ? as
-the driver letter. For instance ?:\a.txt seraches for C:\a.txt,
-D:\b.txt (and Z:\a.txt).
+=over 4
 
-======================================================================
-Editors
-======================================================================
+=item * 
 
-You may have a problem to create perl scripts. A cumbersome workaround
-is to use the OPL Editor and exporting to text.
+socket IO is only implemented poorly. You can only use sysread and
+syswrite on them. The commands read, write, print, <> do not work for
+sockets. This may change iff epocemx supports sockets.
 
-The OPL+ Editor is quite good. (Shareware: http://www.twiddlebit.com)
-There is a port of vim around: 
-        http://www.starship.freeserve.co.uk/index.html
+=item *
 
-======================================================================
-Restrictions
-======================================================================
+kill, alarm and signals. Do not try to use them. This may be
+impossible to implement on EPOC.
 
-The following things are left out of this perl port:
+=item *
 
-+ backquoting, pipes etc.
+select is missing.
 
-+ system() does not inherit ressources like: file descriptors,
-  environment etc.
+=item *
 
-+ signal, kill, alarm. Do not try to use them. This may be
-  impossible to implement on EPOC.
+binmode does not exist. (No CR LF to LF translation for text files)
 
-+ select is missing.
+=item *
 
-+ binmode does not exist. (No CR LF to LF translation for text files)
+EPOC does not handle the notion of current drive and current
+directory very well (i.e. not at all, but it tries hard to emulate
+one). See PATH.
 
-+ EPOC does not handle the notion of current drive and current
-  directory very well (i.e. not at all, but it tries hard to emulate
-  one) See PATH.
+=item *
 
-+ You need the shell eshell.exe in order to run perl.exe and supply
-  it with arguments.
+Heap is limited to 4MB.
 
-+ Heap is limited to 4MB.
+=item *
 
-===================================================================
-Compiling Perl 5 on the EPOC cross compiling envionment.
-===================================================================
+Dynamic loading is not implemented.
+
+=back
+
+=head2 Compiling Perl 5 on the EPOC cross compiling environment
 
 Sorry, this is far too short.
 
-    You will need the C++ SDK from http://developer.epocworld.com/. 
+=over 4
+
+=item *
+
+You will need the epocemx SDK from Eberhard Mattes. 
 
-    You will need to set up the cross SDK from 
-    http://www.linuxstart.com/~oflebbe
+=item *
 
-    You may have to adjust config.sh (cc, cppflags) for your epoc 
-    install location.
+Get the Perl sources from your nearest CPAN site.
 
-    You may have to adjust config.sh for your cross SDK location
+=item *
 
-    Get the Perl sources from your nearest CPAN site.
+Unpack the sources. 
 
-    Unpack the sources. 
+=item *
+
+Build a native perl from this sources... Make sure to save the
+miniperl executable as miniperl.native.
+
+Start again from scratch
 
-      Build a native perl from this sources... 
       cp epoc/* .
       ./Configure -S
-      make perl
+      make 
       cp miniperl.native miniperl
-      make perl
-      perl link.pl perlmain.o lib/auto/DynaLoader/DynaLoader.a \
-         lib/auto/Data/Dumper.a \
-         lib/auto/File/Glob/Glob.a lib/auto/IO/IO.a \
-         lib/auto/Socket/Socket.a perl.a `cat ext.libs`
+      touch miniperl.exe
+      make
       perl createpkg.pl 
-      wine "G:/bin/makesis perl.pkg perl.sis"
 
+      emxsis perl.pkg perl.sis
+
+=back
+
+=head1 SUPPORT STATUS OF PERL ON EPOC
+
+I'm offering this port "as is". You can ask me questions, but I can't
+guarantee I'll be able to answer them. Since the port to epocemx is
+quite new, please check the web for updates first.
+
+Very special thanks to Eberhard Mattes for epocemx.
+
+=head1 AUTHOR
 
-====================================================================
-Wish List
-====================================================================
+Olaf Flebbe <olaf@oflebbe.de>
+http://www.oflebbe.de/oflebbe/perl/
 
-- Threads ?
-- Acess to the GUI?
+=head1 LAST UPDATE
 
-====================================================================
-Support Status
-====================================================================
+2003-01-18
 
-I'm offering this port "as is".  You can ask me questions, but I can't
-guarantee I'll be able to answer them; I don't know much about Perl
-internals myself;
+=cut