Debian Codegraph @

upstream/debian-unstable/man3/CPAN::Kwalify.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::Kwalify 3perl"
58 .TH CPAN::Kwalify 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::Kwalify \- Interface between CPAN.pm and Kwalify.pm
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 2
68 \& use CPAN::Kwalify;
69 \& validate($schema_name, $data, $file, $doc);
70 .Ve
71 .SH DESCRIPTION
72 .IX Header "DESCRIPTION"
73 .ie n .IP "_validate($schema_name, $data, $file, $doc)" 4
74 .el .IP "_validate($schema_name, \f(CW$data\fR, \f(CW$file\fR, \f(CW$doc\fR)" 4
75 .IX Item "_validate($schema_name, $data, $file, $doc)"
76 \&\f(CW$schema_name\fR is the name of a supported schema. Currently only
77 \&\f(CW\*(C`distroprefs\*(C'\fR is supported. \f(CW$data\fR is the data to be validated. \f(CW$file\fR
78 is the absolute path to the file the data are coming from. \f(CW$doc\fR is the
79 index of the document within \f(CW$doc\fR that is to be validated. The last
80 two arguments are only there for better error reporting.
81 .Sp
82 Relies on being called from within CPAN.pm.
83 .Sp
84 Dies if something fails. Does not return anything useful.
85 .IP yaml($schema_name) 4
86 .IX Item "yaml($schema_name)"
87 Returns the YAML text of that schema. Dies if something fails.
88 .SH AUTHOR
89 .IX Header "AUTHOR"
90 Andreas Koenig \f(CW\*(C`<[email protected]>\*(C'\fR
91 .SH LICENSE
92 .IX Header "LICENSE"
93 This program is free software; you can redistribute it and/or
94 modify it under the same terms as Perl itself.
95 .PP
96 See <http://www.perl.com/perl/misc/Artistic.html>