.\" -*- 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 "cpanfile 3"
.TH cpanfile 3 2026-07-15 "perl v5.42.2" "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
cpanfile \- A format for describing CPAN dependencies for Perl applications
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&  requires \*(AqPlack\*(Aq, \*(Aq1.0\*(Aq; # 1.0 or newer
\&  requires \*(AqJSON\*(Aq, \*(Aq>= 2.00, < 2.80\*(Aq;
\&
\&  recommends \*(AqJSON::XS\*(Aq, \*(Aq2.0\*(Aq;
\&  conflicts \*(AqJSON\*(Aq, \*(Aq< 1.0\*(Aq;
\&
\&  on \*(Aqtest\*(Aq => sub {
\&    requires \*(AqTest::More\*(Aq, \*(Aq>= 0.96, < 2.0\*(Aq;
\&    recommends \*(AqTest::TCP\*(Aq, \*(Aq1.12\*(Aq;
\&  };
\&
\&  on \*(Aqdevelop\*(Aq => sub {
\&    recommends \*(AqDevel::NYTProf\*(Aq;
\&  };
\&
\&  feature \*(Aqsqlite\*(Aq, \*(AqSQLite support\*(Aq => sub {
\&    recommends \*(AqDBD::SQLite\*(Aq;
\&  };
.Ve
.SH VERSION
.IX Header "VERSION"
This document describes cpanfile format version 1.0.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`cpanfile\*(C'\fR describes CPAN dependencies required to execute associated
Perl code.
.SH SYNTAX
.IX Header "SYNTAX"
.IP "requires, recommends, suggests, conflicts" 4
.IX Item "requires, recommends, suggests, conflicts"
.Vb 1
\&  requires $module, $version_requirement;
.Ve
.Sp
Describes the requirement for a module. See CPAN::Meta::Spec for
the meanings of each requirement type.
.Sp
When version requirement is omitted, it is assumed that \f(CW0\fR is
passed, meaning any version of the module would satisfy the
requirement.
.Sp
Version requirement can either be a version number or a string that
satisfies "Version Ranges" in CPAN::Meta::Spec, such as \f(CW>= 1.0, !=
1.1\fR.
.Sp
Note that, per CPAN::Meta::Spec, when a plain version number is
given, it means the version \fIor newer\fR is required. If you want a
specific version for a module, use the specific range syntax, i.e.
\&\f(CW\*(C` == 2.1 \*(C'\fR.
.IP on 4
.IX Item "on"
.Vb 1
\&  on $phase => sub { ... };
.Ve
.Sp
Describe requirements for a specific phase. Available phases are
\&\f(CW\*(C`configure\*(C'\fR, \f(CW\*(C`build\*(C'\fR, \f(CW\*(C`test\*(C'\fR, \f(CW\*(C`runtime\*(C'\fR and \f(CW\*(C`develop\*(C'\fR.
.IP feature 4
.IX Item "feature"
.Vb 1
\&  feature $identifier, $description => sub { ... };
.Ve
.Sp
Group requirements with features. Description can be omitted, when it
is assumed to be the same as identifier. See
"optional_features" in CPAN::Meta::Spec for more details.
.IP "configure_requires, build_requires, test_requires, author_requires" 4
.IX Item "configure_requires, build_requires, test_requires, author_requires"
.Vb 2
\&  configure_requires $module, $version;
\&  # on \*(Aqconfigure\*(Aq => sub { requires $module, $version }
\&
\&  build_requires $module, $version;
\&  # on \*(Aqbuild\*(Aq => sub { requires $module, $version };
\&
\&  test_requires $module, $version;
\&  # on \*(Aqtest\*(Aq => sub { requires $module, $version };
\&
\&  author_requires $module, $version;
\&  # on \*(Aqdevelop\*(Aq => sub { requires $module, $version };
.Ve
.Sp
Shortcut for \f(CW\*(C`requires\*(C'\fR in specific phase. This is mainly provided
for compatibilities with Module::Install DSL.
.SH USAGE
.IX Header "USAGE"
\&\f(CW\*(C`cpanfile\*(C'\fR is a format to describe dependencies. How to use this file
is dependent on the tools reading/writing it.
.PP
Usually, you\*(Aqre expected to place the \f(CW\*(C`cpanfile\*(C'\fR in the root of the
directory containing the associated code.
.PP
Tools supporting \f(CW\*(C`cpanfile\*(C'\fR format (e.g. cpanm and carton) will
automatically detect the file and install dependencies for the code to
run.
.PP
There are also tools to support converting cpanfile to CPAN toolchain
compatible formats, such as Module::CPANfile,
Dist::Zilla::Plugin::Prereqs::FromCPANfile,
Module::Install::CPANfile, so that \f(CW\*(C`cpanfile\*(C'\fR can be used to
describe dependencies for a CPAN distribution as well.
.PP
The cpanfile\-dump tool can be used to dump dependencies.
.SH AUTHOR
.IX Header "AUTHOR"
Tatsuhiko Miyagawa
.SH ACKNOWLEDGEMENTS
.IX Header "ACKNOWLEDGEMENTS"
The format (DSL syntax) is inspired by Module::Install and
Module::Build::Functions.
.PP
\&\f(CW\*(C`cpanfile\*(C'\fR specification (this document) is based on Ruby\*(Aqs
Gemfile <http://bundler.io/v1.3/man/gemfile.5.html> specification.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
CPAN::Meta::Spec Module::Install Carton