.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Required to disable full justification in groff 1.23.0. .if n .ds AD l .\" ======================================================================== .\" .IX Title "CPANP 1" .TH CPANP 1 2025-12-14 "perl v5.42.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME cpanp \- The CPANPLUS launcher .SH SYNOPSIS .IX Header "SYNOPSIS" \&\fBcpanp\fR .PP \&\fBcpanp\fR [\-]\fBa\fR [\ \-\-[\fBno\fR\-]\fIoption\fR...\ ] \ \fIauthor\fR...\ .PP \&\fBcpanp\fR [\-]\fBmfitulrcz\fR [\ \-\-[\fBno\fR\-]\fIoption\fR...\ ] \ \fImodule\fR...\ .PP \&\fBcpanp\fR [\-]\fBd\fR [\ \-\-[\fBno\fR\-]\fIoption\fR...\ ] [\ \-\-\fBfetchdir\fR=...\ ] \ \fImodule\fR...\ .PP \&\fBcpanp\fR [\-]\fBxb\fR [\ \-\-[\fBno\fR\-]\fIoption\fR...\ ] .PP \&\fBcpanp\fR [\-]\fBo\fR [\ \-\-[\fBno\fR\-]\fIoption\fR...\ ] [\ \fImodule\fR...\ ] .SH DESCRIPTION .IX Header "DESCRIPTION" This script launches the \fBCPANPLUS\fR utility to perform various operations from the command line. If it\*(Aqs invoked without arguments, an interactive shell is executed by default. .PP Optionally, it can take a single\-letter switch and one or more arguments, to perform the associated action on each argument. A summary of the available commands is listed below; \f(CW\*(C`cpanp \-h\*(C'\fR provides a detailed list. .PP .Vb 2 \& h # help information \& v # version information \& \& a AUTHOR ... # search by author(s) \& m MODULE ... # search by module(s) \& f MODULE ... # list all releases of a module \& \& i MODULE ... # install module(s) \& t MODULE ... # test module(s) \& u MODULE ... # uninstall module(s) \& d MODULE ... # download module(s) \& l MODULE ... # display detailed information about module(s) \& r MODULE ... # display README files of module(s) \& c MODULE ... # check for module report(s) from cpan\-testers \& z MODULE ... # extract module(s) and open command prompt in it \& \& x # reload CPAN indices \& \& o [ MODULE ... ] # list installed module(s) that aren\*(Aqt up to date \& b # write a bundle file for your configuration .Ve .PP Each command may be followed by one or more \fIoptions\fR. If preceded by \f(CW\*(C`no\*(C'\fR, the corresponding option will be set to \f(CW0\fR, otherwise it\*(Aqs set to \f(CW1\fR. .PP Example: To skip a module\*(Aqs tests, .PP .Vb 1 \& cpanp \-i \-\-skiptest MODULE ... .Ve .PP Valid options for most commands are \f(CW\*(C`cpantest\*(C'\fR, \f(CW\*(C`debug\*(C'\fR, \f(CW\*(C`flush\*(C'\fR, \f(CW\*(C`force\*(C'\fR, \&\f(CW\*(C`prereqs\*(C'\fR, \f(CW\*(C`storable\*(C'\fR, \f(CW\*(C`verbose\*(C'\fR, \f(CW\*(C`md5\*(C'\fR, \f(CW\*(C`signature\*(C'\fR, and \f(CW\*(C`skiptest\*(C'\fR; the \&\*(Aqd\*(Aq command also accepts \f(CW\*(C`fetchdir\*(C'\fR. Please consult CPANPLUS::Configure for an explanation to their meanings. .PP Example: To download a module\*(Aqs tarball to the current directory, .PP .Vb 1 \& cpanp \-d \-\-fetchdir=. MODULE ... .Ve