Podify README.epoc and README.vos.

p4raw-id: //depot/perl@7429

1 files changed, 92 insertions, 56 deletions

diff --git a/README.epoc b/README.epoc
index 06290c3090..f66df5fb17 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 <o.flebbe@gmx.de>
-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 <stdin_file 2>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 <o.flebbe@gmx.de>
+http://members.linuxstart.com/~oflebbe/perl/perl5.html
+
+=head1 LAST UPDATE
+
+2000-09-18
+
+=cut