Debian Codegraph @

upstream/debian-unstable/man3/CPAN::Meta::History::Meta_1_0.3perl

raw
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_0 3perl"
58 .TH CPAN::Meta::History::Meta_1_0 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_0 \- Version 1.0 metadata specification for META.yml
65 .SH PREFACE
66 .IX Header "PREFACE"
67 This is a historical copy of the version 1.0 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.17 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.0 of the \fIMETA.yml\fR specification.
83 .PP
84 The META.yml 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 .IP license 4
122 .IX Item "license"
123 Example: \f(CW\*(C`perl\*(C'\fR
124 .Sp
125 The license under which this distribution may be used and
126 redistributed.
127 .Sp
128 Must be one of the following licenses:
129 .RS 4
130 .IP perl 4
131 .IX Item "perl"
132 The distribution may be copied and redistributed under the same terms as perl
133 itself (this is by far the most common licensing option for modules on CPAN).
134 This is a dual license, in which the user may choose between either the GPL
135 version 1 or the Artistic version 1 license.
136 .IP gpl 4
137 .IX Item "gpl"
138 The distribution is distributed under the terms of the GNU General Public
139 License version 2 (<http://opensource.org/licenses/GPL\-2.0>).
140 .IP lgpl 4
141 .IX Item "lgpl"
142 The distribution is distributed under the terms of the GNU Lesser General
143 Public License version 2 (<http://opensource.org/licenses/LGPL\-2.1>).
144 .IP artistic 4
145 .IX Item "artistic"
146 The distribution is licensed under the Artistic License version 1, as specified
147 by the Artistic file in the standard perl distribution
148 (<http://opensource.org/licenses/Artistic\-Perl\-1.0>).
149 .IP bsd 4
150 .IX Item "bsd"
151 The distribution is licensed under the BSD 3\-Clause License
152 (<http://opensource.org/licenses/BSD\-3\-Clause>).
153 .IP open_source 4
154 .IX Item "open_source"
155 The distribution is licensed under some other Open Source Initiative-approved
156 license listed at <http://www.opensource.org/licenses/>.
157 .IP unrestricted 4
158 .IX Item "unrestricted"
159 The distribution is licensed under a license that is \fBnot\fR approved by
160 www.opensource.org <http://www.opensource.org/> but that allows distribution
161 without restrictions.
162 .IP restrictive 4
163 .IX Item "restrictive"
164 The distribution may not be redistributed without special permission from the
165 author and/or copyright holder.
166 .RE
167 .RS 4
168 .RE
169 .IP distribution_type 4
170 .IX Item "distribution_type"
171 Example: \f(CW\*(C`module\*(C'\fR
172 .Sp
173 What kind of stuff is contained in this distribution. Most things on
174 CPAN are \f(CW\*(C`module\*(C'\fRs (which can also mean a collection of
175 modules), but some things are \f(CW\*(C`script\*(C'\fRs.
176 .IP requires 4
177 .IX Item "requires"
178 Example:
179 .Sp
180 .Vb 2
181 \& Data::Dumper: 0
182 \& File::Find: 1.03
183 .Ve
184 .Sp
185 A YAML mapping <http://yaml.org/spec/history/2002-10-31.html#syntax-mapping>
186 indicating the Perl modules this distribution requires for proper
187 operation. The keys are the module names, and the values are version
188 specifications as described in the
189 documentation for Module::Build's "requires" parameter.
190 .Sp
191 \&\fINote: the exact nature of the fancy specifications like
192 \&\fR\f(CI">= 1.2, != 1.5, < 2.0"\fR\fI is subject to
193 change. Advance notice will be given here. The simple specifications
194 like \fR\f(CI"1.2"\fR\fI will not change in format.\fR
195 .IP recommends 4
196 .IX Item "recommends"
197 Example:
198 .Sp
199 .Vb 2
200 \& Data::Dumper: 0
201 \& File::Find: 1.03
202 .Ve
203 .Sp
204 A YAML mapping <http://yaml.org/spec/history/2002-10-31.html#syntax-mapping>
205 indicating the Perl modules this distribution recommends for enhanced
206 operation.
207 .IP build_requires 4
208 .IX Item "build_requires"
209 Example:
210 .Sp
211 .Vb 2
212 \& Data::Dumper: 0
213 \& File::Find: 1.03
214 .Ve
215 .Sp
216 A YAML mapping <http://yaml.org/spec/history/2002-10-31.html#syntax-mapping>
217 indicating the Perl modules required for building and/or testing of
218 this distribution. These dependencies are not required after the
219 module is installed.
220 .IP conflicts 4
221 .IX Item "conflicts"
222 Example:
223 .Sp
224 .Vb 2
225 \& Data::Dumper: 0
226 \& File::Find: 1.03
227 .Ve
228 .Sp
229 A YAML mapping <http://yaml.org/spec/history/2002-10-31.html#syntax-mapping>
230 indicating the Perl modules that cannot be installed while this
231 distribution is installed. This is a pretty uncommon situation.
232 .IP dynamic_config 4
233 .IX Item "dynamic_config"
234 Example: \f(CW0\fR
235 .Sp
236 A boolean flag indicating whether a \fIBuild.PL\fR or
237 \&\fIMakefile.PL\fR (or similar) must be executed, or whether this
238 module can be built, tested and installed solely from consulting its
239 metadata file. The main reason to set this to a true value if that
240 your module performs some dynamic configuration (asking questions,
241 sensing the environment, etc.) as part of its build/install process.
242 .Sp
243 Currently Module::Build doesn't actually do anything with
244 this flag \- it's probably going to be up to higher-level tools like
245 CPAN.pm to do something useful with it. It can potentially
246 bring lots of security, packaging, and convenience improvements.
247 .IP generated_by 4
248 .IX Item "generated_by"
249 Example: \f(CW\*(C`Module::Build version 0.16\*(C'\fR
250 .Sp
251 Indicates the tool that was used to create this \fIMETA.yml\fR file. It's
252 good form to include both the name of the tool and its version, but
253 this field is essentially opaque, at least for the moment.
254 .SH "Related Projects"
255 .IX Header "Related Projects"
256 .IP DOAP 4
257 .IX Item "DOAP"
258 An RDF vocabulary to describe software projects. <http://usefulinc.com/doap>.
259 .SH History
260 .IX Header "History"
261 .IP \(bu 4
262 \&\fBMarch 14, 2003\fR (Pi day) \- created version 1.0 of this document.
263 .IP \(bu 4
264 \&\fBMay 8, 2003\fR \- added the "dynamic_config" field, which was missing from the
265 initial version.