added "output" parameter to gzip and gunzip used to specify target file

[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 946446dc6cc35c3ef6f3b7a377b396f2f424914b..2047cf204b852736782672a1f8152b1a916c46ce 100644 (file)
--- a/helm/http_getter/http_getter_misc.mli
+++ b/helm/http_getter/http_getter_misc.mli
@@ -47,10 +47,14 @@ val cp: string -> string -> unit
   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
+  (** gzip frontend. If keep = true original file will be kept, default is
+  false. output is the file on which gzipped data will be saved, default is
+  given file with an added ".gz" suffix *)
+val gzip: ?keep: bool -> ?output: string -> string -> unit
+  (** gunzip frontend. If keep = true original file will be kept, default is
+  false. output is the file on which gunzipped data will be saved, default is
+  given file name without trailing ".gz" *)
+val gunzip: ?keep: bool -> ?output: string -> string -> unit
   (** tempfile frontend, return the name of created file. A special purpose
   suffix is used (actually "_http_getter" *)
 val tempfile: unit -> string