From: Jarkko Hietaniemi Date: Wed, 23 May 2001 22:43:31 +0000 (+0000) Subject: Tiny pod nits on READMEs, mostly whitespace issues. X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=b5ab506977d1ee50356f33e5eebd52b6102eecb5;p=p5sagit%2Fp5-mst-13.2.git Tiny pod nits on READMEs, mostly whitespace issues. p4raw-id: //depot/perl@10189 --- diff --git a/README.amiga b/README.amiga index 1a7c9d8..f94fe5c 100644 --- a/README.amiga +++ b/README.amiga @@ -18,7 +18,7 @@ be read I: either as F, or F. A recent version of perl for the Amiga can be found at the Geek Gadgets section of the Aminet: - + http://www.aminet.net/~aminet/dirs/dev_gg.html =cut @@ -40,7 +40,7 @@ Contents - GNU info files - LaTeX docs BUILD - - Prerequisites + - Build Prerequisites - Getting the perl source - Application of the patches - Making @@ -180,7 +180,7 @@ can be constructed using C. Here we discuss how to build Perl under AmigaOS. -=head2 Prerequisites +=head2 Build Prerequisites You need to have the latest B (Unix emulation for Amiga) from Aminet. @@ -205,19 +205,14 @@ is normal and expected. (There is a conflict with a similarly-named file F, but it causes no harm.) =head2 Making - - remember to use a hefty wad of stack (I use 2000000) + +Remember to use a hefty wad of stack (I use 2000000) sh configure.gnu --prefix=/gg - the makedepend script has to be edited if it fails - - change $cat to /bin/cat at line 75 - change cat to /bin/cat at line 163 - change cat to /bin/cat at line 176 (both) - change $cat to /bin/cat at line 190 +Now type - now type make depend + make depend Now! diff --git a/README.dos b/README.dos index fe649ed..acdb511 100644 --- a/README.dos +++ b/README.dos @@ -227,7 +227,7 @@ goes under C<($DJDIR)/lib/perl5/pod>. =head1 BUILDING AND INSTALLING MODULES -=head2 Prerequisites +=head2 Building Prerequisites For building and installing non-XS modules, all you need is a working perl under DJGPP. Non-XS modules do not require re-linking the perl diff --git a/README.macos b/README.macos index cc8121b..ea6faf2 100644 --- a/README.macos +++ b/README.macos @@ -6,7 +6,6 @@ designed to be readable as is. README.macos - Perl under Mac OS (Classic) - =head1 SYNOPSIS This document briefly describes perl under Mac OS (Classic). @@ -16,7 +15,6 @@ here (unless you are in the Classic environment under Mac OS X). When we say "Mac OS" below, we mean pre-Mac OS X, which includes Mac OS 7, 8, and 9. - =head1 DESCRIPTION The perl 5.6.1 source itself builds on Mac OS, with some additional diff --git a/README.mpeix b/README.mpeix index 7976db5..0351f3b 100644 --- a/README.mpeix +++ b/README.mpeix @@ -5,13 +5,13 @@ specially designed to be readable as is. =head1 NAME README.mpeix - Perl/iX for HP e3000 MPE - + =head1 SYNOPSIS http://www.bixby.org/mark/perlix.html Perl language for MPE Last updated June 2, 2000 @ 0400 UTC - + =head1 NOTE This is a podified version of the above-mentioned web page, @@ -20,21 +20,21 @@ podified by Jarkko Hietaniemi 2001-Jan-01. =head1 What's New June 1, 2000 - + =over 4 =item * Rebuilt to be compatible with mod_perl. If you plan on using mod_perl, you MUST download and install this version of Perl/iX! - + =item * bincompat5005="undef": sorry, but you will have to recompile any binary 5.005 extensions that you may be using (if any; there is no 5.005 code in what you download from bixby.org) uselargefiles="undef": not available in MPE for POSIX files yet. - + =item * Now bundled with various add-on packages: @@ -48,12 +48,12 @@ libnet (http://www.gbarr.demon.co.uk/libnet/FAQ.html) =item * libwww-perl (LWP) which lets Perl programs behave like web browsers: - + 1. #!/PERL/PUB/perl 2. use LWP::Simple; 3. $doc = get('http://www.bixby.org/mark/perlix.html'); # reads the web page into variable $doc - + (http://www.bixby.org/mark/perlix.html) =item * @@ -62,9 +62,9 @@ mod_perl (just the perl portion; the actual DSO will be released soon with Apache/iX 1.3.12 from bixby.org). This module allows you to write high performance persistent Perl CGI scripts and all sorts of cool things. (http://perl.apache.org/) - + and much much more hiding under /PERL/PUB/.cpan/ - + =item * The CPAN module now works for automatic downloading and @@ -73,7 +73,7 @@ installing of add-on packages: 1. export FTP_PASSIVE=1 2. perl -MCPAN -e shell 3. Ignore any terminal I/O related complaints! - + (http://theoryx5.uwinnipeg.ca/CPAN/data/perl/CPAN.html) =back @@ -92,7 +92,7 @@ Updated to version 5.6.0. Builds straight out of the box on MPE/iX. Perl's getpwnam() function which had regressed to being unimplemented on MPE is now implemented once again. - + =back September 17, 1999 @@ -104,7 +104,7 @@ September 17, 1999 Migrated from cccd.edu to bixby.org. =back - + =head1 Welcome This is the official home page for the HP e3000 MPE/iX @@ -115,22 +115,22 @@ implemented functionality, known bugs, to-do list, etc. Status reports about major milestones will also be posted to the HP3000-L mailing list (http://www.lsoft.com/scripts/wl.exe?SL1=HP3000-L&H=RAVEN.UTC.EDU) and its associated gatewayed newsgroup comp.sys.hp.mpe. - + I'm doing this port because I can't live without Perl on the Unix machines that I administer, and I want to have the same power available to me on MPE. - + Please send your comments, questions, and bug reports directly to me, Mark Bixby (http://www.bixby.org/mark/), by e-mailing to mark@bixby.org. Or just post them to HP3000-L. - + The platform I'm using to do this port is an HP 3000 957RX running MPE/iX 6.0 and using the GNU gcc C compiler (http://jazz.external.hp.com/src/gnu/gnuframe.html). - + The combined porting wisdom from all of my ports can be found in my MPE/iX Porting Guide (http://www.bixby.org/mark/porting.html). - + IMPORTANT NOTICE: Yes, I do work for the HP CSY R&D lab, but ALL of the software you download from bixby.org is my personal freeware that is NOT supported by HP. @@ -192,12 +192,12 @@ Run the installation script =item 5. Convert your *.a system archive libraries to *.sl shared libraries - + =back Download Perl using FTP.ARPA.SYS from your HP 3000 (the preferred method)..... - + :HELLO MANAGER.SYS :XEQ FTP.ARPA.SYS open ftp.bixby.org @@ -210,7 +210,7 @@ method)..... .....Or download using some other generic web or ftp client (the alternate method) - + Download the following files (make sure that you use "binary mode" or whatever client feature that is 8-bit clean): @@ -225,24 +225,24 @@ Perl from or ftp://ftp.bixby.org/pub/mpe/perl-5.6.0-mpe.tar.Z - + =item * Upload those files to your HP 3000 in an 8-bit clean bytestream manner to: /tmp/perl.tar.Z - + =item * Then extract the installation script (after both download methods) - + :CHDIR /tmp :XEQ TAR.HPBIN.SYS 'xvfopz /tmp/perl.tar.Z INSTALL' =item * Edit the installation script - + Examine the accounting structure creation commands and modify if necessary (adding additional capabilities, choosing a non-system volume set, etc). @@ -252,7 +252,7 @@ volume set, etc). =item * Run the installation script. - + The accounting structure will be created and then all files will be extracted from the archive. @@ -261,7 +261,7 @@ extracted from the archive. =item * Convert your *.a system archive libraries to *.sl shared libraries - + You only have to do this ONCE on your MPE/iX 5.5 machine in order to convert /lib/lib*.a and /usr/lib/lib*.a libraries to their *.sl equivalents. This step should not be necessary on MPE/iX 6.0 or later @@ -278,28 +278,28 @@ machines because the 6.0 or later update process does it for you. =item README The file you're reading now. - + =item INSTALL Perl/iX Installation script. - + =item LIBSHP3K Script to convert *.a system archive libraries to *.sl shared libraries. - + =item PERL Perl NMPRG executable. A version-numbered backup copy also exists. You might wish to "ln -s /PERL/PUB/PERL /usr/local/bin/perl". - + =item .cpan/ Much add-on source code downloaded with the CPAN module. - + =item lib/ Perl libraries, both core and add-on. - + =item man/ Perl man page documentation. @@ -307,13 +307,13 @@ Perl man page documentation. =item public_html/feedback.cgi Sample feedback CGI form written in Perl. - + =item src/perl-5.6.0-mpe Source code. =back - + =head1 How to Compile Perl/iX =over 4 @@ -352,7 +352,7 @@ make install Optionally create symbolic links that point to the Perl executable, i.e. ln -s /PERL/PUB/PERL /usr/local/bin/perl - + =back The summary test results from "cd t; ./perl -I../lib harness": @@ -374,7 +374,7 @@ The summary test results from "cd t; ./perl -I../lib harness": Create your Perl script files with "#!/PERL/PUB/perl" (or an equivalent symbolic link) as the first line. Use the chmod command to make sure that your script has execute permission. Run your script! - + Be sure to take a look at the CPAN module list (http://www.cpan.org/CPAN.html). A wide variety of free Perl software is available. You can automatically download these packages by using @@ -435,11 +435,11 @@ calls to setuid() within Perl/iX, so I have not attempted an automatic GETPRIVMODE() solution similar to bind(). =back - + =head1 Known Bugs Under Investigation None. - + =head1 To-Do List =over 4 @@ -460,20 +460,20 @@ Add support for Berkeley DB once I've finished porting Berkeley DB. Write an MPE XS extension library containing miscellaneous important MPE functions like GETPRIVMODE(), GETUSERMODE(), and sfcntl(). - + =back =head1 Change History May 6, 1999 - + =over 4 =item * Patch LBCJXT6A is required on MPE/iX 5.5 machines in order to prevent Perl/iX from dying with an unresolved external reference to _getenv_libc. - + =back April 7, 1999 @@ -498,7 +498,7 @@ characters patch is now MPEKX40B. The LIBSHP3K *.a -> *.sl library conversion script is now included as /PERL/PUB/LIBSHP3K. - + =back November 20, 1998 @@ -527,9 +527,9 @@ All bugfixes will be submitted back to the official Perl developers. The current incarnation of the POSIX filename extended characters patch is now MPEKXJ3A. - + =back - + August 14, 1998 =over 4 @@ -538,9 +538,9 @@ August 14, 1998 The previous POSIX filename extended characters patch MPEKX44C has been superseded by MPEKXB5A. - + =back - + August 7, 1998 =over 4 @@ -549,19 +549,19 @@ August 7, 1998 The previous POSIX filename extended characters patch MPEKX76A has been superseded by MPEKX44C. - -=over 4 =back - + July 28, 1998 +=over 4 + =item * Updated to version 5.005_01. - + =back - + July 23, 1998 =over 4 @@ -570,9 +570,9 @@ July 23, 1998 Updated to version 5.005 (production release). The public freeware sources are now 100% MPE-ready "straight out of the box". - + =back - + July 17, 1998 =over 4 @@ -588,9 +588,9 @@ insure that the final release of 5.005 will be 100% MPE-ready and =item * My MPE binary release is now extracted using my standard INSTALL script. - + =back - + July 15, 1998 =over 4 @@ -599,9 +599,9 @@ July 15, 1998 Changed startperl to #!/PERL/PUB/perl so that Perl will recognize scripts more easily and efficiently. - + =back - + July 8, 1998 =over 4 @@ -614,9 +614,9 @@ MPE-ready. The next public freeware release of Perl should compile was strictly internal to me and never publicly released. Note that [21]BIND/iX is now required (well, the include files and libbind.a) if you wish to compile Perl/iX. - + =back - + November 6, 1997 =over 4 @@ -624,9 +624,9 @@ November 6, 1997 =item * Updated to version 5.004_04. No changes in MPE-specific functionality. - + =back - + October 16, 1997 =over 4 @@ -635,9 +635,9 @@ October 16, 1997 Added Demos section to the Perl/iX home page so you can see some sample Perl applications running on my 3000. - + =back - + October 3, 1997 =over 4 @@ -646,9 +646,9 @@ October 3, 1997 Added System Requirements section to the Perl/iX home page just so the prerequisites stand out more. Various other home page tweaks. - + =back - + October 2, 1997 =over 4 @@ -656,9 +656,9 @@ October 2, 1997 =item * Initial public release. - + =back - + September 1997 =over 4 @@ -668,8 +668,8 @@ September 1997 Porting begins. =back - + =head1 Author - + Mark Bixby, mark@bixby.org diff --git a/README.vmesa b/README.vmesa index 2017484..a67e6bf 100644 --- a/README.vmesa +++ b/README.vmesa @@ -56,13 +56,13 @@ for most things. Some things to watch out for are: this port does support dynamic loading but it's not had much testing =item * - + Don't turn on the compiler optimization flag "-O". There's a bug in the compiler (APAR PQ18812) that generates some bad code the optimizer is on. =item * - + As VM/ESA doesn't fully support the fork() API programs relying on this call will not work. I've replaced fork()/exec() with spawn() and the standalone exec() with spawn(). This has a side effect when @@ -90,7 +90,7 @@ your results may differ: [the list of failures being compiled] =head2 Usage Hints - + When using perl on VM/ESA please keep in mind that the EBCDIC and ASCII character sets are different. Perl builtin functions that may behave differently under EBCDIC are mentioned in the perlport.pod document. diff --git a/README.win32 b/README.win32 index 195170d..49d2d62 100644 --- a/README.win32 +++ b/README.win32 @@ -646,7 +646,7 @@ as the virus checker interacts badly with miniperl.exe writing configure files (it seems to either catch file part written and treat it as suspicious, or virus checker may have it "locked" in a way which inhibits miniperl updating it). The build does complete with - + set PERLIO=perlio but that may be just luck. Other AntiVirus software may have similar issues.