Modified the instructions
authorkim <kim@3cdefd35-fc62-479d-8e8d-bae585ffb9ca>
Thu, 29 Jan 2009 03:49:52 +0000 (03:49 +0000)
committerkim <kim@3cdefd35-fc62-479d-8e8d-bae585ffb9ca>
Thu, 29 Jan 2009 03:49:52 +0000 (03:49 +0000)
git-svn-id: svn+ssh://idea.nguyen.vg/svn/sxsi/trunk/xpathcomp@89 3cdefd35-fc62-479d-8e8d-bae585ffb9ca

HACKING
options.ml

diff --git a/HACKING b/HACKING
index b8fe7c6..06b4b21 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -38,6 +38,8 @@ Usage :
 
 file.xml is the input file. There are some in the tests subdirectory. At the moment you can mainly test
 with base.xml and tiny.xml. Any file bigger than this will take too much time to load.
+If the file ends with the .srx extensions then it is considered to be a serialized output saved to disk
+with the -s flag (see bellow).
 
 
 output is optional. If specified, it is the name of a file to which the result of the query is serialized.
@@ -45,14 +47,17 @@ If output is not given, the the result of the query is kept as a set of identifi
 the string collection is made.
 
 
-There are a few flags:
 
--f sample factor [default=64]
--i index empty texts [default=false]
--d Disable text collection[default=false]
--help  Display this list of options
---help  Display this list of options
 
+There are a few flags:
+
+./main <input.xml> 'query' [output]
+  -f sample factor [default=64]
+  -i index empty texts [default=false]
+  -d Disable text collection[default=false]
+  -s Save the intermediate representation into file.srx
+  -help  Display this list of options
+  --help  Display this list of options
 
 for instance:
 ./main -f 29 -d tests/tiny.xml '//para'
index ffa5fa7..ff4fdbe 100644 (file)
@@ -7,7 +7,7 @@ let input_file = ref ""
 let output_file = ref None
 let save_file = ref ""
 
-let usage_msg = Printf.sprintf "%s <input.xml> 'query' [output]" Sys.argv.(0)
+let usage_msg = Printf.sprintf "%s <input.{xml|srx}> 'query' [output]" Sys.argv.(0)
 
 
 let pos = ref 0