X-Git-Url: http://matita.cs.unibo.it/gitweb/?a=blobdiff_plain;f=helm%2Fhttp_getter%2Fhttp_getter_env.mli;h=6d4d6312f2ab726c15bb24523179b652affb2d4e;hb=4faf0e37e7019de16dd6862bb34d84f799a2a230;hp=e47cc3d3c077b69ec4307c4b598c51f2575b0c2a;hpb=86e80bc65186bf4c2824dc94f5f4dd5966843f14;p=helm.git diff --git a/helm/http_getter/http_getter_env.mli b/helm/http_getter/http_getter_env.mli index e47cc3d3c..6d4d6312f 100644 --- a/helm/http_getter/http_getter_env.mli +++ b/helm/http_getter/http_getter_env.mli @@ -1,58 +1,77 @@ (* - * Copyright (C) 2000, HELM Team. - * - * This file is part of HELM, an Hypertextual, Electronic - * Library of Mathematics, developed at the Computer Science - * Department, University of Bologna, Italy. - * - * HELM is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation; either version 2 - * of the License, or (at your option) any later version. - * - * HELM is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with HELM; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, - * MA 02111-1307, USA. - * - * For details, see the HELM World-Wide-Web page, - * http://cs.unibo.it/helm/. - *) - - 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 *) + * Copyright (C) 2003: + * Stefano Zacchiroli + * 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 + * Department, University of Bologna, Italy. + * + * HELM is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * HELM is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with HELM; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, + * MA 02111-1307, USA. + * + * For details, see the HELM World-Wide-Web page, + * http://helm.cs.unibo.it/ + *) + +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 *)