~ubuntu-branches/ubuntu/utopic/findlib/utopic-proposed

« back to all changes in this revision

Viewing changes to src/findlib/findlib.mli

  • Committer: Package Import Robot
  • Author(s): Stéphane Glondu
  • Date: 2012-02-28 08:50:01 UTC
  • mfrom: (1.1.10)
  • Revision ID: package-import@ubuntu.com-20120228085001-jihzgnhxh43fetjv
Tags: 1.2.8+debian-1
* New upstream release
* Switch debian/copyright to format 1.0
* Bump Standards-Version to 3.9.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
(* $Id: findlib.mli 116 2007-11-11 22:40:21Z gerd $
 
1
(* $Id: findlib.mli 145 2011-11-29 20:57:20Z gerd $
2
2
 * ----------------------------------------------------------------------
3
3
 *
4
4
 *)
56
56
   *   The special value ["none"] turns this feature off.
57
57
   * - The search path is the concatenation of the env variable OCAMLPATH
58
58
   *   and the variable [path] of the config file
59
 
   * - The executables of (ocamlc|ocamlopt|ocamlcp|ocamlmktop) are determined
60
 
   *   as follows: if the env variable OCAMLFIND_COMMANDS is set and non-empty,
61
 
   *   its contents specify the executables. Otherwise, if the config file
62
 
   *   variables [ocamlc], [ocamlopt], [ocamlcp] and [ocamlmktop] are set,
63
 
   *   their contents specify the executables. Otherwise, the obvious default
64
 
   *   values are chosen: ["ocamlc"] for [ocamlc], ["ocamlopt"] for [ocamlopt],
65
 
   *   and so on.
 
59
   * - The executables of (ocamlc|ocamlopt|ocamlcp|ocamlmklib|ocamlmktop) are
 
60
   *   determined as follows: if the env variable OCAMLFIND_COMMANDS is set
 
61
   *   and non-empty, its contents specify the executables. Otherwise, if the
 
62
   *   config file variables [ocamlc], [ocamlopt], [ocamlcp], [ocamlmklib] and
 
63
   *   [ocamlmktop] are set, their contents specify the executables. Otherwise,
 
64
   *   the obvious default values are chosen: ["ocamlc"] for [ocamlc],
 
65
   *   ["ocamlopt"] for [ocamlopt], and so on.
66
66
   * - The directory of the standard library is the value of the environment
67
67
   *   variable CAMLLIB (or OCAMLLIB), or if unset or empty, the value of
68
68
   *   the configuration variable [stdlib], or if unset the built-in location
77
77
      ?ocamlc_command: string ->       (* default: "ocamlc"     *)
78
78
      ?ocamlopt_command: string ->     (* default: "ocamlopt"   *)
79
79
      ?ocamlcp_command: string ->      (* default: "ocamlcp"    *)
 
80
      ?ocamlmklib_command: string ->   (* default: "ocamlmklib" *)
80
81
      ?ocamlmktop_command: string ->   (* default: "ocamlmktop" *)
81
82
      ?ocamldep_command: string ->     (* default: "ocamldep"   *)
82
83
      ?ocamlbrowser_command: string -> (* default: "ocamlbrowser"   *)
105
106
val search_path : unit -> string list
106
107
  (** Get the search path for packages *)
107
108
 
108
 
val command : [ `ocamlc | `ocamlopt | `ocamlcp | `ocamlmktop | `ocamldep
109
 
              | `ocamlbrowser | `ocamldoc
 
109
val command : [ `ocamlc | `ocamlopt | `ocamlcp | `ocamlmklib 
 
110
              | `ocamlmktop | `ocamldep | `ocamlbrowser | `ocamldoc
110
111
              ] -> 
111
112
              string
112
113
  (** Get the name/path of the executable *)