/usr/share/perl5/pod
NameSizeModeActions
perl.pod166670644editdlrm
perl56delta.pod1072010644editdlrm
perl58delta.pod1151650644editdlrm
perl561delta.pod1247130644editdlrm
perl581delta.pod380600644editdlrm
perl582delta.pod44700644editdlrm
perl583delta.pod63350644editdlrm
perl584delta.pod73630644editdlrm
perl585delta.pod58890644editdlrm
perl586delta.pod46510644editdlrm
perl587delta.pod83570644editdlrm
perl588delta.pod252810644editdlrm
perl589delta.pod539040644editdlrm
perl5004delta.pod562400644editdlrm
perl5005delta.pod342830644editdlrm
perl5100delta.pod555330644editdlrm
perl5101delta.pod438880644editdlrm
perl5120delta.pod892710644editdlrm
perl5121delta.pod101410644editdlrm
perl5122delta.pod96030644editdlrm
perl5123delta.pod41000644editdlrm
perl5124delta.pod36720644editdlrm
perl5125delta.pod76830644editdlrm
perl5140delta.pod1443250644editdlrm
perl5141delta.pod79660644editdlrm
perl5142delta.pod68920644editdlrm
perl5143delta.pod77600644editdlrm
perl5144delta.pod63270644editdlrm
perl5160delta.pod1336510644editdlrm
perl5161delta.pod61420644editdlrm
perl5162delta.pod35940644editdlrm
perl5163delta.pod40850644editdlrm
perl5180delta.pod1194290644editdlrm
perl5181delta.pod65970644editdlrm
perl5182delta.pod53350644editdlrm
perl5184delta.pod46420644editdlrm
perl5200delta.pod1156980644editdlrm
perl5201delta.pod108990644editdlrm
perl5202delta.pod125090644editdlrm
perl5203delta.pod93920644editdlrm
perl5220delta.pod1309630644editdlrm
perl5221delta.pod107670644editdlrm
perl5222delta.pod126290644editdlrm
perl5223delta.pod84560644editdlrm
perl5224delta.pod44600644editdlrm
perl5240delta.pod649230644editdlrm
perl5241delta.pod82150644editdlrm
perl5242delta.pod41130644editdlrm
perl5243delta.pod114280644editdlrm
perl5244delta.pod45100644editdlrm
perl5260delta.pod1018350644editdlrm
perl5261delta.pod79270644editdlrm
perl5262delta.pod78800644editdlrm
perl5263delta.pod70670644editdlrm
perl5280delta.pod721130644editdlrm
perl5281delta.pod46390644editdlrm
perl5282delta.pod62000644editdlrm
perl5283delta.pod51110644editdlrm
perl5300delta.pod412810644editdlrm
perl5301delta.pod57300644editdlrm
perl5302delta.pod46820644editdlrm
perl5303delta.pod49800644editdlrm
perl5320delta.pod546010644editdlrm
perl5321delta.pod70030644editdlrm
perlaix.pod204380644editdlrm
perlamiga.pod57490644editdlrm
perlandroid.pod82220644editdlrm
perlapi.pod4931060644editdlrm
perlapio.pod213360644editdlrm
perlartistic.pod70100644editdlrm
perlbook.pod83860644editdlrm
perlboot.pod2940644editdlrm
perlbot.pod3040644editdlrm
perlbs2000.pod79940644editdlrm
perlcall.pod567380644editdlrm
perlcheat.pod44800644editdlrm
perlclib.pod96070644editdlrm
perlcn.pod47630644editdlrm
perlcommunity.pod69830644editdlrm
perlcygwin.pod272020644editdlrm
perldata.pod497820644editdlrm
perldbmfilter.pod49810644editdlrm
perldebguts.pod423310644editdlrm
perldebtut.pod221520644editdlrm
perldebug.pod393830644editdlrm
perldelta.pod70030644editdlrm
perldeprecation.pod208250644editdlrm
perldiag.pod2969860644editdlrm
perldos.pod105220644editdlrm
perldsc.pod256140644editdlrm
perldtrace.pod79590644editdlrm
perlebcdic.pod843450644editdlrm
perlembed.pod375690644editdlrm
perlexperiment.pod72340644editdlrm
perlfork.pod133550644editdlrm
perlform.pod166080644editdlrm
perlfreebsd.pod16230644editdlrm
perlfunc.pod4037770644editdlrm
perlgit.pod295910644editdlrm
perlgov.pod144810644editdlrm
perlgpl.pod138150644editdlrm
perlguts.pod1621030644editdlrm
perlhack.pod431570644editdlrm
perlhacktips.pod576920644editdlrm
perlhacktut.pod61530644editdlrm
perlhaiku.pod15080644editdlrm
perlhist.pod561640644editdlrm
perlhpux.pod306090644editdlrm
perlhurd.pod19940644editdlrm
perlintern.pod835650644editdlrm
perlinterp.pod337150644editdlrm
perlintro.pod221350644editdlrm
perliol.pod348040644editdlrm
perlipc.pod715290644editdlrm
perlirix.pod44150644editdlrm
perljp.pod84310644editdlrm
perlko.pod122080644editdlrm
perllexwarn.pod3550644editdlrm
perllinux.pod20070644editdlrm
perllocale.pod741120644editdlrm
perllol.pod95800644editdlrm
perlmacos.pod9980644editdlrm
perlmacosx.pod121240644editdlrm
perlmod.pod261970644editdlrm
perlmodinstall.pod102610644editdlrm
perlmodlib.pod763480644editdlrm
perlmodstyle.pod225880644editdlrm
perlmroapi.pod32800644editdlrm
perlnetware.pod66480644editdlrm
perlnewmod.pod110370644editdlrm
perlnumber.pod83530644editdlrm
perlobj.pod357170644editdlrm
perlootut.pod267570644editdlrm
perlop.pod1488880644editdlrm
perlopenbsd.pod12240644editdlrm
perlopentut.pod152230644editdlrm
perlos2.pod933480644editdlrm
perlos390.pod165270644editdlrm
perlos400.pod47650644editdlrm
perlpacktut.pod513700644editdlrm
perlperf.pod498810644editdlrm
perlplan9.pod51250644editdlrm
perlpod.pod230760644editdlrm
perlpodspec.pod686280644editdlrm
perlpolicy.pod265620644editdlrm
perlport.pod886930644editdlrm
perlpragma.pod51760644editdlrm
perlqnx.pod66730644editdlrm
perlre.pod1308170644editdlrm
perlreapi.pod302450644editdlrm
perlrebackslash.pod322850644editdlrm
perlrecharclass.pod497070644editdlrm
perlref.pod354320644editdlrm
perlreftut.pod188260644editdlrm
perlreguts.pod393010644editdlrm
perlrepository.pod5090644editdlrm
perlrequick.pod191410644editdlrm
perlreref.pod155900644editdlrm
perlretut.pod1225270644editdlrm
perlriscos.pod15290644editdlrm
perlrun.pod559800644editdlrm
perlsec.pod276010644editdlrm
perlsecpolicy.pod194500644editdlrm
perlsolaris.pod298430644editdlrm
perlsource.pod71320644editdlrm
perlstyle.pod87340644editdlrm
perlsub.pod744050644editdlrm
perlsymbian.pod153440644editdlrm
perlsyn.pod451380644editdlrm
perlsynology.pod79600644editdlrm
perlthrtut.pod465220644editdlrm
perltie.pod393140644editdlrm
perltoc.pod7018000644editdlrm
perltodo.pod3720644editdlrm
perltooc.pod2940644editdlrm
perltoot.pod2940644editdlrm
perltrap.pod106230644editdlrm
perltru64.pod84920644editdlrm
perltw.pod44630644editdlrm
perlunicode.pod913530644editdlrm
perlunicook.pod256580644editdlrm
perlunifaq.pod136440644editdlrm
perluniintro.pod386470644editdlrm
perluniprops.pod4416140644editdlrm
perlunitut.pod79510644editdlrm
perlutil.pod72910644editdlrm
perlvar.pod825770644editdlrm
perlvms.pod508230644editdlrm
perlvos.pod38430644editdlrm
perlwin32.pod403170644editdlrm
Edit: /usr/share/perl5/pod/perlmodinstall.pod (10261B)
=head1 NAME perlmodinstall - Installing CPAN Modules =head1 DESCRIPTION You can think of a module as the fundamental unit of reusable Perl code; see L for details. Whenever anyone creates a chunk of Perl code that they think will be useful to the world, they register as a Perl developer at L so that they can then upload their code to the CPAN. The CPAN is the Comprehensive Perl Archive Network and can be accessed at L , and searched at L . This documentation is for people who want to download CPAN modules and install them on their own computer. =head2 PREAMBLE First, are you sure that the module isn't already on your system? Try C. (Replace "Foo" with the name of the module; for instance, C.) 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 that it's not in your path, which you can display with C.) For the remainder of this document, we'll assume that you really honestly truly lack an installed module, but have found it on the CPAN. So now you have a file ending in .tar.gz (or, less often, .zip). You know there's a tasty module inside. There are four steps you must now take: =over 5 =item B the file =item B the file into a directory =item B the module (sometimes unnecessary) =item B the module. =back Here's how to perform each step for each operating system. This is 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 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, you can substitute C to install the modules into F. Then you can use the modules from your Perl programs with C or sometimes just C. If you're on a system that requires superuser/root access to install modules into the directories you see when you type C, you'll want to install them into a local directory (such as your home directory) and use this approach. =over 4 =item * B You can use Andreas Koenig's CPAN module ( L ) to automate the following steps, from DECOMPRESS through INSTALL. A. DECOMPRESS Decompress the file with C You can get gzip from L Or, you can combine this step with the next to save disk space: gzip -dc yourmodule.tar.gz | tar -xof - B. UNPACK Unpack the result with C C. BUILD Go into the newly-created directory and type: perl Makefile.PL make test or perl Makefile.PL PREFIX=/my/perl_directory to install it locally. (Remember that if you do this, you'll have to put C near the top of the program that is to use this module. D. INSTALL While still in that directory, type: make install 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 another reason you have a statically-linked perl, B 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 First, type C from a shell and see whether ActiveState's PPM repository has your module. If so, you can install it with C and you won't have to bother with any of the other steps here. You might be able to use the CPAN instructions from the "Unix or Linux" section above as well; give it a try. Otherwise, you'll have to follow the steps below. A. DECOMPRESS You can use the open source 7-zip ( L ) or the shareware Winzip ( L ) to decompress and unpack modules. B. UNPACK If you used WinZip, this was already done for you. C. BUILD You'll need the C utility, available at L or dmake, available on CPAN. L Does the module require compilation (i.e. does it have files that end 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. L Go into the newly-created directory and type: perl Makefile.PL nmake test D. INSTALL While still in that directory, type: nmake install =item * B A. DECOMPRESS djtarx ( L ) will both uncompress and unpack. B. UNPACK See above. C. BUILD Go into the newly-created directory and type: perl Makefile.PL make test You will need the packages mentioned in F in the Perl distribution. D. INSTALL While still in that directory, type: make install You will need the packages mentioned in F in the Perl distribution. =item * B Get the EMX development suite and gzip/tar from Hobbes ( L ), and then follow the instructions for Unix. =item * B When downloading from CPAN, save your file with a C<.tgz> extension instead of C<.tar.gz>. All other periods in the filename should be replaced with underscores. For example, C should be downloaded as C. A. DECOMPRESS Type gzip -d Your-Module.tgz or, for zipped modules, type unzip Your-Module.zip Executables for gzip, zip, and VMStar: http://www.hp.com/go/openvms/freeware/ and their source code: 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 creation of multi-file archives. B. UNPACK If you're using VMStar: VMStar xf Your-Module.tar Or, if you're fond of VMS command syntax: tar/extract/verbose Your_Module.tar C. BUILD Make sure you have MMS (from Digital) or the freeware MMK ( available from MadGoat at L ). Then type this to create the DESCRIP.MMS for the module: perl Makefile.PL Now you're ready to build: mms test Substitute C for C above if you're using MMK. D. INSTALL Type mms install Substitute C for C above if you're using MMK. =item * B, Introduce the F<.tar.gz> file into an HFS as binary; don't translate from ASCII to EBCDIC. A. DECOMPRESS Decompress the file with C You can get gzip from L B. UNPACK 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 L =back =head1 PORTABILITY Note that not all modules will work with on all platforms. See L for more information on portability issues. Read the documentation to see if the module will work on your system. There are basically three categories of modules that will not work "out of the box" with all platforms (with some possibility of overlap): =over 4 =item * B These need to be fixed; consider contacting the author and possibly writing a patch. =item * B (These modules contain F<.xs> or F<.c> files, usually.) You might be able to find existing binaries on the CPAN or elsewhere, or you might want to try getting compilers and building it yourself, and then release the binary for other poor souls to use. =item * B (Such as the Win32:: modules.) If the module is targeted specifically at a platform other than yours, you're out of luck, most likely. =back Check the CPAN Testers if a module should work with your platform but it doesn't behave as you'd expect, or you aren't sure whether or not a module will work under your platform. If the module you want isn't listed there, you can test it yourself and let CPAN Testers know, you can join CPAN Testers, or you can request it be tested. https://cpantesters.org/ =head1 HEY 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, ask someone familiar with Perl on your operating system, or if all else fails, file a ticket at L. =head1 AUTHOR Jon Orwant orwant@medita.mit.edu with invaluable help from Chris Nandor, and valuable help from Brandon Allbery, Charles Bailey, Graham Barr, Dominic Dunlop, Jarkko Hietaniemi, Ben Holzman, Tom Horsley, Nick Ing-Simmons, Tuomas J. Lukka, Laszlo Molnar, Alan Olsen, Peter Prymmer, Gurusamy Sarathy, Christoph Spalinger, Dan Sugalski, Larry Virden, and Ilya Zakharevich. First version July 22, 1998; last revised November 21, 2001. =head1 COPYRIGHT Copyright (C) 1998, 2002, 2003 Jon Orwant. All Rights Reserved. This document may be distributed under the same terms as Perl itself.