This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Remove old code dealing with installing 5.003's perldiag
[perl5.git] / pod / perlmodinstall.pod
index 504c048..0229385 100644 (file)
@@ -10,7 +10,7 @@ Perl code that they think will be useful to the world, they register
 as a Perl developer at http://www.cpan.org/modules/04pause.html
 so that they can then upload their code to the CPAN.  The CPAN is the
 Comprehensive Perl Archive Network and can be accessed at
-http://www.cpan.org/.
+http://www.cpan.org/ , and searched at http://search.cpan.org/ .
 
 This documentation is for people who want to download CPAN modules
 and install them on their own computer.
@@ -19,7 +19,7 @@ and install them on their own computer.
 
 First, are you sure that the module isn't already on your system?  Try
 C<perl -MFoo -e 1>.  (Replace "Foo" with the name of the module; for
-instance, C<perl -MCGI::Carp -e 1>.  
+instance, C<perl -MCGI::Carp -e 1>.
 
 If you don't see an error message, you have the module.  (If you do
 see an error message, it's still possible you have the module, but
@@ -45,7 +45,7 @@ take:
 =back
 
 Here's how to perform each step for each operating system.  This is
-I<not> a substitute for reading the README and INSTALL files that
+<not> a substitute for reading the README and INSTALL files that
 might have come with your module!
 
 Also note that these instructions are tailored for installing the
@@ -59,23 +59,23 @@ sometimes just C<use "/my/perl_directory";>.  If you're on a system
 that requires superuser/root access to install modules into the
 directories you see when you type C<perl -e "print qq(@INC)">, you'll
 want to install them into a local directory (such as your home
-directory) and use this approach.  
+directory) and use this approach.
 
 =over 4
 
 =item *
 
-B<If you're on a Unix or Linux system,>
+B<If you're on a Unix or Unix-like system,>
 
