This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[DOC PATCH] Sort subs *can* now be recursive
[perl5.git] / README.dos
index 95ab911..e1d6d33 100644 (file)
@@ -5,11 +5,11 @@ specially designed to be readable as is.
 =head1 NAME
 
 perldos - Perl under DOS, W31, W95.
-                                 
+
 =head1 SYNOPSIS
 
 These are instructions for building Perl under DOS (or w??), using
-DJGPP v2.01 or later. Under w95 long filenames are supported.
+DJGPP v2.03 or later.  Under w95 long filenames are supported.
 
 =head1 DESCRIPTION
 
@@ -22,7 +22,11 @@ This port currently supports MakeMaker (the set of modules that
 is used to build extensions to perl).  Therefore, you should be
 able to build and install most extensions found in the CPAN sites.
 
-=head2 Prerequisites
+Detailed instructions on how to build and install perl extension
+modules, including XS-type modules, is included.  See 'BUILDING AND
+INSTALLING MODULES'.
+
+=head2 Prerequisites for Compiling Perl on DOS
 
 =over 4
 
@@ -46,31 +50,25 @@ the world. Like:
 
 You need the following files to build perl (or add new modules):
 
-        v2/djdev201.zip
-        v2/bnu27b.zip
-        v2gnu/gcc2721b.zip
-        v2gnu/bsh1147b.zip
-        v2gnu/mak3761b.zip
-        v2gnu/fil316b.zip
-        v2gnu/sed118b.zip
-        v2gnu/txt122b.zip
-        v2gnu/dif271b.zip
-        v2gnu/grep21b.zip
-        v2gnu/shl112b.zip
-        v2gnu/gawk303b.zip
-        v2misc/csdpmi4b.zip 
-
-or any newer version.
+        v2/djdev203.zip
+        v2gnu/bnu2112b.zip
+        v2gnu/gcc2953b.zip
+        v2gnu/bsh204b.zip
+        v2gnu/mak3791b.zip
+        v2gnu/fil40b.zip
+        v2gnu/sed3028b.zip
+        v2gnu/txt20b.zip
+        v2gnu/dif272b.zip
+        v2gnu/grep24b.zip
+        v2gnu/shl20jb.zip
+        v2gnu/gwk306b.zip
+        v2misc/csdpmi5b.zip
+
+or possibly any newer version.
 
 =item Pthreads
 
-If you want multithreading support in perl, you need a pthread library
-that supports DJGPP. One of them can be found at:
-
-        ftp://ftp.cs.fsu.edu/pub/PART/PTHREADS/pthreads.zip
-
-But thread support is still in alpha, it may be unstable. For more information
-see below.
+Thread support is not tested in this version of the djgpp perl.
 
 =back
 
@@ -99,17 +97,19 @@ sockets
 
 =back
 
-=head2 Building
+=head2 Building Perl on DOS
 
 =over 4
 
 =item *
 
-Unpack the source package F<perl5.00?_??.tar.gz> with djtarx. If you want
-to use long file names under w95, don't forget to use
+Unpack the source package F<perl5.8*.tar.gz> with djtarx. If you want
+to use long file names under w95 and also to get Perl to pass all its
+tests, don't forget to use
 
         set LFN=y
-        
+        set FNCASE=y
+
 before unpacking the archive.
 
 =item *
@@ -119,6 +119,9 @@ directory.
 
         ln -s bash.exe sh.exe
 
+[If you have the recommended version of bash for DJGPP, this is already
+done for you.]
+
 And make the C<SHELL> environment variable point to this F<sh.exe>:
 
         set SHELL=c:/djgpp/bin/sh.exe (use full path name!)
@@ -135,20 +138,34 @@ F<split.exe> to F<djsplit.exe>, and F<gsplit.exe> to F<split.exe>.
 Copy or link F<gecho.exe> to F<echo.exe> if you don't have F<echo.exe>.
 Copy or link F<gawk.exe> to F<awk.exe> if you don't have F<awk.exe>.
 
+[If you have the recommended versions of djdev, shell utilities and
+gawk, all these are already done for you, and you will not need to do
+anything.]
+
 =item *
 
 Chdir to the djgpp subdirectory of perl toplevel and type the following
