INSTALL

   1 Dependencies
   2 ------------
   3 libexpat-ocaml-dev
   4 ocaml-findlib
   5 ocaml-ulex
   6 ocaml-nox
   7 camlp4
   8
   9 and their dependencies as well as ocamlbuild which is part of the standard ocaml distribution.
  10
  11 Build instructions
  12 ------------------
  13
  14 Build the xpathcomp program:
  15 ./configure
  16 ./build
  17
  18 See ./build --help to customize the build process (build with debugging/profiling code, build ocaml
  19 bytecode instead of native binary etc...).
  20
  21 This will produce a main.native executable (a symlink to the real binary which lies in the _build/src
  22 directory).
  23
  24 Usage
  25 -----
  26 ./main.native [options] 'input_file' 'query' [output_file]
  27
  28 input_file can be either an xml file (and thus the name must have a .xml extension) or an indexed file
  29 (with a .srx extension). Due to a bug in the parser, the query can only use the explicit syntax, that
  30 is:
  31
  32 /descendant::a/child::b[ child::a and descendant::c or not(contains( ., "str")) ]/descendant::d
  33
  34 and no // or a/b/c. Text predicates must be of the form function( ., "string") where function can
  35 be: contains, equals, starts-with, ends-with.
  36
  37 Available options are:
  38
  39   -c counting only (don't materialize the result set)
  40   -f sample factor [default=64]
  41   -i index empty texts [default=false]
  42   -d disable text collection[default=false]
  43   -s save the intermediate representation into file.srx
  44   -b real bottom up run
  45   -nj disable jumping
  46   -index-type {default|swcsa|rlcsa} choose text index type
  47   -v verbose mode
  48   -help  Display this list of options
  49   --help  Display this list of options