CPANPLUS::Config(3pm)

1CPANPLUS::Config(3)   User Contributed Perl Documentation  CPANPLUS::Config(3)
2
3
4

NAME

6       CPANPLUS::Config - configuration defaults and heuristics for CPANPLUS
7

SYNOPSIS

9           ### conf object via CPANPLUS::Backend;
10           $cb   = CPANPLUS::Backend->new;
11           $conf = $cb->configure_object;
12
13           ### or as a standalone object
14           $conf = CPANPLUS::Configure->new;
15
16           ### values in 'conf' section
17           $verbose = $conf->get_conf( 'verbose' );
18           $conf->set_conf( verbose => 1 );
19
20           ### values in 'program' section
21           $editor = $conf->get_program( 'editor' );
22           $conf->set_program( editor => '/bin/vi' );
23

DESCRIPTION

25       This module contains defaults and heuristics for configuration
26       information for CPANPLUS. To change any of these values, please see the
27       documentation in "CPANPLUS::Configure".
28
29       Below you'll find a list of configuration types and keys, and their
30       meaning.
31

CONFIGURATION

33   Section 'conf'
34       hosts
35           An array ref containing hosts entries to be queried for packages.
36
37           An example entry would like this:
38
39               {   'scheme' => 'ftp',
40                   'path' => '/pub/CPAN/',
41                   'host' => 'ftp.cpan.org'
42               },
43
44       allow_build_interactivity
45           Boolean flag to indicate whether 'perl Makefile.PL' and similar are
46           run interactively or not. Defaults to 'true'.
47
48       allow_unknown_prereqs
49           Boolean flag to indicate that unresolvable prereqs are acceptable.
50           If "true" then only warnings will be issued (the behaviour before
51           0.9114) when a module is unresolvable from any our sources (CPAN
52           and/or "custom_sources"). If "false" then an unresolvable prereq
53           will fail during the "prepare" stage of distribution installation.
54           Defaults to "true".
55
56       base
57           The directory CPANPLUS keeps all its build and state information
58           in.  Defaults to ~/.cpanplus. If File::HomeDir is available, that
59           will be used to work out your "HOME" directory. This may be
60           overridden by setting the "PERL5_CPANPLUS_HOME" environment
61           variable, see CPANPLUS::Config::HomeEnv for more details.
62
63       buildflags
64           Any flags to be passed to 'perl Build.PL'. See "perldoc
65           Module::Build" for details. Defaults to an empty string.
66
67       cpantest
68           Boolean flag to indicate whether or not to mail test results of
69           module installations to "http://testers.cpan.org". Defaults to
70           'false'.
71
72       cpantest_mx
73           String holding an explicit mailserver to use when sending out
74           emails for "http://testers.cpan.org". An empty string will use your
75           system settings. Defaults to an empty string.
76
77       debug
78           Boolean flag to enable or disable extensive debugging information.
79           Defaults to 'false'.
80
81       dist_type
82           Default distribution type to use when building packages. See
83           "cpan2dist" or "CPANPLUS::Dist" for details. An empty string will
84           not use any package building software. Defaults to an empty string.
85
86       email
87           Email address to use for anonymous ftp access and as "from" address
88           when sending emails. Defaults to an "example.com" address.
89
90       enable_custom_sources
91           Boolean flag indicating whether custom sources should be enabled or
92           not. See the "CUSTOM MODULE SOURCES" in "CPANPLUS::Backend" for
93           details on how to use them.
94
95           Defaults to "true"
96
97       extractdir
98           String containing the directory where fetched archives should be
99           extracted. An empty string will use a directory under your "base"
100           directory. Defaults to an empty string.
101
102       fetchdir
103           String containing the directory where fetched archives should be
104           stored. An empty string will use a directory under your "base"
105           directory. Defaults to an empty string.
106
107       flush
108           Boolean indicating whether build failures, cache dirs etc should be
109           flushed after every operation or not. Defaults to 'true'.
110
111       force
112           Boolean indicating whether files should be forcefully overwritten
113           if they exist, modules should be installed when they fail tests,
114           etc. Defaults to 'false'.
115
116       histfile
117           A string containing the history filename of the CPANPLUS readline
118           instance.
119
120       lib An array ref holding directories to be added to @INC when CPANPLUS
121           starts up. Defaults to an empty array reference.
122
123       makeflags
124           A string holding flags that will be passed to the "make" program
125           when invoked. Defaults to an empty string.
126
127       makemakerflags
128           A string holding flags that will be passed to "perl Makefile.PL"
129           when invoked. Defaults to an empty string.
130
131       md5 A boolean indicating whether or not sha256 checks should be done
132           when an archive is fetched. Defaults to 'true' if you have
133           "Digest::SHA" installed, 'false' otherwise.
134
135       no_update
136           A boolean indicating whether or not "CPANPLUS"' source files should
137           be updated or not. Defaults to 'false'.
138
139       passive
140           A boolean indicating whether or not to use passive ftp connections.
141           Defaults to 'true'.
142
143       prefer_bin
144           A boolean indicating whether or not to prefer command line programs
145           over perl modules. Defaults to 'false' unless you do not have
146           "Compress::Zlib" installed (as that would mean we could not extract
147           ".tar.gz" files)
148
149       prefer_makefile
150           A boolean indicating whether or not prefer a "Makefile.PL" over a
151           "Build.PL" file if both are present. Defaults to 'true', unless the
152           perl version is at least 5.10.1 or appropriate versions of
153           Module::Build and CPANPLUS::Dist::Build are available.
154
155       prereqs
156           A digit indicating what to do when a package you are installing has
157           a prerequisite. Options are:
158
159               0   Do not install
160               1   Install
161               2   Ask
162               3   Ignore  (dangerous, install will probably fail!)
163
164           The default is to ask.
165
166       shell
167           A string holding the shell class you wish to start up when starting
168           "CPANPLUS" in interactive mode.
169
170           Defaults to "CPANPLUS::Shell::Default", the default CPANPLUS shell.
171
172       show_startup_tip
173           A boolean indicating whether or not to show start up tips in the
174           interactive shell. Defaults to 'true'.
175
176       signature
177           A boolean indicating whether or not check signatures if packages
178           are signed. Defaults to 'true' if you have "gpg" or
179           "Crypt::OpenPGP" installed, 'false' otherwise.
180
181       skiptest
182           A boolean indicating whether or not to skip tests when installing
183           modules.  Defaults to 'false'.
184
185       storable
186           A boolean indicating whether or not to use "Storable" to write
187           compiled source file information to disk. This makes for faster
188           startup and look up times, but takes extra diskspace. Defaults to
189           'true' if you have "Storable" installed and 'false' if you don't.
190
191       timeout
192           Digit indicating the time before a fetch request times out (in
193           seconds).  Defaults to 300.
194
195       verbose
196           A boolean indicating whether or not "CPANPLUS" runs in verbose
197           mode.  Defaults to 'true' if you have the environment variable
198           "PERL5_CPANPLUS_VERBOSE" set to true, 'false' otherwise.
199
200           It is recommended you run with verbose enabled, but it is disabled
201           for historical reasons.
202
203       write_install_log
204           A boolean indicating whether or not to write install logs after
205           installing a module using the interactive shell. Defaults to
206           'true'.
207
208       source_engine
209           Class to use as the source engine, which is generally a subclass of
210           "CPANPLUS::Internals::Source". Default to
211           "CPANPLUS::Internals::Source::Memory".
212
213       cpantest_reporter_args
214           A hashref of key => value pairs that are passed to the constructor
215           of "Test::Reporter". If you'd want to enable TLS for example, you'd
216           set it to:
217
218             { transport       => 'Net::SMTP::TLS',
219               transport_args  => [ User => 'Joe', Password => '123' ],
220             }
221
222   Section 'program'
223       editor
224           A string holding the path to your editor of choice. Defaults to
225           your $ENV{EDITOR}, $ENV{VISUAL}, 'vi' or 'pico' programs, in that
226           order.
227
228       make
229           A string holding the path to your "make" binary. Looks for the
230           "make" program used to build perl or failing that, a "make" in your
231           path.
232
233       pager
234           A string holding the path to your pager of choice. Defaults to your
235           $ENV{PAGER}, 'less' or 'more' programs, in that order.
236
237       shell
238           A string holding the path to your login shell of choice. Defaults
239           to your $ENV{SHELL} setting, or $ENV{COMSPEC} on Windows.
240
241       sudo
242           A string holding the path to your "sudo" binary if your install
243           path requires super user permissions. Looks for "sudo" in your
244           path, or remains empty if you do not require super user permissions
245           to install.
246
247       perlwrapper
248           DEPRECATED
249
250           A string holding the path to the "cpanp-run-perl" utility bundled
251           with CPANPLUS, which is used to enable autoflushing in spawned
252           processes.
253

BUG REPORTS

255       Please report bugs or other issues to <bug-cpanplus@rt.cpan.org<gt>.
256

AUTHOR

258       This module by Jos Boumans <kane@cpan.org>.
259

COPYRIGHT

261       The CPAN++ interface (of which this module is a part of) is copyright
262       (c) 2001 - 2007, Jos Boumans <kane@cpan.org>. All rights reserved.
263
264       This library is free software; you may redistribute and/or modify it
265       under the same terms as Perl itself.
266