-You can use Andreas Koenig's CPAN module 
-( http://www.cpan.org/modules/by-module/CPAN ) 
+You can use Andreas Koenig's CPAN module
+( http://www.cpan.org/modules/by-module/CPAN )
 to automate the following steps, from DECOMPRESS through INSTALL.
 
-A. DECOMPRESS 
+A. DECOMPRESS
 
 Decompress the file with C<gzip -d yourmodule.tar.gz>
 
-You can get gzip from ftp://prep.ai.mit.edu/pub/gnu
+You can get gzip from ftp://prep.ai.mit.edu/pub/gnu/
 
 Or, you can combine this step with the next to save disk space:
 
@@ -90,10 +90,9 @@ C. BUILD
 Go into the newly-created directory and type:
 
       perl Makefile.PL
-      make
       make test
 
-or 
+or
 
       perl Makefile.PL PREFIX=/my/perl_directory
 
@@ -138,23 +137,34 @@ If you used WinZip, this was already done for you.
 
    C. BUILD
 
+You'll need the C<nmake> utility, available at
+http://download.microsoft.com/download/vc15/Patch/1.52/W95/EN-US/nmake15.exe
+or dmake, available on CPAN.
+http://search.cpan.org/dist/dmake/
+
 Does the module require compilation (i.e. does it have files that end
-in .xs, .c, .h, .y, .cc, .cxx, or .C)?  If it doesn't, go to INSTALL.
-If it does, life is now officially tough for you, because you have to
-compile the module yourself -- no easy feat on Windows.  You'll need
-the C<nmake> utility, available at
-ftp://ftp.microsoft.com/Softlib/MSLFILES/nmake15.exe.
+in .xs, .c, .h, .y, .cc, .cxx, or .C)?  If it does, life is now
+officially tough for you, because you have to compile the module
+yourself -- no easy feat on Windows.  You'll need a compiler such as
+Visual C++.  Alternatively, you can download a pre-built PPM package
+from ActiveState.
+http://aspn.activestate.com/ASPN/Downloads/ActivePerl/PPM/
+
+Go into the newly-created directory and type:
+
+      perl Makefile.PL
+      nmake test
+
 
    D. INSTALL
 
-Copy the module into your Perl's I<lib> directory.  That'll be one
-of the directories you see when you type 
+While still in that directory, type:
 
-   perl -e 'print "@INC"'
+      nmake install
 
 =item *
 
-B<If you're using a Macintosh,>
+B<If you're using a Macintosh with "Classic" MacOS and MacPerl,>
 
 
 A. DECOMPRESS
@@ -169,9 +179,7 @@ After installing cpan-mac, drop the module archive on the
 B<untarzipme> droplet, which will decompress and unpack for you.
 
 B<Or>, you can either use the shareware B<StuffIt Expander> program
-( http://www.aladdinsys.com/expander/ )
-in combination with B<DropStuff with Expander Enhancer>
-( http://www.aladdinsys.com/dropstuff/ )
+( http://my.smithmicro.com/mac/stuffit/ )
 or the freeware B<MacGzip> program (
 http://persephone.cps.unizar.es/general/gente/spd/gzip/gzip.html ).
 
@@ -190,14 +198,6 @@ F<.xs> and F<.c> files, which normally denote that the distribution
 must be compiled, and you cannot install it "out of the box."
 (See L<"PORTABILITY">.)
 
-If a module does not work on MacPerl but should, or needs to be
-compiled, see if the module exists already as a port on the
-MacPerl Module Porters site (http://pudge.net/mmp/).
-For more information on doing XS with MacPerl yourself, see
-Arved Sandstrom's XS tutorial (http://macperl.com/depts/Tutorials/),
-and then consider uploading your binary to the CPAN and
-registering it on the MMP site.
-
 D. INSTALL
 
 If you are using cpan-mac, just drop the folder on the
@@ -241,8 +241,8 @@ B<If you're on the DJGPP port of DOS,>
 
    A. DECOMPRESS
 
-djtarx ( ftp://ftp.simtel.net/pub/simtelnet/gnu/djgpp/v2/ )
-will both uncompress and unpack.  
+djtarx ( ftp://ftp.delorie.com/pub/djgpp/current/v2/ )
+will both uncompress and unpack.
 
    B. UNPACK
 
@@ -253,10 +253,9 @@ See above.
 Go into the newly-created directory and type:
 
       perl Makefile.PL
-      make
       make test
 
-You will need the packages mentioned in C<Readme.dos>
+You will need the packages mentioned in F<README.dos>
 in the Perl distribution.
 
    D. INSTALL
@@ -264,8 +263,8 @@ in the Perl distribution.
 While still in that directory, type:
 
      make install      
-     
-You will need the packages mentioned in Readme.dos in the Perl distribution.
+
+You will need the packages mentioned in F<README.dos> in the Perl distribution.
 
 =item *
 
@@ -287,20 +286,21 @@ C<Your-Module-1_33.tgz>.
 
 A. DECOMPRESS
 
-Type 
+Type
 
     gzip -d Your-Module.tgz
 
-or, for zipped modules, type 
+or, for zipped modules, type
 
     unzip Your-Module.zip
 
-Executables for gzip, zip, and VMStar ( Alphas:
-http://www.openvms.digital.com/cd/000TOOLS/ALPHA/ and Vaxen:
-http://www.openvms.digital.com/cd/000TOOLS/VAX/ ).  
+Executables for gzip, zip, and VMStar:
+
+    http://www.hp.com/go/openvms/freeware/
+
+and their source code:
 
-gzip and tar
-are also available at ftp://ftp.digital.com/pub/VMS.
+    http://www.fsf.org/order/ftp.html
 
 Note that GNU's gzip/gunzip is not the same as Info-ZIP's zip/unzip
 package.  The former is a simple compression tool; the latter permits
@@ -316,23 +316,23 @@ Or, if you're fond of VMS command syntax:
 
      tar/extract/verbose Your_Module.tar
 
-C. BUILD 
+C. BUILD
 
-Make sure you have MMS (from Digital) or the freeware MMK ( available from MadGoat at  http://www.madgoat.com ).  Then type this to create the
-DESCRIP.MMS for the module: 
+Make sure you have MMS (from Digital) or the freeware MMK ( available
+from MadGoat at http://www.madgoat.com ).  Then type this to create
+the DESCRIP.MMS for the module:
 
     perl Makefile.PL
 
 Now you're ready to build:
 
-    mms
     mms test
 
 Substitute C<mmk> for C<mms> above if you're using MMK.
 
 D. INSTALL
 
-Type 
+Type
 
     mms install
 
@@ -342,25 +342,25 @@ Substitute C<mmk> for C<mms> above if you're using MMK.
 
 B<If you're on MVS>,
 
-Introduce the .tar.gz file into an HFS as binary; don't translate from
+Introduce the F<.tar.gz> file into an HFS as binary; don't translate from
 ASCII to EBCDIC.
 
-A. DECOMPRESS 
+A. DECOMPRESS
 
-      Decompress the file with C<gzip -d yourmodule.tar.gz>
+Decompress the file with C<gzip -d yourmodule.tar.gz>
 
-      You can get gzip from 
-      http://www.s390.ibm.com/products/oe/bpxqp1.html.
+You can get gzip from
+http://www.s390.ibm.com/products/oe/bpxqp1.html
 
 B. UNPACK
 
-Unpack the result with 
+Unpack the result with
 
      pax -o to=IBM-1047,from=ISO8859-1 -r < yourmodule.tar
 
 The BUILD and INSTALL steps are identical to those for Unix.  Some
 modules generate Makefiles that work better with GNU make, which is
-available from http://www.mks.com/s390/gnu/index.htm.
+available from http://www.mks.com/s390/gnu/
 
 =back
 
@@ -420,11 +420,9 @@ familiar with Perl on your operating system.
 
 =head1 AUTHOR
 
-Jon Orwant 
-
-orwant@tpj.com
+Jon Orwant
 
-The Perl Journal, http://tpj.com
+orwant@medita.mit.edu
 
 with invaluable help from Chris Nandor, and valuable help from Brandon
 Allbery, Charles Bailey, Graham Barr, Dominic Dunlop, Jarkko
@@ -436,7 +434,7 @@ First version July 22, 1998; last revised November 21, 2001.
 
 =head1 COPYRIGHT
 
-Copyright (C) 1998, 2001 Jon Orwant.  All Rights Reserved.
+Copyright (C) 1998, 2002, 2003 Jon Orwant.  All Rights Reserved.
 
 Permission is granted to make and distribute verbatim copies of this
 documentation provided the copyright notice and this permission notice are