helm/http_getter/http_getter_env.mli

   1 (*
   2  *  Copyright (C) 2003, HELM Team.
   3  *
   4  *  This file is part of HELM, an Hypertextual, Electronic
   5  *  Library of Mathematics, developed at the Computer Science
   6  *  Department, University of Bologna, Italy.
   7  *
   8  *  HELM is free software; you can redistribute it and/or
   9  *  modify it under the terms of the GNU General Public License
  10  *  as published by the Free Software Foundation; either version 2
  11  *  of the License, or (at your option) any later version.
  12  *
  13  *  HELM is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with HELM; if not, write to the Free Software
  20  *  Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  21  *  MA  02111-1307, USA.
  22  *
  23  *  For details, see the HELM World-Wide-Web page,
  24  *  http://cs.unibo.it/helm/.
  25  *)
  26
  27   open Http_getter_types;;
  28
  29   (* environment gathered data *)
  30
  31   val xml_dbm       : string        (* XML map DBM file *)
  32   val rdf_dbm       : string        (* RDF map DBM file *)
  33   val xsl_dbm       : string        (* XSL map DBM file *)
  34   val xml_index     : string        (* XMLs' index *)
  35   val rdf_index     : string        (* RDFs' index *)
  36   val xsl_index     : string        (* XSLTs' index *)
  37   val xml_dir       : string        (* XMLs' directory *)
  38   val rdf_dir       : string        (* RDFs' directory *)
  39   val dtd_dir       : string        (* DTDs' root directory *)
  40   val servers_file  : string        (* servers.txt file *)
  41   val port          : int           (* port on which getter listens *)
  42   val dtd_base_url  : string        (* base URL for DTD downloading *)
  43
  44   (* derived data *)
  45
  46   val host          : string        (* host on which getter listens *)
  47   val my_own_url    : string        (* URL at which contact getter *)
  48   val servers       : string list   (* servers list (i.e. servers_file lines) *)
  49   val cache_mode    : http_getter_encoding  (* cached files encoding *)
  50   val conf_file     : string        (* configuration file's full path *)
  51   val conf_dir      : string        (* directory where conf_file resides *)
  52
  53   (* misc *)
  54
  55 val dump_env : unit -> unit       (* dump a textual representation of the
  56                                   current http_getter settings *)
  57