man/mdoc-validate.1

   1 .\"
   2 .\" mdoc validate manual page.
   3 .\" (C) 2008 Novell, Inc.
   4 .\" Author:
   5 .\"   Jonathan Pryor (jpryor@novell.com)
   6 .\"
   7 .de Sp \" Vertical space (when we can't use .PP)
   8 .if t .sp .5v
   9 .if n .sp
  10 ..
  11 .TH "mdoc-validate" 1
  12 .SH NAME
  13 mdoc validate \- Validate XML documents against a schema
  14 .SH SYNOPSIS
  15 .B mdoc validate
  16 [OPTIONS]*
  17 PATHS+
  18 .SH DESCRIPTION
  19 \fBmdoc validate\fR validates the specified \fIPATHS\fR against a specified
  20 format schema.
  21 .SH OPTIONS
  22 .TP
  23 \fB\-\-format\fR=\fIFORMAT\fR
  24 The documentation format to validate \fIPATHS\fR against.  Supported formats
  25 include: \fIecma\fR.
  26 .Sp
  27 See the \fIFORMATS\fR section below for more information about these formats.
  28 .Sp
  29 The default format (if none is specified) is \fIecma\fR.
  30 .TP
  31 \fB\-h\fR, \fB\-?\fR, \fB\-\-help\fR
  32 Display a help message and exit.
  33 .SH FORMATS
  34 The following documentation formats are supported:
  35 .SS ecma
  36 The \fIMono ECMA Documentation Format\fR validates all output generated by
  37 \fBmdoc-update\fR(1) against an XML schema, including the \fIindex.xml\fR,
  38 \fIns-*.xml\fR, and \fINamespaceName/TypeName.xml\fR files.
  39 .PP
  40 See \fBmdoc\fR(5) for details about this file format.
  41 .SH EXAMPLES
  42 To validate the \fBmdoc-update\fR(1) output stored within a directory (and all
  43 documentation within that directory, recursively), use:
  44 .nf
  45
  46     mdoc validate /path/to/ecma/docs
  47
  48 .fi
  49 .PP
  50 .SH MAILING LISTS
  51 .TP
  52 Visit http://lists.ximian.com/mailman/listinfo/mono-docs-list for details.
  53 .SH WEB SITE
  54 Visit http://www.mono-project.com/mdoc for details