This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perluniprops: Add text about using with older Unicode releases
[perl5.git] / README.symbian
index e6cb4dc..2572631 100644 (file)
@@ -4,7 +4,7 @@ designed to be readable as is.
 
 =head1 NAME
 
-README.symbian - Perl version 5 on Symbian OS
+perlsymbian - Perl version 5 on Symbian OS
 
 =head1 DESCRIPTION
 
@@ -12,14 +12,14 @@ This document describes various features of the Symbian operating
 system that will affect how Perl version 5 (hereafter just Perl)
 is compiled and/or runs.
 
-B<NOTE: this port (as of 0.1.0) does not compile into a Symbian
+B<NOTE: this port (as of 0.4.1) does not compile into a Symbian
 OS GUI application, but instead it results in a Symbian DLL.>
 The DLL includes a C++ class called CPerlBase, which one can then
 (derive from and) use to embed Perl into applications, see F<symbian/README>.
 
 The base port of Perl to Symbian only implements the basic POSIX-like
-functionality; it does not implement any further Symbian or Series 60
-bindings for Perl.
+functionality; it does not implement any further Symbian or Series 60,
+Series 80, or UIQ bindings for Perl.
 
 It is also possible to generate Symbian executables for "miniperl"
 and "perl", but since there is no standard command line interface
@@ -28,21 +28,23 @@ mainly as demonstrations.
 
 =head2 Compiling Perl on Symbian
 
-(0) You need to have the Symbian SDK installed.
+(0) You need to have the appropriate Symbian SDK installed.
 
     These instructions have been tested under various Nokia Series 60
