Debian Codegraph @

upstream/mageia-cauldron/man3pm/CPAN::Meta::History::Meta_1_0.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "CPAN::Meta::History::Meta_1_0 3pm"
61 .TH CPAN::Meta::History::Meta_1_0 3pm 2023-12-22 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 CPAN::Meta::History::Meta_1_0 \- Version 1.0 metadata specification for META.yml
68 .SH PREFACE
69 .IX Header "PREFACE"
70 This is a historical copy of the version 1.0 specification for \fIMETA.yml\fR
71 files, copyright by Ken Williams and licensed under the same terms as Perl
72 itself.
73 .PP
74 Modifications from the original:
75 .IP \(bu 4
76 Conversion from the original HTML to POD format
77 .IP \(bu 4
78 Include list of valid licenses from Module::Build 0.17 rather than
79 linking to the module, with minor updates to text and links to reflect
80 versions at the time of publication.
81 .IP \(bu 4
82 Fixed some dead links to point to active resources.
83 .SH DESCRIPTION
84 .IX Header "DESCRIPTION"
85 This document describes version 1.0 of the \fIMETA.yml\fR specification.
86 .PP
87 The META.yml file describes important properties of contributed Perl
88 distributions such as the ones found on CPAN <http://www.cpan.org>. It is
89 typically created by tools like Module::Build and ExtUtils::MakeMaker.
90 .PP
91 The fields in the \fIMETA.yml\fR file are meant to be helpful to people
92 maintaining module collections (like CPAN), for people writing
93 installation tools (like CPAN or CPANPLUS), or just people who want to
94 know some stuff about a distribution before downloading it and starting to
95 install it.
96 .SH Format
97 .IX Header "Format"
98 \&\fIMETA.yml\fR files are written in the YAML <http://www.yaml.org/> format. The
99 reasons we chose YAML instead of, say, XML or Data::Dumper are discussed in
100 this thread <http://www.nntp.perl.org/group/perl.makemaker/2002/04/msg406.html>
101 on the MakeMaker mailing list.
102 .PP
103 The first line of a \fIMETA.yml\fR file should be a valid
104 YAML document header <http://yaml.org/spec/history/2002-10-31.html#syntax-document>
105 like \f(CW"\-\-\- #YAML:1.0"\fR
106 .SH Fields
107 .IX Header "Fields"
108 The rest of the META.yml file is one big YAML
109 mapping <http://yaml.org/spec/history/2002-10-31.html#syntax-mapping>,
110 whose keys are described here.
111 .IP name 4
112 .IX Item "name"
113 Example: \f(CW\*(C`Module\-Build\*(C'\fR
114 .Sp
115 The name of the distribution. Often created by taking the "main
116 module" in the distribution and changing "::" to "\-". Sometimes it\*(Aqs
117 completely different, however, as in the case of the
118 libwww\-perl <http://search.cpan.org/author/GAAS/libwww-perl/> distribution.
119 .IP version 4
120 .IX Item "version"
121 Example: \f(CW0.16\fR
122 .Sp
123 The version of the distribution to which the META.yml file refers.
124 .IP license 4
125 .IX Item "license"
126 Example: \f(CW\*(C`perl\*(C'\fR
127 .Sp
128 The license under which this distribution may be used and
129 redistributed.
130 .Sp
131 Must be one of the following licenses:
132 .RS 4
133 .IP perl 4
134 .IX Item "perl"
135 The distribution may be copied and redistributed under the same terms as perl
136 itself (this is by far the most common licensing option for modules on CPAN).
137 This is a dual license, in which the user may choose between either the GPL
138 version 1 or the Artistic version 1 license.
139 .IP gpl 4
140 .IX Item "gpl"
141 The distribution is distributed under the terms of the GNU General Public
142 License version 2 (<http://opensource.org/licenses/GPL\-2.0>).
143 .IP lgpl 4
144 .IX Item "lgpl"
145 The distribution is distributed under the terms of the GNU Lesser General
146 Public License version 2 (<http://opensource.org/licenses/LGPL\-2.1>).
147 .IP artistic 4
148 .IX Item "artistic"
149 The distribution is licensed under the Artistic License version 1, as specified
150 by the Artistic file in the standard perl distribution
151 (<http://opensource.org/licenses/Artistic\-Perl\-1.0>).
152 .IP bsd 4
153 .IX Item "bsd"
154 The distribution is licensed under the BSD 3\-Clause License
155 (<http://opensource.org/licenses/BSD\-3\-Clause>).
156 .IP open_source 4
157 .IX Item "open_source"
158 The distribution is licensed under some other Open Source Initiative\-approved
159 license listed at <http://www.opensource.org/licenses/>.
160 .IP unrestricted 4
161 .IX Item "unrestricted"
162 The distribution is licensed under a license that is \fBnot\fR approved by
163 www.opensource.org <http://www.opensource.org/> but that allows distribution
164 without restrictions.
165 .IP restrictive 4
166 .IX Item "restrictive"
167 The distribution may not be redistributed without special permission from the
168 author and/or copyright holder.
169 .RE
170 .RS 4
171 .RE
172 .IP distribution_type 4
173 .IX Item "distribution_type"
174 Example: \f(CW\*(C`module\*(C'\fR
175 .Sp
176 What kind of stuff is contained in this distribution. Most things on
177 CPAN are \f(CW\*(C`module\*(C'\fRs (which can also mean a collection of
178 modules), but some things are \f(CW\*(C`script\*(C'\fRs.
179 .IP requires 4
180 .IX Item "requires"
181 Example:
182 .Sp
183 .Vb 2
184 \& Data::Dumper: 0
185 \& File::Find: 1.03
186 .Ve
187 .Sp
188 A YAML mapping <http://yaml.org/spec/history/2002-10-31.html#syntax-mapping>
189 indicating the Perl modules this distribution requires for proper
190 operation. The keys are the module names, and the values are version
191 specifications as described in the
192 documentation for Module::Build\*(Aqs "requires" parameter.
193 .Sp
194 \&\fINote: the exact nature of the fancy specifications like
195 \&\fR\f(CI">= 1.2, != 1.5, < 2.0"\fR\fI is subject to
196 change. Advance notice will be given here. The simple specifications
197 like \fR\f(CI"1.2"\fR\fI will not change in format.\fR
198 .IP recommends 4
199 .IX Item "recommends"
200 Example:
201 .Sp
202 .Vb 2
203 \& Data::Dumper: 0
204 \& File::Find: 1.03
205 .Ve
206 .Sp
207 A YAML mapping <http://yaml.org/spec/history/2002-10-31.html#syntax-mapping>
208 indicating the Perl modules this distribution recommends for enhanced
209 operation.
210 .IP build_requires 4
211 .IX Item "build_requires"
212 Example:
213 .Sp
214 .Vb 2
215 \& Data::Dumper: 0
216 \& File::Find: 1.03
217 .Ve
218 .Sp
219 A YAML mapping <http://yaml.org/spec/history/2002-10-31.html#syntax-mapping>
220 indicating the Perl modules required for building and/or testing of
221 this distribution. These dependencies are not required after the
222 module is installed.
223 .IP conflicts 4
224 .IX Item "conflicts"
225 Example:
226 .Sp
227 .Vb 2
228 \& Data::Dumper: 0
229 \& File::Find: 1.03
230 .Ve
231 .Sp
232 A YAML mapping <http://yaml.org/spec/history/2002-10-31.html#syntax-mapping>
233 indicating the Perl modules that cannot be installed while this
234 distribution is installed. This is a pretty uncommon situation.
235 .IP dynamic_config 4
236 .IX Item "dynamic_config"
237 Example: \f(CW0\fR
238 .Sp
239 A boolean flag indicating whether a \fIBuild.PL\fR or
240 \&\fIMakefile.PL\fR (or similar) must be executed, or whether this
241 module can be built, tested and installed solely from consulting its
242 metadata file. The main reason to set this to a true value if that
243 your module performs some dynamic configuration (asking questions,
244 sensing the environment, etc.) as part of its build/install process.
245 .Sp
246 Currently Module::Build doesn\*(Aqt actually do anything with
247 this flag \- it\*(Aqs probably going to be up to higher\-level tools like
248 CPAN.pm to do something useful with it. It can potentially
249 bring lots of security, packaging, and convenience improvements.
250 .IP generated_by 4
251 .IX Item "generated_by"
252 Example: \f(CW\*(C`Module::Build version 0.16\*(C'\fR
253 .Sp
254 Indicates the tool that was used to create this \fIMETA.yml\fR file. It\*(Aqs
255 good form to include both the name of the tool and its version, but
256 this field is essentially opaque, at least for the moment.
257 .SH "Related Projects"
258 .IX Header "Related Projects"
259 .IP DOAP 4
260 .IX Item "DOAP"
261 An RDF vocabulary to describe software projects. <http://usefulinc.com/doap>.
262 .SH History
263 .IX Header "History"
264 .IP \(bu 4
265 \&\fBMarch 14, 2003\fR (Pi day) \- created version 1.0 of this document.
266 .IP \(bu 4
267 \&\fBMay 8, 2003\fR \- added the "dynamic_config" field, which was missing from the
268 initial version.