CPANPLUS::Config(3pm)

1CPANPLUS::Config(3pm)  Perl Programmers Reference Guide  CPANPLUS::Config(3pm)
2
3
4

NAME

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

BUG REPORTS

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

AUTHOR

241       This module by Jos Boumans <kane@cpan.org>.
242

COPYRIGHT

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