* added popup menu, implemented some functions

[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 9c66f8ff7a0dd18f2844c358527b079044ce33de..6d4d6312f2ab726c15bb24523179b652affb2d4e 100644 (file)
--- a/helm/http_getter/http_getter_env.mli
+++ b/helm/http_getter/http_getter_env.mli
@@ -1,5 +1,7 @@
 (*
- *  Copyright (C) 2003, HELM Team.
+ * Copyright (C) 2003:
+ *    Stefano Zacchiroli <zack@cs.unibo.it>
+ *    for the HELM Team http://helm.cs.unibo.it/
  *
  *  This file is part of HELM, an Hypertextual, Electronic
  *  Library of Mathematics, developed at the Computer Science
@@ -21,38 +23,55 @@
  *  MA  02111-1307, USA.
  *
  *  For details, see the HELM World-Wide-Web page,
- *  http://cs.unibo.it/helm/.
+ *  http://helm.cs.unibo.it/
  *)
 
-  open Http_getter_types;;
-
-  (* environment gathered data *)
-
-  val xml_dbm       : string        (* XML map DBM file *)
-  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 rdf_dir       : string        (* RDFs' directory *)
-  val xsl_dir       : string        (* XSLs' 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 *)
-
-  val host          : string        (* host on which getter listens *)
-  val my_own_url    : string        (* URL at which contact getter *)
-  val servers       : string list   (* servers list (i.e. servers_file lines) *)
-  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 *)
-
-val dump_env : unit -> unit       (* dump a textual representation of the
-                                  current http_getter settings *)
+open Http_getter_types;;
+
+  (* {2 general information} *)
+
+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 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 *)
+
+  (* {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. 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 *)
+
+  (* {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 configuration information *)
+val env_to_string : unit -> string  (* dump a textual representation of the
+                                    current http_getter settings on an output
+                                    channel *)