| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "CPAN::FirstTime 3perl" |
| 58 |
.TH CPAN::FirstTime 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide" |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
CPAN::FirstTime \- Utility for CPAN::Config file Initialization |
| 65 |
.SH SYNOPSIS |
| 66 |
.IX Header "SYNOPSIS" |
| 67 |
\&\fBCPAN::FirstTime::init()\fR |
| 68 |
.SH DESCRIPTION |
| 69 |
.IX Header "DESCRIPTION" |
| 70 |
The init routine asks a few questions and writes a CPAN/Config.pm or |
| 71 |
CPAN/MyConfig.pm file (depending on what it is currently using). |
| 72 |
.PP |
| 73 |
In the following all questions and explanations regarding config |
| 74 |
variables are collected. |
| 75 |
.IP allow_installing_module_downgrades 2 |
| 76 |
.IX Item "allow_installing_module_downgrades" |
| 77 |
The CPAN shell can watch the \f(CW\*(C`blib/\*(C'\fR directories that are built up |
| 78 |
before running \f(CW\*(C`make test\*(C'\fR to determine whether the current |
| 79 |
distribution will end up with modules being overwritten with decreasing module version numbers. It |
| 80 |
can then let the build of this distro fail when it discovers a |
| 81 |
downgrade. |
| 82 |
.Sp |
| 83 |
Do you want to allow installing distros with decreasing module |
| 84 |
versions compared to what you have installed (yes, no, ask/yes, |
| 85 |
ask/no)? |
| 86 |
.IP allow_installing_outdated_dists 2 |
| 87 |
.IX Item "allow_installing_outdated_dists" |
| 88 |
The CPAN shell can watch the \f(CW\*(C`blib/\*(C'\fR directories that are built up |
| 89 |
before running \f(CW\*(C`make test\*(C'\fR to determine whether the current |
| 90 |
distribution contains modules that are indexed with a distro with a |
| 91 |
higher distro-version number than the current one. It can |
| 92 |
then let the build of this distro fail when it would not represent the |
| 93 |
most up-to-date version of the distro. |
| 94 |
.Sp |
| 95 |
Note: choosing anything but 'yes' for this option will need |
| 96 |
CPAN::DistnameInfo being installed for taking effect. |
| 97 |
.Sp |
| 98 |
Do you want to allow installing distros that are not indexed as the |
| 99 |
highest distro-version for all contained modules (yes, no, ask/yes, |
| 100 |
ask/no)? |
| 101 |
.IP auto_commit 2 |
| 102 |
.IX Item "auto_commit" |
| 103 |
Normally CPAN.pm keeps config variables in memory and changes need to |
| 104 |
be saved in a separate 'o conf commit' command to make them permanent |
| 105 |
between sessions. If you set the 'auto_commit' option to true, changes |
| 106 |
to a config variable are always automatically committed to disk. |
| 107 |
.Sp |
| 108 |
Always commit changes to config variables to disk? |
| 109 |
.IP build_cache 2 |
| 110 |
.IX Item "build_cache" |
| 111 |
CPAN.pm can limit the size of the disk area for keeping the build |
| 112 |
directories with all the intermediate files. |
| 113 |
.Sp |
| 114 |
Cache size for build directory (in MB)? |
| 115 |
.IP build_dir 2 |
| 116 |
.IX Item "build_dir" |
| 117 |
Directory where the build process takes place? |
| 118 |
.IP build_dir_reuse 2 |
| 119 |
.IX Item "build_dir_reuse" |
| 120 |
Until version 1.88 CPAN.pm never trusted the contents of the build_dir |
| 121 |
directory between sessions. Since 1.88_58 CPAN.pm has a YAML-based |
| 122 |
mechanism that makes it possible to share the contents of the |
| 123 |
build_dir/ directory between different sessions with the same version |
| 124 |
of perl. People who prefer to test things several days before |
| 125 |
installing will like this feature because it saves a lot of time. |
| 126 |
.Sp |
| 127 |
If you say yes to the following question, CPAN will try to store |
| 128 |
enough information about the build process so that it can pick up in |
| 129 |
future sessions at the same state of affairs as it left a previous |
| 130 |
session. |
| 131 |
.Sp |
| 132 |
Store and re-use state information about distributions between |
| 133 |
CPAN.pm sessions? |
| 134 |
.IP build_requires_install_policy 2 |
| 135 |
.IX Item "build_requires_install_policy" |
| 136 |
When a module declares another one as a 'build_requires' prerequisite |
| 137 |
this means that the other module is only needed for building or |
| 138 |
testing the module but need not be installed permanently. In this case |
| 139 |
you may wish to install that other module nonetheless or just keep it |
| 140 |
in the 'build_dir' directory to have it available only temporarily. |
| 141 |
Installing saves time on future installations but makes the perl |
| 142 |
installation bigger. |
| 143 |
.Sp |
| 144 |
You can choose if you want to always install (yes), never install (no) |
| 145 |
or be always asked. In the latter case you can set the default answer |
| 146 |
for the question to yes (ask/yes) or no (ask/no). |
| 147 |
.Sp |
| 148 |
Policy on installing 'build_requires' modules (yes, no, ask/yes, |
| 149 |
ask/no)? |
| 150 |
.IP cache_metadata 2 |
| 151 |
.IX Item "cache_metadata" |
| 152 |
To considerably speed up the initial CPAN shell startup, it is |
| 153 |
possible to use Storable to create a cache of metadata. If Storable is |
| 154 |
not available, the normal index mechanism will be used. |
| 155 |
.Sp |
| 156 |
Note: this mechanism is not used when use_sqlite is on and SQLite is |
| 157 |
running. |
| 158 |
.Sp |
| 159 |
Cache metadata (yes/no)? |
| 160 |
.IP check_sigs 2 |
| 161 |
.IX Item "check_sigs" |
| 162 |
CPAN packages can be digitally signed by authors and thus verified |
| 163 |
with the security provided by strong cryptography. The exact mechanism |
| 164 |
is defined in the Module::Signature module. While this is generally |
| 165 |
considered a good thing, it is not always convenient to the end user |
| 166 |
to install modules that are signed incorrectly or where the key of the |
| 167 |
author is not available or where some prerequisite for |
| 168 |
Module::Signature has a bug and so on. |
| 169 |
.Sp |
| 170 |
With the check_sigs parameter you can turn signature checking on and |
| 171 |
off. The default is off for now because the whole tool chain for the |
| 172 |
functionality is not yet considered mature by some. The author of |
| 173 |
CPAN.pm would recommend setting it to true most of the time and |
| 174 |
turning it off only if it turns out to be annoying. |
| 175 |
.Sp |
| 176 |
Note that if you do not have Module::Signature installed, no signature |
| 177 |
checks will be performed at all. |
| 178 |
.Sp |
| 179 |
Always try to check and verify signatures if a SIGNATURE file is in |
| 180 |
the package and Module::Signature is installed (yes/no)? |
| 181 |
.IP cleanup_after_install 2 |
| 182 |
.IX Item "cleanup_after_install" |
| 183 |
Users who install modules and do not intend to look back, can free |
| 184 |
occupied disk space quickly by letting CPAN.pm cleanup each build |
| 185 |
directory immediately after a successful install. |
| 186 |
.Sp |
| 187 |
Remove build directory after a successful install? (yes/no)? |
| 188 |
.IP colorize_output 2 |
| 189 |
.IX Item "colorize_output" |
| 190 |
When you have Term::ANSIColor installed, you can turn on colorized |
| 191 |
output to have some visual differences between normal CPAN.pm output, |
| 192 |
warnings, debugging output, and the output of the modules being |
| 193 |
installed. Set your favorite colors after some experimenting with the |
| 194 |
Term::ANSIColor module. |
| 195 |
.Sp |
| 196 |
Please note that on Windows platforms colorized output also requires |
| 197 |
the Win32::Console::ANSI module. |
| 198 |
.Sp |
| 199 |
Do you want to turn on colored output? |
| 200 |
.IP colorize_print 2 |
| 201 |
.IX Item "colorize_print" |
| 202 |
Color for normal output? |
| 203 |
.IP colorize_warn 2 |
| 204 |
.IX Item "colorize_warn" |
| 205 |
Color for warnings? |
| 206 |
.IP colorize_debug 2 |
| 207 |
.IX Item "colorize_debug" |
| 208 |
Color for debugging messages? |
| 209 |
.IP commandnumber_in_prompt 2 |
| 210 |
.IX Item "commandnumber_in_prompt" |
| 211 |
The prompt of the cpan shell can contain the current command number |
| 212 |
for easier tracking of the session or be a plain string. |
| 213 |
.Sp |
| 214 |
Do you want the command number in the prompt (yes/no)? |
| 215 |
.IP connect_to_internet_ok 2 |
| 216 |
.IX Item "connect_to_internet_ok" |
| 217 |
If you have never defined your own \f(CW\*(C`urllist\*(C'\fR in your configuration |
| 218 |
then \f(CW\*(C`CPAN.pm\*(C'\fR will be hesitant to use the built in default sites for |
| 219 |
downloading. It will ask you once per session if a connection to the |
| 220 |
internet is OK and only if you say yes, it will try to connect. But to |
| 221 |
avoid this question, you can choose your favorite download sites once |
| 222 |
and get away with it. Or, if you have no favorite download sites |
| 223 |
answer yes to the following question. |
| 224 |
.Sp |
| 225 |
If no urllist has been chosen yet, would you prefer CPAN.pm to connect |
| 226 |
to the built-in default sites without asking? (yes/no)? |
| 227 |
.IP ftp_passive 2 |
| 228 |
.IX Item "ftp_passive" |
| 229 |
Shall we always set the FTP_PASSIVE environment variable when dealing |
| 230 |
with ftp download (yes/no)? |
| 231 |
.IP ftpstats_period 2 |
| 232 |
.IX Item "ftpstats_period" |
| 233 |
Statistics about downloads are truncated by size and period |
| 234 |
simultaneously. |
| 235 |
.Sp |
| 236 |
How many days shall we keep statistics about downloads? |
| 237 |
.IP ftpstats_size 2 |
| 238 |
.IX Item "ftpstats_size" |
| 239 |
Statistics about downloads are truncated by size and period |
| 240 |
simultaneously. Setting this to zero or negative disables download |
| 241 |
statistics. |
| 242 |
.Sp |
| 243 |
How many items shall we keep in the statistics about downloads? |
| 244 |
.IP getcwd 2 |
| 245 |
.IX Item "getcwd" |
| 246 |
CPAN.pm changes the current working directory often and needs to |
| 247 |
determine its own current working directory. Per default it uses |
| 248 |
Cwd::cwd but if this doesn't work on your system for some reason, |
| 249 |
alternatives can be configured according to the following table: |
| 250 |
.Sp |
| 251 |
.Vb 5 |
| 252 |
\& cwd Cwd::cwd |
| 253 |
\& getcwd Cwd::getcwd |
| 254 |
\& fastcwd Cwd::fastcwd |
| 255 |
\& getdcwd Cwd::getdcwd |
| 256 |
\& backtickcwd external command cwd |
| 257 |
.Ve |
| 258 |
.Sp |
| 259 |
Preferred method for determining the current working directory? |
| 260 |
.IP halt_on_failure 2 |
| 261 |
.IX Item "halt_on_failure" |
| 262 |
Normally, CPAN.pm continues processing the full list of targets and |
| 263 |
dependencies, even if one of them fails. However, you can specify |
| 264 |
that CPAN should halt after the first failure. (Note that optional |
| 265 |
recommended or suggested modules that fail will not cause a halt.) |
| 266 |
.Sp |
| 267 |
Do you want to halt on failure (yes/no)? |
| 268 |
.IP histfile 2 |
| 269 |
.IX Item "histfile" |
| 270 |
If you have one of the readline packages (Term::ReadLine::Perl, |
| 271 |
Term::ReadLine::Gnu, possibly others) installed, the interactive CPAN |
| 272 |
shell will have history support. The next two questions deal with the |
| 273 |
filename of the history file and with its size. If you do not want to |
| 274 |
set this variable, please hit SPACE ENTER to the following question. |
| 275 |
.Sp |
| 276 |
File to save your history? |
| 277 |
.IP histsize 2 |
| 278 |
.IX Item "histsize" |
| 279 |
Number of lines to save? |
| 280 |
.IP inactivity_timeout 2 |
| 281 |
.IX Item "inactivity_timeout" |
| 282 |
Sometimes you may wish to leave the processes run by CPAN alone |
| 283 |
without caring about them. Because the Makefile.PL or the Build.PL |
| 284 |
sometimes contains question you're expected to answer, you can set a |
| 285 |
timer that will kill a 'perl Makefile.PL' process after the specified |
| 286 |
time in seconds. |
| 287 |
.Sp |
| 288 |
If you set this value to 0, these processes will wait forever. This is |
| 289 |
the default and recommended setting. |
| 290 |
.Sp |
| 291 |
Timeout for inactivity during {Makefile,Build}.PL? |
| 292 |
.IP index_expire 2 |
| 293 |
.IX Item "index_expire" |
| 294 |
The CPAN indexes are usually rebuilt once or twice per hour, but the |
| 295 |
typical CPAN mirror mirrors only once or twice per day. Depending on |
| 296 |
the quality of your mirror and your desire to be on the bleeding edge, |
| 297 |
you may want to set the following value to more or less than one day |
| 298 |
(which is the default). It determines after how many days CPAN.pm |
| 299 |
downloads new indexes. |
| 300 |
.Sp |
| 301 |
Let the index expire after how many days? |
| 302 |
.IP inhibit_startup_message 2 |
| 303 |
.IX Item "inhibit_startup_message" |
| 304 |
When the CPAN shell is started it normally displays a greeting message |
| 305 |
that contains the running version and the status of readline support. |
| 306 |
.Sp |
| 307 |
Do you want to turn this message off? |
| 308 |
.IP keep_source_where 2 |
| 309 |
.IX Item "keep_source_where" |
| 310 |
Unless you are accessing the CPAN on your filesystem via a file: URL, |
| 311 |
CPAN.pm needs to keep the source files it downloads somewhere. Please |
| 312 |
supply a directory where the downloaded files are to be kept. |
| 313 |
.Sp |
| 314 |
Download target directory? |
| 315 |
.IP load_module_verbosity 2 |
| 316 |
.IX Item "load_module_verbosity" |
| 317 |
When CPAN.pm loads a module it needs for some optional feature, it |
| 318 |
usually reports about module name and version. Choose 'v' to get this |
| 319 |
message, 'none' to suppress it. |
| 320 |
.Sp |
| 321 |
Verbosity level for loading modules (none or v)? |
| 322 |
.IP makepl_arg 2 |
| 323 |
.IX Item "makepl_arg" |
| 324 |
Every Makefile.PL is run by perl in a separate process. Likewise we |
| 325 |
run 'make' and 'make install' in separate processes. If you have |
| 326 |
any parameters (e.g. PREFIX, UNINST or the like) you want to |
| 327 |
pass to the calls, please specify them here. |
| 328 |
.Sp |
| 329 |
If you don't understand this question, just press ENTER. |
| 330 |
.Sp |
| 331 |
Typical frequently used settings: |
| 332 |
.Sp |
| 333 |
.Vb 1 |
| 334 |
\& PREFIX=~/perl # non\-root users (please see manual for more hints) |
| 335 |
.Ve |
| 336 |
.Sp |
| 337 |
Parameters for the 'perl Makefile.PL' command? |
| 338 |
.IP make_arg 2 |
| 339 |
.IX Item "make_arg" |
| 340 |
Parameters for the 'make' command? Typical frequently used setting: |
| 341 |
.Sp |
| 342 |
.Vb 1 |
| 343 |
\& \-j3 # dual processor system (on GNU make) |
| 344 |
.Ve |
| 345 |
.Sp |
| 346 |
Your choice: |
| 347 |
.IP make_install_arg 2 |
| 348 |
.IX Item "make_install_arg" |
| 349 |
Parameters for the 'make install' command? |
| 350 |
Typical frequently used setting: |
| 351 |
.Sp |
| 352 |
.Vb 2 |
| 353 |
\& UNINST=1 # to always uninstall potentially conflicting files |
| 354 |
\& # (but do NOT use with local::lib or INSTALL_BASE) |
| 355 |
.Ve |
| 356 |
.Sp |
| 357 |
Your choice: |
| 358 |
.IP make_install_make_command 2 |
| 359 |
.IX Item "make_install_make_command" |
| 360 |
Do you want to use a different make command for 'make install'? |
| 361 |
Cautious people will probably prefer: |
| 362 |
.Sp |
| 363 |
.Vb 5 |
| 364 |
\& su root \-c make |
| 365 |
\& or |
| 366 |
\& sudo make |
| 367 |
\& or |
| 368 |
\& /path1/to/sudo \-u admin_account /path2/to/make |
| 369 |
.Ve |
| 370 |
.Sp |
| 371 |
or some such. Your choice: |
| 372 |
.IP mbuildpl_arg 2 |
| 373 |
.IX Item "mbuildpl_arg" |
| 374 |
A Build.PL is run by perl in a separate process. Likewise we run |
| 375 |
\&'./Build' and './Build install' in separate processes. If you have any |
| 376 |
parameters you want to pass to the calls, please specify them here. |
| 377 |
.Sp |
| 378 |
Typical frequently used settings: |
| 379 |
.Sp |
| 380 |
.Vb 1 |
| 381 |
\& \-\-install_base /home/xxx # different installation directory |
| 382 |
.Ve |
| 383 |
.Sp |
| 384 |
Parameters for the 'perl Build.PL' command? |
| 385 |
.IP mbuild_arg 2 |
| 386 |
.IX Item "mbuild_arg" |
| 387 |
Parameters for the './Build' command? Setting might be: |
| 388 |
.Sp |
| 389 |
.Vb 1 |
| 390 |
\& \-\-extra_linker_flags \-L/usr/foo/lib # non\-standard library location |
| 391 |
.Ve |
| 392 |
.Sp |
| 393 |
Your choice: |
| 394 |
.IP mbuild_install_arg 2 |
| 395 |
.IX Item "mbuild_install_arg" |
| 396 |
Parameters for the './Build install' command? Typical frequently used |
| 397 |
setting: |
| 398 |
.Sp |
| 399 |
.Vb 2 |
| 400 |
\& \-\-uninst 1 # uninstall conflicting files |
| 401 |
\& # (but do NOT use with local::lib or INSTALL_BASE) |
| 402 |
.Ve |
| 403 |
.Sp |
| 404 |
Your choice: |
| 405 |
.IP mbuild_install_build_command 2 |
| 406 |
.IX Item "mbuild_install_build_command" |
| 407 |
Do you want to use a different command for './Build install'? Sudo |
| 408 |
users will probably prefer: |
| 409 |
.Sp |
| 410 |
.Vb 5 |
| 411 |
\& su root \-c ./Build |
| 412 |
\& or |
| 413 |
\& sudo ./Build |
| 414 |
\& or |
| 415 |
\& /path1/to/sudo \-u admin_account ./Build |
| 416 |
.Ve |
| 417 |
.Sp |
| 418 |
or some such. Your choice: |
| 419 |
.IP pager 2 |
| 420 |
.IX Item "pager" |
| 421 |
What is your favorite pager program? |
| 422 |
.IP prefer_installer 2 |
| 423 |
.IX Item "prefer_installer" |
| 424 |
When you have Module::Build installed and a module comes with both a |
| 425 |
Makefile.PL and a Build.PL, which shall have precedence? |
| 426 |
.Sp |
| 427 |
The main two standard installer modules are the old and well |
| 428 |
established ExtUtils::MakeMaker (for short: EUMM) which uses the |
| 429 |
Makefile.PL. And the next generation installer Module::Build (MB) |
| 430 |
which works with the Build.PL (and often comes with a Makefile.PL |
| 431 |
too). If a module comes only with one of the two we will use that one |
| 432 |
but if both are supplied then a decision must be made between EUMM and |
| 433 |
MB. See also http://rt.cpan.org/Ticket/Display.html?id=29235 for a |
| 434 |
discussion about the right default. |
| 435 |
.Sp |
| 436 |
Or, as a third option you can choose RAND which will make a random |
| 437 |
decision (something regular CPAN testers will enjoy). |
| 438 |
.Sp |
| 439 |
In case you can choose between running a Makefile.PL or a Build.PL, |
| 440 |
which installer would you prefer (EUMM or MB or RAND)? |
| 441 |
.IP prefs_dir 2 |
| 442 |
.IX Item "prefs_dir" |
| 443 |
CPAN.pm can store customized build environments based on regular |
| 444 |
expressions for distribution names. These are YAML files where the |
| 445 |
default options for CPAN.pm and the environment can be overridden and |
| 446 |
dialog sequences can be stored that can later be executed by an |
| 447 |
Expect.pm object. The CPAN.pm distribution comes with some prefab YAML |
| 448 |
files that cover sample distributions that can be used as blueprints |
| 449 |
to store your own prefs. Please check out the distroprefs/ directory of |
| 450 |
the CPAN.pm distribution to get a quick start into the prefs system. |
| 451 |
.Sp |
| 452 |
Directory where to store default options/environment/dialogs for |
| 453 |
building modules that need some customization? |
| 454 |
.IP prerequisites_policy 2 |
| 455 |
.IX Item "prerequisites_policy" |
| 456 |
The CPAN module can detect when a module which you are trying to build |
| 457 |
depends on prerequisites. If this happens, it can build the |
| 458 |
prerequisites for you automatically ('follow'), ask you for |
| 459 |
confirmation ('ask'), or just ignore them ('ignore'). Choosing |
| 460 |
\&'follow' also sets PERL_AUTOINSTALL and PERL_EXTUTILS_AUTOINSTALL for |
| 461 |
"\-\-defaultdeps" if not already set. |
| 462 |
.Sp |
| 463 |
Please set your policy to one of the three values. |
| 464 |
.Sp |
| 465 |
Policy on building prerequisites (follow, ask or ignore)? |
| 466 |
.IP pushy_https 2 |
| 467 |
.IX Item "pushy_https" |
| 468 |
Boolean. Defaults to true. If this option is true, the cpan shell will |
| 469 |
use https://cpan.org/ to download stuff from the CPAN. It will fall |
| 470 |
back to http://cpan.org/ if it can't handle https for some reason |
| 471 |
(missing modules, missing programs). Whenever it falls back to the |
| 472 |
http protocol, it will issue a warning. |
| 473 |
.Sp |
| 474 |
If this option is true, the option \f(CW\*(C`urllist\*(C'\fR will be ignored. |
| 475 |
Consequently, if you want to work with local mirrors via your own |
| 476 |
configured list of URLs, you will have to choose no below. |
| 477 |
.Sp |
| 478 |
Do you want to turn the pushy_https behaviour on? |
| 479 |
.IP randomize_urllist 2 |
| 480 |
.IX Item "randomize_urllist" |
| 481 |
CPAN.pm can introduce some randomness when using hosts for download |
| 482 |
that are configured in the urllist parameter. Enter a numeric value |
| 483 |
between 0 and 1 to indicate how often you want to let CPAN.pm try a |
| 484 |
random host from the urllist. A value of one specifies to always use a |
| 485 |
random host as the first try. A value of zero means no randomness at |
| 486 |
all. Anything in between specifies how often, on average, a random |
| 487 |
host should be tried first. |
| 488 |
.Sp |
| 489 |
Randomize parameter |
| 490 |
.IP recommends_policy 2 |
| 491 |
.IX Item "recommends_policy" |
| 492 |
(Experimental feature!) Some CPAN modules recommend additional, optional dependencies. These should |
| 493 |
generally be installed except in resource constrained environments. When this |
| 494 |
policy is true, recommended modules will be included with required modules. |
| 495 |
.Sp |
| 496 |
Include recommended modules? |
| 497 |
.IP scan_cache 2 |
| 498 |
.IX Item "scan_cache" |
| 499 |
By default, each time the CPAN module is started, cache scanning is |
| 500 |
performed to keep the cache size in sync ('atstart'). Alternatively, |
| 501 |
scanning and cleanup can happen when CPAN exits ('atexit'). To prevent |
| 502 |
any cache cleanup, answer 'never'. |
| 503 |
.Sp |
| 504 |
Perform cache scanning ('atstart', 'atexit' or 'never')? |
| 505 |
.IP shell 2 |
| 506 |
.IX Item "shell" |
| 507 |
What is your favorite shell? |
| 508 |
.IP show_unparsable_versions 2 |
| 509 |
.IX Item "show_unparsable_versions" |
| 510 |
During the 'r' command CPAN.pm finds modules without version number. |
| 511 |
When the command finishes, it prints a report about this. If you |
| 512 |
want this report to be very verbose, say yes to the following |
| 513 |
variable. |
| 514 |
.Sp |
| 515 |
Show all individual modules that have no \f(CW$VERSION\fR? |
| 516 |
.IP show_upload_date 2 |
| 517 |
.IX Item "show_upload_date" |
| 518 |
The 'd' and the 'm' command normally only show you information they |
| 519 |
have in their in-memory database and thus will never connect to the |
| 520 |
internet. If you set the 'show_upload_date' variable to true, 'm' and |
| 521 |
\&'d' will additionally show you the upload date of the module or |
| 522 |
distribution. Per default this feature is off because it may require a |
| 523 |
net connection to get at the upload date. |
| 524 |
.Sp |
| 525 |
Always try to show upload date with 'd' and 'm' command (yes/no)? |
| 526 |
.IP show_zero_versions 2 |
| 527 |
.IX Item "show_zero_versions" |
| 528 |
During the 'r' command CPAN.pm finds modules with a version number of |
| 529 |
zero. When the command finishes, it prints a report about this. If you |
| 530 |
want this report to be very verbose, say yes to the following |
| 531 |
variable. |
| 532 |
.Sp |
| 533 |
Show all individual modules that have a \f(CW$VERSION\fR of zero? |
| 534 |
.IP suggests_policy 2 |
| 535 |
.IX Item "suggests_policy" |
| 536 |
(Experimental feature!) Some CPAN modules suggest additional, optional dependencies. These 'suggest' |
| 537 |
dependencies provide enhanced operation. When this policy is true, suggested |
| 538 |
modules will be included with required modules. |
| 539 |
.Sp |
| 540 |
Include suggested modules? |
| 541 |
.IP tar_verbosity 2 |
| 542 |
.IX Item "tar_verbosity" |
| 543 |
When CPAN.pm uses the tar command, which switch for the verbosity |
| 544 |
shall be used? Choose 'none' for quiet operation, 'v' for file |
| 545 |
name listing, 'vv' for full listing. |
| 546 |
.Sp |
| 547 |
Tar command verbosity level (none or v or vv)? |
| 548 |
.IP term_is_latin 2 |
| 549 |
.IX Item "term_is_latin" |
| 550 |
The next option deals with the charset (a.k.a. character set) your |
| 551 |
terminal supports. In general, CPAN is English speaking territory, so |
| 552 |
the charset does not matter much but some CPAN have names that are |
| 553 |
outside the ASCII range. If your terminal supports UTF\-8, you should |
| 554 |
say no to the next question. If it expects ISO\-8859\-1 (also known as |
| 555 |
LATIN1) then you should say yes. If it supports neither, your answer |
| 556 |
does not matter because you will not be able to read the names of some |
| 557 |
authors anyway. If you answer no, names will be output in UTF\-8. |
| 558 |
.Sp |
| 559 |
Your terminal expects ISO\-8859\-1 (yes/no)? |
| 560 |
.IP term_ornaments 2 |
| 561 |
.IX Item "term_ornaments" |
| 562 |
When using Term::ReadLine, you can turn ornaments on so that your |
| 563 |
input stands out against the output from CPAN.pm. |
| 564 |
.Sp |
| 565 |
Do you want to turn ornaments on? |
| 566 |
.IP test_report 2 |
| 567 |
.IX Item "test_report" |
| 568 |
The goal of the CPAN Testers project (http://testers.cpan.org/) is to |
| 569 |
test as many CPAN packages as possible on as many platforms as |
| 570 |
possible. This provides valuable feedback to module authors and |
| 571 |
potential users to identify bugs or platform compatibility issues and |
| 572 |
improves the overall quality and value of CPAN. |
| 573 |
.Sp |
| 574 |
One way you can contribute is to send test results for each module |
| 575 |
that you install. If you install the CPAN::Reporter module, you have |
| 576 |
the option to automatically generate and deliver test reports to CPAN |
| 577 |
Testers whenever you run tests on a CPAN package. |
| 578 |
.Sp |
| 579 |
See the CPAN::Reporter documentation for additional details and |
| 580 |
configuration settings. If your firewall blocks outgoing traffic, |
| 581 |
you may need to configure CPAN::Reporter before sending reports. |
| 582 |
.Sp |
| 583 |
Generate test reports if CPAN::Reporter is installed (yes/no)? |
| 584 |
.IP perl5lib_verbosity 2 |
| 585 |
.IX Item "perl5lib_verbosity" |
| 586 |
When CPAN.pm extends \f(CW@INC\fR via PERL5LIB, it prints a list of |
| 587 |
directories added (or a summary of how many directories are |
| 588 |
added). Choose 'v' to get this message, 'none' to suppress it. |
| 589 |
.Sp |
| 590 |
Verbosity level for PERL5LIB changes (none or v)? |
| 591 |
.IP prefer_external_tar 2 |
| 592 |
.IX Item "prefer_external_tar" |
| 593 |
Per default all untar operations are done with the perl module |
| 594 |
Archive::Tar; by setting this variable to true the external tar |
| 595 |
command is used if available; on Unix this is usually preferred |
| 596 |
because they have a reliable and fast gnutar implementation. |
| 597 |
.Sp |
| 598 |
Use the external tar program instead of Archive::Tar? |
| 599 |
.IP trust_test_report_history 2 |
| 600 |
.IX Item "trust_test_report_history" |
| 601 |
When a distribution has already been tested by CPAN::Reporter on |
| 602 |
this machine, CPAN can skip the test phase and just rely on the |
| 603 |
test report history instead. |
| 604 |
.Sp |
| 605 |
Note that this will not apply to distributions that failed tests |
| 606 |
because of missing dependencies. Also, tests can be run |
| 607 |
regardless of the history using "force". |
| 608 |
.Sp |
| 609 |
Do you want to rely on the test report history (yes/no)? |
| 610 |
.IP urllist_ping_external 2 |
| 611 |
.IX Item "urllist_ping_external" |
| 612 |
When automatic selection of the nearest cpan mirrors is performed, |
| 613 |
turn on the use of the external ping via Net::Ping::External. This is |
| 614 |
recommended in the case the local network has a transparent proxy. |
| 615 |
.Sp |
| 616 |
Do you want to use the external ping command when autoselecting |
| 617 |
mirrors? |
| 618 |
.IP urllist_ping_verbose 2 |
| 619 |
.IX Item "urllist_ping_verbose" |
| 620 |
When automatic selection of the nearest cpan mirrors is performed, |
| 621 |
this option can be used to turn on verbosity during the selection |
| 622 |
process. |
| 623 |
.Sp |
| 624 |
Do you want to see verbosity turned on when autoselecting mirrors? |
| 625 |
.IP use_prompt_default 2 |
| 626 |
.IX Item "use_prompt_default" |
| 627 |
When this is true, CPAN will set PERL_MM_USE_DEFAULT to a true |
| 628 |
value. This causes ExtUtils::MakeMaker (and compatible) prompts |
| 629 |
to use default values instead of stopping to prompt you to answer |
| 630 |
questions. It also sets NONINTERACTIVE_TESTING to a true value to |
| 631 |
signal more generally that distributions should not try to |
| 632 |
interact with you. |
| 633 |
.Sp |
| 634 |
Do you want to use prompt defaults (yes/no)? |
| 635 |
.IP use_sqlite 2 |
| 636 |
.IX Item "use_sqlite" |
| 637 |
CPAN::SQLite is a layer between the index files that are downloaded |
| 638 |
from the CPAN and CPAN.pm that speeds up metadata queries and reduces |
| 639 |
memory consumption of CPAN.pm considerably. |
| 640 |
.Sp |
| 641 |
Use CPAN::SQLite if available? (yes/no)? |
| 642 |
.IP version_timeout 2 |
| 643 |
.IX Item "version_timeout" |
| 644 |
This timeout prevents CPAN from hanging when trying to parse a |
| 645 |
pathologically coded \f(CW$VERSION\fR from a module. |
| 646 |
.Sp |
| 647 |
The default is 15 seconds. If you set this value to 0, no timeout |
| 648 |
will occur, but this is not recommended. |
| 649 |
.Sp |
| 650 |
Timeout for parsing module versions? |
| 651 |
.IP yaml_load_code 2 |
| 652 |
.IX Item "yaml_load_code" |
| 653 |
Both YAML.pm and YAML::Syck are capable of deserialising code. As this |
| 654 |
requires a string eval, which might be a security risk, you can use |
| 655 |
this option to enable or disable the deserialisation of code via |
| 656 |
CPAN::DeferredCode. (Note: This does not work under perl 5.6) |
| 657 |
.Sp |
| 658 |
Do you want to enable code deserialisation (yes/no)? |
| 659 |
.IP yaml_module 2 |
| 660 |
.IX Item "yaml_module" |
| 661 |
At the time of this writing (2009\-03) there are three YAML |
| 662 |
implementations working: YAML, YAML::Syck, and YAML::XS. The latter |
| 663 |
two are faster but need a C compiler installed on your system. There |
| 664 |
may be more alternative YAML conforming modules. When I tried two |
| 665 |
other players, YAML::Tiny and YAML::Perl, they seemed not powerful |
| 666 |
enough to work with CPAN.pm. This may have changed in the meantime. |
| 667 |
.Sp |
| 668 |
Which YAML implementation would you prefer? |
| 669 |
.SH LICENSE |
| 670 |
.IX Header "LICENSE" |
| 671 |
This program is free software; you can redistribute it and/or |
| 672 |
modify it under the same terms as Perl itself. |