From 9a997319a2cb3566368aef4411c3714ed702d800 Mon Sep 17 00:00:00 2001 From: Jarkko Hietaniemi Date: Tue, 24 Oct 2000 20:03:40 +0000 Subject: [PATCH] Podify README.epoc and README.vos. p4raw-id: //depot/perl@7429 --- README.epoc | 148 ++++++++++++++++++++++++++---------------- README.vos | 192 +++++++++++++++++++++++++++++++++---------------------- pod/buildtoc.PL | 4 ++ pod/perl.pod | 2 + pod/perlport.pod | 12 ++-- pod/perltoc.pod | 89 ++++++++++++++++++++++++-- 6 files changed, 303 insertions(+), 144 deletions(-) diff --git a/README.epoc b/README.epoc index 06290c3..f66df5f 100644 --- a/README.epoc +++ b/README.epoc @@ -1,14 +1,16 @@ -===================================================================== -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 -http://members.linuxstart.com/~oflebbe/perl/perl5.html -2000-09-18 +=head1 NAME + +README.epoc - Perl for EPOC -===================================================================== -Introduction -===================================================================== +=head1 SYNOPSIS + +Perl 5 README file for the EPOC operating system. + +=head1 INTRODUCTION EPOC is a OS for palmtops and mobile phones. For more informations look at: http://www.symbian.com/ @@ -18,9 +20,7 @@ This is a port of perl to EPOC. It runs on the Psion Series 5, 5mx, 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 install and run perl. @@ -40,9 +40,9 @@ 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. -====================================================================== -IO Redirection -====================================================================== +=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 @@ -51,12 +51,10 @@ stdout_file, the errors to stderr_file and input from stdin_file. perl test.pl >stdout_file stderr_file -Alternativly you can use 2>&1 in order to add the standard error +Alternatively you can use 2>&1 in order to add the standard error output to stdout. -====================================================================== -PATH Names -====================================================================== +=head2 PATH Names ESHELL looks for executables in ?:/System/Programs. The SIS file installs perl in this special folder directory. The default drive and @@ -80,68 +78,96 @@ 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). -====================================================================== -Editors -====================================================================== +=head2 Editors A suitable text-editor can be downloaded from symbian http://developer.epocworld.com/downloads/progs/Editor.zip -==================================================================== -Features -==================================================================== +=head2 Features The built-in function EPOC::getcwd returns the current directory. -====================================================================== -Restrictions -====================================================================== +=head2 Restrictions Features are left out, because of restrictions of the POSIX support in EPOC: -+ backquoting, pipes etc. +=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 * -+ system() does not inherit ressources like: file descriptors, - environment etc. +binmode does not exist. (No CR LF to LF translation for text files) -+ signal, kill, alarm. Do not try to use them. This may be - impossible to implement on EPOC. +=item * -+ select is missing. +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. -+ 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. +You need the shell eshell.exe in order to run perl.exe and supply +it with arguments. -+ You need the shell eshell.exe in order to run perl.exe and supply - it with arguments. +=item * -+ Heap is limited to 4MB. +Heap is limited to 4MB. -=================================================================== -Compiling Perl 5 on the EPOC cross compiling envionment. -=================================================================== +=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 C++ SDK from http://developer.epocworld.com/. + +=item * + +You will need to set up the cross SDK from +http://members.linuxstart.com/~oflebbe + +=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 - You will need to set up the cross SDK from - http://members.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... +Build a native perl from this sources... cp epoc/* . ./Configure -S @@ -159,10 +185,20 @@ Sorry, this is far too short. wine G:/bin/makesis perl.pkg perl.sis +=back -==================================================================== -Support Status -==================================================================== +=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 +http://members.linuxstart.com/~oflebbe/perl/perl5.html + +=head1 LAST UPDATE + +2000-09-18 + +=cut diff --git a/README.vos b/README.vos index ccb8739..b44f3cf 100644 --- a/README.vos +++ b/README.vos @@ -1,14 +1,18 @@ -Perl 5 README file for the Stratus VOS operating system. -Paul Green (Paul_Green@stratus.com) -October 24, 2000 +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.vos - Perl for Stratus VOS + +=head1 SYNOPSIS +This is a port of Perl version 5, revision 7, to VOS. Perl is a +scripting or macro language that is popular on many systems. See your +local computer bookstore for a number of good books on Perl. -Introduction ------------- -This is a port of Perl version 5, revision 7, to VOS. Perl -is a scripting or macro language that is popular on many -systems. See your local computer bookstore for a number of good -books on Perl. +=head2 Stratus POSIX Support Note that there are two different implementations of POSIX.1 support on VOS. There is an alpha version of POSIX that is @@ -31,44 +35,57 @@ The workaround is to run the commands outside of perl, then have perl process the output file. These functions are all available in the generally-available version of POSIX. +=head1 INSTALLING PERL IN VOS + +=head2 Compiling Perl 5 on VOS -Compiling Perl 5 on VOS ------------------------ Before you can build Perl 5 on VOS, you need to have or acquire the following additional items. -1. The VOS Standard C Compiler and Runtime, or the VOS Standard C - Cross-Compiler. This is a standard Stratus product. - -2. Either the VOS OS TCP/IP or STCP product set. If you are - building with the alpha version of POSIX you need the OS - TCP/IP product set. If you are building with the - generally-available version of POSIX you need the STCP - product set. These are standard Stratus products. - -3. Either the alpha or generally-available version of the VOS - POSIX.1 environment. - - The alpha version of POSIX.1 support is available on the - Stratus FTP site. Login anonymously to ftp.stratus.com and - get the file /pub/vos/posix/alpha/posix.save.evf.gz in - binary file-transfer mode. Or use the Uniform Resource - Locator (URL) - ftp://ftp.stratus.com/pub/vos/alpha/posix.save.evf.gz from - your web browser. Instructions for unbundling this file - are at ftp://ftp.stratus.com/pub/vos/utility/utility.html. - This is not a standard Stratus product. - - The generally-available version of POSIX.1 support is - bundled with the VOS Standard C compiler and Runtime (or - Cross-Compiler) in VOS Release 14.3.0 or higher. This is a - standard Stratus product. - -4. You must compile this version of Perl 5 on VOS Release - 14.1.0 or higher because some of the perl source files - contain more than 32,767 source lines. Due to VOS - release-compatibility rules, this port of perl may not - execute on VOS Release 12 or earlier. +=over 5 + +=item 1 + +The VOS Standard C Compiler and Runtime, or the VOS Standard C +Cross-Compiler. This is a standard Stratus product. + +=item 2 + +Either the VOS OS TCP/IP or STCP product set. If you are +building with the alpha version of POSIX you need the OS +TCP/IP product set. If you are building with the +generally-available version of POSIX you need the STCP +product set. These are standard Stratus products. + +=item 3 + +Either the alpha or generally-available version of the VOS +POSIX.1 environment. + +The alpha version of POSIX.1 support is available on the +Stratus FTP site. Login anonymously to ftp.stratus.com and +get the file /pub/vos/posix/alpha/posix.save.evf.gz in +binary file-transfer mode. Or use the Uniform Resource +Locator (URL) +ftp://ftp.stratus.com/pub/vos/alpha/posix.save.evf.gz from +your web browser. Instructions for unbundling this file +are at ftp://ftp.stratus.com/pub/vos/utility/utility.html. +This is not a standard Stratus product. + +The generally-available version of POSIX.1 support is +bundled with the VOS Standard C compiler and Runtime (or +Cross-Compiler) in VOS Release 14.3.0 or higher. This is a +standard Stratus product. + +=item 4 + +You must compile this version of Perl 5 on VOS Release +14.1.0 or higher because some of the perl source files +contain more than 32,767 source lines. Due to VOS +release-compatibility rules, this port of perl may not +execute on VOS Release 12 or earlier. + +=back To build perl 5, change to the "vos" subdirectory and type the command "compile_perl -processor X", where X is the processor @@ -85,61 +102,78 @@ execute on the PA7100, PA8000, PA8500 and PA8600 processors, and that code compiled for the pa8000 processor type can execute on the PA8000, PA8500 and PA8600 processors. +=head2 Installing Perl 5 on VOS -Installing Perl 5 on VOS ------------------------- -1. Create the directory >system>ported>command_library. +=over 4 -2. Copy the appropriate version of the perl program module to - this directory. For example, with your current directory - set to the top-level directory of Perl 5, to install the - executable program module for the Motorola 68K - architecture, enter: +=item 1 + +Create the directory >system>ported>command_library. + +=item 2 + +Copy the appropriate version of the perl program module to +this directory. For example, with your current directory +set to the top-level directory of Perl 5, to install the +executable program module for the Motorola 68K +architecture, enter: !copy_file vos>obj>perl.pm >system>ported>command_library>* - (If you wish to use both Perl version 4 and Perl version 5, - you must give them different names; for example, perl.pm - and perl5.pm). +(If you wish to use both Perl version 4 and Perl version 5, +you must give them different names; for example, perl.pm +and perl5.pm). + +=item 3 -3. Create the directory >system>ported>perl>lib. +Create the directory >system>ported>perl>lib. -4. Copy all of the files and subdirectories from the lib - subdirectory into this new directory. For example, with - the current directory set to the top-level directory of the - perl distribution, enter: +=item 4 + +Copy all of the files and subdirectories from the lib +subdirectory into this new directory. For example, with +the current directory set to the top-level directory of the +perl distribution, enter: !copy_dir lib >system>ported>perl>lib>5.7 -5. While there are currently no architecture-specific - extensions or modules distributed with perl, the following - directories can be used to hold such files: +=item 5 + +While there are currently no architecture-specific +extensions or modules distributed with perl, the following +directories can be used to hold such files: >system>ported>perl>lib>5.7.68k >system>ported>perl>lib>5.7.860 >system>ported>perl>lib>5.7.7100 >system>ported>perl>lib>5.7.8000 -6. Site-specific perl extensions and modules can be installed - in one of two places. Put architecture-independent files - into: +=item 6 + +Site-specific perl extensions and modules can be installed in one of +two places. Put architecture-independent files into: >system>ported>perl>lib>site>5.7 - Put architecture-dependent files into one of the following - directories: +Put architecture-dependent files into one of the following +directories: >system>ported>perl>lib>site>5.7.68k >system>ported>perl>lib>site>5.7.860 >system>ported>perl>lib>site>5.7.7100 >system>ported>perl>lib>site>5.7.8000 -7. You can examine the @INC variable from within a perl program - to see the order in which Perl searches these directories. +=item 7 + +You can examine the @INC variable from within a perl program +to see the order in which Perl searches these directories. +=back + +=head1 USING PERL IN VOS + +=head2 Unimplemented Features -Unimplemented Features ----------------------- If perl is built with the alpha version of VOS POSIX.1 support and if it attempts to call an unimplemented VOS POSIX.1 function, it will print a fatal error message and enter the VOS @@ -148,9 +182,8 @@ a list of the unimplemented POSIX.1 functions. To see what functions are unimplemented and what the error message looks like, compile and execute "test_vos_dummies.c". +=head2 Restrictions -Restrictions ------------- This port of Perl version 5 to VOS prefers Unix-style, slash-separated pathnames over VOS-style greater-than-separated pathnames. VOS-style pathnames should work in most contexts, but @@ -167,12 +200,19 @@ supported epoch is January 1, 1980 to January 17, 2038. See the file pod/perlport.pod for more information about the VOS port of Perl. +=head1 SUPPORT STATUS -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. There are some excellent books available on the Perl language; consult a book seller. -(end) +=head1 AUTHOR + +Paul Green (Paul_Green@stratus.com) + +=head1 LAST UPDATE + +October 24, 2000 + +=cut diff --git a/pod/buildtoc.PL b/pod/buildtoc.PL index 3819308..90deff4 100644 --- a/pod/buildtoc.PL +++ b/pod/buildtoc.PL @@ -154,12 +154,14 @@ if (-d "pod") { perlamiga perlcygwin perldos + perlepoc perlhpux perlmachten perlos2 perlos390 perlposix-bc perlvms + perlvos perlwin32 ); @@ -168,12 +170,14 @@ if (-d "pod") { perlamiga perlcygwin perldos + perlepoc perlhpux perlmachten perlos2 perlos390 perlposix-bc perlvms + perlvos perlwin32 ); for (@ARCHPODS) { s/$/.pod/ } diff --git a/pod/perl.pod b/pod/perl.pod index 946d6f2..9f3824d 100644 --- a/pod/perl.pod +++ b/pod/perl.pod @@ -108,12 +108,14 @@ For ease of access, the Perl manual has been split up into several sections: perlamiga Perl notes for Amiga perlcygwin Perl notes for Cygwin perldos Perl notes for DOS + perlepoc Perl notes for EPOC perlhpux Perl notes for HP-UX perlmachten Perl notes for Power MachTen perlos2 Perl notes for OS/2 perlos390 Perl notes for OS/390 perlposix-bc Perl notes for POSIX-BC perlvms Perl notes for VMS + perlvos Perl notes for Stratus VOS perlwin32 Perl notes for Windows (If you're intending to read these straight through for the first time, diff --git a/pod/perlport.pod b/pod/perlport.pod index 0ee6721..d1887bf 100644 --- a/pod/perlport.pod +++ b/pod/perlport.pod @@ -890,9 +890,9 @@ vmsperl on the web, http://www.sidhe.org/vmsperl/index.html =head2 VOS -Perl on VOS is discussed in F in the perl distribution. -Perl on VOS can accept either VOS- or Unix-style file -specifications as in either of the following: +Perl on VOS is discussed in F in the perl distribution +(installed as L). Perl on VOS can accept either VOS- or +Unix-style file specifications as in either of the following: $ perl -ne "print if /perl_setup/i" >system>notices $ perl -ne "print if /perl_setup/i" /system/notices @@ -1994,9 +1994,9 @@ http://www.perl.com/CPAN/ports/index.html for binary distributions. =head1 SEE ALSO -L, L, L, L, L, -L, L, L, L, L, -L, and L. +L, L, L, L, L, +L, L, L, L, L, +L, L, L, and L. =head1 AUTHORS / CONTRIBUTORS diff --git a/pod/perltoc.pod b/pod/perltoc.pod index 4174512..098d2d8 100644 --- a/pod/perltoc.pod +++ b/pod/perltoc.pod @@ -5740,6 +5740,42 @@ DJGPP, Pthreads =back +=head2 perlepoc, README.epoc - Perl for EPOC + +=over + +=item SYNOPSIS + +=item INTRODUCTION + +=item INSTALLING PERL ON EPOC + +=item USING PERL ON EPOC + +=over + +=item IO Redirection + +=item PATH Names + +=item Editors + +=item Features + +=item Restrictions + +=item Compiling Perl 5 on the EPOC cross compiling environment + +=back + +=item SUPPORT STATUS + +=item AUTHOR + +=item LAST UPDATE + +=back + =head2 perlhpux, README.hpux - Perl version 5 on Hewlett-Packard Unix (HP-UX) systems @@ -6190,6 +6226,46 @@ LIST, waitpid PID,FLAGS =back +=head2 perlvos, README.vos - Perl for Stratus VOS + +=over + +=item SYNOPSIS + +=over + +=item Stratus POSIX Support + +=back + +=item INSTALLING PERL IN VOS + +=over + +=item Compiling Perl 5 on VOS + +=item Installing Perl 5 on VOS + +=back + +=item USING PERL IN VOS + +=over + +=item Unimplemented Features + +=item Restrictions + +=back + +=item SUPPORT STATUS + +=item AUTHOR + +=item LAST UPDATE + +=back + =head2 perlwin32 - Perl under Win32 =over @@ -8008,12 +8084,13 @@ C, C, C, C, C, C, C, C, C, C, C, C, C, C, C, C, C, C, C, -C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, -C, C, C, C, C, +C, C, C, +C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, +C, C, C, C, C, C, C, C, C, C, C, C, C, C, C, C, C, C, -- 2.7.4