Debian Codegraph @

upstream/mageia-cauldron/man3pm/CPAN::Meta::YAML.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::YAML 3pm"
61 .TH CPAN::Meta::YAML 3pm 2025-06-24 "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::YAML \- Read and write a subset of YAML for CPAN Meta files
68 .SH VERSION
69 .IX Header "VERSION"
70 version 0.020
71 .SH SYNOPSIS
72 .IX Header "SYNOPSIS"
73 .Vb 1
74 \& use CPAN::Meta::YAML;
75 \&
76 \& # reading a META file
77 \& open $fh, "<:utf8", "META.yml";
78 \& $yaml_text = do { local $/; <$fh> };
79 \& $yaml = CPAN::Meta::YAML\->read_string($yaml_text)
80 \& or die CPAN::Meta::YAML\->errstr;
81 \&
82 \& # finding the metadata
83 \& $meta = $yaml\->[0];
84 \&
85 \& # writing a META file
86 \& $yaml_text = $yaml\->write_string
87 \& or die CPAN::Meta::YAML\->errstr;
88 \& open $fh, ">:utf8", "META.yml";
89 \& print $fh $yaml_text;
90 .Ve
91 .SH DESCRIPTION
92 .IX Header "DESCRIPTION"
93 This module implements a subset of the YAML specification for use in reading
94 and writing CPAN metadata files like \fIMETA.yml\fR and \fIMYMETA.yml\fR. It should
95 not be used for any other general YAML parsing or generation task.
96 .PP
97 NOTE: \fIMETA.yml\fR (and \fIMYMETA.yml\fR) files should be UTF\-8 encoded. Users are
98 responsible for proper encoding and decoding. In particular, the \f(CW\*(C`read\*(C'\fR and
99 \&\f(CW\*(C`write\*(C'\fR methods do \fBnot\fR support UTF\-8 and should not be used.
100 .SH SUPPORT
101 .IX Header "SUPPORT"
102 This module is currently derived from YAML::Tiny by Adam Kennedy. If
103 there are bugs in how it parses a particular META.yml file, please file
104 a bug report in the YAML::Tiny bugtracker:
105 <https://github.com/Perl\-Toolchain\-Gang/YAML\-Tiny/issues>
106 .SH "SEE ALSO"
107 .IX Header "SEE ALSO"
108 YAML::Tiny, YAML, YAML::XS
109 .SH AUTHORS
110 .IX Header "AUTHORS"
111 .IP \(bu 4
112 Adam Kennedy <[email protected]>
113 .IP \(bu 4
114 David Golden <[email protected]>
115 .SH CONTRIBUTOR
116 .IX Header "CONTRIBUTOR"
117 Karen Etheridge <[email protected]>
118 .SH "COPYRIGHT AND LICENSE"
119 .IX Header "COPYRIGHT AND LICENSE"
120 This software is copyright (c) 2010 by Adam Kennedy.
121 .PP
122 This is free software; you can redistribute it and/or modify it under
123 the same terms as the Perl 5 programming language system itself.