]> matita.cs.unibo.it Git - helm.git/blob - helm/http_getter/http_getter_env.mli
removed ancient lablgtk, lablgtk_gtkmathview
[helm.git] / helm / http_getter / http_getter_env.mli
1 (*
2  * Copyright (C) 2003:
3  *    Stefano Zacchiroli <zack@cs.unibo.it>
4  *    for the HELM Team http://helm.cs.unibo.it/
5  *
6  *  This file is part of HELM, an Hypertextual, Electronic
7  *  Library of Mathematics, developed at the Computer Science
8  *  Department, University of Bologna, Italy.
9  *
10  *  HELM is free software; you can redistribute it and/or
11  *  modify it under the terms of the GNU General Public License
12  *  as published by the Free Software Foundation; either version 2
13  *  of the License, or (at your option) any later version.
14  *
15  *  HELM is distributed in the hope that it will be useful,
16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  *  GNU General Public License for more details.
19  *
20  *  You should have received a copy of the GNU General Public License
21  *  along with HELM; if not, write to the Free Software
22  *  Foundation, Inc., 59 Temple Place - Suite 330, Boston,
23  *  MA  02111-1307, USA.
24  *
25  *  For details, see the HELM World-Wide-Web page,
26  *  http://helm.cs.unibo.it/
27  *)
28
29 open Http_getter_types;;
30
31   (* {2 general information} *)
32
33 val version       : string        (* getter version *)
34
35   (* {2 environment gathered data} *)
36
37 val cic_dbm       : string        (* XML map DBM file for CIC *)
38 val nuprl_dbm     : string        (* XML map DBM file for NuPRL *)
39 val rdf_dbm       : string        (* RDF map DBM file *)
40 val xsl_dbm       : string        (* XSL map DBM file *)
41 val xml_index     : string        (* XMLs' index *)
42 val rdf_index     : string        (* RDFs' index *)
43 val xsl_index     : string        (* XSLTs' index *)
44 val cic_dir       : string        (* XMLs' directory  for CIC*)
45 val nuprl_dir     : string        (* XMLs' directory for NuPRL*)
46 val rdf_dir       : string        (* RDFs' directory *)
47 val dtd_dir       : string        (* DTDs' root directory *)
48 val servers_file  : string        (* servers.txt file *)
49 val port          : int           (* port on which getter listens *)
50 val dtd_base_url  : string        (* base URL for DTD downloading *)
51
52   (* {2 derived data} *)
53
54 val host          : string          (* host on which getter listens *)
55 val my_own_url    : string          (* URL at which contact getter *)
56 val servers       : string list ref (* servers list. DO NOT CHANGE this list,
57                                     modifications wont be preserved *)
58 val cache_mode    : http_getter_encoding  (* cached files encoding *)
59 val conf_file     : string          (* configuration file's full path *)
60 val conf_dir      : string          (* directory where conf_file resides *)
61
62   (* {2 dynamic configuration changes} *)
63
64   (* add a server to servers list in a given position (defaults to "after the
65   last server", change servers file accordingly and reload servers list *)
66 val add_server: ?position:int -> string -> unit
67   (* remove a server from servers list, change servers file accordingly and
68   reload servers list *)
69 val remove_server: int -> unit
70
71   (* {2 misc} *)
72
73 val reload: unit -> unit            (* reload configuration information *)
74 val env_to_string : unit -> string  (* dump a textual representation of the
75                                     current http_getter settings on an output
76                                     channel *)
77