- added "cp", a wrapper around omonymous command

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

diff --git a/helm/http_getter/http_getter_misc.mli b/helm/http_getter/http_getter_misc.mli
index c1afb198ff8f704a88facc780cb2d5a7696210ac..d9f8ff873a6e973a96d980e5b9830dc31bbee5dd 100644 (file)
--- a/helm/http_getter/http_getter_misc.mli
+++ b/helm/http_getter/http_getter_misc.mli
@@ -1,5 +1,5 @@
 (*
- *  Copyright (C) 2000, HELM Team.
+ *  Copyright (C) 2003, HELM Team.
  *
  *  This file is part of HELM, an Hypertextual, Electronic
  *  Library of Mathematics, developed at the Computer Science
@@ -24,10 +24,38 @@
  *  http://cs.unibo.it/helm/.
  *)
 
+ (** "fold_left" like function on file lines, trailing newline is not passed to
+ the given function *)
 val fold_file : ('a -> string -> 'a) -> 'a -> string -> 'a
+ (* "iter" like function on file lines, trailing newline is not passed to the
+ given function *)
 val iter_file : (string -> unit) -> string -> unit
 
   (** like Hashtbl.fold but keys are processed ordered *)
 val hashtbl_sorted_fold :
   ('a -> 'b -> 'c -> 'c) -> ('a, 'b) Hashtbl.t -> 'c -> 'c
 
+  (** cp frontend *)
+val cp: string -> string -> unit
+  (** wget frontend, if output is given it is the destination file, otherwise
+  standard wget rules are used. Additionally this function support also the
+  "file://" scheme for file system addressing *)
+val wget: ?output: string -> string -> unit
+  (** gzip frontend, if keep = true original file will be kept *)
+val gzip: ?keep: bool -> string -> unit
+  (** gunzip frontend, if keep = true original file will be kept *)
+val gunzip: ?keep: bool -> string -> unit
+  (** tempfile frontend, return the name of created file. A special purpose
+  suffix is used (actually "_http_getter" *)
+val tempfile: unit -> string
+  (** mkdir frontend, if parents = true also parent directories will be created.
+  If the given directory already exists doesn't act *)
+val mkdir: ?parents: bool -> string -> unit
+
+  (** pretty printer for Unix.process_status values *)
+val string_of_proc_status : Unix.process_status -> string
+
+  (** raw HTTP downloader, return Some the contents of downloaded resource or
+  None if an error occured while downlaoding *)
+val http_get: string -> string option
+