home *** CD-ROM | disk | FTP | other *** search
/ Australian Personal Computer 2004 July / APC0407D2.iso / workshop / apache / files / ActivePerl-5.6.1.638-MSWin32-x86.msi / _f47f96dd1dc57d65a8c547ee99d1b55b < prev    next >
Encoding:
Text File  |  2004-04-13  |  56.2 KB  |  1,636 lines
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
  2. <html>
  3.  
  4. <head>
  5. <title>ActivePerl FAQ - Using PPM to install modules</title>
  6. <link rel="STYLESHEET" href="../Active.css" type="text/css" media="screen">
  7. </head>
  8.  
  9. <body>
  10.  
  11. <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EAE2BB">
  12. <tr> 
  13. <td width="57"><a target=_blank href="http://www.ActiveState.com/ActivePerl/">
  14. <img src="../images/activeperl_logo.gif" width="57" height="48" border="0" alt="ActivePerl"></a></td>
  15. <td><div align="center" class="heading">ActivePerl User Guide</div></td>
  16. <td width="112"><a target=_blank  href="http://www.ActiveState.com">
  17. <img src="../images/AS_logo.gif" width="112" height="48" border="0"  alt="ActiveState" /></a></td>
  18. </tr>
  19. <tr>
  20. <td class="lineColour" colspan="3"></td>
  21. </tr>
  22. </table>
  23.  
  24. <h1>Using PPM to install modules</h1>
  25.  
  26. <ul>
  27.   <li><a class="doc" href="#NAME">NAME</a></li>
  28.   <li><a class="doc" href="#DESCRIPTION">DESCRIPTION</a>
  29.     <ul>
  30.       <li><a class="doc" href="#what_is_ppm">What is the PPM?</a></li>
  31.       <li><a class="doc" href="#how_do_i_install_ppm">How do I install PPM?</a></li>
  32.       <li><a class="doc" href="#running_ppm">How do I run PPM?</a></li>
  33.       <li><a class="doc" href="#using_ppm">How do I use PPM?</a></li>
  34.       <li><a class="doc" href="#ppm3_commands">PPM version 3 Commands</a></li>
  35.       <li><a class="doc" href="#ppm2_commands">PPM version 2 Commands</a></li>
  36.       <li><a class="doc" href="#repositories">Where are the package repositories?</a></li>
  37.       <li><a class="doc" href="#how_to_make_ppm_distribution">How do I make a PPM package?</a></li>
  38.       <li><a class="doc" href="#ppm_and_proxies">PPM, Proxies and Firewalls</a></li>
  39.     </ul>
  40.   </li>
  41.   <li><a class="doc" href="#AUTHOR_AND_COPYRIGHT">AUTHOR AND COPYRIGHT</a></li>
  42. </ul>
  43.  
  44. <h2><a name="NAME">NAME</a></h2>
  45. <p>Using PPM to install modules</p>
  46.  
  47. <h2><a name="DESCRIPTION">DESCRIPTION</a></h2>
  48. <p>How to install and upgrade modules using PPM</p>
  49.  
  50. <h2><a name="what_is_ppm">What is the PPM?</a></h2>
  51. <p>The Programmer's Package Manager (PPM), formerly known as the Perl Package Manager,
  52. provides a command line interface for managing your modules and extensions (packages).
  53. PPM is used to access package repositories (or collections of packages on other machines),
  54. install and remove packages from your system, as well as update previously installed packages
  55. with the latest versions.
  56.  
  57. <p>The PPM 3.0 release introduces a complete rewrite of PPM, featuring many
  58. <a class="doc" href="#ppm_commands"> additions and improvements</a>. To maintain compatibility
  59. and provide a smooth migration path, PPM3 will coexist with the current PPM.
  60.  
  61. <h2><a name="how_do_i_install_ppm">How do I install PPM?</a></h2>
  62. <p>Both PPM versions 2 and PPM version 3 (PPM3) are installed when you install 
  63. ActivePerl.</p>
  64.  
  65. <h2><a name="running_ppm">How do I run PPM?</a></h2>
  66.  
  67. <p>Before you run PPM or PPM3, you must either be connected to the Internet or have access 
  68. to a local <a class="doc" href="#repositories">repository</a>, like a hard drive 
  69. or the <a class="doc" href="http://aspn.activestate.com/ASPN/Downloads/ActiveCD"> 
  70. ActiveState ActiveCD</a>. If your Internet connection is via a firewall or proxy, 
  71. you must set the environment variable "HTTP_proxy" to the name of the proxy 
  72. server. If your proxy server requires a username and password, use the environment 
  73. variables "HTTP_proxy_user" and "HTTP_proxy_pass". See <a class="doc" href="#ppm_and_proxies"> 
  74. PPM, Proxies and Firewalls</a> for more information.
  75.  
  76. <p>To run PPM version 2, enter <code>ppm</code> in a command prompt window 
  77. (Windows), or <code>ppm3</code> at the shell prompt (Linux / Solaris).</p>
  78.  
  79. <h2><a name="using_ppm">How do I use PPM?</h2></a>
  80.  
  81. <p>Quick start: at the PPM3 command prompt, type 
  82. <a class="doc" href="#search"><code>search *</code></a>
  83. to get a listing of all available packages, then type <code>install
  84. <package name></code>, where <<code>package name</code>> is the name of a
  85. package displayed by the <code>search</code> command. To list the packages you have previously
  86. installed using PPM3, use the <a class="doc" href="#query"><code>query *</code></a> command.
  87.  
  88. <p>Those using PPM can type '<code>search</code>' to get a
  89. listing of all available packages, then type '<code>install <packagename></code>',
  90. where <code><packagename></code> is the name of a package displayed by the
  91. '<code>search</code>' command. To list the packages you have previously
  92. installed using PPM, use the '<code>query</code>' command.</p>
  93.  
  94. <blockquote>
  95. <p>Note to PPM users: If you find the listing of packages scrolls by too quickly, you may want to
  96. use the command '<code>set more <number></code>' to pause the listing
  97. after <number> packages have been displayed. Use the '<code>set save</code>'
  98. command to save this configuration for future PPM sessions.</p>
  99. </blockquote>
  100.  
  101. <p>The first time you run PPM or PPM3, the ActiveState package repository will be your default repository.
  102. If you change your default repository, that change will be saved. PPM3 users can can select a different
  103. repository with the <a class="doc" href="#repository"> repository</a> command. PPM users will use
  104. the '<code>set</code>' command. See
  105. <a class="doc" href="#repositories">Where are the package repositories?</a> below.
  106.  
  107. <h2><a name="ppm3_commands">PPM version 3 Commands</a></h2>
  108.  
  109. <p>Items in <angle brackets> are arguments that can be used with the commands, while items
  110. in [square brackets] are optional elements. PPM3 will recognize and accept shortened versions of the
  111. commands, as long as enough letters are typed to be recognized by PPM3. For example,
  112. "des" can be typed instead of "describe".
  113.  
  114. <!-- to facilitate parsing of the command descriptions, each command has <PPM-HELP> tags, with the argument of "name" -->
  115. <PPM3-HELP name="describe">
  116. <h3><a name="describe">Describe</a></h3>
  117. <blockquote>
  118. <table>
  119.     <tr>
  120.     <td><p>describe</td>
  121.     <td valign="top" align="left" width="10%"></td>
  122.     <td><p>Describes default/current package</td>
  123.     </tr>
  124.     <tr>
  125.     <td><p>describe <number></td>
  126.     <td valign="top" align="left" width="10%"></td>
  127.     <td><p>Describes package <number> in the current search set</td>
  128.     </tr>
  129.     <tr>
  130.     <td><p>describe <range></td>
  131.     <td valign="top" align="left" width="10%"></td>
  132.     <td><p>Describes packages in the given <range> from the current search set</td>
  133.     </tr>
  134.     <tr>
  135.     <td><p>describe <name></td>
  136.     <td valign="top" align="left" width="10%"></td>
  137.     <td><p>Describes named package</td>
  138.     </tr>
  139.     <tr>
  140.     <td><p>describe <glob pattern></td>
  141.     <td valign="top" align="left" width="10%"></td>
  142.     <td><p>Performs a new search using <glob pattern></td>
  143.     </tr>
  144. </table>
  145. </blockquote>
  146.  
  147. <p>When used, <code>describe</code> returns information about a package, including the name of the package,
  148. the author's name and a brief description (called an "Abstract") about the package. For example, when you enter:
  149.  
  150. <pre>
  151. describe libnet
  152. </pre>
  153.  
  154. <p>PPM3 will return:
  155.  
  156. <pre>
  157. ===============================
  158. Package 1
  159.     Name: libnet
  160.  Version: 1.07.03
  161.   Author: Graham Barr
  162. Abstract: Collection of Network protocol modules
  163. Implementations:
  164.     1.sun4-solaris-thread-multi
  165.     2.i686-linux-thread-multi
  166.     3.MSWIn32-x86-multi-thread
  167. ===============================
  168. </pre>
  169.  
  170. <p>When the <code>describe</code> command is called without arguments, it returns information about the first
  171. package in the current <a class="doc" href="#search">search</a>. If there is no default search set, you'll be
  172. prompted to use <a class="doc" href="#search">search</a> to find a package.
  173.  
  174. <p>If <code>describe</code> is called with a numeric argument, that number is set as the default package
  175. and the information about that package is returned. If the number given doesn't exist, you'll be prompted
  176. to use <a class="doc" href="#search">search</a> to find a package. Also, you can use <code>describe</code> to give
  177. descriptions of several packages. For example:
  178.  
  179. <pre>
  180. describe 4-7
  181. </pre>
  182.  
  183. <p>will give you descriptions of packages 4 through 7, in the current search request. You can also enter:
  184.     
  185. <pre>
  186. describe 3-4,10
  187. </pre>
  188.  
  189. <p>to get information on packages 3, 4 and 10.
  190.  
  191. <p>When the <code>describe</code> command is given a name with a wildcard (such as "*" or "?")
  192. it executes the <code>search</code> command with the given argument. With this, you can type
  193. something like <code>describe Tk*</code> and the search will give you the name(s) of any packages
  194. that match your search parameters.
  195.  
  196. <p>See Also:
  197. <a class="doc" href="#properties">Properties</a>
  198. </PPM3-HELP>
  199.  
  200. <PPM3-HELP name="exit">
  201. <h3><a name="exit">Exit</a></h3>
  202. <blockquote>
  203. <table>
  204.     <tr>
  205.     <td><p>exit</td>
  206.     <td valign="top" align="left" width="10%"></td>
  207.     <td><p>Exits the program</td>
  208.     </tr>
  209. </table>
  210. </blockquote>
  211.  
  212. <p>When you leave the PPM3 environment, the current settings are saved.
  213.  
  214. <p>See Also:
  215.     <a class="doc" href="#quit">Quit</a>
  216. </PPM3-HELP>
  217.  
  218. <PPM3-HELP name="help">
  219. <h3><a name="help">Help</a></h3>
  220.  
  221. <blockquote>
  222. <table>
  223.     <tr>
  224.     <td><p>help</td>
  225.     <td valign="top" align="left" width="10%"></td>
  226.         <td><p>lists available commands</td>
  227.     </tr>
  228.     <tr>
  229.     <td><p>help <command></td>
  230.     <td valign="top" align="left" width="10%"></td>
  231.     <td><p>lists detailed help about a specific command</td>
  232.     </tr>
  233. </table>
  234. </blockquote>
  235.  
  236. <p>The <code>help</code> command provides a brief description of the commands available
  237. within PPM3. For help on a specific command, enter <code>help</code> followed by the command.
  238. For example, enter <code>help settings</code> or <code>help set</code> for a detailed description of the
  239. <a class="doc" href="#settings">settings</a> command.
  240.  
  241. <p>There are some extra help topics built into PPM3. They can be accessed within the PPM3 environment as follows:</p>
  242.  
  243. <blockquote>
  244. <table> 
  245.     <tr>
  246.     <td align="left"><p>HELP COMMAND</td>
  247.     <td valign="top" align="left" width="10%"></td>
  248.     <td align="left"><p>DESCRIPTION</td>
  249.     <td valign="top" align="left" width="10%"></td>
  250.     </tr>
  251.     <tr>    
  252.     <td colspan="4" bgcolor="#000000"></td>
  253.     </tr>
  254.     <tr>
  255.     <td><p>help ppm_migration</td>
  256.     <td valign="top" align="left" width="10%"></td>
  257.     <td><p>shows more details about the changes from previous versions of PPM</td>
  258.     </tr>
  259.     <tr>    
  260.     <td colspan="4" bgcolor="#000000"></td>
  261.     </tr>
  262.     <tr>
  263.     <td><p>help quickstart</td>
  264.     <td valign="top" align="left" width="10%"></td>
  265.     <td><p>an easy-to-follow guide to getting started with PPM3</td>
  266.     </tr>
  267.     <tr>    
  268.     <td colspan="4" bgcolor="#000000"></td>
  269.     </tr>
  270.     <tr>
  271.     <td><p>help prompt</td>
  272.     <td valign="top" align="left" width="10%"></td>
  273.     <td><p>provides a detailed explanation about the PPM3 prompt</td>
  274.     </tr>
  275.     <tr>    
  276.     <td colspan="4" bgcolor="#000000"></td>
  277.     </tr>
  278.     <tr>
  279.     <td><p>help queryformat</td>
  280.     <td valign="top" align="left" width="10%"></td>
  281.     <td><p>gives the user extra tips and hints about making effective searches/queries in PPM3</td>
  282.     </tr>
  283.     <tr>    
  284.     <td colspan="4" bgcolor="#000000"></td>
  285.     </tr>
  286. </table>
  287. </blockquote>
  288. </PPM3-HELP>
  289.  
  290. <PPM3-HELP name="install">
  291. <h3><a name="install">Install</a></h3>
  292.  
  293. <blockquote>
  294. <table>
  295.     <tr>
  296.     <td><p>install</td>
  297.     <td valign="top" align="left" width="10%"></td>
  298.     <td><p>Installs default package<td>
  299.     </tr>
  300.     <tr>
  301.     <td><p>install <number></td>
  302.     <td valign="top" align="left" width="10%"></td>
  303.     <td><p>Installs packages by a specific number</td>
  304.     </tr>
  305.     <tr>
  306.     <td><p>install <range></td>
  307.     <td valign="top" align="left" width="10%"></td>
  308.     <td><p>Installs packages in the given numeric range <range>.</td>
  309.     </tr>
  310.     <tr>
  311.     <td><p>install <name></td>
  312.     <td valign="top" align="left" width="10%"></td>
  313.     <td><p>Installs named package</td>
  314.     </tr>
  315. </table>
  316. </blockquote>
  317.  
  318. <p>The <code>install</code> command is used to install packages from the
  319. repository. You can install packages by name or number (the number is given by
  320. the repository or search request), or a default package can be established
  321. through use of the <code>describe</code> command. There is also a set of
  322. modifiers that can be used with the install command:</p>
  323.  
  324. <pre>-force  -noforce
  325. -follow -nofollow</pre>
  326.  
  327. <p>The <code>force</code> and <code>follow</code> commands determine how
  328. packages are installed:
  329.  
  330. <blockquote>
  331. <table>
  332.     <tr>
  333.     <td align="left"><p>FORCE</td>
  334.     <td valign="top" align="left" width="10%"></td>
  335.     <td align="left"><p>FOLLOW</td>
  336.     <td valign="top" align="left" width="10%"></td>
  337.     <td align="left"><p>RESULT</td>
  338.     </tr>
  339.     <tr>    
  340.     <td colspan="5" bgcolor="#000000"></td>
  341.     </tr>
  342.     <tr>
  343.     <td><p>false</td>
  344.     <td valign="top" align="left" width="10%"></td>
  345.     <td><p>false</td>
  346.     <td valign="top" align="left" width="10%"></td>
  347.     <td><p>Checks to see if the package is installed and if it is, PPM3 stops. If there are any missing prerequisites, the installation
  348.     will fail.</td>
  349.     </tr>
  350.     <tr>    
  351.     <td colspan="5" bgcolor="#000000"></td>
  352.     </tr>
  353.     <tr>
  354.     <td><p>false</td>
  355.     <td valign="top" align="left" width="10%"></td>
  356.     <td><p>true</td>
  357.     <td valign="top" align="left" width="10%"></td>
  358.     <td><p>Checks to see if the package is installed and if it is, PPM3 stops. If there are any missing prerequisites, they
  359.     are automatically installed.</td>
  360.     </tr>
  361.     <tr>    
  362.     <td colspan="5" bgcolor="#000000"></td>
  363.     </tr>
  364.     <tr>
  365.     <td><p>true</td>
  366.     <td valign="top" align="left" width="10%"></td>
  367.     <td><p>false</td>
  368.     <td valign="top" align="left" width="10%"></td>
  369.     <td><p>If the package is installed, PPM3 will reinstall the package. If there are any missing prerequisites, the installation will fail. NOTE:
  370.         This is the default setting when PPM3 is first installed.</td>
  371.     </tr>
  372.     <tr>    
  373.     <td colspan="5" bgcolor="#000000"></td>
  374.     </tr>
  375.     <tr>
  376.     <td><p>true</td>
  377.     <td valign="top" align="left" width="10%"></td>
  378.     <td><p>true</td>
  379.     <td valign="top" align="left" width="10%"></td>
  380.     <td><p>If the package is installed, PPM3 will reinstall the package. If there are any missing prerequisites, they
  381.     are automatically installed.</td>
  382.     </tr>
  383.     <tr>    
  384.     <td colspan="5" bgcolor="#000000"></td>
  385.     </tr>
  386. </table>
  387. </blockquote>
  388.  
  389. <p>If you do not specify any options, install uses the default settings. Set or view the
  390. current defaults using the <a class="doc" href="#settings">settings</a> command. </p>
  391.  
  392. <p>For example:</p>
  393.  
  394. <pre>install foo</pre>
  395.  
  396. <p>will install the package named "foo", using the default settings. You can over-ride the
  397. defaults with the install modifiers.</p>
  398.  
  399. <p>For example:</p>
  400.  
  401. <pre>install foo -force</pre>
  402.  
  403. <p>will install the "foo" package, even if it has already been installed. If both <code>-force</code> and <code>-follow</code>
  404. are set to "true", all the prerequisites for any package you install will be installed. For example, the installation of a tk-related package,
  405. like "tk-ach" which is 8.4 kB will be preceded by the installation of Tk, which is 1.7 MB.
  406.  
  407. <p>You can also install by package number. The numbering of the packages is based on the current repository or current search request.
  408. For example:
  409.     
  410. <pre>
  411. install 6
  412. </pre>
  413.  
  414. <p>installs package number 6. You can install more than one package at one time:
  415.     
  416. <pre>
  417. install 3-5
  418. </pre>
  419.  
  420. <p>installs packages 3, 4 and 5. You can also type <code>install 3-6,8</code> to receive packages 3,4,5,6 and 8.
  421. </PPM3-HELP>
  422.  
  423. <PPM3-HELP name="profile">
  424. <h3><a name="profile">Profile</a></h3>
  425. <blockquote>
  426. <table>
  427.     <tr>
  428.     <td><p>profile</td>
  429.     <td valign="top" align="left" width="10%"></td>
  430.     <td><p>lists profiles available on the repository</td>
  431.     </tr>
  432.     <tr>
  433.         <td><p>profile <number></td>
  434.         <td valign="top" align="left" width="10%"></td>
  435.         <td><p>switches to the given profile</td>
  436.     </tr>
  437.     <tr>
  438.     <td><p>profile add <name></td>
  439.     <td valign="top" align="left" width="10%"></td>
  440.     <td><p>creates a new profile on the repository</td>
  441.     </tr>
  442.     <tr>
  443.     <td><p>profile del <number></td>
  444.     <td valign="top" align="left" width="10%"></td>
  445.     <td><p>deletes the given profile</td>
  446.     </tr>
  447.     <!-- <tr>
  448.     <td><p>profile des <number>
  449.     <td valign="top" align="left" width="10%"></td>
  450.     <td><p>describes the given profile (NOT IMPLEMENTED)</td>
  451.     </tr> -->
  452.     <tr>
  453.     <td><p>profile save</td>
  454.     <td valign="top" align="left" width="10%"></td>
  455.     <td><p>saves the client state to the current profile</td>
  456.     </tr>
  457.     <tr>
  458.     <td><p>profile restore</td>
  459.     <td valign="top" align="left" width="10%"></td>
  460.     <td><p>restores the current profile</td>
  461.     </tr>
  462. </table>
  463. </blockquote>
  464.  
  465. <p>With profiles, package installation and management is easy to oversee. By
  466. using profiles, you can save your favorite perl packages in a single profile
  467. or group packages by function in different profiles. This also makes installation of
  468. packages easier, as you only need to access one or two profiles, instead of many
  469. individual packages.
  470.  
  471. <p>Managing your profiles can be done through PPM3 or via the ActiveState Interactive website.
  472. <!-- need to add a url here, when it becomes available
  473. we also need the liscening information for PPM -->
  474.  
  475. <p>Note: The <code>profile</code> commands are only available if the current repository is a PPM3 repository.</p>
  476. </PPM3-HELP>
  477.  
  478. <PPM3-HELP name="properties">
  479. <h3><a name="properties">Properties</a></h3>
  480.  
  481. <blockquote>
  482. <table> 
  483.     <tr>
  484.     <td><p>properties</td>
  485.     <td valign="top" align="left" width="10%"></td>
  486.     <td><p>Describes default installed package</td>
  487.     </tr>
  488.     <tr>
  489.     <td><p>properties <number></td>
  490.     <td valign="top" align="left" width="10%"></td>
  491.     <td><p>Describes installed package <number></td>
  492.     </tr>
  493.     <tr>
  494.         <td><p>properties <package name></td>
  495.         <td valign="top" align="left" width="10%"></td>
  496.         <td><p>Describes named installed package</td>
  497.     </tr>
  498.     <tr>
  499.     <td><p>properties <glob pattern></td>
  500.     <td valign="top" align="left" width="10%"></td>
  501.     <td><p>Performs a new query using <glob pattern></td>
  502.     </tr>
  503. </table>
  504. </blockquote>
  505.  
  506. <p>Similar to the <a class="doc" href="#describe">describe</a> command,
  507. <code>properties</code> provides information on an installed package, but with
  508. more details than those available with <a class="doc"
  509. href="#describe">describe</a>.  In addition to the summary information,
  510. <code>properties</code> will display the installation date and a URL showing
  511. the location of the package within the repository.
  512.  
  513. <p>Note: When <code>properties</code> is called with arguments including a
  514. wildcard, it prints a message telling you that it is about to forward the
  515. whole command-line to <a class="doc" href="#query">query</a>; then it does.
  516. With this, you can type "properties Tk*" or "prop Tk*".
  517.  
  518. <p>For example, typing <code>properties libnet</code> will give you:
  519. <pre>
  520.     Name: libnet
  521.  Version: 1.07.03
  522.   Author: Graham Barr
  523. Abstract: Collection of Network protocol modules
  524. InstDate: Fri Oct  2 16:15:15 1998
  525. Location: http://ppm.ActiveState.com/cgibin/PPM/ppmserver.pl?urn:/PPMServer
  526. </pre>    
  527. <p>See Also:
  528.     <a class="doc" href="#describe">Describe</a>
  529. </PPM3-HELP>
  530.  
  531. <PPM3-HELP name="quit">
  532. <h3><a name="quit">Quit</a></h3>
  533.  
  534. <blockquote>
  535. <table>
  536.     <tr>
  537.     <td><p>Quit</td>
  538.     <td valign="top" align="left" width="10%"></td>
  539.     <td><p>exits the program.</td>
  540.     </tr>
  541. </table>
  542. </blockquote>
  543. <p><code>Quit</code> is another command used to close the PPM application. Like the <a class="doc" href="#exit">exit</a>
  544. command; when you close PPM3, the current settings will be saved.
  545.  
  546. <p>See Also:
  547.     <a class="doc" href="#exit">Exit</a>
  548. </PPM3-HELP>
  549.  
  550. <PPM3-HELP name="query">
  551. <h3><a name="query">Query</a></h3>
  552.  
  553. <blockquote>
  554. <table>
  555.     <tr>
  556.     <td><p>query</td>
  557.     <td valign="top" align="left" width="10%"></td>
  558.     <td><p>Displays list of previous queries</td>
  559.     </tr>
  560.     <tr>
  561.     <td><p>query <number></td>
  562.     <td valign="top" align="left" width="10%"></td>
  563.     <td><p>Displays results of previous query</td>
  564.     </tr>
  565.     <tr>
  566.     <td><p>query <glob pattern></td>
  567.     <td valign="top" align="left" width="10%"></td>
  568.     <td><p>Performs a new query using <glob pattern></td>
  569.     </tr>
  570.     <tr>
  571.     <td><p>query *</td>
  572.     <td valign="top" align="left" width="10%"></td>
  573.     <td><p>Displays a list of all installed packages</td>
  574.     </tr>
  575. </table>    
  576. </blockquote>
  577.  
  578. <p>The <code>query</code> command displays either a list of all installed packages or a shortened list,
  579. based on the <glob pattern> entered. You can also check the list of past queries or the results of a past query.
  580.  
  581. <p>Note: Depending on the value of "case-sensitivity", the query may or may not be case-sensitive.
  582. See "help settings" for how to affect the case sensitivity.
  583.  
  584. <p>See Also:
  585.     <a class="doc" href="#settings">Settings</a>
  586. </PPM3-HELP>
  587.  
  588. <PPM3-HELP name="remove">
  589. <h3><a name="remove">Remove</a></h3>
  590.  
  591. <blockquote>
  592. <table>
  593.     <tr>
  594.     <td><p>remove</td>
  595.     <td valign="top" align="left" width="10%"></td>
  596.     <td><p>Deletes default installed package</td>
  597.     </tr>
  598.     <tr>
  599.     <td><p>remove <number></td>
  600.     <td valign="top" align="left" width="10%"></td>
  601.     <td><p>Deletes a package by a specific number</td>
  602.     </tr>
  603.     <tr>
  604.     <td><p>remove <range></td>
  605.     <td valign="top" align="left" width="10%"></td>
  606.     <td><p>Deletes a <range> of packages</td>
  607.     </tr>
  608.     <tr>
  609.     <td><p>remove <name></td>
  610.     <td valign="top" align="left" width="10%"></td>
  611.     <td><p>Deletes a package by a specific name</td>
  612.     </tr>
  613. </table>
  614. </blockquote>
  615.  
  616. <p>The <code>remove</code> command deletes packages from your current <A class="doc" href="#target">target</a>.
  617. Packages can be removed by package name or by their numerical listing. For example:
  618.  
  619. <pre>
  620. remove XML-DOM
  621. </pre>
  622.  
  623. <p>will delete the XML-DOM package from your target. Also, you can remove package by number:
  624.  
  625. <pre>
  626. remove 6
  627. </pre>
  628.  
  629. <p>and the 6th package in your current query will be removed. If you have no query requests established, you'll be required to
  630. use <a class="doc" href="#query">query</a> to find a package before you delete it. It's important to remember that removing
  631. packages also clears all previous query requests, since the numerical sequence stored in any query will no longer be true
  632. once package(s) have been removed.
  633.  
  634. <p>Packages can also be removed in groups; for example:
  635.  
  636. <pre>
  637. remove 4-7
  638. </pre>
  639.  
  640. <p>will delete packages 4, 5, 6, and 7 from your target. You can also skip packages in the removal process:
  641.  
  642. <pre>
  643. remove 3-5, 7
  644. </pre>
  645.  
  646. <p>this will delete packages 3, 4, 5 and 7...but it will leave 6 intact. Remember to run a new query whenever
  647. you remove a package from your target.
  648.  
  649. <p>Please note that wildcards like "*" or "?" cannot be used with the <code>remove</code> command.
  650.  
  651. <p>See Also:
  652.     <a class="doc" href="#uninstall">Uninstall</a>
  653. </PPM3-HELP>
  654.  
  655. <PPM3-HELP name="repository">
  656. <h3><a name="repository">Repository</a></h3>
  657.  
  658. <blockquote>
  659. <table>
  660.     <tr>
  661.     <td><p>repository</td>
  662.     <td valign="top" align="left" width="10%"></td>
  663.     <td><p>displays all repositories</td>
  664.     </tr>
  665.     <tr>
  666.     <td><p>repository [set] <number></td>
  667.     <td valign="top" align="left" width="10%"></td>
  668.     <td><p>sets the specified repository active</td>
  669.     </tr>
  670.     <tr>
  671.     <td><p>repository add [name] <repository location></td>
  672.     <td valign="top" align="left" width="10%"></td>
  673.     <td><p>adds a new repository</td>
  674.     </tr>
  675.     <tr>
  676.     <td><p>repository del <number></td>
  677.     <td valign="top" align="left" width="10%"></td>
  678.     <td><p>deletes the specified repository</td>
  679.     </tr>
  680.     <tr>
  681.     <td><p>repository describe [number]</td>
  682.     <td valign="top" align="left" width="10%"></td>
  683.     <td><p>displays the name, location and type of the specified (or
  684.     current) repository</td>
  685.     </tr>
  686. </table>
  687. </blockquote>
  688.  
  689. <p>When used with no arguments, <code>repository</code> (or "<code>rep</code>") will list the 
  690. repositories currently within the PPM3 settings. The default repository is highlighted with a leading "*".
  691.  
  692. <p>For example, when you enter:</p>
  693.  
  694. <pre>rep</pre>
  695.  
  696. <p>PPM3 will return something resembling this:</p>
  697.  
  698. <pre>
  699. Repositories:
  700. * 1. ActiveCD.
  701.   2. ActiveState Package Repository
  702. </pre>
  703.  
  704. <p>With the example above, entering <code>rep set 2</code> will make the
  705. second repository (ActiveState Package
  706. Repository) the active repository. Adding another repository is done like this:</p>
  707.  
  708. <pre>rep add <NAME> <LOCATION></pre>
  709.  
  710. <p>for example:</p>
  711.  
  712. <code>rep add TheoryX5 http://theoryx5.uwinnipeg.ca/cgi-bin/ppmserver?urn:/PPMServer</code>
  713.   
  714. <p>with "TheoryX5" being the name of the repository (for easy reference) and the location noted by
  715. the http location. If you were to enter <code>rep</code> again, you would see:</p>
  716.  
  717. <pre>
  718. ppm>rep
  719. Repositories:
  720.   1. ActiveCD
  721. * 2. ActiveState Package Repository
  722.   3. TheoryX5
  723. </pre>
  724.  
  725. <p>If you wanted to remove the ActiveCD repository, you would type <code>rep del 1</code>,
  726. to remove the 1st repository. To get more information on a particular repository, type
  727. <code>res describe</code> to get information on the current repository or <code>res describe
  728. <number></code> to get information on a specific repository.
  729.  
  730. <p>For example:</p>
  731.  
  732. <pre>rep describe 2</pre>
  733.  
  734. <p>will return:</p>
  735.  
  736. <pre>
  737. Describing Repository 2:
  738.     Name: ActiveState Package Repository
  739. Location: http://ppm.ActiveState.com/cgibin/PPM/ppmserver.pl?urn:/PPMServer
  740.     Type: PPMServer 2.00
  741. </pre>  
  742. </PPM3-HELP>
  743.  
  744. <PPM3-HELP name="search">
  745. <h3><a name="search">Search</a></h3>
  746.  
  747. <blockquote>
  748. <table>
  749.     <tr>
  750.     <td valign="top" align="left" width="20%"><p>search</td>
  751.     <td valign="top" align="left" width="10%"></td>
  752.     <td><p>Displays list of previous searches</td>
  753.     </tr>
  754.     <tr>
  755.     <td><p>search <number></td>
  756.     <td valign="top" align="left" width="10%"></td>
  757.     <td><p> Displays results of search <number></td>
  758.     </tr>
  759.     <tr>
  760.     <td><p>search <glob pattern></td>
  761.     <td valign="top" align="left" width="10%"></td>
  762.     <td><p>Performs a new search</td>
  763.     </tr>
  764.     <tr>
  765.     <td><p>search <field>=<glob pattern></td>
  766.     <td valign="top" align="left" width="10%"></td>
  767.     <td><p>Searches for all packages matching the field - the available fields are ABSTRACT, NAME or TITLE, AUTHOR and VERSION -
  768.     NAME is the default search setting</td>
  769.     </tr>
  770.     <tr>
  771.     <td><p>search *</td>
  772.     <td valign="top" align="left" width="10%"></td>
  773.     <td><p>Searches for all packages in the current repository</td>
  774.     </tr>
  775. </table>
  776. </blockquote>
  777.  
  778. <p><code>Search</code> is used to look through the repository for packages. With PPM, you can 
  779. perform powerful and detailed searches. Here are some examples:
  780.  
  781. <blockquote>
  782. <table>
  783.     <tr valign="top">
  784.         <td align="left" width="20%"><p>COMMAND</p></td>
  785.         <td width="10%"></td>
  786.         <td align="left"><p>MEANING</p></td>
  787.         <td width="10%"></td>
  788.         <td width="30%" align="left"><p>SAMPLE RESULTS</p></td>
  789.     </tr>
  790.     <tr>
  791.         <td colspan="5" bgcolor="#000000"></td>
  792.     </tr>
  793.     <tr valign="top">
  794.         <td width="20%"><p><code>search CGI</code></p></td>
  795.         <td width="10%"></td>
  796.         <td><p>Search for 'CGI' anywhere in the name</p></td>
  797.         <td width="10%"></td>
  798.         <td><p><code>Apache-CGI<br>CGI-Application<br>CGI-ArgChecker</code></p></td>
  799.     </tr>
  800.     <tr>
  801.         <td colspan="5" bgcolor="#000000"></td>
  802.     </tr>
  803.     <tr valign="top">
  804.         <td width="20%"><p><code>search CGI*</code></p></td>
  805.         <td width="10%"></td>
  806.         <td><p>Search for 'CGI' at beginning of name</p></td>
  807.         <td width="10%"></td>
  808.         <td><p><code>CGI-Application<br>CGI-ArgChecker</code></p></td>
  809.     </tr>
  810.     <tr>
  811.         <td colspan="5" bgcolor="#000000"></td>
  812.     </tr>
  813.     <tr valign="top">
  814.         <td width="20%"><p><code>search AUTHOR=smith</code></p></td>
  815.         <td width="10%"></td>
  816.         <td><p>Search for all modules authored by someone with 'smith' in their name or email</p></td>
  817.         <td width="10%"></td>
  818.         <td><p><code>Apache-ProxyPass<br>Business-ISBN</code></p></td>
  819.     </tr>
  820.     <tr>
  821.         <td colspan="5" bgcolor="#000000"></td>
  822.     </tr>
  823.     <tr valign="top">
  824.         <td width="20%"><p><code>search ABSTRACT=compress</code></p></td>
  825.         <td width="10%"></td>
  826.         <td><p>Search for 'compress' anywhere in the abstract</p></td>
  827.         <td width="10%"></td>
  828.         <td><p><code>Apache-GzipChain<br>IO-Zlib</code></p></td>
  829.     </tr>
  830.     <tr>
  831.         <td colspan="5" bgcolor="#000000"></td>
  832.     </tr>
  833.     <tr valign="top">
  834.         <td width="20%"><p><code>search CGI or ABSTRACT=web</code></p></td>
  835.         <td width="10%"></td>
  836.         <td><p>Search for 'CGI' in the name, or 'web' in the abstract</p></td>
  837.         <td width="10%"></td>
  838.         <td><p><code>CGI-XMLForm<br>HTML-Clean</code></p></td>
  839.     </tr>      
  840.     <tr>
  841.         <td colspan="5" bgcolor="#000000"></td>
  842.     </tr>
  843.     <tr valign="top">
  844.         <td width="20%"><p><code>search XML and (parser or ABSTRACT=pars) and not XPath</code></p></td>
  845.         <td width="10%"></td>
  846.         <td><p>Search for 'XML' in the name and either 'parser' in the name or 'pars' in the abstract, but not with 'XPath' in the name</p></td>
  847.         <td width="10%"></td>
  848.         <td><p><code>XML-Node<br>XML-Parser-EasyTree</code></p></td>
  849.     </tr>      
  850.     <tr>
  851.         <td colspan="5" bgcolor="#000000"></td>
  852.     </tr>
  853.     <tr valign="top">
  854.         <td width="20%"><p><code>search Data::Grove</code></p></td>
  855.         <td width="10%"></td>
  856.         <td><p>PPM Server 3.0 repositories only: Search by module name, even if unrelated to the containing package</p></td>
  857.         <td width="10%"></td>
  858.         <td><p><code>libxml-perl</code></p></td>
  859.     </tr>      
  860.     <tr>
  861.         <td colspan="5" bgcolor="#000000"></td>
  862.     </tr>
  863.     <tr valign="top">
  864.         <td width="20%"><p><code>search *</code></p></td>
  865.         <td width="10%"></td>
  866.         <td><p>Browse all packages in the repository</p></td>
  867.         <td></td>
  868.         <td><p><code>Affix-Infix2Postfix<br>AI-Fuzzy<br>AI-NeuralNet-BackProp<br></code><em>[... 1700+ more]</em></p></td>
  869.     </tr>
  870.     <tr>
  871.         <td colspan="5" bgcolor="#000000"></td>
  872.     </tr>
  873. </table>
  874. </blockquote>
  875.  
  876. <p>You can recall previous searches with the <code>search <number></code> command, as PPM stores past searches.
  877.  
  878. </PPM3-HELP>
  879.     
  880. <PPM3-HELP name="settings">
  881. <h3><a name="settings">Settings</a></h3>
  882.     
  883. <blockquote>    
  884. <table>
  885.     <tr>
  886.     <td><p>settings</td>
  887.     <td valign="top" align="left" width="10%"></td>
  888.     <td><p>displays current options</td>
  889.     </tr>
  890.     <tr>
  891.     <td><p>settings <name></td>
  892.     <td valign="top" align="left" width="10%"></td>
  893.     <td><p>displays the current setting of the given <name></td>
  894.     </tr>
  895.     <tr>
  896.     <td><p>settings <name> <value></td>
  897.     <td valign="top" align="left" width="10%"></td>
  898.     <td><p>sets <name> to <value></td>
  899.     </tr>
  900. </table>
  901. </blockquote>
  902.     
  903. <p>The settings command gives you access to the different options that PPM has available. This can
  904.  be modified to better suit your needs when using PPM.</p>
  905.  
  906. <p>Available settings:</p>
  907.  
  908. <blockquote>
  909. <table>
  910.     <tr>
  911.     <td align="left" width="15%"><p>NAME</td>
  912.     <td valign="top" align="left" width="10%"></td>
  913.     <td align="left" width="08%"><p>VALUE</td>
  914.         <td valign="top" align="left" width="10%"></td>
  915.     <td align="left"><p>DESCRIPTION</td>
  916.     </tr>
  917.     <tr>    
  918.     <td colspan="5" bgcolor="#000000"></td>
  919.     </tr>
  920.     <tr>
  921.     <td><p>case-sensitivity</td>
  922.     <td valign="top" align="left" width="10%"></td>
  923.     <td><p>"0" or "1"</td>
  924.     <td valign="top" align="left" width="10%"></td>
  925.     <td><p>If set to "1", searches and queries are case-sensitive.</td>
  926.     </tr>
  927.     <tr>    
  928.     <td colspan="5" bgcolor="#000000"></td>
  929.     </tr>
  930.     <tr>
  931.     <td><p>download-chunksize</td>
  932.     <td valign="top" align="left" width="10%"></td>
  933.     <td><p>integer</td>
  934.         <td valign="top" align="left" width="10%"></td>
  935.     <td><p>If this is set to a positive, non-zero integer, PPM updates the status after each "integer"
  936.     of bytes transferred during an install or upgrade.</td>
  937.     </tr>
  938.     <tr>    
  939.     <td colspan="5" bgcolor="#000000"></td>
  940.     </tr>
  941.     <tr>
  942.     <td><p>follow-install</td>
  943.     <td valign="top" align="left" width="10%"></td>
  944.     <td><p>"0" or "1"</td>
  945.         <td valign="top" align="left" width="10%"></td>
  946.     <td><p>See <a class="doc" href="#install">install</a> for details.</td>
  947.     </tr>
  948.     <tr>    
  949.     <td colspan="5" bgcolor="#000000"></td>
  950.     </tr>
  951.     <tr>
  952.     <td><p>force-install</td>
  953.     <td valign="top" align="left" width="10%"></td>
  954.     <td><p>"0" or "1"</td>
  955.         <td valign="top" align="left" width="10%"></td>
  956.     <td><p>See <a class="doc" href="#install">install</a> for details.</td>
  957.     </tr>
  958.     <tr>    
  959.     <td colspan="5" bgcolor="#000000"></td>
  960.     </tr>
  961.     <tr>
  962.     <td><p>page-lines</td>
  963.     <td valign="top" align="left" width="10%"></td>
  964.     <td><p>integer</td>
  965.         <td valign="top" align="left" width="10%"></td>
  966.     <td><p>The number of lines to display per page. If a result has fewer than "page-lines", it will be printed
  967.     directly to the screen regardless of the "pager" setting.</td>
  968.     </tr>
  969.     <tr>    
  970.     <td colspan="5" bgcolor="#000000"></td>
  971.     </tr>
  972.     <tr>
  973.     <td><p>pager</td>
  974.     <td valign="top" align="left" width="10%"></td>
  975.     <td><p>path</td>
  976.         <td valign="top" align="left" width="10%"></td>
  977.     <td><p>The path to an external pager program used to page long displays. If left blank, the internal pager is used.</td>
  978.     </tr>
  979.     <tr>    
  980.     <td colspan="5" bgcolor="#000000"></td>
  981.     </tr>
  982.     <tr>
  983.     <td><p>prompt-context</td>
  984.     <td valign="top" align="left" width="10%"></td>    
  985.     <td><p>"0" or "1"</td>
  986.     <td valign="top" align="left" width="10%"></td>
  987.     <td><p>If "1", enables the prompt to change based on the current state of PPM, i.e. showing current target, query, etc.
  988.     </tr>
  989.     <tr>    
  990.     <td colspan="5" bgcolor="#000000"></td>
  991.     </tr>
  992.     <tr>
  993.     <td><p>prompt-slotsize</td>
  994.     <td valign="top" align="left" width="10%"></td>
  995.     <td><p>integer</td>
  996.         <td valign="top" align="left" width="10%"></td>
  997.     <td><p>If prompt-verbose is "1", this defines the width of each slot in the prompt. For instance, "4" means to
  998.     use 4 character-wide slots.</td>
  999.     </tr>
  1000.     <tr>    
  1001.     <td colspan="5" bgcolor="#000000"></td>
  1002.     </tr>
  1003.     <tr>
  1004.     <td><p>prompt-verbose</td>
  1005.         <td valign="top" align="left" width="10%"></td>
  1006.     <td><p>"0" or "1"</td>
  1007.     <td valign="top" align="left" width="10%"></td>
  1008.     <td><p>If "0", uses numbers to represent the context in the prompt; much shorter. If prompt-context is set
  1009.     to "0", there will be no visible difference in the prompt-verbose settings.</td>
  1010.     </tr>
  1011.     <tr>    
  1012.     <td colspan="5" bgcolor="#000000"></td>
  1013.     </tr>
  1014.     <tr>
  1015.     <td><p>sort-field</td>
  1016.     <td valign="top" align="left" width="10%"></td>
  1017.     <td><p>field</td>
  1018.     <td valign="top" align="left" width="10%"></td>
  1019.     <td><p>The field by which to sort search and query results. Valid fields are ABSTRACT, NAME or TITLE, AUTHOR and VERSION.
  1020.     Note: these fields are case-sensitive.</td>
  1021.     </tr>
  1022.     <tr>    
  1023.     <td colspan="5" bgcolor="#000000"></td>
  1024.     </tr>
  1025.     <tr>
  1026.     <td><p>tempdir</td>
  1027.         <td valign="top" align="left" width="10%"></td>
  1028.     <td><p>path</td>
  1029.     <td valign="top" align="left" width="10%"></td>
  1030.     <td><p>A temporary directory into which packages are downloaded and expanded during "install" and "upgrade".</td>
  1031.     </tr>
  1032.     <tr>    
  1033.     <td colspan="5" bgcolor="#000000"></td>
  1034.     </tr>
  1035.     <tr>
  1036.     <td><p>trace-file</td>
  1037.         <td valign="top" align="left" width="10%"></td>
  1038.     <td><p>path</td>
  1039.     <td valign="top" align="left" width="10%"></td>
  1040.     <td><p>A file to which PPM will write tracing information.</td>
  1041.     </tr>
  1042.     <tr>    
  1043.     <td colspan="5" bgcolor="#000000"></td>
  1044.     </tr>
  1045.     <tr>
  1046.     <td><p>trace-level</td>
  1047.         <td valign="top" align="left" width="10%"></td>
  1048.     <td><p>integer</td>
  1049.     <td valign="top" align="left" width="10%"></td>
  1050.     <td><p>If 0 or negative, tracing is disabled. Any positive integer
  1051.     results in tracing information. Higher numbers mean more tracing
  1052.     information.</td>
  1053.     </tr>
  1054.     <tr>    
  1055.     <td colspan="5" bgcolor="#000000"></td>
  1056.     </tr>
  1057. </table>
  1058. </blockquote>
  1059.     
  1060. <p>PPM options: If you are looking for old options understood by previous version of PPM, please see
  1061.  "help ppm_migration".
  1062.  
  1063. <p>Note: When you assign a value, PPM saves its configuration. That means all values automatically
  1064. persist across sessions. Also, setting names may be abbreviated to uniqueness. Instead of
  1065. typing "case-sensitivity", you may type "case".
  1066. </PPM3-HELP>
  1067.     
  1068. <PPM3-HELP name="target">
  1069. <h3><a name="target">Target</a></h3>
  1070.     
  1071. <blockquote>
  1072. <table>
  1073.     <tr>
  1074.     <td><p>target</td>
  1075.     <td valign="top" align="left" width="10%"></td> 
  1076.     <td><p>Displays a list of targets</td>
  1077.     </tr>
  1078.     <tr>
  1079.     <td><p>target <number></td>
  1080.     <td valign="top" align="left" width="10%"></td>
  1081.     <td><p>Sets <number> as default target</td>
  1082.     </tr>
  1083.     <tr>
  1084.     <td><p>target describe [number]</td>
  1085.     <td valign="top" align="left" width="10%"></td>
  1086.     <td><p>Describes the given (or default) target</td>
  1087.     </tr>
  1088.     <tr>
  1089.     <td><p>target set <key> <val></td>
  1090.     <td valign="top" align="left" width="10%"></td>
  1091.     <td><p>Sets the target's <key> to <val></td>
  1092.     </tr>
  1093. </table>
  1094. </blockquote>
  1095.     
  1096. <p>A target is a location where packages are installed, a directory where the packages you want
  1097.  to install are placed when they're downloaded from the repository. For example, entering:</p>
  1098.  
  1099. <pre>target</pre>
  1100.  
  1101. <p>will return:</p>
  1102.  
  1103. <pre>
  1104. Targets:
  1105.   1. ActivePerl 618
  1106. * 2. ActivePerl 630
  1107. </pre>
  1108.  
  1109. <p>This shows us that we have 2 targets available to us and that the second target (ActivePerl 630) is
  1110. currently the default, as noted by the asterisk. The ability to choose different targets allows
  1111.  PPM to manage several installations of Perl from one command-line.</p>
  1112.  
  1113. <p>Note: Currently, PPM only supports Perl but will be expanded for other languages in the near
  1114.  future. You can have several versions of Perl on your system and each version will be
  1115.  recognized as a unique target by PPM.
  1116. </PPM3-HELP>
  1117.  
  1118. <PPM3-HELP name="tree">
  1119. <h3><a name="tree">Tree</a></h3>
  1120.  
  1121. <blockquote>
  1122. <table>
  1123.     <tr>
  1124.     <td><p>tree</td>
  1125.     <td valign="top" align="left" width="10%"></td>
  1126.     <td><p>displays the dependency-tree of the default package</td>
  1127.     </tr>
  1128.     <tr>
  1129.     <td><p>tree <number></td>
  1130.     <td valign="top" align="left" width="10%"></td>
  1131.     <td><p>displays the dependency-tree of the given <number></td>
  1132.     </tr>
  1133.     <tr>
  1134.     <td><p>tree <range></td>
  1135.     <td valign="top" align="left" width="10%"></td>
  1136.     <td><p>displays a <range> of dependency trees</td>
  1137.     </tr>
  1138.     <tr>
  1139.     <td><p>tree <name></td>
  1140.     <td valign="top" align="left" width="10%"></td>
  1141.     <td><p>displays the dependency-tree of the named package</td>
  1142.     </tr>
  1143. </table>
  1144. </blockquote>
  1145.  
  1146. <p>The <code>tree</code> command is used to show the what is known as the "dependncy tree" of a given package. That is,
  1147. a list of additional packages that are required to make a given package perform as expected. For example, entering:
  1148.     
  1149. <pre>
  1150. tree SOAP-lite
  1151. </pre>
  1152.     
  1153. <p>would return something that looks like this:
  1154.     
  1155. <pre>
  1156. ====================
  1157. SOAP-Lite 0.46
  1158.     |__MIME-tools 5.316
  1159.     |   |__MailTools 1.15
  1160.     |   \__IO-stringy 1.216
  1161.     |
  1162.     \__MIME-Lite 2.105
  1163. ====================
  1164. </pre>
  1165.  
  1166. <p>As we can see, SOAP-Lite would require 4 other packages to be installed with it.
  1167.  
  1168. <p>When <code>tree</code> is called without a <name> or <number>, <code>tree</code> will return the
  1169. dependency tree of the first package in the default search result. If there is no default search, you will be requested to
  1170. use <a class="doc" href="#search">search</a> to find a package.
  1171. </PPM3-HELP>
  1172.  
  1173. <PPM3-HELP name="uninstall">
  1174. <h3><a name="uninstall">Uninstall</a></h3>
  1175.  
  1176. <blockquote>
  1177. <table>
  1178.     <tr>
  1179.     <td><p>uninst</td>
  1180.     <td valign="top" align="left" width="10%"></td>
  1181.     <td><p>Removes default installed package</td>
  1182.     </tr>
  1183.     <tr>
  1184.     <td><p>uninst <number></td>
  1185.     <td valign="top" align="left" width="10%"></td>
  1186.     <td><p>Removes installed package <number></td>
  1187.     </tr>
  1188.     <tr>
  1189.     <td><p>uninst <range></td>
  1190.     <td valign="top" align="left" width="10%"></td>
  1191.     <td><p>Removes a <range> of installed packages</td>
  1192.     </tr>
  1193.     <tr>
  1194.     <td><p>uninst <name></td>
  1195.     <td valign="top" align="left" width="10%"></td>
  1196.     <td><p>Removes named installed package</td>
  1197.     </tr>
  1198. </table>
  1199. </blockquote>
  1200.     
  1201. <p>Like the <a class="doc" href="#remove">remove</a> command, <code>uninstall</code> enables you to delete installed
  1202. packages. This can be done by name or by the numerical listing of packages. Also like the remove command, uninstalling any
  1203. packages will clear all previous query requests.
  1204.     
  1205. <p>See Also: <a class="doc" href="#remove">Remove</a>
  1206. </PPM3-HELP>
  1207.     
  1208. <PPM3-HELP name="upgrade">
  1209. <h3><a name="upgrade">Upgrade</a></h3>
  1210.     
  1211. <blockquote>
  1212. <table>
  1213.     <tr>
  1214.     <td><p>upgrade [*]</td>
  1215.         <td valign="top" align="left" width="10%"></td>
  1216.     <td><p>Lists upgrades available for all installed packages</td>
  1217.     </tr>
  1218.     <tr>
  1219.         <td><p>upgrade <number></td>
  1220.         <td valign="top" align="left" width="10%"></td>
  1221.     <td><p>Upgrades installed package <number></td>
  1222.     </tr>
  1223.     <tr>
  1224.         <td><p>upgrade <range></td>
  1225.         <td valign="top" align="left" width="10%"></td>
  1226.     <td><p>Upgrades a <range> of installed packages</td>
  1227.     </tr>
  1228.     <tr>
  1229.     <td><p>upgrade <package></td>
  1230.         <td valign="top" align="left" width="10%"></td>
  1231.     <td><p>Upgrades the named <package></td>
  1232.     </tr>
  1233. </table>
  1234. </blockquote>
  1235.     
  1236. <p>There are several modifiers to the upgrade command, as well:</p>
  1237.  
  1238. <blockquote>
  1239. <table>
  1240.     <tr>
  1241.     <td align="left"><p>OPTION</td>
  1242.     <td valign="top" align="left" width="10%"></td>
  1243.     <td align="left"><p>DESCRIPTION</td>
  1244.     </tr>
  1245.     <tr>    
  1246.     <td colspan="5" bgcolor="#000000"></td>
  1247.     </tr>
  1248.     <tr>
  1249.     <td><p>Install</td>
  1250.         <td valign="top" align="left" width="10%"></td>
  1251.     <td><p>Installs, rather than lists, available upgrades</td>
  1252.     </tr>
  1253.     <tr>    
  1254.     <td colspan="5" bgcolor="#000000"></td>
  1255.     </tr>
  1256.     <tr>
  1257.     <td><p>Precious</td>
  1258.         <td valign="top" align="left" width="10%"></td>
  1259.     <td><p>Allows upgrading of "precious" packages</td>
  1260.     </tr>
  1261.     <tr>    
  1262.     <td colspan="5" bgcolor="#000000"></td>
  1263.     </tr>
  1264.     <tr>
  1265.     <td><p>Force</td>
  1266.         <td valign="top" align="left" width="10%"></td>
  1267.     <td><p>See <a class="doc" href="#install">install</a></td>
  1268.     </tr>
  1269.     <tr>    
  1270.     <td colspan="5" bgcolor="#000000"></td>
  1271.     </tr>
  1272.     <tr>
  1273.     <td><p>Follow</td>
  1274.     <td valign="top" align="left" width="10%"></td>
  1275.     <td><p>See <a class="doc" href="#install">install</a></td>
  1276.     </tr>
  1277.     <tr>    
  1278.     <td colspan="5" bgcolor="#000000"></td>
  1279.     </tr>
  1280. </table>
  1281. </blockquote>
  1282.  
  1283. <p>By default, <code>upgrade</code> typed by itself only lists the available upgrades. To actually install all available
  1284. upgrades, enter:
  1285.  
  1286. <pre>
  1287. upgrade -install
  1288. </pre>
  1289.     
  1290. <p>To enable upgrading "precious" packages, type:
  1291.     
  1292. <pre>
  1293. upgrade -install -precious
  1294. </pre>
  1295.     
  1296. </PPM3-HELP>
  1297.     
  1298. <PPM3-HELP name="version">
  1299. <h3><a name="version">Version</a></h3>
  1300.  
  1301. <blockquote>
  1302. <table>
  1303.     <tr>
  1304.     <td><p>Version</td>
  1305.     <td valign="top" align="left" width="10%"></td>
  1306.     <td><p>displays the installed PPM version number.</td>
  1307.     </tr>
  1308. </table>
  1309. </blockquote>
  1310. </PPM3-HELP>
  1311.  
  1312. <h2><a name="ppm2_commands">PPM version 2 Commands</a></h4>
  1313.  
  1314. <p>A summary of PPM version 2 commands is shown below.  Type <code>help
  1315. <command></code> at the PPM prompt for usage details. Items in [brackets] 
  1316. are optional.</p>
  1317.  
  1318. <table cellpadding="5">
  1319.   <tr>
  1320.     <td><font color="#b82619"><b>Command</b></font></td>
  1321.     <td><font color="#b82619"><b>Function</b></font></td>
  1322.   </tr>
  1323.   <tr>
  1324.     <td><b>genconfig</b></td>
  1325.     <td>prints a minimal PPM configuration file to STDOUT
  1326.       [Note: genconfig only works from the command-line]</td>
  1327.   </tr>
  1328.   <tr>
  1329.     <td><b>help [command]</b></td>
  1330.     <td>lists available commands, or help on 'command'.</td>
  1331.   </tr>
  1332.   <tr>
  1333.     <td><b>install package1 [package2...]</b></td>
  1334.     <td>installs specified packages.</td>
  1335.   </tr>
  1336.   <tr>
  1337.     <td><b>quit</b></td>
  1338.     <td>exits the program.</td>
  1339.   </tr>
  1340.   <tr>
  1341.     <td><b>query [pattern]</b></td>
  1342.     <td>lists installed packages, or packages containing <code>pattern</code>.</td>
  1343.   </tr>
  1344.   <tr>
  1345.     <td><b>query /abstract [pattern]</b></td>
  1346.     <td>lists descriptions of installed packages, or package
  1347.       descriptions containing <code>pattern</code>.</td>
  1348.   </tr>
  1349.   <tr>
  1350.     <td><b>remove package1 [package2...]</b></td>
  1351.     <td>removes the specified packages from the system.</td>
  1352.   </tr>
  1353.   <tr>
  1354.     <td><b>search [pattern]</b></td>
  1355.     <td>lists available packages, or packages containing <code>pattern</code>.</td>
  1356.   </tr>
  1357.   <tr>
  1358.     <td><b>search /abstract [pattern]</b></td>
  1359.     <td>lists descriptions of available packages, or package
  1360.       descriptions containing <code>pattern</code>.</td>
  1361.   </tr>
  1362.   <tr>
  1363.     <td><b>set</b></td>
  1364.     <td>set/display current options.</td>
  1365.   </tr>
  1366.   <tr>
  1367.     <td><b>set save</b></td>
  1368.     <td>save current options.</td>
  1369.   </tr>
  1370.   <tr>
  1371.     <td><b>verify [package1...]</b></td>
  1372.     <td>verifies currently installed packages are up to date.</td>
  1373.   </tr>
  1374.   <tr>
  1375.     <td><b>verify /upgrade [package1...]</b></td>
  1376.     <td>installs available package upgrades.</td>
  1377.   </tr>
  1378.   <tr>
  1379.     <td><b>version</b></td>
  1380.     <td>displays the PPM version number</td>
  1381.   </tr>
  1382. </table>
  1383. <p>A pattern is a search string just like the regular expressions - for example
  1384. if you search for with this command</p>
  1385. <blockquote>
  1386.   <p><code>search ODBC|DBI</code></p>
  1387. </blockquote>
  1388. <p>(which means <i>'search for packages in which the characters ODBC and/or the
  1389. characters DBI are present in that order'</i>) you get a result like this</p>
  1390. <blockquote>
  1391.   <p>Apache-DBI<br>
  1392.   DBD-ODBC<br>
  1393.   DBI<br>
  1394.   FindBin<br>
  1395.   Win32-ODBC</p>
  1396. </blockquote>
  1397. <p>Note that if you use <code>'search /abstract [pattern]' </code>the search will only
  1398. include the ABSTRACT section of the package files.</p>
  1399.  
  1400. <h2><a name="repositories">Where are the package repositories?</a></h2>
  1401. <p>By default, PPM will use the ActiveState package repository, but there are
  1402. other repositories on the Internet. At the moment there are these repositories:</p>
  1403.     
  1404. <p><b>Note: most of these repositories are for ActivePerl 5xx builds only; they
  1405. may not be compatible with ActivePerl 6xx builds. Check these repositories for the latest updates:</b></p>
  1406.     
  1407. <blockquote>
  1408.   <table cellspacing="10">
  1409.     <tr>
  1410.       <td valign="top" align="left" width="50%">http://ppm-ia.ActiveState.com/PPM/ppmserver.plex?urn:/PPM/Server/SQL</td>
  1411.       <td valign="top" align="left" width="50%">New 3.0 Repository
  1412.         from ActiveState</td>
  1413.     </tr>
  1414.     <tr>
  1415.       <td valign="top" align="left" width="50%">http://www.ActiveState.com/cgibin/PPM/ppmserver.plex?urn:/PPMServer</td>
  1416.       <td valign="top" align="left" width="50%">The default package repository from ActiveState</td>
  1417.     </tr>
  1418.     <tr>
  1419.       <td valign="top" align="left" width="50%">http://theoryx5.uwinnipeg.ca/cgi-bin/ppmserver?urn:/PPMServer</td>
  1420.       <td valign="top" align="left" width="50%">University of Winnipeg</td>
  1421.     </tr>
  1422.     <tr>
  1423.       <td valign="top" align="left" width="50%">http://Jenda.Krynicky.cz/perl</td>
  1424.       <td valign="top" align="left" width="50%">Jan Krynicky's package
  1425.         repository</td>
  1426.     </tr>
  1427.     <tr>
  1428.       <td valign="top" align="left" width="50%">http://www.roth.net/perl/packages/</td>
  1429.       <td valign="top" align="left" width="50%">Roth Consulting's package
  1430.         repository</td>
  1431.     </tr>
  1432.     <tr>
  1433.       <td valign="top" align="left" width="50%">http://www.xray.mpe.mpg.de/~ach/ptk/ppm</td>
  1434.       <td valign="top" align="left" width="50%">Achim Bohnet's package
  1435.         repository</td>
  1436.     </tr>
  1437.     <tr>
  1438.       <td valign="top" align="left" width="50%">http://rto.dk/packages/</td>
  1439.       <td valign="top" align="left" width="50%">RTO's packages repository
  1440.         (mostly mirrors of the above)</td>
  1441.     </tr>
  1442.     <tr>
  1443.       <td colspan="2">
  1444.         <hr width="50%">
  1445.       </td>
  1446.     </tr>
  1447.     <tr>
  1448.       <td valign="top" align="left" width="50%">http://www.fastnetltd.ndirect.co.uk/Perl/zips/</td>
  1449.       <td valign="top" align="left" width="50%">Fastnet Software Ltd's packages
  1450.         - not directly accessible from PPM at present</td>
  1451.     </tr>
  1452.   </table>
  1453. </blockquote>
  1454.  
  1455. <h4>For PPM3 users</h4>
  1456. <p>To use these package repositories you start PPM3 and at the prompt type:</p>
  1457.     
  1458. <pre>
  1459. repository add <i>NAME</i> <i>URL</i>
  1460. </pre>
  1461.     
  1462. <p>where <i>NAME</i> is a name by which you want to reference the repository
  1463. from PPM and <i>URL</i> is the URL to the repository. Please note that <i>NAME</i> is
  1464. optional, as PPM will assign a name to the repository for you. For example, entering:</p>
  1465.  
  1466. <pre>
  1467. repository add JENDA http://Jenda.Krynicky.cz/perl
  1468. </pre>
  1469.  
  1470. <p>will create a repository for you, by the name of JENDA and give you access to the modules
  1471. available there.</p>
  1472.  
  1473. <h4>For PPM users</h4>
  1474. <p>To use these package repositories you start PPM and at the prompt type</p>
  1475. <pre>
  1476. set repository <i>NAME</i> <i>URL</i>
  1477. </pre>
  1478.     
  1479. <p>where <i>NAME</i> is a name by which you want to reference the repository
  1480. from PPM and <i>URL</i> is the URL to the repository. You could for example type</p>
  1481.  
  1482. <pre>
  1483. set repository JENDA http://Jenda.Krynicky.cz/perl
  1484. </pre>
  1485.  
  1486. <p>The next time you do a 'search' you will not only search the ActiveState
  1487. package repository but also the repositories you have added. Before you exit PPM
  1488. you should save the changes to the configuration by issuing the command 'set
  1489. save'.</p>
  1490.  
  1491. <h2><a name="how_to_make_ppm_distribution">How do I make a PPM package?</a></h2>
  1492. <p>If you want to make a PPM package for use on other machine you can do it like
  1493. this:</p>
  1494. <p>Specify the AUTHOR and ABSTRACT parameters in the Makefile.PL. However you
  1495. should only pass them to WriteMakefile if the version of the perl is greater
  1496. than 5.005 - older perls do not have these parameters added and do not expect to
  1497. see them. This is an example Makefile.PL:</p>
  1498. <blockquote>
  1499.   <p><code>use ExtUtils::MakeMaker;<br>
  1500.   # See lib/ExtUtils/MakeMaker.pm for details of how to influence<br>
  1501.   # the contents of the Makefile that is written.<br>
  1502.   WriteMakefile(<br>
  1503.       'NAME' => 'Term::Control',<br>
  1504.       'VERSION_FROM' => 'Control.pm', # finds $VERSION<br>
  1505.       ($] ge '5.005') ? (<br>
  1506.           'AUTHOR' => 'Johnny Doel (johnny@doel.org)',<br>
  1507.           'ABSTRACT' => 'Control the
  1508.   IO for terminals',<br>
  1509.       ) : (),<br>
  1510.   );</code></p>
  1511. </blockquote>
  1512. <p>Then you make the archive with the commands</p>
  1513. <blockquote>
  1514.   <p><code>perl Makefile.PL<br>
  1515.   nmake</code></p>
  1516. </blockquote>
  1517. <p>The resulting files are placed in the blib directory that is created when you
  1518. run nmake. These files should be packed into an archive like this:</p>
  1519. <blockquote>
  1520.   <p><code>tar cvf <i>package</i>.tar blib<br>
  1521.   gzip --best <i>package</i>.tar</code></p>
  1522. </blockquote>
  1523. <p>You now have an archive called <i>package</i>.tar.gz. Then you generate the
  1524. PPD file by:</p>
  1525. <blockquote>
  1526.   <p><code>nmake ppd</code></p>
  1527. </blockquote>
  1528. <p>You have to edit the resulting PPD file and add the location of the package
  1529. archive into <CODEBASE HREF="" />. The location is relative to
  1530. the PPD file.</p>
  1531. <p>You can get nmake from <a class="doc" href="http://download.microsoft.com/download/vc15/Patch/1.52/W95/EN-US/Nmake15.exe">http://download.microsoft.com/download/vc15/Patch/1.52/W95/EN-US/Nmake15.exe</a>.
  1532. </p>
  1533.  
  1534.  
  1535. <h2><a name="ppm_and_proxies">PPM, Proxies and Firewalls</a></h2>
  1536. <p>If you use a proxy server or firewall, you might have trouble running PPM.
  1537. Here is the solution.</p>
  1538. <blockquote>
  1539.   <p><b>NOTE</b>: If none of the changes in this document work for you,
  1540.   you may download individual packages from <a class="doc" href="http://www.activestate.com/PPMpackages/5.6/zips">here
  1541.   [ActivePerl 613 and later]</a> or <a class="doc" href="http://www.activestate.com/PPMpackages/5.005/zips">here
  1542.   [ActivePerl 522 and earlier]</a> and install them according to the directions
  1543.   in the README file contained within the ZIP file. If you want, you can also
  1544.   keep a local repository, with several .ppd files in a permanent repository
  1545.   directory, and their .tar.gz files in an <i>x86</i> directory beneath that.</p>
  1546. </blockquote>
  1547. <ol start="1">
  1548.   <li>
  1549.     <h3>Set Environment Vars</h3>
  1550.   </li>
  1551. </ol>
  1552. <blockquote>
  1553.   <p>Up to three environment variables need to be set.</p>
  1554. </blockquote>
  1555. <blockquote>
  1556.     <p><b>Under Windows 2000</b><br>
  1557.     Right click on "My Computer", click on "Properties" and select the
  1558.     "Advanced" tab. Click the button marked "Environment Variables"
  1559.     and make the following changes in the "System Variables" window:<br></p>
  1560.     <ol>
  1561.     <li>With the "New" button, add the setting <i>HTTP_proxy</i>, with your proxy name as the
  1562.     value (you must include "<code>http://</code>"), followed by a colon and
  1563.       the proxy port, if applicable; e.g., "<code>http://proxy:8080</code>"</li>
  1564.     <li>If you require a user name and/or password to access your proxy, use the "New" button
  1565.     to add the settings <i>HTTP_proxy_user</i> and <i>HTTP_proxy_pass</i>, with your user name and
  1566.       password as the respective values.</li>
  1567.     </ol>
  1568. </blockquote>
  1569. <blockquote>
  1570.   <p><strong>Under Windows NT<br>
  1571.   </strong>Right click on "My Computer", click on
  1572.   "Properties", select the "Environment" tab. These are your
  1573.   environment settings. Make the following changes:<br></p>
  1574.   <ol>
  1575.     <li>Add the setting <i>HTTP_proxy</i>, with your proxy name as the value (you
  1576.       must include "<code>http://</code>"), followed by a colon and
  1577.       the proxy port, if applicable; e.g., "<code>http://proxy:8080</code>"</li>
  1578.     <li>If you require a user name and/or password to access your proxy, add the
  1579.       settings <i>HTTP_proxy_user</i> and <i>HTTP_proxy_pass</i>, with your user name and
  1580.       password as the respective values.</li>
  1581.     </ol>
  1582. </blockquote>
  1583. <blockquote>
  1584.   <p><strong>Under Windows 9x<br></strong>
  1585.   In your AUTOEXEC.BAT file, place the following lines then reboot so the changes can take effect:</p>
  1586. </blockquote>
  1587. <blockquote>
  1588.   <ol>
  1589.     <li>SET HTTP_proxy=<your proxy server (you must include
  1590.       "<code>http://</code>", followed by a colon and the proxy
  1591.       port, if applicable; e.g., <code>SET HTTP_proxy=http://proxy:8080</code></li>
  1592.     <li>SET HTTP_proxy_user=<your user name> (if required)</li>
  1593.     <li>SET HTTP_proxy_pass=<your password> (if required)</li>
  1594.   </ol>
  1595. </blockquote>
  1596. <ol start="2">
  1597.   <li>
  1598.     <h3>Try using PPM</h3>
  1599.   </li>
  1600. </ol>
  1601. <blockquote>
  1602.   <p>With your internet connection active, try using PPM again. Try to install a
  1603.   small package, like File-Slurp. You'll know that it still fails if you see an
  1604.   error stating that it can't find a ppd file for the specified package.</p>
  1605. </blockquote>
  1606. <ol start="3">
  1607.   <li>
  1608.     <h3>Further Information and Help</h3>
  1609.   </li>
  1610. </ol>
  1611. <blockquote>
  1612.   <p>If there were problems with any of the above hints, please see 
  1613.   <a class="doc" href="../readme.html#Troubleshooting_FAQ">Troubleshooting</a>
  1614.   for information regarding further help.</p>
  1615. </blockquote>
  1616.  
  1617. <h2><a name="AUTHOR_AND_COPYRIGHT">AUTHOR AND COPYRIGHT</a></h2>
  1618. <p>This FAQ was originally assembled and maintained by Evangelo Prodromou. It
  1619. has been revised and updated by Brian Jepson of O'Reilly & Associates, David
  1620. Grove, David Dmytryshyn, and Murray Nesbitt of ActiveState, Henning Michael M°ller-Nielsen
  1621. of RTO, Kevin Meltzer, and David Sparks of ActiveState.</p>
  1622. <p>This FAQ is in the public domain. If you use it, however, please ensure that
  1623. you give credit to the original authors.</p>
  1624.  
  1625. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  1626.   <tr>
  1627.     <td class="block" valign="MIDDLE" width="100%" bgcolor="#cccccc"><strong>
  1628.       <p class="block"> ActivePerl FAQ - PPM</p>
  1629.       </strong></td>
  1630.   </tr>
  1631. </table>
  1632.  
  1633. </body>
  1634.  
  1635. </html>
  1636.