1MODULEMD-VALIDATOR(1)            User Commands           MODULEMD-VALIDATOR(1)
2
3
4

NAME

6       modulemd-validator - validate modulemd documents
7

SYNOPSIS

9       modulemd-validator [--quiet|--verbose|--debug] FILE...
10       modulemd-validator [--quiet|--verbose|--debug] --type=TYPE FILE
11       modulemd-validator {--version|--help}
12

DESCRIPTION

14       This  tool  validates  modulemd documents specified with the positional
15       arguments using a libmodulemd parser.
16
17       Without a --type option, all document types which can be found in a YUM
18       repository  will be recognized. In this case each FILE can contain mul‐
19       tiple modulemd documents.
20
21       Otherwise, exactly one FILE containing exactly  one  modulemd  document
22       must  be  provided and the document will be validated against the given
23       TYPE.
24

OPTIONS

26       --type=TYPE
27              Constrain a document type. The recognized types are:
28
29              modulemd-v1
30                     An obsolete format used for building and installing  mod‐
31                     ules.
32
33              modulemd-v2
34                     A  deprecated format for building modules and a contempo‐
35                     rary format for built modules which can  be  placed  into
36                     a YUM repository and installed by a package manager.
37
38              modulemd-defaults-v1
39                     A  format  for  defining default streams and default pro‐
40                     files of a module. Found in YUM repositories.
41
42              modulemd-obsoletes-v1
43                     A format for defining streams which reach or  will  reach
44                     its end of life. It can also recommend a new stream which
45                     obsoleted the old one. Found in YUM repositories.
46
47              modulemd-packager-v2
48                     An obsolete format for building modules.
49
50              modulemd-packager-v3
51                     A contemporary format for building modules.
52
53              modulemd-translations-v1
54                     A contemporary format for delivering localized human-ori‐
55                     ented  texts (e.g. a description or a summary) associated
56                     with a module. Found in YUM repositories.
57
58              Only single-document files are supported.  For compatibility, if
59              this  options is not provided, any document type loadable into a
60              modulemd index (i.e. those intended for YUM repositories) is ac‐
61              ceptable.
62
63       --debug
64              Output debugging messages.
65
66       -q, --quiet
67              Print no output.
68
69       -v, --verbose
70              Be verbose.
71
72       -h, --help
73              Print a usage text and then exit.
74
75       -V, --version
76              Print a version number and then exit.
77

EXIT CODE

79       If the supplied documents are valid (and satisfy the --type constrain),
80       zero exit code will be returned.  Otherwise a  non-zero  code  will  be
81       emitted.
82

REPORTING BUGS

84       Bugs  and feature requests can be reported at the libmodulemd home page
85       ⟨https//github.com/fedora-modularity/libmodulemd⟩.
86

SEE ALSO

88       Specification of the modulemd documents is available in a yaml_spec di‐
89       rectory at the libmodulemd home page.
90
91
92
93
94libmodulemd                                              MODULEMD-VALIDATOR(1)
Impressum