Overeager visited-positions optimizations
[p5sagit/p5-mst-13.2.git] / README.epoc
index 88d2e5e..f66df5f 100644 (file)
@@ -1,42 +1,48 @@
-=================================================
-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/perl.html
-1999-11-01
+=head1 NAME
+
+README.epoc - Perl for EPOC
 
-Introduction
------------- 
+=head1 SYNOPSIS
+
+Perl 5 README file for the EPOC operating system.
 
-This is a port of Perl version 5.005_62 to EPOC. 
+=head1 INTRODUCTION
 
-There are many features left out, because of restrictions of the POSIX
-support in the SDK.
+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.
 
-Installation/Usage
-------------------
+=head1 INSTALLING PERL ON EPOC
 
-You will need ~4MB free space in order to run perl.
+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). If you do not know how to do that, you are on your own. You may
-have to use a CF Card in order to work with perl. The perl debugger
-uses more then 1.5 MB additional RAM. The heap is limited to 2 MB.
+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 1.7MB disk space. I
-left out UTF support and modules which will not work with this
-version. (For details look into epoc/createpkg.pl). 
+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.
 
-Copy eshell.exe to the same location as perl. Start eshell.exe with a
-double click.
+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 have to switch back manually to eshell.exe
-(With Ctrl-System or the button in the upper right corner of the
-System screen.) When perl is running, you will see a task with the
-name STDOUT in the task list. 
+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
@@ -45,89 +51,154 @@ stdout_file, the errors to stderr_file and input from stdin_file.
 
 perl test.pl >stdout_file <stdin_file 2>stderr_file
 
-Alternativly you can use 2>&1 in order to add the standard error output to
-stdout.
+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.
 
-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
-is the path perl.exe is / (???).
+=head2 Restrictions
 
-i.e. command lines look a little bit funny:
+Features are left out, because of restrictions of the POSIX support in
+EPOC:
 
-D:\perl.exe C:/test.pl >C:/output.txt
+=over 4
 
-In order to use Getopt::Long you have to autosplit this module by hand: run
+=item *
 
-\perl.exe \autosplit.pl in order to create the necessary files.
+backquoting, pipes etc.
 
-You may have a problem to create perl scripts. A cumbersome workaround
-is to use the OPL Editor and exporting to text.
+=item *
 
-Problems
---------
+system() does not inherit ressources like: file descriptors,
+environment etc.
 
-The following known problems exist:
+=item *
 
-1) no support for system, backquoting, pipes etc. One cannot exec a
-   different process.
+signal, kill, alarm. Do not try to use them. This may be
+impossible to implement on EPOC.
 
-2) no signals, kill, alarm. Do not try to use them. This may be
-   impossible to implement on EPOC.
+=item *
 
-3) select is missing.
+select is missing.
 
-4) binmode does not exist. (No CR LF to LF translation for text files)
+=item *
 
-5) Only a stub Config.pm
+binmode does not exist. (No CR LF to LF translation for text files)
 
-6) 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)
+=item *
 
-7) sockets may hardly of any use.
+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.
 
-8) You need the shell eshell.exe in order to run perl.exe and supply
-   it with arguments.
+=item *
 
+You need the shell eshell.exe in order to run perl.exe and supply
+it with arguments.
 
-Compiling Perl 5 on the EPOC cross compiling envionment.
---------------------------------------------------------
+=item *
 
-0. You will need the C++ SDK from
-   http://developer.epocworld.com/. Install it on a separate
-   drive.
+Heap is limited to 4MB.
 
-1. Get the Perl sources from your nearest CPAN site.
-   Unpack the sources of perl5.005_60 in the epoc development drive.
-2. Copy all files in the directory perl5.005_60/epoc to perl5.005_60.
+=back
 
-3. Check the perl.mmp file: It should have the correct locations for
-   project und subproject (see step 1)
+=head2 Compiling Perl 5 on the EPOC cross compiling environment
 
-4. Change to the EPOC development drive and run 
-     makmake perl marm
-     nmake -f perl.marm
-     makesis perl.pkg perl5.005.sis
+Sorry, this is far too short.
 
-5. Beam the perl5.005.sis to the Psion5, install and enjoy!
+=over 4
 
-You can use epoc\createpkg.pl to generate a new perl.pkg file. 
+=item *
 
+You will need the C++ SDK from http://developer.epocworld.com/. 
 
-Wish List
----------
+=item *
 
-- Implement an OPX to get rid of eshell.exe.
+You will need to set up the cross SDK from 
+http://members.linuxstart.com/~oflebbe
 
-- Implement system(), in order to run the  tests.
+=item *
+
+You may have to adjust config.sh (cc, cppflags) for your epoc 
+install location.
+
+=item *
+
+You may have to adjust config.sh for your cross SDK location
+
+=item *
+
+Get the Perl sources from your nearest CPAN site.
+
+=item *
+
+Unpack the sources. 
+
+=item *
+
+Build a native perl from this sources... 
+
+      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 
+
+      wine G:/bin/makesis perl.pkg perl.sis
+
+=back
+
+=head1 SUPPORT STATUS
+
+I'm offering this port "as is". You can ask me questions, but I can't
+guarantee I'll be able to answer them.
+
+=head1 AUTHOR
+
+Olaf Flebbe <o.flebbe@gmx.de>
+http://members.linuxstart.com/~oflebbe/perl/perl5.html
 
-- Implement getprotcolbyname() and relatives.
+=head1 LAST UPDATE
 
-Support Status
---------------
+2000-09-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