Debian Codegraph @

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