cl-asdf 2:3.1.6-1 / usr / share / doc / cl-asdf / asdf / The-defsystem-form.html

This file is indexed.

/usr/share/doc/cl-asdf/asdf/The-defsystem-form.html is in cl-asdf 2:3.1.6-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- 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-2015 Daniel Barlow and contributors.

This manual Copyright (C) 2001-2015 Daniel Barlow and contributors.

This manual revised (C) 2009-2015 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.
 -->
<!-- Created by GNU Texinfo 6.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>ASDF Manual: The defsystem form</title>

<meta name="description" content="ASDF Manual: The defsystem form">
<meta name="keywords" content="ASDF Manual: The defsystem form">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Defining-systems-with-defsystem.html#Defining-systems-with-defsystem" rel="up" title="Defining systems with defsystem">
<link href="A-more-involved-example.html#A-more-involved-example" rel="next" title="A more involved example">
<link href="Defining-systems-with-defsystem.html#Defining-systems-with-defsystem" rel="prev" title="Defining systems with defsystem">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {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}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<a name="The-defsystem-form"></a>
<div class="header">
<p>
Next: <a href="A-more-involved-example.html#A-more-involved-example" accesskey="n" rel="next">A more involved example</a>, Previous: <a href="Defining-systems-with-defsystem.html#Defining-systems-with-defsystem" accesskey="p" rel="prev">Defining systems with defsystem</a>, Up: <a href="Defining-systems-with-defsystem.html#Defining-systems-with-defsystem" accesskey="u" rel="up">Defining systems with defsystem</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="The-defsystem-form-1"></a>
<h3 class="section">6.1 The defsystem form</h3>
<a name="index-defsystem"></a>
<a name="index-asdf_002duser"></a>
<a name="index-load_002dasd"></a>

<p>This section begins with an example of a system definition,
then gives the full grammar of <code>defsystem</code>.
</p>
<p>Let&rsquo;s look at a simple system.
This is a complete file that should be saved as <samp>hello-lisp.asd</samp>
(in order that ASDF can find it
when ordered to operate on the system named <code>&quot;hello-lisp&quot;</code>).
</p>
<div class="lisp">
<pre class="lisp">;; Usual Lisp comments are allowed here

(defsystem &quot;hello-lisp&quot;
  :description &quot;hello-lisp: a sample Lisp system.&quot;
  :version &quot;0.0.1&quot;
  :author &quot;Joe User &lt;joe@example.com&gt;&quot;
  :licence &quot;Public Domain&quot;
  :depends-on (&quot;optima.ppcre&quot; &quot;command-line-arguments&quot;)
  :components ((:file &quot;packages&quot;)
               (:file &quot;macros&quot; :depends-on (&quot;packages&quot;))
               (:file &quot;hello&quot; :depends-on (&quot;macros&quot;))))
</pre></div>

<p>Some notes about this example:
</p>
<ul>
<li> The <code>defsystem</code> form defines a system named <code>hello-lisp</code>
that contains three source files:
<samp>packages.lisp</samp>, <samp>macros.lisp</samp> and <samp>hello.lisp</samp>.

</li><li> The <samp>.lisp</samp> suffix is implicit for Lisp source files.
The source files are located in the same directory
as the <code>.asd</code> file with the system definition.

</li><li> The file <samp>macros</samp> depends on <samp>packages</samp>
(presumably because the package it&rsquo;s in is defined in <samp>packages</samp>),
and the file <samp>hello</samp> depends on <samp>macros</samp>
(and hence, transitively on <samp>packages</samp>).
This means that ASDF will compile and load <samp>packages</samp> then <samp>macros</samp>
before starting the compilation of file <samp>hello</samp>.

</li><li> This example system has external dependencies on two other systems,
<code>optima.ppcre</code> (that provides a friendly interface to matching regular expressions),
and <code>command-line-arguments</code> (that provides a way to parse arguments passed from the shell command line).
To use this system, ASDF must be configured to find installed copies of these systems;
it will load them before it tries to compile and load <code>hello-lisp</code>.

</li><li> This system also defines a bunch of metadata.
While it is optional to define these fields
(and other fields like <code>:bug-tracker</code>, <code>:mailto</code>, <code>:long-name</code>,
<code>:long-description</code>, <code>:source-control</code>),
it is strongly recommended to define the fields <code>:description</code>, <code>:version</code>, <code>:author</code>, and <code>:licence</code>,
especially if you intend your software to be eventually included in Quicklisp.

</li><li> Make sure you know how the <code>:version</code> numbers will be parsed!
Only period-separated non-negative integers are accepted at present.
See below Version specifiers in <a href="The-defsystem-grammar.html#The-defsystem-grammar">The defsystem grammar</a>.

</li><li> This file contains a single form, the <code>defsystem</code> declaration.
No <code>in-package</code> form, no <code>asdf:</code> package prefix, no nothing.
Just the one naked <code>defsystem</code> form.
This is what we recommend.
More complex system definition files are possible with arbitrary Lisp code,
but we recommend that you keep it simple if you can.
This will make your system definitions more robust and more future-proof.

<a name="index-_003aversion"></a>

</li></ul>

<p>This is all you need to know to define simple systems.
The next example is much more involved, to give you a glimpse of how you can do more complex things.
However, since it&rsquo;s ultimately arbitrary Lisp code, there is no bottom to the rabbit hole.
</p>

<hr>
<div class="header">
<p>
Next: <a href="A-more-involved-example.html#A-more-involved-example" accesskey="n" rel="next">A more involved example</a>, Previous: <a href="Defining-systems-with-defsystem.html#Defining-systems-with-defsystem" accesskey="p" rel="prev">Defining systems with defsystem</a>, Up: <a href="Defining-systems-with-defsystem.html#Defining-systems-with-defsystem" accesskey="u" rel="up">Defining systems with defsystem</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>

APT Browse - Built by Thomas Orozco.