diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 19:43:11 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 19:43:11 +0000 |
commit | fc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch) | |
tree | ce1e3bce06471410239a6f41282e328770aa404a /upstream/archlinux/man3/CPAN::Meta::History::Meta_1_0.3perl | |
parent | Initial commit. (diff) | |
download | manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip |
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/archlinux/man3/CPAN::Meta::History::Meta_1_0.3perl')
-rw-r--r-- | upstream/archlinux/man3/CPAN::Meta::History::Meta_1_0.3perl | 265 |
1 files changed, 265 insertions, 0 deletions
diff --git a/upstream/archlinux/man3/CPAN::Meta::History::Meta_1_0.3perl b/upstream/archlinux/man3/CPAN::Meta::History::Meta_1_0.3perl new file mode 100644 index 00000000..d58ea1ce --- /dev/null +++ b/upstream/archlinux/man3/CPAN::Meta::History::Meta_1_0.3perl @@ -0,0 +1,265 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. +.ie n \{\ +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds C` +. ds C' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is >0, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.\" +.\" Avoid warning from groff about undefined register 'F'. +.de IX +.. +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} +. \} +.\} +.rr rF +.\" ======================================================================== +.\" +.IX Title "CPAN::Meta::History::Meta_1_0 3perl" +.TH CPAN::Meta::History::Meta_1_0 3perl 2024-02-11 "perl v5.38.2" "Perl Programmers Reference Guide" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH NAME +CPAN::Meta::History::Meta_1_0 \- Version 1.0 metadata specification for META.yml +.SH PREFACE +.IX Header "PREFACE" +This is a historical copy of the version 1.0 specification for \fIMETA.yml\fR +files, copyright by Ken Williams and licensed under the same terms as Perl +itself. +.PP +Modifications from the original: +.IP \(bu 4 +Conversion from the original HTML to POD format +.IP \(bu 4 +Include list of valid licenses from Module::Build 0.17 rather than +linking to the module, with minor updates to text and links to reflect +versions at the time of publication. +.IP \(bu 4 +Fixed some dead links to point to active resources. +.SH DESCRIPTION +.IX Header "DESCRIPTION" +This document describes version 1.0 of the \fIMETA.yml\fR specification. +.PP +The META.yml file describes important properties of contributed Perl +distributions such as the ones found on CPAN <http://www.cpan.org>. It is +typically created by tools like Module::Build and ExtUtils::MakeMaker. +.PP +The fields in the \fIMETA.yml\fR file are meant to be helpful to people +maintaining module collections (like CPAN), for people writing +installation tools (like CPAN or CPANPLUS), or just people who want to +know some stuff about a distribution before downloading it and starting to +install it. +.SH Format +.IX Header "Format" +\&\fIMETA.yml\fR files are written in the YAML <http://www.yaml.org/> format. The +reasons we chose YAML instead of, say, XML or Data::Dumper are discussed in +this thread <http://www.nntp.perl.org/group/perl.makemaker/2002/04/msg406.html> +on the MakeMaker mailing list. +.PP +The first line of a \fIMETA.yml\fR file should be a valid +YAML document header <http://yaml.org/spec/history/2002-10-31.html#syntax-document> +like \f(CW"\-\-\- #YAML:1.0"\fR +.SH Fields +.IX Header "Fields" +The rest of the META.yml file is one big YAML +mapping <http://yaml.org/spec/history/2002-10-31.html#syntax-mapping>, +whose keys are described here. +.IP name 4 +.IX Item "name" +Example: \f(CW\*(C`Module\-Build\*(C'\fR +.Sp +The name of the distribution. Often created by taking the "main +module" in the distribution and changing "::" to "\-". Sometimes it's +completely different, however, as in the case of the +libwww-perl <http://search.cpan.org/author/GAAS/libwww-perl/> distribution. +.IP version 4 +.IX Item "version" +Example: \f(CW0.16\fR +.Sp +The version of the distribution to which the META.yml file refers. +.IP license 4 +.IX Item "license" +Example: \f(CW\*(C`perl\*(C'\fR +.Sp +The license under which this distribution may be used and +redistributed. +.Sp +Must be one of the following licenses: +.RS 4 +.IP perl 4 +.IX Item "perl" +The distribution may be copied and redistributed under the same terms as perl +itself (this is by far the most common licensing option for modules on CPAN). +This is a dual license, in which the user may choose between either the GPL +version 1 or the Artistic version 1 license. +.IP gpl 4 +.IX Item "gpl" +The distribution is distributed under the terms of the GNU General Public +License version 2 (<http://opensource.org/licenses/GPL\-2.0>). +.IP lgpl 4 +.IX Item "lgpl" +The distribution is distributed under the terms of the GNU Lesser General +Public License version 2 (<http://opensource.org/licenses/LGPL\-2.1>). +.IP artistic 4 +.IX Item "artistic" +The distribution is licensed under the Artistic License version 1, as specified +by the Artistic file in the standard perl distribution +(<http://opensource.org/licenses/Artistic\-Perl\-1.0>). +.IP bsd 4 +.IX Item "bsd" +The distribution is licensed under the BSD 3\-Clause License +(<http://opensource.org/licenses/BSD\-3\-Clause>). +.IP open_source 4 +.IX Item "open_source" +The distribution is licensed under some other Open Source Initiative-approved +license listed at <http://www.opensource.org/licenses/>. +.IP unrestricted 4 +.IX Item "unrestricted" +The distribution is licensed under a license that is \fBnot\fR approved by +www.opensource.org <http://www.opensource.org/> but that allows distribution +without restrictions. +.IP restrictive 4 +.IX Item "restrictive" +The distribution may not be redistributed without special permission from the +author and/or copyright holder. +.RE +.RS 4 +.RE +.IP distribution_type 4 +.IX Item "distribution_type" +Example: \f(CW\*(C`module\*(C'\fR +.Sp +What kind of stuff is contained in this distribution. Most things on +CPAN are \f(CW\*(C`module\*(C'\fRs (which can also mean a collection of +modules), but some things are \f(CW\*(C`script\*(C'\fRs. +.IP requires 4 +.IX Item "requires" +Example: +.Sp +.Vb 2 +\& Data::Dumper: 0 +\& File::Find: 1.03 +.Ve +.Sp +A YAML mapping <http://yaml.org/spec/history/2002-10-31.html#syntax-mapping> +indicating the Perl modules this distribution requires for proper +operation. The keys are the module names, and the values are version +specifications as described in the +documentation for Module::Build's "requires" parameter. +.Sp +\&\fINote: the exact nature of the fancy specifications like +\&\fR\f(CI">= 1.2, != 1.5, < 2.0"\fR\fI is subject to +change. Advance notice will be given here. The simple specifications +like \fR\f(CI"1.2"\fR\fI will not change in format.\fR +.IP recommends 4 +.IX Item "recommends" +Example: +.Sp +.Vb 2 +\& Data::Dumper: 0 +\& File::Find: 1.03 +.Ve +.Sp +A YAML mapping <http://yaml.org/spec/history/2002-10-31.html#syntax-mapping> +indicating the Perl modules this distribution recommends for enhanced +operation. +.IP build_requires 4 +.IX Item "build_requires" +Example: +.Sp +.Vb 2 +\& Data::Dumper: 0 +\& File::Find: 1.03 +.Ve +.Sp +A YAML mapping <http://yaml.org/spec/history/2002-10-31.html#syntax-mapping> +indicating the Perl modules required for building and/or testing of +this distribution. These dependencies are not required after the +module is installed. +.IP conflicts 4 +.IX Item "conflicts" +Example: +.Sp +.Vb 2 +\& Data::Dumper: 0 +\& File::Find: 1.03 +.Ve +.Sp +A YAML mapping <http://yaml.org/spec/history/2002-10-31.html#syntax-mapping> +indicating the Perl modules that cannot be installed while this +distribution is installed. This is a pretty uncommon situation. +.IP dynamic_config 4 +.IX Item "dynamic_config" +Example: \f(CW0\fR +.Sp +A boolean flag indicating whether a \fIBuild.PL\fR or +\&\fIMakefile.PL\fR (or similar) must be executed, or whether this +module can be built, tested and installed solely from consulting its +metadata file. The main reason to set this to a true value if that +your module performs some dynamic configuration (asking questions, +sensing the environment, etc.) as part of its build/install process. +.Sp +Currently Module::Build doesn't actually do anything with +this flag \- it's probably going to be up to higher-level tools like +CPAN.pm to do something useful with it. It can potentially +bring lots of security, packaging, and convenience improvements. +.IP generated_by 4 +.IX Item "generated_by" +Example: \f(CW\*(C`Module::Build version 0.16\*(C'\fR +.Sp +Indicates the tool that was used to create this \fIMETA.yml\fR file. It's +good form to include both the name of the tool and its version, but +this field is essentially opaque, at least for the moment. +.SH "Related Projects" +.IX Header "Related Projects" +.IP DOAP 4 +.IX Item "DOAP" +An RDF vocabulary to describe software projects. <http://usefulinc.com/doap>. +.SH History +.IX Header "History" +.IP \(bu 4 +\&\fBMarch 14, 2003\fR (Pi day) \- created version 1.0 of this document. +.IP \(bu 4 +\&\fBMay 8, 2003\fR \- added the "dynamic_config" field, which was missing from the +initial version. |