Add documentation for exception traces.
[mono-project.git] / man / mono-xmltool.1
blob9c9d96c56d5e790eb6c1175e4064890b7325a404
1 .\" 
2 .\" mono manual page.
3 .\" (C) 2003 Ximian, Inc. 
4 .\" (C) 2004-2005 Novell, Inc. 
5 .\" Author:
6 .\"   Miguel de Icaza (miguel@gnu.org)
7 .\"
8 .de Sp \" Vertical space (when we can't use .PP)
9 .if t .sp .5v
10 .if n .sp
12 .TH mono-xmltool "Mono 1.0"
13 .SH NAME
14 mono-xmltool \- Mono XML validation and transformation tool. 
15 .SH SYNOPSIS
16 .PP
17 .B mono-xmltool --validate [*.rng | *.rnc | *.nvdl | *.xsd] [instances]
18 .PP
19 .B mono-xmltool --validate-rng relax-ng-grammar-xml [instances]
20 .PP
21 .B mono-xmltool --validate-rnc relax-ng-compact-grammar-file [instances]
22 .PP
23 .B mono-xmltool --validate-nvdl nvdl-script-xml [instances]
24 .PP
25 .B mono-xmltool --validate-xsd xml-schema [instances]
26 .PP
27 .B mono-xmltool --transform stylesheet instance-xml
28 .PP
29 .B mono-xmltool --prettyprint [source [result]]
30 .PP
31 .SH DESCRIPTION
32 \fImono-xmltool\fP is a command line front end for various functions
33 available in the Mono XML class libraries. It currently it offers
34 validation with various different kinds of schemas, xslt
35 transformations and pretty printing.
36 .PP
37 .SH XML VALIDATION
38 mono-xmltool can validate a given set of XML files (the instances
39 parameter) using the given schema file.  Currently supported schema
40 files include Relax NG (*.rng), Compact Relax NG (*.rnc),
41 Namespace-based Validation Dispatching Language (*.nvdl) and XML
42 Schema (*.xsd).
43 .PP
44 If invoked with the --validate argument, Mono will use the filename
45 extension to guess the kind of validation required.  The
46 --validate-xxx flags would force a specific kind of validation.
47 .PP
48 The following lists the flags and the actual class that implements
49 them in Mono:
50 .TP
51 .I --validate-rng 
52 .Sp
53 Commons.Xml.Relaxng.RelaxNgPattern as the schema, and
54 Commons.Xml.Relaxng.RelaxngValidatingReader validator.
55 .TP
56 .I --validate-rnc
57 Commons.Xml.Relaxng.RncParser as the schema, and
58 Commons.Xml.Relaxng.RelaxngValidatingReader validator.
59 .TP
60 .I --validate-nvdl 
61 .Sp
62 Commons.Xml.Nvdl as the schema and Commons.Xml.NvdlValidatingReader
63 validator. 
64 .TP
65 .I --validate-xsd
66 System.Xml.Schema.XmlSchema as the schema and uses
67 System.Xml.XmlValidatingReader as the validator.
68 .SH TRANSFORMATIONS
69 This does an XSLT transformation. The stylesheet must be an XSLT file,
70 the instance-xml is the document to be processed.  Output it sent to
71 the standard output.
72 .SH PRETTY PRINTING
73 Produces a pretty-print rendering of the 
74 .I source
75 file.  If it is not
76 specified it reads the standard input.   If 
77 .I result 
78 is not specified, the output is sent to the standard output.
79 .SH MAILING LISTS
80 Mailing lists are listed at the
81 http://www.mono-project.com/Mailing_Lists
82 .SH WEB SITE
83 http://www.mono-project.com
84 .SH SEE ALSO
85 .BR mono(1), mcs(1).