Revive master sound enable switch.

[flightgear.git] / utils / xmlgrep / README

diff --git a/utils/xmlgrep/README b/utils/xmlgrep/README
index 81757de9d388f4e6b052b06ea405ac908590282e..72ab606ea3d99dfc5998e07a12fb83f74b579994 100644 (file)
--- a/utils/xmlgrep/README
+++ b/utils/xmlgrep/README
@@ -1,106 +1,6 @@
-This library is specially designed for reading xml configuration files and
-to be as low on memory management as possible. Modifying or writing xml files
-is not planned for the future. In most situations being able to gather data
-by reading an xml file is more than enough and the read-only decision
-provides a number of advantages over a one-size fits all approach. For isntance
-the memory footprint can be kept low and the library can be kept simple.
 
-To achieve these goals the mmap function is used to map the configuration file
-to a memory region. The only places where memory is allocated is when creating
-a new XML-id, when requesting a string from a node or when a request is made to
-copy a node.
+The xmlgrep utility is part op the ZeroXML package which is now hosted at:
+http://www.adalin.com
 
-Using this library should be pretty simple for most tasks; just open a file,
-read every parameter one by one and close the id again.
-{
-   void *xid;
+Any further development will take place there.
 
-   xid = xmlOpen("/tmp/file.xml");
-   xpos = xmlGetNodeDouble(xid, "/configuration/x-pos");
-   ypos = xmlGetNodeDouble(xid, "/configuration/y-pos");
-   zpos = xmlGetNodeDouble(xid, "/configuration/z-pos");
-   xmlClose(xid);
-}
-
-While it is certainly possible to access every node directly by calling the
-xmlGetNode(Int/Double/String) functions, when more than one node need to be
-gathered from a parent node it is advised to get the id of the parent node
-and work from there. This is because the XML-id holds the boundaries of the
-(parent)node which limits the searching area causing improved searching speed.
-{
-   void *xnid;
-   char *s;
-
-   xnid = xmlGetNode(id, "/configuration/setup/");
-   version = xmlGetNodeDouble(xnid, "version");
-   s = xmlGetNodeString(xnid, "author");
-   if (s) author = s;
-   free(s);
-   free(xnid);
-}
-
-Overview of the available functions:
- ----------------------------------------------------------------------------- 
-#
-# Functions to Open and Close the XML file
-# e.g.
-#   id = xmlOpen("/tmp/file.xml");
-#   xmlClose(id);
-#
-void *xmlOpen(const char *);
-void xmlClose(const void *);
-
-#
-# Get the Id of a node at the specified path
-# e.g.
-#    xnid = xmlGetNode(id, "/path/to/specified/node");
-#
-void *xmlGetNode(const void *, const char *);
-void *xmlCopyNode(void *, const char *);
-
-#
-# Functions to walk the node tree and process them one by one.
-# e.g.
-#   xmid = xmlMarkId(id);
-#   num = xmlGetNumElements(xmid);
-#   for (i=0; i<num; i++) {
-#      if (xmlGetNextElement(id, xmid, "element") != 0) {
-#         if ((s = xmlGetString(xmid)) != 0) {
-#            printf("%s\n", s);
-#            free(s);
-#         }
-#      }
-#   }
-#   free(xmid);
-#
-void *xmlMarkId(void *);
-unsigned int xmlGetNumElements(void *, const char *);
-void *xmlGetNextElement(const void *, void *, const char *);
-
-#
-# These functions work on the current node.
-# e.g.
-#    xnid = xmlGetNode(id, "/path/to/last/node");
-#    i = xmlGetInt(xnid);
-# or
-#    xnid = xmlGetNode(id, "/path/to/specified/node");
-#    if (xmlCompareString(xnid, "value") == 0) printf("We have a match!\n");
-#
-long int xmlGetInt(void *);
-double xmlGetDouble(void *);
-char *xmlGetString(void *);
-int xmlCompareString(const void *, const char *);
-
-#
-# These functions work on a specified node path
-# e.g.
-#    d = xmlGetNodeDouble(id, "/path/to/node");
-# or
-#    xnid = xmlGetNode(id, "/path/to");
-#    i = xmlGetNodeInt(xnid, "node");
-#
-long int xmlGetNodeInt(void *, const char *);
-double xmlGetNodeDouble(void *, const char *);
-char *xmlGetNodeString(void *, const char *);
-unsigned xmlCopyNodeString(void *, const char *, char *, const unsigned int);
-int xmlCompareNodeString(const void *, const char *, const char *);