RE: [PATCH perl@8269] Corrections for Perl_yylex_r (used by a reentrant parser as...
[p5sagit/p5-mst-13.2.git] / README.epoc
index fd1c5c7..6c62565 100644 (file)
-=================================================
+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.
+
+=head1 NAME
+
+README.epoc - Perl for EPOC
+
+=head1 SYNOPSIS
+
 Perl 5 README file for the EPOC operating system.
-==================================================
 
-Olaf Flebbe (o.flebbe@science-computing.de)
-http://www.fortunecity.de/wolkenkratzer/trumpet/84/perl5.html
-June 27, 1999
+=head1 INTRODUCTION
+
+EPOC is a OS for palmtops and mobile phones. For more informations look at:
+http://www.symbian.com/
+
+This is a port of perl to EPOC. It runs on the Psion Series 5, 5mx,
+5mx Pro, Psion Revo and on the Ericson M128. I have no report about
+the Psion Netbook or the S7. For information about this hardware
+please refer to http://www.psion.com.
+
+=head1 INSTALLING PERL ON EPOC
+
+You will need ~4MB free space in order to install and run 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. 
+
+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.
+
+Get ESHELL from symbian: 
+http://developer.epocworld.com/downloads/progs/Eshell.zip
+
+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. When perl is running, you will see
+a task with the name STDOUT in the task list.
+
+=head1 USING PERL ON EPOC
+
+=head2 IO Redirection
+
+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.
+
+perl test.pl >stdout_file <stdin_file 2>stderr_file
+
+Alternatively you can use 2>&1 in order to add the standard error
+output to stdout.
+
+=head2 PATH Names
+
+ESHELL looks for executables in ?:/System/Programs. The SIS file
+installs perl in this special folder directory. The default drive and
+path are the same as folder the executable resides. The EPOC
+filesystem is case-preserving, not case-sensitive.
+
+EPOC uses the ?: syntax for establishing a search order: First in C: (RAM),
+then on D: (CF Card) and last in Z: (ROM).
+
+The perl @INC search path is now implemented with '?:'. Your perl
+executable can now live on a different drive than the perl library or
+even your scripts.
+
+ESHELL paths have to be written with backslashes '\', file arguments
+to perl with slashes '/'. Remember that I/O redirection is done
+internally in perl, so please use slashes for redirects.
+
+perl.exe C:/test.pl >C:/output.txt
+
+You can automatically search for file on all EPOC drives with a ? as
+the driver letter. For instance ?:\a.txt searches for C:\a.txt,
+D:\b.txt (and Z:\a.txt).
+
+=head2 Editors
+
+A suitable text-editor can be downloaded 
+from symbian http://developer.epocworld.com/downloads/progs/Editor.zip
+
+=head2 Features
+
+The built-in function EPOC::getcwd returns the current directory.
+
+=head2 Restrictions
+
+Features are left out, because of restrictions of the POSIX support in
+EPOC:
+
+=over 4
+
+=item *
+
+backquoting, pipes etc.
+
+=item *
+
+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.
+
+=item *
+
+select is missing.
+
+=item *
+
+binmode does not exist. (No CR LF to LF translation for text files)
+
+=item *
+
+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.
 
-Introduction
------------- 
+=item *
 
-This is a port of Perl version 5, revision 005-57 to EPOC. 
+Heap is limited to 4MB.
 
-There are many features left out, because of restrictions of the posix
-support in the SDK.
+=back
 
-The following known problems do exist:
+=head2 Compiling Perl 5 on the EPOC cross compiling environment
 
-1) very little testing.
+Sorry, this is far too short.
 
-2) no support for system, backquoting, pipes etc. One cannot exec a
-   different process.
+=over 4
 
-3) no signals, kill. Do not try to use them.
+=item *
 
-4) select is missing.
+You will need the C++ SDK from http://developer.epocworld.com/. 
 
-5) binmode does not work. (No CR LF to LF translation for text files)
+=item *
 
-6) no Config.pm
+You will need to set up the cross SDK from 
+http://www.science-computing.de/o.flebbe/sdk
 
-7) no I/O redirection.
+=item *
 
-8) it may not run from a drive other than C: (I have no CF Card to test)
+You may have to adjust config.sh (cc, cppflags) for your epoc 
+install location.
 
-9) sockets may hardly of any use.
+=item *
 
-10) You need a shell in order to run perl.exe.
+You may have to adjust config.sh for your cross SDK location
 
+=item *
 
-Compiling Perl 5 on the EPOC cross compiling envionment.
---------------------------------------------------------
+Get the Perl sources from your nearest CPAN site.
 
-0. You will need the C++ SDK from
-   http://developer.epocworld.com/. Install it on a separate drive.
+=item *
 
-1. Unpack the sources in the epoc development drive: The sources
-   should be in a directory perl5.005/perl5.005_57
+Unpack the sources. 
 
-2. Move all files in the directory perl5.005_57/epoc to perl5.005_57.
+=item *
 
-3. Check the perl.mmp file: It should have the correct locations for
-   project und subproject (see step 1)
+Build a native perl from this sources... 
 
-4. Change to the EPOC development drive and run 
-     makmake perl marm
-     nmake -f perl.marm
-     makesis perl.pkg perl5.005.sis
+      cp epoc/* .
+      ./Configure -S
+      make perl.a
+      cp miniperl.native miniperl
+      make perl
+      make ext/Errno/pm_to_blib 
+      perl link.pl perlmain.o lib/auto/DynaLoader/DynaLoader.a \
+         lib/auto/Data/Dumper/Dumper.a \
+         lib/auto/File/Glob/Glob.a lib/auto/IO/IO.a \
+         lib/auto/Socket/Socket.a \
+         lib/auto/Fcntl/Fcntl.a lib/auto/Sys/Hostname/Hostname.a \
+       perl.a `cat ext.libs`
+      perl createpkg.pl 
 
-5. Beam the perl5.005.sis to the Psion5, install and enjoy!
+      wine G:/bin/makesis perl.pkg perl.sis
 
-ToDo List
----------
+=back
 
-- Allocate an UID from symbian.
+=head1 SUPPORT STATUS
 
-- Implement system() and I/O redirection, in order to run the
-  tests.
+I'm offering this port "as is". You can ask me questions, but I can't
+guarantee I'll be able to answer them.
 
-- Implement getprotcolbyname() and relatives.
+=head1 AUTHOR
 
-- Implement perl as a OPX module. (What do you think?)
+Olaf Flebbe <o.flebbe@gmx.de>
+http://members.linuxstart.com/~oflebbe/perl/perl5.html
 
-Support Status
---------------
+=head1 LAST UPDATE
 
-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
-itself;
+2000-09-18
 
+=cut