-command:
+commands:
 
+        set FNCASE=y
         configure.bat
 
 This will do some preprocessing then run the Configure script for you.
-The Configure script is interactive, but in most cases you
-just need to press ENTER.
+The Configure script is interactive, but in most cases you just need to
+press ENTER.  The "set" command ensures that DJGPP preserves the letter
+case of file names when reading directories.  If you already issued this
+set command when unpacking the archive, and you are in the same DOS
+session as when you unpacked the archive, you don't have to issue the
+set command again.  This command is necessary *before* you start to 
+(re)configure or (re)build perl in order to ensure both that perl builds 
+correctly and that building XS-type modules can succeed.  See the DJGPP 
+info entry for "_preserve_fncase" for more information:
+
+        info libc alphabetical _preserve_fncase
 
 If the script says that your package is incomplete, and asks whether
 to continue, just answer with Y (this can only happen if you don't use
-long filenames).
+long filenames or forget to issue "set FNCASE=y" first).
 
 When Configure asks about the extensions, I suggest IO and Fcntl,
 and if you want database handling then SDBM_File or GDBM_File
@@ -160,7 +177,7 @@ with: C<stubedit cc1.exe>).
 You can use the Configure script in non-interactive mode too.
 When I built my F<perl.exe>, I used something like this:
 
-        configure.bat -Uuseposix -des
+        configure.bat -des
 
 You can find more info about Configure's command line switches in
 the F<INSTALL> file.
@@ -185,17 +202,18 @@ Now you can compile Perl. Type:
 
 =back
 
-=head2 Testing
+=head2 Testing Perl on DOS
 
 Type:
 
         make test
 
-You should see "All tests successful" if you configured a database
-manager, and 1 failed test script if not (F<lib/anydbm.t>). If you
-configured POSIX you will see 1 additional failed subtest in F<lib/posix.t>.
+If you're lucky you should see "All tests successful". But there can be
+a few failed subtests (less than 5 hopefully) depending on some external
+conditions (e.g. some subtests fail under linux/dosemu or plain dos
+with short filenames only).
 
-=head2 Installation
+=head2 Installation of Perl on DOS
 
 Type:
 
@@ -206,67 +224,105 @@ directory structure. Perl.exe and the utilities go into C<($DJDIR)/bin>,
 and the library goes under C<($DJDIR)/lib/perl5>. The pod documentation
 goes under C<($DJDIR)/lib/perl5/pod>.
 
-=head2 Threaded perl under dos-djgpp
+=head1 BUILDING AND INSTALLING MODULES ON DOS
 
-Multithreading support is considered alpha, because some of the
-tests in C<ext/Thread> still die with SIGSEGV (patches are welcome). But
-if you want to give it a try, here are the necessary steps:
+=head2 Building Prerequisites for Perl on DOS
 
-=over 4
+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
+binary, and so are simpler to build and install.
 
-=item
+XS-type modules do require re-linking the perl binary, because part of
+an XS module is written in "C", and has to be linked together with the
+perl binary to be executed.  This is required because perl under DJGPP
+is built with the "static link" option, due to the lack of "dynamic
+linking" in the DJGPP environment.
 
-1. You will need a pthread library which supports djgpp. Go, and download
-FSU's version from:
+Because XS modules require re-linking of the perl binary, you need both
+the perl binary distribution and the perl source distribution to build
+an XS extension module.  In addition, you will have to have built your
+perl binary from the source distribution so that all of the components
+of the perl binary are available for the required link step.
 
-      ftp://ftp.cs.fsu.edu/pub/PART/PTHREADS/pthreads.zip
+=head2 Unpacking CPAN Modules on DOS
 
