File: rel.html

package info (click to toggle)
erlang-doc-html 1%3A10.b.1a-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 22,488 kB
  • ctags: 9,933
  • sloc: erlang: 505; ansic: 323; perl: 61; sh: 45; makefile: 39
file content (168 lines) | stat: -rw-r--r-- 3,700 bytes parent folder | download
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.2 -->
<HTML>
<HEAD>
  <TITLE>rel</TITLE>
  <SCRIPT type="text/javascript" src="../../../../doc/erlresolvelinks.js">
</SCRIPT>
  <STYLE TYPE="text/css">
<!--
    .REFBODY     { margin-left: 13mm }
    .REFTYPES    { margin-left: 8mm }
-->
  </STYLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#FF00FF"
      ALINK="#FF0000">
<!-- refpage -->
<CENTER>
<A HREF="http://www.erlang.se">
  <IMG BORDER=0 ALT="[Ericsson AB]" SRC="min_head.gif">
</A>
<H1>rel</H1>
</CENTER>

<H3>FILE</H3>
<DIV CLASS=REFBODY>
rel
</DIV>

<H3>FILE SUMMARY</H3>
<DIV CLASS=REFBODY>
Release resource file
</DIV>

<H3>DESCRIPTION</H3>
<DIV CLASS=REFBODY>

<P>The <STRONG>release resource file</STRONG> specifies which applications are
are included in a release (system) based on Erlang/OTP.
<P>This file is used by the functions in <CODE>systools</CODE> when generating
start scripts (<CODE>.script</CODE>, <CODE>.boot</CODE>) and release upgrade
files (<CODE>relup</CODE>).

</DIV>

<H3>FILE SYNTAX</H3>
<DIV CLASS=REFBODY>

<P>The release resource file should be called <CODE>Name.rel</CODE>.
<P>The <CODE>.rel</CODE> file contains one single Erlang term, which is
called a <STRONG>release specification</STRONG>. The file has the
following syntax:
<PRE>
{release, {RelName,Vsn}, {erts, EVsn},
  [{Application, AppVsn} |
   {Application, AppVsn, Type} |
   {Application, AppVsn, IncApps} |
   {Application, AppVsn, Type, IncApps}]}.
    
</PRE>

<P>
<UL>

<LI>
        <CODE>RelName = string()</CODE> is the name of the release.<BR>


</LI>


<LI>
        <CODE>Vsn = string()</CODE> is the version of the release.<BR>


</LI>


<LI>
        <CODE>EVsn = string()</CODE> is the version of ERTS the release is
         intended for.<BR>


</LI>


<LI>
        <CODE>Application = atom()</CODE> is the name of an application
         included in the release.<BR>


</LI>


<LI>
        <CODE>AppVsn = string()</CODE> is the version of an application
         included in the release.<BR>


</LI>


<LI>
        <CODE>Type = permanent | transient | temporary | load | none</CODE>
         is the start type of an application included in the release.<BR>


        If <CODE>Type = permanent | transient | temporary</CODE>,
         the application will be loaded and started in the corresponding
         way, see <CODE>application(3)</CODE>. If <CODE>Type = load</CODE>,
         the application will only be loaded. If <CODE>Type = none</CODE>,
         the application will be neither loaded nor started, although
         the code for its modules will be loaded.
         Defaults to <CODE>permanent</CODE><BR>


</LI>


<LI>
        <CODE>IncApps = [atom()]</CODE> is a list of applications that are
         included by an application included in the release.<BR>


        The list must be a subset of the included applications
         specified in the application resource file
         (<CODE>Application.app</CODE>) and overrides this value. Defaults
         to the empty list.<BR>


</LI>


</UL>

<P>
<TABLE CELLPADDING=4>
  <TR>
    <TD VALIGN=TOP><IMG ALT="Note!" SRC="note.gif"></TD>
    <TD>

<P>The list of applications must contain the <CODE>kernel</CODE> and
        <CODE>stdlib</CODE> applications.    </TD>
  </TR>
</TABLE>

</DIV>

<H3>SEE ALSO</H3>
<DIV CLASS=REFBODY>

<P>application(3), relup(4), systools(3)
</DIV>

<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
Gunilla Hugosson - support@erlang.ericsson.se<BR>

</DIV>
<CENTER>
<HR>
<SMALL>sasl 2.0<BR>
Copyright &copy; 1991-2004
<A HREF="http://www.erlang.se">Ericsson AB</A><BR>
</SMALL>
</CENTER>
</BODY>
</HTML>