1
0
Fork 0
cl-sites/asdf.common-lisp.dev/asdf/Configurations.html
2023-11-12 11:34:18 +01:00

172 lines
7.8 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.8, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes ASDF, a system definition facility
for Common Lisp programs and libraries.
You can find the latest version of this manual at
https://common-lisp.net/project/asdf/asdf.html.
ASDF Copyright (C) 2001-2019 Daniel Barlow and contributors.
This manual Copyright (C) 2001-2019 Daniel Barlow and contributors.
This manual revised (C) 2009-2019 Robert P. Goldman and Francois-Rene Rideau.
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-->
<title>Configurations (ASDF Manual)</title>
<meta name="description" content="Configurations (ASDF Manual)">
<meta name="keywords" content="Configurations (ASDF Manual)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Controlling-where-ASDF-searches-for-systems.html" rel="up" title="Controlling where ASDF searches for systems">
<link href="Truenames-and-other-dangers.html" rel="next" title="Truenames and other dangers">
<link href="Controlling-where-ASDF-searches-for-systems.html" rel="prev" title="Controlling where ASDF searches for systems">
<style type="text/css">
<!--
a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em}
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
span:hover a.copiable-anchor {visibility: visible}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en">
<div class="section" id="Configurations">
<div class="header">
<p>
Next: <a href="Truenames-and-other-dangers.html" accesskey="n" rel="next">Truenames and other dangers</a>, Previous: <a href="Controlling-where-ASDF-searches-for-systems.html" accesskey="p" rel="prev">Controlling where ASDF searches for systems</a>, Up: <a href="Controlling-where-ASDF-searches-for-systems.html" accesskey="u" rel="up">Controlling where ASDF searches for systems</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="Configurations-1"></span><h3 class="section">8.1 Configurations</h3>
<p>Configurations specify paths where to find system files.
</p>
<ol>
<li> The search registry may use some hardcoded wrapping registry specification.
This allows some implementations (notably SBCL) to specify where to find
some special implementation-provided systems that
need to precisely match the version of the implementation itself.
</li><li> An application may explicitly initialize the source-registry configuration
using the configuration API
(see <a href="Controlling-where-ASDF-searches-for-systems.html">Configuration API</a>, below)
in which case this takes precedence.
It may itself compute this configuration from the command-line,
from a script, from its own configuration file, etc.
</li><li> The source registry will be configured from
the environment variable <code>CL_SOURCE_REGISTRY</code> if it exists.
</li><li> The source registry will be configured from
user configuration file
<samp>$XDG_CONFIG_DIRS/common-lisp/source-registry.conf</samp>
(which defaults to
<samp>~/.config/common-lisp/source-registry.conf</samp>)
if it exists.
</li><li> The source registry will be configured from
user configuration directory
<samp>$XDG_CONFIG_DIRS/common-lisp/source-registry.conf.d/</samp>
(which defaults to
<samp>~/.config/common-lisp/source-registry.conf.d/</samp>)
if it exists.
</li><li> The source registry will be configured from
default user configuration trees
<samp>~/common-lisp/</samp> (since ASDF 3.1.2 only),
<samp>~/.sbcl/systems/</samp> (on SBCL only),
<samp>$XDG_DATA_HOME/common-lisp/systems/</samp> (no recursion, link farm)
<samp>$XDG_DATA_HOME/common-lisp/source/</samp>.
The <code>XDG_DATA_HOME</code> directory defaults to <samp>~/.local/share/</samp>.
On Windows, the <code>local-appdata</code> and <code>appdata</code> directories are used instead.
</li><li> The source registry will be configured from
system configuration file
<samp>/etc/common-lisp/source-registry.conf</samp>
if it exists.
</li><li> The source registry will be configured from
system configuration directory
<samp>/etc/common-lisp/source-registry.conf.d/</samp>
if it exists.
</li><li> The source registry will be configured from a default configuration.
This configuration may allow for implementation-specific systems
to be found, for systems to be found the current directory
(at the time that the configuration is initialized) as well as
<code>:directory</code> entries for <samp>$XDG_DATA_DIRS/common-lisp/systems/</samp> and
<code>:tree</code> entries for <samp>$XDG_DATA_DIRS/common-lisp/source/</samp>,
where <code>XDG_DATA_DIRS</code> defaults to <samp>/usr/local/share</samp> and <samp>/usr/share</samp> on Unix,
and the <code>common-appdata</code> directory on Windows.
</li><li> The source registry may include implementation-dependent directories
that correspond to implementation-provided extensions.
</li></ol>
<p>Each of these configurations is specified as an s-expression
in a trivial domain-specific language (defined below).
Additionally, a more shell-friendly syntax is available
for the environment variable (defined yet below).
</p>
<p>Each of these configurations is only used if the previous
configuration explicitly or implicitly specifies that it
includes its inherited configuration.
</p>
<p>Additionally, some implementation-specific directories
may be automatically prepended to whatever directories are specified
in configuration files, no matter if the last one inherits or not.
</p>
</div>
<hr>
<div class="header">
<p>
Next: <a href="Truenames-and-other-dangers.html">Truenames and other dangers</a>, Previous: <a href="Controlling-where-ASDF-searches-for-systems.html">Controlling where ASDF searches for systems</a>, Up: <a href="Controlling-where-ASDF-searches-for-systems.html">Controlling where ASDF searches for systems</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>