This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Document Indented Here-docs
[perl5.git] / pod / perlmodinstall.pod
index dd0e279..71f6b6c 100644 (file)
@@ -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
@@ -49,11 +49,11 @@ Here's how to perform each step for each operating system.  This is
 might have come with your module!
 
 Also note that these instructions are tailored for installing the
-module into your system's repository of Perl modules -- but you can
+module into your system's repository of Perl modules, but you can
 install modules into any directory you wish.  For instance, where I
 say C<perl Makefile.PL>, you can substitute C<perl Makefile.PL
 PREFIX=/my/perl_directory> to install the modules into
-C</my/perl_directory>.  Then you can use the modules from your Perl
+F</my/perl_directory>.  Then you can use the modules from your Perl
 programs with C<use lib "/my/perl_directory/lib/site_perl";> or
 sometimes just C<use "/my/perl_directory";>.  If you're on a system
 that requires superuser/root access to install modules into the
@@ -65,7 +65,7 @@ directory) and use this approach.
 
 =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 )
@@ -75,7 +75,7 @@ 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,7 +90,6 @@ C. BUILD
 Go into the newly-created directory and type:
 
       perl Makefile.PL
-      make
       make test
 
 or
@@ -111,14 +110,14 @@ Make sure you have the appropriate permissions to install the module
 in your Perl 5 library directory.  Often, you'll need to be root.
 
 That's all you need to do on Unix systems with dynamic linking.
-Most Unix systems have dynamic linking -- if yours doesn't, or if for
+Most Unix systems have dynamic linking. If yours doesn't, or if for
 another reason you have a statically-linked perl, B<and> the
 module requires compilation, you'll need to build a new Perl binary
 that includes the module.  Again, you'll probably need to be root.
 
 =item *
 
-B<If you're running ActivePerl (Win95/98/2K/NT/XP, Linux, Solaris)>
+B<If you're running ActivePerl (Win95/98/2K/NT/XP, Linux, Solaris),>
 
 First, type C<ppm> from a shell and see whether ActiveState's PPM
 repository has your module.  If so, you can install it with C<ppm> and
@@ -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 ).
 
@@ -188,15 +196,7 @@ Read the module's documentation, looking for
 reasons why you might have trouble using it with MacPerl.  Look for
 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.
+(See L</"PORTABILITY">.)
 
 D. INSTALL
 
@@ -241,7 +241,7 @@ B<If you're on the DJGPP port of DOS,>
 
    A. DECOMPRESS
 
-djtarx ( ftp://ftp.simtel.net/pub/simtelnet/gnu/djgpp/v2/ )
+djtarx ( ftp://ftp.delorie.com/pub/djgpp/current/v2/ )
 will both uncompress and unpack.
 
    B. UNPACK
@@ -253,7 +253,6 @@ See above.
 Go into the newly-created directory and type:
 
       perl Makefile.PL
-      make
       make test
 
 You will need the packages mentioned in F<README.dos>
@@ -297,8 +296,7 @@ or, for zipped modules, type
 
 Executables for gzip, zip, and VMStar:
 
-    http://www.openvms.digital.com/freeware/
-    http://www.crinoid.com/utils/
+    http://www.hp.com/go/openvms/freeware/
 
 and their source code:
 
@@ -328,7 +326,6 @@ the DESCRIP.MMS for the module:
 
 Now you're ready to build:
 
-    mms
     mms test
 
 Substitute C<mmk> for C<mms> above if you're using MMK.
@@ -363,7 +360,7 @@ Unpack the result with
 
 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
 
@@ -418,16 +415,14 @@ If you have any suggested changes for this page, let me know.  Please
 don't send me mail asking for help on how to install your modules.
 There are too many modules, and too few Orwants, for me to be able to
 answer or even acknowledge all your questions.  Contact the module
-author instead, or post to comp.lang.perl.modules, or ask someone
-familiar with Perl on your operating system.
+author instead, ask someone familiar with Perl on your operating
+system, or if all else fails, file a ticket at http://rt.cpan.org/.
 
 =head1 AUTHOR
 
 Jon Orwant
 
-orwant@tpj.com
-
-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
@@ -439,21 +434,6 @@ First version July 22, 1998; last revised November 21, 2001.
 
 =head1 COPYRIGHT
 
-Copyright (C) 1998, 2001 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
-preserved on all copies.
-
-Permission is granted to copy and distribute modified versions of this
-documentation under the conditions for verbatim copying, provided also
-that they are marked clearly as modified versions, that the authors'
-names and title are unchanged (though subtitles and additional
-authors' names may be added), and that the entire resulting derived
-work is distributed under the terms of a permission notice identical
-to this one.
-
-Permission is granted to copy and distribute translations of this
-documentation into another language, under the above conditions for
-modified versions.
+Copyright (C) 1998, 2002, 2003 Jon Orwant.  All Rights Reserved.
 
+This document may be distributed under the same terms as Perl itself.