-    Symbian SDKs (1.2 to 2.6).  You can get the SDKs from
-    Forum Nokia (http://www.forum.nokia.com/).
+    Symbian SDKs (1.2 to 2.6, 2.8 should also work, 1.2 compiles but
+    does not work), Series 80 2.0, and Nokia 7710 (Series 90) SDK.
+    You can get the SDKs from Forum Nokia (L<http://www.forum.nokia.com/>).
+    A very rough port ("it compiles") to UIQ 2.1 has also been made.
 
     A prerequisite for any of the SDKs is to install ActivePerl
-    from ActiveState, http://www.activestate.com/Products/ActivePerl/
+    from ActiveState, L<http://www.activestate.com/Products/ActivePerl/>
 
     Having the SDK installed also means that you need to have either
     the Metrowerks CodeWarrior installed (2.8 and 3.0 were used in testing)
     or the Microsoft Visual C++ 6.0 installed (SP3 minimum, SP5 recommended).
 
-    Note that for example the Serie s60 2.0 VC SDK installation talks
-    about ActivePerl build 518, which does no more (as of mid-2004) exist
+    Note that for example the Serie60 2.0 VC SDK installation talks
+    about ActivePerl build 518, which does no more (as of mid-2005) exist
     at the ActiveState website.  The ActivePerl 5.8.4 build 810 was
     used successfully for compiling Perl on Symbian.  The 5.6.x ActivePerls
     do not work.
@@ -55,7 +57,7 @@ mainly as demonstrations.
     releases, SDKs, compilers, platforms, or devices are naturally welcome.
 
 (1) Get a Perl source code distribution (for example the file
-    perl-5.9.2.tar.gz is fine) from http://www.cpan.org/src/
+    perl-5.9.2.tar.gz is fine) from L<http://www.cpan.org/src/>
     and unpack it in your the C:/Symbian directory of your Windows
     system.
 
@@ -67,42 +69,51 @@ mainly as demonstrations.
 
        perl symbian\config.pl
 
-    You must use the cmd.exe, the Cygwin shell will not work
-    (the PATH must include the SDK tools, including a Perl,
-    which should be the case under cmd.exe)
+    You must use the cmd.exe, the Cygwin shell will not work.
+    The PATH must include the SDK tools, including a Perl,
+    which should be the case under cmd.exe.  If you do not
+    have that, see the end of symbian\sdk.pl for notes of
+    how your environment should be set up for Symbian compiles.
 
 (4) Build the project, either by
 
        make all
 
     in cmd.exe or by using either the Metrowerks CodeWarrior
-    or the Visual C++ 6.0.
+    or the Visual C++ 6.0, or the Visual Studio 8 (the Visual C++
+    2005 Express Edition works fine).
 
     If you use the VC IDE, you will have to run F<symbian\config.pl>
     first using the cmd.exe, and then run 'make win.mf vc6.mf' to generate
-    the VC6 makefiles and workspaces.
+    the VC6 makefiles and workspaces.  "make vc6" will compile for the VC6,
+    and "make cw" for the CodeWarrior.
 
-    The following Series 60 SDK and compiler configurations and Nokia
-    phones that were tested (+ = compiled and PerlApp run, - = not),
+    The following SDK and compiler configurations and Nokia phones were
+    tested at some point in time (+ = compiled and PerlApp run, - = not),
     both for Perl 5.8.x and 5.9.x:
 
-        SDK | VC | CW |
-        ----+----+----+---
-        1.2 | +  | +  | 3650 (*)
-        2.0 | +  | +  | 6600
-        2.1 | -  | +  | 6670
-        2.6 | +  | +  | 6630    
+        SDK     | VC | CW |
+        --------+----+----+---
+        S60 1.2 | +  | +  | 3650 (*)
+        S60 2.0 | +  | +  | 6600
+        S60 2.1 | -  | +  | 6670
+        S60 2.6 | +  | +  | 6630    
+        S60 2.8 | +  | +  | (not tested in a device)
+        S80 2.6 | -  | +  | 9300
+        S90 1.1 | +  | -  | 7710
+        UIQ 2.1 | -  | +  | (not tested in a device)
+
+    (*) Compiles but does not work, unfortunately, a problem with Symbian.
 
     If you are using the 'make' directly, it is the GNU make from the SDKs,
     and it will invoke the right make commands for the Windows emulator
     build and the Arm target builds ('thumb' by default) as necessary.
-    (*) Compiles but does not work, unfortunately.
 
     The build scripts assume the 'absolute style' SDK installs under C:,
     the 'subst style' will not work.
 
     If using the VC IDE, to build use for example the File->Open Workspace->
-    C:\Symbian\8.as\S60_2nd_FP2\epoc32\build\symbian\perl\perl\wins\perl.dsw
+    C:\Symbian\8.0a\S60_2nd_FP2\epoc32\build\symbian\perl\perl\wins\perl.dsw
     The emulator binaries will appear in the same directory.
 
     If using the VC IDE, you will a lot of warnings in the beginning of
@@ -126,7 +137,7 @@ mainly as demonstrations.
     the messages.
 
     Since the total size of all Perl SIS files once installed is
-    over 1.9 MB, it is recommended to do the installation into a
+    over 2 MB, it is recommended to do the installation into a
     memory card (drive E:) instead of the C: drive.
 
     The size of the perlXYZ.SIS is about 370 kB but once it is in the
@@ -147,7 +158,7 @@ mainly as demonstrations.
 
         make perlext.sis
 
-    which will create perlXYZext.sis (210 kB -> 470 kB).
+    which will create perlXYZext.sis (290 kB -> 770 kB).
 
     To compile the demonstration application PerlApp you need first to
     install the Perl headers under the SDK.
@@ -204,7 +215,7 @@ If you see right after "make" this
     'cat' is not recognized as an internal or external command,
     operable program or batch file.
 
-it means you need to (re)run the symbian\config.pl.
+it means you need to (re)run the F<symbian\config.pl>.
 
 If you get the error
 
@@ -232,11 +243,20 @@ the "Oneliner" allows one to type in Perl code, and the "Run"
 opens a file chooser for selecting a Perl file to run.
 
 The PerlApp also is started when the "Perl recognizer" (also included
-and installed) detects a Perl file being activated througg the GUI,
+and installed) detects a Perl file being activated through the GUI,
 and offers either to install it under \Perl (if the Perl file is in
 the inbox of the messaging application) or to run it (if the Perl file
 is under \Perl).
 
