]> matita.cs.unibo.it Git - helm.git/blob - helm/ocaml/getter/http_getter_env.mli
Added a new section on automation
[helm.git] / helm / ocaml / getter / http_getter_env.mli
1 (* Copyright (C) 2005, HELM Team.
2  * 
3  * This file is part of HELM, an Hypertextual, Electronic
4  * Library of Mathematics, developed at the Computer Science
5  * Department, University of Bologna, Italy.
6  * 
7  * HELM is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  * 
12  * HELM is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with HELM; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
20  * MA  02111-1307, USA.
21  * 
22  * For details, see the HELM World-Wide-Web page,
23  * http://helm.cs.unibo.it/
24  *)
25
26 open Http_getter_types
27
28   (** {2 general information} *)
29
30 val version       : string        (* getter version *)
31
32   (** {2 environment gathered data} *)
33   (** all *_dir values are returned with trailing "/" *)
34
35 val cache_dir     : string lazy_t         (* cache root *)
36 val dtd_dir       : string lazy_t         (* DTDs' root directory *)
37 val port          : int lazy_t            (* port on which getter listens *)
38 val dtd_base_urls : string list lazy_t    (* base URLs for document patching *)
39 val prefixes      : (string * (string * prefix_attr list)) list lazy_t
40                                           (* prefix map uri -> url + attrs *)
41
42   (* {2 derived data} *)
43
44 val host          : string lazy_t         (* host on which getter listens *)
45 val my_own_url    : string lazy_t         (* URL at which contact getter *)
46
47   (* {2 misc} *)
48
49 val env_to_string : unit -> string  (* dump a textual representation of the
50                                     current http_getter settings on an output
51                                     channel *)
52