local-lib5/man/man1/cpan.1p

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "CPAN 1"
 132 .TH CPAN 1 "2009-03-13" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 cpan \- easily interact with CPAN from the command line
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 2
 138 \&        # with arguments and no switches, installs specified modules
 139 \&        cpan module_name [ module_name ... ]
 140 .Ve
 141 .PP
 142 .Vb 2
 143 \&        # with switches, installs modules with extra behavior
 144 \&        cpan [\-cfimt] module_name [ module_name ... ]
 145 .Ve
 146 .PP
 147 .Vb 2
 148 \&        # without arguments, starts CPAN.pm shell
 149 \&        cpan
 150 .Ve
 151 .PP
 152 .Vb 2
 153 \&        # without arguments, but some switches
 154 \&        cpan [\-ahrvACDLO]
 155 .Ve
 156 .SH "DESCRIPTION"
 157 .IX Header "DESCRIPTION"
 158 This script provides a command interface (not a shell) to \s-1CPAN\s0. At the
 159 moment it uses \s-1CPAN\s0.pm to do the work, but it is not a one-shot command
 160 runner for \s-1CPAN\s0.pm.
 161 .Sh "Meta Options"
 162 .IX Subsection "Meta Options"
 163 These options are mutually exclusive, and the script processes them in
 164 this order: [hvCAar].  Once the script finds one, it ignores the others,
 165 and then exits after it finishes the task.  The script ignores any other
 166 command line options.
 167 .IP "\-a" 4
 168 .IX Item "-a"
 169 Creates the \s-1CPAN\s0.pm autobundle with CPAN::Shell\->autobundle.
 170 .IP "\-A module [ module ... ]" 4
 171 .IX Item "-A module [ module ... ]"
 172 Shows the primary maintainers for the specified modules
 173 .IP "\-C module [ module ... ]" 4
 174 .IX Item "-C module [ module ... ]"
 175 Show the \f(CW\*(C`Changes\*(C'\fR files for the specified modules
 176 .IP "\-D module [ module ... ]" 4
 177 .IX Item "-D module [ module ... ]"
 178 Show the module details. This prints one line for each out-of-date module
 179 (meaning, modules locally installed but have newer versions on \s-1CPAN\s0).
 180 Each line has three columns: module name, local version, and \s-1CPAN\s0
 181 version.
 182 .IP "\-L author [ author ... ]" 4
 183 .IX Item "-L author [ author ... ]"
 184 List the modules by the specified authors.
 185 .IP "\-h" 4
 186 .IX Item "-h"
 187 Prints a help message.
 188 .IP "\-O" 4
 189 .IX Item "-O"
 190 Show the out-of-date modules.
 191 .IP "\-r" 4
 192 .IX Item "-r"
 193 Recompiles dynamically loaded modules with CPAN::Shell\->recompile.
 194 .IP "\-v" 4
 195 .IX Item "-v"
 196 Print the script version and \s-1CPAN\s0.pm version.
 197 .Sh "Module options"
 198 .IX Subsection "Module options"
 199 These options are mutually exclusive, and the script processes them in
 200 alphabetical order. It only processes the first one it finds.
 201 .IP "c" 4
 202 .IX Item "c"
 203 Runs a `make clean` in the specified module's directories.
 204 .IP "f" 4
 205 .IX Item "f"
 206 Forces the specified action, when it normally would have failed.
 207 .IP "i" 4
 208 .IX Item "i"
 209 Installed the specified modules.
 210 .IP "m" 4
 211 .IX Item "m"
 212 Makes the specified modules.
 213 .IP "t" 4
 214 .IX Item "t"
 215 Runs a `make test` on the specified modules.
 216 .Sh "Examples"
 217 .IX Subsection "Examples"
 218 .Vb 2
 219 \&        # print a help message
 220 \&        cpan \-h
 221 .Ve
 222 .PP
 223 .Vb 2
 224 \&        # print the version numbers
 225 \&        cpan \-v
 226 .Ve
 227 .PP
 228 .Vb 2
 229 \&        # create an autobundle
 230 \&        cpan \-a
 231 .Ve
 232 .PP
 233 .Vb 2
 234 \&        # recompile modules
 235 \&        cpan \-r
 236 .Ve
 237 .PP
 238 .Vb 2
 239 \&        # install modules ( sole \-i is optional )
 240 \&        cpan \-i Netscape::Booksmarks Business::ISBN
 241 .Ve
 242 .PP
 243 .Vb 2
 244 \&        # force install modules ( must use \-i )
 245 \&        cpan \-fi CGI::Minimal URI
 246 .Ve
 247 .SH "TO DO"
 248 .IX Header "TO DO"
 249 .SH "BUGS"
 250 .IX Header "BUGS"
 251 * none noted
 252 .SH "SEE ALSO"
 253 .IX Header "SEE ALSO"
 254 Most behaviour, including environment variables and configuration,
 255 comes directly from \s-1CPAN\s0.pm.
 256 .SH "SOURCE AVAILABILITY"
 257 .IX Header "SOURCE AVAILABILITY"
 258 This source is part of a SourceForge project which always has the
 259 latest sources in \s-1CVS\s0, as well as all of the previous releases.
 260 .PP
 261 .Vb 1
 262 \&        http://sourceforge.net/projects/brian\-d\-foy/
 263 .Ve
 264 .PP
 265 If, for some reason, I disappear from the world, one of the other
 266 members of the project can shepherd this module appropriately.
 267 .SH "CREDITS"
 268 .IX Header "CREDITS"
 269 Japheth Cleaver added the bits to allow a forced install (\-f).
 270 .PP
 271 Jim Brandt suggest and provided the initial implementation for the
 272 up-to-date and Changes features.
 273 .PP
 274 Adam Kennedy pointed out that \fIexit()\fR causes problems on Windows
 275 where this script ends up with a .bat extension
 276 .SH "AUTHOR"
 277 .IX Header "AUTHOR"
 278 brian d foy, \f(CW\*(C`<bdfoy@cpan.org>\*(C'\fR
 279 .SH "COPYRIGHT"
 280 .IX Header "COPYRIGHT"
 281 Copyright (c) 2001\-2006, brian d foy, All Rights Reserved.
 282 .PP
 283 You may redistribute this under the same terms as Perl itself.