+=head2 sisify.pl
+
+In the symbian subdirectory there is F<sisify.pl> utility which can be used
+to package Perl scripts and/or Perl library directories into SIS files,
+which can be installed to the device.  To run the sisify.pl utility,
+you will need to have the 'makesis' and 'uidcrc' utilities already
+installed.  If you don't have the Win32 SDKs, you may try for example
+L<http://gnupoc.sourceforge.net/> or L<http://symbianos.org/~andreh/>.
+
 =head2 Using Perl in Symbian
 
 First of all note that you have full access to the Symbian device
@@ -250,22 +270,23 @@ library, but certain corners of such emulation libraries that tend
 to be left unimplemented on non-UNIX platforms have been left
 unimplemented also this time: fork(), signals(), user/group ids,
 select() working for sockets, non-blocking sockets, and so forth.
-See the file symbian/config.sh and look for 'undef' to find the
+See the file F<symbian/config.sh> and look for 'undef' to find the
 unsupported APIs (or from Perl use Config).
-  
+
 The filesystem of Symbian devices uses DOSish syntax, "drives"
-separated from paths by a colon, and backslashes for the path.
-The exact assignment of the drives probably varies between platforms,
-but you might for example see C: as the flash main memory, D: as the
-RAM drive, E: as the memory card (MMC), Z: as the ROM.  As far the
-devices go the NUL: is the bit bucket, the COMx: are the serial lines,
-IRCOMx: are the IR ports, TMP: might be C:\System\Temp.  Remember to
-double those backslashes in doublequoted strings.
+separated from paths by a colon, and backslashes for the path.  The
+exact assignment of the drives probably varies between platforms, but
+for example in Series 60 you might see C: as the (flash) main memory,
+D: as the RAM drive, E: as the memory card (MMC), Z: as the ROM.  In
+Series 80 D: is the memory card.  As far the devices go the NUL: is
+the bit bucket, the COMx: are the serial lines, IRCOMx: are the IR
+ports, TMP: might be C:\System\Temp.  Remember to double those
+backslashes in doublequoted strings.
 
 The Perl DLL is installed in \System\Libs\.  The Perl libraries and
 extension DLLs are installed in \System\Libs\Perl\X.Y.Z\.  The PerlApp
 is installed in \System\Apps\, and the SIS also installs a couple of
-demo scripts in \Perl\.
+demo scripts in \Perl\ (C:\Mydocs\Perl\ on Nokia 7710).
 
 Note that the Symbian filesystem is very picky: it strongly prefers
 the \ instead of the /.
@@ -280,11 +301,11 @@ the Perl definitions and redefines them as PerlNew() and PerlCopy().
 
 =head1 TO DO
 
-Lots.  See F<symbian\TODO>.
+Lots.  See F<symbian/TODO>.
 
 =head1 WARNING
 
-As of Perl Symbian port version 0.1.0 any part of Perl's standard
+As of Perl Symbian port version 0.4.1 any part of Perl's standard
 regression test suite has not been run on a real Symbian device using
 the ported Perl, so innumerable bugs may lie in wait.  Therefore there
 is absolutely no warranty.
@@ -292,12 +313,13 @@ is absolutely no warranty.
 =head1 NOTE
 
 When creating and extending application programming interfaces (APIs)
-for Symbian or Series 60 it is suggested that trademarks, registered
-trademarks, or trade names are not used in the API names.  Instead,
-developers should consider basing the API naming in the existing (C++)
-public component and API naming, modified as appropriate by the rules
-of the programming language the new APIs are for.
-  
+for Symbian or Series 60 or Series 80 or Series 90 it is suggested
+that trademarks, registered trademarks, or trade names are not used in
+the API names.  Instead, developers should consider basing the API
+naming in the existing (C++, or maybe Java) public component and API
+naming, modified as appropriate by the rules of the programming
+language the new APIs are for.
+
 Nokia is a registered trademark of Nokia Corporation. Nokia's product
 names are trademarks or registered trademarks of Nokia.  Other product
 and company names mentioned herein may be trademarks or trade names of
