Debian Codegraph @

upstream/mageia-cauldron/man3pm/CPAN::FirstTime.3pm

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