Gecko [ gtgates.com ]

Name	Size	Permission	Date
Algorithm	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
App	[ DIR ]	drwxr-xr-x	2025-06-04 11:33
Archive	[ DIR ]	drwxr-xr-x	2024-02-12 23:57
Authen	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
B	[ DIR ]	drwxr-xr-x	2024-02-12 23:56
CGI	[ DIR ]	drwxr-xr-x	2024-02-12 23:57
CPAN	[ DIR ]	drwxr-xr-x	2025-06-04 11:33
Carp	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
Config	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
Data	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
Date	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
Devel	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
Digest	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
Encode	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
Error	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
Exporter	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
ExtUtils	[ DIR ]	drwxr-xr-x	2024-02-12 23:53
File	[ DIR ]	drwxr-xr-x	2024-12-02 12:30
Filter	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
Getopt	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
Git	[ DIR ]	drwxr-xr-x	2025-07-23 11:30
HTML	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
HTTP	[ DIR ]	drwxr-xr-x	2024-05-31 13:24
IO	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
IPC	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
JSON	[ DIR ]	drwxr-xr-x	2024-02-12 23:56
LWP	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
Locale	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
MRO	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
Math	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
Module	[ DIR ]	drwxr-xr-x	2024-12-02 12:30
Mozilla	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
Net	[ DIR ]	drwxr-xr-x	2024-02-12 23:58
POD2	[ DIR ]	drwxr-xr-x	2019-10-13 14:04
Package	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
Params	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
Parse	[ DIR ]	drwxr-xr-x	2024-12-02 12:30
Perl	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
PerlIO	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
Pod	[ DIR ]	drwxr-xr-x	2024-02-12 23:56
Software	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
String	[ DIR ]	drwxr-xr-x	2024-12-02 12:30
Sub	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
TAP	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
Term	[ DIR ]	drwxr-xr-x	2024-02-12 23:57
Test	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
Test2	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
Text	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
Thread	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
Time	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
Try	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
Types	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
WWW	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
XML	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
YAML	[ DIR ]	drwxr-xr-x	2024-02-12 23:56
autodie	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
inc	[ DIR ]	drwxr-xr-x	2024-02-12 23:53
lib	[ DIR ]	drwxr-xr-x	2019-10-13 14:04
libwww	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
local	[ DIR ]	drwxr-xr-x	2024-02-12 23:51
CGI.pm	121.63 KB	-rw-r--r--	2017-12-01 08:28
CGI.pod	65.66 KB	-rw-r--r--	2017-03-29 08:46
CPAN.pm	138.01 KB	-rw-r--r--	2025-06-03 14:32
Carp.pm	30.32 KB	-rw-r--r--	2019-10-13 07:06
Digest.pm	10.46 KB	-rw-r--r--	2019-10-13 08:28
Env.pm	5.39 KB	-rw-r--r--	2013-03-02 17:10
Error.pm	24.29 KB	-rw-r--r--	2019-10-14 15:30
Expect.pm	98.09 KB	-rw-r--r--	2017-05-18 19:07
Exporter.pm	18.31 KB	-rw-r--r--	2019-10-13 08:52
Fatal.pm	56.81 KB	-rw-r--r--	2015-07-09 07:16
Fh.pm	166 B	-rw-r--r--	2017-12-01 08:28
Git.pm	46.95 KB	-rw-r--r--	2025-07-22 14:33
JSON.pm	53.65 KB	-rw-r--r--	2017-12-21 11:13
LWP.pm	21.17 KB	-rw-r--r--	2018-06-05 18:49
Test2.pm	6.24 KB	-rw-r--r--	2018-03-30 05:53
YAML.pm	3.06 KB	-r--r--r--	2017-10-30 19:32
YAML.pod	21.62 KB	-r--r--r--	2017-10-30 19:32
autodie.pm	12.58 KB	-rw-r--r--	2015-07-09 07:16
bigint.pm	22.85 KB	-rw-r--r--	2018-02-03 10:59
bignum.pm	20.64 KB	-rw-r--r--	2018-02-03 10:59
bigrat.pm	15.78 KB	-rw-r--r--	2018-02-03 10:59
constant.pm	14.38 KB	-rw-r--r--	2019-10-13 13:55
cpanfile-faq.pod	4.39 KB	-rw-r--r--	2016-02-12 16:23
cpanfile.pod	3.39 KB	-rw-r--r--	2016-02-12 16:23
experimental.pm	6.83 KB	-rw-r--r--	2017-12-03 17:40
newgetopt.pl	2.15 KB	-rw-r--r--	2010-07-09 12:26
ok.pm	967 B	-rw-r--r--	2018-03-30 05:53
parent.pm	2.51 KB	-rw-r--r--	2018-07-06 17:53
perldoc.pod	9.16 KB	-rw-r--r--	2016-08-02 16:31
perlfaq.pm	77 B	-rw-r--r--	2018-06-05 05:02
perlfaq.pod	22.22 KB	-rw-r--r--	2018-06-05 05:02
perlfaq1.pod	14.12 KB	-rw-r--r--	2018-06-05 05:02
perlfaq2.pod	9.24 KB	-rw-r--r--	2018-06-05 05:02
perlfaq3.pod	36.66 KB	-rw-r--r--	2018-06-05 05:02
perlfaq4.pod	87.3 KB	-rw-r--r--	2018-06-05 05:02
perlfaq5.pod	54.21 KB	-rw-r--r--	2018-06-05 05:02
perlfaq6.pod	38.69 KB	-rw-r--r--	2018-06-05 05:02
perlfaq7.pod	36.93 KB	-rw-r--r--	2018-06-05 05:02
perlfaq8.pod	48.93 KB	-rw-r--r--	2018-06-05 05:02
perlfaq9.pod	14.5 KB	-rw-r--r--	2018-06-05 05:02
perlglossary.pod	134.02 KB	-rw-r--r--	2018-06-05 05:02

