Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
mdoc-validate(1)	    General Commands Manual	      mdoc-validate(1)

NAME
       mdoc validate - Validate	XML documents against a	schema

SYNOPSIS
       mdoc validate [OPTIONS]*	PATHS+

DESCRIPTION
       mdoc  validate validates	the specified PATHS against a specified	format
       schema.

OPTIONS
       --format=FORMAT
	      The documentation	format to validate PATHS  against.   Supported
	      formats include: ecma.

	      See  the	FORMATS	section	below for more information about these
	      formats.

	      The default format (if none is specified)	is ecma.

       -h, -?, --help
	      Display a	help message and exit.

FORMATS
       The following documentation formats are supported:

   ecma
       The Mono	ECMA Documentation Format validates all	 output	 generated  by
       mdoc-update(1)	against	  an  XML  schema,  including  the  index.xml,
       ns-*.xml, and NamespaceName/TypeName.xml	files.

       See mdoc(5) for details about this file format.

EXAMPLES
       To validate the mdoc-update(1) output stored within  a  directory  (and
       all documentation within	that directory,	recursively), use:

	   mdoc	validate /path/to/ecma/docs

MAILING	LISTS
       Visit  http://lists.ximian.com/mailman/listinfo/mono-docs-list  for de-
       tails.

WEB SITE
       Visit http://www.mono-project.com/docs/tools+libraries/tools/mdoc/  for
       details

							      mdoc-validate(1)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | FORMATS | EXAMPLES | MAILING LISTS | WEB SITE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=mdoc-validate&sektion=1&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help