kc3-lang/libxml2/doc/xmllint.xml

• Show log

  Commit

• Hash : 027edfb7
  Author :
  Date : 2001-11-04T20:13:58
  

  Sun Nov 4 13:11:41 MST 2001 John Fleck <jfleck@inkstain.net
  
  
  Sun Nov  4 13:11:41 MST 2001 John Fleck <jfleck@inkstain.net
  
  	* doc/xmllint.xml, xmllint.1 - updating xmllint man page to
  	document --sgml option, fixing gnome bugzilla #63382
  

Download

• doc/xmllint.xml

• <?xml version="1.0"?>
  <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
      "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
  ]>
  <refentry>
    <refentryinfo>
      <title>xmllint Manual</title>
      <copyright>
        <year>2001</year>
      </copyright>
      <author>
        <firstname>John</firstname>
        <surname>Fleck</surname>
      </author>
      <address><email>jfleck@inkstain.net</email></address>
      <author>
        <firstname>Ziying</firstname>
        <surname>Sherwin</surname>
      </author>
      <address><email>sherwin@nlm.nih.gov</email></address>
      <legalnotice id="legalnotice">
        <para>Permission is granted to copy, distribute and/or modify this document
  	under the terms of the <ulink type="help" url="gnome-help:fdl"><citetitle>GNU Free Documentation
  	    License</citetitle></ulink>, Version 1.1 or any later version 
  	published by the Free Software Foundation with no Invariant Sections, 
  	no Front-Cover Texts, and no Back-Cover Texts.  A copy of the license
  	can be found <ulink type="help" url="gnome-help:fdl">here</ulink>.
        </para>
        <para>Many of the names used by companies to distinguish their products and
  	services are claimed as trademarks. Where those names appear in any
  	GNOME documentation, and those trademarks are made aware to the members
  	of the GNOME Documentation Project, the names have been printed in caps
  	or initial caps.
        </para>
      </legalnotice>
      <releaseinfo>This is release 0.1 of the xmllint Manual.</releaseinfo>
    </refentryinfo>
  
    <refmeta>
      <refentrytitle>xmllint</refentrytitle>
      <manvolnum>1</manvolnum>
    </refmeta>
  
    <refnamediv>
      <refname>xmllint</refname>
      <refpurpose>command line <acronym>XML</acronym> tool</refpurpose>
    </refnamediv>
  
    <refsynopsisdiv>
      <cmdsynopsis>
        <command>xmllint</command>
        <group>
  	<arg>--version</arg>
  	<arg>--debug</arg>
  	<arg>--shell</arg>
  	<arg>--debugent</arg>
  	<arg>--copy</arg>
  	<arg>--recover</arg>
  	<arg>--noent</arg>
  	<arg>--noout</arg>
  	<arg>--htmlout</arg>
  	<arg>--nowrap</arg>
  	<arg>--valid</arg>
  	<arg>--postvalid</arg>
  	<arg>--dtdvalid <replaceable>URL</replaceable></arg>
  	<arg>--timing</arg>
  	<arg>--repeat</arg>
  	<arg>--insert</arg>
  	<arg>--compress</arg>
  	<arg>--sgml</arg>
  	<arg>--html</arg>
  	<arg>--push</arg>
  	<arg>--memory</arg>
  	<arg>--nowarning</arg>
  	<arg>--noblanks</arg>
  	<arg>--format</arg>
  	<arg>--testIO</arg>
  	<arg>--encode <replaceable>encoding</replaceable></arg>
  	<arg>--catalogs</arg>
  	<arg>--nocatalogs</arg>
  	<arg>--auto</arg>
  	<arg>--xinclude</arg>
  	<arg>--loaddtd</arg>
  	<arg>--dtdattr</arg>
        </group>
        <arg><option><replaceable>xmlfile</replaceable></option></arg>
    </cmdsynopsis>
    </refsynopsisdiv>
  
    <refsect1 id="introduction">
      <title>Introduction</title>
      <para>
        The xmllint program parses one or more XML files, specified on the
        command line as <replaceable>xmlfile</replaceable>. It prints various
        types of output, depending upon the options selected. It is useful for
        detecting errors both in <acronym>XML</acronym> code and in the
        <acronym>XML</acronym> parser itself.
      </para>
  
      <para>
        It is included in <application>libxml2</application>.
      </para>
    </refsect1>
    <refsect1 id="options">
      <title>Options</title>
      <variablelist>
        <varlistentry>
  	<term><option>--version</option></term>
  	<listitem>
  	  <simpara>
  	    Display the version of
  	    <application>libxml2</application> used.
  	  </simpara>
  	</listitem>
        </varlistentry>
  
        <varlistentry>
  	<term><option>--debug</option></term>
  	<listitem>
  	  <simpara>
  	    Parse a file and output an annotated tree of the
  	    in-memory version of the document.
  	  </simpara>
  	</listitem>
        </varlistentry>
  
        <varlistentry>
  	<term><option>--shell</option></term>
  	<listitem>
  	  <simpara>
  	    Run a navigating shell.
  	  </simpara>
  	</listitem>
        </varlistentry>
  
        <varlistentry>
  	<term><option>--debugent</option></term>
  	<listitem>
  	  <simpara>
  	    Debug the entities defined in the document.
  	  </simpara>
  	</listitem>
        </varlistentry>
  
        <varlistentry>
  	<term><option>--copy</option> </term>
  	<listitem>
  	  <simpara>
  	    Test the internal copy implementation.
  	  </simpara>
  	</listitem>
        </varlistentry>
      
        
        <varlistentry>
  	<term><option>--recover</option></term>
  	<listitem>
  	  <simpara>
  	    Output any parsable portions of an invalid
  	    document.
  	  </simpara>
  	</listitem>
        </varlistentry>
  
        <varlistentry>
  	<term><option>--noent</option></term>
  	<listitem>
  	  <simpara>
  	    Substitute entity values for entity
  	    references. By default, <application>xmllint</application> leaves entity
  	    references in place.
  	  </simpara>
  	</listitem>
        </varlistentry>
     
        <varlistentry>
  	<term><option>--noout</option></term>
  	<listitem>
  	  <simpara>
  	    Suppress output. By default,
  	    <application>xmllint</application> outputs the result tree.
  	  </simpara>
  	</listitem>
        </varlistentry>
  
      <varlistentry>
  	<term><option>--htmlout</option></term>
  	<listitem>
  	  <simpara>
  	    Output results as an <acronym>HTML</acronym>
  	    file. This causes <application>xmllint</application> to output
  	    the necessary <acronym>HTML</acronym> tags surrounding the result tree
  	    output so the results can be displayed in a browser. 
  	  </simpara>
  	</listitem>
        </varlistentry>
  
      <varlistentry>
  	<term><option>--nowrap </option></term>
  	<listitem>
  	  <simpara>
  	    Do not output HTML doc wrapper.
  	  </simpara>
  	</listitem>
        </varlistentry>
  
  <varlistentry>
  	<term><option>--valid </option></term>
  	<listitem>
  	  <simpara>
  	    Determine if the document is a valid instance
  	    of the included Document Type Definition (<acronym>DTD</acronym>). A
  	    <acronym>DTD</acronym> to be validated against also can be specified at
  	    the command line using the <option>--dtdvalid</option> option. By default,
  	    <application>xmllint</application> also checks to determine if the
  	    document is well-formed.
  	  </simpara>
  	</listitem>
        </varlistentry>
     
   <varlistentry>
  	<term><option>--postvalid</option></term>
  	<listitem>
  	  <simpara>
  	    Validate after parsing is completed.
  	  </simpara>
  	</listitem>
        </varlistentry>
     
      <varlistentry>
  	<term> <option>--dtdvalid</option> <replaceable>URL</replaceable></term>
  	<listitem>
  	  <simpara>
  	    Use the
        <acronym>DTD</acronym> specified by <replaceable>URL</replaceable> for
        validation.
  	  </simpara>
  	</listitem>
        </varlistentry>
     
       <varlistentry>
  	<term><option>--timing</option></term>
  	<listitem>
  	  <simpara>
  	    Output information about the time it takes
  	    <application>xmllint</application> to perform the various steps.
  	  </simpara>
  	</listitem>
        </varlistentry>
  
     <varlistentry>
  	<term><option>--repeat</option></term>
  	<listitem>
  	  <simpara>
  	    Repeat 100 times, for timing or profiling.
  	  </simpara>
  	</listitem>
        </varlistentry>
     
      <varlistentry>
  	<term><option>--insert</option></term>
  	<listitem>
  	  <simpara>
  	    Test for valid insertions.
  	  </simpara>
  	</listitem>
        </varlistentry>
  
        <varlistentry>
  	<term><option>--compress</option></term>
  	<listitem>
  	  <simpara>
  	    Turn on gzip compression of output.
  	  </simpara>
  	</listitem>
        </varlistentry>
     
        <varlistentry>
  	<term><option>--sgml</option></term>
  	<listitem>
  	  <simpara>Use the DocBook <acronym>SGML</acronym> parser. This allows
  	    documents written in <acronym>SGML</acronym> DocBook to be converted
  	    into an in-memory tree and treated as if they were written in
  	    <acronym>XML</acronym>.</simpara>
  	</listitem>
        </varlistentry>
  
      <varlistentry>
  	<term><option>--html</option></term>
  	<listitem>
  	  <simpara>
  	    Use the <acronym>HTML</acronym> parser.
  	  </simpara>
  	</listitem>
        </varlistentry>
     
      <varlistentry>
  	<term><option>--push</option></term>
  	<listitem>
  	  <simpara>
  	    Use the push mode of the parser.
  	  </simpara>
  	</listitem>
        </varlistentry>
     
  
      <varlistentry>
  	<term><option>--memory</option></term>
  	<listitem>
  	  <simpara>
  	   Parse from memory.
  	  </simpara>
  	</listitem>
        </varlistentry>
  
      <varlistentry>
  	<term><option>--nowarning</option></term>
  	<listitem>
  	  <simpara>
  	   Do not emit warnings from the parser and/or validator.
  	  </simpara>
  	</listitem>
        </varlistentry>
  
      <varlistentry>
  	<term><option>--noblanks</option></term>
  	<listitem>
  	  <simpara>
  	   Drop ignorable blank spaces.
  	  </simpara>
  	</listitem>
        </varlistentry>
  
      <varlistentry>
  	<term><option>--format</option></term>
  	<listitem>
  	  <simpara>
  	   Reformat and reindent the output.
  	  </simpara>
  	</listitem>
        </varlistentry>
  
      <varlistentry>
  	<term><option>--testIO</option></term>
  	<listitem>
  	  <simpara>
  	   Test user input/output support.
  	  </simpara>
  	</listitem>
        </varlistentry>
  
      <varlistentry>
        <term><option>--encode</option> <replaceable>encoding</replaceable></term>
  	<listitem>
  	  <simpara>
  	   Output in the given encoding.
  	  </simpara>
  	</listitem>
        </varlistentry>
      
      <varlistentry>
  	<term><option>--catalogs</option></term>
  	<listitem>
  	  <simpara>
  	   Use the catalogs from $SGML_CATALOG_FILES. Otherwise /etc/xml/catalog
  	   is used by default.
  	  </simpara>
  	</listitem>
        </varlistentry>
  
      <varlistentry>
  	<term><option>--nocatalogs</option></term>
  	<listitem>
  	  <simpara>
  	   Do not use any catalogs.
  	  </simpara>
  	</listitem>
        </varlistentry>
      
      <varlistentry>
  	<term><option>--auto</option></term>
  	<listitem>
  	  <simpara>
  	   Generate a small document for testing purposes.
  	  </simpara>
  	</listitem>
        </varlistentry>
  
      <varlistentry>
  	<term><option>--xinclude</option></term>
  	<listitem>
  	  <simpara>
  	   Do XInclude processing.
  	  </simpara>
  	</listitem>
        </varlistentry>
      <varlistentry>
  	<term><option>--loaddtd</option></term>
  	<listitem>
  	  <simpara>
  	   Fetch external DTD.
  	  </simpara>
  	</listitem>
        </varlistentry>
      
      <varlistentry>
  	<term><option>--dtdattr</option></term>
  	<listitem>
  	  <simpara>
  	   Fetch external DTD and populate the tree with inherited attributes.
  	  </simpara>
  	</listitem>
        </varlistentry>
  
      </variablelist>
    </refsect1>
  </refentry>

Download