Initial revision

[helm.git] / helm / http_getter / http_getter_common.mli

diff --git a/helm/http_getter/http_getter_common.mli b/helm/http_getter/http_getter_common.mli
index 323c71d218eedbbd1c680d7e99674cb3f609aa2a..9ac5aad6fde50b9cd801f140af6f247cf53a1a07 100644 (file)
--- a/helm/http_getter/http_getter_common.mli
+++ b/helm/http_getter/http_getter_common.mli
@@ -1,5 +1,7 @@
 (*
- *  Copyright (C) 2000, 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,7 +23,7 @@
  *  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;;
@@ -41,17 +43,26 @@ val patch_dtd : string -> string
 
 val return_html_error: string -> out_channel -> unit
 val return_html_internal_error: string -> out_channel -> unit
+  (** return an HTML HTTP response from the given string, embedding it in an
+  "H1" element of an HTML page; content-type is set to text/html *)
 val return_html_msg: string -> out_channel -> unit
-val return_xml_msg: string -> out_channel -> unit
+  (** return an HTTP response using given string as content; content-type is set
+  to text/html *)
+val return_html_raw: string -> out_channel -> unit
+  (** return an HTTP response using given string as content; content-type is set
+  to text/xml *)
+val return_xml_raw: string -> out_channel -> unit
+ (** return a bad request http response *)
 val return_400: string -> out_channel -> unit
+  (**
+  @param fname name of the file to be sent
+  @param contype Content-Type header value
+  @param contenc Content-Enconding header value
+  @param patch_fun function used to patch file contents
+  @param outchan output channel over which sent file fname *)
 val return_file:
   fname:string ->
   ?contype:string -> ?contenc:string -> ?patch_fun:(string -> string) ->
   out_channel ->
     unit
 
-val wget: ?output: string -> string -> unit
-val gzip: ?keep: bool -> string -> unit
-val gunzip: ?keep: bool -> string -> unit
-val tempfile: unit -> string
-