.\" Automatically generated by Pod::Man 4.14 (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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 "PKWALIFY 1p" .TH PKWALIFY 1p "2022-11-11" "perl v5.36.0" "User Contributed Perl Documentation" .\" 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" pkwalify \- Kwalify schema for data structures .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& pkwalify [\-v] [\-s] [\-m parse\-mod] \-f schemafile datafile .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBpkwalify\fR validates the data from \fIdatafile\fR (which may be a \&\s-1YAML\s0 or \s-1JSON\s0 file) against a schema defined with \fIschemafile\fR (which also may be a \s-1YAML\s0 or \s-1JSON\s0 file). .PP It is required that either \s-1YAML\s0, \s-1YAML::XS\s0 or YAML::Syck is installed to parse \s-1YAML\s0 files, or either \s-1JSON\s0 or \s-1JSON::XS\s0 for \&\s-1JSON\s0 files. Or the module specified on the command-line. .PP The program returns the number of errors found in the datafile. An exit status 0 means no errors. .SS "\s-1OPTIONS\s0" .IX Subsection "OPTIONS" .IP "\-f \fIschemafile\fR" 4 .IX Item "-f schemafile" Specify a schema file, either as \s-1YAML\s0 or \s-1JSON.\s0 Required. .IP "\-m \fIparse-mod\fR" 4 .IX Item "-m parse-mod" Specify the \s-1YAML\s0 or \s-1JSON\s0 Perl module to use. Valid modules are: \&\s-1YAML\s0, \s-1YAML::XS\s0, YAML::Syck, \s-1JSON\s0 and \s-1JSON::XS\s0. .IP "\-s" 4 .IX Item "-s" Be silent if the document is valid. .IP "\-v" 4 .IX Item "-v" Show script and module versions and exit. .IP "\-h \-\-help" 4 .IX Item "-h --help" Show summary of options. .SH "AUTHOR" .IX Header "AUTHOR" Slaven Rezić, .SH "SEE ALSO" .IX Header "SEE ALSO" Kwalify, \fBkwalify\fR\|(1), \s-1JSON\s0, \s-1JSON::XS\s0, \s-1YAML\s0, \s-1YAML::XS\s0, YAML::Syck.