-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documentation of branch “master” at 63dac43b
- Loading branch information
Showing
70 changed files
with
146 additions
and
146 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Envars (rocq-runtime.Envars)</title><link rel="stylesheet" href="../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.0.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../index.html">rocq-runtime</a> » Envars</nav><header class="odoc-preamble"><h1>Module <code><span>Envars</span></code></h1><p>This file provides a high-level interface to the environment variables needed by Rocq 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 Rocq was build).</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value" id="val-getenv_rocq" class="anchored"><a href="#val-getenv_rocq" class="anchor"></a><code><span><span class="keyword">val</span> getenv_rocq : <span>string <span class="arrow">-></span></span> <span>string option</span></span></code></div><div class="spec-doc"><p><code>getenv_rocq name</code> returns the value of "ROCQ$name" if it exists, otherwise the value of "COQ$name" if it exists and warns that it is deprecated, otherwise <code>None</code>.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-expand_path_macros" class="anchored"><a href="#val-expand_path_macros" class="anchor"></a><code><span><span class="keyword">val</span> expand_path_macros : <span>warn:<span>(<span>string <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>expand_path_macros warn s</code> 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 <code>warn</code> as a message displayer.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-home" class="anchored"><a href="#val-home" class="anchor"></a><code><span><span class="keyword">val</span> home : <span>warn:<span>(<span>string <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>home warn</code> 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, <code>warn</code> is called.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-datadir" class="anchored"><a href="#val-datadir" class="anchor"></a><code><span><span class="keyword">val</span> datadir : <span>unit <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>datadir</code> is the path to the installed data directory.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-configdir" class="anchored"><a href="#val-configdir" class="anchor"></a><code><span><span class="keyword">val</span> configdir : <span>unit <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>configdir</code> is the path to the installed config directory.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-coqbin" class="anchored"><a href="#val-coqbin" class="anchor"></a><code><span><span class="keyword">val</span> coqbin : string</span></code></div><div class="spec-doc"><p><code>coqbin</code> is the name of the current executable.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-coqroot" class="anchored"><a href="#val-coqroot" class="anchor"></a><code><span><span class="keyword">val</span> coqroot : string</span></code></div><div class="spec-doc"><p><code>coqroot</code> is the path to <code>coqbin</code>. The following value only makes sense when executables are running from source tree (e.g. during build or in local mode).</p></div></div><div class="odoc-spec"><div class="spec value" id="val-coqpath" class="anchored"><a href="#val-coqpath" class="anchor"></a><code><span><span class="keyword">val</span> coqpath : <span>string list</span></span></code></div><div class="spec-doc"><p><code>coqpath</code> 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.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-xdg_config_home" class="anchored"><a href="#val-xdg_config_home" class="anchor"></a><code><span><span class="keyword">val</span> xdg_config_home : <span><span>(<span>string <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p>Rocq tries to honor the XDG Base Directory Specification to access the user's configuration files.</p><p>see <code>http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html</code></p></div></div><div class="odoc-spec"><div class="spec value" id="val-xdg_data_home" class="anchored"><a href="#val-xdg_data_home" class="anchor"></a><code><span><span class="keyword">val</span> xdg_data_home : <span><span>(<span>string <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-xdg_data_dirs" class="anchored"><a href="#val-xdg_data_dirs" class="anchor"></a><code><span><span class="keyword">val</span> xdg_data_dirs : <span><span>(<span>string <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> <span>string list</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-xdg_dirs" class="anchored"><a href="#val-xdg_dirs" class="anchor"></a><code><span><span class="keyword">val</span> xdg_dirs : <span>warn:<span>(<span>string <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> <span>string list</span></span></code></div></div></div></body></html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Envars (rocq-runtime.Envars)</title><link rel="stylesheet" href="../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.0.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../index.html">rocq-runtime</a> » Envars</nav><header class="odoc-preamble"><h1>Module <code><span>Envars</span></code></h1><p>This file provides a high-level interface to the environment variables needed by Rocq 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 Rocq was build).</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value" id="val-getenv_rocq" class="anchored"><a href="#val-getenv_rocq" class="anchor"></a><code><span><span class="keyword">val</span> getenv_rocq : <span>string <span class="arrow">-></span></span> <span>string option</span></span></code></div><div class="spec-doc"><p><code>getenv_rocq name</code> returns the value of "ROCQ$name" if it exists, otherwise the value of "COQ$name" if it exists and warns that it is deprecated, otherwise <code>None</code>.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-expand_path_macros" class="anchored"><a href="#val-expand_path_macros" class="anchor"></a><code><span><span class="keyword">val</span> expand_path_macros : <span>warn:<span>(<span>string <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>expand_path_macros warn s</code> 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 <code>warn</code> as a message displayer.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-home" class="anchored"><a href="#val-home" class="anchor"></a><code><span><span class="keyword">val</span> home : <span>warn:<span>(<span>string <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>home warn</code> 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, <code>warn</code> is called.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-datadir" class="anchored"><a href="#val-datadir" class="anchor"></a><code><span><span class="keyword">val</span> datadir : <span>unit <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>datadir</code> is the path to the installed data directory.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-configdir" class="anchored"><a href="#val-configdir" class="anchor"></a><code><span><span class="keyword">val</span> configdir : <span>unit <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>configdir</code> is the path to the installed config directory.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-coqbin" class="anchored"><a href="#val-coqbin" class="anchor"></a><code><span><span class="keyword">val</span> coqbin : string</span></code></div><div class="spec-doc"><p><code>coqbin</code> is the name of the current executable.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-coqroot" class="anchored"><a href="#val-coqroot" class="anchor"></a><code><span><span class="keyword">val</span> coqroot : string</span></code></div><div class="spec-doc"><p><code>coqroot</code> is the path to <code>coqbin</code>. The following value only makes sense when executables are running from source tree (e.g. during build or in local mode).</p></div></div><div class="odoc-spec"><div class="spec value" id="val-coqpath" class="anchored"><a href="#val-coqpath" class="anchor"></a><code><span><span class="keyword">val</span> coqpath : <span>unit <span class="arrow">-></span></span> <span>string list</span></span></code></div><div class="spec-doc"><p><code>coqpath</code> 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.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-xdg_config_home" class="anchored"><a href="#val-xdg_config_home" class="anchor"></a><code><span><span class="keyword">val</span> xdg_config_home : <span><span>(<span>string <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p>Rocq tries to honor the XDG Base Directory Specification to access the user's configuration files.</p><p>see <code>http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html</code></p></div></div><div class="odoc-spec"><div class="spec value" id="val-xdg_data_home" class="anchored"><a href="#val-xdg_data_home" class="anchor"></a><code><span><span class="keyword">val</span> xdg_data_home : <span><span>(<span>string <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-xdg_data_dirs" class="anchored"><a href="#val-xdg_data_dirs" class="anchor"></a><code><span><span class="keyword">val</span> xdg_data_dirs : <span><span>(<span>string <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> <span>string list</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-xdg_dirs" class="anchored"><a href="#val-xdg_dirs" class="anchor"></a><code><span><span class="keyword">val</span> xdg_dirs : <span>warn:<span>(<span>string <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> <span>string list</span></span></code></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.