| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "CPAN::Meta::History::Meta_1_2 3perl" |
| 58 |
.TH CPAN::Meta::History::Meta_1_2 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide" |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
CPAN::Meta::History::Meta_1_2 \- Version 1.2 metadata specification for META.yml |
| 65 |
.SH PREFACE |
| 66 |
.IX Header "PREFACE" |
| 67 |
This is a historical copy of the version 1.2 specification for \fIMETA.yml\fR |
| 68 |
files, copyright by Ken Williams and licensed under the same terms as Perl |
| 69 |
itself. |
| 70 |
.PP |
| 71 |
Modifications from the original: |
| 72 |
.IP \(bu 4 |
| 73 |
Various spelling corrections |
| 74 |
.IP \(bu 4 |
| 75 |
Include list of valid licenses from Module::Build 0.2611 rather than |
| 76 |
linking to the module, with minor updates to text and links to reflect |
| 77 |
versions at the time of publication. |
| 78 |
.IP \(bu 4 |
| 79 |
Fixed some dead links to point to active resources. |
| 80 |
.SH SYNOPSIS |
| 81 |
.IX Header "SYNOPSIS" |
| 82 |
.Vb 10 |
| 83 |
\& \-\-\- #YAML:1.0 |
| 84 |
\& name: Module\-Build |
| 85 |
\& abstract: Build and install Perl modules |
| 86 |
\& version: 0.20 |
| 87 |
\& author: |
| 88 |
\& \- Ken Williams <[email protected]> |
| 89 |
\& license: perl |
| 90 |
\& distribution_type: module |
| 91 |
\& requires: |
| 92 |
\& Config: 0 |
| 93 |
\& Cwd: 0 |
| 94 |
\& Data::Dumper: 0 |
| 95 |
\& ExtUtils::Install: 0 |
| 96 |
\& File::Basename: 0 |
| 97 |
\& File::Compare: 0 |
| 98 |
\& File::Copy: 0 |
| 99 |
\& File::Find: 0 |
| 100 |
\& File::Path: 0 |
| 101 |
\& File::Spec: 0 |
| 102 |
\& IO::File: 0 |
| 103 |
\& perl: 5.005_03 |
| 104 |
\& recommends: |
| 105 |
\& Archive::Tar: 1.00 |
| 106 |
\& ExtUtils::Install: 0.3 |
| 107 |
\& ExtUtils::ParseXS: 2.02 |
| 108 |
\& Pod::Text: 0 |
| 109 |
\& YAML: 0.35 |
| 110 |
\& build_requires: |
| 111 |
\& Test: 0 |
| 112 |
\& urls: |
| 113 |
\& license: http://dev.perl.org/licenses/ |
| 114 |
\& meta\-spec: |
| 115 |
\& version: 1.2 |
| 116 |
\& url: http://module\-build.sourceforge.net/META\-spec\-v1.2.html |
| 117 |
\& generated_by: Module::Build version 0.20 |
| 118 |
.Ve |
| 119 |
.SH DESCRIPTION |
| 120 |
.IX Header "DESCRIPTION" |
| 121 |
This document describes version 1.2 of the \fIMETA.yml\fR specification. |
| 122 |
.PP |
| 123 |
The \fIMETA.yml\fR file describes important properties of contributed |
| 124 |
Perl distributions such as the ones found on CPAN. It is typically |
| 125 |
created by tools like Module::Build, Module::Install, and |
| 126 |
ExtUtils::MakeMaker. |
| 127 |
.PP |
| 128 |
The fields in the \fIMETA.yml\fR file are meant to be helpful for people |
| 129 |
maintaining module collections (like CPAN), for people writing |
| 130 |
installation tools (like CPAN.pm or CPANPLUS), or just for people who |
| 131 |
want to know some stuff about a distribution before downloading it and |
| 132 |
starting to install it. |
| 133 |
.PP |
| 134 |
\&\fINote: The latest stable version of this specification can always be |
| 135 |
found at <http://module\-build.sourceforge.net/META\-spec\-current.html>, |
| 136 |
and the latest development version (which may include things that |
| 137 |
won't make it into the stable version can always be found at |
| 138 |
<http://module\-build.sourceforge.net/META\-spec\-blead.html>.\fR |
| 139 |
.SH FORMAT |
| 140 |
.IX Header "FORMAT" |
| 141 |
\&\fIMETA.yml\fR files are written in the YAML format (see |
| 142 |
<http://www.yaml.org/>). |
| 143 |
.PP |
| 144 |
See the following links to learn why we chose YAML instead of, say, |
| 145 |
XML or Data::Dumper: |
| 146 |
.IP \(bu 4 |
| 147 |
Module::Build design plans <http://www.nntp.perl.org/group/perl.makemaker/2002/04/msg407.html> |
| 148 |
.IP \(bu 4 |
| 149 |
Not keen on YAML <http://www.nntp.perl.org/group/perl.module-authors/2003/11/msg1353.html> |
| 150 |
.IP \(bu 4 |
| 151 |
META Concerns <http://www.nntp.perl.org/group/perl.module-authors/2003/11/msg1385.html> |
| 152 |
.SH TERMINOLOGY |
| 153 |
.IX Header "TERMINOLOGY" |
| 154 |
.IP distribution 4 |
| 155 |
.IX Item "distribution" |
| 156 |
This is the primary object described by the \fIMETA.yml\fR |
| 157 |
specification. In the context of this document it usually refers to a |
| 158 |
collection of modules, scripts, and/or documents that are distributed |
| 159 |
for other developers to use. |
| 160 |
.IP module 4 |
| 161 |
.IX Item "module" |
| 162 |
This refers to a reusable library of code typically contained in a |
| 163 |
single file. Currently, we primarily talk of perl modules, but this |
| 164 |
specification should be open enough to apply to other languages as |
| 165 |
well (ex. python, ruby). |
| 166 |
.SH "VERSION SPECIFICATIONS" |
| 167 |
.IX Header "VERSION SPECIFICATIONS" |
| 168 |
Some fields require a version specification (ex. "requires", |
| 169 |
"recommends", "build_requires", etc.). This section details the |
| 170 |
version specifications that are currently supported. |
| 171 |
.PP |
| 172 |
If a single version is listed, then that version is considered to be |
| 173 |
the minimum version supported. |
| 174 |
.PP |
| 175 |
If 0 is given as the version number, then any version is supported. |
| 176 |
.PP |
| 177 |
Additionally, for more complicated requirements, the specification |
| 178 |
supports a list of versions, each of which may be optionally preceded |
| 179 |
by a relational operator. |
| 180 |
.PP |
| 181 |
Supported operators include < (less than), <= (less than or |
| 182 |
equal), > (greater than), >= (greater than or equal), == (equal), and != |
| 183 |
(not equal). |
| 184 |
.PP |
| 185 |
If a list is given then it is evaluated from left to right so that any |
| 186 |
specifications in the list that conflict with a previous specification |
| 187 |
are overridden by the later. |
| 188 |
.PP |
| 189 |
Examples: |
| 190 |
.PP |
| 191 |
.Vb 1 |
| 192 |
\& >= 1.2, != 1.5, < 2.0 |
| 193 |
.Ve |
| 194 |
.PP |
| 195 |
Any version from version 1.2 onward, except version 1.5, that also |
| 196 |
precedes version 2.0. |
| 197 |
.SH HEADER |
| 198 |
.IX Header "HEADER" |
| 199 |
The first line of a \fIMETA.yml\fR file should be a valid YAML document |
| 200 |
header like \f(CW"\-\-\- #YAML:1.0"\fR. |
| 201 |
.SH FIELDS |
| 202 |
.IX Header "FIELDS" |
| 203 |
The rest of the \fIMETA.yml\fR file is one big YAML mapping whose keys |
| 204 |
are described here. |
| 205 |
.SS meta-spec |
| 206 |
.IX Subsection "meta-spec" |
| 207 |
Example: |
| 208 |
.PP |
| 209 |
.Vb 3 |
| 210 |
\& meta\-spec: |
| 211 |
\& version: 1.2 |
| 212 |
\& url: http://module\-build.sourceforge.net/META\-spec\-v1.2.html |
| 213 |
.Ve |
| 214 |
.PP |
| 215 |
(Spec 1.1) [required] {URL} This field indicates the location of the |
| 216 |
version of the META.yml specification used. |
| 217 |
.SS name |
| 218 |
.IX Subsection "name" |
| 219 |
Example: |
| 220 |
.PP |
| 221 |
.Vb 1 |
| 222 |
\& name: Module\-Build |
| 223 |
.Ve |
| 224 |
.PP |
| 225 |
(Spec 1.0) [required] {string} The name of the distribution which is often |
| 226 |
created by taking the "main module" in the distribution and changing |
| 227 |
"::" to "\-". Sometimes it's completely different, however, as in the |
| 228 |
case of the libwww-perl distribution (see |
| 229 |
<http://search.cpan.org/author/GAAS/libwww\-perl/>). |
| 230 |
.SS version |
| 231 |
.IX Subsection "version" |
| 232 |
Example: |
| 233 |
.PP |
| 234 |
.Vb 1 |
| 235 |
\& version: 0.20 |
| 236 |
.Ve |
| 237 |
.PP |
| 238 |
(Spec 1.0) [required] {version} The version of the distribution to which the |
| 239 |
\&\fIMETA.yml\fR file refers. |
| 240 |
.SS abstract |
| 241 |
.IX Subsection "abstract" |
| 242 |
Example: |
| 243 |
.PP |
| 244 |
.Vb 1 |
| 245 |
\& abstract: Build and install Perl modules. |
| 246 |
.Ve |
| 247 |
.PP |
| 248 |
(Spec 1.1) [required] {string} A short description of the purpose of the |
| 249 |
distribution. |
| 250 |
.SS author |
| 251 |
.IX Subsection "author" |
| 252 |
Example: |
| 253 |
.PP |
| 254 |
.Vb 2 |
| 255 |
\& author: |
| 256 |
\& \- Ken Williams <[email protected]> |
| 257 |
.Ve |
| 258 |
.PP |
| 259 |
(Spec 1.1) [required] {list of strings} A YAML sequence indicating the author(s) of the |
| 260 |
distribution. The preferred form is author-name <email\-address>. |
| 261 |
.SS license |
| 262 |
.IX Subsection "license" |
| 263 |
Example: |
| 264 |
.PP |
| 265 |
.Vb 1 |
| 266 |
\& license: perl |
| 267 |
.Ve |
| 268 |
.PP |
| 269 |
(Spec 1.0) [required] {string} The license under which this distribution may be |
| 270 |
used and redistributed. |
| 271 |
.PP |
| 272 |
Must be one of the following licenses: |
| 273 |
.IP perl 4 |
| 274 |
.IX Item "perl" |
| 275 |
The distribution may be copied and redistributed under the same terms as perl |
| 276 |
itself (this is by far the most common licensing option for modules on CPAN). |
| 277 |
This is a dual license, in which the user may choose between either the GPL |
| 278 |
version 1 or the Artistic version 1 license. |
| 279 |
.IP gpl 4 |
| 280 |
.IX Item "gpl" |
| 281 |
The distribution is distributed under the terms of the GNU General Public |
| 282 |
License version 2 (<http://opensource.org/licenses/GPL\-2.0>). |
| 283 |
.IP lgpl 4 |
| 284 |
.IX Item "lgpl" |
| 285 |
The distribution is distributed under the terms of the GNU Lesser General |
| 286 |
Public License version 2 (<http://opensource.org/licenses/LGPL\-2.1>). |
| 287 |
.IP artistic 4 |
| 288 |
.IX Item "artistic" |
| 289 |
The distribution is licensed under the Artistic License version 1, as specified |
| 290 |
by the Artistic file in the standard perl distribution |
| 291 |
(<http://opensource.org/licenses/Artistic\-Perl\-1.0>). |
| 292 |
.IP bsd 4 |
| 293 |
.IX Item "bsd" |
| 294 |
The distribution is licensed under the BSD 3\-Clause License |
| 295 |
(<http://opensource.org/licenses/BSD\-3\-Clause>). |
| 296 |
.IP open_source 4 |
| 297 |
.IX Item "open_source" |
| 298 |
The distribution is licensed under some other Open Source Initiative-approved |
| 299 |
license listed at <http://www.opensource.org/licenses/>. |
| 300 |
.IP unrestricted 4 |
| 301 |
.IX Item "unrestricted" |
| 302 |
The distribution is licensed under a license that is \fBnot\fR approved by |
| 303 |
www.opensource.org <http://www.opensource.org/> but that allows distribution |
| 304 |
without restrictions. |
| 305 |
.IP restrictive 4 |
| 306 |
.IX Item "restrictive" |
| 307 |
The distribution may not be redistributed without special permission from the |
| 308 |
author and/or copyright holder. |
| 309 |
.SS distribution_type |
| 310 |
.IX Subsection "distribution_type" |
| 311 |
Example: |
| 312 |
.PP |
| 313 |
.Vb 1 |
| 314 |
\& distribution_type: module |
| 315 |
.Ve |
| 316 |
.PP |
| 317 |
(Spec 1.0) [optional] {string} What kind of stuff is contained in this |
| 318 |
distribution. Most things on CPAN are \f(CW\*(C`module\*(C'\fRs (which can also mean |
| 319 |
a collection of modules), but some things are \f(CW\*(C`script\*(C'\fRs. |
| 320 |
.PP |
| 321 |
Unfortunately this field is basically meaningless, since many |
| 322 |
distributions are hybrids of several kinds of things, or some new |
| 323 |
thing, or subjectively different in focus depending on who's using |
| 324 |
them. Tools like Module::Build and MakeMaker will likely stop |
| 325 |
generating this field. |
| 326 |
.SS requires |
| 327 |
.IX Subsection "requires" |
| 328 |
Example: |
| 329 |
.PP |
| 330 |
.Vb 3 |
| 331 |
\& requires: |
| 332 |
\& Data::Dumper: 0 |
| 333 |
\& File::Find: 1.03 |
| 334 |
.Ve |
| 335 |
.PP |
| 336 |
(Spec 1.0) [optional] {map} A YAML mapping indicating the Perl modules this |
| 337 |
distribution requires for proper operation. The keys are the module |
| 338 |
names, and the values are version specifications as described in |
| 339 |
Module::Build for the "requires" parameter. |
| 340 |
.SS recommends |
| 341 |
.IX Subsection "recommends" |
| 342 |
Example: |
| 343 |
.PP |
| 344 |
.Vb 3 |
| 345 |
\& recommends: |
| 346 |
\& Data::Dumper: 0 |
| 347 |
\& File::Find: 1.03 |
| 348 |
.Ve |
| 349 |
.PP |
| 350 |
(Spec 1.0) [optional] {map} A YAML mapping indicating the Perl modules this |
| 351 |
distribution recommends for enhanced operation. |
| 352 |
.PP |
| 353 |
\&\fIALTERNATIVE: It may be desirable to present to the user which |
| 354 |
features depend on which modules so they can make an informed |
| 355 |
decision about which recommended modules to install.\fR |
| 356 |
.PP |
| 357 |
Example: |
| 358 |
.PP |
| 359 |
.Vb 9 |
| 360 |
\& optional_features: |
| 361 |
\& \- foo: |
| 362 |
\& description: Provides the ability to blah. |
| 363 |
\& requires: |
| 364 |
\& Data::Dumper: 0 |
| 365 |
\& File::Find: 1.03 |
| 366 |
\& \- bar: |
| 367 |
\& description: This feature is not available on this platform. |
| 368 |
\& excludes_os: MSWin32 |
| 369 |
.Ve |
| 370 |
.PP |
| 371 |
\&\fI(Spec 1.1) [optional] {map} A YAML sequence of names for optional features |
| 372 |
which are made available when its requirements are met. For each |
| 373 |
feature a description is provided along with any of "requires", |
| 374 |
"build_requires", "conflicts", \fR\f(CI\*(C`requires_packages\*(C'\fR\fI, |
| 375 |
\&\fR\f(CI\*(C`requires_os\*(C'\fR\fI, and \fR\f(CI\*(C`excludes_os\*(C'\fR\fI which have the same meaning in |
| 376 |
this subcontext as described elsewhere in this document.\fR |
| 377 |
.SS build_requires |
| 378 |
.IX Subsection "build_requires" |
| 379 |
Example: |
| 380 |
.PP |
| 381 |
.Vb 3 |
| 382 |
\& build_requires: |
| 383 |
\& Data::Dumper: 0 |
| 384 |
\& File::Find: 1.03 |
| 385 |
.Ve |
| 386 |
.PP |
| 387 |
(Spec 1.0) [optional] {map} A YAML mapping indicating the Perl modules |
| 388 |
required for building and/or testing of this distribution. These |
| 389 |
dependencies are not required after the module is installed. |
| 390 |
.SS conflicts |
| 391 |
.IX Subsection "conflicts" |
| 392 |
Example: |
| 393 |
.PP |
| 394 |
.Vb 3 |
| 395 |
\& conflicts: |
| 396 |
\& Data::Dumper: 0 |
| 397 |
\& File::Find: 1.03 |
| 398 |
.Ve |
| 399 |
.PP |
| 400 |
(Spec 1.0) [optional] {map} A YAML mapping indicating the Perl modules that |
| 401 |
cannot be installed while this distribution is installed. This is a |
| 402 |
pretty uncommon situation. |
| 403 |
.SS dynamic_config |
| 404 |
.IX Subsection "dynamic_config" |
| 405 |
Example: |
| 406 |
.PP |
| 407 |
.Vb 1 |
| 408 |
\& dynamic_config: 0 |
| 409 |
.Ve |
| 410 |
.PP |
| 411 |
(Spec 1.0) [optional] {boolean} A boolean flag indicating whether a \fIBuild.PL\fR |
| 412 |
or \fIMakefile.PL\fR (or similar) must be executed when building this |
| 413 |
distribution, or whether it can be built, tested and installed solely |
| 414 |
from consulting its |
| 415 |
metadata file. The main reason to set this to a true value if that |
| 416 |
your module performs some dynamic configuration (asking questions, |
| 417 |
sensing the environment, etc.) as part of its build/install process. |
| 418 |
.PP |
| 419 |
Currently Module::Build doesn't actually do anything with this flag |
| 420 |
\&\- it's probably going to be up to higher-level tools like CPAN |
| 421 |
to do something useful with it. It can potentially bring lots of |
| 422 |
security, packaging, and convenience improvements. |
| 423 |
.PP |
| 424 |
If this field is omitted, it defaults to 1 (true). |
| 425 |
.SS private |
| 426 |
.IX Subsection "private" |
| 427 |
\&\fI(Deprecated)\fR (Spec 1.0) [optional] {map} This field has been renamed to |
| 428 |
"no_index". See below. |
| 429 |
.SS provides |
| 430 |
.IX Subsection "provides" |
| 431 |
Example: |
| 432 |
.PP |
| 433 |
.Vb 9 |
| 434 |
\& provides: |
| 435 |
\& Foo::Bar: |
| 436 |
\& file: lib/Foo/Bar.pm |
| 437 |
\& version: 0.27_02 |
| 438 |
\& Foo::Bar::Blah: |
| 439 |
\& file: lib/Foo/Bar/Blah.pm |
| 440 |
\& Foo::Bar::Baz: |
| 441 |
\& file: lib/Foo/Bar/Baz.pm |
| 442 |
\& version: 0.3 |
| 443 |
.Ve |
| 444 |
.PP |
| 445 |
(Spec 1.1) [optional] {map} A YAML mapping that describes all packages |
| 446 |
provided by this distribution. This information can be (and, in some |
| 447 |
cases, is) used by distribution and automation mechanisms like PAUSE, |
| 448 |
CPAN, and search.cpan.org to build indexes saying in which |
| 449 |
distribution various packages can be found. |
| 450 |
.PP |
| 451 |
When using tools like Module::Build that can generate the |
| 452 |
\&\f(CW\*(C`provides\*(C'\fR mapping for your distribution automatically, make sure you |
| 453 |
examine what it generates to make sure it makes sense \- indexers will |
| 454 |
usually trust the \f(CW\*(C`provides\*(C'\fR field if it's present, rather than |
| 455 |
scanning through the distribution files themselves to figure out |
| 456 |
packages and versions. This is a good thing, because it means you can |
| 457 |
use the \f(CW\*(C`provides\*(C'\fR field to tell the indexers precisely what you want |
| 458 |
indexed about your distribution, rather than relying on them to |
| 459 |
essentially guess what you want indexed. |
| 460 |
.SS no_index |
| 461 |
.IX Subsection "no_index" |
| 462 |
Example: |
| 463 |
.PP |
| 464 |
.Vb 9 |
| 465 |
\& no_index: |
| 466 |
\& file: |
| 467 |
\& \- My/Module.pm |
| 468 |
\& dir: |
| 469 |
\& \- My/Private |
| 470 |
\& package: |
| 471 |
\& \- My::Module::Stuff |
| 472 |
\& namespace: |
| 473 |
\& \- My::Module::Stuff |
| 474 |
.Ve |
| 475 |
.PP |
| 476 |
(Spec 1.1) [optional] {map} A YAML mapping that describes any files, |
| 477 |
directories, packages, and namespaces that are private |
| 478 |
(i.e. implementation artifacts) that are not of interest to searching |
| 479 |
and indexing tools. This is useful when no \f(CW\*(C`provides\*(C'\fR field is |
| 480 |
present. |
| 481 |
.PP |
| 482 |
\&\fI(Note: I'm not actually sure who looks at this field, or exactly |
| 483 |
what they do with it. This spec could be off in some way from actual |
| 484 |
usage.)\fR |
| 485 |
.PP |
| 486 |
\fIfile\fR |
| 487 |
.IX Subsection "file" |
| 488 |
.PP |
| 489 |
(Spec 1.1) [optional] Exclude any listed file(s). |
| 490 |
.PP |
| 491 |
\fIdir\fR |
| 492 |
.IX Subsection "dir" |
| 493 |
.PP |
| 494 |
(Spec 1.1) [optional] Exclude anything below the listed |
| 495 |
directory(ies). |
| 496 |
.PP |
| 497 |
\fIpackage\fR |
| 498 |
.IX Subsection "package" |
| 499 |
.PP |
| 500 |
(Spec 1.1) [optional] Exclude the listed package(s). |
| 501 |
.PP |
| 502 |
\fInamespace\fR |
| 503 |
.IX Subsection "namespace" |
| 504 |
.PP |
| 505 |
(Spec 1.1) [optional] Excludes anything below the listed namespace(s), |
| 506 |
but \fInot\fR the listed namespace(s) its self. |
| 507 |
.SS keywords |
| 508 |
.IX Subsection "keywords" |
| 509 |
Example: |
| 510 |
.PP |
| 511 |
.Vb 4 |
| 512 |
\& keywords: |
| 513 |
\& \- make |
| 514 |
\& \- build |
| 515 |
\& \- install |
| 516 |
.Ve |
| 517 |
.PP |
| 518 |
(Spec 1.1) [optional] {list} A sequence of keywords/phrases that describe |
| 519 |
this distribution. |
| 520 |
.SS resources |
| 521 |
.IX Subsection "resources" |
| 522 |
Example: |
| 523 |
.PP |
| 524 |
.Vb 5 |
| 525 |
\& resources: |
| 526 |
\& license: http://dev.perl.org/licenses/ |
| 527 |
\& homepage: http://sourceforge.net/projects/module\-build |
| 528 |
\& bugtracker: http://rt.cpan.org/NoAuth/Bugs.html?Dist=Module\-Build |
| 529 |
\& MailingList: http://lists.sourceforge.net/lists/listinfo/module\-build\-general |
| 530 |
.Ve |
| 531 |
.PP |
| 532 |
(Spec 1.1) [optional] {map} A mapping of any URL resources related to |
| 533 |
this distribution. All-lower-case keys, such as \f(CW\*(C`homepage\*(C'\fR, |
| 534 |
\&\f(CW\*(C`license\*(C'\fR, and \f(CW\*(C`bugtracker\*(C'\fR, are reserved by this specification, as |
| 535 |
they have "official" meanings defined here in this specification. If |
| 536 |
you'd like to add your own "special" entries (like the "MailingList" |
| 537 |
entry above), use at least one upper-case letter. |
| 538 |
.PP |
| 539 |
The current set of official keys is: |
| 540 |
.IP homepage 2 |
| 541 |
.IX Item "homepage" |
| 542 |
The official home of this project on the web. |
| 543 |
.IP license 2 |
| 544 |
.IX Item "license" |
| 545 |
An URL for an official statement of this distribution's license. |
| 546 |
.IP bugtracker 2 |
| 547 |
.IX Item "bugtracker" |
| 548 |
An URL for a bug tracker (e.g. Bugzilla or RT queue) for this project. |
| 549 |
.SS generated_by |
| 550 |
.IX Subsection "generated_by" |
| 551 |
Example: |
| 552 |
.PP |
| 553 |
.Vb 1 |
| 554 |
\& generated_by: Module::Build version 0.20 |
| 555 |
.Ve |
| 556 |
.PP |
| 557 |
(Spec 1.0) [required] {string} Indicates the tool that was used to create this |
| 558 |
\&\fIMETA.yml\fR file. It's good form to include both the name of the tool |
| 559 |
and its version, but this field is essentially opaque, at least for |
| 560 |
the moment. If \fIMETA.yml\fR was generated by hand, it is suggested that |
| 561 |
the author be specified here. |
| 562 |
.PP |
| 563 |
[Note: My \fImeta_stats.pl\fR script which I use to gather statistics |
| 564 |
regarding \fIMETA.yml\fR usage prefers the form listed above, i.e. it |
| 565 |
splits on /\es+version\es+/ taking the first field as the name of the |
| 566 |
tool that generated the file and the second field as version of that |
| 567 |
tool. RWS] |
| 568 |
.SH "SEE ALSO" |
| 569 |
.IX Header "SEE ALSO" |
| 570 |
CPAN <http://www.cpan.org/> |
| 571 |
.PP |
| 572 |
CPAN.pm |
| 573 |
.PP |
| 574 |
CPANPLUS |
| 575 |
.PP |
| 576 |
Data::Dumper |
| 577 |
.PP |
| 578 |
ExtUtils::MakeMaker |
| 579 |
.PP |
| 580 |
Module::Build |
| 581 |
.PP |
| 582 |
Module::Install |
| 583 |
.PP |
| 584 |
XML <http://www.w3.org/XML/> |
| 585 |
.PP |
| 586 |
YAML <http://www.yaml.org/> |
| 587 |
.SH HISTORY |
| 588 |
.IX Header "HISTORY" |
| 589 |
.IP "March 14, 2003 (Pi day)" 4 |
| 590 |
.IX Item "March 14, 2003 (Pi day)" |
| 591 |
.RS 4 |
| 592 |
.PD 0 |
| 593 |
.IP \(bu 2 |
| 594 |
.PD |
| 595 |
Created version 1.0 of this document. |
| 596 |
.RE |
| 597 |
.RS 4 |
| 598 |
.RE |
| 599 |
.IP "May 8, 2003" 4 |
| 600 |
.IX Item "May 8, 2003" |
| 601 |
.RS 4 |
| 602 |
.PD 0 |
| 603 |
.IP \(bu 2 |
| 604 |
.PD |
| 605 |
Added the "dynamic_config" field, which was missing from the initial |
| 606 |
version. |
| 607 |
.RE |
| 608 |
.RS 4 |
| 609 |
.RE |
| 610 |
.IP "November 13, 2003" 4 |
| 611 |
.IX Item "November 13, 2003" |
| 612 |
.RS 4 |
| 613 |
.PD 0 |
| 614 |
.IP \(bu 2 |
| 615 |
.PD |
| 616 |
Added more YAML rationale articles. |
| 617 |
.IP \(bu 2 |
| 618 |
Fixed existing link to YAML discussion thread to point to new |
| 619 |
<http://nntp.x.perl.org/group/> site. |
| 620 |
.IP \(bu 2 |
| 621 |
Added and deprecated the "private" field. |
| 622 |
.IP \(bu 2 |
| 623 |
Added "abstract", \f(CW\*(C`configure\*(C'\fR, \f(CW\*(C`requires_packages\*(C'\fR, |
| 624 |
\&\f(CW\*(C`requires_os\*(C'\fR, \f(CW\*(C`excludes_os\*(C'\fR, and "no_index" fields. |
| 625 |
.IP \(bu 2 |
| 626 |
Bumped version. |
| 627 |
.RE |
| 628 |
.RS 4 |
| 629 |
.RE |
| 630 |
.IP "November 16, 2003" 4 |
| 631 |
.IX Item "November 16, 2003" |
| 632 |
.RS 4 |
| 633 |
.PD 0 |
| 634 |
.IP \(bu 2 |
| 635 |
.PD |
| 636 |
Added \f(CW\*(C`generation\*(C'\fR, \f(CW\*(C`authored_by\*(C'\fR fields. |
| 637 |
.IP \(bu 2 |
| 638 |
Add alternative proposal to the "recommends" field. |
| 639 |
.IP \(bu 2 |
| 640 |
Add proposal for a \f(CW\*(C`requires_build_tools\*(C'\fR field. |
| 641 |
.RE |
| 642 |
.RS 4 |
| 643 |
.RE |
| 644 |
.IP "December 9, 2003" 4 |
| 645 |
.IX Item "December 9, 2003" |
| 646 |
.RS 4 |
| 647 |
.PD 0 |
| 648 |
.IP \(bu 2 |
| 649 |
.PD |
| 650 |
Added link to latest version of this specification on CPAN. |
| 651 |
.IP \(bu 2 |
| 652 |
Added section "VERSION SPECIFICATIONS". |
| 653 |
.IP \(bu 2 |
| 654 |
Chang name from Module::Build::META\-spec to CPAN::META::Specification. |
| 655 |
.IP \(bu 2 |
| 656 |
Add proposal for \f(CW\*(C`auto_regenerate\*(C'\fR field. |
| 657 |
.RE |
| 658 |
.RS 4 |
| 659 |
.RE |
| 660 |
.IP "December 15, 2003" 4 |
| 661 |
.IX Item "December 15, 2003" |
| 662 |
.RS 4 |
| 663 |
.PD 0 |
| 664 |
.IP \(bu 2 |
| 665 |
.PD |
| 666 |
Add \f(CW\*(C`index\*(C'\fR field as a compliment to "no_index" |
| 667 |
.IP \(bu 2 |
| 668 |
Add "keywords" field as a means to aid searching distributions. |
| 669 |
.IP \(bu 2 |
| 670 |
Add "TERMINOLOGY" section to explain certain terms that may be |
| 671 |
ambiguous. |
| 672 |
.RE |
| 673 |
.RS 4 |
| 674 |
.RE |
| 675 |
.IP "July 26, 2005" 4 |
| 676 |
.IX Item "July 26, 2005" |
| 677 |
.RS 4 |
| 678 |
.PD 0 |
| 679 |
.IP \(bu 2 |
| 680 |
.PD |
| 681 |
Removed a bunch of items (generation, requires_build_tools, |
| 682 |
requires_packages, configure, requires_os, excludes_os, |
| 683 |
auto_regenerate) that have never actually been supported, but were |
| 684 |
more like records of brainstorming. |
| 685 |
.IP \(bu 2 |
| 686 |
Changed \f(CW\*(C`authored_by\*(C'\fR to "author", since that's always been what |
| 687 |
it's actually called in actual \fIMETA.yml\fR files. |
| 688 |
.IP \(bu 2 |
| 689 |
Added the "==" operator to the list of supported version-checking |
| 690 |
operators. |
| 691 |
.IP \(bu 2 |
| 692 |
Noted that the "distribution_type" field is basically meaningless, |
| 693 |
and shouldn't really be used. |
| 694 |
.IP \(bu 2 |
| 695 |
Clarified "dynamic_config" a bit. |
| 696 |
.RE |
| 697 |
.RS 4 |
| 698 |
.RE |
| 699 |
.IP "August 23, 2005" 4 |
| 700 |
.IX Item "August 23, 2005" |
| 701 |
.RS 4 |
| 702 |
.PD 0 |
| 703 |
.IP \(bu 2 |
| 704 |
.PD |
| 705 |
Removed the name \f(CW\*(C`CPAN::META::Specification\*(C'\fR, since that implies a |
| 706 |
module that doesn't actually exist. |
| 707 |
.RE |
| 708 |
.RS 4 |
| 709 |
.RE |