doc/FAQ.html

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="SHORTCUT ICON" href="/favicon.ico" /><style type="text/css">
   4 TD {font-family: Verdana,Arial,Helvetica}
   5 BODY {font-family: Verdana,Arial,Helvetica; margin-top: 2em; margin-left: 0em; margin-right: 0em}
   6 H1 {font-family: Verdana,Arial,Helvetica}
   7 H2 {font-family: Verdana,Arial,Helvetica}
   8 H3 {font-family: Verdana,Arial,Helvetica}
   9 A:link, A:visited, A:active { text-decoration: underline }
  10 </style><title>FAQ</title></head><body bgcolor="#8b7765" text="#000000" link="#a06060" vlink="#000000"><table border="0" width="100%" cellpadding="5" cellspacing="0" align="center"><tr><td width="120"><a href="http://swpat.ffii.org/"><img src="epatents.png" alt="Action against software patents" /></a></td><td width="180"><a href="http://www.gnome.org/"><img src="gnome2.png" alt="Gnome2 Logo" /></a><a href="http://www.w3.org/Status"><img src="w3c.png" alt="W3C Logo" /></a><a href="http://www.redhat.com/"><img src="redhat.gif" alt="Red Hat Logo" /></a><div align="left"><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-180x168.gif" alt="Made with Libxml2 Logo" /></a></div></td><td><table border="0" width="90%" cellpadding="2" cellspacing="0" align="center" bgcolor="#000000"><tr><td><table width="100%" border="0" cellspacing="1" cellpadding="3" bgcolor="#fffacd"><tr><td align="center"><h1>The XML C parser and toolkit of Gnome</h1><h2>FAQ</h2></td></tr></table></td></tr></table></td></tr></table><table border="0" cellpadding="4" cellspacing="0" width="100%" align="center"><tr><td bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td valign="top" width="200" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td><table width="100%" border="0" cellspacing="1" cellpadding="3"><tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Main Menu</b></center></td></tr><tr><td bgcolor="#fffacd"><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="20" value="" /><input name="submit" type="submit" value="Search ..." /></form><ul><li><a href="index.html">Home</a></li><li><a href="html/index.html">Reference Manual</a></li><li><a href="intro.html">Introduction</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="docs.html" style="font-weight:bold">Developer Menu</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="help.html">How to help</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="news.html">Releases</a></li><li><a href="XMLinfo.html">XML</a></li><li><a href="XSLT.html">XSLT</a></li><li><a href="xmldtd.html">Validation &amp; DTDs</a></li><li><a href="encoding.html">Encodings support</a></li><li><a href="catalog.html">Catalog support</a></li><li><a href="namespaces.html">Namespaces</a></li><li><a href="contribs.html">Contributions</a></li><li><a href="examples/index.html" style="font-weight:bold">Code Examples</a></li><li><a href="html/index.html" style="font-weight:bold">API Menu</a></li><li><a href="guidelines.html">XML Guidelines</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></td></tr></table><table width="100%" border="0" cellspacing="1" cellpadding="3"><tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Related links</b></center></td></tr><tr><td bgcolor="#fffacd"><ul><li><a href="http://mail.gnome.org/archives/xml/">Mail archive</a></li><li><a href="http://xmlsoft.org/XSLT/">XSLT libxslt</a></li><li><a href="http://phd.cs.unibo.it/gdome2/">DOM gdome2</a></li><li><a href="http://www.aleksey.com/xmlsec/">XML-DSig xmlsec</a></li><li><a href="ftp://xmlsoft.org/">FTP</a></li><li><a href="http://www.zlatkovic.com/projects/libxml/">Windows binaries</a></li><li><a href="http://opencsw.org/packages/libxml2">Solaris binaries</a></li><li><a href="http://www.explain.com.au/oss/libxml2xslt.html">MacOsX binaries</a></li><li><a href="http://lxml.de/">lxml Python bindings</a></li><li><a href="http://cpan.uwinnipeg.ca/dist/XML-LibXML">Perl bindings</a></li><li><a href="http://libxmlplusplus.sourceforge.net/">C++ bindings</a></li><li><a href="http://www.zend.com/php5/articles/php5-xmlphp.php#Heading4">PHP bindings</a></li><li><a href="http://sourceforge.net/projects/libxml2-pas/">Pascal bindings</a></li><li><a href="http://libxml.rubyforge.org/">Ruby bindings</a></li><li><a href="http://tclxml.sourceforge.net/">Tcl bindings</a></li><li><a href="http://bugzilla.gnome.org/buglist.cgi?product=libxml2">Bug Tracker</a></li></ul></td></tr></table></td></tr></table></td><td valign="top" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%"><tr><td><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td><table border="0" cellpadding="3" cellspacing="1" width="100%"><tr><td bgcolor="#fffacd"><p>Table of Contents:</p><ul>
  11   <li><a href="FAQ.html#License">License(s)</a></li>
  12   <li><a href="FAQ.html#Installati">Installation</a></li>
  13   <li><a href="FAQ.html#Compilatio">Compilation</a></li>
  14   <li><a href="FAQ.html#Developer">Developer corner</a></li>
  15 </ul><h3><a name="License" id="License">License</a>(s)</h3><ol>
  16   <li><em>Licensing Terms for libxml</em>
  17     <p>libxml2 is released under the <a href="http://www.opensource.org/licenses/mit-license.html">MIT
  18     License</a>; see the file Copyright in the distribution for the precise
  19     wording</p>
  20   </li>
  21   <li><em>Can I embed libxml2 in a proprietary application ?</em>
  22     <p>Yes. The MIT License allows you to keep proprietary the changes you
  23     made to libxml, but it would be graceful to send-back bug fixes and
  24     improvements as patches for possible incorporation in the main
  25     development tree.</p>
  26   </li>
  27 </ol><h3><a name="Installati" id="Installati">Installation</a></h3><ol>
  28   <li><strong><span style="background-color: #FF0000">Do Not Use
  29     libxml1</span></strong>, use libxml2</li>
  30   <p></p>
  31   <li><em>Where can I get libxml</em> ?
  32     <p>The original distribution comes from <a href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a> or <a href="ftp://ftp.gnome.org/pub/GNOME/sources/libxml2/2.6/">gnome.org</a></p>
  33     <p>Most Linux and BSD distributions include libxml, this is probably the
  34     safer way for end-users to use libxml.</p>
  35     <p>David Doolin provides precompiled Windows versions at <a href="http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/         ">http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/</a></p>
  36   </li>
  37   <p></p>
  38   <li><em>I see libxml and libxml2 releases, which one should I install ?</em>
  39     <ul>
  40       <li>If you are not constrained by backward compatibility issues with
  41         existing applications, install libxml2 only</li>
  42       <li>If you are not doing development, you can safely install both.
  43         Usually the packages <a href="http://rpmfind.net/linux/RPM/libxml.html">libxml</a> and <a href="http://rpmfind.net/linux/RPM/libxml2.html">libxml2</a> are
  44         compatible (this is not the case for development packages).</li>
  45       <li>If you are a developer and your system provides separate packaging
  46         for shared libraries and the development components, it is possible
  47         to install libxml and libxml2, and also <a href="http://rpmfind.net/linux/RPM/libxml-devel.html">libxml-devel</a>
  48         and <a href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml2-devel</a>
  49         too for libxml2 &gt;= 2.3.0</li>
  50       <li>If you are developing a new application, please develop against
  51         libxml2(-devel)</li>
  52     </ul>
  53   </li>
  54   <li><em>I can't install the libxml package, it conflicts with libxml0</em>
  55     <p>You probably have an old libxml0 package used to provide the shared
  56     library for libxml.so.0, you can probably safely remove it. The libxml
  57     packages provided on <a href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a> provide
  58     libxml.so.0</p>
  59   </li>
  60   <li><em>I can't install the libxml(2) RPM package due to failed
  61     dependencies</em>
  62     <p>The most generic solution is to re-fetch the latest src.rpm , and
  63     rebuild it locally with</p>
  64     <p><code>rpm --rebuild libxml(2)-xxx.src.rpm</code>.</p>
  65     <p>If everything goes well it will generate two binary rpm packages (one
  66     providing the shared libs and xmllint, and the other one, the -devel
  67     package, providing includes, static libraries and scripts needed to build
  68     applications with libxml(2)) that you can install locally.</p>
  69   </li>
  70 </ol><h3><a name="Compilatio" id="Compilatio">Compilation</a></h3><ol>
  71   <li><em>What is the process to compile libxml2 ?</em>
  72     <p>As most UNIX libraries libxml2 follows the "standard":</p>
  73     <p><code>gunzip -c xxx.tar.gz | tar xvf -</code></p>
  74     <p><code>cd libxml-xxxx</code></p>
  75     <p><code>./configure --help</code></p>
  76     <p>to see the options, then the compilation/installation proper</p>
  77     <p><code>./configure [possible options]</code></p>
  78     <p><code>make</code></p>
  79     <p><code>make install</code></p>
  80     <p>At that point you may have to rerun ldconfig or a similar utility to
  81     update your list of installed shared libs.</p>
  82   </li>
  83   <li><em>What other libraries are needed to compile/install libxml2 ?</em>
  84     <p>Libxml2 does not require any other library, the normal C ANSI API
  85     should be sufficient (please report any violation to this rule you may
  86     find).</p>
  87     <p>However if found at configuration time libxml2 will detect and use the
  88     following libs:</p>
  89     <ul>
  90       <li><a href="http://www.info-zip.org/pub/infozip/zlib/">libz</a> : a
  91         highly portable and available widely compression library.</li>
  92       <li>iconv: a powerful character encoding conversion library. It is
  93         included by default in recent glibc libraries, so it doesn't need to
  94         be installed specifically on Linux. It now seems a <a href="http://www.opennc.org/onlinepubs/7908799/xsh/iconv.html">part
  95         of the official UNIX</a> specification. Here is one <a href="http://www.gnu.org/software/libiconv/">implementation of the
  96         library</a> which source can be found <a href="ftp://ftp.ilog.fr/pub/Users/haible/gnu/">here</a>.</li>
  97     </ul>
  98   </li>
  99   <p></p>
 100   <li><em>Make check fails on some platforms</em>
 101     <p>Sometimes the regression tests' results don't completely match the
 102     value produced by the parser, and the makefile uses diff to print the
 103     delta. On some platforms the diff return breaks the compilation process;
 104     if the diff is small this is probably not a serious problem.</p>
 105     <p>Sometimes (especially on Solaris) make checks fail due to limitations
 106     in make. Try using GNU-make instead.</p>
 107   </li>
 108   <li><em>I use the SVN version and there is no configure script</em>
 109     <p>The configure script (and other Makefiles) are generated. Use the
 110     autogen.sh script to regenerate the configure script and Makefiles,
 111     like:</p>
 112     <p><code>./autogen.sh --prefix=/usr --disable-shared</code></p>
 113   </li>
 114   <li><em>I have troubles when running make tests with gcc-3.0</em>
 115     <p>It seems the initial release of gcc-3.0 has a problem with the
 116     optimizer which miscompiles the URI module. Please use another
 117     compiler.</p>
 118   </li>
 119 </ol><h3><a name="Developer" id="Developer">Developer</a> corner</h3><ol>
 120   <li><em>Troubles compiling or linking programs using libxml2</em>
 121     <p>Usually the problem comes from the fact that the compiler doesn't get
 122     the right compilation or linking flags. There is a small shell script
 123     <code>xml2-config</code> which is installed as part of libxml2 usual
 124     install process which provides those flags. Use</p>
 125     <p><code>xml2-config --cflags</code></p>
 126     <p>to get the compilation flags and</p>
 127     <p><code>xml2-config --libs</code></p>
 128     <p>to get the linker flags. Usually this is done directly from the
 129     Makefile as:</p>
 130     <p><code>CFLAGS=`xml2-config --cflags`</code></p>
 131     <p><code>LIBS=`xml2-config --libs`</code></p>
 132   </li>
 133   <li><em>I want to install my own copy of libxml2 in my home directory and
 134     link my programs against it, but it doesn't work</em>
 135     <p>There are many different ways to accomplish this.  Here is one way to
 136     do this under Linux.  Suppose your home directory is <code>/home/user.
 137     </code>Then:</p>
 138     <ul>
 139       <li>Create a subdirectory, let's call it <code>myxml</code></li>
 140       <li>unpack the libxml2 distribution into that subdirectory</li>
 141       <li>chdir into the unpacked distribution
 142         (<code>/home/user/myxml/libxml2 </code>)</li>
 143       <li>configure the library using the "<code>--prefix</code>" switch,
 144         specifying an installation subdirectory in
 145         <code>/home/user/myxml</code>, e.g.
 146         <p><code>./configure --prefix /home/user/myxml/xmlinst</code> {other
 147         configuration options}</p>
 148       </li>
 149       <li>now run <code>make</code> followed by <code>make install</code></li>
 150       <li>At this point, the installation subdirectory contains the complete
 151         "private" include files, library files and binary program files (e.g.
 152         xmllint), located in
 153         <p><code>/home/user/myxml/xmlinst/lib,
 154         /home/user/myxml/xmlinst/include </code> and <code>
 155         /home/user/myxml/xmlinst/bin</code></p>
 156         respectively.</li>
 157       <li>In order to use this "private" library, you should first add it to
 158         the beginning of your default PATH (so that your own private program
 159         files such as xmllint will be used instead of the normal system
 160         ones).  To do this, the Bash command would be
 161         <p><code>export PATH=/home/user/myxml/xmlinst/bin:$PATH</code></p>
 162       </li>
 163       <li>Now suppose you have a program <code>test1.c</code> that you would
 164         like to compile with your "private" library.  Simply compile it using
 165         the command
 166         <p><code>gcc `xml2-config --cflags --libs` -o test test.c</code></p>
 167         Note that, because your PATH has been set with <code>
 168         /home/user/myxml/xmlinst/bin</code> at the beginning, the xml2-config
 169         program which you just installed will be used instead of the system
 170         default one, and this will <em>automatically</em> get the correct
 171         libraries linked with your program.</li>
 172     </ul>
 173   </li>
 174
 175   <p></p>
 176   <li><em>xmlDocDump() generates output on one line.</em>
 177     <p>Libxml2 will not <strong>invent</strong> spaces in the content of a
 178     document since <strong>all spaces in the content of a document are
 179     significant</strong>. If you build a tree from the API and want
 180     indentation:</p>
 181     <ol>
 182       <li>the correct way is to generate those yourself too.</li>
 183       <li>the dangerous way is to ask libxml2 to add those blanks to your
 184         content <strong>modifying the content of your document in the
 185         process</strong>. The result may not be what you expect. There is
 186         <strong>NO</strong> way to guarantee that such a modification won't
 187         affect other parts of the content of your document. See <a href="http://xmlsoft.org/html/libxml-parser.html#xmlKeepBlanksDefault">xmlKeepBlanksDefault
 188         ()</a> and <a href="http://xmlsoft.org/html/libxml-tree.html#xmlSaveFormatFile">xmlSaveFormatFile
 189         ()</a></li>
 190     </ol>
 191   </li>
 192   <p></p>
 193   <li><em>Extra nodes in the document:</em>
 194     <p><em>For an XML file as below:</em></p>
 195     <pre>&lt;?xml version="1.0"?&gt;
 196 &lt;PLAN xmlns="http://www.argus.ca/autotest/1.0/"&gt;
 197 &lt;NODE CommFlag="0"/&gt;
 198 &lt;NODE CommFlag="1"/&gt;
 199 &lt;/PLAN&gt;</pre>
 200     <p><em>after parsing it with the function
 201     pxmlDoc=xmlParseFile(...);</em></p>
 202     <p><em>I want to the get the content of the first node (node with the
 203     CommFlag="0")</em></p>
 204     <p><em>so I did it as following;</em></p>
 205     <pre>xmlNodePtr pnode;
 206 pnode=pxmlDoc-&gt;children-&gt;children;</pre>
 207     <p><em>but it does not work. If I change it to</em></p>
 208     <pre>pnode=pxmlDoc-&gt;children-&gt;children-&gt;next;</pre>
 209     <p><em>then it works.  Can someone explain it to me.</em></p>
 210     <p></p>
 211     <p>In XML all characters in the content of the document are significant
 212     <strong>including blanks and formatting line breaks</strong>.</p>
 213     <p>The extra nodes you are wondering about are just that, text nodes with
 214     the formatting spaces which are part of the document but that people tend
 215     to forget. There is a function <a href="http://xmlsoft.org/html/libxml-parser.html">xmlKeepBlanksDefault
 216     ()</a>  to remove those at parse time, but that's an heuristic, and its
 217     use should be limited to cases where you are certain there is no
 218     mixed-content in the document.</p>
 219   </li>
 220   <li><em>I get compilation errors of existing code like when accessing
 221     <strong>root</strong> or <strong>child fields</strong> of nodes.</em>
 222     <p>You are compiling code developed for libxml version 1 and using a
 223     libxml2 development environment. Either switch back to libxml v1 devel or
 224     even better fix the code to compile with libxml2 (or both) by <a href="upgrade.html">following the instructions</a>.</p>
 225   </li>
 226   <li><em>I get compilation errors about non existing
 227     <strong>xmlRootNode</strong> or <strong>xmlChildrenNode</strong>
 228     fields.</em>
 229     <p>The source code you are using has been <a href="upgrade.html">upgraded</a> to be able to compile with both libxml
 230     and libxml2, but you need to install a more recent version:
 231     libxml(-devel) &gt;= 1.8.8 or libxml2(-devel) &gt;= 2.1.0</p>
 232   </li>
 233   <li><em>Random crashes in threaded applications</em>
 234     <p>Read and follow all advices on the <a href="threads.html">thread
 235     safety</a> page, and make 100% sure you never call xmlCleanupParser()
 236     while the library or an XML document might still be in use by another
 237     thread.</p>
 238   </li>
 239   <li><em>The example provided in the web page does not compile.</em>
 240     <p>It's hard to maintain the documentation in sync with the code
 241     &lt;grin/&gt; ...</p>
 242     <p>Check the previous points 1/ and 2/ raised before, and please send
 243     patches.</p>
 244   </li>
 245   <li><em>Where can I get more examples and information than provided on the
 246     web page?</em>
 247     <p>Ideally a libxml2 book would be nice. I have no such plan ... But you
 248     can:</p>
 249     <ul>
 250       <li>check more deeply the <a href="html/libxml-lib.html">existing
 251         generated doc</a></li>
 252       <li>have a look at <a href="examples/index.html">the set of
 253         examples</a>.</li>
 254       <li>look for examples of use for libxml2 function using the Gnome code
 255           or by asking on Google.</li>
 256       <li><a href="http://svn.gnome.org/viewvc/libxml2/trunk/">Browse
 257         the libxml2 source</a> , I try to write code as clean and documented
 258         as possible, so looking at it may be helpful. In particular the code
 259         of <a href="http://svn.gnome.org/viewvc/libxml2/trunk/xmllint.c?view=markup">xmllint.c</a> and of the various testXXX.c test programs should
 260         provide good examples of how to do things with the library.</li>
 261     </ul>
 262   </li>
 263   <p></p>
 264   <li><em>What about C++ ?</em>
 265     <p>libxml2 is written in pure C in order to allow easy reuse on a number
 266     of platforms, including embedded systems. I don't intend to convert to
 267     C++.</p>
 268     <p>There is however a C++ wrapper which may fulfill your needs:</p>
 269     <ul>
 270       <li>by Ari Johnson &lt;ari@btigate.com&gt;:
 271         <p>Website: <a href="http://libxmlplusplus.sourceforge.net/">http://libxmlplusplus.sourceforge.net/</a></p>
 272         <p>Download: <a href="http://sourceforge.net/project/showfiles.php?group_id=12999">http://sourceforge.net/project/showfiles.php?group_id=12999</a></p>
 273       </li>
 274     </ul>
 275   </li>
 276   <li><em>How to validate a document a posteriori ?</em>
 277     <p>It is possible to validate documents which had not been validated at
 278     initial parsing time or documents which have been built from scratch
 279     using the API. Use the <a href="http://xmlsoft.org/html/libxml-valid.html#xmlValidateDtd">xmlValidateDtd()</a>
 280     function. It is also possible to simply add a DTD to an existing
 281     document:</p>
 282     <pre>xmlDocPtr doc; /* your existing document */
 283 xmlDtdPtr dtd = xmlParseDTD(NULL, filename_of_dtd); /* parse the DTD */
 284
 285         dtd-&gt;name = xmlStrDup((xmlChar*)"root_name"); /* use the given root */
 286
 287         doc-&gt;intSubset = dtd;
 288         if (doc-&gt;children == NULL) xmlAddChild((xmlNodePtr)doc, (xmlNodePtr)dtd);
 289         else xmlAddPrevSibling(doc-&gt;children, (xmlNodePtr)dtd);
 290           </pre>
 291   </li>
 292   <li><em>So what is this funky "xmlChar" used all the time?</em>
 293     <p>It is a null terminated sequence of utf-8 characters. And only utf-8!
 294     You need to convert strings encoded in different ways to utf-8 before
 295     passing them to the API.  This can be accomplished with the iconv library
 296     for instance.</p>
 297   </li>
 298   <li>etc ...</li>
 299 </ol><p></p><p><a href="bugs.html">Daniel Veillard</a></p></td></tr></table></td></tr></table></td></tr></table></td></tr></table></td></tr></table></body></html>