1PERLBREW(1) User Contributed Perl Documentation PERLBREW(1)
2
6 perlbrew - Perl environment manager.
7
9 perlbrew command syntax:
10 perlbrew <command> [options] [arguments]
12 Commands:
14 init Initialize perlbrew environment.
16 info Show useful information about the perlbrew installation
17 install Install perl
19 uninstall Uninstall the given installation
20 available List perls available to install
21 lib Manage local::lib directories.
22 alias Give perl installations a new name
23 upgrade-perl Upgrade the current perl
24 list List perl installations
26 use Use the specified perl in current shell
27 off Turn off perlbrew in current shell
28 switch Permanently use the specified perl as default
29 switch-off Permanently turn off perlbrew (revert to system perl)
30 exec exec programs with specified perl environments.
31 clone-modules re-installs all CPAN modules from one installation to another
32 self-install Install perlbrew itself under PERLBREW_ROOT/bin
34 self-upgrade Upgrade perlbrew itself.
35 install-patchperl Install patchperl
37 install-cpanm Install cpanm, a friendly companion.
38 install-multiple Install multiple versions and flavors of perl
39 download Download the specified perl distribution tarball.
41 clean Purge tarballs and build directories
42 version Display version
43 help Read more detailed instructions
44 Generic command options:
46 -q --quiet Be quiet on informative output message.
48 -v --verbose Tell me more about it.
49 See `perlbrew help` for the full documentation of perlbrew, or
51 See `perlbrew help <command>` for detail description of the command.
53
55 PERLBREW_ROOT
56 By default, perlbrew builds and installs perls into
57 "$ENV{HOME}/perl5/perlbrew" directory. To use a different
58 directory, set this environment variable in your "bashrc" to the
59 directory in your shell RC before sourcing perlbrew's RC.
60 It is possible to share one perlbrew root with multiple user
62 account on the same machine. Therefore people do not have to
63 install the same version of perl over an over. Let's say
64 "/opt/perl5" is the directory we want to share. All users should be
65 able append this snippet to their bashrc to make it effective:
66 export PERLBREW_ROOT=/opt/perl5
68 source ${PERLBREW_ROOT}/etc/bashrc
69 After doing so, everyone's PATH should include "/opt/perl5/bin" and
71 "/opt/perl5/perls/${PERLBREW_PERL}/bin". Each user can invoke
72 "perlbrew switch" and "perlbrew use" to independently switch to
73 different perl environment of their choice. However, only the user
74 with write permission to $PERLBREW_ROOT may install CPAN modules.
75 This is both good and bad depending on the working convention of
76 your team.
77 If you wish to install CPAN modules only for yourself, you should
79 use the "lib" command to construct a personal local::lib
80 environment. local::lib environments are personal, and are not
81 shared between different users. For more detail, read "perlbrew
82 help lib" and the documentation of local::lib.
83 If you want even a cooler module isolation and wish to install CPAN
85 modules used for just one project, you should use carton for this
86 purpose.
87 It is also possible to set this variable before installing perlbrew
89 to make perlbrew install itself under the given PERLBREW_ROOT:
90 export PERLBREW_ROOT=/opt/perl5
92 curl -L http://install.perlbrew.pl | bash
93 After doing this, the perlbrew executable is installed as
95 "/opt/perl5/bin/perlbrew"
96 PERLBREW_HOME
98 By default, perlbrew stores per-user setting to
99 "$ENV{HOME}/.perlbrew" directory. To use a different directory, set
100 this environment variable in your shell RC before sourcing
101 perlbrew's RC.
102 In some cases, say, your home directory is on NFS and shared across
104 multiple machines, you may wish to have several different perlbrew
105 setting per-machine. To do so, you can use the "PERLBREW_HOME"
106 environment variable to tell perlbrew where to look for the
107 initialization file. Here's a brief bash snippet for the given
108 scenario.
109 if [ "$(hostname)" == "machine-a" ]; then
111 export PERLBREW_HOME=~/.perlbrew-a
112 elif [ "$(hostname)" == "machine-b" ]; then
113 export PERLBREW_HOME=~/.perlbrew-b
114 fi
115 source ~/perl5/perlbrew/etc/bashrc
117 PERLBREW_CONFIGURE_FLAGS
119 This environment variable specify the list of command like flags to
120 pass through to 'sh Configure'. By default it is '-de'.
121 PERLBREW_CPAN_MIRROR
123 The CPAN mirror url of your choice. The default value is
124 "http://www.cpan.org"
125
127 Usage: perlbrew init
128 The "init" command should be manually invoked whenever you (the
130 perlbrew user) upgrade or reinstall perlbrew.
131 If the upgrade is done with "self-upgrade" command, or by running the
133 one-line installer manually, this command is invoked automatically.
134
136 info [module]
137 Usage: perlbrew info [ <module> ]
138 Display useful information about the perlbrew installation.
140 If a module is given the version and location of the module is
142 displayed.
143
145 install [options] perl-<version>
146 install [options] <version>
147 Build and install the given version of perl.
148 Version numbers usually look like "5.x.xx", or "perl-5.xx.x-RCx"
150 for release candidates.
151 The specified perl is downloaded from the official CPAN website or
153 from the mirror site configured before.
154 Add '--mirror $URL' to specify the URL of mirror site.
156 install [options] cperl-<version>
158 Install the cperl distribution released from:
159 https://github.com/perl11/cperl/releases
161 See http://perl11.org/cperl/ for more information about cperl
163 distribution.
164 install [options] perl-stable
166 install [options] stable
167 A convenient way to install the most recent stable version of Perl,
168 of those that are available.
169 install [options] perl-blead
171 install [options] blead
172 A special way to install the blead version of perl, which is
173 downloaded from this specific URL regardless of mirror settings:
174 http://perl5.git.perl.org/perl.git/snapshot/blead.tar.gz
176 install [options] /path/to/perl/git/checkout/dir
178 Build and install from the given git checkout dir.
179 install [options] /path/to/perl-5.14.0.tar.gz
181 Build and install from the given archive file.
182 install [options] http://example.com/mirror/perl-5.12.3.tar.gz
184 Build and install from the given URL. Supported URL schemes are
185 "http://", "https://", "ftp://" and "file://".
186 Options for "install" command:
188 -f --force Force installation
190 -j $n Parallel building and testing. ex. C<perlbrew install -j 5 perl-5.14.2>
191 -n --notest Skip testing
192 --switch Automatically switch to this Perl once successfully
194 installed, as if with `perlbrew switch <version>`
195 --as Install the given version of perl by a name.
197 ex. C<perlbrew install perl-5.6.2 --as legacy-perl>
198 --noman Skip installation of manpages
200 --thread Build perl with usethreads enabled
202 --multi Build perl with usemultiplicity enabled
203 --64int Build perl with use64bitint enabled
204 --64all Build perl with use64bitall enabled
205 --ld Build perl with uselongdouble enabled
206 --debug Build perl with DEBUGGING enabled
207 --clang Build perl using the clang compiler
208 --no-patchperl
209 Skip calling patchperl
210 -D,-U,-A Switches passed to perl Configure script.
212 ex. C<perlbrew install perl-5.10.1 -D usemymalloc -U versiononly>
213 --destdir $path
215 Install perl as per 'make install DESTDIR=$path'
216 --sitecustomize $filename
218 Specify a file to be installed as sitecustomize.pl
219 By default, all installations are configured after their name like
221 this:
222 sh Configure -de -Dprefix=$PERLBREW_ROOT/perls/<name>
224
226 Usage: perlbrew install-multiple [options] <perl-version-1>
227 <perl-version-2> ...
228 Build and install the given versions of perl.
230 "install-multiple" accepts the same set of options as the command
232 "install" plus the following ones:
233 --both $flavor Where $flavor is one of C<thread>, C<multi>, C<ld>,
235 C<64int>, C<64all>, C<debug> and C<clang>.
236 For every given perl version, install two
238 flavors, one with the flag C<--$flavor> set
239 and the other with out. C<--both> can be
240 passed multiple times with different values
241 and in that case, all the possible
242 combinations are generated.
243 --common-variations equivalent to C<--both thread --both ld --both 64int>
245 --all-variations generates all the possible flavor combinations
247 --append $string Appends the given string to the generated names
249 For instance:
251 perlbrew install-multiple 5.18.0 blead --both thread --both debug
253 Installs the following perls:
255 perl-blead
257 perl-blead-debug
258 perl-blead-thread-multi
259 perl-blead-thread-multi-debug
260 perl-5.18.0
261 perl-5.18.0-debug
262 perl-5.18.0-thread-multi
263 perl-5.18.0-thread-multi-debug
264 (note that the "multi" flavor is selected automatically because
266 "thread" requires it)
267 Another example using custom compilation flags:
269 perlbrew install-multiple 5.18.0 --both thread -Doptimize='-O3' --append='-O3'
271
273 Usage: perlbrew uninstall <name>
274 Uninstalls the given perl installation. The name is the installation
276 name as in the output of `perlbrew list`. This effectively deletes the
277 specified perl installation, and all libs associated with it.
278
280 Usage: perlbrew use [perl-<version> | <version> | <name>]
281 Use the given version perl in current shell. This will not effect newly
283 opened shells.
284 Without a parameter, shows the version of perl currently in use.
286
288 Usage: perlbrew switch [ <name> ]
289 Switch to the given version, and makes it the default for this and all
291 future terminal sessions.
292 Without a parameter, shows the version of perl currently selected.
294
296 Usage: perlbrew list
297 List all perl installations inside perlbrew root specified by
299 $PERLBREW_ROOT environment variable. By default, the value is
300 "~/perl5/perlbrew".
301 If there are libs associated to some perl installations, they will be
303 included as part of the name. The output items in this list can be the
304 argument in various other commands.
305
307 Usage: perlbrew available [--all]
308 List the recently available versions of perl on CPAN.
310 The list is retrieved from the web page
312 <http://www.cpan.org/src/README.html>, and is not the list of *all*
313 perl versions ever released in the past.
314 To get a list of all perls ever released, use the "--all" option.
316 NOTICE: This command might be gone in the future and becomes an option
318 of 'list' command.
319
321 Usage: perlbrew off
322 Temporarily disable perlbrew in the current shell. Effectively re-
324 enables the default system Perl, whatever that is.
325 This command works only if you add the statement of `source
327 $PERLBREW_ROOT/etc/bashrc` in your shell initialization (bashrc /
328 zshrc).
329
331 Usage: perlbrew switch-off
332 Permananently disable perlbrew. Use "switch" command to re-enable it.
334 Invoke "use" command to enable it only in the current shell.
335 Re-enables the default system Perl, whatever that is.
337
339 Usage: perlbrew alias [-f] create <name> <alias>
340 Create an alias for the installation named <name>.
342 Usage: perlbrew alias [-f] rename <old_alias> <new_alias>
344 Rename the alias to a new name.
346 Usage: perlbrew alias delete <alias>
348 Delete the given alias.
350
352 Usage: perlbrew exec [--with perl-name[,perl-name...]] <command>
353 <args...>
354 Execute command for each perl installations, one by one.
356 For example, run a Hello program:
358 perlbrew exec perl -e 'print "Hello from $]\n"'
360 The output looks like this:
362 perl-5.12.2
364 ==========
365 Hello word from perl-5.012002
366 perl-5.13.10
368 ==========
369 Hello word from perl-5.013010
370 perl-5.14.0
372 ==========
373 Hello word from perl-5.014000
374 Notice that the command is not executed in parallel.
376 When "--with" argument is provided, the command will be only executed
378 with the specified perl installations. The following command install
379 Moose module into perl-5.12, regardless the current perl:
380 perlbrew exec --with perl-5.12 cpanm Moose
382 Multiple installation names can be provided:
384 perlbrew exec --with perl-5.12,perl-5.12-debug,perl-5.14.2 cpanm Moo
386 They are split by either spaces or commas. When spaces are used, it is
388 required to quote the whole specification as one argument, but then
389 commas can be used in the installation names:
390 perlbrew exec --with '5.12 5.12,debug 5.14.2@nobita @shizuka' cpanm Moo
392 As demonstrated above, "perl-" prefix can be omitted, and lib names can
394 be specified too. Lib names can appear without a perl installation
395 name, in such cases it is assumed to be "current perl".
396 At the moment, any specified names that fails to be resolved as a real
398 installation names are silently ignored in the output. Also, the
399 command exit status are not populated back.
400
402 Usage: perlbrew env [ <name> ]
403 Low-level command. Invoke this command to see the list of environment
405 variables that are set by "perlbrew" itself for shell integration.
406 The output is something similar to this (if your shell is bash/zsh):
408 export PERLBREW_ROOT=/Users/gugod/perl5/perlbrew
410 export PERLBREW_VERSION=0.31
411 export PERLBREW_PATH=/Users/gugod/perl5/perlbrew/bin:/Users/gugod/perl5/perlbrew/perls/current/bin
412 export PERLBREW_PERL=perl-5.14.1
413 tcsh / csh users should see 'setenv' statements instead of `export`.
415
417 Usage: perlbrew symlink-executables [ <name> ]
418 Low-level command. This command is used to create the "perl" executable
420 symbolic link to, say, "perl5.13.6". This is only required for
421 development version of perls.
422 You don't need to do this unless you have been using old perlbrew to
424 install perls, and you find yourself confused because the perl that you
425 just installed appears to be missing after invoking `use` or `switch`.
426 perlbrew changes its installation layout since version 0.11, which
427 generates symlinks to executables in a better way.
428 If you just upgraded perlbrew (from 0.11 or earlier versions) and
430 "perlbrew switch" failed to work after you switch to a development
431 release of perl, say, perl-5.13.6, run this command:
432 perlbrew symlink-executables perl-5.13.6
434 This essentially creates this symlink:
436 ${PERLBREW_ROOT}/perls/perl-5.13.6/bin/perl
438 -> ${PERLBREW_ROOT}/perls/perl-5.13.6/bin/perl5.13.6
439 Newly installed perls, whether they are development versions or not,
441 does not need manually treatment with this command.
442
444 Usage: perlbrew install-cpanm
445 Install the "cpanm" standalone executable in "$PERLBREW_ROOT/bin".
447 For more rationale about the existence of this command, read
449 <http://perlbrew.pl/Perlbrew-and-Friends.html>
450
452 Usage: perlbrew install-patchperl
453 Install the "patchperl" standalone executable in "$PERLBREW_ROOT/bin".
455 This is automatically invoked if your perlbrew installation is done
456 with the installer, but not with cpan.
457 For more rationale about the existence of this command, read
459 <http://perlbrew.pl/Perlbrew-and-Friends.html>
460
462 Usage: perlbrew self-upgrade
463 This command upgrades Perlbrew to its latest version.
465
467 Usage: perlbrew self-install
468 NOTICE: You should not need to run this command in your daily routine.
470 This command install perlbrew itself to "$PERLBREW_ROOT/bin". It is
472 intended to be used by the perlbrew installer. However, you could
473 manually do the following to re-install only the "perlbrew" executable:
474 curl https://raw.githubusercontent.com/gugod/App-perlbrew/master/perlbrew -o perlbrew
476 perl ./perlbrew self-install
477 It is slightly different from running the perlbrew installer because
479 "patchperl" is not installed in this case.
480
482 Usage: perlbrew clean
483 Removes all previously downloaded Perl tarballs and build directories.
485
487 Usage: perlbrew version
488 Show the version of perlbrew.
490
492 Usage: perlbrew lib <action> <lib-name>
493 perlbrew lib list
495 perlbrew lib create <lib-name>
496 perlbrew lib delete <lib-name>
497 The `lib` command is used to manipulate local::lib roots inside perl
499 installations. Effectively it is similar to `perl
500 -Mlocal::lib=/path/to/lib-name`, but a little bit more than just that.
501 A lib name can be a short name, containing alphanumeric, like
503 'awesome', or a full name, prefixed by a perl installation name and a
504 '@' sign, for example, 'perl-5.14.2@awesome'.
505 Here are some a brief examples to invoke the `lib` command:
507 # Create lib perl-5.12.3@shizuka
509 perlbrew lib create perl-5.12.3@shizuka
510 # Create lib perl-5.14.2@nobita and perl-5.14.2@shizuka
512 perlbrew use perl-5.14.2
513 perlbrew lib create nobita
514 perlbrew lib create shizuka
515 # See the list of use/switch targets
517 perlbrew list
518 # Activate a lib in current shell
520 perlbrew use perl-5.12.3@shizuka
521 perlbrew use perl-5.14.2@nobita
522 perlbrew use perl-5.14.2@shizuka
523 # Activate a lib as default
525 perlbrew switch perl-5.12.3@shizuka
526 perlbrew switch perl-5.14.2@nobita
527 perlbrew switch perl-5.14.2@shizuka
528 # Delete lib perl-5.14.2@nobita and perl-5.14.2@shizuka
530 perlbrew use perl-5.14.2
531 perlbrew lib delete nobita
532 perlbrew lib delete shizuka
533 # Delete lib perl-5.12.3@shizuka
535 perlbrew lib delete perl-5.12.3@shizuka
536 Short lib names are local to current perl. A lib name 'nobita' can
538 refer to 'perl-5.12.3@nobita' or 'perl-5.14.2@nobita', depending on
539 your current perl.
540 When "use"ing or "switch"ing to a lib, always provide the long name. A
542 simple rule: the argument to "use" or "switch" command should appear in
543 the output of "perlbrew list".
544
546 Usage: perlbrew upgrade-perl
547 Minor Perl releases (ex. 5.x.*) are binary compatible with one another,
549 so this command offers you the ability to upgrade older perlbrew
550 environments in place.
551 It upgrades the currently activated perl to its latest released
553 brothers. If you have a shell with 5.14.0 activated, it upgrades it to
554 5.14.2.
555
557 Usage:
558 perlbrew download perl-5.14.2
560 perlbrew download perl-5.16.1
561 perlbrew download perl-5.17.3
562 Download the specified version of perl distribution tarball under
564 "$PERLBREW_ROOT/dists/" directory.
565
567 List all installed cpan modules for the current perl.
568 This command can be used in conjunction with `perlbrew exec` to migrate
570 your module installation to different perl. The following command re-
571 installs all modules under perl-5.16.0:
572 perlbrew list-modules | perlbrew exec --with perl-5.16.0 cpanm
574 Note that this installs the latest versions of the Perl modules on the
576 new perl, which are not necessarily the same module versions you had
577 installed previously.
578
580 This command re-installs all CPAN modules found from one installation
581 to another.
582 Usage:
584 perlbrew clone-modules <src_version> <dst_version>
585 for example
587 perlbrew clone-modules 5.26.1 5.27.7
589
591 App::perlbrew, App::cpanminus, Devel::PatchPerl
592perl v5.30.0 2019-07-26 PERLBREW(1)