1mdoc-validate(1)            General Commands Manual           mdoc-validate(1)
2
3
4

NAME

6       mdoc validate - Validate XML documents against a schema
7

SYNOPSIS

9       mdoc validate [OPTIONS]* PATHS+
10

DESCRIPTION

12       mdoc  validate validates the specified PATHS against a specified format
13       schema.
14

OPTIONS

16       --format=FORMAT
17              The documentation format to validate PATHS  against.   Supported
18              formats include: ecma.
19
20              See  the  FORMATS section below for more information about these
21              formats.
22
23              The default format (if none is specified) is ecma.
24
25       -h, -?, --help
26              Display a help message and exit.
27

FORMATS

29       The following documentation formats are supported:
30
31   ecma
32       The Mono ECMA Documentation Format validates all  output  generated  by
33       mdoc-update(1)   against   an  XML  schema,  including  the  index.xml,
34       ns-*.xml, and NamespaceName/TypeName.xml files.
35
36       See mdoc(5) for details about this file format.
37

EXAMPLES

39       To validate the mdoc-update(1) output stored within  a  directory  (and
40       all documentation within that directory, recursively), use:
41
42           mdoc validate /path/to/ecma/docs
43
44

MAILING LISTS

46       Visit    http://lists.ximian.com/mailman/listinfo/mono-docs-list    for
47       details.
48

WEB SITE

50       Visit http://www.mono-project.com/mdoc for details
51
52
53
54                                                              mdoc-validate(1)