home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _c1b8256ad4f7580f20a0e25a2b708495 < prev    next >
Text File  |  2000-03-23  |  17KB  |  378 lines
  1. <HTML>
  2. <HEAD>
  3. <TITLE>perlmodinstall - Installing CPAN Modules</TITLE>
  4. <LINK REL="stylesheet" HREF="../../Active.css" TYPE="text/css">
  5. <LINK REV="made" HREF="mailto:">
  6. </HEAD>
  7.  
  8. <BODY>
  9. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  10. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  11. <STRONG><P CLASS=block> perlmodinstall - Installing CPAN Modules</P></STRONG>
  12. </TD></TR>
  13. </TABLE>
  14.  
  15. <A NAME="__index__"></A>
  16. <!-- INDEX BEGIN -->
  17.  
  18. <UL>
  19.  
  20.     <LI><A HREF="#name">NAME</A></LI>
  21.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  22.     <UL>
  23.  
  24.         <LI><A HREF="#preamble">PREAMBLE</A></LI>
  25.     </UL>
  26.  
  27.     <LI><A HREF="#hey">HEY</A></LI>
  28.     <LI><A HREF="#author">AUTHOR</A></LI>
  29.     <LI><A HREF="#copyright">COPYRIGHT</A></LI>
  30. </UL>
  31. <!-- INDEX END -->
  32.  
  33. <HR>
  34. <P>
  35. <H1><A NAME="name">NAME</A></H1>
  36. <P>perlmodinstall - Installing CPAN Modules</P>
  37. <P>
  38. <HR>
  39. <H1><A NAME="description">DESCRIPTION</A></H1>
  40. <P>You can think of a module as the fundamental unit of reusable Perl
  41. code; See <A HREF="../../lib/Pod/perlmod.html">the perlmod manpage</A> for details.  Whenever anyone creates a chunk
  42. of Perl code that they think will be useful to the world, they
  43. register as a Perl developer at
  44. <A HREF="http://www.perl.com/CPAN/modules/04pause.html">http://www.perl.com/CPAN/modules/04pause.html</A> so that they can then
  45. upload their code to CPAN.  CPAN is the Comprehensive Perl Archive
  46. Network and can be accessed at <A HREF="http://www.perl.com/CPAN/,">http://www.perl.com/CPAN/,</A> or searched
  47. via <A HREF="http://cpan.perl.com/">http://cpan.perl.com/</A> and
  48. <A HREF="http://theory.uwinnipeg.ca/mod_perl/cpan-search.pl">http://theory.uwinnipeg.ca/mod_perl/cpan-search.pl</A> .</P>
  49. <P>This documentation is for people who want to download CPAN modules
  50. and install them on their own computer.</P>
  51. <P>
  52. <H2><A NAME="preamble">PREAMBLE</A></H2>
  53. <P>You have a file ending in <EM>.tar.gz</EM> (or, less often, <EM>.zip</EM>).
  54. You know there's a tasty module inside.  You must now take four
  55. steps:</P>
  56. <DL>
  57. <DT><STRONG><A NAME="item_DECOMPRESS_the_file"><STRONG>DECOMPRESS</STRONG> the file</A></STRONG><BR>
  58. <DD>
  59. <DT><STRONG><A NAME="item_UNPACK_the_file_into_a_directory"><STRONG>UNPACK</STRONG> the file into a directory</A></STRONG><BR>
  60. <DD>
  61. <DT><STRONG><A NAME="item_module"><STRONG>BUILD</STRONG> the module (sometimes unnecessary)</A></STRONG><BR>
  62. <DD>
  63. <DT><STRONG><A NAME="item_INSTALL_the_module%2E"><STRONG>INSTALL</STRONG> the module.</A></STRONG><BR>
  64. <DD>
  65. </DL>
  66. <P>Here's how to perform each step for each operating system.  This is
  67. <EM>not</EM> a substitute for reading the README and INSTALL files that
  68. might have come with your module!</P>
  69. <P>Also note that these instructions are tailored for installing the
  70. module into your system's repository of Perl modules.  But you can
  71. install modules into any directory you wish.  For instance, where I
  72. say <CODE>perl Makefile.PL</CODE>, you can substitute <CODE>perl
  73. Makefile.PL PREFIX=/my/perl_directory</CODE> to install the modules
  74. into <CODE>/my/perl_directory</CODE>.  Then you can use the modules
  75. from your Perl programs with <CODE>use lib
  76. "/my/perl_directory/lib/site_perl"</CODE> or sometimes just <CODE>use
  77. "/my/perl_directory"</CODE>.</P>
  78. <UL>
  79. <LI>
  80. <STRONG>If you're on Unix,</STRONG>
  81. <P>You can use Andreas Koenig's CPAN module 
  82. (which comes standard with Perl, or can itself be downloaded
  83. from <A HREF="http://www.perl.com/CPAN/modules/by-module/CPAN)">http://www.perl.com/CPAN/modules/by-module/CPAN)</A> 
  84. to automate the following steps, from DECOMPRESS through INSTALL.</P>
  85. <P>A. DECOMPRESS</P>
  86. <P>Decompress the file with <CODE>gzip -d yourmodule.tar.gz</CODE></P>
  87. <P>You can get gzip from <A HREF="ftp://prep.ai.mit.edu/pub/gnu.">ftp://prep.ai.mit.edu/pub/gnu.</A></P>
  88. <P>Or, you can combine this step with the next to save disk space:</P>
  89. <PRE>
  90.      gzip -dc yourmodule.tar.gz | tar -xof -</PRE>
  91. <P>B. UNPACK</P>
  92. <P>Unpack the result with <CODE>tar -xof yourmodule.tar</CODE></P>
  93. <P>C. BUILD</P>
  94. <P>Go into the newly-created directory and type:</P>
  95. <PRE>
  96.       perl Makefile.PL
  97.       make
  98.       make test</PRE>
  99. <P>D. INSTALL</P>
  100. <P>While still in that directory, type:</P>
  101. <PRE>
  102.       make install</PRE>
  103. <P>Make sure you have appropriate permissions to install the module
  104. in your Perl 5 library directory.  Often, you'll need to be root.</P>
  105. <P>Perl maintains a record of all module installations.  To look at
  106. this list, simply type:</P>
  107. <PRE>
  108.       perldoc <A HREF="../../lib/perllocal.html">perllocal</A></PRE>
  109. <P>That's all you need to do on Unix systems with dynamic linking.
  110. Most Unix systems have dynamic linking--if yours doesn't, or if for
  111. another reason you have a statically-linked perl, <EM>and</EM> the
  112. module requires compilation, you'll need to build a new Perl binary
  113. that includes the module.  Again, you'll probably need to be root.</P>
  114. <P></P>
  115. <LI>
  116. <STRONG>If you're running Windows 95 or NT with the ActiveState port of Perl</STRONG>
  117. <PRE>
  118.    A. DECOMPRESS</PRE>
  119. <P>You can use the shareware <STRONG>Winzip</STRONG> program ( <A HREF="http://www.winzip.com">http://www.winzip.com</A> ) to
  120. decompress and unpack modules.</P>
  121. <PRE>
  122.    B. UNPACK</PRE>
  123. <P>If you used WinZip, this was already done for you.</P>
  124. <PRE>
  125.    C. BUILD</PRE>
  126. <P>Does the module require compilation (i.e. does it have files
  127. that end in .xs, .c, .h, .y, .cc, .cxx, or .C)?  If it does, you're on
  128. your own.  You can try compiling it yourself if you have a C compiler.
  129. If you're successful, consider uploading the resulting binary to
  130. CPAN for others to use.  If it doesn't, go to INSTALL.</P>
  131. <PRE>
  132.    D. INSTALL</PRE>
  133. <P>Copy the module into your Perl's <EM>lib</EM> directory.  That'll be one
  134. of the directories you see when you type</P>
  135. <PRE>
  136.    perl -e 'print "@INC"'</PRE>
  137. <P></P>
  138. <LI>
  139. <STRONG>If you're running Windows 95 or NT with the core Windows distribution of Perl,</STRONG>
  140. <PRE>
  141.    A. DECOMPRESS</PRE>
  142. <P>When you download the module, make sure it ends in either
  143. <EM>.tar.gz</EM> or <EM>.zip</EM>.  Windows browsers sometimes
  144. download <CODE>.tar.gz</CODE> files as <CODE>_tar.tar</CODE>, because
  145. early versions of Windows prohibited more than one dot in a filename.</P>
  146. <P>You can use the shareware <STRONG>WinZip</STRONG> program ( <A HREF="http://www.winzip.com">http://www.winzip.com</A> ) to
  147. decompress and unpack modules.</P>
  148. <P>Or, you can use InfoZip's <CODE>unzip</CODE> utility (
  149. <A HREF="http://www.cdrom.com/pub/infozip/">http://www.cdrom.com/pub/infozip/</A> ) to uncompress <CODE>.zip</CODE> files; type
  150. <CODE>unzip yourmodule.zip</CODE> in your shell.</P>
  151. <P>Or, if you have a working <CODE>tar</CODE> and <CODE>gzip</CODE>, you can
  152. type</P>
  153. <PRE>
  154.    gzip -cd yourmodule.tar.gz | tar xvf -</PRE>
  155. <P>in the shell to decompress <CODE>yourmodule.tar.gz</CODE>.  This will
  156. UNPACK your module as well.</P>
  157. <PRE>
  158.    B. UNPACK</PRE>
  159. <P>The methods in DECOMPRESS will have done this for you.</P>
  160. <PRE>
  161.    C. BUILD</PRE>
  162. <P>Go into the newly-created directory and type:</P>
  163. <PRE>
  164.       perl Makefile.PL
  165.       dmake
  166.       dmake test</PRE>
  167. <P>Depending on your perl configuration, <CODE>dmake</CODE> might not be
  168. available.  You might have to substitute whatever <CODE>perl
  169. -V:make</CODE> says. (Usually, that will be <CODE>nmake</CODE> or
  170. <CODE>make</CODE>.)</P>
  171. <PRE>
  172.    D. INSTALL</PRE>
  173. <P>While still in that directory, type:</P>
  174. <PRE>
  175.       dmake install</PRE>
  176. <P></P>
  177. <LI>
  178. <STRONG>If you're using a Macintosh,</STRONG>
  179. <P>A. DECOMPRESS</P>
  180. <P>In general, all Macintosh decompression utilities mentioned here
  181. can be found in the Info-Mac Hyperarchive
  182. ( <A HREF="http://hyperarchive.lcs.mit.edu/HyperArchive.html">http://hyperarchive.lcs.mit.edu/HyperArchive.html</A> ).
  183. Specificly the ``Commpress & Translate'' listing
  184. ( <A HREF="http://hyperarchive.lcs.mit.edu/HyperArchive/Abstracts/cmp/HyperArchive.html">http://hyperarchive.lcs.mit.edu/HyperArchive/Abstracts/cmp/HyperArchive.html</A> ).</P>
  185. <P>You can either use the shareware <STRONG>StuffIt Expander</STRONG> program
  186. ( <A HREF="http://www.aladdinsys.com/expander/">http://www.aladdinsys.com/expander/</A> ) 
  187. in combination with <EM>DropStuff with Expander Enhancer</EM>
  188. ( <A HREF="http://www.aladdinsys.com/dropstuff/">http://www.aladdinsys.com/dropstuff/</A> ) 
  189. or the freeware <STRONG>MacGzip</STRONG> program (
  190. <A HREF="http://persephone.cps.unizar.es/general/gente/spd/gzip/gzip.html">http://persephone.cps.unizar.es/general/gente/spd/gzip/gzip.html</A> ).</P>
  191. <P>B. UNPACK</P>
  192. <P>If you're using DropStuff or Stuffit, you can just extract the tar
  193. archive.  Otherwise, you can use the freeware <STRONG>suntar</STRONG> or <EM>Tar</EM> (
  194. <A HREF="http://hyperarchive.lcs.mit.edu/HyperArchive/Archive/cmp/">http://hyperarchive.lcs.mit.edu/HyperArchive/Archive/cmp/</A> ).</P>
  195. <P>C. BUILD</P>
  196. <P>Does the module require compilation?</P>
  197. <P>1. If it does,</P>
  198. <P>Overview: You need MPW and a combination of new and old CodeWarrior
  199. compilers for MPW and libraries.  Makefiles created for building under
  200. MPW use Metrowerks compilers.  It's most likely possible to build
  201. without other compilers, but it has not been done successfully, to our
  202. knowledge.  Read the documentation in <EM>MacPerl: Power and Ease</EM> (
  203. <A HREF="http://www.ptf.com/macperl/">http://www.ptf.com/macperl/</A> ) on porting/building extensions, or find
  204. an existing precompiled binary, or hire someone to build it for you.</P>
  205. <P>Or, ask someone on the mac-perl mailing list (<A HREF="mailto:mac-perl@iis.ee.ethz.ch">mac-perl@iis.ee.ethz.ch</A>)
  206. to build it for you.  To subscribe to the mac-perl mailing list, send
  207. mail to <A HREF="mailto:mac-perl-request@iis.ee.ethz.ch.">mac-perl-request@iis.ee.ethz.ch.</A></P>
  208. <P>2. If the module doesn't require compilation, go to INSTALL.</P>
  209. <P>D. INSTALL</P>
  210. <P>Make sure the newlines for the modules are in Mac format, not Unix format.
  211. If they are not then you might have decompressed them incorrectly.  Check
  212. your decompression and unpacking utilities settings to make sure they are
  213. translating text files properly.</P>
  214. <P>As a last resort, you can use the perl one-liner:</P>
  215. <PRE>
  216.     perl -i.bak -pe 's/(?:\015)?\012/\015/g' <filenames></PRE>
  217. <P>on the source files.</P>
  218. <P>Move the files manually into the correct folders.</P>
  219. <P>Move the files to their final destination: This will
  220. most likely be in <CODE>$ENV{MACPERL}site_lib:</CODE> (i.e.,
  221. <CODE>HD:MacPerl folder:site_lib:</CODE>).  You can add new paths to
  222. the default <CODE>@INC</CODE> in the Preferences menu item in the
  223. MacPerl application (<CODE>$ENV{MACPERL}site_lib:</CODE> is added
  224. automagically).  Create whatever directory structures are required
  225. (i.e., for <CODE>Some::Module</CODE>, create
  226. <CODE>$ENV{MACPERL}site_lib:Some:</CODE> and put
  227. <CODE>Module.pm</CODE> in that directory).</P>
  228. <P>Run the following script (or something like it):</P>
  229. <PRE>
  230.      #!perl -w
  231.      use AutoSplit;
  232.      my $dir = "${MACPERL}site_perl";
  233.      autosplit("$dir:Some:Module.pm", "$dir:auto", 0, 1, 1);</PRE>
  234. <P>Eventually there should be a way to automate the installation process; some
  235. solutions exist, but none are ready for the general public yet.</P>
  236. <P></P>
  237. <LI>
  238. <STRONG>If you're on the DJGPP port of DOS,</STRONG>
  239. <PRE>
  240.    A. DECOMPRESS</PRE>
  241. <P>djtarx ( <A HREF="ftp://ftp.simtel.net/pub/simtelnet/gnu/djgpp/v2/">ftp://ftp.simtel.net/pub/simtelnet/gnu/djgpp/v2/</A> )
  242. will both uncompress and unpack.</P>
  243. <PRE>
  244.    B. UNPACK</PRE>
  245. <P>See above.</P>
  246. <PRE>
  247.    C. BUILD</PRE>
  248. <P>Go into the newly-created directory and type:</P>
  249. <PRE>
  250.       perl Makefile.PL
  251.       make
  252.       make test</PRE>
  253. <P>You will need the packages mentioned in <EM>README.dos</EM>
  254. in the Perl distribution.</P>
  255. <PRE>
  256.    D. INSTALL</PRE>
  257. <P>While still in that directory, type:</P>
  258. <PRE>
  259.      make install</PRE>
  260. <P>You will need the packages mentioned in <EM>README.dos</EM> in the Perl distribution.</P>
  261. <P></P>
  262. <LI>
  263. <STRONG>If you're on OS/2,</STRONG>
  264. <P>Get the EMX development suite and gzip/tar, from either Hobbes (
  265. <A HREF="http://hobbes.nmsu.edu">http://hobbes.nmsu.edu</A> ) or Leo ( <A HREF="http://www.leo.org">http://www.leo.org</A> ), and then follow
  266. the instructions for Unix.</P>
  267. <P></P>
  268. <LI>
  269. <STRONG>If you're on VMS,</STRONG>
  270. <P>When downloading from CPAN, save your file with a <EM>.tgz</EM>
  271. extension instead of <EM>.tar.gz</EM>.  All other periods in the
  272. filename should be replaced with underscores.  For example,
  273. <CODE>Your-Module-1.33.tar.gz</CODE> should be downloaded as
  274. <CODE>Your-Module-1_33.tgz</CODE>.</P>
  275. <P>A. DECOMPRESS</P>
  276. <P>Type</P>
  277. <PRE>
  278.     gzip -d Your-Module.tgz</PRE>
  279. <P>or, for zipped modules, type</P>
  280. <PRE>
  281.     unzip Your-Module.zip</PRE>
  282. <P>Executables for gzip, zip, and VMStar ( Alphas:
  283. <A HREF="http://www.openvms.digital.com/freeware/000TOOLS/ALPHA/">http://www.openvms.digital.com/freeware/000TOOLS/ALPHA/</A> and Vaxen:
  284. <A HREF="http://www.openvms.digital.com/freeware/000TOOLS/VAX/">http://www.openvms.digital.com/freeware/000TOOLS/VAX/</A> ).</P>
  285. <P>gzip and tar
  286. are also available at <A HREF="ftp://ftp.digital.com/pub/VMS.">ftp://ftp.digital.com/pub/VMS.</A></P>
  287. <P>Note that GNU's gzip/gunzip is not the same as Info-ZIP's zip/unzip
  288. package.  The former is a simple compression tool; the latter permits
  289. creation of multi-file archives.</P>
  290. <P>B. UNPACK</P>
  291. <P>If you're using VMStar:</P>
  292. <PRE>
  293.      VMStar xf Your-Module.tar</PRE>
  294. <P>Or, if you're fond of VMS command syntax:</P>
  295. <PRE>
  296.      tar/extract/verbose Your_Module.tar</PRE>
  297. <P>C. BUILD</P>
  298. <P>Make sure you have MMS (from Digital) or the freeware MMK ( available from MadGoat at  <A HREF="http://www.madgoat.com">http://www.madgoat.com</A> ).  Then type this to create the
  299. DESCRIP.MMS for the module:</P>
  300. <PRE>
  301.     perl Makefile.PL</PRE>
  302. <P>Now you're ready to build:</P>
  303. <PRE>
  304.     mms
  305.     mms test</PRE>
  306. <P>Substitute <CODE>mmk</CODE> for <CODE>mms</CODE> above if you're using MMK.</P>
  307. <P>D. INSTALL</P>
  308. <P>Type</P>
  309. <PRE>
  310.     mms install</PRE>
  311. <P>Substitute <CODE>mmk</CODE> for <CODE>mms</CODE> above if you're using MMK.</P>
  312. <P></P>
  313. <LI>
  314. <STRONG>If you're on MVS</STRONG>,
  315. <P>Introduce the <EM>.tar.gz</EM> file into an HFS as binary; don't translate from
  316. ASCII to EBCDIC.</P>
  317. <P>A. DECOMPRESS</P>
  318. <PRE>
  319.       Decompress the file with C<gzip -d yourmodule.tar.gz></PRE>
  320. <PRE>
  321.       You can get gzip from 
  322.       <A HREF="http://www.s390.ibm.com/products/oe/bpxqp1.html.">http://www.s390.ibm.com/products/oe/bpxqp1.html.</A></PRE>
  323. <P>B. UNPACK</P>
  324. <P>Unpack the result with</P>
  325. <PRE>
  326.      pax -o to=IBM-1047,from=ISO8859-1 -r < yourmodule.tar</PRE>
  327. <P>The BUILD and INSTALL steps are identical to those for Unix.  Some
  328. modules generate Makefiles that work better with GNU make, which is
  329. available from <A HREF="http://www.mks.com/s390/gnu/index.htm.">http://www.mks.com/s390/gnu/index.htm.</A></P>
  330. <P></P></UL>
  331. <P>
  332. <HR>
  333. <H1><A NAME="hey">HEY</A></H1>
  334. <P>If you have any suggested changes for this page, let me know.  Please
  335. don't send me mail asking for help on how to install your modules.
  336. There are too many modules, and too few Orwants, for me to be able to
  337. answer or even acknowledge all your questions.  Contact the module
  338. author instead, or post to comp.lang.perl.modules, or ask someone
  339. familiar with Perl on your operating system.</P>
  340. <P>
  341. <HR>
  342. <H1><A NAME="author">AUTHOR</A></H1>
  343. <P>Jon Orwant</P>
  344. <P><A HREF="mailto:orwant@tpj.com">orwant@tpj.com</A></P>
  345. <P>The Perl Journal, <A HREF="http://tpj.com">http://tpj.com</A></P>
  346. <P>with invaluable help from Brandon Allbery, Charles Bailey, Graham
  347. Barr, Dominic Dunlop, Jarkko Hietaniemi, Ben Holzman, Tom Horsley,
  348. Nick Ing-Simmons, Tuomas J. Lukka, Laszlo Molnar, Chris Nandor, Alan
  349. Olsen, Peter Prymmer, Gurusamy Sarathy, Christoph Spalinger, Dan
  350. Sugalski, Larry Virden, and Ilya Zakharevich.</P>
  351. <P>July 22, 1998</P>
  352. <P>
  353. <HR>
  354. <H1><A NAME="copyright">COPYRIGHT</A></H1>
  355. <P>Copyright (C) 1998 Jon Orwant.  All Rights Reserved.</P>
  356. <P>Permission is granted to make and distribute verbatim copies of this
  357. documentation provided the copyright notice and this permission notice are
  358. preserved on all copies.</P>
  359. <P>Permission is granted to copy and distribute modified versions of this
  360. documentation under the conditions for verbatim copying, provided also
  361. that they are marked clearly as modified versions, that the authors'
  362. names and title are unchanged (though subtitles and additional
  363. authors' names may be added), and that the entire resulting derived
  364. work is distributed under the terms of a permission notice identical
  365. to this one.</P>
  366. <P>Permission is granted to copy and distribute translations of this
  367. documentation into another language, under the above conditions for
  368. modified versions.</P>
  369. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  370. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  371. <STRONG><P CLASS=block> perlmodinstall - Installing CPAN Modules</P></STRONG>
  372. </TD></TR>
  373. </TABLE>
  374.  
  375. </BODY>
  376.  
  377. </HTML>
  378.