@@ -311,13 +333,20 @@ Jarkko Hietaniemi
 
 Copyright (c) 2004-2005 Nokia.  All rights reserved.
 
+Copyright (c) 2006-2007 Jarkko Hietaniemi.
+
 =head1 LICENSE
 
 The Symbian port is licensed under the same terms as Perl itself.
 
 =head1 HISTORY
 
-Perl Symbian Port version 0.1.0: April 2005
+=over 4
+
+=item *
+
+0.1.0: April 2005
+
 (This will show as "0.01" in the Symbian Installer.)
 
   - The console window is a very simple console indeed: one can
@@ -331,7 +360,7 @@ Perl Symbian Port version 0.1.0: April 2005
     DynaLoader Exporter File::Spec integer lib strict Symbol
     vars warnings XSLoader
   - The following extensions are available:
-    attrs Cwd Data::Dumper Devel::Peek Digest::MD5 DynaLoader
+    attributes Compress::Zlib Cwd Data::Dumper Devel::Peek Digest::MD5 DynaLoader
     Fcntl File::Glob Filter::Util::Call IO List::Util MIME::Base64
     PerlIO::scalar PerlIO::via SDBM_File Socket Storable Time::HiRes
   - The following extensions are missing for various technical reasons:
@@ -340,13 +369,64 @@ Perl Symbian Port version 0.1.0: April 2005
     re Safe Sys::Hostname Sys::Syslog
     threads threads::shared Unicode::Normalize
   - Using MakeMaker or the Module::* to build and install modules
-    is not supported.  A future solution might use the native
-    SIS packaging format (see symbian\TODO).
+    is not supported.
   - Building XS other than the ones in the core is not supported.
 
-Since this is 0.1.0, any future releases are almost guaranteed to be
-binary incompatible.  As a sign of this the Symbian symbol exports are
-kept unfrozen and the .def files rebuilt every time.
+Since this is 0.something release, any future releases are almost
+guaranteed to be binary incompatible.  As a sign of this the Symbian
+symbol exports are kept unfrozen and the .def files fully rebuilt
+every time.
 
-=cut
+=item *
+
+0.2.0: October 2005
+
+  - Perl 5.9.3 (patch level 25741)
+  - Compress::Zlib and IO::Zlib supported
+  - sisify.pl added
+
+We maintain the binary incompatibility.
+
+=item *
+
+0.3.0: October 2005
+
+  - Perl 5.9.3 (patch level 25911)
+  - Series 80 2.0 and UIQ 2.1 support
 
+We maintain the binary incompatibility.
+
+=item *
+
+0.4.0: November 2005
+
+  - Perl 5.9.3 (patch level 26052)
+  - adding a sample Symbian extension
+
+We maintain the binary incompatibility.
+
+=item *
+
+0.4.1: December 2006
+
+  - Perl 5.9.5-to-be (patch level 30002)
+  - added extensions: Compress/Raw/Zlib, Digest/SHA,
+    Hash/Util, Math/BigInt/FastCalc, Text/Soundex, Time/Piece
+  - port to S90 1.1 by alexander smishlajev
+
+We maintain the binary incompatibility.
+
+=item *
+
+0.4.2: March 2007
+
+  - catchup with Perl 5.9.5-to-be (patch level 30812)
+  - tested to build with Microsoft Visual C++ 2005 Express Edition
+    (which uses Microsoft Visual C 8, instead of the old VC6),
+    SDK used for testing S60_2nd_FP3 aka 8.1a
+
+We maintain the binary incompatibility.
+
+=back
+
+=cut