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

150 lines
6.9 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>Introduction (ASDF Manual)</title>
<meta name="description" content="Introduction (ASDF Manual)">
<meta name="keywords" content="Introduction (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="index.html" rel="up" title="Top">
<link href="Quick-start-summary.html" rel="next" title="Quick start summary">
<link href="index.html" rel="prev" title="Top">
<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="chapter" id="Introduction">
<div class="header">
<p>
Next: <a href="Quick-start-summary.html" accesskey="n" rel="next">Quick start summary</a>, Previous: <a href="index.html" accesskey="p" rel="prev">ASDF: Another System Definition Facility</a>, Up: <a href="index.html" accesskey="u" rel="up">ASDF: Another System Definition Facility</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="Introduction-1"></span><h2 class="chapter">1 Introduction</h2>
<span id="index-ASDF_002drelated-features"></span>
<span id="index-_002afeatures_002a-1"></span>
<span id="index-Testing-for-ASDF"></span>
<span id="index-ASDF-versions"></span>
<span id="index-_003aasdf"></span>
<span id="index-_003aasdf2"></span>
<span id="index-_003aasdf3"></span>
<p>ASDF, or Another System Definition Facility, is a <em>build system</em>:
a tool for specifying how systems of Common Lisp software
are made up of components (sub-systems and files),
and how to operate on these components in the right order
so that they can be compiled, loaded, tested, etc.
If you are new to ASDF, see <a href="Quick-start-summary.html">the quick start
guide</a>.
</p>
<p>ASDF presents three faces:
one for users of Common Lisp software who want to reuse other people&rsquo;s code,
one for writers of Common Lisp software who want to specify how to build their systems,
and one for implementers of Common Lisp extensions who want to extend
the build system.
For more specifics,
see <a href="Using-ASDF.html">Using ASDF</a>,
to learn how to use ASDF to load a system.
See <a href="Defining-systems-with-defsystem.html">Defining systems with defsystem</a>,
to learn how to define a system of your own.
See <a href="The-object-model-of-ASDF.html">The Object model of ASDF</a>, for a description of
the ASDF internals and how to extend ASDF.
</p>
<p>Note that
ASDF is <em>not</em> a tool for library and system <em>installation</em>;
it plays a role like <code>make</code> or <code>ant</code>, not like a package manager.
In particular, ASDF should not to be confused with Quicklisp or ASDF-Install,
that attempt to find and download ASDF systems for you.
Despite what the name might suggest,
ASDF-Install was never a part of ASDF; it was always a separate piece of software.
ASDF-Install has also been unmaintained and obsolete for a very long time.
We recommend you use Quicklisp
(<a href="http://www.quicklisp.org/">http://www.quicklisp.org/</a>) instead,
a Common Lisp package manager which works well and is being actively maintained.
If you want to download software from version control instead of tarballs,
so you may more easily modify it,
we recommend clbuild (<a href="http://common-lisp.net/project/clbuild/">http://common-lisp.net/project/clbuild/</a>).
As for where on your filesystem to install Common Lisp software,
we recommend subdirectories of <samp>~/common-lisp/</samp>:
starting with ASDF 3.1.2 (2014), this hierarchy is included
in the default source-registry configuration.
</p>
<p>Finally, note that this manual is incomplete.
All the bases are covered,
but many advanced topics are only barely alluded to,
and there is not much in terms of examples.
The source code remains the ultimate source of information,
free software systems in Quicklisp remain the best source of examples,
and the mailing-list the best place to ask for help.
</p>
</div>
<hr>
<div class="header">
<p>
Next: <a href="Quick-start-summary.html">Quick start summary</a>, Previous: <a href="index.html">ASDF: Another System Definition Facility</a>, Up: <a href="index.html">ASDF: Another System Definition Facility</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>