Permalink
Browse files

Migrating from monodoc/man to mono/man...

svn path=/trunk/mono/; revision=116281
  • Loading branch information...
1 parent e6fdbcf commit 14c633f63b0a7210ac73d352a09a9581506083b3 Jonathan Pryor committed Oct 17, 2008
Showing with 54 additions and 0 deletions.
  1. +54 −0 man/mdoc-validate.1
View
@@ -0,0 +1,54 @@
+.\"
+.\" mdoc validate manual page.
+.\" (C) 2008 Novell, Inc.
+.\" Author:
+.\" Jonathan Pryor (jpryor@novell.com)
+.\"
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.TH "mdoc-validate" 1
+.SH NAME
+mdoc validate \- Validate XML documents against a schema
+.SH SYNOPSIS
+.B mdoc validate
+[OPTIONS]*
+PATHS+
+.SH DESCRIPTION
+\fBmdoc validate\fR validates the specified \fIPATHS\fR against a specified
+format schema.
+.SH OPTIONS
+.TP
+\fB\-\-format\fR=\fIFORMAT\fR
+The documentation format to validate \fIPATHS\fR against. Supported formats
+include: \fIecma\fR.
+.Sp
+See the \fIFORMATS\fR section below for more information about these formats.
+.Sp
+The default format (if none is specified) is \fIecma\fR.
+.TP
+\fB\-h\fR, \fB\-?\fR, \fB\-\-help\fR
+Display a help message and exit.
+.SH FORMATS
+The following documentation formats are supported:
+.SS ecma
+The \fIMono ECMA Documentation Format\fR validates all output generated by
+\fBmdoc-update\fR(1) against an XML schema, including the \fIindex.xml\fR,
+\fIns-*.xml\fR, and \fINamespaceName/TypeName.xml\fR files.
+.PP
+See \fBmdoc\fR(5) for details about this file format.
+.SH EXAMPLES
+To validate the \fBmdoc-update\fR(1) output stored within a directory (and all
+documentation within that directory, recursively), use:
+.nf
+
+ mdoc validate /path/to/ecma/docs
+
+.fi
+.PP
+.SH MAILING LISTS
+.TP
+Visit http://lists.ximian.com/mailman/listinfo/mono-docs-list for details.
+.SH WEB SITE
+Visit http://www.mono-project.com/mdoc for details

0 comments on commit 14c633f

Please sign in to comment.