Add man page
authorMiguel de Icaza <miguel@gnome.org>
Thu, 9 Feb 2006 23:28:10 +0000 (23:28 -0000)
committerMiguel de Icaza <miguel@gnome.org>
Thu, 9 Feb 2006 23:28:10 +0000 (23:28 -0000)
svn path=/trunk/mono/; revision=56735

man/mono-xmltool.1 [new file with mode: 0644]

diff --git a/man/mono-xmltool.1 b/man/mono-xmltool.1
new file mode 100644 (file)
index 0000000..137780a
--- /dev/null
@@ -0,0 +1,85 @@
+.\" 
+.\" mono manual page.
+.\" (C) 2003 Ximian, Inc. 
+.\" (C) 2004-2005 Novell, Inc. 
+.\" Author:
+.\"   Miguel de Icaza (miguel@gnu.org)
+.\"
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.TH mono-xmltool "Mono 1.0"
+.SH NAME
+mono-xmltool \- Mono XML validation and transformation tool. 
+.SH SYNOPSIS
+.PP
+.B mono-xmltool --validate [*.rng | *.rnc | *.nvdl | *.xsd] [instances]
+.PP
+.B mono-xmltool --validate-rng relax-ng-grammar-xml [instances]
+.PP
+.B mono-xmltool --validate-rnc relax-ng-compact-grammar-file [instances]
+.PP
+.B mono-xmltool --validate-nvdl nvdl-script-xml [instances]
+.PP
+.B mono-xmltool --validate-xsd xml-schema [instances]
+.PP
+.B mono-xmltool --transform stylesheet instance-xml
+.PP
+.B mono-xmltool --prettyprint [source [result]]
+.PP
+.SH DESCRIPTION
+\fImono-xmltool\fP is a command line front end for various functions
+available in the Mono XML class libraries, currently it offers
+validation with various different kinds of schemas, xslt
+transformations and pretty printing.
+.PP
+.SH XML VALIDATION
+mono-xmltool can validate a given set of XML files (the instances
+parameter) using the given schema file.  Currently supported schema
+files include Relax NG (*.rng), Compact Relax NG (*.rnc),
+Namespace-based Validation Dispatching Language (*.nvdl) and XML
+Schema (*.xsd).
+.PP
+If invoked with the --validate argument, Mono will use the filename
+extension to guess the kind of validation required.  The
+--validate-xxx flags would force a specific kind of validation.
+.PP
+The following lists the flags and the actual class that implements
+this in Mono:
+.TP
+.I --validate-rng 
+.Sp
+Commons.Xml.Relaxng.RelaxNgPattern as the schema, and
+Commons.Xml.Relaxng.RelaxngValidatingReader validator.
+.TP
+.I --validate-rnc
+Commons.Xml.Relaxng.RncParser as the schema, and
+Commons.Xml.Relaxng.RelaxngValidatingReader validator.
+.TP
+.I --validate-nvdl 
+.Sp
+Commons.Xml.Nvdl as the schema and Commons.Xml.NvdlValidatingReader
+validator. 
+.TP
+.I --validate-xsd
+System.Xml.Schema.XmlSchema as the schema and uses
+System.Xml.XmlValidatingReader as the validator.
+.SH TRANSFORMATIONS
+This does an XSLT transformation, the stylesheet must be an XSLT file,
+the instance-xml is the document to be processed.  Output it sent to
+the standard output.
+.SH PRETTY PRINTING
+Produces a prett-print rendering of the 
+.I source
+file.  If it is not
+specified it reads the standard input.   If 
+.I result 
+is not specified, the output is sent to the standard output.
+.SH MAILING LISTS
+Mailing lists are listed at the
+http://www.mono-project.com/Mailing_Lists
+.SH WEB SITE
+http://www.mono-project.com
+.SH SEE ALSO
+.BR mono(1), mcs(1).