Rename

=head1 NAME

cpanfile - A format for describing CPAN dependencies for Perl applications

=head1 SYNOPSIS

requires 'Plack', '1.0'; # 1.0 or newer
  requires 'JSON', '>= 2.00, < 2.80';

recommends 'JSON::XS', '2.0';
  conflicts 'JSON', '< 1.0';

on 'test' => sub {
    requires 'Test::More', '>= 0.96, < 2.0';
    recommends 'Test::TCP', '1.12';
  };

on 'develop' => sub {
    recommends 'Devel::NYTProf';
  };

feature 'sqlite', 'SQLite support' => sub {
    recommends 'DBD::SQLite';
  };

=head1 VERSION

This document describes cpanfile format version 1.0.

=head1 DESCRIPTION

C<cpanfile> describes CPAN dependencies required to execute associated
Perl code.

=head1 SYNTAX

=over 4

=item requires, recommends, suggests, conflicts

requires $module, $version_requirement;

Describes the requirement for a module. See L<CPAN::Meta::Spec> for
the meanings of each requirement type.

When version requirement is omitted, it is assumed that C<0> is
passed, meaning any version of the module would satisfy the
requirement.

Version requirement can either be a version number or a string that
satisfies L<CPAN::Meta::Spec/Version Ranges>, such as C<< >= 1.0, !=
1.1 >>.

Note that, per L<CPAN::Meta::Spec>, when a plain version number is
given, it means the version I<or newer> is required. If you want a
specific version for a module, use the specific range syntax, i.e.
C< == 2.1 >.

=item on

on $phase => sub { ... };

Describe requirements for a specific phase. Available phases are
C<configure>, C<build>, C<test>, C<runtime> and C<develop>.

=item feature

feature $identifier, $description => sub { ... };

Group requirements with features. Description can be omitted, when it
is assumed to be the same as identifier. See
L<CPAN::Meta::Spec/optional_features> for more details.

=item configure_requires, build_requires, test_requires, author_requires

configure_requires $module, $version;
  # on 'configure' => sub { requires $module, $version }

build_requires $module, $version;
  # on 'build' => sub { requires $module, $version };

test_requires $module, $version;
  # on 'test' => sub { requires $module, $version };

author_requires $module, $version;
  # on 'develop' => sub { requires $module, $version };

Shortcut for C<requires> in specific phase. This is mainly provided
for compatibilities with L<Module::Install> DSL.

=back

=head1 USAGE

C<cpanfile> is a format to describe dependencies. How to use this file
is dependent on the tools reading/writing it.

Usually, you're expected to place the C<cpanfile> in the root of the
directory containing the associated code.

Tools supporting C<cpanfile> format (e.g. L<cpanm> and L<carton>) will
automatically detect the file and install dependencies for the code to
run.

There are also tools to support converting cpanfile to CPAN toolchain
compatible formats, such as L<Module::CPANfile>,
L<Dist::Zilla::Plugin::Prereqs::FromCPANfile>,
L<Module::Install::CPANfile>, so that C<cpanfile> can be used to
describe dependencies for a CPAN distribution as well.

The L<cpanfile-dump> tool can be used to dump dependencies.

=head1 AUTHOR

Tatsuhiko Miyagawa

=head1 ACKNOWLEDGEMENTS

The format (DSL syntax) is inspired by L<Module::Install> and
L<Module::Build::Functions>.

C<cpanfile> specification (this document) is based on Ruby's
L<Gemfile|http://bundler.io/v1.3/man/gemfile.5.html> specification.

=head1 SEE ALSO

L<CPAN::Meta::Spec> L<Module::Install> L<Carton>

=cut