- the mathql interpreter is not helm-dependent any more

[helm.git] / helm / http_getter / http_getter_env.mli

diff --git a/helm/http_getter/http_getter_env.mli b/helm/http_getter/http_getter_env.mli
index ce24cfeb7ed106f21b0d2a3f490b3c1bcbb738db..6d4d6312f2ab726c15bb24523179b652affb2d4e 100644 (file)
--- a/helm/http_getter/http_getter_env.mli
+++ b/helm/http_getter/http_getter_env.mli
@@ -28,33 +28,50 @@
 
 open Http_getter_types;;
 
-  (* environment gathered data *)
+  (* {2 general information} *)
 
-val xml_dbm       : string        (* XML map DBM file *)
+val version       : string        (* getter version *)
+
+  (* {2 environment gathered data} *)
+
+val cic_dbm       : string        (* XML map DBM file for CIC *)
+val nuprl_dbm     : string        (* XML map DBM file for NuPRL *)
 val rdf_dbm       : string        (* RDF map DBM file *)
 val xsl_dbm       : string        (* XSL map DBM file *)
 val xml_index     : string        (* XMLs' index *)
 val rdf_index     : string        (* RDFs' index *)
 val xsl_index     : string        (* XSLTs' index *)
-val xml_dir       : string        (* XMLs' directory *)
+val cic_dir       : string        (* XMLs' directory  for CIC*)
+val nuprl_dir     : string        (* XMLs' directory for NuPRL*)
 val rdf_dir       : string        (* RDFs' directory *)
 val dtd_dir       : string        (* DTDs' root directory *)
 val servers_file  : string        (* servers.txt file *)
 val port          : int           (* port on which getter listens *)
 val dtd_base_url  : string        (* base URL for DTD downloading *)
 
-  (* derived data *)
+  (* {2 derived data} *)
 
 val host          : string          (* host on which getter listens *)
 val my_own_url    : string          (* URL at which contact getter *)
-val servers       : string list ref (* servers list *)
+val servers       : string list ref (* servers list. DO NOT CHANGE this list,
+                                    modifications wont be preserved *)
 val cache_mode    : http_getter_encoding  (* cached files encoding *)
 val conf_file     : string          (* configuration file's full path *)
 val conf_dir      : string          (* directory where conf_file resides *)
 
-  (* misc *)
+  (* {2 dynamic configuration changes} *)
+
+  (* add a server to servers list in a given position (defaults to "after the
+  last server", change servers file accordingly and reload servers list *)
+val add_server: ?position:int -> string -> unit
+  (* remove a server from servers list, change servers file accordingly and
+  reload servers list *)
+val remove_server: int -> unit
+
+  (* {2 misc} *)
 
-val reload: unit -> unit          (* reload servers list *)
-val dump_env : unit -> unit       (* dump a textual representation of the
-                                  current http_getter settings *)
+val reload: unit -> unit            (* reload configuration information *)
+val env_to_string : unit -> string  (* dump a textual representation of the
+                                    current http_getter settings on an output
+                                    channel *)