diff options
author | 2015-01-25 14:42:51 +0100 | |
---|---|---|
committer | 2015-01-25 14:42:51 +0100 | |
commit | 7cfc4e5146be5666419451bdd516f1f3f264d24a (patch) | |
tree | e4197645da03dc3c7cc84e434cc31d0a0cca7056 /lib/envars.mli | |
parent | 420f78b2caeaaddc6fe484565b2d0e49c66888e5 (diff) |
Imported Upstream version 8.5~beta1+dfsg
Diffstat (limited to 'lib/envars.mli')
-rw-r--r-- | lib/envars.mli | 71 |
1 files changed, 63 insertions, 8 deletions
diff --git a/lib/envars.mli b/lib/envars.mli index 023b54c0..b62b9f28 100644 --- a/lib/envars.mli +++ b/lib/envars.mli @@ -1,25 +1,80 @@ (************************************************************************) (* v * The Coq Proof Assistant / The Coq Development Team *) -(* <O___,, * INRIA - CNRS - LIX - LRI - PPS - Copyright 1999-2014 *) +(* <O___,, * INRIA - CNRS - LIX - LRI - PPS - Copyright 1999-2015 *) (* \VV/ **************************************************************) (* // * This file is distributed under the terms of the *) (* * GNU Lesser General Public License Version 2.1 *) (************************************************************************) -(** This file gathers environment variables needed by Coq to run (such - as coqlib) *) +(** This file provides a high-level interface to the environment variables + needed by Coq to run (such as coqlib). The values of these variables + may come from different sources (shell environment variables, + command line options, options set at the time Coq was build). *) +(** [expand_path_macros warn s] substitutes environment variables + in a string by their values. This function also takes care of + substituting path of the form '~X' by an absolute path. + Use [warn] as a message displayer. *) +val expand_path_macros : warn:(string -> unit) -> string -> string + +(** [home warn] returns the root of the user directory, depending + on the OS. This information is usually stored in the $HOME + environment variable on POSIX shells. If no such variable + exists, then other common names are tried (HOMEDRIVE, HOMEPATH, + USERPROFILE). If all of them fail, [warn] is called. *) +val home : warn:(string -> unit) -> string + +(** [coqlib] is the path to the Coq library. *) val coqlib : unit -> string + +(** [set_coqlib] must be runned once before any access to [coqlib] *) +val set_coqlib : fail:(string -> string) -> unit + +(** [docdir] is the path to the Coq documentation. *) val docdir : unit -> string + +(** [coqbin] is the name of the current executable. *) val coqbin : string + +(** [coqroot] is the path to [coqbin]. + The following value only makes sense when executables are running from + source tree (e.g. during build or in local mode). +*) val coqroot : string -(* coqpath is stored in reverse order, since that is the order it - * gets added to the searc path *) -val xdg_config_home : string -val xdg_dirs : string list + +(** [coqpath] is the standard path to coq. + Notice that coqpath is stored in reverse order, since that is + the order it gets added to the search path. *) val coqpath : string list +(** [camlbin ()] is the path to the ocaml binaries. *) val camlbin : unit -> string -val camlp4bin : unit -> string + +(** [camllib ()] is the path to the ocaml standard library. *) val camllib : unit -> string + +(** [ocamlc ()] is the ocaml bytecode compiler that compiled this Coq. *) +val ocamlc : unit -> string + +(** [ocamlc ()] is the ocaml native compiler that compiled this Coq. *) +val ocamlopt : unit -> string + +(** [camlp4bin ()] is the path to the camlp4 binary. *) +val camlp4bin : unit -> string + +(** [camlp4lib ()] is the path to the camlp4 library. *) val camlp4lib : unit -> string + +(** [camlp4 ()] is the camlp4 utility. *) +val camlp4 : unit -> string + +(** Coq tries to honor the XDG Base Directory Specification to access + the user's configuration files. + + see [http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html] +*) +val xdg_config_home : (string -> unit) -> string +val xdg_data_home : (string -> unit) -> string +val xdg_config_dirs : (string -> unit) -> string list +val xdg_data_dirs : (string -> unit) -> string list +val xdg_dirs : warn : (string -> unit) -> string list |