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
|
<html lang="en">
<head>
<title>The DESCRIPTION File - Untitled</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Untitled">
<meta name="generator" content="makeinfo 4.11">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Creating-Packages.html#Creating-Packages" title="Creating Packages">
<link rel="next" href="The-INDEX-file.html#The-INDEX-file" title="The INDEX file">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<p>
<a name="The-DESCRIPTION-File"></a>
Next: <a rel="next" accesskey="n" href="The-INDEX-file.html#The-INDEX-file">The INDEX file</a>,
Up: <a rel="up" accesskey="u" href="Creating-Packages.html#Creating-Packages">Creating Packages</a>
<hr>
</div>
<h4 class="subsection">35.4.1 The DESCRIPTION File</h4>
<p>The <code>DESCRIPTION</code> file contains various information about the
package, such as its name, author, and version. This file has a very
simple format
<p class="noindent">
<ul>
<li>Lines starting with ‘<samp><span class="samp">#</span></samp>’ are comments.
<li>Lines starting with a blank character are continuations from the
previous line.
<li>Everything else is of the form <code>NameOfOption: ValueOfOption</code>.
</ul>
<p class="noindent">The following is a simple example of a <code>DESCRIPTION</code> file
<pre class="example"> Name: The name of my package
Version: 1.0.0
Date: 2007-18-04
Author: The name (and possibly email) of the package author.
Maintainer: The name (and possibly email) of the current
package maintainer.
Title: The title of the package
Description: A short description of the package. If this
description gets too long for one line it can continue
on the next by adding a space to the beginning of the
following lines.
License: GPL version 3 or later
</pre>
<p>The package manager currently recognizes the following keywords
<p class="noindent">
<dl>
<dt><code>Name</code><dd>Name of the package.
<br><dt><code>Version</code><dd>Version of the package.
<br><dt><code>Date</code><dd>Date of last update.
<br><dt><code>Author</code><dd>Original author of the package.
<br><dt><code>Maintainer</code><dd>Maintainer of the package.
<br><dt><code>Title</code><dd>A one line description of the package.
<br><dt><code>Description</code><dd>A one paragraph description of the package.
<br><dt><code>Categories</code><dd>Optional keyword describing the package (if no <code>INDEX</code> file is
given this is mandatory).
<br><dt><code>Problems</code><dd>Optional list of known problems.
<br><dt><code>Url</code><dd>Optional list of homepages related to the package.
<br><dt><code>Autoload</code><dd>Optional field that sets the default loading behavior for the package.
If set to <code>yes</code>, <code>true</code> or <code>on</code>, then Octave will
automatically load the package when starting. Otherwise the package
must be manually loaded with the pkg load command. This default
behavior can be overridden when the package is installed.
<br><dt><code>Depends</code><dd>A list of other Octave packages that this package depends on. This can
include dependencies on particular versions, with a format
<pre class="example"> Depends: package (>= 1.0.0)
</pre>
<p class="noindent">Possible operators are <code><</code>, <code><=</code>, <code>==</code>, <code>>=</code> or
<code>></code>. If the part of the dependency in <code>()</code> is missing, any
version of the package is acceptable. Multiple dependencies can be
defined either as a comma separated list or on separate <code>Depends</code>
lines.
<br><dt><code>License</code><dd>An optional short description of the used license (e.g., GPL version 3
or newer). This is optional since the file <code>COPYING</code> is mandatory.
<br><dt><code>SystemRequirements</code><dd>These are the external install dependencies of the package and are not
checked by the package manager. This is here as a hint to the
distribution packager. They follow the same conventions as the
<code>Depends</code> keyword.
<br><dt><code>BuildRequires</code><dd>These are the external build dependencies of the package and are not
checked by the package manager. This is here as a hint to the
distribution packager. They follow the same conventions as the
<code>Depends</code> keyword. Note that in general, packaging systems such
as <code>rpm</code> or <code>deb</code> and autoprobe the install dependencies
from the build dependencies, and therefore the often a
<code>BuildRequires</code> dependency removes the need for a
<code>SystemRequirements</code> dependency.
</dl>
<p class="noindent">The developer is free to add additional arguments to the
<code>DESCRIPTION</code> file for their own purposes. One further detail to
aid the packager is that the <code>SystemRequirements</code> and
<code>BuildRequires</code> keywords can have a distribution dependent section,
and the automatic build process will use these. An example of the
format of this is
<pre class="example"> BuildRequires: libtermcap-devel [Mandriva] libtermcap2-devel
</pre>
<p class="noindent">where the first package name will be used as a default and if the
RPMs are built on a Mandriva distribution, then the second package
name will be used instead.
</body></html>
|
