X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/39e571d41067215a80f26089b260f1418caeb36b..3b071feee62d0713bd7e9f33098c084e3ee4fdeb:/README.dos diff --git a/README.dos b/README.dos index 3d1b33c..ef3578f 100644 --- a/README.dos +++ b/README.dos @@ -1,164 +1,331 @@ -This is a DOS/DJGPP port of Perl 5.004_5x +If you read this file _as_is_, just ignore the funny characters you +see. It is written in the POD format (see perlpod manpage) which is +specially designed to be readable as is. -1. Installation - ------------ +=head1 NAME - - Unzip the binary package perl54b.zip preserving the directory - structure (-d switch to PKUNZIP) from the top DJGPP directory. - If you want to use perl with long file names (win0.95), then use a LFN - aware unzip and add +perldos - Perl under DOS, W31, W95. - set LFN=y +=head1 SYNOPSIS - to your autoexec.bat or DJGPP.ENV. +These are instructions for building Perl under DOS (or w??), using +DJGPP v2.03 or later. Under w95 long filenames are supported. - - Edit lib/perl5/Config.pm, and replace every 'c:/djgpp' with your - DJGPP root directory. This can be done with perl too: - - perl -i~ -pe "s!c:/djgpp!x:/djroot!i;" lib/perl5/Config.pm - ^^^^^^^^^ - Substitute this with your DJGPP root directory! +=head1 DESCRIPTION - - This version of perl searches its library files in '../lib/perl5/', - which is relative to the path of perl.exe. If you don't like this, - you can use the PERL5LIB environment variable to tell perl where - the library is. E.g: - - set PERL5LIB=c:/perl/lib - - Warning: if you set PERL5LIB and use tainting checks (-T command line - option), perl ignores PERL5LIB, so you must use the -I command line - switch or the "use lib '...'" construct. Or you can patch perl.exe :) +Before you start, you should glance through the README file +found in the top-level directory where the Perl distribution +was extracted. Make sure you read and understand the terms under +which this software is being distributed. - - Perl works best with a unixy shell, so you may want to download and - install bash (bshXXXXb.zip from the usual DJGPP sites). After installing - it make the 'SHELL' environment variable point to your bash.exe. - Finally create a `link' to your bash.exe in your %DJDIR%/bin directory: +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. - ln -s bash.exe sh.exe - or - stubify -g sh.exe - stubedit sh.exe runfile=bash +Detailed instructions on how to build and install perl extension +modules, including XS-type modules, is included. See 'BUILDING AND +INSTALLING MODULES'. - - The documentation is in lib/perl5/pod. You can read the .pod files - with any editor, or you can use the `perldoc' utility. For more info: +=head2 Prerequisites for Compiling Perl on DOS - perl -S perldoc -h +=over 4 - It tries to use less.exe or more.com, but you can set your pager with: - - SET PAGER=path_of_your_favourite_pager +=item DJGPP -2. Building Perl - ------------- +DJGPP is a port of GNU C/C++ compiler and development tools to 32-bit, +protected-mode environment on Intel 32-bit CPUs running MS-DOS and compatible +operating systems, by DJ Delorie and friends. - - In addition to the standard DJGPP tools, you will need sed, gawk, grep, - sh-utils, textutils, fileutils, bash, diffutils, make and findutils. :-) - You can find them on the usual DJGPP sites. If you want to build perl - under win0.95, then you MUST use fileutils 3.16+ (3.13 doesn't work). +For more details (FAQ), check out the home of DJGPP at: - - Unzip the source package perl54s.zip preserving the directory - structure (-d switch to PKUNZIP) from the top DJGPP directory. - Under plain DOS, use the -o switch too when unzipping. - This creates the directory gnu/perl5004. + http://www.delorie.com/djgpp/ - - Create a symlink or copy your bash.exe to sh.exe in your DJGPP/bin - directory. +If you have questions about DJGPP, try posting to the DJGPP newsgroup: +comp.os.msdos.djgpp, or use the email gateway djgpp@delorie.com. - ln -s bash.exe sh.exe +You can find the full DJGPP distribution on any of the mirrors listed here: - And make the 'SHELL' environment variable point to this sh.exe: + http://www.delorie.com/djgpp/getting.html - set SHELL=c:/djgpp/bin/sh.exe (use full path name!) +You need the following files to build perl (or add new modules): - You can do this in djgpp.env too. Add this line BEFORE any section - definition: + 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 - +SHELL=%DJDIR%/bin/sh.exe +or possibly any newer version. - - If you have split.exe and gsplit.exe in your path, then rename split.exe - to djsplit.exe, and gsplit.exe to split.exe. +=item Pthreads - - Copy or link gecho.exe to echo.exe if you don't have echo.exe. +Thread support is not tested in this version of the djgpp perl. - - Copy or link gawk.exe to awk.exe if you don't have awk.exe. +=back - - Chdir to the gnu/perl5004/djgpp directory and type the following - command: +=head2 Shortcomings of Perl under DOS - configure.bat +Perl under DOS lacks some features of perl under UNIX because of +deficiencies in the UNIX-emulation, most notably: - This will do some preprocessing then run the Configure script. +=over 4 - The Configure script is interactive, but in most of the cases you - just need to press ENTER. +=item * - If the script says that your package is incomplete, and ask whether - to continue, just answer with Y (this can only happen if you don't use - long filenames). +fork() and pipe() - When Configure asks about the extensions, I suggest IO and Fcntl, - and if you want database handling then SDBM_File or GDBM_File - (you need to install gdbm for this one). If you want to use the - POSIX extension (this is the default), make sure that the stack - size of your cc1.exe is at least 512kbyte (you can check this - with: stubedit cc1.exe). - - You can use the Configure script in non-interactive mode too. - When I've built my perl.exe, I used this: +=item * - configure.bat -Uuseposix -dEs +some features of the UNIX filesystem regarding link count and file dates - then edited config.sh (set hostname & domainname), then +=item * - sh Configure -S +in-place operation is a little bit broken with short filenames - You can find more info about Configure's command line switches in - the `INSTALL' file. +=item * - - When the script ends, and you want to change some values in the - generated config.sh file, then run +sockets - sh Configure -S +=back - after you made your modifications. +=head2 Building Perl on DOS - IMPORTANT: if you use this -S switch, be sure to delete the CONFIG - environment variable before running the script: +=over 4 - set CONFIG= +=item * - - Now you can compile Perl. Type: +Unpack the source package F 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 - make + set LFN=y + set FNCASE=y - - Run the tests: +before unpacking the archive. - make test +=item * - You should see "All tests successful" if you configured a database - manager, and 1 failed test script if not (lib/anydbm.t). If you - configured POSIX you will see 4 failed subtests in lib/posix.t. +Create a "symlink" or copy your bash.exe to sh.exe in your C<($DJDIR)/bin> +directory. - - If you want the documentation in HTML format, then read INSTALL in - the main perl5004 source directory. + ln -s bash.exe sh.exe - WARNING: if you want to use absolute path names with `installhtml', - use something like this: +[If you have the recommended version of bash for DJGPP, this is already +done for you.] - --htmldir=f:/html - --htmlroot='/f|/html' # "|" instead of ":" !!! +And make the C environment variable point to this F: - or NETSCAPE does strange things. + set SHELL=c:/djgpp/bin/sh.exe (use full path name!) - - If you don't want to use the modules, then you are ready: copy perl.exe - into your bin directory. +You can do this in F too. Add this line BEFORE any section +definition: - - Else install the files with: + +SHELL=%DJDIR%/bin/sh.exe - make install +=item * - Enjoy. +If you have F and F in your path, then rename +F to F, and F to F. +Copy or link F to F if you don't have F. +Copy or link F to F if you don't have F. - Laszlo Molnar +[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 +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 "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 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 +(you need to install gdbm for this one). If you want to use the +POSIX extension (this is the default), make sure that the stack +size of your F is at least 512kbyte (you can check this +with: C). + +You can use the Configure script in non-interactive mode too. +When I built my F, I used something like this: + + configure.bat -des + +You can find more info about Configure's command line switches in +the F file. + +When the script ends, and you want to change some values in the +generated F file, then run + + sh Configure -S + +after you made your modifications. + +IMPORTANT: if you use this C<-S> switch, be sure to delete the CONFIG +environment variable before running the script: + + set CONFIG= + +=item * + +Now you can compile Perl. Type: + + make + +=back + +=head2 Testing Perl on DOS + +Type: + + make test + +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 of Perl on DOS + +Type: + + make install + +This will copy the newly compiled perl and libraries into your DJGPP +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>. + +=head1 BUILDING AND INSTALLING MODULES ON DOS + +=head2 Building Prerequisites for Perl on DOS + +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. + +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. + +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. + +=head2 Unpacking CPAN Modules on DOS + +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. + +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. + +From the command line, you can use the djtar utility provided with DJGPP +to unpack and expand these files. For example: + + C:\djgpp>djtarx -v Text-CSV-0.01.tar.gz + +This will create the new directory C<($DJDIR)/Text-CSV-0.01>, filling +it with the source for this module. + +=head2 Building Non-XS Modules on DOS + +To build a non-XS module, you can use the standard module-building +instructions distributed with perl modules. + + perl Makefile.PL + make + make test + make install + +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. + +=head2 Building XS Modules on DOS + +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. + + set FNCASE=y + perl Makefile.PL + make + make perl + make test + make -f Makefile.aperl inst_perl MAP_TARGET=perl.exe + make install + +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. + +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>. + +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 [Installing/building perl] + +Peter J. Farley III F [Building/installing modules] + +=head1 SEE ALSO + +perl(1). + +=cut