| 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_1 3perl" |
| 58 |
.TH CPAN::Meta::History::Meta_1_1 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_1 \- Version 1.1 metadata specification for META.yml |
| 65 |
.SH PREFACE |
| 66 |
.IX Header "PREFACE" |
| 67 |
This is a historical copy of the version 1.1 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 |
Conversion from the original HTML to POD format |
| 74 |
.IP \(bu 4 |
| 75 |
Include list of valid licenses from Module::Build 0.18 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 DESCRIPTION |
| 81 |
.IX Header "DESCRIPTION" |
| 82 |
This document describes version 1.1 of the \fIMETA.yml\fR specification. |
| 83 |
.PP |
| 84 |
The \fIMETA.yml\fR file describes important properties of contributed Perl |
| 85 |
distributions such as the ones found on CPAN <http://www.cpan.org>. It is |
| 86 |
typically created by tools like Module::Build and ExtUtils::MakeMaker. |
| 87 |
.PP |
| 88 |
The fields in the \fIMETA.yml\fR file are meant to be helpful to people |
| 89 |
maintaining module collections (like CPAN), for people writing |
| 90 |
installation tools (like CPAN or CPANPLUS), or just people who want to |
| 91 |
know some stuff about a distribution before downloading it and starting to |
| 92 |
install it. |
| 93 |
.SH Format |
| 94 |
.IX Header "Format" |
| 95 |
\&\fIMETA.yml\fR files are written in the YAML <http://www.yaml.org/> format. The |
| 96 |
reasons we chose YAML instead of, say, XML or Data::Dumper are discussed in |
| 97 |
this thread <http://www.nntp.perl.org/group/perl.makemaker/2002/04/msg406.html> |
| 98 |
on the MakeMaker mailing list. |
| 99 |
.PP |
| 100 |
The first line of a \fIMETA.yml\fR file should be a valid |
| 101 |
YAML document header <http://yaml.org/spec/history/2002-10-31.html#syntax-document> |
| 102 |
like \f(CW"\-\-\- #YAML:1.0"\fR |
| 103 |
.SH Fields |
| 104 |
.IX Header "Fields" |
| 105 |
The rest of the META.yml file is one big YAML |
| 106 |
mapping <http://yaml.org/spec/history/2002-10-31.html#syntax-mapping>, |
| 107 |
whose keys are described here. |
| 108 |
.IP name 4 |
| 109 |
.IX Item "name" |
| 110 |
Example: \f(CW\*(C`Module\-Build\*(C'\fR |
| 111 |
.Sp |
| 112 |
The name of the distribution. Often created by taking the "main |
| 113 |
module" in the distribution and changing "::" to "\-". Sometimes it's |
| 114 |
completely different, however, as in the case of the |
| 115 |
libwww-perl <http://search.cpan.org/author/GAAS/libwww-perl/> distribution. |
| 116 |
.IP version 4 |
| 117 |
.IX Item "version" |
| 118 |
Example: \f(CW0.16\fR |
| 119 |
.Sp |
| 120 |
The version of the distribution to which the META.yml file refers. |
| 121 |
This is a mandatory field. |
| 122 |
.Sp |
| 123 |
The version is essentially an arbitrary string, but \fImust\fR be |
| 124 |
only ASCII characters, and \fIstrongly should\fR be of the format |
| 125 |
integer-dot-digit-digit, i.e. \f(CW25.57\fR, optionally followed by |
| 126 |
underscore-digit-digit, i.e. \f(CW\*(C`25.57_04\*(C'\fR. |
| 127 |
.Sp |
| 128 |
The standard tools that deal with module distribution (PAUSE, CPAN, |
| 129 |
etc.) form an identifier for each distribution by joining the 'name' |
| 130 |
and 'version' attributes with a dash (\f(CW\*(C`\-\*(C'\fR) character. Tools |
| 131 |
who are prepared to deal with distributions that have no version |
| 132 |
numbers generally omit the dash as well. |
| 133 |
.IP license 4 |
| 134 |
.IX Item "license" |
| 135 |
Example: \f(CW\*(C`perl\*(C'\fR |
| 136 |
.Sp |
| 137 |
a descriptive term for the licenses ... not authoritative, but must |
| 138 |
be consistent with licensure statements in the READMEs, documentation, etc. |
| 139 |
.Sp |
| 140 |
The license under which this distribution may be used and |
| 141 |
redistributed. |
| 142 |
.Sp |
| 143 |
Must be one of the following licenses: |
| 144 |
.RS 4 |
| 145 |
.IP perl 4 |
| 146 |
.IX Item "perl" |
| 147 |
The distribution may be copied and redistributed under the same terms as perl |
| 148 |
itself (this is by far the most common licensing option for modules on CPAN). |
| 149 |
This is a dual license, in which the user may choose between either the GPL |
| 150 |
version 1 or the Artistic version 1 license. |
| 151 |
.IP gpl 4 |
| 152 |
.IX Item "gpl" |
| 153 |
The distribution is distributed under the terms of the GNU General Public |
| 154 |
License version 2 (<http://opensource.org/licenses/GPL\-2.0>). |
| 155 |
.IP lgpl 4 |
| 156 |
.IX Item "lgpl" |
| 157 |
The distribution is distributed under the terms of the GNU Lesser General |
| 158 |
Public License version 2 (<http://opensource.org/licenses/LGPL\-2.1>). |
| 159 |
.IP artistic 4 |
| 160 |
.IX Item "artistic" |
| 161 |
The distribution is licensed under the Artistic License version 1, as specified |
| 162 |
by the Artistic file in the standard perl distribution |
| 163 |
(<http://opensource.org/licenses/Artistic\-Perl\-1.0>). |
| 164 |
.IP bsd 4 |
| 165 |
.IX Item "bsd" |
| 166 |
The distribution is licensed under the BSD 3\-Clause License |
| 167 |
(<http://opensource.org/licenses/BSD\-3\-Clause>). |
| 168 |
.IP open_source 4 |
| 169 |
.IX Item "open_source" |
| 170 |
The distribution is licensed under some other Open Source Initiative-approved |
| 171 |
license listed at <http://www.opensource.org/licenses/>. |
| 172 |
.IP unrestricted 4 |
| 173 |
.IX Item "unrestricted" |
| 174 |
The distribution is licensed under a license that is \fBnot\fR approved by |
| 175 |
www.opensource.org <http://www.opensource.org/> but that allows distribution |
| 176 |
without restrictions. |
| 177 |
.IP restrictive 4 |
| 178 |
.IX Item "restrictive" |
| 179 |
The distribution may not be redistributed without special permission from the |
| 180 |
author and/or copyright holder. |
| 181 |
.RE |
| 182 |
.RS 4 |
| 183 |
.RE |
| 184 |
.IP license_uri 4 |
| 185 |
.IX Item "license_uri" |
| 186 |
This should contain a URI where the exact terms of the license may be found. |
| 187 |
.Sp |
| 188 |
(change "unrestricted" to "redistributable"?) |
| 189 |
.IP distribution_type 4 |
| 190 |
.IX Item "distribution_type" |
| 191 |
Example: \f(CW\*(C`module\*(C'\fR |
| 192 |
.Sp |
| 193 |
What kind of stuff is contained in this distribution. Most things on |
| 194 |
CPAN are \f(CW\*(C`module\*(C'\fRs (which can also mean a collection of |
| 195 |
modules), but some things are \f(CW\*(C`script\*(C'\fRs. |
| 196 |
.Sp |
| 197 |
This field is basically meaningless, and tools (like Module::Build or |
| 198 |
MakeMaker) will likely stop generating it in the future. |
| 199 |
.IP private 4 |
| 200 |
.IX Item "private" |
| 201 |
WTF is going on here? |
| 202 |
.Sp |
| 203 |
index_ignore: any application that indexes the contents of |
| 204 |
distributions (PAUSE, search.cpan.org) ought to ignore the items |
| 205 |
(packages, files, directories, namespace hierarchies). |
| 206 |
.IP requires 4 |
| 207 |
.IX Item "requires" |
| 208 |
Example: |
| 209 |
.Sp |
| 210 |
.Vb 2 |
| 211 |
\& Data::Dumper: 0 |
| 212 |
\& File::Find: 1.03 |
| 213 |
.Ve |
| 214 |
.Sp |
| 215 |
A YAML mapping <http://yaml.org/spec/history/2002-10-31.html#syntax-mapping> |
| 216 |
indicating the Perl modules this distribution requires for proper |
| 217 |
operation. The keys are the module names, and the values are version |
| 218 |
specifications as described in the |
| 219 |
documentation for Module::Build's "requires" parameter. |
| 220 |
.Sp |
| 221 |
\&\fINote: the exact nature of the fancy specifications like |
| 222 |
\&\fR\f(CI">= 1.2, != 1.5, < 2.0"\fR\fI is subject to |
| 223 |
change. Advance notice will be given here. The simple specifications |
| 224 |
like \fR\f(CI"1.2"\fR\fI will not change in format.\fR |
| 225 |
.IP recommends 4 |
| 226 |
.IX Item "recommends" |
| 227 |
Example: |
| 228 |
.Sp |
| 229 |
.Vb 2 |
| 230 |
\& Data::Dumper: 0 |
| 231 |
\& File::Find: 1.03 |
| 232 |
.Ve |
| 233 |
.Sp |
| 234 |
A YAML mapping <http://yaml.org/spec/history/2002-10-31.html#syntax-mapping> |
| 235 |
indicating the Perl modules this distribution recommends for enhanced |
| 236 |
operation. |
| 237 |
.IP build_requires 4 |
| 238 |
.IX Item "build_requires" |
| 239 |
Example: |
| 240 |
.Sp |
| 241 |
.Vb 2 |
| 242 |
\& Data::Dumper: 0 |
| 243 |
\& File::Find: 1.03 |
| 244 |
.Ve |
| 245 |
.Sp |
| 246 |
A YAML mapping <http://yaml.org/spec/history/2002-10-31.html#syntax-mapping> |
| 247 |
indicating the Perl modules required for building and/or testing of |
| 248 |
this distribution. These dependencies are not required after the |
| 249 |
module is installed. |
| 250 |
.IP conflicts 4 |
| 251 |
.IX Item "conflicts" |
| 252 |
Example: |
| 253 |
.Sp |
| 254 |
.Vb 2 |
| 255 |
\& Data::Dumper: 0 |
| 256 |
\& File::Find: 1.03 |
| 257 |
.Ve |
| 258 |
.Sp |
| 259 |
A YAML mapping <http://yaml.org/spec/history/2002-10-31.html#syntax-mapping> |
| 260 |
indicating the Perl modules that cannot be installed while this |
| 261 |
distribution is installed. This is a pretty uncommon situation. |
| 262 |
.Sp |
| 263 |
\&\- possibly separate out test-time prereqs, complications include: can |
| 264 |
tests be meaningfully preserved for later running? are test-time |
| 265 |
prereqs in addition to build-time, or exclusive? |
| 266 |
.Sp |
| 267 |
\&\- make official location for installed *distributions*, which can |
| 268 |
contain tests, etc. |
| 269 |
.IP dynamic_config 4 |
| 270 |
.IX Item "dynamic_config" |
| 271 |
Example: \f(CW0\fR |
| 272 |
.Sp |
| 273 |
A boolean flag indicating whether a \fIBuild.PL\fR or |
| 274 |
\&\fIMakefile.PL\fR (or similar) must be executed, or whether this |
| 275 |
module can be built, tested and installed solely from consulting its |
| 276 |
metadata file. The main reason to set this to a true value if that |
| 277 |
your module performs some dynamic configuration (asking questions, |
| 278 |
sensing the environment, etc.) as part of its build/install process. |
| 279 |
.Sp |
| 280 |
Currently Module::Build doesn't actually do anything with |
| 281 |
this flag \- it's probably going to be up to higher-level tools like |
| 282 |
CPAN.pm to do something useful with it. It can potentially |
| 283 |
bring lots of security, packaging, and convenience improvements. |
| 284 |
.IP generated_by 4 |
| 285 |
.IX Item "generated_by" |
| 286 |
Example: \f(CW\*(C`Module::Build version 0.16\*(C'\fR |
| 287 |
.Sp |
| 288 |
Indicates the tool that was used to create this \fIMETA.yml\fR file. It's |
| 289 |
good form to include both the name of the tool and its version, but |
| 290 |
this field is essentially opaque, at least for the moment. |
| 291 |
.SS "Ingy's suggestions" |
| 292 |
.IX Subsection "Ingy's suggestions" |
| 293 |
.IP short_description 4 |
| 294 |
.IX Item "short_description" |
| 295 |
add as field, containing abstract, maximum 80 characters, suggested minimum 40 characters |
| 296 |
.IP description 4 |
| 297 |
.IX Item "description" |
| 298 |
long version of abstract, should add? |
| 299 |
.IP maturity 4 |
| 300 |
.IX Item "maturity" |
| 301 |
alpha, beta, gamma, mature, stable |
| 302 |
.IP "author_id, owner_id" 4 |
| 303 |
.IX Item "author_id, owner_id" |
| 304 |
.PD 0 |
| 305 |
.IP "categorization, keyword, chapter_id" 4 |
| 306 |
.IX Item "categorization, keyword, chapter_id" |
| 307 |
.IP "URL for further information" 4 |
| 308 |
.IX Item "URL for further information" |
| 309 |
.PD |
| 310 |
could default to search.cpan.org on PAUSE |
| 311 |
.IP namespaces 4 |
| 312 |
.IX Item "namespaces" |
| 313 |
can be specified for single elements by prepending |
| 314 |
dotted-form, i.e. "com.example.my_application.my_property". Default |
| 315 |
namespace for META.yml is probably "org.cpan.meta_author" or |
| 316 |
something. Precedent for this is Apple's Carbon namespaces, I think. |
| 317 |
.SH History |
| 318 |
.IX Header "History" |
| 319 |
.IP \(bu 4 |
| 320 |
\&\fBMarch 14, 2003\fR (Pi day) \- created version 1.0 of this document. |
| 321 |
.IP \(bu 4 |
| 322 |
\&\fBMay 8, 2003\fR \- added the "dynamic_config" field, which was missing from the |
| 323 |
initial version. |