-The latest version is 3.5, released in Feb 98.
+First, download the module package from CPAN (e.g., the "Comma Separated
+Value" text package, Text-CSV-0.01.tar.gz).  Then expand the contents of
+the package into some location on your disk.  Most CPAN modules are
+built with an internal directory structure, so it is usually safe to
+expand it in the root of your DJGPP installation.  Some people prefer to
+locate source trees under /usr/src (i.e., C<($DJDIR)/usr/src>), but you may
+put it wherever seems most logical to you, *EXCEPT* under the same
+directory as your perl source code.  There are special rules that apply
+to modules which live in the perl source tree that do not apply to most
+of the modules in CPAN.
 
-=item 
+Unlike other DJGPP packages, which are normal "zip" files, most CPAN
+module packages are "gzipped tarballs".  Recent versions of WinZip will
+safely unpack and expand them, *UNLESS* they have zero-length files.  It
+is a known WinZip bug (as of v7.0) that it will not extract zero-length
+files.
 
-2. Unzip the file, cd to C<threads\src> and run F<configur.bat>.
+From the command line, you can use the djtar utility provided with DJGPP
+to unpack and expand these files.  For example:
 
-=item 
+        C:\djgpp>djtarx -v Text-CSV-0.01.tar.gz
 
-3. Add C<RAND_SWITCH> or C<MUTEX_SWITCH> or C<RR_SWITCH> to C<CFLAGS>
-in the F<makefile>. Note that using these values, multithreading will
-NOT be preemptive. This is necessary, since djgpp's libc is not thread safe.
+This will create the new directory C<($DJDIR)/Text-CSV-0.01>, filling
+it with the source for this module.
 
-=item 
+=head2 Building Non-XS Modules on DOS
 
-4. Apply the following patch:
+To build a non-XS module, you can use the standard module-building
+instructions distributed with perl modules.
 
-    *** include/pthread/signal.h~      Wed Feb  4 10:51:24 1998
-    --- include/pthread/signal.h       Tue Feb 10 22:40:32 1998
-    ***************
-    *** 364,368 ****
-    --- 364,370 ----
-      
-      #ifndef SA_ONSTACK
-    + #ifdef  SV_ONSTACK
-      #define SA_ONSTACK SV_ONSTACK
-    + #endif
-      #endif /* !SA_ONSTACK */
+    perl Makefile.PL
+    make
+    make test
+    make install
 
-=item
+This is sufficient because non-XS modules install only ".pm" files and
+(sometimes) pod and/or man documentation.  No re-linking of the perl
+binary is needed to build, install or use non-XS modules.
 
-5. run make (before you do this, you must make sure your C<SHELL> environment 
-variable does NOT point to bash).
+=head2 Building XS Modules on DOS
 
-=item
+To build an XS module, you must use the standard module-building
+instructions distributed with perl modules *PLUS* three extra
+instructions specific to the DJGPP "static link" build environment.
 
-6. Install the library and header files into your djgpp directory structure.
+    set FNCASE=y
+    perl Makefile.PL
+    make
+    make perl
+    make test
+    make -f Makefile.aperl inst_perl MAP_TARGET=perl.exe
+    make install
 
-=item
+The first extra instruction sets DJGPP's FNCASE environment variable so
+that the new perl binary which you must build for an XS-type module will
+build correctly.  The second extra instruction re-builds the perl binary
+in your module directory before you run "make test", so that you are
+testing with the new module code you built with "make".  The third extra
+instruction installs the perl binary from your module directory into the
+standard DJGPP binary directory, C<($DJDIR)/bin>, replacing your
+previous perl binary.
 
-7. Add C<-Dusethreads> to the commmand line of perl's F<configure.bat>.
+Note that the MAP_TARGET value *must* have the ".exe" extension or you
+will not create a "perl.exe" to replace the one in C<($DJDIR)/bin>.
 
-=back
+When you are done, the XS-module install process will have added information
+to your "perllocal" information telling that the perl binary has been replaced,
+and what module was installed.  You can view this information at any time
+by using the command:
+
+        perl -S perldoc perllocal
 
 =head1 AUTHOR
 
-Laszlo Molnar, F<laszlo.molnar@eth.ericsson.se>
+Laszlo Molnar, F<laszlo.molnar@eth.ericsson.se> [Installing/building perl]
+
+Peter J. Farley III F<pjfarley@banet.net> [Building/installing modules]
 
 =head1 SEE ALSO