DESCRIPTION

diff -r 243519c5055f -r 6b9cbc8ad81c xml/xmlexpatparser/src/expat-1.95.5/doc_pub/xmlwf.sgml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/xml/xmlexpatparser/src/expat-1.95.5/doc_pub/xmlwf.sgml Tue May 25 14:41:02 2010 +0300 @@ -0,0 +1,440 @@ + manpage.1'. You may view + the manual page with: `docbook-to-man manpage.sgml | nroff -man | + less'. A typical entry in a Makefile or Makefile.am is: + +manpage.1: manpage.sgml + docbook-to-man $< > $@ + --> + + + Scott"> + Bronson"> + + December 5, 2001"> + + 1"> + bronson@rinspin.com"> + + XMLWF"> + + + Debian GNU/Linux"> + GNU"> +]> + + + +

+ &dhemail; +

+ + &dhfirstname; + &dhsurname; + + + 2001 + &dhusername; + + &dhdate; + + + &dhucpackage; + + &dhsection; + + + &dhpackage; + + Determines if an XML document is well-formed + + + + &dhpackage; + + + + + + + + + + + + + + + + + + file ... + + + + + DESCRIPTION + + + &dhpackage; uses the Expat library to determine + if an XML document is well-formed. It is non-validating. + + + + If you do not specify any files on the command-line, + and you have a recent version of &dhpackage;, the input + file will be read from stdin. + + + + + + WELL-FORMED DOCUMENTS + + + A well-formed document must adhere to the + following rules: + + + + + The file begins with an XML declaration. For instance, + <?xml version="1.0" standalone="yes"?>. + NOTE: &dhpackage; does not currently + check for a valid XML declaration. + + + Every start tag is either empty (<tag/>) + or has a corresponding end tag. + + + There is exactly one root element. This element must contain + all other elements in the document. Only comments, white + space, and processing instructions may come after the close + of the root element. + + + All elements nest properly. + + + All attribute values are enclosed in quotes (either single + or double). + + + + + If the document has a DTD, and it strictly complies with that + DTD, then the document is also considered valid. + &dhpackage; is a non-validating parser -- it does not check the DTD. + However, it does support external entities (see the -x option). + + + + + OPTIONS + + +When an option includes an argument, you may specify the argument either +separate ("d output") or mashed ("-doutput"). &dhpackage; supports both. + + + + + + + + + If the input file is well-formed and &dhpackage; doesn't + encounter any errors, the input file is simply copied to + the output directory unchanged. + This implies no namespaces (turns off -n) and + requires -d to specify an output file. + + + + + + + + + Specifies a directory to contain transformed + representations of the input files. + By default, -d outputs a canonical representation + (described below). + You can select different output formats using -c and -m. + + + The output filenames will + be exactly the same as the input filenames or "STDIN" if the input is + coming from STDIN. Therefore, you must be careful that the + output file does not go into the same directory as the input + file. Otherwise, &dhpackage; will delete the input file before + it generates the output file (just like running + cat < file > file in most shells). + + + Two structurally equivalent XML documents have a byte-for-byte + identical canonical XML representation. + Note that ignorable white space is considered significant and + is treated equivalently to data. + More on canonical XML can be found at + http://www.jclark.com/xml/canonxml.html . + + + + + + + + + Specifies the character encoding for the document, overriding + any document encoding declaration. &dhpackage; + has four built-in encodings: + US-ASCII, + UTF-8, + UTF-16, and + ISO-8859-1. + Also see the -w option. + + + + + + + + + Outputs some strange sort of XML file that completely + describes the the input file, including character postitions. + Requires -d to specify an output file. + + + + + + + + + Turns on namespace processing. (describe namespaces) + -c disables namespaces. + + + + + + + + + Tells xmlwf to process external DTDs and parameter + entities. + + + Normally &dhpackage; never parses parameter entities. + -p tells it to always parse them. + -p implies -x. + + + + + + + + + Normally &dhpackage; memory-maps the XML file before parsing. + -r turns off memory-mapping and uses normal file IO calls instead. + Of course, memory-mapping is automatically turned off + when reading from STDIN. + + + + + + + + + Prints an error if the document is not standalone. + A document is standalone if it has no external subset and no + references to parameter entities. + + + + + + + + + Turns on timings. This tells Expat to parse the entire file, + but not perform any processing. + This gives a fairly accurate idea of the raw speed of Expat itself + without client overhead. + -t turns off most of the output options (-d, -m -c, ...). + + + + + + + + + Prints the version of the Expat library being used, and then exits. + + + + + + + + + Enables Windows code pages. + Normally, &dhpackage; will throw an error if it runs across + an encoding that it is not equipped to handle itself. With + -w, &dhpackage; will try to use a Windows code page. See + also -e. + + + + + + + + + Turns on parsing external entities. + + + Non-validating parsers are not required to resolve external + entities, or even expand entities at all. + Expat always expands internal entities (?), + but external entity parsing must be enabled explicitly. + + + External entities are simply entities that obtain their + data from outside the XML file currently being parsed. + + + This is an example of an internal entity: + +<!ENTITY vers '1.0.2'> + + + + And here are some examples of external entities: + + +<!ENTITY header SYSTEM "header-&vers;.xml"> (parsed) +<!ENTITY logo SYSTEM "logo.png" PNG> (unparsed) + + + + + + + + + + + For some reason, &dhpackage; specifically ignores "--" + anywhere it appears on the command line. + + + + + + + Older versions of &dhpackage; do not support reading from STDIN. + + + + + OUTPUT + + If an input file is not well-formed, &dhpackage; outputs + a single line describing the problem to STDOUT. + If a file is well formed, &dhpackage; outputs nothing. + Note that the result code is not set. + + + + + BUGS + + According to the W3C standard, an XML file without a + declaration at the beginning is not considered well-formed. + However, &dhpackage; allows this to pass. + + + &dhpackage; returns a 0 - noerr result, even if the file is + not well-formed. There is no good way for a program to use + xmlwf to quickly check a file -- it must parse xmlwf's STDOUT. + + + The errors should go to STDERR, not stdout. + + + There should be a way to get -d to send its output to STDOUT + rather than forcing the user to send it to a file. + + + I have no idea why anyone would want to use the -d, -c + and -m options. If someone could explain it to me, I'd + like to add this information to this manpage. + + + + + ALTERNATIVES + + Here are some XML validators on the web: + + +http://www.hcrc.ed.ac.uk/~richard/xml-check.html +http://www.stg.brown.edu/service/xmlvalid/ +http://www.scripting.com/frontier5/xml/code/xmlValidator.html +http://www.xml.com/pub/a/tools/ruwf/check.html + (on a page with no less than 15 ads! Shame!) + + + + + + + SEE ALSO + + + +The Expat home page: http://www.libexpat.org/ +The W3 XML specification: http://www.w3.org/TR/REC-xml + + + + + + + AUTHOR + + This manual page was written by &dhusername; &dhemail; for + the &debian; system (but may be used by others). Permission is + granted to copy, distribute and/or modify this document under + the terms of the GNU Free Documentation + License, Version 1.1. + + + + +